009-2003-080 tl1 manual

CIENA® CONFIDENTIAL AND PROPRIETARY

ONLINE�7000/9000/11000TRANSPORT PLATFORM

TL1 ADMINISTRATION AND REFERENCE MANUAL

Software Release 6.0

CIENA Part Number: 009-2003-080Revision A

April 30, 2003


LEGAL NOTICES

THIS DOCUMENT CONTAINS CONFIDENTIAL AND TRADE SECRET INFORMATION OF CIENA CORPORATIONAND ITS RECEIPT OR POSSESSION DOES NOT CONVEY ANY RIGHTS TO REPRODUCE OR DISCLOSE ITSCONTENTS, 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 CIENACORPORATION IS STRICTLY FORBIDDEN.

EVERY EFFORT HAS BEEN MADE TO ENSURE THAT THE INFORMATION IN THIS DOCUMENT IS COMPLETEAND ACCURATE AT THE TIME OF PRINTING; HOWEVER, THE INFORMATION CONTAINED IN THIS DOCUMENTIS 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 othercountries. It may not be reproduced or distributed in any form by any means, altered in any fashion, or stored in a database 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 aClass A digital device, as described in the FCC Rules. Equipment limitations are designed to provide reasonableprotection 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 causeinterference with other communications equipment. Operation of this equipment in a residential environment maycause 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 forunauthorized use or access.

Contacting CIENA®

Corporate Headquarters 410-694-5700 www.ciena.com

Customer Technical Support/Warranty

In North America 1-800-CIENA24 (243-6224) E-mail: [email protected]

In Europe 00800 843 52 322 or +44 181 843 52 322 E-mail: [email protected]

In Asia 0120-884-766

Sales and General Information 410-694-5700 E-mail: [email protected]

In North America 410-694-5700 E-mail: [email protected]

In Europe 44 207 389 7100 E-mail: [email protected]

In Asia +81-3-3248-4680 E-mail: [email protected]

Training and Documentation

Training 877-CIENA-TD (243-6283) or 410-694-8120 E-mail: [email protected]

Documentation 877-CIENA-TD (243-6283) or 410-694-8125 E-mail: [email protected]

ONLINETM7000/9000/11000 PREFACE

PREFACEThis preface defines the purpose, readership, and organization of the TL1 Administration and ReferenceManual in the following sections:

� 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

OBJECTIVESThe TL1 Administration and Reference Manual presents the Transaction Language 1 (TL1) message setsfor use with the ONLINE� 7000/9000/11000 Transport Platform. Use this manual to find details about TL1message construction, and how to use TL1 messages to accomplish tasks currently supported on theONLINE� 7000/9000/1100 Transport Platform system.

AUDIENCEThis manual is intended for use by network administrators, network engineers, network installers, andnetwork operators responsible for the installation and day-to-day operations of optical networkingequipment in a metropolitan area network (MAN).

DISCLAIMERPortions of this document are intended solely as an outline of methodologies to be followed during themaintenance and upgrade of an ONLINE 7000/9000/1100 Transport Platform. It is not intended as a step-by-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 ofprinting, the information that it contains is subject to change. CIENA® is not responsible for any additions toor alterations of the original document. Networks vary widely in their configurations, topologies, and trafficconditions. This document is intended as a general guide only. It has not been tested for all possibleapplications, 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 trafficdisruption warnings.

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 i


PREFACE ONLINETM7000/9000/11000

CONTENT ORGANIZATIONThis manual contains the following chapters and appendices:

� 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� ONLINE CLI Reference Manual� ONLINE SNMP Reference Manual

COMPLIANCE INFORMATIONFood and Drug Administration (FDA) Laser Safety Warning

This product contains a laser diode. CIENA Corporation strongly recommends that users, maintenance, andservice personnel comply with the following standards and regulations in the design, modification,operation, maintenance, an service of lasers and fiber-optic devices:

It is further recommended that the owner of this equipment determine and ensure conformance with anyspecific and applicable local regulations.

Class I Laser Product Notice

The CIENA Corporation ONLINE� 7000/9000/1100 Transport Platform product is a Class 1 Laser productas 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/

Jurisdiction Type TitleFederal, US Regulation FDA 21 CFR 1040.10/.11Federal, US Guidelines OSHAInternational Standard ANSI Z136 seriesInternational Standard IEC-825 seriesInternational Standard EN-60825

TL1 Administration and Reference ManualApril 30, 2003 - Revision A

ii 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY

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 ClassA digital device, as described in the FCC Rules. Equipment limitations are designed to provide reasonableprotection against harmful interference when the equipment is operated in a commercial environment. Thisequipment, if not installed and used properly, and in accordance with guidelines established by CIENACorporation may cause interference with other communications equipment. Operations of this equipment ina residential environment may cause interference and is the responsibility of the user to correct theinterference at the user�s own expense.

Environmental Impact Statement

CIENA® equipment contains no hazardous materials as defined by the United States EnvironmentalProtection Agency (USEPA). CIENA® recommends that all failed product be returned to CIENA® for failureanalysis 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 Supplier-Provided Documentation, GR-454-CORE.

TRADEMARK ACKNOWLEDGEMENTS� 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 productincludes code licensed from RSA Data Security.

RELEASE NOTES AND DOCUMENT UPDATESThe hard copy and Compact Disc Read Only Memory (CD-ROM) versions of this document are revised onlyat major releases and, therefore, may not always contain the latest product information. As needed,Software Release Documents (SRDs), Hardware Release Documents (HRDs), Application Notes, FieldService Bulletins (FSBs), and/or Document Maintenance Bulletins (DMBs) are provided between majorreleases 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 siteat http://www.ciena.com.

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 iii


PREFACE ONLINETM7000/9000/11000

PRINTING HISTORYThe following information lists the printing history of this document.

DOCUMENT ORDERING INFORMATIONTo order additional documentation, the user may contact the local sales representative or CIENA® throughthe contact numbers and/or e-mail addresses listed on the back of the cover.

DOCUMENT COMMENTSCIENA® appreciates all comments that help us improve our documentation quality. The user can submitcomments through our web site (http://www.ciena.com) or with the Documentation Improvement Requestform included with this document.

ADDITIONAL PRODUCT INFORMATIONAdditional 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 TRIALSIn accordance with trial-agreement escalation procedures, any problem encountered during laboratoryevaluations and field trials should be referred to a CIENA® field trial coordinator.

Issue/Revision Release Date Content Description

009-2002-618, Revision A January 15, 2003

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.


iv 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY

ONLINETM7000/9000/11000 TABLE OF CONTENTSTOC

TABLE OF CONTENTSPREFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 v


TABLE OF CONTENTS ONLINETM7000/9000/11000TOC

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


vi 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY


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 ManualApril 30, 2003 - Revision A009-2003-080 vii



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


viii 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY


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

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 ix



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


x 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY

ONLINETM7000/9000/11000 LIST OF TABLESLOT

TABLE # TABLE NAME PAGE #
LIST OF TABLESTable 1-1. Serial Cable Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Table 1-2. Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Table 1-3. Editing Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

Table 1-4. Command History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

Table 1-5. Supported Emulation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Table 1-6. Terminal Session Command Characteristics and Options. . . . . . . . . . . . . . . . 1-10

Table 1-7. Access Identifier Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16

Table 2-1. Protection Mapping Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

Table 2-2. Event Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13

Table 3-1. Parameters Available in <nameblk> for Response to RTRV-EQPT . . . . . . . . 3-163

Table 3-2. Parameters Displayed in Response to <rr> . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-171

Table 4-1. TL1 Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Table 4-2. TL1 Notification Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Table 4-3. TL1 Parameter Definitions and Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Table 5-1. Condition types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Table 5-2. Mapping Probable Cause to TL1 Condition Types. . . . . . . . . . . . . . . . . . . . . . 5-4

Table 6-1. Monitor Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Table 7-1. Group Access Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Table 8-1. Supported Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Table 8-2. Facility Protection Switching Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 xi


LIST OF TABLES ONLINETM7000/9000/11000LOT

THIS PAGE INTENTIONALLY LEFT BLANK


xii 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY

ONLINETM7000/9000/11000 TL1 OVERVIEW1

CHAPTER 1TL1 OVERVIEW

The ONLINE� Transport System Transaction Language 1 (TL1) command line message set is used forcommunications between Telecommunications Operations Support Systems (OSSs) and the ONLINEnetwork elements (NEs)The construction, usage, output, and range of TL1 commands is explained in the following sections of thischapter:

� 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/SDHrings. The message sets conform to Telcordia specifications and consist of the commands issued to thenode, and the responses�either normal or error�that are returned by the node. The TL1 commandapplication 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 TL1conventions, each node is identified by a target identifier (TID), which is the node identifier assigned by thesystem administrator during system turn-up. The TID is automatically retrieved by the PEM CP. Also, thevalue configured for the SID/TID is unique within the subnetwork where the NE resides, but not necessarilyacross multiple subnetworks (or rings).

� A TID is the target identifier that identifies the target NE to which a command is directed. A TIDconsists of up to 20 characters, or may be null when the OS directly interfaces with the targetNE.

� A SID is the source identifier of the NE generating the output message, which may contain upto 20 characters.

TL1 messaging is supported over TCP/IP stacks and can therefore be accessed locally or remotely. At theNE, the TL1 command application runs from the installed Processor Element Module (PEM), which iscabled for either Ethernet or serial communications (Figure 1-1).

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 1 - 1


TL1 OVERVIEW ONLINETM7000/9000/110001

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

Figure 1-1. TL1 Interface Context

The NE that is connected to a management network is the gateway NE (GNE) that routes TL1 commandstargeted for remote NEs in the subnet. Internal sessions between gateway and remote NEs are managedtransparently by this GNE. Because the TID is used to determine the destination of a command, every NEmust contain the information necessary to determine the IP address associated with each TID in thesubnetwork. Remote NEs are those that are not physically connected to the management network. Accessto 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 REQUIREMENTSBefore accessing the TL1 command application, the PEM CP must be cabled and communicating with theterminal from where the TL1 commands are configured. Use the guidelines provided in this section to eitherprepare or check the system at the hardware level.

This section describes the basic RS-232 cables needed, basic Ethernet information, and the procedure toset 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.

ONLINE NE

ONLINE NE

ONLINE NE

Remote NE

OSC

GNE LANTL1 over TCP/IP

WAN

LAN OSS


1 - 2 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY


Serial Setup

RS-232 serial cable, female 9-pin, D-subminiature (DB-9) connector on one end; male DB-9 connector onthe other end. See Table 1-1 for cable pin assignments.

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

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 networkingSTEP 1: Set up the phone book entry for the ONLINE system on the Basic tab page.

Entry name = ONLINE modelComment = Direct serial connection using PPPDial using = dial-up networking serial cable between two PCsSet 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), InternetNetwork protocols = TCP/IPEnable software compression = click to selectEnable PPP LCP extensions = click to select

In the TCP/IP Settings dialog box, click to select the following parameters:

Server assigned IP address

Table 1-1. Serial Cable Pin Assignments

Pin Signal Direction Description

1 DCD <-- Carrier Detect

2 RxD <-- Receive Data

3 TxD --> Transmit Data

4 DTR --> Data Terminal Ready

5 Ground --- Signal Ground

6 DSR <-- Data Set Ready

7 RTS --> Ready to Send

8 CTS <-- Clear to Send

9 Ring <-- Ring Indicator




Server assigned name server addresses

Use IP header compressionUse default gateway on remote network

STEP 3: Make sure the After dialing (login) option is set to none on the Script tab page.STEP 4: Make sure the Authentication and encryption policy is set to accept any authentication including

clear text on the Security tab page. STEP 5: Make sure the X.25 network provider for the remote server is set for none on the X.25 tab page.STEP 6: Use the Dial-up Networking dialog box to connect to the NE.

ONLINE TL1 ACCESSThe craft computer must be equipped with Telnet client software or another interface that can communicatewith port 5050 on the NE. The craft computer operating system can be Windows 95/98/NT/2000, a UNIXvariant, or any other system that supports client software capable of communicating with port 5050. If Telnetclient 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 configuredproperly prior to the first connection to the network element (NE) Telnet port (see Windows 2000 TelnetConfiguration on page 1-5).

The TL1 commands are accessed by means of a Telnet client session. Up to 32 simultaneous TL1 sessionsare supported with ONLINE systems. Use the procedure in this section to present the TL1 prompt with whichto log into the ONLINE system.

Use the following procedure to establish Telnet connectivity.To establish Telnet connectivitySTEP 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).




Windows 2000 Telnet Configuration

Use the configuration steps outlined in this section to set up Telnet parameters in Windows 2000.

C:\> telnetMicrosoft (R) Windows 2000 (TM) Version 5.00 (Build 2195)Welcome to Microsoft Telnet ClientTelnet Client Build 5.00.99201.1

Escape Character is 'CTRL+]'

Microsoft Telnet> unset NTLMMicrosoft Telnet> set LOCAL_ECHOMicrosoft Telnet> unset CRLFMicrosoft Telnet> set TERM VT100Microsoft Telnet> displayEscape Character is 'CTRL+]'WONT AUTH (NTLM Authentication)LOCAL_ECHO onSending only CRWILL TERM TYPE

Preferred Term Type is VT100Microsoft Telnet> quit

SESSION SECURITYOnly the ACT-USER command can be issued once a connection is established to the TL1 server. Aftersuccessful authentication, the other commands are available. A default session timeout (defaulted to 35minutes) is provided for added security. This default value can be modified or disabled with the SET-ATTR-SECUDFLT command. Also, a GNE session is not dropped until all remote sessions accessed through thatspecific GNE connection are logged out and disconnected.

TL1 SYNTAX CONVENTIONSTL1 command syntax essentially functions as a map of the command; the conventions, shown in Figure 1-2, define the type of notation found in TL1.

Table 1-2. Syntax Conventions

Symbol Description

<cr> A carriage return in American Standard Code for Information Interchange (ASCII)

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




[ ] 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 Uppercase characters in format expression shall appear as they are in the message.

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

Table 1-2. Syntax Conventions (Continued)




NAVIGATION KEYSTL1 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 thevarious keys used to position the cursor or remove characters.

TL1 COMMAND HISTORYAny given TL1 session keeps track of the previous 32 commands that are entered. However, the memorybuffer 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-3. Editing Keys

Key Control Sequence Action

Left arrow Ctrl-b Reverse character.

Right arrow Ctrl-f Forward character.

Home Ctrl-a Beginning of line

End Ctrl-e End of line

Backspace Delete previous character.

Delete Ctrl-d Delete current character.

Ctrl-k Delete to end of line.

Ctrl-u Delete the complete line.

Insert Ctrl-i Toggle insert/overwrite.

Table 1-4. Command History

Key Control Sequence Action

Up arrow Ctrl-p Previous in history

Down arrow Ctrl-n Next in history




The history buffer does not track any of the following commands to prevent accidental reboots and forsecurity reasons:

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

EMULATION MODESTable 1-2 lists the keys supported for each mode of a TL1 session. The following emulation modes aresupported.

� 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 mappingto the appropriated control sequence.

Table 1-5. Supported Emulation Modes

Key VT-100 VT-220 VT-320 ANSI TTY

Left arrow * * * * *

Right arrow * * * * *

Up arrow * * * * *

Down arrow * * * * *

Home n/a * * * *

End n/a * * * *

Backspace * * * * *

Delete * * * n/a n/a

Insert n/a * * n/a n/a




SETUP REQUIREMENT FOR TERMINAL SESSIONSFour commands are available to modify a terminal session and default behavior, and are summarized asfollows:

� ED-TRMNL-SESThis 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, andthe column width of the terminal.

� ED-TRMNL-DFLT This command affects all future sessions created on this node and does not modify the currentsession, 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, historybuffer size, password masking, and the column width of the terminal. It is also used to set themode trigger method. The Mode Trigger is a convenience keystroke to switch a session frommachine mode to human mode.

� Human ModeThis mode sets edit and echo to the enabled state and sets the column width to the defaultvalue. 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 ModeMachine mode is the default state of the Edit, Echo, Column Width and History Buffer Sizecharacteristics as provisioned with the ED-TRMNL-DFLT command. A session is started inMachine Mode for ED-TRMNL-DFLT with the mode field <mode> set to MACHINE,TRIGENTER or TRIGCTRLENTER and only enters the Human Mode upon a keystroketrigger. If the ED-TRMNL-DFLT <mode> is set to HUMAN, this trigger occurs as soon as thesession 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 thisnode. A value of 0 (zero) disables the inactivity timeout for all future sessions. This commanddoes not affect the current session.

� SET-SESSION This command is used to set the inactivity timeout for the current session. A value of 0disables the inactivity timeout for the current session only.

See Terminal Session Commands on page 3-30 for details on specific commands and for the availableRTRV (retrieve) commands used to view the data provisioned in the above commands. The range ofcapability and allowed values for each of the terminal session commands are briefly summarized in Table1-6.




Table 1-6. Terminal Session Command Characteristics and Options

Characteristic Default Value

Default Modify Command

Session Modify Command Allowed Values

Edit Allowed N ED-TRMNL-DFLT ED-TRMNL-SES EDIT:Y = Edit allowed.N=Edit disabled.

Echo Allowed N ED-TRMNL-DFLT ED-TRMNL-SES ECHO:Y= Server echo allowedN= Server echo disabled

History Buffer Size 0 ED-TRMNL-DFLT ED-TRMNL-SES HISTBUF:0 = History Disabled1-256 = Number of Commands to retain in buffer

Column Width 80 ED-TRMNL-DFLT ED-TRMNL-SES COLWIDTH:0=Auto detect3-1023 = Set to column width of the terminal

Trigger Mode MACHINE ED-TRMNL-DFLT n/a MODE:MACHINE = Human mode cannot be triggered by keystroke. Use ED-TRMNL-SES command to set individual characteristics for the sessions.HUMAN = Human mode entered at session startupTRIGENTER = Human mode entered when Enter key pressed.TRIGCTRLENTER= Human mode entered when Ctrl-Enter pressed.




TL1 COMMAND FORMATSTL1 messages conform to syntax rules as appropriate for command input, system acknowledgements, andoutput messages.

Input Command Format

When entering TL1 commands, the verb, modifiers, system identifiers, and punctuation must conform to thefollowing syntax.

Syntax<verb>-<modifier>[-<modifier>]:[<tid>]:<aid>:<ctag>[:<genblk>][:<comblk>[:<specificblk>] [:<stateblk>]] ] ];

Password Masking Mode

N ED-TRMNL-DFLT n/a PWMASKY = Defaults to insertN = Defaults to overwrite

Insert Mode Y ED-TRMNL-DFLT n/a (insert key) INSERT:Y=Defaults to insertN = Defaults to overwrite

Inactivity Timeout 35 SET-ATTR-SECUDFLT

SET-SESSION TMOUT:0=disabled1-120 = Minutes before disconnect

Parameter Description

verb The action to be initiated at the NE. This typically includes (but not always) modifiers for the command. The verbs are as follows:

ACT ActivateALW AllowCANC CancelDLT DeleteENT Enter: addED Edit: modify

INH InhibitINIT InitializeOPR OperateRTRV RetrieveREPT ReportRMV - { } Remove

RLS ReleaseRST- { } Restore

SCHED ScheduleSET Define

Table 1-6. Terminal Session Command Characteristics and Options (Continued)

Characteristic Default Value

Default Modify Command

Session Modify Command Allowed Values




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

tid Target identifierThe 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.

aid Access identifierThe specific resource being identified in the request.

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

genblk Not used.

comblk Common data block (position defined). Used for parameters:� 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.

stateblk Primary and secondary state parameters.

; ";" command terminator




ACKNOWLEDGEMENT FORMATThe 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 thefollowing syntax:

Syntax<ack> ^ <ctag><cr><lf>


ack 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.IPIn progress: the request has been initiated. There are subsequent outputmessages that give a termination report or a termination report and commandresults.

NA

No acknowledgement: under abnormal conditions, a command has beenaccepted but has been lost and correct acknowledgement is not possible.NG

No good: the command is valid, but the requested action conflicts with thecurrent system or equipment status.

RLRepeat later: the requested action cannot be executed now because ofunavailable system resources caused by system overload, excessive queuelengths, and busy programs. The command may be entered again later.

ctag Correlation tagThis is the CTAG specified in the command.

cr Carriage return

lf Line feed




OUTPUT RESPONSE FORMATTL1 output responses contain a head, response identifier, a block of text pertinent to the response type, anda terminating character with the following syntax:

Syntax<header><response id>[<text block>]<terminator>


header The header represents information common to all output response and autonomous messages, using the following syntax:<cr><lf><lf>^^^<sid>^<date>^<time>

response id Response ID syntax consists of the following elements:<cr><lf>M^^<ctag>^<cmplcde>MConstant that signifies that the message is the response to an input command message.ctagCommand-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:

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




text block The optional text block is used to represent information specific to the particular output response in either of two forms�normal or error. The form of the normal response text is:

<rspblk>*

� 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>(;|>)

� The " ; " indicates termination of the output response message.� The " >" indicates more output associated with this response follows

under another header.





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, TL1PARAMETER DEFINITIONS provides additional information on AID derivations.

Table 1-7. Access Identifier Formats

Object Modifier AID Format

Alarm Severity Assignment Profile (ASAP)

ASAP-<asaptype>[-<localasapnum>]<asaptype>

Indicates the type of profile. Valid values are:

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

� <pmode> = Indicates the protection mode. Valid values are { PRI | BKUP}




Shelf EQPT EQPT-SHELF-<shelf>� <shelf> = The specified shelf. Valid values are {1-15}.

Circuit Pack EQPT EQPT-CP-<shelf>-<slot>

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

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

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

Table 1-7. Access Identifier Formats (Continued)





Optical Line Facility OT OT-<side>[-<shelf>-<slot>][-<role>]

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

Facility Modification Format:

� OT-<side>[-<shelf>-<slot >]Facility Alarm/Event Format:

� OT-<side>-<shelf>-<slot >

Facility Protection Format:� OT-<side>-<role>

Optical Band OB OB-<shelf>-<slot>-B<band>

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






Optical Tributary Facility

OCH OCH-<shelf>-<slot>[-C<channel>][-<lntr>]� <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>

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



� <port> = The port of the GRDM containing the associated FC facility. Valid values are {1-2}.






FICON(GRDM tributary side)

FICON FICON-<shelf>-<slot>-P<port>



� <port> = The port of the GRDM containing the associated FC facility. Valid values are {1-2}.

ESCON Facility ESCON � 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}.






SONET/SDH Facility <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>]� <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

Enut, Nut UNSWTS <rr>-<shelf>-<slot>[-P<port>]� <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.






External Interface EXTIF EXTIF-<side>-<band>[-<channel>]� <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>� <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 onlyEQPT-DCM-<dch>-<dcm> for DCM Leaf only

� <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 {1-99}.

DCH EQPT EQPT-DCH-<dch>� <dch> = The integer number representing the Dispersion

Compensation Module (DCM) Box. Valid values are {1-99}.

Logical SONET NE SNE SNE-<sne>

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






OC48 SONET BLSRSTM16_MSPRING line-protected facilities

VNODE VNODE-<wshelf>-<wslot>-<eshelf>-<eslot>� < 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>

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

� <num> = {1-12} for original 23 inch shelf or {1-8} for 19 inch or 23 inch Vertical shelf.

External Controls CONT CONT-<num>

� <num> = {1-12} for original 23 inch shelf or {1-8} for 19 inch or 23 inch vertical shelf.

Trail TRAIL <shelf>-<slot>[-P<port>],<shelf>-<slot>[-P<port>]� <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 {1-23} (23" Vertical Shelf).

� <port> = Valid values are {1-8} for STMX Circuit Packs and {1-4} for others.

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.






Network Path Circuits

CKT � <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 {1-23} (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.






Subrate Path Circuits SBR <anodeid>-<ashelf>-<aslot>-P<aport>-<atslot>,<znodeid>-<zshelf>-<zslot>-P<zport>-<ztslot>[,<z2nodeid>-<z2shelf>-<z2slot>-P<z2port>-<z2tslot>]

� <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 {0-15}.

� <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 {0-18} (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 {0-12} (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 {0-12} (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





ONLINETM7000/9000/11000 TL1 AUTONOMOUS MESSAGES2

CHAPTER 2TL1 AUTONOMOUS MESSAGES

TL1 autonomous messages are automatically output to the session as REPT (report) messages. Thischapter describes the format of TL1 autonomous REPT messages in the following sections.

� 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



TL1 AUTONOMOUS MESSAGES ONLINETM7000/9000/110002

REPT ALMreport alarm

PurposeA 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 alarmedevent causes a standing condition and has immediate or potential impact on the operation or performanceof the entity. Some form of maintenance effort is required to restore normal operation or performance of theentity after the event has occurred.A non-alarmed event is not reported with this message; rather, the REPT-EVT message is used. GR-474-CORE and FR-475 explain the designation of specific trouble events as alarmed or non-alarmed events.

Autonomous Identification<cr><lf><almcde>^<atag>^REPT^ALM^{EQPT|COM|SYNCN|LINK|<rr>}

System Response Syntax^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,[<ocrdat>],[<ocrtm>],[<locn>],[<dirn>] [,[<monval>][:[<conddescr>],]"<cr><lf>


almcde Alarm code

atag Autonomously generated correlation tag

rr Facility rate codeSee CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing.

Message Description

aid The specific equipment unit, facility, link or packet link in the NE, depending on the message code modifier, to which the alarm pertains.

ntfcncde Two-character notification code

condtype Type of alarmSee CHAPTER 5, TL1 CONDITION TYPES for more information.

srveff Effect on service as a result of the alarm condition

ocrdat The date of the event occurrence

ocrtm The time of day of the event occurrence

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




dirn The direction of the alarm relative to the entity identified by the AID.

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

conddescr Detailed text description of the specific event that caused this notification.

Message Description




REPT ALM ENVreport alarm environment

PurposeAn autonomous message that is generated for each environmental alarm raised. This command is relatedto the input command RTRV-ALM-ENV.Autonomous Identification<cr><lf><almcde>^<atag>^REPT^ALM^ENV

System Response Syntax^^^"<aid>:<ntfcncde>,<almtype>,[<ocrdat>],[<ocrtm>][,<almmsg>]" <cr> <lf>

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.


almcde Alarm code


Message Description

aid The specific equipment unit, facility,link or packet link in the NE, depending on the message code modifier, to which the alarm pertains.

ntfcncde Two-character notification code

almtype Alarm type, as one of the following types:� CLFAN = Cooling fan failure� FUSE = Fuse failure� MISC = Miscellaneous condition� POWER = Commercial power failure

ocrdat Date of event occurrence

ocrtm Time of day of event occurrence

almmsg Text message associated with the environmental alarm. It may contain up to 40 characters and must be enclosed within a pair of escaped quotes (\�).




REPT DBCHGreport database change

PurposeThis message is generated by an NE to inform the OS of any database changes that have occurred as aresult of commands entered from another interface channel, and changes due to external events such ascircuit pack insertion or removal.

Any changes to (1) the value of the NE�s TID (or SID), (2) the values of the keywords defined in the commonblock and the specific block, (3) state transition into and out of OOS-MA primary state, and (4) state changeto the RDLD (red-lined) secondary state are considered as database changes. Autonomous Identification<cr><lf>A^^<atag>^REPT^DBCHG

System Response Syntax^^^"TIME=<time>,DATE=<date>,[SOURCE=<source>],[LINK=<linkid>],[USERID=<userid>],DBCHGSEQ=<dbchgseq>:<cmdcde>:<aid>[:<datablk>]"<cr><lf>;


atag Autonomously generated correlation tag.

Message Description

time Shows the current time in HH-MM-SS format.

date Shows the date in YY-MM-DD format.

source Identifies an input-command CTAG, if present.(optional)

dbchgseq A sequential number of the database change message ranging from 1 to 9999.

cmdcde The input command code that indicates whether the action that caused the database change was an addition, modification, or deletion.

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

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




REPT EVTreport event

PurposeThe report event is an autonomous message that is generated for non-alarmed events. The event beingreported may be the change of the status or the occurrence of an irregularity, which by itself is not severeenough 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 arereported initially by REPT EVT.

Autonomous Identification<cr><lf><almcde>^<atag>^REPT^EVT^{EQPT|COM|SYNCN|LINK|<rr>}

System Response Syntax ^^^"[<aid>][,<aidtype>]:<condtype>,[<condeff>],[<ocrdat>],[<ocrtm>],[<locn>][<dirn>],[<monval>],][,<tmper>][:[<conddescr>]"<cr><lf>


almcde Alarm code


rr Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

Message Description

aid The specific equipment unit, facility, link, or packet link in the NE, depending on the message code modifier, to which the alarm pertains.

aidtype Refers to the type of access identifier.

condtype Type of alarmSee CHAPTER 5, TL1 CONDITION TYPES for more information.

condeff 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 RETRIEVE-CONDITION 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 clearedSC- standing condition raisedTC- transient conditionA null value for <condeff> defaults to TC. Parameter grouping is not used with this parameter.

ocrdat Date of event occurrence




Protection Switching MappingTable 2-1 defines the mapping between internal protection switch causes and the <condtype. used in REPTEVT autonomous messages.

ocrtm Time of day of event occurrence

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


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

tmper The accumulation time period for the performance monitoring information if <condtype>is of the form T-x for a threshold violation on <montype> x.

conddescr Detailed text description of the specific event that caused this notification.

Table 2-1. Protection Mapping Definitions

Internal Cause Reported by Working/Protection

autoSwitch WKSWPR

autoSwitchFailed FAILTOSW


autoSwitchRelease WKSWBK

autoSwitchReleaseFailed FAILTORLS

manualSwitch MANWKSWPR

manualSwitchFailed FAILTOSW

manualSwitchRelease MANWKSWBK

manualSwitchReleaseFailed FAILTORLS

forcedSwitch FRCDWKSWPR

forcedSwitchFailed FAILTOSW

forcedSwitchRelease FRCDWKSWBK

Message Description




forcedSwitchReleaseFailed FAILTORLS

lockout LOCKOUTOFPR

lockoutFailed FAILTOSW

lockoutRelease LOCKOUTOFWK

lockoutReleaseFailed FAILTORLS

Table 2-1. Protection Mapping Definitions (Continued)

Internal Cause Reported by Working/Protection




REPT PMreport performance monitoring

PurposeThis autonomous message is generated by an NE to inform the OS or maintenance personnel ofperformance monitoring information. Parameters are provided to report performance monitoring data frommultiple data collection intervals in a single message for NEs that store a history of performance monitoringinformation. REPT PM is an automatic message that is generated by the NE as a result of a previousschedule-performance reporting SCHED PMREPT command received by the NE. NEs should not send anREPT PM unless a schedule has been created using SCHED-PMREPT.

Autonomous Identification<cr><lf>A^^<atag>^REPT^PM^(LINK|SYNCN|<rr>}

System Response Syntax^^^"[<aid>[,<aidtype>]:<montype>,<monval>,[<vldty>],[<locn>],[<dirn>],[<tmper>],[<mondat>],[<montm>]"<cr><lf>


almcde (A) Alarm code indicates the severity of the autonomous message.


rr Facility rate codeSee CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

Message Description



montype Type of monitored parameter whose value is being reported.

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

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




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


tmper The accumulation time period for the performance monitoring information if <condtype> is of the form T-x for a threshold violation on <montype> x.

mondat Date of the beginning of the performance monitoring period specified in <tmper>.

montm Beginning time of day of the performance monitoring period specified in <tmper>.

Message Description




REPT RMVreport removal

PurposeThis 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 ofan 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>}

System Response Syntax^^^"<aid>[,<aidtype>][:<state>]" <cr> <lf>


almcde Alarm code


rr Facility rate code See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

Message Description



state Gives the full state into which the entity is placed.




REPT RSTreport 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 fromservice. An automatic report for the clearance of an alarm or event that triggers the restoration may beassociated with the message.Autonomous Identification<cr><lf><almcde>^<atag>^REPT^RST^{EQPT|COM|LINK|SYNCN|<rr>}

System Response Syntax^^^"<aid>[,<aidtype>][:<state>]" <cr> <lf>





Message Description







EVENT TYPE MAPPINGTable 2-2 summarizes specific event types and the associated autonomous messages.

Table 2-2. Event Type Mapping

Event Autonomous Message

Communications alarm event REPT ALM <rr>

Processing error alarm event REPT ALM <rr>

Equipment alarm event REPT ALM <rr>

Environmental alarm event REPT ALM ENV

Attribute value change event REPT DBCHG

Object creation event REPT DBCHG

Object deletion event REPT DBCHG

State change event REPT RMV <rr>, REPT RST <rr>, REPT DBCHG

Restart event REPT EVT EQPT

Threshold crossing event REPT EVT <rr>

Protection switch report event REPT EVT COM | <rr>

Clock reference switch report event REPT EVT SYNCN

Scheduled PM event REPT PM <rr>



ONLINETM7000/9000/11000 TL1 COMMANDS3

CHAPTER 3TL1 COMMANDS

This chapter describes the currently supported ONLINE TL1 commands in the following sections.� 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



TL1 COMMANDS ONLINETM7000/9000/110003

SECURITY COMMANDSUse the security commands to control the user accounts for the NE. All access privileges and security-related parameters can be configured, modified, deleted, and viewed for individual users and groups ofusers.This section describes the following security commands:

� 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




ACT-PRIV-SECUactivate-privilege-security

PurposeActivate privileges associated with a specified group ID. Privileges cannot be modified for the administratoraccount.

User Input SyntaxACT-PRIV-SECU:[<tid>]:<gid>:[<ctag>]::<gap>;

System Response Syntax� Normal� A normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:


tid Target identifierThe 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.

gid Group identifier

ctag Correlation tag

gap Group access privilege. A value of ALL can be used to specify all access privileges. See CHAPTER 7, GROUP ACCESS PRIVILEGES for more details.

Error Code Description

ICNV Input - command not valid

IDNV Input - data not valid

IICT Input - invalid correlation tag

IITA Input - invalid target identifier

PIUI Privilege - illegal user identity

PICC Privilege - illegal command code

PLNA Privilege - login not active

SCNF Status - command not valid

SDBE Status - internal database error

SROF Status - requested operation failed

SRQN Status- invalid request




ACT-USER activate-user

PurposeAllow users to log in to the system. A normal response is returned if the login request is accepted.

User Input SyntaxACT-USER:[<tid>]:<uid>:[<ctag>]::<pid>;

System Response Syntax� Normal� A normal output response is a comment block containing login, version, and contact

information.� Error�A standard error response indicates one of the following error codes:

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.


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. Consists of up to 20 characters.

uid User identification or login name. This field is case sensitive.

ctag Correlation tag.

pid Password of the user indicated in <uid>. This field is case sensitive.







ALW-USER-SECUallow-user-security

PurposeAllow an appropriate administrator to activate a user account.

User Input SyntaxALW-USER-SECU:[<tid>]:<uid>:[<ctag>];



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. Consists of up to 20 characters.

uid User identification or login name. This field is case sensitive.

















CANC-PRIV-SECUcancel-privilege-security

PurposeCancel privileges that are associated with a specified group ID. Privileges cannot be modified for theadministrator account.

User Input SyntaxCANC-PRIV-SECU:[<tid>]:<gid>:[<ctag>]::<gap>;



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

gid Group identifier. This field is case sensitive.


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
















CANC-SESSIONcancel-session

PurposeCloses the current session. To close sessions other than the current session use the CANC-SESSION-SECU command.

User Input SyntaxCANC-SESSION:[<tid>]::[<ctag>];



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.








CANC-SESSION-SECUcancel-session-user

PurposeClose any session, including the sessions of other users.

User Input SyntaxCANC-SESSION-SECU:[<tid>]:<snid>:[<ctag>];

System Response Syntax� Normal� A normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes.


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.

snid Session identification








CANC-USER cancel-user

PurposeTerminate a TL1 session at the NE. A normal response is returned if the command is accepted.

User Input SyntaxCANC-USER:[<tid>]:[<uid>]:[<ctag>];




uid User identification or login name, or null to log off the current user. This field is case sensitive.






PLNA Input - login not active




DLT-GROUP-SECUdelete-group- security

PurposeDelete the security parameters that are associated with a specific group ID. This task deletes only emptygroups; groups that contain members cannot be deleted.

User Input SyntaxDLT-GROUP-SECU:[<tid>]:<gid>:[<ctag>];

System Response Syntax� Normal�A normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:

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


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. Consists of up to 20 characters.


















DLT-USER-SECUdelete-user-security

PurposeRemove the security parameters that are associated with a specified user. This task is performed by anappropriate administrator and is applicable for closing a user account.

User Input SyntaxDLT-USER-SECU:[<tid>]:<uid>:[<ctag>];



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

uid The user identification or login name.

















ED-PIDedit-password

PurposeChange the password that is used for logging in to the NE. This command is available to any valid user toedit the user�s own password. A normal response is returned if the command is accepted.

User Input SyntaxED-PID:[<tid>]:<uid>:[<ctag>]::<oldpid>,<newpid>;




uid The user identification or login name. The field is case sensitive.


oldpid Old password. The field is case sensitive.

newpid New password. The field is case sensitive.









ED-GROUP-SECUedit-group-security

PurposeEdit the security parameters that are associated with a specified user group. This command allows anappropriate administrator to edit the name of the group. All members of the group are updated to bemembers of the new group name.

User Input SyntaxED-GROUP-SECU:[<tid>]:<oldgid>:[<ctag>]::<newgid>:[<gdcrn>],[<gfnm>];




oldgid Group identifier. This field is case sensitive.

newgid New group identifier. This field is case sensitive.


gdcrn The Group Description

gfnm The group Full Name
















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




ED-USER-SECUedit-user-security

PurposeModify security parameters associated with a specified user account. This command allows theadministrator to edit the user�s password, group ID, and activity status.

User Input SyntaxED-USER-SECU:[<tid>]:<uid>:[<ctag>]::,[<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.



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


uid User identifier

pid User password


udcrn The User Description

ufnm The User Full Name












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 self-demotion to a lower authorization level, thus causing a situation where there would be no remaining user with proper authorization level to issue NESSA commands.








ENT-GROUP-SECUenter-group-security

PurposeSet security parameters that is associated with a specified group ID. This command is used by anappropriate administrator and creates a new group that initially contains no privileges or members.

User Input SyntaxENT-GROUP-SECU:[<tid>]:<gid>:[<ctag>]:::[<gdcrn>],[<gfnm>];























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




ENT-USER-SECUenter-user-security

PurposeSet the security parameters that are associated with a user ID. This command allows an appropriateadministrator to enter the user ID, password, group ID, and activity status.

User Input SyntaxENT-USER-SECU:[<tid>]:<uid>:[<ctag>]::<pid>,,<gid>:<act>,[<udcrn>],[<ufnm>];




uid User identifier. This field is case sensitive.

pid User password


act User activity status


















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 self-demotion to a lower authorization level, thus causing a situation where there would be no remaining user with proper authorization level to issue NESSA commands.

SRQN Status - invalid request




INH-USER-SECUinhibit-user-security

PurposeAllow an appropriate administrator to temporarily disable a user account. To permanently remove a useraccount use the DLT-USER-SECU command.

User Input SyntaxINH-USER-SECU:[<tid>]:<uid>:[<ctag>];




uid The user identification or login name. This field is case sensitive.



ICNV Input- command not valid

IDNV Input - command not valid













RTRV-GROUP-SECUretrieve-group-security

PurposeRetrieve the security parameters associated with a specific group ID. This command allows retrieval of a listof groups, a list of group members, or a list of all members for every group.

User Input SyntaxRTRV-GROUP-SECU:[<tid>]:[<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� Normal�A normal response is:

^^^"<gid>[:<uid>],[<gdcrn>],[<gfnm>];"<cr><lf>


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

gid Group identifier.If this is null, all groups are displayed. This field is case sensitive.



gid Group identifier.

uid User identifier.






� Error�A standard error response indicates one of the following error codes:





IITA input - invalid target identifier

PICC privilege - illegal command code

PIUI privilege - illegal user identity

PLNA privilege - login not active

SCNF status - command not valid

SDBE status - internal database error

SROF status - requested operation failed

SRQN status- invalid request




RTRV-PRIV-SECUretrieve-privilege-security

PurposeRetrieve the privileges that are associated with a single group or all groups.

User Input SyntaxRTRV-PRIV-SECU:[<tid>]:[<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>







gap Group access privilege.See CHAPTER 7, GROUP ACCESS PRIVILEGES for more details.




RTRV-SESSIONretrieve-session

PurposeThis command is for retrieving parameters associated with the current session. To retrieve parameters forsessions other that the current use the RTRV-SESSION-SECU command.

User Input SyntaxRTRV-SESSION:[<tid>]::[<ctag>];


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



tid Target identifier The name of the NE where the command is being sent. This is the system IDstring provisioned in the ONLINE system as the SID/TID for TL1communications, which consists of up to 20 characters.



snid A session identifier

sstat Session status

ipaddr IP address of the client

tmout The inactivity timeout for the session.

uid The user�s identification or login name

rmtcnt The count of remote sessions which are operating over the session.

gwsnid Identifier of the gateway session that a remote session is hosted by.

target System identifier of the session�s target network element.







RTRV-SESSION-SECUretrieve-session-security

PurposeRetrieve parameters that are associated with any session, including the sessions of other users.

User Input SyntaxRTRV-SESSION-SECU:[<tid>]:[<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>



snid Session identification.ALL is supported and implied when this parameter is empty.



snid A session identifier.

sstat Session status.

ipaddr IP address of the client.

tmout The inactivity timeout for the session.

uid The user�s identification or login name.

rmtcnt The count of remote sessions which are operating over the session.

gwsnid Identifier of the gateway session that a remote session is hosted by.

target System identifier of the session�s target network element.




RTRV-USER-SECUretrieve-user-security

PurposeAllow an appropriate administrator to retrieve the security parameters that are associated with a user or agroup. This command does not allow the administrator to retrieve any user�s password.

User Input SyntaxRTRV-USER-SECU:[<tid>]:[<uid>]:[<ctag>];


^^^"<uid>::<gid>:<act>,<udcrn>,<ufnm>"<cr><lf>



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



uid User identifier


act Activity status






TERMINAL SESSION COMMANDSThe terminal session commands are used to modify current, future, and default terminal session properties.The following commands are used to modify terminal sessions.

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




ED-TRMNL-DFLTedit-terminal default

PurposeModify the default properties related to future terminal sessions. This command affects only future sessionsand does not modify the current session nor any other active sessions.

User Input SyntaxED-TRMNL-DFLT:[<tid>]::[<ctag>]:::[COLWIDTH=<colwidth>][,ECHO=<echo>][,EDIT=<edit>][,INSERT=<insert>][,HISTBUF=<histbuf>][,MODE=<mode>][,PWMASK=<pwmask>];

System Response Syntax� Normal� A normal output response is an empty text block.� Error� A standard error response indicates one of the following error codes:




colwidth The number of characters allowed per line on the Telnet client. If empty, this value is not changed.

echo The ability to echo characters from the TL1 server. If empty, this value is not changed.

edit The ability to edit lines of text. If empty, this value is not changed.

insert The state of the insert/overwrite mode. If empty, this value is not changed.

histbuf The NE default size of the history buffer. If empty, this value is not changed.

mode The trigger mode for enabling the human mode (convenience keystroke). If empty, this value is not changed.

pwmask The NE default state of the password masking mode. If empty, this value is not changed.









ED-TRMNL-SESedit-terminal-session

Modifies the properties related to the current terminal session. This command affects only the currentsession and does not modify the future session nor any other active sessions.

User Input SyntaxED-TRMNL-SES:[<tid>]::[<ctag>]:::[COLWIDTH=<colwidth>][,ECHO=<echo>][,EDIT= <edit>][,HISTBUF=<histbuf>]

System Response Syntax� Normal� A normal output response is an empty text block� Error� A standard error response indicates one of the following error codes:


tid Target identifier. This command is effective on only the session to which the terminal is connected.


colwidth Number of characters allowed per line on the Telnet client. If empty, this value is not changed. (Current session only)

echo Ability to echo characters from the TL1 server. If empty, this value is not changed. (Current session only)

edit Ability to edit lines of text. If empty, this value is not changed. (Current session only)

histbuf Size of the history buffer. If empty, this value is not changed. (Current session only)









RTRV-TRMNL-DFLTretrieve-terminal-default

PurposeRetrieve the default properties related to future terminal sessions.

User Input SyntaxRTRV-TRMNL-DFLT:[<tid>]::[<ctag>];


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

� Error� A standard error response indicates one of the following error codes:


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



echo The ability to echo characters from the TL1 server

edit The ability to edit lines of text

colwidth The number of characters allowed per line on the Telnet client

insert The state of the insert/overwrite mode

histbuf The NE default size of the history buffer

mode The trigger mode for enabling the human mode (convenience keystroke)

pwmask The NE default state of the password masking mode.









RTRV-TRMNL-SESretrieve-terminal-session

PurposeRetrieve the properties related to the current terminal session.

User Input SyntaxRTRV-TRMNL-SES:[<tid>]::[<ctag>];


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

� Error� A standard error response indicates one of the following error codes:


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



echo The ability to echo characters from the TL1 server

edit The ability to edit lines of text

colwidth The number of characters allowed per line on the Telnet client

histbuf The NE default size of the history buffer









SET-ATTR-SECUDFLTset-attribute-security default

PurposeModify the default properties related to security.

User Input SyntaxSET-ATTR-SECUDFLT:[<tid>]::[<ctag>]::TMOUT=<tmout>;

System Response Syntax� Normal�A normal output response is an empty text block.� Error� A standard error response indicates one of the following error codes:

Parmeter Description



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







SET-SESSIONset-session

PurposeModify the properties of the current session.

User Input SyntaxSET-SESSION:[<tid>]::[<ctag>]::<tmout>;

System Response Syntax� Normal�A normal output response is an empty text block.� Error� A standard error response indicates one of the following error codes:




tmout The new inactivity timeout value.

Error Description






ALARM SURVEILLANCE COMMANDSUse the TL1 alarm surveillance commands to retrieve alarm reports from specified NEs. Alarms aregenerated as a result of events detected by the ONLINE NE.

This section contains descriptions of the ONLINE TL1 alarm surveillance commands in the followingsections:

� 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




ALW-MSGallow-message

PurposePermit an NE to resume transmission of automatic messages to an OS after being in the inhibit-message(INH-MSG) mode. Parameters are provided to selectively enable messaging. Unreported alarmsin 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 transmittedto the OS with the REPT EVT message.

Allow-message commands sent on one OS or NE, or user session, should not impact other sessions. AnyNE whose messages are inhibited with the INH-MSG command should include the appropriate conditiontype information in response to a retrieve-condition request.

See INH-MSG for related information.

User Input SyntaxALW-MSG-{EQPT|<rr>|LINK|SYNCN|COM|ALL}:[<tid>]:[<aid>]:[<ctag>]:[<ntfcncde>], [<condtype>][,<tmper>];


rr Facility rate code.See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing.


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


ntfcncde Notification code associated with the alarm conditions being retrieved.

condtype Type of alarm condition to retrieve.See CHAPTER 5, TL1 CONDITION TYPES for more details.




System Response Syntax� The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:






SCNF Status - command not active





ASGN-ASAPassign-alarm severity assignment profile

PurposeInstruct an NE to attach an ASAP profile with one or more entities.

User Input SyntaxASGN-ASAP:[<tid>]:<aid>:[<ctag>]::[<instanceAid>];

System Response Syntax� Error�A standard error response indicates one of the following error codes:


tid Target identifier

The name of the NE where the command is being sent. This is the system IDstring provisioned in the ONLINE system as the SID/TID for TL1communications, which consists of up to 20 characters.

aid Access identifier The AID of the ASAP to retrieve.


instanceAid The entity instance aid. Specifies the entity to which the ASAP is applied. ALLis not valid for this parameter in an assign



IIAC Input - invalid access identifier


IIPG Input - invalid parameter grouping


INUP Input - non-null unimplemented parameter

SROF Status-requested operation failed

SDBE Status-internal database error




DLT-ASAPdelete-alarm severity assignment profile

PurposeDelete an existing ASAP profile. Entities previously assigned to this ASAP with the ASGN-ASAP commandmust first be unassigned using the UNASGN-ASAP command before the ASAP may be deleted.

SyntaxDLT-ASAP:[<tid>]:<aid>:[<ctag>];

System Response Syntax� The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:



aid Agent identifier.




IDNV Input- data not valid





IPMS Input-parameter missing






ED-ASAPedit-alarm severity alarm profile

PurposeED-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 thepair is removed.

User Input SyntaxED-ASAP:[<tid>]:<aid>:[<ctag>]::<probcause>[,<ntfcncde>]:[qualifier>];

� Normal�A normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:



aid The AID of the ASAP.


probcause The alarm condition(s) being reported. See Mapping Probable Cause to TL1 Condition Types on page 5-4

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

qualifier Is a descriptor for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical.





IIFM Input - invalid data format





SRQN Status-invalid request




ENT-ASAPenter-alarm severity assignment

PurposeENT-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. Theresulting ASAP applies the user-chosen ntfcncde for the specified probcause for each of the entities towhich it is assigned.

User Input SyntaxENT-ASAP:[<tid>]:<aid>:[<ctag>];

� Normal�A normal response is a normal output response with an empty text block.� Error�A standard error response indicates one of the following error codes:


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















INH-MSGinhibit-message

PurposeInstruct an NE to enter a mode in which certain automatic messages associated with a specific equipmentunit, facility, subscriber line, trunk, link, packet link, or signaling link are prevented from being transmitted tothe OS.

This command only applies to the OS/NE or user session on which this command is sent. Parameters areprovided to selectively disable messaging. This command should not have any effect on indicators in theoffice where the NE resides or on the NE itself. During the entire period of message inhibition, the NE shouldcontinue to respond fully to RETRIEVE-ALARM and RETRIEVE-CONDITION requests. The condition maybe 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 toa RETRIEVE-CONDITION request.See ALW-MSG for related information.

User Input SyntaxINH-MSG-{EQPT|<rr>|LINK|SYNCN|COM|ALL}:[<tid>]:[<aid>]:[<ctag>]::

[<ntfcncde>],[<condtype>][,<tmper>];

� Normal�A normal response is a normal output response with an empty text block.� Error�A standard error response indicates one of the following error codes:




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


ntfcncde Notification code associated with the alarm conditions being retrieved.

condtype Type of alarm condition to retrieve. See CHAPTER 5, TL1 CONDITION TYPES for more details.

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









SCNF Status - command not found





RTRV-ALMretrieve-alarm

PurposeInstruct an NE to retrieve and send the current status of its alarm conditions associated with one or moreequipment units, facilities, links or packet links within the NE. The command may be used to retrieve NEinformation, which in turn may be used to update an OS database when it is suspected that autonomousalarm messages issued by the NE using REPORT ALARM were not received or properly processed. It mayalso 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. Forexample, existing conditions satisfying all the specified input parameters are reported in the messageresponse.

To receive environmental alarms, use the RTRV-ALM-ENV command rather than the RTRV-ALMcommand.

User Input SyntaxRTRV-ALM-{EQPT|COM|LINK|SYNCN|ALL|<rr>}:[<tid>]:[<aid>]:[<ctag>]:: [<ntfcncde>],[<condtype>],[<srveff>],[<locn>],[<dirn>][,<tmper>];






ntfcncde Notification code associated with the alarm conditions being retrieved. Null value defaults to display all values.

condtype Type of alarm condition to retrieve. See CHAPTER 5, TL1 CONDITION TYPES for more details.

srveff Effect on service that is caused by the alarm condition. Null value defaults to display all values.

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





^^^"<aid>[,<aidtype>]:<ntfcncde>,<condtype>,<srveff>,[<ocrdat>],[<ocrtm>],[<locn>],[<dirn>][,<tmper>][:[<conddescr>],]"<cr><lf>

dirn Direction of monitoring relative to the entity defined by the <aid>. Grouping is not available. Null value defaults to display all values.

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




ntfcncde Two-character notification code associated with a single alarm condition.

condtype Single type of alarm condition being reported on this particular line. See CHAPTER 5, TL1 CONDITION TYPES for more details.

srveff Effect on service caused by the alarm condition.

ocrdat Date when the triggering event occurred.

ocrtm Time of day when the triggering event occurred.

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

dirn (Not currently supported for output.)Direction of monitoring relative to the entity defined by the <aid>.

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

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









IITA Input - Invalid target identifier







RTRV-ALM-ENVretrieve alarm environment

PurposeRequest that an NE or office environment monitor retrieve specified, outstanding environmental alarms. Thecommand can be used to retrieve NE information. In turn, this information may be used to update an OSenvironmental alarm database if it is suspected that autonomous alarm messages issued using the REPT-ALM-ENV command are not being received or properly processed.

User Input SyntaxRTRV-ALM-ENV:[<tid>]:[<aid>]:[<ctag>]::[<ntfcncde>][,<almtype>];

System Response Syntax� Normal�If 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>




ntfcncde Notification code for the environmental alarm being requested.


Null value defaults to display all values.


ntfcncde Notification code for the environmental alarm being retrieved.








almmsg Text message associated with the environmental alarm.It may contain up to 40 characters and must be enclosed within a pair of escaped quotes (\�).












RTRV-ASAPretrieve-alarm severity assignment profile

PurposeRetrieve an ASAP profile. By entering an <aid> of "all" or leaving the <aid> empty, all available ASAP profileaids are displayed. By entering a specific <aid>, the <probcause> - <ntfcncde> list and list of entities towhich the ASAP is assigned are displayed.

User Input Syntax

RTRV-ASAP:[<tid>]:[<aid>]:[<ctag>];

System Response Syntax

� Normal�A normal response is:

<aid>[:<probcause>[,<ntfcncde>]:[<qualifier>][:<instanceAid>]]



tid Target identifier.

aid The AID of the ASAP to retrieve. If this parameter is null or all, a list of all available ASAP AIDs are displayed.



aid The aid of the ASAP.


ntfcncde A two-character notification code associated with the indicated <condtype>.See TL1 CONDITION TYPES on page 5-1.

qualifier A descriptor for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical.

instanceAid Is a TL1 aid of an entity to which the ASAP is assigned.


IDNV Input-data not valid

IICT Input-invalid correlation tag

IIPG Input-invalid parameter grouping

IITA Input-invalid target identifier

INUP Input-non-null unimplemented parameter




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.








RTRV-CONDretrieve-condition

PurposeInstruct an NE to return the standing condition or state that is associated with one or more specifiedequipment 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 AIDsassociated 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 theinterface of the specified AIDs and typereq(s). It is likely that this command are used in such a way thateither the AID or the typereq (but not both) conveys the meaning of "all."

User Input SyntaxAll parameters in this command are positional.

RTRV-COND-{EQPT|COM|LINK|SYNCN|ALL|<rr>}:[<tid>]:[<aid>]:[<ctag>]:: [<typereq>],[<locn>],[<dirn>][,<tmper>];




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


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

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

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

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





^^^"<aid>:[<ntfcncde>],<typereq>,[<srveff>],[<ocrdat>],[<ocrtm>],[<locn>],[<dirn>][,<tmper>],[<conddescr>]" <cr> <lf>



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

ntfcncde Two-character notification code associated with a single alarm condition.

typereq Single type of alarm condition being reported on this particular line. See CHAPTER 5, TL1 CONDITION TYPES for more details.

srveff Effect on service caused by the alarm condition.



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

dirn Direction of monitoring relative to the entity defined by the <aid>

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

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











RTRV-COND-SYNCNretrieve-condition-syncn

PurposeInstructs an NE to return the current standing state associated with a sync source.

User Input SyntaxRTRV-COND-SYNCN:[<tid>]:<aid>:[<ctag>];

All parameters in this command are positional.


^^^"<aid>:[ACTSRC=<actsrc>][,ACTSIDE=<actside>][,SYNCNMODE=<syncnmode>],RVRTV=<rvrtv>,WTR=<wtr>, LASTREFSWITCHTIME=<lastrefswtime>,SYNCSWITCHSTATUS=<syncswstatus>,ACTIVESYNCUNIT=<actsyncunit><cr> <lf>



aid Access identifier. Identifies the equipment unit on which the sync source resides.



aid Access identifier.

actsrc The active synchronization source.

actside The port or line-side qualifier ("W"est or "E"ast). This parameter is displayed only for paired ADM cards.

syncnmode The synchronization mode for the specified equipment.

rvrtv Revertive protection mode (Y|N).

wtr Wait to restore time in seconds.

syncswitchstatus Sync Switch Status. It displays text: Manual, Force, or Clear.

astrefswtime The time when the last switch happened

actsyncunit The Sync Unit which is presently active




RTRV-DFLT-ASAPretrieve-default-alarm severity assignment profile

PurposeRetrieve the default severities for a given probable cause or all probable causes.

User Input SyntaxRTRV-DFLT-ASAP:[<tid>]::[<ctag>]::[< probcause>];

System Response Syntax� Normal� A normal output response is:

<probcause>,<ntfcncde>,<qualifier>





probcause The alarm condition(s) whose default severity are retrieved. See Mapping Probable Cause to TL1 Condition Types on page 5-4




qualifier A description for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical.


IDNV Input - command not valid




INUP Privilege - login not active

IPMS Status - command not found






SET-NE-ALLset-network element-all

PurposeInstruct an NE to enter a mode in which certain automatic messages associated with specific event typesare 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 areprovided to selectively enable or disable messaging. This command should not have any effect on indicatorsin 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 RETRIEVE-requests associated with the respective message type.

User Input SyntaxSET-NE-ALL:[<tid>]::[<ctag>]:::<nameblk>



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


nameblk A vendor-specific label associated with specific event categories. The possible values are:

� [ALM=ON|OFF]� [EVT=ON|OFF]� [ENV=ON|OFF]� [PM=ON|OFF]� [DBCHG=ON|OFF]

At least one event type category must be entered.




UNASGN-ASAPdelete-alarm severity alarm profile

PurposeInstructs the NE to detach an ASAP profile from one or more entities.

User Input SyntaxUNASGN-ASAP:[<tid>]:<aid>:[<ctag>]::[<instanceAid>];

� Normal�A normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:



aid AID of the ASAP to retrieve.


instanceAid The entity instance aid. Specifies the entity to which the ASAP is applied. ALLis not valid for this parameter in an assign














MAINTENANCE COMMANDSUse the TL1 maintenance commands to set specified operation controls on the NE. This section containsthe following TL1 maintenance commands.

� 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




EX-SWexercise- switching

PurposeInstruct an NE to exercise a switching algorithm from working to protected equipment or facilities. The NEfollows all the necessary steps prior to switching, but does not actually perform the switch. The commandassumes 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 SyntaxEX-SW-{OC48|STM16}:<tid>:<aid>:<ctag>::[<rspns>][,<protid>][,<dirn>];



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


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

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

dirn Direction of the transmission and is relative to the entity identified by the <aid>. Not supported for input.




INIT-SYSinitialize system

PurposeInstruct an NE to initialize its system processor and/or associated subsystems. This function may be usedat various levels of thoroughness, referred to as phases.

The highest phase initialization is called a "cold restart"; it causes the processor to unconditionally executethe same routine executed on system power-up. By the nature of the function, a normal response cannotbe issued after a cold restart command is executed. In this case, the normal response should be sentimmediately before the power-up routine is entered.Lower phase initializations represent various levels of less drastic system and subsystem initialization. Theshutdown phase causes either the PSM or PEM to perform an orderly shutdown. The INIT-SYS commandis used to shut down a circuit pack (CP) before removing it from the NE for maintenance. There is nosoftware method for returning the CP to service; it must be reseated. Executing the INIT-SYS command onany CP other than the PEM or PSM has no effect and generates an appropriate error message.

User Input SyntaxINIT-SYS:[<tid>]:<aid>:[<ctag>]::<ph>;



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


ph Phase; specifies the type of restart to perform. Valid values are:� 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.




System Response Syntax� Normal�The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:



IIAC Input-invalid access identifier











OPR-ACOoperate alarm cutoff

PurposeInstruct 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 toprovide conditioning only on those alarms that are currently active. The NE should remain able to transmitits 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 GR-474-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 troublestill exists.

User Input SyntaxOPR-ACO-{COM|ALL}:[<tid>]:[<aid>]:[<ctag>];



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





OPR-EXT-CONToperate-external-control

PurposeInstruct an NE to operate an external control, such as a relay activation (alarm outputs). The control can beoperated 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 inresponse to a RTRV-EXT-CONT request. Depending on the type of external control, the NE may also berequired to use the REPT COND message when an external control is being operated.

User Input SyntaxOPR-EXT-CONT:[<tid>]:[<aid>]:[<ctag>];




aid Access identifierIdentifies 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.












OPR-PROTNSWoperate-protection switch

PurposeInstruct a SONET NE to initiate a SONET line or path protection switch request. User switch requestsinitiated with this command (such as forced switch, lockout, and manual switch) remain active until they arereleased via the release-protection-switch (RLS-PROTNSW) command or overridden by a higher priorityprotection 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 SyntaxOPR-PROTNSW-{COM|OCH|rr}:[<tid>]:<aid>:[<ctag>]::<sc>:[<dirn>];



aid Access identifierIdentifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling link in the NE depending on the command code modifier.


sc Switch command that is to be initiated on the line(s) or path(s) identified in the <aid> parameter.

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




OPR-SYNCNoperate-synchronization switch

PurposeInstruct a SONET NE to switch synchronization references. Synchronization reference switches initiatedwith this command remain active until they are released via an update to the sync reference table or areoverridden by a synchronization reference failure.

User Input SyntaxOPR-SYNCN:[<tid>]:<aid>:[<ctag>]:::SYNCSRC=<syncsrc>[,SYNCSIDE=<side>][,SYNCREQUEST=<syncrequest>];





syncsrc Synchronization source

syncside The port or line side qualifier, West or East. This parameter is required for paired ADM CPs only.

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




RLS-EXT-CONTrelease-external-control

PurposeInstruct an NE to release an external control, such as a relay deactivation (alarm outputs). The control canbe released momentarily or continuously, and can be operated by using the OPR-EXT-CONT command.

User Input SyntaxRLS-EXT-CONT:[<tid>]:[<aid>]:[<ctag>];










IITA Input - non-null unimplemented parameter






RLS-PROTNSWrelease-protection switch

PurposeInstruct a SONET NE to release (clear) either a SONET line protection switch request between a workingline and a protection line or a SONET path protection switch request that was established with the OPR-PROTNSW command. This command assumes that only one user-initiated switch request is active perentity (for example, per AID).

User Input SyntaxRLS-PROTNSW-{COM|OCH|rr}:[<tid>]:<aid>:[<ctag>]::[<dirn>];





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




RTRV-EXT-CONTretrieve-external-control

PurposeInstruct an NE to report the control state of an external control. The command can be used to audit the resultof either an OPR-EXT-CONT or a RLS-EXT-CONT command.

User Input SyntaxRTRV-EXT-CONT:[<tid>]:[<aid>]:[<ctag>];

� Normal�The normal response is:

^^^"<aid>:[<conttype>],<dur>[,<contstate>]" <cr> <lf>







conttype Type of controlCurrently defaults to MISC-<num>. The value in <num> = the control number.

dur Duration of the external control operation (relay activation). This output is always CONTS (continuous).

contstate Control state of the external control. Valid values for <contstate> are as follows:

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




PERFORMANCE MONITORING COMMANDSUse the performance monitoring commands to retrieve performance monitoring data from the NE. Thissection contains the following performance monitoring commands:

� 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




INIT-REGinitialize register

PurposeInstructs an NE to initialize the PM counter for a facility. This command allows the initialization of PMcounters on a whole facility base, it initializes 15-MIN counters and 1-DAY counters together.

User Input SyntaxINIT-REG:[<tid>]:<aid>:[<ctag>];

System Response Syntax� The normal response is simply a normal output response with an empty text block.� Error�A standard error response indicates one of the following error codes:


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.

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




IDNV Input - data not found







SROF Status - invalid request




RTRV-PMretrieve performance monitoring

PurposeInstruct an NE to show the current set of performance monitoring data associated with one or moreequipment units, facilities, or links within the NE. It may be used to load an OS or audit an OS databasewhen it is suspected that automatic performance monitoring messages issued using REPT-PM were notreceived or properly processed. The command may also be used to evaluate the system before or after NEmaintenance operations.

Parameters are provided to retrieve past performance monitoring data for NEs that can store a history ofperformance monitoring information. They may also be used to retrieve data that does not cross theautomatic reporting threshold specified in the SCHED-PMREPT command.

This message and the other PM-related messages are based on the following assumptions about the NE�sPM data collection.

� External control over the NE may be exercised in regard to manipulating the reporting of PMdata, 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 directinteraction 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 occurringon the hour.

User Input SyntaxRTRV-PM-{<rr>|LINK|SYNCN}:[<tid>]:[<aid>]:[<ctag>]::[<montype>],[<monlev>],[<locn>],[<dirn>],[<tmper>],[<mondat>][,<montm>];


rr Facility rate code.See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for a complete listing of facility rate codes.

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.

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


montype Type of monitored parameter whose value is being reported. See TL1 MONITOR TYPES on page 6-1 for more details.





^^^"<aid>:<montype>,<monval>,[<vldty>],[<locn>],[<dirn>],[<tmper>],[<mondat>][,<montm>]"<cr><lf>

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

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

dirn Direction of monitoring relative to the entity defined by the <aid>

tmper Accumulation time period for the PM information

mondat Date of the beginning of the PM period specified in <tmper>.

montm Beginning time of day of the PM period specified in <tmper>




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

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

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

dirn Direction of the alarm which is relative to the entity identified by the AID.Not supported for output in this release.

tmper Accumulation time period for the performance monitoring information






mondat Beginning of the performance monitoring period specified in <tmper>

montm Beginning time of day of the performance monitoring period specified in <tmper>















RTRV-PMCTLretrieve-performance monitoring control

PurposeDisplays whether the PM monitoring is currently enabled or disabled. This command only supports path PMmarinating. Therefore, the AID must be a path AID.

User Input SyntaxRTRV-PMCTL:[<tid>]:<aid>:[<ctag>];


^^^"<aid>:PMCTL=<pmctl>" <cr> <lf>







pmctl Control state of the performance monitor. Enabled or Disabled




RTRV-THretrieve-threshold

PurposeInstruct an NE to send the current threshold level of one or more monitored parameters for which violationtriggers 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 SyntaxRTRV-TH-{<rr>|LINK|SYNCN|ALL}:[<tid>]:[<aid>]:[<ctag>][::[<montype>], [<locn>][,<tmper>]];







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

tmper Accumulated time period for the specified monitor parameter <montype>.





^^^"<aid>:<montype>,[<locn>],[<dirn>],<thlev>[,<tmper>]" <cr> <lf>





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

thlev The threshold level for the monitored parameter

dirn Direction of the alarm which is relative to the entity identified by the AID. This parameter is not supported for output in this release.

tmper Accumulation time period for the performance monitoring information














SCHED-PMREPTschedule-performance reporting

PurposeInstruct the NE to start, reschedule, or remove the reporting of performance monitoring data on a specifiedequipment unit, facility, link, or packet link within the NE. When this command is used, it is expected thatthe 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 SyntaxSCHED-PMREPT-{<rr>|LINK}:[<tid>]:[<aid>]:[<ctag>]::,,[<numrept>];






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




System Response Format� Error�A standard error response indicates one of the following error codes:






IPMS Input - parameter missing






SET-PMCTLset-performance monitoring control

PurposeInstruct an NE to enable or disable the PM monitoring on a facility base. This command only supports toenabling or disabling path PM marinating. Therefore, the AID must be a path AID.

User Input SyntaxSET-PMCTL:[<tid>]:<aid>:[<ctag>]:::PMCTL=<pmctl>;

System Response Syntax� The normal response is simply a normal output response with an empty text block.� Error�A standard error response indicates one of the following error codes:



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


pmctl Control state of the performance monitor. Valid values are:� Enabled� Disabled














SET-THset-threshold

PurposeInstruct an NE to set the threshold level for a monitored parameter that, when exceeded, triggers anautomatic message. The threshold level may apply to one or more equipment units, facilities, subscriberlines, trunks, links, packet links, or signaling links in the NE. Threshold setting for multiple monitoredparameters 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 therequest. 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 SyntaxSET-TH-{<rr>|LINK|SYNCN}:[<tid>]:[<aid>]:[<ctag>]::<montype>, <thlev>,[<locn>],[<dirn>][,<tmper>];







thlev The threshold level for the monitored parameter

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

dirn Direction of the alarm which is relative to the entity identified by the AID. Not supported for output in this release.

tmper Accumulated time period for the specified monitor parameter <montype>.




System Response Syntax� Normal�The normal output response is an empty text block. � Error�A standard error response indicates one of the following error codes:













PROVISIONING COMMANDSUse the TL1 provisioning commands to configure and monitor the ONLINE system. This section containsthe following TL1 provisioning commands:

� DLT-{OC3|OC12|STM1|STM4} on page 3-94

� ENT-CRS-<rr> on page 3-128

� DLT-CKT on page 3-95 � ENT-EQPT on page 3-130

� DLT-CRS-<rr> on page 3-96 � ENT-EXTIF on page 3-135

� DLT-EQPT on page 3-97 � ENT-FFP on page 3-136

� DLT-EXTIF on page 3-98 � ENT-PASS on page 3-138

� DLT-FFP on page 3-99 � ENT-RNGMAP-VNODE on page 3-139

� DLT-PASS on page 3-100 � ENT-SBR on page 3-140

� DLT-SBR on page 3-101 � ENT-TRAIL on page 3-142

� DLT-SNE on page 3-102 � ENT-UNSWTS on page 3-143

� DLT-SYNCN on page 3-103 � ENT-VLAN on page 3-144

� DLT-TRAIL on page 3-104 � INIT-RNGMAP-VNODE on page 3-145

� DLT-UNSWTS on page 3-105 � OPR-LPBK on page 3-146

� DLT-VLAN on page 3-106 � RD-SYNCN on page 3-148

� ED-<rr> on page 3-107 � RLS-LPBK on page 3-150

� ED-CKT on page 3-110 � RMV-{ } on page 3-152

� ED-DAT on page 3-112 � RST-{ } on page 3-153

� ED-DW on page 3-114 � RTRV-CKT on page 3-154

� ED-EQPT on page 3-116 � RTRV-CKTINFO-{OCH | <rr> | Gbe | FC | FICON | EQPT} on page 3-156

� ED-EXTIF on page 3-118 � RTRV-CKTINFO-CKT on page 3-158

� ED-FFP on page 3-119 � RTRV-CRS-<rr> on page 3-160

� ED-SBR on page 3-120 � RTRV-EQPT on page 3-162

� ED-SNE on page 3-121 � RTRV-EXTIF on page 3-166

� ED-SYNCN on page 3-122 � RTRV-{<rr>|SYNCN|PMM|LINK} on page 3-167

� ENT-<rr> on page 3-124 � RTRV-FAC-{<rr>|ALL|PMM|LINK} on page 3-167

� ENT-CKT on page 3-126 � RTRV-FIBER-EQPT on page 3-174




� RTRV-FFP on page 3-176 � RTRV-SNE on page 3-189

� RTRV-HDR on page 3-178 � RTRV-SWVER-COM on page 3-191

� RTRV-NETYPE on page 3-179 � RTRV-SWVER-EQPT on page 3-192

� RTRV-PASS on page 3-180 � RTRV-TRAIL on page 3-194

� RTRV-RNGMAP-VNODE on page 3-182 � RTRV-UNSWTS on page 3-195

� RTRV-RNGSTATUS-VNODE on page 3-183

� RTRV-VLAN on page 3-196

� RTRV-SQLCHTBL-VNODE on page 3-185

� SET-SID on page 3-198

� RTRV-SBR on page 3-186 � SET-SYNCN on page 3-199

� RTRV-SIDTABLE on page 3-188




DLT-{OC3|OC12|STM1|STM4}delete- facility [OC-3 | OC-12 | STM-1 | STM-4]

PurposeDelete a specific facility from the specified SONET MUX circuit pack. Prior to deletion, the primary state ofthe facility must be OOS.

NOTE: Parameter grouping is not supported for this command.

User Input SyntaxDLT-{OC3|OC12|STM1|STM4}:[<tid>]:<aid>:[<ctag>];




aid Access identifier








DLT-CKTdelete-circuit

PurposeRemove a provisioned end-to-end circuit from the network.

User Input SyntaxDLT-CKT:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::[ABAND=<band>][,ACHANNEL=<channel>][,ZBAND=<band>] [,ZCHANNEL=<channel>];




aaid, zaid, z2aid Access identifier.Identifies the circuit.


aband, zband Band number for the A or Z node of the circuit to be deleted. This parameter only applies to 3rd party circuits.

achannel, zchannel Channel number for the A or Z node of the circuit to be deleted. This parameter only applies to 3rd party circuits.













DLT-CRS-<RR>delete-cross [connect]

PurposeDelete an STS-12C, STS-3C, STS-1, AU4, and AU44C level cross-connect between a SONET MUXtributary and line side timeslot.

Parameter grouping is not supported for this command.

User Input SyntaxDLT-CRS-{STS12C|STS3C|STS1|AU4|AU44C}:[<tid>]:<fromaid>,<toaid> [,<frompaid>][,<topaid>] :[<ctag>]:::XCTYPE=<xctype>;

System Response Syntax� Normal�The normal response is an empty text block.� Error�A standard error response indicates one of the following error codes:



fromaid Access identifier that identifies the "from" (originating) facility.

toaid Access identifier that identifies the "to" (destination) facility.

frompaid Access Identifier that identifies the "from" (originating) protecting facility.

topaid Access Identifier that identifies the "to" (destination) protecting facility.


xctype MUX connection type







DLT-EQPTdelete-equipment

PurposeRemove provisioning information about a specified CP or other contents of a slot in an NE.

User Input SyntaxDLT-EQPT:[<tid>]:<aid>:[<ctag>];


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.



aid Access identifier Identifies the equipment associated with the command.









DLT-EXTIFdelete-external interface

PurposeThis command is used to delete an existing external interface.

User Input SyntaxDLT-EXTIF:[<tid>]:<aid>:[<ctag>];




aid Access Identifier Identifies the external interface to be created. Grouping is not supported.








DLT-FFPdelete-facility protection group

PurposeDelete a facility protection group.

User Input SyntaxDLT-FFP-{<rr>}:[<tid>]:<workaid>,<protaid>:[<ctag>];

System Response Syntax� Normal�The normal response is a normal output response with an empty text block.� Error�A standard error response indicates one of the following error codes:


rr Facility rate code.For a prottype of SBLSR, only OC48 and STM16 are supported.


workaid Access identifier for the working-side of the protection group.

protaid Access identifier for the protection-side of the protection group.









DLT-PASSdelete-passthrough

PurposeDeletes a band or channel passthrough within a node.

User Input SyntaxDLT-PASS:[<tid>]:<westaid>,<eastaid>:[<ctag>];

System Response Syntax� Normal�The normal response is an empty text block.� Error�A standard error response indicates one of the following error codes:



The name of the NE where the command is being sent. This is the system IDstring provisioned in the ONLINE system as the SID\TID for TL1communications, which consists of up to 20 characters.

westaid Access identifier

Identifies an AID associated with the passthrough circuit. Grouping is notsupported for this command.

eastaid See <westaid>.















DLT-SBRdelete-subrate

PurposeRemove a provisioned end-to-end subrate circuit from the network.

User Input SyntaxDLT-SBR:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>];




aaid, zaid, z2aid Access identifier Identifies the subrate circuit.















DLT-SNEdelete-sonet network element

PurposeRemove a provisioned logical SONET ADM overlay the DWDM fabric.

User Input SyntaxDLT-SNE:[<tid>]:<aid>:[<ctag>];

� Normal�The normal response is an empty text block.� Error�A standard error response indicates one of the following error codes



aid Access Identifier Identifies the pass-through band and possibly channel associated with the pass-through circuit.














DLT-SYNCNdelete-synchronization

PurposeRemoves a provisioned synchronization source. This parameter grouping is not supported for thiscommand.

User Input SyntaxDLT-SYNCN:[<tid>]:<eqptaid>:[<ctag>]:::SYNCSRC=<syncsrc>[,SYNCSIDE=<side>];

� Normal�The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes



eqptaid Access identifierIdentifies the synchronization source to delete.



syncside The port or line side qualifier, west or east (W | E).This parameter is required for paired ADM cards only.














DLT-TRAILdelete-trail

PurposeDeletes the trail connection from an STMX, or ADM CP to a WCI CP (or another STMX, or ADM CP for portchaining configurations.)

User Input SyntaxDLT-TRAIL:[<tid>]:<fromAid>,<toAid>:[<ctag>];

System Response Syntax� Normal�The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes



fromAid Access identifier which identifies the from-side, single equipment unit to which this event pertains.

toAid Access identifier which identifies the to-side, single equipment unit to which this event pertains.








DLT-UNSWTSdelete-unswitched timeslots

PurposeDelete provisioning of unswitched timeslots.

User Input SyntaxDLT-UNSWTS:[<tid>]:<aid>:[<ctag>]:::TSTYPE=<tstype>,STARTTS=<startts>, ENDTS=<endts>;

� Normal�The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:



aid Access identifier.Identifies the equipment and timeslots to be added.


tstype The type of timeslot. The valid values are:� 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 The start timeslot of the unswitched traffic to be provisioned.

endts The end timeslot of the unswitched traffic to be provisioned










DLT-VLANenter-virtual LAN

PurposeDeprovision datawire virtual LANs.

User Input SyntaxDLT-VLAN:[<tid>]:<aid>:[<ctag>]:::<vlanid>;




aid Access identifier. Identifies the facility to create.


vlanid Virtual LAN identification number.

















ED-<RR>edit-facility

PurposeModify the provisioned attributes of a SONET MUX facility. Parameter grouping is not supported for thiscommand.

User Input SyntaxED-{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>,OUTSECTR=<outsectr>,EXPSECTR=<expsectr>][,SECTRMON=<sectrmon>][,TMAP=<tmap>][,TMODE=<tmode>][TTERM=<tterm>][,FAULTPROPMODE=<faultpropmode>][ENABLEAIS=<enableais>][,SECTRMODE=<sectrmode>][,OWDCCBYTEMODE=<owdccbytemode>][,=SECTTRACEC1BYTE<secttraceC1byte>][,SECTTRACEJ0BYTES=<secttraceJ0bytes>][SVCTYPE=<svctype>][,ENABLEDCC=<enabledcc>,ENABLEOSPF=<enableospf>][,CLKID=<clkid>][,OVROUTSSM=<ovroutssm>][,IPMAPPING=<ipmap>][,DCCTYPE=<dcctype>][,PEERIP=<peerip>][,SUBIP=<subip>][,SUBNETMASK=<subnetmask>][,MTU=<mtu>][,FCS=<fcs>][,BITRATE=<bitrate>][:<pst>];



aid Access Identifier. Identifies the facility to modify.


alwB1 Enable state of the B1 Section BIP-8 overhead transparency byte.

alwB2 Enable state of the B2 Line BIP-8 overhead transparency byte.

alwD1_D3 Enable state of the D1_D3 Section DCC overhead transparency byte.

alwD4_D12 Enable state of the D4_D12 Line DCC overhead transparency byte.

alwE1 Enable state of the E1 Section Orderwire overhead transparency byte

alwE2 Enable state of the E2 Line Orderwire overhead transparency byte.

alwF1 Enable state of the F1 User Channel overhead transparency byte.

alwJ0 Enable state of the J0 Section Trace overhead transparency byte.

alwK1_K2 Enable state of the K1_K2 APS overhead transparency byte.

alwM1 Enable state of the M1 Line REI overhead transparency byte.

alwS1 Enable state of the S1 Synchronization overhead transparency byte.

alwSS Enable state of the SS SONET/SDH overhead transparency byte.

alwX1 Enable state of the X1 National overhead transparency byte.





alwZ0 Enable state of the Z0 Section Growth overhead transparency byte.

alwZ1 Enable state of the Z1 Growth overhead transparency byte.


bitrate Bit Rate, only applicable if the SVCTYPE is userSpecifiedRate

enableais A boolean value which indicates whether to enable section trace mismatch detection.

enablepath A boolean value which indicates whether to enable path trace mismatch detection.

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

tranfmt Transmission format for this facility. Note, only supported on ADM and SMX10G circuit packs.

ohmode Overhead Mode for this facility. Note, only supported on Tributary side SMX10G and ADM circuit packs.

outpathtr Transmit (outgoing) path trace value. This is the output value for the Sonet J1 path trace byte values.

owdccbytemode The mode in which the E1/F1/D1-D3 section overhead bytes are transmitted

pathtrtp Type of protocol to use in path trace overhead.

secttraceC1byte The C1 1 byte value {1-255}.

secttraceJ0bytes The 15 byte string for the SDH J0 section overhead 15 bytes.

sectrtp Section Trace Type for this facility. Note, only supported on ADM facilities.

outsectr Transmit (outgoing) Section Trace value. Note, only supported on ADM facilities.

expsectr Expected Section Trace value. Note, only supported on ADM facilities.

sectrmode The mode for transmitting section trace values.

sectrmon Flag for Section Trace (mismatch) monitoring. Note, only supported on ADM facilities.

svctyp Data format of the service.

tmap Transparency mapping.

tmode Transparency mode.

tterm Transparency termination.

faultpropmode Fault Propagation Mode. Note, only supported on FC, FICON, GBE and ESCON facilities.

clkid Clock ID of the facility. Valid values are ( auto|1..20).

ovroutssm Over ride outgoing SSM on the facility [no_override|dus_dnu|stu_allzero]






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

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

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

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

peerip A valid IP address is accepted. This attribute can only be provisioned on the first four tributary side facilities of ADMII.

subip A list of IP addresses separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII.

subnetmask A list of IP Subnet Masks separated by a '&'. This attribute can only be provisioned on the first four tributary side facilities of ADMII.

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

fcs Frame Check Sequence. Valid values are FCS16 and FCS32. This attribute can only be provisioned on the first four tributary side facilities of ADMII.

pst The desired Primary State of the entity.








ED-CKTedit-circuit

PurposeModify the name of circuits.

User Input SyntaxED-CKT:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::[ABAND=<band>][,ACHANNEL=<channel>][,ZBAND=<band>][,ZCHANNEL=<channel>][,USERLABEL=<userlabel>] [,BITRATE=<bitrate>][,PATHFEC=<pathfec>][:<pst>];



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.

aaid, zaid, z2aid Access identifier. Identifies the circuit. Grouping is not supported.


aband, zband Band number for the A or Z node of the circuit to be edited. This parameter only applies to 3rd party circuits.

achannel, zchannel Channel number for the A or Z node of the circuit to be edited. This parameter only applies to 3rd party circuits.

userlabel The new name of the circuit.

pathfec Path forward error correction mode.

bitrate Bit rate of the circuit.

pst The designated primary state of the object.











ED-DATedit-date

PurposeInstruct the NE to change its system date and time to a specified value.

User Input SyntaxED-DAT:[<tid>]::[<ctag>]::<date>[,<time>];


tid Target identifierThe 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.


date Current date is configured in a YY-MM-DD format.� 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.

time Current time is configured in a HH-MM-SS format.� 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.





NOTE: Changing the system date and time may result in the corruption of performance monitoring data for one or more time periods.





IPMS Input - invalid parameter grouping






ED-DWedit-datawire

PurposeChange the connection state of a node�s datawire facility. Either datawire facility, or both datawire facilitiescan 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.� 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 invalidconfiguration to proceed. When this occurs, the datawire connection state of the other side isset to unconnected.

� If there is no conflict, then the requested change is made. Otherwise, a warning message isdisplayed and no change is made.

Valid datawire configurations are:� 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.For this reason, the "both" parameter is only target accepted when the connection state is being changedto passthrough.

User Input SyntaxED-DW:[<tid>]:<aid>:[<ctag>]:::[CONNST=<connst>][,BOTH=true|false][,FORCE=true|false][:<pst>];



aid Access identifier which identifies the facility to modify.


connst Connection state of the datawire circuit pack

both When true, applies CONNST to both East and West side, DataWire facilities.

force When true, resolves CONNST conflict by setting opposite side of DataWire facility to NC.

pst The desired Primary State of the entity.




ED-EQPTedit-equipment

PurposeModify provisioning information about an existing a circuit pack or other contents of a slot in a NE. User

Input SyntaxED-EQPT:[<tid>]:<aid>:[<ctag>]::<eqptype>:<nameblk>[:<pst>,<sst>];



aid Access Identifier Identifies the equipment associated with that circuit.


eqptype The type of circuit pack for a given input command.

nameblk Set of vendor-defined extensions for modifying specific CPs.See Table 3-1 for options.

xmtfmt Specifies transmission format

ohmode Specifies the overhead processing mode.

extpad Indicates the loss insertion for the attached DCM.

maxoutp Indicates the maximum output for a port.

gainmode Gain settings for VGA-type CPsThis setting is not applicable for non-VGA CPs.

ssm SSM parameter can have [enable|disable] values. The default is disable.

sabit Sa Bit attribute can have values [Sa4, Sa5, Sa6,Sa7 & Sa8].

clusterid ID of the cluster that the ADM (ADMII) is in. Value for Cluster ID is an integer in the range of ( 0, 2 - 255)

pst The specific primary state of the object.

sst The specific secondary state of the object.





Eqp Type Nameblk

adm CLUSTERID=<clusterid>

pmm EASTEXTPAD=<extpad>,EMAXOUTP=<maxoutp>WESTEXTPAD=<extpad>,WMAXOUTP=<maxoutp>Applied only to MPT.

postamp GAINMODE=<gainmode>

preamp GAINMODE=<gainmode>

stmx XMTFMT=<xmtfmt>,OHMODE=<ohmode>

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







ED-EXTIFedit-external interface

PurposeThis command is used to modify the power values of an existing external interface.

User Input SyntaxED-EXTIF:[<tid>]:<aid>:[<ctag>]:::EXPINP=<expinp>,TGTOUTP=<tgtoutp>;






expinp Expected input power in dBm. Valid values are: (-25 to 12)

tgtoutp Target Output Power in dBm. Valid values are: (-30 to 12)







ED-FFPedit-facility protection group

PurposeModify the attributes of a facility protection group.

User Input SyntaxED-FFP-{<rr>|OCH|COM}:[<tid>]:<workaid>,<protaid>:[<ctag>]:::[RVRTV=<rvrtv>][,WTR=<wtr>][,SWON=<swon>][,USERLABEL=<userlabel>];



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


workaid Access identifierIdentifies the equipment associated with the working portion of the protection group. Grouping is not available for this parameter.

protaid Access identifierIdentifies the equipment associated with the protecting portion of the protection group. Grouping is not available for this parameter.


rvrtv Revertive protection mode.An FFP with a prottype of SBLSR must always be set to Y.

wtr Wait restore time�in seconds

swon The condition initiating a switch

userlabel The user-supplied name for the logical node and is only used with prottpe of SBLSR.







ED-SBRedit-subrate

PurposeModify the name of subrate circuit.

User Input SyntaxED-SBR:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::[USERLABEL=<userlabel>] [,OFC=<ofc>][:<pst>];




aaid, zaid, z2aid Access Identifier Identifies the subrate circuit. Grouping is not available for this command.


userlabel Identifies the new name of the associated circuit.

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














ED-SNEedit-sonet network element

PurposeModify the name of a provisioned logical SONET ADM.

User Input SyntaxED-SNE:[<tid>]:<aid>:[<ctag>]:::[OLDUSERLABEL=<userlabel>,]NEWUSERLABEL= <userlabel>;




aid Access Identifier


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













ED-SYNCNedit-synchronization

PurposeModify the properties of a synchronization source.

User Input SyntaxED-SYNCN:[<tid>]:<eqptaid>:[<ctag>]:::SYNCSRC=<syncsrc>,SYNCPRI=<syncpri>[,SYNCSIDE=<syncside>][,SYNCSSM=<ssm>[,SYNCFQL=<fql>[,SYNCSSMMODE=<ssmmode>][,SYNCPNO=<pno>][,WTR=<wtr>][,RVRTV=<rvrtv>]:<pst>;



eqptaid Access identifier.Identifies the CP to associate synchronization with.


syncsrc Priority of the entered synchronization source.

syncpri Priority of the entered synchronization source.

syncside Port or line-side qualifier. Valid values are W for west or E for east. This parameter is only required for paired ADM cards.

syncssm An option field associated with a facility. The possible value are (ENABLE, DISABLE), default is DISABLE.

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

syncssmmode SSM processing mode.

pno Provisionable Network Operator quality level.

wrt Wait To Restore Time. Any number in the range of 0 and 12 (0 and 12 inclusive)

rvtv Revertive parameter. Sets the synchronization switch to revert or not revert.Valid values are Y or N.

pst Designated primary state of entity.




ENT-<RR>enter-facility

PurposeProvision a facility on a specified SONET MUX circuit pack. The options are:

� OC-12� OC-3� STM-1� STM-4

NOTE: Parameter grouping is not supported for this command.

User Input SyntaxENT-{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>];




aid Access Identifier. Identifies which facility to create.

tribts Tributary time slot number to associate with this facility.

enabledcc 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

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








System Response System� Normal�The normal output response is an empty text block.� Error�A standard error response indicates one of the following error codes:


fcs Frame Check Sequence. Valid values are FCS16 or FCS32. This attribute can only be provisioned on the first four tributary side facilities of ADMII.

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.

pst The specific primary state of the entity.








ENT-CKTenter-circuit

PurposeProvision end-to-end circuits through the network.

User Input SyntaxENT-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>];



aaid, zaid, z2aid Access Identifier Identifies the circuit. Grouping is not supported.


userlabel User-specified name for the circuit. This name needs to be unique within a subnet.

accesstyp Access type of the circuit

ckttyp Type of circuit to be added or dropped.

svctyp Data format of the service to be added or dropped.

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

� W� E

bitrate Bit rate of the circuit

aband, zband Band number for the A or Z node of the circuit to be created. This parameter only applies to 3rd party circuits.

achannel, zchannel Channel number for the A or Z node of the circuit to be created. This parameter only applies to 3rd party circuits.

pst The specific primary state of the object




ENT-CRS-<RR>enter-cross connection-facility

PurposeProvision an STS-12C, STS-3C, STS-1, AU4, AU44C level cross-connect between a SONET MUX tributaryand line side timeslot.

User Input SyntaxENT-CRS-{STS12C|STS3C|STS1|AU4|AU44C}:[<tid>]:<fromaid>,<toaid>[,<frompaid>][,<topaid>]:[<ctag>]:::XCTYPE=<xctype>[,LINETSMODE=<linetsmode>][,TRIBTSMODE= <tribtsmod>];


rr Facility rate code.Supported rate codes are:

� STS -1� STS-3C� STS-12C� AU4� AU44C


fromaid Access identifier which identifies the "from" facility.

toaid Access identifier which identifies the "to" facility.

frompaid Access identifier.Identifies the "from" protecting facility.

topaid Access identifier.Identifies the "to" protecting facility.

xctype Cross-connect type, the following are options:� 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).

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




ENT-EQPTenter-equipment

PurposeAdd provisioning information about a specific CP, or other contents, of a slot in a NE. Specific name blockformat for each CP are provided in Table 3-1.

User Input SyntaxENT-EQPT:[<tid>]:[<aid>]:[<ctag>]::<eqptype>:<nameblk>[:<pst>[,<sst>]];


side Specifies the side on which the entity operates.

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

channel Specifies the channel is assigned to the circuit pack.

eqptaid The Access Identifier (Section 4.11.1) identifying a circuit pack.

wave A wavelength indicator of the form: <side>-<band>-<channel>.

userlabel A text label for the equipment specified in the ENT-SNE command. This field is case sensitive.

sne An integer between 1 and 999 specifying the SNE entered with the ENT-SNE command to logically contain the ADM or SMX10G circuit pack.

pmode Specifies the protection mode of a circuit pack.

trsptype Specifies how a WCI transponder functions. For regens, if not specified, DUAL is the default value

admtype Indicates the type of ADM circuit pack. Valid values are: 4ADM, 8ADM, 4ADM2S, 4ADM2I, 4ADM2L, 8ADM2S, 8ADM2I, 8ADM2L.

numports Indicates the number of ports supported by a circuit pack.

fchainpos Specifies to which circuit pack in the fiber chain the COM port of the new BWDM is connected.

xmtfmt Specifies transmission format.

ohmode Specifies the overhead processing mode.

dataprot Specifies data protocol.

pmmtype Specifies the PMM type.

extpad Indicates the loss insertion for the attached DCM. Only valid for DCM card. Same for <eastextpad> and <westextpad>.

maxoutp Indicates the maximum output power for a port. Only valid for DCM card. Same for <emaxoutp> and <wmaxoutp>.

gainmode Gain settings for VGA type circuit packs. Not applicable for non-VGA circuit packs.

shelftype Shelf type.




reftype reference type.

frmfmt Frame format.

linecde Line code of source.

ssm SSM attribute can have [enable|disable] values. The default is disable.

sabit Sa Bit attribute can have values [Sa4, Sa5, Sa6,Sa7 & Sa8].

splitmode Splitter mode.

wcitype Type of the WCI circuit pack.

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

dcmtype DCM TYPE

fromcp The EQPT AID of the from side circuit pack. Can also be set to "SPAN" to indicate the span to the remote node.

tocp The EQPT AID of the to side circuit pack.

fromband The band of the from side circuit pack (only valid for all-band BWDM).

toband The band of the to side circuit pack (only valid for all-band BWDM).

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

mate The mate parameter contains the EQPT AID of the adjacent circuit pack of a protected and mated pair of circuit packs

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 RTRV-EQPT only when two ADMs are paired.

bwdm SIDE=<side>,BAND=<band>, ACCESSTYP=<chanaccesstyp> PMODE=<pmode>,FCHAINPOS=<fchainpos>

cwdm SIDE=<side>,BAND=<band>

dch None

dcm DCMTYPE=<dcmtype>,FROMCP=<fromcp>,TOCP=<tocp>[,FROMBAND=<fromband>] [,TOBAND=<toband>]





grdm GRDMTYPE=<grdmtype>,XMTFMT=<xmtfmt>, DATAPROT=<dataprot>

grdm2 GRDMTYPE=<grdmtype>, XMTFMT=<xmtfmt>, DATAPROT=<dataprot>, MATE=<mate>, CLUSTERID=<clustered>

emx XMTFMT=<xmtfmt>

line SIDE=<side>,CCTPKTYPE=<cctpktype>

osc SIDE=<side>

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

postamp SIDE=<side>,VGATYPE=<vgatype>[,GAINMODE=<gainmode>]

preamp SIDE=<side>,VGATYPE=<vgatype>[,GAINMODE=<gainmode>]

regen WESTWAVE=<wave>,WESTWCITYPE=<wcitype>[,WESTNOCWDM=<nocwdm>],EASTWAVE=<wave>,EASTWCITYPE=<wcitype>[,EASTNOCWDM=<nocwdm>] [,TRSPTYPE=<trsptype>]

NOTE: Two WCI cards are added to the system after a regen is entered. As the result, two WCI cards are presented in RTRV-EQPT command, the optional REGEN GROUP is presented in the nameblk (see WCI below).

shelf SHELFTYPE=<shelftype>

smx10g [,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 RTRV-EQPT only when two SMX10Gs are paired.

stem WAVE=<wave>The WAVE is only required when the NE type is not "gateway".

stmx Normal: NUMPORTS=<numports>,XMTFMT=<xmtfmt>,OHMODE=<ohmode>, WAVE=<wave>Chain:NUMPORTS=<numports>,XMTFMT=<xmtfmt>,OHMODE=<ohmode>

Eqp Type Nameblk




System Response Syntax� Normal�The normal response is a normal output response with an empty text block.� Error�A standard error response indicates one of the following error codes:

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>,TRSPTYPE=<trsptype>[,WESTNOCWDM=<nocwdm>], EASTWAVE=<wave>,EASTAID=<eqptaid>, EASTWCITYPE=<wcitype> [,EASTNOCWDM=<nocwdm>]

wci [WAVE=<wave>],[SIDE=<SIDE>],[BAND=<band>], WCITYPE=<wcitype>,TRSPTYPE=<trsptype> [,NOCWDM=<nocwdm>]

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>






Eqp Type Nameblk




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




ENT-EXTIFenter-external interface

PurposeThis command is used to provision an external interface to the BWDM, all-band BWDM, or CWDM for 3rd-party DWDM circuits.

User Input SyntaxENT-EXTIF:[<tid>]:<aid>:[<ctag>]:::MUXTYPE=<muxtype>,EXPINP=<expinp>,TGTOUTP=<tgtoutp>;






muxtype Specifies if the external interface is connected to a BWDM or CWDM circuit pack. Valid values are: (BWDM|CWDM)









ENT-FFPenter-facility protection group

PurposeCreate a facility protection group. This command associates a protecting (alternate) facility with a protectedmain or preferred) facility(s). It also provides for entering attributes of the facility protection group.

User Input SyntaxENT-FFP-{<rr>}:[<tid>]:<workaid>,<protaid>:[<ctag>]:::PROTTYPE=<prottype>[,RVRTV=<rvrtv>][,WTR=<wtr>][,WPSAID=<wpsaid>][,NODEID=<nodeid>][,RINGMAPID=<userlabel>][,USERLABEL=<userlabel>];


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


workaid Access identifier Identifies the working/protected entity in the protection group. Grouping is not supported for this command.

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


rvrtv Revertive protection mode.An FFP with a prottype of SBLSR must always be set to Y.

wtr Wait-to-restore time�in seconds. If not specified, the default value is 300 (seconds).

prottype Protection type





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

userlabel The user-supplied name for a logical node or ring and is only used with prottype of SBLSR.

nodeid An integer indicating a unique identifier for the logical node in an FFP of type SBLSR. Valid node IDs are 0-15.


IISP Input - invalid syntax or punctuation

IPNV Input - parameter not valid


IPEX Input - parameter extra


IDRG Input - data, range error


IBNC Input - block not consistent


IBEX Input - block extra

IBMS Input - block missing

ENEQ Equipage - not equipped

EQWT Equipage - wrong type

SABT Status - aborted

SDNC Status - data not consistent

SSTP Status - stopped

SSRE Status - system resources exceeded

SARB Status - all resources busy





ENT-PASSenter-pass

PurposeProvisions pass-through circuits for bands and/or channels.

User Input SyntaxENT-PASS:[<tid>]:<westaid>,<eastaid>:[<ctag>];




westaid Access identifier. Identifies an AID associated with the passthrough circuit. Grouping is not supported for this command.

eastaid See westaid.

aid Identifies the passthrough band and channel associated with the passthrough circuit.















ENT-RNGMAP-VNODEenter- ringmap- vnode

PurposeENT-RNGMAP-VNODE modifies the ringmap of an FFP with prottype=SBLSR. Content of the ringmapincludes a node ID which is unique among the BLSR nodes within the overlay ring and an ordered list oflogical nodes within the ring in a clockwise direction. The node ID value is in the range of 0 - 15.

User Input SyntaxENT-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>];




aid Access identifierIdentifies the entity to be provisioned by this command.

ctag Correlation Tag

nodeid The integer indicating a unique identifier for this node in the overlay ring. Valid node IDs are 0-15.










ENT-SBRenter-subrate

PurposeProvision end-to-end subrate circuits through the network. It can also be used to provision open endedsubrate circuits where the format of the AID for the open ended side of the subrate must be <nodeId>-0-0-P0-0 for <nodeid>-<shelf>-<slot>-P<port>-<timeslot>.

User Input SyntaxENT-SBR:[<tid>]:<aaid>,<zaid>[,<z2aid>]:[<ctag>]:::USERLABEL=<userlabel>,SVCTYP=<svctyp>[:<pst>];



aaid, zaid, z2aid Access identifier. Identifies the equipment associated with the command.


userlabel User-specified name for the subrate circuit.

svctyp Data format of the subrate service:� GBE - Gigabit Ethernet� FC Fiber Channel� FICON - Fibre Channel� ESCON MUX





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.














ENT-TRAILenter-trail

PurposeProvision a trail connection from an STMX, GRDM, ESCON MUX, SMX10G, or ADM CP to a WCI CP (oranother STMX, GRDM, ESCON MUX, SMX10G, or ADM CP for port chaining configurations).

User Input SyntaxENT-TRAIL:[<tid>]:<fromAid>,<toAid>:[<ctag>];


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.




fromAid Access identifier that identifies the "from" facility.

toAid Access identifier that identifies the "to" facility.







ENT-UNSWTSenter-unswitched timeslots

PurposeENT-UNSWTS provisions unswitched timeslots for NUT / ENUT traffic.

User Input SyntaxENT-UNSWTS:[<tid>]:<aid>:[<ctag>]:::TSTYPE=<tstype>,STARTTS=<startts>, ENDTS=<endts>;




aid Access identifier.Identifies the equipment and timeslots to be added.


tstype The type of timeslot. The valid values are:� NUT (only valid for 1+1 protected ports)� DISABLE_SPANSW (only valid for BLSR protected ports)� DISABLE_RINGSW (only valid for BLSR protected ports).


endts The end timeslot of the unswitched traffic to be provisioned










ENT-VLANenter-virtual LAN

PurposeProvision datawire virtual LANs.

User Input SyntaxENT-VLAN:[<tid>]:<aid>:[<ctag>]:::<vlanid>;




aid Access identifier. Identifies the facility to create.



















INIT-RNGMAP-VNODEinitialize-ringmap

PurposeINIT-RNGMAP-VNODE provisions the ringmap of an FFP with prottype=SBLSR. Content of the ringmapincludes a node ID which is unique among the BLSR nodes within the overlay ring and an ordered list oflogical nodes within the ring in a clockwise direction. The node ID value is in the range of 0 - 15.

User Input SyntaxINIT-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>];
















OPR-LPBKoperate-loopback

PurposeInstruct an NE to perform a loopback on a specified facility. It is assumed that the specified entity is in astate that allows a loopback to occur. If not, an error response is issued by the NE.

User Input SyntaxOPR-LPBK-<rr>:[<tid>]:<aid>:[<ctag>]::[<locn>],[<orgn>],[<intext>],<lpbktype>;



aid Access identifier that identifies the equipment to retrieve. If empty, all fiber equipment is displayed.


locn Identifies the location where the loopback occurs. Not supported for this release.

orgn Office that originated the signal to be looped back. Not supported for this release.

intext Directs the NE to provide a loopback that is with the benefit of reshaping. Not supported for this release.

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




RD-SYNCNread-synchronization

PurposeDisplay the synchronization source table for the specified SONET MUX circuit pack.

User Input SyntaxRD-SYNCN:[<tid>]:<aid>:[<ctag>];

System Response Syntax� Normal�The 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][,WTR=<wtr>][,RVRTV=<rvrtv>:pst"<cr><lf>


tid Target Identifier

aid Access IdentifierIdentifies the synchronization source to retrieve.



aid Access identifier.

syncsrc Synchronization source.

syncpri Priority of the entered synchronization source.

side Port- or line-side qualifier. This parameter is only displayed for paired ADM CPs.

syncssm An option field associated with a facility. The possible values are (ENABLE orDISABLE). The default is DISABLE.

syncfql Forced Quality Level. When the SSM is disabled, a FQL must be selected fromthe list of forced quality levels for this SSM processing mode.

syncssmmode The SSM processing mode.

pno Provisionable Networks Operator quality level

clockid Clock ID of the facility. Valid values are ( auto|1..20).

outgoingssm Outgoing SSM on the facility [no_override|dus_dnu|stu_allzero]

receivedssm Received SSM on the facility.

sycnstate Shows the current status of the clock source.







pst The desired primary state of the entity.















RLS-LPBKrelease-loopback

PurposeInstruct an NE to release loopback on a specified facility. It is assumed that the specified entity is in a statethat allows a loopback to occur. If not, an error response should be issued by the NE.

User Input SyntaxRLS-LPBK-<rr>:[<tid>]:<aid>:[<ctag>]::[<locn>],[<orgn>],[<intext>],[<lpbktype>];



aid Access identifier that identifies the equipment to retrieve. If empty, all fiber equipment is displayed.


locn Identifies the location where the loopback occurs. Not supported for this release.

orgn Office that originated the signal to be looped back. Not supported for this release.

intext Directs the NE to provide a loopback that has the benefit of reshaping. Not supported for this release.

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




RMV-{ }remove- facility

PurposeRemove 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 amaintenance state in which maintenance activities can be performed or moved from the currentmaintenance state to another maintenance state. No alarms should be generated at the near end office asa result of the REMOVE command. Once an entity is removed from service, service-affecting diagnosticroutines or physical replacement of defective equipment can be initiated.

This command is restrictive and is intended for maintenance purposes only. The functionality of thiscommand can also be achieved by using the ED (edit) command in this section.

User Input SyntaxRMV-{EQPT | LINK | SYNCN | CKT | SBR | PMM |VNODE | EXTIF | <rr>} :[<tid>]:<aid>:[<ctag>];



rr Facility rate codeSee CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for acomplete listing.


aid Access Identifier

Identifies the equipment associated with the command.





SNVS Status - not valid source




RST-{ }restore-facility

PurposeInstruct an NE to restore one or more equipment units, facilities, ISDN channels or interfaces, subscriberlines, trunks, links, packet links, or signaling links to service. The entity is taken from a maintenance stateand placed in an in-service state for which the unit is ready to provide its service functions. It is assumedthat these entities are in good working condition.

This command is restrictive and is intended for maintenance purposes only. The functionality of thiscommand can also be achieved by using the EDIT command described in this section.

User Input SyntaxRST-{EQPT | LINK | SYNCN | CKT | SBR | PMM |VNODE| EXTIF | <rr>} :[<tid>]:<aid>:[<ctag>];





aid Access Identifier Identifies the equipment associated with the command.





SNVS Status - not valid source




RTRV-CKTretrieve-circuit

PurposeDisplay information about circuits on a subnetwork.

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 SyntaxRTRV-CKT:[<tid>]:[<aaid>,<zaid>[,<z2aid>]]:[<ctag>]:::[ABAND=<band>][,ACHANNEL=<channel>][,ZBAND=<band>] [,ZCHANNEL=<channel>];


^^^"<aaid>,<zaid>[,<z2aid>]:ASIDE=<side>,AZWAVE=<wave>,ZAWAVE=<wave>,USERLABEL=<userlabel>,ACCESSTYP=<accesstyp>,CKTTYP=<ckttyp>,SVCTYP=<svctyp>[,BITRATE=<bitrate>][,PATHFEC=<pathfec>]:<pst>"<cr><lf>



aaid, zaid, z2aid Access Identifier

Identifies the equipment associated with the circuit.


aband, zband Band number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits.

achannel, zchannel Channel number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits.


aid, zaid, z2aid Access identifierIdentifies the circuit.






userlabel User-specified name for the circuit.

accesstyp Access type of the circuit.

ckttyp Type of circuit to be added or dropped.

svctyp Data format of the service to be added or dropped.

bitrate Bit rate of the circuit.

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

wave The wave associated with the circuit in the given direction.

pathfec Indicates if the fec coder along the circuit are set by the auto config algorithm or turned off.

pst The primary state of the object.















RTRV-CKTINFO-{OCH | <RR> | GBE | FC | FICON | EQPT}retrieve-circuit information-{Optical Channel Facility | Circuit Rate | GigabitEthernet | Fibre Channel | FICON | Equipment}

PurposeGiven the AID of a particular facility or CP, display circuit userlabel and circuit rate information for everycircuit with a termination point at a particular facility or CP.

NOTE: This command does not display subrate circuits for WCI tributary facilities.

User Input SyntaxRTRV-CKTINFO-{OCH | <rr> | GBE | FC | FICON | EQPT}:[<tid>]:<aid>:[<ctag>]:::[ABAND=<band>][,ZBAND=<band>][,ACHANNEL=<channel>][,ZCHANNEL=<channel>];


^^^"<aid>:USERLABEL=<userlabel>,SVCTYPE=<rr>”<cr><lf>


tid The target identifier that identifies the target NE to which a command isdirected. 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 theOS directly interfaces with the target NE. The recommended value for the <tid>,when it is used, is the target�s CLLI code.

aid Access identifier that identifies the entity that is being reported.

ctag The correlation tag that is used to correlate input and response messages. Thevalue of <ctag> is an identifier or a decimal numeral and is limited to amaximum of six ASCII characters. It is assigned by the OS and must beincluded in NE input and response messages where specified.

aband, zband Band number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits.

achannel, zchannel Channel number for the A or Z node of the circuit to be retrieved. This parameter only applies to 3rd party circuits.


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

userlabel Text label representing a user-nameable entity. Consists of a quoted string of up to 64 characters. Grouping is not supported for this parameter.





rr Circuit rate code. Supported rate codes are:� GBE (Gigabit Ethernet) � ESCON � FC (Fibre Channel)� FICON� STM1 (SDH STM-1) � STM4 (SDH STM-4) � STM16 (SDH STM-16) � STM64 (SDH STM-64)











RTRV-CKTINFO-CKTretrieve-circuit information-circuit

PurposeDisplay information about a particular circuit (given its AID). This information includes:

� Circuit userlabel � Circuit rate � A-end facility AID, equipment AID, and CP � Z-end facility AID, equipment AID, and CP

User Input SyntaxRTRV-CKTINFO-CKT:[<tid>]:<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>


tid The target identifier that identifies the target NE to which a command isdirected. 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 theOS directly interfaces with the target NE. The recommended value for the <tid>,when it is used, is the target�s CLLI code.

aid Access identifier that identifies the entity that is being reported.

ctag The correlation tag that is used to correlate input and response messages. Thevalue of <ctag> is an identifier or a decimal numeral and is limited to amaximum of six ASCII characters. It is assigned by the OS and must beincluded in NE input and response messages where specified.



acard The pcode of the card associated with the a-end of the circuit.

aequipaid The Equipment aid of the card associated with the a-end of the circuit.

afacaid The aid of the associated a-end facility.

anodeid The node id of the a-end system (text).

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





rr Circuit rate code. Supported rate codes are:� 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 The pcode of the card associated with the z-end of the circuit.

zequipaid The Equipment aid of the card associated with the z-end of the circuit.

zfacaid The aid of the associated z-end facility.

znodeid The node id of the z-end system (text).











RTRV-CRS-<RR>retrieve-cross [connections]

PurposeRetrieve the STS-12C, STS-3C, STS-1, AU4 and AU44C level, cross-connections associated with theentered AID. Parameter grouping is not supported for this command.

User Input SyntaxRTRV-CRS-{STS12C|STS3C|STS1|AU4|AU44C}:[<tid>]:[<aid>]:[<ctag>];


^^^"<fromaid>,<toaid>[,<frompaid>][,<topaid>]:<cct>,<payload>:XCTYPE=<xctype>[,LINETSMODE=<linetsmode>][,TRIBTSMODE=<tribtsmode>][:<pst>[,<sst>]>]"<cr><lf>



fromaid Access identifier that identifies the cross-connect. If not specified, all cross-connects supported by the second modifier are displayed. Either the from, to or both (comma separated) AIDs can be specified.



fromaid Access identifier which identifies the originating facility.

toaid Access identifier which identifies the destination facility.

cct Cross-connect type

payload Associated payload rate

xctype MUX-connection type

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

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

pst Primary state of the cross-connect

sst Secondary state of the cross-connect






IDNV Input -data not valid






RTRV-EQPTretrieve-equipment

PurposeDisplay the provisioning information of a CP or other contents of a slot in an NE.

User Input SyntaxRTRV-EQPT:[<tid>]:[<aid>]:[<ctag>]::[<eqptype>][:ACTION=<attrfilter>][:<pst>[,<sst>]];


^^^”<aid>:[<pcode>,<width>]:[<eqptype>][,<nameblk>][:<pst>[,<sst>]]”<cr><lf>



aid Access Identifier Identifies the equipment associated with the equipment being requested for display.


eqptype The type of CP for a given input command

attrfilter This field is used to filter retrieve actions. The actions supported are (RXSSM).

pst The desired primary state of the object. Not supported for RTRV-EQPT command input.

sst The desired secondary state of the object. Not supported for RTRV-EQPT command input.


aid Access Identifier Identifies the equipment associated with the equipment being requested for display.

pcode The product code of the CP.

width The number of slots occupied by the CP.

eqptype Type of CP for a given input command

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

pst The primary state of the object

sst Secondary state of the cross-connect




Table 3-1. Parameters Available in <nameblk> for Response to RTRV-EQPT

PARAMETERALL

ADM

BWDM

CWDM

DCH

DCM

EMX

GRDM

GRDM2

LINE

OSC

PMM

POSTAMP

PREAMP

REGEN

SHELF

SMX10G

STEM

STMX

SYNC

UPSR

WCI

WPS

ACCESSTYP Y Y

ADMTYPE Y Y

BAND Y Y Y Y

CCTPKTYPE Y Y

CLUSTERID Y Y Y Y

DATAPROT Y Y Y

DCMLIST Y Y

DCMTYPE Y Y

EASTAID Y Y

EASTEXTPAD Y Y

EASTNOCWDM Y Y Y

EASTWCITYPE Y Y Y

EASTWAVE Y Y Y

EMAXOUTP Y Y

FCHAINPOS Y Y

FRMFMT Y Y

FROMBAND Y Y

FROMCP Y Y

GAINMODE Y Y Y

GRDMTYPE Y Y Y

LINECDE Y Y

MATE Y Y Y Y

NOCWDM Y Y

NUMPORTS Y Y

OHMODE Y Y




PMMTYPE Y Y

PMODE Y Y

REFTYPE Y Y

REGENGROUP Y Y

SABIT Y

SHELFTYPE Y Y

SIDE Y Y Y Y Y Y Y

SNE Y Y Y

SNELABEL Y Y Y Y

SPLITMODE Y Y

SSM Y

TOBAND Y Y

TOCP Y Y

TRSPTYPE Y Y

VGATYPE Y Y Y

WAVE Y Y Y Y

WCITYPE Y Y

WESTAID Y Y

WESTEXTPAD Y Y

WESTNOCWDM Y Y Y

WESTWCITYPE Y Y Y

WESTWAVE Y Y Y

WMAXOUTP Y Y

XMTFMT Y Y Y Y Y Y Y

Table 3-1. Parameters Available in <nameblk> for Response to RTRV-EQPT

PARAMETERALL

ADM

BWDM

CWDM

DCH

DCM

EMX

GRDM

GRDM2

LINE

OSC

PMM

POSTAMP

PREAMP

REGEN

SHELF

SMX10G

STEM

STMX

SYNC

UPSR

WCI

WPS





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.


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.


IISP Input - invalid syntax or punctuation

IPNV Input - parameter not valid


IPEX Input - parameter extra


IDRG Input - data, range error


IBNC Input - block not consistent

IBEX Input - block extra

IBMS Input - block missing

ENEQ Equipage - not equipped

EQWT Equipage - wrong type

SABT Status - aborted

SDNC Status - data not consistent

SSTP Status - stopped

SSRE Status - system resources exceeded








RTRV-EXTIFretrieve-external interface

PurposeThis command is used to retrieve information about an existing external interface.

User Input SyntaxRTRV-EXTIF:[<tid>]:[<aid>]:[<ctag>];


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








muxtype Specifies if the external interface is connected to a BWDM or CWDM circuit pack. Valid values are: (BWDM|CWDM)










RTRV-{<RR>|SYNCN|PMM|LINK}

RTRV-FAC-{<RR>|ALL|PMM|LINK}retrieve-facility [data and state parameters]

PurposeThese commands retrieve the data and state parameters for facilities on the network element. Parametergrouping is not supported for this command.

Table 3-2 lists the parameters that can be displayed in the response output depending on the secondmodifier (<rr>|ALL|SYNCN|PMM|LINK) entered in the command input.

User Input SyntaxRTRV-{<rr>|SYNCN|PMM|LINK}:[<tid>]:[<aid>]:[<ctag>];

RTRV-FAC-{<rr>|ALL|PMM|LINK}:[<tid>]:[<aid>]:[<ctag>][:::[ACTION=<attrfilter>]];


^^^"<aid>::[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>][BAND=<band] [,BITRATE=<bitrate>][,CONCAT=<concat>][,CONNST=<connst>][,ENABLEDCC=<enabledcc>,ENABLEOSPF=<enableospf>][,EQPT=<eqpt>][,EXCOLL=<excoll>][,EXPSECTR=<expsectr>][,FAULTPROPMODE=<faultpropmode>][,FRMFMT=<frmfmt>][,GOODRXFRM=<goodrxfrm>][,GOODTXFRM=<goodtxfrm>][,FLTRXFRM=FltrRxFrm][,LATECOLL=<latecoll>][,LPBKTYPE=<lpbktype>][,LINECDE=<linecde>][,MULTIPLECOLLTXFRM=<multiplecolltxfrm>][,OHMODE=<ohmode>][,OUTSECTR=<outsectr>][,RECSCETR=<recsectr>][,REFTYPE=<reftype>][,RXCRCERRORS=<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>][,CLKID=<clkid>,OVROUTSSM=<ovroutssm>,RECEIVEDSSM=<receivedssm>][,IPMAPPING=<ipmap>][,DCCTYPE=<dcctype>][,PEERIP=<peerip>][,SUBIP=<subip>][,SUBNETMASK=<subnetmask>][,MTU=<mtu>][,FCS=<fcs>][:<pst>[,<sst>]]"<cr><lf>



aid Access Identifier Identifies the facility from which to retrieve data.


attrfilter This field is used to filter retrieve actions. The actions supported are (RTRV-<rr> RXSSM and TXSSM, RTRV-SYNCN: SYNCSRCREPORT).





aid Access identifier. Identifies the facility to modify.

alwB1 Enable state of the B1 Section BIP-8 overhead transparency byte.

alwB2 Enable state of the B2 Line BIP-8 overhead transparency byte.

alwD1_D3 Enable state of the D1_D3 Section DCC overhead transparency byte.

alwD4_D12 Enable state of the D4_D12 Line DCC overhead transparency byte.

alwE1 Enable state of the E1 Section Orderwire overhead transparency byte

alwE2 Enable state of the E2 Line Orderwire overhead transparency byte.

alwF1 Enable state of the F1 User Channel overhead transparency byte.

alwJ0 Enable state of the J0 Section Trace overhead transparency byte.

alwK1_K2 Enable state of the K1_K2 APS overhead transparency byte.

alwM1 Enable state of the M1 Line REI overhead transparency byte.

alwS1 Enable state of the S1 Synchronization overhead transparency byte.

alwSS Enable state of the SS SONET/SDH overhead transparency byte.



alwZ0 Enable state of the Z0 Section Growth overhead transparency byte.



band Band of the facility.

bitrate Bit rate.

concat If TRUE, this specifies concatenated payload.Applies to OC12/STM4 ports for STMX circuit packs only.

connst Connection state.

datarate Specifies the datarate 10 mbps or 100 Mbps.

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

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

eqpt Equipment AID associated with this facility.

excoll Excessive Collisions (Integer Value).

expsectr Expected section trace




faultpropmode Fault Propagation mode. Applies only to FC, FICON, GBE and ESCON facilities.

frmfmt Frame Format

goodrxfrm Good Receive Frames (Integer Value).

goodtxfrm Good Transmit Frames (Integer Value).

fltrrxfrm Filtered Receive Frames

latecoll Late Collisions (Integer Value).

linecde Line Code

lpbktype Loopback type

multiplecolltxfrm Multiple collision transmit frames (Integer Value).

ohmode Overhead processing mode for this facility.

outsectr Output section trace

recsectr Receive section trace

reftype Reference Type

rxcrcerrors Receive CRC Errors (Integer Value).

rxoctets Receive octets (Integer Value).

sdbert SD BER Threshold (Integer Value).

sectrmon Section trace monitor

sectrtp Section trace type

senseerrs Carrier Sense Errors (Integer Value).

sfbert SF BER Threshold (Integer Value).

side Side of the facility (W or E).

singlecoltxfrm Single collision on Transmit Frames (Integer Value).

tmap Transparency mapping.

tmode Transparency mode.

tterm Transparency termination.

tranfmt Transmission format for this facility.

NOTE: Only supported on ADM circuit packs.

tribts SONET MUX, Tributary Time Slot number associated with this facility.

txoctets Transmit Octets (Integer Value).

wave The wave the facility occupies.

clockid Clock ID of the facility. Valid values are ( auto|1..20).






ovroutssm Outgoing SSM on the facility [no_override|dus_dnu|stu_allzero]

receivedssm Received SSM on the facility.

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






fcs Frame Check Sequence. Valid values are FCS16 and FCS32. This attribute can only be provisioned on the first four tributary side facilities of ADMII.

pst Primary state of the specified facility.

sst Secondary state of the specified facility.









Table 3-2. Parameters Displayed in Response to <rr>

PARAMETERALL

DW

ESCON

FC

GBE

LINK

OB

OC3

OC12

OC48

OC192

OCH

OT

PMM

STM1

STM4

STM16

STM64

STS1

STS3C

STS12C

SYNCN

alwB1 Y Y Y Y Y

alwB2 Y Y Y Y Y

alwD1_D3 Y Y Y Y Y

alwD4_D12 Y Y Y Y Y

alwE1 Y Y Y Y Y

alwE2 Y Y Y Y Y

alwF1 Y Y Y Y Y

alwJ0 Y Y Y Y Y

alwK1_K2 Y Y Y Y Y

alwM1 Y Y Y Y Y

alwS1 Y Y Y Y Y

alwSS Y Y Y Y Y

alwX1 Y Y Y Y Y

alwX2 Y Y Y Y Y

alwZ0 Y Y Y Y Y

alwZ1 Y Y Y Y Y

alwZ2 Y Y Y Y Y

band Y Y Y Y

bitrate Y Y

concat Y Y

connst Y Y

eqpt Y Y

excoll Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

expsectr Y Y

faultpropmode Y Y Y Y




frmfmt Y Y Y

goodrxfrm Y Y

goodtxfrm Y Y

latecoll Y Y

linecode Y Y

lpbktype Y Y

multiplecolltxfrm Y Y Y Y Y Y Y Y Y

ohmode Y Y

outsectr Y Y Y Y Y Y Y Y Y

recsectr Y Y Y Y Y Y

reftype Y Y Y Y Y Y

rxcrcerrors Y Y

rxoctets Y Y

sdbert Y Y

sectrmon Y Y Y Y Y Y Y Y Y Y Y

sectrtp Y Y Y Y Y Y

senseerrs Y Y Y Y Y Y

sfbert Y Y

side Y Y Y Y Y Y Y Y Y Y Y

singlecolltxfrm Y Y

tranfmt Y Y

tribts Y Y Y Y Y Y Y Y Y

txoctets Y Y Y Y Y

wave Y Y

pst Y Y Y

sst Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

enabledcc Y Y Y Y Y Y Y Y


PARAMETERALL

DW

ESCON

FC

GBE

LINK

OB

OC3

OC12

OC48

OC192

OCH

OT

PMM

STM1

STM4

STM16

STM64

STS1

STS3C

STS12C

SYNCN




enableospf Y Y Y Y Y Y Y Y

Dcctype Y Y Y Y Y Y Y Y

Ipmapping Y Y Y Y Y Y Y Y

PeerIp Y Y Y Y Y Y Y Y

SubIp Y Y Y Y Y Y Y Y

SubnetMask Y Y Y Y Y Y Y Y

MTU Y Y Y Y Y Y Y Y

FCS Y Y Y Y Y Y Y Y


PARAMETERALL

DW

ESCON

FC

GBE

LINK

OB

OC3

OC12

OC48

OC192

OCH

OT

PMM

STM1

STM4

STM16

STM64

STS1

STS3C

STS12C

SYNCN




RTRV-FIBER-EQPTretrieve-fiber-equipment

PurposeDisplay the fiber connection information for the NE. Fiber connections between CPs and/or NEs aredisplayed when this command is issued.

User Input SyntaxRTRV-FIBER-EQPT:[<tid>]:[<aid>]:[<ctag>];


^^^”FROMCP=<fromcp>,FROMCPTYPE=<fromcptype>,FROMPORT=<fromport>,FROMSIDE=<fromside>,PAD=<pad>,TOCP=<tocp>,TOCPTYPE=<tocptype>,TOPORT=<toport>,TOSIDE=<toside>”<cr><lf>


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/TIDfor TL1 communications, which consists of up to 20 characters.

aid Access identifier that identifies the equipment that is associated with theequipment that is being requested for display. If this field is empty, values for allfiber equipment are displayed.



fromcp EQPT AID of the From side CP for the fiber connection.

fromcptype The type of the From side CP for the fiber connection.

fromport The port of the From side CP for the fiber connection.

fromside The side of the From side CP for the fiber connection.

tocp EQPT of the To side CP for the fiber connection.

tocptype The type of the To side CP for the fiber connection.

toport The port of the To side CP for the fiber connection.

toside The side of the To side CP for the fiber connection.

pad The padding value of the fiber connection.





NOTE: Logical REGENs cannot be displayed with this command; however, the individual WCI CPs can be displayed.








RTRV-FFPretrieve-facility protection group

PurposeRetrieve the attributes and state of a facility protection group.

User Input SyntaxRTRV-FFP-{<rr>}:[<tid>]:[<workaid>],[<protaid>]:[<ctag>];


^^^"<workaid>,<protaid>:[RVRTV=<rtrtv>][,WTR=<wtr>][,SWON=<swon>][,PROTTYPE=<prottype>][,WPSAID=<wpsaid>][,USERLABEL=userlabel>][,RINGMAPID=<userlabel>][,NODEID=<nodeid>]"<"<cr><lf>




workaid Access IdentifierIdentifies the working and protected entity in the protection group. Grouping is not supported for this command.

protaid Access Identifier Identifies the alternate and protecting entity in the protection group. Grouping is not supported for this command.



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

protaid Access identifier. Identifies the alternate/protecting entity in the protection group.

rvrtv Revertive protection mode. Displayed for COM and all rate codes (<rr>) except OT.

wtr Wait-time to restore�in seconds.

swon The condition that initiates a switch.

prottype The protection type





wpsaid The equipment aid (Section 4.11.1) of the WPS. This field is only displayed when prottype is OUPSR or STMXODPR.

userlabel is the userlabel for the logical node or ringmap and is only displayed for prottype=SBLSR.

nodeid an integer indicating a unique identifier for the logical node. Valid node ids are 0-15. Only displayed for prottype=SBLSR.

activeport AID of the currently active (providing service) line or tributary port in the protection group.









RTRV-HDRretrieve header

PurposeRequest an NE to reply with a normal response indicating COMPLD. The information of interest in the replyis 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 isactive and operating normally, a normal response is returned.

User Input SyntaxRTRV-HDR:<tid>::<ctag>;












RTRV-NETYPEretrieve-network element type

PurposeInstructs the NE to retrieve its equipment related information.

User Input SyntaxRTRV-NETYPE:[<tid>]::[<ctag>];


^^^"CIENA,ONLINE,<netype>,<swversion>"<cr><lf>






netype Network Element Type The contents of <netype> is a text string of up to 40 characters.

swversion The software release issue of a network element. The contents of <swversion> is a text string of up to 40 characters.








RTRV-PASS retrieve passthrough

PurposeDisplay information about the passthroughs of a particular node.

User Syntax InputRTRV-PASS:[<tid>]:[<westaid>,<eastaid>]:[<ctag>];


^^^"<westaid>,<eastaid>"<cr><lf>



westaid Access IdentifierIdentifies an AID associated with the passthrough circuit. If this field is left empty, all passthroughs are displayed. Grouping is not supported for this command.




westaid Access identifierIdentifies the pass-through band and possible the channel associated with the pass-through circuit.





RTRV-RNGMAP-VNODERetrieve- ringmap- vnode

PurposeThis command is used to retrieve the current and backup node ids and maps for the network elements inthe SONET BLSR ring.

User Input SyntaxRTRV-RNGMAP-VNODE:[<tid>]:[<aid>]:[<ctag>];


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










userlabel Unique name for the overlay ringmap.







RTRV-RNGSTATUS-VNODEretrieve-ring status - vnode

PurposeRetrieve 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 SyntaxRTRV-RNGSTATUS-VNODE:[<tid>]:[<aid>]:[<ctag>];


^^^"<aid>,aidtype>]::RINGLABEL=<userlabel>,NODELABEL=<userlabel>,NODEID=<snodeid> [,K1K2EASTRX=<byte>][,K1K2EASTTX=<byte>][, [,K1K2WESTRX=<byte>] [,K1K2WESTTX=<byte>][,NODESTATUS=<nodestatus>[,ERINGSTATUS=<ringstatus>][,WRINGSTATUS=<ringstatus>]"<cr><lf>



aid Access identifier.Identifies the entity to be provisioned by this command.



ringid A string indicating a unique ring id.

userlabel A string indicating the ring or node name

snodeid An integer indicating a unique identifier for a node in the SONET BLSR ring. Valid node IDs are 0-15.

byte The K1/K2 byte(s) received.

nodestatus An indication of the state of the SONET BLSR node. Possible values are: UNPROVISIONED, IDLE, SWITCHING, PASSTHROUGH, ISOLATED, UNKNOWN.

ringstatus An indication of the switching substate of the ring. Possible values are: NOBRIDGE, BRIDGE, BRIDGEDSWITCHED, NA.




RTRV-SQLCHTBL-VNODEretrieve- squelch table-vnode

PurposeDisplay channels being squelched on a SONET BLSR ring.

User Input SyntaxRTRV-SQLCHTBL-VNODE:[<tid>]:[<aid>]:[<ctag>];

System Response Syntax

� Normal�The normal output response is:

^^^"<aid>[,aidtype]::WSVCTYPE=<svctype>,ANODEW=<nodeid>,ZNODEW=<nodeid>,ESVCTYPE=<svctype>,ANODEE=<nodeid>,ZNODEE=<nodeid>"<cr><lf>




aid Access identifier.Identifies the entity to be provisioned by this command.



aid Access identifier that identifies the vnode associated with the squelch table.

svctype The type of service being provided (OCx, STMX).

nodeid The logical node id of an element in the overlay ring.







RTRV-SBRretrieve-subrate

PurposeDisplay information about circuits on a subnetwork.

User Input SyntaxRTRV-SBR:[<tid>]:[<aaid>,<zaid>[,<z2aid>]]:[<ctag>];


^^^"<aaid>,<zaid>[,<z2aid>]:USERLABEL=<userlabel>,SVCTYP=<svctyp>,AWAVE=<wave>,ZWAVE=<wave>[,OFC=<ofc>]:<pst>"<cr><lf>


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.

aaid, zaid, z2aid Access Identifier Identifies the subrate circuit. If this block is null, all subrates are displayed.



aid Access identifier that identifies the subrate circuit.

aidtype Type of access identifier

userlabel User-specified name for the subrate circuit

svctyp Data format of the subrate service

wave The AID of an optical channel associated with the A and Z side of a subrate. Uses the OCH BLSR AID format.

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

pst The primary state of the object





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.














RTRV-SIDTABLEretrieve-system identifier table

PurposeRetrieve the system identifier and node identifier for each NE in the subnetwork.

User Input SyntaxRTRV-SIDTABLE:[<tid>]:[<sid>]:[<ctag>]:

;


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




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



sid System identifier of an NE.

nodeid Node identifier of an NE.







RTRV-SNEretrieve-sonet network element

PurposeDisplay information about logical SONET ADM overlays.

User Input SyntaxRTRV-SNE:[<tid>]:[<aid>]:[<ctag>];


^^^"<aid>[,<aidtype>]:USERLABEL=<userlabel>,XMTFMT=<xmtfmt>"<cr><lf>



aid Access identifier Identifies the SNE.



aid Access identifierIdentifies the subrate circuit

aidtype Type of access identifier

userlabel User-specified name

xmtfmt Specifies transmission format.




RTRV-SWVER-COMretrieve-software version common

PurposeRetrieve the software release version of a network element.

User Input SyntaxRTRV-SWVER-COM:[<tid>]::[<ctag>];


^^^"COM:<validity>:[VER=<ver>][,CURRREL=<currrel>][,ALTREL=<altrel>][,MAINTREL=<maintrel>]"<cr><lf>

� Error�A standard error response indicates one of the following error codes





validity The equipment information is valid. Valid values are as follows:� VALID = Information is valid.� UNINITIALIZED = Information is not set on the specific equipment.

ver The software version of a network element. The contents of <ver> is a text string of up to 40 characters.

currrel The current release version of a network element. The contents of <currrel> is a text string of up to 40 characters.

altrel The alternate release version of a network element. The contents of <altrel> is a text string of up to 40 characters.

maintrel The maintenance release version of a network element. The contents of <maintrel> is a text string of up to 40 characters.








RTRV-SWVER-EQPTretrieve-software version equipment

PurposeRetrieve the software release version of circuit packs in a network element.

User Input SyntaxRTRV-HDR:[<tid>]:[<aid>]:[<ctag>];


^^^"<aid>:<validity>:[APP=<app>][,BOOT=<boot>][,MBL=<mbl>][,OS=<os>][,DB=<db>][,FPGA=<fpga>][,APPLET=<applet>]"<cr><lf>






aid Access identifier. Identifies the circuit pack.

validity The equipment information validity. Valid values are:� VALID = Information is valid. � UNREPORTED = Information is not reported by the specific

equipment.

app Application load. The contents of <app> is a text string of up to 40 characters.

boot The boot loader load. The contents of <boot> is a text string of up to 40 characters.

mbl The micro boot loader load. The contents of <mbl> is a text string of up to 40 characters.

os The operating system load. The contents of <os> is a text string of up to 40 characters.

db The database load.The contents of <db> is a text string of up to 40 characters.

fpga The FPGA load.The contents of <fpga> is a text string of up to 40 characters.

applet The applet load.The contents of <applet> is a text string of up to 40 characters.




RTRV-TRAILretrieve-trail

Retrieve the trail connections associated with the specified equipment AID.

User Input SyntaxRTRV-TRAIL:[<tid>]:[<fromAid>,<toAid>]:[<ctag>];


^^^"<aid>:<fromAid>,<toAid>"<cr><lf>




fromAid, toAid Access identifierIdentifies the equipment containing the trails. If null, all values are displayed.



fromAid Access identifierIdentifies the single equipment unit� "from" (originating) side.

toAid Access identifierIdentifiers the single equipment unit� "to" (destination) side.








RTRV-UNSWTSretrieve-unswitched timeslots

PurposeDisplays unswitched timeslot traffic.

User Input SyntaxRTRV-UNSWTS:[<tid>]:<aid>:[<ctag>];

System Response Syntax^^^"<aid>:::STARTTS=<startts>,ENDTS=<endts>[,ENUTTYPE=<enuttype>,DIR=<dir>]"<cr><lf>+



aid Access identifier.Identifies the equipment and timeslots to be displayed with this command.



aid Access identifier.Identifies the equipment and timeslots.


endts The end timeslot of the unswitched traffic to be provisioned.

enuttype The type of ENUT traffic. Valid values are:� DISABLE_RINGSW � DISABLE_SPANSW

Displayed only for ENUT traffic.

dir The direction of the ENUT traffic. Valid values are: � EAST � WEST

Displayed only for ENUT traffic.





RTRV-VLANretrieve-virtual LAN

PurposeRetrieve information on datawire virtual LANs.

User Input SyntaxRTRV-VLAN:[<tid>]:<aid>:[<ctag>];


<aid>:::<vlanid>;



aid Access identifier.Identifies the created facility.


vlanid Virtual LAN identification







SET-SIDset-system identification

PurposeInstructs the NE to change the system identification (SID) code to a specified value. Where appropriate, thevalue of this SID code is used as the target identifier (TID) in a input command and source identifier in anoutput or autonomous message.

User Input Syntax SET-SID:[<tid>]::[<ctag>]::<sid>;

System Response Syntax� Normal�The normal response is a normal output response with an empty text block. The SID

in this response should be the new SID.� Error�A standard error response indicates one of the following error codes:

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.


tid Target identifier The name of the NE where the command is being sent. This is the system IDstring provisioned in the ONLINE system as the SID/TID for TL1communications, which consists of up to 20 characters.


sid System identification code to be assigned to the NE. The value of SID may beany valid simple or compound TL1 identifier or text string. It is limited to20 characters. The recommended value for this parameter is the NE�s CLLI.









SET-SYNCNset-synchronization

PurposeProvision the synchronization source selection table. Parameter grouping is not supported for thiscommand.

User Input SyntaxSET-SYNCN:[<tid>]:<eqptaid>:[<ctag>]:::SYNCSRC=<syncsrc>,SYNCPRI=<syncpri>[,SYNCSIDE=<side>][,SYNCSSM=<ssm>[,SYNCFQL=<fql>[,SYNCSSMMODE=<ssmmode>][,SYNCPNO=<pno>][,WTR=<wtr>][,RVRTV=<rvrtv>]:pst;



eqptaid Access identifierIdentifies the circuit pack with which to associate the synchronization.



syncpri The priority of the entered synchronization source

syncside The port or line-side qualifier (W-west; E-east). This parameter is required forADM CPs only.

syncssm An option field associated with a facility. The possible values are (ENABLE orDISABLE). The default is DISABLE.

syncfql Forced Quality Level. When the SSM is disabled, a FQL must be selected fromthe list of forced quality levels for this SSM processing mode.

syncssmmode The SSM processing mode.

pno Provisionable Networks Operator quality level



pst The primary state of the selected table entry








IIAC Invalid - invalid access identifier









ONLINETM7000/9000/11000 TL1 PARAMETER DEFINITIONS4

CHAPTER 4TL1 PARAMETER DEFINITIONS

This chapter summarizes the TL1 codes and definitions in the following sections:� Codes on page 4-1� Definitions on page 4-3

CODESCodes indicate alarms, errors, notifications, and system conditions in the system messages. They areexplained in the following sections:

� 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, andminor. The non-alarm message designation is used when the NE is reporting non-alarmed events, periodicmeasurements, or results of previously scheduled diagnostics or audits. The alarm codes, in decreasing order of severity, are:

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

ICNV Input - Command Not Valid

IDNC Input - Data Not Consistent

IDNV Input - Data Not Valid

IIAC Input - Invalid Access Identifier

IICT Input - Invalid Correlation Tag

IIFM Input - Invalid Data Format







TL1 PARAMETER DEFINITIONS ONLINETM7000/9000/110004

Notification Codes (ntfcncde)

The values CR, MJ, and MN are issued by the REPT ALM Message. The NA message is issued by theREPT EVT message. Those messages coded as not reported (NR) indicate that the associated informationis retained in the NE at the time of the event.







SENF Status - error not found



IISP Input, invalid syntax or punctuation

IPNV Input parameter, not valid

IPEX Input, parameter, extra

IDRG Input, data, range error

IBNC Input, block, not consistent

IBEX Input, block, extra

IBMS Input, block, missing

ENEQ Equipage, not equipped

EQWT Equipage, wrong type

SSTP Status, stopped

SSRE Status, system resources exceeded

ICNC Input, command, not consistent

SABT Status, aborted

SDNC Status, data, not consistent

SARB Status, all resources busy

Table 4-1. TL1 Error Codes (Continued)

Code Description




TL1 notification codes identify the events shown in Table 4-2.

DEFINITIONSThis section contains parameter definitions and rules that are used in TL1 messages and occur in multipleTL1 commands.

Table 4-2. TL1 Notification Codes

Code Description

CR Critical Alarm

MJ Major Alarm

MN Minor Alarm

NA Not Alarmed

NR Not Reported

Table 4-3. TL1 Parameter Definitions and Rules

Parameter Definition

<accesstyp> Access type of the circuit. Grouping is not supported for this parameter. Valid values are:

� WCA: Working Channel Access� UCA: Unswitched Channel Access

<act> Activity status associated with a userThe status can be either �activated� or �deactivated�.

<activeport> Line or tributary port AID of the currently active (providing service) side in the protection group.

<actside> Qualifier for <syncsrc> selection. Valid values are:� W (west)� E (east)

<actsrc> Valid synchronization references (depending on hardware used) include:� LN Line� P1 � P16 Port number� PRI Primary External Reference (ExtRef-A)� SEC Secondary External Reference (ExtRef-B)� INT Internal Clock




<admtype> Indicates the type of ADM circuit pack. Valid values are:� 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 alarmThe 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.

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

<alwB1> Modifies enable state of the B1 Section BIP-8 overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwB2> <alwB2> modifies enable state of the B2 Line BIP-8 overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwD1_D3> <alwD1_D3> modifies enable state of the D1_D3 Section DCC overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwD4_D12> <alwD4_D12> modifies enable state of the D4_D12 Line DCC overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwE1> <alwE1> modifies enable state of the E1 Section Orderwire overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwE2> <alwE2> modifies enable state of the E2 Line Orderwire overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwF1> <alwF1> modifies enable state of the F1 User Channel overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

Table 4-3. TL1 Parameter Definitions and Rules (Continued)





<alwJ0> Modifies enable state of the J0 Section Trace overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwK1_K2> <alwK1_K2> modifies enable state of the K1_K2 APS overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwM1> <alwM1> modifies enable state of the M1 Line REI overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwS1> <alwS1> modifies enable state of the S1 Synchronization overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwSS> <alwSS> modifies enable state of the SS SONET/SDH overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwX1> <alwX1> modifies enable state of the X1 National overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwX2> <alwX2> modifies enable state of the X2 National overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwZ0> <alwZ0> modifies enable state of the Z0 Section Growth overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwZ1> <alwZ1> modifies enable state of the Z1 Growth overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).

<alwZ2> <alwZ2> modifies enable state of the Z2 Growth overhead transparency byte. Valid values are:Y (Enabled) or N (disabled).






<asaptype> The name of an Alarm Severity Assignment Profile (ASAP). Valid values are as follows:

� 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

<band> Specifies the wavelength band in which an entity operates. Valid values are: � {1-11}� allBand_1_5 � allBand_7_11

All band modes are only valid when adding a BWDM CP.

<bitrate> Bit rate for a circuit. Grouping is not supported for this parameter.Valid values are 100.0 - 2500.0.

<byte> The K1K2 byte value(s) received or transmitted.

<chanaccesstyp> Channel access type� switched� unswitched

<channel> Specifies the wavelength channel in which the entity operates.The values are 1-3.

<cct> Cross-connect type. Valid value is 2-way.

<cctpktype> Line CP type� line� olm� osm






<ckttyp> Type of circuit to be added or dropped. Grouping is not supported for this parameter. Valid values are

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

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

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

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

<condtype> Identifies the type of event, condition or alarm indication being reported or the type of event for which a notification attribute is being changed.

<connst> Connection state of a data wire CP.The valid values are:

� AD - add drop� PT - pass-through� NC - not connected

<conttype> The type of external control. Valid values follow the form MISC-<num> where <num> is a number within the range of 1- 8.

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






<dataprot> Specifies the data protocol for a GRDM-based facility. The valid values are:� GBE - Gigabit Ethernet� FC - Fibre Channel� FICON - FICON

<dcmlist> Specifies the list of DCMs in the DCH box. It is a list of DCM aids connected by '&'.

<dcmtype> DCM TYPE:� A10� A20� A30� A40� A50� A60� A70� A80� A90� LF20� LF30� LF40� LF60� LF80� LF100� LF120� LF150

<dir> The direction of the ENUT traffic. Valid values are:� EAST� WEST

<dirn> Specifies the direction associated with particular information (action to perform, information requested, information reported, etc.)The valid values:

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






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

� Y = Editing is allowed.� N = Editing is disabled.

<enableais> Is a boolean value which indicates whether to enable section trace mismatch detection.

<enablepath> Is a boolean value which indicates whether to enable path trace mismatch detection.

<endts> The end timeslot of the unswitched traffic to be provisioned. A valid timeslot value (integer).

<enuttype> The type of ENUT traffic. Valid values are:� 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.






<eqptype> The type of CP installed in a slot.Possible values are:

� 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> Expected input power in dBm. Valid values are: -25 to 12.

<extpad> Indicates the loss insertion for the attached DCM (floating point number).

<expsectr> Expected section trace value. This is expected value for the section trace J0/C1 bit. Default is 1.

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






<faultpropmode> Fault Propagation Mode (Applicable only for the GBE, FC, FICON, and ESCON facilities.). The valid values for FC, FICON, and ESCON are:

� SHUTLASEROFF� INSERTNOS� INSERTK30.7

Valid values for GBE are� SHUTLASEROFF � INSERTNOS � INSERTK30.7� DSHUTLASEROFF � DINSERTK30.7

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:

� 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:� T1ESF T1 Extended Superframe format.� T1SF T1 Superframe format� E1U E1 unframed� E1F E1 framed

<fromband> The band of the from-side circuit pack (all band BWDM).

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

<gainmode> Gain settings for VGA type CPs. For non-VGA CPs this parameter is ignored. Valid value are (fixed |optimal).






<gap> Group access privilegesNon-confidential identifier that uniquely determines a group�s access privileges. Each group can have zero or more access privileges. A value of ALL specifies all group privileges.

<gdcrn> The group Description. 64 alphanumeric characters. The text is inclosed with escape quotes.

<gfnm> The group Full Name. 64 alphanumeric characters. The text is inclosed with escape quotes.

<gid> Group identifierNon-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.

<grdmtype> GRDM CP type� 850nm� 1310nm

<histbuf> The size of the history buffer. Valid values are:� 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.

<insert> The state of the insert and overwrite mode. Valid values are:� Y = Insert mode enabled. Overwrite mode disabled.� N = Insert mode disabled. Overwrite mode enabled.

<instance> An instance name of the entity in the NE.

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

<ipaddr> IP Address. The format is in standard dotted decimal format (for example, 127.0.0.1).

<linecde> The T1/E1 line encoding� 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:

� UNSWITCHED� SWITCHED






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

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

� LINE: Line side loopback � TRIB: Tributary side loopback � FACILITY: Both line and tributary loopback � NOLPBK No loopback

<maxoutp> Indicates the maximum output power for a port (floating point number).

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

� MACHINE = The human mode is never triggered. Terminal characteristics can only be modified for the session by using the ED-TRMNL-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.






<monlev> Specifies the discriminating level for the requested monitored parameter. Theformat for <monlev> is LEV-DIRN, where valid values for LEV are decimalnumerals, and valid values for DIRN are as follows:

� 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 beused with this parameter.

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

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

<muxtype> Specifies if the external interface is connected to a BWDM or CWDM circuit pack.

� BWDM - The external interface is connected to a BWDM circuit pack.� CWDM - The external interface is connected to a CWDM circuit pack.

<nettype> The network element type. Valid values for <netype> are as follows:� 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






<newgid> The new Group Identifier used when renaming (editing) a group. It is a 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.

<ntfcncde> See Notification Codes (ntfcncde) on page 4-2.

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

<nodeid> An integer indicating a unique identifier for a node in an overlay ring. Valid node IDs are 0-15.

<nodestatus> An indication of the state of the node in an overlay ring. Possible values are:� UNPROVISIONED� IDLE� SWITCHING� PASSTHROUGH� ISOLATED � UNKNOWN

<numports> Indicates the number of ports supported by a CP. Valid values are:� 4� 8

<oldgid> The old Group Identifier used when renaming (editing) a group. It is a 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.

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

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

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






<ohmode> Specifies the overhead processing mode. Valid values are:

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

<outsectr> Transmit (outgoing) section trace value. This is the output value for the section trace J0/C1 bit.

<owdccbytemode> The mode in which the E1/F1/D1-D3 section overhead bytes are transmitted. Valid values are:

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

� AUTOCFG - FEC codes along the circuit are set by the autoconfiguration algorithm.

� ALLOFF - Forces all FEC coders to be turned off for the circuit.

<pathtrtp> Type of protocol to use in path trace overhead. Valid values are:� SONET� SDH

<payload> Associated payload rate. Valid values are:� STS1 STS-1 Facility� STS3C STS-3C Facility� STS12C STS-12C Facility

<ph> Phase, specifies the degree of thoroughness of the system initialization. Valid values are:

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

<pmctl> Specifies whether PM monitoring is enabled or disabled.� ENABLED - PM monitoring is enabled.� DISABLED - PM monitoring is disabled.






<pmmtype> Specifies whether the PMM type. Valid values are:� MPT Mux pass-through� BPT Band pass-through

<pmode> Specifies the protection mode of a BWDM CP. � PRI - The unit is the primary (protected) unit.� BKUP - The unit is the backup (protecting) unit.

The BKUP is only allowed in twoFiberOmsOSPR configurations

<probcause> See Probable Causes for Condition Types on page 5-4 for a complete listing of probable causes.

<prottype> Specifies the protection type. Grouping is not supported for this parameter. Valid values:

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

� 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

For input, grouping is not supported for this parameter and valid values are:� IS In service.� MA The entity is out of service by management command.

A value of NULL defaults depend on the specified <aidtype>

<pwmask> is the state of the password masking mode. Valid values are:� Y = Password masking mode enabled. Echoed characters in password

fields are masked. � N = Password masking mode disabled. Echoed characters in password

fields are displayed.






<qualifier> is a descriptor for the <probcause>-<ntfcncde> pair and is used to differentiate between pairs that would otherwise be identical. Valid values are:

� NONE none� PROT protecting� SYNC syncFacility� WAVE wavelengthFacitiy� WAVEPROT wavelengthFacitiyProtecting� MULT multiple� ALTDR alternateDrive� LINE lineFacility� NODE node

<recsectr> Received Section Trace Value. This is the actual value received from the section trace for J0/C1 bit.

<reftype> Reference type. Valid values are:� 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 (&).

<ringid> is a string indicating a unique ring id for an overlay ring.

<ringstatus> is an indication of the switching substate of an overlay ring. Possible values are:

� NOBRIDGE� BRIDGE� BRIDGEDSWITCHED� NA

<rr> See CHAPTER 8, FACILITIES AND PROTECTION SWITCHING for the facility rate code.

<rtrtv> Indicates a revertive protection mode. Grouping is not supported for this parameter.Valid values are:

� Y� N






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






<sc> (cont�d) 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.

<sectrtp> Section Trace Type for this facility. Possible values are as follows with the default value being C1:

� C1� SDHJ0

<secttraceC1byte> The C1 1 byte value {1-255}.






<secttraceJ0bytes> The 15 byte string for the SDH J0 section overhead 15 bytes.

<sectrmode> The mode for transmitting section trace values. Valid values are:� SECTIONREGENSection regeneration mode.� PASSSection passthrough mode.

<shelftype> Shelf type. Valid values are:� 19 - 19" shelf� 23 - 23" shelf� 23V - 23" vertical shelf

<side> Specifies the direction in which the facility is originated or terminated on the node. Valid values are:

� W (west)� E (east)

<snid> The session identifier. This value specifies an integer number associated with an active session.

<splitmode> Splitter mode. Valid values are {single | multi}.

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

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






<sst> Secondary service stateThis 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

<sstat> Session status. Possible values are:� 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.

<startts> The start timeslot of the unswitched traffic to be provisioned. A valid timeslot value in integer.






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

� LINEFAIL� OSCFAIL� OSCDEGRADE

<syncpri> The synchronization source priority. Valid values are integers between 1-4, with 1 indicating the highest priority

<syncside> Qualifier for syncsrc selection. Valid values are:� W (west)� E (east)

<syncmode> The synchronization mode for the specified equipment. The valid values are:� FRNG - Free running synchronization mode� FST - Fast start synchronization mode� HLDOVR - Heldover synchronization mode� NORM - Normal synchronization mode

<syncsrc> Valid synchronization references (depending on hardware used) include:� LN Line� P1 � P16 Port number� PRI Primary External Reference� SEC Secondary External Reference� INT Internal Clock






<tgtoutp> Target Output Power in dBm, valid values are from -30 to 12.

<tid> 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 target�s CLI code.The TID is an optional parameter. If omitted, the command is handled by the local node.

<thlev> The current threshold level for the monitored parameter.

<tmap> Transparency mapping. Valid values: � MAP1 = mapping#1 � MAP2 = mapping#2 � NA = not applicable

<tmode> Transparency mode. Valid values:� PART = partialPortTransparency� FULL = fullPortTransparency� NA = not applicable

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

<tmper> The accumulation time period for performance monitoring parameters.Valid values for <tmper> are 15-MIN and 1-DAY.

<toband> The band of the to side circuit pack (for all band BWDM only).

<tocp> The EQPT AID of the to side circuit pack. It also can be a DCM AID if the to side is DCM equipment.

<tranfmt> Specifies transmission format.Valid values are:

� sonet� sdh

<tribtsmode> Specifies the switching mode for the tributary side timeslot of the cross-connect being provisioned. Valid values are

� UNSWITCHED� SWITCHED

<trsptype> Specifies how a WCI transponder functions. Valid values are:� {DYNAMICAD | DUAL | STANDALONEREGEN} for regens,� {PATHSWITCH | STANDALONEUPSR} for UPSR�s,� {SINGLEEAST | SINGLEWEST | STANDALONE} for WCI�s.






<tstype> Type of timeslot. Valid values are: � NUT (only valid for 1+1 protected ports), � DISABLE_SPANSW (only valid for BLSR protected ports),� DISABLE_RINGSW (only valid for BLSR protected ports).

<tterm> Transparency termination. Valid values: � TTTP = Transparency Trail Termination Point.� TCTP = Transparency Connect Termination Point.� NA = not applicable

<udcrn> User Description. 64 alphanumeric characters. The text is inclosed with escape quotes.

<ufnm> The User Full Name. 64 alphanumeric characters. The text is inclosed with escape quotes.

<uid> The user identifier. This is a non-confidential identifier that uniquely determines a user (such as the user�s login ID). This parameter is the key for each record in this view. Each user must have a unique UID.

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

<vgatype> Postamp and preamp CP typeValid values are:

� non� vga

<vldty> Indicates whether the information for the specified time period wasaccumulated over the entire time period or some portion of the time period. Thefollowing values are supported:

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

<wave> A wavelength indicator of the form: <side>-<band>-<channel>






<wcitype> The type of WCI circuit pack.Valid values are:

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

� {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}

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

<xmtfmt> Transmission formatValid values are:

� sonet� sdh





ONLINETM7000/9000/11000 TL1 CONDITION TYPES5

CHAPTER 5TL1 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 inthe following sections:

� Condtypes on page 5-1� Probable Causes for Condition Types on page 5-4

CONDTYPESConditions that may be seen in ONLINE TL1 response messaging are listed and described in Table 5-1.

Table 5-1. Condition types

Condition Type Description

ACTLPBK Loop back in active position

AIS Alarm Indication Signal detected

AIS-L SONET AIS - Line Alarm Indication Signal detected

AIS-P SONET AIS - Path

ALMCKT Alarm circuit failure

APSB Protection Switch Byte Failure

APSC Protection Switch Channel Failure Code

AU-AIS High Order Path Alarm Indication Signal detected

CLFAN Cooling fan failure

CONTCOM Control communications equipment failure

CONTEQPT Control Equipment (centralized or distributed) failure

DATAFLT Data integrity fault

DMUX Demultiplex

EQPT Critical alarm caused by equipment failure

FAILTORLS Failure to release from protection

FAILTOSW Failure to switch to protection

FRCDWKSWBK Working facility/equipment forced to switch back to working

FRCDWKSWPR Working facility/equipment forced to switch protection unit

FRNGSYNC Free running synchronization mode

FSTSYNC Fast start synchronization mode

GP General purpose (i.e. indication completely described by the other parameters)

HITEMP High temperature



TL1 CONDITION TYPES ONLINETM7000/9000/110005

HLDOVRSYNC Holdover synchronization mode

HP-RFI High Order Path Remote Failure Indication

HP-TIM High Order Trace Identifier Mismatch

INC Incoming failure condition

INT Internal hardware fault or failure

INTERR Error internal to NE Detected

INTSFT Internal software fault or failure

INVLDFREQ Invalid Frequency

LOCKOUTOFPR Lockout of protection

LOCKOUTOFWK Lockout of working

LOF Loss of frame

LOP Loss of pointer

LOS Loss of signal

LOS-D Loss of signal - Demux

LOS-M Loss of signal - Mux

LOWRESOURCE Low System Resource

LPBKFACILITY Facility Loopback

LPBKLINE Line Loopback

MANWKSWBK Manual switch of working facility/equipment back to working

MANWKSWPR Manual switch of working facility/equipment to protection unit

MISC Miscellaneous condition

MON Monitor failure

MS-AIS Multiplex Section Alarm Indication Signal detected

MS-RFI Multiplex Section Remote Failure Indication

MUX Multiplex problem

OG Outgoing failure condition

OOF Out of Frame

PKVOLTAGE Peak Voltage Violation

PLM-P Payload Label Mismatch - STS

POWER Power failure (detected external to NE)

PRCDRERR Procedure error

PROTNA Protection unit not available






PWR Power failure (detected internal to NE)

RCVR Receiver failure

REPLUNITMISS Replaceable equipment/unit is missing

RFI Remote Failure Indication

RFI-L Remote Failure Indication - Line

RFI-P Remote Failure Indication - Path

RNA Resource Not Available

RS-TIM Regenerator Section Trace Identifier Mismatch

SCMMA State Change due to Manual Maintenance Action

SELECTIVERST Node is in Selective Restore

SWTOINT Clock Reference Switching to Internal Clock

SWTOPRI Clock Reference Switching to Primary Sync

SWTOSEC Clock Reference Switching to Secondary Sync

SWTOLN Clock Reference Switching to Line

SWTOP1 � 16 Clock Reference Switching to Port 1 through 16

SYNC Loss of timing on synchronization link

TIM-P SONET Trace identifier message defect - Path

TIM-S SONET Trace identifier message defect - Section

TRMT Transmitter failure

WKGMEM Working memory failure

WKSWBK Working facility/equipment switched back to working

WKSWPR Working facility/equipment switched to protection unit






PROBABLE CAUSES FOR CONDITION TYPESThe mapping from ONLINE probable causes to TL1 Condition Types (<condtype>) is presented in Table 5-2. Where a match does not exist, a much broader matching condition type is chosen. The extra text of theresponse header is used to convey the exact probable causes.

Table 5-2. Mapping Probable Cause to TL1 Condition Types

Probable Cause Condition Type

ais AIS

alarmCardFailure ALMCKT

AU_Ais AU-AIS

AU_LOP AU-LOP

autoSwitch WKSWPR


autoSwitchRelease WKSWBK

autoSwitchReleaseFailed FAILTORLS

berTestRunning GP

CardProvisioningMismatch INTERR

communicationsFailure CONTCOM

configurationError INTERR

coolingFanFailure CLFAN

DCCLinkFailure CONTCOM

diagnosticsFailure48V_bus_A CONTEQPT

diagnosticsFailure48V_bus_B CONTEQPT

diagnosticsFailureADCLoopbackTest CONTEQPT

diagnosticsFailureDevice3270_3110 CONTEQPT

diagnosticsFailureDevice4080 CONTEQPT

diagnosticsFailureDeviceADClm12458 CONTEQPT

diagnosticsFailureDeviceCommonLed CONTEQPT

diagnosticsFailureDeviceDACad8412 CONTEQPT

diagnosticsFailureDeviceDio CONTEQPT

diagnosticsFailureDeviceEDFA CONTEQPT

diagnosticsFailureDeviceEEProm CONTEQPT

diagnosticsFailureDeviceGrdmEpld CONTEQPT

diagnosticsFailureDeviceGrdmPhy CONTEQPT

diagnosticsFailureDeviceGrdmYukon CONTEQPT




diagnosticsFailureDeviceI2c CONTEQPT

diagnosticsFailureDeviceLED CONTEQPT

diagnosticsFailureDeviceLM81 CONTEQPT

diagnosticsFailureDeviceParallel CONTEQPT

diagnosticsFailureDevicePM5347 CONTEQPT

diagnosticsFailureDeviceSigFpga CONTEQPT

diagnosticsFailureDeviceSwitch CONTEQPT

diagnosticsFailureEEPromTest CONTEQPT

diagnosticsFailureEthernet_Cpm0 CONTEQPT

diagnosticsFailureEthernet_Cpm1 CONTEQPT

diagnosticsFailureFPGAProgramFailure CONTEQPT

diagnosticsFailureHDLC_Tests CONTEQPT

diagnosticsFailureOscMRV CONTEQPT

diagnosticsFailureSlotMismatch CONTEQPT

diagnosticsFailureSpiBusTest CONTEQPT

driveMountFailure CONTEQPT

duplicatedSIDsInSubnet PRCDRERR

eastAuditFailure CONTCOM

eastDefaultKByte APSB

eastEnutTableMismatch DATAFLT

eastImproperApsCode APSC

eastInconsistentAPSCode APSC

eastInterfaceSideMismatch DATAFLT

eastNodeIDMismatch APSC

eastProtectionSwitchFailure FAILTOSW

eastRingmapIdMismatch DATAFLT

eastRingmapMismatch DATAFLT

eastSquelchTableMismatch DATAFLT

EDFAFailure CONTEQPT

eepromDataError DATAFLT

ethernetLinkFailureOnBackPlaneA CONTCOM

ethernetLinkFailureOnBackPlaneB CONTCOM






ethernetSwitchError INT

ethernetSwitchFailure CONTEQPT

excessiveDataRate INC

excessiveInputPower INC

excessiveInputPowerOnLinePort INC

excessiveInputPowerOnTribPort INC

exercise SWEX

exerciseFailed SWEX

exerciseSuccess SWEX

ExternalReferenceA SWTOPRI

ExternalReferenceB SWTOSEC

externalReferenceFailedSYNCA SYNC

externalReferenceFailedSYNCB SYNC

fastStart FSTSYNC

forcedSwitch FRCDWKSWPR

forcedSwitchFailed FAILTOSW

forcedSwitchOnLinePort FRCDWKSWPR

forcedSwitchOnTribPort FRCDWKSWPR

forcedSwitchRelease FRCDWKSWBK

forcedSwitchReleaseFailed FAILTORLS

fPGAFailureOnLinePort INT

fPGAFailureOnTribPort INT

fPGAPowerFailureOnLinePort INT

fPGAPowerFailureOnTribPort INT

FPGAProgramFailure INT

freeRun FRNGSYNC

highOrderPathRemoteFailureIndication HP-RFI

highOrderPathTraceIdentifierMismatch HP-TIM

highPeakVoltageViolation PKVOLTAGE

holdover HLDOVRSYNC

HUBOSCMismatch EQPT

indeterminate GP






InternalClock SWTOINT

invalidDataRate INC

invalidDataRateOnLinePort INC

invalidDataRateOnTribPort INC

laserBiasCurrentFailure INT

laserBiasCurrentFailureOnLinePort INT

laserBiasCurrentFailureOnTribPort INT

laserWavelengthLockFailure EQPT

laserWavelengthLockFailureOnLinePort INT

laserWavelengthLockFailureOnTribPort INT

Line SWTOLN

lineAis AIS-L

lineAisOnLinePort AIS-L

lineAisOnTribPort AIS-L

lineRemoteFailureIndication RFI-L

lockout LOCKOUTOFPR

lockoutFailed FAILTOSW

lockoutOfProtection LOCKOUTOFPR

lockoutOfProtectionOnLinePort LOCKOUTOFPR

lockoutOfProtectionOnTribPort LOCKOUTOFPR

lockoutOfWorking LOCKOUTOFWK

lockoutOfWorkingOnLinePort LOCKOUTOFWK

lockoutOfWorkingOnTribPort LOCKOUTOFWK

lockoutRelease LOCKOUTOFWK

lockoutReleaseFailed FAILTORLS

loopback ACTLBPK

loopbackOnLinePort LPBKLINE

loopbackOnTribPort LPBKFACILITY

lossOfClock SYNC

lossOfClockOnLinePort SYNC

lossOfClockOnTribPort SYNC

lossOfFrame LOF






lossOfFrameOnLinePort LOF

lossOfFrameOnTribPort LOF

lossOfSignal LOS

lossOfSignalDemux LOS-D

lossOfSignalMux LOS-M

lossOfSignalOLMLine LOS

lossOfSignalOLMNode LOS

lossOfSignalOnLinePort LOS

lossOfSignalOnTribPort LOS

lossOfSignalOSMLine LOS

lossOfSignalOSMNode LOS

lossOfSignalPMM LOS

lossOfSignalPostamp LOS

lossOfSignalPostVGA LOS

lossOfSignalPreamp LOS

lossOfSignalPreVGA LOS

lossOfSignalWPS LOS

lossOfSync SYNC

lossValuesOutOfRange INT

lowPeakVoltageViolation PKVOLTAGE

lowSystemResourceDiskSpace WKGMEM

lowSystemResourceHandle WKGMEM

lowSystemResourceMemory WKGMEM

manualSwitch MANWKSWPR

manualSwitchFailed FAILTOSW

manualSwitchOnLinePort MANWKSWPR

manualSwitchOnTribPort MANWKSWPR

manualSwitchRelease MANWKSWBK

manualSwitchReleaseFailed FAILTORLS

memoryMismatch INTERR

multiplexSectionAis MS-AIS

multiplexSectionRemoteFailureIndication MS-RFI






nodeInHitlessState DATAFLT

nodeInSelectiveRestore SELECTIVERST

ntpServerNotAvailable RNA

OchAisOnLinePort AIS-L

OchLOFOnLinePort LOF

oDPRProtectionUnavailable PROTNA

oosDiagnosticsPerformed CONTEQPT

opticalSwitchFailure CONTEQPT

osc4080DeviceFailure CONTEQPT

oSPRProtectionUnavailable PROTNA

outOfFrame OOF

pathAis AIS-P

pathLossOfPointer LOP-P

pathRemoteFailureIndication RFI-P

pathTraceIdentifierMismatch TIM-P

payloadMappingFailure PLM-P

peerCommunicationsFailure CONTCOM

planeAcommunicationsFailure CONTCOM

planeBcommunicationsFailure CONTCOM

PMAIsLocked SCMMA

Port1 SWTOP1

Port2 SWTOP2

Port3 SWTOP3

Port4 SWTOP4

Port5 SWTOP5

Port6 SWTOP6

Port7 SWTOP7

Port8 SWTOP8

Port9 SWTOP9

Port10 SWTOP10

Port11 SWTOP11

Port12 SWTOP12






Port13 SWTOP13

Port14 SWTOP14

Port15 SWTOP15

Port16 SWTOP16

powerAcoCardFailure ALMCKT

powerEntryFailure POWER

powerManagementProblem INTERR

powerProblem PWR

processorBusy GP

programMemoryFailure WKGMEM

programMemoryMissing WKGMEM

protectionPathFailure INT

pumpLaserTemperatureOutOfRange HITEMP

receiverFailure RCVR

receiverFailureOnLinePort RCVR

receiverFailureOnTribPort RCVR

referenceFailed SYNC

referenceOutOfRange SYNC

regeneratorSectionTraceIdentifierMismatch RS-TIM

regeneratorSectionTraceIdentifierMismatchOnLinePort RS-TIM

regeneratorSectionTraceIdentifierMismatchOnTribPort RS-TIM

remoteFailureIndication RFI

replaceableUnitMissing REPLUNITMISS

replaceableUnitProblem EQPT

replaceableUnitTypeMismatch EQPT

sectionTraceIdentifierMismatch TIM-S

sectionTraceIdentifierMismatchOnLinePort TIM-S

sectionTraceIdentifierMismatchOnTribPort TIM-S

shelfIdMismatch EQPT

shelfInterconnectFailure CONTCOM

shelfTypeMismatch INTERR

signalDegradeBER INC






signalDegradeBEROnLinePort INC

signalDegradeBEROnTribPort INC

signalFailBER INC

signalFailBEROnLinePort INC

signalFailBEROnTribPort INC

signalFrequencyInvalid INVLDFREQ

signalingFailure INTERR

signalSquelched OG

signalSquelchedOnLinePort OG

signalSquelchedOnTribPort OG

softwareDownloadFailure INTERR

softwareEnvironmentProblem INTSFT

storageCapacityProblem INTERR

synchronizationFailure SYNC

temperatureOutOfRange HITEMP

temperatureSensorFailure MON

thresholdCrossed GP

thresholdCrossedLBCOnLinePort T-LBCN

thresholdCrossedLBCOnTribPort T-LBCN

thresholdCrossedOPR T-OPR

thresholdCrossedOPROnLinePort T-OPR

thresholdCrossedOPROnTribPort T-OPR

thresholdCrossedOPT T-OPT

thresholdCrossedOPTOnLinePort T-OPT

thresholdCrossedOPTOnTribPort T-OPT

thresholdNMCrossedCRC T-CRC

thresholdNMCrossedCV_L T-CVL

thresholdNMCrossedCV_LOnLinePort T-CVL

thresholdNMCrossedCV_LOnTribPort T-CVL

thresholdNMCrossedCV_P T-CVP

thresholdNMCrossedCV_S T-CVS

thresholdNMCrossedCV_SOnLinePort T-CVS






thresholdNMCrossedCV_SOnTribPort T-CVS

thresholdNMCrossedCVs T-CV

thresholdNMCrossedCVs_ch1 T-CV-CH1

thresholdNMCrossedCVs_ch2 T-CV-CH2

thresholdNMCrossedCVs_EMX_IN T-CV

thresholdNMCrossedCVs_EMX_OUT T-CV

thresholdNMCrossedCVsOnLinePort T-CV

thresholdNMCrossedCVsOnTribPort T-CV

thresholdNMCrossedES_L T-ESL

thresholdNMCrossedES_LOnLinePort T-ESL

thresholdNMCrossedES_LOnTribPort T-ESL

thresholdNMCrossedES_P T-ESP

thresholdNMCrossedES_S T-ESS

thresholdNMCrossedES_SOnLinePort T-ESS

thresholdNMCrossedES_SOnTribPort T-ESS

thresholdNMCrossedFC_L T-FCL

thresholdNMCrossedFC_LOnLinePort T-FCL

thresholdNMCrossedFC_LOnTribPort T-FCL

thresholdNMCrossedFC_P T-FCP

thresholdNMCrossedFCS T-FCS

thresholdNMCrossedFE T-FRER

thresholdNMCrossedFE_FCS T-FCS-FE

thresholdNMCrossedGbE_CRC_IN T-CRC

thresholdNMCrossedGbE_CRC_OUT T-CRC

thresholdNMCrossedGbE_DE T-DE

thresholdNMCrossedGbE_FRAGS_IN T-FRG

thresholdNMCrossedGbE_FRAGS_OUT T-FRG

thresholdNMCrossedGbE_JABBER_IN T-JBR

thresholdNMCrossedGbE_JABBER_OUT T-JBR

thresholdNMCrossedGbE_LOCS T-LOCS

thresholdNMCrossedGbE_LOCSOnLinePort T-LOCS

thresholdNMCrossedGbE_LOCSOnTribPort T-LOCS






thresholdNMCrossedMS_BBE T-BBEM

thresholdNMCrossedMS_EB T-EBM

thresholdNMCrossedMS_ES T-ESM

thresholdNMCrossedMS_FC T-FCM

thresholdNMCrossedMS_SES T-SESM

thresholdNMCrossedMS_UAS T-UASM

thresholdNMCrossedPath_BBE T-BBEAU

thresholdNMCrossedPath_EB T-EBAU

thresholdNMCrossedPath_ES T-ESAU

thresholdNMCrossedPath_FC T-FCAU

thresholdNMCrossedPath_SES T-SESAU

thresholdNMCrossedPath_UAS T-UASAU

thresholdNMCrossedRS_BBE T-BBER

thresholdNMCrossedRS_EB T-EBR

thresholdNMCrossedRS_ES T-ESR

thresholdNMCrossedRS_SEFS T-SEFSR

thresholdNMCrossedRS_SES T-SESR

thresholdNMCrossedSEFS_S T-SEFSS

thresholdNMCrossedSEFS_SOnLinePort T-SEFSS

thresholdNMCrossedSEFS_SOnTribPort T-SEFSS

thresholdNMCrossedSES_L T-SESL

thresholdNMCrossedSES_LOnLinePort T-SESL

thresholdNMCrossedSES_LOnTribPort T-SESL

thresholdNMCrossedSES_P T-SESP

thresholdNMCrossedSES_S T-SESS

thresholdNMCrossedSES_SOnLinePort T-SESS

thresholdNMCrossedSES_SOnTribPort T-SESS

thresholdNMCrossedTCBEOnLinePort T-TCBE

thresholdNMCrossedTCBEOnTribPort T-TCBE

thresholdNMCrossedUAS_L T-UASL

thresholdNMCrossedUAS_LOnLinePort T-UASL

thresholdNMCrossedUAS_LOnTribPort T-UASL






thresholdNMCrossedUAS_P T-UASP

thresholdNMCrossedUCBEOnLinePort T-UCBE

thresholdNMCrossedUCBEOnTribPort T-UCBE

topologyDiscovering DATAFLT

topologyMismatch DATAFLT

trailTraceMismatch INTERR

transmitFail TRMT

transmitterFailure TRMT

transmitterFailureOnLinePort TRMT

transmitterFailureOnTribPort TRMT

transmitterFailurePostVGA TRMT

transmitterFailurePreVGA TRMT

tribOpticalPowerMonitoringNotSupported MON

underlyingResourceUnavailable EQPT

unsupportedPayloadType PLM-P

userAlarm1 MISC

userAlarm2 MISC

userAlarm3 MISC

userAlarm4 MISC

userAlarm5 MISC

userAlarm6 MISC

userAlarm7 MISC

userAlarm8 MISC

userAlarm9 MISC

userAlarm10 MISC

userAlarm11 MISC

userAlarm12 MISC

voaFailure CONTEQPT

voaFailureDemux DMUX

voaFailureMux MUX

voaMotorMissingSteps CONTEQPT

voaMotorMissingStepsDemux DMUX






voaMotorMissingStepsMux MUX

voaMotorNotStepping CONTEQPT

voaMotorNotSteppingDemux DMUX

voaMotorNotSteppingMux MUX

voaPotFailure CONTEQPT

voaPotFailureDemux DMUX

voaPotFailureMux MUX

wavelengthManagementUnavailable INTERR

westAuditFailure CONTCOM

westDefaultKByte APSB

westEnutTableMismatch DATAFLT

westImproperApsCode APSC

westInconsistentAPSCode APSC

westInterfaceSideMismatch DATAFLT

westNodeIDMismatch APSC

westProtectionSwitchFailure FAILTOSW

westRingmapIdMismatch DATAFLT

westRingmapMismatch DATAFLT

westSquelchTableMismatch DATAFLT





ONLINETM7000/9000/11000 TL1 MONITOR TYPES6

CHAPTER 6TL1 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

MonitorType Description Current

IntervalHistory

IntervalsTCA

EventTCA

Alarm

BBE-MS Background Block Error � Multiplex Section X X X X

BBE-RS Background Block Error � Regenerator Section X X X X

BBE-AU Background Block Error - Path X X X X

BBER-MS Background Block Error Ratio � Multiplex Section X X

BBER-RS Background Block Error Ratio � Regenerator Section

X X

BBER-AU Background Block Error Ratio - SDH Path X X

BCST Broadcast count X X

BYT Byte count X X

CRC CRC count X X X X

CV Coding Violation count X X X X

CV-CH1 Coding Violation count GBE Channel 1 X X X X

CV-CH2 Coding Violation count GBE Channel 2 X X X X

CVL Coding Violation count - Line X X X X

CVP Coding Violation count - Path X X X X

CVS Coding Violation count - Section X X X X

DE Disparity Errors X X X X

EB-MS Errored Block � Multiplex Section X X X X

EB-RS Errored Block � Regenerator Section X X X X

EB-AU Errored Block - SDH Path X X X X

ES-AU Errored Second count - SDH Path X X X X

ES-L Errored Second count - Line X X X X

ES-MS Errored Second � Multiplex Section X X X X

ES-P Errored Second count � Path X X X X

ES-RS Errored Second � Regenerator Section X X X X

ESR-AU Errored Second Ratio - SDH Path X X

ESR-MS Errored Second Ratio � Multiplex Section X X



TL1 MONITOR TYPES ONLINETM7000/9000/110006

ESR-RS Errored Second Ratio � Regenerator Section X X

ESR-P Errored Second Ratio - Path X X

ES-S Errored Second count � Section X X X X

FC-AU Failure Count - SDH Path X X X X

FC-L Failure Count - Line Near End X X X X

FC-MS Failure Count � Multiplex Section X X X X

FC-P Failure Count � Path Near End X X X X

FCS Frame Check Sequence - Near End X X X X

FCS-FE Frame Check Sequence - Far End X X X X

FE Framing Error X X X X

FRG Fragment count X X X X

FRM Frame count X X

GIA Giant count X X

JBR Jabber count X X X X

LBC Normalized Laser Bias Current X X

LOCS Loss of synchronization count (Synchronization Errors)

X X X X

MCST Multicast count X X

OPR Optical Power Received level X X

OPT Optical Power Transmission level X X

P64 Packet 64 count (Packet size of 64 bytes or less) X X

P127 Packet 127 count (Packet size of 65 to 127 bytes) X X



P1023 Packet 1023 count (Packet size of 512 to 1023 bytes)

X X

P1518 Packet 1518 count (Packet size of 1024 to 1518 bytes)

X X

PSC Protection Switching Count X X

PV Protocol Violation X X

RNT Runt count X X

SEFSR Severely Errored Framing Second count � Regenerator Section

X X X X

Table 6-1. Monitor Types (Continued)


IntervalHistory

IntervalsTCA

EventTCA

Alarm



ONLINETM7000/9000/11000 TL1 MONITOR TYPES6

SEFS-S Severely Errored Framing Second count � Section X X X X

SES-AU Severe Errored Second count - SDH Path X X X X

SES-L Severe Errored Second count - Line X X X X

SES-MS Severe Errored Second count � Multiplex Section X X X X

SES-P Severe Errored Second count - Path X X X X

SESR Severe Errored Second Ratio X X X X

SESR-AU Severe Errored Second count - SDH Path X X

SESR-MS Severe Errored Second Ratio � Multiplex Section X X

SESR-RS Severe Errored Second Ratio � Regenerator Section

X X

SESR-P Severe Errored Second Ratio - Path X X

SES-S Severe Errored Second count - Section X X X X

SLOSS Synchronization Loss X X X X

TCBE Total Corrected Bit Errors X X X X

UCBE UnCorrected Bit Errors X X X X

UAS-AU Unavailable Second Count - SDH Path X X X X

UAS-L Unavailable Second Count - Line/Layer X X X X

UAS-MS Unavailable Second Count � Multiplex Section X X X X

UAS-P Unavailable Second Count - Path X X X X

Table 6-1. Monitor Types (Continued)


IntervalHistory

IntervalsTCA

EventTCA

Alarm



TL1 MONITOR TYPES ONLINETM7000/9000/110006




ONLINETM7000/9000/11000 GROUP ACCESS PRIVILEGES7

CHAPTER 7GROUP 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 addAMP addBandPassThru

addBWDM addChannelPassThru addCWDM

addDCM addESCON addGRDM

addGroup addPMM addPrivileges

addShelf addSID addSTMX

addSYNC addUsers addWCI

administrator assignASAP backupNE

changeGroup changeGroupLabel changeNEState

changeOwner changePassword changeUserMessaging

circuitProtectionSetup circuitProtectionSwitch cliAll

cliScript cliSession clockSyncOperation

commitSecurityUpdate configureDCC createCircuit

createUser deactivateUser deleteAccessControlList

deleteAMP deleteBandPassThru deleteBWDM

deleteChannelPassThru deleteCircuit deleteCWDM

deleteDCM deleteESCON deleteGRDM

deleteGroup deletePMM deleteShelf

deleteSID deleteSTMX deleteSYNC

deleteUser deleteWCI equipmentProtectionSwitch

fecConfigType findCircuits getAccessControlList

getAccessControlLists getAllGroupLabels getGroupLabelFromUser

getInventoryList getIpServiceInfo getIpServiceNameList

getPrivilegesInGroup getUsersActivityStatuses getUsersGroupLabels

getUsersGroupNames getUsersInGroup getUsersPrivileges

initDatawire initializePMRegisters lockAndUnlock

lockAndUnlockPMA loopBack LOSThresholdSetting

modifyAttributes modifyCircuit modifyDatawire

modifyDayThresholdData modifyPrivilegesInGroup modifyThresholdData

PMAlarmSetup PMDayTCASetup PMTCASetup



GROUP ACCESS PRIVILEGES ONLINETM7000/9000/110007

portProvision PowerManager protectionSwitchSetup

provisionAMP provisionPMM provisionSID

provisionSTMX provisionSYNC removePrivileges

removeUsers renameNE resetCard

resetNEDB restoreNE ringProtectionSwitch

runDiagnostics setAccessControlList setBERThreshold

setCraftEnabled setLanEnabled setLineSideFiberTypes

setNEAttributes setNETime setOpticalConfiguration

setPadList setSpanLoss setSubnetworkMap

snmp softwareDownload sonetADMView

syslog tcPassThrough timingProtectionSwitch

tl1 troubleShooting unprovisionSTMX

userAlarmOutputs userAlarmsInfo userLoginControl

viewUser viewUserActivateStatus WCIOverheadProvisioning

Table 7-1. Group Access Privileges (Continued)



FACILITIES ANDONLINETM7000/9000/11000 PROTECTION SWITCHING

8

CHAPTER 8FACILITIES AND PROTECTION SWITCHING

This chapter includes reference tables for:� Supported Facilities on page 8-1� Protection Switching Support on page 8-2

SUPPORTED FACILITIESThis section identifies the supported facilities defined for the <rr> parameter (Table 8-1).

Table 8-1. Supported Facilities

Facility Definition

OB Optical Band Section Facility

OT Optical Transport Facility

OCH Optical Channel Facility

DW Datawire Facility

GBE Gigabit Ethernet Facility

ESCON ESCON Facility

FC Fibre Channel Facility

FICON FICON Facility

OC3 SONET OC-3 Facility




STM1 SDH STM-1 Facility



STM 64 SDH STM-64 Facility

STS1 STS-1 Facility

STS3C STS-3C Facility



AU4 AU4 Facility

AU44C AU44C Facility



FACILITIES ANDPROTECTION SWITCHING ONLINETM7000/9000/110008

PROTECTION SWITCHING SUPPORT Table 8-2 summarizes the facility protection provisioning commands supported by the ONLINE� TransportSystem.

Table 8-2. Facility Protection Switching Support

Protection <rr> ENT ED DLT RTRV

BLSR Ring OT NA X (wtr and swon) NA X (wtr and swon)

BLSR Equipment COM NA NA NA X (wtr and rvtv)

UPSR Path OCH NA X (wtr and rvtv) NA X (wtr and rvtv)

SONET UPSR STS1, STS3C, STS12C NA X (wtr and rvtv) NA X (wtr and rvtv)

SONET O-UPSR OC3, OC12, OC48, OC192 STM1, STM4, STM16, STM64

X X (wtr and rvtv) X X (wtr and rvtv)

SONET 1 + 1 APS

OC3, OC12, OC48, OC192 STM1, STM4, STM16, STM64

X X (wtr and rvtv) X X (wtr and rvtv)



ONLINETM7000/9000/11000 INDEX I

INDEX

A

Access Identifiers (AIDs) 1-16accessing TL1 1-4Alarm Types mapping 5-1Autonomous Messages

Report Environment Alarm 2-4

C

CommandsEdit password 3-12Login 3-4Logout 3-9Retrieve All Alarms 3-46Retrieve Environmental Alarms 3-49Retrieve header 3-178

E

Edit password command 3-12

L

Login command 3-4Logout command 3-9

M

Machine Mode 1-9

N

Notification codes 4-1

R

Report Environment Alarm 2-4Retrieve All Alarms command 3-46Retrieve Environmental Alarms command 3-49Retrieve header command 3-178

S

Session security (ACT-USER) 1-5

T

telnet 1-4TL1

Alarm Types mapping 5-1Command Format 1-11Commands 3-2Notification codes 4-1Response Format 1-14

U

UNASGN-ASAP 3-42Upgrading from previous versions (RTRV-CKT) 3-

154

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 I-1


INDEX ONLINETM7000/9000/11000I



I-2 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY

ONLINETM7000/9000/11000 COMMANDS/CODES INDEX I

COMMANDS/CODES INDEX

AACT-PRIV-SECU 3-3ACT-USER 3-4ALW-MSG 3-38ALW-USER-SECU 3-5

CCANC-PRIV-SECU 3-6CANC-SESSION 3-7CANC-SESSION-SECU 3-8CANC-USER 3-9

DDLT-{OC3|OC12|STM1|STM4} 3-94DLT-ASAP 3-41DLT-CKT 3-95DLT-CRS- 3-96DLT-EQPT 3-97DLT-EXTIF 3-98DLT-FFP 3-99DLT-GROUP-SECU 3-10DLT-PASS 3-100DLT-SBR 3-101DLT-SYNCN 3-103DLT-TRAIL 3-104DLT-UNSWTS 3-105DLT-USER-SECU 3-11DLT-VLAN 3-106

EED-{OC3 | OC12 | OC48 | STM1 | STM4 |STM16} 3-107ED-ASAP 3-42ED-CKT 3-110ED-DAT 3-112ED-DW 3-114ED-EQPT 3-116ED-EXTIF 3-118ED-FFP 3-119ED-GROUP-SECU 3-13ED-PID 3-12ED-SBR 3-120ED-SNE 3-121

ED-SYNCN 3-122ED-TRMNL-DFLT 3-31ED-TRMNL-SES 3-32ED-USER-SECU 3-15ENT- {OC3 | OC12 | STM1 | STM4} 3-124ENT-ASAP 3-43ENT-CKT 3-126ENT-CRS- 3-128ENT-EQPT 3-130ENT-EXTIF 3-135ENT-FFP 3-136ENT-GROUP-SECU 3-17ENT-RNGMAP-VNODE 3-139ENT-SBR 3-140ENT-TRAIL 3-142ENT-UNSWTS 3-143ENT-USER-SECU 3-19ENT-VLAN 3-144errcde 4-1EX-SW 3-62

IINH-MSG 3-44INH-USER-SECU 3-21INIT-REG 3-79

Nntfcncde 4-2

OOPR-PROTNSW 3-69

RRD-SYNCN 3-148REPT-ALM 2-2REPT-EVT 2-6REPT-PM 2-9REPT-RMV 2-11REPT-RST 2-12RLS-EXT-CONT 3-73RLS-PROTNSW 3-74RMV- { } 3-152RST- { } 3-153RTRV-ALM 3-46RTRV-ALM-ENV 3-49

TL1 Administration and Reference ManualApril 30, 2003 - Revision A009-2003-080 I-3


COMMANDS/CODES INDEX ONLINETM7000/9000/11000I

RTRV-ASAP 3-51RTRV-CKTINFO-{OCH | | Gbe | FC | FICON| EQPT} 3-156RTRV-CKTINFO-CKT 3-158RTRV-COND 3-53RTRV-COND-SYNCN 3-55RTRV-CRS- 3-160RTRV-DFLT-ASAP 3-57RTRV-EQPT 3-162RTRV-EXT-CONT 3-76RTRV-EXTIF 3-166RTRV-FAC- 3-167RTRV-FAC-{|ALL|PMM|LINK} 3-167RTRV-FAC-ALL 3-167RTRV-FFP 3-176RTRV-FIBER-EQPT 3-174RTRV-GROUP-SECU 3-22RTRV-HDR 3-178RTRV-NETYPE 3-179RTRV-PASS 3-180RTRV-PM 3-80RTRV-PMCTL 3-83RTRV-PRIV-SECU 3-24RTRV-RNGMAP-VNODE 3-182RTRV-ROUTEMAP 3-183RTRV-SBR 3-186RTRV-SESSION 3-26RTRV-SESSION-SECU 3-27RTRV-SIDTABLE 3-188RTRV-SNE 3-189RTRV-SQLCHTBL-VNODE 3-185RTRV-SWVER-COM 3-191RTRV-SWVER-EQPT 3-192RTRV-TH 3-85RTRV-TRAIL 3-194RTRV-TRMNL-DFLT 3-33RTRV-UNSWTS 3-195RTRV-USER-SECU 3-29RTRV-VLAN 3-196

SSCHED-PMREPT 3-87SET-ASAP-{ } 3-58SET-ATTR-SECUDFLT 3-35SET-NE-ALL 3-58

SET-PMCTL 3-89SET-SESSION 3-36SET-SID 3-198SET-SYNCN 3-199SET-TH 3-90


I-4 009-2003-080CIENA® CONFIDENTIAL AND PROPRIETARY