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, Cisco ONS 15600 SDH, and Cisco ONS 15310-MA SDH. Refer to the Cisco ONS 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
Note The MS-SPRing commands do not apply to the Cisco ONS 15310-MA SDH platform.
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>]"
Adds a new WDM node side and defines its attributes.
OPR-APC:[<TID>]::<CTAG>[::::];
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-PROTNSW-OTS:[<TID>]:<AID>:<CTAG>::<SW>;
Performs a protection switch on the trunk port of TXPP_MR_2.5G, MXPP_MR_2.5G, Optical Protection Unit, and OTU2-XP cards.
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>:,,[<ROLE>],[<STATUS>]:<OPTICALPORTTYPE>,[<POWER>],[<ILOSS>],
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.
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.
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>]" ;
Retrieves an Ethernet connection between two or more Ethernet connection endpoints within the Ethernet facilities.
Output format:
SID DATE TIME M CTAG COMPLD "<SRC>,<DST>:<ECT>:[CKTID=<CKTID>]:<PSTPSTQ>,[<SSTQ>]" ;
RTRV-ETH:[<TID>]:<AID>:<CTAG>;
Retrieves the front-end port information of an Ethernet card. (Not supported by the ONS 15600 SDH.)
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[LINKSTATE=<LINKSTATE>],[FLOWCTRL=<FLOWCTRL>],[DUPLEX=<DUPLEX>], [SPEED=<SPEED>],[FLOW=<FLOW>],[EXPDUPLEX=<EXPDUPLEX>], [EXPSPEED=<EXPSPEED>],[VLANCOS=<VLANCOS>],[IPTOS=<IPTOS>], [OPTICS=<OPTICS>],[NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [SELECTIVEAUTO=<SELECTIVEAUTO>]:<PST_PSTQ>,[<SSTQ>]"
;
RTRV-L2-ETH:[<TID>]:<AID>:<CTAG>[:::];
Retrieves the Layer 2 port information of the Ethernet card.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[<NIMODE>],[<MACLEARNING>],[<INGRESSCOS>],[<ETHERCETYPE>],[<ETHERSTYPE>],[<ALWMACADDR>],[<INHMACADDR>],[<BPDU>],[<BRIDGESTATE>],[<ACTBRIDGESTATE>],[<QNQMODE>],[<TRNSPSVLAN>],[<NAME>],[<IGMPROUTER>],[<AISACTION>],[<PROTACTION>]:
;
RTRV-MCAST:[<TID>]:<AID>:<CTAG>::[::];
Retrieves the multicast VLAN registration attributes.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[MVRSTATE=<MVRSTATE>],[MVRSVLAN=<MVRSVLAN>],[MVRSTARTIP=<MVRSTARTIP>],[MVRIPRANGE=<MVRIPRANGE>][:]" ;
Uploads the startup IOS configuration file from the network to the node. Downloads the startup Cisco IOS configuration file from the node to the network.
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>]" ;
11 Log
Table 11 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>" ;
12 Network
Table 12 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>]" ;
14 Performance
Note The RTRV-BFDLPM-<MOD2> command is not supported on the Cisco ONS 15310-MA SDH platform.
Table 14 Performance
ALW-PMREPT-ALL:[<TID>]::<CTAG>;
Resumes the processing of all inhibited performance monitoring (PM) reports.
Sets the threshold for PM and sets the alarm thresholds for the MXP_2.5G_10G and TXP_MR_10G cards.
15 Ports
Note The following Ports commands and modifiers are not supported on the Cisco ONS 15310-MA SDH platform: ED-<MOD1FCPAYLOAD>, ED-<MOD1FICONPAYLOAD>, RTRV-<MOD1FCPAYLOAD>, RTRV-<MOD1FICONPAYLOAD>, DS3I, E4, G1000, GIGE, STM1E, and VLAN.
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>],[TAPTYPE=<TAPTYPE>],[SFBER=<SFBER>],[SDBER=<SDBER>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>" ;
RTRV-E1:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the attributes and state information of an E1 port facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::LINECDE=<LINECDE>,FMT=<FMT>,[TACC=<TACC>],[TAPTYPE=<TAPTYPE>], [SFBER=<SFBER>],[SDBER=<SDBER>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [NAME=<NAME>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>], [RETIME=<RETIME>],[ADMSSM=<ADMSSM>],[PROVIDESYNC=<PROVIDESYNC>], [SABIT=<SABIT>]:<PSTPSTQ>,[<SSTQ>]" ;
RTRV-E3:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the attributes and state information of an E3 port facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[SFBER=<SFBER>], [SDBER=<SDBER>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]" ;
RTRV-E4:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the attributes and state information of an E4 port facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[PAYLOAD=<PAYLOAD>],[SFBER=<SFBER>],[SDBER=<SDBER>], [SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]" ;
RTRV-ESCON:[<TID>]:<AID>:<CTAG>;
Retrieves FC-specific settings for ports that have been configured to carry ESCON traffic using the ENT-ESCON command.
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.
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 a Fast Ethernet (10/100 Mbps) card.
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>],[SUPPRESS=<SUPPRESS>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SELECTIVEAUTO=<SELECTIVEAUTO>]: <PST_PSTQ>,[<SSTQ>]" ;
RTRV-G1000:[<TID>]:<AID>:<CTAG>;
Retrieves the G1000-4 facilities configuration. (Not supported by the ONS 15600 SDH.)
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 GFP for GFP management.
Output format:
SID DATE TIME
M CTAG COMPLD "<AID>::[FCS=<FCS>],[AUTOTHGFPBUF=<AUTOTHGFPBUF>],[GFPBUF=<GFPBUF>], [FILTER=<FILTER>]" ;
RTRV-GIGE:[<TID>]:<AID>:<CTAG>;
Retrieves front-end port information for a 1-Gigabit Ethernet card. (Not supported by the ONS 15600 SDH)
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[<ADMINSTATE>],[<LINKSTATE>],[<MTU>],[<MFS>],
Retrieves the layer 2 port information for the Ethernet card.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[NIMODE=<TYPE>],[MACLEARNING=<MACLEARNING>],[ INGRESSCOS=<INGRESSCOS>],[ETHERCETYPE=<ETHERCETYPE>], [ETHERSTYPE=<ETHERSTYPE>],[ALWMACADDR=<ALWMACADDR>], [INHMACADDR=<INHMACADDR>],[BPDU=<BPDU>],[BRIDGESTATE=<BRIDGESTATE>], [QNQMODE=<QNQMODE>],[TRNSPSVLAN=<TRNSPSVLAN>], [NAME=<NAME>]:[<PST>[,<SST>]]
Retrieves the NNI selective S-VLAN-ID table associated to an L2 Ethernet port.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<S_VLAN_ID>[::]" ;
RTRV-POS:[<TID>]:<AID>:<CTAG>;
Retrieves the back-end port information for the Ethernet card 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-STM1E:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the attributes and state information of an STM1E facility.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[PAYLOAD=<PAYLOAD>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>], [SFBER=<SFBER>],[SDBER=<SDBER>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>" ;
Instructs an SDH NE to release (clear) an SDH line protection switch request.
RLS-PROTNSW-<PATH>:[<TID>]:<SRC>:<CTAG>[::];
Instructs an SDH NE to release (clear) an SDH path protection switch request that was established with the OPR-PROTNSW-(MOD_PATH) command.
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-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Retrieves the optical facility protection information.
Output format:
SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>::[PROTID=<PROTID>,][RVRTV=<RVRTV>,][RVTM=<RVTM>,] [PSDIRN=<PSDIRN>,][VRGRDTM=<VRGRDTM>,][DTGRDTM=<DTGRDTM>,] [RCGRDTM=<RCGRDTM>,][OPOTYPE=<OPOTYPE>]" ;
Retrieves 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.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>:<FIRSTCEVLANID>,<LASTCEVLANID>,<SVLANID>:RULE=<RULE>[:]" ;
RTRV-VLAN:[<TID>]:<AID>:<CTAG>[::::];
Retrieves a virtual LAN entry from the VLAN database.
Output format:
SID DATE TIME M CTAG COMPLD "<AID>::[NAME=<NAME>],[PROTN=<PROTN>]:" ;
17 Provisionable Patchcords
Note None of the Provisionable Patchcords commands are supported on the Cisco ONS 15310- MA SDH platform.
Table 17 Provisionable Patchcords
DLT-LNKTERM:[<TID>]:<AID>:<CTAG>;
Deletes a provisionable patchcord termination that is present on a node.
Adds a user account; this command can only be performed by a Superuser.
INH-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;
Turns off the console port for the ML-Series cards. (Not supported by the ONS 15600 SDH.)
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 user ID, 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 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. (Not supported by the ONS 15600 SDH.)
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 for 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>]" ;
Initializes the specified card and its associated subsystems.
RTRV-ALMTYPE:[<TID>]::<CTAG>;
Retrieves all system and user-defined alarm types.
Output format:
SID DATE TIME M CTAG COMPLD "<TYPEOFALM>,<ALMTYPE>" ;
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-APC:[<TID>]:[<AID>]:<CTAG>;
Output format:
SID DATE TIME M CTAG COMPLD "<AID>,<MOD>::[MODIFDAT=<MODIFDAT>],[MODIFTM=<MODIFTM>],[CHECKDAT=<CHECKDAT>],[CHECKTM=<CHECKTM>]"
;
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 path-level attribuyes on an NE.
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>" ;
Retrieves all the attributes provisioned for a VCG.
Output format:
SID DATE TIME M CTAG COMPLD "<SRC>::TYPE=<TYPE>,TXCOUNT=<TXCOUNT>,CCT=<CCT>,[LCAS=<LCAS>], [BUFFERS=<BUFFERS>],[NAME=<NAME>]:<PST>" ;
23 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:
Subscribe to the What's New in Cisco Product Documentationas 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.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Feedback
The MS-SPRing commands do not apply to the Cisco ONS 15310-MA SDH platform.
