323-1051-190G TL1 Reference Iss 5

NTN465BE
SONET Transmission Products
323-1051-190G
S/DMS TransportNode OC-3 Express and Express CX

TL1 Reference
Standard Doc Issue 5 November 1998
Whats inside...
Introducing OC-3 TL1 TL1 detailed command descriptions Automatic reports Error codes and messages
1997-1998 Northern Telecom All rights reserved

All information contained in this document is subject to change without notice. Northern Telecom reserves the right to make changes to equipment design or program components, as progress in engineering, manufacturing methods, or other circumstances may warrant. Ethernet is a trademark of Xerox Corporation. S/DMS TransportNode and the Nortel logo are trademarks of Northern Telecom. VT100 is a trademark of Digital Equipment Corporation.
Printed in Canada
iii
Contents
About this document
Supported software releases xi Technical support and information xii
xi
Introducing OC-3 TL1

TL1 command interface 1-3 Obtaining the TL1 prompt 1-3 User identifier 1-3 Password identifier 1-3 Security access level 1-4 Target identifier and source identifier 1-4 Default TID 1-5 Multiple sessions 1-5 TL1 message notation 1-6 Access identifier 1-6 Correlation tag 1-6 Command structure 1-7 Command grouping 1-7 Mandatory punctuation 1-7 TL1 command acknowledgment 1-7 TL1 message overview 1-8 TL1 message types 1-8 TL1 command response header 1-8 Editing features 1-10 Online syntax help 1-10
1-1
Security and administration detailed command descriptions

ACT-USER 2-3 CANC-PROV 2-4 CANC-USER 2-5 CHK-PROV 2-6 CMMT-PROV 2-9 DLT-PROV 2-10 DLT-SECU-USER 2-12 ED-DAT 2-13 ED-SECU-PID 2-14 ED-SECU-USER 2-16 ENT-SECU-USER 2-18
2-1
TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998
iv Contents RST-PROV 2-20 RTRV-ACTIVE-USER 2-23 RTRV-HDR 2-24 RTRV-HELP 2-25 RTRV-PROV-LST 2-26 RTRV-SECU-UPC 2-28 RTRV-SECU-USER 2-29 SAV-PROV 2-31 SET-SID 2-34 VALD-PROV 2-36
System detailed command descriptions

ED-NETYPE 3-2 RTRV-NETYPE (SP host) 3-3 RTRV-NETYPE (NP host) 3-5 RTRV-RTG-TBL 3-6 RTRV-SW-VER 3-10
3-1
Synchronization detailed command descriptions

OPR-BITSOUTSW 4-2 OPR-SYNCSW 4-3 RTRV-BITS-IN 4-4 RTRV-BITS-OUT 4-5 RTRV-SYNCSTIN 4-7 RTRV-TMG-MODE 4-8 RTRV-TMREFIN 4-9 SET-BITS-IN 4-11 SET-BITS-OUT 4-12 SET-SYNCSTIN 4-14 SET-TMG-MODE 4-16 SET-TMREFIN 4-17
4-1
Equipment detailed command descriptions

DLT-EQPT 5-2 ENT-EQPT 5-4 RMV-EQPT 5-7 RST-EQPT 5-9 RTRV-EQPT 5-11 RTRV-INVENTORY 5-15
5-1
Facility detailed command descriptions

DLT-EC1 6-3 DLT-EIM 6-4 DLT-FFP-OC3 6-5 DLT-OC3 6-6 DLT-T1 6-7 DLT-T3 6-8 ED-DFLT-AINS 6-9 ED-EC1 6-10 ED-EIM 6-11
6-1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Doc Issue 5 Standard Nov 1998
Contents v ED-FFP-OC3 6-13 ED-IMA-GRP 6-14 ED-OC3 6-16 ED-T1 6-19 ED-T3 6-24 ENT-EC1 6-26 ENT-EIM 6-28 ENT-FFP-OC3 6-30 ENT-OC3 6-31 ENT-T1 6-33 ENT-T3 6-37 RMV-EC1 6-39 RMV-EIM 6-40 RMV-OC3 6-41 RMV-T1 6-42 RMV-T3 6-43 RST-EC1 6-44 RST-EIM 6-45 RST-OC3 6-46 RST-T1 6-47 RST-T3 6-48 RTRV-DFLT-AINS 6-49 RTRV-EC1 6-50 RTRV-EIM 6-52 RTRV-FFP-OC3 6-55 RTRV-IMA-GRP 6-57 RTRV-OC3 6-59 RTRV-T1 6-63 RTRV-T3 6-68 RTRV-VP 6-70
MIB detailed command descriptions

DLT-MIB-BRIDGE 7-2 DLT-MIB-IP 7-4 ED-MIB-BRIDGE 7-6 ED-MIB-IP 7-9 ED-MIB-SNMP 7-12 ED-MIB-SYSTEM 7-13 ED-MIB-VIEW 7-15 ENT-MIB-BRIDGE 7-19 ENT-MIB-IP 7-21 RTRV-MIB-BRIDGE 7-23 RTRV-MIB-ICMP 7-29 RTRV-MIB-IF 7-32 RTRV-MIB-IP 7-35 RTRV-MIB-LAN 7-41 RTRV-MIB-SNMP 7-44 RTRV-MIB-SYSTEM 7-48 RTRV-MIB-UDP 7-50 RTRV-MIB-VIEW 7-52
7-1
vi Contents
Cross-connect detailed command descriptions

DLT-CRS-STS1 8-2 DLT-CRS-STS3C 8-4 DLT-CRS-VT1 8-6 ED-CRS-STS1 8-9 ED-CRS-STS3C 8-14 ED-CRS-VT1 8-19 ENT-CRS-STS1 8-26 ENT-CRS-STS3C 8-28 ENT-CRS-VT1 8-30 RTRV-CRS-STS1 8-33 RTRV-CRS-STS3C 8-37 RTRV-CRS-VT1 8-40
8-1
Inservice traffic rollover command descriptions

ENT-ROLL-VT1 9-3 ENT-ROLL-STS1 9-6 ENT-ROLL-STS3C 9-9 ED-ROLL-VT1 9-12 ED-ROLL-STS1 9-15 ED-ROLL-STS3C 9-17 CMMT-ROLL-VT1 9-19 CMMT-ROLL-STS1 9-21 CMMT-ROLL-STS3C 9-23 DLT-ROLL-VT1 9-25 DLT-ROLL-STS1 9-28 DLT-ROLL-STS3C 9-30 RTRV-ROLL-VT1 9-32 RTRV-ROLL-STS1 9-34 RTRV-ROLL-STS3C 9-36
9-1
Facility test signal generation and loopback detailed command descriptions

CONN-TSTSIG-T1 10-2 CONN-TSTSIG-T3 10-4 DISC-TSTSIG-T1 10-6 DISC-TSTSIG-T3 10-7 OPR-LPBK-EC1 10-8 OPR-LPBK-T1 10-10 OPR-LPBK-T3 10-12 RLS-LPBK-EC1 10-14 RLS-LPBK-T1 10-15 RLS-LPBK-T3 10-16
10-1
Protection switching detailed command descriptions

ALW-EX-OC3 11-2 EX-SW-OC3 11-3 INH-EX-OC3 11-5 OPR-PROTNSW-EQPT 11-6
11-1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Contents vii OPR-PROTNSW-OC3 11-8 OPR-PROTNSW-STS1 11-10 OPR-PROTNSW-STS3C 11-12 OPR-PROTNSW-VT1 11-14 RLS-PROTNSW-EQPT 11-16 RLS-PROTNSW-OC3 11-17 RLS-PROTNSW-STS1 11-18 RLS-PROTNSW-STS3C 11-19 RLS-PROTNSW-VT1 11-20 RTRV-EXSCHED-OC3 11-21 RTRV-PROTNSW-rr 11-23 SCHED-EX-OC3 11-26
Performance monitoring detailed command descriptions

INIT-REG-ALL 12-3 INIT-REG-EC1 12-7 INIT-REG-OC3 12-11 INIT-REG-STS1 12-15 INIT-REG-STS3C 12-20 INIT-REG-T1 12-24 INIT-REG-T3 12-29 RTRV-PM-ABORT 12-33 RTRV-PM-ALL 12-34 RTRV-PM-EC1 12-39 RTRV-PM-OC3 12-43 RTRV-PM-STS1 12-47 RTRV-PM-STS3C 12-52 RTRV-PM-T1 12-56 RTRV-PM-T3 12-60 RTRV-TH-ALL 12-64 RTRV-TH-EC1 12-67 RTRV-TH-OC3 12-70 RTRV-TH-STS1 12-73 RTRV-TH-STS3C 12-76 RTRV-TH-T1 12-79 RTRV-TH-T3 12-82 SET-TH-ALL 12-85 SET-TH-EC1 12-87 SET-TH-OC3 12-90 SET-TH-STS1 12-93 SET-TH-STS3C 12-96 SET-TH-T1 12-99 SET-TH-T3 12-102
12-1
TARP detailed command descriptions

ED-TARP-CONFIG 13-2 ED-TARP-TBL 13-5 OPR-TARP-TEF 13-8 RTRV-TARP-CONFIG 13-10 RTRV-TARP-TBL 13-12
13-1
viii Contents
TBOS detailed command descriptions

RTRV-TBOS 14-2 SET-TBOS 14-4
14-1
Alarm, events, and external controls detailed command descriptions

ALW-MSG-ALL 15-3 INH-MSG-ALL 15-4 OPR-ACO-ALL 15-5 OPR-EXT-CONT 15-6 RLS-EXT-CONT 15-8 RTRV-ALM-ALL 15-10 RTRV-ALM-ENV 15-15 RTRV-ALMID-rr 15-20 RTRV-AO 15-22 RTRV-ATTR-CONT 15-24 RTRV-ATTR-ENV 15-26 RTRV-COND-ALL 15-29 RTRV-CONDATTR-COM 15-31 RTRV-CONDATTR-rr 15-32 RTRV-EXT-CONT 15-34 RTRV-NTFCNCDE 15-36 RTRV-STSBIP 15-37 SET-ATTR-CONT 15-38 SET-ATTR-ENV 15-40 SET-CONDATTR-COM 15-44 SET-CONDATTR-rr 15-45 SET-NTFCNCDE 15-47 SET-STSBIP-OFF 15-48 SET-STSBIP-ON 15-49
15-1
SDCC detailed command descriptions

DLT-LLSDCC 16-2 ED-LLSDCC 16-3 ED-ULSDCC 16-6 ENT-LLSDCC 16-8 RTRV-LLSDCC 16-9 RTRV-ULSDCC 16-12
16-1
Initialization detailed command descriptions

INIT-COLD 17-2 INIT-WARM 17-4
17-1
Path and section trace detailed command descriptions

ED-STS1 18-2 RTRV-PTHTRC-STS1 18-4 RTRV-TRC-OC3 18-6
18-1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Contents ix
Network processor command descriptions

ADD-SOC 19-3 DLT-FAC 19-4 DLT-PVC 19-5 ED-IP 19-6 ED-LLX25 19-8 ED-PTX25 19-9 ED-ULSDCC 19-11 ED-ULX25 19-13 ED-VC 19-15 ENT-FAC 19-17 RMV-SOC 19-18 RTRV-CHK-SUM 19-19 RTRV-CONFIG 19-20 RTRV-FAC 19-21 RTRV-IP 19-23 RTRV-LLX25 19-24 RTRV-PTX25 19-25 RTRV-SOC 19-26 RTRV-ULSDCC 19-27 RTRV-ULX25 19-28 RTRV-VC 19-30
19-1
Software upgrade detailed command descriptions

CANC-UPGRD 20-2 CHK-UPGRD 20-3 CMMT-UPGRD 20-5 DLT-UPGRD 20-6 INVK-UPGRD 20-7 LOAD-REPLACE 20-8 LOAD-UPGRD 20-9 RTRV-SPACE 20-11 RTRV-UPGRD 20-12
20-1
Automatic reports
REPTÂLM^COM 21-3 REPTÂLMÊC1 21-6 REPTÂLMÊIM 21-9 REPTÂLMÊNV 21-12 REPTÂLMÊQPT 21-16 REPTÂLM^FAC 21-19 RTRVÂLMÎMA T1 21-21 REPTÂLMÔC3 21-24 REPTÂLM^STS1 21-27 REPTÂLM^STS3C 21-29 REPTÂLM^T1 21-31 REPTÂLM^T3 21-34 REPTÂLM^VP 21-37 REPTÂLM^VT1 21-40 REPT^CONFIG^CHG 21-43
21-1
x Contents REPT^DBCHG 21-44 REPTÊVT^COM 21-46 REPTÊVTÊQPT 21-48 REPTÊVTÊC1 21-52 REPTÊVTÔC3 21-54 REPTÊVT^STS1 21-57 REPTÊVT^STS3C 21-59 REPTÊVT^T1 21-61 REPTÊVT^T3 21-64 REPTÊVT^VT1 21-67 REPTÊX 21-69 REPT^SOC 21-71
Error codes and messages Index
22-1 23-1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
xi
About this document

This document provides details of the Transaction Language 1 (TL1) network surveillance and provisioning implementation on OC-3 Express and Express CX network elements. Topics covered include the following: TL1 message common structure, syntax, and description description of each TL1 message parameter
Supported software releases

This document supports the software releases for OC-3 Express Release 4.0 and OC-3 Express CX Release 1.1.
Who should use this guide

This book is for the following members of the operating company: planners provisioners network administrators transmission standards engineers maintenance personnel
xii About this document
Technical support and information

For technical support and information from Nortel (Northern Telecom), refer to the following tables. United States Regional Service Centers In the United States, direct requests for information to the nearest regional service center.
For 24-hour emergency technical support For assistance restoring service on equipment which has been carrying traffic and is out of service, call the following toll-free number: 800-275-3827 (800-ASK-ETAS) For technical support from 8 a.m. to 10 p.m. EST Call the following toll-free number: 800-275-8726 (800-ASK-TRAN) Southern Region Northern Telecom Inc. 5555 Windward Parkway West, Building B Alpharetta, Georgia 30201 (770) 661-4050 Central Region Northern Telecom Inc. 475 Martingale Road Schaumburg, Illinois 60173 1-800-466-7835 Pacific Region (North) Northern Telecom Inc. 2305 Camino Ramon San Ramon, California 94583 (510) 867-2091 or 1-800-456-0854 Pacific Region (South) Northern Telecom Inc. 300 North Lake Avenue Pasadena, California 91101 (818) 584-2000 Northeast Region Northern Telecom Inc. 200 Summit Lake Drive Valhalla, New York 10595 (914) 773-2559 Western Region Northern Telecom Inc. 5575 DTC Parkway, Suite 150 Englewood, Colorado 80112 (303) 850-5600 Southwest Region Northern Telecom Inc. 2221 Lakeside Blvd., FL 9 Richardson, Texas 75082-4399 (972) 684-1000 Eastern Region Northern Telecom Inc. 2010 Corporate Ridge McLean, Virginia 22102 1-800-275-8726
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
About this document xiii
Canada Technical Assistance Service Centers In Canada, direct requests for information to the nearest technical assistance service center.
For 24-hour emergency technical support For assistance with problems that can lead to payload-affecting failures or issues that prevent payload protection switching, call the following numbers: 800-361-2465 or 514-956-3500 For 24-hour emergency recovery For assistance restoring service on equipment that has been carrying payload and is out of service, call ETAS at the following number: 613-226-5456 For non-emergency support from 8:00 a.m. to 4:00 p.m. Call the regional Field Service Engineering (FSE) group in your Technical Assistance Service Center. FSE West (British Columbia, Yukon, and Northwest Territories) Northern Telecom Canada Limited #410 - 13251 Delf Place Richmond, British Columbia V6V 2A2 (604) 244-4179 FSE West (Manitoba, Northwestern Ontario) Northern Telecom Canada Limited 360 Main St., Suite 1400 Winnipeg, Manitoba R3C 3Z3 (204) 934-7530 Ontario Northern Telecom Canada Limited PO Box 3000 Brampton, Ontario L6V 2M6 (905) 863-4181 or 1-800-684-3578 FSE East (Newfoundland) Northern Telecom Canada Limited 63 Thorburn Rd. St. Johns, Newfoundland A1B 3M2 (709) 722-2500 FSE East (Nova Scotia, Prince Edward Island) Northern Telecom Canada Limited 1701 Hollis St., Suite 900 Halifax, Nova Scotia B3J 3M8 (902) 421-2306 FSE West (Saskatchewan) Northern Telecom Canada Limited PO Box 770 Regina, Saskatchewan S4P 3A8 (1867 Hamilton Street, 8th Floor) (306) 791-7108 Quebec Northern Telecom Canada Limited 9300 TransCanada Highway St. Laurent, Quebec H4S 1K5 (514) 956-3500 FSE East (New Brunswick) Northern Telecom Canada Limited 1 Brunswick Square, 4th Floor Saint John, New Brunswick E2L 4K2 (506) 632-8271 or (506) 632-8203 FSE West (Alberta) Northern Telecom Canada Limited 10235-101st Street Edmonton, Alberta T5J 3G1 (403) 441-3193
xiv About this document
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
1-1
Introducing OC-3 TL1
1-
This chapter provides an introduction to the Transaction Language 1 (TL1) used on the network element and the network processor (NP). TL1 is a common language protocol for messages exchanged between network elements and NPs in an OC-3 Express or Express CX network. TL1 is the primary user interface to the network element and NP, and is used to operate, administer, maintain, and provision the network. The TL1 implementation on the network element and NP allows the user to perform the following functions: commissioning testing provisioning alarm and network surveillance performance monitoring protection switching network security and administration inventory retrieval
Standards compliance The TL1 interface complies with the Bellcore standard TR-TSY-439, Operations Technology Generic Requirements (OTGR): Section 12.3, TR-TSY-833, Issue 3: Network Maintenance - Network Element and Transport Surveillance Messages Section 12.2, TR-NWT-199, Issue 2: Operations Application Messages and Memory Administration Messages, Specifications of Memory Administration at the OS/NE Interface Section 12.5, TR-NWT-835, Issue 2: Operations Application Messages Network Element (NE) Security Parameter Administration Messages
1-2 Introducing OC-3 TL1
TL1 user interface on the network element

The TL1 interface is a text-based, single command line user interface. On the OC-3 Express shelf, the TL1 user interface is obtained by connecting a VT100 or other ANSI, standard terminal to a DB-9, RS-232, DTE, craft access port on the left input/output (LIO), or to the DB-25, RS-232, DCE, craft access port on the shelf processor circuit pack. On the OC-3 Express CX shelf, the TL1 user interface is obtained by connecting a VT100 or other ANSI, standard terminal to a DB-9, RS-232, DTE, craft access port on the input/output (I/O) module, or to the DB-9, RS-232, DCE, craft access port on the shelf processor circuit pack. All network elements in the system can be accessed from any other network element in the system.
TL1 user interface on the network processor

The TL1 interface on the NP allows the retrieval of all TL1 alarms and events from the network elements in the NP span of control. The TL1 interface also allows provisioning of NP facilities, X.25 parameters, an IP address and up to three manual area addresses. The NP requires one of the following connections: backplane connection from the co-located shelf processor (SP) to the NP through OSI/Ethernet (10base T). You can access the NP using a VT100 compatible terminal connected to any network element in the system. You do not have to log in to the local network element to log in to the NP PC GUI to NP through TCP/IP over Ethernet (10base T) INM Broadband/OC-3 Express TL1 Managed Object Agent (MOA) to NP through TCP/IP over Ethernet (10base T) an operations support system (OSS) to NP through the X.25 port on the right input/output (RIO)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Introducing OC-3 TL1 1-3
TL1 command interface

Obtaining the TL1 prompt The TL1 prompt is indicated by a less than sign (<) on the left side of the screen. The prompt appears in response to the semi-colon (;) from the terminal keyboard. TL1 commands are executed from the TL1 prompt. The TL1 interface switches all input commands to uppercase characters on-screen even if they are entered in lowercase. Note: TL1 uses a semi-colon (;), not a carriage return, as a line terminator. The semi-colon is shown at the end of all TL1 commands in this guide. User identifier The user identifier (UID) is a unique non-confidential name to identify each authorized system user. UIDs are between 1 and 10 alphanumeric characters. It is essential to have a UID to activate a user login session. Password identifier The password identifier (PID) is a confidential code to qualify the authorized system user to access the account specified by a UID. It is essential to use the PID to activate a user login session to the UID specified, or change the current PID to a different PID. Password identifiers are between 5 and 10 characters. PIDs are a combination of alphanumeric (A-Z, 0-9) and special characters. The following special characters are supported for the password: !#$%`()*+-./<=>@[]^_'{|}. The following characters are not supported for the PID: semicolon (;), colon (:), ampersand (&), backslash (\), comma (,), spaces (deleted as entered), lowercase (switched to uppercase as entered), all control characters, and question mark (?). Note: Carriage returns (the <Enter> key) are always ignored by the TL1 interface.
Security access level When logging in to a network element or an NP, an account name and password are used. Each account is created by the user of a master account. During account creation a security access level is assigned from 1 through 5 on the network element or the NP. This number is called the user privilege code (UPC). The UPC security levels offer access to a range of task execution capabilities as follows: Surveillance - level 5, allows surveillance of all OC-3 Express and Express CX network elements in the NP span of control. A user account with a level 5 UPC is valid only under the following circumstances: a remote login to the NP from the OC-3 Express TL1 MOA a login to the NP if the NP is the gateway to the network Note 1: A user account with a level 5 UPC cannot be used to access an OC-3 Express or Express CX network element. Note 2: On the NP, only one level 5 user account can be active at a time. Administration - level 4, allows complete access to all commands and processes; level 4 can be assigned to more than one account so that several users have full privilege access to a network element Provisioning - level 3, allows access to provisioning, testing, editing, and deleting commands Control - level 2, permits access to operate, release, and retrieve commands but not provisioning Retrieve - level 1, allows retrieve and report related commands to be executed; because of its limitations, level 1 is suitable as a login ID for a monitoring process To execute TL1 commands, you must log in using an account with the sufficient UPC level. Target identifier and source identifier Every TL1 command includes a target identifier (TID) as part of the syntax. The TID is a non-confidential code to identify the network element or NP being addressed. It is the name of the network element or NP. If a TID is not entered in the TL1 command, the local TID is substituted. You must enter a TID to send the command to a remote network element or remote NP. TIDs must be between 1 and 20 alphanumeric characters and are assigned using the SET-SID command. The first character must be a letter (lowercase letters are changed to uppercase letters). The remaining characters can be any combination of letters (changed to uppercase), numbers, or dashes (-).
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Enclose the TID in double quotes () to include any combination of lower case or special characters. The string, enclosed by the double quotes, cannot include the following characters: backslash (\), space, and double quotes (). Note: Source identifier (SID) is the term used to identify the TID in a received message or response. Default TID The TID identifies the network element or NP where you are sending a command. When you have multiple sessions active, you can issue commands to any of the network elements or NPs you are logged into. If a TID is omitted from a command, the local TID is inserted by the TL1 interpreter. Multiple sessions You can use the ACT-USER command to log in to 20 network elements at a time. For more information on multiple sessions, see ACT-USER on page 2-3.
TL1 message notation

The following notation is used to define the syntax of the TL1 messages.
Symbol <cr> <lf> ^ <ctrl> + ; Meaning ASCII carriage return ASCII line feed ASCII space ASCII control key Symbol used in response block syntax Semicolon command or message terminator, used instead of Return to execute commands
Access identifier An access identifier (AID) appears in most command argument strings. The AID identifies the equipment or facilities to be accessed by the command. Correlation tag The TL1 interface requires a sequential command identifier to be used with every command input. The identifier is called a correlation tag (CTAG). If a CTAG is not entered as part of the command, the command will be rejected. The CTAG is returned with all response messages including confirmation, failed and syntax error messages, and retrieved reports. A CTAG is not returned with a scheduled report. Note: An automatically generated message has an automatic tag (ATAG) instead of a CTAG. The ATAG is a unique numeric string generated by the system. The CTAG correlates the command to the result of the command. The format of the CTAG is alphanumeric and can be up to six characters in length. The CTAG can be used creatively to reflect its purpose, for example, JOB28, TAG33.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Command structure TL1 commands use a rigid structure. A command always begins with a verb, followed by a hyphen and a modifier. A second hyphen and a secondary modifier may follow. The TID and AID follow, then the CTAG and any additional parameters used by the command: VERB-MODIFIER:TID:AID:CTAG::parameter-list; Command elements are separated by punctuation marks, fields by colons (:) and subfields by commas(,). The order of AID, CTAG, and additional parameters can vary from one command group to another. Command grouping TL1 allows command grouping for some commands. This technique can be used to save time and typing of repetitive command lines. The general format of command grouping is as follows: VERB-MODIFIER:tid:aid:ctag::parameter&parameter,value&value:; Mandatory punctuation TL1 commands use colons and commas as command element separators and a semicolon to terminate the command line. TL1 also uses ampersands (&) as group item separators where command grouping is supported. All punctuation shown in the command descriptions must be used or the command will fail to execute. TL1 command acknowledgment Whenever a TL1 command is entered, the system responds with the letters IP for in progress and the CTAG entered. Until the command either completes successfully or fails, the TL1 prompt does not return. Since no other command can be executed until the prompt returns, the same CTAG can be used in every subsequent command.
TL1 message overview

This section describes the TL1 message types, the common elements present in all TL1 messages, and the responses to TL1 non-autonomous requests. TL1 autonomous messages are also referred to as automatic output (see the RTRV-AO command). TL1 message types There are two types of TL1 messages: autonomous and non-autonomous. Each consists of a header and a message block. Autonomous messages are generated by a network element as a result of activity on the network element (such as alarms, non-alarmed events, protection switch activity, and performance monitoring threshold alerts). These messages are generated automatically. Alarms, events and PM threshold crossing alerts are broadcast to all user sessions active on the SID. Up to 10 user sessions can be active at one time. No information request is required to receive autonomous messages. Non-autonomous messages are the network element response to a TL1 command. TL1 command response header A response is identified by a two-line header that indicates the origin of the message, time and date, and whether the command successfully executed. The second line always begins with the letter M to indicate it is a response message.
Normal response syntax <cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> M^^<ctag>^COMPLD <cr> <lf> ; Response block
All retrieve commands return a response block <rspblk> in the third line as follows:
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> M^^<ctag>^COMPLD <cr> <lf> <rspblk> ;
The response block contains command-specific details retrieved. The maximum size of the response block is 32 lines. Any response longer than 32 lines is divided into multiple responses.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Introducing OC-3 TL1 1-9 Error responses
If a TL1 command is unsuccessful, a DENY response with a TL1 error is returned. The response includes an error code. The error codes are reported along with a description of the situation under which the problem occurred. The error response follows the syntax:
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> M^^<ctag>^DENY <cr> <lf> ^^^<errcde> <cr> <lf> ^^^/*error text*/ <cr> <lf> ;
All TL1 error codes are listed in Chapter 20, Error codes and messages.
Autonomous messages format
The network element reports all alarms and events autonomously to all sessions logged in through the TL1 interface. The alarm reports are generated by events or faults in facilities or equipment, environmental faults, or performance monitored threshold crossings. Autonomous reports display a header similar to that of command response headers. The second line begins with either the letter A indicating that it reports an autonomous event, or an alarm code indicating the severity of the alarm. The second element of the second line is always a numeric autonomous tag followed by a report label:
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A|<almcde>^^|^<atag>^REPT^MODIFIER^MODIFIER <cr> <lf> <rspblk> ;
The report label (REPT^MODIFIER^MODIFIER) indicates whether a facility (EC-1, OC-3, T1, T3, STS-1, STS-3c, or VT1.5), common (COM), environmental (ENV), equipment (EQPT) or shelf (FAC, CONFIG, EX) alarm or event has been generated. The response block (rspblk) is the response to either a command, scheduled report, or fault. It contains several elements to identify the specific nature of the problem. The names and significance of each is specific to the type of report.
Editing features
The OC-3 Express and Express CX support the following editing features: <ctrl>+a, recalls the last command line to the current line <ctrl>+u, deletes the current command line backspace arrow keys are not supported if the TID is left blank, the TL1 command interpreter fills in the empty space with the default TID
Online syntax help

The OC-3 Express and Express CX have a built-in help system in the TL1 interface. When typing TL1 commands you can enter an incomplete command terminated with a question mark (?) at the point where syntax help is needed. The interface responds with syntax choices for that command element. The rule applies throughout the command, from first letter onward. For example entering A?; displays a list of all commands beginning with A. When you log in to an OC-3 Express network element, the following message appears indicating some of the online help functions:
Version 3.0: Welcome to NORTEL's S/DMS TransportNode OC-3 Express Shelf. /* * Starting Interactive TL1 Command Mode. * Type ? for help while constructing TL1 commands. * Type .? for specific parameter/keyword help. */
For example, entering

< ENT?
returns the following list:

/* * Applicable Command(s): * * ENT-CRS-VT1 * ENT-EQPT * ENT-OC3 * ENT-SECU-USER * ENT-T1 */
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
The help function can be called at any point in the syntax and the response is always context sensitive. For example, entering
< ENT-SECU?
returns the following:

/* * Applicable Command(s): * * ENT-SECU-USER */
To get the whole command syntax structure enter

< ENT-SECU-USER?
and the following results:

/* * Input Format: * ENT-SECU-USER:[TID]:UID:CTAG::PID,,UPC:TMOUTA=DOMAIN; */
Entering a question mark in a specific field such as the TID

< ENT-SECU-USER:?
results in a field-specific response as follows:

/* * Input Format: * ENT-SECU-USER:[TID]:UID:CTAG::PID,,UPC:TMOUTA=DOMAIN; * * Explanation of Parameters/Keywords: * * TID (Target Identifier) * ------------------------------------------------------------* Descr: 7-20 alphanumeric characters * Local: ALADDIN06 * Previous: ALADDIN06 */
The following example illustrates that a question mark can be entered in any field, such as the UID below
< ENT-SECU-USER::?
and the response is always context specific:

/* * Input Format: * ENT-SECU-USER:[TID]:UID:CTAG::PID,,UPC:TMOUTA=DOMAIN; * * Explanation of Parameters/Keywords: * * UID (User Identifier) * ------------------------------------------------------------* Descr: 1-10 alphanumeric characters * Example: ADMIN, OPERATOR, USER03 */
The TL1 online help function prompts you to enter correct length and content values for all fields in every command and gives examples. The interface specifies if a field should be left null. Entering a question mark in a field with multiple components returns an explanation of all the components. For example, entering
< ENT-SECU-USER::COLIN:123::?
results in the following:

/* * Input Format: * ENT-SECU-USER:[TID]:UID:CTAG::PID,,UPC:TMOUTA=DOMAIN; * * Explanation of Parameters/Keywords: * * PID (Private Identifier (i.e. password)) * ------------------------------------------------------------* Descr: 1-10 alphanumeric characters * Example: ADMIN, OPERATOR, USER03 * * UPC (User Privilege Code) * ------------------------------------------------------------* 1 Retrieve Privilege * 2 Control Privilege * 3 Provisioning Privilege * 4 Administration Privilege */ S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998
However entering period+question mark (.?) as follows:

< ENT-SECU-USER::COLIN:123::.?
results in the following:

/* * Input Format: * ENT-SECU-USER:[TID]:UID:CTAG::PID,,UPC:TMOUTA=DOMAIN; * * Explanation of Parameters/Keywords: * * PID (Private Identifier (i.e. password)) * ------------------------------------------------------------* Descr: 1-10 alphanumeric characters * Example: ADMIN, OPERATOR, USER03 */
The response detail is limited to only the first comma delimited parameter (PID) being treated by online help. Any comma delimited parameter can be isolated by the online help system by using period+question mark (.?). Help can be used in the middle of a command parameter as well, to list all commands of a certain type. For example, entering
< INIT-R?
returns the following:

/* * Applicable Command(s): * * INIT-REG-ALL * INIT-REG-OC3 * INIT-REG-T1 */
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
2-1
Security and administration detailed command descriptions 2This chapter is an alphabetical summary of the TL1 commands related to security and administration. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. Most commands in this chapter are supported on the OC-3 Express network element, the OC-3 Express CX network element, and the network processor (NP). The following table lists all the commands in this chapter.
Command ACT-USER CANC-PROV CANC-USER CHK-PROV CMMT-PROV DLT-PROV DLT-SECU-USER ED-DAT ED-SECU-PID ED-SECU-USER ENT-SECU-USER RST-PROV RTRV-ACTIVE-USER
continued
Page 2-3 2-4 2-5 2-6 2-9 2-10 2-12 2-13 2-14 2-16 2-18 2-20 2-23
2-2 Security and administration detailed command descriptions Command RTRV-HDR RTRV-HELP RTRV-PROV-LST RTRV-SECU-UPC RTRV-SECU-USER SAV-PROV SET-SID VALD-PROV Page 2-24 2-25 2-26 2-28 2-29 2-31 2-34 2-36
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-3
ACT-USER
The Activate User command is used to log in to the network element or the network processor (NP). You must have a valid user identifier (UID) and password identifier (PID) to use this command. Up to 100 unique accounts can be created for one network element but only 10 TL1 user sessions using these accounts can be active at one time on one network element. Up to 100 accounts can be created for the NP as well, but only 34 TL1 user sessions can be active at one time on one NP. To log out see the CANC-USER command. You can use ACT-USER to log in to a maximum of 20 network elements at one time. To maintain multiple logins all network elements must be interconnected. Once you have activated sessions to a number of network elements, most TL1 commands can be addressed to all the network elements simultaneously. Note: A maximum of two users can log in locally to the same OC-3 Express network element. Once you are connected to an NP, you can log in to a maximum of 20 NPs or network elements, if the nodes are interconnected. Only one account with a level 5 UPC can be active at a time on the network element or the NP. Security level Level 1 Input syntax
ACT-USER:[TID]:UID:CTAG::PID; Table 2-1 Syntax definition Field TID UID CTAG PID Example input Purpose Target identifier User identifier Correlation tag User password identifier
Log in to network element NEWYORK using the account ADMIN:

ACT-USER:NEWYORK:ADMIN:IL123::SESAME;
Note: The password is not displayed when it is typed in.

2-4 Security and administration detailed command descriptions
CANC-PROV
The Cancel Provisioning (CANC-PROV) command is used to cancel a SAV-PROV, RST-PROV, or CMMT-PROV action in progress. In addition it cleans-up any backup files left in an invalid state by the SAV-PROV or RST-PROV, or CMMT-PROV disconnects any file transfer connections left behind by the SAV-PROV or RST-PROV clears any in progress alarms raised by the SAV-PROV, RST-PROV, or CMMT-PROV cancels the failure state that may exist
Security level Level 3 Input syntax

CANC-PROV:[TID]::CTAG; Table 2-2 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Cancel a SAV-PROV command executed on shelf processor OTTAWA:

CANC-PROV:OTTAWA::CTAG99;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
CANC-USER
The Cancel User command is used to log out of an active session with the network element or network processor. Regardless of privilege, no account can be logged out by a CANC-USER command from a different user account. However an INIT-WARM and INIT-COLD command will log out all currently active sessions. Note: The UID must be used to log out any account. If a user remains logged in to an account on the local network element and another user wants to log the user out but does not know the UID of the first user, the only way to log out the account is to disconnect the RS-232 cable from the craft access port, or turn off the power to the VT100 terminal. Security level Level 1 Input syntax
CANC-USER:[TID]:UID:CTAG;
Note: ALL is a valid target identifier (TID).

Table 2-3 Syntax definition Field TID UID CTAG Example input Purpose Target identifier User identifier Correlation tag
Log out SYSOP from the network element WASHINGTON:

CANC-USER:WASHINGTON:SYSOP:TN777;
CHK-PROV
The Check Provisioning (CHK-PROV) command is used to do pre-checks on the shelf processor (SP) or network processor (NP) for which the provisioning data is to be saved or restored. These checks include whether the given destination is reachable (if the DESTTYPE and DESTADDR options are included). If the file transfer connection cannot be made or if the destination is involved in a duplicate SID, the check fails. the given userid and password are valid (if the USERID and PASSWD options are included). If either the user name or password are not valid the check fails. the system is in one of the following preventative states - upgrade in progress - load mismatch - inservice rollover in progress (SP only) - disk is full (NP only) - duplicate source identifier (SID) - database save and restore in progress - database save and restore has failed If the system is in a preventative state the check fails. any alarms are raised on the SP or NP (if the CHKALM option is omitted or given the value Y). If any alarms are raised on the SP or NP the check fails. The CHK-PROV command, although optional, should always be sent before sending a SAV-PROV or a RST-PROV to an SP or NP. Note: Only one save and restore command can occur at a time, with the exception of CANC-PROV. Security level Level 3 Input syntax
CHK-PROV:[TID]::CTAG::[USERID,PASSWD]: [DESTTYPE=Domain[,DESTADDR=Domain]][,CHKALM=Domain];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Table 2-4 Syntax definition Field TID CTAG USERID PASSWD DESTTYPE Purpose Target identifier Correlation tag User login name (If the CHK-PROV is from anSP to an NP, omit USERID.) User login password (If the CHK-PROV is from anSP to an NP, omit PASSWD.) Destination type Type of destination of the Save or source of the Restore TID, IP, or locally attached PCGUI. DESTADDR Destination address Address of the Destination type (TID or IP) which is the destination of the Save or source of the Restore. For a DESTTYPE of PC, omit DESTADDR. CHKALM Table 2-5 Keyword descriptions Keyword USERID Domain User ID Description A unique, non-confidential identifier of 1 to 12 alphanumeric characters (including double quotes) used to identify each authorized system user A confidential code name of 1 to 32 alphanumeric characters (including double quotes) used to activate a user login session Target Identifier Internet Protocol Locally attached PCGUI
continued
Check alarm status
PASSWD
Password
DESTTYPE
TID IP PC
2-8 Security and administration detailed command descriptions Table 2-5 Keyword descriptions Keyword DESTADDR Domain Description
TID address Name of the network element, NP, or OPC IP address A network element or NP identifier in the format x.x.x.x (where x = a number from 1-255) A CHK-PROV is not allowed if there is an alarm present on the NP or SP card receiving the command A CHK-PROV is allowed whether or not there is an alarm present on the NP or SP card receiving the command. If the CHK-PROV command is sent with the CHKALM=N and some preventative states exist, the command will fail.
CHKALM
Y (default) N
Example input
Check network processor MONTREAL prior to saving its provisioning data to a UNIX workstation:
CHK-PROV:MONTREAL::CTAG98::ORIGSIN98,EXCULP99: DESTTYPE=IP,DESTADDR=47.124.9.88,CHKALM=Y;
or Check network processor MONTREAL prior to saving its provisioning data to an OPC. Use a quoted string for USERID and PASSWD:
CHK-PROV:MONTREAL::CTAG98::quasimoto,his,:password: DESTTYPE=TID,DESTADDR=OPCOTTAWA,CHKALM=Y;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
CMMT-PROV
The Commit Provisioning (CMMT-PROV) command is used to commit the files which have been restored to an SP or NP by the RST-PROV command. The CMMT-PROV command checks to see if there are any outstanding reasons not to commit the data at this time. If there are no reasons, it will commit the data and cause a special reset. It will also clear the Database Restore in Progress alarm. Security level Level 3 Input syntax
CMMT-PROV:[TID]::CTAG; Table 2-6 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Commit provisioning data that has been restored to shelf processor OTTAWA:
CMMT-PROV:OTTAWA::CTAG93;
DLT-PROV
The Delete Provisioning (DLT-PROV) command is sent to a network processor (NP) to delete shelf processor (SP) backups that reside on the NP. For each SP backup directory that is deleted from the NP, a TL1 message stating that the backup has been deleted is displayed. Security level Level 3 Input syntax
DLT-PROV:[TID]::CTAG::[DLTALL]:[DLTBKUP=Domain]; Table 2-7 Syntax definition Field TID CTAG DLTALL DLTBKUP Purpose Target identifier Correlation tag Deletes all SP backups on an NP Specifies the TID of an SP whose backup is to be deleted from an NP
Table 2-8 Keyword descriptions Keyword DLTALL DLTBKUP Domain DLT_ALL_BACKUPS TID of SP Description Delete all SP backups on the NP Name of the SP whose backup is to be deleted from the NP
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-11 Example input
Delete the provisioning data on network processor MONTREAL that was backed-up from shelf processor OTTAWA:
DLT-PROV:MONTREAL::CTAG:::DLTBKUP=OTTAWA;
The response displayed is as follows:

MONTREAL 98-07-30 04:03:35 M A COMPLD Deleting SP Backups from NP Backup for OTTAWA deleted
Response block syntax The response display is as follows:

<SID><DATE><TIME> Deleting SP Backups from NP Backup for <TID> deleted
If no SP backups are deleted, the response display is as follows:

<SID><DATE><TIME> Deleting SP Backups from NP No Backups deleted Table 2-9 Response block description Keyword SID DATE, TIME TID Description Source identifier of the NP storing the SP data Date and time of SP deletion Target identifier of each SP deleted
DLT-SECU-USER
The Delete Security User command is used to delete a user account on the network element or the network processor. To change the UPC, see ED-SECU-USER. Users with ADMIN privilege cannot delete their own UID. This ensures that at least one UID with ADMIN privilege always exists. If a user attempts to delete their UID, the error response *Privilege, Illegal User Code* is displayed. Security level Level 4 Input syntax
DLT-SECU-USER:[TID]:UID:CTAG;

Delete the user account USER03 from network element NEWYORK:

DLT-SECU-USER:NEWYORK:USER03:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-DAT
The Edit Date command instructs the network element or network processor to change its system date and time clock to the value specified. The date and time are set up on the network element as part of commissioning, and on the NP when the NP is initially provisioned. The date and time must be reset after a system restart. Security level Level 3 Input syntax
ED-DAT:[TID]::CTAG::[date],[time];

Table 2-11 Syntax definition Field TID CTAG DATE TIME Purpose Target identifier Correlation tag Current date. A null value for DATE leaves the date unchanged. Current time. A null value for TIME leaves the time unchanged.
Table 2-12 Parameter descriptions Parameter DATE Format Description
YY-MM-DD YY is the last two digits of the year ranging from 00 to 99, MM is the month of the year ranging from 01 to 12, and DD is the day of the month ranging from 01 to 31. HH-MM-SS HH is the hour ranging from 00 to 23, MM is the minute ranging from 00 to 59, and SS is the second ranging from 00 to 59.
TIME
Example input
Set the date and time on the network element to April 15, 1995, 9:30 a.m.:
ED-DAT:NEWYORK::CTAG12::95-04-15,09-30-00;
ED-SECU-PID
The Edit Security Password Identifier command is used by users to edit their own accounts password on the network element or the network processor. This command cannot be used to edit the password of another user. Password identifiers (PIDs) are between 5 and 10 characters. PIDs can include alphabetical characters, numbers, and the following symbols: !#$%`()*+-./<=>@[]^_'{|} Unsupported characters include: semicolon (;), colon (:), ampersand (&), backslash (\), comma (,), spaces (deleted as entered), lowercase (switched to uppercase as entered), all control characters, and question mark (?). Note 1: The password must contain at least one alphanumeric character. Note 2: The double quote () must always be preceded by a backslash (\). The backslash is considered as a character in the length of the password. Note 3: Carriage returns (<Enter>) are always ignored by the TL1 interface. Security level Level 1 Input syntax
ED-SECU-PID:[TID]:UID:CTAG::OldPID,NewPID,NewPID;
Note 1: ALL is a valid target identifier (TID). Note 2: Passwords entered in TL1 commands are not echoed to the UI screen. Note 3: In OC-3 Express, passwords must be entered twice for confirmation. In OC-3 Express CX, passwords are only entered once.
Table 2-13 Syntax definition Field TID UID CTAG OldPID NewPID Purpose Target identifier User identifier Correlation tag Old user password identifier New user password identifier
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-15 Example input
Change the password for user FORD on OC-3 Express network element NEWYORK from PREFECT to PENGUINE:
ED-SECU-PID:NEWYORK:FORD:CTAG12::PREFECT,PENGUINE,PENGUINE;
Change the password for user FORD on OC-3 Express CX network element NEWYORK from PREFECT to PENGUINE:
ED-SECU-PID:NEWYORK:FORD:CTAG12::PREFECT,PENGUINE;
ED-SECU-USER
The Edit Security User command is used to edit the security parameters associated with a user account on the network element or the network processor. Enter only the data parameters you want to change. The remaining attributes are not altered. The user identifier (UID) can be 1 to 10 alphanumeric characters. Parameter grouping of UIDs is not possible. A maximum of 100 UIDs can be added to the password file. If you try to create UID 101, the error message /*Status, List Exceeds Maximum*/ is displayed. Users with ADMIN privilege (level 4) cannot change their own UPC to a level below 4. This is to ensure that at least one UID with ADMIN privilege always exists. The last account in the network element with level 4 privilege cannot be deleted. Security level Level 4 Input syntax
ED-SECU-USER:[TID]:UID:CTAG::[NEWUID],[NEWPID],[NEWPID],[UPC]: [TMOUTA=Domain][,TMOUT=Domain];
Note 1: ALL is a valid target identifier (TID). Note 2: Passwords entered in TL1 commands are not echoed to the UI screen. Note 3: Passwords must be entered twice for confirmation Note 4: OC-3 Express CX does not support the [TMOUT=Domain] parameter.
Table 2-14 Syntax definition Field TID UID CTAG NewUID NewPID Purpose Target identifier User identifier Correlation tag New user identifier New user password identifier
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-17 Table 2-14 (continued) Syntax definition Field UPC TMOUTA Purpose User privilege code Automatic timeout flag. The user is automatically logged off from the network element if no valid TL1 command is sent within the specified TMOUT interval. Timeout interval in minutes. A decimal number from 1 to 99. The default is 30 minutes.
TMOUT
Table 2-15 Keyword descriptions Keyword TMOUTA Domain Y Description Timeout enabled. If TMOUTA is enabled and the TMOUT interval is not specified, the default is 30 minutes. Timeout disabled. The user will never be automatically logged off. TMOUT is irrelevant (set to 0 minutes).
Example input
Change UID of ADMIN on network element NEWYORK to ADMIN2:

ED-SECU-USER:NEWYORK:ADMIN:CTAG12::ADMIN2;
Change UID and PID of UID ADMIN on network element NEWYORK to ADMIN2 and NTADMIN respectively:
ED-SECU-USER:NEWYORK:ADMIN:CTAG12::ADMIN2,NTADMIN,NTADMIN :TMOUTA=N;
Change UID and PID of UID ADMIN on network element NEWYORK to ADMIN2 and NTADMIN respectively, with a UPC level change from 4 to 3, and a timeout interval of 60 minutes:
ED-SECU-USER:NEWYORK:ADMIN:CTAG12::ADMIN2,NTADMIN,NTADMIN, 3:TMOUTA=Y,TMOUT=60;
ENT-SECU-USER
The Enter Security User command is used to create a new user account on a network element or network processor and enter the security parameters associated with the account. The network element or network processor is specified by the TID. Note: If a TID is not specified then the local TID is used. Password identifiers are between 5 and 10 characters. PIDs are a combination of alphanumeric (A-Z, 0-9) and special characters. The following special characters are supported for the password: !#$%`()*+-./<=>@[]^_'{|}. Unsupported characters include: semicolon (;), colon (:), ampersand (&), backslash (\), comma (,), spaces (deleted as entered), lowercase (switched to uppercase as entered), all control characters, and question mark (?). Note 1: The password must contain at least one alphanumeric character. Note 2: The double quote () must always be preceded by a backslash (\). The backslash is considered as a character in the length of the password. Note 3: Carriage returns (<Enter>) are always ignored by the TL1 interface. A maximum of 100 UIDs can be added to the password file. If you try to create UID 101, the error message /*Status, List Exceeds Maximum*/ is displayed. Security level Level 4 Input syntax
ENT-SECU-USER:[TID]:UID:CTAG::PID,PID,UPC:TMOUTA=Domain [,TMOUT=Domain];
Note 1: ALL is a valid target identifier (TID). Note 2: Passwords entered in TL1 commands are not echoed to the UI screen. Note 3: Passwords must be entered twice for confirmation. Note 4: OC-3 Express CX does not support the [TMOUT=Domain] parameter.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-19 Table 2-16 Syntax definition Field TID UID CTAG PID UPC TMOUTA Purpose Target identifier User identifier Correlation tag Password identifier User privilege code Automatic timeout flag. The user is automatically logged off from the network element if no valid TL1 command is sent within the specified TMOUT interval. Timeout interval in minutes. A decimal number from 1 to 99. The default is 30 minutes.
TMOUT
Table 2-17 Keyword descriptions Keyword TMOUTA Domain Y Description Timeout enabled. If TMOUTA is enabled and the TMOUT interval is not specified, the default is 30 minutes. Timeout disabled. The user will never be automatically logged off. TMOUT is irrelevant (set to 0 minutes).
Example input
Create an account on OC-3 Express CX network element Seattle, with user name CAM, password VWXYZ, security privilege level 3, and timeout disabled:
ENT-SECU-USER:SEATTLE:CAM:CTAG12::VWXYZ,VWXYZ,3:TMOUTA=N;
Create an account on OC-3 Express network element Seattle, with user name CAM, password VWXYZ, security privilege level 3, and timeout set to 60 minutes:
ENT-SECU-USER:SEATTLE:CAM:CTAG12::VWXYZ,VWXYZ,3:TMOUTA=Y, TMOUT=60;
RST-PROV
The Restore Provisioning (RST-PROV) command is used to restore provisioning data (including that backed-up from circuit packs) to a shelf processor (SP) from a locally attached PCGUI. This function can only be executed by a user through a PCGUI. Note: A locally attached PCGUI is connected directly by RS-232 cable to an SP or PCGUI can be connected to an SP by modem. provisioning data (including that backed-up from circuit packs) to a SP from a network processor (NP) provisioning data (including that backed-up from SPs) to a NP from a UNIX workstation or an Operations Controller (OPC)
The RST-PROV command does some basic checks on the integrity of the restored data compares the software release listed in the backup data with the current software release running on the network element (NE). If they are not the same, the restoration fails. if CHKTID=Y or CHKTID is omitted, compares the TID of the network element to which provisioning data is being restored with the stored TID. If they are not the same, the restoration fails.
Security level Level 3 Input syntax

RST-PROV:[TID]::CTAG::[USERID,PASSWD] :DESTTYPE=Domain[,DESTADDR=Domain][,DIR=Domain] [,CHKTID=Domain][,CHKALM=Domain]; Table 2-18 Syntax definition Field TID CTAG USERID PASSWD Purpose Target identifier Correlation tag User login name (If the RST-PROV is from an NP to an SP, omit USERID.) User login password (If the RST-PROV is from an NP to an SP, omit PASSWORD.)
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-21 Table 2-18 Syntax definition Field DESTTYPE DESTADDR Purpose Source of the Restore TID, IP, or locally attached PCGUI Address of the DESTTYPE (TID or IP) which is the source of the Restore For a DESTTYPE of PC, omit DESTADDR DIR CHKTID Directory in which the backed-up provisioning data is stored. Check TID Specifies whether the operation does or does not compare the TID from which the backup was saved with the TID of the SP or NP to which the backup is being restored. CHKALM Table 2-19 Keyword descriptions Keyword USERID Domain User ID Description A unique, non-confidential identifier of 1 to 12 alphanumeric characters (including double quotes) used to identify each authorized system user. A confidential code name of 1 to 32 alphanumeric characters (including double quotes) used to activate a user login session. A remote Restore will be executed using ALFTAM or FTAM protocol to transfer files from the TID given in the DESTADDR parameter to an SP or NP. A remote Restore will be enacted using FTP to transfer files from the IP address given in the DESTADDR parameter to the NP. A local restore will be executed between an SP and a locally attached PCGUI. Name of the Restore source (a network element or NP) consisting of an identifier of 7 to 20 alphanumeric characters. The first character is alphabetic. The address of the Restore source (a network element or NP) consisting of an identifier in the format x.x.x.x (where x=a number 0-255).
continued
Check alarm status
PASSWD
Password
DESTTYPE
TID
IP
PC DESTADDR TID address
IP address
2-22 Security and administration detailed command descriptions Table 2-19 Keyword descriptions Keyword DIR Domain Directory name Description A string of characters that specifies the unique directory name in which the backup is stored. If a directory name parameter is not specified in the command, when restoring provisioning data from an NP to an SP that is in its span of control, the SP uses its TID to derive a default directory name.
Note: SPs only derive a default directory name if they are in the span of control of the destination NP.
When restoring NP provisioning data from an external repository, the name of the directory in which the data is stored must be specified in the command or the command fails. (That is, there is no default directory name.) The directory name is a string of 1 to 60 characters. CHKTID Y (default) N CHKALM Y (default) N Do not skip TID check Skip TID check (Note 1) The RST-PROV is not allowed if there is an alarm present on the NP or SP card. The RST-PROV is allowed if there is an alarm present on the NP or SP card receiving the command except if it is in one of the following states: upgrade in progress, load mismatch, IS rollover in progress, duplicate SID, database save and restore in progress.
Note 1: To restore the provisioning data of an SP to an SP with a different TID or the provisioning data of an NP to an NP with a different TID, set CHKTID to N.
Example input
Restore provisioning data stored on network processor MONTREAL to its original shelf processor in OTTAWA.
RST-PROV:OTTAWA::CTAG96:::DESTTYPE=TID,DESTADDR=MONTREAL, DIR=/saverest/NE01,CHKTID=N;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-ACTIVE-USER
The Retrieve Active User command is used to list all users logged in to a network element or network processor. Security level Level 3 Input syntax
RTRV-ACTIVE-USER:[TID]::CTAG;

Table 2-20 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve a list of all active users logged in to network element NEWYORK:

RTRV-ACTIVE-USER:NEWYORK::CTAG23;
Response block syntax

AID:,UPC::SID
RTRV-HDR
The Retrieve Header command requests that a network element or network processor reply with a normal response indicating COMPLD. The information of interest in the reply is the reply itself, namely the source identifier, the date, and the time. This command can be used to determine how many login sessions to remote network elements or network processors are currently active, or to confirm that a network element or network processor is responding. As part of a surveillance protocol the RTRV-HDR command can also be used to keep login sessions active by preventing timeout from occurring. Security level Level 1 Input syntax
RTRV-HDR:[TID]::CTAG;

Retrieve the header message from network element SEATTLE to verify you are still logged in to the network element and that the session is still active:
RTRV-HDR:SEATTLE::CTAG12;
Retrieve all headers to determine which network elements you are logged in to and that have an active session:
RTRV-HDR:ALL::CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-HELP
The Retrieve HELP command is used to retrieve TL1 command help from either a local or a remote network element. The RTRV-HELP command is used to retrieve help on SP specific commands when the user is on an NP or on NP specific commands when the user is on an SP. If there are no applicable commands matching the command that help is requested for, the response will indicate this. Security level Level 1 Input syntax
RTRV-HELP:[TID]::1::[partial_cmd]; Table 2-22 Syntax definition Field TID CTAG partial_cmd Purpose Target identifier, the network element or network processor to which the command is directed Correlation tag, an alphanumeric identifier to correlate the command and response messages Partial command is optional. Partial_cmd is a string of characters which is a subset of an actual command to be retrieved. Partial_cmd can also be a complete command, in which case the input format for the command is returned.
Example input
Retrieve all the TL-1 commands supported on TID BOSTON:

RTRV-HELP:BOSTON::CTAG12;
Retrieve all the ENT commands supported on TID BOSTON:

RTRV-HELP:BOSTON::CTAG13::ENT;
Retrieve the input format for the ENT-T1 command on TID BOSTON:
RTRV-HELP:BOSTON::CTAG14::ENT-T1;
RTRV-PROV-LST
The Retrieve Provisioning List (RTRV-PROV-LST) command is sent to a network processor (NP) to retrieve a list of the shelf processor (SP) backups stored on the NP. The display will include a list of the SP target identifiers (TID), their associated directory names and the timestamp for each backup. Security level Level 1 Input syntax
RTRV-PROV-LST:[TID]::CTAG; Table 2-23 Syntax definition Field TID CTAG Purpose Target identifier of the NP Correlation tag
Example input
Retrieve a list of the shelf processor backups saved on network processor MONTREAL.
RTRV-PROV-LST:MONTREAL::CTAG95;
The information that will be displayed as a result of this command is as follows:

MONTREAL 98-07-30 03:39:25 M A COMPLD SP Provisioning Database Backups OTTAWA /saverest/NE011998-07-16 10:31:20 NEWYORK /saverest/NE021998-06-18 09:33:17 WATERLOO /saverest/NE031998-06-03 14:55:21

<SID><DATE><TIME> SP Provisioning Database Backups <TID><DIR><TIMESTAMP>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-27 Table 2-24 Response block description Keyword SID DATE,TIME TID DIR TIMESTAMP Description Source identifier of the NP storing the SP data Date and time of list retrieval Target identifier of each SP backed-up on the NP Directory name of each SP backed-up on the NP Date and time of backup
RTRV-SECU-UPC
The Retrieve Security command is used to retrieve your own user privilege code (UPC). You must have level 4 privilege to retrieve the UPC of another user. Security level Level 1 (to retrieve your own user privilege code) Level 4 (to retrieve another users user privilege code) Input syntax
RTRV-SECU-UPC:[TID]:UID:CTAG;

Retrieve security level for account ADMIN:

RTRV-SECU-UPC:WASHINGTON:ADMIN:COOL99;

UID:,UPC
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-SECU-USER
The Retrieve Security User command is used to retrieve the security parameters associated with a user account on the network element or network processor. Note: For security purposes the UPC to execute this command is Level 4 since it provides a list of all accounts and access levels. Users with ADMIN privilege (level 4) cannot change their own UPC to a level below 4. This is to ensure that at least one UID with ADMIN privilege always exists. The last account in the network element with level 4 privilege cannot be deleted. Security level Level 4 Input syntax
RTRV-SECU-USER:[TID]:UID:CTAG;

Retrieve security parameters for account USER1:

RTRV-SECU-USER:SEATTLE:USER1:CTAG23;
Retrieve security parameters for all accounts on network element WASHINGTON:

RTRV-SECU-USER:WASHINGTON:ALL:CTAG12;
Retrieve security parameters for all active login sessions in the span of control where you are logged in:
RTRV-SECU-USER:ALL:ALL:CTAG12;

UID:,UPC:ACTIVE=DOMAIN,TMOUTA=DOMAIN UID:,UPC:ACTIVE=DOMAIN,TMOUTA=DOMAIN Table 2-27 Parameter descriptions Parameter ACTIVE Possible values Y N TMOUTA Y N Description User is logged in User is not logged in Timeout enabled Timeout disabled
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SAV-PROV
The Save Provisioning (SAV-PROV) command is used to save: provisioning data (including that backed-up from circuit packs) from a shelf processor (SP) to a disk on a locally attached PCGUI. This function can only be executed by a user through a PCGUI. Note: A locally attached PCGUI is connected directly to an SP by RS-232 cable or by a modem. provisioning data (including that backed-up from circuit packs) from an SP to a network processor (NP) provisioning data (including that backed-up from SPs) from a NP to a PC or UNIX workstation or an Operatons Controller (OPC)
Prior to executing a SAV-PROV, it is recommended that a CHK-PROV command be executed. Security level Level 3 Input syntax
SAV-PROV:[TID]::CTAG::[USERID,PASSWD]:DESTTYPE=Domain [,DESTADDR=Domain][,DIR=Domain][,CHKALM=Domain];
Note: Passwords entered in TL1 commands are not echoed to the UI screen.
Table 2-28 Syntax definition Field TID CTAG USERID Purpose Target identifier Correlation tag User login name (If the SAV-PROV is from an SP to an NP, omit USERID.) PASSWD User login password (If the SAV-PROV is from an SP to an NP, omit PASSWD.) DESTTYPE Destination type Destination of the Save TID, IP, or locally attached PCGUI.
continued
2-32 Security and administration detailed command descriptions Table 2-28 Syntax definition Field DESTADDR Purpose Destination address Address of the Destination type (TID or IP) which is the destination of the Save. For a DESTTYPE of PC, omit DESTADDR DIR CHKALM Table 2-29 Keyword descriptions Keyword USERID Domain User ID Description A unique, non-confidential identifier of 1 to 12 alphanumeric characters (including double quotes) used to identify each authorized system user. Not used in a SAV-PROV sent to an SP. A confidential code name of 1 to 32 alphanumeric characters (including double quotes) used to activate a user login session. Not used in a SAV-PROV sent to an SP. A remote Save will be enacted using ALFTAM or FTAM protocol to transfer files to the TID given in the DESTADDR parameter. A remote Save will be enacted using FTP to transfer files to the IP address given in the DESTADDR parameter. A local Save will be executed between an SP and a locally attached PCGUI. The address of the destination of the SAVE (when saving SP data to an NP or saving NP data to an OPC) consisting of an identifier of 7 to 20 alphanumeric characters The address of the destination of the SAVE (when saving NP data to a UNIX workstation) consisting of an identifier in the format x.x.x.x (where x=a number 1-255).
continued
Directory used to store provisioning data backup. Check alarm status.
PASSWD
Password
DESTTYPE
TID
IP
PC DESTADDR TID address
IP address
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Security and administration detailed command descriptions 2-33 Table 2-29 Keyword descriptions Keyword DIR Domain Directory name Description A string of characters that specifies the unique directory name in which the backup is stored. When backing-up SP provisioning data to an NP, the directory name parameter is omitted. The SP uses its TID to derive a default directory name. When backing-up NP provisioning data to an external repository, the name for the directory must be specified in the command or the command will fail. (That is, there is no default directory name.) The directory name is a string of 1 to 60 characters. CHKALM Y (default) The SAV-PROV is not allowed if there is an alarm present on the NP or SP card receiving the command. The SAV-PROV is allowed if there is an alarm present on the NP or SP card receiving the command except if it is in one of the following states: upgrade in progress, load mismatch, IS rollover in progress, duplicate SID, database save and restore in progress.
Example input
Save the provisioning data on the network processor MONTREAL to the Operations Controller of network element TORONTO.
SAV-PROV:MONTREAL::CTAG97:::DESTTYPE=TID:DESTADDR=TORONTO, CHKALM=Y;
SET-SID
The Set System Identifier command instructs the network element or network processor to change its system identification (SID) code to a given value. Changing the SID can result in a mismatch of the SID value in the response headers with TID value in commands received before the change. The SET-SID command is inhibited if there is more than one user active (logged in) on the network element. The single user can be locally or remotely connected to the network element when the SET-SID command is issued. Note: A response of /*Status, Requested Command Inhibited*/ indicates that other users are logged into the NE. The other users must log off before you can execute the SET-SID command. If a TID is not entered in the TL1 command, the local TID is substituted. You must enter a TID to send the command to a remote network element or remote NP. TIDs must be between 1 and 20 alphanumeric characters and are assigned using the SET-SID command. The first character must be a letter (lowercase letters are changed to uppercase letters). The remaining characters can be any combination of letters (changed to uppercase), numbers, or dashes (-). Enclose the TID in double quotes () to include any combination of lower case or special characters. The string, enclosed by the double quotes, cannot include the following characters: backslash (\), space, and double quotes (). Note 1: All OC-3 Express and Express CX network elements are preset with a default SID of NORTELOC3. If the network element is connected to another OC-3 Express or Express CX network element, the two network elements must have different names. Therefore as a general rule the default name should always be changed as part of the provisioning process. Note 2: The OC-3 Express network processor is preset with a default SID of NORTELOC3NP. If there is more than one network processor in the network, then the two network processors must have different names. Therefore as a general rule the default name should always be changed as part of the provisioning process. If the SID is changed, the new name is not recognized by the TBOS display mapper. To re-assign the network element to the correct TBOS display number, use the SET-TBOS command. Note: After a shelf processor or network processor restart, the Duplicate SID alarm is masked for 20 minutes.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
When the SET-SID command is complete, the local session continues unchecked. However, the remote association is dropped and the message /*Status, Remote Session Dropped*/ is displayed at the remote network element. To re-establish the association, issue the ACT-USER command to the network element using the new TID. Note: The timestamp for the /*Status, Remote Session Dropped*/ message generated at the remote network element displays the time at the local network element. Security level Level 3 Input syntax
SET-SID:[TID]::CTAG::SID; Table 2-30 Syntax definition Field TID CTAG SID Purpose Target identifier Correlation tags Set source identifier, the new SID allocated to the NE specified by the TID.
Example input
Change the name of a network element called NEWYORK to BOSTON2:

SET-SID:NEWYORK::MA999::BOSTON2;
VALD-PROV
The purpose of the Validate Provisioning (VALD-PROV) command is to check whether the restored data that currently resides in the temporary save and restore directory on a network element, but which has not yet been committed by the CMMT-PROV command, is valid. Data in a temporary Save and Restore directory may become invalid when there is a long delay between a RST-PROV and a CMMT-PROV command. Security level Level 3 Input syntax
VALD-PROV:[TID]::CTAG; Table 2-31 Syntax definition Field TID CTAG Purpose Target identifier Correlation tag
Example input
The response blocks contain <STRING> which contains information relating to a backup being restored. This information will differ between SPs and NPs. An SP example. Validate the provisioning data currently in the save and restore directory of shelf processor OTTAWA:
VALD-PROV:OTTAWA::CTAG94;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
The information that will be displayed as a result of this command is as follows:

OTTAWA 98-01-03 02:07:28 M A COMPLD Information on Backup being Restored Backup saved from: OTTAWA Prov Data available for slot Prov Data available for slot Prov Data available for slot Prov Data available for slot Prov Data available for slot Prov Data available for slot Prov Data available for slot Prov Data available for slot
07: 08: 11: 12: 13: 14: 15: 16:
OC3 OC3 OC3 OC3 VTX VTX SP NP
Backup saved from: specifies the SP from which the data was originally backed-up. If the data was restored to a different SP, the TID in the VALD-PROV command will differ from the TID in Backup saved from:.
A NP example. Validate the provisioning data currently in the save and restore directory of network processor MONTREAL.
VALD-PROV:MONTREAL::CTAG94; The information that will be displayed as a result of this command is as follows: MONTREAL 96-01-03 02:07:39 M A COMPLD Information on Backup being Restored Backup Backup Backup Backup saved from: MONTREAL included for: ALLADIN29 1998-05-12 13:05:23 included for: ALADDIN06 1998-06-22 07:55:03 included for: ALADDIN11 1998-06-09 22:22:11
Note: Backup saved from: specifies the NP from which the data was originally backed-up. If the data was restored to a different NP, the TID in the VALD-PROV command will differ from the TID in Backup saved from:. Response block syntax
<SID><DATE><TIME> Restored Data Information <STRING>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
3-1
System detailed command descriptions

This chapter is an alphabetical summary of all TL1 commands related to setting or retrieving the network element type setting or deleting the network service access points (NSAP) setting, retrieving, or deleting network name services (NNS)
3-
The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response.
Command ED-NETYPE RTRV-NETYPE (SP host) RTRV-NETYPE (NP host) RTRV-RTG-TBL RTRV-SW-VER Page 3-2 3-3 3-5 3-6 3-10
3-2 System detailed command descriptions
ED-NETYPE
Use the Edit Network Element Type command to update the network element to support linear and UPSR add/drop multiplexer capabilities when the SP is replaced with an SPe on an OC-3 Express shelf. See RTRV-NETYPE (SP host) for more details. Security level Level 3 Input syntax
ED-NETYPE:TID::CTAG:::NETYPE=Domain; Table 3-1 Syntax definition Field TID CTAG NETYPE Purpose Target identifier Correlation tag Type of network element supported
Table 3-2 Parameter descriptions Parameter NETYPE Possible Description values LINEAR Not supported
Note: Downgrades from an SPe to an SP are not supported.

RING Used when an SP is replaced with an SPe. The network element can now support linear and UPSR add/drop multiplexer (ADM) functionality as well as EC-1 and OC-3 tributaries.
Example input
After an SP has been replaced with an SPe at the NEWYORK network element, add add/drop multiplexer capabilities to the shelf:
ED-NETYPE:NEWYORK::CTAG42:::NETYPE=RING;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
System detailed command descriptions 3-3
RTRV-NETYPE (SP host)

When your current session is hosted by a shelf processor, use the Retrieve Network Element Type command to retrieve the current network element type setting for a network element. Use this command to determine the network element functionality currently supported. On an OC-3 Express network element, if the shelf processor is an SP, the only supported functionality is a linear terminal network element with DS1 and DS3 tributaries. On an OC-3 Express network element, if the shelf processor is an SPe, the supported functionality will be the same as for the SP if the NETYPE is LINEAR. When the NETYPE is set to RING, the network element functionality supported is a linear terminal with DS1, DS3, EC-1, and OC-3 tributaries as well as a linear or UPSR ADM with the same tributaries. This command also returns additional data such as the shelf vendor and model. Security level Level 1 Input syntax
RTRV-NETYPE:TID::CTAG; Table 3-3 Syntax definition Field TID CTAG Purpose Target identifier Correlation tag
3-4 System detailed command descriptions Table 3-4 Output parameter descriptions Parameter Vendor Model Possible values NORTEL TransportNode Express TransportNode OC-3 Express CX NETYPE LINEAR Only linear terminal functionality with DS1 and DS3 tributaries is supported (OC-3 Express only). Linear terminal and ADM as well as UPSR ADM are supported. Release name Description
RING Rel Example input
For the NEWYORK network element, retrieve the network element type:
RTRV-NETYPE:NEWYORK::CTAG99;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-NETYPE (NP host)

When your current session is hosted by a network processor (NP), use the Retrieve Network Element Type command to retrieve the shelf vendor, model and the host processor type. Security level Level 1 Input syntax
RTRV-NETYPE:TID::CTAG; Table 3-5 Syntax definition Field TID CTAG Purpose Target identifier Correlation tag
Table 3-6 Output parameter descriptions Parameter Vendor Model NETYPE Possible values NORTEL S/DMS TransportNode OC-3 Express GCF Gateway communication function: indicates the session you are in is hosted by an NP Description
Example input
For the NEWYORK network element, retrieve the network element type:
RTRV-NETYPE:NEWYORK::CTAG99;
RTRV-RTG-TBL
The Retrieve Routing Table command returns a report with a standard header and a display array listing all the network entities on the network. The report display lists the network element source identifier (SID), the open systems interconnect (OSI) system identifier, and OSI cost value. The RTRV-RTG-TBL command has been enhanced so that TARP (TID address resolution protocol) is used to resolve any unknown TIDs. Use of the TARP option on the RTRV-RTG-TBL could take 15 minutes or more. The routing table is automatically constructed at each network element based on the intermediate system to intermediate system (IS-IS) routing protocol PDU exchange, from the OSI standard ISO-10589. Links between network elements are assigned a COST value according to their type. The COST column displays the COST sum of the shortest route between the local network element and the network element identified in each row of the display. The COST of a route is the sum of the COSTS of each link traversed. The local network element always has a COST value of 0 (zero). If the OC-3 Express or Express CX network element is connected to an OC-12 or OC-48 backbone, the other network elements on the network are also listed. OPC, OC-48 and OC-12 will also display a SID in the NE NAME column, though the length of the SID can vary from that of OC-3 Express or Express CX SIDs. OC-3 Express SYSTEM-ID addresses range between 00-00-75-D0-00-00 and 00-00-75-DF-FF-FF. Note: If a different target identifier (TID) is used then the list of network elements will vary in order and different COST values will be displayed. For example the COST value for the first row (local TID used) will always be zero. Security level Level 1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Input syntax
RTRV-RTG-TBL:[TID]::CTAG; Table 3-7 Syntax definition Field TID CTAG TARP Example input Purpose Target identifier Correlation tag TID address resolution protocol
Retrieve routing table from a network element MIAMI:

RTRV-RTG-TBL:MIAMI::A1A;

"NE NAME SYSTEM-ID COST" ---------------------------------------------"NE NAME SYSTEM ID COST" Example normal response "MIAMI 95-04-30 16:59:00 "CTAG COMPLD "NE NAME SYSTEM-ID COST" -------------------------------------------"MIAMI 00-00-75-D0-00-1 0" "JUPITER 00-00-75-D0-00-1 6" "ORLANDO 00-00-75-D0-00-1 6" "DAYTONA 00-00-75-D0-00-1 12" "ALADDIN28 00-00-75-d0-05-a9 4" "TRAINING02 00-00-75-d0-05-aa 10" "ALADDIN48 00-00-75-d0-00-50 4" "ALADDIN80NP 00-00-75-de-06-a1 4" "ALADDIN45 00-00-75-d0-00-52 4" "UNKNOWN 00-00-75-7f-ff-ff 10" "NORTELOC3NP 00-00-75-de-02-b3 4" "EXPRESS37NP 00-00-75-de-06-b7 4" "KASHIWA 00-00-75-50-06-3c 14" "ALADDIN09 00-00-75-d0-05-ba 10" "ALADDIN08NP 00-00-75-de-06-b3 4" "UNKNOWN 00-00-75-51-02-20 4" "OSAKA 00-00-75-50-06-3e 14" "ALADDIN42NP 00-00-75-de-00-4f 0"
The example shows the response to the RTRV-RTG-TBL command when executed from a network element, with a TID of MIAMI, on a network resembling the following illustration.
MIAMI OC-3 JUPITER OC-3
ORLANDO OC-3
DAYTONA OC-3
Table 3-8 Response parameter descriptions Parameter NE NAME SYSTEM-ID COST Response values Description
64 character Source identifier (SID) of the network alphanumeric string element 6 octet, hexadecimal numeric value of 0 or greater Universally administered IEEE address (world-wide unique address) The shortest path COST value in SDCC links with a weighted value of six for each link
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Fault location The RTRV-RTG-TBL command can be used to locate network faults. For example, in the following illustration if the link between B and C is broken then from A, the COST value of C will rise from 12 to 18.
OC-3 UPSR
B OC-3
OC-3
OC-3
A OC-3
D OC-3
RTRV-SW-VER
Use the Retrieve Software Version command to retrieve the version of the software on the shelf processor, for example REL0300A. Security level Level 1 Input syntax
RTRV-SW-VER:TID::CTAG; Table 3-9 Syntax definition Field TID CTAG Purpose Target identifier Correlation tag
Example input
For the SEATTLE network element, retrieve the current software version:
RTRV-SW-VER:SEATTLE::CTAG99;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
4-1
Synchronization detailed command descriptions
4-
This chapter is an alphabetical summary of the TL1 commands related to system synchronization. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command OPR-BITSOUTSW OPR-SYNCSW RTRV-BITS-IN RTRV-BITS-OUT RTRV-SYNCSTIN RTRV-TMG-MODE RTRV-TMREFIN SET-BITS-IN SET-BITS-OUT SET-SYNCSTIN SET-TMG-MODE SET-TMREFIN Page 4-2 4-3 4-4 4-5 4-7 4-8 4-9 4-11 4-12 4-14 4-16 4-17
4-2 Synchronization detailed command descriptions
OPR-BITSOUTSW
The Operate BITS Out Switch command is used to perform manual synchronization switching between the primary and secondary timing references at a BITS output. The switch completes only if the quality of the two references is the same. The network element always chooses the best quality timing reference for its synchronization reference. Use the RTRV-BITS-OUT command to retrieve the current timing reference settings. Use the SET-BITS-OUT command to assign the primary and secondary timing references. Use the SET-SYNCSTIN command to set the synchronization status of the incoming synchronization signal. User synchronization switches initiated using this command remain active until another BITS Out switch is activated or they are overridden by a synchronization reference failure. Security level Level 2 Input syntax
OPR-BITSOUTSW:[TID]:AID:CTAG; Table 4-1 Syntax definition Field TID AID CTAG Table 4-2 AID descriptions AID type BITS output Example input Command-specific values BITSOUT-bits Purpose BITSOUT-A or BITSOUT-B Purpose Target identifier Access identifier. BITS output to act on. Correlation tag
Switch BITSOUT-A from the currently active timing source to the other timing source:
OPR-BITSOUTSW:NEWYORK:BITSOUT-A:CTAG23;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Synchronization detailed command descriptions 4-3
OPR-SYNCSW
The Operate Synchronization Switch command instructs the network element to switch synchronization timing reference signals from primary to secondary, or vice versa. The switch completes only if the quality of the two references is the same. The network element always chooses the best quality timing reference for its synchronization reference. Use the RTRV-TMREFIN command to retrieve timing references. Use the SET-SYNCSTIN command to set the synchronization status of the incoming synchronization signal. User synchronization switches initiated using this command remain active until another synchronization switch is activated or they are overridden by a synchronization reference failure. Primary and secondary timing references are assigned using the SET-TMREFIN command. Security level Level 2 Input syntax
OPR-SYNCSW:[TID]::CTAG; Table 4-3 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Switch synchronization from the currently active timing source to the other timing source:
OPR-SYNCSW:NEWYORK::CTAG23;
RTRV-BITS-IN
The Retrieve BITS Input command is used to retrieve the setting of the signal format and linecode parameters for the BITS input BITSIN-A and BITSIN-B. Security level Level 1 Input syntax
RTRV-BITS-IN:[TID]:AID:CTAG;

Table 4-4 Syntax definition Field TID AID CTAG Table 4-5 AID descriptions AID type BITS input Example input Command-specific values BITSIN-bits Purpose BITSIN-A or BITSIN-B Purpose Target identifier Access identifier. BITS input to act on. Correlation tag
Retrieve the signal format and linecode settings for BITSIN-A:

RTRV-BITS-IN:NEWYORK:BITSIN-A:CTAG43;

FMT=value LINECDE=value Table 4-6 Parameter descriptions Keyword FMT Domain SF (default) ESF LINECDE AMI (default) B8ZS Description Superframe format Extended superframe format Alternate mark inversion, both directions Bipolar with 8-zero substitution, both directions
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-BITS-OUT
The Retrieve BITS Output command is used to retrieve the setting of the primary and secondary timing references, the signal format, and the equalization for the BITS output BITSOUT-A and BITSOUT-B. Note: The OC-3 Express CX does not support a separate reference selection for BITSOUT. You can enter NONE as the primary and secondary references setting or ignore them. Security level Level 1 Input syntax
RTRV-BITS-OUT:[TID]:AID:CTAG;

Table 4-7 Syntax definition Field TID AID CTAG Table 4-8 AID descriptions AID type BITS output Example input Command-specific values BITSOUT-bits Purpose BITSOUT-A or BITSOUT-B Purpose Target identifier Access identifier. BITS output to act on. Correlation tag
Retrieve the parameter settings for BITSOUT-A:

RTRV-BITS-OUT:NEWYORK:BITSOUT-A:CTAG43;

Keyword=Domain Table 4-9 Keyword descriptions Keyword PRI or SEC (see Note) Domain OC3-slot# EC1-slot# DS1-slot#-port# BITSIN-bit NONE SF (default) ESF EQLZ 1 (default) 2 3 Description Primary or secondary timing reference: OC-3, slot 3 to 12 EC-1, slot 3, 5, 7 or 9 DS1, slot 4 to 10, port 1 to 12 BITSIN-A or BITSIN-B Deprovision timing reference Frame format: Superframe format Extended superframe format Equalization: Short (0-266 ft.) Medium (266-533 ft.) Long (533-655 ft.)
FMT
Note: The OC-3 Express CX does not support a separate reference selection for BITSOUT. You can enter NONE as the primary and secondary references setting or ignore them.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-SYNCSTIN
The Retrieve Synchronization Status Input command is used to find out the synchronization status provisioned by the user using the SET-SYNCSTIN command. Security level Level 1 Input syntax
RTRV-SYNCSTIN:[TID]::CTAG;

Retrieve the current synchronization status at network element Seattle:

RTRV-SYNCSTIN:SEATTLE::CTAG23;

^^^<sync message status> Table 4-11 Synchronization message status values Parameter Possible values Description Stratum 1 traceable Normal-Traceability Unknown Stratum 2 traceable Stratum 3 traceable Traceable SONET minimum clock Stratum 4 traceable Reserved for Network Synchronization Use Do not use for synchronization None
SYNC_STATUS ST1 STU ST2 ST3 SMC ST4 RES DUS NONE
RTRV-TMG-MODE
The Retrieve System Timing Mode command is used to query the system timing mode for a network element. On an OC-3 Express network element, there are three possible modes: free-running internal (INT), line (LINE), or external (EXT). On an OC-3 Express CX network element, there are two possible modes: free-running internal (INT) and line (LINE). Note: This command will never generate an error response; a default value for the system always exists. Security level Level 1 Input syntax
RTRV-TMG-MODE:[TID]::CTAG;

Retrieve the timing mode for network element Seattle:

RTRV-TMG-MODE:SEATTLE::12345;

MODE = <mode> Table 4-13 Parameter descriptions Parameter Mode Possible values EXT INT LINE Description External timing (BITS); default for a new network element with a VTX+ or VTXe Internal timing (freerun) Line timing - default for a new OC-3 Express NE with a VTX - default for new OC-3 Express CX NEs
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-TMREFIN
The Retrieve Timing References Input command is used to retrieve the primary and secondary input timing references used for shelf timing. Possible timing references are BITSin-A, BITSin-B, OC-3, and EC-1 tributaries and DS1 facilities. Note: This command will never generate an error response; a default value for the system always exists. Security level Level 1 Input syntax
RTRV-TMREFIN:[TID]::CTAG;

Retrieve the timing reference for network element New York:

RTRV-TMREFIN:NEWYORK::CTAG45;

^^^"PRI = <Facility AID>:<SST>,<Sync msg status>,<Sync msg status>-P <cr> <lf> ^^^^SEC = <Facility AID>:<SST>,<Sync msg status>,<Sync msg status>-P" <cr> <lf> Table 4-15 Response parameter descriptions Table 4-16 Parameter Possible values Description Express Facility AID OC3-slot# EC1-slot# DS1-slot#-port# BITSIN-Bit NONE SST (secondary state) ACT&WKH ACT&ERRANL IDLE&WKG IDLE&FLT Sync msg status ST1 STU ST2 ST3 SMC ST4 RES DUS NONE OC-3, slot 3 to 12 EC-1, slot 3, 5, 7 or 9 DS1, slot 4 to 10, port 1 to 12 BITSIN-A or BITSIN-B Deprovision timing reference Active and working Active and errored Idle and working Idle and faulty Stratum 1 Traceable Synchronizedtraceability unknown Stratum 2 Traceable Stratum 3 Traceable Traceable SONET minimum clock Stratum 4 Traceable Reserved for network synchronization Do not use for synchronization None Express CX OC-3, slot 3 to 4 EC-1, slot 1 DS1, slot 1, port 1 to 12 DS1, slot 3, port 1 to 8 Not supported Deprovision timing reference
Note: The user-provisioned synchronization status set by using the SET-SYNCSTIN command is also listed, with a P following the message.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-BITS-IN
The Set BITS Input command is used to set the signal format, frame format, and the line code parameters for BITSin-A and BITSin-B. Security level Level 3 Input syntax
SET-BITS-IN:[TID]:AID:CTAG:::[SIGFMT=Domain][,FMT=Domain] [,LINECDE=Domain]; Table 4-17 Syntax definition Field TID AID CTAG Domain Table 4-18 AID descriptions AID type BITS input Command-specific values BITSIN-bits Purpose BITSIN-A or BITSIN-B Purpose Target identifier Access identifier. BITS input to act on. Correlation tag Signal format, frame format, and line code values
Table 4-19 Keyword descriptions Keyword SIGFMT FMT Domain DS1 (default) SF (default) ESF LINECDE AMI (default) B8ZS Description Signal format DS1 Superframe format Extended superframe format Alternate mark inversion, both directions Bipolar with 8-zero substitution, both directions
Example input
Provision the BITS input to network element WASHINGTON:

SET-BITS-IN:WASHINGTON:BITSIN-A:CTAG23:FMT=SF,LINECODE=AMI;
SET-BITS-OUT
The Set BITS Output command is used to provision the primary and secondary timing references, the frame format, and the equalization parameters for BITSout-A and BITSout-B. The BITS output provides timing reference to the BITS clock or to other digital equipment that accepts a BITS signal. Note: The OC-3 Express CX does not support a separate reference selection for BITSOUT. You can enter NONE as the primary and secondary references setting or ignore them. Security level Level 3 Input syntax
SET-BITS-OUT:[TID]:AID:CTAG:::[PRI=Domain],[SEC=Domain], [FMT=Domain],[EQLZ=Domain]; Table 4-20 Syntax definition Field TID AID CTAG Domain Purpose Target identifier Access identifier. BITS output to act on. Correlation tag Primary and secondary timing reference sources, or frame format, or equalization values
Table 4-21 AID descriptions AID type BITS output Command-specific values BITSOUT-bits Purpose BITSOUT-A or BITSOUT-B
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Synchronization detailed command descriptions 4-13 Table 4-22 Keyword descriptions Keyword PRI or SEC (see Note) Domain OC3-slot# EC1-slot# DS1-slot#-port# BITSIN-bit NONE SF (default) ESF 1 (default) 2 3 Description OC-3, slot 3 to 12 EC-1, slot 3, 5, 7 or 9 DS1, slot 4 to 10, port 1 to 12 BITSIN-A or BITSIN-B Deprovision timing reference Superframe format Extended superframe format Short (0-266 ft.) Medium (266-533 ft.) Long (533-655 ft.)
FMT EQLZ
Note: The OC-3 Express CX does not support a separate reference selection for BITSOUT. You can enter NONE as the primary and secondary references setting or ignore them.
Example input
Provision the BITS output from network element WASHINGTON:

SET-BITS-OUT:WASHINGTON:BITSOUT-A:CTAG23:::PRI=OC3-5, SEC=NONE,FMT=SF,EQLZ=1;
SET-SYNCSTIN
The Set Synchronization Status Input command sets the synchronization status to override the incoming message from a timing source, so that the incoming synchronization signal may be given a different value. This value determines whether the incoming synchronization signal is used as the timing reference. Security level Level 3 Input syntax
SET-SYNCSTIN:[TID]:AID:CTAG::SYNC_STATUS; Table 4-23 Syntax definition Field TID AID CTAG SYNC_STATUS Table 4-24 AID descriptions Table 4-25 AID type Command-specific values OC3-slot# EC1-slot# DS1-slot#-port# BITSIN-bit NONE Purpose Express OC-3, slot 3 to 12 EC-1, slot 3, 5, 7 or 9 DS1, slot 4 to 10, port 1 to 12 BITSIN-A or BITSIN-B Deprovision timing reference Express CX OC-3, slot 3 to 4 EC-1, slot 1 DS1, slot 1, port 1 to 12 DS1, slot 3, port 1 to 8 Not supported Deprovision timing reference Purpose Target identifier Facility provisioned as the timing reference Correlation tag Synchronization status
Facility
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Synchronization detailed command descriptions 4-15 Table 4-26 Parameter descriptions Parameter Possible values Description Traceable Stratum 1 Normal-Traceability Unknown Traceable Stratum 2 Traceable Stratum 3 Traceable SONET minimum clock Traceable Stratum 4 Reserved for Network Synchronization Use Do not use for synchronization None
SYNC_STATUS ST1 STU ST2 ST3 SMC ST4 RES DUS NONE Example input
Provision the synchronization status of BITS input A to ST2:

SET-SYNCSTIN:OTTAWA:BITSIN-A:CTAG23::ST2;
SET-TMG-MODE
The Set Timing Mode command sets the system timing mode for a network element. On an OC-3 Express network element, there are three possible modes: free-running internal (INT), line (LINE), or external (EXT). On an OC-3 Express CX network element, there are two possible modes: free-running internal (INT) and line (LINE). Note: The shelf timing mode cannot be changed from external or line timing to a different mode unless the sources for timing references are deprovisioned first. Security level Level 3 Input syntax
SET-TMG-MODE:[TID]::CTAG::[MODE]; Table 4-27 Syntax definition Field TID CTAG Mode Purpose Target identifier Correlation tag Shelf timing to be selected
Table 4-28 Parameter descriptions Parameter Mode Possible values EXT INT LINE Description External timing (BITS); default for a new network element with a VTX+ or VTXe Internal timing (freerun) Line timing - default for a new OC-3 Express NE with a VTX - default for new OC-3 Express CX NEs
Example input
Set timing mode to line or internal:

SET-TMG-MODE:NEWYORK::CTAG02::LINE; SET-TMG-MODE:WASHINGTON::CTAG03::INT;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-TMREFIN
The Set Timing Reference Input command is used to set the input timing references for the shelf. Possible values are BITSin-A, BITSin-B, OC-3, and EC-1 tributaries and DS1 tributaries. Security level Level 3 Input syntax
SET-TMREFIN:[TID]::CTAG:::[PRI=Domain],[SEC=Domain]; Table 4-29 Syntax definition Field TID CTAG Domain Table 4-30 Keyword descriptions Table 4-31 Keyword Domain Description Express PRI or SEC OC3-slot# EC1-slot# DS1-slot#-port# BITSIN-bit NONE OC-3, slot 3 to 12 EC-1, slot 3, 5, 7 or 9 DS1, slot 4 to 10, port 1 to 12 BITSIN-A or BITSIN-B Deprovision timing reference Express CX OC-3, slot 3 to 4 EC-1, slot 1 DS1, slot 1, port 1 to 12 DS1, slot 3, port 1 to 8 (Note) Not supported Deprovision timing reference Purpose Target identifier Correlation tag Primary and secondary timing references
Note: On an OC-3 Express CX shelf, you can set one of the DS1, slot 3 tributaries as the PRI reference and another as the SEC reference if the tributaries belong to different groups, that is from ports 1 to 4 and ports 5 to 8.
4-18 Synchronization detailed command descriptions Example input
Provision the primary timing reference input from the OC-3 in slot 11, and the secondary timing reference from the OC-3 in slot 12:
SET-TMREFIN:SEATTLE::CTAG34:::PRI=OC3-11,SEC=OC3-12;
Provision the primary timing reference input from the EC1 in slot 5 and deprovision the secondary timing reference (set to none):
SET-TMREFIN:WASHINGTON::CTAG34:::PRI=EC1-5,SEC=NONE;
Set both primary and secondary references to none (defaults to freerun):

SET-TMREFIN:NEWYORK::CTAG34:::PRI=NONE,SEC=NONE;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
5-1
Equipment detailed command descriptions
5-
This chapter is an alphabetical summary of all TL1 commands related to provisioning DS1, DS3, EC-1, OC-3, EIM, and MTX equipment. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command DLT-EQPT ENT-EQPT RMV-EQPT RST-EQPT RTRV-EQPT RTRV-INVENTORY Page 5-2 5-4 5-7 5-9 5-11 5-15
5-2 Equipment detailed command descriptions
DLT-EQPT
The Delete Equipment command is used to delete the provisioning information for the specified equipment. Note: Equipment cannot be deleted if any facilities are provisioned on that equipment. When you delete OC-3 or EC-1 equipment, the section data communications channel (SDCC) link is also affected (layers 1, 2). Security level Level 3 Input syntax
DLT-EQPT:[TID]:AID:CTAG; Table 5-1 Syntax definition Field TID AID CTAG Purpose Target identifier Access identifier. Equipment to act on. Correlation tag
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Equipment detailed command descriptions 5-3 Table 5-2 AID descriptions AID type DS1 AID Command-specific Purpose values DS1-slot# Identify the DS1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 equipment where slot#= 3 to 12 (Express) Identify the EIM equipment where slot#= 7 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the ILAN equipment where slot#= 16 (Express) Identify the protection switch controller Identify the protection switch extender
DS3 AID
DS3-slot#
EC1 AID
EC1-slot#
OC3 AID EIM AID
OC3-slot# EIM-slot#
ILAN AID PSC AID PSX AID
ILAN PSC PSX
Note: The PSX can only be deleted if DS1-6-5 and higher do not exist.
NP AID NP Identify the network processor
Example input
Delete the DS1 circuit pack in slot 4:

DLT-EQPT:NEWYORK:DS1-4:CTAG23;
ENT-EQPT
The Enter Equipment command is used to enter the attributes of a given type of common equipment module or slot definition in a network element. This tells the network element that a specific circuit pack of a particular type is supposed to be in a particular slot. If the system does a self test and finds a circuit pack in a slot that does not match the description provisioned, an alarm is raised. On an OC-3 Express shelf, this command is used to add the requested OC-3/EC-1 equipment as well as to add a corresponding section data communications channel (SDCC) link (layers 1, 2). The SDCC protection scheme is based on the OC-3/EC-1 equipment protection scheme (Simplex as opposed to 1+1 protected) as well as the current number of SDCCs already configured on a given pair of OC-3 or EC-1 circuit packs. Security level Level 3 Input syntax
ENT-EQPT:[TID]:AID:CTAG::::[PST]; Table 5-3 Syntax definition Field TID AID CTAG PST Purpose Target identifier Access identifier. Equipment to act on. Correlation tag Primary state (optional parameter)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Equipment detailed command descriptions 5-5 Table 5-4 AID descriptions AID type DS1 AID Command values DS1-slot# Purpose Identify the DS1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 equipment where slot#= 3 to 12 (Express) Identify the EIM equipment where slot#= 7 to 10 (Express) Identify the ILAN equipment where slot#= 16 (Express) Identify the protection switch controller Identify the protection switch extender Identify the network processor
DS3 AID
DS3-slot#
EC1 AID
EC1-slot#
OC3 AID EIM AID ILAN AID PSC AID PSX AID NP AID
OC3-slot# EIM-slot# ILAN PSC PSX NP
Table 5-5 Parameter descriptions Parameter PST Possible values IS OOS-MA Description In-service (default) Out-Of-Service maintenance for provisioning Memory Administration
Note: Secondary state cannot be provisioned.

Example input
Provision a DS1 circuit pack in slot 4:

ENT-EQPT:NEWYORK:DS1-4:CTAG12::::IS;
Provision an OC-3 circuit pack in slot 11:

ENT-EQPT:WASHINGTON:OC3-11:CTAG23;
Provision a DS3 circuit pack in slot 6:

ENT-EQPT:SEATTLE:DS3-6:CTAG23;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Equipment detailed command descriptions 5-7
RMV-EQPT
The Remove Equipment command removes the specified type of common equipment module from service and puts it in an out-of-service (OOS) maintenance for memory administration state. Any facilities on the equipment must also be OOS for this to be permitted. Security level Level 3 Input syntax
RMV-EQPT:[TID]:AID:CTAG; Table 5-6 Syntax definition Field TID AID CTAG Purpose Target identifier Access identifier. Equipment to act on. Correlation tag
5-8 Equipment detailed command descriptions Table 5-7 AID descriptions AID type DS1 AID Command values DS1-slot# Purpose Identify the DS1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 equipment where slot#= 3 to 12 (Express) Identify the EIM equipment where slot#= 7 to 10 (Express) Identify the protection switch controller Identify VTX where slot#= 13 or 14 Identify MTX where slot#= 3 or 4
DS3 AID
DS3-slot#
EC-1 AID
EC1-slot#
OC-3 AID EIM AID PSC AID VTX AID MTX AID Example input
OC3-slot# EIM-slot# PSC VTX-slot# MTX-slot#
Put the DS1 circuit pack in slot 4 out of service:

RMV-EQPT:NEWYORK:DS1-4:CTAG23;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RST-EQPT
The Restore Equipment command brings a given type of common equipment module back into service from an out-of-service maintenance for memory administration state. Security level Level 3 Input syntax
RST-EQPT:[TID]:AID:CTAG; Table 5-8 Syntax definition Field TID AID CTAG Purpose Target identifier Access identifier. Equipment to act on. Correlation tag
5-10 Equipment detailed command descriptions Table 5-9 AID descriptions AID type DS1 AID Command values DS1-slot# Purpose Identify the DS1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 equipment where slot#= 3 to 12 (Express) Identify the EIM equipment where slot#= 7 to 10 (Express) Identify the protection switch controller Identify VTX where slot#=13 or 14 Identify MTX where slot#=3 or 4
DS3 AID
DS3-slot#
EC-1 AID
EC1-slot#
OC-3 AID EIM AID PSC AID VTX AID MTX AID Example input
OC3-slot# EIM-slot# PSC VTX-slot# MTX-slot#
Force the DS1 circuit pack in slot 4 to go back in service:

RST-EQPT:NEWYORK:DS1-4:CTAG34;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-EQPT
The Retrieve Equipment command retrieves the data parameters and state parameters for provisioned equipment and facilities. This command identifies only what is provisioned and does not identify which equipment is actually present or missing. To identify what equipment is physically situated in each slot use the RTRV-INVENTORY command. Security level Level 1 Input syntax
RTRV-EQPT:[TID]:AID:CTAG;

Table 5-10 Syntax definition Field TID AID CTAG Purpose Target identifier Access identifier. Equipment to act on. Correlation tag
5-12 Equipment detailed command descriptions Table 5-11 AID descriptions AID type DS1 AID Command values DS1-slot# DS1-ALL DS3-slot# DS3-ALL EC1-slot# EC1-ALL OC3-slot# OC3-ALL EIM-slot# EIM-ALL ILAN PSC PSX VTX-slot# VTX-ALL MTX-slot# MTX-ALL NP SP Purpose Identify the DS1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 equipment where slot#= 3 to 12 (Express) Identify the EIM equipment where slot#= 7 to 10 (Express) Identify the ILAN equipment where slot#= 16 (Express) Identify the protection switch controller Identify the protection switch extender Identify VTX where slot#=13 or 14 Identify MTX where slot#=3 or 4 Identify the network processor Identify the shelf processor
DS3 AID
EC-1 AID
OC-3 AID EIM AID ILAN AID PSC AID PSX AID VTX AID MTX AID NP AID SP AID Example input
Retrieve a list of all DS1 equipment provisioned:

RTRV-EQPT:SEATTLE:DS1-ALL:CTAG19;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID:<PEC=Domain>,<REL=Domain>,<CLEI=Domain>,<SER=Domain>, <MDAT=Domain>,<AGE=Domain>,<ONSC=Domain>:<pst>,<sst> Table 5-12 Response parameter descriptions Parameter Possible values AID DS1-slot# Description Identify the DS1 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the protection switch controller Identify the protection switch extender Identify the OC-3 where slot#= 3 to 12 (Express) Identify the EIM where slot#= 7 to 10 (Express) Identify the ILAN where slot#= 16 (Express) Identify the VTX where slot# = 13 or 14 Identify the MTX where slot# = 3 or 4 Identify the network processor circuit pack Identify the shelf processor circuit pack Product engineering code, a standard Northern Telecom product identifier Release version number Common Language equipment identifier Serial number
continued
DS3-slot#
EC1-slot#
PSC PSX OC3-slot# EIM-slot# ILAN VTX-slot# MTX-slot# NP SP PEC REL CLEI SER 8 alphanumeric characters 1-255 10 alphanumeric characters 9 alphanumeric characters
5-14 Equipment detailed command descriptions Table 5-12 (continued) Response parameter descriptions Parameter Possible values MDAT YYYY-WOY Description Manufacture date, the date the unit was manufactured, in the format: year-week of year. Age, cumulative in-service time elapsed since manufacture, in the format: years-days-hours-minutes. On since, cumulative time since the unit was last inserted, in the format: years-days-hours-minutes. In-service (default) In-service - Abnormal Out-of-service maintenance for provisioning memory administration Out-of-service autonomous - the entity is not able to perform its provisioned functions (alarm is raised) Out-of-service autonomous management - the entity is not able to perform its provisioned functions and is purposefully removed from service Out-of-service maintenance abnormal Active, carrying traffic (default) Idle, not carrying traffic Protection switch inhibited Fault detected in equipment Mismatched equipment attributes (circuit pack) Test failed, OOS due to failed test Unequipped, circuit pack missing
AGE
YY-DDD-hh-mm
ONSC
YY-DDD-hh-mm
PST
IS IS-ANR OOS-MA OOS-AU
OOS-AUMA
OOS-MA-ANR SST ACT IDLE PSI FLT MEA TSTF UEQ
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-INVENTORY
The Retrieve Inventory command identifies what type of circuit packs are situated in which slots. This command does not retrieve what has been logically provisioned in those slots, but what is actually in the slots. The RTRV-INVENTORY command can be used to identify incorrectly situated circuit packs with the RTRV-EQPT and RTRV-<FAC> commands. Security level Level 1 Input syntax
RTRV-INVENTORY:[TID]:[AID]:CTAG;

Table 5-13 Syntax definition Field TID AID CTAG Example input Purpose Target identifier Access identifier. Slot number to act on. Correlation tag
Retrieve information about all circuit packs in one network element:

RTRV-INVENTORY:SEATTLE::CTAG19;
Retrieve information for all circuit packs in all currently logged in network elements:
RTRV-INVENTORY:ALL::CTAG20;

AID::<PEC=Domain>,<REL=Domain>,<CLEI=Domain>,<SER=Domain>, <MDAT=Domain>,<AGE=Domain>,<ONSC=Domain>; Table 5-14 Input parameter descriptions Parameter AID Command-specific values Purpose
slot#= 1 through 18 (Express) Identify the circuit pack slot slot#= 1 through 5 (Express CX) number. ALL Null All slots All slots
5-16 Equipment detailed command descriptions Table 5-15 Response parameter descriptions Parameter AID Response values equipment-slot#= 1 to 18 (Express) 1 to 5 (Express CX) EMPTY UNKNOWN DS1 Description Circuit pack and its slot number in the network element shelf There is no identifiable circuit pack in the slot The circuit pack occupying the slot cannot be identified DS1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) DS3 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) EC-1 equipment where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) OC-3 equipment where slot#= 3 to 12 (Express) EIM equipment where slot#= 7 to 10 (Express) ILAN equipment where slot#= 16 (Express) Protection Switch Controller Protection Switch Extender Virtual Tributary Cross-connect circuit pack Main Transport circuit pack Network Processor circuit pack Shelf Processor circuit pack Left Extender circuit pack Right Extender circuit pack Left Input/Output circuit pack, front Left Input/Output circuit pack, rear
continued
DS3
EC1
OC3 EIM ILAN PSC PSX VTX MTX NP SP LEX REX LIO_FRONT LIO_REAR
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Equipment detailed command descriptions 5-17 Table 5-15 (continued) Response parameter descriptions Parameter AID (cont) Response values RIO_FRONT RIO_REAR CIO EIO PEC REL CLEI SER MDAT 8 alphanumeric characters 1-255 10 alphanumeric characters 9 alphanumeric characters YYYY-WOY Description Right Input/Output circuit pack, front Right Input/Output circuit pack, rear Common input/output module Expansion input/output module Product Equipment Code. Standard Northern Telecom product identifier. Release version number Common Language equipment identifier Serial number Manufacture date. The date the unit was manufactured in the format: year-week of year. Age. Cumulative in-service time elapsed since manufacture in the format: years-days-hours-minutes. On since. Cumulative time since the unit was last inserted, in the format: years-days-hours-minutes.
AGE
YY-DDD-hh-mm
ONSC
YY-DDD-hh-mm
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
6-1
Facility detailed command descriptions
6-
This chapter is an alphabetical summary of all TL1 commands to provision DS1, DS3, EC-1, EIM bridge, and OC-3 facilities. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command DLT-EC1 DLT-EIM DLT-FFP-OC3 DLT-OC3 DLT-T1 DLT-T3 ED-DFLT-AINS ED-EC1 ED-EIM ED-FFP-OC3 ED-IMA-GRP ED-OC3 ED-T1 ED-T3 ENT-EC1 ENT-EIM
continued
Page 6-3 6-4 6-5 6-6 6-7 6-8 6-9 6-10 6-11 6-13 6-14 6-16 6-19 6-24 6-26 6-28
6-2 Facility detailed command descriptions Command ENT-FFP-OC3 ENT-OC3 ENT-T1 ENT-T3 RMV-EC1 RMV-EIM RMV-OC3 RMV-T1 RMV-T3 RST-EC1 RST-EIM RST-OC3 RST-T1 RST-T3 RTRV-DFLT-AINS RTRV-EC1 RTRV-EIM RTRV-FFP-OC3 RTRV-IMA-GRP RTRV-OC3 RTRV-T1 RTRV-T3 RTRV-VP Page 6-30 6-31 6-33 6-37 6-39 6-40 6-41 6-42 6-43 6-44 6-45 6-46 6-47 6-48 6-49 6-50 6-52 6-55 6-57 6-59 6-63 6-68 6-70
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-3
DLT-EC1
The Delete EC-1 command is used to eliminate the EC-1 facility from the EC-1 circuit pack; the EC-1 circuit pack provisioning information is deleted and all other information (errors, monitoring points) is ignored. Before you delete an EC-1 facility, you must delete all connections on the facility, delete any SDCC links on the EC-1, ensure the EC-1 facility is not used as a timing reference, and put the facility out of service (OOS). Security level Level 3 Input syntax
DLT-EC1:[TID]:AID:CTAG; Table 6-1 Syntax definition Field TID AID CTAG Table 6-2 AID descriptions AID type EC1 AID Command-specific values EC1-slot# Purpose Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. EC-1 facility to act on. Correlation tag
Example input
Delete the EC-1 facility in slot 5:

DLT-EC1:NEWYORK:EC1-5:CTAG34;
6-4 Facility detailed command descriptions
DLT-EIM
The Delete EIM command is used to delete the EIM bridge facility from the EIM circuit pack. The EIM circuit pack provisioning information is deleted and all other information (errors, monitoring points) is ignored. Before you delete an EIM bridge facility, you must delete all connections on the bridge facility and put the facility out of service (OOS). Security level Level 3 Input syntax
DLT-EIM:[TID]:AID:CTAG; Table 6-3 Syntax definition Field TID AID CTAG Table 6-4 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# EIM-slot#-ALL EIM-ALL Purpose Identify the EIM facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#= 1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag
Example input
Delete EIM bridge facility 2 from the EIM circuit pack in slot 7:
DLT-EIM:NEWYORK:EIM-7-2:CTAG34;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
DLT-FFP-OC3
The Delete FFP OC-3 command is used to delete 1+1 protection for an OC-3 linear facility. Of the pair, the protection facility is in the even slot. The protection OC-3 facility must be OOS-MA (out of service maintenance for memory administration) before the FFP can be deleted. The OC-3 equipment runs in simplex mode once you delete the FFP. Connections on the protection OC-3 are deleted when you delete the FFP. Deleting protection also affects how the section data communication channel (SDCC) operates. Security level Level 3 Input syntax
DLT-FFP-OC3:[TID]:workingOC3AID,protectionOC3AID:CTAG; Table 6-5 Syntax definition Field TID AID CTAG Table 6-6 AID descriptions AID type Command-specific values Purpose Identify the slot number of the working OC-3 where slot# = 3, 5, 7, 9, or 11 (Express) slot# = 3 (Express CX) Identify the slot number of the protection OC-3 where slot# = 4, 6, 8, 10, or 12 (Express) slot# = 4 (Express CX) Purpose Target identifier Access identifier. OC-3 facility to act on. Correlation tag
working OC3 OC3-slot# AID
protection OC3 AID
Note: Ensure that facilities on the protection circuit pack are out of service.
Example input
Delete 1+1 protection for the OC-3 facility in slot 11 and slot 12:
DLT-FFP-OC3:SEATTLE:OC3-11,OC3-12:CTAG13;
DLT-OC3
The Delete OC-3 command is used to eliminate the OC-3 facility from the OC-3 or MTX circuit pack; the OC-3 facility provisioning information is deleted and all other information (errors, monitoring points) is ignored. Before you delete an OC-3 facility, you must delete all connections on the facility, delete any SDCC links on the OC-3, ensure the facility is not used as a timing reference, delete the FFP and put the facility OOS. Security level Level 3 Input syntax
DLT-OC3:[TID]:AID:CTAG; Table 6-7 Syntax definition Field TID AID CTAG Table 6-8 AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 slot where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. OC-3 facility to act on. Correlation tag
Example input
Delete the OC-3 facility in slot 12:

DLT-OC3:SEATTLE:OC3-12:CTAG04;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
DLT-T1
The Delete T1 command is used to eliminate a DS1 facility from a DS1 or MTX circuit pack; the DS1facility provisioning information is deleted and all other information (errors, monitoring points) is ignored. Before you delete a facility, you must delete all connections on the facility, ensure the facility is not used as a timing reference, and put the facility OOS. Security level Level 3 Input syntax
DLT-T1:[TID]:AID:CTAG; Table 6-9 Syntax definition Field TID AID CTAG Table 6-10 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL Purpose Identify the DS1s where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Example input Purpose Target identifier Access identifier. DS1 facilities to act on. Correlation tag
Delete DS1 facility #7 on the DS1 circuit pack in slot 4:

DLT-T1:NEWYORK:DS1-4-7:CTAG123;
Delete all the DS1 facilities on the DS1 circuit pack in slot 6:
DLT-T1:SEATTLE:DS1-6-ALL:CTAG123;
DLT-T3
The Delete T3 command is used to eliminate a DS3 facility from a DS3 circuit pack; the DS3 facility provisioning information is deleted and all other information (errors, monitoring points) is ignored. Before you delete a facility, you must delete all connections on the facility, and put the facility OOS. Security level Level 3 Input syntax
DLT-T3:[TID]:AID:CTAG; Table 6-11 Syntax definition Field TID AID CTAG Table 6-12 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3s where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. DS3s to act on. Correlation tag
Example input
Delete the DS3 facility in slot 9 at the OTTAWA network element:

DLT-T3:OTTAWA:DS3-9:CTAG13;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-DFLT-AINS
Use the Edit default auto-in-service command to modify the default DS1 auto-in-service (AINS) start-up time for a shelf. When the secondary state of a DS1 facility is set to auto-in-service (using the ED-T1 or ENT-T1 commands), and the start-up time parameter (HH-MM) is not entered, HH-MM assumes the default start-up time. Security level Level 3 Input syntax
ED-DFLT-AINS:[TID]::CTAG::[HH-MM]; Table 6-13 Syntax definition Field TID CTAG HH-MM Purpose Target identifier Correlation tag DS1 auto-in-service start-up time
Table 6-14 HH-MM parameter descriptions Parameter HH-MM (hour-minute) Valid values 00-01 to 96-00 Description Default = 04-00 ( 4 hours) Amount of time that an error-free signal must be present on the DS1 line in order for the auto-in-service state to clear. If an error-free signal is present for less than this period of time, the DS1 facility remains in an auto-in-service state.
Example input
For the SEATTLE network element, set the default DS1 AINS start-up time to 7 hours and 30 minutes:
ED-DFLT-AINS:SEATTLE::CTAG04::07-30;
ED-EC1
The Edit EC1 command is used to edit the parameters of an EC-1 facility. Security level Level 3 Input syntax
ED-EC1:[TID]:AID:CTAG:::[LBO=Domain]; Table 6-15 Syntax definition Field TID AID CTAG LBO=Domain Table 6-16 AID descriptions AID type EC1 AID Command-specific values EC1-slot# Purpose Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. EC-1 facility to act on Correlation tag Line buildout (optional parameter)
Table 6-17 Keyword descriptions Keyword LBO Domain 1 2 Example input Description 0 to 224 ft to EC-1 cross-connect (default) 225 to 450 ft to EC-1 cross-connect
Edit the line buildout of the EC-1 facility in slot 5:

ED-EC1:SEATTLE:EC1-5:CTAG45:::LBO=2;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-EIM
The Edit EIM command is used to edit the parameters of an EIM bridge facility. Before you edit an EIM bridge facility, place the bridge facility out of service. Security level Level 3 Input syntax
ED-EIM:[TID]:AID:CTAG:::[FILTER=Domain][,STP=Domain] [,SNMP=Domain][,ETHDPX=Domain][,IPADDR=Domain][,IPMASK=Domain] [,IPBROAD=Domain]; Table 6-18 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 6-19 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 7 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
6-12 Facility detailed command descriptions Table 6-20 Parameter descriptions Parameter FILTER Possible values ON OFF STP ON OFF SNMP ON OFF ETHDPX HALF Description Traffic is not allowed to pass through (default) Allows traffic to pass through Enable spanning tree protocol (default) Disable spanning tree protocol Enable SNMP Disable SNMP (default) HALF (for half duplex) allows Ethernet bridge ports to alternately transmit or receive. Default is ETHDPX=HALF. FULL (for full duplex) allows Ethernet bridge ports to simultaneously transmit and receive.
FULL
Note: OC-3 Express CX does not support the ETHDPX parameter.

IPADDR x.x.x.x where IP address of this entry x= 0 to 255 or null (Note) x.x.x.x where Subnet mask associated with the IP address of this x= 0 to 255 entry or null (Note) x.x.x.x where IP broadcast address used to send datagrams on the x= 0 to 255 (logical) interface associated with the IP address of or null (Note) this entry
IPMASK
IPBROAD
Note: You can dynamically assign the IP address , the IP subnet mask, or the IP broadcast address by leaving the domain field blank and entering the command string; for example, ...,IPADDR=, IPMASK=47.123.24.43, IPBROAD=, ...
Example input
Edit EIM bridge facility 2 on the EIM circuit pack in slot 10 to enable filtering:
ED-EIM:SEATTLE:EIM-10-1:CTAG34:::FILTER=ON;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-FFP-OC3
The Edit FFP OC-3 command is used to edit the attributes of the OC-3 1+1 line protection group. Security level Level 3 Input syntax
ED-FFP-OC3:[TID]:workingOC3AID,protectionOC3AID:CTAG::: [PSDIRN=Domain]; Table 6-21 Syntax definition Field TID AID CTAG PSDIRN Purpose Target identifier Access identifier. OC-3 facility to act on. Correlation tag Direction of protection group for OC-3 lines: UNI (unidirectional) or BI (bidirectional). Default is UNI.
Table 6-22 AID descriptions AID type working OC3 AID Command-specific values OC3-slot# Purpose Identify the slot number of the working OC-3 where slot# = 3, 5, 7, 9, or 11 (Express) slot# = 3 (Express CX) Identify the slot number of the protection OC-3 where slot# = 4, 6, 8, 10, or 12 (Express) slot# = 4 (Express CX)
protection OC3 AID
Example input
Edit the 1+1 protection for the OC-3 facility in slot 5 and slot 6 to be bidirectional:
ED-FFP-OC3:SEATTLE:OC3-5,OC3-6:CTAG13:::PSDIRN=BI;
ED-IMA-GRP
The Edit IMA Group command is used to edit the parameters of an IMA group. Note 1: Before you can edit the IMA group parameters, you must put the associated bridge facility out of service. Note 2: IMA group parameters are accessible only if the VP is cross-connected. Security level Level 3 Input syntax
ED-IMA-GRP:[TID]:AID:CTAG:::[IMAFRAME=Domain] [,IMASCRAM=Domain]; Table 6-23 Syntax definition Field TID AID CTAG IMAFRAME IMASCRAM Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag DS1 framing. See Parameter descriptions table for details. ATM cell payload scrambling. See Parameter descriptions table for details.
Table 6-24 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge#-vp# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 vp#=1 to 8
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-15 Table 6-25 Parameter descriptions Parameter IMAFRAME Possible values SF ESF IMASCRAM ON OFF Example input Description Super frame (default) Extended super frame Enable payload scrambling Disable payload scrambling (default)
Edit IMA group to use SF framing:

ED-IMA-GRP:SEATTLE:EIM-9-2-8:CTAG34:::IMAFRAME=SF;
ED-OC3
The Edit OC3 command is used to set the signal degrade threshold (SDTH) for OC-3 facilities. The signal degrade threshold determines the bit error rate (BER) in a received OC-3 signal at which an autonomous protection switch occurs. an autonomous linear protection switch occurs between two 1+1 linear protected OC-3 facilities. (OC-3 facilities are provisioned for 1+1 linear protection with the ENT-FFP-OC3 command. See page 6-30 for more information on the ENT-FFP-OC3 command.) an autonomous protection switch occurs between two path-protected (switchmate) OC-3 facilities. (Path protection occurs either at the STS-3c, STS-1 or VT1.5 levels. To provision path protection, see the ENT-CRS-STS1 command (page 8-26) or the ENT-CRS-VT1 command (page 8-30.) Note: Provisioning the SDTH parameter on an optical interface provisions the SDTH for the line and for all signals (STS-3c, STS-1, VT1.5) on that line. The Edit OC3 command is also used to edit the section trace parameters. The user can edit the outgoing section trace message, the expected section trace message, the section trace format, and the section trace failure mode. The Edit-OC-3 command is also used to edit SS Bits parameters. By default, the value of SS Bits is SONET but it can also be set to SDH. Security level Level 3 Input syntax
ED-OC3:[TID]:AID:CTAG:::[SDTH=Domain][,STFORMAT=Domain] [,STRC=Domain][,EXPSTRC=Domain][,STFMODE=Domain] [,SSBITMDE=Domain];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-17 Table 6-26 Syntax definition Field TID AID CTAG SDTH Purpose Target identifier Access identifier. Identifies an OC-3 facility. Correlation tag Signal degrade threshold, bit error level at which a linear autonomous protection switch takes place. See Parameter Description table for details. Section trace format. See Parameter descriptions table for details. Outgoing section trace message. See Parameter descriptions table for details. Expected section trace message. See Parameter descriptions table for details. Section trace fail mode. See Parameter descriptions table for details. SS bits mode
STFORMAT STRC EXPSTRC STFMODE SSBITMDE Table 6-27 AID descriptions AID type
Command-specific parameters
Parameter values slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX)
OC-3 OC3-slot# Facility AID
6-18 Facility detailed command descriptions Table 6-28 Parameter descriptions Parameter SDTH Possible values 5 to 9 Description Translates to 10-5 to 10-9 (default is 6) Section trace message is 1 byte long (default) Section trace message is up to 15 bytes long if STFORMAT is NUM (default is 1) if STFORMAT is STRING (default is null character string). See Note 1. if STFORMAT is NUM (default is 1) if STFORMAT is STRING (default is null character string). See Note 1. Alarms off, no traffic protection (default) Alarms on, no traffic protection Alarms on, with traffic protection. See Notes 2 and 3. Default
STFORMAT NUM STRING STRC 0 to 255 ASCII string up to 15 characters EXPSTRC 0 to 255 ASCII string up to 15 characters STFMODE OFF ALMONLY LINEFAIL SSBITMDE SONET SDH
Note 1: The possible values of the section trace messages depend on the STFORMAT value. If STFORMAT is NUM, the possible values are 0 to 255. If STFORMAT is STRING, the possible values are any printable alphanumeric ASCII string up to 15 characters (except comma, colon, semi-colon, equal sign, or question mark) or a NULL character string (for example, STRC=, or EXPSTRC=,). Enclose the ASCII string in double quotes () to maintain case sensitivity. The string must begin and end with the double quotes. You cannot use double quotes, or any special character, as part of the ASCII string. Note 2: If STFMODE is currently set to LINEFAIL, you cannot modify the values of STFORMAT, STRC, or EXPSTRC, unless you also change STFMODE to OFF or ALMONLY in the same command. Note 3: STFMODE can be only be changed to LINEFAIL if the values of STFORMAT, STRC, and EXPSTRC are not being changed in the same command.
Example input
At the NEWYORK network element, set the SDTH for the slot 7 OC-3 facility to 10-7 errors per second and the STFMODE to LINEFAIL and the SSBITMDE to SONET:
ED-OC3:NEWYORK:OC3-7:CTAG23:::SDTH=7,STFMODE=LINEFAIL, SSBITMDE=SONET;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-T1
The Edit T1 command is used to edit DS1 facility signal, facility service, and auto-in-service parameters. If parameter and state changes are requested in the same edit command, the state change is processed first, followed by parameter updates. Note: To change primary state use the RMV-T1, and RST-T1 commands. Security level Level 3 Input syntax
ED-T1:[TID]:AID:CTAG:::[EQLZ=Domain][,FENDNTE=Domain] [,FLMDE=Domain][,FMT=Domain][,LINECDE=Domain] [,MAP=Domain][,OMODE=Domain]:[PST],[SST],[HH-MM];
6-20 Facility detailed command descriptions Table 6-29 Syntax definition Field TID AID CTAG EQLZ=Domain FENDNTE=Domain FLMDE=Domain FMT=Domain LINECDE=Domain MAP=Domain OMODE=Domain PST Purpose Target identifier Access identifier. DS1s to act on. Correlation tag Facility signal attribute parameters. See the Facility signal attribute descriptions table on page 6-21.
Primary state. The PST field must be present if SST or HH-MM values are being specified, but must be left blank in this command. The DS1 auto-in-service parameters. See the parameter descriptions table on page 6-23.
SST HH-MM
Table 6-30 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL Purpose Identify the DS1s where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-21 Table 6-31 Facility signal attribute descriptions Keyword EQLZ Domain Description Cable connecting DS1 to DS1 cross-connect. If the cables for the incoming and outgoing streams are different, add TX or RX to the domain, for example 1RX or 2TX. 1, 2 and 3 set the values for both TX and RX cables. 1 1TX 1RX 2 2TX 2RX 3 3TX 3RX FENDNTE ANSI NOTANSI FLMDE BOTH INC OC N FMT SF ESF SF-TR08 Default: short: 0-220 ft both directions 0-220 ft transmit 0-220 ft receive medium: 220-430 ft both directions 220-430 ft transmit 220-430 ft receive long: 430-655 ft both directions 430-655 ft transmit 430-655 ft receive Default: Far end NTE supports ANSI standards ANSI standards are not supported Fault locate mode: Faults in the frame format will be checked for. Use N if DS1 data is unframed. Default: both incoming and outgoing data streams will have the frame format, as specified by FMT, checked. Only check incoming data. (Outgoing can be unframed.) Only check outgoing data. Do not check the frame format. (The DS1 facility can be unframed or used as a clear channel facility.) Default: Superframe format Extended Superframe format Superframe with TR08 extensions
continued
6-22 Facility detailed command descriptions Table 6-31 (continued) Facility signal attribute descriptions Keyword LINECDE Domain Description Line code. If the incoming and outgoing streams are different, add TX or RX to the domain, for example AMITX, B8ZSRX. AMI AMITX AMIRX AMIZCS Default: Alternate mark inversion (bipolar) both directions AMI transmit AMI receive AMI with zero code suppression, both directions If there are 8 zeros in a byte, the least significant will be changed to a one.
AMIZCSTX AMIZCS Transmit
Note: Zero code suppression not supported in the receive direction.

B8ZS B8ZSTX B8ZSRX Bipolar with 8-zero substitution, both directions B8ZS Transmit B8ZS Receive
Note: If an EIM facility is cross-connected to a DS1 facility, the DS1 facility line coding must be set to B8ZS.
MAP The form of mapping for DS1 payloads into VT1.5s.
Note: You must enter each MAP parameter in a separate command.

VTASYN VTBYTE VTBIT Default:VT1.5 bit asynchronous mapping VT1.5 byte synchronous mapping VT1.5 bit synchronous mapping
Note: If using VTBYTE mapping, one or both of these mappings can also be specified:
SIGNLIN Robbed bit signaling bits are transported. SIGNLOUT Out slot (S1-S4) signaling bits are transported. OMODE NORM IDLE AZC Output mode: Default: The outgoing stream is a regular DS1 The outgoing stream is set to an idle code: repeating 1100 The outgoing stream will have any AIS code changed to all-zeros.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-23 Table 6-32 DS1 auto-in-service parameter descriptions Parameter Valid values Description auto-in-service auto-in-service deactivated
SST AINS (secondary state) AINS-DEA HH-MM (hour-minute)
00-01 to 96-00 Default = 04-00 ( 4 hours) Amount of time that an error-free signal must be present on the DS1 line in order for the auto-in-service state to clear. If an error-free signal is present for less than this period of time, the DS1 facility remains in an auto-in-service state.
Note: The default secondary state for a DS1 facility is NULL. That is, when a DS1 facility autoprovisions, the secondary state is not auto-in-service. This state is reported as a blank in the TL1 response to a RTRV-T1 command. The purpose of the AINS-DEA parameter is to deactivate the AINS secondary state.
When the AINS-DEA parameter is entered, it is not maintained as a secondary state and is not reported by the RTRV-T1 command. The secondary state remains NULL until it is changed with either the ENT-T1 or ED-T1 command. Example input
Alter the provisioning for DS1 facility #7 on the DS1 circuit pack in slot 4; change the TX EQLZ value and set the FMT to ESF:
ED-T1:NEWYORK:DS1-4-7:CTAG123:::EQLZ=2TX,FMT=ESF;
Change all the DS1 facilities on the DS1 circuit pack in slot 6 to use B8ZS:
ED-T1:SEATTLE:DS1-6-ALL:CTAG123:::LINECDE=B8ZS;
Change all the DS1 facilities on the DS1 circuit pack in slot 6 to set the MAP to VTBYTE:
ED-T1:SEATTLE:DS1-6-ALL:CTAG123:::MAP=VTBYTE;
ED-T3
The Edit T3 command is used to edit the service parameters (attributes) of a DS3 facility. Note: To change primary state use the RMV-T3 and RST-T3 commands. Security level Level 3 Input syntax
ED-T3:[TID]:AID:CTAG:::[LBO=Domain][,FMT=Domain]; Table 6-33 Syntax definition Field TID AID CTAG LBO=Domain FMT=Domain Purpose Target identifier Access identifier. DS3s to act on. Correlation tag Line buildout Frame format Optional parameters. See Keyword descriptions table for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-25 Table 6-34 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3s where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX)
Table 6-35 Keyword descriptions Keyword FMT Domain ASYNC UNFR LBO 1 2 Example input Description Multiplex framed (default) Unframed clear channel 0 to 224 ft to DS3 cross-connect (default) 225 to 450 ft to DS3 cross-connect
Change the FMT of the DS3 facility on the DS3 circuit pack in slot 5 to UNFR:
ED-T3:NEWYORK:DS3-5:CTAG23:::FMT=UNFR;
ENT-EC1
The Enter EC-1 command provisions and enters the attributes of an EC-1 facility in a network element. Security level Level 3 Input syntax
ENT-EC1:[TID]:AID:CTAG:::[LBO=Domain]:[PST]; Table 6-36 Syntax definition Field TID AID CTAG LBO=Domain PST Purpose Target identifier Access identifier. EC-1 facility to act on. Correlation tag Line buildout. Optional parameter. See Keyword descriptions table for details. Primary state. Optional parameter. See Parameter descriptions table for details.
Table 6-37 AID descriptions AID type EC1 AID Command-specific values EC1-slot# Purpose Identify the EC-1 facility slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX)
Table 6-38 Keyword descriptions Keyword LBO Domain 1 2 Description 0-224 ft to EC-1 cross-connect (default) 225-450 ft to EC-1 cross-connect
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-27 Table 6-39 Parameter descriptions Parameter PST Possible values IS OOS-MA Example input Description In service (default) Out of service maintenance for memory administration
Enter an EC-1 facility for the circuit pack in slot 7:

ENT-EC1:SEATTLE:EC1-7:CTAG23:::LBO=1;
ENT-EIM
The Enter EIM command is used to enter the attributes of an EIM bridge facility in an OC-3 Express network element. To modify EIM facilities once they have been created, use the ED-EIM command. Security level Level 3 Input syntax
ENT-EIM:[TID]:AID:CTAG:::[FILTER=Domain][,STP=Domain] [,SNMP=Domain][,ETHDPX=domain][,IPADDR=Domain][,IPMASK=Domain] [,IPBROAD=Domain]; Table 6-40 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 6-41 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-29 Table 6-42 Parameter descriptions Parameter FILTER Possible values ON OFF STP ON OFF SNMP ON OFF ETHDPX HALF Description Traffic is not allowed to pass through (default) Allows traffic to pass through Enable spanning tree protocol (default) Disable spanning tree protocol Enable SNMP Disable SNMP (default) HALF (for half duplex) allows Ethernet bridge ports to alternately transmit or receive. Default is ETHDPX=HALF. FULL (for full duplex) allows Ethernet bridge ports to simultaneously transmit and receive.
FULL

IPADDR x.x.x.x where IP address of this entry x= 0 to 255 or null (Note) x.x.x.x where Subnet mask associated with the IP address of this x= 0 to 255 entry or null (Note) x.x.x.x where IP broadcast address used to send datagrams on the x= 0 to 255 (logical) interface associated with the IP address of or null (Note) this entry
IPMASK
IPBROAD
Note: You can dynamically assign the IP address , the IP subnet mask, or the IP broadcast address by leaving the domain field blank and entering the command string; for example, ...,IPADDR=, IPMASK=47.123.24.43, IPBROAD=, ...
Example input
Add EIM bridge facility 2 to the EIM circuit pack in slot 7 with filtering, SNMP enabled, and an IP address of 127.123.123.123:
ENT-EIM:SEATTLE:EIM-7-2:CTAG34:::FILTER=ON,SNMP=ON, IPADDR=127.123.123.123;
ENT-FFP-OC3
The Enter FFP OC-3 command is used to set up 1+1 linear protection for OC-3 interfaces. The command also affects the operation of the SDCC in different ways depending on the current number of SDCC links configured on the pair of OC-3 interfaces targeted by this command. If two SDCC links are provisioned before 1+1 protection is set up, make sure the SDCC layer 2 parameters are the same for both links. If the parameters are not the same, the ENT-FFP-OC3 command will not complete. Security level Level 3 Input syntax
ENT-FFP-OC3:[TID]:workingOC3AID,protectionOC3AID:CTAG::: [PSDIRN=Domain]; Table 6-43 Syntax definition Field TID AID CTAG PSDIRN Purpose Target identifier Access identifier. OC-3 to act on. Correlation tag Direction of protection group for OC-3 lines UNI (unidirectional): default BI (bidirectional)
Table 6-44 AID descriptions AID type working OC3 AID Command-specific values OC3-slot# Purpose Identify the slot number of the working OC-3 where slot# = 3, 5, 7, 9, or 11 (Express) slot# = 3 (Express CX) Identify the slot number of the protection OC-3 where slot# = 4, 6, 8, 10, or 12 (Express) slot# = 4 (Express CX)
protection OC3 AID
Example input
Provision unidirectional 1+1 protection for the pair of OC-3 circuit packs in slots 9 and 10:
ENT-FFP-OC3:NEWYORK:OC3-9,OC3-10:CTAG12:::PSDIRN=UNI; S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998
ENT-OC3
The Enter OC-3 command provisions and enters the attributes of an OC-3 facility in a network element. Security level Level 3 Input syntax
ENT-OC3:[TID]:AID:CTAG:::[SDTH=Domain][,STFORMAT=Domain] [,STRC=Domain][,EXPSTRC=Domain][,STFMODE=Domain] [,SSBITMDE=Domain]:[PST]; Table 6-45 Syntax definition Field TID AID CTAG SDTH STFORMAT STRC EXPSTRC STFMODE SSBITMDE PST Table 6-46 AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 facility where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX) Purpose Target identifier Access identifier. OC-3 to act on. Correlation tag Signal degrade threshold. See Parameter Descriptions table for details. Section trace format. See Parameter Descriptions table for details. Outgoing section trace message. See Parameter Descriptions table for details. Expected section trace message. See Parameter Descriptions table for details. Section trace fail mode. See Parameter Descriptions table for details. SS bits mode Primary state. See Parameter Descriptions table for details.
6-32 Facility detailed command descriptions Table 6-47 Parameter descriptions Parameter SDTH Possible values 5 to 9 Description Translates to 10-5 to 10-9 (default is 6) Section trace message is 1 byte long (default) Section trace message is up to 15 bytes long If STFORMAT is NUM (default is 1) If STFORMAT is STRING (default is null character string). See Note 1. If STFORMAT is NUM (default is 1) If STFORMAT is STRING (default is null character string). See Note 1. Alarms off, no traffic protection (default) Alarms on, no traffic protection Default
STFORMAT NUM STRING STRC 0 to 255 ASCII string up to 15 characters EXPSTRC 0 to 255 ASCII string up to 15 characters STFMODE OFF ALMONLY SSBITMDE SONET SDH PST IS (see Note 2) OOS-MA
In service (default) Out of service maintenance for provisioning memory administration
Note 1: The possible values of the section trace messages depend on the STFORMAT value. If STFORMAT is NUM, the possible values are 0 to 255. If STFORMAT is STRING, the possible values are any printable alphanumeric ASCII string up to 15 characters (except comma, colon, semi-colon, equal sign, or question mark) or a NULL character string (for example, STRC=, or EXPSTRC=,). Enclose the ASCII string in double quotes () to maintain case sensitivity. The string must begin and end with the double quotes. You cannot use double quotes, or any special character as part of the ASCII string. Note 2: A secondary state cannot be provisioned.
Example input
Set the primary state of the OC-3 facility in slot 12 to an in-service state with a section trace format value of STRING and an outgoing section trace value of Abc123 and the SSBITMDE to SONET:
ENT-OC3:SEATTLE:OC3-12:CTAG12:::STFORMAT=STRING,STRC=Abc123, SSBITMDE=SONET:IS;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ENT-T1
The Enter T1 command is used to enter the attributes of a DS1 facility in a network element. Since there are multiple DS1 facilities for each DS1 circuit pack, ENT-T1 can only be used to provision the line terminations; ENT-EQPT must be used to provision the circuit pack. To modify DS1 facilities once they have been created, use the ED-T1 command. Security level Level 3 Input syntax
ENT-T1:[TID]:AID:CTAG:::[EQLZ=Domain][,FENDNTE=Domain] [,FLMDE=Domain][,FMT=Domain][,LINECDE=Domain][,MAP=Domain] [,OMODE=Domain]:[PST],[SST],[HH-MM]; Table 6-48 Syntax definition Field TID AID CTAG EQLZ=Domain FENDNTE=Domain FLMDE=Domain FMT=Domain LINECDE=Domain MAP=Domain OMODE=Domain PST SST HH-MM Purpose Target identifier Access identifier. DS1s to act on. Correlation tag Facility signal attribute parameters. See the Facility signal attributes description table on page 6-34.
Primary state. See the DS1 primary state parameter descriptions table on page 6-36. DS1 auto-in-service parameters. See the DS1 auto-in-service parameter descriptions table on page 6-23.
6-34 Facility detailed command descriptions Table 6-49 Facility signal attributes description Keyword EQLZ Domain Description Cable connecting T1 to DS1 cross-connect. If the cables for the incoming and outgoing streams are different, add TX or RX to the domain, for example 1RX or 2TX. 1, 2 and 3 set the values for both TX and RX cables. 1 1TX 1RX 2 2TX 2RX 3 3TX 3RX FENDNTE ANSI NOTANSI FLMDE BOTH INC OC N FMT SF ESF SF-TR08 Default: short: 0-220 ft both directions 0-220 ft transmit 0-220 ft receive medium: 220-430 ft both directions 220-430 ft transmit 220-430 ft receive long: 430-655 ft both directions 430-655 ft transmit 430-655 ft receive Default: Far end NTE supports ANSI standards ANSI standards are not supported Fault locate mode: Faults in the frame format will be checked for. Use N if DS1 data is unframed. Default: both incoming and outgoing data streams will have the frame format, as specified by FMT, checked. Only check incoming data. (Outgoing can be unframed.) Only check outgoing data. Do not check the frame format. (The DS1 facility can be unframed or used as a clear channel facility.) Default: Superframe format Extended Superframe format Superframe with TR08 extensions
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-35 Table 6-49 (continued) Facility signal attributes description Keyword LINECDE Domain Description Line code. If the incoming and outgoing streams are different, add TX or RX to the domain, for example AMITX, B8ZSRX. AMI AMITX AMIRX AMIZCS Default: Alternate mark inversion (bipolar) both directions AMI transmit AMI receive
AMI with zero code suppression, both directions If there are 8 zeros in a byte, the least significant will be changed to a one. AMIZCSTX AMIZCS transmit
Note: Zero code suppression is not supported in the receive direction.

B8ZS B8ZSTX B8ZSRX MAP VTASYN VTBYTE VTBIT MAP SIGNLIN Bipolar with 8-zero substitution, both directions B8ZS Transmit B8ZS Receive The form of mapping for DS1 payloads into VT1.5s. Default:VT1.5 bit asynchronous mapping VT1.5 byte synchronous mapping VT1.5 bit synchronous mapping If using VTBYTE mapping, one or both of these mappings can also be specified: Robbed bit signaling bits are transported. SIGNLOUT Out slot (S1-S4) signaling bits are transported.

OMODE NORM IDLE AZC Output mode: Default: The outgoing stream is a regular DS1 The outgoing stream is set to an idle code: repeating 1100 The outgoing stream will have any AIS code changed to all-zeros.
6-36 Facility detailed command descriptions Table 6-50 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL Purpose Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Table 6-51 DS1 primary state parameter descriptions Parameter PST (primary state) Example input Valid values IS OOS-MA Description In service (default) Out of service maintenance
Provision DS1 facility #7 on the DS1 circuit pack in slot 4 and set its TX EQLZ value:
ENT-T1:NEWYORK:DS1-4-7:CTAG23:::EQLZ=2TX;
Provision all the DS1 facilities on the DS1 circuit pack in slot 6 and set their LINECDE values to use B8ZS:
ENT-T1:NEWYORK:DS1-6-ALL:CTAG23:::LINECDE=B8ZS;
Provision DS1# 7 on the DS1 circuit pack in slot 4, overruling the defaults for EQLZ (it is a long cable, not a short one) and FMT (the framing is extended superframe):
ENT-T1:NEWYORK:DS1-4-7:CTAG23:::EQLZ=3,FMT=ESF;
Provision all the DS1 facilities on the DS1 circuit pack in slot 6 with the defaults:
ENT-T1:WASHINGTON:DS1-6-ALL:CTAG23;
Provision all the DS1 facilities on the DS1 circuit pack in slot 6 and set their MAP values to use VTBYTE:
ENT-T1:SEATTLE:DS1-6-ALL:CTAG23:::MAP=VTBYTE;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ENT-T3
The Enter T3 command is used to enter the attributes of a DS3 facility in a network element. To modify DS3 facilities once they have been created, use the ED-T3 command. Security level Level 3 Input syntax
ENT-T3:[TID]:AID:CTAG:::[LBO=Domain][,FMT=Domain]:[PST]; Table 6-52 Syntax definition Field TID AID CTAG LBO=Domain FMT=Domain Purpose Target identifier Access identifier. DS3s to act on. Correlation tag Line buildout Frame format Optional parameters. See Keyword Descriptions table for details. Primary state. Optional parameter. See Parameter descriptions table for details.
PST
Table 6-53 Keyword descriptions Keyword FMT Domain ASYNC UNFR LBO 1 2 Description Multiplex framed (default) Unframed clear channel 0-224 ft to DS3 cross-connect (default) 225-450 ft to DS3 cross-connect
6-38 Facility detailed command descriptions Table 6-54 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3s where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX)
Table 6-55 Facility parameter descriptions Parameter PST Possible values IS OOS-MA Description In service (default) Out of service maintenance for provisioning memory administration
Example input
Provision a DS3 facility on the DS3 circuit pack in slot 5:

ENT-T3:NEWYORK:DS3-5:CTAG23:::LBO=2,FMT=UNFR;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RMV-EC1
The Remove EC-1 command is used to put an EC-1 facility in an out-of-service maintenance for memory administration state. Once the EC-1 is removed from service, service-affecting tests or physical replacement of defective equipment can be initiated. Security level Level 3 Input syntax
RMV-EC1:[TID]:AID:CTAG; Table 6-56 Syntax definition Field TID AID CTAG Table 6-57 AID descriptions AID type EC-1 AID Command-specific values EC1-slot# Purpose Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. EC-1 facility to act on. Correlation tag
Example input
Put the EC-1 facility in slot 5 in an out-of-service state:

RMV-EC1:SEATTLE:EC1-5:CTAG45;
RMV-EIM
The Remove EIM command is used to put an EIM facility/bridge in an out-of-service maintenance for memory administration state. Once the EIM is removed from service, service-affecting tests or physical replacement of defective equipment can be initiated. Security level Level 3 Input syntax
RMV-EIM:[TID]:AID:CTAG; Table 6-58 Syntax definition Field TID AID CTAG Table 6-59 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag
Example input
Put the EIM bridge facility 1 on the EIM circuit pack in slot 7 back in an out-of-service state:
RMV-EIM:NEWYORK:EIM-7-1:CTAG34;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RMV-OC3
The Remove OC-3 command instructs a network element to change the state of the OC-3 facility from in service to out-of-service maintenance for memory administration. Once the OC-3 is removed from service, service-affecting tests or physical replacement of defective equipment can be initiated. Security level Level 3 Input syntax
RMV-OC3:[TID]:AID:CTAG; Table 6-60 Syntax definition Field TID AID CTAG Table 6-61 AID descriptions AID type OC-3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. OC-3s to act on. Correlation tag
Example input
Remove OC-3 facility on the OC-3 circuit pack in slot 12:

RMV-OC3:NEWYORK:OC3-12:CTAG56;
RMV-T1
The Remove T1 command instructs a network element to change the state of the DS1 from in-service to out-of-service maintenance for memory administration. Once the DS1 is removed from service, service-affecting tests or physical replacement of defective equipment can be initiated. Security level Level 3 Input syntax
RMV-T1:[TID]:AID:CTAG; Table 6-62 Syntax definition Field TID AID CTAG Table 6-63 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL Purpose Identify the DS1s where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Example input Purpose Target identifier Access identifier. DS1s to act on. Correlation tag
Remove DS1 facility # 7 on the DS1 circuit pack in slot 4:

RMV-T1:NEWYORK:DS1-4-7:CTAG45;
Remove all the DS1 facilities on the DS1 circuit pack in slot 6:
RMV-T1:CHARLESTON:DS1-6-ALL:CTAG78;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RMV-T3
The Remove T3 command instructs a network element to change the state of the DS3 from in-service to out-of-service maintenance for memory administration. Once the DS3 is removed from service, service-affecting tests or physical replacement of defective equipment can be initiated. Security level Level 3 Input syntax
RMV-T3:[TID]:AID:CTAG; Table 6-64 Syntax definition Field TID AID CTAG Table 6-65 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3s where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. DS3s to act on. Correlation tag
Example input
Remove the DS3 facility on the DS3 circuit pack in slot 5:

RMV-T3:TOMBSTONE:DS3-3:CTAG45;
RST-EC1
The Restore EC1 command is used to put an EC-1 facility in an in-service state after having been out-of-service maintenance for memory administration. Security level Level 3 Input syntax
RST-EC1:[TID]:AID:CTAG; Table 6-66 Syntax definition Field TID AID CTAG Table 6-67 AID descriptions AID type EC-1 AID Command-specific values EC1-slot# Purpose Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. EC-1 facility to act on. Correlation tag
Example input
Put the EC-1 facility in slot 5 back in service:

RST-EC1:NEWYORK:EC1-5:CTAG34;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RST-EIM
The Restore EIM command is used to put an EIM facility in an in-service state after having been out-of-service maintenance for memory administration. Security level Level 3 Input syntax
RST-EIM:[TID]:AID:CTAG; Table 6-68 Syntax definition Field TID AID CTAG Table 6-69 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag
Example input
Put the EIM bridge facility 1 on the EIM circuit pack in slot 7 back in service:
RST-EIM:NEWYORK:EIM-7-1:CTAG34;
RST-OC3
The Restore OC-3 command instructs the network element to bring an OC-3 facility back into service from an out-of-service maintenance for memory administration state. Security level Level 3 Input syntax
RST-OC3:[TID]:AID:CTAG; Table 6-70 Syntax definition Field TID AID CTAG Table 6-71 AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC3s where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX) Purpose Target identifier Access identifier. OC3s to act on. Correlation tag
Example input
Restore the OC-3 facility on the OC-3 circuit pack in slot 11:
RST-OC3:NEWYORK:OC3-11:CTAG77;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RST-T1
The Restore T1 command instructs a network element to bring a DS1 back into service from an out-of-service maintenance for memory administration state. Security level Level 3 Input syntax
RST-T1:[TID]:AID:CTAG; Table 6-72 Syntax definition Field TID AID CTAG Table 6-73 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL Purpose Identify the DS1s where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Example input Purpose Target identifier Access identifier. DS1s to act on. Correlation tag
Restore DS1 facility # 7 on the DS1 circuit pack in slot 4:

RST-T1:NEWYORK:DS1-4-7:BM001;
Restore all the DS1 facilities on the DS1 circuit pack in slot 6:
RST-T1:SEATTLE:DS1-6-ALL:CK002;
RST-T3
The Restore T3 command instructs a network element to bring a DS3 back into service from an out-of-service maintenance for memory administration state. Security level Level 3 Input syntax
RST-T3:[TID]:AID:CTAG; Table 6-74 Syntax definition Field TID AID CTAG Table 6-75 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3s where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. DS3s to act on. Correlation tag
Example input
Restore the DS3 facility on the DS3 circuit pack in slot 5:

RST-T3:NEWYORK:DS3-5:CTAG01;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-DFLT-AINS
Use the Retrieve default auto-in-service command to retrieve the current default DS1 auto-in-service (AINS) start-up time for a shelf. When the secondary state of a DS1 facility is set to auto-in-service (using the ED-T1 or ENT-T1 commands), and the start-up time parameter (HH:MM) is not entered, HH:MM assumes the default start-up time. Security level Level 1 Input syntax
RTRV-DFLT-AINS:[TID]::CTAG; Table 6-76 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
For the SEATTLE network element, retrieve the default DS1 AINS start-up time:
RTRV-DFLT-AINS:SEATTLE::CTAG04;

DFLT-AINS-TIME=HH:MM Table 6-77 Response parameter descriptions Parameter HH:MM (hour:minute) Valid values 00:01 to 96:00 Description Default = 04:00 (4 hours) Amount of time that an error-free signal must be present on the DS1 line in order for the auto-in-service state to clear. If an error-free signal is present for less than this period of time, the DS1 facility remains in an auto-in-service state.
RTRV-EC1
The Retrieve EC1 command is used to retrieve the data parameters and state parameters for provisioned EC-1 facilities. You can retrieve information for EC-1 facilities by specifying the odd-numbered slots. Security level Level 1 Input syntax
RTRV-EC1:[TID]:AID:CTAG;

Table 6-78 Syntax definition Field TID AID CTAG Table 6-79 AID descriptions AID type EC1 Command-specific values EC1-slot# EC1-ALL Purpose Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. EC-1 facility to act on. Correlation tag
Example input
Retrieve the provisioning and service states of the EC-1 facility in slot 7:
RTRV-EC1:SEATTLE:EC1-7:CTAG19;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<TMGREF=Domain><,LBO=Domain><,DCC=Domain>:<PST>,<SST> Table 6-80 Response block descriptions Keyword AID TMGREF Domain EC1-slot# Y N LBO 1 2 DCC Y N PST IS IS-ANR OOS-MA OOS-AU OOS-AUMA Description The EC-1 and slot number for which the data is retrieved Yes, the signal is a timing reference. No, the signal is not a timing reference. 0-224 ft to EC-1 cross-connect (default) 225-450 ft to EC-1 cross-connect Yes, SDCC is enabled No, SDCC is not enabled In-service In-service -Abnormal Out-Of-Service Maintenance for provisioning Memory Administration Out-Of-Service Autonomous - the entity is not able to perform its provisioned functions (alarm is raised) Out-Of-Service Autonomous Management - the entity is not able to perform its provisioned functions and is purposefully removed from service
OOS-MA-ANR Out-Of-Service Maintenance - abnormal SST ACT DISCD FLT SGEO WRKTX WRKRX Active - carrying traffic (default) Disconnected - not carrying traffic Fault detected in equipment Supporting entity outage Working (active) transmitter Working (active) receiver
RTRV-EIM
The Retrieve EIM command is used to retrieve the provisioning and service state of an EIM bridge facility. Security level Level 1 Input syntax
RTRV-EIM:[TID]:AID:CTAG;

Table 6-81 Syntax definition Field TID AID CTAG Table 6-82 AID descriptions AID type EIM Command-specific values EIM-slot#-bridge# EIM-slot#-ALL EIM-ALL Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag
Example input
Retrieve the provisioning and service state of EIM bridge facility 1 for the EIM circuit pack in slot 7:
RTRV-EIM:SEATTLE:EIM-7-1:CTAG19;

AID::<FILTER=Domain><,STP=Domain><,SNMP=Domain> <,IPADDR=Domain><,IPMASK=Domain><,IPBROAD=Domain>:<pst><,sst>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-53 Table 6-83 Response block descriptions Keyword AID FILTER Domain Description
EIM-slot#-bridge# The EIM slot number and bridge facility for which the data is retrieved ON OFF Traffic is not passing through Traffic is passing through Spanning tree protocol is enabled Spanning tree protocol is disabled SNMP is enabled SNMP is disabled HALF (for half duplex) allows Ethernet bridge ports to alternately transmit or receive. Default is ETHDPX=HALF. FULL (for full duplex) allows Ethernet bridge ports to simultaneously transmit and receive.
STP
ON OFF
SNMP
ON OFF
ETHDPX
HALF
FULL

IPADDR x.x.x.x where x= 0 to 255 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) IP address of this entry
IPMASK
Subnet mask associated with the IP address of this entry IP broadcast address used to send datagrams on the (logical) interface associated with the IP address of this entry In-service Out-Of-Service Maintenance for provisioning Memory Administration Out-Of-Service Autonomous - the entity is not able to perform its provisioned functions (alarm is raised) Out-Of-Service Autonomous Management - the entity is not able to perform its provisioned functions and is purposefully removed from service
continued
IPBROAD x.x.x.x where x= 0 to 255 or null (Note) PST IS OOS-MA OOS-AU
OOS-AUMA
6-54 Facility detailed command descriptions Table 6-83 (continued) Response block descriptions Keyword SST Domain DISCD FLT SGEO Description Disconnected not carrying traffic Fault detected in equipment Supporting entity outage
Note: This keyword may not have a return value following the =. For example, ...,IPADDR=, IPMASK=47.123.24.43, IPBROAD=, ...
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-FFP-OC3
The Retrieve Facility Protection Group OC-3 command is used to retrieve the protection state of the OC-3 interfaces. Security level Level 1 Input syntax
RTRV-FFP-OC3:[TID]:OC3-ALL|workingOC3AID,protectionOC3AID: CTAG;

Table 6-84 Syntax definition Field TID CTAG Table 6-85 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL OC3-slot# Purpose Identify the OC-3 slot where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Identify the slot number of the working OC-3 where slot# = 3, 5, 7, 9, or 11 (Express) slot# = 3 (Express CX) Identify the slot number of the protection OC-3 where slot# = 4, 6, 8, 10, or 12 (Express) slot# = 4 (Express CX) Purpose Target identifier Correlation tag
working OC3 AID
protection OC3 AID
Example input
Retrieve the protection state for network element WASHINGTON:

RTRV-FFP-OC3:WASHINGTON:OC3-11:CTAG12;

WorkingOC3aid,ProtectionOC3aid:<PSDIRN=Domain> Table 6-86 Response block descriptions Keyword WorkingOC3aid Domain OC3-slot# Description Working OC-3 AID, where slot# = 3, 5, 7, 9, or 11 (Express) slot# = 3 (Express CX) Protection OC-3 AID, where slot# = 4, 6, 8, 10, or 12 (Express) slot# = 4 (Express CX) UNI BI Unidirectional Bidirectional
ProtectionOC3aid
PSDIRN
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-IMA-GRP
The Retrieve IMA group command is used to retrieve the IMA group parameters. Security level Level 1 Input syntax
RTRV-IMA-GRP:[TID]:AID:CTAG;

Table 6-87 Syntax definition Field TID AID CTAG Table 6-88 AID descriptions AID type EIM Command-specific values EIM-slot#-bridge#-vp# EIM-slot#-bridge#-ALL EIM-slot#-ALL EIM-ALL Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 vp#= 1 to 8 Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag
Example input
Retrieve the IMA group parameters of the for the virtual port 6 of EIM bridge facility 1 for the EIM circuit pack in slot 7:
RTRV-IMA-GRP:SEATTLE:EIM-7-1-6:CTAG19;

AID::<IMALEN=Domain> <,GRPSYM=Domain> <,IMAID=Domain>, <IMAFRAME=Domain> <,IMASCRAM=Domain> <,PROVBAN=Domain> <,AVAILBAN=Domain> Table 6-89 Response block descriptions Keyword AID IMALEN GRPSYM ACO AOSC SCO IMAID IMAFRAME IMASCRAM PROVBAN AVAILBAN 0 to 255 SF ESF ON OFF 0 to 8 0 to 8 Domain Description
EIM-slot#-bridge#-vp# The EIM slot number, bridge facility, and virtual port for which the data is retrieved 32, 64, 128, 256 Frame length (default is 128) Group symmetry Asymmetrical configuration and operation Symmetrical configuration and asymmetrical operation Symmetrical configuration and operation (default) IMA group number Superframe (default) Extended super frame Payload scrambling is enabled Payload scrambling is disabled (default) Number of provisioned TI links Number of provisioned TI links carrying traffic
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-OC3
The Retrieve OC-3 command retrieves the data, state, and signal degrade threshold (SDTH) parameters and the provisioned section trace and SS Bits information for specified OC-3 facilities. Security level Level 1 Input syntax
RTRV-OC3:[TID]:AID:CTAG:::[STINFO=Domain][,SSBITINFO=Domain];
6-60 Facility detailed command descriptions Table 6-90 Syntax definition Field TID AID CTAG STINFO SSBITINFO Purpose Target identifier Access identifier. OC-3 facilities to act on. Correlation tag Section trace information. See the Parameter descriptions table for details. SS bit mode information. See the Parameter descriptions table for details.
Table 6-91 AID descriptions AID type OC3 Command-specific values OC3-slot# OC3-ALL Purpose Identify the OC-3 facility where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX)
Table 6-92 Parameter descriptions Parameter STINFO Possible values NO YES SSBITINFO NO YES Example input Description Do not include the section trace information in the response (default) Include the section trace information in the response Do not include SS Bits information in the response (default) Include SS Bits information in the response
Retrieve information for the OC-3 facility in slot 11 on network element NEWYORK:
RTRV-OC3:NEWYORK:OC3-11:CTAG46:::STINFO=YES,SSBITINFO=YES;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Response block syntax If the values of the STINFO and SSBITINFO parameters are NO or not specified:
AID::<TMGREF=Domain>,<DCC=Domain>,<TRC=String>,<SDTH=Domain>: <pst>,<sst>
If the values of the STINFO and SSBITINFO parameters are YES:

AID::<TMGREF=Domain>,<DCC=Domain>,<TRC=String>,<SDTH=Domain>, <STFORMAT=Domain>,<STRC=Domain>,<EXPSTRC=Domain>, <STFMODE=Domain><SSBITINFO=Domain>:<pst>,<sst> Table 6-93 Response AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 facility
Table 6-94 Response parameter descriptions Parameter TMGREF Possible values Y N DCC Y N TRC SDTH Null 5, 6, 7, 8, or 9 Description Yes, the signal is a timing reference. No, the signal is not a timing reference. Yes, SDCC is enabled. No, SDCC is not enabled. This field is not used in this release. Signal degrade threshold is specified as a bit error rate where: 5 = 10-5 errors per second 6 = 10-6 errors per second 7 = 10-7 errors per second 8 = 10-8 errors per second STFORMAT NUM STRING STRC EXPSTRC Section trace format (see Notes 1 and 2) Outgoing section trace message (see Notes 1 and 2) Expected incoming section trace message (see Notes 1 and 2)
continued
6-62 Facility detailed command descriptions Table 6-94 (continued) Response parameter descriptions Parameter STFMODE Possible values OFF ALMONLY LINEFAIL Description Section trace fail mode (see Note 2)
SSBITINFO SONET (see Note 4) SDH PST IS IS-ANR OOS-MA OOS-AU OOS-AUMA
Default
In-service In-service Abnormal Out-Of-Service Maintenance for provisioning Memory Administration Out-Of-Service Autonomous - the entity is not able to perform its provisioned functions (alarm is raised) Out-Of-Service Autonomous Management - the entity is not able to perform its provisioned functions and is purposefully removed from service
OOS-MA-ANR Out-Of-Service Maintenance abnormal SST ACT (see Note 3) DISCD FLT SGEO WRKTX WRKRX Active carrying traffic (default) Disconnected not carrying traffic Fault detected in equipment Supporting entity outage Working (active) transmitter Working (active) receiver
Note 1: The possible values of the section trace messages depend on the STFORMAT value. If STFORMAT is NUM, the possible values are 0 to 255. If STFORMAT is STRING, the possible values are any printable alphanumeric ASCII string up to 15 characters (except comma, colon, semi-colon, equal sign, or question mark) or a NULL character string (for example, STRC=, or EXPSTRC=,). Note 2: This value is only returned by the RTRV-OC3 command if STINFO=YES. Note 3: The secondary state can be retrieved by the RTRV-OC3 command but cannot be set by the corresponding ENT-OC3 command. Note 4: This value is only returned by the RTRV-OC3 command if SSBITINFO=YES.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-T1
The Retrieve T1 command retrieves the data parameters and state parameters that have been provisioned for specified DS1 facilities. This command identifies what parameters have been set using the ENT-T1 or ED-T1 command. The RTRV-T1 command does not report whether a DS1 circuit pack is present or operational, but simply that it has been provisioned and with which attributes. Security level Level 1 Input syntax
RTRV-T1:[TID]:AID:CTAG;

Table 6-95 Syntax definition Field TID AID CTAG Table 6-96 AID descriptions AID type T1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL DS1-ALL Purpose Identify the DS1s where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Purpose Target identifier Access identifier. DS1s to act on. Correlation tag
6-64 Facility detailed command descriptions Example input
Retrieve provisioned conditions of all the DS1 facilities in slot 6:

RTRV-T1:NEWYORK:DS1-6-ALL:CTAG29;
Retrieve provisioned conditions of the DS1 facility # 3 in slot 5:

RTRV-T1:WASHINGTON:DS1-5-3:CTAG34;

AID::<EQLZ=Domain>,<FENDNTE=Domain>,<FLMDE=Domain>, <FMT=Domain>,<LINECDE=Domain>,<OMODE=Domain>,<TMGREF=Domain>, <MAP=Domain>:<PST>,<SST>[,HH:MM]; Table 6-97 Response AID description AID type T1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL DS1-ALL Purpose Identify the DS1s where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-65 Table 6-98 Response parameter descriptions Keyword EQLZ Domain Description Cable connecting T1 to DS1 cross-connect. If the cables for the incoming and outgoing streams are different, add TX or RX to the domain, for example 1RX or 2TX. 1, 2, and 3 set the values for both TX and RX cables. 1 1TX 1RX 2 2TX 2RX 3 3TX 3RX FENDNTE ANSI NOTANSI FLMDE BOTH INC OC N FMT SF ESF SF-TR08 Default: short: 0-220 ft both directions 0-220 ft transmit 0-220 ft receive medium: 220-430 ft both directions 220-430 ft transmit 220-430 ft receive long: 430-655 ft both directions 430-655 ft transmit 430-655 ft receive Default: Far end NTE supports ANSI standards ANSI standards are not supported Fault locate mode: Faults in the frame format will be checked for. Use N if DS1 data is unframed. Default: both incoming and outgoing data streams will have the frame format, as specified by FMT, checked. Only check incoming data. (Outgoing can be unframed.) Only check outgoing data. Do not check the frame format. (The DS1 facility can be unframed or used as a clear channel facility.) Default: Superframe format Extended Superframe format Superframe with TR08 extensions
continued
6-66 Facility detailed command descriptions Table 6-98 (continued) Response parameter descriptions Keyword LINECDE Domain Description Line code. If the incoming and outgoing streams are different, add TX or RX to the domain, for example AMITX, B8ZSRX. AMI AMITX AMIRX AMIZCS Default: Alternate mark inversion (bipolar) both directions AMI Transmit AMI Receive
AMI with zero code suppression, both directions If there are eight zeros in a byte, the least significant will be changed to a one. AMIZCSTX AMIZCS transmit
Note: Zero code suppression is not supported in the receive direction.

B8ZS B8ZSTX B8ZSRX OMODE NORM IDLE AZC TMGREF MAP VTASYN VTBYTE VTBIT MAP SIGNLIN Y N Bipolar with 8-zero substitution, both directions B8ZS transmit B8ZS receive Output mode: Default: The outgoing stream is a regular DS1 The outgoing stream is set to an idle code: repeating 1100 The outgoing stream will have any AIS code changed to all-zeros. Yes, the signal is a timing reference. No, the signal is not a timing reference. The form of mapping for DS1 payloads into VT1.5s. Default: VT1.5 asynchronous mapping VT1.5 byte synchronous mapping VT1.5 bit synchronous mapping If using VTBYTE mapping, one or both of these mappings can also be specified: Robbed bit signaling bits are transported. SIGNLOUT Out slot (S1-S4) signaling bits are transported.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility detailed command descriptions 6-67 Table 6-99 Facility parameter descriptions Parameter PST Possible values IS IS-ANR OOS-MA OOS-AU OOS-AUMA Description In-Service In Service - Abnormal Out-Of-Service Maintenance for provisioning Memory Administration Out-Of-Service Autonomous the entity is not able to perform its provisioned functions (alarm is raised) Out-Of-Service Autonomous Management - the entity is not able to perform its provisioned functions and is purposefully removed from service
OOS-MA-ANR Out of service maintenance abnormal SST ACT DISCD FLT SGEO AINS AINS-DEA Default: Active -- carrying traffic Disconnected -- not carrying traffic Fault Detected in Equipment Supporting Entity Outage auto-in-service auto-in-service deactivated (see Note 1)
HH:MM 00:01 to 96:00 Amount of time that an error-free signal must be (hour:minute) present on the DS1 line in order for the auto-in-service state to clear. If an error-free signal is present for less than this period of time, the DS1 facility remains in an auto-in-service state. See Note 2.
Note 1: Although the value of AINS-DEA can be set as the SST, it will never be retrieved. Note 2: HH:MM is only returned in the TL1 Response Block if there is an SST of AINS.
RTRV-T3
The Retrieve T3 command retrieves the data parameters and state parameters that have been provisioned for specified DS3 facilities. This command identifies what parameters have been set using the ENT-T3 command. The RTRV-T3 command does not report whether a DS3 circuit pack is present or operational, but simply that it has been provisioned and with which attributes. Security level Level 1 Input syntax
RTRV-T3:[TID]:AID:CTAG;

Table 6-100 Syntax definition Field TID AID CTAG Table 6-101 AID descriptions AID type T3 AID Command-specific values DS3-slot# DS3-ALL Purpose Identify the DS3s where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. DS3s to act on. Correlation tag
Example input
Retrieve provisioned conditions of the DS3 facility on the DS3 in slot 7:

RTRV-T3:NEWYORK:DS3-7:CTAG29;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<LBO=Domain><,FMT=Domain>:<PST><,SST> Table 6-102 Response block descriptions Keyword T3 AID Domain DS3-slot# DS3-ALL 1 2 FMT ASYNC UNFR Description Identify the DS3s slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) 0-224 ft to DS3 cross-connect (default) 225-450 ft to DS3 cross-connect Multiplex framed (default) Unframed clear channel
LBO
Table 6-103 Facility parameter descriptions Parameter PST Possible values IS IS-ANR OOS-MA OOS-AU OOS-AUMA Description In-Service In Service - Abnormal Out-Of-Service Maintenance for provisioning Memory Administration Out-Of-Service Autonomous the entity is not able to perform its provisioned functions (alarm is raised) Out-Of-Service Autonomous Management - the entity is not able to perform its provisioned functions and is purposefully removed from service
OOS-MA-ANR Out-Of-Service Maintenance abnormal SST ACT DISCD FLT SGEO Default: Active carrying traffic Disconnected not carrying traffic Fault Detected in Equipment Supporting Entity Outage
RTRV-VP
The Retrieve VP command is used to retrieve all supported read-only, write-only, and read-write parameters (provisioned bandwidth, available bandwidth) of a specified EIM virtual port one or all of the VPs of a given EIM facility bridge port. Security level Level 1 Input syntax
RTRV-VP:[TID]:AID:CTAG;

Table 6-104 Syntax definition Field TID AID CTAG Table 6-105 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge#-vp# EIM-slot#-bridge#-ALL EIM-slot#-ALL EIM-ALL Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 vp#= 1 to 8 Purpose Target identifier Access identifier. VPs to act on. Correlation tag
Example input
Retrieve the parameters for all of the virtual port for the EIM bridge facility 1 for the EIM circuit pack in slot 7:
RTRV-VP:SEATTLE:EIM-7-1-ALL:CTAG19;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<IMAID=Domain>,<ENCAP=Domain>,<VPI=Domain>,<VCI=Domain>, <CONT=Domain> Table 6-106 Response block descriptions Keyword AID IMAID ENCAP Domain Description
EIM-slot#-bridge#-vp# The EIM slot number, bridge facility, and virtual port number for which the data is retrieved 0 to 255 LLC_CRC LLC VC_CRC VC 1 to 255 1 to 65535 ON OFF IMA group number Type of encapsulation
VPI VCI CONT
ATM VPI value ATM VCI value ATM continuity test is enabled ATM continuity test is disabled
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
7-1
MIB detailed command descriptions 7This chapter is an alphabetical summary of all TL1 commands to provision an EIM bridge for SNMP. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command DLT-MIB-BRIDGE DLT-MIB-IP ED-MIB-BRIDGE ED-MIB-IP ED-MIB-SNMP ED-MIB-SYSTEM ED-MIB-VIEW ENT-MIB-BRIDGE ENT-MIB-IP RTRV-MIB-BRIDGE RTRV-MIB-ICMP RTRV-MIB-IF RTRV-MIB-IP RTRV-MIB-LAN RTRV-MIB-SNMP RTRV-MIB-SYSTEM RTRV-MIB-UDP RTRV-MIB-VIEW Page 7-2 7-4 7-6 7-9 7-12 7-13 7-15 7-19 7-21 7-23 7-29 7-32 7-35 7-41 7-44 7-48 7-50 7-52
7-2 MIB detailed command descriptions
DLT-MIB-BRIDGE
The Delete MIB bridge command is used to remove an entry from the static table in the bridge group MIB. Security level Level 3 Input syntax
DLT-MIB-BRIDGE:[TID]:AID:CTAG:::ADDR=Domain, RCVPORT=Domain; Table 7-1 Syntax definition Field TID AID CTAG ADDR RCVPORT Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag MAC address. See Parameter descriptions table for details. Static receive port. See Parameter descriptions table for details.
Table 7-2 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2
Example input
Delete the entry indexed by MAC address 123456789ABC and static receive port 1 from the static table in the bridge group MIB:
DLT-MIB-BRIDGE:NEWYORK:EIM-7-1:CTAG34:::ADDR=123456789ABC, RCVPORT=1;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-3 Table 7-3 Parameter descriptions Parameter ADDR RCVPORT Domain Description
MAC address Destination MAC address in a frame to which the filtering information of this entry applies 0 to 9 Either the value 0, or the port number of the port from which a frame must be received for the filtering information of this entry to apply.
DLT-MIB-IP
The Delete MIB IP command is used to remove an entry from the IP routing table or the IP address translation table. Security level Level 3 Input syntax For deleting an entry from the IP routing table:
DLT-MIB-IP:[TID]:AID:CTAG:::DST=Domain [,NHOP=Domain];
For deleting an entry from the IP address translation table:

DLT-MIB-IP:[TID]:AID:CTAG:::IDX=Domain, NETADDR=Domain; Table 7-4 Syntax definition Field TID AID CTAG DST NHOP IDX NETADDR Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag Destination IP address of the route. See Parameter descriptions table for details. IP address of the next hop on the route. See Parameter descriptions table for details. Index value of the interface. See Parameter descriptions table for details. IP address corresponding to the media-dependent physical address. See Parameter descriptions table for details.
Table 7-5 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#= 1 to 2
Example input
Delete the table entry for IP route destination 23.43.231.22:

DLT-MIB-IP:NEWYORK:EIM-7-2:CTAG34:::DST=23.43.23.122;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-5 Table 7-6 Parameter descriptions Keyword DST NHOP IDX NETADDR Domain x.x.x.x where x= 0 to 255 x.x.x.x where x= 0 to 255 1 to 9 x.x.x.x where x= 0 to 255 Parameter Destination IP address of this route IP address of the next hop of this route Unique value for each interface IP address corresponding to the media-dependent physical address
ED-MIB-BRIDGE
The Edit MIB bridge command is used to edit an entry in the bridge group, the bridge spanning tree port table, or the static table in the bridge group. Security level Level 3 Input syntax For editing an entry in the bridge group:
ED-MIB-BRIDGE:tid:aid:ctag:::[STPPRIORITY=Domain] [,STPBRDGMAXAGE=Domain] [,STPBRDGHELLOTIME=Domain], [,STPBRDGFWDDELAY=Domain] [,TPAGINGTIME=Domain];
For editing the bridge spanning tree port table:

ED-MIB-BRIDGE:tid:aid:ctag:::STPPORT=Domain [,PRIORITY=Domain] [,PATHCOST=Domain] [,ENABLE=Domain];
For editing the static table in the bridge group:

ED-MIB-BRIDGE:tid:aid:ctag:::ADDR=Domain, RCVPORT=Domain [,ALLOWTOGOTO=Domain] [,STATUS=Domain]; Table 7-7 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 7-8 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-7 Table 7-9 Parameter descriptions Keyword Domain Description
Editing an entry in the bridge group STPPRIORITY 0 to 65535 Value of the writable portion of the bridge ID, namely the first two octets of the (eight octet long) bridge ID. Maximum age of spanning tree protocol information learned from the network on any port before it is discarded, in units of hundredths of a second. This is the actual value in the range of 600 to 4000 that this bridge is using. Network bridges use this value in the range of 100 to 1000 for hello time when this bridge is acting as the root. Network bridges use this value in the range of 400 to 3000 for forward delay when this bridge is acting as the root
STPBRDGMAXAGE
600 to 4000
STPBRDGHELLOTIME
100 to 1000
STPBRDGFWDDELAY
400 to 3000
TPAGINGTIME
10 to 1000000 Time-out period in seconds for aging out dynamically learned forwarding information. This is the actual value in the range of 10 to 1000000.
Editing the bridge spanning tree port table STPPORT 1 to 9 Port number of the port for which this entry contains the spanning tree protocol management information Value of the priority field which is contained in the first (in network byte order) octet of the Port ID. The other octet of the Port ID comes from the value of the DOT1DSTPPORT. STP port PATHCOST is the contribution of this port to the path cost of paths towards the spanning tree root, including this port. STP port ENABLE is an enumerated type where enabled(1) and disabled(2) describe the status of the port
continued
PRIORITY
0 to 255
PATHCOST
1 to 65535
ENABLE
ENABLE DISABLE
7-8 MIB detailed command descriptions Table 7-9 (continued) Parameter descriptions Keyword Domain Description
Editing the static table in the bridge group ADDR RCVPORT MAC Address Destination MAC address in a frame to which the filtering information of this entry applies 0 to 9 Either the value 0 to specify all ports, or the port number of the port from which a frame must be received for the filtering information of this entry to apply Set of ports to which frames received from a specific port and destined for a specific MAC address, are allowed to be forwarded
ALLOWTOGOTO
Bit string: 0000 to FF80 Hex
STATUS
An enumerated type where OTHER(1), OTHER INVALID(2), PERMANENT(3), INVALID PERMANENT DELeteONReSeT(4), and DELeteONTIMEout. DELONRST DELONTIME Example input
Edit the bridge MIB to change the stppriority:

ED-MIB-BRIDGE:SEATTLE:EIM-7-1:CTAG45:::STPPRIORITY=34;
Edit the bridge spanning tree port to change the spanning tree port to 1:
ED-MIB-BRIDGE:SEATTLE:EIM-7-1:CTAG45:::STPPORT=1;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-9
ED-MIB-IP
The Edit MIB IP command is used to edit the parameters of the IP group, the IP routing table, or the IP address translation table. Security level Level 3 Input syntax For editing the IP group:
ED-MIB-IP:[TID]:AID:CTAG:::DFLTTTL=Domain;
For editing the IP routing table:

ED-MIB-IP:[TID]:AID:CTAG:::DST=domain [,IDX=Domain] [,METRIC1=Domain] [,METRIC2=Domain] [,METRIC3=Domain] [,METRIC4=Domain] [,METRIC5=Domain] ,NHOP=Domain [,IPRT=Domain] [,IPROUTEAGE=Domain] [,MSK=Domain];
For editing the IP address translation table:

ED-MIB-IP:tid:aid:ctag:::IDX=domain, NETADDR=domain [,PHYSADDR=Domain] [,IPNETTOMEDIATYPE=Domain]; Table 7-10 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 7-11 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
7-10 MIB detailed command descriptions Table 7-12 Parameter descriptions Keyword DFLTTTL Domain 1 to 255 Parameter Default value inserted into the time-to-live field of the IP header of datagrams originated at this entity, whenever a TTL value is not supplied by the transport layer protocol Destination IP address of this route. An entry with a value of 0.0.0.0 is considered a default route. Unique value for each interface Primary routing metric for this route First alternate routing metric for this route Second alternate routing metric for this route Third alternate routing metric for this route Fourth alternate routing metric for this route IP address of the next hop of this route. (In the case of a route bound to an interface which is realized by means of a broadcast media, the value of this field is the IP address of the agent on that interface.) Enumerated type where OTH = none of the following, INVD = an invalid route, DIR(1) = route to directly connected network, and INDR(2) = route to a non-local host
DST IDX METRIC1 METRIC2 METRIC3 METRIC4 METRIC5 NHOP
x.x.x.x where x= 0 to 255 1 to 9 -1 to 32767 -1 to 32767 -1 to 32767 -1 to 32767 -1 to 32767 x.x.x.x where x= 0 to 255
IPRT
OTH INVD DIR INDR
Note: OTH and INVD are not supported in this release.

IPROUTEAGE MSK 0 to 4294967295 x.x.x.x where x= 0 to 255 x.x.x.x where x= 0 to 255 MAC address OTHER INVALID DYNAMIC STATIC Number of seconds since this route was last updated or determined to be correct Indicate the mask to be logical-ANDed with the destination address before being compared to the value in the IPROUTEDEST field IP address corresponding to the media-dependent physical address Media-dependent physical address Enumerated type where OTHER(1) = none of the following, INVALID(2) = an invalidated mapping, DYNAMIC(3), and STATIC(4)
NETADDR PHYSADDR IPNETTOMEDIATYPE
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-11 Example input
Edit the IP MIB to change the default TTL for EIM bridge facility 2 on the EIM circuit pack in slot 7:
ED-MIB-IP:SEATTLE:EIM-7-2:CTAG34:::DFLTTTL=34;
Edit the IP routing table to change the route index and the next hop parameters indexed by route destination 23.43.231.2 for EIM bridge facility 2 on the EIM circuit pack in slot 7:
ED-MIB-IP:SEATTLE:EIM-7-2:CTAG34:::DST=23.43.23.1.2, IDX=5, NHOP=42.42.213.22;
ED-MIB-SNMP
The Edit MIB SNMP command is used to edit the parameters of the SNMP group MIB. Security level Level 3 Input syntax
ED-MIB-SNMP:[TID]:AID:CTAG:::ENABLEAUTHENTRAPS=Domain; Table 7-13 Syntax definition Field TID AID CTAG ENABLEAUTHENTRAPS Table 7-14 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag SNMP enable authentication-failure traps (on or off)
Example input
Edit the SNMP MIB to generate authentication-failure traps for EIM bridge facility 2 on the EIM circuit pack in slot 7:
ED-MIB-SNMP:SEATTLE:EIM-7-2:CTAG34:::ENABLEAUTHENTRAPS=ON;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-MIB-SYSTEM
The Edit MIB System command is used to edit the parameters of a system group MIB. Security level Level 3 Input syntax
ED-MIB-SYSTEM:[TID]:AID:CTAG:::[CONTACT=Domain][,NAME=Domain] [,LOC=Domain]; Table 7-15 Syntax definition Field TID AID CTAG CONTACT NAME LOC Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag System contact. See Parameter descriptions table for details. System name. See Parameter descriptions table for details. System location. See Parameter descriptions table for details.
7-14 MIB detailed command descriptions Table 7-17 Parameter descriptions Parameter CONTACT Domain ASCII STRING ASCII STRING ASCII STRING Description Textual identification of the contact person for the managed node and the information required to contact this person (up to 50 characters) Assigned name for the managed node (up to 50 characters) Location of the node (up to 50 characters)
NAME LOC
Example input
Edit the system MIB to change the contact:

ED-MIB-SYSTERM:SEATTLE:EIM-7-1:CTAG34:::CONTACT=EBROWN;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-MIB-VIEW
The Edit MIB View command is used to edit the parameters in the MIB view. Security level Level 3 Input syntax
ED-MIB-VIEW:[TID]:AID:CTAG:::VIDX=Domain [,ENABLE=Domain] [,NAME=Domain] [,TRAP=Domain] [,IPADDR1=Domain] [,UDPPORT1=Domain] [,IPADDR2=Domain] [,UDPPORT2=Domain] [,IPADDR3=Domain] [,UDPPORT3=Domain] [,IPADDR4=Domain] [,UDPPORT4=Domain] [,IPADDR5=Domain] [,UDPPORT5=Domain] [,SYSCONTACT=Domain] [,SYSNAME=Domain] [,SYSLOCATION=Domain] [,STATICTABLE=Domain] [,STPPORTTABLE=Domain] [,DOT1DTPAGINGTIME=Domain] [,STPBRIDGEFORWARDDELAY=Domain] [,STPBRIDGEHELLOTIME=Domain] [,STPBRIDGEMAXAGE=Domain] [,DOT1DSTPPRIORITY=Domain] [,IPROUTETABLE=Domain] [,IPDEFAULTTTL=Domain] [,IPNETTOMEDIA=Domain] [,SNMPENABLEAUTHENTRAPS=Domain] ; Table 7-18 Syntax definition Field TID AID CTAG KEYWORD= Domain Table 7-19 AID descriptions AID type EIM AID Command-specific parameters EIM-slot#-bridge# Parameter values Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
7-16 MIB detailed command descriptions Table 7-20 Parameter descriptions Keyword VIDX ENABLE NAME TRAP IPADDR1 Domain 1 to 5 YES NO STRING ON OFF x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) Description Number indicating which of the five community views are being edited Flag that determines whether or not the community is valid String representing the community name as used in all SNMP PDUs Flag to indicate if SNMP traps will be generated for this community IP address for community member one
UDPPORT1 IPADDR2
User datagram protocol (UDP) port for community member one IP address for community member two
UDPPORT2 IPADDR3
UDP port for community member two IP address for community member three
UDPPORT3 IPADDR4
UDP port for community member three IP address for community member four
UDPPORT4 IPADDR5
UDP port for community member four IP address for community member five
UDPPORT5
UDP port for community member five
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-17 Table 7-20 (continued) Parameter descriptions Keyword SYSCONTACT Domain READ WRITE READ WRITE READ WRITE READ WRITE Description Indicates whether the CONTACT keyword in the system group is READ only or read and WRITE in the community view. Indicates whether the NAME keyword in the system group is READ only or read and WRITE in the community view. Indicates whether the LOC keyword in the system group is READ only or read and WRITE in the community view. Indicates whether the static table in the bridge group is READ only or read and WRITE in the community view. If it is read and WRITE then new entries can be added and any entry can be modified or deleted. Indicates whether the spanning tree port table is READ only or read and WRITE in the community view. If it is read and WRITE then any entry can be modified. Indicates whether the TPAGINGTIME keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPBRDGFWDDELAY keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPBRDGHELLOTIME keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPBRDGMAXAGE keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPPRIORITY keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the IP routing table is READ only or read and WRITE in the community view. If it is read and WRITE then new entries can be added and any entry can be modified or deleted.
continued
SYSNAME
SYSLOCATION
STATICTABLE
STPPORTTABLE
READ WRITE
DOT1DTPAGINGTIME
READ WRITE READ WRITE READ WRITE READ WRITE READ WRITE READ WRITE
STPBRIDGEFORWARDDELAY
STPBRIDGEHELLOTIME
STPBRIDGEMAXAGE
DOT1DSTPPRIORITY
IPROUTETABLE
7-18 MIB detailed command descriptions Table 7-20 (continued) Parameter descriptions Keyword IPDEFAULTTTL Domain READ WRITE READ WRITE Description Indicates whether the DFLTTTL keyword in the IP group is READ only or read and WRITE in the community view. Indicates whether the IP address translation table is READ only or read and WRITE in the community view. If it is read and WRITE then new entries can be added and any entry can be modified or deleted. Indicates whether the ENABLEAUTHENTRAPS keyword in the SNMP group is READ only or read and WRITE in the community view.
IPNETTOMEDIA
SNMPENABLEAUTHENTRAPS
READ WRITE
Note: You can dynamically assign the IP addresses and the UDP ports by leaving the domain field blank and entering the command string; for example,...UDPPORT1=, IPADDR1=, UDPPORT2=232, IPADDR2=47.123.111.123, ...
Example input
Edit the MIB view to enable community 2:

ED-MIB-VIEW:NEWYORK:EIM-7-1:CTAG23:::VIDX=2, ENABLE=YES, SYSCONTACT=WRITE;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ENT-MIB-BRIDGE
The Enter MIB Bridge command is used to add to the static table in the bridge group. Security level Level 3 Input syntax
ENT-MIB-BRIDGE:[TID]:AID:CTAG:::ADDR=Domain, RCVPORT=Domain, ALLOWTOGOTO=Domain, STATUS=Domain; Table 7-21 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 7-22 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
7-20 MIB detailed command descriptions Table 7-23 Parameter descriptions Keyword ADDR RCVPORT Domain Description
MAC Address Destination MAC address in a frame to which this entrys filtering information applies 0 to 9 Either the value 0, or the port number of the port from which a frame must be received for the filtering information of this entry to apply. Set of ports to which frames received from a specific port and destined for a specific MAC address, are allowed to be forwarded
ALLOWTOGOTO
Range= 0000 to FF80
STATUS
Enumerated type where OTHER(1), INVALID(2), OTHER PERMANENT(3), DELeteONReSeT(4), and INVALID PERMANENT DELeteONTIMEout DELONRST DELONTIME Example input
Add an entry indexed by dot1StaticAddress=123456789ABC and dot1dStaticReceivePort=1:

ENT-MIB-BRIDGE:SEATTLE:EIM-7-1:CTAG23:::ADDR=123456789ABC, RCVPORT=1, ALLOWTOGOTO=FF80, STATUS=DELONRST;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ENT-MIB-IP
The Enter MIB IP command is used to add an entry to the IP routing table or the IP address translation table. Security level Level 3 Input syntax For adding an entry to the IP routing table:
ENT-MIB-IP:[TID]:AID:CTAG:::DST=Domain, IDX=Domain, NHOP=Domain, IPRT=Domain, MSK=Domain;
For adding an entry to the IP address translation table:

ENT-MIB-IP:[TID]:AID:CTAG:::IDX=Domain, NETADDR=Domain, PHYSADDR=Domain, IPNETTOMEDIATYPE=Domain; Table 7-24 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 7-25 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#= 1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter descriptions table for details.
7-22 MIB detailed command descriptions Table 7-26 Parameter descriptions Keyword Domain Description
Adding an entry to the IP routing table DST IDX NHOP x.x.x.x where x= 0 to 255 1 to 9 x.x.x.x where x= 0 to 255 Destination IP address of this route. An entry with a value of 0.0.0.0 is considered a default route. Unique value for each interface IP address of the next hop of this route. (In the case of a route bound to an interface which is realized through a broadcast media, the value of this field is the IP address of the agent on that interface.) IP route type is an enumerated type where OTH = none of the following, INVD = an invalid route, DIR(1) = route to directly connected network, and INDR(2) = route to a non-local host
IPRT
OTH INVD DIR INDR
Note: OTH and INVD are not supported in this release.

MSK x.x.x.x where x= 0 to 255 Mask to be logical-ANDed with the destination address before being compared to the value in the IPROUTEDEST field
Adding an entry to the IP address translation table IDX NETADDR PHYSADDR IPNETTOMEDIATYPE 1 to 9 x.x.x.x where x= 0 to 255 MAC address INVALID DYNAMIC STATIC OTHER Unique value for each interface IP address corresponding to the media-dependent physical address Media-dependent physical address Enumerated type where INVALID(1) = an invalidated mapping, DYNAMIC(2), STATIC(3) and OTHER(4) = none of the following
Example input
Add an IP routing entry for 23.43.231.22:

ENT-MIB-IP:SEATTLE:EIM-7-1:CTAG23:::DST=23.43.231.22, IDX=9, NHOP=23.43.231.1, IPRT=DIR, MSK=255.0.0.0;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-MIB-BRIDGE
The Retrieve MIB bridge command is used to retrieve the bridge group, the bridge base (generic) group, the bridge spanning tree port table, the bridge transparent port table, and the static table in a bridge group. Security level Level 1 Input syntax For retrieving the bridge group:
RTRV-MIB-BRIDGE:[TID]:AID:CTAG;
For retrieving the bridge base (generic) group:

RTRV-MIB-BRIDGE:[TID]:AID:CTAG:::BASEPORT=Domain;
For retrieving the bridge spanning tree port table:

RTRV-MIB-BRIDGE:[TID]:AID:CTAG:::STPPORT=Domain;
For retrieving the bridge transparent port table:

RTRV-MIB-BRIDGE:[TID]:AID:CTAG:::TPPORT;
For retrieving the static table in a bridge group:

RTRV-MIB-BRIDGE:[TID]:AID:CTAG:::ADDR=Domain, RCVPORT=Domain;
7-24 MIB detailed command descriptions Table 7-27 Syntax definition Field TID AID CTAG BASEPORT STPPORT TPPORT ADDR RCVPORT Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag Port number of the port for which this entry contains bridge management information (1 to 9) Port number of the port for which this entry contains the spanning tree protocol management information (1 to 9) Port number of the port for which this entry contains transparent bridging management information (1 to 9) Destination MAC address in a frame to which this entrys filtering information applies Either the value 0, or the port number of the port from which a frame must be received for the filtering information of this entry to apply (0 to 9)
Example input
Retrieve the bridge base port table (table entry indexed by dot1dBasePort=7):
RTRV-MIB-BRIDGE:SEATTLE:EIM-7-1:CTAG19:::BASEPORT=7;
Retrieve the STP port table information indexed by dot1dStpPort=1:

RTRV-MIB-BRIDGE:SEATTLE:EIM-7-1:CTAG19:::STPPORT=1;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<KEYWORD=Domain> Table 7-29 Response block descriptions Keyword AID Retrieving the bridge group BASEBRDGADDR BASENUMPORTS BASETYPE MAC address 1 to 9 UNKNOWN TP SR SRT UNKNOWN DECLB100 IEEE8021D 1 to 4294967295 0 to 4294967295 MAC address used by this bridge Number of ports controlled by this bridging entity Type of bridging this bridge can perform where unknown (1), transparent-only (2), sourceroute-only (3), and srt (4) Version of the spanning tree protocol that is running where unknown (1), declb100 (2),and ieee8021d (3) Time since the last time a topology change was detected by the bridge entity Total number of topology changes detected by this bridge since the management entity was last reset or initialized Value of the writable portion of the bridge ID Bridge identifier of the root of the spanning tree as determined by the spanning tree protocol (STP) as executed by this node Cost of the path to the root as seen from this bridge Port number of the port that offers the lowest cost path from this bridge to the root bridge Maximum age of STP information learned from the network on any port before it is discarded Amount of time between the transmission of configuration bridge PDUs by this node on any port when it is the root of the spanning tree or trying to become so
continued
Domain
Description
EIM-slot#-bridge # EIM bridge facility for which the data is retrieved
STPPROTOSPEC
STPTIMESINTOPCHG STPTOPCHGS
STPPRIORITY STPDESIGNROOT
0 to 65535 STP bridge address 0 to 65535 0 to 65535 400 to 3000 400 to 3000
STPROOTCOST STPROOTPORT STPMAXAGE STPHELLOTIME
7-26 MIB detailed command descriptions Table 7-29 (continued) Response block descriptions Keyword STPHOLDTIME Domain 0 to 65535 Description Amount of time during which no more than two configuration bridge PDUs are transmitted by the node; measured in hundredths of a second Time value that controls how fast a port changes its spanning state when moving towards the forwarding state. Value that this bridge is currently using. Value that all bridges use for MaxAge when this bridge is acting as the root Value that all bridges use for HelloTime when this bridge is acting as the root Value that all bridges use for ForwardDelay when this bridge is acting as the root Total number of forwarding database entries that have been or would have been learned but have been discarded because of a lack of space to store them in the forwarding database Timeout period for aging out dynamically learned forwarding information
STPFWDDELAY
400 to 3000
STPBRDGMAXAGE STPBRDGHELLOTIME STPBRDGFWDDELAY TPLRNEDENTRYDISCDS
600 to 4000 100 to 1000 400 to 3000 0 to 4294967295
TPAGINGTIME
10 to 1000000
Retrieving the bridge base (generic) group BASEPORT IFIDX 1 to 9 1 to 9 Port number of the port that this entry contains bridge management information Value of the instance of the Index object, defined in MIB-II, for the interface corresponding to this port Number of frames discarded by this port because of excessive transit delay through the bridge Number of frames discarded by this port because of excessive size
DELAYEXCDDISCDS MTUEXCDDISCDS
0 to 4294967295 0 to 4294967295
Retrieving the spanning tree port table STPPORT PRIORITY 1 to 9 0 to 255 Port number of the port for which this entry contains STP management information Value of the priority field that is contained in the first (in network byte order) octet of the (two octet long) Port ID.
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-27 Table 7-29 (continued) Response block descriptions Keyword STATE Domain DISABLE BLOCKING LISTENING LEARNING FORWARDING BROKEN ENABLE DISABLE 1 to 65535 Description Current state of the port as defined by application of the STP, where disabled (1), blocking (2), listening (3), learning (4), forwarding (5), and broken (6)
ENABLE PATHCOST
Enabled or disabled status of the port, where enabled (1) and disabled (2) Contribution of this port to the path cost of paths towards the spanning tree root which includes this port Unique bridge identifier of the bridge recorded as the root in the configuration BPDUs transmitted by the designated bridge for the segment to which the port is attached Path cost of the designated port of the segment connected to this port Bridge identifier of the bridge that this port considers to be the designated bridge for the segment of this port Port identifier of the port on the designated bridge for the segment of this port Number of times this port has transitioned from the learning state to the forwarding state
DESIGNROOT
STP bridge address
DESIGNCOST DESIGNBRIDGE
1 to 65535 STP bridge address STP bridge suffix 0 to 4294967295
DESIGNPORT FWDTRANSITIONS
Retrieving the bridge transparent port table TPPORT 1 to 9 Port number of the port for which this entry contains transparent bridging management information Maximum size of the INFO field that this port receives or transmits Number of frames that have been received by this port from its segment Number of frames that have been transmitted by this port from its segment Count of valid frames received that were discarded by the forwarding process
MAXINFO INFRMS OUTFRMS INDISCDS
1 to 65535 0 to 4294967295 0 to 4294967295 0 to 4294967295
continued
7-28 MIB detailed command descriptions Table 7-29 (continued) Response block descriptions Keyword Domain Description
Retrieving the static table in a bridge group ADDR RCVPORT MAC address 0 to 9 Destination MAC address in a frame to which this entrys filtering information applies Either the value 0, or the port number of the port from which the frame must be received for the filtering information of this entry to apply Set of ports to which frames received from a specific port and destined for a specific MAC address are allowed to be forwarded Status of this entry, where other (1), invalid (2), permanent (3), delete on reset (4), and delete on timeout (5)
ALLOWTOGOTO
Octet string
STATUS
OTHER INVALID PERMANENT DELONRST DELONTIME
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-MIB-ICMP
The Retrieve MIB ICMP command is used to retrieve the group parameters of the Internet control message protocol (ICMP). Security level Level 1 Input syntax
RTRV-MIB-ICMP:[TID]:AID:CTAG;

Table 7-30 Syntax definition Field TID AID CTAG Table 7-31 AID descriptions AID type EIM Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag
Example input
Retrieve the ICMP MIB information for EIM bridge facility 1 for the EIM circuit pack in slot 7:
RTRV-MIB-ICMP:SEATTLE:EIM-7-1:CTAG19;

AID::<KEYWORD=Domain> Table 7-32 Response block descriptions Keyword AID INMSGS INERRS Domain EIM-slot#-bridge# 0 to 4294967295 0 to 4294967295 Description EIM bridge facility for which the data is retrieved Total number of ICMP messages that the entity received Number of ICMP messages that the entity received but determined as having ICMP-specific errors Number of ICMP destination unreachable messages received Number of ICMP time exceeded messages received Number of ICMP parameter problems messages received Number of ICMP source quench messages received Number of ICMP redirect messages received Number of ICMP echo request messages received Number of ICMP echo reply messages received Number of ICMP timestamp request messages received Number of ICMP timestamp reply messages received Number of ICMP address mask request messages received Number of ICMP address mask reply messages received Total number of ICMP messages that the entity attempted to send Number of ICMP messages that this entity did not send because of problems discovered within ICMP
INDESTUNREACHS INTIMEEXCDS INPARMPROBS INSRCQUENCHS INREDIRS INECHOS INECHOREPS INTIMESTAMPS INTIMESTAMPREPS INADDRMASKS INADDRMASKREPS OUTMSGS OUTERRS
0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-31 Table 7-32 (continued) Response block descriptions Keyword OUTDESTUNREACHS OUTTIMEEXCDS OUTPARMPROBS OUTSRCQUENCHS OUTREDIRS OUTECHOS OUTECHOREPS OUTTIMESTAMPS OUTTIMESTAMPREPS OUTADDRMASKS OUTADDRMASKREPS Domain 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 Description Number of ICMP destination unreachable messages sent Number of ICMP time exceeded messages sent Number of ICMP parameter problems messages sent Number of ICMP source quench messages sent Number of ICMP redirect messages received Number of ICMP echo request messages received.sent Number of ICMP echo reply messages sent Number of ICMP timestamp request messages sent Number of ICMP timestamp reply messages sent Number of ICMP address mask request messages sent Number of ICMP address mask reply messages sent
RTRV-MIB-IF
The Retrieve MIB interfaces command is used to retrieve the interfaces group and port table. Security level Level 1 Input syntax For retrieving the interfaces group:
RTRV-MIB-IF:[TID]:AID:CTAG;
For retrieving the interfaces port table:

RTRV-MIB-IF:[TID]:AID:CTAG:::IDX=Domain;

Table 7-33 Syntax definition Field TID AID CTAG IDX Table 7-34 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag Index. IDX is the unique value for each interface (1 to 9).
Example input
Retrieve the interface MIB information in interfaces table entry indexed by ifIndex=4:
RTRV-MIB-IF:WASHINGTON:EIM-7-1:CTAG12:::IDX=4;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<KEYWORD=Domain> Table 7-35 Response block descriptions Keyword AID Domain EIM-slot#-bridge# Description EIM bridge facility for which the data is retrieved
Retrieving the interfaces group NUMBER 9 Number of network interfaces present on the system
Retrieving the interfaces port table IDX DESCR IFTYPE MTU SPD PHYSADDR 1 to 9 STRING OTHER ETHERNET-CSMACD 1500 0 to 4294967295 MAC address Unique value for each interface Textual string containing information about the interface Enumerated type where other (1)none of the following, Ethernet-csmacd (2) Size of the largest datagram that can be sent or received on the interface, specified in octets Estimate of the current bandwidth of the interface in bits per second Address of the interface at the protocol layer immediately below the network layer in the protocol stack Enumerated type for the desired state of the interface where up (1), down (2), and testing (3) Enumerated type for the operational state of the interface where up (1), down (2), and testing (3) Value of sysUpTime at the time the interface entered its current operational state. If the current state was entered before the last reinitialization of the local network management subsystem, then this object contains a zero value Total number of octets received on the interface, including framing characters Number of subnetwork-unicast packets delivered to a higher layer protocol
continued
ADMINSTAT
UP DOWN TESTING UP DOWN TESTING 0 to 4294967295
OPERSTAT
LASTCHG
INOCTETS INUCASTPKTS
0 to 4294967295 0 to 4294967295
7-34 MIB detailed command descriptions Table 7-35 (continued) Response block descriptions Keyword INNUCASTPKTS INDISCDS Domain 0 to 4294967295 0 to 4294967295 Description Number of non-unicast packets delivered to a higher layer protocol Number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being delivered to a higher layer protocol Number of inbound packets that contained errors preventing them from being delivered to a higher layer protocol Number of packets received by way of the interface that were discarded because of an unknown or unsupported protocol Total number of octets transmitted out of the interface, including framing characters Total number of packets that higher level protocols requested be transmitted to a subnetwork-unicast address, including those that were discarded or not sent Total number of packets that higher level protocols requested be transmitted to a non-unicast address, including those that were discarded or not sent Number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted Number of outbound packets that could not be transmitted because of errors Length of the output packet queue in packets
INERR
0 to 4294967295
INUNKNWNPROTOS
0 to 4294967295
OUTOCTETS OUTUCASTPKTS
0 to 4294967295 0 to 4294967295
OUTNUCASTPKTS
0 to 4294967295
OUTDISCDS
0 to 4294967295
OUTERR OUTQLEN
0 to 4294967295 0 to 4294967295
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-MIB-IP
The Retrieve MIB IP command is used to retrieve the IP group, the IP address table, the IP routing table, the IP address translation table. Security level Level 1 Input syntax For retrieving the IP group:
RTRV-MIB-IP:[TID]:AID:CTAG;
For retrieving the IP address table:

RTRV-MIB-IP:[TID]:AID:CTAG:::ADDR=IPADDR;
For retrieving the IP routing table:

RTRV-MIB-IP:[TID]:AID:CTAG:::DST=Domain [,NHOP=Domain];
For retrieving the IP address translation table:

RTRV-MIB-IP:[TID]:AID:CTAG:::IDX=Domain, NETADDR=Domain;

Table 7-36 Syntax definition Field TID AID CTAG KEYWORD=Domain Table 7-37 AID descriptions AID type EIM Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM bridge facility to act on. Correlation tag See Parameter Descriptions table for details.
7-36 MIB detailed command descriptions Table 7-38 Parameter descriptions Parameter ADDR DST NHOP IDX NETADDR Domain Description
x.x.x.x where IP address x= 0 to 255 x.x.x.x where Destination IP address of the route. An entry with a x= 0 to 255 value of 0.0.0.0 is considered a default route. x.x.x.x where IP address of the next hop of this route x= 0 to 255 1 to 9 Unique value for each interface
x.x.x.x where IP address corresponding to the media-dependent x= 0 to 255 physical address
Example input
Retrieve the IP group information for EIM bridge facility 1 for the EIM circuit pack in slot 7:
RTRV-MIB-IP:SEATTLE:EIM-7-1:CTAG19;
Retrieve the IP address table for the IP address 42.124.34.34 for EIM bridge facility 2 for the EIM circuit pack in slot 7:
RTRV-MIB-IP:SEATTLE:EIM-7-2:CTAG19:::ADDR:42.124.34.34;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<KEYWORD=Domain> Table 7-39 Response block descriptions Keyword AID Retrieving IP group FWDING 1 or 2 Indication of whether this entity is acting as an IP gateway in respect to the forwarding of datagrams received by, but not addressed to, this entity. Enumerated type where forwarding (1) and not forwarding (2). Default value inserted in the time-to-live field of the IP header of datagrams originated at this entity whenever a TTL value is not supplied by the transport layer protocol Total number of input datagrams received from interfaces, including those received in error Number of input datagrams discarded because of errors in their IP headers Number of input datagrams discarded because the IP address in the destination field of the IP header was not a valid address to be received at this entity Number of input datagrams for which this entity was not their final IP destination, and as a result of which an attempt was made to find a route to forward them to the final destination Number of locally-addressed datagrams received successfully but discarded because of an unknown or unsupported protocol Number of input datagrams for which no problems were encountered to prevent their continued processing, but which were discarded Total number of input datagrams successfully delivered to IP user protocols Total number of IP datagrams that local IP user protocols supplied to IP in requests fro transmission
continued
Domain EIM-slot#-bridge#
Description EIM bridge facility for which the data is retrieved
DFLTTTL
1 to 255
INRCV INHDRERR INADDRERR
0 to 4294967295 0 to 4294967295 0 to 4294967295
FORWDATAGRAMS
0 to 4294967295
INUNKNWNPROTOS
0 to 4294967295
INDISCDS
0 to 4294967295
INDELIVERS OUTREQS
0 to 4294967295 0 to 4294967295
7-38 MIB detailed command descriptions Table 7-39 (continued) Response block descriptions Keyword OUTDISCDS Domain 0 to 4294967295 Description Number of output datagrams for which no problems were encountered to prevent their continued processing, but which were discarded Number of IP datagrams discarded because no route could be found to transmit them to their destination Maximum number of seconds that received fragments are held while they are awaiting reassembly at this entity Number of IP fragments received which needed to be reassembled at this entity Number of IP datagrams successfully reassembled Number of failures detected by the IP reassembly algorithm Number of IP datagrams that have been successfully fragmented at this entity Number of IP datagrams that have been discarded because they needed to be fragmented at this entity but could not be The number of IP datagram fragments that have been generated as a result of fragmentation at this entity Number of routing entries that were chosen to be discarded even though they are valid
OUTNOROUTES
0 to 4294967295
REASMTIMEOUT
1 to 255
REASMREQDS REASMOKS REASMFAILS FRAGOKS FRAGFAILS
0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295
FRAGCREATES
0 to 4294967295
ROUTINGDISCDS
0 to 4294967295
Retrieving the IP address table ADDR IDX NETMASK x.x.x.x where x= 0 to 255 1 to 9 x.x.x.x where x= 0 to 255 IP address to which the addressing information of this entry pertains Index value which uniquely identifies the interface to which this entry is applicable Subnet mask associated with the IP address of this entry
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-39 Table 7-39 (continued) Response block descriptions Keyword BCASTADDR Domain x.x.x.x where x= 0 to 255 Description Value of the least significant bit in the IP broadcast address used for sending datagrams on the logical interface associated with the IP address of this entry Size of the largest IP datagram that this entity can reassemble from incoming IP fragmented datagrams received on this interface
REASMMAXSIZE
0 to 65535
Retrieving IP routing table DST IDX x.x.x.x where x= 0 to 255 1 to 9 Destination IP address of this route Index value that uniquely identifies the local interface through which the next hop of this route should be reached Primary routing metric for this route Alternate routing metric for this route Alternate routing metric for this route Alternate routing metric for this route Alternate routing metric for this route IP address of the next hop of this route Type of route where other (1), invalid (2), direct (3), and indirect (4)
METRIC1 METRIC2 METRIC3 METRIC4 METRIC5 NHOP IPRT
-1 to 32767 -1 to 32767 -1 to 32767 -1 to 32767 -1 to 32767 x.x.x.x where x= 0 to 255 OTH INVD DIR INDR OTHER LOCAL NETMGMT ICMP 0 to 4294967295 x.x.x.x where x= 0 to 255
PROTO
Routing mechanism through which this route was learned where other (1), local (2), netmgmt (3), and icmp (4) Number of seconds since this route was last updated or otherwise determined to be correct Indicate the mask to be logical-ANDed with the destination address before being compared to the value in the ipRouteDest field.
continued
IPROUTEAGE MSK
7-40 MIB detailed command descriptions Table 7-39 (continued) Response block descriptions Keyword Domain Description
Retrieving IP address translation table IDX NETADDR PHYSADDR IPNETTOMEDIATYPE 1 to 9 x.x.x.x where x= 0 to 255 MAC address OTHER INVALID DYNAMIC STATIC Interface on which the equivalence of this entry is effective IP address corresponding to the media-dependent physical address Media-dependent physical address Enumerated type where other (1), invalid (2), dynamic (3), and static (2)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-MIB-LAN
The Retrieve MIB LAN command retrieves the LAN group MIB. Security level Level 1 Input syntax
RTRV-MIB-LAN:[TID]:AID:CTAG; Table 7-40 Syntax definition Field TID AID CTAG Table 7-41 AID descriptions AID type EIM Command-specific values EIM-slot#-bridge#Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag
Example input
Retrieve LAN MIB information:

RTRV-MIB-LAN:NEWYORK:EIM-7-1:CTAG46;

AID::<KEYWORD=Domain>; Table 7-42 Response block descriptions Keyword AID IDX ALIGNERR Domain EIM-slot#-bridge# 1 to 9 0 to 4294967295 Description EIM bridge facility for which the data is retrieved Index value that uniquely identifies an interface to an ethernet-like medium Count of frames received on a particular interface that are not an integral number of octets in length and do not pass the FCS check Count of frames received on a particular interface that are an integral number of octets in length and do not pass the FCS check Count of successfully transmitted frames on a particular interface for which transmission is inhibited by exactly one collision Count of successfully transmitted frames on a particular interface for which transmission is inhibited by more than one collision Count of times that the SQE test error message is generated by the PLS sublayer for a particular interface Count of frames for which the first transmission attempt on a particular interface is delayed because the medium is busy Number of times that a collision is detected on a particular interface later than 512 bit-times into the transmission of a packet Count of frames for which the transmission on a particular interface fails because of excessive collisions Count of frames for which the transmission on a particular interface fails because of an internal MAC sublayer transmit error
continued
FCSERR
0 to 4294967295
SINGLECOLLFR
0 to 4294967295
MULTICOLLFR
0 to 4294967295
SQETESTERR
0 to 4294967295
DEFERTRANS
0 to 4294967295
LATECOLL
0 to 4294967295
EXCESSCOLL
0 to 4294967295
INTERNALMACRXERR 0 to 4294967295
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-43 Table 7-42 (continued) Response block descriptions Keyword CARSENERR Domain 0 to 4294967295 Description Number of times that the carrier sense condition was lost or never asserted when attempting to transmit a frame on a particular interface Count of frames received on a particular interface that exceed the maximum permitted frame size Count of frames for which reception on a particular interface fails because of an internal MAC sublayer receive error
FRTOOLONGS
0 to 4294967295
INTERNALMACRXERR 0 to 4294967295
RTRV-MIB-SNMP
The Retrieve MIB SNMP command is used to retrieve the SNMP group. Security level Level 1 Input syntax
RTRV-MIB-SNMP:[TID]:AID:CTAG;

Table 7-43 Syntax definition Field TID AID CTAG Table 7-44 AID descriptions AID type EIM Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-45 Example input
Retrieve SNMP MIB information:

RTRV-MIB-SNMP:NEWYORK:EIM-7-1:CTAG29;

AID:<KEYWORD=Domain>; Table 7-45 Response block descriptions Keyword AID INPKTS OUTPKTS Domain EIM-slot#-bridge# 0 to 4294967295 0 to 4294967295 Description EIM bridge facility for which the data is retrieved Total number of messages delivered to the SNMP entity from the transport service. Total number of SNMP messages that were passed from the SNMP protocol entity to the transport service Total number of SNMP messages that were delivered to the SNMP protocol entity and were for an unsupported SNMP version Total number of SNMP messages that were delivered to the SNMP protocol entity which used an SNMP community name not known to the said entity Total number of SNMP messages that were delivered to the SNMP protocol entity which represented an SNMP operation that was not allowed by the SNMP community named in the message Total number of ASN.1 or BER errors encountered by the SNMP protocol entity when decoding received SNMP messages Total number of SNMP PDUs that were delivered to the SNMP protocol entity and for which the value of the error-status field is tooBig Total number of SNMP PDUs that were delivered to the SNMP protocol entity and for which the value of the error-status field is noSuchName Total number of SNMP PDUs that were delivered to the SNMP protocol entity and for which the value of the error-status field is badValue
INBADVER
0 to 4294967295
INBADCOMMUNAMES
0 to 4294967295
INBADCOMMUUSES
0 to 4294967295
INASNPARSEERRS
0 to 4294967295
INTOOBIGS
0 to 4294967295
INNOSUCHNAMES
0 to 4294967295
INBADVALUES
0 to 4294967295
continued
7-46 MIB detailed command descriptions Table 7-45 (continued) Response block descriptions Keyword INREADONLYS Domain 0 to 4294967295 Description Total number of SNMP PDUs that were delivered to the SNMP protocol entity and for which the value of the error-status field is readOnly Total number of SNMP PDUs that were delivered to the SNMP protocol entity and for which the value of the error-status field is genErr Total number of MIB objects that have been successfully retrieved by the SNMP protocol entity as the result of receiving valid SNMP Get request and Get next PDUs Total number of MIB objects that have been successfully altered by the SNMP protocol entity as the result of receiving valid SNMP Set request PDUs Total number of SNMP Get request PDUs that have been accepted and processed by the SNMP protocol entity Total number of SNMP Get next PDUs that have been accepted and processed by the SNMP protocol entity Total number of SNMP Set request PDUs that have been accepted and processed by the SNMP protocol entity Total number of SNMP Get response PDUs that have been accepted and processed by the SNMP protocol entity Total number of SNMP trap PDUs that have been accepted and processed by the SNMP protocol entity Total number of SNMP PDUs that were generated by the SNMP protocol entity and for which the value of the error-status field is tooBig Total number of SNMP PDUs that were generated by the SNMP protocol entity and for which the value of the error-status field is noSuchName
INGENEERS
0 to 4294967295
INTOTALREQVARS
0 to 4294967295
INTOTALSETVARS
0 to 4294967295
INGETREQS
0 to 4294967295
INGETNEXTS
0 to 4294967295
INSETREQS
0 to 4294967295
INGETRESPS
0 to 4294967295
INTRAPS
0 to 4294967295
OUTTOOBIGS
0 to 4294967295
OUTNOSUCHNAMES
0 to 4294967295
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-47 Table 7-45 (continued) Response block descriptions Keyword OUTBADVALS Domain 0 to 4294967295 Description Total number of SNMP PDUs that were generated by the SNMP protocol entity and for which the value of the error-status field is badValue Total number of SNMP PDUs that were generated by the SNMP protocol entity and for which the value of the error-status field is genErr Total number of SNMP Get request PDUs that have been generated by the SNMP protocol entity Total number of SNMP Get next PDUs that have been generated by the SNMP protocol entity Total number of SNMP Set request PDUs that have been generated by the SNMP protocol entity Total number of SNMP Get response PDUs that have been generated by the SNMP protocol entity Total number of SNMP Trap PDUs that have been generated by the SNMP protocol entity Indication of whether the SNMP agent process is permitted to generate authentication-failure traps where enabled (1) and disabled (2)
OUTGENERRS
0 to 4294967295
OUTGETREQS OUTGETNEXTS OUTSETREQS OUTGETRESPS OUTTRAPS ENABLEAUTHENTRAPS
0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 0 to 4294967295 ON OFF
RTRV-MIB-SYSTEM
The Retrieve MIB System command retrieves the system group MIB. Security level Level 1 Input syntax
RTRV-MIB-SYSTEM:[TID]:AID:CTAG;

Table 7-46 Syntax definition Field TID AID CTAG Table 7-47 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag
Example input
Retrieve system MIB information on bridge facility 1 of the EIM circuit pack in slot 7:
RTRV-MIB-SYSTEM:NEWYORK:EIM-7-1:CTAG29;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<UPTIME=Domain>,<CONTACT=Domain>,<NAME=Domain>, <LOC=Domain>,<SERV=Domain> Table 7-48 Response block descriptions Keyword AID UPTIME CONTACT Domain EIM-slot#-bridge# 1 to 4294967295 ASCII STRING Description EIM bridge facility for which the data is retrieved Time since the network management portion of the system was last reinitialized Textual identification of the contact person for the managed node and the information required to contact this person Assigned name for the managed node Location of the node Value that indicates the set of services that this entity primarily offers
NAME LOC SERV
ASCII STRING ASCII STRING 0 to 127
RTRV-MIB-UDP
The Retrieve MIB UDP command is used to retrieve the UDP group and the UDP port table group. Security level Level 1 Input syntax For retrieving the UDP group:
RTRV-MIB-UDP:[TID]:AID:CTAG;
For retrieving the UDP port table group:

RTRV-MIB-UDP:[TID]:AID:CTAG:::LOCALADDR=IPADDR;

Table 7-49 Syntax definition Field TID AID CTAG LOCALADDR Table 7-50 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag Local IP address for the UDP listener
Example input
Retrieve UDP port table MIB information indexed by udpLocalAddress=1.2.3.4:

RTRV-MIB-UDP:SEATTLE:EIM-7-1:CTAG19:::LOCALADDR=1.2.3.4;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Response block syntax For retrieving the UDP group:

AID::<INDATAGRAMS=Domain>,<NOPORTS=Domain>,<INERRS=Domain>, <OUTDATAGRAMS=Domain>
For retrieving the UDP port table group:

AID::<LOCALADDR=Domain>,<LOCALPORT1=Domain>, <LOCALPORT2=Domain>,<LOCALPORT3=Domain>,<LOCALPORT4=Domain>, <LOCALPORT5=Domain> Table 7-51 Response block descriptions Keyword AID INDATAGRAMS NOPORTS Domain EIM-slot#-bridge# 0 to 4294967295 0 to 4294967295 Description EIM bridge facility for which the data is retrieved Total number of UDP datagrams delivered to UDP users Total number of received UDP datagrams for which there was no application at the destination port Number of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port Total number of UDP datagrams sent from this entity Local IP address for this UDP listener Local port number for this UDP listener Local port number for this UDP listener Local port number for this UDP listener Local port number for this UDP listener Local port number for this UDP listener
INERRS
0 to 4294967295
OUTDATAGRAMS LOCALADDR LOCALPORT1 LOCALPORT2 LOCALPORT3 LOCALPORT4 LOCALPORT5
0 to 4294967295 x.x.x.x where x= 0 to 255 0 to 65535 or null (Note) 0 to 65535 or null (Note) 0 to 65535 or null (Note) 0 to 65535 or null (Note) 0 to 65535 or null (Note)
Note: This keyword may not have a return value following the =. For example, ...,LOCALPORT1=, LOCALPORT2=345, ...
RTRV-MIB-VIEW
The Retrieve MIB view command is used to retrieve the MIB view. Security level Level 1 Input syntax
RTRV-MIB-VIEW:[TID]:AID:CTAG;

Table 7-52 Syntax definition Field TID AID CTAG Table 7-53 AID descriptions AID type EIM AID Command-specific values EIM-slot#-bridge# Purpose Identify the EIM bridge facility where Express slot#= 4 to 10 Express CX slot#= 1 to 2 bridge#=1 to 2 Purpose Target identifier Access identifier. EIM entity to act on. Correlation tag
Example input
Retrieve the MIB view information for the EIM bridge facility 1 for the EIM circuit pack in slot 7:
RTRV-MIB-VIEW:SEATTLE:EIM-7-1:CTAG19;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

AID::<KEYWORD=Domain> Table 7-54 Response block descriptions Keyword AID VIDX Domain EIM-slot#-bridge# 1 to 5 Description EIM bridge facility for which the data is retrieved Number indicating which of the five community views are being edited, and so it is a mandatory parameter Flag that determines whether or not the community is valid String representing the community name as used in all SNMP PDUs Flag indicating if SNMP traps will be generated for this community IP address for community member one that SNMP managers use to access the variables on this bridge User Datagram Protocol (UDP) port for community member one that SNMP managers use to access the variables on this bridge IP address for community member two that SNMP managers use to access the variables on this bridge UDP port for community member two that SNMP managers use to access the variables on this bridge IP address for community member three that SNMP managers use to access the variables on this bridge UDP port for community member three that SNMP managers use to access the variables on this bridge IP address for community member four that SNMP managers use to access the variables on this bridge
ENABLE NAME TRAP IPADDR1
YES NO STRING ON OFF x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note)
UDPPORT1
IPADDR2
UDPPORT2
IPADDR3
UDPPORT3
IPADDR4
continued
7-54 MIB detailed command descriptions Table 7-54 (continued) Response block descriptions Keyword UDPPORT4 Domain 0 to 65535 or null (Note) x.x.x.x where x= 0 to 255 or null (Note) 0 to 65535 or null (Note) READ WRITE READ WRITE READ WRITE READ WRITE Description UDP port for community member four that SNMP managers use to access the variables on this bridge IP address for community member five that SNMP managers use to access the variables on this bridge UDP port for community member five that SNMP managers use to access the variables on this bridge Indicates whether the CONTACT keyword in the system group is READ only or read and WRITE in the community view. Indicates whether the NAME keyword in the system group is READ only or read and WRITE in the community view. Indicates whether the LOC keyword in the system group is READ only or read and WRITE in the community view. Indicates whether the static table in the bridge group is READ only or read and WRITE in the community view. If it is read and WRITE then new entries can be added and any entry can be modified or deleted. Indicates whether the spanning tree port table is READ only or read and WRITE in the community view. If it is read and WRITE then any entry can be modified. Indicates whether the TPAGINGTIME keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPBRDGFWDDELAY keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPBRDGHELLOTIME keyword in the bridge group is READ only or read and WRITE in the community view.
continued
IPADDR5
UDPPORT5
SYSCONTACT
SYSNAME
SYSLOCATION
STATICTABLE
STPPORTTABLE
READ WRITE
DOT1DTPAGINGTIME
READ WRITE READ WRITE
STPBRIDGEFORWARDDELAY
STPBRIDGEHELLOTIME
READ WRITE
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
MIB detailed command descriptions 7-55 Table 7-54 (continued) Response block descriptions Keyword STPBRIDGEMAXAGE Domain READ WRITE READ WRITE READ WRITE Description Indicates whether the STPBRDGMAXAGE keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the STPPRIORITY keyword in the bridge group is READ only or read and WRITE in the community view. Indicates whether the IP routing table is READ only or read and WRITE in the community view. If it is read and WRITE then new entries can be added and any entry can be modified or deleted. Indicates whether the DFLTTTL keyword in the IP group is READ only or read and WRITE in the community view. Indicates whether the ENABLEAUTHENTRAPS keyword in the SNMP group is READ only or read and WRITE in the community view Indicates whether the IP address translation table is READ only or read and WRITE in the community view. If it is read and WRITE then new entries can be added and any entry can be modified or deleted.
DOT1DSTPPRIORITY
IPROUTETABLE
IPDEFAULTTTL
READ WRITE READ WRITE
SNMPENABLEAUTHENTRAPS
IPNETTOMEDIA
READ WRITE
Note: This keyword may not have a return value following the =. For example, ..., UDPPORT1=, IPADDR1=, UDPPORT2=232, IPADDR2=47.123.111.123, ...
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
8-1
Cross-connect detailed command descriptions
8-
This chapter is an alphabetical summary of all the TL1 commands that add, delete or retrieve STS-1, STS-3c, and VT1.5 cross-connects. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all of the commands in this chapter.
Command DLT-CRS-STS1 DLT-CRS-STS3C DLT-CRS-VT1 ED-CRS-STS1 ED-CRS-STS3C ED-CRS-VT1 ENT-CRS-STS1 ENT-CRS-STS3C ENT-CRS-VT1 RTRV-CRS-STS1 RTRV-CRS-STS3C RTRV-CRS-VT1 Page 8-2 8-4 8-6 8-9 8-14 8-19 8-26 8-28 8-30 8-33 8-37 8-40
8-2 Cross-connect detailed command descriptions
DLT-CRS-STS1
The Delete Cross-connect STS1 command is used to delete an STS-1 cross-connect from between two STS-1 facilities. Security level Level 3 Input syntax
DLT-CRS-STS1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-1 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Path protection for the FromAID OC-3 interface only when the CCT is protected. That is, when the CCT is one of 1WAYPR, 2WAYPR, or 2WAYBR.
ToAID
CTAG CCT SWMATE
Table 8-2 AID descriptions AID type Command-specific parameters Parameter values Express slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, or 9 slot# = 3, 5, 7, or 9 Express CX slot# = 3 to 4 sts# = 1 to 3 slot# = 1 slot# = 1
STS-1 OC3-slot#-sts# Facility AID DS3-slot# EC1-slot#
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-3 Table 8-3 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Description Unidirectional connection Bidirectional connection (default) Unidirectional path ring connection Bidirectional path ring connection Bidirectional bridge ring connection
AID, CCT, and SWMATE usage Figure 8-1 on page 8-44 shows valid combinations of AID, CCT, and SWMATE along with the resulting facility connections.
Example input
For the NEWYORK network element, delete the bidirectional STS-1 passthrough cross-connection between the OC-3 interfaces in slots 11 and 12:
DLT-CRS-STS1:NEWYORK:OC3-11-1,OC3-12-1:CTAG12::2WAY;
For the SEATTLE network element, delete the bidirectional STS-1 connection between the DS3 facility in slot 9 and the path protected OC-3 interfaces in slots 11 and 12:
DLT-CRS-STS1:SEATTLE: OC3-11-1,DS3-9:CTAG12::2WAYPR:SWMATE=OC3-12-1;
DLT-CRS-STS3C
The Delete Cross-connect STS-3c command deletes an STS-3c cross-connect. Security level Level 3 Input syntax
DLT-CRS-STS3C:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-4 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type The path protection for the FromAID OC-3 interface only when the CCT is protected. That is, when the CCT is one of 1WAYPR or 2WAYPR.
ToAID
CTAG CCT SWMATE
Table 8-5 AID descriptions AID type Command-specific values Purpose Identify the OC-3 facility where slot# = 3 to 12
OC-3 OC3-slot# Facility AID
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-5 Table 8-6 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR Description Unidirectional connection Bidirectional connection (default) Unidirectional path ring connection Bidirectional path ring connection
Example input
For the NEWYORK network element, delete the bidirectional STS-3c passthrough cross-connection between the OC-3 interfaces in slots 11 and 12:
DLT-CRS-STS3C:NEWYORK:OC3-11,OC3-12:CTAG12::2WAY;
DLT-CRS-VT1
The Delete Cross-connect VT1.5 command is used to delete a VT1.5 cross-connect from between two VT1.5 facilities. Security level Level 3 Input syntax
DLT-CRS-VT1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-7 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Identifies the path protection for the FromAID OC-3 interface only when the CCT is protected. That is, when the CCT is one of 1WAYPR, 2WAYPR, or 2WAYBR.
ToAID
CTAG CCT SWMATE
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-7 Table 8-8 AID descriptions AID type Command-specific parameters DS1-slot#-port# Parameter values Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1 port# = 1 to 12 slot# = 3 port# = 1 to 8 OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5 , 7, or 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 7 to 10 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 grp# = 1 to 3 slot# = 3 to 4 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 or 2 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 Not applicable
VT1.5 facility AID
EC1-slot#-sts#-vtg#-vt# EC1-slot#-sts#-ALL
EIM-slot#-bridge#-vp#-t1#
SMART AID
DS1-DFLT-grp#
For an OC-3 Express network element, use the DFLT-# smart AID to delete one of three sets of 28 DS1s cross-connected to VT1.5s within an STS-1. For each possible DFLT-# value, a specific set of 28 ports is cross-connected to an STS-1. For example, the DFLT-2 set of DS1 ports can be mapped to STS1-3. This causes DS1 ports 29 through 56 to be cross-connected to STS1-3. Table 8-9 shows the DFLT-# smart AID value and the corresponding ports.
Table 8-9 DFLT-# smart AID values DFLT-# 1 2 3 Ports 1-28 29-56 57-84 Equivalent facilities DS1-4-1 DS1-6-4 DS1-6-5 DS1-8-8 DS1-8-9 DS1-10-12
8-8 Cross-connect detailed command descriptions Table 8-10 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Description Unidirectional connection Bidirectional connection (default) Unidirectional path ring connection Bidirectional path ring connection Bidirectional bridge ring connection
Example input
For the NEWYORK network element, delete a VT1.5 bidirectional cross-connect between the DS1 mapper in slot 4 and the path protected optical interfaces in slots 11 and 12:
DLT-CRS-VT1:NEWYORK: OC3-11-2-1-1,DS1-4-1:CTAG45:: 2WAYPR:SWMATE=OC3-12-2-1-1;
For the WASHINGTON network element, delete 28 bidirectional VT1.5 cross-connects between the DFLT-1 VT1.5 facilities (DS1 ports 1 to 12 on the slot 4 DS1 mapper, DS1 ports 1 to 12 on the slot 5 DS1 mapper and DS1 ports 1 to 4 on the slot 6 DS1 mapper), from the path protected optical interfaces in slots 9 and 11:
DLT-CRS-VT1:WASHINGTON: OC3-9-3-ALL,DS1-DFLT-1:CTAG89:: 2WAYPR:SWMATE=OC3-11-3-ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-9
ED-CRS-STS1
The Edit Cross-connect STS-1 command is used to edit the cross-connect type (CCT) of an existing STS-1 cross-connect. Security level Level 3 Input syntax
ED-CRS-STS1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-11 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Switchmate identifies the path protection for the FromAID OC-3 interface when the CCT is path protected. That is, when the CCT is one of 1WAYPR, 2WAYPR, or 2WAYBR.
ToAID
CTAG CCT SWMATE
Table 8-12 AID descriptions AID type Command-specific Parameter values parameters Express slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, or 9 slot# = 3, 5, 7, or 9
Express CX slot# = 3 to 4 sts# = 1 to 3 slot# = 1 slot# = 1
When the cross-connect type is protected (1WAYPR, 2WAYPR, or 2WAYBR), the FromAID and SWMATE facilities can be reversed so that the FromAID becomes the SWMATE and the SWMATE becomes the FromAID. See ToAID = ALL on page 8-12 for more information on the ALL ToAID.
8-10 Cross-connect detailed command descriptions Table 8-13 STS-1 CCT descriptions CCT 2WAY Description Converts two existing 1WAY cross-connects to a 2WAY cross-connect. CCTs before and after CCT edit
FromAID DS3 EC-1 OC-3 FromAID DS3 EC-1 OC-3
DS3 EC-1 OC-3 ToAID Before edit: two 1WAY connections FromAID OC-3 SWMATE OC-3
DS3 EC-1 OC-3 ToAID After edit: one 2WAY connection FromAID OC-3 SWMATE OC-3
*Converts an existing 2WAYPR cross-connect to a 2WAY cross-connect.
DS3 EC-1 OC-3 ToAID Before edit: one 2WAYPR connection
DS3 EC-1 OC-3 ToAID After edit: one 2WAYconnection
1 WAY
Converts an existing 2WAY cross-connect to two 1WAY cross-connects.
FromAID DS3 EC-1 OC-3
DS3 EC-1 OC-3 ToAID Before edit: one 2WAY connections
DS3 EC-1 OC-3 ToAID After edit: two 1WAY connections
OC-3 FromAID
OC-3 SWMATE
OC-3 FromAID
OC-3 SWMATE
DS3 EC-1 OC-3 ToAID After edit: one 1WAY connection
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-11 CCT Description CCTs before and after CCT edit
FromAID OC-3 FromAID OC-3 SWMATE OC-3
1WAYPR *Converts an existing 1WAY cross-connect to a 1WAYPR cross-connect.
SWMATE OC-3
DS3 EC-1 OC-3 ToAID Before edit: one 1WAY connection
DS3 EC-1 OC-3 ToAID After edit: one 1WAYPR connections FromAID OC-3 SWMATE OC-3
*Converts an existing 2WAYPR cross-connect to a 1WAYPR and two 1way cross-connects.
FromAID OC-3
SWMATE OC-3
DS3 EC-1 OC-3 ToAID After edit: one 1WAYPR and two 1WAYconnections
FromAID OC-3
SWMATE OC-3
FromAID OC-3
SWMATE OC-3
*Converts an existing 1WAYPR cross-connect to a 2WAYPR cross-connect if 1WAY cross-connects already exist.
FromAID OC-3
SWMATE OC-3
DS3 EC-1 OC-3 ToAID After edit: one 1WAYPR connections
*For OC-3 Express, this CCT is valid only for NEs equipped with an SPe shelf processor.
ToAID = ALL The ED-CRS-STS1 command exchanges the FromAID and SWMATE facilities for existing path protected (1WAYPR, 2WAYPR and 2WAYBR) cross-connects when ALL is entered for the ToAID parameter. That is, the FromAID becomes the SWMATE, and the SWMATE becomes the FromAID. The ED-CRS-STS1 syntax (when ToAID = ALL) is
ED-CRS-STS1:[TID]:FromAID,ALL:CTAG:::SWMATE=<AID>;
where FromAID identifies the OC-3 facility which is currently the SWMATE AID. This facility will be the new FromAID after the command executes. The SWMATE AID identifies the OC-3 facility which is currently the FromAID. This facility will be the new SWMATE AID after the command executes. Note: This command affects (reverses the FromAID and SWMATE AID) for all path-protected connections with the same FromAID and SWMATE AID. See Example 3 on page 8-13 for more information on the ALL ToAID parameter value. Example 1
Task
For the NEWYORK network element, edit (convert) an existing STS-1 1WAY cross-connect to a 2WAY cross-connect. The existing cross-connect has the following characteristics: FromAID = slot 7 DS3 mapper ToAID = slot 11 OC-3 interface, STS1 = #3
Solution
The ED-CRS-STS1 command requires two 1WAY cross-connects to be in place before a 1WAY to 2WAY edit. Consequently, a second 1WAY cross-connect must be entered with the following command before the ED-CRS-STS1 command can be issued:
ENT-CRS-STS1:NEWYORK:OC3-11-3,DS3-7:CTAG12::1WAY;
Now that the complementary 1WAY cross-connect exists, the two cross-connects can be converted into an single 2WAY cross-connect with the following command:
ED-CRS-STS1:NEWYORK:OC3-11-3,DS3-7:CTAG12::2WAY;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Example 2
Task
For the SEATTLE network element, edit an existing STS-1 2WAY cross-connect to a 2WAYPR cross-connect. The existing cross-connect has the following characteristics: FromAID = slot 5 DS3 mapper ToAID = slot 11 OC-3 interface, STS1 = #2 The switchmate for the resulting 2WAYPR cross-connect is to be STS1-#2 on the slot 12 optical interface.
Solution
The following command will edit the existing cross-connect as required:

ED-CRS-STS1:SEATTLE: OC3-11-2,DS3-5:CTAG12::2WAYPR:SWMATE=OC3-12-2;
Example 3
Task
For the SEATTLE network element, reverse the FromAid and SWMATE AID for all path-protected STS-1 cross-connects where FromAID = slot 11 OC-3 interface, STS1 = #1 SWMATE AID = slot 12 OC-3 interface, STS1 = #1
Solution
Before issuing the command to reverse the FromAid and SWMATE, the RTRV-CRS-STS1 can be used to retrieve all provisioned STS-1 connections for the SEATTLE network element:
RTRV-CRS-STS1:SEATTLE:ALL:CTAG34;
For this network element at this point in time, the TL1 system responds with:
OC3-11-1,DS3-7:2WAYPR:SWMATE=OC3-12-1: OC3-11-1,OC3-5-1:1WAYPR,FFP:SWMATE=OC3-12-1: OC3-11-1,OC3-5-2:1WAY,FFP::
The following command reverses the existing cross-connects:

ED-CRS-STS1:SEATTLE:OC3-12-1,ALL:CTAG22:::SWMATE=OC3-11-1;
If cross-connects are retrieved (after the ED-CRS-STS1 executes) as follows:

RTRV-CRS-STS1:SEATTLE:ALL:CTAG34;
The TL1 system responds with:

OC3-12-1,DS3-7:2WAYPR:SWMATE=OC3-11-1: OC3-12-1,OC3-5-1:1WAYPR,FFP:SWMATE=OC3-11-1: OC3-11-1,OC3-5-2:1WAY,FFP::
ED-CRS-STS3C
The Edit Cross-connect STS-3c command is used to edit the cross-connect type (CCT) of an existing STS-3c cross-connect. Security level Level 3 Input syntax
ED-CRS-STS3C:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-14 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Switchmate identifies the path protection for the FromAID OC-3 interface when the CCT is path protected. That is, when the CCT is one of 1WAYPR or 2WAYPR.
ToAID
CTAG CCT SWMATE
Table 8-15 AID descriptions AID type Command-specific Parameter values parameters slot# = 3 to 12 Purpose Identify one STS-3c facility
STS-3c OC3-slot# Facility AID
When the cross-connect type is protected (1WAYPR or 2WAYPR), the FromAID and SWMATE facilities can be reversed so that the FromAID becomes the SWMATE and the SWMATE becomes the FromAID. See ToAID = ALL on page 8-17 for more information on the ALL ToAID.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-15 Table 8-16 STS-3c CCT descriptions CCT 2WAY Description Converts two existing 1WAY cross-connects to a 2WAY cross-connect. CCTs before and after CCT edit
FromAID OC-3 FromAID OC-3
OC-3 ToAID
OC-3 ToAID After edit: one 2WAY connection FromAID OC-3 SWMATE OC-3
Before edit: two 1WAY connections FromAID OC-3 SWMATE OC-3
OC-3 ToAID Before edit: one 2WAYPR connection
OC-3 ToAID After edit: one 2WAYconnection
1 WAY
FromAID OC-3
FromAID OC-3
OC-3 ToAID Before edit: one 2WAY connections
OC-3 ToAID After edit: two 1WAY connections
OC-3 FromAID
OC-3 SWMATE
OC-3 FromAID
OC-3 SWMATE
OC-3 ToAID After edit: one 1WAY connection
continued
8-16 Cross-connect detailed command descriptions CCT Description CCTs before and after CCT edit
SWMATE OC-3
OC-3 ToAID Before edit: one 1WAY connection
OC-3 ToAID After edit: one 1WAYPR connections FromAID OC-3 SWMATE OC-3
FromAID OC-3
SWMATE OC-3
OC-3 ToAID After edit: one 1WAYPR and two 1WAYconnections
FromAID OC-3
SWMATE OC-3
FromAID OC-3
SWMATE OC-3
OC-3 ToAID After edit: one 1WAYPR connections FromAID OC-3 SWMATE OC-3
FromAID OC-3
SWMATE OC-3
OC-3 ToAID After edit: one 1WAYPR connections
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ToAID = ALL The ED-CRS-STS1 command exchanges the FromAID and SWMATE facilities for existing path protected (1WAYPR and 2WAYPR) cross-connects when ALL is entered for the ToAID parameter. That is, the FromAID becomes the SWMATE, and the SWMATE becomes the From AID. The ED-CRS-STS1 syntax (when ToAID = ALL) is
ED-CRS-STS3C:[TID]:FromAID,ALL:CTAG:::SWMATE=<AID>;
where FromAID identifies the OC-3 facility which is currently the SWMATE AID. This facility will be the new FromAID after the command executes. The SWMATE AID identifies the OC-3 facility which is currently the FromAID. This facility will be the new SWMATE AID after the command executes. Note: This command affects (reverses the FromAID and SWMATE AID) for all path-protected connections with the same FromAID and SWMATE AID. Example 1
Task
For the NEWYORK network element, edit (convert) an existing STS-3c 1WAY cross-connect to a 2WAY cross-connect. The existing cross-connect has the following characteristics: FromAID = slot 7 OC-3 interface ToAID = slot 11 OC-3 interface
Solution
The ED-CRS-STS3C command requires two 1WAY cross-connects to be in place before a 1WAY to 2WAY edit. Consequently, a second 1WAY cross-connect must be entered with the following command before the ED-CRS-STS1 command can be issued:
ENT-CRS-STS3C:NEWYORK:OC3-11,OC3-7:CTAG12::1WAY;
ED-CRS-STS3C:NEWYORK:OC3-11,OC3-7:CTAG12::2WAY;
Example 2
Task
For the SEATTLE network element, edit an existing STS-3c 2WAY cross-connect to a 2WAYPR cross-connect. The existing cross-connect has the following characteristics: FromAID = slot 5 OC-3 mapper ToAID = slot 11 OC-3 interface The switchmate for the resulting 2WAYPR cross-connect is to be the slot 12 optical interface.
Solution

ED-CRS-STS3C:SEATTLE: OC3-11,OC3-5:CTAG12::2WAYPR:SWMATE=OC3-12;
Example 3
Task
For the SEATTLE network element, reverse the FromAid and SWMATE AID for all path-protected STS-3c cross-connects where FromAID = slot 11 OC-3 interface SWMATE AID = slot 12 OC-3 interface
Solution
Before issuing the command to reverse the FromAid and SWMATE, the RTRV-CRS-STS1 can be used to retrieve all provisioned STS-3c connections for the SEATTLE network element:
RTRV-CRS-STS3C:SEATTLE:ALL:CTAG34;
For this network element at this point in time, the TL1 system responds with:
OC3-11,OC3-5:1WAYPR,FFP:SWMATE=OC3-12: OC3-11,OC3-5:1WAY,FFP::
The following command reverses the existing cross-connects:

ED-CRS-STS3C:SEATTLE:OC3-12,ALL:CTAG22:::SWMATE=OC3-11;
If cross-connects are retrieved (after the ED-CRS-STS3C executes) as follows:

RTRV-CRS-STS3C:SEATTLE:ALL:CTAG34;

OC3-12,OC3-5:1WAYPR,FFP:SWMATE=OC3-11: OC3-11,OC3-5:1WAY,FFP::
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-CRS-VT1
The Edit Cross-connect VT1.5 command is used to edit the cross-connect type (CCT) of an existing VT1.5 cross-connect. Security level Level 3 Input syntax
ED-CRS-VT1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-17 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Switchmate identifies the path protection for the FromAID OC-3 interface when the CCT is path protected. That is, when the CCT is one of 1WAYPR, 2WAYPR, or 2WAYBR.
ToAID
CTAG CCT SWMATE
8-20 Cross-connect detailed command descriptions Table 8-18 AID descriptions AID type Command-specific parameters Parameter values Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1 port# = 1 to 12 slot# = 3 port# = 1 to 8 OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, or 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 7 to 10 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 grp# = 1 to 3 slot# = 1 to 4 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 or 2 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 Not applicable
VT1.5 DS1-slot#-port# facility AID
SMART AID
DS1-DFLT-grp#
When the cross-connect type is protected (1WAYPR, 2WAYPR, or 2WAYBR) the FromAID and SWMATE facilities can be reversed so that the FromAID becomes the SWMATE and the SWMATE becomes the From AID. See ToAID = ALL on page 8-23 for more information on the ALL ToAID.
For an OC-3 Express network element, use the DFLT-# smart AID to edit the CCT for one of three sets of 28 DS1s to VT1.5s within an STS-1. For each possible DFLT-# value, a specific set of 28 ports is cross-connected to an STS-1. Table 8-19 shows the DFLT-# smart AID value and the corresponding ports.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-21 Table 8-20 VT1.5 CCT descriptions CCT 2WAY Description Converts two existing 1WAY cross-connects to a 2WAY cross-connect. CCTs before and after CCT edit
FromAID DS1 EC-1 OC-3 FromAID DS1 EC-1 OC-3
DS1 EC-1 OC-3 ToAID Before edit: two 1WAY connections FromAID OC-3 SWMATE OC-3
DS1 EC-1 OC-3 ToAID After edit: one 2WAY connection FromAID OC-3 SWMATE OC-3
DS1 EC-1 OC-3 ToAID After edit: one 2WAYconnection
1 WAY
DS1 EC-1 OC-3 ToAID Before edit: one 2WAY connections
DS1 EC-1 OC-3 ToAID After edit: two 1WAY connections
OC-3 FromAID
OC-3 SWMATE
OC-3 FromAID
OC-3 SWMATE
DS1 EC-1 OC-3 ToAID After edit: one 1WAY connection
continued
8-22 Cross-connect detailed command descriptions CCT Description CCTs before and after CCT edit
SWMATE OC-3
FromAID OC-3
SWMATE OC-3
DS1 EC-1 OC-3 ToAID After edit: one 1WAYPR and two 1WAYconnections
FromAID OC-3
SWMATE OC-3
FromAID OC-3
SWMATE OC-3
FromAID OC-3
SWMATE OC-3
DS1 EC-1 OC-3 ToAID After edit: one 1WAYPR connections
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ToAID = ALL The ED-CRS-VT1 command exchanges the FromAID and SWMATE facilities for existing path protected (1WAYPR, 2WAYPR, or 2WAYBR) cross-connects when ALL is entered for the ToAID parameter. That is, the FromAID becomes the SWMATE, and the SWMATE becomes the FromAID. The ED-CRS-VT1 syntax (when the ToAID = ALL) is
ED-CRS-VT1:[TID]:FromAID,ALL:CTAG:::SWMATE=<AID>;
where FromAID identifies the OC-3 facility which is currently the SWMATE AID. This facility will be the new FromAID after the command executes. The SWMATE AID identifies the OC-3 facility which is currently the FromAID. This facility will be the new SWMATE AID after the command executes. Note: This command affects (reverses the FromAID and SWMATE AID) for all path-protected connections with the same FromAID and SWMATE AID. See Example 3 on page 8-24 for more information on the ALL ToAID parameter value. Example 1
Task
For the NEWYORK network element, edit (convert) an existing VT1.5 1WAY cross-connect to a 2WAY cross-connect. The existing cross-connect has the following characteristics: FromAID = slot 7 DS1 mapper, port 2 ToAID = slot 11 OC-3 interface, STS1 = #3, VTG = 4, VT =1
Solution
The ED-CRS-VT1 command requires two 1WAY cross-connects to be in place before a 1WAY to 2WAY edit. Consequently, a second 1WAY cross-connect must be entered with the following command before the ED-CRS-VT1 command can be issued:
ENT-CRS-VT1:NEWYORK:OC3-11-3-4-1,DS1-7-2:CTAG12::1WAY;
ED-CRS-VT1:NEWYORK:OC3-11-3-4-1,DS1-7-2:CTAG12::2WAY;
Example 2
Task
For the SEATTLE network element, edit an existing VT1 2WAY cross-connect to a 2WAYPR cross-connect. The existing cross-connect has the following characteristics: STS-1 = #2 FromAID = slot 5 DS1 mapper, port 12 ToAID = slot 11 OC-3 interface, STS1 = #2, VTG = 4, VT = 3 The required switchmate for the resulting 2WAYPR cross-connect is the slot 12 optical interface.
Solution

ED-CRS-VT1:SEATTLE: OC3-11-2-4-3,DS1-5-12:CTAG12::2WAYPR:SWMATE=OC3-12-2-4-3;
Example 3
Task
For the SEATTLE network element, reverse the FromAid and SWMATE AID for all path-protected VT1.5 cross-connects, where FromAID = slot 11 OC-3 interface, STS1 = #1, VTG = 2, VT =3 SWMATE AID = slot 12 OC-3 interface, STS1 = #1, VTG = 2, VT =3
Solution
Before issuing the command to reverse the FromAid and SWMATE, the RTRV-CRS-VT1 command can retrieve all provisioned connections for the SEATTLE network element:
RTRV-CRS-VT1:SEATTLE:ALL:CTAG34;

OC3-11-1-2-3,DS1-7-3:2WAYPR:SWMATE=OC3-12-12-3: OC3-11-1-2-3,OC3-5-1-2-3:1WAYPR,FFP:SWMATE=OC3-12-1-2-3: OC3-11-1-2-3,OC3-5-2-3-3:1WAY,FFP::
The following command reverses the FromAID and SWMATE AID of the existing cross-connect:
ED-CRS-V1:SEATTLE: OC3-12-1-2-3,ALL:CTAG:::SWMATE=OC3-11-1-2-3;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
If cross-connects are retrieved (after the ED-CRS-STS1 command executes) as follows:

RTRV-CRS-VT1:SEATTLE:ALL:CTAG34;

OC3-12-1-2-3,DS3-7:2WAYPR:SWMATE=OC3-11-1-2-3: OC3-12-1-2-3,OC3-5-1-2-3:1WAYPR,FFP:SWMATE=OC3-11-1-2-3: OC3-11-1,OC3-5-2-3-3:1WAY,FFP::
ENT-CRS-STS1
The Enter Cross-connect STS-1 command is used to add an STS-1 connection between two STS-1 facilities. Security level Level 3 Input syntax
ENT-CRS-STS1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-21 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag cross-connection type Identifies the path protection for the FromAID OC-3 interface only when the CCT is protected. That is, when the CCT is one of 1WAYPR, 2WAYPR, or 2WAYBR.
ToAID
CTAG CCT SWMATE
Table 8-22 AID descriptions AID type Command-specific Parameter values parameters Express slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, or 9 slot# = 3, 5, 7, or 9
Express CX slot# = 3 to 4 sts# = 1 to 3 slot# = 1 slot# = 1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-27 Table 8-23 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Description Unidirectional connection Bidirectional connection (default) Unidirectional path ring connection Bidirectional path ring connection Bidirectional bridge ring connection
Example input
For the NEWYORK network element, add a bidirectional STS-1 passthrough cross-connection between the OC-3 interfaces in slots 11 and 12:
ENT-CRS-STS1:NEWYORK:OC3-11-1,OC3-12-1:CTAG12::2WAY;
For the SEATTLE network element, add a bidirectional STS-1 connection between the DS3 facility in slot 9 and the path protected OC-3 interfaces in slots 11 and 12:
ENT-CRS-STS1:SEATTLE: OC3-11-1,DS3-9:CTAG12::2WAYPR:SWMATE=OC3-12-1;
ENT-CRS-STS3C
The Enter Cross-connect STS-3c command is used to add an STS-3c connection between two OC-3 interface facilities. Security level Level 3 Input syntax
ENT-CRS-STS3C:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-24 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Identifies the path protection for the FromAID OC-3 interface only when the CCT is protected. That is, when the CCT is one of 1WAYPR or 2WAYPR.
ToAID
CTAG CCT SWMATE
Table 8-25 AID descriptions AID type Command-specific parameters Parameter values Identify the OC-3 where slot# = 3 to 12
OC-3C OC3-slot# Facility AID
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-29 Table 8-26 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR Description Unidirectional connection Bidirectional connection (default) Unidirectional path ring connection Bidirectional path ring connection
Example input
For the NEWYORK network element, add a bidirectional STS-3c passthrough cross-connection between the OC-3 interfaces in slots 11 and 12:
ENT-CRS-STS3C:NEWYORK:OC3-11,OC3-12:CTAG12::2WAY;
ENT-CRS-VT1
The Enter Cross-connect VT1.5 command is used to cross-connect one VT1.5 facility to another. Security level Level 3 Input syntax
ENT-CRS-VT1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>]; Table 8-27 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connection type Switchmate identifies the path protection for the FromAID OC-3 interface only when the CCT is protected. That is, when the CCT is one of 1WAYPR, 2WAYPR, or 2WAYBR.
ToAID
CTAG CCT SWMATE
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-31 Table 8-28 AID descriptions AID type Command-specific parameters Parameter values Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1 port# = 1 to 12 slot# = 3 port# = 1 to 8 OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, or 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 7 to 10 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 grp# = 1 to 3 slot# = 3 to 4 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 or 2 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 Not applicable
VT1.5 DS1-slot#-port# facility AID
SMART AID
DS1-DFLT-grp#
For an OC-3 Express network element, use the DFLT-# smart AID to cross-connect one of three sets of 28 DS1s to VT1.5s within an STS-1. For each possible DFLT-# value, a specific set of 28 ports is cross-connected to an STS-1. For example, the DFLT-2 set of DS1 ports can be mapped to STS1-3. This causes DS1 ports 29 through 56 to be cross-connected to STS1-3. Table 8-29 shows the DFLT-# smart AID value and the corresponding ports.
8-32 Cross-connect detailed command descriptions Table 8-30 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Description Unidirectional connection Bidirectional connection (default) Unidirectional path ring connection Bidirectional path ring connection Bidirectional bridge ring connection
Example input
For the NEWYORK network element, add a VT1.5 bidirectional cross-connect between the DS1 mapper in slot four and the path protected optical interfaces in slots 11 and 12:
ENT-CRS-VT1:NEWYORK: OC3-11-2-1-1,DS1-4-1:CTAG45:: 2WAYPR:SWMATE=OC3-12-2-1-1;
For the WASHINGTON network element, add 28 bidirectional VT1.5 cross-connects between the DFLT-1 VT1.5 facilities (DS1 ports to 12 on the slot 4 DS1 mapper, DS1 ports 1 to 12on the slot 5 DS1 mapper and DS1 ports 1 to 4 on the slot 6 DS1 mapper), from the path protected optical interfaces in slots 9 and 11:
ENT-CRS-VT1:WASHINGTON: OC3-9-3-ALL,DS1-DFLT-1:CTAG89:: 2WAYPR:SWMATE=OC3-11-3-ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-CRS-STS1
The Retrieve Cross-connect STS1 command is used to retrieve STS-1 cross-connects and activity. Security level Level 1 Input syntax
RTRV-CRS-STS1:[TID]:[fromAID,toAID]/[AID]:CTAG::[CCT] :[DISPLAY=Domain]; Table 8-31 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connect type is accepted only when Display=PROV. The CCT is ignored if Display=ACT. Specifies whether provisioned or active cross-connects are retrieved
ToAID
CTAG CCT Display
8-34 Cross-connect detailed command descriptions Table 8-32 AID descriptions AID type Command-specific Parameter values parameters Express Description Express CX Retrieve all provisioned STS-1 cross-connects to all STS-1 facilities. This is valid only when DISPLAY=PROV Retrieves the active path when DISPLAY=ACT
STS-1 ALL Facility AID
ALL OC3-slot#-sts# OC3-slot#-ALL OC3-ALL DS3-slot# DS3-ALL EC1-slot# EC1-ALL slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, or 9 slot# = 3, 5, 7, or 9 slot# = 3 to 4 sts# = 1 to 3 slot# = 1 slot# = 1
Note: If both the FromAID and the ToAID are specified, only the AIDs in the shaded cells are valid.
Table 8-33 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Description Unidirectional connection Bidirectional connection Unidirectional path ring connection Bidirectional path ring connection Bidirectional bridge ring connection
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Table 8-34 Display mode descriptions Display PROV ACT Example input Description Default. Retrieves provisioned cross-connects Retrieves the path activity of provisioned cross-connects
For the WASHINGTON network element, retrieve the active OC-3 interface for all provisioned STS-1 cross-connects to the OC-3 interface in slot 11, regardless of cross-connection type:
RTRV-CRS-STS1:WASHINGTON:OC3-11-ALL:CTAG65:::DISPLAY=ACT;
For the SEATTLE network element, retrieve all the provisioned STS-1 cross-connects regardless of cross-connection type:
RTRV-CRS-STS1:SEATTLE:ALL:CTAG56:::DISPLAY=PROV;
Note: All of the provisioned STS-1 cross-connects on the network element are listed in the command response. For the SEATTLE network element, retrieve all the provisioned STS-1 cross-connects with a cross-connection type of 1WAY:
RTRV-CRS-STS1:SEATTLE:ALL:CTAG56::1WAY:DISPLAY=PROV;

FromAID,ToAID:cct[,FFP]:[SWMATE=<aid>]:sst Table 8-35 Response parameter descriptions Parameter FFP Response values UNI BIDIR Description unidirectional bidirectional
Note: The facility group protection is only available with linear systems.
SST ACT IDLE PSI FLT MEA TSTF UEQ ROLL Active, carrying traffic (default) Idle, not carrying traffic Protection switch inhibited Fault detected in equipment Mismatched equipment attributes (circuit pack) Test failed, OOS due to failed test Unequipped, circuit pack missing Roll
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-CRS-STS3C
The Retrieve Cross-connect STS3C command is used to retrieve STS-3c cross-connects and activity. Security level Level 1 Input syntax
RTRV-CRS-STS3C:[TID]:[fromAID,toAID]/[AID]:CTAG::[CCT] :[DISPLAY=Domain]; Table 8-36 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connect type is accepted only when Display=PROV. The CCT is ignored if Display=ACT. Specifies whether provisioned or active cross-connects are retrieved
ToAID
CTAG CCT Display
8-38 Cross-connect detailed command descriptions Table 8-37 AID descriptions AID type Command-specific Parameter values parameters Description Retrieve all provisioned STS-3c cross-connects to all OC-3 facilities. This is valid only when DISPLAY=PROV slot# = 3 to 12 Retrieve the active path when DISPLAY=ACT
OC-3 ALL Facility AID
OC3-slot# OC3-ALL ALL Table 8-38 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR Description
Unidirectional connection Bidirectional connection Unidirectional path ring connection Bidirectional path ring connection
Table 8-39 Display mode descriptions Display PROV ACT Description Default. Retrieves provisioned cross-connects Retrieves the path activity of provisioned cross-connects
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-39 Example input
For the WASHINGTON network element, retrieve the active OC-3 interface for any provisioned STS-3c cross-connects to the OC-3 interface in slot 11, regardless of cross-connection type:
RTRV-CRS-STS3C:WASHINGTON:OC3-11:CTAG65:::DISPLAY=ACT;
For the SEATTLE network element, retrieve all the provisioned STS-3c cross-connects regardless of cross-connection type:
RTRV-CRS-STS3C:SEATTLE:ALL:CTAG56:::DISPLAY=PROV;
Note: All of the provisioned STS-3c cross-connects on the network element are listed in the command response. For the SEATTLE network element, retrieve all the provisioned STS-3c cross-connects with a cross-connection type of 1WAY:
RTRV-CRS-STS3C:SEATTLE:ALL:CTAG56::1WAY:DISPLAY=PROV;

RTRV-CRS-VT1
The Retrieve Cross-connect VT1.5 command is used to retrieve VT1.5 cross-connects. Security level Level 1 Input syntax
RTRV-CRS-VT1:[TID]:[fromAID,toAID]/[AID]:CTAG::[CCT] :[DISPLAY=Domain]; Table 8-41 Syntax definition Field TID FromAID Purpose Target identifier From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source. To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination. Correlation tag Cross-connect type is accepted only when Display=PROV. The CCT is ignored if Display=ACT. Specifies whether provisioned or active cross-connects are retrieved
ToAID
CTAG CCT Display
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-41 Table 8-42 AID descriptions AID type Command-specific parameters VT1.5 Facility AID ALL Parameter values Express Express CX Retrieve all provisioned VT1.5 cross-connects to all VT1.5 facilities. This is valid only when DISPLAY=PROV slot# = 4 to 10 port# = 1 to 12 slot# = 1 port# = 1 to 12 slot# = 3 port# = 1 to 8 grp# = 1 to 3 slot# = 3, 5, 7, or 9 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 7 to 10 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 Not applicable slot# = 1 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3 to 4 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 1 or 2 bridge#= 1 to 2 vp# = 1 to 8 t1# = 1 to 8 Retrieves the active path when DISPLAY=ACT Purpose
DS1-slot#-port# DS1-slot#-ALL DS1-ALL
DS1-DFLT-grp# EC1-slot#-sts#-vtg#-vt# EC1-slot#-sts#-ALL EC1-ALL OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL OC3-ALL EIM-slot#-bridge#-vp#-t1# EIM-slot#-bridge#-vp#-ALL EIM-slot#-bridge#-ALL EIM-slot#-ALL EIM-ALL
For an OC-3 Express network element, use the DFLT-# smart AID to retrieve the cross-connects of one of three sets of 28 DS1s to VT1.5s within an STS-1. For each possible DFLT-# value, a specific set of 28 ports is cross-connected to an STS-1. For example, the DFLT-2 set of DS1 ports can be mapped to STS1-3. This causes DS1 ports 29 through 56 to be cross-connected to STS1-3. Table 8-43 shows the DFLT-# smart AID value and the corresponding ports.
8-42 Cross-connect detailed command descriptions Table 8-43 DFLT-# smart AID values DFLT-# 1 2 3 Table 8-44 CCT descriptions CCT 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Description Unidirectional connection Bidirectional connection Unidirectional path protected ring connection Bidirectional path protected ring connection Bidirectional path protected bridge ring connection Ports 1-28 29-56 57-84
Table 8-45 Display mode descriptions Display PROV ACT Description Default. Retrieves provisioned cross-connects Retrieves the path activity of provisioned cross-connects.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-43 Example input
For the WASHINGTON network element, retrieve the activity for all provisioned VT1.5 cross-connects to the OC-3 interface in slot 11, regardless of cross-connection type:
RTRV-CRS-VT1:WASHINGTON:OC3-11-1-ALL:CTAG65:::DISPLAY=ACT;
For the SEATTLE network element, retrieve all the provisioned VT1.5 cross-connects regardless of cross-connection type:
RTRV-CRS-VT1:SEATTLE:ALL:CTAG56:::DISPLAY=PROV;
Note: All of the provisioned VT1.5 cross-connects on the network element are listed in the command response. For the SEATTLE network element, retrieve all the provisioned VT1.5 cross-connects with a cross-connection type of 1WAY:
RTRV-CRS-VT1:SEATTLE:ALL:CTAG56::1WAY:DISPLAY=PROV;

8-44 Cross-connect detailed command descriptions Figure 8-1 Valid STS-1 AID combinations by CCT
FromAID DS3 EC-1 OC-3 STS-1
FromAID OC-3
SWMATE OC-3
STS-1 DS3 EC-1 OC-3 ToAID CCT = 1WAY DS3 EC-1 OC-3 ToAID CCT = 1WAYPR
Typical application is unidirectional broadcast. Valid in linear and UPSR systems.
Typical application is reception of unidirectional broadcast. Valid only in UPSRs.
FromAID DS3 EC-1 OC-3 STS-1
FromAID OC-3
SWMATE OC-3
STS-1 DS3 EC-1 OC-3 ToAID CCT = 2WAY
Typical applications are bidirectional connection in a linear system or a bidirectional passthrough in a UPSR. Valid in linear and UPSR systems.
STS-1
STS-1 DS3 EC-1 OC-3 ToAID CCT = 2WAYPR
STS-1
Standard application is a bidirectional connection in a UPSR. Valid only in UPSR systems.
FromAID OC-3
SWMATE OC-3
DS3 EC-1 OC-3 ToAID
Standard application is matched-node connection between two UPSRs. Valid only in UPSR systems.
CCT = 2WAYBR
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Cross-connect detailed command descriptions 8-45 Figure 8-2 Valid STS-3c AID combinations by CCT
FromAID OC-3
STS-3c
ToAID CCT = 1WAY
FromAID OC-3
SWMATE OC-3
OC-3 FromAID OC-3 ToAID CCT = 1WAYPR
STS-3c STS-3c Typical applications are bidirectional connection in a linear system or a bidirectional passthrough in a UPSR. Valid in linear and UPSR systems.
OC-3 ToAID CCT = 2WAY
FromAID OC-3
SWMATE OC-3
STS-3c STS-3c
STS-3c
OC-3 ToAID CCT = 2WAYPR
8-46 Cross-connect detailed command descriptions Figure 8-3 Valid VT1.5 AID combinations by CCT
FromAID DS1 EC-1 OC-3 VT1.5
FromAID OC-3
SWMATE OC-3
VT1.5 DS1 EC-1 OC-3 ToAID CCT = 1WAY DS1 EC-1 OC-3 ToAID CCT = 1WAYPR
FromAID DS1 EC-1 OC-3 VT1.5 VT1.5 Typical applications are bidirectional connection in a linear system or a bidirectional passthrough in a UPSR. Valid in linear and UPSR systems.
FromAID OC-3
SWMATE OC-3
VT1.5
VT1.5 DS1 EC-1 OC-3 ToAID CCT = 2WAYPR
VT1.5
DS1 EC-1 OC-3 ToAID CCT = 2WAY
FromAID OC-3 VT1.5
SWMATE OC-3
VT1.5 VT1.5 DS1 EC-1 OC-3 ToAID Standard application is matched-node connection between two UPSRs. Valid only in UPSR systems.
CCT = 2WAYBR
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
9-1
Inservice traffic rollover command descriptions
9-
This chapter is a summary of the TL1 commands related to inservice traffic rollover (ISTR). The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. Most commands in this chapter are supported on the OC-3 Express network element, the OC-3 Express CX network element, and the network processor (NP). The following table lists all the commands in this chapter
Command ENT-ROLL-VT1 ENT-ROLL-STS1 ENT-ROLL-STS3C ED-ROLL-VT1 ED-ROLL-STS1 ED-ROLL-STS3C CMMT-ROLL-VT1 CMMT-ROLL-STS1 CMMT-ROLL-STS3C DLT-ROLL-VT1 DLT-ROLL-STS1 DLT-ROLL-STS3C
continued
Page
9-3 9-6 9-9 9-12 9-15 9-17 9-19 9-21 9-23 9-25 9-28 9-30
9-2 Inservice traffic rollover command descriptions Command RTRV-ROLL-VT1 RTRV-ROLL-STS1 RTRV-ROLL-STS3C Page
9-32 9-34 9-36
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-3
ENT-ROLL-VT1
The Enter Rollover VT1 command is used to define a new connection to which to rollover an existing termination point in a VT1.5 path. If you try to execute an inservice rollover command on a 1WAYPR mutlicast cross-connect, you get the message Status, data not consistent. To rollover a 1WAYPR multicast cross-connect, you must: convert each 1WAYPR multicast cross-connect to a 1WAY cross-connect with the ED-CRS command rollover the endpoint of each 1WAY cross-connect convert each 1WAY cross-connect back to a 1WAYPR cross-connect with the ED-CRS command Security level Level 3 Input syntax
ENT-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,SWMATE=AID]; Table 9-1 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID SWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, a user created alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate Used to bridge the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
Note: When rolling a switch mate, RTO=RFROM.
9-4 Inservice traffic rollover command descriptions Table 9-2 AID description AID type VT1.5 facility AID Command-specific parameters DS1-slot#-port# DS1-DFLT-Grp OC3-slot#-sts#-vtg#-vt# Parameter values slot# = 4 to 10 port# = 1 to 12 Grp = 1 to 3 slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3 to 12 sts# = 1 to 3 EC1-slot#-sts#-vtg#-vt# slot# = 3, 5, 7, 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, 9 sts# = 1
OC3-slot#-sts#-ALL
EC1-slot#-sts#-ALL
Table 9-3 Parameter description Parameter CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Bridge will be denied if conditions on the node are inappropriate. Bridge will be performed regardless of the condition of the switched-to path.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-5 Example input
Rollover a VT1.5 working connection and its switch mate on the OC3 circuit pack in a 2WAYPR circuit between a DS1 service and the OC3 circuit pack. Bridge the original working OC-3 connection:
ENT-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:A::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-3-7-1,VALID=Y;
Switch to the bridge connection:

ED-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:B::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-3-7-1,VALID=Y;
Remove the original working connection:

CMMT-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:C::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-3-7-1;
Bridge the original switch mate OC-3 connection:

ENT-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:E::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-2-7-1,VALID=Y, SWMATE=OC3-12-2-7-1;

ED-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:F::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-2-7-1,VALID=Y, EDSWMATE=Y:SWITCHED;
Remove the original switch mate OC-3 connection:

CMMT-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:G::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-2-7-1,CMMTSWMATE=Y;
9-6 Inservice traffic rollover command descriptions
ENT-ROLL-STS1
The Enter Rollover STS-1 command is used to define a new connection to which to rollover an existing termination point in an STS-1 path. If you try to execute an inservice rollover command on a 1WAYPR mutlicast cross-connect, you get the message Status, data not consistent. To rollover a 1WAYPR multicast cross-connect, you must: convert each 1WAYPR multicast cross-connect to a 1WAY cross-connect with the ED-CRS command rollover the endpoint of each 1WAY cross-connect convert each 1WAY cross-connect back to a 1WAYPR cross-connect with the ED-CRS command Security level Level 3 Input syntax
ENT-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,SWMATE=AID]; Table 9-4 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID SWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate Used to bridge the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-7 Table 9-5 AID description AID type STS-1 facility AID Command-specific parameters OC3-slot#-sts# Parameter values slot#=3-12 sts#=1-3 DS3-slot# EC1-slot#-sts# slot#=3, 5, 7, 9 slot#=3, 5, 7, 9 sts# = 1
Table 9-6 Parameter description Parameter CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Bridge will be denied if conditions on the node are inappropriate. Bridge will be performed regardless of the condition of the switched-to path.
Example input
Rollover an STS1 connection and its switch mate on the OC3 circuit pack in a 2WAYPR circuit between a DS3 service and the OC3 circuit pack. Bridge the original working OC-3 connection:
ENT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:A::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-3,VALID=Y;

ED-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:B::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-3,VALID=Y:SWITCHED;

CMMT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:C::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-3;

ENT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:E::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-2,VALID=Y, SWMATE=OC3-12-2;

ED-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:F::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-2,VALID=Y, EDSWMATE=Y:SWITCHED;
Remove the original switch mate OC-3 connection:

CMMT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:G::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-2,CMMTSWMATE=Y;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ENT-ROLL-STS3C
The Enter Rollover STS3C command is used to define a new connection to which to rollover an existing termination point in a STS3C path. If you try to execute an inservice rollover command on a 1WAYPR mutlicast cross-connect, you get the message Status, data not consistent. To rollover a 1WAYPR multicast cross-connect, you must: convert each 1WAYPR multicast cross-connect to a 1WAY cross-connect with the ED-CRS command rollover the endpoint of each 1WAY cross-connect convert each 1WAY cross-connect back to a 1WAYPR cross-connect with the ED-CRS command Security level Level 3 Input syntax
ENT-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,SWMATE=AID]; Table 9-7 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID SWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate Used to bridge the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
9-10 Inservice traffic rollover command descriptions Table 9-8 AID description AID type STS3C facility AID Command-specific parameters OC3-slot#-sts# OC3-slot# Table 9-9 Parameter description Parameter CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Bridge will be denied if conditions on the node are inappropriate. Bridge will be performed regardless of the condition of the switched-to path. Parameter values slot# = 3-12 sts# = 1 slot# = 3 to 12
Example input
Rollover an STS3C connection and its switch mate on the OC3 circuit pack in a 2WAYPR circuit between an OC3 service and the OC3 circuit pack. Bridge the original working OC-3 connection:
ENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:A::2WAYPR: RFROM=OC3-11,RTO=OC3-9,VALID=Y;

ED-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:B::2WAYPR: RFROM=OC3-11,RTO=OC3-9,VALID=Y:SWITCHED;

CMMT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:C::2WAYPR: RFROM=OC3-11,RTO=OC3-9;

ENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:D::2WAYPR: RFROM=OC3-11,RTO=OC3-9,VALID=Y,SWMATE=OC3-8;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G

ED-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:E::2WAYPR: RFROM=OC3-11,RTO=OC3-11,VALID=Y,EDSWMATE=Y:SWITCHED;
Remove the original switch mate connection:

CMMT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:F::2WAYPR: RFROM=OC3-11,RTO=OC3-11,CMMTSWMATE=Y;
ED-ROLL-VT1
The Edit Rollover VT1 command is used to switch traffic from an existing connection to another connection previously established by an ENT-ROLL-VT1 command. Security level Level 3 Input syntax
ED-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,EDSWMATE=Domain]:SST; Table 9-10 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID EDSWMATE SST Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate Used to switch the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR Secondary state
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-13 Table 9-11 AID description AID type VT1.5 facility AID Command-specific parameters DS1-slot#-port# DS1-DFLT-Grp OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL Parameter values slot# = 4 to 10 port# = 1 to 12 Grp = 1 to 3 slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4
Table 9-12 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) SST Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Switch will be denied if conditions on the node are inappropriate. Switch will be performed regardless of the condition of the switched-to path.
SWITCHED (default) when switching from bridged to switched, SST=SWITCHED BRIDGED when backing -out from switched to bridged, SST=BRIDGED
Example input
Rollover a VT1.5 working connection on the OC3 circuit pack in a 2WAYPR circuit between a DS1 service and the OC3 circuit pack. Bridge the original working OC-3 connection:

ED-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:B::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-3-7-1,VALID=Y:SWITCHED;

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-ROLL-STS1
The Edit Rollover STS1 command is used to switch traffic from an existing connection to another connection previously established by an ENT-ROLL-STS1 command. Security level Level 3 Input syntax
ED-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,EDSWMATE=Domain]:SST; Table 9-13 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID EDSWMATE SST Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate Used to switch the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit Secondary state
9-16 Inservice traffic rollover command descriptions Table 9-14 AID description AID type STS1 facility AID Command-specific parameters DS3-slot# OC3-slot#-sts# EC1-slot#-sts# Parameter values slot# = 3, 5, 7, 9 slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, 9 sts# = 1
Table 9-15 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) SST Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Switch will be denied if conditions on the node are inappropriate. Switch will be performed regardless of the condition of the switched-to path.
Example input
Rollover an STS1 working connection on the OC3 circuit pack in a 2WAYPR circuit between a DS3 service and the OC3 circuit pack. Bridge the original OC-3 connection:


CMMT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-4:C::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-3; S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998
ED-ROLL-STS3C
The Edit Rollover STS3C command is used to switch traffic from an existing connection to another connection previously established by an ENT-ROLL-STS3C command. Security level Level 3 Input syntax
ED-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,EDSWMATE=Domain]:SST; Table 9-16 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID EDSWMATE SST Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate Used to switch the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit Secondary state

Table 9-17 AID description AID type STS3C facility AID Command-specific parameters OC3-slot#-sts# OC3-slot# Parameter values slot# = 3 to 12 sts# = 1
9-18 Inservice traffic rollover command descriptions Table 9-18 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) SST Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Switch will be denied if conditions on the node are inappropriate. Switch will be performed regardless of the condition of the switched-to path.
Example input
Rollover an STS3C working connection on the OC3 circuit pack in a 2WAYPR circuit between an OC3 service and the OC3 circuit pack. Bridge the original OC-3 working connection
ENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:D::2WAYPR: RFROM=OC3-11,RTO=OC3-9,VALID=Y;
Switch to the bridge connection

Remove the original working connection

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
CMMT-ROLL-VT1
The Commit Rollover VT1 command is used to delete the original VT1.5 path. Security level Level 3 Input syntax
CMMT-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,CMMTSWMATE=Domain]; Table 9-19 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO CMMTSWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Deletes the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
9-20 Inservice traffic rollover command descriptions Table 9-20 AID description AID type VT1.5 facility AID Command-specific parameters DS1-slot#-port# DS1-DFLT-Grp OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL Parameter values slot# = 4 to 10 port# = 1 to 12 Grp = 1 to 3 slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4
Table 9-21 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Example input Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3
Rollover a VT1.5 working connection on the OC3 circuit pack in a 2WAYPR circuit between a DS1 service and the OC3 circuit pack. Bridge the original OC-3 connection:

ED-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:B::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-3-7-1,VALID=Y:SWITCHED;
Remove the original connection:

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
CMMT-ROLL-STS1
The Commit Rollover STS1 command is used to delete the original STS1 path. Security level Level 3 Input syntax
CMMT-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,CMMTSWMATE=Domain]; Table 9-22 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO CMMTSWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Deletes the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

Table 9-23 AID description AID type STS1 facility AID Command-specific parameters DS3-slot# OC3-slot#-sts# EC1-slot#-sts# Parameter values slot# = 3, 5, 7, 9 slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, 9 sts# = 1
9-22 Inservice traffic rollover command descriptions Table 9-24 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Example input Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3
Rollover an STS1 working connection on the OC3 circuit pack in a 2WAYPR circuit between a DS3 service and the OC3 circuit pack. Bridge the original OC-3 working connection:


CMMT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:C::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-3;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
CMMT-ROLL-STS3C
The Commit Rollover STS3C command is used to delete the original STS-3c path. Security level Level 3 Input syntax
CMMT-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,CMMTSWMATE=Domain]; Table 9-25 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO CMMTSWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Deletes the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

9-24 Inservice traffic rollover command descriptions Table 9-27 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Example input Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3
Rollover an STS3C working connection on the OC3 circuit pack in a 2WAYPR circuit between an OC3 service and the OC3 circuit pack. Bridge the original OC-3 working connection:
ENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:D::2WAYPR: RFROM=OC3-11,RTO=OC3-9,VALID=Y;


S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
DLT-ROLL-VT1
The Delete Rollover VT1 command is used to delete a connection previously established by the ENT-ROLL-VT1 command. The Delete Rollover VT1 command will return the connection to its original idle state. Security level Level 3 Input syntax
DLT-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,DLTSWMATE=Domain]; Table 9-28 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID DLTSWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled (see Note) AID RFROM is to be rolled to (see Note) Command execution will be denied if the conditions on the node are inappropriate If included in the command, the switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
9-26 Inservice traffic rollover command descriptions Table 9-29 AID description AID type VT1.5 facility AID Command-specific parameters DS1-slot#-port# DS1-DFLT-Grp OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL Parameter values slot# = 4 to 10 port# = 1 to 12 Grp = 1 to 3 slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4
Table 9-30 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) DLTSWMATE Y Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Command execution will be denied if conditions on the node are inappropriate. Command is performed regardless of the condition of the switched-to path. The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR The switch mate is not affected.
N (default)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-27 Example input
Reverse the rollover of a VT1.5 connection on the OC3 circuit pack in a 2WAYPR circuit between a DS1 service and the OC3 circuit pack. Bridge the original OC-3 connection:
Backout of the bridged connection:

DLT-ROLL-VT1:OTTAWA:OC3-11-2-7-1,DS1-4-4:B::2WAYPR: RFROM=OC3-11-2-7-1,RTO=OC3-11-3-7-1,VALID=Y;
DLT-ROLL-STS1
The Delete Rollover STS1 command is used to delete a connection previously established by the ENT-ROLL-STS1 command. The Delete Rollover STS1 command will return the connection to its original idle state. Security level Level 3 Input syntax
DLT-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,DLTSWMATE=Domain]; Table 9-31 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID DLTSWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled AID RFROM is to be rolled to Command execution will be denied if the conditions on the node are inappropriate The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
Table 9-32 AID description AID type STS1 facility AID Command-specific parameters DS3-slot# OC3-slot#-sts# EC1-slot#-sts# Parameter values slot# = 3, 5, 7, 9 slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, 9 sts# = 1
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-29 Table 9-33 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) DLTSWMATE Y Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Command execution will be denied if conditions on the node are inappropriate Command execution is performed regardless of the conditions The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit The switch mate is not affected.
N (default) Example input
Rollover an STS1 connection on the OC3 circuit pack in a 2WAYPR circuit between a DS3 service and the OC3 circuit pack. Bridge the original OC-3 connection:
ENT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:A::2WAYPR: RFROM=OC3-11-2,RTO=OC3-11-3,VALID=Y,SWMATE=OC3-12-2;
Backout of the bridged connection:

DLT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:E::2WAYPR: RFROM=0C3-11-2,RTO=OC3-11-3,VALID=Y;
DLT-ROLL-STS3C
The Delete Rollover STS3C command is used to delete a connection previously established by the ENT-ROLL-STS3C command. The Delete Rollover STS3C command will return the connection to its original idle state. Security level Level 3 Input syntax
DLT-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT: RFROM=AID,RTO=AID[,VALID=Domain][,DLTSWMATE=Domain]; Table 9-34 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO VALID DLTSWMATE Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints The second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled AID RFROM is to be rolled to Command execution will be denied if the conditions on the node are inappropriate The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-31 Table 9-36 Keyword description Keyword CCT Possible Values 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR VALID Y N (default) DLTSWMATE Y Description Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Command execution will be denied if conditions on the node are inappropriate Command execution is performed regardless of the conditions The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit The Switch Mate is not affected.
N (default) Example input
Rollover an STS-3c connection on the OC-3 circuit pack in a 2WAYPR circuit between an OC-3 service and the OC-3 circuit pack. Bridge the original OC-3 connection:
ENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:D::2WAYPR: RFROM=OC3-11,RTO=OC3-9:VALID=Y;
Backout of the bridge connection:

DLT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:B::2WAYPR: RFROM=OC3-11,RTO=OC3-9,VALID=Y;
RTRV-ROLL-VT1
The Retrieve Rollover VT1 command is used to retrieve the status of connections operating at the VT1.5 rate which are in the process of being rolled over. If you try to execute an inservice rollover command on a 1WAYPR mutlicast cross-connect, you get the message Status, data not consistent. To rollover a 1WAYPR multicast cross-connect, you must: convert each 1WAYPR multicast cross-connect to a 1WAY cross-connect with the ED-CRS command rollover the endpoint of each 1WAY cross-connect convert each 1WAY cross-connect back to a 1WAYPR cross-connect with the ED-CRS command Security level Level 1 Input syntax
RTRV-ROLL-VT1:[TID]:[fromAID],[toAID]:CTAG::[CCT]: [RFROM=AID][,RTO=AID]; Table 9-37 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled AID RFROM is to be rolled to
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-33 Table 9-38 AID description AID type VT1.5 facility AID Command-specific parameters DS1-slot#-port# DS1-slot#-ALL DS1-ALL DS1-DFLT-Grp OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL OC3-slot#-ALL OC3-ALL EC1-slot#-sts#-vtg#-vt# EC1-slot#-sts#-ALL EC1-ALL ALL Table 9-39 Keyword description Keyword CCT Possible Values Null (default) 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Response block syntax Description Connections of any cross connect type Unidirectional connection Bidirectional connection 1WAY path ring, FromAID must be OC3 2WAY path ring, FromAID must be OC3 2WAY bridge ring, FromAID must be OC3 Parameter values slot# = 4 to 10 port# = 1 to 12 Grp = 1 to 3 slot# = 3 to 12 sts# = 1 to 3 vtg# = 1 to 7 vt# = 1 to 4 slot# = 3, 5, 7, 9 sts# = 1 vtg# = 1 to 7 vt# = 1 to 4 all VT1.5 facilities
The display response to the command RTRV-ROLL-VT1 is as follows:

Unprotected VT1 roll <fromAID>,<toAID>:<CCT>:<RFROM>,<RTO>:<SST> for example: OC3-11-2-1-4,DS1-9-8:2WAY;DS1-9-8,DS1-11-8:BRIDGED 1+1 Protected endpoint roll <fromAID>,<toAID>:<CCT>:<RFROM>,<RTO>:<SST>: <SWMATE_RFROM>,<SWMATE_RTO>:<SST> for example: OC3-11-2-1-4,DS1-9-8:2WAYPR:OC3-11-2-1-4,OC3-7-3-1-4: BRIDGED:OC3-12-3-1-4,OC3-8-3-1-4:BRIDGED
RTRV-ROLL-STS1
The Retrieve Rollover STS1 command is used to retrieve the status of connections operating at the STS1 rate which are in the process of being rolled over. If you try to execute an inservice rollover command on a 1WAYPR mutlicast cross-connect, you get the message Status, data not consistent. To rollover a 1WAYPR multicast cross-connect, you must: convert each 1WAYPR multicast cross-connect to a 1WAY cross-connect with the ED-CRS command rollover the endpoint of each 1WAY cross-connect convert each 1WAY cross-connect back to a 1WAYPR cross-connect with the ED-CRS command Security level Level 1 Input syntax
RTRV-ROLL-STS1:[TID]:[fromAID],[toAID]:CTAG::[CCT]: [RFROM=AID][,RTO=AID]; Table 9-40 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled AID RFROM is to be rolled to
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-35 Table 9-41 AID description AID type STS1 facility AID Command-specific parameters DS3-slot# DS3-ALL OC3-slot#-sts# OC3-slot#-ALL OC3-ALL EC1-slot#-sts# EC1-ALL ALL Table 9-42 Keyword description Keyword CCT Possible Values Null (default) 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Response block syntax Description Connections of any cross connect type Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Parameter values slot# = 3, 5, 7, 9 slot# = 3 to 12 sts# = 1 to 3 slot# = 3, 5, 7, 9 sts# = 1 all STS-1 facilities
The display response to the command RTRV-ROLL-STS1 is as follows:

Unprotected STS1 roll <fromAID>,<toAID>:<CCT>:<RFROM>,<RTO>:<SST> for example: OC3-11-2,DS3-9:2WAY;DS1-9-8,DS3-9:BRIDGED 1+1 Protected endpoint roll <fromAID>,<toAID>:<CCT>:<RFROM>,<RTO>:<SST>: <SWMATE_RFROM>,<SWMATE_RTO>:<SST> for example: OC3-11-2,DS3-9:2WAYPR:OC3-11-2,OC3-7-3: BRIDGED:OC3-12-3,OC3-8-3:BRIDGED
RTRV-ROLL-STS3C
The Retrieve Rollover STS3C command is used to retrieve the status of connections operating at the STS3C rate which are in the process of being rolled over. If you try to execute an inservice rollover command on a 1WAYPR mutlicast cross-connect, you get the message Status, data not consistent. To rollover a 1WAYPR multicast cross-connect, you must: convert each 1WAYPR multicast cross-connect to a 1WAY cross-connect with the ED-CRS command rollover the endpoint of each 1WAY cross-connect convert each 1WAY cross-connect back to a 1WAYPR cross-connect with the ED-CRS command Security level Level 1 Input syntax
RTRV-ROLL-STS3C:[TID]:[fromAID],[toAID]:CTAG::[CCT]: [RFROM=AID][,RTO=AID]; Table 9-43 Syntax definition Field TID fromAID toAID CTAG CCT RFROM RTO Purpose Target identifier, the network element to which the command is directed One of the original cross-connection endpoints Second of the original cross-connection endpoints Correlation tag, an alphanumeric identifier to correlate the command and response messages Connection type to be rolled The fromAID or toAID to be rolled AID RFROM is to be rolled to
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Inservice traffic rollover command descriptions 9-37 Table 9-44 AID description AID type STS3C facility AID Command-specific parameters OC3-slot#-sts# OC3-slot# OC3-ALL ALL Table 9-45 Keyword description Keyword CCT Possible Values Null (default) 1WAY 2WAY 1WAYPR 2WAYPR 2WAYBR Response block syntax Description Connections of any cross connect type Unidirectional connection Bidirectional connection 1WAY path ring, fromAID must be OC3 2WAY path ring, fromAID must be OC3 2WAY bridge ring, fromAID must be OC3 Parameter values slot# = 3 to 12 sts# = 1 all STS-3c facilities
The display response to the command RTRV-ROLL-STS3C is as follows:

Unprotected VT1 roll <fromAID>,<toAID>:<CCT>:<RFROM>,<RTO>:<SST> for example: OC3-11,OC3-12:2WAY;OC3-12,OC3-9:BRIDGED 1+1 Protected endpoint roll <fromAID>,<toAID>:<CCT>:<RFROM>,<RTO>:<SST>: <SWMATE_RFROM>,<SWMATE_RTO>:<SST> for example: OC3-11,OC3-12:2WAYPR:OC3-11,OC3-7: BRIDGED:OC3-9,OC3-8:BRIDGED
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
10-1
Facility test signal generation and loopback detailed command descriptions
10-
This chapter is an alphabetical summary of all the TL1 commands for the management of facility internal test equipment and facility loopbacks. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all of the commands in this chapter:
Command CONN-TSTSIG-T1 CONN-TSTSIG-T3 DISC-TSTSIG-T1 DISC-TSTSIG-T3 OPR-LPBK-EC1 OPR-LPBK-T1 OPR-LPBK-T3 RLS-LPBK-EC1 RLS-LPBK-T1 RLS-LPBK-T3 Page 10-2 10-4 10-6 10-7 10-8 10-10 10-12 10-14 10-15 10-16
10-2 Facility test signal generation and loopback detailed command descriptions
CONN-TSTSIG-T1
The Connect Test Signal T1 command instructs the network element to connect a test signal to the DS1 facility or monitor a connected signal. To retrieve error count on the monitored signal, use the RTRV-T1 command. Internal test equipment connected with the CONN-TSTSIG -T1 remains connected until it is released using the DISC-TSTSIG-T1 command (see page 10-6). Before internal test equipment can be connected to a DS1 facility, the facility must be put in an out-of-service state (RMV-T1 command). In order to clear the error count on the internal signal monitor, disconnect the internal test equipment by using the DISC-TSTSIG -T1 command. Security level Level 2 Input syntax
CONN-TSTSIG-T1:[TID]:AID:CTAG::[SRC],[DIRN],[TSIG],[ERR]; Table 10-1 Syntax definition Field TID AID CTAG src dirn tsig err Table 10-2 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# Purpose Identify the DS1 facility where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Purpose Target identifier Access identifier. The facility to act on. Correlation tag See the Parameter descriptions on page 10-3 for details
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-3 Table 10-3 Parameter descriptions Parameter src Possible values SRC MON dirn IN Description Connect the internal signal generator to the facility (default) Connect the internal signal monitor to the facility Default. Internal signal generator outputs a test signal in the direction of the optics. Internal signal monitor monitors the signal from the copper (DS1) side of the facility. Internal signal generator outputs a test signal to the copper (DS1) side of the facility. Internal signal monitor monitors the signal from the direction of the optics. The test signal to be sent for or monitored is: PR2017 PR2003 PR1514 PR2318 FIX Default: a pseudo-random pattern: x 20 + x17 + 1 (default) a pseudo-random pattern: x20 + x3 + 1 (see Note) a pseudo-random pattern: x15 + x14 + 1 a pseudo-random pattern: x23 + x18 + 1 the fixed Daly pattern
OUT tsig
<number> a fixed pattern made by endlessly repeating the binary version of the number specified by the user. The number can be anything between 0 and 16,777,215
Note: This pattern is not the pattern usually referred to as PR2003 in North American DS1 test sets. It is a rare variant that has been included for completeness. To generate a PR2003 pattern compatible with a North American test set, the PR2017 pattern should be used without zero suppression enabled.
err 0 to 1023 The number of errors to be inserted in one second. The default is 0. (This parameter is valid only if the src is SRC.)
Example input
At the SEATTLE network element, attach an internal DS1 signal generator to DS1 facility 7 on the slot 4 DS1 mapper. Send the test signal with a pattern of x20 + x17 + 1 and with 10 errors in the direction of the LIO onto the DS1 copper:
CONN-TSTSIG-T1:SEATTLE:DS1-4-7:CTAG12::SRC,OUT,,10;
Monitor the returned pattern:

CONN-TSTSIG-T1:SEATTLE:DS1-4-7:CTAG12::MON,IN,,10;
CONN-TSTSIG-T3
The Connect Test Signal T3 command instructs DS3 facility to send a test signal towards the optics or monitor a signal from the optics. The signal generator and signal monitor capability on a facility is often referred to as internal test equipment. Internal test equipment connected with the CONN-TSTSIG-T3 remains connected until it is released using the DISC-TSTSIG-T3 command (see page 10-7). Once a monitor is provisioned for a DS3 facility, it is possible to detect errors in the monitored signal using the RTRV-T3 command. If the ERR field in the response syntax equals YES, there are errors in the monitored signal. If the ERR field in the response syntax equals NO, there are no errors in the monitored signal. Before internal test equipment can be set up on a DS3 facility, the facility must be put in an out-of-service state (RMV-T3 command). Security level Level 3 Input syntax
CONN-TSTSIG-T3:[TID]:AID:CTAG::[SRC],[TSIG]; Table 10-4 Syntax definition Field TID AID CTAG src tsig Table 10-5 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3 facility where slot# = 3, 5, 7, or 9 Purpose Target identifier, Access identifier, the facility to be acted on Correlation tag See Parameter description table for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-5 Table 10-6 Parameter descriptions Parameter Possible values src SRC MON tsig PR15FRER PR15FRNER PR15UFRER Description Send a signal with the specified pattern towards the optics (default) Monitor a signal with the specified pattern from the optics The test signal to be sent for or monitored is: a pseudo-random pattern: 215 - 1 frame format = framed errored a pseudo-random pattern: 215 -
frame format = framed not errored a pseudo-random pattern: 215 - 1
frame format = unframed errored PR15UFRNER a pseudo-random pattern: 215 - 1 (default) frame format = unframed not errored ALL1s IDLE Example input All 1s pattern DS3 framed idle (repeating 1100 pattern)
At the SEATTLE network element, attach an internal DS3 signal generator to the DS3 facility on the slot 5 DS3 mapper. Send the test signal with a pseudo-random pattern of 215 - 1 and with frame format = framed errored:
CONN-TSTSIG-T3:SEATTLE:DS3-5:CTAG12::SRC,PR15FRER;
Monitor the returned pattern:

CONN-TSTSIG-T3:SEATTLE:DS3-5:CTAG12::MON,PR15FRER;
DISC-TSTSIG-T1
The Disconnect Test Signal T1 command instructs the network element to disconnect the DS1 test signal from the facility or stop monitoring a connected DS1 signal. All internal test equipment connected to a facility is disconnected. Security level Level 2 Input syntax
DISC-TSTSIG-T1:[TID]:AID:CTAG; Table 10-7 Syntax definition Field TID AID CTAG Table 10-8 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# Purpose Identify the DS1 facility where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Example input Purpose Target identifier Access identifier. The facility to act on. Correlation tag
Remove all internal test equipment on DS1 facility 7 on the DS1 in slot 4:
DISC-TSTSIG-T1:SEATTLE:DS1-4-7:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-7
DISC-TSTSIG-T3
The Disconnect Test Signal T3 command instructs the network element to disconnect the DS3 test signal from the facility and/or stop monitoring a connected DS3 signal. Note: DS3 test signal indicates a DS3 test signal generated by a DS3 facility. The CONN-TSTSIG-T3 command is used to provision signal generation and monitoring in DS3 facilities. See page 10-4 for information on the CONN-TSTSIG-T3 command. Security level Level 2 Input syntax
DISC-TSTSIG-T3:[tid]:AID:CTAG; Table 10-9 Syntax definition Field TID AID CTAG Table 10-10 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3 facility where slot# = 3, 5, 7, or 9 Purpose Target identifier Access identifier, the facility to be acted on Correlation tag
Example input
At the NEWYORK network element, remove all internal test equipment from the DS3 facility in slot 7:
DISC-TSTSIG-T3:NEWYORK:DS3-7:CTAG12;
OPR-LPBK-EC1
The Operate Loopback EC-1 facility command instructs the equipment to set the specified EC-1 facility into loopback mode. Two types of loopback are provided: terminal and facility. The facility must be put in an out-of-service state before a loopback will be permitted (RMV-EC1 command). To release the facility loopback, use the RLS-LPBK-EC1 command. Security level Level 2 Input syntax
OPR-LPBK-EC1:TID:AID:CTAG::,,,[LPBKTYPE]; Table 10-11 Syntax definition Field TID AID CTAG lpbktype Table 10-12 AID descriptions AID type EC1 AID Command-specific values EC1-slot# Purpose Identify the EC1 where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. The facility to act on. Correlation tag Loopback. See the Parameter descriptions table for details.
Table 10-13 Parameter descriptions Parameter lpbktype Possible values FACILITY Description A signal received on the copper side of the facility is looped back towards the copper. (default) A signal received on the optical side of the facility is looped back towards the optics.
TERMINAL
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-9 Example input
At the NEWYORK network element, for the slot 5 EC-1 mapper, loopback the incoming signal from the optics back on to the optics:
OPR-LPBK-EC1:NEWYORK:EC1-5:CTAG::,,,TERMINAL;
At the NEWYORK network element, for the slot 5 EC-1 mapper, loopback the incoming signal from the copper back on to the copper:
OPR-LPBK-EC1:NEWYORK:EC1-5:CTAG::,,,FACILITY;
OPR-LPBK-T1
The Operate Loopback T1 facility command instructs the equipment to set the specified DS1 facility into loopback mode. Two types of loopback are provided: terminal and facility. The facility must be put in an out-of-service state before a loopback is permitted (RMV-T1 command). To release the facility loopback, use the RLS-LPBK-T1 command. Security level Level 2 Input syntax
OPR-LPBK-T1:[TID]:AID:CTAG::,,,[LPBKTYPE]; Table 10-14 Syntax definition Field TID AID CTAG lpbktype Table 10-15 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# Purpose Identify the DS1 facility where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Purpose Target identifier Access identifier. The facility to act on. Correlation tag Loopback. See the Parameter descriptions table for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-11 Table 10-16 Parameter descriptions Parameter lpbktype Possible values FACILITY Description A signal received on the copper side of the facility is looped back towards the copper. (default) A signal received on the optical side of the facility is looped back towards the optics.
TERMINAL
Example input
At the SEATTLE network element, for the port 11 facility on the slot 5 DS1 mapper, loopback the incoming signal from the optics back on to the optics:
OPR-LPBK-T1:SEATTLE:DS1-5-11:CTAG::,,,TERMINAL;
At the SEATTLE network element, for the port 11 facility on the slot 5 DS1 mapper, loopback the incoming signal from the copper back on to the copper:
OPR-LPBK-T1:SEATTLE:DS1-5-11:CTAG::,,,FACILITY;
OPR-LPBK-T3
The Operate Loopback T3 facility command instructs the equipment to set the specified DS3 facility into loopback mode. Two types of loopback are provided: terminal and facility. The facility must be put in an out-of-service state before a loopback is permitted (RMV-T3 command). To release the facility loopback, use the RLS-LPBK-T3 command. Security level Level 2 Input syntax
OPR-LPBK-T3:[TID]:AID:CTAG::,,,[LPBKTYPE]; Table 10-17 Syntax definition Field TID AID CTAG lpbktype Table 10-18 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3 where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. The facility to act on. Correlation tag Loopback. See the Parameter descriptions table for details.
Table 10-19 Parameter descriptions Parameter lpbktype Possible values FACILITY Description A signal received on the copper side of the facility is looped back towards the copper. (default) A signal received on the optical side of the facility is looped back towards the optics.
TERMINAL
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-13 Example input
At the NEWYORK network element, for the slot 5 DS3 mapper, loopback the incoming signal from the optics back on to the optics:
OPR-LPBK-T3:NEWYORK:DS3-5:CTAG::,,,TERMINAL;
At the NEWYORK network element, for the slot 5 DS3 mapper, loopback the incoming signal from the copper back on to the copper:
OPR-LPBK-T3:NEWYORK:DS3-5:CTAG::,,,FACILITY;
RLS-LPBK-EC1
The Release Loopback EC-1 command instructs the equipment to release an EC-1 facility loopback. Security level Level 2 Input syntax
RLS-LPBK-EC1:[TID]:AID:CTAG; Table 10-20 Syntax definition Field TID AID CTAG Table 10-21 AID descriptions AID type EC1 AID Command-specific values EC1-slot# Purpose Identify the EC-1 where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. The facility to act on. Correlation tag
Example input
At the SEATTLE network element, release the slot 7 EC-1 facility loopback:
RLS-LPBK-EC1:SEATTLE:EC1-7:CTAG45;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Facility test signal generation and loopback detailed command descriptions 10-15
RLS-LPBK-T1
The Release Loopback T1 command instructs the equipment to release a DS1 facility loopback. Security level Level 2 Input syntax
RLS-LPBK-T1:[TID]:AID:CTAG; Table 10-22 Syntax definition Field TID AID CTAG Table 10-23 AID descriptions AID type DS1 AID Command-specific values DS1-slot#-port# Purpose Identify the DS1 facility where Express: slot#=4 to 10, port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Example input Purpose Target identifier Access identifier. The facility to act on. Correlation tag
At the NEWYORK network element, release the slot 4 DS1 mapper, facility 7 loopback:
RLS-LPBK-T1:NEWYORK:DS1-4-7:CTAG23;
RLS-LPBK-T3
The Release Loopback T3 command instructs the equipment to release a DS3 facility loopback. Security level Level 2 Input syntax
RLS-LPBK-T3:[TID]:AID:CTAG; Table 10-24 Syntax definition Field TID AID CTAG Table 10-25 AID descriptions AID type DS3 AID Command-specific values DS3-slot# Purpose Identify the DS3 where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX) Purpose Target identifier Access identifier. The facility to act on. Correlation tag
Example input
At the SEATTLE network element, release the slot 7 DS3 facility loopback:
RLS-LPBK-T3:SEATTLE:DS3-7:CTAG45;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
11-1
Protection switching detailed command descriptions 11This chapter is an alphabetical summary of all the TL1 commands related to protection switching. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command ALW-EX-OC3 EX-SW-OC3 INH-EX-OC3 OPR-PROTNSW-EQPT OPR-PROTNSW-OC3 OPR-PROTNSW-STS1 OPR-PROTNSW-STS3C OPR-PROTNSW-VT1 RLS-PROTNSW-EQPT RLS-PROTNSW-OC3 RLS-PROTNSW-STS1 RLS-PROTNSW-STS3C RLS-PROTNSW-VT1 RTRV-EXSCHED-OC3 RTRV-PROTNSW-rr SCHED-EX-OC3 Page 11-2 11-3 11-5 11-6 11-8 11-10 11-12 11-14 11-16 11-17 11-18 11-19 11-20 11-21 11-23 11-26
11-2 Protection switching detailed command descriptions
ALW-EX-OC3
The Allow Exerciser command is used to activate the exerciser to test the different protection mechanisms associated with OC-3 line switching in a linear 1+1 protected system. The high-speed exerciser is a routine that tests the integrity of the protection switching bytes (K-bytes) communication between an OC-3 pair configured in a linear 1+1 protected system. If the two ends fail to exchange the K-bytes, the exerciser will fail and the protection channel match fail alarm is raised. The exerciser can run automatically on a predetermined schedule, or it can be initiated manually. The exerciser runs on a pair of OC-3 circuit packs or on all OC-3 circuit packs in the shelf that are in an in-service state. The exerciser is the lowest priority user command and does not run if a higher priority feature or command is in effect. Security level Level 3 Input syntax
ALW-EX-OC3:[TID]:AID:CTAG; Table 11-1 Syntax definition Field TID AID CTAG Table 11-2 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL Purpose Identify the OC-3 facility where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. The OC-3 to act on. Correlation tag
Example input
Allow the exerciser for network element SEATTLE to run:

ALW-EX-OC3:SEATTLE:OC3-11:CTAG13;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-3
EX-SW-OC3
The Exercise Switch OC-3 command is used to run the exerciser to test the different protection mechanisms associated with OC-3 line switching. The high-speed exerciser is a routine that tests the integrity of the protection switching bytes (K-bytes) communication between an OC-3 pair configured in a linear 1+1 protected system. If the two ends fail to exchange the K-bytes, the exerciser will fail and the protection channel match fail alarm is raised. The exerciser can run automatically on a predetermined schedule, or it can be initiated manually. The exerciser runs on a pair of OC-3 or MTX circuit packs or on all OC-3 circuit packs in the shelf that are in an in-service state. The exerciser is the lowest priority user command and does not run if a higher priority feature or command is in effect. Security level Level 1 Input syntax
EX-SW-OC3:[TID]:AID:CTAG; Table 11-3 Syntax definition Field TID AID CTAG Table 11-4 AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 facility where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. The OC-3 to act on. Correlation tag
Example input
Run the exerciser on network element OTTAWA and report results of all exercises:
EX-SW-OC3:OTTAWA:OC3-11:CTAG23;

[aid]:<rslt>
Possible values for <rslt> are: FAIL the exercise has determined unit failure PASS the exercise found no problem in the unit
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
INH-EX-OC3
The INH-EX-OC3 command is used to prevent the exerciser from running to test the different protection mechanisms associated with OC-3 line switching. Security level Level 1 Input syntax
INH-EX-OC3:[TID]:AID:CTAG; Table 11-5 Syntax definition Field TID AID CTAG Table 11-6 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL Purpose Identify the OC-3 facility where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. The OC-3 to act on. Correlation tag
Example input
Prevent the exerciser from running on network element SEATTLE:

INH-EX-OC3:SEATTLE:OC3-ALL:CTAG23;
OPR-PROTNSW-EQPT
The Operate Protection Switch Equipment command instructs the network element to initiate an equipment protection switch request for a DS1, DS3, or EC-1 circuit pack. User switch requests initiated with this command remain active until they are released using the RLS-PROTNSW-EQPT command or overridden by a higher priority switch request. Security level Level 2 Input syntax
OPR-PROTNSW-EQPT:[TID]:AID:CTAG::[SC]; Table 11-7 Syntax definition Field TID AID CTAG SC Purpose Target identifier Access identifier. The entity to act on. Correlation tag Switch Command. See the Parameter descriptions table for details. Default is manual.
Table 11-8 AID descriptions AID type DS1 AID Command-specific values DS1-slot# Purpose Identify the DS1 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX)
DS3 AID
DS3-slot#
EC-1 AID
EC1-slot#
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-7 Table 11-9 Parameter descriptions Possible values MAN AID Express DS1#4 to 10 DS3 #3 to 10 EC-1 #3 to 10 Express CX DS1#1 to 2 DS3 #1 to 2 EC-1 #1 to 2 If the AID identifies a working circuit pack, then service will be transferred from it to the protection circuit pack if and only if the latter is neither failed nor servicing a higher or equal priority request. Default value. DS1#3 FRCD DS1#4 to 10 DS3 #3 to 10 EC-1 #3 to 10 DS1#1 to 2 DS3 #1 to 2 EC-1 #1 to 2 Not applicable. If the AID identifies a working circuit pack, then service will be transferred from it to the protection circuit pack if and only if the latter is not servicing a higher or equal priority request. If the AID identifies a working circuit pack that has already been switched to protection, no switch occurs; however, the priority of the existing switch will be raised to forced. DS1#3 LOCKOUT DS1#3 Not applicable. If the AID identifies the protection circuit pack (DS1-3) then the command will prevent any working circuit pack from switching to the protection circuit pack. If a working circuit pack is already on protection, it will be switched back. If the AID identifies a working circuit pack, then the command will prevent the working circuit pack from switching to protection. If the working circuit pack is on protection, it will be switched back. Description
DS1#4 to 10
Example input
Manually switch the DS1 in slot 5 to protection mode:

OPR-PROTNSW-EQPT:NEWYORK:DS1-5:CTAG23::MAN;
OPR-PROTNSW-OC3
The Operate Protection Switch OC-3 command instructs the network element to initiate a protection switch request for an OC-3 or MTX circuit pack. You can initiate a protection switch request only for network elements in a linear system. User switch requests initiated with this command remain active until they are released using the RLS-PROTNSW-OC3 command or overridden by a higher priority switch request. Security level Level 2 Input syntax
OPR-PROTNSW-OC3:[TID]:AID:CTAG::[SC]; Table 11-10 Syntax definition Field TID AID CTAG SC Purpose Target identifier Access identifier. The OC-3 to act on. Correlation tag Switch Command. See the Parameter descriptions table for details. Default is manual.
Table 11-11 AID description AID type OC-3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-9 Table 11-12 Parameter descriptions Parameter SC Possible Values MAN Description If the AID identifies a working circuit pack, then service will be transferred from it to the protection circuit pack if and only if the latter is neither failed nor servicing a higher or equal priority request. Default value. FRCD If the AID identifies a working circuit pack, then service will be transferred from it to the protection circuit pack if and only if the latter is not servicing a higher or equal priority request. If the AID identifies a working circuit pack that has already been switched to protection, no switch occurs; however, the priority of the existing switch will be raised to forced. LOCKOUT If the AID identifies the protection circuit pack then the command will prevent any working circuit pack from switching to the protection circuit pack. If a working circuit pack is already on protection, it will be switched back. Example input
Manually switch the OC-3 in slot 9 to protection mode:

OPR-PROTNSW-OC3:NEWYORK:OC3-9:CTAG23::MAN;
Lock out the OC-3 protection circuit pack in slot 10:

OPR-PROTNSW-OC3:NEWYORK:OC3-10:CTAG23::LOCKOUT;
OPR-PROTNSW-STS1
The Operate Protection Switch STS-1 command instructs the network element to initiate an STS-1 path protection switch request for an OC-3 or MTX circuit pack. Two levels of priority are supported: manual and forced. Lockout is not supported because STS-1 circuits are non-revertive. User switch requests initiated with this command remain active until they are released using the RLS-PROTNSW-STS1 command or overridden by a higher priority switch request. Security level Level 2 Input syntax
OPR-PROTNSW-STS1:[TID]:AID:CTAG::[SC]; Table 11-13 Syntax definition Field TID AID CTAG SC Purpose Target identifier Access identifier. The STS-1 path facility on the OC-3 to act on. Correlation tag, an alphanumeric identifier to correlate the command and response messages Switch Command. See the Parameter descriptions table for details. Default is manual.
Table 11-14 AID description AID type OC-3 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL Purpose Identify the STS-1 path on the OC-3 where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX) sts# = 1 to 3
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-11 Table 11-15 Parameter descriptions Parameter Possible Values SC MAN Description If the AID identifies a working circuit pack, then service will be transferred from it to the protection circuit pack if and only if the latter is neither failed nor servicing a higher or equal priority request. Default value. FRCD If the AID identifies a working circuit pack, then service will be transferred from it to the protection circuit pack if and only if the latter is not servicing a higher or equal priority request. If the AID identifies a working circuit pack that has already been switched to protection, no switch occurs; however, the priority of the existing switch will be raised to forced. Example input
Manually switch the STS-1 port 2 of the OC-3 in slot 9 to protection mode:
OPR-PROTNSW-STS1:NEWYORK:OC3-9-2:CTAG23::MAN;
OPR-PROTNSW-STS3C
The Operate Protection Switch STS-3c command instructs the network element to initiate an STS-3c path protection switch request for an OC-3 path. Two levels of priority are supported: manual and forced. Lockout is not supported. User switch requests initiated with this command remain active until they are released using the RLS-PROTNSW-STS3C command or overridden by a higher priority switch request. Security level Level 2 Input syntax
OPR-PROTNSW-STS3C:[TID]:AID:CTAG::[SC]; Table 11-16 Syntax definition Field TID AID CTAG SC Purpose Target identifier Access identifier. The STS-1 path to STS-3c on the OC-3 to act on. Correlation tag Switch Command. See the Parameter descriptions table for details. Default is manual.
Table 11-17 AID description AID type Command-specific values Purpose Identify the STS-1 path to STS-3c on the OC-3 where slot#= 3 to 12 sts# = 1
STS-3c OC3-slot#-sts# facility AID OC-3-slot#
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-13 Table 11-18 Parameter descriptions Parameter Possible Values SC MAN Description If the AID identifies a working path, then service will be transferred from it to the protection path if and only if the latter is neither failed nor servicing a higher or equal priority request. Default value. FRCD If the AID identifies a working path, then service will be transferred from it to the protection path if and only if the latter is not servicing a higher or equal priority request. If the AID identifies a working circuit pack that has already been switched to protection, no switch occurs; however, the priority of the existing switch will be raised to forced. Example input
Manually switch the STS-3c signal of the OC-3 in slot 9 to protection mode:
OPR-PROTNSW-STS3C:NEWYORK:OC3-9:CTAG23::MAN;
OPR-PROTNSW-VT1
The Operate Protection Switch VT1 command instructs the network element to initiate a VT1.5 path protection switch request. Two levels of priority are supported: manual and forced. Lockout is not supported because VT1.5 circuits are non-revertive. Manual and forced switch requests initiated using this command remain active until they are released using the RLS-PROTNSW-VT1 command or overridden by a higher priority switch request. Security level Level 2 Input syntax
OPR-PROTNSW-VT1:[TID]:AID:CTAG::[SC]; Table 11-19 Syntax definition Field TID AID CTAG SC Purpose Target identifier Access identifier. The VT1.5 path facility to act on. Correlation tag Switch Command. See the Parameter descriptions table for details. Default is manual.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-15 Table 11-20 AID descriptions AID type VT1.5 facility AID Command-specific values OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL Purpose Identify the VT1.5 path on the OC-3 where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX) sts# = 1 to 3 vtg#= 1 to 4 vt#= 1 to 4 Table 11-21 Parameter descriptions Parameter SC Possible values MAN Description Manual VT1.5 path protection switch. Service is transferred from the VT1.5 path identified, to the alternate path only if the path selector is not satisfying a higher or equal priority request. Default value. FRCD Forced VT1.5 path protection switch. Service is transferred from the VT1.5 path identified, to the alternate path only if the path selector is not satisfying a higher or equal priority request.
Example input
Request forced protection switching for VT1 #1, VTG#1, STS1#1, in slot 12:
OPR-PROTNSW-VT1:SEATTLE:OC3-12-1-1-1:CTAG45::FRCD;
RLS-PROTNSW-EQPT
The Release Protection Switch Equipment command instructs the network element to release (clear) any equipment protection switch requests that were initiated by the OPR-PROTNSW-EQPT command and are active on the entity specified. This command clears lockouts, forced switches and manual switches of DS1 circuit packs, and forced switches of DS3 and EC-1 circuit packs. Security level Level 2 Input syntax
RLS-PROTNSW-EQPT:[TID]:AID:CTAG; Table 11-22 Syntax definition Field TID AID CTAG Table 11-23 AID descriptions AID type DS1 AID Command-specific values DS1-slot# Purpose Identify the DS1 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the DS3 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 where slot#= 3 to 10 (Express) slot#= 1 to 2 (Express CX) Purpose Target identifier Access identifier. The equipment to act on. Correlation tag
DS3 AID
DS3-slot#
EC-1 AID
EC1-slot#
Example input
Release any protection requests on the DS1 in slot 5:

RLS-PROTNSW-EQPT:SEATTLE:DS1-5:CTAG23;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RLS-PROTNSW-OC3
The Release Protection Switch OC-3 command instructs the network element to release (clear) an OC-3 protection switch request. This command clears lockouts and forced switches of OC-3 circuit packs. Security level Level 2 Input syntax
RLS-PROTNSW-OC3:[TID]:AID:CTAG; Table 11-24 Syntax definition Field TID AID CTAG Table 11-25 AID descriptions AID type OC-3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 facility where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. The OC-3 facility to act on. Correlation tag
Example input
Place the OC-3 circuit pack in slot 12 back into normal mode:
RLS-PROTNSW-OC3:SEATTLE:OC3-12:CTAG12;
RLS-PROTNSW-STS1
The Release Protection Switch STS1 command instructs the network element to release (clear) an STS-1 path protection switch request. Security level Level 2 Input syntax
RLS-PROTNSW-STS1:[TID]:AID:CTAG; Table 11-26 Syntax definition Field TID AID CTAG Table 11-27 AID descriptions AID type STS-1 facility AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL Purpose Identify the STS-1 path on the OC-3 where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX) sts# = 1 to 3 Example input Purpose Target identifier Access identifier. The STS-1 path facility to act on. Correlation tag
Place the STS-1 signal on OC-3 circuit pack in slot 12, STS1#1 back into normal mode:
RLS-PROTNSW-STS1:SEATTLE:OC3-12-1:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RLS-PROTNSW-STS3C
The Release Protection Switch STS3C command instructs the network element to release (clear) an STS-3c path protection switch request. Security level Level 2 Input syntax
RLS-PROTNSW-STS3C:[TID]:AID:CTAG; Table 11-28 Syntax definition Field TID AID CTAG Table 11-29 AID descriptions AID type STS-3c facility AID Command-specific values OC3-slot#-sts# OC3-slot# Purpose Identify the STS-1 path to STS-3c on the OC-3 where slot#= 3 to 12 sts# = 1 Purpose Target identifier Access identifier. The STS-1 path to STS-3c to act on. Correlation tags
Example input
Place the STS-3c signal on OC-3 circuit pack in slot 12 back into normal mode:
RLS-PROTNSW-STS3C:SEATTLE:OC3-12-1:CTAG12;
RLS-PROTNSW-VT1
The Release Protection Switch VT1 command instructs the network element to release (clear) a VT1.5 path protection switch request. Security level Level 2 Input syntax
RLS-PROTNSW-VT1:[TID]:AID:CTAG; Table 11-30 Syntax definition Field TID AID CTAG Table 11-31 AID descriptions AID type VT1.5 facility AID Command-specific values OC3-slot#-sts1#-vtg#-vt# OC3-slot#-sts1#-ALL Purpose Identify the VT1.5 path on the OC-3 where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX) sts# = 1 to 3 vtg#= 1 to 4 vt#= 1 to 4 Example input Purpose Target identifier Access identifier. The VT1.5 path facility to act on. Correlation tag
Place the VT1.5 signal on OC-3 circuit pack in slot 12, STS1#1, VTG#1 back into normal mode:
RLS-PROTNSW-VT1:SEATTLE:OC3-12-1-1-1:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-EXSCHED-OC3
The Retrieve Exerciser Schedule command is used to retrieve the schedule that has been set for the exerciser to run. The high-speed exerciser is a routine that tests the integrity of the protection switching bytes (K-bytes) communication between an OC-3 pair configured in a linear 1+1 protected system. If the two ends fail to exchange the K-bytes, the exerciser will fail and the protection channel match fail alarm is raised. The exerciser can run automatically on a predetermined schedule, or it can be initiated manually. The exerciser runs on a pair of OC-3 circuit packs or on all OC-3 circuit packs in the shelf that are in an in-service state. The exerciser is the lowest priority user command and does not run if a higher priority feature or command is in effect. Security level Level 1 Input syntax
RTRV-EXSCHED-OC3:[TID]:AID:CTAG;

Table 11-32 Syntax definition Field TID AID CTAG Table 11-33 AID descriptions AID type OC3 Command-specific values OC3-slot# OC3-ALL Purpose Identify the OC-3s where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Purpose Target identifier Access identifier. The OC-3 to act on. Correlation tag
Response block syntax The response follows the normal response format if there are no exerciser schedules. If there is at least one exerciser schedule to report, the <rspblk> has the format:
<aid>[,aidtype]:<invl>,<dat>,<tm>,<numinvl>,<reptmode> Table 11-34 Response parameter descriptions Parameter Valid Values Unit DAY HR MIN Run the exerciser once every x days Run the exerciser once every x hours Run the exerciser once every x minutes If no parameter is entered, the default is once every 24 hours. Description
Value invl (interval between 1 to 3 the exerciser) 1 to 5 5 to 30 null dat (date)
Month of year, day of month of the next MOY-DOM where MOY is from exercise 1 to 12, and DOM is from 1 to 31 Hour of day, minute of hour of the next HOD-MOH where HOD is from exercise 0 to 23, and MOH is from 0 to 59 1 to 250 255 The remaining number of intervals over which exercises are to be performed The exerciser runs indefinitely, until it is stopped or rescheduled by another command. Report results of all exercises Report results of failed exercises If no value is entered, the default is FAIL. The exerciser is enabled. The exerciser is disabled.
tm (time)
numinvl (number of intervals to run the exerciser)
reptmode (report mode)
ALL FAIL null
alw
ALW INH
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-PROTNSW-rr
The Retrieve Protection Switch command retrieves the protection switching status for tributary equipment (DS1, DS3 and EC-1) 1+1 protected optical interfaces VT1.5, STS-1, and STS-3c path protected channels Security level Level 2 Input syntax
RTRV-PROTNSW-rr:[TID]:[AID]:CTAG; Table 11-35 Syntax definition Field TID AID CTAG Table 11-36 AID descriptions rr value EQPT ALL DS1-slot# DS1-ALL DS3-slot# DS3-ALL EC1-slot# EC1-ALL OC3 OC3-slot# OC3-ALL AID value Purpose Equipment protection All DS1, DS3, and EC-1 equipment slot#=3 to 10 (Express) slot#=1 to 2 (Express CX) slot#=3 to 10 (Express) slot#=1 to 2 (Express CX) slot#=3 to 10 (Express) slot#=1 to 2 (Express CX) OC-3 equipment protection slot#=3 to 12 (Express) slot#=3 to 4 (Express CX)
continued
Purpose Target identifier Access identifier. The equipment to act on. Correlation tag
11-24 Protection switching detailed command descriptions Table 11-36 (continued) AID descriptions rr value VT1 OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts#-ALL OC3-slot#-ALL OC3-ALL AID value Purpose VT1 path protection slot#=3 to 12 (Express) slot#=3 to 4 (Express CX) sts#=1 to 3 vtg# = 1 to 7 vt# 1 to 4 STS-1 path protection slot#=3 to 12 (Express) slot#=3 to 4 (Express CX) sts#=1 to 3 STS-3c path protection slot#=3 to 12
STS1 OC3-slot#-sts# OC3-slot#-ALL OC3-ALL STS3C OC3-slot# OC3-ALL Example input
Retrieve the protection switching status for the slot 5 DS1 mapper in the Seattle network element:
RTRV-PROTNSW-EQPT:SEATTLE:DS1-5:CTAG;

<aid>:<SWSTATUS=status>, <SWEND=END>, <SWREASON=REASON> Table 11-37 Response parameter descriptions Parameter SWSTATUS Valid values MAN LOCKOUT AUTO FRCD IDLE SWEND REMOTE Description Manual switch by user Lockout by user Autonomous switch by network element Forced switch by user No switch The switch is initiated at the far end. Applicable to protection such as SONET APS where the protocol requires negotiation of switch requests between network elements. (Currently only OC-3 line switching.)
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-25 Table 11-37 (continued) Response parameter descriptions Parameter SWEND (continued) Valid values LOCAL Description The switch is initiated by the local network element. All equipment and path switches are always locally initiated. OC-3 line switches are LOCAL when a failure is detected on the local network element or if the user request is initiated locally. Signal OK Signal/path/line/equipment is able to carry traffic Signal Fail Autonomous switch due to complete line/path failure (OC-3 line or path switching only) Signal Degrade Autonomous switch due to line/path signal degrade condition (OC-3 line or path switching only) Excessive BIP error Autonomous switch due to excessive BIP error (OC-3 line and path switching) Equipment Fail Autonomous switch due to equipment failure (DS1/DS3/EC-1 equipment or OC-3 line switching) Facility OOS OC-3 line autonomous switch due to facility OOS Equipment OOS OC-3 line autonomous switch due to OC-3 equipment OOS Oscillation Autonomous switch locked onto working or protection OC-3 line due to switch oscillation control by OC-3 firmware Wait to restore Autonomous switch active because the wait to restore period has not yet expired (DS1 equipment only)
SWREASON
SIGOK
SF
SD
EBER
EQPFL
FACOOS
EQPOOS
OSC
WTR
SCHED-EX-OC3
The Schedule Exerciser OC-3 command is used to schedule the exerciser to test the different protection mechanisms associated with OC-3 line switching. The high-speed exerciser is a routine that tests the integrity of the protection switching bytes (K-bytes) communication between an OC-3 pair configured in a linear 1+1 protected system. If the two ends fail to exchange the K-bytes, the exerciser will fail and the protection channel match fail alarm is raised. The exerciser can run automatically on a predetermined schedule, or it can be initiated manually. The exerciser runs on a pair of OC-3 circuit packs or on all OC-3 circuit packs in the shelf that are in an in-service state. The exerciser is the lowest priority user command and does not run if a higher priority feature or command is in effect. Security level Level 3 Input syntax
SCHED-EX-OC3:[TID]:AID:CTAG::[invl],[statm],[numinvl], [reptmode]; Table 11-38 Syntax definition Field TID AID CTAG INVL STATM NUMINVL REPTMODE Purpose Target identifier Access identifier. The OC-3 to act on. Correlation tag Interval between the running of the exerciser. See the Parameter descriptions table for details. Start time for the exerciser schedule. See the Parameter descriptions table for details. Number of intervals over which exerciser is to be run. See the Parameter descriptions table for details. Report mode, determines whether the results of all exercises or only failed exercises are reported. See the Parameter descriptions table for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Protection switching detailed command descriptions 11-27 Table 11-39 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL Purpose Identify the OC-3 facility where slot#= 3 to 12 (Express) slot#= 3 to 4 (Express CX)
Table 11-40 Parameter descriptions Parameter Valid Values Unit DAY HR MIN Run the exerciser once every x days Run the exerciser once every x hours Run the exerciser once every x minutes If no parameter is entered, the default is once every 24 hours. Description
Value invl (interval between 1 to 3 the exerciser) 1 to 5 5 to 30 null statm (start time)
HOD-MOH Hour of day, minute of hour to start the where HOD is from exerciser 0 to 23, and HOM is from 0 to 59 null If no parameter is entered, the default is the current time of day. the exerciser runs the specified number of times; a value of 0 stops the exerciser If no parameter is entered, the exerciser runs indefinitely, until it is stopped or rescheduled by another command. Report results of all exercises Report results of failed exercises If no value is entered, the default is FAIL.
numinvl (number of intervals to run the exerciser)
1 to 250 null
reptmode (report mode)
ALL FAIL null
Example input
Schedule the exerciser to run on network element Seattle, 3 times, every day at 10 am, and to report the results of all exercises:
SCHED-EX-OC3:SEATTLE:OC3-11:CTAG12::1DAY,10-0,3,ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
12-1
Performance monitoring detailed command descriptions
12-
This chapter is an alphabetical summary of the TL1 commands related to performance monitoring. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command INIT-REG-ALL INIT-REG-EC1 INIT-REG-OC3 INIT-REG-STS1 INIT-REG-STS3C INIT-REG-T1 INIT-REG-T3 RTRV-PM-ABORT RTRV-PM-ALL RTRV-PM-EC1 RTRV-PM-OC3 RTRV-PM-STS1 RTRV-PM-STS3C RTRV-PM-T1 RTRV-PM-T3 RTRV-TH-ALL
continued
Page 12-3 12-7 12-11 12-15 12-20 12-24 12-29 12-33 12-34 12-39 12-43 12-47 12-52 12-56 12-60 12-64
12-2 Performance monitoring detailed command descriptions Command RTRV-TH-EC1 RTRV-TH-OC3 RTRV-TH-STS1 RTRV-TH-STS3C RTRV-TH-T1 RTRV-TH-T3 SET-TH-ALL SET-TH-EC1 SET-TH-OC3 SET-TH-STS1 SET-TH-STS3C SET-TH-T1 SET-TH-T3 Page 12-67 12-70 12-73 12-76 12-79 12-82 12-85 12-87 12-90 12-93 12-96 12-99 12-102
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-3
INIT-REG-ALL
The Initialize Registers All command instructs a network element to clear the performance monitoring data registers for all facilities (OC-3, EC-1, STS-1, STS-3c, DS1, and DS3). To initialize registers for individual facilities use the INIT-REG-<FACTYPE> commands. The AID for this command is always ALL. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the PM registers for all facilities and parameters for the current 15-minute accumulation period will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 2 Input syntax
INIT-REG-ALL:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn], [tmper],[mondat],[montm],[index];
12-4 Performance monitoring detailed command descriptions Table 12-1 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Table 12-2 AID descriptions AID type ALL Command-specific values ALL Purpose All facilities (OC-3, EC-1, STS-1, STS-3c, DS1, DS3) Purpose Target identifier Access identifier, The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
Table 12-3 Parameter descriptions Parameter montype monval locn Possible values null ALL null 0 null NEND FEND Description Default: equivalent to ALL All applicable montypes Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-5 Table 12-3 (continued) Parameter descriptions Parameter dirn Possible values null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Description Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods
tmper
Note 1: If index is used, mondat and montm cannot be used. Note 2: If tmper = 1UNT, mondat is not applicable.
montm null ALL HOD-MOH Grouping allowed Default: start of current 15-MIN All beginning times available Hour of day-minute of hour Mondat and montm can be used as a pair.
Note 1: If index is used, mondat and montm cannot be used. Note 2: If tmper=1-UNT or tmper=1-DAY, montm is not applicable.
index null 0 1-32 ALL Grouping and ranges allowed Default: equivalent to 0 Current interval Previous intervals (see Note) All available intervals If mondat and montm are used, index cannot be used.
Note: For tmper=15-MIN, index=1 is the most recently completed 15-minute interval, index=2 is the interval before that. For tmper=1-DAY, index=1 is the most recently completed day interval (yesterday).
12-6 Performance monitoring detailed command descriptions
Example input Initialize all 15-minute and 1-day registers on the network element, specifying mondat and montm:
INIT-REG-ALL:NEWYORK:ALL:CTAG23::,,,,15-MIN&1-DAY, ALL,ALL;
Initialize all registers on the network element, specifying all intervals:

INIT-REG-ALL:SEATTLE:ALL:CTAG23::,,,,ALL,,,ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
INIT-REG-EC1
The Initialize Register EC1 command instructs a network element to initialize performance monitoring data for an EC-1 facility. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the current 15-min PM registers for all parameters for the corresponding facility will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 2 Input syntax
INIT-REG-EC1:[TID]:AID:CTAG::[montype],[monval],[locn], [dirn],[tmper],[mondat],[montm],[index];
12-8 Performance monitoring detailed command descriptions Table 12-4 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Table 12-5 AID descriptions AID type EC1 AID Command-specific values EC1-slot# EC1-ALL ALL Purpose Identify the EC-1 facilities where slot# =3, 5, 7, or 9 (Express) slot# = 1 (Express CX) Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-9 Table 12-6 Parameter descriptions Parameter montype Possible values NULL CVS ESS SESS SEFSS Description Default: equivalent to ALL Coding Violations - Section Errored Seconds - Section Severely Errored Seconds Section Severely Errored Frame Seconds - Section Coding Violations - Line Errored Seconds - Line Failure Count - Line Severely Errored Seconds - Line Unavailable Seconds - Line All applicable montypes
CVL ESL FCL SESL UASL ALL Grouping allowed monval locn null 0 null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed
Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-min 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair.
continued
12-10 Performance monitoring detailed command descriptions Table 12-6 (continued) Parameter descriptions Parameter montm Possible values null ALL HOD-MOH Grouping allowed Description Default: start of current 15-MIN All beginning times available Hour of day-minute of hour Mondat and montm can be used as a pair.
Note 1: If index is used mondat and montm cannot be used. Note 2: If tmper=1-UNT or tmper=1-DAY, montm is not applicable.
index null 0 1-32 ALL Default: equivalent to 0 Current interval Previous intervals (see Note) All available intervals
Grouping and ranges allowed If mondat or montm is used, index cannot be used.
Example input
Initialize the PM data at NEWYORK on EC-1 in slot 3 for section coding violations (CVS) for current 15-minute bins:
INIT-REG-EC1:NEWYORK:EC1-3:CTAG12::CVS;
Initialize the PM data at WASHINGTON on all EC-1 slots for line unavailable seconds (UASL), specifying mondat and montm for current 15-minute bins:
INIT-REG-EC1:WASHINGTON:EC1-ALL:CTAG12::UASL,,,,,12-25,09-00;
Initialize the PM data at SEATTLE on all EC-1 facilities for line severely errored seconds (SESL) for the current 1-day bin, at the receive direction only:
INIT-REG-EC1:SEATTLE:ALL:CTAG12::SESL,,NEND,RCV,1-DAY;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
INIT-REG-OC3
The Initialize Register OC-3 command instructs a network element to initialize performance monitoring data for an OC-3 facility. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the current 15-min PM registers for all parameters for the corresponding facility will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 2 Input syntax
INIT-REG-OC3:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn], [tmper],[mondat],[montm],[index];
12-12 Performance monitoring detailed command descriptions Table 12-7 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Table 12-8 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL ALL Purpose Identify the OC-3 where slot# =3 to 12 (Express) slot# = 3 to 4 (Express CX) All OC-3 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-13 Table 12-9 Parameter descriptions Parameter montype Possible values null CVS ESS SESS SEFSS Description Default: equivalent to ALL Coding Violations - Section Errored Seconds - Section Severely Errored Seconds - Section Severely Errored Frame Seconds Section Coding Violations - Line Errored Seconds - Line Failure Count - Line Severely Errored Seconds - Line Unavailable Seconds - Line All applicable montypes
CVL ESL FCL SESL UASL ALL Grouping allowed monval locn null 0 null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed
Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair.
continued
index null 0 1-32 ALL Grouping and ranges allowed Default: equivalent to 0 Current interval Previous intervals (see Note) All available intervals If mondat or montm is used, index cannot be used.
Example input
Initialize the PM data for near-end receive line coding violations for OC-3 slot 11, for all intervals, all mondat and montm (that is, all current and historical information):
INIT-REG-OC3:SEATTLE:OC3-11:CTAG12::CVL,,NEND,RCV, ALL,ALL,ALL;
Initialize the PM data for all monitored parameters for OC-3 slot 11, for all intervals, specifying all intervals:
INIT-REG-OC3:NEWYORK:OC3-11:CTAG12::,,,,ALL,,,ALL;
Initialize all current 15-minute registers for all OC-3 facilities:

INIT-REG-OC3:WASHINGTON:ALL:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
INIT-REG-STS1
The Initialize Register STS1 command instructs a network element to initialize performance monitoring data for the STS-1 facility. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the current 15-min PM registers for all parameters for the corresponding facility will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Note: STS-1 facilities can exist on both OC-3 and EC-1 equipment. Security level Level 2
Input syntax
INIT-REG-STS1:[TID]:AID:CTAG::[montype],[monval],[locn], [dirn],[tmper],[mondat],[montm],[index]; Table 12-10 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-17 Table 12-11 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL OC3-ALL Purpose Identify the STS-1 facilities on the OC-3 interfaces where slot# =3 to 12 (Express) slot# = 3 to 4 (Express CX) sts# = 1 to 3 EC1-slot#-sts# EC-1-slot# EC1-ALL Identify the STS-1 facilities on the EC-1 circuit packs where slot# =3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts# = 1 to 3 ALL Table 12-12 Parameter descriptions Parameter montype Possible values NULL CVP ESP SESP ALSP UASP FCP ALL Grouping allowed monval locn null 0 null NEND FEND null TRMT RCV
continued
All applicable STS-1 facilities
Description Default: equivalent to ALL Coding Violations - Path Errored Seconds - Path Severely Errored Seconds Path AIS/LOP Seconds - Path Unavailable Seconds - Path Failure Count - Path All applicable montypes Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only
dirn
12-18 Performance monitoring detailed command descriptions Table 12-12 (continued) Parameter descriptions Parameter tmper Possible values null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Description Default: equivalent to 15-min 15 minute interval Day interval Untimed interval All available time periods
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-19 Example input
Initialize the PM data at NEWYORK on OC-3 in slot 3, sts 2, for path errored seconds (ESP) for the current 15-minute bin:
INIT-REG-STS1:NEWYORK:OC3-3-2:CTAG12::ESP;
Initialize the PM data at WASHINGTON on all EC-1 slots for path severely errored seconds (SESP), specifying mondat and montm for 15-minute bins:
INIT-REG-STS1:WASHINGTON:EC1-ALL:CTAG12:SESP,,,,,12-25,09-00;
Initialize the PM data at SEATTLE on all OC-3 and EC-1 facilities for path failure count (FCP), at the near-end receive direction only for the current 1-day bin:
INIT-REG-STS1:SEATTLE:ALL:CTAG12::FCP,,NEND,RCV,1-DAY;
INIT-REG-STS3C
The Initialize Register STS3C command instructs a network element to initialize performance monitoring data for the STS-3c facility. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the current 15-min PM registers for all parameters for the corresponding facility will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Note: STS-3c facilities can only exist on OC-3 equipment. Security level Level 2 Input syntax
INIT-REG-STS3C:[TID]:AID:CTAG::[montype],[monval],[locn], [dirn],[tmper],[mondat],[montm],[index];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-21 Table 12-13 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Table 12-14 AID descriptions AID type STS3C AID Command-specific values OC3-slot# OC3-ALL ALL Purpose Identify the OC-3s where slot# =3 to 12 All OC-3 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
12-22 Performance monitoring detailed command descriptions Table 12-15 Parameter descriptions Parameter montype Possible values NULL CVP ESP SESP ALSP UASP FCP ALL Grouping allowed monval locn null 0 null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Description Default: equivalent to ALL Coding Violations - Path Errored Seconds - Path Severely Errored Seconds Path AIS/LOP Seconds - Path Unavailable Seconds - Path Failure Count - Path All applicable montypes Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-min 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-23 Table 12-15 (continued) Parameter descriptions Parameter montm Possible values null ALL HOD-MOH Grouping allowed Description Default: start of current 15-MIN All beginning times available Hour of day-minute of hour Mondat and montm can be used as a pair.
Example input
Initialize the PM data at NEWYORK on OC-3 in slot 3 for path errored seconds (ESP) for the current 15-minute bin:
INIT-REG-STS3C:NEWYORK:OC3-3:CTAG12::ESP;
Initialize the PM data at WASHINGTON on all OC-3 slots for STS-3c path severely errored seconds (SESP), specifying mondat and montm for 15-minute bins:
INIT-REG-STS3C:WASHINGTON:OC3-ALL:CTAG12:SESP,,,,,12-25,09-00;
Initialize the PM data at SEATTLE on all OC-3 facilities for STS-3c path failure count (FCP), at the near-end receive direction only for the current 1-day bin:
INIT-REG-STS3C:SEATTLE:ALL:CTAG12::FCP,,NEND,RCV,1-DAY;
INIT-REG-T1
The Initialize Registers T1 command instructs a network element to initialize performance monitoring data for the DS1 facility. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the current 15-min PM registers for all parameters for the corresponding facility will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 2 Input syntax
INIT-REG-T1:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn], [tmper],[mondat],[montm],[index];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-25 Table 12-16 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Table 12-17 AID descriptions AID type T1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL DS1-ALL Purpose Identify the DS1s where Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1, port# = 1 to 12 slot# = 3, port# = 1 to 8 ALL All DS1 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
12-26 Performance monitoring detailed command descriptions Table 12-18 Parameter descriptions Parameter montype Possible values null CVL ESL SESL CVP ESP FCP SESP SEFSP SASP CSSP UASP ALL Grouping allowed monval locn null 0 null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed
continued
Description Default: equivalent to ALL Coding Violations - Line Errored Seconds - Line Severely Errored Seconds- Line Coding Violations - Path Errored Seconds - Path Failure Count - Path Severely Errored Seconds Path Severely Errored Frame Seconds - Path SEF / AIS Seconds - Path Controlled slip seconds - Path Unavailable Seconds - Path All applicable montypes
Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-min 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-27 Table 12-18 (continued) Parameter descriptions Parameter mondat Possible values null ALL MOY-DOM Grouping allowed Description Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair.
12-28 Performance monitoring detailed command descriptions Example input
Initialize the PM data for near-end receive line coding violations for DS1 slot 4 port 7, for all intervals, specifying ALL mondat and ALL montm (that is, all current and historical bins):
INIT-REG-T1:NEWYORK:DS1-4-7:CTAG12::CVL,,NEND,RCV,ALL,ALL,ALL;
Initialize the PM data for all monitored parameters for DS1 slot 4 port 7, for all intervals, specifying all time periods:
INIT-REG-T1:SEATTLE:DS1-4-7:CTAG12::,,,,15-MIN&1-DAY&1-UNT,,,A LL;
Initialize all current 15-minute registers for all T1 facilities:

INIT-REG-T1:WASHINGTON:ALL:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
INIT-REG-T3
The Initialize Registers T3 command instructs a network element to initialize performance monitoring data for the DS3 facility. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. If all optional parameters are left blank, all of the current 15-min PM registers for all parameters for the corresponding facility will be cleared at once. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 2 Input syntax
INIT-REG-T3:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn], [tmper],[mondat],[montm],[index];
12-30 Performance monitoring detailed command descriptions Table 12-19 Syntax definition Field TID AID CTAG montype monval locn dirn tmper mondat montm index Table 12-20 AID descriptions AID type T3 AID Command-specific values DS3-slot# DS3-ALL ALL Purpose Identify the DS3s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All DS3 facilities Purpose Target identifier Access identifier. The facility to which the command applies Correlation tag The type of monitored parameter for which a value is requested The value the registers should be initialized to The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be accessed
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-31 Table 12-21 Parameter descriptions Parameter montype Possible values null CVL ESL SESL CVP ESP FCP SESP SASP UASP ALL Grouping allowed monval locn null 0 null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Default: equivalent to 0 Reset registers to zero Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-min 15 minute interval Day interval Untimed interval All available time periods Description Default: equivalent to ALL Coding Violations - Line Errored Seconds - Line Severely Errored Seconds- Line Coding Violations - Path Errored Seconds - Path Failure Count - Path Severely Errored Seconds Path SEF / AIS Seconds - Path Unavailable Seconds - Path All applicable montypes
dirn
tmper
continued
Example input
Initialize the PM data at NEWYORK on DS3 in slot 3 for path coding violations (CVP) for the current 15-minute bin:
INIT-REG-T3:NEWYORK:DS3-3:CTAG12::CVP;
Initialize the PM data at WASHINGTON on all DS3 slots for path unavailable seconds (UASP), specifying mondat and montm:
INIT-REG-T3:WASHINGTON:DS3-ALL:CTAG12::UASP,,,,,12-25,09-00;
Initialize the PM data at SEATTLE on all DS3 facilities for path severely errored seconds (SESP), at the near-end receive direction only for the current 1-day bin:
INIT-REG-T3:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-PM-ABORT
The Retrieve Performance Monitoring Abort command allows you to abort the active retrieve (RTRV-PM) command. If the retrieve command completes before the abort command is processed by the system, there is no impact. Security level Level 1 Input syntax
RTRV-PM-ABORT:[tid]::ctag; Table 12-22 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Abort the active retrieve PM command at NEWYORK:

RTRV-PM-ABORT:NEWYORK::123;
RTRV-PM-ALL
The Retrieve Performance Monitoring All command instructs a network element to send its set of all performance monitoring (PM) data to the current TL1 session immediately. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1 Input syntax
RTRV-PM-ALL:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-35 Table 12-23 Syntax definition Field TID AID CTAG montype Purpose Target identifier Access identifier. The facility to which the command is directed. Correlation tag The type of monitored parameter for which a value is requested. A null value requests all types of monitored parameters to be retrieved. Parameter grouping may be used. With multiple AIDs, the register(s) specified pertains to each AID specified. The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
monlev locn dirn tmper mondat montm index Table 12-24 AID descriptions AID type ALL
Command-specific values ALL
Purpose All facilities
Table 12-25 Parameter descriptions Parameter montype monlev Possible values null ALL null 0-UP 1-UP Description Default: equivalent to ALL All applicable montypes Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only
continued
12-36 Performance monitoring detailed command descriptions Table 12-25 (continued) Parameter descriptions Parameter locn Possible values null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Description Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-min 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
montm null ALL HOD-MOH Grouping allowed Default: Use index All beginning times available Hour of day-minute of hour Mondat and montm can be used as a pair.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Retrieve all non-zero 15-minute and 1-day registers on the network element, specifying mondat and montm:
RTRV-PM-ALL:NEWYORK:ALL:CTAG12::,,,,15-MIN&1-DAY,ALL,ALL;
Retrieve all non-zero 15-minute and 1-day registers on the network element, specifying all intervals:
RTRV-PM-ALL:SEATTLE:ALL:CTAG12::,,,,15-MIN&1-DAY,,,ALL;
Retrieve all current 15-minute registers:

RTRV-PM-ALL:WASHINGTON:ALL:CTAG12::,0-UP;

<aid>,<aidtype>:<montype>,<monval>,<vldty>,<locn>,<dirn>, <tmper>,<mondat>,<montm>,<index> Table 12-26 Response block parameter descriptions Parameter AID Possible values OC3-slot# (ALL) EC1-slot# (ALL) EC1-slot# (ALL) OC3-slot#-sts (ALL) DS3-slot# (ALL) DS1-slot#-port# (ALL) OC3, EC1, STS1, STS3C, T1, T3 See montype parameter in parameter description tables for RTRV-PM-OC3 RTRV-PM-EC1 RTRV-PM-STS1 RTRV-PM-STS3C RTRV-PM-T1 RTRV-PM-T3 Integer from 0 - (232 -1 ) COMPL PRTL ADJ
continued
Description
AIDtype montype
monval vldty
Value counted from 0 to 4,294,967,295 or (232 - 1) Interval complete Interval incomplete (partial) current time period was cut short The register data is suspect
12-38 Performance monitoring detailed command descriptions Table 12-26 (continued) Response block parameter descriptions Parameter locn dirn tmper Possible values NEND FEND TRMT RCV 15-MIN 1-DAY 1-UNT MOY-DOM HOD-MOH 0 1-32 Description Near end Far end Transmit direction only Receive direction only 15 minute interval Day interval Untimed interval Month of year-day of month Hour of day-minute of hour Current interval Previous intervals (see Note)
mondat montm index
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-PM-EC1
The Retrieve Performance Monitoring EC1 command instructs a network element to send its current set of EC-1 performance monitoring (PM) data to the current TL1 session. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1 Input syntax
RTRV-PM-EC1:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];
12-40 Performance monitoring detailed command descriptions Table 12-27 Syntax definition Field TID AID CTAG montype monlev locn dirn tmper mondat montm index Table 12-28 AID descriptions AID type EC1 AID Command-specific values EC1-slot# EC1-ALL ALL Purpose Identify the EC-1s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All EC-1 facilities Purpose Target identifier, the network element to which the command is directed Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-41 Table 12-29 Parameter descriptions Parameter montype Possible values null CVS ESS SESS SEFSS CVL ESL SESL UASL FCL ALL Grouping allowed monlev null 0-UP 1-UP null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods Description Default: equivalent to ALL Coding Violations - Section Errored Seconds - Section Severely Errored Seconds - Section Severely Errored Frame Seconds Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds- Line Unavailable Seconds - Line Frame Count - Line All applicable montypes
locn
dirn
tmper
continued
Grouping and ranges If mondat or montm is used, index cannot be used. allowed
Example input
Retrieve the non-zero PM data at NEWYORK on EC-1 in slot 3 for section coding violations (CVS) for current 15-minute bin:
RTRV-PM-EC1:NEWYORK:EC1-3:CTAG12::CVS;
Retrieve the non-zero PM data for 15-minute bins at WASHINGTON on all EC-1 slots for line unavailable seconds (UASL), specifying mondat and montm:
RTRV-PM-EC1:WASHINGTON:EC1-ALL:CTAG12::UASL,,,,,12-25,09-00;
Retrieve the non-zero PM data at SEATTLE on all EC-1 facilities for line severely errored seconds (SESL), at the near-end receive direction only for current 1-day bin:
RTRV-PM-EC1:SEATTLE:ALL:CTAG12::SESL,,NEND,RCV,1-DAY;

<aid>,<aidtype>:<montype>,<monval>,<vldty>,<locn>,<dirn>, <tmper>,<mondat>,<montm>,<index>
See Table 12-26 for a description of the response block parameters.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-PM-OC3
The Retrieve Performance Monitoring OC3 command instructs a network element to send its current set of OC-3 performance monitoring (PM) data to the current TL1 session. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1 Input syntax
RTRV-PM-OC3:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];
12-44 Performance monitoring detailed command descriptions Table 12-30 Syntax definition Field TID AID CTAG montype monlev locn dirn tmper mondat montm index Table 12-31 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL ALL Purpose Identify the OC-3s where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) All OC-3 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-45 Table 12-32 Parameter descriptions Parameter montype Possible values null CVS ESS SESS SEFSS CVL ESL SESL UASL FCL ALL Grouping allowed monlev null 0-UP 1-UP null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods Description Default: equivalent to ALL Coding Violations - Section Errored Seconds - Section Severely Errored Seconds Section Severely Errored Frame Seconds - Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds- Line Unavailable Seconds - Line Frame Count - Line All applicable montypes
locn
dirn
tmper
continued
Grouping and ranges allowed If mondat or montm is used, index cannot be used.
Example input
Retrieve all PM data at NEWYORK for near-end receive line coding violations (CVL) for OC-3 slot 11, for all intervals, specifying ALL mondat and ALL montm:
RTRV-PM-OC3:NEWYORK:OC3-11:CTAG12::CVL,0-UP,NEND,RCV, ALL,ALL,ALL;
Retrieve all current 15-minute registers at WASHINGTON for all OC-3 facilities:
RTRV-PM-OC3:WASHINGTON:ALL:CTAG12::,0-UP;

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-PM-STS1
The Retrieve Performance Monitoring STS1 command instructs a network element to send its current set of STS-1 Performance Monitoring (PM) data to the current TL1 session. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1
Input syntax
RTRV-PM-STS1:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index]; Table 12-33 Syntax definition Field TID AID CTAG montype monlev locn dirn tmper mondat montm index Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-49 Table 12-34 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL OC3-ALL Purpose Identify the STS-1 facilities on the OC-3 interfaces where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) sts# = 1 to 3 EC1-slot#-sts# EC1-slot# EC1-ALL Identify the STS-1 facilities on the EC-1 circuit packs where slot# =3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts# = 1 to 3 ALL Table 12-35 Parameter descriptions Parameter montype Possible values null CVP ESP SESP ALSP UASP FCP ALL Grouping allowed monlev null 0-UP 1-UP null NEND FEND null TRMT RCV Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only
continued
All applicable STS-1 facilities
Description Default: equivalent to ALL Coding Violations - Path Errored Seconds - Path Severely Errored Seconds - Path AIS/LOP second - Path Unavailable Seconds - Path Failure Count - Path All applicable montypes
locn
dirn
12-50 Performance monitoring detailed command descriptions Table 12-35 (continued) Parameter descriptions Parameter tmper Possible values null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Description Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Retrieve the non-zero PM data at NEWYORK on EC-1 in slot 3 for path coding violations (CVP) for the current 15-minute bin:
RTRV-PM-STS1:NEWYORK:EC1-3:CTAG12::CVP;
Retrieve the non-zero PM data for 15-minute bins at WASHINGTON on all EC-1 slots for path failure count (FCP), specifying mondat and montm:
RTRV-PM-STS1:WASHINGTON:EC1-ALL:CTAG12::FCP,,,,,12-25,09-00;
Retrieve the non-zero PM data at SEATTLE on all OC-3 and EC-1 facilities for path severely errored seconds (SESP), at the near-end receive direction only for the current 1-day bin:
RTRV-PM-STS1:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;

RTRV-PM-STS3C
The Retrieve Performance Monitoring STS3C command instructs a network element to send its current set of STS-3c Performance Monitoring (PM) data to the current TL1 session. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1 Input syntax
RTRV-PM-STS3C:[TID]:AID:CTAG::[montype],[monlev],[locn], [dirn],[tmper],[mondat],[montm],[index];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-53 Table 12-36 Syntax definition Field TID AID CTAG montype monlev locn dirn tmper mondat montm index Table 12-37 AID descriptions AID type STS3C AID Command-specific values OC3-slot# OC3-ALL ALL Purpose Identify the OC-3s where slot# =3 to 12 All OC-3 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
12-54 Performance monitoring detailed command descriptions Table 12-38 Parameter descriptions Parameter montype Possible values null CVP ESP SESP ALSP UASP FCP ALL Grouping allowed monlev null 0-UP 1-UP null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods Description Default: equivalent to ALL Coding Violations - Path Errored Seconds - Path Severely Errored Seconds - Path AIS/LOP second - Path Unavailable Seconds - Path Failure Count - Path All applicable montypes
locn
dirn
tmper
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Example input
Retrieve the non-zero PM data at NEWYORK on OC-3 in slot 3 for STS-3c path coding violations (CVP) for the current 15-minute bin:
RTRV-PM-STS3C:NEWYORK:OC3-3:CTAG12::CVP;
Retrieve the non-zero PM data at WASHINGTON on all OC-3 slots for STS-3c path failure count (FCP), specifying mondat and montm:
RTRV-PM-STS3C:WASHINGTON:OC3-ALL:CTAG12::FCP,,,,,12-25,09-00;
Retrieve the non-zero PM data at SEATTLE on all OC-3 facilities for STS-3c path severely errored seconds (SESP), at the near-end receive direction only for the current 1-day bin:
RTRV-PM-STS3C:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;

RTRV-PM-T1
The Retrieve Performance Monitoring T1 command instructs a network element to send the specified set of DS1 Performance Monitoring (PM) data to the current TL1 session. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1 Input syntax
RTRV-PM-T1:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-57 Table 12-39 Syntax definition Field TID AID CTAG montype monlev locn dirn tmper mondat montm index Table 12-40 AID descriptions AID type T1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL DS1-ALL Purpose Identify the DS1s where Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1, port# = 1 to 12 slot# = 3, port# = 1 to 8 ALL All DS1 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
12-58 Performance monitoring detailed command descriptions Table 12-41 Parameter descriptions Parameter montype Possible values null CVL ESL SESL CVP ESP FCP SEFSP SESP SASP CSSP UASP ALL Grouping allowed monlev null 0-UP 1-UP null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods Description Default: equivalent to ALL Coding Violations - Line Errored Seconds - Line Severely Errored Seconds - Line Coding Violations - Path Errored Seconds - Path Failure Count - Path Severely Errored Frame Seconds - Path Severely Errored Seconds - Path SEF / AIS Seconds - Path Controlled slip seconds - Path Unavailable Seconds - Path All applicable montypes
locn
dirn
tmper
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Example input
Retrieve all the PM data for near-end receive line coding violations for DS1 slot 4 port 7, for all intervals, specifying ALL mondat and ALL montm:
RTRV-PM-T1:NEWYORK:DS1-4-7:CTAG12::CVL,0-UP,NEND,RCV, ALL,ALL,ALL;
Retrieve all current 15-minute registers for all T1 facilities:

RTRV-PM-T1:SEATTLE:ALL:CTAG12::,0-UP;
Retrieve all non-zero T1 registers for April:

RTRV-PM-T1:WASHINGTON:ALL:CTAG12::,,,,,04-00;

RTRV-PM-T3
The Retrieve Performance Monitoring T3 command instructs a network element to send its current set of DS3 Performance Monitoring (PM) data to the current TL1 session. PM data is kept in separate monitored parameter registers or bins for each passed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify the interval by using <index>. If you specify <mondat>, <montm>, or both, you cannot specify <index>. Current intervals are indicated by index=0, and older periods have higher numbers. If you specify <index>, you cannot specify <mondat> or <montm>. Note: The accumulation intervals that are stored are as follows: the current 15-minute and 32 previous 15-minute intervals, the current day and previous day, and an untimed interval. Several parameters can be grouped. To group parameters, use the ampersand (&) as the separator. To use a range of parameters, use two ampersands (&&) between the parameters. For example, to use a range of index intervals from 5 to 12, enter 5&&12 as the index parameter. Security level Level 1 Input syntax
RTRV-PM-T3:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-61 Table 12-42 Syntax definition Field TID AID CTAG montype monlev locn dirn tmper mondat montm index Table 12-43 AID descriptions AID type T3 AID Command-specific values DS3-slot# DS3-ALL ALL Purpose Identify the DS3s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All DS3 facilities Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The type of monitored parameter for which a value is requested The discriminating level for reported monitored parameters The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information The date of the beginning of the requested PM period The beginning time of day of the requested PM period The interval numbers to be retrieved
12-62 Performance monitoring detailed command descriptions Table 12-44 Parameter descriptions Parameter montype Possible values null CVL ESL SESL CVP ESP FCP SESP SASP UASP ALL Grouping allowed null 0-UP 1-UP null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed mondat null ALL MOY-DOM Grouping allowed Default: Current date All dates available Month of year-day of month Mondat and montm can be used as a pair. Description ALL Coding Violations - Line Errored Seconds - Line Severely Errored Seconds - Line Coding Violations - Path Errored Seconds - Path Failure Count - Path Severely Errored Seconds - Path SEF / AIS Seconds - Path Unavailable Seconds - Path All applicable montypes Default: equivalent to 1-UP All monitored parameter bins Non-zero bins only Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: equivalent to 15-MIN 15 minute interval Day interval Untimed interval All available time periods
monlev
locn
dirn
tmper
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Example input
Retrieve the non-zero PM data at NEWYORK on DS3 in slot 3 for path coding violations (CVP) for the current 15-minute bin:
RTRV-PM-T3:NEWYORK:DS3-3:CTAG12::CVP;:
Retrieve the non-zero PM data for 15-minute bins at WASHINGTON on all DS3 slots for path unavailable seconds (UASP), specifying mondat and montm:
RTRV-PM-T3:WASHINGTON:DS3-ALL:CTAG12::UASP,,,,,12-25,09-00;
Retrieve the non-zero PM data at SEATTLE on all DS3 facilities for path severely errored seconds (SESP), at the near-end receive direction only for the current 1-day bin:
RTRV-PM-T3:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;

RTRV-TH-ALL
The Retrieve Threshold All command instructs the network element to display the threshold levels for given PM monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-ALL:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];

Table 12-45 Syntax definition Field TID AID CTAG montype locn dirn tmper Table 12-46 AID descriptions AID type ALL Defaults Command-specific values ALL DFLT Purpose All facilities (EC-1, OC-3, STS-1, STS-3c, DS1, DS3) Default threshold setting Purpose Target identifier Access identifier. The facility to which the threshold applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-65 Table 12-47 Parameter descriptions Parameter montype locn dirn tmper Possible values null ALL NEND FEND TRMT RCV 15-MIN 1-DAY 1-UNT ALL Grouping allowed Example input Description Default: equivalent to ALL All applicable montypes Near end Far end Transmit direction only Receive direction only 15 minute interval Day interval Untimed interval All available time periods
Retrieve all thresholds:

RTRV-TH-ALL:NEWYORK:ALL:CTAG12;
Retrieve all default thresholds:

RTRV-TH-ALL:WASHINGTON:DFLT:CTAG12;
Retrieve thresholds for the 15-minute and 1-day accumulation bins:

RTRV-TH-ALL:SEATTLE:ALL:CTAG12::,,,1-DAY&15-MIN;

<aid>,<aidtype>:<montype>,<locn>,<dirn>,<thlev>,<tmper>
12-66 Performance monitoring detailed command descriptions Table 12-48 Response block parameter descriptions Parameter AID Possible values For non-DFLT AIDs: OC3-slot# (ALL) EC1-slot# (ALL) EC1-slot#-1 (ALL) OC3-slot#-sts (ALL) DS3-slot# (ALL) DS1-slot#-port# (ALL) For DFLT: OC3-DFLT EC1-DFLT EMPTY-DFLT DS3-DFLT DS1-DFLT AIDtype montype T1, T3, EC1, OC3, STS1, STS3C See montype parameter in parameter description tables for RTRV-TH-OC3, RTRV-TH-EC1, RTRV-TH-T1, RTRV-TH-T3, RTRV-TH-STS1, RTRV-TH-STS3C NEND FEND TRMT RCV 10 digit number 15-MIN 1-DAY 1-UNT Near end Far end Transmit direction only Receive direction only Restricted by montype and tmper 15 minute interval Day interval Untimed interval STS-1 defaults Description
locn dirn thlev tmper
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-TH-EC1
The Retrieve Threshold EC1 command instructs the network element to display the threshold levels for the specified EC-1 performance monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-EC1:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper]; Table 12-49 Syntax definition Field TID AID CTAG montype locn dirn tmper Purpose Target identifier Access identifier. The facility to which the threshold applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
12-68 Performance monitoring detailed command descriptions Table 12-50 AID descriptions AID type EC1 AID Command-specific values EC1-slot# EC1-ALL ALL Defaults DFLT Purpose Identify the EC-1s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All EC-1 facilities Default threshold setting
Table 12-51 Parameter descriptions Parameter montype Possible values null CVS ESS SESS SEFSS CVL ESL SESL UASL ALL Grouping allowed locn null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed Description ALL Coding Violations - Section Errored Seconds - Section Severely Errored Seconds Section Severely Errored Frame Seconds - Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds Line Unavailable Seconds - Line All applicable montypes Default: All applicable locations Near End Far End Default: All applicable directions Transmit direction only Receive direction only Default: all applicable time periods 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Retrieve the thresholds at NEWYORK on EC-1 in slot 3 for section coding violations (CVS):
RTRV-TH-EC1:NEWYORK:EC1-3:CTAG12::CVS;
Retrieve the threshold at WASHINGTON on all EC-1 facilities for line unavailable seconds (UASL), 15-minute accumulation bin:
RTRV-TH-EC1:WASHINGTON:EC1-ALL:CTAG12::UASL,,,15-MIN;
Retrieve the thresholds at SEATTLE on all EC-1 facilities for line severely errored seconds (SESL), at the near-end receive direction only, for 1-day accumulation bin:
RTRV-TH-EC1:SEATTLE:ALL:CTAG12::SESL,NEND,RCV,1-DAY;

RTRV-TH-OC3
The Retrieve Threshold OC3 command instructs the network element to display the threshold levels for specified OC-3 performance monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-OC3:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper]; Table 12-52 Syntax definition Field TID AID CTAG montype locn dirn tmper Purpose Target identifier Access identifier. The facility to which the threshold applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-71 Table 12-53 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL ALL Defaults DFLT Purpose Identify the OC-3s where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) All OC-3 facilities Default threshold setting
Table 12-54 Parameter descriptions Parameter montype Possible values null CVS ESS SESS SEFSS CVL ESL SESL UASL ALL Grouping allowed locn null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: all applicable time periods 15 minute interval Day interval Untimed interval All applicable time periods Description ALL Coding Violations - Section Errored Seconds - Section Severely Errored Seconds Section Severely Errored Frame Seconds - Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds Line Unavailable Seconds - Line All applicable montypes
dirn
tmper
Retrieve the threshold for near-end receive line coding violations for OC-3 slot 11, for the 15-minute time period:
RTRV-TH-OC3:NEWYORK:OC3-11:CTAG12::CVL,NEND,RCV,15-MIN;
Retrieve the OC-3 threshold defaults:

RTRV-TH-OC3:WASHINGTON:DFLT:CTAG12;

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-TH-STS1
The Retrieve Threshold STS1 command instructs the network element to display the threshold levels for the specified STS-1 performance monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-STS1:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper]; Table 12-55 Syntax definition Field TID AID CTAG montype locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
12-74 Performance monitoring detailed command descriptions Table 12-56 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL Purpose Identify the OC-3s where slot# =3 to 12 (Express) slot# = 3 to 4 (Express CX) sts = 1 to 3 OC3-ALL EC1-slot#-sts EC-1-slot# All OC-3 facilities Identify the EC-1s where slot# =3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts = 1 to 3 EC1-ALL ALL Defaults DFLT All EC-1 facilities All OC-3 and EC-1 facilities Default threshold setting
Table 12-57 Parameter descriptions Parameter montype Possible values null CVP ESP SESP ALSP UASP ALL Grouping allowed null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed Description ALL Coding Violations - Path Errored Seconds - Path Severely Errored Secs - Path AIS/LOP second - Path Unavailable Seconds - Path All applicable montypes Default: All applicable locations Near End Far End Default: All applicable directions Transmit direction only Receive direction only Default: all applicable time periods 15 minute interval Day interval Untimed interval All available time periods
locn
dirn
tmper
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Retrieve the thresholds for the near-end receive path code violation (CVP) on OC-3 slot 3, sts2, for the 15-minute time period:
RTRV-TH-STS1:NEWYORK:OC3-3-2:CTAG12::CVP,NEND,RCV,15-MIN;
Retrieve the STS1 threshold defaults:

RTRV-TH-STS1:WASHINGTON:DFLT:CTAG12;
Note: When the STS-1 default thresholds are displayed, the output AID is shown as EMPTY-DFLT. The STS-1 threshold defaults are common to both OC-3 and EC-1 equipment. Response block syntax
RTRV-TH-STS3C
The Retrieve Threshold STS3C command instructs the network element to display the threshold levels for the specified STS-3c performance monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-STS3C:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];

Table 12-58 Syntax definition Field TID AID CTAG montype locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-77 Table 12-59 AID descriptions AID type STS3C AID Command-specific values OC3-slot# OC3-ALL ALL Defaults DFLT Purpose Identify the OC-3s where slot# =3 to 12 All OC-3 facilities Default threshold setting
Table 12-60 Parameter descriptions Parameter montype Possible values null CVP ESP SESP ALSP UASP ALL Grouping allowed null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed Description ALL Coding Violations - Path Errored Seconds - Path Severely Errored Secs - Path AIS/LOP second - Path Unavailable Seconds - Path All applicable montypes Default: All applicable locations Near End Far End Default: All applicable directions Transmit direction only Receive direction only Default: all applicable time periods 15 minute interval Day interval Untimed interval All available time periods
locn
dirn
tmper
Retrieve the thresholds for the near-end receive STS-3c path code violation (CVP) on OC-3 slot 3, for the 15-minute time period:
RTRV-TH-STS3C:NEWYORK:OC3-3:CTAG12::CVP,NEND,RCV,15-MIN;
Retrieve the STS-3c threshold defaults:

RTRV-TH-STS3C:WASHINGTON:DFLT:CTAG12;

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-TH-T1
The Retrieve Threshold T1 command instructs the network element to display the threshold levels for the specified DS1 performance monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-T1:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];

Table 12-61 Syntax definition Field TID AID CTAG montype locn dirn tmper Purpose Target identifier Access identifier. The facility to which the command applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
12-80 Performance monitoring detailed command descriptions Table 12-62 AID descriptions AID type T1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL DS1-ALL Purpose Identify the DS1s where Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1, port# = 1 to 12 slot# = 3, port# = 1 to 8 ALL Defaults DFLT All DS1 facilities Default threshold setting
Table 12-63 Parameter Descriptions Parameter montype Possible values null CVL ESL SESL CVP ESP SEFSP SESP SASP CSSP UASP ALL Grouping allowed
continued
Description ALL Coding Violations - Line Errored Seconds - Line Severely Errored Secs - Line Coding Violations - Path Errored Seconds - Path Severely errored frame seconds - Path Severely Errored Secs - Path SEF / AIS Seconds - Path Controlled slip seconds - Path Unavailable Seconds - Path All applicable montypes
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-81 Table 12-63 (continued) Parameter Descriptions Parameter locn Possible values null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed Example input Description Default: All applicable locations Near End Far End Default: All applicable directions Transmit direction only Receive direction only Default: all applicable time periods 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
Retrieve the threshold for near-end receive line coding violations for DS1 slot 4 port 7, for the 15-minute time period:
RTRV-TH-T1:NEWYORK:DS1-4-7:CTAG12::CVL,NEND,RCV,15-MIN;
Retrieve the T1 threshold defaults:

RTRV-TH-T1:WASHINGTON:DFLT:CTAG12;

RTRV-TH-T3
The Retrieve Threshold T3 command instructs the network element to display the threshold levels for the specified DS3 performance monitored parameters. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 1 Input syntax
RTRV-TH-T3:TID:AID:CTAG::[montype],[locn],[dirn],[tmper];

Table 12-64 Syntax definition Field TID AID CTAG montype locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being retrieved The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-83 Table 12-65 AID descriptions AID type T3 AID Command-specific values DS3-slot# DS3-ALL ALL Defaults DFLT Purpose Identify the DS3s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All DS3 facilities Default threshold setting
Table 12-66 Parameter descriptions Parameter montype Possible values null CVL ESL SESL CVP ESP SESP SASP UASP ALL Grouping allowed locn null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Grouping allowed Default: All applicable locations Near End Far End Default: All applicable directions Transmit direction only Receive direction only Default: all applicable time periods 15 minute interval Day interval Untimed interval All available time periods Description ALL Coding Violations - Line Errored Seconds - Line Severely Errored Secs - Line Coding Violations - Path Errored Seconds - Path Severely Errored Secs - Path SEF / AIS Seconds - Path Unavailable Seconds - Path All applicable montypes
dirn
tmper
Retrieve the threshold for near-end receive line coding violations for DS3 slot 3, for the 15-minute time period:
RTRV-TH-T3:NEWYORK:DS3-3:CTAG12::CVL,NEND,RCV,15-min;
Retrieve the T3 threshold defaults:

RTRV-TH-T3:WASHINGTON:DFLT:CTAG12;

S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-TH-ALL
The Set Threshold All command instructs the network element to set the threshold levels for all PM monitored parameters to default settings. When these thresholds are met or exceeded, automatic messages (threshold crossing alerts) will be generated. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-ALL:[TID]:AID:CTAG::montype,thlev; Table 12-67 Syntax definition Field TID AID CTAG montype thlev Purpose Target identifier Access identifier. The facility to which the threshold applies. Correlation tag The particular monitored parameter for which threshold level is being set The desired threshold level to be set for montype
12-86 Performance monitoring detailed command descriptions Table 12-68 AID descriptions AID type ALL Command-specific values ALL Purpose All facilities
Table 12-69 Parameter descriptions Parameter montype Possible values ALL Description Set the threshold level of all monitored parameters; valid only with thlev of DFLT Set to Default thlev
thlev Example input
DFLT
Set all thresholds to defaults:

SET-TH-ALL:NEWYORK:ALL:CTAG12::ALL,DFLT;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-TH-EC1
The Set Threshold EC1 command instructs the network element to set the threshold level for a PM monitored EC-1 parameter. When this threshold is met or exceeded, an automatic message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods requires multiple SET-TH commands from the OS. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-EC1:[TID]:AID:CTAG::montype,thlev,[locn],[dirn], [tmper]; Table 12-70 Syntax definition Field TID AID CTAG montype thlev locn dirn tmper Purpose Target identifier Access identifier. The facility to which the threshold applies. Correlation tag The particular monitored parameter for which threshold level is being set The desired threshold level to be set for montype The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
12-88 Performance monitoring detailed command descriptions Table 12-71 AID descriptions AID type EC1 AID Command-specific values EC1-slot# EC1-ALL ALL Defaults DFLT Purpose Identify the EC-1s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All EC-1 facilities Default threshold setting
Table 12-72 Parameter descriptions Parameter montype Possible values CVS ESS SESS SEFSS CVL ESL SESL UASL ALL thlev 0 10 digit number DFLT Description Coding Violations - Section Errored Seconds - Section Severely Errored Seconds Section Severely Errored Frame Seconds - Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds Line Unavailable Seconds - Line Valid only with thlev of DFLT, and tmper of ALL Disable threshold Restricted by montype and tmper Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-89 Table 12-72 (continued) Parameter descriptions Parameter locn Possible values null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Example input Description Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: 15 minute interval 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
Set the threshold for near-end receive line coding violations (CVL) at 100 for the 15-minute accumulation period for EC-1 slot 3:
SET-TH-EC1:SEATTLE:EC1-3:CTAG12::CVL,100,NEND,RCV,15-MIN;
Set the default threshold for near-end receive line coding violations (CVL) at 100 for the 15-minute accumulation period:
SET-TH-EC1:NEWYORK:DFLT:CTAG12::CVL,100,NEND,RCV,15-MIN;
Set all EC-1 thresholds to defaults:

SET-TH-EC1:SEATTLE:ALL:CTAG12::ALL,DFLT,,,ALL;
SET-TH-OC3
The Set Threshold OC3 command instructs the network element to set the threshold level for a PM monitored OC-3 parameter. When this threshold is met or exceeded, an automatic message (threshold crossing alert) is generated. Threshold setting for multiple parameters or time periods requires multiple SET-TH commands to the operating system. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-OC3:[TID]:AID:CTAG::montype,thlev,[locn],[dirn], [tmper]; Table 12-73 Syntax definition Field TID AID CTAG montype thlev locn dirn tmper Purpose Target identifier Access identifier. The facility to which the threshold applies. Correlation tag The particular monitored parameter for which the threshold level is being set The desired threshold level to be set for montype The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-91 Table 12-74 AID descriptions AID type OC3 AID Command-specific values OC3-slot# OC3-ALL ALL Defaults DFLT Purpose Identify the OC-3s where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) All OC-3 facilities Default threshold setting
Table 12-75 Parameter descriptions Parameter montype Possible values CVS ESS SESS SEFSS CVL ESL SESL UASL ALL thlev 0 10 digit number DFLT Description Coding Violations - Section Errored Seconds - Section Severely Errored Seconds Section Severely Errored Frame Seconds - Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds Line Unavailable Seconds - Line Valid only with thlev of DFLT, and tmper of ALL Disable threshold Restricted by montype and tmper Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT
continued
12-92 Performance monitoring detailed command descriptions Table 12-75 (continued) Parameter descriptions Parameter locn Possible values null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Example input Description Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: 15 minute interval 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
Set the threshold for near-end receive line coding violations (CVL) at 100 for the 15-minute accumulation period for OC-3 slot 12:
SET-TH-OC3:SEATTLE:OC3-12:CTAG12::CVL,100,NEND,RCV,15-MIN;
SET-TH-OC3:NEWYORK:DFLT:CTAG12::CVL,100,NEND,RCV,15-MIN;
Set all OC-3 thresholds to defaults:

SET-TH-OC3:SEATTLE:ALL:CTAG12::ALL,DFLT,,,ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-TH-STS1
The Set Threshold STS1 command instructs the network element to set the threshold level for a PM monitored STS-1 parameter. When this threshold is met or exceeded, an automatic message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods requires multiple SET-TH commands from the OS. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-STS1:[TID]:AID:CTAG::montype,thlev,[locn],[dirn], [tmper]; Table 12-76 Syntax definition Field TID AID CTAG montype thlev locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being set The desired threshold level to be set for montype The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
12-94 Performance monitoring detailed command descriptions Table 12-77 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts OC3-slot#-ALL OC3-ALL Purpose Identify the OC-3s where slot# =3 to 12 (Express) slot# = 3 to 4 (Express CX) sts = 1 to 3 EC1-slot#-sts EC-1-slot# EC1-ALL Identify the EC-1s where slot# =3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts = 1 to 3 ALL Default DFLT All OC-3 and EC-1 facilities Default threshold setting
Table 12-78 Parameter descriptions Parameter montype Possible values CVP ESP SESP ALSP UASP ALL thlev 0 10 digit number DFLT Description Coding Violations - Path Errored Seconds - Path Severely Errored Seconds Path AIS/LOP second - Path Unavailable Seconds - Path Valid only with thlev of DFLT, and tmper of ALL Disable threshold Restricted by montype and tmper Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-95 Table 12-78 (continued) Parameter descriptions Parameter locn Possible values null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Example input Description Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: 15 minute interval 15 minute interval Day interval Untimed interval All available time periods
dirn
tmper
Set the threshold for near-end receive path coding violations (CVP) at 100 for the 15-minute accumulation period for OC-3 slot 12, sts 2:
SET-TH-STS1:SEATTLE:OC3-12-2:CTAG12::CVP,100,NEND,RCV,15-MIN;
Set the default threshold for near-end receive path coding violations (CVP) at 100 for the 15-minute accumulation period:
SET-TH-STS1:NEWYORK:DFLT:CTAG12::CVP,100,NEND,RCV,15-MIN;
Set all STS-1 thresholds to defaults:

SET-TH-STS1:SEATTLE:ALL:CTAG12::ALL,DFLT,,,ALL;
SET-TH-STS3C
The Set Threshold STS3C command instructs the network element to set the threshold level for a PM monitored STS-3c parameter. When this threshold is met or exceeded, an automatic message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods requires multiple SET-TH commands from the OS. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-STS3C:[TID]:AID:CTAG::montype,thlev,[locn],[dirn], [tmper]; Table 12-79 Syntax definition Field TID AID CTAG montype thlev locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being set The desired threshold level to be set for montype The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-97 Table 12-80 AID descriptions AID type STS3C AID Command-specific values OC3-slot# OC3-ALL ALL Defaults DFLT Purpose Identify the OC-3s where slot# =3 to 12 All OC-3 facilities Default threshold setting
Table 12-81 Parameter descriptions Parameter montype Possible values CVP ESP SESP ALSP UASP ALL thlev 0 10 digit number DFLT Description Coding Violations - Path Errored Seconds - Path Severely Errored Seconds Path AIS/LOP second - Path Unavailable Seconds - Path Valid only with thlev of DFLT, and tmper of ALL Disable threshold Restricted by montype and tmper Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: 15 minute interval 15 minute interval Day interval Untimed interval All available time periods
locn
null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL
dirn
tmper
Set the threshold for near-end receive STS-3c path coding violations (CVP) at 100 for the 15-minute accumulation period for OC-3 slot 12:
SET-TH-STS3C:SEATTLE:OC3-12:CTAG12::CVP,100,NEND,RCV,15-MIN;
Set the default threshold for near-end receive STS-3c path coding violations (CVP) at 100 for the 15-minute accumulation period:
SET-TH-STS3C:NEWYORK:DFLT:CTAG12::CVP,100,NEND,RCV,15-MIN;
Set all STS-3c thresholds to defaults:

SET-TH-STS3C:SEATTLE:ALL:CTAG12::ALL,DFLT,,,ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-TH-T1
The Set Threshold T1 command instructs the network element to set the threshold level for a PM monitored DS1 parameter. When this threshold is met or exceeded, an autonomous message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods requires multiple SET-TH commands from the OS. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-T1:[TID]:AID:CTAG::montype,thlev,[locn],[dirn], [tmper]; Table 12-82 Syntax definition Field TID AID CTAG montype thlev locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being set The desired threshold level to be set for montype The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
12-100 Performance monitoring detailed command descriptions Table 12-83 AID descriptions AID type T1 AID Command-specific values DS1-slot#-port# DS1-slot#-ALL DS1-ALL Purpose Identify the DS1s where Express slot# = 4 to 10 port# = 1 to 12 Express CX slot# = 1, port# = 1 to 12 slot# = 3, port# = 1 to 8 ALL Defaults DFLT All DS1 facilities Default threshold setting
Table 12-84 Parameter descriptions Parameter montype Possible values CVL ESL SESL CVP ESP SESP SEFSP SASP CSSP UASP ALL thlev 0 10 digit number DFLT Description Coding Violations - Line Errored Seconds - Line Severely Errored Seconds Line Coding Violations - Path Errored Seconds - Path Severely Errored Seconds Path Severely errored frame seconds - Path SEF / AIS Seconds - Path Controlled slip seconds - Path Unavailable Seconds - Path Valid only with thlev of DFLT, and tmper of ALL Disable threshold Restricted by montype and tmper Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT Default: All applicable locations Near end Far end
continued
locn
null NEND FEND
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-101 Table 12-84 (continued) Parameter descriptions Parameter dirn Possible values null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL Example input Description Default: All applicable directions Transmit direction only Receive direction only Default: 15 minute interval 15 minute interval Day interval Untimed interval All available time periods
tmper
Set the threshold for near-end receive line coding violations (CVL) at 100 for the 15-minute accumulation period for DS1 slot 4 port 7:
SET-TH-T1:NEWYORK:DS1-4-7:CTAG12::CVL,100,NEND,RCV,15-MIN;
SET-TH-T1:SEATTLE:DFLT:CTAG126::CVL,100,NEND,RCV,15-MIN;
Set all T1 thresholds to default:

SET-TH-T1:WASHINGTON:ALL:CTAG12::ALL,DFLT,,,ALL;
SET-TH-T3
The Set Threshold T3 command instructs the network element to set the threshold level for a PM monitored DS3 parameter. When this threshold is met or exceeded, an autonomous message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods requires multiple SET-TH commands from the OS. Setting a threshold to zero will disable threshold crossing alerts (TCAs) from being generated for the corresponding monitored parameter and accumulation bin. Only non-zero thresholds are displayed by RTRV-TH commands. Security level Level 2 Input syntax
SET-TH-T3:[TID]:AID:CTAG::montype,thlev,[locn],[dirn], [tmper]; Table 12-85 Syntax definition Field TID AID CTAG montype thlev locn dirn tmper Purpose Target identifier Access identifier. The facility to which the given threshold level applies. Correlation tag The particular monitored parameter for which threshold level is being set The desired threshold level to be set for montype The location where the monitored parameter originates, and refers to the entity identified by the AID The direction which the monitored parameter applies, and is relative to the entity identified by the AID The accumulation time period for the PM information
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Performance monitoring detailed command descriptions 12-103 Table 12-86 AID descriptions AID type T3 AID Command-specific values DS3-slot# DS3-ALL ALL Defaults DFLT Purpose Identify the DS3s where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) All DS3 facilities Default threshold setting
Table 12-87 Parameter descriptions Parameter montype Possible values CVL ESL SESL CVP ESP SESP SASP UASP ALL thlev 0 10 digit number DFLT Description Coding Violations - Line Errored Seconds - Line Severely Errored Seconds Line Coding Violations - Path Errored Seconds - Path Severely Errored Seconds Path SEF / AIS Seconds - Path Unavailable Seconds - Path Valid only with thlev of DFLT and tmper of ALL Disable threshold Restricted by montype and tmper Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT Default: All applicable locations Near end Far end Default: All applicable directions Transmit direction only Receive direction only Default: 15 minute interval 15 minute interval Day interval Untimed interval All available time periods
locn
null NEND FEND null TRMT RCV null 15-MIN 1-DAY 1-UNT ALL
dirn
tmper
Set the threshold for near-end receive line coding violations (CVL) at 100 for the 15-minute accumulation period for DS3 slot 9:
SET-TH-T3:SEATTLE:DS3-9:CTAG12::CVL,100,NEND,RCV,15-MIN;
SET-TH-T3:NEWYORK:DFLT:CTAG12::CVL,100,NEND,RCV,15-MIN;
Set all DS3 thresholds to defaults:

SET-TH-T3:SEATTLE:ALL:CTAG12::ALL,DFLT,,,ALL;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
13-1
TARP detailed command descriptions
13-
This chapter is an alphabetical summary of the TL1 commands related to TARP provisioning. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command ED-TARP-CONFIG ED-TARP-TBL OPR-TARP-TEF RTRV-TARP-CONFIG RTRV-TARP-TBL Page 13-2 13-5 13-8 13-10 13-12
13-2 TARP detailed command descriptions
ED-TARP-CONFIG
The Edit TARP Configuration command is used to configure the TARP processor parameters as required. Security level Level 3 Input syntax
ED-TARP-CONFIG:<TID>::<CTAG>::OPERATION:[TMODE=Domain] [,NSEL=Domain][,LIFE=Domain][,PTYPE=Domain][,SEQ=Domain] [,THROTTLE=Domain][,T1=Domain][,T3=Domain][,LDBFLUSH=Domain] [,TDCFLUSH=Domain][,LDBELIFE=Domain];
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TARP detailed command descriptions 13-3 Table 13-1 Syntax definition Field TID CTAG OPERATION Purpose Target identifier Correlation tag SET: set parameters specified in keyword-defined parameter block. Supply at least one keyword-defined parameter. RESET: reset parameters specified in keyword-defined parameter block to default values by specifying only the keyword. RESETALL: reset all parameters to default values. Keyword-defined parameters are ignored. See Parameter descriptions table for details
KEYWORD=Domain
Table 13-2 Parameter descriptions Parameter TMODE Possible values PROPAGATION ORIGINATION BOTH NONE Default: BOTH NSEL LIFE A number including 2 hexadecimal digits Network selector Description TARP mode
A decimal number that ranges from 0 to 65535 PDU lifetime Default: 100 hops
PTYPE
A number including 2 hexadecimal digits Default: FE for CLNP
Protocol address type
SEQ
A decimal number that ranges from 0 to 65535 PDU sequence number Default: 0
continued
13-4 TARP detailed command descriptions Table 13-2 Parameter descriptions Parameter THROTTLE Possible values A decimal number grouping Throttle default: 300 Period default: 2 An example is: THROTTLE=300&2 Description Throttle&period Throttle (integer) is the maximum number of PDUs processed within the time of interval period (second) TARP type 1 message response waiting period Address resolution request response waiting period Loop detection buffer flush TARP data cache flush Loop detection buffer entry life
T1
A decimal number that ranges from 0 to 3600 Default: 15 seconds
T3
A decimal number that ranges from 0 to 3600 Default: 40 seconds
LDBFLUSH
A decimal number that ranges from 0 to 1440 Default: 5 minutes
TDCFLUSH A decimal number that ranges from 0 to 1440 Default: 1440 minutes LDBELIFE A decimal number that ranges from 1 to 10 Default: 5 minutes Example input
Reset the TMODE and T1 parameter to the default on network element NEWYORK:
ED-TARP-CONFIG:NEWYORK::CTAG123::RESET:TMODE=,T1=;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TARP detailed command descriptions 13-5
ED-TARP-TBL
The Edit TARP Tables command is used to edit the disabled adjacency table (DAT), disabled circuit/port table (DCT), loop detection buffer (LDB), manual adjacency table (MAT), and TARP data cache (TDC). Security level Level 3 Input syntax
ED-TARP-TBL:<TID>::<CTAG>::TABLE,OPERATION:[LDBENTRY=Domain] [,TDCENTRY=Domain][,MATENTRY=Domain][,DATENTRY=Domain] [,DCTENTRY=Domain]; Table 13-3 Syntax definition Field TID CTAG TABLE Purpose Target identifier Correlation tag DAT - Disabled adjacency table DCT - Disabled circuit/port table LDB - Loop detection buffer MAT - Manual adjacency table TDC - TARP data cache ADD - Adds a new entry DEL - Deletes an entry FLUSH - Flushes the table See Parameter descriptions table for details
OPERATION
KEYWORD=Domain
13-6 TARP detailed command descriptions Table 13-4 Parameter descriptions Keyword LDBENTRY Description Loop detection buffer entry Value SystemID&SEQ SystemID is a 12 hexadecimal digit number SEQ (sequence number) is a decimal number 0-65535 TDCENTRY TARP data cache entry TID&NSAP TID is a string of up to 20 characters NSAP is a number including a maximum of 40 hexadecimal digits MATENTRY Manual adjacency table entry NSAP or SystemID NSAP is a number including a maximum of 40 hexadecimal digits SystemID is a 12 hexadecimal digit number DATENTRY Disabled adjacency table entry NSAP or SystemID NSAP is a number including a maximum of 40 hexadecimal digits SystemID is a 12 hexadecimal digit number DCTENTRY Disabled circuit/port table entry LAN0, DCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12
Note: Add or delete the parameter(s) from the specified TABLE. Either parameter is mandatory if the OPERATION is either ADD or DEL. If OPERATION is FLUSH, the parameter(s) is ignored and all entries on the specified TABLE are deleted.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TARP detailed command descriptions 13-7 Example input
Delete all entries from LDB table:

ED-TARP-TBL:OTTAWA::CTAG12::LDB,FLUSH;
OPR-TARP-TEF
The Operate TARP TEF (TARP Echo Function) command is used support TEF for trouble shooting. It is similar to the ping function in the IP network. Security level Level 3 Input syntax
OPR-TARP-TEF:<TID>::<CTAG>::ADDRTYPE,ADDRESS: [ITERATION=Domain][,RATE=Domain][,TIMEOUT=Domain]; Table 13-5 Syntax definitions Field TID CTAG ADDRTYPE ADDRESS Purpose Target identifier Correlation tag Remote address type can be TID or NSAP ADDRESS is the value of ADDRTYPE. If ADDRTYPE is TID, ADDRESS is a string with a maximum of 20 characters. If ADDTYPE is NSAP, ADDRESS is a hexadecimal number with a maximum of 40 digits. See Parameter descriptions table for details
KEYWORD=Domain
Table 13-6 Parameter descriptions Parameter ITERATION Description Iterations of number TARP Type 5 messages to be transmitted Rate of sent requests Wait for a response before sending each request (in milliseconds) TIMEOUT Possible values A decimal number that ranges from 1 to 65535 Default: 1 A decimal number that ranges from 1000 to 180000 Default: 1000
RATE
The maximum time to A decimal number that ranges from 1000 wait for a response to to 180000 each echo request (in Default: 1500 milliseconds)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TARP detailed command descriptions 13-9 Input example OPR-TARP-TEF:OTTAWA::CTAG12::TID,NEWYORK; Table 13-7 Output parameters for TEF Parameter TEF SEQ TID NSAP TIME Example input Description TARP echo function indicator Sequence number Target identifier NSAP Value A string with a maximum of 20 characters A decimal number A string with a maximum of 20 characters A number with a maximum of 40 hexadecimal digits
Response time in milliseconds A decimal number
Perform a TARP-TEF:
TEF:SEQ=1,TID=NEWYORK,NSAP=490000000075D0082E00,TIME=70 TEF:SENT 1, RECEIVED 1,MTNTM/AVETM/MAXTM=70/70/70, SUCCESS=100%
RTRV-TARP-CONFIG
The Retrieve TARP Configuration command is used to retrieve all the TARP configuration parameters. Security level Level 1 Input syntax
RTRV-TARP-CONFIG:<TID>::<CTAG>; Table 13-8 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the TARP configuration parameter for network element NEWYORK:

RTRV-TARP-CONFIG:NEWYORK::CTAG12;

TMODE=Domain,TID=Domain,NSAP=Domain,NSEL=Domain, SEQ=Domain,PTYPE=Domain,LIFE=Domain,THROTTLE=Domain,T1=Domain, T3=Domain,LDBFLUSH=Domain,TDCFLUSH=Domain,LDBELIFE=Domain Table 13-9 Response block descriptions Parameter TMODE Domain PROPAGATION ORIGINATION BOTH NONE A number including a maximum of 40 hexadecimal digits A number including 2 hexadecimal digits Description TARP mode
NSAP NSEL SEQ PTYPE
NSAP Network selector
A decimal number that ranges from 0 to 65535 PDU sequence number A number including 2 hexadecimal digits
continued
Protocol address type
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TARP detailed command descriptions 13-11 Table 13-9 Response block descriptions Parameter LIFE Domain Description
A decimal number that ranges from 0 to 65535 PDU lifetime Default: 100 hops
THROTTLE
A decimal number grouping An example is: THROTTLE=300&2
Throttle&period Throttle (integer) is the maximum number of PDUs processed within the time of interval period (second)
T1
A decimal number that ranges from 0 to 3600 TARP type 1 message response waiting period A decimal number that ranges from 0 to 3600 Address resolution request response waiting period A decimal number that ranges from 0 to 1440 Loop detection buffer flush Default: 5 minutes
T3
LDBFLUSH
TDCFLUSH A decimal number that ranges from 0 to 1440 TARP data cache flush Default: 1440 minutes LDBELIFE A decimal number that ranges from 1 to 10 Default: 5 minutes Loop detection buffer entry life
RTRV-TARP-TBL
The Retrieve TARP Tables command is used to retrieve the contents of the computed TARP adjacency (ADJ), disabled adjacency table (DAT), disabled circuit/port table (DCT), loop detection buffer (LDB), manual adjacency table (MAT), and TARP data cache (TDC). Security level Level 1 Input syntax
RTRV-TARP-TBL:<TID>::<CTAG>::TABLE; Table 13-10 Syntax definition Field TID CTAG TABLE Purpose Target identifier Correlation tag ADJ - Computed TARP adjacency DAT - Disabled adjacency table DCT - Disabled circuit/port table LDB - Loop detection buffer MAT - Manual adjacency table TDC - TARP data cache
Table 13-11 Parameter descriptions Parameter NSAP SYSID SeqNumber PortID Description NSAP System ID Possible values NSAP is a number including a maximum of 40 hexadecimal digits A 12 hexadecimal digit
Sequence number A decimal number Port identifier LAN LAN-ROUTER DCC-ROUTER DCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12
Example input
Retrieve the TARP table ADJ on network element OTTAWA:

RTRV-TARP-TBL:OTTAWA::CTAG12::ADJ;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TARP detailed command descriptions 13-13
Response block table

Table 13-12 Response block descriptions Table ADJ Parameter NSAP SystemID PORT ID Value Up to 40 hexadecimal digit numbers A 12 hexadecimal digit number LAN LAN-ROUTER DCC-ROUTER DCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12 Up to 40 hexadecimal digit numbers A 12 hexadecimal digit number LAN LAN-ROUTER DCC-ROUTER DCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12 A 12 hexadecimal digit number
DAT
NSAP SystemID
DCT
Port ID
LDB
System ID
SeqNumber A decimal number MAT NSAP SystemID TDC TID NSAP Up to 40 hexadecimal digit numbers A 12 hexadecimal digit number A string of up to 20 characters Up to 40 hexadecimal digit numbers
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
14-1
TBOS detailed command descriptions
14-
This chapter is an alphabetical summary of the TL1 commands related to the telemetry byte-oriented serial feature (TBOS). The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command RTRV-TBOS SET-TBOS Page 14-2 14-4
14-2 TBOS detailed command descriptions
RTRV-TBOS
The Retrieve TBOS command returns a report with a standard header and a display array listing current assignments of all assigned network elements in the TBOS span of control by TBOS page number. TBOS page numbers are previously assigned using the SET-TBOS command. Adjacent will be TID and columns indicating critical, major, and minor alarms, columns for the first 4 (or 4 most important) environmental alarms, and a remote alarm column. The RTRV-TBOS command is a powerful tool for monitoring network conditions. The single-ended TBOS feature in OC-3 Express is a simple and powerful remote surveillance tool, independent of whether an actual TBOS link is used. For example, in a four-node ring, the head-end network element can be provisioned to monitor all four network elements in the ring using the SET-TBOS command. Alarms activating the remote (RM) LED on the LIO or the office alarm contact of the head-end network element can be retrieved by entering the RTRV-TBOS command at that network element. This gives an alarm summary of all four network elements in the ring. Often, this information will require you to log in to a remote network element with outstanding alarms for further diagnostics. Note: Only the head-end network element can display the TBOS array. Security level Level 1 Input syntax
RTRV-TBOS:[TID]::CTAG;

Retrieve TBOS for a network span whose head end is NEWYORK:

RTRV-TBOS:NEWYORK::CTAG23;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TBOS detailed command descriptions 14-3

DISPLAYSID CR MJ MN E1 E2 E3 E4 RM ----------------------------------------------------[^]+ <display> [^]+ <sid> [ ^<*|.|?>]+ Example normal response SID yy-mm-dd hh:mm:ss M CTAG23 COMPLD "DISPLAY SID CR MJ MN E1 E2 E3 E4 RM "-------------------------------------" 1 NEWYORK . . * * . . . * " 2 SYRACUSE . * . . . . . . " 3 ROCHESTER . . . . . . . . " 4 BOSTON1 ? ? ? ? ? ? ? ? ;
" " " " " "
In the sample report, adjacent to each SID (source identifier) are columns containing periods (.), asterisks (*), or question marks (?). Each column is used to indicate a condition. A period indicates normal status. The asterisks under the display header row symbols CR, MJ, MN, E1, E2, E3, E4, and RM, correspond to alarm conditions at each network element. These represent critical, major and minor alarms, the first four environmental alarms in numeric order, and the remote alarm indicator, respectively. The name in each row under SID identifies the SID of the network element. Question marks show that the network element has not been found in the TBOS traffic flow. This can mean that the network element is not functioning, it cannot be reached, or the SID has been changed but not updated in the TBOS display page.
SET-TBOS
The Set TBOS command sets up the TBOS display number associated with a particular network element, to enable single-ended TBOS operations. This means that one network element in a TBOS span of control is designated the head-end network element and is always numbered 1. From the head-end network element the RTRV-TBOS command can be used to monitor the conditions of all other network elements that have been assigned a TBOS page number. For OC-3 Express, each network element being monitored by TBOS has half a display (32 data bits instead of 64). Therefore, the traditional 8 displays for standard TBOS become 16 displays for OC-3 Express. If the SID is changed then the new name will not be recognized by the TBOS display mapper. To reassign the network element to the correct TBOS display number, use the SET-TBOS command. Note: This command is also used to delete TBOS mapping assignments. See the procedure for deleting TBOS mapping assignments in TL1 Network Surveillance, 323-1051-520. Security level Level 3 Input syntax
SET-TBOS:[TID]:DISPLAY#:CTAG::SID;
Note: The SID field is not used when deleting a TBOS mapping assignment.
Table 14-2 Syntax definition Field TID DISPLAY# CTAG SID Purpose Target identifier The display number assigned in the TBOS display, from 1 to 16 Correlation tag The system identifier of the network element associated with DISPLAY#
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
TBOS detailed command descriptions 14-5 Example input
A TBOS link has been established to the network element with SID of NEWYORK. Four commands are entered telling NEWYORK that it is responsible for the surveillance of four different network elements.
SET-TBOS:NEWYORK:1:CTAG12::NEWYORK; SET-TBOS:NEWYORK:2:CTAG23::SYRACUSE; SET-TBOS:NEWYORK:3:CTAG34::ROCHESTER; SET-TBOS:NEWYORK:4:CTAG45::BOSTON1;
The RTRV-TBOS command will display the following:

SID yy-mm-dd hh:mm:ss
M CTAG12 COMPLD "DISPLAY SID CR MJ MN E1 E2 E3 E4 RM "
"-------------------------------------- " " " " " ; 1 2 3 4 NEWYORK . . * . ? ? * . . ? * . . ? . . . ? . . . ? . . . ? * . . " " " "
SYRACUSE . ROCHESTER . BOSTON1 ?
Note: The series of question marks at BOSTON1 indicate that TBOS is unable to connect to the remote node. Such a state causes a TBOS connection failure alarm to be raised. Every 30 seconds, TBOS retries the connection. If the connection is established, the alarm clears automatically. The alarm is also cleared if the connection at BOSTON1 is deleted. Delete the TBOS connection at the remote node BOSTON1:
SET-TBOS:NEWYORK:4:CTAG12::;
Note 1: The SID field is left blank when deleting a TBOS mapping assignment. Note 2: TBOS mapping connections can only be deleted from the head-end network element. Note 3: The TID must match the head-end TID in the TBOS mapping assignment table retrieved.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
15-1
Alarm, events, and external controls detailed command descriptions 15This chapter is an alphabetical summary of the TL1 commands related to alarm, events, and external controls. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists all the commands in this chapter.
Command ALW-MSG-ALL INH-MSG-ALL OPR-ACO-ALL OPR-EXT-CONT RLS-EXT-CONT RTRV-ALM-ALL RTRV-ALM-ENV RTRV-ALMID-rr RTRV-AO RTRV-ATTR-CONT RTRV-ATTR-ENV RTRV-COND-ALL RTRV-CONDATTR-COM RTRV-CONDATTR-rr RTRV-EXT-CONT RTRV-NTFCNCDE
continued
Page 15-3 15-4 15-5 15-6 15-8 15-10 15-15 15-20 15-22 15-24 15-26 15-29 15-31 15-32 15-34 15-36
15-2 Alarm, events, and external controls detailed command descriptions Command RTRV-STSBIP SET-ATTR-CONT SET-ATTR-ENV SET-CONDATTR-COM SET-CONDATTR-rr SET-NTFCNCDE SET-STSBIP-OFF SET-STSBIP-ON Page 15-37 15-38 15-40 15-44 15-45 15-47 15-48 15-49
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-3
ALW-MSG-ALL
The Allow Messages All command instructs the network element to resume previously inhibited REPT-ALM, REPT-ALM-ENV, REPT-EVT and REPT-EX autonomous messages. These messages are inhibited through the use of the INH-MSG-ALL command. When a TL1 session begins, REPT-ALM, REPT-ALM-ENV, and REPT-EVT messages are allowed by default. To inhibit messages see INH-MSG-ALL. Security level Level 1 Input syntax
ALW-MSG-ALL:[TID]:[ALL]:CTAG;

Restart all autonomous message from network element BOSTON3:

ALW-MSG-ALL:BOSTON3::CTAG12;
15-4 Alarm, events, and external controls detailed command descriptions
INH-MSG-ALL
The Inhibit Message All command is used to stop all REPTÂLM, REPTÂLMÊNV, REPTÊVT and REPTÊX autonomous messages. It is meant to be used during maintenance to keep the terminal screen uncluttered. When a TL1 session begins, REPTÂLM, REPTÂLMÊNV and REPTÊVT messages are allowed by default. To resume messages see ALW-MSG-ALL. Security level Level 1 Input syntax
INH-MSG-ALL:[TID]:[ALL]:CTAG;

Turn off all messages from the network element NEWYORK:

INH-MSG-ALL:NEWYORK::CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
OPR-ACO-ALL
The Operate Alarm Cutoff All command instructs a network element to cut off the office audible alarm indications without changing the other alarm indications. The result of the OPR-ACO-ALL command is identical to manually pressing the ACO button on the network element circuit pack. There is no complementary release command for ACO. Security level Level 1 Input syntax
OPR-ACO-ALL:[TID]:[ALL]:CTAG;

Stop the audible alarm in network element NEWYORK:

OPR-ACO-ALL:NEWYORK::CTAG12;
Stop audible alarms in ALL network elements:

OPR-ACO-ALL:ALL::CTAG12;
OPR-EXT-CONT
The Operate External Controls command is used to turn on one or more of the four external control relays. The network element is equipped with four relays that can be configured for normally closed or normally open operation. The contact number parameter is mandatory and grouping is allowed. The control type parameter is not required, but can be used to parse the command. For example, if the command is intended to turn on lights on relay 3, but relay 3 is actually connected to sprinklers, then including the value LIGHT in the CONTTYPE field would cause the command to fail (and prevent sprinklers from being accidentally turned on). CAUTION Be careful not to turn on external controls that activate a potential danger such as sprinklers or miscellaneous controls connected to possibly hazardous systems or equipment. To turn off external control relays see the RLS-EXT-CONT command. Security level Level 2 Input syntax
OPR-EXT-CONT:[TID]:AID:CTAG::[CONTTYPE]; Table 15-4 Syntax definition Field TID AID CTAG CONTTYPE Purpose Target identifier Access identifier, the contact number from 1 to 4 Correlation tag Optional parameter, the type of control for which the control state is being set
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-7 Table 15-5 AID descriptions AID type Command-specific values Purpose Identify the contact number Activate all external relays. Not allowed when CONTTYPE is null. Grouping #&#&#, #= 1 to 4 Identify multiple contacts
CONTACT NO. 1 to 4 ALL ALL
Table 15-6 Parameter descriptions Parameter CONTTYPE Possible values null Description Optional parameter (ALL) Not allowed when AID is ALL AIRCOND ENGINE FAN GEN HEAT LIGHT MISC SPKLR Example input Air conditioning Engine Fan Generator Heat Light Miscellaneous Sprinkler
Turn on the air conditioner on relay 1 at network element WASHINGTON:

OPR-EXT-CONT:WASHINGTON:1:CTAG12::AIRCOND;
Turn on the heat on all external controls at network element NEWYORK:

OPR-EXT-CONT:NEWYORK:ALL:CTAG12::HEAT;
Turn on relays 2 and 3 to activate the generator at network element SEATTLE:

OPR-EXT-CONT:SEATTLE:2&3:CTAG12::GEN;
RLS-EXT-CONT
The Release External Control command is used to switch any of the four electrical relays, for controlling external devices, from operative mode to idle mode. The external control relays can be configured for either normally closed or normally open mode and are connected to external devices through wire-wrap pins on the LIO adapter. External control relays are normally inoperative and are switched into operative mode by the OPR-EXT-CONT command. Note: Though the CONTTYPE value is optional it should be used to prevent errors. If an incorrect value to relay pair is entered then the command will be denied by the network element. Security level Level 2 Input syntax
RLS-EXT-CONT:[TID]:AID:CTAG::[CONTTYPE]; Table 15-7 Syntax definition Field TID AID CTAG CONTTYPE Purpose Target identifier Access identifier, the contact number from 1 to 4 Correlation tag Optional parameter, the type of control for which the control state is being set
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-9 Table 15-8 AID descriptions AID type Command-specific values Purpose Identify the contact number Release relays 1 to 4 ALL not allowed if CONTTYPE is null. Grouping #&#&#, #=1 to 4 Multiple contacts for example 1,2
CONTACT NO. 1 to 4 ALL ALL
Table 15-9 Parameter descriptions Parameter CONTTYPE Possible values null Description Optional parameter (ALL) Not allowed when AID is ALL AIRCOND ENGINE FAN GEN HEAT LIGHT MISC SPKLR Example input air conditioning engine fan generator heat light miscellaneous sprinkler
Switch external control 1, for air conditioning off at network element NEWYORK:
RLS-EXT-CONT:NEWYORK:1:CTAG34::AIRCOND;
Switch off engine and fan on relays 2 and 3 respectively at network element WASHINGTON:
RLS-EXT-CONT:WASHINGTON:2&3:CTAG45::ENGINE&FAN;
RTRV-ALM-ALL
The Retrieve Alarm All command retrieves all the current alarms from the specified network elements. The RTRV-ALM-ALL command retrieves only alarmed conditions. To display non-alarmed conditions and events use the RTRV-COND-ALL command. Note: This command will not retrieve cleared alarms. To retrieve cleared alarms refer to the RTRV-AO command. Security level Level 1 Input syntax
RTRV-ALM-ALL:[TID]:[ALL]:CTAG;

Retrieve all the alarms from network element SEATTLE:

RTRV-ALM-ALL:SEATTLE::CTAG12;

<aid>,<aidtype>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>, <ocrtm>,<locn>,<dirn>:<conddescr>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-11 Table 15-11 Alarm report AID descriptions <aid> DS1-slot#-port# DS3-slot# EC1-slot#-sts#-vtg#-vt# EC1-slot# OC3-slot#-sts#-vtg#-vt# OC3-slot#-sts# OC3-slot# OC3-slot# DS1-slot# DS3-slot# EC1-slot# EIM-slot# VTX-slot# COM PSC PSX SP <aidtype> T1 T3 VT1 STS1 VT1 STS1 OC3 EQPT EQPT EQPT EQPT EQPT EQPT COM EQPT EQPT COM Fault description T1 signal T3 signal VT1 fault STS-1 fault VT1 fault STS-1 fault OC-3 signal fault OC-3 circuit pack DS1 mapper DS3 mapper EC-1 circuit pack EIM circuit pack Virtual tributary cross-connect Failure type Facility Facility Facility Facility Facility Facility Facility Equipment Equipment Equipment Equipment Equipment Equipment
Data communications Equipment Protection switch controller (DS1 1-28) Equipment
Protection switch Equipment extender (DS1 29-84) Shelf processor Equipment
Note: AIDs can be identical for both facility and equipment but will be accompanied by different condition descriptions.
15-12 Alarm, events, and external controls detailed command descriptions Table 15-12 Alarm report field descriptions Parameter <ntfcncde> Values CR MJ MN EQPT INT SWEQPT ESW LOS LOF APSMM APSC AIS INC SLMF FA SYNCPRI SYNCSEC LOP <srveff> <ocrdat> <ocrtm> SA NSA mm-dd hh:mm:ss Applicable Description AIDs all Critical alarm Major alarm Minor alarm Critical alarm caused by equipment failure Internal hardware fault/failure Protection switching equipment failure Excessive switching Loss of signal Loss of frame Automatic protection switch mode mismatch Automatic protection switch channel failure Alarm indication signal detected Incoming failure condition Signal label match failure Failure of Power A or B Primary synchronization signal lost Secondary synchronization signal lost
<condtype>
all all working EQPT AID OC3, VTX facility AID facility AID EQPT facility AID facility AID facility AID STS1 facility AID EQPT EQPT EQPT
OC3 facility Loss of pointer all all all Service affecting Not service affecting The date when the alarm occurred The time when the alarm occurred
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-13 Table 15-12 (continued) Alarm report field descriptions Parameter <locn> Values NEND FEND <dirn> NA RCV TRMT null <conddescr> character string Applicable Description AIDs all all all facility AID all all all Failure at the near end of the system Failure at the far end of the system Not applicable Receive direction only Transmit direction only Not applicable The detailed text description of the trouble.
15-14 Alarm, events, and external controls detailed command descriptions Legend Term AIS CR ENV EQPT INC INT MJ MN NA NSA Rx RFI SA SDCC Tx VT Description Alarm Indication Signal detection Critical alarm condition Environmental alarm Equipment alarm Incoming failure condition Internal failure Major alarm condition Minor alarm condition Not Applicable Non Service Affecting Receive Remote Fault Indicator Service Affecting Section Data Communication Channel Transmit Virtual Tributary
Sample output
SEATTLE 1995-01-01 00:00 CTAG12 COMPLD DS1-4:MJ,LOF,SA,01-01,00-00-19,NEND,RCV:DS1 Rx Loss Of Frame ;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-ALM-ENV
The Retrieve Alarm Environment command retrieves the current environmental alarms from the specified entity or entities. Environment alarms do not relay information about equipment faults but about problems with physical premises. Security level Level 1 Input syntax
RTRV-ALM-ENV:[TID]:AID:CTAG::[NTFCNCDE],[ALMTYPE];
15-16 Alarm, events, and external controls detailed command descriptions Table 15-13 Syntax definitions Field TID AID CTAG NTFCNCDE ALMTYPE Purpose Target identifier Access identifier, the contact number from 1 to 16 Correlation tag Optional, the notification code indicating severity; grouping allowed Optional, the alarm type indicating the specific nature of the problem; grouping allowed
Table 15-14 AID descriptions AID type Command-specific values Purpose identify the contact number all contacts Grouping of multiple AIDs separated by & ampersands
contact number 1 to 16 ALL Grouping ALL #&#&#, #= 1 to 16
Table 15-15 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN Applicable Description AIDs all all all Critical alarm Major alarm Minor alarm
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-17 Table 15-15 (continued) Parameter descriptions Parameter <almtype> Values AIRCOMPR AIRCOND AIRDRYR BATDSCHRG BATTERY CLFAN ENGINE ENGOPRG EXPLGS FIRDETR FIRE FLOOD FUSE GEN HIAIR HIHUM HITEMP HIWTR INTRUDER Applicable Description AIDs all all all all all all all all all all all all all all all all all all all Air compressor failure Air conditioning failure Air dryer failure Battery discharging Battery failure Cooling fan failure Engine failure Engine operating Explosive gas Fire detector failure Fire Flood Fuse failure Generator failure High airflow High humidity High temperature High water Intrusion
continued
15-18 Alarm, events, and external controls detailed command descriptions Table 15-15 (continued) Parameter descriptions Parameter <almtype> Values LWBATVG LWFUEL LWHUM LWPRES LWTEMP LWWTR MISC OPENDR PUMP POWER PWR-48 RECT RECTHI RECTLO SMOKE TOXICGAS VENTN Applicable Description AIDs all all all all all all all all all all all all all all all all all Low battery voltage Low fuel Low humidity Low cable pressure Low temperature Low water Miscellaneous Open door Pump failure Commercial power failure 48-V power supply failure Rectifier failure Rectifier high voltage Rectifier low voltage Smoke Toxic gas Ventilation system failure
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-19 Example input
Retrieve only INTRUDER alarms on all contacts from network element NEWYORK:
RTRV-ALM-ENV:NEWYORK:ALL:CTAG12::,INTRUDER;
Retrieve alarms 1, 5 and 6 from network element WASHINGTON:

RTRV-ALM-ENV:WASHINGTON:1&5&6:CTAG12;
Retrieve all alarms from network element SEATTLE:

RTRV-ALM-ENV:SEATTLE:ALL:CTAG34;
Retrieve all CRITICAL alarms from the network element:

RTRV-ALM-ENV:WASHINGTON:ALL:CTAG56::CR;

<aid>:<ntfcncde>,<almtype>,<ocrdat>,<ocrtm>,<almmsg> Table 15-16 Response parameter descriptions Parameter <ocrdat> <ocrtm> <almmsg> Values mm-dd hh-mm-ss character string Applicable Description AIDs all all all the date when the alarm occurred the time when the alarm occurred the detailed text description of the trouble
RTRV-ALMID-rr
The Retrieve Alarm Identification command retrieves the alarm identification numbers for alarms. Security level Level 1 Input syntax
RTRV-ALMID-rr:[TID]::CTAG; Table 15-17 Syntax definitions Field TID CTAG Table 15-18 Values for rr Applicable rr ALL COM EIM EQPT FAC STS1 Example input Description All available alarms Common alarms EIM circuit pack Equipment ILAN circuit pack STS1 facility Purpose Target identifier Correlation tag
Retrieve alarm identification numbers for all alarms which can be inhibited on network element BOSTON3:
RTRV-ALMID-ALL:BOSTON3::CTAG12;

Alm ID AID Alarm Text ------------------------------<almid> <aid> <almtext>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-21 Table 15-19 Response parameter descriptions Parameter ALMID ALMTEXT Possible values non-zero unsigned integer character string Description Alarm identification number Alarm text
RTRV-AO
The Retrieve Automatic Output command retrieves a list of automatic output (AO) messages on the shelf processor (SP) or the network processor (NP). The message list provides historical autonomous messages including all events, alarms and environmental alarms. The AO list cannot be deleted, reset, or altered. The message list holds messages in a first-in-first-out buffer: 200 messages on the SP 30 messages on the NP To identify the significance of the alarm messages see the REPT-ALM and REPT-EVT messages in the Automatic Reports chapter. Note: This command retrieves alarms and conditions that are cleared. The notification code is CL for cleared alarms. Security level Level 1 Input syntax
On the shelf processor RTRV-AO:[TID]::CTAG:::[ATAGSEQ=Domain],[MSGTYPE=Domain];

On the network processor RTRV-AO:[TID]::CTAG;
Note: ALL is not a valid target identifier (TID).

Table 15-20 Syntax definition Field TID CTAG ATAGSEQ Purpose Target identifier Correlation tag Automatic tag sequential. The sequential equivalent of a CTAG, issued by the system when the event record is generated. Message type. Specifies what type of activity is to be retrieved.
MSGTYPE
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Retrieve SP automatic output messages requesting automatic tag sequential from network element WASHINGTON:
RTRV-AO:WASHINGTON::CTAG12:::ATAGSEQ=123&124&235;
Retrieve SP automatic output messages of message type alarm from network element SEATTLE:
RTRV-AO:SEATTLE::CTAG12:::,MSGTYPE=ALM;
Retrieve NP automatic output messages from network element SEATTLE:

RTRV-AO:SEATTLE::CTAG12;
Response block syntax Alarm response blocks contain:

<aid>]:<ntfcncde>,<condtype>,<srveff>, <ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>
For parameter definitions see the REPT-ALM autonomous messages in Chapter 19. Event response blocks contain:
<aid>:<condtype>,<condeff>,<ocrdat>, <ocrtm>,<locn>,<dirn>:<conddescr>
For parameter definitions see the REPT-EVT autonomous messages in Chapter 19. Threshold crossing alert response blocks contain:
<aid>:<condtype>,<condeff>,<ocrdat>, <ocrtm>,<locn>,<dirn>,<monval>,<thlev>,<tmper>
For parameter definitions see the REPT-EVT autonomous messages in Chapter 19. Environmental alarm response blocks contain:
<aid>:<ntfcncde>,<almtype>,<ocrdat>,<ocrtm>,<almmsg>
For parameter definitions see the REPT-ALM autonomous messages in Chapter 19.
RTRV-ATTR-CONT
The Retrieve Attributes Controls command retrieves the attributes associated with external controls. The attributes are the text strings assigned by the SET-ATTR-CONT command, which identify the function of the control relay. Security level Level 1 Input syntax
RTRV-ATTR-CONT:[TID]:AID:CTAG::[CONTTYPE];

Table 15-21 Syntax definition Field TID AID CTAG CONTTYPE Purpose Target identifier Access identifier, the contact number from 1 to 4 Correlation tag Control type, optional parameter, the type of control for which the control state is being set
Table 15-22 AID descriptions AID type Command-specific values Purpose Identify the contact number Display all contacts Group multiple AIDs separated by & ampersands
CONTACT NO. 1 to 4 ALL Grouping ALL #&#&#, #=1 to 4
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-25 Table 15-23 Parameter descriptions Parameter CONTTYPE Possible values AIRCOND ENGINE FAN GEN HEAT LIGHT MISC SPKLR Example input Description Air conditioning Engine Fan Generator heat light Miscellaneous Sprinkler
Retrieve the description of the external control on relay 2 from network element NEWYORK:
RTRV-ATTR-CONT:NEWYORK:2:CTAG12;
Retrieve all external control relays that are connected to air conditioning from network element WASHINGTON:
RTRV-ATTR-CONT:WASHINGTON:ALL:CTAG75::AIRCOND;
Retrieve the status of all engine and generator relays from network element SEATTLE:
RTRV-ATTR-CONT:SEATTLE:ALL:CTAG18::ENGINE&GEN;

<aid>:[<CONTTYPE>]
RTRV-ATTR-ENV
The Retrieve Attributes Environment command retrieves the attributes associated with environmental alarms. The response displays what each environmental alarm register has been programmed to represent. In the response, an alarm type field contains one of the 36 allowed types, followed by an alarm message preprogrammed by the customer to describe the precise details. Security level Level 1 Input syntax
RTRV-ATTR-ENV:[TID]:AID:CTAG::[NTFCNCDE],[ALMTYPE];

Table 15-24 Syntax definition Field TID AID CTAG NTFCNCDE ALMTYPE Table 15-25 AID descriptions AID type Command-specific values Purpose Identify the contact number Display all contacts Group multiple AIDs separated by ampersands (&) Purpose Target identifier Access identifier, the contact number from 1 to 16, or ALL to display all contact numbers Correlation tag Notification code for the environmental alarm; grouping allowed Alarm type for the environmental alarm; grouping allowed
CONTACT NO. 1 through 16 ALL Grouping ALL #&#&#, #=1 through 16
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-27 Table 15-26 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN <almtype> AIRCOMPR AIRCOND AIRDRYR BATDSCHRG BATTERY CLFAN ENGINE ENGOPRG EXPLGS FIRDETR FIRE FLOOD FUSE GEN HIAIR HIHUM HITEMP HIWTR INTRUDER Applicable Description AIDs all all all all all all all all all all all all all all all all all all all all all all Critical alarm Major alarm Minor alarm Air compressor failure Air conditioning failure Air dryer failure Battery discharging Battery failure Cooling fan failure Engine failure Engine operating Explosive gas Fire detector failure Fire Flood Fuse failure Generator failure High airflow High humidity High Temperature High water Intrusion
continued
15-28 Alarm, events, and external controls detailed command descriptions Table 15-26 (continued) Parameter descriptions Parameter <almtype> Values LWBATVG LWFUEL LWHUM LWPRES LWTEMP LWWTR MISC OPENDR PUMP POWER PWR-48 RECT RECTHI RECTLO SMOKE TOXICGAS VENTN Example input Applicable Description AIDs all all all all all all all all all all all all all all all all all Low battery voltage Low fuel Low humidity Low cable pressure Low temperature Low water Miscellaneous Open door Pump failure Commercial power failure 48-V power supply failure Rectifier failure 48-V rectifier high voltage Rectifier low voltage Smoke Toxic gas Ventilation system failure
Retrieve all environmental alarms configured to represent either floods or major severity from network element SEATTLE:
RTRV-ATTR-ENV:SEATTLE:ALL:CTAG12::MJ,FLOOD;
Retrieve the configuration of environmental alarm relay 2 from network element WASHINGTON:
RTRV-ATTR-ENV:WASHINGTON:2:CTAG12;

<aid>:<NTFCNCDE>,<ALMTYPE>,\"<ALMMSG>\"
Note: The alarm message field <ALMMSG> is always prefixed and terminated with the characters backslash and quotation mark (\").
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-COND-ALL
The Retrieve Conditions All command retrieves the current conditions (alarm or status) from the specified network elements. The RTRV-COND-ALL command does not retrieve performance monitored threshold crossings. To display performance monitored information use the RTRV-PM commands. To display environmental alarms use the RTRV-ALM-ENV command. Note: This command will not retrieve cleared alarms. To retrieve cleared alarms refer to the RTRV-AO command. Security level Level 1 Input syntax
RTRV-COND-ALL:[TID]:[ALL]:CTAG;

Retrieve all conditions from the network element SEATTLE:

RTRV-COND-ALL:SEATTLE::CTAG12;

<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>, <locn>,<dirn>:<conddescr> Table 15-28 Response parameters definition Parameter ntfcncde condtype srveff ocrdat ocrtm locn dirn conddescr Description Notification code indicating severity of condition Condition type indicating the equipment or facility affected Service effect indicating whether the condition is service affecting Occurrence date indicating the day of the event Occurrence time indicating the hour of the event Location indicating whether the event is near end or far end Direction indicating whether the event is incoming or outgoing Condition description giving a textual outline of the event
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-CONDATTR-COM
The Retrieve Condition Attributes Common command retrieves the attributes associated with common alarms. Security level Level 1 Input syntax
RTRV-CONDATTR-COM:[TID]:[ALMID]:CTAG; Table 15-29 Syntax definition Field TID ALMID CTAG Example input Purpose Target identifier Alarm identification number, a non-zero unsigned integer Correlation tag
Retrieve the condition attributes for the common alarm with identification number 123 on network element NEWYORK:
RTRV-CONDATTR-COM:NEWYORK:123:CTAG12;

SHELF:COM,<almtext>,ALRM=ENABLED/DISABLED
RTRV-CONDATTR-rr
The Retrieve Condition Attributes command retrieves the condition attributes associated with equipment and facility alarms. Security level Level 1 Input syntax
RTRV-CONDATTR-rr:[TID]:[AID][,ALMID]:CTAG; Table 15-30 Syntax definition Field TID AID ALMID CTAG Table 15-31 AID descriptions rr value EIM AID value Purpose Purpose Target identifier Access identifier Alarm identification number, a non-zero unsigned integer Correlation tag
EIM mapper EIM-slot#-bridge# slot# = 7 to 10 bridge# = 1 to 2 EIM-slot#-ALL EIM-ALL ALL OC3-slot# ALL Equipment alarms slot#=3 to 12 STS-1 facility alarms slot# = 3 to 12 sts# = 1 to 3 slot# = 3 to 10 sts# = 1
EQPT
STS1 OC3-slot#-sts# OC3-slot#-ALL OC3-ALL EC1-slot#-sts# EC1-ALL ALL
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Retrieve the condition attributes for all EIM circuit packs for the alarm with identification number 123 on network element NEWYORK:
RTRV-CONDATTR-EIM:NEWYORK:ALL:123:CTAG12;

SHELF:EIM,<almtext>,ALRM=ENABLED/DISABLED
RTRV-EXT-CONT
The Retrieve External Controls command retrieves the control state of external controls showing whether the control is Operated or Released. The command is used to retrieve the state from one to all four controls. The control type variable is optional and can be used to ensure that the correct information is retrieved. Security level Level 1 Input syntax
RTRV-EXT-CONT:[TID]:AID:CTAG::[CONTTYPE];

Table 15-32 Syntax definition Field TID AID CTAG CONTTYPE Purpose Target identifier Access identifier, the contact number from 1 to 4 Correlation tag Optional parameter, the type of control for which the control state is being retrieved. Grouping is allowed; use ampersand & as separator
Table 15-33 AID descriptions AID type Command-specific values Purpose Identify the contact number Retrieve all external controls Retrieve multiple contacts
CONTACT NO. 1 to 4 ALL Grouping ALL #&#&#, #=1 to 4
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-35 Table 15-34 Input parameter descriptions Parameter CONTTYPE Possible value AIRCOND ENGINE FAN GEN HEAT LIGHT MISC SPKLR Example input Description air conditioning engine fan generator heat light miscellaneous sprinkler
Retrieve the state of control 1 from network element NEWYORK:

RTRV-EXT-CONT:NEWYORK:1:CTAG23;
Retrieve the state of all light relays from network element SEATTLE:
RTRV-EXT-CONT:SEATTLE:ALL:CTAG56::LIGHT;

<aid>:[<CONTTYPE>],CONTS,<contstate> Table 15-35 Response parameter descriptions Parameter CONTS CONTSTATE Possible values CONTS OPER RLS Description Duration is continuous, momentary is not supported Operated Released
RTRV-NTFCNCDE
The Retrieve Alarm Notification command retrieves the current alarm notification setting for the specified network element. Security level Level 1 Input syntax
RTRV-NTFCNCDE:[TID]::CTAG; Table 15-36 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the setting of the alarm notification code from network element OTTAWA5:
RTRV-NTFCNCDE:OTTAWA5::CTAG12;

NTFCNCDE=DFLT/ALT
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-STSBIP
The Retrieve STS Rx Excessive BIP Error status command retrieves the status of the STS Rx Excessive BIP Error alarm on the specified AIDs. Security level Level 1 Input syntax
RTRV-STSBIP:[TID]:AID:CTAG; Table 15-37 Syntax definition Field TID AID CTAG Table 15-38 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL OC3-ALL Purpose Identify the STS-1 facilities on the OC-3 interfaces where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) sts# = 1 to 3 EC1-slot#-sts# EC1-slot# EC1-ALL Identify the STS-1 facilities on the EC-1 circuit packs where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts# = 1 ALL Example input All applicable STS-1 facilities Purpose Target identifier Access identifier, the facility to which the command applies Correlation tag
Retrieve the STS Rx Excessive BIP Error alarm status from all the OC-3 facilities on network element OTTAWA5:
RTRV-STSBIP:OTTAWA5:OC3-ALL:CTAG12;

<aid>: STS Rx Excessive BIP Error: ALRM=DISABLED/ENABLED
SET-ATTR-CONT
The Set Attributes Control command sets the attributes associated with external controls. The attributes are basically textual and are used to indicate what the external control is used for. Security level Level 3 Input syntax
SET-ATTR-CONT:[TID]:AID:CTAG::[CONTTYPE]; Table 15-39 Syntax definition Field TID AID CTAG CONTTYPE Purpose Target identifier Access identifier, the contact number from 1 to 4 Correlation tag Optional parameter, the type of control for which the control state is being set
Table 15-40 AID descriptions AID type Command-specific values Purpose Identify the contact number Group multiple AIDs separated by & ampersands
CONTACT NO. 1 to 4 Grouping #&#&#, #=1 to 4
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-39 Table 15-41 Parameter descriptions Parameter CONTTYPE Possible values AIRCOND ENGINE FAN GEN HEAT LIGHT MISC SPKLR Example input Description Air conditioning Engine Fan Generator heat light Miscellaneous Sprinkler
Set control relay 2 to display the air conditioning value (AIRCOND) for CONTTYPE on network element NEWYORK:
SET-ATTR-CONT:NEWYORK:2:CTAG12::AIRCOND;
SET-ATTR-ENV
The Set Attributes Environment command sets the attributes associated with environmental alarms. These attributes are included when an environmental alarm is reported or retrieved. If all attributes are null value, it unassigns the value of these attributes. If some of them are null, it keeps these null value attributes unchanged. Security level Level 3 Input syntax
SET-ATTR-ENV:[TID]:AID:CTAG::[NTFCNCDE],[ALMTYPE], [\"ALMMSG\"];
Note: The alarm message field must begin and end with the characters backslash and quote (\").
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-41 Table 15-42 Syntax definition Field TID AID CTAG NTFCNCDE ALMTYPE ALMMSG Purpose Target identifier Access identifier, the contact number from 1 to 16 Correlation tag The notification code for the environmental alarm The alarm type for the environmental alarm The text message, 1 to 40 characters, associated with the environmental alarm specified by the AID parameters
Table 15-43 AID descriptions AID type Command-specific values Purpose Identify the contact number As a precautionary feature this parameter cannot be null. Group multiple AIDs separated by ampersands (&)
CONTACT NO. 1 to 16 null is not allowed Grouping #&#&#, #=1 to 16
Table 15-44 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN Applicable Description AIDs all Critical alarm Major alarm Minor alarm
15-42 Alarm, events, and external controls detailed command descriptions Table 15-44 (continued) Parameter descriptions Parameter <almtype> Values AIRCOMPR AIRCOND AIRDRYR BATDSCHRG BATTERY CLFAN ENGINE ENGOPRG EXPLGS FIRDETR FIRE FLOOD FUSE GEN HIAIR HIHUM HITEMP HIWTR INTRUDER Applicable Description AIDs all all all all all all all all all all all all all all all all all all all Air compressor failure Air conditioning failure Air dryer failure Battery discharging Battery failure Cooling fan failure Engine failure Engine operating Explosive gas Fire detector failure Fire Flood Fuse failure Generator failure High airflow High humidity High temperature High water Intrusion
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Alarm, events, and external controls detailed command descriptions 15-43 Table 15-44 (continued) Parameter descriptions Parameter <almtype> Values LWBATVG LWFUEL LWHUM LWPRES LWTEMP LWWTR MISC OPENDR PUMP POWER PWR-48 RECT RECTHI RECTLO SMOKE TOXICGAS VENTN <almmsg> character string Applicable Description AIDs all all all all all all all all all all all all all all all all all all Low battery voltage Low fuel Low humidity Low cable pressure Low temperature Low water Miscellaneous Open door Pump failure Commercial power failure 48-V power supply failure Rectifier failure Rectifier high voltage Rectifier low voltage Smoke Toxic gas Ventilation system failure 1 to 40-character detailed text description of trouble
Example input
Set environmental alarm 2 to report a flood alarm with notification code of major on network element NEWYORK:
SET-ATTR-ENV:NEWYORK:2:CTAG12::MJ,FLOOD,\"FLOOD\";
SET-CONDATTR-COM
The Set Condition Attributes Common command sets the condition attributes associated with common alarms. These attributes are included when an alarm is reported or retrieved. Security level Level 3 Input syntax
SET-CONDATTR-COM:[TID]:ALMID:CTAG:::[ALRM=Domain]; Table 15-45 Syntax definition Field TID ALMID CTAG ALRM Purpose Target identifier Alarm identification number, a non-zero unsigned integer Correlation tag Alarm status. See the Parameter descriptions table for details.
Table 15-46 Parameter descriptions Parameter ALRM Command-specific values ENABLED DISABLED Example input Purpose Enable the specified alarm (default) Disable the specified alarm
Disable the common alarm with alarm identification 123 on network element NEWYORK:
SET-CONDATTR-COM:NEWYORK:123:CTAG12:::ALRM=DISABLED;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-CONDATTR-rr
The Set Condition Attributes command sets the condition attributes associated with alarms. These attributes are included when an alarm is reported or retrieved. Security level Level 3 Input syntax
SET-CONDATTR-rr:[TID]:AID,ALMID:CTAG:::[ALRM=Domain]; Table 15-47 Syntax definition Field TID AID ALMID CTAG ALRM Purpose Target identifier Access identifier Alarm identification number, a non-zero unsigned integer Correlation tag Alarm status. See the Parameter descriptions table for details.
15-46 Alarm, events, and external controls detailed command descriptions Table 15-48 AID descriptions rr value EIM AID value Purpose
EIM mapper EIM-slot#-bridge# slot# = 7 to 10 bridge# = 1 to 2 EIM-slot#-ALL EIM-ALL ALL OC3-slot# ALL Equipment alarms slot#=3 to 12 STS-1 facility alarms slot# = 3 to 12 sts# = 1 to 3 slot# = 3 to 10 sts# = 1
EQPT
STS1 OC3-slot#-sts# OC3-slot#-ALL OC3-ALL EC1-slot#-sts# EC1-ALL ALL Table 15-49 Parameter descriptions Parameter ALRM
Command-specific values ENABLED DISABLED
Purpose Enable the specific alarm on the specified AID (default) Disable the specific alarm on the specified AID
Example input
Disable the alarm with alarm identification 123 for all EIM mappers on network element NEWYORK:
SET-CONDATTR-EIM:NEWYORK:ALL,123:CTAG12:::ALRM=DISABLED;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-NTFCNCDE
The Set Alarm Notification command sets the alarm notification code for the specified network element. The alarm notifications supported are default and alternative. Note: This command only applies to new alarms; it has no impact on alarms already raised. Security level Level 3 Input syntax
SET-NTFCNCDE:[TID]::CTAG::[DFLT/ALT]; Table 15-50 Syntax definition Field TID CTAG DFLT/ALT Example input Purpose Target identifier Correlation tag Use default (DFLT) or alternate (ALT) notification code
Set the alarm notification code to alternative on the network element OTTAWA5:
SET-NTFCNCDE:OTTAWA5::CTAG12::ALT;
SET-STSBIP-OFF
The Set STS Rx Excessive BIP Error Off command disables the STS Rx Excessive BIP Error alarm on the specified AIDs. Security level Level 3 Input syntax
SET-STSBIP-OFF:[TID]:AID:CTAG; Table 15-51 Syntax definition Field TID AID CTAG Table 15-52 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL OC3-ALL Purpose Identify the STS-1 facilities on the OC-3 interfaces where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) sts# = 1 to 3 EC1-slot#-sts# EC1-slot# EC1-ALL Identify the STS-1 facilities on the EC-1 circuit packs where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts# = 1 ALL Example input All applicable STS-1 facilities Purpose Target identifier Access identifier, the facility to which the command applies Correlation tag
Inhibit all the STS Rx Excessive BIP Error alarms from network element OTTAWA5:
SET-STSBIP-OFF:OTTAWA5:ALL:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SET-STSBIP-ON
The Set STS Rx Excessive BIP Error On command allows the STS Rx Excessive BIP Error alarm to be reported on the specified AIDs. Security level Level 3 Input syntax
SET-STSBIP-ON:[TID]:AID:CTAG; Table 15-53 Syntax definition Field TID AID CTAG Table 15-54 AID descriptions AID type STS1 AID Command-specific values OC3-slot#-sts# OC3-slot#-ALL OC3-ALL Purpose Identify the STS-1 facilities on the OC-3 interfaces where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) sts# = 1 to 3 EC1-slot#-sts# EC1-slot# EC1-ALL Identify the STS-1 facilities on the EC-1 circuit packs where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX) sts# = 1 ALL Example input All applicable STS-1 facilities Purpose Target identifier Access identifier, the facility to which the command applies Correlation tag
Allow all the STS Rx Excessive BIP Error alarms to be reported from network element OTTAWA5:
SET-STSBIP-ON:OTTAWA5:ALL:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
16-1
SDCC detailed command descriptions
16-
This chapter is an alphabetical summary of all the TL1 commands that apply to the section data communications channel (SDCC). The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. Note: For OC-3 Express CX, SDCC is only supported on the OC-3 interfaces on the MTX circuit packs. The following table lists all the commands in this chapter.
Command DLT-LLSDCC ED-LLSDCC ED-ULSDCC ENT-LLSDCC RTRV-LLSDCC RTRV-ULSDCC Page 16-2 16-3 16-6 16-8 16-9 16-12
16-2 SDCC detailed command descriptions
DLT-LLSDCC
The Delete Lower Layer SDCC command is used to delete a section data communications channel (SDCC) link (layers 1 and 2) on the specified AID. Security level Level 3 Input syntax
DLT-LLSDCC:[TID]:AID:CTAG; Table 16-1 Syntax definition Field TID AID CTAG Table 16-2 AID descriptions AID type OC-3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Identify the EC-1 where slot# = 3, 5, 7, or 9 Purpose Target identifier Access identifier. The OC-3 or EC-1 equipment to act on. Correlation tag
EC-1 AID
EC1-slot#
Example input
Delete the lower layer SDCC link for the OC-3 circuit pack in slot 7:
DLT-LLSDCC:NEWYORK:OC3-7:CTAG34;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SDCC detailed command descriptions 16-3
ED-LLSDCC
The Edit Lower Layer SDCC command is used to modify editable layer 2 parameters of the section data communications channel (SDCC) link. When the SDCC link is provisioned, default values are set for these parameters. Execute the edit command at the far end first since all edit commands cause the link to drop and be reestablished. You can edit up to nine parameters in one command. The order of the parameters is unimportant. Separate each parameter with a comma. Security level Level 3 Input syntax
ED-LLSDCC:[TID]:AID:CTAG:::<Keyword=Domain>; Table 16-3 Syntax definition Field TID AID CTAG Keyword Purpose Target identifier Access identifier. The OC-3 or EC-1 equipment to act on. Correlation tag Layer 2 parameters that can be modified. See the Keyword descriptions table for details.
Table 16-4 AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Identify the EC-1 where slot# = 3, 5, 7, or 9
EC1 AID
EC1-slot#
16-4 SDCC detailed command descriptions Table 16-5 Keyword descriptions Parameter L2INFO L2REX Valid values Range 512 to 1492 2 to 16 Default 1304 bytes 3 This parameter is the frame size. This parameter is the retransmission count. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2WAIT 2 to 200 2 This parameter is the waiting acknowledgment timer, in tenths of a second. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2NOA 4 to 120 s 10 s This parameter is the no activity timer. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2IF 1 to 127 7 This parameter is the outstanding I-frame count. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2TEI 0 to 127 0 This parameter is the terminal endpoint identifier. Make the change at both ends as a new value gives the channel a new address. Make the change at the far end first, because when the first change is made, the channel state becomes down, and association with the far end is lost. L2SAPI 0 to 63 62 This parameter is the Service Access Point Identifier. Make the change at both ends as a new value gives the channel a new address. Make the change at the far end first, because when the first change is made, the channel state becomes down, and association with the far end is lost. L2TS AITS UITS AITS This parameter is the transfer type. The default is AITS (acknowledged information transfer service). UITS (unacknowledged information transfer service) is not supported in this release. L2SIDE USER NETWORK AUTO AUTO This parameter is the role of the local node, network or user. The default value is Auto. The local node attempts to establish a connection with the far end by toggling its role between network and user in a random pattern. Setting this parameter to auto simplifies the setup of the link since the nodes decide which node is user and which is network. It does not matter which node has which role, as long as the two connecting nodes have opposite roles. Comments
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SDCC detailed command descriptions 16-5 Example input
Change the retransmission count from the default value:

ED-LLSDCC:WASHINGTON:OC3-11:CTAG23:::L2REX=5;
Change the no activity timer to 100 s, the frame size to 1492 bytes and the terminal endpoint identifier to 25:
ED-LLSDCC:WASHINGTON:OC3-11:CTAG23:::L2NOA=100, L2INFO=1492,L2TEI=25;
ED-ULSDCC
The Edit ULSDCC command is used to change manual area addresses of the section data communications channel (SDCC) link. When the SDCC link is provisioned, MANAREA0 has a default setting of 49000. You must have at least one manual area address provisioned. If you want to delete the address in MANAREA0 and it is the only address provisioned, you must first provision an address in MANAREA1 or MANAREA2, then delete the address in MANAREA0. To change a manual area address, you must delete the address that is provisioned, then add the new address. For example, to change MANAREA1, enter the command to edit MANAREA1 and leave a blank for the domain. This clears the address in MANAREA1. Then enter the command to edit MANAREA1 again, and enter the new address for the domain. Security level Level 3 Input syntax
ED-ULSDCC:[TID]::CTAG:::<Keyword=Domain>; Table 16-6 Syntax definition Field TID CTAG Keyword Purpose Target identifier Correlation tag MANAREA address. See the Keyword descriptions table for details.
Table 16-7 Keyword descriptions Keyword MANAREA0 MANAREA1 MANAREA2 Valid value maximum 26-character hexadecimal string Description Area address 0 (default) Area address 1 Area address 2
Note: The MANAREA address must follow a standard format for data communications protocol.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SDCC detailed command descriptions 16-7 Example input
Edit the address in MANAREA1, by clearing the address that is already provisioned, then entering a new address:
ED-ULSDCC:SEATTLE::CTAG34:::MANAREA1=; ED-ULSDCC:SEATTLE::CTAG34::: MANAREA1=39830f80000000000000000000;
Delete area address 2

ED-ULSDCC:SEATTLE::CTAG34:::MANAREA2=;
ENT-LLSDCC
The Enter Lower Layer SDCC command is used to add a section data communications channel (SDCC) link (layers 1 and 2) onto the specified AID (equipment slot). The request is validated based on already configured SDCCs on the pair of slots (the number of SDCCs already configured, the current SDCC protection scheme) and the circuit pack currently provisioned in that slot or pair of slots. If the request is successful, the addition request is carried through using the SDCC provisioning defaults. To change the provisioning defaults, see ED-LLSDCC. Security level Level 3 Input syntax
ENT-LLSDCC:[TID]:AID:CTAG; Table 16-8 Syntax definition Field TID AID CTAG Table 16-9 AID descriptions AID type OC3 AID Command-specific values OC3-slot# Purpose Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Identify the EC-1 where slot# = 3, 5, 7, or 9 Purpose Target identifier Access identifier. The OC-3 or EC-1 equipment to act on. Correlation tag
EC1 AID
EC1-slot#
Example input
Add a lower layer SDCC link on the EC-1 circuit pack in slot 7:
ENT-LLSDCC:NEWYORK:EC1-7:CTAG13;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SDCC detailed command descriptions 16-9
RTRV-LLSDCC
The Retrieve Lower Layer SDCC command is used to retrieve information associated with a given section data communications channel (SDCC) link for layers 1 and 2. The information includes the state of the layer 2 (LAPD) link (IS-NR, OOS-AU) and the current settings of editable layer 2 parameters. Security level Level 1 Input syntax
RTRV-LLSDCC:[TID]:AID:CTAG; Table 16-10 Syntax definition Field TID AID CTAG Table 16-11 AID descriptions AID type EC1 AID Command-specific values EC1-slot# EC1-ALL OC3-slot# OC3-ALL Purpose Identify the EC-1 where slot# = 3, 5, 7, or 9 (Express) Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) Retrieve SDCC information for all EC-1 and optical interface circuit packs Purpose Target identifier Access identifier. The OC-3 or EC-1 equipment to retrieve SDCC information from. Correlation tag
OC3 AID
ALL
ALL
Example input
Retrieve the lower layer SDCC information for the OC-3 circuit pack in slot 5:
RTRV-LLSDCC:NEWYORK:OC3-5:CTAG56;

AID::L2INFO=Domain,L2REX=Domain,L2WAIT=Domain,L2NOA=Domain, L2IF=Domain,L2TEI=Domain,L2SAPI=Domain,L2TS=Domain, L2SIDE=Domain,PROT=N:IS,ACT Table 16-12 Response parameter descriptions Parameter Valid values Range L2INFO L2REX 512 to 1492 2 to 16 Default 1304 bytes 3 This parameter is the frame size. This parameter is the retransmission count. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2WAIT 2 to 200 2 This parameter is the waiting acknowledgment timer, in tenths of a second. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2NOA 4 to 120 s 10 s This parameter is the no activity timer. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2IF 1 to 127 7 This parameter is the outstanding I-frame count. Although there is no requirement to make this value the same at both ends, it is advisable to do so to improve performance. L2TEI 0 to 127 0 This parameter is the terminal endpoint identifier. Make the change at both ends as a new value gives the channel a new address. Make the change at the far end first, because when the first change is made, the channel state becomes down, and association with the far end is lost. L2SAPI 0 to 63 62 This parameter is the service access point identifier. Make the change at both ends as a new value gives the channel a new address. Make the change at the far end first, because when the first change is made, the channel state becomes down, and association with the far end is lost.
continued
Comments
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
SDCC detailed command descriptions 16-11 Table 16-12 (continued) Response parameter descriptions Parameter Valid values Range L2TS AITS UITS L2SIDE USER NETWORK AUTO AUTO Default AITS This parameter is the transfer type. The default is AITS (acknowledged information transfer service). UITS (unacknowledged information transfer service) is not supported in this release. This parameter is the role of the local node, network or user. The default value is AUTO. The local node attempts to establish a connection with the far end by toggling its role between network and user in a random pattern. Setting this parameter to auto simplifies the setup of the link since the nodes decide which node is user and which is network. It does not matter which node has which role, as long as the two connecting nodes have opposite roles. Comments
RTRV-ULSDCC
The Retrieve ULSDCC command is used to retrieve manual area addresses provisioned for the section data communications channel (SDCC) link. Security level Level 1 Input syntax
RTRV-ULSDCC:[TID]::CTAG;

Retrieve the MANAREA addresses provisioned for network element New York:
RTRV-ULSDCC:NEWYORK::CTAG12;

MANAREA0=Domain,MANAREA1=Domain,MANAREA2=Domain Table 16-14 Response parameter descriptions Keyword MANAREA0 MANAREA1 MANAREA2 Valid value maximum 26-character hexadecimal string Description Area address 0 (default) Area address 1 Area address 2
Note: The MANAREA address must follow a standard format for data communications protocol.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
17-1
Initialization detailed command descriptions
17-
This chapter is an alphabetical summary of the TL1 commands related to initialization.The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. All commands in this chapter are supported on the OC-3 Express and Express CX network elements and the network processor (NP). The following table lists all commands in this chapter.
Command INIT-COLD INIT-WARM Page 17-2 17-4
17-2 Initialization detailed command descriptions
INIT-COLD
The Initialize Cold command instructs a network element to initialize its circuit packs. A cold initialization is equivalent to a power-up and can affect traffic. You can use the network processor as the target identifier to initialize the network processor. The date and time must be reset on the network element and network processor after a system restart. Security level Level 3 Input syntax
INIT-COLD:[TID]:AID:CTAG; Table 17-1 Syntax definition Field TID Purpose Target identifier
Note: You must use the network processor as the target identifier to initialize the NP.
AID CTAG Access identifier. The circuit pack to initialize. Correlation tag
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Initialization detailed command descriptions 17-3 Table 17-2 AID descriptions AID type equipment Command-specific values DS3-slot# Purpose Identify the DS3 where slot#=3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 where slot#=3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 where slot#=3 to 12 (Express) Identify the VTX where slot#=13 or 14 (Express) Identify the MTX where slot#=3 or 4 (Express CX) Identify the EIM where slot#= 7 to 10 (Express) Identify the ILAN where slot#= 16 (Express) Protection switch controller Shelf processor Network processor
EC1-slot#
OC3-slot# VTX-slot# MTX-slot# EIM-slot# ILAN-slot# PSC SP NP
Example input
Perform a cold initialization of OC-3 in slot 12 only on network element WASHINGTON:

INIT-COLD:WASHINGTON:OC3-12:CTAG13;
INIT-WARM
The Initialize Warm command instructs a network element to initialize its circuit packs. A warm initialization does not affect traffic. The date and time must be reset after a system restart. Security level Level 3 Input syntax
INIT-WARM:[TID]:AID:CTAG; Table 17-3 Syntax definition Field TID Purpose Target identifier
AID CTAG Access identifier. The circuit pack to initialize. Correlation tag
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Initialization detailed command descriptions 17-5 Table 17-4 AID descriptions AID type equipment Command-specific values DS3-slot# Purpose Identify the DS3 where slot#=3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the EC-1 where slot#=3 to 10 (Express) slot#= 1 to 2 (Express CX) Identify the OC-3 where slot#=3 to 12 (Express) Identify the VTX where slot#=13 or 14 (Express) Identify the MTX where slot#=3 or 4 (Express CX) Protection switch controller Shelf processor Network processor
EC1-slot#
OC3-slot# VTX-slot# MTX-slot# PSC SP NP
Example input
Perform a warm initialization of OC-3 in slot 12 only on network element WASHINGTON:

INIT-WARM:WASHINGTON:OC3-12:CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
18-1
Path and section trace detailed command descriptions
18-
This chapter is an alphabetical summary of the TL1 commands related to path and section trace. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The following table lists the commands in this chapter.
Command ED-STS1 RTRV-PTHTRC-STS1 RTRV-TRC-OC3 Page 18-2 18-4 18-6
18-2 Path and section trace detailed command descriptions
ED-STS1
The Edit STS1 command is used to edit the expected incoming or outgoing path trace values, or both path trace values. Security level Level 3 Input syntax
ED-STS1:[TID]:AID:CTAG::[MON]:[EXPTRC=Domain], [TRC=Domain]; Table 18-1 Syntax definition Field TID AID CTAG MON Table 18-2 AID descriptions AID type AID Command-specific values DS3-slot# OC3-slot#-sts# Purpose Identifies the DS3 STS-1 path facility where DS3 slot# = 3, 5, 7, or 9 (Express) Identifies the OC-3 STS-1 path facility where OC-3 slot# = 3 to 12 (Express) OC-3 slot# = 3 to 4 (Express CX) sts# = 1 to 3 Purpose Target identifier Access identifier. The STS-1 facility to act on. Correlation tag Path trace monitoring
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Path and section trace detailed command descriptions 18-3 Table 18-3 Parameter descriptions Parameter MON Possible values ON OFF (default) EXPTRC (See Note) TRC (See Note) Description Enables path trace monitoring Disables path trace monitoring
Any ASCII string of up to 62 Expected incoming path trace characters message Any ASCII string of up to 62 Outgoing path trace message characters
Note: Enclose the ASCII string in double quotes () to maintain case sensitivity. The string must begin and end with the double quotes. You cannot use double quotes as part of the ASCII string.
Example
Edit the path trace value:

ED-STS1:NEWYORK:OC3-11-1:CTAG13::ON:EXPTRC=NEWYORKOC3-11-1, TRC=TXPATHDS3-5;
RTRV-PTHTRC-STS1
The Retrieve Path Trace STS-1 command is used to retrieve the expected incoming, actual incoming, or outgoing path trace values for a given STS path. Security level Level 1 Input syntax
RTRV-PTHTRC-STS1:[TID]:AID:CTAG::[MSGTYPE][,MON]; Table 18-4 Syntax definition Field TID AID CTAG msgtype Purpose Target identifier Access identifier. The STS-1 facility to act on. Correlation tag EXPTRC (default), expected incoming path trace message INCTRC, incoming path trace message TRC, outgoing path trace message
Table 18-5 AID descriptions AID type AID Command-specific Purpose values DS3-slot# OC3-slot#-sts# Identifies the DS3 STS-1 path facility where DS3 slot# = 3, 5, 7, or 9 (Express) Identifies the OC-3 STS-1 path facility where OC-3 slot# = 3 to 12 (Express) OC-3 slot# = 3 to 4 (Express CX) sts# = 1 to 3
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Path and section trace detailed command descriptions 18-5 Table 18-6 Parameter descriptions Parameter MON Possible values YES NO (default) Description Includes path trace monitoring value Not include path trace monitoring value
Example input
Retrieve the expected incoming path trace message and include the path trace monitoring value:
RTRV-PTHTRC-STS1:NEWYORK:OC3-11-1:CTAG45::EXPTRC,YES;

trace message MON = ON/OFF
RTRV-TRC-OC3
The Retrieve Trace OC-3 command is used to retrieve the expected incoming, actual incoming, or outgoing section trace values for a specified OC-3 facility. Security level Level 1 Input syntax
RTRV-TRC-OC3:[TID]:AID:CTAG::[MSGTYPE]; Table 18-7 Syntax definition Field TID AID CTAG MSGTYPE Purpose Target identifier Access identifier. OC-3 facility to act on. Correlation tag Section trace message type. See the Parameter descriptions table for details.
Table 18-8 AID descriptions AID type OC3 Command-specific values OC3-slot# Purpose Identify the OC-3 facility where slot#= 3 to 12
Table 18-9 Parameter descriptions Parameter MSGTYPE Possible values STRC EXPSTRC INCSTRC Example input Description Outgoing section trace message (default) Expected incoming section trace message Actual incoming section trace message
Retrieve the outgoing section trace message for the OC-3 facility in slot 11 on network element SEATTLE:
RTRV-TRC-OC3:SEATTLE:OC3-11:123::STRC;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Path and section trace detailed command descriptions 18-7

section trace message Table 18-10 Response parameter descriptions Parameter STRC EXPSTRC INCSTRC Possible values 0 to 255 ASCII string 0 to 255 ASCII string 0 to 255 ASCII string Description Outgoing section trace message Expected incoming section trace message Incoming section trace message
Note: The possible values of the section trace messages depend on the STFORMAT value. If STFORMAT is NUM, the possible values are 0 to 255. If STFORMAT is STRING, the possible values are any printable alphanumeric ASCII string up to 15 characters (except comma, colon, semi-colon, equal sign, or question mark) or a NULL character string.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
19-1
Network processor command descriptions
19-
This chapter is an alphabetical summary of all the TL1 commands related to the network processor (NP). The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. The TL1 commands described in this chapter apply only to the NP. For descriptions of the TL1 commands that apply to both the NP and the network element, for example, network security and administration commands, see other appropriate sections in this document. Note: The target identifier (TID) in the commands in this chapter is always the NP to which the command is directed. The following table lists all the commands in this chapter.
Command ADD-SOC DLT-FAC DLT-PVC ED-IP ED-LLX25 ED-PTX25 ED-ULSDCC ED-ULX25 ED-VC ENT-FAC RMV-SOC
continued
Page 19-3 19-4 19-5 19-6 19-8 19-9 19-11 19-13 19-15 19-17 19-18
19-2 Network processor command descriptions Command RTRV-CHK-SUM RTRV-CONFIG RTRV-FAC RTRV-IP RTRV-LLX25 RTRV-PTX25 RTRV-SOC RTRV-ULSDCC RTRV-ULX25 RTRV-VC Page 19-19 19-20 19-21 19-23 19-24 19-25 19-26 19-27 19-28 19-30
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Network processor command descriptions 19-3
ADD-SOC
The Add Span of Control command is used to add a network element to the NP span of control. A maximum of 16 network elements can be added to an NP span of control. Security level Level 3 Input syntax
ADD-SOC:[TID]:netid:CTAG::neuid,nepid;
Note: Passwords entered in TL1 commands are not echoed to the UI screen.
Table 19-1 Syntax definition Field TID NETID CTAG NEUID NEPID Purpose Target identifier The TID of the network element to be added to the NP span of control Correlation tag The user identifier of the network element to be added to the NP span of control The password of the network element to be added to the NP span of control
Example input
Add network element NEWYORK to the span of control of OC3NP:

ADD-SOC:OC3NP:NEWYORK:CTAG13::SURVEIL,SURVEIL;
19-4 Network processor command descriptions
DLT-FAC
The Delete Facility command is used to delete an NP facility. NP facilities include ILANSP, ILANNP, ILAN1, ILAN2, COLAN, and X25. ILANSP and ILANNP are autoprovisioned and cannot be manually deprovisioned. Security level Level 3 Input syntax
DLT-FAC:[TID]:AID:CTAG; Table 19-2 Syntax definition Field TID AID CTAG Table 19-3 AID descriptions AID type AID Command-specific values Purpose ILAN1 ILAN2 COLAN X25 Intershelf LAN-1 Intershelf LAN-2 Central office LAN X.25 Purpose Target identifier Access identifier. The NP facility to act on. Correlation tag
Example input
Delete the ILAN-2 facility on OC3NP:

DLT-FAC:OC3NP:ILAN2:CTAG24;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
DLT-PVC
The Delete Permanent Virtual Circuit (PVC) command deletes an X.25 PVC. Deleting a PVC restores the circuit to a switched virtual circuit (SVC) with default values from ULX25. Security level Level 3 Input syntax
DLT-PVC:[TID]:AID:CTAG; Table 19-4 Syntax definition Field TID AID CTAG Example input Purpose Target identifier Access identifier. The PVC to delete. Valid values are 0-15 Correlation tag
Delete PVC #11 and then retrieve VC #11:

DLT-PVC:OC3NP:11:CTAG45; RTRV-VC:OC3NP:11:CTAG45;
VC #11 is now an SVC with default values retrieved from the ULX25 database.
ED-IP
The Edit IP command is used to edit the IP address and associated parameters assigned to the COLAN on the NP. Security level Level 3 Input syntax
ED-IP:[TID]::CTAG::[IPADDR]:[Keyword=Domain,][Keyword=Domain]; Table 19-5 Syntax definition Field TID CTAG ipaddr Purpose Target identifier Correlation tag The unique IP address to be assigned to COLAN on the NP. The IP address must be in the standard dot notation, n.n.n.n (0 n 255), for example, 47.215.37.65 Subnet mask, default gateway, and broadcast address. All must be in the standard dot notation, n.n.n.n (0 n 255), for example, 47.215.37.65. See the Keyword descriptions table for details.
Keyword
Table 19-6 Keyword descriptions Keyword NETMASK Valid value 0.0.0.0 (default) Class A: 255.n.n.n Class B: 255.255.n.n Class C: 255.255.255.n Class D: 255.255.255.n Class E: 255.255.255.n 0.0.0.0 (default) n.n.n.n Description COLAN network mask. The value 0.0.0.0 means that the network mark is assigned automatically by the NP, based on the network class of the IP address. COLAN default gateway. Router for packets with unknown destination. The value 0.0.0.0 will delete the currently provisioned gateway. COLAN broadcast address. The value 0.0.0.0 means the broadcast address is assigned automatically by the NP based on the IP address.
GATEWAY
BCASTADDR
0.0.0.0 (default) n.n.n.n
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Network processor command descriptions 19-7 Example input
Change the COLAN IP address:

ED-IP:OC3IP::CTAG45::47.215.37.65;
Change the default gateway:

ED-IP:OC3IP::CTAG45::47.215.37.65:GATEWAY=47.215.0.1;
ED-LLX25
The Edit Lower Level X.25 command is used to edit the common parameters for all virtual circuits (VC) on the X.25 LAPB level. Security level Level 3 Input syntax
ED-LLX25:[TID]::CTAG:::<Keyword=Domain>; Table 19-7 Syntax definition Field TID CTAG Domain Purpose Target identifier Correlation tag Value assigned to the lower level X.25 parameters. See keyword descriptions table for details
Table 19-8 Keyword descriptions Parameter Range T1 T3 N1 N2 K 500-10000 ms 10000-300000 ms 1080-16440 bits 1-30 1-7 or 1-127 Domain Default 500 ms 30000 ms 1080 bits 30 7 8 Acknowledgment timer in milliseconds (500 ms increment) Link inactivity timer in milliseconds Maximum length of an I frame in bits (increments of 8) Maximum number of retransmissions Window size for the transmitter based on LLX25 MODULUS value Sequence number range Description
MODULUS 8 or 128 Example input
Modify the T3 and the N2 parameters:

ED-LLX25:OC3NP::CTAG45:::T3=20000,N2=20;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-PTX25
The Edit X.25 Physical Port Configuration command is used to modify the physical port configuration of X.25. Security level Level 3 Input syntax
ED-PTX25:[TID]::CTAG:::<Keyword=Domain>; Table 19-9 Syntax definition Field TID CTAG Domain Purpose Target identifier Correlation tag Value assigned to the X.25 port. See keyword description table for details
Table 19-10 Keyword descriptions Parameter Range RXCLKSRC TXCLKSRC CTS_PIN DCD_PIN DSR_PIN DTR_PIN RTS_PIN RXEXT, TXEXT RXEXT, TXEXT ENABLED DISABLED ENABLED DISABLED ENABLED DISABLED ENABLED DISABLED ENABLED DISABLED Domain Default RXEXT TXEXT ENABLED DISABLED DISABLED ENABLED ENABLED
continued
Description
Source of receive clock Source of transmit clock CTS pin configuration DCD pin configuration DSR pin configuration DTR pin configuration RTS pin configuration
19-10 Network processor command descriptions Table 19-10 (continued) Keyword descriptions Parameter Range DSR DTR RTS ON, OFF ON, OFF ON, OFF, AUTO Domain Default ON ON ON DSR pin initial value when DSR_PIN is enabled DTR pin initial value when DTR_PIN is enabled RTS pin initial value when RTS_PIN is enabled Description
Note: When the range is set to AUTO , the RTS value is under hardware control.
Example input
Modify the X.25 port configuration of OC3NP:

ED-PTX25:OC3NP::CTAG45:::RXCLKSRC=RXEXT,TXCLKSRC=RXEXT;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-ULSDCC
The Edit Upper Layer SDCC command is used to edit the network layer address of the OC-3 Express OSI stack on the NP. Three manual area addresses can be provisioned. The manual area address identifies the network to which the NP belongs. When the NP is provisioned, MANAREA0 has a default setting of 490000. You must have at least one manual area address provisioned. If you want to delete the address in MANAREA0 and it is the only address provisioned, you must first provision an address in MANAREA1 or MANAREA2, then delete the address in MANAREA0. To change a manual area address, you must ensure that at least two area addresses are provisioned. You must delete the address you want to change, then add the new address. For example, to change MANAREA1, enter the command to edit MANAREA1 and leave a blank for the domain. This clears the address in MANAREA1. Then enter the command to edit MANAREA1 again, and enter the new address for the domain. Security level Level 3 Input syntax
ED-ULSDCC:[TID]::CTAG:::<Keyword=Domain>; Table 19-11 Syntax definition Field TID CTAG Domain Purpose Target identifier Correlation tag Value assigned to the manual area address. See keyword descriptions table for details
Table 19-12 Keyword descriptions Parameter MANAREA0 MANAREA1 MANAREA2 Domain 6-26 characters, each character representing a half byte (3-13 bytes) Description Network layer area address 0 (default) Network layer area address 1 Network layer area address 2
19-12 Network processor command descriptions Example input
Edit the address in MANAREA1, by clearing the address that is already provisioned, then entering a new address:
ED-ULSDCC:OC3NP::CTAG34:::MANAREA1=; ED-ULSDCC:OC3NP::CTAG34::: MANAREA1=39840f80000000000000000000;
Delete area address 2:

ED-ULSDCC:OC3NP::CTAG34:::MANAREA0=;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-ULX25
The Edit Upper Level X.25 command is used to edit the common parameters for all switched virtual circuits (SVCs) on the X.25 network level. Note 1: To edit the parameters for a permanent virtual circuit (PVC), use the ED-VC command (page 19-15). Note 2: Changes to any of the following ULX25 parameters cause all current SVC calls to be lost and all PVC calls to be restarted: TXSIZE, RXSIZE, WNDW, MODULUS, T20, N20, T21, T22, T23, N22, N23, or DBIT. Note 3: Changes to any of the following ULX25 parameters only affect new calls: NUI, NEGFLOWCTRL, NEGTXSIZE, NEGRXSIZE, NEGTXWNDW, NEGRXWNDW, NEGTRPTCLS, NEGTXTRPT, or NEGRXTRPT. Security level Level 3 Input syntax
ED-ULX25:[TID]::CTAG:::<Keyword=Domain>; Table 19-13 Syntax definition Field TID CTAG Domain Purpose Target identifier Correlation tag Value assigned to the upper level X.25 parameters. See keyword descriptions table for details
Table 19-14 Keyword descriptions Parameter Range TXSIZE RXSIZE WNDW MODULUS 16-4096 16-4096 1-7 or 1-127 8 or 128 Domain Default 128 128 2 8 Maximum transmitting packet size Maximum receiving packet size Packet window size based on ULX25 MODULUS value Sequence number range
continued
Description
19-14 Network processor command descriptions Table 19-14 (continued) Keyword descriptions Parameter Range T20 N20 T21 T22 T23 N22 N23 DBIT NUI 5-500 sec 1-255 5-500 sec 5-500 sec 5-500 sec 1-255 1-255 Yes/No Maximum 20 ASCII characters Domain Default 180 sec 1 200 sec 180 sec 180 sec 1 1 Yes NULL string OFF 128 (Note 1) 128 (Note 1) 2 (Note 1) 2 (Note 1) OFF Data terminating equipment (DTE) restart time-out (5 sec increment) Number of T20 retries DTE call request time-out (5 sec increment) DTE reset time-out (5 sec increment) Declare time-out (5 sec increment) Number of T22 retries Number of T23 retries Delivery confirmation option Network user identification (SVC only) Negotiate flow control (NFC) NFC: Tx packet size NFC: Rx packet size NFC: Tx window size based on ULX25 MODULUS value NFC: Rx window size based on LIX25 MODULUS value Negotiate throughput class Description
NEGFLOWCTL ON/OFF NEGTXSIZE NEGRXSIZE 16-4096 16-4096
NEGTXWNDW 1-7 or 1-127 NEGRXWNDW 1-7 or 1-127 NEGTRPTCLS ON/OFF NEGTXTRPT NEGRXTRPT 7-11 7-11
10 (Note 2) Throughput class: speed of transmitter 10 (Note 2) Throughput class: speed of receiver
Note 1: The default value applies only when NEGFLOWCTRL is ON. Note 2: The default value applies only when NEGTRPTCLS is ON.
Example input
Modify the TXSIZE and the RXSIZE parameters:

ED-ULX25:OC3NP::CTAG45:::TXSIZE=256,RXSIZE=256;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ED-VC
The Edit Virtual Circuit (VC) command modifies the parameter values of the specified permanent virtual circuit (PVC). This command cannot be used to modify a switched virtual circuit (SVC). To modify SVCs, use the ED-ULX25 command (page 19-13). You can use ED-VC to change an SVC to a PVC, or to change a PVC to an SVC. To change an SVC to a PVC, you must specify the values of LCGN and LCN. Default values of TXSIZE and RXSIZE are available from ULX25 (see Table 19-16). To change a PVC to an SVC, the PVC is deleted and the circuit is restored as an SVC with default parameter values from the ULX25 (see Table 19-16). Security level Level 3 Input syntax
ED-VC:[TID]:AID:CTAG::type:<Keyword=Domain>; Table 19-15 Syntax definition Field TID AID CTAG type Domain Purpose Target identifier Access identifier. The VC number to act on. Valid values are 0-15. Null is not a valid value Correlation tag The VC type, SVC or PVC The value to be assigned to the parameter. See keyword descriptions table for details
19-16 Network processor command descriptions Table 19-16 Keyword descriptions Parameter Range T21 T22 T23 N22 N23 DBIT WNDW LCGN LCN TXSIZE RXSIZE 5-500 sec 5-500 sec 5-500 sec 1-255 1-255 Yes/No Domain Default 200 sec 180 sec 180 sec 1 1 Yes DTE call request time-out DTE reset time-out Declare time-out Number of T22 retries Number of T23 retries Delivery confirmation option Packet window size based on ULX25 MODULUS value Description
1-7 or 1-127 2 0-7 0-255 16-4096 16-4096
(see Note) Logical channel group number (see Note) Logical channel number 128 128 Maximum transmitting packet size Maximum receiving packet size
Note: Values for LCGN and LCN must be provided when switching an SVC to a PVC.
Example input
Change SVC #10 to PVC:

ED-VC:OC3NP:10:CTAG45::PVC:LCGN=0,LCN=5,WNDW=5;
This command reconfigures VC #10 to be a PVC with LCGN and LCN set to 0 and 5 respectively, and WNDW set to 5. Change PVC #10 back to SVC:
ED-VC:OC3NP:10:CTAG45::SVC:;
This command deletes PVC #10 and restores VC #10 as an SVC with WNDW reset to default value 2.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
ENT-FAC
The Enter Facility command is used to provision an NP facility. NP facilities include ILANSP, ILANNP, ILAN1, ILAN2, COLAN, and X25. ILANSP and ILANNP cannot be manually provisioned. Security level Level 3 Input syntax
ENT-FAC:[TID]:AID:CTAG; Table 19-17 Syntax definition Field TID AID CTAG Table 19-18 AID descriptions AID type AID Command-specific values Purpose ILAN1 ILAN2 COLAN X25 Intershelf LAN-1 Intershelf LAN-2 Central office LAN X.25 Purpose Target identifier Access identifier. The NP facility to act on. Correlation tag
Example input
Provision the ILAN-2 facility:

ENT-FAC:OC3NP:ILAN2:CTAG24;
RMV-SOC
The Remove Span of Control command is used to remove a network element from the NP span of control. Security level Level 3 Input syntax
RMV-SOC:[TID]:netid:CTAG; Table 19-19 Syntax definition Field TID netid CTAG Example input Purpose Target identifier The TID of the network element to be removed from the NP span of control Correlation tag
Remove network element NEWYORK from the span of control of OC3NP:

RMV-SOC:OC3NP:NEWYORK:CTAG13;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-CHK-SUM
The Retrieve Check Sum command is used to retrieve the checksum created by the NP after a file transfer from the TransportNode INM Broadband. After the file transfer, the NP calculates the checksum of the files in the given directory and the INM Broadband retrieves the checksum to verify the success of the file transfer. This command is normally used by the INM Broadband. Security level Level 1 Input syntax
RTRV-CHK-SUM:[TID]::CTAG::LOC=DirectoryName; Table 19-20 Syntax definition Field TID CTAG DirectoryName Purpose Target identifier Correlation tag The absolute path to the directory where the NP checksum is stored. DirectoryName must start with the root directory
Example input
Retrieve checksums for three files, load1, load2, and load3, stored in the directory /load/v2:
RTRV-CHK-SUM:OC3NP::CTAG13::LOC=/load/v2;

FILE=FileName,SIZE=FileSize,SUM=ChkSum
Note: The NP returns one response block for each file.

Table 19-21 Response block description Keyword FILE SIZE SUM Description Name of the file File size in bytes Checksum as a decimal number (16 bits)
RTRV-CONFIG
The Retrieve Configuration command provides the topology information of the network. PCGUI generates a MAP view based on the information from the RTRV-CONFIG command. The MAP view provides a graphical topology display of all the network elements in the NP span of control. Note: The availability of the MAP view is independent of the status of the network element in the span of control. Security level Level 1 Input syntax
RTRV-CONFIG:[TID]::CTAG; Table 19-22 Syntax definition Field TID CTAG Purpose Target identifier Correlation tag

NETID:NETID-Eqpt-slot-P, NETID-Eqpt-slot-P, NETID-Eqpt-slot-P,... Table 19-23 Response block description Keyword NETID Eqpt slot P Description TID of the SP that is in the NP span of control Transport equipment Shelf slot number Protection status. If Y, there is protection. If N, there is no protection.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-FAC
The Retrieve Facility command is used to retrieve the state of an NP facility. NP facilities include ILANSP, ILANNP, ILAN1, ILAN2, COLAN, and X25. States of all facilities can be retrieved. Security level Level 1 Input syntax
RTRV-FAC:[TID]:AID:CTAG; Table 19-24 Syntax definition Field TID AID CTAG Table 19-25 AID descriptions AID type AID Command-specific values Purpose ILANSP ILANNP ILAN1 ILAN2 COLAN X25 ALL Intershelf LAN to SP communication Intershelf LAN to NP communication Intershelf LAN-1 Intershelf LAN-2 Central office LAN X.25 All facilities Purpose Target identifier Access identifier. The NP facility to retrieve. Correlation tag
Table 19-26 NP facility state Facility State NULL IS OOS-AU, FLT IS-ANR,FLT Description Facility not provisioned or manually deprovisioned. This state does not apply to ILAN-SP and ILAN-NP Facility in service. No alarms or fault conditions detected. Facility failure Facility performance degraded
19-22 Network processor command descriptions Example input
Retrieve the X25 facility of OC3NP:

RTRV-FAC:OC3NP:X25:CTAG24;

AID::state
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-IP
The Retrieve IP command is used to retrieve the IP address and associated parameters assigned to the COLAN on the NP. COLAN allows the NP to communicate with the TransportNode INM Broadband and OC-3 Express TL1 Managed Object Agent (MOA) over TCP/IP. Security level Level 1 Input syntax
RTRV-IP:[TID]::CTAG; Table 19-27 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the IP address of the OC3NP:

RTRV-IP:OC3NP::CTAG24;

IP=n.n.n.n NETMASK=n.n.n.n GATEWAY=n.n.n.n BCASTADDR=n.n.n.n
RTRV-LLX25
The Retrieve Lower Level X.25 command is used to retrieve the LAPB level parameters of the X.25 facility. Security level Level 1 Input syntax
RTRV-LLX25:[TID]::CTAG; Table 19-28 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the X.25 facility of the OC3NP:

RTRV-LLX25:OC3NP:X.25:CTAG24;

Keyword=Domain Table 19-29 Response block description Keyword TYPE LINKS T1 T3 N1 N2 K MODULUS 500-10 000 Domain DTE Description Data terminating equipment Number of LAPB links Acknowledgment timer in milliseconds
10 000-300 000 Link inactivity timer in milliseconds 1080-16440 1-30 1-7 or 1-127 8 or 128 Maximum length of an I frame in bytes Maximum number of retransmissions Window size for the transmitter based on the LLX25 MODULUS value Sequence number range
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-PTX25
The Retrieve X.25 Physical Port Configuration command is used to retrieve the X.25 port configuration. Security level Level 1 Input syntax
RTRV-PTX25:[TID]::CTAG; Table 19-30 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the X.25 port configuration of OC3NP:

RTRV-PTX25:OC3NP::CTAG45;

::Keyword=Domain Table 19-31 Keyword descriptions Parameter RXCLKSRC TXCLKSRC CTS_PIN DCD_PIN DSR_PIN DTR_PIN RTS_PIN DSR DTR RTS Domain RXEXT, TXEXT RXEXT, TXEXT ENABLED, DISABLED ENABLED, DISABLED ENABLED, DISABLED ENABLED, DISABLED ENABLED, DISABLED ON, OFF ON, OFF ON, OFF, AUTO Description Source of receive clock Source of transmit clock CTS pin configuration (input pin) DCD pin configuration (input pin) DSR pin configuration (input pin) DTR pin configuration (output pin) RTS pin configuration (output pin) DSR pin initial value (when DSR_PIN is enabled) DTR pin initial value (when DTR_PIN is enabled) RTS pin initial value (when RTS_PIN is enabled)
RTRV-SOC
The Retrieve Span of Control command is used to retrieve all the network elements in the NP span of control. Note: The status of the network elements in the span of control (using a surveil account on the NP) is independent from the MAP view when the MAP view is retrieved since they use different links. Security level Level 1 Input syntax
RTRV-SOC:[TID]::CTAG; Table 19-32 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the span of control of OC3NP:

RTRV-SOC:OC3NP::CTAG24;

NETID::SW_VER:STATUS Table 19-33 Response block description Keyword NETID SW_VER STATUS Description Target identifier of the network element The software version of the shelf processor (SP) if STATUS is UP UP: SP to NP association up DOWN: SP to NP association down XPID: password mismatch
Note: All span of control connections are DOWN until the surveillance account (level 5 UPC) is activated.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-ULSDCC
The Retrieve Upper Level SDCC command is used to retrieve the manual area address of the OC-3 Express OSI stack on the NP. Security level Level 1 Input syntax
RTRV-ULSDCC:[TID]::CTAG; Table 19-34 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the MANAREA addresses provisioned on OC3NP:

RTRV-ULSDCC:OC3NP::CTAG24;

MANAREA0=value, MANAREA1=value, MANAREA2=value
where value is a string of up to 26 ASCII characters, or blank if the address is not provisioned.
RTRV-ULX25
The Retrieve Upper Level X.25 command is used to retrieve the network level X.25 parameters. Security level Level 1 Input syntax
RTRV-ULX25:[TID]::CTAG; Table 19-35 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the packet level X.25 parameters of OC3NP:

RTRV-ULX25:OC3NP::CTAG24;

::Keyword=Domain Table 19-36 Response block description Keyword CCITTVER MAXCIR MAXINTR TXSIZE RXSIZE WNDW MODULUS T20 N20 16-4096 16-4096 1-7 or 1-127 8 or 128 5-500 sec 1-255 Domain Description
String of 10 characters CCITT Version Maximum circuits supported Maximum DTE interfaces supported Maximum transmitting packet size Maximum receiving packet size Packet window size based on ULX25 MODULUS value Sequence number range DTE restart time-out (5 sec increment) Number of T20 retries
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Network processor command descriptions 19-29 Table 19-36 (continued) Response block description Keyword T21 T22 T23 N22 N23 DBIT NUI NEGFLOWCTL NEGTXSIZE NEGRXSIZE NEGTXWNDW NEGRXWNDW NEGTRPTCLS NEGTXTRPT NEGRXTRPT Domain 5-500 sec 5-500 sec 5-500 sec 1-255 1-255 Y/N Maximum 20 ASCII characters ON/OFF 16-4096 16-4096 1-7 or 1-127 1-7 or 1-127 ON/OFF 7-11 7-11 Description DTE call request time-out (5 sec increment) DTE reset time-out (5 sec increment) Declare time-out (5 sec increment) Number of T22 retries Number of T23 retries Delivery confirmation option Network user identification (SVC only) Negotiate flow control (NFC) NFC: Tx packet size NFC: Rx packet size NFC: Tx window size based on ULX25 MODULUS value NFC: Rx window size based on ULX25 MODULUS value Negotiate throughput class Throughput class: speed of transmitter Throughput class: speed of receiver
RTRV-VC
The Retrieve Virtual Circuit command is used to retrieve a virtual circuit (VC) and its parameter settings. Security level Level 1 Input syntax
RTRV-VC:[TID]:AID:CTAG; Table 19-37 Syntax definition Field TID AID CTAG Example input Purpose Target identifier Access identifier. The VC number to be acted upon. Valid values are 0-15. Null is not a valid value. Correlation tag
Retrieve VC #11:
RTRV-VC:OC3NP:11:CTAG24;

AID:TYPE:Keyword=Domain
where TYPE is SVC or PVC. See Table 19-38 for a description of the keywords.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Network processor command descriptions 19-31 Table 19-38 Response block description Keyword T21 T22 T23 N22 N23 DBIT WNDW LCGN LCN TXSIZE RXSIZE Description Data terminating equipment (DTE) call request time-out DTE reset time-out Declare time-out Number of T22 retries Number of T23 retries Delivery confirmation option Packet window size (PVC) Logical channel group number (PVC) Logical channel number (PVC) Maximum transmitting packet size (PVC) Maximum receiving packet size
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
20-1
Software upgrade detailed command descriptions 20This chapter is an alphabetical summary of all the TL1 commands related to upgrading software on the OC-3 Express shelf. The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and response. All commands in this chapter are supported on both the OC-3 Express network element and the network processor (NP). The following table lists all the commands in this chapter.
Command CANC-UPGRD CHK-UPGRD CMMT-UPGRD DLT-UPGRD INVK-UPGRD LOAD-REPLACE LOAD-UPGRD RTRV-SPACE RTRV-UPGRD Page 20-2 20-3 20-5 20-6 20-7 20-8 20-9 20-11 20-12
20-2 Software upgrade detailed command descriptions
CANC-UPGRD
The Cancel Upgrade command allows you to back out of the upgrade, if a commit upgrade command has not been issued. Security level Level 3 Input syntax
CANC-UPGRD:[TID]::CTAG::RNAME; Table 20-1 Syntax definition Field TID CTAG RNAME Purpose Target identifier Correlation tag Remote node name (applies to the SP only)
Table 20-2 Parameter descriptions Parameter RNAME Description The RNAME parameter applies to the SP only. The name of the node from which the old loads are retrieved. The node can be of different types: OC3NE: RNAME = the remote TID (7-20 characters) OC3NP: RNAME = the remote TID (7-20 characters) OPC: RNAME = the name of the remote OPC To obtain old loads from the PC using the RS-232 port: PC: RNAME = "PC"
Note: OC3NE is valid only for network element upgrade.

Example input
Cancel the upgrade of node Ottawa, using NP Montreal:

CANC-UPGRD:OTTAWA::CTAG24::MONTREAL;
Cancel the upgrade of NP Toronto:

CANC-UPGRD:TORONTO::CTAG12;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Software upgrade detailed command descriptions 20-3
CHK-UPGRD
The Check Upgrade command is entered with parameters specifying the new release number and where to get the files containing the new loads (PC, OPC, another network element). When CHK-UPGRD is issued from the network element user interface, the shelf processor checks if the specified location is reachable and does a pre-upgrade check to see if the network element can be upgraded. When CHK-UPGRD is issued from the NP user interface, the NP checks if the specified location is reachable and does a pre-upgrade check to see if the NP can be upgraded. Security level Level 3 Input syntax
CHK-UPGRD:[TID]::CTAG::RNAME,RELNO; Table 20-3 Syntax definition Field TID CTAG RNAME Purpose Target identifier Correlation tag The name of the node from which the new loads are retrieved. The node can be of the following types: OC3NE: RNAME = the remote TID (7-20 characters) OC3NP: RNAME = the remote TID (7-20 characters) OPC: RNAME = the name of the remote OPC For upgrade from a PC using the RS-232 port: PC: RNAME = "PC" For upgrade from the local file system: file system: RNAME = the local TID (7-20 characters)

RELNO an ASCII string identifying the release number to upgrade to
20-4 Software upgrade detailed command descriptions Example input
Check that network element Ottawa can be upgraded from network element TORONTO:
CHK-UPGRD:OTTAWA::CTAG24::TORONTO,NTNA6021;
Check that OC3NP can be upgraded from another NP:

CHK-UPGRD:OC3NP::CTAG25::OC3NP2,NTNA6021;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
CMMT-UPGRD
The Commit Upgrade command causes the new loads on the SP or the NP to become the permanent load. You cannot cancel the upgrade once the commit upgrade command has been executed. Security level Level 3 Input syntax
CMMT-UPGRD:[TID]::CTAG; Table 20-4 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Commit the upgrade load on network element OTTAWA:

CMMT-UPGRD:OTTAWA::CTAG24;
Commit the upgrade load on OC3NP:

CMMT-UPGRD:OC3NP::CTAG25;
DLT-UPGRD
The Delete Upgrade command is used to delete a release of a software load stored on the NP. Security level Level 3 Input syntax
DLT-UPGRD:[TID]::CTAG::RELNO; Table 20-5 Syntax definition Field TID CTAG RELNO Example input Purpose Target identifier Correlation tag ASCII string identifying the release number to delete
Delete the software release REL0310D.TT on network element OTTAWA:

DLT-UPGRD:OTTAWA::CTAG24::REL0310D.TT;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
INVK-UPGRD
When issued from the network element user interface, the Invoke Upgrade command causes the new shelf processor and transport loads to be executed. The new transport load runs on each transport card. When issued from the NP user interface, the Invoke Upgrade command causes the new NP load to be executed. Security level Level 3 Input syntax
INVK-UPGRD:[TID]::CTAG; Table 20-6 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Invoke the upgrade on network element NEWYORK:

INVK-UPGRD:NEWYORK::CTAG24;
Invoke the upgrade on OC3NP:

INVK-UPGRD:OC3NP::CTAG25;
LOAD-REPLACE
The Load Replace command is only available on the NP. Load Replace installs a software load specified in the TL1 command into the file system, without upgrading to it. This makes the load available for upgrades by the local network processor or other connected network elements or network processors. Security level Level 3 Input syntax
LOAD-REPLACE:[TID]::CTAG::RNAME,RELNO:[ALRMS=Domain]; Table 20-7 Syntax definition Field TID CTAG RNAME RELNO ALRMS=Domain Purpose Target identifier Correlation tag Name of the node or OPC where the load files reside Release number to install on NP. See Parameter descriptions table for details. Check alarms. See Parameter descriptions table for details.
Table 20-8 Parameter descriptions Parameter RNAME Description The name of the node from which the new loads are retrieved. The node can be of different types: OC3NP: RNAME = the remote TID (7-20 characters) OPC: RNAME = the name of the remote OPC RELNO ALRMS ASCII string identifying the release number to upgrade to If Y, proceed only if there are no alarms If N, proceed regardless of the alarm status Example input
Install load REL0400A.DM from OPC MONTREAL onto NP OTTAWANP:

LOAD-REPLACE:OTTAWANP::CTAG1::MONTREAL,REL0400A.DM;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
LOAD-UPGRD
When issued from the network element user interface, the Load Upgrade command causes the new SP and transport loads to be downloaded into the shelf processor file system. The new transport load is transferred from the shelf processor to each transport card in the network element. When issued from the NP user interface, the Load Upgrade command causes the new SP, transport, and NP loads to be downloaded into the NP file system. Security level Level 3 Input syntax
LOAD-UPGRD:[TID]::CTAG::RNAME,RELNO:[ALRMS=Domain]; Table 20-9 Syntax definition Field TID CTAG RNAME RELNO ALRMS Purpose Target identifier Correlation tag Name of the node from which the new loads are retrieved. See Parameter description table for details. Release number to upgrade to. See Parameter description table for details. Check alarms. See Parameter description table for details.
20-10 Software upgrade detailed command descriptions Table 20-10 Parameter descriptions Parameter RNAME Description The name of the node from which the new loads are retrieved. The node can be of different types: OC3NE: RNAME = the remote TID (7-20 characters) OC3NP: RNAME = the remote TID (7-20 characters) OPC: RNAME = the name of the remote OPC For upgrade from a PC using the RS-232 port: PC: RNAME = "PC" For upgrade from the local file system: file system: RNAME = the local TID (7-20 characters)

RELNO ALRMS ASCII string identifying the release number to upgrade to If YES, proceed only if there are no alarms If NO, proceed regardless of the alarm status Example input
Download the new software from network element OTTAWA to network element NEWYORK regardless of the alarm status:
LOAD-UPGRD:NEWYORK::CTAG24::OTTAWA,NTNA6021:ALRMS=NO;
Download the new software from OC3NP2 to OC3NP:

LOAD-UPGRD:OC3NP::CTAG25::OC3NP2,NTNA6021;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRV-SPACE
The Retrieve Space command is used to retrieve the available file system space to make sure there is enough space before putting a new release in the file system. Security level Level 1 Input syntax
RTRV-SPACE:[TID]::CTAG; Table 20-11 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the available file system space on OTTAWANP:

RTRV-SPACE:OTTAWANP::CTAG24; Response block x bytes available
RTRV-UPGRD
The Retrieve Upgrade command is used to retrieve the list of software releases on the file system. Security level Level 1 Input syntax
RTRV-UPGRD:[TID]::CTAG; Table 20-12 Syntax definition Field TID CTAG Example input Purpose Target identifier Correlation tag
Retrieve the list of software releases on OTTAWANP:

RTRV-UPGRD:OTTAWANP::CTAG24; Response block syntax REL3DSUN.Q1 REL30BU REL21BR
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
21-1
Automatic reports
21-
This chapter is an alphabetical summary of each OC-3 Express and Express CX network element TL1 automatic report. Automatic reports are the messages retrieved by the RTRV-AO command. Automatic reports are stored in a random access memory (RAM) cache and are also broadcast to all active TL1 accounts when each event occurs. The message descriptions in this chapter describe the purpose of the message, the syntax, and parameters returned as part of the autonomous message. Note: Automatic reports are sometimes referred to as autonomous messages. The following table lists all commands in this chapter.
Command REPTÂLM^COM REPTÂLMÊC1 REPTÂLMÊNV REPTÂLMÊIM REPTÂLMÊQPT REPTÂLM^FAC RTRVÂLMÎMA T1 REPTÂLMÔC3 REPTÂLM^STS1 REPTÂLM^STS3C REPTÂLM^T1 REPTÂLM^T3
continued
Page 21-3 21-6 21-12 21-9 21-16 21-19 21-21 21-24 21-27 21-29 21-31 21-34
21-2 Automatic reports Command REPTÂLM^VP REPTÂLM^VT1 REPT^CONFIG^CHG REPT^DBCHG REPTÊVT^COM REPTÊVTÊQPT REPTÊVTÊC1 REPTÊVTÔC3 REPTÊVT^STS1 REPTÊVT^STS3C REPTÊVT^T1 REPTÊVT^T3 REPTÊVT^VT1 REPTÊX REPT^SOC Page 21-37 21-40 21-43 21-44 21-46 21-48 21-52 21-54 21-57 21-29 21-61 21-64 21-67 21-69 21-71
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-3
REPTÂLM^COM
Report Alarm Com is generated by a network element or network processor to report alarms that affect the network processor or the shelf as a whole. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLM^COM <cr> <lf> <rspblk> + ;
The message must contain at least one occurrence of <rspblk>. Its format is:
^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>, <locn>,<dirn>:<conddescr>" <cr> <lf> ; Table 21-1 Syntax Definition Field <sid> <date> <time> <almcde> Purpose The network element or NP source identifier In the format yy-mm-dd In the format hh:mm:ss Possible alarm code values in decreasing order of severity: *C (Critical alarm) ** (Major alarm) *^ (Minor alarm) A^ (Automatic message) Automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
<atag> <rspblk>
21-4 Automatic reports Table 21-2 AID descriptions AID type shelf tid Shelf SP NP Command-specific values user-defined shelf name SHELF SP NP Purpose Identify the network element Identify the network element Identify the shelf processor Identify the network processor
Table 21-3 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL SYNCPRI SYNCSEC INT FA HLDOVRSYNC FRNGSYNC <srveff> <ocrdat> <ocrtm> <locn> <dirn> SA NSA mm-dd hh-mm-ss NEND NA Applicable Description AIDs all Critical alarm Major alarm Minor alarm Cleared alarm Switch to primary timing reference Switch to secondary timing reference Internal software failure power failure Switch to holdover synchronization Switch to freerun Service affecting Not service affecting The date when the alarm occurred The time when the alarm occurred Failure at the near end of the system Not applicable The detailed text description of the trouble
<condtype>
shelf tid shelf tid all shelf tid shelf tid shelf tid all all all all all all
<conddescr> Character string
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-5 Example message
At 9 pm on March 17, 1997,

<cr> <lf> <lf> OC3NE01 97-03-17 21:00:00 <cr> <lf> * 123 REPT ALM COM <cr> <lf> "BITS-A,COM:MJ,SYNCPRI,NSA,03-17,21-00-00,NEND,NA:\"Loss of BITSout-A Pri. Timing Ref.\"" ; <cr> <lf>
21-6 Automatic reports
REPTÂLMÊC1
Report Alarm EC1 is generated by a network element to report the occurrence of EC-1 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcd3>^<atag>^REPTÂLMÊC1 <cr> <lf> <rspblk> + ;
^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>, <locn>,<dirn>:<conddescr>" <cr> <lf> Table 21-4 Syntax definition Field <sid> <date> <time> <almcde> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Possible alarm code values in decreasing order of severity: *C (Critical alarm) ** (Major alarm) *^ (Minor alarm) A^ (Automatic message) Automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
<atag> <rspblk>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-7 Table 21-5 AID descriptions AID type Command-specific values Purpose Identify EC-1 facility where slot# = 3, 5, 7, or 9 (Express) slot# = 1 (Express CX)
EC1 facility AID EC1-slot#
Table 21-6 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL LOS LOF INT INC <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Loss of signal Loss of frame Internal hardware fault/failure Incoming failure condition Service affecting Non service affecting The date when the alarm occurred
<condtype>
hh-mm-ss The time when the alarm occurred NEND NA RCV TRMT null Near end Not applicable Receive direction only Transmit direction only Not applicable The detailed text description of the trouble
<conddescr> character string
21-8 Automatic reports Example messages
At 9 pm on October 17, 1995, the following alarm report was generated for the EC-1 in slot 7:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM EC1 <cr> <lf> "EC1-7:MN,INT,SA,10-17,21-00-00,NEND,RCV:\"EC1 Loopback Active\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÂLMÊIM
Report Alarm EIM is generated by a network element to report the occurrence of EIM bridge alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcd3>^<atag>^REPTÂLMÊIM <cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-10 Automatic reports Table 21-8 AID descriptions AID type Command-specific values Purpose Identify the EIM bridge facility where slot#=7 to 10 bridge#= 1 to 2
EIM bridge AID EIM-slot#-bridge#
<condtype>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-11 Example messages
At 9 pm on April 17, 1998, the following alarm report was generated for bridge facility 2 on the EIM circuit pack in slot 7:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM EIM <cr> <lf> "EIM-7-2:MN,INT,SA,10-17,21-00-00,NEND,RCV:\"Link Pulse Missing\"" ; <cr> <lf>
REPTÂLMÊNV
Report Alarm Environment is generated by a network element to report the occurrence of an environmental alarm. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLMÊNV <cr> <lf> <rspblk> + ;
^^^"<aid>:<ntfcncde>,<almtype>,<ocrdat>,<ocrtm>,<almmsg> <cr> <lf> ;
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-13 Table 21-10 Syntax Definition Field <sid> <date> <time> <almcde> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Possible alarm code values in decreasing order of severity: *C (Critical alarm) ** (Major alarm) *^ (Minor alarm) A^ (Automatic message) Automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
<atag> <rspblk>
Table 21-11 AID descriptions AID type 1 to 16 Purpose Identify the contact
Table 21-12 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL Applicable Description AIDs all Critical alarm Major alarm Minor alarm Cleared alarm
21-14 Automatic reports Table 21-12 (continued) Parameter descriptions Parameter <almtype> Values AIRCOMPR AIRCOND AIRDRYR BATDSCHRG BATTERY CLFAN ENGINE ENGOPRG EXPLGS FIRDETR FIRE FLOOD FUSE GEN HIAIR HIHUM HITEMP HIWTR INTRUDER Applicable Description AIDs all all all all all all all all all all all all all all all all all all all Air compressor failure Air conditioning failure Air dryer failure Battery discharging Battery failure Cooling fan failure Engine failure Engine operating Explosive gas Fire detector failure Fire Flood Fuse failure Generator failure High airflow High humidity High temperature High water Intrusion
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-15 Table 21-12 (continued) Parameter descriptions Parameter <almtype> Values LWBATVG LWFUEL LWHUM LWPRES LWTEMP LWWTR MISC OPENDR PUMP POWER PWR-48 RECT RECTHI RECTLO SMOKE TOXICGAS VENTN <ocrdat> <ocrtm> <almmsg> mm-dd hh-mm-ss character string Applicable Description AIDs all all all all all all all all all all all all all all all all all all all all Low battery voltage Low fuel Low humidity Low cable pressure Low temperature Low water Miscellaneous Open door Pump failure Commercial power failure 48-V power supply failure Rectifier failure Rectifier high voltage Rectifier low voltage Smoke Toxic gas Ventilation system failure The date when the alarm occurred The time when the alarm occurred The detailed text description of the trouble
Example message <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM ENV <cr> <lf> "1:MN,FLOOD,10-17,21-00-00:\"Flood\"" ; <cr> <lf>
REPTÂLMÊQPT
Report Alarm Equipment is generated by a network element to report the occurrence of alarmed equipment related events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLMÊQPT <cr> <lf> <rspblk> + ;
<atag> <rspblk>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-17 Table 21-14 AID descriptions AID type DS1 eqpt Command-specific values DS1-slot# Purpose Identify DS1 equipment where slot# = 3 to 10 (Express) slot# = 1 to 2 (Express CX) Identify DS3 equipment where slot# = 3 to 10 (Express) slot# = 1 to 2 (Express CX) Identify EC-1 equipment where slot# = 3 to 10 (Express) slot# = 1 to 2 (Express CX) Identify the protection switch controller Identify VTX equipment where slot# = 13 or 14 Identify OC-3 equipment where slot# = 3 to 12 (Express) slot# = 1 to 2 (Express CX) Identify MTX equipment where slot# = 3 or 4 Identify the shelf processor Identify the network processor Identify the network element
DS3 eqpt
DS3-slot#
EC1 eqpt
EC-slot#
PSC eqpt VTX eqpt OC3 eqpt
PSC VTX-slot# OC3-slot#
MTX eqpt SP eqpt NP eqpt Shelf
MTX-slot# SP NP SHELF
21-18 Automatic reports Table 21-15 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL EQPT INT SWEQPT ESW INC <srveff> <ocrdat> <ocrtm> <locn> <dirn> SA NSA mm-dd hh-mm-ss NEND NA RCV all all all all all all Applicable Description AIDs all Critical alarm Major alarm Minor alarm Cleared alarm Critical alarm caused by equipment failure Internal hardware fault/failure Protection switching equipment failure Excessive switching Incoming failure condition Service affecting Not service affecting The date when the alarm occurred The time when the alarm occurred Failure at the near end of the system Not applicable Receive direction only The detailed text description of the trouble
<condtype>
all all working EQPT AID OC3/VTX
<conddescr> Character string
Example message
At 9 p.m. on October 17, 1995, an automatic diagnostic ran and passed on the DS1 in slot 5:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM EQPT <cr> <lf> "DS1-5:MN,INT,NSA,10-17,21-00-00,NEND,NA:\"Circuit Pack Failed\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÂLM^FAC
Report Alarm Facility is generated by a network processor to report the occurrence of alarmed facility related events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLM^FAC <cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-20 Automatic reports Table 21-17 AID descriptions AID type NP facility AID Command-specific values ILAN1 ILAN2 COLAN ILANSP ILANNP X25 SHELF Purpose Identify the NP facility
Shelf
Identify the network element
Table 21-18 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL INT SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Internal software fault/failure Service affecting Non service affecting The date when the alarm occurred
<condtype> <srveff>
<conddescr> character string Example message
At 9 p.m. on October 17, 1995, the NP ILAN1:

<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM FAC<cr> <lf> "ILAN1:MN,INT,NSA,10-17,21-00-00,NEND,NA:\"Facility Failure\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
RTRVÂLMÎMA T1
Report Alarm IMA T1 is generated by a network element to report the occurrence of IMA links and IMA DS1 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcd3>^<atag>^REPTÂLMÎMAT1 <cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-22 Automatic reports Table 21-20 AID descriptions AID type EIM T1 AID Command-specific values EIM-slot#-bridge#-vp#-t1# Purpose Identify the EIM bridge facility where slot#=7 to 10 bridge#=1 to 2 vp#=1 to 8 t1#=1 to 8
<condtype>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
At 9 pm on April 17, 1998, the following alarm report was generated for bridge facility 2, virtual port 2, T1 1, on the EIM circuit pack in slot 7:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM EIM <cr> <lf> "EIM-7-2-2-1:MJ,LOF,SA,10-17,21-00-00,NEND,RCV:\"IMA Loss of IMA Frame\"" ; <cr> <lf>
REPTÂLMÔC3
Report Alarm OC3 is generated by a network element to report the occurrence of OC-3 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLMÔC3 <cr> <lf> <rspblk> + ;
<atag> <rspblk>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-25 Table 21-23 AID descriptions AID type OC3 facility AID Command-specific values OC3-slot# Purpose Identify the OC-3 facility where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX)
Table 21-24 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL LOS LOF INT INC AIS <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Loss of signal Loss of frame Internal hardware fault/failure Incoming failure condition Alarm indication signal detected Service affecting Non service affecting The date when the alarm occurred
<condtype>
21-26 Automatic reports Example messages <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> *C 123 REPT ALM OC3 <cr> <lf> "OC3-11:CR,AIS,SA,10-17,21-00-00,NEND,RCV:\"OC3 Signal Degrade\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÂLM^STS1
Report Alarm STS1 is generated by a network element to report the occurrence of STS-1 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLM^STS1<cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-28 Automatic reports Table 21-26 AID descriptions AID type STS path AID Command-specific values OC3-slot#-sts# Purpose Identify the STS path where Express slot# = 3 to 12 sts# = 1 to 3 Express CX slot# = 3 to 4 sts# = 1 to 3 STS path AID EC1-slot#-sts# Identify the EC1 where slot = 3, 5, 7, or 9 sts# = 1
Table 21-27 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL SLMF AIS INC <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Signal label mismatch failure Alarm indication signal detected Incoming failure condition Service affecting Non service affecting The date when the alarm occurred
<condtype>
hh-mm-ss The time when the alarm occurred NEND RCV Near end Receive direction only The detailed text description of the trouble
Example message <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> *C 123 REPT ALM STS1 <cr> <lf> "OC3-9-1:CR:AIS,SA,10-17,21-00-00,NEND,RCV:\"STS Rx AIS\"" ; <cr> <lf> S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998
REPTÂLM^STS3C
Report Alarm STS3C is generated by a network element to report the occurrence of STS-3C alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLM^STS3C <cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-30 Automatic reports Table 21-29 AID descriptions AID type Command-specific values Purpose Identify the STS-3C facility where slot# = 3 to 12 Table 21-30 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL SLMF AIS INC <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Signal label mismatch failure Alarm indication signal detected Incoming failure condition Service affecting Non service affecting The date when the alarm occurred
STS-3C facility OC3-slot# AID
<condtype>
Example message <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> *C 123 REPT ALM STS3C <cr> <lf> "OC3-9-1:CR:AIS,SA,10-17,21-00-00,NEND,RCV:\"STS3C Rx AIS\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÂLM^T1
Report Alarm T1 is generated by a network element to report the occurrence of DS1 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLM^T1 <cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-32 Automatic reports Table 21-32 AID descriptions AID type Command-specific values Purpose Identify the DS1 facility where Express: slot#=4 to 10 port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Table 21-33 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL LOS LOF INT INC AIS <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Loss of signal Loss of frame Internal hardware fault/failure Incoming failure condition Alarm indication signal Service affecting Non service affecting The date when the alarm occurred
DS1 facility AID DS1-slot#-port#
<condtype>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-33 Example messages <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM T1 <cr> <lf> "DS1-5-12:MN,INT,SA,10-17,21-00-00,NEND,RCV:\"DS1 Loopback Active\"" ; <cr> <lf>
REPTÂLM^T3
Report Alarm T3 is generated by a network element to report the occurrence of DS3 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcd3>^<atag>^REPTÂLM^T3 <cr> <lf> <rspblk> + ;
<atag> <rspblk>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-35 Table 21-35 AID descriptions AID type Command-specific values Purpose Identify the DS3 facility where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX)
DS3 facility AID DS3-slot#
Table 21-36 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL LOS LOF INT INC AIS <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Loss of signal Loss of frame Internal hardware fault/failure Incoming failure condition Alarm indication signal Service affecting Non service affecting The date when the alarm occurred
<condtype>
21-36 Automatic reports Example messages <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM T3 <cr> <lf "DS3-5:MN,INT,SA,10-17,21-00-00,NEND,RCV:\"DS3 Loopback Active\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÂLM^VP
Report Alarm VP is generated by a network element to report the occurrence of VP and IMA group alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcd3>^<atag>^REPTÂLM^VP <cr> <lf> <rspblk> + ;
<atag> <rspblk>
21-38 Automatic reports Table 21-38 AID descriptions AID type EIM VP AID Command-specific values EIM-slot#-bridge#-vp# Purpose Identify the EIM bridge facility where slot#=7 to 10 bridge#=1 to 2 vp#= 1 to 8
Table 21-39 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL LOS LOF INT INC AIS <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Loss of signal Loss of frame Internal hardware fault/failure Incoming failure condition Alarm indication signal Service affecting Non service affecting The date when the alarm occurred
<condtype>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
At 9 pm on April 17, 1995, the following alarm report was generated for bridge facility 2, virtual port 8, on the EIM circuit pack in slot 7:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> * 123 REPT ALM VP <cr> <lf> "EIM-7-2-8:MN,INT,SA,10-17,21-00-00,NEND,RCV:\"Virtual port not in forwarding state\"" ; <cr> <lf>
REPTÂLM^VT1
Report Alarm VT1 is generated by a network element to report the occurrence of VT1.5 alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPTÂLM^VT1 <cr> <lf> <rspblk> + ;
<atag> <rspblk>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-41 Table 21-41 AID descriptions AID type VT AID Command-specific values OC3-slot#-sts#-vtg#-vt# Purpose Identify the VT1.5 path on the OC-3 where Express slot#= 3 to 12 sts# = 1 to 3 vtg#= 1 to 7 vt#= 1 to 4 Express CX slot#= 3 to 4 sts# = 1 to 3 vtg#= 1 to 7 vt#= 1 to 4 Table 21-42 Parameter descriptions Parameter <ntfcncde> Values CR MJ MN CL SLMF AIS INC <srveff> SA NSA <ocrdat> <ocrtm> <locn> <dirn> mm-dd Description Critical alarm Major alarm Minor alarm Cleared alarm Signal label match failure Alarm indication signal detected Incoming failure condition Service affecting Non service affecting The date when the alarm occurred
<condtype>
21-42 Automatic reports Example message <cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> *C 123 REPT ALM VT1<cr> <lf> "OC3-11-1-2-2:CR,AIS,SA,10-17,21-00-00,NEND,RCV:\"STS Rx AIS\"" ; <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPT^CONFIG^CHG
Report Configuration Change is generated when the functionality detects that there may be a change in the configured network administered by the network processor. Typically this is due to expansion and reconfiguration of an existing network. An example of this might be the upgrading of a point-to-point linear network to a linear ADM chain or the addition of nodes to a ring. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> <almcde>^<atag>^REPT^CONFIG^CHG <cr> <lf> ; Table 21-43 Syntax definition Field <sid> <date> <time> <almcde> <atag> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss A^ (Automatic message) Automatic tag, the numerical identification of the message
REPT^DBCHG
Report Database Change is generated by the network element to which a name change (TID) or account change (UID) was made. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPT^DBCHG <cr> <lf> <rspblk> + ;
Note: Since an atag with 000000 is not logged into the automatic output (AO) buffer, the atag is always 000000. The message must contain at least one occurrence of <rspblk>. The format for an NE name change is:
^^^"<msgtype>:<netid>,<oldtid>,<newtid>" <cr> <lf>
The format for an NE account change is:

^^^"<msgtype>:<netid>,<olduid>,<newuid>" <cr> <lf>
Note 1: When issued for a SID change, REPT DBCHG is sent only to the TL1 session that originated the change. Note 2: When issued for a UID change, REPT DBCHG is sent to all active TL1 sessions to the shelf processor or network processor that issued the change. The affected TL1 sessions are those that have a UPC equal or greater to the UPC of the UID that was changed.
Table 21-44 Syntax definition Field <sid> <date> <time> <atag> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Automatic tag, the numerical identification of the message. The atag is always 000000 since an atag with 000000 is not logged into the automatic output (AO) buffer Response block. See the Parameter description tables for details.
<rspblk>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-45 Table 21-45 Response block parameters descriptions Parameter <msgtype> <netid> <oldtid> <newtid> <olduid> <newuid> Example message Values NNC SAC Description NE name change System account change Target identifier Old target identifier New target identifier Old user identifier New user identifier
At 9 p.m. on October 17, 1995, the name of NE01TID was changed to OC3NE01. This message will be returned:
<cr> <lf> <lf> NE01TID 95-10-17 21:00:00 <cr> <lf> A 000000 REPT DBCHG <cr> <lf> "NNC:NE01TID,NE01TID,OC3NE01" <cr> <lf>
At 10 p.m. on January 18, 1997, the user identifier EXPRESS01 on network element BOSTON was changed to EXPRESS02. This message will be returned:
<cr> <lf> <lf> BOSTON 97-01-18 22:00:00 <cr> <lf> A 000000 REPT DBCHG <cr> <lf> "SAC:BOSTON,EXPRESS01,EXPRESS02" <cr> <lf>
REPTÊVT^COM
Report Event Com is generated by a network element or network processor to report alarms that affect the network processor or the shelf as a whole. In general, an event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVT^COM <cr> <lf> <rspblk> +
^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>,<dirn>: <conddescr>" <cr> <lf> Table 21-46 Syntax Definition Field <sid> <date> <time> <atag> <rspblk> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
Table 21-47 AID descriptions AID type SP NP Shelf Command-specific values SP NP SHELF Purpose Identify the network element Identify the network processor Identify the shelf
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-47 Table 21-48 Parameter descriptions Parameter <condtype> <condeff> Values HLDOVRSYNC SWFTDWN SC TC CL mm-dd hh-mm-ss Applicable Description AIDs all all Switch to holdover synchronization Standing condition raised Transient condition Standing condition cleared The date when the event occurred The time when the event occurred The detailed text description of the trouble Failure at the near end of the system Not applicable
<ocrdat> <ocrtm>
all all all all all
<conddescr> character string <locn> <dirn> NEND NA
Example message
At 9 p.m. on March 17, 1997, during a software upgrade on network element NEWYORK, the following event is reported:
<cr> <lf> <lf> NEWYORK 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT COM <cr> <lf> "SP:SWFTDWN,TC,10-17,21-00-00,,:" Invoke upgrade passed Slot(s) 05 06 09 10 11 12 13 14 15 passed"" ; <cr> <lf>
REPTÊVTÊQPT
Report Event Equipment is generated by a network element to report the occurrence of non-alarmed equipment related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVTÊQPT <cr> <lf> <rspblk> + ;
^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>, <dirn>:<conddescr>" <cr> <lf> Table 21-49 Syntax definition Field <sid> <date> <time> <atag> <rspblk> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-49 Table 21-50 AID descriptions AID type DS1 eqpt Command-specific values DS1-slot# Purpose Identify DS1 equipment where Express slot# = 3 to 10 port# = 1 to 12 Express CX slot# = 1 to 2 (Express CX) DS3 eqpt DS3-slot# Identify DS3 equipment where slot# = 3 to 10 (Express) slot# = 1 to 2 (Express CX) Identify EC-1 equipment where slot# = 3 to 10 (Express) slot# = 1 to 2 (Express CX) Identify the protection switch controller Identify VTX equipment where slot# = 13 or 14 Identify OC-3 equipment where slot# = 3 to 12 (Express) Identify MTX equipment where slot# = 3 or 4 Identify the shelf processor Identify the network processor Identify the network element
EC1 eqpt
EC-slot#
PSC eqpt VTX eqpt OC3 eqpt MTX eqpt SP eqpt NP eqpt Shelf
PSC VTX-slot# OC3-slot# MTX-slot# SP NP SHELF
21-50 Automatic reports Table 21-51 Parameter descriptions Parameter <condtype> Values INHSWPR INHSWWKG INIT-x LPBKLINE MANSWTOINT MANSWTOPRI MANSWTOSEC MANWKSWBK MANWKSWPR NORMAL OVRDSW PROTNA SWTOINT SWTOPRI SWTOSEC WKSWBK WKSWPR <condeff> TC SC CL Applicable Description AIDs DS1 DS1 all DS3/DS1 VTX VTX VTX VTX/DS1 VTX/DS1 all VTX/DS1 DS1 VTX VTX VTX VTX/DS1 OC3 VTX/DS1 OC3 all Switch to protection inhibited Switch to working inhibited x=0: Warm initialization will occur. x=1: Cold initialization will occur Line looped back Manual synchronization switch to internal clock Manual synchronization switch to primary reference Manual synchronization switch to secondary reference Manual switch of working facility or equipment back to working Manual switch of working facility or equipment to protection unit Return to normal conditions Automatic protection switching overridden Protection unit not available Synchronization switch to internal clock Synchronization switch to primary clock Synchronization switch to secondary clock Working facility or equipment switched back to working Working facility or equipment switched to protection Transient condition Standing condition raised Standing condition cleared
continued
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-51 Table 21-51 (continued) Parameter descriptions Parameter <ocrdat> <ocrtm> <locn> <dirn> Values mm-dd hh-mm-ss NEND NA Applicable Description AIDs all all all all all The date when the event occurred The time when the event occurred Failure at the near end of the system Not applicable The detailed text description of the trouble
Example message
At 9 p.m. on March 21, 1997, the VTX in slot 13 switches to protection. This message will be returned.
<cr> <lf> <lf> OC3NE01 97-03-21 21:00:00 <cr> <lf> A 123 REPT EVT EQPT <cr> <lf> VTX-13:WKSWPR,TC,03-21,21-00-00,NEND,NA:Switch to protection ;
REPTÊVTÊC1
Report Event EC1 is generated by a network element to report the occurrence of non-alarmed EC-1 related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVTÊC1 <cr> <lf> <rspblk> + ;
^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>, <dirn>,<monval>,<thlev>,<tmper>" <cr> <lf> Table 21-52 Syntax definition Field <sid> <date> <time> <atag> <rspblk> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
Table 21-53 AID descriptions AID type EC1 eqpt Command-specific Values EC1-slot# Purpose Identify EC-1 equipment where slot# = 3 to 10 (Express) slot# = 1 (Express CX)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-53 Table 21-54 Response block parameters descriptions Parameter <condtype> <condeff> Values T-MONTYPE TC SC CL mm-dd hh-mm-ss NEND FEND TRMT RCV 1 and up 1 and up 15-MIN 1-DAY 1-UNT Description Threshold-crossing monitored threshold type Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far-end Transmit (away from the node) Receive (onto the node) Measured value of a monitored parameter Threshold level for the monitored parameter The accumulation time period
<ocrdat> <ocrtm> <locn> <dirn> monval thlev tmper
Table 21-55 Montype parameter descriptions Parameter montype Possible values CVS ESS SESS SEFSS Description Coding Violations - Section Errored Seconds - Section Severely Errored Seconds - Section Severely Errored Frame Seconds Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds- Line Unavailable Seconds - Line
CVL ESL SESL UASL Example message
At 9 p.m. on March 21, 1997, This message will be returned.

<cr> <lf> <lf> OC3NE01 97-03-21 21:00:00 <cr> <lf> A 123 REPT EVT EC1 <cr> <lf> ^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>, <dirn>,<monval>,<thlev>,<tmper>" <cr> <lf>
REPTÊVTÔC3
Report Event OC3 is generated by a network element to report the occurrence of non-alarmed OC-3 related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVTÔC3 <cr> <lf> <rspblk> + ;
Table 21-57 AID descriptions AID type OC3 eqpt AID Command-specific Values OC3-slot# Purpose Identify the OC-3 where slot# = 3 to 12 (Express) slot# = 1 to 4 (Express CX)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-55 Table 21-58 Response block parameters descriptions Parameter <condtype> <condeff> Values T-MONTYPE TC SC CL mm-dd hh-mm-ss NEND FEND RCV TRMT Description Threshold-crossing monitored threshold type Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far end Receive (onto the node) Transmit (away from the node) Condition description Measured value of a monitored parameter Threshold level for the monitored parameter The accumulation time period
<ocrdat> <ocrtm> <locn> <dirn>
<conddescr> text message monval thlev tmper 1 and up 1 and up 15-MIN 1-DAY 1-UNT
Table 21-59 Montype parameter descriptions Parameter montype Possible values CVS ESS SESS SEFSS CVL ESL SESL UASL Description Coding Violations - Section Errored Seconds - Section Severely Errored Seconds - Section Severely Errored Frame Seconds Section Coding Violations - Line Errored Seconds - Line Severely Errored Seconds- Line Unavailable Seconds - Line
21-56 Automatic reports Example message
At 9 p.m. on October 17, 1995, the OC-3 in slot 11 records bipolar violations. This message will be returned:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT OC3<cr> <lf> "OC3-11:,BPV" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÊVT^STS1
Report Event STS1 is generated by a network element to report the occurrence of non-alarmed STS-1 related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVT^STS1 <cr> <lf> <rspblk> + ;
Table 21-61 AID descriptions AID type STS path AID Command-specific Values OC3-slot#-sts# Purpose Identify the STS path where slot# = 3 to 12 (Express) slot# = 3 to 4 (Express CX) sts# = 1 to 3
21-58 Automatic reports Table 21-62 Response block parameters descriptions Parameter <condtype> <condeff> Values T-MONTYPE TC SC CL mm-dd hh-mm-ss NEND FEND RCV TRMT Description Threshold-crossing monitored threshold type Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far end Receive (onto the node) Transmit (away from the node) Condition description Measured value of a monitored parameter Threshold level for the monitored parameter The accumulation time period
Table 21-63 Montype parameter descriptions Parameter montype Possible values CVP ESP SESP ALSP UASP Example message Description Coding Violations - Path Errored Seconds - Path Severely Errored Seconds - Path AIS/LOP Seconds - Path Unavailable Seconds - Path
At 9 p.m. on October 17, 1995, the OC-3 in slot 3, sts 3 records bipolar violations. This message will be returned:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT STS1<cr> <lf> "OC3-3-3:,BPV" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÊVT^STS3C
Report Event STS3C is generated by a network element to report the occurrence of non-alarmed STS-3C related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVT^STS3C <cr> <lf> <rspblk> + ;
Table 21-65 AID descriptions AID type STS-3C facility AID Command-specific Values OC3-slot# Purpose Identify the STS-3C facility where slot# = 3 to 12
21-60 Automatic reports Table 21-66 Response block parameters descriptions Parameter <condtype> <condeff> Values T-MONTYPE TC SC CL mm-dd hh-mm-ss NEND FEND RCV TRMT Description Threshold-crossing monitored threshold type Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far end Receive (onto the node) Transmit (away from the node) Condition description Measured value of a monitored parameter Threshold level for the monitored parameter The accumulation time period
Table 21-67 Montype parameter descriptions Parameter montype Possible values CVP ESP SESP ALSP UASP Example message Description Coding Violations - Path Errored Seconds - Path Severely Errored Seconds - Path AIS/LOP Seconds - Path Unavailable Seconds - Path
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT STS3C <cr> <lf> "OC3-3:,BPV" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÊVT^T1
Report Event T1 is generated by a network element to report the occurrence of non-alarmed DS1 related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVT^T1 <cr> <lf> <rspblk> + ;
^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>, <dirn>,<monval>,<thlev>,<tmper>" <cr> <lf> Table 21-68 Syntax definition Field <sid> <date> <time> <atag> <rspblk> Purpose The network element source identifier in the format yy-mm-dd in the format hh:mm:ss automatic tag, the numerical identification of the message Response block. See the following AID and Parameter description tables for details.
21-62 Automatic reports Table 21-69 AID descriptions AID type DS1 AID Command-specific Values DS1-slot#-port# Purpose Identify the DS1 facility where Express: slot#=4 to 10 port#=1 to 12 Express CX: slot#=1, port#=1 to 12 slot#=3, port#=1 to 8 Table 21-70 Response block parameters descriptions Parameter <condtype> <condeff> Values T-MONTYPE TC SC CL mm-dd hh-mm-ss NEND FEND RCV TRMT 1 and up 1 and up 15-MIN 1-DAY 1-UNT Description Threshold-crossing monitored threshold type Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far end Receive (onto the node) Transmit (away from the node) Measured value of a monitored parameter Threshold level for the monitored parameter The accumulation time period
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-63 Table 21-71 Montype parameter descriptions Parameter montype Possible values CVL ESL SESL CVP ESP SEFSP SESP SASP UASP CSSP Example message Description Coding Violations - Line Errored Seconds - Line Severely Errored Seconds - Line Coding Violations - Path Errored Seconds - Path Severely Errored Frame Seconds - Path Severely Errored Seconds - Path SEF / AIS Seconds - Path Unavailable Seconds - Path Controlled Slip Seconds - Path
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT T1<cr> <lf> "OC3-3-3:,BPV" <cr> <lf>
REPTÊVT^T3
Report Event T3 is generated by a network element to report the occurrence of non-alarmed DS3 related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVT^T3 <cr> <lf> <rspblk> + ;
Table 21-73 AID descriptions AID type DS3 AID Command-specific Values DS3-slot# Purpose Identify the DS3 where slot#=3, 5, 7, or 9 (Express) slot#=1 (Express CX)
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Automatic reports 21-65 Table 21-74 Response block parameters descriptions Parameter <condtype> <condeff> Values T-MONTYPE TC SC CL mm-dd hh-mm-ss NEND FEND RCV TRMT 1 and up 1 and up 15-MIN 1-DAY 1-UNT Description Threshold-crossing monitored threshold type Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far end Receive (onto the node) Transmit (away from the node) Measured value of a monitored parameter Threshold level for the monitored parameter The accumulation time period
Table 21-75 Montype parameter descriptions Parameter montype Possible values CVL ESL SESL CVP ESP SEFSP SESP SASP UASP CSSP Description Coding Violations - Line Errored Seconds - Line Severely Errored Seconds - Line Coding Violations - Path Errored Seconds - Path Severely Errored Frame Seconds - Path Severely Errored Seconds - Path SEF / AIS Seconds - Path Unavailable Seconds - Path Controlled Slip Seconds - Path
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT T3<cr> <lf> "OC3-3-3:,BPV" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÊVT^VT1
Report Event VT1 is generated by a network element to report the occurrence of non-alarmed VT1.5 related events. The event being reported can be a change of status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPTÊVT^VT1 <cr> <lf> <rspblk> + ;
21-68 Automatic reports Table 21-77 AID descriptions AID type VT1 AID Command-specific Values OC3-slot#-sts#-vtg#-vt# Purpose Identify the OC-3 path where Express slot#= 3 to 12 sts# = 1 to 3 vtg#= 1 to 7 vt#= 1 to 4 Express CX slot#= 3 to 4 sts# = 1 to 3 vtg#= 1 to 7 vt#= 1 to 4 Table 21-78 Response block parameters descriptions Parameter <condtype> <condeff> Values INT TC SC CL mm-dd hh-mm-ss NEND FEND TRMT RCV 1 and up Description Internal hardware fault/failure Transient condition Standing condition raised Standing condition cleared Date when the event occurred Time when the event occurred Near end Far end Transmit (away from the node) Receive (onto the node) Measured value of a monitored parameter
<ocrdat> <ocrtm> <locn> <dirn> monval
Example message
At 9 p.m. on October 17, 1995, the OC-3 in slot 3, STS-3 records bipolar violations. This message will be returned:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT VT1<cr> <lf> "OC3-3-3:,BPV" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPTÊX
Report exercise is generated by a network element to inform the user or the OS of the results of a periodic exercise. Related commands are SCHED-EX-OC3 and RTRV-EXSCHED-OC3. Message format The message format depends on the results of the exercise. If the exercises are all successful and the results of only failed exercises were requested, the message format is as follows:
cr lf lf ^^^<rsphdr> cr lf A^^<atag>^REPTÊXÔC3 cr lf ;
Otherwise, the message format is as follows:

cr lf lf ^^^<rsphdr> cr lf A^^<atag>^REPTÊXÔC3 cr lf <rspblk> + ;
where <rspblk> has the format:

^^^"<aid>:<rslt>" cr lf
Possible values for <rslt>: FAIL the exercise has determined unit failure PASS the exercise found no problem in the unit NOEX the exercise could not be run on the specified unit
Table 21-79 Syntax definition Field <sid> <date> <time> <atag> <rspblk> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Automatic tag, the numerical identification of the message Response block.
At 9 p.m. on October 17, 1995, the exerciser ran and passed on the OC-3 in slot 11. This message will be returned:
<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EX OC3 <cr> <lf> "OC3-11:PASS" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
REPT^SOC
The Report Span of Control is generated by the NP to a level 5 user if there is a change in the span of control of the NP, such as an NE is removed from or added to the span of control, or the connection status from an NP to an NE in the span of control is changed. Message format All parameters in this message are either positional or name defined.
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> A^^<atag>^REPT^SOC <cr> <lf> ^^^<msgtype>:<netid>,<status>,<swversion> <cr> <lf> ;
Note: Since an atag with 000000 is not logged into the automatic output (AO) buffer, the atag is always 000000.
21-72 Automatic reports Table 21-80 Syntax definition Field <sid> <date> <time> <atag> <msgtype> <netid> <status> <swversion> Purpose The network element source identifier In the format yy-mm-dd In the format hh:mm:ss Automatic tag, the numerical identification of the message See Response block parameters descriptions table for details.
Table 21-81 Response block parameters descriptions Parameter <msgtype> Values EAD ERM CSR Description NE added NE removed Connection status report Target identifier UP DOWN XPID Connection is up Connection is down Incorrect password Software version
<netid> <status>
<swversion>
Note: For the Connection status report notification, the software version is provided only if the connection status changes from DOWN to UP, or from XPID to UP.
Example message
At 9 p.m. on October 17, 1995, the connection status from NP OC3NP01 to network element OC3NE02 was changed from down to up. This message will be returned:
<cr> <lf> <lf> OC3NP01 95-10-17 21:00:00 <cr> <lf> A 000000 REPT SOC <cr> <lf> "CSR:OC3NE02,UP,REL0300A.CG" <cr> <lf>
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
22-1
Error codes and messages
22-
Whenever a TL1 command is incorrectly entered, addresses equipment, a logical device or a facility that does not exist, or is misspelled, the TL1 interface will return a DENY message, a four-letter error code and a text message explaining the error. The error code and error text appear in the error response message as follows:
<cr> <lf> <lf> ^^^<sid>^<date>^<time> <cr> <lf> M^^<ctag>^DENY <cr> <lf> ^^^<errcde> <cr> <lf> ^^^/*error text*/ <cr> <lf> ;
This chapter lists the error codes and error text messages for TL1 commands as displayed in the error response.
22-2 Error codes and messages Table 22-1 TL1 response error codes Error code ENEQ ENEX ENPS ENSI Error text Equipage, Not EQuipped Equipage, Not equipped with EXercise capability Equipage, Not equipped with Protection Switching Invalid VTX version Applicable commands ENT-<FAC> exerciser protection switching SET-TMG-MODE
Note: The user selected EXT and the appropriate VTX modules are not present, for example, VTX is used instead of VTX+ or VTXe, there is a mix of VTX modules , or no VTX modules are present.
EQWT IATA IBEX IBMS ICNV IDNV IDRG IEAE IENE IIAC IICT IIPG IITA INUP IPEX IPMS IPNV ODNV EQuipage, Wrong Type Input, Ambiguous TID Input, Block EXtra Input, Block MiSsing Input, Command Not Valid Input, Data Not Valid Input, Data, RanGe error Input, Entity Already Exists Input, Entity Not Exists Input, Invalid ACcess identifier Input, Invalid Correlation Tag Input, Invalid Parameter Grouping Input, Invalid TArget identifier Input, Non-null Unimplemented Parameter Input, Parameter EXtra Input, Parameter MiSsing Input, Parameter Not Valid Output, Data Not Valid
continued
network element commands all all all all commands with parameters commands with parameters provisioning provisioning all all PM commands all all all commands with parameters commands with parameters all
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
Error codes and messages 22-3 Table 22-1 (continued) TL1 response error codes Error code PIUC PIUI PLNA PRTL SAAL SAAS SABT SAIN SAIS SAMS SAOP SAPR SARB SARL SDNC SDNR SLEM SNSR SNVS SPFA SPLD SRCI SROF SRPR SSRD SSRE Error text Privilege, Illegal User Code Privilege, Illegal User Identity Privilege, Login Not Active PaRTiaLly completed Status, Already ALlowed Status, Already ASsigned Status, ABorTed Status, Already INhibited Status, Already In Service Status, Already in Maintenance State Status, Already OPerated Status, Already in PRotection state Status, All Resources Busy Status, Already ReLeased Status, Data Not Consistent Status, Data Not Ready Status, List Exceeds Maximum Status, No Switch Request outstanding Status, Not in Valid State Status, Protection unit FAiled Status, Protection unit LockeD Status, Requested Command Inhibited Status, Requested Operation Failed Status, switch Request PReempted Status, Switch Request Denied Status, System Resources Exceeded
continued
Applicable commands admin and security commands admin and security commands all DataComm ALW commands network element type commands all INH commands provisioning provisioning protection switching protection switching all protection switching provisioning provisioning admin and security commands protection switching ACT-USER and provisioning protection switching protection switching exerciser protection switching protection switching protection switching all
22-4 Error codes and messages Table 22-1 (continued) TL1 response error codes Error code SSTP SWFA SWLD Error text Status, SToPped Status, Working unit FAiled Status, Working unit LockeD Applicable commands all protection switching protection switching
S/DMS TransportNode
OC-3 MX and CX 323-1051-190G
23-1
Index
A
Automatic report REPTÂLM^COM 21-3 REPTÂLMÊC1 21-6 REPTÂLMÊIM 21-9 REPTÂLMÊNV 21-12 REPTÂLMÊQPT 21-16 REPTÂLM^FAC 21-19 REPTÂLMÎMA T1 21-21 REPTÂLMÔC3 21-24 REPTÂLM^STS1 21-27 REPTÂLM^STS3C 21-29 REPTÂLM^T1 21-31 REPTÂLM^T3 21-34 REPTÂLM^VP 21-37 REPTÂLM^VT1 21-40 REPT^CONFIG^CHG 21-43 REPT^DBCHG 21-44 REPTÊVT^COM 21-46 REPTÊVTÊC1 21-52 REPTÊVTÊQPT 21-48 REPTÊVTÔC3 21-54 REPTÊVT^STS1 21-57 REPTÊVT^STS3C 21-59 REPTÊVT^T1 21-61 REPTÊVT^T3 21-64 REPTÊVT^VT1 21-67 REPTÊX 21-69 REPT^SOC 21-71
23E
Error codes and messages (TL1), definition 22-1
I
IEEE routing ID 3-6
O
Online help for TL1, description 1-10 Optical interface autonomous messages, format 1-9 command response header, format 1-8 introduction to commands 1-3 message notation 1-6 message types 1-8 online help for TL1 1-10 TL1 overview 1-1
P
Password identifier (PID), definition 1-3
S
Security access level, definition 1-4 Software upgrade network element 20-1 network processor (NP) 20-1 Source identifier (SID), definition 1-4
C
CTAG, definition 1-6
T
Target identifier (TID), definition 1-4
23-2 Index
TL1 command description ACT-USER 2-3 ADD-SOC 19-3 ALW-EX-OC3 11-2 ALW-MSG-ALL 15-3 CANC-PROV 2-4 CANC-UPGRD 20-2 CANC-USER 2-5 CHK-PROV 2-6 CHK-UPGRD 20-3 CMMT-PROV 2-9 CMMT-ROLL-STS1 9-21 CMMT-ROLL-STS3C 9-23 CMMT-ROLL-VT1 9-19 CMMT-UPGRD 20-5 CONN-TSTSIG-T1 10-2 CONN-TSTSIG-T3 10-4 DISC-TSTSIG-T1 10-6 DISC-TSTSIG-T3 10-7 DLT-CRS-STS1 8-2 DLT-CRS-STS3C 8-4 DLT-CRS-VT1 8-6 DLT-EC1 6-3 DLT-EIM 6-4 DLT-EQPT 5-2 DLT-FAC 19-4 DLT-FFP-OC3 6-5 DLT-LLSDCC 16-2 DLT-MIB-BRIDGE 7-2 DLT-MIB-IP 7-4 DLT-OC3 6-6 DLT-PROV 2-10 DLT-PVC 19-5 DLT-ROLL-STS1 9-28 DLT-ROLL-STS3C 9-30 DLT-ROLL-VT1 9-25 DLT-SECU-USER 2-12 DLT-T1 6-7 DLT-T3 6-8 DLT-UPGRD 20-6 ED-CRS-STS1 8-9 ED-CRS-STS3C 8-14 ED-CRS-VT1 8-19 ED-DAT 2-13 ED-DFLT-AINS 6-9 ED-EC1 6-10 ED-EIM 6-11
TL1 command description (continued) ED-FFP-OC3 6-13 ED-IMA-GRP 6-14 ED-IP 19-6 ED-LLSDCC 16-3 ED-LLX25 19-8 ED-MIB-BRIDGE 7-6 ED-MIB-IP 7-9 ED-MIB-SNMP 7-12 ED-MIB-SYSTEM 7-13 ED-MIB-VIEW 7-15 ED-NETYPE 3-2 ED-OC3 6-16 ED-PTX25 19-9 ED-ROLL-STS1 9-15 ED-ROLL-STS3C 9-17 ED-ROLL-VT1 9-12 ED-SECU-PID 2-14 ED-SECU-USER 2-16 ED-STS1 18-2 ED-T1 6-19 ED-T3 6-24 ED-TARP-CONFIG 13-2 ED-TARP-TBL 13-5 ED-ULSDCC 16-6, 19-11 ED-ULX25 19-13 ED-VC 19-15 ENT-CRS-STS1 8-26 ENT-CRS-STS3C 8-28 ENT-CRS-VT1 8-30 ENT-EC1 6-26 ENT-EIM 6-28 ENT-EQPT 5-4 ENT-FAC 19-17 ENT-FFP-OC3 6-30 ENT-LLSDCC 16-8 ENT-MIB-BRIDGE 7-19 ENT-MIB-IP 7-21 ENT-OC3 6-31 ENT-ROLL-STS1 9-6 ENT-ROLL-STS3C 9-9 ENT-ROLL-VT1 9-3 ENT-SECU-USER 2-18 ENT-T1 6-33 ENT-T3 6-37 EX-SW-OC3 11-3 INH-EX-OC3 11-5
S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998
Index 23-3
TL1 command description (continued) INH-MSG-ALL 15-4 INIT-COLD 17-2 INIT-REG-ALL 12-3 INIT-REG-EC1 12-7 INIT-REG-OC3 12-11 INIT-REG-STS1 12-15 INIT-REG-STS3C 12-20 INIT-REG-T1 12-24 INIT-REG-T3 12-29 INIT-WARM 17-4 INVK-UPGRD 20-7 LOAD-REPLACE 20-8 LOAD-UPGRD 20-9 OPR-ACO-ALL 15-5 OPR-BITSOUTSW 4-2 OPR-EXT-CONT 15-6 OPR-LPBK-EC1 10-8 OPR-LPBK-T1 10-10 OPR-LPBK-T3 10-12 OPR-PROTNSW-EQPT 11-6 OPR-PROTNSW-OC3 11-8 OPR-PROTNSW-STS1 11-10 OPR-PROTNSW-STS3C 11-12 OPR-PROTNSW-VT1 11-14 OPR-SYNCSW 4-3 OPR-TARP-TEF 13-8 RLS-EXT-CONT 15-8 RLS-LPBK-EC1 10-14 RLS-LPBK-T1 10-15 RLS-LPBK-T3 10-16 RLS-PROTNSW-EQPT 11-16 RLS-PROTNSW-OC3 11-17 RLS-PROTNSW-STS1 11-18 RLS-PROTNSW-STS3C 11-19 RLS-PROTNSW-VT1 11-20 RMV-EC1 6-39 RMV-EIM 6-40 RMV-EQPT 5-7 RMV-OC3 6-41 RMV-SOC 19-18 RMV-T1 6-42 RMV-T3 6-43 RST-EC1 6-44 RST-EIM 6-45 RST-EQPT 5-9 RST-OC3 6-46
TL1 command description (continued) RST-PROV 2-20 RST-T1 6-47 RST-T3 6-48 RTRV-ACTIVE-USER 2-23 RTRV-ALM-ALL 15-10 RTRV-ALM-ENV 15-15 RTRV-ALMID-rr 15-20 RTRV-AO 15-22 RTRV-ATTR-CONT 15-24 RTRV-ATTR-ENV 15-26 RTRV-BITS-IN 4-4 RTRV-BITS-OUT 4-5 RTRV-CHK-SUM 19-19 RTRV-COND-ALL 15-29 RTRV-CONDATTR-COM 15-31 RTRV-CONDATTR-rr 15-32 RTRV-CONFIG 19-20 RTRV-CRS-STS1 8-33 RTRV-CRS-STS3C 8-37 RTRV-CRS-VT1 8-40 RTRV-DFLT-AINS 6-49 RTRV-EC1 6-50 RTRV-EIM 6-52 RTRV-EQPT 5-11 RTRV-EXSCHED-OC3 11-21 RTRV-EXT-CONT 15-34 RTRV-FAC 19-21 RTRV-FFP-OC3 6-55 RTRV-HDR 2-24 RTRV-HELP 2-25 RTRV-IMA-GRP 6-57 RTRV-INVENTORY 5-15 RTRV-IP 19-23 RTRV-LLSDCC 16-9 RTRV-LLX25 19-24 RTRV-MIB-BRIDGE 7-23 RTRV-MIB-ICMP 7-29 RTRV-MIB-IF 7-32 RTRV-MIB-IP 7-35 RTRV-MIB-LAN 7-41 RTRV-MIB-SNMP 7-44 RTRV-MIB-SYSTEM 7-48 RTRV-MIB-UDP 7-50 RTRV-MIB-VIEW 7-52 RTRV-NETYPE (NP host) 3-5 RTRV-NETYPE (SP host) 3-3
23-4 Index
TL1 command description (continued) RTRV-NTFCNCDE 15-36 RTRV-OC3 6-59 RTRV-PM-ABORT 12-33 RTRV-PM-ALL 12-34 RTRV-PM-EC1 12-39 RTRV-PM-OC3 12-43 RTRV-PM-STS1 12-47 RTRV-PM-STS3C 12-52 RTRV-PM-T1 12-56 RTRV-PM-T3 12-60 RTRV-PROTNSW-rr 11-23 RTRV-PROV-LST 2-26 RTRV-PTHTRC-STS1 18-4 RTRV-PTX25 19-25 RTRV-ROLL-STS1 9-34 RTRV-ROLL-STS3C 9-36 RTRV-ROLL-VT1 9-32 RTRV-RTG-TBL 3-6 RTRV-SECU-UPC 2-28 RTRV-SECU-USER 2-29 RTRV-SOC 19-26 RTRV-SPACE 20-11 RTRV-STSBIP 15-37 RTRV-SW-VER 3-10 RTRV-SYNCSTIN 4-7 RTRV-T1 6-63 RTRV-T3 6-68 RTRV-TARP-CONFIG 13-10 RTRV-TARP-TBL 13-12 RTRV-TBOS 14-2 RTRV-TH-ALL 12-64 RTRV-TH-EC1 12-67 RTRV-TH-OC3 12-70 RTRV-TH-STS1 12-73 RTRV-TH-STS3C 12-76 RTRV-TH-T1 12-79 RTRV-TH-T3 12-82 RTRV-TMG-MODE 4-8 RTRV-TMREFIN 4-9 RTRV-TRC-OC3 18-6 RTRV-ULSDCC 16-12, 19-27 RTRV-ULX25 19-28 RTRV-UPGRD 20-12 RTRV-VC 19-30 RTRV-VP 6-70 SAV-PROV 2-31
TL1 command description (continued) SCHED-EX-OC3 11-26 SET-ATTR-CONT 15-38 SET-ATTR-ENV 15-40 SET-BITS-IN 4-11 SET-BITS-OUT 4-12 SET-CONDATTR-COM 15-44 SET-CONDATTR-rr 15-45 SET-NTFCNCDE 15-47 SET-SID 2-34 SET-STSBIP-OFF 15-48 SET-STSBIP-ON 15-49 SET-SYNCSTIN 4-14 SET-TBOS 14-4 SET-TH-ALL 12-85 SET-TH-EC1 12-87 SET-TH-OC3 12-90 SET-TH-STS1 12-93 SET-TH-STS3C 12-96 SET-TH-T1 12-99 SET-TH-T3 12-102 SET-TMG-MODE 4-16 SET-TMREFIN 4-17 VALD-PROV 2-36 Transaction Language 1 (TL1) autonomous messages, format 1-9 command interface, introduction 1-3 command response header, format 1-8 CTAG, definition 1-6 error codes and messages, definition 22-1 message notation 1-6 message types 1-8 online syntax help 1-10 overview 1-1 password identifier, definition 1-3 security access level 1-4 source identifier, definition 1-4 standards compliance 1-1 target identifier, definition 1-4 user identifier, definition 1-3 user privilege codes, definition 1-4
U
User identifier (UID), definition 1-3 User privilege codes (UPC), definition 1-4
S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998
SONET Transmission Products
S/DMS TransportNode OC-3 Express and Express CX

TL1 Reference
19961998 Northern Telecom All rights reserved All information contained in this document is subject to change without notice. Northern Telecom reserves the right to make changes to equipment design or program components, as progress in engineering, manufacturing methods, or other circumstances may warrant. Ethernet is a trademark of Xerox Corporation. S/DMS TransportNode and the Nortel logo are trademarks of Northern Telecom. VT100 is a trademark of Digital Equipment Corporation. 323-1051-190G Standard Doc Issue 5 November 1998 Printed in Canada

323-1051-190G TL1 Reference Iss 5

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

323-1051-190G TL1 Reference Iss 5

Uploaded by

Copyright:

Available Formats

NTN465BE

SONET Transmission Products

S/DMS TransportNode OC-3 Express and Express CX

1997-1998 Northern Telecom All rights reserved

Introducing OC-3 TL1

Security and administration detailed command descriptions

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

System detailed command descriptions

Synchronization detailed command descriptions

Equipment detailed command descriptions

Facility detailed command descriptions

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

MIB detailed command descriptions

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

Cross-connect detailed command descriptions

Inservice traffic rollover command descriptions

Facility test signal generation and loopback detailed command descriptions

Protection switching detailed command descriptions

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

Performance monitoring detailed command descriptions

TARP detailed command descriptions

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

TBOS detailed command descriptions

Alarm, events, and external controls detailed command descriptions

SDCC detailed command descriptions

Initialization detailed command descriptions

Path and section trace detailed command descriptions

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

Network processor command descriptions

Software upgrade detailed command descriptions

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

Error codes and messages Index

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

About this document

Supported software releases

Who should use this guide

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

xii About this document

Technical support and information

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

About this document xiii

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

xiv About this document

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

Introducing OC-3 TL1

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

1-2 Introducing OC-3 TL1

TL1 user interface on the network element

TL1 user interface on the network processor

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

Introducing OC-3 TL1 1-3

TL1 command interface

TL1 Reference 323-1051-190G Doc Issue 5 Standard Nov 1998

1-4 Introducing OC-3 TL1

OC-3 MX and CX 323-1051-190G

Doc Issue 5 Standard Nov 1998

Introducing OC-3 TL1 1-5