-
Cisco ONS SDH TL1 Command Guide, Release 8.5
-
Preface
-
Chapter 1, ACT Commands
-
Chapter 2, ALW Commands
-
Chapter 3, APPLY Commands
-
Chapter 4, CANC Commands
-
Chapter 5, CHG Commands
-
Chapter 6, CLR Commands
-
Chapter 7, CONN Commands
-
Chapter 8, COPY Commands
-
Chapter 9, DISC Commands
-
Chapter 10, DLT Commands
-
Chapter 11, ED Commands
-
Chapter 12, ENT Commands
-
Chapter 13, EX Commands
-
Chapter 14, INH Commands
-
Chapter 15, INIT Commands
-
Chapter 16, OPR Commands
-
Chapter 17, REPT Messages
-
Chapter 18, RLS Commands
-
Chapter 19, RMV Commands
-
Chapter 20, RST Commands
-
Chapter 21, RTRV Commands
-
Chapter 22, SCHED Commands
-
Chapter 23, SET Commands
-
Chapter 24, SW Commands
-
Chapter 25, Access Identifiers
-
Chapter 26, Conditions
-
Chapter 27, Modifiers
-
Table Of Contents
21.23 RTRV-BULKROLL-<STM_TYPE>
21.46 RTRV-FFP-<MOD2DWDMPAYLOAD>
21.87 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
RTRV Commands
This chapter provides retrieve (RTRV) commands for the Cisco ONS 15454 SDH and
Cisco ONS 15600 SDH.21.1 RTRV-<MOD1FCPAYLOAD>
(Cisco ONS 15454 SDH) The Retrieve 1GFC, 2GFC, 4 GFC, or 10 GFC (RTRV-<MOD1FCPAYLOAD>) command retrieves the attributes related with the Fibre Channel port. See Table 27-1 on page 27-1 for supported modifiers by platform.
Usage Guidelines
None
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 "25.13 FACILITY" section on page 25-18.
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>]:
<PSTPSTQ>,[<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:LOCKED-ENABLED,MAINTENANCE"
;Output Parameters
<AID>
Access identifier from the "25.13 FACILITY" section on page 25-18.
<ROLE>
(Optional) The port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
PROT
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) The port status in a Y-cable protection scheme. 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>
(Optional) 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>
(Optional) 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>
(Optional) 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, which is the 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) Locked-Automatic In Service to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-Automatic In Service to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. The rules for SOAKLEFT are:
•
•
•
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the 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>
The parameter type is REACH, which is the reach value.
•
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
<PSTPSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (PST) and primary state qualifier (PSTQ).
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and 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 and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.2 RTRV-<MOD1FICONPAYLOAD>
(Cisco ONS 15454 SDH) The Retrieve 1GFICON, 2GFICON, or 4GFICON (RTRV-MOD1FICONPAYLOAD>) command returns Fibre-Channel-specific settings for ports that have been configured to carry fiber connectivity (FICON) traffic using the ENT-FICON command. The MXP_MR_2.5G and MXPP_MR_2.5G cards only support the GFP-T frame type. See Table 27-1 on page 27-1 for supported modifiers by platform.
Usage Guidelines
None
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 "25.13 FACILITY" section on page 25-18.
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>]:
<PSTPSTQ>,<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:LOCKED-ENABLED,
MAINTENANCE"
;Output Parameters
<AID>
Access identifier from the "25.13 FACILITY" section on page 25-18.
<ROLE>
(Optional) The port role in a Y-cable protection scheme. 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) Port status in a Y-cable protection scheme. 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>
(Optional) 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>
(Optional) 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>
(Optional) 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, which is the 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) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked 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:
•
•
•
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the 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, which is the reach value.
•
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
<PSTPSTQ>
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, autonomous and management
•
Out of service and management
<SST>
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 and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.3 RTRV-<MOD2DWDMPAYLOAD>
(Cisco ONS 15454 SDH) 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. See Table 27-1 on page 27-1 for supported modifiers by platform.
Usage Guidelines
None
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 "25.13 FACILITY" section on page 25-18.
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:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;Output Parameters
<AIDUNIONID>
Access identifier from the "25.2 AidUnionId" section on page 25-6.
<AIDTYPE>
A type of access identifier. The parameter type is MOD2DWDMPAYLOAD, which is 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
•
ETRCLO payload
•
Gigabit Ethernet payload
•
HDTV payload
•
ISC1 payload
•
ISC3 payload
•
Any pass-through (2R) payload
<ROLE>
(Optional) The port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit has 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) Port status in a Y-cable protection scheme. 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) The parameter type is OPTICAL_WLEN, which is the 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, which is the reach value.
•
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
<PSTPSTQ>
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, autonomous and 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 and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.4 RTRV-<MOD_RING>
(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Multiplex Section Shared Protection Ring (RTRV-<MOD_RING>) command retrieves the multiplex section-shared protection ring (MS-SPRing) information of the network element (NE). A two-fiber or four-fiber MS-SPRing can be retrieved.
Usage Guidelines
Error conditions:
•
•
•
•
•
•
Category
MS-SPRing
Security
Retrieve
Input Format
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input Example
RTRV-MSSPR:PETALUMA:ALL:123;
Input Parameters
<AID>
(Optional) Access identifier from the "25.3 AidUnionId1" section on page 25-8. Identifies the MS-SPRing of the NE. Only ALL, null or a list of MSSPR-# in AID are allowed. A null value is equivalent to ALL.
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>],
[EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>],
[WESTPROT=<WESTPROT>]"
;Output Example
•
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"MSSPR-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"
;•
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"MSSPR-N12EF::RINGID=N12EF,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1"
;Output Parameters
<AID>
(Optional) Access identifier from the "25.3 AidUnionId1" section on page 25-8. Identifies the MS-SPRing of the NE.
<RINGID>
(Optional) The MS-SPRing ID of the NE up to six characters. Valid characters are A-Z and 0-9. RINGID is a string.
<NODEID>
(Optional) The MS-SPRing node ID of the NE. NODEID ranges from 0 to 31. NODEID is a string.
<MODE>
(Optional) Mode with which the command is to be implemented. Identifies the MS-SPRing mode; either two-fiber or four-fiber. The parameter type is MSSPR_MODE, which is the MS-SPRing mode.
•
Two-fiber MS-SPRing
•
Four-fiber MS-SPRing
<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>
(Optional) Revertive time. RVTM is not allowed to be set while RVRTV is N. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<SRVRTV>
(Optional) The span revertive mode for four-fiber MS-SPRing only. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SRVTM>
(Optional) The span revertive time for four-fiber MS-SPRing only. SRVTM is not allowed to be set while SRVRTV is N. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<EASTWORK>
(Optional) East working facility. AID from the "25.13 FACILITY" section on page 25-18.
<WESTWORK>
(Optional) West working facility. AID from the "25.13 FACILITY" section on page 25-18.
<EASTPROT>
(Optional) East protecting facility. AID from the "25.13 FACILITY" section on page 25-18.
<WESTPROT>
(Optional) West protecting facility. AID from the "25.13 FACILITY" section on page 25-18.
21.5 RTRV-<PATH>
(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-<PATH>) command retrieves the attributes associated with an VC path. See Table 27-1 on page 27-1 for supported modifiers by platform.
Usage Guidelines
•
•
•
•
•
–
–
•
•
Sending this command while MSSPRPTHTYPE=PCA, whether there is MS-SPRing 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 a VC AID without circuits and no MS-SPRing switched on the VC, will return and error message.
•
•
•
•
•
Category
Paths
Security
Retrieve
Input Format
RTRV-<PATH>:[<TID>]:<AID>:<CTAG>:::[MSSPRPTHTYPE=<MSSPRPTHTYPE>][:];
Input Example
RTRV-VC4:FERNDALE:VC4-2-1-4:238:::MSSPRPTHTYPE=NON-PCA;
Input Parameters
<AID>
Access identifier from the "25.10 CrossConnectId1" section on page 25-13.
<MSSPRPTHTYPE>
(Optional) The MS-SPRing path type (only if the port is on the MS-SPRing). Defaults to NON-PCA. Applicable only to VC-level paths in SDH. A null value defaults to NON-PCA. The parameter type is MSSPR_PTH_TYPE, which is the MS-SPRing path type only if the port is on the MS-SPRing.
•
The AID is on the working path, or the cross-connection card protection path.
•
The AID is on the MS-SPRing 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>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[SNCPPTHSTATE=<SNCPPTHSTATE>],[C2=<C2>],
[MSSPRPTHSTATE=<MSSPRPTHSTATE>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-2-1-4::LEVEL=VC3,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=DUAL,
SNCPPTHSTATE=ACT,C2=0X04,
MSSPRPTHSTATE=PROTPTHACT:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;Output Parameters
<AID>
Access identifier from the "25.10 CrossConnectId1" section on page 25-13.
<LEVEL>
(Optional) The rate of the cross-connected channel. Applicable only to High-Order paths (VC4). The parameter type is PATH, which is the modifier for path commands.
•
Synchronous Transport Signal/Module Level-1 (51 Mbps)
•
Synchronous Transport Signal/Module Level-12 Concatenated (622 Mbps)
•
Synchronous Transport Signal/Module Level-18 Concatenated (933 Mbps)
•
Synchronous Transport Signal/Module Level-192 Concatenated (9952 Mbps)
•
Synchronous Transport Signal/Module Level-24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal/Module Signal Level-3 Concatenated (155 Mbps)
•
Synchronous Transport Signal/Module Level-48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal/Module level-6 (310 Mbps)
•
Synchronous Transport Signal/Module Level-9 Concatenated (465 Mbps)
•
Virtual Tributary 2. Virtual Channel 12
<SFBER>
(Optional) A VC path signal failure threshold that only applies to SNCP. Applicable only to High-Order paths. 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) A VC path signal degrade threshold that only applies to SNCP. Applicable only High-Order paths. 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>
(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
(Optional) Revertive time. Only applies to SNCP. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
SWPDIP
(Optional) Switch on PDI-P. Applicable only to VC-level paths (VCn). 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 and LF. Applicable to VC-level paths (VCn). Defaults to NULL when SNCP path is created. 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 VC-level paths (VCn). TRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to VC-level paths in (VCn). Defaults to Null when a SNCP path is created. INCTRC is a string.
<TRCMODE>
(Optional) Path trace mode. Applicable only to VC-level paths (VCn). Defaults to OFF when a SNCP path is created. The parameter type is TRCMODE, which is the trace mode.
•
Use the previously received path trace string as the expected string (not applicable to MXP_2.5G_10G and TXP_MR_10G cards).
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected.
•
Turn off path trace capability. Nothing will be reported.
<TACC>
(Optional) Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual facility access digroup (FAD).
•
Single FAD
<SNCPPTHSTATE>
(Optional) Indicates whether a given AID is the working or standby path of a SNCP 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 VC-level paths (VCn). The parameter type is C2_BYTE, which is the C2 byte hex code.
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured VC-1 synchronous payload envelope (SPE)
•
Locked Virtual Tributary (VT) mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4 North American (NA)
•
Mapping for asynchronous transfer mode (ATM)
•
Mapping for distributed queue dual bus (DQDB)
•
Asynchronous Mapping for fiber distributed data interface (FDDI)
•
High-level data link control (HDLC)-Over-SDH Mapping
•
VT-structured VC4-1 SPE with 1VTx payload defect
•
VT-structured VC4-1 SPE with 2VTx payload defects
•
VT-structured VC4-1 SPE with 3VTx payload defects
•
VT-structured VC4-1 SPE with 4VTx payload defects
•
VT-structured VC4-1 SPE with 5VTx payload defects
•
VT-structured VC4-1 SPE with 6VTx payload defects
•
VT-structured VC4-1 SPE with 7VTx payload defects
•
VT-structured VC4-1 SPE with 8VTx payload defects
•
VT-structured VC4-1 SPE with 9VTx payload defects
•
VT-structured VC4-1 SPE with 10VTx payload defects
•
VT-structured VC4-1 SPE with 11VTx payload defects
•
VT-structured VC4-1 SPE with 12VTx payload defects
•
VT-structured VC4-1 SPE with 13VTx payload defects
•
VT-structured VC4-1 SPE with 14VTx payload defects
•
VT-structured VC4-1 SPE with 15VTx payload defects
•
VT-structured VC4-1 SPE with 16VTx payload defects
•
VT-structured VC4-1 SPE with 17VTx payload defects
•
VT-structured VC4-1 SPE with 18VTx payload defects
•
VT-structured VC4-1 SPE with 19VTx payload defects
•
VT-structured VC4-1 SPE with 20VTx payload defects
•
VT-structured VC4-1 SPE with 21VTx payload defects
•
VT-structured VC4-1 SPE with 22VTx payload defects
•
VT-structured VC4-1 SPE with 23VTx payload defects
•
VT-structured VC4-1 SPE with 24VTx payload defects
•
VT-structured VC4-1 SPE with 25VTx payload defects
•
VT-structured VC4-1 SPE with 26VTx payload defects
•
VT-structured VC4-1 SPE with 27VTx payload defects
•
VT-structured VC4-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved. C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
<MSSPRPTHSTATE>
(Optional) The MS-SPRing path state only if the port is on the MS-SPRing. Applicable only to VC-level paths in SDH (VCn). The parameter type is MSSPR_PTH_STATE, which is the MS-SPRing path state only if the port is on the MS-SPRing.
•
Indicates that the MS-SPRing switched and its PCA path is in the active state.
•
Indicates that the MS-SPRing switched and its PCA path is in the standby state.
•
Indicates that the MS-SPRing switched and its protection path is in the active state.
•
Indicates that the MS-SPRing switched and its working path is in the active state.
•
Indicates that the MS-SPRing switched and its working path is in the standby state.
<PSTPSTQ>
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 the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and 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 and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.6 RTRV-<STM_TYPE>
(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve (STM1, STM4, STM16, STM64) command retrieves the attributes (such as service parameters) and the state of an STM facility. See Table 27-1 on page 27-1 for supported modifiers by platform.
Usage Guidelines
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-STM16:PENNGROVE:FAC-6-1:236;
Input Parameters
<AID>
Access identifier from the "25.13 FACILITY" section on page 25-18.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[RSDCC=<RSDCC>],[AREA=<AREA>],
[TMGREF=<TMGREF>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],
[PJMON=<PJMON>],[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],
[WVLEN=<WVLEN>],[RINGID=<RINGID>],[MSSPRTYPE=<MSSPRTYPE>],
[MUX=<MUX>],[UNIC=<UNIC>],[CCID=<CCID>],[NBRIX=<NBRIX>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>],[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],
[MSDCC=<MSDCC>],[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:RSDCC=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,
MSSPRTYPE=WESTWORK,MUX=E2,UNIC=Y,CCID=8,NBRIX=2,SOAK=52,
SOAKLEFT=12-25,SSMRCV=STU_SDH,OSPF=Y,MSDCC=Y,NAME=\"STM PORT\",
LBCL=10.0,OPT=10.0,OPR=10.0, EXPTRC="AAA",TRC="AAA",TRCMODE=MAN,
TRCFORMAT=16-BYTE,ADMSSM=G811, SENDDUSFF=N,
AISONLPBK=AIS_ON_LPBK_ALL,FREQ=1550,LOSSB=LR-1,FOREIGNFEND=Y,
FOREIGNIPADDRESS=10.92.63.44,UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;Output Parameters
<AID>
Access identifier from the "25.13 FACILITY" section on page 25-18.
<ROLE>
(Optional) An STM 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 STM 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.
<RSDCC>
(Optional) Indicates whether or not the regenerator section DCC (RS-DCC) is to be used. 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.
<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 STM 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>
(Optional) Synchronization status message. 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.
<SENDDUS>
(Optional) The facility will send the Do Not Use for Synchronization (DUS) value in 0x0f bit 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 STM port PJMON. Defaults to 0 (zero). PJMON is an integer. Set a valid VC4 number of the optical port.
Note
<SFBER>
(Optional) An STM 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 STM 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) STM port mode. Defaults to SDH. 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 STM port wavelength, expressed in nanometers. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. WVLEN is a float.
<RINGID>
(Optional) The MS-SPRing RINGID with which the port is connected. RINGID ranges from 0 to 9999. RINGID is an integer.
<MSSPRTYPE>
(Optional) The MS-SPRing type with which the port is connected. The parameter type is MSSPR_TYPE, which is the MS-SPRing type of an STM port.
•
The STM port is an east protecting port.
•
The STM port is an east working port.
•
The STM port is an west protecting port.
•
The STM port is an west working port.
<MUX>
(Optional) MS-SPRing extension byte. The parameter type is MUX_TYPE, which is the MS-SPRing extension byte.
•
E2 byte (orderwire)
•
F1 byte (user)
•
K3 byte
•
Z2 byte
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked 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:
•
•
•
<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 SDH.
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
<OSPF>
(Optional) The Open Shortest Path First discovery. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<MS-DCC>
(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 VC-level Paths in SDH (VCn). 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 AIS and RDI if TIMP is detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Turn off path trace capability. Nothing will be reported.
<TRCFORMAT>
(Optional) Trace message size. The parameter type is TRCFORMAT, which is the 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 SDH.
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
<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) The parameter type is AIS_ON_LPBK, which indicates if AIS should be sent on loopback.
•
AIS is sent on facility loopback.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopback.
•
AIS is sent on terminal loopback.
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the 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, which is the reach value.
•
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 enabled an attribute).
•
Disable an attribute.
•
Enable an attribute.
<FOREIGNIP>
(Optional) The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. FOREIGNIP is a string.
<PSTPSTQ>
(Optional) 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, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) The 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 and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.7 RTRV-10GIGE
(Cisco ONS 15454 SDH) 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 "25.13 FACILITY" section on page 25-18.
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 Examples
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:Unlocked-Disabled,AutomaticInService"
;Output Parameters
<AID>
Access identifier from the "25.13 FACILITY" section on page 25-18.
<ROLE>
(Optional) The port role in a Y-cable protection scheme. 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) Port status in a Y-cable protection scheme. 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) The parameter type is OPTICAL_WLEN, which is the 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, which is the reach value.
•
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
<PSTPSTQ>
Administrative state in the PSTPSTQ format. The parameter type is PSTPSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and 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 and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
21.8 RTRV-ALM-<MOD2ALM>
(Cisco ONS 15454 SDH and ONS 15600 SDH) 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, STM4, STM64, STM1, STM16, OCH, OMS, OTS, OTU2, POS, RPRIF, STM1, STM4, STM16, STM64, STM1E, VC3, VC4-4C, VC4-6C, VC4-64C, VC4-8C, VC4-12C, VC4, VC4-16C, VC4-2C, VC4-3C, T1, T3, UDCDCC, UDCF, VC3, VC4, VC4-2c, VC4-3c, VC4-4c, VC4-16c, VC4-64c, VC11, VC12, VC3, VCG, VC11, VC12, or WLEN (RTRV-ALRM-<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. See Table 27-1 on page 27-1 for supported modifiers by platform.
Usage Guidelines
•
•
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 "25.2 AidUnionId" section on page 25-6.
<NTFCNCDE>
(Optional) 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>
(Optional) 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 SDH or ONS 15600 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not Alarmed (NA) conditions, and Not Reported (NR) conditions. See the Table 26-1 on page 26-1 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. 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 "25.1 ALL" section on page 25-1.
<AIDTYPE>
(Optional) Type of access identifier. 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
•
DS3i-N-12 alarm
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 frame. Only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
•
Fast Ethernet port alarm
•
G1000 alarm
•
Generic framing protocol over packet over SDH 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
•
Optical channel
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STM1 alarm
•
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card.
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC38C alarm
•
VC44C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual concatenation group 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 SDH or ONS 15600 SDH shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See the Table 26-1 on page 26-1 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. 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) The condition description.
21.9 RTRV-ALMTYPE
(Cisco ONS 15454 SDH and ONS 15600 SDH) 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