009-2003-080 TL1 Manual

ONLINE 7000/9000/11000
TRANSPORT PLATFORM
TL1 ADMINISTRATION AND REFERENCE MANUAL

Software Release 6.0
CIENA Part Number: 009-2003-080 Revision A April 30, 2003
CIENA CONFIDENTIAL AND PROPRIETARY
LEGAL NOTICES THIS DOCUMENT CONTAINS CONFIDENTIAL AND TRADE SECRET INFORMATION OF CIENA CORPORATION AND ITS RECEIPT OR POSSESSION DOES NOT CONVEY ANY RIGHTS TO REPRODUCE OR DISCLOSE ITS CONTENTS, OR TO MANUFACTURE, USE, OR SELL ANYTHING THAT IT MAY DESCRIBE. REPRODUCTION, DISCLOSURE, OR USE IN WHOLE OR IN PART WITHOUT THE SPECIFIC WRITTEN AUTHORIZATION OF CIENA CORPORATION IS STRICTLY FORBIDDEN. EVERY EFFORT HAS BEEN MADE TO ENSURE THAT THE INFORMATION IN THIS DOCUMENT IS COMPLETE AND ACCURATE AT THE TIME OF PRINTING; HOWEVER, THE INFORMATION CONTAINED IN THIS DOCUMENT IS SUBJECT TO CHANGE. Copyright 2003 CIENA Corporation Unpublished All Rights Reserved The material contained in this document is also protected by copyright laws of the United States of America and other countries. It may not be reproduced or distributed in any form by any means, altered in any fashion, or stored in a data base or retrieval system, without express written permission of the CIENA Corporation. Required Customer Information Part 15 of the Federal Communications Commission (FCC): Interference CIENA NOTE: Every effort has been made to ensure that this equipment is designed to comply with the limits for a Class A digital device, as described in the FCC Rules. Equipment limitations are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment, if not installed and used properly, and in accordance with guidelines established by CIENA Corporation may cause interference with other communications equipment. Operation of this equipment in a residential environment may cause interference and is the responsibility of the user to correct the interference at his own expense. Security CIENA cannot be responsible for unauthorized use of equipment and will not make allowance or credit for unauthorized use or access. Contacting CIENA Corporate Headquarters Customer Technical Support/Warranty In North America In Europe In Asia Sales and General Information In North America In Europe In Asia Training and Documentation Training Documentation 877-CIENA-TD (243-6283) or 410-694-8120 877-CIENA-TD (243-6283) or 410-694-8125 E-mail: techtng@ciena.com E-mail: techpubs@ciena.com 1-800-CIENA24 (243-6224) 00800 843 52 322 or +44 181 843 52 322 0120-884-766 410-694-5700 410-694-5700 44 207 389 7100 +81-3-3248-4680 E-mail: sales@ciena.com E-mail: sales@ciena.com E-mail: sales@ciena.com E-mail: sales@ciena.com E-mail: north.america.support@ciena.com E-mail: europe.support@ciena.com 410-694-5700 www.ciena.com
ONLINETM7000/9000/11000
PREFACE
PREFACE
This preface defines the purpose, readership, and organization of the TL1 Administration and Reference Manual in the following sections:
u u u u u u u u u u u u
Objectives Audience Disclaimer Content Organization Related Documents Compliance Information Trademark Acknowledgements Release Notes and Document Updates Document Ordering Information Document Comments Additional Product Information Lab Evaluation and Field Trials
OBJECTIVES
The TL1 Administration and Reference Manual presents the Transaction Language 1 (TL1) message sets for use with the ONLINE 7000/9000/11000 Transport Platform. Use this manual to find details about TL1 message construction, and how to use TL1 messages to accomplish tasks currently supported on the ONLINE 7000/9000/1100 Transport Platform system.
AUDIENCE
This manual is intended for use by network administrators, network engineers, network installers, and network operators responsible for the installation and day-to-day operations of optical networking equipment in a metropolitan area network (MAN).
DISCLAIMER
Portions of this document are intended solely as an outline of methodologies to be followed during the maintenance and upgrade of an ONLINE 7000/9000/1100 Transport Platform. It is not intended as a stepby-step guide or a complete set of all procedures necessary and sufficient to complete an upgrade. While every effort has been made to ensure that this document is complete and accurate at the time of printing, the information that it contains is subject to change. CIENA is not responsible for any additions to or alterations of the original document. Networks vary widely in their configurations, topologies, and traffic conditions. This document is intended as a general guide only. It has not been tested for all possible applications, and it may not be complete or accurate for some situations. Users of this document are urged to heed warnings interspersed throughout the document, such as traffic disruption warnings.
TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
PREFACE CONTENT ORGANIZATION

This manual contains the following chapters and appendices:
u u u u u u u u
ONLINETM7000/9000/11000
CHAPTER 1, TL1 OVERVIEW CHAPTER 2, TL1 AUTONOMOUS MESSAGES CHAPTER 3, TL1 COMMANDS CHAPTER 4, TL1 PARAMETER DEFINITIONS CHAPTER 5, TL1 CONDITION TYPES CHAPTER 6, TL1 MONITOR TYPES CHAPTER 7, GROUP ACCESS PRIVILEGES CHAPTER 8, FACILITIES AND PROTECTION SWITCHING
RELATED DOCUMENTS
u u
ONLINE CLI Reference Manual ONLINE SNMP Reference Manual
COMPLIANCE INFORMATION
Food and Drug Administration (FDA) Laser Safety Warning
This product contains a laser diode. CIENA Corporation strongly recommends that users, maintenance, and service personnel comply with the following standards and regulations in the design, modification, operation, maintenance, an service of lasers and fiber-optic devices:
Jurisdiction Federal, US Federal, US International International International
Type Regulation Guidelines Standard Standard Standard
Title FDA 21 CFR 1040.10/.11 OSHA ANSI Z136 series IEC-825 series EN-60825
It is further recommended that the owner of this equipment determine and ensure conformance with any specific and applicable local regulations.
Class I Laser Product Notice

The CIENA Corporation ONLINE 7000/9000/1100 Transport Platform product is a Class 1 Laser product as identified by US FDA/CDRH 21CFR1040.10/.11; Class 1 Laser product as defined by IEC825/EN-60825; and OFCS SG1 as defined by ANSI Z136.1/.2/
ii
ONLINETM7000/9000/11000
PREFACE
Part 15 of the Federal Communications Commission (FCC): Interference

Every effort has been made to ensure that this equipment is designed to comply with the limits for a Class A digital device, as described in the FCC Rules. Equipment limitations are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment, if not installed and used properly, and in accordance with guidelines established by CIENA Corporation may cause interference with other communications equipment. Operations of this equipment in a residential environment may cause interference and is the responsibility of the user to correct the interference at the users own expense.
Environmental Impact Statement

CIENA equipment contains no hazardous materials as defined by the United States Environmental Protection Agency (USEPA). CIENA recommends that all failed product be returned to CIENA for failure analysis and proper disposal.
Toxic Emissions
CIENA equipment releases no toxic emissions.
Telcordia Document Standards

The format and structure of this document is derived from the Telcordia Generic Requirements for SupplierProvided Documentation, GR-454-CORE.
TRADEMARK ACKNOWLEDGEMENTS
u u u
CIENA is a registered trademark of CIENA Corporation. ONLINE 7000/9000/11000 Transport Platform is a trademark of CIENA Corporation. Windows 95/98/2000 and Windows NT are registered trademarks of the Microsoft Corporation. UNIX is a registered trademark licensed exclusively through X/Open Company, Ltd. Pentium is a registered trademark of Intel Corporation. Sun, Sun Microsystems, JAVA, Java Secure Socket Extension, and JAVAX are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. or other countries. This product includes code licensed from RSA Data Security.
u u u
RELEASE NOTES AND DOCUMENT UPDATES

The hard copy and Compact Disc Read Only Memory (CD-ROM) versions of this document are revised only at major releases and, therefore, may not always contain the latest product information. As needed, Software Release Documents (SRDs), Hardware Release Documents (HRDs), Application Notes, Field Service Bulletins (FSBs), and/or Document Maintenance Bulletins (DMBs) are provided between major releases to describe any new information or document changes. The latest online version of this document and all release notes can be accessed via the CIENA web site at http://www.ciena.com.
iii
PREFACE PRINTING HISTORY
ONLINETM7000/9000/11000
The following information lists the printing history of this document. Issue/Revision Release Date Content Description The ONLINE 7000/9000/11000 TL1 Administration and Reference Guide describes the Transaction Language 1 (TL1) message sets for use with the ONLINE system. Use this manual to find details about TL1 message construction, and how to use TL1 messages to accomplish tasks currently supported on the ONLINE Transport System through release 5.0.
009-2002-618, Revision A
January 15, 2003
DOCUMENT ORDERING INFORMATION

To order additional documentation, the user may contact the local sales representative or CIENA through the contact numbers and/or e-mail addresses listed on the back of the cover.
DOCUMENT COMMENTS
CIENA appreciates all comments that help us improve our documentation quality. The user can submit comments through our web site (http://www.ciena.com) or with the Documentation Improvement Request form included with this document.
ADDITIONAL PRODUCT INFORMATION

Additional product information can be obtained by contacting the local sales representative or CIENA through the contact numbers and/or e-mail addresses listed on the back of the cover.
LAB EVALUATION AND FIELD TRIALS

In accordance with trial-agreement escalation procedures, any problem encountered during laboratory evaluations and field trials should be referred to a CIENA field trial coordinator.
iv
TOC
ONLINE 7000/9000/11000
TM
TABLE OF CONTENTS
TABLE OF CONTENTS
PREFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i LIST OF TABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi CHAPTER 1 TL1 OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 TL1 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Serial Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Ethernet Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 ONLINE TL1 Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Windows 2000 Telnet Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Session Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 TL1 Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Navigation Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 TL1 Command Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 TL1 Command History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Emulation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Setup Requirement for Terminal Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9 TL1 Command Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Input Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Acknowledgement Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-13 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13 Output Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Access Identifiers (AIDs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-16 CHAPTER 2 TL1 AUTONOMOUS MESSAGES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 REPT ALM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 REPT ALM ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-4 REPT DBCHG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 REPT EVT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 REPT PM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-9 REPT RMV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
TOC
TABLE OF CONTENTS ONLINETM7000/9000/11000
REPT RST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12 Event Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-13 CHAPTER 3 TL1 COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Security Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 ACT-PRIV-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3 ACT-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 ALW-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 CANC-PRIV-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6 CANC-SESSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 CANC-SESSION-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 CANC-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9 DLT-GROUP-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10 DLT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11 ED-PID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12 ED-GROUP-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13 ED-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15 ENT-GROUP-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17 ENT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19 INH-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-21 RTRV-GROUP-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22 RTRV-PRIV-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24 RTRV-SESSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-26 RTRV-SESSION-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27 RTRV-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29 Terminal Session Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-30 ED-TRMNL-DFLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-31 ED-TRMNL-SES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-32 RTRV-TRMNL-DFLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33 RTRV-TRMNL-SES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34 SET-ATTR-SECUDFLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-35 SET-SESSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36 Alarm Surveillance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37 ALW-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38 TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
vi
TOC
ONLINE 7000/9000/11000
TM
TABLE OF CONTENTS
ASGN-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-40 DLT-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41 ED-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-42 ENT-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-43 INH-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-44 RTRV-ALM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46 RTRV-ALM-ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-49 RTRV-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-51 RTRV-COND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-53 RTRV-COND-SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55 RTRV-DFLT-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57 SET-NE-ALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58 UNASGN-ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-60 Maintenance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61 EX-SW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62 INIT-SYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-64 OPR-ACO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-66 OPR-EXT-CONT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-68 OPR-PROTNSW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-69 OPR-SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71 RLS-EXT-CONT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-73 RLS-PROTNSW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-74 RTRV-EXT-CONT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-76 Performance Monitoring Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-78 INIT-REG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-79 RTRV-PM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-80 RTRV-PMCTL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83 RTRV-TH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-85 SCHED-PMREPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-87 SET-PMCTL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89 SET-TH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-90 Provisioning Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-92 DLT-{OC3|OC12|STM1|STM4} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-94 DLT-CKT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-95 TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
vii
TOC
DLT-CRS-<rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-96 DLT-EQPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-97 DLT-EXTIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98 DLT-FFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-99 DLT-PASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-100 DLT-SBR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-101 DLT-SNE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-102 DLT-SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-103 DLT-TRAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-104 DLT-UNSWTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105 DLT-VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106 ED-<rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-107 ED-CKT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-110 ED-DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112 ED-DW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114 ED-EQPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-116 ED-EXTIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118 ED-FFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119 ED-SBR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-120 ED-SNE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121 ED-SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-122 ENT-<rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-124 ENT-CKT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-126 ENT-CRS-<rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-128 ENT-EQPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-130 ENT-EXTIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-135 ENT-FFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-136 ENT-PASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-138 ENT-RNGMAP-VNODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-139 ENT-SBR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-140 ENT-TRAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-142 ENT-UNSWTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-143 ENT-VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-144 INIT-RNGMAP-VNODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-145 TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
viii
TOC
ONLINE 7000/9000/11000
TM
TABLE OF CONTENTS
OPR-LPBK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-146 RD-SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-148 RLS-LPBK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-150 RMV-{ } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-152 RST-{ } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-153 RTRV-CKT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-154 RTRV-CKTINFO-{OCH | <rr> | Gbe | FC | FICON | EQPT} . . . . . . . . . . . . . . . . . . . . . . . . 3-156 RTRV-CKTINFO-CKT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-158 RTRV-CRS-<rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-160 RTRV-EQPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-162 RTRV-EXTIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-166 RTRV-{<rr>|SYNCN|PMM|LINK} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-167 RTRV-FAC-{<rr>|ALL|PMM|LINK} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-167 RTRV-FIBER-EQPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-174 RTRV-FFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-176 RTRV-HDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-178 RTRV-NETYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-179 RTRV-PASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-180 RTRV-RNGMAP-VNODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-182 RTRV-RNGSTATUS-VNODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-183 RTRV-SQLCHTBL-VNODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-185 RTRV-SBR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-186 RTRV-SIDTABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-188 RTRV-SNE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-189 RTRV-SWVER-COM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-191 RTRV-SWVER-EQPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-192 RTRV-TRAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-194 RTRV-UNSWTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-195 RTRV-VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-196 SET-SID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-198 SET-SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-199
ix
TOC
CHAPTER 4 TL1 PARAMETER DEFINITIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-1 Alarm Codes (almcde) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Error Codes (errcde) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Notification Codes (ntfcncde) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2 Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 CHAPTER 5 TL1 CONDITION TYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Condtypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Probable Causes for Condition Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 CHAPTER 6 TL1 MONITOR TYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 CHAPTER 7 GROUP ACCESS PRIVILEGES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1 CHAPTER 8 FACILITIES AND PROTECTION SWITCHING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1 Supported Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1 Protection Switching Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2 INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .I-1 COMMANDS/CODES INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .I-3
LOT
ONLINETM7000/9000/11000
TABLE #
LIST OF TABLES
LIST OF TABLES
PAGE #
TABLE NAME
Table 1-1. Table 1-2. Table 1-3. Table 1-4. Table 1-5. Table 1-6. Table 1-7. Table 2-1. Table 2-2. Table 3-1. Table 3-2. Table 4-1. Table 4-2. Table 4-3. Table 5-1. Table 5-2. Table 6-1. Table 7-1. Table 8-1. Table 8-2.
Serial Cable Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Editing Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Command History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 Supported Emulation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Terminal Session Command Characteristics and Options. . . . . . . . . . . . . . . . 1-10 Access Identifier Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 Protection Mapping Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7 Event Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13 Parameters Available in <nameblk> for Response to RTRV-EQPT . . . . . . . . 3-163 Parameters Displayed in Response to <rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-171 TL1 Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 TL1 Notification Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 TL1 Parameter Definitions and Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Condition types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Mapping Probable Cause to TL1 Condition Types. . . . . . . . . . . . . . . . . . . . . . 5-4 Monitor Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Group Access Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1 Supported Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1 Facility Protection Switching Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
xi
LOT
LIST OF TABLES ONLINETM7000/9000/11000
THIS PAGE INTENTIONALLY LEFT BLANK
xii
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
CHAPTER 1 TL1 OVERVIEW

The ONLINE Transport System Transaction Language 1 (TL1) command line message set is used for communications between Telecommunications Operations Support Systems (OSSs) and the ONLINE network elements (NEs) The construction, usage, output, and range of TL1 commands is explained in the following sections of this chapter:
u u u u u u u u u u u u u
TL1 Interface on page 1-1 System Requirements on page 1-2 ONLINE TL1 Access on page 1-4 Session Security on page 1-5 TL1 Syntax Conventions on page 1-5 Navigation Keys on page 1-7 TL1 Command History on page 1-7 Emulation Modes on page 1-8 Setup Requirement for Terminal Sessions on page 1-9 TL1 Command Formats on page 1-11 Acknowledgement Format on page 1-13 Output Response Format on page 1-14 Access Identifiers (AIDs) on page 1-16
TL1 INTERFACE
TL1 commands are part of the overall TL1 message set used to communicate with NEs on SONET/SDH rings. The message sets conform to Telcordia specifications and consist of the commands issued to the node, and the responseseither normal or errorthat are returned by the node. The TL1 command application also provides autonomous messaging, which automatically provides reporting of NE alarms, diagnostics, performance monitoring, NE changes, and other specific conditions. The ONLINE TL1 server resides on the PEM circuit pack (CP) in the ONLINE system. Using TL1 conventions, each node is identified by a target identifier (TID), which is the node identifier assigned by the system administrator during system turn-up. The TID is automatically retrieved by the PEM CP. Also, the value configured for the SID/TID is unique within the subnetwork where the NE resides, but not necessarily across multiple subnetworks (or rings).
u
A TID is the target identifier that identifies the target NE to which a command is directed. A TID consists of up to 20 characters, or may be null when the OS directly interfaces with the target NE. A SID is the source identifier of the NE generating the output message, which may contain up to 20 characters.
TL1 messaging is supported over TCP/IP stacks and can therefore be accessed locally or remotely. At the NE, the TL1 command application runs from the installed Processor Element Module (PEM), which is cabled for either Ethernet or serial communications (Figure 1-1).
1-1
1
TL1 OVERVIEW
NOTE:
ONLINETM7000/9000/11000
Local access is typically conducted at a craft terminal over a Telnet connection; remote access from the craft terminal of an Operations Support System (OSS).
Remote NE
ONLINE NE
OSC
WAN LAN
OSS
ONLINE NE
TL1 over TCP/IP GNE LAN
ONLINE NE
Figure 1-1. TL1 Interface Context The NE that is connected to a management network is the gateway NE (GNE) that routes TL1 commands targeted for remote NEs in the subnet. Internal sessions between gateway and remote NEs are managed transparently by this GNE. Because the TID is used to determine the destination of a command, every NE must contain the information necessary to determine the IP address associated with each TID in the subnetwork. Remote NEs are those that are not physically connected to the management network. Access to the remote NEs is supported over the gateway NE using the Optical Supervisory Channel (OSC) CP. Therefore, TL1 commands targeted for remote NEs are passed to the appropriate NE by the GNE.
SYSTEM REQUIREMENTS
Before accessing the TL1 command application, the PEM CP must be cabled and communicating with the terminal from where the TL1 commands are configured. Use the guidelines provided in this section to either prepare or check the system at the hardware level. This section describes the basic RS-232 cables needed, basic Ethernet information, and the procedure to set up dial-up networking. Use the dial-up networking feature in Windows to set the connectivity parameters
NOTE:
If the NE (Network Element) is connected to a network (i.e., to a hub or a switch), a straight-through CAT-5 is required. In this configuration, a PC is also connected to the network and Telnet to the NE (port 5050) using the settings described in Windows 2000 Telnet Configuration on page 1-5.
1-2
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Serial Setup
RS-232 serial cable, female 9-pin, D-subminiature (DB-9) connector on one end; male DB-9 connector on the other end. See Table 1-1 for cable pin assignments.
u u
The male connector attaches to the LAN port on the PEM CP. The female connector attaches to the serial port on the local craft computer. Table 1-1. Serial Cable Pin Assignments
Pin 1 2 3 4 5 6 7 8 9
Signal DCD RxD TxD DTR Ground DSR RTS CTS Ring
Direction <-<---> --> --<---> <-<--
Description Carrier Detect Receive Data Transmit Data Data Terminal Ready Signal Ground Data Set Ready Ready to Send Clear to Send Ring Indicator
Ethernet Setup
Use straight-through Ethernet CAT 5 cable, with RJ-45 connectors at both ends.
NOTE:
Do not use a crossover cable, except if connecting from a laptop.
To set up dial-up networking STEP 1: Set up the phone book entry for the ONLINE system on the Basic tab page. Entry name = ONLINE model Comment = Direct serial connection using PPP Dial using = dial-up networking serial cable between two PCs Set modem initial speed to 115200, and enable flow control STEP 2: Set the dial-up server type to be used on the Server tab page. Dial-up server type = PPP: Windows NT, Windows 95 (or later), Internet Network protocols = TCP/IP Enable software compression = click to select Enable PPP LCP extensions = click to select In the TCP/IP Settings dialog box, click to select the following parameters: Server assigned IP address TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
1-3
1
TL1 OVERVIEW
Server assigned name server addresses Use IP header compression Use default gateway on remote network STEP 3: STEP 4: STEP 5: STEP 6: Make sure the After dialing (login) option is set to none on the Script tab page. Make sure the Authentication and encryption policy is set to accept any authentication including clear text on the Security tab page. Make sure the X.25 network provider for the remote server is set for none on the X.25 tab page. Use the Dial-up Networking dialog box to connect to the NE.
ONLINETM7000/9000/11000
ONLINE TL1 ACCESS

The craft computer must be equipped with Telnet client software or another interface that can communicate with port 5050 on the NE. The craft computer operating system can be Windows 95/98/NT/2000, a UNIX variant, or any other system that supports client software capable of communicating with port 5050. If Telnet client is used, it must have "character at a time," and have local echo disabled. If the Windows 2000 operating system is used on the craft computer, the Telnet client must be configured properly prior to the first connection to the network element (NE) Telnet port (see Windows 2000 Telnet Configuration on page 1-5). The TL1 commands are accessed by means of a Telnet client session. Up to 32 simultaneous TL1 sessions are supported with ONLINE systems. Use the procedure in this section to present the TL1 prompt with which to log into the ONLINE system. Use the following procedure to establish Telnet connectivity. To establish Telnet connectivity STEP 1: Start a Telnet client session. a. Select the Connect | Remote System menu item. b. Enter the host name and the port number of the NE and PEM from which to invoke the TL1 interface. c. Connect to the TL1 server from the command line, or Start/Run dialog. Type: telnet <pem ip address> 5050
By default there is no response message sent from the TL1 server to indicate a successful connect. STEP 2: Use the TL1 ACT-USER command to log in. act-user:: superuser:::superuser;
NOTE:
Refer to Setup Requirement for Terminal Sessions on page 1-9 for information on using the ED-TRMNL-SES command (for turning on character echo).
1-4
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Windows 2000 Telnet Configuration

Use the configuration steps outlined in this section to set up Telnet parameters in Windows 2000. C:\> telnet Microsoft (R) Windows 2000 (TM) Version 5.00 (Build 2195) Welcome to Microsoft Telnet Client Telnet Client Build 5.00.99201.1 Escape Character is 'CTRL+]' Microsoft Telnet> unset NTLM Microsoft Telnet> set LOCAL_ECHO Microsoft Telnet> unset CRLF Microsoft Telnet> set TERM VT100 Microsoft Telnet> display Escape Character is 'CTRL+]' WONT AUTH (NTLM Authentication) LOCAL_ECHO on Sending only CR WILL TERM TYPE Preferred Term Type is VT100 Microsoft Telnet> quit
SESSION SECURITY
Only the ACT-USER command can be issued once a connection is established to the TL1 server. After successful authentication, the other commands are available. A default session timeout (defaulted to 35 minutes) is provided for added security. This default value can be modified or disabled with the SET-ATTRSECUDFLT command. Also, a GNE session is not dropped until all remote sessions accessed through that specific GNE connection are logged out and disconnected.
TL1 SYNTAX CONVENTIONS

TL1 command syntax essentially functions as a map of the command; the conventions, shown in Figure 12, define the type of notation found in TL1. Table 1-2. Syntax Conventions Symbol <cr> <lf> ^ Description A carriage return in American Standard Code for Information Interchange (ASCII) A line feed in ASCII Indicates a blank space that must appear in the message. Symbols are sometimes preceded and followed by blanks (not "^") for readability only and are not part of the command or response.
1-5
1
TL1 OVERVIEW ONLINETM7000/9000/11000
Table 1-2. Syntax Conventions (Continued) [ ] One or more parameters (including delimiters) enclosed within brackets indicates the parameters are optional. An optional parameter means that if an optional parameter is left empty, then a default (or a default action) is automatically substituted in the transmitted input field. The default value, or null value, is defined in the parameter descriptions of the messages. In some cases, when NA (not applicable) is the default value, this indicates that unless a value is supplied, this parameter is not applicable, or relevant, to the message. A list of two or more parameters enclosed within curly braces and separated by a vertical line | indicates that one (and only one) of the parameters may be selected from the list. The angle brackets are used to enclose one or more information items. For example, < date >, <time>, and <source identifier>. The brackets are not transmitted. The parentheses are used to enclose a group of symbols for the following operators ( " * " and "+"). The parentheses are not transmitted. The asterisk is a post-fix operator that indicates the preceding symbol or group of symbols may occur zero or more times. The plus sign is a post-fix operator that indicates the preceding symbol or group of symbols (enclosed in parentheses) may occur one or more times. Uppercase characters in format expression shall appear as they are in the message.
{ | |}
< >
( ) * + UPPERCASE
The following syntactical characters, in format expression, is transmitted exactly as shown: ; " " /* */ , : < > The end of a message is a semicolon ( ;). A pair of quotes (" ") in format expressions is used to delimit an expression that can be parsed. A pair of characters ( * * ) is used to delimit an expression that can be parsed. A comma ( , ) separates parameters within a parameter block. A colon ( : ) separates parameters within a parameter block. A dash ( - ) is always used in the command code when modifiers are present to separate the verb (and first and second modifiers when applicable). The ""<" symbol is the ready indicator (refer to GR-831-CORE). The "." symbol is an end-of-output character indicating that more output associated with response follows (refer to GR-831-CORE).
1-6
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
NAVIGATION KEYS
TL1 functionality is used to edit commands efficiently while provisioning or monitoring the ONLINE system. A command history is also available. The following sections summarize both the TL1 command editing and history capabilities.
TL1 Command Editing

The command line editor is used to edit commands while provisioning the system. Table 1-3 shows the various keys used to position the cursor or remove characters. Table 1-3. Editing Keys Key Left arrow Right arrow Home End Backspace Delete Ctrl-d Ctrl-k Ctrl-u Insert Ctrl-i Control Sequence Ctrl-b Ctrl-f Ctrl-a Ctrl-e Reverse character. Forward character. Beginning of line End of line Delete previous character. Delete current character. Delete to end of line. Delete the complete line. Toggle insert/overwrite. Action
TL1 COMMAND HISTORY

Any given TL1 session keeps track of the previous 32 commands that are entered. However, the memory buffer is emptied when logging in or out with the ACT-USER or CANC-USER command. The following keys (Table 1-4) are used to access this buffer. Table 1-4. Command History Key Up arrow Down arrow Control Sequence Ctrl-p Ctrl-n Previous in history Next in history Action
1-7
1
The history buffer does not track any of the following commands to prevent accidental reboots and for security reasons:
u u u u u
ACT-USER ENT-USER- SECU ED-USER-SECU ED-PID INIT-SYS
EMULATION MODES
Table 1-2 lists the keys supported for each mode of a TL1 session. The following emulation modes are supported.
u u u u u
VT-100 VT-220 VT-320 ANSI TTY
Limitations are due to the emulator not supporting the key and can be resolved with emulator-key mapping to the appropriated control sequence. Table 1-5. Supported Emulation Modes Key Left arrow Right arrow Up arrow Down arrow Home End Backspace Delete Insert * * * * n/a n/a * * n/a VT-100 * * * * * * * * * VT-220 * * * * * * * * * VT-320 * * * * * * * n/a n/a ANSI * * * * * * * n/a n/a TTY
1-8
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
SETUP REQUIREMENT FOR TERMINAL SESSIONS

Four commands are available to modify a terminal session and default behavior, and are summarized as follows:
u
ED-TRMNL-SES This command only modifies the current session and has no effect on other or future sessions. This command is used to modify editing capabilities, character echo, history buffer size, and the column width of the terminal. ED-TRMNL-DFLT This command affects all future sessions created on this node and does not modify the current session, nor any other active sessions. This command allows users with the administrator or tl1 privilege to modify default editing capabilities, initial insert mode, character echo, history buffer size, password masking, and the column width of the terminal. It is also used to set the mode trigger method. The Mode Trigger is a convenience keystroke to switch a session from machine mode to human mode. Human Mode This mode sets edit and echo to the enabled state and sets the column width to the default value. It enables the history buffer and sets it to the default value unless the default value is 0, in which case the trigger sets this session history buffer to 32. Machine Mode Machine mode is the default state of the Edit, Echo, Column Width and History Buffer Size characteristics as provisioned with the ED-TRMNL-DFLT command. A session is started in Machine Mode for ED-TRMNL-DFLT with the mode field <mode> set to MACHINE, TRIGENTER or TRIGCTRLENTER and only enters the Human Mode upon a keystroke trigger. If the ED-TRMNL-DFLT <mode> is set to HUMAN, this trigger occurs as soon as the session is started. See the ED-TRMNL-DFLT command description for more details. SET-ATTR-SECUDFLT This command is used to set the default inactivity timeout for all future session created on this node. A value of 0 (zero) disables the inactivity timeout for all future sessions. This command does not affect the current session. SET-SESSION This command is used to set the inactivity timeout for the current session. A value of 0 disables the inactivity timeout for the current session only.
See Terminal Session Commands on page 3-30 for details on specific commands and for the available RTRV (retrieve) commands used to view the data provisioned in the above commands. The range of capability and allowed values for each of the terminal session commands are briefly summarized in Table 1-6.
1-9
1
Table 1-6. Terminal Session Command Characteristics and Options Characteristic Edit Allowed N Default Value Default Modify Command ED-TRMNL-DFLT Session Modify Command ED-TRMNL-SES Allowed Values EDIT: Y = Edit allowed. N=Edit disabled. ECHO: Y= Server echo allowed N= Server echo disabled HISTBUF: 0 = History Disabled 1-256 = Number of Commands to retain in buffer COLWIDTH: 0=Auto detect 3-1023 = Set to column width of the terminal MODE: MACHINE = Human mode cannot be triggered by keystroke. Use EDTRMNL-SES command to set individual characteristics for the sessions. HUMAN = Human mode entered at session startup TRIGENTER = Human mode entered when Enter key pressed. TRIGCTRLENTER= Human mode entered when CtrlEnter pressed.
Echo Allowed
ED-TRMNL-DFLT
ED-TRMNL-SES
History Buffer Size 0
ED-TRMNL-DFLT
ED-TRMNL-SES
Column Width
80
ED-TRMNL-DFLT
ED-TRMNL-SES
Trigger Mode
MACHINE
ED-TRMNL-DFLT
n/a
1 - 10
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Table 1-6. Terminal Session Command Characteristics and Options (Continued) Characteristic Password Masking Mode N Default Value Default Modify Command ED-TRMNL-DFLT Session Modify Command n/a Allowed Values PWMASK Y = Defaults to insert N = Defaults to overwrite INSERT: Y=Defaults to insert N = Defaults to overwrite TMOUT: 0=disabled 1-120 = Minutes before disconnect
Insert Mode
ED-TRMNL-DFLT
n/a (insert key)
Inactivity Timeout
35
SET-ATTRSECUDFLT
SET-SESSION
TL1 COMMAND FORMATS

TL1 messages conform to syntax rules as appropriate for command input, system acknowledgements, and output messages.
Input Command Format

When entering TL1 commands, the verb, modifiers, system identifiers, and punctuation must conform to the following syntax.
Syntax
<verb>-<modifier>[-<modifier>]:[<tid>]:<aid>:<ctag>[:<genblk>][:<comblk> [:<specificblk>] [:<stateblk>]] ] ];
Parameter verb
Description The action to be initiated at the NE. This typically includes (but not always) modifiers for the command. The verbs are as follows: ACT Activate ALW Allow CANC Cancel DLT Delete ENT Enter: add ED Edit: modify INH Inhibit INIT Initialize OPR Operate RTRV Retrieve REPT Report RMV - { } Remove RLS Release RST- { } Restore SCHED Schedule SET Define
1 - 11
1
TL1 OVERVIEW
modifier
ONLINETM7000/9000/11000
Command code modifiers are optional depending upon the specific command and the application domain. In normal TL1 command usage, the first modifier identifies the object of the verb where the action is to be applied in the NE. The second modifier further modifies the object of the verb and is interpreted differently for different operations domains. Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier The specific resource being identified in the request. Correlation tag A unique identifier sent to correlate responses. The response to a command contains the CTAG of the corresponding command. Valid CTAG values include strings of up to six characters comprised of identifiers (alphanumeric, beginning with a letter) or non-zero decimal numerals (a string of decimal digits with an optional non-trailing "."). Not used. Common data block (position defined). Used for parameters:
u u
tid
aid ctag
genblk comblk
which are not in the majority of instance, and/or parameters in the common data block that puts the specific data block in context.
specificblk
Name defined. Used in the majority of instances or in the case where, for a given instance of the command, only a few parameters are needed from a choice of many. Primary and secondary state parameters. ";" command terminator
stateblk ;
1 - 12
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
ACKNOWLEDGEMENT FORMAT
The TL1 acknowledgement response identifies itself as one of four types, and may contain a correlation tag (CTAG) associated with the command that prompted the response. This information is contained in the following syntax:
Syntax
<ack> ^ <ctag><cr><lf>
Parameter ack
Description If a TL1 command requires more than 2 seconds to send a response, an acknowledgement response is issued from the NE to indicate that the command has been received and is being processed. Once the processing is complete, either a normal or error response is sent. The following are acknowledgement message definitions. IP In progress: the request has been initiated. There are subsequent output messages that give a termination report or a termination report and command results. NA No acknowledgement: under abnormal conditions, a command has been accepted but has been lost and correct acknowledgement is not possible. NG No good: the command is valid, but the requested action conflicts with the current system or equipment status. RL Repeat later: the requested action cannot be executed now because of unavailable system resources caused by system overload, excessive queue lengths, and busy programs. The command may be entered again later.
ctag cr lf
Correlation tag This is the CTAG specified in the command. Carriage return Line feed
1 - 13
1
TL1 OVERVIEW OUTPUT RESPONSE FORMAT
TL1 output responses contain a head, response identifier, a block of text pertinent to the response type, and a terminating character with the following syntax:
ONLINETM7000/9000/11000
Syntax
<header><response id>[<text block>]<terminator>
Parameter header
Description The header represents information common to all output response and autonomous messages, using the following syntax: <cr><lf><lf>^^^<sid>^<date>^<time> Response ID syntax consists of the following elements: <cr><lf>M^^<ctag>^<cmplcde> M Constant that signifies that the message is the response to an input command message. ctag Command-message correlation identifier. If the value is invalid or cannot be identified due to connection errors, the response CTAG shall be set to the single character zero (0). cmplcde The completion code that indicates the disposition of the response. Valid values for the cmplcde are:
u u u
response id
COMPLD: represents total successful execution of the input command. DENY: represents total denial of the input command. PRTL: represents the partial successful execution of the input command. This response code shall be returned for input commands specifying multiple AIDs of which only a subset (but not an empty subset) has been successfully executed. DELAY: represents the successful queuing of the input command submitted for delayed activation.
1 - 14
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Description
Parameter text block
The optional text block is used to represent information specific to the particular output response in either of two formsnormal or error. The form of the normal response text is: <rspblk>*
u
rspblk One or more lines that return the specific results, if any, of a retrieve/ query command. The form of the error response is: ^^^<errcde><cr><lf> (^^^"<error description>"<cr><lf>)* (^^^/*error text*/<cr><lf>)*
errcde The error code
error description An optional textual description of the error.error text: An optional commentary of the conditions surrounding the error.
terminator
The terminator is represented by either the semicolon character (;) or the greater than (>) character. For example: <cr><lf>(;|>)
u u
The " ; " indicates termination of the output response message. The " >" indicates more output associated with this response follows under another header.
1 - 15
1
TL1 OVERVIEW ACCESS IDENTIFIERS (AIDS)
Access identifiers (AIDs) refer to specific objects and the defining characteristics of the objects (Table 1-7), which are associated with the internal information used by the ONLINE NE. CHAPTER 4, TL1 PARAMETER DEFINITIONS provides additional information on AID derivations.
ONLINETM7000/9000/11000
Table 1-7. Access Identifier Formats Object Alarm Severity Assignment Profile (ASAP) Modifier AID Format ASAP-<asaptype>[-<localasapnum>]<asaptype> Indicates the type of profile. Valid values are:
u u u u u u u u u u u u u u u u
LOCAL NODE SHELF CP LINE SONET GBE ESCON OSC DW WAVE BAND SYNC PMM MP SSI
NOTE:
All values with the except of "LOCAL" are considered global profiles.
NOTE:
localasapnum: Indicates the specific local profile. Used only with "LOCAL" asaptype. Valid values are {1-999}.
Common Equipment
COM
COM[-<pmode>]
u
<pmode> = Indicates the protection mode. Valid values are { PRI | BKUP}
1 - 16
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Table 1-7. Access Identifier Formats (Continued) Object Shelf Modifier EQPT EQPT-SHELF-<shelf>
u
AID Format
<shelf> = The specified shelf. Valid values are {1-15}.
Circuit Pack
EQPT
EQPT-CP-<shelf>-<slot>
u u
<shelf> = {1-15} <slot>= {1-18} (19 shelf) {1-26} (23 shelf) {1-23} (23 " vertical shelf)
Regen
EQPT
EQPT-CP-<shelf>-<slot>,EQPT-CP-<shelf>-<slot>
u
<shelf> = The shelf of the WCI circuit pack. Valid values are {1-15}. <slot> = The slot of the WCI circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf).
NOTE:
When used in DLT-EQPT only the east shelf and slot or west shelf and slot specifying one WCI making up the Regen is required and both WCI's making up the Regen are deleted. Also note the RTRV-EQPT command does not display the regen, but displays 2 separate WCI circuit packs.
Datawire Link
DW
DW-<shelf>-<slot>
u
<shelf> = The shelf of the OSC circuit pack. Valid values are {1-15}. <slot> = The slot of the OSC circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf).
Optical Supervisory Channel
LINK
LINK-OSC-<shelf>-<slot>
u
<shelf> = The shelf of the OSC circuit pack. Valid values are {1-15}. <slot> = The slot of the OSC circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf).
1 - 17
1
Table 1-7. Access Identifier Formats (Continued) Object Optical Line Facility Modifier OT AID Format OT-<side>[-<shelf>-<slot>][-<role>]
u
<side> = The side of the specified wave. Valid values are {W|E}. <shelf> = The shelf of the associated circuit pack. The shelf is only displayed for AIDs referring to alarms that are specific to a circuit pack. Valid values are {1-15}. <slot> = The slot of the associated circuit pack. The slot is only displayed for AIDs referring to alarms that are specific to a circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <role> = The protection mode of the facility. The role is only used for protection switching and FFP purposes. Valid values are {WKG|PROT}. OT-<side>[-<shelf>-<slot >] OT-<side>-<shelf>-<slot > OT-<side>-<role>
Facility Modification Format:

u
Facility Alarm/Event Format:

u
Facility Protection Format:

u
Optical Band
OB
OB-<shelf>-<slot>-B<band>
u
<shelf> = The shelf of the BWDM or ABWDM circuit pack. Valid values are {1-15}. <slot> = The slot of the BWDM or ABWDM circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <band> = The band associated with this facility. Valid values are {1-11}.
1 - 18
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Table 1-7. Access Identifier Formats (Continued) Object Optical Tributary Facility Modifier OCH AID Format OCH-<shelf>-<slot>[-C<channel>][-<lntr>]
u
<shelf> = The shelf of the WCI circuit pack for BLSR or unprotected UPSR configurations or the shelf of the WPS splitter for line protected UPSR configurations. If a channel is specified, the shelf is of the associated CWDM circuit pack. Valid values are {1-15}. <slot> = The slot of the WCI circuit pack for BLSR or unprotected UPSR configurations or the slot of the WPS splitter for line protected UPSR configurations. If a channel is specified, the slot is of the associated CWDM circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <channel> = The channel of the CWDM circuit pack associated with this facility. This format is only used for provisioning and retrieving of a channel passthrough. Valid values are {1-3}. <lntr> = Indicates the side of the WCI, Line or Tributary, associated with a PM or an alarm. This is only valid for PM's and line or tributary specific alarms. Valid values are {LN|TR}.
Gigabit Ethernet Facility (GRDM tributary side)
GBE
GBE-<shelf>-<slot>-P<port>
u
<shelf> = The shelf of the GRDM circuit pack. Valid values are {1-15}. <slot> = The slot of the GRDM circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <port> = The port of the GRDM containing the associated GBE facility. Valid values are {1-2}.
Fibre Channel Facility (GRDM tributary side)
FC
FC-<shelf>-<slot>-P<port>
u
<shelf> = The shelf of the GRDM circuit pack. Valid values are {1-15}. <slot> = The slot of the GRDM circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <port> = The port of the GRDM containing the associated FC facility. Valid values are {1-2}.
1 - 19
1
Table 1-7. Access Identifier Formats (Continued) Object FICON (GRDM tributary side) Modifier FICON AID Format FICON-<shelf>-<slot>-P<port>
u
<shelf> = The shelf of the GRDM circuit pack. Valid values are {1-15}. <slot> = The slot of the GRDM circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <port> = The port of the GRDM containing the associated FC facility. Valid values are {1-2}. ESCON-<shelf>-<slot>-P<port> <shelf> = The shelf of the EMX circuit pack. Valid values are {1-15}. <slot> = The slot of the EMX circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <port> = The port of the EMX containing the associated ESCON facility. Valid values are {1-12}.
ESCON Facility
ESCON
u u
1 - 20
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Table 1-7. Access Identifier Formats (Continued) Object SONET/SDH Facility Modifier <rr> Facility: <rr>-<shelf>-<slot>[-P<port>][-<timeslot>][-<role>] Protected Tributary Facility: <rr>-<workshelf>-<workslot>-P<workport>-<protshelf><protslot>-P<protport>[-<worktimeslot>] Protected Line Facility: <rr>-<workshelf>-<workslot>-<protshelf>-<protslot> Virtual Port Facility (for paired STMX card tributary side only): <rr>-<shelf>-<slot>-VP<port>[-<timeslot>]
u
AID Format
<rr> = The rate code of the facility. Valid values are {OC3 | OC12 | OC48 | OC192 | STM1 | STM4 | STM16 | STM64 | STS1 | STS3C | STS12C | STS48C| AU4| AU44C}. <shelf>,<workshelf>,<protshelf> = The shelf of the associated circuit pack. Valid values are {1-15}. <slot>,<workslot>,<protslot> = The slot of the associated circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <port>,<workport>,<protport> = The port on the associated circuit pack containing the associated facility. Valid values are {1-16} depending on the type of circuit pack.Valid values are {1-4} for 4 Port STMX, SMX10G and 4 Port ADM; {1-8} for 8 Port STMX and 8 Port ADM; {9-16} for STEM and virtual ports (VP) on the STMX card. <timeslot>,<worktimeslot> = The timeslot for the associated facility. Valid values are {1-192} for OC192 line side circuit packs and {1-48} for OC48 <rr> = The rate code of the facility. Valid values are { OC3 | OC12 | OC48 | OC192 | STM1 | STM4 | STM16 | STM64 }. <shelf> = The shelf of the associated circuit pack. Valid values are {1-15}. <slot> = The slot of the associated circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <port> = The port on the associated circuit pack containing the associated facility. Valid values are {1-16} depending on the type of circuit pack.Valid values are {1-4} for 4 Port ADM; {1-8} for 8 Port ADM.
Enut, Nut
UNSWTS
<rr>-<shelf>-<slot>[-P<port>]
u
1 - 21
1
Table 1-7. Access Identifier Formats (Continued) Object External Interface Modifier EXTIF AID Format EXTIF-<side>-<band>[-<channel>]
u
<side> = The side of BWDM/CWDM circuit pack this interface connects to, it can be 'W' or 'E'. Side is a required field in the AID. <band> = The band supported by this interface, it can be 1-11. Band is a required field in the AID. <channel> = The channel supported by this interface, it can be 1-3. Channel is an optional field in the AID.
PMM Facility
PMM
PMM-<pmmtype>-<shelf>-<slot>-<voa>
u
<pmmtype> = The PMM passthrough type.Valid values are: {MPT|BPT}. <shelf> = The shelf of the PMM circuit pack. Valid values are {1-15}. <slot> = The slot of the PMM circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <voa> = The variable optical attenuator number for the PMM facility. Valid values are {1-2}.
DCM
EQPT
EQPT-DCM-<dcm> for DCM A only EQPT-DCM-<dch>-<dcm> for DCM Leaf only

u
<dcm> = The integer number representing the Dispersion Compensation Module (DCM). Valid values are {1-999}. <dch> = The integer number representing the Dispersion Compensation Module (DCM) Box. Valid values are {199}. <dch> = The integer number representing the Dispersion Compensation Module (DCM) Box. Valid values are {199}.
DCH
EQPT
EQPT-DCH-<dch>
u
Logical SONET NE
SNE
SNE-<sne>
u
<sne> = The integer number representing the Sonet Network Element (SNE). Valid values are {1-999}. This is not the Node number or Node ID, but is a logical grouping of 2 Sonet circuit packs to create protection between the two circuit packs. The number represents this logical grouping of 1 or 2 circuit packs.
1 - 22
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Table 1-7. Access Identifier Formats (Continued) Object OC48 SONET BLSR STM16_MSPRING line-protected facilities Modifier VNODE AID Format VNODE-<wshelf>-<wslot>-<eshelf>-<eslot>
u
< wshelf >= The shelf of the associated west circuit pack. Valid values are {1-15}. < eshelf >= The shelf of the associated east circuit pack. Valid values are {1-15}. <wslot> = The slot of the associated west circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf). <eslot>= The slot of the associated east circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {1-23} (23" Vertical Shelf).
External Sync Reference
SYNCN
SYNCN-<shelf>-<slot>
u
<shelf > = Shelf number containing the reference used as the external SYNC source. Valid values are {1-15}. <slot> = The slot of the associated circuit pack. Valid values are {1-18} (19" Shelf) or {1-23} (23" Vertical Shelf). Not valid on the 23" old style shelf.
User Alarms
ENV
USRALM-<num>
u
<num> = {1-12} for original 23 inch shelf or {1-8} for 19 inch or 23 inch Vertical shelf.
External Controls
CONT
CONT-<num>
u
<num> = {1-12} for original 23 inch shelf or {1-8} for 19 inch or 23 inch vertical shelf. <shelf> = The shelf of the specified circuit pack. Valid values are {1-15}. <slot> = The slot of the specified circuit pack. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {123} (23" Vertical Shelf). <port> = Valid values are {1-8} for STMX Circuit Packs and {1-4} for others.
Trail
TRAIL
<shelf>-<slot>[-P<port>],<shelf>-<slot>[-P<port>]
u
NOTE:
This AID is position independent. The "from" and "to" side can be swapped.Note: The TRAIL AID block is made up of two AIDs, one for the "from" side and one for the "to" side. Do not treat this combination as one AID.
1 - 23
1
Table 1-7. Access Identifier Formats (Continued) Object Network Path Circuits Modifier CKT
u
AID Format <anode>-<ashelf>-<aslot >,<znode>-<zshelf>-<zslot > [,<z2node>-<z2shelf>-<z2slot >] <anode>,<znode>,<z2node> = Node ID of specified node the circuit originates from or terminates to. Valid values are {1-16383}. <ashelf >,<zshelf>,<z2shelf> = Shelf number containing the BWDM, CWDM, WCI, or WPS used in the circuit. WCA Traffic on a twoFiberOchODPR configuration requires the shelf number of the WPS to be specified, all other configurations require the shelf number of the WCI. Valid values are {1-15}. <aslot >,<zslot>,<z2slot> = Slot number containing the BWDM, CWDM, WCI, or WPS used in the circuit. WCA Traffic on a twoFiberOchODPR configuration requires the slot number of the WPS to be specified, all other configurations require the slot number of the WCI. Valid values are {1-18} (19" Shelf) or {1-26} (23" Shelf) or {123} (23" Vertical Shelf).
NOTE:
Note: The CKT AID block is made up of two or three AIDs, one for the A node and one for the Z node (and possible one for a second znode). Do not treat this combination as one AID.
1 - 24
ONLINE 7000/9000/11000
TM
TL1 OVERVIEW
Table 1-7. Access Identifier Formats (Continued) Object Subrate Path Circuits Modifier SBR AID Format <anodeid>-<ashelf>-<aslot>-P<aport>-<atslot>,<znodeid><zshelf>-<zslot>-P<zport>-<ztslot>[,<z2nodeid>-<z2shelf><z2slot>-P<z2port>-<z2tslot>]
u
<anodeid>,<znodeid>,<z2nodeid> = Node ID of specified node the subrate originates from or terminates to. Valid values are {1-16383}. <ashelf >,<zshelf>,<z2shelf> = Shelf number containing the GRDM or EMX used in the subrate. For open ended subrates, this value must be set to 0. Valid values are {015}. <aslot >,<zslot>,<z2slot> = Slot number containing the GRDM or EMX used in the subrate. For open ended subrates, this value must be set to 0. Valid values are {018} (19" Shelf) or {0-26} (23" Shelf) or {0-23} (23" Vertical Shelf). <aport>,<zport>,<z2port> = Port number of subrate on the GRDM or EMX used in this subrate. For open ended subrates, this value must be set to 0. Valid values are {012} (ESCON) or {0-2} (GRDM (FC, FICON, or GBE)). <atslot>,<ztslot>,<z2tslot> = Time slot of subrate on the GRDM or EMX used in this subrate. For open ended subrates, this value must be set to 0. Valid values are {012} (ESCON) or {0-2} (GRDM (FC, FICON, or GBE)).
NOTE:
The SBR AID block is made up of two or three AIDs, one for the A node and one for the Z node (and possible one for a second znode). Do not treat this combination as one AID
1 - 25
1
1 - 26
ONLINE 7000/9000/11000
TM
TL1 AUTONOMOUS MESSAGES
CHAPTER 2 TL1 AUTONOMOUS MESSAGES

TL1 autonomous messages are automatically output to the session as REPT (report) messages. This chapter describes the format of TL1 autonomous REPT messages in the following sections.
u u u u u u u u
REPT ALM on page 2-2 REPT ALM ENV on page 2-4 REPT DBCHG on page 2-5 REPT EVT on page 2-6 REPT PM on page 2-9 REPT RMV on page 2-11 REPT RST on page 2-12 Event Type Mapping on page 2-13
2-1
2
TL1 AUTONOMOUS MESSAGES REPT ALM
report alarm
Purpose A report-alarm (REPT-ALM) is generated by a network element to report the occurrence of alarmed events. Trouble events occurring in the NE are classified as alarmed or non-alarmed events. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the entity. Some form of maintenance effort is required to restore normal operation or performance of the entity after the event has occurred. A non-alarmed event is not reported with this message; rather, the REPT-EVT message is used. GR-474CORE and FR-475 explain the designation of specific trouble events as alarmed or non-alarmed events. Autonomous Identification
<cr><lf><almcde>^<atag>^REPTÂLM^{EQPT|COM|SYNCN|LINK|<rr>}
ONLINETM7000/9000/11000
Parameter almcde atag rr
Description Alarm code Autonomously generated correlation tag Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing.
System Response Syntax

^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,[<ocrdat>],[<ocrtm>],[<locn>],[<dirn>] [,[<monval>][:[<conddescr>],]"<cr><lf>
Message aid ntfcncde condtype srveff ocrdat ocrtm locn
Description The specific equipment unit, facility, link or packet link in the NE, depending on the message code modifier, to which the alarm pertains. Two-character notification code Type of alarm See CHAPTER 5, TL1 CONDITION TYPES for more information. Effect on service as a result of the alarm condition The date of the event occurrence The time of day of the event occurrence Location of the failure; refers to the entity identified in the <aid>. Thus near end refers to failure conditions occurring at the identified entity, and far end refers to failure conditions occurring at a distant entity that is connected to the identified entity. Likewise, LINE[-x] refers to an intermediate point.
2-2
ONLINE 7000/9000/11000
TM
Message dirn monval
Description The direction of the alarm relative to the entity identified by the AID. Measured value of a monitored parameter, which may contain data related to transmission performance or circuit activity, if <condtype> is a threshold violation. This data is in the form of numeric counts or rates. This value should be provided if this alarm report has resulted from a degradation that has exceeded the defined or specified threshold level. Detailed text description of the specific event that caused this notification.
conddescr
2-3
2
TL1 AUTONOMOUS MESSAGES REPT ALM ENV
report alarm environment
Purpose An autonomous message that is generated for each environmental alarm raised. This command is related to the input command RTRV-ALM-ENV. Autonomous Identification
<cr><lf><almcde>^<atag>^REPTÂLMÊNV
ONLINETM7000/9000/11000
Parameter almcde atag
Description Alarm code Autonomously generated correlation tag

^^^"<aid>:<ntfcncde>,<almtype>,[<ocrdat>],[<ocrtm>][,<almmsg>]" <cr> <lf>
Message aid ntfcncde almtype
Description The specific equipment unit, facility,link or packet link in the NE, depending on the message code modifier, to which the alarm pertains. Two-character notification code Alarm type, as one of the following types:
u u u u
CLFAN = Cooling fan failure FUSE = Fuse failure MISC = Miscellaneous condition POWER = Commercial power failure
ocrdat ocrtm almmsg
Date of event occurrence Time of day of event occurrence Text message associated with the environmental alarm. It may contain up to 40 characters and must be enclosed within a pair of escaped quotes (\).
NOTE:
To avoid confusion with the <ntfcncde> parameter, the <almcde> parameter description refers to the nature of the automatic message, not the severity of the alarm.
2-4
ONLINE 7000/9000/11000
TM
REPT DBCHG
report database change
Purpose This message is generated by an NE to inform the OS of any database changes that have occurred as a result of commands entered from another interface channel, and changes due to external events such as circuit pack insertion or removal. Any changes to (1) the value of the NEs TID (or SID), (2) the values of the keywords defined in the common block and the specific block, (3) state transition into and out of OOS-MA primary state, and (4) state change to the RDLD (red-lined) secondary state are considered as database changes. Autonomous Identification
<cr><lf>A^^<atag>^REPT^DBCHG
Parameter atag
Description Autonomously generated correlation tag.

^^^"TIME=<time>,DATE=<date>,[SOURCE=<source>],[LINK=<linkid>],[USERID=<userid>] ,DBCHGSEQ=<dbchgseq>:<cmdcde>:<aid>[:<datablk>]"<cr><lf>;
Message time date source dbchgseq cmdcde aid
Description Shows the current time in HH-MM-SS format. Shows the date in YY-MM-DD format. Identifies an input-command CTAG, if present. (optional) A sequential number of the database change message ranging from 1 to 9999. The input command code that indicates whether the action that caused the database change was an addition, modification, or deletion. The access identifier (AID) that identifies an entity (or group thereof) in the NE to which the command pertains. The value of <aid> may be null where explicitly specified. The data block that provides informational parameters associated with the database change. DATABLK are name/value pairs separated by commas. This information is specific to CIENA.
datablk
2-5
2
TL1 AUTONOMOUS MESSAGES REPT EVT
report event
Purpose The report event is an autonomous message that is generated for non-alarmed events. The event being reported may be the change of the status or the occurrence of an irregularity, which by itself is not severe enough to warrant an alarm notification. One example of this is a performance threshold crossing. This message may also be used to report the recovery from off-normal or trouble conditions that are reported initially by REPT EVT. Autonomous Identification
<cr><lf><almcde>^<atag>^REPTÊVT^{EQPT|COM|SYNCN|LINK|<rr>}
ONLINETM7000/9000/11000
Description Alarm code Autonomously generated correlation tag Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

^^^"[<aid>][,<aidtype>]:<condtype>,[<condeff>],[<ocrdat>],[<ocrtm>],[<locn>][<d irn>],[<monval>],][,<tmper>][:[<conddescr>]"<cr><lf>
Message aid aidtype condtype condeff
Description The specific equipment unit, facility, link, or packet link in the NE, depending on the message code modifier, to which the alarm pertains. Refers to the type of access identifier. Type of alarm See CHAPTER 5, TL1 CONDITION TYPES for more information. Indicates the effect of the event on the condition of the NE. The event may initiate a standing condition, which can later be retrieved using the RETRIEVECONDITION command or may initiate a transient condition that does not change the basic condition of the NE for an extended time period. Valid values for <condeff> are as follows: CL- standing condition cleared SC- standing condition raised TC- transient condition A null value for <condeff> defaults to TC. Parameter grouping is not used with this parameter. Date of event occurrence
ocrdat
2-6
ONLINE 7000/9000/11000
TM
Message ocrtm locn
Description Time of day of event occurrence Location of the event relative to the entity identified by the AID. Thus, near end refers to events occurring at the identified entity, and far end refers to events occurring at a distant entity that is connected to the identified entity. Likewise, LINE[-x] refers to an intermediate point. The <dirn> is the direction of the event and is relative to the entity identified by the AID. The direction of the alarm relative to the entity identified by the AID. Measured value of a monitored parameter, which may contain data related to transmission performance or circuit activity if <condtype> is of the form T-x for a threshold violation on <montype> x. This data is in the form of numeric counts or rates. This value should be provided if this event report is the result of a threshold for a monitored parameter exceeding the defined or specified threshold level. The accumulation time period for the performance monitoring information if <condtype>is of the form T-x for a threshold violation on <montype> x. Detailed text description of the specific event that caused this notification.
dirn monval
tmper conddescr
Protection Switching Mapping Table 2-1 defines the mapping between internal protection switch causes and the <condtype. used in REPT EVT autonomous messages.
Table 2-1. Protection Mapping Definitions Internal Cause autoSwitch autoSwitchFailed autoSwitchFailed autoSwitchRelease autoSwitchReleaseFailed manualSwitch manualSwitchFailed manualSwitchRelease manualSwitchReleaseFailed forcedSwitch forcedSwitchFailed forcedSwitchRelease TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
Reported by Working/Protection WKSWPR FAILTOSW FAILTOSW WKSWBK FAILTORLS MANWKSWPR FAILTOSW MANWKSWBK FAILTORLS FRCDWKSWPR FAILTOSW FRCDWKSWBK
2-7
2
TL1 AUTONOMOUS MESSAGES ONLINETM7000/9000/11000
Table 2-1. Protection Mapping Definitions (Continued) Internal Cause forcedSwitchReleaseFailed lockout lockoutFailed lockoutRelease lockoutReleaseFailed Reported by Working/Protection FAILTORLS LOCKOUTOFPR FAILTOSW LOCKOUTOFWK FAILTORLS
2-8
ONLINE 7000/9000/11000
TM
REPT PM
report performance monitoring
Purpose This autonomous message is generated by an NE to inform the OS or maintenance personnel of performance monitoring information. Parameters are provided to report performance monitoring data from multiple data collection intervals in a single message for NEs that store a history of performance monitoring information. REPT PM is an automatic message that is generated by the NE as a result of a previous schedule-performance reporting SCHED PMREPT command received by the NE. NEs should not send an REPT PM unless a schedule has been created using SCHED-PMREPT. Autonomous Identification
<cr><lf>A^^<atag>^REPT^PM^(LINK|SYNCN|<rr>}
Parameter almcde (A) atag rr
Description Alarm code indicates the severity of the autonomous message. Autonomously generated correlation tag Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

^^^"[<aid>[,<aidtype>]:<montype>,<monval>,[<vldty>],[<locn>],[<dirn>],[<tmper>] ,[<mondat>],[<montm>]"<cr><lf>
Message aid aidtype montype monval
Description The specific equipment unit, facility, link, or packet link in the NE, depending on the message code modifier, to which the alarm pertains. Refers to the type of access identifier. Type of monitored parameter whose value is being reported. Measured value of a monitored parameter, which may contain data related to transmission performance or circuit activity if <condtype> is a threshold violation. This data is in the form of numeric counts or rates. This value should be provided if this alarm report has resulted from a degradation that has exceeded the defined or specified threshold level. Validity indicator for the reported PM data. It indicates whether the information for the specified time period was accumulated over the entire time period or some portion of it.
vldty
2-9
2
Message locn Description Location In reference to the entity identified by the <aid>, from where the PM value is being reported. Thus, near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. The direction of the alarm relative to the entity identified by the AID. The accumulation time period for the performance monitoring information if <condtype> is of the form T-x for a threshold violation on <montype> x. Date of the beginning of the performance monitoring period specified in <tmper>. Beginning time of day of the performance monitoring period specified in <tmper>.
ONLINETM7000/9000/11000
dirn tmper mondat montm
2 - 10
ONLINE 7000/9000/11000
TM
REPT RMV
report removal
Purpose This event is generated by an NE after it has autonomously removed from service an equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE. An automatic report for the occurrence of an alarm or event that triggers the removal may be associated with the message. Autonomous Identification
<cr><lf><almcde>^<atag>^REPT^RMV^{EQPT|COM|LINK|SYNCN|<rr>}
Description Alarm code Autonomously generated correlation tag Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

^^^"<aid>[,<aidtype>][:<state>]" <cr> <lf>
Message aid aidtype state
Description The specific equipment unit, facility, link, or packet link in the NE, depending on the message code modifier, to which the alarm pertains. Refers to the type of access identifier. Gives the full state into which the entity is placed.
2 - 11
2
TL1 AUTONOMOUS MESSAGES REPT RST
report restoration
Purpose This report is sent by an NE after it has autonomously restored to service an equipment unit, a facility, subscriber line, trunk, link, packet link, or signaling link that previously was autonomously removed from service. An automatic report for the clearance of an alarm or event that triggers the restoration may be associated with the message. Autonomous Identification
<cr><lf><almcde>^<atag>^REPT^RST^{EQPT|COM|LINK|SYNCN|<rr>}
ONLINETM7000/9000/11000
Parameter aid aidtype state

^^^"<aid>[,<aidtype>][:<state>]" <cr> <lf>
Message aid aidtype state
2 - 12
ONLINE 7000/9000/11000
TM
EVENT TYPE MAPPING

Table 2-2 summarizes specific event types and the associated autonomous messages.
Table 2-2. Event Type Mapping Event Communications alarm event Processing error alarm event Equipment alarm event Environmental alarm event Attribute value change event Object creation event Object deletion event State change event Restart event Threshold crossing event Protection switch report event Clock reference switch report event Scheduled PM event Autonomous Message REPT ALM <rr> REPT ALM <rr> REPT ALM <rr> REPT ALM ENV REPT DBCHG REPT DBCHG REPT DBCHG REPT RMV <rr>, REPT RST <rr>, REPT DBCHG REPT EVT EQPT REPT EVT <rr> REPT EVT COM | <rr> REPT EVT SYNCN REPT PM <rr>
2 - 13
2
TL1 AUTONOMOUS MESSAGES ONLINETM7000/9000/11000
2 - 14
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
CHAPTER 3 TL1 COMMANDS

This chapter describes the currently supported ONLINE TL1 commands in the following sections.
u u u u u u
Security Commands on page 3-2 Terminal Session Commands on page 3-30 Alarm Surveillance Commands on page 3-37 Maintenance Commands on page 3-61 Performance Monitoring Commands on page 3-78 Provisioning Commands on page 3-92
3-1
3
TL1 COMMANDS SECURITY COMMANDS
Use the security commands to control the user accounts for the NE. All access privileges and securityrelated parameters can be configured, modified, deleted, and viewed for individual users and groups of users. This section describes the following security commands:
u u u u u u u u u u u u u u u u u u u u
ONLINETM7000/9000/11000
ACT-PRIV-SECU on page 3-3 ACT-USER on page 3-4 ALW-USER-SECU on page 3-5 CANC-PRIV-SECU on page 3-6 CANC-SESSION on page 3-7 CANC-SESSION-SECU on page 3-8 CANC-USER on page 3-9 DLT-GROUP-SECU on page 3-10 DLT-USER-SECU on page 3-11 ED-PID on page 3-12 ED-GROUP-SECU on page 3-13 ED-USER-SECU on page 3-15 ENT-GROUP-SECU on page 3-17 ENT-USER-SECU on page 3-19 INH-USER-SECU on page 3-21 RTRV-GROUP-SECU on page 3-22 RTRV-PRIV-SECU on page 3-24 RTRV-SESSION on page 3-26 RTRV-SESSION-SECU on page 3-27 RTRV-USER-SECU on page 3-29
3-2
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ACT-PRIV-SECU
activate-privilege-security
Purpose Activate privileges associated with a specified group ID. Privileges cannot be modified for the administrator account. User Input Syntax
ACT-PRIV-SECU:[<tid>]:<gid>:[<ctag>]::<gap>;
Parameter tid
Description Target identifier The name of the network element where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier Correlation tag Group access privilege. A value of ALL can be used to specify all access privileges. See CHAPTER 7, GROUP ACCESS PRIVILEGES for more details.
gid ctag gap
System Response Syntax u Normal A normal output response is an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid correlation tag Input - invalid target identifier Privilege - illegal user identity Privilege - illegal command code Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed Status- invalid request
Error Code ICNV IDNV IICT IITA PIUI PICC PLNA SCNF SDBE SROF SRQN
3-3
3
TL1 COMMANDS ACT-USER
activate-user
Purpose Allow users to log in to the system. A normal response is returned if the login request is accepted. User Input Syntax
ACT-USER:[<tid>]:<uid>:[<ctag>]::<pid>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. User identification or login name. This field is case sensitive. Correlation tag. Password of the user indicated in <uid>. This field is case sensitive.
uid ctag pid
System Response Syntax u Normal A normal output response is a comment block containing login, version, and contact information.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag
Error Code ICNV IICT
NOTE:
Per TR-NWT-000835, it is required that no error code be transmitted except to convey that the login is granted (or denied). Providing more detailed error responses is considered a security issue and is not recommended.
3-4
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ALW-USER-SECU
allow-user-security
Purpose Allow an appropriate administrator to activate a user account. User Input Syntax
ALW-USER-SECU:[<tid>]:<uid>:[<ctag>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. User identification or login name. This field is case sensitive. Correlation tag.
uid ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - illegal user identity Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed Status- invalid request
Error Code ICNV IDNV IICT IITA PICC PIUI PLNA SCNF SDBE SROF SRQN
3-5
3
TL1 COMMANDS CANC-PRIV-SECU
cancel-privilege-security
Purpose Cancel privileges that are associated with a specified group ID. Privileges cannot be modified for the administrator account. User Input Syntax
CANC-PRIV-SECU:[<tid>]:<gid>:[<ctag>]::<gap>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier. This field is case sensitive. Correlation tag. Group access privilege. A value of ALL can be used to specify all access privileges. The field is case sensitive. See CHAPTER 7, GROUP ACCESS PRIVILEGES for more details.
gid ctag gap
u
3-6
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
CANC-SESSION
cancel-session
Purpose Closes the current session. To close sessions other than the current session use the CANC-SESSIONSECU command. User Input Syntax
CANC-SESSION:[<tid>]::[<ctag>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Correlation tag
ctag
u
3-7
3
TL1 COMMANDS CANC-SESSION-SECU
cancel-session-user
Purpose Close any session, including the sessions of other users. User Input Syntax
CANC-SESSION-SECU:[<tid>]:<snid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Session identification Correlation tag
snid ctag
u
ErrorA standard error response indicates one of the following error codes. Description Input - command not valid Input - invalid correlation tag
3-8
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
CANC-USER
cancel-user
Purpose Terminate a TL1 session at the NE. A normal response is returned if the command is accepted. User Input Syntax
CANC-USER:[<tid>]:[<uid>]:[<ctag>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. User identification or login name, or null to log off the current user. This field is case sensitive. Correlation tag.
uid ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Privilege - illegal user identity Input - login not active
Error Code ICNV IICT PIUI PLNA
3-9
3
TL1 COMMANDS DLT-GROUP-SECU
delete-group- security
Purpose Delete the security parameters that are associated with a specific group ID. This task deletes only empty groups; groups that contain members cannot be deleted. User Input Syntax
DLT-GROUP-SECU:[<tid>]:<gid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier. This field is case sensitive. Correlation tag.
gid ctag
System Response Syntax u NormalA normal output response is an empty text block.
u
NOTE:
Since the GID is a unique identifier of a group, the NE shall transmit PIUI as the error message if the new GID is already in use
3 - 10
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-USER-SECU
delete-user-security
Purpose Remove the security parameters that are associated with a specified user. This task is performed by an appropriate administrator and is applicable for closing a user account. User Input Syntax
DLT-USER-SECU:[<tid>]:<uid>:[<ctag>];
Parameter tid
Description Target identifier. The name of the network element where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. The user identification or login name. Correlation tag.
uid ctag
u
3 - 11
3
TL1 COMMANDS ED-PID
edit-password
Purpose Change the password that is used for logging in to the NE. This command is available to any valid user to edit the users own password. A normal response is returned if the command is accepted. User Input Syntax
ED-PID:[<tid>]:<uid>:[<ctag>]::<oldpid>,<newpid>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. The user identification or login name. The field is case sensitive. Correlation tag. Old password. The field is case sensitive. New password. The field is case sensitive.
uid ctag oldpid newpid
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Privilege - illegal user identity Privilege - login not active
Error Code ICNV IICT PIUI PLNA
3 - 12
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ED-GROUP-SECU
edit-group-security
Purpose Edit the security parameters that are associated with a specified user group. This command allows an appropriate administrator to edit the name of the group. All members of the group are updated to be members of the new group name. User Input Syntax
ED-GROUP-SECU:[<tid>]:<oldgid>:[<ctag>]::<newgid>:[<gdcrn>],[<gfnm>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier. This field is case sensitive. New group identifier. This field is case sensitive. Correlation tag. The Group Description The group Full Name
oldgid newgid ctag gdcrn gfnm
u
3 - 13
3
TL1 COMMANDS
NOTE:
ONLINETM7000/9000/11000
Because the GID is a unique identifier of a group, the NE transmits PIUI as the error message if the new GID is already in use.
3 - 14
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ED-USER-SECU
edit-user-security
Purpose Modify security parameters associated with a specified user account. This command allows the administrator to edit the users password, group ID, and activity status. User Input Syntax
ED-USER-SECU:[<tid>]:<uid>:[<ctag>]::,[<pid>],,[<gid>]:[<udcrn>],[<ufnm>];
Parameter tid
Description Target identifier The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag User identifier User password Group identifier The User Description The User Full Name
ctag uid pid gid udcrn ufnm
NOTE:
Only one of the <pid> and <gid> fields can be modified per command execution. Requests to modify more than one of these fields per command execution is rejected.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - illegal user identity Privilege - login not active
Error Code ICNV IDNV IICT IITA PICC PIUI PLNA
3 - 15
3
TL1 COMMANDS
SCNF SDBE SROF SRQN Status - command not valid Status - internal database error Status - requested operation failed Status- invalid request
ONLINETM7000/9000/11000
NOTE:
Because the UID is a unique user identification, the NE shall transmit PIUI as the error message if the new UID is already in use. If the new PID is illegal, there shall be the same error message PIUI.
NOTE:
If the UAP is illegal, the corresponding error message shall be PIUC. PIUC shall also be transmitted if the only supervisor (such as the appropriate administrator) attempts selfdemotion to a lower authorization level, thus causing a situation where there would be no remaining user with proper authorization level to issue NESSA commands.
3 - 16
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ENT-GROUP-SECU
enter-group-security
Purpose Set security parameters that is associated with a specified group ID. This command is used by an appropriate administrator and creates a new group that initially contains no privileges or members. User Input Syntax
ENT-GROUP-SECU:[<tid>]:<gid>:[<ctag>]:::[<gdcrn>],[<gfnm>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier. This field is case sensitive. Correlation tag. The Group Description The group Full Name
gid ctag gdcrn gfnm
u
3 - 17
3
TL1 COMMANDS
NOTE:
ONLINETM7000/9000/11000
Because the GID is a unique identifier of a group, the NE transmits PIUI as the error message if the new GID is already in use.
3 - 18
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ENT-USER-SECU
enter-user-security
Purpose Set the security parameters that are associated with a user ID. This command allows an appropriate administrator to enter the user ID, password, group ID, and activity status. User Input Syntax
ENT-USER-SECU:[<tid>]:<uid>:[<ctag>]::<pid>,,<gid>:<act>,[<udcrn>],[<ufnm>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. User identifier. This field is case sensitive. User password Group identifier User activity status The User Description The User Full Name
uid pid gid act udcrn ufnm
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid correlation tag Input - invalid target identifier Privilege - illegal user identity Description Privilege - illegal command code Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed
Error Code ICNV IDNV IICT IITA PIUI Error Code PICC PLNA SCNF SDBE SROF
3 - 19
3
TL1 COMMANDS
SRQN Status - invalid request
ONLINETM7000/9000/11000
NOTE:
Because the UID is a unique identifier of a user, the NE shall transmit PIUI as the error message if the new UID is already in use. If the new PID is illegal, there shall be the same error message PIUI.
NOTE:
If the UAP is illegal, the corresponding error message shall be PIUC. PIUC shall also be transmitted if the only supervisor (such as the appropriate administrator) attempts selfdemotion to a lower authorization level, thus causing a situation where there would be no remaining user with proper authorization level to issue NESSA commands.
3 - 20
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
INH-USER-SECU
inhibit-user-security
Purpose Allow an appropriate administrator to temporarily disable a user account. To permanently remove a user account use the DLT-USER-SECU command. User Input Syntax
INH-USER-SECU:[<tid>]:<uid>:[<ctag>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. The user identification or login name. This field is case sensitive. Correlation tag.
uid ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input- command not valid Input - command not valid Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - illegal user identity Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed Status- invalid request
3 - 21
3
TL1 COMMANDS RTRV-GROUP-SECU
retrieve-group-security
Purpose Retrieve the security parameters associated with a specific group ID. This command allows retrieval of a list of groups, a list of group members, or a list of all members for every group. User Input Syntax
RTRV-GROUP-SECU:[<tid>]:[<gid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier. If this is null, all groups are displayed. This field is case sensitive. Correlation tag.
gid ctag
NOTE:
If a GID is not specified, all of the groups on the NE are displayed without the UID. If a GID is specified, all UIDs for that GID are displayed.
NOTE:
If a GID of all is specified, all UIDs of all GIDs are displayed. If a group does not contain any UIDs, the group name is displayed without a GID.
System Response Syntax u NormalA normal response is:

^^^"<gid>[:<uid>],[<gdcrn>],[<gfnm>];"<cr><lf>
Parameter gid uid gdcrn gfnm
Description Group identifier. User identifier. The Group Description The group Full Name
3 - 22
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid correlation tag input - invalid target identifier privilege - illegal command code privilege - illegal user identity privilege - login not active status - command not valid status - internal database error status - requested operation failed status- invalid request
3 - 23
3
TL1 COMMANDS RTRV-PRIV-SECU
retrieve-privilege-security
Purpose Retrieve the privileges that are associated with a single group or all groups. User Input Syntax
RTRV-PRIV-SECU:[<tid>]:[<gid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Group identifier. Correlation tag.
gid ctag
NOTE:
If the GID is not specified, all GAPs for all GIDs are displayed. If the GID is specified, only the GAPs for the specified group are displayed.
NOTE:
If a group does not contain any GAPs, the group name is displayed without a GAP.

^^^"<gid>[:<gap>]"<cr><lf>
Parameter gid gap
Description Group identifier. Group access privilege. See CHAPTER 7, GROUP ACCESS PRIVILEGES for more details.
3 - 24
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
3 - 25
3
TL1 COMMANDS RTRV-SESSION
retrieve-session
Purpose This command is for retrieving parameters associated with the current session. To retrieve parameters for sessions other that the current use the RTRV-SESSION-SECU command. User Input Syntax
RTRV-SESSION:[<tid>]::[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters.
ctag
Correlation tag

^^^" <snid>,<sstat>:[<ipaddr>,<tmout>,<uid>,<rmtcnt>]:[<gwsnid>, <target>]"<cr><lf>
Parameter snid sstat ipaddr tmout uid rmtcnt gwsnid target

u
Description A session identifier Session status IP address of the client The inactivity timeout for the session. The users identification or login name The count of remote sessions which are operating over the session. Identifier of the gateway session that a remote session is hosted by. System identifier of the sessions target network element.
3 - 26
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-SESSION-SECU
retrieve-session-security
Purpose Retrieve parameters that are associated with any session, including the sessions of other users. User Input Syntax
RTRV-SESSION-SECU:[<tid>]:[<snid>]:[<ctag>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Session identification. ALL is supported and implied when this parameter is empty. Correlation tag.
snid ctag
NOTE:
If the GID is not specified, all GAPs for all GIDs are displayed. If the GID is specified, only the GAPs for the specified group are displayed.
NOTE:
If a group does not contain any GAPs, the group name is displayed without a GAP.

^^^" <snid>,<sstat>:[<ipaddr>,<tmout>,<uid>,<rmtcnt>]: [<gwsnid>,<target>]" <cr><lf>
Parameter snid sstat ipaddr tmout uid rmtcnt gwsnid target
Description A session identifier. Session status. IP address of the client. The inactivity timeout for the session. The users identification or login name. The count of remote sessions which are operating over the session. Identifier of the gateway session that a remote session is hosted by. System identifier of the sessions target network element.
3 - 27
3
TL1 COMMANDS
u
ONLINETM7000/9000/11000
3 - 28
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-USER-SECU
retrieve-user-security
Purpose Allow an appropriate administrator to retrieve the security parameters that are associated with a user or a group. This command does not allow the administrator to retrieve any users password. User Input Syntax
RTRV-USER-SECU:[<tid>]:[<uid>]:[<ctag>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. The user identifier or login in name. This field is case sensitive. Entering a UID retrieves security information for that specific user. Masking a null entry (pressing the Enter key, a carriage return) retrieves data for all users. Correlation tag.
uid
ctag

^^^"<uid>::<gid>:<act>,<udcrn>,<ufnm>"<cr><lf>
Parameter uid gid act udcrn ufnm
Description User identifier Group identifier Activity status The User Description The User Full Name
3 - 29
3
TL1 COMMANDS TERMINAL SESSION COMMANDS
The terminal session commands are used to modify current, future, and default terminal session properties. The following commands are used to modify terminal sessions.
u u u u u u
ONLINETM7000/9000/11000
ED-TRMNL-DFLT on page 3-31 ED-TRMNL-SES on page 3-32 RTRV-TRMNL-DFLT on page 3-33 RTRV-TRMNL-SES on page 3-34 SET-ATTR-SECUDFLT on page 3-35 SET-SESSION on page 3-36
See RTRV-SESSION on page 3-26 to view the inactivity timeout for the current session.
3 - 30
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ED-TRMNL-DFLT
edit-terminal default
Purpose Modify the default properties related to future terminal sessions. This command affects only future sessions and does not modify the current session nor any other active sessions. User Input Syntax
ED-TRMNLDFLT:[<tid>]::[<ctag>]:::[COLWIDTH=<colwidth>][,ECHO=<echo>][,EDIT=<edit>][,INS ERT=<insert>][,HISTBUF=<histbuf>][,MODE=<mode>][,PWMASK=<pwmask>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag The number of characters allowed per line on the Telnet client. If empty, this value is not changed. The ability to echo characters from the TL1 server. If empty, this value is not changed. The ability to edit lines of text. If empty, this value is not changed. The state of the insert/overwrite mode. If empty, this value is not changed. The NE default size of the history buffer. If empty, this value is not changed. The trigger mode for enabling the human mode (convenience keystroke). If empty, this value is not changed. The NE default state of the password masking mode. If empty, this value is not changed.
ctag colwidth echo edit insert histbuf mode pwmask
u
Error A standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid correlation tag Status - requested operation failed
Error Code ICNV IDNV IICT SROF
3 - 31
3
TL1 COMMANDS ED-TRMNL-SES
edit-terminal-session
Modifies the properties related to the current terminal session. This command affects only the current session and does not modify the future session nor any other active sessions. User Input Syntax
ED-TRMNL-SES:[<tid>]::[<ctag>]:::[COLWIDTH=<colwidth>][,ECHO=<echo>][,EDIT= <edit>][,HISTBUF=<histbuf>]
ONLINETM7000/9000/11000
Parameter tid ctag colwidth echo edit histbuf
Description Target identifier. This command is effective on only the session to which the terminal is connected. Correlation tag Number of characters allowed per line on the Telnet client. If empty, this value is not changed. (Current session only) Ability to echo characters from the TL1 server. If empty, this value is not changed. (Current session only) Ability to edit lines of text. If empty, this value is not changed. (Current session only) Size of the history buffer. If empty, this value is not changed. (Current session only)
System Response Syntax u Normal A normal output response is an empty text block
u
3 - 32
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-TRMNL-DFLT
retrieve-terminal-default
Purpose Retrieve the default properties related to future terminal sessions. User Input Syntax
RTRV-TRMNL-DFLT:[<tid>]::[<ctag>];
Parameter tid
Description Target identifier This command is only effective only on the session the terminal is connected to. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag
ctag

^^^"DEFAULT::ECHO=<echo>,EDIT=<edit>,COLWIDTH=<colwidth>,INSERT=<insert>,HISTBU F=<histbuf>,MODE=<mode>,PWMASK=<pwmask>"<cr><lf>
Parameter echo edit colwidth insert histbuf mode pwmask

u
Description The ability to echo characters from the TL1 server The ability to edit lines of text The number of characters allowed per line on the Telnet client The state of the insert/overwrite mode The NE default size of the history buffer The trigger mode for enabling the human mode (convenience keystroke) The NE default state of the password masking mode.
3 - 33
3
TL1 COMMANDS RTRV-TRMNL-SES
retrieve-terminal-session
Purpose Retrieve the properties related to the current terminal session. User Input Syntax
RTRV-TRMNL-SES:[<tid>]::[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier This command is only effective only on the session the terminal is connected to. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag
ctag

^^^"SESSION::ECHO=<echo>,EDIT=<edit>,COLWIDTH=<colwidth>,HISTBUF=<histbuf>" <cr><lf>
Parameter echo edit colwidth histbuf

u
Description The ability to echo characters from the TL1 server The ability to edit lines of text The number of characters allowed per line on the Telnet client The NE default size of the history buffer
3 - 34
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
SET-ATTR-SECUDFLT
set-attribute-security default
Purpose Modify the default properties related to security. User Input Syntax
SET-ATTR-SECUDFLT:[<tid>]::[<ctag>]::TMOUT=<tmout>;
Parmeter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Correlation tag. The new inactivity timeout value. This is the logged-in inactivity timeout and is not used when a user is not logged into a session.
ctag tmout
u
Error A standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag
3 - 35
3
TL1 COMMANDS SET-SESSION
set-session
Purpose Modify the properties of the current session. User Input Syntax
SET-SESSION:[<tid>]::[<ctag>]::<tmout>;
ONLINETM7000/9000/11000
Parmeter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Correlation tag. The new inactivity timeout value.
ctag tmout
u
Error A standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag
Error ICNV IICT
3 - 36
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ALARM SURVEILLANCE COMMANDS

Use the TL1 alarm surveillance commands to retrieve alarm reports from specified NEs. Alarms are generated as a result of events detected by the ONLINE NE. This section contains descriptions of the ONLINE TL1 alarm surveillance commands in the following sections:
u u u u u u u u u u u u u u
ALW-MSG on page 3-38 ASGN-ASAP on page 3-40 DLT-ASAP on page 3-41 ED-ASAP on page 3-42 ENT-ASAP on page 3-43 INH-MSG on page 3-44 RTRV-ALM on page 3-46 RTRV-ALM-ENV on page 3-49 RTRV-ASAP on page 3-51 RTRV-COND on page 3-53 RTRV-COND-SYNCN on page 3-55 RTRV-DFLT-ASAP on page 3-57 SET-NE-ALL on page 3-58 UNASGN-ASAP on page 3-60
3 - 37
3
TL1 COMMANDS ALW-MSG
allow-message
Purpose Permit an NE to resume transmission of automatic messages to an OS after being in the inhibitmessage(INH-MSG) mode. Parameters are provided to selectively enable messaging. Unreported alarms in existence at the time of resumption should be transmitted to the OS with the REPT ALM message. Unreported non-alarmed standing conditions in existence at the time of resumption should be transmitted to the OS with the REPT EVT message. Allow-message commands sent on one OS or NE, or user session, should not impact other sessions. Any NE whose messages are inhibited with the INH-MSG command should include the appropriate condition type information in response to a retrieve-condition request. See INH-MSG for related information. User Input Syntax
ALW-MSG-{EQPT|<rr>|LINK|SYNCN|COM|ALL}:[<tid>]:[<aid>]:[<ctag>]:[<ntfcncde>], [<condtype>][,<tmper>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Access identifier. Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all AIDs are affected. Correlation tag. Notification code associated with the alarm conditions being retrieved. Type of alarm condition to retrieve. See CHAPTER 5, TL1 CONDITION TYPES for more details.
tid
aid
ctag ntfcncde condtype
3 - 38
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
System Response Syntax u The normal output response is an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Input - invalid target identifier Privilege - login not active Status - command not active Status - requested operation failed
Error Code ICNV IICT IITA PLNA SCNF SROF
3 - 39
3
TL1 COMMANDS ASGN-ASAP
assign-alarm severity assignment profile
Purpose Instruct an NE to attach an ASAP profile with one or more entities. User Input Syntax
ASGN-ASAP:[<tid>]:<aid>:[<ctag>]::[<instanceAid>];
ONLINETM7000/9000/11000
Parameter tid
aid ctag instanceAid
Access identifier The AID of the ASAP to retrieve. Correlation tag The entity instance aid. Specifies the entity to which the ASAP is applied. ALL is not valid for this parameter in an assign
System Response Syntax u ErrorA standard error response indicates one of the following error codes: Error Code IDNV IIAC IICT IIPG IITA INUP SROF SDBE Description Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Status-requested operation failed Status-internal database error
3 - 40
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-ASAP
delete-alarm severity assignment profile
Purpose Delete an existing ASAP profile. Entities previously assigned to this ASAP with the ASGN-ASAP command must first be unassigned using the UNASGN-ASAP command before the ASAP may be deleted. Syntax
DLT-ASAP:[<tid>]:<aid>:[<ctag>];
Parameter tid aid ctag
Description Target identifier Agent identifier. Correlation tag.
System Response Syntax u The normal output response is an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input- data not valid Input - invalid correlation tag Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Input-parameter missing Status-internal database error Status - requested operation failed
Error Code ICNV IDNV IICT IIPG IITA INUP IPMS SDBE SROF
3 - 41
3
TL1 COMMANDS ED-ASAP
edit-alarm severity alarm profile
Purpose ED-ASAP is used to modify the list of <probcause> - <ntfcncde> pairs in an ASAP profile. If a valid <ntfcncde> is entered with a corresponding <probcause> the pair is added. If the <ntfcncde> is empty the pair is removed. User Input Syntax
ED-ASAP:[<tid>]:<aid>:[<ctag>]::<probcause>[,<ntfcncde>]:[qualifier>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. The AID of the ASAP. Correlation tag. The alarm condition(s) being reported. See Mapping Probable Cause to TL1 Condition Types on page 5-4 Notification code associated with the alarm conditions being retrieved. Grouping is not supported for this parameter. If the value is left empty, the probable cause is removed from the ASAP list. Is a descriptor for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical.
aid ctag probcause ntfcncde
qualifier
u u
NormalA normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Status-requested operation failed Status-invalid request
Error Code IDNV IIAC IICT IIFM IIPG IITA INUP SROF SRQN
3 - 42
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ENT-ASAP
enter-alarm severity assignment
Purpose ENT-ASAP is used to create an Alarm Severity Assignment Profile (ASAP.) Using the ED-ASAP command, the user may then specify a notification code <ntfcncde> for each specified probable cause <probcause>. This profile can then be associated with one or more entities using the ASGN-ASAP command. The resulting ASAP applies the user-chosen ntfcncde for the specified probcause for each of the entities to which it is assigned. User Input Syntax
ENT-ASAP:[<tid>]:<aid>:[<ctag>];
Parameter tid
Description Target identifier The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. The AID of the ASAP. Correlation tag.
aid ctag
u u
NormalA normal response is a normal output response with an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid correlation tag Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Input-parameter missing Status-requested operation failed Status-invalid request
Error Code IDNV IICT IIPG IITA INUP IPMS SROF SRQN
3 - 43
3
TL1 COMMANDS INH-MSG
inhibit-message
Purpose Instruct an NE to enter a mode in which certain automatic messages associated with a specific equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link are prevented from being transmitted to the OS. This command only applies to the OS/NE or user session on which this command is sent. Parameters are provided to selectively disable messaging. This command should not have any effect on indicators in the office where the NE resides or on the NE itself. During the entire period of message inhibition, the NE should continue to respond fully to RETRIEVE-ALARM and RETRIEVE-CONDITION requests. The condition may be restored to normal with the ALLOW-MESSAGE command. Any NE with an INH-MSG in effect should include the appropriate condition type information in response to a RETRIEVE-CONDITION request. See ALW-MSG for related information. User Input Syntax
INH-MSG-{EQPT|<rr>|LINK|SYNCN|COM|ALL}:[<tid>]:[<aid>]:[<ctag>]:: [<ntfcncde>],[<condtype>][,<tmper>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Access Identifier. Identifies the single equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag. Notification code associated with the alarm conditions being retrieved. Type of alarm condition to retrieve. See CHAPTER 5, TL1 CONDITION TYPES for more details. Accumulation time period for PM parameters. When <condtype> is of the form T-x for a threshold violation on <montype> x (valid values for x are shown in Appendix E), the value of <tmper> identifies the accumulation time period. When <condtype> is not of the form T-x, <tmper> does not pertain and must be null.
tid
aid
ctag ntfcncde condtype tmper
u u
NormalA normal response is a normal output response with an empty text block. ErrorA standard error response indicates one of the following error codes: TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
3 - 44
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Description Input - command not valid Input - invalid correlation tag Input - invalid target identifier Privilege - login not active Status - command not found Status-requested operation failed
3 - 45
3
TL1 COMMANDS RTRV-ALM
retrieve-alarm
Purpose Instruct an NE to retrieve and send the current status of its alarm conditions associated with one or more equipment units, facilities, links or packet links within the NE. The command may be used to retrieve NE information, which in turn may be used to update an OS database when it is suspected that autonomous alarm messages issued by the NE using REPORT ALARM were not received or properly processed. It may also be used to evaluate the system before or after NE maintenance operations. The alarm conditions to be retrieved can be specified by using the input parameters as the filter. For example, existing conditions satisfying all the specified input parameters are reported in the message response. To receive environmental alarms, use the RTRV-ALM-ENV command rather than the RTRV-ALM command. User Input Syntax
RTRV-ALM-{EQPT|COM|LINK|SYNCN|ALL|<rr>}:[<tid>]:[<aid>]:[<ctag>]:: [<ntfcncde>],[<condtype>],[<srveff>],[<locn>],[<dirn>][,<tmper>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Access Identifier. Identifies the single equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag. Notification code associated with the alarm conditions being retrieved. Null value defaults to display all values. Type of alarm condition to retrieve. See CHAPTER 5, TL1 CONDITION TYPES for more details. Effect on service that is caused by the alarm condition. Null value defaults to display all values. Location. Refers to the entity identified by the <aid>. Null value defaults to display all values. Near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. A null input value defaults to all applicable directions.
tid
aid
ctag ntfcncde condtype srveff locn
3 - 46
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter dirn tmper
Description Direction of monitoring relative to the entity defined by the <aid>. Grouping is not available. Null value defaults to display all values. Accumulation time period for PM parameters. When <condtype> is of the form T-x for a threshold violation on <montype> x, the value of <tmper> identifies the accumulation time period. When <condtype> is not of the form T-x, <tmper> does not pertain and must be null.

^^^"<aid>[,<aidtype>]:<ntfcncde>,<condtype>,<srveff>,[<ocrdat>],[<ocrtm>],[<loc n>],[<dirn>][,<tmper>][:[<conddescr>],]"<cr><lf>
Parmeter aid
Description Access Identifier. Identifies the single equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Refers to the type of access identifier. Two-character notification code associated with a single alarm condition. Single type of alarm condition being reported on this particular line. See CHAPTER 5, TL1 CONDITION TYPES for more details. Effect on service caused by the alarm condition. Date when the triggering event occurred. Time of day when the triggering event occurred. (Not supported for output since everything is near end.) Refers to the entity identified by the <aid>. Near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. A null input value defaults to all applicable directions. (Not currently supported for output.) Direction of monitoring relative to the entity defined by the <aid>. Accumulation time period for PM parameters. When <condtype> is of the form T-x for a threshold violation on <montype> x, the value of <tmper> identifies the accumulation time period. When <condtype> is not of the form T-x, <tmper> does not pertain and must be null. Detailed text description of the trouble. This field must be limited to 64 characters enclosed within escaped quotes (\") for a maximum of 68 characters (counting the escaped quotes).
aidtype ntfcncde condtype srveff ocrdat ocrtm locn
dirn tmper
conddescr
3 - 47
3
TL1 COMMANDS
u
ONLINETM7000/9000/11000
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Input - Invalid target identifier Privilege - login not active Status - command not valid Status - requested operation failed
3 - 48
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-ALM-ENV
retrieve alarm environment
Purpose Request that an NE or office environment monitor retrieve specified, outstanding environmental alarms. The command can be used to retrieve NE information. In turn, this information may be used to update an OS environmental alarm database if it is suspected that autonomous alarm messages issued using the REPTALM-ENV command are not being received or properly processed. User Input Syntax
RTRV-ALM-ENV:[<tid>]:[<aid>]:[<ctag>]::[<ntfcncde>][,<almtype>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Correlation tag. Notification code for the environmental alarm being requested. Alarm type, as one of the following types:
u u u u
ctag ntfcncde almtype
Null value defaults to display all values. System Response Syntax u NormalIf no alarms, then the output response is an empty block. If one or more outstanding alarms satisfy the request, the normal response is a <rspblk> with the following format:
^^^"<aid>:<ntfcncde>,<almtype>,[<ocrdat>],[<ocrtm>][,<almmsg>]"<cr><lf>
Parameter ntfcncde almtype
Description Notification code for the environmental alarm being retrieved. Alarm type, as one of the following types:
u u u u
ocrdat
Date when the triggering event occurred.
3 - 49
3
TL1 COMMANDS
Parameter ocrtm almmsg Description Time of day when the triggering event occurred. Text message associated with the environmental alarm. It may contain up to 40 characters and must be enclosed within a pair of escaped quotes (\). ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Input - invalid target identifier Privilege - login not active Status - command not found Status-requested operation failed
ONLINETM7000/9000/11000
3 - 50
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-ASAP
retrieve-alarm severity assignment profile
Purpose Retrieve an ASAP profile. By entering an <aid> of "all" or leaving the <aid> empty, all available ASAP profile aids are displayed. By entering a specific <aid>, the <probcause> - <ntfcncde> list and list of entities to which the ASAP is assigned are displayed.
User Input Syntax RTRV-ASAP:[<tid>]:[<aid>]:[<ctag>];
Description Target identifier. The AID of the ASAP to retrieve. If this parameter is null or all, a list of all available ASAP AIDs are displayed. Correlation tag.

u
NormalA normal response is:
<aid>[:<probcause>[,<ntfcncde>]:[<qualifier>][:<instanceAid>]]
Parameter aid probcause ntfcncde qualifier instanceAid

u
Description The aid of the ASAP. The alarm condition(s) being reported. See Mapping Probable Cause to TL1 Condition Types on page 5-4 A two-character notification code associated with the indicated <condtype>. See TL1 CONDITION TYPES on page 5-1. A descriptor for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical. Is a TL1 aid of an entity to which the ASAP is assigned.
ErrorA standard error response indicates one of the following error codes: Description Input-data not valid Input-invalid correlation tag Input-invalid parameter grouping Input-invalid target identifier Input-non-null unimplemented parameter
Error Code IDNV IICT IIPG IITA INUP
3 - 51
3
TL1 COMMANDS
Error Code IPMS SROF SDBE Description Input-parameter missing Status-requested operation failed Status-internal database error
ONLINETM7000/9000/11000
NOTE:
If the <asap> is NULL or ALL, all of the currently existing profiles are displayed without the corresponding <probcause> and <ntfcncde> data. If an <asap> is specified, all <probcause> and <ntfcncde> data is displayed for the specified profile.
3 - 52
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-COND
retrieve-condition
Purpose Instruct an NE to return the standing condition or state that is associated with one or more specified equipment units, facilities, ISDN channels or interfaces, subscriber lines, trunks, links, packet links, signaling links, or test access in the NE. An alternate use is to instruct an NE to return all the AIDs associated with a specified condition or state (typereq). If one or more AIDs or one or more typereq(s) are included in the request, the response relates to the interface of the specified AIDs and typereq(s). It is likely that this command are used in such a way that either the AID or the typereq (but not both) conveys the meaning of "all." User Input Syntax All parameters in this command are positional.
RTRV-COND-{EQPT|COM|LINK|SYNCN|ALL|<rr>}:[<tid>]:[<aid>]:[<ctag>]:: [<typereq>],[<locn>],[<dirn>][,<tmper>];
Parameter rr
Description Facility rate code. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier. Access identifier. Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag. Type of condition or state to be retrieved. Valid values can be any specific condition type (<condtype>), primary state (<pst>), or secondary service state (<sst>) that is defined in Appendix B, TL1 Condition Types. Null value defaults to display all values. Location Refers to the entity identified by the <aid>. Near end refers to PM values obtained at the identified entity. Far end refers to PM values obtained at a distant entity that is connected to the identified entity. Null value defaults to display all values. Direction of monitoring relative to the entity defined by the <aid>. Null value defaults to display all values. Grouping is not supported for this parameter. Accumulation time period for PM parameters. Not supported for input. When <condtype> is of the form T-x for a threshold violation on <montype> x, the value of <tmper> identifies the accumulation time period. When <condtype> is not of the form T-x, <tmper> does not pertain and must be null.
tid aid
ctag typereq
locn
dirn tmper
3 - 53
3
TL1 COMMANDS
^^^"<aid>:[<ntfcncde>],<typereq>,[<srveff>],[<ocrdat>],[<ocrtm>],[<locn>],[<dir n>][,<tmper>],[<conddescr>]" <cr> <lf>
ONLINETM7000/9000/11000
Parameter aid
Description Access Identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, signaling link, or test access in the NE, depending on the command code modifier, to which the desired operation pertain. Two-character notification code associated with a single alarm condition. Single type of alarm condition being reported on this particular line. See CHAPTER 5, TL1 CONDITION TYPES for more details. Effect on service caused by the alarm condition. Date when the triggering event occurred. Time of day when the triggering event occurred. Location In reference to the entity identified by the <aid>. Thus, near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. A null input value defaults to all applicable directions. Direction of monitoring relative to the entity defined by the <aid> Accumulation time period for PM parameters. When <condtype> is of the form T-x for a threshold violation on <montype> x (valid values for x are shown in Appendix E), the value of <tmper> identifies the accumulation time period. When <condtype> is not of the form T-x, <tmper> does not pertain and must be null. Detailed text description of the trouble. This field must be limited to 64 characters enclosed within escaped quotes (\") for a maximum of 68 characters (counting the escaped quotes).
ntfcncde typereq srveff ocrdat ocrtm locn
dirn tmper
conddescr
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Input - invalid target identifier Privilege - login not active Status - command not found Status-requested operation failed
3 - 54
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-COND-SYNCN
retrieve-condition-syncn
Purpose Instructs an NE to return the current standing state associated with a sync source. User Input Syntax
RTRV-COND-SYNCN:[<tid>]:<aid>:[<ctag>];
All parameters in this command are positional.
Description Target identifier. Access identifier. Identifies the equipment unit on which the sync source resides. Correlation tag.

^^^"<aid>:[ACTSRC=<actsrc>][,ACTSIDE=<actside>][,SYNCNMODE=<syncnmode>],RVRTV=< rvrtv>,WTR=<wtr>, LASTREFSWITCHTIME=<lastrefswtime>, SYNCSWITCHSTATUS=<syncswstatus>,ACTIVESYNCUNIT=<actsyncunit><cr> <lf>
Parameter aid actsrc actside syncnmode rvrtv wtr syncswitchstatus astrefswtime actsyncunit
Description Access identifier. The active synchronization source. The port or line-side qualifier ("W"est or "E"ast). This parameter is displayed only for paired ADM cards. The synchronization mode for the specified equipment. Revertive protection mode (Y|N). Wait to restore time in seconds. Sync Switch Status. It displays text: Manual, Force, or Clear. The time when the last switch happened The Sync Unit which is presently active
3 - 55
3
TL1 COMMANDS
u
ONLINETM7000/9000/11000
3 - 56
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-DFLT-ASAP
retrieve-default-alarm severity assignment profile
Purpose Retrieve the default severities for a given probable cause or all probable causes. User Input Syntax
RTRV-DFLT-ASAP:[<tid>]::[<ctag>]::[< probcause>];
Parameter tid ctag probcause
Description Target identifier Correlation tag The alarm condition(s) whose default severity are retrieved. See Mapping Probable Cause to TL1 Condition Types on page 5-4
System Response Syntax u Normal A normal output response is:

<probcause>,<ntfcncde>,<qualifier>
Parameter aid probcause qualifier
Description The AID of the ASAP. The alarm condition(s) being reported. See Mapping Probable Cause to TL1 Condition Types on page 5-4 A description for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical.
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Input - invalid parameter grouping Input - invalid target identifier Privilege - login not active Status - command not found Status-requested operation failed Status - internal database error
Error Code IDNV IICT IIPG IITA INUP IPMS SROF SDBE
3 - 57
3
TL1 COMMANDS SET-NE-ALL
set-network element-all
Purpose Instruct an NE to enter a mode in which certain automatic messages associated with specific event types are allowed to be transmitted or prevented from being transmitted to the OS. This command only applies to the OS/NE or user session on which this command is sent. Parameters are provided to selectively enable or disable messaging. This command should not have any effect on indicators in the office where the NE resides or on the NE itself. If a certain event type is prevented from reporting, the NE should continue to respond fully to RETRIEVErequests associated with the respective message type. User Input Syntax
SET-NE-ALL:[<tid>]::[<ctag>]:::<nameblk>
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag A vendor-specific label associated with specific event categories. The possible values are:
u u u u u
aid
ctag nameblk
[ALM=ON|OFF] [EVT=ON|OFF] [ENV=ON|OFF] [PM=ON|OFF] [DBCHG=ON|OFF]
At least one event type category must be entered.
3 - 58
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
3 - 59
3
TL1 COMMANDS UNASGN-ASAP
delete-alarm severity alarm profile
Purpose Instructs the NE to detach an ASAP profile from one or more entities. User Input Syntax
UNASGN-ASAP:[<tid>]:<aid>:[<ctag>]::[<instanceAid>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. AID of the ASAP to retrieve. Correlation tag. The entity instance aid. Specifies the entity to which the ASAP is applied. ALL is not valid for this parameter in an assign
aid ctag instanceAid
u u
NormalA normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Status-requested operation failed Status-invalid request
Error Code IDNV IIAC IICT IIFM IIPG IITA INUP SROF SRQN
3 - 60
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
MAINTENANCE COMMANDS
Use the TL1 maintenance commands to set specified operation controls on the NE. This section contains the following TL1 maintenance commands.
u u u u u u u u u
EX-SW on page 3-62 INIT-SYS on page 3-64 OPR-ACO on page 3-66 OPR-EXT-CONT on page 3-68 OPR-PROTNSW on page 3-69 OPR-SYNCN on page 3-71 RLS-EXT-CONT on page 3-73 RLS-PROTNSW on page 3-74 RTRV-EXT-CONT on page 3-76
3 - 61
3
TL1 COMMANDS EX-SW
exercise- switching
Purpose Instruct an NE to exercise a switching algorithm from working to protected equipment or facilities. The NE follows all the necessary steps prior to switching, but does not actually perform the switch. The command assumes the equipment or facility being exercised is the working unit. If not, an error message is generated. This command is only supported on OC48 SONET BLSR and STM16 MS_PRing line protected facilities. User Input Syntax
EX-SW-{OC48|STM16}:<tid>:<aid>:<ctag>::[<rspns>][,<protid>][,<dirn>];
ONLINETM7000/9000/11000
Parameter tid aid
Description Target identifier. Access Identifier identifies either the equipment unit or facility in the NE, depending on the command code modifier, for which the switching exercise is being requested. Correlation tag. The response code that indicates whether the results of all exercises or only failed exercises are reported in the response message. Not supported for input. identifies the protection equipment or facility to be used in the switching exercise when there is more than one protection equipment or facility within the NE. Not supported for input. Direction of the transmission and is relative to the entity identified by the <aid>. Not supported for input.
ctag rspns
protid
dirn
3 - 62
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - login not active Status - command not found Status - internal database error Status - requested operation failed Status - invalid request
Error Code ICNV IDNV IIAC IICT IITA PICC PLNA SCNF SDBE SROF SRQN
3 - 63
3
TL1 COMMANDS INIT-SYS
initialize system
Purpose Instruct an NE to initialize its system processor and/or associated subsystems. This function may be used at various levels of thoroughness, referred to as phases. The highest phase initialization is called a "cold restart"; it causes the processor to unconditionally execute the same routine executed on system power-up. By the nature of the function, a normal response cannot be issued after a cold restart command is executed. In this case, the normal response should be sent immediately before the power-up routine is entered. Lower phase initializations represent various levels of less drastic system and subsystem initialization. The shutdown phase causes either the PSM or PEM to perform an orderly shutdown. The INIT-SYS command is used to shut down a circuit pack (CP) before removing it from the NE for maintenance. There is no software method for returning the CP to service; it must be reseated. Executing the INIT-SYS command on any CP other than the PEM or PSM has no effect and generates an appropriate error message. User Input Syntax
INIT-SYS:[<tid>]:<aid>:[<ctag>]::<ph>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Access identifier. Identifies the CP being initialized. To prevent accidental reboot of all cards, for this command, a null AID does not default to ALL; as a result, if this field is left empty, the command is rejected. ALL is supported and causes the entire NE and all of its CPs to be restarted. Correlation tag. Phase; specifies the type of restart to perform. Valid values are:
u u u u
aid
ctag ph
WARM for warm restart. RESYNC for warm restart with resync. COLD for cold restart. SHUTDOWN for shutting down the PEM or PSM, depending on the AID.
3 - 64
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
System Response Syntax u NormalThe normal output response is an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input-invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Input - invalid target identifier Privilege - login not active Status - command not found Status-requested operation failed
Error Code ICNV IIAC IICT IIFM IIPG IITA PLNA SCNF SROF
3 - 65
3
TL1 COMMANDS OPR-ACO
operate alarm cutoff
Purpose Instruct an NE to cut off the office audible alarm indications without changing the local alarm indications. This command should not have any effect on future alarms at the NE, but rather should direct the NE to provide conditioning only on those alarms that are currently active. The NE should remain able to transmit its current alarm or status condition if requested by the OS or other external command source. In general, centralized indications should not be affected by the ACO, although exceptions are listed in GR474-CORE. GR-474-CORE also provides precise definitions for office, local, and centralized indications. The ACO retires the Central Office (CO) alarm audible indicators without clearing indicators that the trouble still exists. User Input Syntax
OPR-ACO-{COM|ALL}:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Access identifier. Identifies the equipment associated with the ACO that is being requested, which is currently the NE as a whole. This field must be utilized if the second modifier is ALL. Also, it must be COM if the second modifier is COM. Correlation tag.
aid
ctag
3 - 66
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input-invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Input - invalid target identifier Privilege - login not active Status - command not found Status-requested operation failed
Error Code ICNV IIAC IICT IIFM IIPG IITA PLNA SCNF SROF
3 - 67
3
TL1 COMMANDS OPR-EXT-CONT
operate-external-control
Purpose Instruct an NE to operate an external control, such as a relay activation (alarm outputs). The control can be operated momentarily or continuously. It can be released by using the RLS-EXT-CONT command. Any NE that has an external control in effect should include the appropriate condition type information in response to a RTRV-EXT-CONT request. Depending on the type of external control, the NE may also be required to use the REPT COND message when an external control is being operated. User Input Syntax
OPR-EXT-CONT:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag
aid
ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input-invalid access identifier Input - invalid correlation tag Input - invalid target identifier Privilege - login not active Status - command not found
Error Code ICNV IIAC IICT IITA PLNA SCNF
3 - 68
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
OPR-PROTNSW
operate-protection switch
Purpose Instruct a SONET NE to initiate a SONET line or path protection switch request. User switch requests initiated with this command (such as forced switch, lockout, and manual switch) remain active until they are released via the release-protection-switch (RLS-PROTNSW) command or overridden by a higher priority protection switch request. This command is not intended for use in initiating the exerciser function.
NOTE:
This command may not require a switch to occur. It may be used to upgrade the priority of a SONET line or path already on protection, for example, to upgrade the priority of a channel automatically switched to protection to a forced switch.
User Input Syntax

OPR-PROTNSW-{COM|OCH|rr}:[<tid>]:<aid>:[<ctag>]::<sc>:[<dirn>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag Switch command that is to be initiated on the line(s) or path(s) identified in the <aid> parameter. The direction of transmission in which switching is to be made and is relative to the SONET line or path identified by the AID. Not supported for input.
aid
ctag sc dirn
3 - 69
3
TL1 COMMANDS ONLINETM7000/9000/11000
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input-invalid access identifier Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - login not active Status - command not found Status - internal database error Status - requested operation failed Status - invalid request
3 - 70
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
OPR-SYNCN
operate-synchronization switch
Purpose Instruct a SONET NE to switch synchronization references. Synchronization reference switches initiated with this command remain active until they are released via an update to the sync reference table or are overridden by a synchronization reference failure. User Input Syntax
OPR-SYNCN:[<tid>]:<aid>:[<ctag>]:::SYNCSRC=<syncsrc>[,SYNCSIDE=<side>] [,SYNCREQUEST=<syncrequest>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag Synchronization source The port or line side qualifier, West or East. This parameter is required for paired ADM CPs only. [manual |forced| clear| clearwtr|Lockout|ClearLockout] is an optional field, if the request parameter is not provided then it takes a default value of manual switch to be compatible with the old command.
aid
ctag syncsrc syncside syncrequest
3 - 71
3
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input-invalid access identifier Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - login not active Status - command not found Status - internal database error Status - requested operation failed Status - invalid request
3 - 72
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RLS-EXT-CONT
release-external-control
Purpose Instruct an NE to release an external control, such as a relay deactivation (alarm outputs). The control can be released momentarily or continuously, and can be operated by using the OPR-EXT-CONT command. User Input Syntax
RLS-EXT-CONT:[<tid>]:[<aid>]:[<ctag>];
Parameter tid
aid
ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input-invalid access identifier Input - invalid correlation tag Input - non-null unimplemented parameter Privilege - login not active Status - command not found
Error Code ICNV IIAC IICT IITA PLNA SCNF
3 - 73
3
TL1 COMMANDS RLS-PROTNSW
release-protection switch
Purpose Instruct a SONET NE to release (clear) either a SONET line protection switch request between a working line and a protection line or a SONET path protection switch request that was established with the OPRPROTNSW command. This command assumes that only one user-initiated switch request is active per entity (for example, per AID). User Input Syntax
RLS-PROTNSW-{COM|OCH|rr}:[<tid>]:<aid>:[<ctag>]::[<dirn>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag The direction of transmission in which switching is to be made and is relative to the SONET line or path identified by the AID. Not supported for input.
aid
ctag dirn
3 - 74
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid target identifier Privilege - illegal command code Privilege - login not active Status - command not found Status - internal database error Status - requested operation failed Status - invalid request
3 - 75
3
TL1 COMMANDS RTRV-EXT-CONT
retrieve-external-control
Purpose Instruct an NE to report the control state of an external control. The command can be used to audit the result of either an OPR-EXT-CONT or a RLS-EXT-CONT command. User Input Syntax
RTRV-EXT-CONT:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
aid
ctag
u
NormalThe normal response is:
^^^"<aid>:[<conttype>],<dur>[,<contstate>]" <cr> <lf>
Parameter aid
Description Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Type of control Currently defaults to MISC-<num>. The value in <num> = the control number. Duration of the external control operation (relay activation). This output is always CONTS (continuous). Control state of the external control. Valid values for <contstate> are as follows:
u u u
conttype dur contstate
OPER Operated RLS Released NA - Not applicable (for example, <dur> is MNTRY). A null value defaults to NA.
If dur is CONTS, contstate must not be null.
3 - 76
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid access identifier Input - invalid correlation tag Privilege - illegal command code Privilege - login not active Status - command not found
Error Code ICNV IIAC IICT PICC PLNA SCNF
3 - 77
3
TL1 COMMANDS PERFORMANCE MONITORING COMMANDS
Use the performance monitoring commands to retrieve performance monitoring data from the NE. This section contains the following performance monitoring commands:
u u u u u u u
ONLINETM7000/9000/11000
INIT-REG on page 3-79 RTRV-PM on page 3-80 RTRV-PMCTL on page 3-83 RTRV-TH on page 3-85 SCHED-PMREPT on page 3-87 SET-PMCTL on page 3-89 SET-TH on page 3-90
3 - 78
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
INIT-REG
initialize register
Purpose Instructs an NE to initialize the PM counter for a facility. This command allows the initialization of PM counters on a whole facility base, it initializes 15-MIN counters and 1-DAY counters together. User Input Syntax
INIT-REG:[<tid>]:<aid>:[<ctag>];
Parameter tid
Description Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier. Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag.
aid
ctag
System Response Syntax u The normal response is simply a normal output response with an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid Status - invalid request
Error Code ICNV IDNV IIAC IICT IIFM IIPG PLNA SCNF SROF
3 - 79
3
TL1 COMMANDS RTRV-PM
retrieve performance monitoring
Purpose Instruct an NE to show the current set of performance monitoring data associated with one or more equipment units, facilities, or links within the NE. It may be used to load an OS or audit an OS database when it is suspected that automatic performance monitoring messages issued using REPT-PM were not received or properly processed. The command may also be used to evaluate the system before or after NE maintenance operations. Parameters are provided to retrieve past performance monitoring data for NEs that can store a history of performance monitoring information. They may also be used to retrieve data that does not cross the automatic reporting threshold specified in the SCHED-PMREPT command. This message and the other PM-related messages are based on the following assumptions about the NEs PM data collection.
u
ONLINETM7000/9000/11000
External control over the NE may be exercised in regard to manipulating the reporting of PM data, but the NE cannot be commanded externally to change its mode of PM data collection. Accumulation periods for PM data are fixed in the NE, or are changeable only by some direct interaction with the NE. All daily accumulation periods in the NE span the period from midnight to midnight. All 15-minute accumulation periods in the NE begin and end on the hour, 15 minutes after the hour, 30 minutes after the hour, and 45 minutes after the hour. The duration of all accumulation periods less than an hour must be such that an integral number of periods must total exactly one hour, and that there be a period transition occurring on the hour.
u u
User Input Syntax

RTRV-PM-{<rr>|LINK|SYNCN}:[<tid>]:[<aid>]:[<ctag>]:: [<montype>],[<monlev>],[<locn>],[<dirn>],[<tmper>],[<mondat>][,<montm>];
Parameter rr
Description Facility rate code. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes. Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier. Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag. Type of monitored parameter whose value is being reported. See TL1 MONITOR TYPES on page 6-1 for more details.
tid
aid
ctag montype
3 - 80
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter monlev
Description Indicates the level for the requested monitored parameter. Monlev does not suppress values from the OPT, OPN, and LBCN montypes since these types are actually power levels and not PM counts. Location Refers to the entity identified by the <aid>. Near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. A null input value defaults to all applicable directions. Direction of monitoring relative to the entity defined by the <aid> Accumulation time period for the PM information Date of the beginning of the PM period specified in <tmper>. Beginning time of day of the PM period specified in <tmper>
locn
dirn tmper mondat montm

^^^"<aid>:<montype>,<monval>,[<vldty>],[<locn>],[<dirn>],[<tmper>],[<mondat>][, <montm>]"<cr><lf>
Parameter aid
Description Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Type of monitored parameter whose value is being reported. See TL1 MONITOR TYPES on page 6-1 for more details. Measured value of a monitored parameter, which may contain data related to transmission performance or circuit activity if <condtype> is a threshold violation. This data is in the form of numeric counts or rates. This value should be provided if this alarm report has resulted from a degradation that has exceeded the defined or specified threshold level. Validity indicator for the reported PM data. It indicates whether the information for the specified time period is accumulated over the entire time period or some portion of it. Location In reference to the entity identified by the <aid>, from which the performance monitoring value is being reported. Thus, near end refers to performance monitoring values obtained at the identified entity, and far end refers to performance monitoring values obtained at a distant entity that is connected to the identified entity. Direction of the alarm which is relative to the entity identified by the AID. Not supported for output in this release. Accumulation time period for the performance monitoring information
montype monval
vldty
locn
dirn tmper
3 - 81
3
TL1 COMMANDS
Parameter mondat montm Description Beginning of the performance monitoring period specified in <tmper> Beginning time of day of the performance monitoring period specified in <tmper> ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid Status - invalid request
ONLINETM7000/9000/11000
3 - 82
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-PMCTL
retrieve-performance monitoring control
Purpose Displays whether the PM monitoring is currently enabled or disabled. This command only supports path PM marinating. Therefore, the AID must be a path AID. User Input Syntax
RTRV-PMCTL:[<tid>]:<aid>:[<ctag>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag
aid
ctag

^^^"<aid>:PMCTL=<pmctl>" <cr> <lf>
Parameter aid
Description Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Control state of the performance monitor. Enabled or Disabled
pmctl
3 - 83
3
TL1 COMMANDS
u
ONLINETM7000/9000/11000
3 - 84
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-TH
retrieve-threshold
Purpose Instruct an NE to send the current threshold level of one or more monitored parameters for which violation triggers an automatic message. These threshold levels may apply to one or more equipment units, facilities, subscriber lines, trunks, links, packet links, or signaling links in the NE. User Input Syntax
RTRV-TH-{<rr>|LINK|SYNCN|ALL}:[<tid>]:[<aid>]:[<ctag>][::[<montype>], [<locn>][,<tmper>]];
Parameter rr
Description Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag Type of monitored parameter whose value is being reported. See TL1 MONITOR TYPES on page 6-1 for more details. Location Refers to the entity identified by the <aid>. Thus, near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. A null input value defaults to all applicable directions. Accumulated time period for the specified monitor parameter <montype>.
tid
aid
ctag montype locn
tmper
3 - 85
3
TL1 COMMANDS
System Response Syntax u NormalA normal response is: ^^^"<aid>:<montype>,[<locn>],[<dirn>],<thlev>[,<tmper>]" <cr> <lf> Parameter aid Description Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Type of monitored parameter whose value is being reported. See TL1 MONITOR TYPES on page 6-1 for more details. Location In reference to the entity identified by the <aid>, from which the performance monitoring value is being reported. Thus, near end refers to performance monitoring values obtained at the identified entity, and far end refers to performance monitoring values obtained at a distant entity that is connected to the identified entity. The threshold level for the monitored parameter Direction of the alarm which is relative to the entity identified by the AID. This parameter is not supported for output in this release. Accumulation time period for the performance monitoring information
u
ONLINETM7000/9000/11000
montype locn
thlev dirn tmper
3 - 86
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
SCHED-PMREPT
schedule-performance reporting
Purpose Instruct the NE to start, reschedule, or remove the reporting of performance monitoring data on a specified equipment unit, facility, link, or packet link within the NE. When this command is used, it is expected that the NE periodically returns data using the automatic REPT PM autonomous message.
NOTE:
Only the ability to enable or disable PM reporting on a per AID basis is provided. When enabled, all PM montypes corresponding to the indicated AID are reported. Further, the schedule used is fixed, and uses the standard SONET 15 minute and on day reporting intervals.
User Input Syntax

SCHED-PMREPT-{<rr>|LINK}:[<tid>]:[<aid>]:[<ctag>]::,,[<numrept>];
Parameter rr
Description Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier. Correlation tag Number of reports that the schedule is expected to produce. A value of null enables PM reporting, which remains in effect until the schedule is changed. A value of 0 (zero) is used to terminate any performance-monitoring schedule that was introduced by a previous SCHED-PMREPT command.
tid
aid
ctag numrept
3 - 87
3
System Response Format u ErrorA standard error response indicates one of the following error codes: Error Code ICNV IDNV IICT INUP IPMS PLNA SCNF Description Input - command not valid Input - data not found Input - invalid correlation tag Input - non-null unimplemented parameter Input - parameter missing Privilege - login not active Status - command not valid
3 - 88
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
SET-PMCTL
set-performance monitoring control
Purpose Instruct an NE to enable or disable the PM monitoring on a facility base. This command only supports to enabling or disabling path PM marinating. Therefore, the AID must be a path AID. User Input Syntax
SET-PMCTL:[<tid>]:<aid>:[<ctag>]:::PMCTL=<pmctl>;
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. Correlation tag Control state of the performance monitor. Valid values are:
u u
aid
ctag pmctl
Enabled Disabled
System Response Syntax u The normal response is simply a normal output response with an empty text block.
u
3 - 89
3
TL1 COMMANDS SET-TH
set-threshold
Purpose Instruct an NE to set the threshold level for a monitored parameter that, when exceeded, triggers an automatic message. The threshold level may apply to one or more equipment units, facilities, subscriber lines, trunks, links, packet links, or signaling links in the NE. Threshold setting for multiple monitored parameters or time periods require multiple commands from the OS. This command allows the modification of any threshold associated with the general type of facility in the request. It allows modification of thresholds that are not collected for that particular subcategory of facility. For example, an All Rate FEC WCI collects Severely Errored Seconds (SESs) PMs and a 2R WCI does not. Therefore, the SET-TH command allows the modification of SESs for a 2R WCI. User Input Syntax
SET-TH-{<rr>|LINK|SYNCN}:[<tid>]:[<aid>]:[<ctag>]::<montype>, <thlev>,[<locn>],[<dirn>][,<tmper>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the command code modifier, for which automatic messages are to resume. If ALL or NULL is specified, then all aids are affected. Correlation tag Type of monitored parameter whose value is being reported. See TL1 MONITOR TYPES on page 6-1 for more details. The threshold level for the monitored parameter Location Refers to the entity identified by the <aid>. Thus, near end refers to PM values obtained at the identified entity, and far end refers to PM values obtained at a distant entity that is connected to the identified entity. A null input value defaults to all applicable directions. Direction of the alarm which is relative to the entity identified by the AID. Not supported for output in this release. Accumulated time period for the specified monitor parameter <montype>.
tid
aid
ctag montype thlev locn
dirn tmper
3 - 90
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid
Error Code ICNV IDNV IIAC IICT IIFM IIPG PLNA SCNF
3 - 91
3
TL1 COMMANDS PROVISIONING COMMANDS
Use the TL1 provisioning commands to configure and monitor the ONLINE system. This section contains the following TL1 provisioning commands:
ONLINETM7000/9000/11000
DLT-{OC3|OC12|STM1|STM4} on page 3-94 DLT-CKT on page 3-95 DLT-CRS-<rr> on page 3-96 DLT-EQPT on page 3-97 DLT-EXTIF on page 3-98 DLT-FFP on page 3-99 DLT-PASS on page 3-100 DLT-SBR on page 3-101 DLT-SNE on page 3-102 DLT-SYNCN on page 3-103 DLT-TRAIL on page 3-104 DLT-UNSWTS on page 3-105 DLT-VLAN on page 3-106 ED-<rr> on page 3-107 ED-CKT on page 3-110 ED-DAT on page 3-112 ED-DW on page 3-114 ED-EQPT on page 3-116 ED-EXTIF on page 3-118 ED-FFP on page 3-119 ED-SBR on page 3-120 ED-SNE on page 3-121 ED-SYNCN on page 3-122 ENT-<rr> on page 3-124 ENT-CKT on page 3-126
ENT-CRS-<rr> on page 3-128 ENT-EQPT on page 3-130 ENT-EXTIF on page 3-135 ENT-FFP on page 3-136 ENT-PASS on page 3-138 ENT-RNGMAP-VNODE on page 3-139 ENT-SBR on page 3-140 ENT-TRAIL on page 3-142 ENT-UNSWTS on page 3-143 ENT-VLAN on page 3-144 INIT-RNGMAP-VNODE on page 3-145 OPR-LPBK on page 3-146 RD-SYNCN on page 3-148 RLS-LPBK on page 3-150 RMV-{ } on page 3-152 RST-{ } on page 3-153 RTRV-CKT on page 3-154 RTRV-CKTINFO-{OCH | <rr> | Gbe | FC | FICON | EQPT} on page 3-156 RTRV-CKTINFO-CKT on page 3-158 RTRV-CRS-<rr> on page 3-160 RTRV-EQPT on page 3-162 RTRV-EXTIF on page 3-166 RTRV-{<rr>|SYNCN|PMM|LINK} on page 3-167 RTRV-FAC-{<rr>|ALL|PMM|LINK} on page 3167 RTRV-FIBER-EQPT on page 3-174
u u u u u u u u u u u u u u u u u
u u u u u u
u u u u u u
3 - 92
ONLINE 7000/9000/11000
TM
u u u u u u
TL1 COMMANDS
u u u u u u
RTRV-FFP on page 3-176 RTRV-HDR on page 3-178 RTRV-NETYPE on page 3-179 RTRV-PASS on page 3-180 RTRV-RNGMAP-VNODE on page 3-182 RTRV-RNGSTATUS-VNODE on page 3183 RTRV-SQLCHTBL-VNODE on page 3185 RTRV-SBR on page 3-186 RTRV-SIDTABLE on page 3-188
RTRV-SNE on page 3-189 RTRV-SWVER-COM on page 3-191 RTRV-SWVER-EQPT on page 3-192 RTRV-TRAIL on page 3-194 RTRV-UNSWTS on page 3-195 RTRV-VLAN on page 3-196 SET-SID on page 3-198 SET-SYNCN on page 3-199
u u
3 - 93
3
TL1 COMMANDS DLT-{OC3|OC12|STM1|STM4}
delete- facility [OC-3 | OC-12 | STM-1 | STM-4]
Purpose Delete a specific facility from the specified SONET MUX circuit pack. Prior to deletion, the primary state of the facility must be OOS.
ONLINETM7000/9000/11000
NOTE:
Parameter grouping is not supported for this command.
User Input Syntax

DLT-{OC3|OC12|STM1|STM4}:[<tid>]:<aid>:[<ctag>];
Description Target identifier Access identifier Correlation tag
u
ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Status - requested operation failed
Error Code IDNV SROF
3 - 94
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-CKT
delete-circuit
Purpose Remove a provisioned end-to-end circuit from the network. User Input Syntax
DLT-CKT:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::[ABAND=<band>] [,ACHANNEL=<channel>][,ZBAND=<band>] [,ZCHANNEL=<channel>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier. Identifies the circuit. Correlation tag Band number for the A or Z node of the circuit to be deleted. This parameter only applies to 3rd party circuits. Channel number for the A or Z node of the circuit to be deleted. This parameter only applies to 3rd party circuits.
aaid, zaid, z2aid ctag aband, zband achannel, zchannel
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid
Error Code ICNV IDNV IIAC IICT IIFM IIPG PLNA SCNF
3 - 95
3
TL1 COMMANDS DLT-CRS-<RR>
delete-cross [connect]
Purpose Delete an STS-12C, STS-3C, STS-1, AU4, and AU44C level cross-connect between a SONET MUX tributary and line side timeslot. Parameter grouping is not supported for this command. User Input Syntax
DLT-CRS-{STS12C|STS3C|STS1|AU4|AU44C}:[<tid>]:<fromaid>,<toaid> [,<frompaid>][,<topaid>] :[<ctag>]:::XCTYPE=<xctype>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier that identifies the "from" (originating) facility. Access identifier that identifies the "to" (destination) facility. Access Identifier that identifies the "from" (originating) protecting facility. Access Identifier that identifies the "to" (destination) protecting facility. Correlation tag MUX connection type
fromaid toaid frompaid topaid ctag xctype
System Response Syntax u NormalThe normal response is an empty text block.

u
3 - 96
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-EQPT
delete-equipment
Purpose Remove provisioning information about a specified CP or other contents of a slot in an NE. User Input Syntax
DLT-EQPT:[<tid>]:<aid>:[<ctag>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the equipment associated with the command. Correlation tag
aid ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - parameter missing Input - data not valid Input - command not valid
Error Code IPMS IDNV ICNV
NOTE:
Before equipment can be deleted, all facilities associated with the equipment and the equipment itself must be locked using the RMV-{<rr>|EQPT|SYNCN} command or similar. The RTRV-EQPT and RTRV-FAC-{ALL|<rr>|SYNCN} commands are helpful for displaying this service state information.
NOTE:
When deleting REGEN equipment, only the aid consisting of an east shelf and slot or west shelf and slot specifying one WCI making up the REGEN is required and both WCI's making up the REGEN are deleted.
3 - 97
3
TL1 COMMANDS DLT-EXTIF
delete-external interface
Purpose This command is used to delete an existing external interface. User Input Syntax
DLT-EXTIF:[<tid>]:<aid>:[<ctag>];
ONLINETM7000/9000/11000
Description Target identifier Access Identifier Identifies the external interface to be created. Grouping is not supported. Correlation tag
u
3 - 98
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-FFP
delete-facility protection group
Purpose Delete a facility protection group. User Input Syntax
DLT-FFP-{<rr>}:[<tid>]:<workaid>,<protaid>:[<ctag>];
Parameter rr tid workaid protaid ctag
Description Facility rate code. For a prottype of SBLSR, only OC48 and STM16 are supported. Target identifier Access identifier for the working-side of the protection group. Access identifier for the protection-side of the protection group. Correlation tag
System Response Syntax u NormalThe normal response is a normal output response with an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - parameter missing Input - data not valid Input - command not valid
3 - 99
3
TL1 COMMANDS DLT-PASS
delete-passthrough
Purpose Deletes a band or channel passthrough within a node. User Input Syntax
DLT-PASS:[<tid>]:<westaid>,<eastaid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters.
westaid
Access identifier Identifies an AID associated with the passthrough circuit. Grouping is not supported for this command.
eastaid ctag
See <westaid>. Correlation tag
System Response Syntax u NormalThe normal response is an empty text block.

u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not found Status - requested operation failed
3 - 100
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-SBR
delete-subrate
Purpose Remove a provisioned end-to-end subrate circuit from the network. User Input Syntax
DLT-SBR:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the subrate circuit. Correlation tag
aaid, zaid, z2aid ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid Status - requested operation failed
3 - 101
3
TL1 COMMANDS DLT-SNE
delete-sonet network element
Purpose Remove a provisioned logical SONET ADM overlay the DWDM fabric. User Input Syntax
DLT-SNE:[<tid>]:<aid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access Identifier Identifies the pass-through band and possibly channel associated with the pass-through circuit. Correlation tag
aid
ctag
u u
NormalThe normal response is an empty text block. ErrorA standard error response indicates one of the following error codes Description Input - data not found Input - invalid correlation tag Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Input - parameter missing Status - requested operation failed Status - internal database error
3 - 102
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-SYNCN
delete-synchronization
Purpose Removes a provisioned synchronization source. This parameter grouping is not supported for this command. User Input Syntax
DLT-SYNCN:[<tid>]:<eqptaid>:[<ctag>]:::SYNCSRC=<syncsrc>[,SYNCSIDE=<side>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier Identifies the synchronization source to delete. Correlation tag Synchronization source The port or line side qualifier, west or east (W | E). This parameter is required for paired ADM cards only.
eqptaid ctag syncsrc syncside
u u
NormalThe normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid Status - requested operation failed
3 - 103
3
TL1 COMMANDS DLT-TRAIL
delete-trail
Purpose Deletes the trail connection from an STMX, or ADM CP to a WCI CP (or another STMX, or ADM CP for port chaining configurations.) User Input Syntax
DLT-TRAIL:[<tid>]:<fromAid>,<toAid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access identifier which identifies the from-side, single equipment unit to which this event pertains. Access identifier which identifies the to-side, single equipment unit to which this event pertains. Correlation tag
fromAid toAid ctag
u
ErrorA standard error response indicates one of the following error codes Description Input - data not found Status - requested operation failed
3 - 104
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
DLT-UNSWTS
delete-unswitched timeslots
Purpose Delete provisioning of unswitched timeslots. User Input Syntax
DLT-UNSWTS:[<tid>]:<aid>:[<ctag>]:::TSTYPE=<tstype>,STARTTS=<startts>, ENDTS=<endts>;
Parameter tid aid ctag tstype
Description Target identifier. Access identifier. Identifies the equipment and timeslots to be added. Correlation tag. The type of timeslot. The valid values are:
u u u
NUT (only valid for 1+1 protected ports) DISABLE_SPANSW (only valid for BLSR protected ports) DISABLE_RINGSW (only valid for BLSR protected ports).
startts endts
u u
The start timeslot of the unswitched traffic to be provisioned. The end timeslot of the unswitched traffic to be provisioned NormalThe normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid correlation tag Input - invalid parameter grouping Input - non-null unimplemented parameter Input - parameter missing
Error Code IDNV IICT IIPG INUP IPMS
3 - 105
3
TL1 COMMANDS DLT-VLAN
enter-virtual LAN
Purpose Deprovision datawire virtual LANs. User Input Syntax
DLT-VLAN:[<tid>]:<aid>:[<ctag>]:::<vlanid>;
ONLINETM7000/9000/11000
Parameter tid aid ctag vlanid
Description Target identifier. Access identifier. Identifies the facility to create. Correlation tag. Virtual LAN identification number.
u
ErrorA standard error response indicates one of the following error codes:
Error Code ICNV IDNV IIAC IICT IIFM IITA IPMS PIUI PLNA SCNF SDBE SROF
Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid target identifier Input - parameter missing Privilege - illegal user identity Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed
3 - 106
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ED-<RR>
edit-facility
Purpose Modify the provisioned attributes of a SONET MUX facility. Parameter grouping is not supported for this command. User Input Syntax
ED-{OC3|OC12|OC48|OC192|STM1|STM4|STM16|STM64|GBE|FC|FICON|ESCON|OCH}:[<tid>] :<aid>:[<ctag>]:::>::[ALWB1=<alwB1>][,ALWB2=<alwB2>][,ALWD1_D3=<alwD1_D3>] [,ALWD4_D12=<alwD4_D12>][,ALWE1=<alwE1>][,ALWE2=<alwE2>][,ALWF1=<alwF1>] [,ALWJ0=<alwJ0>][,ALWK1_K2=<alwK1_K2>][,ALWM1=<alwM1>][,ALWS1=<alwS1>] [,ALWSS=<alwSS>][,ALWX1=<alwX1>][,ALWX2=<alwX2>][,ALWZ0=<alwZ0>][,ALWZ1=<alwZ1] [,ALWZ2=<alwZ2>][TRANFMT=<tranfmt>][,OHMODE=<ohmode>][,SECTRTP=<sectrtp>,OUTSEC TR=<outsectr>,EXPSECTR=<expsectr>][,SECTRMON=<sectrmon>][,TMAP=<tmap>][,TMODE=< tmode>][TTERM=<tterm>][,FAULTPROPMODE=<faultpropmode>][ENABLEAIS=<enableais>][, SECTRMODE=<sectrmode>][,OWDCCBYTEMODE=<owdccbytemode>][,=SECTTRACEC1BYTE<secttr aceC1byte>][,SECTTRACEJ0BYTES=<secttraceJ0bytes>][SVCTYPE=<svctype>][,ENABLEDCC =<enabledcc>,ENABLEOSPF=<enableospf>][,CLKID=<clkid>][,OVROUTSSM=<ovroutssm>][, IPMAPPING=<ipmap>][,DCCTYPE=<dcctype>][,PEERIP=<peerip>][,SUBIP=<subip>][,SUBNE TMASK=<subnetmask>][,MTU=<mtu>][,FCS=<fcs>][,BITRATE=<bitrate>][:<pst>];
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access Identifier. Identifies the facility to modify. Correlation tag Enable state of the B1 Section BIP-8 overhead transparency byte. Enable state of the B2 Line BIP-8 overhead transparency byte. Enable state of the D1_D3 Section DCC overhead transparency byte. Enable state of the D4_D12 Line DCC overhead transparency byte. Enable state of the E1 Section Orderwire overhead transparency byte Enable state of the E2 Line Orderwire overhead transparency byte. Enable state of the F1 User Channel overhead transparency byte. Enable state of the J0 Section Trace overhead transparency byte. Enable state of the K1_K2 APS overhead transparency byte. Enable state of the M1 Line REI overhead transparency byte. Enable state of the S1 Synchronization overhead transparency byte. Enable state of the SS SONET/SDH overhead transparency byte. Enable state of the X1 National overhead transparency byte.
aid ctag alwB1 alwB2 alwD1_D3 alwD4_D12 alwE1 alwE2 alwF1 alwJ0 alwK1_K2 alwM1 alwS1 alwSS alwX1
3 - 107
3
TL1 COMMANDS
Parameter alwX2 alwZ0 alwZ1 alwZ2 bitrate enableais enablepath exppathtr Description Enable state of the X2 National overhead transparency byte. Enable state of the Z0 Section Growth overhead transparency byte. Enable state of the Z1 Growth overhead transparency byte. Enable state of the Z2 Growth overhead transparency byte. Bit Rate, only applicable if the SVCTYPE is userSpecifiedRate A boolean value which indicates whether to enable section trace mismatch detection. A boolean value which indicates whether to enable path trace mismatch detection. Expected path trace value. This is the expected value for the Sonet J1 path trace byte values. The length must be 64 bytes, including the <CR><LF> which is added by the system. Transmission format for this facility. Note, only supported on ADM and SMX10G circuit packs. Overhead Mode for this facility. Note, only supported on Tributary side SMX10G and ADM circuit packs. Transmit (outgoing) path trace value. This is the output value for the Sonet J1 path trace byte values. The mode in which the E1/F1/D1-D3 section overhead bytes are transmitted Type of protocol to use in path trace overhead. The C1 1 byte value {1-255}. The 15 byte string for the SDH J0 section overhead 15 bytes. Section Trace Type for this facility. Note, only supported on ADM facilities. Transmit (outgoing) Section Trace value. Note, only supported on ADM facilities. Expected Section Trace value. Note, only supported on ADM facilities. The mode for transmitting section trace values. Flag for Section Trace (mismatch) monitoring. Note, only supported on ADM facilities. Data format of the service. Transparency mapping. Transparency mode. Transparency termination. Fault Propagation Mode. Note, only supported on FC, FICON, GBE and ESCON facilities. Clock ID of the facility. Valid values are ( auto|1..20). Over ride outgoing SSM on the facility [no_override|dus_dnu|stu_allzero] TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
ONLINETM7000/9000/11000
tranfmt ohmode outpathtr owdccbytemode pathtrtp secttraceC1byte secttraceJ0bytes sectrtp outsectr expsectr sectrmode sectrmon svctyp tmap tmode tterm faultpropmode clkid ovroutssm
3 - 108
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter enabledcc
Description Flag to indicate if DCC is enabled. The valid values are True or False. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. Flag to indicate if OSPF is enabled. The valid values are True or False. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. The valid values are [IPOHDLC | IPOPPP]. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. The valid values are SECTION or LINE. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. A valid IP address is accepted. This attribute can only be provisioned on the first four tributary side facilities of ADMII. A list of IP addresses separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII. A list of IP Subnet Masks separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII. Maximum Transfer Unit. Valid values range from 48 to 1500. This attribute can only be provisioned on the first four tributary side facilities of ADMII. Frame Check Sequence. Valid values are FCS16 and FCS32. This attribute can only be provisioned on the first four tributary side facilities of ADMII. The desired Primary State of the entity.
enableospf
ipmap dcctype peerip subip subnetmask mtu fcs pst
u
ErrorA standard error response indicates one of the following error codes Description Input - data not found Status - requested operation failed
3 - 109
3
TL1 COMMANDS ED-CKT
edit-circuit
Purpose Modify the name of circuits. User Input Syntax
ED-CKT:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::[ABAND=<band>] [,ACHANNEL=<channel>][,ZBAND=<band>][,ZCHANNEL=<channel>] [,USERLABEL=<userlabel>] [,BITRATE=<bitrate>][,PATHFEC=<pathfec>][:<pst>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier. Identifies the circuit. Grouping is not supported. Correlation tag. Band number for the A or Z node of the circuit to be edited. This parameter only applies to 3rd party circuits. Channel number for the A or Z node of the circuit to be edited. This parameter only applies to 3rd party circuits. The new name of the circuit. Path forward error correction mode. Bit rate of the circuit. The designated primary state of the object.
aaid, zaid, z2aid ctag aband, zband achannel, zchannel userlabel pathfec bitrate pst
u
ErrorA standard error response indicates one of the following error codes Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping
Error Code ICNV IDNV IIAC IICT IIFM IIPG
3 - 110
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Error Code PLNA SCNF SROF
Description Privilege - login not active Status - command not valid Status - requested operation failed
3 - 111
3
TL1 COMMANDS ED-DAT
edit-date
Purpose Instruct the NE to change its system date and time to a specified value. User Input Syntax
ED-DAT:[<tid>]::[<ctag>]::<date>[,<time>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag Current date is configured in a YY-MM-DD format.
u
ctag date
YY is the last two digits of the year, ranging from 00 to 99. Always refers to the 21st century (20YY). MM is the month of the year, ranging from 01 to 12. DD is the day of the month, ranging from 01 to 31. HH is the hour in a 24-hour format, ranging from 00 to 23. MM are the minutes, ranging from 00 to 59. SS are the seconds, ranging from 00 to 59.
u u
time
Current time is configured in a HH-MM-SS format.

u u u
3 - 112
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes Description Input - command not valid Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - requested operation failed
Error Code ICNV IICT IIFM IPMS PLNA SROF
NOTE:
Changing the system date and time may result in the corruption of performance monitoring data for one or more time periods.
3 - 113
3
TL1 COMMANDS ED-DW
edit-datawire
Purpose Change the connection state of a nodes datawire facility. Either datawire facility, or both datawire facilities can be modified with this command. Parameter grouping is not supported for this command This command checks whether the datawire configuration that would result from the change is valid.
u
ONLINETM7000/9000/11000
If the resulting change is invalid, then the action that follows is governed by the optional force parameter. This option is necessary to permit a change that would result in an invalid configuration to proceed. When this occurs, the datawire connection state of the other side is set to unconnected. If there is no conflict, then the requested change is made. Otherwise, a warning message is displayed and no change is made. The connection state of both sides are the same. The connection state of one side is unconnected and the connection state of the other side is addDrop.
Valid datawire configurations are:

u u
For this reason, the "both" parameter is only target accepted when the connection state is being changed to passthrough. User Input Syntax
ED-DW:[<tid>]:<aid>:[<ctag>]:::[CONNST=<connst>][,BOTH=true|false] [,FORCE=true|false][:<pst>];
Parameter tid aid ctag connst both force pst
Description Target identifier Access identifier which identifies the facility to modify. Correlation tag Connection state of the datawire circuit pack When true, applies CONNST to both East and West side, DataWire facilities. When true, resolves CONNST conflict by setting opposite side of DataWire facility to NC. The desired Primary State of the entity.
3 - 114
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
3 - 115
3
TL1 COMMANDS ED-EQPT
edit-equipment
Purpose Modify provisioning information about an existing a circuit pack or other contents of a slot in a NE. User Input Syntax
ED-EQPT:[<tid>]:<aid>:[<ctag>]::<eqptype>:<nameblk>[:<pst>,<sst>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID\TID for TL1 communications, which consists of up to 20 characters. Access Identifier Identifies the equipment associated with that circuit. Correlation tag The type of circuit pack for a given input command. Set of vendor-defined extensions for modifying specific CPs. See Table 3-1 for options. Specifies transmission format Specifies the overhead processing mode. Indicates the loss insertion for the attached DCM. Indicates the maximum output for a port. Gain settings for VGA-type CPs This setting is not applicable for non-VGA CPs. SSM parameter can have [enable|disable] values. The default is disable. Sa Bit attribute can have values [Sa4, Sa5, Sa6,Sa7 & Sa8]. ID of the cluster that the ADM (ADMII) is in. Value for Cluster ID is an integer in the range of ( 0, 2 - 255) The specific primary state of the object. The specific secondary state of the object.
aid ctag eqptype nameblk xmtfmt ohmode extpad maxoutp gainmode ssm sabit clusterid pst sst
3 - 116
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Eqp Type adm pmm
Nameblk CLUSTERID=<clusterid> EASTEXTPAD=<extpad>,EMAXOUTP=<maxoutp> WESTEXTPAD=<extpad>,WMAXOUTP=<maxoutp> Applied only to MPT. GAINMODE=<gainmode> GAINMODE=<gainmode> XMTFMT=<xmtfmt>,OHMODE=<ohmode> SSM=<ssm> The possible values for SSM are (ENABLE, DISABLE). The default is DISABLE. SABIT= <sabit> The possible values for Sa Bit are (SA4, SA5, SA6, SA7, SA8). The default is SA4.
postamp preamp stmx sync
u
ErrorA standard error response indicates one of the following error codes: Description Input - parameter missing Input - data not valid
Error Code IPMS IDNV
3 - 117
3
TL1 COMMANDS ED-EXTIF
edit-external interface
Purpose This command is used to modify the power values of an existing external interface. User Input Syntax
ED-EXTIF:[<tid>]:<aid>:[<ctag>]:::EXPINP=<expinp>,TGTOUTP=<tgtoutp>;
ONLINETM7000/9000/11000
Parameter tid aid ctag expinp tgtoutp
Description Target identifier Access Identifier Identifies the external interface to be created. Grouping is not supported. Correlation tag Expected input power in dBm. Valid values are: (-25 to 12) Target Output Power in dBm. Valid values are: (-30 to 12)
u
3 - 118
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ED-FFP
edit-facility protection group
Purpose Modify the attributes of a facility protection group. User Input Syntax
ED-FFP{<rr>|OCH|COM}:[<tid>]:<workaid>,<protaid>:[<ctag>]:::[RVRTV=<rvrtv>][,WTR=<wtr >][,SWON=<swon>][,USERLABEL=<userlabel>];
Parameter rr
Description Facility rate code. For a prottype of SBLSR, only OC48 and STM16 are supported. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier Access identifier Identifies the equipment associated with the working portion of the protection group. Grouping is not available for this parameter. Access identifier Identifies the equipment associated with the protecting portion of the protection group. Grouping is not available for this parameter. Correlation tag Revertive protection mode. An FFP with a prottype of SBLSR must always be set to Y. Wait restore timein seconds The condition initiating a switch The user-supplied name for the logical node and is only used with prottpe of SBLSR.
tid workaid
protaid
ctag rvrtv wtr swon userlabel
u
IPMS IDNV ICNV
Input - parameter missing Input - data not valid Input - command not valid
3 - 119
3
TL1 COMMANDS ED-SBR
edit-subrate
Purpose Modify the name of subrate circuit. User Input Syntax
ED-SBR:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::[USERLABEL=<userlabel>] [,OFC=<ofc>][:<pst>];
ONLINETM7000/9000/11000
Parameter tid aaid, zaid, z2aid ctag userlabel ofc
Description Target identifier Access Identifier Identifies the subrate circuit. Grouping is not available for this command. Correlation tag Identifies the new name of the associated circuit. provisions the OFC option to be enabled or disabled. Valid values are {Y | N}. The OFC parameter can only be used on 1310 nm point-to-point Fibre Channel (FC) sub-rate circuit (supported by GRDM). The empty value default is unchanged for ED-SBR.
u
ErrorA standard error response indicates one of the following error codes Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid Status - requested operation failed
3 - 120
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ED-SNE
edit-sonet network element
Purpose Modify the name of a provisioned logical SONET ADM. User Input Syntax
ED-SNE:[<tid>]:<aid>:[<ctag>]:::[OLDUSERLABEL=<userlabel>,]NEWUSERLABEL= <userlabel>;
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access Identifier Correlation tag Identifies the name for the logical Sonet ADM. Note that when the OLDUSERLABEL is specified, it is validated against the name stored against the <aid>. If it is not specified, it only validates that the NEWUSERLABEL is not the same as the old userlabel. There is no need to specify the OLDUSERLABEL unless additional validation is desired.
aid ctag userlabel
u
ErrorA standard error response indicates one of the following error codes: Description Input - data not found Input - invalid correlation tag Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Input - parameter missing Status - requested operation failed Status - internal database error
3 - 121
3
TL1 COMMANDS ED-SYNCN
edit-synchronization
Purpose Modify the properties of a synchronization source. User Input Syntax
ED-SYNCN:[<tid>]:<eqptaid>:[<ctag>]:::SYNCSRC=<syncsrc>,SYNCPRI=<syncpri> [,SYNCSIDE=<syncside>][,SYNCSSM=<ssm>[,SYNCFQL=<fql>[,SYNCSSMMODE=<ssmmode>] [,SYNCPNO=<pno>][,WTR=<wtr>][,RVRTV=<rvrtv>]:<pst>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier. Identifies the CP to associate synchronization with. Correlation tag. Priority of the entered synchronization source. Priority of the entered synchronization source. Port or line-side qualifier. Valid values are W for west or E for east. This parameter is only required for paired ADM cards. An option field associated with a facility. The possible value are (ENABLE, DISABLE), default is DISABLE. Forced Quality level - When the SSM is disabled, a FQL must be selected from the list of forced quality levels for this SSM processing mode. SSM processing mode. Provisionable Network Operator quality level. Wait To Restore Time. Any number in the range of 0 and 12 (0 and 12 inclusive) Revertive parameter. Sets the synchronization switch to revert or not revert. Valid values are Y or N. Designated primary state of entity.
eqptaid ctag syncsrc syncpri syncside syncssm syncfql syncssmmode pno wrt rvtv pst
3 - 122
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
Description Input - command not valid Input - data not found Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not valid Status - requested operation failed
3 - 123
3
TL1 COMMANDS ENT-<RR>
enter-facility
Purpose Provision a facility on a specified SONET MUX circuit pack. The options are:
u u u u
ONLINETM7000/9000/11000
OC-12 OC-3 STM-1 STM-4
NOTE:
Parameter grouping is not supported for this command.
User Input Syntax

ENT-{OC3|OC12|STM1|STM4}:[<tid>]:<aid>:[<ctag>]:::TRIBTS=<tribts> [,CONCAT=true|false][,ENABLEDCC=<enabledcc>][,IPMAPPING=<ipmapping>] [,DCCTYPE=<dcctype>][,PEERIP=<peerip>][,SUBIP=<subip>] [,SUBNETMASK=<subnetmask>][,MTU=<mtu>][,FCS=<fcs>][:<pst>];
Parameter tid
Description Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag. Access Identifier. Identifies which facility to create. Tributary time slot number to associate with this facility. The valid values are TRUE or FALSE. This is valid for ADM II/ GRDM II and ESCON II line side facilities and the first four tributary side facilities of ADMII The valid values are IPOHDLC or IPOPPP. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. The valid values are SECTION or LINE. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. A valid IP address is accepted. This attribute can only be provisioned on the first four tributary side facilities of ADMII. A list of IP addresses separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII. A list of IP Subnet Masks separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII.
ctag aid tribts enabledcc ipmap dcctype peerip subip subnetmask
3 - 124
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter mtu fcs concat
Description Maximum Transfer Unit. Valid values range from 48 to 1500. This attribute can only be provisioned on the first four tributary side facilities of ADMII. Frame Check Sequence. Valid values are FCS16 or FCS32. This attribute can only be provisioned on the first four tributary side facilities of ADMII. If true, specifies concatenated payload. Applies to OC12/STM4 ports for STMX circuit packs only. Defaults to true if not specified for OC12/STM4 ports on an STMX circuit pack. The specific primary state of the entity.
pst
System Response System u NormalThe normal output response is an empty text block.
u
3 - 125
3
TL1 COMMANDS ENT-CKT
enter-circuit
Purpose Provision end-to-end circuits through the network. User Input Syntax
ENT-CKT:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::USERLABEL=<userlabel>, ACCESSTYP=<accesstyp>,CKTTYP=<ckttyp>,SVCTYP=<svctyp>[,ASIDE=<side>] [,BITRATE=<bitrate>][,ABAND=<band>][,ACHANNEL=<channel>][,ZBAND=<band>] [,ZCHANNEL=<channel>][:<pst>];
ONLINETM7000/9000/11000
Parameter tid aaid, zaid, z2aid ctag userlabel accesstyp ckttyp svctyp side
Description Target identifier Access Identifier Identifies the circuit. Grouping is not supported. Correlation tag User-specified name for the circuit. This name needs to be unique within a subnet. Access type of the circuit Type of circuit to be added or dropped. Data format of the service to be added or dropped. Only used when provisioning a WCA circuit on a node configured as a two Fiber OCH ODPR. Specifies the working path on the "A" node. The "Z" side working path is always be the opposite of the "A" side and is therefore not required to be specified. Valid values are:
u u
W E
bitrate aband, zband achannel, zchannel pst
Bit rate of the circuit Band number for the A or Z node of the circuit to be created. This parameter only applies to 3rd party circuits. Channel number for the A or Z node of the circuit to be created. This parameter only applies to 3rd party circuits. The specific primary state of the object
3 - 126
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
3 - 127
3
TL1 COMMANDS ENT-CRS-<RR>
enter-cross connection-facility
Purpose Provision an STS-12C, STS-3C, STS-1, AU4, AU44C level cross-connect between a SONET MUX tributary and line side timeslot. User Input Syntax
ENT-CRS-{STS12C|STS3C|STS1|AU4|AU44C}:[<tid>]:<fromaid>,<toaid>[,<frompaid>] [,<topaid>]:[<ctag>]:::XCTYPE=<xctype>[,LINETSMODE=<linetsmode>][,TRIBTSMODE= <tribtsmod>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code. Supported rate codes are:

u u u u u
STS -1 STS-3C STS-12C AU4 AU44C
tid
Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier which identifies the "from" facility. Access identifier which identifies the "to" facility. Access identifier. Identifies the "from" protecting facility. Access identifier. Identifies the "to" protecting facility. Cross-connect type, the following are options:
u u u
fromaid toaid frompaid topaid xctype
hairpin addDrop passThru
linetsmode
The switching mode of the timeslot on the line side of the XC (for APS 1+1 or SBLSR related cross-connects, when specifying switched or unswitched timeslots). The switching mode of the timeslot on the tributary side of the XC (for APS 1+1 or SBLSR related cross-connects, when specifying switched or unswitched timeslots).
tribtsmode
3 - 128
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - data not found Status - requested operation failed
3 - 129
3
TL1 COMMANDS ENT-EQPT
enter-equipment
Purpose Add provisioning information about a specific CP, or other contents, of a slot in a NE. Specific name block format for each CP are provided in Table 3-1. User Input Syntax
ENT-EQPT:[<tid>]:[<aid>]:[<ctag>]::<eqptype>:<nameblk>[:<pst>[,<sst>]];
ONLINETM7000/9000/11000
Parameter side band channel eqptaid wave userlabel sne pmode trsptype admtype numports fchainpos xmtfmt ohmode dataprot pmmtype extpad maxoutp gainmode shelftype
Description Specifies the side on which the entity operates. Specifies the band that is assigned to the circuit pack. When this field is used for entering the PMM card, it is only valid if connecting to an all-band card. Specifies the channel is assigned to the circuit pack. The Access Identifier (Section 4.11.1) identifying a circuit pack. A wavelength indicator of the form: <side>-<band>-<channel>. A text label for the equipment specified in the ENT-SNE command. This field is case sensitive. An integer between 1 and 999 specifying the SNE entered with the ENT-SNE command to logically contain the ADM or SMX10G circuit pack. Specifies the protection mode of a circuit pack. Specifies how a WCI transponder functions. For regens, if not specified, DUAL is the default value Indicates the type of ADM circuit pack. Valid values are: 4ADM, 8ADM, 4ADM2S, 4ADM2I, 4ADM2L, 8ADM2S, 8ADM2I, 8ADM2L. Indicates the number of ports supported by a circuit pack. Specifies to which circuit pack in the fiber chain the COM port of the new BWDM is connected. Specifies transmission format. Specifies the overhead processing mode. Specifies data protocol. Specifies the PMM type. Indicates the loss insertion for the attached DCM. Only valid for DCM card. Same for <eastextpad> and <westextpad>. Indicates the maximum output power for a port. Only valid for DCM card. Same for <emaxoutp> and <wmaxoutp>. Gain settings for VGA type circuit packs. Not applicable for non-VGA circuit packs. Shelf type.
3 - 130
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter reftype frmfmt linecde ssm sabit splitmode wcitype nocwdm
Description reference type. Frame format. Line code of source. SSM attribute can have [enable|disable] values. The default is disable. Sa Bit attribute can have values [Sa4, Sa5, Sa6,Sa7 & Sa8]. Splitter mode. Type of the WCI circuit pack. Specifies whether the WCI circuit pack is added without a corresponding CWDM circuit pack and can be directly connected to the BWDM. If this field is empty, a CWDM is expected to be associated with this channel. Same for <eastnocwdm> and <westnocwdm>. DCM TYPE The EQPT AID of the from side circuit pack. Can also be set to "SPAN" to indicate the span to the remote node. The EQPT AID of the to side circuit pack. The band of the from side circuit pack (only valid for all-band BWDM). The band of the to side circuit pack (only valid for all-band BWDM). ID of the cluster that the ADMII, GRDMII or ESCONII is in. Value for Cluster ID is an integer in the range of ( 0, 2 - 255) The mate parameter contains the EQPT AID of the adjacent circuit pack of a protected and mated pair of circuit packs
dcmtype fromcp tocp fromband toband clusterid mate
Eqp Type
Nameblk
adm
ADMTYPE=<admtype>[,XMTFMT=<xmtfmt>,SNELABEL=<snelabel>][,MATE =<mate>][,CLUSTERID=<clusterid>]
NOTE:
Either XMTFMT and SNELABEL, or MATE must be entered, but not all three. Both XMTFMT and SNELABEL are displayed for the RTRV-EQPT command. MATE is displayed for RTRVEQPT only when two ADMs are paired.
bwdm cwdm dch dcm
SIDE=<side>,BAND=<band>, ACCESSTYP=<chanaccesstyp> PMODE=<pmode>,FCHAINPOS=<fchainpos> SIDE=<side>,BAND=<band> None DCMTYPE=<dcmtype>,FROMCP=<fromcp>,TOCP=<tocp>[,FROMBAND=<f romband>] [,TOBAND=<toband>]
3 - 131
3
TL1 COMMANDS
Eqp Type Nameblk
ONLINETM7000/9000/11000
grdm grdm2 emx line osc pmm
GRDMTYPE=<grdmtype>,XMTFMT=<xmtfmt>, DATAPROT=<dataprot> GRDMTYPE=<grdmtype>, XMTFMT=<xmtfmt>, DATAPROT=<dataprot>, MATE=<mate>, CLUSTERID=<clustered> XMTFMT=<xmtfmt> SIDE=<side>,CCTPKTYPE=<cctpktype> SIDE=<side> PMMTYPE=<pmmtype>[,EASTEXTPAD=<extpad>] [,EMAXOUTP=<maxoutp>][,WESTEXTPAD=<extpad>] [,WMAXOUTP=<maxoutp>] [,BAND=<band>] Optional EASTEXTPAD, EMAXOUTP, WESTEXTPAD, WMAXOUTP required only for MPTOptional BAND is required when connecting to an ABWDM card. SIDE=<side>,VGATYPE=<vgatype>[,GAINMODE=<gainmode>] SIDE=<side>,VGATYPE=<vgatype>[,GAINMODE=<gainmode>] WESTWAVE=<wave>,WESTWCITYPE=<wcitype>[,WESTNOCWDM=<nocw dm>],EASTWAVE=<wave>,EASTWCITYPE=<wcitype>[,EASTNOCWDM=<n ocwdm>] [,TRSPTYPE=<trsptype>]
postamp preamp regen
NOTE:
Two WCI cards are added to the system after a regen is entered. As the result, two WCI cards are presented in RTRVEQPT command, the optional REGEN GROUP is presented in the nameblk (see WCI below).
shelf smx10g
SHELFTYPE=<shelftype> [,XMTFMT=<xmtfmt>,SNELABEL=<snelabel>][,MATE=<mate>]
NOTE:
Either XMTFMT and SNELABEL, or MATE must be entered, but not all three. Both XMTFMT and SNELABEL are displayed for the RTRV-EQPT command. MATE is displayed for RTRVEQPT only when two SMX10Gs are paired.
stem stmx
WAVE=<wave> The WAVE is only required when the NE type is not "gateway". Normal: NUMPORTS=<numports>,XMTFMT=<xmtfmt>,OHMODE=<ohmode>, WAVE=<wave> Chain: NUMPORTS=<numports>,XMTFMT=<xmtfmt>,OHMODE=<ohmode>
3 - 132
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Eqp Type
Nameblk
sync
REFTYPE=<reftype>,FRMFMT=<frmfmt>,LINECDE=<linecde>, SSM=<ssm>, SABIT=<sabit>
NOTE:
Valid FRMFMT & LINECDE combinations follow: <linecde> "T1ESF" must have <frmfmt> of "AMI" or "B8ZS" <linecde> "T1SF" must have <frmfmt> of "AMI" or "B8ZS" <linecde> "E1F" must have <frmfmt> of "HDB3" or "AMI" <linecde> "E1U" must have <frmfmt> of "NONE"
upsr
WESTWAVE=<wave>,WESTAID=<eqptaid>,WESTWCITYPE=<wcitype>,TR SPTYPE=<trsptype>[,WESTNOCWDM=<nocwdm>], EASTWAVE=<wave>,EASTAID=<eqptaid>, EASTWCITYPE=<wcitype> [,EASTNOCWDM=<nocwdm>] [WAVE=<wave>],[SIDE=<SIDE>],[BAND=<band>], WCITYPE=<wcitype>,TRSPTYPE=<trsptype> [,NOCWDM=<nocwdm>]
wci
NOTE:
REGENGROUP=<westWCIaid>&<eastWCIaid > is presented in the nameblk for RTRV-EQPT command if the WCI is added as a result of adding a regen. For standAlone WCI on a gateway node, side and band parameters are used instead of the wave parameter.
wps
SPLITMODE=<splitmode>
System Response Syntax u NormalThe normal response is a normal output response with an empty text block.
u
ErrorA standard error response indicates one of the following error codes: Description Input - parameter missing Input - data not valid Input - command not valid Input - command not valid
Error Code IPMS IDNV ICNV ICNV
3 - 133
3
TL1 COMMANDS
NOTE:
ONLINETM7000/9000/11000
The SYNC circuit pack provides BITS source, the ADM circuit pack receives this source if the SET-SYNCN command specifies a syncsrc of EXTREFA or EXTREFB for the given ADM card.
NOTE:
When provisioning an ADM or SMX10G, first decide if it is paired with another to provide either line protection (SONETUPSR or SONET BLSR, available only for ADM) or tributary side protection. When provisioning the first ADM or SMX10G in a pair or when provisioning an ADM or SMX10G that does not have a mate (unprotected or UPSR protected), the XMTFMT and SNELABEL parameters are required. The MATE parameter cannot be used. When provisioning a Mate ADM, the XMTFMT and SNELABEL cannot be used, but the MATE parameter must be provided. The MATE parameter must contain the EQPT AID of the adjacent circuit pack that is used to provide protection between the mated pair of ADM or SMX10G circuit packs.
NOTE:
Note that the internal SNE is deleted after the second circuit pack of the pair or only circuit pack of an unpaired ADM or SMX10G is deleted with the DLT-EQPT command. Also note that other interfaces such as CLI and CIT are still responsible for deleting the SNE after deleting the associated ADM and SMX10G circuit packs with a non-TL1 interface.
3 - 134
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ENT-EXTIF
enter-external interface
Purpose This command is used to provision an external interface to the BWDM, all-band BWDM, or CWDM for 3rdparty DWDM circuits. User Input Syntax
ENT-EXTIF:[<tid>]:<aid>:[<ctag>]:::MUXTYPE=<muxtype>,EXPINP=<expinp>, TGTOUTP=<tgtoutp>;
Parameter tid aid ctag muxtype expinp tgtoutp
Description Target identifier Access Identifier Identifies the external interface to be created. Grouping is not supported. Correlation tag Specifies if the external interface is connected to a BWDM or CWDM circuit pack. Valid values are: (BWDM|CWDM) Expected input power in dBm. Valid values are: (-25 to 12) Target Output Power in dBm. Valid values are: (-30 to 12)
u
3 - 135
3
TL1 COMMANDS ENT-FFP
enter-facility protection group
Purpose Create a facility protection group. This command associates a protecting (alternate) facility with a protected main or preferred) facility(s). It also provides for entering attributes of the facility protection group. User Input Syntax
ENT-FFP-{<rr>}:[<tid>]:<workaid>,<protaid>:[<ctag>]:::PROTTYPE=<prottype> [,RVRTV=<rvrtv>][,WTR=<wtr>][,WPSAID=<wpsaid>][,NODEID=<nodeid>][,RINGMAPID= <userlabel>][,USERLABEL=<userlabel>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code.For a prottype of SBLSR, only OC48 and STM16 are supported. See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier Access identifier Identifies the working/protected entity in the protection group. Grouping is not supported for this command.
tid workaid
NOTE:
When entering an FFP with prottype of MATEDTM, the <workaid> is referred to as the <primaryaid>. When entering an FFP with prottype of SBLSR, the <workaid> is referred to as the <westaid>.
protaid
Access identifier Identifies the alternate/protecting entity in the protection group. Grouping is not supported for this command.
NOTE:
When entering an FFP with prottype of MATEDTM, the <protaid> is referred to as the <secondaryaid>. When entering an FFP with prottype of SBLSR, the <protaid> is referred to as the <eastaid>.
ctag rvrtv wtr prottype
Correlation tag Revertive protection mode. An FFP with a prottype of SBLSR must always be set to Y. Wait-to-restore timein seconds. If not specified, the default value is 300 (seconds). Protection type
3 - 136
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter wpsaid
Description The equipment AID of the WPS. This field is required when <prottype> is OUPSR or STMXODPR and is denied when <prottype> is APS or MATEDTM. This field specifies the AID of an existing or non-existing WPS. If the WPS is not already provisioned, it is automatically be added when ENT-FFP is issued. If the WPS has already been provisioned, this command simply sets up protection on the WPS. The user-supplied name for a logical node or ring and is only used with prottype of SBLSR. An integer indicating a unique identifier for the logical node in an FFP of type SBLSR. Valid node IDs are 0-15.
userlabel nodeid
u
ErrorA standard error response indicates one of the following error codes: Description Input - invalid syntax or punctuation Input - parameter not valid Input - parameter missing Input - parameter extra Input - data not valid Input - data, range error Input - command not valid Input - block not consistent Description Input - block extra Input - block missing Equipage - not equipped Equipage - wrong type Status - aborted Status - data not consistent Status - stopped Status - system resources exceeded Status - all resources busy
Error Code IISP IPNV IPMS IPEX IDNV IDRG ICNV IBNC Error Code IBEX IBMS ENEQ EQWT SABT SDNC SSTP SSRE SARB
3 - 137
3
TL1 COMMANDS ENT-PASS
enter-pass
Purpose Provisions pass-through circuits for bands and/or channels. User Input Syntax
ENT-PASS:[<tid>]:<westaid>,<eastaid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid westaid
Description Target identifier Access identifier. Identifies an AID associated with the passthrough circuit. Grouping is not supported for this command. See westaid. Identifies the passthrough band and channel associated with the passthrough circuit. Correlation tag
eastaid aid ctag
u
3 - 138
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ENT-RNGMAP-VNODE
enter- ringmap- vnode
Purpose ENT-RNGMAP-VNODE modifies the ringmap of an FFP with prottype=SBLSR. Content of the ringmap includes a node ID which is unique among the BLSR nodes within the overlay ring and an ordered list of logical nodes within the ring in a clockwise direction. The node ID value is in the range of 0 - 15. User Input Syntax
ENT-RNGMAP-VNODE:[<tid>]:[<aid>]:[<ctag>]:::NODEID=<nodeid>,NODEID0=<nodeid> [,NODEID1=<nodeid>][,NODEID2=<nodeid>][,NODEID3=<nodeid>][,NODEID4=<nodeid>] [,NODEID5=<nodeid>][,NODEID6=<nodeid>][,NODEID7=<nodeid>][,NODEID8=<nodeid>] [,NODEID9=<nodeid>][,NODEID10=<nodeid>][,NODEID11=<nodeid>] [,NODEID12=<nodeid>][,NODEID13=<nodeid][,NODEID14=<nodeid>] [,NODEID15=<nodeid>];
Parameter tid aid ctag nodeid
Description Target identifier Access identifier Identifies the entity to be provisioned by this command. Correlation Tag The integer indicating a unique identifier for this node in the overlay ring. Valid node IDs are 0-15.
u u
NormalThe normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid correlation tag Input - invalid parameter grouping Input - non-null unimplemented parameter Input - parameter missing
3 - 139
3
TL1 COMMANDS ENT-SBR
enter-subrate
Purpose Provision end-to-end subrate circuits through the network. It can also be used to provision open ended subrate circuits where the format of the AID for the open ended side of the subrate must be <nodeId>-0-0P0-0 for <nodeid>-<shelf>-<slot>-P<port>-<timeslot>. User Input Syntax
ENT-SBR:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::USERLABEL=<userlabel>, SVCTYP=<svctyp>[:<pst>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier. Identifies the equipment associated with the command. Correlation tag. User-specified name for the subrate circuit. Data format of the subrate service:
u u u u
aaid, zaid, z2aid ctag userlabel svctyp
GBE - Gigabit Ethernet FC Fiber Channel FICON - Fibre Channel ESCON MUX
3 - 140
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
NOTE:
Subrate information is common to all nodes in a ring. When a subrate is entered, the command can be issued on any TID in the ring.
3 - 141
3
TL1 COMMANDS ENT-TRAIL
enter-trail
Purpose Provision a trail connection from an STMX, GRDM, ESCON MUX, SMX10G, or ADM CP to a WCI CP (or another STMX, GRDM, ESCON MUX, SMX10G, or ADM CP for port chaining configurations). User Input Syntax
ENT-TRAIL:[<tid>]:<fromAid>,<toAid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Correlation tag Access identifier that identifies the "from" facility. Access identifier that identifies the "to" facility.
ctag fromAid toAid
u
ErrorA standard error response indicates one of the following error codes: Description Input - data not found Status - requested operation failed
NOTE:
The AID block contains two position-independent AIDs for this command and, therefore, the <fromaid> and <toaid> can be swapped. An AID entered as 5-2-P2,2-2 is retrieved (RTRV-TRAIL) as 2-2,5-2-P2. The AID can be deleted using either 5-2-P2,2-2 or 2-2,5-2-P2. The rule to follow for determining order is a string compare where the AID with the smaller number is first.
3 - 142
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
ENT-UNSWTS
enter-unswitched timeslots
Purpose ENT-UNSWTS provisions unswitched timeslots for NUT / ENUT traffic. User Input Syntax
ENT-UNSWTS:[<tid>]:<aid>:[<ctag>]:::TSTYPE=<tstype>,STARTTS=<startts>, ENDTS=<endts>;
Parameter tid aid ctag tstype
Description Target identifier. Access identifier. Identifies the equipment and timeslots to be added. Correlation tag. The type of timeslot. The valid values are:
u u u
NUT (only valid for 1+1 protected ports) DISABLE_SPANSW (only valid for BLSR protected ports) DISABLE_RINGSW (only valid for BLSR protected ports).
startts endts
u u
The start timeslot of the unswitched traffic to be provisioned. The end timeslot of the unswitched traffic to be provisioned NormalThe normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid correlation tag Input - invalid parameter grouping Input - non-null unimplemented parameter Input - parameter missing
3 - 143
3
TL1 COMMANDS ENT-VLAN
enter-virtual LAN
Purpose Provision datawire virtual LANs. User Input Syntax
ENT-VLAN:[<tid>]:<aid>:[<ctag>]:::<vlanid>;
ONLINETM7000/9000/11000
Description Target identifier. Access identifier. Identifies the facility to create. Correlation tag. Virtual LAN identification number.
u
Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid target identifier Input - parameter missing Privilege - illegal user identity Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed
3 - 144
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
INIT-RNGMAP-VNODE
initialize-ringmap
Purpose INIT-RNGMAP-VNODE provisions the ringmap of an FFP with prottype=SBLSR. Content of the ringmap includes a node ID which is unique among the BLSR nodes within the overlay ring and an ordered list of logical nodes within the ring in a clockwise direction. The node ID value is in the range of 0 - 15. User Input Syntax
INIT-RNGMAPVNODE:[<tid>]:[<aid>]:[<ctag>]:::NODEID=<nodeid>,NODEID0=<nodeid>[,NODEID1=<nod eid>][,NODEID2=<nodeid>][,NODEID3=<nodeid>][,NODEID4=<nodeid>][,NODEID5=<nodeid >][,NODEID6=<nodeid>,][NODEID7=<nodeid>][,NODEID8=<nodeid][,NODEID9=<nodeid>][, NODEID10=<nodeid>][,NODEID11=<nodeid>][,NODEID12=<nodeid>][,NODEID13=<nodeid][, NODEID14=<nodeid>][,NODEID15=<nodeid>];
Parameter tid aid ctag nodeid
Description Target identifier Access identifier Identifies the entity to be provisioned by this command. Correlation Tag The integer indicating a unique identifier for this node in the overlay ring. Valid node IDs are 0-15.
u u
NormalThe normal output response is an empty text block. ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid correlation tag Input - invalid parameter grouping Input - non-null unimplemented parameter Input - parameter missing
3 - 145
3
TL1 COMMANDS OPR-LPBK
operate-loopback
Purpose Instruct an NE to perform a loopback on a specified facility. It is assumed that the specified entity is in a state that allows a loopback to occur. If not, an error response is issued by the NE. User Input Syntax
OPR-LPBK-<rr>:[<tid>]:<aid>:[<ctag>]::[<locn>],[<orgn>],[<intext>],<lpbktype>;
ONLINETM7000/9000/11000
Parameter tid aid ctag locn orgn intext lpbktype
Description Target identifier Access identifier that identifies the equipment to retrieve. If empty, all fiber equipment is displayed. Correlation tag Identifies the location where the loopback occurs. Not supported for this release. Office that originated the signal to be looped back. Not supported for this release. Directs the NE to provide a loopback that is with the benefit of reshaping. Not supported for this release. Loopback type, as defined in Parameter Definitions and Rules. There is only one loopback per facility. The loopback type specifies what kind of loopback is present (and is the value to which the internal loopback status attribute is set). A <lpbktype> of NOLPBK is invalid for this command, because it specifies that no loopback is present. Use the RLS-LPBK command to release the loopback.
3 - 146
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not found Status - requested operation failed Status - invalid request
Error Code ICNV IDNV IIAC IICT IIFM IIPG PLNA SCNF SROF SRQN
3 - 147
3
TL1 COMMANDS RD-SYNCN
read-synchronization
Purpose Display the synchronization source table for the specified SONET MUX circuit pack. User Input Syntax
RD-SYNCN:[<tid>]:<aid>:[<ctag>];
ONLINETM7000/9000/11000
Description Target Identifier Access Identifier Identifies the synchronization source to retrieve. Correlation tag
System Response Syntax u NormalThe normal output response is:

^^^"<aid>:SYNCSRC=<syncsrc>,SYNCPRI=<syncpri>[,SYNCSIDE=<side>][,SYNCSSM=<ssm>[ ,SYNCFQL=<fql>[,SYNCSSMMODE=<ssmmode>][,SYNCPNO=<pno>][,CLKID=<clockid>, OUTGOINGSSM=<outgoingssm>,RECEIVEDSSM=<receivedssm>][,SYNCSTATE=<syncstate][,WT R=<wtr>][,RVRTV=<rvrtv>:pst"<cr><lf>
Parameter aid syncsrc syncpri side syncssm syncfql syncssmmode pno clockid outgoingssm receivedssm sycnstate wrt
Description Access identifier. Synchronization source. Priority of the entered synchronization source. Port- or line-side qualifier. This parameter is only displayed for paired ADM CPs. An option field associated with a facility. The possible values are (ENABLE or DISABLE). The default is DISABLE. Forced Quality Level. When the SSM is disabled, a FQL must be selected from the list of forced quality levels for this SSM processing mode. The SSM processing mode. Provisionable Networks Operator quality level Clock ID of the facility. Valid values are ( auto|1..20). Outgoing SSM on the facility [no_override|dus_dnu|stu_allzero] Received SSM on the facility. Shows the current status of the clock source. Wait To Restore Time. Any number in the range of 0 and 12 (0 and 12 inclusive)
3 - 148
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter rvtv pst

u
Description Revertive parameter. Sets the synchronization switch to revert or not revert. Valid values are Y or N. The desired primary state of the entity.
3 - 149
3
TL1 COMMANDS RLS-LPBK
release-loopback
Purpose Instruct an NE to release loopback on a specified facility. It is assumed that the specified entity is in a state that allows a loopback to occur. If not, an error response should be issued by the NE. User Input Syntax
RLS-LPBK-<rr>:[<tid>]:<aid>:[<ctag>]::[<locn>],[<orgn>],[<intext>], [<lpbktype>];
ONLINETM7000/9000/11000
Parameter tid aid ctag locn orgn intext lpbktype
Description Target identifier Access identifier that identifies the equipment to retrieve. If empty, all fiber equipment is displayed. Correlation tag Identifies the location where the loopback occurs. Not supported for this release. Office that originated the signal to be looped back. Not supported for this release. Directs the NE to provide a loopback that has the benefit of reshaping. Not supported for this release. Loopback type, as defined in Parameter Definitions and Rules. There is only one loopback per facility. The loopback type specifies what kind of loopback is present (and is the value to which the internal loopback status attribute is set). Only a <lpbktype> of NOLPBK is valid for RLS-LPBK, because it specifies no loopback is present. Not supported as input for this release because it always defaults to NOLPBK.
3 - 150
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not found Status - requested operation failed Status - invalid request
Error Code ICNV IDNV IIAC IICT IIFM IIPG PLNA SCNF SROF SRQN
3 - 151
3
TL1 COMMANDS RMV-{ }
remove- facility
Purpose Remove one or more equipment units, facilities, ISDN channels, or interfaces, subscriber lines, trunks, links, packet links, or signaling links from service. The entity is taken from an in-service state and placed in a maintenance state in which maintenance activities can be performed or moved from the current maintenance state to another maintenance state. No alarms should be generated at the near end office as a result of the REMOVE command. Once an entity is removed from service, service-affecting diagnostic routines or physical replacement of defective equipment can be initiated. This command is restrictive and is intended for maintenance purposes only. The functionality of this command can also be achieved by using the ED (edit) command in this section. User Input Syntax
RMV-{EQPT | LINK | SYNCN | CKT | SBR | PMM |VNODE | EXTIF | <rr>} :[<tid>]:<aid>:[<ctag>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing.
tid aid ctag
Target identifier Access Identifier Identifies the equipment associated with the command. Correlation tag
u
ErrorA standard error response indicates one of the following error codes: Description Input - data not found Status - requested operation failed Status - not valid source
Error Code IDNV SROF SNVS
3 - 152
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RST-{ }
restore-facility
Purpose Instruct an NE to restore one or more equipment units, facilities, ISDN channels or interfaces, subscriber lines, trunks, links, packet links, or signaling links to service. The entity is taken from a maintenance state and placed in an in-service state for which the unit is ready to provide its service functions. It is assumed that these entities are in good working condition. This command is restrictive and is intended for maintenance purposes only. The functionality of this command can also be achieved by using the EDIT command described in this section. User Input Syntax
RST-{EQPT | LINK | SYNCN | CKT | SBR | PMM |VNODE| EXTIF | <rr>} :[<tid>]:<aid>:[<ctag>];
Parameter rr
Description Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier Access Identifier Identifies the equipment associated with the command. Correlation tag
tid aid ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - data not found Status - requested operation failed Status - not valid source
Error Code IDNV SROF SNVS
3 - 153
3
TL1 COMMANDS RTRV-CKT
retrieve-circuit
Purpose Display information about circuits on a subnetwork.
ONLINETM7000/9000/11000
NOTE:
After upgrading from a version lower than 5.0 to 5.0 or higher the RTRV-CKT command may respond with a message stating "Could Not Update Circuit Table." If this occurs and all nodes on the ring have been upgraded to the same version and are all operating the system is ready to update the Circuit Table. The table is upgraded when any type of provisioning occurs on a circuit. The RTRV-CKT command does not work correctly until some type of provisioning is executed on a circuit. If no provisioning is required, the easiest way to tell the system to upgrade the table is by issuing an ED-CKT command on an existing circuit and attempt to rename the userlabel to the existing userlabel name. This command fails stating that the new entry name is duplicated, but it also upgrades the table allowing the RTRV-CKT command to operate correctly from this point on for all nodes on the ring.
User Input Syntax

RTRV-CKT:[<tid>]:[<aaid>,<zaid>[,<z2aid>]]:[<ctag>]:::[ABAND=<band>] [,ACHANNEL=<channel>][,ZBAND=<band>] [,ZCHANNEL=<channel>];
Parameter tid aaid, zaid, z2aid ctag aband, zband achannel, zchannel
Description Target identifier Access Identifier Identifies the equipment associated with the circuit. Correlation tag Band number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits. Channel number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits.

^^^"<aaid>,<zaid>[,<z2aid>]:ASIDE=<side>,AZWAVE=<wave>,ZAWAVE=<wave>,USERLABEL= <userlabel>,ACCESSTYP=<accesstyp>,CKTTYP=<ckttyp>,SVCTYP=<svctyp>[,BITRATE=<bit rate>][,PATHFEC=<pathfec>]:<pst>"<cr><lf>
Parameter aid, zaid, z2aid ctag
Description Access identifier Identifies the circuit. Correlation tag TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
3 - 154
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter userlabel accesstyp ckttyp svctyp bitrate side
Description User-specified name for the circuit. Access type of the circuit. Type of circuit to be added or dropped. Data format of the service to be added or dropped. Bit rate of the circuit. Specifies the working path on the "A" node. The "Z" side working path is always the opposite of the "A" side and is therefore not required to be specified. Valid values are {W|E}. The wave associated with the circuit in the given direction. Indicates if the fec coder along the circuit are set by the auto config algorithm or turned off. The primary state of the object.
wave pathfec pst

u
3 - 155
3
TL1 COMMANDS ONLINETM7000/9000/11000 RTRV-CKTINFO-{OCH | <RR> | GBE | FC | FICON | EQPT}
retrieve-circuit information-{Optical Channel Facility | Circuit Rate | Gigabit Ethernet | Fibre Channel | FICON | Equipment}
Purpose Given the AID of a particular facility or CP, display circuit userlabel and circuit rate information for every circuit with a termination point at a particular facility or CP.
NOTE:
This command does not display subrate circuits for WCI tributary facilities.
User Input Syntax

RTRV-CKTINFO-{OCH | <rr> | GBE | FC | FICON | EQPT}:[<tid>]:<aid>:[<ctag>] :::[ABAND=<band>][,ZBAND=<band>][,ACHANNEL=<channel>][,ZCHANNEL=<channel>];
Parameter tid
Description The target identifier that identifies the target NE to which a command is directed. The value of <tid> consists of a maximum of 20 ASCII characters, limited to letters, digits, and hyphens. The value of <tid> may be null when the OS directly interfaces with the target NE. The recommended value for the <tid>, when it is used, is the targets CLLI code. Access identifier that identifies the entity that is being reported. The correlation tag that is used to correlate input and response messages. The value of <ctag> is an identifier or a decimal numeral and is limited to a maximum of six ASCII characters. It is assigned by the OS and must be included in NE input and response messages where specified. Band number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits. Channel number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits.
aid ctag
aband, zband achannel, zchannel

^^^"<aid>:USERLABEL=<userlabel>,SVCTYPE=<rr><cr><lf>
Parameter aid
Description Access identifier that identifies the single equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE, depending on the message code modifier to which this event pertains. Text label representing a user-nameable entity. Consists of a quoted string of up to 64 characters. Grouping is not supported for this parameter.
userlabel
3 - 156
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter rr
Description Circuit rate code. Supported rate codes are:

u u u u u u u u
GBE (Gigabit Ethernet) ESCON FC (Fibre Channel) FICON STM1 (SDH STM-1) STM4 (SDH STM-4) STM16 (SDH STM-16) STM64 (SDH STM-64)
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid access identifier Input - invalid correlation tag Status - internal database error Status - requested operation failed
Error Code ICNV IIAC IICT SDBE SROF
3 - 157
3
TL1 COMMANDS RTRV-CKTINFO-CKT
retrieve-circuit information-circuit
Purpose Display information about a particular circuit (given its AID). This information includes:
u u u u
ONLINETM7000/9000/11000
Circuit userlabel Circuit rate A-end facility AID, equipment AID, and CP Z-end facility AID, equipment AID, and CP
User Input Syntax

RTRV-CKTINFO-CKT:[<tid>]:<aid>:[<ctag>];
Parameter tid
Description The target identifier that identifies the target NE to which a command is directed. The value of <tid> consists of a maximum of 20 ASCII characters, limited to letters, digits, and hyphens. The value of <tid> may be null when the OS directly interfaces with the target NE. The recommended value for the <tid>, when it is used, is the targets CLLI code. Access identifier that identifies the entity that is being reported. The correlation tag that is used to correlate input and response messages. The value of <ctag> is an identifier or a decimal numeral and is limited to a maximum of six ASCII characters. It is assigned by the OS and must be included in NE input and response messages where specified.
aid ctag

^^^"<aid>:USERLABEL=<userlabel>,SVCTYPE=<rr>,ANODEID=<nodeid>,AFACAID=<afacaid> ,AEQUIPAID=<aequipaid>,ACARD=<acard>,ZNODEID=<nodeid>,ZFACAID=<zfacaid>, ZEQUIPAID=<zequipaid>,ZCARD=<zcard><cr><lf>
Parameter aid acard aequipaid afacaid anodeid userlabel
Description Access identifier The pcode of the card associated with the a-end of the circuit. The Equipment aid of the card associated with the a-end of the circuit. The aid of the associated a-end facility. The node id of the a-end system (text). A text label representing an user nameable entity. Consists of a quoted string containing up to 64 characters. Grouping is not supported for this parameter.
3 - 158
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter rr
Description Circuit rate code. Supported rate codes are:

u u u u u u u u
GBE (Gigabit Ethernet) ESCON FC (Fibre Channel) FICON STM1 (SDH STM-1) STM4 (SDH STM-4) STM16 (SDH STM-16) STM64 (SDH STM-64)
zcard zequipaid zfacaid znodeid

u
The pcode of the card associated with the z-end of the circuit. The Equipment aid of the card associated with the z-end of the circuit. The aid of the associated z-end facility. The node id of the z-end system (text). ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid access identifier Input - invalid correlation tag Status - internal database error Status - requested operation failed
Error Code ICNV IIAC IICT SDBE SROF
3 - 159
3
TL1 COMMANDS RTRV-CRS-<RR>
retrieve-cross [connections]
Purpose Retrieve the STS-12C, STS-3C, STS-1, AU4 and AU44C level, cross-connections associated with the entered AID. Parameter grouping is not supported for this command. User Input Syntax
RTRV-CRS-{STS12C|STS3C|STS1|AU4|AU44C}:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access identifier that identifies the cross-connect. If not specified, all crossconnects supported by the second modifier are displayed. Either the from, to or both (comma separated) AIDs can be specified. Correlation tag
fromaid
ctag

^^^"<fromaid>,<toaid>[,<frompaid>][,<topaid>]:<cct>,<payload>:XCTYPE=<xctype>[, LINETSMODE=<linetsmode>][,TRIBTSMODE=<tribtsmode>][:<pst>[,<sst>]>]" <cr><lf>
Parameter fromaid toaid cct payload xctype linetsmode
Description Access identifier which identifies the originating facility. Access identifier which identifies the destination facility. Cross-connect type Associated payload rate MUX-connection type The switching mode of the timeslot on the line side of the XC (for APS 1+1 or SBLSR related cross-connects, when specifying switched or unswitched timeslots). The switching mode of the timeslot on the tributary side of the XC (for APS 1+1 or SBLSR related cross-connects, when specifying switched or unswitched timeslots). Primary state of the cross-connect Secondary state of the cross-connect
tribtsmode
pst sst
3 - 160
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
ErrorA standard error response indicates one of the following error codes: Description Input -data not valid Input - invalid access identifier Status - requested operation failed
Error Code IDNV IIAC SROF
3 - 161
3
TL1 COMMANDS RTRV-EQPT
retrieve-equipment
Purpose Display the provisioning information of a CP or other contents of a slot in an NE. User Input Syntax
RTRV-EQPT:[<tid>]:[<aid>]:[<ctag>]::[<eqptype>][:ACTION=<attrfilter>] [:<pst>[,<sst>]];
ONLINETM7000/9000/11000
Parameter tid aid
Description Target identifier Access Identifier Identifies the equipment associated with the equipment being requested for display. Correlation tag The type of CP for a given input command This field is used to filter retrieve actions. The actions supported are (RXSSM). The desired primary state of the object. Not supported for RTRV-EQPT command input. The desired secondary state of the object. Not supported for RTRV-EQPT command input.
ctag eqptype attrfilter pst sst

^^^<aid>:[<pcode>,<width>]:[<eqptype>][,<nameblk>] [:<pst>[,<sst>]]<cr><lf>
Parameter aid
Description Access Identifier Identifies the equipment associated with the equipment being requested for display. The product code of the CP. The number of slots occupied by the CP. Type of CP for a given input command The set of vendor-defined extensions for provisioning specific CPs. Possible values are defined in Table 3-2, Parameters Displayed in Response to <rr>, on page 3-171 for each supported <eqptype>. The primary state of the object Secondary state of the cross-connect TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
pcode width eqptype nameblk
pst sst
3 - 162
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Table 3-1. Parameters Available in <nameblk> for Response to RTRV-EQPT P P O G R R L O P S R E I E D N S M T A G C M A M E M M N 2 E P P S H E L F S M X 1 0 G
PARAMETER
A A B C D D E G W W R L D D D C C M D L M H M X M M M Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
S T E M
S T M X
S Y N C
U W W P S C P I S R
ACCESSTYP ADMTYPE BAND CCTPKTYPE CLUSTERID DATAPROT DCMLIST DCMTYPE EASTAID EASTEXTPAD EASTNOCWDM EASTWCITYPE EASTWAVE EMAXOUTP FCHAINPOS FRMFMT FROMBAND FROMCP GAINMODE GRDMTYPE LINECDE MATE NOCWDM NUMPORTS OHMODE
Y Y Y Y Y Y Y
Y Y Y Y Y Y Y Y Y
Y Y Y Y Y Y Y Y Y Y
3 - 163
3
Table 3-1. Parameters Available in <nameblk> for Response to RTRV-EQPT P P G R O R L O P S R E I E D N S M T A G C M A M E 2 E M M N P P Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y S H E L F S M X 1 0 G
PARAMETER
A A B W L D D L M M Y Y Y Y
C D D E G W R D C C M D H M X M M
S T E M
S T M X
S Y N C
U W W P S C P I S R
PMMTYPE PMODE REFTYPE REGENGROUP SABIT SHELFTYPE SIDE SNE SNELABEL SPLITMODE SSM TOBAND TOCP TRSPTYPE VGATYPE WAVE WCITYPE WESTAID WESTEXTPAD WESTNOCWDM WESTWCITYPE WESTWAVE WMAXOUTP XMTFMT
3 - 164
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
ErrorA standard error response indicates one of the following error codes: Description Input - invalid syntax or punctuation Input - parameter not valid Input - parameter missing Input - parameter extra Input - data not valid Input - data, range error Input - command not valid Input - block not consistent Input - block extra Input - block missing Equipage - not equipped Equipage - wrong type Status - aborted Status - data not consistent Status - stopped Status - system resources exceeded Status - all resources busy
Error Code IISP IPNV IPMS IPEX IDNV IDRG ICNV IBNC IBEX IBMS ENEQ EQWT SABT SDNC SSTP SSRE SARB
NOTE:
A value of Y indicates that the parameter could be present for the given type but is not always present for that type. An empty field indicates that the value cannot be present for that type.
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid
Error Code ICNV IDNV
NOTE:
The RTRV-EQPT command does not display a REGEN as a single piece of equipment; instead it displays two separate WCI CPs, each indicating that it is part of a REGENGROUP.
3 - 165
3
TL1 COMMANDS RTRV-EXTIF
retrieve-external interface
Purpose This command is used to retrieve information about an existing external interface. User Input Syntax
RTRV-EXTIF:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Description Target identifier Access Identifier Identifies the external interface to be created. Grouping is not supported. Correlation tag

^^^"<aid>::MUXTYPE=<MuxType>,EXPINP=<expinp>,TGTOUTP=<tgtoutp>>"<cr><lf>
Parameter aid muxtype expinp tgtoutp

u
Description Access Identifier Identifies the external interface to be created. Grouping is not supported. Specifies if the external interface is connected to a BWDM or CWDM circuit pack. Valid values are: (BWDM|CWDM) Expected input power in dBm. Valid values are: (-25 to 12) Target Output Power in dBm. Valid values are: (-30 to 12)
ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid access identifier Status - requested operation failed
3 - 166
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-{<RR>|SYNCN|PMM|LINK} RTRV-FAC-{<RR>|ALL|PMM|LINK}
retrieve-facility [data and state parameters]
Purpose These commands retrieve the data and state parameters for facilities on the network element. Parameter grouping is not supported for this command. Table 3-2 lists the parameters that can be displayed in the response output depending on the second modifier (<rr>|ALL|SYNCN|PMM|LINK) entered in the command input. User Input Syntax
RTRV-{<rr>|SYNCN|PMM|LINK}:[<tid>]:[<aid>]:[<ctag>]; RTRV-FAC-{<rr>|ALL|PMM|LINK}:[<tid>]:[<aid>]:[<ctag>][ :::[ACTION=<attrfilter>]];
Parameter tid aid ctag attrfilter
Description Target identifier Access Identifier Identifies the facility from which to retrieve data. Correlation tag This field is used to filter retrieve actions. The actions supported are (RTRV<rr> RXSSM and TXSSM, RTRV-SYNCN: SYNCSRCREPORT).

^^^"<aid>::[ALWB1=<alwB1>][,ALWB2=<alwB2>][,ALWD1_D3=<alwD1_D3>][,ALWD4_D12=<al wD4_D12>][,ALWE1=<alwE1>][,ALWE2=<alwE2>][,ALWF1=<alwF1>][,ALWJ0=<alwJ0>][,ALWK 1_K2=<alwK1_K2>][,ALWM1=<alwM1>][,ALWS1=<alwS1>][,ALWSS=<alwSS>][,ALWX1=<alwX1> ][,ALWX2=<alwX2>][,ALWZ0=<alwZ0>][,ALWZ1=<alwZ1>][,ALWZ2=<alwZ2>][BAND=<band] [,BITRATE=<bitrate>][,CONCAT=<concat>][,CONNST=<connst>][,ENABLEDCC=<enabledcc> ,ENABLEOSPF=<enableospf>][,EQPT=<eqpt>][,EXCOLL=<excoll>][,EXPSECTR=<expsectr>] [,FAULTPROPMODE=<faultpropmode>][,FRMFMT=<frmfmt>][,GOODRXFRM=<goodrxfrm>][,GOO DTXFRM=<goodtxfrm>][,FLTRXFRM=FltrRxFrm][,LATECOLL=<latecoll>][,LPBKTYPE=<lpbkt ype>][,LINECDE=<linecde>][,MULTIPLECOLLTXFRM=<multiplecolltxfrm>][,OHMODE=<ohmo de>][,OUTSECTR=<outsectr>][,RECSCETR=<recsectr>][,REFTYPE=<reftype>][,RXCRCERRO RS=<rxcrcerrors>][,RXOCTETS=<rxoctets>][,SDBERT=<sdbert>][,SECTRMON=<sectrmon>] [,SECTRTP=<sectrtp>][,SENSEERRS=<senseerrs>][,SFBERT=<sfbert>][,SIDE=<side>] [,SINGLECOLTXFRM=<singlecoltxfrm>][,TMAP=<tmap>][,TMODE=<tmode>][TTERM=<tterm>] [,TRANFMT=<tranfmt>][,TRIBTS=<tribts>][,TXOCTETS=<txoctets>][,WAVE=<wave>][,CLK ID=<clkid>,OVROUTSSM=<ovroutssm>,RECEIVEDSSM=<receivedssm>][,IPMAPPING=<ipmap>] [,DCCTYPE=<dcctype>][,PEERIP=<peerip>][,SUBIP=<subip>][,SUBNETMASK=<subnetmask> ][,MTU=<mtu>][,FCS=<fcs>][:<pst>[,<sst>]]"<cr><lf>
3 - 167
3
Parameter aid alwB1 alwB2 alwD1_D3 alwD4_D12 alwE1 alwE2 alwF1 alwJ0 alwK1_K2 alwM1 alwS1 alwSS alwX1 alwX2 alwZ0 alwZ1 alwZ2 band bitrate concat connst datarate enabledcc Description Access identifier. Identifies the facility to modify. Enable state of the B1 Section BIP-8 overhead transparency byte. Enable state of the B2 Line BIP-8 overhead transparency byte. Enable state of the D1_D3 Section DCC overhead transparency byte. Enable state of the D4_D12 Line DCC overhead transparency byte. Enable state of the E1 Section Orderwire overhead transparency byte Enable state of the E2 Line Orderwire overhead transparency byte. Enable state of the F1 User Channel overhead transparency byte. Enable state of the J0 Section Trace overhead transparency byte. Enable state of the K1_K2 APS overhead transparency byte. Enable state of the M1 Line REI overhead transparency byte. Enable state of the S1 Synchronization overhead transparency byte. Enable state of the SS SONET/SDH overhead transparency byte. Enable state of the X1 National overhead transparency byte. Enable state of the X2 National overhead transparency byte. Enable state of the Z0 Section Growth overhead transparency byte. Enable state of the Z1 Growth overhead transparency byte. Enable state of the Z2 Growth overhead transparency byte. Band of the facility. Bit rate. If TRUE, this specifies concatenated payload. Applies to OC12/STM4 ports for STMX circuit packs only. Connection state. Specifies the datarate 10 mbps or 100 Mbps. Flag to indicate if dcc is enabled. The valid values are TRUE or FALSE. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. Flag to indicate if ospf is enabled. The valid values are TRUE or FALSE. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. Equipment AID associated with this facility. Excessive Collisions (Integer Value). Expected section trace
enableospf
eqpt excoll expsectr
3 - 168
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter faultpropmode frmfmt goodrxfrm goodtxfrm fltrrxfrm latecoll linecde lpbktype multiplecolltxfrm ohmode outsectr recsectr reftype rxcrcerrors rxoctets sdbert sectrmon sectrtp senseerrs sfbert side singlecoltxfrm tmap tmode tterm tranfmt
Description Fault Propagation mode. Applies only to FC, FICON, GBE and ESCON facilities. Frame Format Good Receive Frames (Integer Value). Good Transmit Frames (Integer Value). Filtered Receive Frames Late Collisions (Integer Value). Line Code Loopback type Multiple collision transmit frames (Integer Value). Overhead processing mode for this facility. Output section trace Receive section trace Reference Type Receive CRC Errors (Integer Value). Receive octets (Integer Value). SD BER Threshold (Integer Value). Section trace monitor Section trace type Carrier Sense Errors (Integer Value). SF BER Threshold (Integer Value). Side of the facility (W or E). Single collision on Transmit Frames (Integer Value). Transparency mapping. Transparency mode. Transparency termination. Transmission format for this facility.
NOTE: tribts txoctets wave clockid
Only supported on ADM circuit packs.
SONET MUX, Tributary Time Slot number associated with this facility. Transmit Octets (Integer Value). The wave the facility occupies. Clock ID of the facility. Valid values are ( auto|1..20).
3 - 169
3
TL1 COMMANDS
Parameter ovroutssm receivedssm ipmap dcctype peerip subip subnetmask mtu fcs pst sst
u
ONLINETM7000/9000/11000
Description Outgoing SSM on the facility [no_override|dus_dnu|stu_allzero] Received SSM on the facility. Valid values are [IPOHDLC | IPOPPP]. This is valid for ADM II/ GRDM II and ESCON II line side facilities and first four Tributary side facilities of ADMII. The valid values are SECTION or LINE. This is valid for ADM II, GRDM II, ESCON II line side facilities, and the first four tributary side facilities of ADMII. A valid IP address is accepted. This attribute can only be provisioned on the first four tributary side facilities of ADMII. A list of IP addresses separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII. A list of IP Subnet Masks separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII. Maximum Transfer Unit. Valid values range from 48 to 1500. This attribute can only be provisioned on the first four tributary side facilities of ADMII. Frame Check Sequence. Valid values are FCS16 and FCS32. This attribute can only be provisioned on the first four tributary side facilities of ADMII. Primary state of the specified facility. Secondary state of the specified facility.
ErrorA standard error response indicates one of the following error codes: Description Input - data not valid Input - invalid access identifier Status - requested operation failed
3 - 170
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Table 3-2. Parameters Displayed in Response to <rr> E L O D S F G I O O C B C C W O C E N B 3 1 K 2 N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y O O C C O O P 1 C M 4 9 H T M 8 2 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y S T M 1 S S T T M M 1 4 6 S T M 6 4 S T S 1 S T S 3 C S T S 1 2 C S Y N C N
PARAMETER
A L L Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
alwB1 alwB2 alwD1_D3 alwD4_D12 alwE1 alwE2 alwF1 alwJ0 alwK1_K2 alwM1 alwS1 alwSS alwX1 alwX2 alwZ0 alwZ1 alwZ2 band bitrate concat connst eqpt excoll expsectr faultpropmode
Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
3 - 171
3
Table 3-2. Parameters Displayed in Response to <rr> E L O D S F G I O O C B C C W O C E N B 3 1 K 2 N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y O O C C O O P M 1 C 4 9 H T M 8 2 S T M 1 S S T T M M 1 4 6 S T M 6 4 S T S 1 S T S 3 C S T S 1 2 C S Y N C N
PARAMETER
A L L Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
frmfmt goodrxfrm goodtxfrm latecoll linecode lpbktype multiplecolltxfrm ohmode outsectr recsectr reftype rxcrcerrors rxoctets sdbert sectrmon sectrtp senseerrs sfbert side singlecolltxfrm tranfmt tribts txoctets wave pst sst enabledcc
3 - 172
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Table 3-2. Parameters Displayed in Response to <rr> E L O S G O D C F B I O C C N B 1 W C O E K 3 2 N Y Y Y Y Y Y Y Y O C 4 8 O S S C O P O 1 C M T T M M T 9 H M 1 4 2 Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y S T M 1 6 S T M 6 4 Y Y Y Y Y Y Y Y S T S 1 S T S 3 C S T S 1 2 C S Y N C N
PARAMETER
A L L
enableospf Dcctype Ipmapping PeerIp SubIp SubnetMask MTU FCS
Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y
3 - 173
3
TL1 COMMANDS RTRV-FIBER-EQPT
retrieve-fiber-equipment
Purpose Display the fiber connection information for the NE. Fiber connections between CPs and/or NEs are displayed when this command is issued. User Input Syntax
RTRV-FIBER-EQPT:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
aid
Access identifier that identifies the equipment that is associated with the equipment that is being requested for display. If this field is empty, values for all fiber equipment are displayed. Correlation tag.
ctag

^^^FROMCP=<fromcp>,FROMCPTYPE=<fromcptype>,FROMPORT=<fromport>, FROMSIDE=<fromside>,PAD=<pad>,TOCP=<tocp>,TOCPTYPE=<tocptype>, TOPORT=<toport>,TOSIDE=<toside><cr><lf>
Parameter fromcp fromcptype fromport fromside tocp tocptype toport toside pad
Description EQPT AID of the From side CP for the fiber connection. The type of the From side CP for the fiber connection. The port of the From side CP for the fiber connection. The side of the From side CP for the fiber connection. EQPT of the To side CP for the fiber connection. The type of the To side CP for the fiber connection. The port of the To side CP for the fiber connection. The side of the To side CP for the fiber connection. The padding value of the fiber connection.
3 - 174
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - parameter missing
Error Code ICNV IDNV IPMS
NOTE:
Logical REGENs cannot be displayed with this command; however, the individual WCI CPs can be displayed.
3 - 175
3
TL1 COMMANDS RTRV-FFP
retrieve-facility protection group
Purpose Retrieve the attributes and state of a facility protection group. User Input Syntax
RTRV-FFP-{<rr>}:[<tid>]:[<workaid>],[<protaid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter rr
Description Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing. Target identifier Access Identifier Identifies the working and protected entity in the protection group. Grouping is not supported for this command. Access Identifier Identifies the alternate and protecting entity in the protection group. Grouping is not supported for this command. Correlation tag
tid workaid
protaid
ctag

^^^"<workaid>,<protaid>:[RVRTV=<rtrtv>][,WTR=<wtr>][,SWON=<swon>][,PROTTYPE=<pr ottype>][,WPSAID=<wpsaid>][,USERLABEL=userlabel>][,RINGMAPID=<userlabel>][,NODE ID=<nodeid>]"<"<cr><lf>
Parameter workaid
Description Access identifier. Identifies the working/protected entity in the protection group. It is possible to have a second protaid in this field for rate codes of OCH. Access identifier. Identifies the alternate/protecting entity in the protection group. Revertive protection mode. Displayed for COM and all rate codes (<rr>) except OT. Wait-time to restorein seconds. The condition that initiates a switch. The protection type
protaid rvrtv wtr swon prottype
3 - 176
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
Parameter wpsaid userlabel nodeid activeport
Description The equipment aid (Section 4.11.1) of the WPS. This field is only displayed when prottype is OUPSR or STMXODPR. is the userlabel for the logical node or ringmap and is only displayed for prottype=SBLSR. an integer indicating a unique identifier for the logical node. Valid node ids are 0-15. Only displayed for prottype=SBLSR. AID of the currently active (providing service) line or tributary port in the protection group.
Description Input - parameter missing Input - data not valid Input - command not valid
3 - 177
3
TL1 COMMANDS RTRV-HDR
retrieve header
Purpose Request an NE to reply with a normal response indicating COMPLD. The information of interest in the reply is the reply itself, along with information that the NE has about itself, namely the SID, date, and time. The NE must support this command in order for the user to detect whether the communication link is active, as well as to give the NE an indication that the client connection should remain active. If the TL1 agent is active and operating normally, a normal response is returned. User Input Syntax
RTRV-HDR:<tid>::<ctag>;
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Correlation tag.
ctag
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Input - non-null unimplemented parameter
Error Code ICNV IICT INUP
3 - 178
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-NETYPE
retrieve-network element type
Purpose Instructs the NE to retrieve its equipment related information. User Input Syntax
RTRV-NETYPE:[<tid>]::[<ctag>];
Parameter tid
Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. Correlation tag.
ctag

^^^"CIENA,ONLINE,<netype>,<swversion>"<cr><lf>
Parameter netype swversion
Description Network Element Type The contents of <netype> is a text string of up to 40 characters. The software release issue of a network element. The contents of <swversion> is a text string of up to 40 characters.
3 - 179
3
TL1 COMMANDS RTRV-PASS
retrieve passthrough
Purpose Display information about the passthroughs of a particular node. User Syntax Input
RTRV-PASS:[<tid>]:[<westaid>,<eastaid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access Identifier Identifies an AID associated with the passthrough circuit. If this field is left empty, all passthroughs are displayed. Grouping is not supported for this command. See westaid. Correlation tag
westaid
eastaid ctag

^^^"<westaid>,<eastaid>"<cr><lf>
Parameter westaid
Description Access identifier Identifies the pass-through band and possible the channel associated with the pass-through circuit. See westaid.
eastaid
3 - 180
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
3 - 181
3
TL1 COMMANDS RTRV-RNGMAP-VNODE
Retrieve- ringmap- vnode
Purpose This command is used to retrieve the current and backup node ids and maps for the network elements in the SONET BLSR ring. User Input Syntax
RTRV-RNGMAP-VNODE:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Description Target identifier Access identifier Identifies the entity to be provisioned by this command. Correlation Tag

^^^"<aid> NODEID=<nodeid>,USERLABEL=<userlabel>;[,NODEID0=<nodeid>][, NODEID1=<nodeid>][, NODEID2=<nodeid>][, NODEID3=<nodeid>][, NODEID4=<nodeid>] [,NODEID5=<nodeid>][, NODEID6=<nodeid>,][ NODEID7=<nodeid>][, NODEID8=<nodeid] [, NODEID9=<nodeid>][, NODEID10=<nodeid>][,NODEID11=<nodeid>] [,NODEID12=<nodeid>][ ,NODEID13=<nodeid>][,NODEID14=<nodeid>] [,NODEID15=<nodeid>]"<cr><lf>
Parameter tid aid nodeid userlabel

u
Description Target identifier Access identifier Identifies the entity to be provisioned by this command. The integer indicating a unique identifier for this node in the overlay ring. Valid node IDs are 0-15. Unique name for the overlay ringmap.
3 - 182
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-RNGSTATUS-VNODE
retrieve-ring status - vnode
Purpose Retrieve the ring status for an FFP with a prottype of SBLSR. Values retrieved include provisioning state, node state and substate, protection switching status, span, east and west switching nodes, and the transmit and receive K1/K2 byte values on the east and west ports. User Input Syntax
RTRV-RNGSTATUS-VNODE:[<tid>]:[<aid>]:[<ctag>];
Description Target identifier. Access identifier. Identifies the entity to be provisioned by this command. Correlation tag

^^^"<aid>,aidtype>]::RINGLABEL=<userlabel>,NODELABEL=<userlabel>,NODEID=<snodei d> [,K1K2EASTRX=<byte>][,K1K2EASTTX=<byte>][, [,K1K2WESTRX=<byte>] [,K1K2WESTTX=<byte>][,NODESTATUS=<nodestatus>[,ERINGSTATUS=<ringstatus>][,WRING STATUS=<ringstatus>]"<cr><lf>
Parameter ringid userlabel snodeid byte nodestatus
Description A string indicating a unique ring id. A string indicating the ring or node name An integer indicating a unique identifier for a node in the SONET BLSR ring. Valid node IDs are 0-15. The K1/K2 byte(s) received. An indication of the state of the SONET BLSR node. Possible values are: UNPROVISIONED, IDLE, SWITCHING, PASSTHROUGH, ISOLATED, UNKNOWN. An indication of the switching substate of the ring. Possible values are: NOBRIDGE, BRIDGE, BRIDGEDSWITCHED, NA.
ringstatus
3 - 183
3
TL1 COMMANDS
u
ONLINETM7000/9000/11000
3 - 184
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-SQLCHTBL-VNODE
retrieve- squelch table-vnode
Purpose Display channels being squelched on a SONET BLSR ring. User Input Syntax
RTRV-SQLCHTBL-VNODE:[<tid>]:[<aid>]:[<ctag>];
Description Target identifier. Access identifier. Identifies the entity to be provisioned by this command. Correlation tag.

u
NormalThe normal output response is:
^^^"<aid>[,aidtype]::WSVCTYPE=<svctype>,ANODEW=<nodeid>,ZNODEW=<nodeid>,ESVCTYP E=<svctype>,ANODEE=<nodeid>,ZNODEE=<nodeid>"<cr><lf>
Parameter aid svctype nodeid

u
Description Access identifier that identifies the vnode associated with the squelch table. The type of service being provided (OCx, STMX). The logical node id of an element in the overlay ring.
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not found
Error Code ICNV IDNV
3 - 185
3
TL1 COMMANDS RTRV-SBR
retrieve-subrate
Purpose Display information about circuits on a subnetwork. User Input Syntax
RTRV-SBR:[<tid>]:[<aaid>,<zaid>[,<z2aid>]]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid
Description Target identifier The name of the NE where the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications, which consists of up to 20 characters. Access Identifier Identifies the subrate circuit. If this block is null, all subrates are displayed. Correlation tag
aaid, zaid, z2aid ctag

^^^"<aaid>,<zaid>[,<z2aid>]:USERLABEL=<userlabel>,SVCTYP=<svctyp>,AWAVE=<wave>, ZWAVE=<wave>[,OFC=<ofc>]:<pst>"<cr><lf>
Parameter aid aidtype userlabel svctyp wave ofc
Description Access identifier that identifies the subrate circuit. Type of access identifier User-specified name for the subrate circuit Data format of the subrate service The AID of an optical channel associated with the A and Z side of a subrate. Uses the OCH BLSR AID format. Indicates whether or not the OFC option is enabled. Valid values are {Y | N}. This parameter is only displayed for Fibre Channel (FC) sub-rate circuit (supported by GRDM). The primary state of the object
pst
3 - 186
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
NOTE:
Upgrades: After upgrading from a version lower than 4.1 to 4.1, or higher, the RTRV-SBR command may respond with a message stating Could Not Update Subrate Table. If this occurs and all nodes on the ring have been upgraded to the same version and are all operating, the system is ready to update the Subrate Table.The table is upgraded when any type of provisioning occurs on a subrate. The RTRV-SBR command does not work correctly until some type of provisioning is executed on a subrate. If no provisioning is required, the easiest way to tell the system to upgrade the table is by issuing an ED-SBR command on an existing subrate, and rename that user label to the existing user label name. In fact, this command fails stating that the new entry name is duplicated, but it also upgrades the table allowing the RTRV-SBR command to operate correctly from this point on for all nodes on the ring.
3 - 187
3
TL1 COMMANDS RTRV-SIDTABLE
retrieve-system identifier table
Purpose Retrieve the system identifier and node identifier for each NE in the subnetwork. User Input Syntax
RTRV-SIDTABLE:[<tid>]:[<sid>]:[<ctag>]:
ONLINETM7000/9000/11000
; Parameter tid Description Target identifier. The name of the NE to which the command is being sent. This is the system ID string provisioned in the ONLINE system as the SID/TID for TL1 communications. Consists of up to 20 characters. System identifier of a network element (NE). When this parameter is empty (that is, when it contains no characters or white space), ALL is implied and supported. Correlation tag.
sid
ctag

^^^"<sid>,<nodeid>"<cr><lf>
Parameter sid nodeid

u
Description System identifier of an NE. Node identifier of an NE.
3 - 188
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-SNE
retrieve-sonet network element
Purpose Display information about logical SONET ADM overlays. User Input Syntax
RTRV-SNE:[<tid>]:[<aid>]:[<ctag>];
Description Target identifier Access identifier Identifies the SNE. Correlation tag

^^^"<aid>[,<aidtype>]:USERLABEL=<userlabel>,XMTFMT=<xmtfmt>"<cr><lf>
Parameter aid aidtype userlabel xmtfmt
Description Access identifier Identifies the subrate circuit Type of access identifier User-specified name Specifies transmission format.
3 - 189
3
TL1 COMMANDS
u
ONLINETM7000/9000/11000
3 - 190
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-SWVER-COM
retrieve-software version common
Purpose Retrieve the software release version of a network element. User Input Syntax
RTRV-SWVER-COM:[<tid>]::[<ctag>];
Parameter tid ctag
Description Target identifier Correlation tag

^^^"COM:<validity>:[VER=<ver>][,CURRREL=<currrel>][,ALTREL=<altrel>][,MAINTREL= <maintrel>]"<cr><lf>
Parameter validity
Description The equipment information is valid. Valid values are as follows:

u u
VALID = Information is valid. UNINITIALIZED = Information is not set on the specific equipment.
ver currrel altrel maintrel
The software version of a network element. The contents of <ver> is a text string of up to 40 characters. The current release version of a network element. The contents of <currrel> is a text string of up to 40 characters. The alternate release version of a network element. The contents of <altrel> is a text string of up to 40 characters. The maintenance release version of a network element. The contents of <maintrel> is a text string of up to 40 characters. ErrorA standard error response indicates one of the following error codes Description Input - command not valid Input - invalid correlation tag Input - non-null unimplemented parameter
3 - 191
3
TL1 COMMANDS RTRV-SWVER-EQPT
retrieve-software version equipment
Purpose Retrieve the software release version of circuit packs in a network element. User Input Syntax
RTRV-HDR:[<tid>]:[<aid>]:[<ctag>];
ONLINETM7000/9000/11000
Description Target identifier Access identifier Correlation tag

^^^"<aid>:<validity>:[APP=<app>][,BOOT=<boot>][,MBL=<mbl>][,OS=<os>][,DB=<db>][ ,FPGA=<fpga>][,APPLET=<applet>]"<cr><lf>
Parameter aid validity
Description Access identifier. Identifies the circuit pack. The equipment information validity. Valid values are:
u u
VALID = Information is valid. UNREPORTED = Information is not reported by the specific equipment.
app boot mbl os db fpga applet
Application load. The contents of <app> is a text string of up to 40 characters. The boot loader load. The contents of <boot> is a text string of up to 40 characters. The micro boot loader load. The contents of <mbl> is a text string of up to 40 characters. The operating system load. The contents of <os> is a text string of up to 40 characters. The database load. The contents of <db> is a text string of up to 40 characters. The FPGA load. The contents of <fpga> is a text string of up to 40 characters. The applet load. The contents of <applet> is a text string of up to 40 characters.
3 - 192
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
3 - 193
3
TL1 COMMANDS RTRV-TRAIL
retrieve-trail
Retrieve the trail connections associated with the specified equipment AID. User Input Syntax
RTRV-TRAIL:[<tid>]:[<fromAid>,<toAid>]:[<ctag>];
ONLINETM7000/9000/11000
Parameter tid fromAid, toAid ctag
Description Target identifier Access identifier Identifies the equipment containing the trails. If null, all values are displayed. Correlation tag

^^^"<aid>:<fromAid>,<toAid>"<cr><lf>
Parameter fromAid toAid
Description Access identifier Identifies the single equipment unit "from" (originating) side. Access identifier Identifiers the single equipment unit "to" (destination) side.
ErrorA standard error response indicates one of the following error codes: Description Input - data not found Input - invalid access identifier Status - requested operation failed
3 - 194
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
RTRV-UNSWTS
retrieve-unswitched timeslots
Purpose Displays unswitched timeslot traffic. User Input Syntax
RTRV-UNSWTS:[<tid>]:<aid>:[<ctag>];
Description Target identifier. Access identifier. Identifies the equipment and timeslots to be displayed with this command. Correlation tag.

^^^"<aid>:::STARTTS=<startts>,ENDTS=<endts>[,ENUTTYPE=<enuttype>,DIR=<dir>]"<cr ><lf>+
Parameter aid startts endts enuttype
Description Access identifier. Identifies the equipment and timeslots. The start timeslot of the unswitched traffic to be provisioned. The end timeslot of the unswitched traffic to be provisioned. The type of ENUT traffic. Valid values are:
u u
DISABLE_RINGSW DISABLE_SPANSW
Displayed only for ENUT traffic. dir The direction of the ENUT traffic. Valid values are:
u u
EAST WEST
Displayed only for ENUT traffic. ctag Correlation tag.
3 - 195
3
TL1 COMMANDS RTRV-VLAN
retrieve-virtual LAN
Purpose Retrieve information on datawire virtual LANs. User Input Syntax
RTRV-VLAN:[<tid>]:<aid>:[<ctag>];
ONLINETM7000/9000/11000
Description Target identifier. Access identifier. Identifies the created facility. Correlation tag. Virtual LAN identification

<aid>:::<vlanid>;
Parameter aid vlanid
Description Access identifier Virtual LAN identification number.
3 - 196
ONLINE 7000/9000/11000
TM
u
TL1 COMMANDS
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Input - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid target identifier Input - parameter missing Privilege - illegal user identity Privilege - login not active Status - command not valid Status - internal database error Status - requested operation failed
3 - 197
3
TL1 COMMANDS SET-SID
set-system identification
Purpose Instructs the NE to change the system identification (SID) code to a specified value. Where appropriate, the value of this SID code is used as the target identifier (TID) in a input command and source identifier in an output or autonomous message. User Input Syntax
SET-SID:[<tid>]::[<ctag>]::<sid>;
ONLINETM7000/9000/11000
Parameter tid
ctag sid
Correlation tag System identification code to be assigned to the NE. The value of SID may be any valid simple or compound TL1 identifier or text string. It is limited to 20 characters. The recommended value for this parameter is the NEs CLLI.
System Response Syntax u NormalThe normal response is a normal output response with an empty text block. The SID in this response should be the new SID.
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - invalid correlation tag Privilege - login not active Status - requested operation failed
Error Code ICNV IICT PLNA SROF
NOTE:
Changing the SID may result in a mismatch of the SID value in the response headers with TID value in commands received prior to the change.
3 - 198
ONLINE 7000/9000/11000
TM
TL1 COMMANDS
SET-SYNCN
set-synchronization
Purpose Provision the synchronization source selection table. Parameter grouping is not supported for this command. User Input Syntax
SET-SYNCN:[<tid>]:<eqptaid>:[<ctag>]:::SYNCSRC=<syncsrc>,SYNCPRI=<syncpri> [,SYNCSIDE=<side>][,SYNCSSM=<ssm>[,SYNCFQL=<fql>[,SYNCSSMMODE=<ssmmode>] [,SYNCPNO=<pno>][,WTR=<wtr>][,RVRTV=<rvrtv>]:pst;
Parameter tid eqptaid ctag syncsrc syncpri syncside syncssm syncfql syncssmmode pno wrt rvtv pst
Description Target identifier Access identifier Identifies the circuit pack with which to associate the synchronization. Correlation tag Synchronization source The priority of the entered synchronization source The port or line-side qualifier (W-west; E-east). This parameter is required for ADM CPs only. An option field associated with a facility. The possible values are (ENABLE or DISABLE). The default is DISABLE. Forced Quality Level. When the SSM is disabled, a FQL must be selected from the list of forced quality levels for this SSM processing mode. The SSM processing mode. Provisionable Networks Operator quality level Wait To Restore Time. Any number in the range of 0 and 12 (0 and 12 inclusive) Revertive parameter. Sets the synchronization switch to revert or not revert. Valid values are Y or N. The primary state of the selected table entry
3 - 199
3
u
ErrorA standard error response indicates one of the following error codes: Description Input - command not valid Input - data not valid Invalid - invalid access identifier Input - invalid correlation tag Input - invalid data format Input - invalid parameter grouping Privilege - login not active Status - command not found Status - requested operation failed
3 - 200
ONLINE 7000/9000/11000
TM
TL1 PARAMETER DEFINITIONS
CHAPTER 4 TL1 PARAMETER DEFINITIONS

This chapter summarizes the TL1 codes and definitions in the following sections:
u u
Codes on page 4-1 Definitions on page 4-3
CODES
Codes indicate alarms, errors, notifications, and system conditions in the system messages. They are explained in the following sections:
u u u
Alarm Codes (almcde) on page 4-1 Error Codes (errcde) on page 4-1 Notification Codes (ntfcncde) on page 4-2
Alarm Codes (almcde)

TL1 alarm codes indicate the severity of the autonomous message. Severity levels are critical, major, and minor. 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. The alarm codes, in decreasing order of severity, are:
u u u u
*C = Critical ** = Major *^ = Minor A^ =Non-alarmed message (clear)
If multiple alarms are reported in the same message, the alarm code is the highest severity of those being reported.
Error Codes (errcde)

TL1 error codes <errcode> are identified as shown in Table 4-1. Table 4-1. TL1 Error Codes Code ICNV IDNC IDNV IIAC IICT IIFM IIPG IITA INUP IPMS Description Input - Command Not Valid Input - Data Not Consistent Input - Data Not Valid Input - Invalid Access Identifier Input - Invalid Correlation Tag Input - Invalid Data Format Input - invalid parameter grouping Input - invalid target identifier Input - non-null unimplemented parameter Input - parameter missing
4-1
4
TL1 PARAMETER DEFINITIONS ONLINETM7000/9000/11000
Table 4-1. TL1 Error Codes (Continued) Code PICC PIUI PLNA SARB SCNF SDBE SENF SROF SRQN IISP IPNV IPEX IDRG IBNC IBEX IBMS ENEQ EQWT SSTP SSRE ICNC SABT SDNC SARB Description Privilege - illegal command code Privilege - illegal user identity Privilege - login not active Status - all resources busy Status - command not found Status - internal database error Status - error not found Status - requested operation failed Status - invalid request Input, invalid syntax or punctuation Input parameter, not valid Input, parameter, extra Input, data, range error Input, block, not consistent Input, block, extra Input, block, missing Equipage, not equipped Equipage, wrong type Status, stopped Status, system resources exceeded Input, command, not consistent Status, aborted Status, data, not consistent Status, all resources busy
Notification Codes (ntfcncde)

The values CR, MJ, and MN are issued by the REPT ALM Message. The NA message is issued by the REPT EVT message. Those messages coded as not reported (NR) indicate that the associated information is retained in the NE at the time of the event.
4-2
ONLINE 7000/9000/11000
TM
TL1 notification codes identify the events shown in Table 4-2. Table 4-2. TL1 Notification Codes Code CR MJ MN NA NR Description Critical Alarm Major Alarm Minor Alarm Not Alarmed Not Reported
DEFINITIONS
This section contains parameter definitions and rules that are used in TL1 messages and occur in multiple TL1 commands. Table 4-3. TL1 Parameter Definitions and Rules Parameter <accesstyp> Definition Access type of the circuit. Grouping is not supported for this parameter. Valid values are:
u u
WCA: Working Channel Access UCA: Unswitched Channel Access
<act> <activeport> <actside>
Activity status associated with a user The status can be either activated or deactivated. Line or tributary port AID of the currently active (providing service) side in the protection group. Qualifier for <syncsrc> selection. Valid values are:
u u
W (west) E (east) LN Line P1 P16 Port number PRI Primary External Reference (ExtRef-A) SEC Secondary External Reference (ExtRef-B) INT Internal Clock
<actsrc>
Valid synchronization references (depending on hardware used) include:

u u u u u
4-3
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <admtype> Definition Indicates the type of ADM circuit pack. Valid values are:
u u u u u u u u
4ADM 4-port ADM circuit pack (old style) 4ADM2I 4-port ADM-II circuit pack - 1310 nm intermediate reach 4ADM2L 4-port ADM-II circuit pack - 1550 nm long reach 4ADM2S 4-port ADM-II circuit pack - 1310 nm short reach 8ADM 8-port ADM circuit pack (old style) 8ADM2I 8-port ADM-II circuit pack - 1310 nm intermediate reach 8ADM2L 8-port ADM-II circuit pack - 1550 nm long reach 8ADM2S 8-port ADM-II circuit pack - 1310 nm short reach
<almmsg>
The text message associated with an environmental alarm The content of <almmsg> should be contained in a text string of no more than 40 characters enclosed within a pair of escaped quotes (\"text string\"). A null value in this parameter means there is no message text for the environmental alarm; <almmsg> is required if the alarm type;<almtype>, equals MISC. The type of environmental alarm returned by the various ENV commands. Parameter groupings are not used with this parameter. The alarm message parameter, <almmsg>, is required if the alarm type equals MISC. Modifies enable state of the B1 Section BIP-8 overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwB2> modifies enable state of the B2 Line BIP-8 overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwD1_D3> modifies enable state of the D1_D3 Section DCC overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwD4_D12> modifies enable state of the D4_D12 Line DCC overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwE1> modifies enable state of the E1 Section Orderwire overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwE2> modifies enable state of the E2 Line Orderwire overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwF1> modifies enable state of the F1 User Channel overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
<almtype>
<alwB1>
<alwB2>
<alwD1_D3>
<alwD4_D12>
<alwE1>
<alwE2>
<alwF1>
4-4
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <alwJ0> Definition Modifies enable state of the J0 Section Trace overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwK1_K2> modifies enable state of the K1_K2 APS overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwM1> modifies enable state of the M1 Line REI overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwS1> modifies enable state of the S1 Synchronization overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwSS> modifies enable state of the SS SONET/SDH overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwX1> modifies enable state of the X1 National overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwX2> modifies enable state of the X2 National overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwZ0> modifies enable state of the Z0 Section Growth overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwZ1> modifies enable state of the Z1 Growth overhead transparency byte. Valid values are: Y (Enabled) or N (disabled). <alwZ2> modifies enable state of the Z2 Growth overhead transparency byte. Valid values are: Y (Enabled) or N (disabled).
<alwK1_K2>
<alwM1>
<alwS1>
<alwSS>
<alwX1>
<alwX2>
<alwZ0>
<alwZ1>
<alwZ2>
4-5
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <asaptype> Definition The name of an Alarm Severity Assignment Profile (ASAP). Valid values are as follows:
u u u u u u u u u u u u u u u u
LOCAL Local NODE Node SHELF Shelf CP Circuit Packs LINE Line (OT) Facility SONET SONET or SDH Facility GBE Gigabit Ethernet Facility ESCON ESCON Facility OSC Optical Supervisory Channel Facility DW Data Wire Facility WAVE Wavelength Facility BAND Band Facility SYNC Sync Facility PMM Power Management Module Facility MP SONET Monitor Point Facility SSI Sync Source Info {1-11} allBand_1_5 allBand_7_11
<band>
Specifies the wavelength band in which an entity operates. Valid values are:
u u u
All band modes are only valid when adding a BWDM CP. <bitrate> <byte> <chanaccesstyp> Bit rate for a circuit. Grouping is not supported for this parameter. Valid values are 100.0 - 2500.0. The K1K2 byte value(s) received or transmitted. Channel access type
u u
switched unswitched
<channel> <cct> <cctpktype>
Specifies the wavelength channel in which the entity operates. The values are 1-3. Cross-connect type. Valid value is 2-way. Line CP type
u u u
line olm osm
4-6
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <ckttyp> Definition Type of circuit to be added or dropped. Grouping is not supported for this parameter. Valid values are
u u
BULK - Bulk wavelength circuit that can carry subrate circuits WAVE - Wavelength circuit
<clgrate>
Allowed Ceiling Rate. Grouping is not supported for this parameter. Valid values are:
u u
100.0 - 1250.0 for autoLockLowRate 100.0 - 2500.0 for autoLock
<colwidth>
The number of characters allowed per line on the terminal session. Valid values are:
u
0 = Auto Sense. For VT-100 based terminal, the width is determined by querying the client. 3-1023 = Valid column widths.
<concat>
If TRUE, specifies concatenated payload. Applies to OC12/STM4 ports for STMX circuit packs only. Defaults to TRUE if not specified for OC12/STM4 ports on an STMX circuit pack. Valid values are {TRUE|FALSE}. A detailed text description of the condition, state, trouble (ALM commands) or specific event. <conddescr> should contain a text string of no more than 64 characters enclosed within a pair of escaped quotes (\"text string\"). A null value in this parameter means there is no information to be reported. Parameter grouping shall not be used with this parameter. Identifies the type of event, condition or alarm indication being reported or the type of event for which a notification attribute is being changed. Connection state of a data wire CP. The valid values are:
u u u
<conddescr>
<condtype> <connst>
AD - add drop PT - pass-through NC - not connected
<conttype> <ctag>
The type of external control. Valid values follow the form MISC-<num> where <num> is a number within the range of 1- 8. The correlation tag (CTAG) is used to correlate input and response messages. The value of <ctag> is an identifier or a decimal numeral, and is limited to a maximum of 6 characters. It is assigned by the OS and must be included in NE input and response messages where specified.
4-7
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <dataprot> Definition Specifies the data protocol for a GRDM-based facility. The valid values are:
u u u
GBE - Gigabit Ethernet FC - Fibre Channel FICON - FICON
<dcmlist> <dcmtype>
Specifies the list of DCMs in the DCH box. It is a list of DCM aids connected by '&'. DCM TYPE:
A10 A20 A30 A40 A50 A60 A70 A80 A90 LF20 LF30 LF40 LF60 LF80 LF100 LF120 LF150 EAST WEST
<dir>
The direction of the ENUT traffic. Valid values are:

u u
<dirn>
Specifies the direction associated with particular information (action to perform, information requested, information reported, etc.) The valid values:
u u u
TRMT - Transmit direction only RCV - Receive direction only NA - Not applicable.
<echo>
The ability to echo characters from the TL1 server. Valid values are: Y=Characters are echoed from the TL1 server. Prompts are provided. N=Characters are not echoed from the TL1 server. Prompts are suppressed.
4-8
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <edit> Definition The ability to edit lines of text. Editing consist of all editing keys such as backspace, delete, arrow keys, CTRL sequences, etc. Valid values are:
u u
Y = Editing is allowed. N = Editing is disabled.
<enableais> <enablepath> <endts> <enuttype>
Is a boolean value which indicates whether to enable section trace mismatch detection. Is a boolean value which indicates whether to enable path trace mismatch detection. The end timeslot of the unswitched traffic to be provisioned. A valid timeslot value (integer). The type of ENUT traffic. Valid values are:
u u
DISABLE_RINGSW DISABLE_SPANSW
<errcde>
The error code is returned by the response format error message. It is possible for a response format error message to be returned by ONLINE commands. Error codes are not returned by automatic messages. See Error Codes (errcde) on page 4-1.
4-9
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <eqptype> Definition The type of CP installed in a slot. Possible values are:
u u u u u u u u u u u u u u u u u u u u u u u u u u
PEM PSM RSM LINE POSTAMP PREAMP WPS SYNC OSC COM BWDM CWDM WCI ALM PWR FAN STMX STEM GRDM EMX PMM SHELF UPSR SMX10G DCM DCH
<expinp> <extpad> <expsectr> <exppathtr>
Expected input power in dBm. Valid values are: -25 to 12. Indicates the loss insertion for the attached DCM (floating point number). Expected section trace value. This is expected value for the section trace J0/ C1 bit. Default is 1. Expected path trace value. This is the expected value for the Sonet J1 path trace byte values. The length must be 64 bytes, including the <CR><LF> which is added by the system.
4 - 10
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <faultpropmode> Definition Fault Propagation Mode (Applicable only for the GBE, FC, FICON, and ESCON facilities.). The valid values for FC, FICON, and ESCON are:
u u u
SHUTLASEROFF INSERTNOS INSERTK30.7 SHUTLASEROFF INSERTNOS INSERTK30.7 DSHUTLASEROFF DINSERTK30.7
Valid values for GBE are

u u u u u
The default value for GBE, FICON, and FC is SHUTLASEROFF and the default value for ESCON is INSERTNOS. <fchainpos> Specifies to which CP in the fiber chain the COM port of the new BWDM is connected. Valid values are:
u u u u u u u
first last {1-11} allBand_1_5 allBand_7_11 optimalLinkBudget hitlessUpgrade
The values "optimalLinkBudget" and "hitlessUpgrade" are for backwards compatibility only. <frmfmt> T1/E1 frame format. Valid values are:
u u u u
T1ESF T1 Extended Superframe format. T1SF T1 Superframe format E1U E1 unframed E1F E1 framed
<fromband> <fromcp>
The band of the from-side circuit pack (all band BWDM). The EQPT AID of the from-side circuit pack. Can also be set to "SPAN" to indicate the span to the remote node for DCM. Can also be a DCM AID if the from side is DCM equipment. Gain settings for VGA type CPs. For non-VGA CPs this parameter is ignored. Valid value are (fixed |optimal).
<gainmode>
4 - 11
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <gap> Definition Group access privileges Non-confidential identifier that uniquely determines a groups access privileges. Each group can have zero or more access privileges. A value of ALL specifies all group privileges. The group Description. 64 alphanumeric characters. The text is inclosed with escape quotes. The group Full Name. 64 alphanumeric characters. The text is inclosed with escape quotes. Group identifier Non-confidential identifier that uniquely determines a group. This parameter is the key for each record in this view. Each group must have a unique UID. GRDM CP type
u u
<gdcrn> <gfnm> <gid>
<grdmtype>
850nm 1310nm 1-256 = Valid values for history buffer size. 0 = History buffer disabled. Note that a human mode trigger overrides this value with 32. See <mode> for details. Y = Insert mode enabled. Overwrite mode disabled. N = Insert mode disabled. Overwrite mode enabled.
<histbuf>
The size of the history buffer. Valid values are:

u u
<insert>
The state of the insert and overwrite mode. Valid values are:
u u
<instance> <instanceAid>
An instance name of the entity in the NE. The AID for an entity in the system. The <instanceAid> is equivalent to an <aid>, but is used to describe an entity other than primary entity. For valid values see <aid> parameter definition. IP Address. The format is in standard dotted decimal format (for example, 127.0.0.1). The T1/E1 line encoding
u u u u
<ipaddr> <linecde>
HDB3 B8ZS AMI NONE - Valid for unframed E1 only.
<linetsmode>
Specifies the switching mode of the line side timeslot of the cross-connect being provisioned. Valid values are:
u u
UNSWITCHED SWITCHED
4 - 12
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <locn> Definition Identifies the location (line unit, alarm, loopback, etc.) associated with a particular command. In general, the location is in reference to the entity identified by the <aid>. A list of valid values are as follows:
u
NEND - Near End: Condition, alarm, or event occurred at the near end of the system. FEND - Far End: Condition, alarm, or event occurred at the far end of the system.
<lpbktype>
Indicates the type of loopback that is to be operated or released by an NE. Valid values:
u u u u
LINE: Line side loopback TRIB: Tributary side loopback FACILITY: Both line and tributary loopback NOLPBK No loopback
<maxoutp> <mode>
Indicates the maximum output power for a port (floating point number). The trigger mode for enabling the Human mode (convenience keystroke). Human mode is characterized by setting the <echo> to Y, <edit> to Y, <colwidth> to default value and <histbuf> to default value, unless it is 0, in which case it is set to 32. The human mode is triggered by the following values:
u
MACHINE = The human mode is never triggered. Terminal characteristics can only be modified for the session by using the EDTRMNL-SES command. HUMAN = The human mode is triggered as soon as a session is started. Default <edit> and <echo> are always overridden with Y and if <histbuf> is 0, it is overridden with 32. TRIGENTER = The human mode is triggered once a user presses the ENTER key. Prior to this trigger, the default <edit>, <echo> and <histbuf> are used. TRIGCTRLENTER = The human mode is triggered once the user presses the CTRL and ENTER key at the same time. Prior to this trigger, the default <edit>, <echo> and <histbuf> are used.
<mondat>
The beginning date of the PM or storage register period specified in <tmper>. The format for <mondat> is MOY-DOM, where MOY (month of year) ranges from 1 to 12 and DOM (day of month) ranges from 1 to 31. A null value for <mondat> defaults to the current date. Parameter grouping may be used with this parameter in input commands.
4 - 13
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <monlev> Definition Specifies the discriminating level for the requested monitored parameter. The format for <monlev> is LEV-DIRN, where valid values for LEV are decimal numerals, and valid values for DIRN are as follows:
u
UP parameter with values equal to or greater than the value of LEV are reported. DN parameter with values equal to or less than the value of LEV are reported
A null value for <monlev> defaults to 1-UP. Parameter grouping should not be used with this parameter. <montm>
u
The beginning time of day of the PM or storage register period specified in <tmper>. The format for <montm> is HOD-MOH, where HOD (hour of day) ranges from 0 to 23 and MOH (minute of hour) ranges from 0 to 59. A null value for <montm> defaults to the current HOD-MOH. If <tmper> is 1-DAY, <montm> is not applicable (null). Parameter grouping may be used with this parameter in Input commands. If parameter grouping is used for both <mondat> and <montm>, the values specified by <montm> pertain to each date.
<montype>
Specifies the type of monitored parameter for which a value is requested or retrieved. Valid values for <montype> are found in this document. On Input Format, a null value requests all types of monitored parameters to be retrieved. Grouping may be used with this parameter for Input format only. The measured value of what is being monitored. The value is in the form of numeric counts or rates. If the requested data is not available, this and the <vldty> parameter must be NA. Specifies if the external interface is connected to a BWDM or CWDM circuit pack.
u u
<monval>
<muxtype>
BWDM - The external interface is connected to a BWDM circuit pack. CWDM - The external interface is connected to a CWDM circuit pack. UNKNOWN Unknown network element type (node uninitialized) TMUX-E Terminal Multiplexer, East TMUX-W Terminal Multiplexer, West LADM Linear Add-drop Multiplexer O-UPSR Optical UPSR Node (OCH ODPR) O-BLSR Optical BLSR Node (OMS OSPR) OLA Optical Line Amplifier GATEWAY Gateway
<nettype>
The network element type. Valid values for <netype> are as follows:
u u u u u u u u
4 - 14
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <newgid> Definition The new Group Identifier used when renaming (editing) a group. It is a nonconfidential identifier that uniquely determines a group. This parameter is the key for each record in this view. Each group must have a unique UID. See Notification Codes (ntfcncde) on page 4-2. Specifies whether the WCI CP is added without a corresponding CWDM CP and can be directly connected to the BWDM. Valid values are {true | false}. An integer indicating a unique identifier for a node in an overlay ring. Valid node IDs are 0-15. An indication of the state of the node in an overlay ring. Possible values are:
u u u u u u
<ntfcncde> <nocwdm> <nodeid> <nodestatus>
UNPROVISIONED IDLE SWITCHING PASSTHROUGH ISOLATED UNKNOWN 4 8
<numports>
Indicates the number of ports supported by a CP. Valid values are:

u u
<oldgid>
The old Group Identifier used when renaming (editing) a group. It is a nonconfidential identifier that uniquely determines a group. This parameter is the key for each record in this view. Each group must have a unique UID. The date when the specific event or violation occurred. Parameter grouping shall not be used with this parameter. The format for <ocrdat> is MOY-DOM.
u u
<ocrdat>
MOY stands for month of year and has a range of 1 to 12. DOM stands for day of month and has a range of 1 to 31.
A null value defaults to the current date except in REPT messages where a null value defaults to the date in the message header. <ocrdat> has the following dependency on the <ocrtm> parameter: A null value for <ocrtm> means that <ocrtm> and <ocrdat> are both not applicable. <ocrtm> Is the time of day when the specific event or violation occurred. Parameter groupings can not be used with this parameter. The format for <ocrtm> is HOD-MOH-SOM.
u u u
HOD stands for hour of day and has a range of 0 to 23. MOH stands for minute of hour and has a range of 0 to 59. SOM stands for second of minute and has a range of 0 to 59
A null value for <ocrtm> means that <ocrtm> and <ocrdat> are both not applicable.
4 - 15
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <ohmode> Definition Specifies the overhead processing mode. Valid values are:
u u
TRANS - Transparent overhead LTE - Line termination equipment
<outpathtr>
Transmit (outgoing) path trace value. This is the output value for the Sonet J1 path trace byte values. The length must be 64 bytes, including the <CR><LF> which is added by the system. Transmit (outgoing) section trace value. This is the output value for the section trace J0/C1 bit. The mode in which the E1/F1/D1-D3 section overhead bytes are transmitted. Valid values are:
u u
<outsectr> <owdccbytemode>
PASS: Passthrough mode. ZEROES: Send zeroes mode.
<pathfec>
Forward error correction for a circuit path. Parameter grouping is not used with this parameter. Valid values are:
u
AUTOCFG - FEC codes along the circuit are set by the autoconfiguration algorithm. ALLOFF - Forces all FEC coders to be turned off for the circuit. SONET SDH STS1 STS-1 Facility STS3C STS-3C Facility STS12C STS-12C Facility
<pathtrtp>
Type of protocol to use in path trace overhead. Valid values are:

u u
<payload>
Associated payload rate. Valid values are:

u u u
<ph>
Phase, specifies the degree of thoroughness of the system initialization. Valid values are:
u u u u
WARM - for warm restart RESYNC - for warm restart with resync COLD - for cold restart SHUTDOWN - shuts down the PEM or PSM depending upon the AID.
<pid>
The password, or any other confidential authenticator of a user. It must me stored in a one-way encrypted form so the user-related security view does not reveal it. Specifies whether PM monitoring is enabled or disabled.
u u
<pmctl>
ENABLED - PM monitoring is enabled. DISABLED - PM monitoring is disabled. TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
4 - 16
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <pmmtype> Definition Specifies whether the PMM type. Valid values are:
u u
MPT Mux pass-through BPT Band pass-through PRI - The unit is the primary (protected) unit. BKUP - The unit is the backup (protecting) unit.
<pmode>
Specifies the protection mode of a BWDM CP.

u u
The BKUP is only allowed in twoFiberOmsOSPR configurations <probcause> <prottype> See Probable Causes for Condition Types on page 5-4 for a complete listing of probable causes. Specifies the protection type. Grouping is not supported for this parameter. Valid values:
u u u u u u u
APSLINE 1+1 Line side APS protection APSTRIB 1+1 Tributary side APS protection OUPSR ADM and SMX10G O-UPSR (tributary side splitter protection) MATEDTM Mated Transparent Mode STMXODPR STMX SONET UPSR (protected cross connection). SUPSR SONET UPSR (not accepted as input for ENT-FFP commands) SBLSR SONET BLSR or SDH MS-SPRing protected facility.
<pst>
The primary state of an entity. Output values are:

u u u u
IS-NR In Service Normal OOS-AU Out of Service, Autonomous OOS-MA Out of Service, Management OOS-AUMA Out of Service, Autonomous and Management IS In service. MA The entity is out of service by management command.
For input, grouping is not supported for this parameter and valid values are:
u u
A value of NULL defaults depend on the specified <aidtype> <pwmask> is the state of the password masking mode. Valid values are:
u
Y = Password masking mode enabled. Echoed characters in password fields are masked. N = Password masking mode disabled. Echoed characters in password fields are displayed.
4 - 17
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <qualifier> Definition is a descriptor for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical. Valid values are:
u u u u u u u u u
NONE none PROT protecting SYNC syncFacility WAVE wavelengthFacitiy WAVEPROT wavelengthFacitiyProtecting MULT multiple ALTDR alternateDrive LINE lineFacility NODE node
<recsectr> <reftype>
Received Section Trace Value. This is the actual value received from the section trace for J0/C1 bit. Reference type. Valid values are:
u u
PRI - SYNC-A (Primary reference) SEC - SYNC-B (Secondary reference)
<regengroup>
Output parameter for WCI Nameblock indicating the WCI is part of a REGEN. The value for this parameter is the shelf and slot AID of the two WCI cards that make up the REGEN separated by an ampersand (&). is a string indicating a unique ring id for an overlay ring. is an indication of the switching substate of an overlay ring. Possible values are:
u u u u
<ringid> <ringstatus>
NOBRIDGE BRIDGE BRIDGEDSWITCHED NA
<rr> <rtrtv>
See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for the facility rate code. Indicates a revertive protection mode. Grouping is not supported for this parameter. Valid values are:
u u
Y N
4 - 18
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <sc> Definition The switch command that is to be initiated on the line(s) or path(s) identified in the <aid> parameter. Valid values for <sc> are as follows: MAN - Manual Switch Manual Switch of Working Line (to Protection Line): If the AID identifies a working line, then service is switched from the working line to the protection line unless a request of equal or higher priority is in effect. Manual Switch of Protection Line (to Working Line): If the AID identifies the protection line, then service is transferred from the protection line to the working line, unless a request of equal or higher priority is in effect. This is applicable only in the 1+1 architecture. Manual Path Protection Switch: Service is transferred from the path identified in the AID to the alternate path (i.e., service is selected from the alternate path by the path selector function) only if the path selector is not satisfying a higher or equal priority request and the alternate path is not experiencing any of the following: Path Alarm Indication Signal (AIS) or Path Loss of Pointer (LOP) (at the appropriate level, Synchronous Transport Signal [STS] or Virtual Tributary [VT]) Excessive Path Bit Error Rate (BER) Signal Degrade (SD) (if provided)
4 - 19
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <sc> (contd) Definition FRCD - Forced Switch Forced Switch of Working Line (to Protection Line): If the AID identifies a working line, then service is transferred from the working line to the protection line unless the protection line is locked out or in the Signal Failure (SF) condition, or another Forced Switch is in effect. Forced Switch of Protection Line (to Working Line): If the AID identifies the protection line, then (for 1+1 architectures) service is transferred from the protection line back to the working line unless a request of equal or higher priority is in effect. Forced Path Protection Switch: Service is transferred from the path identified by the AID to the alternate path (i.e., service is selected from the alternate path by the path selector function) unless the path selector is satisfying a higher or equal priority request. If the AID identifies a path that has already been switched, either by an automatic or manual switch, no switch occurs; however, the priority of the existing switch is raised to "forced." LOCKOUT - Lockout Lockout of Protection Line: If the AID identifies the protection line, then the use of this parameter value prevents any working line from switching to the protection line. If a working line is on protection, the working line is switched back to its original working line. Lockout of Working Line: If the AID identifies a working line, then the use of this parameter value prevents the working line from switching to protection. If the working line is already on protection, the working line is switched back to its original working line. Lockout (for Path Protection Switching): Use of this parameter value prevents path selection from the path identified in the <aid> parameter. If service is currently selected from the path identified in the AID, service is transferred to the alternate path (e.g., if <aid> identifies the primary or preferred ring, and service is currently selected from the primary ring, then use of this parameter value causes service to be transferred from the primary ring to the secondary, or non-preferred ring). <sectrmon> Flag for Section Trace (mismatch) monitoring. If this is set to TRUE it is on and if it is set to FALSE it is not used. If it is TRUE and a mismatch occurs, a SectionTraceMismatch (TIM-S) alarm is generated. Default value is FALSE. Section Trace Type for this facility. Possible values are as follows with the default value being C1:
u u
<sectrtp>
C1 SDHJ0
<secttraceC1byte>
The C1 1 byte value {1-255}.
4 - 20
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <secttraceJ0bytes> <sectrmode> Definition The 15 byte string for the SDH J0 section overhead 15 bytes. The mode for transmitting section trace values. Valid values are:
u u
SECTIONREGENSection regeneration mode. PASSSection passthrough mode. 19 - 19" shelf 23 - 23" shelf 23V - 23" vertical shelf
<shelftype>
Shelf type. Valid values are:

u u u
<side>
Specifies the direction in which the facility is originated or terminated on the node. Valid values are:
u u
W (west) E (east)
<snid> <splitmode> <srveff>
The session identifier. This value specifies an integer number associated with an active session. Splitter mode. Valid values are {single | multi}. The effect on service caused by the standing or alarm condition. Parameter grouping shall not be used with this parameter. Valid values for <srveff> are as follows:
u u
SA - Service-effecting condition, immediate action required NSA - Non-service-effecting condition, action required
A null value is valid with <srveff> for the REPT^COND or RTRV-COND commands. A null value implies that the effect on service is unknown or that the <srveff> parameter is not used. When a null value is used in Input Format with the RTRV-ALM command, alarm conditions for both SA and NSA are retrieved.
4 - 21
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <sst> Definition Secondary service state This output parameter supports a grouping of the following states:
ACT - active BUSY - busy IDLE - idle FLT - failed OVFL - logFull PWR - powerOff TS - inTest UEQ - notInstalled INHIP - shuttingDown WRK - providingService STBYC - coldStandby STBYH - hotStandby LPBK - localLoopback HOST - The session is the host session. DIRECT - The session is a direct connection to a client. INDIRECT - The session is an indirect connection from a client via a gateway node. REMOTE - The session is to a remote node.
<sstat>
Session status. Possible values are:

u u u
<startts>
The start timeslot of the unswitched traffic to be provisioned. A valid timeslot value in integer.
4 - 22
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <svctyp> Definition Data format of the service. Grouping is not supported for this parameter. Valid values are:
CLEARCHANNEL STM1 STM4 STM16 STM64 GBE FC FICON WAN10G LAN10G ESCON USERSPECIFIEDRATE OPTRANS
<swon>
The condition on which to perform a ring switch. Grouping is not supported for this parameter. Valid values are:
u u u
LINEFAIL OSCFAIL OSCDEGRADE
<syncpri> <syncside>
The synchronization source priority. Valid values are integers between 1-4, with 1 indicating the highest priority Qualifier for syncsrc selection. Valid values are:
u u
W (west) E (east) FRNG - Free running synchronization mode FST - Fast start synchronization mode HLDOVR - Heldover synchronization mode NORM - Normal synchronization mode LN Line P1 P16 Port number PRI Primary External Reference SEC Secondary External Reference INT Internal Clock
<syncmode>
The synchronization mode for the specified equipment. The valid values are:
u u u u
<syncsrc>
Valid synchronization references (depending on hardware used) include:

u u u u u
4 - 23
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <tgtoutp> <tid> Definition Target Output Power in dBm, valid values are from -30 to 12. The target identifier (TID) that identifies the target NE to which a command is directed. The value of <tid> is comprised of a maximum of 20 ASCII characters limited to letters, digits, and hyphens. The value of <tid> may be null when the OS directly interfaces with the target NE. The recommended value for the <tid>, when it is used, is the targets CLI code. The TID is an optional parameter. If omitted, the command is handled by the local node. The current threshold level for the monitored parameter. Transparency mapping. Valid values:
u u u
<thlev> <tmap>
MAP1 = mapping#1 MAP2 = mapping#2 NA = not applicable PART = partialPortTransparency FULL = fullPortTransparency NA = not applicable
<tmode>
Transparency mode. Valid values:

u u u
<tmout>
The session inactivity timeout. This is the time in minutes after which a session is automatically closed by the system. Permissible values are 0-120 minutes, where zero effectively disables the inactivity timer. The accumulation time period for performance monitoring parameters. Valid values for <tmper> are 15-MIN and 1-DAY. The band of the to side circuit pack (for all band BWDM only). The EQPT AID of the to side circuit pack. It also can be a DCM AID if the to side is DCM equipment. Specifies transmission format. Valid values are:
u u
<tmper> <toband> <tocp> <tranfmt>
sonet sdh
<tribtsmode>
Specifies the switching mode for the tributary side timeslot of the crossconnect being provisioned. Valid values are
u u
UNSWITCHED SWITCHED {DYNAMICAD | DUAL | STANDALONEREGEN} for regens, {PATHSWITCH | STANDALONEUPSR} for UPSRs, {SINGLEEAST | SINGLEWEST | STANDALONE} for WCIs.
<trsptype>
Specifies how a WCI transponder functions. Valid values are:

u u u
4 - 24
ONLINE 7000/9000/11000
TM
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <tstype> Definition Type of timeslot. Valid values are:
u u u
NUT (only valid for 1+1 protected ports), DISABLE_SPANSW (only valid for BLSR protected ports), DISABLE_RINGSW (only valid for BLSR protected ports). TTTP = Transparency Trail Termination Point. TCTP = Transparency Connect Termination Point. NA = not applicable
<tterm>
Transparency termination. Valid values:

u u u
<udcrn> <ufnm> <uid>
User Description. 64 alphanumeric characters. The text is inclosed with escape quotes. The User Full Name. 64 alphanumeric characters. The text is inclosed with escape quotes. The user identifier. This is a non-confidential identifier that uniquely determines a user (such as the users login ID). This parameter is the key for each record in this view. Each user must have a unique UID. A text label representing an user nameable entity. Consists of a quoted string containing up to 64 characters. Grouping is not supported for this parameter. Postamp and preamp CP type Valid values are:
u u
<userlabel> <vgatype>
non vga
<vldty>
Indicates whether the information for the specified time period was accumulated over the entire time period or some portion of the time period. The following values are supported:
u
COMPL Data has been accumulated over the entire time period. (Null default value) ADJ Data is reset or the clock is modified. NA Data is not available. PRTL Data is accumulated over some portion of the time period.
u u u
<wave>
A wavelength indicator of the form: <side>-<band>-<channel>
4 - 25
4
Table 4-3. TL1 Parameter Definitions and Rules (Continued) Parameter <wcitype> Definition The type of WCI circuit pack. Valid values are:
u u u u u u u u u u u u
2R 2R 1310 nm 2R-850 2R 850 nm 2R-ESCON 2R ESCON 3R 3R 1310 nm 3R-E 3R Enhanced 1310 nm 3R-192 3R OC-192 3R-192A 3R OC-192 for MetroCor Fiber 3R-RG25Regional Rate-Tunable 1310 nm 192FEC 3R OC-192 with FEC 192FEC-MC OC-192 with FEC metrocor 10GLAN-FEC 3R 10GLAN GbE with FEC AR-1310 Metro Rate-Tunable 1310 nm
<wtr>
The wait to restore time in seconds. Grouping is not supported for this parameter. Valid values are:
u u
{5-720} 999 may be used to indicate infinite timeout for line protected facilities with prottype=SBLSR.
<xctype>
SONET/SDH facility cross-connect type. Valid values are: {HP | AD | PT}

u
HP - hairpin connection (connects tributary side to tributary side facilities). PT - pass-through connection (connects line side to line side facilities). AD - add-drop connection (connects tributary side to line side facilities).
u u
<xmtfmt>
Transmission format Valid values are:

u u
sonet sdh
4 - 26
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
CHAPTER 5 TL1 CONDITION TYPES

This chapter contains the ONLINE Transport System condition types, which identify the type of event, condition, or alarm being reported, or the type of event for which a notification attribute is being changed in the following sections:
u u
Condtypes on page 5-1 Probable Causes for Condition Types on page 5-4
CONDTYPES
Conditions that may be seen in ONLINE TL1 response messaging are listed and described in Table 5-1. Table 5-1. Condition types Condition Type ACTLPBK AIS AIS-L AIS-P ALMCKT APSB APSC AU-AIS CLFAN CONTCOM CONTEQPT DATAFLT DMUX EQPT FAILTORLS FAILTOSW FRCDWKSWBK FRCDWKSWPR FRNGSYNC FSTSYNC GP HITEMP Loop back in active position Alarm Indication Signal detected SONET AIS - Line Alarm Indication Signal detected SONET AIS - Path Alarm circuit failure Protection Switch Byte Failure Protection Switch Channel Failure Code High Order Path Alarm Indication Signal detected Cooling fan failure Control communications equipment failure Control Equipment (centralized or distributed) failure Data integrity fault Demultiplex Critical alarm caused by equipment failure Failure to release from protection Failure to switch to protection Working facility/equipment forced to switch back to working Working facility/equipment forced to switch protection unit Free running synchronization mode Fast start synchronization mode General purpose (i.e. indication completely described by the other parameters) High temperature Description
5-1
5
TL1 CONDITION TYPES ONLINETM7000/9000/11000
Table 5-1. Condition types Condition Type HLDOVRSYNC HP-RFI HP-TIM INC INT INTERR INTSFT INVLDFREQ LOCKOUTOFPR LOCKOUTOFWK LOF LOP LOS LOS-D LOS-M LOWRESOURCE LPBKFACILITY LPBKLINE MANWKSWBK MANWKSWPR MISC MON MS-AIS MS-RFI MUX OG OOF PKVOLTAGE PLM-P POWER PRCDRERR PROTNA Holdover synchronization mode High Order Path Remote Failure Indication High Order Trace Identifier Mismatch Incoming failure condition Internal hardware fault or failure Error internal to NE Detected Internal software fault or failure Invalid Frequency Lockout of protection Lockout of working Loss of frame Loss of pointer Loss of signal Loss of signal - Demux Loss of signal - Mux Low System Resource Facility Loopback Line Loopback Manual switch of working facility/equipment back to working Manual switch of working facility/equipment to protection unit Miscellaneous condition Monitor failure Multiplex Section Alarm Indication Signal detected Multiplex Section Remote Failure Indication Multiplex problem Outgoing failure condition Out of Frame Peak Voltage Violation Payload Label Mismatch - STS Power failure (detected external to NE) Procedure error Protection unit not available Description
5-2
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-1. Condition types Condition Type PWR RCVR REPLUNITMISS RFI RFI-L RFI-P RNA RS-TIM SCMMA SELECTIVERST SWTOINT SWTOPRI SWTOSEC SWTOLN SWTOP1 16 SYNC TIM-P TIM-S TRMT WKGMEM WKSWBK WKSWPR Receiver failure Replaceable equipment/unit is missing Remote Failure Indication Remote Failure Indication - Line Remote Failure Indication - Path Resource Not Available Regenerator Section Trace Identifier Mismatch State Change due to Manual Maintenance Action Node is in Selective Restore Clock Reference Switching to Internal Clock Clock Reference Switching to Primary Sync Clock Reference Switching to Secondary Sync Clock Reference Switching to Line Clock Reference Switching to Port 1 through 16 Loss of timing on synchronization link SONET Trace identifier message defect - Path SONET Trace identifier message defect - Section Transmitter failure Working memory failure Working facility/equipment switched back to working Working facility/equipment switched to protection unit Description Power failure (detected internal to NE)
5-3
5
TL1 CONDITION TYPES ONLINETM7000/9000/11000 PROBABLE CAUSES FOR CONDITION TYPES
The mapping from ONLINE probable causes to TL1 Condition Types (<condtype>) is presented in Table 52. Where a match does not exist, a much broader matching condition type is chosen. The extra text of the response header is used to convey the exact probable causes. Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause ais alarmCardFailure AU_Ais AU_LOP autoSwitch autoSwitchFailed autoSwitchRelease autoSwitchReleaseFailed berTestRunning CardProvisioningMismatch communicationsFailure configurationError coolingFanFailure DCCLinkFailure diagnosticsFailure48V_bus_A diagnosticsFailure48V_bus_B diagnosticsFailureADCLoopbackTest diagnosticsFailureDevice3270_3110 diagnosticsFailureDevice4080 diagnosticsFailureDeviceADClm12458 diagnosticsFailureDeviceCommonLed diagnosticsFailureDeviceDACad8412 diagnosticsFailureDeviceDio diagnosticsFailureDeviceEDFA diagnosticsFailureDeviceEEProm diagnosticsFailureDeviceGrdmEpld diagnosticsFailureDeviceGrdmPhy diagnosticsFailureDeviceGrdmYukon AIS ALMCKT AU-AIS AU-LOP WKSWPR FAILTOSW WKSWBK FAILTORLS GP INTERR CONTCOM INTERR CLFAN CONTCOM CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
Condition Type
5-4
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause diagnosticsFailureDeviceI2c diagnosticsFailureDeviceLED diagnosticsFailureDeviceLM81 diagnosticsFailureDeviceParallel diagnosticsFailureDevicePM5347 diagnosticsFailureDeviceSigFpga diagnosticsFailureDeviceSwitch diagnosticsFailureEEPromTest diagnosticsFailureEthernet_Cpm0 diagnosticsFailureEthernet_Cpm1 diagnosticsFailureFPGAProgramFailure diagnosticsFailureHDLC_Tests diagnosticsFailureOscMRV diagnosticsFailureSlotMismatch diagnosticsFailureSpiBusTest driveMountFailure duplicatedSIDsInSubnet eastAuditFailure eastDefaultKByte eastEnutTableMismatch eastImproperApsCode eastInconsistentAPSCode eastInterfaceSideMismatch eastNodeIDMismatch eastProtectionSwitchFailure eastRingmapIdMismatch eastRingmapMismatch eastSquelchTableMismatch EDFAFailure eepromDataError ethernetLinkFailureOnBackPlaneA ethernetLinkFailureOnBackPlaneB CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT CONTEQPT PRCDRERR CONTCOM APSB DATAFLT APSC APSC DATAFLT APSC FAILTOSW DATAFLT DATAFLT DATAFLT CONTEQPT DATAFLT CONTCOM CONTCOM Condition Type
5-5
5
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause ethernetSwitchError ethernetSwitchFailure excessiveDataRate excessiveInputPower excessiveInputPowerOnLinePort excessiveInputPowerOnTribPort exercise exerciseFailed exerciseSuccess ExternalReferenceA ExternalReferenceB externalReferenceFailedSYNCA externalReferenceFailedSYNCB fastStart forcedSwitch forcedSwitchFailed forcedSwitchOnLinePort forcedSwitchOnTribPort forcedSwitchRelease forcedSwitchReleaseFailed fPGAFailureOnLinePort fPGAFailureOnTribPort fPGAPowerFailureOnLinePort fPGAPowerFailureOnTribPort FPGAProgramFailure freeRun highOrderPathRemoteFailureIndication highOrderPathTraceIdentifierMismatch highPeakVoltageViolation holdover HUBOSCMismatch indeterminate INT CONTEQPT INC INC INC INC SWEX SWEX SWEX SWTOPRI SWTOSEC SYNC SYNC FSTSYNC FRCDWKSWPR FAILTOSW FRCDWKSWPR FRCDWKSWPR FRCDWKSWBK FAILTORLS INT INT INT INT INT FRNGSYNC HP-RFI HP-TIM PKVOLTAGE HLDOVRSYNC EQPT GP Condition Type
5-6
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause InternalClock invalidDataRate invalidDataRateOnLinePort invalidDataRateOnTribPort laserBiasCurrentFailure laserBiasCurrentFailureOnLinePort laserBiasCurrentFailureOnTribPort laserWavelengthLockFailure laserWavelengthLockFailureOnLinePort laserWavelengthLockFailureOnTribPort Line lineAis lineAisOnLinePort lineAisOnTribPort lineRemoteFailureIndication lockout lockoutFailed lockoutOfProtection lockoutOfProtectionOnLinePort lockoutOfProtectionOnTribPort lockoutOfWorking lockoutOfWorkingOnLinePort lockoutOfWorkingOnTribPort lockoutRelease lockoutReleaseFailed loopback loopbackOnLinePort loopbackOnTribPort lossOfClock lossOfClockOnLinePort lossOfClockOnTribPort lossOfFrame SWTOINT INC INC INC INT INT INT EQPT INT INT SWTOLN AIS-L AIS-L AIS-L RFI-L LOCKOUTOFPR FAILTOSW LOCKOUTOFPR LOCKOUTOFPR LOCKOUTOFPR LOCKOUTOFWK LOCKOUTOFWK LOCKOUTOFWK LOCKOUTOFWK FAILTORLS ACTLBPK LPBKLINE LPBKFACILITY SYNC SYNC SYNC LOF Condition Type
5-7
5
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause lossOfFrameOnLinePort lossOfFrameOnTribPort lossOfSignal lossOfSignalDemux lossOfSignalMux lossOfSignalOLMLine lossOfSignalOLMNode lossOfSignalOnLinePort lossOfSignalOnTribPort lossOfSignalOSMLine lossOfSignalOSMNode lossOfSignalPMM lossOfSignalPostamp lossOfSignalPostVGA lossOfSignalPreamp lossOfSignalPreVGA lossOfSignalWPS lossOfSync lossValuesOutOfRange lowPeakVoltageViolation lowSystemResourceDiskSpace lowSystemResourceHandle lowSystemResourceMemory manualSwitch manualSwitchFailed manualSwitchOnLinePort manualSwitchOnTribPort manualSwitchRelease manualSwitchReleaseFailed memoryMismatch multiplexSectionAis multiplexSectionRemoteFailureIndication LOF LOF LOS LOS-D LOS-M LOS LOS LOS LOS LOS LOS LOS LOS LOS LOS LOS LOS SYNC INT PKVOLTAGE WKGMEM WKGMEM WKGMEM MANWKSWPR FAILTOSW MANWKSWPR MANWKSWPR MANWKSWBK FAILTORLS INTERR MS-AIS MS-RFI Condition Type
5-8
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause nodeInHitlessState nodeInSelectiveRestore ntpServerNotAvailable OchAisOnLinePort OchLOFOnLinePort oDPRProtectionUnavailable oosDiagnosticsPerformed opticalSwitchFailure osc4080DeviceFailure oSPRProtectionUnavailable outOfFrame pathAis pathLossOfPointer pathRemoteFailureIndication pathTraceIdentifierMismatch payloadMappingFailure peerCommunicationsFailure planeAcommunicationsFailure planeBcommunicationsFailure PMAIsLocked Port1 Port2 Port3 Port4 Port5 Port6 Port7 Port8 Port9 Port10 Port11 Port12 DATAFLT SELECTIVERST RNA AIS-L LOF PROTNA CONTEQPT CONTEQPT CONTEQPT PROTNA OOF AIS-P LOP-P RFI-P TIM-P PLM-P CONTCOM CONTCOM CONTCOM SCMMA SWTOP1 SWTOP2 SWTOP3 SWTOP4 SWTOP5 SWTOP6 SWTOP7 SWTOP8 SWTOP9 SWTOP10 SWTOP11 SWTOP12 Condition Type
5-9
5
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause Port13 Port14 Port15 Port16 powerAcoCardFailure powerEntryFailure powerManagementProblem powerProblem processorBusy programMemoryFailure programMemoryMissing protectionPathFailure pumpLaserTemperatureOutOfRange receiverFailure receiverFailureOnLinePort receiverFailureOnTribPort referenceFailed referenceOutOfRange regeneratorSectionTraceIdentifierMismatch regeneratorSectionTraceIdentifierMismatchOnLinePort regeneratorSectionTraceIdentifierMismatchOnTribPort remoteFailureIndication replaceableUnitMissing replaceableUnitProblem replaceableUnitTypeMismatch sectionTraceIdentifierMismatch sectionTraceIdentifierMismatchOnLinePort sectionTraceIdentifierMismatchOnTribPort shelfIdMismatch shelfInterconnectFailure shelfTypeMismatch signalDegradeBER SWTOP13 SWTOP14 SWTOP15 SWTOP16 ALMCKT POWER INTERR PWR GP WKGMEM WKGMEM INT HITEMP RCVR RCVR RCVR SYNC SYNC RS-TIM RS-TIM RS-TIM RFI REPLUNITMISS EQPT EQPT TIM-S TIM-S TIM-S EQPT CONTCOM INTERR INC Condition Type
5 - 10
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause signalDegradeBEROnLinePort signalDegradeBEROnTribPort signalFailBER signalFailBEROnLinePort signalFailBEROnTribPort signalFrequencyInvalid signalingFailure signalSquelched signalSquelchedOnLinePort signalSquelchedOnTribPort softwareDownloadFailure softwareEnvironmentProblem storageCapacityProblem synchronizationFailure temperatureOutOfRange temperatureSensorFailure thresholdCrossed thresholdCrossedLBCOnLinePort thresholdCrossedLBCOnTribPort thresholdCrossedOPR thresholdCrossedOPROnLinePort thresholdCrossedOPROnTribPort thresholdCrossedOPT thresholdCrossedOPTOnLinePort thresholdCrossedOPTOnTribPort thresholdNMCrossedCRC thresholdNMCrossedCV_L thresholdNMCrossedCV_LOnLinePort thresholdNMCrossedCV_LOnTribPort thresholdNMCrossedCV_P thresholdNMCrossedCV_S thresholdNMCrossedCV_SOnLinePort INC INC INC INC INC INVLDFREQ INTERR OG OG OG INTERR INTSFT INTERR SYNC HITEMP MON GP T-LBCN T-LBCN T-OPR T-OPR T-OPR T-OPT T-OPT T-OPT T-CRC T-CVL T-CVL T-CVL T-CVP T-CVS T-CVS Condition Type
5 - 11
5
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause thresholdNMCrossedCV_SOnTribPort thresholdNMCrossedCVs thresholdNMCrossedCVs_ch1 thresholdNMCrossedCVs_ch2 thresholdNMCrossedCVs_EMX_IN thresholdNMCrossedCVs_EMX_OUT thresholdNMCrossedCVsOnLinePort thresholdNMCrossedCVsOnTribPort thresholdNMCrossedES_L thresholdNMCrossedES_LOnLinePort thresholdNMCrossedES_LOnTribPort thresholdNMCrossedES_P thresholdNMCrossedES_S thresholdNMCrossedES_SOnLinePort thresholdNMCrossedES_SOnTribPort thresholdNMCrossedFC_L thresholdNMCrossedFC_LOnLinePort thresholdNMCrossedFC_LOnTribPort thresholdNMCrossedFC_P thresholdNMCrossedFCS thresholdNMCrossedFE thresholdNMCrossedFE_FCS thresholdNMCrossedGbE_CRC_IN thresholdNMCrossedGbE_CRC_OUT thresholdNMCrossedGbE_DE thresholdNMCrossedGbE_FRAGS_IN thresholdNMCrossedGbE_FRAGS_OUT thresholdNMCrossedGbE_JABBER_IN thresholdNMCrossedGbE_JABBER_OUT thresholdNMCrossedGbE_LOCS thresholdNMCrossedGbE_LOCSOnLinePort thresholdNMCrossedGbE_LOCSOnTribPort T-CVS T-CV T-CV-CH1 T-CV-CH2 T-CV T-CV T-CV T-CV T-ESL T-ESL T-ESL T-ESP T-ESS T-ESS T-ESS T-FCL T-FCL T-FCL T-FCP T-FCS T-FRER T-FCS-FE T-CRC T-CRC T-DE T-FRG T-FRG T-JBR T-JBR T-LOCS T-LOCS T-LOCS Condition Type
5 - 12
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause thresholdNMCrossedMS_BBE thresholdNMCrossedMS_EB thresholdNMCrossedMS_ES thresholdNMCrossedMS_FC thresholdNMCrossedMS_SES thresholdNMCrossedMS_UAS thresholdNMCrossedPath_BBE thresholdNMCrossedPath_EB thresholdNMCrossedPath_ES thresholdNMCrossedPath_FC thresholdNMCrossedPath_SES thresholdNMCrossedPath_UAS thresholdNMCrossedRS_BBE thresholdNMCrossedRS_EB thresholdNMCrossedRS_ES thresholdNMCrossedRS_SEFS thresholdNMCrossedRS_SES thresholdNMCrossedSEFS_S thresholdNMCrossedSEFS_SOnLinePort thresholdNMCrossedSEFS_SOnTribPort thresholdNMCrossedSES_L thresholdNMCrossedSES_LOnLinePort thresholdNMCrossedSES_LOnTribPort thresholdNMCrossedSES_P thresholdNMCrossedSES_S thresholdNMCrossedSES_SOnLinePort thresholdNMCrossedSES_SOnTribPort thresholdNMCrossedTCBEOnLinePort thresholdNMCrossedTCBEOnTribPort thresholdNMCrossedUAS_L thresholdNMCrossedUAS_LOnLinePort thresholdNMCrossedUAS_LOnTribPort T-BBEM T-EBM T-ESM T-FCM T-SESM T-UASM T-BBEAU T-EBAU T-ESAU T-FCAU T-SESAU T-UASAU T-BBER T-EBR T-ESR T-SEFSR T-SESR T-SEFSS T-SEFSS T-SEFSS T-SESL T-SESL T-SESL T-SESP T-SESS T-SESS T-SESS T-TCBE T-TCBE T-UASL T-UASL T-UASL Condition Type
5 - 13
5
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause thresholdNMCrossedUAS_P thresholdNMCrossedUCBEOnLinePort thresholdNMCrossedUCBEOnTribPort topologyDiscovering topologyMismatch trailTraceMismatch transmitFail transmitterFailure transmitterFailureOnLinePort transmitterFailureOnTribPort transmitterFailurePostVGA transmitterFailurePreVGA tribOpticalPowerMonitoringNotSupported underlyingResourceUnavailable unsupportedPayloadType userAlarm1 userAlarm2 userAlarm3 userAlarm4 userAlarm5 userAlarm6 userAlarm7 userAlarm8 userAlarm9 userAlarm10 userAlarm11 userAlarm12 voaFailure voaFailureDemux voaFailureMux voaMotorMissingSteps voaMotorMissingStepsDemux T-UASP T-UCBE T-UCBE DATAFLT DATAFLT INTERR TRMT TRMT TRMT TRMT TRMT TRMT MON EQPT PLM-P MISC MISC MISC MISC MISC MISC MISC MISC MISC MISC MISC MISC CONTEQPT DMUX MUX CONTEQPT DMUX Condition Type
5 - 14
ONLINE 7000/9000/11000
TM
TL1 CONDITION TYPES
Table 5-2. Mapping Probable Cause to TL1 Condition Types Probable Cause voaMotorMissingStepsMux voaMotorNotStepping voaMotorNotSteppingDemux voaMotorNotSteppingMux voaPotFailure voaPotFailureDemux voaPotFailureMux wavelengthManagementUnavailable westAuditFailure westDefaultKByte westEnutTableMismatch westImproperApsCode westInconsistentAPSCode westInterfaceSideMismatch westNodeIDMismatch westProtectionSwitchFailure westRingmapIdMismatch westRingmapMismatch westSquelchTableMismatch MUX CONTEQPT DMUX MUX CONTEQPT DMUX MUX INTERR CONTCOM APSB DATAFLT APSC APSC DATAFLT APSC FAILTOSW DATAFLT DATAFLT DATAFLT Condition Type
5 - 15
5
5 - 16
ONLINE 7000/9000/11000
TM
TL1 MONITOR TYPES
CHAPTER 6 TL1 MONITOR TYPES

This chapter contains the ONLINE monitor types to identify the values for montype and monval parameters (Table 6-1). Table 6-1. Monitor Types Monitor Type BBE-MS BBE-RS BBE-AU BBER-MS BBER-RS BBER-AU BCST BYT CRC CV CV-CH1 CV-CH2 CVL CVP CVS DE EB-MS EB-RS EB-AU ES-AU ES-L ES-MS ES-P ES-RS ESR-AU ESR-MS Description Background Block Error Multiplex Section Background Block Error Regenerator Section Background Block Error - Path Background Block Error Ratio Multiplex Section Background Block Error Ratio Regenerator Section Background Block Error Ratio - SDH Path Broadcast count Byte count CRC count Coding Violation count Coding Violation count GBE Channel 1 Coding Violation count GBE Channel 2 Coding Violation count - Line Coding Violation count - Path Coding Violation count - Section Disparity Errors Errored Block Multiplex Section Errored Block Regenerator Section Errored Block - SDH Path Errored Second count - SDH Path Errored Second count - Line Errored Second Multiplex Section Errored Second count Path Errored Second Regenerator Section Errored Second Ratio - SDH Path Errored Second Ratio Multiplex Section Current History TCA TCA Interval Intervals Event Alarm 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 X X X X X X X X X X X X X X X X X
6-1
6
TL1 MONITOR TYPES ONLINETM7000/9000/11000
Table 6-1. Monitor Types (Continued) Monitor Type ESR-RS ESR-P ES-S FC-AU FC-L FC-MS FC-P FCS FCS-FE FE FRG FRM GIA JBR LBC LOCS MCST OPR OPT P64 P127 P255 P511 P1023 P1518 PSC PV RNT SEFSR Description Errored Second Ratio Regenerator Section Errored Second Ratio - Path Errored Second count Section Failure Count - SDH Path Failure Count - Line Near End Failure Count Multiplex Section Failure Count Path Near End Frame Check Sequence - Near End Frame Check Sequence - Far End Framing Error Fragment count Frame count Giant count Jabber count Normalized Laser Bias Current Loss of synchronization count (Synchronization Errors) Multicast count Optical Power Received level Optical Power Transmission level Packet 64 count (Packet size of 64 bytes or less) Packet 127 count (Packet size of 65 to 127 bytes) Packet 255 count (Packet size of 128 to 255 bytes) Packet 511 count (Packet size of 256 to 511 bytes) Packet 1023 count (Packet size of 512 to 1023 bytes) Packet 1518 count (Packet size of 1024 to 1518 bytes) Protection Switching Count Protocol Violation Runt count Severely Errored Framing Second count Regenerator Section Current History TCA TCA Interval Intervals Event Alarm 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 X X X X X X X X X
6-2
ONLINE 7000/9000/11000
TM
TL1 MONITOR TYPES
Table 6-1. Monitor Types (Continued) Monitor Type SEFS-S SES-AU SES-L SES-MS SES-P SESR SESR-AU SESR-MS SESR-RS SESR-P SES-S SLOSS TCBE UCBE UAS-AU UAS-L UAS-MS UAS-P Description Severely Errored Framing Second count Section Severe Errored Second count - SDH Path Severe Errored Second count - Line Severe Errored Second count Multiplex Section Severe Errored Second count - Path Severe Errored Second Ratio Severe Errored Second count - SDH Path Severe Errored Second Ratio Multiplex Section Severe Errored Second Ratio Regenerator Section Severe Errored Second Ratio - Path Severe Errored Second count - Section Synchronization Loss Total Corrected Bit Errors UnCorrected Bit Errors Unavailable Second Count - SDH Path Unavailable Second Count - Line/Layer Unavailable Second Count Multiplex Section Unavailable Second Count - Path Current History TCA TCA Interval Intervals Event Alarm 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
6-3
6
TL1 MONITOR TYPES ONLINETM7000/9000/11000
6-4
ONLINE 7000/9000/11000
TM
GROUP ACCESS PRIVILEGES
CHAPTER 7 GROUP ACCESS PRIVILEGES

This chapter provides the values acceptable for use when defining group privileges during TL1 input (Table 7-1) Table 7-1. Group Access Privileges activateUser addBWDM addDCM addGroup addShelf addSYNC administrator changeGroup changeOwner circuitProtectionSetup cliScript commitSecurityUpdate createUser deleteAMP deleteChannelPassThru deleteDCM deleteGroup deleteSID deleteUser fecConfigType getAccessControlLists getInventoryList getPrivilegesInGroup getUsersGroupNames initDatawire lockAndUnlockPMA modifyAttributes modifyDayThresholdData PMAlarmSetup addAMP addChannelPassThru addESCON addPMM addSID addUsers assignASAP changeGroupLabel changePassword circuitProtectionSwitch cliSession configureDCC deactivateUser deleteBandPassThru deleteCircuit deleteESCON deletePMM deleteSTMX deleteWCI findCircuits getAllGroupLabels getIpServiceInfo getUsersActivityStatuses getUsersInGroup initializePMRegisters loopBack modifyCircuit modifyPrivilegesInGroup PMDayTCASetup addBandPassThru addCWDM addGRDM addPrivileges addSTMX addWCI backupNE changeNEState changeUserMessaging cliAll clockSyncOperation createCircuit deleteAccessControlList deleteBWDM deleteCWDM deleteGRDM deleteShelf deleteSYNC equipmentProtectionSwitch getAccessControlList getGroupLabelFromUser getIpServiceNameList getUsersGroupLabels getUsersPrivileges lockAndUnlock LOSThresholdSetting modifyDatawire modifyThresholdData PMTCASetup
7-1
7
GROUP ACCESS PRIVILEGES ONLINETM7000/9000/11000
Table 7-1. Group Access Privileges (Continued) portProvision provisionAMP provisionSTMX removeUsers resetNEDB runDiagnostics setCraftEnabled setNEAttributes setPadList snmp syslog tl1 userAlarmOutputs viewUser PowerManager provisionPMM provisionSYNC renameNE restoreNE setAccessControlList setLanEnabled setNETime setSpanLoss softwareDownload tcPassThrough troubleShooting userAlarmsInfo viewUserActivateStatus protectionSwitchSetup provisionSID removePrivileges resetCard ringProtectionSwitch setBERThreshold setLineSideFiberTypes setOpticalConfiguration setSubnetworkMap sonetADMView timingProtectionSwitch unprovisionSTMX userLoginControl WCIOverheadProvisioning
7-2
ONLINE 7000/9000/11000
TM
FACILITIES AND PROTECTION SWITCHING
CHAPTER 8 FACILITIES AND PROTECTION SWITCHING

This chapter includes reference tables for:
u u
Supported Facilities on page 8-1 Protection Switching Support on page 8-2
SUPPORTED FACILITIES
This section identifies the supported facilities defined for the <rr> parameter (Table 8-1). Table 8-1. Supported Facilities Facility OB OT OCH DW GBE ESCON FC FICON OC3 OC12 OC48 OC192 STM1 STM4 STM16 STM 64 STS1 STS3C STS12C STS48C AU4 AU44C TL1 Administration and Reference Manual April 30, 2003 - Revision A 009-2003-080
Definition Optical Band Section Facility Optical Transport Facility Optical Channel Facility Datawire Facility Gigabit Ethernet Facility ESCON Facility Fibre Channel Facility FICON Facility SONET OC-3 Facility SONET OC-12 Facility SONET OC-48 Facility SONET OC-192 Facility SDH STM-1 Facility SDH STM-4 Facility SDH STM-16 Facility SDH STM-64 Facility STS-1 Facility STS-3C Facility STS-12C Facility STS-48C Facility AU4 Facility AU44C Facility
8-1
FACILITIES AND PROTECTION SWITCHING PROTECTION SWITCHING SUPPORT
ONLINETM7000/9000/11000
Table 8-2 summarizes the facility protection provisioning commands supported by the ONLINE Transport System. Table 8-2. Facility Protection Switching Support Protection BLSR Ring BLSR Equipment UPSR Path SONET UPSR SONET O-UPSR OT COM OCH STS1, STS3C, STS12C OC3, OC12, OC48, OC192 STM1, STM4, STM16, STM64 OC3, OC12, OC48, OC192 STM1, STM4, STM16, STM64 <rr> ENT NA NA NA NA X ED X (wtr and swon) NA X (wtr and rvtv) X (wtr and rvtv) X (wtr and rvtv) DLT NA NA NA NA X RTRV X (wtr and swon) X (wtr and rvtv) X (wtr and rvtv) X (wtr and rvtv) X (wtr and rvtv)
SONET 1 + 1 APS
X (wtr and rvtv)
X (wtr and rvtv)
8-2
I
ONLINETM7000/9000/11000
INDEX
INDEX S
Session security (ACT-USER) 1-5
A
Access Identifiers (AIDs) 1-16 accessing TL1 1-4 Alarm Types mapping 5-1 Autonomous Messages Report Environment Alarm 2-4
T
telnet 1-4 TL1 Alarm Types mapping 5-1 Command Format 1-11 Commands 3-2 Notification codes 4-1 Response Format 1-14
C
Commands Edit password 3-12 Login 3-4 Logout 3-9 Retrieve All Alarms 3-46 Retrieve Environmental Alarms 3-49 Retrieve header 3-178
U
UNASGN-ASAP 3-42 Upgrading from previous versions (RTRV-CKT) 3154
E
Edit password command 3-12
L
Login command 3-4 Logout command 3-9
M
Machine Mode 1-9
N
Notification codes 4-1
R
Report Environment Alarm 2-4 Retrieve All Alarms command 3-46 Retrieve Environmental Alarms command 3-49 Retrieve header command 3-178
I-1
I
INDEX ONLINETM7000/9000/11000
I-2
I
ONLINETM7000/9000/11000
COMMANDS/CODES INDEX
ED-SYNCN 3-122 ED-TRMNL-DFLT 3-31 ED-TRMNL-SES 3-32 ED-USER-SECU 3-15 ENT- {OC3 | OC12 | STM1 | STM4} 3-124 ENT-ASAP 3-43 ENT-CKT 3-126 ENT-CRS- 3-128 ENT-EQPT 3-130 ENT-EXTIF 3-135 ENT-FFP 3-136 ENT-GROUP-SECU 3-17 ENT-RNGMAP-VNODE 3-139 ENT-SBR 3-140 ENT-TRAIL 3-142 ENT-UNSWTS 3-143 ENT-USER-SECU 3-19 ENT-VLAN 3-144 errcde 4-1 EX-SW 3-62 I INH-MSG 3-44 INH-USER-SECU 3-21 INIT-REG 3-79 N ntfcncde 4-2 O OPR-PROTNSW 3-69 R RD-SYNCN 3-148 REPT-ALM 2-2 REPT-EVT 2-6 REPT-PM 2-9 REPT-RMV 2-11 REPT-RST 2-12 RLS-EXT-CONT 3-73 RLS-PROTNSW 3-74 RMV- { } 3-152 RST- { } 3-153 RTRV-ALM 3-46 RTRV-ALM-ENV 3-49
A ACT-PRIV-SECU 3-3 ACT-USER 3-4 ALW-MSG 3-38 ALW-USER-SECU 3-5 C CANC-PRIV-SECU 3-6 CANC-SESSION 3-7 CANC-SESSION-SECU 3-8 CANC-USER 3-9 D DLT-{OC3|OC12|STM1|STM4} 3-94 DLT-ASAP 3-41 DLT-CKT 3-95 DLT-CRS- 3-96 DLT-EQPT 3-97 DLT-EXTIF 3-98 DLT-FFP 3-99 DLT-GROUP-SECU 3-10 DLT-PASS 3-100 DLT-SBR 3-101 DLT-SYNCN 3-103 DLT-TRAIL 3-104 DLT-UNSWTS 3-105 DLT-USER-SECU 3-11 DLT-VLAN 3-106 E ED-{OC3 | OC12 | OC48 | STM1 | STM4 | STM16} 3-107 ED-ASAP 3-42 ED-CKT 3-110 ED-DAT 3-112 ED-DW 3-114 ED-EQPT 3-116 ED-EXTIF 3-118 ED-FFP 3-119 ED-GROUP-SECU 3-13 ED-PID 3-12 ED-SBR 3-120 ED-SNE 3-121
I-3
I
RTRV-ASAP 3-51 RTRV-CKTINFO-{OCH | | Gbe | FC | FICON | EQPT} 3-156 RTRV-CKTINFO-CKT 3-158 RTRV-COND 3-53 RTRV-COND-SYNCN 3-55 RTRV-CRS- 3-160 RTRV-DFLT-ASAP 3-57 RTRV-EQPT 3-162 RTRV-EXT-CONT 3-76 RTRV-EXTIF 3-166 RTRV-FAC- 3-167 RTRV-FAC-{|ALL|PMM|LINK} 3-167 RTRV-FAC-ALL 3-167 RTRV-FFP 3-176 RTRV-FIBER-EQPT 3-174 RTRV-GROUP-SECU 3-22 RTRV-HDR 3-178 RTRV-NETYPE 3-179 RTRV-PASS 3-180 RTRV-PM 3-80 RTRV-PMCTL 3-83 RTRV-PRIV-SECU 3-24 RTRV-RNGMAP-VNODE 3-182 RTRV-ROUTEMAP 3-183 RTRV-SBR 3-186 RTRV-SESSION 3-26 RTRV-SESSION-SECU 3-27 RTRV-SIDTABLE 3-188 RTRV-SNE 3-189 RTRV-SQLCHTBL-VNODE 3-185 RTRV-SWVER-COM 3-191 RTRV-SWVER-EQPT 3-192 RTRV-TH 3-85 RTRV-TRAIL 3-194 RTRV-TRMNL-DFLT 3-33 RTRV-UNSWTS 3-195 RTRV-USER-SECU 3-29 RTRV-VLAN 3-196 S SCHED-PMREPT 3-87 SET-ASAP-{ } 3-58 SET-ATTR-SECUDFLT 3-35 SET-NE-ALL 3-58
ONLINETM7000/9000/11000
SET-PMCTL 3-89 SET-SESSION 3-36 SET-SID 3-198 SET-SYNCN 3-199 SET-TH 3-90
I-4

009-2003-080 TL1 Manual

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

009-2003-080 TL1 Manual

Uploaded by

Copyright:

Available Formats

ONLINE 7000/9000/11000

TL1 ADMINISTRATION AND REFERENCE MANUAL

CIENA Part Number: 009-2003-080 Revision A April 30, 2003

CIENA CONFIDENTIAL AND PROPRIETARY

CIENA CONFIDENTIAL AND PROPRIETARY

PREFACE CONTENT ORGANIZATION

ONLINE CLI Reference Manual ONLINE SNMP Reference Manual

Jurisdiction Federal, US Federal, US International International International

Type Regulation Guidelines Standard Standard Standard

Class I Laser Product Notice

Part 15 of the Federal Communications Commission (FCC): Interference

Environmental Impact Statement

Telcordia Document Standards

RELEASE NOTES AND DOCUMENT UPDATES

PREFACE PRINTING HISTORY

January 15, 2003

DOCUMENT ORDERING INFORMATION

ADDITIONAL PRODUCT INFORMATION

LAB EVALUATION AND FIELD TRIALS

THIS PAGE INTENTIONALLY LEFT BLANK

CHAPTER 1 TL1 OVERVIEW

Direction <-<---> --> --<---> <-<--

Do not use a crossover cable, except if connecting from a laptop.

ONLINE TL1 ACCESS

Windows 2000 Telnet Configuration

TL1 SYNTAX CONVENTIONS

TL1 Command Editing

TL1 COMMAND HISTORY

ACT-USER ENT-USER- SECU ED-USER-SECU ED-PID INIT-SYS

VT-100 VT-220 VT-320 ANSI TTY

SETUP REQUIREMENT FOR TERMINAL SESSIONS

History Buffer Size 0

n/a (insert key)

TL1 COMMAND FORMATS

Input Command Format

Parameter text block

errcde The error code

<shelf> = The specified shelf. Valid values are {1-15}.

Optical Supervisory Channel

Facility Modification Format:

Facility Alarm/Event Format:

Facility Protection Format:

Gigabit Ethernet Facility (GRDM tributary side)

Fibre Channel Facility (GRDM tributary side)

EQPT-DCM-<dcm> for DCM A only EQPT-DCM-<dch>-<dcm> for DCM Leaf only

External Sync Reference

THIS PAGE INTENTIONALLY LEFT BLANK

TL1 AUTONOMOUS MESSAGES

CHAPTER 2 TL1 AUTONOMOUS MESSAGES

Parameter almcde atag rr

System Response Syntax

Message aid ntfcncde condtype srveff ocrdat ocrtm locn

TL1 AUTONOMOUS MESSAGES

Message dirn monval

Parameter almcde atag

Description Alarm code Autonomously generated correlation tag

System Response Syntax

Message aid ntfcncde almtype

ocrdat ocrtm almmsg

TL1 AUTONOMOUS MESSAGES

Description Autonomously generated correlation tag.

System Response Syntax

Message time date source dbchgseq cmdcde aid