|
|
Table Of Contents
21.42 RTRV-FFP-<MOD2DWDMPAYLOAD>
21.74 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
RTRV Commands
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.
This chapter provides RTRV (retrieve) commands for the Cisco ONS 15454, ONS 15327, ONS 15600 and ONS 15310-CL.
21.1 RTRV-<MOD1FCPAYLOAD>
Retrieve (1GFC, 2GFC)
Usage Guidelines
Cisco ONS 15454
This command retrieves the attributes related with the Fibre Channel port.
See Table 27-1 for supported modifiers by platform.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
Table 21-1 RTRV-<MOD1FCPAYLOAD> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFC,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,
NAME=\"FC PORT\",SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,
LOSSB=LR-1:OOS-MA,MT"
;Output Parameters
Table 21-2 RTRV-<MOD1FCPAYLOAD> Output Parameters
AID
Access identifier from the "FACILITY" section
ROLE
The port role in Y-cable protection (WORK or PROT). Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
A port status in Y-cable protection (ACT or STBY). Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
LINKRATE
The actual rate running on the fibre channel port. It can differ from the payload type provisioned
Parameter type is LINKRATE—the link rate on a fibre channel port
•
The rate is 1 G fibre channel
•
The rate is 1 G FICON
•
The rate is 2 G fibre channel
•
The rate is 2 G FICON
•
The rate is unknown
•
The SFP is not plugged into the fibre channel port so the link rate cannot be detected
LINKSTATE
Link state
Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter
•
Monitored parameter with values equal to or greater than the level of LEV will be reported
•
Monitored parameter with values equal or less than the value of LEV will be reported
LINKRCVRY
Link recovery
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
DISTEXTN
Distance extension. Optional
Parameter type is DISTANCE_EXTENSION—distance extension
•
Buffer to buffer flow control
•
No distance extension
LINKCREDITS
Number of link credits. Integer. Optional
MFS
Maximum frame size. Integer. Optional
ENCAP
Frame encapsulation type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
NAME
Identifies the port name. String. Optional
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
FREQ
Optional. Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Optional. Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.2 RTRV-<MOD1FICONPAYLOAD>
Retrieve (1GFICON, 2GFICON)
Usage Guidelines
Cisco ONS 15454
This command returns fibre channel-specific settings for ports which have been configured to carry FICON traffic using the ENT-FICON command. The MXPP_MR_2.5G card only supports the GFP-T frame type
See Table 27-1 for supported modifiers by platform.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
Table 21-3 RTRV-<MOD1FICONPAYLOAD> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFICON,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,NAME=\"FC PORT\",
SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,LOSSB=LR-1:OOS-MA,MT"
;Output Parameters
Table 21-4 RTRV-<MOD1FICONPAYLOAD> Output Parameters
AID
Access identifier from the "FACILITY" section
ROLE
The port role in Y-cable protection (WORK or PROT). Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
A port status in Y-cable protection (ACT or STBY). Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
LINKRATE
The actual rate running on the fibre channel port. It can differ from the payload type provisioned
Parameter type is LINKRATE—the link rate on a fibre channel port
•
The rate is 1 G fibre channel
•
The rate is 1 G FICON
•
The rate is 2 G fibre channel
•
The rate is 2 G FICON
•
The rate is unknown
•
The SFP is not plugged into the fibre channel port so the link rate cannot be detected
LINKSTATE
Link state
Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter
•
Monitored parameter with values equal to or greater than the level of LEV will be reported
•
Monitored parameter with values equal or less than the value of LEV will be reported
LINKRCVRY
Link recovery
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
DISTEXTN
Distance extension. Optional
Parameter type is DISTANCE_EXTENSION—distance extension
•
Buffer to buffer flow control
•
No distance extension
LINKCREDITS
Number of link credits. Integer. Optional
MFS
Maximum frame size. Integer. Optional
ENCAP
Frame encapsulation type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
NAME
Identifies the port name. String. Optional
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
FREQ
Optional. Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Optional. Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.3 RTRV-<MOD2DWDMPAYLOAD>
Retrieve (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, PASSTHRU)
Usage Guidelines
Cisco ONS 15454
This command retrieves the configuration parameter of a DWDM client.
See Table 27-1 for supported modifiers by platform.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-HDTV:MILAN:FAC-1-1:100;
Input Parameters
Table 21-5 RTRV-<MOD2DWDMPAYLOAD> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[LBCL=<LBCL>],
[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1,HDTV:,,WORK,ACT:NAME=\"NY PORT\",LBCL=10.0,OPT=10.0,OPR=10.0,
FREQ=1550,LOSSB=LR-1:OOS-AU,AINS"
;Output Parameters
Table 21-6 RTRV-<MOD2DWDMPAYLOAD> Output Parameters
AIDUNIONID
Access identifier from the "AidUnionId" section
AIDTYPE
A type of access identifier
Parameter type is MOD2DWDMPAYLOAD—payload types applicable to DWDM ports
•
10 gigabit fibre channel payload
•
10 gigabit Ethernet
•
1 gigabit fibre channel payload
•
1 gigabit FICON payload
•
2 gigabit fibre channel payload
•
2 gigabit FICON payload
•
D1Video payload
•
DV6000 payload
•
ETR_CLO payload
•
Gigabit Ethernet payload
•
HDTV payload
•
ISC1 payload
•
ISC3 payload
•
Any pass through (2R) payload
ROLE
The port role in Y-cable protection (WORK or PROT). Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
A port status in Y-cable protection (ACT or STBY). Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
NAME
Identifies the port name. String. Optional
LBCL
Displays the current value of the laser current. Float. Optional
OPT
Displays the current value of the transmitted optical power. Float. Optional
OPR
Displays the current value of the received optical power. Float. Optional
FREQ
Optional. Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Optional. Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.4 RTRV-<MOD_RING>
Retrieve Bidirectional Line Switched Ring
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600
This command retrieves the BLSR information of the NE. A two-fiber or four-fiber BLSR can be retrieved.
Note
Output examples:
4F BLSR
"BLSR-N43AB::RINGID=N43AB,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,SRVRTV=Y,
SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,EASTPROT=FAC-12-1,
WESTPROT=FAC-13-1"2F BLSR
"BLSR-N12EF::RINGID=N12EF,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1"The following actions will return error messages:
•
•
•
Note
•
•
CategoryBLSR
SecurityRetrieve
Related Commands
Input FormatRTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input ExampleRTRV-BLSR:PETALUMA:ALL:123;
Input Parameters
Table 21-7 RTRV-<MOD_RING> Input Parameters
AID
Access identifier from the "AidUnionId1" section. Identifies the BLSR of the NE. Only ALL, null or a list of BLSR-# in AID are allowed. A null value is equivalent to ALL
Output FormatSID 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>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BLSR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,SRVRTV=Y,SRVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,EASTPROT=FAC-12-1,WESTPROT=FAC-13-1"
;Output Parameters
Table 21-8 RTRV-<MOD_RING> Output Parameters
AID
Access identifier from the "AidUnionId1" section. Identifies the BLSR of the NE. Optional
RINGID
The BLSR ID of the NE up to six characters. Valid characters are A-Z and 0-9. String. Optional
NODEID
The BLSR node ID of the NE. NODEID ranges from 0 to 31. String. Optional
MODE
Mode with which the command is to be implemented. Identifies the BLSR mode; either two-fiber or four-fiber. Optional
Parameter type is BLSR_MODE—BLSR mode
•
Two-fiber BLSR
•
Four-fiber BLSR
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. RVTM is not allowed to be set while "RVRTV" is N
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
SRVRTV
The span revertive mode for four-fiber BLSR only
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SRVTM
The span revertive time for four-fiber BLSR only. SRVTM is not allowed to be set while SRVRTV is N
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
EASTWORK
East working facility. AID from the "FACILITY" section
WESTWORK
West working facility. AID from the "FACILITY" section
EASTPROT
East protecting facility. AID from the "FACILITY" section
WESTPROT
West protecting facility. AID from the "FACILITY" section
21.5 RTRV-<OCN_TYPE>
Retrieve (OC3, OC12, OC48, OC192)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the attributes (for example, service parameters) and the state of an OC-N facility.
See Table 27-1 for supported modifiers by platform.
Both RINGID and BLSRTYPE identify the OC-N port connected with a BLSR. These attributes are only presented for the OC-12, OC-48, OC-192 ports within a BLSR connection. The RTRV-<MOD_RING> command with the AID BLSR-RINGID, can provide more information on this BLSR.
Note
UNI-C DCC provisioning notes:
1.
2.
3.
4.
5.
6.
7.
8.
CategoryBLSR
SecurityRetrieve
Related Commands
Input FormatRTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-OC48:PENNGROVE:FAC-6-1:236;
Input Parameters
Table 21-9 RTRV-<OCN_TYPE> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>],
[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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:DCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SONET,WVLEN=1310.00,RINGID=43,
BLSRTYPE=WESTWORK,MUX=E2,UNIC=Y,
SOAKLEFT=\"12-25\",SSMRCV=STU,OSPF=Y,LDCC=Y,NAME=\"OCN PORT\",LBCL=10.0,
OPT=10.0,OPR=10.0,EXPTRC=\"AAA\",TRC=\"AAA\",TRCMODE=MAN,
TRCFORMAT=16-BYTE,ADMSSM=PRS,SENDDUSFF=N,AISONLPBK=AIS_ON_LPBK_ALL,
FREQ=1550,LOSSB=LR-1,FOREIGNFEND=Y,
FOREIGNIPADDRESS=10.92.63.44,:OOS-AU,AINS"
;Output Parameters
Table 21-10 RTRV-<OCN_TYPE> Output Parameters
AID
Access identifier from the "FACILITY" section
ROLE
An OCn port role. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
An OCn port status. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
DCC
Indicates whether or not the section DCC is to be used. Optional
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
AREA
Area ID. Shows up only if the DCC is enabled. String. Optional
TMGREF
The termination to be used, whether primary or secondary. Identifies if an OCn port has a timing reference. Defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SYNCMSG
Synchronization status message
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
SENDDUS
The facility will send the DUS (Don't use for Synchronization) value in 0x0f bits pattern as the sync status message for that facility. Defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
PJMON
Identifies an OCn port PJMON. Defaults to 0 (zero). Integer. Optional
SFBER
An OCn port signal failure threshold. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
An OCn port signal degrade threshold. Defaults 1E-7. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
MODE
OCn port mode. Defaults to SONET. Optional
Parameter type is OPTICAL_MODE—the facility's optical mode
•
SDH/ETSI optical mode using European/International format
•
SONET/ANSI optical mode using the American format
WVLEN
An OCn port wavelength in nanometers. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. Float. Optional
RINGID
The BLSR RINGID with which the port is connected. RINGID ranges from 0 to 9999. Integer. Optional
BLSRTYPE
The BLSR type with which the port is connected. Optional
Parameter type is BLSR_TYPE—BLSR type of an OCn port
•
The OCn port is an east protecting port
•
The OCn port is an east working port
•
The OCn port is an west protecting port
•
The OCn port is an west working port
MUX
BLSR extension byte. Optional
Parameter type is MUX_TYPE—BLSR extension byte
•
E2 byte (orderwire)
•
F1 byte (user)
•
K3 byte
•
Z2 byte
UNIC
Indicates if the port connects to the UCP. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1-minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
SSMRCV
Displays the quality of the individual port. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
OSPF
The open shortest path first protocol. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
LDCC
The line DCC connection on the port. Optional
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
NAME
Name. String. Optional
LBCL
Displays the current value of the laser current. Float. Optional
OPT
Displays the current value of the transmitted optical power. OPT is only displayed for DWDM cards. Float. Optional
OPR
Received optical power. Float
EXPTRC
Expected path trace content. String. Optional
TRC
Path trace message to be transmitted. String. Optional
TRCMODE
Path trace mode. Applicable only to STS-level Paths in SONET. Defaults to the OFF mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Turn off path trace capability. Nothing will be reported
TRCFORMAT
Trace message size. Optional
Parameter type is TRCFORMAT—trace format
•
1-byte trace message
•
16-byte trace message
•
64-byte trace message
•
Enable an attribute
ADMSSM
SSM selectable value. Only displayed when SSM is disabled. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
SENDDUSFF
Indicates that the facility will send the DUS (Don't use for synchronization) value in 0xff bits pattern as the sync status message for that facility. Defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
AISONLPBK
AIS on loopback. Optional
Parameter type is AIS_ON_LPBK—Indicates if AIS is sent on a loopback
•
AIS is sent on facility loopbacks
•
AIS is sent on all loopbacks
•
AIS is not sent on loopbacks
•
AIS is sent on terminal loopbacks
FREQ
Optional. Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Optional. Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
FOREIGNFEND
Indicates whether the far-end NE on the DCC is a foreign NE. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
FOREIGNIPADDRESS
The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. String. Optional
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.6 RTRV-<PATH>
Retrieve (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the attributes associated with an STS/VT path.
See Table 27-1 for supported modifiers by platform.
Supported AIDs are: ALL, SLOT-N (N=1,2,...,ALL), and STS/VT-specific AIDs.
The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and UPSRPTHSTATE parameters only apply to path protection.
The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SONET STS Path overhead.
The EXPTRC indicates the contents of the expected incoming path trace are provisioned by the user in the ED-STS_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode performs the comparison of the received string with the user entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.
J1 (EXPTRC) is implemented on the DS1/DS1N, DS3E/DS3NE, DS3XM, EC1, DS3-EC1-48, OC3, OC48AS, OC192, MRC-12 and OC192-XFP cards.
TRC and INCTRC are supported on DS1N, DS3NE, DS3-EC1-48 and DS3XM cards.
The following actions will result in error messages:
•
•
Note
•
•
•
•
•
•
•
CategoryPaths
SecurityRetrieve
Related Commands
Input FormatRTRV-<PATH>:[<TID>]:<AID>:<CTAG>[:::BLSRPTHTYPE=<BLSRPTHTYPE>][:];
Input ExampleRTRV-STS3C:FERNDALE:STS-2-1-4:238:::BLSRPTHTYPE=NON-PCA;
Input Parameters
Table 21-11 RTRV-<PATH> Input Parameters
AID
Access identifier from the "CrossConnectId1" section. Must not be null
BLSRPTHTYPE
The BLSR path type only if the port is on the BLSR. Defaults to NON-PCA. Applicable only to STS-level paths in SONET. A null value defaults to NON-PCA
Parameter type is BLSR_PTH_TYPE—BLSR path type only if the port is on the BLSR
•
The AID is on the working path, or the cross-connection card protection path
•
The AID is on the BLSR PCA path
Output FormatSID 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=<C2>],
[BLSRPTHSTATE=<BLSRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-2-1-4::LEVEL=STS1,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TRCFORMAT=64-BYTE,TACC=8,
TAPTYPE=DUAL,UPSRPTHSTATE=ACT,C2=0X04,
BLSRPTHSTATE=PROTPTHACT:OOS-AU,AINS"
;Output Parameters
Table 21-12 RTRV-<PATH> Output Parameters
AID
Access identifier from the "CrossConnectId1" section
LEVEL
The rate of the cross-connect. Indicates the rate of the cross-connected channel. Applicable only to STS path in SONET. Optional
Parameter type is PATH—modifier for path commands
•
Synchronous transport signal/module level-1 (51.84 Mbps)
•
Synchronous transport signal/module level-3 concatenated (155.52 Mbps)
•
Synchronous transport signal/module level-6 (311.04 Mbps)
•
Synchronous transport signal/module level-9 concatenated (466.56 Mbps)
•
Synchronous transport signal/module level-12 concatenated (622.08 Mbps)
•
Synchronous transport signal/module level-18 concatenated (933.12 Mbps)
•
Synchronous transport signal/module level-24 concatenated (1244.16 Mbps)
•
Synchronous transport signal/module level-36 concatenated (1866.24 Mbps)
•
Synchronous transport signal/module level-48 concatenated (2488.32 Mbps)
•
Synchronous transport signal/module level-192 concatenated (9953.28 Mbps)
SFBER
An STS path signal failure threshold which only applies to path protection. Applicable only to STS-level paths in SONET. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
An STS path signal degrade threshold which only applies to path protection. Applicable only to STS-level paths in SONET. Defaults 1E-6. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
RVRTV
Revertive mode. Only applies to path protection. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Only applies to path protection
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
SWPDIP
Switch on PDI-P. Applicable only to STS-level paths in SONET. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
HOLDOFFTIMER
Hold off timer. Integer. Optional
EXPTRC
Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). Applicable to STS-level paths in SONET. Defaults to NULL when path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. String. Optional
TRC
The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to STS-level paths in SONET. Applicable to VT-level paths for the DS3XM-12 card on the ONS 15454. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. String. Optional
INCTRC
The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to STS-level paths in SONET (STSn). Defaults to Null when a path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. String. Optional
TRCMODE
Path trace mode. Applicable only to STS-level paths in SONET (STSn). Defaults to OFF when a path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string (not applicable to MXP_2.5G_10G and TXP_MR_10G cards)
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected
•
Turn off path trace capability. Nothing will be reported
TRCFORMAT
Trace message size. Optional
Parameter type is TRCFORMAT—trace format
•
1-byte trace message
•
16-byte trace message
•
64-byte trace message
•
Enable an attribute
TACC
Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N. Not applicable to the ONS 15310-CL. Optional
TAPTYPE
TAP type. Not applicable to the ONS 15310-CL. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
UPSRPTHSTATE
Indicates whether a given AID is the working or standby path of a path protection cross-connect. Optional
Parameter type is STATUS—status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
C2
The c2 byte hex code. Applicable only to STS-level paths in SONET (STSn). Optional
Parameter type is C2_BYTE—c2 byte hex code
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured STS-1 SPE
•
Locked VT Mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream
BLSRPTHSTATE
The BLSR path state only if the port is on the BLSR. Applicable only to STS-level paths in SONET (STSn). Optional
Parameter type is BLSR_PTH_STATE—the BLSR path state only if the port is on the BLSR
•
Indicates the BLSR is un-switched and its PCA path is in the active state
•
Indicates the BLSR is switched and its PCA path is in the standby state
•
Indicates the BLSR is switched and its protection path is in the active state
•
Indicates the BLSR is not switched and its working path is in the active state
•
Indicates the BLSR is switched and its working path is in the standby state
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.7 RTRV-10GIGE
Retrieve 10GIGE
Usage Guidelines
Cisco ONS 15454
This command retrieves the 10 Gbps-specific parameters for a port that has been configured to support the gigabyte Ethernet payload with the ENT-10GIGE command.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-10GIGE:TID:FAC-1-1:100;
Input Parameters
Table 21-13 RTRV-10GIGE Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:NAME=\"NY PORT\",MACADDR=00-0E-AA-BB-CC-FF,LBCL=10.0,
OPT=10.0,OPR=10.0,FREQ=1550,LOSSB=SX:OOS-AU,AINS"
;Output Parameters
Table 21-14 RTRV-10GIGE Output Parameters
AID
Access identifier from the "FACILITY" section
ROLE
The port role in Y-cable protection (WORK or PROT). Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
A port status in Y-cable protection (ACT or STBY). Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
NAME
Port name. String. Optional
MACADDR
The MAC address for the 10 gigabyte Ethernet payload. String. Optional
LBCL
Displays the current value of the laser current. Float. Optional
OPT
Displays the current value of the transmitted optical power. Float. Optional
OPR
Displays the current value of the received optical power. Float. Optional
FREQ
Optional. Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Optional. Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.8 RTRV-ALM-<MOD2ALM>
Retrieve Alarm (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS1, E100, E1000, E3, E4, EC1, FSTE, G1000, GFPOS, GIGE, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC12, VC3, VCG, VT1, VT2, WLEN)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves and sends the current status of alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
See Table 27-1 for supported modifiers by platform.
Note
Note
CategoryFault
SecurityRetrieve
Related Commands
Input FormatRTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input ExampleRTRV-ALM-OC12:ELDRIDGE:FAC-5-1:225::MN,SD,SA;
Input Parameters
Table 21-15 RTRV-ALM-<MOD2ALM> Input Parameters
AID
Access identifier from the "AidUnionId" section. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1,OC12:MJ,SD,SA,09-05,12-30-20,,:\"BER AT SIGNAL DEGRADE LEVEL\","
;Output Parameters
Table 21-16 RTRV-ALM-<MOD2ALM> Output Parameters
AID
Access identifier from the "ALL" section
AIDTYPE
Type of access identifier. Optional
Parameter type is MOD2ALM—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
Client facility for MXP/TXP cards
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
Generic framing protocol over packet over SONET virtual port alarm
•
GIG Ethernet port alarm
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
T1 alarm
•
T3 alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual Concatenation Group alarm
•
VT1 alarm
•
VT2 alarm
•
Wavelength Path Provisioning
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
21.9 RTRV-ALM-ALL
Retrieve Alarm All
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves and sends the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
According to GR-833, the RTRV-ALM-ALL command only reports EQPT, COM, and rr (T1, T3, OCN, EC1, STSN, VT1, DS1, E100, E1000, G1000, ML-Series, TXP and MXP) alarms.
To retrieve all the NE alarms, issue all of the following commands:
RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-ENV
RTRV-ALM-SYNCNCategoryFault
SecurityRetrieve
Related Commands
Input FormatRTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<CONDITION>],
[<SRVEFF>][,,,];Input ExampleRTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA;
Input Parameters
Table 21-17 RTRV-ALM-ALL Input Parameters
AID
Access identifier from the "ALL" section. A null value is equivalent to ALL. String
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDITION
The type of alarm condition. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output FormatSID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>],[<AIDDET>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,,,,:\"POWER FAIL RESTART\",DS1-14"
;Output Parameters
Table 21-18 RTRV-ALM-ALL Output Parameters
AID
Access identifier from the "ALL" section. Optional
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
DESC
A condition description. String. Optional
AIDDET
AIDDET uses the same addressing rules as the AID, but specifies AID type and additional details about the entity being managed. The supplementary equipment identification. Optional
21.10 RTRV-ALM-BITS
Retrieve Alarm Building Integrated Timing Supply
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves and sends the current status of alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.
CategorySynchronization
SecurityRetrieve
Related Commands
Input FormatRTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input ExampleRTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Input Parameters
Table 21-19 RTRV-ALM-BITS Input Parameters
AID
Access identifier from the "BITS" section. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
The condition type for an alarm or reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,,,,:\"LOSS OF SIGNAL\","
;Output Parameters
Table 21-20 RTRV-ALM-BITS Output Parameters
AID
Access identifier from the "BITS" section. Optional
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
DESC
A condition description. String. Optional
21.11 RTRV-ALM-ENV
Retrieve Alarm Environment
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the environmental alarms.
CategoryEnvironment
SecurityRetrieve
Related Commands
Input FormatRTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input ExampleRTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-21 RTRV-ALM-ENV Input Parameters
AID
Access identifier from the "ENV" section. Must not be null
Note
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
ALMTYPE
The alarm type for the environmental alarm. A null value is equivalent to ALL
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High airflow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnected bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,08-01,14-25-59,\"OPEN DOOR\""
;Output Parameters
Table 21-22 RTRV-ALM-ENV Output Parameters
AID
Access identifier from the "ENV" section
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
ALMTYPE
The alarm type for the environmental alarm. A null value is equivalent to ALL
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High airflow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnected bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
OCRDAT
Date. Optional
OCRTM
Time. Optional
DESC
A condition description. String. Optional
21.12 RTRV-ALM-EQPT
Retrieve Alarm Equipment
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves and sends the current status of alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
CategoryEquipment
SecurityRetrieve
Related Commands
Input FormatRTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input ExampleRTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;
Input Parameters
Table 21-23 RTRV-ALM-EQPT Input Parameters
AID
Access identifier from the "EQPT" section. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
The condition type for an alarm or a reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output FormatSID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,EQPT:MJ,HITEMP,NSA,08-01,14-25-59,,:\"HI TEMPERATURE\","
;Output Parameters
Table 21-24 RTRV-ALM-EQPT Output Parameters
AID
Access identifier from the "EQPT" section. Optional
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date. Optional
OCRTM
Time. Optional
DESC
A condition description. String. Optional
21.13 RTRV-ALM-SYNCN
Retrieve Alarm Synchronization
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves and sends the current status of alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
CategorySynchronization
SecurityRetrieve
Related Commands
Input FormatRTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input ExampleRTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Input Parameters
Table 21-25 RTRV-ALM-SYNCN Input Parameters
AID
Access identifier from the "SYNC_REF" section. Must not be null
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
The condition type for an alarm or a reported event. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL
•
The condition is non-service affecting
•
The condition is service affecting
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:CR,FAILTOSW,SA,08-01,
14-25-59,,:\"FAILURE TO SWITCH TO PROTECTION\","
;Output Parameters
Table 21-26 RTRV-ALM-SYNCN Output Parameters
AID
Access identifier from the "SYN" section
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date. Optional
OCRTM
Time. Optional
DESC
A condition description. String. Optional
21.14 RTRV-ALMTH-<MOD2>
Retrieve Alarm Threshold (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15310-CL
This command retrieves the alarm threshold values. The only applicable MOD2 values are OC3, OC12, OC48, OC192, OCH, OMS, and OTS.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<CONDTYPE>][,,::];
Input ExampleRTRV-ALMTH-{MOD2}::CHAN-2-2:1::OPT-HIGH;
Input Parameters
Table 21-27 RTRV-ALMTH-<MOD2> Input Parameters
AID
Access identifier from the "ALL" section. Must not be null
CONDTYPE
Alarm threshold. A null value is equivalent to ALL
Parameter type is ALM_THR—alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards
•
Battery Voltage - Extremely High
•
Battery Voltage - Extremely Low
•
Battery Voltage - High
•
Battery Voltage - Low
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]
•
Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]
•
Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm
•
Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]
•
Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>:<CONDTYPE>,,,<THLEVEL>";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,OCH:OPT-HIGH,,,20"
;Output Parameters
Table 21-28 RTRV-ALMTH-<MOD2> Output Parameters
AID
Access identifier from the "ALL" section
MOD
AID type
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
CONDTYPE
Condition type for an alarm or a reported event
Parameter type is ALM_THR—alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards
•
Battery Voltage - Extremely High
•
Battery Voltage - Extremely Low
•
Battery Voltage - High
•
Battery Voltage - Low
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]
•
Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]
•
Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm
•
Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]
•
Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
THLEVEL
Threshold level. Float
21.15 RTRV-ALMTH-EQPT
Retrieve Alarm Threshold Equipment
Usage Guidelines
Cisco ONS 15454
This command retrieves the alarm thresholds for the power level monitoring on an NE.
CategoryEquipment
SecurityRetrieve
Related Commands
Input FormatRTRV-ALMTH-EQPT:[<TID>]:<AID>:<CTAG>::[<CONDTYPE>][,,::];
Input ExampleRTRV-ALMTH-EQPT:::1::BATV-HIGH;
Input Parameters
Table 21-29 RTRV-ALMTH-EQPT Input Parameters
AID
Access identifier from the "CHANNEL" section
CONDTYPE
Must not be null
Parameter type is ALM_THR—alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards
•
Battery Voltage - Extremely High
•
Battery Voltage - Extremely Low
•
Battery Voltage - High
•
Battery Voltage - Low
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]
•
Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]
•
Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm
•
Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]
•
Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
Output FormatSID DATE TIME
M CTAG COMPLD
",<MOD2B>:<CONDTYPE>,,,<DNFIELD>";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
",EQPT:BATV-HIGH,,,-52.0,"
;Output Parameters
21.16 RTRV-ALS
Retrieve Automatic Laser Shutoff
Usage Guidelines
Cisco ONS 15454, 15310-CL
This command retrieves the ALS attributes of an OC-N facility and all the facilities that support the ALS feature. This command is used to retrieve the ALS parameter of the OC48 and OC192 ports on the MXP_2.5G_10E, TXP_MR_10E, TXP_MR_2.5G, TXPP_MR_2.5G, MXP_2.5G_10G, and TXP_MR_10G cards
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-ALS:PENNGROVE:FAC-1-1:1;
Related Commands
Table 21-31 RTRV-ALS Input Parameters
AID
Access identifier from the "AidUnionId" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>],
[ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1,OC192::ALSMODE=DISABLED,ALSRCINT=100,ALSRCPW=2.0,LSRSTAT=ON:"
;Output Parameters
Table 21-32 RTRV-ALS Output Parameters
AID
Access identifier from the "AidUnionId" section
AIDTYPE
Type of access identifier
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
ALSMODE
ALS is enabled or disabled
Parameter type is ALS_MODE—the working mode for automatic laser shutdown
•
Automatic
•
Disabled
•
Manual
•
Manual restart for test
ALSRCINT
ALS recovery interval. The range is 60 to 300 seconds. Integer. Optional
ALSRCPW
ALS recovery pulse width. The range is 2.0 to 100.00 seconds, in increments of 100 ms. Float. Optional
LSRSTAT
Status of the laser. Optional
Parameter type is LASER_STATUS—laser status
•
Laser is switched on but is working automatic power reduction
•
Laser is switched off
•
Laser is switched on
21.17 RTRV-APC
Operate Amplification Power Control
Usage Guidelines
Cisco ONS 15454
This command retrieves the APC application attributes.
CategoryDWDM
SecurityMaintenance
Related Commands
Input FormatRTRV-APC:[<TID>]::<CTAG>;
Input ExampleRTRV-APC:PENNGROVE::114;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"::[APCENABLE=<APCENABLE>],[APCSTATE=<APCSTATE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"::APCENABLE=Y,APCSTATE=WORKING"
;Output Parameters
21.18 RTRV-ATTR-CONT
Retrieve Attribute Control
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves and sends the attributes associated with an external control. These attributes are used when an external control is operated or released. To set these attributes, use the SET-ATTR-CONT command.
CategoryEnvironment
SecurityRetrieve
Related Commands
OPR-ACO-ALL
OPR-EXT-CONT
REPT ALM ENV
REPT EVT ENV
RLS-EXT-CONT
RTRV-ALM-ENV
RTRV-ATTR-ENV
RTRV-COND-ENV
RTRV-EXT-CONT
SET-ATTR-CONT
SET-ATTR-ENV
SET-ATTR-SECUDFLT
Input FormatRTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input ExampleRTRV-ATTR-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Input Parameters
Table 21-35 RTRV-ATTR-CONT Input Parameters
AID
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. Must not be null
CONTTYPE
Environmental control type. A null value is equivalent to ALL
Parameter type is CONTTYPE—Environmental control types
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND"
;Output Parameters
Table 21-36 RTRV-ATTR-CONT Output Parameters
AID
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. Must not be null
CONTTYPE
Environmental control type. A null value is equivalent to ALL
Parameter type is CONTTYPE—Environmental control types
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
21.19 RTRV-ATTR-ENV
Retrieve Attribute Environment
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the attributes associated with an environmental alarm.
CategoryEnvironment
SecurityRetrieve
Related Commands
OPR-ACO-ALL
OPR-EXT-CONT
REPT ALM ENV
REPT EVT ENV
RLS-EXT-CONT
RTRV-ALM-ENV
RTRV-ATTR-CONT
RTRV-COND-ENV
RTRV-EXT-CONT
SET-ATTR-CONT
SET-ATTR-ENV
SET-ATTR-SECUDFLT
Input FormatRTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input ExampleRTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-37 RTRV-ATTR-ENV Input Parameters
AID
Access identifier from the "ENV" section. Must not be null
NTFCNCDE
Two-letter notification code
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
ALMTYPE
The alarm type for the environmental alarm. A null value is equivalent to ALL
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail, or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High airflow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:[<NTFCNCDE>],[<ALMTYPE>],[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,\"OPEN DOOR\""
;Output Parameters
Table 21-38 RTRV-ATTR-ENV Output Parameters
AID
Access identifier from the "ENV" section. Must not be null
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
ALMTYPE
The alarm type for the environmental alarm. Optional
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High airflow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
DESC
Alarm description. String. Optional
21.20 RTRV-AUDIT-LOG
Retrieve Audit Log
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the contents of the audit log stored in the NE. Audit records contain information for user operations such as login, logout, change of provisioning parameters and other changes a user might make when connected to the NE. Audit records do not store operations related to parameter retrieval.
CategoryLog
SecurityRetrieve
Related Commands
Input FormatRTRV-AUDIT-LOG:[<TID>]::<CTAG>;
Input ExampleRTRV-AUDIT-LOG:::1;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
" <ENTRYNUM>,<OCRDAT>,<OCRTM>,<TASKID>,<TXSTATUS>,<DESCRIPTION>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
" 17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,
\17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,\"DESCRIPTION\""
;Output Parameters
21.21 RTRV-BFDLPM-<MOD2>
Retrieve BFDL Performance Monitoring (DS1, T1)
Usage Guidelines
Cisco ONS 15454
This command retrieves the BFDL (enhanced 24-hour ES, UAS, BES, CSS and LOFC) performance monitoring parameters and applies to the DS3XM-12 card DS1 under BFDL mode. This command returns the current 15-minute and current 24-hour BFDL PMs and the 96 15-minute history requested type PMs.
For example:
Input:
RTRV-BFDLPM-DS1::DS1-14-1-1:1:::REQTYPE=ENH-24HR-ES;
Output:
DS1-14-1-1:ES,30,CURR-15MIN-INV DS1-14-1-1:UAS,40,CURR-15MIN-INV DS1-14-1-1:BES,50,CURR-15MIN-INV DS1-14-1-1:SES,60,CURR-15MIN-INV DS1-14-1-1:CSS,70,CURR-15MIN-INV DS1-14-1-1:LOFC,80,CURR-15MIN-INV DS1-14-1-1:ES,30,CURR-24HR-INV DS1-14-1-1:UAS,40,CURR-24HR-INV DS1-14-1-1:BES,50,CURR-24HR-INV DS1-14-1-1:SES,60,CURR-24HR-INV DS1-14-1-1:CSS,70,CURR-24HR-INV DS1-14-1-1:LOFC,80,CURR-24HR-INV DS1-14-1-1:ES,30,1-15MIN-INV DS1-14-1-1:ES,40,2-15MIN-INV
DS1-14-1-1:ES,50,3-15MIN-INV
DS1-14-1-1:ES,80,96-15MIN-INVSending this command with a REQTYPE of ENH-24HR-CSS-AND-LOFC will retrieve 96 15-minute PMs for both CSS and LOFC. The command is applied on the DS3XM-12 DS1 under BFDL mode, ESF frame format, C-BIT IS port with an IS VT circuit configuration.
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-BFDLPM-<MOD2>:[<TID>]:<AID>:<CTAG>:::REQTYPE=<REQTYPE>;
Input ExampleRTRV-BFDLPM-DS1:TID:DS1-14-1-1:123:::REQTYPE=ENH-24HR-ES;
Input Parameters
Table 21-41 RTRV-BFDLPM-<MOD2> Input Parameters
AID
Access identifier from the "DS1" section. Must not be null
REQTYPE
Indicates requested BFDL PM type. Must not be null
Parameter type is REQTYPE—requested PM type
•
The enhanced 24-hour BES performance data
•
The enhanced 24-hour CSS-AND-LOFC performance data
•
The enhanced 24-hour ES performance data
•
The enhanced 24-hour SES performance data
•
The enhanced 24-hour UAS performance data
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<MONTYPE>,<MONVAL>,<BUCKET>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"DS1-14-1-1:ES,55,CURR-15MIN-INV"
;Output Parameters
Table 21-42 RTRV-BFDLPM-<MOD2> Output Parameters
AID
Access identifier from the "DS1" section
MONTYPE
Monitored type which includes: BES, CSS, ES, LOFC, SES, UAS. String
MONVAL
The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. String
BUCKET
The BIN of each BFDL PM. String
21.22 RTRV-BITS
Retrieve Building Integrated Timing Supply
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the BITS configuration command. For BITS facility, 64 K and 6 MHz are only applicable to the ONS 15454. SSM selectable (ADMSSM) is not applicable to the ONS 15600.
CategorySynchronization
SecurityRetrieve
Related Commands
ED-BITS
ED-NE-SYNCN
ED-SYNCN
OPR-SYNCNSW
REPT ALM BITS
REPT ALM SYNCN
REPT EVT BITS
REPT EVT SYNCN
RLS-SYNCNSW
RTRV-ALM-BITS
RTRV-ALM-SYNCN
RTRV-COND-BITS
RTRV-COND-SYNCN
RTRV-NE-SYNCN
RTRV-SYNCN
Input FormatRTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-BITS:SONOMA:BITS-1:782;
Input Parameters
Table 21-43 RTRV-BITS Input Parameters
AID
Access identifier from the "BITS" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1::LINECDE=AMI,FMT=ESF,LBO=0-133,SYNCMSG=N,AISTHRSHLD=PRS,
SABIT=BYTE-4,IMPEDANCE=120-OHM,BITSFAC=T1,ADMSSM=PRS:IS"
;Output Parameters
Table 21-44 RTRV-BITS Output Parameters
AID
Access identifier from the "BITS" section
LINECDE
Line code. Optional
Parameter type is LINE_CODE—line code
•
Line code value is AMI
•
Line code value is B8ZS (bipolar with three-zero substitution)
FMT
Digital signal frame format. Optional
Parameter type is FRAME_FORMAT—frame format for a T1 port
•
Frame format is D4
•
Frame format is ESF
•
Frame format is unframed
LBO
Line build out settings. BITS line build out. Default value is 0 to 133. Integer. Optional
Parameter type is BITS_LineBuildOut—BITS line buildout
•
BITS line buildout range is 0-133
•
BITS line buildout range is 134-266
•
BITS line buildout range is 267-399
•
BITS line buildout range is 400-533
•
BITS line buildout range is 534-655
SYNCMSG
Indicates if the BITS facility supports synchronization status message. Default is on (Y)
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
AISTHRSHLD
Alarm indication signal threshold. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
SABIT
When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. Optional
Parameter type is SABITS—SA BITS
•
SABIT is BYTE-4
•
SABIT is BYTE-5
•
SABIT is BYTE-6
•
SABIT is BYTE-7
•
SABIT is BYTE-8
IMPEDANCE
When the frame format selection is E1, IMPEDANCE is the terminal impedance of the BITS-IN port. Optional
Parameter type is IMPEDANCE—the terminal impedance of the BITS-IN port
•
Impedance of 120 ohms
•
Impedance of 75 ohms
BITSFAC
BITS facility settings. Optional
Parameter type is BITS_FAC—BITS facility rate. 64 K and 6 MHz are only applicable to the ONS 15454
•
2 MHz rate
•
64 K rate
•
6 MHz rate
•
E1 rate
•
T1 rate
ADMSSM
SSM selectable. Only applicable to BITS-IN when SSM is disabled. Optional
Note
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
PST
Primary state. Optional
Parameter type is PST—indicates the current overall service condition of an entity
•
In service
•
Out of service
21.23 RTRV-BULKROLL<OCN_TYPE>
Retrieve Bulkroll (OC12, OC192, OC3, OC48)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600
This command retrieves roll data parameters on a line.
See Table 27-1 for supported modifiers by platform.
CategoryBridge and Roll
SecurityProvisioning
Related Commands
Input FormatRTRV-BULKROLL-<OCN_TYPE>:[<TID>]:<SRC>:<CTAG>;
Input ExampleRTRV-BULKROLL-OC12:CISCO:FAC-3-1:1;
Input Parameters
Table 21-45 RTRV-BULKROLL-<OCN_TYPE> Input Parameters
SRC
Source AID from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],VLDSIG=<VLDSIG>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-3-1-1:RFROM=STS-3-1-1,RTO=STS-5-1-1,RMODE=AUTO,VLDSIG=Y"
;Output Parameters
Table 21-46 RTRV-BULKROLL-<OCN_TYPE> Output Parameters
FROM
One of the end points. Access identifier from the "FACILITY" section for line level rolling and bulk rolling
RFROM
The termination point of the existing cross-connect that is to be rolled. The AID is from the "CrossConnectId1" section (except VCM and FACILITY)
RTO
The termination point that will become a leg of the new cross-connection. The AID is from the "CrossConnectId1" section (except VCM and FACILITY)
RMODE
The rolling mode of operation. Optional
Parameter type is ALS_MODE—specifies the working mode for the automatic laser shutdown (ALS) functionality
•
Automatic
•
Disabled
•
Manual
•
Manual Restart for Test
VLDSIG
The rolling mode of operation. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
21.24 RTRV-CMD-SECU
Retrieve Command Security
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the current command security level of the command specified in the AID field.
CategorySecurity
SecuritySuperuser
Related Commands
Input FormatRTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-CMD-SECU::INIT-REG:1;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<CAP>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"INIT-REG:MAINT"
;Output Parameters
21.25 RTRV-COND-<MOD2ALM>
Retrieve Condition (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS1, E100, E1000, E3, E4, EC1, FSTE, G1000, GFPOS, GIGE, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC12, VC3, VCG, VT1, VT2, WLEN)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the current standing condition and state associated with an entity.
See Table 27-1 for supported modifiers by platform.
CategoryFault
SecurityRetrieve
Related Commands
Input FormatRTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-T3:TID:FAC-2-1:229::LOS;
Input Parameters
Table 21-49 RTRV-COND-<MOD2ALM> Input Parameters
AID
Access identifier from the "ALL" section. Must not be null
TYPEREQ
The type of condition to be retrieved. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,T3:CR,LOS,SA,01-01,16-00-20,,,\"LOS OF SIGNAL\""
;Output Parameters
Table 21-50 RTRV-COND-<MOD2ALM> Output Parameters
AID
Access identifier from the "ALL" section
AIDTYPE
Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2ALM—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
Client facility for MXP/TXP cards
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
Generic framing protocol over packet over SONET virtual port alarm
•
GIG Ethernet port alarm
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
T1 alarm
•
T3 alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual Concatenation Group alarm
•
VT1 alarm
•
VT2 alarm
•
Wavelength Path Provisioning
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
TYPEREP
The condition itself
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition, Optional
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
Condition description. String. Optional
21.26 RTRV-COND-ALL
Retrieve Condition All
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the current standing condition for all entities.
According to GR-833, the RTRV-COND-ALL command only reports EQPT, COM, and rr (T1, T3, OCn, EC1, STSn, VT1, DS1, E100, E1000, G1000, ML-Series, TXP and MXP) alarms.
This command does not return all conditions that are returned by other, more specific RTRV-COND commands; RTRV-COND-ALL returns a subset of these conditions. GR-253-CORE, Section 6.2.1.8.4 states a retrieval that returns ALL conditions from a node (RTRV-COND-ALL) must omit any conditions that are "same root cause" as other raised conditions. The section also states any retrieval of a subset of the conditions from a node, regardless of how the subsetting occurs, should not omit these "same root cause" conditions.
RTRV-COND-STS1, for example, includes "same root cause" conditions in the set it returns and RTRV-COND-ALL does not.
To retrieve all the NE conditions, issue all of the following commands:
RTRV-COND-ALL
RTRV-COND-ENV
RTRV-COND-BITS
RTRV-COND-SYNCNCategoryFault
SecurityRetrieve
Related Commands
Input FormatRTRV-COND-ALL:[<TID>]:[<AID>]:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-ALL:TID:ALL:229::LOS;
Input Parameters
Table 21-51 RTRV-COND-ALL Input Parameters
AID
Access identifier from the "ALL" section. String. A null value is equivalent to ALL
TYPEREQ
The type of condition to be retrieved. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,OC3:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;Output Parameters
Table 21-52 RTRV-COND-ALL Output Parameters
AID
Access identifier from the "ALL" section that has an alarm condition
AIDTYPE
Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
TYPEREP
The type of condition to be retrieved
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition, Optional
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
Condition description. String. Optional
21.27 RTRV-COND-BITS
Retrieve Condition Building Integrated Timing Supply
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the standing conditions on BITS.
CategorySynchronization
SecurityRetrieve
Related Commands
Input FormatRTRV-COND-BITS:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-BITS:TID:BITS-1:229::LOS;
Input Parameters
Table 21-53 RTRV-COND-BITS Input Parameters
AID
Access identifier from the "BITS" section. Must not be null
TYPEREQ
The type of condition to be retrieved. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;Output Parameters
Table 21-54 RTRV-COND-BITS Output Parameters
AID
Access identifier from the "BITS" section that has an alarm condition
AIDTYPE
Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS2I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
TYPEREP
The type of condition to be retrieved
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition, Optional
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
Condition description. String. Optional
21.28 RTRV-COND-ENV
Retrieve Environmental Condition
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the environmental conditions.
CategoryEnvironment
SecurityRetrieve
Related Commands
Input FormatRTRV-COND-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>][,,,];
Input ExampleRTRV-COND-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-55 RTRV-COND-ENV Input Parameters
AID
Access identifier from the "ENV" section. Must not be null
Note
NTFCNCDE
Two-letter notification code. A null value is equivalent to ALL
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
ALMTYPE
The alarm type for the environmental alarm. A null value is equivalent to ALL
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High airflow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],,,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,01-01,16-02-15,,,,\"OPEN DOOR\""
;Output Parameters
Table 21-56 RTRV-COND-ENV Output Parameters
AID
Access identifier from the "ENV" section
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
ALMTYPE
The alarm type for the environmental alarm
Parameter type is ENV_ALM—environmental alarm types
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High airflow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48V power supply failure
•
-139V power converter
•
-190V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
Condition description. String. Optional
21.29 RTRV-COND-EQPT
Retrieve Condition Equipment
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the equipment conditions.
CategoryEquipment
SecurityRetrieve
Related Commands
Input FormatRTRV-COND-EQPT:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-EQPT:TID:SLOT-1:229::LOS;
Input Parameters
Table 21-57 RTRV-COND-EQPT Input Parameters
AID
Access identifier from the "EQPT" section that has an alarm condition. Must not be null
TYPEREQ
The type of condition to be retrieved. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1,EQPT:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;Output Parameters
Table 21-58 RTRV-COND-EQPT Output Parameters
AID
Access identifier from the "EQPT" section that has an alarm condition
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
TYPEREP
The type of condition to be retrieved
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition, Optional
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
Condition description. String. Optional
21.30 RTRV-COND-SYNCN
Retrieve Condition Synchronization
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the synchronization condition.
CategorySynchronization
SecurityRetrieve
Related Commands
Input FormatRTRV-COND-SYNCN:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-SYNCN:TID:SYNC-NE:229::LOS;
Input Parameters
Table 21-59 RTRV-COND-SYNCN Input Parameters
AID
Access identifier from the "SYNC_REF" section that has an alarm condition. Must not be null
TYPEREQ
The type of condition to be retrieved. A null value is equivalent to ALL
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:MJ,FRNGSYNC,SA,01-01,16-02-15,,,
\"FREE RUNNING SYNCHRONIZATION MODE\""
;Output Parameters
Table 21-60 RTRV-COND-SYNCN Output Parameters
AID
Access identifier from the "SYN" section that has an alarm condition
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. The value is always SYNCN. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
NTFCNCDE
Two-letter notification code. Optional
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
TYPEREP
The type of condition to be retrieved
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
SRVEFF
The effect on service caused by the standing alarm or condition, Optional
Parameter type is SERV_EFF—the effect of the alarm on service
•
The condition is non-service affecting
•
The condition is service affecting
OCRDAT
Date when the specific event or violation occurred. Optional
OCRTM
Time when the specific event or violation occurred. Optional
DESC
Condition description. String. Optional
21.31 RTRV-CONSOLE-PORT
Retrieve Console Port
Usage Guidelines
Cisco ONS 15454, 15310
This command retrieves the status of the console port from the ML-Series cards.
CategorySecurity
SecurityRetrieve
Related Commands
Input FormatRTRV-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-CONSOLE-PORT:CISCONODE:SLOT-2:123;
Input Parameters
Table 21-61 RTRV-CONSOLE-PORT Input Parameters
AID
Access identifier from the "EQPT" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<EQPT>:[PORT=<PORT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2:PORT=ENABLED"
;Output Parameters
21.32 RTRV-CRS
Retrieve Cross-Connect
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves all the cross-connections based on the required PATH types.
Note
•
•
•
•
•
CategoryCross Connections
SecurityRetrieve
Related Commands
Input FormatRTRV-CRS:[<TID>]:[<AID>]:<CTAG>:::[CRSTYPE=<CRSTYPE>][:];
Input ExampleRTRV-CRS:CISCO:ALL:123:::CRSTYPE=STS;
Input Parameters
Table 21-63 RTRV-CRS Input Parameters
AID
Access identifier from the "CrossConnectId1" section that can be facility, STS, VT or ALL. The ALL AID defaults to NE, which means it reports all the existing cross-connections on the NE. A null value is equivalent to ALL
CRSTYPE
The cross-connection type. Defaults to all existing cross-connections. A null value is equivalent to ALL
Parameter type is PATH—modifier for path commands
•
Synchronous transport signal/module level-1 (51.84 Mbps)
•
Synchronous transport signal/module level-3 concatenated (155.52 Mbps)
•
Synchronous transport signal/module level-6 (311.04 Mbps)
•
Synchronous transport signal/module level-9 concatenated (466.56 Mbps)
•
Synchronous transport signal/module level-12 concatenated (622.08 Mbps)
•
Synchronous transport signal/module level-18 concatenated (933.12 Mbps)
•
Synchronous transport signal/module level-24 concatenated (1244.16 Mbps)
•
Synchronous transport signal/module level-36 concatenated (1866.24 Mbps)
•
Synchronous transport signal/module level-48 concatenated (2488.32 Mbps)
•
Synchronous transport signal/module level-192 concatenated (9953.28 Mbps)
•
Virtual Tributary 1 (SONET). Virtual Channel 11 (SDH)
•
Virtual Tributary 2 (SONET). Virtual Channel 12 (SDH)
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<CCT>,<CRSTYPE>:[DRITYPE=<DRITYPE>],[DRINODE=<SYNCSW>],
[CKTID=<CKTID>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-5-1-2&STS-6-1-2,STS-12-1-2&STS-13-1-2:1WAYDC,STS1:DRITYPE=BLSR,
DRINODE=PRI,CKTID=CKTID:OOS-AU,AINS"
;Output Parameters
Table 21-64 RTRV-CRS Output Parameters
SRC
Source access identifier from the "CrossConnectId" section. Indicates the source AID(s) of the cross-connection. Listable
DST
Destination AID of the cross-connection from the "CrossConnectId" section. Listable
CCT
Type of connection. Used for specifying one or two-way connections
Parameter type is CCT—type of cross-connect to be created
•
A unidirectional connection from a source tributary to a destination tributary
•
Path Protection multicast drop with (1-way) continue
•
Path Protection multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A Bidirectional Drop and Continue connection applicable only to Path Protection Traditional and Integrated Dual Ring InterConnections
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (BLSR PCA diagnostics cross-connect)
CRSTYPE
The cross-connection type
Parameter type is CRS_TYPE—cross-connection type
•
Indicates all the STS cross-connections
•
STS1 cross-connect
•
STS3C cross-connect
•
STS6C cross-connect
•
STS9C cross-connect
•
STS12C cross-connect
•
STS18C cross-connect
•
STS24C cross-connect
•
STS36C cross-connect
•
STS48C cross-connect
•
STS192C cross-connect
•
Indicates all the VT1 cross-connections
•
VT1 cross-connect
•
VT2 cross-connect
DRITYPE
The DRI connection type. It is applied only if the cross-connection is a drop-and-continue connection type (1WAYDC or 2WAYDC), and defaults to path protection for the DRI configuration. Optional
Parameter type is DRITYPE—DRI type
•
BLSR DRI type
•
Path Protection DRI type
•
Path Protection-BLSR hand off DRI type
SYNCSW
Synchronization switch AID from the "SYNCSW" section. Optional
CKTID
Circuit identification parameter that contains a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. String. Optional
PST_PSTQ
Primary state and primary state qualifier separated by a colon
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
One or more secondary states separated by "&", in alphabetical order. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.33 RTRV-CRS-<PATH>
Retrieve Cross-Connect (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves any connections associated with the entered AID(s) or AID range. The information on both ends is returned along with the type of connection.
See Table 27-1 for supported modifiers by platform.
Note
–
from points: F1, F2
to points: T1
the output will be:
1-way
"F1&F2,T1:CCT,STS3C"
2-way
If retrieved on point F1 or F2, the output format is the same as the 1-way output.
If retrieved on point T1, the output will be:
"T1,F1&F2:CCT,STS3C"
–
from point: F1
to points: T1, T2
the output will be:
1-way
"F1,T1&T2:CCT,STS3C"
2-way
"T1&T2,F1:CCT,STS3C"
–
from point: F1, F2
to points: T1, T2
the output will be:
1-way:
"F1&F2,T1&T2:CCT,STS3C"
2-way:
If retrieved on point F1 or F2, the output format is the same as the 1-way output.
If retrieved on point T1 or T2, the output will be:
"T1&T2,F1&F2:CCT,STS3C"
–
ENT-CRS-<PATH>::F1&F2,S1&S2:<CTAG>::2WAY;
from points: F1, F2 (F1 is the working side, F2 is the protect side)
selector: S1, S2 (S1 is the working side, S2 is the protect side)
the output will be:
If retrieved on point F1 or F2, the output will be:
"F1&F2,S1&S2:CCT,STS3C"
If retrieved on selector S1 or S2, the output will be:
"S1&S2,F1&F2:CCT,STS3C"
–
from points: F1, F2
to points: T1, T2
the output will be:
"F1&F2,T1&T2:CCT,STS3C"
–
from points: F1, F2
to points: T1
the output will be:
"F1&F2,T1:CCT,STS3C"
•
•
•
•
•
•
•
CategoryCross Connections
SecurityRetrieve
Related Commands
Input FormatRTRV-CRS-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-CRS-STS3C:KENWOOD:STS-6-1-1:223;
Input Parameters
Table 21-65 RTRV-CRS-<PATH> Input Parameters
SRC
Source access identifier from the "CrossConnectId1" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<CCT>,<MOD>:[DRITYPE=<DRITYPE>],[DRINODE=<SYNCSW>],
[CKTID=<CKTID>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-5-1-2&STS-6-1-2,STS-12-1-2&STS-13-1-2:1WAYDC,STS1:DRITYPE=BLSR,
DRINODE=PRI,CKTID=CKTID:OOS-AU,AINS"
;Output Parameters
Table 21-66 RTRV-CRS-<PATH> Output Parameters
SRC
Source access identifier from the "CrossConnectId" section. Indicates the source AID(s) of the cross-connection. Listable
DST
Destination AID of the cross-connection from the "CrossConnectId" section. Listable
CCT
Type of connection. Used for specifying one or two-way connections
Parameter type is CCT—type of cross-connect to be created
•
A unidirectional connection from a source tributary to a destination tributary
•
Path Protection multicast drop with (1-way) continue
•
Path Protection multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A Bidirectional Drop and Continue connection applicable only to Path Protection Traditional and Integrated Dual Ring InterConnections
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (BLSR PCA diagnostics cross-connect)
MOD
The connection path bandwidth
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
DRITYPE
The DRI connection type. It is applied only if the cross-connection is a drop-and-continue connection type (1WAYDC or 2WAYDC), and defaults to path protection for the DRI configuration. Optional
Parameter type is DRITYPE—DRI type
•
BLSR DRI type
•
Path Protection DRI type
•
Path Protection-BLSR hand off DRI type
SYNCSW
Synchronization switch AID from the "SYNCSW" section. Optional
CKTID
A string of ASCII characters. Maximum length is 48. String. Optional
PST_PSTQ
Primary state and primary state qualifier separated by a colon
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
One or more secondary states separated by "&", in alphabetical order. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.34 RTRV-DFLT-SECU
Retrieve Default Security
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the system-wide default values associated with several security parameters.
CategorySecurity
SecuritySuperuser
Related Commands
Input FormatRTRV-DFLT-SECU:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-DFLT-SECU:CISCO:ALL:123;
Input Parameters
Table 21-67 RTRV-DFLT-SECU Input Parameters
AID
Access identifier. ALL is the only acceptable value. String. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"TCC2:PAGE=40,PCND=5,MXINV=5,DURAL=30,TMOUT=0,UOUT=60,PFRCD=NO,
POLD=5,PINT=20,LOGIN=MULTIPLE,PRIVLVL=RTRV,PDIF=1"
;Output Parameters
21.35 RTRV-DS1
Retrieve DS1
Usage Guidelines
Cisco ONS 15454
This command retrieves the test access attributes on a DS1 layer of a DS3XM card.
Note
•
•
•
•
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-DS1:[<TID>]:<DS1AID>:<CTAG>[::::];
Input ExampleRTRV-DS1:PETALUMA:DS1-2-1-6-12:123;
Input Parameters
Table 21-69 RTRV-DS1 Input Parameters
DS1AID
The DS1 path access identifier of the DS3XM card from the "DS1" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<DS1AID>::[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[MODE=<MODE>],[FMT=<FMT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"DS1-2-1-6-12::TACC=8,TAPTYPE=SINGLE,MODE=FDL,FMT=ESF"
;Output Parameters
Table 21-70 RTRV-DS1 Output Parameters
DS1AID
The DS1 path access identifier of the DS3XM card from the "DS1" section
TACC
Indicates whether the digroup being provisioned is to be used as a test access digroup. Default is N. Integer. Optional
TAPTYPE
TAP type. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
MODE
Mode with which the command is to be implemented. DS1 path mode of the DS3XM-12 card. Optional
Parameter type is DS1MODE—the DS1 path mode of the DS3XM-12 card
•
The DS1 path of the DS3XM-12 card is in AT&T 54016 mode
•
The DS1 path of the DS3XM-12 card is in FDL T1-403 mode
FMT
Digital signal format. The DS1 path frame format of the DS3XM-12 card. Optional
Parameter type is FRAME_FORMAT—frame format for a T1 port
•
Frame format is D4
•
Frame format is ESF
•
Frame format is unframed
21.36 RTRV-EC1
Retrieve Electrical Carrier
Usage Guidelines
Cisco ONS 15454
This command retrieves the facility status of an EC1 card.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-EC1:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-EC1:CISCO:FAC-1-1:1234;
Input Parameters
Table 21-71 RTRV-EC1 Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::PJMON=0,LBO=0-225,RXEQUAL=Y,SOAK=52,SOAKLEFT=12-25,SFBER=1E-4,
SDBER=1E-7,NAME=\"EC1 PORT\",EXPTRC="AAA",TRC="AAA",TRCMODE=MAN,
TRCFORMAT=16-BYTE,AISONLPBK=AIS_ON_LPBK_ALL:IS-NR,AINS"
;Output Parameters
Table 21-72 RTRV-EC1 Output Parameters
AID
Access identifier from the "FACILITY" section
PJMON
A SONET pointer monitor attribute of an EC1 port. Integer. Optional
LBO
Line build out settings. Integer. Optional
Parameter type is E_LBO—electrical signal line buildout
•
Electrical signal line buildout range is 0-225
•
Electrical signal line buildout range is 226-450
RXEQUAL
Optional
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
SOAK
IS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1-minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
SFBER
Signal failure threshold. The default value is 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
Signal degrade threshold. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
NAME
String. Optional
EXPTRC
String. Optional
TRC
String. Optional
TRCMODE
Trace mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Turn off path trace capability. Nothing will be reported
TRCFORMAT
Trace message size. Optional
Parameter type is TRCFORMAT—trace format
•
1-byte trace message
•
16-byte trace message
•
64-byte trace message
•
Enable an attribute
AISONLPBK
AIS on loopback. Optional
Parameter type is AIS_ON_LPBK—Indicates if AIS is sent on a loopback
•
AIS is sent on facility loopbacks
•
AIS is sent on all loopbacks
•
AIS is not sent on loopbacks
•
AIS is sent on terminal loopbacks
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.37 RTRV-EQPT
Retrieve Equipment
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the data parameters and state parameters associated to an equipment unit.
This command returns the PRTYPE, PROTID, RVTM, and RVRTV parameters for a card inside of a protection group by the following scenario:
1.
2.
3.
RVRTV=Y.4.
5.
6.
7.
8.
Error conditions:
•
CategoryEquipment
SecurityRetrieve
Related Commands
Input FormatRTRV-EQPT:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-EQPT:MIRABEL:SLOT-12:230;
Input Parameters
Table 21-73 RTRV-EQPT Input Parameters
AID
Access identifier from the "EQPT" section. Must not be null
Output FormatSID 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>,]
[PWL=<PWL>],[TRANSMODE=<TRANSMODE>],
[RETIME=<RETIME>]:[<PST_PSTQ>],[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-12:DS1,EQUIP,,ACT:PROTID=SLOT-13,PRTYPE=1-1,RVRTV=Y,RVTM=8.5,
CARDNAME=DESCRIPTION,IOSCFG="IOS CONFIG INFO FOR ML SERIES CARD",
CARDMODE=DS3XM12-STS48,PEERID=SLOT-1,REGENNAME="THIS GROUP",
PWL=1530.33,TRANSMODE=SONET,RETIME=Y:OOS-AU,AINS&UEQ"
;Output Parameters
Table 21-74 RTRV-EQPT Output Parameters
AID
Access identifier from the "EQPT" section
AIDTYPE
The type of facility, link or other addressable entity targeted by the message
Parameter type is EQUIPMENT_TYPE—equipment type
•
Unidirectional optical demultiplexer with 32 channels
•
Unidirectional optical multiplexer with 32 channels
•
Optical wavelength selective switch with 32 channels
•
Optical Add/Drop Multiplexed (OADM) 1 Band Filter
•
Optical Add/Drop Multiplexed (OADM) 1 Channel Filter
•
Optical Add/Drop Multiplexed (OADM) 2 Channels Filter
•
Optical Add/Drop Multiplexed (OADM) 4 Bands Filter
•
Optical Add/Drop Multiplexed (OADM) 4 Channels Filter
•
AICI card
•
Any Service Any Port (ASAP) Carrier card with 4 PIM slots
•
8-Port 100T card on ONS 15454 and ONS 15310-CL
•
Cross-Connect Card (ONS 15600 only)
•
DS1 card
•
DS1-E1-56 card
•
DS1I card
•
DS1N card
•
DS3 card
•
DS3E card
•
DS3-EC1-48 card
•
DS3I card
•
DS3IN card
•
DS3N card
•
DS3NE card
•
DS3XM card
•
DS3XM-12 card
•
E1000T card
•
E100T card
•
EC1 card
•
FC_MR-4 card
•
Blank Filler card (ONS 15600)
•
2-port G1000 card (ONS 15327)
•
4-port G1000 card (ONS 15454)
•
Optical Multiplexer/Demultiplexer with 4 Channels
•
ONS 15327 MIC card
•
ONS 15327 MIC-EXT card
•
ML100FX card
•
15454-LI+ Mapper card and 15310-CL ML-100T8 card
•
ML-Series 2-Port GigE card
•
ML-Series 12-Port FSTE card
•
12-port multirate optical card (ONS 15454)
•
10G (4 * 2.5G) muxponder card with Enhanced FEC
•
10G (4 * 2.5G) muxponder card
•
Multirate 2.5G muxponder unprotected
•
Multirate 2.5G muxponder protected
•
OC3 card
•
8-Port OC3 card
•
OC12 card
•
4-port OC12 card
•
OC48 card
•
16-port OC48 card
•
OC192 card
•
4-port OC192 card
•
1-port OC192 XFP
•
Optical booster amplifier
•
Optical preamplifier
•
Optical Service Channel (OSC) with Combiner/Separator Module (SCM)
•
Optical Service Channel (OSC) Module
•
4-port Pluggable Interface Module (ONS 15600)
•
Pluggable Port Module with 1 SFP port (ONS 15600 ASAP, ONS 15310-CL, ONS 15454 MXP/MXPP, TXP/TXPP, MRC-12 and OC192-XFP)
•
Cross-connect card (ONS 15600)
•
TCC card
•
10G Multirate Transponder Card with Enhanced FEC
•
10G Multirate Transponder Card
•
Multirate 2.5G Unprotected
•
Multirate 2.5G Protected
•
XC10G card
•
XCVT card
•
XCVXC-10G card
•
XCVXC-2.5G card
•
XCVXL-10G card
•
XCVXL-2.5G card
•
ONS 15327 XTC card
EQUIP
Indicates if the equipment is physically present
Parameter type is EQUIP—the presence of a plug-in unit
•
The unit is equipped - present
•
The unit is unequipped - absent
ROLE
Indicates if the card is a working unit or the protecting unit. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
Indicates a status. SONET card status is shown on its card level. Optional
Parameter type is STATUS—status
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit on the shelf
PROTID
Protecting identifier AID from the "PRSLOT" section. Optional
PRTYPE
Protection type. Optional
Parameter type is PROTECTION_GROUP—protection group type
•
1 to 1 protection
•
1 to N protection
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
CARDNAME
The card name of the card, PIM or PPM equipment. String. Optional
IOSCFG
Displays the information about the startup Cisco IOS config file for the ML-Series cards. An example of this field is "TL1,11.22.33.44//DIR/IOS.CONF,2002/1/1 9:1:1 EST". The following information is included in this field:
1) Where the config file is from: TL1, or CTC/CTM/CLI/TCC;
2) The host (IP address)/directory/file name, if the config file is downloaded from the network;
3) When the startup config file is created (by copying from the network, for example).
This field only applies to ML-Series cards. String. Optional.CARDMODE
Card mode. Optional
Parameter type is CARDMODE—card mode. Card mode is applicable to cards that have multiple capabilities, for example, the ML card can operate in two distinct modes: Linear Mapper Mode and L2/L3 Mode
•
The DS3XM-12 card in the STS12 back plane rate mode
•
The DS3XM-12 card in the STS48 back plane rate mode
•
Line terminating mode
•
Section terminating mode
•
Transparent mode AIS
•
Transparent mode SQUELCH
•
FC_MR-4 card with distance extension support
•
FC_MR-4 card without distance extension support
•
ML-Series card in DOS FPGA using GFP framing type
•
ML-Series card in DOS FPGA using HDLC framing type
•
Fibre channel or GIGE mode for the MXP-MR-2.5G card
PEERID
The regeneration group peer slot identifier from the "EQPT" section. Optional
REGENNAME
Name of a regeneration group. String. Optional
PWL
Provisioned wavelength. Optional
Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
TRANSMODE
Transport mode. Applicable only to the DS1/E1-56 card on ONS 15454. Defaults to SONET. Optional
Parameter type is TRANSMODE—transition mode
•
AU3 mode
•
AU4 mode
•
SONET mode
RETIME
Indicates the retime function for all the ports on this card. Applicable only to the DS1/E1-56 card on the ONS 15454. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Listable
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.38 RTRV-ESCON
Retrieve Enterprise System Connection
Usage Guidelines
Cisco ONS 15454
This command retrieves the fibre channel-specific settings for ports that have been configured to carry ESCON traffic using the ENT-ESCON command.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-ESCON:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-ESCON::CISCO:FAC-1-1:123;
Input Parameters
Table 21-75 RTRV-ESCON Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[ENCAP=<ENCAP>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:ENCAP=GFP-T"
;Output Parameters
Table 21-76 RTRV-ESCON Output Parameters
AID
Access identifier from the "FACILITY" section
ROLE
The port role in Y-cable protection (WORK or PROT). Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
A port status in Y-cable protection (ACT or STBY). Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
ENCAP
Encapsulation frame type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP Frame Mode
•
GFP Transparent Mode
•
HDLC Frame Mode
•
HDLC LAN Extension Frame Mode
•
HDLC X.86 Frame Mode
21.39 RTRV-EXT-CONT
Retrieve External Control
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the control state of an external control. The command can be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT command.
Note
Note
CategoryEnvironment
SecurityRetrieve
Related Commands
OPR-ACO-ALL
OPR-EXT-CONT
REPT ALM ENV
REPT EVT ENV
RLS-EXT-CONT
RTRV-ALM-ENV
RTRV-ATTR-CONT
RTRV-ATTR-ENV
RTRV-COND-ENV
SET-ATTR-CONT
SET-ATTR-ENV
SET-ATTR-SECUDFLT
Input FormatRTRV-EXT-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input ExampleRTRV-EXT-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Input Parameters
Table 21-77 RTRV-EXT-CONT Input Parameters
AID
Access identifier from the "ENV" section. The only valid AID for RTRV-EXT-CONT is ENV-OUT-{1-2}. Must not be null
CONTTYPE
Environmental control type. A null value is equivalent to ALL
Parameter type is CONTTYPE—Environmental control types
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>],<DUR>,[<CONTSTATE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND,CONTS,OPEN"
;Output Parameters
Table 21-78 RTRV-EXT-CONT Output Parameters
AID
Access identifier from the "ENV" section. Identifies the external control for which the control state is being retrieved
CONTTYPE
Environmental control type. Optional
Parameter type is CONTTYPE—Environmental control types
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
DUR
Duration of operation. The duration for which the external control can be operated
Parameter type is Duration—Duration
•
Continuous duration
CONTSTATE
Control state of the external control. Optional
Parameter type is CONT_MODE—current state of the environmental control
•
Not applicable (for example, duration is MNTRY)
•
The environmental control state is CLOSE
•
The environmental control state is OPEN
21.40 RTRV-FAC
Retrieve Facility
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the payload type of the facility. It can also dump all the facilities on a given card and is applicable to all cards.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-FAC:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-FAC:CISCO:FAC-2-9:2223;
Input Parameters
Table 21-79 RTRV-FAC Input Parameters
SRC
Source access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>::PAYLOAD=<PAYLOAD>:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-9::PAYLOAD=E4-FRAMED:OOS-AU,AINS"
;Output Parameters
Table 21-80 RTRV-FAC Output Parameters
SRC
Source access identifier from the "FACILITY" section
PAYLOAD
Payload type of the facility. Optional
Parameter type is PAYLOAD—identifies payload type
•
10 Gigabit Ethernet fibre channel mode
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel mode
•
1 Gigabit FICON mode
•
2 Gigabit fibre channel mode
•
2 Gigabit FICON mode
•
DS3 mode
•
Video mode
•
EC1 mode
•
ESCON mode
•
ETR_CLO payload mode
•
Gigabit Ethernet Payload
•
HDTV mode
•
ISC1 Mode
•
ISC3 Mode
•
SONET OC12 mode
•
SONET OC3 mode
•
SONET OC48 mode
•
Pass through mode
•
SDI-D1-Video mode
•
SONET Payload Mode
PST_PSTQ
Admin state in the PST-PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state. String. Optional
21.41 RTRV-FFP
Retrieve Facility Protection Group
Usage Guidelines
This command retrieves all optical 1+1 protection groups.
CategoryProtection
SecurityRetrieve
Related Commands
Input FormatRTRV-FFP:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-FFP:HERNDON:FAC-1-1:1;
Input Parameters
Table 21-81 RTRV-FFP Input Parameters
AID
Optical facility access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>:<LEVEL>:[PROTID=<PROTID>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>],
[DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1:OC48:PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,PSDIRN=BI,
VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;Output Parameters
Table 21-82 RTRV-FFP Output Parameters
WORK
The working port access identifier from the "FACILITY" section
PROTECT
The protected port access identifier from the "FACILITY" section
PROTTYPE
Protection group type. String. Optional
LEVEL
Optical rate the protection group was defined against
Parameter type is OCN_TYPE—modifier used to differentiate various levels of OC-N
•
Optical Carrier level-12 (622Mbs)
•
Optical Carrier level-192 (10Gbs)
•
Optical Carrier level-3 (155Mbs)
•
Optical Carrier level-48 (2.4Gbs)
PROTID
Protection group name. String. Optional
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PSDIRN
Protection switch operation. Direction of reversion. Optional
Parameter type is UNI_BI—unidirectional and bidirectional switch operations
•
Bidirectional protection switching
•
Unidirectional protection switching
VRGRDTM
Verification guard timer. Only applies to optimized 1+1. Optional
Parameter type is VERIFICATION_GUARD_TIMER—optimized 1+1 verification guard timer
•
500 ms
•
1 second
DTGRDTM
Detection guard timer. Only applies to optimized 1+1. Optional
Parameter type is DETECTION_GUARD_TIMER—optimized 1+1 detection guard timer
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
RCGRDTM
Recovery guard timer. Only applies to optimized 1+1. Optional
Parameter type is RECOVERY_GUARD_TIMER—optimized 1+1 recovery guard timer
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
OPOTYPE
1+1 protection type. Optional
Parameter type is ONE_PLUS_ONE— one plus one protection type
•
Optimized 1+1
•
Standard 1+1
21.42 RTRV-FFP-<MOD2DWDMPAYLOAD>
Retrieve Facility Protection Group (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, PASSTHRU)
Usage Guidelines
Cisco ONS 15454
This command retrieves Y-cable protection on client facilities.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-FFP-<MOD2DWDMPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-FFP-HDTV:CISCO:FAC-1-1-1:100;
Input Parameters
Table 21-83 RTRV-FFP-<MOD2DWDMPAYLOAD> Input Parameters
SRC
Source access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDUNIONID1>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1,FAC-2-1-1::PROTTYPE=Y-CABLE,PROTID=\"DC-METRO\",
RVRTV=N,RVTM=1.0,PSDIRN=BI"
;Output Parameters
Table 21-84 RTRV-FFP-<MOD2DWDMPAYLOAD> Output Parameters
AIDUNIONID
Access identifier from the "FACILITY" section
AIDUNIONID1
Access identifier from the "FACILITY" section
PROTTYPE
The type of facility protection. Optional
Parameter type is PROTTYPE—protection type for DWDM client facilities
•
Y-cable protection for the client ports on TXP_MR_10G,/MXP_2.5G_10G and TXP_MR_2.5G/TXPP_MR_2.5G cards
PROTID
Y-cable protection group identifier. String. Optional
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Defaults to 5.0 minutes. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PSDIRN
Protection switch operation. Identifies the switching mode. Defaults to UNI. Optional
Parameter type is UNI_BI—unidirectional and bidirectional switch operations
•
Bidirectional protection switching
•
Unidirectional protection switching
21.43 RTRV-FFP-<OCN_TYPE>
Retrieve Facility Protection Group (OC3, OC12, OC48, OC192)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the optical facility protection information.
See Table 27-1 for supported modifiers by platform.
Note
Note
CategoryProtection
SecurityRetrieve
Related Commands
Input FormatRTRV-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-FFP-OC3:PETALUMA:OC3-1-1:1;
Input Parameters
Table 21-85 RTRV-FFP-<OCN_TYPE> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1::PROTTYPE=Y-CABLE,PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,
PSDIRN=BI,VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;Output Parameters
Table 21-86 RTRV-FFP-<OCN_TYPE> Output Parameters
WORK
Access identifier from the "FACILITY" section. Identifies the working port
PROTECT
Access identifier from the "FACILITY" section. Identifies the protection port
PROTTYPE
Protection group type. Applicable only to DWDM cards. Optional
Parameter type is PROTTYPE—protection type for DWDM client facilities
•
Y-cable protection for the client ports on TXP_MR_10G/MXP_2.5G_10G and TXP_MR_2.5G/TXPP_MR_2.5G cards
PROTID
Free form text string name given to the 1+1 protection group. String. Optional
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Defaults to 5.0 minutes. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PSDIRN
Protection switch operation. Identifies the switching mode. Defaults to UNI. Optional
Parameter type is TRANS_MODE—G1000 transponder mode
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
VRGRDTM
Verification guard timer. Only applies to optimized 1+1. Optional
Parameter type is VERIFICATION_GUARD_TIMER—optimized 1+1 verification guard timer
•
500 ms
•
1 second
DTGRDTM
Detection guard timer. Only applies to optimized 1+1. Optional
Parameter type is DETECTION_GUARD_TIMER—optimized 1+1 detection guard timer
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
RCGRDTM
Recovery guard timer. Only applies to optimized 1+1. Optional
Parameter type is RECOVERY_GUARD_TIMER—optimized 1+1 recovery guard timer
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
OPOTYPE
1+1 protection type. Optional
Parameter type is ONE_PLUS_ONE— one plus one protection type
•
Optimized 1+1
•
Standard 1+1
21.44 RTRV-FFP-OCH
Retrieve Facility Protection Group Optical Channel
Usage Guidelines
Cisco ONS 15454
This command retrieves the protection group information for the TXP_MR_2.5G and the TXPP-MR-2.5G card trunk port.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-FFP-OCH:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-FFP-OCH:VA454-22:CHAN-2-2:100;
Input Parameters
Table 21-87 RTRV-FFP-OCH Input Parameters
AID
Access identifier from the "CHANNEL" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>,[,PSDIRN=<PSDIRN>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,CHAN-2-3::PROTTYPE=SPLITTER,PROTID=\"TRUNK PROT\",RVRTV=Y,
RVTM=1.0,PSDIRN=UNI"
;Output Parameters
Table 21-88 RTRV-FFP-OCH Output Parameters
WORK
The working port access identifier from the "CHANNEL" section
PROTECT
The protected port access identifier from the "CHANNEL" section
PROTTYPE
Protection group type. String. Optional
PROTID
Protection group name. String. Optional
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PSDIRN
Protection switch operation. Direction of reversion. Optional
Parameter type is UNI_BI—unidirectional and bidirectional switch operations
•
Bidirectional protection switching
•
Unidirectional protection switching
21.45 RTRV-FSTE
Retrieve Fast Ethernet
Usage Guidelines
Cisco ONS 15454, 15310-CL
This command retrieves the front end port information of fast (10/100 Mbps) Ethernet card. MTU is not displayed for the ML-100T-8 and CE-100T-8 cards. RTRV-POS will display the MTU which is common for both front and back-end ports.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-FSTE:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-FSTE:TID:FAC-1-1:CTAG;
Input Parameters
Table 21-89 RTRV-FSTE Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,
FLOWCTRL=SYMMETRIC,DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,
EXPDUPLEX=EXPDUPLEX,EXPSPEED=EXPSPEED,VLANCOS=VLANCOS,
IPTOS=IPTOS,OPTICS=1000-BASE-LX,NAME=\"FSTEPORT\",SOAK=32,
SOAKLEFT=\"12-25\":OOS-AU,AINS"
;Output Parameters
Table 21-90 RTRV-FSTE Output Parameters
AID
Access identifier from the "FACILITY" section
ADMINSTATE
Administration type. Optional
Parameter type is UP_DOWN—Up or down
•
Down
•
Up
LINKSTATE
Link protocol. Optional
Parameter type is UP_DOWN—Up or down
•
Down
•
Up
MTU
Maximum transmission unit. Integer. Optional
FLOWCTRL
Flow control. Optional
Parameter type is FLOW—the type of flow control that has been negotiated for an Ethernet port
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Symmetric flow control
DUPLEX
Duplex mode. Optional
Parameter type is ETHER_DUPLEX—duplex mode
•
Auto mode
•
Full mode
•
Half mode
SPEED
Speed. Optional
Parameter type is ETHER_SPEED—Ethernet speed
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
Auto
FLOW
Flow. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
EXPDUPLEX
Ethernet duplex mode. Optional
Parameter type is ETHER_DUPLEX—duplex mode
•
Auto mode
•
Full mode
•
Half mode
EXPSPEED
Ethernet speed. Optional
Parameter type is ETHER_SPEED—Ethernet speed
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
Auto
VLANCOS
Priority queing threshold based on VLAN class of service of incoming Ethernet packets. Integer. Optional
IPTOS
Priority queing threshold based on IP type of service of incoming Ethernet packets. Integer. Optional
OPTICS
GBIC type. Optional
Parameter type is OPTICS—type of Gigabit Ethernet optics being used
•
1000 Base CX
•
1000 Base LX
•
1000 Base SX
•
1000 Base ZX
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
NAME
Name. String. Optional
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
PST_PSTQ
Admin state in the PST-PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.46 RTRV-G1000
Retrieve G1000 Facility
Usage Guidelines
Cisco ONS 15454
This command retrieves the G1000 facilities configuration.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-G1000:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-G1000:TID:FAC-1-1:CTAG;
Input Parameters
Table 21-91 RTRV-G1000 Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::MFS=9032,FLOW=N,LAN=ASYMMETRIC,OPTICS=UNKNOWN,TRANS=NONE,
TPORT=FAC-5-1,LOWMRK=20,HIWMRK=492,AUTONEG=Y,ENCAP=GFP_T,
NAME=\"G1000 PORT\",SOAK=32,SOAKLEFT=\"12-25\":OOS-AU,AINS"
;Output Parameters
Table 21-92 RTRV-G1000 Output Parameters
AID
Access identifier from the "FACILITY" section
MFS
Maximum frame size
Parameter type is MFS_TYPE—maximum frame size used by an Ethernet card
•
Normal frame size
•
Jumbo frame size
FLOW
Flow control
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
LAN
Local-area network. Optional
Parameter type is FLOW—the type of flow control that has been negotiated for an Ethernet port
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Symmetric flow control
OPTICS
GBIC type. Optional
Parameter type is OPTICS—type of Gigabit Ethernet optics being used
•
1000 Base CX
•
1000 Base LX
•
1000 Base SX
•
1000 Base ZX
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
TRANS
Transponder mode. Optional
Parameter type is TRANS_MODE—G1000 transponder mode
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
TPORT
Transponding port access identifier from the "FACILITY" section. Optional
LOWMRK
Low watermark value. Integer. Optional
HIWMRK
High watermark value. Integer. Optional
AUTONEG
Automatic negotiation. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
ENCAP
Frame encapsulation type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
NAME
Name. String. Optional
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1-minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
PSTPSTQ
Admin state in the PST-PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.47 RTRV-GFP
Retrieve Generic Framing Protocol
Usage Guidelines
Cisco ONS 15454, 15310-CL, 15600
This command applies to the ONS 15454 CE-100T-8 card, the ONS 15454 FC_MR-4 card, and the 15310-CL CE-100T-8 card.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-GFP:[<TID>]:<SRC>:<CTAG>;
Input ExampleRTRV-GFP:CISCO:FAC-1-1:123;
Input Parameters
Table 21-93 RTRV-GFP Input Parameters
SRC
Source access identifier from the "FACILITY" section. Must not be null
Note
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[FCS=<FCS>],[AUTOTHGFPBUF=<AUTOTHGFPBUF>],
[GFPBUF=<GFPBUF>],[FILTER=<FILTER>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::FCS=FCS-32,AUTOTHGFPBUF=Y,GFPBUF=16,FILTER=EGRESS"
;Output Parameters
Table 21-94 RTRV-GFP Output Parameters
AID
Access identifier from the "FACILITY" section
FCS
Payload frame check sequence. Optional
Parameter type is FCS—frame check sequence
•
Frame check sequencing using 16 bits
•
Frame check sequencing using 32 bits
•
No frame check sequence
AUTOTHGFPBUF
Flag used to indicate whether PDI-P should be generated on the outgoing VT-structured STSs. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
GFPBUF
Integer. Optional
FILTER
Optional. Parameter type is GFP_FILTER—filter
•
Activate filter on egress port
•
Turn off filter
21.48 RTRV-GIGE
Retrieve Gigabit Ethernet
Usage Guidelines
Cisco ONS 15454, 15600
This command retrieves the front end port information for a 1 GIG Ethernet card.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-GIGE:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-GIGE:TID:FAC-1-1:CTAG;
Input Parameters
Table 21-95 RTRV-GIGE Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,<ROLE>,<STATUS>:[ADMINSTATE=<ADMINSTATE>],
[LINKSTATE=<LINKSTATE>],[MTU=<MTU>],[ENCAP=<ENCAP>],
[FLOWCTRL=<FLOWCTRL>],[OPTICS=<OPTICS>],[DUPLEX=<DUPLEX>],
[SPEED=<SPEED>],[NAME=<NAME>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,
ENCAP=GFP-F,FLOWCTRL=SYMMETRIC,OPTICS=1000_BASE_SX,DUPLEX=AUTO,
SPEED=AUTO,NAME=`"GIGE PORT\",FREQ=1550,LOSSB=SX""
;Output Parameters
Table 21-96 RTRV-GIGE Output Parameters
AID
Access identifier from the "FACILITY" section
ROLE
Identifies the port role in a Y-cable protection scheme
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
Identifies a port status in a Y-cable protection scheme
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
ADMINSTATE
Administration type. Optional
Parameter type is UP_DOWN—Up or down
•
Down
•
Up
LINKSTATE
Link protocol. Optional
Parameter type is UP_DOWN—Up or down
•
Down
•
Up
MTU
Maximum transmission unit. Integer. Optional
ENCAP
Encapsulation frame type. Optional
Parameter type is ENCAP—frame encapsulation type
•
GFP Frame Mode
•
GFP Transparent Mode
•
HDLC Frame Mode
•
HDLC LAN Extension Frame Mode
•
HDLC X.86 Frame Mode
FLOWCTRL
Flow control. Optional
Parameter type is FLOW—the type of flow control that has been negotiated for an Ethernet port
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Symmetric flow control
OPTICS
Optics type. Optional
Parameter type is OPTICS—type of Gigabit Ethernet optics being used
•
1000 Base CX
•
1000 Base LX
•
1000 Base SX
•
1000 Base ZX
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
DUPLEX
Duplex mode. Optional
Parameter type is ETHER_DUPLEX—duplex mode
•
Auto mode
•
Full mode
•
Half mode
SPEED
Speed. Optional
Parameter type is ALS_MODE—automatic laser shutdown
•
Automatic
•
Disabled
•
Manual
•
Manual restart for test
NAME
Name. String. Optional
FREQ
Optional. Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
LOSSB
Optional. Parameter type is REACH—reach values
•
Autoprovisioning
•
Reach CX
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
Reach VX
•
Reach ZX
21.49 RTRV-HDLC
Retrieve High-Level Data Link Control
Usage Guidelines
Cisco ONS 15600
This command retrieves HDLC-related attributes.
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-HDLC:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-HDLC:TID:VFAC-SLOT-PORT:CTAG;
Input Parameters
Table 21-97 RTRV-HDLC Input Parameters
AID
Access identifier from the "FACILITY" section. The ONS 15600 ASAP card uses the VFAC AID
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[FCS=<FCS>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-SLOT-PORT::FCS=FCS-16"
;Output Parameters
Table 21-98 RTRV-HDLC Output Parameters
AID
Access identifier from the "FACILITY" section. The ONS 15600 ASAP card uses the VFAC AID
FCS
Payload frame check sequence. Optional
Parameter type is FCS—frame check sequence
•
Frame check sequencing using 16 bits
•
Frame check sequencing using 32 bits
•
No frame check sequence
21.50 RTRV-HDR
Retrieve Header
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the header of a TL1 response message. It is used by TL1 clients to determine if the link to the NE is still active and if the NE is responding to commands.
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-HDR:[<TID>]::<CTAG>;
Input ExampleRTRV-HDR:SONOMA::232;
Input Parameters
21.51 RTRV-INV
Retrieve Inventory
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves a list of the equipment inventory. For each unit in the system, the list identifies the unit's firmware numbers and CLEI codes, and the system's product ID and version ID. This command also retrieves the inventory information from pluggable modules using the AID PPM-SLOT-PORT format.
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-INV:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-INV:OCCIDENTAL:SLOT-15:301;
Input Parameters
Table 21-100 RTRV-INV Input Parameters
AID
Access identifier from the "EQPT" section or the "ALL" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[PLUGTYPE=<PLUGTYPE>],[PN=<PN>],[HWREV=<HWREV>],
[FWREV=<FWREV>],[SN=<SN>],[CLEI=<CLEI>],[TWL1=<TWL>],[TWL2=<TWL1>],
[TWL3=<TWL2>],[TWL4=<TWL3>],[PLUGINVENDORID=<PLUGINVENDORID>],
[PLUGINPN=<PLUGINPN>],[PLUGINHWREV=<PLUGINHWREV>],
[PLUGINFWREV=<PLUGINFWREV>],[PLUGINSN=<PLUGINSN>],
[ILOSSREF=<ILOSSREF>],[PID=<PID>],[VID=<VID>],[FPGA=<FPGA>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-15,OC3-IR-4::PLUGTYPE=SX-IR-SW-SN,PN=87-31-00002,HWREV=004K,
FWREV=76-99-00009-004A,SN=013510,CLEI=NOCLEI,TWL1=1546.12,TWL2=1546.92,
TWL3=1547.72,TWL4=1548.51,PLUGINVENDORID=012345,PLUGINPN=ABCDE,
PLUGINHWREV=ABCDE,PLUGINFWREV=01-02-03,PLUGINSN=01234,ILOSSREF=1.0,
PID=CISCO_ONS15454,VID=V01,FPGA=F451"
;Output Parameters
Table 21-101 RTRV-INV Output Parameters
AID
Access identifier from the "EQPT" section
AIDTYPE
Specifies the type of (AID) facility, link or other addressable entity targeted by the message. String
PLUGTYPE
The type of plug-in. String. Optional
PN
Hardware part number. String. Optional
HWREV
Hardware revision. String. Optional
FWREV
Firmware revision. String. Optional
SN
Serial number. String. Optional
CLEI
Common language equipment identifier code for the equipment. String. Optional
TWL1
Tunable wavelength 1. Optional. (See OPTICAL_WLEN parameter below)
TWL2
Tunable wavelength 2. Optional. (See OPTICAL_WLEN parameter below)
TWL3
Tunable wavelength 3. Optional. (See OPTICAL_WLEN parameter below)
TWL4
Tunable wavelength 4. Optional
Parameter type for TWL1, TWL2, TWL3, and TW4 is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
PLUGINVENDORID
Plugin vendor ID. Integer. Optional
PLUGINPN
Third-party plug-in module HW part number. Applicable only to the following cards: optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards and OADM cards. String. Optional
PLUGINHWREV
Third-party plug-in module hardware revision. Applicable only to the following cards: optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards and OADM cards. String. Optional
PLUGINFWREV
Third-party plug-in module firmware. Applicable only to the following cards: optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards and OADM cards. String. Optional
PLUGINSN
Third-party plug-in module serial number. Applicable only to the following cards: optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards and OADM cards. String. Optional
ILOSSREF
The insertion loss reference calculated by the unit as worst insertion loss of all the unit. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PID
Product ID of the module. String. Optional
VID
Vendor ID. String. Optional
FPGA
FPGA version. String. Optional
21.52 RTRV-LNK
Retrieve Link
Usage Guidelines
Cisco ONS 15454
This command retrieves all the (optical) links created in the NE. The end information is returned along with the type of (optical) link.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-LNK:[<TID>]::<CTAG>;
Input ExampleRTRV-LNK:PENNGROVE::114;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],[RDIRN=<RDIRN>],
[BAND=<BAND>],[WLEN=<WLEN>]:<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-TX,BAND-13-1-RX::OLNKT=HITLESS,CTYPE=PROV,RDIRN=W_E,
BAND=1530.32-1532.68,WLEN=1530.32:OOS-AU,AINS"
;Output Parameters
Table 21-103 RTRV-LNK Output Parameters
FROM
Access identifier from the "ALL" section. Identifies an entity at one end of the optical link
TO
Access identifier from the "ALL" section. Identifies an entity at the other end of the optical link
OLNKT
Optical link type. Optional
Parameter type is OPTICAL_LINK_TYPE—type of optical link between two optical facilities
•
Link between two points that results in an add/drop connection from a drop point to an add point
•
Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
Link between two OTS points
CTYPE
The type of cross-connection. Indicates if the optical link is provisioned by the user or automatically created by the NE. Optional
Parameter type is CREATION_TYPE—optical link creation type
•
Automatically created by the NE
•
Provisioned by the user
RDIRN
Ring directionality of the optical line. Optional
Parameter type is RDIRN_MODE—the optical ring directionality
•
The direction of the signal is from east to west (clockwise)
•
The direction of the signal is from west to east (counterclockwise)
BAND
The optical band (group of four contiguous wavelengths) for this optical link. BAND is optional and present only when there is a link between two OMS entities
Parameter type is OPTICAL_BAND—optical band
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit
WLEN
Optical wavelength for this optical link. WLEN is present only when there is a link between two OCH entities. Option
Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.53 RTRV-LNK-<MOD2O>
Retrieve Optical Link (OCH, OMS, OTS)
Usage Guidelines
Cisco ONS 15454
This command retrieves any optical link associated with the entered AIDs or AID range. The end information is returned along with the type of optical link.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-LNK-<MOD2O>:[<TID>]:<AID>:<CTAG>:::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],
[RDIRN=<RDIRN>];Input ExampleRTRV-LNK-OMS:PENNGROVE:ALL:114:::OLNKT=HITLESS,CTYPE=AUTO,RDIRN=W-E;
Input Parameters
Table 21-104 RTRV-LNK-<MOD2O> Input Parameters
AID
Access identifier from the "BAND" section. Identifies facilities to check for optical link membership. It can be an OPTICAL_AID AID or an ALL AID. The ALL AID defaults to NE, which reports all the existing optical links of the NE. Must not be null
OLNKT
Optical link type. A null value is equivalent to ALL
Parameter type is OPTICAL_LINK_TYPE—type of optical link between two optical facilities
•
Link between two points that results in an add/drop connection from a drop point to an add point
•
Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
Link between two OTS points
CTYPE
The type of cross-connection. Indicates if the optical link is provisioned by the user or automatically created by the NE. A null value is equivalent to ALL
Parameter type is CREATION_TYPE—optical link creation type
•
Automatically created by the NE
•
Provisioned by the user
RDIRN
Ring directionality of the optical line. A null value is equivalent to ALL
Parameter type is RDIRN_MODE—the optical ring directionality
•
The direction of the signal is from east to west (clockwise)
•
The direction of the signal is from west to east (counterclockwise)
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>::[OLNKT=<OPTICALLINKTYPE>],[CTYPE=<CREATIONTYPE>],
[RDIRN=<RDIRN>],[BAND=<BAND>],[WLEN=<WLEN>]:<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-TX,BAND-13-1-RX::OLNKT=HITLESS,CTYPE=PROV,RDIRN=W_E,
BAND=1530.32-1532.68,WLEN=1530.32:OOS-AU,AINS"
;Output Parameters
Table 21-105 RTRV-LNK-<MOD2O> Output Parameters
FROM
Access identifier from the "BAND" section. Identifies an entity at one end of the optical link
TO
Access identifier from the "BAND" section. Identifies an entity at the other end of the optical link
OPTICALLINKTYPE
Optical link type. Optional
Parameter type is OPTICAL_LINK_TYPE—type of optical link between two optical facilities
•
Link between two points that results in an add/drop connection from a drop point to an add point
•
Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
Link between two OTS points
CREATIONTYPE
Indicates if the optical link is provisioned by the user or automatically created by the NE. Optional
Parameter type is CREATION_TYPE—optical link creation type
•
Automatically created by the NE
•
Provisioned by the user
RDIRN
Ring directionality of the optical line. Optional
Parameter type is RDIRN_MODE—the optical ring directionality
•
The direction of the signal is from east to west (clockwise)
•
The direction of the signal is from west to east (counterclockwise)
BAND
The optical band (group of four contiguous wavelengths) for this optical link. BAND is optional and present only when there is a link between two OMS entities
Parameter type is OPTICAL_BAND—optical band
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit
WLEN
Optical wavelength for this optical link. WLEN is present only when there is a link between two OCH entities. Optional
Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.54 RTRV-LNKTERM
Retrieve Provisionable Patchcord Termination
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15310-CL
This command retrieves information about one or more provisionable patchcord (PP) terminations.
Note
Note
CategoryProvisionable Patchcords
SecurityRetrieve
Related Commands
Input FormatRTRV-LNKTERM:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-LNKTERM::LNKTERM-2:CTAG;
Input Parameters
Table 21-106 RTRV-LNKTERM Input Parameters
AID
Access identifier from the "LNKTERM" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::PORT=<PORT>,[REMOTENODE=<REMOTENODE>],
[REMOTELNKTERMID=<REMOTELNKTERMID>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"LNKTERM-2::PORT=FAC-3-1,REMOTENODE=172.20.221.225,REMOTELNKTERMID=21"
;Output Parameters
Table 21-107 RTRV-LNKTERM Output Parameters
AID
Access identifier from the "LNKTERM" section. Must not be null
PORT
Access identifier from the "AidUnionId" section
REMOTENODE
Remote node. String. Optional
REMOTELNKTERMID
Remote link term ID. Integer. Optional
21.55 RTRV-LOG
Retrieve Log
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the alarm log of the NE.
Note
CategoryLog
SecurityRetrieve
Related Commands
Input FormatRTRV-LOG:[<TID>]::<CTAG>::<LOGNM>;
Input ExampleRTRV-LOG:CERENT::123::ALARM;
Input Parameters
Table 21-108 RTRV-LOG Input Parameters
LOGNM
Log to be retrieved. Log name - ALARM. String. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<ALMNUMBER>:CURRENT=<CURRENT>,[PREVIOUS=<PREVIOUS>],
<CONDITION>,<SRVEFF>,[TIME=<OCRTIME>],[DATE=<OCRDAT>]:<ALMDESCR>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,18:CURRENT=MJ,PREVIOUS=CL,EOC,NSA,TIME=16-33-04,
DATE=1971-02-03:\"SDCC TERMINATION FAILURE\""
;Output Parameters
Table 21-109 RTRV-LOG Output Parameters
AID
Access identifier from the "ALL" section
ALMNUMBER
Alarm number of the log. Integer
CURRENT
Current severity
Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message
•
The condition causing the alarm has cleared
•
A critical alarm
•
A major alarm
•
A minor alarm
•
The condition is not alarmed
•
The alarm is not reported
PREVIOUS
Previous severity. Optional
Parameter type is COND_EFF—the state of the condition upon the affected unit
•
Standing condition cleared
•
Standing condition raised
•
Transient condition
CONDITION
Condition type for an alarm or a reported event
Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions
OCRTIME
Time when alarm was triggered. Optional
OCRDATE
Date when the specific event or violation occurred. Date when alarm was triggered. Optional
ALMDESCR
Alarm description. String
21.56 RTRV-MAP-NETWORK
Retrieve Map Network
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves all the NE attributes which are accessible from the GNE (gateway NE). The NE attributes include the node IP address (IPADDR), node name (TID), and the product type of the NE (PRODUCT).
Note
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-MAP-NETWORK:[<TID>]::<CTAG>;
Input ExampleRTRV-MAP-NETWORK:CISCO::123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<IPADDR>,<NODENAME>,<PRODUCT>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"172.20.222.225,TID-000,15454"
;Output Parameters
21.57 RTRV-NE-APC
Retrieve Network Amplification Power Control
Usage Guidelines
Cisco ONS 15454
This command retrieves the APC application ports involved in node set up regulation.
CategorySystem
SecurityMaintenance
Related Commands
Input FormatRTRV-NE-APC:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-NE-APC:PENNGROVE:CHAN-16-1-RX:114;
Input Parameters
Table 21-112 RTRV-NE-APC Input Parameters
AID
Access identifier from the "CHANNEL" section. A null value is equivalent to ALL
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>::[MODIFDAT=<MODIFDAT>],[MODIFTM=<MODIFTM>],
[CHECKDAT=<CHECKDAT>],[CHECKTM=<CHECKTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-16-1-RX,OCH::MODIFDAT=04-11-02,MODIFTM=12-35-00,
CHECKDAT=04-11-02,CHECKTM=12-55-00"
;Output Parameters
Table 21-113 RTRV-NE-APC Output Parameters
AID
Access identifier from the "CHANNEL" section
MOD
AID type
Parameter type is MOD2O—facility types for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards
•
Optical channel
•
Optical multiplexer section
•
Optical trace section
MODIFDAT
The last date when the APC application modified this port. The format of MODIFDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MODIFDAT is a Date. Optional
MODIFTM
The last time when the APC application modified this port. The format of MODIFTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MODIFTM is a time. Optional
CHECKDAT
The last date when the APC application controlled and validated this port. The format of CHECKDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. CHECKDAT is a date. Optional
CHECKTM
The last time when the APC application controlled and validated this port. The format of CHECKTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. CHECKTM is a time. Optional
21.58 RTRV-NE-GEN
Retrieve Network Element General
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the general NE attributes.
Note
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-NE-GEN:[<TID>]::<CTAG>;
Input ExampleRTRV-NE-GEN:CISCO::123;
Input Parameters
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"IPADDR=192.168.100.52,IPMASK=255.255.255.0,DEFRTR=192.168.100.1,
IIOPPORT=57970,NTP=192.168.100.52,ETHIPADDR=172.20.208.225,
ETHIPMASK=255.255.255.0,NAME="NODENAME",SWVER=2.01.03,
LOAD=02.13-E09A-08.15,PROTSWVER=2.01.02,PROTLOAD=02.12-E09A-09.25,
DEFDESC=\"NE DEFAULTS FEATURE\",PLATFORM=15454-ANSI,SECUMODE=NORMAL,
SUPPRESSIP=YES"
;Output Parameters
21.59 RTRV-NE-IPMAP
Retrieve Network Element Internet Protocol MAP
This command retrieves the IP address and node name of the NEs that have the DCC connection with this NE.
Note
CategoryNetwork
SecurityRetrieve
Related Commands
Input FormatRTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-NE-IPMAP:CISCO:FAC-12-1:123;
Input Parameters
Table 21-116 RTRV-NE-IPMAP Input Parameters
AID
Access identifier from the "FACILITY" section. The port of an NE carrying the DCC connection. A null value defaults to the whole NE. A null value is equivalent to ALL
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<IPADDR>,<NODENAME>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-12-1:172.20.208.225,NODENAME2"
;Output Parameters
Table 21-117 RTRV-NE-IPMAP Output Parameters
AID
Access identifier from the "FACILITY" section. Port of an NE carrying the DCC connection
IPADDR
Node IP address. String
NODENAME
Network element name. String
21.60 RTRV-NE-PATH
Retrieve Network Element Path
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15310-CL
This command retrieves the path-level attributes on an NE.
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-NE-PATH:[<TID>]::<CTAG>[::::];
Input ExampleRTRV-NE-PATH:::CTAG;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"[PDIP=<PDIP>],[XCMODE=<XCMODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"PDIP=Y,XCMODE=MIXED"
;Output Parameters
21.61 RTRV-NE-SYNCN
Retrieve Network Element Synchronization
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the synchronization attributes of the NE.
Note
•
–
–
–
CategorySynchronization
SecurityRetrieve
Related Commands
Input FormatRTRV-NE-SYNCN:[<TID>]::<CTAG>[::::];
Input ExampleRTRV-NE-SYNCN:CISCO::123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"::[TMMD=<TMMD>],[SSMGEN=<SSMGEN>],[QRES=<QRES>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"::TMMD=LINE,SSMGEN=GEN1,QRES=ABOVE-PRS,RVRTV=Y,RVTM=8.0"
;Output Parameters
21.62 RTRV-NE-WDMANS
Retrieve Network Element Wavelength Division Multiplexing Automatic Node Set Up
Usage Guidelines
Cisco ONS 15454
This command retrieves the optical node set up (WDMANS) application ports involved in node set up regulation.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-NE-WDMANS:[<TID>]::<CTAG>;
Input ExampleRTRV-NE-WDMANS:PENNGROVE::114;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[REGULATED=<REGULATED>,][PARAM=<PARAM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-16-1-RX,OCH::REGULATED=OUT-OF-RANGE,PARAM=VOAATTN"
;Output Parameters
Table 21-123 RTRV-NE-WDMANS Output Parameters
AID
Access identifier from the "ALL" section. AID is port regulated
AIDTYPE
Specifies the type of facility, link, or other addressable entity targeted by the message. A type of access identifier
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
REGULATED
The status of the port after a node set up regulation. Optional
Parameter type is REGULATED_PORT_TYPE—optical configuration types for NEs
•
WDM-ANS encountered a failure while regulating this port
•
WDM-ANS does not foresee any algorithm or does not have any value to set for the parameter
•
WDM-ANS cannot modify the set point because the calculated value is out of the allowed range
•
WDM-ANS cannot modify the set point because the ports are in IS state
•
WDM-ANS has successfully regulated this port
•
WDM-ANS has not changed this port
PARAM
The regulated parameter inside of the specified port. Optional
Parameter type is REGULATED_PARAM_NAME—the name of the parameter regulated by the WDMANS application
•
WDM-ANS has regulated the amplifier control mode parameter
•
WDM-ANS has regulated the amplifier per the channel power parameter
•
WDM-ANS has regulated the amplifier gain parameter
•
WDM-ANS has regulated the OPWR-LFAIL threshold parameter
•
WDM-ANS has regulated the amplifier tilt reference parameter
•
WDM-ANS has regulated the VOA attenuation reference parameter
•
WDM-ANS has regulated the VOA power reference parameter
21.63 RTRV-NETYPE
Retrieve Network Element Type
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the NE's equipment-related information.
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-NETYPE:[<TID>]::<CTAG>;
Input ExampleRTRV-NETYPE:GAUR1::1;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<VENDOR>,<MODEL>,<NETYPE>,<SW_ISSUE"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CISCO,ONS15454,ADM&MSPP&MSTP,5.00.00"
;Output Parameters
21.64 RTRV-OCH
Retrieve Optical Channel
Usage Guidelines
Cisco ONS 15454
This command retrieves the attributes (service parameters) and state of an OCH facility.
Refer to the Cisco ONS SONET TL1 Reference Guide for specific card provisioning rules.
Note
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-OCH:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OCH:PENNGROVE:CHAN-6-2:236;
Input Parameters
Table 21-126 RTRV-OCH Input Parameters
AID
Access identifier from the "CHANNEL" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-6-1:,,WORK,ACT:RDIRN=W-E,OPTYPE=DROP,OPWR=10.0,EXPWLEN=1530.33,
ACTWLEN=1530.33,ILOSS=1.0,VOAMODE=ATTN,VOAATTN=0.5,VOAPWR=0.0,
VOAREFATTN=3.5,VOAREFPWR=5.0,REFOPWR=10.5,CALOPWR=0,CHPOWER=2.0,
NAME="NY PORT",SFBER=1E-4,SDBER=1E-5,COMM=GCC,GCCRATE=192K,DWRAP=Y,
FEC=STD,PAYLOADMAP=ASYNCH,OSFBER=1E-4,OSDBER=1E-5,
MACADDR=00-0E-AA-BB-CC-FF,SYNCMSG=Y,SENDDUS=Y,SOAK=52,SOAKLEFT=12-25,
OSPF=Y,LBCL=10.0,OPT=10.0,OPR=10.0:OOS-AU,AINS"
;Output Parameters
Table 21-127 RTRV-OCH Output Parameters
AID
Access identifier from the "CHANNEL" section
ROLE
Identifies an OCH port role. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
STATUS
The port status. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
RDIRN
Ring directionality of the optical channel. Optional
Parameter type is RDIRN_MODE—the optical ring directionality
•
The direction of the signal is from east to west (clockwise)
•
The direction of the signal is from west to east (counterclockwise)
OPTICALPORTTYPE
The optical port type. Only applicable to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Optional
Parameter type is OPTICAL_PORT_TYPE—qualifies the optical port of a card
•
The signal is added to the port
•
The signal is dropped from the port
•
COM channels (without OSC) that continue the signal from the previous card
•
Input DCU port
•
The express channel that continues the signal from the previous card
•
All the channels that continue the signal from the previous card
•
OSC channel that continues the signal from the previous card
•
COM channels (without OSC) that continue the signal to the next card
•
Output DCU port
•
Express channel that continues the signal to the next card
•
All the channels that continue the signal to the next card
•
OSC channel that continue the signal to the next card
POWER
The optical power measured at this port. It can be the input or output power according to port type. Only applicable to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. String. Optional
EXPWLEN
Optical wavelength for this port. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. String. Optional
Parameter type is OPTICAL_WLEN—optical wavelength. See values below
ACTWLEN
The manufacturing optical wavelength for this port. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Optional
Parameter type is OPTICAL_WLEN—optical wavelength
•
Wavelength 1
•
Wavelength 2
•
Wavelength 3
•
Wavelength 4
•
Wavelength 5
•
Wavelength 6
•
Wavelength 7
•
Wavelength 8
•
Wavelength 9
•
Wavelength 10
•
Wavelength 11
•
Wavelength 12
•
Wavelength 13
•
Wavelength 14
•
Wavelength 15
•
Wavelength 16
•
Wavelength 17
•
Wavelength 18
•
Wavelength 19
•
Wavelength 20
•
Wavelength 21
•
Wavelength 22
•
Wavelength 23
•
Wavelength 24
•
Wavelength 25
•
Wavelength 26
•
Wavelength 27
•
Wavelength 28
•
Wavelength 29
•
Wavelength 30
•
Wavelength 31
•
Wavelength 32
•
Use Tunable Wavelength 1
ILOSS
Insertion loss expressed in dBm. ILOSS applies to output ports only on the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. String. Optional
VOAMODE
The working control mode of the VOA. Applies only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Optional
Parameter type is VOA_CNTR_MODE—defines the VOA control mode
•
VOA has a fixed attenuation
•
VOA controls the attenuation to obtain a fixed output power
VOAATTN
The transit power attenuation for the variable optical attenuator (VOA) expressed in dBm. The range is -24.0 to +2.0 dBm for the MXP_2.5G_10G and TXP_MR_10G cards. String. Optional
VOAPWR
The value of calibrated output power that the VOA is going to set as a result of its attenuation. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Float. String. Optional
VOAREFATTN
The value of reference attenuation for the VOA. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Float. String. Optional
VOAREFPWR
The value of reference output power that the VOA is going to set as a result of its attenuation. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Float. String. Optional
REFOPWR
The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Float. String. Optional
CALOPWR
The value of the calibrated optical power expected for the output added to the calculated value which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B. Float. String. Optional.
CHPOWER
The value of per channel optical power expected to the OCH drop port of an AD-4C unit. CHPOWER is a float expressed in dBm
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PORTNAME
Port name. String. Optional
SFBER
Signal failure threshold for the SONET payload. Can only be provisioned on the working port. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
Signal degrade threshold for the SONET payload. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
COMM
The GCC or DCC is enabled or disabled. The GCC can be enabled only if the digital wrapper has been enabled for the card. The default is NONE. For an MXP_2.5G_10G/TXP_MR_10G client port, only the DCC can be provisioned if the termination mode is not transparent and the payload is SONET. On an MXP_2.5G_10G/TXP_MR_10G DWDM port, the DCC can be enabled only if the G.709 is not enabled and if the payload is SONET and the termination mode is not transparent. On an MXP_2.5G_10G/TXP_MR_10G DWDM port, the GCC can be enabled if there is no DCC and the G.709 flag is enabled. Optional
Parameter type is COMM_TYPE—out of band communications channel termination type
•
Section DCC type
•
Generic communication channel (OTN) type
•
Disable DCC or GCC if enabled
GCCRATE
The data rate of the GCC traffic. The default is 192 kbps. For MXP_2.5G_10G/TXP_MR_10G cards this applies only to the DWDM port. The 576K option is not supported in this release. Optional
Parameter type is GCCRATE—the data rate of the GCC traffic
•
192 kbps
•
576 kbps
DWRAP
The G.709 digital wrapper. It is either on or off. The system default is ON. For MXP_2.5G_10G/TXP_MR_10G cards, this applies only to the DWDM port. Optional
To enable G.709:
•
•
To disable G.709:
•
•
•
•
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
FEC
Forward error correction. It can be enabled only if the G.709 is turned ON. It is either off or enabled in standard or enhanced mode. The system default is standard FEC enabled. The FEC level PM and thresholds apply if the FEC is turned ON. Optional
Parameter type is FEC_MODE—specifies the type of forward error correction
•
Enhanced FEC is enabled
•
FEC is disabled
•
Standard FEC is enabled
PAYLOADMAP
The type of payload mapping. It can be enabled only if the G.709 is turned ON and FEC is enabled. Optional
Parameter type is PAYLOAD_MAPPING—payload mapping mode
•
Asynchronous mapping mode
•
ODU multiplex structure mode
•
Synchronous mapping mode
OSFBER
The signal failure threshold at the OTN level. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
OSDBER
The signal degrade threshold at the OTN level. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
MACADDR
MAC address for the 10GigE payload. String. Optional
SYNCMSG
The facility be enabled to provide the synchronization clock. This does not apply to the TXP_MR_10G card. This applies to an MXP_2.5G_10G card, only if the payload is SONET/SDH and the card termination mode is as follows:
TRANSPARENT - All Client ports are available for all timing selections. All Trunk ports are not available.
LINE - All ports are available for all-timing selections. OptionalParameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SENDDUS
The facility sends out a Do not Use for Sync message. This does not apply to the TXP_MR_10G card. This applies to an MXP_2.5G_10G card, only if the payload is SONET/SDH and the card termination mode is as follows:
TRANSPARENT- All Client ports are available for all timing selections. All Trunk ports are not available.
LINE - All ports are available for all-timing selectionsParameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
OOS-AINS to IS transition soak time as measured in 15-minute intervals, so a value of 4 translates to a soak time of 1 hour. The allowable range is 0 to 192 intervals, 48 hours maximum. Optional
OSPF
Open shortest path first. Optional
Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol
•
The ring does not support the extended K1/K2/K3 protocol
•
The ring does support the extended K1/K2/K3 protocol
LBCL
Displays the current value of the laser current. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
OPT
Displays the current value of the transmitted optical power. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
OPR
Displays the current value of the received optical power. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.65 RTRV-OMS
Retrieve Optical Multiplex Section
Usage Guidelines
Cisco ONS 15454
This command retrieves the attributes (service parameters) and state of an OMS facility.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-OMS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OMS:PENNGROVE:BAND-6-1-RX:236;
Input Parameters
Table 21-128 RTRV-OMS Input Parameters
AID
Access identifier from the "BAND" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-RX::RDIRN=W-E,OPTYPE=ADD,OPWR=10.0,EXPBAND=UNKNOWN,
ACTBAND=1530.33_1531.12,ILOSS=1.0,VOAMODE=ATTN,VOAATTN=0.5,
VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,REFOPWR=10.5,CALOPWR=0.5,
CHPOWER=2.0,NAME=\"OMS PORT\":OOS-AU,AINS"
;Output Parameters
Table 21-129 RTRV-OMS Output Parameters
AID
Access identifier from the "CHANNEL" section
RDIRN
Ring directionality of the optical line
Parameter type is RDIRN_MODE—the optical ring directionality
•
The direction of the signal is from east to west (clockwise)
•
The direction of the signal is from west to east (counterclockwise)
OPTICALPORTTYPE
The optical port type
Parameter type is OPTICAL_PORT_TYPE—qualifies the optical port of a card
•
The signal is added to the port
•
The signal is dropped from the port
•
COM channels (without OSC) that continue the signal from the previous card
•
Input DCU port
•
The express channel that continues the signal from the previous card
•
All the channels that continue the signal from the previous card
•
OSC channel that continues the signal from the previous card
•
COM channels (without OSC) that continue the signal to the next card
•
Output DCU port
•
Express channel that continues the signal to the next card
•
All the channels that continue the signal to the next card
•
OSC channel that continue the signal to the next card
POWER
The optical power measured at this port. It can be the input or output power according to port type. String. Optional
EXPBAND
The expected value of band for this port
Parameter type is OPTICAL_BAND—optical band
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit
ACTBAND
Identifies the manufacturing optical band (group of four contiguous wavelengths) for this port. Optional
Parameter type is OPTICAL_BAND—optical band
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit
ILOSS
Insertion loss expressed in dBm. ILOSS applies to output ports only. Optional
VOAMODE
The working control mode of the VOA. Optional
Parameter type is VOA_CNTR_MODE—defines the VOA control mode
•
VOA has a fixed attenuation
•
VOA controls the attenuation to obtain a fixed output power
VOAATTN
The value of calibrated attenuation for the VOA. Float. String. Optional
VOAPWR
The value of calibrated output power that the VOA is going to set as a result of its attenuation. Float. String. Optional
VOAREFATTN
The value of reference attenuation for the VOA. Float. String. Optional
VOAREFPWR
The value of reference output power that the VOA is going to set as a result of its attenuation. Float. String. Optional
REFOPWR
The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. Float. String. Optional
CALOPWR
The value of the calibrated optical power expected for the output added to the calculated value which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. Float. String. Optional.
CHPOWER
The per channel optical power. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
NAME
Name. String. Optional
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.66 RTRV-OPM
Retrieve Optical Monitoring Parameter
Usage Guidelines
Cisco ONS 15454
This command retrieves the optical power monitoring parameters present at the OCH layer in a R-OADM node.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-OPM:[<TID>]:[<AID>]:<CTAG>[::::];
Input ExampleRTRV-OPM:VA454-22:OPM-5-1530.33:116;
Input Parameters
Table 21-130 RTRV-OPM Input Parameters
AID
Access identifier from the "OPM" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[POWEROUT=<POWEROUT>],[POWERADD=<POWERADD>],
[POWERPT=<POWERPT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"OPM-5-1530.33::POWEROUT=9.0,POWERADD=10.0,POWERPT=11.0:"
;Output Parameters
Table 21-131 RTRV-OMS Output Parameters
AID
Access identifier from the "OPM" section
POWEROUT
The value of the output power associated to the add or pass-through channel port of 32-WSS. Float. Optional
POWERADD
The value of the input power associated to the add channel port of 32-WSS. POWERADD is mutually exclusive with the POWERPT parameter. Float. Optional
POWERRPT
The value of the input power associated to the pass-through channel port of 32-WSS. POWERPT is mutually exclusive with the POWERADD parameter. Float. Optional
21.67 RTRV-OSC
Retrieve Optical Service Channel
Usage Guidelines
Cisco ONS 15454
This command retrieves all the OSC (optical service channel) information of the NE.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-OSC:[<TID>]:<AID>:<CTAG
Input ExampleRTRV-OSC:PENNGROVE:OSC-1:114;
Input Parameters
Table 21-132 RTRV-OSC Input Parameters
AID
Access identifier from the "OSC" section. Identifies the OSC group of the NE. Only ALL, null, or OSC-# in AID is allowed. A null value is equivalent to ALL. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[RINGID=<RINGID>],[NODEID=<NODEID>],[EAST=<EAST>],[WEST=<WEST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"OSC-1::RINGID=10,NODEID=1,EAST=FAC-8-1,WEST=FAC-10-1"
;Output Parameters
Table 21-133 RTRV-OSC Output Parameters
AID
Access identifier from the "OSC" section. Identifies the OSC group of the NE
RINGID
OSC ring ID of the NE. It is a string of up to six characters, valid characters are [A to Z, 0 to 0]. Default value is # of AID OSC-#. Integer. Optional
NODEID
OSC node ID of the NE. It ranges from 0 to 31. Integer. Optional
EAST
The east OC3 facility from the "FACILITY" section. EAST_OC3 is the AID facility. Only one OC-3 for the east direction is supported in this release. Optional
WEST
The west OC3 facility from the "FACILITY" section. EAST_OC3 is the AID facility. Only one OC-3 for the west direction is supported in this release. Optional
21.68 RTRV-OTS
Retrieve Optical Transport System
Usage Guidelines
Cisco ONS 15454
This command retrieves the attributes (service parameters) and state of an OTS facility.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-OTS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OTS:PENNGROVE:LINE-6-1-RX:236;
Input Parameters
Table 21-134 RTRV-OTS Input Parameters
AID
Access identifier from the "LINE" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"LINE-6-1-RX:RDIRN=W-E,OPTYPE=IN,OPWR=10.0,ILOSS=1.0,VOAMODE=ATTN,
VOAATTN=0.5,VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,OSRI=Y,
AMPLMODE=GAIN,CHPOWER=-10.0,GAIN=3.0,EXPGAIN=3.0,REFOPWR=10.0,
OFFSET=0.0,REFTILT=3.0,CALTILT=0.0,ASEOPWR=5.0,DCULOSS=1.2,
AWGST=WARM-UP,HEATST=ON,NAME=\"OTS PORT\":OOS-AU,AINS"
;Output Parameters
Table 21-135 RTRV-OTS Output Parameters
AID
Access identifier from the "LINE" section
RDIRN
Ring directionality of the optical line
Parameter type is RDIRN_MODE—the optical ring directionality
•
The direction of the signal is from east to west (clockwise)
•
The direction of the signal is from west to east (counterclockwise)
OPTICALPORTTYPE
The optical port type
Parameter type is OPTICAL_PORT_TYPE—qualifies the optical port of a card
•
The signal is added to the port
•
The signal is dropped from the port
•
COM channels (without OSC) that continue the signal from the previous card
•
Input DCU port
•
The express channel that continues the signal from the previous card
•
All the channels that continue the signal from the previous card
•
OSC channel that continues the signal from the previous card
•
COM channels (without OSC) that continue the signal to the next card
•
Output DCU port
•
Express channel that continues the signal to the next card
•
All the channels that continue the signal to the next card
•
OSC channel that continue the signal to the next card
POWER
The optical power measured at this port. It can be the input or output power according to port type. Float. Optional
ILOSS
Insertion loss. Optional
VOAMODE
The working control mode of the VOA. Optional
Parameter type is VOA_CNTR_MODE—defines the VOA control mode
•
VOA has a fixed attenuation
•
VOA controls the attenuation to obtain a fixed output power
VOAATTN
The value of calibrated attenuation for the VOA. Float. Optional
VOAPWR
The value of calibrated output power that the VOA is going to set as a result of its attenuation. Float. Optional
VOAREFATTN
The value of reference attenuation for the VOA. Float. Optional
VOAREFPWR
The value of reference output power that the VOA is going to set as a result of its attenuation. Float. Optional
OSRI
OSRI enabled or disabled. Present only on a port where the safety is supported. Defaults to off. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
AMPLMODE
The optical amplification control mode. Optional
Parameter type is AMPL_MODE—defines amplifier control mode
•
The amplifier always maintains a fixed gain
•
The amplifier maintains the output power to a fixed value
CHPOWER
The per channel optical power. Applicable only to amplified OTS ports. Optional
GAIN
The value of the gain of the amplifier. Defaults to 21 dB for preamplifier and 20 dB for booster amplifier. Optional
EXPGAIN
The expected gain value to be reached from an amplifier when the node is in a DWDM access network. Float. Optional
REFOPWR
The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. Float. Optional
OFFSET
The value of the calibrated optical power expected for the output line which is added to the calculated value to have the total expected output power. Float. Optional
REFTILT
The calculated tilt value to be added to the user provided calibration value. Float. Optional
CALTILT
The amplifier calibration tilt offset to be added to the calculated reference value. Float. Optional
ASEOPWR
The value of the calibrated optical power expected for the output line which is provided by the user, added to the calculated value to have the total expected output power. Float. Optional
DCULOSS
The value of insertion loss associated to DCU in between the two stages of a preamplifier unit. Float. Optional
AWGST
The status assumed by AWG. Optional
Parameter value is AWG_STATUS—AWG status list
•
The AWG is on
•
The AWG is warming up
HEATST
The status assumed by the heater. Optional
Parameter type is HEATER_STATUS—heater status list
•
The heater is off
•
The heater is on
NAME
Name of the port. String. Optional
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.69 RTRV-PM-<MOD2>
Retrieve Performance (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the values of PM parameters for a specified card type.
See Table 27-1 for supported modifiers by platform.
<MONTYPE>, <MONLEV>, <MONDAT> and <MONTM> are supported in this release.
<MONLEV> is in the format of LEV-DIRN.
The format of <MONDAT> is MM-DD, where MM (month of the year) ranges from 1-12 and DD (day of the month) ranges from 1-31.
The format for <MONTM> is HH-MM, where HH (hour of the day) ranges from 0-23 and MM (minute of the hour) ranges from 0-59.
Note
•
•
•
•
•
•
•
•
The rules are as follows: Client port only-Laser and SONET PM's are applicable and will appear. If the card payload is in SONET mode, then SONET PM's will appear, provided the MONLEV criteria is met.
Trunk port Laser PMs are always available. Laser PMs are only for Near End. If G.709 is enabled, then the OTN PMs will appear. If G.709 is enabled and FEC is enabled, then the FEC PMs will appear. If the card payload is in SONET mode, then SONET PM's will appear. All PM MONVALUES should pass the MONLEV filter criteria.
•
•
•
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-PM-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<DATE>],[<TIME>];Input ExampleRTRV-PM-T1:TID:FAC-2-1:123::CVL,10-UP,NEND,RCV,15-MIN,04-11,12-45;
Input Parameters
Table 21-136 RTRV-PM-<MOD2> Input Parameters
AID
Access identifier from the "ALL" section. All of the STS, VT1, Facility, and DS1 AIDs are supported. Must not be null
MONTYPE
Monitored type. A null value defaults to "all montypes applicable to the modifier"
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second -Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second - Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
MONLEV
The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. String
LOCN
Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
DIRECTION
Type of direction. Must not be null
Parameter type is DIRECTION—transmit and receive directions
•
Both transmit and receive directions
•
Receive direction only
•
Transmit direction only
TMPER
Accumulation time period for performance counters. If TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null. A null value defaults to 15-MIN
Parameter type is TMPER—accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
DATE
The beginning date of the PM or storage register period specified in TMPER. The format of DATE is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to current date
TIME
The beginning time of day of the PM or storage register period specified in TMPER. The format of TIME is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to current time
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<MONDAT>],[<MONTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,DS1-14:CVL,21,COMPL,NEND,RCV,15-MIN,04-11,12-45"
;Output Parameters
Table 21-137 RTRV-PM-<MOD2> Output Parameters
AID
Access identifier from the "ALL" section
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
MONTYPE
Monitored type
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
MONVAL
The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. String
VLDTY
Indicates whether the information for the specified time period was accumulated over the entire time period or some portion thereof. Validity indicator for the reported PM data. Optional
Parameter type is VALIDITY—response validity
•
Complete response
•
Partial response
LOCN
Location associated with a particular command. Optional
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
DIRECTION
The PM count retrieval direction
Parameter type is DIRECTION—transmit and receive directions
•
Both transmit and receive directions
•
Receive direction only
•
Transmit direction only
TMPER
Accumulation time period for performance counters, Optional
Parameter type is TMPER—accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
MONDAT
The beginning date of the PM or storage register period specified in TMPER. The format of MONDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. String. Optional
MONTM
The beginning time of day of the PM or storage register period specified in TMPER. The format of MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. String. Optional
21.70 RTRV-PMMODE-<STS_PATH>
Retrieve Performance Mode of PM Data Collection (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the type of PM mode that has been previously set in the NE. This command can be used to identify whether the PM parameters are Section, Line or Path type, and to identify whether or not the PMs are being collected by the NE.
See Table 27-1 for supported modifiers by platform.
Note
•
•
•
•
•
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-PMMODE-<STS_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>;
Input ExampleRTRV-PMMODE-STS1:CISCO:STS-4-1-2:123::NEND;
Input Parameters
Table 21-138 RTRV-PMMODE-<STS_PATH> Input Parameters
SRC
Source access identifier from the "CrossConnectId" section. Must not be null
LOCN
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Must not be null
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
Output FormatSID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:[<LOCN>],<MODETYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-4-1-2:NEND,P"
;Output Parameters
Table 21-139 RTRV-PMMODE-<STS_PATH> Output Parameters
CROSSCONNECTID
Access identifier from the "CrossConnectId" section
LOCN
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Optional
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
MODETYPE
The type of PM parameters that the entity or the sub entity is to store as a result of an attribute change
Parameter type is PM_MODE—the type of PM parameters
•
Transport Path PM parameters
21.71 RTRV-PMSCHED-<MOD2>
Retrieve Performance Monitoring Schedule (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the PM reporting schedule that was set for the NE by the SCHED-PMREPT command.
See Table 27-1 for supported modifiers by platform.
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-PMSCHED-<MOD2>:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-PMSCHED-OC3:CISCO-NODE:FAC-3-1:123;
Input Parameters
Table 21-140 RTRV-PMSCHED-<MOD2> Input Parameters
AID
Access identifier from the "ALL" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],,
[<MONLEV>],<LOCN>,,[<TMPER>],[<TMOFST>],[<INHMODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,OC3:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW"
;Output Parameters
Table 21-141 RTRV-PMSCHED-<MOD2> Output Parameters
AID
Access identifier from the "ALL" section
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
REPTINVL
Reporting interval. How often a report is to be generated and sent to the appropriate NE. String
REPTDAT
Report date. Date for the next report. String
REPTTM
Report time. The time of day for the next PM report. String
NUMINVL
The remaining number of intervals over which the PM will be reported. Integer. Optional
LOCN
Location associated with a particular command. Identifies the location from which the PM mode will be retrieved
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
TMPER
Accumulation time period for performance counters. Optional
Parameter type is TMPER—accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
TMOFST
Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. String. Optional
INHMODE
Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). Optional
Parameter type is INH_MODE—indicates whether the function is inhibited
•
Function is allowed
•
Function is inhibited
21.72 RTRV-PMSCHED-ALL
Retrieve Performance Schedule All
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves all the PM reporting schedules that were set for the NE by the SCHED-PMREPT command.
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-PMSCHED-ALL:[<TID>]::<CTAG>;
Input ExampleRTRV-PMSCHED-ALL:CISCO-NODE::123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],,
[<MONLEV>],<LOCN>,,[<TMPER>],<TMOFST>,[<INHMODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,OC3:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW"
;Output Parameters
Table 21-143 RTRV-PMSCHED-ALL Output Parameters
AID
Access identifier from the "ALL" section
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS-1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
REPTINVL
Reporting interval. How often a report is to be generated and sent to the appropriate NE. String
REPTDAT
Report date. Date for the next report. String
REPTTM
Report time. The time of day for the next PM report. String
NUMINVL
The remaining number of intervals over which PM is to be reported. Integer. Optional
LOCN
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
TMPER
Accumulation time period for performance counters. Optional
Parameter type is TMPER—accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
TMOFST
Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. String. Optional
INHMODE
Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). Optional
Parameter type is INH_MODE—indicates whether the function is inhibited
•
Function is allowed
•
Function is inhibited
21.73 RTRV-POS
Retrieve Packet Over SONET
Usage Guidelines
Cisco ONS 15454, 15310-CL, 15600
This command retrieves the back end port information for the Ethernet card when the back end port is working in POS mode.
Note
•
•
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-POS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-POS:TID:VFAC-1-1:CTAG;
Input Parameters
Table 21-144 RTRV-POS Input Parameters
AID
Access identifier from the "FACILITY" section
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[ADMINSTATE=<ADMINSTATE>],[LINKSTATE=<LINKSTATE>],
[MTU=<MTU>],[ENCAP=<ENCAP>],[NAME=<NAME>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>]:<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-1-1::ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,ENCAP=HDLC,
NAME=\"POSPORT\",SOAK=32,SOAKLEFT=\12-25\":OOS-AU,AINS"
;Output Parameters
Table 21-145 RTRV-POS Output Parameters
AID
Access identifier from the "FACILITY" section
ADMINSTATE
Administration type. Optional
Parameter type is UP_DOWN—Up or down
•
Down
•
Up
LINKSTATE
Link protocol. Optional
Parameter type is UP_DOWN—Up or down
•
Down
•
Up
MTU
Maximum transmission unit. Integer. Optional
ENCAP
Encapsulation
Parameter type is ENCAP—frame encapsulation type
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
NAME
Name. String. Optional
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
PST_PSTQ
Primary state of the entity
Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.74 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
Retrieve Protection Switch (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, PASSTHRU)
Usage Guidelines
Cisco ONS 15454
This command retrieves the protection switch status of client facilities.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-PROTNSW-<MOD2DWDMPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-PROTNSW-HDTV:CISCO:FAC-1-1-1:100;
Input Parameters
Table 21-146 RTRV-PROTNSW-<MOD2DWDMPAYLOAD> Input Parameters
SRC
Source access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>:<SC>,[<SWITCHTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1:FRCD,MANWKSWBK"
;Output Parameters
Table 21-147 RTRV-PROTNSW-<MOD2DWDMPAYLOAD> Output Parameters
AIDUNIONID
Access identifier from the "FACILITY" section
SC
Switch command to be initiated on the paths
Parameter type is SW—the type of switch to be initiated
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands
•
Forces a switch unless another FRCD or LOCKOUT is in effect
•
Locks the facility out of switching. The system cannot switch to this facility to carry service
•
Requests a manual switch of the facility
SWITCHTYPE
Switch type. Optional
Parameter type is SWITCH_TYPE—BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection
•
Working unit is forced to switch back to working
•
Working unit is forced to switch to the protection unit
•
Lockout of protection
•
Lockout of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
BLSR ring switch type
•
BLSR span switch type
21.75 RTRV-PROTNSW-<OCN_TYPE>
Retrieve Protection Switch (OC3, OC12, OC48, OC192)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the switching state of a SONET line specified in the AID.
See Table 27-1 for supported modifiers by platform.
CategoryProtection
SecurityRetrieve
Related Commands
Input FormatRTRV-PROTNSW-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-PROTNSW-OC48:CISCO:FAC-5-1:123;
Input Parameters
Table 21-148 RTRV-PROTNSW-<OCN_TYPE> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<SC>,[<SWITCHTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1:MAN,MANWKSWBK"
;Output Parameters
Table 21-149 RTRV-PROTNSW-<OCN_TYPE> Output Parameters
AID
Access identifier from the "FACILITY" section
SC
Switch command to be initiated on the paths
Parameter type is SW—the type of switch to be initiated
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands
•
Forces a switch unless another FRCD or LOCKOUT is in effect
•
Locks the facility out of switching. The system cannot switch to this facility to carry service
•
Requests a manual switch of the facility
SWITCHTYPE
Switch type. Optional
Parameter type is SWITCH_TYPE—BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection
•
Working unit is forced to switch back to working
•
Working unit is forced to switch to the protection unit
•
Lockout of protection
•
Lockout of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
BLSR ring switch type
•
BLSR span switch type
21.76 RTRV-PROTNSW-<PATH>
Retrieve Protection Switch (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the switching state of a SONET Path Protection STS path specified in the AID. Because the GR-1400 does not allow the LOCKOUT_OF_WORKING on the Path Protection WORKING path/AID, the "AID:LOCKOUT,LOCKOUTOFWK" does not appear in this protection switch retrieval result.
See Table 27-1 for supported modifiers by platform.
CategoryProtection
SecurityRetrieve
Related Commands
Input FormatRTRV-PROTNSW-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-PROTNSW-STS1:CISCO:STS-5-1-1:123;
Input Parameters
Table 21-150 RTRV-PROTNSW-<PATH> Input Parameters
SRC
Source access identifier from the "CrossConnectId" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:<SC>,[<SWITCHTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-5-1-1:MAN,MANWKSWBK"
;Output Parameters
Table 21-151 RTRV-PROTNSW-<PATH> Output Parameters
CROSSCONNECTID
Access identifier from the "CrossConnectId" section
SC
Switch command that is to be initiated on the paths
Parameter type is SW—the type of switch to be initiated
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands
•
Forces a switch unless another FRCD or LOCKOUT is in effect
•
Locks the facility out of switching. The system cannot switch to this facility to carry service
•
Requests a manual switch of the facility
SWITCHTYPE
Switch type. Optional
Parameter type is SWITCH_TYPE—BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection
•
Working unit is forced to switch back to working
•
Working unit is forced to switch to the protection unit
•
Lockout of protection
•
Lockout of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
BLSR ring switch type
•
BLSR span switch type
21.77 RTRV-PROTNSW-OCH
Retrieve Protection Switch Optical Channel
Usage Guidelines
Cisco ONS 15454
This command retrieves the protection switch status of a TXPP_MR_2.5G card.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-PROTNSW-OCH:VA454-22:CHAN-2-2:100;
Input Parameters
Table 21-152 RTRV-PROTNSW-OCH Input Parameters
AID
Access identifier from the "CHANNEL" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<SW>,<SWTYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2:FRCD,FRCDWKSWBK"
;Output Parameters
Table 21-153 RTRV-PROTNSW-OCH Output Parameters
AID
Access identifier from the "CHANNEL" section
SW
Indicates the switch operation
Parameter type is SW—the type of switch to be initiated
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands
•
Forces a switch unless another FRCD or LOCKOUT is in effect
•
Locks the facility out of switching. The system cannot switch to this facility to carry service
•
Requests a manual switch of the facility
SWITCHTYPE
Indicates the switch type operation
Parameter type is SWITCH_TYPE—BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection
•
Working unit is forced to switch back to working
•
Working unit is forced to switch to the protection unit
•
Lockout of protection
•
Lockout of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
BLSR ring switch type
•
BLSR span switch type
21.78 RTRV-PROTOCOL
Retrieve Protocol
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the status of a protocol/service supported in the NE. Valid protocols include: SHELL, EMS, TL1 and SNMP. If the AID is not specified, the status of all the protocols is retrieved.
Note
CategorySecurity
SecurityRetrieve
Related Commands
Input FormatRTRV-PROTOCOL:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-PROTOCOL::EMS:123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<PROTOCOLAID>:<PROTOCOLSTAT>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"EMS:UNSECURE"
;Output Parameters
21.79 RTRV-PTHTRC-<PATH>
Retrieve Path Trace (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the contents of the SONET path trace message.
See Table 27-1 for supported modifiers by platform.
The path trace message is a 64-character string with the last two characters reserved for the terminating CR (carriage return) and the LF (line feed). The message can be an incoming path trace message, an expected incoming path trace message, or an outgoing path trace message, which is inserted into the path overhead of the outgoing signal.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The path trace mode defaults to OFF mode. The MANUAL mode performs the comparison of the received string with the user-entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user-entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.
When the transmitted string is queried under the OFF, MANUAL or AUTO path trace mode, the transmitted string is the provisioned transmit string.
Note
•
•
•
•
•
•
•
•
•
•
CategoryTroubleshooting and Test Access
SecurityRetrieve
Related Commands
Input FormatRTRV-PTHTRC-<PATH>:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>][:<LOCN>];
Input ExampleRTRV-PTHTRC-STS1:CISCO:STS-2-1-1:123::EXPTRC:NEND;
Input Parameters
Table 21-156 RTRV-PTHTRC-<PATH> Input Parameters
SRC
Source access identifier from the "CrossConnectId" section. Must not be null
MSGTYPE
Type of autonomous message to be retrieved. A null value defaults to INCTRC
Parameter type is MSGTYPE—type of trace message
•
Expected incoming path trace message
•
Incoming path trace message
•
Outgoing path trace message
LOCN
Location associated with a particular command in reference to the entity identified by the AID
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
Output FormatSID DATE TIME
M CTAG COMPLD
"<TRACMSG>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"TRACMSG"
;Output Parameters
21.80 RTRV-RMONTH-<MOD2_RMON>
Retrieve Remote Monitoring Threshold (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, FSTE, G1000, GFPOS, GIGE, OCH, POS)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15310-CL
This command retrieves the thresholds defined in the RMON alarm table.
See Table 27-1 for supported modifiers by platform.
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-RMONTH-<MOD2_RMON>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],,,,
[<INTVL>]:[RISE=<RISE>],[FALL=<FALL>],[SAMPLE=<SAMPLE>],
[STARTUP=<STARTUP>][:];Input ExampleRTRV-RMONTH-GIGE:CISCO:FAC-2-1:1234::ETHERSTATSOCTETS,,,,100:RISE=1000,
FALL=100,SAMPLE=DELTA,STARTUP=RISING;Input Parameters
Table 21-158 RTRV-RMONTH-<MOD2_RMON> Input Parameters
AID
Access identifier from the "FACILITY" section. AID for the facility that the data statistic is managed by. Must not be null
MONTYPE
Monitored type. Type of RMON monitored data statistic. A null value is equivalent to ALL
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second -Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second - Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
INTVL
The interval in seconds during which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds). A null value is equivalent to ALL
RISE
The rising threshold for the sampled statistic. A valid value is any integer. A null value is equivalent to ALL
FALL
The falling threshold. A valid value is any integer smaller than the rising threshold. A null value is equivalent to ALL
SAMPLE
The method of calculating the value to be compared to the thresholds. A null value is equivalent to ALL
Parameter type is SAMPLE_TYPE—describes how the data will be calculated during the sampling period
•
Comparing directly
•
Comparing with the current value of the selected variable subtracted by the last sample
STARTUP
Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. A null value is equivalent to ALL
Parameter type is STARTUP_TYPE—indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold
•
Generates the event when the sample is smaller than or equal to the falling threshold
•
Generates the event when the sample is greater than or equal to the rising threshold
•
Generates the event when the sample is crossing the rising threshold, or the falling threshold
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:<MONTYPE>,,,,<INTVL>:INDEX=<INDEX>,
RISE=<RISE>,FALL=<FALL>,SAMPLE=<SAMPLE>,STARTUP=<STARTUP>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,GIGE:ETHERSTATSOCTETS,,,,100:INDEX=2,RISE=1000,FALL=100,
SAMPLE=DELTA,STARTUP=RISING"
;Output Parameters
Table 21-159 RTRV-RMONTH-<MOD2_RMON> Output Parameters
AIDUNIONID
Access identifier from the "FACILITY" section
AIDTYPE
The type of facility, link, or other addressable entity targeted by the message
Parameter type is MOD2_RMON—line modifiers
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
Fast Ethernet (10/100 Megabits per second)
•
Gigabit Ethernet (used for G1000 ports)
•
Generic framing protocol over SONET
•
Gigabit Ethernet (used for Non-G1000 ports)
•
Optical channel
•
Packet over SONET
MONTYPE
Monitored type. Type of RMON monitored data statistic
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second -Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second - Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
INTVL
The interval in seconds over which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds)
INDEX
The index for the threshold created by the system in the RMON threshold table. Integer
RISE
The rising threshold for the sampled statistic. A valid value is any integer
FALL
The falling threshold. A valid value is any integer smaller than the rising threshold. Integer
SAMPLE
The method of calculating the value to be compared to the thresholds
Parameter type is SAMPLE_TYPE—describes how the data will be calculated during the sampling period
•
Comparing directly
•
Comparing with the current value of the selected variable subtracted by the last sample
STARTUP
Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both
Parameter type is STARTUP_TYPE—indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold
•
Generates the event when the sample is smaller than or equal to the falling threshold
•
Generates the event when the sample is greater than or equal to the rising threshold
•
Generates the event when the sample is crossing the rising threshold, or the falling threshold
21.81 RTRV-ROLL-<MOD_PATH>
Retrieve Roll (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VC11, VC12, VC3, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600
This command retrieves roll data parameters.
See Table 27-1 for supported modifiers by platform.
CategoryBridge and Roll
SecurityRetrieve
Related Commands
Input FormatRTRV-ROLL-<MOD_PATH>:[<TID>]:<SRC>:<CTAG>;
Input ExampleRTRV-ROLL-STS1:CISCO:STS-1-1-1:6;
Input Parameters
Table 21-160 RTRV-ROLL-<MOD_PATH> Input Parameters
SRC
Source access identifier from the "CrossConnectId1" section (except VCM and FACILITY). Roll path (STS or VT). Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],
VLDSIG=<VLDSIG>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-1-1-1,STS-2-1-1:RFROM=STS-2-1-1,RTO=STS-3-1-1,RMODE=AUTO,VLDSIG=N"
;Output Parameters
Table 21-161 RTRV-ROLL-<MOD_PATH> Output Parameters
FROM
One of the termination points (legs) of the existing cross-connection. Access identifier from the "CrossConnectId1" section (except VCM and FACILITY)
TO
One of the termination points (legs) of the existing cross-connection. Access identifier from the "CrossConnectId1" section (except VCM and FACILITY)
RFROM
The termination point of the existing cross-connect that is to be rolled. AID from the "CrossConnectId1" section (except VCM and FACILITY)
RTO
The termination point that will become a leg of the new cross-connection. AID from the "CrossConnectId1" section (except VCM and FACILITY)
RMODE
The rolling mode of operation. Optional
Parameter type is ALS_MODE—specifies the working mode for the automatic laser shutdown (ALS) functionality
•
Automatic
•
Disabled
•
Manual
•
Manual Restart for Test
VLDSIG
Shows whether or not the roll has received a valid signal. VLDSIG is Y if the signal is valid and N if it is not
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
21.82 RTRV-ROUTE
Retrieve Route
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves static routes.
Note
•
CategorySystem
SecurityRetrieve
Related Commands
DLT-ROUTE
DLT-TADRMAP
DLT-TUNNEL-FIREWALL
DLT-TUNNEL-PROXY
ENT-ROUTE
ENT-TADRMAP
ENT-TUNNEL-FIREWALL
ENT-TUNNEL-PROXY
RTRV-TADRMAP
RTRV-TUNNEL-FIREWALL
RTRV-TUNNEL-PROXY
Input FormatRTRV-ROUTE:[<TID>]::<CTAG>::[<DESTIP>],[<IPMASK>],[<NXTHOP>],[<COST>];
Input ExampleRTRV-ROUTE:CISCO::123::10.64.72.57,255.255.255.0,10.64.10.1,200;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
",:<DESTIP>,<IPMASK>,<NXTHOP>,<COST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
",:\"10.64.72.57\",\"255.255.255.0\",\"10.64.10.1\",200"
;Output Parameters
Table 21-163 RTRV-ROUTE Output Parameters
DESTIP
Destination tip. String
IPMASK
IP mask. String
NXTHOP
Next hop. String
COST
Cost. Integer
21.83 RTRV-ROUTE-GRE
Retrieve Route Generic Routing Encapsulation
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command displays the existing GRE tunnels.
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-ROUTE-GRE:[<TID>]::<CTAG>[::::];
Input ExampleRTRV-ROUTE-GRE:CISCO::123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
",:IPADDR=<IPADDR>,IPMASK=<IPMASK>,NSAP=<NSAP>,COST=<COST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
",:IPADDR=10.64.72.57,IPMASK=255.255.255.0,
NSAP=39840F80FFFFFF0000DDDDAA000010CFB4910200,COST=110"
;Output Parameters
21.84 RTRV-SLV-WDMANS
Retrieve Span Loss Verification Wavelength Division Multiplexing Automatic Node Set Up
Usage Guidelines
Cisco ONS 15454
This command retrieves the expected span loss verification provisioned by the ED-SLV-WDMANS command.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-SLV-WDMANS:VA454-22:WDMANS-E:116;
Input Parameters
Table 21-166 RTRV-SLV-WDMANS Input Parameters
AID
Access identifier from the "WDMANS" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[HIGHSLVEXP=<HIGHSLVEXP>],[LOWSLVEXP=<LOWSLVEXP>],
[SLVACT=<SLVACT>],[RESOLUTION=<RESOLUTION>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"WDMANS-E::HIGHSLVEXP=10.0,LOWSLVEXP=5.0,SLVACT=10.0,RESOLUTION=1.0:"
;Output Parameters
Table 21-167 RTRV-SLV-WDMANS Output Parameters
AID
Access identifier from the "WDMANS" section
HIGHSLVEXP
The high range value of the expected span loss verification. Float. Optional
LOWSLVEXP
The low range value of the expected span loss verification. Float. Optional
SLVACT
The value of the calculated span loss verification. Float. Optional
RESOLUTION
The value of the resolution applied to the calculated span loss verification. Float. Optional
21.85 RTRV-STS
Retrieve Synchronous Transport Signal
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the attributes associated with an STS path based on the granularity level of NE/SLOT-specific STSs.
Supported AIDs are ALL, SLOT-N (N=1,2,...,ALL), STS-<SLOT>[-<PORT>]-<STS NUMBER>.
The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and UPSRPTHSTATE parameters only apply to Path Protection.
The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SONET STS Path overhead.
The EXPTRC indicates that the contents of the expected incoming path trace are provisioned by the user in the ED-STS_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode compares the received string with the user entered expected string. The AUTO mode compares the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.
J1 (EXPTRC) is implemented on the DS1/DS1N, DS3E/DS3NE, DS3XM, EC1, DS3-EC1-48 OC3, OC12-4, OC48AS, OC192, OC192-XFP, and MRC-12 cards.
TRC and INCTRC are supported on DS1(N), DS3(N)E, DS3-EC1-48, DS3XM, OC192-XFP and MRC-12 cards.
Beginning with Release 5.0, the ED-VT1 command is only supported to edit the J2 path trace on the VT1.5 cross-connection of the DS3XM-12 card.
CategoryPaths
SecurityRetrieve
Related Commands
Input FormatRTRV-STS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-STS:TID:STS-2-1-1:1;
Input Parameters
Table 21-168 RTRV-STS Input Parameters
AID
Access identifier from the "AidUnionId" section
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-2-1-4::LEVEL=STS3C,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=SINGLE,
UPSRPTHSTATE=ACT,C2=0X04,BLSRPTHSTATE=PROTPTHACT:OOS-AU,AINS"
;Output Parameters
Table 21-169 RTRV-STS Output Parameters
AID
Access identifier from the "AidUnionId" section
LEVEL
The rate of the cross-connect. Applicable only to STS paths in SONET. Optional
Parameter type is STS_PATH—modifier for some STS commands
•
Synchronous Transport Signal level-1 (51 Mbps)
•
Synchronous Transport Signal level-12 Concatenated (622 Mbps)
•
Synchronous Transport Signal level-18 Concatenated (933 Mbps)
•
Synchronous Transport Signal level-192 (9952 Mbps)
•
Synchronous Transport Signal level-24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal level-36 Concatenated (1866 Mbps)
•
Synchronous Transport Signal level-3 Concatenated (155 Mbps)
•
Synchronous Transport Signal level-48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal level-3 Concatenated (310 Mbps)
•
Synchronous Transport Signal level-9 Concatenated (465 Mbps)
SFBER
An STS path SFBER that applies only to path protection and only to STS-level paths in SONET. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
An STS path SDBER that applies only to path protection and only to STS-level paths in SONET. Defaults to 1E-6. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
RVRTV
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Only applies to path protection
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. RVTM is not allowed to be set while "RVRTV" is N. Only applies to path protection
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
SWPDIP
Switch on PDI-P. Applicable only to STS-level paths in SONET (STSn). Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
HOLDOFFTIMER
Hold off timer. Integer. Optional
EXPTRC
Expected path trace content. A 64-character ASCII string including the terminating CR (carriage return) and LF (line feed). Indicates the expected path trace message (J1) contents. Applicable only to STS-Level Paths in SONET. Defaults to null when path protection path is created. Optional
TRC
The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to STS-level paths in SONET (STSn). String. Optional
INCTRC
Identifies the incoming path trace message contents. Can be any combination of 64-characters. Applicable only to STS-level paths in SONET. Defaults to null when a path protection path is created. String. Optional
TRCMODE
Path trace mode. Applicable only to STS-level Paths in SONET (STSn). Defaults to the OFF mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Turn off path trace capability. Nothing will be reported
TACC
Indicates whether the digroup being provisioned is to be used as a test access digroup. Default is N. Integer. Optional
TAPTYPE
TAP type. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
UPSRPTHSTATE
Indicates whether a given AID is the working or standby path of a Path Protection cross-connect. Optional
Parameter type is STATUS—status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
C
The c2 byte hex code. Applicable only to STS-level paths in SONET (STSn). Optional
Parameter type is C2_BYTE—c2 byte hex code
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured STS-1 SPE
•
Locked VT Mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream
BLSRPTHSTATE
The BLSR path state only if the port is on the BLSR. Applicable only to STS-level paths in SONET (STSn). Optional
Parameter type is BLSR_PTH_STATE—the BLSR path state only if the port is on the BLSR
•
Indicates the BLSR is not switched and its PCA path is in the active state
•
Indicates the BLSR is switched and its PCA path is in the standby state
•
Indicates the BLSR is switched and its protection path is in the active state
•
Indicates the BLSR is not switched and its working path is in the active state
•
Indicates the BLSR is switched and its working path is in the standby state
PST_PSTQ
Admin state in the PST_PSTQ format
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state of the entity. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.86 RTRV-SYNCN
Retrieve Synchronization
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources can be specified (for example, PRIMARY, SECOND, THIRD).
Note
Note
CategorySynchronization
SecurityRetrieve
Related Commands
ED-BITS
ED-NE-SYNCN
ED-SYNCN
OPR-SYNCNSW
REPT ALM BITS
REPT ALM SYNCN
REPT EVT BITS
REPT EVT SYNCN
RLS-SYNCNSW
RTRV-ALM-BITS
RTRV-ALM-SYNCN
RTRV-BITS
RTRV-COND-BITS
RTRV-COND-SYNCN
RTRV-NE-SYNCN
Input FormatRTRV-SYNCN:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-SYNCN:BOYES:SYNC-NE:234;
Input Parameters
Table 21-170 RTRV-SYNCH Input Parameters
AID
Access identifier from the "SYNC_REF" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<REF>,<REFVAL>,[<QREF>],[<STATUS>],[<PROTECTSTATUS>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE:PRI,FAC-1-2,WORK,ACT,PRS"
;Output Parameters
Table 21-171 RTRV-SYNCN Output Parameters
AID
Access identifier from the "SYNC_REF" section
REF
Rank of synchronization reference. Access identifier from the "SYNCSW" section
REFVAL
Value of a synchronization reference. "SYN_SRC" section
QREF
Indicates whether the working or protect card (in a protection group) provides timing. This parameter has no significance if the reference source is BITS or INTERNAL and is left blank. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
STATUS
Status. Optional
Parameter type is STATUS—the status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
PROTECTSTATUS
Applicable to 1+1. Designates the role of the entity in the protection group. Either it is the working or the protect entity. Not applicable to the ONS 15600 Platform. Optional
Parameter type is SIDE—the role the unit is playing in the protection group
•
The entity is a protection unit in the protection group
•
The entity is a working unit in the protection group
21.87 RTRV-T1
Retrieve T1 Facility
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15310-CL
This command retrieves the DS-1 facilities configuration.
Note
Note
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-T1:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-T1:TID:FAC-2-1:1223;
Input Parameters
Table 21-172 RTRV-T1 Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1::LINECDE=AMI,FMT=ESF,LBO=0-131,TACC=8,TAPTYPE=DUAL,SOAK=52,
SOAKLEFT=12-25,SFBER=1E-4,SDBER=1E-7,NAME=\"T1 PORT\",SYNCMSG=Y,
SENDDUS=Y,RETIME=Y,AISONLPBK=AIS_ON_LPBK_ALL,AISVONAIS=Y,,AISONLOF=Y,
MODE=FDL,SYNCMAP=ASYNC,ADMSSM=STU,PROVIDESYNC=N,VTMAP=GR253,
INHFELPBK=N:OOS-AU,AINS"
;Output Format
Table 21-173 RTRV-T1 Output Parameters
AID
Access identifier from the "FACILITY" section
LINECDE
Line code. Optional
Parameter type is LINE_CODE—line code
•
Line code value is AMI
•
Line code value is B8ZS (bipolar with three-zero substitution)
FMT
Digital signal frame format. Optional
Parameter type is FRAME_FORMAT—frame format for a T1 port
•
Frame format is D4
•
Frame format is ESF
•
Frame format is unframed
LBO
Line build out settings. Integer. Optional
Parameter type is LINE_BUILDOUT—Line buildout
•
Line buildout range is 0-131
•
Line buildout range is 132-262
•
Line buildout range is 263-393
•
Line buildout range is 394-524
•
Line buildout range is 525-655
TAP
Defines the STS as a test access port with a selected unique TAP number. The TAP number is within a range of 0, 1 to 999. When TACC is 0 (zero), the TAP is deleted. Default is N. Optional
TAPTYPE
TAP type. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. String. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
SFBER
The port signal failure threshold. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
Port signal degrade threshold. Defaults to 1E-7. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
NAME
Port name. String. Optional
SYNCMSG
Synchronization status messaging is enabled or disabled on the T1 facility.
Note
Parameter type is YES_NO—whether the users password is about to expire, the user is logged into the NE, or the user is locked out of the NE
•
No
•
Yes
SENDDUS
The facility will send the DUS (Don't use for Synchronization) value as the sync status message for that facility
Note
Parameter type is YES_NO—whether the users password is about to expire, the user is logged into the NE, or the user is locked out of the NE
RETIME
Indicates if retiming is needed. Optional
Note
Parameter type is YES_NO—whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE
•
No
•
Yes
•
Indicates the DS1 path of the DS3XM-12 is in FDL T1-403 mode
AISONLPBK
Defaults to AIS_ON_LPBK_ALL. Optional
Parameter type is AIS_ON_LPBK—Indicates if AIS is sent on a loopback
•
AIS is sent on facility loopbacks
•
AIS is sent on all loopbacks
•
AIS is not sent on loopbacks
•
AIS is sent on terminal loopbacks
AISVONAIS
Defaults to N. Optional
Parameter type is ON_OFF—disable/enable an attribute
•
Disable an attribute
•
Enable an attribute
AISVONLOF
Optional
Parameter type is ON_OFF—disable/enable an attribute
•
Disable an attribute
•
Enable an attribute
MODE
Mode. Default value is FDL. Optional
Parameter type is DS1MODE—the DS1 path mode of the DS3XKM-12 card
•
Indicates the DS1 path of the DS3XM-12 is in AT&T 54016 mode
•
Indicates the DS1 path of the DS3XM-12 is in FDL T1-403 mode
SYNCMAP
The synchronous mapping for the DS1 facility. Defaults to ASYNC. Only supported on ONS 15454. Optional
Parameter type is SYNCMAP—synchronous mapping type
•
Asynchronous
•
Byte
•
Jbyte
ADMSSM
The administrative synchronization status message. Only supported on the ONS 15454. Optional
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
PROVIDESYNC
Indicates whether the facility provides synchronization. Only supported on ONS 15454. Optional
Parameter type is ON_OFF—disable/enable an attribute
•
Disable an attribute
•
Enable an attribute
VTMAP
The port to VT mapping type for that particular STS. Only supported on ONS 15454. Defaults to GR253. Optional
Parameter type is VTMAP—VT mapping
•
Mapping based on GR253
•
Mapping based on industry standard
INHFELPBK
Indicates whether far end loopbacks are inhibited on the facility. Only supported on ONS 15454. Optional
Parameter type is ON_OFF—disable/enable an attribute
•
Disable an attribute
•
Enable an attribute
PST_PSTQ
Primary state
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.88 RTRV-T3
Retrieve T3
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15310-CL
This command retrieves the facility properties of a DS3 and a DS3XM card.
Note
•
•
•
•
•
CategoryPorts
SecurityRetrieve
Related Commands
Input FormatRTRV-T3:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-T3:CISCO:FAC-1-2:123;
Input Parameters
Table 21-174 RTRV-T3 Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID 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>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-2::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225,INHFELPBK=N,TACC=8,
TAPTYPE=SINGLE,SOAK=52,SOAKLEFT=12-25,SFBER=1E-4,SDBER=1E-7,
NAME=\"T3 PORT\",AISONLPBK=AIS_ON_LPBK_ALL:OOS-AU,AINS"
;Output Parameters
Table 21-175 RTRV-T3 Output Parameters
AID
Access identifier from the "FACILITY" section
FMT
Digital signal format. Optional
Parameter type is DS_LINE_TYPE—DS123 line type
•
C-BIT line type applies to the DS3XM and DS3E cards
•
M13 line type applies to the DS3XM and DS3E cards
•
Line type is unframed. The old DS3 (L3M) and DS3CR cards can only run in unframed mode
LINECDE
Line code. Optional
Parameter type is DS_LINE_CODE—DS123 line code
•
Bipolar with three-zero substitution
LBO
Line build out settings. Integer. Optional
Parameter type is E_LBO—electrical signal line buildout
•
Electrical signal line buildout range is 0-225
•
Electrical signal line buildout range is 226-450
INHFELPBK
Far-end loopback inhibition attribute of the port. If it is Y, the automatic far-end loopbacks are inhibited. It is either on or off. The system default is N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
TAP
Defines the STS as a test access port with a selected unique TAP number. The TAP number is within a range of 0, 1 to 999. When TACC is 0 (zero), the TAP is deleted. Default is N. Optional
TAPTYPE
TAP type. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
SOAK
OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional
SOAKLEFT
Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. String. Optional
Rules for <SOAKLEFT> are as follows:•
•
•
SFBER
The port signal failure threshold. Defaults to 1E-4. Optional
Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path
•
SFBER is 1E-3
•
SFBER is 1E-4
•
SFBER is 1E-5
SDBER
Port signal degrade threshold. Defaults to 1E-7. Optional
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
NAME
Port name. String. Optional
AISONLPBK
AIS on loopback. Optional
Parameter type is AIS_ON_LPBK—Indicates if AIS is sent on a loopback
•
AIS is sent on facility loopbacks
•
AIS is sent on all loopbacks
•
AIS is not sent on loopbacks
•
AIS is sent on terminal loopbacks
PST_PSTQ
Primary state
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In-service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SSTQ
Secondary state. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in-service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.89 RTRV-TACC
Retrieve Test Access
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600
This command retrieves details associated with a TAP. The TAP is identified by the TAP number. The ALL input TAP value means that the command will return all the configured TACCs in the NE.
CategoryTroubleshooting and Test Access
SecurityRetrieve
Related Commands
Input FormatRTRV-TACC:[<TID>]:<TAP>:<CTAG>;
Input ExampleRTRV-TACC:CISCO:241:CTAG;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<TAP>:<TACC_AIDA>,<TACC_AIDB>,[<MD>],[<CROSSCONNECTID1>],
<AIDUNIONID>,<PATHWIDTH>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"241:STS-2-1-1,STS-2-2,MONE,STS-12-1-1,STS-13-1-1,STS48C"
;Output Parameters
Table 21-177 RTRV-TACC Output Parameters
TAP
The assigned number for the AID being used as a test access point. Integer
TACC_AIDA
Access identifier from the "CrossConnectId" section. The A path of the test access point. The first STS/VT path of the TAP
TACC_AIDB
The B path of the test access point. Access identifier from the "CrossConnectId" section. The second STS/VT path of the TAP. For single FAD TAP this path will be empty
MD
Test access mode. It identifies the mode of access between the TAP and the circuit connected to the TAP. Optional
Parameter type is TACC_MODE—test access mode
•
Indicates to split both the A and B paths. Connect the line incoming from E direction to the line outgoing in the E direction, and connect this looped configuration to the FAD. The line outgoing in the F direction will have a QRS connected, and the line incoming from the F direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode
•
Indicates to split both the A and B paths. Connect the line incoming from F direction to the line outgoing in the F direction, and connect this looped configuration to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode
•
Indicates that a monitor connection is to be provided from the FAD to the A transmission path of the accessed circuit
•
Indicates that a monitor connection is to be provided from the FAD1 to a DFAD, or the odd pair of a FAP, to the A transmission path and from FAD2 of the same DFAD, or the even pair of a FAP, to the B transmission path of the accessed circuit.
•
Indicates that a monitor connection is to be provided from the FAD to the B transmission path of the accessed circuit.
•
Indicates that a connection is to be provided from both the E and F sides of the A transmission path of the circuit under test to the FAD and split the A transmission path. Intrusive test access mode
•
Indicates that a connection is to be provided from both the E and F sides of the B transmission path of the circuit under test to the FAD and split the B transmission path. Intrusive test access mode
•
Indicates to split both the A and B paths and connect the E side of the accessed circuit to the FAD. The line outgoing in the F direction shall have a QRS connected, and the line incoming from the F direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode
•
Indicates to split both the A and B paths, and connect the E side of the accessed circuit to FAD1 and the F side to FAD2. Intrusive test access mode
•
Indicates to split both the A and B paths, and connect the F side of the accessed circuit to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode
CROSSCONNECTID1
Access identifier from the "CrossConnectId" section. The E path of the cross-connect. Optional
PATHWIDTH
The cross-connection width
Parameter type is CRS_TYPE—cross-connection type
•
Indicates all the STS cross-connections
•
STS1 cross-connectcross-connect
•
STS3C cross-connect
•
STS6C cross-connect
•
STS9C cross-connect
•
STS12C cross-connect
•
STS18C cross-connect
•
STS24C cross-connect
•
STS36C cross-connect
•
STS48C cross-connect
•
STS192C cross-connect
•
Indicates all the VT1 cross-connections
•
VT1 cross-connect
•
VT2 cross-connect
CROSSCONNECTID2
Access identifier from the "CrossConnectId" section. The F path of the cross-connect. Optional
21.90 RTRV-TADRMAP
Retrieve Target Identifier Address Mapping
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the contents of the TADRMAP table.
CategorySystem
SecurityRetrieve
Related Commands
DLT-ROUTE
DLT-TADRMAP
DLT-TUNNEL-FIREWALL
DLT-TUNNEL-PROXY
ENT-ROUTE
ENT-TADRMAP
ENT-TUNNEL-FIREWALL
ENT-TUNNEL-PROXY
RTRV-ROUTE
RTRV-TUNNEL-FIREWALL
RTRV-TUNNEL-PROXY
Input FormatRTRV-TADRMAP:[<TID>]:<SRC>:<CTAG>:::MODE=<MODE>;
Input ExampleRTRV-TADRMAP:[TID]:[AID]:CTAG:::MODE=PROV;
Input Parameters
Table 21-178 RTRV-TADRMAP Input Parameters
SRC
Access identifier from the "ALL" section. Must not be null
MODE
Must not be null
Parameter type is MODE—determines the category of addresses to return
•
Discovered and provisioned addresses
•
Discovered addresses
•
IP addresses
•
NSAP addresses
•
Provisioned
Output FormatSID DATE TIME
M CTAG COMPLD
"[TID=<TID>],[IP ADDRESS =<IPADDRESS>],[NSAP=<NSAP>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"TID=RANGERS1,IP ADDRESS = 64.101.245.5,
NSAP=39840FFFFFFFOOOODDDDAA01D00F0400000700"
;Output Parameters
Table 21-179 RTRV-TADRMAP Output Parameters
TID
Target identifier. String. Optional
IPADDRESS
IP address. String. Optional
NSAP
NSAP address. String. Optional
21.91 RTRV-TH-<MOD2>
Retrieve Threshold (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, VT2)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the threshold level of one or more monitored parameters.
See Table 27-1 for supported modifiers by platform.
Note
•
The message is issued to retrieve the thresholds for PM and alarm thresholds. If it is used to retrieve the alarm thresholds, the time-period is not applicable.
The presentation rules are as follows: Client port only-Laser, Alarm and SONET Thresholds are applicable and will appear. Laser and alarm thresholds are only for Near End. If the card payload is in SONET mode, then SONET Thresholds will appear. The Receiver Temperature Montypes (RXT) are only applicable to the Trunk Port. The Transceiver Voltage Montypes (XCVR) are not applicable, though it is displayed or handled.
Laser and Alarm thresholds are always available. Laser and alarm thresholds are only for Near End. If G.709 is enabled, then the OTN thresholds will appear. If G.709 is enabled and FEC is enabled, then the FEC thresholds will appear. If the card payload is in SONET mode, then SONET Thresholds will appear. The Transceiver Voltage Montypes (XCVR) are not applicable, though it is displayed or handled.
•
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],[<TMPER>][::];
Input ExampleRTRV-TH-T3:CISCO:FAC-1-3:1234::CVL,NEND,15-MIN;
Input Parameters
Table 21-180 RTRV-TH-<MOD2> Input Parameters
AID
Access identifier from the "ALL" section. Must not be null
MONTYPE
Monitored type
Note
A null value is equivalent to ALL
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second -Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second - Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
LOCN
Location associated with a particular command in reference to the entity identified by the AID. LOCN defaults to NEND (near end). A null value is equivalent to ALL
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
TMPER
Accumulation time period for performance counters. Defaults to 15-MIN. Must not be null
Parameter type is TMPER—accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,[<LOCN>],,<THLEV>,[<TMPER>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-3,DS3:CVL,NEND,,1,15-MIN"
;Output Parameters
Table 21-181 RTRV-TH-<MOD2> Output Parameters
AID
Access identifier from the "ALL" section. Must not be null
AIDTYPE
Type of facility, link or other addressable entity targeted by the message. Optional
Parameter type is MOD2B—alarm type
•
1 Gigabit fibre channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit fibre channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS18C alarm
•
STS12C alarm
•
STS24C alarm
•
STS36C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
MONTYPE
Monitored type
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second -Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second - Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
LOCN
Location associated with a particular command. Optional
Parameter type is LOCATION—the location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
THELV
Threshold level. Float
TMPER
Accumulation time period for performance counters. Optional
Parameter type is TMPER—accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
21.92 RTRV-TH-ALL
Retrieve Threshold All
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the threshold level of all monitored parameters on the NE.
Note
•
•
•
•
•
CategoryPerformance
SecurityRetrieve
Related Commands
Input FormatRTRV-TH-ALL:[<TID>]::<CTAG>::[<MONTYPE>],[<LOCATION>],[<TMPER>][::];
Input ExampleRTRV-TH-ALL:CHARGERS6::123::CVL,NEND,15-MIN;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>:<MONTYPE>,<LOCATION>,,<THLEV>,<TMPER>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1,DS3:CVL,NEND,,1,15-MIN"
;Output Parameters
Table 21-183 RTRV-TH-ALL Output Parameters
AID
Access identifier from the "AidUnionId" section
AIDTYPE
Specifies the type of facility, link, or other addressable entity targeted by the message
Parameter type is MOD2B—alarm type for certain generic TL1 commands
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
fibre channel alarm
•
FSTE alarm
•
G1000 alarm
•
GIGE alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT Alarm (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS alarm
•
STS1 alarm
•
STS3C alarm
•
STS6C alarm
•
STS9C alarm
•
STS12C alarm
•
STS18C alarm
•
STS24C alarm
•
STS48C alarm
•
STS192C alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
ONS 15327 XTC alarm
MONTYPE
Monitored type. A null value defaults to ALL
Parameter type is ALL_MONTYPE—monitoring type list
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as 1/10th of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as 1/10th of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second -Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as 1/10th of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as 1/10th of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds - A
•
High-Order Path Errored Seconds - B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpkt Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in uA
•
Maximum Laser Bias current in uA
•
Minimum Laser Bias current in uA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in 1/10 uW
•
Maximum Receive Power in 1/10 uW
•
Minimum Receive Power in 1/10 uW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in 1/10 uW
•
Maximum Transmit Power in 1/10 uW
•
Minimum Transmit Power in 1/10uW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in 1/10th of dBm
•
Optical Power—Maximum Interval Value in 1/10th of dBm
•
Optical Power—Minimum Interval Value in 1/10th of dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second - Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as 1/10th of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as 1/10th of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second - Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
LOCATION
The location. A null value defaults to NEND
Parameter type is LOCATION—location where the action is to take place
•
Action occurs on the Far End of the facility
•
Action occurs on the Near End of the facility
THLEV
Threshold level. Indicates the threshold value. Float
TMPER
The accumulation time period for performance counters. A null value defaults to 15-MIN
Parameter type is TMPER—accumulation time period for the performance management counter
•
Performance parameter accumulation interval length—every 24 hours
•
Performance parameter accumulation interval length—every 1 hour
•
Performance parameter accumulation interval length—every 1 minute
•
Performance parameter accumulation interval length—every 15 minutes
•
Performance parameter accumulation interval length—starting from the last time the counters were cleared. This is only applicable to RMON-managed PMs
21.93 RTRV-TOD
Retrieve Time of Day
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the system date and time at the instant when the command was executed. The time returned is in Coordinated Universal Time (UTC).
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-TOD:[<TID>]::<CTAG>;
Input ExampleRTRV-TOD:CAZADERO::230;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,<DIFFERENCE>:<TMTYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"2002,05,08,17,01,33,840:LINT"
;Output Parameters
21.94 RTRV-TRAPTABLE
Retrieve Trap Table
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves a trap destination entry identified by a specific trap destination address.
CategorySystem
SecurityRetrieve
Related Commands
Input FormatRTRV-TRAPTABLE:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-TRAPTABLE::1.2.3.4:1;
Input Parameters
Table 21-186 RTRV-TRAPTABLE Input Parameters
AID
Access identifier from the "IPADDR" section. IP address identifying the trap destination. Only a numeric IP address is allowed. A null value is equivalent to ALL
Output FormatSID DATE TIME
M CTAG COMPLD
"<DEST>,<TRAPPORT>,<COMMUNITY>,<SNMPVERSION>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"1.2.3.4,162,\"PRIVATE\",SNMPV1"
;Output Parameters
Table 21-187 RTRV-TRAPTABLE Output Parameters
DEST
Access identifier from the "IPADDR" section
TRAPPORT
UDP port number associated with the trap destination. Defaults to 162. Integer
COMMUNITY
Community name associated to the trap destination. Maximum of 32 characters. String
SNMPVERSION
SNMP version number. Defaults to SNMPv1
Parameter type is SNMP_VERSION—SNMP version
•
SNMP version 1 (default)
•
SNMP version 2
21.95 RTRV-TRC-<OCN_BLSR>
Retrieve Trace Client (OC12, OC192, OC48)
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600
This command retrieves the valid J1 expected trace string, retrieved trace string, trace mode, C2 byte, and STS bandwidth of the OCn port only if the port has a BLSR.
See Table 27-1 for supported modifiers by platform.
Note
Note
CategoryBLSR
SecurityRetrieve
Related Commands
Input FormatRTRV-TRC-<OCN_BLSR>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-TRC-OC48:CISCO:FAC-6-1:238;
Input Parameters
Table 21-188 RTRV-TRC-<OCN_BLSR> Input Parameters
AID
Access identifier from the "FACILITY" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[C2=<C2>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-6-1-25::LEVEL=STS1,EXPTRC="EXPTRCSTRING",INCTRC="INCTRCSTRING",
TRCMODE=AUTO,C2=0X04"
;Output Parameters
Table 21-189 RTRV-TRC-<OCN_BLSR> Output Parameters
AID
Access identifier from the "STS" section
LEVEL
The rate of the cross-connect. Optional
Parameter type is STS_PATH—modifier for some STS commands
•
Synchronous Transport Signal level-1 (51 Mbps)
•
Synchronous Transport Signal level-12 Concatenated (622 Mbps)
•
Synchronous Transport Signal level-18 Concatenated (933 Mbps)
•
Synchronous Transport Signal level-192 (9952 Mbps)
•
Synchronous Transport Signal level-24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal level-36 Concatenated (1866 Mbps)
•
Synchronous Transport Signal level-3 Concatenated (155 Mbps)
•
Synchronous Transport Signal level-48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal level-3 Concatenated (310 Mbps)
•
Synchronous Transport Signal level-9 Concatenated (465 Mbps)
EXPTRC
Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). String. Optional
INCTRC
The incoming path trace message contents. INCTRC is any combination of 64 characters including CR and LF. String. Optional
TRCMODE
Trace mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Turn off path trace capability. Nothing will be reported
C2
The c2 byte hex code. Applicable only to STS-level paths in SONET (STSn). Optional
Parameter type is C2_BYTE—c2 byte hex code
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured STS-1 SPE
•
Locked VT Mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream
21.96 RTRV-TRC-OCH
Retrieve Trace Optical Channel
Usage Guidelines
Cisco ONS 15454
This command 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.
The following rules apply: Client port-only the J0 Section trace applies. The J0 Section trace applies only if the card termination mode is not transparent and the payload is SONET/SDH. On the DWDM port the J0 Section trace, the TTI Path, Section trace monitoring point traces are allowed. The J0 Section trace is allowed only if the payload for the card is set to SONET/SDH. The J0 Section trace is allowed only if the card termination mode is not transparent. The TTI Path, Section trace is allowed only if the G.709 (DWRAP) is enabled.
Depending on the settings, the following filtering applies: If no TRCLEVEL is provided, all TRCLEVELS are reported as applicable. If TRCLEVEL is provided and no MSGTYPE is provided, all applicable MSGTYPES for the given level is displayed. If no MSGTYPE is provided, all MSGTYPES are reported as applicable. If a MSGTYPE is provided with out a TRCLEVEL, then the given MSGTYPE for all TRCLEVELS are displayed.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-TRC-OCH:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];
Input ExampleRTRV-TRC-OCH:CISCO:CHAN-2-2:100::EXPTRC,TTI-PM;
Input Parameters
Table 21-190 RTRV-TRC-OCH Input Parameters
SRC
Access identifier from the "CHANNEL" section. Must not be null
MSGTYPE
Type of autonomous message to be retrieved. A null value is equivalent to ALL
Parameter type is MSGTYPE—type of trace message
•
Expected incoming path trace message
•
Incoming path trace message
•
Outgoing path trace message
TRCLEVEL
The trace level to be managed. A null value is equivalent to ALL
Parameter type is TRCLEVEL—the trace mode options
•
Identifies the SONET J0 Section trace level
•
Identifies the TTI Path monitoring point
•
Identifies the TTI Section Monitoring point
Output FormatSID DATE TIME
M CTAG COMPLD
"<CHANNEL>,<MOD>::[TRCLEVEL=<TRCLEVEL>],[EXPTRC=<EXPTRC>],
[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,OCH::TRCLEVEL=TTI-PM,EXPTRC=\"AAA\",TRC=\"AAA\",
INCTRC=\"AAA\",TRCMODE=MAN,TRCFORMAT=64-BYTE"
;Output Parameters
Table 21-191 RTRV-TRC-OCH Output Parameters
CHANNEL
Access identifier from the "CHANNEL" section
MOD
Indicates an OCH AID type
Parameter type is MOD2—line/path modifier
•
10 Gigabit fibre channel
•
10 Gigabit Ethernet
•
1 Gigabit fibre channel
•
1 Gigabit FICON
•
2 Gigabit fibre channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
G1K-4 facility
•
Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability
•
GIG Ethernet
•
HDTV
•
ISC1
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3C path
•
STS6C path
•
STS9C path
•
STS18C path
•
STS12C path
•
STS24C path
•
STS36C path
•
STS48C path
•
STS192C path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 Path
•
VT2 Path
TRCLEVEL
The trace level to be managed. Optional
Parameter type is TRCLEVEL—the trace mode options
•
Identifies the SONET J0 Section trace level
•
Identifies the TTI Path monitoring point
•
Identifies the TTI Section Monitoring point
EXPTRC
Expected path trace content. A 64 character ASCII string. Optional
TRC
The path trace message to be transmitted. The trace byte continuously transmits a 64 byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. String. Optional
INCTRC
The incoming path trace message contents. String. Optional
TRCMODE
Trace mode. Optional
Parameter type is TRCMODE—trace mode
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected
•
Turn off path trace capability. Nothing will be reported
TRCFORMAT
The size of the trace message. If in SONET/SDH mode, only 1 or 16 bytes is applicable for the J0 section trace. The TTI level trace is only 64 bytes. Optional
Parameter type is TRCFORMAT—trace format
•
1 byte trace message
•
16 byte trace message
•
64 byte trace message
•
Enable an attribute
21.97 RTRV-TUNNEL-FIREWALL
Retrieve Tunnel Firewall
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the contents of the firewall tunnel table.
CategorySystem
SecurityRetrieve
Related Commands
DLT-ROUTE
DLT-TADRMAP
DLT-TUNNEL-FIREWALL
DLT-TUNNEL-PROXY
ENT-ROUTE
ENT-TADRMAP
ENT-TUNNEL-FIREWALL
ENT-TUNNEL-PROXY
RTRV-ROUTE
RTRV-TADRMAP
RTRV-TUNNEL-PROXY
Input FormatRTRV-TUNNEL-FIREWALL:[<TID>]::<CTAG>;
Input ExampleRTRV-TUNNEL-FIREWALL:TID::CTAG;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>],
[DEST MASK=<DESTMASK>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7,
DEST MASK=255.255.255.0"
;Output Parameters
21.98 RTRV-TUNNEL-PROXY
Retrieve Tunnel Proxy
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the contents of the proxy tunnel table.
CategorySystem
SecurityRetrieve
Related Commands
DLT-ROUTE
DLT-TADRMAP
DLT-TUNNEL-FIREWALL
DLT-TUNNEL-PROXY
ENT-ROUTE
ENT-TADRMAP
ENT-TUNNEL-FIREWALL
ENT-TUNNEL-PROXY
RTRV-ROUTE
RTRV-TADRMAP
RTRV-TUNNEL-FIREWALL
Input FormatRTRV-TUNNEL-PROXY:[<TID>]::<CTAG>;
Input ExampleRTRV-TUNNEL-PROXY:TID::CTAG;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>],
[DEST MASK=<DESTMASK>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7,
DEST MASK=255.255.255.0"
;Output Parameters
21.99 RTRV-USER-SECU
Retrieve User Security
Usage Guidelines
Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL
This command retrieves the security information of a specified user or list of users. The keyword ALL can be used to obtain a list of all users. For security reasons the password cannot be retrieved.
A Superuser can retrieve any user's security information. A user with MAINT, PROV, or RTRV privileges can only retrieve their own information.
Note
CategorySecurity
SecurityRetrieve
Note
Related Commands
Input FormatRTRV-USER-SECU:[<TID>]:<UID>:<CTAG>;
Input ExampleRTRV-USER-SECU::CISCO15:1;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<UID>:,<PRIVILEGE>:LOGGEDIN=<LOGGEDIN>,[NUMSESSIONS=<NUMSESS>,]
[LOCKEDOUT=<LOCKEDOUT>,][DISABLED=<DISABLED>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CISCO15:,SUPER:LOGGEDIN=YES,NUMSESSIONS=1,LOCKEDOUT=NO,DISABLED=NO"
;Output Parameters
21.100 RTRV-VCG
Retrieve Virtual Concatenated Group
Usage Guidelines
Cisco ONS 15454, 15310-CL
This command retrieves all the attributes provisioned for a VCG.
CategoryVCAT
SecurityRetrieve
Related Commands
Input FormatRTRV-VCG:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-VCG:NODE1:FAC-1-1:1234;
Input Parameters
Table 21-198 RTRV-VCG Input Parameters
SRC
Source access identifier from the "FACILITY" section. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>::TYPE=<TYPE>,TXCOUNT=<TXCOUNT>,CCT=<CCT>,[LCAS=<LCAS>],
[BUFFERS=<BUFFERS>],[NAME=<NAME>]:<PST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::TYPE=STS3C,TXCOUNT=8,CCT=2WAY,LCAS=LCAS,BUFFERS=DEFAULT,
NAME="VCG2":IS"
;Output Parameters
Table 21-199 RTRV-VCG Output Parameters
SRC
Source access identifier from the "FACILITY" section. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID
TYPE
The type of the entity being provisioned. Null indicates not applicable. TYPE can be a common language equipment identifier (CLEI) code or another value. The type of member cross-connect. ML1000-2 and ML100T-12 cards support STS1, STS3c and STS12c. The FC_MR-4 card supports STS3c only
Parameter type is MOD_PATH—STS/VT path modifier
•
STS1 path
•
STS12C path
•
STS18C path
•
STS192C path
•
STS24C path
•
STS36C path
•
STS3C path
•
STS48C path
•
STS6C path
•
STS9C path
•
VT1 path
•
VT2 path
TXCOUNT
Number of VCG members in the Tx direction. For ML1000-2 and ML100T-12 cards the only valid value is 2. For the FC_MR-4 card the only valid value is 8. Integer
CCT
Type of connection; one-way or two-way. Cross-connect type for the VCG member cross-connects
Parameter type is CCT—type of cross-connect to be created
•
A unidirectional connection from a source tributary to a destination tributary
•
Path Protection multicast drop with (1-way) continue
•
Path Protection multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A Bidirectional Drop and Continue connection applicable only to Path Protection Traditional and Integrated Dual Ring InterConnections
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (BLSR PCA diagnostics cross-connect)
LCAS
Link capacity adjustment scheme. Optional
Parameter type is LCAS—link capacity adjustment scheme mode for the VCG created
•
LCAS is enabled
•
No LCAS
•
Supports the temporary removal of a VCG member during the member failure. Only supported by the ML1000-2 and ML100T-12 cards
BUFFERS
Buffer type. The default value is DEFAULT. The FC_MR-4 card supports DEFAULT and EXPANDED buffers. Other data cards support DEFAULT buffers only. Optional
Parameter type is BUFFER_TYPE—buffer type (used in VCAT)
•
Default buffer value
•
Expanded buffer value
NAME
Name of the VCAT group. String. Optional
PST
Primary state. Optional
Parameter type is PST—indicates the current overall service condition of an entity
•
In service
•
Out of service
21.101 RTRV-VT
Retrieve Virtual Tributary
Usage Guidelines
Cisco ONS 15454
This command retrieves the attributes associated with a VT path based on the granularity level of NE/Slot-specific VTs.
Supported AIDs are ALL, SLOT-N (N=1,2,...ALL), VT-<SLOT>[-<PORT>]-<STS NUMBER>-
<VT GROUP>-<VT NUMBER>.
Note
CategoryPaths
SecurityRetrieve
Related Commands
Input FormatRTRV-VT:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-VT:TID:VT1-1-1-1-1:1;
Input Parameters
Table 21-200 RTRV-VT Input Parameters
AID
Access identifier from the "AidUnionId" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],
[HOLDOFFTIMER=<HOLDOFFTIMER>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[UPSRPTHSTATE=<UPSRPTHSTATE>]:[<PST>],[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VT1-1-1-1-1-1::LEVEL=VT1,RVRTV=Y,RVTM=1.0,HOLDOFFTIMER=2000,TACC=8,
TAPTYPE=SINGLE,UPSRPTHSTATE=ACT:OOS,AINS"
;Output Parameters
Table 21-201 RTRV-VT Output Parameters
AID
Access identifier from the "AidUnionId" section
LEVEL
The rate of the cross-connect. Indicates the rate of the cross-connected channel. Applicable only to VT1 path in SONET. Optional
Parameter type is VT_PATH—modifier for some VT commands
•
Virtual Tributary 1
•
Virtual Tributary 2
RVRTV
Revertive mode. Only applies to path protection. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Optional
Parameter type is ON_OFF—disable or enable an attribute
•
Disable an attribute
•
Enable an attribute
RVTM
Revertive time. Only applies to path protection. Defaults to empty because RVRTV is N when a path protection path is created. Optional
Parameter type is REVERTIVE_TIME—revertive time
•
Revertive time is 0.5 to 12.0 minutes
HOLDOFFTIMER
Hold off timer. Integer. Optional
TACC
Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N. Optional
TAPTYPE
TAP type. Optional
Parameter type is TAPTYPE—test access point type
•
Dual FAD
•
Single FAD
UPSRPTHSTATE
Indicates whether a given AID is the working or standby path of a path protection cross-connect. Optional
Parameter type is STATUS—status of the unit in the protection pair
•
The entity is the active unit in the shelf
•
Status is unavailable
•
The entity is the standby unit in the shelf
PST
Primary state
Parameter type is PST—indicates the current overall service condition of an entity
•
In service
•
Out of service
SST
Secondary state
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.102 RTRV-WDMANS
Retrieve Wavelength Division Multiplexing Automatic Node Set Up
Usage Guidelines
Cisco ONS 15454
This command edits the automatic optical node set up (AONS) application attributes.
CategoryDWDM
SecurityMaintenance
Related Commands
Input FormatRTRV-WDMANS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-WDMANS:PENNGROVE:WDMANS-W:114;
Input Parameters
Table 21-202 RTRV-WDMANS Input Parameters
AID
Access identifier from the "WDMANS" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[POWERIN=<POWERIN>],[POWEROUT=<POWEROUT>],
[POWEREXP=<POWEREXP>],[NTWTYPE=<NTWTYPE>],
[OPTICALTYPE=<OPTICALTYPE>],[LASTRUNDAT=<LASTRUNDAT>],
[LASTRUNTM=<LASTRUNTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"WDMANS-W::POWERIN=10.0,POWEROUT=10.0,POWEREXP=10.0,
NTWTYPE=METRO-CORE,OPTICALTYPE=OADM,LASTRUNDAT=01-01-01,
LASTRUNTM=10-55-00"
;Output Parameters
Table 21-203 RTRV-WDMANS Output Parameters
AID
Access identifier from the "WDMANS" section
POWERIN
Input power for an OADM section of an OADM NE. Float. Optional
POWEROUT
Output power for an OADM or Mux/Demux section of HUB, TERMINAL or OADM nodes. Float. Optional
POWEREXP
Express power for a Mux/Demux section of a HUB or TERMINAL NE. Float. Optional
NTWTYPE
Type of network with DWDM node installed. Optional
Parameter type is DWDM_RING_TYPE—network type where NE is installed
•
The network where a DWDM node is installed is a metro access network
•
The network where a DWDM node is installed is a metro core network
•
A node that does not have a standard DWDM configuration
OPTICALTYPE
The optical configuration type for the NE. Optional
Parameter type is OPTICAL_NODE_TYPE—optical configuration types for NEs
•
A terminal site EAST, WEST or both with 32 channel mux/demux card
•
A line site with booster card
•
A site with OADM cards
•
An OSC regeneration site with only 2 OSC-CSM cards in both sides
•
A site with R-OADM cards
•
A TDM node with an amplifier directly connected to a TXP/MXP card
•
The node type is undefined
LASTRUNDAT
The last date when the WDMANS application was run automatically or by user request. The format is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. Optional
LASTRUNTM
The last time when the WDMANS application was run automatically or by user request. The format is HH-MM, where HH (hour of day) ranges from 1 to 23 and MM (minute of hour) ranges from 0 to 59. Optional
21.103 RTRV-WLEN
Retrieve Wavelength
Usage Guidelines
Cisco ONS 15454
This command retrieves the wavelength provisioning information.
CategoryDWDM
SecurityRetrieve
Related Commands
Input FormatRTRV-WLEN:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-WLEN:PENNGROVE:WLEN-W-ADD-1530.33:114;
Input Parameters
Table 21-204 RTRV-WLEN Input Parameters
AID
Access identifier from the "WLEN" section. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"WLEN-W-ADD-1530.33:1WAY:SIZE=MULTI-RATE,CKTID=CKTID:OOS-AU,AINS"
;Output Parameters
Table 21-205 RTRV-WLEN Output Parameters
AID
Access identifier from the "WLEN" section
CCT
The wavelength connection type
Parameter type is WCT—wavelength connection types
•
A unidirectional wavelength connection for one specified ring direction
•
A bidirectional wavelength connection for both ring directions
SIZE
Size of the switching network. Optional
Parameter type is CIRCUIT_SIZE—the DWDM circuit size used on a wavelength
•
The circuit size is 10 Gbps with FEC
•
The circuit size is10 Gbps without FEC
•
The circuit size is 2.5 Gbps with FEC
•
The circuit size is 2.5 Gbps without FEC
•
The circuit size is supports multirate
•
The circuit size is not equipment specific
CKTID
Circuit identification parameter that contains the common language circuit ID or other alias of the circuit being provisioned. Cannot contain blank spaces. CKTID is a string of ASCII characters with a maximum length of 48 characters. String. Optional
PST_PSTQ
The primary state and the primary state qualifier separated by a colon
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)
•
In service - normal
•
Out of service - autonomous
•
Out of service - autonomous and management
•
Out of service - management
SST
One or more secondary states separated by "&" in alphabetical order. Optional
Parameter type is SST—provides additional information pertaining to PST and PSTQ
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
Posted: Mon Sep 3 12:03:42 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
