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

User Manual: CISCO ONS 15327

Open the PDF directly: View PDF PDF.
Page Count: 514

DownloadCisco ONS 15454 And 15327 TL1 Command Guide, Release 4.0 454tl140
Open PDF In BrowserView PDF
Cisco ONS 15454 and Cisco ONS 15327
TL1 Command Guide
Product and Documentation Release 4.0
March 2003

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

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
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
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.

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)
Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide
Copyright © 2003 Cisco Systems, Inc. All rights reserved

CONTENTS
About This Guide

xxix

Document Objectives
Audience

xxix

xxix

Document Organization

xxx

Related Documentation

xxx

Document Conventions

xxxi

Where to Find Safety and Warning Information

xxxii

Obtaining Documentation xxxii
World Wide Web xxxii
Documentation CD-ROM xxxii
Ordering Documentation xxxii
Documentation Feedback xxxiii
Obtaining Technical Assistance xxxiii
Cisco.com xxxiii
Technical Assistance Center xxxiv
Cisco TAC Web Site xxxiv
Cisco TAC Escalation Center xxxiv
Obtaining Additional Publications and Information

CHAPTER

1

Getting Started

xxxv

1-1

1.1 Setting up TL1 Communication 1-2
1.1.1 Open a TL1 session 1-2
Open a TL1 Session Via CTC 1-2
Open a TL1 Session Via Telnet 1-3
Open a TL1 Session Via Craft Interface
1.2 TL1 Command Syntax

1-4

1-5

1.3 Autonomous Messages 1-6
1.3.1 Alarm Codes 1-6
1.4 TL1 Commands by User Security

1-7

1.5 Provisioning a DS3E Card in CTC Using TL1

1-8

1.6 Provisioning Rules for MXP_2.5G_10G and TXP_MR_10G Cards
1.6.1 Payload Provisioning Rules for MXP/TXP Cards 1-8
1.6.2 Termination Mode Provisioning Rules for MXP/TXP Cards

1-8

1-9

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

iii

Contents

1.6.3 Wavelength Provisioning Rules for MXP/TXP Cards 1-9
1.6.4 DCC/GCC Provisioning Rules for MXP/TXP Cards 1-10
1.6.5 G.709 Provisioning Rules for MXP/TXP Cards 1-10
1.6.6 FEC Provisioning Rules for MXP/TXP Cards 1-11
1.6.7 Synchronization Provisioning Rules for MXP/TXP Cards 1-11
1.6.8 Trace Provisioning Rules for MXP/TXP Cards 1-12
1.6.9 PM and Alarm Threshold Provisioning Rules for MXP/TXP Cards 1-13
1.6.10 Regeneration Group Provisioning Rules for MXP/TXP Cards 1-13
1.6.11 Y Cable Protection Group Provisioning Rules for MXP/TXP Cards 1-13
1.7 CTC Interoperability

1-14

1.8 Mixed Mode Timing Support

1-14

1.9 TL1 Command Completion Behavior 1-14
1.9.1 General Rules 1-14
1.9.1.1 Explicit List of AIDs - No Wildcards 1-15
1.9.1.2 Implicit List of AIDs - Single AID With Wildcard 1-15
1.9.1.3 Explicit List Grouped With Implicit List 1-15
1.9.2 Command Completion Behavior for Retrieval of Cross-Connections
1.9.2.1 Explicit List of AIDs - No Wildcards 1-15
1.9.2.2 Implicit List of AIDs - Single AID With Wildcard 1-16
1.9.2.3 Explicit List Grouped With Implicit List 1-16
1.10 Test Access 1-17
1.10.1 Test Access Terminology 1-18
1.10.2 TAP Creation and Deletion 1-18
1.10.2.1 ED-T1 1-19
1.10.2.2 ED-T3 1-19
1.10.2.3 ED-DS1 1-20
1.10.2.4 ED-STSn 1-20
1.10.2.5 ED-VT1 1-21
1.10.3 Connect Test Access Points 1-21
1.10.4 Change Access Mode 1-22
1.10.5 Disconnect Test Access Points 1-22
1.10.6 Delete Test Access Points 1-23
1.10.7 Retrieve Test Access Point Information
1.10.8 Test Access Configurations 1-24
1.10.9 Test Access Mode Definitions 1-26
1.10.9.1 MONE 1-26
1.10.9.2 MONF 1-27
1.10.9.3 MONEF 1-27
1.10.9.4 SPLTE 1-28

1-15

1-23

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

iv

March 2003

Contents

1.10.9.5 SPLTF 1-28
1.10.9.6 SPLTEF 1-29
1.10.9.7 LOOPE 1-29
1.10.9.8 LOOPF 1-30
1.10.9.9 SPLTA 1-30
1.10.9.10 SPLTB 1-31
1.10.10 Unmapped AID Test Access Point Connections
1.10.10.1 1-Way Circuit 1-32
1.10.10.2 2-Way Circuits 1-33
1.10.10.3 Unmapped AID 1-33

1-31

1.11 TL1 PCA Provisioning 1-34
1.11.1 Provision a PCA Cross-Connection 1-34
1.11.2 Retrieve a PCA Cross-Connection 1-35
1.12 FTP Software Download 1-35
1.12.1 COPY-RFILE 1-35
1.12.2 APPLY 1-36
1.12.3 REPT EVT FXFR 1-37
1.12.4 Downloading New Software 1-37
Download New Software 1-37
1.12.5 Activating New Software 1-40
Activate New Software 1-40
1.12.6 Remote Software Download/Activation Using the GNE

CHAPTER

2

TL1 Gateway

1-41

2-1

2.1 Gateway Network Element Topology

2-1

2.2 Implementing TL1 Gateway 2-4
Log Into a Remote ENE 2-5
Forward Commands by Specifying the ENE TID (Node 1 or Node 3)
Receive Autonomous Messages from the Remote ENE 2-5
Log Out of a Remote ENE 2-5

CHAPTER

3

TL1 Command Descriptions

2-5

3-1

3.1 TL1 Commands by Category

3-1

3.2 TL1 Commands by Card (ONS 15454)

3-6

3.3 TL1 Commands by Card (ONS 15327)

3-12

3.4 TL1 Commands 3-17
3.4.1 ACT-USER: Activate User 3-17
3.4.2 ALW-MSG-ALL: Allow Message All 3-19
3.4.3 ALW-MSG-DBCHG: Allow Database Change Message

3-19

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

v

Contents

3.4.4 ALW-MSG-SECU: Allow Message Security 3-20
3.4.5 ALW-PMREPT-ALL: Allow Performance Report All 3-20
3.4.6 ALW-SWDX-EQPT: Allow Switch Duplex Equipment 3-21
3.4.7 ALW-SWTOPROTN-EQPT: Allow Switch to Protection Equipment 3-21
3.4.8 ALW-SWTOWKG-EQPT: Allow Switch to Working Equipment 3-23
3.4.9 APPLY: Apply 3-24
3.4.10 CANC: Cancel 3-25
3.4.11 CANC-USER: Cancel User 3-25
3.4.12 CHG-ACCMD-: Change Test Access Mode (DS1, STS1, STS3C, STS6C, STS9C,
STS12C, STS24C, STS48C, STS192C, T1, T3, VT1) 3-26
3.4.13 CONN-TACC-: Connect Test Access (DS1, STS1, STS3C, STS6C, STS9C,
STS12C, STS24C, STS48C, STS192C, T1, T3, VT1) 3-27
3.4.14 COPY-IOSCFG: Copy IOS Config File 3-28
3.4.15 COPY-RFILE: Copy RFILE 3-30
3.4.16 DISC-TACC: Disconnect Test Access 3-32
3.4.17 DLT-BLSR: Delete BLSR 3-32
3.4.18 DLT-CRS-: Delete Cross Connection (STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C, STS192C) 3-33
3.4.19 DLT-CRS-VT1: Delete Virtual Tributary Cross Connect 3-35
3.4.20 DLT-EQPT: Delete Equipment 3-36
3.4.21 DLT-FFP-: Delete Facility Protection Group (OC3, OC12, OC48, OC192) 3-37
3.4.22 DLT-FFP-CLNT: Delete Facility Protection Group Client 3-38
3.4.23 DLT-UCP-CC: Delete Unified Control Plane Control Channel 3-39
3.4.24 DLT-UCP-IF: Delete Unified Control Plane Interface 3-40
3.4.25 DLT-UCP-NBR: Delete Unified Control Plane Neighbor 3-40
3.4.26 DLT-USER-SECU: Delete User Security 3-41
3.4.27 ED-: Edit (OC3, OC12, OC48, OC192) 3-42
3.4.28 ED-: Edit (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,
STS192C) 3-43
3.4.29 ED-BITS: Edit Building Integrated Timing Supply 3-46
3.4.30 ED-BLSR: Edit Bidirectional Line Switched Ring 3-48
3.4.31 ED-CLNT: Edit Client 3-49
3.4.32 ED-CRS-:ED CRS (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS 48C,
STS192C) 3-51
3.4.33 ED-CRS-VT1: Edit Cross Connection VT1 3-52
3.4.34 ED-DAT: Edit Date and Time 3-53
3.4.35 ED-DS1: Edit DS1 3-53
3.4.36 ED-DWDM: Edit Dense Wavelength Division Multiplexing 3-54
3.4.37 ED-EC1: Edit Electrical Carrier 3-55
3.4.38 ED-EQPT: Edit Equipment 3-56
3.4.39 ED-FFP-: Edit Facility Protection Group (OC3, OC12, OC48, OC192) 3-58
Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

vi

March 2003

Contents

3.4.40 ED-FFP-CLNT: Edit Facility Protection Group Client 3-59
3.4.41 ED-G1000: Edit G1000 3-60
3.4.42 ED-NE-GEN: Edit Network Element General 3-61
3.4.43 ED-NE-SYNCN: Edit Network Element Synchronization 3-62
3.4.44 ED-OCH: Edit Optical Channel 3-63
3.4.45 ED-PID: Edit Password 3-66
3.4.46 ED-SYNCN: Edit Synchronization 3-67
3.4.47 ED-T1: Edit T1 3-68
3.4.48 ED-T3: Edit T3 3-69
3.4.49 ED-TRC-CLNT: Edit Trace Client 3-71
3.4.50 ED-TRC-OCH: Edit Trace Optical Channel Facilities 3-72
3.4.51 ED-UCP-CC: Edit Unified Control Plane Control Channel 3-73
3.4.52 ED-UCP-IF: Edit Unified Control Plane Interface 3-74
3.4.53 ED-UCP-NBR: Edit Unified Control Plane Neighbor 3-75
3.4.54 ED-UCP-NODE: Edit Unified Control Plane Node 3-76
3.4.55 ED-USER-SECU: Edit User Security 3-79
3.4.56 ED-VT1: Edit Virtual Tributary 3-81
3.4.57 ENT-BLSR: Enter BLSR 3-82
3.4.58 ENT-CRS-: Enter Cross Connection (STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C, STS192C) 3-84
3.4.59 ENT-CRS-VT1: Enter STS Cross Connection VT1 3-86
3.4.60 ENT-EQPT: Enter Equipment 3-87
3.4.61 ENT-FFP-: Enter Facility Protection Group (OC3, OC12, OC48, OC192) 3-90
3.4.62 ENT-FFP-CLNT: Enter Facility Protection Group Client 3-91
3.4.63 ENT-UCP-CC: Enter Unified Control Plane Control Channel 3-92
3.4.64 ENT-UCP-IF: Enter Unified Control Plane Interface 3-95
3.4.65 ENT-UCP-NBR: Enter Unified Control Plane Neighbor 3-96
3.4.66 ENT-USER-SECU: Enter User Security 3-99
3.4.67 EX-SW-: Operate Protection Switch (OC12, OC48, OC192) 3-100
3.4.68 INH-MSG-ALL: Inhibit Message All 3-101
3.4.69 INH-MSG-DBCHG: Inhibit Database Change Message 3-102
3.4.70 INH-MSG-SECU: Inhibit Message Security 3-102
3.4.71 INH-PMREPT-ALL: Inhibit Performance Report All 3-102
3.4.72 INH-SWDX-EQPT: Inhibit Switch Duplex Equipment 3-103
3.4.73 INH-SWTOPROTN-EQPT: Inhibit Switch to Protection Equipment 3-104
3.4.74 INH-SWTOWKG-EQPT: Inhibit Switch to Working Equipment 3-105
3.4.75 INIT-REG-: Initialize Register (CLNT, DS1, EC1, OC3, OC12, OC48, OC192, OCH, STS1,
STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1) 3-108
3.4.76 INIT-SYS: Initialize System 3-109
3.4.77 OPR-ACO-ALL: Operate Alarm Cutoff All 3-109
Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0
March 2003

vii

Contents

3.4.78 OPR-EXT-CONT: Operate External Control 3-110
3.4.79 OPR-LPBK-: Operate Loopback (CLNT, DS1, EC1, OC12, OC192, OC3, OC48, OCH,
STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, VT1) 3-111
3.4.80 OPR-PROTNSW-: Operate Protection Switch (OC3, OC12, OC48, OC192) 3-112
3.4.81 OPR-PROTNSW-: Operate Protection Switch (STS1, STS3C, STS6C, STS9C,
STS12C, STS24C, STS48C, STS192C) 3-114
3.4.82 OPR-PROTNSW-CLNT: Operate Protection Switch Client 3-115
3.4.83 OPR-PROTNSW-VT1: Operate Virtual Tributary Protection Switch VT1 3-116
3.4.84 OPR-SYNCNSW: Operate Synchronization Switch 3-117
3.4.85 REPT ALM : Report Alarm (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE,
OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C,
STS9C, T1, T3, UDCDCC, UDCF, VT1) 3-118
3.4.86 REPT ALM BITS: Report Alarm Building Integrated Timing Supply 3-119
3.4.87 REPT ALM COM: Report Alarm COM 3-120
3.4.88 REPT ALM ENV: Report Alarm Environment 3-121
3.4.89 REPT ALM EQPT: Report Alarm Equipment 3-122
3.4.90 REPT ALM RING: Report Alarm Ring 3-123
3.4.91 REPT ALM SYNCN: Report Alarm Synchronization 3-124
3.4.92 REPT ALM UCP: Report Alarm Unified Control Plane 3-125
3.4.93 REPT DBCHG: Report Database Change Message 3-126
3.4.94 REPT EVT : Report Event (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE,
OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C,
STS9C, T1, T3, UDCDCC, UDCF, VT1) 3-128
3.4.95 REPT EVT BITS: Report Event BITS 3-129
3.4.96 REPT EVT COM: Report Event COM 3-130
3.4.97 REPT EVT ENV: Report Event Environment 3-131
3.4.98 REPT EVT EQPT: Report Event Equipment 3-132
3.4.99 REPT EVT FXFR: Report Event Software Download 3-133
3.4.100 REPT EVT IOSCFG: Report Event IOS Config File 3-134
3.4.101 REPT EVT RING: Report Event Ring 3-135
3.4.102 REPT EVT SECU: Report Event Security 3-136
3.4.103 REPT EVT SESSION: Report Event Session 3-137
3.4.104 REPT EVT SYNCN: Report Event Synchronization 3-138
3.4.105 REPT EVT UCP: Report Event Unified Control Plane 3-139
3.4.106 REPT PM : Report Performance Monitoring (CLNT, DS1, EC1, OC12, OC192, OC3,
OC48, OCH, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1, T3, VT1) 3-140
3.4.107 REPT SW: Report Switch 3-141
3.4.108 RLS-EXT-CONT: Release External Control 3-141
3.4.109 RLS-LPBK-: Release Loopback (CLNT, DS1, EC1, OC12, OC192, OC3, OC48, OCH,
STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C, STS9C, T1,T3, VT1) 3-142
3.4.110 RLS-PROTNSW-: Release Protection Switch (OC3, OC12, OC48, OC192) 3-143

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

viii

March 2003

Contents

3.4.111 RLS-PROTNSW-: Release Protection Switch (STS1, STS3C, STS6C, STS9C,
STS12C, STS24C, STS48C, STS192C) 3-144
3.4.112 RLS-PROTNSW-CLNT: Release Protection Switch Client 3-145
3.4.113 RLS-PROTNSW-VT1: Release Protection Switch VT1 3-145
3.4.114 RLS-SYNCNSW: Release Synchronization Switch 3-146
3.4.115 RMV-: Remove (CLNT, DS1, EC1, G1000, OC12, OC192, OC3, OC48, OCH, T1,
T3) 3-147
3.4.116 RST-: Restore (CLNT, DS1, EC1, G1000, OC12, OC192, OC3, OC48, OCH, T1,
T3) 3-147
3.4.117 RTRV-: Retrieve (OC3, OC12, OC48, OC192) 3-148
3.4.118 RTRV-: Retrieve (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,
STS192C) 3-151
3.4.119 RTRV-ALM-:Retrieve Alarm (CLNT, DS1, E100, E1000, EC1, FSTE, G1000, GIGE,
OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C, STS6C,
STS9C, T1, T3, UDCDCC, UDCF, VT1) 3-154
3.4.120 RTRV-ALM-ALL: Retrieve Alarm All 3-155
3.4.121 RTRV-ALM-BITS: Retrieve Alarm Building Integrated Timing Supply 3-157
3.4.122 RTRV-ALM-ENV: Retrieve Alarm Environment 3-159
3.4.123 RTRV-ALM-EQPT: Retrieve Alarm Equipment 3-160
3.4.124 RTRV-ALM-RING: Retrieve Alarm Ring 3-162
3.4.125 RTRV-ALM-SYNCN: Retrieve Alarm Synchronization 3-163
3.4.126 RTRV-ALM-UCP: Retrieve Alarm Unified Control Plane 3-165
3.4.127 RTRV-ATTR-CONT: Retrieve Attribute Control 3-167
3.4.128 RTRV-ATTR-ENV: Retrieve Attribute Environment 3-168
3.4.129 RTRV-BITS: Retrieve Building Integrated Timing Supply 3-169
3.4.130 RTRV-BLSR: Retrieve Bidirectional Line Switched Ring 3-171
3.4.131 RTRV-CLNT: Retrieve Client 3-173
3.4.132 RTRV-COND-: Retrieve Condition (CLNT, DS1, E100, E1000, EC1, FSTE, G1000,
GIGE, OC12, OC192, OC3, OC48, OCH, POS, STS1, STS12C, STS192C, STS24C, STS3C, STS48C,
STS6C, STS9C, T1, T3, UDCDCC, UDCF, VT1) 3-175
3.4.133 RTRV-COND-ALL: Retrieve Condition All 3-177
3.4.134 RTRV-COND-BITS: Retrieve Condition Building Integrated Timing Supply 3-179
3.4.135 RTRV-COND-ENV: Retrieve Environmental Condition 3-181
3.4.136 RTRV-COND-EQPT: Retrieve Condition Equipment 3-182
3.4.137 RTRV-COND-RING: Retrieve Condition Ring 3-185
3.4.138 RTRV-COND-SYNCN: Retrieve Condition Synchronization 3-186
3.4.139 RTRV-COND-UCP: Retrieve Condition Unified Control Plane 3-188
3.4.140 RTRV-CRS: Retrieve Cross Connect 3-189
3.4.141 RTRV-CRS-: Retrieve Cross Connect (STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C, STS192C) 3-191
3.4.142 RTRV-CRS-VT1: Retrieve Cross Connect Virtual Tributary 3-194

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

ix

Contents

3.4.143 RTRV-DS1: Retrieve DS1 3-196
3.4.144 RTRV-DWDM: Retrieve Dense Wavelength Division Multiplexing 3-197
3.4.145 RTRV-EC1: Retrieve EC1 3-199
3.4.146 RTRV-EQPT: Retrieve Equipment 3-200
3.4.147 RTRV-EXT-CONT: Retrieve External Control 3-202
3.4.148 RTRV-FFP-: Retrieve Facility Protection Group (OC3, OC12, OC48,
OC192) 3-203
3.4.149 RTRV-FFP-CLNT: Retrieve Facility Protection Group Client 3-204
3.4.150 RTRV-FSTE: Retrieve Fast Ethernet 3-206
3.4.151 RTRV-G1000: Retrieve G1000 Facility 3-207
3.4.152 RTRV-GIGE: Retrieve Gigabit Ethernet 3-208
3.4.153 RTRV-HDR: Retrieve Header 3-210
3.4.154 RTRV-INV: Retrieve Inventory 3-210
3.4.155 RTRV-LOG: Retrieve Log 3-212
3.4.156 RTRV-MAP-NETWORK: Retrieve Map Network 3-213
3.4.157 RTRV-NE-GEN: Retrieve Network Element General 3-213
3.4.158 RTRV-NE-IPMAP: Retrieve Network Element IPMAP 3-215
3.4.159 RTRV-NE-SYNCN: Retrieve Network Element Synchronization 3-216
3.4.160 RTRV-OCH: Retrieve Optical Channel 3-218
3.4.161 RTRV-PM-: Retrieve Performance (CLNT, DS1, EC1, OC3, OC12, OC48, OC192, OCH,
STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1) 3-221
3.4.162 RTRV-PMMODE-: Retrieve Performance Mode of PM Data Collection (STS1,
STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C) 3-224
3.4.163 RTRV-PMSCHED-:Retrieve Performance Monitoring Schedule (CLNT, DS1, EC1,
OC3, OC12, OC48, OC192, OCH, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,
T1, T3, VT1) 3-225
3.4.164 RTRV-PMSCHED-ALL: Retrieve Performance Schedule All 3-226
3.4.165 RTRV-POS: Retrieve Packet Over SONET 3-228
3.4.166 RTRV-PROTNSW-: Retrieve Protection Switch (OC3, OC12, OC48,
OC192) 3-229
3.4.167 RTRV-PROTNSW-: Retrieve Protection Switch (STS1, STS3C, STS6C, STS9C,
STS12C, STS24C, STS48C, STS192C) 3-230
3.4.168 RTRV-PROTNSW-CLNT: Retrieve Protection Switch Client 3-231
3.4.169 RTRV-PROTNSW-VT1: Retrieve Protection Switch VT1 3-232
3.4.170 RTRV-PTHTRC-: Retrieve Path Trace (STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C, STS192C) 3-232
3.4.171 RTRV-SYNCN: Retrieve Synchronization 3-234
3.4.172 RTRV-T1: Retrieve T1 Facility 3-235
3.4.173 RTRV-T3: Retrieve T3 3-237
3.4.174 RTRV-TACC: Retrieve Test Access 3-238

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

x

March 2003

Contents

3.4.175 RTRV-TH-: Retrieve Threshold (CLNT, DS1, EC1, OC3, OC12, OC48, OC192, OCN,
STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3, VT1) 3-240
3.4.176 RTRV-TOD: Retrieve Time of Day 3-242
3.4.177 RTRV-TRC-: Retrieve Trace Client (OC12, OC192, OC48) 3-243
3.4.178 RTRV-TRC-CLNT: Retrieve Trace Client 3-244
3.4.179 RTRV-TRC-OCH: Retrieve Trace Optical Channel 3-245
3.4.180 RTRV-UCP-CC: Retrieve Unified Control Plane Control Channel 3-247
3.4.181 RTRV-UCP-IF: Retrieve Unified Control Plane Interface 3-249
3.4.182 RTRV-UCP-NBR: Retrieve Unified Control Plane Neighbor 3-251
3.4.183 RTRV-UCP-NODE: Retrieve Unified Control Plane Node 3-252
3.4.184 RTRV-USER-SECU: Retrieve User Security 3-255
3.4.185 RTRV-VT1: Retrieve VT1 3-256
3.4.186 SCHED-PMREPT-: Schedule Performance Monitoring Report (CLNT, DS1, EC1, OC3,
OC12, OC48, OC192, OCH, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, T1, T3,
VT1) 3-257
3.4.187 SET-ATTR-CONT: Set Attribute Control 3-259
3.4.188 SET-ATTR-ENV: Set Attribute Environment 3-260
3.4.189 SET-PMMODE-: Set Performance Mode of PM Data Collection (STS1, STS3C,
STS6C, STS9C, STS12C, STS24C, STS48C, STS192C) 3-261
3.4.190 SET-TH-: Set Threshold (CLNT, DS1, EC1, OC3, OC12,OC48, OC192, OCH, STS1,
STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,T1, T3, VT1) 3-262
3.4.191 SET-TOD: Set Time of Day 3-263
3.4.192 SW-DX-EQPT: Switch Duplex Equipment 3-263
3.4.193 SW-TOPROTN-EQPT: Switch to Protection Equipment 3-264
3.4.194 SW-TOWKG-EQPT: Switch to Working Equipment 3-266

CHAPTER

4

TL1 Command Components

4-1

4.1 TL1 Default Values 4-1
4.1.1 BLSR 4-1
4.1.2 Cross Connections 4-1
4.1.3 Environment Alarms and Controls
4.1.4 Equipment 4-2
4.1.5 Performance 4-2
4.1.6 Ports 4-3
4.1.7 SONET Line Protection 4-4
4.1.8 STS and VT Paths 4-4
4.1.9 Synchronization 4-5
4.1.10 Testing 4-5
4.2 Modifier Support by Platform

4-2

4-6

4.3 Starting Positions for an STS-Mc SPE

4-7

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

xi

Contents

4.4 Access Identifiers 4-10
4.4.1 ALL 4-10
4.4.2 CrossConnectID 4-14
4.4.3 IPCC 4-16
4.4.4 NBR 4-16
4.4.5 PRSLOT 4-16
4.4.6 UCP 4-17
4.4.7 AONS 4-17
4.4.8 BAND 4-17
4.4.9 BITS 4-18
4.4.9.1 BITS for ONS 15454 4-18
4.4.9.2 BITS for ONS 15327 4-18
4.4.10 BLSR 4-18
4.4.10.1 BLSR for ONS 15454 4-18
4.4.10.2 BLSR for ONS 15327 4-19
4.4.11 CHANNEL 4-19
4.4.12 COM 4-19
4.4.12.1 COM for ONS 15454 4-19
4.4.12.2 COM for ONS 15327 4-20
4.4.13 DS1 4-20
4.4.14 ENV 4-20
4.4.14.1 ENV for ONS 15454 4-20
4.4.14.2 ENV for ONS 15327 4-21
4.4.15 EQPT 4-21
4.4.15.1 EQPT for ONS 15454 4-21
4.4.15.2 EQPT for ONS 15327 4-22
4.4.16 FACILITY 4-22
4.4.16.1 FACILITY for ONS 15454 4-22
4.4.16.2 FACILITY for ONS 15327 4-23
4.4.17 LINE 4-23
4.4.18 OSC 4-24
4.4.19 RFILE 4-24
4.4.19.1 RFILE for ONS 15454 4-24
4.4.20 STS 4-24
4.4.20.1 STS for ONS 15454 4-24
4.4.20.2 STS for ONS 15327 4-26
4.4.21 SYN 4-26
4.4.21.1 SYN for ONS 15454 4-26
4.4.21.2 SYN for ONS 15327 4-27
4.4.22 SYN_SRC 4-27
Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0

xii

March 2003

Contents

4.4.22.1 SYN_SRC for ONS 15454 4-27
4.4.22.2 SYN_SRC for ONS 15327 4-27
4.4.23 SYNC_REF 4-28
4.4.23.1 SYNC_REF for ONS 15454 4-28
4.4.23.2 SYNC_REF for ONS 15327 4-28
4.4.24 SYNCSW 4-29
4.4.24.1 SYNCSW for ONS 15454 4-29
4.4.24.2 SYNCSW for ONS 15327 4-29
4.4.25 TACC 4-29
4.4.26 TAP 4-30
4.4.27 UDC 4-30
4.4.28 VT1_5 4-30
4.4.28.1 VT1_5 for ONS 15454 4-30
4.4.28.2 VT1_5 for ONS 15327 4-31
4.5 Parameter Types 4-31
4.5.1 ATAG Description 4-31
4.5.2 CTAG Description 4-32
4.5.3 TID Description 4-32
4.5.4 Parameter Notes 4-33
4.5.5 ALL_MONTYPE 4-33
4.5.6 ALL_THR 4-37
4.5.7 ALM_THR 4-40
4.5.8 ALS_CFG 4-41
4.5.9 ALS_MODE 4-41
4.5.10 ALS_RESTART 4-41
4.5.11 AMPL_MODE 4-42
4.5.12 AWG_STATUS 4-42
4.5.13 BITS_LineBuildOut 4-42
4.5.14 BLSR_MODE 4-42
4.5.15 BLSR_PTH_STATE 4-43
4.5.16 BLSR_PTH_TYPE 4-43
4.5.17 BLSR_TYPE 4-43
4.5.18 C2_BYTE 4-44
4.5.19 CCT 4-45
4.5.20 CIRCUIT_SIZE 4-45
4.5.21 CMD_MODE 4-46
4.5.22 COMM_TYPE 4-46
4.5.23 COND_EFF 4-47
4.5.24 CONDITION 4-47
4.5.25 CONT_MODE 4-59
Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0
March 2003

xiii

Contents

4.5.26
4.5.27
4.5.28
4.5.29
4.5.30
4.5.31
4.5.32
4.5.33
4.5.34
4.5.35
4.5.36
4.5.37
4.5.38
4.5.39
4.5.40
4.5.41
4.5.42
4.5.43
4.5.44
4.5.45
4.5.46
4.5.47
4.5.48
4.5.49
4.5.50
4.5.51
4.5.52
4.5.53
4.5.54
4.5.55
4.5.56
4.5.57
4.5.58
4.5.59
4.5.60
4.5.61
4.5.62
4.5.63
4.5.64
4.5.65

CONTTYPE 4-59
CREATION_TYPE 4-60
CRS_TYPE 4-60
DATARATE 4-60
DIRECTION 4-60
DIRN 4-61
DL_TYPE 4-61
DS_LINE_CODE 4-61
DS_LINE_TYPE 4-61
DURATION 4-62
E_LBO 4-62
ENV_ALM 4-62
EQPT_TYPE 4-63
EQUIP 4-66
EQUIPMENT_TYPE 4-66
ETHER_DUPLEX 4-67
ETHER_SPEED 4-68
EXP 4-68
EXT_RING 4-68
FIBER_TYPE 4-68
FLOW 4-69
FRAME_FORMAT 4-69
GCCRATE 4-69
HEATER_STATUS 4-69
INH_MODE 4-70
LASER_STATUS 4-70
LINE_BUILDOUT 4-70
LINE_CODE 4-70
LOCATION 4-71
LPBK_TYPE 4-71
MFS_TYPE 4-71
MOD2 4-72
MOD2_IO 4-72
MOD2ALM 4-73
MOD2B 4-74
MOD2O 4-75
MOD_PATH 4-75
MOD_PORT 4-76
MOD_TACC 4-76
MODULE_OP 4-77

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

xiv

March 2003

Contents

4.5.66 MSGTYPE 4-77
4.5.67 MUX_TYPE 4-78
4.5.68 NOTIF_CODE 4-78
4.5.69 OCN_BLSR 4-78
4.5.70 OCN_MONTYPE 4-79
4.5.71 OCN_TYPE 4-79
4.5.72 ON_OFF 4-79
4.5.73 OPTICAL_BAND 4-80
4.5.74 OPTICAL_LINK_TYPE 4-80
4.5.75 OPTICAL_MODE 4-80
4.5.76 OPTICAL_PORT_TYPE 4-81
4.5.77 OPTICAL_WLEN 4-81
4.5.78 OPTICS 4-82
4.5.79 PAYLOAD 4-83
4.5.80 PM_MODE 4-83
4.5.81 PM_STATE 4-83
4.5.82 PRIVILEGE 4-83
4.5.83 PRODUCT_TYPE 4-84
4.5.84 PROTECTION_GROUP 4-84
4.5.85 PROTTYPE 4-84
4.5.86 PST 4-85
4.5.87 RDIRN_MODE 4-85
4.5.88 REVERTIVE_TIME 4-85
4.5.89 SD_BER 4-85
4.5.90 SDCC_MODE 4-86
4.5.91 SERV_EFF 4-86
4.5.92 SF_BER 4-86
4.5.93 SIDE 4-87
4.5.94 SST 4-87
4.5.95 STATUS 4-87
4.5.96 STM_TYPE 4-87
4.5.97 STS_MONTYPE 4-88
4.5.98 STS_PATH 4-88
4.5.99 SW 4-88
4.5.100 SWITCH_TYPE 4-89
4.5.101 SYNC_CLOCK_REF_QUALITY_LEVEL
4.5.102 SYNC_GENERATION 4-90
4.5.103 SYNC_QUALITY_LEVEL 4-90
4.5.104 SYNC_GENERATION 4-91
4.5.105 SYS_TYPE 4-91

4-89

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

xv

Contents

4.5.106
4.5.107
4.5.108
4.5.109
4.5.110
4.5.111
4.5.112
4.5.113
4.5.114
4.5.115
4.5.116
4.5.117
4.5.118
4.5.119
4.5.120
4.5.121
4.5.122
4.5.123
4.5.124
4.5.125
4.5.126
4.5.127
4.5.128
4.5.129
4.5.130
4.5.131

CHAPTER

5

T1_MONTYPE 4-91
T3_MONTYPE 4-92
TACC_MODE 4-92
TERM_MODE 4-93
TIMING_MODE 4-93
TMPER 4-93
TRANS_MODE 4-94
TRCFORMAT 4-94
TRCLEVEL 4-94
TRCMODE 4-94
TX_RSLT 4-95
TX_STATUS 4-95
TX_TYPE 4-95
UCP_ADM_STATE 4-96
UCP_CC_TUN_MD 4-96
UCP_CKT_STATE 4-96
UCP_CRC_MODE 4-97
UCP_IPCC_TYPE 4-97
UCP_TNA_TYPE 4-97
UNI_BI 4-97
UP_DOWN 4-98
VALIDITY 4-98
VOA_CNTR_MODE 4-98
VT1_5_MONTYPE 4-98
WDM 4-99
WLEN_MODE 4-99

Ring Provisioning

5-1

5.1 UPSR Topology

5-1

5.2 UPSR Cross-Connections

5-2

5.3 Ring-to-Ring Interconnection 5-2
5.3.1 Sample UPSR to UPSR Connection 5-3
5.3.2 Sample UPSR to Two-Fiber BLSR Connection 5-4
5.3.3 Sample Two-Fiber BLSR to UPSR Connection 5-5
5.3.4 Sample Two-Fiber BLSR to Two-Fiber BLSR Connection 5-6
5.3.5 Sample Two-Fiber BLSR to Four-Fiber BLSR Connection (ONS 15454)
5.3.6 Sample UPSR to Four-Fiber BLSR Connection (ONS 15454) 5-8
5.4 1-Way Drop and Continue 5-9
5.4.1 Sample Node 1 Configuration (Source Node)

5-7

5-9

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

xvi

March 2003

Contents

5.4.2 Sample Node 2 Configuration (Drop and Continue Node)
5.4.3 Sample Node 3 Configuration (Destination Node) 5-10

CHAPTER

6

TL1 Performance Monitoring

5-10

6-1

6.1 Performance Monitoring by Card
6.2 PM Parameters by Line Type

6-1

6-5

6.3 Scheduled PM Report 6-6
6.3.1 Create a PM Schedule and Receive an Autonomous PM Report 6-6
6.3.2 Manage PM Schedules 6-7
6.3.3 Enable or Disable a TL1 Session to Receive Autonomous PM Reports

CHAPTER

7

TL1 Alarms and Errors

6-7

7-1

7.1 Alarms 7-1
7.1.1 AEP 7-2
7.1.2 AIP 7-2
7.1.3 BITS 7-3
7.1.4 BP 7-3
7.1.5 CC 7-3
7.1.6 CKT 7-4
7.1.7 DS1 7-4
7.1.8 DS3 7-4
7.1.9 DWDM Client 7-5
7.1.10 DWDM Trunk 7-6
7.1.11 ECN 7-9
7.1.12 ENV 7-9
7.1.13 EQPT 7-10
7.1.14 ETHER 7-12
7.1.15 EXTSYNCH 7-12
7.1.16 FAN 7-12
7.1.17 FUDC 7-13
7.1.18 HDGE (G1000) 7-13
7.1.19 ML1000 7-14
7.1.20 MSUDC 7-14
7.1.21 NBR 7-14
7.1.22 NE 7-15
7.1.23 NERING 7-16
7.1.24 NESYNCH 7-16
7.1.25 OCN 7-16
7.1.26 STSMON 7-18
Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0
March 2003

xvii

Contents

7.1.27 STSTERM 7-18
7.1.28 VT-MON 7-19
7.1.29 VT-TERM 7-19
7.2 Errors 7-20
7.2.1 Errors Listed by Error Code
7.3 Echo

7-20

7-37

INDEX

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

xviii

March 2003

F I G U R E S

Figure 1-1

Autonomous message format

Figure 1-2

Circuit with no access

Figure 1-3

Single node view (Node 1)

Figure 1-4

Multi-node view (MONE example)

Figure 1-5

Circuit with no access

Figure 1-6

MONE access

1-26

Figure 1-7

MONF access

1-27

Figure 1-8

MONEF access

Figure 1-9

SPLTE access

1-28

Figure 1-10

SPLTF access

1-28

Figure 1-11

SPLTEF access

1-29

Figure 1-12

LOOPE access

1-29

Figure 1-13

LOOPF access

1-30

Figure 1-14

SPLTA access

1-30

Figure 1-15

SPLTB access

1-31

Figure 2-1

Example of a GNE topology

Figure 2-2

Four-node ring without TL1 Gateway

Figure 2-3

Four-node ring with TL1 Gateway

Figure 5-1

Network configured with a 1-way UPSR circuit

Figure 5-2

Network map with Cisco node showing ring-to-ring interconnection

Figure 5-3

UPSR to UPSR connection specifications through the Cisco node

Figure 5-4

Selector between 5/1/1 and 6/1/1

Figure 5-5

Selector between 12/3/2 and 13/3/2

Figure 5-6

UPSR to two-fiber BLSR

Figure 5-7

Selector between 5/1/1 and 6/1/1

Figure 5-8

Bridge from 12/3/2 to Ring 1

Figure 5-9

Two-fiber BLSR to UPSR

Figure 5-10

Bridge from 6/1/1 to Ring 2

Figure 5-11

Selector between 12/3/2 and 13/3/2 to Ring 1

Figure 5-12

Two-fiber BLSR to two-fiber BLSR

Figure 5-13

2-way connection from 5/1/1 to 13/3/2

1-6

1-17
1-24
1-25

1-26

1-27

2-2
2-4

2-4
5-2
5-3

5-3

5-4
5-4

5-4
5-5

5-5

5-5
5-6
5-6

5-6
5-7

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

xix

Figures

Figure 5-14

Two-fiber BLSR to four-fiber BLSR

Figure 5-15

2-way connection from 1/1/1 to 5/1/1

Figure 5-16

UPSR to four-fiber BLSR

Figure 5-17

Selector between 1/1/1 and 2/1/1 to Ring 2 (5/1/190)

Figure 5-18

Bridge from 5/1/190 to Ring 1 (1/1/1 and 2/1/1)

Figure 5-19

1-way drop and continue

Figure 5-20

Bridge from 1/1/1 to 5/1/1 and 6/1/1

Figure 5-21

Selector between 5/1/1 and 6/1/1 to 1/1/1

5-10

Figure 5-22

Selector between 5/1/1 and 6/1/1 to 1/1/1

5-10

5-7
5-7

5-8
5-8

5-8

5-9
5-9

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

xx

March 2003

T A B L E S

Table 1-1

Command Access

Table 1-2

Security Default Time Outs

Table 1-3

Modes Supported by Circuit Type

Table 2-1

Gateway Resource Pool

Table 2-2

Examples of a Single GNE Topology Showing How the GNE/ENE Resources can be Allocated

Table 3-1

TL1 Commands by Category

Table 3-2

TL1 Commands by Card (ONS 15454)

3-6

Table 3-3

TL1 Commands by Card (ONS 15327)

3-12

Table 4-1

BLSR Default Values

Table 4-2

Cross Connections Default Values

Table 4-3

Environment Alarms and Controls Default Values

Table 4-4

Equipment Default Values

Table 4-5

Performance Default Values

Table 4-6

Ports Default Values

Table 4-7

SONET Line Protection Default Values

Table 4-8

STS and VT Paths Default Values

Table 4-9

Synchronization Default Values

Table 4-10

Testing Default Values

Table 4-11

Modifier Support

Table 4-12

Starting Positions for an STS-Mc SPE in an OC-12 Signal

4-7

Table 4-13

Starting Positions for an STS-Mc SPE in an OC-48 Signal

4-7

Table 4-14

Starting positions for an STS-Mc SPE in an OC-192 Signal

Table 4-15

ALL for ONS 15454 and ONS 15327

Table 4-16

CrossConnectID for ONS 15454

Table 4-17

IPCC for ONS 15454

4-16

Table 4-18

NBR for ONS 15454

4-16

Table 4-19

PRSLOT for ONS 15454

Table 4-20

UCP for ONS 15454

Table 4-21

AONS for ONS 15454

4-17

Table 4-22

BAND for ONS 15454

4-17

Table 4-23

BITS for ONS 15454

1-7
1-8
1-33

2-2
2-3

3-1

4-1
4-1
4-2

4-2
4-2

4-3
4-4

4-4
4-5

4-5

4-6

4-8

4-10

4-14

4-16

4-17

4-18

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

xxi

Tables

Table 4-24

BITS for ONS 15327

4-18

Table 4-25

BLSR for ONS 15454

4-18

Table 4-26

BLSR for ONS 15327

4-19

Table 4-27

CHANNEL Values

Table 4-28

COM for ONS 15454

4-19

Table 4-29

COM for ONS 15327

4-20

Table 4-30

DS1 for ONS 15454

4-20

Table 4-31

ENV for ONS 15454

4-20

Table 4-32

ENV for ONS 15327

4-21

Table 4-33

EQPT for ONS 15454

4-21

Table 4-34

EQPT for ONS 15327

4-22

Table 4-35

FACILITY for ONS 15454

4-22

Table 4-36

FACILITY for ONS 15327

4-23

Table 4-37

LINE Values

4-23

Table 4-38

OSC Values

4-24

Table 4-39

RFILE for ONS 15454

Table 4-40

STS for ONS 15454

4-24

Table 4-41

STS for ONS 15327

4-26

Table 4-42

SYN for ONS 15454

4-26

Table 4-43

SYN for ONS 15327

4-27

Table 4-44

SYN_SRC for ONS 15454

4-27

Table 4-45

SYN_SRC for ONS 15327

4-27

Table 4-46

SYNC_REF for ONS 15454

4-28

Table 4-47

SYNC_REF for ONS 15327

4-28

Table 4-48

SYNCSW for ONS 15454

4-29

Table 4-49

SYNCSW for ONS 15327

4-29

Table 4-50

TACC for ONS 15454

4-29

Table 4-51

TACC for ONS 15327

4-30

Table 4-52

UDC for ONS 15454

Table 4-53

VT1_5 for ONS 15454

4-30

Table 4-54

VT1_5 for ONS 15327

4-31

Table 4-55

ALL_MONTYPE Values

Table 4-56

ALL_THR Value

Table 4-57

ALM_THR Values

Table 4-58

ALS_CFG Values

4-19

4-24

4-30

4-33

4-37
4-40
4-41

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

xxii

March 2003

Tables

Table 4-59

ALS_MODE Values

Table 4-60

ALS_RESTART Values

Table 4-61

AMPL_MODE Values

Table 4-62

AWG_STATUS Values

Table 4-63

BITS_LineBuildOut Values

Table 4-64

BLSR_MODE Values

Table 4-65

BLSR_PTH_STATE Values

Table 4-66

BLSR_PTH_TYPE Values

Table 4-67

BLSR_TYPE Values

Table 4-68

C2_BTYE Values

Table 4-69

CCT Values

Table 4-70

CIRCUIT_SIZE Values

Table 4-71

CMD_MODE Values

Table 4-72

COMM_TYPE Values

Table 4-73

COND_EFF Values

Table 4-74

CONDITION Values

Table 4-75

CONT_MODE Values

Table 4-76

CONTTYPE Values

Table 4-77

CREATION_TYPE Values

Table 4-78

CRS_TYPE Values

4-60

Table 4-79

DATARATE Values

4-60

Table 4-80

DIRECTION Values

4-60

Table 4-81

DIRN Values

Table 4-82

DL_TYPE Values

Table 4-83

DS_LINE_CODE Values

4-61

Table 4-84

DS_LINE_TYPE Values

4-61

Table 4-85

DURATION Values

Table 4-86

E_LBO Values

Table 4-87

ENV_ALM Values

Table 4-88

EQPT_TYPE Values

Table 4-89

EQUIP Values

Table 4-90

EQUIPMENT_TYPE Values

Table 4-91

ETHER_DUPLEX Values

Table 4-92

ETHER_SPEED Values

Table 4-93

EXP Values

4-41
4-41
4-42
4-42
4-42

4-43
4-43
4-43

4-43
4-44

4-45
4-45
4-46
4-46
4-47
4-47
4-59
4-59
4-60

4-61
4-61

4-62

4-62
4-62
4-63

4-66
4-66
4-68
4-68

4-68

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

xxiii

Tables

Table 4-94

EXT_RING Values

Table 4-95

FIBER_TYPE Values

Table 4-96

FLOW Values

Table 4-97

FRAME_FORMAT Values

Table 4-98

GCCRATE Values

Table 4-99

HEATER_STATUS Values

Table 4-100

INH_MODE Values

Table 4-101

LASER_STATUS Values

4-70

Table 4-102

LINE_BUILDOUT Values

4-70

Table 4-103

LINE_CODE Values

Table 4-104

LOCATION Values

Table 4-105

LPBK_TYPE Values

4-71

Table 4-106

MFS_TYPE Values

4-71

Table 4-107

MOD2 Values

Table 4-108

MOD2_IO Values

Table 4-109

MOD2ALM Values

Table 4-110

MOD2B Values

4-74

Table 4-111

MOD2O Values

4-75

Table 4-112

MOD_PATH Values

4-75

Table 4-113

MOD_PORT Values

4-76

Table 4-114

MOD_TACC Values

4-76

Table 4-115

MOD_OP Values

Table 4-116

MSGTYPE Values

Table 4-117

MUX_TYPE Values

Table 4-118

NOTIF_CODE Values

Table 4-119

OCN_BLSR Values

Table 4-120

OCN_MONTYPE Values

Table 4-121

OCN_TYPE Values

Table 4-122

ON_OFF Values

Table 4-123

OPTICAL_BAND Values

Table 4-124

OPTICAL_LINK_TYPE Values

Table 4-125

OPTICAL_MODE Values

Table 4-126

OPTICAL_PORT_TYPE Values

Table 4-127

OPTICAL_WLEN Values

Table 4-128

OPTICS Values

4-68
4-69

4-69
4-69

4-69
4-70

4-70

4-71
4-71

4-72
4-72
4-73

4-77
4-77
4-78
4-78
4-78
4-79

4-79
4-79
4-80
4-80

4-80
4-81

4-81

4-82

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

xxiv

March 2003

Tables

Table 4-129

PAYLOAD Values

Table 4-130

PM_MODE Values

4-83

Table 4-131

PM_STATE Values

4-83

Table 4-132

PRIVILEGE Values

Table 4-133

PRODUCT_TYPE Values

Table 4-134

PROTECTION_GROUP Values

Table 4-135

PROTTYPE Values

Table 4-136

PST Values

Table 4-137

RDIRN_MODE Values

Table 4-138

REVERTIVE_TIME Values

Table 4-139

SD_BER Values

Table 4-140

SDCC_MODE Values

Table 4-141

SERV_EFF Values

Table 4-142

SF_BER Values

Table 4-143

SIDE Values

Table 4-144

SST Values

Table 4-145

STATUS Values

Table 4-146

STM_TYPE Values

Table 4-147

STS_MONTYPE Values

Table 4-148

STS_PATH Values

Table 4-149

SW Values

Table 4-150

SWITCH_TYPE Values

Table 4-151

SYNC_CLOCK_REF_QUALITY_LEVEL Values

Table 4-152

SYNC_GENERATION Values

Table 4-153

SYNC_QUALITY_LEVEL Values

Table 4-154

SYNC_GENERATION Values

Table 4-155

SYS_TYPE Values

Table 4-156

T1_MONTYPE Values

4-91

Table 4-157

T3_MONTYPE Values

4-92

Table 4-158

TACC_MODE Values

4-92

Table 4-159

TERM_MODE Values

4-93

Table 4-160

TIMING_MODE Values

Table 4-161

TMPER Values

Table 4-162

TRANS_MODE Values

Table 4-163

TRCFORMAT Values

4-83

4-83
4-84
4-84

4-84

4-85
4-85
4-85

4-85
4-86

4-86
4-86

4-87
4-87
4-87
4-87
4-88

4-88

4-88
4-89
4-89

4-90
4-90
4-91

4-91

4-93

4-93
4-94
4-94

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

xxv

Tables

Table 4-164

TRCLEVEL Values

4-94

Table 4-165

TRCMODE Values

4-94

Table 4-166

TX_RSLT Values

Table 4-167

TX_STATUS Values

Table 4-168

TX_TYPE Values

Table 4-169

UCP_ADM_STATE Values

4-96

Table 4-170

UCP_CC_TUN_MD Values

4-96

Table 4-171

UCP_CKT_STATE Values

4-96

Table 4-172

UCP_CRC_MODE Values

4-97

Table 4-173

UCP_IPCC_TYPE Values

4-97

Table 4-174

UCP_TNA_TYPE Values

4-97

Table 4-175

UNI_BI Values

Table 4-176

UP_DOWN Values

Table 4-177

VALIDITY Values

Table 4-178

VOA_CNTR_MODE Values

Table 4-179

VT1_5_MONTYPE Values

Table 4-180

WDM Values

Table 4-181

WLEN_MODE Values

Table 6-1

TXP_MR_10G (Transponder) and MXP_2.5G_10G (Muxponder) Card PMs

Table 6-2

EC1 Card PMs

Table 6-3

DS1(N) Card PMs

6-2

Table 6-4

DS3(N) Card PMs

6-2

Table 6-5

DS3(N)-3E Card PMs

6-2

Table 6-6

DS3XM-6 Card PMs

6-3

Table 6-7

OC3 Card PMs

Table 6-8

OC12, OC48, OC192 Card PMs

Table 6-9

PM Parameters by Line Type

Table 7-1

AEP

7-2

Table 7-2

AIP

7-2

Table 7-3

BITS

Table 7-4

BP

7-3

Table 7-5

CC

7-3

Table 7-6

CKT

7-4

Table 7-7

DS1

7-4

Table 7-8

DS3

7-4

4-95
4-95

4-95

4-97
4-98
4-98
4-98
4-98

4-99
4-99
6-1

6-2

6-3
6-4
6-5

7-3

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

xxvi

March 2003

Tables

Table 7-9

DWDM Client

7-5

Table 7-10

DWDM Trunk

7-6

Table 7-11

ECN

7-9

Table 7-12

ENV

7-9

Table 7-13

EQPT

Table 7-14

ETHER

Table 7-15

EXTSYNCH

Table 7-16

FAN

Table 7-17

FUDC

Table 7-18

HDGE (G1000)

Table 7-19

ML1000

7-14

Table 7-20

MSUDC

7-14

Table 7-21

NBR

Table 7-22

NE

Table 7-23

NERING

Table 7-24

NESYNCH

Table 7-25

OCN

Table 7-26

STSMON

7-18

Table 7-27

STSTERM

7-18

Table 7-28

VT-MON

7-19

Table 7-29

VT-TERM

7-19

Table 7-30

Errors listed by Error Code

7-10
7-12
7-12

7-12
7-13
7-13

7-14
7-15
7-16
7-16

7-16

7-20

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

xxvii

Tables

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

xxviii

March 2003

About This Guide
This section explains the objectives, intended audience, and organization of this publication and
describes the conventions that convey instructions and other information.
This section provides the following information:
•

Document Objectives

•

Audience

•

Document Organization

•

Related Documentation

•

Document Conventions

•

Where to Find Safety and Warning Information

•

Obtaining Documentation

•

Obtaining Technical Assistance

•

Obtaining Additional Publications and Information

Document Objectives
This guide explains the use of Transaction Language 1 (TL1) for Cisco ONS 15454 and ONS 15327
systems. Use this guide in conjunction with the appropriate publications listed in the Related
Documentation section.

Audience
To use this publication, you should be familiar with Cisco or equivalent optical transmission hardware
and cabling, telecommunications hardware and cabling, electronic circuitry and wiring practices, and
preferably have experience as a telecommunications technician.

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

xxix

About This Guide
Document Organization

Document Organization
This Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, R4.0 is organized into the
following chapters:
•

Chapter 1, “Getting Started” explains how to gain access to TL1, command syntax, autonomous
messages, provision a DS3E card in CTC using TL1, CTC interoperability, security level privileges
associated with each command, command completion behavior, test access configurations, PCA
provisioning and FTP software download.

•

Chapter 2, “TL1 Gateway” describes the TL1 Gateway and provides procedures and examples for
implementing TL1 Gateway on a four node ring.

•

Chapter 3, “TL1 Command Descriptions” lists TL1 commands by category and then lists each
command and autonomous message supported by the ONS 15454 and the ONS 15327.

•

Chapter 4, “TL1 Command Components” describes the components of TL1 commands including,
default values, access identifiers (AIDs), and parameter types.

•

Chapter 5, “Ring Provisioning” provides sample procedures for setting up STS or VT circuits over
existing unidirectional path switched ring (UPSR) and bidirectional line switch ring (BLSR)
configurations.

•

Chapter 6, “TL1 Performance Monitoring” provides TL1 performance monitoring (PM) information
and scheduled PM report provisioning.

•

Chapter 7, “TL1 Alarms and Errors” lists TL1 alarms and errors supported by the ONS 15454 and
the ONS 15327 including descriptions and severity.

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

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

xxx

March 2003

About This Guide
Document Conventions

Document Conventions
This publication uses the following conventions:
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.

>

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.

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.

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

xxxi

About This Guide
Where to Find Safety and Warning Information

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

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

xxxii

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

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

xxxiii

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.

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

xxxiv

March 2003

About This Guide
Obtaining Additional Publications and Information

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

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

xxxv

About This Guide
Obtaining Additional Publications and Information

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

xxxvi

March 2003

C H A P T E R

1

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

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

1-1

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:[]::::; and press Enter.

Note

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

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

1-2

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:[]::; 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   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:[]::::;

Note
Step 4

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

Type the Cancel User command to close a TL1 session:
CANC-USER:[]::;

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

1-3

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:[]::::;

Note
Step 5

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

Type the Cancel User command to close a TL1 session:
CANC-USER:[]::;

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

1-4

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 .

•

[ ] enclose an optional symbol, for example [].

•

“ ” 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.

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

1-5

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

SVT197 1999-04-08 18:26:02
A 100.100 REPT ALM BITS
BITS-2:
CL,LOS,SA,,,,:Loss of Signal
/* Loss of Signal*/

Alarm
Code

Access
Identifier

Level

(ATAG)
Number In Messaging
Sequence

Condition

Text
Description
String

Time

Date

Service Affecting/
Non Service
Affecting

40898

(TID)
Target or
Node ID

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

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

1-6

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

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-*-*

X

X

X

RLS-*-*

X

X

X

RMV-*-*

X

X

X

RST-*-*

X

X

X

SW-*-*

X

X

X

ACT-*-*

X

X

X

X

ALW-*-*

X

X

X

X

CANC-*-*

X

X

X

X

ED-PID

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

INH-*-*
REPT * *

1

RTRV-*-*

Provisioning

Maintenance

Retrieve

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

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

1-7

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.
Table 1-2

Security Default Time Outs

Security Level

Default Timeouts

Retrieve

Unlimited

Maintenance

60 minutes

Provisioning

30 minutes

Superuser

15 minutes

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.

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

1-8

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:[]:::::[PEERID=,]

[TERMMODE=,][PAYLOAD=,][PWL=];
– RTRV-DWDM:[]::;

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:[]:::::[PEERID=,]

[TERMMODE=,][PAYLOAD=,][PWL=];
– RTRV-DWDM:[]::;

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:[]:::::[PEERID=,]

[TERMMODE=,][PAYLOAD=,][PWL=];
– RTRV-DWDM:[]::;

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

1-9

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:[]:::::[SFBER=,][SDBER=,]

[ALSMODE=,][ALSRCINT=,][ALSRCPW=,]
[COMM=,][MACADDR=,][SYNCMSG=,]
[SENDDUS=,][RLASER=,][SOAK=]:[],[];
– ED-OCH:[]:::::[RDIRN=,][EXPWLEN=,]

[VOAATTN=,][VOAPWR=,][CALOPWR=,]
[SFBER=,][SDBER=,][ALSMODE=,]
[ALSRCINT=,][ALSRCPW=,][COMM=,]
[GCCRATE=,][OSFBER=,][OSDBER=,]
[DWRAP=,][FEC=,][MACADDR=,]
[SYNCMSG=,][SENDDUS=,][RLASER=,]
[SOAK=]:[],[];
– RTRV-CLNT:[]::;
– RTRV-OCH:[]::;

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.

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

1-10

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:[]:::::[SFBER=,][SDBER=,]

[ALSMODE=,][ALSRCINT=,][ALSRCPW=,]
[COMM=,][MACADDR=,][SYNCMSG=,]
[SENDDUS=,][RLASER=,][SOAK=]:[],[];
– ED-OCH:[]:::::[RDIRN=,][EXPWLEN=,]

[VOAATTN=,][VOAPWR=,][CALOPWR=,]
[SFBER=,][SDBER=,][ALSMODE=,]
[ALSRCINT=,][ALSRCPW=,][COMM=,]
[GCCRATE=,][OSFBER=,][OSDBER=,]
[DWRAP=,][FEC=,][MACADDR=,]
[SYNCMSG=,][SENDDUS=,][RLASER=,]
[SOAK=]:[],[];
– RTRV-CLNT:[]::;
– RTRV-OCH:[]::;

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:[]:::::[SFBER=,][SDBER=,]

[ALSMODE=,][ALSRCINT=,][ALSRCPW=,]
[COMM=,][MACADDR=,][SYNCMSG=,]
[SENDDUS=,][RLASER=,][SOAK=]:[],[];
– ED-OCH:[]:::::[RDIRN=,][EXPWLEN=,]

[VOAATTN=,][VOAPWR=,][CALOPWR=,]
[SFBER=,][SDBER=,][ALSMODE=,]
[ALSRCINT=,][ALSRCPW=,][COMM=,]
[GCCRATE=,][OSFBER=,][OSDBER=,]
[DWRAP=,][FEC=,][MACADDR=,]
[SYNCMSG=,][SENDDUS=,][RLASER=,]
[SOAK=]:[],[];
– RTRV-CLNT:[]::;
– RTRV-OCH:[]::;

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.

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

1-11

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:[]:::::[SFBER=,][SDBER=,]

[ALSMODE=,][ALSRCINT=,][ALSRCPW=,]
[COMM=,][MACADDR=,][SYNCMSG=,]
[SENDDUS=,][RLASER=,][SOAK=]:[],[];
– ED-OCH:[]:::::[RDIRN=,][EXPWLEN=,]

[VOAATTN=,][VOAPWR=,][CALOPWR=,]
[SFBER=,][SDBER=,][ALSMODE=,]
[ALSRCINT=,][ALSRCPW=,][COMM=,]
[GCCRATE=,][OSFBER=,][OSDBER=,]
[DWRAP=,][FEC=,][MACADDR=,]
[SYNCMSG=,][SENDDUS=,][RLASER=,]
[SOAK=]:[],[];
– RTRV-CLNT:[]::;
– RTRV-OCH:[]::;

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:[]:::::[EXPTRC=,][TRC=,]

[TRCMODE=,][TRCLEVEL=,]
[TRCFORMAT=][:];
– ED-TRC-OCH:[]:::::[EXPTRC=,][TRC=,]

[TRCMODE=,][TRCLEVEL=,]
[TRCFORMAT=][:];
– RTRV-TRC-CLNT:[]::::[],[][::];
– RTRV-TRC-OCH:[]::::[],[][::];

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

1-12

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:[]::::,,

[],,[];
– SET-TH-OCH:[]::::,,[],,[];
– RTRV-TH-CLNT:[]::::[],[],[::];
– RTRV-TH-OCH:[]::::[],[],[::];

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:[]:::::[PEERID=,]

[TERMMODE=,][PAYLOAD=,][PWL=];
– RTRV-DWDM:[]::;

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:[]:,:

:::[PROTTYPE=,][PROTID=,][RVRTV=,]
[RVTM=,][PSDIRN=][:];

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

1-13

Chapter 1

Getting Started

CTC Interoperability

– ED-FFP-CLNT:[]:::::[PROTID=,][RVRTV=,]

[RVTM=,][PSDIRN=][:];
– RTRV-FFP-CLNT:[]::[::::];

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

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

1-14

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.

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

1-15

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:[]:STS-9-ALL:; 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

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

1-16

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

E
AID

A

F
"Mapped"
AID

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

61106

B

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

1-17

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-) is used to change an existing port, STS, or VT to a TAP.
Input Format:
ED-(STS_PATH):[]:::::[SFBER=,][SDBER=,]
[RVRTV=,][RVTM=,][SWPDIP=,][EXPTRC=,]
[TRC=,][TRCMODE=,][TACC=]:[],[];
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.

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

1-18

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.

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

1-19

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.

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

1-20

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-) 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):[]:::::MD=;
Connect the port/STS/VT defined by  to the port/STS/VT defined by the  number. The
mode of test access to the circuit/cross-connect is specified by . 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

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

1-21

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
;

1.10.4 Change Access Mode
The CHG-ACCMD command (CHG-ACCMD-) is used to change the access mode.
Input Format: CHG-ACCMD-(T1, T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,
VT1, DS1):[]::::;
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  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:[]::;

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

1-22

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-:[<[TID>]:::::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:[]::;
 indicates the assigned numeric number for the AID being used as a test access point. The 
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.  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:
•

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

•

 is the STS or VT AID that was designated as a test access point and assigned to the
TAP;  is from the “ALL” section on page 4-10

•

 is the STS or VT AID that was designated as a test access point and assigned to the
TAP+1;  is from the “ALL” section on page 4-10

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

1-23

Chapter 1

Getting Started

Test Access

•

 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

•

 indicates the E side STS or VT AID of a circuit connected to the TACC or under test;
 is from the “ALL” section on page 4-10 and is optional

•

 indicates the F side STS or VT AID of a circuit connected to the TACC or under test;
 is from the “ALL” section on page 4-10

1.10.8 Test Access Configurations
Figure 1-3

Single node view (Node 1)

E

RTU
Test Set

71716

F

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

This command changes STS1 and STS2 on Slot 1 to a TAP. The  is 90. Sets the TAP number
to 1.
Example 1-13 CONN-TACC-STS1:::91::TAP-1:MONE

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

Note

The connection made in the CONN-TACC command can use MONE to connect to the F side .
The  provided designates the E side and the other automatically becomes the F side. For example,
if an  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
 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).

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

1-24

March 2003

Chapter 1

Getting Started
Test Access

Figure 1-4

Multi-node view (MONE example)

A
E

F

NE1
B

OC12
G

OC12

I
H

RTU

NE3

71717

C

J
NE2
D

On NE3:
Example 1-14 ENT-CRS-STS1:::100::2WAY; A connection, not a TAP. CTAG is 100.
ENT-CRS-STS1:::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;
number assigned is 4.

Creates TAP with STS-1-1 and STS-1-2 through NE1. TAP

Example 1-16 CONN-TACC-STS1:::102::4:

Note

Connects TAP #4 to the circuit.

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

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

1-25

Chapter 1

Getting Started

Test Access

1.10.9 Test Access Mode Definitions
The following diagrams show what the different test access modes  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

E
AID

F

A

"Mapped"
AID

B

61106

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

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

E
AID

A

F
"Mapped"
AID

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

61107

B

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

1-26

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

E
AID

F

A

"Mapped"
AID

B

Note

61108

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

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

E
AID

A

F
"Mapped"
AID

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

61109

B

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

1-27

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

E
AID

F

A

"Mapped"
AID

BB

B

61110

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

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

E
AID

A

F
BB

"Mapped"
AID

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

61111

B

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

1-28

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

E
AID

F

A

"Mapped"
AID

B

61112

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

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

AID

F

A
B

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

BB

"Mapped"
AID

61113

E

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

1-29

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

E
AID

A

F
BB

"Mapped"
AID

B

61114

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

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

E
AID

A

F
"Mapped"
AID

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

61115

B

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

1-30

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

E
AID

F

A

"Mapped"
AID

B

61116

Dual-FAD TAP
(2 times the bandwidth
of the circuit accessed)

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

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  provided in the CONN-TACC command designates the E side and the other automatically
becomes the F side.

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

1-31

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
 specified is the source AID, the direction is designated as From E in the above table. If the
 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  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  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.

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

1-32

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  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
1-way (from E)

MONF

MONEF

SPLTE

SPLTF

SPLTEF

LOOPE

LOOPF

X

1-way (from F)

SPLTA

SPLTB

X
X

2-way

X

X

X

X

X

X

X

X

X

X

UPSR

X

X

X

X

X

X

X

X

X

X

UPSR_HEAD
(from E)

X

UPSR_HEAD
(from F)
UPSR_DROP
UPSR_DC
UPSR_EN
(from E)

X
X

X

X

X

X

UPSR_DROP
UPSR_DC
UPSR_EN
(from F)
UPSR_UPSR

X

Unmapped AID

X

X

X

X

X
X

X

X

X

X

X

X

X

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

1-33

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-:[]:,:::[][::];
::={STS_PATH | VT1}
[]::={1WAY, 1WAYDC, 1WAYEN, 2WAY, 1WAYPCA, 2WAYPCA}, it defaults to 2WAY.
{STS_PATH}::={STS1 | STS3C | STS6C | STS9C | STS12C | STS24C | STS48C | STS192C}

STS= all the STS bandwidth cross-connections.
VT1=VT1_5 cross-connection.

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

1-34

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 [] of this cross-connection provisioning command is either 1WAYPCA or 2WAYPCA, and
the NONE of both  and  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-[]:[]::[::::];::={STS_PATH | VT1 | STS }

If PATH is STS, it will retrieve all the STS cross-connections based on the queried AIDs.
={FacilityAIDs, STSAIDs, VTAIDs, ALL}
Output format of the PCA STSp cross-connection retrieval command:
Example 1-27 “,:2WAYPCA,STS3C”

Output format of the PCA VT cross-connection retrieval command:
Example 1-28 “,: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:[]:[]:::TYPE=,[SRC=]:

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

1-35

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

•

 is the file transfer protocol; valid values can be found in the “TX_TYPE” section on
page 4-95

•

 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 .

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:[]::[::]:

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

1-36

March 2003

Chapter 1

Getting Started
FTP Software Download

where:
•

 indicates memory switch action during the software upgrade.
 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
“,,[],[]”
;

where:
•

 indicates the transferred file path name and is a string

•

 indicates the file transferred status: Start, IP (in progress), or COMPLD

•

 indicates the file transferred result: success or failure.  is optional

•

 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;

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

1-37

Chapter 1

Getting Started

FTP Software Download

Output example:
Example 1-33

Step 5

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\””
;

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::RFILEPKG: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

Step 7

If the download is successful the REPT EVT FXFR message will report an active start:
Example 1-36

Step 8

DEV208 1970-01-10 11:52:02
A 2816.2816 REPT EVT EQPT
“SLOT-11:SFTWDOWN-FAIL,TC,,,,,,,:\”SOFTWARE DOWNLOAD FAILED\”,TCC
;

DEV208 1970-01-10 11:52:15
A 2818,2818 REPT EVT FXFR
“ACTIVE START”
;

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.

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

1-38

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.

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

1-39

Chapter 1

Getting Started

FTP Software Download

Example 1-41

Step 12

DEV208 1970-01-10 12:01:16
A 2825,2825 REPT EVT FXFR
“ACTIVE,COMPLD,SUCCESS”
;

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.

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

1-40

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;

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

1-41

Chapter 1

Getting Started

FTP Software Download

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

1-42

March 2003

C H A P T E R

2

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.

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

2-1

Chapter 2

TL1 Gateway

Gateway Network Element Topology

Figure 2-1

Example of a GNE topology

OSS

Single connection

TLI Gateway node

Command/Response
Number of connections

55276

Autonomous messages

Node 1

Node 2

Node 3

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

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

2-2

March 2003

Chapter 2

TL1 Gateway
Gateway Network Element Topology

Table 2-2

Note

Examples of a Single GNE Topology Showing How the GNE/ENE Resources can be
Allocated

Number of GNE Communication Sessions

Maximum Number of ENEs

1

31

2

62

3

93

4

96

Number of GNE Communication Sessions

Number of ENEs

1

16

2

32

3

48

4

64

5

80

6

96

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.

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

2-3

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

Node 0

Node 3

55274

Node 2

Node 1

Figure 2-3

Four-node ring with TL1 Gateway

GNE

TCP/IP
GNE Session

DCC Channel

ENE 3

ENE 1

55275

INE 2

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

2-4

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.

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

2-5

Chapter 2

TL1 Gateway

Implementing TL1 Gateway

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

2-6

March 2003

C H A P T E R

3

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-
REPT EVT RING
RTRV-BLSR
RTRV-COND-RING
RTRV-TRC-

Cross Connections

DLT-CRS-
DLT-CRS-VT1
ED-CRS-
ED-CRS-VT1
ENT-CRS-
ENT-CRS-VT1
RTRV-CRS
RTRV-CRS-
RTRV-CRS-VT1

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

3-1

Chapter 3

TL1 Command Descriptions

TL1 Commands by Category

Table 3-1

TL1 Commands by Category (continued)

Category

Command or Autonomous Message

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

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

3-2

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Category

Table 3-1

TL1 Commands by Category (continued)

Category

Command or Autonomous Message

Fault

REPT ALM 
REPT ALM COM
REPT ALM RING
REPT EVT 
REPT EVT COM
RTRV-ALM-
RTRV-ALM-ALL
RTRV-ALM-RING
RTRV-COND-
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-
REPT PM 
RTRV-PM-
RTRV-PMMODE-
RTRV-PMSCHED-
RTRV-PMSCHED-ALL
RTRV-TH-
SCHED-PMREPT-
SET-PMMODE-
SET-TH-

Ports

ED-
ED-DS1
ED-EC1
ED-G1000
ED-T1
ED-T3
INIT-REG-G1000
RMV-
RST-
RTRV-
RTRV-DS1
RTRV-EC1
RTRV-FSTE
RTRV-G1000
RTRV-GIGE
RTRV-POS
RTRV-T1
RTRV-T3

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

3-3

Chapter 3

TL1 Command Descriptions

TL1 Commands by Category

Table 3-1

TL1 Commands by Category (continued)

Category

Command or Autonomous Message

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-
ED-FFP-
ENT-FFP-
OPR-PROTNSW-
RLS-PROTNSW-
RTRV-FFP-
RTRV-PROTNSW-

Software Download

APPLY
COPY-RFILE
REPT EVT FXFR

STS and VT Paths

ED-
ED-VT1
RTRV-
RTRV-PTHTRC-
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

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

3-4

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Category

Table 3-1

TL1 Commands by Category (continued)

Category

Command or Autonomous Message

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-
CONN-TACC-
DISC-TACC
RTRV-TACC

Testing

OPR-LPBK-
RLS-LPBK-

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-
OPR-PROTNSW-VT1
REPT SW
RLS-PROTNSW-
RLS-PROTNSW-VT1
RTRV-PROTNSW-
RTRV-PROTNSW-VT1

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

3-5

Chapter 3

TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

3.2 TL1 Commands by Card (ONS 15454)
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
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

Table 3-2

ACT-USER
ALW-MSG-ALL
ALW-MSG-DBCHG
ALW-PMREPT-ALL
ALW-SWDX-EQPT
ALW-SWTOPROTN-EQPT

X X X X X X X X

ALW-SWTOWKG-EQPT

X X X X X X X X

APPLY

X

X X

X

X

CANC
CANC-USER
CHG-ACCMD-

X X X X X X X X X X X X X X X

CONN-TACC-

X X X X X X X X X X X X X X X
X X

COPY-IOSCFG

X

COPY-RFILE

X

X X X X X X X X X X X X X X X

DISC-TACC

X X X X X

DLT-BLSR
DLT-CRS-VT1

X

X X X

X X X X X X X X

DLT-CRS-

X X X X X X X X X X X X X X X X X X

DLT-EQPT

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X X X X X X X

DLT-FFP-

X X

DLT-FFP-CLNT

X X X X X X X

DLT-UCP-CC
DLT-UCP-IF
DLT-UCP-NBR
DLT-USER-SECU

X

ED-BITS

X X X X X X X

ED-BLSR
ED-CRS-

X X X X X X X X X X X X X X X X X X
X X X X X X X X

ED-CRS-VT1

X X

ED-CLNT
ED-DAT

X

ED-DS1

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

3-6

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Card (ONS 15454)

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
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

Table 3-2

X X

ED-DWDM
ED-EC1

X

ED-EQPT

X X X X X X X X
X X X X X X X

ED-FFP-

X X

ED-FFP-CLNT
ED-G1000

X

ED-NE-GEN

X

ED-NE-SYNCN

X
X X

ED-OCH
ED-PID

X

ED-SYNCN
ED-T1

X

X X
X X X X X

ED-T3
ED-TRC-CLNT

X X

ED-TRC-OCH

X X

ED-UCP-CC

X X X X X X X

ED-UCP-IF

X X X X X X X

ED-UCP-NBR
ED-UCP-NODE
ED-USER-SECU
ED-VT1
ED-
ED-
ENT-BLSR
ENT-CRS-VT1

X X X

X X X X X X X X
X X X X X X X

X X X X X X X X X X X X X X X X X X
X X X X X
X X X X X X X X

ENT-CRS-

X X X X X X X X X X X X X X X X X X

ENT-EQPT

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

ENT-FFP-

X X X X X X X

ENT-FFP-CLNT

X X

ENT-UCP-CC

X X X X X X X

ENT-UCP IF

X X X X X X X

ENT-UCP-NBR
ENT-USER-SECU
EX-SW-

X X X X X X

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

3-7

Chapter 3

TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

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
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

Table 3-2

INH-MSG-ALL
INH-MSG-DBCHG

X

INH-MSG-SECU

X

ING-PMREPT-ALL

X

INH-SWDX-EQPT
INH-SWTOPROTN-EQPT

X X X X X X X X

INH-SWTOWKG-EQPT

X X X X X X X X

INIT-REG-

X X X X X X X X X X X X X X X

INIT-REG-G1000

X X

X
X X

INIT-REG-CLNT

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

INIT-SYS
OPR-ACO-ALL

X X

OPR-EXT-CONT

X X

OPR-LPBK-

X

X X X X X X X X X X X X X X X

OPR-PROTNSW-VT1

X X X X X X X

OPR-PROTNSW-

X X X X X X X

OPR-PROTNSW-

X X X X X X X

X X

X X

OPR-PROTNSW-CLNT

X X X X X X X

OPR-SYNCNSW

X
X

REPT ALM BITS
REPT ALM COM
REPT ALM ENV
REPT ALM EQPT

X X
X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

REPT ALM RING

X X X X X

REPT ALM SYNCN
REPT ALM 

X X X X X X X

X

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

REPT ALM UCP
REPT DBCHG

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

REPT EVT BITS

X

REPT EVT COM

X X

REPT EVT ENV

X

REPT EVT FXFR
REPT EVT EQPT
REPT EVT IOSCFG

X

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X X

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

3-8

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Card (ONS 15454)

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
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

Table 3-2

X X X X X

REPT EVT RING
REPT EVT SECU

X

REPT EVT SESSION

X X X X X X X

REPT EVT SYNCN
REPT EVT 

X

X

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

REPT EVT UCP

X X X X X X X X X X X X X X X

REPT PM 

X X
X

REPT SW

X X
X X

RLS-EXT-CONT
RLS-LPBK-

X

X X X X X X X X X X X X X X X
X X

RLS-PROTNSW-CLNT
RLS-PROTNSW-VT1

X X X X X X X

RLS-PROTNSW-

X X X X X X X

RLS-PROTNSW-

X X X X X X X

RLS-SYNCNSW

X X X X X X X

X

RMV-

X

X X X X X X X X X X X X X X X

X X

RST-

X

X X X X X X X X X X X X X X X

X X

RTRV-ALM-ALL

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X

RTRV-ALM-BITS

X X

RTRV-ALM-ENV
RTRV-ALM-EQPT
RTRV-ALM-RING
RTRV-ALM-SYNCN
RTRV-ALM-

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X X X X X
X X X X X X X

X

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

RTRV-ALM-UCP
RTRV-ATTR-CONT

X X

RTRV-ATTR-ENV

X X

RTRV-BITS
RTRV-BLSR

X
X X X X X

RTRV-CKT-ORIG
RTRV-CKT-TERM

X X

RTRV-CLNT
RTRV-COND-ALL
RTRV-COND-BITS

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X

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

3-9

Chapter 3

TL1 Command Descriptions

TL1 Commands by Card (ONS 15454)

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
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

Table 3-2

X X

RTRV-COND-ENV
RTRV-COND-EQPT

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X

RTRV-COND-SYNCN
RTRV-COND-

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X
X X X X X

RTRV-COND-RING
RTRV-COND-UCP

X X X X X X X X X X X X X X X X X X

RTRV-CRS

X X X

RTRV-CRS-VT1
RTRV-CRS-

X X X X X X X X

X X X X X X X X X X X X X X X X X X
X X

RTRV-DWMD

X

RTRV-EC1

X

RTRV-DS1

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

RTRV-EQPT

X X

RTRV-EXT-CONT
RTRV-FFP-CLNT

X X X X X X X

RTRV-FFP-

X X

RTRV-FSTE

X

RTRV-G1000

X X

RTRV-GIGE
RTRV-HDR
RTRV-INV

X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X

RTRV-LOG
RTRV-MAP-NETWORK
RTRV-NE-GEN

X

RTRV-NE-IPMAP

X X X X X X X

RTRV-NE-SYNCN

X

RTRV-OCH

X X

RTRV-PM-

X X X X X X X X X X X X X X X

RTRV-PMMODE-

X X X X X X X X X X X X X X X

RTRV-PMSCHED-

X X X X X X X X X X X X X X X

X X
X X
X X

RTRV-PMSCHED-ALL

X X

RTRV-POS

X X X X X X X

RTRV-PROTNSW-
RTRV-PROTNSW-

X X X

X X X X X X X

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

3-10

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Card (ONS 15454)

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
XC
TCC2
XCVT
XC192
XCVXL
AICI
AIC
MXP
TXP

Table 3-2

X X

RTRV-PROTNSW-CLNT

X X X X X X X

RTRV-PROTNSW-VT1
RTRV-PTHTRC-

X X X X X X X X X X X X X

X X
X

RTRV-SYNCN
RTRV-TACC
RTRV-T1

X X X X X X X X X X X X X X X
X X
X X X X

RTRV-T3
RTRV-TH-

X

X X X X X X X X X X X X X X X

X X

RTRV-TOD

X X X X X

RTRV-TRC-
RTRV-TRC-CLNT

X X

RTRV-TRC-OCH

X X

RTRV-VT1
RTRV-
RTRV-

X X X

X X X X

X X X

X X X X X X X X
X X X X X X X X X X X X X X X X X X

RTRV-UCP-CC

X X X X X X X X

RTRV-UCP-IF

X X X X X X X X

RTRV-UCP-NBR
RTRV-UCP-NODE
RTRV-USER-SECU
SCHED-PMREPT-

X X X X X X X X X X X X X X X

X X

SET-ATTR-CONT

X X

SET-ATTR-ENV

X X

SET-PMMODE-

X X X X X X X X X X X X X X X

SET-TH-

X X X X X X X X X X X X X X X

X X

SET-TOD
SW-DX-EQPT

X

SW-TOPROTN-EQPT

X X X X X X X X

SW-TOWKG-EQPT

X X X X X X X X

X X

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

3-11

Chapter 3

TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

3.3 TL1 Commands by Card (ONS 15327)
XTC/AIC

XTC/XCVT

G1000-2

XTC

E1000T

E100T

OC48

OC12

OC3

XTC/DS3

TL1 Commands by Card (ONS 15327)

XTC/DS1

Table 3-3

ACT-USER
ALW-MSG-ALL
ALW-MSG-DBCHG
ALW-PMREPT-ALL
ALW-SWDX-EQPT
ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT

X

APPLY
CANC
CANC-USER
CHG-ACCMD-

X

X

X

X

X

CONN-TACC-

X

X

X

X

X

COPY-IOSCFG

X

COPY-RFILE

X

X

X

X

X

X

X

X

X

X

X

DLT-EQPT

X

X

X

DLT-FFP-

X

X

X

DISC-TACC

X

X

DLT-BLSR
DLT-CRS-VT1
DLT-CRS-

X

X

X

X

X

X

DLT-USER-SECU
ED-BITS

X

ED-BLSR
ED-CRS-

X

X

ED-CRS-VT1

X

X

X

X

X

X

X

X

X

X

X

X

ED-DAT
ED-DS1
ED-EC1

X

ED-EQPT
ED-FFP-

X
X

ED-G1000

X

ED-NE-GEN

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

3-12

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Card (ONS 15327)

XTC/AIC

XTC/XCVT

G1000-2

XTC

E1000T

E100T

OC48

OC12

OC3

XTC/DS3

TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

Table 3-3

X

ED-NE-SYNCN
ED-PID

X

ED-SYNCN
ED-T1

X
X

ED-T3
ED-USER-SECU
ED-VT1

X

ED-
ED-

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

ENT-BLSR
ENT-CRS-VT1
ENT-CRS-

X

X

X

X

X

ENT-EQPT

X

X

X

X

X

X

X

X

X

X

ENT-FFP-

X

X
X

X

X

X

X

X

ENT-USER-SECU
EX-SW-
INH-MSG-ALL
INH-MSG-DBCHG

X

INH-MSG-SECU
INH-PMREPT-ALL

X

INH-SWDX-EQPT
INH-SWTOPROTN-EQPT

X

X

INH-SWTOWKG-EQPT

X

X

INIT-REG-

X

X

X

X

X
X

INIT-REG-G1000
INIT-SYS

X

X

X

X

X

X

X

X

X

X

X

OPR-ACO-ALL

X

OPR-EXT-CONT

X

X

X

OPR-PROTNSW-VT1

X

X

X

OPR-PROTNSW-

X

X

X

OPR-PROTNSW-

X

X

X

OPR-SYNCNSW

X

X

X

OPR-LPBK-

REPT ALM BITS

X

X

X

X

X
X

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

3-13

Chapter 3

TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

XTC/AIC

XTC/XCVT

G1000-2

XTC

E1000T

E100T

OC48

OC12

OC3

XTC/DS3

TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

Table 3-3

REPT ALM COM

X

REPT ALM ENV
REPT ALM EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT ALM RING
REPT ALM SYNCN
REP ALM 

X

X

X

X

X

X

X

X

X

X

X

X
X

X

X

X

REPT DBCHG

X

REPT EVT BITS
REPT EVT COM

X

REPT EVT ENV
REPT EVT EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

REPT EVT FXFR

X

REPT EVT RING

X

REPT EVT SECU

X

REPT EVT SESSION
REPT EVT SYNCN

X

X

X

X

REPT EVT 

X

X

X

X

X

X

REPT PM 

X

X

X

X

X

X

X

X

X

REPT SW

X

RLS-EXT-CONT

X

X

X

RLS-PROTNSW-VT1

X

X

X

RLS-PROTNSW-

X

X

X

RLS-PROTNSW-

X

X

X

RLS-SYNCNSW

X

X

X

RLS-LPBK-

X

X

X

X

RMV-

X

X

X

X

X

X

RST-

X

X

X

X

X

X

RTRV-ALM-ALL

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-BITS

X

RTRV-ALM-ENV
RTRV-ALM-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-ALM-RING
RTRV-ALM-SYNCN
RTRV-ALM-

X

X

X
X

X

X

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

3-14

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands by Card (ONS 15327)

XTC/AIC

XTC/XCVT

G1000-2

XTC

E1000T

E100T

OC48

OC12

OC3

XTC/DS3

TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

Table 3-3

RTRV-ATTR-CONT

X

RTRV-ATTR-ENV

X
X

RTRV-BITS
RTRV-BLSR
RTRV-COND-ALL

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-BITS

X

RTRV-COND-ENV
RTRV-COND-EQPT

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-COND-RING

X

RTRV-COND-SYNCN
RTRV-COND-

X

X

X

X

X

RTRV-CRS

X

X

X

X

X

RTRV-CRS-VT1

X

X

X

X

RTRV-CRS-

X

X

X

X

X

X

X

X

X

X

X

X

X

X
X

RTRV-EC1
RTRV-DS1
RTRV-EQPT

X

X

X

X

X

RTRV-EXT-CONT

X

RTRV-FFP-

X

X
X

RTRV-G1000
RTRV-HDR
RTRV-INV

X

X

X

X

X

X

X

X

X

X

X

RTRV-LOG
RTRV-MAP-NETWORK

X

RTRV-NE-GEN

X

RTRV-NE-IPMAP

X

X
X

RTRV-NE-SYNCN
RTRV-PM-

X

RTRV-PMMODE-

X

X

X

X

X

X

X

X

RTRV-PMSCHED-ALL

X

X

X

X

X

RTRV-PMSCHED-

X

X

X

X

X

RTRV-PROTNSW-VT1

X

X

X

RTRV-PROTNSW-

X

X

X

RTRV-PROTNSW-

X

X

X

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

3-15

Chapter 3

TL1 Command Descriptions

TL1 Commands by Card (ONS 15327)

RTRV-PTHTRC-

X

X

X

XTC/AIC

XTC/XCVT

G1000-2

XTC

E1000T

E100T

OC48

OC12

OC3

XTC/DS3

TL1 Commands by Card (ONS 15327) (continued)

XTC/DS1

Table 3-3

X
X

RTRV-SYNCN

X

RTRV-T1

X

RTRV-T3
RTRV-TACC

X

X

X

X

X

RTRV-TH-

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

X

RTRV-TOD
RTRV-TRC-
RTRV-USER-SECU

X

RTRV-VT1
RTRV-
RTRV-

X

X

X

SCHED-PMREPT-
SET-ATTR-CONT

X

SET-ATTR-ENV

X

SET-PMMODE-

X

X

X

X

X

SET-TH-

X

X

X

X

X

SET-TOD

X

SW-DX-EQPT
SW-TOPROTN-EQPT

X

X

SW-TOWKG-EQPT

X

X

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

3-16

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

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

3-17

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

Related
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:[]::::;
where:
•

 is the user identifier;  is any combination of up to 10
alphanumeric characters.  is a string and must not be null

•

 is the user password;  is any combination of up to 10 alphanumeric
characters.  is a string and must not be null

Note

CTC allows  and  of up to 20 characters. The 20 character
CTC-entered  and  are not valid TL1  and 

Input Example

ACT-USER:PETALUMA:TERRI:100::MYPASSWD;

Errors

Errors are listed in Table 7-30 on page 7-20.

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

3-18

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.

Section

ALW-MSG-ALL Description

Category

System

Security

Retrieve

Related
Messages

APPLY
COPY-RFILE
ED-DAT
ED-NE-GEN
ED-NE-SYNCN
INH-MSG-ALL
INIT-SYS
REPT EVT FXFR

Input Format

ALW-MSG-ALL:[]::[::,,];

Input Example

ALW-MSG-ALL:PETALUMA::549;

Errors

Errors are listed in Table 7-30 on page 7-20.

RTRV-HDR
RTRV-INV
RTRV-MAP-NETWORK
RTRV-NE-GEN
RTRV-NE-IPMAP
RTRV-NE-SYNCN
RTRV-TOD
SET-TOD

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-DBCHG Description

Category

Log

Security

Retrieve

Related
Messages

INH-MSG-DBCHG
REPT DBCHG
RTRV-LOG

Input Format

ALW-MSG-DBCHG:[]::[::,,];

Input Example

ALW-MSG-DBCHG:CISCO::123;

Errors

Errors are listed in Table 7-30 on page 7-20.

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

3-19

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
Section

ALW-MSG-SECU Description

Category

Security

Security

Superuser

Related
Messages

ACT-USER
CANC
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU

Input Format

ALW-MSG-SECU:[]::;

Input Example

ALW-MSG-SECU:PETALUMA::123;

Errors

Errors are listed in Table 7-30 on page 7-20.

ENT-USER-SECU
INH-MSG-SECU
REPT EVT SECU
REPT EVT SESSION
RTRV-USER-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-PMREPT-ALL Description

Category

Performance

Security

Retrieve

Related
Messages

INH-PMREPT-ALL
INIT-REG-
REPT PM 
RTRV-PM-
RTRV-PMMODE-
RTRV-PMSCHED-

Input Format

ALW-PMREPT-ALL:[]::;

Input Example

ALW-PMREPT-ALL:CISCONODE::123;

Errors

Errors are listed in Table 7-30 on page 7-20.

RTRV-PMSCHED-ALL
RTRV-TH-
SCHED-PMREPT-
SET-PMMODE-
SET-TH-

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

3-20

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.

Section

ALW-SWDX-EQPT Description

Category

Equipment

Security

Maintenance

Related
Messages

ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
DLT-EQPT
ED-EQPT
ENT-EQPT
INH-SWDX-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT

Input Format

ALW-SWDX-EQPT:[]::[::];

REPT ALM EQPT
REPT EVT EQPT
RTRV-ALM-EQPT
RTRV-COND-EQPT
RTRV-EQPT
SW-DX-EQPT
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

where:
•

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

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

3-21

Chapter 3

TL1 Command Descriptions

TL1 Commands

Notes:
1.

This command only supports one value of the  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

Related
Messages

ALW-SWDX-EQPT
ALW-SWTOWKG-EQPT
DLT-EQPT
ED-EQPT
ENT-EQPT
INH-SWDX-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT

Input Format

ALW-SWTOPROTN-EQPT:[]::[::];

REPT ALM EQPT
REPT EVT EQPT
RTRV-ALM-EQPT
RTRV-COND-EQPT
RTRV-EQPT
SW-DX-EQPT
SW-TORPROTN-EQPT
SW-TOWKG-EQPT

where:
•

 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);  is from the “EQPT” section
on page 4-21

•

 is the direction of the switching. The command only supports one value
of the  parameter - BTH. This parameter defaults to BTH; valid values
for  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.

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

3-22

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

Related
Messages

ALW-SWDX-EQPT
ALW-SWTOPROTN-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

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

3-23

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

ALW-SWTOWKG-EQPT Description (continued)

Input Format

ALW-SWTOWKG-EQPT:[]::[::];
where:
•

 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);  is from the “EQPT”
section on page 4-21

•

 is the direction of the switching. The command only supports one value
of the  parameter - BTH. This parameter defaults to BTH; valid values
for  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.

3.4.9 APPLY: Apply
This command activates or reverts a software load during a software upgrade or downgrade process.
Section

APPLY Description

Category

Software Download

Security

Maintenance

Related
Messages

ALW-MSG-ALL
COPY-RFILE
ED-DAT
ED-NE-GEN
ED-NE-SYNCN
INH-MSG-ALL
INIT-SYS
REPT EVT FXFR

Input Format

APPLY:[]::[::];

RTRV-HDR
RTRV-INV
RTRV-MAP-NETWORK
RTRV-NE-GEN
RTRV-NE-IPMAP
RTRV-NE-SYNCN
RTRV-TOD
SET-TOD

where:
•

 indicates memory switch action during the software
upgrade; valid values for  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.

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

3-24

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

CANC Description

Category

Security

Security

Retrieve

Related
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
“”
;
where:
•

Output
Example

 refers to the user’s identification whose session is terminated due to
timeout;  is any combination of up to 10 alphanumeric characters. 
is a string

TID-000 1998-06-20 14:30:00
A 100.100 CANC
“CISCO15”
;

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.

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

3-25

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

CANC-USER Description

Category

Security

Security

Retrieve

Related
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:[]::;
where:
•

 identifies the user to the system;  is any combination of
up to 10 alphanumeric characters.  is a string

Note

CTC allows  and  of up to 20 characters. The 20 character
CTC-entered  and  are not valid TL1  and 

Input Example

CANC-USER:PETALUMA:TERRI:101;

Errors

Errors are listed in Table 7-30 on page 7-20.

3.4.12 CHG-ACCMD-: 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- 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

CHG-ACCMD- Description

Category

Test Access

Security

Maintenance

Related
Messages

CONN-TACC-
DISC_TACC
RTRV-TACC

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

3-26

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

CHG-ACCMD- Description (continued)

Input Format

CHG-ACCMD-:[]::::;
where:
•

Note
•

 indicates the test access path number selected by the NE. The  is
used to identify all messages between the TSC and NE until the access point is
released. The  number must be an integer with a range of 1 to 999. 
is a string
This command only changes a single TAP at a time.
 indicates the test access mode (SPLTE, SPLTF, LOOPE, AND LOOPF
require an external QRS input signal); valid values for  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.

3.4.13 CONN-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- 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.

Section

CONN-TACC- Description

Category

Test Access

Security

Provisioning

Related
Messages

CHG-ACCMD-
DISC-TACC
RTRV-TACC

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

3-27

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

CONN-TACC- Description (continued)

Input Format

CONN-TACC-:[]:::::MD=;
where:
•

 is an access identifier.  format is the modifier AID format in the
ALL AID list. Only a single AID is supported in this command.  is the
AID from the “ALL” section on page 4-10.  must not be null

•

 indicates the test access path number selected by the NE. The  is
used to identify all messages between the TSC and the NE until the access point
is released. The  number must be an integer with a range of 1 to 999. A
null  defaults to an appropriate  number selected by the NE.
 is an integer and a null value is equivalent to ALL

•

 indicates the test access mode (SPLTE, SPLTF, LOOPE and LOOPF
require an external QRS input signal); valid values for  are shown in the
“TACC_MODE” section on page 4-92.  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
“”
;
where:
•

 indicates the test access path number selected by the NE. The  is
used to identify all messages between the TSC and NE until the access point is
released. The  number must be an integer with a range of 1 - 999. A null
 defaults to an appropriate  number selected by the NE.  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.

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

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

3-28

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 ”. 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:
 is the userid to connect to the computer with the package file
 is the password used to connect to the computer with the package file
 is the IP address of the computer with the package file, DNS lookup of hostnames
is not supported
 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

Related
Messages

REPT EVT IOSCFG

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

3-29

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

COPY-IOSCFG Description (continued)

Input Format

COPY-IOSCFG:[]::::SRC=,DEST=;
where:
•

 specifies the slot number of the card where the IOS configuration file
belongs and is from the AID “EQPT” section on page 4-21

•

 specifies where the IOS config file is copied from and is a string

•

 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.

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.

Section

COPY-RFILE Description

Category

Software Download

Security

Superuser

Related
Messages

APPLY
REPT EVT FXFR

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

3-30

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

COPY-RFILE Description (continued)

Input Format

COPY-RFILE:[]:[]:::TYPE=,
[SRC=,][DEST=];
where:
•

 is the type of file being transferred;  is the AID from the
“RFILE” section on page 4-24

•

 is the file transfer protocol; valid values for  are
shown in the “TX_TYPE” section on page 4-95

•

 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:
–  is the userid to connect to the computer with the package file
–  is the password used to connect to the computer with

the package file
–  is the IP address of the computer with the package file,

DNS lookup of hostnames is not supported
–  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
 is a string.

•

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

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

3-31

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

Section

DISC-TACC Description

Category

Test Access

Security

Provisioning

Related
Messages

CHG-ACCMD-
CONN-TACC-
RTRV-TACC

Input Format

DISC-TACC:[]::;
where:
•

 indicates the test access path number selected by the NE. The  is
used to identify all messages between the TSC and the NE until the access point
is released. The  number must be an integer with a range of 1- 999. This
command only supports changing a single  number at a time.  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.

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

DLT-BLSR Description

Category

BLSR

Security

Provisioning

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

3-32

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

DLT-BLSR Description (continued)

Related
Messages

ED-BLSR
ENT-BLSR
REPT ALM RING
REPT EVT RING

Input Format

DLT-BLSR:[]::[:::];

RTRV-ALM-RING
RTRV-BLSR
RTRV-COND-RING

where:
•

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

3.4.18 DLT-CRS-: 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}:[]:F1&F2,T1:;
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}:[]:F1,T1&T2:;
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}:[]:F1&F2,T1&T2:;
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.

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

3-33

Chapter 3

TL1 Command Descriptions

TL1 Commands

e. The following command is used to create a UPSR IDRI Cross-Connection:

ENT-CRS-{STS_PATH}:[]:A&B,C&D:::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}:[]:A&B,C:::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- 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- Description

Category

Cross Connections

Security

Provisioning

Related
Messages

DLT-CRS-VT1
ED-CRS-
ED-CRS-VT1
ENT-CRS-
ENT-CRS-VT1
RTRV-CRS
RTRV-CRS-
RTRV-CRS-VT1

Input Format

DLT-CRS-:[]:,:[:::];
where:
•

 is the AID from the “CrossConnectID” section on page 4-14

•

 is the AID from the “CrossConnectID” section on page 4-14

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

3-34

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

DLT-CRS- Description (continued)

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.

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:[]:F1&F2,T1:;
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:[]:F1,T1&T2:;
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:[]:F1&F2,T1&T2:;
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.

Section

DLT-CRS-VT1 Description

Category

Cross Connections

Security

Provisioning

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

3-35

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

DLT-CRS-VT1 Description (continued)

Related
Messages

DLT-CRS-
ED-CRS-
ED-CRS-VT1
ENT-CRS-
ENT-CRS-VT1
RTRV-CRS
RTRV-CRS-
RTRV-CRS-VT1

Input Format

DLT-CRS-VT1:[]:,:[:::];
where:
•

 indicates an identifier at one end of the VT cross-connection;
 is the AID from the “VT1_5” section on page 4-30

•

 indicates an identifier at the other end of the VT cross-connection; 
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.

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.

Section

DLT-EQPT Description

Category

Equipment

Security

Provisioning

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

3-36

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

DLT-EQPT Description (continued)

Related
Messages

ALW-SWDX-EQPT
ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
ED-EQPT
ENT-EQPT
INH-SWDX-EQPT
INH-SWTOPROTN-EQPT
INH-SWTOWKG-EQPT

Input Format

DLT-EQPT:[]::[:::];

REPT ALM EQPT
REPT EVT EQPT
RTRV-ALM-EQPT
RTRV-COND-EQPT
RTRV-EQPT
SW-DX-EQPT
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

where:
•

 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.

3.4.21 DLT-FFP-: 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.

Section

DLT-FFP- Description

Category

SONET Line Protection

Security

Provisioning

Related
Messages

ED-FFP-
ENT-FFP-
EX-SW-
OPR-PROTNSW-
RLS-PROTNSW-
RTRV-FFP-
RTRV-PROTNSW-

Input Format

DLT-FFP-:[]:,:[:::];
where:
•

 identifies the working facility and is the AID from the “FACILITY”
section on page 4-22

•

 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.

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

3-37

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

Related
Messages

DLT-FFP-
ED-CLNT
ED-DWDM
ED-FFP-
ED-FFP-CLNT
ED-OCH
ED-TRC-CLNT
ED-TRC-OCH
ENT-FFP-
ENT-FFP-CLNT
OPR-PROTNSW-
OPR-PROTNSW-CLNT

Input Format

DLT-FFP-CLNT:[]:,:[:::];

RLS-PROTNSW-
RLS-PROTNSW-CLNT
RTRV-CLNT
RTRV-DWDM
RTRV-FFP-
RTRV-FFP-CLNT
RTRV-OCH
RTRV-PROTNSW-
RTRV-PROTNSW-CLNT
RTRV-TRC-CLNT
RTRV-TRC-OCH

where:
•

 identifies the working facility and is the AID from the
“FACILITY” section on page 4-22

•

 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.

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

3-38

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

Related
Messages

DLT-UCP-IF
DLT-UCP-NBR
ED-UCP-CC
ED-UCP-IF
ED-UCP-NBR
ED-UCP-NODE
ENT-UCP-CC
ENT-UCP-IF

Input Format

DLT-UCP-CC:[]::[::::];

ENT-UCP-NBR
REPT ALM UCP
REPT EVT UCP
RTRV-ALM-UCP
RTRV-COND-UCP
RTRV-UCP-CC
RTRV-UCP-IF
RTRV-UCP-NBR

where:
•

 indicates an individual IPCC ID;  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.

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

3-39

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.

Section

DLT-UCP-IF Description

Category

UCP

Security

Provisioning

Related
Messages

DLT-UCP-CC
DLT-UCP-NBR
ED-UCP-CC
ED-UCP-IF
ED-UCP-NBR
ED-UCP-NODE
ENT-UCP-CC
ENT-UCP-IF

Input Format

DLT-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

where:
•

 indicates the interface port index of the data link;  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.

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-NBR Description

Category

UCP

Security

Provisioning

Related
Messages

DLT-UCP-CC
DLT-UCP-IF
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

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

3-40

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

DLT-UCP-NBR Description (continued)

Input Format

DLT-UCP-NBR:[]::[::::];
where:
•

 indicates an individual neighbor AID of the UCP;  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.

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]::[CTAG];
the syntax of  is not checked. The user is deleted if the  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.

Section

DLT-USER-SECU Description

Category

Security

Security

Superuser

Related
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:[]::;
where:
•

 is the user identifier and is a string;  is any combination of up to
10 alphanumeric characters

Note

CTC allows  and  of up to 20 characters. The 20 character
CTC-entered  and  are not valid TL1  and .

Input Example

DLT-USER-SECU:PETALUMA:CISCO15:123;

Errors

Errors are listed in Table 7-30 on page 7-20.

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

3-41

Chapter 3

TL1 Command Descriptions

TL1 Commands

3.4.27 ED-: 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- Description

Category

Ports

Security

Provisioning

Related
Messages

ED-DS1
ED-EC1
ED-G1000
ED-T1
ED-T3
RMV-
RST-
RTRV-
RTRV-DS1
RTRV-EC1
RTRV-G1000
RTRV-T1
RTRV-T3

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

3-42

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

ED- Description (continued)

Input Format

ED-:[]:::::[DCC=,]
[SYNCMSG=,][SENDDUS=,][PJMON=,]
[SFBER=,][SDBER=,][MODE=,][MUX=,]
[SOAK=]:[],[];
where:
•

 is the access identifier from the “FACILITY” section on page 4-22

•

 identifies an OCN port DCC connection; valid values for  are
shown in the “SDCC_MODE” section on page 4-86

•

 indicates if sync status messaging is enabled or disabled on the
facility; valid values for  are shown in the “ON_OFF” section on
page 4-79

•

 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

•

 identifies an OC-N port PJMON with a value range of [0, highest STS
number for the sonet card];  is an integer

•

 identifies an OC-N port SFBER; valid values for  are shown
in the “SF_BER” section on page 4-86

•

 identifies an OC-N port SDBER; valid values for  are
shown in the “SD_BER” section on page 4-85

•

Valid values for  are shown in the “OPTICAL_MODE” section on
page 4-80

•

 BLSR Extension Byte (supported only on OC48AS cards); valid values
for  are shown in the “MUX_TYPE” section on page 4-78

•

 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).  is an integer.

•

 is the primary state; valid values for  are shown in the “PST”
section on page 4-85

•

 is the secondary state; valid values for  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.

3.4.28 ED-: 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.

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

3-43

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

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

3-44

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- Description

Category

STS and VT Paths

Security

Provisioning

Related
Messages

RTRV-
RTRV-PTHTRC-

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

3-45

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

ED- Description (continued)

Input Format

ED-:[]:::::[SFBER=,]
[SDBER=,][RVRTV=,][RVTM=,]
[SWPDIP=,][HOLDOFFTIMER=,]
[EXPTRC=,][TRC=,][TRCMODE=,]
[TACC=]:[],[];
where:
•

 is the access identifier from the “CrossConnectID” section on page 4-14

•

 identifies an STS path SFBER which only applies to UPSR; valid
values for  are shown in the “SF_BER” section on page 4-86

•

 identifies an STS path SDBER which only applies to UPSR; valid
values for  are shown in the “SD_BER” section on page 4-85

•

 identifies a revertive mode which only applies to UPSR; valid values
for  are shown in the “ON_OFF” section on page 4-79

•

 identifies a revertive time which only applies to UPSR; valid values for
 are shown in the “REVERTIVE_TIME” section on page 4-85.
 is not allowed to be set while  is N.

•

 On-Off switch for UPSR Payload Defect Level switching. Valid
values for  are shown in the “ON_OFF” section on page 4-79

•

 Hold-off timer for UPSR DRI;  is an
integer

•

 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);  is a string

•

 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);  is a string

•

 indicates the path trace mode, and defaults to the OFF mode;
valid values for  are shown in the “TRCMODE” section on
page 4-94

•

 is the AID “TACC” section on page 4-29

•

 is the primary state; valid values for  are shown in the “PST”
section on page 4-85

•

 is the secondary state; valid values for  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.

3.4.29 ED-BITS: Edit Building Integrated Timing Supply
This command edits the BITS reference attributes.

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

3-46

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

ED-BITS Description

Category

Synchronization

Security

Provisioning

Related
Messages

ED-NE-SYNCN
ED-SYNCN
OPR-SYNCNSW
REPT ALM BITS
REPT ALM SYNCN
REPT EVT BITS
REPT EVT SYNCN
RLS-SYNCNSW

Input Format

ED-BITS:[]:::::[LINECDE=,][FMT=,]
[LBO=,][SYNCMSG=,][AISTHRSHLD=]
[:];

RTRV-ALM-BITS
RTRV-ALM-SYNCN
RTRV-BITS
RTRV-COND-BITS
RTRV-COND-SYNCN
RTRV-NE-SYNCN
RTRV-SYNCN

where:
•

 is an access identifier from the “BITS” section on page 4-18

•

 is a line code; valid values for  are shown in the
“LINE_CODE” section on page 4-70

•

 is the frame format; valid values for  are shown in the
“FRAME_FORMAT” section on page 4-69

•

 indicates BITS line build out. The default value is 0-133. Valid values
for  are shown in the “BITS_LineBuildOut” section on page 4-42

•

 indicates if this BITS facility supports synchronization status
message;  defaults to (Y) and valid values are shown in the
“ON_OFF” section on page 4-79

•

 is the AIS Threshold. Valid values for 
shown in the “SYNC_CLOCK_REF_QUALITY_LEVEL” section on page 4-89

•

 is a state; valid values for  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.

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

3-47

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

Related
Messages

DLT-BLSR
ENT-BLSR
REPT ALM RING
REPT EVT RING
RTRV-ALM-RING
RTRV-BLSR
RTRV-COND-RING

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

3-48

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section

ED-BLSR Description (continued)

Input Format

ED-BLSR:[]:::::[RINGID=,]
[NODEID=,][RVRTV=,][RVTM=,]
[SRVRTV=,][SRVTM=][:];
where:
•

 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

•

 identifies the BLSR ring ID of the NE. It ranges from 0–9999.
 is an integer

•

 identifies the BLSR node ID of the NE. It ranges from 0–31.
 is an integer

•

 identifies the revertive mode and valid values are shown in the
“ON_OFF” section on page 4-79

•

 identifies the revertive time; valid values for  are shown in
the “REVERTIVE_TIME” section on page 4-85

•

 identifies the span revertive mode for 4F BLSR only and valid
values are shown in the “ON_OFF” section on page 4-79

•

 identifies the span revertive time for 4F BLSR only; valid values for
 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.

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

ED-CLNT Description

Category

DWDM

Security

Provisioning

Related
Messages

RTRV-CLNT
RTRV-ALM-CLNT
RTRV-COND-CLNT
RST-CLNT
RMV-CLNT
ED-DWDM
RTRV-DWDM

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

3-49

Chapter 3

TL1 Command Descriptions

TL1 Commands

Section

ED-CLNT Description (continued)

Input Format

ED-CLNT:[]:::::[SFBER=,][SDBER=,]
[ALSMODE=,][ALSRCINT=,]
[ALSRCPW=,][COMM=,][MACADDR=,]
[SYNCMSG=,][SENDDUS=,][RLASER=]
[SOAK=]:[],[];
where:
•

 is from the “FACILITY” section on page 4-22

•

 identifies the SFBER for the SONET payload; valid values are shown
in the “SF_BER” section on page 4-86

•

 identifies the SDBER for the SONET payload; valid values are shown
in the “SD_BER” section on page 4-85

•

 indicates if the Automatic Laser Shutdown is enabled or disabled;
valid values are shown in the “ALS_MODE” section on page 4-41

•

 indicates the ALS recovery interval. Range is 100–300 seconds;
 is an integer

•

 indicates the ALS recovery pulse width. The range is 2–100
seconds, in increments of 100ms, e.g. 30.1;  is a float

•

 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.

•

 identifies the MAC address for the 10GEthernet payload;
 is a string

•

 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.

•

 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

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

3-50

September 2004

Chapter 3

TL1 Command Descriptions
TL1 Commands

Section
Input Format
(continued)

ED-CLNT Description (continued)
•

 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

•

 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).  is an integer

•

 primary state; valid values are shown in the “PST” section on page 4-85

•

 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.

3.4.32 ED-CRS-:ED CRS (STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS 48C, STS192C)
This command edits the state of an STS cross-connection.
Section

ED-CRS- Description

Category

Cross Connections

Security

Provisioning

Related
Messages

DLT-CRS-
DLT-CRS-VT1
ED-CRS-VT1
ENT-CRS-

Input Format

ED-CRS-:[]:,::::[ADD=,]
[REMOVE=]:[],[];

ENT-CRS-VT1
RTRV-CRS
RTRV-CRS-
RTRV-CRS-VT1

where:
•

 is the AID from the “CrossConnectID” section on page 4-14

•

 is the AID from the “CrossConnectID” section on page 4-14

•

 is the AID from the “CrossConnectID” section on page 4-14

•

 is the AID from the “CrossConnectID” section on page 4-14

•

 primary state; valid values for  are shown in the “PST” section on
page 4-85

•

 secondary state; valid values for  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.

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

3-51

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

Related
Messages

DLT-CRS-
DLT-CRS-VT1
ED-CRS-
ENT-CRS-

Input Format

ED-CRS-VT1:[]:,:::::[ADD=,]
[REMOVE=]:[],[];

ENT-CRS-VT1
RTRV-CRS
RTRV-CRS-
RTRV-CRS-VT1

where:
•

 is the AID from the “VT1_5” section on page 4-30

•

 is the AID from the “VT1_5” section on page 4-30

•

 is the AID from the “VT1_5” section on page 4-30

•

 is the AID from the “VT1_5” section on page 4-30

•

 primary state; valid values for  are shown in the “PST” section on
page 4-85

•

 secondary state; valid values for  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.

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

3-52

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
Section

ED-DAT Description

Category

System

Security

Provisioning

Related
Messages

ALM-MSG-ALL
APPLY
COPY-RFILE
ED-NE-GEN
ED-NE-SYNCN
INH-MSG-ALL
INIT-SYS
REPT EVT FXFR

Input Format

ED-DAT:[]::::[],[
Source Exif Data: 
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Page Mode                       : UseOutlines
Page Count                      : 514
Language                        : 
Producer                        : Acrobat Distiller 6.0 (Windows); modified using iText 2.1.7 by 1T3XT
Access Level                    : Customer,Guest,Partner
Description                     : 
Secondary Concept               : 
Ia Path                         : cisco.com#Products#Cisco Products#Optical Networking#SONET%2FSDH#Cisco ONS 15454 Series Multiservice Provisioning Platforms#Cisco ONS 15454 SONET Multiservice Provisioning Platform (MSPP)
Content Type                    : cisco.com##postSales
Modify Date                     : 2013:11:26 08:24:14-08:00
Entitlement Expression          : contains( "0,1,2,3,4,7" , $profileField[3] )
Title                           : Cisco ONS 15454 and Cisco ONS 15327 TL1 Command Guide, Release 4.0
Creator                         : FrameMaker 5.5.6p145
Doc Type                        : TSD Products Command Reference Book
Country                         : 
Concept                         : Cisco ONS 15454 SONET Multiservice Provisioning Platform (MSPP)
Date                            : 2007-09-14T00:00:00.000-07:00
Create Date                     : 2004:09:29 16:03:13-07:00
Author                          : nleonard
EXIF Metadata provided by EXIF.tools

Navigation menu