Cisco ONS 15454 And 15327 TL1 Command Guide, Release 4.0 454tl140

User Manual: CISCO ONS 15327

Open the PDF directly: View PDF .
Page Count: 514 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide
Chapter 1, Getting Started
Chapter 2, TL1 Gateway
- 2.1 Gateway Network Element Topology
- 2.2 Implementing TL1 Gateway
Chapter 3, TL1 Command Descriptions
Chapter 4, TL1 Command Components
Chapter 5, Ring Provisioning
Chapter 6, TL1 Performance Monitoring
Chapter 7, TL1 Alarms and Errors
Index

Corporate Headquarters

Cisco Systems, Inc.

170 West Tasman Drive

San Jose, CA 95134-1706

USA

http://www.cisco.com

Tel: 408 526-4000

800 553-NETS (6387)

Fax: 408 526-4100

Cisco ONS 15454 and Cisco ONS 15327

TL1 Command Guide

Product and Documentation Release 4.0

March 2003

Customer Order Number: DOC-7815244=

Text Part Number: 78-15244-01

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL

STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT

WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT

SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE

OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The following information is for FCC compliance of Class A devices: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant

to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial

environment. This equipment generates, uses, and can radiate radio-frequency energy and, if not installed and used in accordance with the instruction manual, may cause

harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required

to correct the interference at their own expense.

The following information is for FCC compliance of Class B devices: The equipment described in this manual generates and may radiate radio-frequency energy. If it is not

installed in accordance with Cisco’s installation instructions, it may cause interference with radio and television reception. This equipment has been tested and found to

comply with the limits for a Class B digital device in accordance with the specifications in part 15 of the FCC rules. These specifications are designed to provide reasonable

protection against such interference in a residential installation. However, there is no guarantee that interference will not occur in a particular installation.

Modifying the equipment without Cisco’s written authorization may result in the equipment no longer complying with FCC requirements for Class A or Class B digital

devices. In that event, your right to use the equipment may be limited by FCC regulations, and you may be required to correct any interference to radio or television

communications at your own expense.

You can determine whether your equipment is causing interference by turning it off. If the interference stops, it was probably caused by the Cisco equipment or one of its

peripheral devices. If the equipment causes interference to radio or television reception, try to correct the interference by using one or more of the following measures:

• Turn the television or radio antenna until the interference stops.

• Move the equipment to one side or the other of the television or radio.

• Move the equipment farther away from the television or radio.

• Plug the equipment into an outlet that is on a different circuit from the television or radio. (That is, make certain the equipment and the television or radio are on circuits

controlled by different circuit breakers or fuses.)

Modifications to this product not authorized by Cisco Systems, Inc. could void the FCC approval and negate your authority to operate the product.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH

ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT

LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF

DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,

WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO

OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide

CCIP, CCSP, the Cisco Arrow logo, the Cisco Powered Network mark, Cisco Unity, Follow Me Browsing, FormShare, and StackWise are trademarks of Cisco Systems, Inc.;

Changing the Way We Work, Live, Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCNA,

CCNP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, the Cisco IOS logo, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo,

Empowering the Internet Generation, Enterprise/Solver, EtherChannel, EtherSwitch, Fast Step, GigaStack, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net

Readiness Scorecard, LightStream, MGX, MICA, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, RateMUX, Registrar,

ScriptShare, SlideCast, SMARTnet, StrataView Plus, Stratm, SwitchProbe, TeleRouter, The Fastest Way to Increase Your Internet Quotient, TransPath, and VCO are registered

trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship

between Cisco and any other company. (0401R)

iii

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

CONTENTS

About This Guide xxix

Document Objectives xxix

Audience xxix

Document Organization xxx

Related Documentation

Use this Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0 in conjunction with the

following referenced publications:

•Cisco ONS 15454 Procedure Guide, R4.0

•Cisco ONS 15454 Troubleshooting Guide, R4.0

•Cisco ONS 15454 Reference Manual, R4.0

•Cisco ONS 15327 Procedure Guide, R4.0

•Cisco ONS 15327 Troubleshooting Guide, R4.0

•Cisco ONS 15327 Reference Manual, R4.0

xxxi

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

About This Guide

Document Conventions

This publication uses the following conventions:

Note Means reader take note. Notes contain helpful suggestions or references to material not covered in

the document.

Caution Means reader be careful. In this situation, the user might do something that could result in equipment

damage or loss of data.

Convention Application

boldface Commands and keywords in body text.

italic Command input that is supplied by the user.

[ ] Keywords or arguments that appear within square brackets are optional.

{ x | x | x } A choice of keywords (represented by x) appears in braces separated by

vertical bars. The user must select one.

Ctrl The control key. For example, where Ctrl + D is written, hold down the

Control key while pressing the D key.

screen font Examples of information displayed on the screen.

boldface screen font Examples of information that the user must enter.

< > Command parameters that must be replaced by module-specific codes.

Warning

IMPORTANT SAFETY INSTRUCTIONS

This warning symbol means danger. You are in a situation that could cause bodily injury. Before you

work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar

with standard practices for preventing accidents. To see translations of the warnings that appear in

this publication, refer to the translated safety warnings that accompanied this device.

Note: SAVE THESE INSTRUCTIONS

Note: This documentation is to be used in conjunction with the specific product installation guide

that shipped with the product. Please refer to the Installation Guide, Configuration Guide, or other

enclosed additional documentation for further details.

xxxii

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

About This Guide

Where to Find Safety and Warning Information

For safety and warning information, refer to the Cisco ONS 15454 and Cisco ONS 15327 TL1 Command

Guide, R4.0 that accompanied the product. This publication describes the international agency

compliance and safety information for the Cisco ONS 15xxx systems. It also includes translations of the

safety warnings that appear in the ONS 15xxx system documentation.

Obtaining Documentation

Cisco provides several ways to obtain documentation, technical assistance, and other technical

resources. These sections explain how to obtain technical information from Cisco Systems.

World Wide Web

You can access the most current Cisco documentation on the World Wide Web at this URL:

http://www.cisco.com/univercd/home/home.htm

You can access the Cisco website at this URL:

http://www.cisco.com

International Cisco web sites can be accessed from this URL:

http://www.cisco.com/public/countries_languages.shtml

Documentation CD-ROM

Optical networking-related documentation is available in a CD-ROM package that ships with your

product. The Optical Networking Product Documentation CD-ROM is updated with incremental

releases and may be more current than printed documentation.

Ordering Documentation

You can find instructions for ordering documentation at this URL:

http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm

You can order Cisco documentation in these ways:

•Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from

the Networking Products MarketPlace:

http://www.cisco.com/en/US/partner/ordering/index.shtml

•Registered Cisco.com users can order the Documentation CD-ROM (Customer Order Number

DOC-CONDOCCD=) through the online Subscription Store:

http://www.cisco.com/go/subscription

•Nonregistered Cisco.com users can order documentation through a local account representative by

calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408 526-7208 or, elsewhere

in North America, by calling 800 553-NETS (6387).

xxxiii

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

About This Guide

Obtaining Technical Assistance

Documentation Feedback

You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click

Feedback at the top of the page.

You can email your comments to bug-doc@cisco.com.

You can submit your comments by mail by using the response card behind the front cover of your

document or by writing to the following address:

Cisco Systems

Attn: Customer Document Ordering

170 West Tasman Drive

San Jose, CA 95134-9883

We appreciate your comments.

Obtaining Technical Assistance

Cisco provides Cisco.com, which includes the Cisco Technical Assistance Center (TAC) Website, as a

starting point for all technical assistance. Customers and partners can obtain online documentation,

troubleshooting tips, and sample configurations from the Cisco TAC website. Cisco.com registered users

have complete access to the technical support resources on the Cisco TAC website, including TAC tools

and utilities.

Cisco.com

Cisco.com offers a suite of interactive, networked services that let you access Cisco information,

networking solutions, services, programs, and resources at any time, from anywhere in the world.

Cisco.com provides a broad range of features and services to help you with these tasks:

•Streamline business processes and improve productivity

•Resolve technical issues with online support

•Download and test software packages

•Order Cisco learning materials and merchandise

•Register for online skill assessment, training, and certification programs

To obtain customized information and service, you can self-register on Cisco.com at this URL:

http://www.cisco.com

xxxiv

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

About This Guide

Obtaining Technical Assistance

Technical Assistance Center

The Cisco TAC is available to all customers who need technical assistance with a Cisco product,

technology, or solution. Two levels of support are available: the Cisco TAC website and the Cisco TAC

Escalation Center. The avenue of support that you choose depends on the priority of the problem and the

conditions stated in service contracts, when applicable.

We categorize Cisco TAC inquiries according to urgency:

•Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities,

product installation, or basic product configuration.

•Priority level 3 (P3)—Your network performance is degraded. Network functionality is noticeably

impaired, but most business operations continue.

•Priority level 2 (P2)—Your production network is severely degraded, affecting significant aspects

of business operations. No workaround is available.

•Priority level 1 (P1)—Your production network is down, and a critical impact to business operations

will occur if service is not restored quickly. No workaround is available.

Cisco TAC Web Site

You can use the Cisco TAC website to resolve P3 and P4 issues yourself, saving both cost and time. The

site provides around-the-clock access to online tools, knowledge bases, and software. To access the

Cisco TAC website, go to this URL:

http://www.cisco.com/tac

All customers, partners, and resellers who have a valid Cisco service contract have complete access to

the technical support resources on the Cisco TAC website. Some services on the Cisco TAC website

require a Cisco.com login ID and password. If you have a valid service contract but do not have a login

ID or password, go to this URL to register:

http://tools.cisco.com/RPF/register/register.do

If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco

TAC website, you can open a case online at this URL:

http://www.cisco.com/en/US/support/index.html

If you have Internet access, we recommend that you open P3 and P4 cases through the Cisco TAC

website so that you can describe the situation in your own words and attach any necessary files.

Cisco TAC Escalation Center

The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. These

classifications are assigned when severe network degradation significantly impacts business operations.

When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer

automatically opens a case.

To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:

http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml

Before calling, please check with your network operations center to determine the level of Cisco support

services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network

Supported Accounts (NSA). When you call the center, please have available your service agreement

number and your product serial number.

xxxv

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

About This Guide

Obtaining Additional Publications and Information

Information about Cisco products, technologies, and network solutions is available from various online

and printed sources.

•The Cisco Product Catalog describes the networking products offered by Cisco Systems as well as

ordering and customer support services. Access the Cisco Product Catalog at this URL:

http://www.cisco.com/en/US/products/products_catalog_links_launch.html

•Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new

and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking

Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design

Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:

http://www.ciscopress.com

•Packet magazine is the Cisco monthly periodical that provides industry professionals with the latest

information about the field of networking. You can access Packet magazine at this URL:

http://www.cisco.com/en/US/about/ac123/ac114/about_cisco_packet_magazine.html

•iQ Magazine is the Cisco monthly periodical that provides business leaders and decision makers

with the latest information about the networking industry. You can access iQ Magazine at this URL:

http://business.cisco.com/prod/tree.taf%3fasset_id=44699&public_view=true&kbns=1.html

•Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering

professionals involved in the design, development, and operation of public and private internets and

intranets. You can access the Internet Protocol Journal at this URL:

http://www.cisco.com/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html

•Training—Cisco offers world-class networking training, with current offerings in network training

listed at this URL:

http://www.cisco.com/en/US/learning/le31/learning_recommended_training_list.html

xxxvi

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

About This Guide

Obtaining Additional Publications and Information

CHAPTER

1-1

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Getting Started

Transaction Language 1 (TL1) is a subset of the input and output messages contained in the International

Telecommunications Union (ITU) Man-Machine Language (MML). TL1 provides a standard set of

messages that can be used for communicating between operating systems and network elements, and

personnel and network elements. The ONS 15454 and ONS 15327 can support up to 20 concurrent TL1

sessions in this release. For more information about TL1, refer to Telcordia document GR-833-CORE,

Network Maintenance: Network Element and Transport Surveillance Messages.

This chapter provides information and procedures for getting started with TL1:

•Setting up TL1 communication

•TL1 command syntax

•Autonomous messages

•TL1 commands by user security

•Provisioning a DS3E card in CTC using TL1

•Provisioning rules for MXP_2.5G_10G and TXP_MR_10G cards

•CTC interoperability

•Mixed mode timing support

•TL1 command completion behavior

•Test access

•TL1 PCA provisioning

•FTP software download

1-2

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Setting up TL1 Communication

1.1 Setting up TL1 Communication

The period during which a user is logged into the ONS 15454 or ONS 15327 is called a session. There

are three options you can use to open a session (login):

•Cisco Transport Controller (CTC)

•Telnet

•Craft interface

The TL1 password (PID) is masked when accessing a TL1 session using any of these options. When you

logout of any of these options, you are closing a session. The ONS 15454 and ONS 15327 allow a

maximum of 20 (19 telnet sessions and one craft session) concurrent TL1 sessions using any one or any

combination of the options listed above. For information on issuing commands to multiple nodes, see

Chapter 2, “TL1 Gateway.”

1.1.1 Open a TL1 session

Use the following procedures to open a TL1 session via the CTC, telnet, or craft interface. In the

procedures the Activate and Cancel User commands are shown in their input format. For more

information about these and other commands and messages, see Chapter 3, “TL1 Command

Descriptions.”

Open a TL1 Session Via CTC

Step 1 From the PC connected to the ONS 15454, start Netscape or Internet Explorer.

Step 2 Enter the ONS 15454 IP address of the node you want to communicate with in the Netscape or Internet

Explorer Web address (URL) field.

Step 3 Log into the CTC. The IP address at the title bar should match the IP address of the node you entered in

Step 2.

Step 4 Once logged into the CTC, click Tools > Open TL1 Connection.

Step 5 Choose the node you want to communicate with from the Select Node dialog box.

Step 6 Click OK.

A TL1 interface window opens. There are three sub-windows in the TL1 interface window: Request

history, Message log, and TL1 request. Type commands in the TL1 request window. You will see

responses in the Message log window. The Request history window allows you to recall previous

commands by clicking on them.

Step 7 Verify that the Connect button is selected (grayed out).

Step 8 Type the Activate User command in the TL1 request window to open a TL1 session:

ACT-USER:[<TID>]:<UID>:<CTAG>::<PID>; and press Enter.

Note You must press Enter after the semicolon in each TL1 command, or the command will not be

issued.

1-3

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Setting up TL1 Communication

Step 9 Type the Cancel User command in the TL1 request window or press the Disconnect button to close a

TL1 session:

CANC-USER:[<TID>]:<USERID>:<CTAG>; and press Enter.

Open a TL1 Session Via Telnet

To access TL1 commands in a telnet session over a craft interface or a LAN connection (TCC+/TCC2

card front panel or backplane pins) you can choose from several ports. Port number 3082 is a raw TCP/IP

port; it will not echo and it will not prompt the user. Port number 3083 is a telnet port that uses the telnet

protocol and associated telnet escape sequences. Port number 2361 is supported for backward

compatibility with earlier releases and has the same behavior as Port 3083 (telnet port). Use the

following procedure with PCs running Windows operating systems.

Step 1 At the DOS prompt, type cmd and click OK. (The same steps can also be done from a Unix prompt).

Step 2 At the DOS command prompt type:

TELNET <NODE IP ADDRESS OR NODE NAME> <PORT NUMBER> and press Enter.

The Node IP address or Node Name refers to the IP address or Node Name of the node you want to

communicate with. Port number is the port (2361, 3082, or 3083) where TL1 commands are understood.

If the connection is successful, a screen opens with a prompt.

Step 3 Type the Activate User command to open a TL1 session:

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

Note When the semicolon is typed, the command is issued immediately.

Step 4 Type the Cancel User command to close a TL1 session:

CANC-USER:[<TID>]:<USERID>:<CTAG>;

1-4

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Setting up TL1 Communication

Open a TL1 Session Via Craft Interface

The TCC+/TCC2 and XTC cards have two built-in interface ports for accessing the ONS 15454. With

one RJ-45 LAN connection you can access the system using a standard browser interface. In the browser

interface, you can perform local and remote Operations, Administration, Maintenance, and Provisioning

(OAM&P) functions and open a VT100 emulation window to enter TL1 commands. If a browser is not

available, you can access the system using a nine-pin RS-232 port. The RS-232 port supports VT100

emulation such that TL1 commands may be entered directly without a browser. For instructions on how

to install the TL1 craft interface, refer to the Cisco ONS 15454 Procedure Guide or the Cisco ONS 15327

Procedure Guide.

Step 1 Connect the serial cable to the RS-232 port on the active TCC+/TCC2 or XTC card.

Step 2 Configure the terminal emulation software (Hyperterminal):

a. Terminal emulation = vt100

b. Bits per second = 9600

c. Parity = None

d. Stop BITS = 1

e. Flow control = None

Step 3 Press Enter. An angle bracket prompt (>) appears.

Step 4 At the > prompt, type the Activate User command to open a TL1 session:

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

Note When the semicolon is typed, the TL1 command is issued immediately.

Step 5 Type the Cancel User command to close a TL1 session:

CANC-USER:[<TID>]:<USERID>:<CTAG>;

1-5

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

TL1 Command Syntax

1.2 TL1 Command Syntax

TL1 commands conform to the following syntax:

a:b:c:d:e: ... z;

where:

“a” is the command code

“b” is the target identifier (TID)

“c” is the access identifier (AID) or the user identifier (UID)

“d” is the correlation tag (CTAG)

“e: ... z;” are other positions required for various commands

The TID, AID, and CTAG route and control the TL1 command. Other parameters provide additional

information required to complete the action requested by the command. TL1 command codes, parameter

names and parameter values can be either uppercase or lowercase exclusively or any combination of the

two, unless specifically noted in the command description.

The TID is a unique name given to each system when it is installed. The name identifies the particular

NE (in this case, the ONS 15454 or ONS 15327), to which each command is directed. Each TID can have

a maximum of 20 ASCII characters limited to letters, digits, and hyphens, but each TID must start with

an alphabetic character. The presence of the TID is required in all input commands, but its value can be

null (represented by two successive colons). The TID can be null when the operating system directly

communicates with the target NE. The recommended value for the TID, when it is used, is the target’s

CLLI code. To establish the TID for an ONS 15454/15327 node, use the Provisioning > General tabs in

CTC.

Note If the TID contains any characters other than letters and digits, such as spaces, the text string form

(enclosed in double quotes) must be used.

The AID is an access code used to identify and address specific objects within the ONS 15454 and the

ONS 15327. These objects include individual pieces of equipment, transport spans, access tributaries,

and other objects.

The CTAG is a unique identifier given to each input command by the user. When the

ONS 15454/ONS 15327 system responds to a specific command, it includes the command’s CTAG in

the reply. Including the CTAG eliminates discrepancies about which response corresponds to which

command. Valid CTAG values include strings of up to six characters comprised of identifiers

(alphanumeric, beginning with a letter) or decimal numerals (a string of decimal digits with an optional

non-trailing “.”).

The following specification characters are used throughout this document as vehicles for defining the

syntax:

•< > enclose a symbol specifier, for example <CTAG>.

•[ ] enclose an optional symbol, for example [<TID>].

•“ ” enclose a literal character, for example an output format

“SLOT-7:PLUGIN,TC,,,,,,,:\“EQUIPMENT PLUG-IN\”,TCC”

•^ is a space, a literal blank character used only in examples of messages.

1-6

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Autonomous Messages

1.3 Autonomous Messages

The autonomous TL1 messages are included in Chapter 3, “TL1 Command Descriptions” and listed

alphabetically. Figure 1-1 shows the autonomous message format. The autonomous message tag (ATAG)

is used for message sequencing. The number is incremented by one for each autonomous message sent

by the ONS 15454 or ONS 15327. The ONS 15454 and ONS 15327 use whole numbers 0000 to 9999.

Note Some autonomous messages (REPT DBCHG and REPT EVT SESSION, for example) differ slightly

from the format shown in the third line of Figure 1-1.

Figure 1-1 Autonomous message format

1.3.1 Alarm Codes

The alarm code indicates the severity of the autonomous message. Valid values for alarm codes in

decreasing order of severity are as follows:

•*C Critical alarm

•** Major alarm

•*^ Minor alarm

•A^ Non-alarm message

Critical, Major, and Minor correspond to the reporting of alarmed events. The Non-alarm message

designation is used when the NE is reporting non-alarmed events, periodic measurements, or results of

previously-scheduled diagnostics or audits. If multiple alarms are reported in the same message, the

alarm code is the highest severity of those being reported.

The following is an example of an output message that includes the Critical alarm code:

AB7-56 1970-01-01 16:02:10

*C 100.100 REPT ALM EQPT

“SYSTEM:CR,HITEMP,NSA,,,,:\“High Temperature\”,TCC”

For more information about alarms, see Chapter 7, “TL1 Alarms and Errors.”

SVT197 1999-04-08 18:26:02

A 100.100 REPT ALM BITS

BITS-2: CL,LOS,SA,,,,:Loss of Signal

/* Loss of Signal*/

DateTime

Service Affecting/

Non Service

Affecting

Condition

(TID)

Target or

Node ID

Access

Identifier Level

(ATAG)

Number In Messaging

Sequence

Text

Description

String

Alarm

Code

40898

1-7

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

TL1 Commands by User Security

1.4 TL1 Commands by User Security

The following table specifies command access privileges for each user security level.

Table 1-1 Command Access

Command Superuser Provisioning Maintenance Retrieve

ALW-MSG-SECU X

ALW-USER-SECU X

APPLY X

COPY-RFILE X

DLT-USER-SECU X

ED-DAT X

ED-USER-SECU X

ENT-USER-SECU X

INH-MSG-SECU X

INH-USER-SECU X

REPT EVT SECU X

DLT-*-* X X

ED-*-* X X

ENT-*-* X X

SET-*-* X X

SET-TOD X X

INIT-*-* X X X

OPR-*-*XXX

RLS-*-* XXX

RMV-*-*XXX

RST-*-* XXX

SW-*-* X X X

ACT-*-*XXXX

ALW-*-*XXXX

CANC-*-*XXXX

ED-PID XXXX

INH-*-* XXXX

REPT * *1

1. Except for REPT EVT SECU which is Superuser only as shown above.

XXXX

RTRV-*-*XXXX

1-8

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Provisioning a DS3E Card in CTC Using TL1

User security levels limit the amount of time a user can leave the system idle before the TL1 session is

locked to prevent unauthorized users from making changes. Higher security levels have shorter time

outs. Starting with Release 4.0, time outs can be provisioned (by a Superuser) from CTC. If provisioned,

it only affects users who are not currently logged in. A user that is logged in has to log out and log back

in before the new timeouts will take affect.

Table 1-2 shows security levels and their default time outs.

1.5 Provisioning a DS3E Card in CTC Using TL1

The DS3E card can autosense the framing being received and set the framing accordingly; however, this

framing autosense feature can only be set using CTC. Use CTC to set the FMT attribute on a DS3E card

to autoprovision which results in the FMT field being blanked out for a few seconds while the DS3E card

is determining the framing mode coming into that particular port. The FMT field is then set accordingly

to unframed, M23, or CBit. If the DS3E card is not present (pre-provisioned), setting the FMT field to

autoprovision will result in the FMT field defaulting to unframed.

The TL1 interface does not support the autoprovision option for the DS3E card; the TL1 interface only

supports unframed, M23, or CBit. If autoprovision is selected from CTC and at the same time the TL1

command RTRV-T3 is issued, the TL1 output will result in the FMT field populated with unframed

during the time period that the DS3E card (if present) is autosensing the frame format. If the DS3E card

is not present (pre-provisioned), issuing RTRV-T3 after CTC sets the FMT to autoprovision will result

in the TL1 output populating the FMT field with unframed.

1.6 Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G

Cards

The following sections provide rules necessary when performing provisioning with theMXP_2.5G_10G

and TXP_MR_10G (MXP/TXP) cards.

1.6.1 Payload Provisioning Rules for MXP/TXP Cards

1. You are allowed to change payload type only if all ports are in OOS state.

2. If the slot is in regeneration group, changing payload type affects both cards.

3. Changing payload is a card-level operation (i.e. all client ports are affected).

4. There should be no DCC enable on any ports.

5. Only the TXP card can be used for 10GE payload.

Table 1-2 Security Default Time Outs

Security Level Default Timeouts

Retrieve Unlimited

Maintenance 60 minutes

Provisioning 30 minutes

Superuser 15 minutes

1-9

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards

6. To set the 10GE payload, the termination mode must be set to transparent.

7. The payload cannot be changed if any of the ports are a part of any Y cable protection group or are

used as the timing source.

8. The TL1 commands to provision are:

–

ED-DWDM:[<TID>]:<AID>:<CTAG>:::[PEERID=<PEERID>,]

[TERMMODE=<TERMMODE>,][PAYLOAD=<PAYLOAD>,][PWL=<PWL>];

–

RTRV-DWDM:[<TID>]:<AID>:<CTAG>;

1.6.2 Termination Mode Provisioning Rules for MXP/TXP Cards

1. Only applicable to payload type of SONET/SDH.

2. Changing termination mode is a card-level operation (i.e. client and trunk must have the same

termination mode selection).

3. There should be no DCC enabled on any ports.

4. All ports need to be in OOS state.

5. For transparent termination mode, the trunk port should not be a timing source.

6. Section termination mode is not supported for both the MXP and TXP cards.

7. The trace mode should be set to OFF for the J0 Section trace level on all ports, prior to a change of

the termination mode.

8. The TL1 commands to provision are:

–

ED-DWDM:[<TID>]:<AID>:<CTAG>:::[PEERID=<PEERID>,]

[TERMMODE=<TERMMODE>,][PAYLOAD=<PAYLOAD>,][PWL=<PWL>];

–

RTRV-DWDM:[<TID>]:<AID>:<CTAG>;

1.6.3 Wavelength Provisioning Rules for MXP/TXP Cards

1. The DWDM (trunk) port should be placed in OOS state because this change is traffic affecting. This

is enforced in CTC. TL1 does not enforce this restriction.

2. Setting the wavelength to the first tunable wavelength will cause the first wavelength from the card

manufacturing data to be used as the operational wavelength.

3. If the provisioned wavelength is set to the first tunable wavelength, any removal of an operational

card and the subsequent replacement with a card of a different wavelength will not cause a mismatch

alarm to be raised.

4. In order to receive the mismatch alarm notification, you need to explicitly provision the wavelength

and not use the first tunable wavelength.

5. The TL1 commands to provision are:

–

ED-DWDM:[<TID>]:<AID>:<CTAG>:::[PEERID=<PEERID>,]

[TERMMODE=<TERMMODE>,][PAYLOAD=<PAYLOAD>,][PWL=<PWL>];

–

RTRV-DWDM:[<TID>]:<AID>:<CTAG>;

1-10

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards

1.6.4 DCC/GCC Provisioning Rules for MXP/TXP Cards

1. The DCC can be provisioned for the MXP and TXP cards.

2. The DCC can be provisioned only if the card payload is set to SONET/SDH and the termination

mode is set to line terminated.

3. The client ports can only support DCC.

4. The trunk port can only support either DCC or GCC.

5. To enable the GCC on the trunk port, the G.709 should be enabled.

6. To enable the DCC on the trunk port, the G.709 should be disabled.

7. Only the working port (not the protect) in a Y cable protection scheme is allowed to be provisioned

as DCC and timing reference.

8. The TL1 commands to provision are:

–

ED-CLNT:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,]

[ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,]

[COMM=<COMM>,][MACADDR=<MACADDR>,][SYNCMSG=<SYNCMSG>,]

[SENDDUS=<SENDDUS>,][RLASER=<RLASER>,][SOAK=<SOAK>]:[<PST>],[<SST>];

–

ED-OCH:[<TID>]:<AID>:<CTAG>:::[RDIRN=<RDIRN>,][EXPWLEN=<EXPWLEN>,]

[VOAATTN=<VOAATTN>,][VOAPWR=<VOAPWR>,][CALOPWR=<CALOPWR>,]

[SFBER=<SFBER>,][SDBER=<SDBER>,][ALSMODE=<ALSMODE>,]

[ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,][COMM=<COMM>,]

[GCCRATE=<GCCRATE>,][OSFBER=<OSFBER>,][OSDBER=<OSDBER>,]

[DWRAP=<DWRAP>,][FEC=<FEC>,][MACADDR=<MACADDR>,]

[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][RLASER=<RLASER>,]

[SOAK=<SOAK>]:[<PST>],[<SST>];

–

RTRV-CLNT:[<TID>]:<AID>:<CTAG>;

–

RTRV-OCH:[<TID>]:<AID>:<CTAG>;

1.6.5 G.709 Provisioning Rules for MXP/TXP Cards

1. The G.709 can only be provisioned on the trunk (DWDM) port.

2. In order to disable G.709, the FEC, if enabled, should be disabled first.

3. In order to disable G.709, the GCC if provisioned, should be removed.

4. In order to change G.709 setting, the trunk port needs to be OOS.

1-11

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards

5. The TL1 commands to provision are:

–

ED-CLNT:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,]

[ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,]

[COMM=<COMM>,][MACADDR=<MACADDR>,][SYNCMSG=<SYNCMSG>,]

[SENDDUS=<SENDDUS>,][RLASER=<RLASER>,][SOAK=<SOAK>]:[<PST>],[<SST>];

–

ED-OCH:[<TID>]:<AID>:<CTAG>:::[RDIRN=<RDIRN>,][EXPWLEN=<EXPWLEN>,]

[VOAATTN=<VOAATTN>,][VOAPWR=<VOAPWR>,][CALOPWR=<CALOPWR>,]

[SFBER=<SFBER>,][SDBER=<SDBER>,][ALSMODE=<ALSMODE>,]

[ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,][COMM=<COMM>,]

[GCCRATE=<GCCRATE>,][OSFBER=<OSFBER>,][OSDBER=<OSDBER>,]

[DWRAP=<DWRAP>,][FEC=<FEC>,][MACADDR=<MACADDR>,]

[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][RLASER=<RLASER>,]

[SOAK=<SOAK>]:[<PST>],[<SST>];

–

RTRV-CLNT:[<TID>]:<AID>:<CTAG>;

–

RTRV-OCH:[<TID>]:<AID>:<CTAG>;

1.6.6 FEC Provisioning Rules for MXP/TXP Cards

1. The FEC can only be provisioned if the G.709 is enabled.

2. Trunk port needs to be OOS.

3. The TL1 commands to provision are:

–

ED-CLNT:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,]

[ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,]

[COMM=<COMM>,][MACADDR=<MACADDR>,][SYNCMSG=<SYNCMSG>,]

[SENDDUS=<SENDDUS>,][RLASER=<RLASER>,][SOAK=<SOAK>]:[<PST>],[<SST>];

–

ED-OCH:[<TID>]:<AID>:<CTAG>:::[RDIRN=<RDIRN>,][EXPWLEN=<EXPWLEN>,]

[VOAATTN=<VOAATTN>,][VOAPWR=<VOAPWR>,][CALOPWR=<CALOPWR>,]

[SFBER=<SFBER>,][SDBER=<SDBER>,][ALSMODE=<ALSMODE>,]

[ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,][COMM=<COMM>,]

[GCCRATE=<GCCRATE>,][OSFBER=<OSFBER>,][OSDBER=<OSDBER>,]

[DWRAP=<DWRAP>,][FEC=<FEC>,][MACADDR=<MACADDR>,]

[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][RLASER=<RLASER>,]

[SOAK=<SOAK>]:[<PST>],[<SST>];

–

RTRV-CLNT:[<TID>]:<AID>:<CTAG>;

–

RTRV-OCH:[<TID>]:<AID>:<CTAG>;

1.6.7 Synchronization Provisioning Rules for MXP/TXP Cards

1. Only the MXP card ports can be used for a timing source.

2. For the MXP card, all client ports are available for timing irrespective of the termination mode.

3. For the MXP card, the trunk port is only allowed for a timing reference if G.709 is off and the

termination mode is set to line.

1-12

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards

4. The TL1 commands to provision are:

–

ED-CLNT:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,]

[ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,]

[COMM=<COMM>,][MACADDR=<MACADDR>,][SYNCMSG=<SYNCMSG>,]

[SENDDUS=<SENDDUS>,][RLASER=<RLASER>,][SOAK=<SOAK>]:[<PST>],[<SST>];

–

ED-OCH:[<TID>]:<AID>:<CTAG>:::[RDIRN=<RDIRN>,][EXPWLEN=<EXPWLEN>,]

[VOAATTN=<VOAATTN>,][VOAPWR=<VOAPWR>,][CALOPWR=<CALOPWR>,]

[SFBER=<SFBER>,][SDBER=<SDBER>,][ALSMODE=<ALSMODE>,]

[ALSRCINT=<ALSRCINT>,][ALSRCPW=<ALSRCPW>,][COMM=<COMM>,]

[GCCRATE=<GCCRATE>,][OSFBER=<OSFBER>,][OSDBER=<OSDBER>,]

[DWRAP=<DWRAP>,][FEC=<FEC>,][MACADDR=<MACADDR>,]

[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][RLASER=<RLASER>,]

[SOAK=<SOAK>]:[<PST>],[<SST>];

–

RTRV-CLNT:[<TID>]:<AID>:<CTAG>;

–

RTRV-OCH:[<TID>]:<AID>:<CTAG>;

1.6.8 Trace Provisioning Rules for MXP/TXP Cards

1. The client ports only support the SONET/SDH J0 section trace.

2. The client ports support the J0 Section trace only in line terminated mode.

3. The trunk (DWDM) port supports the J0 Section trace mode only in line terminated mode.

4. For the trunk port, if G.709 is enabled, TTI level trace can be provisioned for section and path

monitoring.

5. In line termination, the J0 Section trace supports MANUAL and MANUAL_NO_AIS trace mode.

6. The J0 Section trace level supports 1 or 16-byte length trace format.

7. The OTN level trace supports only the Manual and MANUAL-NO-AIS trace modes.

8. The OTN level trace supports only 64-byte length trace format

9. The trace mode of AUTO and AUTO-NO-AIS are not supported.

10. The TL1 commands to provision are:

–

ED-TRC-CLNT:[<TID>]:<SRC>:<CTAG>:::[EXPTRC=<EXPTRC>,][TRC=<TRC>,]

[TRCMODE=<TRCMODE>,][TRCLEVEL=<TRCLEVEL>,]

[TRCFORMAT=<TRCFORMAT>][:];

–

ED-TRC-OCH:[<TID>]:<SRC>:<CTAG>:::[EXPTRC=<EXPTRC>,][TRC=<TRC>,]

[TRCMODE=<TRCMODE>,][TRCLEVEL=<TRCLEVEL>,]

[TRCFORMAT=<TRCFORMAT>][:];

–

RTRV-TRC-CLNT:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];

–

RTRV-TRC-OCH:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];

1-13

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards

1.6.9 PM and Alarm Threshold Provisioning Rules for MXP/TXP Cards

1. The OTN thresholds are only applicable if the G.709 is enabled.

2. The FEC thresholds are only applicable if the G.709 and FEC are enabled.

3. The Optics TCA & Alarm Thresholds apply to the local node only.

4. The TL1 commands to provision are:

–

SET-TH-CLNT:[<TID>]:<AID>:<CTAG>::<MONTYPE>,<THLEV>,

[<LOCN>],,[<TMPER>];

–

SET-TH-OCH:[<TID>]:<AID>:<CTAG>::<MONTYPE>,<THLEV>,[<LOCN>],,[<TMPER>];

–

RTRV-TH-CLNT:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],<TMPER>[::];

–

RTRV-TH-OCH:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],<TMPER>[::];

1.6.10 Regeneration Group Provisioning Rules for MXP/TXP Cards

1. Only a TXP card can be used in a regeneration group.

2. A regeneration group enables the continuation of the client signal across multiple spans.

3. Regeneration group rules are as follows:

a. peer-slot must not be itself

b. peer-slot must at least be preprovisioned

c. same card type

d. same payload type

e. termination mode has to be set to transparent mode

f. peer slot cannot be part of another Y cable or regeneration group

4. Once two cards are in regeneration group, any payload changes will be reflected on both cards.

5. The TL1 commands to provision are:

–

ED-DWDM:[<TID>]:<AID>:<CTAG>:::[PEERID=<PEERID>,]

[TERMMODE=<TERMMODE>,][PAYLOAD=<PAYLOAD>,][PWL=<PWL>];

–

RTRV-DWDM:[<TID>]:<AID>:<CTAG>;

1.6.11 Y Cable Protection Group Provisioning Rules for MXP/TXP Cards

1. A Y cable protection group can be created between the client ports of either two TXP cards or two

MXP cards.

2. Y cable protection cannot be part of a regeneration group.

3. Only the working ports (not the protect) can be provisioned with DCC and timing reference.

4. The TL1 commands to provision are:

–

ENT-FFP-CLNT:[<TID>]:<WORKAID>,<PROTAID>:

<CTAG>:::[PROTTYPE=<PROTTYPE>,][PROTID=<PROTID>,][RVRTV=<RVRTV>,]

[RVTM=<RVTM>,][PSDIRN=<PSDIRN>][:];

1-14

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

CTC Interoperability

–

ED-FFP-CLNT:[<TID>]:<AID>:<CTAG>:::[PROTID=<PROTID>,][RVRTV=<RVRTV>,]

[RVTM=<RVTM>,][PSDIRN=<PSDIRN>][:];

–

RTRV-FFP-CLNT:[<TID>]:<AID>:<CTAG>[::::];

1.7 CTC Interoperability

A TL1 cross-connect that has been upgraded to a CTC circuit can no longer be managed by TL1. For

example, if you issue a DLT-CRS-<STS_PATH> command to delete a circuit, you will see that the circuit

still appears in CTC as “incomplete.” The reason for this is because in addition to creating

cross-connects (as TL1 does), CTC creates another object on the source node that stores network-level

circuit attributes. CTC will continue to see that object after the cross-connect is deleted which is why it

shows an incomplete circuit.

Starting with R3.4, there is a Create cross connects only (TL1-like) check box that appears in CTC when

creating circuits. If applicable, you can check this box to create one or more cross-connects to complete

a signal path for TL1-generated circuits. If this box is checked, you cannot assign a name to the circuit;

and VT tunnels, Ethergroup sources, and drops are unavailable. Refer to the Cisco ONS 15454

Procedure Guide or the Cisco ONS 15327 User Documentation for information about CTC circuit

creation.

1.8 Mixed Mode Timing Support

Although TL1 supports mixed mode timing in this release, Cisco strongly advises against its

implementation. Mixed mode timing is not a recommended timing mode because of the inherent risk of

creating timing loops. Refer to Telcordia document GR-436-CORE, Digital Network Synchronization

Plan for recommended synchronization planning. Refer to the Cisco ONS 15454 Procedure Guide or the

Cisco ONS 15327 User Documentation for information about setting up ONS 15454/15327 timing. For

further assistance contact the Cisco Technical Assistance Center (TAC) at www.cisco.com or call

1-877-323-7368 for unresolved problems.

1.9 TL1 Command Completion Behavior

When you enter a TL1 command, one of three completion codes will be returned. The completion codes

are: completed (COMPLD), partial (PRTL), and deny (DENY). You can specify an explicit, implicit, or

explicit with implicit list as explained in the following sections.

1.9.1 General Rules

Note The command completion behavior does not apply to RTRV-CRS, RTRV-ALM, and RTVR-COND

commands.

1-15

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

TL1 Command Completion Behavior

1.9.1.1 Explicit List of AIDs - No Wildcards

If a set of AIDs is explicitly listed, including a set of just one AID, then each AID must complete

successfully to return a COMPLD message. If more than one AID is in the set and at least one AID

succeeds but all do not, then a PRTL with errors for each failed AID is returned. If all AIDs in the set

fail, a DENY with errors for each failed AID is returned.

SLOT-1

FAC-2-1&FAC-3-3&FAC-4-2

1.9.1.2 Implicit List of AIDs - Single AID With Wildcard

If a set of AIDs is implied by the use of the ALL modifier on a single AID, then follow the same rules

as in the “Explicit List of AIDs - No Wildcards” section on page 1-15. The caveat is that the implicit list

only includes AIDs that apply to the command:

SLOT-ALL

FAC-1-ALL

STS-3-ALL

where Slot 3 contains an OC-12 and the command is ED-STS1 but STS-3-4 and STS-3-7 are STS3C.

The set implied by STS-3-ALL then only contains STS-3-{1,2,3,10,11,12} and will not return an error

for STS-3-{4,5,6,7,8,9}. Disregard the STS3C in this case because the modifier of the command

specifies that the user is only interested in STS-1 paths. The rule specified in this section then applies to

the implicit set of {1,2,3,10,11,12}.

1.9.1.3 Explicit List Grouped With Implicit List

If the set of AIDs is comprised of two subsets, one set including explicitly stated AIDs and the other set

implied by one or more AID(s) with the ALL modifier, then follow the rules of the“Explicit List of AIDs

- No Wildcards” section on page 1-15 and the “Implicit List of AIDs - Single AID With Wildcard”

section on page 1-15, respectively.

FAC-1-1&FAC-2-ALL

FAC-3-ALL&FAC-7-ALL

STS-2-ALL&STS-12-1&STS-13-2&STS-14-ALL

1.9.2 Command Completion Behavior for Retrieval of Cross-Connections

When you enter a RTRV-CRS command, one of three completion codes will be returned. The completion

codes are: completed (COMPLD), partial (PRTL), and deny (DENY). You can specify an explicit,

implicit, or explicit with implicit list as explained in the following sections.

1.9.2.1 Explicit List of AIDs - No Wildcards

For an explicit list of AIDs on a RTRV-CRS command, an error code will be returned for each AID that

fails validation (e.g. the user specifies STS-N-13 when SLOT-N only contains an OC-12) or for each AID

where no matching cross-connection is found. To determine the completion code, follow the rules from

the “Explicit List of AIDs - No Wildcards” section on page 1-15. If the result is either PRTL or

COMPLD, then a list of matching cross-connections will accompany the response.

1-16

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

TL1 Command Completion Behavior

1.9.2.2 Implicit List of AIDs - Single AID With Wildcard

If a set of AIDs is implied by the use of the ALL modifier on a single AID, then follow the same AID

expansion rule as defined in the example from the “Implicit List of AIDs - Single AID With Wildcard”

section on page 1-15. Then apply the following rules to the set:

1. If all valid AIDs match, COMPLD is returned with a matching list of cross-connections.

2. If some valid AIDs match but not all, COMPLD is returned with a matching list of

cross-connections.

3. If all valid AIDs fail to match, DENY is returned.

RTRV-CRS-STS1:[<TID>]:STS-9-ALL:<CTAG>; where STS-9-ALL maps to STS-9-{1,2,3,10,11,12}

because there is a single-port OC-12 card in Slot 3 with STS-3C defined for STS-9-4 and STS-9-7. You

then traverse the set and return only the STS1 cross-connections that exist using end points in that set.

If no cross-connections are retrieved, COMPLD is returned.

1.9.2.3 Explicit List Grouped With Implicit List

When you have determined the implicit list, apply the rules from the “Implicit List of AIDs - Single AID

With Wildcard” section on page 1-16 to the implicit list and the rules from the “Explicit List of AIDs -

No Wildcards” section on page 1-15 to the explicit list. Apply the following logic to the results from the

two subsets:

1. Explicit list returns COMPLD, implicit list returns COMPLD, return COMPLD plus matching list

2. Explicit list returns COMPLD, implicit list returns DENY, return PRTLwith errors plus matching

list

3. Explicit list returns PRTL, implicit list returns COMPLD, return PRTL with errors plus matching

lists

4. Explicit list returns PRTL, implicit list returns DENY, return PRTL with errors plus matching list

5. Explicit list returns DENY, implicit list returns COMPLD, return PRTL with errors plus matching

list

6. Explicit list returns DENY, implicit list returns DENY, return DENY with errors

1-17

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10 Test Access

The test access (TACC) feature allows a third-party Broadband Remote Test Unit (BRTU) to create

non-intrusive test access points (TAPs) to monitor the circuits on the ONS 15454/15327 for errors. The

test access feature also allows the circuit to be split (intrusive), so that the transmission paths can be

tested for bit errors via the use of various bit test patterns. The two BRTUs supported by the

ONS 15454/15327 are the Hekimian/Spirent BRTU-93 (6750) and the TTC/Acterna Centest 650.

The test access functionality provides TL1 commands for creating and deleting TAPs, connecting or

disconnecting TAPs to circuit cross-connects and changing the mode of test access on the

ONS 15454/15327. You can view test access information in CTC; in node view click the

Maintenance > Test Access tabs.

Refer to Telcordia document GR-834-CORE, Network Maintenance: Access and Testing and

GR-1402-CORE, Network Maintenance: Access Testing - DS3 HCDS TSC/RTU and DTAU Functional

Requirements for more information about Test Access. See Chapter 3, “TL1 Command Descriptions” for

TL1 command information.

A TAP provides the capability of connecting the circuit under test to a BRTU. This connection initially

provides in-service monitoring capability to permit the tester to determine that the circuit under test is

idle. The monitor connection should not disturb the circuit under test. The access point and remote test

unit (RTU) also provide the capability of splitting a circuit under test. A split consists of breaking the

transmission path of the circuit under test. This is done out of service. The two sides of the access point

are called the Equipment (E) and Facility (F) directions. For a 4-wire or 6-wire circuit, the transmission

pairs within the access point are defined as the A and B pairs. The circuit under test should be wired into

the access point so the direction of transmission on the A pair is from E to F, and the transmission

direction for the B pair is from F to E (Figure 1-2).

Figure 1-2 Circuit with no access

61106

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-18

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.1 Test Access Terminology

BRTU—Broadband remote test unit

DFAD—Dual facility access digroup

FAD—Facility access digroup

FAP—Facility access path

MONE—Monitor access with signal detector on A path

MONF—Monitor access with signal detector on B path

MONEF—Monitor access with signal detector on A and B paths

SPLTA—Split access on A path with signal detector from equipment, QRS on facility side

SPLTB—Split access on B path with signal detector from equipment, QRS on equipment side

SPLTE—Split access on A and B paths with signal detector from equipment, QRS on equipment side

SPLTF—Split access on A and B paths with signal detector from equipment, QRS on facility side

SPLTEF—Split access on A and B paths for testing in both equipment and facility directions

LOOPE—Split/loop access on A and B paths equipment side

LOOPF—Split/loop access on A and B paths facility side

QRS—Quasi-random signal (bit test pattern)

TACC—Test access

TAP—Test access path/point

Path Naming Conventions:

E—Equipment test access point direction

F—Facility test access point direction

A—Transmission path (the direction of transmission on the A pair is from E to F)

B—Transmission path (the transmission direction for the B pair is from F to E)

1.10.2 TAP Creation and Deletion

The edit command (ED-<rr>) is used to change an existing port, STS, or VT to a TAP.

Input Format:

ED-(STS_PATH):[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,]

[RVRTV=<RVRTV>,][RVTM=<RVTM>,][SWPDIP=<SWPDIP>,][EXPTRC=<EXPTRC>,]

[TRC=<TRC>,][TRCMODE=<TRCMODE>,][TACC=<TACC>]:[<PST>],[<SST>];

Edit an existing port, STS, or VT and change it to a TAP so it can be used when requesting TACC

connections. Includes a new optical parameter TACC=n that defines the port, STS, or VT as a TAP with

a selected unique TAP number. This TAP number will be used when requesting test access connections

to circuit cross-connections under test. The TAP creation will fail if there is a cross-connection already

on the port, STS, or VT.

1-19

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

The following list applies to TAP numbers:

1. The TAP number is an integer within the range of 1–999. When TACC=0 is specified, the TAP is

deleted (if already present).

2. The TAP number is unique across T1/T3/STS/VT/DS1 TAPs in the system.

3. The TAP number is not editable.

1.10.2.1 ED-T1

When the ED-T1 command is issued with a specified TACC value for a given T1 port/facility, a dual

facility access group (DFAD) is created by using the specified port/facility and the consecutive

port/facility.

Example 1-1 ED-T1::FAC-1-1:12:::TACC=1;

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

This command creates a DFAD on FAC-1-1 and FAC-1-2.

Note These ports/facilities cannot be used for the creation of cross-connects until the TAP is deleted.

1.10.2.2 ED-T3

When the ED-T3 command is issued with a specified TACC value for a given T3 port/facility, a DFAD

is created by using the specified port/facility and the consecutive port/facility.

The command in Example 1-2 creates a T3 DFAD on FAC-2-1 and FAC-2-2.

Example 1-2 ED-T3::FAC-2-1:12:::TACC=2;

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

Note These ports/facilities cannot be used for the creation of cross-connects until the TAP is deleted.

1-20

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.2.3 ED-DS1

When the ED-DS1 command is issued with a specified TACC value for a given DS1 facility on a

DS3XM, a DFAD is created by using the specified facility and the consecutive port/facility.

The command in Example 1-3 creates DFAD on DS1-2-1-1 and DS1-2-1-2.

Example 1-3 ED-DS1::DS1-2-1-1:12:::TACC=3;

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

Note These ports/facilities cannot be used for the creation of cross-connects until the TAP is deleted.

1.10.2.4 ED-STSn

When the ED-STSn command is issued for a TACC it assigns the STS for the first 2-way test access

connection and STS+1 as the second 2-way connection. For STS3c, STS9c, STS12c, STS24c, and

STS48c the next consecutive STS of same width is chosen. The TAP creation will fail if either of the

consecutive STSs are not available.

The command in Example 1-4 creates a TAP on STS-5-1 and STS-5-2.

Example 1-4 ED-STS1::STS-5-1:12:::TACCC=4

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

Note These STSs cannot be used for the creation of cross-connects until the TAP is deleted.

The command in Example 1-5 creates an STS24C dual TAP on STS-6-1 and STS-6-25.

Example 1-5 ED-STS24C::STS-6-1:12:::TACC=5:

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

Note These STSs cannot be used for the creation of cross-connects until the TAP is deleted.

1-21

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.2.5 ED-VT1

When the ED-VT1 command is issued for a TACC, a VT TAP is created. The specified VT AID is taken

as the first VT connection, the second VT connection is made by incrementing the VT group and keeping

the VT number the same.

The command in Example 1-6 creates a VT TAP on VT1-1-1-1-1 and VT1-1-1-2-1.

Example 1-6 ED-VT1-1-1-1-1:12:::TACC=6;

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

Note These VTs cannot be used for the creation of cross-connects until the TAP is deleted.

1.10.3 Connect Test Access Points

The CONN-TACC command (CONN-TACC-<rr>) is used to make a connection between the TAP and

the circuit or cross-connect under test.

Input Format: CONN-TACC-(T1, T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, VT1,

DS1):[<TID>]:<AID>:<CTAG>::<TAP>:MD=<MD>;

Connect the port/STS/VT defined by <AID> to the port/STS/VT defined by the <TAP> number. The

mode of test access to the circuit/cross-connect is specified by <MD>. The modes can be either of

monitor (non-intrusive), split or loop (intrusive) modes. The various modes are described in the “Test

Access Mode Definitions” section on page 1-26.

Note The connection is maintained only for the duration of the TL1 session (non-persistent).

Note The TAP number is displayed at the output if the CONN-TACC command completes successfully.

Error Codes Supported:

RTBY—Requested TAP busy

RTEN—Requested TAP does not exist

SCAT—Circuit is already connected to another TAP

SRCN—Requested condition already exists

IIAC—Invalid access identifier (AID)

EANS—Access not supported

SRAC—Requested access configuration is invalid

1-22

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

The command in Example 1-7 creates a connection between TAP with number one and the port/facility

FAC-1-3 with access mode as MONE. The various modes are described in the “Test Access Mode

Definitions” section on page 1-26.

Example 1-7 CONN-TACC-T1::FAC-1-3:12::1:MD=MONE;

DV9-99 1970-01-02 02:51:54

M 12 COMPLD

;

1.10.4 Change Access Mode

The CHG-ACCMD command (CHG-ACCMD-<rr>) is used to change the access mode.

Input Format: CHG-ACCMD-(T1, T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,

VT1, DS1):[<TID>]:<TAP>:<CTAG>::<MD>;

Change the type of test access. This may be a change from monitoring the data to inserting data into the

STS. This command can only be applied to an existing TAP connection. If a TAP connection does not

exist, a RTEN error is returned.

Error codes supported:

SRCN—Requested condition already exists

SRAC—Requested access configuration is invalid

RTEN—Requested TAP does not exist

The command in Example 1-8 changes the access mode of TAP 1 to LOOPE.

Example 1-8 CHG-ACCMD-T1::1:12::LOOPE;

DV9-9 1970-01-02 02:59:43

M 12 COMPLD

;

Note The access mode cannot be changed if the TAP is not connected.

1.10.5 Disconnect Test Access Points

TAPs can be disconnected in the following ways:

•Issue the DISC-TACC command

•Delete or modify accessed connection

•Drop the TL1 session for any reason, including logout or a dropped telnet session

•Switch or reset a TCC+/TCC2or XTC

The DISC-TACC command disconnects the <TAP> and puts the connection back to it’s original state

(no access). To issue the DISC-TACC command, follow the input format and examples shown below:

Input Format: DISC-TACC:[<TID>]:<TAP>:<CTAG>;

1-23

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

The command in Example 1-9 disconnects TAP 1 from the circuit/cross-connect under test.

Example 1-9 DISC-TACC::1:12;

DV9-99 1970-01-02 02:59:43

M 12 COMPLD

;

Error codes supported:

SADC—Already disconnected

SRTN—Unable to release TAP

1.10.6 Delete Test Access Points

The command in Example 1-10 deletes a TAP.

Example 1-10 ED-<STS_PATH>:[<[TID>]:<AID>:<CTAG>:::TACC=0:;

Note The TACC number must be set to zero in order to delete a TAP.

Note If a TAP is not removed the STS bandwidth will be stranded.

1.10.7 Retrieve Test Access Point Information

The RTRV-TACC command retrieves TAP information. See the “RTRV-TACC: Retrieve Test Access”

section on page 3-238 for more information.

Input Format: RTRV-TACC:[<TID>]:<TAP>:<CTAG>;

<TAP> indicates the assigned numeric number for the AID being used as a test access point. The <TAP>

number must be an integer with a range of 1–999. The ALL TAP value means that the command will

return all the configured TACCs in the NE. <TAP> is a string and must not be null.

Example 1-11 RTRV-TACC::ALL:12;

PTLM6-454A59-52 1970-01-10 09:51:27

M 12 COMPLD

“1:STS-2-1,STS-2-2,MONE,STS-2-3,STS-2-4”

“2:VT1-1-1-1-1,VT1-1-1-2-1,MONF,VT1-1-1-3-1,VT1-1-1-4-1”

;

Parameter definitions:

•<TAP> indicates the assigned numeric number for the AID being used as a TAP; <TAP> is a string

•<TACC_AID1> is the STS or VT AID that was designated as a test access point and assigned to the

TAP; <TACC_AID1> is from the “ALL” section on page 4-10

•<TACC_AID2> is the STS or VT AID that was designated as a test access point and assigned to the

TAP+1; <TACC_AID2> is from the “ALL” section on page 4-10

1-24

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

•<MD> indicates the test access mode. It identifies the status of the circuit connected to the TACC.

Valid values are shown in the “TACC_MODE” section on page 4-92

•<E_CONN> indicates the E side STS or VT AID of a circuit connected to the TACC or under test;

<E_CONN> is from the “ALL” section on page 4-10 and is optional

•<F_CONN> indicates the F side STS or VT AID of a circuit connected to the TACC or under test;

<F_CONN> is from the “ALL” section on page 4-10

1.10.8 Test Access Configurations

Figure 1-3 Single node view (Node 1)

Example 1-12 ED-STS1::STS-1-1:90:::TACC=1:;

This command changes STS1 and STS2 on Slot 1 to a TAP. The <CTAG> is 90. Sets the TAP number

to 1.

Example 1-13 CONN-TACC-STS1::<AID for E or F depending on MD>:91::TAP-1:MONE

This command connects the <AID> to the TACC defined by TAP 1 on the E side. <CTAG> is 91.

Note The connection made in the CONN-TACC command can use MONE to connect to the F side <AID>.

The <AID> provided designates the E side and the other automatically becomes the F side. For example,

if an <AIDF> is supplied to a MONE connection the top line would be connected to the side of the path,

or what is shown in the diagram as the F side. Once a CONN-TACC is set up, these designations cannot

change until a DISC-TACC or another CONN-TACC command is issued. The connection is based on the

<AID> supplied.

Note In the Figure 1-3 configuration there may be a single DS3 port wired-up but configured as 14 dual FADs

(28 VTs).

RTU

Test Set

71716

1-25

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

Figure 1-4 Multi-node view (MONE example)

On NE3:

Example 1-14 ENT-CRS-STS1::<AID I-G>:100::2WAY; A connection, not a TAP. CTAG is 100.

ENT-CRS-STS1::<AID J-H>:101::2WAY; Second connection, not a TAP.

On NE1:

Assuming the path from A to B is already entered; the A and B points in the diagram refer to entry and

exit points on the node or different cards. The E/F designators refer to the two 2-way connections from

NE3.

Example 1-15 ED-STS1::STS-1-1:TACC=4; Creates TAP with STS-1-1 and STS-1-2 through NE1. TAP

number assigned is 4.

Example 1-16 CONN-TACC-STS1::<AID A or B>:102::4:<MD> Connects TAP #4 to the circuit.

Note The I and J connections above are TAPs in Figure 1-3, but normal connections in the Figure 1-4

configuration.

RTU

OC12

NE1

NE2

NE3

71717

1-26

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.9 Test Access Mode Definitions

The following diagrams show what the different test access modes <MD> refer to. Figure 1-5 shows a

circuit with no access followed by all the modes. The QRS may be generated by an outside source, i.e.

the empty connection of the BRTU.

Figure 1-5 Circuit with no access

1.10.9.1 MONE

Monitor E (MONE) indicates a monitor connection provided from the facility access digroup (FAD) to

the A transmission path of the accessed circuit (Figure 1-6). This is a non-intrusive mode.

Figure 1-6 MONE access

61106

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

61107

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-27

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.9.2 MONF

Monitor F (MONF) indicates that the FAD is providing a monitor connection to the B transmission path

of the accessed circuit (Figure 1-7). This is a non-intrusive mode.

Figure 1-7 MONF access

Note The MONE and SPLTA modes are applicable to unidirectional circuits from E to F. The MONF and

SPLTB modes are applicable to unidirectional circuits from F to E.

1.10.9.3 MONEF

Monitor EF (MONEF) is a monitor connection provided from the FAD1 (odd pair) to a DFAD, to the A

transmission path and from FAD2 (even pair) of the same DFAD, to the B transmission path of the

accessed circuit. This is a non-intrusive mode.

MONEF for T3 (DS3 HCDS) indicates that the odd pair of a FAP is providing a monitor connection to

the A transmission path and from the even pair of a facility access path (FAP) to the B transmission path

of the accessed circuit.

Figure 1-8 MONEF access

61108

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

61109

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-28

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.9.4 SPLTE

Split E (SPLTE) indicates to split both the A and B paths and connect the E side of the accessed circuit

to the FAD. Figure 1-9 through 1-11 show split E and F access modes.

Figure 1-9 SPLTE access

1.10.9.5 SPLTF

Split F (SPLTF) indicates to split both the A and B paths and connect the F side of the accessed circuit

to the FAD.

Figure 1-10 SPLTF access

61110

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

61111

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-29

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.9.6 SPLTEF

Split EF (SPLTEF) for T1 (DS1 HCDS) indicates to split both the A and B paths, connect the E side of

the accessed circuit to FAD1 and the dual facility access digroup (DFAD) pair, and connect the F side to

the FAD2 of the same DFAD pair. SPLTEF for T3 (DS3 HCDS) indicates to split both the A and B paths

and connect the E side of the accessed circuit to the odd pair of the FAP and the F side to the even pair

of the FAP.

Figure 1-11 SPLTEF access

1.10.9.7 LOOPE

Loop E (LOOPE) indicates to split both the A and B paths, connect the incoming line from the E

direction to the outgoing line in the E direction, and connect this looped configuration to the FAD. Loop

E and F modes are basically identical to the SPLT E and F modes except that the outgoing signal is the

incoming signal and not the signal from the remote test unit (RTU).

Figure 1-12 LOOPE access

61112

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

61113

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-30

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.9.8 LOOPF

Loop F (LOOPF) indicates to split both the A and B paths, connect the incoming line from the F direction

to the outgoing line in the F direction and connect this looped configuration to the FAD.

Figure 1-13 LOOPF access

1.10.9.9 SPLTA

Split A (SPLTA) indicates that a connection is provided from both the E and F sides of the A transmission

path of the circuit under test to the FAD and split the A transmission path. Split A and B access modes

are shown in Figure 1-14 and Figure 1-15. These modes are similar to the Split E and F modes, except

the signals are sent to the RTU, not the NE signal configuration.

Figure 1-14 SPLTA access

61114

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

61115

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-31

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.9.10 SPLTB

Split B (SPLTB) indicates that a connection is provided from both the E and F sides of the B transmission

path of the circuit under test to the FAD and split the B transmission path.

Figure 1-15 SPLTB access

1.10.10 Unmapped AID Test Access Point Connections

The ONS 15454/15327 supports connections to unmapped AIDs (unmapped circuits). The TAPs can be

connected to an unmapped AID, i.e. an AID that does not have a cross-connect on it. The access modes

supported are: MONE, SPLTE, and LOOPE.

Example 1-17 ED-STS1::STS-5-1:12:::TACC=1;

DV9-99 1970-01-02 03:16:11

M 12 COMPLD

;

This command creates a TAP on STS-5-1 and STS-5-2.

Example 1-18 CONN-TACC-STS1::STS-5-3:12::1:MD=MONE;

DV9-99 1970-01-02 02:51:54

M 12 COMPLD

;

Note STS-5-3 does not have a cross-connect on it. This command creates an unmapped AID connection with

the MONE access mode. STS-5-3 becomes unusable until the connection is disconnected by the

DISC-TACC command.

Note The <AID> provided in the CONN-TACC command designates the E side and the other automatically

becomes the F side.

61116

"Mapped"

AID

Dual-FAD TAP

(2 times the bandwidth

of the circuit accessed)

1-32

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

Note In the case of all 1-way circuits (1-way, UPSR_HEAD, UPSR_DROP, UPSR_DC, UPSR_EN): If the

<AID> specified is the source AID, the direction is designated as From E in the above table. If the

<AID> specified is the destination AID or the drop side, the direction is designated as From F in the

above table.

Examples:

The following examples assume an STS TAP is already created with TAP number = 1.

1.10.10.1 1-Way Circuit

Example 1-19 ENT-CRS-STS1::STS-5-1,STS-5-2:12::1WAY;

DV9-99 1970-07-01 20:29:06

M 12 COMPLD;

Example 1-20 CONN-TACC-STS1::STS-5-1:12::1:MD=MONF;

DV9-99 1970-01-01 20:29:47

M 12 DENY

EANS

STS-5-1

/*INCORRECT TAP MODE*/

The <AID> specified in the above CONN-TACC command is the source AID for the 1-way circuit. In

this case only MONE and SPLTA modes are allowed because there is no B path in the case of a 1-way

circuit (see Table 1-3 on page 1-33).

Example 1-21 CONN-TACC-STS1::STS-5-1:12::1:MD=MONE;

DV9-99 1970-01-01 20:30:09

M 12 COMPLD

Example 1-22 DISC-TACC::1:12;

DV9-99 1970-01-01 20:30:20

M 12 COMPLD

;

However if the <AID> specified is the destination AID as shown below, the modes allowed are MONF

and SPLTB.

Example 1-23 CONN-TACC-STS1::STS-5-2:12::1:MD=MONF;

DV9-99 1970-01-01 20:30:32

M 12 COMPLD

Notes:

1. The same examples apply for UPSR_HEAD, UPSR_DROP, UPSR_DC and UPSR_EN which are all

1-way circuits.

2. The connections are made only to the working path irrespective of which path is currently active.

1-33

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

Test Access

1.10.10.2 2-Way Circuits

For 2-way circuits all the modes are allowed as shown in Table 1-3 and the same applies for

UPSR_UPSR and UPSR circuit types. In the case of UPSR_UPSR and UPSR circuits the working path

is connected irrespective of which path is currently active.

1.10.10.3 Unmapped AID

As explained in the “Unmapped AID Test Access Point Connections” section on page 1-31, connections

can be made to an <AID> without a cross-connect on it. The modes supported are MONE, SPLTE and

LOOPE as shown in Table 1-3.

Table 1-3 Modes Supported by Circuit Type

MONE MONF MONEF SPLTE SPLTF SPLTEF LOOPE LOOPF SPLTA SPLTB

1-way (from E) X X

1-way (from F) X

2-way XXXXXXXXXX

UPSR XXXXXXXXXX

UPSR_HEAD

(from E)

X X

UPSR_HEAD

(from F)

X X

UPSR_DROP

UPSR_DC

UPSR_EN

(from E)

X X

UPSR_DROP

UPSR_DC

UPSR_EN

(from F)

X X

UPSR_UPSRXXXXXXXXXX

Unmapped AIDXXX

1-34

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

TL1 PCA Provisioning

1.11 TL1 PCA Provisioning

You can provision or retrieve protection channel access (PCA) cross-connections on two-fiber and

four-fiber BLSR topologies at these supported OC rates: OC12 (two-fiber only), OC48, and OC192. The

traffic on the protection channel is referred to as extra-traffic and has the lowest priority level.

Extra-traffic will be preempted by any working traffic that requires the use of the protection channel.

In a two-fiber BLSR the extra traffic is provisioned on the upper half of the bandwidth path. In a

four-fiber BLSR the extra traffic is provisioned on the protect fiber. The PCA provisioning feature allows

you to establish the PCA cross-connection on the protection path of the two-fiber BLSR and protection

channel of the four-fiber BLSR only when the query is an explicit request.

There are two PCA connection types: 1WAYPCA and 2WAYPCA. The PCA cross-connection is

provisioned only when the user provides an explicit request using the ENT-CRS-STSp/VT1 commands.

If the cross-connection is a PCA cross-connection, either 1WAYPCA or 2WAYPCA is shown in the CCT

field of the RTRV-CRS-STSp/VT1 command output.

1WAYPCA and 2WAYPCA are only used in the TL1 user interface to provide usability and visibility for

the user to specify a PCA cross-connection type in the TL1 cross-connection commands.

Note The network must be configured as either a two-fiber or four-fiber OC-12, OC-48, or OC-192 BLSR.

Note The STS or VT1 path cross-connection can be established with TL1 commands (ENT-CRS-xxx).

Note Because the RTRV-CSR-xxx command does not include the optional CTYPE field to specify a

connection type, the output result reports the matched cross-connections based on the queried AID(s);

therefore, the retrieved cross-connection inventory can be both PCA and non-PCA cross-connections.

1.11.1 Provision a PCA Cross-Connection

Input format for provisioning a PCA cross-connection:

Example 1-24 ENT-CRS-<PATH>:[<TID>]:<FROM>,<TO>:<CTAG>::[<CCT>][::];

<PATH>::={STS_PATH | VT1}

[<C CT >]: :={ 1WAY, 1WAYD C, 1WAYE N, 2 WAY, 1WAY PCA , 2WAY PCA }, it de fau lts to 2 WAY.

{STS_PATH}::={STS1 | STS3C | STS6C | STS9C | STS12C | STS24C | STS48C | STS192C}

STS= all the STS bandwidth cross-connections.

VT1=VT1_5 cross-connection.

1-35

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

Input example of provisioning an STS3C PCA cross-connection:

Example 1-25 ENT-CRS-STS3C::STS-1-1,STS-2-1:123::2WAYPCA;

Note If the [<CCT>] of this cross-connection provisioning command is either 1WAYPCA or 2WAYPCA, and

the NONE of both <FROM> and <TO> AID is PCA AID, an IIAC ( Input, Invalid PCA AIDs) error

message is returned.

Note If sending this command with a non-PCA connection type (CCT), and one (or two) AIDs is/are the PCA

AIDs, an IIAC (The PCA AID Is Not Allowed for the Queried CCT Type) error message is returned.

1.11.2 Retrieve a PCA Cross-Connection

Input Format for retrieving a PCA cross-connection:

Example 1-26 RTRV-CRS-[<PATH>]:[<TID>]:<AID>:<CTAG>[::::];<PATH>::={STS_PATH | VT1 | STS }

If PATH is STS, it will retrieve all the STS cross-connections based on the queried AIDs.

<AID>={FacilityAIDs, STSAIDs, VTAIDs, ALL}

Output format of the PCA STSp cross-connection retrieval command:

Example 1-27 “<FROM>,<TO>:2WAYPCA,STS3C”

Output format of the PCA VT cross-connection retrieval command:

Example 1-28 “<FROM>,<TO>:2WAYPCA”

1.12 FTP Software Download

The file transfer protocol (FTP) software download feature downloads a software package to the inactive

flash partition residing on either the TCC+/TCC2 or XTC card. FTP software download provides for

simplex and duplex TCC+/TCC2 or XTC card downloads, success and failure status, and in-progress

status at 20% increments.

1.12.1 COPY-RFILE

The COPY-RFILE command downloads a new software package from the location specified by the FTP

URL into the inactive flash partition residing on either the TCC+/TCC2 or XTC card.

Input format:

Example 1-29 COPY-RFILE:[<TID>]:[<SRC>]:<CTAG>::TYPE=<XFERTYPE>,[SRC=<SRC1>]:

1-36

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

where:

•SRC is the type of file being transferred and is from the “RFILE” section on page 4-24

•<XFERTYPE> is the file transfer protocol; valid values can be found in the “TX_TYPE” section on

page 4-95

•<SRC1> specifies the source of the file to be transferred. Only the FTP URL is supported. In a

non-firewall environment the format for the URL is:

“FTP://FTPUSER[:FTPPASSWORD]]@FTPHOST/PACKAGE_PATH”

where:

–

userid is the userid to connect to the computer with the package file

–

password is the password used to connect to the computer with the package file

–

hostname is the IP address of the computer with the package file. DNS lookup of hostname is

not supported.

–

package_path is the long path name to the package file

Note Userid and password are optional if the user does not need to log into the host computer. The

password may be optional if the user does not need to log in. All other portions of the URL

are required, including the initial “FTP://” string.

In a firewall environment the hostname should be replaced with a list of IP addresses each separated

by a “@” character. The first IP address should be for the computer where the package file is stored.

Subsequent IP addresses are for firewall computers moving outward toward the edge of the network

until the final IP address listed is the computer that outside users use to first access the network.

For example, if your topology is:

“FTPHOST <-> GNE3 <->GNE2 <-> GNE1 <-> ENE”

the FTP URL is:

FTP://FTPUSER:FTPPASSWORD@FTPHOST@GNE3@GNE2@GNE1/PACKAGE_PATH

SRC1 is a String

Notes:

1. SWDL is the only allowable <XFERTYPE>.

2. FTP is the only allowed file transfer method.

3. The use of the SWDL and the extended FTP URL syntax are required by the COPY-RFILE syntax.

1.12.2 APPLY

The APPLY command can activate or revert software depending on the version of software loaded on

the active and protect flash. An error is returned if attempting to activate to an older software load or

trying to revert to a newer software load. If this command is successful the appropriate flash is selected

and the TCC+/TCC2 or XTC card will reboot.

Input format:

Example 1-30 APPLY:[<TID>]::<CTAG>[::<MEM_SW_TYPE>]:

1-37

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

where:

•<MEM_SW_TYPE> indicates memory switch action during the software upgrade.

<MEM_SW_TYPE> is ACT for activate and RVRT for revert.

1.12.3 REPT EVT FXFR

REPT EVT FXFR is an autonomous message used to report the start, completion, and completed

percentage status of the FTP software download. REPT EVT FXFR also reports any failure during the

software upgrade including invalid package, invalid path, invalid userid/password, and loss of network

connection.

Note:

1. The “FXFR_RSLT” is only sent when the “FXFR_STATUS” is COMPLD.

2. The “BYTES_XFRD” is only sent when the “FXFR_STATUS” is IP or COMPLD.

Output format:

Example 1-31 SID DATE TIME

A ATAG REPT EVT FXFR

“<FILENAME>,<FXFR_STATUS>,[<FXFR_RSLT>],[<BYTES_XFRD>]”

;

where:

•<FILENAME> indicates the transferred file path name and is a string

•<FXFR_STATUS> indicates the file transferred status: Start, IP (in progress), or COMPLD

•<FXFR_RSLT> indicates the file transferred result: success or failure. <FXFR_RSLT> is optional

•<BYTES_XFRD> indicates the percentage transfer complete and is optional

1.12.4 Downloading New Software

The following procedure downloads new software to the TCC+/TCC2 or XTC card using TL1.

Download New Software

Note Only Superusers can download and activate software.

Step 1 Copy the new software package (15454-0340-X02E-2804.pkg) to an FTP host.

Step 2 Establish a TL1 session with the target NE.

Step 3 Login with the ACT-USER command.

Step 4 Check the working and protect software on the NE by issuing the RTRV-NE-GEN command.

Input example:

Example 1-32 RTRV-NE-GEN:::1;

1-38

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

Output example:

Example 1-33 VA454-94 1970-01-06 22:22:12

M 1 COMPLD

“IPADDR=1-.82.87.94,IPMASK=255.255.254.0,DEFRTR=10.82.86.1,

ETHIPADDR=10.82.87.94,ETHIPMASK=255.255.254.0,NAME=VA454-94,

SWER=3.40.00,LOAD=03.40-002G-14.21,PROTSWVER=4.00.00,

PROTLOAD=04.00-X02G-25.07,DEFDESC=\”FACTORY DEFAULTS\””

;

Step 5 Issue the COPY-RFILE command. This command will initiate the download process. Refer to the

“COPY-RFILE” section on page 1-35 for command syntax.

In the following example the package is located in “/USR/CET/VINTARA” in the host 10.77.22.199.

The userid and passwords are TL1 and CISCO454. The directory path of the package is similar to what

you will see during an FTP session.

Example 1-34 COPY-RFILE::RFILE-

PKG:CTAG::TYPE=SWDL,SRC=”FTP://TL1:CISCO454@10.77.29.199

/USR/CET/VINTARA/15454-0340-X02E-2804.PKG”;

DEV208 1970-01-10 11:51:57

M CTAG COMPLD

;

Step 6 If any of the parameters are wrong or if the host is not accessible, a REPT EVT FXFR message will

report from the following list. A download failure may be due to one or more of the following:

•Directory path of the package is invalid or not found

•Package is invalid (i.e., ONS 15454 package on an ONS 15327, vice-versa, or an invalid file type)

•Package not found on specified path

•Userid/password or hostname is invalid

•Host is not accessible

•Firewall userid/password or host in invalid

•Node rebooted/lost connection during download

•If software download is already in progress

•If the node or the host timed out during FTP protocol

Example 1-35 DEV208 1970-01-10 11:52:02

A 2816.2816 REPT EVT EQPT

“SLOT-11:SFTWDOWN-FAIL,TC,,,,,,,:\”SOFTWARE DOWNLOAD FAILED\”,TCC

;

Step 7 If the download is successful the REPT EVT FXFR message will report an active start:

Example 1-36 DEV208 1970-01-10 11:52:15

A 2818,2818 REPT EVT FXFR

“ACTIVE START”

;

Step 8 A SFTDOWN minor alarm is raised to indicate that the software download is in progress. The

SFTDOWN alarm will clear when the download is complete.

1-39

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

Example 1-37 DEV208 1970-01--10 11:52:15

* 2817.2817 REPT ALM EQPT

“SLOT-7:MN,SFTWDOWN,NSA,,,,:\”SOFTWARE DOWNLOAD IN PROGRESS\”,TCC”

;

Use the in-progress status at any time during the software download to verify the RTRV-NE-GEN

command.

Example 1-38 RTRV-NE-GEN

VA454-94 1970-01-06 22:22;12

M 1 COMPLD

“IPADDR=10.82.87.94,IPMASK=255.255.245.0,DEFRTR=10.82.86.1,

ETHIPADDR=10.82.87.94,EHTIPMASK=255.255.254.0,NAME=VA454-94,

SWVER=3.40.00,LOAD=03.40-002G-14-21,PROTSWVER=NONE,

PROTLOAD=DOWNLOADINPROGRESS,DEFDESC=\:FACTORY DEFAULTS\””

;

Step 9 The download progress is reported by the REPT EVT FXFR message which will report a message after

every 20% of download is complete as shown:

Example 1-39 DEV208 1970-01-10 11:53:12

A 2820,2820 REPT EVT FXFR

“ACTIVE,IP,,20”

;

DEV208 1970-01-10 11:53:12

A 2820,2820 REPT EVT FXFR

“ACTIVE,IP,,40”

;

DEV208 1970-01-10 11:53:12

A 2820,2820 REPT EVT FXFR

“ACTIVE,IP,,60”

;

DEV208 1970-01-10 11:53:12

A 2820,2820 REPT EVT FXFR

“ACTIVE,IP,,80”

;

Step 10 If the TL1 session times out during download or if the user terminates the TL1 session the download will

continue. The download completion can be confirmed by issuing the RTRV-NE-GEN command and

verifying the PROTLOAD.

Example 1-40 RTRV-NE-GEN:::1;

VA454-94 1970-01-06 22:22:12

M 1 COMPLD

“IPADDR=10.82.87.94,IPMASK=255.255.245.0,DEFRTR=10.82.86.1,

ETHIPADDR=10.82.87.94,EHTIPMASK=255.255.254.0,NAME=VA454-94,

SWVER=3.40.00,LOAD=03.40-002G-14-21,PROTSWVER=4.00.00,

PROTLOAD=03.40-X02E-28.04,DEFDESC=\:FACTORY DEFAULTS\””

;

Step 11 REPT EVT FXFR confirms the completion of the software download.

1-40

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

Example 1-41 DEV208 1970-01-10 12:01:16

A 2825,2825 REPT EVT FXFR

“ACTIVE,COMPLD,SUCCESS”

;

Step 12 The SFTDOWN alarm clears when the download is complete.

Example 1-42 DEV208 1970-01-10 11:52:15

* 2826,2817 REPT ALM EQPT

“SLOT-7:CL,SFTWDOWN,NSA,,,,:\”SOFTWARE DOWNLOAD IN PROGRESS\”,TCC”

;

1.12.5 Activating New Software

After the software is successfully downloaded, the new software which resides in the protect load must

be activated to run on the NE. The APPLY command can be used to activate and revert depending on the

version of the protect software and the newly downloaded software (refer to the “APPLY” section on

page 1-36 for correct APPLY syntax).

Activate New Software

Step 1 If the protect software is newer than the working software, activate it as shown:

Example 1-43 APPLY::1::ACT;

DEV208 1970-01-10 13:40:53

M 1 COMPLD

;

An error is reported if a revert is attempted with a newer protect software.

Step 2 If the APPLY command is successful, logout of the TL1 session using the CANC-USER command:

Example 1-44 CANC-USER::CISCO15:1;

VA454-94 1970-01-07 01:18:18

M 1 COMPLD

;

After a successful completion of the APPLY command the NE will reboot and the TL1 session will

disconnect. When the NE comes up after the reboot it will be running the new software. Traffic switches

are possible during activation.

1-41

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

1.12.6 Remote Software Download/Activation Using the GNE

In a network with SDCC-connected ONS 15454 and ONS 15327s, remote download and activation are

possible using the GNE/ENE feature supported in TL1. The GNE must be connected by a LAN and the

remaining ENEs can download the new software package through fiber from the GNE.

For remote software downloading, complete the steps in the “Download New Software” procedure on

page 1-37 and the “Activate New Software” procedure on page 1-40, but ensure that the TID in each

command is filled with the ENE node name.

A maximum of 5 ENEs (an additional session through craft interface) can be contacted using the GNE

sessions through the GNE by opening a single TL1 session on the GNE. For more information on TL1

Gateway, see Chapter 2, “TL1 Gateway.”

Example 1-45 ACT-USER:NODE1:CISCO15:1;

ACT-USER:NODE2:CISCO15:1;

ACT-USER:NODE3:CISCO15:1;

ACT-USER:NODE4:CISCO15:1;

ACT-USER:NODE5:CISCO15:1;

Five simultaneous software downloads can be initiated using the COPY-RFILE command with

appropriate TIDs. All downloads will be independent of each other and download speeds may differ.

Example 1-46 COPY-RFILE:NODE1:RFILE-PKG:CTAG::TYPE=SWDL,SRC=”FTP://TL1:

CISCO454@10.77.29.199/USR/CET/VINTARA/15454-0340-X02E-2804.PKG”;

COPY-RFILE:NODE2:RFILE-PKG...

COPY-RFILE:NODE3:RFILE-PKG...

COPY-RFILE:NODE4:RFILE-PKG...

COPY-RFILE:NODE5:RFILE-PKG...

Individual REPT EVT FXFR messages can be isolated using the node names. RTRV-NE-GEN also

requires the individual node names entered in the TID to see a specific download status.

You can activate the software on all of the nodes using the GNE node.

Note Activate the GNE last, after activating all the ENEs or else ENE connectivity will be lost when the GNE

starts to reboot for activation.

Example 1-47 APPLY:NODE1::1::ACT;

APPLY:NODE2::1::ACT;

APPLY:NODE3::1::ACT;

APPLY:NODE4::1::ACT;

APPLY:NODE5::1::ACT;

1-42

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 1 Getting Started

FTP Software Download

CHAPTER

2-1

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

TL1 Gateway

This chapter describes the TL1 Gateway and provides procedures and examples for implementing

TL1 Gateway on the ONS 15454 or ONS 15327.

2.1 Gateway Network Element Topology

You can issue TL1 commands to multiple nodes via a single connection through the TL1 Gateway. Any

node can serve as a Gateway Network Element (GNE), End-Point Network Element (ENE), or

Intermediate Network Element (INE). A node becomes a GNE when a TL1 user connects to it and enters

a command destined for another node. An ENE is an end node because it processes a TL1 command that

is passed to it from another node. An INE is an intermediate node because of topology; it has no special

hardware, software, or provisioning.

To implement the TL1 Gateway, use the desired ENE’s TID in the ACT-USER command to initiate a

session between the GNE and the ENE. Once a session is established you need to enter the ENE’s TID

in all of the subsequent commands that are destined for the ENE. From the GNE, you can access several

remote nodes which become the ENEs. The ENEs are the message destinations or origins. The INE

handles the DCC TCP/IP packet exchange.

The GNE Session is the connection that multiplexes TL1 messages between the OSS/craftsperson and

the GNE. The GNE demulitplexes incoming operations support system (OSS) TL1 commands and

forwards them to the remote ENE. The GNE also multiplexes incoming responses and autonomous

messages to the GNE Session. The ENE Session is the connection that exchanges messages between the

GNE and the remote ENE. Figure 2-1 shows the GNE topology.

2-2

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 2 TL1 Gateway

Gateway Network Element Topology

Figure 2-1 Example of a GNE topology

With the TCC2, each GNE can support eleven (10+1) concurrent gateway communication sessions

(connections from an OS to the GNE). Ten of these sessions are via the LAN (wire-wrap, active TCC2

LAN port, or DCC) and the eleventh session is reserved for the active TCC2 serial port. With the

XTC/TCC+, each GNE can support six (5+1) concurrent gateway communication sessions. Five of these

session are via the LAN (wire wrap, active XTC LAN port or DCC) and the sixth session is reserved for

the active XTC/TCC+ serial port.

On each gateway communication session a GNE can establish TL1 sessions to up to 31 additional DCC-

connected nodes, for a total DCC of 32 nodes. Each GNE can handle 32 nodes and 6 (XTC/TCC+) or 11

(TCC2) concurrent communication gateway sessions, and the GNE can handle up to a maximum of 96

(XTC/TCC+) or 176 (TCC2) ENEs/GNE. You can dynamically distribute the ENEs to balance the

number of concurrent gateway communication sessions versus the number of NEs on the DCC. The GNE

treats the 6 (5+1 for XTC/TCC+) or 11 (10+1 for TCC2) concurrent gateway communication sessions

and 96 (XTC/TCC+) or 176 (TCC2) ENEs/GNE limit as a resource pool (Table 2-1) and continues to

allocate resources until the pool is exhausted (see Table 2-2 for allocation examples). When the pool is

exhausted the GNE returns an “All Gateways in Use” message or an “All ENE Connections in Use”

message.

55276

Number of connections

Node 1 Node 2

OSS

Node 3

Autonomous messages

TLI Gateway node

Single connection

Command/Response

Table 2-1 Gateway Resource Pool

Number of GNEs Number of GNE Sessions Number of ENEs

1 (Cisco ONS 15327) 6 (5+1) 96 (dynamically allocated)

1 (Cisco ONS 15454) 11 (10+1) TCC2 176 (dynamically allocated)

6 (5+1) XTC/TCC+ 96 (dynamically allocated)

2-3

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 2 TL1 Gateway

Gateway Network Element Topology

Note Issuing commands to specific nodes in the network is accomplished by entering a unique node name in

the TID field in each TL1 message. The TID field is synonymous with the name of the node and is the

second token in a TL1 command.

Table 2-2 Examples of a Single GNE Topology Showing How the GNE/ENE Resources can be

Allocated

Number of GNE Communication Sessions Maximum Number of ENEs

131

262

393

496

Number of GNE Communication Sessions Number of ENEs

116

232

348

464

580

696

2-4

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 2 TL1 Gateway

Implementing TL1 Gateway

2.2 Implementing TL1 Gateway

The following procedures demonstrate TL1 Gateway on a four-node ring (without TL1 Gateway in

Figure 2-2 and with TL1 Gateway in Figure 2-3), where:

Node 0 is the GNE.

Node 1 is the ENE 1.

Node 2 is the INE 2.

Node 3 is the ENE 3.

Figure 2-2 Four-node ring without TL1 Gateway

Figure 2-3 Four-node ring with TL1 Gateway

55274

Node 3Node 2

Node 0

Node 1

55275

ENE 3INE 2

DCC Channel

GNE

ENE 1

TCP/IP

GNE Session

2-5

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 2 TL1 Gateway

Implementing TL1 Gateway

Log Into a Remote ENE

Step 1 Telnet or serial port to Node 0, which will become the GNE.

Step 2 To connect to the ENE 1 node, enter the TL1 login command using the following input example:

ACT-USER:NODE1:USERNAME:1234:PASSWORD;

The GNE forwards the login to ENE 1. After successful login, ENE 1 sends a COMPLD response.

Step 3 When you are logged into ENE 1, enter the following TL1 login command to connect to ENE 3:

ACT-USER:NODE3:USERNAME:1234:PASSWORD;

The GNE forwards the login to ENE 3. After successful login, the ENE 3 sends a COMPLD response.

Forward Commands by Specifying the ENE TID (Node 1 or Node 3)

When you are logged into ENE 1 and ENE 3, enter a command and designate a specific TID, as shown

in the following example:

RTRV-HDR:NODE1::1; will retrieve the header of Node 1 and

RTRV-HDR:NODE3::3; will retrieve the header of Node 3.

Receive Autonomous Messages from the Remote ENE

To receive autonomous messages from the remote ENE, you must log into the remote ENE. When you

are logged in, you will start receiving autonomous messages. The source of the message is identified by

the node TID as part of the message.

Log Out of a Remote ENE

To disconnect from a remote ENE, you must use the CANC-USER command as follows:

CANC-USER:NODE1:USERNAME:1; will disconnect ENE 1 and

CANC-USER:NODE3:USERNAME:3; will disconnect ENE 3.

The GNE forwards the logout to the remote ENEs. The GNE/ENE TCP session is closed.

2-6

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

March 2003

Chapter 2 TL1 Gateway

Implementing TL1 Gateway

CHAPTER

3-1

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

TL1 Command Descriptions

This chapter provides specific information on TL1 commands and autonomous messages for the

Cisco ONS 15454 and the Cisco ONS 15327, Release 4.0, including:

•TL1 commands by category

•TL1 commands by card

•TL1 commands

For information on command components, such as parameters, see Chapter 4, “TL1 Command

Components.”

3.1 TL1 Commands by Category

Table 3-1 TL1 Commands by Category

Category Command or Autonomous Message

BLSR DLT-BLSR

ED-BLSR

ENT-BLSR

EX-SW-<OCN_BLSR>

REPT EVT RING

RTRV-BLSR

RTRV-COND-RING

RTRV-TRC-<OCN_BLSR>

Cross Connections DLT-CRS-<STS_PATH>

DLT-CRS-VT1

ED-CRS-<STS_PATH>

ED-CRS-VT1

ENT-CRS-<STS_PATH>

ENT-CRS-VT1

RTRV-CRS

RTRV-CRS-<STS_PATH>

RTRV-CRS-VT1

3-2

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Category

DWDM (ONS 15454) DLT-FFP-CLNT

ED-CLNT

ED-DWDM

ED-FFP-CLNT

ED-OCH

ED-TRC-CLNT

ED-TRC-OCH

ENT-FFP-CLNT

OPR-PROTNSW-CLNT

RLS-PROTNSW-CLNT

RTRV-CLNT

RTRV-DWDM

RTRV-FFP-CLNT

RTRV-OCH

RTRV-PROTNSW-CLNT

RTRV-TRC-CLNT

RTRV-TRC-OCH

Environment Alarms and Controls OPR-ACO-ALL

OPR-EXT-CONT

REPT ALM ENV

REPT EVT ENV

RLS-EXT-CONT

RTRV-ALM-ENV

RTRV-ATTR-CONT

RTRV-ATTR-ENV

RTRV-COND-ENV

RTRV-EXT-CONT

SET-ATTR-CONT

SET-ATTR-ENV

Equipment ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

DLT-EQPT

ED-EQPT

ENT-EQPT

INH-SWDX-EQPT

INH-SWTOPROTN-EQPT

INH-SWTOWKG-EQPT

REPT ALM EQPT

REPT EVT EQPT

RTRV-ALM-EQPT

RTRV-COND-EQPT

RTRV-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT

Table 3-1 TL1 Commands by Category (continued)

Category Command or Autonomous Message

3-3

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Category

Fault REPT ALM <MOD2ALM>

REPT ALM COM

REPT ALM RING

REPT EVT <MOD2ALM>

REPT EVT COM

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-RING

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

IOS COPY-IOSCFG

REPT EVT IOSCFG

Log ALW-MSG-DBCHG

INH-MSG-DBCHG

REPT DBCHG

RTRV-LOG

Network RTRV-NE-IPMAP

RTRV-MAP-NETWORK

Performance ALW-PMREPT-ALL

INH-PMREPT-ALL

INIT-REG-<MOD2>

REPT PM <MOD2>

RTRV-PM-<MOD2>

RTRV-PMMODE-<STS_PATH>

RTRV-PMSCHED-<MOD2>

RTRV-PMSCHED-ALL

RTRV-TH-<MOD2>

SCHED-PMREPT-<MOD2>

SET-PMMODE-<STS_PATH>

SET-TH-<MOD2>

Ports ED-<OCN_TYPE>

ED-DS1

ED-EC1

ED-G1000

ED-T1

ED-T3

INIT-REG-G1000

RMV-<MOD2_IO>

RST-<MOD2_IO>

RTRV-<OCN_TYPE>

RTRV-DS1

RTRV-EC1

RTRV-FSTE

RTRV-G1000

RTRV-GIGE

RTRV-POS

RTRV-T1

RTRV-T3

Table 3-1 TL1 Commands by Category (continued)

Category Command or Autonomous Message

3-4

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Category

Security ACT-USER

ALW-MSG-SECU

CANC

CANC-USER

DLT-USER-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-USER-SECU

SONET Line Protection DLT-FFP-<OCN_TYPE>

ED-FFP-<OCN_TYPE>

ENT-FFP-<OCN_TYPE>

OPR-PROTNSW-<OCN_TYPE>

RLS-PROTNSW-<OCN_TYPE>

RTRV-FFP-<OCN_TYPE>

RTRV-PROTNSW-<OCN_TYPE>

Software Download APPLY

COPY-RFILE

REPT EVT FXFR

STS and VT Paths ED-<STS_PATH>

ED-VT1

RTRV-<STS_PATH>

RTRV-PTHTRC-<STS_PATH>

RTRV-VT1

Synchronization ED-BITS

ED-NE-SYNCN

ED-SYNCN

OPR-SYNCNSW

REPT ALM BITS

REPT ALM SYNCN

REPT EVT BITS

REPT EVT SYNCN

RLS-SYNCNSW

RTRV-ALM-BITS

RTRV-ALM-SYNCN

RTRV-BITS

RTRV-COND-BITS

RTRV-COND-SYNCN

RTRV-NE-SYNCN

RTRV-SYNCN

Table 3-1 TL1 Commands by Category (continued)

Category Command or Autonomous Message

3-5

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Category

System ALW-MSG-ALL

ED-DAT

ED-NE-GEN

INH-MSG-ALL

INIT-SYS

RTRV-HDR

RTRV-INV

RTRV-NE-GEN

RTRV-TOD

SET-TOD

Test Access CHG-ACCMD-<MOD_TACC>

CONN-TACC-<MOD_TACC>

DISC-TACC

RTRV-TACC

Testing OPR-LPBK-<MOD2>

RLS-LPBK-<MOD2>

UCP DLT-UCP-CC

DLT-UCP-IF

DLT-UCP-NBR

ED-UCP-CC

ED-UCP-IF

ED-UCP-NBR

ED-UCP-NODE

ENT-UCP-CC

ENT-UCP-IF

ENT-UCP-NBR

REPT ALM UCP

REPT EVT UCP

RTRV-ALM-UCP

RTRV-COND-UCP

RTRV-UCP-CC

RTRV-UCP-IF

RTRV-UCP-NBR

RTRV-UCP-NODE

UPSR Switching OPR-PROTNSW-<STS_PATH>

OPR-PROTNSW-VT1

REPT SW

RLS-PROTNSW-<STS_PATH>

RLS-PROTNSW-VT1

RTRV-PROTNSW-<STS_PATH>

RTRV-PROTNSW-VT1

Table 3-1 TL1 Commands by Category (continued)

Category Command or Autonomous Message

3-6

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

3.2 TL1 Commands by Card (ONS 15454)

Table 3-2 TL1 Commands by Card (ONS 15454)

G1000-4

ML1000-2

ML100T-12

EC1

DS1

DS1N

DS3

DS3N

DS3E

DS3NE

DS3XM

OC3

OC3-8

OC12

OC12-4

OC48

OC48AS

OC192

E100T

E1000T

TCC

TCC2

XCVT

XC192

XCVXL

AICI

AIC

MXP

TXP

ACT-USER

ALW-MSG-ALL

ALW-MSG-DBCHG

ALW-PMREPT-ALL

ALW-SWDX-EQPT XXX

ALW-SWTOPROTN-EQPT XXXXXXXX

ALW-SWTOWKG-EQPT XXXXXXXX

APPLY XX

CANC

CANC-USER

CHG-ACCMD-<CHG_ACCMD> XXXXXXXXXXXXXXX

CONN-TACC-<MOD_TACC> XXXXXXXXXXXXXXX

COPY-IOSCFG XX

COPY-RFILE XX

DISC-TACC XXXXXXXXXXXXXXX

DLT-BLSR XXXXX

DLT-CRS-VT1 X XXX XXXXXXXX

DLT-CRS-<STS_PATH> XXXXXXXXXXXXXXXXXX

DLT-EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

DLT-FFP-<OCN_TYPE> XXXXXXX

DLT-FFP-CLNT XX

DLT-UCP-CC XXXXXXX

DLT-UCP-IF

DLT-UCP-NBR

DLT-USER-SECU

ED-BITS X

ED-BLSR XXXXXXX

ED-CRS-<STS_PATH> XXXXXXXXXXXXXXXXXX

ED-CRS-VT1 XXXXXXXX

ED-CLNT XX

ED-DAT

ED-DS1 X

3-7

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

ED-DWDM XX

ED-EC1 X

ED-EQPT XXXXXXXX

ED-FFP-<OCN_TYPE> XXXXXXX

ED-FFP-CLNT XX

ED-G1000 X

ED-NE-GEN X

ED-NE-SYNCN X

ED-OCH XX

ED-PID

ED-SYNCN XX

ED-T1 XX

ED-T3 XXXXX

ED-TRC-CLNT XX

ED-TRC-OCH XX

ED-UCP-CC XXXXXXX

ED-UCP-IF XXXXXXX

ED-UCP-NBR

ED-UCP-NODE

ED-USER-SECU

ED-VT1 XXX XXXXXXXX

ED-<OCN_TYPE> XXXXXXX

ED-<STS_PATH> XXXXXXXXXXXXXXXXXX

ENT-BLSR XXXXX

ENT-CRS-VT1 XXXXXXXX

ENT-CRS-<STS_PATH> XXXXXXXXXXXXXXXXXX

ENT-EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

ENT-FFP-<OCN_TYPE> XXXXXXX

ENT-FFP-CLNT XX

ENT-UCP-CC XXXXXXX

ENT-UCP IF XXXXXXX

ENT-UCP-NBR

ENT-USER-SECU

EX-SW-<OCN_BLSR> XXXXXX

Table 3-2 TL1 Commands by Card (ONS 15454) (continued)

G1000-4

ML1000-2

ML100T-12

EC1

DS1

DS1N

DS3

DS3N

DS3E

DS3NE

DS3XM

OC3

OC3-8

OC12

OC12-4

OC48

OC48AS

OC192

E100T

E1000T

TCC

TCC2

XCVT

XC192

XCVXL

AICI

AIC

MXP

TXP

3-8

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

INH-MSG-ALL

INH-MSG-DBCHG

INH-MSG-SECU XX

ING-PMREPT-ALL

INH-SWDX-EQPT XXX

INH-SWTOPROTN-EQPT XXXXXXXX

INH-SWTOWKG-EQPT XXXXXXXX

INIT-REG-<MOD2> XXXXXXXXXXXXXXX

INIT-REG-G1000 X

INIT-REG-CLNT XX

INIT-SYS XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

OPR-ACO-ALL XX

OPR-EXT-CONT XX

OPR-LPBK-<MOD2> X XXXXXXXXXXXXXXX XX

OPR-PROTNSW-VT1 XXXXXXX

OPR-PROTNSW-<OCN_TYPE> XXXXXXX

OPR-PROTNSW-<STS_PATH> XXXXXXX

OPR-PROTNSW-CLNT XX

OPR-SYNCNSW XXXXXXX X

REPT ALM BITS X

REPT ALM COM

REPT ALM ENV XX

REPT ALM EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

REPT ALM RING XXXXX

REPT ALM SYNCN XXXXXXX X

REPT ALM <MOD2ALM> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

REPT ALM UCP

REPT DBCHG XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

REPT EVT BITS X

REPT EVT COM

REPT EVT ENV XX

REPT EVT FXFR XX

REPT EVT EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

REPT EVT IOSCFG XX

Table 3-2 TL1 Commands by Card (ONS 15454) (continued)

G1000-4

ML1000-2

ML100T-12

EC1

DS1

DS1N

DS3

DS3N

DS3E

DS3NE

DS3XM

OC3

OC3-8

OC12

OC12-4

OC48

OC48AS

OC192

E100T

E1000T

TCC

TCC2

XCVT

XC192

XCVXL

AICI

AIC

MXP

TXP

3-9

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

REPT EVT RING XXXXX

REPT EVT SECU

REPT EVT SESSION XX

REPT EVT SYNCN XXXXXXX X

REPT EVT <MOD2ALM> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

REPT EVT UCP

REPT PM <MOD2> XXXXXXXXXXXXXXX XX

REPT SW XXX

RLS-EXT-CONT XX

RLS-LPBK-<MOD2> X XXXXXXXXXXXXXXX

RLS-PROTNSW-CLNT XX

RLS-PROTNSW-VT1 XXXXXXX

RLS-PROTNSW-<OCN_TYPE> XXXXXXX

RLS-PROTNSW-<STS_PATH> XXXXXXX

RLS-SYNCNSW XXXXXXX X

RMV-<MOD2_IO> X XXXXXXXXXXXXXXX XX

RST-<MOD2_IO> X XXXXXXXXXXXXXXX XX

RTRV-ALM-ALL XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-ALM-BITS X

RTRV-ALM-ENV XX

RTRV-ALM-EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-ALM-RING XXXXX

RTRV-ALM-SYNCN XXXXXXX X

RTRV-ALM-<MOD2ALM> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-ALM-UCP

RTRV-ATTR-CONT XX

RTRV-ATTR-ENV XX

RTRV-BITS X

RTRV-BLSR XXXXX

RTRV-CKT-ORIG

RTRV-CKT-TERM

RTRV-CLNT XX

RTRV-COND-ALL XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-COND-BITS X

Table 3-2 TL1 Commands by Card (ONS 15454) (continued)

G1000-4

ML1000-2

ML100T-12

EC1

DS1

DS1N

DS3

DS3N

DS3E

DS3NE

DS3XM

OC3

OC3-8

OC12

OC12-4

OC48

OC48AS

OC192

E100T

E1000T

TCC

TCC2

XCVT

XC192

XCVXL

AICI

AIC

MXP

TXP

3-10

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

RTRV-COND-ENV XX

RTRV-COND-EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-COND-SYNCN X

RTRV-COND-<MOD2ALM> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-COND-RING XXXXX

RTRV-COND-UCP

RTRV-CRS XXXXXXXXXXXXXXXXXX

RTRV-CRS-VT1 XXX XXXXXXXX

RTRV-CRS-<STS_PATH> XXXXXXXXXXXXXXXXXX

RTRV-DWMD XX

RTRV-EC1 X

RTRV-DS1 X

RTRV-EQPT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-EXT-CONT XX

RTRV-FFP-CLNT

RTRV-FFP-<OCN_TYPE> XXXXXXX

RTRV-FSTE XX

RTRV-G1000 X

RTRV-GIGE XX

RTRV-HDR

RTRV-INV XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

RTRV-LOG

RTRV-MAP-NETWORK

RTRV-NE-GEN X

RTRV-NE-IPMAP XXXXXXX

RTRV-NE-SYNCN X

RTRV-OCH XX

RTRV-PM-<MOD2> XXXXXXXXXXXXXXX XX

RTRV-PMMODE-<STS_PATH> XXXXXXXXXXXXXXX

RTRV-PMSCHED-<MOD2> XXXXXXXXXXXXXXX XX

RTRV-PMSCHED-ALL XX

RTRV-POS XX

RTRV-PROTNSW-<OCN_TYPE> XXXXXXX

RTRV-PROTNSW-<STS_PATH> XXX XXXXXXX

Table 3-2 TL1 Commands by Card (ONS 15454) (continued)

G1000-4

ML1000-2

ML100T-12

EC1

DS1

DS1N

DS3

DS3N

DS3E

DS3NE

DS3XM

OC3

OC3-8

OC12

OC12-4

OC48

OC48AS

OC192

E100T

E1000T

TCC

TCC2

XCVT

XC192

XCVXL

AICI

AIC

MXP

TXP

3-11

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

RTRV-PROTNSW-CLNT XX

RTRV-PROTNSW-VT1 XXXXXXX

RTRV-PTHTRC-<STS_PATH> XXXXXXXXXXXXX XX

RTRV-SYNCN XX

RTRV-TACC XXXXXXXXXXXXXXX

RTRV-T1 XX

RTRV-T3 XXXX

RTRV-TH-<MOD2> XXXXXXXXXXXXXXX XX

RTRV-TOD

RTRV-TRC-<OCN_BLSR> XXXXX

RTRV-TRC-CLNT XX

RTRV-TRC-OCH XX

RTRV-VT1 XXX XXXX XXX

RTRV-<OCN_TYPE> XXXXXXXX

RTRV-<STS_PATH> XXXXXXXXXXXXXXXXXX

RTRV-UCP-CC XXXXXXXX

RTRV-UCP-IF XXXXXXXX

RTRV-UCP-NBR

RTRV-UCP-NODE

RTRV-USER-SECU

SCHED-PMREPT-<MOD2> XXXXXXXXXXXXXXX XX

SET-ATTR-CONT XX

SET-ATTR-ENV XX

SET-PMMODE-<STS_PATH> XXXXXXXXXXXXXXX

SET-TH-<MOD2> XXXXXXXXXXXXXXX XX

SET-TOD

SW-DX-EQPT XXX

SW-TOPROTN-EQPT XXXXXXXX

SW-TOWKG-EQPT XXXXXXXX

Table 3-2 TL1 Commands by Card (ONS 15454) (continued)

G1000-4

ML1000-2

ML100T-12

EC1

DS1

DS1N

DS3

DS3N

DS3E

DS3NE

DS3XM

OC3

OC3-8

OC12

OC12-4

OC48

OC48AS

OC192

E100T

E1000T

TCC

TCC2

XCVT

XC192

XCVXL

AICI

AIC

MXP

TXP

3-12

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

3.3 TL1 Commands by Card (ONS 15327)

Table 3-3 TL1 Commands by Card (ONS 15327)

XTC/DS1

XTC/DS3

OC3

OC12

OC48

E100T

E1000T

XTC

G1000-2

XTC/XCVT

XTC/AIC

ACT-USER

ALW-MSG-ALL

ALW-MSG-DBCHG

ALW-PMREPT-ALL

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

APPLY X

CANC

CANC-USER

CHG-ACCMD-<CHG_ACCMD> XXXXX

CONN-TACC-<MOD_TACC> XXXXX

COPY-IOSCFG

COPY-RFILE X

DISC-TACC XXXXX

DLT-BLSR XX

DLT-CRS-VT1 XXX

DLT-CRS-<STS_PATH> XXXXX

DLT-EQPT X XXXXX X

DLT-FFP-<OCN_TYPE> XXX

DLT-USER-SECU

ED-BITS X

ED-BLSR XX

ED-CRS-<STS_PATH> XXXXX X

ED-CRS-VT1 XXX

ED-DAT

ED-DS1

ED-EC1

ED-EQPT XX

ED-FFP-<OCN_TYPE> XXX

ED-G1000 X

ED-NE-GEN X

3-13

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

ED-NE-SYNCN X

ED-PID

ED-SYNCN X

ED-T1 X

ED-T3 X

ED-USER-SECU

ED-VT1 XXXX

ED-<OCN_TYPE> XXX

ED-<STS_PATH> XXXXX X

ENT-BLSR XX

ENT-CRS-VT1 XXX

ENT-CRS-<STS_PATH> XXXXX X

ENT-EQPT XXXXXXXXXXX

ENT-FFP-<OCN_TYPE> XXX

ENT-USER-SECU

EX-SW-<OCN_BLSR> XX

INH-MSG-ALL

INH-MSG-DBCHG

INH-MSG-SECU X

INH-PMREPT-ALL

INH-SWDX-EQPT X

INH-SWTOPROTN-EQPT XX

INH-SWTOWKG-EQPT XX

INIT-REG-<MOD2> XXXXX

INIT-REG-G1000 X

INIT-SYS XXXXXXXXXXX

OPR-ACO-ALL X

OPR-EXT-CONT X

OPR-LPBK-<MOD2> XXXXX X

OPR-PROTNSW-VT1 XXX

OPR-PROTNSW-<OCN_TYPE> XXX

OPR-PROTNSW-<STS_PATH> XXX

OPR-SYNCNSW XXX X

REPT ALM BITS X

Table 3-3 TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

XTC/DS3

OC3

OC12

OC48

E100T

E1000T

XTC

G1000-2

XTC/XCVT

XTC/AIC

3-14

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

REPT ALM COM

REPT ALM ENV X

REPT ALM EQPT XXXXXXXXXXX

REPT ALM RING XX

REPT ALM SYNCN XXX X

REP ALM <MOD2ALM> XXXXXXXXXX X

REPT DBCHG X

REPT EVT BITS X

REPT EVT COM

REPT EVT ENV X

REPT EVT EQPT XXXXXXXXXX X

REPT EVT FXFR X

REPT EVT RING XX

REPT EVT SECU

REPT EVT SESSION X

REPT EVT SYNCN XXX X

REPT EVT <MOD2ALM> XXXXXXXXXX X

REPT PM <MOD2> XXXXXX

REPT SW X

RLS-EXT-CONT X

RLS-LPBK-<MOD2> XXXXX X

RLS-PROTNSW-VT1 XXX

RLS-PROTNSW-<OCN_TYPE> XXX

RLS-PROTNSW-<STS_PATH> XXX

RLS-SYNCNSW XXX X

RMV-<MOD2_IO> XXXXX X

RST-<MOD2_IO> XXXXX X

RTRV-ALM-ALL XXXXXXXXXX X

RTRV-ALM-BITS X

RTRV-ALM-ENV X

RTRV-ALM-EQPT XXXXXXXXXX X

RTRV-ALM-RING

RTRV-ALM-SYNCN XXX X

RTRV-ALM-<MOD2ALM> XXXXXXXXXX X

Table 3-3 TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

XTC/DS3

OC3

OC12

OC48

E100T

E1000T

XTC

G1000-2

XTC/XCVT

XTC/AIC

3-15

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

RTRV-ATTR-CONT X

RTRV-ATTR-ENV X

RTRV-BITS X

RTRV-BLSR XX

RTRV-COND-ALL XXXXXXXXXXX

RTRV-COND-BITS X

RTRV-COND-ENV X

RTRV-COND-EQPT XXXXXXXXXXX

RTRV-COND-RING

RTRV-COND-SYNCN X

RTRV-COND-<MOD2ALM> XXXXXXXXXXX

RTRV-CRS XXXXX X

RTRV-CRS-VT1 XXXX

RTRV-CRS-<STS_PATH> XXXXX X

RTRV-EC1

RTRV-DS1

RTRV-EQPT XXXXXXXXXX X

RTRV-EXT-CONT X

RTRV-FFP-<OCN_TYPE> XXX

RTRV-G1000 X

RTRV-HDR

RTRV-INV XXXXXXXXXX X

RTRV-LOG

RTRV-MAP-NETWORK

RTRV-NE-GEN X

RTRV-NE-IPMAP XXX

RTRV-NE-SYNCN X

RTRV-PM-<MOD2> XXXXX

RTRV-PMMODE-<STS_PATH> XXXX

RTRV-PMSCHED-ALL XXXXX

RTRV-PMSCHED-<MOD2> XXXXX

RTRV-PROTNSW-VT1 XXX

RTRV-PROTNSW-<OCN_TYPE> XXX

RTRV-PROTNSW-<STS_PATH> XXX

Table 3-3 TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

XTC/DS3

OC3

OC12

OC48

E100T

E1000T

XTC

G1000-2

XTC/XCVT

XTC/AIC

3-16

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

RTRV-PTHTRC-<STS_PATH> XX X X

RTRV-SYNCN X

RTRV-T1 X

RTRV-T3 X

RTRV-TACC XXXXX

RTRV-TH-<MOD2> XXXXX

RTRV-TOD

RTRV-TRC-<OCN_BLSR> XX

RTRV-USER-SECU

RTRV-VT1 XXXX

RTRV-<OCN_TYPE> XXX

RTRV-<STS_PATH> XXXXX X

SCHED-PMREPT-<MOD2>

SET-ATTR-CONT X

SET-ATTR-ENV X

SET-PMMODE-<STS_PATH> XXXXX

SET-TH-<MOD2> XXXXX

SET-TOD

SW-DX-EQPT X

SW-TOPROTN-EQPT XX

SW-TOWKG-EQPT XX

Table 3-3 TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

XTC/DS3

OC3

OC12

OC48

E100T

E1000T

XTC

G1000-2

XTC/XCVT

XTC/AIC

3-17

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4 TL1 Commands

The commands and autonomous messages used for ONS 15454 and ONS 15327 are described in detail

in this section and are listed alphabetically according to the first alpha character of the command string.

Each TL1 command must be less than or equal to 255 characters. Any command larger than 255

characters must be split into multiple commands. For example, if you use the ED-<STS_PATH>

command to edit the J1 EXPTRC/TRC message, UPSR attributes, and TACC attributes and the

command exceeds 255 characters the command will not be processed. You must use multiple

ED-<STS_PATH> commands instead.

Note The CTAG of any TL1 line mode command is a mandatory field in this TL1 release.

Note The AID definitions provided are supersets of the actual AID definitions.

Note TL1 commands that are entered incorrectly are not completed.

Note Starting with release 3.3 (R3.3), all TL1 commands will return the DENY error code without any

additional error messages prior to a successful TL1 login (i.e., prior to a successful ACT-USER

command). Releases earlier than R3.3 either return different error codes; for example, PLNA and IICT

and also additional error messages; for example, Login Not Active.

3.4.1 ACT-USER: Activate User

This command set-ups a session with the Network Element (NE).

Notes:

1. Passwords are masked for the following security commands: ACT-USER, ED-PID,

ENT-USER-SECU and ED-USER-SECU. Access to a TL1 session via any means will have the

password masked. The CTC Request History and Message Log will also show the masked

commands. When a password-masked command is re-issued by double-clicking the command from

CTC Request History, the password will still be masked in the CTC Request History and Message

Log. The actual password that was previously issued will be sent to the NE. To use a former

command as a template only, single-click the command in CTC Request History. The command will

be placed in the Command Request text box, where you can edit the appropriate fields prior to

re-issuing it.

2. In this release, the ACT-USER command does not return the date and time of the last session

established by the UID or the number of unsuccessful session attempts since the last session.

3. This command is backwards compatible with userids and passwords from ONS 15454 2.X software

versions according to the following rules:

ACT-USER:[TID]:[STRING]:CTAG::[STRING]

a. The syntax of the userid (first [STRING]) and the password (second [STRING]) are not

checked.

3-18

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

b. Invalid syntax for both the userid and password is permitted, but the user can only log in if the

userid/password match what is in the database.

c. The userid and password cannot exceed 10 characters.

4. For the ACT-USER command, it is required that no error code be transmitted except to convey that

the login is granted or denied. Per TR-835, Appendix A, Section A.2:

“... the error codes corresponding to ACT ... do not apply to the ACT-USER command because this

command requires that no error code be provided to the session request except to indicate that it has

been denied. Before a session is established, a specific error code may reveal clues to an intruder

attempting unauthorized entry.”

Section ACT-USER Description

Category Security

Security N/A

Messages

CANC

CANC-USER

DLT-USER-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

REPT EVT SECU

RTRV-USER-SECU

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

where:

•<UID> is the user identifier; <UID> is any combination of up to 10

alphanumeric characters. <UID> is a string and must not be null

•<PID> is the user password; <PID> is any combination of up to 10 alphanumeric

characters. <PID> is a string and must not be null

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character

CTC-entered <UID> and <PID> are not valid TL1 <UID> and <PID>

Input Example ACT-USER:PETALUMA:TERRI:100::MYPASSWD;

Errors Errors are listed in Table 7-30 on page 7-20.

3-19

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.2 ALW-MSG-ALL: Allow Message All

This command instructs the NE to enter a mode in which all the REPT ALM and REPT EVT autonomous

messages are transmitted. See the INH-MSG-ALL command to inhibit these autonomous messages.

When a TL1 session starts, the REPT ALM and REPT EVT messages are allowed by default.

Note If this command is issued twice in the same session, the SAAL (Status, Already Allowed) error message

will be returned. The optional fields in the e block are not supported.

3.4.3 ALW-MSG-DBCHG: Allow Database Change Message

This command enables REPT DBCHG. When a TL1 session starts, the REPT DBCHG messages are not

allowed by default.

Note This command is not defined in the GR.

Section ALW-MSG-ALL Description

Category System

Security Retrieve

Messages

APPLY RTRV-HDR

COPY-RFILE RTRV-INV

ED-DAT RTRV-MAP-NETWORK

ED-NE-GEN RTRV-NE-GEN

ED-NE-SYNCN RTRV-NE-IPMAP

INH-MSG-ALL RTRV-NE-SYNCN

INIT-SYS RTRV-TOD

REPT EVT FXFR SET-TOD

Input Format ALW-MSG-ALL:[<TID>]::<CTAG>[::,,];

Input Example ALW-MSG-ALL:PETALUMA::549;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ALW-MSG-DBCHG Description

Category Log

Security Retrieve

Messages

INH-MSG-DBCHG

REPT DBCHG

RTRV-LOG

Input Format ALW-MSG-DBCHG:[<TID>]::<CTAG>[::,,];

Input Example ALW-MSG-DBCHG:CISCO::123;

Errors Errors are listed in Table 7-30 on page 7-20.

3-20

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.4 ALW-MSG-SECU: Allow Message Security

This command enables REPT EVT SECU and REPT ALM SECU

3.4.5 ALW-PMREPT-ALL: Allow Performance Report All

This command resumes processing all the PM reports that are inhibited. The allowance of the PM

reporting is session-based, which means the command is only effective to the TL1 session that issues

this command. REPT PM messages are inhibited by default for a session.

Section ALW-MSG-SECU Description

Category Security

Security Superuser

Messages

ACT-USER ENT-USER-SECU

CANC INH-MSG-SECU

CANC-USER REPT EVT SECU

DLT-USER-SECU REPT EVT SESSION

ED-PID RTRV-USER-SECU

ED-USER-SECU

Input Format ALW-MSG-SECU:[<TID>]::<CTAG>;

Input Example ALW-MSG-SECU:PETALUMA::123;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ALW-PMREPT-ALL Description

Category Performance

Security Retrieve

Messages

INH-PMREPT-ALL RTRV-PMSCHED-ALL

INIT-REG-<MOD2> RTRV-TH-<MOD2>

REPT PM <MOD2> SCHED-PMREPT-<MOD2>

RTRV-PM-<MOD2> SET-PMMODE-<STS_PATH>

RTRV-PMMODE-<STS_PATH> SET-TH-<MOD2>

RTRV-PMSCHED-<MOD2>

Input Format ALW-PMREPT-ALL:[<TID>]::<CTAG>;

Input Example ALW-PMREPT-ALL:CISCONODE::123;

Errors Errors are listed in Table 7-30 on page 7-20.

3-21

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.6 ALW-SWDX-EQPT: Allow Switch Duplex Equipment

(Cisco ONS 15454 only)

This command allows automatic or manual switching on a duplex system containing duplexed or

redundant equipment. To inhibit an NE switching to duplex, use the INH-SWDX-EQPT command.

ALW-SWDX-EQPT is not used for SONET line or electrical card protection switching. For SONET line

or path protection switching commands, see OPR-PROTNSW and RLS-PROTNSW commands. For the

electrical card protection switching, see the SW-TOWKG-EQPT and SW-TOPROTN-EQPT commands.

Note This command applies to the XC, XCVT, or XC10G equipment units only in this release.

3.4.7 ALW-SWTOPROTN-EQPT: Allow Switch to Protection Equipment

(Cisco ONS 15454 only)

This command allows automatic or manual switching of an equipment unit back to a protection status.

Use the INH-SWTOPROTN-EQPT command to inhibit an NE from switching to protection.

ALW-SWTOPROTN-EQPT is used for non-SONET line cards (e.g. DS1, DS3, DS3XM, and EC1). DS1

and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment

protection. When this command is given to a working unit, the working unit will be allowed to switch to

the protection unit. When this command is given to a protection unit, any working unit in the protection

group is allowed to switch to the protection unit.

The standing condition of INHSWPR on the unit specified by the AID will be cleared.

Section ALW-SWDX-EQPT Description

Category Equipment

Security Maintenance

Messages

ALW-SWTOPROTN-EQPT REPT ALM EQPT

ALW-SWTOWKG-EQPT REPT EVT EQPT

DLT-EQPT RTRV-ALM-EQPT

ED-EQPT RTRV-COND-EQPT

ENT-EQPT RTRV-EQPT

INH-SWDX-EQPT SW-DX-EQPT

INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT

INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format ALW-SWDX-EQPT:[<TID>]:<AID>:<CTAG>[::];

where:

•<AID> is the XC/XCVT/XC10G equipment AID from the “EQPT” section on

page 4-21

Input Example ALW-SWDX-EQPT:CISCO:SLOT-8:1234;

Errors Errors are listed in Table 7-30 on page 7-20.

3-22

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

Notes:

1. This command only supports one value of the <DIRN> parameter - BTH. A command with any other

value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error

message should be responsed.

2. This command is not used for the common control (TCC+/TCC2 or XC/XCVT/XC10G) cards. A

command on a common control card will receive an IIAC (Input, Invalid Access Identifier) error

message. To use the common control card switching commands, use the SW-DX-EQPT and

ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will receive an

IIAC (Input, Invalid Access identifier) error message. To use a SONET card switching command,

use OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid

State) error message should be responsed.

5. If this command is used on a card that is not in the inhibit state, the SAAL (Status, Already Allowed)

error message should be responsed.

6. The following situation(s) are allowed and will not generate any error response: Sending this

command to missing cards so long as none of the previous error conditions apply.

Section ALW-SWTOPROTN-EQPT Description

Category Equipment

Security Maintenance

Messages

ALW-SWDX-EQPT REPT ALM EQPT

ALW-SWTOWKG-EQPT REPT EVT EQPT

DLT-EQPT RTRV-ALM-EQPT

ED-EQPT RTRV-COND-EQPT

ENT-EQPT RTRV-EQPT

INH-SWDX-EQPT SW-DX-EQPT

INH-SWTOPROTN-EQPT SW-TORPROTN-EQPT

INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format ALW-SWTOPROTN-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

where:

•<AID> This parameter can either be the protection unit for which carrying traffic

is to be allowed (release of lockout) or the working unit for which switching to

protect is to be allowed (release of lock on); <AID> is from the “EQPT” section

on page 4-21

•<DIRN> is the direction of the switching. The command only supports one value

of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values

for <DIRN> are shown in the “DIRECTION” section on page 4-60

Input Example ALW-SWTOPROTN-EQPT:CISCO:SLOT-2:123::BTH;

Errors Errors are listed in Table 7-30 on page 7-20.

3-23

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.8 ALW-SWTOWKG-EQPT: Allow Switch to Working Equipment

(Cisco ONS 15454 only)

This command allows automatic or manual switching of an equipment unit back to a working status. Use

the INH-SWTOWKG-EQPT command to inhibit an NE from switching to working.

ALW-SWTOWKG-EQPT is used for non-SONET line cards (e.g. DS1, DS3, DS3XM, and EC1). DS1

and DS3 cards have 1:1 and 1:N equipment protection. DS3XM and EC1 cards have only 1:1 equipment

protection.

When this command is given to a working unit, the working unit will be allowed to carry traffic. In the

case of revertive protection, the traffic will switch immediately from the protection unit to the working

unit regardless of the reversion time setting.

When this command is given to a protection unit, the protection unit will be allowed to switch back to

the working unit currently protected as long as the working unit has not raised INHSWWKG. In the case

of revertive protection, the traffic will switch immediately from the protection unit to the working unit

regardless of the reversion time setting. In the case of non-revertive protection, the protection unit will

continue to carry the traffic.

The standing condition of INHSWWKG on the unit specified by the AID will be cleared.

Notes:

1. This command only supports one value of the <DIRN> parameter - BTH. A command with any other

value is considered an incorrect use of the command. An IDNV (Input, Data Not Valid) error

message should be responsed.

2. This command is not used for the common control (TCC+/TCC2 or XC/XCVT/XC10G) cards. A

command on a common control card will receive an IIAC (Input, Invalid Access Identifier) error

message. To use the common control card switching commands, use the SW-DX-EQPT and

ALW-SWDX-EQPT commands.

3. This command is not used for SONET (OCN) cards. A command on a SONET card will receive an

IIAC (Input, Invalid Access Identifier) error message. To use a SONET card switching command,

use the OPR-PROTNSW and RLS-PROTNSW commands.

4. If this command is used on a card that is not in a protection group, the SNVS (Status, Not in Valid

State) error message should be responsed.

5. If this command is used on a card that is not in the inhibit state, the SAAL (Status, Already Allowed)

error message should be responsed.

6. The following situation(s) are allowed and will not generate any error response: sending this

command to missing cards as long as none of the previous error conditions apply.

Section ALW-SWTOWKG-EQPT Description

Category Equipment

Security Maintenance

Messages

ALW-SWDX-EQPT REPT ALM EQPT

ALW-SWTOPROTN-EQPT REPT EVT EQPT

DLT-EQPT RTRV-ALM-EQPT

ED-EQPT RTRV-COND-EQPT

ENT-EQPT RTRV-EQPT

INH-SWDX-EQPT SW-DX-EQPT

INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT

INH-SWTOWKG-EQPT SW-TOWKG-EQPT

3-24

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.9 APPLY: Apply

This command activates or reverts a software load during a software upgrade or downgrade process.

Input Format ALW-SWTOWKG-EQPT:[<TID>]:<AID>:<CTAG>[::<DIRN>];

where:

•<AID> This parameter can either be the protection unit for which switching back

to working is to be allowed (release of lock on) or the working unit for which

carrying traffic is to be allowed (release of lockout); <AID> is from the “EQPT”

section on page 4-21

•<DIRN> is the direction of the switching. The command only supports one value

of the <DIRN> parameter - BTH. This parameter defaults to BTH; valid values

for <DIRN> are shown in the “DIRECTION” section on page 4-60

Input Example ALW-SWTOWKG-EQPT:CISCO:SLOT-2:123::BTH;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ALW-SWTOWKG-EQPT Description (continued)

Section APPLY Description

Category Software Download

Security Maintenance

Messages

ALW-MSG-ALL RTRV-HDR

COPY-RFILE RTRV-INV

ED-DAT RTRV-MAP-NETWORK

ED-NE-GEN RTRV-NE-GEN

ED-NE-SYNCN RTRV-NE-IPMAP

INH-MSG-ALL RTRV-NE-SYNCN

INIT-SYS RTRV-TOD

REPT EVT FXFR SET-TOD

Input Format APPLY:[<TID>]::<CTAG>[::<MEM_SW_TYPE>];

where:

•<MEM_SW_TYPE> indicates memory switch action during the software

upgrade; valid values for <MEM_SW_TYPE> are shown in the “DL_TYPE”

section on page 4-61

Input Example APPLY:CISCO::123::ACT;

Errors Errors are listed in Table 7-30 on page 7-20.

3-25

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.10 CANC: Cancel

Reports the occurrence of a session timeout event.

CANC is an autonomous message transmitted by the NE to a user when a session established by that user

is terminated because no messages were exchanged for a long period of time, a timeout. There is a

default timeout period based on the user’s privilege/security level, and starting with Release 4.0 timeouts

can be provisioned. The default timeouts based on privilege/security level are: superuser [SUPER] has

the timeout period of 15 minutes., the Provision user [PROV] has the timeout period of 30 minutes, the

Maintenance [MAINT] user has the timeout period of 60 minutes, the Retrieve user [RTRV] has no

timeout.

When a timeout occurs, the corresponding port drops and the next session initiation at that port requires

the regular login procedure.

3.4.11 CANC-USER: Cancel User

This command logs a user out of an active session with the NE.

Note The USERID field of this command is a mandatory field.

For the CANC-USER command: CANC-USER:[TID]:[STRING]:CTAG

the syntax of the userid (fist [STRING]) is not checked. Invalid syntax for the userid is permitted and

the userid must not exceed 10 characters.

Section CANC Description

Category Security

Security Retrieve

Messages

ACT-USER

CANC-USER

DLT-USER-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

REPT EVT SECU

RTRV-USER-SECU

Output Format SID DATE TIME

A ATAG CANC

“<UID>”

;

where:

•<UID> refers to the user’s identification whose session is terminated due to

timeout; <UID> is any combination of up to 10 alphanumeric characters. <UID>

is a string

Output

Example

TID-000 1998-06-20 14:30:00

A 100.100 CANC

“CISCO15”

;

3-26

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.12 CHG-ACCMD-<MOD_TACC>: Change Test Access Mode (DS1, STS1,

STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command changes the test access (TACC) mode for the circuit being tested. For more information

on TACC, refer to the “Test Access” section on page 1-17.

This may be a change from monitoring the data to inserting data into the STS. This command can only

be applied to an existing TAP connection.

For this command to be applicable, you must first create the TAP using the ED-<STS_PATH> or

ED-VT1 commands

Notes:

1. If there is no TAP connection, a DENY error message is returned.

2. If a requested condition already exists, a SRCN error message is returned.

3. If a requested access configuration is invalid, a SRAC error message is returned

4. If a requested TAP does not exist, a RTEN error message is returned.

Section CANC-USER Description

Category Security

Security Retrieve

Messages

ACT-USER

CANC

DLT-USER-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

REPT EVT SECU

RTRV-USER-SECU

Input Format CANC-USER:[<TID>]:<USERID>:<CTAG>;

where:

•<USERID> identifies the user to the system; <USERID> is any combination of

up to 10 alphanumeric characters. <USERID> is a string

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character

CTC-entered <UID> and <PID> are not valid TL1 <UID> and <PID>

Input Example CANC-USER:PETALUMA:TERRI:101;

Errors Errors are listed in Table 7-30 on page 7-20.

Section CHG-ACCMD-<MOD_TACC> Description

Category Test Access

Security Maintenance

Messages

CONN-TACC-<MODE_TACC>

DISC_TACC

RTRV-TACC

3-27

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.13 CONN-TACC-<MOD_TACC>: Connect Test Access (DS1, STS1, STS3C,

STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command connects the STS or VT defined by AID to the STS specified by the TAP number. For

more information on TACC, refer to the “Test Access” section on page 1-17.

The connection will exist only for the duration of the TL1 session, after which the TAP will be

disconnected from the circuit before the session cancels out. For this command to be applicable, you

must first create the TAP using the ED-<STS_PATH> or ED-VT1 commands.

Notes:

1. If all TAPs are busy, a RABY error message is returned.

2. If a requested TAP is busy, a RTBY error message is returned.

3. If a requested TAP does not exist, a RTEN error message is returned.

4. If a circuit is already connected to another TAP, a SCAT error message is returned.

5. If a requested condition already exists, a SRCN error message is returned.

6. If the AID is invalid, an IIAC (Input, Invalid Access Identifier) error message is returned.

7. If an access is not supported, an EANS error message is returned.

8. If a requested access configuration is invalid, a SRAC error message is returned.

Input Format CHG-ACCMD-<MOD_TACC>:[<TID>]:<TAP>:<CTAG>::<MD>;

where:

•<TAP> indicates the test access path number selected by the NE. The <TAP> is

used to identify all messages between the TSC and NE until the access point is

released. The <TAP> number must be an integer with a range of 1 to 999. <TAP>

is a string

Note This command only changes a single TAP at a time.

•<MD> indicates the test access mode (SPLTE, SPLTF, LOOPE, AND LOOPF

require an external QRS input signal); valid values for <MD> are shown in the

“TACC_MODE” section on page 4-92

Input Example CHG-ACCMD-STS1:CISCO:8:123::MONE;

Errors Errors are listed in Table 7-30 on page 7-20.

Section CHG-ACCMD-<MOD_TACC> Description (continued)

Section CONN-TACC-<MOD_TACC> Description

Category Test Access

Security Provisioning

Messages

CHG-ACCMD-<CHG-ACCMD>

DISC-TACC

RTRV-TACC

3-28

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.14 COPY-IOSCFG: Copy IOS Config File

(Cisco ONS 15454 only)

This command supports the following types of operations on the IOS configuration file of ML-series

Ethernet cards:

1. Uploading of startup IOS configuration file from the network to the node.

FTP is the only protocol allowed for uploading. When doing this operation, the SRC field must be

a FTP URL string specifying the user name and password for FTP authentication, and specifying

the host and the directory to locate the startup config file from the network. The DEST field must

be a string of “STARTUP”.

Input Format CONN-TACC-<MOD_TACC>:[<TID>]:<AID>:<CTAG>::<TAP>:MD=<MD>;

where:

•<AID> is an access identifier. <AID> format is the modifier AID format in the

ALL AID list. Only a single AID is supported in this command. <AID> is the

AID from the “ALL” section on page 4-10. <AID> must not be null

•<TAP> indicates the test access path number selected by the NE. The <TAP> is

used to identify all messages between the TSC and the NE until the access point

is released. The <TAP> number must be an integer with a range of 1 to 999. A

null <TAP> defaults to an appropriate <TAP> number selected by the NE.

<TAP> is an integer and a null value is equivalent to ALL

•<MD> indicates the test access mode (SPLTE, SPLTF, LOOPE and LOOPF

require an external QRS input signal); valid values for <MD> are shown in the

“TACC_MODE” section on page 4-92. <MD> must not be null

Input Example CONN-TACC-STS1:CISCO:STS-2-4:123::8:MD=MONE;

Output Format SID DATE TIME

M CTAG COMPLD

“<TAP>”

;

where:

•<TAP> indicates the test access path number selected by the NE. The <TAP> is

used to identify all messages between the TSC and NE until the access point is

released. The <TAP> number must be an integer with a range of 1 - 999. A null

<TAP> defaults to an appropriate <TAP> number selected by the NE. <TAP> is

an integer

Output

Example

TID-000 1998-06-20 14:30:00

M 001 COMPLD

“8”

;

Errors Errors are listed in Table 7-30 on page 7-20.

Section CONN-TACC-<MOD_TACC> Description (continued)

3-29

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

2. Downloading of startup IOS configuration file from the node to the network.

FTP is the only protocol allowed for downloading. When doing this operation, the SRC field must

be a string of “STARTUP”. The DEST field must be a FTP URL string specifying the user name and

password for FTP authentication, and specifying the host and the directory to store the startup config

file.

Notes:

1. The IOS configuration file is unique for each ML-series card, and is specified by the SLOT number

in the AID field of the command.

2. In the GNE/ENE environment, if the GNE firewall exists, the download (backup) of IOS

configuration file via TL1 is not allowed. Any such attempt will receive a “Data Connection Error”

from the GNE. For the upload of IOS configuration file via TL1, GNE will allow it to go through

the firewall only if the file contains the header “! Cisco IOS config <text>”. If the configuration file

does not contain this header, GNE will block the uploading with “Data Connection Error”.

3. The format of the FTP URL string used in the SRC or DEST field of the command is as follows:

In a non-firewall environment, the format of the URL should be

“FTP://[FTPUSER[:FTPPASSWORD]]@FTP_HOST_IP/PACKAGE_PATH” where:

<FTPUSER> is the userid to connect to the computer with the package file

<FTPPASSWORD> is the password used to connect to the computer with the package file

<FTP_HOST_IP> is the IP address of the computer with the package file, DNS lookup of hostnames

is not supported

<PACKAGE_PATH> is the long path name to the package file

Note Note that USERID and PASSWORD are optional if the user does not need to log into the host

computer. Also note that the password may be optional if the user does not need to log in. All

the other portions of the URL are required, including the initial “FTP:\\” string.

In a firewall environment, the hostname should be replaced with a list of IP addresses each separated

by a @ character. The first IP address should be for the machine where the package file is stored.

Subsequent IP addresses should then be for firewall machines moving outwards towards the edge of

the network, until the final IP address listed was the machine that outside users first access the

network.

For example: if your topology is “FTP_HOST_IP <-> GNE3 <->GNE2 <-> GNE1 <-> ENE”, your

FTP URL will be:

FTP://FTPUSER:FTPPASSWORD@FTP_HOST_IP@GNE3@GNE2@GNE1/PACKAGE_PATH

Section COPY-IOSCFG Description

Category IOS

Security Provisioning

Messages

REPT EVT IOSCFG

3-30

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.15 COPY-RFILE: Copy RFILE

This command downloads a new software package from the location specified by the FTP URL. It is also

used to backup and restore the system database.

Notes:

1. Userid is the userid to connect to the computer with the package file or system database.

2. Password is the password used to connect to the computer with the package file or system database.

3. Hostname is the hostname or IP address of the computer with the package file or system database.

4. Package_path is the long path name to the package file or system database.

5. Both the userid and password are optional if the user does not need to log into the host computer.

6. The password may be optional if the user does not need to log in.

7. All the other portions of the URL are required, including the initial “FTP://” string.

Example:

COPY-RFILE:TID:RFILE-PKG:703::TYPE=SWDL,SRC=“FTP://USERID:

PASSWORD@HOSTIP:21/DIR1/DIR2/DIR3/PACKAGE.PKG”;

Notes:

1. The SWDL type is used for software package uploads. The RFBU type is used for system database

backups, and the RFR type is used for system database restores. The SRC input is required when the

type is SWDL or RFR. The DEST input is needed when the type is RFBU. The SRC and DEST

inputs cannot both be used in the same command.

2. FTP is the only allowed file transfer method.

3. The extended FTP URL syntax is required by the COPY-RFILE syntax.

4. Port number (21) is optional. 21 is the only supported Port Number. Leaving this field blank defaults

to 21.

Input Format COPY-IOSCFG:[<TID>]:<AID>:<CTAG>::SRC=<SRC>,DEST=<DEST>;

where:

•<AID> specifies the slot number of the card where the IOS configuration file

belongs and is from the AID “EQPT” section on page 4-21

•<SRC> specifies where the IOS config file is copied from and is a string

•<DEST> specifies where the IOS config file is copied to and is a string

Input Example COPY-IOSCFG::SLOT-1:CTAG::SRC=“LONG_FTP_PATH”,DEST=“STARTUP”;

Errors Errors are listed in Table 7-30 on page 7-20.

Section COPY-IOSCFG Description (continued)

Section COPY-RFILE Description

Category Software Download

Security Superuser

Messages

APPLY

REPT EVT FXFR

3-31

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

Input Format COPY-RFILE:[<TID>]:[<SRC>]:<CTAG>::TYPE=<XFERTYPE>,

[SRC=<SRC1>,][DEST=<DEST>];

where:

•<SRC> is the type of file being transferred; <SRC> is the AID from the

“RFILE” section on page 4-24

•<XFERTYPE> is the file transfer protocol; valid values for <XFERTYPE> are

shown in the “TX_TYPE” section on page 4-95

•<SRC1> specifies the source of the file to be transferred. Only the FTP URL is

supported. In a non-firewall environment the format of the URL should be:

“FTP://[FTP_USER[:FTP_PASSWORD]]@

FTP_HOST_IP/PACKAGE_PATH”

where:

–

<FTP_USER> is the userid to connect to the computer with the package file

–

<FTP_PASSWORD> is the password used to connect to the computer with

the package file

–

<FTP_HOST_IP> is the IP address of the computer with the package file,

DNS lookup of hostnames is not supported

–

<PACKAGE_PATH> is the long path name to the package file

Note Userid and password are optional if the user does not need to log into the host

computer. The password may be optional if the user does not need to log in.

All the other portions of the URL are required, including the initial “FTP://”

string.

In a firewall environment, the hostname should be replaced with a list of IP

addresses each separated by a @ character. The first IP address should be for the

machine where the package file is stored. Subsequent IP addresses should then

be for firewall machines moving outwards towards the edge of the network, until

the final IP address listed is the machine that outside users first access the

network.

For example, if the topology is “FTP_HOST_IP <-> GNE3 <->GNE2 <->

GNE1 <-> ENE”, the FTP URL is:

FTP://FTP_USER:FTP_PASSWORD@FTP_HOST_IP@GNE3@GNE2@

GNE1/PACKAGE_PATH

<SRC1> is a string.

•<DEST> see <SRC1> above

Input Example COPY-RFILE:HERNDON:RFILE-PKG:703::TYPE=SWDL,

SRC=“LONG_FTP_PATH”,DEST=“LONG_FTP_PATH”;

Errors Errors are listed in Table 7-30 on page 7-20.

Section COPY-RFILE Description (continued)

3-32

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.16 DISC-TACC: Disconnect Test Access

This command disconnects the TAP and puts the connection back to its original state (no splits). For

more information on TACC, refer to the “Test Access” section on page 1-17.

For this command to be applicable, you must first create the TAP using the ED-<STS_PATH> or

ED-VT1 commands.

Notes:

1. If you send this command to an already disconnected connection, a SADC error message is returned.

2. If the system cannot release TAP, an SRTN error message is returned.

3. Automatic disconnection of the STS/VT path from a TAP happens when the session that created the

connection gets timed out or is terminated.

3.4.17 DLT-BLSR: Delete BLSR

This command deletes the BLSR of the NE.

Error conditions:

1. If the system fails on getting IOR, a SDBE (Status, Internal Data Base Error) error message is

returned.

2. If the NE returns nothing for the required BLSR (BLSR-# AID), a SRQN (Status, Invalid Request)

error message is returned.

Section DISC-TACC Description

Category Test Access

Security Provisioning

Messages

CHG-ACCMD-<MOD_TACC>

CONN-TACC-<MOD_TACC>

RTRV-TACC

Input Format DISC-TACC:[<TID>]:<TAP>:<CTAG>;

where:

•<TAP> indicates the test access path number selected by the NE. The <TAP> is

used to identify all messages between the TSC and the NE until the access point

is released. The <TAP> number must be an integer with a range of 1- 999. This

command only supports changing a single <TAP> number at a time. <TAP> is a

string

Note This command only disconnects a single TAP at a time.

Input Example DISC-TACC:CISCO:8:123;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-BLSR Description

Category BLSR

Security Provisioning

3-33

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.18 DLT-CRS-<STS_PATH>: Delete Cross Connection (STS1, STS3C, STS6C,

STS9C, STS12C, STS24C, STS48C, STS192C)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command deletes a cross-connection between STS paths. STS paths are specified using their STS

AID.

Notes:

1. The fields after CTAG (trailing colons) are optional.

2. For the 1-way cross-connections the AIDs must be in the same order as originally entered; for the

2-way cross-connections, either order will work.

3. This command does not support deleting multiple STS cross-connections.

4. Using “&” in the AID field of this command can delete an UPSR STS cross-connection.

a. The following command is used to delete a 1-way selector or 2-way selector and bridge with:

from points: F1, F2

to points: T1

DLT-CRS-{STS_PATH}:[<TID>]:F1&F2,T1:<CTAG>;

b. The following command is used to delete a 1-way bridge or 2-way selector and bridge with:

from point: F1

to points: T1, T2

DLT-CRS-{STS_PATH}:[<TID>]:F1,T1&T2:<CTAG>;

c. The following command is used to delete a 1-way or 2-way subtending UPSR connection with:

from point: F1, F2

to points: T1, T2

DLT-CRS-{STS_PATH}:[<TID>]:F1&F2,T1&T2:<CTAG>;

d. The AID format in the deletion command is the same as the AID format in the retrieved response

message. For example, if the output of any retrieved AID is “F1&F2,T1:CCT,STS3C”, the

deletion command with the AID format (F1&F2,T1) is required to delete this cross-connection.

Messages

ED-BLSR RTRV-ALM-RING

ENT-BLSR RTRV-BLSR

REPT ALM RING RTRV-COND-RING

REPT EVT RING

Input Format DLT-BLSR:[<TID>]:<AID>:<CTAG>[:::];

where:

•<AID> identifies the BLSR of the NE. “ALL” or “BLSR-ALL” AID is not

allowed for editing BLSR. This command only supports a single BLSR AID.

<AID> is the AID from the “BLSR” section on page 4-18

Input Example DLT-BLSR:PETALUMA:BLSR-2:123;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-BLSR Description (continued)

3-34

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

e. The following command is used to create a UPSR IDRI Cross-Connection:

ENT-CRS-{STS_PATH}:[<TID>]:A&B,C&D:<CTAG>::2WAYDC;

A–Path on ring X to which traffic from ring Y is bridged

B–Path on ring X to which traffic from the same ring is bridged

C–Path on ring Y to which traffic from ring X is bridged

D–Path on ring Y to which traffic from the same ring is bridged

A, B, C, and D have a positional meaning. Connection type 2WAYDC is used for UPSR IDRI

cross-connections.

f. The following command is used to create a UPSR DRI Cross-Connection:

ENT-CRS-{STS_PATH}:[<TID>]:A&B,C:<CTAG>::2WAYDC;

A–Path on ring X to which traffic from ring Y is bridged

B–Path on ring X to which traffic from the same ring is bridged

C–Traffic to and from ring Y

A, B, C, and D have a positional meaning. Connection type 2WAYDC is used for UPSR DRI

cross-connections.

5. All A&B AIDs in the TL1 cross-connection command are in the format of

WorkingAID&ProtectAID.

6. You can experience some implementation behavior problems if additional drops have been added to

the connection object.

7. The facility AID is only valid for slots holding the G1000-4 card.

8. The virtual facility AID (VFAC) is only valid on slots holding an ML-series card.

9. A TL1 cross-connect that has been upgraded to a CTC circuit can no longer be managed by TL1.

For example, if you issue a DLT-CRS-<STS_PATH> command to delete a circuit, you will see that

the circuit still appears in CTC as “incomplete”. The reason for this is because in addition to creating

cross-connects (as TL1 does), CTC creates another object on the source node that stores

network-level circuit attributes. CTC will continue to see that object after the cross-connect is

deleted which is why it shows an incomplete circuit.

Section DLT-CRS-<STS_PATH> Description

Category Cross Connections

Security Provisioning

Messages

DLT-CRS-VT1

ED-CRS-<STS_PATH>

ED-CRS-VT1

ENT-CRS-<STS_PATH>

ENT-CRS-VT1

RTRV-CRS

RTRV-CRS-<STS_PATH>

RTRV-CRS-VT1

Input Format DLT-CRS-<STS_PATH>:[<TID>]:<SRC>,<DST>:<CTAG>[:::];

where:

•<SRC> is the AID from the “CrossConnectID” section on page 4-14

•<DST> is the AID from the “CrossConnectID” section on page 4-14

3-35

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.19 DLT-CRS-VT1: Delete Virtual Tributary Cross Connect

This command deletes the VT1 cross-connections.

Notes:

1. The fields after CTAG (trailing colons) are the optional.

2. For the 1-way cross-connections the AIDs must be in the same order as originally entered; for the

2-way either order will work.

3. This command does not support deleting multiple VT cross-connections.

4. Using “&” in the AID field of this command can delete an UPSR VT cross-connection.

a. The following command is used to delete a 1-way selector or 2-way selector and bridge with:

from points: F1, F2

to points: T1

DLT-CRS-VT1:[<TID>]:F1&F2,T1:<CTAG>;

b. The following command is used to delete a 1-way bridge or 2-way selector and bridge with:

from point: F1

to points: T1, T2

DLT-CRS-VT1:[<TID>]:F1,T1&T2:<CTAG>;

c. The following command is used to delete a 1-way subtending UPSR connection or 2-way

subtending UPSR connection with:

from points: F1, F2

to points: T1, T2

DLT-CRS-VT1:[<TID>]:F1&F2,T1&T2:<CTAG>;

d. The AID format in the deletion command is the same as the AID format in the retrieved response

message. For example, if the output of any retrieved AID is “F1&F2,T1:CCT”, the deletion

command with the AID format (F1&F2,T1) is required to delete this cross-connection.

5. All A&B AIDs in the TL1 cross-connection command are in the format of

WorkingAID&ProtectAID.

6. You can experience some implementation behavior problems if additional drops have been added to

the connection object.

Input Example DLT-CRS-STS12C:VINBURG:STS-1-1-1,STS-12-1-1:102;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-CRS-<STS_PATH> Description (continued)

Section DLT-CRS-VT1 Description

Category Cross Connections

Security Provisioning

3-36

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.20 DLT-EQPT: Delete Equipment

This command deletes a card from the NE.

This command removes the card type and attributes that were entered for a particular slot. If any facilities

are assigned, they are deleted too. The command will be denied if the card is part of a protection group

or has a cross-connect end-point.

To delete a card that is part of a protection group, it has to be removed from the protection group first

using the ED-EQPT command.

Error conditions for deleting equipment may be:

1. If the equipment is in use which corresponds to some provisioning having been done on the

equipment, the SPLD (Equipment in use) error message will be returned:

a. If it is belongs to a protection group that has a cross-connection.

b. If one of its ports has been provisioned as a DCC channel.

c. If one of its ports is being used for a synchronization source.

d. If the equipment has a Test Access Point (TAP).

e. If one of its ports is being used as a UCP Control Channel or Interface.

f. If one of its ports is provisioned for a BLSR.

g. If one of its ports is a part of a 1+1 protection group.

2. If a card is not provisioned, an error message will be returned.

Messages

DLT-CRS-<STS_PATH>

ED-CRS-<STS_PATH>

ED-CRS-VT1

ENT-CRS-<STS_PATH>

ENT-CRS-VT1

RTRV-CRS

RTRV-CRS-<STS_PATH>

RTRV-CRS-VT1

Input Format DLT-CRS-VT1:[<TID>]:<FROM>,<TO>:<CTAG>[:::];

where:

•<FROM> indicates an identifier at one end of the VT cross-connection;

<FROM> is the AID from the “VT1_5” section on page 4-30

•<TO> indicates an identifier at the other end of the VT cross-connection; <TO>

is the AID from the “VT1_5” section on page 4-30

Input Example DLT-CRS-VT1:CISCO:VT1-2-3-7-2,VT1-4-4-5-2:1234;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-CRS-VT1 Description (continued)

Section DLT-EQPT Description

Category Equipment

Security Provisioning

3-37

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.21 DLT-FFP-<OCN_TYPE>: Delete Facility Protection Group (OC3, OC12,

OC48, OC192)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command deletes an OCN facility protection group in a 1+1 architecture.

Note If the protection group does not exist, an error message will be returned.

Messages

ALW-SWDX-EQPT REPT ALM EQPT

ALW-SWTOPROTN-EQPT REPT EVT EQPT

ALW-SWTOWKG-EQPT RTRV-ALM-EQPT

ED-EQPT RTRV-COND-EQPT

ENT-EQPT RTRV-EQPT

INH-SWDX-EQPT SW-DX-EQPT

INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT

INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format DLT-EQPT:[<TID>]:<AID>:<CTAG>[:::];

where:

•<AID> is the equipment unit (slot) to act on and is the AID from the “EQPT”

section on page 4-21

Input Example DLT-EQPT:SONOMA:SLOT-1:104;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-EQPT Description (continued)

Section DLT-FFP-<OCN_TYPE> Description

Category SONET Line Protection

Security Provisioning

Messages

ED-FFP-<OCN_TYPE>

ENT-FFP-<OCN_TYPE>

EX-SW-<OCN_BLSR>

OPR-PROTNSW-<OCN_TYPE>

RLS-PROTNSW-<OCN_TYPE>

RTRV-FFP-<OCN_TYPE>

RTRV-PROTNSW-<OCN_TYPE>

Input Format DLT-FFP-<OCN_TYPE>:[<TID>]:<WORK>,<PROTECT>:<CTAG>[:::];

where:

•<WORK> identifies the working facility and is the AID from the “FACILITY”

section on page 4-22

•<PROTECT> identifies the protect facility and is the AID “FACILITY” section

on page 4-22

Input Example DLT-FFP-OC3:PETALUMA:FAC-2-1,FAC-1-1:1;

Errors Errors are listed in Table 7-30 on page 7-20.

3-38

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.22 DLT-FFP-CLNT: Delete Facility Protection Group Client

This command deletes Y cable protection on client facilities.

Section DLT-FFP-CLNT Description

Category DWDM

Security Provisioning

Messages

DLT-FFP-<OCN_TYPE> RLS-PROTNSW-<OCN_TYPE>

ED-CLNT RLS-PROTNSW-CLNT

ED-DWDM RTRV-CLNT

ED-FFP-<OCN_TYPE> RTRV-DWDM

ED-FFP-CLNT RTRV-FFP-<OCN_TYPE>

ED-OCH RTRV-FFP-CLNT

ED-TRC-CLNT RTRV-OCH

ED-TRC-OCH RTRV-PROTNSW-<OCN_TYPE>

ENT-FFP-<OCN_TYPE> RTRV-PROTNSW-CLNT

ENT-FFP-CLNT RTRV-TRC-CLNT

OPR-PROTNSW-<OCN_TYPE> RTRV-TRC-OCH

OPR-PROTNSW-CLNT

Input Format DLT-FFP-CLNT:[<TID>]:<WORKAID>,<PROTAID>:<CTAG>[:::];

where:

•<WORKAID> identifies the working facility and is the AID from the

“FACILITY” section on page 4-22

•<PROTECTAID> identifies the protect facility and is the AID “FACILITY”

section on page 4-22

Input Example DLT-FFP-CLNT:CISCO:FAC-1-1,FAC-2-1:100;

Errors Errors are listed in Table 7-30 on page 7-20.

3-39

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.23 DLT-UCP-CC: Delete Unified Control Plane Control Channel

(Cisco ONS 15454 only)

This command deletes a UCP IP control channel.

1. If you send this command to a control channel that is in use, a SRQN (Status, Invalid Request) error

message is returned.

2. If sending this command to delete an SDCC IPCC with a complete result, the SDCC of the specified

SONET line is deleted (or disabled) automatically with a DB change reporting (if the DB change

report is enabled).

3. If sending this command to delete an IPCC which is in use by a UCP Interface, an SROF (Delete

UCP IPCC Failed - Object Is In Use) error message is returned.

Section DLT-UCP-CC Description

Category UCP

Security Provisioning

Messages

DLT-UCP-IF ENT-UCP-NBR

DLT-UCP-NBR REPT ALM UCP

ED-UCP-CC REPT EVT UCP

ED-UCP-IF RTRV-ALM-UCP

ED-UCP-NBR RTRV-COND-UCP

ED-UCP-NODE RTRV-UCP-CC

ENT-UCP-CC RTRV-UCP-IF

ENT-UCP-IF RTRV-UCP-NBR

Input Format DLT-UCP-CC:[<TID>]:<AID>:<CTAG>[::::];

where:

•<AID> indicates an individual IPCC ID; <AID> is the AID from the “IPCC”

section on page 4-16

Input Example DLT-UCP-CC:CISCO:CC-9:CTAG;

Errors Errors are listed in Table 7-30 on page 7-20.

3-40

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.24 DLT-UCP-IF: Delete Unified Control Plane Interface

This command deletes a UCP interface.

Note If the UCP interface is not found or in use, a SRQN (Status, Invalid Request) error message is returned.

3.4.25 DLT-UCP-NBR: Delete Unified Control Plane Neighbor

This command deletes a UCP neighbor.

Notes:

1. If the neighbor is in use, an SRQN (Status, Invalid Request) error message is returned.

2. If sending this command to delete a neighbor which is in use by IPCC, an SROF (Delete UCP

neighbor Failed - Object Is In Use) error message is returned.

Section DLT-UCP-IF Description

Category UCP

Security Provisioning

Messages

DLT-UCP-CC ENT-UCP-NBR

DLT-UCP-NBR REPT ALM UCP

ED-UCP-CC REPT EVT UCP

ED-UCP-IF RTRV-ALM-UCP

ED-UCP-NBR RTRV-COND-UCP

ED-UCP-NODE RTRV-UCP-CC

ENT-UCP-CC RTRV-UCP-IF

ENT-UCP-IF RTRV-UCP-NBR

Input Format DLT-UCP-IF:[<TID>]:<AID>:<CTAG>[::::];

where:

•<AID> indicates the interface port index of the data link; <AID> is the AID

from the “FACILITY” section on page 4-22

Input Example DLT-UCP-IF:CISCO:FAC-2-1:CTAG;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-UCP-NBR Description

Category UCP

Security Provisioning

Messages

DLT-UCP-CC ENT-UCP-NBR

DLT-UCP-IF REPT ALM UCP

ED-UCP-CC REPT EVT UCP

ED-UCP-IF RTRV-ALM-UCP

ED-UCP-NBR RTRV-COND-UCP

ED-UCP-NODE RTRV-UCP-CC

ENT-UCP-CC RTRV-UCP-IF

ENT-UCP-IF RTRV-UCP-NBR

3-41

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.26 DLT-USER-SECU: Delete User Security

This command deletes a user and can only be performed by a Superuser. Privilege levels are described

in the ENT-USER-SECU command.

This command cannot be used to delete a user that is currently logged on.

For the DLT-USER-SECU command:

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

the syntax of <UID> is not checked. The user is deleted if the <UID> exists in the database.

Notes:

1. A userid cannot be deleted when that user is logged in. If you try to delete a userid and the user is

logged in, an error message indicating that the user is logged in will be received.

Input Format DLT-UCP-NBR:[<TID>]:<AID>:<CTAG>[::::];

where:

•<AID> indicates an individual neighbor AID of the UCP; <AID> is the AID

from the “NBR” section on page 4-16

Input Example DLT-UCP-NBR:CISCO:NBR-8:CTAG;

Errors Errors are listed in Table 7-30 on page 7-20.

Section DLT-UCP-NBR Description (continued)

Section DLT-USER-SECU Description

Category Security

Security Superuser

Messages

ACT-USER

CANC

CANC-USER

ED-PID

ED-USER-SECU

ENT-USER-SECU

REPT EVT SECU

RTRV-USER-SECU

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

where:

•<UID> is the user identifier and is a string; <UID> is any combination of up to

10 alphanumeric characters

Note CTC allows <UID> and <PID> of up to 20 characters. The 20 character

CTC-entered <UID> and <PID> are not valid TL1 <UID> and <PID>.

Input Example DLT-USER-SECU:PETALUMA:CISCO15:123;

Errors Errors are listed in Table 7-30 on page 7-20.

3-42

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.27 ED-<OCN_TYPE>: Edit (OC3, OC12, OC48, OC192)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command edits the attributes (i.e., service parameters) and state of an OC-N facility. Allowable

states for a facility are Out Of Service (OOS), Out Of Service with Automatic In Service transitioning

(OOS-AINS), Out Of Service for Maintenance (OOS-MT), and In Service (IS).

The DCC transmit is bridged to both working and protect in a 1+1 configuration. On the receive side,

the active one is selected for DCC. The DCC is provisioned on the working port only in a 1+1

configuration.

All lines in a 1+1 BLSR must have the same mode. If you change the mode of a line that is in a 1+1

BLSR, an error message will be returned.

UNI-C DCC provisioning notes:

1. The attributes DCC(Y/N) and mode (SONET/SDH) remain the same in the ED/RTRV-OCN

commands when the DCC is used for UNI-C, in which case the port attribute UNIC is enables

(UNIC=Y).

2. If the DCC is created under regular SONET provisioning, and this port is used by UNI-C, the port

is converted as a UNI-C DCC automatically.

3. De-provisioning UNI-C IF/IB IPCC will free up DCC termination automatically.

4. The state of the T1 port cannot be changed to IS or OOS if a loopback has been operated upon the

line.

Section ED-<OCN_TYPE> Description

Category Ports

Security Provisioning

Messages

ED-DS1

ED-EC1

ED-G1000

ED-T1

ED-T3

RMV-<MOD2_IO>

RST-<MOD2_IO>

RTRV-<OCN_TYPE>

RTRV-DS1

RTRV-EC1

RTRV-G1000

RTRV-T1

RTRV-T3

3-43

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.28 ED-<STS_PATH>: Edit (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,

STS48C, STS192C)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command edits the attributes associated with an STS path.

The SFBER, SDBER, RVRTV, and RVTM parameters only apply to UPSR.

Input Format ED-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>:::[DCC=<DCC>,]

[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][PJMON=<PJMON>,]

[SFBER=<SFBER>,][SDBER=<SDBER>,][MODE=<MODE>,][MUX=<MUX>,]

[SOAK=<SOAK>]:[<PST>],[<SST>];

where:

•<AID> is the access identifier from the “FACILITY” section on page 4-22

•<DCC> identifies an OCN port DCC connection; valid values for <DCC> are

shown in the “SDCC_MODE” section on page 4-86

•<SYNCMSG> indicates if sync status messaging is enabled or disabled on the

facility; valid values for <SYNCMSG> are shown in the “ON_OFF” section on

page 4-79

•<SENDDUS> indicates that the facility will send out the DUS (do not use for

synchronization) value as the sync status message for that facility; valid values

are shown in the “ON_OFF” section on page 4-79

•<PJMON> identifies an OC-N port PJMON with a value range of [0, highest STS

number for the sonet card]; <PJMON> is an integer

•<SFBER> identifies an OC-N port SFBER; valid values for <SFBER> are shown

in the “SF_BER” section on page 4-86

•<SDBER> identifies an OC-N port SDBER; valid values for <SDBER> are

shown in the “SD_BER” section on page 4-85

•Valid values for <MODE> are shown in the “OPTICAL_MODE” section on

page 4-80

•<MUX> BLSR Extension Byte (supported only on OC48AS cards); valid values

for <MUX> are shown in the “MUX_TYPE” section on page 4-78

•<SOAK> OOS-AINS to IS transition soak time as measured in 15 minute

intervals, so a value of 4 translates to a soak time of 1 hour. The allowable range

is 0–192 intervals (maximum of 48 hours). <SOAK> is an integer.

•<PST> is the primary state; valid values for <PST> are shown in the “PST”

section on page 4-85

•<SST> is the secondary state; valid values for <SST> are shown in the “SST”

section on page 4-87

Input Example ED-OC48:PENNGROVE:FAC-6-1:114:::DCC=Y,SYNCMSG=Y,SENDDUS=N,

PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SONET,MUX=E2,

SOAK=10:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-<OCN_TYPE> Description (continued)

3-44

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

The path trace message is a 64 character string including the terminating CR (carriage return) and LF

(line feed) that is transported in the J1 byte of the SONET STS Path overhead. Both the EXPTRC and

TRC string can be provisioned by user with up to 62 character string.

The EXPTRC indicates the contents of the expected incoming path trace are provisioned by the user. The

TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of

the incoming path trace message.

The path trace mode has three modes: OFF, MANUAL, and AUTO. The path trace mode defaults to OFF.

The MANUAL mode performs the comparison of the received string with the user-entered expected

string. The AUTO mode performs the comparison of the present received string with an expected string

set to a previously received string. If there is a mismatch, TIM-P alarm is raised. When the path trace

mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.

The TACC parameter edits an existing single STS or VT and changes it to a test access point. When an

editing command on TACC is executed, it assigns the STS for the first 2-way connection and STS=1 as

the second 2-way connection. For STS3C and STS12C, the next available STS of the same width is

chosen. For more information on TACC, refer to the “Test Access” section on page 1-17.

J1 is implemented on the DS1/DS1N, DS3E/DS3NE, DS3XM, EC1, OC3, OC48AS and OC192 cards.

DS3/DS3N, OC12, OC48, E100, and E1000 cards do not support path trace.

DS1/DS1N, DS3E/DS3NE, and DS3XM support both TRC and EXPTRC in the ED-STS-PATH

command.

EC1, OC3, OC48AS, and OC192 only support EXPTRC in the ED-STS-PATH command.

Note Each TL1 command must be less than or equal to 255 characters. Any command larger than 255

characters must be split into multiple commands. For example, if you use the ED-<STS_PATH>

command to edit the J1 EXPTRC/TRC message, UPSR attributes, and TACC attributes and the

command exceeds 255 characters the command will not be processed. You must use multiple

ED-<STS_PATH> commands instead.

Note An STS TAP created in a DS3XM card cannot be used to connect to an STS with a non-VT structured

payload, for example, DS3. If created, traffic cannot be monitored.

Note An STS TAP created in a DS3 card cannot be used to connect to an STS with a non-DS3 payload, for

example, VT structured. If created, traffic cannot be monitored.

Error conditions:

1. If sending this command to edit SFBER or SDBER or RVRTV or RVTM for the non UPSR STS

path, an error message will be returned.

2. If sending this command to edit the EXPTRC string with the AUTO path trace mode

(TRCMODE=AUTO), an error message will be returned.

3. If sending this command to edit TRC on any card other than DS3(N)E, DS1(N), and DS3XM cards,

an error message (TRC-not allowed for monitor paths. Incorrect card type.) will be returned.

4. This command is allowed to edit EXPTRC on DS1(N), DS3(N)E, DS3XM, EC1, OC3, OC48AS,

and OC192 cards.

5. If sending this command to edit both TACC and any other attribute(s), the (Parameters Not

compatible) error message will be returned.

3-45

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

6. If sending this command to edit TACC on an AID with cross-connections, an error message (STS in

Use) will be returned.

7. TACC creation will also be denied on the protect ports/cards for 1:1, 1:N, and 1+1.

8. The VFAC AID is only valid on slots containing an ML1000-2 or ML100T-12 card. TACC is not

supported for the ML1000-2 or ML100T-12 cards.

9. After the BLSR switching, provisioning of the J1 trace string or trace mode is not allowed on the

protection path.

10. TACC creation is allowed on PCA for two-fiber and four-fiber BLSR.

11. TACC is not supported on G1000/MXP/TXP/ML1000-2 and ML100T-12 cards.

Section ED-<STS_PATH> Description

Category STS and VT Paths

Security Provisioning

Messages

RTRV-<STS_PATH>

RTRV-PTHTRC-<STS_PATH>

3-46

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.29 ED-BITS: Edit Building Integrated Timing Supply

This command edits the BITS reference attributes.

Input Format ED-<STS_PATH>:[<TID>]:<SRC>:<CTAG>:::[SFBER=<SFBER>,]

[SDBER=<SDBER>,][RVRTV=<RVRTV>,][RVTM=<RVTM>,]

[SWPDIP=<SWPDIP>,][HOLDOFFTIMER=<HOLDOFFTIMER>,]

[EXPTRC=<EXPTRC>,][TRC=<TRC>,][TRCMODE=<TRCMODE>,]

[TACC=<TACC>]:[<PST>],[<SST>];

where:

•<SRC> is the access identifier from the “CrossConnectID” section on page 4-14

•<SFBER> identifies an STS path SFBER which only applies to UPSR; valid

values for <SFBER> are shown in the “SF_BER” section on page 4-86

•<SDBER> identifies an STS path SDBER which only applies to UPSR; valid

values for <SDBER> are shown in the “SD_BER” section on page 4-85

•<RVRTV> identifies a revertive mode which only applies to UPSR; valid values

for <RVRTV> are shown in the “ON_OFF” section on page 4-79

•<RVTM> identifies a revertive time which only applies to UPSR; valid values for

<RVTM> are shown in the “REVERTIVE_TIME” section on page 4-85.

<RVTM> is not allowed to be set while <RVRTV> is N.

•<SWPDIP> On-Off switch for UPSR Payload Defect Level switching. Valid

values for <SWPDIP> are shown in the “ON_OFF” section on page 4-79

•<HOLDOFFTIMER> Hold-off timer for UPSR DRI; <HOLDOFFTIMER> is an

integer

•<EXPTRC> indicates the expected path trace message (J1) contents. The

EXPTRC is any 64 character string, including the terminating CR (carriage

return) and LF (line feed); <EXPTRC> is a string

•<TRC> identifies the path trace message to be transmitted. The TRC is any

combination of 64 characters, including the terminating CR and LF. The trace

byte (J1) continuously transmits a 64 byte string, one byte at a time. A null value

defaults to the NE transmitting null characters (Hex 00); <TRC> is a string

•<TRCMODE> indicates the path trace mode, and defaults to the OFF mode;

valid values for <TRCMODE> are shown in the “TRCMODE” section on

page 4-94

•<TACC> is the AID “TACC” section on page 4-29

•<PST> is the primary state; valid values for <PST> are shown in the “PST”

section on page 4-85

•<SST> is the secondary state; valid values for <SST> are shown in the “SST”

section on page 4-87

Input Example ED-STS1:FERNDALE:STS-2-1-4:115:::SFBER=1E-3,SDBER=1E-5,RVRTV=Y,

RVTM=1.0,SWPDIP=Y,HOLDOFFTIMER=2000,EXPTRC=“EXPTRCSTRING”,

TRC=“TRCSTRING”,TRCMODE=OFF,TACC=8:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-<STS_PATH> Description (continued)

3-47

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

Section ED-BITS Description

Category Synchronization

Security Provisioning

Messages

ED-NE-SYNCN RTRV-ALM-BITS

ED-SYNCN RTRV-ALM-SYNCN

OPR-SYNCNSW RTRV-BITS

REPT ALM BITS RTRV-COND-BITS

REPT ALM SYNCN RTRV-COND-SYNCN

REPT EVT BITS RTRV-NE-SYNCN

REPT EVT SYNCN RTRV-SYNCN

RLS-SYNCNSW

Input Format ED-BITS:[<TID>]:<AID>:<CTAG>:::[LINECDE=<LINECDE>,][FMT=<FMT>,]

[LBO=<LBO>,][SYNCMSG=<SYNCMSG>,][AISTHRSHLD=<AISTHRSHLD>]

[:<PST>];

where:

•<AID> is an access identifier from the “BITS” section on page 4-18

•<LINECDE> is a line code; valid values for <LINECDE> are shown in the

“LINE_CODE” section on page 4-70

•<FMT> is the frame format; valid values for <FMT> are shown in the

“FRAME_FORMAT” section on page 4-69

•<LBO> indicates BITS line build out. The default value is 0-133. Valid values

for <LBO> are shown in the “BITS_LineBuildOut” section on page 4-42

•<SYNCMSG> indicates if this BITS facility supports synchronization status

message; <SYNCMSG> defaults to (Y) and valid values are shown in the

“ON_OFF” section on page 4-79

•<AISTHRSHLD> is the AIS Threshold. Valid values for <AISTHRSHLD>

shown in the “SYNC_CLOCK_REF_QUALITY_LEVEL” section on page 4-89

•<PST> is a state; valid values for <PST> are shown in the “PST” section on

page 4-85

Input Example ED-BITS:SONOMA:BITS-2:779:::LINECDE=AMI,FMT=ESF,LBO=0-133,

SYNCMSG=Y,AISTHRSHLD=PRS:IS;

Errors Errors are listed in Table 7-30 on page 7-20.

3-48

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.30 ED-BLSR: Edit Bidirectional Line Switched Ring

This command edits the BLSR attributes.

Notes:

1. Only the RVRTV, RVTM, SRVRTV, SRVTM attributes can be edited for the 4-Fiber BLSR.

2. Only the RVRTV and RVTM attributes can be edited for the 2-Fiber BLSR.

Error conditions:

1. If the system fails on getting IOR, a SDBE (Status, Internal Data Base Error) error message will be

returned.

2. If the NE returns nothing for the required BLSR (BLSR-#, AID), a SRQN (Status, Invalid Request)

error message will be returned.

3. If sending this command to modify any attribute other than RVRTV, RVTM, SRVRTV, and SRVTM

on the 4-Fiber BLSR, an IDNV (Input, Data Not Valid) error message will be returned.

4. If sending this command to modify any attribute other than RVRTV or RVTM on the 2-fiber BLSR,

an IDNV (Input, Data Not Valid) error message will be returned.

5. Both RINGID and NODEID can be edited using the ED-BLSR command starting with Release 3.2.

Section ED-BLSR Description

Category BLSR

Security Provisioning

Messages

DLT-BLSR

ENT-BLSR

REPT ALM RING

REPT EVT RING

RTRV-ALM-RING

RTRV-BLSR

RTRV-COND-RING

3-49

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.31 ED-CLNT: Edit Client

This command edits client facility attributes.

See the “Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards” section on page 1-8 for

specific MXP/TXP card provisioning rules.

Input Format ED-BLSR:[<TID>]:<AID>:<CTAG>:::[RINGID=<RINGID>,]

[NODEID=<NODEID>,][RVRTV=<RVRTV>,][RVTM=<RVTM>,]

[SRVRTV=<SRVRTV>,][SRVTM=<SRVTM>][:];

where:

•<AID> identifies the BLSR of the NE and is from the “BLSR” section on

page 4-18 (the AID “ALL” or “BLSR ALL” is not allowed for editing BLSR).

This command only supports a single BLSR AID

•<RINGID> identifies the BLSR ring ID of the NE. It ranges from 0–9999.

<RINGID> is an integer

•<NODEID> identifies the BLSR node ID of the NE. It ranges from 0–31.

<NODEID> is an integer

•<RVRTV> identifies the revertive mode and valid values are shown in the

“ON_OFF” section on page 4-79

•<RVTM> identifies the revertive time; valid values for <RVTM> are shown in

the “REVERTIVE_TIME” section on page 4-85

•<SRVRTV> identifies the span revertive mode for 4F BLSR only and valid

values are shown in the “ON_OFF” section on page 4-79

•<SRVTM> identifies the span revertive time for 4F BLSR only; valid values for

<SRVTM> are shown in the “REVERTIVE_TIME” section on page 4-85

Input Example ED-BLSR:PETALUMA:BLSR-43:123:::RINGID=43,NODEID=3,RVRTV=Y,

RVTM=2.0,SRVRTV=Y,SRVTM=5.0;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-BLSR Description (continued)

Section ED-CLNT Description

Category DWDM

Security Provisioning

Messages

RTRV-CLNT

RTRV-ALM-CLNT

RTRV-COND-CLNT

RST-CLNT

RMV-CLNT

ED-DWDM

RTRV-DWDM

3-50

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

Input Format ED-CLNT:[<TID>]:<AID>:<CTAG>:::[SFBER=<SFBER>,][SDBER=<SDBER>,]

[ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,]

[ALSRCPW=<ALSRCPW>,][COMM=<COMM>,][MACADDR=<MACADDR>,]

[SYNCMSG=<SYNCMSG>,][SENDDUS=<SENDDUS>,][RLASER=<RLASER>]

[SOAK=<SOAK>]:[<PST>],[<SST>];

where:

•<AID> is from the “FACILITY” section on page 4-22

•<SFBER> identifies the SFBER for the SONET payload; valid values are shown

in the “SF_BER” section on page 4-86

•<SDBER> identifies the SDBER for the SONET payload; valid values are shown

in the “SD_BER” section on page 4-85

•<ALSMODE> indicates if the Automatic Laser Shutdown is enabled or disabled;

valid values are shown in the “ALS_MODE” section on page 4-41

•<ALSRCINT> indicates the ALS recovery interval. Range is 100–300 seconds;

<ALSRCINT> is an integer

•<ALSRCPW> indicates the ALS recovery pulse width. The range is 2–100

seconds, in increments of 100ms, e.g. 30.1; <ALSRCPW> is a float

•<COMM> indicates if the GCC or DCC is enabled or disabled. The GCC can be

enabled only if the digital wrapper has been enabled for the card. The default is

NONE. Valid values are shown in the “COMM_TYPE” section on page 4-46.

Rules for a MXP/TXP Client port are; only the DCC can be provisioned, if the

termination mode is not transparent and the payload is SONET. On a MXP/TXP

DWDM port, the DCC can be enabled only if the G.709 is not enabled and if the

payload is SONET and the termination mode is not transparent. On a MXP/TXP

DWDM port, the GCC can be enabled if there is no DCC and the G.709 flag is

enabled.

•<MACADDR> identifies the MAC address for the 10GEthernet payload;

<MACADDR> is a string

•<SYNCMSG> indicates that the facility be enabled to provide the

synchronization clock. This does not apply to a TXP card. This applies to an

MXP card, only if the payload is SONET and the card termination mode is as

follows: TRANSPARENT - All Client ports are available for all timing

selections. All Trunk ports are not available. Valid values are shown in the

“ON_OFF” section on page 4-79

LINE - All ports are available for all-timing selections.

•<SENDDUS> indicates that the facility send out a Do not Use for Sync message.

This does not apply to a TXP card. This applies to an MXP card, only if the

payload is SONET and the card termination mode is as follows:

TRANSPARENT - All Client ports are available for all timing selections. All

Trunk ports are not available.

LINE - All ports are available for all-timing selections. Valid values are shown

in the “ON_OFF” section on page 4-79

Section ED-CLNT Description (continued)

3-51

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.32 ED-CRS-<STS_PATH>:ED CRS (STS1, STS3C, STS6C, STS9C, STS12C,

STS24C, STS 48C, STS192C)

This command edits the state of an STS cross-connection.

Input Format

(continued)

•<RLASER> indicates if the laser should be restarted. This is applicable only if

the ALSMODE is not automatic; valid values are shown in the “ON_OFF”

section on page 4-79

•<SOAK> OOS-AINS to IS transition soak time as measured in 15–minute

intervals. A value of 4 translates to a soak time of one hour. The allowable range

is 0–192 intervals (maximum of 48–hours). <SOAK> is an integer

•<PST> primary state; valid values are shown in the “PST” section on page 4-85

•<SST> secondary state; valid values are shown in the “SST” section on page 4-87

Input Example ED-CLNT:CISCO:FAC-1-1:100:::SFBER=1E-4,SDBER=1E-5,ALSMODE=Y,

ALSRCINT=30,ALSRCPW=35.1,COMM=DCC,

MACADDR=00-0E-AA-BB-CC-FF,SYNCMSG=Y,SENDDUS=Y,RLASER=Y,

SOAK=10:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-CLNT Description (continued)

Section ED-CRS-<STS_PATH> Description

Category Cross Connections

Security Provisioning

Messages

DLT-CRS-<STS_PATH> ENT-CRS-VT1

DLT-CRS-VT1 RTRV-CRS

ED-CRS-VT1 RTRV-CRS-<STS_PATH>

ENT-CRS-<STS_PATH> RTRV-CRS-VT1

Input Format ED-CRS-<STS_PATH>:[<TID>]:<SRC>,<DST>:<CTAG>:::[ADD=<ADD>,]

[REMOVE=<REMOVE>]:[<PST>],[<SST>];

where:

•<SRC> is the AID from the “CrossConnectID” section on page 4-14

•<DST> is the AID from the “CrossConnectID” section on page 4-14

•<ADD> is the AID from the “CrossConnectID” section on page 4-14

•<REMOVE> is the AID from the “CrossConnectID” section on page 4-14

•<PST> primary state; valid values for <PST> are shown in the “PST” section on

page 4-85

•<SST> secondary state; valid values for <SST> are shown in the “SST” section

on page 4-87

Input Example ED-CRS-STS1::STS-1-1-1,STS-2-1-1:1:::ADD=STS-13-1-1,

REMOVE=STS-2-1-1:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

3-52

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.33 ED-CRS-VT1: Edit Cross Connection VT1

This command edits a VT cross-connection.

Note It is not possible to use both ADD and REMOVE at the same time.

Section ED-CRS-VT1 Description

Category Cross Connections

Security Provisioning

Messages

DLT-CRS-<STS_PATH> ENT-CRS-VT1

DLT-CRS-VT1 RTRV-CRS

ED-CRS-<STS_PATH> RTRV-CRS-<STS_PATH>

ENT-CRS-<STS_PATH> RTRV-CRS-VT1

Input Format ED-CRS-VT1:[<TID>]:<SRC>,<DST>:<CTAG>::::[ADD=<ADD>,]

[REMOVE=<REMOVE>]:[<PST>],[<SST>];

where:

•<SRC> is the AID from the “VT1_5” section on page 4-30

•<DST> is the AID from the “VT1_5” section on page 4-30

•<ADD> is the AID from the “VT1_5” section on page 4-30

•<REMOVE> is the AID from the “VT1_5” section on page 4-30

•<PST> primary state; valid values for <PST> are shown in the “PST” section on

page 4-85

•<SST> secondary state; valid values for <SST> are shown in the “SST” section

on page 4-87

Input Example ED-CRS-VT1::VT1-1-1-1-1-1,VT1-2-1-1-1-1:1:::ADD=VT1-3-1-1-1-1,

REMOVE=VT1-2-1-1-1-1:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

3-53

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.34 ED-DAT: Edit Date and Time

This command edits the date and the time

3.4.35 ED-DS1: Edit DS1

(Cisco ONS 15454 only)

This command edits the test access attribute for DS1 access on a DS3XM card.

Note This command is not allowed if the card is a protecting card.

Section ED-DAT Description

Category System

Security Provisioning

Messages

ALM-MSG-ALL RTRV-HDR

APPLY RTRV-INV

COPY-RFILE RTRV-MAP-NETWORK

ED-NE-GEN RTRV-NE-GEN

ED-NE-SYNCN RTRV-NE-IPMAP

INH-MSG-ALL RTRV-NE-SYNCN

INIT-SYS RTRV-TOD

REPT EVT FXFR SET-TOD

Input Format ED-DAT:[<TID>]::<CTAG>::[<DATE>],[<TIME>];

where:

•<DATE> identifies the date and is a string

•<TIME> identifies the time and is a string

Input Example ED-DAT:CISCO::1234::99-12-21,14-35-15;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-DS1 Description

Category Ports

Security Provisioning

Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>

ED-EC1 RTRV-DS1

ED-G1000 RTRV-EC1

ED-T1 RTRV-G1000

ED-T3 RTRV-T1

RMV-<MOD2_IO> RTRV-T3

RST-<MOD2_IO>

3-54

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.36 ED-DWDM: Edit Dense Wavelength Division Multiplexing

The command edits an already pre-provisioned/provisioned MXP/TXP card. It changes the operating

parameters for the card.

The rules for provisioning a regeneration group are: a regeneration group can be created only between a

pair of TXP cards. The peer slot should contain a card of the same type, and should not have an existing

regeneration group for the same slot. The termination mode should be identical for the cards. All the

client port level settings should be identical for the cards. Setting the PEERID=Null will remove an

existing regeneration group. The two TXP cards should be set to transparent termination mode to

successfully create a regeneration group.

The rules for provisioning the payload field are as follows: For a TXP card, the SONET/10GE (Ethernet)

applies. The port has to be in OOS state for a payload change to be successful. There should be no Trace

enabled for the port. To set the Payload to 10GE, the termination mode should already be in Transparent

mode. Issue a separate ED-DWDM command to set it to Transparent mode prior to setting the payload

to 10GE. The MXP card does not support 10GE payload. To change the payload type for the MXP card,

all the ports should be in OOS state. The payload cannot be changed if any of the ports are a part of a Y

cable protection group or are used as the timing source. There should be no DCC enabled on any ports.

See the “Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards” section on page 1-8 for

specific MXP/TXP card provisioning rules.

Input Format ED-DS1:[<TID>]:<AID>:<CTAG>[:::TACC=<TACC>];

where:

•<AID> is the access identifier of a DS1 access on the DS3XM card and is from

the “DS1” section on page 4-20

•<TACC> defines the STS as a test access port with a selected unique TAP

number. The TAP number ranges from 0–999. When TACC is 0, the TAP is

deleted. <TACC> is an integer

Input Example ED-DS1:PETALUMA:DS1-2-6-12:123:::TACC=8;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-DS1 Description (continued)

Section ED-DWDM Description

Category DWDM

Security Provisioning

Messages

RTRV-DWDM

3-55

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.37 ED-EC1: Edit Electrical Carrier

(Cisco ONS 15454 only)

This command edits the attributes of an EC1.

Notes:

1. This command is not allowed if the card is a protecting card.

2. The state of the T1 port cannot be changed to IS or OOS if a loopback has been operated upon the

line.

Input Format ED-DWDM:[<TID>]:<AID>:<CTAG>:::[PEERID=<PEERID>,]

[TERMMODE=<TERMMODE>,][PAYLOAD=<PAYLOAD>,][PWL=<PWL>];

where:

•<AID> is from the “EQPT” section on page 4-21

•<PEERID> is from the “EQPT” section on page 4-21

•<TERMMODE> indicates the termination mode of the card; valid values are

shown in the “TERM_MODE” section on page 4-93

•<PAYLOAD> is the type of payload carried; valid values are shown in the

“PAYLOAD” section on page 4-83

•<PWL> is the provisioned wavelength; valid values are shown in the

“OPTICAL_WLEN” section on page 4-81

Input Example ED-DWDM:VA454-22:SLOT-1:100:::PEERID=SLOT-2,TERMMODE=TRANS,

PAYLOAD=SONET,PWL=1546.52;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-DWDM Description (continued)

Section ED-EC1 Description

Category Ports

Security Provisioning

Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>

ED-DS1 RTRV-DS1

ED-G1000 RTRV-EC1

ED-T1 RTRV-G1000

ED-T3 RTRV-T1

RMV-<MOD2_IO> RTRV-T3

RST-<MOD2_IO>

3-56

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.38 ED-EQPT: Edit Equipment

This command edits the attributes for a given equipment slot in the NE. If the card is in an equipment

slot, this command is allowed only on the working AID.

The PROTID parameter indicates the unique identifier of the protection group (the protect card).

“NULL” is a special value of the PROTID parameter and indicates absence of a protection group. For

1:1 protection type, RVRTV and RVTM parameters can be changed. For 1:1 protection type, if the

PROTID parameter is entered as “NULL”, the protection group is deleted.

ED-EQPT:[<TID>]:SLOT-2:<CTAG>:::PROTID=NULL;

For 1:N protection type, if the PROTID is “NULL”, the AIDs in the list are removed from the protection

group. If all the working cards are in the AID list, the protection group is deleted.

Example: if Slot-1, Slot-2 and Slot-4 were the only working cards in the protection group. The following

command will remove Slot-4 from the protection group:

ED-EQPT:[<TID>]:SLOT-4:<CTAG>:::PROTID=NULL;

The protection group still has Slot-1 and Slot-2 as working cards.

The following command will remove all the other working cards in the above example and consequently,

delete the protection group itself:

ED-EQPT:[<TID>]:SLOT-2&SLOT-1:<CTAG>:::PROTID=NULL;

The ED-EQPT command can be successfully executed on an already provisioned card to add a working

card to or remove one from a protection group. This command is not valid on a protect card. Only cards

can be added to or removed from a protection group. Protection type is immutable and is determined at

the time of creation of a protection group (while adding the first working card). Once provisioned, the

equipment type cannot be edited either.

Examples of adding an existing card to a protection group using the ED-EQPT command:

1:1 protection group

Input Format ED-EC1:[<TID>]:<AID>:<CTAG>:::[PJMON=<PJMON>,][LBO=<LBO>,]

[SOAK=<SOAK>]:[<PST>],[<SST>];

where:

•<AID> is a facility AID of an EC1 port and is from the “FACILITY” section on

page 4-22

•<PJMON> is a SONET pointer number (0 or 1) of an EC1 port and is an integer

•Valid values for <LBO> are shown in the “E_LBO” section on page 4-62

•<SOAK> OOS-AINS to IS transition soak time as measured in 15 minute

intervals, so a value of 4 translates to a soak time of 1 hour. The allowable range

is 0–192 intervals (maximum of 48 hours). <SOAK> is an integer

•<PST> primary state; valid values for <PST> are shown in the “PST” section on

page 4-85

•<SST> secondary state; valid values for <SST> are shown in the “SST” section

on page 4-87

Input Example ED-EC1:CISCO:FAC-1-1:123:::PJMON=0,LBO=0-225,SOAK=10:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-EC1 Description (continued)

3-57

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

ED-EQPT::SLOT-2:12:::PROTID=SLOT-1,RVRTV=Y,RVTM=9.0;

1:N protection group

ED-EQPT::SLOT-2:12:::PROTID=SLOT-3,PRTYPE=1-N,RVTM=6.5;

Error conditions for editing a 1:1 or 1:N protection group may be:

1. Editing the PRTYPE or PROTID (non-NULL value) parameters.

2. Editing RVRTV or RVTM when no protection group exists.

3. Editing RVRTV for 1:N protection.

4. Failed to remove, currently switched to protect.

Section ED-EQPT Description

Category Equipment

Security Provisioning

Messages

ALW-SWDX-EQPT REPT ALM EQPT

ALW-SWTOPROTN-EQPT REPT EVT EQPT

ALW-SWTOWKG-EQPT RTRV-ALM-EQPT

DLT-EQPT RTRV-COND-EQPT

ENT-EQPT RTRV-EQPT

INH-SWDX-EQPT SW-DX-EQPT

INH-SWTOPROTN-EQPT SW-TOPROTN-EQPT

INH-SWTOWKG-EQPT SW-TOWKG-EQPT

Input Format ED-EQPT:[<TID>]:<AID>:<CTAG>:::[PROTID=<PROTID>,]

[PRTYPE=<PRTYPE>,][RVRTV=<RVRTV>,][RVTM=<RVTM>][:];

where:

•<AID> is an access identifier from the “EQPT” section on page 4-21

•<PROTID> is the protecting card slot number of the protection group.

<PROTID> is the AID from the “UCP” section on page 4-17

•<PRTYPE> is the protection group type; valid values for <PRTYPE> are shown

in the “PROTECTION_GROUP” section on page 4-84

•<RVRTV> is the revertive mode: valid values for <RVRTV> are shown in the

“ON_OFF” section on page 4-79

•<RVTM> is the revertive time; valid values for <RVTM> are shown in the

“REVERTIVE_TIME” section on page 4-85

Input Example ED-EQPT:CISCO:SLOT-2:123:::PROTID=SLOT-1,PRTYPE=1-1,RVRTV=Y,

RVTM=9.0;

Errors Errors are listed in Table 7-30 on page 7-20.

3-58

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.39 ED-FFP-<OCN_TYPE>: Edit Facility Protection Group (OC3, OC12, OC48,

OC192)

See Table 4-11 on page 4-6 for supported modifiers by platform.

This command edits the optical facility protection.

Notes:

1. This command can be used on both protecting and working AIDs.

Section ED-FFP-<OCN_TYPE> Description

Category SONET Line Protection

Security Provisioning

Messages

DLT-FFP-<OCN_TYPE>

ENT-FFP-<OCN_TYPE>

EX-SW-<OCN_BLSR>

OPR-PROTNSW-<OCN_TYPE>

RLS-PROTNSW-<OCN_TYPE>

RTRV-FFP-<OCN_TYPE>

RTRV-PROTNSW-<OCN_TYPE>

Input Format ED-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>:::[PROTID=<PROTID>,]

[RVRTV=<RVRTV>,][RVTM=<RVTM>,][PSDIRN=<PSDIRN>][:];

where:

•<AID> is the facility AID from the “FACILITY” section on page 4-22

•<PROTID> is the protection group identifier (protection group name) and is a

string; <PROTID> can have a maximum of 32 characters

•<RVRTV> identifies a revertive mode; valid values for <RVRTV> are shown in

the “ON_OFF” section on page 4-79

•<RVTM> identifies a revertive time; valid values for <RVTM> are shown in the

“REVERTIVE_TIME” section on page 4-85

•<PSDIRN> identifies the switching mode; valid values for <PSDIRN> are shown

in the “UNI_BI” section on page 4-97

Input Example ED-FFP-OC3:PETALUMA:FAC-1-1:1:::PROTID=PROT_NAME,RVRTV=Y,

RVTM=1.0,PSDIRN=BI;

Errors Errors are listed in Table 7-30 on page 7-20.

3-59

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.40 ED-FFP-CLNT: Edit Facility Protection Group Client

This command edits a Y cable protection group on client facilities.

See the “Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards” section on page 1-8 for

specific MXP/TXP card provisioning rules.

Section ED-FFP-CLNT Description

Category DWDM

Security Provisioning

Messages

RTRV-FFP-CLNT

OPR-PROTNSW-CLNT

RTRV-CLNT

RTRV-ALM-CLNT

RTRV-COND-CLNT

DLT-FFP-CLNT

ENT-FFP-CLNT

Input Format ED-FFP-CLNT:[<TID>]:<AID>:<CTAG>:::[PROTID=<PROTID>,]

[RVRTV=<RVRTV>,][RVTM=<RVTM>,][PSDIRN=<PSDIRN>][:];

where:

•<AID> identifies a port in a protection group and is the AID from the

“FACILITY” section on page 4-22

•<PROTID> is a protection group identifier (protection group name). It defaults

to the protecting port AID of the protection group. It is a string and can have a

maximum length of 32 characters. <PROTID> is a string

•<RVRTV> identifies a revertive mode. The retrieve behavior defaults to N

(non-revertive mode); valid values are shown in the “ON_OFF” section on

page 4-79

•<RVTM> identifies a revertive time. The revertive time defaults to 5.0 minutes;

valid values are shown in the “REVERTIVE_TIME” section on page 4-85

•<PSDIRN> identifies the switching mode and defaults to UNI. Release 4.0

MXP/TXP cards do not support BI-DIRECTIONAL switching. Valid values for

<PSDIRN> are shown in the “UNI_BI” section on page 4-97

Input Example ED-FFP-CLNT:CISCO:FAC-1-1:100:::PROTID=DC-METRO,RVRTV=N,

RVTM=1.0,PSDIRN=BI;

Errors Errors are listed in Table 7-30 on page 7-20.

3-60

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.41 ED-G1000: Edit G1000

(Cisco ONS 15454 only)

This command edits the attributes related to a G1000 port.

Note The state OOS-AINS is not supported on the G1000.

Section ED-G1000 Description

Category Ports

Security Provisioning

Messages

ED-<OCN_TYPE> RTRV-<OCN_TYPE>

ED-DS1 RTRV-DS1

ED-EC1 RTRV-EC1

ED-T1 RTRV-G1000

ED-T3 RTRV-T1

RMV-<MOD2_IO> RTRV-T3

RST-<MOD2_IO>

Input Format ED-G1000:[<TID>]:<AID>:<CTAG>:::[MFS=<MFS>,][FLOW=<FLOW>,]

[OPTICS=<OPTICS>,][ALS=<ALS>,][TRANS=<TRANS>]:[<PST>],[<SST>];

where:

•<AID> is the AID facility from the “FACILITY” section on page 4-22

•Valid values for <MFS> are shown in the “MFS_TYPE” section on page 4-71

•Valid values for <FLOW> are shown in the “AWG_STATUS” section on

page 4-42

•<OPTICS> GBIC type; valid values are shown in the “OPTICS” section on

page 4-82

•<ALS> automatic laser shutdown; valid values are shown in the

“ALS_RESTART” section on page 4-41

•<TRANS> transponder mode; valid values are shown in the “TRANS_MODE”

section on page 4-94

•<PST> primary state; valid values for <PST> are shown in the “PST” section on

page 4-85

•<SST> secondary state; valid values for <SST> are shown in the “SST” section

on page 4-87

Input Example ED-G1000:TID:FAC-1-1:CTAG:::MFS=1548,FLOW=ON,OPTICS=COPPER,

ALS=AUTO_RESTART,TRANS=NONE:OOS,AINS;

Errors Errors are listed in Table 7-30 on page 7-20.

3-61

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.42 ED-NE-GEN: Edit Network Element General

This command edits the node attributes of the NE.

Notes:

1. Only the IPADDR, IPMASK, DEFRTR, IIOP PORT and node name can be modified with this

command.

2. The node name can be a maximum of 20 characters. If the entered name exceeds 20 characters, an

IPNV (Node Name Too Long) error message is returned.

3. The feature of setting a timing source has been supported since ONS 15454 R3.2.

4. An existing timing source can be removed by setting the address to 0.0.0.0.

Section ED-NE-GEN Description

Category System

Security Superuser

Messages

ALW-MSG-ALL RTRV-HDR

APPLY RTRV-INV

COPY-RFILE RTRV-MAP-NETWORK

ED-DAT RTRV-NE-GEN

ED-NE-SYNCN RTRV-NE-IPMAP

INH-MSG-ALL RTRV-NE-SYNCN

INIT-SYS RTRV-TOD

REPT EVT FXFR SET-TOD

Input Format ED-NE-GEN:[<TID>]::<CTAG>:::[NAME=<NAME>,][IPADDR=<IPADDR>,]

[IPMASK=<IPMASK>,][DEFRTR=<DEFRTR>,][IIOPPORT=<IIOPPORT>,]

[NTP=<NTP>];

where:

•<NAME> indicates the node name and is a string

•<IPADDR> indicates the node IP address and is a string

•<IPMASK> indicates the node IP mask and is a string

•<DEFRTR> indicates the node default router and is a string

•<IIOPPORT> indicates the node IIOPPORT and is an integer

•<NTP> indicates the node’s NTP timing origin address and is a string

Input Example ED-NE-GEN:CISCO::123:::NAME=NODENAME,IPADDR=192.168.100.52,

IPMASK=255.255.255.0,DEFRTR=192.168.100.1,IIOPPORT=57790,

NTP=192.168.100.52;

Errors Errors are listed in Table 7-30 on page 7-20.

3-62

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.43 ED-NE-SYNCN: Edit Network Element Synchronization

This command edits the synchronization attributes of the NE.

Notes:

1. Although mixed mode timing is supported in this release, it is not recommended. See the “Mixed

Mode Timing Support” section on page 1-14 for more information.

2. The existing external and line modes have the same functionality in all ONS 15454 3.x releases:

External mode: the node derives its timing from the BITS inputs.

Line mode: the node derives its timing from the SONET line(s).

Mixed mode: the node derives its timing from the BITS input or SONET lines.

Section ED-NE-SYNCN Description

Category Synchronization

Security Provisioning

Messages

ALW-MSG-ALL RLS-SYNCNSW

APPLY RTRV-ALM-BITS

COPY-RFILE RTRV-ALM-SYNCN

ED-BITS RTRV-BITS

ED-DAT RTRV-COND-BITS

ED-NE-GEN RTRV-COND-SYNCN

ED-SYNCN RTRV-HDR

INH-MSG-ALL RTRV-INV

INIT-SYS RTRV-MAP-NETWORK

OPR-SYNCNSW RTRV-NE-GEN

REPT ALM BITS RTRV-NE-IPMAP

REPT ALM SYNCN RTRV-NE-SYNCN

REPT EVT BITS RTRV-SYNCN

REPT EVT FXFR RTRV-TOD

REPT EVT SYNCN SET-TOD

Input Format ED-NE-SYNCN:[<TID>]::<CTAG>:::[TMMD=<TMMD>,]

[SSMGEN=<SSMGEN>,][QRES=<QRES>,][RVRTV=<RVRTV>,]

[RVTM=<RVTM>];

where:

•<TMMD> is the timing mode; valid values for <TMMD> are shown in the

“TIMING_MODE” section on page 4-93

•<SSMGEN> is the SSM message set; valid values for <SSMGEN> are shown

in the “SYNC_GENERATION” section on page 4-90

•<QRES> is the quality of the RES; valid values for <QRES> are shown in the

“SYNC_QUALITY_LEVEL” section on page 4-90

•<RVRTV> is the revertive mode; valid values for <RVRTV> are shown in the

“ON_OFF” section on page 4-79

•<RVTM> is the revertive time; valid values for <RVTM> are shown in the

“REVERTIVE_TIME” section on page 4-85

3-63

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

3.4.44 ED-OCH: Edit Optical Channel

Cisco ONS 15454 only for MXP and TXP cards.

This command edits the attributes (service parameters) and state of an OCH facility.

See the “Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards” section on page 1-8 for

specific MXP/TXP card provisioning rules.

Input Example ED-NE-SYNCN:CISCO::123:::TMMD=LINE,SSMGEN=GEN1,

QRES=ABOVE-PRS,RVRTV=Y,RVTM=8.0;

Errors Errors are listed in Table 7-30 on page 7-20.

Section ED-NE-SYNCN Description (continued)

Section ED-OCH Description

Category DWDM

Security Provisioning

Messages

RTRV-OCH

RTRV-ALM-OCH

RTRV-COND-OCH

RST-OCH

RMV-OCH

3-64

Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

September 2004

Chapter 3 TL1 Command Descriptions

TL1 Commands

Input Format ED-OCH:[<TID>]:<AID>:<CTAG>:::[RDIRN=<RDIRN>,]

[EXPWLEN=<EXPWLEN>,][VOAATTN=<VOAATTN>,]

[VOAPWR=<VOAPWR>,][CALOPWR=<CALOPWR>,][SFBER=<SFBER>,]

[SDBER=<SDBER>,][ALSMODE=<ALSMODE>,][ALSRCINT=<ALSRCINT>,]

[ALSRCPW=<ALSRCPW>,][COMM=<COMM>,][GCCRATE=<GCCRATE>,]

[OSFBER=<OSFBER>,][OSDBER=<OSDBER>,][DWRAP=<DWRAP>,]

[FEC=<FEC>,][MACADDR=<MACADDR>,][SYNCMSG=<SYNCMSG>,]

[SENDDUS=<SENDDUS>,][RLASER=<RLASER>,][SOAK=<SOAK>]:

[<PST>],[<SST>];

where:

•<AID> is an access identifier from the “CHANNEL” section on page 4-19

•<RDIRN> applicable in a future release

•<EXPWLEN> applicable in a future release

•<VOAATTN> indicates the value of calibrated attenuation for the VOA. It is

expressed in Dbm. The range is -24.0 to +2.0Dbm for MXP/TXP cards.

<VOAATTN> is a float

•<VOAPWR> applicable in a future release

•<CALOPWR> applicable in a future release

•<SFBER> identifies the SFBER for the SONET payload; valid values are shown

in the “SF_BER” section on page 4-86

•<SDBER> identifies the SDBER for the SONET payload; valid values are

shown in the “SD_BER” section on page 4-85

•<ALSMODE> indicates if the Automatic Laser Shutdown is enabled or

disabled; valid values are shown in the “ALS_MODE” section on page 4-41