RTRV Commands
This chapter provides RTRV (retrieve) commands for the Cisco ONS 15454 SDH.
21.1 RTRV-<MOD1FCPAYLOAD>
Retrieve (1GFC, 2GFC)
Usage Guidelines
This command retrieves the attributes related with the Fibre Channel port.
See Table 27-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Input Format
RTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
Table 21-1 RTRV-<MOD1FCPAYLOAD> Input Parameters
|
|
AID |
Access identifier from the "FACILITY" section. Must not be null |
Input Example
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:LINKRATE=<LINKRATE>,LINKSTATE=<LINKSTATE>,
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,[<SST>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFC,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,
NAME=\"FC PORT\",SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,
LOSSB=LR-1:LOCKED-ENABLED,MAINTENANCE"
;
Output Parameters
Table 21-2 RTRV-<MOD1FCPAYLOAD> Output Parameters
|
|
AID |
Access identifier from the "FACILITY" section |
ROLE |
The port role in a Y-cable protection scheme. Optional Parameter type is SIDE—the role the unit is playing in the protection group |
• PROT |
The entity is a protection unit in the protection group |
• WORK |
The entity is a working unit in the protection group |
STATUS |
Port status in a Y-cable protection scheme. Optional Parameter type is STATUS—the status of the unit in the protection pair |
• ACT |
The entity is the active unit in the shelf |
• NA |
Status is unavailable |
• STBY |
The entity is the standby unit in the shelf |
LINKRATE |
The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned Parameter type is LINKRATE—the link rate on a Fibre Channel port |
• 1GFC |
The rate is 1 G Fibre Channel |
• 1GFICON |
The rate is 1 G FICON |
• 2GFC |
The rate is 2 G Fibre Channel |
• 2GFICON |
The rate is 2 G FICON |
• UNKNOWN |
The rate is unknown |
• UNPLUGGED |
The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected |
LINKSTATE |
Link state Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter |
• DN |
Monitored parameter with values equal to or greater than the level of LEV will be reported |
• UP |
Monitored parameter with values equal or less than the value of LEV will be reported |
LINKRCVRY |
Link recovery Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
DISTEXTN |
Distance extension. Optional Parameter type is DISTANCE_EXTENSION—distance extension |
• B2B |
Buffer to buffer flow control |
• NONE |
No distance extension |
LINKCREDITS |
Number of link credits. Integer. Optional |
MFS |
Maximum frame size. Integer. Optional |
ENCAP |
Frame encapsulation type. Optional Parameter type is ENCAP—frame encapsulation type |
• GFP_F |
GFP frame mode |
• GFP_T |
GFP transparent mode |
• HDLC |
HDLC frame mode |
• HDLC_LEX |
HDLC LAN extension frame mode |
• HDLC_X86 |
HDLC X.86 frame mode |
NAME |
Identifies the port name. String. Optional |
SOAK |
Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Integer. Optional |
SOAKLEFT |
Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional Rules for <SOAKLEFT> are as follows: • When the port is in Locked, Locked_Maintenance or Unlocked state, the parameter will not appear. • When the port is in Locked_AutomaticInService, but the countdown has not started due to fault signal the value will be SOAKLEFT=NOT-STARTED. • When the port is in Locked_AutomaticInService state and the countdown has started the value will be shown in HH-MM format. |
FREQ |
Parameter type is OPTICAL_WLEN—optical wavelength |
• 1310 |
Wavelength 1310 |
• 1470 |
Wavelength 1470 |
• 1490 |
Wavelength 1490 |
• 1510 |
Wavelength 1510 |
• 1529.55 |
Wavelength 1529.55 |
• 1529.94 |
Wavelength 1529.94 |
• 1530 |
Wavelength 1530 |
• 1530.33 |
Wavelength 1530.33 |
• 1530.73 |
Wavelength 1530.73 |
• 1531.12 |
Wavelength 1531.12 |
• 1531.51 |
Wavelength 1531.51 |
• 1531.90 |
Wavelength 1531.90 |
• 1532.29 |
Wavelength 1532.29 |
• 1532.68 |
Wavelength 1532.68 |
• 1533.07 |
Wavelength 1533.07 |
• 1533.47 |
Wavelength 1533.47 |
• 1533.86 |
Wavelength 1533.86 |
• 1534.25 |
Wavelength 1534.25 |
• 1534.64 |
Wavelength 1534.64 |
• 1535.04 |
Wavelength 1535.04 |
• 1535.43 |
Wavelength 1535.43 |
• 1535.82 |
Wavelength 1535.82 |
• 1536.22 |
Wavelength 1536.22 |
• 1536.61 |
Wavelength 1536.61 |
• 1537 |
Wavelength 1537 |
• 1537.40 |
Wavelength 1537.40 |
• 1537.79 |
Wavelength 1537.79 |
• 1538.19 |
Wavelength 1538.19 |
• 1538.58 |
Wavelength 1538.58 |
• 1538.98 |
Wavelength 1538.98 |
• 1539.37 |
Wavelength 1539.37 |
• 1539.77 |
Wavelength 1539.77 |
• 1540.16 |
Wavelength 1540.16 |
• 1540.56 |
Wavelength 1540.56 |
• 1540.95 |
Wavelength 1540.95 |
• 1541.35 |
Wavelength 1541.35 |
• 1541.75 |
Wavelength 1541.75 |
• 1542.14 |
Wavelength 1542.14 |
• 1542.35 |
Wavelength 1542.35 |
• 1542.54 |
Wavelength 1542.54 |
• 1542.94 |
Wavelength 1542.94 |
• 1543.33 |
Wavelength 1543.33 |
• 1543.73 |
Wavelength 1543.73 |
• 1544.13 |
Wavelength 1544.13 |
• 1544.53 |
Wavelength 1544.53 |
• 1544.92 |
Wavelength 1544.92 |
• 1545.32 |
Wavelength 1545.32 |
• 1545.72 |
Wavelength 1545.72 |
• 1546.12 |
Wavelength 1546.12 |
• 1546.52 |
Wavelength 1546.52 |
• 1546.92 |
Wavelength 1546.92 |
• 1547.32 |
Wavelength 1547.32 |
• 1547.72 |
Wavelength 1547.72 |
• 1548.12 |
Wavelength 1548.12 |
• 1548.51 |
Wavelength 1548.51 |
• 1548.92 |
Wavelength 1548.92 |
• 1549.32 |
Wavelength 1549.32 |
• 1549.71 |
Wavelength 1549.71 |
• 1550 |
Wavelength 1500 |
• 1550.12 |
Wavelength 1550.12 |
• 1550.52 |
Wavelength 1550.52 |
• 1550.92 |
Wavelength 1550.92 |
• 1551.32 |
Wavelength 1551.32 |
• 1551.72 |
Wavelength 1551.72 |
• 1552.12 |
Wavelength 1552.12 |
• 1552.52 |
Wavelength 1552.52 |
• 1552.93 |
Wavelength 1552.93 |
• 1553.33 |
Wavelength 1553.33 |
• 1553.73 |
Wavelength 1553.73 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.94 |
Wavelength 1554.94 |
• 1555.34 |
Wavelength 1555.34 |
• 1555.75 |
Wavelength 1555.75 |
• 1556.15 |
Wavelength 1556.15 |
• 1556.55 |
Wavelength 1556.55 |
• 1556.96 |
Wavelength 1556.96 |
• 1557.36 |
Wavelength 1557.36 |
• 1557.77 |
Wavelength 1557.77 |
• 1558.17 |
Wavelength 1558.17 |
• 1558.58 |
Wavelength 1558.58 |
• 1558.98 |
Wavelength 1558.98 |
• 1559.39 |
Wavelength 1559.39 |
• 1559.79 |
Wavelength 1559.79 |
• 1560.20 |
Wavelength 1560.20 |
• 1560.61 |
Wavelength 1560.61 |
• 1561.01 |
Wavelength 1561.01 |
• 1561.42 |
Wavelength 1561.42 |
• 1561.83 |
Wavelength 1561.83 |
• 1570 |
Wavelength 1570 |
• 1570.83 |
Wavelength 1570.83 |
• 1571.24 |
Wavelength 1571.24 |
• 1571.65 |
Wavelength 1571.65 |
• 1572.06 |
Wavelength 1572.06 |
• 1572.48 |
Wavelength 1572.48 |
• 1572.89 |
Wavelength 1572.89 |
• 1573.30 |
Wavelength 1573.30 |
• 1573.71 |
Wavelength 1573.71 |
• 1574.13 |
Wavelength 1574.13 |
• 1574.54 |
Wavelength 1574.54 |
• 1574.95 |
Wavelength 1574.95 |
• 1575.37 |
Wavelength 1575.37 |
• 1575.78 |
Wavelength 1575.78 |
• 1576.20 |
Wavelength 1576.20 |
• 1576.61 |
Wavelength 1576.61 |
• 1577.03 |
Wavelength 1577.03 |
• 1577.44 |
Wavelength 1577.44 |
• 1577.86 |
Wavelength 1577.86 |
• 1578.27 |
Wavelength 1578.27 |
• 1578.69 |
Wavelength 1578.69 |
• 1579.10 |
Wavelength 1579.10 |
• 1579.52 |
Wavelength 1579.52 |
• 1579.93 |
Wavelength 1579.93 |
• 1580.35 |
Wavelength 1580.35 |
• 1580.77 |
Wavelength 1580.77 |
• 1581.18 |
Wavelength 1581.18 |
• 1581.60 |
Wavelength 1581.60 |
• 1582.02 |
Wavelength 1582.02 |
• 1582.44 |
Wavelength 1582.44 |
• 1582.85 |
Wavelength 1582.85 |
• 1583.27 |
Wavelength 1583.27 |
• 1583.69 |
Wavelength 1583.69 |
• 1584.11 |
Wavelength 1584.11 |
• 1584.53 |
Wavelength 1584.53 |
• 1584.95 |
Wavelength 1584.95 |
• 1585.36 |
Wavelength 1585.36 |
• 1585.78 |
Wavelength 1585.78 |
• 1586.20 |
Wavelength 1586.20 |
• 1586.62 |
Wavelength 1586.62 |
• 1587.04 |
Wavelength 1587.04 |
• 1587.46 |
Wavelength 1587.46 |
• 1587.88 |
Wavelength 1587.88 |
• 1588.30 |
Wavelength 1588.30 |
• 1588.73 |
Wavelength 1588.73 |
• 1589.15 |
Wavelength 1589.15 |
• 1589.57 |
Wavelength 1589.57 |
• 1589.99 |
Wavelength 1589.99 |
• 1590 |
Wavelength 1590 |
• 1590.41 |
Wavelength 1590.41 |
• 1590.83 |
Wavelength 1590.83 |
• 1591.26 |
Wavelength 1591.26 |
• 1591.68 |
Wavelength 1591.68 |
• 1592.10 |
Wavelength 1592.10 |
• 1592.52 |
Wavelength 1592.52 |
• 1592.95 |
Wavelength 1592.95 |
• 1593.37 |
Wavelength 1593.37 |
• 1593.79 |
Wavelength 1593.79 |
• 1594.22 |
Wavelength 1594.22 |
• 1594.64 |
Wavelength 1594.64 |
• 1595.06 |
Wavelength 1595.06 |
• 1595.49 |
Wavelength 1595.49 |
• 1596.34 |
Wavelength 1596.34 |
• 1596.76 |
Wavelength 1596.76 |
• 1597.19 |
Wavelength 1597.19 |
• 1597.62 |
Wavelength 1597.62 |
• 1598.04 |
Wavelength 1598.04 |
• 1598.47 |
Wavelength 1598.47 |
• 1598.89 |
Wavelength 1598.89 |
• 1599.32 |
Wavelength 1599.32 |
• 1599.75 |
Wavelength 1599.75 |
• 1600.06 |
Wavelength 1600.06 |
• 1601.03 |
Wavelength 1601.03 |
• 1601.46 |
Wavelength 1601.46 |
• 1601.88 |
Wavelength 1601.88 |
• 1602.31 |
Wavelength 1602.31 |
• 1602.74 |
Wavelength 1602.74 |
• 1603.17 |
Wavelength 1603.17 |
• 1603.60 |
Wavelength 1603.60 |
• 1604.03 |
Wavelength 1604.03 |
• 1610 |
Wavelength 1610 |
• USE-TWL1 |
Use Tunable Wavelength 1 |
LOSSB |
Parameter type is REACH—reach values |
• AUTOPROV |
Autoprovisioning |
• CX |
Reach CX |
• DX |
Reach DX |
• HX |
Reach HX |
• I1 |
Reach I1 |
• IR-1 |
Reach IR-1 |
• IR-2 |
Reach IR-2 |
• L1 |
Reach L1 |
• L2 |
Reach L2 |
• L3 |
Reach L3 |
• LR-1 |
Reach LR-1 |
• LR-2 |
Reach LR-2 |
• LR-3 |
Reach LR-3 |
• LX |
Reach LX |
• S1 |
Reach S1 |
• S2 |
Reach S2 |
• SR |
Reach SR |
• SR-1 |
Reach SR-1 |
• SX |
Reach SX |
• T |
Reach T |
• VX |
Reach VX |
• ZX |
Reach ZX |
PST_PSTQ |
Primary state of the entity Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ) |
• Unlocked-Enabled |
In service - normal |
• Locked-Disabled |
Out of service - autonomous |
• Locked-Disabled |
Out of service - autonomous and management |
• Locked-Enabled |
Out of service - management |
SST |
Secondary state of the entity. Optional Parameter type is SST—provides additional information pertaining to PST and PSTQ |
• AutomaticInService |
Automatic in service |
• Disabled |
Disabled |
• Loopback |
Loopback |
• MismatchofEquipmentAlarm |
Mismatch of equipment and attributes |
• Maintenance |
Maintenance mode |
• OutOfGroup |
Out of group |
• SoftwareDownload |
Software downloading |
• Unassigned |
Unassigned |
• NotInstalled |
Unequipped |
21.2 RTRV-<MOD1FICONPAYLOAD>
Retrieve (1GFICON, 2 GFICON)
Usage Guidelines
This command returns Fibre-Channel-specific settings for ports that have been configured to carry FICON traffic using the ENT-FICON command. The MXP(P)-MR-2.5G card only supports the GFP-T frame type.
See Table 27-1 for supported modifiers by platform.
Category
Ports
Security
Retrieve
Input Format
RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
Table 21-3 RTRV-<MOD1FICONPAYLOAD> Input Parameters
|
|
AID |
Access identifier from the "FACILITY" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>],
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,<SST>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFICON,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,NAME=\"FC PORT\",
SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,LOSSB=LR-1:LOCKED-ENABLED,
MAINTENANCE"
;
Output Parameters
Table 21-4 RTRV-<MOD1FICONPAYLOAD> Output Parameters
|
|
AID |
Access identifier from the "FACILITY" section |
ROLE |
The port role in a Y-cable protection scheme. Optional Parameter type is SIDE—the role the unit is playing in the protection group |
• PROT |
The entity is a protection unit in the protection group |
• WORK |
The entity is a working unit in the protection group |
STATUS |
Port status in a Y-cable protection scheme. Optional Parameter type is STATUS—the status of the unit in the protection pair |
• ACT |
The entity is the active unit in the shelf |
• NA |
Status is unavailable |
• STBY |
The entity is the standby unit in the shelf |
LINKRATE |
The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned Parameter type is LINKRATE—the link rate on a Fibre Channel port |
• 1GFC |
The rate is 1 G Fibre Channel |
• 1GFICON |
The rate is 1 G FICON |
• 2GFC |
The rate is 2 G Fibre Channel |
• 2GFICON |
The rate is 2 G FICON |
• UNKNOWN |
The rate is unknown |
• UNPLUGGED |
The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected |
LINKSTATE |
Link state Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter |
• DN |
Monitored parameter with values equal to or greater than the level of LEV will be reported |
• UP |
Monitored parameter with values equal or less than the value of LEV will be reported |
LINKRCVRY |
Link recovery Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
DISTEXTN |
Distance extension. Optional Parameter type is DISTANCE_EXTENSION—distance extension |
• B2B |
Buffer to buffer flow control |
• NONE |
No distance extension |
LINKCREDITS |
Number of link credits. Integer. Optional |
MFS |
Maximum frame size. Integer. Optional |
ENCAP |
Frame encapsulation type. Optional Parameter type is ENCAP—frame encapsulation type |
• GFP_F |
GFP frame mode |
• GFP_T |
GFP transparent mode |
• HDLC |
HDLC frame mode |
• HDLC_LEX |
HDLC LAN extension frame mode |
• HDLC_X86 |
HDLC X.86 frame mode |
NAME |
Identifies the port name. String. Optional |
SOAK |
Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Integer. Optional |
SOAKLEFT |
Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional Rules for <SOAKLEFT> are as follows: • When the port is in Locked, Locked_Maintenance or Unlocked state, the parameter will not appear. • When the port is in Locked_AutomaticInService, but the countdown has not started due to fault signal, the value will be SOAKLEFT=NOT-STARTED. • When the port is in Locked_AutomaticInService state and the countdown has started, the value will be shown in HH-MM format. |
FREQ |
Parameter type is OPTICAL_WLEN—optical wavelength |
• 1310 |
Wavelength 1310 |
• 1470 |
Wavelength 1470 |
• 1490 |
Wavelength 1490 |
• 1510 |
Wavelength 1510 |
• 1529.55 |
Wavelength 1529.55 |
• 1529.94 |
Wavelength 1529.94 |
• 1530 |
Wavelength 1530 |
• 1530.33 |
Wavelength 1530.33 |
• 1530.73 |
Wavelength 1530.73 |
• 1531.12 |
Wavelength 1531.12 |
• 1531.51 |
Wavelength 1531.51 |
• 1531.90 |
Wavelength 1531.90 |
• 1532.29 |
Wavelength 1532.29 |
• 1532.68 |
Wavelength 1532.68 |
• 1533.07 |
Wavelength 1533.07 |
• 1533.47 |
Wavelength 1533.47 |
• 1533.86 |
Wavelength 1533.86 |
• 1534.25 |
Wavelength 1534.25 |
• 1534.64 |
Wavelength 1534.64 |
• 1535.04 |
Wavelength 1535.04 |
• 1535.43 |
Wavelength 1535.43 |
• 1535.82 |
Wavelength 1535.82 |
• 1536.22 |
Wavelength 1536.22 |
• 1536.61 |
Wavelength 1536.61 |
• 1537 |
Wavelength 1537 |
• 1537.40 |
Wavelength 1537.40 |
• 1537.79 |
Wavelength 1537.79 |
• 1538.19 |
Wavelength 1538.19 |
• 1538.58 |
Wavelength 1538.58 |
• 1538.98 |
Wavelength 1538.98 |
• 1539.37 |
Wavelength 1539.37 |
• 1539.77 |
Wavelength 1539.77 |
• 1540.16 |
Wavelength 1540.16 |
• 1540.56 |
Wavelength 1540.56 |
• 1540.95 |
Wavelength 1540.95 |
• 1541.35 |
Wavelength 1541.35 |
• 1541.75 |
Wavelength 1541.75 |
• 1542.14 |
Wavelength 1542.14 |
• 1542.35 |
Wavelength 1542.35 |
• 1542.54 |
Wavelength 1542.54 |
• 1542.94 |
Wavelength 1542.94 |
• 1543.33 |
Wavelength 1543.33 |
• 1543.73 |
Wavelength 1543.73 |
• 1544.13 |
Wavelength 1544.13 |
• 1544.53 |
Wavelength 1544.53 |
• 1544.92 |
Wavelength 1544.92 |
• 1545.32 |
Wavelength 1545.32 |
• 1545.72 |
Wavelength 1545.72 |
• 1546.12 |
Wavelength 1546.12 |
• 1546.52 |
Wavelength 1546.52 |
• 1546.92 |
Wavelength 1546.92 |
• 1547.32 |
Wavelength 1547.32 |
• 1547.72 |
Wavelength 1547.72 |
• 1548.12 |
Wavelength 1548.12 |
• 1548.51 |
Wavelength 1548.51 |
• 1548.92 |
Wavelength 1548.92 |
• 1549.32 |
Wavelength 1549.32 |
• 1549.71 |
Wavelength 1549.71 |
• 1550 |
Wavelength 1500 |
• 1550.12 |
Wavelength 1550.12 |
• 1550.52 |
Wavelength 1550.52 |
• 1550.92 |
Wavelength 1550.92 |
• 1551.32 |
Wavelength 1551.32 |
• 1551.72 |
Wavelength 1551.72 |
• 1552.12 |
Wavelength 1552.12 |
• 1552.52 |
Wavelength 1552.52 |
• 1552.93 |
Wavelength 1552.93 |
• 1553.33 |
Wavelength 1553.33 |
• 1553.73 |
Wavelength 1553.73 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.94 |
Wavelength 1554.94 |
• 1555.34 |
Wavelength 1555.34 |
• 1555.75 |
Wavelength 1555.75 |
• 1556.15 |
Wavelength 1556.15 |
• 1556.55 |
Wavelength 1556.55 |
• 1556.96 |
Wavelength 1556.96 |
• 1557.36 |
Wavelength 1557.36 |
• 1557.77 |
Wavelength 1557.77 |
• 1558.17 |
Wavelength 1558.17 |
• 1558.58 |
Wavelength 1558.58 |
• 1558.98 |
Wavelength 1558.98 |
• 1559.39 |
Wavelength 1559.39 |
• 1559.79 |
Wavelength 1559.79 |
• 1560.20 |
Wavelength 1560.20 |
• 1560.61 |
Wavelength 1560.61 |
• 1561.01 |
Wavelength 1561.01 |
• 1561.42 |
Wavelength 1561.42 |
• 1561.83 |
Wavelength 1561.83 |
• 1570 |
Wavelength 1570 |
• 1570.83 |
Wavelength 1570.83 |
• 1571.24 |
Wavelength 1571.24 |
• 1571.65 |
Wavelength 1571.65 |
• 1572.06 |
Wavelength 1572.06 |
• 1572.48 |
Wavelength 1572.48 |
• 1572.89 |
Wavelength 1572.89 |
• 1573.30 |
Wavelength 1573.30 |
• 1573.71 |
Wavelength 1573.71 |
• 1574.13 |
Wavelength 1574.13 |
• 1574.54 |
Wavelength 1574.54 |
• 1574.95 |
Wavelength 1574.95 |
• 1575.37 |
Wavelength 1575.37 |
• 1575.78 |
Wavelength 1575.78 |
• 1576.20 |
Wavelength 1576.20 |
• 1576.61 |
Wavelength 1576.61 |
• 1577.03 |
Wavelength 1577.03 |
• 1577.44 |
Wavelength 1577.44 |
• 1577.86 |
Wavelength 1577.86 |
• 1578.27 |
Wavelength 1578.27 |
• 1578.69 |
Wavelength 1578.69 |
• 1579.10 |
Wavelength 1579.10 |
• 1579.52 |
Wavelength 1579.52 |
• 1579.93 |
Wavelength 1579.93 |
• 1580.35 |
Wavelength 1580.35 |
• 1580.77 |
Wavelength 1580.77 |
• 1581.18 |
Wavelength 1581.18 |
• 1581.60 |
Wavelength 1581.60 |
• 1582.02 |
Wavelength 1582.02 |
• 1582.44 |
Wavelength 1582.44 |
• 1582.85 |
Wavelength 1582.85 |
• 1583.27 |
Wavelength 1583.27 |
• 1583.69 |
Wavelength 1583.69 |
• 1584.11 |
Wavelength 1584.11 |
• 1584.53 |
Wavelength 1584.53 |
• 1584.95 |
Wavelength 1584.95 |
• 1585.36 |
Wavelength 1585.36 |
• 1585.78 |
Wavelength 1585.78 |
• 1586.20 |
Wavelength 1586.20 |
• 1586.62 |
Wavelength 1586.62 |
• 1587.04 |
Wavelength 1587.04 |
• 1587.46 |
Wavelength 1587.46 |
• 1587.88 |
Wavelength 1587.88 |
• 1588.30 |
Wavelength 1588.30 |
• 1588.73 |
Wavelength 1588.73 |
• 1589.15 |
Wavelength 1589.15 |
• 1589.57 |
Wavelength 1589.57 |
• 1589.99 |
Wavelength 1589.99 |
• 1590 |
Wavelength 1590 |
• 1590.41 |
Wavelength 1590.41 |
• 1590.83 |
Wavelength 1590.83 |
• 1591.26 |
Wavelength 1591.26 |
• 1591.68 |
Wavelength 1591.68 |
• 1592.10 |
Wavelength 1592.10 |
• 1592.52 |
Wavelength 1592.52 |
• 1592.95 |
Wavelength 1592.95 |
• 1593.37 |
Wavelength 1593.37 |
• 1593.79 |
Wavelength 1593.79 |
• 1594.22 |
Wavelength 1594.22 |
• 1594.64 |
Wavelength 1594.64 |
• 1595.06 |
Wavelength 1595.06 |
• 1595.49 |
Wavelength 1595.49 |
• 1596.34 |
Wavelength 1596.34 |
• 1596.76 |
Wavelength 1596.76 |
• 1597.19 |
Wavelength 1597.19 |
• 1597.62 |
Wavelength 1597.62 |
• 1598.04 |
Wavelength 1598.04 |
• 1598.47 |
Wavelength 1598.47 |
• 1598.89 |
Wavelength 1598.89 |
• 1599.32 |
Wavelength 1599.32 |
• 1599.75 |
Wavelength 1599.75 |
• 1600.06 |
Wavelength 1600.06 |
• 1601.03 |
Wavelength 1601.03 |
• 1601.46 |
Wavelength 1601.46 |
• 1601.88 |
Wavelength 1601.88 |
• 1602.31 |
Wavelength 1602.31 |
• 1602.74 |
Wavelength 1602.74 |
• 1603.17 |
Wavelength 1603.17 |
• 1603.60 |
Wavelength 1603.60 |
• 1604.03 |
Wavelength 1604.03 |
• 1610 |
Wavelength 1610 |
• USE-TWL1 |
Use Tunable Wavelength 1 |
LOSSB |
Parameter type is REACH—reach values |
• AUTOPROV |
Autoprovisioning |
• CX |
Reach CX |
• DX |
Reach DX |
• HX |
Reach HX |
• I1 |
Reach I1 |
• IR-1 |
Reach IR-1 |
• IR-2 |
Reach IR-2 |
• L1 |
Reach L1 |
• L2 |
Reach L2 |
• L3 |
Reach L3 |
• LR-1 |
Reach LR-1 |
• LR-2 |
Reach LR-2 |
• LR-3 |
Reach LR-3 |
• LX |
Reach LX |
• S1 |
Reach S1 |
• S2 |
Reach S2 |
• SR |
Reach SR |
• SR-1 |
Reach SR-1 |
• SX |
Reach SX |
• T |
Reach T |
• VX |
Reach VX |
• ZX |
Reach ZX |
PST_PSTQ |
Primary state of the entity Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ) |
• Unlocked-Enabled |
In service - normal |
• Locked-Disabled |
Out of service - autonomous |
• Locked-Disabled |
Out of service - autonomous and management |
• Locked-Enabled |
Out of service - management |
SST |
Secondary state of the entity. Optional Parameter type is SST—provides additional information pertaining to PST and PSTQ |
• AutomaticInService |
Automatic in service |
• Disabled |
Disabled |
• Loopback |
Loopback |
• MismatchofEquipmentAlarm |
Mismatch of equipment and attributes |
• Maintenance |
Maintenance mode |
• OutOfGroup |
Out of group |
• SoftwareDownload |
Software downloading |
• Unassigned |
Unassigned |
• NotInstalled |
Unequipped |
21.3 RTRV-<MOD2DWDMPAYLOAD>
Retrieve (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, PASSTHRU)
Usage Guidelines
This command retrieves the configuration parameter of a DWDM client.
See Table 27-1 for supported modifiers by platform.
Category
DWDM
Security
Retrieve
Input Format
RTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-HDTV:MILAN:FAC-1-1:100;
Input Parameters
Table 21-5 RTRV-<MOD2DWDMPAYLOAD> Input Parameters
|
|
AID |
Access identifier from the "FACILITY" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1,HDTV:,,WORK,ACT:NAME=\"NY PORT\",LBCL=10.0,OPT=10.0,OPR=10.0,
FREQ=1550,LOSSB=LR-1:Unlocked-Disabled,AutomaticInService"
;
Output Parameters
Table 21-6 RTRV-<MOD2DWDMPAYLOAD> Output Parameters
|
|
AIDUNIONID |
Access identifier from the "AidUnionId" section |
AIDTYPE |
A type of access identifier Parameter type is MOD2DWDMPAYLOAD—payload types applicable to DWDM ports |
• 10GFC |
10 gigabit Fibre Channel payload |
• 10GIGE |
10 gigabit Ethernet |
• 1GFC |
1 gigabit Fibre Channel payload |
• 1GFICON |
1 gigabit FICON payload |
• 2GFC |
2 gigabit Fibre Channel payload |
• 2GFICON |
2 gigabit FICON payload |
• D1VIDEO |
D1Video payload |
• DV6000 |
DV6000 payload |
• ETRCLO |
ETRCLO payload |
• GIGE |
Gigabit Ethernet payload |
• HDTV |
HDTV payload |
• ISC1 |
ISC1 payload |
• ISC3 |
ISC3 payload |
• PASSTHRU |
Any pass through (2R) payload |
ROLE |
The port role in a Y-cable protection scheme. Optional Parameter type is SIDE—the role the unit has in the protection group |
• PROT |
The entity is a protection unit in the protection group |
• WORK |
The entity is a working unit in the protection group |
STATUS |
Port status in a Y-cable protection scheme. Optional Parameter type is STATUS—the status of the unit in the protection pair |
• ACT |
The entity is the active unit in the shelf |
• NA |
Status is unavailable |
• STBY |
The entity is the standby unit in the shelf |
NAME |
Identifies the port name. String. Optional |
LBCL |
Displays the current value of the laser current. Float. Optional |
OPT |
Displays the current value of the transmitted optical power. Float. Optional |
OPR |
Displays the current value of the received optical power. Float. Optional |
FREQ |
Parameter type is OPTICAL_WLEN—optical wavelength |
• 1310 |
Wavelength 1310 |
• 1470 |
Wavelength 1470 |
• 1490 |
Wavelength 1490 |
• 1510 |
Wavelength 1510 |
• 1529.55 |
Wavelength 1529.55 |
• 1529.94 |
Wavelength 1529.94 |
• 1530 |
Wavelength 1530 |
• 1530.33 |
Wavelength 1530.33 |
• 1530.73 |
Wavelength 1530.73 |
• 1531.12 |
Wavelength 1531.12 |
• 1531.51 |
Wavelength 1531.51 |
• 1531.90 |
Wavelength 1531.90 |
• 1532.29 |
Wavelength 1532.29 |
• 1532.68 |
Wavelength 1532.68 |
• 1533.07 |
Wavelength 1533.07 |
• 1533.47 |
Wavelength 1533.47 |
• 1533.86 |
Wavelength 1533.86 |
• 1534.25 |
Wavelength 1534.25 |
• 1534.64 |
Wavelength 1534.64 |
• 1535.04 |
Wavelength 1535.04 |
• 1535.43 |
Wavelength 1535.43 |
• 1535.82 |
Wavelength 1535.82 |
• 1536.22 |
Wavelength 1536.22 |
• 1536.61 |
Wavelength 1536.61 |
• 1537 |
Wavelength 1537 |
• 1537.40 |
Wavelength 1537.40 |
• 1537.79 |
Wavelength 1537.79 |
• 1538.19 |
Wavelength 1538.19 |
• 1538.58 |
Wavelength 1538.58 |
• 1538.98 |
Wavelength 1538.98 |
• 1539.37 |
Wavelength 1539.37 |
• 1539.77 |
Wavelength 1539.77 |
• 1540.16 |
Wavelength 1540.16 |
• 1540.56 |
Wavelength 1540.56 |
• 1540.95 |
Wavelength 1540.95 |
• 1541.35 |
Wavelength 1541.35 |
• 1541.75 |
Wavelength 1541.75 |
• 1542.14 |
Wavelength 1542.14 |
• 1542.35 |
Wavelength 1542.35 |
• 1542.54 |
Wavelength 1542.54 |
• 1542.94 |
Wavelength 1542.94 |
• 1543.33 |
Wavelength 1543.33 |
• 1543.73 |
Wavelength 1543.73 |
• 1544.13 |
Wavelength 1544.13 |
• 1544.53 |
Wavelength 1544.53 |
• 1544.92 |
Wavelength 1544.92 |
• 1545.32 |
Wavelength 1545.32 |
• 1545.72 |
Wavelength 1545.72 |
• 1546.12 |
Wavelength 1546.12 |
• 1546.52 |
Wavelength 1546.52 |
• 1546.92 |
Wavelength 1546.92 |
• 1547.32 |
Wavelength 1547.32 |
• 1547.72 |
Wavelength 1547.72 |
• 1548.12 |
Wavelength 1548.12 |
• 1548.51 |
Wavelength 1548.51 |
• 1548.92 |
Wavelength 1548.92 |
• 1549.32 |
Wavelength 1549.32 |
• 1549.71 |
Wavelength 1549.71 |
• 1550 |
Wavelength 1500 |
• 1550.12 |
Wavelength 1550.12 |
• 1550.52 |
Wavelength 1550.52 |
• 1550.92 |
Wavelength 1550.92 |
• 1551.32 |
Wavelength 1551.32 |
• 1551.72 |
Wavelength 1551.72 |
• 1552.12 |
Wavelength 1552.12 |
• 1552.52 |
Wavelength 1552.52 |
• 1552.93 |
Wavelength 1552.93 |
• 1553.33 |
Wavelength 1553.33 |
• 1553.73 |
Wavelength 1553.73 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.94 |
Wavelength 1554.94 |
• 1555.34 |
Wavelength 1555.34 |
• 1555.75 |
Wavelength 1555.75 |
• 1556.15 |
Wavelength 1556.15 |
• 1556.55 |
Wavelength 1556.55 |
• 1556.96 |
Wavelength 1556.96 |
• 1557.36 |
Wavelength 1557.36 |
• 1557.77 |
Wavelength 1557.77 |
• 1558.17 |
Wavelength 1558.17 |
• 1558.58 |
Wavelength 1558.58 |
• 1558.98 |
Wavelength 1558.98 |
• 1559.39 |
Wavelength 1559.39 |
• 1559.79 |
Wavelength 1559.79 |
• 1560.20 |
Wavelength 1560.20 |
• 1560.61 |
Wavelength 1560.61 |
• 1561.01 |
Wavelength 1561.01 |
• 1561.42 |
Wavelength 1561.42 |
• 1561.83 |
Wavelength 1561.83 |
• 1570 |
Wavelength 1570 |
• 1570.83 |
Wavelength 1570.83 |
• 1571.24 |
Wavelength 1571.24 |
• 1571.65 |
Wavelength 1571.65 |
• 1572.06 |
Wavelength 1572.06 |
• 1572.48 |
Wavelength 1572.48 |
• 1572.89 |
Wavelength 1572.89 |
• 1573.30 |
Wavelength 1573.30 |
• 1573.71 |
Wavelength 1573.71 |
• 1574.13 |
Wavelength 1574.13 |
• 1574.54 |
Wavelength 1574.54 |
• 1574.95 |
Wavelength 1574.95 |
• 1575.37 |
Wavelength 1575.37 |
• 1575.78 |
Wavelength 1575.78 |
• 1576.20 |
Wavelength 1576.20 |
• 1576.61 |
Wavelength 1576.61 |
• 1577.03 |
Wavelength 1577.03 |
• 1577.44 |
Wavelength 1577.44 |
• 1577.86 |
Wavelength 1577.86 |
• 1578.27 |
Wavelength 1578.27 |
• 1578.69 |
Wavelength 1578.69 |
• 1579.10 |
Wavelength 1579.10 |
• 1579.52 |
Wavelength 1579.52 |
• 1579.93 |
Wavelength 1579.93 |
• 1580.35 |
Wavelength 1580.35 |
• 1580.77 |
Wavelength 1580.77 |
• 1581.18 |
Wavelength 1581.18 |
• 1581.60 |
Wavelength 1581.60 |
• 1582.02 |
Wavelength 1582.02 |
• 1582.44 |
Wavelength 1582.44 |
• 1582.85 |
Wavelength 1582.85 |
• 1583.27 |
Wavelength 1583.27 |
• 1583.69 |
Wavelength 1583.69 |
• 1584.11 |
Wavelength 1584.11 |
• 1584.53 |
Wavelength 1584.53 |
• 1584.95 |
Wavelength 1584.95 |
• 1585.36 |
Wavelength 1585.36 |
• 1585.78 |
Wavelength 1585.78 |
• 1586.20 |
Wavelength 1586.20 |
• 1586.62 |
Wavelength 1586.62 |
• 1587.04 |
Wavelength 1587.04 |
• 1587.46 |
Wavelength 1587.46 |
• 1587.88 |
Wavelength 1587.88 |
• 1588.30 |
Wavelength 1588.30 |
• 1588.73 |
Wavelength 1588.73 |
• 1589.15 |
Wavelength 1589.15 |
• 1589.57 |
Wavelength 1589.57 |
• 1589.99 |
Wavelength 1589.99 |
• 1590 |
Wavelength 1590 |
• 1590.41 |
Wavelength 1590.41 |
• 1590.83 |
Wavelength 1590.83 |
• 1591.26 |
Wavelength 1591.26 |
• 1591.68 |
Wavelength 1591.68 |
• 1592.10 |
Wavelength 1592.10 |
• 1592.52 |
Wavelength 1592.52 |
• 1592.95 |
Wavelength 1592.95 |
• 1593.37 |
Wavelength 1593.37 |
• 1593.79 |
Wavelength 1593.79 |
• 1594.22 |
Wavelength 1594.22 |
• 1594.64 |
Wavelength 1594.64 |
• 1595.06 |
Wavelength 1595.06 |
• 1595.49 |
Wavelength 1595.49 |
• 1596.34 |
Wavelength 1596.34 |
• 1596.76 |
Wavelength 1596.76 |
• 1597.19 |
Wavelength 1597.19 |
• 1597.62 |
Wavelength 1597.62 |
• 1598.04 |
Wavelength 1598.04 |
• 1598.47 |
Wavelength 1598.47 |
• 1598.89 |
Wavelength 1598.89 |
• 1599.32 |
Wavelength 1599.32 |
• 1599.75 |
Wavelength 1599.75 |
• 1600.06 |
Wavelength 1600.06 |
• 1601.03 |
Wavelength 1601.03 |
• 1601.46 |
Wavelength 1601.46 |
• 1601.88 |
Wavelength 1601.88 |
• 1602.31 |
Wavelength 1602.31 |
• 1602.74 |
Wavelength 1602.74 |
• 1603.17 |
Wavelength 1603.17 |
• 1603.60 |
Wavelength 1603.60 |
• 1604.03 |
Wavelength 1604.03 |
• 1610 |
Wavelength 1610 |
• USE-TWL1 |
Use Tunable Wavelength 1 |
LOSSB |
Parameter type is REACH—reach values |
• AUTOPROV |
Autoprovisioning |
• CX |
Reach CX |
• DX |
Reach DX |
• HX |
Reach HX |
• I1 |
Reach I1 |
• IR-1 |
Reach IR-1 |
• IR-2 |
Reach IR-2 |
• L1 |
Reach L1 |
• L2 |
Reach L2 |
• L3 |
Reach L3 |
• LR-1 |
Reach LR-1 |
• LR-2 |
Reach LR-2 |
• LR-3 |
Reach LR-3 |
• LX |
Reach LX |
• S1 |
Reach S1 |
• S2 |
Reach S2 |
• SR |
Reach SR |
• SR-1 |
Reach SR-1 |
• SX |
Reach SX |
• T |
Reach T |
• VX |
Reach VX |
• ZX |
Reach ZX |
PST_PSTQ |
Primary state of the entity Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ) |
• Unlocked-Enabled |
In service - normal |
• Locked-Disabled |
Out of service - autonomous |
• Locked-Disabled |
Out of service - autonomous and management |
• Locked-Enabled |
Out of service - management |
SST |
Secondary state of the entity. Optional Parameter type is SST—provides additional information pertaining to PST and PSTQ |
• AutomaticInService |
Automatic in service |
• Disabled |
Disabled |
• Loopback |
Loopback |
• MismatchofEquipmentAlarm |
Mismatch of equipment and attributes |
• Maintenance |
Maintenance mode |
• OutOfGroup |
Out of group |
• SoftwareDownload |
Software downloading |
• Unassigned |
Unassigned |
• NotInstalled |
Unequipped |
21.4 RTRV-<MOD_RING>
Retrieve Multiplex Section Shared Protection Ring
Usage Guidelines
This command retrieves the MS-SPRing information of the NE. A two-fiber or four-fiber MS-SPRing can be retrieved.
Output examples:
4F MS-SPRing
"MSSPR-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 MS-SPRing
"MSSPR-N12EF::RINGID=N12EF,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1"
Error conditions:
1.
Only ALL, NULL, MSSPR-ALL, or MSSPR-RINGID is allowed for this command.
2.
A NULL AID defaults to the AID ALL.
3.
The list AID format is supported.
4.
If the system fails on getting IOR, a SROF (Get IOR Failed) error message is returned.
5.
If the AID is invalid, an IIAC (Invalid AID) error message is returned.
6.
If the MS-SPRing does not exist, a SRQN (MSSPR Does Not Exist) error message is returned.
Category
MS-SPRing
Security
Retrieve
Input Format
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input Example
RTRV-MSSPR:PETALUMA:ALL:123;
Input Parameters
Table 21-7 RTRV-<MOD_RING> Input Parameters
|
|
AID |
Access identifier from the "AidUnionId1" section. Identifies the MS-SPRing of the NE. Only ALL, null or a list of MSSPR-# in AID are allowed. A null value is equivalent to ALL |
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>],
[EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>],
[WESTPROT=<WESTPROT>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"MSSPR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,
SRVRTV=Y,SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,
EASTPROT=FAC-12-1,WESTPROT=FAC-13-1"
;
Output Parameters
Table 21-8 RTRV-<MOD_RING> Output Parameters
|
|
AID |
Access identifier from the "AidUnionId1" section. Identifies the MS-SPRing of the NE. Optional |
RINGID |
The MS-SPRing ID of the NE up to six characters. Valid characters are A-Z and 0-9. String. Optional |
NODEID |
The MS-SPRing node ID of the NE. NODEID ranges from 0 to 31. String. Optional |
MODE |
Mode with which the command is to be implemented. Identifies the MS-SPRing mode; either two-fiber or four-fiber. Optional Parameter type is MSSPR_MODE—MS-SPRing mode |
• 2F |
Two-fiber MS-SPRing |
• 4F |
Four-fiber MS-SPRing |
RVRTV |
Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
RVTM |
Revertive time. RVTM is not allowed to be set while "RVRTV" is N Parameter type is REVERTIVE_TIME—revertive time |
• 0.5 to 12.0 |
Revertive time is 0.5 to 12.0 minutes |
SRVRTV |
The span revertive mode for four-fiber MS-SPRing only Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
SRVTM |
The span revertive time for four-fiber MS-SPRing only. SRVTM is not allowed to be set while SRVRTV is N Parameter type is REVERTIVE_TIME—revertive time |
• 0.5 to 12.0 |
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-<PATH>
Retrieve (VC3, VC44C, VC38C, VC464C, VC48C, STS36C, VC4, VC416C, VC42C, VC43C, VC11, VC12)
Usage Guidelines
This command retrieves the attributes associated with an VC path.
See Table 27-1 for supported modifiers by platform.
Supported AIDs are: ALL, SLOT-N (N=1,2,...,ALL), and VC-specific AIDs
The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and SNCPPTHSTATE parameters only apply to SNCP.
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 SDH VC Path overhead.
The EXPTRC indicates the contents of the expected incoming path trace that are provisioned by the user in the ED-VC_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode compares of the received string with the user entered expected string. The AUTO mode compares 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 either 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 either a copy of the received string, or NULL if the string has not been received.
J1 (EXPTRC) is implemented on the STM1, STM16AS, STM64, MRC-12 and STM64-XFP cards.
Note
•
An optional parameter MSSPRPTHTYPE provides more options to retrieve J1/C2 of a particular MS-SPRing path. This field is valid only if the queried AID port has MS-SPRing. The MSSPRPTHTYPE defaults to "non-pca" path type if the MS-SPRing is switched, or defaults to all MS-SPRing path types if there is no MS-SPRing switching.
•
Sending this command while MSSPRPTHTYPE=PCA, whether there is MS-SPRing switch or not, the PCA path J1/C2 data will be returned (if there is PCA circuit on the AID). Sending this command with a VC AID without circuits and no MS-SPRing switched on the VC, will return and error message.
•
An optional output parameter MSSPRPTHSTATE is introduced into this command output. Each J1/C2 output data of this command will include the MS-SPRing path state information.
•
After the MS-SPRing switching, the J1/IPPM/C2 data can be retrieved over the protection path. Provisioning J1 trace string, trace mode, or threshold is not allowed on the protection path.
•
HOLDOFFTIMER is not specific to a path. Instead, it is applicable to the SNCP selector.
•
To retrieve either the cross-connect points or the test access points on the DS3i-N-12 card, the RTRV-VC3 command with the appropriate AID must be used.
•
For the selector path on an MS-SPRing, the SWPDIP path attribute is not editable and always in the ON state.
Category
Paths
Security
Retrieve
Input Format
RTRV-<PATH>:[<TID>]:<AID>:<CTAG>:::[MSSPRPTHTYPE=<MSSPRPTHTYPE>][:];
Input Example
RTRV-VC4:FERNDALE:VC4-2-1-4:238:::MSSPRPTHTYPE=NON-PCA;
Input Parameters
Table 21-9 RTRV-<PATH> Input Parameters
|
|
AID |
Access identifier from the "CrossConnectId1" section. Must not be null |
MSSPRPTHTYPE |
The MS-SPRing path type (only if the port is on the MS-SPRing). Defaults to NON-PCA. Applicable only to VC-level paths in SDH. A null value defaults to NON-PCA Parameter type is MSSPR_PTH_TYPE—MS-SPRing path type only if the port is on the MS-SPRing |
• NON-PCA |
The AID is on the working path, or the cross-connection card protection path |
• PCA |
The AID is on the MS-SPRing PCA path |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[SNCPPTHSTATE=<SNCPPTHSTATE>],[C2=<C2>],
[MSSPRPTHSTATE=<MSSPRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-2-1-4::LEVEL=VC3,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=DUAL,
SNCPPTHSTATE=ACT,C2=0X04,
MSSPRPTHSTATE=PROTPTHACT:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Output Parameters
Table 21-10 RTRV-<PATH> Output Parameters
|
|
AID |
Access identifier from the "CrossConnectId1" section |
LEVEL |
The rate of the cross-connected channel. Applicable only to High-Order paths (VC4). Optional Parameter type is PATH—modifier for path commands |
• VC3 |
Synchronous Transport Signal/Module Level-1 (51Mbs) |
• VC44C |
Synchronous Transport Signal/Module Level-12 Concatenated (622Mbs) |
• VC38C |
Synchronous Transport Signal/Module Level-18 Concatenated (933Mbps) |
• VC464C |
Synchronous Transport Signal/Module Level-192 Concatenated (9952 Mbs) |
• VC48C |
Synchronous Transport Signal/Module Level-24 Concatenated (1240 Mbs) |
• VC4 |
Synchronous Transport Signal/Module Signal Level-3 Concatenated (155 Mbs) |
• VC416C |
Synchronous Transport Signal/Module Level-48 Concatenated (2488 Mbs) |
• VC42C |
Synchronous Transport Signal/Module level-6 (310 Mbs) |
• VC43C |
Synchronous Transport Signal/Module Level-9 Concatenated (465 Mbs) |
• VC12 |
Virtual Tributary 2. Virtual Channel 12 |
SFBER |
An VC path signal failure threshold which only applies to SNCP. Applicable only to High-Order paths. Defaults to 1E-4. Optional Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path |
• 1E-3 |
SFBER is 1E-3 |
• 1E-4 |
SFBER is 1E-4 |
• 1E-5 |
SFBER is 1E-5 |
SDBER |
An VC path signal degrade threshold which only applies to SNCP. Applicable only High-Order paths. Defaults 1E-6. Optional Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path |
• 1E-5 |
SDBER is 1E-5 |
• 1E-6 |
SDBER is 1E-6 |
• 1E-7 |
SDBER is 1E-7 |
• 1E-8 |
SDBER is 1E-8 |
• 1E-9 |
SDBER is 1E-9 |
RVRTV |
Revertive mode. Only applies to SNCP. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
RVTM |
Revertive time. Only applies to SNCP Parameter type is REVERTIVE_TIME—revertive time |
• 0.5 to 12.0 |
Revertive time is 0.5 to 12.0 minutes |
SWPDIP |
Switch on PDI-P. Applicable only to VC-level paths (VCn). Optional Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
HOLDOFFTIMER |
Hold off timer. Integer. Optional |
EXPTRC |
Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). Applicable to VC-level paths (VCn). Defaults to NULL when SNCP path is created. String. Optional |
TRC |
The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to VC-level paths (VCn). String. Optional |
INCTRC |
The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to VC-level paths in (VCn). Defaults to Null when a SNCP path is created. String. Optional |
TRCMODE |
Path trace mode. Applicable only to VC-level paths (VCn). Defaults to OFF when a SNCP path is created. Optional Parameter type is TRCMODE—trace mode |
• AUTO |
Use the previously received path trace string as the expected string (not applicable to MXP_2.5G_10G and TXP_MR_10G cards) |
• AUTO-NO-AIS |
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected |
• MAN |
Use the provisioned expected string as the expected string |
• MAN-NO-AIS |
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected |
• OFF |
Turn off path trace capability. Nothing will be reported |
TACC |
Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N. Optional |
TAPTYPE |
TAP type. Optional Parameter type is TAPTYPE—test access point type |
• DUAL |
Dual FAD |
• SINGLE |
Single FAD |
SNCPPTHSTATE |
Indicates whether a given AID is the working or standby path of a SNCP cross-connect. Optional Parameter type is STATUS—status of the unit in the protection pair |
• ACT |
The entity is the active unit in the shelf |
• NA |
Status is unavailable |
• STBY |
The entity is the standby unit in the shelf |
C2 |
The c2 byte hex code. Applicable only to VC-level paths (VCn). Optional Parameter type is C2_BYTE—c2 byte hex code |
• 0X00 |
Unequipped |
• 0X01 |
Equipped-Non Specific payload |
• 0X02 |
VT-Structured VC-1 SPE |
• 0X03 |
Locked VT mode |
• 0X04 |
Asynchronous Mapping for DS3 |
• 0X12 |
Asynchronous Mapping for DS4NA |
• 0X13 |
Mapping for ATM |
• 0X14 |
Mapping for DQDB |
• 0X15 |
Asynchronous Mapping for FDDI |
• 0X16 |
HDLC-Over-SDH Mapping |
• 0XE1 |
VT-structured VC4-1 SPE with 1VTx payload defect |
• 0XE2 |
VT-structured VC4-1 SPE with 2VTx payload defects |
• 0XE3 |
VT-structured VC4-1 SPE with 3VTx payload defects |
• 0XE4 |
VT-structured VC4-1 SPE with 4VTx payload defects |
• 0XE5 |
VT-structured VC4-1 SPE with 5VTx payload defects |
• 0XE6 |
VT-structured VC4-1 SPE with 6VTx payload defects |
• 0XE7 |
VT-structured VC4-1 SPE with 7VTx payload defects |
• 0XE8 |
VT-structured VC4-1 SPE with 8VTx payload defects |
• 0XE9 |
VT-structured VC4-1 SPE with 9VTx payload defects |
• 0XEA |
VT-structured VC4-1 SPE with 10VTx payload defects |
• 0XEB |
VT-structured VC4-1 SPE with 11VTx payload defects |
• 0XEC |
VT-structured VC4-1 SPE with 12VTx payload defects |
• 0XED |
VT-structured VC4-1 SPE with 13VTx payload defects |
• 0XEE |
VT-structured VC4-1 SPE with 14VTx payload defects |
• 0XEF |
VT-structured VC4-1 SPE with 15VTx payload defects |
• 0XF0 |
VT-structured VC4-1 SPE with 16VTx payload defects |
• 0XF1 |
VT-structured VC4-1 SPE with 17VTx payload defects |
• 0XF2 |
VT-structured VC4-1 SPE with 18VTx payload defects |
• 0XF3 |
VT-structured VC4-1 SPE with 19VTx payload defects |
• 0XF4 |
VT-structured VC4-1 SPE with 20VTx payload defects |
• 0XF5 |
VT-structured VC4-1 SPE with 21VTx payload defects |
• 0XF6 |
VT-structured VC4-1 SPE with 22VTx payload defects |
• 0XF7 |
VT-structured VC4-1 SPE with 23VTx payload defects |
• 0XF8 |
VT-structured VC4-1 SPE with 24VTx payload defects |
• 0XF9 |
VT-structured VC4-1 SPE with 25VTx payload defects |
• 0XFA |
VT-structured VC4-1 SPE with 26VTx payload defects |
• 0XFB |
VT-structured VC4-1 SPE with 27VTx payload defects |
• 0XFC |
VT-structured VC4-1 SPE with 28VTx payload defects |
• 0XFE |
O.181 Test Signal (TSS1 to TSS3) Mapping |
• 0XFF |
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream |
MSSPRPTHSTATE |
The MS-SPRing path state only if the port is on the MS-SPRing. Applicable only to VC-level paths in SDH (VCn). Optional Parameter type is MSSPR_PTH_STATE—the MS-SPRing path state only if the port is on the MS-SPRing |
• PCAPTHACT |
Indicates the MS-SPRing un-switched and its PCA path is in the active state |
• PCAPTHSTB |
Indicates the MS-SPRing switched and its PCA path is in the standby state |
• PROTPTHACT |
Indicates the MS-SPRing switched and its protection path is in the active state |
• WKGPTHACT |
Indicates the MS-SPRing un-switched and its working path is in the active state |
• WKGPTHSTB |
Indicates the MS-SPRing switched and its working path is in the standby state |
PST_PSTQ |
Admin state in the PST_PSTQ format Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ) |
• Unlocked-Enabled |
In service - normal |
• Locked-Disabled |
Out of service - autonomous |
• Locked-Disabled |
Out of service - autonomous and management |
• Locked-Enabled |
Out of service - management |
SSTQ |
Secondary state of the entity. Optional Parameter type is SST—provides additional information pertaining to PST and PSTQ |
• AutomaticInService |
Automatic in service |
• Disabled |
Disabled |
• Loopback |
Loopback |
• MismatchofEquipmentAlarm |
Mismatch of equipment and attributes |
• Maintenance |
Maintenance mode |
• OutOfGroup |
Out of group |
• SoftwareDownload |
Software downloading |
• Unassigned |
Unassigned |
• NotInstalled |
Unequipped |
21.6 RTRV-<STM_TYPE>
Retrieve (STM1, STM4, STM16, STM64)
Usage Guidelines
This command retrieves the attributes (such as, service parameters) and the state of an STM facility.
See Table 27-1 for supported modifiers by platform.
Both RINGID and MSSPRTYPE identify the STM port connected with a MS-SPRing. These attributes are only presented for the STM4, STM16, STM64 ports within a MS-SPRing connection. The RTRV-<MOD_RING> command with the AID MSSPR-RINGID, can provide more information on this MS-SPRing.
Note
This command does not show the WVLEN attribute if the STM port has zero value on WVLEN.
UNI-C DCC provisioning notes:
1.
The attributes DCC(Y/N) and mode (SONET/SDH) remain the same in the ED/RTRV-STM commands when the DCC is used for UNI-C, in which case the port attribute UNIC is enabled (UNIC=Y).
2.
UNI-C DCC termination cannot be deleted by the regular DCC deprovisioning command.
3.
If the DCC is created under regular SDH provisioning, and this port is used by UNI-C, the port is converted as an UNI-C DCC automatically.
4.
Deprovisioning UNI-C IF/IB IPCC will free up DCC termination automatically.
5.
The parameters ALSMODE, ALSRCINT, and ALSRCPW are only applicable for STM1-8, STM64 and STM16ELR cards.
6.
SSMRCV will display the quality of the individual port.
7.
J0 Support (EXPTRC, TRC, TRCMODE and TRCFORMAT parameters) are supported by: DWDM cards with an STM payload, the MRC-12 card and the STM64-XFP card. J0 is not supported by STM1-8, STM4, STM16, STM64 and other SDH optical cards.
Category
Ports
Security
Retrieve
Input Format
RTRV-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-STM16:PENNGROVE:FAC-6-1:236;
Input Parameters
Table 21-11 RTRV-<STM_TYPE> Input Parameters
|
|
AID |
Access identifier from the "FACILITY" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>],
[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>],
[RINGID=<RINGID>],[MSSPRTYPE=<MSSPRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>],
[CCID=<CCID>],[NBRIX=<NBRIX>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],
[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],[LDCC=<LDCC>],[NAME=<NAME>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[EXPTRC=<EXPTRC>],[TRC=<TRC>],
[TRCMODE=<TRCMODE>],[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>],
[SENDDUSFF=<SENDDUSFF>],[AISONLPBK=<AISONLPBK>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>],[FOREIGNFEND=<FOREIGNFEND>],
[FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],:<PSTPSTQ>,[<SSTQ>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:DCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SDH,WVLEN=1310.00,RINGID=43,
MSSPRTYPE=WESTWORK,MUX=E2,UNIC=Y,CCID=8,NBRIX=2,SOAK=52,
SOAKLEFT=12-25,SSMRCV=STU,OSPF=Y,LDCC=Y,
NAME=\"STM 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,UNLOCKED-DISABLED,
AUTOMATICINSERVICE"
;
Output Parameters
Table 21-12 RTRV-<STM_TYPE> Output Parameters
|
|
AID |
Access identifier from the "FACILITY" section |
ROLE |
An STM port role. Optional Parameter type is SIDE—the role the unit is playing in the protection group |
• PROT |
The entity is a protection unit in the protection group |
• WORK |
The entity is a working unit in the protection group |
STATUS |
An STM port status. Optional Parameter type is STATUS—the status of the unit in the protection pair |
• ACT |
The entity is the active unit in the shelf |
• NA |
Status is unavailable |
• STBY |
The entity is the standby unit in the shelf |
DCC |
Indicates whether or not the section DCC is to be used. Optional Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol |
• N |
The ring does not support the extended K1/K2/K3 protocol |
• Y |
The ring does support the extended K1/K2/K3 protocol |
AREA |
Area ID. Shows up only if the DCC is enabled. String. Optional |
TMGREF |
The termination to be used, whether primary or secondary. Identifies if an STM port has a timing reference. Defaults to N. Optional Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
SYNCMSG |
Synchronization status message Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol |
• N |
The ring does not support the extended K1/K2/K3 protocol |
• Y |
The ring does support the extended K1/K2/K3 protocol |
SENDDUS |
The facility will send the DUS (Don't use for Synchronization) value in 0x0f bits pattern as the synchronization status message for that facility. Defaults to N. Optional Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
PJMON |
(Optional) Identifies an STM port PJMON. PJMON is an integer. It defaults to 0 (zero). Set a valid VC4 number of the optical port. Note The PJMON number displayed in TL1 interface does not correspond to the PJVC4MON number in CTC, but instead corresonds to the VC4 number of the optical port. |
SFBER |
An STM port signal failure threshold. Defaults to 1E-4. Optional Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path |
• 1E-3 |
SFBER is 1E-3 |
• 1E-4 |
SFBER is 1E-4 |
• 1E-5 |
SFBER is 1E-5 |
SDBER |
An STM port signal degrade threshold. Defaults 1E-7. Optional Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path |
• 1E-5 |
SDBER is 1E-5 |
• 1E-6 |
SDBER is 1E-6 |
• 1E-7 |
SDBER is 1E-7 |
• 1E-8 |
SDBER is 1E-8 |
• 1E-9 |
SDBER is 1E-9 |
MODE |
STM port mode. Defaults to SDH. Optional Parameter type is OPTICAL_MODE—the facility's optical mode |
• SDH |
SDH/ETSI optical mode using European/International format |
• SONET |
SONET/ANSI optical mode using the American format |
WVLEN |
An STM port wavelength in nanometer. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. Float. Optional |
RINGID |
The MS-SPRing RINGID with which the port is connected. RINGID ranges from 0 to 9999. Integer. Optional |
MSSPRTYPE |
The MS-SPRing type with which the port is connected. Optional Parameter type is MSSPR_TYPE—MS-SPRing type of an STM port |
• EASTPROT |
The STM port is an east protecting port |
• EASTWORK |
The STM port is an east working port |
• WESTPROT |
The STM port is an west protecting port |
• WESTWORK |
The STM port is an west working port |
MUX |
MS-SPRing extension byte. Optional Parameter type is MUX_TYPE—MS-SPRing extension byte |
• E2 |
E2 byte (orderwire) |
• F1 |
F1 byte (user) |
• K3 |
K3 byte |
• Z2 |
Z2 byte |
SOAK |
Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Integer. Optional |
SOAKLEFT |
Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Optional Rules for <SOAKLEFT> are as follows: • When the port is in Locked, Locked_Maintenance or Unlocked state, the parameter will not appear. • When the port is in Locked_AutomaticInService, but the countdown has not started due to fault signal the value will be SOAKLEFT=NOT-STARTED. • When the port is in Locked_AutomaticInService state and the countdown has started the value will be shown in HH-MM format. |
SSMRCV |
Displays the quality of the individual port. Optional Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SDH |
• DUS_SDH |
Do Not Use For Synchronization |
• G811 |
G811 Standard |
• RES_SDH |
Reserved For Network Synchronization Use |
• G812T |
G812T Standard |
• STU_SDH |
Synchronized, Traceability Unknown |
• G812TL |
G812TL Standard |
• SETS |
Synchronous Equipment Timing Source |
OSPF |
The Open Shortest Path First discovery. Optional Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
LDCC |
The line DCC connection on the port. Optional Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol |
• N |
The ring does not support the extended K1/K2/K3 protocol |
• Y |
The ring does support the extended K1/K2/K3 protocol |
NAME |
Name. String. Optional |
LBCL |
Displays the current value of the laser current. Float. Optional |
OPT |
Displays the current value of the transmitted optical power. OPT is only displayed for DWDM cards. Float. Optional |
OPR |
Received optical power. Float. Optional |
EXPTRC |
Expected path trace content. String. Optional |
TRC |
Path trace message to be transmitted. String. Optional |
TRCMODE |
Path trace mode. Applicable only to VC-level Paths in SDH (VCn). Defaults to the OFF mode. Optional Parameter type is TRCMODE—trace mode |
• AUTO |
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards |
• AUTO-NO-AIS |
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected |
• MAN |
Use the provisioned expected string as the expected string |
• MAN-NO-AIS |
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected |
• OFF |
Turn off path trace capability. Nothing will be reported |
TRCFORMAT |
Trace message size. Optional |
|
Parameter type is TRCFORMAT—trace format |
• 1-BYTE |
1 byte trace message |
• 16-BYTE |
16 byte trace message |
• 64-BYTE |
64 byte trace message |
• Y |
Enable an attribute |
ADMSSM |
SSM selectable value. Only displayed when SSM is disabled. Optional |
|
Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SDH |
• DUS_SDH |
Do Not Use For Synchronization |
• G811 |
G811 Standard |
• RES_SDH |
Reserved For Network Synchronization Use |
• G812T |
G812T Standard |
• STU_SDH |
Synchronized, Traceability Unknown |
• G812TL |
G812TL Standard |
• SETS |
Synchronous Equipment Timing Source |
SENDDUSFF |
Indicates that the facility will send the DUS (Don't use for synchronization) value in 0xff bits pattern as the synchronization status message for that facility. Defaults to N. Optional |
|
Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
AISONLPBK |
Parameter type is AIS_ON_LPBK—indicates if AIS should be sent on loopback |
• AIS_ONLPBK_FACILITY |
AIS is sent on facility loopback |
• AIS_ON_LPBK_ALL |
AIS is sent on all loopbacks |
• AIS_ON_LPBK_OFF |
AIS is not sent on loopback |
• AIS_ON_LPBK_TERMINAL |
AIS is sent on terminal loopback |
FREQ |
Parameter type is OPTICAL_WLEN—optical wavelength |
• 1310 |
Wavelength 1310 |
• 1470 |
Wavelength 1470 |
• 1490 |
Wavelength 1490 |
• 1510 |
Wavelength 1510 |
• 1529.55 |
Wavelength 1529.55 |
• 1529.94 |
Wavelength 1529.94 |
• 1530 |
Wavelength 1530 |
• 1530.33 |
Wavelength 1530.33 |
• 1530.73 |
Wavelength 1530.73 |
• 1531.12 |
Wavelength 1531.12 |
• 1531.51 |
Wavelength 1531.51 |
• 1531.90 |
Wavelength 1531.90 |
• 1532.29 |
Wavelength 1532.29 |
• 1532.68 |
Wavelength 1532.68 |
• 1533.07 |
Wavelength 1533.07 |
• 1533.47 |
Wavelength 1533.47 |
• 1533.86 |
Wavelength 1533.86 |
• 1534.25 |
Wavelength 1534.25 |
• 1534.64 |
Wavelength 1534.64 |
• 1535.04 |
Wavelength 1535.04 |
• 1535.43 |
Wavelength 1535.43 |
• 1535.82 |
Wavelength 1535.82 |
• 1536.22 |
Wavelength 1536.22 |
• 1536.61 |
Wavelength 1536.61 |
• 1537 |
Wavelength 1537 |
• 1537.40 |
Wavelength 1537.40 |
• 1537.79 |
Wavelength 1537.79 |
• 1538.19 |
Wavelength 1538.19 |
• 1538.58 |
Wavelength 1538.58 |
• 1538.98 |
Wavelength 1538.98 |
• 1539.37 |
Wavelength 1539.37 |
• 1539.77 |
Wavelength 1539.77 |
• 1540.16 |
Wavelength 1540.16 |
• 1540.56 |
Wavelength 1540.56 |
• 1540.95 |
Wavelength 1540.95 |
• 1541.35 |
Wavelength 1541.35 |
• 1541.75 |
Wavelength 1541.75 |
• 1542.14 |
Wavelength 1542.14 |
• 1542.35 |
Wavelength 1542.35 |
• 1542.54 |
Wavelength 1542.54 |
• 1542.94 |
Wavelength 1542.94 |
• 1543.33 |
Wavelength 1543.33 |
• 1543.73 |
Wavelength 1543.73 |
• 1544.13 |
Wavelength 1544.13 |
• 1544.53 |
Wavelength 1544.53 |
• 1544.92 |
Wavelength 1544.92 |
• 1545.32 |
Wavelength 1545.32 |
• 1545.72 |
Wavelength 1545.72 |
• 1546.12 |
Wavelength 1546.12 |
• 1546.52 |
Wavelength 1546.52 |
• 1546.92 |
Wavelength 1546.92 |
• 1547.32 |
Wavelength 1547.32 |
• 1547.72 |
Wavelength 1547.72 |
• 1548.12 |
Wavelength 1548.12 |
• 1548.51 |
Wavelength 1548.51 |
• 1548.92 |
Wavelength 1548.92 |
• 1549.32 |
Wavelength 1549.32 |
• 1549.71 |
Wavelength 1549.71 |
• 1550 |
Wavelength 1500 |
• 1550.12 |
Wavelength 1550.12 |
• 1550.52 |
Wavelength 1550.52 |
• 1550.92 |
Wavelength 1550.92 |
• 1551.32 |
Wavelength 1551.32 |
• 1551.72 |
Wavelength 1551.72 |
• 1552.12 |
Wavelength 1552.12 |
• 1552.52 |
Wavelength 1552.52 |
• 1552.93 |
Wavelength 1552.93 |
• 1553.33 |
Wavelength 1553.33 |
• 1553.73 |
Wavelength 1553.73 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.94 |
Wavelength 1554.94 |
• 1555.34 |
Wavelength 1555.34 |
• 1555.75 |
Wavelength 1555.75 |
• 1556.15 |
Wavelength 1556.15 |
• 1556.55 |
Wavelength 1556.55 |
• 1556.96 |
Wavelength 1556.96 |
• 1557.36 |
Wavelength 1557.36 |
• 1557.77 |
Wavelength 1557.77 |
• 1558.17 |
Wavelength 1558.17 |
• 1558.58 |
Wavelength 1558.58 |
• 1558.98 |
Wavelength 1558.98 |
• 1559.39 |
Wavelength 1559.39 |
• 1559.79 |
Wavelength 1559.79 |
• 1560.20 |
Wavelength 1560.20 |
• 1560.61 |
Wavelength 1560.61 |
• 1561.01 |
Wavelength 1561.01 |
• 1561.42 |
Wavelength 1561.42 |
• 1561.83 |
Wavelength 1561.83 |
• 1570 |
Wavelength 1570 |
• 1570.83 |
Wavelength 1570.83 |
• 1571.24 |
Wavelength 1571.24 |
• 1571.65 |
Wavelength 1571.65 |
• 1572.06 |
Wavelength 1572.06 |
• 1572.48 |
Wavelength 1572.48 |
• 1572.89 |
Wavelength 1572.89 |
• 1573.30 |
Wavelength 1573.30 |
• 1573.71 |
Wavelength 1573.71 |
• 1574.13 |
Wavelength 1574.13 |
• 1574.54 |
Wavelength 1574.54 |
• 1574.95 |
Wavelength 1574.95 |
• 1575.37 |
Wavelength 1575.37 |
• 1575.78 |
Wavelength 1575.78 |
• 1576.20 |
Wavelength 1576.20 |
• 1576.61 |
Wavelength 1576.61 |
• 1577.03 |
Wavelength 1577.03 |
• 1577.44 |
Wavelength 1577.44 |
• 1577.86 |
Wavelength 1577.86 |
• 1578.27 |
Wavelength 1578.27 |
• 1578.69 |
Wavelength 1578.69 |
• 1579.10 |
Wavelength 1579.10 |
• 1579.52 |
Wavelength 1579.52 |
• 1579.93 |
Wavelength 1579.93 |
• 1580.35 |
Wavelength 1580.35 |
• 1580.77 |
Wavelength 1580.77 |
• 1581.18 |
Wavelength 1581.18 |
• 1581.60 |
Wavelength 1581.60 |
• 1582.02 |
Wavelength 1582.02 |
• 1582.44 |
Wavelength 1582.44 |
• 1582.85 |
Wavelength 1582.85 |
• 1583.27 |
Wavelength 1583.27 |
• 1583.69 |
Wavelength 1583.69 |
• 1584.11 |
Wavelength 1584.11 |
• 1584.53 |
Wavelength 1584.53 |
• 1584.95 |
Wavelength 1584.95 |
• 1585.36 |
Wavelength 1585.36 |
• 1585.78 |
Wavelength 1585.78 |
• 1586.20 |
Wavelength 1586.20 |
• 1586.62 |
Wavelength 1586.62 |
• 1587.04 |
Wavelength 1587.04 |
• 1587.46 |
Wavelength 1587.46 |
• 1587.88 |
Wavelength 1587.88 |
• 1588.30 |
Wavelength 1588.30 |
• 1588.73 |
Wavelength 1588.73 |
• 1589.15 |
Wavelength 1589.15 |
• 1589.57 |
Wavelength 1589.57 |
• 1589.99 |
Wavelength 1589.99 |
• 1590 |
Wavelength 1590 |
• 1590.41 |
Wavelength 1590.41 |
• 1590.83 |
Wavelength 1590.83 |
• 1591.26 |
Wavelength 1591.26 |
• 1591.68 |
Wavelength 1591.68 |
• 1592.10 |
Wavelength 1592.10 |
• 1592.52 |
Wavelength 1592.52 |
• 1592.95 |
Wavelength 1592.95 |
• 1593.37 |
Wavelength 1593.37 |
• 1593.79 |
Wavelength 1593.79 |
• 1594.22 |
Wavelength 1594.22 |
• 1594.64 |
Wavelength 1594.64 |
• 1595.06 |
Wavelength 1595.06 |
• 1595.49 |
Wavelength 1595.49 |
• 1596.34 |
Wavelength 1596.34 |
• 1596.76 |
Wavelength 1596.76 |
• 1597.19 |
Wavelength 1597.19 |
• 1597.62 |
Wavelength 1597.62 |
• 1598.04 |
Wavelength 1598.04 |
• 1598.47 |
Wavelength 1598.47 |
• 1598.89 |
Wavelength 1598.89 |
• 1599.32 |
Wavelength 1599.32 |
• 1599.75 |
Wavelength 1599.75 |
• 1600.06 |
Wavelength 1600.06 |
• 1601.03 |
Wavelength 1601.03 |
• 1601.46 |
Wavelength 1601.46 |
• 1601.88 |
Wavelength 1601.88 |
• 1602.31 |
Wavelength 1602.31 |
• 1602.74 |
Wavelength 1602.74 |
• 1603.17 |
Wavelength 1603.17 |
• 1603.60 |
Wavelength 1603.60 |
• 1604.03 |
Wavelength 1604.03 |
• 1610 |
Wavelength 1610 |
• USE-TWL1 |
Use Tunable Wavelength 1 |
LOSSB |
Parameter type is REACH—reach values |
• AUTOPROV |
Autoprovisioning |
• CX |
Reach CX |
• DX |
Reach DX |
• HX |
Reach HX |
• I1 |
Reach I1 |
• IR-1 |
Reach IR-1 |
• IR-2 |
Reach IR-2 |
• L1 |
Reach L1 |
• L2 |
Reach L2 |
• L3 |
Reach L3 |
• LR-1 |
Reach LR-1 |
• LR-2 |
Reach LR-2 |
• LR-3 |
Reach LR-3 |
• LX |
Reach LX |
• S1 |
Reach S1 |
• S2 |
Reach S2 |
• SR |
Reach SR |
• SR-1 |
Reach SR-1 |
• SX |
Reach SX |
• T |
Reach T |
• VX |
Reach VX |
• ZX |
Reach ZX |
FOREIGNFEND |
Indicates whether the far-end NE on the DCC is a foreign NE Parameter type is ON_OFF—disable or enabled an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
FOREIGNIP |
The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. String |
PST_PSTQ |
Admin state in the PST_PSTQ format |
|
Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ) |
• Unlocked-Enabled |
In service - normal |
• Locked-Disabled |
Out of service - autonomous |
• Locked-Disabled |
Out of service - autonomous and management |
• Locked-Enabled |
Out of service - management |
SSTQ |
Secondary state of the entity. Optional Parameter type is SST—provides additional information pertaining to PST and PSTQ |
• AutomaticInService |
Automatic in service |
• Disabled |
Disabled |
• Loopback |
Loopback |
• MismatchofEquipmentAlarm |
Mismatch of equipment and attributes |
• Maintenance |
Maintenance mode |
• OutOfGroup |
Out of group |
• SoftwareDownload |
Software downloading |
• Unassigned |
Unassigned |
• NotInstalled |
Unequipped |
21.7 RTRV-10GIGE
Retrieve 10GIGE
Usage Guidelines
This command retrieves the 10 Gbps-specific parameters for a port that has been configured to support the gigabyte Ethernet payload with the ENT-10GIGE command.
Category
Ports
Security
Retrieve
Input Format
RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-10GIGE:TID:FAC-1-1:100;
Input Parameters
Table 21-13 RTRV-10GIGE Input Parameters
|
|
AID |
Access identifier from the "FACILITY" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PSTPSTQ>,[<SST>]"
;
Output Examples
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:NAME=\"NY PORT\",MACADDR=00-0E-AA-BB-CC-FF,LBCL=10.0,
OPT=10.0,OPR=10.0,FREQ=1550,LOSSB=SX:Unlocked-Disabled,AutomaticInService"
;
Output Parameters
Table 21-14 RTRV-10GIGE Output Parameters
|
|
AID |
Access identifier from the "FACILITY" section |
ROLE |
The port role in a Y-cable protection scheme. Optional Parameter type is SIDE—the role the unit is playing in the protection group |
• PROT |
The entity is a protection unit in the protection group |
• WORK |
The entity is a working unit in the protection group |
STATUS |
Port status in a Y-cable protection scheme. Optional Parameter type is STATUS—the status of the unit in the protection pair |
• ACT |
The entity is the active unit in the shelf |
• NA |
Status is unavailable |
• STBY |
The entity is the standby unit in the shelf |
NAME |
Port name. String. Optional |
MACADDR |
The MAC address for the 10 gigabyte Ethernet payload. String. Optional |
LBCL |
Displays the current value of the laser current. Float. Optional |
OPT |
Displays the current value of the transmitted optical power. Float. Optional |
OPR |
Displays the current value of the received optical power. Float. Optional |
FREQ |
Parameter type is OPTICAL_WLEN—optical wavelength |
• 1310 |
Wavelength 1310 |
• 1470 |
Wavelength 1470 |
• 1490 |
Wavelength 1490 |
• 1510 |
Wavelength 1510 |
• 1529.55 |
Wavelength 1529.55 |
• 1529.94 |
Wavelength 1529.94 |
• 1530 |
Wavelength 1530 |
• 1530.33 |
Wavelength 1530.33 |
• 1530.73 |
Wavelength 1530.73 |
• 1531.12 |
Wavelength 1531.12 |
• 1531.51 |
Wavelength 1531.51 |
• 1531.90 |
Wavelength 1531.90 |
• 1532.29 |
Wavelength 1532.29 |
• 1532.68 |
Wavelength 1532.68 |
• 1533.07 |
Wavelength 1533.07 |
• 1533.47 |
Wavelength 1533.47 |
• 1533.86 |
Wavelength 1533.86 |
• 1534.25 |
Wavelength 1534.25 |
• 1534.64 |
Wavelength 1534.64 |
• 1535.04 |
Wavelength 1535.04 |
• 1535.43 |
Wavelength 1535.43 |
• 1535.82 |
Wavelength 1535.82 |
• 1536.22 |
Wavelength 1536.22 |
• 1536.61 |
Wavelength 1536.61 |
• 1537 |
Wavelength 1537 |
• 1537.40 |
Wavelength 1537.40 |
• 1537.79 |
Wavelength 1537.79 |
• 1538.19 |
Wavelength 1538.19 |
• 1538.58 |
Wavelength 1538.58 |
• 1538.98 |
Wavelength 1538.98 |
• 1539.37 |
Wavelength 1539.37 |
• 1539.77 |
Wavelength 1539.77 |
• 1540.16 |
Wavelength 1540.16 |
• 1540.56 |
Wavelength 1540.56 |
• 1540.95 |
Wavelength 1540.95 |
• 1541.35 |
Wavelength 1541.35 |
• 1541.75 |
Wavelength 1541.75 |
• 1542.14 |
Wavelength 1542.14 |
• 1542.35 |
Wavelength 1542.35 |
• 1542.54 |
Wavelength 1542.54 |
• 1542.94 |
Wavelength 1542.94 |
• 1543.33 |
Wavelength 1543.33 |
• 1543.73 |
Wavelength 1543.73 |
• 1544.13 |
Wavelength 1544.13 |
• 1544.53 |
Wavelength 1544.53 |
• 1544.92 |
Wavelength 1544.92 |
• 1545.32 |
Wavelength 1545.32 |
• 1545.72 |
Wavelength 1545.72 |
• 1546.12 |
Wavelength 1546.12 |
• 1546.52 |
Wavelength 1546.52 |
• 1546.92 |
Wavelength 1546.92 |
• 1547.32 |
Wavelength 1547.32 |
• 1547.72 |
Wavelength 1547.72 |
• 1548.12 |
Wavelength 1548.12 |
• 1548.51 |
Wavelength 1548.51 |
• 1548.92 |
Wavelength 1548.92 |
• 1549.32 |
Wavelength 1549.32 |
• 1549.71 |
Wavelength 1549.71 |
• 1550 |
Wavelength 1500 |
• 1550.12 |
Wavelength 1550.12 |
• 1550.52 |
Wavelength 1550.52 |
• 1550.92 |
Wavelength 1550.92 |
• 1551.32 |
Wavelength 1551.32 |
• 1551.72 |
Wavelength 1551.72 |
• 1552.12 |
Wavelength 1552.12 |
• 1552.52 |
Wavelength 1552.52 |
• 1552.93 |
Wavelength 1552.93 |
• 1553.33 |
Wavelength 1553.33 |
• 1553.73 |
Wavelength 1553.73 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.13 |
Wavelength 1554.13 |
• 1554.94 |
Wavelength 1554.94 |
• 1555.34 |
Wavelength 1555.34 |
• 1555.75 |
Wavelength 1555.75 |
• 1556.15 |
Wavelength 1556.15 |
• 1556.55 |
Wavelength 1556.55 |
• 1556.96 |
Wavelength 1556.96 |
• 1557.36 |
Wavelength 1557.36 |
• 1557.77 |
Wavelength 1557.77 |
• 1558.17 |
Wavelength 1558.17 |
• 1558.58 |
Wavelength 1558.58 |
• 1558.98 |
Wavelength 1558.98 |
• 1559.39 |
Wavelength 1559.39 |
• 1559.79 |
Wavelength 1559.79 |
• 1560.20 |
Wavelength 1560.20 |
• 1560.61 |
Wavelength 1560.61 |
• 1561.01 |
Wavelength 1561.01 |
• 1561.42 |
Wavelength 1561.42 |
• 1561.83 |
Wavelength 1561.83 |
• 1570 |
Wavelength 1570 |
• 1570.83 |
Wavelength 1570.83 |
• 1571.24 |
Wavelength 1571.24 |
• 1571.65 |
Wavelength 1571.65 |
• 1572.06 |
Wavelength 1572.06 |
• 1572.48 |
Wavelength 1572.48 |
• 1572.89 |
Wavelength 1572.89 |
• 1573.30 |
Wavelength 1573.30 |
• 1573.71 |
Wavelength 1573.71 |
• 1574.13 |
Wavelength 1574.13 |
• 1574.54 |
Wavelength 1574.54 |
• 1574.95 |
Wavelength 1574.95 |
• 1575.37 |
Wavelength 1575.37 |
• 1575.78 |
Wavelength 1575.78 |
• 1576.20 |
Wavelength 1576.20 |
• 1576.61 |
Wavelength 1576.61 |
• 1577.03 |
Wavelength 1577.03 |
• 1577.44 |
Wavelength 1577.44 |
• 1577.86 |
Wavelength 1577.86 |
• 1578.27 |
Wavelength 1578.27 |
• 1578.69 |
Wavelength 1578.69 |
• 1579.10 |
Wavelength 1579.10 |
• 1579.52 |
Wavelength 1579.52 |
• 1579.93 |
Wavelength 1579.93 |
• 1580.35 |
Wavelength 1580.35 |
• 1580.77 |
Wavelength 1580.77 |
• 1581.18 |
Wavelength 1581.18 |
• 1581.60 |
Wavelength 1581.60 |
• 1582.02 |
Wavelength 1582.02 |
• 1582.44 |
Wavelength 1582.44 |
• 1582.85 |
Wavelength 1582.85 |
• 1583.27 |
Wavelength 1583.27 |
• 1583.69 |
Wavelength 1583.69 |
• 1584.11 |
Wavelength 1584.11 |
• 1584.53 |
Wavelength 1584.53 |
• 1584.95 |
Wavelength 1584.95 |
• 1585.36 |
Wavelength 1585.36 |
• 1585.78 |
Wavelength 1585.78 |
• 1586.20 |
Wavelength 1586.20 |
• 1586.62 |
Wavelength 1586.62 |
• 1587.04 |
Wavelength 1587.04 |
• 1587.46 |
Wavelength 1587.46 |
• 1587.88 |
Wavelength 1587.88 |
• 1588.30 |
Wavelength 1588.30 |
• 1588.73 |
Wavelength 1588.73 |
• 1589.15 |
Wavelength 1589.15 |
• 1589.57 |
Wavelength 1589.57 |
• 1589.99 |
Wavelength 1589.99 |
• 1590 |
Wavelength 1590 |
• 1590.41 |
Wavelength 1590.41 |
• 1590.83 |
Wavelength 1590.83 |
• 1591.26 |
Wavelength 1591.26 |
• 1591.68 |
Wavelength 1591.68 |
• 1592.10 |
Wavelength 1592.10 |
• 1592.52 |
Wavelength 1592.52 |
• 1592.95 |
Wavelength 1592.95 |
• 1593.37 |
Wavelength 1593.37 |
• 1593.79 |
Wavelength 1593.79 |
• 1594.22 |
Wavelength 1594.22 |
• 1594.64 |
Wavelength 1594.64 |
• 1595.06 |
Wavelength 1595.06 |
• 1595.49 |
Wavelength 1595.49 |
• 1596.34 |
Wavelength 1596.34 |
• 1596.76 |
Wavelength 1596.76 |
• 1597.19 |
Wavelength 1597.19 |
• 1597.62 |
Wavelength 1597.62 |
• 1598.04 |
Wavelength 1598.04 |
• 1598.47 |
Wavelength 1598.47 |
• 1598.89 |
Wavelength 1598.89 |
• 1599.32 |
Wavelength 1599.32 |
• 1599.75 |
Wavelength 1599.75 |
• 1600.06 |
Wavelength 1600.06 |
• 1601.03 |
Wavelength 1601.03 |
• 1601.46 |
Wavelength 1601.46 |
• 1601.88 |
Wavelength 1601.88 |
• 1602.31 |
Wavelength 1602.31 |
• 1602.74 |
Wavelength 1602.74 |
• 1603.17 |
Wavelength 1603.17 |
• 1603.60 |
Wavelength 1603.60 |
• 1604.03 |
Wavelength 1604.03 |
• 1610 |
Wavelength 1610 |
• USE-TWL1 |
Use Tunable Wavelength 1 |
LOSSB |
Parameter type is REACH—reach values |
• AUTOPROV |
Autoprovisioning |
• CX |
Reach CX |
• DX |
Reach DX |
• HX |
Reach HX |
• I1 |
Reach I1 |
• IR-1 |
Reach IR-1 |
• IR-2 |
Reach IR-2 |
• L1 |
Reach L1 |
• L2 |
Reach L2 |
• L3 |
Reach L3 |
• LR-1 |
Reach LR-1 |
• LR-2 |
Reach LR-2 |
• LR-3 |
Reach LR-3 |
• LX |
Reach LX |
• S1 |
Reach S1 |
• S2 |
Reach S2 |
• SR |
Reach SR |
• SR-1 |
Reach SR-1 |
• SX |
Reach SX |
• T |
Reach T |
• VX |
Reach VX |
• ZX |
Reach ZX |
PST_PSTQ |
Admin state in the PST_PSTQ format Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ) |
• Unlocked-Enabled |
In service - normal |
• Locked-Disabled |
Out of service - autonomous |
• Locked-Disabled |
Out of service - autonomous and management |
• Locked-Enabled |
Out of service - management |
SST |
Secondary state of the entity. Optional Parameter type is SST—provides additional information pertaining to PST and PSTQ |
• AutomaticInService |
Automatic in service |
• Disabled |
Disabled |
• Loopback |
Loopback |
• MismatchofEquipmentAlarm |
Mismatch of equipment and attributes |
• Maintenance |
Maintenance mode |
• OutOfGroup |
Out of group |
• SoftwareDownload |
Software downloading |
• Unassigned |
Unassigned |
• NotInstalled |
Unequipped |
21.8 RTRV-ALM-<MOD2ALM>
Retrieve Alarm (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS3I, E1, E100, E1000, E3, E4, FSTE, G1000, GFPOS, GIGE, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, STS36C, VC4, VC416C, VC42C, VC43C, UDCDCC, UDCF, VCG, VC11, VC12, WLEN)
Usage Guidelines
This command retrieves and sends the current status of alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
See Table 27-1 for supported modifiers by platform.
Note
VT1-n-n-n replaces PS_VC12-n-n-n for the VC12 alarm AID.
Note
The [<AIDTYPE>] shows VC3 for VC alarms.
Category
Fault
Security
Retrieve
Input Format
RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];
Input Example
RTRV-ALM-STM4:ELDRIDGE:FAC-5-1:225::MN,SD,SA;
Input Parameters
Table 21-15 RTRV-ALM-<MOD2ALM> Input Parameters
|
|
AID |
Access identifier from the "AidUnionId" section. Must not be null |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See the Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],,:[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1,STM4:MJ,SD,SA,09-05,12-30-20,,:\"BER AT SIGNAL DEGRADE LEVEL\","
;
Output Parameters
Table 21-16 RTRV-ALM-<MOD2ALM> Output Parameters
|
|
AID |
Access identifier from the "ALL" section |
AIDTYPE |
Type of access identifier. Optional Parameter type is MOD2ALM—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 1GISC3 |
1 Gbps ISC3 compatible |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• CLNT |
Client facility for MXP/TXP cards |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 frame. Only applicable to STM1E port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GFPOS |
Generic framing protocol over packet over SDH virtual port alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G payload |
• ISC3PEER2G |
ISC3PEER2G payload |
• ISC3PEER2R |
ISC3PEER2R payload |
• ISCCOMPAT |
ISCCOMPAT payload |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC38C |
VC38C alarm |
• VC44C |
VC44C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
• UDCDCC |
UDCDCC alarm |
• UDCF |
UCDF alarm |
• VCG |
Virtual Concatenation Group alarm |
• WLEN |
Wavelength Path Provisioning |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See the Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date when the specific event or violation occurred. Optional |
OCRTM |
Time when the specific event or violation occurred. Optional |
DESC |
The condition description |
21.9 RTRV-ALM-ALL
Retrieve Alarm All
Usage Guidelines
This command retrieves and sends the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
To retrieve all the NE alarms, issue all of the following commands:
RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-ENV
RTRV-ALM-SYNCN
Category
Fault
Security
Retrieve
Input Format
RTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDITION>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA;
Input Parameters
Table 21-17 RTRV-ALM-ALL Input Parameters
|
|
AID |
Access identifier from the "ALL" section. A null value is equivalent to ALL. String |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDITION |
The type of alarm condition. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,<OCRDAT>,
<OCRTM>,,:[<DESC>],[<AIDDET>]"
;
Output Examples
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,08-01,14-25-59,,:\"POWER FAIL RESTART\",E1-N-14"
;
Output Parameters
Table 21-18 RTRV-ALM-ALL Output Parameters
|
|
AID |
Access identifier from the "ALL" section. Optional |
AIDTYPE |
Type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date |
OCRTM |
Time |
DESC |
A condition description. String. Optional |
AIDDET |
AIDDET uses the same addressing rules as the AID, but specifies AID type and additional details about the entity being managed. The supplementary equipment identification. Optional |
21.10 RTRV-ALM-BITS
Retrieve Alarm Building Integrated Timing Supply
Usage Guidelines
This command retrieves and sends the current status of alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.
Category
Synchronization
Security
Retrieve
Input Format
RTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Input Parameters
Table 21-19 RTRV-ALM-BITS Input Parameters
|
|
AID |
Access identifier from the "BITS" section. Must not be null |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
The condition type for an alarm or reported event. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,:[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,08-01,14-25-59,,:\"LOSS OF SIGNAL\","
;
Output Parameters
Table 21-20 RTRV-ALM-BITS Output Parameters
|
|
AID |
Access identifier from the "BITS" section. Optional |
AIDTYPE |
Type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date. Optional |
OCRTM |
Time. Optional |
DESC |
A condition description. String. Optional |
21.11 RTRV-ALM-ENV
Retrieve Alarm Environment
Usage Guidelines
This command retrieves the environmental alarms.
Category
Environment
Security
Retrieve
Input Format
RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-21 RTRV-ALM-ENV Input Parameters
|
|
AID |
Access identifier from the "ENV" section. Must not be null Note For RTRV-ALM-ENV, only ENV-IN-{1-4} is a valid AID. ENV-OUT-{1,6} is not a valid AID for RTRV-ALM-ENV. |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
ALMTYPE |
The alarm type for the environmental alarm. A null value is equivalent to ALL Parameter type is ENV_ALM—environmental alarm types |
• AIRCOMPR |
Air compressor failure |
• AIRCOND |
Air conditioning failure |
• AIRDRYR |
Air dryer failure |
• BATDSCHRG |
Battery discharging |
• BATTERY |
Battery failure |
• CLFAN |
Cooling fan failure |
• CPMAJOR |
Centralized power major failure |
• CPMINOR |
Centralized power minor failure |
• ENGINE |
Engine failure |
• ENGOPRG |
Engine operating |
• ENGTRANS |
Standby engine transfer |
• EXPLGS |
Explosive gas |
• FIRDETR |
Fire detector failure |
• FIRE |
Fire |
• FLOOD |
Flood |
• FUELLEAK |
Fuel leak |
• FUSE |
Fuse failure |
• GASALARM |
Explosive gas, toxic gas, ventilation fail or gas monitor fail |
• HATCH |
CEV hatch fail |
• GEN |
Generator failure |
• HIAIR |
High air flow |
• HIHUM |
High humidity |
• HITEMP |
High temperature |
• HIWTR |
High water |
• INTRUDER |
Intrusion |
• LEVELCON |
Level converter |
• LVDADSL |
Secondary ADSL low voltage disconnect |
• LVDBYPAS |
Low voltage disconnected bypass |
• LWBATVG |
Low battery voltage |
• LWFUEL |
Low fuel |
• LWHUM |
Low humidity |
• LWPRES |
Low cable pressure |
• LWTEMP |
Low temperature |
• LWWTR |
Low water |
• MISC |
Miscellaneous |
• OPENDR |
Open door |
• POWER |
Commercial power failure |
• PUMP |
Pump failure |
• PWR-48 |
48V power supply failure |
• PWR-139 |
-139V power converter |
• PWR-190 |
-190V power converter |
• PWRMJ |
Power supply major |
• PWRMN |
Power supply minor |
• RECT |
Rectifier failure |
• RECTHI |
Rectifier high voltage |
• RECTLO |
Rectifier low voltage |
• RINGGENMJ |
Ringing generator major |
• RINGGENMN |
Ringing generator minor |
• RTACADSL |
AC or AC/rectifier power fail ADSL equipment |
• RTACCRIT |
AC or AC/rectifier power fail DCL equipment critical site |
• RTACPWR |
AC or AC/rectifier power fail DCL equipment |
• RTACPWRENG |
Commercial AC fail, site equipped with standby engine |
• RTBAYPWR |
AC power loss distributed power RT bay |
• RTRVENG |
Retrieve standby engine, commercial AC restored |
• SMOKE |
Smoke |
• TEMP |
High-low temperature |
• TOXICGAS |
Toxic gas |
• TREPEATER |
T-repeater shelf |
• VENTN |
Ventilation system failure |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,08-01,14-25-59,\"OPEN DOOR\""
;
Output Parameters
Table 21-22 RTRV-ALM-ENV Output Parameters
|
|
AID |
Access identifier from the "ENV" section |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
ALMTYPE |
The alarm type for the environmental alarm. A null value is equivalent to ALL Parameter type is ENV_ALM—environmental alarm types |
• AIRCOMPR |
Air compressor failure |
• AIRCOND |
Air conditioning failure |
• AIRDRYR |
Air dryer failure |
• BATDSCHRG |
Battery discharging |
• BATTERY |
Battery failure |
• CLFAN |
Cooling fan failure |
• CPMAJOR |
Centralized power major failure |
• CPMINOR |
Centralized power minor failure |
• ENGINE |
Engine failure |
• ENGOPRG |
Engine operating |
• ENGTRANS |
Standby engine transfer |
• EXPLGS |
Explosive gas |
• FIRDETR |
Fire detector failure |
• FIRE |
Fire |
• FLOOD |
Flood |
• FUELLEAK |
Fuel leak |
• FUSE |
Fuse failure |
• GASALARM |
Explosive gas, toxic gas, ventilation fail or gas monitor fail |
• HATCH |
CEV hatch fail |
• GEN |
Generator failure |
• HIAIR |
High air flow |
• HIHUM |
High humidity |
• HITEMP |
High temperature |
• HIWTR |
High water |
• INTRUDER |
Intrusion |
• LEVELCON |
Level converter |
• LVDADSL |
Secondary ADSL low voltage disconnect |
• LVDBYPAS |
Low voltage disconnect bypass |
• LWBATVG |
Low battery voltage |
• LWFUEL |
Low fuel |
• LWHUM |
Low humidity |
• LWPRES |
Low cable pressure |
• LWTEMP |
Low temperature |
• LWWTR |
Low water |
• MISC |
Miscellaneous |
• OPENDR |
Open door |
• POWER |
Commercial power failure |
• PUMP |
Pump failure |
• PWR-48 |
48V power supply failure |
• PWR-139 |
-139V power converter |
• PWR-190 |
-190V power converter |
• PWRMJ |
Power supply major |
• PWRMN |
Power supply minor |
• RECT |
Rectifier failure |
• RECTHI |
Rectifier high voltage |
• RECTLO |
Rectifier low voltage |
• RINGGENMJ |
Ringing generator major |
• RINGGENMN |
Ringing generator minor |
• RTACADSL |
AC or AC/rectifier power fail ADSL equipment |
• RTACCRIT |
AC or AC/rectifier power fail DCL equipment critical site |
• RTACPWR |
AC or AC/rectifier power fail DCL equipment |
• RTACPWRENG |
Commercial AC fail, site equipped with standby engine |
• RTBAYPWR |
AC power loss distributed power RT bay |
• RTRVENG |
Retrieve standby engine, commercial AC restored |
• SMOKE |
Smoke |
• TEMP |
High-low temperature |
• TOXICGAS |
Toxic gas |
• TREPEATER |
T-repeater shelf |
• VENTN |
Ventilation system failure |
OCRDAT |
Date. Optional |
OCRTM |
Time. Optional |
DESC |
A condition description. String. Optional |
21.12 RTRV-ALM-EQPT
Retrieve Alarm Equipment
Usage Guidelines
This command retrieves and sends the current status of alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
Category
Equipment
Security
Retrieve
Input Format
RTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>][,,,];
Input Example
RTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;
Input Parameters
Table 21-23 RTRV-ALM-EQPT Input Parameters
|
|
AID |
Access identifier from the "EQPT" section. Must not be null |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
The condition type for an alarm or a reported event. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,,:[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,EQPT:MJ,HITEMP,NSA,08-01,14-25-59,,:\"HI TEMPERATURE\","
;
Output Parameters
Table 21-24 RTRV-ALM-EQPT Output Parameters
|
|
AID |
Access identifier from the "EQPT" section. Optional |
AIDTYPE |
Type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date. Optional |
OCRTM |
Time. Optional |
DESC |
A condition description. String. Optional |
21.13 RTRV-ALM-SYNCN
Retrieve Alarm Synchronization
Usage Guidelines
This command retrieves and sends the current status of alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
Category
Synchronization
Security
Retrieve
Input Format
RTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][,,,];
Input Example
RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Input Parameters
Table 21-25 RTRV-ALM-SYNCN Input Parameters
|
|
AID |
Access identifier from the "SYNC_REF" section. Must not be null |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
The condition type for an alarm or a reported event. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],,:[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:CR,FAILTOSW,SA,
08-01,14-25-59,,:\"FAILURE TO SWITCH TO PROTECTION\","
;
Output Parameters
Table 21-26 RTRV-ALM-SYNCN Output Parameters
|
|
AID |
Access identifier from the "SYN" section |
AIDTYPE |
Type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date. Optional |
OCRTM |
Time. Optional |
DESC |
A condition description. String. Optional |
21.14 RTRV-ALMTH-<MOD2>
Retrieve Alarm Threshold (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS3I, DV6000, E1, E3, E4, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, STS36C, VC4, VC416C, VC42C, VC43C, VC11, VC12)
Usage Guidelines
This command retrieves the alarm threshold values. The only applicable MOD2 values are STM1, STM4, STM16, STM64, OCH, OMS, and OTS.
Category
DWDM
Security
Retrieve
Input Format
RTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::<ALMTHR>[,,::];
Input Example
RTRV-ALMTH-{MOD2}::CHAN-2-2:1::OPT-HIGH;
Input Parameters
Table 21-27 RTRV-ALMTH-<MOD2> Input Parameters
|
|
AID |
Access identifier from the "ALL" section. Must not be null |
ALMTHR |
Alarm threshold. Must not be null Parameter type is ALM_THR—alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards |
• BATV-EHIGH |
Battery Voltage - Extremely High |
• BATV-ELOW |
Battery Voltage - Extremely Low |
• BATV-HIGH |
Battery Voltage - High |
• BATV-LOW |
Battery Voltage - Low |
• GAIN-HDEG |
Gain not reached—High Degrade Threshold |
• GAIN-HFAIL |
Gain not reached—High Failure Threshold |
• GAIN-LDEG |
Gain not reached—Low Degrade Threshold |
• GAIN-LFAIL |
Gain not reached—Low Failure Threshold |
• LBCL-HIGH |
Laser Bias current in micro A as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%] |
• OPR-HIGH |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm] |
• OPR-LOW |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm |
• OPT-HIGH |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPT-LOW |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPWR-HDEG |
Optical Power—High Degrade Threshold |
• OPWR-HFAIL |
Optical Power—High Failure Threshold |
• OPWR-LDEG |
Optical Power—Low Degrade Threshold |
• OPWR-LFAIL |
Optical Power—Low Failure Threshold |
• VOA-HDEG |
VOA Attenuation—High Degrade Threshold |
• VOA-HFAIL |
VOA Attenuation—High Failure Threshold |
• VOA-LDEG |
VOA Attenuation—Low Degrade Threshold |
• VOA-LFAIL |
VOA Attenuation—Low Failure Threshold |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>:<CONDTYPE>,,,<THLEVEL>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,OCH:OPT-HIGH,,,20"
;
Output Parameters
Table 21-28 RTRV-ALMTH-<MOD2> Output Parameters
|
|
AID |
Access identifier from the "ALL" section |
MOD |
AID type Parameter type is MOD2—line/path modifier |
• 10GFC |
10 Gigabit Fibre Channel |
• 10GIGE |
10 Gigabit Ethernet |
• 1GFC |
1 Gigabit Fibre Channel |
• 1GFICON |
1 Gigabit FICON |
• 2GFC |
2 Gigabit Fibre Channel |
• 2GFICON |
2 Gigabit FICON |
• D1VIDEO |
D1 Video |
• DS3I |
DS3i-N-12 Line |
• DV6000 |
DV6000 |
• E1 |
E1 |
• E3 |
E3 |
• E4 |
E4 frame. Only applicable to STM1E port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode |
• ESCON |
ESCON |
• ETRCLO |
ETRCLO |
• FSTE |
FSTE facility |
• G1000 |
G1000 facility |
• GFPOS |
Generic Framing Protocol over Packet Over SDH. Virtual Ports partitioned using GFP's Multiplexing Capability |
• GIGE |
GIG Ethernet |
• HDTV |
HDTV |
• ISC3PEER1G |
ISC3PEER1G |
• ISC3PEER2G |
ISC3PEER2G |
• ISC3PEER2R |
ISC3PEER2R |
• ISCCOMPAT |
ISCCOMPAT |
• STM1 |
STM1 facility |
• STM4 |
STM4 facility |
• STM16 |
STM16 facility |
• STM64 |
STM64 facility |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port |
• STM1E |
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card |
• VC3 |
VC3 path |
• VC44C |
VC44C path |
• VC38C |
VC38C path |
• VC464C |
VC464C path |
• VC48C |
VC48C path |
• VC4 |
VC4 path |
• VC416C |
VC416C path |
• VC42C |
VC42C path |
• VC43C |
VC43C path |
• VC11 |
VC11 path |
• VC12 |
VC12 path |
CONDTYPE |
Condition type for an alarm or a reported event Parameter type is ALM_THR—alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards |
• BATV-EHIGH |
Battery Voltage - Extremely High |
• BATV-ELOW |
Battery Voltage - Extremely Low |
• BATV-HIGH |
Battery Voltage - High |
• BATV-LOW |
Battery Voltage - Low |
• GAIN-HDEG |
Gain not reached—High Degrade Threshold |
• GAIN-HFAIL |
Gain not reached—High Failure Threshold |
• GAIN-LDEG |
Gain not reached—Low Degrade Threshold |
• GAIN-LFAIL |
Gain not reached—Low Failure Threshold |
• LBCL-HIGH |
Laser Bias current in micro A as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%] |
• OPR-HIGH |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm] |
• OPR-LOW |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm |
• OPT-HIGH |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPT-LOW |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPWR-HDEG |
Optical Power—High Degrade Threshold |
• OPWR-HFAIL |
Optical Power—High Failure Threshold |
• OPWR-LDEG |
Optical Power—Low Degrade Threshold |
• OPWR-LFAIL |
Optical Power—Low Failure Threshold |
• VOA-HDEG |
VOA Attenuation—High Degrade Threshold |
• VOA-HFAIL |
VOA Attenuation—High Failure Threshold |
• VOA-LDEG |
VOA Attenuation—Low Degrade Threshold |
• VOA-LFAIL |
VOA Attenuation—Low Failure Threshold |
THLEVEL |
Threshold level. Float |
21.15 RTRV-ALMTH-EQPT
Retrieve Alarm Threshold Equipment
Usage Guidelines
This command retrieves the alarm thresholds for the power level monitoring on an NE.
Category
Equipment
Security
Retrieve
Input Format
RTRV-ALMTH-EQPT:[<TID>]:[<AID>]:<CTAG>::[<CONDTYPE>][,,::];
Input Example
RTRV-ALMTH-EQPT:::1::BATV-HIGH;
RTRV-ALMTH-EQPT::SHELF-2:1::BATV-HIGH;
Input Parameters
Table 21-29 RTRV-ALMTH-EQPT 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 |
Alarm threshold. A null value is equivalent to ALL. Parameter type is ALM_THR—alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards |
• BATV-EHIGH |
Battery Voltage - Extremely High |
• BATV-ELOW |
Battery Voltage - Extremely Low |
• BATV-HIGH |
Battery Voltage - High |
• BATV-LOW |
Battery Voltage - Low |
• GAIN-HDEG |
Gain not reached—High Degrade Threshold |
• GAIN-HFAIL |
Gain not reached—High Failure Threshold |
• GAIN-LDEG |
Gain not reached—Low Degrade Threshold |
• GAIN-LFAIL |
Gain not reached—Low Failure Threshold |
• LBCL-HIGH |
Laser Bias current in micro A as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%] |
• OPR-HIGH |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm] |
• OPR-LOW |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm |
• OPT-HIGH |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPT-LOW |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPWR-HDEG |
Optical Power—High Degrade Threshold |
• OPWR-HFAIL |
Optical Power—High Failure Threshold |
• OPWR-LDEG |
Optical Power—Low Degrade Threshold |
• OPWR-LFAIL |
Optical Power—Low Failure Threshold |
• VOA-HDEG |
VOA Attenuation—High Degrade Threshold |
• VOA-HFAIL |
VOA Attenuation—High Failure Threshold |
• VOA-LDEG |
VOA Attenuation—Low Degrade Threshold |
• VOA-LFAIL |
VOA Attenuation—Low Failure Threshold |
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],<MOD2B>:<CONDTYPE>,,,<DNFIELD>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SHELF-1,EQPT:BATV-HIGH,,,-52.0,"
;
TID-000 1998-06-20 14:30:00
M 001 COMPLD
",EQPT:BATV-HIGH,,,-52.0,""
;
Output Parameters
Table 21-30 RTRV-ALMTH-EQPT 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 Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
CONDTYPE |
Alarm threshold Parameter type is ALM_THR—alarm threshold list 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 |
• BATV-EHIGH |
Battery Voltage - Extremely High |
• BATV-ELOW |
Battery Voltage - Extremely Low |
• BATV-HIGH |
Battery Voltage - High |
• BATV-LOW |
Battery Voltage - Low |
• GAIN-HDEG |
Gain not reached—High Degrade Threshold |
• GAIN-HFAIL |
Gain not reached—High Failure Threshold |
• GAIN-LDEG |
Gain not reached—Low Degrade Threshold |
• GAIN-LFAIL |
Gain not reached—Low Failure Threshold |
• LBCL-HIGH |
Laser Bias current in micro A as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%] |
• OPR-HIGH |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm] |
• OPR-LOW |
Receive power in 1/10 micro W Measured value [-40.0 dBm,+30.0 dBm |
• OPT-HIGH |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPT-LOW |
Transmit power in 1/10 micro W. Measured value [-40.0 dBm,+30.0 dBm] |
• OPWR-HDEG |
Optical Power—High Degrade Threshold |
• OPWR-HFAIL |
Optical Power—High Failure Threshold |
• OPWR-LDEG |
Optical Power—Low Degrade Threshold |
• OPWR-LFAIL |
Optical Power—Low Failure Threshold |
• VOA-HDEG |
VOA Attenuation—High Degrade Threshold |
• VOA-HFAIL |
VOA Attenuation—High Failure Threshold |
• VOA-LDEG |
VOA Attenuation—Low Degrade Threshold |
• VOA-LFAIL |
VOA Attenuation—Low Failure Threshold |
DNFIELD |
Float |
21.16 RTRV-ALS
Retrieve Automatic Laser Shutoff
Usage Guidelines
This command retrieves the ALS attributes of an STM facility and all the facilities that support the ALS feature. This command is used to retrieve the ALS parameter of the STM16 and STM64 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
Category
Ports
Security
Retrieve
Input Format
RTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-ALS:PENNGROVE:FAC-1-1:1;
Input Parameters
Table 21-31 RTRV-ALS Input Parameters
|
|
AID |
Access identifier from the "AidUnionId" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>],
[ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1,STM64::ALSMODE=DISABLED,ALSRCINT=100,ALSRCPW=2.0,LSRSTAT=UP:"
;
Output Parameters
Table 21-32 RTRV-ALS Output Parameters
|
|
AID |
Access identifier from the "AidUnionId" section |
AIDTYPE |
Type of access identifier Parameter type is MOD2—line/path modifier |
• 10GFC |
10 Gigabit Fibre Channel |
• 10GIGE |
10 Gigabit Ethernet |
• 1GFC |
1 Gigabit Fibre Channel |
• 1GFICON |
1 Gigabit FICON |
• 1GISC3 |
1 Gbps ISC3 compatible |
• 2GFC |
2 Gigabit Fibre Channel |
• 2GFICON |
2 Gigabit FICON |
• 2GISC3 |
2 Gbps ISC3 compatible |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• D1VIDEO |
D1 video |
• DS3I |
DS3i-N-12 line |
• DV6000 |
DV6000 |
• E1 |
E1 |
• E3 |
E3 |
• E4 |
E4 frame. Only applicable to STM1E port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode |
• ESCON |
ESCON |
• ETRCLO |
ETRCLO |
• FSTE |
FSTE facility |
• G1000 |
G1000 facility |
• GFPOS |
Generic Framing Protocol over Packet Over SDH. Virtual Ports partitioned using GFP's Multiplexing Capability |
• GIGE |
Gigabit Ethernet |
• HDTV |
HDTV |
• ISC3PEER1G |
ISC3PEER1G |
• ISC3PEER2G |
ISC3PEER2G |
• ISC3PEER2R |
ISC3PEER2R |
• ISCCOMPAT |
ISCCOMPAT |
• OCH |
Optical Channel |
• OCHCC |
OCH Channel Connection |
• OCHNC |
OCH Network Connection |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port |
• STM1 |
STM1 facility |
• STM1E |
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card |
• STM4 |
STM4 facility |
• STM16 |
STM16 facility |
• STM64 |
STM64 facility |
• VC3 |
VC3 path |
• VC44C |
VC4-4C path |
• VC38C |
VC3-8C path |
• VC464C |
VC4-64C path |
• VC48C |
VC4-8C path |
• VC4 |
VC4 path |
• VC416C |
VC4-16C path |
• VC42C |
VC4-2C path |
• VC43C |
VC4-3C path |
• VC11 |
VC11 path |
• VC12 |
VC12 path |
ALSMODE |
ALS is enabled or disabled Parameter type is ALS_MODE—the working mode for automatic laser shutdown |
• AUTO |
Automatic |
• DISABLED |
Disabled |
• MAN |
Manual |
• MAN-RESTART |
Manual restart for test |
ALSRCINT |
ALS recovery interval. The range is 60 to 300 seconds. Integer. Optional |
ALSRCPW |
ALS recovery pulse width. The range is 2.0 to 100.00 seconds, in increments of 100 ms. Float. Optional |
LSRSTAT |
Status of the laser. Optional Parameter type is LASER_STATUS—status of laser |
• APR |
Laser is switched on but is working automatic power reduction |
• OFF |
Laser is switched off |
• ON |
Laser is switched on |
21.17 RTRV-APC
Operate Amplification Power Control
Usage Guidelines
This command retrieves the APC application attributes.
Category
DWDM
Security
Maintenance
Input Format
RTRV-APC:[<TID>]::<CTAG>;
Input Example
RTRV-APC:PENNGROVE::114;
Input Parameters
Table 21-33 RTRV-APC Input Parameters
|
|
— |
|
Output Format
SID DATE TIME
M CTAG COMPLD
"::[APCENABLE=<APCENABLE>],[APCSTATE=<APCSTATE>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"::APCENABLE=Y,APCSTATE=WORKING"
;
Output Parameters
Table 21-34 RTRV-APC Output Parameters
|
|
APCENABLE |
The enable/disable of the APC application. Optional Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
APCSTATE |
Indicates the status of the APC application. Optional Parameter type is APC_STATE—APC status |
• DISABLE |
The APC is disabled by the user and is not working |
• FORCED-DISABLE |
The APC has been internally disabled by the node and is not working |
• WORKING |
The APC is enabled by the user and is working |
21.18 RTRV-ATTR-CONT
Retrieve Attribute Control
Usage Guidelines
This command retrieves and sends the attributes associated with an external control. These attributes are used when an external control is operated or released. To set these attributes, use the SET-ATTR-CONT command.
Category
Environment
Security
Retrieve
Input Format
RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input Example
RTRV-ATTR-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Input Parameters
Table 21-35 RTRV-ATTR-CONT Input Parameters
|
|
AID |
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. Must not be null |
CONTTYPE |
Environmental control type. A null value is equivalent to ALL Parameter type is CONTTYPE—Environmental control types |
• AIRCOND |
Air conditioning |
• ENGINE |
Engine |
• FAN |
Fan |
• GEN |
Generator |
• HEAT |
Heat |
• LIGHT |
Light |
• MISC |
Miscellaneous |
• SPKLR |
Sprinkler |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND"
;
Output Parameters
Table 21-36 RTRV-ATTR-CONT Output Parameters
|
|
AID |
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set. Must not be null |
CONTTYPE |
Environmental control type. A null value is equivalent to ALL Parameter type is CONTTYPE—Environmental control types |
• AIRCOND |
Air conditioning |
• ENGINE |
Engine |
• FAN |
Fan |
• GEN |
Generator |
• HEAT |
Heat |
• LIGHT |
Light |
• MISC |
Miscellaneous |
• SPKLR |
Sprinkler |
21.19 RTRV-ATTR-ENV
Retrieve Attribute Environment
Usage Guidelines
This command retrieves the attributes associated with an environmental alarm.
Category
Environment
Security
Retrieve
Input Format
RTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-37 RTRV-ATTR-ENV Input Parameters
|
|
AID |
Access identifier from the "ENV" section. Must not be null |
NTFCNCDE |
Two-letter notification code Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
ALMTYPE |
The alarm type for the environmental alarm. A null value is equivalent to ALL Parameter type is ENV_ALM—environmental alarm types |
• AIRCOMPR |
Air compressor failure |
• AIRCOND |
Air conditioning failure |
• AIRDRYR |
Air dryer failure |
• BATDSCHRG |
Battery discharging |
• BATTERY |
Battery failure |
• CLFAN |
Cooling fan failure |
• CPMAJOR |
Centralized power major failure |
• CPMINOR |
Centralized power minor failure |
• ENGINE |
Engine failure |
• ENGOPRG |
Engine operating |
• ENGTRANS |
Standby engine transfer |
• EXPLGS |
Explosive gas |
• FIRDETR |
Fire detector failure |
• FIRE |
Fire |
• FLOOD |
Flood |
• FUELLEAK |
Fuel leak |
• FUSE |
Fuse failure |
• GASALARM |
Explosive gas, toxic gas, ventilation fail or gas monitor fail |
• HATCH |
CEV hatch fail |
• GEN |
Generator failure |
• HIAIR |
High air flow |
• HIHUM |
High humidity |
• HITEMP |
High temperature |
• HIWTR |
High water |
• INTRUDER |
Intrusion |
• LEVELCON |
Level converter |
• LVDADSL |
Secondary ADSL low voltage disconnect |
• LVDBYPAS |
Low voltage disconnect bypass |
• LWBATVG |
Low battery voltage |
• LWFUEL |
Low fuel |
• LWHUM |
Low humidity |
• LWPRES |
Low cable pressure |
• LWTEMP |
Low temperature |
• LWWTR |
Low water |
• MISC |
Miscellaneous |
• OPENDR |
Open door |
• POWER |
Commercial power failure |
• PUMP |
Pump failure |
• PWR-48 |
48V power supply failure |
• PWR-139 |
-139V power converter |
• PWR-190 |
-190V power converter |
• PWRMJ |
Power supply major |
• PWRMN |
Power supply minor |
• RECT |
Rectifier failure |
• RECTHI |
Rectifier high voltage |
• RECTLO |
Rectifier low voltage |
• RINGGENMJ |
Ringing generator major |
• RINGGENMN |
Ringing generator minor |
• RTACADSL |
AC or AC/rectifier power fail ADSL equipment |
• RTACCRIT |
AC or AC/rectifier power fail DCL equipment critical site |
• RTACPWR |
AC or AC/rectifier power fail DCL equipment |
• RTACPWRENG |
Commercial AC fail, site equipped with standby engine |
• RTBAYPWR |
AC power loss distributed power RT bay |
• RTRVENG |
Retrieve standby engine, commercial AC restored |
• SMOKE |
Smoke |
• TEMP |
High-low temperature |
• TOXICGAS |
Toxic gas |
• TREPEATER |
T-repeater shelf |
• VENTN |
Ventilation system failure |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[<NTFCNCDE>],[<ALMTYPE>],[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,\"OPEN DOOR\""
;
Output Parameters
Table 21-38 RTRV-ATTR-ENV Output Parameters
|
|
AID |
Access identifier from the "ENV" section. Must not be null |
NTFCNCDE |
Two-letter notification code. Optional Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
ALMTYPE |
The alarm type for the environmental alarm. Optional Parameter type is ENV_ALM—environmental alarm types |
• AIRCOMPR |
Air compressor failure |
• AIRCOND |
Air conditioning failure |
• AIRDRYR |
Air dryer failure |
• BATDSCHRG |
Battery discharging |
• BATTERY |
Battery failure |
• CLFAN |
Cooling fan failure |
• CPMAJOR |
Centralized power major failure |
• CPMINOR |
Centralized power minor failure |
• ENGINE |
Engine failure |
• ENGOPRG |
Engine operating |
• ENGTRANS |
Standby engine transfer |
• EXPLGS |
Explosive gas |
• FIRDETR |
Fire detector failure |
• FIRE |
Fire |
• FLOOD |
Flood |
• FUELLEAK |
Fuel leak |
• FUSE |
Fuse failure |
• GASALARM |
Explosive gas, toxic gas, ventilation fail or gas monitor fail |
• HATCH |
CEV hatch fail |
• GEN |
Generator failure |
• HIAIR |
High air flow |
• HIHUM |
High humidity |
• HITEMP |
High temperature |
• HIWTR |
High water |
• INTRUDER |
Intrusion |
• LEVELCON |
Level converter |
• LVDADSL |
Secondary ADSL low voltage disconnect |
• LVDBYPAS |
Low voltage disconnect bypass |
• LWBATVG |
Low battery voltage |
• LWFUEL |
Low fuel |
• LWHUM |
Low humidity |
• LWPRES |
Low cable pressure |
• LWTEMP |
Low temperature |
• LWWTR |
Low water |
• MISC |
Miscellaneous |
• OPENDR |
Open door |
• POWER |
Commercial power failure |
• PUMP |
Pump failure |
• PWR-48 |
48V power supply failure |
• PWR-139 |
-139V power converter |
• PWR-190 |
-190V power converter |
• PWRMJ |
Power supply major |
• PWRMN |
Power supply minor |
• RECT |
Rectifier failure |
• RECTHI |
Rectifier high voltage |
• RECTLO |
Rectifier low voltage |
• RINGGENMJ |
Ringing generator major |
• RINGGENMN |
Ringing generator minor |
• RTACADSL |
AC or AC/rectifier power fail ADSL equipment |
• RTACCRIT |
AC or AC/rectifier power fail DCL equipment critical site |
• RTACPWR |
AC or AC/rectifier power fail DCL equipment |
• RTACPWRENG |
Commercial AC fail, site equipped with standby engine |
• RTBAYPWR |
AC power loss distributed power RT bay |
• RTRVENG |
Retrieve standby engine, commercial AC restored |
• SMOKE |
Smoke |
• TEMP |
High-low temperature |
• TOXICGAS |
Toxic gas |
• TREPEATER |
T-repeater shelf |
• VENTN |
Ventilation system failure |
DESC |
Alarm description. String. Optional |
21.20 RTRV-AUDIT-LOG
Retrieve Audit Log
Usage Guidelines
This command retrieves the contents of the audit log stored in the NE. Audit records contain information for user operations such as login, logout, change of provisioning parameters and other changes a user might make when connected to the NE. Audit records do not store operations related to parameter retrieval.
Category
Log
Security
Superuser
Input Format
RTRV-AUDIT-LOG:[<TID>]::<CTAG>;
Input Example
RTRV-AUDIT-LOG:::1;
Input Parameters
Table 21-39 RTRV-AUDIT-LOG Input Parameters
|
|
— |
|
Output Format
SID DATE TIME
M CTAG COMPLD
" <ENTRYNUM>,<OCRDAT>,<OCRTM>,<TASKID>,<TXSTATUS>,<DESCRIPTION>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,\"DESCRIPTION\""
;
Output Parameters
Table 21-40 RTRV-AUDIT-LOG Output Parameters
|
|
ENTRYNUM |
Entry number. Integer |
OCRDAT |
Date |
OCRTM |
Time |
TASKID |
Task ID. String |
TXSTATUS |
Parameter type is TX_STATUS—indicates the status of the transferred file |
• COMPLD |
The file transmission is completed |
• IP |
The file transmission is in process |
• START |
The file transmission is started |
DESCRIPTION |
Description of event. Description format varies depending on the event and can include parameters used during the event. String |
21.21 RTRV-BITS
Retrieve Building Integrated Timing Supply
Usage Guidelines
This command retrieves the BITS configuration command.
Category
Synchronization
Security
Retrieve
Input Format
RTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-BITS:SONOMA:BITS-1:782;
Input Parameters
Table 21-41 RTRV-BITS Input Parameters
|
|
AID |
Access identifier from the "BITS" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],
[SYNCMSG=<SYNCMSG>],[AISTHRSHLD=<AISTHRSHLD>],[SABIT=<SABIT>],
[IMPEDANCE=<IMPEDANCE>],[BITSFAC=<BITSFAC>],[ADMSSM=<ADMSSM>]:[<PST>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1::LINECDE=AMI,FMT=ESF,LBO=0-133,SYNCMSG=N,AISTHRSHLD=PRS,
SABIT=BYTE-4,IMPEDANCE=120-OHM,BITSFAC=E1,ADMSSM=PRS:UNLOCKED"
;
Output Parameters
Table 21-42 RTRV-BITS Output Parameters
|
|
AID |
Access identifier from the "BITS" section |
LINECDE |
Line code. Optional Parameter type is LINE_CODE—line code |
• AMI |
Line code value is AMI |
• B8ZS |
Line code value is B8ZS (bipolar with three-zero substitution) |
• HDB3 |
Line Code HDB3. Only applicable to SDH E1 signal |
FMT |
Digital signal frame format. Optional Parameter type is FRAME_FORMAT—frame format for an E1 port |
• D4 |
Frame format is D4 |
• E1-CRCMF |
SDH E1 CRCMF frame format |
• E1-MF |
SDH E1 MF frame format |
• E1-UNFRAMED |
SDH E1 unframed format |
• ESF |
Frame format is ESF |
• UNFRAMED |
Frame format is unframed |
LBO |
Line build out settings. BITS line build out. Default value is 0 to 133. Integer. Optional Parameter type is BITS_LineBuildOut—BITS line buildout |
• 0-133 |
BITS line buildout range is 0-133 |
• 134-266 |
BITS line buildout range is 134-266 |
• 267-399 |
BITS line buildout range is 267-399 |
• 400-533 |
BITS line buildout range is 400-533 |
• 534-655 |
BITS line buildout range is 534-655 |
SYNCMSG |
Indicates if the BITS facility supports synchronization status message. Default is on (Y) Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol |
• N |
The ring does not support the extended K1/K2/K3 protocol |
• Y |
The ring does support the extended K1/K2/K3 protocol |
AISTHRSHLD |
Alarm indication signal threshold. Optional Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SDH |
• DUS_SDH |
Do Not Use For Synchronization |
• G811 |
G811 Standard |
• RES_SDH |
Reserved For Network Synchronization Use |
• G812T |
G812T Standard |
• STU_SDH |
Synchronized, Traceability Unknown |
• G812TL |
G812TL Standard |
• SETS |
Synchronous Equipment Timing Source |
SABIT |
When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. Optional Parameter type is SABITS—SA BITS |
• BYTE-4 |
SABIT is BYTE-4 |
• BYTE-5 |
SABIT is BYTE-5 |
• BYTE-6 |
SABIT is BYTE-6 |
• BYTE-7 |
SABIT is BYTE-7 |
• BYTE-8 |
SABIT is BYTE-8 |
IMPEDANCE |
When the frame format selection is E1, IMPEDANCE is the terminal impedance of the BITS-IN port. Optional Parameter type is IMPEDANCE—the terminal impedance of the BITS-IN port |
• 120-OHM |
Impedance of 120 ohm |
• 75-OHM |
Impedance of 75 ohm |
BITSFAC |
BITS facility settings. Optional Parameter type is BITS_FAC—BITS facility rate. 64 k and 6 MHz are only applicable to the ONS 15454 |
• 2 M |
2 MHz rate |
• 64 K |
64 K rate |
• 6 M |
6 MHz rate |
• E1 |
E1 rate |
ADMSSM |
SSM selectable. Only applicable to BITS-IN when SSM is disabled. Optional Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SDH |
• DUS_SDH |
Do Not Use For Synchronization |
• G811 |
G811 Standard |
• RES_SDH |
Reserved For Network Synchronization Use |
• G812T |
G812T Standard |
• STU_SDH |
Synchronized, Traceability Unknown |
• G812TL |
G812TL Standard |
• SETS |
Synchronous Equipment Timing Source |
PST |
Primary state. Optional Parameter type is PST—indicates the current overall service condition of an entity |
• Unlocked |
In service |
• Locked |
Out of service |
21.22 RTRV-BULKROLL<STM_TYPE>
Retrieve Bulkroll (STM4, STM64, STM1, STM16)
Usage Guidelines
This command retrieves roll data parameters on a line.
See Table 27-1 for supported modifiers by platform.
Category
Bridge and Roll
Security
Retrieve
Input Format
RTRV-BULKROLL-<STM_TYPE>:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-BULKROLL-STM4:CISCO:FAC-3-1:1;
Input Parameters
Table 21-43 RTRV-BULKROLL-<STM_TYPE> Input Parameters
|
|
SRC |
Source AID from the "FACILITY" section. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<FROM>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],VLDSIG=<VLDSIG>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-3-1-1:RFROM=VC4-3-1-1,RTO=VC4-5-1-1,RMODE=AUTO,VLDSIG=Y"
;
Output Parameters
Table 21-44 RTRV-BULKROLL-<STM_TYPE> Output Parameters
|
|
FROM |
One of the endpoints. 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. AID is from the "VC" section |
RTO |
The the termination point that will become a leg of the new cross-connection. AID is from the "VC" section |
RMODE |
The rolling mode of operation. Optional Parameter type is RMODE—specifies the roll mode |
• AUTO |
Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous end-point. |
• MAN |
Manual. Enter the corresponding delete roll/bulkroll command to delete the previous end-point. |
VLDSIG |
The rolling mode of operation. Optional Parameter type is ON_OFF—disable or enable an attribute |
• N |
Disable an attribute |
• Y |
Enable an attribute |
21.23 RTRV-CMD-SECU
Retrieve Command Security
Usage Guidelines
This command retrieves the current command security level of the command specified in the AID field.
Category
Security
Security
Superuser
Input Format
RTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-CMD-SECU::INIT-REG:1;
Input Parameters
Table 21-45 RTRV-CMD-SECU Input Parameters
|
|
AID |
Access identifier string. Identifies the entity in the NE to which the command pertains. It is the command verb along with verb modifier(s), as it currently exists. It can be a single command or a block of commands, where the block might include all commands. Only INIT-REG will be supported. String. Must not be null |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<CAP>"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"INIT-REG:PROV"
;
Output Parameters
Table 21-46 RTRV-CMD-SECU Output Parameters
|
|
AID |
Access identifier. It can be a single command or a block of commands, where the block can include all commands. Only INIT-REG is supported. String. Optional |
CAP |
Command access privilege Parameter type is PRIVILEGE—security level |
• PROV |
Provision security level |
• SUPER |
Superuser security level |
21.24 RTRV-COND-<MOD2ALM>
Retrieve Condition (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS3I, E1, E100, E1000, E3, E4, FSTE, G1000, GFPOS, GIGE, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, STS36C, VC4, VC416C, VC42C, VC43C, UDCDCC, UDCF, VCG, VC11, VC12, WLEN)
Usage Guidelines
This command retrieves the current standing condition and state associated with an entity.
See Table 27-1 for supported modifiers by platform.
Category
Fault
Security
Retrieve
Input Format
RTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input Example
RTRV-COND-T3:TID:FAC-2-1:229::LOS;
Input Parameters
Table 21-47 RTRV-COND-<MOD2ALM> Input Parameters
|
|
AID |
Access identifier from the "ALL" section. Must not be null |
TYPEREQ |
The type of condition to be retrieved. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,T3:CR,LOS,SA,01-01,16-00-20,,,\"LOS OF SIGNAL\""
;
Output Parameters
Table 21-48 RTRV-COND-<MOD2ALM> Output Parameters
|
|
AID |
Access identifier from the "ALL" section |
AIDTYPE |
Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2ALM—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 1GISC3 |
1 Gbps ISC3 compatible |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• CLNT |
Client facility for MXP/TXP cards |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 frame. Only applicable to STM1E port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GFPOS |
Generic framing protocol over packet over SDH virtual port alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G payload |
• ISC3PEER2G |
ISC3PEER2G payload |
• ISC3PEER2R |
ISC3PEER2R payload |
• ISCCOMPAT |
ISCCOMPAT payload |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC38C |
VC38C alarm |
• VC44C |
VC44C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
• UDCDCC |
UDCDCC alarm |
• UDCF |
UCDF alarm |
• VCG |
Virtual Concatenation Group alarm |
• WLEN |
Wavelength Path Provisioning |
NTFCNCDE |
Two-letter notification code. Optional Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
TYPEREP |
The condition itself Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition, Optional Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date when the specific event or violation occurred. Optional |
OCRTM |
Time when the specific event or violation occurred. Optional |
DESC |
Condition description. String. Optional |
21.25 RTRV-COND-ALL
Retrieve Condition All
Usage Guidelines
This command retrieves the current standing condition for all entities.
This command does not return all conditions that are returned by other, more specific RTRV-COND commands; RTRV-COND-ALL returns a subset of these conditions. GR-253-CORE, Section 6.2.1.8.4 states a retrieval that returns ALL conditions from a node (RTRV-COND-ALL) must omit any conditions that are "same root cause" as other raised conditions. The section also states any retrieval of a subset of the conditions from a node, regardless of how the subsetting occurs, should not omit these "same root cause" conditions.
RTRV-COND-VC3, for example, includes "same root cause" conditions in the set it returns and RTRV-COND-ALL does not.
To retrieve all the NE conditions, issue all of the following commands:
RTRV-COND-ALL
RTRV-COND-ENV
RTRV-COND-BITS
RTRV-COND-SYNCN
Category
Fault
Security
Retrieve
Input Format
RTRV-COND-ALL:[<TID>]:[<AID>]:<CTAG>::[<TYPEREQ>][,,,];
Input Example
RTRV-COND-ALL:TID:ALL:229::LOS;
Input Parameters
Table 21-49 RTRV-COND-ALL Input Parameters
|
|
AID |
Access identifier from the "ALL" section. String. A null value is equivalent to ALL |
TYPEREQ |
The type of condition to be retrieved. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,STM1:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;
Output Parameters
Table 21-50 RTRV-COND-ALL Output Parameters
|
|
AID |
Access identifier from the "ALL" section that has an alarm condition |
AIDTYPE |
Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
NTFCNCDE |
Two-letter notification code. Optional Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
TYPEREP |
The type of condition to be retrieved Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition, Optional Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date when the specific event or violation occurred. Optional |
OCRTM |
Time when the specific event or violation occurred. Optional |
DESC |
Condition description. String. Optional |
21.26 RTRV-COND-BITS
Retrieve Condition Building Integrated Timing Supply
Usage Guidelines
This command retrieves the standing conditions on BITS.
Category
Synchronization
Security
Retrieve
Input Format
RTRV-COND-BITS:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];
Input Example
RTRV-COND-BITS:TID:BITS-1:229::LOS;
Input Parameters
Table 21-51 RTRV-COND-BITS Input Parameters
|
|
AID |
Access identifier from the "BITS" section. Must not be null |
TYPEREQ |
The type of condition to be retrieved. A null value is equivalent to ALL Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],,,[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;
Output Parameters
Table 21-52 RTRV-COND-BITS Output Parameters
|
|
AID |
Access identifier from the "BITS" section that has an alarm condition |
AIDTYPE |
Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional Parameter type is MOD2B—alarm type |
• 1GFC |
1 Gigabit Fibre Channel alarm |
• 1GFICON |
1 Gigabit FICON alarm |
• 2GFC |
2 Gigabit Fibre Channel alarm |
• 2GFICON |
2 Gigabit FICON alarm |
• 4GFC |
4 Gbps Fibre Channel |
• 4GFICON |
4 Gbps fiber connection |
• BITS |
BITS alarm |
• CLNT |
Client facility for MXP/TXP cards |
• COM |
Common alarm |
• DS3I |
DS3I alarm |
• E1 |
E1 alarm |
• E100 |
E100 alarm |
• E1000 |
E1000 alarm |
• E3 |
E3 alarm |
• E4 |
E4 alarm |
• ENV |
ENV alarm |
• EQPT |
EQPT alarm |
• FSTE |
Fast Ethernet Port alarm |
• G1000 |
G1000 alarm |
• GIGE |
GIG Ethernet port alarm |
• ISC3PEER1G |
ISC3PEER1G alarm |
• ISC3PEER2G |
ISC3PEER2G alarm |
• ISC3PEER2R |
ISC3PEER2R alarm |
• ISCCOMPAT |
ISCCOMPAT alarm |
• OCH |
Optical channel |
• OMS |
Optical Multiplex Section |
• OTS |
Optical Transport Section |
• POS |
POS port alarm |
• STM1 |
STM1 alarm |
• STM1E |
STM1E alarm |
• STM4 |
STM4 alarm |
• STM16 |
STM16 alarm |
• STM64 |
STM64 alarm |
• SYNCN |
SYNCN alarm |
• TCC |
TCC alarm |
• VC11 |
VC11 alarm |
• VC12 |
VC12 alarm |
• VC3 |
VC3 alarm |
• VC44C |
VC44C alarm |
• VC38C |
VC38C alarm |
• VC464C |
VC464C alarm |
• VC48C |
VC48C alarm |
• VC4 |
VC4 alarm |
• VC416C |
VC416C alarm |
• VC42C |
VC42C alarm |
• VC43C |
VC43C alarm |
NTFCNCDE |
Two-letter notification code. Optional Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
TYPEREP |
The type of condition to be retrieved Parameter type is CONDITION—any problem detected on an ONS 15454 SDH shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Table 26-1 for a list of conditions |
SRVEFF |
The effect on service caused by the standing alarm or condition, Optional Parameter type is SERV_EFF—the effect of the alarm on service |
• NSA |
The condition is non-service affecting |
• SA |
The condition is service affecting |
OCRDAT |
Date when the specific event or violation occurred. Optional |
OCRTM |
Time when the specific event or violation occurred. Optional |
DESC |
Condition description. String. Optional |
21.27 RTRV-COND-ENV
Retrieve Environmental Condition
Usage Guidelines
This command retrieves the environmental conditions.
Category
Environment
Security
Retrieve
Input Format
RTRV-COND-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>][,,,];
Input Example
RTRV-COND-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Input Parameters
Table 21-53 RTRV-COND-ENV Input Parameters
|
|
AID |
Access identifier from the "ENV" section. Must not be null Note For RTRV-ALM-ENV, only ENV-IN-{1-4} is a valid AID for ONS 15454 SDH. ENV-OUT-{1,6} is not a valid AID for RTRV-ALM-ENV. |
NTFCNCDE |
Two-letter notification code. A null value is equivalent to ALL Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message |
• CL |
The condition causing the alarm has cleared |
• CR |
A critical alarm |
• MJ |
A major alarm |
• MN |
A minor alarm |
• NA |
The condition is not alarmed |
• NR |
The alarm is not reported |
ALMTYPE |
The alarm type for the environmental alarm. A null value is equivalent to ALL Parameter type is ENV_ALM—environmental alarm types |
• AIRCOMPR |
|