Cisco ONS SONET TL1 Command Quick Reference Guide, Release 8.0
Last Updated: October 28, 2007
Note The terms "Unidirectional Path Switched Ring" and "UPSR" may appear in Cisco literature. These terms do not refer to using Cisco ONS 15xxx products in a unidirectional path switched ring configuration. Rather, these terms, as well as "Path Protected Mesh Network" and "PPMN," refer generally to Cisco's path protection feature, which may be used in any topological network configuration. Cisco does not recommend using its path protection feature in any particular topological network configuration.
Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600
This guide lists TL1 commands and autonomous messages by category. It includes basic descriptions and input and output formats supported by the Cisco ONS 15454, Cisco ONS 15310-CL, Cisco ONS 15310-MA, and Cisco ONS 15600. Refer to the Cisco ONS SONET TL1 Command Guide for a complete description of TL1 commands.
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.
Exercises the algorithm for switching from a working facility to a protection facility without actually performing a switch.
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Retrieves the BLSR information of the NE.
Output format:
SID DATE TIME M CTAG COMPLD "[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>], [RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>], [EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>], [WESTPROT=<WESTPROT>]" ;
RTRV-TRC-<OCN_BLSR>:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the valid J1 expected trace string, received trace string, trace mode, C2 byte, and STS bandwidth of the OC-N port if the port has a BLSR.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>], [TRCMODE=<TRCMODE>],[C2=<C2>]" ;
Adds a new WDM node side and defines its attributes.
OPR-APC:[<TID>]::<CTAG>[::::];
Permits the APC application inside the NE to force regulation of the optical power to the entire DWDM ring.
OPR-LASER-OTS:[<TID>]:<AID>:<CTAG>;
Instructs a laser to be switched on.
OPR-LNK:[<TID>]::<CTAG>;
Permits the optical link application inside the NE to calculate all the automatic optical links between end points which can be identified by the NE.
OPR-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>::<SW>;
Performs a protection switch on the trunk port of a TXPP_MR_2.5G card (protect version only).
OPR-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;
Invokes the calculation of the expected span loss verification.
OPR-WDMANS:[<TID>]::<CTAG>;
Operates the AONS application inside the NE to force a recalculation of the value to be assigned to all variable optical attenuators (VOA) representing the optical path inside the node.
Retrieves the configuration parameter of a DWDM client.
Output format:
SID DATE TIME M CTAG COMPLD "<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[LBCL=<LBCL>], [OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]" ;
Retrieves Y-cable protection on client facilities.
Output format:
SID DATE TIME M CTAG COMPLD "<AIDUNIONID>,<AIDUNIONID1>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>], [RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>]" ;
RTRV-FFP-OCH:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the protection group information for the TXP_MR_2.5G and TXPP_MR_2.5G trunk port.
Output format:
SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>], [RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>], [DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]" ;
SID DATE TIME M CTAG COMPLD "<AID>::REMOTEID=<REMOTEID>,LOCALPORT=<LOCALPORT>, REMOTEIP=<REMOTEIP>,[HELLO=<HELLO>],[HELLOMIN=<HELLOMIN>], [HELLOMAX=<HELLOMAX>],[DEAD=<DEAD>],[DEADMIN=<DEADMIN>], [DEADMAX=<DEADMAX>],[OPSTATE=<OPSTATE>]:[<PST>[,<SST>]] ;
RTRV-LMP-TLINK:[<TID>]:<SRC>:<CTAG>;
Retrieves an LMP TE link.
Output format:
SID DATE TIME M CTAG COMPLD "<SRC>::[REMOTEID=<REMOTEID>],[DWDM=<DWDM>],[REMOTETE=<REMOTETE>], [MUXCAP=<MUXCAP>],[OPSTATE=<OPSTATE>]:[<PST>[,<SST>]]" ;
RTRV-LMP-DLINK:[<TID>]:<SRC>:<CTAG>;
Retrieves an LMP data link.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LINKTYPE=<LINKTYPE>],[REMOTEID=<REMOTEID>],[TELINK=<TELINK>], [OPSTATE=<OPSTATE>]" ;
RTRV-LNK:[<TID>]::<CTAG>;
Retrieves all the optical links created in the NE.
Output format:
SID DATE TIME M CTAG COMPLD "<FROM>,<TO>::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],[RDIRN=<RDIRN>], [BAND=<BAND>],[WLEN=<WLEN>]:<PST_PSTQ>,[<SST>]" ;
Retrieves any optical link associated with the entered AIDs or AID range.
Output format:
SID DATE TIME M CTAG COMPLD "<FROM>,<TO>::[OLNKT=<OPTICALLINKTYPE>],[CTYPE=<CREATIONTYPE>], [RDIRN=<RDIRN>],[BAND=<BAND>],[WLEN=<WLEN>]:<PST_PSTQ>,[<SST>]" ;
RTRV-NE-APC:[<TID>]:[<AID>]:<CTAG>;
Retrieves the APC application ports that are involved in node setup regulation.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,<MOD>::[MODIFDAT=<MODIFDAT>],[MODIFTM=<MODIFTM>], [CHECKDAT=<CHECKDAT>],[CHECKTM=<CHECKTM>]" ;
RTRV-NE-WDMANS:[<TID>]::<CTAG>;
Retrieves the optical node setup (WDMANS) application ports involved in node setup regulation.
Output format:
SID DATE TIME M CTAG COMPLD "[<AID>],<AIDTYPE>::[REGULATED=<REGULATED>],[PARAM=<PARAM>]" ;
RTRV-OCH:[<TID>]:<AID>:<CTAG>;
Retrieves the attributes (service parameters) and state of an OCH facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[RDIRN=<RDIRN>],[OPTYPE=<OPTICALPORTTYPE>], [OPWR=<POWER>],[EXPWLEN=<EXPWLEN>],[ACTWLEN=<ACTWLEN>], [ILOSS=<ILOSS>],[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>], [VOAPWR=<VOAPWR>],[VOAREFATTN=<VOAREFATTN>], [VOAREFPWR=<VOAREFPWR>],[REFOPWR=<REFOPWR>],[CALOPWR=<CALOPWR>], [CHPOWER=<CHPOWER>],[NAME=<PORTNAME>],[SFBER=<SFBER>],[SDBER=<SDBER>], [COMM=<COMM>],[GCCRATE=<GCCRATE>],[DWRAP=<DWRAP>],[FEC=<FEC>], [PAYLOADMAP=<PAYLOADMAP>],[OSPF=<OSPF>],[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>]:<PST_PSTQ>,[<SSTQ>],[OSFBER=<OSFBER>],[OSDBER=<OSDBER>],[MACADDR=<MACADDR>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>]" ;
RTRV-OCHCC:[<TID>]:<AID>:<CTAG>;
Retrieves the OCH client connection provisioning information.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[PAYLOAD=<PAYLOAD>],[CTKID=<CTKID>]:<PSTPSTQ>" ;
RTRV-OCHNC:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the OCH wavelength connection provisioning information.
Output format:
SID DATE TIME M CTAG COMPLD "<SRC>,<DST>:<WCT>:[CKTID=<CKTID>]::<PSTPSTQ>" ;
RTRV-OMS:[<TID>]:<AID>:<CTAG>;
Retrieves the attributes (service parameters) and state of an OMS facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>], EXPBAND=<EXPBAND>,[ACTBAND=<ACTBAND>],[ILOSS=<ILOSS>], [VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>],[VOAPWR=<VOAPWR>], [VOAREFATTN=<VOAREFATTN>],[VOAREFPWR=<VOAREFPWR>], [REFOPWR=<REFOPWR>],[CALOPWR=<CALOPWR>],[CHPOWER=<CHPOWER>], [NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-OPM:[<TID>]:[<AID>]:<CTAG>[::::];
Retrieves the optical power monitoring (OPM) parameters present at the OCH layer in a reconfigurable optical add/drop mode (ROADM) node.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[POWEROUT=<POWEROUT>],[POWERADD=<POWERADD>], [POWERPT=<POWERPT>]" ;
RTRV-OSC:[<TID>]:<AID>:<CTAG>;
Retrieves all of the OSC information of the NE.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[RINGID=<RINGID>],[NODEID=<NODEID>],[EAST=<EAST>],[WEST=<WEST>]" ;
RTRV-OTS:[<TID>]:<AID>:<CTAG>;
Retrieves the attributes (service parameters) and state of an OTS facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>], [ILOSS=<ILOSS>],[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>], [VOAPWR=<VOAPWR>],[VOAREFATTN=<VOAREFATTN>], [VOAREFPWR=<VOAREFPWR>],[OSRI=<OSRI>],[AMPLMODE=<AMPLMODE>], [CHPOWER=<CHPOWER>],[GAIN=<GAIN>],[EXPGAIN=<EXPGAIN>], [REFOPWR=<REFOPWR>],[OFFSET=<OFFSET>],[REFTILT=<REFTILT>], [CALTILT=<CALTILT>],[ASEOPWR=<ASEOPWR>],[DCULOSS=<DCULOSS>], [AWGST=<AWGST>],[HEATST=<HEATST>],[NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-PATH-OCH:[<TID>]:<AID>:<CTAG>;
Retrieves the OCH path inside a node.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:[WLEN],[PATH]:" ;
RTRV-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>;
Retrieves the protection switch status of a TXPP_MR_2.5G card.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<SW>,<SWTYPE>" ;
RTRV-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;
Retrieves the options provisionable by the ED-SLV-WDMANS command.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[HIGHSLVEXP=<HIGHSLVEXP>],[LOWSLVEXP=<LOWSLVEXP>], [SLVACT=<SLVACT>],[RESOLUTION=<RESOLUTION>]" ;
Retrieves the sent trace string, expected trace string, received trace string, trace mode, and the trace level for the SONET J0 Section, the TTI PATH, and the SECTION monitoring levels of the DWDM facility.
Output format:
SID DATE TIME M CTAG COMPLD "<CHANNEL>,<MOD>::[TRCLEVEL=<TRCLEVEL>],[EXPTRC=<EXPTRC>],[TRC=<TRC>], [INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],[TRCFORMAT=<TRCFORMAT>]" ;
RTRV-WDMANS:[<TID>]:<AID>:<CTAG>;
Retrieves the AONS application attributes.
Output format:
SID DATE TIME "<AID>::[POWERIN=<POWERIN>],[POWEROUT=<POWEROUT>], [POWEREXP=<POWEREXP>],[NTWTYPE=<NTWTYPE>], [OPTICALTYPE=<OPTICALTYPE>],[LASTRUNDAT=<LASTRUNDAT>], [LASTRUNTM=<LASTRUNTM>]" ;
RTRV-WDMSIDE:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the WDM side and defines its attributes.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::LINEIN=<LINEIN>,LINEOUT=<LINEOUT>,[OCS=<OSC>][:]" ;
RTRV-WLEN:[<TID>]:<AID>:<CTAG>;
Retrieves the wavelength provisioning information.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>],[TOSIDE=<TOSIDE>],[SRC=<SRC>],
Edits the attributes for a specific slot in the NE. Modifies a shelf role from node control (NC) to shelf control (SC) on an NE configured in multishelf mode.
Downloads a new software package from the location specified by the FTP URL. Performs backup/restore on the database and archives the auditlog.
REPT EVT FXFR
Reports the FTP software download status of the start, completion, and completed percentage (not supported on the ONS 15600).
Output format:
SID DATE TIME A ATAG REPT EVT FXFR "<FILENAME>,<FXFR_STATUS>,[<FXFR_RSLT>],[<PRCNT_XFRD>]" ;
REPT EVT IOSCFG
Reports the status of copying the IOS configuration file when the COPY-IOSCFG command is issued.
Output format:
SID DATE TIME A ATAG REPT EVT IOSCFG "<AID>:<SRC>,<DEST>,<STATUS>,[<RESULT>]" ;
9 Log
Table 9 Log
ALW-MSG-DBCHG:[<TID>]::<CTAG>[::,,];
Enables REPT DBCHG.
INH-MSG-DBCHG:[<TID>]::<CTAG>[::,,];
Disables REPT DBCHG.
REPT DBCHG
Reports any changes on the NE that result from certain TL1 commands or an external event.
Output format:
SID DATE TIME A ATAG REPT DBCHG "TIME=<TIME>,DATE=<DATE>,[SOURCE=<SOURCE>],[USERID=<USERID>], DBCHGSEQ=<DBCHGSEQ>:<COMMAND>:<AID>:::<PSTPSTQ>,<SST>" ;
RTRV-AUDIT-LOG:[<TID>]::<CTAG>;
Retrieves the contents of the audit log stored in the NE.
Output format:
SID DATE TIME M CTAG COMPLD "<ENTRYNUM>,<OCRDAT>,<OCRTM>,<TASKID>,<TXSTATUS>,<DESCRIPTION>"
;
RTRV-LOG:[<TID>]::<CTAG>::<LOGNM>;
Retrieves the alarm log of the NE.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,<ALMNUMBER>:CURRENT=<CURRENT>,[PREVIOUS=<PREVIOUS>], <CONDITION>,<SRVEFF>,[TIME=<OCRTIME>],[DATE=<OCRDAT>]:<ALMDESCR>" ;
10 Network
Table 10 Network
RTRV-MAP-NETWORK:[<TID>]::<CTAG>;
Retrieves all the NE attributes which are reachable from the gateway network element (GNE).
Output format:
SID DATE TIME M CTAG COMPLD "<IPADDR>,<NODENAME>,<PRODUCT>" ;
RTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;
Retrieves the IP address and node name of the NEs that have the data communication channel (DCC) connection with this NE.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<IPADDR>,<NODENAME>" ;
Retrieves the attributes associated with an STS or VT path.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>], [RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>], [EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>], [TRCFORMAT =<TRCFORMAT>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>], [UPSRPTHSTATE=<UPSRPTHSTATE>],[C2=<C>], [BLSRPTHSTATE=<BLSRPTHSTATE>]:<PSTPSTQ>,[<SSTQ>]" ;
RTRV-STS:[<TID>]:<AID>:<CTAG>;
Retrieves the attributes associated with an STS path based on the granularity level of NE-specific STSs (not supported on the ONS 15310-CL).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>], [RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>], [EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>], [TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[UPSRPTHSTATE=<UPSRPTHSTATE>], [C2=<C>],[BLSRPTHSTATE=<BLSRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]" ;
12 Performance
Table 12 Performance
ALW-PMREPT-ALL:[<TID>]::<CTAG>;
Resumes the processing of all inhibited performance monitoring (PM) reports.
Schedules/reschedules the NE to report the performance monitoring data for a line facility or for an STS/VT path periodically, using an automatic REPT PM message.
Deletes the IEEE 802.1Q tunneling (QinQ) relationship between the CE-VLAN and the S-VLAN for Gigabit Ethernet uniport provisioning associated to an L2 Ethernet port.
Edits the Generic Framing Procedure (GFP) port on the ONS 15310-CL/ONS 15310-MA ML-100T-8 card; ONS 15454 CE-100T-8, FC_MR-4, and CE-1000-4 cards; and the ONS 15600 ASAP-4 card.
Edits the back-end virtual port information on the ONS 15310-CL/ONS 15310-MA ML-100T-8 card; ONS 15454 CE-100T-8 and CE-1000-4 cards; and the ONS 15600 ASAP-4 card.
Modifies the IEEE 802.1Q tunneling (QinQ) relationship between the customer CE-VLAN and the S-VLAN for Gigabit Ethernet uniport provisioning associated to an L2 Ethernet port.
Enters a new IEEE 802.1Q tunneling (QinQ) relationship between the CE-VLAN and S-VLAN for Gigabit Ethernet uniport provisioning associated to an L2 Ethernet port.
Retrieves the attributes related with the fibre channel (FC) port (ONS 15454 only).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:LINKRATE=<LINKRATE>,LINKSTATE=<LINKSTATE>, [LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>], [LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]: <PST_PSTQ>,[<SST>]"
;
RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Retrieves the fibre-channel-specific settings for ports which have been configured to carry FICON traffic (ONS 15454 only).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>], [LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>], [LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]: <PST_PSTQ>,<SST>" ;
RTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the attributes and state of an OC-N facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<ARE
The terms "Unidirectional Path Switched Ring" and "UPSR" may appear in Cisco literature. These terms do not refer to using Cisco ONS 15xxx products in a unidirectional path switched ring configuration. Rather, these terms, as well as "Path Protected Mesh Network" and "PPMN," refer generally to Cisco's path protection feature, which may be used in any topological network configuration. Cisco does not recommend using its path protection feature in any particular topological network configuration.
