This guide lists TL1 commands and autonomous messages by category. It includes basic descriptions and input and output formats supported by the Cisco ONS 15530 for Cisco IOS Release 12.1(12c)EV1.
TL1 commands conform to the following syntax:
a:b:c:d:e: ...z;
where:
"a" is the Command Code.
"b" is the Target Identifier (TID).
"c" is the Access Identifier (AID) or the User Identifier (UID).
"d" is the Correlation Tag (CTAG).
"e: ...z;" are other positions required for various commands.
The TID, AID, and CTAG route and control the TL1 command.
Other parameters provide additional information required to complete the action requested by the command.
1 Alarms and Faults
Table 1 Alarms and Faults
ALW-MSG-ALL
ALW-MSG-ALL:[<tid>]::<ctag>;
Allows the transmission of all autonomous messages.
SID DATE TIME M CTAG COMPLD "<wkg_aid>,<prot_aid>:ACTIVE=<active>,STANDBY=<standby>,PROTID=<protid>, PSDIRN=<psdirn>,RVRTV=<rvrtv>,RVRTM=<rvrtm>,ENSWOTM=<enswotm>, SRCHUPMIN=<srchupmin>,SRCHUPMAX=<srchupmax>,FENDDIRN=<fenddirn>, MSGCH=<msgch>,MSGCHCUR=<msgchcur>,MSGHOLDTM=<msgholdtm>, MSGCHST=<msgchst>,MSGHOLDCOUNT=<msgholdcount>, MSGMAXTM=<msgmaxtm>:<pst>" ;
DLT-FFP-OCH
DLT-FFP-OCH:[<tid>]:<wkg_aid>,<prot_aid>:<ctag>;
Deletes an APS group.
OPR-PROTNSW-OCH
OPR-PROTNSW-OCH:[<tid>]:<aid>:<ctag>::<sc>;
Requests a protection switchover or lockout.
RLS-PROTNSW-OCH
RLS-PROTNSW-OCH:[<tid>]:<aid>:<ctag>::;
Clears a protection switchover or lockout request.
Creates a cross connection between two interfaces across the switch fabric.
DLT-CRS-OCH
DLT-CRS-OCH:[<tid>]:<from_aid>,<to_aid>:<ctag>;
Deletes a cross connection.
RTRV-CRS-OCH
RTRV-CRS-OCH:[<tid>]:<from_aid>,<to_aid>:<ctag>;
Retrieves the cross connection information between two interfaces.
Output format:
SID DATE TIME M CTAG COMPLD "<from_aid>,<to_aid>:<dirn>" ;
RTRV-CRS-ALL
RTRV-CRS-ALL:[<tid>]::<ctag>;
Retrieves the cross connection information for the system.
Output format:
SID DATE TIME M CTAG COMPLD "<from_aid>,<to_aid>:<dirn>" ;
5 Generic Network Element Configuration
Table 5 Generic Network Element Configuration
ED-NE-GEN
ED-NE-GEN:[<tid>]::<ctag>:::[CFGREG=<cfgreg>];
Configures the generic network element (NE) configuration information, such as the software configuration register value.
RTRV-NE-GEN
RTRV-NE-GEN:[<tid>]::<ctag>;
Retrieves the generic NE information.
Output format:
SID DATE TIME M CTAG COMPLD ":CURCFGREG=<curcfgreg>,NEWCFGREG=<newcfgreg>,SWVER=<swver>, SWNAME=<swname>,SYSFILE=<sysfile>,CMPLTIME=<cmpltime>,CMPLBY=<cmplby>" ;
INIT-SYS
INIT-SYS:[<tid>]:<aid>:<ctag>::;
Initializes or resets a CPU switch module.
SET-SID
SET-SID:[<tid>]::<ctag>::<sid>;
Changes the system identification code to the specified value.
RTRV-HDR
RTRV-HDR:[<tid>]::<ctag>;
Retrieves the system header information.
Output format:
SID DATE TIME M CTAG COMPLD ;
ED-DAT
ED-DAT:[<tid>]::<ctag>::[<date>],[<time>];
Edits the date and time on the system.
RTRV-TOD
RTRV-TOD:[<tid>]::<ctag>;
Retrieves the system time-of-date information.
Output format:
SID DATE TIME M CTAG COMPLD "<year>,<month>,<day>,<hour>,<minute>,<second>.<thousandths-of-second>,<timezone>" ;
Retrieves the escon interface configuration information.
SID DATE TIME M CTAG COMPLD "<aid>:RXFLOWID=<rxflowid>,TXFLOWID=<txflowid>,THRLISTNAME=<thrlistname>, RXMAXFLOWID=<rxmaxflowid>,TXMAXFLOWID=<txmaxflowid>:<pst>" ;
Configures protocol encapsulation, clock rate, forward laser control, Open Fiber Control (OFC), threshold lists, Cisco Discovery Protocol (CDP), and interface state for a transparent interface.
Configures forward laser control, laser safety control, threshold lists, laser frequency, and interface state for a wave interface.
Configures the interface state for a wavepatch interface.
Configures the CDP and interface state for an etherdcc interface.
RTRV-OCH
RTRV-OCH:[<tid>]:[<aid>]:<ctag>;
Retrieves the interface configuration information.
Output format for a transparent interface:
SID DATE TIME M CTAG COMPLD "<aid>:ENCAP=<encap>,RATE=<rate>,THRLISTNAME=<thrlistname>,FLC=<flc>, OFC=<ofc>,CDP=<cdp>,LPBKTYPE=<lpbktype>:<pst>" ;
Output format for a wave interface:
SID DATE TIME M CTAG COMPLD "<aid>:THRLISTNAME=<thrlistname>,FLC=<flc>,LSC=<lsc>,LASERFREQ=<laserfreq>, LPBKTYPE=<lpbktype>:<pst>" ;
SET-PMMODE-OCH
SET-PMMODE-OCH:[<tid>]:<aid>:<ctag>::,,<pmstate>;
Enables and disables the performance monitoring for a transparent interface.
RTRV-PMMODE-OCH
RTRV-PMMODE-OCH:[<tid>]:[<aid>]:<ctag>;
Retrieves the performance monitoring configuration for a transparent interface.
Output format:
SID DATE TIME M CTAG COMPLD "<aid>:,,<pmmode>" ;
INIT-REG-OCH
INIT-REG-OCH:[<tid>]:[<aid>]:<ctag>;
Clears the counters associated with a transparent or wave interface.
OPR-LPBK-OCH
OPR-LPBK-OCH:[<tid>]:<aid>:<ctag>::,,,<lpbktype>;
Operates a loopback on a transparent or wave interface.
RLS-LPBK-OCH
RLS-LPBK-OCH:[<tid>]:<aid>:<ctag>::,,,<lpbktype>;
Releases a loopback on a transparent or wave interface.
Configures the attenuation or the desired power level on the variable optical attenuator (VOA) module interfaces.
RTRV-VOA
RTRV-VOA:[<tid>]:[<aid>]:<ctag>;
Retrieves the attenuation or power level configured for VOA module interfaces.
Output format:
SID DATE TIME M CTAG COMPLD "<aid>:ATTENMODE=<attenmode>,DESPOWER=<despower>,CURATTEN=<curatten>, CURPOWER=<curpower>,MINATTEN=<minatten>,MAXATTEN=<maxatten>:<pst>" ;
Configures the in-band message channel, forward laser control, forced end-of-hop, and alarm threshold lists on a tengigetherphy or waveetherphy interface.
RTRV-GBE10
RTRV-GBE10:[<tid>]:[<aid>]:<ctag>;
Retrieves the information for a tengigetherphy and waveetherphy interface.
Output format:
SID DATE TIME M CTAG COMPLD "<aid>:THRLISTNAME=<thrlistname>,FRCENDHOP=<frcendhop>, NODEBEHAVIOUR=<nodebehaviour>,LPBKTYPE=<lpbktype>:<pst>" ;
SID DATE TIME M CTAG COMPLD "ASSOCTYPE=<assoctype>,ASSOCIPADDR=<associpaddr>, ASSOCSTRATUM=<assocstratum>,ASSOCREFID=<assocrefid>,ASSOCPOLL=<assocpoll>, ASSOCREACH=<assocreach>,ASSOCDELAY=<assocdelay>,ASSOCOFFSET=<assocoffset>, ASSOCDISP=<assocdisp>" ;
RTRV-NTP
RTRV-NTP:[<tid>]::<ctag>;
Retrieves the NTP information for the system.
Output format:
SID DATE TIME M CTAG COMPLD "SYNCSTATE=<syncstate>,STRATUM=<stratum>,REFIPADDR=<refipaddr>, NOMFREQ=<nomfreq>,ACTFREQ=<actfreq>,PRECISION=<precision>, REFTIME=<reftime>,CLKOFFSET=<clkoffset>,ROOTDELAY=<rootdelay>, ROOTDISP=<rootdisp>,PEERDISP=<peerdisp>" ;
SID DATE TIME M CTAG COMPLD "<from_aid>,<to_aid>:<dirn>" ;
15 Redundancy
Table 15 Redundancy
SW-DX-EQPT
SW-DX-EQPT:[<tid>]:<aid>:<ctag>::[<mode>];
Switches activity from the active CPU switch module to the standby CPU switch module.
ALW-SWDX-EQPT
ALW-SWDX-EQPT:[<tid>]:<aid>:<ctag>;
Enables switchovers and configuration synchronization between the active and standby CPU switch modules.
INH-SWDX-EQPT
INH-SWDX-EQPT:[<tid>]:<aid>:<ctag>;
Disables switchovers and configuration synchronization between the active and standby CPU switch modules.
RTRV-EQPT
RTRV-EQPT:[<tid>]:[<aid>]:<ctag>;
Retrieves the redundancy configuration.
Output format for CPU switch modules:
SID DATE TIME M CTAG COMPLD "<aid>:<clei>:PN=<pn>,SN=<sn>,OPN=<opn>,HWVER=<hwver>,SWVER=<swver>, FWVER=<fwver>,BOOTLDR=<bootldr>,ROMMONVER=<rommonver>, HWREDSTATE=<hwredstate>,SWREDSTATE=<swredstate>,,:<pst>,<sst>,<sst>" ;
Output format for transponder line cards:
SID DATE TIME M CTAG COMPLD "<aid>:<clei>:PN=<pn>,SN=<sn>,OPN=<opn>,HWVER=<hwver>,,FSWVER=<fwver>,,,,, LASERFREQLOW=<laserfreqlow>,LASERFREQHIGH=<laserfreqhigh>:<pst>,<sst>,<sst>" ;
RTRV-PM-EQPT
RTRV-PM-EQPT:[<tid>]:[<aid>]:<ctag>;
Retrieves the performance monitoring data for CPU switch modules.
Output format:
SID DATE TIME M CTAG COMPLD "<aid>:<montype>,<count>,,,,<time>" ;
16 Security
Table 16 Security
ENT-USER-SECU
ENT-USER-SECU:[<tid>]:<uid>:<ctag>::<pid>,,<uap>;
Create a user ID and sets the security parameters.
This guide is part of a documentation set that supports the Cisco ONS 15530 and the Cisco ONS 15540 ESPx. The other documents in the set are as follows:
Cisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.
Cisco.com
You can access the most current Cisco documentation on the World Wide Web at this URL:
Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.
Registered Cisco.com users can order the Documentation CD-ROM (product number DOC-CONDOCCD=) through the online Subscription Store:
Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).
Documentation Feedback
You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.
You can email your comments to bug-doc@cisco.com.
You can submit your comments by mail by using the response card behind the front cover of your document or by writing to the following address:
Cisco Systems Attn: Customer Document Ordering 170 West Tasman Drive San Jose, CA 95134-9883
We appreciate your comments.
Obtaining Technical Assistance
Cisco provides Cisco.com, which includes the Cisco Technical Assistance Center (TAC) Website, as a starting point for all technical assistance. Customers and partners can obtain online documentation, troubleshooting tips, and sample configurations from the Cisco TAC website. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC website, including TAC tools and utilities.
Cisco.com
Cisco.com offers a suite of interactive, networked services that let you access Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.
Cisco.com provides a broad range of features and services to help you with these tasks:
Streamline business processes and improve productivity
Resolve technical issues with online support
Download and test software packages
Order Cisco learning materials and merchandise
Register for online skill assessment, training, and certification programs
To obtain customized information and service, you can self-register on Cisco.com at this URL:
The Cisco TAC is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two levels of support are available: the Cisco TAC website and the Cisco TAC Escalation Center. The avenue of support that you choose depends on the priority of the problem and the conditions stated in service contracts, when applicable.
We categorize Cisco TAC inquiries according to urgency:
Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities, product installation, or basic product configuration.
Priority level 3 (P3)—Your network performance is degraded. Network functionality is noticeably impaired, but most business operations continue.
Priority level 2 (P2)—Your production network is severely degraded, affecting significant aspects of business operations. No workaround is available.
Priority level 1 (P1)—Your production network is down, and a critical impact to business operations will occur if service is not restored quickly. No workaround is available.
Cisco TAC Website
You can use the Cisco TAC website to resolve P3 and P4 issues yourself, saving both cost and time. The site provides around-the-clock access to online tools, knowledge bases, and software. To access the Cisco TAC website, go to this URL:
All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC website. Some services on the Cisco TAC website require a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to this URL to register:
If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC website, you can open a case online at this URL:
If you have Internet access, we recommend that you open P3 and P4 cases through the Cisco TAC website so that you can describe the situation in your own words and attach any necessary files.
Cisco TAC Escalation Center
The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. These classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer automatically opens a case.
To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:
Before calling, please check with your network operations center to determine the level of Cisco support services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). When you call the center, please have available your service agreement number and your product serial number.
Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online and printed sources.
The Cisco Product Catalog describes the networking products offered by Cisco Systems as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:
Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:
Packet magazine is the Cisco monthly periodical that provides industry professionals with the latest information about the field of networking. You can access Packet magazine at this URL:
iQ Magazine is the Cisco monthly periodical that provides business leaders and decision makers with the latest information about the networking industry. You can access iQ Magazine at this URL:
Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in the design, development, and operation of public and private internets and intranets. You can access the Internet Protocol Journal at this URL:
Printed in the USA on recycled paper containing 10% postconsumer waste.