Cisco ONS 15454 SDH and Cisco ONS 15600 SDH TL1 Command Quick Reference Guide, Release 8.0
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 SDH and Cisco ONS 15600 SDH. Refer to the Cisco ONS 15454 SDH and Cisco ONS 15600 SDH 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.
1 MS-SPRing
Table 1 MS-SPRing
DLT-<MOD_RING>:[<TID>]:<AID>:<CTAG>[:::];
Deletes the multiplex section-shared protection ring (MS-SPRing) of the network element (NE).
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 all of the MS-SPRing information from 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-<STM_MSSPR>:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the valid J1 expected trace string, received trace string, trace mode, c2 byte, and VC bandwidth of the STM port if the port is provisioned for MS-SPring.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>], [TRCMODE=<TRCMODE>],[C2=<C2>]"
Permit the NE's APC application to force regulation of the optical power to the DWDM ring.
OPR-LASER-OTS:[<TID>]:<AID>:<CTAG>;
Instructs a laser to be switched on.
OPR-LNK:[<TID>]::<CTAG>;
Permits the NE's optical link (OLNK) application to calculate all automatic optical links between points that 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 transponder (protect version only).
OPR-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;
Invokes the calculation of the expected span loss verification.
OPR-WDMANS:[<TID>]::<CTAG>;
Permits the NE's AONS application to force a recalculation of the value assigned to all variable optical attenuators (VOAs) 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 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 NE's APC application ports 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>]:[<AID>]:<CTAG>;
Retrieves the NE's 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 service parameter attributes 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>],[OSFBER=<OSFBER>],[OSDBER=<OSDBER>], [MACADDR=<MACADDR>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[OSPF=<OSPF>],[LBCL=<LBCL>], [OPT=<OPT>],[OPR=<OPR>]:<PST_PSTQ>,[<SSTQ>]" ;
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 service parameter attributes 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 parameters present at the OCH layer in a reconfigurable optical add/drop multiplexing (ROADM) node.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[POWEROUT=<POWEROUT>],[POWERADD=<POWERADD>], [POWERPT=<POWERPT>]" ;
RTRV-OSC:[<TID>]:<AID>:<CTAG>;
Retrieves all OSC information from 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 service parameter attributes 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 transponder trunk port (protect version only).
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-WDMASN command.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[HIGHSLVEXP=<HIGHSLVEXP>],[LOWSLVEXP=<LOWSLVEXP>], [SLVACT=<SLVACT>],[RESOLUTION=<RESOLUTION>]" ;
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 M CTAG COMPLD "<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>],
Sets the alarm thresholds on the following cards/ports/channels: MXP_2.5G_10G/TXP_MR_10G, optical service channel, optical amplifier, dispersion compensation units, multiplex/demultiplex and OADM.
5 Environment
Table 5 Environment
OPR-ACO-ALL:[<TID>]:[<AID>]:<CTAG>;
Operates the cut-off of the office audible alarm indications without changing the local alarm indications.
Edits the attributes for a specific equipment slot in the NE. Modifies a shelf role from node controller (NC) to shelf controller (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.
Output format:
SID DATE TIME A ATAG REPT EVT FXFR "<FILENAME>,<FXFR_STATUS>,[<FXFR_RSLT>],[<PRCNT_XFRD>]" ;
REPT EVT IOSCFG
Reports the copying status of 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>;
Reports all the NE attributes that are reachable from the gateway NE (GNE).
RTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;
Retrieves the IP address and node name of the NEs that have the data communications channel (DCC) connection with this NE.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<IPADDR>,<NODENAME>" ;
Retrieves the attributes associated with an SDH high/low order 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>], [TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[SNCPPTHSTATE=<SNCPPTHSTATE>], [C2=<C>],[MSSPRPTHSTATE=<MSSPRPTHSTATE>]:<PSTPSTQ>,[<SSTQ>]" ;
12 Performance
Table 12 Performance
ALW-PMREPT-ALL:[<TID>]::<CTAG>;
Resumes the processing of all inhibited performance monitoring (PM) reports.
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.
Modifies the automatic laser shutdown (ALS) attributes of an STM facility and in general for all the facilities that support the ALS feature. (Not supported by ONS 15600)
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.
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>;
Returns FC-specific settings for ports that have been configured to carry FICON traffic using the ENT-FICON command.
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>" ;
Retrieves the service parameter attributes and state of an STM facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>], [SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>], [SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>], [RINGID=<RINGID>],[MSSPRTYPE=<MSSPRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>], [CCID=<CCID>],[NBRIX=<NBRIX>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [SSMRCV=<SSMRCV>],[OSPF=<OSPF>],[LDCC=<LDCC>],[NAME=<NAME>], [LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[EXPTRC=<EXPTRC>],[TRC=<TRC>], [TRCMODE=<TRCMODE>],[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>], [SENDDUSFF=<SENDDUSFF>],[AISONLPBK=<AISONLPBK>],[FREQ=<FREQ>], [LOSSB=<LOSSB>],[FOREIGNFEND=<FOREIGNFEND>], [FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],:<PSTPSTQ>,[<SSTQ>]" ;
RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Used to retrieve the 10-Gbps-specific parameters for a port configured to support the gigabyte Ethernet payload using the ENT-10GIGE command.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>], [LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]: <PSTPSTQ>,[<SST>]" ;
RTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the ALS attributes of an STM facility and all facilities that support the ALS feature.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>], [ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>]" ;
RTRV-COS-ETH:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the egress parameters of a CoS table associated to an L2 Ethernet port.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[QOSENABLED=<QOSENABLED>],[BW0=<BWO>], [WEIGHT0=<WEIGHT0>],[BW1=<BW1>],[WEIGHT1=<WEIGHT1>],[BW2=<BW2>], [WEIGHT2=<WEIGHT2>],[BW3=<BW3>],[WEIGHT3=<WEIGHT3>],[BW4=<BW4>], [WEIGHT4=<WEIGHT4>],[BW5=<BW5>],[WEIGHT5=<WEIGHT5>],[BW6=<BW6>], [WEIGHT6=<WEIGHT6>],[BW7=<BW7>],[WEIGHT7=<WEIGHT7>][:]" ;
RTRV-DS3I:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the properties of a DS3i-N-12 facility. (Not supported by the ONS 15600 SDH)
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::FMT=<FMT>,LINECDE=<LINECDE>,LBO=<LBO>,[INHFELPBK=<INHFELPBK>], [TACC=<TACC>],[T