-
Cisco ONS SONET TL1 Command Guide, Release 6.0
-
About This Guide
-
Chapter 1, ACT Commands
-
Chapter 2, ALW Commands
-
Chapter 3, APPLY Commands
-
Chapter 4, CANC Commands
-
Chapter 5, CHG Commands
-
Chapter 6, CLR Commands
-
Chapter 7, CONN Commands
-
Chapter 8, COPY Commands
-
Chapter 9, DISC Commands
-
Chapter 10, DLT Commands
-
Chapter 11, ED Commands
-
Chapter 12, ENT Commands
-
Chapter 13, EX Commands
-
Chapter 14, INH Commands
-
Chapter 15, INIT Commands
-
Chapter 16, OPR Commands
-
Chapter 17, REPT Messages
-
Chapter 18, RLS Commands
-
Chapter 19, RMV Commands
-
Chapter 20, RST Commands
-
Chapter 21, RTRV Commands
-
Chapter 22, SCHED Commands
-
Chapter 23, SET Commands
-
Chapter 24, SW Commands
-
Chapter 25, Access Identifiers
-
Chapter 26, Conditions
-
Chapter 27, Modifiers
-
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 on page 27-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
Table 21-1 RTRV-<MOD1FCPAYLOAD> Input Parameters
AID
Access identifier from the "25.1.14 FACILITY" section on page 25-28. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:LINKRATE=<LINKRATE>,LINKSTATE=<LINKSTATE>,
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,[<SST>]"
;Output Example
TID-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 "25.1.14 FACILITY" section on page 25-28
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 on page 27-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
Table 21-3 RTRV-<MOD1FICONPAYLOAD> Input Parameters
AID
Access identifier from the "25.1.14 FACILITY" section on page 25-28. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>],
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,<SST>"
;Output Example
TID-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 "25.1.14 FACILITY" section on page 25-28
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 on page 27-1 for supported modifiers by platform.
Category
DWDM
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-HDTV:MILAN:FAC-1-1:100;
Input Parameters
Table 21-5 RTRV-<MOD2DWDMPAYLOAD> Input Parameters
AID
Access identifier from the "25.1.14 FACILITY" section on page 25-28. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[LBCL=<LBCL>],
[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]";
Output Example
TID-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 "25.1.2 AidUnionId" section on page 25-9
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
•
•
Category
BLSR
Security
Retrieve
Related Commands
Input Format
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input Example
RTRV-BLSR:PETALUMA:ALL:123;
Input Parameters
Table 21-7 RTRV-<MOD_RING> Input Parameters
AID
Access identifier from the "25.1.3 AidUnionId1" section on page 25-12. 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 Format
SID DATE TIME
M CTAG COMPLD
"[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>],
[EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>],
[WESTPROT=<WESTPROT>]";
Output Example
TID-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 "25.1.3 AidUnionId1" section on page 25-12. 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 "25.1.14 FACILITY" section on page 25-28
WESTWORK
West working facility. AID from the "25.1.14 FACILITY" section on page 25-28
EASTPROT
East protecting facility. AID from the "25.1.14 FACILITY" section on page 25-28
WESTPROT
West protecting facility. AID from the "25.1.14 FACILITY" section on page 25-28
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 on page 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.
Category
BLSR
Security
Retrieve
Related Commands
Input Format
RTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-OC48:PENNGROVE:FAC-6-1:236;
Input Parameters
Table 21-9 RTRV-<OCN_TYPE> Input Parameters
AID
Access identifier from the "25.1.14 FACILITY" section on page 25-28. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>],
[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>],
[RINGID=<RINGID>],[BLSRTYPE=<BLSRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>],
[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 Example
TID-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 "25.1.14 FACILITY" section on page 25-28
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 OC-N port PJMON. PJMON is an integer. It defaults to 0 (zero). Set a valid STS number of the optical port.
Note
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 on page 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
•
•
•
•
•
•
•
Category
Paths
Security
Retrieve
Related Commands
Input Format
RTRV-<PATH>:[<TID>]:<AID>:<CTAG>[:::BLSRPTHTYPE=<BLSRPTHTYPE>][:];
Input Example
RTRV-STS3C:FERNDALE:STS-2-1-4:238:::BLSRPTHTYPE=NON-PCA;
Input Parameters
Table 21-11 RTRV-<PATH> Input Parameters
AID
Access identifier from the "25.1.10 CrossConnectId1" section on page 25-20. 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 Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT =<TRCFORMAT>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[UPSRPTHSTATE=<UPSRPTHSTATE>],[C2=<C2>],
[BLSRPTHSTATE=<BLSRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]"
;Output Example
TID-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 "25.1.10 CrossConnectId1" section on page 25-20
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.
Category
Ports
Security
Retrieve
Related Commands
Input Format
RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-10GIGE:TID:FAC-1-1:100;
Input Parameters
Table 21-13 RTRV-10GIGE Input Parameters
AID
Access identifier from the "25.1.14 FACILITY" section on page 25-28. Must not be null
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]"
;Output Example
TID-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 "25.1.14 FACILITY" section on page 25-28
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 on page 27-1 for supported modifiers by platform.
Note
Note
Category
Fault
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input Example
RTRV-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 "25.1.2 AidUnionId" section on page 25-9. 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 Chapter 26, "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 Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],,:[<DESC>]";
Output Example
TID-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 "25.1.1 ALL" section on page 25-1
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 Chapter 26, "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-SYNCNCategory
Fault
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<CONDITION>],
[<SRVEFF>][,,,];Input Example
RTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA;
Input Parameters
Table 21-17 RTRV-ALM-ALL Input Parameters
AID
Access identifier from the "25.1.1 ALL" section on page 25-1. 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 Chapter 26, "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 Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>],[<AIDDET>]";
Output Example
TID-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 "25.1.1 ALL" section on page 25-1. 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 Chapter 26, "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.
Category
Synchronization
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Input Parameters
Table 21-19 RTRV-ALM-BITS Input Parameters
AID
Access identifier from the "25.1.5 BITS" section on page 25-13. 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 Chapter 26, "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 Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>]";
Output Example
TID-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 "25.1.5 BITS" section on page 25-13. 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 Chapter 26, "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.
Category
Environment
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-21 RTRV-ALM-ENV Input Parameters
AID
Access identifier from the "25.1.12 ENV" section on page 25-26. 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 Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<DESC>]";
Output Example
TID-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 "25.1.12 ENV" section on page 25-26
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 Chapter 26, "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.
Category
Equipment
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;
Input Parameters
Table 21-23 RTRV-ALM-EQPT Input Parameters
AID
Access identifier from the "25.1.13 EQPT" section on page 25-27. 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 Chapter 26, "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 Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,,:[<DESC>]";
Output Example
TID-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 "25.1.13 EQPT" section on page 25-27. 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 Chapter 26, "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.
Category
Synchronization
Security
Retrieve
Related Commands
Input Format
RTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input Example
RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Input Parameters
Table 21-25 RTRV-ALM-SYNCN Input Parameters
AID
Access identifier from the "25.1.25 SYNC_REF" section on page 25-40. 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
•
