Cisco ONS SONET TL1 Command Quick Reference Guide, Release 7.0.1
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 15327, 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, ONS 15327, ONS 15310-CL, ONS 15310-MA, and ONS 15600, Release 7.0.1. 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 Network Element (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 OCN 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>]" ;
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 univocally 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 recompute 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>]" ;
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 nodes 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 OCH layer in a 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 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 automatic optical node setup (AONS) application attributes.
Output format:
SID DATE TIME "<AID>::[POWERIN=<POWERIN>],[POWEROUT=<POWEROUT>], [POWEREXP=<POWEREXP>],[NTWTYPE=<NTWTYPE>], [OPTICALTYPE=<OPTICALTYPE>],[LASTRUNDAT=<LASTRUNDAT>], [LASTRUNTM=<LASTRUNTM>]" ;
SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>], [<OCRTM>],,,[<DESC>]" ;
RTRV-EQPT:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the data parameters and state parameters associated with an equipment unit. Also retrieves shelf parameters.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<AIDTYPE>,<EQUIP>,[<ROLE>],[<STATUS>]:[PROTID=<PROTID>], [PRTYPE=<PRTYPE>],[RVRTV=<RVRTV>],[RVTM=<RVTM>], [CARDNAME=<CARDNAME>],[IOSCFG=<IOSCFG>],[CARDMODE=<CARDMODE>], [PEERID=<PEERID>],[REGENNAME=<REGENNAME>,][TRANSMODE=<TRANSMODE>], [RETIME=<RETIME>],[SHELFROLE=<SHELFROLE>]:[<PST_PSTQ>],[<SSTQ>]" ;
Downloads a new software package from the location specified by the FTP URL. Performs backup/restore on the database and archives the audit-log.
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 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 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/SLOT-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 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.
Edits the Generic Framing Procedure (GFP) port on the ONS 15310-CL/ONS 15310-MA ML-100T-8, ONS 15454 CE-100T-8, FC_MR-4, and CE-1000-4, and ONS 15600 ASAP-4 cards.
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 (not supported on the ONS 15327).
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>],[BLSRTYPE=<BLSRTYPE>],[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>[::::];
Retrieves the 10 Gigabit per second specific parameters for the port (ONS 15454 only).
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 OC-N facility and all facilities that support the ALS feature (ONS 15454, ONS 15310-CL, ONS 15310-MA).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>], [ALSRCPW=<ALSRCPW>],[LSRSTAR=<LSRSTAR>]" ;
RTRV-DS1:[<TID>]:<SRC>:<CTAG>[::::];
Retrieves the test access attributes on a DS1 layer of DS3XM card (ONS 15454 only).
Output format:
SID DATE TIME M CTAG COMPLD "<DS1AID>::[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[AISONLPBK=<AISONLPBK>], [MODE=<MODE>],[FMT=<FMT>" ;
RTRV-EC1:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the facility status of an EC1 card (ONS 15454, ONS 15310-CL, ONS 15310-MA).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[PJMON=<PJMON>],[LBO=<LBO>],[RXEQUAL=<RXEQUAL>],[SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>],[SFBER=<SFBER>],[SDBER=<SDBER>],[NAME=<NAME>], [EXPTRC=<EXPTRC>],[TRC=<TRC>],[TRCMODE=<TRCMODE>], [TRCFORMAT=<TRCFORMAT>],[AISONLPBK=<AISONLPBK>]:<PSTPSTQ>,[<SSTQ>]" ;
RTRV-ESCON:[<TID>]:<AID>:<CTAG>;
Retrieves fibre channel specific settings for ports that have been configured to carry ESCON traffic (ONS 15454 only).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[ENCAP=<ENCAP>]" ;
RTRV-FAC:[<TID>]:<SRC>:<CTAG>[::::];
Retrieves the payload type of the facility. Only applicable to a facility with a provisionable type.
Output format:
SID DATE TIME M CTAG COMPLD "<SRC>::PAYLOAD=<PAYLOAD>:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-FSTE:[<TID>]:<AID>:<CTAG>;
Retrieves the front end port information of fast (10/100 Mbps) Ethernet cards (ONS 15454, ONS 15310-CL, ONS 15310-MA).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[ADMINSTATE=<ADMINSTATE>],[LINKSTATE=<LINKSTATE>],[MTU=<MTU>], [FLOWCTRL=<FLOWCTRL>],[DUPLEX=<DUPLEX>],[SPEED=<SPEED>],[FLOW=<FLOW>], [EXPDUPLEX=<EXPDUPLEX>],[EXPSPEED=<EXPSPEED>],[VLANCOS=<VLANCOS>], [IPTOS=<IPTOS>],[OPTICS=<OPTICS>],[NAME=<NAME>],[SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>]:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-G1000:[<TID>]:<AID>:<CTAG>;
Retrieves the G1000 facilities configuration (ONS 15454 and ONS 15327 only).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[MFS=<MFS>],[FLOW=<FLOW>],[LAN=<LAN>],[OPTICS=<OPTICS>], [TRANS=<TRANS>],[TPORT=<TPORT>],[LOWMRK=<LOWMRK>], [HIWMRK=<HIWMRK>],[AUTONEG=<AUTONEG>],[ENCAP=<ENCAP>], [NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>]:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-GFP:[<TID>]:<SRC>:<CTAG>;
Retrieves the Generic Framing Procedure (GFP) port information on the ONS 15310-CL/ONS 15310-MA ML-100T-8, ONS 15454 CE-100T-8, FC_MR-4, and CE-1000-4, and ONS 15600 ASAP-4cards.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[FCS=<FCS>],[AUTOTHGFPBUF=<AUTOTHGFPBUF>],[GFPBUF=<GFPBUF>], [FILTER=<FILTER>]" ;
RTRV-GIGE:[<TID>]:<AID>:<CTAG>;
Retrieves the front end port information for the ONS 15454 ML1000-2, CE-1000-4 cards and ONS 15600 ASAP-4 cards.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,<ROLE>,<STATUS>:[ADMINSTATE=<ADMINSTATE>], [LINKSTATE=<LINKSTATE>],[MTU=<MTU>],[ENCAP=<ENCAP>], [FLOWCTRL=<FLOWCTRL>],[AUTONEG=<AUTONEG>],[HIWMRK=<HIWMRK>], [LOWMRK=<LOWMRK>],[OPTICS=<OPTICS>],[DUPLEX=<DUPLEX>],[SPEED=<SPEED>], [NAME=<NAME>],[FREQ=<FREQ>],[LOSSB=<LOSSB>],[SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>]:<PST>,<SST>" ;
RTRV-POS:[<TID>]:<AID>:<CTAG>;
Retrieves the back end port information for the ML-series Ethernet cards when the back end port is working in POS mode.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[ADMINSTATE=<ADMINSTATE>],[LINKSTATE=<LINKSTATE>],[MTU=<MTU>], [ENCAP=<ENCAP>],[NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>]: <PST_PSTQ>,[<SST>]" ;
RTRV-T1:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the DS1 facilities configuration (not supported on the ONS 15600).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],[TACC=<TAP>], [TAPTYPE=<TAPTYPE>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SFBER=<SFBER>], [SDBER=<SDBER>],[NAME=<NAME>],[SYNCMSG=<SYNCMSG>], [SENDDUS=<SENDDUS>],[RETIME=<RETIME>],[AISONLPBK=<AISONLPBK>], [AISVONAIS=<AISVONAIS>],[AISONLOF=<AISONLOF>],[MODE=<MODE>], [SYNCMAP=<SYNCMAP>],[ADMSSM=<ADMSSM>],[PROVIDESYNC=<PROVIDESYNC>], [VTMAP=<VTMAP>],[INHFELPBK=<INHFELPBK>]:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-T3:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the facilities properties of a DS3, DS3I (on SONET) and a DS3 trans mux card (not supported on the ONS 15600).
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[FMT=<FMT>],[LINECDE=<LINECDE>],[LBO=<LBO>], [INHFELPBK=<INHFELPBK>],[TACC=<TAP>],[TAPTYPE=<TAPTYPE>],[SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>],[SFBER=<SFBER>],[SDBER=<SDBER>],[NAME=<NAME>], [AISONLPBK=<AISONLPBK>]:<PST_PSTQ>,[<SSTQ>]" ;
Instructs a SONET NE to release (clear) a SONET line protection switch request.
RTRV-FFP:[<TID>]:<AID>:<CTAG>[::::];
Retrieves all optical 1+1 protection groups
Output format:
SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>:<LEVEL>:[PROTID=<PROTID>],[RVRTV=<RVRTV>], [RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>], [DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]" ;
RTRV-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the optical facility protection information.
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>]" ;
Adds a user account; can only be performed by a Superuser.
INH-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;
Turns off the console port for the ML-Series cards.
INH-MSG-SECU:[<TID>]::<CTAG>[::,,];
Inhibits the REPT EVT SECU and REPT ALM SECU messages.
INH-USER-SECU:[<TID>]::<CTAG>::<UID>;
Disables (without deleting) a userid, so the user is denied access to the NE.
REPT ALM SECU
Reports the occurrence of an alarmed security event against the NE.
Output format:
SID DATE TIME ** ATAG REPT ALM SECU "<AID>:<NOTIFCODE>,<SECUALMTYPE>" ;
REPT EVT SECU
Reports the occurrence of a non-alarmed security event against the NE.
Output format:
SID DATE TIME A ATAG REPT EVT SECU "<AID>:<DNFIELD>,[<CONDEFF>],,,,,,,:<SECURITY>:<DNFIELD1>" ;
REPT EVT SESSION
Reports a non-alarmed event related to establishing a session with the NE.
Output format:
SID DATE TIME A ATAG REPT EVT SESSION "<AID>:<EXP>,<PCN>" "<WARN>" ;
RTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;
Retrieves the current command security level of the command specified in the AID field.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<CAP>" ;
RTRV-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;
Retrieves the status of the console port for the ML-Series cards.
Output format:
SID DATE TIME M CTAG COMPLD "<EQPT>:PORT=<PORT>" ;
RTRV-DFLT-SECU:[<TID>]:<AID>:<CTAG>; Retrieves the system-wide default values associated with several security parameters. Output format:
SID DATE TIME M CTAG COMPLD "<NE>:PAGE=<PAGE>,PCND=<PCND>,MXINV=<MXINV>,DURAL=<DURAL>, TMOUT=<TMOUT>,UOUT=<UOUT>,PFRCD=<PFRCD>,POLD=<POLD>,PINT=<PINT>, LOGIN=<LOGIN>,[PRIVLVL=<PRIVLVL>],[PDIF=<PDIF>]" ;
RTRV-USER-SECU:[<TID>]:<UID>:<CTAG>;
Retrieves the security information of a specified user or list of users.
Output format:
SID DATE TIME M CTAG COMPLD "<UID>:,<PRIVILEGE>:LOGGEDIN=<LOGGEDIN>,[NUMSESSIONS=<NUMSESS>], [LOCKEDOUT=<LOCKEDOUT>],[DISABLED=<DISABLED>]" ;
Retrieves and sends the current status of alarm conditions associated with a synchronization facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>], [<OCRTM>],,:[<DESC>]" ;
RTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the BITS configuration command.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],[SYNCMSG=<SYNCMSG>], [AISTHRSHLD=<AISTHRSHLD>],[SABIT=<SABIT>],[IMPEDANCE=<IMPEDANCE>], [BITSFAC=<BITSFAC>],[ADMSSM=<ADMSSM>]:[<PST>]" ;
ED-NE-GEN:[<TID>]::<CTAG>:::[NAME=<NAME>],[IPADDR=<IPADDR>], [IPMASK=<IPMASK>],[DEFRTR=<DEFRTR>],[IIOPPORT=<IIOPPORT>], [NTP=<NTP>],[ISPROXYSERVER=<ISPROXYSERVER>],[ISFIREWALL=<ISFIREWALL>], [SUPPRESSIP=<SUPPRESSIP>],[MODE=<MODE>]; Edits the general node attributes of an NE.
Initializes the specified card and its associated subsystem(s).
RTRV-HDR:[<TID>]::<CTAG>;
Retrieves the header of a TL1 response message.
RTRV-INV:[<TID>]:<AID>:<CTAG>[::::];
Retrieves a listing of the equipment inventory.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,<AIDTYPE>::[PN=<PN>],[HWREV=<HWREV>],[FWREV=<FWREV>],[SN=<SN>], [CLEI=<CLEI>],[TWL1=<TWL>],[PLUGINVENDORID=<PLUGINVENDORID>], [PLUGINPN=<PLUGINPN>],[PLUGINHWREV=<PLUGINHWREV>], [PLUGINFWREV=<PLUGINFWREV>],[PLUGINSN=<PLUGINSN>], [ILOSSREF=<ILOSSREF>],[PID=<PID>],[VID=<VID>],[FPGA=<FPGA>], [VENDORID=<VENDORID>]" ;
RTRV-NE-GEN:[<TID>]::<CTAG>;
Retrieves the general NE attributes.
Output format:
SID DATE TIME M CTAG COMPLD "[IPADDR=<IPADDR>],[IPMASK=<IPMASK>],[DEFRTR=<DEFRTR>], [IIOPPORT=<IIOPPORT>],[NTP=<NTP>],[ETHIPADDR=<ETHIPADDR>], [ETHIPMASK=<ETHIPMASK>],[NAME=<NAME>],[SWVER=<SWVER>],[LOAD=<LOAD>], [PROTSWVER=<PROTSWVER>],[PROTLOAD=<PROTLOAD>],[DEFDESC=<DEFDESC>], [PLATFORM=<PLATFORM>],[SECUMODE=<SECUMODE>],[SUPPRESSIP=<SUPPRESSIP>]" ;
RTRV-NE-PATH:[<TID>]::<CTAG>[::::];
Retrieves the general NE attributes.
Output format:
SID DATE TIME M CTAG COMPLD "[PDIP=<PDIP>],[XCMODE=<XCMODE>]" ;
RTRV-NETYPE:[<TID>]::<CTAG>;
Retrieves the equipment-related information of an NE.
Output format:
SID DATE TIME M CTAG COMPLD "<VENDOR>,<MODEL>,<NETYPE>,<SW_ISSUE>" ;
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.
