323-1051-190g tl1 reference iss 5

NTN465BE 323-1051-190G

SONET Transmission Products

S/DMS TransportNode OC-3 Express and Express CXTL1 Reference

Standard Doc Issue 5 November 1998

What’s inside...

Introducing OC-3 TL1TL1 detailed command descriptionsAutomatic reportsError codes and messages

1997-1998 Northern TelecomAll 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

ContentsAbout this document xiSupported software releases xiTechnical support and information xii

Introducing OC-3 TL1 1-1TL1 command interface 1-3

Obtaining the TL1 prompt 1-3User identifier 1-3Password identifier 1-3Security access level 1-4Target identifier and source identifier 1-4Default TID 1-5Multiple sessions 1-5

TL1 message notation 1-6Access identifier 1-6Correlation tag 1-6Command structure 1-7Command grouping 1-7Mandatory punctuation 1-7TL1 command acknowledgment 1-7

TL1 message overview 1-8TL1 message types 1-8TL1 command response header 1-8

Editing features 1-10Online syntax help 1-10

Security and administration detailed command descriptions 2-1ACT-USER 2-3CANC-PROV 2-4CANC-USER 2-5CHK-PROV 2-6CMMT-PROV 2-9DLT-PROV 2-10DLT-SECU-USER 2-12ED-DAT 2-13ED-SECU-PID 2-14ED-SECU-USER 2-16ENT-SECU-USER 2-18

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

iv Contents

RST-PROV 2-20RTRV-ACTIVE-USER 2-23RTRV-HDR 2-24RTRV-HELP 2-25RTRV-PROV-LST 2-26RTRV-SECU-UPC 2-28RTRV-SECU-USER 2-29SAV-PROV 2-31SET-SID 2-34VALD-PROV 2-36

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

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

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

Facility detailed command descriptions 6-1DLT-EC1 6-3DLT-EIM 6-4DLT-FFP-OC3 6-5DLT-OC3 6-6DLT-T1 6-7DLT-T3 6-8ED-DFLT-AINS 6-9ED-EC1 6-10ED-EIM 6-11

S/DMS TransportNode OC-3 MX and CX 323-1051-190G Doc Issue 5 Standard Nov 1998

Contents v

ED-FFP-OC3 6-13ED-IMA-GRP 6-14ED-OC3 6-16ED-T1 6-19ED-T3 6-24ENT-EC1 6-26ENT-EIM 6-28ENT-FFP-OC3 6-30ENT-OC3 6-31ENT-T1 6-33ENT-T3 6-37RMV-EC1 6-39RMV-EIM 6-40RMV-OC3 6-41RMV-T1 6-42RMV-T3 6-43RST-EC1 6-44RST-EIM 6-45RST-OC3 6-46RST-T1 6-47RST-T3 6-48RTRV-DFLT-AINS 6-49RTRV-EC1 6-50RTRV-EIM 6-52RTRV-FFP-OC3 6-55RTRV-IMA-GRP 6-57RTRV-OC3 6-59RTRV-T1 6-63RTRV-T3 6-68RTRV-VP 6-70

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


vi Contents

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

Inservice traffic rollover command descriptions 9-1ENT-ROLL-VT1 9-3ENT-ROLL-STS1 9-6ENT-ROLL-STS3C 9-9ED-ROLL-VT1 9-12ED-ROLL-STS1 9-15ED-ROLL-STS3C 9-17CMMT-ROLL-VT1 9-19CMMT-ROLL-STS1 9-21CMMT-ROLL-STS3C 9-23DLT-ROLL-VT1 9-25DLT-ROLL-STS1 9-28DLT-ROLL-STS3C 9-30RTRV-ROLL-VT1 9-32RTRV-ROLL-STS1 9-34RTRV-ROLL-STS3C 9-36

Facility test signal generation and loopback detailed command descriptions 10-1CONN-TSTSIG-T1 10-2CONN-TSTSIG-T3 10-4DISC-TSTSIG-T1 10-6DISC-TSTSIG-T3 10-7OPR-LPBK-EC1 10-8OPR-LPBK-T1 10-10OPR-LPBK-T3 10-12RLS-LPBK-EC1 10-14RLS-LPBK-T1 10-15RLS-LPBK-T3 10-16

Protection switching detailed command descriptions 11-1ALW-EX-OC3 11-2EX-SW-OC3 11-3INH-EX-OC3 11-5OPR-PROTNSW-EQPT 11-6


Contents vii

OPR-PROTNSW-OC3 11-8OPR-PROTNSW-STS1 11-10OPR-PROTNSW-STS3C 11-12OPR-PROTNSW-VT1 11-14RLS-PROTNSW-EQPT 11-16RLS-PROTNSW-OC3 11-17RLS-PROTNSW-STS1 11-18RLS-PROTNSW-STS3C 11-19RLS-PROTNSW-VT1 11-20RTRV-EXSCHED-OC3 11-21RTRV-PROTNSW-rr 11-23SCHED-EX-OC3 11-26

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

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


viii Contents

TBOS detailed command descriptions 14-1RTRV-TBOS 14-2SET-TBOS 14-4

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

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

Initialization detailed command descriptions 17-1INIT-COLD 17-2INIT-WARM 17-4

Path and section trace detailed command descriptions 18-1ED-STS1 18-2RTRV-PTHTRC-STS1 18-4RTRV-TRC-OC3 18-6


Contents ix

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

Software upgrade detailed command descriptions 20-1CANC-UPGRD 20-2CHK-UPGRD 20-3CMMT-UPGRD 20-5DLT-UPGRD 20-6INVK-UPGRD 20-7LOAD-REPLACE 20-8LOAD-UPGRD 20-9RTRV-SPACE 20-11RTRV-UPGRD 20-12

Automatic reports 21-1REPTÂLM^COM 21-3REPTÂLMÊC1 21-6REPTÂLMÊIM 21-9REPTÂLMÊNV 21-12REPTÂLMÊQPT 21-16REPTÂLM^FAC 21-19RTRVÂLMÎMA T1 21-21REPTÂLMÔC3 21-24REPTÂLM^STS1 21-27REPTÂLM^STS3C 21-29REPTÂLM^T1 21-31REPTÂLM^T3 21-34REPTÂLM^VP 21-37REPTÂLM^VT1 21-40REPT^CONFIG^CHG 21-43


x Contents

REPT^DBCHG 21-44REPTÊVT^COM 21-46REPTÊVTÊQPT 21-48REPTÊVTÊC1 21-52REPTÊVTÔC3 21-54REPTÊVT^STS1 21-57REPTÊVT^STS3C 21-59REPTÊVT^T1 21-61REPTÊVT^T3 21-64REPTÊVT^VT1 21-67REPTÊX 21-69REPT^SOC 21-71

Error codes and messages 22-1

Index 23-1


xi

ork ress

e 4.0

About this documentThis document provides details of the Transaction Language 1 (TL1) netwsurveillance and provisioning implementation on OC-3 Express and ExpCX network elements. Topics covered include the following:

• TL1 message common structure, syntax, and description

• description of each TL1 message parameter

Supported software releasesThis document supports the software releases for OC-3 Express Releasand 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

al

Technical support and informationFor technical support and information from Nortel (Northern Telecom), refer to the following tables.

United States Regional Service CentersIn the United States, direct requests for information to the nearest regionservice center.

For 24-hour emergency technical supportFor 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. ESTCall the following toll-free number:

800-275-8726 (800-ASK-TRAN)

Southern RegionNorthern Telecom Inc.5555 Windward Parkway West, Building BAlpharetta, Georgia 30201

(770) 661-4050

Northeast RegionNorthern Telecom Inc.200 Summit Lake DriveValhalla, New York 10595

(914) 773-2559

Central RegionNorthern Telecom Inc.475 Martingale RoadSchaumburg, Illinois 60173

1-800-466-7835

Western RegionNorthern Telecom Inc.5575 DTC Parkway, Suite 150Englewood, Colorado 80112

(303) 850-5600

Pacific Region (North)Northern Telecom Inc.2305 Camino RamonSan Ramon, California 94583

(510) 867-2091 or 1-800-456-0854

Southwest RegionNorthern Telecom Inc.2221 Lakeside Blvd., FL 9Richardson, Texas 75082-4399

(972) 684-1000

Pacific Region (South)Northern Telecom Inc.300 North Lake AvenuePasadena, California 91101

(818) 584-2000

Eastern RegionNorthern Telecom Inc.2010 Corporate RidgeMcLean, Virginia 22102

1-800-275-8726


About this document xiii

ance
Canada Technical Assistance Service Centers
In Canada, direct requests for information to the nearest technical assistservice center.

For 24-hour emergency technical supportFor 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 recoveryFor 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 PlaceRichmond, British Columbia V6V 2A2

(604) 244-4179

FSE West (Alberta)Northern Telecom Canada Limited10235-101st StreetEdmonton, Alberta T5J 3G1

(403) 441-3193

FSE West (Manitoba, Northwestern Ontario)Northern Telecom Canada Limited360 Main St., Suite 1400Winnipeg, Manitoba R3C 3Z3

(204) 934-7530

FSE West (Saskatchewan)Northern Telecom Canada LimitedPO Box 770Regina, Saskatchewan S4P 3A8(1867 Hamilton Street, 8th Floor)

(306) 791-7108

OntarioNorthern Telecom Canada LimitedPO Box 3000Brampton, Ontario L6V 2M6

(905) 863-4181 or 1-800-684-3578

QuebecNorthern Telecom Canada Limited9300 TransCanada HighwaySt. Laurent, Quebec H4S 1K5

(514) 956-3500

FSE East (Newfoundland)Northern Telecom Canada Limited63 Thorburn Rd.St. John’s, Newfoundland A1B 3M2

(709) 722-2500

FSE East (New Brunswick)Northern Telecom Canada Limited1 Brunswick Square, 4th FloorSaint John, New Brunswick E2L 4K2

(506) 632-8271 or (506) 632-8203

FSE East (Nova Scotia, Prince Edward Island)Northern Telecom Canada Limited1701 Hollis St., Suite 900Halifax, Nova Scotia B3J 3M8

(902) 421-2306


xiv About this document


1-1

1)

twork e rate,

to

s

s -

Introducing OC-3 TL1 1-This chapter provides an introduction to the Transaction Language 1 (TLused on the network element and the network processor (NP).

TL1 is a common language protocol for messages exchanged between neelements and NPs in an OC-3 Express or Express CX network. TL1 is thprimary user interface to the network element and NP, and is used to opeadminister, maintain, and provision the network.

The TL1 implementation on the network element and NP allows the userperform 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 Messageand Memory Administration Messages, Specifications of Memory Administration at the OS/NE Interface

• Section 12.5, TR-NWT-835, Issue 2: Operations Application MessageNetwork Element (NE) Security Parameter Administration Messages


1-2 Introducing OC-3 TL1

ing a ess ess

,

ork

nts lso p to

NP 100 You

P

the

TL1 user interface on the network elementThe TL1 interface is a text-based, single command line user interface.

On the OC-3 Express shelf, the TL1 user interface is obtained by connectVT100 or other ANSI, standard terminal to a DB-9, RS-232, DTE, craft accport on the left input/output (LIO), or to the DB-25, RS-232, DCE, craft accport 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-232DTE, 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 netwelement in the system.

TL1 user interface on the network processorThe TL1 interface on the NP allows the retrieval of all TL1 alarms and evefrom the network elements in the NP span of control. The TL1 interface aallows provisioning of NP facilities, X.25 parameters, an IP address and uthree manual area addresses.

The NP requires one of the following connections:

• backplane connection from the co-located shelf processor (SP) to thethrough OSI/Ethernet (10base T). You can access the NP using a VTcompatible terminal connected to any network element in the system.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 Nthrough TCP/IP over Ethernet (10base T)

• an operations support system (OSS) to NP through the X.25 port on right input/output (RIO)


Introducing OC-3 TL1 1-3

r. e.

ch cters.

ed

s are A-Z, d for

ontrol

L1

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 characterson-screen even if they are entered in lowercase.

Note: TL1 uses a semi-colon (;), not a carriage return, as a line terminatoThe semi-colon is shown at the end of all TL1 commands in this guid

User identifier The user identifier (UID) is a unique non-confidential name to identify eaauthorized system user. UIDs are between 1 and 10 alphanumeric charaIt 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 authorizsystem 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 identifierbetween 5 and 10 characters. PIDs are a combination of alphanumeric (0-9) and special characters. The following special characters are supportethe 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 ccharacters, and question mark (?).

Note: Carriage returns (the <Enter> key) are always ignored by the Tinterface.



ount. gh 5 code

ress evel

an

me.

everal

nd

ands

r a

x.

ou mote signed ase be any

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 accDuring account creation a security access level is assigned from 1 throuon the network element or the NP. This number is called the user privilege (UPC). The UPC security levels offer access to a range of task executioncapabilities as follows:

• Surveillance - level 5, allows surveillance of all OC-3 Express and ExpCX network elements in the NP span of control. A user account with a l5 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 OC-3 Express or Express CX network element.

Note 2: On the NP, only one level 5 user account can be active at a ti

• Administration - level 4, allows complete access to all commands andprocesses; level 4 can be assigned to more than one account so that susers have full privilege access to a network element

• Provisioning - level 3, allows access to provisioning, testing, editing, adeleting commands

• Control - level 2, permits access to operate, release, and retrieve commbut 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 fomonitoring 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 syntaThe TID is a non-confidential code to identify the network element or NPbeing 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. Ymust enter a TID to send the command to a remote network element or reNP. TIDs must be between 1 and 20 alphanumeric characters and are asusing the SET-SID command. The first character must be a letter (lowercletters are changed to uppercase letters). The remaining characters can combination of letters (changed to uppercase), numbers, or dashes (-).



ase clude

ands

Enclose the TID in double quotes (“) to include any combination of lower cor special characters. The string, enclosed by the double quotes, cannot inthe 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 commto 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 sessionsYou 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.



he .

ith a ted.

,

AG) the

rmat he

TL1 message notationThe following notation is used to define the syntax of the TL1 messages.

Access identifier An access identifier (AID) appears in most command argument strings. TAID identifies the equipment or facilities to be accessed by the command

Correlation tag The TL1 interface requires a sequential command identifier to be used wevery command input. The identifier is called a correlation tag (CTAG). IfCTAG is not entered as part of the command, the command will be rejec

The CTAG is returned with all response messages including confirmationfailed 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 (ATinstead of a CTAG. The ATAG is a unique numeric string generated bysystem.

The CTAG correlates the command to the result of the command. The foof the CTAG is alphanumeric and can be up to six characters in length. TCTAG can be used creatively to reflect its purpose, for example, JOB28, TAG33.

Symbol Meaning

<cr> ASCII carriage return

<lf> ASCII line feed

^ ASCII space

<ctrl> ASCII control key

+ Symbol used in response block syntax

; Semicolon command or message terminator, used instead of Return to execute commands



erb,

s (

be rmat

rs and &) as

rs IP es and

every

Command structure TL1 commands use a rigid structure. A command always begins with a vfollowed by a hyphen and a modifier. A second hyphen and a secondarymodifier 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 colon:) 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 canused to save time and typing of repetitive command lines. The general foof command grouping is as follows:

VERB-MODIFIER:tid:aid:ctag::parameter&parameter,value&value:;

Mandatory punctuationTL1 commands use colons and commas as command element separatoa semicolon to terminate the command line. TL1 also uses ampersands (group item separators where command grouping is supported.

All punctuation shown in the command descriptions must be used or thecommand will fail to execute.

TL1 command acknowledgment Whenever a TL1 command is entered, the system responds with the lettefor in progress and the CTAG entered. Until the command either completsuccessfully or fails, the TL1 prompt does not return. Since no other commcan be executed until the prompt returns, the same CTAG can be used in subsequent command.



resent . TL1

. Each

of

eshold o 10 ed to

he d. The sage.

as

n

TL1 message overview This section describes the TL1 message types, the common elements pin all TL1 messages, and the responses to TL1 non-autonomous requestsautonomous messages are also referred to as automatic output (see theRTRV-AO command).

TL1 message types There are two types of TL1 messages: autonomous and non-autonomousconsists of a header and a message block.

Autonomous messages are generated by a network element as a result 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 thrcrossing alerts are broadcast to all user sessions active on the SID. Up tuser sessions can be active at one time. No information request is requirreceive autonomous messages.

Non-autonomous messages are the network element response to a TL1command.

TL1 command response header A response is identified by a two-line header that indicates the origin of tmessage, time and date, and whether the command successfully executesecond line always begins with the letter M to indicate it is a response mes

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 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 tha32 lines is divided into multiple responses.



rted d.

rated

se

the mous

ty

rm

uled of f

Error responses If a TL1 command is unsuccessful, a DENY response with a TL1 error isreturned. The response includes an error code. The error codes are repoalong with a description of the situation under which the problem occurreThe 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 geneby events or faults in facilities or equipment, environmental faults, or performance monitored threshold crossings.

Autonomous reports display a header similar to that of command responheaders. The second line begins with either the letter A indicating that it reports an autonomous event, or an alarm code indicating the severity ofalarm. The second element of the second line is always a numeric autonotag 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 facili(EC-1, OC-3, T1, T3, STS-1, STS-3c, or VT1.5), common (COM), environmental (ENV), equipment (EQPT) or shelf (FAC, CONFIG, EX) alaor event has been generated.

The response block (rspblk) is the response to either a command, schedreport, or fault. It contains several elements to identify the specific naturethe problem. The names and significance of each is specific to the type oreport.



s:

1 and

d. he le

age

Editing features The OC-3 Express and Express CX support the following editing feature

• <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 helpThe OC-3 Express and Express CX have a built-in help system in the TLinterface. When typing TL1 commands you can enter an incomplete commterminated with a question mark (?) at the point where syntax help is needeThe interface responds with syntax choices for that command element. Trule applies throughout the command, from first letter onward. For exampentering A?; displays a list of all commands beginning with A.

When you log in to an OC-3 Express network element, the following messappears 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*/



se is
The help function can be called at any point in the syntax and the responalways 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*/



any

tent

The following example illustrates that a question mark can be entered in 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 convalues for all fields in every command and gives examples. The interfacespecifies 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*/



r be

ll

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 paramete(PID) being treated by online help. Any comma delimited parameter can 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 acommands of a certain type. For example, entering

< INIT-R?

returns the following:

/** Applicable Command(s):** INIT-REG-ALL* INIT-REG-OC3* INIT-REG-T1*/


2-1

ntify s,

ork ssor

Security and administration detailed command descriptions 2-

This chapter is an alphabetical summary of the TL1 commands related tosecurity and administration. The command descriptions in this chapter ideeach command, and describe the command purpose, syntax, parametervariables, and response.

Most commands in this chapter are supported on the OC-3 Express netwelement, the OC-3 Express CX network element, and the network proce(NP).

The following table lists all the commands in this chapter.

Command Page

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

RST-PROV 2-20

RTRV-ACTIVE-USER 2-23

—continued—


2-2 Security and administration detailed command descriptions

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

Command Page


Security and administration detailed command descriptions 2-3

he

ly 10 e but

one

rk ents

s or h a

ACT-USER The Activate User command is used to log in to the network element or tnetwork 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 onTL1 user sessions using these accounts can be active at one time on onnetwork element. Up to 100 accounts can be created for the NP as well,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 attime. To maintain multiple logins all network elements must be interconnected. Once you have activated sessions to a number of netwoelements, most TL1 commands can be addressed to all the network elemsimultaneously.

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 NPnetwork elements, if the nodes are interconnected. Only one account witlevel 5 UPC can be active at a time on the network element or the NP.

Security level Level 1

Input syntaxACT-USER:[TID]:UID:CTAG::PID;

Example input 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.

Table 2-1Syntax definition

Field Purpose

TID Target identifier

UID User identifier

CTAG Correlation tag

PID User password identifier



or

r

CANC-PROVThe 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 orRST-PROV, or CMMT-PROV

• disconnects any file transfer connections left behind by the SAV-PROVRST-PROV

• clears any in progress alarms raised by the SAV-PROV, RST-PROV, oCMMT-PROV

• cancels the failure state that may exist

Security levelLevel 3

Input syntaxCANC-PROV:[TID]::CTAG;

Example input Cancel a SAV-PROV command executed on shelf processor OTTAWA:

CANC-PROV:OTTAWA::CTAG99;


Field Purpose





e

s er the the

CANC-USERThe Cancel User command is used to log out of an active session with thnetwork element or network processor.

Regardless of privilege, no account can be logged out by a CANC-USERcommand 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 remainlogged in to an account on the local network element and another uswants to log the user out but does not know the UID of the first user, only way to log out the account is to disconnect the RS-232 cable fromcraft access port, or turn off the power to the VT100 terminal.


Input syntaxCANC-USER:[TID]:UID:CTAG;

Note: ALL is a valid target identifier (TID).

Example inputLog out SYSOP from the network element WASHINGTON: CANC-USER:WASHINGTON:SYSOP:TN777;


Field Purpose


UID User identifier




s on ning

r if

d the

ted eck

fore

he

CHK-PROVThe Check Provisioning (CHK-PROV) command is used to do pre-checkthe shelf processor (SP) or network processor (NP) for which the provisiodata is to be saved or restored. These checks include whether

• the given destination is reachable (if the DESTTYPE and DESTADDRoptions are included). If the file transfer connection cannot be made othe destination is involved in a duplicate SID, the check fails.

• the given userid and password are valid (if the USERID and PASSWDoptions are included). If either the user name or password are not valicheck 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 failedIf the system is in a preventative state the check fails.

• any alarms are raised on the SP or NP (if the CHKALM option is omitor given the value Y). If any alarms are raised on the SP or NP the chfails.

The CHK-PROV command, although optional, should always be sent besending 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 texception of CANC-PROV.


Input syntaxCHK-PROV:[TID]::CTAG::[USERID,PASSWD]:[DESTTYPE=Domain[,DESTADDR=Domain]][,CHKALM=Domain];




Field Purpose



USERID User login name(If the CHK-PROV is from anSP to an NP, omit USERID.)

PASSWD User login password(If the CHK-PROV is from anSP to an NP, omit PASSWD.)

DESTTYPE 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 des-tination of the Save or source of the Restore.

For a DESTTYPE of PC, omit DESTADDR.

CHKALM Check alarm status

Table 2-5Keyword descriptions

Keyword Domain Description

USERID User ID A unique, non-confidential identifier of 1 to 12 alphanumeric characters (including double quotes) used to identify each authorized system user

PASSWD Password A confidential code name of 1 to 32 alphanumeric characters (including double quotes) used to activate a user login session

DESTTYPE TID Target Identifier

IP Internet Protocol

PC Locally attached PCGUI

—continued—



to

to

Example inputCheck network processor MONTREAL prior to saving its provisioning dataa 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 dataan OPC. Use a quoted string for USERID and PASSWD:CHK-PROV:MONTREAL::CTAG98::”quasimoto”,”his,:’password”:DESTTYPE=TID,DESTADDR=OPCOTTAWA,CHKALM=Y;

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

CHKALM Y (default) A CHK-PROV is not allowed if there is an alarm present on the NP or SP card receiving the command

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





e nd.

l

WA:

CMMT-PROVThe Commit Provisioning (CMMT-PROV) command is used to commit thfiles which have been restored to an SP or NP by the RST-PROV comma

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 wilcommit the data and cause a special reset. It will also clear the DatabaseRestore in Progress alarm.


Input syntaxCMMT-PROV:[TID]::CTAG;

Example inputCommit provisioning data that has been restored to shelf processor OTTACMMT-PROV:OTTAWA::CTAG93;


Field Purpose





ssor

e

DLT-PROVThe Delete Provisioning (DLT-PROV) command is sent to a network proce(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 messagstating that the backup has been deleted is displayed.


Input syntaxDLT-PROV:[TID]::CTAG::[DLTALL]:[DLTBKUP=Domain];


Field Purpose



DLTALL Deletes all SP backups on an NP

DLTBKUP Specifies the TID of an SP whose backup is to be deleted from an NP



DLTALL DLT_ALL_BACKUPS Delete all SP backups on the NP

DLTBKUP TID of SP Name of the SP whose backup is to be de-leted from the NP


Example inputDelete the provisioning data on network processor MONTREAL that wasbacked-up from shelf processor OTTAWA:DLT-PROV:MONTREAL::CTAG:::DLTBKUP=OTTAWA;
The response displayed is as follows:MONTREAL 98-07-30 04:03:35M A COMPLD

Deleting SP Backups from NP

Backup for OTTAWA deleted

Response block syntaxThe 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-9Response block description

Keyword Description

SID Source identifier of the NP storing the SP data

DATE, TIME Date and time of SP deletion

TID Target identifier of each SP deleted



the

at

DLT-SECU-USERThe Delete Security User command is used to delete a user account on 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 least one UID with ADMIN privilege always exists. If a user attempts todelete their UID, the error response *Privilege, Illegal User Code* is displayed.


Input syntaxDLT-SECU-USER:[TID]:UID:CTAG;


Example inputDelete the user account USER03 from network element NEWYORK: DLT-SECU-USER:NEWYORK:USER03:CTAG12;


Field Purpose


UID User identifier




ssor

ning, t be

.:

ED-DATThe Edit Date command instructs the network element or network proceto 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 commissioand on the NP when the NP is initially provisioned. The date and time musreset after a system restart.


Input syntaxED-DAT:[TID]::CTAG::[date],[time];


Example inputSet the date and time on the network element to April 15, 1995, 9:30 a.mED-DAT:NEWYORK::CTAG12::95-04-15,09-30-00;


Field Purpose



DATE Current date. A null value for DATE leaves the date unchanged.

TIME Current time. A null value for TIME leaves the time unchanged.

Table 2-12Parameter descriptions

Parameter Format Description

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

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



their or.

clude

ontrol

ter.

(\). ord.

UI

.

ED-SECU-PIDThe Edit Security Password Identifier command is used by users to edit own account’s password on the network element or the network processThis command cannot be used to edit the password of another user.

Password identifiers (PIDs) are between 5 and 10 characters. PIDs can inalphabetical characters, numbers, and the following symbols:

! “ # $ % ` ( ) * + - . / < = > @ [ ] ^ _ ' { | }

Unsupported characters include:


Note 1: The password must contain at least one alphanumeric charac

Note 2: The double quote (“) must always be preceded by a backslashThe backslash is considered as a character in the length of the passw

Note 3: Carriage returns (<Enter>) are always ignored by the TL1 interface.


Input syntaxED-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 screen.

Note 3: In OC-3 Express, passwords must be entered twice for confirmation. In OC-3 Express CX, passwords are only entered once


Field Purpose


UID User identifier


OldPID Old user password identifier

NewPID New user password identifier



t

ent

Example inputChange the password for user FORD on OC-3 Express network elemenNEWYORK 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 elemNEWYORK from PREFECT to PENGUINE: ED-SECU-PID:NEWYORK:FORD:CTAG12::PREFECT,PENGUINE;



ining

eter

ate ed.

vel ys t be

UI

ED-SECU-USERThe Edit Security User command is used to edit the security parametersassociated with a user account on the network element or the network processor. Enter only the data parameters you want to change. The remaattributes are not altered.

The user identifier (UID) can be 1 to 10 alphanumeric characters. Paramgrouping of UIDs is not possible.

A maximum of 100 UIDs can be added to the password file. If you try to creUID 101, the error message /*Status, List Exceeds Maximum*/ is display

Users with ADMIN privilege (level 4) cannot change their own UPC to a lebelow 4. This is to ensure that at least one UID with ADMIN privilege alwaexists. The last account in the network element with level 4 privilege cannodeleted.


Input syntaxED-SECU-USER:[TID]:UID:CTAG::[NEWUID],[NEWPID],[NEWPID],[UPC]:[TMOUTA=Domain][,TMOUT=Domain];



Note 3: Passwords must be entered twice for confirmation

Note 4: OC-3 Express CX does not support the [TMOUT=Domain] parameter.


Field Purpose


UID User identifier


NewUID New user identifier

NewPID New user password identifier

—continued—



3,

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 and a timeout interval of 60 minutes:ED-SECU-USER:NEWYORK:ADMIN:CTAG12::ADMIN2,NTADMIN,NTADMIN,3:TMOUTA=Y,TMOUT=60;

UPC User privilege code

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

TMOUT Timeout interval in minutes. A decimal number from 1 to 99. The default is 30 minutes.



TMOUTA Y

N

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

Table 2-14 (continued)Syntax definition

Field Purpose



on a

is

ation

ontrol

ter.

(\). ord.

ate ed.

UI

ENT-SECU-USERThe Enter Security User command is used to create a new user accountnetwork element or network processor and enter the security parametersassociated with the account. The network element or network processorspecified 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 combinof alphanumeric (A-Z, 0-9) and special characters. The following special characters are supported for the password:

! “ # $ % ` ( ) * + - . / < = > @ [ ] ^ _ ' { | } .

Unsupported characters include:


Note 1: The password must contain at least one alphanumeric charac

Note 2: The double quote (“) must always be preceded by a backslashThe backslash is considered as a character in the length of the passw

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 creUID 101, the error message /*Status, List Exceeds Maximum*/ is display


Input syntaxENT-SECU-USER:[TID]:UID:CTAG::PID,PID,UPC:TMOUTA=Domain[,TMOUT=Domain];



Note 3: Passwords must be entered twice for confirmation.

Note 4: OC-3 Express CX does not support the [TMOUT=Domain] parameter.



ser

name

Example inputCreate an account on OC-3 Express CX network element Seattle, with uname 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 CAM, password VWXYZ, security privilege level 3, and timeout set to 60minutes: ENT-SECU-USER:SEATTLE:CAM:CTAG12::VWXYZ,VWXYZ,3:TMOUTA=Y,TMOUT=60;


Field Purpose


UID User identifier


PID Password identifier

UPC User privilege code

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

TMOUT Timeout interval in minutes. A decimal number from 1 to 99. The default is 30 minutes.



TMOUTA Y

N

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



elf be

to

P

ent t the

ID.

RST-PROVThe Restore Provisioning (RST-PROV) command is used to restore

• provisioning data (including that backed-up from circuit packs) to a shprocessor (SP) from a locally attached PCGUI. This function can onlyexecuted by a user through a PCGUI.

Note: A locally attached PCGUI is connected directly by RS-232 cablean SP or PCGUI can be connected to an SP by modem.

• provisioning data (including that backed-up from circuit packs) to a Sfrom a network processor (NP)

• provisioning data (including that backed-up from SPs) to a NP from aUNIX 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 currsoftware release running on the network element (NE). If they are nosame, the restoration fails.

• if CHKTID=Y or CHKTID is omitted, compares the TID of the networkelement to which provisioning data is being restored with the stored TIf they are not the same, the restoration fails.


Input syntaxRST-PROV:[TID]::CTAG::[USERID,PASSWD]:DESTTYPE=Domain[,DESTADDR=Domain][,DIR=Domain][,CHKTID=Domain][,CHKALM=Domain];


Field Purpose



USERID User login name(If the RST-PROV is from an NP to an SP, omit USERID.)

PASSWD User login password(If the RST-PROV is from an NP to an SP, omit PASSWORD.)

—continued—



DESTTYPE Source of the Restore — TID, IP, or locally attached PCGUI

DESTADDR Address of the DESTTYPE (TID or IP) which is the source of the Restore

For a DESTTYPE of PC, omit DESTADDR

DIR Directory in which the backed-up provisioning data is stored.

CHKTID 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 Check alarm status



USERID User ID A unique, non-confidential identifier of 1 to 12 alphanumeric characters (including double quotes) used to identify each authorized system user.

PASSWD Password A confidential code name of 1 to 32 alphanumeric characters (including double quotes) used to activate a user login session.

DESTTYPE TID 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.

IP A remote Restore will be enacted using FTP to transfer files from the IP address given in theDESTADDR parameter to the NP.

PC A local restore will be executed between an SP and a locally attached PCGUI.

DESTADDR TID address Name of the Restore source (a network element or NP) consisting of an identifier of 7 to 20 alphanu-meric characters. The first character is alphabetic.

IP address The address of the Restore source (a networkelement or NP) consisting of an identifier in theformat x.x.x.x (where x=a number 0-255).

—continued—


Field Purpose



s
Example inputRestore provisioning data stored on network processor MONTREAL to itoriginal shelf processor in OTTAWA.
RST-PROV:OTTAWA::CTAG96:::DESTTYPE=TID,DESTADDR=MONTREAL,DIR=”/saverest/NE01”,CHKTID=N;

DIR Directory name

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 exter-nal 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 di-rectory name.) The directory name is a string of 1 to 60 characters.

CHKTID Y (default) Do not skip TID check

N Skip TID check (Note 1)

CHKALM Y (default) The RST-PROV is not allowed if there is an alarm present on the NP or SP card.

N The RST-PROV is allowed if there is an alarm present on the NP or SP card receiving thecommand 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.





K:

RTRV-ACTIVE-USERThe Retrieve Active User command is used to list all users logged in to anetwork element or network processor.


Input syntaxRTRV-ACTIVE-USER:[TID]::CTAG;


Example inputRetrieve a list of all active users logged in to network element NEWYORRTRV-ACTIVE-USER:NEWYORK::CTAG23;

Response block syntaxAID:,UPC::SID


Field Purpose





ork tion ate,

mote that

sed

ou e:

in to

RTRV-HDRThe Retrieve Header command requests that a network element or netwprocessor reply with a normal response indicating COMPLD. The informaof interest in the reply is the reply itself, namely the source identifier, the dand the time.

This command can be used to determine how many login sessions to renetwork elements or network processors are currently active, or to confirma network element or network processor is responding.

As part of a surveillance protocol the RTRV-HDR command can also be uto keep login sessions active by preventing timeout from occurring.


Input syntaxRTRV-HDR:[TID]::CTAG;


Example inputRetrieve the header message from network element SEATTLE to verify yare still logged in to the network element and that the session is still activRTRV-HDR:SEATTLE::CTAG12;

Retrieve all headers to determine which network elements you are loggedand that have an active session: RTRV-HDR:ALL::CTAG12;


Field Purpose





used n NP e will

RTRV-HELPThe Retrieve HELP command is used to retrieve TL1 command help fromeither a local or a remote network element. The RTRV-HELP command is to retrieve help on SP specific commands when the user is on an NP or ospecific commands when the user is on an SP. If there are no applicablecommands matching the command that help is requested for, the responsindicate this.


Input syntaxRTRV-HELP:[TID]::1::[partial_cmd];

Table 2-22

Syntax definition

Example inputRetrieve 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;

Field Purpose

TID Target identifier, the network element or network processor to which the command is directed

CTAG Correlation tag, an alphanumeric identifier to correlate the command and response messages

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



ups s up.

r

RTRV-PROV-LSTThe Retrieve Provisioning List (RTRV-PROV-LST) command is sent to a network processor (NP) to retrieve a list of the shelf processor (SP) backstored on the NP. The display will include a list of the SP target identifier(TID), their associated directory names and the timestamp for each back


Input syntaxRTRV-PROV-LST:[TID]::CTAG;

Example inputRetrieve a list of the shelf processor backups saved on network processoMONTREAL.

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:25M A COMPLD SP Provisioning Database BackupsOTTAWA /saverest/NE011998-07-16 10:31:20NEWYORK /saverest/NE021998-06-18 09:33:17WATERLOO /saverest/NE031998-06-03 14:55:21

Response block syntax<SID><DATE><TIME>SP Provisioning Database Backups<TID><DIR><TIMESTAMP>


Field Purpose

TID Target identifier of the NP





Keyword Description

SID Source identifier of the NP storing the SP data

DATE,TIME Date and time of list retrieval

TID Target identifier of each SP backed-up on the NP

DIR Directory name of each SP backed-up on the NP

TIMESTAMP Date and time of backup



ge er

RTRV-SECU-UPCThe Retrieve Security command is used to retrieve your own user privilecode (UPC). You must have level 4 privilege to retrieve the UPC of anothuser.

Security levelLevel 1 (to retrieve your own user privilege code)Level 4 (to retrieve another user’s user privilege code)

Input syntaxRTRV-SECU-UPC:[TID]:UID:CTAG;


Example inputRetrieve security level for account ADMIN: RTRV-SECU-UPC:WASHINGTON:ADMIN:COOL99;

Response block syntaxUID:,UPC


Field Purpose


UID User identifier




twork

el 4

vel ys t be

ntrol

RTRV-SECU-USERThe Retrieve Security User command is used to retrieve the security parameters associated with a user account on the network element or neprocessor.

Note: For security purposes the UPC to execute this command is Levsince it provides a list of all accounts and access levels.

Users with ADMIN privilege (level 4) cannot change their own UPC to a lebelow 4. This is to ensure that at least one UID with ADMIN privilege alwaexists. The last account in the network element with level 4 privilege cannodeleted.


Input syntaxRTRV-SECU-USER:[TID]:UID:CTAG;


Example inputRetrieve 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 cowhere you are logged in:RTRV-SECU-USER:ALL:ALL:CTAG12;


Field Purpose


UID User identifier




Response block syntaxUID:,UPC:ACTIVE=DOMAIN,TMOUTA=DOMAINUID:,UPC:ACTIVE=DOMAIN,TMOUTA=DOMAIN


Parameter Possible values

Description

ACTIVE Y

N

User is logged in

User is not logged in

TMOUTA Y

N

Timeout enabled

Timeout disabled



tion

32

SP

PC

I

SAV-PROVThe Save Provisioning (SAV-PROV) command is used to save:

• provisioning data (including that backed-up from circuit packs) from ashelf processor (SP) to a disk on a locally attached PCGUI. This funccan only be executed by a user through a PCGUI.

Note: A locally attached PCGUI is connected directly to an SP by RS-2cable or by a modem.

• provisioning data (including that backed-up from circuit packs) from anto a network processor (NP)

• provisioning data (including that backed-up from SPs) from a NP to aor UNIX workstation or an Operatons Controller (OPC)

Prior to executing a SAV-PROV, it is recommended that a CHK-PROV command be executed.


Input syntaxSAV-PROV:[TID]::CTAG::[USERID,PASSWD]:DESTTYPE=Domain [,DESTADDR=Domain][,DIR=Domain][,CHKALM=Domain];

Note: Passwords entered in TL1 commands are not echoed to the Uscreen.


Field Purpose



USERID 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—



DESTADDR 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 Directory used to store provisioning data backup.

CHKALM Check alarm status.



USERID User ID 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.

PASSWD Password A confidential code name of 1 to 32 alphanumeric characters (including double quotes) used to acti-vate a user login session. Not used in a SAV-PROV sent to an SP.

DESTTYPE TID A remote Save will be enacted using ALFTAM or FTAM protocol to transfer files to the TID given in the DESTADDR parameter.

IP A remote Save will be enacted using FTP to transfer files to the IP address given in the DESTADDR parameter.

PC A local Save will be executed between an SP and a locally attached PCGUI.

DESTADDR TID address 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

IP address 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—


Field Purpose


Example inputSave the provisioning data on the network processor MONTREAL to theOperations Controller of network element TORONTO.SAV-PROV:MONTREAL::CTAG97:::DESTTYPE=TID:DESTADDR=TORONTO,CHKALM=Y;
DIR Directory name

A string of characters that specifies the uniquedirectory 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.

N The SAV-PROV is allowed if there is an alarm present on the NP or SP card receiving thecommand 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.





ork . nse

tely d.

tes efore

ou mote signed ase be any

ase clude

et ed ork

efault

SID e . ed as

lay

ate

SET-SID The Set System Identifier command instructs the network element or netwprocessor to change its system identification (SID) code to a given valueChanging the SID can result in a mismatch of the SID value in the respoheaders 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 remoconnected to the network element when the SET-SID command is issue

Note: A response of /*Status, Requested Command Inhibited*/ indicathat other users are logged into the NE. The other users must log off byou can execute the SET-SID command.

If a TID is not entered in the TL1 command, the local TID is substituted. Ymust enter a TID to send the command to a remote network element or reNP. TIDs must be between 1 and 20 alphanumeric characters and are asusing the SET-SID command. The first character must be a letter (lowercletters are changed to uppercase letters). The remaining characters can combination of letters (changed to uppercase), numbers, or dashes (-).

Enclose the TID in double quotes (“) to include any combination of lower cor special characters. The string, enclosed by the double quotes, cannot inthe following characters: backslash (\), space, and double quotes (“).

Note 1: All OC-3 Express and Express CX network elements are preswith a default SID of NORTELOC3. If the network element is connectto another OC-3 Express or Express CX network element, the two netwelements must have different names. Therefore as a general rule the dname should always be changed as part of the provisioning process.

Note 2: The OC-3 Express network processor is preset with a default of NORTELOC3NP. If there is more than one network processor in thnetwork, then the two network processors must have different namesTherefore as a general rule the default name should always be changpart of the provisioning process.

If the SID is changed, the new name is not recognized by the TBOS dispmapper. 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 DuplicSID alarm is masked for 20 minutes.



e

to the

at the

:

When the SET-SID command is complete, the local session continues unchecked. However, the remote association is dropped and the messag/*Status, Remote Session Dropped*/ is displayed at the remote network element. To re-establish the association, issue the ACT-USER command 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 local network element.


Input syntaxSET-SID:[TID]::CTAG::SID;

Example inputChange the name of a network element called NEWYORK to BOSTON2SET-SID:NEWYORK::MA999::BOSTON2;


Field Purpose


CTAG Correlation tags

SID Set source identifier, the new SID allocated to the NE specified by the TID.



ck d itted

n a

ting NPs.

store

VALD-PROV The purpose of the Validate Provisioning (VALD-PROV) command is to chewhether the restored data that currently resides in the temporary save anrestore directory on a network element, but which has not yet been commby the CMMT-PROV command, is valid. Data in a temporary Save and Restore directory may become invalid when there is a long delay betweeRST-PROV and a CMMT-PROV command.


Input syntaxVALD-PROV:[TID]::CTAG;

Example inputThe response blocks contain <STRING> which contains information relato a backup being restored. This information will differ between SPs and

An SP example. Validate the provisioning data currently in the save and redirectory of shelf processor OTTAWA:VALD-PROV:OTTAWA::CTAG94;


Field Purpose





ore

as in


OTTAWA 98-01-03 02:07:28M A COMPLD Information on Backup being Restored

Backup saved from: OTTAWAProv Data available for slot 07: OC3Prov Data available for slot 08: OC3Prov Data available for slot 11: OC3Prov Data available for slot 12: OC3Prov Data available for slot 13: VTXProv Data available for slot 14: VTXProv Data available for slot 15: SPProv Data available for slot 16: 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 restdirectory of network processor MONTREAL.VALD-PROV:MONTREAL::CTAG94;


MONTREAL 96-01-03 02:07:39M A COMPLD

Information on Backup being Restored

Backup saved from: MONTREALBackup included for: ALLADIN29 1998-05-12 13:05:23Backup included for: ALADDIN06 1998-06-22 07:55:03Backup included for: ALADDIN11 1998-06-09 22:22:11

Note: “Backup saved from: ” specifies the NP from which the data woriginally backed-up. If the data was restored to a different NP, the TIDthe VALD-PROV command will differ from the TID in “Backup saved from:”.

Response block syntax<SID><DATE><TIME>Restored Data Information<STRING>


3-1

onse.

System detailed command descriptions 3-

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)

The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, variables, and resp

Command Page

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-2 System detailed command descriptions

ent P is

ED-NETYPEUse the Edit Network Element Type command to update the network elemto support linear and UPSR add/drop multiplexer capabilities when the Sreplaced with an SPe on an OC-3 Express shelf. See RTRV-NETYPE (SP host) for more details.


Input syntaxED-NETYPE:TID::CTAG:::NETYPE=Domain;

Example inputAfter 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;


Field Purpose



NETYPE Type of network element supported


Parameter Possiblevalues

Description

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


System detailed command descriptions 3-3

ve type rk

only

the

-3

odel.

RTRV-NETYPE (SP host) When your current session is hosted by a shelf processor, use the RetrieNetwork Element Type command to retrieve the current network element setting for a network element. Use this command to determine the netwoelement functionality currently supported.

On an OC-3 Express network element, if the shelf processor is an SP, thesupported functionality is a linear terminal network element with DS1 andDS3 tributaries.

On an OC-3 Express network element, if the shelf processor is an SPe, 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 OCtributaries as well as a linear or UPSR ADM with the same tributaries.

This command also returns additional data such as the shelf vendor and m


Input syntaxRTRV-NETYPE:TID::CTAG;


Field Purpose





Example inputFor the NEWYORK network element, retrieve the network element type:RTRV-NETYPE:NEWYORK::CTAG99;

Table 3-4Output parameter descriptions

Parameter Possible values Description

Vendor NORTEL

Model TransportNode Express

TransportNode OC-3 Express CX

NETYPE LINEAR Only linear terminal functionality with DS1 and DS3 tributaries is supported (OC-3 Express only).

RING Linear terminal and ADM as well as UPSR ADM are supported.

Rel Release name



he odel

RTRV-NETYPE (NP host) When your current session is hosted by a network processor (NP), use tRetrieve Network Element Type command to retrieve the shelf vendor, mand the host processor type.


Input syntaxRTRV-NETYPE:TID::CTAG;

Example inputFor the NEWYORK network element, retrieve the network element type:RTRV-NETYPE:NEWYORK::CTAG99;


Field Purpose



Table 3-6Output parameter descriptions


Vendor NORTEL

Model S/DMS TransportNode OC-3 Express

NETYPE GCF Gateway communication function: indicates the session you are in is hosted by an NP



ader

pen

f the

ased ol

their ween of

o).

C-12 isted.

, ess

and

rk d. ys

RTRV-RTG-TBL The Retrieve Routing Table command returns a report with a standard heand a display array listing all the network entities on the network.

The report display lists the network element source identifier (SID), the osystems 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 oTARP option on the RTRV-RTG-TBL could take 15 minutes or more.

The routing table is automatically constructed at each network element bon the intermediate system to intermediate system (IS-IS) routing protocPDU exchange, from the OSI standard ISO-10589.

Links between network elements are assigned a COST value according totype. The COST column displays the COST sum of the shortest route betthe local network element and the network element identified in each rowthe 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 (zer

If the OC-3 Express or Express CX network element is connected to an Oor OC-48 backbone, the other network elements on the network are also l

OPC, OC-48 and OC-12 will also display a SID in the NE NAME columnthough the length of the SID can vary from that of OC-3 Express or ExprCX SIDs.

OC-3 Express SYSTEM-ID addresses range between 00-00-75-D0-00-0000-00-75-DF-FF-FF.

Note: If a different target identifier (TID) is used then the list of netwoelements will vary in order and different COST values will be displayeFor example the COST value for the first row (local TID used) will alwabe zero.




Input syntax RTRV-RTG-TBL:[TID]::CTAG;

Example input Retrieve routing table from a network element MIAMI: RTRV-RTG-TBL:MIAMI::A1A;

Response block syntax"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"


Field Purpose



TARP TID address resolution protocol



n
The example shows the response to the RTRV-RTG-TBL command wheexecuted from a network element, with a TID of MIAMI, on a network resembling the following illustration.
Table 3-8Response parameter descriptions

Parameter Response values Description

NE NAME 64 character alphanumeric string

Source identifier (SID) of the network element

SYSTEM-ID 6 octet, hexadecimal

Universally administered IEEE address (world-wide unique address)

COST numeric value of 0 or greater

The shortest path COST value in SDCC links with a weighted value of six for each link

MIAMI JUPITER

ORLANDO DAYTONA

OC-3

OC-3 OC-3

OC-3



n

Fault location The RTRV-RTG-TBL command can be used to locate network faults. Forexample, in the following illustration if the link between “B” and “C” is brokethen from “A”, the COST value of “C” will rise from 12 to 18.

OC-3

OC-3

OC-3 UPSR

A

B

OC-3

ED

OC-3

C

OC-3



e

:

RTRV-SW-VERUse the Retrieve Software Version command to retrieve the version of thsoftware on the shelf processor, for example “REL0300A”.


Input syntaxRTRV-SW-VER:TID::CTAG;

Example inputFor the SEATTLE network element, retrieve the current software versionRTRV-SW-VER:SEATTLE::CTAG99;


Field Purpose




4-1

ify s,

Synchronization detailed command descriptions 4-

This chapter is an alphabetical summary of the TL1 commands related tosystem synchronization. The command descriptions in this chapter identeach command, and describe the command purpose, syntax, parametervariables, and response.


Command Page

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-2 Synchronization detailed command descriptions

he st

ce

he

e

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 ttwo references is the same. The network element always chooses the bequality timing reference for its synchronization reference.

Use the RTRV-BITS-OUT command to retrieve the current timing referensettings. 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 tincoming synchronization signal.

User synchronization switches initiated using this command remain activuntil another BITS Out switch is activated or they are overridden by a synchronization reference failure.


Input syntaxOPR-BITSOUTSW:[TID]:AID:CTAG;


Table 4-2AID descriptions

Example inputSwitch BITSOUT-A from the currently active timing source to the other timing source:OPR-BITSOUTSW:NEWYORK:BITSOUT-A:CTAG23;

Field Purpose


AID Access identifier. BITS output to act on.


AID type Command-specific values Purpose

BITS output BITSOUT-bits BITSOUT-A or BITSOUT-B


Synchronization detailed command descriptions 4-3

ent ary, s is

he

e y a

r

OPR-SYNCSW The Operate Synchronization Switch command instructs the network elemto switch synchronization timing reference signals from primary to secondor vice versa. The switch completes only if the quality of the two referencethe 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 tincoming synchronization signal.

User synchronization switches initiated using this command remain activuntil another synchronization switch is activated or they are overridden bsynchronization reference failure.

Primary and secondary timing references are assigned using the SET-TMREFIN command.


Input syntaxOPR-SYNCSW:[TID]::CTAG;


Example inputSwitch synchronization from the currently active timing source to the othetiming source: OPR-SYNCSW:NEWYORK::CTAG23;

Field Purpose





gnal B.

RTRV-BITS-INThe Retrieve BITS Input command is used to retrieve the setting of the siformat and linecode parameters for the BITS input BITSIN-A and BITSIN-


Input syntaxRTRV-BITS-IN:[TID]:AID:CTAG;




Example inputRetrieve the signal format and linecode settings for BITSIN-A: RTRV-BITS-IN:NEWYORK:BITSIN-A:CTAG43;

Response block syntaxFMT=valueLINECDE=value

Field Purpose


AID Access identifier. BITS input to act on.



BITS input BITSIN-bits BITSIN-A or BITSIN-B



FMT SF (default)

ESF

Superframe format

Extended superframe format

LINECDE AMI (default)

B8ZS

Alternate mark inversion, both directions

Bipolar with 8-zero substitution, both directions


RTRV-BITS-OUT
The Retrieve BITS Output command is used to retrieve the setting of theprimary 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.


Input syntaxRTRV-BITS-OUT:[TID]:AID:CTAG;




Example inputRetrieve the parameter settings for BITSOUT-A: RTRV-BITS-OUT:NEWYORK:BITSOUT-A:CTAG43;

Field Purpose








Response block syntaxKeyword=Domain



PRI or SEC(see Note) OC3-slot#

EC1-slot#DS1-slot#-port#BITSIN-bitNONE

Primary or secondary timing reference:OC-3, slot 3 to 12EC-1, slot 3, 5, 7 or 9DS1, slot 4 to 10, port 1 to 12BITSIN-A or BITSIN-BDeprovision timing reference

FMTSF (default)ESF

Frame format:Superframe formatExtended superframe format

EQLZ1 (default)23

Equalization:Short (0-266 ft.)Medium (266-533 ft.)Long (533-655 ft.)




he

RTRV-SYNCSTIN The Retrieve Synchronization Status Input command is used to find out tsynchronization status provisioned by the user using the SET-SYNCSTINcommand.


Input syntaxRTRV-SYNCSTIN:[TID]::CTAG;



Example inputRetrieve the current synchronization status at network element Seattle:RTRV-SYNCSTIN:SEATTLE::CTAG23;

Response block syntax^^^”<sync message status> ”

Field Purpose



Table 4-11Synchronization message status values


SYNC_STATUS ST1STUST2ST3SMCST4RESDUSNONE

Stratum 1 traceable Normal-Traceability UnknownStratum 2 traceable Stratum 3 traceable Traceable SONET minimum clockStratum 4 traceableReserved for Network Synchronization UseDo not use for synchronizationNone



nt, r

alue

RTRV-TMG-MODE The Retrieve System Timing Mode command is used to query the systemtiming mode for a network element. On an OC-3 Express network elemethere are three possible modes: free-running internal (INT), line (LINE), oexternal (EXT). On an OC-3 Express CX network element, there are twopossible modes: free-running internal (INT) and line (LINE).

Note: This command will never generate an error response; a default vfor the system always exists.


Input syntaxRTRV-TMG-MODE:[TID]::CTAG;



Example inputRetrieve the timing mode for network element Seattle: RTRV-TMG-MODE:SEATTLE::12345;

Response block syntax MODE = <mode>


Field Purpose




Mode EXT

INT

LINE

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



sible d

alue

RTRV-TMREFIN The Retrieve Timing References Input command is used to retrieve the primary and secondary input timing references used for shelf timing. Postiming references are BITSin-A, BITSin-B, OC-3, and EC-1 tributaries anDS1 facilities.

Note: This command will never generate an error response; a default vfor the system always exists.


Input syntax RTRV-TMREFIN:[TID]::CTAG;



Example inputRetrieve the timing reference for network element New York: RTRV-TMREFIN:NEWYORK::CTAG45;

Field Purpose





Response block syntax ^^^"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-16


Express Express CX

Facility AID OC3-slot#EC1-slot#DS1-slot#-port#

BITSIN-BitNONE

OC-3, slot 3 to 12EC-1, slot 3, 5, 7 or 9DS1, slot 4 to 10, port 1 to 12

BITSIN-A or BITSIN-BDeprovision timing reference

OC-3, slot 3 to 4EC-1, slot 1DS1, slot 1, port 1 to 12DS1, slot 3, port 1 to 8Not supportedDeprovision timing reference

SST (secondary state)

ACT&WKH

ACT&ERRANL

IDLE&WKG

IDLE&FLT

Active and working

Active and errored

Idle and working

Idle and faulty

Sync msg status

ST1

STU

ST2

ST3

SMC

ST4

RES

DUS

NONE

Stratum 1 Traceable

Synchronized–traceability unknown

Stratum 2 Traceable

Stratum 3 Traceable

Traceable SONET minimum clock

Stratum 4 Traceable

Reserved for network synchronization

Do not use for synchronization

None

Note: The user-provisioned synchronization status set by using the SET-SYNCSTIN command is also listed, with a P following the message.



at,
SET-BITS-IN
The Set BITS Input command is used to set the signal format, frame formand the line code parameters for BITSin-A and BITSin-B.


Input syntaxSET-BITS-IN:[TID]:AID:CTAG:::[SIGFMT=Domain][,FMT=Domain] [,LINECDE=Domain];




Example inputProvision the BITS input to network element WASHINGTON:SET-BITS-IN:WASHINGTON:BITSIN-A:CTAG23:FMT=SF,LINECODE=AMI;

Field Purpose


AID Access identifier. BITS input to act on.


Domain Signal format, frame format, and line code values


BITS input BITSIN-bits BITSIN-A or BITSIN-B


SIGFMT DS1 (default) Signal format DS1

FMT SF (default)

ESF

Superframe format

Extended superframe format

LINECDE AMI (default)

B8ZS

Alternate mark inversion, both directions

Bipolar with 8-zero substitution, both directions



dary the

SET-BITS-OUT The Set BITS Output command is used to provision the primary and secontiming references, the frame format, and the equalization parameters forBITSout-A and BITSout-B. The BITS output provides timing reference to BITS clock or to other digital equipment that accepts a BITS signal.



Input syntaxSET-BITS-OUT:[TID]:AID:CTAG:::[PRI=Domain],[SEC=Domain],[FMT=Domain],[EQLZ=Domain];



Field Purpose




Domain Primary and secondary timing reference sources, or frame format, or equalization values






Example inputProvision the BITS output from network element WASHINGTON:SET-BITS-OUT:WASHINGTON:BITSOUT-A:CTAG23:::PRI=OC3-5,SEC=NONE,FMT=SF,EQLZ=1;


PRI or SEC(see Note)

OC3-slot#EC1-slot#DS1-slot#-port#BITSIN-bitNONE

OC-3, slot 3 to 12EC-1, slot 3, 5, 7 or 9DS1, slot 4 to 10, port 1 to 12BITSIN-A or BITSIN-BDeprovision timing reference

FMT SF (default)ESF

Superframe formatExtended superframe format

EQLZ 1 (default)23

Short (0-266 ft.)Medium (266-533 ft.)Long (533-655 ft.)




status ing

ines nce.

SET-SYNCSTINThe Set Synchronization Status Input command sets the synchronization to override the incoming message from a timing source, so that the incomsynchronization signal may be given a different value. This value determwhether the incoming synchronization signal is used as the timing refere


Input syntaxSET-SYNCSTIN:[TID]:AID:CTAG::SYNC_STATUS;



Field Purpose


AID Facility provisioned as the timing reference


SYNC_STATUS Synchronization status

Table 4-25

AID type Command-specific values

Purpose

Express Express CX

Facility OC3-slot# EC1-slot#DS1-slot#-port#

BITSIN-bitNONE



OC-3, slot 3 to 4EC-1, slot 1DS1, slot 1, port 1 to 12DS1, slot 3, port 1 to 8Not supportedDeprovision timing reference




Example input Provision the synchronization status of BITS input A to ST2:SET-SYNCSTIN:OTTAWA:BITSIN-A:CTAG23::ST2;


SYNC_STATUS ST1STUST2ST3SMCST4RESDUSNONE

Traceable Stratum 1Normal-Traceability UnknownTraceable Stratum 2Traceable Stratum 3Traceable SONET minimum clockTraceable Stratum 4Reserved for Network Synchronization UseDo not use for synchronizationNone



ork

e

SET-TMG-MODE The Set Timing Mode command sets the system timing mode for a netwelement. On an OC-3 Express network element, there are three possiblemodes: free-running internal (INT), line (LINE), or external (EXT). On anOC-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 linetiming to a different mode unless the sources for timing references ardeprovisioned first.


Input syntaxSET-TMG-MODE:[TID]::CTAG::[MODE];



Example inputSet timing mode to line or internal: SET-TMG-MODE:NEWYORK::CTAG02::LINE;

SET-TMG-MODE:WASHINGTON::CTAG03::INT;

Field Purpose



Mode Shelf timing to be selected


Mode EXT

INT

LINE

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



nd

SET-TMREFIN The Set Timing Reference Input command is used to set the input timingreferences for the shelf. Possible values are BITSin-A, BITSin-B, OC-3, aEC-1 tributaries and DS1 tributaries.


Input syntax SET-TMREFIN:[TID]::CTAG:::[PRI=Domain],[SEC=Domain];



Field Purpose



Domain Primary and secondary timing references

Table 4-31


Express Express CX

PRI or SEC OC3-slot#EC1-slot#DS1-slot#-port#

BITSIN-bitNONE



OC-3, slot 3 to 4EC-1, slot 1DS1, slot 1, port 1 to 12DS1, slot 3, port 1 to 8 (Note)Not supportedDeprovision timing reference

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.



the

:

Example inputProvision the primary timing reference input from the OC-3 in slot 11, andsecondary 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;


5-1

e the

Equipment detailed command descriptions 5-

This chapter is an alphabetical summary of all TL1 commands related toprovisioning DS1, DS3, EC-1, OC-3, EIM, and MTX equipment. The command descriptions in this chapter identify each command, and describcommand purpose, syntax, parameters, variables, and response.


Command Page

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-2 Equipment detailed command descriptions

that

tions

DLT-EQPTThe 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 equipment.

When you delete OC-3 or EC-1 equipment, the section data communicachannel (SDCC) link is also affected (layers 1, 2).


Input syntaxDLT-EQPT:[TID]:AID:CTAG;


Field Purpose


AID Access identifier. Equipment to act on.



Equipment detailed command descriptions 5-3


Example inputDelete the DS1 circuit pack in slot 4: DLT-EQPT:NEWYORK:DS1-4:CTAG23;


Purpose

DS1 AID DS1-slot# Identify the DS1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)


EC1 AID EC1-slot# Identify the EC-1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC3 AID OC3-slot# Identify the OC-3 equipment where slot#= 3 to 12 (Express)

EIM AID EIM-slot# Identify the EIM equipment where slot#= 7 to 10 (Express) slot#= 1 to 2 (Express CX)

ILAN AID ILAN Identify the ILAN equipment where slot#= 16 (Express)

PSC AID PSC Identify the protection switch controller

PSX AID PSX Identify the protection switch extender

Note: The PSX can only be deleted if DS1-6-5 and higher do not exist.

NP AID NP Identify the network processor



type is

ot

lex as ady

ENT-EQPTThe Enter Equipment command is used to enter the attributes of a givenof common equipment module or slot definition in a network element. Thtells the network element that a specific circuit pack of a particular type issupposed to be in a particular slot.

If the system does a self test and finds a circuit pack in a slot that does nmatch 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 protectionscheme is based on the OC-3/EC-1 equipment protection scheme (Simpopposed to 1+1 protected) as well as the current number of SDCCs alreconfigured on a given pair of OC-3 or EC-1 circuit packs.


Input syntaxENT-EQPT:[TID]:AID:CTAG::::[PST];


Field Purpose




PST Primary state (optional parameter)





Example inputProvision 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;

AID type Command values Purpose



EC1 AID EC1-slot# Identify the EC-1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC3 AID OC3-slot# Identify the OC-3 equipment where slot#= 3 to 12 (Express)

EIM AID EIM-slot# Identify the EIM equipment where slot#= 7 to 10 (Express)






Description

PST IS In-service (default)

OOS-MA Out-Of-Service maintenance for provisioning Memory Administration

Note: Secondary state cannot be provisioned.



Provision a DS3 circuit pack in slot 6: ENT-EQPT:SEATTLE:DS3-6:CTAG23;



n

ent

RMV-EQPT The Remove Equipment command removes the specified type of commoequipment module from service and puts it in an out-of-service (OOS) maintenance for memory administration state. Any facilities on the equipmmust also be OOS for this to be permitted.


Input syntax RMV-EQPT:[TID]:AID:CTAG;


Field Purpose







Example input Put the DS1 circuit pack in slot 4 out of service: RMV-EQPT:NEWYORK:DS1-4:CTAG23;




EC-1 AID EC1-slot# Identify the EC-1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC-3 AID OC3-slot# Identify the OC-3 equipment where slot#= 3 to 12 (Express)



VTX AID VTX-slot# Identify VTX where slot#= 13 or 14

MTX AID MTX-slot# Identify MTX where slot#= 3 or 4



ent y

RST-EQPT The Restore Equipment command brings a given type of common equipmmodule back into service from an out-of-service maintenance for memoradministration state.


Input syntaxRST-EQPT:[TID]:AID:CTAG;


Field Purpose







Example inputForce the DS1 circuit pack in slot 4 to go back in service: RST-EQPT:NEWYORK:DS1-4:CTAG34;




EC-1 AID EC1-slot# Identify the EC-1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC-3 AID OC3-slot# Identify the OC-3 equipment where slot#= 3 to 12 (Express)



VTX AID VTX-slot# Identify VTX where slot#=13 or 14

MTX AID MTX-slot# Identify MTX where slot#=3 or 4



te ifies ly

RTRV-EQPT The Retrieve Equipment command retrieves the data parameters and staparameters for provisioned equipment and facilities. This command identonly what is provisioned and does not identify which equipment is actualpresent or missing.

To identify what equipment is physically situated in each slot use the RTRV-INVENTORY command.


Input syntax RTRV-EQPT:[TID]:AID:CTAG;



Field Purpose







Example input Retrieve a list of all DS1 equipment provisioned: RTRV-EQPT:SEATTLE:DS1-ALL:CTAG19;


DS1 AID DS1-slot# DS1-ALL

Identify the DS1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

DS3 AID DS3-slot# DS3-ALL

Identify the DS3 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

EC-1 AID EC1-slot# EC1-ALL

Identify the EC-1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC-3 AID OC3-slot# OC3-ALL

Identify the OC-3 equipment where slot#= 3 to 12 (Express)

EIM AID EIM-slot# EIM-ALL

Identify the EIM equipment where slot#= 7 to 10 (Express)




VTX AID VTX-slot#VTX-ALL

Identify VTX where slot#=13 or 14

MTX AID MTX-slot#MTX-ALL

Identify MTX where slot#=3 or 4


SP AID SP Identify the shelf processor



Response block syntaxAID:<PEC=Domain>,<REL=Domain>,<CLEI=Domain>,<SER=Domain>, <MDAT=Domain>,<AGE=Domain>,<ONSC=Domain>:<pst>,<sst>



AID DS1-slot# Identify the DS1 whereslot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

DS3-slot# Identify the DS3 whereslot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

EC1-slot# Identify the EC-1 whereslot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

PSC Identify the protection switch controller

PSX Identify the protection switch extender

OC3-slot# Identify the OC-3 whereslot#= 3 to 12 (Express)

EIM-slot# Identify the EIM whereslot#= 7 to 10 (Express)

ILAN Identify the ILAN whereslot#= 16 (Express)

VTX-slot# Identify the VTX where slot# = 13 or 14

MTX-slot# Identify the MTX where slot# = 3 or 4

NP Identify the network processor circuit pack

SP Identify the shelf processor circuit pack

PEC 8 alphanumeric characters

Product engineering code, a standard Northern Telecom product identifier

REL 1-255 Release version number

CLEI 10 alphanumeric characters

Common Language equipment identifier

SER 9 alphanumeric characters

Serial number

—continued—



MDAT YYYY-WOY Manufacture date, the date the unit was manufactured, in the format:year-week of year.

AGE YY-DDD-hh-mm Age, cumulative in-service time elapsed since manufacture, in the format: years-days-hours-minutes.

ONSC YY-DDD-hh-mm On since, cumulative time since the unit was last inserted, in the format:years-days-hours-minutes.

PST IS In-service (default)

IS-ANR In-service - Abnormal

OOS-MA Out-of-service maintenance for provisioning memory administration

OOS-AU Out-of-service autonomous - the entity is not able to perform its provisioned functions (alarm is raised)

OOS-AUMA 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 Active, carrying traffic (default)

IDLE Idle, not carrying traffic

PSI Protection switch inhibited

FLT Fault detected in equipment

MEA Mismatched equipment attributes (circuit pack)

TSTF Test failed, OOS due to failed test

UEQ Unequipped, circuit pack missing

Table 5-12 (continued)Response parameter descriptions




.

RTRV-INVENTORY The Retrieve Inventory command identifies what type of circuit packs aresituated 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


Input syntax RTRV-INVENTORY:[TID]:[AID]:CTAG;



Example input 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 networkelements: RTRV-INVENTORY:ALL::CTAG20;

Response block syntaxAID::<PEC=Domain>,<REL=Domain>,<CLEI=Domain>,<SER=Domain>,<MDAT=Domain>,<AGE=Domain>,<ONSC=Domain>;

Field Purpose


AID Access identifier. Slot number to act on.


Table 5-14Input parameter descriptions

Parameter Command-specific values Purpose

AID slot#= 1 through 18 (Express)slot#= 1 through 5 (Express CX)

ALLNull

Identify the circuit pack slot number.

All slotsAll slots





AID equipment-slot#=1 to 18 (Express)1 to 5 (Express CX)

Circuit pack and its slot number in the network element shelf

EMPTY There is no identifiable circuit pack in the slot

UNKNOWN The circuit pack occupying the slot cannot be identified

DS1 DS1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

DS3 DS3 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

EC1 EC-1 equipment where slot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC3 OC-3 equipment where slot#= 3 to 12 (Express)

EIM EIM equipment where slot#= 7 to 10 (Express)

ILAN ILAN equipment whereslot#= 16 (Express)

PSC Protection Switch Controller

PSX Protection Switch Extender

VTX Virtual Tributary Cross-connect circuit pack

MTX Main Transport circuit pack

NP Network Processor circuit pack

SP Shelf Processor circuit pack

LEX Left Extender circuit pack

REX Right Extender circuit pack

LIO_FRONT Left Input/Output circuit pack, front

LIO_REAR Left Input/Output circuit pack, rear

—continued—



AID (cont) RIO_FRONT Right Input/Output circuit pack, front

RIO_REAR Right Input/Output circuit pack, rear

CIO Common input/output module

EIO Expansion input/output module

PEC 8 alphanumeric characters

Product Equipment Code. Standard Northern Telecom product identifier.

REL 1-255 Release version number

CLEI 10 alphanumeric characters

Common Language equipment identifier

SER 9 alphanumeric characters

Serial number

MDAT YYYY-WOY Manufacture date. The date the unit was manufactured in the format: year-week of year.

AGE YY-DDD-hh-mm Age. Cumulative in-service time elapsed since manufacture in the format:years-days-hours-minutes.

ONSC YY-DDD-hh-mm On since. Cumulative time since the unit was last inserted, in the format:years-days-hours-minutes.




6-1

n ons se,

Facility detailed command descriptions 6-

This chapter is an alphabetical summary of all TL1 commands to provisioDS1, DS3, EC-1, EIM bridge, and OC-3 facilities. The command descriptiin this chapter identify each command, and describe the command purposyntax, parameters, variables, and response.


Command Page

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

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

—continued—


6-2 Facility detailed command descriptions

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

Command Page


Facility detailed command descriptions 6-3

d u lete ing

DLT-EC1 The Delete EC-1 command is used to eliminate the EC-1 facility from theEC-1 circuit pack; the EC-1 circuit pack provisioning information is deleteand all other information (errors, monitoring points) is ignored. Before yodelete an EC-1 facility, you must delete all connections on the facility, deany SDCC links on the EC-1, ensure the EC-1 facility is not used as a timreference, and put the facility out of service (OOS).


Input syntaxDLT-EC1:[TID]:AID:CTAG;



Example inputDelete the EC-1 facility in slot 5: DLT-EC1:NEWYORK:EC1-5:CTAG34;

Field Purpose


AID Access identifier. EC-1 facility to act on.



EC1 AID EC1-slot# Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



he u e

DLT-EIMThe Delete EIM command is used to delete the EIM bridge facility from tEIM circuit pack. The EIM circuit pack provisioning information is deletedand all other information (errors, monitoring points) is ignored. Before yodelete an EIM bridge facility, you must delete all connections on the bridgfacility and put the facility out of service (OOS).


Input syntaxDLT-EIM:[TID]:AID:CTAG;



Example inputDelete EIM bridge facility 2 from the EIM circuit pack in slot 7: DLT-EIM:NEWYORK:EIM-7-2:CTAG34;

Field Purpose


AID Access identifier. EIM bridge facility to act on.



EIM AID EIM-slot#-bridge#EIM-slot#-ALLEIM-ALL

Identify the EIM facility where Express slot#= 4 to 10Express CX slot#= 1 to 2bridge#= 1 to 2



C-3

r ment ction cts

DLT-FFP-OC3 The Delete FFP OC-3 command is used to delete 1+1 protection for an Olinear 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 fomemory administration) before the FFP can be deleted. The OC-3 equipruns in simplex mode once you delete the FFP. Connections on the proteOC-3 are deleted when you delete the FFP. Deleting protection also affehow the section data communication channel (SDCC) operates.


Input syntaxDLT-FFP-OC3:[TID]:workingOC3AID,protectionOC3AID:CTAG;



Example inputDelete 1+1 protection for the OC-3 facility in slot 11 and slot 12: DLT-FFP-OC3:SEATTLE:OC3-11,OC3-12:CTAG13;

Field Purpose


AID Access identifier. OC-3 facility to act on.



Purpose

working OC3 AID

protection OC3 AID

OC3-slot# 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 whereslot# = 4, 6, 8, 10, or 12 (Express)slot# = 4 (Express CX)

Note: Ensure that facilities on the protection circuit pack are out of service.



e

fore y,

ing

DLT-OC3The Delete OC-3 command is used to eliminate the OC-3 facility from thOC-3 or MTX circuit pack; the OC-3 facility provisioning information is deleted and all other information (errors, monitoring points) is ignored. Beyou delete an OC-3 facility, you must delete all connections on the facilitdelete any SDCC links on the OC-3, ensure the facility is not used as a timreference, delete the FFP and put the facility OOS.


Input syntaxDLT-OC3:[TID]:AID:CTAG;



Example inputDelete the OC-3 facility in slot 12: DLT-OC3:SEATTLE:OC3-12:CTAG04;

Field Purpose





OC3 AID OC3-slot# Identify the OC-3 slot where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



r ll a

not

DLT-T1The Delete T1 command is used to eliminate a DS1 facility from a DS1 oMTX circuit pack; the DS1facility provisioning information is deleted and aother information (errors, monitoring points) is ignored. Before you deletefacility, you must delete all connections on the facility, ensure the facility isused as a timing reference, and put the facility OOS.


Input syntaxDLT-T1:[TID]:AID:CTAG;



Example inputDelete 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;

Field Purpose


AID Access identifier. DS1 facilities to act on.



DS1 AID DS1-slot#-port#DS1-slot#-ALL

Identify the DS1s where

Express:slot#=4 to 10, port#=1 to 12

Express CX:slot#=1, port#=1 to 12slot#=3, port#=1 to 8



cuit

lity,

DLT-T3 The Delete T3 command is used to eliminate a DS3 facility from a DS3 cirpack; the DS3 facility provisioning information is deleted and all other information (errors, monitoring points) is ignored. Before you delete a faciyou must delete all connections on the facility, and put the facility OOS.


Input syntaxDLT-T3:[TID]:AID:CTAG;



Example inputDelete the DS3 facility in slot 9 at the OTTAWA network element: DLT-T3:OTTAWA:DS3-9:CTAG13;

Field Purpose


AID Access identifier. DS3s to act on.



DS3 AID DS3-slot# Identify the DS3s where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



the ) is

e to

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 (usingED-T1 or ENT-T1 commands), and the start-up time parameter (HH-MMnot entered, HH-MM assumes the default start-up time.


Input syntaxED-DFLT-AINS:[TID]::CTAG::[HH-MM];


Example inputFor the SEATTLE network element, set the default DS1 AINS start-up tim7 hours and 30 minutes: ED-DFLT-AINS:SEATTLE::CTAG04::07-30;

Field Purpose



HH-MM DS1 auto-in-service start-up time

Table 6-14HH-MM parameter descriptions

Parameter Valid values Description

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.



.
ED-EC1
The Edit EC1 command is used to edit the parameters of an EC-1 facility


Input syntaxED-EC1:[TID]:AID:CTAG:::[LBO=Domain];




Example inputEdit the line buildout of the EC-1 facility in slot 5:ED-EC1:SEATTLE:EC1-5:CTAG45:::LBO=2;

Field Purpose


AID Access identifier. EC-1 facility to act on


LBO=Domain Line buildout (optional parameter)


EC1 AID EC1-slot# Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)


LBO 1

2

0 to 224 ft to EC-1 cross-connect (default)

225 to 450 ft to EC-1 cross-connect



of

ED-EIMThe 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 service.


Input syntaxED-EIM:[TID]:AID:CTAG:::[FILTER=Domain][,STP=Domain][,SNMP=Domain][,ETHDPX=Domain][,IPADDR=Domain][,IPMASK=Domain][,IPBROAD=Domain];



Field Purpose




KEYWORD=Domain See Parameter descriptions table for details.


EIM AID EIM-slot#-bridge# Identify the EIM bridge facility whereExpress slot#= 7 to 10Express CX slot#= 1 to 2bridge#=1 to 2



g:


Example inputEdit EIM bridge facility 2 on the EIM circuit pack in slot 10 to enable filterinED-EIM:SEATTLE:EIM-10-1:CTAG34:::FILTER=ON;


Description

FILTER ON Traffic is not allowed to pass through (default)

OFF Allows traffic to pass through

STP ON Enable spanning tree protocol (default)

OFF Disable spanning tree protocol

SNMP ON Enable SNMP

OFF Disable SNMP (default)

ETHDPX HALF

FULL

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.

Note: OC-3 Express CX does not support the ETHDPX parameter.

IPADDR x.x.x.x where x= 0 to 255 or null (Note)

IP address of this entry

IPMASK x.x.x.x where x= 0 to 255 or null (Note)

Subnet mask associated with the IP address of this entry

IPBROAD x.x.x.x where x= 0 to 255 or null (Note)

IP broadcast address used to send datagrams on the (logical) interface associated with the IP address of this entry

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=, ...



line
ED-FFP-OC3
The Edit FFP OC-3 command is used to edit the attributes of the OC-3 1+1protection group.


Input syntaxED-FFP-OC3:[TID]:workingOC3AID,protectionOC3AID:CTAG:::[PSDIRN=Domain];



Example inputEdit 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;

Field Purpose




PSDIRN Direction of protection group for OC-3 lines: UNI (unidirectional) or BI (bidirectional). Default is UNI.


Purpose

working OC3 AID

protection OC3 AID






oup.

the

ED-IMA-GRPThe Edit IMA Group command is used to edit the parameters of an IMA gr

Note 1: Before you can edit the IMA group parameters, you must put associated bridge facility out of service.

Note 2: IMA group parameters are accessible only if the VP is cross-connected.


Input syntaxED-IMA-GRP:[TID]:AID:CTAG:::[IMAFRAME=Domain][,IMASCRAM=Domain];



Field Purpose


AID Access identifier. EIM entity to act on.


IMAFRAME DS1 framing. See Parameter descriptions table for details.

IMASCRAM ATM cell payload scrambling. See Parameter descriptions table for details.


EIM AID EIM-slot#-bridge#-vp# Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2vp#=1 to 8




Example inputEdit IMA group to use SF framing: ED-IMA-GRP:SEATTLE:EIM-9-2-8:CTAG34:::IMAFRAME=SF;


Description

IMAFRAME SF Super frame (default)

ESF Extended super frame

IMASCRAM ON Enable payload scrambling

OFF Disable payload scrambling (default)



) for e ch

ar r

-3c,

ns at

. The race

ault,

ED-OC3The Edit OC3 command is used to set the signal degrade threshold (SDTHOC-3 facilities. The signal degrade threshold determines the bit error rat(BER) in a received OC-3 signal at which an autonomous protection switoccurs.

• an autonomous linear protection switch occurs between two 1+1 lineprotected OC-3 facilities. (OC-3 facilities are provisioned for 1+1 lineaprotection 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 STSSTS-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 provisiothe SDTH for the line and for all signals (STS-3c, STS-1, VT1.5) on thline.

The Edit OC3 command is also used to edit the section trace parametersuser can edit the outgoing section trace message, the expected section tmessage, the section trace format, and the section trace failure mode.

The Edit-OC-3 command is also used to edit SS Bits parameters. By defthe value of SS Bits is SONET but it can also be set to SDH.


Input syntaxED-OC3:[TID]:AID:CTAG:::[SDTH=Domain][,STFORMAT=Domain][,STRC=Domain][,EXPSTRC=Domain][,STFMODE=Domain][,SSBITMDE=Domain];





Field Purpose


AID Access identifier. Identifies an OC-3 facility.


SDTH Signal degrade threshold, bit error level at which a linear autonomous protection switch takes place. See Parameter Description table for details.

STFORMAT Section trace format. See Parameter descriptions table for details.

STRC Outgoing section trace message. See Parameter descriptions table for details.

EXPSTRC Expected section trace message. See Parameter descriptions table for details.

STFMODE Section trace fail mode. See Parameter descriptions table for details.

SSBITMDE SS bits mode

AID type Command-specific parameters Parameter values

OC-3 Facility AID

OC3-slot# slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



ity


Example inputAt the NEWYORK network element, set the SDTH for the slot 7 OC-3 facilto 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;


Description

SDTH 5 to 9 Translates to 10-5 to 10-9 (default is 6)

STFORMAT NUM Section trace message is 1 byte long (default)

STRING Section trace message is up to 15 bytes long

STRC 0 to 255 if STFORMAT is NUM (default is 1)

ASCII string up to 15 characters

if STFORMAT is STRING (default is null character string). See Note 1.

EXPSTRC 0 to 255 if STFORMAT is NUM (default is 1)


if STFORMAT is STRING (default is null character string). See Note 1.

STFMODE OFF Alarms off, no traffic protection (default)

ALMONLY Alarms on, no traffic protection

LINEFAIL Alarms on, with traffic protection. See Notes 2 and 3.

SSBITMDE SONET Default

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.



nd

, the

ds.

ED-T1 The Edit T1 command is used to edit DS1 facility signal, facility service, aauto-in-service parameters.

If parameter and state changes are requested in the same edit commandstate change is processed first, followed by parameter updates.

Note: To change primary state use the RMV-T1, and RST-T1 comman


Input syntaxED-T1:[TID]:AID:CTAG:::[EQLZ=Domain][,FENDNTE=Domain][,FLMDE=Domain][,FMT=Domain][,LINECDE=Domain][,MAP=Domain][,OMODE=Domain]:[PST],[SST],[HH-MM];




Field Purpose




EQLZ=DomainFENDNTE=DomainFLMDE=DomainFMT=DomainLINECDE=DomainMAP=DomainOMODE=Domain

Facility signal attribute parameters. See the Facility signal attribute descriptions table on page 6-21.

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

SSTHH-MM

The DS1 auto-in-service parameters. See the parameter descriptions table on page 6-23.









Table 6-31Facility signal attribute descriptions


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

11TX1RX

Default: short: 0-220 ft both directions 0-220 ft transmit0-220 ft receive

22TX2RX

medium: 220-430 ft both directions 220-430 ft transmit220-430 ft receive

33TX3RX

long: 430-655 ft both directions 430-655 ft transmit430-655 ft receive

FENDNTE ANSI

NOTANSI

Default: Far end NTE supports ANSI standards

ANSI standards are not supported

FLMDE

BOTH

INC

OC

N

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

FMT SF

ESF

SF-TR08

Default: Superframe format

Extended Superframe format

Superframe with TR08 extensions

—continued—



LINECDE Line code. If the incoming and outgoing streams are different, add “TX” or “RX” to the domain, for example “AMITX”, “B8ZSRX”.

AMIAMITXAMIRX

Default: Alternate mark inversion (“bipolar”) both directionsAMI transmit AMI receive

AMIZCS

AMIZCSTX

AMI with zero code suppression, both directions If there are 8 zeros in a byte, the least significant will be changed to a one.

AMIZCS Transmit

Note: Zero code suppression not supported in the receive direction.

B8ZS B8ZSTXB8ZSRX

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

VTASYN

VTBYTE

VTBIT

SIGNLIN

SIGNLOUT

The form of mapping for DS1 payloads into VT1.5s.

Note: You must enter each MAP parameter in a separate command.

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:

Robbed bit signaling bits are transported.

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.

Table 6-31 (continued)Facility signal attribute descriptions




S:

AP

Example inputAlter 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 B8ZED-T1:SEATTLE:DS1-6-ALL:CTAG123:::LINECDE=B8ZS;

Change all the DS1 facilities on the DS1 circuit pack in slot 6 to set the Mto VTBYTE: ED-T1:SEATTLE:DS1-6-ALL:CTAG123:::MAP=VTBYTE;

Table 6-32DS1 auto-in-service parameter descriptions


SST (secondary state)

AINS

AINS-DEA

auto-in-service

auto-in-service deactivated

HH-MM(hour-minute)

00-01 to 96-00 Default = 04-00 ( 4 hours)


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.



of a

ds.

ED-T3 The Edit T3 command is used to edit the service parameters (attributes) DS3 facility.

Note: To change primary state use the RMV-T3 and RST-T3 comman


Input syntaxED-T3:[TID]:AID:CTAG:::[LBO=Domain][,FMT=Domain];


Field Purpose




LBO=DomainFMT=Domain

Line buildoutFrame formatOptional parameters. See Keyword descriptions table for details.



R:



Example inputChange the FMT of the DS3 facility on the DS3 circuit pack in slot 5 to UNFED-T3:NEWYORK:DS3-5:CTAG23:::FMT=UNFR;




FMT ASYNC

UNFR

Multiplex framed (default)

Unframed clear channel

LBO 1

2

0 to 224 ft to DS3 cross-connect (default)

225 to 450 ft to DS3 cross-connect



1
ENT-EC1
The Enter EC-1 command provisions and enters the attributes of an EC-facility in a network element.


Input syntaxENT-EC1:[TID]:AID:CTAG:::[LBO=Domain]:[PST];




Field Purpose




LBO=Domain Line buildout. Optional parameter. See Keyword descriptions table for details.

PST Primary state. Optional parameter. See Parameter descriptions table for details.


EC1 AID EC1-slot# Identify the EC-1 facilityslot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)


LBO 1

2

0-224 ft to EC-1 cross-connect (default)

225-450 ft to EC-1 cross-connect




Example inputEnter an EC-1 facility for the circuit pack in slot 7:ENT-EC1:SEATTLE:EC1-7:CTAG23:::LBO=1;


Description

PST IS In service (default)

OOS-MA Out of service maintenance for memory administration


ENT-EIM
The Enter EIM command is used to enter the attributes of an EIM bridgefacility in an OC-3 Express network element.

To modify EIM facilities once they have been created, use the ED-EIM command.


Input syntaxENT-EIM:[TID]:AID:CTAG:::[FILTER=Domain][,STP=Domain][,SNMP=Domain][,ETHDPX=domain][,IPADDR=Domain][,IPMASK=Domain][,IPBROAD=Domain];



Field Purpose










Example inputAdd 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;


Description

FILTER ON Traffic is not allowed to pass through (default)

OFF Allows traffic to pass through

STP ON Enable spanning tree protocol (default)

OFF Disable spanning tree protocol

SNMP ON Enable SNMP

OFF Disable SNMP (default)

ETHDPX HALF

FULL










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=, ...



C-3 rent pair

e, the

in

ENT-FFP-OC3 The Enter FFP OC-3 command is used to set up 1+1 linear protection for Ointerfaces. The command also affects the operation of the SDCC in diffeways depending on the current number of SDCC links configured on theof 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 2parameters are the same for both links. If the parameters are not the samENT-FFP-OC3 command will not complete.


Input syntaxENT-FFP-OC3:[TID]:workingOC3AID,protectionOC3AID:CTAG:::[PSDIRN=Domain];



Example inputProvision unidirectional 1+1 protection for the pair of OC-3 circuit packs slots 9 and 10:ENT-FFP-OC3:NEWYORK:OC3-9,OC3-10:CTAG12:::PSDIRN=UNI;

Field Purpose


AID Access identifier. OC-3 to act on.


PSDIRN Direction of protection group for OC-3 linesUNI (unidirectional): defaultBI (bidirectional)


Purpose

working OC3 AID

protection OC3 AID






-3
ENT-OC3
The Enter OC-3 command provisions and enters the attributes of an OCfacility in a network element.


Input syntaxENT-OC3:[TID]:AID:CTAG:::[SDTH=Domain][,STFORMAT=Domain][,STRC=Domain][,EXPSTRC=Domain][,STFMODE=Domain][,SSBITMDE=Domain]:[PST];



Field Purpose


AID Access identifier. OC-3 to act on.


SDTH Signal degrade threshold. See Parameter Descriptions table for details.

STFORMAT Section trace format. See Parameter Descriptions table for details.

STRC Outgoing section trace message. See Parameter Descriptions table for details.

EXPSTRC Expected section trace message. See Parameter Descriptions table for details.

STFMODE Section trace fail mode. See Parameter Descriptions table for details.

SSBITMDE SS bits mode

PST Primary state. See Parameter Descriptions table for details.


Purpose

OC3 AID OC3-slot# Identify the OC-3 facility where slot#= 3 to 12 (Express)slot#= 3 to 4 (Express CX)



ith ue of


Example inputSet the primary state of the OC-3 facility in slot 12 to an in-service state wa section trace format value of STRING and an outgoing section trace valAbc123 and the SSBITMDE to SONET: ENT-OC3:SEATTLE:OC3-12:CTAG12:::STFORMAT=STRING,STRC=”Abc123”,SSBITMDE=SONET:IS;


Description

SDTH 5 to 9 Translates to 10-5 to 10-9 (default is 6)

STFORMAT NUM Section trace message is 1 byte long (default)

STRING Section trace message is up to 15 bytes long

STRC 0 to 255 If STFORMAT is NUM (default is 1)


If STFORMAT is STRING (default is null character string). See Note 1.

EXPSTRC 0 to 255 If STFORMAT is NUM (default is 1)


If STFORMAT is STRING (default is null character string). See Note 1.

STFMODE OFF Alarms off, no traffic protection (default)

ALMONLY Alarms on, no traffic protection

SSBITMDE SONET Default

SDH

PST(see Note 2)

IS In service (default)

OOS-MA 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.



a cuit PT

ENT-T1The Enter T1 command is used to enter the attributes of a DS1 facility innetwork element. Since there are multiple DS1 facilities for each DS1 cirpack, ENT-T1 can only be used to provision the line terminations; ENT-EQmust be used to provision the circuit pack.

To modify DS1 facilities once they have been created, use the ED-T1 command.


Input syntaxENT-T1:[TID]:AID:CTAG:::[EQLZ=Domain][,FENDNTE=Domain][,FLMDE=Domain][,FMT=Domain][,LINECDE=Domain][,MAP=Domain][,OMODE=Domain]:[PST],[SST],[HH-MM];


Field Purpose




EQLZ=DomainFENDNTE=DomainFLMDE=DomainFMT=DomainLINECDE=DomainMAP=DomainOMODE=Domain

Facility signal attribute parameters. See the Facility signal attributes description table on page 6-34.

PST Primary state. See the DS1 primary state parameter descriptions table on page 6-36.

SSTHH-MM

DS1 auto-in-service parameters. See the DS1 auto-in-service parameter descriptions table on page 6-23.



Table 6-49Facility signal attributes description


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

11TX1RX


22TX2RX

medium: 220-430 ft both directions 220-430 ft transmit 220-430 ft receive

33TX3RX

long: 430-655 ft both directions 430-655 ft transmit 430-655 ft receive

FENDNTE ANSI

NOTANSI



FLMDE

BOTH

INC

OC

N






FMT SF

ESF

SF-TR08




—continued—




AMIAMITXAMIRX

Default: Alternate mark inversion (“bipolar”) both directionsAMI transmit AMI receive

AMIZCS

AMIZCSTX

AMI with zero code suppression, both directions If there are 8 zeros in a byte, the least significant will be changed to a one.AMIZCS transmit

Note: Zero code suppression is not supported in the receive direction.

B8ZS B8ZSTXB8ZSRX

Bipolar with 8-zero substitution, both directions B8ZS Transmit B8ZS Receive

MAP

VTASYN

VTBYTE

VTBIT


Default:VT1.5 bit asynchronous mapping



MAP

SIGNLIN

SIGNLOUT

If using VTBYTE mapping, one or both of these mappings can also be specified:




OMODE

NORM

IDLE

AZC

Output mode:




Table 6-49 (continued)Facility signal attributes description




LZ

eir

for ed

eir


Example input Provision DS1 facility #7 on the DS1 circuit pack in slot 4 and set its TX EQvalue: ENT-T1:NEWYORK:DS1-4-7:CTAG23:::EQLZ=2TX;

Provision all the DS1 facilities on the DS1 circuit pack in slot 6 and set thLINECDE 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 defaultsEQLZ (it is a long cable, not a short one) and FMT (the framing is extendsuperframe): 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 thMAP values to use VTBYTE:ENT-T1:SEATTLE:DS1-6-ALL:CTAG23:::MAP=VTBYTE;





Table 6-51DS1 primary state parameter descriptions


PST (primary state)

IS

OOS-MA

In service (default)

Out of service maintenance



a
ENT-T3
The Enter T3 command is used to enter the attributes of a DS3 facility innetwork element.

To modify DS3 facilities once they have been created, use the ED-T3 command.


Input syntaxENT-T3:[TID]:AID:CTAG:::[LBO=Domain][,FMT=Domain]:[PST];



Field Purpose




LBO=DomainFMT=Domain

Line buildoutFrame formatOptional parameters. See Keyword Descriptions table for details.

PST Primary state. Optional parameter. See Parameter descriptions table for details.


FMT ASYNC

UNFR



LBO 1

2

0-224 ft to DS3 cross-connect (default)

225-450 ft to DS3 cross-connect




Table 6-55Facility parameter descriptions

Example input Provision a DS3 facility on the DS3 circuit pack in slot 5: ENT-T3:NEWYORK:DS3-5:CTAG23:::LBO=2,FMT=UNFR;




Description

PST IS In service (default)

OOS-MA Out of service maintenance for provisioning memory administration



-1 is

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 ECremoved from service, service-affecting tests or physical replacement of defective equipment can be initiated.


Input syntax RMV-EC1:[TID]:AID:CTAG;



Example input Put the EC-1 facility in slot 5 in an out-of-service state:RMV-EC1:SEATTLE:EC1-5:CTAG45;

Field Purpose





EC-1 AID EC1-slot# Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



M is

RMV-EIMThe Remove EIM command is used to put an EIM facility/bridge in an out-of-service maintenance for memory administration state. Once the EIremoved from service, service-affecting tests or physical replacement of defective equipment can be initiated.


Input syntax RMV-EIM:[TID]:AID:CTAG;



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;

Field Purpose








state ory tests

RMV-OC3The Remove OC-3 command instructs a network element to change theof the OC-3 facility from in service to out-of-service maintenance for memadministration. Once the OC-3 is removed from service, service-affecting or physical replacement of defective equipment can be initiated.


Input syntaxRMV-OC3:[TID]:AID:CTAG;



Example inputRemove OC-3 facility on the OC-3 circuit pack in slot 12: RMV-OC3:NEWYORK:OC3-12:CTAG56;

Field Purpose


AID Access identifier. OC-3s to act on.



OC-3 AID OC3-slot# Identify the OC-3 where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



te of

tests

RMV-T1The Remove T1 command instructs a network element to change the stathe DS1 from in-service to out-of-service maintenance for memory administration. Once the DS1 is removed from service, service-affecting or physical replacement of defective equipment can be initiated.


Input syntaxRMV-T1:[TID]:AID:CTAG;



Example inputRemove 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;

Field Purpose





DS1 AID DS1-slot#-port# DS1-slot#-ALL






te of

tests

RMV-T3The Remove T3 command instructs a network element to change the stathe DS3 from in-service to out-of-service maintenance for memory administration. Once the DS3 is removed from service, service-affecting or physical replacement of defective equipment can be initiated.


Input syntaxRMV-T3:[TID]:AID:CTAG;



Example inputRemove the DS3 facility on the DS3 circuit pack in slot 5: RMV-T3:TOMBSTONE:DS3-3:CTAG45;

Field Purpose








state .

RST-EC1The Restore EC1 command is used to put an EC-1 facility in an in-serviceafter having been out-of-service maintenance for memory administration


Input syntaxRST-EC1:[TID]:AID:CTAG;



Example inputPut the EC-1 facility in slot 5 back in service: RST-EC1:NEWYORK:EC1-5:CTAG34;

Field Purpose





EC-1 AID EC1-slot# Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



tate .

e:

RST-EIMThe Restore EIM command is used to put an EIM facility in an in-service safter having been out-of-service maintenance for memory administration


Input syntaxRST-EIM:[TID]:AID:CTAG;



Example inputPut the EIM bridge facility 1 on the EIM circuit pack in slot 7 back in servicRST-EIM:NEWYORK:EIM-7-1:CTAG34;

Field Purpose








C-3

RST-OC3 The Restore OC-3 command instructs the network element to bring an Ofacility back into service from an out-of-service maintenance for memoryadministration state.


Input syntax RST-OC3:[TID]:AID:CTAG;



Example input Restore the OC-3 facility on the OC-3 circuit pack in slot 11: RST-OC3:NEWYORK:OC3-11:CTAG77;

Field Purpose


AID Access identifier. OC3s to act on.



OC3 AID OC3-slot# Identify the OC3s where slot#= 3 to 12 (Express)slot#= 3 to 4 (Express CX)



k into tate.

RST-T1The Restore T1 command instructs a network element to bring a DS1 bacservice from an out-of-service maintenance for memory administration s


Input syntaxRST-T1:[TID]:AID:CTAG;



Example inputRestore 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;

Field Purpose











k into tate.

RST-T3 The Restore T3 command instructs a network element to bring a DS3 bacservice from an out-of-service maintenance for memory administration s


Input syntax RST-T3:[TID]:AID:CTAG;



Example inputRestore the DS3 facility on the DS3 circuit pack in slot 5: RST-T3:NEWYORK:DS3-5:CTAG01;

Field Purpose








the ) is

p

RTRV-DFLT-AINS Use the Retrieve default auto-in-service command to retrieve the currentdefault 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 (usingED-T1 or ENT-T1 commands), and the start-up time parameter (HH:MMnot entered, HH:MM assumes the default start-up time.


Input syntaxRTRV-DFLT-AINS:[TID]::CTAG;


Example inputFor the SEATTLE network element, retrieve the default DS1 AINS start-utime: RTRV-DFLT-AINS:SEATTLE::CTAG04;

Response block syntaxDFLT-AINS-TIME=HH:MM

Field Purpose





HH:MM(hour:minute)

00:01 to 96:00 Default = 04:00 (4 hours)




state r

RTRV-EC1 The Retrieve EC1 command is used to retrieve the data parameters andparameters for provisioned EC-1 facilities. You can retrieve information foEC-1 facilities by specifying the odd-numbered slots.


Input syntax RTRV-EC1:[TID]:AID:CTAG;




Example input Retrieve the provisioning and service states of the EC-1 facility in slot 7: RTRV-EC1:SEATTLE:EC1-7:CTAG19;

Field Purpose





EC1 EC1-slot# EC1-ALL

Identify the EC-1 facility where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



Response block syntaxAID::<TMGREF=Domain><,LBO=Domain><,DCC=Domain>:<PST>,<SST>

Table 6-80Response block descriptions


AID EC1-slot# The EC-1 and slot number for which the data is retrieved

TMGREF Y

N

Yes, the signal is a timing reference.

No, the signal is not a timing reference.

LBO 1

2

0-224 ft to EC-1 cross-connect (default)

225-450 ft to EC-1 cross-connect

DCC Y

N

Yes, SDCC is enabled

No, SDCC is not enabled

PST IS In-service

IS-ANR In-service -Abnormal

OOS-MA Out-Of-Service Maintenance for provisioning Memory Administration

OOS-AU Out-Of-Service Autonomous - the entity is not able to perform its provisioned functions (alarm is raised)

OOS-AUMA 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 Active - carrying traffic (default)

DISCD Disconnected - not carrying traffic


SGEO Supporting entity outage

WRKTX Working (active) transmitter

WRKRX Working (active) receiver



ice

IM

RTRV-EIMThe Retrieve EIM command is used to retrieve the provisioning and servstate of an EIM bridge facility.


Input syntax RTRV-EIM:[TID]:AID:CTAG;




Example input Retrieve the provisioning and service state of EIM bridge facility 1 for the Ecircuit pack in slot 7: RTRV-EIM:SEATTLE:EIM-7-1:CTAG19;

Response block syntaxAID::<FILTER=Domain><,STP=Domain><,SNMP=Domain><,IPADDR=Domain><,IPMASK=Domain><,IPBROAD=Domain>:<pst><,sst>

Field Purpose





EIM EIM-slot#-bridge#EIM-slot#-ALLEIM-ALL

Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2





AID EIM-slot#-bridge# The EIM slot number and bridge facility for which the data is retrieved

FILTER ON Traffic is not passing through

OFF Traffic is passing through

STP ON Spanning tree protocol is enabled

OFF Spanning tree protocol is disabled

SNMP ON SNMP is enabled

OFF SNMP is disabled

ETHDPX HALF

FULL










PST IS In-service




—continued—



SST DISCD Disconnected –not carrying traffic



Note: This keyword may not have a return value following the =. For example, ...,IPADDR=, IPMASK=47.123.24.43, IPBROAD=, ...

Table 6-83 (continued)Response block descriptions




the
RTRV-FFP-OC3
The Retrieve Facility Protection Group OC-3 command is used to retrieveprotection state of the OC-3 interfaces.


Input syntaxRTRV-FFP-OC3:[TID]:OC3-ALL|workingOC3AID,protectionOC3AID:CTAG;




Example inputRetrieve the protection state for network element WASHINGTON: RTRV-FFP-OC3:WASHINGTON:OC3-11:CTAG12;

Field Purpose




Purpose

OC3 AID OC3-slot#OC3-ALL

Identify the OC-3 slot where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)

working OC3 AID

protection OC3 AID





Response block syntaxWorkingOC3aid,ProtectionOC3aid:<PSDIRN=Domain>



WorkingOC3aid

ProtectionOC3aid

OC3-slot# 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)

PSDIRN UNI

BI

Unidirectional

Bidirectional



ge

RTRV-IMA-GRPThe Retrieve IMA group command is used to retrieve the IMA group parameters.


Input syntax RTRV-IMA-GRP:[TID]:AID:CTAG;




Example input Retrieve the IMA group parameters of the for the virtual port 6 of EIM bridfacility 1 for the EIM circuit pack in slot 7: RTRV-IMA-GRP:SEATTLE:EIM-7-1-6:CTAG19;

Field Purpose





EIM EIM-slot#-bridge#-vp#EIM-slot#-bridge#-ALLEIM-slot#-ALLEIM-ALL

Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2vp#= 1 to 8



Response block syntaxAID::<IMALEN=Domain> <,GRPSYM=Domain> <,IMAID=Domain>,<IMAFRAME=Domain> <,IMASCRAM=Domain> <,PROVBAN=Domain> <,AVAILBAN=Domain>



AID EIM-slot#-bridge#-vp# The EIM slot number, bridge facility, and virtual port for which the data is retrieved

IMALEN 32, 64, 128, 256 Frame length (default is 128)

GRPSYMACOAOSCSCO

Group symmetryAsymmetrical configuration and operationSymmetrical configuration and asymmetrical operationSymmetrical configuration and operation (default)

IMAID 0 to 255 IMA group number

IMAFRAME SFESF

Superframe (default)Extended super frame

IMASCRAM ONOFF

Payload scrambling is enabledPayload scrambling is disabled (default)

PROVBAN 0 to 8 Number of provisioned TI links

AVAILBAN 0 to 8 Number of provisioned TI links carrying traffic



e Bits

RTRV-OC3 The Retrieve OC-3 command retrieves the data, state, and signal degradthreshold (SDTH) parameters and the provisioned section trace and SS information for specified OC-3 facilities.


Input syntaxRTRV-OC3:[TID]:AID:CTAG:::[STINFO=Domain][,SSBITINFO=Domain];






Example inputRetrieve information for the OC-3 facility in slot 11 on network element NEWYORK: RTRV-OC3:NEWYORK:OC3-11:CTAG46:::STINFO=YES,SSBITINFO=YES;

Field Purpose


AID Access identifier. OC-3 facilities to act on.


STINFO Section trace information. See the Parameter descriptions table for details.

SSBITINFO SS bit mode information. See the Parameter descriptions table for details.


OC3 OC3-slot# OC3-ALL

Identify the OC-3 facility where slot#= 3 to 12 (Express)slot#= 3 to 4 (Express CX)


Description

STINFO NO Do not include the section trace information in the response (default)

YES Include the section trace information in the response

SSBITINFO NO Do not include SS Bits information in the response (default)

YES Include SS Bits information in the response



Response block syntaxIf 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-93Response AID descriptions


OC3 AID OC3-slot# Identify the OC-3 facility



Description

TMGREF Y Yes, the signal is a timing reference.

N No, the signal is not a timing reference.

DCC Y Yes, SDCC is enabled.

N No, SDCC is not enabled.

TRC Null This field is not used in this release.

SDTH 5, 6, 7, 8, or 9 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 NUMSTRING

Section trace format (see Notes 1 and 2)

STRC Outgoing section trace message (see Notes 1 and 2)

EXPSTRC Expected incoming section trace message (see Notes 1 and 2)

—continued—



STFMODE OFFALMONLYLINEFAIL

Section trace fail mode (see Note 2)

SSBITINFO(see Note 4)

SONET Default

SDH

PST IS In-service

IS-ANR In-service – Abnormal




OOS-MA-ANR Out-Of-Service Maintenance – abnormal

SST (see Note 3)

ACT Active – carrying traffic (default)

DISCD Disconnected –not carrying traffic



WRKTX Working (active) transmitter

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



Description



eters

sent

RTRV-T1 The Retrieve T1 command retrieves the data parameters and state paramthat 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 preor operational, but simply that it has been provisioned and with which attributes.


Input syntax RTRV-T1:[TID]:AID:CTAG;




Field Purpose





T1 AID DS1-slot#-port# DS1-slot#-ALL DS1-ALL






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;

Response block syntax AID::<EQLZ=Domain>,<FENDNTE=Domain>,<FLMDE=Domain>,<FMT=Domain>,<LINECDE=Domain>,<OMODE=Domain>,<TMGREF=Domain>, <MAP=Domain>:<PST>,<SST>[,HH:MM];

Table 6-97Response AID description


T1 AID DS1-slot#-port# DS1-slot#-ALL DS1-ALL








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

11TX1RX


22TX2RX

medium: 220-430 ft both directions 220-430 ft transmit 220-430 ft receive

33TX3RX

long: 430-655 ft both directions 430-655 ft transmit 430-655 ft receive

FENDNTE ANSI

NOTANSI



FLMDE

BOTH

INC

OC

N






FMT SF

ESF

SF-TR08




—continued—




AMIAMITXAMIRX

Default: Alternate mark inversion (“bipolar”) both directionsAMI Transmit AMI Receive

AMIZCS

AMIZCSTX

AMI with zero code suppression, both directionsIf there are eight zeros in a byte, the least significant will be changed to a one.AMIZCS transmit

Note: Zero code suppression is not supported in the receive direction.

B8ZS B8ZSTXB8ZSRX

Bipolar with 8-zero substitution, both directions B8ZS transmit B8ZS receive

OMODE

NORM

IDLE

AZC

Output mode:




TMGREF Y N

Yes, the signal is a timing reference. No, the signal is not a timing reference.

MAP

VTASYN

VTBYTE

VTBIT


Default: VT1.5 asynchronous mapping



MAP

SIGNLIN

SIGNLOUT

If using VTBYTE mapping, one or both of these mappings can also be specified:










Description

PST IS In-Service

IS-ANR In Service - Abnormal


OOS-AU Out-Of-Service Autonomous the entity is not able to perform its provisioned functions (alarm is raised)


OOS-MA-ANR Out of service maintenance – abnormal

SST ACT Default: Active -- carrying traffic

DISCD Disconnected -- not carrying traffic

FLT Fault Detected in Equipment

SGEO Supporting Entity Outage

AINS auto-in-service

AINS-DEA auto-in-service deactivated (see Note 1)

HH:MM (hour:minute)

00:01 to 96:00 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. 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.



eters

sent

RTRV-T3 The Retrieve T3 command retrieves the data parameters and state paramthat 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 preor operational, but simply that it has been provisioned and with which attributes.


Input syntax RTRV-T3:[TID]:AID:CTAG;




Example input Retrieve provisioned conditions of the DS3 facility on the DS3 in slot 7: RTRV-T3:NEWYORK:DS3-7:CTAG29;

Field Purpose





T3 AID DS3-slot#DS3-ALL

Identify the DS3s where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



Response block syntax AID::<LBO=Domain><,FMT=Domain>:<PST><,SST>





Identify the DS3s slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)

LBO 1

2

0-224 ft to DS3 cross-connect (default)

225-450 ft to DS3 cross-connect

FMT ASYNC

UNFR




Description

PST IS In-Service

IS-ANR In Service - Abnormal


OOS-AU Out-Of-Service Autonomous the entity is not able to perform its provisioned functions (alarm is raised)


OOS-MA-ANR Out-Of-Service Maintenance – abnormal

SST ACT Default: Active – carrying traffic

DISCD Disconnected – not carrying traffic

FLT Fault Detected in Equipment

SGEO Supporting Entity Outage



1

RTRV-VPThe 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.


Input syntax RTRV-VP:[TID]:AID:CTAG;




Example input Retrieve the parameters for all of the virtual port for the EIM bridge facilityfor the EIM circuit pack in slot 7: RTRV-VP:SEATTLE:EIM-7-1-ALL:CTAG19;

Field Purpose


AID Access identifier. VPs to act on.



EIM AID EIM-slot#-bridge#-vp#EIM-slot#-bridge#-ALLEIM-slot#-ALLEIM-ALL

Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2vp#= 1 to 8



Response block syntax AID::<IMAID=Domain>,<ENCAP=Domain>,<VPI=Domain>,<VCI=Domain>,<CONT=Domain>



AID EIM-slot#-bridge#-vp# The EIM slot number, bridge facility, and virtual port number for which the data is retrieved

IMAID 0 to 255 IMA group number

ENCAP LLC_CRCLLCVC_CRCVC

Type of encapsulation

VPI 1 to 255 ATM VPI value

VCI 1 to 65535 ATM VCI value

CONT ON

OFF

ATM continuity test is enabled

ATM continuity test is disabled


7-1

n an ach iables,

MIB detailed command descriptions 7-This chapter is an alphabetical summary of all TL1 commands to provisioEIM bridge for SNMP. The command descriptions in this chapter identify ecommand, and describe the command purpose, syntax, parameters, varand response.


Command Page

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-2 MIB detailed command descriptions

tic

eive

DLT-MIB-BRIDGEThe Delete MIB bridge command is used to remove an entry from the statable in the bridge group MIB.


Input syntaxDLT-MIB-BRIDGE:[TID]:AID:CTAG:::ADDR=Domain, RCVPORT=Domain;



Example inputDelete the entry indexed by MAC address 123456789ABC and static recport 1 from the static table in the bridge group MIB: DLT-MIB-BRIDGE:NEWYORK:EIM-7-1:CTAG34:::ADDR=123456789ABC, RCVPORT=1;

Field Purpose




ADDR MAC address. See Parameter descriptions table for details.

RCVPORT Static receive port. See Parameter descriptions table for details.


EIM AID EIM-slot#-bridge# Identify the EIM bridge facility where Express slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2


MIB detailed command descriptions 7-3


Parameter Domain Description

ADDR MAC address Destination MAC address in a frame to which the filtering information of this entry applies

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



ting
DLT-MIB-IP
The Delete MIB IP command is used to remove an entry from the IP routable or the IP address translation table.


Input syntaxFor 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;



Example inputDelete the table entry for IP route destination 23.43.231.22: DLT-MIB-IP:NEWYORK:EIM-7-2:CTAG34:::DST=23.43.23.122;

Field Purpose




DST Destination IP address of the route. See Parameter descriptions table for details.

NHOP IP address of the next hop on the route. See Parameter descriptions table for details.

IDX Index value of the interface. See Parameter descriptions table for details.

NETADDR IP address corresponding to the media-dependent physical address. See Parameter descriptions table for details.


EIM AID EIM-slot#-bridge# Identify the EIM facility where Express slot#= 4 to 10Express CX slot#= 1 to 2bridge#= 1 to 2




Keyword Domain Parameter

DST x.x.x.x where x= 0 to 255

Destination IP address of this route

NHOP x.x.x.x where x= 0 to 255

IP address of the next hop of this route

IDX 1 to 9 Unique value for each interface

NETADDR x.x.x.x where x= 0 to 255

IP address corresponding to the media-dependent physical address



, the
ED-MIB-BRIDGE
The Edit MIB bridge command is used to edit an entry in the bridge groupbridge spanning tree port table, or the static table in the bridge group.


Input syntaxFor 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];



Field Purpose






EIM AID EIM-slot#-bridge# Identify the EIM bridge facility where Express slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2





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.

STPBRDGMAXAGE 600 to 4000 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.

STPBRDGHELLOTIME 100 to 1000 Network bridges use this value in the range of 100 to 1000 for hello time when this bridge is acting as the root.

STPBRDGFWDDELAY 400 to 3000 Network bridges use this value in the range of 400 to 3000 for forward delay when this bridge is acting as the root

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

PRIORITY 0 to 255 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.

PATHCOST 1 to 65535 STP port PATHCOST is the contribution of this port to the path cost of paths towards the spanning tree root, including this port.

ENABLE ENABLEDISABLE

STP port ENABLE is an enumerated type where enabled(1) and disabled(2) describe the status of the port

—continued—



Example inputEdit 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;

Editing the static table in the bridge group

ADDR MAC Address Destination MAC address in a frame to which the filtering information of this entry applies

RCVPORT 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

ALLOWTOGOTO Bit string: 0000 to FF80 Hex

Set of ports to which frames received from a specific port and destined for a specific MAC address, are allowed to be forwarded

STATUS OTHER INVALIDPERMANENTDELONRSTDELONTIME

An enumerated type where OTHER(1), INVALID(2), PERMANENT(3), DELeteONReSeT(4), and DELeteONTIMEout.

Table 7-9 (continued)Parameter descriptions




, the
ED-MIB-IP
The Edit MIB IP command is used to edit the parameters of the IP groupIP routing table, or the IP address translation table.


Input syntaxFor 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];



Field Purpose










Keyword Domain Parameter

DFLTTTL 1 to 255 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.


METRIC1 -1 to 32767 Primary routing metric for this route

METRIC2 -1 to 32767 First alternate routing metric for this route

METRIC3 -1 to 32767 Second alternate routing metric for this route

METRIC4 -1 to 32767 Third alternate routing metric for this route

METRIC5 -1 to 32767 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.)

IPRT OTHINVDDIRINDR

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

Note: OTH and INVD are not supported in this release.

IPROUTEAGE 0 to 4294967295

Number of seconds since this route was last updated or determined to be correct

MSK x.x.x.x where x= 0 to 255

Indicate the mask to be logical-ANDed with the destination address before being compared to the value in the IPROUTEDEST field



PHYSADDR MAC address Media-dependent physical address

IPNETTOMEDIATYPE OTHERINVALIDDYNAMICSTATIC

Enumerated type where OTHER(1) = none of the following, INVALID(2) = an invalidated mapping, DYNAMIC(3), and STATIC(4)



eters IM

Example inputEdit the IP MIB to change the default TTL for EIM bridge facility 2 on theEIM 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 paramindexed by route destination 23.43.231.2 for EIM bridge facility 2 on the Ecircuit 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;



P

e

ED-MIB-SNMPThe Edit MIB SNMP command is used to edit the parameters of the SNMgroup MIB.


Input syntaxED-MIB-SNMP:[TID]:AID:CTAG:::ENABLEAUTHENTRAPS=Domain;



Example inputEdit the SNMP MIB to generate authentication-failure traps for EIM bridgfacility 2 on the EIM circuit pack in slot 7: ED-MIB-SNMP:SEATTLE:EIM-7-2:CTAG34:::ENABLEAUTHENTRAPS=ON;

Field Purpose




ENABLEAUTHENTRAPS SNMP enable authentication-failure traps (on or off)


Purpose




m
ED-MIB-SYSTEM
The Edit MIB System command is used to edit the parameters of a systegroup MIB.


Input syntaxED-MIB-SYSTEM:[TID]:AID:CTAG:::[CONTACT=Domain][,NAME=Domain][,LOC=Domain];



Field Purpose




CONTACT System contact. See Parameter descriptions table for details.

NAME System name. See Parameter descriptions table for details.

LOC System location. See Parameter descriptions table for details.






Example inputEdit the system MIB to change the contact: ED-MIB-SYSTERM:SEATTLE:EIM-7-1:CTAG34:::CONTACT=EBROWN;


CONTACT ASCII STRING

Textual identification of the contact person for the managed node and the information required to contact this person (up to 50 characters)

NAME ASCII STRING

Assigned name for the managed node (up to 50 characters)

LOC ASCII STRING

Location of the node (up to 50 characters)



iew.
ED-MIB-VIEW
The Edit MIB View command is used to edit the parameters in the MIB v


Input syntaxED-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] ;



Field Purpose




KEYWORD= Domain See Parameter descriptions table for details.







VIDX 1 to 5 Number indicating which of the five community views are being edited

ENABLE YESNO

Flag that determines whether or not the community is valid

NAME STRING String representing the community name as used in all SNMP PDUs

TRAP ONOFF

Flag to indicate if SNMP traps will be generated for this community

IPADDR1 x.x.x.x where x= 0 to 255 or null (Note)

IP address for community member one

UDPPORT1 0 to 65535 or null (Note)

User datagram protocol (UDP) port for community member one


IP address for community member two


UDP port for community member two


IP address for community member three


UDP port for community member three


IP address for community member four


UDP port for community member four


IP address for community member five


UDP port for community member five

—continued—



SYSCONTACT READWRITE

Indicates whether the “CONTACT” keyword in the system group is READ only or read and WRITE in the community view.

SYSNAME READWRITE

Indicates whether the “NAME” keyword in the system group is READ only or read and WRITE in the community view.

SYSLOCATION READWRITE

Indicates whether the “LOC” keyword in the system group is READ only or read and WRITE in the community view.

STATICTABLE READWRITE

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.

STPPORTTABLE READWRITE

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.

DOT1DTPAGINGTIME READWRITE

Indicates whether the “TPAGINGTIME” keyword in the bridge group is READ only or read and WRITE in the community view.

STPBRIDGEFORWARDDELAY READWRITE

Indicates whether the “STPBRDGFWDDELAY” keyword in the bridge group is READ only or read and WRITE in the community view.

STPBRIDGEHELLOTIME READWRITE

Indicates whether the “STPBRDGHELLOTIME” keyword in the bridge group is READ only or read and WRITE in the community view.

STPBRIDGEMAXAGE READWRITE

Indicates whether the “STPBRDGMAXAGE” keyword in the bridge group is READ only or read and WRITE in the community view.

DOT1DSTPPRIORITY READWRITE

Indicates whether the “STPPRIORITY” keyword in the bridge group is READ only or read and WRITE in the community view.

IPROUTETABLE READWRITE

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—





Example inputEdit the MIB view to enable community 2:ED-MIB-VIEW:NEWYORK:EIM-7-1:CTAG23:::VIDX=2, ENABLE=YES, SYSCONTACT=WRITE;

IPDEFAULTTTL READWRITE

Indicates whether the “DFLTTTL” keyword in the IP group is READ only or read and WRITE in the community view.

IPNETTOMEDIA READWRITE

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.

SNMPENABLEAUTHENTRAPS READWRITE

Indicates whether the “ENABLEAUTHENTRAPS” keyword in the SNMP group is READ only or read and WRITE in the community view.

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





idge
ENT-MIB-BRIDGE
The Enter MIB Bridge command is used to add to the static table in the brgroup.


Input syntaxENT-MIB-BRIDGE:[TID]:AID:CTAG:::ADDR=Domain, RCVPORT=Domain, ALLOWTOGOTO=Domain, STATUS=Domain;



Field Purpose









Example inputAdd 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;



ADDR MAC Address Destination MAC address in a frame to which this entry’s filtering information applies

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

ALLOWTOGOTO Range=0000 to FF80

Set of ports to which frames received from a specific port and destined for a specific MAC address, are allowed to be forwarded

STATUS OTHER INVALIDPERMANENTDELONRSTDELONTIME

Enumerated type where OTHER(1), INVALID(2), PERMANENT(3), DELeteONReSeT(4), and DELeteONTIMEout



e or
ENT-MIB-IP
The Enter MIB IP command is used to add an entry to the IP routing tablthe IP address translation table.


Input syntaxFor 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;



Field Purpose






Purpose

EIM AID EIM-slot#-bridge# Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#= 1 to 2



Example inputAdd 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;



Adding an entry to the IP routing table


Destination IP address of this route. An entry with a value of 0.0.0.0 is considered a default route.



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

IPRT OTHINVDDIRINDR

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

Note: OTH and INVD are not supported in this release.


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





IPNETTOMEDIATYPE INVALIDDYNAMICSTATICOTHER

Enumerated type where INVALID(1) = an invalidated mapping, DYNAMIC(2), STATIC(3) and OTHER(4) = none of the following



he ge

RTRV-MIB-BRIDGEThe Retrieve MIB bridge command is used to retrieve the bridge group, tbridge base (generic) group, the bridge spanning tree port table, the bridtransparent port table, and the static table in a bridge group.


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;




t=7):



Example input Retrieve the bridge base port table (table entry indexed by dot1dBasePorRTRV-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;

Field Purpose




BASEPORT Port number of the port for which this entry contains bridge management information (1 to 9)

STPPORT Port number of the port for which this entry contains the spanning tree protocol management information (1 to 9)

TPPORT Port number of the port for which this entry contains transparent bridging management information (1 to 9)

ADDR Destination MAC address in a frame to which this entry’s filtering information applies

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





Response block syntaxAID::<KEYWORD=Domain>



AID EIM-slot#-bridge # EIM bridge facility for which the data is retrieved

Retrieving the bridge group

BASEBRDGADDR MAC address MAC address used by this bridge

BASENUMPORTS 1 to 9 Number of ports controlled by this bridging entity

BASETYPE UNKNOWNTPSRSRT

Type of bridging this bridge can perform where unknown (1), transparent-only (2), sourceroute-only (3), and srt (4)

STPPROTOSPEC UNKNOWNDECLB100IEEE8021D

Version of the spanning tree protocol that is running where unknown (1), declb100 (2),and ieee8021d (3)

STPTIMESINTOPCHG 1 to 4294967295 Time since the last time a topology change was detected by the bridge entity

STPTOPCHGS 0 to 4294967295 Total number of topology changes detected by this bridge since the management entity was last reset or initialized

STPPRIORITY 0 to 65535 Value of the writable portion of the bridge ID

STPDESIGNROOT STP bridge address

Bridge identifier of the root of the spanning tree as determined by the spanning tree protocol (STP) as executed by this node

STPROOTCOST 0 to 65535 Cost of the path to the root as seen from this bridge

STPROOTPORT 0 to 65535 Port number of the port that offers the lowest cost path from this bridge to the root bridge

STPMAXAGE 400 to 3000 Maximum age of STP information learned from the network on any port before it is discarded

STPHELLOTIME 400 to 3000 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—



STPHOLDTIME 0 to 65535 Amount of time during which no more than two configuration bridge PDUs are transmitted by the node; measured in hundredths of a second

STPFWDDELAY 400 to 3000 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.

STPBRDGMAXAGE 600 to 4000 Value that all bridges use for MaxAge when this bridge is acting as the root

STPBRDGHELLOTIME 100 to 1000 Value that all bridges use for HelloTime when this bridge is acting as the root

STPBRDGFWDDELAY 400 to 3000 Value that all bridges use for ForwardDelay when this bridge is acting as the root

TPLRNEDENTRYDISCDS 0 to 4294967295 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

TPAGINGTIME 10 to 1000000 Timeout period for aging out dynamically learned forwarding information

Retrieving the bridge base (generic) group

BASEPORT 1 to 9 Port number of the port that this entry contains bridge management information

IFIDX 1 to 9 Value of the instance of the Index object, defined in MIB-II, for the interface corresponding to this port

DELAYEXCDDISCDS 0 to 4294967295 Number of frames discarded by this port because of excessive transit delay through the bridge

MTUEXCDDISCDS 0 to 4294967295 Number of frames discarded by this port because of excessive size

Retrieving the spanning tree port table

STPPORT 1 to 9 Port number of the port for which this entry contains STP management information

PRIORITY 0 to 255 Value of the priority field that is contained in the first (in network byte order) octet of the (two octet long) Port ID.

—continued—





STATE DISABLEBLOCKINGLISTENINGLEARNINGFORWARDINGBROKEN

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 ENABLEDISABLE

Enabled or disabled status of the port, where enabled (1) and disabled (2)

PATHCOST 1 to 65535 Contribution of this port to the path cost of paths towards the spanning tree root which includes this port

DESIGNROOT STP bridge address

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

DESIGNCOST 1 to 65535 Path cost of the designated port of the segment connected to this port

DESIGNBRIDGE STP bridge address

Bridge identifier of the bridge that this port considers to be the designated bridge for the segment of this port

DESIGNPORT STP bridge suffix Port identifier of the port on the designated bridge for the segment of this port

FWDTRANSITIONS 0 to 4294967295 Number of times this port has transitioned from the learning state to the forwarding state

Retrieving the bridge transparent port table

TPPORT 1 to 9 Port number of the port for which this entry contains transparent bridging management information

MAXINFO 1 to 65535 Maximum size of the INFO field that this port receives or transmits

INFRMS 0 to 4294967295 Number of frames that have been received by this port from its segment

OUTFRMS 0 to 4294967295 Number of frames that have been transmitted by this port from its segment

INDISCDS 0 to 4294967295 Count of valid frames received that were discarded by the forwarding process

—continued—





Retrieving the static table in a bridge group

ADDR MAC address Destination MAC address in a frame to which this entry’s filtering information applies

RCVPORT 0 to 9 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

ALLOWTOGOTO Octet string Set of ports to which frames received from a specific port and destined for a specific MAC address are allowed to be forwarded

STATUS OTHERINVALIDPERMANENTDELONRSTDELONTIME

Status of this entry, where other (1), invalid (2), permanent (3), delete on reset (4), and delete on timeout (5)





rs of
RTRV-MIB-ICMP
The Retrieve MIB ICMP command is used to retrieve the group parametethe Internet control message protocol (ICMP).


Input syntax RTRV-MIB-ICMP:[TID]:AID:CTAG;




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;

Field Purpose





EIM EIM-slot#-bridge# Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2






AID EIM-slot#-bridge# EIM bridge facility for which the data is retrieved

INMSGS 0 to 4294967295 Total number of ICMP messages that the entity received

INERRS 0 to 4294967295 Number of ICMP messages that the entity received but determined as having ICMP-specific errors

INDESTUNREACHS 0 to 4294967295 Number of ICMP destination unreachable messages received

INTIMEEXCDS 0 to 4294967295 Number of ICMP time exceeded messages received

INPARMPROBS 0 to 4294967295 Number of ICMP parameter problems messages received

INSRCQUENCHS 0 to 4294967295 Number of ICMP source quench messages received

INREDIRS 0 to 4294967295 Number of ICMP redirect messages received

INECHOS 0 to 4294967295 Number of ICMP echo request messages received

INECHOREPS 0 to 4294967295 Number of ICMP echo reply messages received

INTIMESTAMPS 0 to 4294967295 Number of ICMP timestamp request messages received

INTIMESTAMPREPS 0 to 4294967295 Number of ICMP timestamp reply messages received

INADDRMASKS 0 to 4294967295 Number of ICMP address mask request messages received

INADDRMASKREPS 0 to 4294967295 Number of ICMP address mask reply messages received

OUTMSGS 0 to 4294967295 Total number of ICMP messages that the entity attempted to send

OUTERRS 0 to 4294967295 Number of ICMP messages that this entity did not send because of problems discovered within ICMP

—continued—



OUTDESTUNREACHS 0 to 4294967295 Number of ICMP destination unreachable messages sent

OUTTIMEEXCDS 0 to 4294967295 Number of ICMP time exceeded messages sent

OUTPARMPROBS 0 to 4294967295 Number of ICMP parameter problems messages sent

OUTSRCQUENCHS 0 to 4294967295 Number of ICMP source quench messages sent

OUTREDIRS 0 to 4294967295 Number of ICMP redirect messages received

OUTECHOS 0 to 4294967295 Number of ICMP echo request messages received.sent

OUTECHOREPS 0 to 4294967295 Number of ICMP echo reply messages sent

OUTTIMESTAMPS 0 to 4294967295 Number of ICMP timestamp request messages sent

OUTTIMESTAMPREPS 0 to 4294967295 Number of ICMP timestamp reply messages sent

OUTADDRMASKS 0 to 4294967295 Number of ICMP address mask request messages sent

OUTADDRMASKREPS 0 to 4294967295 Number of ICMP address mask reply messages sent





roup

y

RTRV-MIB-IF The Retrieve MIB interfaces command is used to retrieve the interfaces gand port table.


Input syntaxFor retrieving the interfaces group:RTRV-MIB-IF:[TID]:AID:CTAG;

For retrieving the interfaces port table:RTRV-MIB-IF:[TID]:AID:CTAG:::IDX=Domain;




Example inputRetrieve the interface MIB information in interfaces table entry indexed bifIndex=4: RTRV-MIB-IF:WASHINGTON:EIM-7-1:CTAG12:::IDX=4;

Field Purpose




IDX Index. IDX is the unique value for each interface (1 to 9).


Purpose








Retrieving the interfaces group

NUMBER 9 Number of network interfaces present on the system

Retrieving the interfaces port table


DESCR STRING Textual string containing information about the interface

IFTYPE OTHERETHERNET-CSMACD

Enumerated type where other (1)—none of the following, Ethernet-csmacd (2)

MTU 1500 Size of the largest datagram that can be sent or received on the interface, specified in octets

SPD 0 to 4294967295 Estimate of the current bandwidth of the interface in bits per second

PHYSADDR MAC address Address of the interface at the protocol layer immediately below the network layer in the protocol stack

ADMINSTAT UPDOWNTESTING

Enumerated type for the desired state of the interface where up (1), down (2), and testing (3)

OPERSTAT UPDOWNTESTING

Enumerated type for the operational state of the interface where up (1), down (2), and testing (3)

LASTCHG 0 to 4294967295 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

INOCTETS 0 to 4294967295 Total number of octets received on the interface, including framing characters

INUCASTPKTS 0 to 4294967295 Number of subnetwork-unicast packets delivered to a higher layer protocol

—continued—



INNUCASTPKTS 0 to 4294967295 Number of non-unicast packets delivered to a higher layer protocol

INDISCDS 0 to 4294967295 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

INERR 0 to 4294967295 Number of inbound packets that contained errors preventing them from being delivered to a higher layer protocol

INUNKNWNPROTOS 0 to 4294967295 Number of packets received by way of the interface that were discarded because of an unknown or unsupported protocol

OUTOCTETS 0 to 4294967295 Total number of octets transmitted out of the interface, including framing characters

OUTUCASTPKTS 0 to 4294967295 Total number of packets that higher level protocols requested be transmitted to a subnetwork-unicast address, including those that were discarded or not sent

OUTNUCASTPKTS 0 to 4294967295 Total number of packets that higher level protocols requested be transmitted to a non-unicast address, including those that were discarded or not sent

OUTDISCDS 0 to 4294967295 Number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted

OUTERR 0 to 4294967295 Number of outbound packets that could not be transmitted because of errors

OUTQLEN 0 to 4294967295 Length of the output packet queue in packets





ress
RTRV-MIB-IP
The Retrieve MIB IP command is used to retrieve the IP group, the IP addtable, the IP routing table, the IP address translation table.


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;




Field Purpose




KEYWORD=Domain See Parameter Descriptions table for details.





it

idge


Example input Retrieve the IP group information for EIM bridge facility 1 for the EIM circupack 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 brfacility 2 for the EIM circuit pack in slot 7: RTRV-MIB-IP:SEATTLE:EIM-7-2:CTAG19:::ADDR:42.124.34.34;


ADDR x.x.x.x where x= 0 to 255

IP address


Destination IP address of the route. An entry with a value of 0.0.0.0 is considered a default route.












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

DFLTTTL 1 to 255 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

INRCV 0 to 4294967295 Total number of input datagrams received from interfaces, including those received in error

INHDRERR 0 to 4294967295 Number of input datagrams discarded because of errors in their IP headers

INADDRERR 0 to 4294967295 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

FORWDATAGRAMS 0 to 4294967295 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

INUNKNWNPROTOS 0 to 4294967295 Number of locally-addressed datagrams received successfully but discarded because of an unknown or unsupported protocol

INDISCDS 0 to 4294967295 Number of input datagrams for which no problems were encountered to prevent their continued processing, but which were discarded

INDELIVERS 0 to 4294967295 Total number of input datagrams successfully delivered to IP user protocols

OUTREQS 0 to 4294967295 Total number of IP datagrams that local IP user protocols supplied to IP in requests fro transmission

—continued—



OUTDISCDS 0 to 4294967295 Number of output datagrams for which no problems were encountered to prevent their continued processing, but which were discarded

OUTNOROUTES 0 to 4294967295 Number of IP datagrams discarded because no route could be found to transmit them to their destination

REASMTIMEOUT 1 to 255 Maximum number of seconds that received fragments are held while they are awaiting reassembly at this entity

REASMREQDS 0 to 4294967295 Number of IP fragments received which needed to be reassembled at this entity

REASMOKS 0 to 4294967295 Number of IP datagrams successfully reassembled

REASMFAILS 0 to 4294967295 Number of failures detected by the IP reassembly algorithm

FRAGOKS 0 to 4294967295 Number of IP datagrams that have been successfully fragmented at this entity

FRAGFAILS 0 to 4294967295 Number of IP datagrams that have been discarded because they needed to be fragmented at this entity but could not be

FRAGCREATES 0 to 4294967295 The number of IP datagram fragments that have been generated as a result of fragmentation at this entity

ROUTINGDISCDS 0 to 4294967295 Number of routing entries that were chosen to be discarded even though they are valid

Retrieving the IP address table

ADDR x.x.x.x where x= 0 to 255

IP address to which the addressing information of this entry pertains

IDX 1 to 9 Index value which uniquely identifies the interface to which this entry is applicable

NETMASK x.x.x.x where x= 0 to 255


—continued—





BCASTADDR x.x.x.x where x= 0 to 255

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

REASMMAXSIZE 0 to 65535 Size of the largest IP datagram that this entity can reassemble from incoming IP fragmented datagrams received on this interface

Retrieving IP routing table


Destination IP address of this route

IDX 1 to 9 Index value that uniquely identifies the local interface through which the next hop of this route should be reached

METRIC1 -1 to 32767 Primary routing metric for this route

METRIC2 -1 to 32767 Alternate routing metric for this route






IPRT OTHINVDDIRINDR

Type of route where other (1), invalid (2), direct (3), and indirect (4)

PROTO OTHERLOCALNETMGMTICMP

Routing mechanism through which this route was learned where other (1), local (2), netmgmt (3), and icmp (4)

IPROUTEAGE 0 to 4294967295 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—





Retrieving IP address translation table

IDX 1 to 9 Interface on which the equivalence of this entry is effective




IPNETTOMEDIATYPE OTHERINVALIDDYNAMICSTATIC

Enumerated type where other (1), invalid (2), dynamic (3), and static (2)





RTRV-MIB-LANThe Retrieve MIB LAN command retrieves the LAN group MIB.


Input syntaxRTRV-MIB-LAN:[TID]:AID:CTAG;



Example inputRetrieve LAN MIB information: RTRV-MIB-LAN:NEWYORK:EIM-7-1:CTAG46;

Field Purpose





EIM EIM-slot#-bridge#- Identify the EIM bridge facility whereExpress slot#= 4 to 10Express CX slot#= 1 to 2bridge#=1 to 2



Response block syntaxAID::<KEYWORD=Domain>;




IDX 1 to 9 Index value that uniquely identifies an interface to an ethernet-like medium

ALIGNERR 0 to 4294967295 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

FCSERR 0 to 4294967295 Count of frames received on a particular interface that are an integral number of octets in length and do not pass the FCS check

SINGLECOLLFR 0 to 4294967295 Count of successfully transmitted frames on a particular interface for which transmission is inhibited by exactly one collision

MULTICOLLFR 0 to 4294967295 Count of successfully transmitted frames on a particular interface for which transmission is inhibited by more than one collision

SQETESTERR 0 to 4294967295 Count of times that the SQE test error message is generated by the PLS sublayer for a particular interface

DEFERTRANS 0 to 4294967295 Count of frames for which the first transmission attempt on a particular interface is delayed because the medium is busy

LATECOLL 0 to 4294967295 Number of times that a collision is detected on a particular interface later than 512 bit-times into the transmission of a packet

EXCESSCOLL 0 to 4294967295 Count of frames for which the transmission on a particular interface fails because of excessive collisions

INTERNALMACRXERR 0 to 4294967295 Count of frames for which the transmission on a particular interface fails because of an internal MAC sublayer transmit error

—continued—



CARSENERR 0 to 4294967295 Number of times that the carrier sense condition was lost or never asserted when attempting to transmit a frame on a particular interface

FRTOOLONGS 0 to 4294967295 Count of frames received on a particular interface that exceed the maximum permitted frame size

INTERNALMACRXERR 0 to 4294967295 Count of frames for which reception on a particular interface fails because of an internal MAC sublayer receive error





RTRV-MIB-SNMPThe Retrieve MIB SNMP command is used to retrieve the SNMP group.


Input syntax RTRV-MIB-SNMP:[TID]:AID:CTAG;




Field Purpose








Example input Retrieve SNMP MIB information: RTRV-MIB-SNMP:NEWYORK:EIM-7-1:CTAG29;

Response block syntax AID:<KEYWORD=Domain>;




INPKTS 0 to 4294967295 Total number of messages delivered to the SNMP entity from the transport service.

OUTPKTS 0 to 4294967295 Total number of SNMP messages that were passed from the SNMP protocol entity to the transport service

INBADVER 0 to 4294967295 Total number of SNMP messages that were delivered to the SNMP protocol entity and were for an unsupported SNMP version

INBADCOMMUNAMES 0 to 4294967295 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

INBADCOMMUUSES 0 to 4294967295 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

INASNPARSEERRS 0 to 4294967295 Total number of ASN.1 or BER errors encountered by the SNMP protocol entity when decoding received SNMP messages

INTOOBIGS 0 to 4294967295 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

INNOSUCHNAMES 0 to 4294967295 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

INBADVALUES 0 to 4294967295 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

—continued—



INREADONLYS 0 to 4294967295 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

INGENEERS 0 to 4294967295 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

INTOTALREQVARS 0 to 4294967295 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

INTOTALSETVARS 0 to 4294967295 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

INGETREQS 0 to 4294967295 Total number of SNMP Get request PDUs that have been accepted and processed by the SNMP protocol entity

INGETNEXTS 0 to 4294967295 Total number of SNMP Get next PDUs that have been accepted and processed by the SNMP protocol entity

INSETREQS 0 to 4294967295 Total number of SNMP Set request PDUs that have been accepted and processed by the SNMP protocol entity

INGETRESPS 0 to 4294967295 Total number of SNMP Get response PDUs that have been accepted and processed by the SNMP protocol entity

INTRAPS 0 to 4294967295 Total number of SNMP trap PDUs that have been accepted and processed by the SNMP protocol entity

OUTTOOBIGS 0 to 4294967295 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

OUTNOSUCHNAMES 0 to 4294967295 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

—continued—





OUTBADVALS 0 to 4294967295 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

OUTGENERRS 0 to 4294967295 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

OUTGETREQS 0 to 4294967295 Total number of SNMP Get request PDUs that have been generated by the SNMP protocol entity

OUTGETNEXTS 0 to 4294967295 Total number of SNMP Get next PDUs that have been generated by the SNMP protocol entity

OUTSETREQS 0 to 4294967295 Total number of SNMP Set request PDUs that have been generated by the SNMP protocol entity

OUTGETRESPS 0 to 4294967295 Total number of SNMP Get response PDUs that have been generated by the SNMP protocol entity

OUTTRAPS 0 to 4294967295 Total number of SNMP Trap PDUs that have been generated by the SNMP protocol entity

ENABLEAUTHENTRAPS ONOFF

Indication of whether the SNMP agent process is permitted to generate authentication-failure traps where enabled (1) and disabled (2)





k

RTRV-MIB-SYSTEMThe Retrieve MIB System command retrieves the system group MIB.


Input syntax RTRV-MIB-SYSTEM:[TID]:AID:CTAG;




Example input Retrieve system MIB information on bridge facility 1 of the EIM circuit pacin slot 7: RTRV-MIB-SYSTEM:NEWYORK:EIM-7-1:CTAG29;

Field Purpose








Response block syntax AID::<UPTIME=Domain>,<CONTACT=Domain>,<NAME=Domain>,<LOC=Domain>,<SERV=Domain>




UPTIME 1 to 4294967295 Time since the network management portion of the system was last reinitialized

CONTACT ASCII STRING Textual identification of the contact person for the managed node and the information required to contact this person

NAME ASCII STRING Assigned name for the managed node

LOC ASCII STRING Location of the node

SERV 0 to 127 Value that indicates the set of services that this entity primarily offers



the
RTRV-MIB-UDP
The Retrieve MIB UDP command is used to retrieve the UDP group andUDP port table group.


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;




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;

Field Purpose




LOCALADDR Local IP address for the UDP listener





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>




INDATAGRAMS 0 to 4294967295 Total number of UDP datagrams delivered to UDP users

NOPORTS 0 to 4294967295 Total number of received UDP datagrams for which there was no application at the destination port

INERRS 0 to 4294967295 Number of received UDP datagrams that could not be delivered for reasons other than the lack of an application at the destination port

OUTDATAGRAMS 0 to 4294967295 Total number of UDP datagrams sent from this entity

LOCALADDR x.x.x.x where x= 0 to 255

Local IP address for this UDP listener

LOCALPORT1 0 to 65535 ornull (Note)

Local port number for this UDP listener









Note: This keyword may not have a return value following the =. For example, ...,LOCALPORT1=, LOCALPORT2=345, ...



RTRV-MIB-VIEWThe Retrieve MIB view command is used to retrieve the MIB view.


Input syntax RTRV-MIB-VIEW:[TID]:AID:CTAG;




Example input Retrieve the MIB view information for the EIM bridge facility 1 for the EIMcircuit pack in slot 7: RTRV-MIB-VIEW:SEATTLE:EIM-7-1:CTAG19;

Field Purpose








Response block syntax AID::<KEYWORD=Domain>




VIDX 1 to 5 Number indicating which of the five community views are being edited, and so it is a mandatory parameter

ENABLE YESNO

Flag that determines whether or not the community is valid

NAME STRING String representing the community name as used in all SNMP PDUs

TRAP ONOFF

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

—continued—




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

SYSCONTACT READWRITE

Indicates whether the “CONTACT” keyword in the system group is READ only or read and WRITE in the community view.

SYSNAME READWRITE

Indicates whether the “NAME” keyword in the system group is READ only or read and WRITE in the community view.

SYSLOCATION READWRITE

Indicates whether the “LOC” keyword in the system group is READ only or read and WRITE in the community view.

STATICTABLE READWRITE

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.

STPPORTTABLE READWRITE

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.

DOT1DTPAGINGTIME READWRITE

Indicates whether the “TPAGINGTIME” keyword in the bridge group is READ only or read and WRITE in the community view.

STPBRIDGEFORWARDDELAY READWRITE

Indicates whether the “STPBRDGFWDDELAY” keyword in the bridge group is READ only or read and WRITE in the community view.

STPBRIDGEHELLOTIME READWRITE

Indicates whether the “STPBRDGHELLOTIME” keyword in the bridge group is READ only or read and WRITE in the community view.

—continued—





STPBRIDGEMAXAGE READWRITE

Indicates whether the “STPBRDGMAXAGE” keyword in the bridge group is READ only or read and WRITE in the community view.

DOT1DSTPPRIORITY READWRITE

Indicates whether the “STPPRIORITY” keyword in the bridge group is READ only or read and WRITE in the community view.

IPROUTETABLE READWRITE

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.

IPDEFAULTTTL READWRITE

Indicates whether the “DFLTTTL” keyword in the IP group is READ only or read and WRITE in the community view.

SNMPENABLEAUTHENTRAPS READWRITE

Indicates whether the “ENABLEAUTHENTRAPS” keyword in the SNMP group is READ only or read and WRITE in the community view

IPNETTOMEDIA READWRITE

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.

Note: This keyword may not have a return value following the =. For example, ..., UDPPORT1=, IPADDR1=, UDPPORT2=232, IPADDR2=47.123.111.123, ...




8-1

dd, and mand e lists

Cross-connect detailed command descriptions 8-

This chapter is an alphabetical summary of all the TL1 commands that adelete or retrieve STS-1, STS-3c, and VT1.5 cross-connects. The commdescriptions in this chapter identify each command, and describe the compurpose, syntax, parameters, variables, and response. The following tablall of the commands in this chapter.

Command Page

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


Input syntaxDLT-CRS-STS1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];



Field Purpose


FromAID From access identifier. The facility at one end of the cross-connect. If the connection is unidirectional, the FromAID specifies the signal source.

ToAID To access identifier. The facility at the other end of the cross-connect. If the connection is unidirectional, the ToAID specifies the signal destination.


CCT Cross-connection type

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

AID type Command-specificparameters

Parameter values

Express Express CX

STS-1 Facility AID

OC3-slot#-sts# slot# = 3 to 12sts# = 1 to 3

slot# = 3 to 4sts# = 1 to 3

DS3-slot# slot# = 3, 5, 7, or 9 slot# = 1

EC1-slot# slot# = 3, 5, 7, or 9 slot# = 1


Cross-connect detailed command descriptions 8-3

d 12:

tion in

Table 8-3CCT descriptions

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 inputFor the NEWYORK network element, delete the bidirectional STS-1 passthrough cross-connection between the OC-3 interfaces in slots 11 anDLT-CRS-STS1:NEWYORK:OC3-11-1,OC3-12-1:CTAG12::2WAY;

For the SEATTLE network element, delete the bidirectional STS-1 connecbetween the DS3 facility in slot 9 and the path protected OC-3 interfacesslots 11 and 12: DLT-CRS-STS1:SEATTLE:OC3-11-1,DS3-9:CTAG12::2WAYPR:SWMATE=OC3-12-1;

CCT Description

1WAY Unidirectional connection

2WAY Bidirectional connection (default)

1WAYPR Unidirectional path ring connection

2WAYPR Bidirectional path ring connection

2WAYBR Bidirectional bridge ring connection



nnect.
DLT-CRS-STS3C
The Delete Cross-connect STS-3c command deletes an STS-3c cross-co


Input syntaxDLT-CRS-STS3C:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];



Field Purpose






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


OC-3 Facility AID

OC3-slot# Identify the OC-3 facility whereslot# = 3 to 12



d 12:



Example inputFor the NEWYORK network element, delete the bidirectional STS-3c passthrough cross-connection between the OC-3 interfaces in slots 11 anDLT-CRS-STS3C:NEWYORK:OC3-11,OC3-12:CTAG12::2WAY;

CCT Description







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.


Input syntaxDLT-CRS-VT1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];


Field Purpose






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



ete . For to an 1-3.


For an OC-3 Express network element, use the DFLT-# smart AID to delone of three sets of 28 DS1s cross-connected to VT1.5s within an STS-1each possible DFLT-# value, a specific set of 28 ports is cross-connectedSTS-1. For example, the DFLT-2 set of DS1 ports can be mapped to STSThis 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-9DFLT-# smart AID values

AID type Command-specific parameters

Parameter values

Express Express CX

VT1.5 facility AID

DS1-slot#-port# slot# = 4 to 10port# = 1 to 12

slot# = 1port# = 1 to 12


OC3-slot#-sts#-vtg#-vt#OC3-slot#-sts#-ALL

slot# = 3 to 12sts# = 1 to 3vtg# = 1 to 7vt# = 1 to 4


EC1-slot#-sts#-vtg#-vt#EC1-slot#-sts#-ALL

slot# = 3, 5 , 7, or 9sts# = 1 vtg# = 1 to 7vt# = 1 to 4

slot# = 1sts# = 1 vtg# = 1 to 7vt# = 1 to 4

EIM-slot#-bridge#-vp#-t1# slot# = 7 to 10bridge#= 1 to 2vp# = 1 to 8t1# = 1 to 8

slot# = 1 or 2bridge#= 1 to 2vp# = 1 to 8t1# = 1 to 8

SMART AID

DS1-DFLT-grp# grp# = 1 to 3 Not applicable

DFLT-# Ports Equivalent facilities

1 1-28 DS1-4-1 — DS1-6-4

2 29-56 DS1-6-5 — DS1-8-8

3 57-84 DS1-8-9 — DS1-10-12



ptical

the ports es in



Example inputFor the NEWYORK network element, delete a VT1.5 bidirectional cross-connect between the DS1 mapper in slot 4 and the path protected ointerfaces 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 onslot 4 DS1 mapper, DS1 ports 1 to 12 on the slot 5 DS1 mapper and DS11 to 4 on the slot 6 DS1 mapper), from the path protected optical interfacslots 9 and 11: DLT-CRS-VT1:WASHINGTON:OC3-9-3-ALL,DS1-DFLT-1:CTAG89::2WAYPR:SWMATE=OC3-11-3-ALL;

CCT Description








t type
ED-CRS-STS1
The Edit Cross-connect STS-1 command is used to edit the cross-connec(CCT) of an existing STS-1 cross-connect.


Input syntaxED-CRS-STS1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];



Field Purpose






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


Parameter values

Express Express CX

STS-1 Facility AID





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.



Table 8-13STS-1 CCT descriptions

CCT Description CCTs before and after CCT edit

2WAY Converts two existing 1WAY cross-connects to a 2WAY cross-connect.

*Converts an existing 2WAYPR cross-connect to a 2WAY cross-connect.

1 WAY Converts an existing 2WAY cross-connect to two 1WAY cross-connects.


—continued—

Before edit: two 1WAY connections

DS3EC-1OC-3

DS3EC-1OC-3

FromAID

ToAID

After edit: one 2WAY connection

DS3EC-1OC-3

DS3EC-1OC-3

FromAID

ToAID

Before edit: one 2WAYPR connection After edit: one 2WAYconnection

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

After edit: two 1WAY connections

DS3EC-1OC-3

DS3EC-1OC-3

FromAID

ToAID

Before edit: one 2WAY connections

DS3EC-1OC-3

DS3EC-1OC-3

FromAID

ToAID


OC-3

DS3EC-1OC-3

FromAID

ToAID

Before edit: one 1WAYPR connection

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

SWMATE

OC-3



1WAYPR *Converts an existing 1WAY cross-connect to a 1WAYPR cross-connect.

*Converts an existing 2WAYPR cross-connect to a 1WAYPR and two 1way cross-connects.


*Converts an existing 1WAYPR cross-connect to a 2WAYPR cross-connect if 1WAY cross-connects already exist.

*For OC-3 Express, this CCT is valid only for NEs equipped with an SPe shelf processor.


OC-3

DS3EC-1OC-3

FromAID

ToAID

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

SWMATE

OC-3

Before edit: one 1WAY connection After edit: one 1WAYPR connections


FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

After edit:one 1WAYPR and two 1WAYconnections


FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3


FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3



e ID.

s.

d

D) TE

AY the

n

the

ToAID = ALLThe 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, thFromAID becomes the SWMATE, and the SWMATE becomes the FromAThe 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 execute

• The SWMATE AID identifies the OC-3 facility which is currently the FromAID. This facility will be the new SWMATE AID after the commanexecutes.

Note: This command affects (reverses the FromAID and SWMATE AIfor all path-protected connections with the same FromAID and SWMAAID.

See Example 3 on page 8-13 for more information on the ALL ToAID parameter value.

Example 1TaskFor the NEWYORK network element, edit (convert) an existing STS-1 1Wcross-connect to a 2WAY cross-connect. The existing cross-connect hasfollowing characteristics:

• FromAID = slot 7 DS3 mapper

• ToAID = slot 11 OC-3 interface, STS1 = #3

SolutionThe ED-CRS-STS1 command requires two 1WAY cross-connects to be iplace 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 withfollowing command:

ED-CRS-STS1:NEWYORK:OC3-11-3,DS3-7:CTAG12::2WAY;



s the

2 on

ID

ions

ith:

lows:

Example 2TaskFor the SEATTLE network element, edit an existing STS-1 2WAY cross-connect to a 2WAYPR cross-connect. The existing cross-connect hafollowing 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-#the slot 12 optical interface.

SolutionThe 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 3TaskFor the SEATTLE network element, reverse the FromAid and SWMATE Afor 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

SolutionBefore issuing the command to reverse the FromAid and SWMATE, the RTRV-CRS-STS1 can be used to retrieve all provisioned STS-1 connectfor the SEATTLE network element:

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

For this network element at this point in time, the TL1 system responds w“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 folRTRV-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::”



ect
ED-CRS-STS3C
The Edit Cross-connect STS-3c command is used to edit the cross-conntype (CCT) of an existing STS-3c cross-connect.


Input syntaxED-CRS-STS3C:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];



Field Purpose






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


Parameter values Purpose

STS-3c Facility AID

OC3-slot# slot# = 3 to 12 Identify one STS-3c facility

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.



Table 8-16STS-3c CCT descriptions






—continued—


OC-3

OC-3

FromAID

ToAID


FromAID

ToAID

OC-3

OC-3


FromAID

ToAID

SWMATE

OC-3 OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

OC-3OC-3


FromAID

ToAID


FromAID

ToAID

OC-3 OC-3

OC-3OC-3


FromAID

ToAID


FromAID

ToAID

SWMATE

OC-3

OC-3

SWMATE

OC-3

OC-3

OC-3 OC-3









OC-3

FromAID

ToAID

FromAID

ToAID

SWMATE

OC-3 OC-3

SWMATE

OC-3


OC-3 OC-3


FromAID

ToAID

SWMATE

OC-3 OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3


OC-3OC-3


FromAID

ToAID

SWMATE

OC-3 OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

OC-3 OC-3


FromAID

ToAID

SWMATE

OC-3

OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3OC-3

OC-3



cts es

s.

d

D) TE

ct

in

the

ToAID = ALLThe ED-CRS-STS1 command exchanges the FromAID and SWMATE facilities for existing path protected (1WAYPR and 2WAYPR) cross-connewhen ALL is entered for the ToAID parameter. That is, the FromAID becomthe 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




Example 1TaskFor the NEWYORK network element, edit (convert) an existing STS-3c 1WAY cross-connect to a 2WAY cross-connect. The existing cross-connehas the following characteristics:

• FromAID = slot 7 OC-3 interface

• ToAID = slot 11 OC-3 interface

SolutionThe ED-CRS-STS3C command requires two 1WAY cross-connects to beplace 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;

Now that the complementary 1WAY cross-connect exists, the two cross-connects can be converted into an single 2WAY cross-connect withfollowing command:ED-CRS-STS3C:NEWYORK:OC3-11,OC3-7:CTAG12::2WAY;



s the

12

ID

tions

ith:

llows:

Example 2TaskFor the SEATTLE network element, edit an existing STS-3c 2WAY cross-connect to a 2WAYPR cross-connect. The existing cross-connect hafollowing 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 slotoptical interface.

SolutionThe following command will edit the existing cross-connect as required: ED-CRS-STS3C:SEATTLE:OC3-11,OC3-5:CTAG12::2WAYPR:SWMATE=OC3-12;

Example 3TaskFor the SEATTLE network element, reverse the FromAid and SWMATE Afor all path-protected STS-3c cross-connects where

• FromAID = slot 11 OC-3 interface

• SWMATE AID = slot 12 OC-3 interface

SolutionBefore issuing the command to reverse the FromAid and SWMATE, the RTRV-CRS-STS1 can be used to retrieve all provisioned STS-3c connecfor the SEATTLE network element: RTRV-CRS-STS3C:SEATTLE:ALL:CTAG34;

For this network element at this point in time, the TL1 system responds w“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 foRTRV-CRS-STS3C:SEATTLE:ALL:CTAG34;

The TL1 system responds with: “OC3-12,OC3-5:1WAYPR,FFP:SWMATE=OC3-11:”“OC3-11,OC3-5:1WAY,FFP::”



t type
ED-CRS-VT1
The Edit Cross-connect VT1.5 command is used to edit the cross-connec(CCT) of an existing VT1.5 cross-connect.


Input syntaxED-CRS-VT1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];


Field Purpose






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



the h

ng


For an OC-3 Express network element, use the DFLT-# smart AID to editCCT for one of three sets of 28 DS1s to VT1.5s within an STS-1. For eacpossible DFLT-# value, a specific set of 28 ports is cross-connected to anSTS-1. Table 8-19 shows the DFLT-# smart AID value and the correspondiports.


Parameter values

Express Express CX

VT1.5 facility AID








slot# = 3, 5, 7, or 9sts# = 1 vtg# = 1 to 7vt# = 1 to 4




SMART AID


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.



1 1-28 DS1-4-1 — DS1-6-4

2 29-56 DS1-6-5 — DS1-8-8

3 57-84 DS1-8-9 — DS1-10-12



Table 8-20VT1.5 CCT descriptions






—continued—


DS1EC-1OC-3

DS1EC-1OC-3

FromAID

ToAID


DS1EC-1OC-3

DS1EC-1OC-3

FromAID

ToAID


FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3


DS1EC-1OC-3

DS1EC-1OC-3

FromAID

ToAID


DS1EC-1OC-3

DS1EC-1OC-3

FromAID

ToAID


OC-3

DS1EC-1OC-3

FromAID

ToAID


FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

SWMATE

OC-3









OC-3

DS1EC-1OC-3

FromAID

ToAID

FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

SWMATE

OC-3



FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3



FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3


FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3



e ID.

s.

d

D) TE

Y the

lace ct

the

ToAID = ALLThe 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, thFromAID becomes the SWMATE, and the SWMATE becomes the FromAThe ED-CRS-VT1 syntax (when the ToAID = ALL) is ED-CRS-VT1:[TID]:FromAID,ALL:CTAG:::SWMATE=<AID>;

where




See Example 3 on page 8-24 for more information on the ALL ToAID parameter value.

Example 1TaskFor the NEWYORK network element, edit (convert) an existing VT1.5 1WAcross-connect to a 2WAY cross-connect. The existing cross-connect hasfollowing characteristics:

• FromAID = slot 7 DS1 mapper, port 2

• ToAID = slot 11 OC-3 interface, STS1 = #3, VTG = 4, VT =1

SolutionThe ED-CRS-VT1 command requires two 1WAY cross-connects to be in pbefore a 1WAY to 2WAY edit. Consequently, a second 1WAY cross-connemust 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;

Now that the complementary 1WAY cross-connect exists, the two cross-connects can be converted into an single 2WAY cross-connect withfollowing command:ED-CRS-VT1:NEWYORK:OC3-11-3-4-1,DS1-7-2:CTAG12::2WAY;



ect g

slot

ID

e

Example 2TaskFor the SEATTLE network element, edit an existing VT1 2WAY cross-connto a 2WAYPR cross-connect. The existing cross-connect has the followincharacteristics:

• 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 12 optical interface.

SolutionThe following command will edit the existing cross-connect as required:

ED-CRS-VT1:SEATTLE:OC3-11-2-4-3,DS1-5-12:CTAG12::2WAYPR:SWMATE=OC3-12-2-4-3;

Example 3TaskFor the SEATTLE network element, reverse the FromAid and SWMATE Afor 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

SolutionBefore issuing the command to reverse the FromAid and SWMATE, the RTRV-CRS-VT1 command can retrieve all provisioned connections for thSEATTLE network element:

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

The TL1 system responds with:

“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 theexisting cross-connect:

ED-CRS-V1:SEATTLE:OC3-12-1-2-3,ALL:CTAG:::SWMATE=OC3-11-1-2-3;



es) as
If cross-connects are retrieved (after the ED-CRS-STS1 command executfollows:
RTRV-CRS-VT1:SEATTLE:ALL:CTAG34;

The TL1 system responds with:

“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::”



ection
ENT-CRS-STS1
The Enter Cross-connect STS-1 command is used to add an STS-1 connbetween two STS-1 facilities.


Input syntaxENT-CRS-STS1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];



Field Purpose





CCT cross-connection type

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


Parameter values

Express Express CX

STS-1 Facility AID







ugh

in



Example inputFor the NEWYORK network element, add a bidirectional STS-1 passthrocross-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 connectionbetween the DS3 facility in slot 9 and the path protected OC-3 interfacesslots 11 and 12: ENT-CRS-STS1:SEATTLE:OC3-11-1,DS3-9:CTAG12::2WAYPR:SWMATE=OC3-12-1;

CCT Description








ENT-CRS-STS3C The Enter Cross-connect STS-3c command is used to add an STS-3c connection between two OC-3 interface facilities.


Input syntaxENT-CRS-STS3C:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];



Field Purpose






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


OC-3C Facility AID

OC3-slot# Identify the OC-3 whereslot# = 3 to 12



ugh



Example inputFor the NEWYORK network element, add a bidirectional STS-3c passthrocross-connection between the OC-3 interfaces in slots 11 and 12: ENT-CRS-STS3C:NEWYORK:OC3-11,OC3-12:CTAG12::2WAY;

CCT Description







T1.5
ENT-CRS-VT1
The Enter Cross-connect VT1.5 command is used to cross-connect one Vfacility to another.


Input syntaxENT-CRS-VT1:[TID]:FromAID,ToAID:CTAG::[CCT]:[SWMATE=<AID>];


Field Purpose






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



or to an 1-3.


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. Feach possible DFLT-# value, a specific set of 28 ports is cross-connectedSTS-1. For example, the DFLT-2 set of DS1 ports can be mapped to STSThis 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.


Parameter values

Express Express CX

VT1.5 facility AID








slot# = 3, 5, 7, or 9sts# = 1 vtg# = 1 to 7vt# = 1 to 4




SMART AID




1 1-28 DS1-4-1 — DS1-6-4

2 29-56 DS1-6-5 — DS1-8-8

3 57-84 DS1-8-9 — DS1-10-12



ed

the orts 1 s in



Example inputFor the NEWYORK network element, add a VT1.5 bidirectional cross-connect between the DS1 mapper in slot four and the path protectoptical 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 slot 4 DS1 mapper, DS1 ports 1 to 12on the slot 5 DS1 mapper and DS1 pto 4 on the slot 6 DS1 mapper), from the path protected optical interfaceslots 9 and 11: ENT-CRS-VT1:WASHINGTON:OC3-9-3-ALL,DS1-DFLT-1:CTAG89::2WAYPR:SWMATE=OC3-11-3-ALL;

CCT Description








RTRV-CRS-STS1 The Retrieve Cross-connect STS1 command is used to retrieve STS-1 cross-connects and activity.


Input syntaxRTRV-CRS-STS1:[TID]:[fromAID,toAID]/[AID]:CTAG::[CCT]:[DISPLAY=Domain];


Field Purpose





CCT Cross-connect type is accepted only when Display=PROV. The CCT is ignored if Display=ACT.

Display Specifies whether provisioned or active cross-connects are retrieved






Parameter values Description

Express Express CX

STS-1 Facility AID

ALL Retrieve all provisioned STS-1 cross-connects to all STS-1 facilities. This is valid only when DISPLAY=PROV

ALL Retrieves the active path when DISPLAY=ACTOC3-slot#-sts#

OC3-slot#-ALLOC3-ALL

slot# = 3 to 12sts# = 1 to 3


DS3-slot#DS3-ALL

slot# = 3, 5, 7, or 9 slot# = 1

EC1-slot#EC1-ALL

slot# = 3, 5, 7, or 9 slot# = 1

Note: If both the FromAID and the ToAID are specified, only the AIDs in the shaded cells are valid.

CCT Description


2WAY Bidirectional connection






ce ,

ent


Table 8-34Display mode descriptions

Example input For the WASHINGTON network element, retrieve the active OC-3 interfafor all provisioned STS-1 cross-connects to the OC-3 interface in slot 11regardless 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 elemare 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;

Display Description

PROV Default. Retrieves provisioned cross-connects

ACT Retrieves the path activity of provisioned cross-connects



Response block syntaxFromAID,ToAID:cct[,FFP]:[SWMATE=<aid>]:sst



FFP UNI

BIDIR

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



c
RTRV-CRS-STS3C
The Retrieve Cross-connect STS3C command is used to retrieve STS-3cross-connects and activity.


Input syntaxRTRV-CRS-STS3C:[TID]:[fromAID,toAID]/[AID]:CTAG::[CCT]:[DISPLAY=Domain];


Field Purpose














Parameter values Description

OC-3 Facility AID

ALL Retrieve all provisioned STS-3c cross-connects to all OC-3 facilities. This is valid only when DISPLAY=PROV

OC3-slot# OC3-ALL ALL

slot# = 3 to 12 Retrieve the active path when DISPLAY=ACT

CCT Description





Display Description


ACT Retrieves the path activity of provisioned cross-connects



ce 11,

Example input For the WASHINGTON network element, retrieve the active OC-3 interfafor any provisioned STS-3c cross-connects to the OC-3 interface in slot 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;




FFP UNI

BIDIR

unidirectional

bidirectional


SST ACT

IDLE

PSI

FLT

MEA

TSTF

UEQ

ROLL








Roll



RTRV-CRS-VT1 The Retrieve Cross-connect VT1.5 command is used to retrieve VT1.5 cross-connects.


Input syntaxRTRV-CRS-VT1:[TID]:[fromAID,toAID]/[AID]:CTAG::[CCT]:[DISPLAY=Domain];


Field Purpose









ieve S-1. cted to

ng


For an OC-3 Express network element, use the DFLT-# smart AID to retrthe cross-connects of one of three sets of 28 DS1s to VT1.5s within an STFor each possible DFLT-# value, a specific set of 28 ports is cross-conneto an STS-1. For example, the DFLT-2 set of DS1 ports can be mapped 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 correspondiports.


Parameter values Purpose

Express Express CX

VT1.5 Facility AID

ALL Retrieve all provisioned VT1.5 cross-connects to all VT1.5 facilities. This is valid only when DISPLAY=PROV

DS1-slot#-port#DS1-slot#-ALLDS1-ALL

slot# = 4 to 10port# = 1 to 12



Retrieves the active path when DISPLAY=ACT


EC1-slot#-sts#-vtg#-vt#EC1-slot#-sts#-ALLEC1-ALL

slot# = 3, 5, 7, or 9sts# = 1 to 3vtg# = 1 to 7vt# = 1 to 4


OC3-slot#-sts#-vtg#-vt#OC3-slot#-sts#-ALLOC3-ALL



EIM-slot#-bridge#-vp#-t1#EIM-slot#-bridge#-vp#-ALLEIM-slot#-bridge#-ALLEIM-slot#-ALLEIM-ALL

slot# = 7 to 10bridge#= 1 to 2vp# = 1 to 8t1# = 1 to 8








DFLT-# Ports

1 1-28

2 29-56

3 57-84

CCT Description



1WAYPR Unidirectional path protected ring connection

2WAYPR Bidirectional path protected ring connection

2WAYBR Bidirectional path protected bridge ring connection

Display Description


ACT Retrieves the path activity of provisioned cross-connects.



less

ent

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, regardof 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 elemare 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;




FFP UNI

BIDIR

unidirectional

bidirectional


SST ACT

IDLE

PSI

FLT

MEA

TSTF

UEQ

ROLL








Roll



Figure 8-1Valid STS-1 AID combinations by CCT

CCT = 1WAYPRCCT = 1WAY

CCT = 2WAY CCT = 2WAYPR

CCT = 2WAYBR

FromAID

ToAID

DS3EC-1OC-3

DS3EC-1OC-3

DS3EC-1OC-3

DS3EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS3EC-1OC-3

FromAID SWMATE

ToAID

OC-3 OC-3

DS3EC-1OC-3

DS3EC-1OC-3

OC-3 OC-3

FromAID SWMATE

ToAID

FromAID

ToAID

Typical application is unidirectional broadcast. Valid in linear and UPSR systems.

Typical application is reception of unidirectional broadcast. Valid only in UPSRs.

Typical applications are bidirectional connection in a linear system or a bidirectional passthrough in a UPSR. Valid in linear and UPSR systems.

Standard application is a bidirectional connection in a UPSR. Valid only in UPSR systems.

Standard application is matched-node connection between two UPSRs. Valid only in UPSR systems.

STS-1

STS-1

STS-1 STS-1STS-1

STS-1

STS-1



Figure 8-2Valid STS-3c AID combinations by CCT

CCT = 1WAYPR

CCT = 1WAY

CCT = 2WAY

CCT = 2WAYPR

FromAID

ToAID

OC-3

OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

FromAID SWMATE

ToAID

OC-3 OC-3

FromAID

ToAID





STS-3c

OC-3

OC-3

STS-3c

STS-3c

STS-3c

STS-3c

STS-3c

OC-3



Figure 8-3Valid VT1.5 AID combinations by CCT

CCT = 1WAYPRCCT = 1WAY

CCT = 2WAY CCT = 2WAYPR

CCT = 2WAYBR

FromAID

ToAID

DS1EC-1OC-3

DS1EC-1OC-3

DS1EC-1OC-3

DS1EC-1OC-3

FromAID

ToAID

SWMATE

OC-3 OC-3

DS1EC-1OC-3

FromAID SWMATE

ToAID

OC-3 OC-3

DS1EC-1OC-3

DS1EC-1OC-3

OC-3 OC-3

FromAID SWMATE

ToAID

FromAID

ToAID





Standard application is matched-node connection between two UPSRs. Valid only in UPSR systems.

VT1.5

VT1.5

VT1.5

VT1.5

VT1.5

VT1.5

VT1.5 VT1.5VT1.5

VT1.5


9-1

ffic

iables,

ork ssor

Inservice traffic rollover command descriptions 9-

This chapter is a summary of the TL1 commands related to inservice trarollover (ISTR). The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, varand response.

Most commands in this chapter are supported on the OC-3 Express netwelement, the OC-3 Express CX network element, and the network proce(NP).

The following table lists all the commands in this chapter

Command Page

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

—continued—


9-2 Inservice traffic rollover command descriptions

RTRV-ROLL-VT1 9-32

RTRV-ROLL-STS1 9-34

RTRV-ROLL-STS3C 9-36

Command Page


Inservice traffic rollover command descriptions 9-3

hich

ast ver a

ect

with

ENT-ROLL-VT1 The Enter Rollover VT1 command is used to define a new connection to wto rollover an existing termination point in a VT1.5 path.

If you try to execute an inservice rollover command on a 1WAYPR mutliccross-connect, you get the message “Status, data not consistent”. To rollo1WAYPR multicast cross-connect, you must:

• convert each 1WAYPR multicast cross-connect to a 1WAY cross-connwith the ED-CRS command

• rollover the endpoint of each 1WAY cross-connect

• convert each 1WAY cross-connect back to a 1WAYPR cross-connect the ED-CRS command


Input syntaxENT-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,SWMATE=AID];


Field Purpose

TID Target identifier, the network element to which the command is directed

fromAID One of the original cross-connection endpoints

toAID Second of the original cross-connection endpoints

CTAG Correlation tag, a user created alphanumeric identifier to correlate the command and response messages

CCT Connection type to be rolled

RFROM The fromAID or toAID to be rolled (see Note)

RTO AID RFROM is to be rolled to (see Note)

VALID Command execution will be denied if the conditions on the node are inappropriate

SWMATE Used to bridge the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

Note: When rolling a switch mate, RTO=RFROM.



Table 9-2AID description


VT1.5facility AID


DS1-DFLT-Grp Grp = 1 to 3

OC3-slot#-sts#-vtg#-vt# slot# = 3 to 12sts# = 1 to 3vtg# = 1 to 7vt# = 1 to 4

OC3-slot#-sts#-ALL slot# = 3 to 12

sts# = 1 to 3

EC1-slot#-sts#-vtg#-vt# slot# = 3, 5, 7, 9sts# = 1 vtg# = 1 to 7vt# = 1 to 4

EC1-slot#-sts#-ALL slot# = 3, 5, 7, 9sts# = 1

Table 9-3Parameter description

Parameter Possible Values Description

CCT 1WAY Unidirectional connection


1WAYPR 1WAY path ring, fromAID must be OC3


2WAYBR 2WAY bridge ring, fromAID must be OC3

VALID Y Bridge will be denied if conditions on the node are inappropriate.

N (default) Bridge will be performed regardless of the condition of the switched-to path.



uit ck.

Example inputRollover a VT1.5 working connection and its switch mate on the OC3 circpack in a 2WAYPR circuit between a DS1 service and the OC3 circuit pa

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;

Switch to the bridge connection: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;



to

ast ver a

ect

with

ENT-ROLL-STS1 The Enter Rollover STS-1 command is used to define a new connection which to rollover an existing termination point in an STS-1 path.






Input syntaxENT-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,SWMATE=AID];


Field Purpose













in a
Example inputRollover an STS1 connection and its switch mate on the OC3 circuit pack2WAYPR 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;

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

Remove the original working connection:CMMT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:C::2WAYPR:RFROM=OC3-11-2,RTO=OC3-11-3;



Parameter values

STS-1 facility AID OC3-slot#-sts# slot#=3-12

sts#=1-3

DS3-slot# slot#=3, 5, 7, 9

EC1-slot#-sts# slot#=3, 5, 7, 9sts# = 1












Bridge the original switch mate OC-3 connection: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;

Switch to the bridge connection: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;



to

ast ver a

ect

with

ENT-ROLL-STS3C The Enter Rollover STS3C command is used to define a new connectionwhich to rollover an existing termination point in a STS3C path.






Input syntaxENT-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,SWMATE=AID];


Field Purpose













k in
Example inputRollover an STS3C connection and its switch mate on the OC3 circuit paca 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;

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

Remove the original working connection:CMMT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:C::2WAYPR:RFROM=OC3-11,RTO=OC3-9;

Bridge the original switch mate OC-3 connection:ENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:D::2WAYPR:RFROM=OC3-11,RTO=OC3-9,VALID=Y,SWMATE=OC3-8;



STS3Cfacility AID

OC3-slot#-sts# slot# = 3-12sts# = 1

OC3-slot# slot# = 3 to 12












Switch to the bridge connection: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 existingconnection to another connection previously established by an ENT-ROLL-VT1 command.


Input syntaxED-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,EDSWMATE=Domain]:SST;


Field Purpose









EDSWMATE Used to switch the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR

SST Secondary state




R
Example inputRollover a VT1.5 working connection on the OC3 circuit pack in a 2WAYPcircuit 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;



VT1.5facility AID

DS1-slot#-port#DS1-DFLT-Grp

slot# = 4 to 10port# = 1 to 12Grp = 1 to 3




slot# = 3, 5, 7, 9sts# = 1 vtg# = 1 to 7vt# = 1 to 4

Table 9-12Keyword description

Keyword Possible Values Description






VALID Y Switch will be denied if conditions on the node are inappropriate.

N (default) Switch will be performed regardless of the condition of the switched-to path.

SST SWITCHED (default) when switching from bridged to switched, SST=SWITCHED

BRIDGED when backing -out from switched to bridged, SST=BRIDGED



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:SWITCHED;

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;



g
ED-ROLL-STS1
The Edit Rollover STS1 command is used to switch traffic from an existinconnection to another connection previously established by an ENT-ROLL-STS1 command.


Input syntaxED-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,EDSWMATE=Domain]:SST;


Field Purpose









EDSWMATE Used to switch the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

SST Secondary state




PR
Example inputRollover an STS1 working connection on the OC3 circuit pack in a 2WAYcircuit 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;





STS1facility AID

DS3-slot# slot# = 3, 5, 7, 9


EC1-slot#-sts# slot# = 3, 5, 7, 9sts# = 1














ing
ED-ROLL-STS3C
The Edit Rollover STS3C command is used to switch traffic from an existconnection to another connection previously established by an ENT-ROLL-STS3C command.


Input syntaxED-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,EDSWMATE=Domain]:SST;


Field Purpose









EDSWMATE Used to switch the switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

SST Secondary state




STS3Cfacility AID

OC3-slot#-sts#OC3-slot#

slot# = 3 to 12sts# = 1



PR
Example inputRollover an STS3C working connection on the OC3 circuit pack in a 2WAYcircuit between an OC3 service and the OC3 circuit pack.
Bridge the original OC-3 working connectionENT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:D::2WAYPR:RFROM=OC3-11,RTO=OC3-9,VALID=Y;

Switch to the bridge connectionED-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:B::2WAYPR:RFROM=OC3-11,RTO=OC3-9,VALID=Y:SWITCHED;

Remove the original working connectionCMMT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:C::2WAYPR:RFROM=OC3-11,RTO=OC3-9;














ath.
CMMT-ROLL-VT1
The Commit Rollover VT1 command is used to delete the original VT1.5 p


Input syntaxCMMT-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,CMMTSWMATE=Domain];


Field Purpose








CMMTSWMATE Deletes the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit




R
Example inputRollover a VT1.5 working connection on the OC3 circuit pack in a 2WAYPcircuit between a DS1 service and the OC3 circuit pack.Bridge the original 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:SWITCHED;

Remove the original 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;



VT1.5facility AID
















path.
CMMT-ROLL-STS1
The Commit Rollover STS1 command is used to delete the original STS1


Input syntaxCMMT-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,CMMTSWMATE=Domain];


Field Purpose












STS1facility AID

DS3-slot# slot# = 3, 5, 7, 9





PR
Example inputRollover an STS1 working connection on the OC3 circuit pack in a 2WAYcircuit between a DS3 service and the OC3 circuit pack.
Bridge the original OC-3 working connection:ENT-ROLL-STS1:OTTAWA:OC3-11-2,DS3-3:A::2WAYPR:RFROM=OC3-11-2,RTO=OC3-11-3,VALID=Y;












-3c
CMMT-ROLL-STS3C
The Commit Rollover STS3C command is used to delete the original STSpath.


Input syntaxCMMT-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,CMMTSWMATE=Domain];


Field Purpose












STS3Cfacility AID


slot# = 3 to 12sts# = 1



PR
Example inputRollover an STS3C working connection on the OC3 circuit pack in a 2WAYcircuit 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:ED-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:B::2WAYPR:RFROM=OC3-11,RTO=OC3-9,VALID=Y:SWITCHED;

Remove the original working connection:CMMT-ROLL-STS3C:OTTAWA:OC3-11,OC3-10:C::2WAYPR:RFROM=OC3-11,RTO=OC3-9;










usly
DLT-ROLL-VT1
The Delete Rollover VT1 command is used to delete a connection previoestablished by the ENT-ROLL-VT1 command. The Delete Rollover VT1 command will return the connection to its original idle state.


Input syntaxDLT-ROLL-VT1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,DLTSWMATE=Domain];


Field Purpose









DLTSWMATE If included in the command, the switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit






VT1.5facility AID














VALID Y Command execution will be denied if conditions on the node are inappropriate.

N (default) Command is performed regardless of the condition of the switched-to path.

DLTSWMATE Y The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR

N (default) The switch mate is not affected.



Example inputReverse 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: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;

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;



usly 1

DLT-ROLL-STS1 The Delete Rollover STS1 command is used to delete a connection previoestablished by the ENT-ROLL-STS1 command. The Delete Rollover STScommand will return the connection to its original idle state.


Input syntaxDLT-ROLL-STS1:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,DLTSWMATE=Domain];


Field Purpose






RFROM The fromAID or toAID to be rolled

RTO AID RFROM is to be rolled to


DLTSWMATE The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit



STS1facility AID

DS3-slot# slot# = 3, 5, 7, 9





it
Example inputRollover an STS1 connection on the OC3 circuit pack in a 2WAYPR circubetween 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;








VALID Y Command execution will be denied if conditions on the node are inappropriate

N (default) Command execution is performed regardless of the conditions

DLTSWMATE Y The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

N (default) The switch mate is not affected.



ate.

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 st


Input syntaxDLT-ROLL-STS3C:[TID]:fromAID,toAID:CTAG::CCT:RFROM=AID,RTO=AID[,VALID=Domain][,DLTSWMATE=Domain];


Field Purpose



toAID The second of the original cross-connection endpoints






DLTSWMATE The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit



STS3Cfacility AID


slot# = 3 to 12sts# = 1



uit
Example inputRollover an STS-3c connection on the OC-3 circuit pack in a 2WAYPR circbetween 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;








VALID Y Command execution will be denied if conditions on the node are inappropriate

N (default) Command execution is performed regardless of the conditions

DLTSWMATE Y The switch mate reverts to the original switch mate in a 1WAYPR, 2WAYPR, or 2WAYBR circuit

N (default) The Switch Mate is not affected.



g

ast ver a

ect

with

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 beinrolled over.






Input syntaxRTRV-ROLL-VT1:[TID]:[fromAID],[toAID]:CTAG::[CCT]:[RFROM=AID][,RTO=AID];


Field Purpose










Response block syntaxThe 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”



VT1.5facility AID

DS1-slot#-port#DS1-slot#-ALLDS1-ALLDS1-DFLT-Grp


OC3-slot#-sts#-vtg#-vt#OC3-slot#-sts#-ALLOC3-slot#-ALLOC3-ALL


EC1-slot#-sts#-vtg#-vt#EC1-slot#-sts#-ALLEC1-ALL


ALL all VT1.5 facilities



CCT Null (default) Connections of any cross connect type



1WAYPR 1WAY path ring, FromAID must be OC3

2WAYPR 2WAY path ring, FromAID must be OC3

2WAYBR 2WAY bridge ring, FromAID must be OC3



rolled

ast ver a

ect

with

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






Input syntaxRTRV-ROLL-STS1:[TID]:[fromAID],[toAID]:CTAG::[CCT]:[RFROM=AID][,RTO=AID];


Field Purpose










Response block syntaxThe 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”



STS1facility AID

DS3-slot#DS3-ALL

slot# = 3, 5, 7, 9

OC3-slot#-sts#OC3-slot#-ALLOC3-ALL

slot# = 3 to 12sts# = 1 to 3

EC1-slot#-sts#EC1-ALL

slot# = 3, 5, 7, 9sts# = 1

ALL all STS-1 facilities











ng

ast ver a

ect

with

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 beirolled over.






Input syntaxRTRV-ROLL-STS3C:[TID]:[fromAID],[toAID]:CTAG::[CCT]:[RFROM=AID][,RTO=AID];


Field Purpose










:
Response block syntaxThe display response to the command RTRV-ROLL-STS3C is as followsUnprotected 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”



STS3Cfacility AID

OC3-slot#-sts#OC3-slot#OC3-ALL

slot# = 3 to 12sts# = 1

ALL all STS-3c facilities










10-1

e e the owing

Facility test signal generation and loopback detailed command descriptions 10-

This chapter is an alphabetical summary of all the TL1 commands for themanagement of facility internal test equipment and facility loopbacks. Thcommand descriptions in this chapter identify each command, and describcommand purpose, syntax, parameters, variables, and response. The folltable lists all of the commands in this chapter:

Command Page

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-2 Facility test signal generation and loopback detailed command descriptions

.

ility

t the

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. Toretrieve error count on the monitored signal, use the RTRV-T1 commandInternal 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 facmust be put in an out-of-service state (RMV-T1 command).

In order to clear the error count on the internal signal monitor, disconnecinternal test equipment by using the DISC-TSTSIG -T1 command.


Input syntax CONN-TSTSIG-T1:[TID]:AID:CTAG::[SRC],[DIRN],[TSIG],[ERR];



Field Purpose


AID Access identifier. The facility to act on.


srcdirntsigerr

See the Parameter descriptions on page 10-3 for details


DS1 AID DS1-slot#-port# Identify the DS1 facility where Express:slot#=4 to 10, port#=1 to 12



Facility test signal generation and loopback detailed command descriptions 10-3

r to rn of


Example inputAt the SEATTLE network element, attach an internal DS1 signal generatoDS1 facility 7 on the slot 4 DS1 mapper. Send the test signal with a pattex20 + 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;


Description

src SRC

MON

Connect the internal signal generator to the facility (default)

Connect the internal signal monitor to the facility

dirn IN

OUT

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.

tsig

PR2017

PR2003

PR1514

PR2318

FIX

<number>

The test signal to be sent for or monitored is:

Default: a pseudo-random pattern: x20 + 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

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



st

rors the the

ust

CONN-TSTSIG-T3 The Connect Test Signal T3 command instructs DS3 facility to send a tesignal towards the optics or monitor a signal from the optics. The signal generator and signal monitor capability on a facility is often referred to asinternal 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 erin the monitored signal using the RTRV-T3 command. If the ERR field in response syntax equals YES, there are errors in the monitored signal. If 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 mbe put in an out-of-service state (RMV-T3 command).


Input syntax CONN-TSTSIG-T3:[TID]:AID:CTAG::[SRC],[TSIG];



Field Purpose

TID Target identifier,

AID Access identifier, the facility to be acted on


srctsig

See Parameter description table for details.


DS3 AID DS3-slot# Identify the DS3 facilitywhere slot# = 3, 5, 7, or 9



r to

d:


Example inputAt the SEATTLE network element, attach an internal DS3 signal generatothe 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 erroreCONN-TSTSIG-T3:SEATTLE:DS3-5:CTAG12::SRC,PR15FRER;

Monitor the returned pattern: CONN-TSTSIG-T3:SEATTLE:DS3-5:CTAG12::MON,PR15FRER;


Description

src SRC

MON

Send a signal with the specified pattern towards the optics (default)

Monitor a signal with the specified pattern from the optics

tsig

PR15FRER

PR15FRNER

PR15UFRER

PR15UFRNER

ALL1s

IDLE

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 - 1 frame format = framed not errored

a pseudo-random pattern: 215 - 1 frame format = unframed errored

a pseudo-random pattern: 215 - 1 (default)frame format = unframed not errored

All 1s pattern

DS3 framed idle (repeating 1100 pattern)



to cted ted.

:

DISC-TSTSIG-T1The Disconnect Test Signal T1 command instructs the network element disconnect the DS1 test signal from the facility or stop monitoring a conneDS1 signal. All internal test equipment connected to a facility is disconnec


Input syntaxDISC-TSTSIG-T1:[TID]:AID:CTAG;



Example inputRemove all internal test equipment on DS1 facility 7 on the DS1 in slot 4DISC-TSTSIG-T1:SEATTLE:DS1-4-7:CTAG12;

Field Purpose





DS1 AID DS1-slot#-port# Identify the DS1 facility whereExpress:slot#=4 to 10, port#=1 to 12




to

om

DISC-TSTSIG-T3The Disconnect Test Signal T3 command instructs the network element 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 DS3facility. 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.


Input syntaxDISC-TSTSIG-T3:[tid]:AID:CTAG;



Example inputAt the NEWYORK network element, remove all internal test equipment frthe DS3 facility in slot 7: DISC-TSTSIG-T3:NEWYORK:DS3-7:CTAG12;

Field Purpose


AID Access identifier, the facility to be acted on



DS3 AID DS3-slot# Identify the DS3 facilitywhere slot# = 3, 5, 7, or 9



set

e

OPR-LPBK-EC1 The Operate Loopback EC-1 facility command instructs the equipment tothe specified EC-1 facility into loopback mode. Two types of loopback areprovided: terminal and facility.

The facility must be put in an out-of-service state before a loopback will bpermitted (RMV-EC1 command).

To release the facility loopback, use the RLS-LPBK-EC1 command.


Input syntaxOPR-LPBK-EC1:TID:AID:CTAG::,,,[LPBKTYPE];




Field Purpose




lpbktype Loopback. See the Parameter descriptions table for details.


EC1 AID EC1-slot# Identify the EC1 where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)


lpbktype FACILITY A signal received on the copper side of the facility is looped back towards the copper. (default)

TERMINAL A signal received on the optical side of the facility is looped back towards the optics.



the

the

Example inputAt the NEWYORK network element, for the slot 5 EC-1 mapper, loopback 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 incoming signal from the copper back on to the copper: OPR-LPBK-EC1:NEWYORK:EC1-5:CTAG::,,,FACILITY;



t the
OPR-LPBK-T1
The Operate Loopback T1 facility command instructs the equipment to sespecified 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.


Input syntaxOPR-LPBK-T1:[TID]:AID:CTAG::,,,[LPBKTYPE];



Field Purpose










1 ics:

1 per:


Example inputAt the SEATTLE network element, for the port 11 facility on the slot 5 DSmapper, loopback the incoming signal from the optics back on to the optOPR-LPBK-T1:SEATTLE:DS1-5-11:CTAG::,,,TERMINAL;

At the SEATTLE network element, for the port 11 facility on the slot 5 DSmapper, loopback the incoming signal from the copper back on to the copOPR-LPBK-T1:SEATTLE:DS1-5-11:CTAG::,,,FACILITY;






t the
OPR-LPBK-T3
The Operate Loopback T3 facility command instructs the equipment to sespecified 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.


Input syntaxOPR-LPBK-T3:[TID]:AID:CTAG::,,,[LPBKTYPE];




Field Purpose






DS3 AID DS3-slot# Identify the DS3 where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)






the

the

Example inputAt the NEWYORK network element, for the slot 5 DS3 mapper, loopback 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 incoming signal from the copper back on to the copper: OPR-LPBK-T3:NEWYORK:DS3-5:CTAG::,,,FACILITY;



e an

ck:

RLS-LPBK-EC1 The Release Loopback EC-1 command instructs the equipment to releasEC-1 facility loopback.


Input syntaxRLS-LPBK-EC1:[TID]:AID:CTAG;



Example input At the SEATTLE network element, release the slot 7 EC-1 facility loopbaRLS-LPBK-EC1:SEATTLE:EC1-7:CTAG45;

Field Purpose





EC1 AID EC1-slot# Identify the EC-1 whereslot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)



DS1

ty 7

RLS-LPBK-T1 The Release Loopback T1 command instructs the equipment to release afacility loopback.


Input syntaxRLS-LPBK-T1:[TID]:AID:CTAG;



Example input At the NEWYORK network element, release the slot 4 DS1 mapper, facililoopback: RLS-LPBK-T1:NEWYORK:DS1-4-7:CTAG23;

Field Purpose









DS3

k:

RLS-LPBK-T3 The Release Loopback T3 command instructs the equipment to release afacility loopback.


Input syntaxRLS-LPBK-T3:[TID]:AID:CTAG;



Example input At the SEATTLE network element, release the slot 7 DS3 facility loopbacRLS-LPBK-T3:SEATTLE:DS3-7:CTAG45;

Field Purpose





DS3 AID DS3-slot# Identify the DS3 whereslot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)


11-1

d to ach iables,

Protection switching detailed command descriptions 11-

This chapter is an alphabetical summary of all the TL1 commands relateprotection switching. The command descriptions in this chapter identify ecommand, and describe the command purpose, syntax, parameters, varand response.


Command Page

ALW-EX-OC3 11-2

EX-SW-OC3 11-3

INH-EX-OC3 11-5

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

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


11-2 Protection switching detailed command descriptions

e

tion d in , the

he e n all

gher

ALW-EX-OC3 The Allow Exerciser command is used to activate the exerciser to test thdifferent protection mechanisms associated with OC-3 line switching in alinear 1+1 protected system.

The high-speed exerciser is a routine that tests the integrity of the protecswitching bytes (K-bytes) communication between an OC-3 pair configurea linear 1+1 protected system. If the two ends fail to exchange the K-bytesexerciser will fail and the protection channel match fail alarm is raised. Texerciser can run automatically on a predetermined schedule, or it can binitiated manually. The exerciser runs on a pair of OC-3 circuit packs or oOC-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 hipriority feature or command is in effect.


Input syntaxALW-EX-OC3:[TID]:AID:CTAG;



Example input Allow the exerciser for network element SEATTLE to run:ALW-EX-OC3:SEATTLE:OC3-11:CTAG13;

Field Purpose


AID Access identifier. The OC-3 to act on.




Identify the OC-3 facility where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)


Protection switching detailed command descriptions 11-3

the

tion d in , the

he e cks

gher

EX-SW-OC3The Exercise Switch OC-3 command is used to run the exerciser to test different protection mechanisms associated with OC-3 line switching.

The high-speed exerciser is a routine that tests the integrity of the protecswitching bytes (K-bytes) communication between an OC-3 pair configurea linear 1+1 protected system. If the two ends fail to exchange the K-bytesexerciser will fail and the protection channel match fail alarm is raised. Texerciser can run automatically on a predetermined schedule, or it can binitiated manually. The exerciser runs on a pair of OC-3 or MTX circuit paor on all OC-3 circuit packs in the shelf that are in an in-service state.



Input syntaxEX-SW-OC3:[TID]:AID:CTAG;



Example inputRun the exerciser on network element OTTAWA and report results of all exercises:EX-SW-OC3:OTTAWA:OC3-11:CTAG23;

Field Purpose





OC3 AID OC3-slot# Identify the OC-3 facility where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



Response block syntax[aid]:<rslt>

Possible values for <rslt> are:

FAIL the exercise has determined unit failurePASS the exercise found no problem in the unit



g to ing.

INH-EX-OC3The INH-EX-OC3 command is used to prevent the exerciser from runnintest the different protection mechanisms associated with OC-3 line switch


Input syntaxINH-EX-OC3:[TID]:AID:CTAG;



Example inputPrevent the exerciser from running on network element SEATTLE:INH-EX-OC3:SEATTLE:OC3-ALL:CTAG23;

Field Purpose






Identify the OC-3 facility whereslot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



rk 3, or

are

OPR-PROTNSW-EQPTThe Operate Protection Switch Equipment command instructs the netwoelement to initiate an equipment protection switch request for a DS1, DSEC-1 circuit pack.

User switch requests initiated with this command remain active until theyreleased using the RLS-PROTNSW-EQPT command or overridden by a higher priority switch request.


Input syntaxOPR-PROTNSW-EQPT:[TID]:AID:CTAG::[SC];



Field Purpose


AID Access identifier. The entity to act on.


SC Switch Command. See the Parameter descriptions table for details. Default is manual.


DS1 AID DS1-slot# Identify the DS1 whereslot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)


EC-1 AID EC1-slot# Identify the EC-1 whereslot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)



Example input Manually switch the DS1 in slot 5 to protection mode: OPR-PROTNSW-EQPT:NEWYORK:DS1-5:CTAG23::MAN;


Possible values

AID Description

Express Express CX

MAN 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

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 Not applicable.

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

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 Not applicable.

LOCKOUT DS1#3 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.

DS1#4 to 10 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.



ent u

ear

are gher

OPR-PROTNSW-OC3The Operate Protection Switch OC-3 command instructs the network elemto initiate a protection switch request for an OC-3 or MTX circuit pack. Yocan initiate a protection switch request only for network elements in a linsystem.

User switch requests initiated with this command remain active until theyreleased using the RLS-PROTNSW-OC3 command or overridden by a hipriority switch request.


Input syntaxOPR-PROTNSW-OC3:[TID]:AID:CTAG::[SC];



Field Purpose










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;

Parameter Possible Values

Description

SC MAN 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.


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.



ment cuit

are igher

OPR-PROTNSW-STS1 The Operate Protection Switch STS-1 command instructs the network eleto initiate an STS-1 path protection switch request for an OC-3 or MTX cirpack.

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 theyreleased using the RLS-PROTNSW-STS1 command or overridden by a hpriority switch request.


Input syntaxOPR-PROTNSW-STS1:[TID]:AID:CTAG::[SC];



Field Purpose


AID Access identifier. The STS-1 path facility on the OC-3 to act on.




OC-3 AID OC3-slot#-sts#

OC3-slot#-ALL

Identify the STS-1 path on the OC-3where

slot#= 3 to 12 (Express)slot#= 3 to 4 (Express CX)

sts# = 1 to 3



e:


Example input Manually switch the STS-1 port 2 of the OC-3 in slot 9 to protection modOPR-PROTNSW-STS1:NEWYORK:OC3-9-2:CTAG23::MAN;


Description

SC MAN 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.




ath.

are

OPR-PROTNSW-STS3CThe Operate Protection Switch STS-3c command instructs the network element to initiate an STS-3c path protection switch request for an OC-3 p

Two levels of priority are supported: manual and forced. Lockout is not supported.

User switch requests initiated with this command remain active until theyreleased using the RLS-PROTNSW-STS3C command or overridden by ahigher priority switch request.


Input syntaxOPR-PROTNSW-STS3C:[TID]:AID:CTAG::[SC];



Field Purpose


AID Access identifier. The STS-1 path to STS-3c on the OC-3 to act on.




STS-3c facility AID

OC3-slot#-sts#

OC-3-slot#

Identify the STS-1 path to STS-3c on the OC-3 whereslot#= 3 to 12 sts# = 1



de:


Example input Manually switch the STS-3c signal of the OC-3 in slot 9 to protection moOPR-PROTNSW-STS3C:NEWYORK:OC3-9:CTAG23::MAN;


Description

SC MAN 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.




ent

ctive

OPR-PROTNSW-VT1 The Operate Protection Switch VT1 command instructs the network elemto 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 auntil they are released using the RLS-PROTNSW-VT1 command or overridden by a higher priority switch request.


Input syntaxOPR-PROTNSW-VT1:[TID]:AID:CTAG::[SC];


Field Purpose


AID Access identifier. The VT1.5 path facility to act on.





12:



Example inputRequest forced protection switching for VT1 #1, VTG#1, STS1#1, in slot OPR-PROTNSW-VT1:SEATTLE:OC3-12-1-1-1:CTAG45::FRCD;


VT1.5 facility AID


Identify the VT1.5 path on the OC-3 where


sts# = 1 to 3vtg#= 1 to 4vt#= 1 to 4


SC MAN 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.



rk were ntity

uit

RLS-PROTNSW-EQPTThe Release Protection Switch Equipment command instructs the netwoelement to release (clear) any equipment protection switch requests thatinitiated by the OPR-PROTNSW-EQPT command and are active on the especified. This command clears lockouts, forced switches and manual switches of DS1 circuit packs, and forced switches of DS3 and EC-1 circpacks.


Input syntaxRLS-PROTNSW-EQPT:[TID]:AID:CTAG;



Example inputRelease any protection requests on the DS1 in slot 5: RLS-PROTNSW-EQPT:SEATTLE:DS1-5:CTAG23;

Field Purpose


AID Access identifier. The equipment to act on.





EC-1 AID EC1-slot# Identify the EC-1 whereslot#= 3 to 10 (Express)slot#= 1 to 2 (Express CX)



ment rs

RLS-PROTNSW-OC3 The Release Protection Switch OC-3 command instructs the network eleto release (clear) an OC-3 protection switch request. This command clealockouts and forced switches of OC-3 circuit packs.


Input syntaxRLS-PROTNSW-OC3:[TID]:AID:CTAG;



Example inputPlace the OC-3 circuit pack in slot 12 back into normal mode: RLS-PROTNSW-OC3:SEATTLE:OC3-12:CTAG12;

Field Purpose


AID Access identifier. The OC-3 facility to act on.



OC-3 AID OC3-slot# Identify the OC-3 facility where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



ment

RLS-PROTNSW-STS1 The Release Protection Switch STS1 command instructs the network eleto release (clear) an STS-1 path protection switch request.


Input syntaxRLS-PROTNSW-STS1:[TID]:AID:CTAG;



Example inputPlace the STS-1 signal on OC-3 circuit pack in slot 12, STS1#1 back intonormal mode: RLS-PROTNSW-STS1:SEATTLE:OC3-12-1:CTAG12;

Field Purpose


AID Access identifier. The STS-1 path facility to act on.



STS-1 facility AID

OC3-slot#-sts#OC3-slot#-ALL

Identify the STS-1 path on the OC-3 where


sts# = 1 to 3



RLS-PROTNSW-STS3C The Release Protection Switch STS3C command instructs the network element to release (clear) an STS-3c path protection switch request.


Input syntaxRLS-PROTNSW-STS3C:[TID]:AID:CTAG;



Example inputPlace the STS-3c signal on OC-3 circuit pack in slot 12 back into normalmode: RLS-PROTNSW-STS3C:SEATTLE:OC3-12-1:CTAG12;

Field Purpose


AID Access identifier. The STS-1 path to STS-3c to act on.

CTAG Correlation tags


STS-3c facility AID


Identify the STS-1 path to STS-3c on the OC-3 whereslot#= 3 to 12 sts# = 1



ent

ack

RLS-PROTNSW-VT1 The Release Protection Switch VT1 command instructs the network elemto release (clear) a VT1.5 path protection switch request.


Input syntaxRLS-PROTNSW-VT1:[TID]:AID:CTAG;



Example inputPlace the VT1.5 signal on OC-3 circuit pack in slot 12, STS1#1, VTG#1 binto normal mode: RLS-PROTNSW-VT1:SEATTLE:OC3-12-1-1-1:CTAG12;

Field Purpose


AID Access identifier. The VT1.5 path facility to act on.



VT1.5 facility AID

OC3-slot#-sts1#-vtg#-vt#OC3-slot#-sts1#-ALL

Identify the VT1.5 path on the OC-3 where


sts# = 1 to 3vtg#= 1 to 4vt#= 1 to 4



le that

tion d in , the

he e n all

gher

RTRV-EXSCHED-OC3The Retrieve Exerciser Schedule command is used to retrieve the scheduhas been set for the exerciser to run.




Input syntaxRTRV-EXSCHED-OC3:[TID]:AID:CTAG;




Field Purpose





OC3 OC3-slot# OC3-ALL

Identify the OC-3s whereslot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)



er

rmat:

Response block syntaxThe response follows the normal response format if there are no exercisschedules.

If there is at least one exerciser schedule to report, the <rspblk> has the fo<aid>[,aidtype]:<invl>,<dat>,<tm>,<numinvl>,<reptmode>


Parameter Valid Values Description

invl(interval between the exerciser)

Value Unit

1 to 3 DAY

1 to 5 HR

5 to 30 MIN

null

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.

dat(date)

MOY-DOM where MOY is from 1 to 12, and DOM is from 1 to 31

Month of year, day of month of the next exercise

tm(time)

HOD-MOH where HOD is from 0 to 23, and MOH is from 0 to 59

Hour of day, minute of hour of the next exercise

numinvl(number of intervals to run the exerciser)

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.

reptmode(report mode)

ALL

FAIL

null

Report results of all exercises

Report results of failed exercises

If no value is entered, the default is FAIL.

alw ALW

INH

The exerciser is enabled.

The exerciser is disabled.



ing
RTRV-PROTNSW-rr
The Retrieve Protection Switch command retrieves the protection switchstatus for

• tributary equipment (DS1, DS3 and EC-1)

• 1+1 protected optical interfaces

• VT1.5, STS-1, and STS-3c path protected channels


Input syntaxRTRV-PROTNSW-rr:[TID]:[AID]:CTAG;


Field Purpose


AID Access identifier. The equipment to act on.



rr value AID value Purpose

EQPTALL

Equipment protectionAll DS1, DS3, and EC-1 equipment

DS1-slot#DS1-ALL

slot#=3 to 10 (Express)slot#=1 to 2 (Express CX)

DS3-slot#DS3-ALL


EC1-slot#EC1-ALL


OC3 OC3-slot#OC3-ALL

OC-3 equipment protectionslot#=3 to 12 (Express)slot#=3 to 4 (Express CX)

—continued—



Example inputRetrieve the protection switching status for the slot 5 DS1 mapper in the Seattle network element: RTRV-PROTNSW-EQPT:SEATTLE:DS1-5:CTAG;

Response block syntax<aid>:<SWSTATUS=status>, <SWEND=END>, <SWREASON=REASON>

VT1OC3-slot#-sts#-vtg#-vt#OC3-slot#-sts#-ALLOC3-slot#-ALLOC3-ALL

VT1 path protection slot#=3 to 12 (Express)slot#=3 to 4 (Express CX)

sts#=1 to 3vtg# = 1 to 7vt# 1 to 4

STS1OC3-slot#-sts#OC3-slot#-ALLOC3-ALL

STS-1 path protectionslot#=3 to 12 (Express)slot#=3 to 4 (Express CX)

sts#=1 to 3

STS3COC3-slot#OC3-ALL

STS-3c path protectionslot#=3 to 12



SWSTATUS MAN Manual switch by user

LOCKOUT Lockout by user

AUTO Autonomous switch by network element

FRCD Forced switch by user

IDLE No switch

SWEND REMOTE 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—

Table 11-36 (continued)AID descriptions




SWEND(continued)

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

SWREASON SIGOK Signal OKSignal/path/line/equipment is able to carry traffic

SF Signal FailAutonomous switch due to complete line/path failure (OC-3 line or path switching only)

SD Signal DegradeAutonomous switch due to line/path signal degrade condition (OC-3 line or path switching only)

EBER Excessive BIP errorAutonomous switch due to excessive BIP error (OC-3 line and path switching)

EQPFL Equipment FailAutonomous switch due to equipment failure (DS1/DS3/EC-1 equipment or OC-3 line switching)

FACOOS Facility OOSOC-3 line autonomous switch due to facility OOS

EQPOOS Equipment OOSOC-3 line autonomous switch due to OC-3 equipment OOS

OSC OscillationAutonomous switch locked onto working or protection OC-3 line due to switch oscillation control by OC-3 firmware

WTR Wait to restoreAutonomous switch active because the wait to restore period has not yet expired (DS1 equipment only)





er to ing.

tion d in , the

he e n all

gher

SCHED-EX-OC3 The Schedule Exerciser OC-3 command is used to schedule the exercistest the different protection mechanisms associated with OC-3 line switch




Input syntaxSCHED-EX-OC3:[TID]:AID:CTAG::[invl],[statm],[numinvl],[reptmode];


Field Purpose




INVL Interval between the running of the exerciser.See the Parameter descriptions table for details.

STATM Start time for the exerciser schedule.See the Parameter descriptions table for details.

NUMINVL Number of intervals over which exerciser is to be run.See the Parameter descriptions table for details.

REPTMODE Report mode, determines whether the results of all exercises or only failed exercises are reported.See the Parameter descriptions table for details.



ay at



Example inputSchedule the exerciser to run on network element Seattle, 3 times, every d10 am, and to report the results of all exercises:SCHED-EX-OC3:SEATTLE:OC3-11:CTAG12::1DAY,10-0,3,ALL;



Identify the OC-3 facility whereslot#= 3 to 12 (Express)slot#= 3 to 4 (Express CX)

Parameter Valid Values Description

invl(interval between the exerciser)

Value Unit

1 to 3 DAY

1 to 5 HR

5 to 30 MIN

null

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.

statm(start time)

HOD-MOH where HOD is from 0 to 23, and HOM is from 0 to 59

null

Hour of day, minute of hour to start the exerciser

If no parameter is entered, the default is the current time of day.

numinvl(number of intervals to run the exerciser)

1 to 250

null

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.

reptmode(report mode)

ALL

FAIL

null

Report results of all exercises

Report results of failed exercises

If no value is entered, the default is FAIL.


12-1

tify s,

Performance monitoring detailed command descriptions 12-

This chapter is an alphabetical summary of the TL1 commands related toperformance monitoring. The command descriptions in this chapter ideneach command, and describe the command purpose, syntax, parametervariables, and response.


Command Page

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

—continued—


12-2 Performance monitoring detailed command descriptions

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

Command Page


Performance monitoring detailed command descriptions 12-3

the 1,

>

ch

he u

r m>.

rent

ies ared

ersand (&&)

rom 5

INIT-REG-ALLThe Initialize Registers All command instructs a network element to clearperformance monitoring data registers for all facilities (OC-3, EC-1, STS-STS-3c, DS1, and DS3).

To initialize registers for individual facilities use the INIT-REG-<FACTYPEcommands.

The AID for this command is always ALL.

PM data is kept in separate monitored parameter registers or bins for eapassed interval.You can specify either the starting time of the periods of interest using <mondat>, <montm>, or both, or you can directly specify tinterval by using <index>. If you specify <mondat>, <montm>, or both, yocannot specify <index>.

Current intervals are indicated by index=0, and older periods have highenumbers. If you specify <index>, you cannot specify <mondat> or <mont

Note: The accumulation intervals that are stored are as follows: the cur15-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 facilitand parameters for the current 15-minute accumulation period will be cleat once.

Several parameters can be grouped. To group parameters, use the amp(&) as the separator. To use a range of parameters, use two ampersandsbetween the parameters. For example, to use a range of index intervals fto 12, enter 5&&12 as the index parameter.


Input syntax INIT-REG-ALL:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn],[tmper],[mondat],[montm],[index];





Field Purpose


AID Access identifier, The facility to which the command applies.


montype The type of monitored parameter for which a value is requested

monval The value the registers should be initialized to

locn The location where the monitored parameter originates, and refers to the entity identified by the AID

dirn The direction which the monitored parameter applies, and is relative to the entity identified by the AID

tmper The accumulation time period for the PM information

mondat The date of the beginning of the requested PM period

montm The beginning time of day of the requested PM period

index The interval numbers to be accessed


ALL ALL All facilities (OC-3, EC-1, STS-1, STS-3c, DS1, DS3)



montype nullALL

Default: equivalent to ALLAll applicable montypes

monval null0

Default: equivalent to 0Reset registers to zero

locn nullNENDFEND

Default: All applicable locationsNear endFar end

—continued—



dirn nullTRMTRCV

Default: All applicable directionsTransmit direction onlyReceive direction only

tmper null15-MIN1-DAY1-UNT

ALL

Grouping allowed

Default: equivalent to 15-MIN15 minute intervalDay intervalUntimed interval

All available time periods

mondat nullALLMOY-DOM

Grouping allowed

Default: Current dateAll dates availableMonth of year-day of month

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 = 1UNT, mondat is not applicable.

montm nullALLHOD-MOH

Grouping allowed

Default: start of current 15-MINAll beginning times availableHour of day-minute of hour



Note 2: If tmper=1-UNT or tmper=1-DAY, montm is not applicable.

index null01-32ALL

Grouping and ranges allowed

Default: equivalent to 0Current intervalPrevious 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).





ying
Example input
Initialize all 15-minute and 1-day registers on the network element, specifmondat 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;



lize

ch

he u

r m>.

rent

ters

ersand (&&)

rom 5

INIT-REG-EC1 The Initialize Register EC1 command instructs a network element to initiaperformance monitoring data for an EC-1 facility.




If all optional parameters are left blank, all of the current 15-min PM regisfor all parameters for the corresponding facility will be cleared at once.



Input syntaxINIT-REG-EC1:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn],[tmper],[mondat],[montm],[index];





Field Purpose


AID Access identifier. The facility to which the command applies.











EC1 AID EC1-slot#EC1-ALLALL

Identify the EC-1 facilities where

slot# =3, 5, 7, or 9 (Express)slot# = 1 (Express CX)





montype NULLCVSESSSESSSEFSS

CVLESLFCL SESL

UASL

ALL

Grouping allowed

Default: equivalent to ALLCoding Violations - SectionErrored Seconds - Section Severely Errored Seconds - SectionSeverely Errored Frame Seconds - Section

Coding Violations - LineErrored Seconds - LineFailure Count - Line Severely Errored Seconds - LineUnavailable Seconds - Line

All applicable montypes

monval null0


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed

Default: equivalent to 15-min15 minute intervalDay intervalUntimed interval



Grouping allowed





—continued—



le ns:

only:

Example inputInitialize 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 unavailabseconds (UASL), specifying mondat and montm for current 15-minute biINIT-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 INIT-REG-EC1:SEATTLE:ALL:CTAG12::SESL,,NEND,RCV,1-DAY;


Grouping allowed



Note 1: If index is used mondat and montm cannot be used.


index null01-32ALL



If mondat or montm is used, index cannot be used.






lize

ch

he u

r m>.

rent

ters

ersand (&&)

rom 5

INIT-REG-OC3The Initialize Register OC-3 command instructs a network element to initiaperformance monitoring data for an OC-3 facility.







Input syntaxINIT-REG-OC3:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn],[tmper],[mondat],[montm],[index];





Field Purpose














ALL

Identify the OC-3 where

slot# =3 to 12 (Express)slot# = 3 to 4 (Express CX)

All OC-3 facilities





montype null

CVSESSSESSSEFSS

CVLESLFCL SESLUASL

ALL

Grouping allowed

Default: equivalent to ALL

Coding Violations - SectionErrored Seconds - Section Severely Errored Seconds - SectionSeverely Errored Frame Seconds - Section

Coding Violations - LineErrored Seconds - LineFailure Count - Line Severely Errored Seconds - LineUnavailable Seconds - Line


monval null0


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



ll

Example inputInitialize the PM data for near-end receive line coding violations for OC-3slot 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 aintervals, 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;


Grouping allowed





index null01-32ALL









lize

ch

he u

r m>.

rent

ters

ersand (&&)

rom 5

INIT-REG-STS1 The Initialize Register STS1 command instructs a network element to initiaperformance monitoring data for the STS-1 facility.






Note: STS-1 facilities can exist on both OC-3 and EC-1 equipment.




Input syntaxINIT-REG-STS1:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn],[tmper],[mondat],[montm],[index];


Field Purpose
















STS1 AID OC3-slot#-sts#OC3-slot#-ALLOC3-ALL

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


sts# = 1 to 3

ALL All applicable STS-1 facilities



montype NULLCVP ESP SESP

ALSPUASP FCP

ALLGrouping allowed

Default: equivalent to ALLCoding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathAIS/LOP Seconds - PathUnavailable Seconds - PathFailure Count - Path


monval null0


locn nullNENDFEND


dirn nullTRMTRCV


—continued—




ALL

Grouping allowed




Grouping allowed






Grouping allowed





index null01-32ALL









red

ly ns:

h -day

Example inputInitialize the PM data at NEWYORK on OC-3 in slot 3, sts 2, for path erroseconds (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 severeerrored seconds (SESP), specifying mondat and montm for 15-minute biINIT-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 patfailure count (FCP), at the near-end receive direction only for the current 1bin: INIT-REG-STS1:SEATTLE:ALL:CTAG12::FCP,,NEND,RCV,1-DAY;



ch

he u

r m>.

rent

ters

ersand (&&)

rom 5

INIT-REG-STS3CThe Initialize Register STS3C command instructs a network element to initialize performance monitoring data for the STS-3c facility.






Note: STS-3c facilities can only exist on OC-3 equipment.


Input syntaxINIT-REG-STS3C:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn],[tmper],[mondat],[montm],[index];





Field Purpose













STS3C AID OC3-slot#OC3-ALL

ALL

Identify the OC-3s whereslot# =3 to 12

All OC-3 facilities





montype NULLCVP ESP SESP

ALSPUASP FCP

ALLGrouping allowed

Default: equivalent to ALLCoding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathAIS/LOP Seconds - PathUnavailable Seconds - PathFailure Count - Path


monval null0


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



h inute

-day

Example inputInitialize 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 patseverely errored seconds (SESP), specifying mondat and montm for 15-mbins: 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 1bin: INIT-REG-STS3C:SEATTLE:ALL:CTAG12::FCP,,NEND,RCV,1-DAY;


Grouping allowed





index null01-32ALL









lize

ch

he u

r m>.

rent

ters

ersand (&&)

rom 5

INIT-REG-T1The Initialize Registers T1 command instructs a network element to initiaperformance monitoring data for the DS1 facility.







Input syntaxINIT-REG-T1:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn],[tmper],[mondat],[montm],[index];





Field Purpose













T1 AID DS1-slot#-port#DS1-slot#-ALLDS1-ALL

Identify the DS1s whereExpressslot# = 4 to 10port# = 1 to 12

Express CXslot# = 1, port# = 1 to 12slot# = 3, port# = 1 to 8

ALL All DS1 facilities





montype null

CVLESLSESL

CVPESPFCP SESP

SEFSP

SASPCSSPUASP

ALL

Grouping allowed


Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds- Line

Coding Violations - PathErrored Seconds - PathFailure Count - Path Severely Errored Seconds - PathSeverely Errored Frame Seconds - PathSEF / AIS Seconds - PathControlled slip seconds - PathUnavailable Seconds - Path


monval null0


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed



—continued—




Grouping allowed






Grouping allowed





index null01-32ALL









t 4 ll

for

Example inputInitialize the PM data for near-end receive line coding violations for DS1 sloport 7, for all intervals, specifying ALL mondat and ALL montm (that is, acurrent 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, all intervals, specifying all time periods: INIT-REG-T1:SEATTLE:DS1-4-7:CTAG12::,,,,15-MIN&1-DAY&1-UNT,,,ALL;

Initialize all current 15-minute registers for all T1 facilities: INIT-REG-T1:WASHINGTON:ALL:CTAG12;



lize

ch

he u

r m>.

rent

ters

ersand (&&)

rom 5

INIT-REG-T3 The Initialize Registers T3 command instructs a network element to initiaperformance monitoring data for the DS3 facility.







Input syntaxINIT-REG-T3:[TID]:AID:CTAG::[montype],[monval],[locn],[dirn], [tmper],[mondat],[montm],[index];





Field Purpose


AID Access identifier. The facility to which the command applies












ALL

Identify the DS3s whereslot# = 3, 5, 7, or 9 (Express)slot# = 1 (Express CX)

All DS3 facilities





montype null

CVLESLSESL

CVPESPFCP SESP

SASPUASP

ALL

Grouping allowed


Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds- Line

Coding Violations - PathErrored Seconds - PathFailure Count - Path Severely Errored Seconds - PathSEF / AIS Seconds - PathUnavailable Seconds - Path


monval null0


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



le

rrent

Example inputInitialize 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 unavailabseconds (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 cu1-day bin: INIT-REG-T3:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;


Grouping allowed





index null01-32ALL









the

ed by

RTRV-PM-ABORTThe Retrieve Performance Monitoring Abort command allows you to abortactive retrieve (RTRV-PM) command.

If the retrieve command completes before the abort command is processthe system, there is no impact.


Input syntaxRTRV-PM-ABORT:[tid]::ctag;


Example inputAbort the active retrieve PM command at NEWYORK: RTRV-PM-ABORT:NEWYORK::123;

Field Purpose





rrent

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-ALLThe Retrieve Performance Monitoring All command instructs a network element to send its set of all performance monitoring (PM) data to the cuTL1 session immediately.






Input syntaxRTRV-PM-ALL:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn],[tmper],[mondat],[montm],[index];






Field Purpose


AID Access identifier. The facility to which the command is directed.


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

monlev The discriminating level for reported monitored parameters






index The interval numbers to be retrieved


ALL ALL All facilities



montype nullALL


monlev null0-UP1-UP

Default: equivalent to 1-UPAll monitored parameter binsNon-zero bins only

—continued—



locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed

Default: current dateAll dates availableMonth of year-day of month





Grouping allowed

Default: Use index All beginning times available Hour of day-minute of hour




index null01-32ALL


Default: equivalent to 0 Current interval Previous intervals (see Note)All available intervals







ent,

ent,

Example inputRetrieve all non-zero 15-minute and 1-day registers on the network elemspecifying 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 elemspecifying 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;

Response block syntax<aid>,<aidtype>:<montype>,<monval>,<vldty>,<locn>,<dirn>,<tmper>,<mondat>,<montm>,<index>

Table 12-26Response block parameter descriptions


AID OC3-slot# (ALL) EC1-slot# (ALL)EC1-slot# (ALL)OC3-slot#-sts (ALL)DS3-slot# (ALL)DS1-slot#-port# (ALL)

AIDtype OC3, EC1, STS1, STS3C, T1, T3

montype See montype parameter in parameter description tables for RTRV-PM-OC3RTRV-PM-EC1RTRV-PM-STS1RTRV-PM-STS3CRTRV-PM-T1RTRV-PM-T3

monval Integer from 0 - (232 -1 ) Value counted from 0 to 4,294,967,295 or (232 - 1)

vldty COMPL

PRTL

ADJ

Interval complete

Interval incomplete (partial) - current time period was cut short

The register data is suspect

—continued—



locn NENDFEND

Near endFar end

dirn TRMTRCV

Transmit direction onlyReceive direction only

tmper 15-MIN1-DAY1-UNT

15 minute intervalDay intervalUntimed interval

mondat MOY-DOM Month of year-day of month

montm HOD-MOH Hour of day-minute of hour

index 01-32

Current interval Previous intervals (see Note)


Table 12-26 (continued)Response block parameter descriptions




ta to

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-EC1The Retrieve Performance Monitoring EC1 command instructs a networkelement to send its current set of EC-1 performance monitoring (PM) dathe current TL1 session.






Input syntaxRTRV-PM-EC1:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];






Field Purpose













EC1 AID EC1-slot#EC1-ALL

ALL

Identify the EC-1s whereslot# = 3, 5, 7, or 9 (Express)slot# = 1 (Express CX)

All EC-1 facilities





montype null

CVSESSSESSSEFSS

CVLESLSESLUASLFCL

ALL

Grouping allowed


Coding Violations - SectionErrored Seconds - SectionSeverely Errored Seconds - SectionSeverely Errored Frame Seconds - Section

Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds- LineUnavailable Seconds - LineFrame Count - Line


monlev null0-UP1-UP


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



n

ll

for

Example inputRetrieve the non-zero PM data at NEWYORK on EC-1 in slot 3 for sectiocoding 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 aEC-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 current 1-day bin: RTRV-PM-EC1:SEATTLE:ALL:CTAG12::SESL,,NEND,RCV,1-DAY;


See Table 12-26 for a description of the response block parameters.


Grouping allowed





index null01-32ALL









ta to

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-OC3 The Retrieve Performance Monitoring OC3 command instructs a networkelement to send its current set of OC-3 performance monitoring (PM) dathe current TL1 session.






Input syntaxRTRV-PM-OC3:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn],[tmper],[mondat],[montm],[index];






Field Purpose














ALL


All OC-3 facilities





montype null

CVSESSSESS

SEFSS

CVLESLSESLUASLFCL

ALL

Grouping allowed



Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds- LineUnavailable Seconds - LineFrame Count - Line


monlev null0-UP1-UP


locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



ns
Example inputRetrieve all PM data at NEWYORK for near-end receive line coding violatio(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;




Grouping allowed





index null01-32ALL









rk ta to

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-STS1 The Retrieve Performance Monitoring STS1 command instructs a netwoelement to send its current set of STS-1 Performance Monitoring (PM) dathe current TL1 session.








Input syntaxRTRV-PM-STS1:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn],[tmper],[mondat],[montm],[index];


Field Purpose


















slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)

sts# = 1 to 3

EC1-slot#-sts#EC1-slot#EC1-ALL



sts# = 1 to 3




montype nullCVP ESP SESP

ALSPUASP FCPALL

Grouping allowed

Default: equivalent to ALLCoding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathAIS/LOP second - PathUnavailable Seconds - PathFailure Count - PathAll applicable montypes

monlev null 0-UP 1-UP


locn nullNENDFEND


dirn nullTRMTRCV


—continued—




ALL

Grouping allowed




Grouping allowed






Grouping allowed





index null01-32ALL









ll

es ion

Example inputRetrieve 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 aEC-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 facilitifor path severely errored seconds (SESP), at the near-end receive directonly for the current 1-day bin: RTRV-PM-STS1:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;





ork data

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-STS3CThe Retrieve Performance Monitoring STS3C command instructs a netwelement to send its current set of STS-3c Performance Monitoring (PM) to the current TL1 session.






Input syntaxRTRV-PM-STS3C:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn],[tmper],[mondat],[montm],[index];





Field Purpose














ALL

Identify the OC-3s where slot# =3 to 12

All OC-3 facilities





montype nullCVP ESP SESP ALSPUASP FCPALL

Grouping allowed

Default: equivalent to ALLCoding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathAIS/LOP second - PathUnavailable Seconds - PathFailure Count - PathAll applicable montypes



locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



3c

-3c only

Example inputRetrieve the non-zero PM data at NEWYORK on OC-3 in slot 3 for STS-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 STSpath severely errored seconds (SESP), at the near-end receive directionfor the current 1-day bin: RTRV-PM-STS3C:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;




Grouping allowed





index null01-32ALL









ta to

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-T1The Retrieve Performance Monitoring T1 command instructs a network element to send the specified set of DS1 Performance Monitoring (PM) dathe current TL1 session.






Input syntaxRTRV-PM-T1:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn],[tmper],[mondat],[montm],[index];






Field Purpose





















montype null

CVL ESL SESLCVP ESP FCPSEFSP SESP SASPCSSPUASP

ALL

Grouping allowed


Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds - LineCoding Violations - PathErrored Seconds - PathFailure Count - PathSeverely Errored Frame Seconds - PathSeverely Errored Seconds - PathSEF / AIS Seconds - PathControlled slip seconds - PathUnavailable Seconds - Path




locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



1
Example inputRetrieve all the PM data for near-end receive line coding violations for DSslot 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;




Grouping allowed





index null01-32ALL









a to

ch

he u

r m>.

rent

ersand (&&)

rom 5

RTRV-PM-T3The Retrieve Performance Monitoring T3 command instructs a network element to send its current set of DS3 Performance Monitoring (PM) datthe current TL1 session.






Input syntaxRTRV-PM-T3:[TID]:AID:CTAG::[montype],[monlev],[locn],[dirn], [tmper],[mondat],[montm],[index];





Field Purpose














ALL


All DS3 facilities





montype nullCVL ESL SESLCVP ESP FCPSESP SASPUASPALLGrouping allowed

ALLCoding Violations - LineErrored Seconds - LineSeverely Errored Seconds - LineCoding Violations - PathErrored Seconds - PathFailure Count - PathSeverely Errored Seconds - PathSEF / AIS Seconds - PathUnavailable Seconds - PathAll applicable montypes



locn nullNENDFEND


dirn nullTRMTRCV



ALL

Grouping allowed




Grouping allowed





—continued—



ing

ll

or the

Example inputRetrieve the non-zero PM data at NEWYORK on DS3 in slot 3 for path codviolations (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 aDS3 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 fcurrent 1-day bin: RTRV-PM-T3:SEATTLE:ALL:CTAG12::SESP,,NEND,RCV,1-DAY;




Grouping allowed





index null01-32ALL









play

rom lation

RTRV-TH-ALLThe Retrieve Threshold All command instructs the network element to disthe threshold levels for given PM monitored parameters.

Setting a threshold to zero will disable threshold crossing alerts (TCAs) fbeing generated for the corresponding monitored parameter and accumubin. Only non-zero thresholds are displayed by RTRV-TH commands.


Input syntaxRTRV-TH-ALL:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];




Field Purpose


AID Access identifier. The facility to which the threshold applies.


montype The particular monitored parameter for which threshold level is being retrieved





ALL ALL All facilities (EC-1, OC-3, STS-1, STS-3c, DS1, DS3)

Defaults DFLT Default threshold setting




Example inputRetrieve 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;

Response block syntax<aid>,<aidtype>:<montype>,<locn>,<dirn>,<thlev>,<tmper>


montype nullALL


locn NENDFEND

Near endFar end

dirn TRMTRCV



ALL

Grouping allowed





Table 12-48Response block parameter descriptions


AID 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-DFLTEC1-DFLTEMPTY-DFLTDS3-DFLTDS1-DFLT

STS-1 defaults

AIDtype T1, T3, EC1, OC3, STS1, STS3C

montype 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

locn NENDFEND

Near endFar end

dirn TRMTRCV


thlev 10 digit number Restricted by montype and tmper





d

rom lation

RTRV-TH-EC1 The Retrieve Threshold EC1 command instructs the network element to display the threshold levels for the specified EC-1 performance monitoreparameters.



Input syntaxRTRV-TH-EC1:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];


Field Purpose














ALL


All EC-1 facilities



montype nullCVSESSSESS

SEFSS

CVLESLSESL

UASLALLGrouping allowed

ALLCoding Violations - SectionErrored Seconds - Section Severely Errored Seconds - SectionSeverely Errored Frame Seconds - Section

Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds - LineUnavailable Seconds - LineAll applicable montypes

locn nullNENDFEND

Default: All applicable locationsNear EndFar End

dirn nullTRMTRCV


tmper null

15-MIN1-DAY1-UNT

ALL

Grouping allowed

Default: all applicable time periods15 minute intervalDay intervalUntimed interval




g

y

Example inputRetrieve the thresholds at NEWYORK on EC-1 in slot 3 for section codinviolations (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 severelerrored seconds (SESL), at the near-end receive direction only, for 1-dayaccumulation bin: RTRV-TH-EC1:SEATTLE:ALL:CTAG12::SESL,NEND,RCV,1-DAY;





rom lation

RTRV-TH-OC3The Retrieve Threshold OC3 command instructs the network element todisplay the threshold levels for specified OC-3 performance monitored parameters.



Input syntaxRTRV-TH-OC3:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];


Field Purpose














ALL


All OC-3 facilities



montype nullCVSESSSESS

SEFSS

CVLESLSESL

UASL

ALL

Grouping allowed

ALLCoding Violations - SectionErrored Seconds - SectionSeverely Errored Seconds - SectionSeverely Errored Frame Seconds - Section

Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds - LineUnavailable Seconds - Line


locn nullNENDFEND


dirn nullTRMTRCV


tmper null

15-MIN1-DAY1-UNT

ALL

Grouping allowed


All applicable time periods



3
Example inputRetrieve the threshold for near-end receive line coding violations for OC-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;





ed

rom lation

RTRV-TH-STS1 The Retrieve Threshold STS1 command instructs the network element todisplay the threshold levels for the specified STS-1 performance monitorparameters.



Input syntaxRTRV-TH-STS1:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];


Field Purpose


AID Access identifier. The facility to which the given threshold level applies.











STS1 AID OC3-slot#-sts#OC3-slot#-ALL

Identify the OC-3s whereslot# =3 to 12 (Express)slot# = 3 to 4 (Express CX)

sts = 1 to 3

OC3-ALL All OC-3 facilities

EC1-slot#-stsEC-1-slot#

Identify the EC-1s whereslot# =3, 5, 7, or 9 (Express)slot# = 1 (Express CX)

sts = 1 to 3

EC1-ALL All EC-1 facilities

ALL All OC-3 and EC-1 facilities



montype nullCVPESPSESPALSPUASPALLGrouping allowed

ALLCoding Violations - PathErrored Seconds - PathSeverely Errored Secs - PathAIS/LOP second - PathUnavailable Seconds - PathAll applicable montypes

locn nullNENDFEND


dirn nullTRMTRCV


tmper null

15-MIN1-DAY1-UNT

ALL

Grouping allowed





) on

D is o

Example inputRetrieve the thresholds for the near-end receive path code violation (CVPOC-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 AIshown as EMPTY-DFLT. The STS-1 threshold defaults are common tboth OC-3 and EC-1 equipment.





to red

rom lation

RTRV-TH-STS3C The Retrieve Threshold STS3C command instructs the network elementdisplay the threshold levels for the specified STS-3c performance monitoparameters.



Input syntaxRTRV-TH-STS3C:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];



Field Purpose














ALL


All OC-3 facilities



montype nullCVPESPSESPALSPUASPALLGrouping allowed

ALLCoding Violations - PathErrored Seconds - PathSeverely Errored Secs - PathAIS/LOP second - PathUnavailable Seconds - PathAll applicable montypes

locn nullNENDFEND


dirn nullTRMTRCV


tmper null

15-MIN1-DAY1-UNT

ALL

Grouping allowed





ion
Example inputRetrieve the thresholds for the near-end receive STS-3c path code violat(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;





play eters.

rom lation

RTRV-TH-T1The Retrieve Threshold T1 command instructs the network element to disthe threshold levels for the specified DS1 performance monitored param



Input syntaxRTRV-TH-T1:[TID]:AID:CTAG::[montype],[locn],[dirn],[tmper];



Field Purpose

















Table 12-63Parameter Descriptions


montype nullCVLESLSESL

CVPESPSEFSP

SESPSASPCSSPUASPALLGrouping allowed

ALLCoding Violations - LineErrored Seconds - LineSeverely Errored Secs - Line

Coding Violations - PathErrored Seconds - PathSeverely errored frame seconds - PathSeverely Errored Secs - PathSEF / AIS Seconds - PathControlled slip seconds - PathUnavailable Seconds - Path


—continued—


Example inputRetrieve the threshold for near-end receive line coding violations for DS1slot 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;



locn nullNENDFEND


dirn nullTRMTRCV


tmper null

15-MIN1-DAY1-UNT

ALL

Grouping allowed



Table 12-63 (continued)Parameter Descriptions




play eters.

rom lation

RTRV-TH-T3 The Retrieve Threshold T3 command instructs the network element to disthe threshold levels for the specified DS3 performance monitored param



Input syntaxRTRV-TH-T3:TID:AID:CTAG::[montype],[locn],[dirn],[tmper];



Field Purpose














ALL


All DS3 facilities



montype nullCVLESLSESL

CVPESPSESPSASPUASP

ALL

Grouping allowed

ALLCoding Violations - LineErrored Seconds - LineSeverely Errored Secs - Line

Coding Violations - PathErrored Seconds - PathSeverely Errored Secs - PathSEF / AIS Seconds - PathUnavailable Seconds - Path


locn nullNENDFEND


dirn nullTRMTRCV


tmper null

15-MIN1-DAY1-UNT

ALL

Grouping allowed




Example inputRetrieve the threshold for near-end receive line coding violations for DS3slot 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;





n

rossing

rom lation

SET-TH-ALLThe Set Threshold All command instructs the network element to set thethreshold levels for all PM monitored parameters to default settings. Whethese thresholds are met or exceeded, automatic messages (threshold calerts) will be generated.



Input syntaxSET-TH-ALL:[TID]:AID:CTAG::montype,thlev;


Field Purpose




montype The particular monitored parameter for which threshold level is being set

thlev The desired threshold level to be set for montype





Example inputSet all thresholds to defaults: SET-TH-ALL:NEWYORK:ALL:CTAG12::ALL,DFLT;


ALL ALL All facilities


montype ALL Set the threshold level of all monitored parameters; valid only with thlev of DFLT

thlev DFLT Set to Default thlev



e is e uires

rom lation

SET-TH-EC1 The Set Threshold EC1 command instructs the network element to set ththreshold level for a PM monitored EC-1 parameter. When this thresholdmet or exceeded, an automatic message (threshold crossing alert) will bgenerated. Threshold setting for multiple parameters or time periods reqmultiple SET-TH commands from the OS.



Input syntaxSET-TH-EC1:[TID]:AID:CTAG::montype,thlev,[locn],[dirn],[tmper];


Field Purpose














ALL


All EC-1 facilities




montype CVSESSSESS

SEFSS

CVL ESL SESL

UASL

ALL



Valid only with thlev of DFLT, and tmper of ALL

thlev 010 digit number

DFLT

Disable thresholdRestricted by montype and tmper

Set to default threshold; valid only with tmper of ALL; cannot be used if AID type is DFLT

—continued—



for

) at

Example input Set the threshold for near-end receive line coding violations (CVL) at 100the 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 (CVL100 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;

locn nullNENDFEND


dirn nullTRMTRCV



ALL

Default: 15 minute interval15 minute intervalDay intervalUntimed interval






he is rated.

le

rom lation

SET-TH-OC3The Set Threshold OC3 command instructs the network element to set tthreshold level for a PM monitored OC-3 parameter. When this thresholdmet or exceeded, an automatic message (threshold crossing alert) is geneThreshold setting for multiple parameters or time periods requires multipSET-TH commands to the operating system.



Input syntaxSET-TH-OC3:[TID]:AID:CTAG::montype,thlev,[locn],[dirn],[tmper];


Field Purpose




montype The particular monitored parameter for which the threshold level is being set










ALL


All OC-3 facilities




montype CVSESSSESS

SEFSS

CVL ESL SESL

UASL

ALL





DFLT



—continued—



for

) at

Example input Set the threshold for near-end receive line coding violations (CVL) at 100the 15-minute accumulation period for OC-3 slot 12: SET-TH-OC3:SEATTLE:OC3-12:CTAG12::CVL,100,NEND,RCV,15-MIN;

Set the default threshold for near-end receive line coding violations (CVL100 for the 15-minute accumulation period: 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;

locn nullNENDFEND


dirn nullTRMTRCV



ALL







the d is e uires

rom lation

SET-TH-STS1 The Set Threshold STS1 command instructs the network element to set threshold level for a PM monitored STS-1 parameter. When this thresholmet or exceeded, an automatic message (threshold crossing alert) will bgenerated. Threshold setting for multiple parameters or time periods reqmultiple SET-TH commands from the OS.



Input syntaxSET-TH-STS1:[TID]:AID:CTAG::montype,thlev,[locn],[dirn],[tmper];


Field Purpose













STS1 AID OC3-slot#-stsOC3-slot#-ALLOC3-ALL

Identify the OC-3s whereslot# =3 to 12 (Express)slot# = 3 to 4 (Express CX)

sts = 1 to 3

EC1-slot#-stsEC-1-slot#EC1-ALL

Identify the EC-1s whereslot# =3, 5, 7, or 9 (Express)slot# = 1 (Express CX)

sts = 1 to 3

ALL All OC-3 and EC-1 facilities

Default DFLT Default threshold setting



montype CVP ESP SESP

ALSPUASP

ALL

Coding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathAIS/LOP second - PathUnavailable Seconds - Path



DFLT



—continued—



0 for

) at

Example input Set the threshold for near-end receive path coding violations (CVP) at 10the 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 (CVP100 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;

locn nullNENDFEND


dirn nullTRMTRCV



ALL







t the ld is e uires

rom lation

SET-TH-STS3CThe Set Threshold STS3C command instructs the network element to sethreshold level for a PM monitored STS-3c parameter. When this threshomet or exceeded, an automatic message (threshold crossing alert) will bgenerated. Threshold setting for multiple parameters or time periods reqmultiple SET-TH commands from the OS.



Input syntaxSET-TH-STS3C:[TID]:AID:CTAG::montype,thlev,[locn],[dirn],[tmper];


Field Purpose















ALL


All OC-3 facilities




ALSPUASP

ALL

Coding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathAIS/LOP second - PathUnavailable Seconds - Path



DFLT



locn nullNENDFEND


dirn nullTRMTRCV



ALL





P) at

ons

Example input Set the threshold for near-end receive STS-3c path coding violations (CV100 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 violati(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;



met

uires

rom lation

SET-TH-T1The Set Threshold T1 command instructs the network element to set thethreshold level for a PM monitored DS1 parameter. When this threshold isor exceeded, an autonomous message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods reqmultiple SET-TH commands from the OS.



Input syntaxSET-TH-T1:[TID]:AID:CTAG::montype,thlev,[locn],[dirn],[tmper];


Field Purpose




















montype CVLESLSESL

CVP ESP SESP

SEFSP

SASPCSSPUASP

ALL

Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds - Line

Coding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathSeverely errored frame seconds - PathSEF / AIS Seconds - PathControlled slip seconds - PathUnavailable Seconds - Path



DFLT



locn nullNENDFEND


—continued—



for

) at

Example inputSet the threshold for near-end receive line coding violations (CVL) at 100the 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 the default threshold for near-end receive line coding violations (CVL100 for the 15-minute accumulation period: 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;

dirn nullTRMTRCV



ALL







met

uires

rom lation

SET-TH-T3 The Set Threshold T3 command instructs the network element to set thethreshold level for a PM monitored DS3 parameter. When this threshold isor exceeded, an autonomous message (threshold crossing alert) will be generated. Threshold setting for multiple parameters or time periods reqmultiple SET-TH commands from the OS.



Input syntaxSET-TH-T3:[TID]:AID:CTAG::montype,thlev,[locn],[dirn],[tmper];


Field Purpose















ALL


All DS3 facilities



montype CVLESLSESL

CVP ESP SESP

SASP UASP

ALL


Coding Violations - PathErrored Seconds - PathSeverely Errored Seconds - PathSEF / AIS Seconds - PathUnavailable Seconds - Path

Valid only with thlev of DFLT and tmper of ALL


DFLT



locn nullNENDFEND


dirn nullTRMTRCV



ALL





for

) at

Example input Set the threshold for near-end receive line coding violations (CVL) at 100the 15-minute accumulation period for DS3 slot 9: SET-TH-T3:SEATTLE:DS3-9:CTAG12::CVL,100,NEND,RCV,15-MIN;

Set the default threshold for near-end receive line coding violations (CVL100 for the 15-minute accumulation period: 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;


13-1

ch

iables,

TARP detailed command descriptions 13-

This chapter is an alphabetical summary of the TL1 commands related toTARP provisioning. The command descriptions in this chapter identify eacommand, and describe the command purpose, syntax, parameters, varand response.


Command Page

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-2 TARP detailed command descriptions

ED-TARP-CONFIGThe Edit TARP Configuration command is used to configure the TARP processor parameters as required.


Input syntaxED-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];


TARP detailed command descriptions 13-3

Table 13-1

Syntax definition

Field Purpose



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

KEYWORD=Domain See Parameter descriptions table for details

Table 13-2

Parameter descriptions


TMODE PROPAGATIONORIGINATIONBOTHNONE

Default: BOTH

TARP mode

NSEL A number including 2 hexadecimal digits Network selector

LIFE A decimal number that ranges from 0 to 65535

Default: 100 hops

PDU lifetime

PTYPE A number including 2 hexadecimal digits

Default: FE for CLNP

Protocol address type

SEQ A decimal number that ranges from 0 to 65535

Default: 0

PDU sequence number

—continued—



Example inputReset the TMODE and T1 parameter to the default on network element NEWYORK:

ED-TARP-CONFIG:NEWYORK::CTAG123::RESET:TMODE=,T1=;

THROTTLE A decimal number grouping

Throttle default: 300Period default: 2

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

Default: 15 seconds

TARP type 1 message response waiting period

T3 A decimal number that ranges from 0 to 3600

Default: 40 seconds

Address resolution request response waiting period

LDBFLUSH A decimal number that ranges from 0 to 1440

Default: 5 minutes

Loop detection buffer flush

TDCFLUSH A decimal number that ranges from 0 to 1440

Default: 1440 minutes

TARP data cache flush

LDBELIFE A decimal number that ranges from 1 to 10

Default: 5 minutes

Loop detection buffer entry life

Table 13-2





able al

ED-TARP-TBLThe Edit TARP Tables command is used to edit the disabled adjacency t(DAT), disabled circuit/port table (DCT), loop detection buffer (LDB), manuadjacency table (MAT), and TARP data cache (TDC).


Input syntaxED-TARP-TBL:<TID>::<CTAG>::TABLE,OPERATION:[LDBENTRY=Domain][,TDCENTRY=Domain][,MATENTRY=Domain][,DATENTRY=Domain][,DCTENTRY=Domain];

Table 13-3

Syntax definition

Field Purpose



TABLE DAT - Disabled adjacency tableDCT - Disabled circuit/port tableLDB - Loop detection bufferMAT - Manual adjacency tableTDC - TARP data cache

OPERATION ADD - Adds a new entryDEL - Deletes an entryFLUSH - Flushes the table




r

the

Table 13-4


Note: Add or delete the parameter(s) from the specified TABLE. Eitheparameter is mandatory if the OPERATION is either ADD or DEL. If OPERATION is FLUSH, the parameter(s) is ignored and all entries onspecified TABLE are deleted.

Keyword Description Value

LDBENTRY Loop detection buffer entry 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



DATENTRY Disabled adjacency table entry NSAP or SystemID



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



Example inputDelete all entries from LDB table:

ED-TARP-TBL:OTTAWA::CTAG12::LDB,FLUSH;



TEF
OPR-TARP-TEF
The Operate TARP TEF (TARP Echo Function) command is used supportfor trouble shooting. It is similar to the ping function in the IP network.


Input syntaxOPR-TARP-TEF:<TID>::<CTAG>::ADDRTYPE,ADDRESS:[ITERATION=Domain][,RATE=Domain][,TIMEOUT=Domain];

Table 13-5Syntax definitions

Field Purpose



ADDRTYPE Remote address type can be TID or NSAP

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



Parameter Description Possible values

ITERATION Iterations of number TARP Type 5 messages to be transmitted

A decimal number that ranges from 1 to 65535

Default: 1

RATE Rate of sent requests

Wait for a response before sending each request (in milliseconds)


Default: 1000

TIMEOUT The maximum time to wait for a response to each echo request (in milliseconds)


Default: 1500



Input exampleOPR-TARP-TEF:OTTAWA::CTAG12::TID,NEWYORK;

Example inputPerform a TARP-TEF:TEF:SEQ=1,TID=NEWYORK,NSAP=490000000075D0082E00,TIME=70TEF:SENT 1, RECEIVED 1,MTNTM/AVETM/MAXTM=70/70/70, SUCCESS=100%

Table 13-7Output parameters for TEF

Parameter Description Value

TEF TARP echo function indicator A string with a maximum of 20 characters

SEQ Sequence number A decimal number

TID Target identifier A string with a maximum of 20 characters

NSAP NSAP A number with a maximum of 40 hexadecimal digits

TIME Response time in milliseconds A decimal number



RP

K:

RTRV-TARP-CONFIGThe Retrieve TARP Configuration command is used to retrieve all the TAconfiguration parameters.


Input syntaxRTRV-TARP-CONFIG:<TID>::<CTAG>;

Example inputRetrieve the TARP configuration parameter for network element NEWYORRTRV-TARP-CONFIG:NEWYORK::CTAG12;

Response block syntaxTMODE=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


Field Purpose





TMODE PROPAGATIONORIGINATIONBOTHNONE

TARP mode

NSAP A number including a maximum of 40 hexadecimal digits

NSAP

NSEL A number including 2 hexadecimal digits Network selector

SEQ A decimal number that ranges from 0 to 65535 PDU sequence number

PTYPE A number including 2 hexadecimal digits Protocol address type

—continued—



LIFE A decimal number that ranges from 0 to 65535

Default: 100 hops

PDU lifetime

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

T3 A decimal number that ranges from 0 to 3600 Address resolution request response waiting period

LDBFLUSH A decimal number that ranges from 0 to 1440

Default: 5 minutes

Loop detection buffer flush

TDCFLUSH A decimal number that ranges from 0 to 1440

Default: 1440 minutes

TARP data cache flush

LDBELIFE A decimal number that ranges from 1 to 10

Default: 5 minutes

Loop detection buffer entry life





he led ble

RTRV-TARP-TBLThe Retrieve TARP Tables command is used to retrieve the contents of tcomputed TARP adjacency (ADJ), disabled adjacency table (DAT), disabcircuit/port table (DCT), loop detection buffer (LDB), manual adjacency ta(MAT), and TARP data cache (TDC).


Input syntaxRTRV-TARP-TBL:<TID>::<CTAG>::TABLE;

Table 13-10

Syntax definition

Example inputRetrieve the TARP table ADJ on network element OTTAWA:RTRV-TARP-TBL:OTTAWA::CTAG12::ADJ;

Field Purpose



TABLE ADJ - Computed TARP adjacencyDAT - Disabled adjacency tableDCT - Disabled circuit/port tableLDB - Loop detection bufferMAT - Manual adjacency tableTDC - TARP data cache


Parameter Description Possible values

NSAP NSAP NSAP is a number including a maximum of 40 hexadecimal digits

SYSID System ID A 12 hexadecimal digit

SeqNumber Sequence number A decimal number

PortID Port identifier LANLAN-ROUTERDCC-ROUTERDCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12



Response block table


Table Parameter Value

ADJ NSAP

SystemID

PORT ID

Up to 40 hexadecimal digit numbers

A 12 hexadecimal digit number

LANLAN-ROUTERDCC-ROUTERDCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12

DAT NSAP

SystemID



DCT Port ID LANLAN-ROUTERDCC-ROUTERDCC-3, DCC-4, DCC-5, DCC-6, DCC-7, DCC-8, DCC-9, DCC-10, DCC-11, DCC-12

LDB System ID

SeqNumber


A decimal number

MAT NSAP

SystemID



TDC TID

NSAP

A string of up to 20 characters



14-1

the s in ,

TBOS detailed command descriptions 14-

This chapter is an alphabetical summary of the TL1 commands related totelemetry byte-oriented serial feature (TBOS). The command descriptionthis chapter identify each command, and describe the command purposesyntax, parameters, variables, and response.


Command Page

RTRV-TBOS 14-2

SET-TBOS 14-4


14-2 TBOS detailed command descriptions

d a ts in are

s,

ul sed.

or d by an

y.

RTRV-TBOS The Retrieve TBOS command returns a report with a standard header andisplay array listing current assignments of all assigned network elementhe TBOS span of control by TBOS page number. TBOS page numbers previously assigned using the SET-TBOS command.

Adjacent will be TID and columns indicating critical, major, and minor alarmcolumns for the first 4 (or 4 most important) environmental alarms, and aremote 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 powerfremote surveillance tool, independent of whether an actual TBOS link is u

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 LIOthe office alarm contact of the head-end network element can be retrieveentering the RTRV-TBOS command at that network element. This gives 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 arra


Input syntaxRTRV-TBOS:[TID]::CTAG;



Example input Retrieve TBOS for a network span whose head end is NEWYORK: RTRV-TBOS:NEWYORK::CTAG23;

Field Purpose




TBOS detailed command descriptions 14-3

s used

, E3, hese rms in

e ng, TBOS

Response block syntaxDISPLAYSID CR MJ MN E1 E2 E3 E4 RM-----------------------------------------------------[^]+ <display> [^]+ <sid> [ ^<*|.|?>]+

Example normal responseSID 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 columncontaining periods (.), asterisks (*), or question marks (?). Each column is to indicate a condition. A period indicates normal status.

The asterisks under the display header row symbols CR, MJ, MN, E1, E2E4, and RM, correspond to alarm conditions at each network element. Trepresent critical, major and minor alarms, the first four environmental alain numeric order, and the remote alarm indicator, respectively. The nameeach row under SID identifies the SID of the network element.

Question marks show that the network element has not been found in thTBOS traffic flow. This can mean that the network element is not functioniit cannot be reached, or the SID has been changed but not updated in the display page.



ith a

ated d-end

page

half for

OS play

nts.

SET-TBOS The Set TBOS command sets up the TBOS display number associated wparticular network element, to enable single-ended TBOS operations.

This means that one network element in a TBOS span of control is designthe head-end network element and is always numbered 1. From the heanetwork element the RTRV-TBOS command can be used to monitor the conditions of all other network elements that have been assigned a TBOSnumber.

For OC-3 Express, each network element being monitored by TBOS hasa display (32 data bits instead of 64). Therefore, the traditional 8 displaysstandard TBOS become 16 displays for OC-3 Express.

If the SID is changed then the new name will not be recognized by the TBdisplay mapper. To reassign the network element to the correct TBOS disnumber, use the SET-TBOS command.

Note: This command is also used to delete TBOS mapping assignmeSee the procedure for deleting TBOS mapping assignments in TL1 Network Surveillance, 323-1051-520.


Input syntaxSET-TBOS:[TID]:DISPLAY#:CTAG::SID;

Note: The SID field is not used when deleting a TBOS mapping assignment.


Field Purpose


DISPLAY# The display number assigned in the TBOS display, from 1 to 16


SID The system identifier of the network element associated with DISPLAY#


TBOS detailed command descriptions 14-5

is

s the ally.

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:

Note: The series of question marks at BOSTON1 indicate that TBOSunable to connect to the remote node. Such a state causes a TBOS connection failure alarm to be raised. Every 30 seconds, TBOS retrieconnection. If the connection is established, the alarm clears automaticThe 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 mappingassignment table retrieved.

SID yy-mm-dd hh:mm:ss

M CTAG12 COMPLD

"DISPLAY SID CR MJ MN E1 E2 E3 E4 RM "

"-------------------------------------- "

" 1 NEWYORK . . * * . . . * "

" 2 SYRACUSE . * . . . . . . "

" 3 ROCHESTER. . . . . . . . "

" 4 BOSTON1 ? ? ? ? ? ? ? ? "

;


15-1

apter

Alarm, events, and external controls detailed command descriptions 15-

This chapter is an alphabetical summary of the TL1 commands related toalarm, events, and external controls. The command descriptions in this chidentify each command, and describe the command purpose, syntax, parameters, variables, and response.


Command Page

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

—continued—


15-2 Alarm, events, and external controls detailed command descriptions

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

Command Page


Alarm, events, and external controls detailed command descriptions 15-3

me

h the

T

ALW-MSG-ALLThe Allow Messages All command instructs the network element to resupreviously inhibited REPT-ALM, REPT-ALM-ENV, REPT-EVT and REPT-EX autonomous messages. These messages are inhibited througuse of the INH-MSG-ALL command.

When a TL1 session begins, REPT-ALM, REPT-ALM-ENV, and REPT-EVmessages are allowed by default.

To inhibit messages see INH-MSG-ALL.


Input syntaxALW-MSG-ALL:[TID]:[ALL]:CTAG;



Example input Restart all autonomous message from network element BOSTON3: ALW-MSG-ALL:BOSTON3::CTAG12;

Field Purpose





is tered.

INH-MSG-ALLThe Inhibit Message All command is used to stop all REPTÂLM, REPTÂLMÊNV, REPTÊVT and REPTÊX autonomous messages. It meant to be used during maintenance to keep the terminal screen unclut

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.


Input syntaxINH-MSG-ALL:[TID]:[ALL]:CTAG;



Example inputTurn off all messages from the network element NEWYORK: INH-MSG-ALL:NEWYORK::CTAG12;

Field Purpose





off

ing

OPR-ACO-ALLThe Operate Alarm Cutoff All command instructs a network element to cutthe office audible alarm indications without changing the other alarm indications.

The result of the OPR-ACO-ALL command is identical to manually pressthe ACO button on the network element circuit pack.

There is no complementary release command for ACO.


Input syntaxOPR-ACO-ALL:[TID]:[ALL]:CTAG;



Example inputStop the audible alarm in network element NEWYORK: OPR-ACO-ALL:NEWYORK::CTAG12;

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

Field Purpose





f the lays

e and.

in lers

ls

OPR-EXT-CONTThe Operate External Controls command is used to turn on one or more ofour external control relays. The network element is equipped with four rethat can be configured for normally closed or normally open operation.

The contact number parameter is mandatory and grouping is allowed. Thcontrol type parameter is not required, but can be used to parse the comm

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 LIGHTthe CONTTYPE field would cause the command to fail (and prevent sprinkfrom being accidentally turned on).

To turn off external control relays see the RLS-EXT-CONT command.


Input syntaxOPR-EXT-CONT:[TID]:AID:CTAG::[CONTTYPE];


CAUTIONBe careful not to turn on external controls that activate a potential danger such as sprinklers or miscellaneous controconnected to possibly hazardous systems or equipment.

Field Purpose


AID Access identifier, the contact number from 1 to 4


CONTTYPE Optional parameter, the type of control for which the control state is being set



:

TLE:



Example inputTurn on the air conditioner on relay 1 at network element WASHINGTONOPR-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 SEATOPR-EXT-CONT:SEATTLE:2&3:CTAG12::GEN;


CONTACT NO. 1 to 4 Identify the contact number

ALL ALL Activate all external relays.

Not allowed when CONTTYPE is null.

Grouping #&#&#, #= 1 to 4 Identify multiple contacts


CONTTYPE null Optional parameter (ALL)

Not allowed when AID is ALL

AIRCOND Air conditioning

ENGINE Engine

FAN Fan

GEN Generator

HEAT Heat

LIGHT Light

MISC Miscellaneous

SPKLR Sprinkler



idle

r wrap

RLS-EXT-CONTThe Release External Control command is used to switch any of the fourelectrical relays, for controlling external devices, from operative mode to mode.

The external control relays can be configured for either normally closed onormally open mode and are connected to external devices through wire-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.


Input syntaxRLS-EXT-CONT:[TID]:AID:CTAG::[CONTTYPE];


Field Purpose







ent



Example inputSwitch 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 elemWASHINGTON: RLS-EXT-CONT:WASHINGTON:2&3:CTAG45::ENGINE&FAN;



ALL ALL Release relays 1 to 4

ALL not allowed if CONTTYPE is null.

Grouping #&#&#, #=1 to 4 Multiple contacts for example 1,2


CONTTYPE null Optional parameter (ALL)

Not allowed when AID is ALL

AIRCOND air conditioning

ENGINE engine

FAN fan

GEN generator

HEAT heat

LIGHT light

MISC miscellaneous

SPKLR sprinkler



ay .

red

RTRV-ALM-ALL The Retrieve Alarm All command retrieves all the current alarms from thespecified network elements.

The RTRV-ALM-ALL command retrieves only alarmed conditions. To displnon-alarmed conditions and events use the RTRV-COND-ALL command

Note: This command will not retrieve cleared alarms. To retrieve cleaalarms refer to the RTRV-AO command.


Input syntaxRTRV-ALM-ALL:[TID]:[ALL]:CTAG;



Example inputRetrieve all the alarms from network element SEATTLE: RTRV-ALM-ALL:SEATTLE::CTAG12;

Response block syntax<aid>,<aidtype>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>

Field Purpose





Table 15-11Alarm report AID descriptions

<aid> <aidtype> Fault description Failure type

DS1-slot#-port# T1 T1 signal Facility

DS3-slot# T3 T3 signal Facility

EC1-slot#-sts#-vtg#-vt# VT1 VT1 fault Facility

EC1-slot# STS1 STS-1 fault Facility

OC3-slot#-sts#-vtg#-vt# VT1 VT1 fault Facility

OC3-slot#-sts# STS1 STS-1 fault Facility

OC3-slot# OC3 OC-3 signal fault Facility

OC3-slot# EQPT OC-3 circuit pack Equipment

DS1-slot# EQPT DS1 mapper Equipment

DS3-slot# EQPT DS3 mapper Equipment

EC1-slot# EQPT EC-1 circuit pack Equipment

EIM-slot# EQPT EIM circuit pack Equipment

VTX-slot# EQPT Virtual tributary cross-connect

Equipment

COM COM Data communications Equipment

PSC EQPT Protection switch controller (DS1 1-28)

Equipment

PSX EQPT Protection switch extender (DS1 29-84)

Equipment

SP COM Shelf processor Equipment

Note: AIDs can be identical for both facility and equipment but will be accompanied by different condition descriptions.



Table 15-12Alarm report field descriptions

Parameter Values Applicable AIDs

Description

<ntfcncde> CR MJ MN

all Critical alarm Major alarmMinor alarm

<condtype> EQPT all Critical alarm caused by equipment failure

INT all Internal hardware fault/failure

SWEQPT workingEQPT AID

Protection switching equipment failure

ESW OC3, VTX Excessive switching

LOS facility AID Loss of signal

LOF facility AID Loss of frame

APSMM EQPT Automatic protection switch mode mismatch

APSC facility AID Automatic protection switch channel failure

AIS facility AID Alarm indication signal detected

INC facility AID Incoming failure condition

SLMF STS1 facility AID

Signal label match failure

FA EQPT Failure of Power A or B

SYNCPRI EQPT Primary synchronization signal lost

SYNCSEC EQPT Secondary synchronization signal lost

LOP OC3 facility Loss of pointer

<srveff> SANSA

all Service affectingNot service affecting

<ocrdat> mm-dd all The date when the alarm occurred

<ocrtm> hh:mm:ss all The time when the alarm occurred

—continued—



<locn> NEND all Failure at the near end of the system

FEND all Failure at the far end of the system

<dirn> NA all Not applicable

RCV facility AID Receive direction only

TRMT all Transmit direction only

null all Not applicable

<conddescr> character string all The detailed text description of the trouble.

Table 15-12 (continued)Alarm report field descriptions


Description



Legend

Sample output SEATTLE 1995-01-01 00:00

CTAG12 COMPLDDS1-4:MJ,LOF,SA,01-01,00-00-19,NEND,RCV:”DS1 Rx Loss Of Frame”

;

Term Description

AIS Alarm Indication Signal detection

CR Critical alarm condition

ENV Environmental alarm

EQPT Equipment alarm

INC Incoming failure condition

INT Internal failure

MJ Major alarm condition

MN Minor alarm condition

NA Not Applicable

NSA Non Service Affecting

Rx Receive

RFI Remote Fault Indicator

SA Service Affecting

SDCC Section Data Communication Channel

Tx Transmit

VT Virtual Tributary



bout

RTRV-ALM-ENVThe 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 aproblems with physical premises.


Input syntaxRTRV-ALM-ENV:[TID]:AID:CTAG::[NTFCNCDE],[ALMTYPE];






Field Purpose




NTFCNCDE Optional, the notification code indicating severity; grouping allowed

ALMTYPE Optional, the alarm type indicating the specific nature of the problem; grouping allowed


contact number 1 to 16 identify the contact number

ALL ALL all contacts

Grouping #&#&#, #= 1 to 16 Grouping of multiple AIDs separated by “&” ampersands



Description

<ntfcncde> CR all Critical alarm

MJ all Major alarm

MN all Minor alarm



<almtype> AIRCOMPR all Air compressor failure

AIRCOND all Air conditioning failure

AIRDRYR all Air dryer failure

BATDSCHRG all Battery discharging

BATTERY all Battery failure

CLFAN all Cooling fan failure

ENGINE all Engine failure

ENGOPRG all Engine operating

EXPLGS all Explosive gas

FIRDETR all Fire detector failure

FIRE all Fire

FLOOD all Flood

FUSE all Fuse failure

GEN all Generator failure

HIAIR all High airflow

HIHUM all High humidity

HITEMP all High temperature

HIWTR all High water

INTRUDER all Intrusion

—continued—



Description



<almtype> LWBATVG all Low battery voltage

LWFUEL all Low fuel

LWHUM all Low humidity

LWPRES all Low cable pressure

LWTEMP all Low temperature

LWWTR all Low water

MISC all Miscellaneous

OPENDR all Open door

PUMP all Pump failure

POWER all Commercial power failure

PWR-48 all 48-V power supply failure

RECT all Rectifier failure

RECTHI all Rectifier high voltage

RECTLO all Rectifier low voltage

SMOKE all Smoke

TOXICGAS all Toxic gas

VENTN all Ventilation system failure



Description



Example inputRetrieve 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;

Response block syntax<aid>:<ntfcncde>,<almtype>,<ocrdat>,<ocrtm>,<almmsg>


Parameter Values ApplicableAIDs

Description

<ocrdat> mm-dd all the date when the alarm occurred

<ocrtm> hh-mm-ss all the time when the alarm occurred

<almmsg> character string all the detailed text description of the trouble



ion

on

RTRV-ALMID-rrThe Retrieve Alarm Identification command retrieves the alarm identificatnumbers for alarms.


Input syntaxRTRV-ALMID-rr:[TID]::CTAG;


Table 15-18Values for rr

Example input Retrieve alarm identification numbers for all alarms which can be inhibitednetwork element BOSTON3: RTRV-ALMID-ALL:BOSTON3::CTAG12;

Response block syntaxAlm ID AID Alarm Text-------------------------------<almid> <aid> <almtext>

Field Purpose



Applicable rr Description

ALL All available alarms

COM Common alarms

EIM EIM circuit pack

EQPT Equipment

FAC ILAN circuit pack

STS1 STS1 facility





ALMID non-zero unsigned integer

Alarm identification number

ALMTEXT character string Alarm text



tput ). The nts, r

d

The

RTRV-AOThe Retrieve Automatic Output command retrieves a list of automatic ou(AO) messages on the shelf processor (SP) or the network processor (NPmessage list provides historical autonomous messages including all evealarms and environmental alarms. The AO list cannot be deleted, reset, oaltered. 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 anREPT-EVT messages in the Automatic Reports chapter.

Note: This command retrieves alarms and conditions that are cleared.notification code is CL for cleared alarms.


Input syntax On the shelf processorRTRV-AO:[TID]::CTAG:::[ATAGSEQ=Domain],[MSGTYPE=Domain];


On the network processorRTRV-AO:[TID]::CTAG;

Note: ALL is not a valid target identifier (TID).


Field Purpose



ATAGSEQ Automatic tag sequential. The sequential equivalent of a CTAG, issued by the system when the event record is generated.

MSGTYPE Message type. Specifies what type of activity is to be retrieved.



ntial

twork

:

Example input Retrieve SP automatic output messages requesting automatic tag sequefrom network element WASHINGTON:RTRV-AO:WASHINGTON::CTAG12:::ATAGSEQ=123&124&235;

Retrieve SP automatic output messages of message type alarm from neelement SEATTLE:RTRV-AO:SEATTLE::CTAG12:::,MSGTYPE=ALM;

Retrieve NP automatic output messages from network element SEATTLERTRV-AO:SEATTLE::CTAG12;

Response block syntaxAlarm 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.



iated y.

RTRV-ATTR-CONTThe Retrieve Attributes Controls command retrieves the attributes assocwith external controls. The attributes are the text strings assigned by theSET-ATTR-CONT command, which identify the function of the control rela


Input syntaxRTRV-ATTR-CONT:[TID]:AID:CTAG::[CONTTYPE];




Field Purpose




CONTTYPE Control type, optional parameter, the type of control for which the control state is being set



ALL ALL Display all contacts

Grouping #&#&#, #=1 to 4 Group multiple AIDs separated by “&” ampersands



rom

ent


Example inputRetrieve 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 fnetwork element WASHINGTON: RTRV-ATTR-CONT:WASHINGTON:ALL:CTAG75::AIRCOND;

Retrieve the status of all engine and generator relays from network elemSEATTLE: RTRV-ATTR-CONT:SEATTLE:ALL:CTAG18::ENGINE&GEN;

Response block syntax<aid>:[<CONTTYPE>]


CONTTYPE AIRCOND Air conditioning

ENGINE Engine

FAN Fan

GEN Generator

HEAT heat

LIGHT light

MISC Miscellaneous

SPKLR Sprinkler



ne of

the

RTRV-ATTR-ENVThe Retrieve Attributes Environment command retrieves the attributes associated with environmental alarms.

The response displays what each environmental alarm register has beenprogrammed to represent. In the response, an alarm type field contains othe 36 allowed types, followed by an alarm message preprogrammed bycustomer to describe the precise details.


Input syntaxRTRV-ATTR-ENV:[TID]:AID:CTAG::[NTFCNCDE],[ALMTYPE];




Field Purpose


AID Access identifier, the contact number from 1 to 16, or ALL to display all contact numbers


NTFCNCDE Notification code for the environmental alarm; grouping allowed

ALMTYPE Alarm type for the environmental alarm; grouping allowed


CONTACT NO. 1 through 16 Identify the contact number

ALL ALL Display all contacts

Grouping #&#&#, #=1 through 16 Group multiple AIDs separated by ampersands (&)





Description

<ntfcncde> CR all Critical alarm

MJ all Major alarm

MN all Minor alarm











FIRE all Fire

FLOOD all Flood





HITEMP all High Temperature



—continued—



r
Example inputRetrieve all environmental alarms configured to represent either floods omajor 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;

Response block syntax<aid>:<NTFCNCDE>,<ALMTYPE>,\"<ALMMSG>\"

Note: The alarm message field <ALMMSG> is always prefixed and terminated with the characters backslash and quotation mark (\" ).


LWFUEL all Low fuel




LWWTR all Low water







RECTHI all 48-V rectifier high voltage


SMOKE all Smoke





Description



arm

d he

red

RTRV-COND-ALLThe Retrieve Conditions All command retrieves the current conditions (alor status) from the specified network elements.

The RTRV-COND-ALL command does not retrieve performance monitorethreshold crossings. To display performance monitored information use tRTRV-PM commands. To display environmental alarms use the RTRV-ALM-ENV command.

Note: This command will not retrieve cleared alarms. To retrieve cleaalarms refer to the RTRV-AO command.


Input syntaxRTRV-COND-ALL:[TID]:[ALL]:CTAG;



Example inputRetrieve all conditions from the network element SEATTLE: RTRV-COND-ALL:SEATTLE::CTAG12;

Field Purpose





Response block syntax<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>

Table 15-28Response parameters definition

Parameter Description

ntfcncde Notification code indicating severity of condition

condtype Condition type indicating the equipment or facility affected

srveff Service effect indicating whether the condition is service affecting

ocrdat Occurrence date indicating the day of the event

ocrtm Occurrence time indicating the hour of the event

locn Location indicating whether the event is near end or far end

dirn Direction indicating whether the event is incoming or outgoing

conddescr Condition description giving a textual outline of the event



utes

RTRV-CONDATTR-COMThe Retrieve Condition Attributes Common command retrieves the attribassociated with common alarms.


Input syntaxRTRV-CONDATTR-COM:[TID]:[ALMID]:CTAG;


Example inputRetrieve the condition attributes for the common alarm with identificationnumber 123 on network element NEWYORK: RTRV-CONDATTR-COM:NEWYORK:123:CTAG12;

Response block syntaxSHELF:COM,<almtext>,ALRM=ENABLED/DISABLED

Field Purpose


ALMID Alarm identification number, a non-zero unsigned integer




tes
RTRV-CONDATTR-rr
The Retrieve Condition Attributes command retrieves the condition attribuassociated with equipment and facility alarms.


Input syntaxRTRV-CONDATTR-rr:[TID]:[AID][,ALMID]:CTAG;



Field Purpose


AID Access identifier




EIMEIM-slot#-bridge#EIM-slot#-ALLEIM-ALLALL

EIM mapperslot# = 7 to 10bridge# = 1 to 2

EQPTOC3-slot#ALL

Equipment alarmsslot#=3 to 12


EC1-slot#-sts#EC1-ALLALL

STS-1 facility alarmsslot# = 3 to 12 sts# = 1 to 3

slot# = 3 to 10sts# = 1



h
Example inputRetrieve the condition attributes for all EIM circuit packs for the alarm witidentification number 123 on network element NEWYORK: RTRV-CONDATTR-EIM:NEWYORK:ALL:123:CTAG12;
Response block syntaxSHELF:EIM,<almtext>,ALRM=ENABLED/DISABLED



ernal and

rrect

RTRV-EXT-CONTThe Retrieve External Controls command retrieves the control state of extcontrols showing whether the control is Operated or Released. The commis 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 coinformation is retrieved.


Input syntaxRTRV-EXT-CONT:[TID]:AID:CTAG::[CONTTYPE];




Field Purpose




CONTTYPE Optional parameter, the type of control for which the control state is being retrieved. Grouping is allowed; use ampersand “&” as separator



ALL ALL Retrieve all external controls

Grouping #&#&#, #=1 to 4 Retrieve multiple contacts



Table 15-34Input parameter descriptions

Example inputRetrieve 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;

Response block syntax<aid>:[<CONTTYPE>],CONTS,<contstate>


Parameter Possible value Description

CONTTYPE AIRCOND air conditioning

ENGINE engine

FAN fan

GEN generator

HEAT heat

LIGHT light

MISC miscellaneous

SPKLR sprinkler


CONTS CONTS Duration is continuous, momentary is not supported

CONTSTATE OPER Operated

RLS Released



RTRV-NTFCNCDEThe Retrieve Alarm Notification command retrieves the current alarm notification setting for the specified network element.


Input syntaxRTRV-NTFCNCDE:[TID]::CTAG;


Example inputRetrieve the setting of the alarm notification code from network element OTTAWA5:RTRV-NTFCNCDE:OTTAWA5::CTAG12;

Response block syntaxNTFCNCDE=DFLT/ALT

Field Purpose





tatus

RTRV-STSBIPThe Retrieve STS Rx Excessive BIP Error status command retrieves the sof the STS Rx Excessive BIP Error alarm on the specified AIDs.


Input syntaxRTRV-STSBIP:[TID]:AID:CTAG;



Example inputRetrieve the STS Rx Excessive BIP Error alarm status from all the OC-3facilities on network element OTTAWA5:RTRV-STSBIP:OTTAWA5:OC3-ALL:CTAG12;

Response block syntax<aid>: STS Rx Excessive BIP Error: ALRM=DISABLED/ENABLED

Field Purpose


AID Access identifier, the facility to which the command applies






sts# = 1 to 3



slot# = 3, 5, 7, or 9 (Express)slot# = 1 (Express CX)

sts# = 1




icate

SET-ATTR-CONTThe Set Attributes Control command sets the attributes associated with external controls. The attributes are basically textual and are used to indwhat the external control is used for.


Input syntaxSET-ATTR-CONT:[TID]:AID:CTAG::[CONTTYPE];



Field Purpose







Grouping #&#&#, #=1 to 4 Group multiple AIDs separated by “&” ampersands




Example inputSet control relay 2 to display the air conditioning value (AIRCOND) for CONTTYPE on network element NEWYORK: SET-ATTR-CONT:NEWYORK:2:CTAG12::AIRCOND;


CONTTYPE AIRCOND Air conditioning

ENGINE Engine

FAN Fan

GEN Generator

HEAT heat

LIGHT light

MISC Miscellaneous

SPKLR Sprinkler



with ntal the e

rs

SET-ATTR-ENVThe Set Attributes Environment command sets the attributes associated environmental alarms. These attributes are included when an environmealarm is reported or retrieved. If all attributes are null value, it unassigns value of these attributes. If some of them are null, it keeps these null valuattributes unchanged.


Input syntaxSET-ATTR-ENV:[TID]:AID:CTAG::[NTFCNCDE],[ALMTYPE],[\"ALMMSG\"];

Note: The alarm message field must begin and end with the charactebackslash and quote (\" ).





Field Purpose




NTFCNCDE The notification code for the environmental alarm

ALMTYPE The alarm type for the environmental alarm

ALMMSG The text message, 1 to 40 characters, associated with the environmental alarm specified by the AID parameters


CONTACT NO. 1 to 16

null is not allowed

Identify the contact number

As a precautionary feature this parameter cannot be null.

Grouping #&#&#, #=1 to 16 Group multiple AIDs separated by ampersands (&)



Description

<ntfcncde> CRMJMN

all Critical alarmMajor alarmMinor alarm













FIRE all Fire

FLOOD all Flood








—continued—



Description



f
Example inputSet environmental alarm 2 to report a flood alarm with notification code omajor on network element NEWYORK: SET-ATTR-ENV:NEWYORK:2:CTAG12::MJ,FLOOD,\"FLOOD\";

LWFUEL all Low fuel




LWWTR all Low water









SMOKE all Smoke



<almmsg> character string all 1 to 40-character detailed text description of trouble



Description



utes alarm

ent

SET-CONDATTR-COMThe Set Condition Attributes Common command sets the condition attribassociated with common alarms. These attributes are included when an is reported or retrieved.


Input syntaxSET-CONDATTR-COM:[TID]:ALMID:CTAG:::[ALRM=Domain];



Example inputDisable the common alarm with alarm identification 123 on network elemNEWYORK: SET-CONDATTR-COM:NEWYORK:123:CTAG12:::ALRM=DISABLED;

Field Purpose




ALRM Alarm status. See the Parameter descriptions table for details.


ALRM ENABLED

DISABLED

Enable the specified alarm (default)

Disable the specified alarm



iated
SET-CONDATTR-rr
The Set Condition Attributes command sets the condition attributes assocwith alarms. These attributes are included when an alarm is reported or retrieved.


Input syntaxSET-CONDATTR-rr:[TID]:AID,ALMID:CTAG:::[ALRM=Domain];


Field Purpose


AID Access identifier



ALRM Alarm status. See the Parameter descriptions table for details.





Example inputDisable the alarm with alarm identification 123 for all EIM mappers on network element NEWYORK: SET-CONDATTR-EIM:NEWYORK:ALL,123:CTAG12:::ALRM=DISABLED;


EIMEIM-slot#-bridge#EIM-slot#-ALLEIM-ALLALL

EIM mapperslot# = 7 to 10bridge# = 1 to 2

EQPTOC3-slot#ALL

Equipment alarmsslot#=3 to 12


EC1-slot#-sts#EC1-ALLALL

STS-1 facility alarmsslot# = 3 to 12 sts# = 1 to 3

slot# = 3 to 10sts# = 1


ALRM ENABLED

DISABLED

Enable the specific alarm on the specified AID (default)

Disable the specific alarm on the specified AID



the and

SET-NTFCNCDEThe Set Alarm Notification command sets the alarm notification code for specified network element. The alarm notifications supported are defaultalternative.

Note: This command only applies to new alarms; it has no impact onalarms already raised.


Input syntaxSET-NTFCNCDE:[TID]::CTAG::[DFLT/ALT];


Example inputSet the alarm notification code to alternative on the network element OTTAWA5:SET-NTFCNCDE:OTTAWA5::CTAG12::ALT;

Field Purpose



DFLT/ALT Use default (DFLT) or alternate (ALT) notification code


SET-STSBIP-OFF
The Set STS Rx Excessive BIP Error Off command disables the STS RxExcessive BIP Error alarm on the specified AIDs.


Input syntaxSET-STSBIP-OFF:[TID]:AID:CTAG;



Example inputInhibit all the STS Rx Excessive BIP Error alarms from network element OTTAWA5:SET-STSBIP-OFF:OTTAWA5:ALL:CTAG12;

Field Purpose








sts# = 1 to 3




sts# = 1




ork

SET-STSBIP-ONThe Set STS Rx Excessive BIP Error On command allows the STS Rx Excessive BIP Error alarm to be reported on the specified AIDs.


Input syntaxSET-STSBIP-ON:[TID]:AID:CTAG;



Example inputAllow all the STS Rx Excessive BIP Error alarms to be reported from netwelement OTTAWA5:SET-STSBIP-ON:OTTAWA5:ALL:CTAG12;

Field Purpose








sts# = 1 to 3




sts# = 1



16-1

pply

mand

SDCC detailed command descriptions 16-

This chapter is an alphabetical summary of all the TL1 commands that ato the section data communications channel (SDCC). The command descriptions in this chapter identify each command, and describe the compurpose, 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.


Command Page

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-2 SDCC detailed command descriptions

a ID.

DLT-LLSDCC The Delete Lower Layer SDCC command is used to delete a section datcommunications channel (SDCC) link (layers 1 and 2) on the specified A


Input syntaxDLT-LLSDCC:[TID]:AID:CTAG;



Example inputDelete the lower layer SDCC link for the OC-3 circuit pack in slot 7:DLT-LLSDCC:NEWYORK:OC3-7:CTAG34;

Field Purpose


AID Access identifier. The OC-3 or EC-1 equipment to act on.




EC-1 AID EC1-slot# Identify the EC-1 where slot# = 3, 5, 7, or 9


SDCC detailed command descriptions 16-3

hen .

use

ED-LLSDCC The Edit Lower Layer SDCC command is used to modify editable layer 2parameters of the section data communications channel (SDCC) link. Wthe SDCC link is provisioned, default values are set for these parameters

Execute the edit command at the far end first since all edit commands cathe 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.


Input syntaxED-LLSDCC:[TID]:AID:CTAG:::<Keyword=Domain>;



Field Purpose




Keyword Layer 2 parameters that can be modified. See the Keyword descriptions table for details.


OC3 AID OC3-slot# Identify the OC-3 where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)

EC1 AID EC1-slot# Identify the EC-1 where slot# = 3, 5, 7, or 9




Parameter Valid values Comments

Range Default

L2INFO 512 to 1492 1304 bytes

This parameter is the frame size.

L2REX 2 to 16 3 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.


L2NOA 4 to 120 s 10 s This parameter is the no activity timer.


L2IF 1 to 127 7 This parameter is the outstanding I-frame count.


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.



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.



e

Example inputChange 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 thterminal endpoint identifier to 25:ED-LLSDCC:WASHINGTON:OC3-11:CTAG23:::L2NOA=100,L2INFO=1492,L2TEI=25;



of the is

t to you te

A1, his

ED-ULSDCC The Edit ULSDCC command is used to change manual area addresses section data communications channel (SDCC) link. When the SDCC linkprovisioned, MANAREA0 has a default setting of 49000.

You must have at least one manual area address provisioned. If you wandelete the address in MANAREA0 and it is the only address provisioned,must first provision an address in MANAREA1 or MANAREA2, then delethe 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 MANAREenter the command to edit MANAREA1 and leave a blank for the domain. Tclears the address in MANAREA1. Then enter the command to edit MANAREA1 again, and enter the new address for the domain.


Input syntaxED-ULSDCC:[TID]::CTAG:::<Keyword=Domain>;



Field Purpose



Keyword MANAREA address. See the Keyword descriptions table for details.

Keyword Valid value Description

MANAREA0 maximum 26-character hexadecimal string

Area address 0 (default)

MANAREA1 Area address 1


Note: The MANAREA address must follow a standard format for data communications protocol.



Example inputEdit 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 2ED-ULSDCC:SEATTLE::CTAG34:::MANAREA2=;



AID CCs t at

the

ENT-LLSDCCThe Enter Lower Layer SDCC command is used to add a section data communications channel (SDCC) link (layers 1 and 2) onto the specified (equipment slot). The request is validated based on already configured SDon the pair of slots (the number of SDCCs already configured, the currenSDCC protection scheme) and the circuit pack currently provisioned in thslot or pair of slots.

If the request is successful, the addition request is carried through usingSDCC provisioning defaults. To change the provisioning defaults, see ED-LLSDCC.


Input syntaxENT-LLSDCC:[TID]:AID:CTAG;



Example inputAdd a lower layer SDCC link on the EC-1 circuit pack in slot 7:ENT-LLSDCC:NEWYORK:EC1-7:CTAG13;

Field Purpose





OC3 AID OC3-slot# Identify the OC-3 where slot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)

EC1 AID EC1-slot# Identify the EC-1 whereslot# = 3, 5, 7, or 9



n k for link .

t 5:

RTRV-LLSDCC The Retrieve Lower Layer SDCC command is used to retrieve informatioassociated with a given section data communications channel (SDCC) linlayers 1 and 2. The information includes the state of the layer 2 (LAPD) (IS-NR, OOS-AU) and the current settings of editable layer 2 parameters


Input syntaxRTRV-LLSDCC:[TID]:AID:CTAG;



Example inputRetrieve the lower layer SDCC information for the OC-3 circuit pack in sloRTRV-LLSDCC:NEWYORK:OC3-5:CTAG56;

Field Purpose


AID Access identifier. The OC-3 or EC-1 equipment to retrieve SDCC information from.




Identify the EC-1 where

slot# = 3, 5, 7, or 9 (Express)


Identify the OC-3 where


ALL ALL Retrieve SDCC information for all EC-1 and optical interface circuit packs



Response block syntaxAID::L2INFO=Domain,L2REX=Domain,L2WAIT=Domain,L2NOA=Domain,L2IF=Domain,L2TEI=Domain,L2SAPI=Domain,L2TS=Domain,L2SIDE=Domain,PROT=N:IS,ACT



Range Default

L2INFO 512 to 1492 1304 bytes

This parameter is the frame size.

L2REX 2 to 16 3 This parameter is the retransmission count.


L2WAIT 2 to 200 2 This parameter is the waiting acknowledgment timer, in tenths of a second.


L2NOA 4 to 120 s 10 s This parameter is the no activity timer.


L2IF 1 to 127 7 This parameter is the outstanding I-frame count.


L2TEI 0 to 127 0 This parameter is the terminal endpoint identifier.



L2SAPI 0 to 63 62 This parameter is the service access point identifier.



—continued—



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.



Range Default



ses

RTRV-ULSDCC The Retrieve ULSDCC command is used to retrieve manual area addresprovisioned for the section data communications channel (SDCC) link.


Input syntaxRTRV-ULSDCC:[TID]::CTAG;



Example inputRetrieve the MANAREA addresses provisioned for network element NewYork:RTRV-ULSDCC:NEWYORK::CTAG12;

Response block syntaxMANAREA0=Domain,MANAREA1=Domain,MANAREA2=Domain

Field Purpose





MANAREA0 maximum 26-character hexadecimal string

Area address 0 (default)



Note: The MANAREA address must follow a standard format for data communications protocol.


17-1

iables,

press

Initialization detailed command descriptions 17-

This chapter is an alphabetical summary of the TL1 commands related toinitialization.The command descriptions in this chapter identify each command, and describe the command purpose, syntax, parameters, varand response.

All commands in this chapter are supported on the OC-3 Express and ExCX network elements and the network processor (NP).

The following table lists all commands in this chapter.

Command Page

INIT-COLD 17-2

INIT-WARM 17-4


17-2 Initialization detailed command descriptions

ct lize

essor

INIT-COLDThe Initialize Cold command instructs a network element to initialize its circuit packs. A cold initialization is equivalent to a power-up and can affetraffic. You can use the network processor as the target identifier to initiathe network processor.

The date and time must be reset on the network element and network procafter a system restart.


Input syntaxINIT-COLD:[TID]:AID:CTAG;


Field Purpose


Note: You must use the network processor as the target identifier to initialize the NP.

AID Access identifier. The circuit pack to initialize.



Initialization detailed command descriptions 17-3


Example input Perform a cold initialization of OC-3 in slot 12 only on network element WASHINGTON: INIT-COLD:WASHINGTON:OC3-12:CTAG13;


equipment DS3-slot# Identify the DS3 whereslot#=3 to 10 (Express)slot#= 1 to 2 (Express CX)

EC1-slot# Identify the EC-1 whereslot#=3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC3-slot# Identify the OC-3 whereslot#=3 to 12 (Express)

VTX-slot# Identify the VTX whereslot#=13 or 14 (Express)

MTX-slot# Identify the MTX whereslot#=3 or 4 (Express CX)

EIM-slot# Identify the EIM whereslot#= 7 to 10 (Express)

ILAN-slot# Identify the ILAN whereslot#= 16 (Express)

PSC Protection switch controller

SP Shelf processor

NP Network processor



INIT-WARM
The Initialize Warm command instructs a network element to initialize itscircuit packs. A warm initialization does not affect traffic.

The date and time must be reset after a system restart.


Input syntaxINIT-WARM:[TID]:AID:CTAG;


Field Purpose



AID Access identifier. The circuit pack to initialize.



Initialization detailed command descriptions 17-5


Example input Perform a warm initialization of OC-3 in slot 12 only on network element WASHINGTON: INIT-WARM:WASHINGTON:OC3-12:CTAG12;


equipment DS3-slot# Identify the DS3 whereslot#=3 to 10 (Express)slot#= 1 to 2 (Express CX)

EC1-slot# Identify the EC-1 whereslot#=3 to 10 (Express)slot#= 1 to 2 (Express CX)

OC3-slot# Identify the OC-3 whereslot#=3 to 12 (Express)

VTX-slot# Identify the VTX whereslot#=13 or 14 (Express)

MTX-slot# Identify the MTX whereslot#=3 or 4 (Express CX)

PSC Protection switch controller

SP Shelf processor

NP Network processor



18-1

path h iables,

Path and section trace detailed command descriptions 18-

This chapter is an alphabetical summary of the TL1 commands related toand section trace. The command descriptions in this chapter identify eaccommand, and describe the command purpose, syntax, parameters, varand response.

The following table lists the commands in this chapter.

Command Page

ED-STS1 18-2

RTRV-PTHTRC-STS1 18-4

RTRV-TRC-OC3 18-6


18-2 Path and section trace detailed command descriptions

ing
ED-STS1
The Edit STS1 command is used to edit the expected incoming or outgopath trace values, or both path trace values.


Input syntaxED-STS1:[TID]:AID:CTAG::[MON]:[EXPTRC=Domain],[TRC=Domain];



Field Purpose


AID Access identifier. The STS-1 facility to act on.


MON Path trace monitoring


Purpose

AID DS3-slot#

OC3-slot#-sts#

Identifies the DS3 STS-1 path facilitywhere DS3 slot# = 3, 5, 7, or 9 (Express)

Identifies the OC-3 STS-1 path facilitywhere

OC-3 slot# = 3 to 12 (Express)OC-3 slot# = 3 to 4 (Express CX)

sts# = 1 to 3


Path and section trace detailed command descriptions 18-3


ExampleEdit the path trace value:ED-STS1:NEWYORK:OC3-11-1:CTAG13::ON:EXPTRC=NEWYORKOC3-11-1,TRC=TXPATHDS3-5;


MON ON

OFF (default)

Enables path trace monitoring

Disables path trace monitoring

EXPTRC(See Note)

Any ASCII string of up to 62 characters

Expected incoming path trace message

TRC(See Note)

Any ASCII string of up to 62 characters

Outgoing path trace message

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.



d ath.

RTRV-PTHTRC-STS1The Retrieve Path Trace STS-1 command is used to retrieve the expecteincoming, actual incoming, or outgoing path trace values for a given STS p


Input syntax RTRV-PTHTRC-STS1:[TID]:AID:CTAG::[MSGTYPE][,MON];



Field Purpose


AID Access identifier. The STS-1 facility to act on.


msgtype EXPTRC (default), expected incoming path trace messageINCTRC, incoming path trace messageTRC, outgoing path trace message


Purpose

AID DS3-slot#

OC3-slot#-sts#

Identifies the DS3 STS-1 path facilitywhere DS3 slot# = 3, 5, 7, or 9 (Express)

Identifies the OC-3 STS-1 path facilitywhere

OC-3 slot# = 3 to 12 (Express)OC-3 slot# = 3 to 4 (Express CX)

sts# = 1 to 3



trace


Example inputRetrieve the expected incoming path trace message and include the pathmonitoring value: RTRV-PTHTRC-STS1:NEWYORK:OC3-11-1:CTAG45::EXPTRC,YES;

Response block syntaxtrace messageMON = ON/OFF


MON YESNO (default)

Includes path trace monitoring valueNot include path trace monitoring value



ing, ility.

1 on

RTRV-TRC-OC3The Retrieve Trace OC-3 command is used to retrieve the expected incomactual incoming, or outgoing section trace values for a specified OC-3 fac


Input syntaxRTRV-TRC-OC3:[TID]:AID:CTAG::[MSGTYPE];




Example inputRetrieve the outgoing section trace message for the OC-3 facility in slot 1network element SEATTLE: RTRV-TRC-OC3:SEATTLE:OC3-11:123::STRC;

Field Purpose




MSGTYPE Section trace message type. See the Parameter descriptions table for details.


OC3 OC3-slot# Identify the OC-3 facility where slot#= 3 to 12


Description

MSGTYPE STRC Outgoing section trace message (default)

EXPSTRC Expected incoming section trace message

INCSTRC Actual incoming section trace message



Response block syntaxsection trace message



STRC 0 to 255ASCII string

Outgoing section trace message

EXPSTRC 0 to 255ASCII string

Expected incoming section trace message

INCSTRC 0 to 255ASCII string

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.


19-1

d to ntify s,

ork ee

ys

Network processor command descriptions 19-

This chapter is an alphabetical summary of all the TL1 commands relatethe network processor (NP). The command descriptions in this chapter ideeach command, and describe the command purpose, syntax, parametervariables, 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 netwelement, for example, network security and administration commands, sother appropriate sections in this document.

Note: The target identifier (TID) in the commands in this chapter is alwathe NP to which the command is directed.


Command Page

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

—continued—


19-2 Network processor command descriptions

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

Command Page


Network processor command descriptions 19-3

e NP NP

I

ADD-SOCThe Add Span of Control command is used to add a network element to thspan of control. A maximum of 16 network elements can be added to anspan of control.


Input syntaxADD-SOC:[TID]:netid:CTAG::neuid,nepid;

Note: Passwords entered in TL1 commands are not echoed to the Uscreen.


Example inputAdd network element NEWYORK to the span of control of OC3NP:ADD-SOC:OC3NP:NEWYORK:CTAG13::SURVEIL,SURVEIL;

Field Purpose


NETID The TID of the network element to be added to the NP span of control


NEUID The user identifier of the network element to be added to the NP span of control

NEPID The password of the network element to be added to the NP span of control



s

DLT-FACThe Delete Facility command is used to delete an NP facility. NP facilitieinclude ILANSP, ILANNP, ILAN1, ILAN2, COLAN, and X25. ILANSP andILANNP are autoprovisioned and cannot be manually deprovisioned.


Input syntaxDLT-FAC:[TID]:AID:CTAG;



Example inputDelete the ILAN-2 facility on OC3NP:DLT-FAC:OC3NP:ILAN2:CTAG24;

Field Purpose


AID Access identifier. The NP facility to act on.



AID ILAN1ILAN2COLANX25

Intershelf LAN-1Intershelf LAN-2Central office LANX.25



VC.

DLT-PVCThe Delete Permanent Virtual Circuit (PVC) command deletes an X.25 PDeleting a PVC restores the circuit to a switched virtual circuit (SVC) withdefault values from ULX25.


Input syntaxDLT-PVC:[TID]:AID:CTAG;


Example inputDelete 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.

Field Purpose


AID Access identifier. The PVC to delete. Valid values are 0-15




meters
ED-IP
The Edit IP command is used to edit the IP address and associated paraassigned to the COLAN on the NP.


Input syntax ED-IP:[TID]::CTAG::[IPADDR]:[Keyword=Domain,][Keyword=Domain];



Field Purpose



ipaddr 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

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


NETMASK 0.0.0.0 (default)Class A: 255.n.n.nClass B: 255.255.n.nClass C: 255.255.255.nClass D: 255.255.255.nClass E: 255.255.255.n

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.

GATEWAY 0.0.0.0 (default)n.n.n.n

COLAN default gateway.Router for packets with unknown destination. The value 0.0.0.0 will delete the currently provisioned gateway.

BCASTADDR 0.0.0.0 (default)n.n.n.n

COLAN broadcast address.The value 0.0.0.0 means the broadcast address is assigned automatically by the NP based on the IP address.



Example inputChange 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;



ters
ED-LLX25
The Edit Lower Level X.25 command is used to edit the common paramefor all virtual circuits (VC) on the X.25 LAPB level.


Input syntax ED-LLX25:[TID]::CTAG:::<Keyword=Domain>;


Example inputModify the T3 and the N2 parameters: ED-LLX25:OC3NP::CTAG45:::T3=20000,N2=20;

Field Purpose



Domain Value assigned to the lower level X.25 parameters. See keyword descriptions table for details



Range Default

T1 500-10000 ms 500 ms Acknowledgment timer in milliseconds (500 ms increment)

T3 10000-300000 ms 30000 ms Link inactivity timer in milliseconds

N1 1080-16440 bits 1080 bits Maximum length of an I frame in bits (increments of 8)

N2 1-30 30 Maximum number of retransmissions

K 1-7 or 1-127 7 Window size for the transmitter based on LLX25 MODULUS value

MODULUS 8 or 128 8 Sequence number range



e
ED-PTX25
The Edit X.25 Physical Port Configuration command is used to modify thphysical port configuration of X.25.


Input syntax ED-PTX25:[TID]::CTAG:::<Keyword=Domain>;


Field Purpose



Domain Value assigned to the X.25 port. See keyword description table for details



Range Default

RXCLKSRC RXEXT, TXEXT RXEXT Source of receive clock

TXCLKSRC RXEXT, TXEXT TXEXT Source of transmit clock

CTS_PIN ENABLEDDISABLED

ENABLED CTS pin configuration

DCD_PIN ENABLED DISABLED

DISABLED DCD pin configuration

DSR_PIN ENABLEDDISABLED

DISABLED DSR pin configuration

DTR_PIN ENABLEDDISABLED

ENABLED DTR pin configuration

RTS_PIN ENABLEDDISABLED

ENABLED RTS pin configuration

—continued—



Example inputModify the X.25 port configuration of OC3NP: ED-PTX25:OC3NP::CTAG45:::RXCLKSRC=RXEXT,TXCLKSRC=RXEXT;

DSR ON, OFF ON DSR pin initial value when DSR_PIN is enabled

DTR ON, OFF ON DTR pin initial value when DTR_PIN is enabled

RTS ON, OFF, AUTO ON RTS pin initial value when RTS_PIN is enabled

Note: When the range is set to AUTO , the RTS value is under hardware control.

Table 19-10 (continued)Keyword descriptions


Range Default



resses hich

t to you te

a nge, e

ars 1

ED-ULSDCCThe 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 addcan be provisioned. The manual area address identifies the network to wthe 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 wandelete the address in MANAREA0 and it is the only address provisioned,must first provision an address in MANAREA1 or MANAREA2, then delethe address in MANAREA0.

To change a manual area address, you must ensure that at least two areaddresses are provisioned. You must delete the address you want to chathen add the new address. For example, to change MANAREA1, enter thcommand to edit MANAREA1 and leave a blank for the domain. This clethe address in MANAREA1. Then enter the command to edit MANAREAagain, and enter the new address for the domain.


Input syntax ED-ULSDCC:[TID]::CTAG:::<Keyword=Domain>;


Field Purpose



Domain Value assigned to the manual area address. See keyword descriptions table for details



MANAREA0 6-26 characters, each character representing a half byte (3-13 bytes)

Network layer area address 0 (default)

MANAREA1 Network layer area address 1

MANAREA2 Network layer area address 2



Example inputEdit 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=;



ters

se

,

r

t

ED-ULX25The Edit Upper Level X.25 command is used to edit the common paramefor all switched virtual circuits (SVCs) on the X.25 network level.

Note 1: To edit the parameters for a permanent virtual circuit (PVC), uthe ED-VC command (page 19-15).

Note 2: Changes to any of the following ULX25 parameters cause allcurrent SVC calls to be lost and all PVC calls to be restarted: TXSIZERXSIZE, WNDW, MODULUS, T20, N20, T21, T22, T23, N22, N23, oDBIT.

Note 3: Changes to any of the following ULX25 parameters only affecnew calls: NUI, NEGFLOWCTRL, NEGTXSIZE, NEGRXSIZE, NEGTXWNDW, NEGRXWNDW, NEGTRPTCLS, NEGTXTRPT, or NEGRXTRPT.


Input syntax ED-ULX25:[TID]::CTAG:::<Keyword=Domain>;


Field Purpose



Domain Value assigned to the upper level X.25 parameters. See keyword descriptions table for details



Range Default

TXSIZE 16-4096 128 Maximum transmitting packet size

RXSIZE 16-4096 128 Maximum receiving packet size

WNDW 1-7 or 1-127 2 Packet window size based on ULX25 MODULUS value

MODULUS 8 or 128 8 Sequence number range

—continued—



Example inputModify the TXSIZE and the RXSIZE parameters: ED-ULX25:OC3NP::CTAG45:::TXSIZE=256,RXSIZE=256;

T20 5-500 sec 180 sec Data terminating equipment (DTE) restart time-out (5 sec increment)

N20 1-255 1 Number of T20 retries

T21 5-500 sec 200 sec DTE call request time-out (5 sec increment)

T22 5-500 sec 180 sec DTE reset time-out (5 sec increment)

T23 5-500 sec 180 sec Declare time-out (5 sec increment)



DBIT Yes/No Yes Delivery confirmation option

NUI Maximum 20 ASCII characters

NULL string

Network user identification (SVC only)

NEGFLOWCTL ON/OFF OFF Negotiate flow control (NFC)

NEGTXSIZE 16-4096 128 (Note 1)

NFC: Tx packet size

NEGRXSIZE 16-4096 128 (Note 1)

NFC: Rx packet size

NEGTXWNDW 1-7 or 1-127 2 (Note 1) NFC: Tx window size based on ULX25 MODULUS value

NEGRXWNDW 1-7 or 1-127 2 (Note 1) NFC: Rx window size based on LIX25 MODULUS value

NEGTRPTCLS ON/OFF OFF Negotiate throughput class

NEGTXTRPT 7-11 10 (Note 2) Throughput class: speed of transmitter

NEGRXTRPT 7-11 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.

Table 19-14 (continued)Keyword descriptions


Range Default



the to 5

an and ee cuit e

ED-VCThe Edit Virtual Circuit (VC) command modifies the parameter values of specified permanent virtual circuit (PVC). This command cannot be usedmodify a switched virtual circuit (SVC). To modify SVCs, use the ED-ULX2command (page 19-13).

You can use ED-VC to change an SVC to a PVC, or to change a PVC toSVC. To change an SVC to a PVC, you must specify the values of LCGNLCN. Default values of TXSIZE and RXSIZE are available from ULX25 (sTable 19-16). To change a PVC to an SVC, the PVC is deleted and the ciris restored as an SVC with default parameter values from the ULX25 (seTable 19-16).


Input syntaxED-VC:[TID]:AID:CTAG::type:<Keyword=Domain>;


Field Purpose


AID Access identifier. The VC number to act on. Valid values are 0-15. Null is not a valid value


type The VC type, SVC or PVC

Domain The value to be assigned to the parameter. See keyword descriptions table for details



t to

DW

Example inputChange 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 se0 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 WNreset to default value 2.



Range Default

T21 5-500 sec 200 sec DTE call request time-out

T22 5-500 sec 180 sec DTE reset time-out

T23 5-500 sec 180 sec Declare time-out



DBIT Yes/No Yes Delivery confirmation option

WNDW 1-7 or 1-127 2 Packet window size based on ULX25 MODULUS value

LCGN 0-7 (see Note) Logical channel group number

LCN 0-255 (see Note) Logical channel number

TXSIZE 16-4096 128 Maximum transmitting packet size

RXSIZE 16-4096 128 Maximum receiving packet size

Note: Values for LCGN and LCN must be provided when switching an SVC to a PVC.



ies

ENT-FACThe Enter Facility command is used to provision an NP facility. NP facilitinclude ILANSP, ILANNP, ILAN1, ILAN2, COLAN, and X25. ILANSP andILANNP cannot be manually provisioned.


Input syntaxENT-FAC:[TID]:AID:CTAG;



Example inputProvision the ILAN-2 facility:ENT-FAC:OC3NP:ILAN2:CTAG24;

Field Purpose


AID Access identifier. The NP facility to act on.



AID ILAN1ILAN2COLANX25

Intershelf LAN-1Intershelf LAN-2Central office LANX.25



ment

:

RMV-SOCThe Remove Span of Control command is used to remove a network elefrom the NP span of control.


Input syntaxRMV-SOC:[TID]:netid:CTAG;


Example inputRemove network element NEWYORK from the span of control of OC3NPRMV-SOC:OC3NP:NEWYORK:CTAG13;

Field Purpose


netid The TID of the network element to be removed from the NP span of control




ted by the tory e file

RTRV-CHK-SUMThe Retrieve Check Sum command is used to retrieve the checksum creathe NP after a file transfer from the TransportNode INM Broadband. Afterfile transfer, the NP calculates the checksum of the files in the given direcand the INM Broadband retrieves the checksum to verify the success of thtransfer. This command is normally used by the INM Broadband.


Input syntaxRTRV-CHK-SUM:[TID]::CTAG::LOC=DirectoryName;


Example inputRetrieve checksums for three files, load1, load2, and load3, stored in thedirectory /load/v2:RTRV-CHK-SUM:OC3NP::CTAG13::LOC=/load/v2;

Response block syntaxFILE=FileName,SIZE=FileSize,SUM=ChkSum

Note: The NP returns one response block for each file.


Field Purpose



DirectoryName The absolute path to the directory where the NP checksum is stored. DirectoryName must start with the root directory

Keyword Description

FILE Name of the file

SIZE File size in bytes

SUM Checksum as a decimal number (16 bits)



of the

he

RTRV-CONFIGThe Retrieve Configuration command provides the topology information the network. PCGUI generates a MAP view based on the information fromRTRV-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 tnetwork element in the span of control.


Input syntaxRTRV-CONFIG:[TID]::CTAG;


Response block syntaxNETID:NETID-Eqpt-slot-P, NETID-Eqpt-slot-P, NETID-Eqpt-slot-P,...


Field Purpose



Keyword Description

NETID TID of the SP that is in the NP span of control

Eqpt Transport equipment

slot Shelf slot number

P Protection status. If Y, there is protection. If N, there is no protection.



lity.
RTRV-FAC
The Retrieve Facility command is used to retrieve the state of an NP faciNP facilities include ILANSP, ILANNP, ILAN1, ILAN2, COLAN, and X25. States of all facilities can be retrieved.


Input syntaxRTRV-FAC:[TID]:AID:CTAG;



Table 19-26NP facility state

Field Purpose


AID Access identifier. The NP facility to retrieve.



AID ILANSPILANNPILAN1ILAN2COLANX25ALL

Intershelf LAN to SP communicationIntershelf LAN to NP communicationIntershelf LAN-1Intershelf LAN-2Central office LANX.25All facilities

Facility State Description

NULL Facility not provisioned or manually deprovisioned. This state does not apply to ILAN-SP and ILAN-NP

IS Facility in service. No alarms or fault conditions detected.

OOS-AU, FLT Facility failure

IS-ANR,FLT Facility performance degraded



Example inputRetrieve the X25 facility of OC3NP:RTRV-FAC:OC3NP:X25:CTAG24;

Response block syntaxAID::state



ted TL1

RTRV-IPThe Retrieve IP command is used to retrieve the IP address and associaparameters assigned to the COLAN on the NP. COLAN allows the NP tocommunicate with the TransportNode INM Broadband and OC-3 Express Managed Object Agent (MOA) over TCP/IP.


Input syntaxRTRV-IP:[TID]::CTAG;


Example inputRetrieve the IP address of the OC3NP:RTRV-IP:OC3NP::CTAG24;

Response block syntaxIP=n.n.n.nNETMASK=n.n.n.nGATEWAY=n.n.n.nBCASTADDR=n.n.n.n

Field Purpose





vel
RTRV-LLX25
The Retrieve Lower Level X.25 command is used to retrieve the LAPB leparameters of the X.25 facility.


Input syntaxRTRV-LLX25:[TID]::CTAG;


Example inputRetrieve the X.25 facility of the OC3NP:RTRV-LLX25:OC3NP:X.25:CTAG24;

Response block syntaxKeyword=Domain


Field Purpose




TYPE DTE Data terminating equipment

LINKS Number of LAPB links

T1 500-10 000 Acknowledgment timer in milliseconds

T3 10 000-300 000 Link inactivity timer in milliseconds

N1 1080-16440 Maximum length of an I frame in bytes

N2 1-30 Maximum number of retransmissions

K 1-7 or 1-127 Window size for the transmitter based on the LLX25 MODULUS value

MODULUS 8 or 128 Sequence number range



ve
RTRV-PTX25
The Retrieve X.25 Physical Port Configuration command is used to retriethe X.25 port configuration.


Input syntax RTRV-PTX25:[TID]::CTAG;


Example inputRetrieve the X.25 port configuration of OC3NP: RTRV-PTX25:OC3NP::CTAG45;

Response block syntax ::Keyword=Domain

Field Purpose





RXCLKSRC RXEXT, TXEXT Source of receive clock

TXCLKSRC RXEXT, TXEXT Source of transmit clock

CTS_PIN ENABLED, DISABLED CTS pin configuration (input pin)

DCD_PIN ENABLED, DISABLED DCD pin configuration (input pin)

DSR_PIN ENABLED, DISABLED DSR pin configuration (input pin)

DTR_PIN ENABLED, DISABLED DTR pin configuration (output pin)

RTS_PIN ENABLED, DISABLED RTS pin configuration (output pin)

DSR ON, OFF DSR pin initial value (when DSR_PIN is enabled)

DTR ON, OFF DTR pin initial value (when DTR_PIN is enabled)

RTS ON, OFF, AUTO RTS pin initial value (when RTS_PIN is enabled)



k

g a he

RTRV-SOCThe Retrieve Span of Control command is used to retrieve all the networelements in the NP span of control.

Note: The status of the network elements in the span of control (usinsurveil account on the NP) is independent from the MAP view when tMAP view is retrieved since they use different links.


Input syntaxRTRV-SOC:[TID]::CTAG;


Example inputRetrieve the span of control of OC3NP:

RTRV-SOC:OC3NP::CTAG24;

Response block syntaxNETID::SW_VER:STATUS


Field Purpose



Keyword Description

NETID Target identifier of the network element

SW_VER The software version of the shelf processor (SP) if STATUS is UP

STATUS UP: SP to NP association upDOWN: SP to NP association downXPID: password mismatch

Note: All span of control connections are DOWN until the surveillance account (level 5 UPC) is activated.



area

ss is

RTRV-ULSDCCThe Retrieve Upper Level SDCC command is used to retrieve the manualaddress of the OC-3 Express OSI stack on the NP.


Input syntaxRTRV-ULSDCC:[TID]::CTAG;


Example inputRetrieve the MANAREA addresses provisioned on OC3NP:RTRV-ULSDCC:OC3NP::CTAG24;

Response block syntaxMANAREA0=value, MANAREA1=value, MANAREA2=value

where value is a string of up to 26 ASCII characters, or blank if the addrenot provisioned.

Field Purpose





evel
RTRV-ULX25
The Retrieve Upper Level X.25 command is used to retrieve the network lX.25 parameters.


Input syntaxRTRV-ULX25:[TID]::CTAG;


Example inputRetrieve the packet level X.25 parameters of OC3NP:RTRV-ULX25:OC3NP::CTAG24;

Response block syntax::Keyword=Domain

Field Purpose





CCITTVER String of 10 characters CCITT Version

MAXCIR Maximum circuits supported

MAXINTR Maximum DTE interfaces supported

TXSIZE 16-4096 Maximum transmitting packet size

RXSIZE 16-4096 Maximum receiving packet size

WNDW 1-7 or 1-127 Packet window size based on ULX25 MODULUS value

MODULUS 8 or 128 Sequence number range

T20 5-500 sec DTE restart time-out (5 sec increment)

N20 1-255 Number of T20 retries

—continued—



T21 5-500 sec DTE call request time-out (5 sec increment)

T22 5-500 sec DTE reset time-out (5 sec increment)

T23 5-500 sec Declare time-out (5 sec increment)



DBIT Y/N Delivery confirmation option

NUI Maximum 20 ASCII characters

Network user identification (SVC only)

NEGFLOWCTL ON/OFF Negotiate flow control (NFC)

NEGTXSIZE 16-4096 NFC: Tx packet size

NEGRXSIZE 16-4096 NFC: Rx packet size

NEGTXWNDW 1-7 or 1-127 NFC: Tx window size based on ULX25 MODULUS value

NEGRXWNDW 1-7 or 1-127 NFC: Rx window size based on ULX25 MODULUS value

NEGTRPTCLS ON/OFF Negotiate throughput class

NEGTXTRPT 7-11 Throughput class: speed of transmitter

NEGRXTRPT 7-11 Throughput class: speed of receiver

Table 19-36 (continued)Response block description




C)
RTRV-VC
The Retrieve Virtual Circuit command is used to retrieve a virtual circuit (Vand its parameter settings.


Input syntaxRTRV-VC:[TID]:AID:CTAG;


Example inputRetrieve VC #11:RTRV-VC:OC3NP:11:CTAG24;

Response block syntaxAID:TYPE:Keyword=Domain

where TYPE is SVC or PVC. See Table 19-38 for a description of the keywords.

Field Purpose


AID Access identifier. The VC number to be acted upon. Valid values are 0-15. Null is not a valid value.





Keyword Description

T21 Data terminating equipment (DTE) call request time-out

T22 DTE reset time-out

T23 Declare time-out

N22 Number of T22 retries

N23 Number of T23 retries

DBIT Delivery confirmation option

WNDW Packet window size

LCGN (PVC) Logical channel group number

LCN (PVC) Logical channel number

TXSIZE (PVC) Maximum transmitting packet size

RXSIZE (PVC) Maximum receiving packet size


20-1

d to ns in ,

work

Software upgrade detailed command descriptions 20-

This chapter is an alphabetical summary of all the TL1 commands relateupgrading software on the OC-3 Express shelf. The command descriptiothis chapter identify each command, and describe the command purposesyntax, parameters, variables, and response.

All commands in this chapter are supported on both the OC-3 Express netelement and the network processor (NP).


Command Page

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-2 Software upgrade detailed command descriptions

a
CANC-UPGRD
The Cancel Upgrade command allows you to back out of the upgrade, if commit upgrade command has not been issued.


Input syntaxCANC-UPGRD:[TID]::CTAG::RNAME;


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;


Field Purpose



RNAME Remote node name (applies to the SP only)


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


Software upgrade detailed command descriptions 20-3

new OPC,

he

n

e NP

CHK-UPGRDThe Check Upgrade command is entered with parameters specifying therelease number and where to get the files containing the new loads (PC, another network element).

When CHK-UPGRD is issued from the network element user interface, tshelf processor checks if the specified location is reachable and does a pre-upgrade check to see if the network element can be upgraded. WheCHK-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 thcan be upgraded.


Input syntaxCHK-UPGRD:[TID]::CTAG::RNAME,RELNO;


Field Purpose



RNAME The name of the node from which the new loads are retrieved.

The node can be of the following types:


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



ent
Example input Check that network element Ottawa can be upgraded from network elemTORONTO:CHK-UPGRD:OTTAWA::CTAG24::TORONTO,NTNA6021;
Check that OC3NP can be upgraded from another NP:CHK-UPGRD:OC3NP::CTAG25::OC3NP2,NTNA6021;



NP to mmit

CMMT-UPGRDThe Commit Upgrade command causes the new loads on the SP or the become the permanent load. You cannot cancel the upgrade once the coupgrade command has been executed.


Input syntaxCMMT-UPGRD:[TID]::CTAG;

Example input Commit the upgrade load on network element OTTAWA:CMMT-UPGRD:OTTAWA::CTAG24;

Commit the upgrade load on OC3NP:CMMT-UPGRD:OC3NP::CTAG25;


Field Purpose





load

:

DLT-UPGRDThe Delete Upgrade command is used to delete a release of a software stored on the NP.


Input syntaxDLT-UPGRD:[TID]::CTAG::RELNO;

Example input Delete the software release REL0310D.TT on network element OTTAWADLT-UPGRD:OTTAWA::CTAG24::REL0310D.TT;


Field Purpose



RELNO ASCII string identifying the release number to delete



e cuted. e NP be

INVK-UPGRDWhen issued from the network element user interface, the Invoke Upgradcommand causes the new shelf processor and transport loads to be exeThe new transport load runs on each transport card. When issued from thuser interface, the Invoke Upgrade command causes the new NP load toexecuted.


Input syntaxINVK-UPGRD:[TID]::CTAG;

Example input Invoke the upgrade on network element NEWYORK:INVK-UPGRD:NEWYORK::CTAG24;

Invoke the upgrade on OC3NP:INVK-UPGRD:OC3NP::CTAG25;


Field Purpose





stalls ut

:

LOAD-REPLACEThe Load Replace command is only available on the NP. Load Replace ina software load specified in the TL1 command into the file system, withoupgrading to it. This makes the load available for upgrades by the local network processor or other connected network elements or network processors.


Input syntaxLOAD-REPLACE:[TID]::CTAG::RNAME,RELNO:[ALRMS=Domain];


Example input Install load REL0400A.DM from OPC MONTREAL onto NP OTTAWANPLOAD-REPLACE:OTTAWANP::CTAG1::MONTREAL,REL0400A.DM;


Field Purpose



RNAME Name of the node or OPC where the load files reside

RELNO Release number to install on NP. See Parameter descriptions table for details.

ALRMS=Domain Check alarms. See Parameter descriptions table for details.


RNAME 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 ASCII string identifying the release number to upgrade to

ALRMS If Y, proceed only if there are no alarms

If N, proceed regardless of the alarm status



the

shelf m the sport,

LOAD-UPGRDWhen issued from the network element user interface, the Load Upgradecommand causes the new SP and transport loads to be downloaded intoshelf processor file system. The new transport load is transferred from theprocessor to each transport card in the network element. When issued froNP user interface, the Load Upgrade command causes the new SP, tranand NP loads to be downloaded into the NP file system.


Input syntaxLOAD-UPGRD:[TID]::CTAG::RNAME,RELNO:[ALRMS=Domain];


Field Purpose



RNAME Name of the node from which the new loads are retrieved. See Parameter description table for details.

RELNO Release number to upgrade to. See Parameter description table for details.

ALRMS Check alarms. See Parameter description table for details.




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;


RNAME The name of the node from which the new loads are retrieved. The node can be of different types:


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 ASCII string identifying the release number to upgrade to

ALRMS If YES, proceed only if there are no alarms

If NO, proceed regardless of the alarm status



space ile

RTRV-SPACEThe Retrieve Space command is used to retrieve the available file system to make sure there is enough space before putting a new release in the fsystem.


Input syntaxRTRV-SPACE:[TID]::CTAG;

Example input Retrieve the available file system space on OTTAWANP:RTRV-SPACE:OTTAWANP::CTAG24;

Response block“x bytes available”


Field Purpose





ases
RTRV-UPGRD
The Retrieve Upgrade command is used to retrieve the list of software releon the file system.


Input syntaxRTRV-UPGRD:[TID]::CTAG;

Example input Retrieve the list of software releases on OTTAWANP:RTRV-UPGRD:OTTAWANP::CTAG24;

Response block syntax“REL3DSUN.Q1”“REL30BU”“REL21BR”


Field Purpose




21-1

ress

ored ctive

ssage, e.

Automatic reports 21-This chapter is an alphabetical summary of each OC-3 Express and ExpCX network element TL1 automatic report. Automatic reports are the messages retrieved by the RTRV-AO command. Automatic reports are stin a random access memory (RAM) cache and are also broadcast to all aTL1 accounts when each event occurs.

The message descriptions in this chapter describe the purpose of the methe syntax, and parameters returned as part of the autonomous messag

Note: Automatic reports are sometimes referred to as autonomous messages.

The following table lists all commands in this chapter.

Command Page

REPTÂLM^COM 21-3

REPTÂLMÊC1 21-6

REPTÂLMÊNV 21-12

REPTÂLMÊIM 21-9

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

—continued—


21-2 Automatic reports

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ÊQPT 21-48

REPTÊVTÊC1 21-52

REPTÊVTÔC3 21-54

REPTÊVT^STS1 21-57

REPTÊVT^STS3C 21-29

REPTÊVT^T1 21-61

REPTÊVT^T3 21-64

REPTÊVT^VT1 21-67

REPTÊX 21-69

REPT^SOC 21-71

Command Page


Automatic reports 21-3

or to te or of

e of

at is:

REPT^ALM^COMReport Alarm Com is generated by a network element or network processreport alarms that affect the network processor or the shelf as a whole. Ingeneral, an alarmed event causes a standing condition and has immediapotential impact on the operation or performance of the entity. Some formmaintenance effort is required to restore normal operation or performancthe entity after the event has occurred.

Message formatAll parameters in this message are either positional or name defined.

<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^ALM^COM <cr> <lf><rspblk> + ;

The message must contain at least one occurrence of <rspblk>. Its form^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>, <locn>,<dirn>:<conddescr>" <cr> <lf>;

Table 21-1Syntax Definition

Field Purpose

<sid> The network element or NP source identifier

<date> In the format yy-mm-dd

<time> In the format hh:mm:ss

<almcde> Possible alarm code values in decreasing order of severity: *C (Critical alarm) ** (Major alarm) *^ (Minor alarm) A^ (Automatic message)

<atag> Automatic tag, the numerical identification of the message

<rspblk> Response block. See the following AID and Parameter description tables for details.






shelf tid user-defined shelf name Identify the network element

Shelf SHELF Identify the network element

SP SP Identify the shelf processor

NP NP Identify the network processor


Description

<ntfcncde> CRMJMNCL

all Critical alarmMajor alarmMinor alarmCleared alarm

<condtype> SYNCPRI shelf tid Switch to primary timing reference

SYNCSEC shelf tid Switch to secondary timing reference

INT all Internal software failure

FA shelf tid power failure

HLDOVRSYNC shelf tid Switch to holdover synchronization

FRNGSYNC shelf tid Switch to freerun

<srveff> SANSA



<ocrtm> hh-mm-ss all The time when the alarm occurred



<conddescr> Character string all The detailed text description of the trouble



Example messageAt 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>



ence

at is:

REPTÂLMÊC1Report Alarm EC1 is generated by a network element to report the occurrof EC-1 alarmed events. In general, an alarmed event causes a standingcondition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcd3>^<atag>^REPTÂLMÊC1 <cr> <lf><rspblk> + ;

The message must contain at least one occurrence of <rspblk>. Its form

^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>, <locn>,<dirn>:<conddescr>" <cr> <lf>


Field Purpose

<sid> The network element source identifier











EC1 facility AID EC1-slot# Identify EC-1 facility whereslot# = 3, 5, 7, or 9 (Express)slot# = 1 (Express CX)

Parameter Values Description

<ntfcncde> CRMJMNCL

Critical alarmMajor alarmMinor alarmCleared alarm

<condtype> LOS Loss of signal

LOF Loss of frame

INT Internal hardware fault/failure


<srveff> SA Service affecting

NSA Non service affecting

<ocrdat> mm-dd The date when the alarm occurred

<ocrtm> hh-mm-ss The time when the alarm occurred

<locn> NEND Near end

<dirn> NA RCVTRMT null

Not applicable Receive direction only Transmit direction only Not applicable

<conddescr> character string

The detailed text description of the trouble



r the
Example messages At 9 pm on October 17, 1995, the following alarm report was generated foEC-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>



nce nding

at is:

REPTÂLMÊIMReport Alarm EIM is generated by a network element to report the occurreof EIM bridge alarmed events. In general, an alarmed event causes a stacondition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcd3>^<atag>^REPTÂLMÊIM <cr> <lf><rspblk> + ;




Field Purpose












EIM bridge AID EIM-slot#-bridge# Identify the EIM bridge facility where slot#=7 to 10bridge#= 1 to 2


<ntfcncde> CRMJMNCL



LOF Loss of frame














dge
Example messages At 9 pm on April 17, 1998, the following alarm report was generated for brifacility 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>



he

at is:

REPTÂLMÊNVReport Alarm Environment is generated by a network element to report toccurrence of an environmental alarm.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPTÂLMÊNV <cr> <lf><rspblk> + ;

The message must contain at least one occurrence of <rspblk>. Its form^^^"<aid>:<ntfcncde>,<almtype>,<ocrdat>,<ocrtm>,<almmsg><cr> <lf>;





Field Purpose







AID type Purpose

1 to 16 Identify the contact



Description

<ntfcncde> CRMJMNCL














FIRE all Fire

FLOOD all Flood








—continued—



Description



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>


LWFUEL all Low fuel




LWWTR all Low water









SMOKE all Smoke





<almmsg> character string all The detailed text description of the trouble



Description



event e is e

at is:

REPTÂLMÊQPTReport Alarm Equipment is generated by a network element to report theoccurrence of alarmed equipment related events. In general, an alarmedcauses a standing condition and has immediate or potential impact on thoperation or performance of the entity. Some form of maintenance effort required to restore normal operation or performance of the entity after thevent has occurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPTÂLMÊQPT <cr> <lf><rspblk> + ;




Field Purpose











DS1 eqpt DS1-slot# Identify DS1 equipment whereslot# = 3 to 10 (Express)slot# = 1 to 2 (Express CX)


EC1 eqpt EC-slot# Identify EC-1 equipment whereslot# = 3 to 10 (Express)slot# = 1 to 2 (Express CX)

PSC eqpt PSC Identify the protection switch controller

VTX eqpt VTX-slot# Identify VTX equipment whereslot# = 13 or 14

OC3 eqpt OC3-slot# Identify OC-3 equipment whereslot# = 3 to 12 (Express)slot# = 1 to 2 (Express CX)

MTX eqpt MTX-slot# Identify MTX equipment whereslot# = 3 or 4

SP eqpt SP Identify the shelf processor

NP eqpt NP Identify the network processor




n the


Example messageAt 9 p.m. on October 17, 1995, an automatic diagnostic ran and passed oDS1 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>


Description

<ntfcncde> CRMJMNCL


<condtype> EQPT all Critical alarm caused by equipment failure

INT all Internal hardware fault/failure

SWEQPT “working”EQPT AID

Protection switching equipment failure

ESW OC3/VTX Excessive switching


<srveff> SANSA





<dirn> NARCV

all Not applicable Receive direction only

<conddescr> Character string all The detailed text description of the trouble



nt e is e

at is:

REPT^ALM^FACReport Alarm Facility is generated by a network processor to report the occurrence of alarmed facility related events. In general, an alarmed evecauses a standing condition and has immediate or potential impact on thoperation or performance of the entity. Some form of maintenance effort required to restore normal operation or performance of the entity after thevent has occurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^ALM^FAC <cr> <lf><rspblk> + ;




Field Purpose











Example messageAt 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>


NP facility AID ILAN1ILAN2COLANILANSPILANNPX25

Identify the NP facility



<ntfcncde> CRMJMNCL


<condtype> INT Internal software fault/failure












ed n the

is e

at is:

RTRVÂLMÎMA T1Report Alarm IMAT1 is generated by a network element to report the occurrence of IMA links and IMA DS1 alarmed events. In general, an alarmevent causes a standing condition and has immediate or potential impact ooperation or performance of the entity. Some form of maintenance effort required to restore normal operation or performance of the entity after thevent has occurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcd3>^<atag>^REPTÂLMÎMAT1 <cr> <lf><rspblk> + ;




Field Purpose












EIM T1 AID EIM-slot#-bridge#-vp#-t1# Identify the EIM bridge facility whereslot#=7 to 10bridge#=1 to 2vp#=1 to 8t1#=1 to 8


<ntfcncde> CRMJMNCL



LOF Loss of frame














dge
Example messages At 9 pm on April 17, 1998, the following alarm report was generated for brifacility 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>



ence

at is:

REPTÂLMÔC3Report Alarm OC3 is generated by a network element to report the occurrof OC-3 alarmed events. In general, an alarmed event causes a standingcondition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPTÂLMÔC3 <cr> <lf><rspblk> + ;




Field Purpose












OC3 facility AID

OC3-slot# Identify the OC-3 facility whereslot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)


<ntfcncde> CRMJMNCL



LOF Loss of frame



AIS Alarm indication signal detected












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>



rence g

at is:

REPT^ALM^STS1Report Alarm STS1 is generated by a network element to report the occurof STS-1 alarmed events. In general, an alarmed event causes a standincondition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^ALM^STS1<cr> <lf><rspblk> + ;




Field Purpose











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>


STS path AID OC3-slot#-sts# Identify the STS path where

Expressslot# = 3 to 12sts# = 1 to 3

Express CXslot# = 3 to 4sts# = 1 to 3

STS path AID EC1-slot#-sts# Identify the EC1 whereslot = 3, 5, 7, or 9sts# = 1


<ntfcncde> CRMJMNCL


<condtype> SLMF Signal label mismatch failure



<srveff> SA

NSA

Service affecting

Non service affecting




<dirn> RCV Receive direction only





ses a n or

at is:

REPT^ALM^STS3CReport Alarm STS3C is generated by a network element to report the occurrence of STS-3C alarmed events. In general, an alarmed event caustanding condition and has immediate or potential impact on the operatioperformance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^ALM^STS3C <cr> <lf><rspblk> + ;




Field Purpose











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>


STS-3C facility AID

OC3-slot# Identify the STS-3C facility where

slot# = 3 to 12


<ntfcncde> CRMJMNCL


<condtype> SLMF Signal label mismatch failure



<srveff> SA

NSA

Service affecting










nce

at is:

REPT^ALM^T1Report Alarm T1 is generated by a network element to report the occurreof 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 torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^ALM^T1 <cr> <lf><rspblk> + ;




Field Purpose












DS1 facility AID DS1-slot#-port# Identify the DS1 facility whereExpress:slot#=4 to 10port#=1 to 12



<ntfcncde> CRMJMNCL



LOF Loss of frame



AIS Alarm indication signal












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>



nce

at is:

REPT^ALM^T3Report Alarm T3 is generated by a network element to report the occurreof 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 torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcd3>^<atag>^REPT^ALM^T3 <cr> <lf><rspblk> + ;




Field Purpose












DS3 facility AID DS3-slot# Identify the DS3 facility where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)


<ntfcncde> CRMJMNCL



LOF Loss of frame















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>



ence es a n or

at is:

REPT^ALM^VPReport Alarm VP is generated by a network element to report the occurrof VP and IMA group alarmed events. In general, an alarmed event causstanding condition and has immediate or potential impact on the operatioperformance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcd3>^<atag>^REPT^ALM^VP <cr> <lf><rspblk> + ;




Field Purpose












EIM VP AID EIM-slot#-bridge#-vp# Identify the EIM bridge facility whereslot#=7 to 10bridge#=1 to 2vp#= 1 to 8


<ntfcncde> CRMJMNCL



LOF Loss of frame















dge
Example messages At 9 pm on April 17, 1995, the following alarm report was generated for brifacility 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>



ence g

at is:

REPT^ALM^VT1Report Alarm VT1 is generated by a network element to report the occurrof VT1.5 alarmed events. In general, an alarmed event causes a standincondition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required torestore normal operation or performance of the entity after the event hasoccurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^ALM^VT1 <cr> <lf><rspblk> + ;




Field Purpose












VT AID OC3-slot#-sts#-vtg#-vt# Identify the VT1.5 path on the OC-3 where

Expressslot#= 3 to 12 sts# = 1 to 3vtg#= 1 to 7vt#= 1 to 4

Express CXslot#= 3 to 4sts# = 1 to 3vtg#= 1 to 7vt#= 1 to 4


<ntfcncde> CRMJMNCL


<condtype> SLMF Signal label match failure



<srveff> SA

NSA

Service affecting










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>



that work ting

ear

REPT^CONFIG^CHGReport Configuration Change is generated when the functionality detectsthere may be a change in the configured network administered by the netprocessor. Typically this is due to expansion and reconfiguration of an exisnetwork. An example of this might be the upgrading of a point-to-point linnetwork to a linear ADM chain or the addition of nodes to a ring.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf><almcde>^<atag>^REPT^CONFIG^CHG <cr> <lf>;


Field Purpose




<almcde> A^ (Automatic message)




name

put

the

ive the or

REPT^DBCHGReport Database Change is generated by the network element to which achange (TID) or account change (UID) was made.


<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 out(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 TL1 session that originated the change.

Note 2: When issued for a UID change, REPT DBCHG is sent to all actTL1 sessions to the shelf processor or network processor that issuedchange. The affected TL1 sessions are those that have a UPC equalgreater to the UPC of the UID that was changed.


Field Purpose




<atag> 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

<rspblk> Response block. See the Parameter description tables for details.



ork

Table 21-45Response block parameters descriptions

Example messageAt 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 netwelement 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>


<msgtype> NNCSAC

NE name changeSystem account change

<netid> Target identifier

<oldtid> Old target identifier

<newtid> New target identifier

<olduid> Old user identifier

<newuid> New user identifier



or to

ential

e of

at is:

REPT^EVT^COMReport Event Com is generated by a network element or network processreport alarms that affect the network processor or the shelf as a whole. Ingeneral, an event causes a standing condition and has immediate or potimpact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performancthe entity after the event has occurred.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPT^EVT^COM <cr> <lf><rspblk> +

The message must contain at least one occurrence of <rspblk>. Its form^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>" <cr> <lf>



Field Purpose







SP SP Identify the network element

NP NP Identify the network processor

Shelf SHELF Identify the shelf



ent


Example messageAt 9 p.m. on March 17, 1997, during a software upgrade on network elemNEWYORK, 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 passedSlot(s) 05 06 09 10 11 12 13 14 15 passed"";<cr> <lf>


Description

<condtype> HLDOVRSYNCSWFTDWN

all Switch to holdover synchronization

<condeff> SCTCCL

all Standing condition raisedTransient conditionStanding condition cleared

<ocrdat> mm-dd all The date when the event occurred

<ocrtm> hh-mm-ss all The time when the event occurred

<conddescr> character string all The detailed text description of the trouble





orted elf is

at is:

REPTÊVTÊQPTReport Event Equipment is generated by a network element to report theoccurrence of non-alarmed equipment related events. The event being repcan be a change of status or the occurrence of an irregularity, which by itsnot severe enough to warrant an alarm notification.

Message formatAll 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> + ;

The message must contain at least one occurrence of <rspblk>. Its form^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>" <cr> <lf>


Field Purpose










DS1 eqpt DS1-slot# Identify DS1 equipment where

Expressslot# = 3 to 10port# = 1 to 12

Express CXslot# = 1 to 2 (Express CX)


EC1 eqpt EC-slot# Identify EC-1 equipment whereslot# = 3 to 10 (Express)slot# = 1 to 2 (Express CX)

PSC eqpt PSC Identify the protection switch controller

VTX eqpt VTX-slot# Identify VTX equipment whereslot# = 13 or 14

OC3 eqpt OC3-slot# Identify OC-3 equipment whereslot# = 3 to 12 (Express)

MTX eqpt MTX-slot# Identify MTX equipment whereslot# = 3 or 4

SP eqpt SP Identify the shelf processor

NP eqpt NP Identify the network processor






Description

<condtype> INHSWPR DS1 Switch to protection inhibited

INHSWWKG DS1 Switch to working inhibited

INIT-x all x=0: Warm initialization will occur.x=1: Cold initialization will occur

LPBKLINE DS3/DS1 Line looped back

MANSWTOINT VTX Manual synchronization switch to internal clock

MANSWTOPRI VTX Manual synchronization switch to primary reference

MANSWTOSEC VTX Manual synchronization switch to secondary reference

MANWKSWBK VTX/DS1 Manual switch of working facility or equipment back to working

MANWKSWPR VTX/DS1 Manual switch of working facility or equipment to protection unit

NORMAL all Return to normal conditions

OVRDSW VTX/DS1 Automatic protection switching overridden

PROTNA DS1 Protection unit not available

SWTOINT VTX Synchronization switch to internal clock

SWTOPRI VTX Synchronization switch to primary clock

SWTOSEC VTX Synchronization switch to secondary clock

WKSWBK VTX/DS1OC3

Working facility or equipment switched back to working

WKSWPR VTX/DS1OC3

Working facility or equipment switched to protection

<condeff> TC SCCL

all Transient condition Standing condition raisedStanding condition cleared

—continued—



his
Example messageAt 9 p.m. on March 21, 1997, the VTX in slot 13 switches to protection. Tmessage 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 ;

<ocrdat> mm-dd all The date when the event occurred

<ocrtm> hh-mm-ss all The time when the event occurred



<conddescr> character string all The detailed text description of the trouble



Description



ence hange

at is:

REPTÊVTÊC1Report Event EC1 is generated by a network element to report the occurrof non-alarmed EC-1 related events. The event being reported can be a cof status or the occurrence of an irregularity, which by itself is not severeenough to warrant an alarm notification.


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



Field Purpose






AID type Command-specific Values Purpose

EC1 eqpt EC1-slot# Identify EC-1 equipment whereslot# = 3 to 10 (Express)slot# = 1 (Express CX)




Table 21-55Montype parameter descriptions

Example messageAt 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>


<condtype> T-MONTYPE Threshold-crossing monitored threshold type

<condeff> TC SCCL

Transient conditionStanding condition raisedStanding condition cleared

<ocrdat> mm-dd Date when the event occurred

<ocrtm> hh-mm-ss Time when the event occurred

<locn> NENDFEND

Near endFar-end

<dirn> TRMTRCV

Transmit (away from the node)Receive (onto the node)

monval 1 and up Measured value of a monitored parameter

thlev 1 and up Threshold level for the monitored parameter


The accumulation time period


montype CVSESSSESSSEFSS

CVLESLSESLUASL


Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds- LineUnavailable Seconds - Line



ence hange

at is:

REPTÊVTÔC3Report Event OC3 is generated by a network element to report the occurrof non-alarmed OC-3 related events. The event being reported can be a cof status or the occurrence of an irregularity, which by itself is not severeenough to warrant an alarm notification.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPTÊVTÔC3 <cr> <lf><rspblk> + ;


^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>" <cr> <lf>



Field Purpose







OC3 eqpt AID OC3-slot# Identify the OC-3 whereslot# = 3 to 12 (Express)slot# = 1 to 4 (Express CX)







<condeff> TC SCCL




<locn> NENDFEND

Near endFar end

<dirn> RCVTRMT

Receive (onto the node) Transmit (away from the node)

<conddescr> text message Condition description






montype CVSESSSESSSEFSS

CVLESLSESLUASL


Coding Violations - LineErrored Seconds - LineSeverely Errored Seconds- LineUnavailable Seconds - Line



ns.
Example messageAt 9 p.m. on October 17, 1995, the OC-3 in slot 11 records bipolar violatioThis 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>



rence t

at is:

REPT^EVT^STS1Report Event STS1 is generated by a network element to report the occurof non-alarmed STS-1 related events. The event being reported can be achange of status or the occurrence of an irregularity, which by itself is nosevere enough to warrant an alarm notification.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPT^EVT^STS1 <cr> <lf><rspblk> + ;





Field Purpose







STS path AID OC3-slot#-sts# Identify the STS path whereslot# = 3 to 12 (Express)slot# = 3 to 4 (Express CX)

sts# = 1 to 3





Example messageAt 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>



<condeff> TC SCCL

Transient condition Standing condition raisedStanding condition cleared



<locn> NENDFEND

Near endFar end

<dirn> RCVTRMT









ALSPUASP

Coding Violations - PathErrored Seconds - PathSeverely Errored Seconds - Path

AIS/LOP Seconds - PathUnavailable Seconds - Path



rted elf is

at is:

REPT^EVT^STS3CReport Event STS3C is generated by a network element to report the occurrence of non-alarmed STS-3C related events. The event being repocan be a change of status or the occurrence of an irregularity, which by itsnot severe enough to warrant an alarm notification.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPT^EVT^STS3C <cr> <lf><rspblk> + ;





Field Purpose







STS-3C facility AID

OC3-slot# Identify the STS-3C facility whereslot# = 3 to 12






<cr> <lf> <lf> OC3NE01 95-10-17 21:00:00 <cr> <lf> A 123 REPT EVT STS3C <cr> <lf>

"OC3-3:,BPV" <cr> <lf>



<condeff> TC SCCL




<locn> NENDFEND

Near endFar end

<dirn> RCVTRMT









ALSPUASP

Coding Violations - PathErrored Seconds - PathSeverely Errored Seconds - Path

AIS/LOP Seconds - PathUnavailable Seconds - Path



ce of nge of ugh

at is:

REPT^EVT^T1Report Event T1 is generated by a network element to report the occurrennon-alarmed DS1 related events. The event being reported can be a chastatus or the occurrence of an irregularity, which by itself is not severe enoto warrant an alarm notification.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPT^EVT^T1 <cr> <lf><rspblk> + ;




Field Purpose


<date> in the format yy-mm-dd

<time> in the format hh:mm:ss

<atag> automatic tag, the numerical identification of the message







DS1 AID DS1-slot#-port# Identify the DS1 facility whereExpress:slot#=4 to 10port#=1 to 12




<condeff> TC SCCL




<locn> NENDFEND

Near endFar end

<dirn> RCVTRMT










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


montype CVL ESL SESL

CVP ESP SEFSP SESP

SASPUASP CSSP


Coding Violations - PathErrored Seconds - PathSeverely Errored Frame Seconds - PathSeverely Errored Seconds - Path

SEF / AIS Seconds - PathUnavailable Seconds - PathControlled Slip Seconds - Path



ce of nge of ugh

at is:

REPT^EVT^T3Report Event T3 is generated by a network element to report the occurrennon-alarmed DS3 related events. The event being reported can be a chastatus or the occurrence of an irregularity, which by itself is not severe enoto warrant an alarm notification.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPT^EVT^T3 <cr> <lf><rspblk> + ;





Field Purpose







DS3 AID DS3-slot# Identify the DS3 where slot#=3, 5, 7, or 9 (Express)slot#=1 (Express CX)







<condeff> TC SCCL




<locn> NENDFEND

Near endFar end

<dirn> RCVTRMT







montype CVL ESL SESL

CVP ESP SEFSP SESP

SASPUASP CSSP


Coding Violations - PathErrored Seconds - PathSeverely Errored Frame Seconds - PathSeverely Errored Seconds - Path

SEF / AIS Seconds - PathUnavailable Seconds - PathControlled Slip Seconds - Path



ence t

at is:

REPT^EVT^VT1Report Event VT1 is generated by a network element to report the occurrof non-alarmed VT1.5 related events. The event being reported can be achange of status or the occurrence of an irregularity, which by itself is nosevere enough to warrant an alarm notification.


<cr> <lf> <lf>^^^<sid>^<date>^<time> <cr> <lf>A^^<atag>^REPT^EVT^VT1 <cr> <lf><rspblk> + ;




Field Purpose










Example messageAt 9 p.m. on October 17, 1995, the OC-3 in slot 3, STS-3 records bipolarviolations. 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>


VT1 AID OC3-slot#-sts#-vtg#-vt# Identify the OC-3 path whereExpressslot#= 3 to 12 sts# = 1 to 3vtg#= 1 to 7vt#= 1 to 4

Express CXslot#= 3 to 4sts# = 1 to 3vtg#= 1 to 7vt#= 1 to 4


<condtype> INT Internal hardware fault/failure

<condeff> TC SCCL




<locn> NENDFEND

Near endFar end

<dirn> TRMTRCV

Transmit (away from the node)Receive (onto the node)




e OS OC3

es are

REPTÊX Report exercise is generated by a network element to inform the user or thof the results of a periodic exercise. Related commands are SCHED-EX-and RTRV-EXSCHED-OC3.

Message formatThe message format depends on the results of the exercise. If the exercisall successful and the results of only failed exercises were requested, themessage format is as follows:cr lf lf^^^<rsphdr> cr lfA^^<atag>^REPTÊXÔC3 cr lf;

Otherwise, the message format is as follows:cr lf lf^^^<rsphdr> cr lfA^^<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 failurePASS the exercise found no problem in the unitNOEX the exercise could not be run on the specified unit


Field Purpose





<rspblk> Response block.



in slot
Example messageAt 9 p.m. on October 17, 1995, the exerciser ran and passed on the OC-3 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>



re is or E in

put

REPT^SOCThe Report Span of Control is generated by the NP to a level 5 user if thea change in the span of control of the NP, such as an NE is removed fromadded to the span of control, or the connection status from an NP to an Nthe span of control is changed.


<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 out(AO) buffer, the atag is always 000000.



to will



Example messageAt 9 p.m. on October 17, 1995, the connection status from NP OC3NP01network element OC3NE02 was changed from down to up. This messagebe 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>

Field Purpose





<msgtype><netid><status><swversion>

See Response block parameters descriptions table for details.


<msgtype> EADERMCSR

NE addedNE removedConnection status report

<netid> Target identifier

<status> UPDOWNXPID

Connection is upConnection is downIncorrect password

<swversion> Software version

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.


22-1

a

ollows:

ands

Error codes and messages 22-Whenever a TL1 command is incorrectly entered, addresses equipment,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 f

<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 commas displayed in the error response.


22-2 Error codes and messages

Table 22-1TL1 response error codes

Error code

Error text Applicable commands

ENEQ Equipage, Not EQuipped ENT-<FAC>

ENEX Equipage, Not equipped with EXercise capability exerciser

ENPS Equipage, Not equipped with Protection Switching protection switching

ENSI Invalid VTX version

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.

SET-TMG-MODE

EQWT EQuipage, Wrong Type network element commands

IATA Input, Ambiguous TID all

IBEX Input, Block EXtra all

IBMS Input, Block MiSsing all

ICNV Input, Command Not Valid all

IDNV Input, Data Not Valid commands with parameters

IDRG Input, Data, RanGe error commands with parameters

IEAE Input, Entity Already Exists provisioning

IENE Input, Entity Not Exists provisioning

IIAC Input, Invalid ACcess identifier all

IICT Input, Invalid Correlation Tag all

IIPG Input, Invalid Parameter Grouping PM commands

IITA Input, Invalid TArget identifier all

INUP Input, Non-null Unimplemented Parameter all

IPEX Input, Parameter EXtra all

IPMS Input, Parameter MiSsing commands with parameters

IPNV Input, Parameter Not Valid commands with parameters

ODNV Output, Data Not Valid all

—continued—


Error codes and messages 22-3

PIUC Privilege, Illegal User Code admin and security commands

PIUI Privilege, Illegal User Identity admin and security commands

PLNA Privilege, Login Not Active all

PRTL PaRTiaLly completed DataComm

SAAL Status, Already ALlowed ALW commands

SAAS Status, Already ASsigned network element type commands

SABT Status, ABorTed all

SAIN Status, Already INhibited INH commands

SAIS Status, Already In Service provisioning

SAMS Status, Already in Maintenance State provisioning

SAOP Status, Already OPerated protection switching

SAPR Status, Already in PRotection state protection switching

SARB Status, All Resources Busy all

SARL Status, Already ReLeased protection switching

SDNC Status, Data Not Consistent provisioning

SDNR Status, Data Not Ready provisioning

SLEM Status, List Exceeds Maximum admin and security commands

SNSR Status, No Switch Request outstanding protection switching

SNVS Status, Not in Valid State ACT-USER and provisioning

SPFA Status, Protection unit FAiled protection switching

SPLD Status, Protection unit LockeD protection switching

SRCI Status, Requested Command Inhibited exerciser

SROF Status, Requested Operation Failed protection switching

SRPR Status, switch Request PReempted protection switching

SSRD Status, Switch Request Denied protection switching

SSRE Status, System Resources Exceeded all

—continued—

Table 22-1 (continued)TL1 response error codes

Error code



22-4 Error codes and messages

SSTP Status, SToPped all

SWFA Status, Working unit FAiled protection switching

SWLD Status, Working unit LockeD protection switching

Table 22-1 (continued)TL1 response error codes

Error code



23-1

Index 23-

AAutomatic report

REPTÂLM^COM 21-3REPTÂLMÊC1 21-6REPTÂLMÊIM 21-9REPTÂLMÊNV 21-12REPTÂLMÊQPT 21-16REPTÂLM^FAC 21-19REPTÂLMÎMAT1 21-21REPTÂLMÔC3 21-24REPTÂLM^STS1 21-27REPTÂLM^STS3C 21-29REPTÂLM^T1 21-31REPTÂLM^T3 21-34REPTÂLM^VP 21-37REPTÂLM^VT1 21-40REPT^CONFIG^CHG 21-43REPT^DBCHG 21-44REPTÊVT^COM 21-46REPTÊVTÊC1 21-52REPTÊVTÊQPT 21-48REPTÊVTÔC3 21-54REPTÊVT^STS1 21-57REPTÊVT^STS3C 21-59REPTÊVT^T1 21-61REPTÊVT^T3 21-64REPTÊVT^VT1 21-67REPTÊX 21-69REPT^SOC 21-71

CCTAG, definition 1-6

TL1 Reference 3

EError codes and messages (TL1),

definition 22-1

IIEEE routing ID 3-6

OOnline help for TL1, description 1-10Optical interface

autonomous messages, format 1-9command response header, format 1-8introduction to commands 1-3message notation 1-6message types 1-8online help for TL1 1-10TL1 overview 1-1

PPassword identifier (PID), definition 1-3

SSecurity access level, definition 1-4Software upgrade

network element 20-1network processor (NP) 20-1

Source identifier (SID), definition 1-4

TTarget identifier (TID), definition 1-4

23-1051-190G Doc Issue 5 Standard Nov 1998

23-2 Index

TL1 command descriptionACT-USER 2-3ADD-SOC 19-3ALW-EX-OC3 11-2ALW-MSG-ALL 15-3CANC-PROV 2-4CANC-UPGRD 20-2CANC-USER 2-5CHK-PROV 2-6CHK-UPGRD 20-3CMMT-PROV 2-9CMMT-ROLL-STS1 9-21CMMT-ROLL-STS3C 9-23CMMT-ROLL-VT1 9-19CMMT-UPGRD 20-5CONN-TSTSIG-T1 10-2CONN-TSTSIG-T3 10-4DISC-TSTSIG-T1 10-6DISC-TSTSIG-T3 10-7DLT-CRS-STS1 8-2DLT-CRS-STS3C 8-4DLT-CRS-VT1 8-6DLT-EC1 6-3DLT-EIM 6-4DLT-EQPT 5-2DLT-FAC 19-4DLT-FFP-OC3 6-5DLT-LLSDCC 16-2DLT-MIB-BRIDGE 7-2DLT-MIB-IP 7-4DLT-OC3 6-6DLT-PROV 2-10DLT-PVC 19-5DLT-ROLL-STS1 9-28DLT-ROLL-STS3C 9-30DLT-ROLL-VT1 9-25DLT-SECU-USER 2-12DLT-T1 6-7DLT-T3 6-8DLT-UPGRD 20-6ED-CRS-STS1 8-9ED-CRS-STS3C 8-14ED-CRS-VT1 8-19ED-DAT 2-13ED-DFLT-AINS 6-9ED-EC1 6-10ED-EIM 6-11

S/DMS TransportNode OC-3 MX and CX 323-10

TL1 command description (continued)ED-FFP-OC3 6-13ED-IMA-GRP 6-14ED-IP 19-6ED-LLSDCC 16-3ED-LLX25 19-8ED-MIB-BRIDGE 7-6ED-MIB-IP 7-9ED-MIB-SNMP 7-12ED-MIB-SYSTEM 7-13ED-MIB-VIEW 7-15ED-NETYPE 3-2ED-OC3 6-16ED-PTX25 19-9ED-ROLL-STS1 9-15ED-ROLL-STS3C 9-17ED-ROLL-VT1 9-12ED-SECU-PID 2-14ED-SECU-USER 2-16ED-STS1 18-2ED-T1 6-19ED-T3 6-24ED-TARP-CONFIG 13-2ED-TARP-TBL 13-5ED-ULSDCC 16-6, 19-11ED-ULX25 19-13ED-VC 19-15ENT-CRS-STS1 8-26ENT-CRS-STS3C 8-28ENT-CRS-VT1 8-30ENT-EC1 6-26ENT-EIM 6-28ENT-EQPT 5-4ENT-FAC 19-17ENT-FFP-OC3 6-30ENT-LLSDCC 16-8ENT-MIB-BRIDGE 7-19ENT-MIB-IP 7-21ENT-OC3 6-31ENT-ROLL-STS1 9-6ENT-ROLL-STS3C 9-9ENT-ROLL-VT1 9-3ENT-SECU-USER 2-18ENT-T1 6-33ENT-T3 6-37EX-SW-OC3 11-3INH-EX-OC3 11-5

51-190G Doc Issue 5 Standard Nov 1998

Index 23-3

TL1 command description (continued)INH-MSG-ALL 15-4INIT-COLD 17-2INIT-REG-ALL 12-3INIT-REG-EC1 12-7INIT-REG-OC3 12-11INIT-REG-STS1 12-15INIT-REG-STS3C 12-20INIT-REG-T1 12-24INIT-REG-T3 12-29INIT-WARM 17-4INVK-UPGRD 20-7LOAD-REPLACE 20-8LOAD-UPGRD 20-9OPR-ACO-ALL 15-5OPR-BITSOUTSW 4-2OPR-EXT-CONT 15-6OPR-LPBK-EC1 10-8OPR-LPBK-T1 10-10OPR-LPBK-T3 10-12OPR-PROTNSW-EQPT 11-6OPR-PROTNSW-OC3 11-8OPR-PROTNSW-STS1 11-10OPR-PROTNSW-STS3C 11-12OPR-PROTNSW-VT1 11-14OPR-SYNCSW 4-3OPR-TARP-TEF 13-8RLS-EXT-CONT 15-8RLS-LPBK-EC1 10-14RLS-LPBK-T1 10-15RLS-LPBK-T3 10-16RLS-PROTNSW-EQPT 11-16RLS-PROTNSW-OC3 11-17RLS-PROTNSW-STS1 11-18RLS-PROTNSW-STS3C 11-19RLS-PROTNSW-VT1 11-20RMV-EC1 6-39RMV-EIM 6-40RMV-EQPT 5-7RMV-OC3 6-41RMV-SOC 19-18RMV-T1 6-42RMV-T3 6-43RST-EC1 6-44RST-EIM 6-45RST-EQPT 5-9RST-OC3 6-46

TL1 Reference 3

TL1 command description (continued)RST-PROV 2-20RST-T1 6-47RST-T3 6-48RTRV-ACTIVE-USER 2-23RTRV-ALM-ALL 15-10RTRV-ALM-ENV 15-15RTRV-ALMID-rr 15-20RTRV-AO 15-22RTRV-ATTR-CONT 15-24RTRV-ATTR-ENV 15-26RTRV-BITS-IN 4-4RTRV-BITS-OUT 4-5RTRV-CHK-SUM 19-19RTRV-COND-ALL 15-29RTRV-CONDATTR-COM 15-31RTRV-CONDATTR-rr 15-32RTRV-CONFIG 19-20RTRV-CRS-STS1 8-33RTRV-CRS-STS3C 8-37RTRV-CRS-VT1 8-40RTRV-DFLT-AINS 6-49RTRV-EC1 6-50RTRV-EIM 6-52RTRV-EQPT 5-11RTRV-EXSCHED-OC3 11-21RTRV-EXT-CONT 15-34RTRV-FAC 19-21RTRV-FFP-OC3 6-55RTRV-HDR 2-24RTRV-HELP 2-25RTRV-IMA-GRP 6-57RTRV-INVENTORY 5-15RTRV-IP 19-23RTRV-LLSDCC 16-9RTRV-LLX25 19-24RTRV-MIB-BRIDGE 7-23RTRV-MIB-ICMP 7-29RTRV-MIB-IF 7-32RTRV-MIB-IP 7-35RTRV-MIB-LAN 7-41RTRV-MIB-SNMP 7-44RTRV-MIB-SYSTEM 7-48RTRV-MIB-UDP 7-50RTRV-MIB-VIEW 7-52RTRV-NETYPE (NP host) 3-5RTRV-NETYPE (SP host) 3-3

23-1051-190G Doc Issue 5 Standard Nov 1998

23-4 Index

1

TL1 command description (continued)RTRV-NTFCNCDE 15-36RTRV-OC3 6-59RTRV-PM-ABORT 12-33RTRV-PM-ALL 12-34RTRV-PM-EC1 12-39RTRV-PM-OC3 12-43RTRV-PM-STS1 12-47RTRV-PM-STS3C 12-52RTRV-PM-T1 12-56RTRV-PM-T3 12-60RTRV-PROTNSW-rr 11-23RTRV-PROV-LST 2-26RTRV-PTHTRC-STS1 18-4RTRV-PTX25 19-25RTRV-ROLL-STS1 9-34RTRV-ROLL-STS3C 9-36RTRV-ROLL-VT1 9-32RTRV-RTG-TBL 3-6RTRV-SECU-UPC 2-28RTRV-SECU-USER 2-29RTRV-SOC 19-26RTRV-SPACE 20-11RTRV-STSBIP 15-37RTRV-SW-VER 3-10RTRV-SYNCSTIN 4-7RTRV-T1 6-63RTRV-T3 6-68RTRV-TARP-CONFIG 13-10RTRV-TARP-TBL 13-12RTRV-TBOS 14-2RTRV-TH-ALL 12-64RTRV-TH-EC1 12-67RTRV-TH-OC3 12-70RTRV-TH-STS1 12-73RTRV-TH-STS3C 12-76RTRV-TH-T1 12-79RTRV-TH-T3 12-82RTRV-TMG-MODE 4-8RTRV-TMREFIN 4-9RTRV-TRC-OC3 18-6RTRV-ULSDCC 16-12, 19-27RTRV-ULX25 19-28RTRV-UPGRD 20-12RTRV-VC 19-30RTRV-VP 6-70SAV-PROV 2-31

S/DMS TransportNode OC-3 MX and CX 323-10

TL1 command description (continued)SCHED-EX-OC3 11-26SET-ATTR-CONT 15-38SET-ATTR-ENV 15-40SET-BITS-IN 4-11SET-BITS-OUT 4-12SET-CONDATTR-COM 15-44SET-CONDATTR-rr 15-45SET-NTFCNCDE 15-47SET-SID 2-34SET-STSBIP-OFF 15-48SET-STSBIP-ON 15-49SET-SYNCSTIN 4-14SET-TBOS 14-4SET-TH-ALL 12-85SET-TH-EC1 12-87SET-TH-OC3 12-90SET-TH-STS1 12-93SET-TH-STS3C 12-96SET-TH-T1 12-99SET-TH-T3 12-102SET-TMG-MODE 4-16SET-TMREFIN 4-17VALD-PROV 2-36

Transaction Language 1 (TL1)autonomous messages, format 1-9command interface, introduction 1-3command response header, format 1-8CTAG, definition 1-6error codes and messages, definition 22-message notation 1-6message types 1-8online syntax help 1-10overview 1-1password identifier, definition 1-3security access level 1-4source identifier, definition 1-4standards compliance 1-1target identifier, definition 1-4user identifier, definition 1-3user privilege codes, definition 1-4

UUser identifier (UID), definition 1-3User privilege codes (UPC), definition 1-4

51-190G Doc Issue 5 Standard Nov 1998

SONET Transmission Products

S/DMS TransportNode OC-3 Express and Express CXTL1 Reference

1996–1998 Northern TelecomAll 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-190GStandard Doc Issue 5 November 1998Printed in Canada

323-1051-190g tl1 reference iss 5

Documents

rtrvnetype sp host

rtrvnetype np host

command structure

user identifier

7tl1 command acknowledgment

1tl1 command interface

8tl1 command response

access identifier