|
|
Table Of Contents
21.23 RTRV-BULKROLL-<OCN_TYPE>
21.42 RTRV-FFP-<MOD2DWDMPAYLOAD>
21.78 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
RTRV Commands
Note
The terms "Unidirectional Path Switched Ring" and "UPSR" may appear in Cisco literature. These terms do not refer to using Cisco ONS 15xxx products in a unidirectional path switched ring configuration. Rather, these terms, as well as "Path Protected Mesh Network" and "PPMN," refer generally to Cisco's path protection feature, which may be used in any topological network configuration. Cisco does not recommend using its path protection feature in any particular topological network configuration.
This chapter provides retrieve (RTRV) commands for the Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, and ONS 15600.
21.1 RTRV-<MOD1FCPAYLOAD>
(Cisco ONS 15454) The Retrieve 1GFC or 2GFC (RTRV-<MOD1FCPAYLOAD>) command retrieves the attributes related with the Fibre Channel port.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryPorts
SecurityRetrieve
Input FormatRTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:LINKRATE=<LINKRATE>,LINKSTATE=<LINKSTATE>,
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFC,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,
NAME=\"FC PORT\",SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,
LOSSB=LR-1:OOS-MA,MT"
;Output Parameters
<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.
<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.
•
The rate is 1 G Fibre Channel.
•
The rate is 1 G FICON.
•
The rate is 2 G Fibre Channel.
•
The rate is 2 G FICON.
•
The rate is unknown.
•
The 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 the primary state (PST) and a 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 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 or 2GFICON (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 27-1 for supported modifiers by platform.
CategoryPorts
SecurityRetrieve
Input FormatRTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>],
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,<SST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFICON,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,NAME=\"FC PORT\",
SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,LOSSB=LR-1:OOS-MA,MT"
;Output Parameters
<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.
•
The rate is 1 G Fibre Channel.
•
The rate is 1 G FICON.
•
The rate is 2 G Fibre Channel.
•
The rate is 2 G FICON.
•
The rate is unknown.
•
The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected.
<LINKSTATE>
Link state. 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 primary state (PST) and a 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 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 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RTRV-<MOD2DWDMPAYLOAD>) command retrieves the configuration parameter of a dense wavelength division multiplexing (DWDM) client.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-HDTV:MILAN:FAC-1-1:100;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[LBCL=<LBCL>],
[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1,HDTV:,,WORK,ACT:NAME=\"NY PORT\",LBCL=10.0,OPT=10.0,OPR=10.0,
FREQ=1550,LOSSB=LR-1:OOS-AU,AINS"
;Output Parameters
<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 (FICON) payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit FICON 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 primary state (PST) and a 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 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, ONS 15327, 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
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"•
–
–
–
•
•
•
CategoryBLSR
SecurityRetrieve
Input FormatRTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input ExampleRTRV-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 FormatSID DATE TIME
M CTAG COMPLD
"[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>],
[EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>],
[WESTPROT=<WESTPROT>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BLSR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,SRVRTV=Y,SRVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,EASTPROT=FAC-12-1,WESTPROT=FAC-13-1"
;Output Parameters
<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>
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
Revertive time. RVTM is not allowed to be set while RVRTV is N. 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, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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 27-1 for supported modifiers by platform.
Both RINGID and BLSRTYPE identify the OC-N port connected with a BLSR. These attributes are only presented for the OC-12, OC-48, 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
UNI-C DCC provisioning notes:
•
•
•
•
•
•
•
•
CategoryPorts
SecurityRetrieve
Input FormatRTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-OC48:PENNGROVE:FAC-6-1:236;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>],
[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>],
[RINGID=<RINGID>],[BLSRTYPE=<BLSRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],
[LDCC=<LDCC>],[NAME=<NAME>],[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>],
[SENDDUSFF=<SENDDUSFF>],[AISONLPBK=<AISONLPBK>],
[FREQ=<FREQ>],[LOSSB=<LOSSB>],[FOREIGNFEND=<FOREIGNFEND>],
[FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],:<PSTPSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:DCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SONET,WVLEN=1310.00,RINGID=43,
BLSRTYPE=WESTWORK,MUX=E2,UNIC=Y,
SOAKLEFT=\"12-25\",SSMRCV=STU,OSPF=Y,LDCC=Y,NAME=\"OCN PORT\",LBCL=10.0,
OPT=10.0,OPR=10.0,EXPTRC=\"AAA\",TRC=\"AAA\",TRCMODE=MAN,
TRCFORMAT=16-BYTE,ADMSSM=PRS,SENDDUSFF=N,AISONLPBK=AIS_ON_LPBK_ALL,
FREQ=1550,LOSSB=LR-1,FOREIGNFEND=Y,
FOREIGNIPADDRESS=10.92.63.44,:OOS-AU,AINS"
;Output Parameters
<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.
<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.
•
SDH/ETSI optical mode using European/International format
•
SONET/ANSI optical mode using the American format
<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) 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>
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 primary state (SST) and a primary state qualifier (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, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RTRV-<PATH>) command retrieves the attributes associated with an STS/VT path.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
Supported AIDs are: ALL, SLOT-N (N=1,2,...,ALL), and STS/VT-specific AIDs.
The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and UPSRPTHSTATE parameters only apply to path protection 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:
•
•
Note
•
•
•
•
•
•
•
•
CategoryPaths
SecurityRetrieve
Input FormatRTRV-<PATH>:[<TID>]:<AID>:<CTAG>[:::BLSRPTHTYPE=<BLSRPTHTYPE>][:];
Input ExampleRTRV-STS3C:FERNDALE:STS-2-1-4:238:::BLSRPTHTYPE=NON-PCA;
Input Parameters
<AID>
Access identifier from the "CrossConnectId1" section. Must not be null.
<BLSRPTHTYPE>
The BLSR path type only if the port is on the BLSR. 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 FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT =<TRCFORMAT>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[UPSRPTHSTATE=<UPSRPTHSTATE>],[C2=<C2>],
[BLSRPTHSTATE=<BLSRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-2-1-4::LEVEL=STS1,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TRCFORMAT=64-BYTE,TACC=8,
TAPTYPE=DUAL,UPSRPTHSTATE=ACT,C2=0X04,
BLSRPTHSTATE=PROTPTHACT:OOS-AU,AINS"
;Output Parameters
<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 the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<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 (ONS 15310-CL) provisioned in mapper mode. TRC is a string.
<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 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 DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if 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 primary state (SST) and a primary state qualifier (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
CategoryPorts
SecurityRetrieve
Input FormatRTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-10GIGE:TID:FAC-1-1:100;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:NAME=\"NY PORT\",MACADDR=00-0E-AA-BB-CC-FF,LBCL=10.0,
OPT=10.0,OPR=10.0,FREQ=1550,LOSSB=SX:OOS-AU,AINS"
;Output Parameters
<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 primary state (SST) and a primary state qualifier (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, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Alarm for 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS1, E100, E1000, E3, E4, EC1, FSTE, G1000, GFPOS, GIGE, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC12, VC3, VCG, VT1, VT2, 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.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
Note
Note
CategoryFault
SecurityRetrieve
Input FormatRTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input ExampleRTRV-ALM-OC12:ELDRIDGE:FAC-5-1:225::MN,SD,SA;
Input Parameters
<AID>
Access identifier from the "AidUnionId" section. Must not be null.
<NTFCNCDE>
Two-letter notification code. A null value is equivalent to ALL. 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. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1,OC12:MJ,SD,SA,09-05,12-30-20,,:\"BER AT SIGNAL DEGRADE LEVEL\","
;Output Parameters
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of access identifier. The parameter type is MOD2ALM (alarm type).
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
1 Gbps ISC3 compatible
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
Client facility for MXP/TXP cards
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
Generic framing protocol over packet over SONET virtual port alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G payload
•
ISC3PEER2G payload
•
ISC3PEER2R payload
•
ISCCOMPAT payload
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
T1 alarm
•
T3 alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual Concatenation Group alarm
•
VT1 alarm
•
VT2 alarm
•
Wavelength Path Provisioning
<NTFCNCDE>
Two-letter notification code. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
21.9 RTRV-ALM-ALL
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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, and rr (T1, T3, OCN, EC1, STSN, VT1, DS1, E100, E1000, G1000, ML-Series, TXP, and MXP) alarms. To retrieve all the NE alarms, issue all of the following commands:
RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-ENV
RTRV-ALM-SYNCNCategoryFault
SecurityRetrieve
Input FormatRTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<CONDITION>],
[<SRVEFF>][,,,];Input ExampleRTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA;
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.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDITION>
The type of alarm condition. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>],[<AIDDET>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,,,,:\"POWER FAIL RESTART\",DS1-14"
;Output Parameters
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
Building integrated timing supply (BITS) alarm
•
Client facility for multiplexer (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
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
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
•
XTC alarm (ONS 15327)
<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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
<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.10 RTRV-ALM-BITS
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input ExampleRTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Input Parameters
<AID>
Access identifier from the "BITS" section. Must not be null.
<NTFCNCDE>
Two-letter notification code. A null value is equivalent to ALL. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,,,,:\"LOSS OF SIGNAL\","
;Output Parameters
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
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
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
Two-letter notification code. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
<DESC>
(Optional) A condition description. DESC is a string.
21.11 RTRV-ALM-ENV
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Alarm Environment (RTRV-ALM-ENV) command retrieves the environmental alarms.
Usage Guidelines
None
CategoryEnvironment
SecurityRetrieve
Input FormatRTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input ExampleRTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
<AID>
Access identifier from the "ENV" section. Must not be null.
Note
<NTFCNCDE>
Two-letter notification code. A null value is equivalent to ALL. 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
•
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 FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,08-01,14-25-59,\"OPEN DOOR\""
;Output Parameters
<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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<ALMTYPE>
The alarm type for the environmental alarm. A null value is equivalent to ALL. 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.
OCRTM
(Optional) Time.
DESC
(Optional) A condition description. DESC is a string.
21.12 RTRV-ALM-EQPT
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategoryEquipment
SecurityRetrieve
Input FormatRTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input ExampleRTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;
Input Parameters
<AID>
Access identifier from the "EQPT" section. Must not be null.
<NTFCNCDE>
Two-letter notification code. A null value is equivalent to ALL. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,EQPT:MJ,HITEMP,NSA,08-01,14-25-59,,:\"HI TEMPERATURE\","
;Output Parameters
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
Two-letter notification code. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
<OCRTM>
(Optional) Time.
<DESC>
(Optional) A condition description. DESC is a string.
21.13 RTRV-ALM-SYNCN
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];Input ExampleRTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Input Parameters
<AID>
Access identifier from the "SYNC_REF" section. Must not be null.
<NTFCNCDE>
Two-letter notification code. A null value is equivalent to ALL. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,:[<DESC>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:CR,FAILTOSW,SA,08-01,
14-25-59,,:\"FAILURE TO SWITCH TO PROTECTION\","
;Output Parameters
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
Two-letter notification code. 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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. 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.
<OCRTM>
(Optional) Time.
<DESC>
(Optional) A condition description. DESC is a string.
21.14 RTRV-ALMTH-<MOD2>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA) The Retrieve Alarm Threshold for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, 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
CategoryFault
SecurityRetrieve
Input FormatRTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<CONDTYPE>][,,::];
Input ExampleRTRV-ALMTH-{MOD2}::CHAN-2-2:1::OPT-HIGH;
Input Parameters
<AID>
Access identifier from the "ALL" section. Must not be null.
<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 microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Receive power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. Measured value (-40.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. 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 FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>:<CONDTYPE>,,,<THLEVEL>";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,OCH:OPT-HIGH,,,20"
;Output Parameters
<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
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
1 Gbps ISC3 compatible
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
2 Gbps ISC3 compatible
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
D1 video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual Ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical Channel
•
OCH channel connection
•
OCH network connection
•
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 microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Receive power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. 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
<THLEVEL>
Threshold level. THLEVEL is a float.
21.15 RTRV-ALMTH-EQPT
(Cisco ONS 15454) The Retrieve Alarm Threshold Equipment (RTRV-ALMTH-EQPT) command retrieves the alarm thresholds for the power level monitoring on an NE.
Usage Guidelines
None
CategoryEquipment
SecurityRetrieve
Input FormatRTRV-ALMTH-EQPT:[<TID>]:[<AID>]:<CTAG>::[<CONDTYPE>][,,::];
Input ExampleRTRV-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. Must not be null
<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 microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Receive power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. 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 FormatSID DATE TIME
M CTAG COMPLD
"[<AID>],<MOD2B>:<CONDTYPE>,,,<DNFIELD>";
Output ExampleTID-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 first shelf of the node. Must not be null
<MOD2B>
Alarm type. The parameter type is MOD2B, which is the alarm type.
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<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 microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Receive power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. Measured value (-0.0 dBm, +30.0 dBm).
•
Transmit power in one tenth of a microW. 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.16 RTRV-ALS
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA) 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
CategoryPorts
SecurityRetrieve
Input FormatRTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-ALS:PENNGROVE:FAC-1-1:1
Input Parameters
<AID>
Access identifier from the "AidUnionId" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>],
[ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>]";
Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1,OC192::ALSMODE=DISABLED,ALSRCINT=100,ALSRCPW=2.0,LSRSTAT=ON:"
;Output Parameters
<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
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
1 Gbps ISC3 compatible
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
2 Gbps ISC3 compatible
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
D1 video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual Ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical Channel
•
OCH channel connection
•
OCH network connection
•
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.17 RTRV-APC
(Cisco ONS 15454) The Operate Amplification Power Control (RTRV-APC) command retrieves the APC application attributes.
Usage Guidelines
None
CategoryDWDM
SecurityMaintenance
Input FormatRTRV-APC:[<TID>]::<CTAG>;
Input ExampleRTRV-APC:PENNGROVE::114;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"::[APCENABLE=<APCENABLE>],[APCSTATE=<APCSTATE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"::APCENABLE=Y,APCSTATE=WORKING"
;Output Parameters
21.18 RTRV-ATTR-CONT
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategoryEnvironment
SecurityRetrieve
Input FormatRTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input ExampleRTRV-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. Must not be null.
<CONTTYPE>
Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Audible (ONS 15310-MA only)
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND"
;Output Parameters
AID
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. Must not be null.
CONTTYPE
Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Audible (ONS 15310-MA only)
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
21.19 RTRV-ATTR-ENV
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Attribute Environment (RTRV-ATTR-ENV) command retrieves the attributes associated with an environmental alarm.
Usage Guidelines
None
CategoryEnvironment
SecurityRetrieve
Input FormatRTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input ExampleRTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
<AID>
Access identifier from the "ENV" section. Must not be null.
<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 FormatSID DATE TIME
M CTAG COMPLD
"<AID>:[<NTFCNCDE>],[<ALMTYPE>],[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,\"OPEN DOOR\""
;Output Parameters
<AID>
Access identifier from the "ENV" section. Must not be null.
<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.20 RTRV-AUDIT-LOG
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategoryLog
SecurityRetrieve
Input FormatRTRV-AUDIT-LOG:[<TID>]::<CTAG>;
Input ExampleRTRV-AUDIT-LOG:::1;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
" <ENTRYNUM>,<OCRDAT>,<OCRTM>,<TASKID>,<TXSTATUS>,<DESCRIPTION>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
" 17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,
\17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,\"DESCRIPTION\""
;Output Parameters
21.21 RTRV-BFDLPM-<MOD2>
(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-INVSending 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.
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-BFDLPM-<MOD2>:[<TID>]:<AID>:<CTAG>:::REQTYPE=<REQTYPE>;
Input ExampleRTRV-BFDLPM-DS1:TID:DS1-14-1-1:123:::REQTYPE=ENH-24HR-ES;
Input Parameters
<AID>
Access identifier from the "DS1" section. Must not be null.
<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 FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<MONTYPE>,<MONVAL>,<BUCKET>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"DS1-14-1-1:ES,55,CURR-15MIN-INV"
;Output Parameters
<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.22 RTRV-BITS
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-BITS:SONOMA:BITS-1:782;
Input Parameters
<AID>
Access identifier from the "BITS" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],
[SYNCMSG=<SYNCMSG>],[AISTHRSHLD=<AISTHRSHLD>],[SABIT=<SABIT>],
[IMPEDANCE=<IMPEDANCE>],[BITSFAC=<BITSFAC>],[ADMSSM=<ADMSSM>]:[<PST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1::LINECDE=AMI,FMT=ESF,LBO=0-133,SYNCMSG=N,AISTHRSHLD=PRS,
SABIT=BYTE-4,IMPEDANCE=120-OHM,BITSFAC=T1,ADMSSM=PRS:IS"
;Output Parameters
<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.23 RTRV-BULKROLL-<OCN_TYPE>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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 27-1 for supported modifiers by platform.
CategoryBridge and Roll
SecurityProvisioning
Input FormatRTRV-BULKROLL-<OCN_TYPE>:[<TID>]:<SRC>:<CTAG>;
Input ExampleRTRV-BULKROLL-OC12:CISCO:FAC-3-1:1;
Input Parameters
<SRC>
Source AID from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],VLDSIG=<VLDSIG>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-3-1-1:RFROM=STS-3-1-1,RTO=STS-5-1-1,RMODE=AUTO,VLDSIG=Y"
;Output Parameters
<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.24 RTRV-CMD-SECU
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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
CategorySecurity
SecuritySuperuser
Input FormatRTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-CMD-SECU::INIT-REG:1;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<CAP>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"INIT-REG:MAINT"
;Output Parameters
21.25 RTRV-COND-<MOD2ALM>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Condition for 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS1, E100, E1000, E3, E4, EC1, FSTE, G1000, GFPOS, GIGE, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC12, VC3, VCG, VT1, VT2, or WLEN (RTRV-COND-<MOD2ALM>) command retrieves the current standing condition and state associated with an entity.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryFault
SecurityRetrieve
Input FormatRTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-T3:TID:FAC-2-1:229::LOS;
Input Parameters
<AID>
Access identifier from the "ALL" section. Must not be null.
<TYPEREQ>
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,T3:CR,LOS,SA,01-01,16-00-20,,,\"LOS OF SIGNAL\""
;Output Parameters
<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 alarm
•
1 Gigabit FICON alarm
•
1 Gbps ISC3 compatible
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
Client facility for MXP/TXP cards
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
Generic framing protocol over packet over SONET virtual port alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G payload
•
ISC3PEER2G payload
•
ISC3PEER2R payload
•
ISCCOMPAT payload
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
T1 alarm
•
T3 alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual Concatenation Group alarm
•
VT1 alarm
•
VT2 alarm
•
Wavelength Path Provisioning
<NTFCNCDE>
(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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
(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.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
<DESC>
(Optional) Condition description. DESC is a string.
21.26 RTRV-COND-ALL
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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-SYNCNCategoryFault
SecurityRetrieve
Input FormatRTRV-COND-ALL:[<TID>]:[<AID>]:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-ALL:TID:ALL:229::LOS;
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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,OC3:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;Output Parameters
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
(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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
(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.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
<DESC>
(Optional) Condition description. DESC is a string.
21.27 RTRV-COND-BITS
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Condition Building Integrated Timing Supply (RTRV-COND-BITS) command retrieves the standing conditions on BITS.
Usage Guidelines
None
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-COND-BITS:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-BITS:TID:BITS-1:229::LOS;
Input Parameters
<AID>
Access identifier from the "BITS" section. Must not be null.
<TYPEREQ>
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;Output Parameters
AID
Access identifier from the "BITS" 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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS2I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
(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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
(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.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
<DESC>
(Optional) Condition description. DESC is a string.
21.28 RTRV-COND-ENV
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Environmental Condition (RTRV-COND-ENV) command retrieves the environmental conditions.
Usage Guidelines
None
CategoryEnvironment
SecurityRetrieve
Input FormatRTRV-COND-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>][,,,];
Input ExampleRTRV-COND-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
<AID>
Access identifier from the "ENV" section. Must not be null.
Note
<NTFCNCDE>
Two-letter notification code. A null value is equivalent to ALL. 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 FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],,,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,01-01,16-02-15,,,,\"OPEN DOOR\""
;Output Parameters
<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>
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
<OCRDAT>
(Optional) Date when the specific event or violation occurred.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
<DESC>
(Optional) Condition description. DESC is a string.
21.29 RTRV-COND-EQPT
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Condition Equipment (RTRV-COND-EQPT) command retrieves the equipment conditions.
Usage Guidelines
None
CategoryEquipment
SecurityRetrieve
Input FormatRTRV-COND-EQPT:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-EQPT:TID:SLOT-1:229::LOS;
Input Parameters
<AID>
Access identifier from the "EQPT" section that has an alarm condition. Must not be null.
<TYPEREQ>
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1,EQPT:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;Output Parameters
<AID>
Access identifier from the "EQPT" section that has an alarm condition.
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
(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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
(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.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
<DESC>
(Optional) Condition description. DESC is a string.
21.30 RTRV-COND-SYNCN
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Condition Synchronization (RTRV-COND-SYNCN) command retrieves the synchronization condition.
Usage Guidelines
None
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-COND-SYNCN:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input ExampleRTRV-COND-SYNCN:TID:SYNC-NE:229::LOS;
Input Parameters
<AID>
Access identifier from the "SYNC_REF" section that has an alarm condition. Must not be null.
<TYPEREQ>
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:MJ,FRNGSYNC,SA,01-01,16-02-15,,,
\"FREE RUNNING SYNCHRONIZATION MODE\""
;Output Parameters
<AID>
Access identifier from the "SYN" section that has an alarm condition.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The value is always SYNCN. The parameter type is MOD2B, which is the alarm type.
•
1 Gigabit Fibre Channel alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<NTFCNCDE>
(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 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<SRVEFF>
(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.
<OCRTM>
(Optional) Time when the specific event or violation occurred.
<DESC>
(Optional) Condition description. DESC is a string.
21.31 RTRV-CONSOLE-PORT
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA) The Retrieve Console Port (RTRV-CONSOLE-PORT) command retrieves the status of the console port from the ML-Series cards.
Usage Guidelines
None
CategorySecurity
SecurityRetrieve
Input FormatRTRV-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-CONSOLE-PORT:CISCONODE:SLOT-2:123;
Input Parameters
<AID>
Access identifier from the "EQPT" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<EQPT>:[PORT=<PORT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2:PORT=ENABLED"
;Output Parameters
21.32 RTRV-CRS
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Cross-Connect (RTRV-CRS) command retrieves all the cross-connections based on the required PATH types.
Usage Guidelines
•
•
•
•
•
•
CategoryCross Connections
SecurityRetrieve
Input FormatRTRV-CRS:[<TID>]:[<AID>]:<CTAG>:::[CRSTYPE=<CRSTYPE>][:];
Input ExampleRTRV-CRS:CISCO:ALL:123:::CRSTYPE=STS;
Input Parameters
<AID>
Access identifier from the "CrossConnectId1" section that can be facility, STS, VT, or ALL. The ALL AID defaults to NE, which means it reports all the existing cross-connections on the NE. A null value is equivalent to ALL.
<CRSTYPE>
The cross-connection type. Defaults to all existing cross-connections. A null value is equivalent to ALL. 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)
•
Virtual Tributary 1 (SONET). Virtual Channel 11 (SDH).
•
Virtual Tributary 2 (SONET). Virtual Channel 12 (SDH).
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<CCT>,<CRSTYPE>:[DRITYPE=<DRITYPE>],[DRINODE=<SYNCSW>],
[CKTID=<CKTID>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-5-1-2&STS-6-1-2,STS-12-1-2&STS-13-1-2:1WAYDC,STS1:DRITYPE=BLSR,
DRINODE=PRI,CKTID=CKTID:OOS-AU,AINS"
;Output Parameters
<SRC>
Source access identifier from the "CrossConnectId" section. Indicates the source AID(s) of the cross-connection. SRC is listable.
<DST>
Destination AID of the cross-connection from the "CrossConnectId" section. DST is listable.
<CCT>
Type of connection. Used for specifying one or two-way connections. The parameter type is CCT, which is the type of cross-connect to be created.
•
A unidirectional connection from a source tributary to a destination tributary
•
Path protection multicast drop with (1-way) continue
•
Path protection multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A bidirectional drop and continue connection applicable only to path protection traditional and integrated DRIs
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (BLSR PCA diagnostics cross-connect).
<CRSTYPE>
The cross-connection type. The parameter type is CRS_TYPE, which is the cross-connection type.
•
Indicates all the STS cross-connections
•
STS1 cross-connect
•
STS3c cross-connect
•
STS6c cross-connect
•
STS9c cross-connect
•
STS12c cross-connect
•
STS18c cross-connect
•
STS24c cross-connect
•
STS36c cross-connect
•
STS48c cross-connect
•
STS192c cross-connect
•
Indicates all the VT1 cross-connections
•
VT1 cross-connect
•
VT2 cross-connect
<DRITYPE>
(Optional) The DRI connection type. It is applied only if the cross-connection is a drop-and-continue connection type (1WAYDC or 2WAYDC), and defaults to path protection for the DRI configuration. The parameter type is DRITYPE (DRI type).
•
BLSR DRI type
•
Path protection DRI type
•
Path protection-BLSR hand-off DRI type
<SYNCSW>
(Optional) Synchronization switch AID from the "SYNCSW" section.
<CKTID>
(Optional) Circuit identification parameter that contains a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. CKTID is a string.
<PST_PSTQ>
Primary state and primary state qualifier separated by a colon. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ).
•
In Service and Normal
•
Out of Service and Autonomous
•
Out of Service and Autonomous Management
•
Out of Service and Management
<SSTQ>
(Optional) One or more secondary states separated by "&", in alphabetical order. 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.33 RTRV-CRS-<PATH>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Cross-Connect for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RTRV-CRS-<PATH>) command retrieves any connections associated with the entered AID(s) or AID range. The information on both ends is returned along with the type of connection.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
Note
–
from points: F1, F2
to points: T1
the output will be:
1-way
"F1&F2,T1:CCT,STS3C"
2-way
If retrieved on point F1 or F2, the output format is the same as the 1-way output.
If retrieved on point T1, the output will be:
"T1,F1&F2:CCT,STS3C"
–
from point: F1
to points: T1, T2
the output will be:
1-way
"F1,T1&T2:CCT,STS3C"
2-way
"T1&T2,F1:CCT,STS3C"
–
from point: F1, F2
to points: T1, T2
the output will be:
1-way:
"F1&F2,T1&T2:CCT,STS3C"
2-way:
If retrieved on point F1 or F2, the output format is the same as the 1-way output.
If retrieved on point T1 or T2, the output will be:
"T1&T2,F1&F2:CCT,STS3C"
–
ENT-CRS-<PATH>::F1&F2,S1&S2:<CTAG>::2WAY;
from points: F1, F2 (F1 is the working side, F2 is the protect side)
selector: S1, S2 (S1 is the working side, S2 is the protect side)
the output will be:
If retrieved on point F1 or F2, the output will be:
"F1&F2,S1&S2:CCT,STS3C"
If retrieved on selector S1 or S2, the output will be:
"S1&S2,F1&F2:CCT,STS3C"
–
from points: F1, F2
to points: T1, T2
the output will be:
"F1&F2,T1&T2:CCT,STS3C"
–
from points: F1, F2
to points: T1
the output will be:
"F1&F2,T1:CCT,STS3C"
•
•
•
•
•
•
•
CategoryCross Connections
SecurityRetrieve
Input FormatRTRV-CRS-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-CRS-STS3C:KENWOOD:STS-6-1-1:223;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId1" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<CCT>,<MOD>:[DRITYPE=<DRITYPE>],[DRINODE=<SYNCSW>],
[CKTID=<CKTID>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-5-1-2&STS-6-1-2,STS-12-1-2&STS-13-1-2:1WAYDC,STS1:DRITYPE=BLSR,
DRINODE=PRI,CKTID=CKTID:OOS-AU,AINS"
;Output Parameters
<SRC>
Source access identifier from the "CrossConnectId" section. Indicates the source AID(s) of the cross-connection. SRC is listable.
<DST>
Destination AID of the cross-connection from the "CrossConnectId" section. DST is listable.
<CCT>
Type of connection. Used for specifying one or two-way connections. The parameter type is CCT, which is the type of cross-connect to be created.
•
A unidirectional connection from a source tributary to a destination tributary
•
Path protection multicast drop with (1-way) continue
•
Path protection multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A bidirectional drop and continue connection applicable only to path protection traditional and integrated dual-ring interconnects
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (BLSR PCA diagnostics cross-connect)
<MOD>
The connection path bandwidth. The parameter type is MOD2, which is the line/path modifier.
•
10 Gigabit Fibre Channel
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3c path
•
STS6c path
•
STS9c path
•
STS18c path
•
STS12c path
•
STS24c path
•
STS36c path
•
STS48c path
•
STS192c path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 path
•
VT2 path
<DRITYPE>
(Optional) The DRI connection type. It is applied only if the cross-connection is a drop-and-continue connection type (1WAYDC or 2WAYDC), and defaults to path protection for the DRI configuration. The parameter type is DRITYPE (DRI type).
•
BLSR DRI type
•
Path protection DRI type
•
UPSR-BLSR hand-off DRI type
<SYNCSW>
(Optional) Synchronization switch AID from the "SYNCSW" section.
<CKTID>
(Optional) A string of ASCII characters. Maximum length is 48. CKTID is a string.
<PST_PSTQ>
Primary state and primary state qualifier separated by a colon. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ).
•
In Service and Normal
•
Out of Service and Autonomous
•
Out of Service and Autonomous Management
•
Out of Service and Management
<SSTQ>
(Optional) One or more secondary states separated by "&", in alphabetical order. 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.34 RTRV-DFLT-SECU
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Default Security (RTRV-DFLT-SECU) command retrieves the system-wide default values associated with several security parameters.
Usage Guidelines
None
CategorySecurity
SecuritySuperuser
Input FormatRTRV-DFLT-SECU:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-DFLT-SECU:CISCO:ALL:123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<NE>:PAGE=<PAGE>,PCND=<PCND>,MXINV=<MXINV>,DURAL=<DURAL>,
TMOUT=<TMOUT>,UOUT=<UOUT>,PFRCD=<PFRCD>,POLD=<POLD>,PINT=<PINT>,
LOGIN=<LOGIN>,PRIVLVL=<PRIVLVL>],[PDIF=<PDIF>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"TCC2:PAGE=40,PCND=5,MXINV=5,DURAL=30,TMOUT=0,UOUT=60,PFRCD=NO,
POLD=5,PINT=20,LOGIN=MULTIPLE,PRIVLVL=RTRV,PDIF=1"
;Output Parameters
21.35 RTRV-DS1
(Cisco ONS 15454) The Retrieve DS1 (RTRV-DS1) command retrieves the test access attributes on a DS1 layer of a DS3XM card.
Usage Guidelines
•
•
•
•
•
CategoryPorts
SecurityRetrieve
Input FormatRTRV-DS1:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-DS1:PETALUMA:DS1-2-1-6-12:123;
Input Parameters
<SRC>
The DS1 path access identifier of the DS3XM card from the "DS1" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<DS1AID>::[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[AISONLPBK=<AISONLPBK>],
[MODE=<MODE>],[FMT=<FMT>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"DS1-2-1-12::TACC=8,TAPTYPE=SINGLE,AISONLPBK=OFF,MODE=FDL,FMT=ESF"
;Output Parameters
<DS1AID>
(Optional) DS1 access identifier from the "DS1" section.
<TACC>
(Optional) Indicates whether the digroup being provisioned is to be used as a test access digroup. Default is N. TACC is an integer.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<AISONLPBK>
(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates if an 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.
<MODE>
(Optional) Mode. The parameter type is DS1MODE, which is the DS1 path mode of the DS3XM-12 card
•
Indicates the DS1 path of the DS3XM-12 is in AT&T 54016 mode.
•
Indicates the DS1 path of the DS3XM-12 is in FDL T1-403 mode.
<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.
21.36 RTRV-EC1
(Cisco ONS 15454, ONS 15310-MA) The Retrieve Electrical Carrier (RTRV-EC1) command retrieves the facility status of an EC1 card.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-EC1:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-EC1:CISCO:FAC-1-1:1234;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[PJMON=<PJMON>],[LBO=<LBO>],[RXEQUAL=<RXEQUAL>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>],[SFBER=<SFBER>],[SDBER=<SDBER>],[NAME=<NAME>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>],[AISONLPBK=<AISONLPBK>]:<PSTPSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::PJMON=0,LBO=0-225,RXEQUAL=Y,SOAK=52,SOAKLEFT=12-25,SFBER=1E-4,
SDBER=1E-7,NAME=\"EC1 PORT\",EXPTRC="AAA",TRC="AAA",TRCMODE=MAN,
TRCFORMAT=16-BYTE,AISONLPBK=AIS_ON_LPBK_ALL:IS-NR,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<PJMON>
(Optional) A SONET pointer monitor attribute of an EC1 port. PJMON is an integer.
<LBO>
(Optional) Line buildout settings. LBO is an integer. The parameter type is E_LBO, which is the electrical signal line buildout.
•
Electrical signal line buildout range is 0-225.
•
Electrical signal line buildout range is 226-450.
<RXEQUAL>
(Optional) Parameter type is EXT_RING, 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.
<SOAK>
IS-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:
•
•
•
<SFBER>
(Optional) Signal failure threshold. The default value is 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) Signal degrade threshold. 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.
<NAME>
(Optional) NAME is a string.
<EXPTRC>
(Optional) EXPTRC is a string.
<TRC>
(Optional) TRC is a string.
<TRCMODE>
(Optional) Trace mode. The parameter type is TRCMODE.
•
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 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.
<AISONLPBK>
(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates if an AIS is sent on a loopback.
•
AIS is sent on facility loopbacks.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopbacks.
•
AIS is sent on terminal loopbacks.
<PST_PSTQ>
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (SST) and a primary state qualifier (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.37 RTRV-EQPT
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Equipment (RTRV-EQPT) command retrieves the data parameters and state parameters associated with an equipment unit.
The RTRV-EQPT command also retrieves shelf parameters.
Usage Guidelines
This command returns the PRTYPE, PROTID, RVTM, and RVRTV parameters for a card inside of a protection group according to the following scenarios:
•
•
•
•
•
•
•
•
Error conditions:
•
CategoryEquipment
SecurityRetrieve
Input FormatRTRV-EQPT:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-EQPT:MIRABEL:SLOT-12:230;
Input Parameters
<AID>
Access identifier from the "EQPT" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<AIDTYPE>,<EQUIP>,[<ROLE>],[<STATUS>]:[PROTID=<PROTID>],
[PRTYPE=<PRTYPE>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],
[CARDNAME=<CARDNAME>],[IOSCFG=<IOSCFG>],[CARDMODE=<CARDMODE>],
[PEERID=<PEERID>],[REGENNAME=<REGENNAME>,][TRANSMODE=<TRANSMODE>],
[RETIME=<RETIME>],[SHELFROLE=<SHELFROLE>]:[<PST_PSTQ>],[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-12:DS1,EQUIP,,ACT:PROTID=SLOT-13,PRTYPE=1-1,RVRTV=Y,RVTM=8.5,
CARDNAME=DESCRIPTION,IOSCFG="IOS CONFIG INFO FOR ML SERIES CARD",
CARDMODE=DS3XM12-STS48,PEERID=SLOT-1,REGENNAME="THIS GROUP",
TRANSMODE=SONET,RETIME=Y,SHELFROLE=NC:OOS-AU,AINS&UEQ"
;Output Parameters
<AID>
Access identifier from the "EQPT" section.
<AIDTYPE>
The type of facility, link, or other addressable entity targeted by the message. The parameter type is EQUIPMENT_TYPE (equipment type).
•
(ONS 15454) 10DME-C card
•
(ONS 15454) 10DME-L card
•
(ONS 15454) 32 channel demultiplexer
•
(ONS 15454) 32 channel demultiplexer unit for L-band
•
(ONS 15454) 32 channel unidirectional optical demultiplexer
•
(ONS 15454) 32 channel unidirectional optical multiplexer
•
(ONS 15454) 32 channel optical wavelength selective switch
•
(ONS 15454) 32 channel wavelength switch selector unit for L-band
•
(ONS 15454) Optical multiplexer/demultiplexer with 4 channels
•
(ONS 15454) Optical add/drop multiplexed (OADM) 1 band filter
•
(ONS 15454) Optical add/drop multiplexed (OADM) 1 channel filter
•
(ONS 15454) Optical add/drop multiplexed (OADM) 2 channel filter
•
(ONS 15454) Optical add/drop multiplexed (OADM) 4 band filter
•
(ONS 15454) Optical add/drop multiplexed (OADM) 4 channel filter
•
(ONS 15454) AIC-I card
•
(ONS 15600) Any service any port carrier card with 4 PIM slots
•
(ONS 15454) CE-1000-4 card
•
(ONS 15454, ONS 15310-CL, ONS 15310-MA) Eight port 100T card
•
(ONS 15310-MA) CTX2500 card
•
(ONS 15454) DS1 card
•
(ONS 15310-MA) DS1-28/DS3-EC1-3 card
•
(ONS 15310-MA) DS1-84/DS3-3 card
•
(ONS 15454) DS1/E1-56 card
•
(ONS 15454) DS1N card
•
(ONS 15454) DS3 card
•
(ONS 15454) DS3/EC1-48 card
•
(ONS 15454) DS3i-N-12 card
•
(ONS 15454) DS3N card
•
(ONS 15454) DS3NE card
•
(ONS 15454) DS3XM-6 card
•
(ONS 15454) DS3XM-12 card
•
(ONS 15454) E1000-2 card
•
(ONS 15454) E1000-2-G card
•
(ONS 15454) E100T card
•
(ONS 15454) EC1 card
•
(ONS 15454) FC_MR-4 card
•
Blank Filler card
•
(ONS 15327) Two port G1000 card
•
(ONS 15454) Four port G1000 card
•
(ONS 15327) MIC A card
•
(ONS 15327) MIC B card
•
(ONS 15310-CL, ONS 15310-MA) Mapper card
•
(ONS 15454) ML-Series two port gigabit Ethernet card
•
(ONS 15454) ML-Series 12 port FSTE card
•
(ONS 15454) Eight port 100T card with optical interface
•
(ONS 15454) Multiring/mesh upgrade unit
•
(ONS 15454) 12 port multirate optical card
•
(ONS 15454) 2.5-Gbps-10-Gbps Muxponder-100 GHz-Tunable xx.xx-xx.xx card
•
(ONS 15454) 2.5-Gbps-10-Gbps Muxponder-100 GHz-Tunable xx.xx-xx.xx card for L-band
•
(ONS 15454) 2.5-Gbps-10-Gbps Muxponder-100 GHz-Tunable xx.xx-xx.xx card for C-band
•
(ONS 15454) 2.5-Gbps-10-Gbps muxponder-100 GHz-tunable xx.xx-xx.xx card
•
(ONS 15454) 2.5-Gbps multirate muxponder-100 GHz-tunable 15xx.xx-15yy.yy card
•
(ONS 15454) 2.5-Gbps-10-Gbps muxponder-protected-100 GHz-tunable xx.xx-xx.xx card
•
(ONS 15454) 2.5-Gbps multirate muxponder-protected-100 GHz-tunable 15xx.xx-15yy.yy card
•
(ONS 15454, ONS 15327) OC-3 card
•
(ONS 15454) Eight port OC-3 card
•
(ONS 15454, ONS 15327) OC-12 card
•
(ONS 15454) Four port OC-12 card
•
(ONS 15454, ONS 15327, ONS 15600) OC-48 card
•
(ONS 15454) 16 port OC-48 card
•
(ONS 15454, ONS 15600) OC-192 card
•
(ONS 15454) Four port OC-192 card
•
(ONS 15454) One port OC-192 XFP
•
(ONS 15454) Optical preamplifier unit for L-Band
•
(ONS 15454) Optical booster amplifier
•
(ONS 15454) Optical booster unit for L-Band
•
(ONS 15454) Optical preamplifier
•
(ONS 15454) Optical service channel (OSC) with combiner/separator Module (SCM)
•
(ONS 15454) Optical service channel module
•
(ONS 15600) One port pluggable interface module
•
(ONS 15600) Four port pluggable interface module
•
(ONS 15454, ONS 15600, ONS 15310-CL, ONS 15310-MA) Pluggable port module with one SFP port
•
Shelf entity
•
(ONS 15600) Cross-connect card
•
(ONS 15454) TCC card
•
(ONS 15454) 10-Gbps multirate transponder-100-GHz-tunable xx.xx-xx.xx card
•
(ONS 15454) 10-Gbps multirate transponder-100-GHz-tunable xx.xx-xx.xx card for C-band
•
(ONS 15454) 10-Gbps multirate transponder-100-GHz-tunable xx.xx-xx.xx card for L-band
•
(ONS 15454) 10-Gbps multirate transponder-100-GHz-tunable xx.xx-xx.xx card
•
(ONS 15454) 2.5-Gbps multirate transponder-100-GHz-tunable xx.xx-xx.xx card
•
(ONS 15454) 2.5-Gbps multirate transponder-protected-100-GHz-tunable xx.xx-xx.xx card
•
Unknown equipment type
•
Unprovisioned type
•
(ONS 15454) XC10G card
•
(ONS 15454) XCVT card
•
(ONS 15454) XC-VXC-10G card
•
(ONS 15327) XTC card
<EQUIP>
Indicates if the equipment is physically present. The parameter type is EQUIP, which is the presence of a plug-in unit.
•
The unit is equipped—present.
•
The unit is unequipped—absent.
<ROLE>
(Optional) Indicates if the card is a working unit or the protecting unit. 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) Indicates a status. SONET card status is shown on its card level. The parameter type is STATUS.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit on the shelf.
<PROTID>
(Optional) Protecting identifier AID from the "PRSLOT" section.
<PRTYPE>
(Optional) Protection type. The parameter type is PROTECTION_GROUP, which is the protection group type.
•
1 to 1 protection
•
1 to N protection
<RVRTV>
(Optional) Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<CARDNAME>
(Optional) The card name of the card, PIM, or PPM equipment. CARDNAME is a string.
<IOSCFG>
(Optional) Displays the information about the startup Cisco IOS configuration file for the ML-Series cards. An example of this field is "TL1,11.22.33.44//DIR/IOS.CONF,2002/1/1 9:1:1 EST". The following information is included in this field:
•
•
•
This field only applies to ML-Series cards. IOSCFG is a string.
<CARDMODE>
(Optional) Card mode. The parameter type is CARDMODE, which is the card mode. Card mode is applicable to cards that have multiple capabilities, for example, the ML-Series card can operate in two distinct modes: Linear Mapper Mode and L2/L3 Mode.
•
The optical amplifier is working as an optical booster
•
The optical amplifier is working as an optical pre-amplifier
•
The DS3XM-12 card in the STS12 backplane rate mode
•
The DS3XM-12 card in the STS48 backplane rate mode
•
Line terminating mode
•
Section terminating mode
•
Transparent mode AIS
•
Transparent mode SQUELCH
•
FC_MR-4 card with distance extension support
•
FC_MR-4 card without distance extension support
•
ML-Series card in DOS field-programmable gate array (FPGA) using generic framing procedure (GFP) framing type
•
ML-Series card in DOS FPGA using high-level data link control (HDLC) framing type
•
4 Gbps Fibre Channel/FICON mode for the Cisco ONS 15454 10DME-C/10DME-L card supported on ports one and five
•
4 Gbps Fibre Channel/FICON supported on port one and Fibre Channel, GIGE and ISC modes for the Cisco ONS 15454 10DME-C/10DME-L card supported on ports five to eight
•
Fibre Channel, GIGE and ISC modes for the Cisco ONS 15454 10DME-C/10DME-L card supported on all eight ports
•
Fibre Channel, GIGE and ISC modes for the Cisco ONS 15454 10DME-C/10DME-L card supported on ports one to four and 4 Gbps Fibre Channel/FICON supported on port five
•
ESCON mode for the Cisco ONS 15454 MXP_2.5G_10G card
•
Fibre channel or GIGE mode for the MXP_2.5G_10G card
•
Mixed Fibre Channel, GIGE and ESCON modes for the Cisco ONS 15454 MXP_2.5G_10G card
<PEERID>
(Optional) The regeneration group peer slot identifier from the "EQPT" section.
<REGENNAME>
(Optional) Name of a regeneration group. REGENNAME is a string.
<TRANSMODE>
(Optional) Transport mode. Applicable only to the DS1/E1-56 card on ONS 15454. Defaults to SONET. The parameter type is TRANSMODE (transition mode).
•
AU3 mode
•
AU4 mode
•
SONET mode
<RETIME>
(Optional) Indicates the retime function for all the ports on this card. Applicable only to the DS1/E1-56 card on the ONS 15454. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SHELFROLE>
The role of the shelf in the context of the node. When it is omitted it defaults to SC. The parameter is SHELF_ROLE.
•
The shelf behaves as a node controller.
•
The shelf behaves as a shelf controller.
<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 primary state (SST) and a primary state qualifier (PSTQ).
•
In Service and Normal
•
Out of Service and Autonomous
•
Out of Service and Autonomous Management
•
Out of Service and Management
<SSTQ>
Secondary state of the entity. Listable. 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.38 RTRV-ESCON
(Cisco ONS 15454) The Retrieve Enterprise System Connection (RTRV-ESCON) command retrieves the Fibre Channel-specific settings for ports that have been configured to carry ESCON traffic using the ENT-ESCON command.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-ESCON:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-ESCON::CISCO:FAC-1-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[ENCAP=<ENCAP>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:ENCAP=GFP-T"
;Output Parameters
<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.
<ENCAP>
(Optional) Encapsulation frame 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
21.39 RTRV-EXT-CONT
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve External Control (RTRV-EXT-CONT) command retrieves the control state of an external control. The command can be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT command.
Usage Guidelines
•
•
CategoryEnvironment
SecurityRetrieve
Input FormatRTRV-EXT-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input ExampleRTRV-EXT-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Input Parameters
<AID>
Access identifier from the "ENV" section. The only valid AID for RTRV-EXT-CONT is ENV-OUT-{1-2}. Must not be null.
<CONTTYPE>
Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Audible (ONS 15310-MA only)
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>],<DUR>,[<CONTSTATE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND,CONTS,OPEN"
;Output Parameters
<AID>
Access identifier from the "ENV" section. Identifies the external control for which the control state is being retrieved.
<CONTTYPE>
(Optional) Environmental control type. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Audible (ONS 15310-MA only)
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
<DUR>
Duration of operation. The duration for which the external control can be operated. The parameter type is Duration.
•
Continuous duration
<CONTSTATE>
(Optional) Control state of the external control. The parameter type is CONT_MODE, which is the current state of the environmental control.
•
Not applicable (for example, duration is MNTRY).
•
The environmental control state is CLOSE.
•
The environmental control state is OPEN.
21.40 RTRV-FAC
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Facility (RTRV-FAC) command retrieves the payload type of the facility. It can also dump all the facilities on a given card and is applicable to all cards.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-FAC:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-FAC:CISCO:FAC-2-9:2223;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>::PAYLOAD=<PAYLOAD>:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-9::PAYLOAD=E4-FRAMED:OOS-AU,AINS"
;Output Parameters
<SRC>
Source access identifier from the "FACILITY" section.
<PAYLOAD>
(Optional) Payload type of the facility. The parameter type is PAYLOAD, which identifies payload type.
•
10 Gigabit Ethernet Fibre Channel mode
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel mode
•
1 Gigabit FICON mode
•
2 Gigabit Fibre Channel mode
•
2 Gigabit FICON mode
•
DS3 mode
•
Video mode
•
EC1 mode
•
ESCON mode
•
ETR_CLO payload mode
•
Gigabit Ethernet Payload
•
HDTV mode
•
ISC1 Mode
•
ISC3 Mode
•
SONET OC12 mode
•
SONET OC3 mode
•
SONET OC48 mode
•
Pass through mode
•
SDI-D1-Video mode
•
SONET Payload Mode
<PST_PSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (SST) and a primary state qualifier (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. SSTQ is a string.
21.41 RTRV-FFP
(Cisco ONS 15454) The Retrieve Facility Protection Group (RTRV-FFP) command retrieves all optical 1+1 protection groups.
Usage Guidelines
None
CategoryProtection
SecurityRetrieve
Input FormatRTRV-FFP:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-FFP:HERNDON:FAC-1-1:1;
Input Parameters
AID
Optical facility access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>:<LEVEL>:[PROTID=<PROTID>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>],
[DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1:OC48:PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,PSDIRN=BI,
VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;Output Parameters
<WORK>
The working port access identifier from the "FACILITY" section.
<PROTECT>
The protected port access identifier from the "FACILITY" section.
<PROTTYPE>
(Optional) Protection group type. PROTTYPE is a string.
<LEVEL>
Optical rate the protection group was defined against. The parameter type is OCN_TYPE, which is the modifier used to differentiate various levels of OC-N.
•
Optical Carrier level 12 (622 Mbps)
•
Optical Carrier level 192 (10 Gbps)
•
Optical Carrier level 3 (155 Mbps)
•
Optical Carrier level 48 (2.4 Gbps)
<PROTID>
(Optional) Protection group name. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
<VRGRDTM>
(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
•
500 ms
•
1 second
<DTGRDTM>
(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
<RCGRDTM>
(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
<OPOTYPE>
(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
•
Optimized 1+1
•
Standard 1+1
21.42 RTRV-FFP-<MOD2DWDMPAYLOAD>
(Cisco ONS 15454) The Retrieve Facility Protection Group for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RTRV-FP-<MOD2DWDMPAYLOAD>) command retrieves Y-cable protection on client facilities.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-FFP-<MOD2DWDMPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-FFP-HDTV:CISCO:FAC-1-1-1:100;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDUNIONID1>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1,FAC-2-1-1::PROTTYPE=Y-CABLE,PROTID=\"DC-METRO\",
RVRTV=N,RVTM=1.0,PSDIRN=BI"
;Output Parameters
<AIDUNIONID>
Access identifier from the "FACILITY" section.
<AIDUNIONID1>
Access identifier from the "FACILITY" section.
<PROTTYPE>
(Optional) The type of facility protection. The parameter type is PROTTYPE, which is the protection type for DWDM client facilities.
•
Y-cable protection for the client ports on TXP_MR_10G, MXP_2.5G_10G, TXP_MR_2.5G, and TXPP_MR_2.5G cards.
<PROTID>
(Optional) Y-cable protection group identifier. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
21.43 RTRV-FFP-<OCN_TYPE>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Facility Protection Group for OC3, OC12, OC48, or OC192 (RTRV-FFP-<OCN_TYPE>) command retrieves the optical facility protection information.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
Note
Note
CategoryProtection
SecurityRetrieve
Input FormatRTRV-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-FFP-OC3:PETALUMA:OC3-1-1:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>],
[DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1::PROTTYPE=Y-CABLE,PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,
PSDIRN=BI,VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;Output Parameters
<WORK>
Access identifier from the "FACILITY" section. Identifies the working port.
<PROTECT>
Access identifier from the "FACILITY" section. Identifies the protection port.
<PROTTYPE>
(Optional) Protection group type. Applicable only to DWDM cards. The parameter type is PROTTYPE, which is the protection type for DWDM client facilities.
•
Y-cable protection for the client ports on TXP_MR_10G, MXP_2.5G_10G, TXP_MR_2.5G, and TXPP_MR_2.5G cards.
<PROTID>
(Optional) Free-form text string name given to the 1+1 protection group. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
<VRGRDTM>
(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
•
500 ms
•
1 second
<DTGRDTM>
(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
<RCGRDTM>
(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
<OPOTYPE>
(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
•
Optimized 1+1
•
Standard 1+1
21.44 RTRV-FFP-OCH
(Cisco ONS 15454) The Retrieve Facility Protection Group Optical Channel (RTRV-FFP-OCH) command retrieves the protection group information for the TXP_MR_2.5G and TXPP_MR_2.5G card trunk port.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-FFP-OCH:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-FFP-OCH:VA454-22:CHAN-2-2:100;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>,[,PSDIRN=<PSDIRN>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,CHAN-2-3::PROTTYPE=SPLITTER,PROTID=\"TRUNK PROT\",RVRTV=Y,
RVTM=1.0,PSDIRN=UNI"
;Output Parameters
<WORK>
The working port access identifier from the "CHANNEL" section.
<PROTECT>
The protected port access identifier from the "CHANNEL" section.
<PROTTYPE>
(Optional) Protection group type. PROTTYPE is a string.
<PROTID>
(Optional) Protection group name. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
21.45 RTRV-FSTE
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA) The Retrieve Fast Ethernet (RTRV-FSTE) command retrieves the front-end port information of a Fast Ethernet (10/100 Mbps) card. MTU is not displayed for the ML-100T-8 and CE-100T-8 cards. RTRV-POS will display the MTU that is common for both front-end and back-end ports.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-FSTE:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-FSTE:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[ADMINSTATE=<ADMINSTATE>],[LINKSTATE=<LINKSTATE>],[MTU=<MTU>],
[FLOWCTRL=<FLOWCTRL>],[DUPLEX=<DUPLEX>],[SPEED=<SPEED>],[FLOW=<FLOW>],
[EXPDUPLEX=<EXPDUPLEX>],[EXPSPEED=<EXPSPEED>],[VLANCOS=<VLANCOS>],
[IPTOS=<IPTOS>],[OPTICS=<OPTICS>],[NAME=<NAME>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,
FLOWCTRL=SYMMETRIC,DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,
EXPDUPLEX=EXPDUPLEX,EXPSPEED=EXPSPEED,VLANCOS=VLANCOS,
IPTOS=IPTOS,OPTICS=1000-BASE-LX,NAME=\"FSTEPORT\",SOAK=32,
SOAKLEFT=\"12-25\":OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<ADMINSTATE>
(Optional) Administration type. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<LINKSTATE>
(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<MTU>
(Optional) Maximum transmission unit. MTU is an integer.
<FLOWCTRL>
(Optional) Flow control. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Passthrough flow control
•
Symmetric flow control
<DUPLEX>
(Optional) Duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<SPEED>
(Optional) Speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
Auto
<FLOW
(Optional) Flow. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<EXPDUPLEX>
(Optional) Ethernet duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<EXPSPEED>
(Optional) Ethernet speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
Auto
<VLANCOS>
(Optional) Priority queing threshold based on VLAN class of service of incoming Ethernet packets. VLANCOS is an integer.
<IPTOS>
(Optional) Priority queing threshold based on IP type of service of incoming Ethernet packets. IPTOS is an integer.
<OPTICS>
(Optional) GBIC type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000 Base CX
•
1000 Base LX
•
1000 Base SX
•
1000 Base ZX
•
100 Base FX
•
100 Base LX
•
Coarse wavelength division multiplexing (CWDM) 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown
<NAME>
(Optional) 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:
•
•
•
<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 primary state (SST) and a primary state qualifier (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. 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.46 RTRV-G1000
(Cisco ONS 15454) The Retrieve G1000 Facility (RTRV-G1000) command retrieves the G1000 facilities configuration.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-G1000:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-G1000:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[MFS=<MFS>],[FLOW=<FLOW>],[LAN=<LAN>],[OPTICS=<OPTICS>],
[TRANS=<TRANS>],[TPORT=<TPORT>],[LOWMRK=<LOWMRK>],
[HIWMRK=<HIWMRK>],[AUTONEG=<AUTONEG>],[ENCAP=<ENCAP>],
[NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::MFS=9032,FLOW=N,LAN=ASYMMETRIC,OPTICS=UNKNOWN,TRANS=NONE,
TPORT=FAC-5-1,LOWMRK=20,HIWMRK=492,AUTONEG=Y,ENCAP=GFP_T,
NAME=\"G1000 PORT\",SOAK=32,SOAKLEFT=\"12-25\":OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<MFS>
Maximum frame size. The parameter type is MFS_TYPE, which is the maximum frame size used by an Ethernet card.
•
Normal frame size
•
Jumbo frame size
<FLOW>
Flow control. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<LAN>
(Optional) Local-area network. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Passthrough flow control
•
Symmetric flow control
<OPTICS>
(Optional) GBIC type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000 Base CX
•
1000 Base LX
•
1000 Base SX
•
1000 Base ZX
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
<TRANS>
(Optional) Transponder mode. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
<TPORT>
(Optional) Transponding port access identifier from the "FACILITY" section.
<LOWMRK>
(Optional) Low watermark value. LOWMRK is an integer.
<HIWMRK>
(Optional) High watermark value. HIWMRK is an integer.
<AUTONEG>
(Optional) Automatic negotiation. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<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) 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:
•
•
•
<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 primary state (SST) and a primary state qualifier (PSTQ).
•
In Service and Normal
•
Out of Service and Autonomous
•
Out of Service and Autonomous Management
•
Out of Service and Management
<SSTQ>
Secondary state. 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.47 RTRV-GFP
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Generic Framing Protocol (RTRV-GFP) command retrieves GFP information for the ONS 15454 CE-100T-8 and CE-1000-4 cards, the ONS 15454 FC_MR-4 card, and the ONS 15310-CL CE-100T-8 card.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-GFP:[<TID>]:<SRC>:<CTAG>;
Input ExampleRTRV-GFP:CISCO:FAC-1-1:123;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. Must not be null.
Note
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[FCS=<FCS>],[AUTOTHGFPBUF=<AUTOTHGFPBUF>],
[GFPBUF=<GFPBUF>],[FILTER=<FILTER>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::FCS=FCS-32,AUTOTHGFPBUF=Y,GFPBUF=16,FILTER=EGRESS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<FCS>
(Optional) Payload frame check sequence. The parameter type is FCS, which is the frame check sequence.
•
Frame check sequencing using 16 bits
•
Frame check sequencing using 32 bits
•
No frame check sequence
<AUTOTHGFPBUF>
(Optional) Flag used to indicate whether PDI-P should be generated on the outgoing VT-structured STSs. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<GFPBUF>
(Optional) GFPBUF is an integer.
<FILTER>
(Optional) Parameter type is GFP_FILTER, which is the filter.
•
Activate filter on egress port.
•
Turn off filter.
21.48 RTRV-GIGE
(Cisco ONS 15454, ONS 15600) The Retrieve Gigabit Ethernet (RTRV-GIGE) command retrieves the front-end port information for a 1 Gigabit Ethernet card.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-GIGE:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-GIGE:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,<ROLE>,<STATUS>:[ADMINSTATE=<ADMINSTATE>],
[LINKSTATE=<LINKSTATE>],[MTU=<MTU>],[ENCAP=<ENCAP>],
[FLOWCTRL=<FLOWCTRL>],[AUTONEG=<AUTONEG>],[HIWMRK=<HIWMRK>],
[LOWMRK=<LOWMRK>],[OPTICS=<OPTICS>],[DUPLEX=<DUPLEX>],
[SPEED=<SPEED>],[NAME=<NAME>],[FREQ=<FREQ>],[LOSSB=<LOSSB>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>]:<PST>,<SST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1548,
ENCAP=GFP-F,FLOWCTRL=SYMMETRIC,AUTONEG=Y,HIWMRK=485,LOWMRK=25,
OPTICS=1000_BASE_SX,DUPLEX=AUTO,SPEED=AUTO,NAME=`"GIGEPORT\",
FREQ=1550,LOSSB=SX,SOAK=32, SOAKLEFT=\"12-22\":IS,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
Identifies 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>
Identifies a 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.
<ADMINSTATE>
(Optional) Administration type. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<LINKSTATE>
(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<MTU>
(Optional) Maximum transmission unit. MTU is an integer.
<ENCAP>
(Optional) Encapsulation frame 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
<FLOWCTRL>
(Optional) Flow control. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Passthrough flow control
•
Symmetric flow control
<AUTONEG>
(Optional) Automatic negotiation. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<LOWMRK>
(Optional) Low watermark value. LOWMRK is an integer.
<HIWMRK>
(Optional) High watermark value. HIWMRK is an integer.
<OPTICS>
(Optional) Optics type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000 Base CX
•
1000 Base LX
•
1000 Base SX
•
1000 Base ZX
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
<DUPLEX>
(Optional) Duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<SPEED>
(Optional) Speed. The parameter type is ALS_MODE, which is the automatic laser shutdown mode.
•
Automatic
•
Disabled
•
Manual
•
Manual restart for test
<NAME>
(Optional) Name. NAME is a string.
<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
<SOAK>
(Optional) IS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) OOS-AINS to IS transition soak time as measured in one 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 as follows:
•
•
•
<PST>
Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In Service
•
Out of Service
<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
•
Maintenance
•
Out of Group
•
Software Download
•
Unassigned
•
Unequipped
21.49 RTRV-HDLC
(Cisco ONS 15600) The Retrieve High-Level Data Link Control (RTRV-HDLC) command retrieves HDLC-related attributes.
Usage Guidelines
None
CategoryPorts
SecurityRetrieve
Input FormatRTRV-HDLC:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-HDLC:TID:VFAC-SLOT-PORT:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. The ONS 15600 ASAP card uses the VFAC AID.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[FCS=<FCS>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-SLOT-PORT::FCS=FCS-16"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section. The ONS 15600 ASAP card uses the VFAC AID.
<FCS>
(Optional) Payload frame check sequence. The parameter type is FCS, which is the frame check sequence.
•
Frame check sequencing using 16 bits
•
Frame check sequencing using 32 bits
•
No frame check sequence
21.50 RTRV-HDR
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Header (RTRV-HDR) command retrieves the header of a TL1 response message. It is used by TL1 clients to determine if the link to the NE is still active and if the NE is responding to commands.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-HDR:[<TID>]::<CTAG>;
Input ExampleRTRV-HDR:SONOMA::232;
Input ParametersNone that require description
21.51 RTRV-INV
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Inventory (RTRV-INV) command retrieves a list of the equipment inventory. For each unit in the system, the list identifies the unit's firmware numbers and Common Language Equipment Identifier (CLEI) codes, and the system's product ID and version ID. This command also retrieves the inventory information from pluggable modules using the AID PPM-SLOT-PORT format.
For multishelf, the inventory parameters are retrieved by using RTRV-INV and the BP AID. Because there is more that one shelf, the SHELFID is specified in BP AID.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-INV:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-INV:OCCIDENTAL:SLOT-15:301;
RTRV-INV:OCCIDENTAL:BP-ALL:116;
RTRV-INV:OCCIDENTAL:BP-1:116;
Input Parameters
<AID>
Access identifier from the "EQPT" section or ALL. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[PN=<PN>],[HWREV=<HWREV>],[FWREV=<FWREV>],[SN=<SN>],
[CLEI=<CLEI>],[TWL1=<TWL>],[PLUGINVENDORID=<PLUGINVENDORID>],
[PLUGINPN=<PLUGINPN>],[PLUGINHWREV=<PLUGINHWREV>],
[PLUGINFWREV=<PLUGINFWREV>],[PLUGINSN=<PLUGINSN>],
[ILOSSREF=<ILOSSREF>],[PID=<PID>],[VID=<VID>],[FPGA=<FPGA>],
[VENDORID=<VENDORID>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-15,OC3-IR-4::PN=87-31-00002,HWREV=004K,FWREV=76-99-00009-004A,
SN=013510,CLEI=NOCLEI,TWL1=1546.12,PLUGINVENDORID=012345,PLUGINPN=ABCDE,
PLUGINHWREV=ABCDE,PLUGINFWREV=01-02-03,PLUGINSN=01234,ILOSSREF=1.0,
PID=CISCO_ONS15454,VID=V01,FPGA=F451,VENDORID=NAME"
;TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BP-1,BP::PN=87-31-00002,HWREV=004K,FWREV=76-99-00009-004A,SN=013510,
CLEI=NOCLEI"
;Output Parameters
<AID>
Access identifier from the "EQPT" section
<AIDTYPE>
Specifies the type of (AID) facility, link or other addressable entity targeted by the message. AIDTYPE is a string.
<PN>
(Optional) Hardware part number. PN is a string.
<HWREV>
(Optional) Hardware revision. HWREV is a string.
<FWREV>
(Optional) Firmware revision. FWREV is a string.
<SN>
(Optional) Serial number. SN is a string.
<CLEI>
(Optional) Common language equipment identifier code for the equipment. CLEI is a string.
<TWL1>
(Optional) Tunable wavelength 1. The parameter type is OPTICAL_WLEN (optical wavelength). Possible values are the same as those for the TWL4 parameter (see below).
•
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
<PLUGINVENDORID>
(Optional) Plugin vendor ID. Integer.
<PLUGINPN>
(Optional) Third-party plug-in module HW part number. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINPN is a string.
<PLUGINHWREV>
(Optional) Third-party plug-in module hardware revision. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINHWREV is a string.
<PLUGINFWREV>
(Optional) Third-party plug-in module firmware. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINFWREV is a string.
<PLUGINSN>
(Optional) Third-party plug-in module serial number. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINSW is a string.
<ILOSSREF>
(Optional) The insertion loss reference calculated by the unit as worst insertion loss of all the unit. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes
<PID>
(Optional) Product ID of the module. PID is a string.
<VID>
(Optional) Vendor ID. VID is a string.
<FPGA>
(Optional) FPGA version. FPGA is a string.
<VENDORID>
(Optional) Vendor ID. VENDORID is a string.
21.52 RTRV-LNK
(Cisco ONS 15454) The Retrieve Link (RTRV-LNK) command retrieves all the (optical) links created in the NE. The end information is returned along with the type of (optical) link.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-LNK:[<TID>]::<CTAG>;
Input ExampleRTRV-LNK:PENNGROVE::114;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],[RDIRN=<RDIRN>],
[BAND=<BAND>],[WLEN=<WLEN>]:<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-TX,BAND-13-1-RX::OLNKT=HITLESS,CTYPE=PROV,RDIRN=W_E,
BAND=1530.32-1532.68,WLEN=1530.32:OOS-AU,AINS"
;Output Parameters
<FROM>
Access identifier from the "ALL" section. Identifies an entity at one end of the optical link.
<TO>
Access identifier from the "ALL" section. Identifies an entity at the other end of the optical link.
<OLNKT>
(Optional) Optical link type. The parameter type is OPTICAL_LINK_TYPE, which is the type of optical link between two optical facilities.
•
Link between two points that results in an add/drop connection from a drop point to an add point
•
Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
Link between two OTS points
<CTYPE>
(Optional) The type of cross-connection. Indicates if the optical link is provisioned by the user or automatically created by the NE. The parameter type is CREATION_TYPE, which is the optical link creation type.
•
Automatically created by the NE
•
Provisioned by the user
<RDIRN>
(Optional) Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<BAND>
(Optional) The optical band (group of four contiguous wavelengths) for this optical link. BAND is present only when there is a link between two OMS entities. The parameter type is OPTICAL_BAND.
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit
<WLEN>
(Optional) Optical wavelength for this optical link. WLEN is present only when there is a link between two OCH entities. The 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
<PST_PSTQ>
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 a 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 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.53 RTRV-LNK-<MOD2O>
(Cisco ONS 15454) The Retrieve Optical Link for OCH, OMS, or OTS (RTRV-LNK-<MOD20>) command retrieves any optical link associated with the entered AIDs or AID range. The end information is returned along with the type of optical link.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-LNK-<MOD2O>:[<TID>]:<AID>:<CTAG>:::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],
[RDIRN=<RDIRN>];Input ExampleRTRV-LNK-OMS:PENNGROVE:ALL:114:::OLNKT=HITLESS,CTYPE=AUTO,RDIRN=W-E;
Input Parameters
<AID>
Access identifier from the "BAND" section. Identifies facilities to check for optical link membership. It can be an OPTICAL_AID AID or an ALL AID. The ALL AID defaults to NE, which reports all the existing optical links of the NE. Must not be null.
<OLNKT>
Optical link type. A null value is equivalent to ALL. The parameter type is OPTICAL_LINK_TYPE, which is the type of optical link between two optical facilities.
•
Link between two points that results in an add/drop connection from a drop point to an add point
•
Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
Link between two OTS points
<CTYPE>
The type of cross-connection. Indicates if the optical link is provisioned by the user or automatically created by the NE. A null value is equivalent to ALL. The parameter type is CREATION_TYPE, which is the optical link creation type.
•
Automatically created by the NE
•
Provisioned by the user
<RDIRN>
Ring directionality of the optical line. A null value is equivalent to ALL. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>::[OLNKT=<OPTICALLINKTYPE>],[CTYPE=<CREATIONTYPE>],
[RDIRN=<RDIRN>],[BAND=<BAND>],[WLEN=<WLEN>]:<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-TX,BAND-13-1-RX::OLNKT=HITLESS,CTYPE=PROV,RDIRN=W_E,
BAND=1530.32-1532.68,WLEN=1530.32:OOS-AU,AINS"
;Output Parameters
<FROM>
Access identifier from the "BAND" section. Identifies an entity at one end of the optical link.
<TO>
Access identifier from the "BAND" section. Identifies an entity at the other end of the optical link.
<OPTICALLINKTYPE>
(Optional) Optical link type. The parameter type is OPTICAL_LINK_TYPE, which is the type of optical link between two optical facilities.
•
Link between two points that results in an add/drop connection from a drop point to an add point
•
Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
Link between two OTS points
<CREATIONTYPE>
(Optional) Indicates whether the optical link is provisioned by the user or automatically created by the NE. The parameter type is CREATION_TYPE, which is the optical link creation type.
•
Automatically created by the NE
•
Provisioned by the user
<RDIRN>
(Optional) Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<BAND>
(Optional) The optical band (group of four contiguous wavelengths) for this optical link. BAND is present only when there is a link between two OMS entities. The parameter type is OPTICAL_BAND.
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit.
<WLEN>
(Optional) Optical wavelength for this optical link. WLEN is present only when there is a link between two OCH entities. The 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
<PST_PSTQ>
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 a 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 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.54 RTRV-LNKTERM
(Cisco ONS 15454, ONS 15327, ONS 15310-CL) The Retrieve Provisionable Patchcord Termination (RTRV-LNKTERM) command retrieves information about one or more provisionable patchcord (PP) terminations.
Usage Guidelines
•
•
CategoryProvisionable Patchcords
SecurityRetrieve
Input FormatRTRV-LNKTERM:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-LNKTERM::LNKTERM-2:CTAG;
Input Parameters
<AID>
Access identifier from the "LNKTERM" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::PORT=<PORT>,[REMOTENODE=<REMOTENODE>],
[REMOTELNKTERMID=<REMOTELNKTERMID>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"LNKTERM-2::PORT=FAC-3-1,REMOTENODE=172.20.221.225,REMOTELNKTERMID=21"
;Output Parameters
<AID>
Access identifier from the "LNKTERM" section. Must not be null.
<PORT>
Access identifier from the "AidUnionId" section.
<REMOTENODE>
(Optional) Remote node. REMOTENODE is a string.
<REMOTELNKTERMID>
(Optional) Remote link term ID. REMOTELNKTERMID is a string.
21.55 RTRV-LOG
Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Log (RTRV-LOG) command retrieves the alarm log of the NE.
Usage Guidelines
The only option reported for LOGNM is ALARM.
CategoryLog
SecurityRetrieve
Input FormatRTRV-LOG:[<TID>]::<CTAG>::<LOGNM>;
Input ExampleRTRV-LOG:CERENT::123::ALARM;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<ALMNUMBER>:CURRENT=<CURRENT>,[PREVIOUS=<PREVIOUS>],
<CONDITION>,<SRVEFF>,[TIME=<OCRTIME>],[DATE=<OCRDAT>]:<ALMDESCR>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,18:CURRENT=MJ,PREVIOUS=CL,EOC,NSA,TIME=16-33-04,
DATE=1971-02-03:\"SDCC TERMINATION FAILURE\""
;Output Parameters
<AID>
Access identifier from the "ALL" section.
<ALMNUMBER>
Alarm number of the log. ALMNUMBER is an integer.
<CURRENT>
Current severity. 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.
<PREVIOUS>
(Optional) Previous severity. The parameter type is COND_EFF, which is the state of the condition upon the affected unit.
•
Standing condition cleared
•
Standing condition raised
•
Transient condition
<CONDITION>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See "Conditions" for a list of conditions.
<OCRTIME>
(Optional) Time when alarm was triggered.
<OCRDATE>
(Optional) Date when the specific event or violation occurred. Date when alarm was triggered.
<ALMDESCR>
Alarm description. ALMDESCR is a string.
21.56 RTRV-MAP-NETWORK
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Map Network (RTRV-MAP-NETWORK) command retrieves all the NE attributes which are accessible from the GNE (gateway NE). The NE attributes include the node IP address (IPADDR), node name (TID), and the product type of the NE (PRODUCT).
Usage Guidelines
The product type field in the response will appear as "unknown" for nodes that are not running the same version of software.
CategorySystem
SecurityRetrieve
Input FormatRTRV-MAP-NETWORK:[<TID>]::<CTAG>;
Input ExampleRTRV-MAP-NETWORK:CISCO::123;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"<IPADDR>,<NODENAME>,<PRODUCT>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"172.20.222.225,TID-000,15454"
;Output Parameters
21.57 RTRV-NE-APC
(Cisco ONS 15454) The Retrieve Network Amplification Power Control (RTRV-NE-APC) command retrieves the APC application ports involved in node set-up regulation.
Usage Guidelines
None
CategorySystem
SecurityMaintenance
Input FormatRTRV-NE-APC:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-NE-APC:PENNGROVE:CHAN-16-1-RX:114;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section. A null value is equivalent to ALL.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>::[MODIFDAT=<MODIFDAT>],[MODIFTM=<MODIFTM>],
[CHECKDAT=<CHECKDAT>],[CHECKTM=<CHECKTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-16-1-RX,OCH::MODIFDAT=04-11-02,MODIFTM=12-35-00,
CHECKDAT=04-11-02,CHECKTM=12-55-00"
;Output Parameters
<AID>
Access identifier from the "CHANNEL" section.
<MOD>
AID type. The parameter type is MOD2O, which is the facility types for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards.
•
Optical channel
•
Optical multiplexer section
•
Optical trace section
<MODIFDAT>
(Optional) The last date when the APC application modified this port. The format of MODIFDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MODIFDAT is a date.
<MODIFTM>
(Optional) The last time when the APC application modified this port. The format of MODIFTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MODIFTM is a time.
<CHECKDAT>
(Optional) The last date when the APC application controlled and validated this port. The format of CHECKDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. CHECKDAT is a date.
<CHECKTM>
(Optional) The last time when the APC application controlled and validated this port. The format of CHECKTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. CHECKTM is a time.
21.58 RTRV-NE-GEN
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element General (RTRV-NE-GEN) command retrieves the general NE attributes.
Usage Guidelines
ETHIPADDR and ETHIPMASK are disabled in this command. ETHIPADDR and ETHIPMASK are used to show the Ethernet interface address and mask. Both default to the nodes' IP address and masks.
CategorySystem
SecurityRetrieve
Input FormatRTRV-NE-GEN:[<TID>]::<CTAG>;
Input ExampleRTRV-NE-GEN:CISCO::123;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"[IPADDR=<IPADDR>],[IPMASK=<IPMASK>],[DEFRTR=<DEFRTR>],
[IIOPPORT=<IIOPPORT>],[NTP=<NTP>],[ETHIPADDR=<ETHIPADDR>],
[ETHIPMASK=<ETHIPMASK>],[NAME=<NAME>],[SWVER=<SWVER>],[LOAD=<LOAD>],
[PROTSWVER=<PROTSWVER>],[PROTLOAD=<PROTLOAD>],[DEFDESC=<DEFDESC>],
[PLATFORM=<PLATFORM>],[SECUMODE=<SECUMODE>],[SUPPRESSIP=<SUPPRESSIP>],
[MODE=<MODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"IPADDR=192.168.100.52,IPMASK=255.255.255.0,DEFRTR=192.168.100.1,
IIOPPORT=57970,NTP=192.168.100.52,ETHIPADDR=172.20.208.225,
ETHIPMASK=255.255.255.0,NAME="NODENAME",SWVER=2.01.03,
LOAD=02.13-E09A-08.15,PROTSWVER=2.01.02,PROTLOAD=02.12-E09A-09.25,
DEFDESC=\"NE DEFAULTS FEATURE\",PLATFORM=15454-ANSI,SECUMODE=NORMAL,
SUPPRESSIP=YES,MODE=SINGLESHELF"
;Output Parameters
21.59 RTRV-NE-IPMAP
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element Internet Protocol Map (RTRV-NE-IPMAP) command retrieves the IP address and node name of the NEs that have a DCC connection with this NE.
Usage Guidelines
This command only reports the discovered DCC link. If there is no discovered DCC link on the port (or the node), the command will return COMPLD without IPMAP information.
CategoryNetwork
SecurityRetrieve
Input FormatRTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-NE-IPMAP:CISCO:FAC-12-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. The port of an NE carrying the DCC connection. A null value defaults to the whole NE. A null value is equivalent to ALL.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<IPADDR>,<NODENAME>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-12-1:172.20.208.225,NODENAME2"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section. Port of an NE carrying the DCC connection.
<IPADDR>
Node IP address. IPADDR is a string.
<NODENAME>
Network element name. NODENAME is a string.
21.60 RTRV-NE-PATH
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA) The Retrieve Network Element Path (RTRV-NE-PATH) command retrieves the path-level attributes on an NE.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-NE-PATH:[<TID>]::<CTAG>[::::];
Input ExampleRTRV-NE-PATH:::CTAG;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"[PDIP=<PDIP>],[XCMODE=<XCMODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"PDIP=Y,XCMODE=MIXED"
;Output Parameters
21.61 RTRV-NE-SYNCN
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element Synchronization (RTRV-NE-SYNCN) command retrieves the synchronization attributes of the NE.
Usage Guidelines
•
•
–
–
–
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-NE-SYNCN:[<TID>]:[<AID>]:<CTAG>[::::];
Input ExampleRTRV-NE-SYNCN:CISCO:SHELF-2:123;
RTRV-NE-SYNCN:CISCO::123;
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. Must not be null
Output FormatSID DATE TIME
M CTAG COMPLD
"[<AID>]::[TMMD=<TMMD>],[SSMGEN=<SSMGEN>],[QRES=<QRES>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SHELF-1::TMMD=LINE,SSMGEN=GEN1,QRES=ABOVE-PRS,RVRTV=Y,RVTM=8.0"
;TID-000 1998-06-20 14:30:00
M 001 COMPLD
"::TMMD=LINE,SSMGEN=GEN1,QRES=ABOVE-PRS,RVRTV=Y,RVTM=8.0"
;Output Parameters
<AID>
The node or shelf access identifier from the "SHELF" section. If omitted it addresses the node or first shelf of the node. Must not be null
<TMMD>
(Optional) Timing mode. The parameter type is TIMING_MODE, which is the timing mode for the current node.
•
The node derives its clock from the BITS input.
•
The node derives its clock from the SONET lines.
•
The node derives its clock from the mixed timing mode.
<SSMGEN>
(Optional) Synchronization status message generator. The parameter type is SYNC_GENERATION, which is the synchronization status message set generation.
•
First generation SSM set
•
Second generation SSM set
<QRES>
(Optional) Quality of the RES. The parameter type is SYNC_QUALITY_LEVEL, which is the network synchronization quality level.
•
Better than G811
•
Between STU_SDH and G811 (default setting)
•
Between G812T and STU_SDH
•
Between G812L and G812T
•
Between SETS and G812L
•
Below SETS but still usable
•
Disable the RES message by equating to DUS_SDH
<RVRTV>
(Optional) Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
21.62 RTRV-NE-WDMANS
(Cisco ONS 15454) The Retrieve Network Element Wavelength Division Multiplexing Automatic Node Setup (RTRV-NE-WDMANS) command retrieves the optical node setup (WDMANS) application ports involved in node setup regulation.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-NE-WDMANS:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-NE-WDMANS:PENNGROVE:ALL:114;
Input Parameters
<AID>
The access identifier from the "ALL" section. A null value is equivalent to ALL.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[REGULATED=<REGULATED>,][PARAM=<PARAM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-16-1-RX,OCH::REGULATED=OUT-OF-RANGE,PARAM=VOAATTN"
;Output Parameters
<AID>
Access identifier from the "ALL" section. AID is port regulated.
<AIDTYPE>
Specifies the type of facility, link, or other addressable entity targeted by the message. A type of access identifier. The parameter type is MOD2, which is the line/path modifier.
•
10 Gigabit Fibre Channel
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
1 Gbps ISC3 compatible
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
2 Gbps ISC3 compatible
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
D1 video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual Ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical Channel
•
OCH channel connection
•
OCH network connection
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3c path
•
STS6c path
•
STS9c path
•
STS18c path
•
STS12c path
•
STS24c path
•
STS36c path
•
STS48c path
•
STS192c path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 path
•
VT2 path
<REGULATED>
(Optional) The status of the port after a node setup regulation. The parameter type is REGULATED_PORT_TYPE, which is the optical configuration types for NEs.
•
WDM-ANS encountered a failure while regulating this port.
•
WDM-ANS does not foresee any algorithm or does not have any value to set for the parameter.
•
WDM-ANS cannot modify the set point because the calculated value is out of the allowed range.
•
WDM-ANS cannot modify the set point because the ports are in IS state.
•
WDM-ANS has successfully regulated this port.
•
WDM-ANS has not changed this port.
<PARAM>
(Optional) The regulated parameter inside of the specified port. The parameter type is REGULATED_PARAM_NAME, which is the name of the parameter regulated by the WDMANS application.
•
WDM-ANS has regulated the amplifier control mode parameter.
•
WDM-ANS has regulated the amplifier per the channel power parameter.
•
WDM-ANS has regulated the amplifier gain parameter.
•
WDM-ANS has regulated the OPWR-LFAIL threshold parameter.
•
WDM-ANS has regulated the amplifier tilt reference parameter.
•
WDM-ANS has regulated the variable optical attenuator (VOA) attenuation reference parameter.
•
WDM-ANS has regulated the VOA power reference parameter.
21.63 RTRV-NETYPE
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element Type (RTRV-NETYPE) command retrieves the NE's equipment-related information.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-NETYPE:[<TID>]::<CTAG>;
Input ExampleRTRV-NETYPE:GAUR1::1;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"<VENDOR>,<MODEL>,<NETYPE>,<SW_ISSUE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CISCO,ONS15454,ADM&MSPP&MSTP,5.00.00"
;Output Parameters
21.64 RTRV-OCH
(Cisco ONS 15454) The Retrieve Optical Channel (RTRV-OCH) command retrieves the attributes (service parameters) and state of an OCH facility.
Usage Guidelines
Refer to the Cisco ONS SONET TL1 Reference Guide for specific card provisioning rules.
Note
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OCH:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OCH:PENNGROVE:CHAN-6-2:236;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[RDIRN=<RDIRN>],[OPTYPE=<OPTICALPORTTYPE>],
[OPWR=<POWER>],[EXPWLEN=<EXPWLEN>],[ACTWLEN=<ACTWLEN>],
[ILOSS=<ILOSS>],[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>],
[VOAPWR=<VOAPWR>],[VOAREFATTN=<VOAREFATTN>],
[VOAREFPWR=<VOAREFPWR>],[REFOPWR=<REFOPWR>],[CALOPWR=<CALOPWR>],
[CHPOWER=<CHPOWER>],[NAME=<PORTNAME>],[SFBER=<SFBER>],
[SDBER=<SDBER>],[COMM=<COMM>],[GCCRATE=<GCCRATE>],[DWRAP=<DWRAP>],
[FEC=<FEC>],[PAYLOADMAP=<PAYLOADMAP>],[OSFBER=<OSFBER>],
[OSDBER=<OSDBER>],[MACADDR=<MACADDR>],[SYNCMSG=<SYNCMSG>],
[SENDDUS=<SENDDUS>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[OSPF=<OSPF>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-6-1:,,WORK,ACT:RDIRN=W-E,OPTYPE=DROP,OPWR=10.0,EXPWLEN=1530.33,
ACTWLEN=1530.33,ILOSS=1.0,VOAMODE=ATTN,VOAATTN=0.5,VOAPWR=0.0,
VOAREFATTN=3.5,VOAREFPWR=5.0,REFOPWR=10.5,CALOPWR=0,CHPOWER=2.0,
NAME="NY PORT",SFBER=1E-4,SDBER=1E-5,COMM=GCC,GCCRATE=192K,DWRAP=Y,
FEC=STD,PAYLOADMAP=ASYNCH,OSFBER=1E-4,OSDBER=1E-5,
MACADDR=00-0E-AA-BB-CC-FF,SYNCMSG=Y,SENDDUS=Y,SOAK=52,SOAKLEFT=12-25,
OSPF=Y,LBCL=10.0,OPT=10.0,OPR=10.0:OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "CHANNEL" section.
<ROLE>
(Optional) Identifies an OCH 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) The 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.
<RDIRN>
(Optional) Ring directionality of the optical channel. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<OPTICALPORTTYPE>
(Optional) The optical port type. Only applicable to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
•
The signal is added to the port.
•
The signal is dropped from the port.
•
COM channels (without OSC) that continue the signal from the previous card.
•
Input DCU port.
•
The express channel that continues the signal from the previous card.
•
All the channels that continue the signal from the previous card.
•
OSC channel that continues the signal from the previous card.
•
COM channels (without OSC) that continue the signal to the next card.
•
Output DCU port.
•
Express channel that continues the signal to the next card.
•
All the channels that continue the signal to the next card
•
OSC channel that continue the signal to the next card.
<POWER>
(Optional) The optical power measured at this port. It can be the input or output power according to port type. Only applicable to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. POWER is a string.
<EXPWLEN>
(Optional) Optical wavelength for this port. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. EXPWLEN is a string. The parameter type is OPTICAL_WLEN (optical wavelength). Refer to the ACTWLEN parameter values.
<ACTWLEN>
(Optional) The manufacturing optical wavelength for this port. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. The 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
<ILOSS>
(Optional) Insertion loss expressed in dBm. ILOSS applies to output ports only on the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. ILOSS is a string.
<VOAMODE>
(Optional) The working control mode of the VOA. Applies only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
•
VOA has a fixed attenuation.
•
VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>
(Optional) The transit power attenuation for the VOA expressed in dBm. The range is -24.0 to +2.0 dBm for the MXP_2.5G_10G and TXP_MR_10G cards. VOAATTN is a string.
<VOAPWR>
(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. VOAPWR is a float and a string.
<VOAREFATTN>
(Optional) The value of reference attenuation for the VOA. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. VOAREFATTN is a float and a string.
<VOAREFPWR>
(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. VOAREFPWR is a float and a string.
<REFOPWR>
(Optional) The value of the calculated optical power expected for the output line added to the calibration value, which equals the total expected output power. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. REFOPWR is a float and a string.
<CALOPWR>
(Optional) The value of the calibrated optical power expected for the output added to the calculated value which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. Applicable only to the OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. CALOPWR is a float and a string.
<CHPOWER>
The value of per-channel optical power expected to the OCH drop port of an AD-4C unit. CHPOWER is a float expressed in dBm. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PORTNAME>
(Optional) Port name. PORTNAME is a string.
<SFBER>
(Optional) Signal failure threshold for the SONET payload. Can only be provisioned on the working port. 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) Signal degrade threshold for the SONET payload. 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.
<COMM>
(Optional) The GCC or DCC is enabled or disabled. The GCC can be enabled only if the digital wrapper has been enabled for the card. The default is NONE. For an MXP_2.5G_10G or TXP_MR_10G client port, only the DCC can be provisioned if the termination mode is not transparent and the payload is SONET. On an MXP_2.5G_10G or TXP_MR_10G DWDM port, the DCC can be enabled only if the ITU-T G.709 is not enabled and if the payload is SONET and the termination mode is not transparent. On an MXP_2.5G_10G or TXP_MR_10G DWDM port, the GCC can be enabled if there is no DCC and the ITU-T G.709 flag is enabled. The parameter type is COMM_TYPE, which is the out-of-band communications channel termination type.
•
Section DCC type.
•
Generic communication channel (OTN) type.
•
Disable DCC or GCC if enabled.
<GCCRATE>
(Optional) The data rate of the GCC traffic. The default is 192 kbps. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the DWDM port. The 576K option is not supported in this release. The parameter type is GCCRATE, which is the data rate of the GCC traffic.
•
192 kbps
•
576 kbps
<DWRAP>
(Optional) The ITU-T G.709 digital wrapper. It is either on or off. The system default is ON. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the DWDM port.
To enable ITU-T G.709:
•
•
To disable ITU-T G.709:
•
•
•
•
The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<FEC>
(Optional) Forward error correction. It can be enabled only if the ITU-T G.709 is turned ON. It is either off or enabled in standard or enhanced mode. The system default is standard FEC enabled. The FEC level PM and thresholds apply if the FEC is turned ON. The parameter type is FEC_MODE, which specifies the type of forward error correction.
•
Enhanced FEC is enabled.
•
FEC is disabled.
•
Standard FEC is enabled.
<PAYLOADMAP>
(Optional) The type of payload mapping. It can be enabled only if the ITU-T G.709 is turned ON and FEC is enabled. The parameter type is PAYLOAD_MAPPING, which is the payload mapping mode.
•
Asynchronous mapping mode
•
ODU multiplex structure mode
•
Synchronous mapping mode
<OSFBER>
(Optional) The signal failure threshold at the OTN level. 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.
<OSDBER>
(Optional) The signal degrade threshold at the OTN level. 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.
<MACADDR>
(Optional) MAC address for the 10 Gigabit Ethernet payload. MACADDR is a string.
<SYNCMSG>
(Optional) The facility be enabled to provide the synchronization clock. This does not apply to the TXP_MR_10G card. This applies to an MXP_2.5G_10G card only if the payload is SONET/SDH and the card termination mode is as follows:
•
•
The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SENDDUS>
The facility sends out a Do not Use for Sync message. This does not apply to the TXP_MR_10G card. This applies to an MXP_2.5G_10G card only if the payload is SONET/SDH and the card termination mode is as follows:
•
•
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) OOS-AINS to IS transition soak time as measured in 15-minute intervals, so a value of 4 translates to a soak time of 1 hour. The allowable range is 0 to 192 intervals, 48 hours maximum.
<OSPF>
(Optional) Open Shortest Path First. 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.
<LBCL>
(Optional) Displays the current value of the laser current. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<OPT>
(Optional) Displays the current value of the transmitted optical power. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<OPR>
(Optional) Displays the current value of the received optical power. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PST_PSTQ>
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 a primary state qualifier (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.65 RTRV-OCHCC
(Cisco ONS 15454) The Retrieve Optical Channel Client Connection (RTRV-OCHCC) command retrieves the OCH client connection provisioning information.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OCHCC:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OCHCC:VA454-22:FAC-2-1-1:116;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[PAYLOAD=<PAYLOAD>],[CTKID=<CTKID>]:<PSTPSTQ>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1-1::PAYLOAD=OC192,CTKID=\"OCHCC\":IS-NR"
;Output Parameters
<AID>
Access identifier from the "CHANNEL" section.
<PAYLOAD>
Indicates the payload of the connection which is equivalent to the type of the payload configured on the facility port where the connection is originated or terminated. Parameter type is MOD1PAYLOAD.
•
10 Gbps Fibre Channel payload
•
10 Gigabit Ethernet payload
•
1 Gbps Fibre Channel payload
•
1 Gigabit Ficon payload
•
1 Gbps ISC3 compatible
•
2 Gbps Fibre Channel payload
•
2 Gigabit Ficon payload
•
2 Gbps ISC3 compatible
•
4 Gbps Fibre channel
•
4 Gbps Fiber connection
•
D1Video payload
•
DV6000 payload
•
EC1 payload
•
ESCON payload
•
ETRCLO payload
•
1 G Ethernet payload
•
HDTV payload
•
ISC3PEER1G payload
•
ISC3PEER2G payload
•
ISC3PEER2R payload
•
ISCCOMPAT payload
•
OC12 payload
•
OC192 payload
•
OC3 payload
•
OC48 payload
•
DS3 payload
<CKTID>
Cross-connect ID. The default is Blank or None. String of ASCII characters. Maximum length is 48. If CKTID is empty or null the CKTID field will not be displayed.
<PSTPSTQ>
Service state. The parameter is PST_PSTQ, which provides the service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ).
•
In Service - Normal
•
Out of Service - Autonomous
•
Out of Service - Autonomous and Management
•
Out of Service - Management
21.66 RTRV-OCHNC
(Cisco ONS 15454) The Retrieve Optical Channel Network Connection (RTRV-OCHNC) command retrieves the OCH wavelength connection provisioning information.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OCHNC:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-OCHNC:VA454-22:CHANWL-1-3-TX-1530.33:116;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<WCT>:[CKTID=<CKTID>]::<PSTPSTQ>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHANWL-1-3-TX-1530.33,LINEWL-4-1-RX-1530.33:1WAY:CKTID=\"OCHNC-1\":IS-NR"
;Output Parameters
<SRC>
Source access identifier from the "CHANNEL" section. In 2-way wavelength connection sources both directions need to be indicated.
<DST>
Destination access identifier from the "LINEWL" section. In 2-way wavelength connection sources both directions need to be indicated.
<WCT>
Wavelength connection type. The parameter type is WCT. The default is 1WAY.
•
A unidirectional wavelength connection for one specified ring direction.
•
A bidirectional wavelength connection for both the ring directions.
<CKTID>
Cross-connect ID. The default is Blank or None. String of ASCII characters. Maximum length is 48. If CKTID is empty or null the CKTID field will not be displayed.
<PSTPSTQ>
Service state. The parameter is PST_PSTQ, which provides the service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ).
•
In Service - Normal
•
Out of Service - Autonomous
•
Out of Service - Autonomous and Management
•
Out of Service - Management
21.67 RTRV-OMS
(Cisco ONS 15454) The Retrieve Optical Multiplex Section (RTRV-OMS) command retrieves the attributes (service parameters) and state of an OMS facility.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OMS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OMS:PENNGROVE:BAND-6-1-RX:236;
Input Parameters
<AID>
Access identifier from the "BAND" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>],
EXPBAND=<EXPBAND>,[ACTBAND=<ACTBAND>],[ILOSS=<ILOSS>],
[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>],[VOAPWR=<VOAPWR>],
[VOAREFATTN=<VOAREFATTN>],[VOAREFPWR=<VOAREFPWR>],
[REFOPWR=<REFOPWR>],[CALOPWR=<CALOPWR>],[CHPOWER=<CHPOWER>],
[NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-RX::RDIRN=W-E,OPTYPE=ADD,OPWR=10.0,EXPBAND=UNKNOWN,
ACTBAND=1530.33_1531.12,ILOSS=1.0,VOAMODE=ATTN,VOAATTN=0.5,
VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,REFOPWR=10.5,CALOPWR=0.5,
CHPOWER=2.0,NAME=\"OMS PORT\":OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "CHANNEL" section.
<RDIRN>
Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<OPTICALPORTTYPE>
The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
•
The signal is added to the port.
•
The signal is dropped from the port.
•
COM channels (without an OSC) that continue the signal from the previous card.
•
Input dispersion compensation unit (DCU) port.
•
Express channel that continues the signal from the previous card.
•
All the channels that continue the signal from the previous card.
•
OSC channel that continues the signal from the previous card.
•
COM channels (without an OSC) that continue the signal to the next card.
•
Output DCU port.
•
Express channel that continues the signal to the next card.
•
All the channels that continue the signal to the next card.
•
OSC channel that continue the signal to the next card.
<POWER>
(Optional) The optical power measured at this port. It can be the input or output power according to port type. POWER is a string.
<EXPBAND>
The expected value of the band for this port. The parameter type is OPTICAL_BAND (optical band).
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit.
<ACTBAND>
(Optional) Identifies the manufacturing optical band (group of four contiguous wavelengths) for this port. The parameter type is OPTICAL_BAND (optical band).
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit.
<ILOSS>
(Optional) Insertion loss expressed in dBm. ILOSS applies to output ports only.
<VOAMODE>
(Optional) The working control mode of the VOA. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
•
VOA has a fixed attenuation.
•
VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>
(Optional) The value of calibrated attenuation for the VOA. VOAATTN is a float and a string.
<VOAPWR>
(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. VOAPWR is a float and a string.
<VOAREFATTN>
(Optional) The value of reference attenuation for the VOA. VOAREFATTN is a float and a string.
<VOAREFPWR>
(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. VOAREFPWR is a float and a string.
<REFOPWR>
(Optional) The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. REFOPWR is a float and a string.
<CALOPWR>
(Optional) The value of the calibrated optical power expected for the output added to the calculated value, which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. CALOPWR is a float and a string.
<CHPOWER>
(Optional) The per-channel optical power. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<NAME>
(Optional) Name. NAME is a string.
<PST_PSTQ>
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 a primary state qualifier (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.68 RTRV-OPM
(Cisco ONS 15454) The Retrieve Optical Monitoring Parameter (RTRV-OPM) command retrieves the optical power monitoring parameters present at the OCH layer in a reconfigurable optical add/drop multiplexing (ROADM) node.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OPM:[<TID>]:[<AID>]:<CTAG>[::::];
Input ExampleRTRV-OPM:VA454-22:OPM-5-1530.33:116;
Input Parameters
<AID>
Access identifier from the "OPM" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[POWEROUT=<POWEROUT>],[POWERADD=<POWERADD>],
[POWERPT=<POWERPT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"OPM-5-1530.33::POWEROUT=9.0,POWERADD=10.0,POWERPT=11.0:"
;Output Parameters
<AID>
Access identifier from the "OPM" section.
<POWEROUT>
(Optional) The value of the output power associated to the add or pass-through channel port of a 32WSS card. POWEROUT is a float.
<POWERADD>
(Optional) The value of the input power associated to the add channel port of a 32WSS card. POWERADD is mutually exclusive with the POWERPT parameter. POWERADD is a float.
<POWERRPT>
(Optional) The value of the input power associated to the pass-through channel port of a 32WSS card. POWERPT is mutually exclusive with the POWERADD parameter. POWERPT is a float.
21.69 RTRV-OSC
(Cisco ONS 15454) The Retrieve Optical Service Channel (RTRV-OSC) command retrieves all the OSC information of the NE.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OSC:[<TID>]:<AID>:<CTAG
Input ExampleRTRV-OSC:PENNGROVE:OSC-1:114;
Input Parameters
AID
Access identifier from the "OSC" section. Identifies the OSC group of the NE. Only ALL, null, or OSC-# is allowed in the AID. A null value is equivalent to ALL. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[RINGID=<RINGID>],[NODEID=<NODEID>],[EAST=<EAST>],[WEST=<WEST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"OSC-1::RINGID=10,NODEID=1,EAST=FAC-8-1,WEST=FAC-10-1"
;Output Parameters
<AID>
Access identifier from the "OSC" section. Identifies the OSC group of the NE.
<RINGID>
(Optional) OSC ring ID of the NE. It is a string of up to six characters, valid characters are [A to Z, 0 to 0]. The default value is number in the AID OSC-#. RINGID is an integer.
<NODEID>
(Optional) OSC node ID of the NE. It ranges from 0 to 31. NODEID is an integer.
<EAST>
(Optional) The east OC3 facility from the "FACILITY" section. EAST_OC3 is the AID facility. Only one OC-3 for the east direction is supported in this release.
<WEST>
(Optional) The west OC3 facility from the "FACILITY" section. EAST_OC3 is the AID facility. Only one OC-3 for the west direction is supported in this release.
21.70 RTRV-OTS
(Cisco ONS 15454) The Retrieve Optical Transport System (RTRV-OTS) command retrieves the attributes (service parameters) and state of an OTS facility.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-OTS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-OTS:PENNGROVE:LINE-6-1-RX:236;
Input Parameters
<AID>
Access identifier from the "LINE" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>],
[ILOSS=<ILOSS>],[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>],
[VOAPWR=<VOAPWR>],[VOAREFATTN=<VOAREFATTN>],
[VOAREFPWR=<VOAREFPWR>],[OSRI=<OSRI>],[AMPLMODE=<AMPLMODE>],
[CHPOWER=<CHPOWER>],[GAIN=<GAIN>],[EXPGAIN=<EXPGAIN>],
[REFOPWR=<REFOPWR>],[OFFSET=<OFFSET>],[REFTILT=<REFTILT>],
[CALTILT=<CALTILT>],[ASEOPWR=<ASEOPWR>],[DCULOSS=<DCULOSS>],
[AWGST=<AWGST>],[HEATST=<HEATST>],[NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"LINE-6-1-RX:RDIRN=W-E,OPTYPE=IN,OPWR=10.0,ILOSS=1.0,VOAMODE=ATTN,
VOAATTN=0.5,VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,OSRI=Y,
AMPLMODE=GAIN,CHPOWER=-10.0,GAIN=3.0,EXPGAIN=3.0,REFOPWR=10.0,
OFFSET=0.0,REFTILT=3.0,CALTILT=0.0,ASEOPWR=5.0,DCULOSS=1.2,
AWGST=WARM-UP,HEATST=ON,NAME=\"OTS PORT\":OOS-AU,AINS"
;Output Parameters
AID
Access identifier from the "LINE" section.
RDIRN
Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
OPTICALPORTTYPE
The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
•
The signal is added to the port.
•
The signal is dropped from the port.
•
COM channels (without OSC) that continue the signal from the previous card.
•
Input DCU port.
•
Express channel that continues the signal from the previous card.
•
All the channels that continue the signal from the previous card.
•
OSC channel that continues the signal from the previous card.
•
COM channels (without OSC) that continue the signal to the next card.
•
Output DCU port.
•
Express channel that continues the signal to the next card.
•
All the channels that continue the signal to the next card.
•
OSC channel that continue the signal to the next card.
<POWER>
(Optional) The optical power measured at this port. It can be the input or output power according to port type. POWER is a float.
<ILOSS>
(Optional) Insertion loss.
<VOAMODE>
(Optional) The working control mode of the VOA. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
•
VOA has a fixed attenuation.
•
VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>
(Optional) The value of calibrated attenuation for the VOA. VOAATTN is a float.
<VOAPWR>
(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. VOAPWR is a float.
<VOAREFATTN>
(Optional) The value of reference attenuation for the VOA. VOAREFATTN is a float.
<VOAREFPWR>
(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. VOAREFPWR is a float.
<OSRI>
(Optional) OSRI enabled or disabled. Present only on a port where the safety is supported. Defaults to off. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<AMPLMODE<
(Optional) The optical amplification control mode. The parameter type is AMPL_MODE, which defines the amplifier control mode.
•
The amplifier always maintains a fixed gain.
•
The amplifier maintains the output power to a fixed value.
<CHPOWER>
(Optional) The per channel optical power. Applicable only to amplified OTS ports.
<GAIN>
(Optional) The value of the gain of the amplifier. Defaults to 21 dB for preamplifier and 20 dB for booster amplifier.
<EXPGAIN>
(Optional) The expected gain value to be reached from an amplifier when the node is in a DWDM access network. EXPGAIN is a float.
<REFOPWR>
(Optional) The value of the calculated optical power expected for the output line added to the calibration value, which equals the total expected output power. REFOPWR is a float.
<OFFSET>
(Optional) The value of the calibrated optical power expected for the output line, which is added to the calculated value to have the total expected output power. OFFSET is a float.
<REFTILT>
(Optional) The calculated tilt value to be added to the user provided calibration value. REFTILT is a float.
<CALTILT>
(Optional) The amplifier calibration tilt offset to be added to the calculated reference value. CALTILT is a float.
<ASEOPWR>
(Optional) The value of the calibrated optical power expected for the output line, which is provided by the user, added to the calculated value to have the total expected output power. ASEOPWR is a float.
<DCULOSS>
(Optional) The value of insertion loss associated to DCU in between the two stages of a preamplifier unit. DCULOSS is a float.
<AWGST>
The status assumed by AWG. The parameter value is AWG_STATUS, which is the AWG status list.
•
The AWG is on.
•
The AWG is warming up.
<HEATST>
(Optional) The status assumed by the heater. The parameter type is HEATER_STATUS, which is the heater status list.
•
The heater is off.
•
The heater is on.
<NAME>
(Optional) Name of the port. NAME is a string.
<PST_PSTQ>
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 a primary state qualifier (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.71 RTRV-PATH-OCH
(ONS 15454) The Retrieve Path Optical Channel (RTRV-PATH-OCH) command retrieves the OCH path inside a node. An OCH path is a list of access identifiers that addresses all the possible facility and internal optical channels which are all associated to the same wavelength.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-PATH-OCH:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-PATH-OCH:PENNGROVE:CHAN-6-2:236;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section or the "LINEWL" section .
Output FormatSID DATE TIMEM
CTAG COMPLD
"<AID>::[WLEN=<WLEN>],[PATH=<PATH>]:"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-6-2::WLEN=1530.33,PATH=LINEWL-1-3-RX-1530.33&LINEWL-1-1-TX-1530.33&
LINEWL-3-1-RX-1530.33&CHAN-3-1-TX&CHAN-6-2:";
Output Parameters
<AID>
Access identifier from the "CHANNEL" section or the "LINEWL" section
WLEN
Defines the Optical Wavelength. The parameter type is OPTICAL_WLEN (optical wavelength).
•
Wavelength C Band - 1/40
•
Wavelength C Band - 2/40
•
Wavelength C Band - 3/40
•
Wavelength C Band - 4/40
•
Wavelength C Band - 6/40
•
Wavelength C Band - 7/40
•
Wavelength C Band - 8/40
•
Wavelength C Band - 9/40
•
Wavelength C Band - 11/40
•
Wavelength C Band - 12/40
•
Wavelength C Band - 13/40
•
Wavelength C Band - 14/40
•
Wavelength C Band - 16/40
•
Wavelength C Band - 17/40
•
Wavelength C Band - 18/40
•
Wavelength C Band - 19/40
•
Wavelength C Band - 21/40
•
Wavelength C Band - 22/40
•
Wavelength C Band - 23/40
•
Wavelength C Band - 24/40
•
Wavelength C Band - 26/40
•
Wavelength C Band - 27/40
•
Wavelength C Band - 28/40
•
Wavelength C Band - 29/40
•
Wavelength C Band - 31/40
•
Wavelength C Band - 32/40
•
Wavelength C Band - 33/40
•
Wavelength C Band - 34/40
•
Wavelength C Band - 36/40
•
Wavelength C Band - 37/40
•
Wavelength C Band - 38/40
•
Wavelength C Band - 39/40
•
L Band Wavelength 1577.44
•
L Band Wavelength 1577.86
•
L Band Wavelength 1578.27
•
L Band Wavelength 1578.69
•
L Band Wavelength 1579.10
•
L Band Wavelength 1579.52
•
L Band Wavelength 1579.93
•
L Band Wavelength 1580.35
•
L Band Wavelength 1580.77
•
L Band Wavelength 1581.18
•
L Band Wavelength 1581.60
•
L Band Wavelength 1582.02
•
L Band Wavelength 1582.44
•
L Band Wavelength 1582.85
•
L Band Wavelength 1583.27
•
L Band Wavelength 1583.69
•
L Band Wavelength 1584.11
•
L Band Wavelength 1584.53
•
L Band Wavelength 1584.95
•
L Band Wavelength 1585.36
•
L Band Wavelength 1585.78
•
L Band Wavelength 1586.20
•
L Band Wavelength 1586.62
•
L Band Wavelength 1587.04
•
L Band Wavelength 1587.46
•
L Band Wavelength 1587.88
•
L Band Wavelength 1588.30
•
L Band Wavelength 1588.73
•
L Band Wavelength 1589.15
•
L Band Wavelength 1589.57
•
L Band Wavelength 1589.99
•
L Band Wavelength 1590.41
•
L Band Wavelength 1590.83
•
L Band Wavelength 1591.26
•
L Band Wavelength 1591.68
•
L Band Wavelength 1592.10
•
L Band Wavelength 1592.52
•
L Band Wavelength 1592.95
•
L Band Wavelength 1593.37
•
L Band Wavelength 1593.79
PATH
Access identifier from the "CHANNEL" section or the "LINEWL" section.
21.72 RTRV-PM-<MOD2>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (RTRV-PM-<MOD2>) command retrieves the values of PM parameters for a specified card type.
Usage Guidelines
•
•
•
•
•
•
•
•
•
•
•
•
•
•
–
–
•
•
•
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-PM-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<DATE>],[<TIME>];Input ExampleRTRV-PM-T1:TID:FAC-2-1:123::CVL,10-UP,NEND,RCV,15-MIN,04-11,12-45;
Input Parameters
<AID>
Access identifier from the "ALL" section. All of the STS, VT1, Facility, and DS1 AIDs are supported. Must not be null.
<MONTYPE>
Monitored type. A null value defaults to all montypes applicable to the modifier. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<MONLEV>
The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<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
<DIRECTION>
Type of direction. Must not be null. The parameter type is DIRECTION (transmit and receive directions).
•
Both transmit and receive directions.
•
Receive direction only.
•
Transmit direction only.
<TMPER>
Accumulation time period for performance counters. If TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<DATE>
The beginning date of the PM or storage register period specified in TMPER. The format of DATE is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to current date.
<TIME>
The beginning time of day of the PM or storage register period specified in TMPER. The format of TIME is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to current time.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<MONDAT>],[<MONTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,DS1-14:CVL,21,COMPL,NEND,RCV,15-MIN,04-11,12-45"
;Output Parameters
<AID>
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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<MONTYPE>
Monitored type. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<MONVAL>
The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. MOVAL is a string.
<VLDTY>
(Optional) Indicates whether the information for the specified time period was accumulated over the entire time period or some portion thereof. Validity indicator for the reported PM data. The parameter type is VALIDITY, which is the response validity.
•
Complete response
•
Partial response
<LOCN>
(Optional) Location associated with a particular command. 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
•
Transmit direction only
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<MONDAT>
(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of MONDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MONDAT is a string.
<MONTM>
(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MONTM is a string.
21.73 RTRV-PMMODE-<STS_PATH>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance Mode of PM Data Collection for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, or STS9C (RTRV-PMMODE-<STS_PATH>) command retrieves the type of PM mode that has been previously set in the NE. This command can be used to identify whether the PM parameters are Section, Line or Path type, and to identify whether or not the PMs are being collected by the NE.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
Note
•
•
•
•
•
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-PMMODE-<STS_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>;
Input ExampleRTRV-PMMODE-STS1:CISCO:STS-4-1-2:123::NEND;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId" section. Must not be null.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Must not be null. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:[<LOCN>],<MODETYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-4-1-2:NEND,P"
;Output Parameters
<CROSSCONNECTID>
Access identifier from the "CrossConnectId" section.
<LOCN>
(Optional) 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.
<MODETYPE>
The type of PM parameters that the entity or the subentity is to store as a result of an attribute change. The parameter type is PM_MODE, which is the type of PM parameters.
•
Transport Path PM parameters.
21.74 RTRV-PMMODE-<VT_PATH>
(Cisco ONS 15310-MA) The Retrieve Performance Mode of PM Data Collection for VT1 and VT2 (RTRV-PMMODE-<VT_PATH>) command retrieves the type of PM mode that has been previously set in the NE. This command can be used to identify whether the PM parameters are Section, Line or Path type, and to identify whether or not the PMs are being collected by the NE.
Usage Guidelines
Note
•
•
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-PMMODE-<VT_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>;
Input ExampleRTRV-PMMODE-VT1:CISCO:VT-1-1-2-2:1::NEND;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId" section. Must not be null.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Must not be null. The parameter type is LOCATION, which is the location where the action is to take place. Must not be null.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
Output FormatSID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:<LOCN>,<MODETYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VT1-1-1-2-2:NEND,P"
;Output Parameters
<CROSSCONNECTID>
Access identifier from the "CrossConnectId1" section.
<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.
<MODETYPE>
The type of PM parameters that the entity or the subentity is to store as a result of an attribute change. The parameter type is PM_MODE, which is the type of PM parameters.
•
Transport Path PM parameters.
21.75 RTRV-PMSCHED-<MOD2>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance Monitoring Schedule for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (RTRV-PMSCHED-<MOD2>) command retrieves the PM reporting schedule that was set for the NE by the SCHED-PMREPT command.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-PMSCHED-<MOD2>:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-PMSCHED-OC3:CISCO-NODE:FAC-3-1:123;
Input Parameters
<AID>
Access identifier from the "ALL" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],,
[<MONLEV>],<LOCN>,,[<TMPER>],[<TMOFST>],[<INHMODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,OC3:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW"
;Output Parameters
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2, which is the line/path modifier.
•
10 Gigabit Fibre Channel
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
D1 Video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual Ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC3 facility
•
OC12 facility
•
OC48 facility
•
OC192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3c path
•
STS6c path
•
STS9c path
•
STS18c path
•
STS12c path
•
STS24c path
•
STS36c path
•
STS48c path
•
STS192c path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 path
•
VT2 path
<REPTINVL>
Reporting interval. How often a report is to be generated and sent to the appropriate NE. REPTINVL is a string.
<REPTDAT>
Report date. Date for the next report. REPTDAT is a string.
<REPTTM>
Report time. The time of day for the next PM report. REPTTM is a string.
<NUMINVL>
(Optional) The remaining number of intervals over which the PM will be reported. NUMINVL is an integer.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode will 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.
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24 hours. For SONET PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<TMOFST>
(Optional) Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. TMOFST is a string.
<INHMODE>
(Optional) Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). The parameter type is INH_MODE, which indicates whether the function is inhibited.
•
Function is allowed.
•
Function is inhibited.
21.76 RTRV-PMSCHED-ALL
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance Schedule All (RTRV-PMSCHED-ALL) command retrieves all the PM reporting schedules that were set for the NE by the SCHED-PMREPT command.
Usage Guidelines
None
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-PMSCHED-ALL:[<TID>]::<CTAG>;
Input ExampleRTRV-PMSCHED-ALL:CISCO-NODE::123;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],,
[<MONLEV>],<LOCN>,,[<TMPER>],<TMOFST>,[<INHMODE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,OC3:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW"
;Output Parameters
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2, which is the line/path modifier.
•
10 Gigabit Fibre Channel
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
D1 Video
•
DS-1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual Ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3c path
•
STS6c path
•
STS9c path
•
STS18c path
•
STS12c path
•
STS24c path
•
STS36c path
•
STS48c path
•
STS192c path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 path
•
VT2 path
<REPTINVL>
Reporting interval. How often a report is to be generated and sent to the appropriate NE. REPTINVL is a string.
<REPTDAT>
Report date. Date for the next report. REPTDAT is a string.
<REPTTM>
Report time. The time of day for the next PM report. REPTTM is a string.
<NUMINVL>
(Optional) The remaining number of intervals over which PM is to be reported. NUMINVL is an integer.
<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.
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24 hours. For SONET PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<TMOFST>
(Optional) Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. TMOFST is a string.
<INHMODE>
(Optional) Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). The parameter type is INH_MODE, which indicates whether the function is inhibited.
•
Function is allowed.
•
Function is inhibited.
21.77 RTRV-POS
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Packet Over SONET (RTRV-POS) command retrieves the back-end port information for the Ethernet card when the back-end port is working in POS mode.
Usage Guidelines
•
•
•
CategoryPorts
SecurityRetrieve
Input FormatRTRV-POS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-POS:TID:VFAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[ADMINSTATE=<ADMINSTATE>],[LINKSTATE=<LINKSTATE>],
[MTU=<MTU>],[ENCAP=<ENCAP>],[NAME=<NAME>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>]:<PST_PSTQ>,[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-1-1::ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,ENCAP=HDLC,
NAME=\"POSPORT\",SOAK=32,SOAKLEFT=\12-25\":OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<ADMINSTATE>
(Optional) Administration type. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<LINKSTATE>
(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<MTU>
(Optional) Maximum transmission unit. MTU is an integer.
<ENCAP>
Encapsulation. 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) 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:
•
•
•
<PST_PSTQ>
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 a 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 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.78 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
(Cisco ONS 15454) The Retrieve Protection Switch for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RTRV-PROTNSW-<MOD2DWDMPAYLOAD>) command retrieves the protection switch status of client facilities.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-PROTNSW-<MOD2DWDMPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-PROTNSW-HDTV:CISCO:FAC-1-1-1:100;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>:<SC>,[<SWITCHTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1:FRCD,MANWKSWBK"
;Output Parameters
<AIDUNIONID>
Access identifier from the "FACILITY" section.
<SC>
Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lockout of protection.
•
Lockout of working.
•
Manual switch of working unit back to working.
•
Manual switch of working unit back to the protection unit.
•
BLSR ring switch type.
•
BLSR span switch type.
21.79 RTRV-PROTNSW-<OCN_TYPE>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Protection Switch for OC3, OC12, OC48, or OC192 (RTRV-PROTNSW-<OSC_TYPE>) command retrieves the switching state of a SONET line specified in the AID.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryProtection
SecurityRetrieve
Input FormatRTRV-PROTNSW-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-PROTNSW-OC48:CISCO:FAC-5-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<SC>,[<SWITCHTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1:MAN,MANWKSWBK"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<SC>
Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lockout of protection.
•
Lockout of working.
•
Manual switch of working unit back to working.
•
Manual switch of working unit back to the protection unit.
•
BLSR ring switch type.
•
BLSR span switch type.
21.80 RTRV-PROTNSW-<PATH>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Protection Switch for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RTRV-PROTNSW-<PATH>) command retrieves the switching state of a SONET UPSR STS path specified in the AID. Because Telcordia GR-1400 does not allow LOCKOUT_OF_WORKING on the UPSR WORKING path/AID, the "AID:LOCKOUT,LOCKOUTOFWK" does not appear in this protection switch retrieval result.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryProtection
SecurityRetrieve
Input FormatRTRV-PROTNSW-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-PROTNSW-STS1:CISCO:STS-5-1-1:123;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:<SC>,[<SWITCHTYPE>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-5-1-1:MAN,MANWKSWBK"
;Output Parameters
<CROSSCONNECTID>
Access identifier from the "CrossConnectId" section.
<SC>
Switch command that is to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lockout of protection.
•
Lockout of working.
•
Manual switch of working unit back to working.
•
Manual switch of working unit back to the protection unit.
•
BLSR ring switch type.
•
BLSR span switch type.
21.81 RTRV-PROTNSW-OCH
(Cisco ONS 15454) The Retrieve Protection Switch Optical Channel (RTRV-PROTNSW-OCH) command retrieves the protection switch status of a TXPP_MR_2.5G card.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-PROTNSW-OCH:VA454-22:CHAN-2-2:100;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<SW>,<SWTYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2:FRCD,FRCDWKSWBK"
;Output Parameters
<AID>
Access identifier from the "CHANNEL" section.
<SW>
Indicates the switch operation. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
Indicates the switch type operation. The parameter type is SWITCH_TYPE, which is the BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lockout of protection.
•
Lockout of working.
•
Manual switch of working unit back to working.
•
Manual switch of working unit back to the protection unit.
•
BLSR ring switch type.
•
BLSR span switch type.
21.82 RTRV-PROTOCOL
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Protocol (RTRV-PROTOCOL) command retrieves the status of a protocol or service supported in the NE. Valid protocols include SHELL, EMS, TL1, and SNMP. If the AID is not specified, the status of all the protocols is retrieved.
Usage Guidelines
If the AID is TL1, the status can be retrieved to show if the protocol is in SECURE or UNSECURE mode.
CategorySecurity
SecurityRetrieve
Input FormatRTRV-PROTOCOL:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-PROTOCOL::EMS:123;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<PROTOCOLAID>:<PROTOCOLSTAT>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"EMS:UNSECURE"
;Output Parameters
21.83 RTRV-PTHTRC-<PATH>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Path Trace for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RTRV-PTHTRC-<PATJ>) command retrieves the contents of the SONET path trace message.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
The path trace message is a 64-character string with the last two characters reserved for the terminating CR (carriage return) and the LF (line feed). The message can be an incoming path trace message, an expected incoming path trace message, or an outgoing path trace message, which is inserted into the path overhead of the outgoing signal.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The path trace mode defaults to OFF mode. The MANUAL mode performs the comparison of the received string with the user-entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user-entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.
When the transmitted string is queried under the OFF, MANUAL, or AUTO path trace mode, the transmitted string is the provisioned transmit string.
Note
•
•
•
•
•
•
•
•
•
•
•
CategoryTroubleshooting and Test Access
SecurityRetrieve
Input FormatRTRV-PTHTRC-<PATH>:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>][:<LOCN>];
Input ExampleRTRV-PTHTRC-STS1:CISCO:STS-2-1-1:123::EXPTRC:NEND;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId" section. Must not be null.
<MSGTYPE>
Type of autonomous message to be retrieved. A null value defaults to INCTRC. The parameter type is MSGTYPE, which is the type of trace message.
•
Expected incoming path trace message
•
Incoming path trace message
•
Outgoing path trace message
<LOCN>
Location associated with a particular command in reference to the entity identified by the AID. 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.
Output FormatSID DATE TIME
M CTAG COMPLD
"<TRACMSG>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"TRACMSG"
;Output Parameters
21.84 RTRV-RMONTH-<MOD2_RMON>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA) The Retrieve Remote Monitoring Threshold for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, FSTE, G1000, GFPOS, GIGE, OCH, or POS (RTRV-RMONTH-<MOD2_RMON>) command retrieves the thresholds defined in the RMON alarm table.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-RMONTH-<MOD2_RMON>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],,,,
[<INTVL>]:[RISE=<RISE>],[FALL=<FALL>],[SAMPLE=<SAMPLE>],
[STARTUP=<STARTUP>][:];Input ExampleRTRV-RMONTH-GIGE:CISCO:FAC-2-1:1234::ETHERSTATSOCTETS,,,,100:RISE=1000,
FALL=100,SAMPLE=DELTA,STARTUP=RISING;Input Parameters
<AID>
Access identifier from the "FACILITY" section. AID for the facility that the data statistic is managed by. Must not be null.
<MONTYPE>
Monitored type. Type of RMON monitored data statistic. A null value is equivalent to ALL. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<INTVL>
The interval in seconds during which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds). A null value is equivalent to ALL.
<RISE>
The rising threshold for the sampled statistic. A valid value is any integer. A null value is equivalent to ALL
<FALL>
The falling threshold. A valid value is any integer smaller than the rising threshold. A null value is equivalent to ALL.
<SAMPLE>
The method of calculating the value to be compared to the thresholds. A null value is equivalent to ALL. The parameter type is SAMPLE_TYPE, which describes how the data will be calculated during the sampling period.
•
Comparing directly
•
Comparing with the current value of the selected variable subtracted by the last sample
<STARTUP>
Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. A null value is equivalent to ALL. The parameter type is STARTUP_TYPE, which indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold.
•
Generates the event when the sample is smaller than or equal to the falling threshold.
•
Generates the event when the sample is greater than or equal to the rising threshold.
•
Generates the event when the sample is crossing the rising threshold, or the falling threshold.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:<MONTYPE>,,,,<INTVL>:INDEX=<INDEX>,
RISE=<RISE>,FALL=<FALL>,SAMPLE=<SAMPLE>,STARTUP=<STARTUP>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,GIGE:ETHERSTATSOCTETS,,,,100:INDEX=2,RISE=1000,FALL=100,
SAMPLE=DELTA,STARTUP=RISING"
;Output Parameters
<AIDUNIONID>
Access identifier from the "FACILITY" section.
<AIDTYPE>
The type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2_RMON, which is the line modifiers.
•
10 Gigabit Fibre Channel
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
Fast Ethernet (10/100 Megabits per second)
•
Gigabit Ethernet (used for G1000 ports)
•
Generic framing protocol over SONET
•
Gigabit Ethernet (used for Non-G1000 ports)
•
Optical channel
•
Packet over SONET
<MONTYPE>
Monitored type. Type of RMON monitored data statistic. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<INTVL>
The interval in seconds over which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds).
<INDEX>
The index for the threshold created by the system in the RMON threshold table. INDEX is an integer.
<RISE>
The rising threshold for the sampled statistic. A valid value is any integer.
<FALL>
The falling threshold. A valid value is any integer smaller than the rising threshold. AID is an integer
<SAMPLE>
The method of calculating the value to be compared to the thresholds. The parameter type is SAMPLE_TYPE, which describes how the data will be calculated during the sampling period
•
Comparing directly
•
Comparing with the current value of the selected variable subtracted by the last sample
<STARTUP>
Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. The parameter type is STARTUP_TYPE, which indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold.
•
Generates the event when the sample is smaller than or equal to the falling threshold.
•
Generates the event when the sample is greater than or equal to the rising threshold.
•
Generates the event when the sample is crossing the rising threshold, or the falling threshold.
21.85 RTRV-ROLL-<MOD_PATH>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Roll for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VC11, VC12, VC3, VT1, or VT2 (RTRV-ROLL-<MOD_PATH>) command retrieves roll data parameters.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
CategoryBridge and Roll
SecurityRetrieve
Input FormatRTRV-ROLL-<MOD_PATH>:[<TID>]:<SRC>:<CTAG>;
Input ExampleRTRV-ROLL-STS1:CISCO:STS-1-1-1:6;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId1" section (except VCM and FACILITY). Roll path (STS or VT). Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],
VLDSIG=<VLDSIG>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-1-1-1,STS-2-1-1:RFROM=STS-2-1-1,RTO=STS-3-1-1,RMODE=AUTO,VLDSIG=N"
;Output Parameters
<FROM>
One of the termination points (legs) of the existing cross-connection. Access identifier from the "CrossConnectId1" section (except VCM and FACILITY).
<TO>
One of the termination points (legs) of the existing cross-connection. Access identifier from the "CrossConnectId1" section (except VCM and FACILITY).
<RFROM>
The termination point of the existing cross-connect that is to be rolled. AID from the "CrossConnectId1" section (except VCM and FACILITY).
<RTO>
The termination point that will become a leg of the new cross-connection. AID from the "CrossConnectId1" section (except VCM and FACILITY).
<RMODE>
(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.
<VLDSIG>
Shows whether or not the roll has received a valid signal. VLDSIG is Y if the signal is valid and N if it is not. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
21.86 RTRV-ROUTE
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Route (RTRV-ROUTE) command retrieves static routes.
Usage Guidelines
•
•
CategorySystem
SecurityRetrieve
Input FormatRTRV-ROUTE:[<TID>]::<CTAG>::[<DESTIP>],[<IPMASK>],[<NXTHOP>],[<COST>];
Input ExampleRTRV-ROUTE:CISCO::123::10.64.72.57,255.255.255.0,10.64.10.1,200;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
",:<DESTIP>,<IPMASK>,<NXTHOP>,<COST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
",:\"10.64.72.57\",\"255.255.255.0\",\"10.64.10.1\",200"
;Output Parameters
<DESTIP>
Destination tip. DESTIP is a string.
<IPMASK>
IP mask. IPMASK is a string.
<NXTHOP>
Next hop. NXTHOP is a string.
<COST>
Cost. COST is a string.
21.87 RTRV-ROUTE-GRE
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Route Generic Routing Encapsulation (RTRV-ROUTE-GRE) command displays the existing GRE tunnels.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-ROUTE-GRE:[<TID>]::<CTAG>[::::];
Input ExampleRTRV-ROUTE-GRE:CISCO::123;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
",:IPADDR=<IPADDR>,IPMASK=<IPMASK>,NSAP=<NSAP>,COST=<COST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
",:IPADDR=10.64.72.57,IPMASK=255.255.255.0,
NSAP=39840F80FFFFFF0000DDDDAA000010CFB4910200,COST=110"
;Output Parameters
21.88 RTRV-SLV-WDMANS
(Cisco ONS 15454) The Retrieve Span Loss Verification Wavelength Division Multiplexing Automatic Node Setup (RTRV-SLV-WDMANS) command retrieves the expected span loss verification provisioned by the ED-SLV-WDMANS command.
Usage Guidelines
None
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-SLV-WDMANS:VA454-22:WDMANS-E:116;
Input Parameters
<AID>
Access identifier from the "WDMANS" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[HIGHSLVEXP=<HIGHSLVEXP>],[LOWSLVEXP=<LOWSLVEXP>],
[SLVACT=<SLVACT>],[RESOLUTION=<RESOLUTION>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"WDMANS-E::HIGHSLVEXP=10.0,LOWSLVEXP=5.0,SLVACT=10.0,RESOLUTION=1.0:"
;Output Parameters
<AID>
Access identifier from the "WDMANS" section.
<HIGHSLVEXP>
(Optional) The high range value of the expected span loss verification. HIGHSLVEXP is a float.
<LOWSLVEXP>
(Optional) The low range value of the expected span loss verification. LOWSLVEXP is a float.
<SLVACT>
(Optional) The value of the calculated span loss verification. SLVACT is a float.
<RESOLUTION>
(Optional) The value of the resolution applied to the calculated span loss verification. RESOLUTION is a float.
21.89 RTRV-STS
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Synchronous Transport Signal (RTRV-STS) command retrieves the attributes associated with an STS path based on the granularity level of NE/SLOT-specific STSs.
Usage Guidelines
•
•
•
•
•
•
•
•
•
•
CategoryPaths
SecurityRetrieve
Input FormatRTRV-STS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-STS:TID:STS-2-1-1:1;
Input Parameters
<AID>
Access identifier from the "AidUnionId" section.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[UPSRPTHSTATE=<UPSRPTHSTATE>],
[C2=<C>],[BLSRPTHSTATE=<BLSRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-2-1-4::LEVEL=STS3C,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=SINGLE,
UPSRPTHSTATE=ACT,C2=0X04,BLSRPTHSTATE=PROTPTHACT:OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "AidUnionId" section.
<LEVEL>
(Optional) The rate of the cross-connect. Applicable only to STS paths in SONET. The parameter type is STS_PATH, which is the modifier for some STS commands.
•
Synchronous Transport Signal level 1 (51 Mbps)
•
Synchronous Transport Signal level 12 Concatenated (622 Mbps)
•
Synchronous Transport Signal level 18 Concatenated (933 Mbps)
•
Synchronous Transport Signal level 192 (9952 Mbps)
•
Synchronous Transport Signal level 24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal level 36 Concatenated (1866 Mbps)
•
Synchronous Transport Signal level 3 Concatenated (155 Mbps)
•
Synchronous Transport Signal level 48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal level 3 Concatenated (310 Mbps)
•
Synchronous Transport Signal level 9 Concatenated (465 Mbps)
<SFBER>
(Optional) An STS path SFBER that applies only to path protection and 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 SDBER that applies only to path protection and only to STS-level paths in SONET. Defaults to 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. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Only applies to path protection. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
Revertive time. RVTM is not allowed to be set while RVRTV is N. Only applies to path protection. 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 (STSn). 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. A 64-character ASCII string including the terminating CR (carriage return) and LF (line feed). Indicates the expected path trace message (J1) contents. Applicable only to STS-Level Paths in SONET. Defaults to null when path protection path is created.
<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 (STSn). TRC is a string.
<INCTRC>
(Optional) Identifies the incoming path trace message contents. Can be any combination of 64-characters. Applicable only to STS-level paths in SONET. Defaults to null when a path protection path is created. INCTRC is a string.
<TRCMODE>
(Optional) Path trace mode. Applicable only to STS-level Paths in SONET (STSn). 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 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.
<TACC>
(Optional) Indicates whether the digroup being provisioned is to be used as a test access digroup. Default is N. TACC is an integer.
<TAPTYPE>
(Optional) TAP type. 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.
<C>
(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 SPE
•
Locked VT Mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
<BLSRPTHSTATE>
(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 primary state (SST) and a primary state qualifier (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.90 RTRV-SYNCN
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Synchronization command retrieves the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources can be specified (for example, PRIMARY, SECOND, THIRD).
Usage Guidelines
•
•
CategorySynchronization
SecurityRetrieve
Input FormatRTRV-SYNCN:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-SYNCN:BOYES:SYNC-NE:234;
Input Parameters
<AID>
Access identifier from the "SYNC_REF" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>:<REF>,<REFVAL>,[<QREF>],[<STATUS>],[<PROTECTSTATUS>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE:PRI,FAC-1-2,WORK,ACT,PRS"
;Output Parameters
<AID>
Access identifier from the "SYNC_REF" section.
<REF>
Rank of synchronization reference. Access identifier from the "SYNCSW" section.
<REFVAL>
Value of a synchronization reference. "SYN_SRC" section.
<QREF>
(Optional) Indicates whether the working or protect card (in a protection group) provides timing. This parameter has no significance if the reference source is BITS or INTERNAL and is left blank. 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)
<STATUS>
(Optional) 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.
<PROTECTSTATUS>
(Optional) Applicable to 1+1. Designates the role of the entity in the protection group. Either it is the working or the protect entity. Not applicable to the ONS 15600 platform. 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.
21.91 RTRV-T1
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA) The Retrieve T1 Facility (RTRV-T1) command retrieves the DS-1 facilities configuration.
Usage Guidelines
•
•
CategoryPorts
SecurityRetrieve
Input FormatRTRV-T1:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-T1:TID:FAC-2-1:1223;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],[TACC=<TAP>],
[TAPTYPE=<TAPTYPE>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[NAME=<NAME>],[SYNCMSG=<SYNCMSG>],
[SENDDUS=<SENDDUS>],[RETIME=<RETIME>],[AISONLPBK=<AISONLPBK>],
[AISVONAIS=<AISVONAIS>],[AISONLOF=<AISONLOF>],[MODE=<MODE>],
[SYNCMAP=<SYNCMAP>],[ADMSSM=<ADMSSM>],[PROVIDESYNC=<PROVIDESYNC>],
[VTMAP=<VTMAP>],[INHFELPBK=<INHFELPBK>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1::LINECDE=AMI,FMT=ESF,LBO=0-131,TACC=8,TAPTYPE=DUAL,SOAK=52,
SOAKLEFT=12-25,SFBER=1E-4,SDBER=1E-7,NAME=\"T1 PORT\",SYNCMSG=Y,
SENDDUS=Y,RETIME=Y,AISONLPBK=AIS_ON_LPBK_ALL,AISVONAIS=Y,,AISONLOF=Y,
MODE=FDL,SYNCMAP=ASYNC,ADMSSM=STU,PROVIDESYNC=N,VTMAP=GR253,
INHFELPBK=N:OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<LINECDE>
(Optional) Line code. The parameter type is LINE_CODE.
•
Line code value is AMI.
•
Line code value is B8ZS.
<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. LBP is an integer. The parameter type is LINE_BUILDOUT.
•
Line buildout range is 0-131
•
Line buildout range is 132-262
•
Line buildout range is 263-393
•
Line buildout range is 394-524
•
Line buildout range is 525-655
<TAP>
(Optional) Defines the STS as a test access port with a selected unique TAP number. The TAP number is within a range of 0, 1 to 999. When TACC is 0 (zero), the TAP is deleted. Default is N.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<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. SOAKLEFT is a string. Rules for SOAKLEFT are as follows:
•
•
•
<SFBER>
(Optional) The 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) Port signal degrade threshold. Defaults to 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.
<NAME>
(Optional) Port name. NAME is a string.
<SYNCMSG>
Synchronization status messaging is enabled or disabled on the T1 facility.
Note
The parameter type is YES_NO, which is whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE.
•
No
•
Yes
<SENDDUS>
The facility will send the DUS value as the sync status message for that facility.
Note
The parameter type is YES_NO, which is whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE.
<RETIME>
(Optional) Indicates if retiming is needed.
Note
The parameter type is YES_NO, which is whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE.
•
No
•
Yes
•
Indicates the DS1 path of the DS3XM-12 is in FDL T1-403 mode.
<AISONLPBK>
(Optional) Defaults to AIS_ON_LPBK_ALL. The parameter type is AIS_ON_LPBK, which indicates if AIS is sent on a loopback
•
AIS is sent on facility loopbacks.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopbacks.
•
AIS is sent on terminal loopbacks.
<AISVONAIS>
(Optional) Defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<AISVONLOF>
(Optional) The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<MODE>
(Optional) Mode. Default value is FDL. The parameter type is DS1MODE, which is the DS1 path mode of the DS3XM-12 card
•
Indicates the DS1 path of the DS3XM-12 is in AT&T 54016 mode.
•
Indicates the DS1 path of the DS3XM-12 is in FDL T1-403 mode.
<SYNCMAP<
(Optional) The synchronous mapping for the DS1 facility. Defaults to ASYNC. Only supported on ONS 15454. The parameter type is SYNCMAP, which is the synchronous mapping type.
•
Asynchronous
•
Byte
•
Jbyte
<ADMSSM>
(Optional) The administrative synchronization status message. Only supported on the ONS 15454. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level.
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
<PROVIDESYNC>
(Optional) Indicates whether the facility provides synchronization. Only supported on ONS 15454. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<VTMAP>
(Optional) The port to VT mapping type for that particular STS. Only supported on ONS 15454. Defaults to GR253. The parameter type is VTMAP, which is the VT mapping.
•
Mapping based on Telcordia GR-253.
•
Mapping based on industry standard.
<INHFELPBK>
(Optional) Indicates whether far end loopbacks are inhibited on the facility. Only supported on ONS 15454. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<PST_PSTQ>
Primary state. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (SST) and a primary state qualifier (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. 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.92 RTRV-T3
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA) The Retrieve T3 (RTRV-T3) command retrieves the facility properties of a DS3 or a DS3XM card.
Usage Guidelines
•
•
•
•
•
•
CategoryPorts
SecurityRetrieve
Input FormatRTRV-T3:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-T3:CISCO:FAC-1-2:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[FMT=<FMT>],[LINECDE=<LINECDE>],[LBO=<LBO>],
[INHFELPBK=<INHFELPBK>],[TACC=<TAP>],[TAPTYPE=<TAPTYPE>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SFBER=<SFBER>],[SDBER=<SDBER>],
[NAME=<NAME>],[AISONLPBK=<AISONLPBK>]:<PST_PSTQ>,[<SSTQ>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-2::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225,INHFELPBK=N,TACC=8,
TAPTYPE=SINGLE,SOAK=52,SOAKLEFT=12-25,SFBER=1E-4,SDBER=1E-7,
NAME=\"T3 PORT\",AISONLPBK=AIS_ON_LPBK_ALL:OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<FMT>
(Optional) Digital signal format. The parameter type is DS_LINE_TYPE, which is the DS123 line type.
•
C-BIT line type applies to the DS3XM and DS3E cards.
•
M13 line type applies to the DS3XM and DS3E cards.
•
Line type is unframed. The old DS3 (L3M) and DS3CR cards can only run in unframed mode.
<LINECDE>
(Optional) Line code. The parameter type is DS_LINE_CODE, which is the DS123 line code.
•
Binary three-zero substitution.
<LBO>
(Optional) Line buildout settings. LBO is an integer. The parameter type is E_LBO, which is the electrical signal line buildout.
•
Electrical signal line buildout range is 0-225.
•
Electrical signal line buildout range is 226-450.
<INHFELPBK>
(Optional) Far-end loopback inhibition attribute of the port. If it is Y, the automatic far-end loopbacks are inhibited. It is either on or off. The system default is N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<TAP>
(Optional) Defines the STS as a test access port with a selected unique TAP number. The TAP number is within a range of 0, 1 to 999. When TACC is 0 (zero), the TAP is deleted. Default is N.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<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. SOAKLEFT is a string. Rules for <SOAKLEFT> are as follows:
•
•
•
<SFBER>
(Optional) The 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) Port signal degrade threshold. Defaults to 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.
<NAME>
(Optional) Port name. NAME is a string.
<AISONLPBK>
(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates if AIS is sent on a loopback.
•
AIS is sent on facility loopbacks.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopbacks.
•
AIS is sent on terminal loopbacks.
<PST_PSTQ>
Primary state. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (SST) and a primary state qualifier (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. 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.93 RTRV-TACC
(Cisco ONS 15454, ONS 15327, ONS 15310-MA, ONS 15600) The Retrieve Test Access (RTRV-TACC) command retrieves details associated with a TAP. The TAP is identified by the TAP number. The ALL input TAP value means that the command will return all the configured TACCs in the NE.
Usage Guidelines
None
CategoryTroubleshooting and Test Access
SecurityRetrieve
Input FormatRTRV-TACC:[<TID>]:<TAP>:<CTAG>;
Input ExampleRTRV-TACC:CISCO:241:CTAG;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<TAP>:<TACC_AIDA>,<TACC_AIDB>,[<MD>],[<CROSSCONNECTID1>],
<AIDUNIONID>,<PATHWIDTH>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"241:STS-2-1-1,STS-2-1-2,MONE,STS-12-1-1,STS-13-1-1,STS1"
;Output Parameters
<TAP>
The assigned number for the AID being used as a test access point. TAP is an integer.
<TACC_AIDA>
Access identifier from the "CrossConnectId" section. The A path of the test access point. The first STS/VT path of the TAP.
<TACC_AIDB>
Access identifier from the "CrossConnectId" section. The B path of the test access point. The second STS/VT path of the TAP. For single FAD TAP this path will be empty.
<MD>
(Optional) Test access mode. It identifies the mode of access between the TAP and the circuit connected to the TAP. The parameter type is TACC_MODE, which is the test access mode.
•
Indicates to split both the A and B paths. Connect the line incoming from E direction to the line outgoing in the E direction, and connect this looped configuration to the FAD. The line outgoing in the F direction will have a QRS connected, and the line incoming from the F direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
•
Indicates to split both the A and B paths. Connect the line incoming from F direction to the line outgoing in the F direction, and connect this looped configuration to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
•
Indicates that a monitor connection is to be provided from the FAD to the A transmission path of the accessed circuit.
•
Indicates that a monitor connection is to be provided from the FAD1 to a DFAD, or from the odd pair of a FAP to the A transmission path and from FAD2 of the same DFAD, or from the even pair of a FAP to the B transmission path of the accessed circuit.
•
Indicates that a monitor connection is to be provided from the FAD to the B transmission path of the accessed circuit.
•
Indicates that a connection is to be provided from both the E and F sides of the A transmission path of the circuit under test to the FAD and split the A transmission path. Intrusive test access mode.
•
Indicates that a connection is to be provided from both the E and F sides of the B transmission path of the circuit under test to the FAD and split the B transmission path. Intrusive test access mode.
•
Indicates to split both the A and B paths and connect the E side of the accessed circuit to the FAD. The line outgoing in the F direction shall have a QRS connected, and the line incoming from the F direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
•
Indicates to split both the A and B paths, and connect the E side of the accessed circuit to FAD1 and the F side to FAD2. Intrusive test access mode.
•
Indicates to split both the A and B paths, and connect the F side of the accessed circuit to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
<CROSSCONNECTID1>
(Optional) Access identifier from the "CrossConnectId" section. The E path of the cross-connect.
<PATHWIDTH>
The cross-connection width. The parameter type is CRS_TYPE, which is the cross-connection type.
•
Indicates all the STS cross-connections.
•
STS1 cross-connect
•
STS3C cross-connect
•
STS6C cross-connect
•
STS9C cross-connect
•
STS12C cross-connect
•
STS18C cross-connect
•
STS24C cross-connect
•
STS36C cross-connect
•
STS48C cross-connect
•
STS192C cross-connect
•
Indicates all the VT1 cross-connections.
•
VT1 cross-connect
•
VT2 cross-connect
<CROSSCONNECTID2>
(Optional) Access identifier from the "CrossConnectId" section. The F path of the cross-connect.
21.94 RTRV-TADRMAP
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Target Identifier Address Mapping (RTRV-TADRMAP) command retrieves the contents of the TADRMAP table.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-TADRMAP:[<TID>]:[<AID>]:<CTAG>[:::MODE=<MODE>];
Input ExampleRTRV-TADRMAP:CISCO:AIP:100:::MODE=PROV;
Additional input examples:
1.
RTRV-TADRMAP:NODE-2:NODE-1:1:::MODE=NSAP;
Output example:
NODE-2 2006-01-26 14:47:30
M 1 COMPLD
"TIDNAME=NODE-1,NSAP=TARP request has been initiated. Check again later."
;
RTRV-TADRMAP:NODE-2::123;
NODE-2 2006-01-26 14:47:38
M 123 COMPLD
"TIDNAME=NODE-2,IPADDR=10.92.24.146,"
"TIDNAME=NODE-1,NSAP=39840F800000000000000000010010CFCE5A0200"
;
2.
RTRV-TADRMAP:NODE-2:NODE-2:1:::MODE=NSAP;
Output example:
NODE-2 2006-01-26 14:48:07
M 1 COMPLD
"TIDNAME=NODE-2,NSAP=39840F80000000000000000001000BFCF8A88500"
;
3.
RTRV-TADRMAP:NODE-2::123:::MODE=NSAP;
Output example:
NODE-2 2006-01-26 13:47:38
M 123 COMPLD
"TIDNAME=FOREIGN-NODE-1,NSAP=39840F80000000000000000001000075DE520800"
"TIDNAME=FOREIGN-NODE-2,NSAP=39840F80000000000000000001000075D07A4A00"
"TIDNAME=NODE-1,NSAP=39840F800000000000000000010010CFCE5A0200"
;
Input Parameters
<AID>
Access identifier from the "ALL" section. Must not be null.
<MODE>
Must not be null. The parameter type is MODE, which determines the category of addresses to return.
•
Discovered and provisioned addresses
•
Discovered addresses
•
IP addresses
•
NSAP addresses
•
Provisioned
Output FormatSID DATE TIME
M CTAG COMPLD
"[TID=<TID>],[IP ADDRESS =<IPADDRESS>],[NSAP=<NSAP>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"TID=RANGERS1,IP ADDRESS = 64.101.245.5,
NSAP=39840FFFFFFFOOOODDDDAA01D00F0400000700"
;Output Parameters
<TID>
(Optional) Target identifier. TID is a string.
<IPADDRESS>
(Optional) IP address. IPADDRESS is a string.
<NSAP>
(Optional) NSAP address. NSAP is a string.
21.95 RTRV-TH-<MOD2>
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Threshold for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VT1, or VT2 (RTRV-TH-<MOD2>) command retrieves the threshold level of one or more monitored parameters.
Usage Guidelines
See Table 27-1 for supported modifiers by platform.
Note
•
•
•
–
–
•
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],[<TMPER>][::];
Input ExampleRTRV-TH-T3:CISCO:FAC-1-3:1234::CVL,NEND,15-MIN;
Input Parameters
<AID>
Access identifier from the "ALL" section. Must not be null.
<MONTYPE>
Monitored type.
Note
A null value is equivalent to ALL. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<LOCN>
Location associated with a particular command in reference to the entity identified by the AID. LOCN defaults to NEND (near end). A null value is equivalent to ALL. 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.
<TMPER>
Accumulation time period for performance counters. Defaults to 15-MIN. Must not be null. The parameter type is TMPER, which is the accumulation time period for the performance management center
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,[<LOCN>],,<THLEV>,[<TMPER>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-3,DS3:CVL,NEND,,1,15-MIN"
;Output Parameters
<AID>
Access identifier from the "ALL" section. Must not be null.
<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 alarm
•
1 Gigabit FICON alarm
•
2 Gigabit Fibre Channel alarm
•
2 Gigabit FICON alarm
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
GIG Ethernet port alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS18c alarm
•
STS12c alarm
•
STS24c alarm
•
STS36c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
XTC alarm (ONS 15327)
<MONTYPE>
Monitored type. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage.
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B- Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<LOCN>
(Optional) Location associated with a particular command. 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.
<THELV>
Threshold level. THLEV is a float.
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24-hours. For SONET PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
21.96 RTRV-TH-ALL
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Threshold All (RTRV-TH-ALL) command retrieves the threshold level of all monitored parameters on the NE.
Usage Guidelines
•
•
•
•
•
•
CategoryPerformance
SecurityRetrieve
Input FormatRTRV-TH-ALL:[<TID>]::<CTAG>::[<MONTYPE>],[<LOCATION>],[<TMPER>][::];
Input ExampleRTRV-TH-ALL:CHARGERS6::123::CVL,NEND,15-MIN;
Input Parameters
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>:<MONTYPE>,<LOCATION>,,<THLEV>,<TMPER>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1,DS3:CVL,NEND,,1,15-MIN"
;Output Parameters
<AID>
Access identifier from the "AidUnionId" section.
<AIDTYPE>
Specifies the type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type for certain generic TL1 commands.
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS1 alarm
•
DS3I alarm
•
E100 alarm
•
E1000 alarm
•
EC1 alarm
•
ENV alarm
•
EQPT alarm
•
Fibre Channel alarm
•
FSTE alarm
•
G1000 alarm
•
GIGE alarm
•
ISC3PEER1G alarm
•
ISC3PEER2G alarm
•
ISC3PEER2R alarm
•
ISCCOMPAT alarm
•
MIC alarm (ONS 15327)
•
MIC-EXT Alarm (ONS 15327)
•
OC3 alarm
•
OC12 alarm
•
OC48 alarm
•
OC192 alarm
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS alarm
•
STS1 alarm
•
STS3c alarm
•
STS6c alarm
•
STS9c alarm
•
STS12c alarm
•
STS18c alarm
•
STS24c alarm
•
STS48c alarm
•
STS192c alarm
•
SYNCN alarm
•
T1 alarm
•
T3 alarm
•
TCC alarm
•
VT1 alarm
•
VT2 alarm
•
ONS 15327 XTC alarm
<MONTYPE>
Monitored type. A null value defaults to ALL. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VT Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High Order Path Negative Pointer Justification Count
•
High Order Path, Negative Pointer Justification Count
•
Outage Intensity
•
High Order Path Pointer Justification Count Difference
•
High Order Path Pointer Justification Count
•
High Order Path Pointer Justification Count Seconds
•
High Order Path Positive Pointer Justification Count
•
High Order Path, Positive Pointer Justification Count
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias current in microA
•
Maximum Laser Bias current in microA
•
Minimum Laser Bias current in microA
•
Normalized Laser Bias Current for OC3-8
•
Laser Bias Current
•
Laser Bias Current
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
PPJC-PDET:Negative Pointer Justification
•
PPJC-PGEN:Negative Pointer Justification
•
Average Receive Power in one tenth of a microW
•
Maximum Receive Power in one tenth of a microW
•
Minimum Receive Power in one tenth of a microW
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microW
•
Maximum Transmit Power in one tenth of a microW
•
Minimum Transmit Power in one tenth of a microW
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
PPJC-PDET:Positive Pointer Justification
•
PPJC-PGEN:Positive Pointer Justification
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VT Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VT Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<LOCATION>
The location. A null value defaults to NEND. 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.
<THLEV>
Threshold level. Indicates the threshold value. THLEV is a float.
<TMPER>
The accumulation time period for performance counters. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management counter.
•
Performance parameter accumulation interval length is every 24 hours.
•
Performance parameter accumulation interval length is every 1 hour.
•
Performance parameter accumulation interval length is every 1 minute.
•
Performance parameter accumulation interval length is every 15 minutes.
•
Performance parameter accumulation interval length starts from the last time the counters were cleared. This is only applicable to RMON-managed PMs.
21.97 RTRV-TOD
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Time of Day (RTRV-TOD) command retrieves the system date and time at the instant when the command was executed. The time returned is in Coordinated Universal Time (UTC).
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-TOD:[<TID>]::<CTAG>;
Input ExampleRTRV-TOD:CAZADERO::230;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,<DIFFERENCE>:<TMTYPE>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"2002,05,08,17,01,33,840:LINT"
;Output Parameters
21.98 RTRV-TRAPTABLE
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Trap Table (RTRV-TRAPTABLE) command retrieves a trap destination entry identified by a specific trap destination address.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-TRAPTABLE:[<TID>]:[<AID>]:<CTAG>;
Input ExampleRTRV-TRAPTABLE::1.2.3.4:1;
Input Parameters
<AID>
Access identifier from the "IPADDR" section. IP address identifying the trap destination. Only a numeric IP address is allowed. A null value is equivalent to ALL.
Output FormatSID DATE TIME
M CTAG COMPLD
"<DEST>,<TRAPPORT>,<COMMUNITY>,<SNMPVERSION>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"1.2.3.4,162,\"PRIVATE\",SNMPV1"
;Output Parameters
<DEST>
Access identifier from the "IPADDR" section.
<TRAPPORT>
UDP port number associated with the trap destination. Defaults to 162. Integer
<COMMUNITY>
Community name associated to the trap destination. Maximum of 32 characters. COMMUNITY is a string.
<SNMPVERSION>
SNMP version number. Defaults to SNMPv1. The parameter type is SNMP_VERSION, which is the SNMP version.
•
SNMP version 1 (default)
•
SNMP version 2
21.99 RTRV-TRC-<OCN_BLSR>
(Cisco ONS 15454, ONS 15327, ONS 15600) The Retrieve Trace Client for OC12, OC192, or OC48 (RTRV-TRC-<OCN_BLSR>) command retrieves the valid J1 expected trace string, retrieved trace string, trace mode, C2 byte, and STS bandwidth of the OC-N port only if the port has a BLSR.
Usage Guidelines
•
•
•
CategoryBLSR
SecurityRetrieve
Input FormatRTRV-TRC-<OCN_BLSR>:[<TID>]:<AID>:<CTAG>[::::];
Input ExampleRTRV-TRC-OC48:CISCO:FAC-6-1:238;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[C2=<C2>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-6-1-25::LEVEL=STS1,EXPTRC="EXPTRCSTRING",INCTRC="INCTRCSTRING",
TRCMODE=AUTO,C2=0X04"
;Output Parameters
<AID>
Access identifier from the "STS" section.
<LEVEL>
(Optional) The rate of the cross-connect. The parameter type is STS_PATH, which is the modifier for some STS commands.
•
Synchronous Transport Signal level 1 (51 Mbps)
•
Synchronous Transport Signal level 12 Concatenated (622 Mbps)
•
Synchronous Transport Signal level 18 Concatenated (933 Mbps)
•
Synchronous Transport Signal level 192 (9952 Mbps)
•
Synchronous Transport Signal level 24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal level 36 Concatenated (1866 Mbps)
•
Synchronous Transport Signal level 3 Concatenated (155 Mbps)
•
Synchronous Transport Signal level 48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal level 3 Concatenated (310 Mbps)
•
Synchronous Transport Signal level 9 Concatenated (465 Mbps)
<EXPTRC>
(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). EXPTRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters including CR and LF. INCTRC is a string.
<TRCMODE>
(Optional) Trace 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 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
<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 SPE
•
Locked VT Mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
21.100 RTRV-TRC-OCH
(Cisco ONS 15454) The Retrieve Trace Optical Channel (RTRV-TRC-OCH) command retrieves the sent trace string, expected trace string, received trace string, trace mode, and the trace level for the SONET J0 Section, the TTI PATH and SECTION monitoring levels of the DWDM facility.
Usage Guidelines
The following rules apply:
•
•
•
•
•
•
Depending on the settings, the following filtering applies:
•
•
•
•
CategoryDWDM
SecurityRetrieve
Input FormatRTRV-TRC-OCH:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];
Input ExampleRTRV-TRC-OCH:CISCO:CHAN-2-2:100::EXPTRC,TTI-PM;
Input Parameters
<SRC>
Access identifier from the "CHANNEL" section. Must not be null.
<MSGTYPE>
Type of autonomous message to be retrieved. A null value is equivalent to ALL. The parameter type is MSGTYPE, which is the type of trace message.
•
Expected incoming path trace message
•
Incoming path trace message
•
Outgoing path trace message
<TRCLEVEL>
The trace level to be managed. A null value is equivalent to ALL. The parameter type is TRCLEVEL, which is the trace mode options.
•
Identifies the SONET J0 Section trace level
•
Identifies the TTI Path monitoring point
•
Identifies the TTI Section monitoring point
Output FormatSID DATE TIME
M CTAG COMPLD
"<CHANNEL>,<MOD>::[TRCLEVEL=<TRCLEVEL>],[EXPTRC=<EXPTRC>],
[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,OCH::TRCLEVEL=TTI-PM,EXPTRC=\"AAA\",TRC=\"AAA\",
INCTRC=\"AAA\",TRCMODE=MAN,TRCFORMAT=64-BYTE"
;Output Parameters
<CHANNEL>
Access identifier from the "CHANNEL" section.
<MOD>
Indicates an OCH AID type. The parameter type is MOD2, which is the line/path modifier.
•
10 Gigabit Fibre Channel
•
10 Gigabit Ethernet
•
1 Gigabit Fibre Channel
•
1 Gigabit FICON
•
1 Gbps ISC3 compatible
•
2 Gigabit Fibre Channel
•
2 Gigabit FICON
•
2 Gbps ISC3 compatible
•
4 Gbps Fibre Channel
•
4 Gbps fiber connection
•
D1 video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
EC1 facility
•
ESCON
•
ETRCLO
•
FSTE facility
•
G1000 facility
•
GFP over packet over SONET. Virtual Ports partitioned using GFP's multiplexing capability.
•
GIG Ethernet
•
HDTV
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
ISC3PEER1G
•
ISC3PEER2G
•
ISC3PEER2R
•
ISCCOMPAT
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
Optical Channel
•
OCH channel connection
•
OCH network connection
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STS1 path
•
STS3c path
•
STS6c path
•
STS9c path
•
STS18c path
•
STS12c path
•
STS24c path
•
STS36c path
•
STS48c path
•
STS192c path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 path
•
VT2 path
<TRCLEVEL>
(Optional) The trace level to be managed. The parameter type is TRCLEVEL, which is the trace mode options.
•
Identifies the SONET J0 Section trace level.
•
Identifies the TTI Path monitoring point.
•
Identifies the TTI Section monitoring point.
<EXPTRC>
(Optional) Expected path trace content. A 64 character ASCII string.
<TRC>
(Optional) The path trace message to be transmitted. The trace byte continuously transmits a 64 byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. TRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is a string.
<TRCMODE>
(Optional) Trace 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 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) The size of the trace message. If in SONET/SDH mode, only 1 or 16 bytes is applicable for the J0 section trace. The TTI level trace is only 64 bytes. The parameter type is TRCFORMAT (trace format).
•
1 byte trace message
•
16 byte trace message
•
64 byte trace message
•
Enable an attribute.
21.101 RTRV-TUNNEL-FIREWALL
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Tunnel Firewall (RTRV-TUNNEL-FIREWALL) command retrieves the contents of the firewall tunnel table.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-TUNNEL-FIREWALL:[<TID>]::<CTAG>;
Input ExampleRTRV-TUNNEL-FIREWALL:TID::CTAG;
Input ParametersNone that require description
Output FormatSID DATE TIME
M CTAG COMPLD
"[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>],
[DEST MASK=<DESTMASK>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7,
DEST MASK=255.255.255.0"
;Output Parameters
21.102 RTRV-TUNNEL-PROXY
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Tunnel Proxy command retrieves the contents of the proxy tunnel table.
Usage Guidelines
None
CategorySystem
SecurityRetrieve
Input FormatRTRV-TUNNEL-PROXY:[<TID>]::<CTAG>;
Input ExampleRTRV-TUNNEL-PROXY:TID::CTAG;
Input ParametersNone that require descriptions
Output FormatSID DATE TIME
M CTAG COMPLD
"[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>],
[DEST MASK=<DESTMASK>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7,
DEST MASK=255.255.255.0"
;Output Parameters
21.103 RTRV-USER-SECU
(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve User Security (RTRV-USER-SECU) command retrieves the security information of a specified user or list of users. The keyword ALL can be used to obtain a list of all users. For security reasons the password cannot be retrieved.
Usage Guidelines
A Superuser can retrieve any user's security information. A user with MAINT, PROV, or RTRV privileges can only retrieve their own information.
Note
CategorySecurity
SecurityRetrieve
Note
Input FormatRTRV-USER-SECU:[<TID>]:<UID>:<CTAG>;
Input ExampleRTRV-USER-SECU::CISCO15:1;
Input Parameters
<UID>
User identifier. The user ID or the keyword ALL. A non-Superuser can only specify his own user ID. Must not be null. UID is a string.
Output FormatSID DATE TIME
M CTAG COMPLD
"<UID>:,<PRIVILEGE>:LOGGEDIN=<LOGGEDIN>,[NUMSESSIONS=<NUMSESS>,]
[LOCKEDOUT=<LOCKEDOUT>,][DISABLED=<DISABLED>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"CISCO15:,SUPER:LOGGEDIN=YES,NUMSESSIONS=1,LOCKEDOUT=NO,DISABLED=NO"
;Output Parameters
21.104 RTRV-VCG
(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA) The Retrieve Virtual Concatenation Group (RTRV-VCG) command retrieves all the attributes provisioned for a VCG.
Usage Guidelines
None
CategoryVCAT
SecurityRetrieve
Input FormatRTRV-VCG:[<TID>]:<SRC>:<CTAG>[::::];
Input ExampleRTRV-VCG:NODE1:FAC-1-1:1234;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<SRC>::TYPE=<TYPE>,TXCOUNT=<TXCOUNT>,CCT=<CCT>,[LCAS=<LCAS>],
[BUFFERS=<BUFFERS>],[NAME=<NAME>]:<PST>"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::TYPE=STS3C,TXCOUNT=8,CCT=2WAY,LCAS=LCAS,BUFFERS=DEFAULT,
NAME="VCG2":IS"
;Output Parameters
<SRC>
Source access identifier from the "FACILITY" section. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID.
<TYPE>
The type of the entity being provisioned. Null indicates not applicable. TYPE can be a CLEI code or another value. The type of member cross-connect. ML1000-2 and ML100T-12 cards support STS1, STS3c, and STS12c. The FC_MR-4 card supports STS3c only. The parameter type is MOD_PATH, which is the STS/VT path modifier.
•
STS1 path
•
STS12c path
•
STS18c path
•
STS192c path
•
STS24c path
•
STS36c path
•
STS3c path
•
STS48c path
•
STS6c path
•
STS9c path
•
VT1 path
•
VT2 path
<TXCOUNT>
Number of VCG members in the transmit (Tx) direction. For ML1000-2 and ML100T-12 cards, the only valid value is 2. For the FC_MR-4 card, the only valid value is 8. TXCOUNT is an integer.
<CCT>
Type of connection; one-way or two-way. Cross-connect type for the VCG member cross-connects. The parameter type is CCT, which is the type of cross-connect to be created.
•
A unidirectional connection from a source tributary to a destination tributary
•
Path protection multicast drop with 1-way continue
•
Path protection multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A bidirectional drop and continue connection applicable only to path protection traditional and integrated dual-ring interconnects
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (BLSR PCA diagnostics cross-connect).
<LCAS>
(Optional) Link capacity adjustment scheme. The parameter type is LCAS, which is the link capacity adjustment scheme mode for the VCG created.
•
LCAS is enabled.
•
No LCAS.
•
Supports the temporary removal of a VCG member during the member failure. Only supported by the ML1000-2 and ML100T-12 cards.
<BUFFERS>
(Optional) Buffer type. The default value is DEFAULT. The FC_MR-4 card supports DEFAULT and EXPANDED buffers. Other data cards support DEFAULT buffers only. The parameter type is BUFFER_TYPE, which is the buffer type (used in VCAT).
•
Default buffer value
•
Expanded buffer value
<NAME>
(Optional) Name of the VCAT group. NAME is a string.
<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.105 RTRV-VT
(Cisco ONS 15454) The Retrieve Virtual Tributary (RTRV-VT) command retrieves the attributes associated with a VT path based on the granularity level of NE- or slot-specific VTs.
Usage Guidelines
•
<VT GROUP>-<VT NUMBER>.•
CategoryPaths
SecurityRetrieve
Input FormatRTRV-VT:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-VT:TID:VT1-1-1-1-1:1;
Input Parameters
<AID>
Access identifier from the "AidUnionId" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],
[HOLDOFFTIMER=<HOLDOFFTIMER>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[UPSRPTHSTATE=<UPSRPTHSTATE>]:[<PST>],[<SST>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"VT1-1-1-1-1-1::LEVEL=VT1,RVRTV=Y,RVTM=1.0,HOLDOFFTIMER=2000,TACC=8,
TAPTYPE=SINGLE,UPSRPTHSTATE=ACT:OOS,AINS"
;Output Parameters
<AID>
Access identifier from the "AidUnionId" section.
<LEVEL>
(Optional) The rate of the cross-connect. Indicates the rate of the cross-connected channel. Applicable only to VT1 path in SONET. The parameter type is VT_PATH, which is the modifier for some VT commands.
•
Virtual Tributary 1
•
Virtual Tributary 2
<RVRTV>
(Optional) Revertive mode. Only applies to path protection. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RVTM>
(Optional) Revertive time. Only applies to path protection. Defaults to empty because RVRTV is N when a path protection path is created. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<HOLDOFFTIMER>
(Optional) Hold off timer. HOLDOFFTIMER is an integer.
<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 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.
<PST>
Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In Service
•
Out of Service
<SST>
Secondary state. 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.106 RTRV-WDMANS
(Cisco ONS 15454) The Retrieve Wavelength Division Multiplexing Automatic Node Setup (RTRV-WDMANS) command edits the automatic optical node setup (AONS) application attributes.
Usage Guidelines
None
CategoryDWDM
SecurityMaintenance
Input FormatRTRV-WDMANS:[<TID>]:<AID>:<CTAG>;
Input ExampleRTRV-WDMANS:PENNGROVE:WDMANS-W:114;
Input Parameters
<AID>
Access identifier from the "WDMANS" section. Must not be null.
Output FormatSID DATE TIME
M CTAG COMPLD
"<AID>::[POWERIN=<POWERIN>],[POWEROUT=<POWEROUT>],
[POWEREXP=<POWEREXP>],[NTWTYPE=<NTWTYPE>],
[OPTICALTYPE=<OPTICALTYPE>],[LASTRUNDAT=<LASTRUNDAT>],
[LASTRUNTM=<LASTRUNTM>]"
;Output ExampleTID-000 1998-06-20 14:30:00
M 001 COMPLD
"WDMANS-W::POWERIN=10.0,POWEROUT=10.0,POWEREXP=10.0,
NTWTYPE=METRO-CORE,OPTICALTYPE=OADM,LASTRUNDAT=01-01-01,
LASTRUNTM=10-55-00"
;Output Parameters
<AID>
Access identifier from the "WDMANS" section.
<POWERIN>
(Optional) Input power for an OADM section of an OADM NE. POWERIN is a float.
<POWEROUT>
(Optional) Output power for an OADM or multiplex/demultiplex section of HUB, TERMINAL, or OADM nodes. POWEROUT is a float.
<POWEREXP>
(Optional) Express power for a multiplex/demultiplex section of a HUB or TERMINAL NE. POWEREXP is a float.
<NTWTYPE>
(Optional) Type of network with DWDM node installed. The parameter type is DWDM_RING_TYPE, which is the network type where NE is installed.
•
The network where a DWDM node is installed is a metro access network.
•
The network where a DWDM node is installed is a metro core network.
•
A node that does not have a standard DWDM configuration.
<OPTICALTYPE>
(Optional) The optical configuration type for the NE. The parameter type is OPTICAL_NODE_TYPE, which is the optical configuration types for NEs.
•
A terminal site, EAST, WEST, or both with 32 channel multiplex/demultiplex card.
•
A line site with booster card.
•
A site with OADM cards.
•
An OSC regeneration site with only 2 OSC-CSM cards in both sides.
•
A site with ROADM cards.
•
A time-division multiplexing (TDM) node with an amplifier directly connected to a TXP/MXP card.
•
The node type is undefined.
<LASTRUNDAT>
(Optional) The last date when the WDMANS application was run automatically or by user request. The format is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<LASTRUNTM>
(Optional) The last time when the WDMANS application was run automatically or by user request. The format is HH-MM, where HH (hour of day) ranges from 1 to 23 and MM (minute of hour) ranges from 0 to 59.
Posted: Mon Oct 29 09:05:40 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
