- Preface
- Chapter 1: ACT Commands
- Chapter 2: ALW Commands
- Chapter 3: APPLY Commands
- Chapter 4: CANC Messages
- 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: EX Commands
- Chapter 13: ENT 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: TST Commands
- Chapter 26: Access Identifiers
- Chapter 27: Conditions
- Chapter 28: Modifiers
- 21.1 RTRV-<MOD1FCPAYLOAD>
- 21.2 RTRV-<MOD1FICONPAYLOAD>
- 21.3 RTRV-<MOD2DWDMPAYLOAD>
- 21.4 RTRV-<MOD_RING>
- 21.5 RTRV-<OCN_TYPE>
- 21.6 RTRV-<PATH>
- 21.7 RTRV-10GIGE
- 21.8 RTRV-ALM-<MOD2ALM>
- 21.9 RTRV-ALMTYPE
- 21.10 RTRV-ALM-ALL
- 21.11 RTRV-ALM-BITS
- 21.12 RTRV-ALM-ENV
- 21.13 RTRV-ALM-EQPT
- 21.14 RTRV-ALM-SYNCN
- 21.15 RTRV-ALMTH-<MOD2>
- 21.16 RTRV-ALMTH-EQPT
- 21.17 RTRV-ALS
- 21.18 RTRV-APC
- 21.19 RTRV-ATTR-CONT
- 21.20 RTRV-ATTR-ENV
- 21.21 RTRV-AUDIT-LOG
- 21.22 RTRV-BFDLPM-<MOD2>
- 21.23 RTRV-BITS
- 21.24 RTRV-BULKROLL-<OCN_TYPE>
- 21.25 RTRV-CMD-SECU
- 21.26 RTRV-COND-<MOD2ALM>
- 21.27 RTRV-COND-ALL
- 21.28 RTRV-COND-BITS
- 21.29 RTRV-COND-ENV
- 21.30 RTRV-COND-EQPT
- 21.31 RTRV-COND-SYNCN
- 21.32 RTRV-CONSOLE-PORT
- 21.33 RTRV-COS-ETH
- 21.34 RTRV-CRS
- 21.35 RTRV-CRS-<PATH>
- 21.36 RTRV-DFLT-SECU
- 21.37 RTRV-DS1
- 21.38 RTRV-EC1
- 21.39 RTRV-EQPT
- 21.40 RTRV-ESCON
- 21.41 RTRV-ETH
- 21.42 RTRV-EXT-CONT
- 21.43 RTRV-FAC
- 21.44 RTRV-FFP
- 21.45 RTRV-FFP-<MOD2DWDMPAYLOAD>
- 21.46 RTRV-FFP-<OCN_TYPE>
- 21.47 RTRV-FFP-OCH
- 21.48 RTRV-FFP-OTS
- 21.49 RTRV-FSTE
- 21.50 RTRV-FTPSERVER
- 21.51 RTRV-G1000
- 21.52 RTRV-GFP
- 21.53 RTRV-GIGE
- 21.54 RTRV-HDLC
- 21.55 RTRV-HDR
- 21.56 RTRV-INV
- 21.57 RTRV-L2-ETH
- 21.58 RTRV-LMP
- 21.59 RTRV-LMP-CTRL
- 21.60 RTRV-LMP-TLINK
- 21.61 RTRV-LMP-DLINK
- 21.62 RTRV-LNK
- 21.63 RTRV-LNKTERM
- 21.64 RTRV-LOG
- 21.65 RTRV-MAP-NETWORK
- 21.66 RTRV-MCAST
- 21.67 RTRV-NE-APC
- 21.68 RTRV-NE-GEN
- 21.69 RTRV-NE-IPMAP
- 21.70 RTRV-NE-PATH
- 21.71 RTRV-NE-SYNCN
- 21.72 RTRV-NE-WDMANS
- 21.73 RTRV-NETYPE
- 21.74 RTRV-NNI-ETH
- 21.75 RTRV-OCH
- 21.76 RTRV-OCHCC
- 21.77 RTRV-OCHNC
- 21.78 RTRV-OMS
- 21.79 RTRV-OPM
- 21.80 RTRV-OTS
- 21.81 RTRV-PATH-OCH
- 21.82 RTRV-PM-<MOD2>
- 21.83 RTRV-PM-ALL
- 21.84 RTRV-PMMODE-<STS_PATH>
- 21.85 RTRV-PMMODE-<VT_PATH>
- 21.86 RTRV-PMSCHED-<MOD2>
- 21.87 RTRV-PMSCHED-ALL
- 21.88 RTRV-POS
- 21.89 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
- 21.90 RTRV-PROTNSW-<OCN_TYPE>
- 21.91 RTRV-PROTNSW-<PATH>
- 21.92 RTRV-PROTNSW-OCH
- 21.93 RTRV-PROTNSW-OTS
- 21.94 RTRV-PROTOCOL
- 21.95 RTRV-PTHTRC-<PATH>
- 21.96 RTRV-QNQ-ETH
- 21.97 RTRV-RAMAN
- 21.98 RTRV-RMONTH-<MOD2_RMON>
- 21.99 RTRV-ROLL-<MOD_PATH>
- 21.100 RTRV-ROUTE
- 21.101 RTRV-ROUTE-GRE
- 21.102 RTRV-SLV-WDMANS
- 21.103 RTRV-STS
- 21.104 RTRV-SYNCN
- 21.105 RTRV-T1
- 21.106 RTRV-T3
- 21.107 RTRV-TACC
- 21.108 RTRV-TADRMAP
- 21.109 RTRV-TH-<MOD2>
- 21.110 RTRV-TH-ALL
- 21.111 RTRV-TOD
- 21.112 RTRV-TRAPTABLE
- 21.113 RTRV-TRC-<OCN_BLSR>
- 21.114 RTRV-TRC-OCH
- 21.115 RTRV-TUNNEL-FIREWALL
- 21.116 RTRV-TUNNEL-PROXY
- 21.117 RTRV-USER-SECU
- 21.118 RTRV-VCG
- 21.119 RTRV-VLAN
- 21.120 RTRV-VLAN-ETH
- 21.121 RTRV-VT
- 21.122 RTRV-WDMANS
- 21.123 RTRV-WDMSIDE
- 21.124 RTRV-WLEN
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 retrieve (RTRV) commands for the Cisco ONS 15454, Cisco ONS 15310-CL, Cisco ONS 15310-MA, and Cisco ONS 15600.
21.1 RTRV-<MOD1FCPAYLOAD>
(Cisco ONS 15454) The Retrieve 1GFC, 2GFC, 4 GFC, or 10GFC (RTRV-<MOD1FCPAYLOAD>) command retrieves the attributes related with the Fibre Channel port.
Usage Guidelines
See Table 28-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Input Format
RTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
<AID> |
Access identifier from the "FACILITY" section. |
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
<AID> |
Access identifier from the "FACILITY" section. |
<ROLE> |
(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role played by the unit 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> |
(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is 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. The parameter type is LINKRATE, which is the link rate on a Fibre Channel port. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
The rate is unknown. |
• |
The Small Form-factor Pluggable (SFP) is not plugged into the Fibre Channel port, so the link rate cannot be detected. |
<LINKSTATE> |
Link state. The parameter type is DIRN, which 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. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<DISTEXTN> |
(Optional) Distance extension. The parameter type is DISTANCE_EXTENSION (distance extension). |
• |
Buffer to buffer flow control |
• |
No distance extension |
<LINKCREDITS> |
(Optional) Number of link credits. LINKCREDITS is an integer. |
<MFS> |
(Optional) Maximum frame size. MFS is an integer. |
<ENCAP> |
(Optional) Frame encapsulation type. The parameter type is ENCAP (frame encapsulation type). |
• |
Generic framing procedure (GFP) frame mode |
• |
GFP transparent mode |
• |
High-level data link control (HDLC) frame mode |
• |
HDLC LAN extension frame mode |
• |
HDLC X.86 frame mode |
<NAME> |
(Optional) Identifies the port name. NAME is a string. |
<SOAK> |
(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer. |
<SOAKLEFT> |
(Optional) 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. Rules for <SOAKLEFT> are as follows: • • • |
<FREQ> |
(Optional) Parameter type is OPTICAL_WLEN (optical wavelength). |
• |
Wavelength 1310 |
• |
Wavelength 1470 |
• |
Wavelength 1490 |
• |
Wavelength 1510 |
• |
Wavelength 1529.55 |
• |
Wavelength 1529.94 |
• |
Wavelength 1530 |
• |
Wavelength 1530.33 |
• |
Wavelength 1530.73 |
• |
Wavelength 1531.12 |
• |
Wavelength 1531.51 |
• |
Wavelength 1531.90 |
• |
Wavelength 1532.29 |
• |
Wavelength 1532.68 |
• |
Wavelength 1533.07 |
• |
Wavelength 1533.47 |
• |
Wavelength 1533.86 |
• |
Wavelength 1534.25 |
• |
Wavelength 1534.64 |
• |
Wavelength 1535.04 |
• |
Wavelength 1535.43 |
• |
Wavelength 1535.82 |
• |
Wavelength 1536.22 |
• |
Wavelength 1536.61 |
• |
Wavelength 1537 |
• |
Wavelength 1537.40 |
• |
Wavelength 1537.79 |
• |
Wavelength 1538.19 |
• |
Wavelength 1538.58 |
• |
Wavelength 1538.98 |
• |
Wavelength 1539.37 |
• |
Wavelength 1539.77 |
• |
Wavelength 1540.16 |
• |
Wavelength 1540.56 |
• |
Wavelength 1540.95 |
• |
Wavelength 1541.35 |
• |
Wavelength 1541.75 |
• |
Wavelength 1542.14 |
• |
Wavelength 1542.35 |
• |
Wavelength 1542.54 |
• |
Wavelength 1542.94 |
• |
Wavelength 1543.33 |
• |
Wavelength 1543.73 |
• |
Wavelength 1544.13 |
• |
Wavelength 1544.53 |
• |
Wavelength 1544.92 |
• |
Wavelength 1545.32 |
• |
Wavelength 1545.72 |
• |
Wavelength 1546.12 |
• |
Wavelength 1546.52 |
• |
Wavelength 1546.92 |
• |
Wavelength 1547.32 |
• |
Wavelength 1547.72 |
• |
Wavelength 1548.12 |
• |
Wavelength 1548.51 |
• |
Wavelength 1548.92 |
• |
Wavelength 1549.32 |
• |
Wavelength 1549.71 |
• |
Wavelength 1500 |
• |
Wavelength 1550.12 |
• |
Wavelength 1550.52 |
• |
Wavelength 1550.92 |
• |
Wavelength 1551.32 |
• |
Wavelength 1551.72 |
• |
Wavelength 1552.12 |
• |
Wavelength 1552.52 |
• |
Wavelength 1552.93 |
• |
Wavelength 1553.33 |
• |
Wavelength 1553.73 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.94 |
• |
Wavelength 1555.34 |
• |
Wavelength 1555.75 |
• |
Wavelength 1556.15 |
• |
Wavelength 1556.55 |
• |
Wavelength 1556.96 |
• |
Wavelength 1557.36 |
• |
Wavelength 1557.77 |
• |
Wavelength 1558.17 |
• |
Wavelength 1558.58 |
• |
Wavelength 1558.98 |
• |
Wavelength 1559.39 |
• |
Wavelength 1559.79 |
• |
Wavelength 1560.20 |
• |
Wavelength 1560.61 |
• |
Wavelength 1561.01 |
• |
Wavelength 1561.42 |
• |
Wavelength 1561.83 |
• |
Wavelength 1570 |
• |
Wavelength 1570.83 |
• |
Wavelength 1571.24 |
• |
Wavelength 1571.65 |
• |
Wavelength 1572.06 |
• |
Wavelength 1572.48 |
• |
Wavelength 1572.89 |
• |
Wavelength 1573.30 |
• |
Wavelength 1573.71 |
• |
Wavelength 1574.13 |
• |
Wavelength 1574.54 |
• |
Wavelength 1574.95 |
• |
Wavelength 1575.37 |
• |
Wavelength 1575.78 |
• |
Wavelength 1576.20 |
• |
Wavelength 1576.61 |
• |
Wavelength 1577.03 |
• |
Wavelength 1577.44 |
• |
Wavelength 1577.86 |
• |
Wavelength 1578.27 |
• |
Wavelength 1578.69 |
• |
Wavelength 1579.10 |
• |
Wavelength 1579.52 |
• |
Wavelength 1579.93 |
• |
Wavelength 1580.35 |
• |
Wavelength 1580.77 |
• |
Wavelength 1581.18 |
• |
Wavelength 1581.60 |
• |
Wavelength 1582.02 |
• |
Wavelength 1582.44 |
• |
Wavelength 1582.85 |
• |
Wavelength 1583.27 |
• |
Wavelength 1583.69 |
• |
Wavelength 1584.11 |
• |
Wavelength 1584.53 |
• |
Wavelength 1584.95 |
• |
Wavelength 1585.36 |
• |
Wavelength 1585.78 |
• |
Wavelength 1586.20 |
• |
Wavelength 1586.62 |
• |
Wavelength 1587.04 |
• |
Wavelength 1587.46 |
• |
Wavelength 1587.88 |
• |
Wavelength 1588.30 |
• |
Wavelength 1588.73 |
• |
Wavelength 1589.15 |
• |
Wavelength 1589.57 |
• |
Wavelength 1589.99 |
• |
Wavelength 1590 |
• |
Wavelength 1590.41 |
• |
Wavelength 1590.83 |
• |
Wavelength 1591.26 |
• |
Wavelength 1591.68 |
• |
Wavelength 1592.10 |
• |
Wavelength 1592.52 |
• |
Wavelength 1592.95 |
• |
Wavelength 1593.37 |
• |
Wavelength 1593.79 |
• |
Wavelength 1594.22 |
• |
Wavelength 1594.64 |
• |
Wavelength 1595.06 |
• |
Wavelength 1595.49 |
• |
Wavelength 1596.34 |
• |
Wavelength 1596.76 |
• |
Wavelength 1597.19 |
• |
Wavelength 1597.62 |
• |
Wavelength 1598.04 |
• |
Wavelength 1598.47 |
• |
Wavelength 1598.89 |
• |
Wavelength 1599.32 |
• |
Wavelength 1599.75 |
• |
Wavelength 1600.06 |
• |
Wavelength 1601.03 |
• |
Wavelength 1601.46 |
• |
Wavelength 1601.88 |
• |
Wavelength 1602.31 |
• |
Wavelength 1602.74 |
• |
Wavelength 1603.17 |
• |
Wavelength 1603.60 |
• |
Wavelength 1604.03 |
• |
Wavelength 1610 |
• |
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. The parameter type is PST_PSTQ, which is the service state of the entity described by primary state (PST) and primary state qualifier (PSTQ). |
• |
In Service and Normal |
• |
Out of Service and Autonomous |
• |
Out of Service and Autonomous Management |
• |
Out of Service and Management |
<SST> |
(Optional) Secondary state of the entity. The parameter type is secondary state (SST), which provides additional information pertaining to PST and PSTQ. |
• |
Automatic In-Service |
• |
Disabled |
• |
Loopback |
• |
Mismatch of Equipment |
• |
Maintenance |
• |
Out of Group |
• |
Software Download |
• |
Unassigned |
• |
Unequipped |
21.2 RTRV-<MOD1FICONPAYLOAD>
(Cisco ONS 15454) The Retrieve 1GFICON, 2GFICON, or 4GFICON (RTRV-<MOD1FICONPAYLOAD>) command returns Fibre Channel-specific settings for ports that have been configured to carry FICON traffic using the ENT-FICON command.
Usage Guidelines
The MXPP_MR_2.5G card only supports the GFP-T frame type.
See Table 28-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Input Format
RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
<AID> |
Access identifier from the "FACILITY" section. |
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
<AID> |
Access identifier from the "FACILITY" section. |
<ROLE> |
(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role that 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> |
(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is 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. The parameter type is LINKRATE, which is the link rate on a Fibre Channel port. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
The rate is unknown. |
• |
The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected. |
<LINKSTATE> |
Link state. The parameter type is DIRN, which 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. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<DISTEXTN> |
(Optional) Distance extension. The parameter type is DISTANCE_EXTENSION (distance extension). |
• |
Buffer to buffer flow control |
• |
No distance extension |
<LINKCREDITS> |
(Optional) Number of link credits. LINKCREDITS is an integer. |
<MFS> |
(Optional) Maximum frame size. MFS is an integer. |
<ENCAP> |
(Optional) Frame encapsulation type. The 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> |
(Optional) Identifies the port name. NAME is a string. |
<SOAK> |
(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer. |
<SOAKLEFT> |
(Optional) 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. Rules for <SOAKLEFT> are as follows: • • • |
<FREQ> |
(Optional) Parameter type is OPTICAL_WLEN (optical wavelength). |
• |
Wavelength 1310 |
• |
Wavelength 1470 |
• |
Wavelength 1490 |
• |
Wavelength 1510 |
• |
Wavelength 1529.55 |
• |
Wavelength 1529.94 |
• |
Wavelength 1530 |
• |
Wavelength 1530.33 |
• |
Wavelength 1530.73 |
• |
Wavelength 1531.12 |
• |
Wavelength 1531.51 |
• |
Wavelength 1531.90 |
• |
Wavelength 1532.29 |
• |
Wavelength 1532.68 |
• |
Wavelength 1533.07 |
• |
Wavelength 1533.47 |
• |
Wavelength 1533.86 |
• |
Wavelength 1534.25 |
• |
Wavelength 1534.64 |
• |
Wavelength 1535.04 |
• |
Wavelength 1535.43 |
• |
Wavelength 1535.82 |
• |
Wavelength 1536.22 |
• |
Wavelength 1536.61 |
• |
Wavelength 1537 |
• |
Wavelength 1537.40 |
• |
Wavelength 1537.79 |
• |
Wavelength 1538.19 |
• |
Wavelength 1538.58 |
• |
Wavelength 1538.98 |
• |
Wavelength 1539.37 |
• |
Wavelength 1539.77 |
• |
Wavelength 1540.16 |
• |
Wavelength 1540.56 |
• |
Wavelength 1540.95 |
• |
Wavelength 1541.35 |
• |
Wavelength 1541.75 |
• |
Wavelength 1542.14 |
• |
Wavelength 1542.35 |
• |
Wavelength 1542.54 |
• |
Wavelength 1542.94 |
• |
Wavelength 1543.33 |
• |
Wavelength 1543.73 |
• |
Wavelength 1544.13 |
• |
Wavelength 1544.53 |
• |
Wavelength 1544.92 |
• |
Wavelength 1545.32 |
• |
Wavelength 1545.72 |
• |
Wavelength 1546.12 |
• |
Wavelength 1546.52 |
• |
Wavelength 1546.92 |
• |
Wavelength 1547.32 |
• |
Wavelength 1547.72 |
• |
Wavelength 1548.12 |
• |
Wavelength 1548.51 |
• |
Wavelength 1548.92 |
• |
Wavelength 1549.32 |
• |
Wavelength 1549.71 |
• |
Wavelength 1500 |
• |
Wavelength 1550.12 |
• |
Wavelength 1550.52 |
• |
Wavelength 1550.92 |
• |
Wavelength 1551.32 |
• |
Wavelength 1551.72 |
• |
Wavelength 1552.12 |
• |
Wavelength 1552.52 |
• |
Wavelength 1552.93 |
• |
Wavelength 1553.33 |
• |
Wavelength 1553.73 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.94 |
• |
Wavelength 1555.34 |
• |
Wavelength 1555.75 |
• |
Wavelength 1556.15 |
• |
Wavelength 1556.55 |
• |
Wavelength 1556.96 |
• |
Wavelength 1557.36 |
• |
Wavelength 1557.77 |
• |
Wavelength 1558.17 |
• |
Wavelength 1558.58 |
• |
Wavelength 1558.98 |
• |
Wavelength 1559.39 |
• |
Wavelength 1559.79 |
• |
Wavelength 1560.20 |
• |
Wavelength 1560.61 |
• |
Wavelength 1561.01 |
• |
Wavelength 1561.42 |
• |
Wavelength 1561.83 |
• |
Wavelength 1570 |
• |
Wavelength 1570.83 |
• |
Wavelength 1571.24 |
• |
Wavelength 1571.65 |
• |
Wavelength 1572.06 |
• |
Wavelength 1572.48 |
• |
Wavelength 1572.89 |
• |
Wavelength 1573.30 |
• |
Wavelength 1573.71 |
• |
Wavelength 1574.13 |
• |
Wavelength 1574.54 |
• |
Wavelength 1574.95 |
• |
Wavelength 1575.37 |
• |
Wavelength 1575.78 |
• |
Wavelength 1576.20 |
• |
Wavelength 1576.61 |
• |
Wavelength 1577.03 |
• |
Wavelength 1577.44 |
• |
Wavelength 1577.86 |
• |
Wavelength 1578.27 |
• |
Wavelength 1578.69 |
• |
Wavelength 1579.10 |
• |
Wavelength 1579.52 |
• |
Wavelength 1579.93 |
• |
Wavelength 1580.35 |
• |
Wavelength 1580.77 |
• |
Wavelength 1581.18 |
• |
Wavelength 1581.60 |
• |
Wavelength 1582.02 |
• |
Wavelength 1582.44 |
• |
Wavelength 1582.85 |
• |
Wavelength 1583.27 |
• |
Wavelength 1583.69 |
• |
Wavelength 1584.11 |
• |
Wavelength 1584.53 |
• |
Wavelength 1584.95 |
• |
Wavelength 1585.36 |
• |
Wavelength 1585.78 |
• |
Wavelength 1586.20 |
• |
Wavelength 1586.62 |
• |
Wavelength 1587.04 |
• |
Wavelength 1587.46 |
• |
Wavelength 1587.88 |
• |
Wavelength 1588.30 |
• |
Wavelength 1588.73 |
• |
Wavelength 1589.15 |
• |
Wavelength 1589.57 |
• |
Wavelength 1589.99 |
• |
Wavelength 1590 |
• |
Wavelength 1590.41 |
• |
Wavelength 1590.83 |
• |
Wavelength 1591.26 |
• |
Wavelength 1591.68 |
• |
Wavelength 1592.10 |
• |
Wavelength 1592.52 |
• |
Wavelength 1592.95 |
• |
Wavelength 1593.37 |
• |
Wavelength 1593.79 |
• |
Wavelength 1594.22 |
• |
Wavelength 1594.64 |
• |
Wavelength 1595.06 |
• |
Wavelength 1595.49 |
• |
Wavelength 1596.34 |
• |
Wavelength 1596.76 |
• |
Wavelength 1597.19 |
• |
Wavelength 1597.62 |
• |
Wavelength 1598.04 |
• |
Wavelength 1598.47 |
• |
Wavelength 1598.89 |
• |
Wavelength 1599.32 |
• |
Wavelength 1599.75 |
• |
Wavelength 1600.06 |
• |
Wavelength 1601.03 |
• |
Wavelength 1601.46 |
• |
Wavelength 1601.88 |
• |
Wavelength 1602.31 |
• |
Wavelength 1602.74 |
• |
Wavelength 1603.17 |
• |
Wavelength 1603.60 |
• |
Wavelength 1604.03 |
• |
Wavelength 1610 |
• |
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. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ. |
• |
In Service and Normal |
• |
Out of Service and Autonomous |
• |
Out of Service and Autonomous Management |
• |
Out of Service and Management |
<SST> |
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ. |
• |
Automatic In-Service |
• |
Disabled |
• |
Loopback |
• |
Mismatch of Equipment |
• |
Maintenance |
• |
Out of Group |
• |
Software Download |
• |
Unassigned |
• |
Unequipped |
21.3 RTRV-<MOD2DWDMPAYLOAD>
(Cisco ONS 15454) The Retrieve D1VIDEO, DV6000, ETRCLO, HDTV, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G and PASSTHRU (RTRV-<MOD2DWDMPAYLOAD>) command retrieves the configuration parameter of a dense wavelength division multiplexing (DWDM) client.
Usage Guidelines
See Table 28-1 for supported modifiers by platform.
Category
DWDM
Security
Retrieve
Input Format
RTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-HDTV:MILAN:FAC-1-1:100;
Input Parameters
<AID> |
Access identifier from the "FACILITY" section. |
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
<AIDUNIONID> |
Access identifier from the "AidUnionId" section |
<AIDTYPE> |
A type of access identifier. The parameter type is MOD2DWDMPAYLOAD, which contains the payload types applicable to DWDM ports. |
• |
10-Gigabit Fibre Channel payload |
• |
10-Gigabit Ethernet |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
D1Video payload |
• |
DV6000 payload |
• |
ETR_CLO payload |
• |
Gigabit Ethernet payload |
• |
High definition television (HDTV) payload |
• |
ISC1 payload |
• |
ISC3 payload |
• |
Any pass-through (2R) payload |
<ROLE> |
(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is 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> |
(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is 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> |
(Optional) Identifies the port name. NAME is a string. |
<LBCL> |
(Optional) Displays the current value of the laser current. LBCL is a float. |
<OPT> |
(Optional) Displays the current value of the transmitted optical power. OPT is a float. |
<OPR> |
(Optional) Displays the current value of the received optical power. OPR is a float. |
<FREQ> |
(Optional) Parameter type is OPTICAL_WLEN (optical wavelength). |
• |
Wavelength 1310 |
• |
Wavelength 1470 |
• |
Wavelength 1490 |
• |
Wavelength 1510 |
• |
Wavelength 1529.55 |
• |
Wavelength 1529.94 |
• |
Wavelength 1530 |
• |
Wavelength 1530.33 |
• |
Wavelength 1530.73 |
• |
Wavelength 1531.12 |
• |
Wavelength 1531.51 |
• |
Wavelength 1531.90 |
• |
Wavelength 1532.29 |
• |
Wavelength 1532.68 |
• |
Wavelength 1533.07 |
• |
Wavelength 1533.47 |
• |
Wavelength 1533.86 |
• |
Wavelength 1534.25 |
• |
Wavelength 1534.64 |
• |
Wavelength 1535.04 |
• |
Wavelength 1535.43 |
• |
Wavelength 1535.82 |
• |
Wavelength 1536.22 |
• |
Wavelength 1536.61 |
• |
Wavelength 1537 |
• |
Wavelength 1537.40 |
• |
Wavelength 1537.79 |
• |
Wavelength 1538.19 |
• |
Wavelength 1538.58 |
• |
Wavelength 1538.98 |
• |
Wavelength 1539.37 |
• |
Wavelength 1539.77 |
• |
Wavelength 1540.16 |
• |
Wavelength 1540.56 |
• |
Wavelength 1540.95 |
• |
Wavelength 1541.35 |
• |
Wavelength 1541.75 |
• |
Wavelength 1542.14 |
• |
Wavelength 1542.35 |
• |
Wavelength 1542.54 |
• |
Wavelength 1542.94 |
• |
Wavelength 1543.33 |
• |
Wavelength 1543.73 |
• |
Wavelength 1544.13 |
• |
Wavelength 1544.53 |
• |
Wavelength 1544.92 |
• |
Wavelength 1545.32 |
• |
Wavelength 1545.72 |
• |
Wavelength 1546.12 |
• |
Wavelength 1546.52 |
• |
Wavelength 1546.92 |
• |
Wavelength 1547.32 |
• |
Wavelength 1547.72 |
• |
Wavelength 1548.12 |
• |
Wavelength 1548.51 |
• |
Wavelength 1548.92 |
• |
Wavelength 1549.32 |
• |
Wavelength 1549.71 |
• |
Wavelength 1500 |
• |
Wavelength 1550.12 |
• |
Wavelength 1550.52 |
• |
Wavelength 1550.92 |
• |
Wavelength 1551.32 |
• |
Wavelength 1551.72 |
• |
Wavelength 1552.12 |
• |
Wavelength 1552.52 |
• |
Wavelength 1552.93 |
• |
Wavelength 1553.33 |
• |
Wavelength 1553.73 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.94 |
• |
Wavelength 1555.34 |
• |
Wavelength 1555.75 |
• |
Wavelength 1556.15 |
• |
Wavelength 1556.55 |
• |
Wavelength 1556.96 |
• |
Wavelength 1557.36 |
• |
Wavelength 1557.77 |
• |
Wavelength 1558.17 |
• |
Wavelength 1558.58 |
• |
Wavelength 1558.98 |
• |
Wavelength 1559.39 |
• |
Wavelength 1559.79 |
• |
Wavelength 1560.20 |
• |
Wavelength 1560.61 |
• |
Wavelength 1561.01 |
• |
Wavelength 1561.42 |
• |
Wavelength 1561.83 |
• |
Wavelength 1570 |
• |
Wavelength 1570.83 |
• |
Wavelength 1571.24 |
• |
Wavelength 1571.65 |
• |
Wavelength 1572.06 |
• |
Wavelength 1572.48 |
• |
Wavelength 1572.89 |
• |
Wavelength 1573.30 |
• |
Wavelength 1573.71 |
• |
Wavelength 1574.13 |
• |
Wavelength 1574.54 |
• |
Wavelength 1574.95 |
• |
Wavelength 1575.37 |
• |
Wavelength 1575.78 |
• |
Wavelength 1576.20 |
• |
Wavelength 1576.61 |
• |
Wavelength 1577.03 |
• |
Wavelength 1577.44 |
• |
Wavelength 1577.86 |
• |
Wavelength 1578.27 |
• |
Wavelength 1578.69 |
• |
Wavelength 1579.10 |
• |
Wavelength 1579.52 |
• |
Wavelength 1579.93 |
• |
Wavelength 1580.35 |
• |
Wavelength 1580.77 |
• |
Wavelength 1581.18 |
• |
Wavelength 1581.60 |
• |
Wavelength 1582.02 |
• |
Wavelength 1582.44 |
• |
Wavelength 1582.85 |
• |
Wavelength 1583.27 |
• |
Wavelength 1583.69 |
• |
Wavelength 1584.11 |
• |
Wavelength 1584.53 |
• |
Wavelength 1584.95 |
• |
Wavelength 1585.36 |
• |
Wavelength 1585.78 |
• |
Wavelength 1586.20 |
• |
Wavelength 1586.62 |
• |
Wavelength 1587.04 |
• |
Wavelength 1587.46 |
• |
Wavelength 1587.88 |
• |
Wavelength 1588.30 |
• |
Wavelength 1588.73 |
• |
Wavelength 1589.15 |
• |
Wavelength 1589.57 |
• |
Wavelength 1589.99 |
• |
Wavelength 1590 |
• |
Wavelength 1590.41 |
• |
Wavelength 1590.83 |
• |
Wavelength 1591.26 |
• |
Wavelength 1591.68 |
• |
Wavelength 1592.10 |
• |
Wavelength 1592.52 |
• |
Wavelength 1592.95 |
• |
Wavelength 1593.37 |
• |
Wavelength 1593.79 |
• |
Wavelength 1594.22 |
• |
Wavelength 1594.64 |
• |
Wavelength 1595.06 |
• |
Wavelength 1595.49 |
• |
Wavelength 1596.34 |
• |
Wavelength 1596.76 |
• |
Wavelength 1597.19 |
• |
Wavelength 1597.62 |
• |
Wavelength 1598.04 |
• |
Wavelength 1598.47 |
• |
Wavelength 1598.89 |
• |
Wavelength 1599.32 |
• |
Wavelength 1599.75 |
• |
Wavelength 1600.06 |
• |
Wavelength 1601.03 |
• |
Wavelength 1601.46 |
• |
Wavelength 1601.88 |
• |
Wavelength 1602.31 |
• |
Wavelength 1602.74 |
• |
Wavelength 1603.17 |
• |
Wavelength 1603.60 |
• |
Wavelength 1604.03 |
• |
Wavelength 1610 |
• |
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. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ. |
• |
In Service and Normal |
• |
Out of Service and Autonomous |
• |
Out of Service and Autonomous Management |
• |
Out of Service and Management |
<SST> |
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ. |
• |
Automatic In-Service |
• |
Disabled |
• |
Loopback |
• |
Mismatch of Equipment |
• |
Maintenance |
• |
Out of Group |
• |
Software Download |
• |
Unassigned |
• |
Unequipped |
21.4 RTRV-<MOD_RING>
(Cisco ONS 15454 and ONS 15600) The Retrieve Bidirectional Line Switched Ring (RTRV-<MOD_RING>) command retrieves the bidirectional line switched ring (BLSR) information of the NE. A two-fiber or four-fiber BLSR can be retrieved.

Note Cisco ONS 15600 does not support four-fiber BLSR.
Usage Guidelines
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:
–If the system fails on getting IOR, a SROF (Get IOR Failed) error message is returned.
–If the AID is invalid, an IIAC (Invalid AID) error message is returned.
–If the BLSR does not exist, a SRQN (BLSR Does Not Exist) error message is returned.
•Only ALL, NULL, BLSR-ALL, or BLSR-RINGID is allowed for this command.
•A NULL AID defaults to the AID ALL.
•The list AID format is supported.
Category
BLSR
Security
Retrieve
Input Format
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input Example
RTRV-BLSR:PETALUMA:ALL:123;
Input Parameters
<AID> |
Access identifier from the "AidUnionId1" section. Identifies the BLSR of the NE. Only ALL, null, or a list of BLSR-# is 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
<AID> |
(Optional) Access identifier from the "AidUnionId1" section. Identifies the BLSR of the NE. |
<RINGID> |
(Optional) The BLSR ID of the NE. String of up to six characters. Valid characters are A-Z and 0-9. |
<NODEID> |
(Optional) The BLSR node ID of the NE. NODEID is a string and ranges from 0 to 31. |
<MODE> |
(Optional) Mode with which the command is to be implemented. Identifies the BLSR mode; either two-fiber or four-fiber. The parameter type is BLSR_MODE (BLSR mode). |
• |
Two-fiber BLSR |
• |
Four-fiber BLSR |
<RVRTV> |
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that 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. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Does not revert service to original line after restoration. |
• |
Reverts service to original line after restoration. |
<RVTM> |
Revertive time. RVTM is not allowed to be set while RVRTV is N. The parameter type is REVERTIVE_TIME. |
• |
Revertive time is 0.5 to 12.0 minutes. |
<SRVRTV> |
The span revertive mode for four-fiber BLSR only. The 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. The parameter type is 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>
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve OC3, OC12, OC48, or OC192 command retrieves the attributes (for example, service parameters) and the state of an OC-N facility.
Usage Guidelines
See Table 28-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, and OC-192 ports within a BLSR connection. The RTRV-<MOD_RING> command with the AID BLSR-RINGID can provide more information about a BLSR.

Note This command does not show the WVLEN attribute if the OC-N port has a zero value.
Category
Ports
Security
Retrieve
Input Format
RTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-OC48:PENNGROVE:FAC-6-1:236;
Input Parameters
<AID> |
Access identifier from the "FACILITY" section. |
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=SINGLESHELF,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
<AID> |
Access identifier from the "FACILITY" section. |
<ROLE> |
(Optional) An OC-N port role. The parameter type is SIDE, which is 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> |
(Optional) An OC-N port status. The parameter type is STATUS, which is 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> |
(Optional) Indicates whether or not the Section data communications channel (DCC) is to be used. The parameter type is EXT_RING, which indicates whether 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> |
(Optional) Area ID. Shows up only if the DCC is enabled. AREA is a string. |
<TMGREF> |
(Optional) The termination to be used, whether primary or secondary. Identifies if an OC-N port has a timing reference. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<SYNCMSG> |
Synchronization status message. The parameter type is EXT_RING, which indicates whether 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> |
(Optional) The facility will send the DUS (Do not use for Synchronization) value in 0x0f bits pattern as the synchronization status message for that facility. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<PJMON> |
(Optional) Identifies an OC-N port PJMON. Defaults to 0 (zero). PJMON is an integer. Set a valid STS number of the optical port. Note |
<SFBER> |
(Optional) An OC-N port signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path. |
• |
SFBER is 1E-3. |
• |
SFBER is 1E-4. |
• |
SFBER is 1E-5. |
<SDBER> |
(Optional) An OC-N port signal degrade threshold. Defaults 1E-7. The parameter type is SD_BER, which is 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> |
(Optional) OC-N port mode. Defaults to SONET. The parameter type is OPTICAL_MODE, which is the facility's optical mode. |
• |
The NE contains only one shelf and the AID representation does not consider the shelf identifier for command requests/response and autonomous reports. |
• |
The AID representation considers the shelf identifier for command requests/response and autonomous reports. This means the NE has more than one shelf configured or the user wants to use the new AID style. |
• |
The AID representation considers the shelf identifier for command requests/response and autonomous reports. This means the NE has more than one shelf configured or the user wants to use the new AID style. The shelves are connected by means of an external Ethernet switch. |
<WVLEN> |
(Optional) An OC-N port wavelength in nanometers. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. WVLEN is a float. |
<RINGID> |
(Optional) The BLSR RINGID with which the port is connected. RINGID ranges from 0 to 9999. RINGID is an integer. |
<BLSRTYPE> |
(Optional) The BLSR type with which the port is connected. The parameter type is BLSR_TYPE, which is the BLSR type of an OC-N port. |
• |
The OC-N port is an east protecting port. |
• |
The OC-N port is an east working port. |
• |
The OC-N port is an west protecting port. |
• |
The OC-N port is an west working port. |
<MUX> |
(Optional) BLSR extension byte. The parameter type is MUX_TYPE, which is the BLSR extension byte. |
• |
E2 byte (orderwire) |
• |
F1 byte (user) |
• |
K3 byte |
• |
Z2 byte |
<UNIC> |
(Optional) Indicates if the port connects to the UCP. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<SOAK> |
(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer. |
<SOAKLEFT> |
(Optional) 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. Rules for <SOAKLEFT> are as follows: • • • |
<SSMRCV> |
(Optional) Displays the quality of the individual port. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the 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> |
(Optional) The Open Shortest Path First protocol. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<LDCC> |
(Optional) The Line DCC connection on the port. The parameter type is EXT_RING, which 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> |
(Optional) Port Name. NAME is a string. |
<LBCL> |
(Optional) Displays the current value of the laser current. LBCL is a float. |
<OPT> |
(Optional) Displays the current value of the transmitted optical power. OPT is only displayed for DWDM cards. OPT is a float. |
<OPR> |
(Optional) Received optical power. OPR is a float. |
<EXPTRC> |
(Optional) Expected path trace content. EXPTRC is a string. |
<TRC> |
(Optional) Path trace message to be transmitted. TRC is a string. |
<TRCMODE> |
(Optional) Path trace mode. Applicable only to STS-level Paths in SONET. Defaults to the OFF mode. The 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 alarm indication signal (AIS) and remote defect indication (RDI) if TIM-P 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 TIM-P is detected. |
• |
Turn off path trace capability. Nothing will be reported. |
<TRCFORMAT> |
(Optional) Trace message size. The parameter type is TRCFORMAT (trace format). |
• |
1-byte trace message |
• |
16-byte trace message |
• |
64-byte trace message |
• |
Enable an attribute. |
<ADMSSM> |
(Optional) SSM selectable value. Only displayed when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the 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> |
(Optional) Indicates that the facility will send the DUS value in 0xff bits pattern as the synchronization status message for that facility. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<AISONLPBK> |
(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates whether 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 1310 |
• |
Wavelength 1470 |
• |
Wavelength 1490 |
• |
Wavelength 1510 |
• |
Wavelength 1529.55 |
• |
Wavelength 1529.94 |
• |
Wavelength 1530 |
• |
Wavelength 1530.33 |
• |
Wavelength 1530.73 |
• |
Wavelength 1531.12 |
• |
Wavelength 1531.51 |
• |
Wavelength 1531.90 |
• |
Wavelength 1532.29 |
• |
Wavelength 1532.68 |
• |
Wavelength 1533.07 |
• |
Wavelength 1533.47 |
• |
Wavelength 1533.86 |
• |
Wavelength 1534.25 |
• |
Wavelength 1534.64 |
• |
Wavelength 1535.04 |
• |
Wavelength 1535.43 |
• |
Wavelength 1535.82 |
• |
Wavelength 1536.22 |
• |
Wavelength 1536.61 |
• |
Wavelength 1537 |
• |
Wavelength 1537.40 |
• |
Wavelength 1537.79 |
• |
Wavelength 1538.19 |
• |
Wavelength 1538.58 |
• |
Wavelength 1538.98 |
• |
Wavelength 1539.37 |
• |
Wavelength 1539.77 |
• |
Wavelength 1540.16 |
• |
Wavelength 1540.56 |
• |
Wavelength 1540.95 |
• |
Wavelength 1541.35 |
• |
Wavelength 1541.75 |
• |
Wavelength 1542.14 |
• |
Wavelength 1542.35 |
• |
Wavelength 1542.54 |
• |
Wavelength 1542.94 |
• |
Wavelength 1543.33 |
• |
Wavelength 1543.73 |
• |
Wavelength 1544.13 |
• |
Wavelength 1544.53 |
• |
Wavelength 1544.92 |
• |
Wavelength 1545.32 |
• |
Wavelength 1545.72 |
• |
Wavelength 1546.12 |
• |
Wavelength 1546.52 |
• |
Wavelength 1546.92 |
• |
Wavelength 1547.32 |
• |
Wavelength 1547.72 |
• |
Wavelength 1548.12 |
• |
Wavelength 1548.51 |
• |
Wavelength 1548.92 |
• |
Wavelength 1549.32 |
• |
Wavelength 1549.71 |
• |
Wavelength 1500 |
• |
Wavelength 1550.12 |
• |
Wavelength 1550.52 |
• |
Wavelength 1550.92 |
• |
Wavelength 1551.32 |
• |
Wavelength 1551.72 |
• |
Wavelength 1552.12 |
• |
Wavelength 1552.52 |
• |
Wavelength 1552.93 |
• |
Wavelength 1553.33 |
• |
Wavelength 1553.73 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.94 |
• |
Wavelength 1555.34 |
• |
Wavelength 1555.75 |
• |
Wavelength 1556.15 |
• |
Wavelength 1556.55 |
• |
Wavelength 1556.96 |
• |
Wavelength 1557.36 |
• |
Wavelength 1557.77 |
• |
Wavelength 1558.17 |
• |
Wavelength 1558.58 |
• |
Wavelength 1558.98 |
• |
Wavelength 1559.39 |
• |
Wavelength 1559.79 |
• |
Wavelength 1560.20 |
• |
Wavelength 1560.61 |
• |
Wavelength 1561.01 |
• |
Wavelength 1561.42 |
• |
Wavelength 1561.83 |
• |
Wavelength 1570 |
• |
Wavelength 1570.83 |
• |
Wavelength 1571.24 |
• |
Wavelength 1571.65 |
• |
Wavelength 1572.06 |
• |
Wavelength 1572.48 |
• |
Wavelength 1572.89 |
• |
Wavelength 1573.30 |
• |
Wavelength 1573.71 |
• |
Wavelength 1574.13 |
• |
Wavelength 1574.54 |
• |
Wavelength 1574.95 |
• |
Wavelength 1575.37 |
• |
Wavelength 1575.78 |
• |
Wavelength 1576.20 |
• |
Wavelength 1576.61 |
• |
Wavelength 1577.03 |
• |
Wavelength 1577.44 |
• |
Wavelength 1577.86 |
• |
Wavelength 1578.27 |
• |
Wavelength 1578.69 |
• |
Wavelength 1579.10 |
• |
Wavelength 1579.52 |
• |
Wavelength 1579.93 |
• |
Wavelength 1580.35 |
• |
Wavelength 1580.77 |
• |
Wavelength 1581.18 |
• |
Wavelength 1581.60 |
• |
Wavelength 1582.02 |
• |
Wavelength 1582.44 |
• |
Wavelength 1582.85 |
• |
Wavelength 1583.27 |
• |
Wavelength 1583.69 |
• |
Wavelength 1584.11 |
• |
Wavelength 1584.53 |
• |
Wavelength 1584.95 |
• |
Wavelength 1585.36 |
• |
Wavelength 1585.78 |
• |
Wavelength 1586.20 |
• |
Wavelength 1586.62 |
• |
Wavelength 1587.04 |
• |
Wavelength 1587.46 |
• |
Wavelength 1587.88 |
• |
Wavelength 1588.30 |
• |
Wavelength 1588.73 |
• |
Wavelength 1589.15 |
• |
Wavelength 1589.57 |
• |
Wavelength 1589.99 |
• |
Wavelength 1590 |
• |
Wavelength 1590.41 |
• |
Wavelength 1590.83 |
• |
Wavelength 1591.26 |
• |
Wavelength 1591.68 |
• |
Wavelength 1592.10 |
• |
Wavelength 1592.52 |
• |
Wavelength 1592.95 |
• |
Wavelength 1593.37 |
• |
Wavelength 1593.79 |
• |
Wavelength 1594.22 |
• |
Wavelength 1594.64 |
• |
Wavelength 1595.06 |
• |
Wavelength 1595.49 |
• |
Wavelength 1596.34 |
• |
Wavelength 1596.76 |
• |
Wavelength 1597.19 |
• |
Wavelength 1597.62 |
• |
Wavelength 1598.04 |
• |
Wavelength 1598.47 |
• |
Wavelength 1598.89 |
• |
Wavelength 1599.32 |
• |
Wavelength 1599.75 |
• |
Wavelength 1600.06 |
• |
Wavelength 1601.03 |
• |
Wavelength 1601.46 |
• |
Wavelength 1601.88 |
• |
Wavelength 1602.31 |
• |
Wavelength 1602.74 |
• |
Wavelength 1603.17 |
• |
Wavelength 1603.60 |
• |
Wavelength 1604.03 |
• |
Wavelength 1610 |
• |
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> |
(Optional) Indicates whether the far-end NE on the DCC is a foreign NE. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<FOREIGNIPADDRESS> |
(Optional) The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. FOREIGNIPADDRESS is a string. |
<PST_PSTQ> |
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ. |
• |
In Service and Normal |
• |
Out of Service and Autonomous |
• |
Out of Service and Autonomous Management |
• |
Out of Service and Management |
<SSTQ> |
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ. |
• |
Automatic In-Service |
• |
Disabled |
• |
Loopback |
• |
Mismatch of Equipment |
• |
Maintenance |
• |
Out of Group |
• |
Software Download |
• |
Unassigned |
• |
Unequipped |
21.6 RTRV-<PATH>
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, VT1, or VT2 (RTRV-<PATH>) command retrieves the attributes associated with an STS/VT path.
Usage Guidelines
See Table 28-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 configurations.
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 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:
•If you send this command while BLSRPTHTYPE=PCA, whether there is a BLSR switch or not, the protection channel access (PCA) path J1/C2 data will be returned (if there is PCA circuit on the AID).
•Sending this command with an STS AID that does not have circuits and where no BLSR is switched on the STS will return an error message.

Note•
An optional input parameter, BLSRPTHTYPE, is introduced into this command to provide more options to retrieve the J1/C2 of a particular BLSR path. This field is valid only if the queried AID port has BLSR. The BLSRPTHTYPE defaults to the "non-pca" path type if the BLSR is switched, or defaults to all BLSR path types if there is no BLSR switching.
•An optional output parameter, BLSRPTHSTATE, is introduced into this command output. Each J1/C2 output data of this command will include the BLSR path state information.
•After BLSR switching, the J1/IPPM/C2 data can be retrieved over the protection path. J1 trace string, trace mode, or threshold is not allowed on the protection path.
•HOLDOFFTIMER is not specific to a path. Instead, it is applicable to the path protection selector.
• VT1.5 J2 path trace provisioning is supported on the DS3XM-12 card and the ONS 15454 CE-100T-8 card VT1.5 path using the ED-VT1, RTRV-VT1, and RTRV-PTHTRC-VT1 commands. The ONS 15310-CL CE-100T-8 card supports J2 path trace.
•Test access is not supported on the ONS 15310-CL. J2 is not supported on the 15310-CL-CTX card of the ONS 15310-CL. However, the CE-100T-8 card supports J2 in the ONS 15310-CL.
•For the selector path on a BLSR, the SWPDIP path attribute is not editable and is always in the ON state.
•SFBER and SDBER are applied for the ONS 15310-CL and the ONS 15454 when the ONS 15454 has an XC-VXC-10G card.
•On the ONS 15310-MA, J2 path trace is supported on DS1 ports only. J2 path trace is not supported on ONS 15310-MA OCn ports and EC1 ports.
Category
Paths
Security
Retrieve
Input Format
RTRV-<PATH>:[<TID>]:<AID>:<CTAG>[:::BLSRPTHTYPE=<BLSRPTHTYPE>][:];
Input Example
RTRV-STS3C:FERNDALE:STS-2-1-4:238:::BLSRPTHTYPE=NON-PCA;
Input Parameters
<AID> |
Access identifier from the "CrossConnectId1" section. |
<BLSRPTHTYPE> |
The BLSR path type only if the port is on the BLSR. No value or a null value defaults to NON-PCA. Applicable only to STS-level paths in SONET. The parameter type is BLSR_PTH_TYPE, which is the 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
<AID> |
Access identifier from the "CrossConnectId1" section. |
<LEVEL> |
(Optional) The rate of the cross-connect. Indicates the rate of the cross-connected channel. Applicable only to the STS path in SONET. The parameter type is PATH, which is the 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> |
(Optional) An STS path signal failure threshold that only applies to path protection. Applicable only to STS-level paths in SONET. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path. |
• |
SFBER is 1E-3. |
• |
SFBER is 1E-4. |
• |
SFBER is 1E-5. |
<SDBER> |
(Optional) An STS path signal degrade threshold that only applies to path protection. Applicable only to STS-level paths in SONET. Defaults 1E-6. The parameter type is SD_BER, which is 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 protection switching system reverts service to the original line after restoration. The value N indicates that 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. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Does not revert service to original line after restoration. |
• |
Reverts service to original line after restoration. |
<RVTM> |
Revertive time. Only applies to path protection. The parameter type is REVERTIVE_TIME. |
• |
Revertive time is 0.5 to 12.0 minutes. |
<SWPDIP> |
(Optional) Switch on PDI-P. Applicable only to STS-level paths in SONET. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
<HOLDOFFTIMER> |
(Optional) Hold off timer. HOLDOFFTIMER is an integer. |
<EXPTRC> |
(Optional) 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 a path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. EXPTRC is a string. |
<TRC> |
(Optional) 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 |
<INCTRC> |
(Optional) 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. INCTRC is a string. |
<TRCMODE> |
(Optional) 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. The 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 TIM-P 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 TIM-P detected. |
• |
Turn off path trace capability. Nothing will be reported. |
<TRCFORMAT> |
(Optional) Trace message size. The parameter type is TRCFORMAT (trace format). |
• |
1-byte trace message |
• |
16-byte trace message |
• |
64-byte trace message |
• |
Enable an attribute. |
<TACC> |
(Optional) 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. |
<TAPTYPE> |
(Optional) TAP type. Not applicable to the ONS 15310-CL. The parameter type is TAPTYPE, which is the test access point type |
• |
Dual FAD |
• |
Single FAD |
<UPSRPTHSTATE> |
(Optional) Indicates whether a given AID is the working or standby path of a path protection cross-connect. The parameter type is STATUS, which is 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. |
<C2> |
(Optional) The C2 byte hex code. Applicable only to STS-level paths in SONET (STSn). The parameter type is C2_BYTE, which is the C2 byte hex code. |
• |
Unequipped |
• |
Equipped Non-Specific payload |
• |
VT-Structured STS-1 synchronous payload envelope (SPE) |
• |
Locked VT Mode |
• |
Asynchronous Mapping for DS3 |
• |
Asynchronous Mapping for DS4 North American (NA) |
• |
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 an AIS-L is being generated by an optical card or cross-connect downstream. |
<BLSRPTHSTATE> |
(Optional) The BLSR path state only if the port is on the BLSR. Applicable only to STS-level paths in SONET (STSn). The parameter type is BLSR_PTH_STATE, which is 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> |
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ. |
• |
In Service and Normal |
• |
Out of Service and Autonomous |
• |
Out of Service and Autonomous Management |
• |
Out of Service and Management |
<SSTQ> |
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ. |
• |
Automatic In-Service |
• |
Disabled |
• |
Loopback |
• |
Mismatch of Equipment |
• |
Maintenance |
• |
Out of Group |
• |
Software Download |
• |
Unassigned |
• |
Unequipped |
21.7 RTRV-10GIGE
(Cisco ONS 15454) The Retrieve 10GIGE (RTRV-10GIGE) command retrieves the 10 Gbps-specific parameters for a port that has been configured to support the Gigabit Ethernet payload with the ENT-10GIGE command.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-10GIGE:TID:FAC-1-1:100;
Input Parameters
<AID> |
Access identifier from the "FACILITY" section. |
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
<AID> |
Access identifier from the "FACILITY" section. |
<ROLE> |
(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is 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> |
(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is 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> |
(Optional) Port name. NAME is a string. |
<MACADDR> |
(Optional) The MAC address for the 10-Gigabit Ethernet payload. MACADDR is a string. |
<LBCL> |
(Optional) Displays the current value of the laser current. LBCL is a float. |
<OPT> |
(Optional) Displays the current value of the transmitted optical power. OPT is a float. |
<OPR> |
(Optional) Displays the current value of the received optical power. OPR is a float. |
<FREQ> |
(Optional) Parameter type is OPTICAL_WLEN (optical wavelength). |
• |
Wavelength 1310 |
• |
Wavelength 1470 |
• |
Wavelength 1490 |
• |
Wavelength 1510 |
• |
Wavelength 1529.55 |
• |
Wavelength 1529.94 |
• |
Wavelength 1530 |
• |
Wavelength 1530.33 |
• |
Wavelength 1530.73 |
• |
Wavelength 1531.12 |
• |
Wavelength 1531.51 |
• |
Wavelength 1531.90 |
• |
Wavelength 1532.29 |
• |
Wavelength 1532.68 |
• |
Wavelength 1533.07 |
• |
Wavelength 1533.47 |
• |
Wavelength 1533.86 |
• |
Wavelength 1534.25 |
• |
Wavelength 1534.64 |
• |
Wavelength 1535.04 |
• |
Wavelength 1535.43 |
• |
Wavelength 1535.82 |
• |
Wavelength 1536.22 |
• |
Wavelength 1536.61 |
• |
Wavelength 1537 |
• |
Wavelength 1537.40 |
• |
Wavelength 1537.79 |
• |
Wavelength 1538.19 |
• |
Wavelength 1538.58 |
• |
Wavelength 1538.98 |
• |
Wavelength 1539.37 |
• |
Wavelength 1539.77 |
• |
Wavelength 1540.16 |
• |
Wavelength 1540.56 |
• |
Wavelength 1540.95 |
• |
Wavelength 1541.35 |
• |
Wavelength 1541.75 |
• |
Wavelength 1542.14 |
• |
Wavelength 1542.35 |
• |
Wavelength 1542.54 |
• |
Wavelength 1542.94 |
• |
Wavelength 1543.33 |
• |
Wavelength 1543.73 |
• |
Wavelength 1544.13 |
• |
Wavelength 1544.53 |
• |
Wavelength 1544.92 |
• |
Wavelength 1545.32 |
• |
Wavelength 1545.72 |
• |
Wavelength 1546.12 |
• |
Wavelength 1546.52 |
• |
Wavelength 1546.92 |
• |
Wavelength 1547.32 |
• |
Wavelength 1547.72 |
• |
Wavelength 1548.12 |
• |
Wavelength 1548.51 |
• |
Wavelength 1548.92 |
• |
Wavelength 1549.32 |
• |
Wavelength 1549.71 |
• |
Wavelength 1500 |
• |
Wavelength 1550.12 |
• |
Wavelength 1550.52 |
• |
Wavelength 1550.92 |
• |
Wavelength 1551.32 |
• |
Wavelength 1551.72 |
• |
Wavelength 1552.12 |
• |
Wavelength 1552.52 |
• |
Wavelength 1552.93 |
• |
Wavelength 1553.33 |
• |
Wavelength 1553.73 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.13 |
• |
Wavelength 1554.94 |
• |
Wavelength 1555.34 |
• |
Wavelength 1555.75 |
• |
Wavelength 1556.15 |
• |
Wavelength 1556.55 |
• |
Wavelength 1556.96 |
• |
Wavelength 1557.36 |
• |
Wavelength 1557.77 |
• |
Wavelength 1558.17 |
• |
Wavelength 1558.58 |
• |
Wavelength 1558.98 |
• |
Wavelength 1559.39 |
• |
Wavelength 1559.79 |
• |
Wavelength 1560.20 |
• |
Wavelength 1560.61 |
• |
Wavelength 1561.01 |
• |
Wavelength 1561.42 |
• |
Wavelength 1561.83 |
• |
Wavelength 1570 |
• |
Wavelength 1570.83 |
• |
Wavelength 1571.24 |
• |
Wavelength 1571.65 |
• |
Wavelength 1572.06 |
• |
Wavelength 1572.48 |
• |
Wavelength 1572.89 |
• |
Wavelength 1573.30 |
• |
Wavelength 1573.71 |
• |
Wavelength 1574.13 |
• |
Wavelength 1574.54 |
• |
Wavelength 1574.95 |
• |
Wavelength 1575.37 |
• |
Wavelength 1575.78 |
• |
Wavelength 1576.20 |
• |
Wavelength 1576.61 |
• |
Wavelength 1577.03 |
• |
Wavelength 1577.44 |
• |
Wavelength 1577.86 |
• |
Wavelength 1578.27 |
• |
Wavelength 1578.69 |
• |
Wavelength 1579.10 |
• |
Wavelength 1579.52 |
• |
Wavelength 1579.93 |
• |
Wavelength 1580.35 |
• |
Wavelength 1580.77 |
• |
Wavelength 1581.18 |
• |
Wavelength 1581.60 |
• |
Wavelength 1582.02 |
• |
Wavelength 1582.44 |
• |
Wavelength 1582.85 |
• |
Wavelength 1583.27 |
• |
Wavelength 1583.69 |
• |
Wavelength 1584.11 |
• |
Wavelength 1584.53 |
• |
Wavelength 1584.95 |
• |
Wavelength 1585.36 |
• |
Wavelength 1585.78 |
• |
Wavelength 1586.20 |
• |
Wavelength 1586.62 |
• |
Wavelength 1587.04 |
• |
Wavelength 1587.46 |
• |
Wavelength 1587.88 |
• |
Wavelength 1588.30 |
• |
Wavelength 1588.73 |
• |
Wavelength 1589.15 |
• |
Wavelength 1589.57 |
• |
Wavelength 1589.99 |
• |
Wavelength 1590 |
• |
Wavelength 1590.41 |
• |
Wavelength 1590.83 |
• |
Wavelength 1591.26 |
• |
Wavelength 1591.68 |
• |
Wavelength 1592.10 |
• |
Wavelength 1592.52 |
• |
Wavelength 1592.95 |
• |
Wavelength 1593.37 |
• |
Wavelength 1593.79 |
• |
Wavelength 1594.22 |
• |
Wavelength 1594.64 |
• |
Wavelength 1595.06 |
• |
Wavelength 1595.49 |
• |
Wavelength 1596.34 |
• |
Wavelength 1596.76 |
• |
Wavelength 1597.19 |
• |
Wavelength 1597.62 |
• |
Wavelength 1598.04 |
• |
Wavelength 1598.47 |
• |
Wavelength 1598.89 |
• |
Wavelength 1599.32 |
• |
Wavelength 1599.75 |
• |
Wavelength 1600.06 |
• |
Wavelength 1601.03 |
• |
Wavelength 1601.46 |
• |
Wavelength 1601.88 |
• |
Wavelength 1602.31 |
• |
Wavelength 1602.74 |
• |
Wavelength 1603.17 |
• |
Wavelength 1603.60 |
• |
Wavelength 1604.03 |
• |
Wavelength 1610 |
• |
Use Tunable Wavelength 1 |
<LOSSB> |
(Optional) The 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> |
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the SST and PSTQ. |
• |
In Service and Normal |
• |
Out of Service and Autonomous |
• |
Out of Service and Autonomous Management |
• |
Out of Service and Management |
<SSTQ> |
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ. |
• |
Automatic In-Service |
• |
Disabled |
• |
Loopback |
• |
Mismatch of Equipment |
• |
Maintenance |
• |
Out of Group |
• |
Software Download |
• |
Unassigned |
• |
Unequipped |
21.8 RTRV-ALM-<MOD2ALM>
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Alarm for (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, DS1, DS3I, E1, E100, E1000, E3, E4, EC1, ETH, FSTE, G1000, GFPOS, GIGE, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OCH, OMS, OTS, OTU2, POS, RPRIF, STM1, STM4, STM16, STM64, STM1E, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC3,VC4,VC4-2c,VC4-3c,VC4-4c,VC4-16c,VC4-64c, VC11, VC12, VC3, VCG, VT1, VT2, or WLEN (RTRV-ALM-<MOD2ALM>) 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.
Usage Guidelines
See Table 28-1 for supported modifiers by platform.

Note VT1-n-n-n replaces PS_VT1-n-n-n for the VT1 alarm AID.

Note The AIDTYPE shows STS1 for STS alarms.
Category
Fault
Security
Retrieve
Input Format
RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][<LOCN>],[<DIRN>][,];
Input Example
RTRV-ALM-OC12:ELDRIDGE:FAC-5-1:225::MN,SD,SA,NEND,RCV;
Input Parameters
<AID> |
Access identifier from the "AidUnionId" section. |
<NTFCNCDE> |
Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is 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. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>]:[<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,NEND,RCV:\"BER AT SIGNAL DEGRADE LEVEL\","
;
Output Parameters
<AID> |
Access identifier from the "ALL" section. |
<AIDTYPE> |
(Optional) Type of access identifier. The parameter type is MOD2ALM (alarm type). |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
1-Gigabit ISC3 compatible |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
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 |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
(ONS 15454) ML-Series two port Gigabit Ethernet card |
• |
OC3 alarm |
• |
OC12 alarm |
• |
OC48 alarm |
• |
OC192 alarm |
• |
Optical channel |
• |
OCH termination |
• |
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 |
• |
UDC-DCC alarm |
• |
UCD-F alarm |
• |
Virtual concatenation group alarm |
• |
VT1 alarm |
• |
VT2 alarm |
• |
Wavelength path provisioning |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<OCRDAT> |
(Optional) Date when the specific event or violation occurred, MM-DD. |
<OCRTM> |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
<LOCN> |
Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<DESC> |
(Optional) A condition description. DESC is a string. |
21.9 RTRV-ALMTYPE
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Alarm Type command retrieves all system and user-defined alarm types.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-ALMTYPE:[<TID>]::<CTAG>;
Input Example
RTRV-ALMTYPE:CISCONODE::1;
Input Parameters
None.
Output Format
SID DATE TIME
M CTAG COMPLD
"<TYPEOFALM>,<ALMTYPE>"
;
Output Examples
CISCONODE 2007-06-26 14:30:00
M 1 COMPLD
"SYSTEMDEFINED,AIRCOMPR"
;
Output Parameters
21.10 RTRV-ALM-ALL
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Alarm All (RTRV-ALM-ALL) 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.
Usage Guidelines
According to Telcordia GR-833, the RTRV-ALM-ALL command only reports EQPT, COM, 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-SYNCN
Category
Fault
Security
Retrieve
Input Format
RTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDITION>],[<SRVEFF>],[<LOCN>],[<DIRN>],[,];
Input Example
RTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA,NEND,RCV;
Input Parameters
<AID> |
Access identifier from the "ALL" section. A null value is equivalent to ALL. AID is a string. |
<NTFCNCDE> |
Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message. |
• |
A critical alarm. |
• |
A major alarm. |
• |
A minor alarm. |
<CONDITION> |
The type of alarm condition. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is 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. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<LOCN>],[<DIRN>]:
[<DESC>],[<AIDDET>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,08-01,14-25-59,NEND,RCV:\"POWER FAIL RESTART\", DS1-14"
;
Output Parameters
<AID> |
(Optional) Access identifier from the "ALL" section. |
<AIDTYPE> |
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
Building integrated timing supply (BITS) alarm |
• |
Client facility for muxponder (MXP) and transponder (TXP) cards |
• |
Common alarm |
• |
DS1 alarm |
• |
DS3i-N-12 alarm |
• |
E100 alarm |
• |
E1000 alarm |
• |
EC1 alarm |
• |
ENV alarm |
• |
EQPT alarm |
• |
Fast Ethernet Port alarm |
• |
G1000 alarm |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
(ONS 15454) ML-Series two port Gigabit Ethernet card |
• |
OC3 alarm |
• |
OC12 alarm |
• |
OC48 alarm |
• |
OC192 alarm |
• |
Optical channel |
• |
Optical Multiplex Section |
• |
Optical Transport Section |
• |
Packet over SONET (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 |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<OCRDAT> |
(Optional) Date when the specific event or violation occurred, MM-DD. |
<OCRTM> |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
<DESC> |
(Optional) A condition description. DESC is a string. |
<AIDDET> |
(Optional) 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. |
21.11 RTRV-ALM-BITS
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Alarm Building Integrated Timing Supply (RTRV-ALM-BITS) 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.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],
[<LOCN>],[<DIRN>];
Input Example
RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Input Parameters
<AID> |
Access identifier from the "BITS" section. |
<NTFCNCDE> |
Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is 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. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<LOCN>],[<DIRN>]:
[<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
<AID> |
(Optional) Access identifier from the "BITS" section. |
<AIDTYPE> |
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
BITS alarm |
• |
Client facility for MXP/TXP cards |
• |
Common alarm |
• |
DS1 alarm |
• |
DS3i-N-12 alarm |
• |
E100 alarm |
• |
E1000 alarm |
• |
EC1 alarm |
• |
ENV alarm |
• |
EQPT alarm |
• |
Fast Ethernet Port alarm |
• |
G1000 alarm |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
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 |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<DESC> |
(Optional) A condition description. DESC is a string. |
21.12 RTRV-ALM-ENV
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Alarm Environment (RTRV-ALM-ENV) command retrieves the environmental alarms.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
<AID> |
Access identifier from the "ENV" section. Note |
<NTFCNCDE> |
Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the 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. The parameter type is ENV_ALM, which is the 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 |
• |
Controlled Environment Vault (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 |
• |
48 V power supply failure |
• |
-139 V power converter |
• |
-190 V 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
<AID> |
Access identifier from the "ENV" section. |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<ALMTYPE> |
The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the 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 |
• |
48 V power supply failure |
• |
-139 V power converter |
• |
-190 V 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 |
(Optional) Date when the specific event or violation occurred, MM-DD. |
OCRTM |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
DESC |
(Optional) A condition description. DESC is a string. |
21.13 RTRV-ALM-EQPT
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Alarm Equipment (RTRV-ALM-EQPT) 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.
Usage Guidelines
None
Category
Equipment
Security
Retrieve
Input Format
RTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],
[<LOCN>],[<DIRN>];
Input Example
RTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;
Input Parameters
<AID> |
Access identifier from the "EQPT" section. |
<NTFCNCDE> |
Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is 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. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>]:[<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
<AID> |
(Optional) Access identifier from the "EQPT" section. |
<AIDTYPE> |
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
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 |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
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 |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<OCRDAT> |
(Optional) Date when the specific event or violation occurred, MM-DD. |
<OCRTM> |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
<DESC> |
(Optional) A condition description. DESC is a string. |
21.14 RTRV-ALM-SYNCN
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Alarm Synchronization (RTRV-ALM-SYNCN) 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.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>],[<LOCN>],[<DIRN>];
Input Example
RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Input Parameters
<AID> |
Access identifier from the "SYNC_REF" section. |
<NTFCNCDE> |
Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is 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. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]"
;
Output Example
TID-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
<AID> |
Access identifier from the "SYN" section. |
<AIDTYPE> |
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
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 |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
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 |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<OCRDAT> |
(Optional) Date when the specific event or violation occurred, MM-DD. |
<OCRTM> |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
<DESC> |
(Optional) A condition description. DESC is a string. |
21.15 RTRV-ALMTH-<MOD2>
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Alarm Threshold for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (RTRV-ALMTH-<MOD2>) command retrieves the alarm threshold values. The only applicable MOD2 values are OC3, OC12, OC48, OC192, OCH, OMS, and OTS.
Usage Guidelines
None
Category
Fault
Security
Retrieve
Input Format
RTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<CONDTYPE>[, ,: :];
Input Example
RTRV-ALMTH-OCH::CHAN-1-3-1-RX:1: : ADD-LFAIL ;
Input Parameters
<AID> |
Access identifier from the "ALL" section. |
<CONDTYPE> |
Alarm threshold. A null value is equivalent to ALL. The parameter type is ALM_THR, which is the 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 microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-40.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.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 |
• |
Add Power Low Failure Threshold on WSS add port |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>:<CONDTYPE>,,,<THLEVEL>"
;
Output Example
TCC139 2008-10-22 14:28:01
M 13 COMPLD
"CHAN-1-3-1-RX, OCH:ADD-LFAIL , , , -16.0,"
Output Parameters
<AID> |
Access identifier from the "ALL" section. |
<MOD> |
AID type. The parameter type is MOD2, which is the line/path modifier. |
• |
10-Gigabit Fibre Channel payload |
• |
10-Gigabit fiber connectivity payload |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
1-Gigabit ISC3 compatible |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
2-Gigabit ISC3 compatible |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
D1 video |
• |
DS1 line of a DS3XM card |
• |
DS3I line |
• |
DV6000 |
• |
EC1 facility |
• |
ESCON |
• |
ETR_CLO |
• |
FSTE facility |
• |
G1000 facility |
• |
GFP over POS. Virtual ports partitioned using GFP's multiplexing capability. |
• |
Gigabit Ethernet |
• |
HDTV |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
OC-3 facility |
• |
OC-12 facility |
• |
OC-48 facility |
• |
OC-192 facility |
• |
Optical Channel |
• |
OCH client connection |
• |
OCH network connection |
• |
OCH termination |
• |
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. The parameter type is ALM_THR, which is the 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 microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.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 |
• |
Add Power Low Failure Threshold on WSS add port |
<THLEVEL> |
Threshold level. THLEVEL is a float. |
21.16 RTRV-ALMTH-EQPT
(Cisco ONS 15454, ONS 15600) The Retrieve Alarm Threshold Equipment (RTRV-ALMTH-EQPT) command retrieves the alarm thresholds for the power level monitoring on an NE.
Usage Guidelines
None
Category
Equipment
Security
Retrieve
Input Format
RTRV-ALMTH-EQPT:[<TID>]:[<AID>]:<CTAG>::[<CONDTYPE>][,,::];
Input Example
RTRV-ALMTH-EQPT:::1::BATV-HIGH;
RTRV-ALMTH-EQPT::SHELF-2:1::BATV-HIGH;
Input Parameters
<AID> |
The node or shelf access identifier from the "SHELF" section. If omitted it addresses the node or first shelf of the node. |
<CONDTYPE> |
Must not be null. The parameter type is ALM_THR, which is the 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 microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold Measured value (0.0 percent, 100.0 percent) |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.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 Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],<MOD2B>:<CONDTYPE>,,,<DNFIELD>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SHELF-1,EQPT:BATV-HIGH,,,-52.0,"
;
TID-000 1998-06-20 14:30:00
M 001 COMPLD
",EQPT:BATV-HIGH,,,-52.0,""
;
Output Parameters
<AID> |
The node or shelf access identifier from the "SHELF" section. If omitted, it addresses the node or the first shelf of the node. |
<MOD2B> |
Alarm type. The parameter type is MOD2B, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
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 |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
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 |
<CONDTYPE> |
Parameter type is ALM_THR, which is the 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 microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Receive power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.0 dBm, +30.0 dBm). |
• |
Transmit power in one tenth of a microwatt. Measured value (-0.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 |
<DNFIELD> |
DNFIELD is a float. |
21.17 RTRV-ALS
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Automatic Laser Shutoff (RTRV-ALS) 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.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-ALS:PENNGROVE:FAC-1-1:1
Input Parameters
<AID> |
Access identifier from the "AidUnionId" section. |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>],
[ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>]"
;
Output Example
TID-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
<AID> |
Access identifier from the "AidUnionId" section. |
<AIDTYPE> |
Type of access identifier.The parameter type is MOD2, which is the line/path modifier. |
• |
10-Gigabit Fibre Channel payload |
• |
10-Gigabit fiber connectivity payload |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
1-Gigabit ISC3 compatible |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
2-Gigabit ISC3 compatible |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
D1 video |
• |
DS1 line of a DS3XM card |
• |
DS3I line |
• |
DV6000 |
• |
EC1 facility |
• |
ESCON |
• |
ETR_CLO |
• |
FSTE facility |
• |
G1000 facility |
• |
GFP over POS. Virtual ports partitioned using GFP's multiplexing capability. |
• |
Gigabit Ethernet |
• |
HDTV |
• |
1-Gigabit ISC3 Peer |
• |
2-Gigabit ISC3 Peer |
• |
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode |
• |
1-Gigabit ISC1, ISC2, and ISC3 compatibility |
• |
OC-3 facility |
• |
OC-12 facility |
• |
OC-48 facility |
• |
OC-192 facility |
• |
Optical Channel |
• |
OCH client connection |
• |
OCH network connection |
• |
OCH termination |
• |
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. The parameter type is ALS_MODE, which is the working mode for automatic laser shutdown. |
• |
Automatic |
• |
Disabled |
• |
Manual |
• |
Manual restart for test |
<ALSRCINT> |
(Optional) ALS interval. The range is 60 to 300 seconds. ALSRCINT is an integer. |
<ALSRCPW> |
(Optional) ALS recovery pulse width. The range is 2.0 to 100.00 seconds, in increments of 100 ms. ALSRCPW is a float. |
<LSRSTAT> |
(Optional) Status of the laser. The 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.18 RTRV-APC
(Cisco ONS 15454) The Operate Amplifier Power Control (RTRV-APC) command retrieves the APC application attributes.
Usage Guidelines
None
Category
DWDM
Security
Maintenance
Input Format
RTRV-APC:[<TID>]::<CTAG>;
Input Example
RTRV-APC:PENNGROVE:WDMSIDE-A:114;
Input Parameters
None that require description
Output Format
SID DATE TIME
M CTAG COMPLD
"::[APCENABLE=<APCENABLE>],[APCSTATE=<APCSTATE>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"::APCENABLE=Y,APCSTATE=WORKING"
;
Output Parameters
21.19 RTRV-ATTR-CONT
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Attribute Control (RTRV-ATTR-CONT) 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.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input Example
RTRV-ATTR-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Input Parameters
<AID> |
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. |
<CONTTYPE> |
Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type. |
• |
ONS 15310-MA only |
• |
Air conditioning |
• |
Engine |
• |
Fan |
• |
Generator |
• |
Heat |
• |
Light |
• |
Miscellaneous |
• |
Sprinkler |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND"
;
Output Parameters
<AID> |
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. |
<CONTTYPE> |
Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type. |
• |
Air conditioning |
• |
ONS 15310-MA only |
• |
Engine |
• |
Fan |
• |
Generator |
• |
Heat |
• |
Light |
• |
Miscellaneous |
• |
Sprinkler |
21.20 RTRV-ATTR-ENV
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Attribute Environment (RTRV-ATTR-ENV) command retrieves the attributes associated with an environmental alarm.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
<AID> |
Access identifier from the "ENV" section. |
<NTFCNCDE> |
Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is ENV_ALM, which is the environmental alarm type. |
• |
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 |
• |
48 V power supply failure |
• |
-139 V power converter |
• |
-190 V 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>],[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,\"OPEN DOOR\""
;
Output Parameters
<AID> |
Access identifier from the "ENV" section. |
<NTFCNCDE> |
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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> |
(Optional) The alarm type for the environmental alarm. The parameter type is ENV_ALM, which is the environmental alarm type. |
• |
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 |
• |
-139 V power converter |
• |
-190 V 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> |
(Optional) Alarm description. DESC is a string. |
21.21 RTRV-AUDIT-LOG
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Audit Log (RTRV-AUDIT-LOG) 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.
Usage Guidelines
None
Category
Log
Security
Superuser
Input Format
RTRV-AUDIT-LOG:[<TID>]::<CTAG>;
Input Example
RTRV-AUDIT-LOG:::1;
Input Parameters
None that require description
Output Format
SID DATE TIME
M CTAG COMPLD
" <ENTRYNUM>,<OCRDAT>,<OCRTM>,<TASKID>,<TXSTATUS>,<DESCRIPTION>"
;
Output Example
TID-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.22 RTRV-BFDLPM-<MOD2>
(Cisco ONS 15454) The Retrieve BFDL Performance Monitoring (DS1, T1) 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 performance monitoring (PM) parameters and the 96 15-minute history requested type PM parameters.
Usage Guidelines
For example, the following input:
RTRV-BFDLPM-DS1::DS1-14-1-1:1:::REQTYPE=ENH-24HR-ES;
Will retrieve the following 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-INV
Sending this command with a REQTYPE of ENH-24HR-CSS-AND-LOFC will retrieve 96 15-minute PM parameters 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.
Category
Performance
Security
Retrieve
Input Format
RTRV-BFDLPM-<MOD2>:[<TID>]:<AID>:<CTAG>:::REQTYPE=<REQTYPE>;
Input Example
RTRV-BFDLPM-DS1:TID:DS1-14-1-1:123:::REQTYPE=ENH-24HR-ES;
Input Parameters
<AID> |
Access identifier from the "DS1" section. |
<REQTYPE> |
Indicates requested BFDL PM type. Must not be null. The parameter type is REQTYPE, which is the 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 Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<MONTYPE>,<MONVAL>,<BUCKET>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"DS1-14-1-1:ES,55,CURR-15MIN-INV"
;
Output Parameters
<AID> |
Access identifier from the "DS1" section. |
<MONTYPE> |
Monitored type which includes: BES, CSS, ES, LOFC, SES, UAS. MONTYPE is a 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. MONVAL is a string. |
<BUCKET> |
The BIN of each BFDL PM. BUCKET is a string. |
21.23 RTRV-BITS
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Building Integrated Timing Supply (RTRV-BITS) 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.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-BITS:SONOMA:BITS-1:782;
Input Parameters
<AID> |
Access identifier from the "BITS" section. |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],
[SYNCMSG=<SYNCMSG>],[AISTHRSHLD=<AISTHRSHLD>],[SABIT=<SABIT>],
[IMPEDANCE=<IMPEDANCE>],[BITSFAC=<BITSFAC>],[ADMSSM=<ADMSSM>]:[<PST>]"
;
Output Example
TID-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
<AID> |
Access identifier from the "BITS" section |
<LINECDE> |
(Optional) Line code. The parameter type is LINE_CODE. |
• |
Line code value is AMI. |
• |
Line code value is B8ZS (binary eight-zero substitution). |
<FMT> |
(Optional) Digital signal frame format. The parameter type is FRAME_FORMAT, which is the frame format for a T1 port. |
• |
Frame format is D4. |
• |
Frame format is ESF. |
• |
Frame format is unframed. |
<LBO> |
(Optional) Line buildout settings. BITS line buildout. Default value is 0 to 133. LBP is an integer. The parameter type is BITS_LineBuildOut, which is the 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 Y. The parameter type is EXT_RING, which 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> |
(Optional) Alarm indication signal threshold. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the 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> |
(Optional) When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. The 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> |
(Optional) When the frame format selection is E1, IMPEDANCE is the terminal impedance of the BITS-IN port. The parameter type is IMPEDANCE, which is the terminal impedance of the BITS-IN port |
• |
Impedance of 120 ohms |
• |
Impedance of 75 ohms |
<BITSFAC> |
(Optional) BITS facility settings. The parameter type is BITS_FAC, which is the 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> |
(Optional) SSM selectable. Only applicable to BITS-IN when SSM is disabled. Note The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the 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> |
(Optional) Primary state. The parameter type is PST, which indicates the current overall service condition of an entity. |
• |
In Service |
• |
Out of Service |
21.24 RTRV-BULKROLL-<OCN_TYPE>
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Bulkroll for OC12, OC192, OC3, or OC48 (RTRV-BULKROLL-<OCN_TYPE>) command retrieves roll data parameters on a line.
Usage Guidelines
See Table 28-1 for supported modifiers by platform.
Category
Bridge and Roll
Security
Provisioning
Input Format
RTRV-BULKROLL-<OCN_TYPE>:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-BULKROLL-OC12:CISCO:FAC-3-1:1;
Input Parameters
<SRC> |
Source AID from the "FACILITY" section. |
Output Format
SID DATE TIME
M CTAG COMPLD
"<FROM>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],VLDSIG=<VLDSIG>"
;
Output Example
TID-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
<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> |
(Optional) The rolling mode of operation. The parameter type is RMODE, which specifies the roll mode. |
• |
Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous end-point. |
• |
Manual. Enter the corresponding delete roll/bulkroll command to delete the previous end-point. |
• |
Manual |
• |
Manual Restart for Test |
<VLDSIG> |
(Optional) The rolling mode of operation. The parameter type is ON_OFF (disable or enable an attribute). |
• |
Disable an attribute. |
• |
Enable an attribute. |
21.25 RTRV-CMD-SECU
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Command Security (RTRV-CMD-SECU) command retrieves the current command security level of the command specified in the AID field.
Usage Guidelines
None
Category
Security
Security
Superuser
Input Format
RTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-CMD-SECU::INIT-REG:1;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<CAP>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"INIT-REG:PROV"
;
Output Parameters
21.26 RTRV-COND-<MOD2ALM>
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Condition for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, DS1, DS3I, E1, E100, E1000, E3, E4, EC1, ETH, FSTE, G1000, ETH, GFPOS, GIGE, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OCH, OMS, OTS, OTU2, POS, RPRIF, STM1, STM4, STM16, STM64, STM1E, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC11, VC12, VC3, VC4, VC4-2c,VC4-3c, VC4-4c, VC4-8c, VC4-16c, VC4-64c, VCG, VT1, VT2, WLEN, or RPRIF
(RTRV-COND-<MOD2ALM>) command retrieves the current standing condition and state associated with an entity.
Usage Guidelines
See Table 28-1 for supported modifiers by platform.
Category
Fault
Security
Retrieve
Input Format
RTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-RPRIF:DXT:RPRIF-2-0:229::FORCE-REQ;
Input Parameters
<AID> |
Access identifier from the "ALL" section. |
<TYPEREQ> |
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],<LOCN>,<DIRECTION>,[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"RPRIF-2-0,T3:MJ,FORCE-REQ,SA,01-01,16-00-20,NEND,RCV,\"FORCED SWITCH REQUEST\""
;
Output Parameters
<AID> |
Access identifier from the "ALL" section. |
<AIDTYPE> |
(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2ALM, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
1-Gigabit ISC3 compatible |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
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 |
• |
Gigabit Ethernet port alarm |
• |
1-Gigabit ISC3 Peer |
• |
2 Gbps ISC3 Peer |
• |
1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode |
• |
1 Gbps ISC1, ISC2, and ISC3 compatibility |
• |
OC3 alarm |
• |
OC12 alarm |
• |
OC48 alarm |
• |
OC192 alarm |
• |
Optical channel |
• |
OCH termination |
• |
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 |
• |
UDC-DCC alarm |
• |
UCD-F alarm |
• |
Virtual concatenation group alarm |
• |
VT1 alarm |
• |
VT2 alarm |
• |
Wavelength path provisioning |
<NTFCNCDE> |
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, |
<SRVEFF> |
(Optional) The effect on service caused by the standing alarm or condition The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<OCRDAT> |
(Optional) Date when the specific event or violation occurred, MM-DD. |
<OCRTM> |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<DESC> |
(Optional) Condition description. DESC is a string. |
21.27 RTRV-COND-ALL
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Condition All (RTRV-CON-ALL) command retrieves the current standing condition for all entities.
Usage Guidelines
According to Telcordia 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. Telcordia 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-SYNCN
Category
Fault
Security
Retrieve
Input Format
RTRV-COND-ALL:[<TID>]:[<AID>]:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-ALL:DXT:ALL:229::FORCE-REQ;
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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],<LOCN>,<DIRECTION>,[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"RPRIF-2-0,T3:MJ,FORCE-REQ,SA,01-01,16-00-20,NEND,RCV,\"FORCED SWITCH REQUEST\""
;
Output Parameters
<AID> |
Access identifier from the "ALL" section that has an alarm condition. |
<AIDTYPE> |
(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type. |
• |
1-Gigabit Fibre Channel payload |
• |
1-Gigabit fiber connectivity payload |
• |
2-Gigabit Fibre Channel payload |
• |
2-Gigabit fiber connectivity payload |
• |
4-Gigabit Fibre Channel payload |
• |
4-Gigabit fiber connectivity payload |
• |
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 |
• |
Gigabit Ethernet port alarm |
• |
1 Gbps ISC3 Peer |
• |
2 Gbps ISC3 Peer |
• |
1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode |
• |
1 Gbps ISC1, ISC2, and ISC3 compatibility |
• |
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 |
<NTFCNCDE> |
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the 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. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<SRVEFF> |
(Optional) The effect on service caused by the standing alarm or condition The parameter type is SERV_EFF, which is the effect of the alarm on service. |
• |
The condition is non-service affecting. |
• |
The condition is service affecting. |
<OCRDAT> |
(Optional) Date when the specific event or violation occurred, MM-DD. |
<OCRTM> |
(Optional) Time when the specific event or violation occurred, HH-MM-SS. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
<DESC> |
(Optional) Condition description. DESC is a string. |
21.28 RTRV-COND-BITS
(Cisco ONS 15454, 15327, 15600, 15310) The Retrieve Condition Building Integrated Timing Supply (RTRV-COND-BITS) command retrieves the standing conditions on BITS.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-COND-BITS:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-BITS:TID:BITS-1:229::LOS;
Input Parameters
<AID> |
Access identifier from the "BITS" section. |
<TYPEREQ> |
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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, NA conditions, and NR conditions. See Chapter 27 "Conditions" for a list of conditions. |
<LOCN> |
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is 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. |
<DIRN> |
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions. |
• |
Both transmit and receive directions |
• |
Receive direction only |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;