Preface

Preface

This section explains the objectives, intended audience, and organization of this publication and describes the conventions that convey instructions and other information.

This section provides the following information:

Revision History

Date
Notes

June 2010

Updated the input example and input parameters for the ENT-LNK command in the chapter ENT Commands.

July 2010
  • Updated the “RTRV-AUDIT-LOG” command in the chapter “RTRV Commands”.
  • Updated the input parameter for the INIT-SYS command in the chapter INIT Commands.

August 2010

Updated the input parameter for the RTRV-NE-IMGSIGN and RTRV-NE-KEYINFO commands in the chapter “RTRV Commands”.

September 2010

Updated the table “RFILE” in the chapter “Access Identifiers”.

October 2010
  • Updated the table “SHELF” in the chapter “Access Identifiers”.
  • Updated the “Usage Guidelines” section for “RTRV-PMMODE-<VC_PATH>” and “SET-PMMODE-<VC_PATH>” commands.

February 2011
  • Updated the content for “LINE” in the chapter “Access Identifiers”
  • Updated the content for “LINELW” in the chapter “Access Identifiers”

April 2011
  • Added the output parameter description for the “RTRV-NE-GEN” command in the chapter, RTRV Commands.
  • Updated the input parameter description for the ED-<OCN_TYPE> command in the chapter, ED Commands.

May 2011
  • Updated the output parameter description for the RTRV-<OCN_TYPE> command in the chapter, RTRV Commands.
  • Updated the “CTC Port Numbers and TL1 Aids” table in the chapter, “Access Identifiers”.

July 2011

Updated the description for RFILE-DB in “RFILE” section in the chapter, “Access Identifiers”

September 2011
  • Added a note to RTRV-PM-<MOD2> section.
  • Modified “Mode” description in ED-<OCN_TYPE> section.

October 2011

Updated “5Gbps InfiniBand payload” to “5Gbps InfiniBand (IB_5G) payload” in the chapter, “RTRV Commands”.

February 2012
  • Removed “MDLTFMT” parameter from the ED-OCH command in the chapter “ED Commands”.
  • Removed “MDLTFMT” parameter from the RTRV-OCH command in the chapter “RTRV Commands”.
  • Added “MS-ISC-100T” parameter to the ENT-EQPT command and removed “XCVXC-2.5G” parameter from the ENT-EQPT command in the chapter “ENT Commands”.

March 2012

Added Facility AID for CE1000 cards in the chapter “Access Identifiers”.

August 2012

The full length book-PDF was generated.

October 2012

Updated the input example for the ED-<MOD1FCPAYLOAD> command in the chapter, ED Commands.

December 2012

Updated the ENT-RMONTH-<MOD2> command in the chapter, “ENT Commands” and RTRV-RMONTH-<MOD2> command in the chapter “RTRV Commands”.

February 2013
  • Updated the section, “ENT-LNKTERM” in the chapter “ENT Commands”.
  • Added a new section “Important Notes about TL1 Commands” in the “Preface” chapter.
  • Added “BIT-EC” counter in the output parameters table for “MONTYPE” parameter in the chapters “INIT Commands”, “RTRV Commands”, and “SET Commands”.

March 2013

Updated the input example for the OPR-SLV-WDMANS command in the chapter, OPR Commands.

May 2013

Updated the input example for the RTRV-NE-IMGSIGN command in the chapter, RTRV Commands.

June 2013

Updated the input example for the RTRV-NE-KEYINFO command in the chapter, RTRV Commands.

July 2013

Updated the allowable range of POLD and PDIF parameters for the RTRV-DFLT-SECU command in the chapter, RTRV Commands.

November 2013
  • Updated the “Important Notes about TL1 Commands” section in the “Preface” chapter.
  • Updated the “Usage Guidelines” section for “ED-PROTOCOL” command in the chapter, ED Commands.
  • Updated the input parameter description for the ENT-EQPT command in the chapter, ENT Commands.
  • Updated the “PRS” parameter description in the chapters, “ED Commands” and “RTRV Commands”.
  • Updated the “SYNCMSG” and “SENDDUS” parameter descriptions in the chapters, “ED Commands” and “RTRV Commands”.

January 2014

Updated the “PST” and “SST” parameter descriptions for the “ED-<GIGE_TYPE>” command in the chapter, “ED Commands”.

April 2014

The full length book-PDF was generated.

Document Objectives

This guide explains the use of Transaction Language 1 (TL1) for the Cisco ONS 15310-MA, Cisco ONS 15454, Cisco ONS 15454 M2, and Cisco ONS 15454 M6 systems. Use this guide in conjunction with the appropriate publications listed in the Related Documentation section.

Audience

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

Important Notes about TL1 Commands

TL1 commands can be executed manually or through the use of scripts.

When commands are executed manually, there is a delay of few seconds before the next command can be executed. This gives the Network Elements (NE) sufficient time to perform most of the database (DB) operations.

However, when commands are executed using scripts, the functioning of the NE differs. The NE has insufficient time to perform all the database operations and may cause the NE to malfunction. This in turn causes the controller card to reboot. To prevent this, it is recommended that a delay of 3 to 5 seconds be added between the commands that require DB updates in the script.

User cannot enter question mark (?) as part of input for any parameter. The special character “?” is used in TL1 commands to display help.

Related Documentation

Use this Cisco ONS SONET TL1 Command Guide, R9.2 in conjunction with the following referenced Release 9.2 publications:

  • Cisco ONS SONET TL1 Reference Guide
     Provides general information, procedures, and errors related to using TL1 in the Cisco ONS 15310-MA, Cisco ONS 15454, Cisco ONS 15454 M2, and Cisco ONS 15454 M6.
  • Cisco ONS SONET TL1 Command Quick Reference Guide
     Provides input formats and output formats (where applicable) for all R9.2 TL1 commands and autonomous messages.
  • Cisco ONS SONET TL1 for Beginners
     Provides basic beginning instruction for using TL1.
  • Cisco ONS 15454 Procedure Guide
     Cisco ONS 15310-CL and Cisco ONS 15310-MA Procedure Guide, Release 9.1 and Release 9.2
     Provides procedures and tasks for the corresponding Cisco ONS node and network.
  • Cisco ONS 15454 Reference Manual
     Cisco ONS 15310-CL and Cisco ONS 15310-MA Reference Manual
     Provides reference material for the corresponding Cisco ONS node and network.
  • Cisco ONS 15454 Troubleshooting Guide
     Cisco ONS 15310-CL and Cisco ONS 15310-MA Troubleshooting Guide
     Provides general troubleshooting procedures, alarm descriptions, performance monitoring parameters, and Simple Network Management Protocol (SNMP) parameters for the corresponding Cisco ONS node and network.
  • Cisco ONS 15454 DWDM Procedure Guide
     Explains installation, turn up, provisioning, and maintenance for Cisco ONS 15454 dense wavelength division (DWDM) systems.
  • Cisco ONS 15454 DWDM Reference Manual
     Explains installation, turn up, provisioning, and maintenance for Cisco ONS 15454 dense wavelength division (DWDM) systems.
  • Cisco ONS 15454 DWDM Troubleshooting Guide
     Provides troubleshooting information and troubleshooting-related parameters for the Cisco ONS 15454 (ANSI) and Cisco ONS 15454 SDH (ETSI) platforms, specifically the dense wavelength division multiplexing (DWDM) application that can operate on either platform.
  • Cisco ONS 15454 and Cisco ONS 15454 SDH Ethernet Card Software Feature and Configuration Guide
    Provides software features for all Ethernet cards and configuration information for Cisco IOS on ML-Series cards.
  • Cisco ONS 15310-CL and Cisco ONS 15310-MA Ethernet Card Software Feature and Configuration Guide
    Provides software features and operations of the ML-100T-8 and the CE-100T-8 Ethernet cards for the Cisco ONS 15310-CL and the Cisco ONS 15310-MA.
  • Release Notes for Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6 DWDM, Release 9.2
    Release Notes for Cisco ONS 15454 SONET and SDH, Release 9.2
    Release Notes for Cisco ONS 15310-MA, Release 9.2
    Provides caveats, closed issues, and new feature and functionality information.

For an update on End-of-Life and End-of-Sale notices, refer to http://cisco.com/en/US/products/hw/optical/ps2001/prod_eol_notices_list.html

Document Conventions

This publication uses the following conventions:

 

Convention
Application

[ ]

Keywords or arguments that appear within square brackets are optional.

{ x | x | x }

A choice of keywords (represented by x) appears in braces separated by vertical bars. The user must select one.

Ctrl

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

screen font

Examples of information displayed on the screen.

< >

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

NoteMeansreader take note. Notes contain helpful suggestions or references to material not covered in the document.

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

 

Warning

IMPORTANT SAFETY INSTRUCTIONS

This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device. Statement 1071

SAVE THESE INSTRUCTIONS

Waarschuwing

BELANGRIJKE VEILIGHEIDSINSTRUCTIES

Dit waarschuwingssymbool betekent gevaar. U verkeert in een situatie die lichamelijk letsel kan veroorzaken. Voordat u aan enige apparatuur gaat werken, dient u zich bewust te zijn van de bij elektrische schakelingen betrokken risico's en dient u op de hoogte te zijn van de standaard praktijken om ongelukken te voorkomen. Gebruik het nummer van de verklaring onderaan de waarschuwing als u een vertaling van de waarschuwing die bij het apparaat wordt geleverd, wilt raadplegen.

BEWAAR DEZE INSTRUCTIES

Varoitus

TÄRKEITÄ TURVALLISUUSOHJEITA

Tämä varoitusmerkki merkitsee vaaraa. Tilanne voi aiheuttaa ruumiillisia vammoja. Ennen kuin käsittelet laitteistoa, huomioi sähköpiirien käsittelemiseen liittyvät riskit ja tutustu onnettomuuksien yleisiin ehkäisytapoihin. Turvallisuusvaroitusten käännökset löytyvät laitteen mukana toimitettujen käännettyjen turvallisuusvaroitusten joukosta varoitusten lopussa näkyvien lausuntonumeroiden avulla.

SÄILYTÄ NÄMÄ OHJEET

Attention

IMPORTANTES INFORMATIONS DE SÉCURITÉ

Ce symbole d'avertissement indique un danger. Vous vous trouvez dans une situation pouvant entraîner des blessures ou des dommages corporels. Avant de travailler sur un équipement, soyez conscient des dangers liés aux circuits électriques et familiarisez-vous avec les procédures couramment utilisées pour éviter les accidents. Pour prendre connaissance des traductions des avertissements figurant dans les consignes de sécurité traduites qui accompagnent cet appareil, référez-vous au numéro de l'instruction situé à la fin de chaque avertissement.

CONSERVEZ CES INFORMATIONS

Warnung

WICHTIGE SICHERHEITSHINWEISE

Dieses Warnsymbol bedeutet Gefahr. Sie befinden sich in einer Situation, die zu Verletzungen führen kann. Machen Sie sich vor der Arbeit mit Geräten mit den Gefahren elektrischer Schaltungen und den üblichen Verfahren zur Vorbeugung vor Unfällen vertraut. Suchen Sie mit der am Ende jeder Warnung angegebenen Anweisungsnummer nach der jeweiligen Übersetzung in den übersetzten Sicherheitshinweisen, die zusammen mit diesem Gerät ausgeliefert wurden.

BEWAHREN SIE DIESE HINWEISE GUT AUF.

Avvertenza

IMPORTANTI ISTRUZIONI SULLA SICUREZZA

Questo simbolo di avvertenza indica un pericolo. La situazione potrebbe causare infortuni alle persone. Prima di intervenire su qualsiasi apparecchiatura, occorre essere al corrente dei pericoli relativi ai circuiti elettrici e conoscere le procedure standard per la prevenzione di incidenti. Utilizzare il numero di istruzione presente alla fine di ciascuna avvertenza per individuare le traduzioni delle avvertenze riportate in questo documento.

CONSERVARE QUESTE ISTRUZIONI

Advarsel

VIKTIGE SIKKERHETSINSTRUKSJONER

Dette advarselssymbolet betyr fare. Du er i en situasjon som kan føre til skade på person. Før du begynner å arbeide med noe av utstyret, må du være oppmerksom på farene forbundet med elektriske kretser, og kjenne til standardprosedyrer for å forhindre ulykker. Bruk nummeret i slutten av hver advarsel for å finne oversettelsen i de oversatte sikkerhetsadvarslene som fulgte med denne enheten.

TA VARE PÅ DISSE INSTRUKSJONENE

Aviso

INSTRUÇÕES IMPORTANTES DE SEGURANÇA

Este símbolo de aviso significa perigo. Você está em uma situação que poderá ser causadora de lesões corporais. Antes de iniciar a utilização de qualquer equipamento, tenha conhecimento dos perigos envolvidos no manuseio de circuitos elétricos e familiarize-se com as práticas habituais de prevenção de acidentes. Utilize o número da instrução fornecido ao final de cada aviso para localizar sua tradução nos avisos de segurança traduzidos que acompanham este dispositivo.

GUARDE ESTAS INSTRUÇÕES

¡Advertencia!

INSTRUCCIONES IMPORTANTES DE SEGURIDAD

Este símbolo de aviso indica peligro. Existe riesgo para su integridad física. Antes de manipular cualquier equipo, considere los riesgos de la corriente eléctrica y familiarícese con los procedimientos estándar de prevención de accidentes. Al final de cada advertencia encontrará el número que le ayudará a encontrar el texto traducido en el apartado de traducciones que acompaña a este dispositivo.

GUARDE ESTAS INSTRUCCIONES

Varning!

VIKTIGA SÄKERHETSANVISNINGAR

Denna varningssignal signalerar fara. Du befinner dig i en situation som kan leda till personskada. Innan du utför arbete på någon utrustning måste du vara medveten om farorna med elkretsar och känna till vanliga förfaranden för att förebygga olyckor. Använd det nummer som finns i slutet av varje varning för att hitta dess översättning i de översatta säkerhetsvarningar som medföljer denna anordning.

SPARA DESSA ANVISNINGAR

 

 

 

 

 

 

 

 

 

 

Aviso

INSTRUÇÕES IMPORTANTES DE SEGURANÇA

Este símbolo de aviso significa perigo. Você se encontra em uma situação em que há risco de lesões corporais. Antes de trabalhar com qualquer equipamento, esteja ciente dos riscos que envolvem os circuitos elétricos e familiarize-se com as práticas padrão de prevenção de acidentes. Use o número da declaração fornecido ao final de cada aviso para localizar sua tradução nos avisos de segurança traduzidos que acompanham o dispositivo.

GUARDE ESTAS INSTRUÇÕES

Advarsel

VIGTIGE SIKKERHEDSANVISNINGER

Dette advarselssymbol betyder fare. Du befinder dig i en situation med risiko for legemesbeskadigelse. Før du begynder arbejde på udstyr, skal du være opmærksom på de involverede risici, der er ved elektriske kredsløb, og du skal sætte dig ind i standardprocedurer til undgåelse af ulykker. Brug erklæringsnummeret efter hver advarsel for at finde oversættelsen i de oversatte advarsler, der fulgte med denne enhed.

GEM DISSE ANVISNINGER

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Obtaining Optical Networking Information

This section contains information that is specific to optical networking products. For information that pertains to all of Cisco, refer to the Obtaining Documentation and Submitting a Service Request section.

Where to Find Safety and Warning Information

For safety and warning information, refer to the Cisco Optical Transport Products Safety and Compliance Information document that accompanied the product. This publication describes the international agency compliance and safety information for the Cisco ONS 15454 system. It also includes translations of the safety warnings that appear in the ONS 15454 system documentation.

Cisco Optical Networking Product Documentation CD-ROM

Optical networking-related documentation, including Cisco ONS 15xxx product documentation, is available in a CD-ROM package that ships with your product. The Optical Networking Product Documentation CD-ROM is updated periodically and may be more current than printed documentation.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s New in Cisco Product Documentation , which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.