-
Cisco NCS TL1 Command Guide, Release 10.x.x
-
Preface
-
Cisco NCS Documentation Roadmap for Release 10.x.x
-
Chapter 1, Overview
-
Chapter 2, Provisioning Procedures
-
Chapter 3, ACT Commands
-
Chapter 4, ALW Commands
-
Chapter 5, APPLY Commands
-
Chapter 6, CANC Commands and Messages
-
Chapter 7, CHG Commands
-
Chapter 8, CLR Commands
-
Chapter 9, CONN Commands
-
Chapter 10, COPY Commands
-
Chapter 11, DISC Commands
-
Chapter 12, DLT Commands
-
Chapter 13, ED Commands
-
Chapter 14, ENT Commands
-
Chapter 15, EX Commands
-
Chapter 16, INH Commands
-
Chapter 17, INIT Commands
-
Chapter 18, OPR Commands
-
Chapter 19, REPT Commands
-
Chapter 20, RLS Commands
-
Chapter 21, RMV Commands
-
Chapter 22, RST Commands
-
Chapter 23, RTRV Commands
-
Chapter 24, SCHED Commands
-
Chapter 25, SET Commands
-
Chapter 26, SW Commands
-
Chapter 27, Access Identifiers
-
Chapter 28, Conditions
-
Chapter 29, Modifiers
-
Chapter 30, TL1 Errors
-
Feedback
Table Of Contents
23.30 RTRV-BULKROLL-<STM_TYPE>
23.31 RTRV-BULKROLL-<OCN_TYPE>
23.62 RTRV-FFP-<MOD2NCSPAYLOAD>
23.126 RTRV-PROTNSW-<MOD2NCSPAYLOAD>
23.127 RTRV-PROTNSW-<STM_TYPE>
23.128 RTRV-PROTNSW-<OCN_TYPE>
23.140 RTRV-RMONTH-<MOD2_RMON>
RTRV Commands
This chapter provides retrieve (RTRV) commands for the Cisco NCS 2002 and Cisco NCS 2006.
23.1 RTRV-100GIGE
The retrive 100GIGE (RTRV-100GIGE) command retrieves the attributes of provisioned 100GIGE facility.
Usage Guidelines
The new parameter NUMOFLANESis added for payloads provisioned on CFP-LC cards.
Category
Ports
Security
Retrieve
Input Format
RTRV-100GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-100GIGE::VFAC-5-1-1:1;
Input Parameters
<AID>
Access Identifier
•
VFAC[-{1-50}]-{2-7}-{1-2}-1
•
•
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[<MTU>],[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>],[<SOAK>],[<SYNCMSG>],[<SENDDUS>],[<ADMSSM>],[<PROVIDESYNC>],[<SQUELCHMODE>]:<PST>,[<SST>]"
;Output Example
100g 2012-05-21 12:11:02
M 1 COMPLD
"VFAC-1-3-1-1:,,WORK,STBY:SOAK=32,SYNCMSG=N,SENDDUS=N,ADMSSM=STU,PROVIDESYNC=N,NUMOFLANES=4:OOS-MA,DSBLD"
Output Parameters
23.2 RTRV-CPS
This command can be used to retrieve Control Plane Service parameter. The user needs to specify only the source port to identify the CPS. ALL and group AID are allowed.
Usage Guidelines
•
•
•
•
•
•
•
Category
NCS
Security
provisioning
Input Format
RTRV-CPS:[<TID>]:<SRC>:<CTAG>::[:CKTID=<CKTID>][:];
Input Example
RTRV-CPS::PCHAN-1-1-RX:8::;
Input Parameters
<SRC>
Source AID from the "CrossConnectId1" section.
<CKTID>
Circuit identification parameter can be used to filter this command
Output Format
SID DATE TIME
M CTAG COMPLD "<SRCAID>:<DSTADDR>,<DSTAID>,<WCT>,<CPSTYPE>:<CKTID>,[<VALMODE>],[<VALZONE>],[<VALMODESEC>],[<VALZONESEC>],[<CPSSTATUS>],[<ACTVALZONE>],[<RESTTYPE>],[<REVERTMODE>],[<SOAKTIME>],[<RESTSTS>],[<CKTLABEL>],[<FREQ>],[<WIDTH>],[<CKTPRI>],[<ALWRGN>],[<PATHPOLICY>],[<DNSTRMPWR>],[<UPSTRMPWR>]:<PST>,[<SST>]";
Output Example
tcc232 2011-08-05 16:37:44
M 8 COMPLD "CHAN-4-2:10.64.107.36,CHAN-7-2,1WAY,ADD:CKTID=,VALMODE=NONE,CPSSTATUS=INACTIVE,RESTTYPE=NONE,RESTSTATUS=NONE:OOS,DSBLD"
;
Output Parameters
<SRC>
Source access identifier from the "ALL" section. Listable.
<DSTADDR>
Identifies the destination node IP address.
<DST>
Destination AID from the "ALL" section.
<WCT>
Identifies the wavelength connection type.
•
A unidirectional connection from a source to a destination port. Deafult is 1WAY
•
A bidirectional connection between the two ports.
<CPSTYPE>
Identifies the type of CPS.
•
CPS End Point are client ports
•
CPS End Point are trunk ports
•
CPS Source End Point is an ADD port
•
Not applicable
•
Not applicable
<CKTID>
(Optional) Circuit identification parameter contains the Common Language Circuit ID or other alias of the circuit being provisioned. Does not contain blank spaces. CKTID is a string of ASCII characters. The maximum length of CKTID can be 48.
<VALMODE>
Identifies the validation mode.
•
No Optical validation is performed.
•
The optical validation is performed as indicated in VALZONE parameter.
<VALZONE>
Identifies the validation operate zone.
•
Not evaluated
•
Margin > 3 sigma
•
1 < margin < 3 sigma
•
0 < margin < 1 sigma
•
-3 < margin < 0 sigma
•
Margin < -3 sigma
<CPSSTATUS>
Identifies the Control Plane Service status.
•
CPS is not active
•
CPS is active
•
CPS activation is started
•
CPS deactivation is started
•
CPS circuit failed (i.e. link down, node down)
•
CPS trail failed (i.e. PSM working or protected is down or fail)
•
temporary reboot status at CPS restart
•
Not applicable
•
CPS repair is started (i.e. node IP changed)
<ACTVALZONE>
Identifies the actual validation operate zone.
•
Not evaluated
•
Margin > 3 sigma
•
1 < margin < 3 sigma
•
0 < margin < 1 sigma
•
-3 < margin < 0 sigma
•
Margin < -3 sigma
<VALMODESEC>
Identifies the validation mode for secondary circuit
<VALZONESEC>
Identifies the validation operate zone for secondary circuit
<<RESTTYPE>>
Specifies the restoration type on CPS circuit or UNI configuration. Parameter type is RESTTYPE.
•
The circuit restoration type is none for WSON circuits.
•
The circuit restoration type is Restore for WSON circuits.
•
The circuit restoration type is Revert for WSON circuits.
< RESTSTS>
Specifies the restoration status. Parameter type is RESTSTS.
•
Restoration failed.
•
Restoration none.
•
The circuit is restored.
•
The circuit is in restoring state.
•
The circuit is revertible.
•
The circuit is reverting back to the original path.
<REVERTMODE>
Specifies the revertive mode type. Paraneter type is REVERTMODE.
•
Automatic revertive mode.
•
Manual revertive mode.
•
None.
<SOAKTIME>
Time after which the circuit switches back to the original circuit.
<PATHPOLICY>
Path selection policy.
•
No path selection policy selected.
•
Path selection policy restricted to LOGO domain.
<CKTLABEL>
Circuit label.
<FREQ>
Optical wavelength
<WIDTH>
Width
<CKTPRIORITY>
Circuit priority
<ALLOWRGN>
Allow RGN. It can be ON/OFF.
<DSPWROFS>
Down stream power offset.
<USPWROFS>
Up stream power offset.
23.3 RTRV-HOP-CPS
The Retrieve HOP Control Plane Service (RTRV-HOP-CPS) command is used to retrieve the HOPs route contraint of the Control Plane Services.
Usage Guidelines
•
•
•
•
•
•
•
Category
NCS
Security
Provisioning
Input Format
RTRV-HOP-CPS:[<TID>]:<SRC>:<CTAG>::[<CIRCUITTYPE>],[<ROUTETYPE>],[<HOPTYPE>],[<HOPNODE>],[<HOPSIDE>][::];
Input Example
> RTRV-HOP-CPS::ALL:333;
tcc232 2011-08-02 16:27:24
M 333 COMPLD
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,1,LOOSE,10.20.33.44,"
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,2,LOOSE,10.20.33.45,"
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,3,LOOSE,10.20.33.46,"
"VFAC-1-5-2:10.20.30.40,,PRIMARY,MAINROUTE,1,LOOSE,10.20.33.44,"
;
Input Parameters
<SRC>
Source AID from the "CrossConnectId1" section.
<CIRCUITTYPE>
Identifies the target circuit. Allowed values are PRIMARY, SECONDARY.
<ROUTETYPE>
Identifies the target circuit route. Allowed values are MAINROUTE and BRIDGEROUTE.
<POSITION>
Identifies the position of the hop in the item list. Default value is 0.
•
•
•
•
•
<HOPTYPE>
Type of hop constraint. Allowed values are STRICT, LOOSE, EXCLUDE
•
The next hop of the path must be the indicated node and side
•
The path must cross the indicated node and side
•
The path must exclude the indicated node
<HOPNODE>
IP address of the target node.
<HOPSIDE>
Hop constraint target WDM side.
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>:<DSTADDR>,<DST>,<CIRCUITTYPE>,<ROUTETYPE>,<POSITION><HOPTYPE>,<HOPNODE>,<HOPSIDE>";
Output Example
tcc232 2011-08-02 16:27:24
M 333 COMPLD
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,1,LOOSE,10.20.33.44,"
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,2,LOOSE,10.20.33.45,"
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,3,LOOSE,10.20.33.46,"
"VFAC-1-5-2:10.20.30.40,,PRIMARY,MAINROUTE,1,LOOSE,10.20.33.44,"
;
tcc232 2011-08-02 16:27:37
M 333 COMPLD
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,1,LOOSE,10.20.33.44,"
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,2,LOOSE,10.20.33.45,"
"CHAN-1-15-10-RX&CHAN-1-14-10-TX:10.20.30.40,CHAN-10-1-10-TX&CHAN-10-1-10-RX,PRIMARY,MAINROUTE,3,LOOSE,10.20.33.46,"
;
Output Parameters
<SRC>
Source access identifier from the "ALL" section. Listable.
<DSTADDR>
Identifies the destination node IP address.
<DST>
Destination AID from the "ALL" section.
<CIRCUITTYPE>
Identifies the target circuit. Allowed values are PRIMARY,SECONDARY.
<ROUTETYPE>
Identifies the target circuit route. Allowed values are MAINROUTE, BRIDGEROUTE.
<POSITION>
Identifies the position of the hop in the item list.
<HOPTYPE>
Type of hop constraint. Allowed values are STRICT, LOOSE, EXCLUDE.
•
The next hop of the path must be the indicated node and side.
•
The path must cross the indicated node and side.
•
The path must exclude the indicated node.
<HOPNODE>
IP address of the target node.
<HOPSIDE>
Hop constraint target WDM side.
23.4 RTRV-<MOD1FCPAYLOAD>
The Retrieve 1GFC, 2GFC, 4 GFC, 5GIB, 8GFC, or 10 GFC (RTRV-<MOD1FCPAYLOAD>) command retrieves the attributes related with the Fibre Channel port. SeeTable 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-1GFC:CISCO:FAC-6-1:888;
Input Parameters
<AID>
Access identifier from the FACILITY.
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>],
[SQUELCHMODE=<SQUELCHMODE>]:<PSTPSTQ>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFC,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,
NAME=\"FC PORT\",SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,
LOSSB=LR-1:LOCKED-ENABLED,MAINTENANCE",
SQUELCHMODE=SQUELCH:OOS-MA,DSBLD"
;
Table 23-1 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
(Optional) The port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) The port status in a Y-cable protection scheme. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
MFS
(Optional) Maximum frame size. MFS is an integer.
•
Generic framing procedure (GFP) frame mode
•
GFP transparent mode
•
High-level data link control (HDLC) frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
<ENCAP>
(Optional) Frame encapsulation type. The parameter type is ENCAP, which is the frame encapsulation type.
•
GFP frame mode.
•
Contant Bit Rate mode.
•
Transparent mode.
•
GMP mapping mode.
<SOAK>
(Optional) Locked-Automatic In Service to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-Automatic In Service to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. The rules for SOAKLEFT are:
•
•
•
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.16
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
The parameter type is REACH, which is the reach value.
•
Autoprovisioning
•
Reach supported on 40GIGE payload on CFP-LC card.
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects.
•
Squelch is enabled.
•
No Squelch.
•
Squelch is disabled.
<PSTPSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (PST) and primary state qualifier (PSTQ).
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
(Optional) Secondary state of the entity. The parameter type is secondary state (SST), which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.5 RTRV-<MOD1FICONPAYLOAD>
The Retrieve 1GFICON, 2GFICON, or 4GFICON (RTRV-MOD1FICONPAYLOAD>) command returns Fibre-Channel-specific settings for ports that have been configured to carry fiber connectivity (FICON) traffic using the ENT-FICON command. The MXP_MR_2.5G and MXPP_MR_2.5G cards only support the GFP-T frame type. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-1GFICON:CISCO:FAC-1-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>],
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PSTPSTQ>,<SST>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:LINKRATE=1GFICON,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,NAME=\"FC PORT\",
SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,LOSSB=LR-1:LOCKED-ENABLED,
MAINTENANCE"
;
Table 23-2 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
(Optional) The port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) Port status in a Y-cable protection scheme. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<LINKRATE>
(Optional) The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned. The parameter type is LINKRATE, which is the link rate on a Fibre Channel port.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
The rate is unknown.
•
The SFP is not plugged into the Fibre Channel port, so the link rate cannot be detected.
<LINKSTATE>
(Optional) Link state. The parameter type is DIRN, which specifies the discriminating level for the requested monitored parameter.
•
Monitored parameter with values equal to or greater than the level of LEV will be reported.
•
Monitored parameter with values equal or less than the value of LEV will be reported.
<LINKRCVRY>
(Optional) Link recovery. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<DISTEXTN>
(Optional) Distance extension. The parameter type is DISTANCE_EXTENSION (distance extension).
•
Buffer-to-buffer flow control
•
No distance extension
<LINKCREDITS>
(Optional) Number of link credits. LINKCREDITS is an integer.
<MFS>
(Optional) Maximum frame size. MFS is an integer.
<ENCAP>
(Optional) Frame encapsulation type. The parameter type is ENCAP, which is the frame encapsulation type.
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
<NAME>
(Optional) Identifies the port name. NAME is a string.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for <SOAKLEFT> are:
•
•
•
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) The parameter type is REACH, which is the reach value.
•
Autoprovisioning
•
Reach supported on 40GIGE payload on CFP-LC card.
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<PSTPSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.6 RTRV-<MOD2NCSPAYLOAD>
The Retrieve D1VIDEO, DV6000, DVBASI, ETRCLO, HDTV, ISCCOMPAT, ISC1, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, PASSTHRU, 3GVIDEO, SDSDI, HDSDI, AUTO, OTL, OTU1, ISC3STP1G, and ISC3STP2G (RTRV-<MOD2NCSPAYLOAD>) command retrieves the configuration parameter of a NCS client. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
The command supports the modifier 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, and ISC3STP2G. The RTRV-OTL command retrieves the Current values on sublanes of 100G-LC-C and retrieves only state of tha facility on CFP-LC cards.
Category
Ports
Security
Maintenance
Input Format
RTRV-<MOD2NCSPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-SDSDI::VFAC-3-2-1:321;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
Output Format
SID DATE TIME M CTAG COMPLD "<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[LBCL=<LBCL>], [OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>],[SQUELCHMODE=,SQUELCHMODE.]:<PSTPSTQ>,[<SST>]" ;
Output Example
TID-000 1998-06-20 14:30:00
M 321 COMPLD
"VFAC-3-2-1,SDSDI:,,WORK,ACT:NAME=\"NY PORT\",LBCL=10.0,OPT=10.0,OPR=10.0, FREQ=1550,LOSSB=LR-1,SQUELCHMODE=SQUELCH:OOS-AU,AINS" ;
Table 23-3 Output Parameter Support
<AIDUNIONID>
Access identifier from the "AidUnionId" section.
<AIDTYPE>
A type of access identifier. The parameter type is MOD2NCSPAYLOAD, which is the payload types applicable to NCS ports.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
40-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
D1Video payload
•
DV6000 payload
•
DVBASI payload
•
ETR_CLO payload
•
Gigabit Ethernet payload
•
High definition television (HDTV) payload
•
ISC1 payload
•
ISC3 payload
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
Any pass-through (2R) payload
•
10-Gigabit Fibre Channel payload
<ROLE>
(Optional) The port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit has in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) Port status in a Y-cable protection scheme. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<NAME>
(Optional) Identifies the port name. NAME is a string.
<LBCL>
(Optional) Displays the current value of the laser current. LBCL is a float.
<OPT>
(Optional) Displays the current value of the transmitted optical power. OPT is a float.
<OPR>
(Optional) Displays the current value of the received optical power. OPR is a float.
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) The parameter type is REACH, which is the reach value.
•
100GBASE-LR4
•
100GBASE-SR10
•
40GBASE-FR
•
40GBASE-LR4
•
Reach supported on 40GIGE payload on CFP-LC card.
•
4I1-9D1F
•
C4S1-2D1
•
FE-BX
•
FX
•
GE-BX
•
GE-EX
•
LX-10
•
TEN-GE-LRM
•
TEN-GE-ZR
•
VSR2000-3R2
•
Autoprovisioning
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects.
•
Squelch is enabled.
•
No Squelch.
•
ODU AIS.
<PSTPSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.7 RTRV-<MOD_RING>
The Retrieve Multiplex Section Shared Protection Ring (RTRV-<MOD_RING>) command retrieves the multiplex section-shared protection ring (MS-SPRing) information of the network element (NE). A two-fiber or four-fiber MS-SPRing can be retrieved.
Usage Guidelines
Error conditions:
•
•
•
•
•
•
Category
MS-SPRing
Security
Retrieve
Input Format
RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];
Input Example
RTRV-MSSPR:PETALUMA:ALL:123;
Input Parameters
<AID>
(Optional) Access identifier from the "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"
;•
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"MSSPR-N12EF::RINGID=N12EF,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1"
;
Table 23-4 Output Parameter Support
<AID>
(Optional) Access identifier from the "AidUnionId1" section. Identifies the MS-SPRing of the NE.
<RINGID>
(Optional) The MS-SPRing ID of the NE up to six characters. Valid characters are A-Z and 0-9. RINGID is a string.
<NODEID>
(Optional) The MS-SPRing node ID of the NE. NODEID ranges from 0 to 31. NODEID is a string.
<MODE>
(Optional) Mode with which the command is to be implemented. Identifies the MS-SPRing mode; either two-fiber or four-fiber. The parameter type is MSSPR_MODE, which is the MS-SPRing mode.
•
Two-fiber MS-SPRing
•
Four-fiber MS-SPRing
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. RVTM is not allowed to be set while RVRTV is N. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<SRVRTV>
(Optional) The span revertive mode for four-fiber MS-SPRing only. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SRVTM>
(Optional) The span revertive time for four-fiber MS-SPRing only. SRVTM is not allowed to be set while SRVRTV is N. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<EASTWORK>
(Optional) East working facility. AID from the "FACILITY" section.
<WESTWORK>
(Optional) West working facility. AID from the "FACILITY" section.
<EASTPROT>
(Optional) East protecting facility. AID from the "FACILITY" section.
<WESTPROT>
(Optional) West protecting facility. AID from the "FACILITY" section.
23.8 RTRV-<OCN_TYPE>
The Retrieve OC3, OC12, OC48, or OC192 command retrieves the attributes (for example, service parameters) and the state of an OC-N facility.
Usage Guidelines
See Table 29-1 for supported modifiers by platform.
Both RINGID and BLSRTYPE identify the OC-N port connected with a BLSR. These attributes are only presented for the OC-12, OC-48, and OC-192 ports within a BLSR connection. The RTRV-<MOD_RING> command with the AID BLSR-RINGID can provide more information about a BLSR.
Note
Category
Ports
Security
Retrieve
Input Format
RTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-OC48:PENNGROVE:FAC-6-1:236;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>],
[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>],
[RINGID=<RINGID>],[BLSRTYPE=<BLSRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],
[LDCC=<LDCC>],[NAME=<NAME>],[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>],
[SENDDUSFF=<SENDDUSFF>],[AISONLPBK=<AISONLPBK>],
[FREQ=<FREQ>],[LOSSB=<LOSSB>],[FOREIGNFEND=<FOREIGNFEND>],
[FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],[SQUELCHMODE=<SQUELCHMODE>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:DCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SINGLESHELF,WVLEN=1310.00,RINGID=43,
BLSRTYPE=WESTWORK,MUX=E2,UNIC=Y,
SOAKLEFT=\"12-25\",SSMRCV=STU,OSPF=Y,LDCC=Y,NAME=\"OCN PORT\",LBCL=10.0,
OPT=10.0,OPR=10.0,EXPTRC=\"AAA\",TRC=\"AAA\",TRCMODE=MAN,
TRCFORMAT=16-BYTE,ADMSSM=PRS,SENDDUSFF=N,AISONLPBK=AIS_ON_LPBK_ALL,
FREQ=1550,LOSSB=LR-1,FOREIGNFEND=Y,
FOREIGNIPADDRESS=10.92.63.44,:OOS-AU,AINS",SQUELCHMODE=SQUELCH"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
(Optional) An OC-N port role. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) An OC-N port status. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<DCC>
(Optional) Indicates whether or not the Section data communications channel (DCC) is to be used. The parameter type is EXT_RING, which indicates whether the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<AREA>
(Optional) Area ID. Shows up only if the DCC is enabled. AREA is a string.
<TMGREF>
(Optional) The termination to be used, whether primary or secondary. Identifies if an OC-N port has a timing reference. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SYNCMSG>
Synchronization status message. The parameter type is EXT_RING, which indicates whether the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<SENDDUS>
(Optional) The facility will send the DUS (Do not use for Synchronization) value in 0x0f bits pattern as the synchronization status message for that facility. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<PJMON>
(Optional) Identifies an OC-N port PJMON. Defaults to 0 (zero). PJMON is an integer. Set a valid STS number of the optical port.
Note
<SFBER>
(Optional) An OC-N port signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) An OC-N port signal degrade threshold. Defaults 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<MODE>
(Optional) OC-N port mode. Defaults to SONET. The parameter type is OPTICAL_MODE, which is the facility's optical mode.
•
The NE contains only one shelf and the AID representation does not consider the shelf identifier for command requests/response and autonomous reports.
•
The AID representation considers the shelf identifier for command requests/response and autonomous reports. This means the NE has more than one shelf configured or the user wants to use the new AID style.
•
The AID representation considers the shelf identifier for command requests/response and autonomous reports. This means the NE has more than one shelf configured or the user wants to use the new AID style. The shelves are connected by means of an external Ethernet switch.
<WVLEN>
(Optional) An OC-N port wavelength in nanometers. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. WVLEN is a float.
<RINGID>
(Optional) The BLSR RINGID with which the port is connected. RINGID ranges from 0 to 9999. RINGID is an integer.
<BLSRTYPE>
(Optional) The BLSR type with which the port is connected. The parameter type is BLSR_TYPE, which is the BLSR type of an OC-N port.
•
The OC-N port is an east protecting port.
•
The OC-N port is an east working port.
•
The OC-N port is an west protecting port.
•
The OC-N port is an west working port.
<MUX>
(Optional) BLSR extension byte. The parameter type is MUX_TYPE, which is the BLSR extension byte.
•
E2 byte (orderwire)
•
F1 byte (user)
•
K3 byte
•
Z2 byte
<UNIC>
(Optional) Indicates if the port connects to the UCP. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SOAK>
(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from OOS-AINS to IS measured in 1-minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for <SOAKLEFT> are as follows:
•
•
•
<SSMRCV>
(Optional) Displays the quality of the individual port. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SONET.
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
<OSPF>
(Optional) The Open Shortest Path First protocol. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<LDCC>
(Optional) The Line DCC connection on the port. The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<NAME>
(Optional) Port Name. NAME is a string.
<LBCL>
(Optional) Displays the current value of the laser current. LBCL is a float.
<OPT>
(Optional) Displays the current value of the transmitted optical power. OPT is only displayed for DWDM cards. OPT is a float.
<OPR>
(Optional) Received optical power. OPR is a float.
<EXPTRC>
(Optional) Expected path trace content. EXPTRC is a string.
<TRC>
(Optional) Path trace message to be transmitted. TRC is a string.
<TRCMODE>
(Optional) Path trace mode. Applicable only to STS-level Paths in SONET. Defaults to the OFF mode. The parameter type is TRCMODE (trace mode).
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.
•
Use the previously received path trace string as the expected string and do not turn on alarm indication signal (AIS) and remote defect indication (RDI) if TIM-P is detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIM-P is detected.
•
Turn off path trace capability. Nothing will be reported.
<TRCFORMAT>
(Optional) Trace message size. The parameter type is TRCFORMAT (trace format).
•
1-byte trace message
•
16-byte trace message
•
64-byte trace message
•
Enable an attribute.
<ADMSSM>
(Optional) SSM selectable value. Only displayed when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SONET.
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
<SENDDUSFF>
(Optional) Indicates that the facility will send the DUS value in 0xff bits pattern as the synchronization status message for that facility. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<AISONLPBK>
(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates whether AIS is sent on a loopback.
•
AIS is sent on facility loopbacks.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopbacks.
•
AIS is sent on terminal loopbacks.
<FREQ>
(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.16
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) Parameter type is REACH (reach values).
•
100GBASE-LR4
•
100GBASE-SR10
•
40GBASE-FR
•
40GBASE-LR4
•
Reach supported on 40GIGE payload on CFP-LC card.
•
4I1-9D1F
•
C4S1-2D1
•
FE-BX
•
FX
•
GE-BX
•
GE-EX
•
LX-10
•
TEN-GE-LRM
•
TEN-GE-ZR
•
VSR2000-3R2
•
Autoprovisioning
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Long haul 10G Ethernet with 1310 nm wavelength
•
Longhaul 2.5G Ethernet with 1550 nm wavelength
•
Long haul 10G Ethernet with 1550 nm wavelength
•
Shorthaul 2.5G Ethernet with 1310 nm wavelength
•
Short haul 10G Ethernet in 1310 nm wavelength
•
Reach SC
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<FOREIGNFEND>
(Optional) Indicates whether the far-end NE on the DCC is a foreign NE. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<FOREIGNIPADDRESS>
(Optional) The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. FOREIGNIPADDRESS is a string.
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects.
•
Squelch is enabled.
•
No Squelch.
•
Generic AIS
<PST_PSTQ>
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In Service and Normal
•
Out of Service and Autonomous
•
Out of Service and Autonomous Management
•
Out of Service and Management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic In-Service
•
Disabled
•
Loopback
•
Mismatch of Equipment
•
Maintenance
•
Out of Group
•
Software Download
•
Unassigned
•
Unequipped
23.9 RTRV-<PATH>
The Retrieve VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-<PATH>) command retrieves the attributes associated with an VC path. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
•
•
•
•
•
–
–
•
•
Sending this command while MSSPRPTHTYPE=PCA, whether there is MS-SPRing switch or not, the protection channel access (PCA) path J1/C2 data will be returned (if there is PCA circuit on the AID). Sending this command with a VC AID without circuits and no MS-SPRing switched on the VC, will return and error message.
•
•
•
•
•
Category
Paths
Security
Retrieve
Input Format
RTRV-<PATH>:[<TID>]:<AID>:<CTAG>:::[MSSPRPTHTYPE=<MSSPRPTHTYPE>][:];
Input Example
RTRV-VC4:FERNDALE:VC4-2-1-4:238:::MSSPRPTHTYPE=NON-PCA;
Table 23-5 Input Parameter Support
<AID>
Access identifier from the "CrossConnectId1" section.
<MSSPRPTHTYPE>
(Optional) The MS-SPRing path type (only if the port is on the MS-SPRing). Defaults to NON-PCA. Applicable only to VC-level paths in NCS. A null value defaults to NON-PCA. The parameter type is MSSPR_PTH_TYPE, which is the MS-SPRing path type only if the port is on the MS-SPRing.
•
The AID is on the working path, or the cross-connection card protection path.
•
The AID is on the MS-SPRing PCA path.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[SNCPPTHSTATE=<SNCPPTHSTATE>],[C2=<C2>],
[MSSPRPTHSTATE=<MSSPRPTHSTATE>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-2-1-4::LEVEL=VC4,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,
HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING",
INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=DUAL,
SNCPPTHSTATE=ACT,C2=0X04,
MSSPRPTHSTATE=PROTPTHACT:UNLOCKED-DISABLED,AUTOMATICINSERVICE";
Table 23-6 Output Parameter Support
<AID>
Access identifier from the "CrossConnectId1" section.
<LEVEL>
(Optional) The rate of the cross-connected channel. Applicable only to High-Order paths (VC4). The parameter type is PATH, which is the modifier for path commands.
•
Synchronous Transport Signal/Module Level-1 (51 Mbps)
•
Synchronous Transport Signal/Module Level-12 Concatenated (622 Mbps)
•
Synchronous Transport Signal/Module Level-18 Concatenated (933 Mbps)
•
Synchronous Transport Signal/Module Level-192 Concatenated (9952 Mbps)
•
Synchronous Transport Signal/Module Level-24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal/Module Signal Level-3 Concatenated (155 Mbps)
•
Synchronous Transport Signal/Module Level-48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal/Module level-6 (310 Mbps)
•
Synchronous Transport Signal/Module Level-9 Concatenated (465 Mbps)
•
Virtual Tributary 2. Virtual Channel 12
•
Virtual Tributary 1. Virtual Channel 11
<SFBER>
(Optional) A VC path signal failure threshold that only applies to SNCP. Applicable only to High-Order paths. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) A VC path signal degrade threshold that only applies to SNCP. Applicable only High-Order paths. Defaults 1E-6. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
RVTM
(Optional) Revertive time. Only applies to SNCP. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
•
Disable an attribute.
•
Enable an attribute.
<HOLDOFFTIMER>
(Optional) Hold off timer. HOLDOFFTIMER is an integer.
<EXPTRC>
(Optional) Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR and LF. Applicable to VC-level paths (VCn). Defaults to NULL when SNCP path is created. EXPTRC is a string.
<TRC>
(Optional) The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to VC-level paths (VCn). TRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to VC-level paths in (VCn). Defaults to Null when a SNCP path is created. INCTRC is a string.
<TRCMODE>
(Optional) Path trace mode. Applicable only to VC-level paths (VCn). Defaults to OFF when a SNCP path is created. The parameter type is TRCMODE, which is the trace mode.
•
Use the previously received path trace string as the expected string (not applicable to MXP_2.5G_10G and TXP_MR_10G cards).
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected.
•
Turn off path trace capability. Nothing will be reported.
<TACC>
(Optional) Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual facility access digroup (FAD).
•
Single FAD
<SNCPPTHSTATE>
(Optional) Indicates whether a given AID is the working or standby path of a SNCP cross-connect. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<C2>
(Optional) The C2 byte hex code. Applicable only to VC-level paths (VCn). The parameter type is C2_BYTE, which is the C2 byte hex code.
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured VC-1 synchronous payload envelope (SPE)
•
Locked Virtual Tributary (VT) mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4 North American (NA)
•
Mapping for asynchronous transfer mode (ATM)
•
Mapping for distributed queue dual bus (DQDB)
•
Asynchronous Mapping for fiber distributed data interface (FDDI)
•
High-level data link control (HDLC)-Over-NCS Mapping
•
VT-structured VC4-1 SPE with 1VTx payload defect
•
VT-structured VC4-1 SPE with 2VTx payload defects
•
VT-structured VC4-1 SPE with 3VTx payload defects
•
VT-structured VC4-1 SPE with 4VTx payload defects
•
VT-structured VC4-1 SPE with 5VTx payload defects
•
VT-structured VC4-1 SPE with 6VTx payload defects
•
VT-structured VC4-1 SPE with 7VTx payload defects
•
VT-structured VC4-1 SPE with 8VTx payload defects
•
VT-structured VC4-1 SPE with 9VTx payload defects
•
VT-structured VC4-1 SPE with 10VTx payload defects
•
VT-structured VC4-1 SPE with 11VTx payload defects
•
VT-structured VC4-1 SPE with 12VTx payload defects
•
VT-structured VC4-1 SPE with 13VTx payload defects
•
VT-structured VC4-1 SPE with 14VTx payload defects
•
VT-structured VC4-1 SPE with 15VTx payload defects
•
VT-structured VC4-1 SPE with 16VTx payload defects
•
VT-structured VC4-1 SPE with 17VTx payload defects
•
VT-structured VC4-1 SPE with 18VTx payload defects
•
VT-structured VC4-1 SPE with 19VTx payload defects
•
VT-structured VC4-1 SPE with 20VTx payload defects
•
VT-structured VC4-1 SPE with 21VTx payload defects
•
VT-structured VC4-1 SPE with 22VTx payload defects
•
VT-structured VC4-1 SPE with 23VTx payload defects
•
VT-structured VC4-1 SPE with 24VTx payload defects
•
VT-structured VC4-1 SPE with 25VTx payload defects
•
VT-structured VC4-1 SPE with 26VTx payload defects
•
VT-structured VC4-1 SPE with 27VTx payload defects
•
VT-structured VC4-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved. C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
<MSSPRPTHSTATE>
(Optional) The MS-SPRing path state only if the port is on the MS-SPRing. Applicable only to VC-level paths in NCS (VCn). The parameter type is MSSPR_PTH_STATE, which is the MS-SPRing path state only if the port is on the MS-SPRing.
•
Indicates that the MS-SPRing switched and its PCA path is in the active state.
•
Indicates that the MS-SPRing switched and its PCA path is in the standby state.
•
Indicates that the MS-SPRing switched and its protection path is in the active state.
•
Indicates that the MS-SPRing switched and its working path is in the active state.
•
Indicates that the MS-SPRing switched and its working path is in the standby state.
<PSTPSTQ>
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. the parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.10 RTRV-<STM_TYPE>
The Retrieve (STM1, STM4, STM16, STM64) command retrieves the attributes (such as service parameters) and the state of an STM facility. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-STM16:PENNGROVE:FAC-6-1:236;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[RSDCC=<RSDCC>],[AREA=<AREA>],
[TMGREF=<TMGREF>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],
[PJMON=<PJMON>],[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],
[WVLEN=<WVLEN>],[RINGID=<RINGID>],[MSSPRTYPE=<MSSPRTYPE>],
[MUX=<MUX>],[UNIC=<UNIC>],[CCID=<CCID>],[NBRIX=<NBRIX>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>],[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],
[MSDCC=<MSDCC>],[NAME=<NAME>],[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>], [TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>], [SENDDUSFF=<SENDDUSFF>],
[AISONLPBK=<AISONLPBK>],[FREQ=<FREQ>], [LOSSB=<LOSSB>],
[FOREIGNFEND=<FOREIGNFEND>], [FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],
[SQUELCHMODE=<SQUELCHMODE>], <PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1:,,WORK,ACT:RSDCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SINGLESHELF,WVLEN=1310.00,RINGID=43,
MSSPRTYPE=WESTWORK,MUX=E2,UNIC=Y,CCID=8,NBRIX=2,SOAK=52,
SOAKLEFT=12-25,SSMRCV=STU_NCS,OSPF=Y,MSDCC=Y,NAME=\"STM PORT\",
LBCL=10.0,OPT=10.0,OPR=10.0, EXPTRC="AAA",TRC="AAA",TRCMODE=MAN,
TRCFORMAT=16-BYTE,ADMSSM=G811, SENDDUSFF=N,
AISONLPBK=AIS_ON_LPBK_ALL,FREQ=1550,LOSSB=LR-1,FOREIGNFEND=Y,
FOREIGNIPADDRESS=10.92.63.44,UNLOCKED-DISABLED,AUTOMATICINSERVICE";
Table 23-7 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
(Optional) An STM port role. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<RSDCC>
(Optional) Indicates whether or not the regenerator section DCC (RS-DCC) is to be used. The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<AREA>
(Optional) Area ID. Shows up only if the DCC is enabled. AREA is a string.
<TMGREF>
(Optional) The termination to be used, whether primary or secondary. Identifies if an STM port has a timing reference. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute)
•
Disable an attribute.
•
Enable an attribute.
<SYNCMSG>
(Optional) Synchronization status message. The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<SENDDUS>
(Optional) The facility will send the Do Not Use for Synchronization (DUS) value in 0x0f bit pattern as the synchronization status message for that facility. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute)
•
Disable an attribute.
•
Enable an attribute.
<PJMON>
(Optional) Identifies an STM port PJMON. Defaults to 0 (zero). PJMON is an integer. Set a valid VC4 number of the optical port.
Note
<SFBER>
(Optional) An STM port signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) An STM port signal degrade threshold. Defaults 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<MODE>
(Optional) STM port mode. Defaults to NCS. The parameter type is OPTICAL_MODE, which is the facility's optical mode.
•
The NE contains only one shelf and the AID representation does not consider the shelf identifier for command requests/response and autonomous reports.
•
The AID representation considers the shelf identifier for command requests/response and autonomous reports. This means the NE has more than one shelf configured or the user wants to use the new AID style.
•
The AID representation considers the shelf identifier for command requests/response and autonomous reports. This means the NE has more than one shelf configured or the user wants to use the new AID style. The shelves are connected by means of an external Ethernet switch.
<WVLEN>
(Optional) An STM port wavelength, expressed in nanometers. For example, WVLEN=1310.00 means it operates at 1310 nm in the NCS application. WVLEN is a float.
<RINGID>
(Optional) The MS-SPRing RINGID with which the port is connected. RINGID ranges from 0 to 9999. RINGID is an integer.
<MSSPRTYPE>
(Optional) The MS-SPRing type with which the port is connected. The parameter type is MSSPR_TYPE, which is the MS-SPRing type of an STM port.
•
The STM port is an east protecting port.
•
The STM port is an east working port.
•
The STM port is an west protecting port.
•
The STM port is an west working port.
<MUX>
(Optional) MS-SPRing extension byte. The parameter type is MUX_TYPE, which is the MS-SPRing extension byte.
•
E2 byte (orderwire)
•
F1 byte (user)
•
K3 byte
•
Z2 byte
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for <SOAKLEFT> are:
•
•
•
<SSMRCV>
(Optional) Displays the quality of the individual port. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
<OSPF>
(Optional) The Open Shortest Path First discovery. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<MS-DCC>
(Optional) The line DCC connection on the port. The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<NAME>
(Optional) Port Name. NAME is a string.
<LBCL>
(Optional) Displays the current value of the laser current. LBCL is a float.
<OPT>
(Optional) Displays the current value of the transmitted optical power. OPT is only displayed for NCS cards. OPT is a float.
<OPR>
(Optional) Received optical power. OPR is a float.
<EXPTRC>
(Optional) Expected path trace content. EXPTRC is a string.
<TRC>
(Optional) Path trace message to be transmitted. TRC is a string.
<TRCMODE>
(Optional) Path trace mode. Applicable only to VC-level Paths in NCS (VCn). Defaults to the OFF mode. The parameter type is TRCMODE (trace mode).
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Turn off path trace capability. Nothing will be reported.
<TRCFORMAT>
(Optional) Trace message size. The parameter type is TRCFORMAT, which is the trace format.
•
1 byte trace message
•
16 byte trace message
•
64 byte trace message
•
Enable an attribute
<ADMSSM>
(Optional) SSM selectable value. Only displayed when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
<SENDDUSFF>
(Optional) Indicates that the facility will send the DUS value in 0xff bits pattern as the synchronization status message for that facility. Defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute
•
Enable an attribute
<AISONLPBK>
(Optional) The parameter type is AIS_ON_LPBK, which indicates if AIS should be sent on loopback.
•
AIS is sent on facility loopback.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopback.
•
AIS is sent on terminal loopback.
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) The parameter type is REACH, which is the reach value.
•
Autoprovisioning
•
Reach supported on 40GIGE payload on CFP-LC card.
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<FOREIGNFEND>
(Optional) Indicates whether the far-end NE on the DCC is a foreign NE. The parameter type is ON_OFF (disable or enabled an attribute).
•
Disable an attribute.
•
Enable an attribute.
<FOREIGNIP>
(Optional) The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. FOREIGNIP is a string.
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects.
•
Squelch is enabled.
•
No Squelch
•
Generic AIS
<PSTPSTQ>
(Optional) Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) The secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.11 RTRV-10GIGE
The Retrieve 10GIGE (RTRV-10GIGE) command retrieves the 10-Gbps-specific parameters for a port that has been configured to support the Gigabit Ethernet payload with the ENT-10GIGE command.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-10GIGE::VLINE-2-1-1-2:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PSTPSTQ>,[<SST>]"
;Output Examples
100g 2012-05-21 12:40:14
M 1 COMPLD
"VFAC-1-6-1-1:,,WORK,STBY:MTU=1548,MACADDR=1c-93-87-e0-01-a9,SOAK=32,ENCAP=CBR,SYNCMSG=N,SENDDUS=N,ADMSSM=STU,PROVIDESYNC=N,:OOS-MA,DSBLD"
;
Table 23-8 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section. VLINE is the AID for 10x10G-LC card.
<ROLE>
(Optional) The port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is the standby unit in the shelf.
<NAME>
(Optional) Port name. NAME is a string.
<MTU>
<ENCAP>
<ENCAP>
(Optional) Frame encapsulation type. The parameter type is ENCAP, which is the frame encapsulation type.
•
GFP frame mode
•
HDLC frame mode
•
•
•
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals.
<SYNCMSG>
(Optional) Indicates if the BITS facility supports synchronization status message. Default is on (Y). The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<SENDDUS>
(Optional) The facility sends out a Do Not Use for Synchronization Message. This does not apply to the TXPD-10G card. This applies to an MXPD-10G card only if the payload is NCS and the card termination mode is as follows:
•
•
The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<ADMSSM>
(Optional) SSM selectable. Only applicable to BITS-IN when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
ITU-T G.811 Standard
•
Reserved For Network Synchronization Use
•
ITU-T G.812T Standard
•
Synchronized, Traceability Unknown
•
ITU-T G.812TL Standard
•
Synchronous Equipment Timing Source
<PROVIDESYNC>
(Optional) Indicates whether the facility provides synchronization. Defaults to N.
•
Yes
•
No
<MACADDR>
(Optional) The MAC address for the 10 Gigabit Ethernet payload. MACADDR is a string.
<LBCL>
(Optional) Displays the current value of the laser current. LBCL is a float.
<OPT>
(Optional) Displays the current value of the transmitted optical power. OPT is a float.
<OPR>
(Optional) Displays the current value of the received optical power. OPR is a float.
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) The parameter type is REACH, which is the reach value.
•
Autoprovisioning
•
Reach supported on 40GIGE payload on CFP-LC card.
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<PSTPSTQ>
Administrative state in the PSTPSTQ format. The parameter type is PSTPSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.12 RTRV-ALM-<MOD2ALM>
The Retrieve Alarm for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, 5GIB, 8GFC, CHGRP, DS1, DS3I, DVBASI, E1, E100, E1000, E3, E4, EC1, ETH, FSTE, G1000, GFPOS, GIGE, HDLC, ILK, ISCCOMPAT, ISC1, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, MSISC, OCH, ODU0, OMS, OTS, OTL, OTU2, OTU3, OTU4, POS, RPRIF, STM1E, VC3, VC4-4C, VC4-6C, VC4-8C, VC4-12C, VC4, VC4-16C, T1, T3, UDCDCC, UDCF, VC3, VC4, VC4-2c, VC4-3c, VC4-4c, VC4-16c, VC4-64c, VCG, VC11, VC12, WLEN, 3GVIDEO, HDSDI, ISC3STP1G, ISC3STP2G, OTU1, or SDSDI (RTRV-ALRM-<MOD2ALM>) command retrieves and sends the current status of alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
The command supports the modifier 3GVIDEO, OTU1, SDSDI, HDSDI, ISC3STP1G, and ISC3STP2G.
•
•
•
•
Category
Fault
Security
Retrieve
Input Format
RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],[<LOCN>],[<DIRN>][,];
Input Example
RTRV-ALM-OTU1::VFAC-5-3-1:1::MN,,NSA,NEND,RCV;
Table 23-9 Input Parameter Support
<AID>
Access identifier from the "ALL" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
(Optional) Condition type for an alarm or a reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not Alarmed (NA) conditions, and Not Reported (NR) conditions. See the Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]"
;
Output Example
tcc2 2011-08-18 16:16:18
M 1 COMPLD
"VFAC-5-3-1,OTU1:MN,HI-RXPOWER,NSA,08-18,12-56-40,NEND,RCV:\"Facility High Rx power\","
;
Table 23-10 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of access identifier. The parameter type is MOD2ALM, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Client facility for MXP/TXP cards
•
Channel group
•
CPS modifier signifies WSON control plane circuits.
•
DS3i-N-12 facility
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 facility
•
E100 facility
•
E1000 facility
•
E3 facility
•
E4 frame. Only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
•
Fast Ethernet port facility
•
G1000 facility
•
Generic framing protocol over packet over NCS virtual port facility
•
Gigabit Ethernet port facility
•
1.5G HD-SDI video payload.
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
ML-Series two port Gigabit Ethernet card
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
OCH termination
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port facility
•
270M SDI video payload.
•
STM1 facility
•
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card.
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
VC11 path
•
VC12 path
•
VC3 path
•
VC38C path
•
VC44C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
•
T3 path
•
UDCDCC path
•
UCDF path
•
Virtual concatenation group alarm
•
Wavelength path provisioning
<NTFCNCDE>
Two-letter notification code. the parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See the Table 28-1 for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) The condition description.
23.13 RTRV-ALMTYPE
The Retrieve Alarm Type command retrieves all system and user-defined alarm types.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-ALMTYPE:[<TID>]::<CTAG>;
Input Example
RTRV-ALMTYPE:CISCONODE::1;
Input Parameters
None.
Output Format
SID DATE TIME
M CTAG COMPLD
"<TYPEOFALM>,<ALMTYPE>"
;Output Examples
CISCONODE 2007-06-26 14:30:00
M 1 COMPLD
"SYSTEMDEFINED,AIRCOMPR"
;
23.14 RTRV-ALM-ALL
The Retrieve Alarm All (RTRV-ALM-ALL) command retrieves and sends the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter. To retrieve all the NE alarms, issue all of the following commands:
RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-ENV
RTRV-ALM-SYNCNUsage Guidelines
None
Category
Fault
Security
Retrieve
Input Format
RTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDITION>],[<SRVEFF>],[<LOCN>],[<DIRN>],[,];Input Example
RTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA,NEND,RCV;
Table 23-12 Input Parameter Support
<AID>
Access identifier from the "ALL" section. A null value is equivalent to ALL. AID is a string.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
<CONDITION>
(Optional) The type of alarm condition. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<LOCN>],[<DIRN>]:
[<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,NEND,RCV:\"POWER FAIL RESTART\", DS1-14"
;
Table 23-13 Output Parameter Support
<AID>
(Optional) Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
10 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Building integrated timing supply (BITS) alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 facility
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 facility
•
E3 facility
•
E100 facility
•
ETH facility
•
E1000 facility
•
E4 facility
•
ENV facility
•
EQPT facility
•
Fast Ethernet port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload
•
ISC-3 STP 2G video payload
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
ML-Series two port Gigabit Ethernet card
•
ML-Series 100T eight port Gigabit Ethernet card
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port facility
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 facility
•
STM1E facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
SYNCN facility
•
TCC facility
•
VC11 path
•
VC12 path
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
•
T3 path
•
UDCDCC path
•
UCDF path
•
Virtual concatenation group alarm
•
Wavelength path provisioning
<NTFCNCDE>
Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<OCRDAT>
Date when the specific event or violation occurred, MM-DD.
<OCRTM>
Time when the specific event or violation occurred, HH-MM-SS.
<DESC>
(Optional) A condition description. DESC is a string.
<AIDDET>
(Optional) The supplementary equipment identification. AIDDET uses the same addressing rules as the AID, but specifies AID type and additional details about the entity being managed.
23.15 RTRV-ALM-BITS
The Retrieve Alarm Building Integrated Timing Supply (RTRV-ALM-BITS) command retrieves and sends the current status of alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],
[<LOCN>],[<DIRN>];Input Example
RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;
Table 23-14 Input Parameter Support
<AID>
Access identifier from the "BITS" section.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is a two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed
•
The alarm is not reported
<CONDTYPE>
(Optional) The condition type for an alarm or reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an Cisco NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],[<OCRTM>],[<LOCATION>],[<DIRECTION>]:[<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\","
;
Table 23-15 Output Parameter Support
<AID>
Access identifier from the "BITS" section.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
BITS alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 facility
•
E1 facility
•
E3 facility
•
E100 facility
•
E1000 facility
•
E4 facility
•
ENV facility
•
EQPT facility
•
Fast Ethernet port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port facility
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 facility
•
STM1E facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
SYNCN facility
•
TCC facility
•
VC11 path
•
VC12 path
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
<NTFCNCDE>
Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCATION>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRECTION>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
<DESC>
(Optional) A condition description. DESC is a string.
23.16 RTRV-ALM-CPS
The Retrieve Alarm Control Plane Service (RTRV-ALM-CPS) command retrieves the alarm reported on the control plane service.
Usage Guidelines
•
•
•
•
Category
NCS
Security
Retrieve
Input Format
RTRV-ALM-CPS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],[<LOCN>],[<DIRN>][,];
Input Example
RTRV-ALM-CPS::ALL:1;
Table 23-16 Input Parameter Support
<AID>
Only ALL AID is supported.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is a two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed
•
The alarm is not reported
<CONDTYPE>
(Optional) The condition type for an alarm or reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an Cisco NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>,<INDEX>,<MOD2>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,<DATE>,<TIME>,<LOCN>,<DIRN>:<CONDITION DESCRIPTION>";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-6-1-RX,6,CPS:MJ,LOS-P,SA,01-16,01-18-31,NEND,RCV:\"INCOMING PAYLOAD SIGNAL ABSENT\""
;
Table 23-17 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<INDEX>
Auto generated sequence number associated with the alarm.
<MOD2>
Modifier 2 of the Alarm command.
<NTFCNCDE>
Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTIM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) A condition description. DESC is a string.
23.17 RTRV-ALM-ENV
The Retrieve Alarm Environment (RTRV-ALM-ENV) command retrieves the environmental alarms.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
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\""
;
Table 23-18 Output Parameter Support
<AID>
Access identifier from the "ENV" section.
<NTFCNCDE>
Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<ALMTYPE>
The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm type.
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48 V power supply failure
•
-139 V power converter
•
-190 V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<DESC>
(Optional) A condition description. DESC is a string.
23.18 RTRV-ALM-EQPT
The Retrieve Alarm Equipment (RTRV-ALM-EQPT) command retrieves and sends the current status of alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.
Usage Guidelines
None
Category
Equipment
Security
Retrieve
Input Format
RTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],
[<LOCN>],[<DIRN>];Input Example
RTRV-ALM-EQPT:TWOROCK:SLOT-1:227::MJ,HITEMP,NSA;
Table 23-19 Input Parameter Support
<AID>
Access identifier from the "EQPT" section.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
(Optional) The condition type for an alarm or a reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-3,EQPT:MJ,HITEMP,NSA,08-01,14-25-59,,:\"HI TEMPERATURE\","
;
Table 23-20 Output Parameter Support
<AID>
(Optional) Access identifier from the "EQPT" section.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
BITS alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 alarm
•
E1 alarm
•
(ONS 15310 MA NCS) E3 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet port alarm
•
G1000 alarm
•
Gigabit Ethernet port alarm
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
SYNCN alarm
•
TCC alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<NTFCNCDE>
Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) A condition description. DESC is a string.
23.19 RTRV-ALM-SYNCN
The Retrieve Alarm Synchronization (RTRV-ALM-SYNCN) command retrieves and sends the current status of alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>],[<LOCN>],[<DIRN>];Input Example
RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;
Table 23-21 Input Parameter Support
<AID>
Access identifier from the "SYNC_REF" section.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
(Optional) The condition type for an alarm or a reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.
•
The condition is non-service affecting.
•
The condition is service affecting.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:CR,FAILTOSW,SA,
08-01,14-25-59,,:\"FAILURE TO SWITCH TO PROTECTION\","
;
Table 23-22 Output Parameter Support
<AID>
Access identifier from the "SYN" section.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gbps fiber connection
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
BITS alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 alarm
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet port alarm
•
G1000 alarm
•
Gigabit Ethernet port alarm
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
SYNCN alarm
•
TCC alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<NTFCNCDE>
Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) A condition description. DESC is a string.
23.20 RTRV-ALMTH-<MOD2>
The Retrieve Alarm Threshold for 10GFC, 10GIGE, 40GIGE, 100 GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, 5GIB, 8GFC, D1VIDEO, DS1, DS3I, DV6000, DVBASI, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ILK, ISCCOMPAT, ISC1, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OTU3, STM1, STM4, STM16, STM64, GIGE, POS, VC3, VC4, VC4-2c, VC4-3c, VC4-4c, VC4-8c, VC4-16c, VC4-64c, 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, OTU4, OTL, ISC3STP1G, or ISC3STP2G (RTRV-ALMTH-<MOD2>) command retrieves the alarm threshold values. The only applicable MOD2 values are OC3, OC12, OC48, OC192, OCH, OMS, and OTS.
Usage Guidelines
The command supports 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, and ISC3STP2G modifiers.
•
•
•
•
•
•
Category
Fault
Security
Retrieve
Input Format
RTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<CONDTYPE>][,,::];
Input Example
RTRV-ALMTH-OTU1::VFAC-5-3-1:A::OPT-LOW;
Table 23-23 Input Parameter Support
<AID>
Access identifier from the "ALL" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
<ALMTHR>
Alarm threshold. Must not be null. The parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.
•
ADD Power - High Degrade
•
ADD Power - High Failure
•
ADD Power - Low Degrade
•
ADD Power - Low Failure
•
Battery Voltage—Extremely High
•
Battery Voltage—Extremely Low
•
Battery Voltage—High
•
Battery Voltage—Low
•
Low Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
High Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias Current in microA as a tenth of a percentage of the High Warning Threshold, Low Warning Threshold. Measured value 0.0%, 100.0%.
•
Receive power in 1tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
Low Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
High Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
Low Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
High Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>:<CONDTYPE>,,,<THLEVEL>";
Output Example
TCC2 2011-08-18 16:01:38
M A COMPLD
"VFAC-5-3-1,OTU1:OPT-LOW,,,-4.5,"
;
RN-DEV-107 2013-05-16 12:47:54
M 1 COMPLD
"VFAC-5-1-1,GIGE:OPT-LOW,,,-40.0,"
"VFAC-5-1-1,GIGE:OPT-HIGH,,,30.0,"
"VFAC-5-1-1,GIGE:LBCL-HIGH,,,100.0,"
"VFAC-5-1-1,GIGE:OPR-LOW,,,-40.0,"
"VFAC-5-1-1,GIGE:OPR-HIGH,,,30.0,"
;
Table 23-24 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<MOD>
AID type. The parameter type is MOD2, which is the line/path modifier.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit fiber connectivity payload
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
100 Gigabit Ethernet.
•
10 Gigabit Ethernet.
•
2-Gigabit ISC3 compatible
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
D1 video
•
DS1 line of a DS3XM card
•
DS3I line
•
DV6000
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
EC1 facility
•
ESCON
•
ETR_CLO
•
FSTE facility
•
G1000 facility
•
GFP over POS. Virtual ports partitioned using GFP's multiplexing capability.
•
Gigabit Ethernet
•
1.5G HD-SDI video payload.
•
HDTV
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
OC-3 facility
•
OC-12 facility
•
OC-48 facility
•
OC-192 facility
•
OC-768 facility
•
Optical Channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port
•
270M SDI video payload
•
STS1 path
•
STS3c path
•
STS6c path
•
STS9c path
•
STS18c path
•
STS12c path
•
STS24c path
•
STS36c path
•
STS48c path
•
STS192c path
•
T1/DS1 facility/line
•
T1/DS1 facility/line
•
VT1 path
•
VT2 path
<CONDTYPE>
Condition type for an alarm or a reported event. The parameter type is ALM_THR, which is the alarm threshold list for the MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.
•
Battery Voltage—Extremely High
•
Battery Voltage—Extremely Low
•
Battery Voltage—High
•
Battery Voltage—Low
•
Low Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
High Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias Current in microA as tenths of a percentage of High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
Low Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
High Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
Low Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
High Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
<THLEVEL>
Threshold level. THLEVEL is a float.
23.21 RTRV-ALMTH-EQPT
The Retrieve Alarm Threshold Equipment (RTRV-ALMTH-EQPT) command retrieves the alarm thresholds for the power level monitoring on an NE.
Usage Guidelines
None
Category
Equipment
Security
Retrieve
Input Format
RTRV-ALMTH-EQPT:[<TID>]:[<AID]>:<CTAG>::[<CONDTYPE>][,,::];
Input Examples
RTRV-ALMTH-EQPT:::1::BATV-HIGH;
RTRV-ALMTH-EQPT::SHELF-2:1::BATV-HIGH;
Table 23-25 Input Parameter Support
<AID>
(Optional) The node or shelf access identifier from the "SHELF" section. If omitted, it addresses the node or first shelf of the node.
<CONDTYPE>
Alarm threshold. A null value is equivalent to ALL. The parameter type is ALM_THR, which is the alarm threshold list for the MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.
•
Battery Voltage—Extremely High
•
Battery Voltage—Extremely Low
•
Battery Voltage—High
•
Battery Voltage—Low
•
Low Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
High Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias Current in microA as tenths of a percentage of High Warning Threshold, Low Warning Threshold. Measured value [0.0%, 100.0%]
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
Low Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
High Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
Low Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
High Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],<MOD2B>:<CONDTYPE>,,,<DNFIELD>";
Output Examples
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,""
;
Table 23-26 Output Parameter Support
<AID>
(Optional) The node or shelf access identifier from the "SHELF" section. If omitted, it addresses the node or first shelf of the node.
<MOD2B>
Alarm type. The parameter type is MOD2B, which is the alarm type.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
BITS alarm
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 alarm
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet Port alarm
•
G1000 alarm
•
Gigabit Ethernet port alarm
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port alarm
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
SYNCN alarm
•
TCC alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<CONDTYPE>
Alarm threshold. The parameter type is ALM_THR, which is the alarm threshold list for the MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.
•
Battery Voltage—Extremely High
•
Battery Voltage—Extremely Low
•
Battery Voltage—High
•
Battery Voltage—Low
•
Low Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
High Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm.
•
Gain not reached—High Degrade Threshold
•
Gain not reached—High Failure Threshold
•
Gain not reached—Low Degrade Threshold
•
Gain not reached—Low Failure Threshold
•
Laser Bias Current in microA as tenths of a percentage of High Warning Threshold, Low Warning Threshold. Measured value [0.0%, 100.0%].
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Receive power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Transmit power in tenths of a microW. Measured value -40.0 dBm, +30.0 dBm.
•
Optical Power—High Degrade Threshold
•
Optical Power—High Failure Threshold
•
Optical Power—Low Degrade Threshold
•
Optical Power—Low Failure Threshold
•
Low Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
High Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm.
•
Low Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
High Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm.
•
VOA Attenuation—High Degrade Threshold
•
VOA Attenuation—High Failure Threshold
•
VOA Attenuation—Low Degrade Threshold
•
VOA Attenuation—Low Failure Threshold
<DNFIELD>
DNFIELD is a float.
23.22 RTRV-ALS
The Retrieve Automatic Laser Shutoff (RTRV-ALS) 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 STM4, 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.
Usage Guidelines
RTRV-ALS on 10x10G-LC, 100G-LC-C, and CFP-LC cards retrieves ALS attributes on the OCH interface for non-OTU payloads and on payloads interfaces for OTU payloads.
Category
Ports
Security
Retrieve
Input Format
RTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-ALS:PENNGROVE:FAC-1-1:1;
Input Parameters
<AID>
Access identifier from the "ALL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>],
[ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>],[OSRI=<OSRI>]";
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:"
;
Table 23-27 Input Parameter Support
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
Type of access identifier. The parameter type is MOD2, which is the line/path modifier.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit fiber connectivity payload
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
2-Gigabit ISC3 compatible
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
D1 video
•
DS3i-N-12 line
•
DV6000
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1
•
E3
•
E4 frame. Only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
•
ESCON
•
ETRCLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over NCS. Virtual ports partitioned using GFP's multiplexing capability.
•
Gigabit Ethernet
•
HDTV
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gigabit ISC3 Peer
•
2-Gigabit ISC3 Peer
•
1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gigabit ISC1, ISC2, and ISC3 compatibility
•
Optical Channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 4
•
POS port
•
270M SDI video payload
•
STM1 facility
•
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
VC3 path
•
VC4-4C path
•
VC3-8C path
•
VC4-64C path
•
VC4-8C path
•
VC4 path
•
VC4-16C path
•
VC4-2C path
•
VC4-3C path
•
VC11 path
•
VC12 path
<ALSMODE>
(Optional) ALS is enabled or disabled. The parameter type is ALS_MODE, which is the working mode for automatic laser shutdown.
•
Automatic
•
Disabled
•
Manual
•
Manual restart for test
<ALSRCINT>
(Optional) ALS recovery interval. The range is 60 to 300 seconds. ALSRCINT is an integer.
<ALSRCPW>
(Optional) ALS recovery pulse width. The range is 2.0 to 100.00 seconds, in increments of 100 ms. ALSRCPW is a float.
<LSRSTAT>
(Optional) Status of the laser. The parameter type is LASER_STATUS, which is the status of laser.
•
Laser is switched on but is working automatic power reduction.
•
Laser is switched off.
•
Laser is switched on.
<OSRI>
(Optional) OSRI enabled or disabled. Present only on a port where the safety is supported. Defaults to off. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
23.23 RTRV-APC
The Operate Amplifier Power Control (RTRV-APC) command retrieves the APC application attributes.
Usage Guidelines
None
Category
NCS
Security
Maintenance
Input Format
RTRV-APC:[<TID>]::<CTAG>;
Input Example
RTRV-APC:PENNGROVE:WDMSIDE-A:114;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
":[ROLE=<ROLE>],[APCENABLE=<APCENABLE>],[APCSTATE=<APCSTATE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"::APCENABLE=Y,APCSTATE=WORKING"
;
23.24 RTRV-ATTR-CONT
The Retrieve Attribute Control (RTRV-ATTR-CONT) command retrieves and sends the attributes associated with an external control. These attributes are used when an external control is operated or released. To set these attributes, use the SET-ATTR-CONT command.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input Example
RTRV-ATTR-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Table 23-29 Input Parameter Support
<AID>
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set.
<CONTTYPE>
(Optional) Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND"
;
Table 23-30 Output Parameter Support
<AID>
Access identifier from the "ENV" section. Identifies the external control for which attributes are being set.
<CONTTYPE>
(Optional) Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
23.25 RTRV-ATTR-ENV
The Retrieve Attribute Environment (RTRV-ATTR-ENV) command retrieves the attributes associated with an environmental alarm.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Input Example
RTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Table 23-31 Input Parameter Support
<AID>
Access identifier from the "ENV" section.
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<ALMTYPE>
(Optional) The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm type.
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48 V power supply failure
•
-139 V power converter
•
-190 V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[<NTFCNCDE>],[<ALMTYPE>],[<DESC>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,\"OPEN DOOR\""
;
Table 23-32 Output Parameter Support
<AID>
Access identifier from the "ENV" section.
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<ALMTYPE>
(Optional) The alarm type for the environmental alarm. The parameter type is ENV_ALM, which is the environmental alarm type.
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48 V power supply failure
•
-139 V power converter
•
-190 V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
<DESC>
(Optional) Alarm description. DESC is a string.
23.26 RTRV-AUDIT-LOG
The Retrieve Audit Log (RTRV-AUDIT-LOG) command retrieves the contents of the audit log stored in the NE. Audit records contain information for user operations such as login, logout, change of provisioning parameters and other changes a user might make when connected to the NE. Audit records do not store operations related to parameter retrieval.
Usage Guidelines
None
Category
Log
Security
Superuser
Input Format
RTRV-AUDIT-LOG:[<TID>]::<CTAG>;
Input Example
RTRV-AUDIT-LOG:::1;
Input Parameters
None
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\""
;
23.27 RTRV-AUTO
The Retrieve Auto (RTRV-AUTO) command retrieves the AUTO ports provisioned. Port bandwidth changes to OC3/OC12/OC48 as per the incoming signal when auto sense is enabled. Default being OC48 when auto sense is disabled.
Usage Guidelines
None
Category
NCS
Security
Provisioning
Input Format
RTRV-AUTO:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-AUTO:CISCO:VFAC-2-1-1:1;
Input Parameters
None that require description
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[DETECTEDPAYLOAD=<DETECTEDPAYLOAD>],[AUTOSENSE=<AUTOSENSE>]"
;
Output Example
M 1 COMPLD
"VFAC-15-1-1,DETECTEDPAYLOAD=OC48,AUTOSENSE=N"
;
Output Parameters
23.28 RTRV-BITS
The Retrieve Building Integrated Timing Supply (RTRV-BITS) command retrieves the BITS configuration command.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-BITS:SONOMA:BITS-1:782;
Input Parameters
<AID>
Access identifier from the "BITS" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],
[SYNCMSG=<SYNCMSG>],[AISTHRSHLD=<AISTHRSHLD>],[SABIT=<SABIT>],
[IMPEDANCE=<IMPEDANCE>],[BITSFAC=<BITSFAC>],[ADMSSM=<ADMSSM>]:[<PST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1::LINECDE=AMI,FMT=ESF,LBO=0-133,SYNCMSG=N,AISTHRSHLD=G811,
SABIT=BYTE-4,IMPEDANCE=120-OHM,BITSFAC=E1,ADMSSM=G811:UNLOCKED"
;
Table 23-34 Input Parameter Support
<AID>
Access identifier from the "BITS" section.
<LINECDE>
(Optional) Line code. The parameter type is LINE_CODE (line code).
•
Line code value is AMI.
•
Binary three-zero substitution.
•
Line code value is B6ZS .
•
Line code value is B8ZS (bipolar with eight-zero substitution).
•
Line Code HDB3. Only applicable to NCS E1 signal.
•
JBZS
•
ZBTSI
<FMT>
(Optional) Digital signal frame format. The parameter type is FRAME_FORMAT, which is the frame format for an E1 port.
•
AUTOPROV
•
C-BIT line type applies to the DS3XM and DS3E cards.
•
DS2 FRAMED
•
NCS E1 CRCMF frame format
•
NCS E1 CRC frame format
•
NCS E1 MF frame format
•
NCS E1 unframed format
•
NCS E1 framed format
•
E2 FRAMED
•
E3-FRAME
•
E3-PLCP
•
FRAMENA
•
G-751
•
G-832
•
M13 line type applies to the DS3XM and DS3E cards.
•
M23
•
SYNTRAN
<LBO>
(Optional) BIS line build out settings. Default value is 0 to 133. LBO is an integer. The parameter type is BITS_LineBuildOut (BITS line buildout).
•
BITS line buildout range is 0 to 133.
•
BITS line buildout range is 134 to 266.
•
BITS line buildout range is 267 to 399.
•
BITS line buildout range is 400 to 533.
•
BITS line buildout range is 534 to 655.
<SYNCMSG>
(Optional) Indicates if the BITS facility supports synchronization status message. Default is on (Y). The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
•
The ring does not support the extended K1/K2/K3 protocol.
•
The ring does support the extended K1/K2/K3 protocol.
<AISTHRSHLD>
(Optional) Alarm indication signal threshold. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
ITU-T G.811 Standard
•
Reserved For Network Synchronization Use
•
ITU-T G.812T Standard
•
Synchronized, Traceability Unknown
•
ITU-T G.812TL Standard
•
Synchronous Equipment Timing Source
<SABIT>
(Optional) When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. The parameter type is SABITS (SA BITS).
•
SABIT is BYTE-4.
•
SABIT is BYTE-5.
•
SABIT is BYTE-6.
•
SABIT is BYTE-7.
•
SABIT is BYTE-8.
<IMPEDANCE>
(Optional) When the frame format selection is E1, IMPEDANCE is the terminal impedance of the BITS-IN port. The parameter type is IMPEDANCE, which is the terminal impedance of the BITS-IN port.
•
Impedance of 120 ohm
•
Impedance of 75 ohm
<BITSFAC>
(Optional) BITS facility settings. The parameter type is BITS_FAC, which is the BITS facility rate. 64 k and 6 MHz are only applicable to NCS.
•
2 MHz rate
•
64 K rate
•
6 MHz rate
•
E1 rate
<ADMSSM>
(Optional) SSM selectable. Only applicable to BITS-IN when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
ITU-T G.811 Standard
•
Reserved For Network Synchronization Use
•
ITU-T G.812T Standard
•
Synchronized, Traceability Unknown
•
ITU-T G.812TL Standard
•
Synchronous Equipment Timing Source
<PST>
(Optional) Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In service
•
Out of service
23.29 RTRV-AWCFG
The Retrieve Alien Wavelength Configuration (RTRV-AWCFG) retrieves the alien wavelength attributes configured.
Usage Guidelines
None
Category
NCS
Security
Provisioning
Input Format
RTRV-AWCFG:[<TID>]:<src>:<CTAG>::[:];
Input Example
RTRV-AWCFG::CHAN-3-5-RX:1;
Table 23-35 Parameter Support
<SRC>
AID from the "ALL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
""<AID>:<ALIENID>,<FECMODE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-3-4-RX:40G NCS ITU-T TXP,FECMODE=ENHANCED14"
;
Table 23-36 Output Parameter Support
<AID>
AID from the "ALL" section.
<ALIENID>
Indicates the operating mode for alien wavelength. ALIENID is a STRING.
<FECMODE>
Specifies the FEC mode for alien wavelength.
•
Enhanced FEC is enabled.
•
Enhanced FEC 1.4 is enabled.
•
Enhanced FEC 1.7 is enabled.
•
7% High Gain FEC is enabled.
•
20% High Gain FEC is enabled.
•
FEC is disabled.
•
Standard FEC is enabled.
23.30 RTRV-BULKROLL-<STM_TYPE>
The Retrieve Bulkroll for STM4, STM64, STM1, or STM16 (RTRV-BULKROLL-STM_TYPE>) command retrieves roll data parameters on a line. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Bridge and Roll
Security
Retrieve
Input Format
RTRV-BULKROLL-<OCN_TYPE>:[<TID>]:<SRC>:<CTAG>:::[CRSTYPE=<CRSTYPE>];
Input Example
RTRV-BULKROLL-STM4:CISCO:FAC-3-1:1:::VC3;
Input Parameters
<SRC>
Source AID from the "FACILITY" section.
<CRSTYPE>
One of the values: VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12
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"
;
Table 23-37 Output Parameter Support
<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>
(Optional) The rolling mode of operation. The parameter type is RMODE, which specifies the roll mode.
•
Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous endpoint.
•
Manual. Enter the corresponding delete roll/bulkroll command to delete the previous endpoint.
<VLDSIG>
(Optional) The rolling mode of operation. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
23.31 RTRV-BULKROLL-<OCN_TYPE>
The Retrieve Bulkroll for OC12, OC192, OC3, OC48, or OC768 (RTRV-BULKROLL-<OCN_TYPE>) command retrieves roll data parameters on a line.
Usage Guidelines
See Table 29-1 for supported modifiers by platform.
Category
Bridge and Roll
Security
Provisioning
Input Format
RTRV-BULKROLL-<OCN_TYPE>:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-BULKROLL-OC12:CISCO:FAC-3-1:1;
Input Parameters
<SRC>
Source AID from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<FROM>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],VLDSIG=<VLDSIG>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-3-1-1:RFROM=STS-3-1-1,RTO=STS-5-1-1,RMODE=AUTO,VLDSIG=Y"
;Output Parameters
<FROM>
One of the end points. Access identifier from the "FACILITY" section for line level rolling and bulk rolling.
<RFROM>
The termination point of the existing cross-connect that is to be rolled. The AID is from the "VC" section (except VCM and FACILITY).
<RTO>
The termination point that will become a leg of the new cross-connection. The AID is from the "VC" section (except VCM and FACILITY).
<RMODE>
(Optional) The rolling mode of operation. The parameter type is RMODE, which specifies the roll mode.
•
Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous end-point.
•
Manual. Enter the corresponding delete roll/bulkroll command to delete the previous end-point.
•
Manual
•
Manual Restart for Test
<VLDSIG>
(Optional) The rolling mode of operation. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
23.32
23.33 RTRV-BWP-ETH
This command is used to retrieve a BandWidth Profile entry in BWP DB. The BWP DB is a collection of BWP used in a Network Element.
Usage Guidelines
The "ALL" AID is supported by this command.
If the AID is invalid, an IIAC (Invalid AID) error message is returned.
Category
Ethernet
Security
Retrieve
Input Format
RTRV-BWP-ETH:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-BWP-ETH:ROCKS:BWP-10000:1;
Input Parameter
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[NAME=<NAME>],[CIR=<CIR>],[CBS=<CBS>],[PBS=<PBS>],[PIR=<PIR>],[CFMSTATE=<CFM_STATE>]:";
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BWP-10000::NAME="MyBWP",CIR=10,CBS=1M,PBS=1M,PIR=20,CFMSTATE=Y:";
;Output Parameters
23.34 RTRV-CFM
The Retrieve Connectivity Fault Management (RTRV-CFM) command retrieves the Connectivity Fault Management (CFM) protocol state at the port level.
Usage Guidelines
•
•
Category
Port
Security
Retrieve
Input Format
RTRV-CFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-CFM:454-156:ETH-1-1-1:1;
Input Parameter
Table 23-40
<AID>
Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<STATE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-7-1-1,STATE=ENABLE"
;
Table 23-41 Output Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<CFM_STATE>
Indicates whether the CFM is enabled or disabled on the port.
•
Indicates the CFM is enabled on the port.
•
Indicates the CFM is disabled on the port.
23.35 RTRV-CHGRP
The Retrieve Channel Group (RTRV-CHGRP) command retrieves the layer 2 channel group information of GE_XP and 10GE_XP ethernet cards.
Category
Channel Group
Security
Retrieve
Input Format
RTRV-CHGRP:[<TID>]:<aid>:<CTAG>[::::];
Input Example
RTRV-CHGRP::CHGRP-1-2:1;
Input Parameters
<AID>
Access identifier from the "CHGRP" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[LACPMODE=<LACPMODE>],[HASHINGALGO=<HASHINGALGO>],[NIMODE=<NIMODE>],[MACLEARNING=<MACLEARNING>],[INGRESSCOS=<INGRESSCOS>],[ETHERCETYPE=<ETHERCETYPE>],[ETHERSTYPE=>ETHERSTYPE>],[BPDU=<BPDU>],[QNQMODE=<QNQMODE>],[MTU=<MTU>],[FLOWCTRL=<FLOWCTRL>],[SPEED=<SPEED>],[EXPSPEED=<EXPSPEED>],[CIR=<CIR>,[CBS=<CBS>],[EBS=<EBS>]:<PST>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHGRP-1-1:LACPMODE=ACTIVE,HASHINGALGO=HASHING_SA_DA_VLAN_INCOMING_PORT,NIMODE=UNI,MACLEARNING=N,INGRESSCOS=0,ETHERCETYPE=8100,ETHERSTYPE
=8100,BPDU=Y,QNQMODE=SELECTIVE,MTU=9700,FLOWCTRL=ASYMMETRIC,
SPEED=AUTO,EXPSPEED=AUTO,CIR=100,CBS=4K,EBS=4K:OOS-MA,DSBLD"
;
Table 23-42 Output Parameter Support
<AID>
Access identifier from the "CHGRP" section.
<NIMODE>
Identifies the Ethernet Network Interface Mode.
•
(Default) Network-Network Interface Mode
•
User-Network Interface Mode
<LACPMODE>
LACP mode values
•
Manual mode of LACP
•
Active mode of LACP
•
Passive mode of LACP
<HASHINGALGO>
Hashing algorithm value
•
The Hashing Algorithm value is HASHING_SA_VLAN_INCOMING_PORT.
•
The Hashing Algorithm is HASHING_DA_VLAN_INCOMING_PORT.
•
The Hashing Algorithm is HASHING_SA_DA_VLAN_INCOMING_PORT.
•
The Hashing Algorithm is HASHING_SRC_IP_TCP_UDP.
•
The Hashing Algorithm is HASHING_DST_IP_TCP_UDP
•
The Hashing Algorithm is HASHING_SRC_DST_IP_TCP_UDP.
<MTU>
(Optional) Maximum transport unit. The parameter type is MTU_TYPE, which indicates the maximum transport unit used by an Ethernet card. Defaults to 9600.
•
10004. Indicates jumbo size.
•
1500
•
1548
•
9600. Indicates jumbo size.
•
64
•
9700. Indicates jumbo size.
<ATTACH >
Ethernet AID for the front end CE-MR-6 cards. Ethernet AID for the ethernet port on GE_XP and 10GE_XP card.
<DETACH>
To remove or detach the port.
<SPEED>
(Optional) The parameter type is ETHER_SPEED, which indicates Ethernet speed. Defaults to AUTO.
•
100 Megabits per second
•
10 Gigabits per second
•
10 Megabits per second
•
1 Gigabit per second
•
40 Gigabit per second
•
Enable auto negotiation with full duplex.
<EXPSPEED>
(Optional) Ethernet speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Megabits per second
•
10 Gigabits per second
•
10 Megabits per second
•
1 Gigabit per second
•
Auto
<CIR>
Ingress committed information rate. This is a value between 0.0 and 100.0. Default value is 100.0.
<CBS>
Ingress committed burst bucket size.
•
4 Kbit bucket size
•
16 Kbit bucket size
•
32 Kbit bucket size
•
64 Kbit bucket size
•
128 Kbit bucket size
•
256 Kbit bucket size
•
512 Kbit bucket size
•
1 Mbit bucket size
•
2 Mbit bucket size
•
4 Mbit bucket size
•
8 Mbit bucket size
•
16 Mbit bucket size
•
16 Kbit bucket size
<EBS>
Ingress excess burst bucket size.
<MACLEARNING>
MAC Address Learning Mode. This activates the MAC address learning on the interface to avoid packet broadcasting.
•
Enables the MAC learning on the interface.
•
Disables the MAC learning on the interface.
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Set a Cos value
•
Use the Customer COS
•
The COS will be provisioned on CVLAN basis (QinQ selective mode)
<ETHERCETYPE>
Identifies a customer foreseen Ethernet type. If the customer uses a non-standard Ethernet type, the incoming packets will be accepted only if the CE-VLAN Ethernet type matches this parameter.
<ETHERSTYPE>
Identifies a customer foreseen Ethernet type. If the customer uses a non-standard Ethernet type, the incoming packets will be accepted only if the CE-VLAN Ethernet type matches this parameter.
<BPDU>
BPDU (Bridge Protocol Data Unit) management mode; Drop/Passthrough BPDU tagged packets.
•
Enables the BPDU tag.
•
Disables the BPDU tag.
<QNQMODE>
This is used to represent the QinQ mode operations.
•
The S-VLAN tag is added only on specified CE-VLANs. The other packets are dropped.
•
The S-VLAN tag is always performed where all packets having the S-VLAN-ID identified by TRNSPSVLAN parameter are allowed.
<TRNSPSVLAN>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<NAME>
(Optional) NAME is a string. User-assigned port name.
23.36 RTRV-CMD-SECU
The Retrieve Command Security (RTRV-CMD-SECU) command retrieves the current command security level of the command specified in the AID field.
Usage Guidelines
None
Category
Security
Security
Superuser
Input Format
RTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-CMD-SECU::INIT-REG:1;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<CAP>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"INIT-REG:ROOT_USER"
;
23.37 RTRV-COND-<MOD2ALM>
The Retrieve Condition for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, 5GIB, 8GFC, CHGRP, DS1, DS3I, DVBASI, E1, E100, E1000, E3, E4, EC1, FSTE, G1000, ETH, GFPOS, GIGE, HDLC, ILK, ISCCOMPAT, ISC1, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, MSISC, OCH, ODU0, OMS, OTS, OTL, OTU2, OTU3, OTU4, POS, RPRIF, STM1, STM4, STM16, STM64, STM1E, VC3, VC4-4C, VC4-6C, VC4-64C, VC4-8C, VC4-12C, VC4, VC4-16C, VC4-2C, VC4-3C, T1, T3, UDCDCC, UDCF, VC3, VC4, VC4-2c, VC4-3c, VC4-4c, VC4-8c, VC4-16c,VC4-64c, VC11, VC12, VCG, VC11, VC12, WLEN, 3GVIDEO, HDSDI, ISC3STP1G, ISC3STP2G, OTU1, or SDSDI (RTRV-COND-<MOD2ALM>) command retrieves the current standing condition and state associated with an entity.
Usage Guidelines
The command supports the modifiers 3GVIDEO, OTU1, SDSDI, HDSDI, ISC3STP1G, and ISC3STP2G. The RTRV-COND-OTL command retrieves the conditions raised on sublanes of 100G-LC-C and CFP-LC Cards.
RTRV-COND-ODU0 command retrieves the conditions raised on the ODU0's on AR-XPE card only.
See Table 29-1 for supported modifiers by platform.
Category
Fault
Security
Retrieve
Input Format
RTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-OTU1::VFAC-14-3-1:1::OTUK-IAE;
Table 23-44 Input Parameter Support
<AID>
Access identifier from the "ALL" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
<TYPEREQ>
(Optional) The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether the problem is reported (that is, whether it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD "<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>], [<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]"
;
Output Example
tcc2 2011-08-18 16:11:55
M 1 COMPLD
"VFAC-14-3-1,OTU1:MN,OTUK-IAE,NSA,08-18,12-58-24,NEND,RCV,\"OTUK: INCOMING ALIGNMENT ERROR\""
;
Table 23-45 Output Parameter Support
<AID>
Access identifier from the "ALL" section
<AIDTYPE>
(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2ALM—alarm type
•
100 Gigabit Ethernet
•
10 Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Client facility for MXP/TXP cards
•
Channel group
•
CPS modifier signifies WSON control plane circuits.
•
DS3i-N-12 alarm
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 frame. Only applicable to STM1E port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode
•
ETH facility
•
Fast Ethernet port alarm
•
G1000 alarm
•
Generic framing protocol over packet over NCS virtual port alarm
•
Gigabit Ethernet port alarm
•
1.5G HD-SDI video payload.
•
High-level data link control (HDLC) frame mode.
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
OCH termination
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload.
•
STM1 alarm
•
STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card.
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC38C alarm
•
VC44C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
•
UDCDCC alarm
•
UCDF alarm
•
Virtual concatenation group alarm
•
Wavelength path provisioning
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<TYPEREP>
The condition itself. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRECTION>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) Condition description. DESC is a string.
23.38 RTRV-COND-ALL
The Retrieve Condition All (RTRV-COND-ALL) command retrieves the current standing condition for all entities.
Usage Guidelines
This command does not return all conditions that are returned by other, more specific RTRV-COND commands; RTRV-COND-ALL returns a subset of these conditions. Telcordia GR-253-CORE, Section 6.2.1.8.4 states that a retrieval that returns ALL conditions from a node (RTRV-COND-ALL) must omit any conditions that have the same root cause as other raised conditions. The section also states that 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. So, for example, RTRV-COND-VC3 includes the same-root-cause conditions in the set it returns and, RTRV-COND-ALL does not.
To retrieve all of the NE conditions, issue all of the following commands:
RTRV-COND-ALL
RTRV-COND-ENV
RTRV-COND-BITS
RTRV-COND-SYNCNCategory
Fault
Security
Retrieve
Input Format
RTRV-COND-ALL:[<TID>]:[<AID>]:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-ALL:DXT:ALL:229::LOS;
Table 23-46 Input Parameter Support
<AID>
(Optional) Access identifier from the "ALL" section. AID is a string. A null value is equivalent to ALL.
<TYPEREQ>
(Optional) The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<DESC>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"RPRIF-2-0,T3:MJ,FORCE-REQ,SA,01-01,16-00-20,NEND,RCV,\"FORCED SWITCH REQUEST\""
;
Table 23-47 Output Parameter Support
<AID>
Access identifier from the "ALL" section for the entity that has an alarm condition.
<AIDTYPE>
(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet
•
10 Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
BITS alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 alarm
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ETH facility
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet port alarm
•
G1000 alarm
•
Gigabit Ethernet port alarm
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
SYNCN alarm
•
TCC alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed
•
The alarm is not reported
<TYPEREP>
The type of condition to be retrieved. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRECTION>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) Condition description. DESC is a string.
23.39 RTRV-COND-BITS
The Retrieve Condition Building Integrated Timing Supply (RTRV-COND-BITS) command retrieves the standing conditions on BITS.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-COND-BITS:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-BITS:TID:BITS-1:229::LOS;
Table 23-48 Input Parameter Support
<AID>
Access identifier from the "BITS" section.
<TYPEREQ>
(Optional) The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<DESC>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;
Table 23-49 Output Parameter Support
<AID>
Access identifier from the "BITS" section.
<AIDTYPE>
(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Bits facility
•
Channel group
•
Client facility for MXP/TXP cards
•
DS3i-N-12 facility
•
E1 facility
•
E3 facility
•
E100 facility
•
E1000 facility
•
E4 facility
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port facility
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 facility
•
STM1E facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
TCC facility
•
VC11 path
•
VC12 path
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) Condition description. DESC is a string.
23.40 RTRV-COND-ENV
The Retrieve Environmental Condition (RETRV-COND-ENV) command retrieves the environmental conditions.
Usage Guidelines
None
Category
Environment
Security
Retrieve
Input Format
RTRV-COND-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>],[<LOCN>],
<DIRN>];Input Example
RTRV-COND-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;
Table 23-50 Input Parameter Support
<AID>
Access identifier from the "ENV" section.
<NTFCNCDE>
(Optional) Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<ALMTYPE>
(Optional) The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm type.
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48 V power supply failure
•
-139 V power converter
•
-190 V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>],
[<DESC>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,01-01,16-02-15,,,,\"OPEN DOOR\""
;
Table 23-51 Output Parameter Support
<AID>
Access identifier from the "ENV" section
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<ALMTYPE>
The alarm type for the environmental alarm. The parameter type is ENV_ALM, which is the environmental alarm type.
•
Air compressor failure
•
Air conditioning failure
•
Air dryer failure
•
Battery discharging
•
Battery failure
•
Cooling fan failure
•
Centralized power major failure
•
Centralized power minor failure
•
Engine failure
•
Engine operating
•
Standby engine transfer
•
Explosive gas
•
Fire detector failure
•
Fire
•
Flood
•
Fuel leak
•
Fuse failure
•
Explosive gas, toxic gas, ventilation fail or gas monitor fail
•
CEV hatch fail
•
Generator failure
•
High air flow
•
High humidity
•
High temperature
•
High water
•
Intrusion
•
Level converter
•
Secondary ADSL low voltage disconnect
•
Low voltage disconnect bypass
•
Low battery voltage
•
Low fuel
•
Low humidity
•
Low cable pressure
•
Low temperature
•
Low water
•
Miscellaneous
•
Open door
•
Commercial power failure
•
Pump failure
•
48 V power supply failure
•
-139 V power converter
•
-190 V power converter
•
Power supply major
•
Power supply minor
•
Rectifier failure
•
Rectifier high voltage
•
Rectifier low voltage
•
Ringing generator major
•
Ringing generator minor
•
AC or AC/rectifier power fail ADSL equipment
•
AC or AC/rectifier power fail DCL equipment critical site
•
AC or AC/rectifier power fail DCL equipment
•
Commercial AC fail, site equipped with standby engine
•
AC power loss distributed power RT bay
•
Retrieve standby engine, commercial AC restored
•
Smoke
•
High-low temperature
•
Toxic gas
•
T-repeater shelf
•
Ventilation system failure
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) Condition description. DESC is a string.
23.41 RTRV-COND-EQPT
The Retrieve Condition Equipment (RTRV-COND-EQPT) command retrieves the equipment conditions.
Usage Guidelines
None
Category
Equipment
Security
Retrieve
Input Format
RTRV-COND-EQPT:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-EQPT:TID:SLOT-1:229::LOS;
Table 23-52 Input Parameter Support
<AID>
Access identifier from the "EQPT" section of the entity for the entity that has an alarm condition.
<TYPEREQ>
(Optional) The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],[<OCRTM>],
[<LOCN>],[<DIRN>],[<DESC>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1,EQPT:CR,LOS,SA,01-01,16-02-15,NEND,RCV,\"LOS OF SIGNAL\""
;
Table 23-53 Output Parameter Support
<AID>
Access identifier from the "EQPT" section for the entity that has an alarm condition.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
BITS alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 alarm
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet port alarm
•
G1000 alarm
•
Gigabit Ethernet port alarm
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
ML-Series 100T eight port Gigabit Ethernet Card
•
CE-Series 100T eight port Gigabit Ethernet Card
•
CE-Series MR six port Gigabit Ethernet Card
•
CTX card
•
21 channel WEB card
•
63 channel WEB card
•
Filler Card
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
SYNCN alarm
•
TCC alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<TYPEREP>
The type of condition to be retrieved. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRECTION>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) Condition description. DESC is a string.
23.42 RTRV-COND-SYNCN
The Retrieve Condition Synchronization (RTRV-COND-SYNCN) command retrieves the synchronization condition.
Usage Guidelines
None
Category
Synchronization
Security
Retrieve
Input Format
RTRV-COND-SYNCN:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];
Input Example
RTRV-COND-SYNCN:TID:SYNC-NE:229::LOS;
Table 23-54 Input Parameter Support
<AID>
Access identifier from the "SYNC_REF" section for the entity that has an alarm condition.
<TYPEREQ>
The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<DESC>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:MJ,FRNGSYNC,SA,01-01,16-02-15,,,
\"FREE RUNNING SYNCHRONIZATION MODE\""
;
Table 23-55 Output Parameter Support
<AID>
Access identifier from the "SYN" section for the entity that has an alarm condition.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The value is always SYNCN. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
BITS alarm
•
Channel group
•
Client facility for MXP/TXP cards
•
Common alarm
•
DS3i-N-12 alarm
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 alarm
•
E100 alarm
•
E1000 alarm
•
E3 alarm
•
E4 alarm
•
ENV alarm
•
EQPT alarm
•
Fast Ethernet port alarm
•
ML-Series 100T eight port Gigabit Ethernet Card
•
CE-Series 100T eight port Gigabit Ethernet Card
•
CE-Series MR six port Gigabit Ethernet Card
•
CTX card
•
21 channel WEB card
•
63 channel WEB card
•
Filler Card
•
G1000 alarm
•
Gigabit Ethernet port alarm
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
SYNCN alarm
•
TCC alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<NTFCNCDE>
(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<TYPEREP>
The type of condition to be retrieved. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<SRVEFF>
(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.
•
The condition is non-service affecting.
•
The condition is service affecting.
<OCRDAT>
(Optional) Date when the specific event or violation occurred, MM-DD.
<OCRTM>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRN>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
<DESC>
(Optional) Condition description. DESC is a string.
23.43 RTRV-CONSOLE-PORT
The Retrieve Console Port (RTRV-CONSOLE-PORT) command retrieves the status of the console port from the ML-Series cards.
Usage Guidelines
None
Category
Security
Security
Retrieve
Input Format
RTRV-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-CONSOLE-PORT:CISCONODE:SLOT-2:123;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<EQPT>:PORT=<PORT>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2:PORT=ENABLED"
;
23.44 RTRV-COS-ETH
The Retrieve Cost of Service Ethernet (RTRV-COS-ETH) command retrieves the egress parameters of a CoS table associated to an L2 Ethernet port.
Usage Guidelines
None
Category
Ethernet
Security
Provisioning
Input Format
RTRV-COS-ETH:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-COS-ETH:TID:ETH-1-1-1:CTAG;
Input Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "LINEWL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[QOSENABLED=<QOSENABLED>],[BW0=<BWO>],
[WEIGHT0=<WEIGHT0>],[BW1=<BW1>],[WEIGHT1=<WEIGHT1>],[BW2=<BW2>],
[WEIGHT2=<WEIGHT2>],[BW3=<BW3>],[WEIGHT3=<WEIGHT3>],[BW4=<BW4>],
[WEIGHT4=<WEIGHT4>],[BW5=<BW5>],[WEIGHT5=<WEIGHT5>],[BW6=<BW6>],
[WEIGHT6=<WEIGHT6>],[BW7=<BW7>],[WEIGHT7=<WEIGHT7>][:]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-5-1-1::QOSENABLED=Y,BW0=10,WEIGHT0=0,BW1=20,WEIGHT1=2,BW2=40,
WEIGHT2=4,BW3=60,WEIGHT3=6,BW4=70,WEIGHT4=8,BW5=80,WEIGHT5=10,BW6=85,
WEIGHT6=12,BW7=100,WEIGHT7=15:"
;
Table 23-57 Output Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<QOSENABLED>
Used to enable or disable the egress quality of service (QoS) policy of an L2 Ethernet port.
•
Disable the service.
•
Enable the service.
<BW0>
Bandwidth percentage, a value between 0 and 100
<WEIGHT0>
Value represents the weighted round-robin (WRR) weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW1>
Bandwidth percentage, a value between 0 and 100
<WEIGHT1>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW2>
Bandwidth percentage, a value between 0 and 100
<WEIGHT2>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW3>
Bandwidth percentage, a value between 0 and 100
<WEIGHT3>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW4>
Bandwidth percentage, a value between 0 and 100
<WEIGHT4>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW5>
Bandwidth percentage, a value between 0 and 100
<WEIGHT5>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW6>
Bandwidth percentage, a value between 0 and 100
<WEIGHT6>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
<BW7>
Bandwidth percentage, a value between 0 and 100
<WEIGHT7>
Value represents the WRR weight associated to the CoS values. It is an integer value ranging between 0 and 15.
23.45 RTRV-CRS
The Retrieve Cross-Connect (RTRV-CRS) command retrieves all the cross-connections based on the required PATH types.
Usage Guidelines
•
•
•
•
•
•
Category
Cross Connections
Security
Retrieve
Input Format
RTRV-CRS:[<TID>]:[<AID>]:<CTAG>[:::CRSTYPE=<CRSTYPE>][:];
Input Example
RTRV-CRS:CISCO:ALL:123:::CRSTYPE=VC4;
Table 23-58 Input Parameter Support
<AID>
(Optional) Access identifier from the "CrossConnectId" section that can be EQPT, Facility, VC or ALL. The ALL AID defaults to NE, which means it reports all the existing cross-connections on the NE. A null value is equivalent to ALL.
<CRSTYPE>
(Optional) The cross-connection type. Defaults to all existing cross-connections. A null value is equivalent to ALL. The parameter type is PATH, which is the modifier for path commands.
•
Synchronous Transport Signal/Module Level-1 (51 Mbps)
•
Synchronous Transport Signal/Module Level-12 Concatenated (622 Mbps)
•
Synchronous Transport Signal/Module Level-18 Concatenated (933 Mbps)
•
Synchronous Transport Signal/Module Level-192 Concatenated (9952 Mbps)
•
Synchronous Transport Signal/Module Level-24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal/Module Signal Level-3 Concatenated (155 Mbps)
•
Synchronous Transport Signal/Module Level-48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal/Module level-6 (310 Mbps)
•
Synchronous Transport Signal/Module Level-9 Concatenated (465 Mbps)
•
Virtual Tributary 2. Virtual Channel 12
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<CCT>,<CRSTYPE>:[DRITYPE=<DRITYPE>],[DRINODE=<SYNCSW>],
[CKTID=<CKTID>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-5-1-2&VC4-6-1-2,VC4-12-1-2&VC4-13-1-2:1WAYDC,VC3:DRITYPE=MSSPR,
DRINODE=PRI,CKTID=CKTID:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-59 Output Parameter Support
<SRC>
Source access identifier from the "CrossConnectId" section. Indicates the source AID(s) of the cross-connection. SRC is listable.
<DST>
Destination AID of the cross-connection from the "CrossConnectId" section. DST is listable.
<CCT>
Type of connection. Used for specifying one or two-way connections. The parameter type is CCT, which is the type of cross-connect to be created.
•
A unidirectional connection from a source tributary to a destination tributary.
•
Subnetwork connection protection (SNCP) multicast drop (1-way continue)
•
SNCP multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries.
•
A bidirectional drop and continue connection applicable only to SNCP traditional and integrated DRIs.
•
A bidirectional connection between the two tributaries on the extra protection path/fiber.
•
Diagnostics cross-connect. Supports BERT (MS-SPRing PCA diagnostics cross-connect).
<CRSTYPE>
The cross-connection type. The parameter type is CRS_TYPE, which is the cross-connection type.
•
Indicates all the VC cross-connections.
•
VC3 cross-connect
•
VC4 cross-connect
•
VC42C cross-connect
•
VC43C cross-connect
•
VC44C cross-connect
•
VC46C cross-connect
•
VC48C cross-connect
•
VC412C cross-connect
•
VC416C cross-connect
•
VC464C cross-connect
•
VC12 cross-connect
<DRITYPE>
(Optional) The DRI connection type. It is applied only if the cross-connection is a drop-and-continue connection type (1WAYDC or 2WAYDC), and defaults to SNCP for the DRI configuration. The parameter type is DRITYPE (DRI type).
•
MS-SPRing DRI type
•
SNCP DRI type
•
SNCP-MS-SPRing hand off DRI type
<DRINODE>
(Optional) Synchronization switch AID from the "SYNCSW" section.
<CKTID>
(Optional) Circuit identification parameter that contains the a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. CKTID is a string.
<PSTPSTQ>
Primary state and primary state qualifier separated by a colon. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) One or more secondary states separated by &, in alphabetical order. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.46 RTRV-CRS-<PATH>
The Retrieve Cross-Connect for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC1 (RTRV-CRS-<PATH>) command retrieves any connections associated with the entered AID(s) or AID range. The information on both ends is returned along with the type of connection. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
The SNCP VC cross-connection can be retrieved by using "&" in the AID fields of this command.
•
from points: F1, F2
to points: T1
the output will be:
–
"F1&F2,T1:CCT,VC4"
–
If retrieved on point F1 or F2, the output format is the same as the 1-way output.
If retrieved on point T1, the output will be:
"T1,F1&F2:CCT,VC4"
•
from point: F1
to points: T1, T2
the output will be:
–
"F1,T1&T2:CCT,VC4"
–
"T1&T2,F1:CCT,VC4"
•
from point: F1, F2
to points: T1, T2
the output will be:
–
"F1&F2,T1&T2:CCT,VC4"
–
If retrieved on point F1 or F2, the output format is the same as the 1-way output.
If retrieved on point T1 or T2, the output will be:
"T1&T2,F1&F2:CCT,VC4"
•
ENT-CRS-<PATH>::F1&F2,S1&S2:<CTAG>::2WAY;
from points: F1, F2 (F1 is the working side, F2 is the protect side)
selector: S1, S2 (s1 is the working side, S2 is the protect side)
–
"F1&F2,S1&S2:CCT,VC4"
–
"S1&S2,F1&F2:CCT,VC4"
•
from points: F1, F2
to points: T1, T2
the output will be:
"F1&F2,T1&T2:CCT,VC4"
•
from points: F1, F2
to points: T1
the output will be:
"F1&F2,T1:CCT,VC4"
The following rules apply:
•
•
•
•
•
•
•
Category
Cross Connections
Security
Retrieve
Input Format
RTRV-CRS-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];
Input Example
RTRV-CRS-VC4:KENWOOD:VC4-6-1-1:223;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId1" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<CCT>,<MOD>:[DRITYPE=<DRITYPE>],[DRINODE=<DRINODE>],
[CKTID=<CKTID>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-5-1-2&VC4-6-1-2,VC4-12-1-2&VC4-13-1-2:1WAYDC,VC4:DRITYPE=MSSPR,
DRINODE=PRI,CKTID=CKTID:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-60 Output Parameter Support
<SRC>
Source access identifier from the "CrossConnectId" section. Indicates the source AID(s) of the cross-connection. SRC is listable.
<DST>
Destination AID of the cross-connection from the "CrossConnectId" section. DST is listable.
<CCT>
Type of connection. Used for specifying one or two-way connections. The parameter type is CCT, which is the type of cross-connect to be created.
•
A unidirectional connection from a source tributary to a destination tributary.
•
SNCP multicast drop (1-way continue)
•
SNCP multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber.
•
A bidirectional connection between the two tributaries.
•
A bidirectional drop and continue connection applicable only to SNCP traditional and integrated DRIs.
•
A bidirectional connection between the two tributaries on the extra protection path/fiber.
•
Diagnostics cross-connect. Supports BERT (MS-SPRing PCA diagnostics cross-connect).
<MOD>
The connection path bandwidth. The parameter type is MOD2, which is the line/path modifier.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
D1 video
•
DS3i-N-12 line
•
DV6000
•
E1
•
E3
•
E4 frame. Only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
•
ESCON
•
ETRCLO
•
FSTE facility
•
G1000 facility
•
Generic Framing Protocol over Packet Over NCS. Virtual ports partitioned using GFP's multiplexing capability
•
Gigabit Ethernet
•
HDTV
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
STM1 facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
Optical channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
POS port
•
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card.
•
VC3 path
•
VC4 path
•
VC42C path
•
VC43C path
•
VC44C path
•
VC46C path
•
VC48C path
•
VC412C path
•
VC416C path
•
VC464C path
•
VC11 path
•
VC12 path
<DRITYPE>
(Optional) The DRI connection type. It is applied only if the cross-connection is a drop-and-continue connection type (1WAYDC or 2WAYDC), and defaults to SNCP for the DRI configuration. The parameter type is DRITYPE (DRI type).
•
MS-SPRing DRI type
•
SNCP DRI type
•
SNCP-MS-SPRing hand off DRI type
<SYNCSW>
(Optional) Synchronization switch AID from the "SYNCSW" section.
<CKTID>
(Optional) A string of ASCII characters. Maximum length is 48. CKTID is a string.
<PSTPSTQ>
Primary state and primary state qualifier separated by a colon. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) One or more secondary states separated by &, in alphabetical order. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.47 RTRV-CRS-ETH
This command retrieve an Ethernet Connection between two or more ethernet connection end points within ethernet facilities.
Usage Guidelines
This command accept the ALL AID. Use one of the specified ethernet end points and the connection end point identifier associated in order to identify a cross-connection inside the node.
Category
ETHERNET
Security
Retrieve
Input Format
RTRV-CRS-ETH:[<TID>]:<aid>:<CTAG>[::::];
Input Example
RTRV-CRS-ETH:TID:ALL:CTAG;
RTRV-CRS-ETH:TID:ETH-5-1-1-ALL:CTAG;
RTRV-CRS-ETH:TID:ETH-1-1-1-11:CTAG;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<src>,<dst>:<ect>:[CKTID=<cktid>]:<pstPstq>,[<sstq>]";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-1-1-1-13,ETH-1-21-1-13Ð-1-22-1-13:2WAY:CKTID=ETHERNET:IS-NR";
Output Parameters
23.48 RTRV-DFLT-SECU
The Retrieve Default Security (RTRV-DFLT-SECU) command retrieves the system-wide default values associated with several security parameters.
Usage Guidelines
None
Category
Security
Security
Superuser
Input Format
RTRV-DFLT-SECU:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-DFLT-SECU:CISCO:ALL:123;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<NE>:PAGE=<PAGE>,PCND=<PCND>,MXINV=<MXINV>,DURAL=<DURAL>,TMOUT=<TMOUT>,UOUT=<UOUT>,PFRCD=<PFRCD>,POLD=<POLD>,PINT=<PINT>,LOGIN=<LOGIN>,[PRIVLVL=<PRIVLVL>],[PDIF=<PDIF>],[PWDCHRULE=<PWDCHRULE>],[PWDMINLEN=<PWDMINLEN>],[PWDMAXLEN=<PWDMAXLEN>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"TCC2:PAGE=40,PCND=5,MXINV=5,DURAL=30,TMOUT=0,UOUT=60,
PFRCD=NO,POLD=5,PINT=20,LOGIN=MULTIPLE,PRIVLVL=RTRV,PDIF=1"
;TID-000 1998-06-20 14:30:00
M 001 COMPLD
"107161:PAGE=0,PCND=0,MXINV=5,DURAL=30,TMOUT=0,UOUT=0,PFRCD=NO,POLD=1,PINT=0,LOGIN=MULTIPLE,PRIVLVL=RTRV,PDIF=1,PWDCHRULE=ANY_CHAR,PWDMINLEN=2,PWDMAXLEN=20"
;
23.49 RTRV-DS3I
The Retrieve DS3I (RTRV-DS3I) command retrieves the properties of a DS3i-N-12 facility.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-DS3I:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-DS3I:CISCO:FAC-1-1:1234;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::FMT=<FMT>,LINECDE=<LINECDE>,LBO=<LBO>,[INHFELPBK=<INHFELPBK>],
[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[SFBER=<SFBER>],[SDBER=<SDBER>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-2::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225,INHFELPBK=N,TACC=8,
TAPTYPE=DUAL,SFBER=1E-4,SDBER=1E-6,SOAK=10,SOAKLEFT=12-25,
NAME=\"DS3I PORT\":UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-63 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<FMT>
Digital signal format. The parameter type is DS_LINE_TYPE, which is the DS123 line type.
•
M13 line type.
•
Frame format is ESF.
•
Line type is unframed.
<LINECDE>
Line code. The parameter type is DS_LINE_CODE, which is the DS123 line code.
•
Bipolar with three-zero substitution
<LBO>
Line build out settings. LBO is an integer. The parameter type is E_LBO, which is the electrical signal line buildout.
•
Electrical signal line buildout range is 0-225.
•
Electrical signal line buildout range is 226-450.
<INHFELPBK>
(Optional) Far-end loopback inhibition attribute of the port. If it is Y, the automatic far-end loopbacks are inhibited. It is either on or off. The system default is N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<TACC>
(Optional) Indicates whether the digroup being provisioned is to be used as a test access digroup. Default is N. TACC is an integer.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<SFBER>
(Optional) Signal failure threshold. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) Signal degrade threshold. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are:
•
•
•
<NAME>
(Optional) Port name. NAME is a string.
<PSTPSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.50 RTRV-DSCP-<MOD2>
The RTRV-DSCP-<MOD2> command retrieves Differentiated Service Code Points (DSCP) to COS conversion table associated to a L2 ethernet port or a channel group.
Usage Guidelines
This command is applicable when the INGRESSCOS parameter is set to DSCP value on the ethernet port or channel group.
Category
Ethernet or Channel Group
Security
Retrieve
Input Format
RTRV-DSCP-MOD2:[<TID>]:<AID>:<CTAG>::[<COS>][::];
Input Example
RTRV-DSCP-ETH::ETH-5-1-1:1234;
RTRV-DSCP-CHGRP::CHGRP-1-1:1234::3;
Input Parameters
<AID>
Access identifier.
•
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
•
Access identifier from the "CHGRP" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"AID>:<COS>:[DSCPFIRST=<DSCP_FIRST>],[DSCPLAST=<DSCP_LAST>];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-5-1-1:0:DSCPFIRST=0,DSCPLAST=9:"
;TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHGRP-5-1-1:0:DSCPFIRST=0,DSCPLAST=9:"
;
Table 23-64 Output Parameter Support
<AID>
Access identifier.
•
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
•
Access identifier from the "CHGRP" section.
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Cos value
•
The COS set according to DSCP to COS mapping table.
•
The Customer COS
•
The COS provisioned on CVLAN basis (QinQ selective mode)
<DSCPFIRST>
DSCP range. Indicates a DSCP value used in the ethernet frame to define the QoS in L3 ethernet transport. It is a number in the range 0..64. Default values is 0
<DSCPLAST>
DSCP range. Indicates a DSCP value used in the ethernet frame to define the QoS in L3 ethernet transport. It is a number in the range 0..64. Default values is 0.
23.51 RTRV-E1
The Retrieve E1 (RTRV-E1) command retrieves the attributes of an E1 port facility.
Usage Guidelines
The ADMSSM, RETIME, SABIT, SYNCMSG, SENDDUS, and PROVIDESYNC parameters are only displayed on the DS1/E1-56 card.
Category
Ports
Security
Retrieve
Input Format
RTRV-E1:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-E1:TID:FAC-1-1:1234;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[<CLKSRC>],<FMT>,<LINECDE>,[<TACC>],[<TAPTYPE>],[<SFBER>],[<SDBER>],[<SOAK>],[<SOAKLEFT>],[<NAME>],[<SYNCMSG>],[<SENDDUS>],[<RETIME>],[<ADMSSM>],[<PROVIDESYNC>],[<AISONLPBK>]:[<SABIT>],[<PST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1::LINECDE=HDB3,FMT=E1-MF,TACC=8,TAPTYPE=DUAL,SFBER=1E-4,
SDBER=1E-6,SOAK=10,SOAKLEFT=12-25,NAME=\"E1PORT\",SYNCMSG=N,
SENDDUS=N,RETIME=N,ADMSSM=STU,PROVIDESYNC=N,
SABIT=BYTE-4:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-65 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section. The entity in the NE to which the command pertains.
<CLKSRC>
<CLKSRC>
•
INTERNAL
•
LOOPBACK TIMING
•
SYNCE
•
ADAPTIVE
<AISONLPBK>
Indicates if AIS should be sent back in loopback.
•
Facility
•
Terminal
•
Off
•
All
<LINECDE>
(Optional) Line code. Defaults to HDB3. The parameter type is LINE_CODE (line code). (Applicable only for NCS platform).
•
Line code value is AMI.
•
Binary three-zero substitution.
•
Line code value is B6ZS.
•
Line code value is B8ZS.
•
Line code value is HDB3. (Applicable only for NCS platform).
•
JBZS
•
ZBTSI
<FMT>
Digital signal frame format. Defaults to E1-MF. The parameter type is FRAME_FORMAT, which is the frame format for a E1 port.
•
AUTOPROV
•
C-BIT line type applies to the DS3XM and DS3E cards.
•
Frame format is D4
•
DS2 FRAMED
•
NCS E1 CRCMF frame format
•
NCS E1 MF frame
•
NCS E1 unframed format
•
E2 FRAMED
•
E3-FRAME
•
E3-PLCP
•
Frame format is ESF
•
FRAMENA
•
G-751
•
G-832
•
M13 line type applies to the DS3XM and DS3E cards.
•
M23
•
SYNTRAN
•
Frame format is unframed.
<TACC>
(Optional) TAP number within a range of 0 to 999. Indicates whether the digroup being provisioned is to be used as a test access digroup. When TACC is 0 (zero), the TAP is deleted. Default is N. TACC is an integer.
<TAPTYPE>
(Optional) TAP type. Defaults to DUAL. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<SFBER>
(Optional) Signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) Signal degrade threshold. Defaults to 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Defaults to 32. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are:
•
•
•
<NAME>
(Optional) NAME is a string. Defaults to NULL. Maximum length is 32 characters.
<SYNCMSG>
(Optional) The facility is enabled to provide the synchronization clock. This applies to an MXPD-10G card only if the payload is NCS and the card termination mode is as follows:
•
•
The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SENDDUS>
(Optional) The facility sends out a Do Not Use for Synchronization Message. This does not apply to the TXPD-10G card. This applies to an MXPD-10G card only if the payload is NCS and the card termination mode is as follows:
•
•
The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<RETIME>
(Optional) Indicates the RETIME function for all the facilities on this card. Applies only to the DS1/E1-56 card. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<ADMSSM>
(Optional) SSM selectable value. Only displayed when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
G811 Standard
•
Reserved For Network Synchronization Use
•
G812T Standard
•
Synchronized, Traceability Unknown
•
G812TL Standard
•
Synchronous Equipment Timing Source
<PROVIDESYNC>
(Optional) Indicates whether the facility provides synchronization. Defaults to N.
•
Yes
•
No
<AISONLPBK>
Indicate if AIS should be sent back in loopback.
•
Facility
•
Terminal
•
Off
•
All
<SABIT>
(Optional) When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. The parameter type is SABITS (SA BITS).
•
SABIT is BYTE-4.
•
SABIT is BYTE-5.
•
SABIT is BYTE-6.
•
SABIT is BYTE-7.
•
SABIT is BYTE-8.
<PSTPSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PSTPSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.52 RTRV-E3
The Retrieve E3 (RTRV-E3) command retrieves the attributes of an E3 port facility.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-E3:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-E3:TID:FAC-1-1:1234;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[<CLKSRC>],[<FMT>],[<LINECDE>],[<TACC>],[<TAPTYPE>],[<SFBER>],[<SDBER>],[<SOAK>],[<SOAKLEFT>],[<NAME>],[<AISONLPBK>]:<PST>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-2::TACC=8,TAPTYPE=SINGLE,SFBER=1E-4,SDBER=1E-6,SOAK=10,
SOAKLEFT=12-25,NAME=\"E3 PORT\":UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-66 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section. The entity in the NE to which the command pertains.
<CLKSRC>
<CLKSRC>
•
INTERNAL
•
LOOPBACK TIMING
•
SYNCE
•
ADAPTIVE
<FMT>
(Optional) Digital signal frame format. Defaults to E1-MF. The parameter type is FRAME_FORMAT, which is the frame format for an E1 port.
•
AUTOPROV
•
C-BIT line type applies to the DS3XM and DS3E cards.
•
DS2 FRAMED
•
E2 FRAMED
•
E3-FRAME
•
E3-PLCP
•
FRAMENA
•
G-751
•
G-832
•
M13 line type applies to the DS3XM and DS3E cards.
•
M23
•
SYNTRAN
<LINECDE>
(Optional) Line code. Defaults to HDB3. The parameter type is LINE_CODE (line code). (Applicable only for NCS platform).
•
Binary three-zero substitution.
•
B6ZS
•
JBZS
•
ZBTSI
<TACC>
(Optional) TAP number within a range of 0 to 999. Indicates whether the digroup being provisioned is to be used as a test access digroup. When TACC is 0 (zero), the TAP is deleted. Default is N. TACC is an integer.
<AISONLPBK>
Indicates if AIS should be sent back in loopback.
•
Facility
•
Terminal
•
Off
•
All
<TAPTYPE>
(Optional) TAP type. Defaults to DUAL. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<SFBER>
(Optional) Signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) Signal degrade threshold. Defaults to 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Defaults to 32. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are:
•
•
•
<NAME>
(Optional) Port Name. NAME is a string. Defaults to NULL. Maximum length is 32 characters.
<PSTPSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.53 RTRV-E4
The Retrieve E4 (RTRV-E4) command retrieves the attributes of an E4 port facility. RTRV-E4 only applies to Ports 9 and 12 of the STM1E card when in E4-FRAMED or E4-UNFRAMED mode.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-E4:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-E4:CISCO:FAC-6-9:8888;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[PAYLOAD=<PAYLOAD>],[SFBER=<SFBER>],[SDBER=<SDBER>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-9::PAYLOAD=E4-UNFRAMED,SFBER=1E-4,SDBER=1E-6,SOAK=10,
SOAKLEFT=12-25,NAME=\"E4 PORT\":Unlocked-Disabled,AutomaticInService"
;
Table 23-67 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section. The entity in the NE to which the command pertains.
<PAYLOAD>
(Optional) The payload for the card. The parameter type is PAYLOAD, which identifies payload type.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
ETR/CLO payload mode
•
Gigabit Ethernet payload
•
High-level data link control (HDLC) frame mode.
•
HDTV mode
•
ISC1 mode
•
ISC3 mode
•
Optical Transport Unit Level 4
•
NCS STM4 mode
•
NCS STM1 mode
•
NCS STM16 mode
•
Pass through mode
•
NCS payload mode
•
SDI-D1-Video mode
<SFBER>
(Optional) Signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) Signal degrade threshold. Defaults to 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. Defaults to 32. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are:
•
•
•
<NAME>
(Optional) Facility name. String. Defaults to NULL. Maximum length is 32 characters.
<PSTPSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.54 RTRV-EFM
The Retrieve Ethernet in the First Mile (RTRV-EFM) command retrieves the Ethernet in the First Mile (EFM) state on the port and EFM protocol parameters associated with that port.
Usage Guidelines
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-EFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-EFM::ETH-12-1-1:1;
Input Parameters
<AID>
Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"AID>:[STATE=<STATE>], [MODE=<MODE>],
[LFACTION=<LFACTION>],[DGACTION=<DGACTION>],[SESSIONTIMER=<SESSIONTIMER>],[EFMREMOTELPBK=<EFMREMOTELPBK>];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-7-1-1,STATE=DISABLE,MODE=ACTIVE,LFACTION=NONE,SESSIONTIMER=5,EFMREMOTELPBK=N:"
;
Table 23-68 Output Parameter Support
<AID>
Access identifier from the "ETH" section.
<STATE>
Indicates whether the EFM is enabled or disabled on the port.
•
Indicates the EFM is enabled on the port.
•
Indicates the EFM is disabled on the port.
<MODE>
Indicates the mode of the EFM port.
•
The port is in the active state.
•
The port is in the passive state.
<LFACTION>
Action to be taken for the failure of the link on the port.
•
No action.
•
Block the port.
<SESSIONTIMER>
Session expire timer for EFM (in seconds).
<EFMREMOTELPBK>
Indicates the EFM remote loopback state on the port.
•
Loopback is enabled on the remote port.
•
Loopback is disabled on the remote Port.
23.55 RTRV-T3
The Retrieve T3 (RTRV-T3) command retrieves the facility properties of a DS3 or a DS3XM card.
Usage Guidelines
•
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-T3:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-T3::T3-1-1:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[<CLKSRC>],[<FMT>],[<LINECDE>],[<LBO>],[<INHFELPBK>],[<TACC>],[<TAPTYPE>],[<SOAK>],[<SOAKLEFT>],[<SFBER>],[<SDBER>],[<NAME>],[<AISONLPBK>],[<BERTMODE>],[<BERTPATTERN>],[<BERTERRCOUNT>],[<BERTERRRATE>],[<BERTSYNCSTATUS>]:<PST>,[<SST>]"
;Output Example
ONS-MANCS 1970-01-02 20:33:28
M 1 COMPLD
"T3-1-1::FMT=UNFRAMED,LINECDE=B3ZS,LBO=226-450,INHFELPBK=Y,SOAK=32,SFBER=1E-4,SDBER=1E-7,AISONLPBK=ALL,:locked-enabled,disabled";
Table 23-69 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<CLKSRC>
<CLKSRC>
•
INTERNAL
•
LOOPBACK TIMING
•
SYNCE
•
ADAPTIVE
<FMT>
(Optional) Digital signal format. The parameter type is DS_LINE_TYPE, which is the DS123 line type.
•
AUTOPROV
•
C-BIT line type applies to the DS3XM and DS3E cards.
•
DS2 FRAMED
•
E2 FRAMED
•
E3-FRAME
•
E3-PLCP
•
FRAMENA
•
G-751
•
G-832
•
M13 line type applies to the DS3XM and DS3E cards.
•
M23
•
SYNTRAN
•
Frame format is unframed.
<LINECDE>
(Optional) Line code. The parameter type is DS_LINE_CODE, which is the DS123 line code.
•
Binary three-zero substitution.
•
B6ZS
•
JBZS
•
ZBTSI
<LBO>
(Optional) Line buildout settings. LBO is an integer. The parameter type is E_LBO, which is the electrical signal line buildout.
•
Electrical signal line buildout range is 0-225.
•
Electrical signal line buildout range is 226-450.
<INHFELPBK>
(Optional) Far-end loopback inhibition attribute of the port. If it is Y, the automatic far-end loopbacks are inhibited. It is either on or off. The system default is N. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<TAP>
(Optional) Defines the STS as a test access port with a selected unique TAP number. The TAP number is within a range of 0, 1 to 999. When TACC is 0 (zero), the TAP is deleted. Default is N.
<TAPTYPE>
(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
•
Dual FAD
•
Single FAD
<SOAK>
(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. SOAKLEFT is a string. Rules for <SOAKLEFT> are as follows:
•
•
•
<SFBER>
(Optional) The port signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) Port signal degrade threshold. Defaults to 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<NAME>
(Optional) Port name. NAME is a string.
<AISONLPBK>
(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates if AIS is sent on a loopback.
•
AIS is sent on facility loopbacks.
•
AIS is sent on all loopbacks.
•
AIS is not sent on loopbacks.
•
AIS is sent on terminal loopbacks.
Y
BERT synchronization status is up.
N
BERT synchronization status is down.
<PST>
(Optional) Primary state. Defaults to Unlocked. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In service
•
Out of service
<SST>
(Optional) Secondary state. Defaults to AutomaticInService. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.56 RTRV-EQPT
The Retrieve Equipment (RTRV-EQPT) command retrieves the data parameters and state parameters associated with a card or shelf. The command retrieves the card type, equipped state, and the state of that card. The command modifies the provision details of AR-MXP, AR-XP, and AR-XPE cards and its facilities.
Usage Guidelines
This command returns the PRTYPE, PROTID, RVTM, and RVRTV parameters for a card inside of a protection group according to the following scenarios:
•
•
•
•
•
•
•
The following action will return an error message:
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-EQPT:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-EQPT::SLOT-4:444;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<AIDTYPE>,<EQUIP>,, [<STATUS>]:[<CARDNAME>],: <PST>,[<SST>];
Output Example
M 321 COMPLD
"SLOT-1:TNC,EQUIP,,ACT:CARDNAME=TNC,:IS-NR,"
"SLOT-3:AR-XP,EQUIP,,STBY:CARDNAME=ROCCIA NERA 7,:OOS-AU,FLT"
"SLOT-4:AR-XP,UNEQUIP,,NA::OOS-AU,AINS&UEQ"
"SLOT-6:TXP-MR-10E,EQUIP,,STBY:CARDNAME=NCS-10E-L1-C 1529.55,CARDMODE=NCS-TRANS-SQUELCH,:IS-NR,"
"PPM-3-1:PPM-1,EQUIP,,NA:CARDNAME=SD-SDI/HD-SDI/SDI3G-TX-1310NM,:IS-NR,"
"PPM-3-5:PPM-1,UNEQUIP,,NA::OOS-AU,AINS&UEQ"
"PPM-3-6:PPM-1,UNEQUIP,,NA::OOS-AU,AINS&UEQ"
"PPM-3-7:PPM-1,EQUIP,,NA:CARDNAME=ESCON/ETR-CLO-1310NM,:IS-NR,"
;
Table 23-70 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<AIDTYPE>
The type of facility, link or other addressable entity targeted by the message. The parameter type is EQUIPMENT-TYPE (equipment type).
•
2 x 10 Gbps. muxponder/L2 ethernet switch card
•
Edge 4-Ch Bi-Directional OADM Module 1530.33 to 1532.68.
•
Edge 4-Ch Bi-Directional OADM Module 1533.47 to 1535.82.
•
Edge 4-Ch Bi-Directional OADM Module 1536.61 to 1538.98.
•
Edge 4-Ch Bi-Directional OADM Module 1539.77 to 1542.14.
•
Edge 4-Ch Bi-Directional OADM Module 1542.94 to 1545.32.
•
Edge 4-Ch Bi-Directional OADM Module 1546.12 to 1548.51.
•
Edge 4-Ch Bi-Directional OADM Module 1549.32 to 1551.72.
•
Edge 4-Ch Bi-Directional OADM Module 1552.52 to 1554.94.
•
Edge 4-Ch Bi-Directional OADM Module 1555.75 to 1558.17.
•
Edge 4-Ch Bi-Directional OADM Module 1558.98 to 1561.42.
•
32 channel optical demultiplexer
•
32 channel optical demultiplexer for L-band
•
32 channel unidirectional optical multiplexer
This overrides the old equipment type MUX-32 present in the 4.6 and earlier releases.•
32 channel optical wavelength selective switch for C Band
•
40 channel optical demultiplexer for C Band
•
40 channel optical multiplexer for C Band
•
40 channel optical wavelength switch selector for C Band
•
40 channel optical wavelength cross-connect/wavelength router for C Band
•
Optical add/drop multiplexed (OADM) 1 band filter
•
Optical add/drop multiplexed (OADM) 1 channel filter
•
Optical add/drop multiplexed (OADM) 2 channels filter
•
Optical add/drop multiplexed (OADM) 4 bands filter
•
Optical add/drop multiplexed (OADM) 4 channels filter
•
16 x OC3/OC12/OC48/GIGE and OC192/Trunk ADM 10 Gbps card
•
AIC card
•
AICI Card
•
Any service any port (ASAP) carrier card with four PIM slots
•
Modena mapper card
•
Exige/Elise mapper card
•
Lotus20g ce2 card
•
Cross connect card
•
DS1-E1-56 card
•
DS1I card
•
DS3I card
•
DS3IN card
•
42 port E1 card
•
E1000T card
•
E100T card
•
E3 card
•
FC-MR-4 card
•
Blank filler card
•
A 4-port G1000 card
•
20 x 1 Gbps muxponder/L2 ethernet switch card
•
Four channel optical multiplexer/demultiplexer
•
Exige/Elise mapper card
•
Daytona 2-port GigE
•
Daytona 12-port FSTE
•
8-port 100T card with optical interface
•
Humvee - 12-port multirate optical card
•
4-port MRC 2.5G
•
12-port MRC 2.5G
•
Monviso 10G (4 * 2.5G) muxponder card with enhanced FEC
•
Cengalo 10G (4 * 2.5G) muxponder with enhanced FEC card
•
Skane 10G (4 * 2.5G) muxponder card
•
Bernina multirate 2.5G muxponder unprotected
•
Bernina multirate 2.5G muxponder protected
•
Multirate 10Gbps datamux
•
Multirate 10Gbps datamux with enhanced dispersion
•
ML-MR-10 card
•
4-port OC192 card
•
Leatherneck: 4-port OC192 card with tunable laser for C band
•
Optical booster/pre-amplifier for C band 17 dBm
•
Optical booster/pre-amplifier for C band 23 dBm
•
Optical booster/pre-amplifier for L band
•
Optical booster/pre-amplifier for C band
•
Optical booster amplifier
•
Optical booster enhanced amplifier for C band
•
Optical booster amplifier for L band
•
MAL-less EDFA Optical Amplifier - C-band - 17dB Gain
•
MAL-less EDFA Optical Amplifier - C-band - 24dB Gain
•
Optical pre-amplifier
•
Optical service channel (OSC) with combiner/separator module (SCM)
•
Optical service channel (OSC) module
•
1-port pluggable interface module
•
4-port pluggable interface module
•
Pluggable port module with one SFP port
•
Line card.
•
Fabric card.
•
CPT 50 panel
•
PTSYS Fan-Out-Group.
•
STM1E-12 card
•
TCC card
•
Skane 10G multirate transponder card with enhanced FEC
•
Skane 10G multirate transponder card
•
Rockwell multirate 2.5G unprotected
•
Rockwell multirate 2.5G protected
•
XC card
•
XC10G card
•
XCVT card
•
XCVXC-10G card
•
XCVXC-2.5G card
•
XCVXL-10G card
•
XCVXL-2.5G card
<EQUIP>
Indicates if the equipment is physically present. The parameter type is EQUIP, which is the presence of a plug-in unit.
•
The unit is equipped—present.
•
The unit is unequipped—absent.
<ROLE>
Identifies the port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) Indicates a status. NCS card status is shown on its card level. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit on the shelf.
•
(Optional) Protection group name. PROTID is a string.
<PRTYPE>
Identifies the protection group type values.
•
1 to 1 protection
•
1 to N protection
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Only applies to SNCP. The parameter type is ON_OFF, which disables or enables an attribute.
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. RVTM is not allowed to be set while RVRTV is N. Only applies to SNCP. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<CARDNAME>
(Optional) Contains the manufacturing name of the card when it is different from the EQUIPMENT_TYPE.
<IOSCFG>
(Optional) Displays the information about startup IOS config file for the ML series card. A example of this field is "TL1,11.22.33.44//DIR/IOS.CONF,2002/1/1 9:1:1 EST". The following information is included in this field: 1) Where the config file is from: TL1, or CTC/CTM/CLI/TCC; 2) The host (IP address)/directory/file name, if the config file is downloaded from the network; 3) When the startup config file is created (by copying from the network, for example). This field only applies to ML series card. IOSCFG is a string.
<CARDMODE>
(Optional) Card mode. The parameter type is CARDMODE (card mode). Card mode is applicable to cards that have multiple capabilities, for example, the ML-Series card can operate in two distinct modes: Linear Mapper mode and L2/L3 mode.
•
Changes the card mode from LAN to WAN.
•
The optical amplifier is working as an optical booster.
•
The optical amplifier is working as an optical preamplifier.
•
CE-MR-10 cards supports auto-allocation of back-end channels.
•
CE-MR-10 cards supports manual-allocation of back-end channels.
•
Lotus20g ce2 card
•
Lotus20g ce2 card
•
DS1 mode on DS1/E1 card
•
E1 mode on DS1/E1 card
•
Line terminating mode
•
Section terminating mode
•
Transparent mode AIS
•
Transparent mode SQUELCH
•
FC_MR-4 card with distance extension support
•
FC_MR-4 card without distance extension support
•
ML-Series card in DOS FPGA using GFP framing type
•
ML-Series card in DOS FPGA using HDLC framing type
•
ML-Series card in DOS FPGA which supports Resilient Packet Ring (RPR).
•
4-Gbps Fibre Channel/FICON mode for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 1 and 5
•
4-Gbps Fibre Channel/FICON supported on port one and Fibre Channel, GIGE and ISC modes for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 5 to 8
•
Fibre Channel, GIGE, and ISC modes for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on all eight ports
•
Fibre Channel, GIGE, and ISC modes for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 1 to 4 and 4 Gbps Fibre Channel/FICON supported on Port 5
•
Fibre Channel, GIGE, and ISC modes for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on all eight ports
•
4-Gbps Fibre Channel/FICON mode for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 1 and 5
•
Fibre Channel, GIGE, and ISC modes for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 1 to 4 and 4-Gbps Fibre Channel/FICON supported on Port 5
•
4-Gbps Fibre Channel/FICON supported on Port 1 and Fibre Channel, GIGE and ISC modes for the MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 5 to 8
•
ESCON mode for the MXP_2.5G_10G card
•
Fibre channel or GIGE mode for the MXP_2.5G_10G card
•
Mixed Fibre Channel, GIGE and ESCON modes for the MXP_2.5G_10G card
•
PSM working in classic configuration.
•
PSM working in stand-alone mode.
•
80-WXC-C working in bidirectional mode.
•
80-WXC-C working as demultiplexer.
•
80-WXC-C working as multiplexer.
•
40G-MXP-MUXPONDER working as multiplexer.
•
40G-MXP-UNIDIR-REGEN working as regenerator.
<PEERID>
Indicates the peer trunk facility of the regeneration group on the OTU2-XP card. Accessed using the CHAN AID.
<REGENNAME>
Indicates the name of a regeneration group. Applicable only to NCS flavored cards, which support regeneration group. Regenname is a string. The default value is "NULL".
<PEERNAME>
Indicates the name of a peer group.
<TRANSMODE>
Transition Mode.
•
Au3 mode.
•
Au4 mode.
•
Sonnet mode.
<RETIME>
(Optional) Indicates the RETIME function for all the facilities on this card. Applies only to the DS1/E1-56 card. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SHELFROLE>
The role of the shelf in the context of the node. When it is omitted it defaults to SC. The parameter is SHELF_ROLE.
<FRPROLE>
Indicates the fast ring protection enable mode for GE-XP/10GE-XP units involved in a protection scheme.
•
Role is of card master of the ring.
•
Role is of card slave of the ring.
<FRPSTATE>
Indicates the fast ring protection enable state.
•
Disabled protection
•
Enabled protection
•
Forced protection
<FRPHOLDOFFTIME>
Indicates the hold off timer value. The protection do not start until the hold off expire.
•
Indicates the hold off timer value as 100 milliseconds.
•
Indicates the hold off timer value as 1milisecond.
•
Indicates the hold off timer value as 200 milliseconds.
•
Indicates the hold off timer value as 2 milliseconds.
•
Indicates the hold off timer value as 500 milliseconds.
•
Indicates the hold off timer value as 50 milliseconds.
•
Indicates the hold off timer value as 50 milliseconds.
•
Indicates that the hold off timer is disabled.
<ADMINCVLAN>
Customer VLAN identifier for REP. ADMINCVLAN is a number between 1 and 4096. The value 0 is reserved to untagged VLAN.
<ADMINSVLAN
>
Service provider VLAN identifier for REP. ADMINSVLAN is a number between 1 and 4096. The value 0 is reserved to untagged VLAN.
<CFMSTATE>
Link Integrity status.
•
Enabled
•
Disabled
<CCTIMER>
Indicates continuity check message timer.
•
1 minute.
•
1 second.
•
10 seconds.
<PROTOPMODE>
PROTOPMODE
<SWITCHWITHCRCALARM>
Switch the GZ card with CRC Alarms
<CRCTHR>
CRC threshold values beyond which alarms are raised. The available threshold values are 10E-2, 10E-3, and 10E-4.
<CRCPOLLINTRVL>
Interval of time after which the polling starts.
<CRCSOAKCNT>
Number of poll cycles during which defect is integrated. The value ranges from 3 to 10.
<USB>
Identifies the USB Port where a passive unit is connected.
<CLOCKTYPE>
The parameter type is CLOCKTYPE. Sets the lock type.
•
Clock type set to INTERNAL.
•
Clock type set to TNC.
<PST>
(Optional) Primary state of the entity. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In Service
•
Out of Service
<SST>
Secondary state of the entity. SST is listable. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.57 RTRV-ESCON
The Retrieve Enterprise System Connection (RTRV-ESCON) command retrieves the Fibre Channel-specific settings for ports that have been configured to carry ESCON traffic using the ENT-ESCON command.
Usage Guidelines
The MXPP_MR_2.5G card only supports GFP-T frame type.
Category
NCS
Security
Retrieve
Input Format
RTRV-ESCON:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-ESCON::CISCO:FAC-1-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[ENCAP=<ENCAP>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1:,,WORK,ACT:ENCAP=GFP-T"
;
Table 23-71 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
(Optional) Port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
GFP Frame mode
•
GFP Transparent mode
•
HDLC Frame mode
•
HDLC LAN Extension Frame mode
•
HDLC X.86 Frame mode
23.58 RTRV-ETH
The Retrieve Ethernet (RTRV-ETH) command retrieves the front-end port information of an Ethernet card.
Usage Guidelines
This command retrieves the front-end port information of (10/100/1000 Mbps) ethernet cards. RTRV-POS will display the MTU, which is common for front and backend ports.
SELECTIVEAUTO parameter is applicable only when EXPSPEED and EXPDUPLEX is not set to AUTO mode.
Note
Category
Ethernet
Security
Provisioning
Input Format
RTRV-ETH:[<TID>]:<aid>:<CTAG>[:::];
Input Example
RTRV-ETH:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LINKSTATE=<LINKSTATE>],[FLOWCTRL=<FLOWCTRL>],[DUPLEX=<DUPLEX>],
[SPEED=<SPEED>],[FLOW=<FLOW>],[EXPDUPLEX=<EXPDUPLEX>],
[EXPSPEED=<EXPSPEED>],[VLANCOS=<VLANCOS>],[IPTOS=<IPTOS>],
[OPTICS=<OPTICS>],[NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],
[SELECTIVEAUTO=<SELECTIVEAUTO>],[LIENABLE=<LIENABLE>],[LITIMER=<LITIMER>]:<PST_PSTQ>,[<SSTQ>]";Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::ADMINSTATE=DOWN,LINKSTATE=DOWN,FLOWCTRL=SYMMETRIC, DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,EXPDUPLEX=EXPDUPLEX,
EXPSPEED=EXPSPEED,VLANCOS=VLANCOS,IPTOS=IPTOS,OPTICS=1000-BASE-LX,
NAME=\"ETH PORT\",SOAK=32,SOAKLEFT=\"12-25\", SELECTIVEAUTO=N,LIENABLE=Y,LITIMER=200:OOS-AU,
AINS";
Table 23-72 Output Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section
<ADMINSTATE>
(Optional) Administration type. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<LINKSTATE>
Link state. The parameter type is UP_DOWN, which indicates an up or down value.
•
Down
•
Up
<MTU>
(Optional) Maximum transmission unit. MTU is an integer.
<FLOWCTRL>
Flow control. The parameter is FLOW, which indicates the type of flow control that has been negotiated for an Ethernet port. Defaults to NONE.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Pass-through flow control
•
Symmetric flow control
<OPTICS>
(Optional) Optics. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000BaseCX
•
1000BaseLX
•
1000BaseSX
•
1000BaseT
•
1000BaseZX
•
100BaseBX_D
•
100BaseBX_U
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
<DUPLEX>
The parameter is ETHER_DUPLEX, which indicates duplex mode. Defaults to AUTO.
•
Auto mode
•
Full mode
•
Half mode
<SPEED>
The parameter type is ETHER_SPEED, which indicates Ethernet speed. Defaults to AUTO.
•
100 Megabits per seconds
•
10 Gigabits per second
•
10 Megabits per second
•
1 Gigabit per second
•
40 Gigabit per second
•
Automatic
•
Enable auto negotiation with full duplex.
<FLOW>
(Optional) Flow. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<EXPDUPLEX>
(Optional) Ethernet duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<EXPSPEED>
(Optional) Expected speed. Due to the auto-negotiation feature, actual speed may differ from expected speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Megabits per second
•
10 Gigabits per second
•
10 Megabits per second
•
1 Gigabit per second
•
Auto
<SELECTIVEAUTO>
(Optional) Selective auto-negotiation. The parameter is Y or N (enable or disable auto-negotiation) This indicates selective auto-negotiation of EXPSPEED and EXPDUPLEX only.
•
Enable selective auto-negotiation.
•
Disable selective auto-negotiation. The default value is N.
<VLANCOS>
(Optional) Priority queueing threshold based on VLAN class of service for incoming Ethernet packets. VLANCOS is an integer.
<IPTOS>
(Optional) Priority queing threshold based on IP type of service for incoming Ethernet packets. IPTOS is an integer.
<NAME>
(Optional) Facility name. NAME is a string.
<SOAK>
(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows:
•
•
•
<LIENABLE>
(Optional) Enable or Disable link integrity timer. Takes either Y or N. Value Y enables the LITIMER and value N disables LITIMER.
By default LITIMER is enabled.
<LITIMER>
(Optional) Link integrity timer duration in the range between 200 ms and 10000 ms in multiples on 100 ms.
<PSTPSTQ>
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. the parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.59 RTRV-EXT-CONT
The Retrieve External Control (RTRV-EXT-CONT) command retrieves the control state of an external control. The command can be used to audit the result of an OPR-EXT-CONT or RLS-EXT-CONT command.
Usage Guidelines
•
•
Category
Environment
Security
Retrieve
Input Format
RTRV-EXT-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];
Input Example
RTRV-EXT-CONT:CISCO:ENV-OUT-2:123::AIRCOND;
Table 23-73 Input Parameter Support
<AID>
Access identifier from the "ENV" section. The only valid AID for RTRV-EXT-CONT is ENV-OUT-{1-2}.
<CONTTYPE>
(Optional) Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[<CONTTYPE>],<DUR>,[<CONTSTATE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-OUT-2:AIRCOND,CONTS,OPEN"
;
Table 23-74 Output Parameter Support
<AID>
Access identifier from the "ENV" section. Identifies the external control for which the control state is being retrieved.
<CONTTYPE>
(Optional) Environmental control type. The parameter type is CONTTYPE, which is the environmental control type.
•
Air conditioning
•
Engine
•
Fan
•
Generator
•
Heat
•
Light
•
Miscellaneous
•
Sprinkler
<DUR>
Duration of operation. The duration for which the external control can be operated. The parameter type is Duration (duration).
•
Continuous duration
<CONTSTATE>
(Optional) Control state of the external control. The parameter type is CONT_MODE, which is the current state of the environmental control.
•
Not applicable.
•
The environmental control state is CLOSE.
•
The environmental control state is OPEN.
23.60 RTRV-FAC
The Retrieve Facility (RTRV-FAC) command retrieves the payload type of the facility. It can also dump all the facilities on a given card and is applicable to all cards.
Note
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-FAC:[<TID>]:<SRC>:<CTAG>[::::];
Input Example
RTRV-FAC:CISCO:FAC-2-9:2223;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>::PAYLOAD=<PAYLOAD>:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-9::PAYLOAD=E4-FRAMED:UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-75 Output Parameter Support
<SRC>
Source access identifier from the "FACILITY" section.
<PAYLOAD>
(Optional) Payload type of the facility. The parameter type is PAYLOAD, which identifies payload type.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Auto
•
Video mode
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E4-FRAMED payload mode for NCS STM1E-12 card
•
E4-UNFRAMED payload mode for NCS STM1E-12 card
•
ESCON mode
•
ETR/CLO payload mode
•
FSTE payload
•
Gigabit Ethernet Payload
•
High-level data link control (HDLC) frame mode.
•
HDTV mode
•
ISC1 mode
•
ISC3 mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
NCS STM4 mode
•
NCS STM1 mode
•
NCS STM16 mode
•
NCS STM256 mode
•
Pass through mode
•
NCS Payload mode
•
SDI-D1-Video mode
•
270M SDI video payload.
<PSTPSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state. SSTQ is a string.
23.61 RTRV-FFP
The Retrieve Facility Protection Group (RTRV-FFP) command retrieves all optical 1+1 protection groups.
Usage Guidelines
None
Category
Protection
Security
Retrieve
Input Format
RTRV-FFP:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-FFP:HERNDON:FAC-1-1:1;
Input Parameters
<AID>
Optical facility access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>:<LEVEL>:[PROTID=<PROTID>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>],
[DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1:STM16:PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,PSDIRN=BI,
VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;
Table 23-76 Output Parameter Support
<WORK>
The working port access identifier from the "FACILITY" section.
<PROTECT>
The protected port access identifier from the "FACILITY" section.
<LEVEL>
Optical rate the protection group was defined against. The parameter type is STM_TYPE, which is the modifier used to differentiate various levels of STM.
•
Optical Carrier Level 12 (622 Mbps)
•
Optical Carrier Level 192 (10 Gbps)
•
Optical Carrier Level 3 (155 Mbps)
•
Optical Carrier Level 48 (2.4 Gbps)
<PROTID>
(Optional) Protection group name. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N, non-revertive.
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
<VRGRDTM>
(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
•
500 ms
•
1 second
<DTGRDTM>
(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
<RCGRDTM>
(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
<OPOTYPE>
(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
•
Optimized 1+1
•
Standard 1+1
23.62 RTRV-FFP-<MOD2NCSPAYLOAD>
The Retrieve Facility Protection Group for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 5GIB, 8GFC, D1VIDEO, DV6000, DVBASI, ETRCLO, FSTE, GIGE, HDTV, ISC1, ISC3, OTU2, OTU3, PASSTHRU, OTU1, OTU4, ISC3STP1G, or ISC3STP2G (RTRV-FFP-<MOD2NCSPAYLOAD>) command retrieves the values facility protection that exists on that port.
Usage Guidelines
The command does not support 3GVIDEO, SDSDI, HDSDI, and AUTO payloads on AR-MXP, AR-XP, and AR-XPE cards.
Category
Performance
Security
Retrieve
Input Format
RTRV-FFP-<MOD2NCSPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];
Input Example
RTRV-FFP-GIGE:CISCO:VFAC-3-1-1:1;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
Output Format
SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>], [<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-1-1-1,VFAC-2-1-1::PROTTYPE=Y-CABLE,PROTID=\"DC-METRO\", RVRTV=N,RVTM=1.0,PSDIRN=BI"
;
Table 23-77 Output Parameter Support
<AIDUNIONID>
Access identifier from the "FACILITY" section.
<AIDUNIONID1>
Access identifier from the "FACILITY" section.
<PROTTYPE>
(Optional) The type of facility protection. The parameter type is PROTTYPE, which is the protection type for NCS client facilities.
•
Y-cable protection for the client ports on TXP_MR_10G, MXP_2.5G_10G, TXP_MR_2.5G, and TXPP_MR_2.5G cards.
<PROTID>
(Optional) Y-cable protection group identifier. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
23.63 RTRV-FFP-<STM_TYPE>
The Retrieve Facility Protection Group for STM1, STM4, STM16, and STM64 (RTRV-FFP-<STM_TYPE>) command retrieves the optical facility protection information. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Protection
Security
Retrieve
Input Format
RTRV-FFP-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-FFP-STM1:PETALUMA:FAC-1-1:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTID=<PROTID>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],
[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>],[DTGRDTM=<DTGRDTM>],
[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1::PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,PSDIRN=BI,
VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;
Table 23-78 Output Parameter Support
<WORK>
Access identifier from the "FACILITY" section. Identifies the working port.
<PROTECT>
Access identifier from the "FACILITY" section. Identifies the protection port.
<PROTID>
(Optional) Free form text string name given to the 1+1 protection group. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME (revertive time)
•
Revertive time is 0.5 to 12.0 minutes
<PSDIRN>
(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
<VRGRDTM>
(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
•
500 ms
•
1 second
<DTGRDTM>
(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
<RCGRDTM>
(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
<OPOTYPE>
(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
•
Optimized 1+1
•
Standard 1+1
23.64 RTRV-FFP-<OCN_TYPE>
The Retrieve Facility Protection Group for OC3, OC12, OC48, OC192, or OC768 (RTRV-FFP-<OCN_TYPE>) command retrieves the optical facility protection information.
Usage Guidelines
See Table 29-1 for supported modifiers by platform.
Category
Protection
Security
Retrieve
Input Format
RTRV-FFP-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-FFP-OC3:PETALUMA:OC3-1-1:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>],
[DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,FAC-1-1::PROTTYPE=Y-CABLE,PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,
PSDIRN=BI,VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED"
;Output Parameters
<WORK>
Access identifier from the "FACILITY" section. Identifies the working port.
<PROTECT>
Access identifier from the "FACILITY" section. Identifies the protection port.
<PROTTYPE>
(Optional) Protection group type. Applicable only to DWDM cards. The parameter type is PROTTYPE, which is the protection type for DWDM client facilities.
•
Y-cable protection for the client ports on TXP_MR_10G, MXP_2.5G_10G, TXP_MR_2.5G, and TXPP_MR_2.5G cards.
<PROTID>
(Optional) Free-form text string name given to the 1+1 protection group. PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N, non-revertive.
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
<VRGRDTM>
(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
•
500 ms
•
1 second
<DTGRDTM>
(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
<RCGRDTM>
(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
•
0 seconds
•
50 ms
•
100 ms
•
500 ms
•
1 second
•
2 seconds
•
3 seconds
•
4 seconds
•
5 seconds
•
6 seconds
•
7 seconds
•
8 seconds
•
9 seconds
•
10 seconds
<OPOTYPE>
(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
•
Optimized 1+1
•
Standard 1+1
23.65 RTRV-FFP-OCH
The Retrieve Facility Protection Group Optical Channel (RTRV-FFP-OCH) command retrieves the protection group information for the TXP_MR_2.5G and the TXPP_MR_2.5G card trunk ports.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-FFP-OCH:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-FFP-OCH:VA454-22:CHAN-2-2:100;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,CHAN-2-3::PROTTYPE=SPLITTER,PROTID=\"TRUNK PROT\",RVRTV=Y,
RVTM=1.0,PSDIRN=UNI"
;
Table 23-79 Output Parameter Support
<WORK>
The working port access identifier from the "CHANNEL" section.
<PROTECT>
The protected port access identifier from the "CHANNEL" section.
<PROTTYPE>
(Optional) Protection group type, PROTTYPE is a string.
<PROTID>
(Optional) Protection group name, PROTID is a string.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
23.66 RTRV-FFP-OTS
The Retrieve Facility Protection Group OTS (RTRV-FFP-OTS) command retrieves the protection group information for the TXP_MR_2.5G and TXPP_MR_2.5G card trunk port and OTU2-XP and optical protection switching unit.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-FFP-OTS:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-FFP-OTS:VA454-22:CHAN-2-2:100;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>,[,PSDIRN=<PSDIRN>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,CHAN-2-3::PROTTYPE=SPLITTER,PROTID=\"TRUNK PROT\",RVRTV=Y,
RVTM=1.0,PSDIRN=UNI"
;Output Parameters
<WORK>
The working port access identifier from the "CHANNEL" section.
<PROTECT>
The protected port access identifier from the "CHANNEL" section.
<PROTTYPE>
Protection type for NCS Client facilities
Y-CABLE
Y-Cable Protection for the Client Ports on Skane and Rockwell cards
SPLITTER
Splitter Protection for the Trunk Ports on Rockwell/Cengalo TXP, Bernina MXP Protected cards, Optical Protection Unit card and the OTU2-XP card.
<PROTID>
is the protecting card slot number of the protection group. Applicable only to Electrical cards which support 1-1 and/or 1-N. protid is the AID PRSLOT.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
•
Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>
(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
•
Bidirectional protection switching
•
Unidirectional protection switching
23.67 RTRV-FOG
The Retrieve Fan-Out-Group (ENT-FOG) command retrieves Fan-Out-Groups.
Usage Guidelines
•
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-FOG:[<TID>]:<AID>:<CTAG>;
Input Examples
RTRV-FOG::ALL:1;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[PTSYSID=<PTSYSID>],[FOGID=<FOGID>],[FOMEM=<FOMEM>],
[<PEERMEM=<PEERMEM>],[STATE=<STATE>],[QUEUEMODE=<QUEUEMODE>],[PBNAME=<PBNAME>]";Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FOG-1-36:PTSYSID=1,FOGID=36,FOMEM=FAC-2-2-1,STATE=UNKNOWN"
23.68 RTRV-FSTE
The Retrieve Fast Ethernet (RTRV-FSTE) command retrieves the front end port information of the 10/100 Mbps Fast Ethernet card.
Usage Guidelines
This command retrieves the front-end port information of fast (10/100 Mbps) ethernet cards. MTU is not displayed for Elise and Exige. RTRV-POS will display the MTU, which is common for front and backend ports.
SELECTIVEAUTO parameter is applicable only when EXPSPEED and EXPDUPLEX is not set to AUTO mode.
Category
Ports
Security
Retrieve
Input Format
RTRV-FSTE:[<TID>]:<AID:<CTAG>;
Input Example
RTRV-FSTE:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME M CTAG COMPLD "<AID>:[<ROLE>],[<STATUS>]:[<ADMINSTATE>],[<LINKSTATE>],[<MTU>],[<FLOWCTRL>],[ <OPTICS>],[<DUPLEX>],[<SPEED>],[<FLOW>],[<EXPDUPLEX>],[<EXPSPEED>],[<VLANCOS THRESHOLD>],[<IPTOSTHRESHOLD>],[<NAME>],[<SUPPRESS>],[<SOAK>],[<SOAKLEFT>], [<SELECTIVEAUTO>],[<LIENABLE>],[<LITIMER>],[<LBCL>],[<OPT>],[<OPR>],[<FREQ>],[< LOSSB>],[<ACTFLOW>],[<ACTDUPLEX>],[<ACTSPEED>],[<CIR>],[<CBS>],[<EBS>],[<OSC>],[SQUELCHMODE=<SQUELCHMODE>]:<PST>,[<SST>]"
;
Output Example
TCC2 2002-02-07 05:37:40
M 1 COMPLD
"VFAC-4-1-1:WORK,STBY:MTU=9700,DUPLEX=FULL,SPEED=100_MBPS,SOAK=32,FREQ=USE-TWL1,LOSSB=AUTOPROV,AUTONEG=Y,SQUELCHMODE=SQUELCH:OOS-MA,DSBLD"
;
Table 23-81 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
Identifies the port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
<STATUS>
Identifies a port status in a Y-cable protection scheme. The parameter type is STATUS, which is the status of the unit in the protection pair.
<ADMINSTATE>
(Optional) Administration type. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<LINKSTATE>
(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<MTU>
(Optional) Maximum transmission unit. MTU is an integer.
<FLOWCTRL>
(Optional) Flow control. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Passthrough flow control
•
Symmetric flow control
<OPTICS>
(Optional) Optics. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000BaseCX
•
1000BaseLX
•
1000BaseSX
•
1000BaseT
•
1000BaseZX
•
100BaseBX_D
•
100BaseBX_U
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1529.16
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
<DUPLEX>
(Optional) Duplex mode. The parameter type is ETHER_DUPLEX (duplex mode).
•
Auto mode
•
Full mode
•
Half mode
<SPEED>
(Optional) Speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
Auto
<FLOW>
(Optional) Flow. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<EXPDUPLEX>
(Optional) Ethernet duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<EXPSPEED>
(Optional) Expected speed. Due to the auto-negotiation feature, actual speed may differ from expected speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
40 Gigabit per second
•
Automatic
•
Enable auto negotiation with full duplex.
<SELECTIVEAUTO>
(Optional) Selective auto-negotiation. The parameter is Y or N (enable or disable auto-negotiation) This indicates selective auto-negotiation of EXPSPEED and EXPDUPLEX only.
•
Enable selective auto-negotiation.
•
Disable selective auto-negotiation. The default value is N.
<VLANCOS>
(Optional) Priority queuing threshold based on VLAN class of service of incoming Ethernet packets. VLANCOS is an integer in the range 0 to 7. Defaults to 7.
<IPTOS>
(Optional) Priority queuing threshold based on IP type of service of incoming Ethernet packets. IPTOS is an integer in the range 0 to 255. Defaults to 255.
<NAME>
(Optional) Facility name. NAME is a string.
<SUPPRESS>
Pre-service alarm flag for data ports.
•
Enable suppress.
•
Disable suppress. Default is Off.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<LIENABLE>
(Optional) Enable or Disable link integrity timer. Takes either Y or N. Value Y enables the LITIMER and value N disables LITIMER.
By default LITIMER is enabled.
<LITIMER>
(Optional) Link integrity timer duration in the range between 200 ms and 10000 ms in multiples on 100 ms.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows:
•
•
•
<CIR>
Ingress committed information rate. The value ranges from 0.0 to 100.0. The default value is 100.0.
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects
•
Transparent
•
Squelch is enabled
<PSTPSTQ>
Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. the parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.69 RTRV-FTPSERVER
The Retrieve FTP Server (RTRV-FTPSERVER) command retrieves FTP server entries.
Usage Guidelines
FTP server entries cannot be retrieved using the TIMER filter.
Category
ENE
Security
Retrieve
Input Format
RTRV-FTPSERVER:[<TID>]::<CTAG>:::[IPADDR=<IPADDR>],[IPMASK=<IPMASK>],[ENABLE=<ENABLE>],[TIMER=<TIMER>];
Input Examples
1.
2.
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
",:IPADDR=<IPADDR>,IPMASK=<IPMASK>, ENABLE=<ENABLE>,TIMER=<TIMER>"
;Output Examples
1.
M CTAG COMPLD
",:IPADDR=10.20.30.40,IPMASK=255.0.0.0, ENABLE=Y,TIMER=10"
;1.
M CTAG COMPLD
",:IPADDR="[3ffe:0501:0008:0000:0260:97ff:fe40:efab/64]", ENABLE=Y,TIMER=10"
;
23.70 RTRV-G1000
The Retrieve G1000 Facility (RTRV-G1000) command retrieves the G1000 facilities configuration.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-G1000:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-G1000:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[MFS=<MFS>],[FLOW=<FLOW>],[LAN=<LAN>],[OPTICS=<OPTICS>],
[TRANS=<TRANS>],[TPORT=<TPORT>],[LOWMRK=<LOWMRK>],
[HIWMRK=<HIWMRK>],[AUTONEG=<AUTONEG>],[ENCAP=<ENCAP>],
[NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[LIENABLE=<LIENABLE],
[LITIMER=<LITIMER>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::MFS=1548,FLOW=N,LAN=ASYMMETRIC,OPTICS=UNKNOWN,TRANS=NONE,
TPORT=FAC-5-1,LOWMRK=20,HIWMRK=492,AUTONEG=Y,ENCAP=GFP_T,
NAME=\"G1000 PORT\",SOAK=32,SOAKLEFT=\"12-25\", LIENABLE=Y,
LITIMER=300:UNLOCKED-DISABLED, AUTOMATICINSERVICE"
;
Table 23-84 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<MFS>
(Optional) Maximum frame size. The parameter type is MFS_TYPE, which is the maximum frame size used by an Ethernet card.
•
Normal frame size
•
Jumbo frame size
<FLOW>
(Optional) Flow control. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<LAN>
(Optional) Local-area network. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Passthrough flow control
•
Symmetric flow control
<OPTICS>
(Optional) Gigabit Interface Converter (GBIC) type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000BaseCX
•
1000BaseLX
•
1000BaseSX
•
1000BaseT
•
1000BaseZX
•
100BaseBX_D
•
100BaseBX_U
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
<TRANS>
(Optional) Transponder mode. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
•
Bidirectional
•
Not in transponder mode
•
Unidirectional
<TPORT>
(Optional) Transponding port access identifier from the "FACILITY" section.
<LOWMRK>
(Optional) Low watermark value. LOWMRK is an integer.
<HIWMRK>
(Optional) High watermark value. HIWMRK is an integer.
<AUTONEG>
(Optional) Automatic negotiation. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<ENCAP>
(Optional) Frame encapsulation type. The parameter type is ENCAP, which is the frame encapsulation type.
•
GFP frame mode
•
GFP transparent mode
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
•
CBR mapping mode.
•
GFP mapping mode.
•
GMP mapping mode is supported only on 8GFC on 10x10G-LC card.
•
Transparent mapping mode.
<NAME>
(Optional) Facility name. String.
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<LIENABLE>
(Optional) Enable or Disable link integrity timer. Takes either Y or N. Value Y enables the LITIMER and value N disables LITIMER.
By default LITIMER is enabled.
<LITIMER>
(Optional) Link integrity timer duration in the range between 200 ms and 10000 ms in multiples of 100 ms.
<PSTPSTQ>
Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.71 RTRV-GFP
The Retrieve Generic Framing Protocol (RTRV-GFP) command retrieves the attributes of GFP encapsulation and applies to the FC_MR-4, CE-1000-4, and CE-100T-8 cards.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-GFP:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-GFP:CISCO:FAC-1-1:123;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section.
Note
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[FCS=<FCS>],[AUTOTHGFPBUF=<AUTOTHGFPBUF>],
[GFPBUF=<GFPBUF>],[FILTER=<FILTER>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1::FCS=FCS-32,AUTOTHGFPBUF=Y,GFPBUF=16,FILTER=EGRESS"
;
Table 23-85 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<FCS>
(Optional) Payload frame check sequence. The parameter type is FCS, which is the frame check sequence.
•
Frame check sequencing using 16 bits
•
Frame check sequencing using 32 bits
•
No frame check sequence
<AUTOTHGFPBUF>
(Optional) The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<GFPBUF>
(Optional) GFP buffer size. GFPBUF is an integer.
<FILTER>
The parameter type is GFP_FILTER, which provides filter feature in GFP.
•
Active filter feature egress port
•
Turn off filter feature
23.72 RTRV-GIGE
The Retrieve Gigabit (GIGE/10GIGE) Ethernet command retrieves the attributes and state of Gigabit Ethernet facilities.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-GIGE:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-GIGE:TID:FAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[<ADMINSTATE>],[<LINKSTATE>],[<MTU>],[<MFS>],[<FLOW>],[<FLOWCTRL>],[<AUTONEG>],[<HIWMRK>],[<LOWMRK>],[<OPTICS>],[<DUPLEX>],[<SPEED>],[<NAME>],[<MACADDR>],[<LBCL>],[<OPT>],[<OPR>],[<FREQ>],[<LOSSB>],[<SUPPRESS>],[<SOAK>],[<SOAKLEFT>],[<SQUELCH>],[<CIR>],[<CBS>],[<EBS>],[<LIENABLE>],[<LITIMER>],[<ACTFLOW>],[<ACTDUPLEX>],[<ACTSPEED>],[<OSC>],[<ENCAP>],[<PAUSEFRAME>],[<CLNTDST>],[<SYNCMSG>],[<SENDDUS>],[<ADMSSM>],[<PROVIDESYNC>],[<ESMC>],[<EXPSPEED>],[<EXPDUPLEX>],[<SELECTIVEAUTO>],[<INTERCONMODE>],[<SQUELCHMODE>]:<PORTMODE>,[<PST>]"
;
Output Example
TCC2 2002-02-07 05:35:58
M 1 COMPLD
"VFAC-4-1-1:,,WORK,STBY:MTU=9700,,AUTONEG=Y,DUPLEX=FULL,SPEED=1_GBPS,MACADDR=08-E5-78-6C-02-7F,FREQ=USE-TWL1,LOSSB=AUTOPROV,SOAK=32,ACTDUPLEX=AUTO,ACTSPEED=AUTO,SYNCMSG=Y,SENDDUS=N,ADMSSM=STU,PROVIDESYNC=N,ESMC=N,SQUELCHMODE=SQUELCH:OOS-MA,DSBLD"
;
Table 23-86 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ROLE>
Identifies the port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
Identifies a port status in a Y-cable protection scheme. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<ADMINSTATE>
(Optional) Administration type. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<LINKSTATE>
(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<MTU>
(Optional) Maximum transmission unit. MTU is an integer.
<MFS>
The max frame size used by an Ethernet card.
<ENCAP>
(Optional) Encapsulation frame type. The parameter type is ENCAP, which is the frame encapsulation type.
•
•
GFP Frame mode
•
GFP Transparent mode
•
HDLC Frame mode
•
HDLC LAN Extension Frame mode
•
HDLC X.86 Frame mode
<FLOWCTRL>
(Optional) Flow control. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
•
Asymmetric flow control
•
Asymmetric local flow control
•
No flow control
•
Passthrough flow control
•
Symmetric flow control
<AUTONEG>
(Optional) Automatic negotiation. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<LOWMRK>
(Optional) Low watermark value. LOWMRK is an integer.
<HIWMRK>
(Optional) High watermark value. HIWMRK is an integer.
<OPTICS>
(Optional) Optics type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
•
1000BaseCX
•
1000BaseLX
•
1000BaseSX
•
1000BaseT
•
1000BaseZX
•
100BaseBX_D
•
100BaseBX_U
•
CWDM 1470
•
CWDM 1490
•
CWDM 1510
•
CWDM 1530
•
CWDM 1550
•
CWDM 1570
•
CWDM 1590
•
CWDM 1610
•
ITU-100G 1530.33
•
ITU-100G 1531.12
•
ITU-100G 1531.90
•
ITU-100G 1532.68
•
ITU-100G 1534.25
•
ITU-100G 1535.04
•
ITU-100G 1535.82
•
ITU-100G 1536.61
•
ITU-100G 1538.19
•
ITU-100G 1538.98
•
ITU-100G 1539.77
•
ITU-100G 1540.56
•
ITU-100G 1542.14
•
ITU-100G 1542.94
•
ITU-100G 1543.73
•
ITU-100G 1544.53
•
ITU-100G 1546.12
•
ITU-100G 1546.92
•
ITU-100G 1547.72
•
ITU-100G 1548.51
•
ITU-100G 1550.12
•
ITU-100G 1550.92
•
ITU-100G 1551.72
•
ITU-100G 1552.52
•
ITU-100G 1554.13
•
ITU-100G 1554.94
•
ITU-100G 1555.75
•
ITU-100G 156.55
•
ITU-100G 1558.17
•
ITU-100G 1558.98
•
ITU-100G 1559.79
•
ITU-100G 1560.61
•
Unknown Optical Type
•
Unplugged
<DUPLEX>
(Optional) Duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<SPEED>
(Optional) Speed. The parameter type is ALS_MODE, which is the automatic laser shutdown mode.
•
Automatic
•
Disabled
•
Manual
•
Manual restart for test
<NAME>
(Optional) Facility name. NAME is a string.
<FREQ>
(Optional) The parameter type is OPTICAL WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1529.16
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) The parameter type is REACH, which is the reach value.
•
100GBASE-LR4
•
100GBASE-SR10
•
40GBASE-FR
•
40GBASE-LR4
•
Reach supported on 40GIGE payload on CFP-LC card.
•
4I1-9D1F
•
C4S1-2D1
•
FE-BX
•
FX
•
GE-BX
•
GE-EX
•
LX-10
•
TEN-GE-LRM
•
TEN-GE-ZR
•
VSR2000-3R2
•
Autoprovisioning
•
CWDM 40 kilometers.
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Long haul 10G Ethernet with 1310 nm wavelength
•
Longhaul 2.5G Ethernet with 1550 nm wavelength
•
Long haul 10G Ethernet with 1550 nm wavelength
•
Shorthaul 2.5G Ethernet with 1310 nm wavelength
•
Short haul 10G Ethernet in 1310 nm wavelength
•
Reach SC
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach ULH
•
Reach VSR
•
Reach VX
•
Reach ZX
<SOAK>
(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<LIENABLE>
(Optional) Enable or disable link integrity timer. Takes either Y or N. Value Y enables the LITIMER and value N disables LITIMER.
By default LITIMER is enabled.
<LITIMER>
(Optional) Link integrity timer duration in the range between 200 ms and 10000 ms in multiples of 100 ms.
<ACTFLOW>
The type of flow control.
•
Asymmetric flow control
•
Asymmetric local flow control.
•
No flow control
•
Pass-through flow control
•
Symmetric flow control
<ACTDUPLEX>
Ethernet duplex mode. Default value is -AUTO.
•
Auto mode
•
Full mode
•
Half mode
<ACTSPEED>
Ethernet speed.
•
100 MBPS
•
10 GBPS
•
10 MBPS
•
1 GBPS
•
40 Gigabit per second
•
Automatic
•
Enable auto negotiation with full duplex.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows:
•
•
•
<ENCAP>
(Optional) Frame encapsulation type. The parameter type is ENCAP, which is the frame encapsulation type.
•
CBR mapping mode
•
GFP frame mode
•
GFP transparent mode
•
GMP mapping mode. Supported only on 8GFC on 10x10G-LC card.
•
HDLC frame mode
•
HDLC LAN extension frame mode
•
HDLC X.86 frame mode
<PAUSEFRAME>
To Enable or Disable the Pause Frame.
•
Enable
•
Disable
<EXPSPEED>
(Optional) Expected speed. Due to the auto-negotiation feature, actual speed may differ from expected speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
•
100 Mbps
•
10 Gbps
•
10 Mbps
•
1 Gbps
•
40 Gigabit per second
•
Automatic
•
Enable auto negotiation with full duplex.
<EXPDUPLEX>
(Optional) Ethernet duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
•
Auto mode
•
Full mode
•
Half mode
<SELECTIVEAUTO>
(Optional) Selective auto-negotiation. The parameter is Y or N (enable or disable auto-negotiation) This indicates selective auto-negotiation of EXPSPEED and EXPDUPLEX only.
•
Enable selective auto-negotiation.
•
Disable selective auto-negotiation. The default value is N.
<INTERCONMODE>
Inter connect mode
<CLNTDST>
Client distance in kilometers.
•
10 kilometers.
•
30 kilometers.
<CIR>
Ingress committed information rate. The value ranges from 0.0 to 100.0. The default value is 100.0.
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects
•
Transparent
•
Squelch is enabled
<PST>
Primary state. The parameter type is PST, which is the current overall service condition of an entity.
•
In service
•
Out of service
<SST>
Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.73 RTRV-HDLC
The Retrieve High-Level Data Link Control (RTRV-HDLC) command retrieves HDLC-related attributes.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-HDLC:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-HDLC:TID:VFAC-1-1-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[FCS=<FCS>],[CRC=<CRS>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-1-1-1::FCS=FCS-16,CRC=CRC-16"
;
Table 23-87 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<FCS>
(Optional) Payload frame check sequence. The parameter type is FCS, which is the frame check sequence.
•
Frame check sequencing using 16 bits
•
Frame check sequencing using 32 bits
•
No frame check sequence
<CRC>
Cyclic Redundancy Check.
•
Cyclic Redundancy Check using 16 bits.
•
Cyclic Redundancy Check using 32 bits.
23.74 RTRV-HDR
The Retrieve Header (RTRV-HDR) command retrieves the header of a TL1 response message. It is used by TL1 clients to determine if the link to the NE is still active and if the NE is responding to commands.
Category
System
Security
Retrieve
Input Format
RTRV-HDR:[<TID>]::<CTAG>;
Input Example
RTRV-HDR:SONOMA::232;
Input Parameters
None
23.75 RTRV-INV
The Retrieve Inventory (RTRV-INV) command retrieves a listing of the equipment inventory. For each unit in the system, it identifies the unit's firmware numbers and Common Language Equipment Identifier (CLEI) codes, and the system's product ID and version ID.
Usage Guidelines
For multishelf, the inventory parameters are retrieved by using RTRV-INV and the BP AID. Because there is more that one shelf, the SHELFID is specified in BP AID.
Category
System
Security
Retrieve
Input Format
RTRV-INV:[<TID>]:<AID>:<CTAG>[::::];
Input Examples
RTRV-INV:OCCIDENTAL:SLOT-15:301;
Input Parameters
<AID>
Access identifier from the "EQPT" section or the "ALL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[PLUGTYPE=<PLUGTYPE>],[PN=<PN>],[HWREV=<HWREV>],
[FWREV=<FWREV>],[SN=<SN>],[CLEI=<CLEI>],[TWL=<TWL>],
[PLUGINVENDORID=<PLUGINVENDORID>],[PLUGINPN=<PLUGINPN>],
[PLUGINHWREV=<PLUGINWREV>], [PLUGINFWREV=<PLUGINFWREV>],
[PLUGINSN=<PLUGINSN>],[ILOSSREF=<ILOSSREF>],[PID=<PID>],[VID=<VID>],
[FPGA=<FPGA>],[MODULETYPE=<MODULETYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-15,OC3-IR-4::PLUGTYPE=SX-IR-SW-SN,PN=87-31-00002,HWREV=004K, FWREV=76-99-00009-004A,SN=013510,CLEI=NOCLEI,TWL1=1546.12,TWL2=1546.92, TWL3=1547.72,TWL4=1548.51,PLUGINVENDORID=012345,PLUGINPN=ABCDE, PLUGINHWREV=ABCDE,PLUGINFWREV=01-02-03,PLUGINSN=01234,ILOSSREF=1.0, PID=CISCO_NCS,VID=V01,FPGA=F451,MODULETYPE=101"
;
Table 23-88 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<AIDTYPE>
Specifies the type of (AID) facility, link or other addressable entity targeted by the message. The parameter type is EQUIPMENT_TYPE (equipment type). AIDTYPE is a string.
•
2 x 10 Gbps. muxponder/L2 ethernet switch card
•
Thermal Multiplex/Demultiplex Passive Unit, spaced at 50 GHz on even grid
•
Thermal Multiplex/Demultiplex Passive Unit, spaced at 50 GHz on odd grid
•
Thermal Interleaver Passive Unit, spaced at 50 GHz grid
•
Edge 4-Ch Bi-Directional OADM Module 1530.33 to 1532.68.
•
Edge 4-Ch Bi-Directional OADM Module 1533.47 to 1535.82.
•
Edge 4-Ch Bi-Directional OADM Module 1536.61 to 1538.98.
•
Edge 4-Ch Bi-Directional OADM Module 1539.77 to 1542.14.
•
Edge 4-Ch Bi-Directional OADM Module 1542.94 to 1545.32.
•
Edge 4-Ch Bi-Directional OADM Module 1546.12 to 1548.51.
•
Edge 4-Ch Bi-Directional OADM Module 1549.32 to 1551.72.
•
Edge 4-Ch Bi-Directional OADM Module 1552.52 to 1554.94.
•
Edge 4-Ch Bi-Directional OADM Module 1555.75 to 1558.17.
•
Edge 4-Ch Bi-Directional OADM Module 1558.98 to 1561.42.
•
32 channel optical demultiplexer
•
32 channel optical demultiplexer for L-band
•
32 channel unidirectional optical demultiplexer
This overrides the old equipment type DMX-32 present in the 4.6 and earlier releases.•
32 channel unidirectional optical multiplexer
This overrides the old equipment type MUX-32 present in the 4.6 and earlier releases.•
32 channel optical wavelength selective switch for C Band
•
40 channel optical demultiplexer for C Band
•
40 channel optical multiplexer for C Band
•
40 Gbit/Sec Multirate Muxponder
•
The single module 40-channel ROADM on C-band
•
The single module 40-channel ROADM with EDFA on C-band
•
40 Gigabits per second Multirate Transponder
•
40 channel optical wavelength cross-connect/wavelength router for C Band
•
80-channel wavelength cross-connect spaced at 100 GHz grid
•
Optical add/drop multiplexed (OADM) 1 band filter
•
Optical add/drop multiplexed (OADM) 1 channel filter
•
Optical add/drop multiplexed (OADM) 2 channels filter
•
Optical add/drop multiplexed (OADM) 4 bands filter
•
Optical add/drop multiplexed (OADM) 4 channels filter
•
16 x OC3/OC12/OC48/GIGE and OC192/Trunk ADM 10 Gbps card
•
AIC card
•
AICI Card
•
Any service any port (ASAP) carrier card with four PIM slots
•
Modena mapper card
•
Exige/Elise mapper card
•
Lotus20g ce2 card
•
GT3 CE2 Card
•
CTX card
•
Cross connect card
•
Dispersion Compensation Unit
•
DS1-84-DS3-EC1-3 card
•
DS1-E1-56 card
•
DS1I card
•
DS3 card
•
DS3-EC1-48 card type
•
DS3E card
•
DS3I card
•
DS3IN card
•
42 port E1 card
•
E1-21-DS3-E3-3
•
E1-63-DS3-E3-3
•
E1000T card
•
E100T card
•
E3 card
•
EC1 card
•
Blank filler card
•
The equipment type for FMEC STM1E12 card with 1:3 protection
•
The equipment type for FMEC STM1E12 card without protection
•
A 4-port G1000 card
•
20 x 1 Gbps muxponder/L2 ethernet switch card
•
Four channel optical multiplexer/demultiplexer
•
The passive unit Patch Panel device used to connect up to four 40-SMR2-C cards.
•
Exige/Elise mapper card
•
Daytona 2-port GigE
•
Daytona 12-port FSTE
•
8-port 100T card with optical interface
•
Humvee - 12-port multirate optical card
•
4-port MRC 2.5G
•
12-port MRC 2.5G
•
Monviso 10G (4 * 2.5G) muxponder card with enhanced FEC
•
Skane 10G (4 * 2.5G) muxponder card
•
Bernina multirate 2.5G muxponder unprotected
•
Bernina multirate 2.5G muxponder protected
•
Multirate 10Gbps datamux
•
4-port OC192 card
•
Leatherneck: 4-port OC192 card with tunable laser for C band
•
16-port OC48 card
•
Optical booster/pre-amplifier for C band 17 dBm
•
Optical booster/pre-amplifier for C band 23 dBm
•
Optical booster/pre-amplifier for L band
•
Optical booster/pre-amplifier for C band
•
Optical booster amplifier
•
Optical booster enhanced amplifier for C band
•
Optical booster amplifier for L band
•
MAL-less EDFA Optical Amplifier - C-band - 17dB Gain
•
MAL-less EDFA Optical Amplifier - C-band - 24dB Gain
•
Optical pre-amplifier
•
Raman pump amplifier C-band
•
An extended version of Raman pump amplifier
•
Raman pump amplifier E-band
•
Optical service channel (OSC) with combiner/separator module (SCM)
•
Optical service channel (OSC) module
•
A 4x10G transponder that is capable to operate with multiple bit rates - 10G FC, 10GE, and OC192/STM64
•
1-port pluggable interface module
•
4-port pluggable interface module
•
Patch-Panel, 4 degrees, for SMR cards
•
Patch-Panel, 4 degrees
•
Patch-Panel, 8 degrees
•
Pluggable port module with one SFP port
•
Protection Service Module card
•
Line card.
•
Fabric card.
•
CPT 50 panel
•
Packet transport system.
•
PTSYS Fan-Out-Group.
•
To add the NCS SSC to multishelf.
•
SHELF-M6
•
STM1E-12 card
•
TCC card
•
Coarse tunable dispersion compensation unit
•
Fine tunable dispersion compensation unit
•
Transport Node Controller card
•
Transport Shelf Controller card
•
Skane 10G multirate transponder card with enhanced FEC
•
Skane 10G multirate transponder card
•
Rockwell multirate 2.5G unprotected
•
Rockwell multirate 2.5G protected
•
XC card
•
XC10G card
•
XCVT card
•
XCVXC-10G card
•
XCVXC-2.5G card
•
XCVXL-10G card
•
XCVXL-2.5G card
<PLUGTYPE>
(Optional) Describes the type of plug-in. PLUGTYPE is a string.
<PN>
(Optional) Hardware part number. PN is a string.
<HWREV>
(Optional) Hardware revision. HWREV is a string.
<FWREV>
(Optional) Firmware revision. It is also known as Bootrom revision. FWREV is a string.
<SN>
(Optional) Serial number. SN is a string.
<CLEI>
(Optional) Common language equipment identifier code for the equipment. CLEI is a string.
<TWL1>
(Optional) Tunable wavelength 1.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<PLUGINVENDORID>
(Optional) Plug-in vendor ID. PLUGINVENDORID is an integer.
<PLUGINPN>
(Optional) Third-party plug-in module HW part number. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINPN is a string.
<PLUGINHWREV>
(Optional) Third-party plug-in module hardware revision. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINHWREV is a string.
<PLUGINFWREV>
(Optional) Third-party plug-in module firmware. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINFWREV is a string.
<PLUGINSN>
(Optional) Third-party plug-in module serial number. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINSN is a string.
<ILOSSREF>
(Optional) The insertion loss reference calculated by the unit as worst insertion loss of all the unit. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<PID>
(Optional) Product ID of the module. PID is a string.
<VID>
(Optional) Vendor ID. VID is a string.
<FPGA>
(Optional) FPGA version. FPGA is a string.
<MODULETYPE>
(Optional) Describes the type of embedded plug-in module. MODULETYPE is a string.
Output Parameters
Note
23.76 RTRV-L2-ETH
The Retrieve Layer 2 Ethernet (RTRV-L2-ETH) command retrieves the Layer 2 port information of the Ethernet card.
Usage Guidelines
None
Category
Ethernet
Security
Retrieve
Input Format
RTRV-L2-ETH:[<TID>]:<AID>:<CTAG>[:::];
Input Example
RTRV-L2-ETH:PETALUMA:FAC-1-1:CTAG;
Input Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[<NIMODE>],[<MACLEARNING>],[<INGRESSCOS>],[<ETHERCETYPE>],[<ETHERSTYPE>],[<ALWMACADDR>],[<INHMACADDR>],[<BPDU>],[<BRIDGESTATE>],[<ACTBRIDGESTATE>],[<QNQMODE>],[<TRNSPSVLAN>],[<NAME>],[<IGMPROUTER>],[<AISACTION>],[<PROTACTION>],[<IGMPONCVLAN>],[<IGMPCVLAN>],[<DLF>],[<DLFTHRES>],[<MCAST>],[<MCASTTHRES>],[<BCAST>],[<BCASTTHRES>],[<CLRCRCALM>]:";
Output Example
MS-55- 2010-11-09 01:26:55
M c COMPLD
"ETH-5-1-22-1::NIMODE=NNI,MACLEARNING=Y,INGRESSCOS=0,ETHERCETYPE=8100,ETHERSTYPE=8100,BPDU=Y,BRIDGESTATE=FORWARDING,ACTBRIDGESTATE=FORWARDING,QNQMODE=SELECTIVE,IGMPROUTER=NONE,AISACTION=AIS-NONE,PROTACTION=PROT-SQUELCH,IGMPONCVLAN=N,DLF=N,DLFTHRES=0,MCAST=N,MCASTTHRES=0,BCAST=N,BCASTTHRES=0,CLRCRCALM=N:"
Table 23-89 Output Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<NIMODE>
Identifies the Ethernet network interface mode.
•
(Default) Network-network interface mode
•
User-network interface mode
<MACLEARNING>
MAC address learning mode. This activates MAC address learning on the interface to avoid packet broadcasting.
•
Enables MAC learning
•
Disables MAC learning
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Set a Cos value
•
The COS is set according to DSCP to COS mapping table.
•
Use the Customer COS
•
The COS will be provisioned on CVLAN basis (QinQ selective mode)
<ETHERCETYPE>
Identifies a customer specific Ethernet type. If the customer uses a nonstandard Ethernet type, the incoming packets will be accepted only if the customer VLAN (CE-VLAN) Ethernet type matches this parameter.
<ETHERSTYPE>
Identifies a customer specific Ethernet type. If the customer uses a nonstandard Ethernet type, the incoming packets will be accepted only if the CE-VLAN Ethernet type matches this parameter.
<ALWMACADDR>
Identifies the allowed MAC addresses filtered out by the L2 Ethernet port. Every single MAC address is in the format of aa-bb-cc-dd-ee-ff, where every digit is in a hexadecimal form.
<INHMACADDR>
Identifies the inhibited MAC addresses filtered out by the L2 Ethernet port. Every single MAC address is in the format of aa-bb-cc-dd-ee-ff, where every digit is in a hexadecimal form.
<BPDU>
Bridge Protocol Data Unit (BPDU) management mode; Drop/Passthrough BPDU tagged packets.
•
Enables the BPDU tag.
•
Disables the BPDU tag.
<BRIDGESTATE>
Defines if the traffic is blocked on the port.
•
Unknown state
•
Disabled state
•
Blocking state
•
Listening state
•
Learning state
•
Forwarding state
•
Broken state
<ACTBRIDGESTATE>
Defines if the traffic is blocked on the port.
•
Unknown state
•
Disabled state
•
Blocking state
•
Listening state
•
Learning state
•
Forwarding state
•
Broken state
<QNQMODE>
This is used to represent the IEEE 802.1Q tunneling (QinQ) mode operations.
•
The S-VLAN tag is added only on specified CE-VLANs. The other packets are dropped.
•
The S-VLAN tag is always added where all packets having the S-VLAN-ID identified by the TRNSPSVLAN parameter are allowed.
<TRNSPSVLAN>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for CE-VLAN IDs and S-VLAN IDs.
<NAME>
(Optional) Facility name. NAME is a string.
<CMDMDE>
(Optional) Command mode. Normal (NORM) mode is the default behavior for all commands but you can specify forced (FRCD) mode to force the system to override a state where the command would normally be denied. The FRCD mode of operation is applicable to delete a virtual concatenated (VCAT) member cross-connect in Unlocked-Enabled or Locked-Disabled, AutomaticInService service states.
<PST>
Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In service
•
Out of service
<SST>
Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
<AISACTION>
VLAN-AIS Action. Indicates what action take place on port when VLAN-AIS alarm is raisedValues
•
The port is squelched
•
No action after VLAN-AIS
<IGMPROUTER>
IGMP M Router port. Indicates the type of connection between this port and the IGMP M Router.
•
A static connection is present between this port and the IGMP M Router
•
No connection is present
<PROTACTION>
Indicates the action that takes place on the standby port in the protection unit when a ONEPLUSONEL2 protection is activated.
•
The port is squelched.
•
Ethernet traffic is blocked.
<IGMPCVLAN>
Indicates the customer VLAN value for IGMP on CVLAN.
<IGMPONCVLAN>
Indicates IGMP on customer VLAN.
<DLF>
To enable or disable storm control on DLFPC packet.
<DLFTHRES>
Indicates the DLFPC packet threshold value for storm control.
<MCAST>
To enable or disable the storm control on multicast packet.
<MCASTTHRES>
Indicates the multicast packet threshold value for storm control.
<BCAST>
To enable or disable the storm control on broadcast packet.
<BCASTTHRES>
Indicates the broadcast packet threshold value for storm control.
<CLRCRCALM>
Clears the DATA-CRC alarm.
23.77 RTRV-L2-TOPO
The Retrieve Layer 2 topology (RTRV-L2-TOPO) command retrieves the LACP, REP, and EFM topology configuration information.
Usage Guidelines
The RTRV-L2-TOPO command retrieves the normal and detailed logs of a port that is configured with LACP, REP, or EFM topology.
Category
Ports
Security
Retrieve
Input Format
RTRV-L2-TOPO:[<TID>]:<AID>:<CTAG>:::PROTOCOL=<PROTOCOL>,[LOGLEVEL=<LOGLEVEL>],[IDENTIFIER=<IDENTIFIER>];
Input Example
RTRV-L2-TOPO::SLOT-16:1:::PROTOCOL=REP-INTERFACES,IDENTIFIER=2;
Input Parameters
<AID>
Access identifier from the FACILITY.
<PROTOCOL>
Indicates protocol for which L2 topology details are displayed.
•
Topology information of Ethernet OAM Discovery.
•
Topology information of the Ethernet OAM Statistics.
•
Topology information of the Ethernet OAM Status.
•
Summary of the Ethernet OAM protocol.
•
Link Aggregation Control Protocol.
•
LACP partner.
•
REP interface.
•
REP topology.
•
REP archive.
<LOGLEVEL>
The parameter type is LOGLEVEL.
•
Detailed
•
Normal
<IDENTIFIER>
Identifier
Output Format
SID DATE TIME
M CTAG COMPLD
"TOPODETAIL"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"Interface Seg-id Type LinkOp Role
---------------------- ------ -------------- ----------- ----
Phy0 2 Primary Edge INIT_DOWN Fail
Phy1 2 Pref Edge INIT_DOWN Fail
UUßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß
ßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßßß"
;
Table 23-90 Output Parameter Support
<AID>
Access identifier from the FACILITY.
23.78 RTRV-LM-EFM
The Retrieve Link Monitoring Ethernet in the First Mile (RTRV-LM-EFM) command retrieves the Ethernet in the First Mile (EFM) link monitoring parameters and the action associated with each of the parameters.
Usage Guidelines
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-LM-EFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-LM-EFM::ETH-12-1-1:1;
Input Parameters
<AID>
Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"AID>:[IMPARAM=<IMPARAM>], [HIGHTH=<HIGHTH>],
[LOWTH=<LOWTH>],[ACTION=<ACTION>],[WINDOW=<WINDOW>];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-7-1-1,LMPARAM=ERR-FRAME,LOWTH=1,HIGHTH=0,ACTION=NONE,WINDOW=10"
;
Table 23-91 Output Parameter Support
<AID>
Access identifier from the FACILITY.
<LMPARAM>
Name of the link monitoring parameter.
•
Error frames.
•
Error frame period.
•
Error frames second.
<LOWTH>
The lowest value of the link monitoring parameter. It is an integer.
<HIGHTH>
The highest value of the link monitoring parameter. It is an integer.
<ACTION>
Action to be taken when the link monitoring parameter crosses the HIGH value, which is set by the user. The value can be NONE or DISABLED.
<WINDOW>
This indicates the window associated with each of the link monitoring parameter (number of packets, number of frames or the timer). It is an integer.
23.79 RTRV-LMP
The Retrieve Link Management Protocol (RTRV-LMP) command retrieves the global LMP protocol attributes.
Usage Guidelines
This command is only available on platforms that support the LMP protocol.
Category
LMP
Security
Provisioning
Input Format
RTRV-LMP:[<TID>]::<CTAG>;
Input Example
RTRV-LMP:PETALUMA::704;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"::ENABLE=<ENABLE>,[WDM=<WDM>],[ROLE=<ROLE>],[NODEID=<NODEID>],
[OPSTATE=<OPSTATE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"::ENABLE=Y,WDM=Y,ROLE=PEER,NODEID=198.133.219.25,OPSTATE=UP"
;
23.80 RTRV-LMP-CTRL
The Retrieve Link Management Protocol Control Channel (RTRV-LMP-CTRL) command retrieves the attributes of an LMP control channel.
Usage Guidelines
This command is only available on platforms that support the LMP protocol.
Category
LMP
Security
Provisioning
Input Format
RTRV-LMP-CTRL:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-LMP-CTRL:PETALUMA:CC-123:704;
Input Parameters
<SRC>
The LMP control channel AID.
•
Specifies all the control channels.
•
Specifies an individual control channel.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::REMOTEID=<REMOTEID>,LOCALPORT=<LOCALPORT>,REMOTEIP=<REMOTEIP>,
[HELLO=<HELLO>],[HELLOMIN=<HELLOMIN>],[HELLOMAX=<HELLOMAX>],
[DEAD=<DEAD>],[DEADMIN=<DEADMIN>],[DEADMAX=<DEADMAX>],
[OPSTATE=<OPSTATE>]:[<PST>[,<SST>]]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD "CTRL-2::REMOTEID=15.15.15.115,LOCALPORT=FAC-1-1-1,REMOTEIP=126.0.0.1,HELLO=50,
HELLOMIN=300,HELLOMAX=5000,DEAD=12000,DEADMIN=2000,DEADMAX=20000,
OPSTATE=UP:OOS,DSBLD"
;
23.81 RTRV-LMP-TLINK
The Retrieve Link Management Protocol (RTRV-LMP-TLINK) command retrieves the attributes of an LMP traffic engineering (TE) link.
Usage Guidelines
This command is limited to nodes that support the LMP protocol, and where the LMP protocol has been enabled.
Category
LMP
Security
Provisioning
Input Format
RTRV-LMP-TLINK:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-LMP-TLINK:PETALUMA:TLINK-123:704;
Input Parameters
<SRC>
LMP TE link AID values
•
Specifies all the TE links.
•
Specifies an individual TE link.
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>::[REMOTEID=<REMOTEID>],[NCS=<NCS>],[REMOTETE=<REMOTETE>],
[MUXCAP=<MUXCAP>],[OPSTATE=<OPSTATE>]:[<PST>[,<SST>]]"
;Output Example
TID-000 1998-06-20 14:30:0
M CTAG COMPLD
"TLINK-2::REMOTEID=15.15.15.115,NCS=Y,REMOTETE=3,MUXCAP=LAMBDA,
OPSTATE=UP:IS"
;
23.82 RTRV-LMP-DLINK
The Retrieve Link Management Protocol Data Link (RTRV-LMP-DLINK) command retrieves the attributes of an LMP data link.
Usage Guidelines
This command is only applicable on a node where the LMP protocol is supported and enabled.
Category
LMP
Security
Provisioning
Input Format
RTRVD-LMP-DLINK:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-LMP-DLINK:PETALUMA:FAC-14-1-1:704;
Input Parameters
<SRC>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LINKTYPE=<LINKTYPE>],[REMOTEID=<REMOTEID>],[TELINK=<TELINK>],
[OPSTATE=<OPSTATE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-14-1-1::LINKTYPE=PORT,REMOTEID=45,TELINK=TLINK-4,OPSTATE=UP-ALLOC"
;
Table 23-95 Output Parameter Support
<SRC>
Access identifier from the "FACILITY" section.
<LINKTYPE>
The type of LMP data link
•
Port data link
•
Component data link
<REMOTEID>
The remote LMP data link ID
<TELINK>
Used to map LMP data links to LMP TE links
<OPSTATE>
Indicates the operational status of an LMP data link.
•
The data link is being tested. An LMP test message is periodically sent through the link.
•
The data link is not communicating with its counterpart on the remote node.
•
The link is up and has been allocated for data traffic.
•
The link has been successfully tested and is now put in the pool of resources (in-service). The link has not yet been allocated to data traffic.
23.83 RTRV-LNK
The Retrieve Link (RTRV-LNK) command retrieves all the (optical) links created in the NE. The end information is returned along with the type of (optical) link.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-LNK:[<TID>]::<CTAG>;
Input Example
RTRV-LNK:PENNGROVE::114;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],[RDIRN=<RDIRN>],
[BAND=<BAND>],[WLEN=<WLEN>]:<PSTPSTQ>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-TX,BAND-13-1-RX::OLNKT=HITLESS,CTYPE=PROV,
RDIRN=W_E, BAND=1530.32-1532.68,WLEN=1530.32:OOS-AU,AINS"
;
Table 23-96 Output Parameter Support
<FROM>
Access identifier from the "ALL" section. Identifies an entity at one end of the optical link.
<TO>
Access identifier from the "ALL" section. Identifies an entity at the other end of the optical link.
<OLNKT>
(Optional) Optical link type. The parameter type is OPTICAL_LINK_TYPE, which is the type of optical link between two optical facilities.
•
Link between two points that result in an add/drop connection from a drop point to an add point
•
Link between two OMS points that result in a hitless connection from a drop point to an add point of a consecutive band/channel filter
•
MPO connector
•
Link between two OTS points
•
Link between two OTS points interrupted by an interleaver card that the system does not monitor.
<CTYPE>
(Optional) The type of cross-connection. Indicates if the optical link is provisioned by the user or automatically created by the NE. The parameter type is CREATION_TYPE, which is the optical link creation type.
•
Automatically created by the NE
•
Provisioned by the user
<RDIRN>
(Optional) Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<BAND>
(Optional) The optical band (group of four contiguous wavelengths) for this optical link. BAND is present only when there is a link between two OMS entities. The parameter type is OPTICAL_BAND (optical band).
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit.
<WLEN>
(Optional) Optical wavelength for this optical link. WLEN is present only when there is a link between two OCH entities. The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.16
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.72
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.11
•
Wavelength 1548.51
•
Wavelength 1548.91
•
Wavelength 1549.32
•
Wavelength 1549.72
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<PSTPSTQ>
Service state. The parameter is PST_PSTQ, which provides the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.84 RTRV-LNKTERM
The Retrieve Provisionable Patchcord Termination (RTRV-LNKTERM) command retrieves information about one or more provisionable patchcord (PP) terminations.
Usage Guidelines
•
•
Category
Provisionable Patchcords
Security
Retrieve
Input Format
RTRV-LNKTERM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-LNKTERM::LNKTERM-2:CTAG;
Input Parameters
<AID>
Access identifier from the "LNKTERM" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::PORT=<PORT>,[REMOTENODE=<REMOTENODE>],
[REMOTELNKTERMID=<REMOTELNKTERMID>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"LNKTERM-2::PORT=FAC-3-1,REMOTENODE=172.20.221.225,REMOTELNKTERMID=21"
;Output Parameters
<AID>
Access identifier from the "LNKTERM" section.
<PORT>
Access identifier from the "AidUnionId" section.
<REMOTENODE>
(Optional) Remote node. REMOTENODE is a string.
<REMOTELNKTERMID>
(Optional) Remote link term ID. REMOTELNKTERMID is an integer.
23.85 RTRV-LOG
The Retrieve Log (RTRV-LOG) command retrieves the alarm log of the NE.
Usage Guidelines
The only option for LOGNM is ALARM.
Category
Log
Security
Superuser
Input Format
RTRV-LOG:[<TID>]::<CTAG>::<LOGNM>;
Input Example
RTRV-LOG:CISCO::123::ALARM;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<ALMNUMBER>:CURRENT=<CURRENT>,[PREVIOUS=<PREVIOUS>],
<CONDITION>,<SRVEFF>,[TIME=<OCRTIME>],[DATE=<OCRDAT>]:<ALMDESCR>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,18:CURRENT=MJ,PREVIOUS=CL,EOC,NSA,TIME=16-33-04,
DATE=1971-02-03:\"RS-DCC TERMINATION FAILURE\""
;
Table 23-97 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<ALMNUMBER>
Alarm number of the log. ALMNUMBER is an integer.
<CURRENT>
Current severity. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
•
The condition causing the alarm has cleared.
•
A critical alarm.
•
A major alarm.
•
A minor alarm.
•
The condition is not alarmed.
•
The alarm is not reported.
<PREVIOUS>
(Optional) Previous severity. The parameter type is COND_EFF, which is the state of the condition upon the affected unit.
•
Standing condition cleared
•
Standing condition raised
•
Transient condition
<CONDITION>
Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an NCS shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Table 28-1 for a list of conditions.
<OCRTIME>
(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<OCRDATE>
(Optional) Date when the specific event or violation occurred, MM-DD. Date when alarm was triggered.
<ALMDESCR>
Alarm description. ALMDESCR is a string.
23.86 RTRV-MA-CFM
The Retrieve Maintenance Association Connectivity Fault Management (RTRV-MA-CFM) command retrieves the maintenance association on the card.
Usage Guidelines
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-MA-CFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-MA-CFM::SLOT-1:1;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"AID>:MANAME=<MANAME>, SVLANID=<SVLANID>,
CCENABLE=<CCENABLE>[:];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,MANAME=CISCO,SVLANID=1,CCENABLE=Y"
;
Table 23-98 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<MANAME>
Maintenance Association Name. It is a string. The MA name length should not exceed more than 43 characters.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<CCENABLE>
Enable or disable Continuos Check messaging
•
Enable
•
Disable
23.87 RTRV-MACTABLE
The RTRV-MACTABLE command retrieves all the MAC addresses stored in the card, as well as the internal MAC addresses associated with each port of the card.
Usage Guidelines
•
•
•
•
Input Format
RTRV-MACTABLE:<TID>:<AID>:<CTAG>:::ADDRTYPE=<addrtype>,[VLANIDFROM=<vlanidfrom>],[VLANIDTO=<vlanidto];
Input Example
RTRV-MACTABLE::SLOT-12:1:::ADDRTYPE=LEARNED-MAC, VLANIDFROM=10, VLANIDTO=20;
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<ADDRTYPE>,<PORT>,<VLANID>,<MACADDRESS>"
;Output Example
SID DATE TIME
M CTAG COMPLD
"SLOT-1,ADDRTYPE=LEARNED-MAC,PORT=4,VLANID=199,MACADDRESS=10:10:10:10:10:10";
23.88 RTRV-MAP-NETWORK
The Retrieve Map Network (RTRV-MAP-NETWORK) command retrieves all the NE attributes that are accessible from the gateway NE (GNE). The NE attributes include the node IP address (IPADDR), the node name (TID), and the product type of the NE (PRODUCT).
Usage Guidelines
The product type field in the response will appear as "unknown" for nodes that are not running the same version of software.
Category
System
Security
Retrieve
Input Format
RTRV-MAP-NETWORK:[<TID>]::<CTAG>;
Input Example
RTRV-MAP-NETWORK:CISCO::123;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"[IPADDR],<NODENAME>,<PRODUCT>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"[3FFE:0501:0008:0000:0260:97FF:FE40:EFAB],TID-000,NCS";
23.89 RTRV-MCAST
The Retrieve the Multicast attributes command retrieves the Multicast VLAN registration attributes.
Usage Guidelines
None
Category
Ethernet
Security
Retrieve
Input Format
RTRV-MCAST:[<TID>]:<AID>:<CTAG>::[::];
Input Example
RTRV-MCAST:TID:SLOT-1-5:CTAG;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[<MVRSTATE>],[<MVRSVLAN>],[<MVRSTARTIP>],[<MVRIPRANGE>],[<IGMPONCVLAN>]:";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1-12::MVRSTATE=Y,MVRSVLAN=132,MVRSTARTIP=230.64.38.55,MVRIPRANGE=60:";
23.90 RTRV-MD-CFM
The Retrieve Maintenance Domain Connectivity Fault Management (RTRV-MD-CFM) command retrieves the maintenance domain on the card.
Usage Guidelines
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-MD-CFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-MD-CFM:454-156:SLOT-1:1;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"AID>:[MDNAME=<MDNAME>],[LEVEL=<LEVEL>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-7,MDNAME=MD1,LEVEL=4"
;
Table 23-102 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<MDNAME>
Maintenance Domain Name. It is a string. The MD name length should not exceed more than 43 characters.
<LEVEL>
This indicates the level of the maintenance domain. The value ranges from 0 to 7.
23.91 RTRV-MDMAMAP-CFM
The Retrieve Maintenance Domain and Maintenance Association mapping Connectivity Fault Management (RTRV-MDMAMAP-CFM) command retrieves the maintenance domain and maintenance association mapping.
Usage Guidelines
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-MDMAMAP-CFM:[<TID>]:<AID>:<CTAG>:::MDNAME=<MDNAME>;
Input Example
RRTRV-MDMAMAP-CFM::SLOT-4:a;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[MANAME=<MANAME>],[SVLANID=<SVLANID>],[CCENABLE=<CCENABLE>];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-17,MDNAME=MD1,SVLANID=7,MANAME=MA3:"
;
Table 23-103 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<MANAME>
Maintenance Association Name. It is a string. The MA name length should not exceed more than 43 characters.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<CCENABLE>
Enable or disable Continuos Check messaging
•
Enable
•
Disable
23.92 RTRV-MEP-CFM
The Retrieve Maintenance End Point Connectivity Fault Management (RTRV-MEP-CFM) command retrieves the maintenance end points on the port.
Usage Guidelines
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-MEP-CFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-MEP-CFM::ETH-1-1-1:1;
Input Parameters
<AID>
Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[SVLANID=<SVLANID>],[MDNAME=<MDNAME>],
[LEVEL=<LEVEL>],[MPID=<MPID>];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-3-4-1,SVLANID=200,MDNAME=D4,LEVEL=4,MPID=314"
;
Table 23-104 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<MDNAME>
Maintenance Domain Name. It is a string. The MD name length should not exceed more than 43 characters.
<LEVEL>
This indicates the level of the maintenance domain. The value ranges from 0 to 7.
<MPID>
Maintenance Point Identifier. It is an integer.
23.93 RTRV-MEPCCDB-CFM
The Retrieve Maintenance End Point Continuity Check Message Data Base Connectivity Fault Management (RTRV-MEPCCDB-CFM) command retrieves the maintenance end point continuity check message data base on a given slot.
Usage Guidelines
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-MEPCCDB-CFM:[<TID>]:<AID>:<CTAG>:::[MDNAME=<MDNAME>],[VLANIDFROM=<VLANIDFROM>],[VLANIDTO=<VLANIDTO>];
Input Example
RTRV-MEPCCDB-CFM::SLOT-1:1:::MDNAME=D2,VLANIDFROM=99,VLANIDTO=100;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
<MDNAME>
Maintenance Domain Name. It is a string. The MD name length should not exceed more than 43 characters.
<VLANIDFROM>
VLAN range. It is the start of the VLANID. Valid range is from 1 to 4096. It is an optional parameter.
<VLANIDTO>
VLAN range. It is the end of the VLANID. Valid range is from 1 to 4096. It is an optional parameter.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:[MPID=<MPID>],[MACADDR=<MACADDR>],[MDNAME=<MDNAME>],[LEVEL=<LEVEL>],[MANAME=<MANAME>],[INPORT=<INPORT>],[CCLIFETIME=<CCLIFETIME>],[AGEOFLASTCC=<AGEOFLASTCC>],[RMTPORSTATE=<RMTPORTSTATE>];"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1,MPID=301,MACADDR=00:19:07:6C:B7:7A,MDNAME=D2,MANAME=M1,SVLANID=100,INPORT=0,CCLIFETIME=0,AGEOFLASTCC=0:"
;
Table 23-105 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<MPID>
Maintenance Point Identifier. It is an integer.
<MACADDR>
(Optional) The MAC address for the 10 Gigabit Ethernet payload. MACADDR is a string.
<MDNAME>
Maintenance Domain Name. It is a string. The MD name length should not exceed more than 43 characters.
<LEVEL>
This indicates the level of the maintenance domain. The value ranges from 0 to 7.
<MANAME>
Maintenance Association Name. It is a string. The MA name length should not exceed more than 43 characters.
<INPORT>
Ingress port.
<CCLIFETIME>
Indicates the Continuity Check Message Timer Life Time on the receiving end. It indicates how long the interface has to wait for the CC message expiry. It is 3 times the CCTIMER.
<AGEOFLASTCC>
Age of the last CC timer. This indicates the time interval between the present time and the last time CC message received.
<RMTPORSTATE>
Indicates the state of the remote port.
•
Invalid state.
•
Up.
•
Down.
•
Test.
•
Unknown port.
•
In active.
•
Port does not exist.
•
Lower layer is down.
•
Admin is down.
•
Excessive errors on the remote port.
•
Excessive errors on the local port.
23.94 RTRV-MEPSTATS-CFM
The Retrieve Maintenance End Point Statistics Connectivity Fault Management (RTRV-MEPSTATS-CFM) command retrieves the maintenance end point statistics.
Usage Guidelines
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-MEPSTATS-CFM:[<TID>]:<AID>:<CTAG>:::[MDNAME=<MDNAME>],[VLANIDFROM=<VLANIDFROM>],[VLANIDTO=<VLANIDTO>];
Input Example
RTRV-MEPSTATS-CFM::SLOT-4:a;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
<MDNAME>
Maintenance Domain Name. It is a string. The MD name length should not exceed more than 43 characters.
<VLANIDFROM>
VLAN range. It is the start of the VLANID. Valid range is from 1 to 4096. It is an optional parameter.
<VLANIDTO>
VLAN range. It is the end of the VLANID. Valid range is from 1 to 4096. It is an optional parameter.
Output Format
SID DATE TIME
M CTAG COMPLD
"M CTAG COMPLD; "<AID>,<MDNAME>,<SVLANID>,<MPID>,<CCMTRANSMITTED>,<CCMRCVD>,
<CCRCVDSEQERROR>,<LTRUNEXPTDRCVD>,<LBRTRANSMITTED>,
<LBRRCVDINORDER>,<LBRRCVDSEQERROR>,<LBRRCVDBADMSDU>";"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-3,MDNAME=Domain_6,SVLANID=30,MPID=600,CCMTRANSMTD=801,CCMRCVDSEQERR=0,CCRCVDSEQERR=0,LTRUNEXPDRCVD=0,LBRTRANSMTD=0,LBRRCVDINORDER=0,LBRRCVDSEQERR=0,LBRRCVDBADMSDU=0"
;
Table 23-106 Output Parameter Support
<AID>
Access identifier from the "EQPT" section.
<MDNAME >
Maintenance Domain Name. It is a string. The MD name length should not exceed more than 43 characters.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<MPID>
Maintenance Point Identifier. It is an integer.
<CCMTRANSMTD>
Indicates the transmission of continuity check messages.
<CCMRCVD>
Continuity check messages received.
<CCRCVDSEQERR>
Continuity check received with sequence errors.
<LTRUNEXPDRCVD>
Link trace reply received unexpectedly.
<LBRTRANSMTD>
Loopback reply transmitted.
<LBRRCVDINORDER>
Loopback reply received in order.
<LBRRCVDSEQERR>
Loopback reply received with sequence error.
<LBRRCVDBADMSDU>
Loopback reply received with bad MSDU.
23.95 RTRV-MIP-CFM
The Retrieve Maintenance Intermediate Point Connectivity Fault Management (RTRV-MIP-CFM) command retrieves the maintenance intermediate points on the port.
Usage Guidelines
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-MIP-CFM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-MIP-CFM::ETH-1-1-1:1;
Input Parameters
<AID>
Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"M CTAG COMPLD; "<<AID>,<VLANID>,<LEVEL>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-17-1-1,VLANID=6,LEVEL=7"
;
Table 23-107 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<VLANID >
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LEVEL>
This indicates the level of the maintenance domain. The value ranges from 0 to 7.
23.96 RTRV-MIPCCDB-CFM
The Retrieve Maintenance Intermediate Point Continuity Check Message Data Base Connectivity Fault Management (RTRV-MIPCCDB-CFM) command retrieves the continuity check message database (CCDB) of the maintenance intermediate points.
Usage Guidelines
•
•
Category
Equipment
Security
Retrieve
Input Format
RTRV-MIPCCDB-CFM:[<TID>]:<AID>:<CTAG>:::[LEVEL=<LEVEL>],[VLANIDFROM=<VLANIDFROM>],[VLANIDTO=<VLANIDTO>];
Input Example
RTRV-MIPCCDB-CFM::SLOT-1:1:::MDNAME=D2,VLANIDFROM=10,VLANIDTO=100;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
<LEVEL>
This indicates the level of the maintenance domain. The value ranges from 0 to 7.
<VLANIDFROM>
VLAN range. It is the start of the VLANID. Valid range is from 1 to 4096. It is an optional parameter.
<VLANIDTO>
VLAN range. It is the end of the VLANID. Valid range is from 1 to 4096. It is an optional parameter.
Output Format
SID DATE TIME
M CTAG COMPLD
"M CTAG COMPLD; "<<AID>,<MACADDR>,<SVLANID>,<LEVEL>,<INGRESSPORT>,<MPID>,<ARCHIVETIMER"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-4,MACADDR=00:00:00:00:00:00,SVLANID=100,LEVEL=1,INGRESSPORT=0,MPID=300,ARCHIVETIMER=0"
;
<AID>
Access identifier from the "EQPT" section.
<MACADDR>
(Optional) The MAC address for the 10 Gigabit Ethernet payload. MACADDR is a string.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LEVEL>
This indicates the level of the maintenance domain. The value ranges from 0 to 7.
<INGRESSPORT>
Identifies the ingress port.
<MPID>
Maintenance Point Identifier. It is an integer.
<ARCHIVETIMER>
Archive Timer for CCDB. The default value is 0.
Output Parameters
23.97 RTRV-NE-APC
The Retrieve Network Amplification Power Control (RTRV-NE-APC) command retrieves the APC application ports involved in node setup regulation.
Usage Guidelines
None
Category
System
Security
Maintenance
Input Format
RTRV-NE-APC:[<TID>]:[<AID>]:<CTAG>;
Input Example
RTRV-NE-APC:PENNGROVE:CHAN-16-1-RX:114;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section. A null value is equivalent to ALL.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<MOD>::[MODIFDAT=<MODIFDAT>],[MODIFTM=<MODIFTM>],
[CHECKDAT=<CHECKDAT>],[CHECKTM=<CHECKTM>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-16-1-RX,OCH::MODIFDAT=04-11-02,MODIFTM=12-35-00,
CHECKDAT=04-11-02,CHECKTM=12-55-00"
;
Table 23-108 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<MOD>
AID type. The parameter type is MOD2O, which is the facility types for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.
•
100 Gigabit Ethernet.
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
4-Gigabit Fibre Channel payload
•
1.5G HD-SDI video payload.
•
1-Gbps ISC3 peer
•
2-Gbps ISC3 peer
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
Optical Data Unit Level 0
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
270M SDI video payload.
<MODIFDAT>
(Optional) The last date when the APC application modified this port. The format of MODIFDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<MODIFTM>
(Optional) The last time when the APC application modified this port. The format of MODIFTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59.
<CHECKDAT>
(Optional) The last date when the APC application controlled and validated this port. The format of CHECKDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<CHECKTM>
(Optional) The last time when the APC application controlled and validated this port. The format of CHECKTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59.
23.98 RTRV-NE-GEN
The Retrieve Network Element General (RTRV-NE-GEN) command retrieves the general NE attributes.
Usage Guidelines
ETHIPADDR and ETHIPMASK are disabled in this command. ETHIPADDR and ETHIPMASK are used to show the Ethernet interface address and mask. Both default to the node IP address and masks.
Note
Category
System
Security
Retrieve
Input Format
RTRV-NE-GEN:[<TID>]::<CTAG>;
Input Example
RTRV-NE-GEN:CISCO::123;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD "[<IPADDR>],[<IPMASK>],[<DEFRTR>],[<IPV6ADDR>],[<IPV6PREFLEN>],[<IPV6DEFRTR>],[<IPV6ENABLE>],[<IIOPPORT>],[<NTP>],[<NAME>],[<SWVER>],[<LOAD>],[<PROTSWVER>],[<PROTLOAD>],[<DEFDESC>],[<PLATFORM>],[<SECUMODE>],[<SUPPRESSIP>],[<MODE>],[<MSPUBVLANID>],[<MSINTLVLANID>],[<AUTOPM>],[<SERIALPORTECHO>],[<OSIROUTINGMODE>],[<OSIL1BUFSIZE>],[<OSIL2BUFSIZE>],[<NET>],[<BKUPNTP>];Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
IPADDR=192.168.100.52,IPMASK=255.255.255.0,DEFRTR=192.168.100.1, IPV6ADDR="[3ffe:0501:0008:0000:0260:97ff:fe40:efab]",IPV6PREFLEN=64,IPV6DEFRTR="[3ffe:0501:0008:0000:0260:97ff:fe40:e000]",IPV6ENABLE=NO IIOPPORT=57970,NTP=192.168.100.52,NAME="NODENAME",SWVER=2.01.03, LOAD=02.13-E09A-08.15,PROTSWVER=2.01.02,PROTLOAD=02.12-E09A-09.25, DEFDESC=\"NE DEFAULTS FEATURE\",PLATFORM=NCS-ANSI,SECUMODE=NORMAL, SUPPRESSIP=YES,PROXYSRV=N,FIREWALL=N,MSPUBVLANID=1,MSINTLVLANID=2,AUTOPM=NO,SERIALPORTECHO=Y,OSIROUTINGMODE=ES,OSIL1BUFSIZE=512,OSIL2BUFSIZE=512"
;
23.99 RTRV-NE-IMGSIGN
The Retrieve Network Image Signature (RTRV-NE-IMGSIGN) command retrieves the signature details of a given shelf.
Usage Guidelines
None
Category
System
Security
Maintenance
Input Format
RTRV-NE-IMGSIGN:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-NE-IMGSIGN:PENNGROVE:SHELF-1;
Input Parameters
<AID>
Shelf access identifier. AID can be ignored if the command is executed on a single shelf. For a multi-shelf configuration, AID can take a shelf value from 1 to 50 (SHELF-{1-50}).
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[PKGTYPE=<PKGTYPE>],[IMGTYPE=<IMGTYPE>], [CMNNAME=<CMNNAME>,[ORGUNIT=<ORGUNIT>],[ORGNAME=<ORGNAME>],[CERTSN=<CERTSN>],[HASH=<HASH>],[SIGNALGO=<SIGNALALGO>],[KEYVER=<KEYVER>]"
;Output Example
SID DATE TIME
M CTAG COMPLD
"SHELF-1,PKGTYPE=WORKING,IMGTYPE=DEVELOPMENT,CMNNAME=UTS TNC,ORGUNIT=OTBU,ORGNAME=CISCO,CERTSN=10000,HASH=SHA-512,SIGNALGO=RSA-2048,KEYVER=A";Output Parameters
23.100 RTRV-NE-IPMAP
The Retrieve Network Element Internet Protocol Map (RTRV-NE-IPMAP) command retrieves the IP address and node name of the NEs that have the DCC connection with this NE.
Usage Guidelines
This command only reports the active DCC link. If there is no active DCC link on the port (or the node), the command will return COMPLD without IPMAP information.
Category
Network
Security
Retrieve
Input Format
RTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;
Input Example
RTRV-NE-IPMAP:CISCO:FAC-12-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section. The port of an NE carrying the DCC connection. A null value defaults to the whole NE. A null value is equivalent to ALL.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<IPADDR>,<NODENAME>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-12-1:"[3ffe:0501:0008:0000:0260:97ff:fe40:efab]",NODENAME2";
Output Parameters
<AID>
Access identifier from the "FACILITY" section. Port of an NE carrying the DCC connection.
<IPADDR>
Node IP address. IPADDR is a string.
<NODENAME>
Network element name. NODENAME is a string.
23.101 RTRV-NE-KEYINFO
The Retrieve Network Key Information (RTRV-NE-KEYINFO) command retrieves the details of the keys that are stored in a given shelf.
Usage Guidelines
None
Category
System
Security
Maintenance
Input Format
RTRV-NE-KEYINFO:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-NE-KEYINFO:PENNGROVE:SHELF-5:CTAG;
Input Parameters
<AID>
Shelf access identifier. AID can be ignored if the command is executed on a single shelf. For a multi-shelf configuration, AID can take a shelf value from 1 to 50 (SHELF-{1-50}).
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>],[KEYTYPE=<KEYTYPE>],[ PUBKEY=<PUBKEY>,[ EXPN=<EXPN>], [KEYVER=<KEYVER>],[ MOD=<MOD>]"
;Output Example
SID DATE TIME
M CTAG COMPLD
"SHELF-5,KEYTYPE=DEVELOPMENT,PUBKEY=RSA-2048,EXPN=1000,KEYVER=A,MOD=\"0:1:2:3:4:5:6:7:8:9:a:b:c:d:e:f:10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f:20:21:22:23:24:25:26:27:28:29:2a:2b:2c:2d:2e:2f:30:31:32:33:34:35:36:37:38:39:3a:3b:3c:3d:3e:3f:40:41:42:43:44:45:46:47:48:49:4a:4b:4c:4d:4e:4f:50:51:52:53:54:55:56:57:58:59:5a:5b:5c:5d:5e:5f:60:61:62:63:64:65:66:67:68:69:6a:6b:6c:6d:6e:6f:70:71:72:73:74:75:76:77:78:79:7a:7b:7c:7d:7e:7f:80:81:82:83:84:85:86:87:88:89:8a:8b:8c:8d:8e:8f:90:91:92:93:94:95:96:97:98:99:9a:9b:9c:9d:9e:9f:a0:a1:a2:a3:a4:a5:a6:a7:a8:a9:aa:ab:ac:ad:ae:af:b0:b1:b2:b3:b4:b5:b6:b7:b8:b9:ba:bb:bc:bd:be:bf:c0:c1:c2:c3:c4:c5:c6:c7:c8:c9:ca:cb:cc:cd:ce:cf:d0:d1:d2:d3:d4:d5:d6:d7:d8:d9:da:db:dc:dd:de:df:e0:e1:e2:e3:e4:e5:e6:e7:e8:e9:ea:eb:ec:ed:ee:ef:f0:f1:f2:f3:f4:f5:f6:f7:f8:f9:fa:fb:fc:fd:fe:ff";Output Parameters
23.102 RTRV-NE-PATH
The Retrieve Network Element Path (RTRV-NE-PATH) command retrieves the path-level attributes on an NE.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-NE-PATH:[<TID>]::<CTAG>[::::];
Input Example
RTRV-NE-PATH:::CTAG;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"[PDIP=<PDIP>],[XCMODE=<XCMODE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"PDIP=Y,XCMODE=MIXED"
;
23.103 RTRV-NE-SYNCN
The Retrieve Network Element Synchronization (RTRV-NE-SYNCN) command retrieves the synchronization attributes of the NE.
Usage Guidelines
Although mixed mode timing is supported, it is not recommended.
The timing modes are:
•
•
•
Note
Category
Synchronization
Security
Retrieve
Input Format
RTRV-NE-SYNCN:[<TID>]:[<AID>]:<CTAG>[::::];
Input Examples
RTRV-NE-SYNCN:CISCO:SHELF-2:123;
Input Parameters
<AID>
The node or shelf access identifier from the "SHELF" section. If omitted, it addresses the node or first shelf of the node.
Output Format
SID DATE TIME
M CTAG COMPLD
"[<AID>]::[TMMD=<TMMD>],[QRES=<QRES>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SYSTMN=<SYSTMN>]"
;Output Examples
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SHELF-2::TMMD=LINE,QRES=ABOVE-PRS,RVRTV=Y,RVTM=8.0,
SYSTMN=NCS"
;
Table 23-111 Output Parameter Support
<AID>
(Optional) The node or shelf access identifier from the "SHELF" section. If omitted, it addresses the node or first shelf of the node.
<TMMD>
(Optional) Timing mode. The parameter type is TIMING_MODE, which is the timing mode for the current node.
•
The node derives its clock from the BITS input.
•
The node derives its clock from the NCS lines.
•
The node derives its clock from the mixed timing mode.
<SSMGEN>
(Optional) Synchronization status message generator. The parameter type is SYNC_GENERATION, which is the synchronization status message set generation.
•
First generation SSM set
•
Second generation SSM set
<QRES>
(Optional) Quality of the RES. The parameter type is SYNC_QUALITY_LEVEL, which is the network synchronization quality level.
•
Better than Primary Reference Source. Valid setting for Generation-1 and Generation-2 SSM Set.
•
Between ST2 and STU. Valid setting for Generation-1 and Generation-2 SSM Set.
•
For Generation-1 SSM set, between ST3 and ST2. For Generation-2 SSM set, between ST3 and ST3E.
•
Between ST3E and TNC. Valid setting only for Generation-2 SSM set.
•
Between ST4 and ST3. Valid setting for Generation-1 and Generation-2 SSM Set.
•
Between STU and PRS. Valid setting for Generation-1 and Generation-2 SSM Set. This is Default Setting.
•
Between TNC and ST2. Valid setting only for Generation-2 SSM set.
•
Below ST4 but still usable. Valid setting for Generation-1 and Generation-2 SSM Set.
•
Disable the RES message by equating it to DUS. Valid setting for Generation-1 and Generation-2 SSM Set.
<RVRTV>
(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
•
Does not revert service to original line after restoration.
•
Reverts service to original line after restoration.
<RVTM>
(Optional) Revertive time. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<SYSTMN>
Identifies the system timing standard used by the node.
•
SONET timing standard
•
NCS timing standard
23.104 RTRV-NE-WDMANS
The Retrieve Network Element Wavelength Division Multiplexing Automatic Node Setup (RTRV-NE-WDMANS) command retrieves the optical node setup (WDMANS) application ports involved in node setup regulation.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-NE-WDMANS:[<TID>]::<CTAG>;
Input Example
RTRV-NE-WDMANS:PENNGROVE::114;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>::[REGULATED=<REGULATED>],[PARAM=<PARAM>],[<VALUE>],[<ACTOR>],[<DATE>],[<TIME>]:"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-16-1-RX,OCH::REGULATED=OUT-OF-RANGE,PARAM=AMPLMODE"
;
Table 23-112 Output Parameter Support
<AID>
Access identifier from the "ALL" section. AID is port regulated.
<AIDTYPE>
Specifies the type of facility, link, or other addressable entity targeted by the message. A type of access identifier. The parameter type is MOD2, which is the line/path modifier.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit fiber connectivity payload
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
2-Gigabit ISC3 compatible
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Channel group
•
D1 video
•
DS3i-N-12 line
•
DV6000
•
E1
•
E3
•
E4 frame. Only applicable to STM1E Port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
•
ESCON
•
ETRCLO
•
FSTE facility
•
G1000 facility
•
GFP over POS. Virtual ports partitioned using GFP's multiplexing capability.
•
Gigabit Ethernet
•
High-level data link control (HDLC) frame mode.
•
HDTV
•
1.5G HD-SDI video payload.
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical Channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port
•
Resilient Ethernet Protocol
•
270M SDI video payload.
•
STM1 facility
•
STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of the NCS STM1E-12 card.
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
VC3 path
•
VC4-4C path
•
VC3-8C path
•
VC4-64C path
•
VC4-8C path
•
VC4 path
•
VC4-16C path
•
VC4-2C path
•
VC4-3C path
•
VC11 path
•
VC12 path
<REGULATED>
(Optional) The status of the port after a node setup regulation. The parameter type is REGULATED_PORT_TYPE, which is the optical configuration types for NEs.
•
WDM-ANS encountered a failure while regulating this port.
•
Missing input power parameter.
•
Missing output power parameter.
•
WDM-ANS does not foresee any algorithm or does not have any value to set for the parameter.
•
WDM-ANS cannot modify the setpoint because the calculated value is out of the allowed range.
•
WDM-ANS cannot modify the setpoint because the ports are in Unlocked state.
•
WDM-ANS has successfully regulated this port.
•
WDM-ANS has not changed this port.
<ACTOR>
Regulator Actor is the name of the Network Element application that regulates the WDM-ANS parameter. The parameter type is REGULATED_ACTOR.
•
Parameter regulated by the ANS application.
•
Parameter regulated by the APC application.
•
Parameter regulated by the OCHNC application.
•
Parameter regulated by the RAMAN Wizard application.
•
The parameter that has been regulated by an unknown application.
<PARAM>
(Optional) The regulated parameter inside of the specified port. The parameter type is REGULATED_PARAM_NAME, which is name of the parameter regulated by the WDMANS application.
•
WDM-ANS has regulated the amplifier control mode parameter.
•
WDM-ANS has regulated the amplifier per the channel power parameter.
•
WDM-ANS has regulated the amplifier gain parameter.
•
WDM-ANS has regulated the OPWR-LFAIL threshold parameter.
•
WDM-ANS has regulated the amplifier tilt reference parameter.
•
WDM-ANS has regulated the VOA attenuation reference parameter.
•
WDM-ANS has regulated the VOA power reference parameter.
•
WDM-ANS has regulated the port P-Dark power.
•
WDM-ANS regulated the port VOA startup.
•
Node setup port attribute. Total power in dBm.
•
Node setup port attribute. Total power in mW.
•
Optical power setting, channel power setting.
•
Optical power setting, low threshold in dBm.
•
Optical power setting, low threshold in mW.
•
Optical power setting ratio.
•
Optical power setting in dBm.
•
Optical power setting in mW.
<DATE>
Identifies the date. Date is a string. Default value is - current date.
<TIME>
Identifies the time. Time is a string. Default value is - current time.
23.105 RTRV-NETYPE
The Retrieve Network Element Type (RTRV-NETYPE) command retrieves the NE's equipment-related information.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-NETYPE:[<TID>]::<CTAG>;
Input Example
RTRV-NETYPE:GAUR1::1;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"<VENDOR>,<MODEL>,<NETYPE>,<SW_ISSUE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CISCO,NCS,ADM&MSPP&MSTP,5.00.00"
;
23.106 RTRV-NNI-CHGRP
The Retrieve Network-to-Network Interface Channel Group (RTRV-NNI-CHGRP) command retrieves the NNI selective S-VLAN-ID table associated to a channel group.
Usage Guidelines
This command accepts the ALL AID.
Category
Channel Group
Security
Retrieve
Input Format
RTRV-NNI-CHGRP:[<TID>]:<AID>:<CTAG>::[<SVLANID>][::];
Input Example
RTRV-NNI-CHGRP:TID:CHGRP-1-1:1::110;
Input Parameters
<AID>
Access identifier from the "CHGRP" section.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SVLANID>[::]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-1-1-1:110::"
;Output Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
23.107 RTRV-NNI-ETH
The Retrieve Network-to-Network Interface Ethernet (RTRV-NNI-ETH) command retrieves the NNI selective S-VLAN-ID table associated to an L2 Ethernet port.
Usage Guidelines
This command accepts the ALL AID.
Category
Ethernet
Security
Retrieve
Input Format
RTRV-NNI-ETH:[<TID>]:<AID>:<CTAG>::[<SVLANID>][::];
Input Example
RTRV-NNI-ETH:PETALUMA:ETH-1-1-1:CTAG::110;
Input Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SVLANID>[::]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-1-1-1:110::"
;Output Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
23.108 RTRV-OCM
The Retrieve Optical Channel Monitoring (RTRV-OCM) command retrieves the optical channel monitoring parameters present at OCH layer in a ROADM node.
Usage Guidelines
•
Category
NCS
Security
Retrieve
Input Format
RTRV-OCM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OCM::OCM-1-16-1-RX-1530.33:12;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
SID DATE TIME
M CTAG COMPLD"[<aid>]::[CHPOWER=<CHPOWER>];
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
" TID-000 1998-06-20 14:30:00M 001 COMPLD "OCM-1-16-1-RX-1530.33::CHPOWER=9.0";
Table 23-114 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<CHPOWER>
(Optional) The per channel optical power. Applicable only to amplified OTS ports.
23.109 RTRV-OCH
The Retrieve Optical Channel (RTRV-OCH) command retrieves the attributes (service parameters) and state of an OCH facility.
Usage Guidelines
•
•
Category
NCS
Security
Retrieve
Input Format
RTRV-OCH:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OCH:PENNGROVE:CHAN-6-2:236;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[<OPTICALPORTTYPE>],[<POWER>],[<EXPWLEN>],[<ACTWLEN>],[<ILOSS>],[<VOAMODE>],[<VOAATTN>],[<VOAPWR>],[<VOAREFATTN>],[<VOAREFPWR>],[<REFOPWR>],[<CALOPWR>],[<CHPOWER>],[<CHPOWERFLG>],[<ADDOPWR>],[<PORTNAME>],[<GCC>],[<GCCRATE>],[<DWRAP>],[<FEC>],[<PAYLOADMAP>],[<LBCLCURR>],[<OPTCURR>],[<OPRCURR>],[<OSFBER>],[<OSDBER>],[<SOAK>],[<SOAKLEFT>],[<LOSSB>],[<PEERID>],[<REGENNAME>],[<PORTMODE>],[<ODUTRANSMODE>],[<ERRORDECORRELATOR>],[<FCS>],[<PROACTPROTECTION>],[<TRIGGERTH>],[<REVERTTH>],[<TRIGWINDOW>],[<RVRTWINDOW>],[<OVRCLK>],[<MDLTFMT>],[<RXWLEN>],[<OSNR>],[<PMD>],[<CHROMDISP>],[<SYNCMSG>],[<SENDDUS>],[<ADMSSM>],[<PROVIDESYNC>]:<SQUELCHMODE>,[<FECALARMSUPRESS>],[<CDLOW>],[<CDHIGH>],[<SOPMDCURR>],[<PCRCURR>],[<PDLCURR>]:<VOATXPOWER>,[<TXLASERSHUTDN>]:[<PST>][<SST>]"
;Output Example
100g 2012-05-22 12:31:55
M 1 COMPLD
"CHAN-3-2:,,WORK,STBY:EXPWLEN=USE-TWL1,GCC=N,DWRAP=Y,FEC=STD,OSFBER=1E-5,OSDBER=1E-7,SOAK=32,PORTMODE=NCS-TRANS-AIS,RXWLEN=USE-TWL1,SYNCMSG=N,SENDDUS=N,ADMSSM=STU,SQUELCHMODE=ODU-AIS,,CDLOW=-70000.0,CDHIGH=70000.0,VOATXPOWER=0.25,TXLASERSHUTDN=N:OOS-MA,DSBLD"
Table 23-115 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<ROLE>
(Optional) Identifies an OCH port role. The parameter type is SIDE, which is the role the unit is playing in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
<STATUS>
(Optional) The port status. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<OPTICALPORTTYPE>
The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
•
The signal is added to the port.
•
Common Port
•
The signal is dropped from the port.
•
Express/Add/Drop port
•
Logical port on Raman CTP card.
•
COM channels (without OSC) that continue the signal from the previous card
•
Input DCU port
•
IN-DEG optical port type
•
Rx managed port on Raman CTP card used for span continuity check.
•
The express channel that continues the signal from the previous card
•
All the channels that continue the signal from the previous card
•
OSC channel that continues the signal from the previous card
•
IN-UPG optical port type
•
COM channels (without OSC) that continue the signal to the next card
•
Output DCU port
•
OUT-DEG optical port type
•
Tx managed port on Raman CTP card used for span continuity check.
•
Express channel that continues the signal to the next card
•
All the channels that continue the signal to the next card
•
OUT-EDRA-PUMP optical port type
•
OUT-UPG optical port type
•
PORT optical port type
<ACTWLEN>
(Optional) The manufacturing optical wavelength for this port. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x. The parameter type is OPTICAL_WLEN, which is the optical wavelength.
<EXPWLEN>
(Optional) Optical wavelength for this port. Applicable only to the following types of cards: optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and optical add/drop multiplexing (OADM) cards. The parameter type is OPTICAL_WLEN, which is the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.16
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.72
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.11
•
Wavelength 1548.51
•
Wavelength 1548.91
•
Wavelength 1549.32
•
Wavelength 1549.72
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
The parameter type is REACH, which indicates the reach values.
•
100GBASE-LR4
•
100GBASE-SR10
•
40GBASE-FR
•
40GBASE-LR4
•
Reach supported on 40GIGE payload on CFP-LC card.
•
4I1-9D1F
•
C4S1-2D1
•
FE-BX
•
FX
•
GE-BX
•
GE-EX
•
LX-10
•
TEN-GE-LRM
•
TEN-GE-ZR
•
VSR2000-3R2
•
Autoprovisioning
•
CWDM 40 km
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach ULH
•
Reach VSR
•
Reach VX
•
Reach ZX
<ILOSS>
(Optional) Insertion loss expressed in dBm. ILOSS applies to output ports only on the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x. ILOSS is a string.
<VOAATTN>
(Optional) The transit power attenuation for the VOA expressed in dBm. The range is -24.0 to +2.0 dBm for the MXP_2.5G_10G and TXP_MR_10G cards. VOAATTN is a string.
<VOAPWR>
(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x. VOAPWR is a float and a string.
<VOAREFATTN>
(Optional) The value of reference attenuation for the VOA. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x. VOAREFATTN is a float and a string.
<VOAREFPWR>
(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x. VOAREFPWR is a float and a string.
<REFOPWR>
(Optional) The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. Applicable only to the following cards: OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x. REFOPWR is a float and a string.
<PORTNAME>
(Optional) Port name. PORTNAME is a string.
<FCS>
(Optional) First Circuit Startup. An automatic channel startup that operates the VOA when the light is detected on the ingress port.
•
Automatic Channel startup enabled.
•
Automatic Channel startup disabled.
<PROACTPROTECTION>
To enable or disable the protective protection on the card.
<CALOPWR>
(Optional) The value of the calibrated optical power expected for the line added to the calculated value, which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. CALOPWR is a float.
<CHPOWERFLG>
(Optional) Parameter status flag indicating the state of the channel power.
<ADDOPWR>
(Optional) The value of the ADD optical power to an ADD port of the WSS card. The ADDOPWR is a float.
<GCC>
Identifies the generic communication channel (GCC) connection of the port.
•
GCC can be utilized.
•
GCC cannot be utilized.
<GCCRATE>
(Optional) The data rate of the GCC traffic. The default is 192 Kbps. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the NCS port. The parameter type is GCCRATE, which is the data rate of the GCC traffic.
•
192 Kbps
•
400 Kbps
•
576 Kbps
<DWRAP>
(Optional) The ITU-T G.709 monitoring digital wrapper. It is either on or off. The system default is ON. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the NCS port. The parameter type is ON_OFF (disable or enable an attribute). To enable ITU-T G.709 monitoring, there should be no GCC on the NCS port and the payload (in which the card is configured) should not be UNFRAMED. To disable ITU-T G.709 monitoring, there should be no GCC on the NCS port, the FEC should be turned to off, there should be no overhead circuit created on the NCS port, and none of the client ports on the card should be part of a Y-cable protection group (muxponder only).
•
Disable an attribute.
•
Enable an attribute.
<PAYLOADMAP>
(Optional) The type of payload mapping. It can be enabled only if ITU-T G.709 monitoring is turned ON and FEC is enabled. The parameter type is PAYLOAD_MAPPING, which is the payload mapping mode.
•
Asynchronous mapping mode
•
ODU multiplex structure mode
•
Synchronous mapping mode
•
Mapping with no FIXEDSTUFF
<FEC>
(Optional) Forward error correction. It can be enabled only if ITU-T G.709 monitoring is turned ON. It is either off or enabled in standard or enhanced mode. The system default is standard FEC enabled. The FEC level PM and thresholds apply if the FEC is turned ON. The parameter type is FEC_MODE, which specifies the type of forward error correction.
•
Enhanced FEC is enabled.
•
Enhanced FEC 1.4 is enabled.
•
Enhanced FEC 1.7 is enabled.
•
20 % Enhanced FEC supported on fixed trunk port of 100G-LC-C card.
•
High Gain 7% FEC.
•
FEC is disabled.
•
Standard FEC is enabled.
<PRE-FEC-PSM>
The parameter type is PROACTIVE_PROT.
•
Proactive protection is disabled.
•
Proactive protection is enabled.
<PEERID>
Indicates the peer trunk facility of the regeneration group on the OTU2-XP card. Accessed using the CHAN AID.
<REGENNAME>
Indicates the name of a regeneration group. Applicable only to NCS flavored cards, which support regeneration group. Regenname is a string. The default value is "NULL".
<PORTMODE>
Describes the termination mode of each interface on the OTU2-XP card.
•
Line terminating mode.
•
Section terminating mode.
•
Transparent mode AIS.
•
Transparent mode squelch.
•
10G LAN to WAN Squelch.
<ODUTRANSMODE>
To configure the "ODUk OH" transparency on the OTU2-XP card.
•
Cisco Extended. When the Cisco Extended configuration is selected, two bytes of the ODU layer is terminated to guarantee the interoperability with the older Transponder/Muxponder cards.
•
Transparent Standard Use. The transponder, behaving as a regenerator, terminates the OUT layer and is transparent to the ODU layer. Also in this case the FEC-MISM (FEC Mismatch) alarm is not generated.
<ERRORDECORRELATOR>
Indicates the presence of the MLSE modules on the card. This applies only to TXP_MR_10EX_C, MXP_2.5G_10EX_C, and MXP_MR_10DMEX_C cards
•
Indicates that the MLSE module is enabled on the card.
•
Indicates that the MLSE module is disabled on the card.
<TRIGGERTH>
Specifies the trigger threshold value for Proactive Protection Regen. The parameter type is TRIGGER_THRESHOLD.
•
Trigger threshold is 1E-2.
•
Trigger threshold is 1E-3.
•
Trigger threshold is 1E-4.
•
Trigger threshold is 1E-5
•
Trigger threshold is 1E-6.
•
Trigger threshold is 1E-7.
•
Trigger threshold is 2E-2.
•
Trigger threshold is 2E-3.
•
Trigger threshold is 2E-4.
•
Trigger threshold is 2E-5.
•
Trigger threshold is 2E-6.
•
Trigger threshold is 2E-7.
•
Trigger threshold is 3E-2.
•
Trigger threshold is 3E-3.
•
Trigger threshold is 3E-4.
•
Trigger threshold is 3E-5.
•
Trigger threshold is 3E-6.
•
Trigger threshold is 4E-7.
•
Trigger threshold is 4E-2.
•
Trigger threshold is 4E-3.
•
Trigger threshold is 4E-4.
•
Trigger threshold is 4E-5.
•
Trigger threshold is 4E-6.
•
Trigger threshold is 4E-7.
•
Trigger threshold is 5E-2.
•
Trigger threshold is 5E-3.
•
Trigger threshold is 5E-4.
•
Trigger threshold is 5E-5.
•
Trigger threshold is 5E-6.
•
Trigger threshold is 5E-7.
•
Trigger threshold is 6E-2.
•
Trigger threshold is 6E-3.
•
Trigger threshold is 6E-4.
•
Trigger threshold is 6E-5
•
Trigger threshold is 6E-6.
•
Trigger threshold is 6E-7.
•
Trigger threshold is 7E-2.
•
Trigger threshold is 7E-3.
•
Trigger threshold is 7E-4.
•
Trigger threshold is 7E-5
•
Trigger threshold is 7E-6.
•
Trigger threshold is 7E-7.
•
Trigger threshold is 8E-2.
•
Trigger threshold is 8E-3.
•
Trigger threshold is 8E-4.
•
Trigger threshold is 8E-5
•
Trigger threshold is 8E-6.
•
Trigger threshold is 8E-7.
•
Trigger threshold is 9E-2.
•
Trigger threshold is 9E-3.
•
Trigger threshold is 9E-4.
•
Trigger threshold is 9E-5
•
Trigger threshold is 9E-6.
•
Trigger threshold is 9E-7.
<REVERTTH>
Specifies the revert threshold for Proactive Protection Regen. The parameter type is RVRTTH.
•
Revert threshold is 1E-3.
•
Revert threshold is 1E-4.
•
Revert threshold is 1E-5.
•
Revert threshold is 1E-6.
•
Revert threshold is 1E-7.
•
Revert threshold is 2E-3.
•
Revert threshold is 2E-4.
•
Revert threshold is 2E-5
•
Revert threshold is 2E-6.
•
Revert threshold is 2E-7.
•
Revert threshold is 3E-3.
•
Revert threshold is 3E-4.
•
Revert threshold is 3E-6.
•
Revert threshold is 4E-4.
•
Revert threshold is 4E-4.
•
Revert threshold is 4E-5
•
Revert threshold is 4E-6.
•
Revert threshold is 4E-7.
•
Revert threshold is 5E-3.
•
Revert threshold is 5E-4.
•
Revert threshold is 5E-5
•
Revert threshold is 5E-6.
•
Revert threshold is 5E-7.
•
Revert threshold is 5E-8.
•
Revert threshold is 6E-3.
•
Revert threshold is 6E-4.
•
Revert threshold is 6E-5
•
Revert threshold is 6E-6.
•
Revert threshold is 6E-7.
•
Revert threshold is 6E-8.
•
Revert threshold is 7E-3.
•
Revert threshold is 7E-4.
•
Revert threshold is 7E-5
•
Revert threshold is 7E-6.
•
Revert threshold is 7E-7.
•
Revert threshold is 7E-8.
•
Revert threshold is 8E-3.
•
Revert threshold is 8E-4.
•
Revert threshold is 8E-5
•
Revert threshold is 8E-6.
•
Revert threshold is 8E-7.
•
Revert threshold is 8E-8.
•
Revert threshold is 9E-3.
•
Revert threshold is 9E-4.
•
Revert threshold is 9E-5
•
Revert threshold is 9E-6.
•
Revert threshold is 9E-7.
•
Revert threshold is 9E-8.
<OVRCLK>
Indicates whether the optical trunk is over-clocked or not. It can be Y or N. The default is N.
•
Indicates the D-QPSK modulation format.
•
Indicates the QPSK modulation format.
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects.
•
Squelch is disabled.
•
AIS
•
Squelch is enabled.
•
No Squelch.
•
ODU AIS.
•
G-AIS
•
NOS
<RXWLEN>
The RX wavelength. It is applicable in unidirectional regeneration mode of a muxponder card. In this case the RX wavelength can be different from the nominal TX wavelength (EXPWLEN). It can be any valid NCS wavelength value. The default value is USE-TWL1.
<OSNR>
Measure of the optical signal to noise ration
<PMD>
Measure of the polarization mode value, an average of the 2 polarization modes.
<CHROMDISP>
Alarm raised when receiver fails in compensating the excessive PMD.
<FECALARMSUPRESS>
FECALARMSUPRESS
<CDLOW>
(Optional) Lower limit of CD working range.
<CDHIGH>
(Optional) Upper limit of CD working range.
<SOPMDCURR>
(Optional) Indicates the current value of second order polarization dispersion mode on the fixed trunk of 10x10G-LC card.
<PCRCURR>
(Optional) Indicates the current value of polarization change rate on fixed trunk of 10x10G-LC card.
<PDLCURR>
(Optional) Indicates the current value of polarization dependent loss on the fixed trunk of 10x10G-LC card.
<VOATXPOWER>
(Optional) VOA Transmit Power. The parameter type is VOATXPOWER, indicates the VOA transmit power on the fixed trunk.
<TXLASERSHUTDN>
(Optional) Transmit Laser Shut down. The parameter type is TXLASERSHUTDN indicates the transmit laser shut down status as Y or N.
<PST_PSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In Service and Normal
•
Out of Service and Autonomous
•
Out of Service and Autonomous Management
•
Out of Service and Management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic In-Service
•
Disabled
•
Loopback
•
Mismatch of Equipment
•
Maintenance
•
Out of Group
•
Software Download
•
Unassigned
•
Unequipped
23.110 RTRV-OCHCC
The Retrieve Optical Channel Client Connection (RTRV-OCHCC) command retrieves the OCH client connection provisioning information.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-OCHCC:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-OCHCC:VA454-22:FAC-2-1-1:116;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[<PAYLOAD>],[<CKTID>],[<ODU1START>],[<ODU1END>],[<TSSTART>],[<TSEND>],[<ODU0START>],[<ODU0END>]:<PST>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-3-1-1::PAYLOAD=GIGE,ODU1START=1,ODU1END=1,ODU0START=1,ODU0END=1:IS-NR,"
;
Table 23-116 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<PAYLOAD>
(Optional) Indicates the payload of the connection which is equivalent to the type of the payload configured on the facility port where the connection is originated or terminated. The parameter type is MOD1PAYLOAD.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit fiber connectivity payload
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
2-Gigabit ISC3 compatible
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
D1Video payload
•
DV6000 payload
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
EC1 payload
•
ESCON payload
•
ETRCLO payload
•
1-Gigabit Ethernet payload
•
1.5G HD-SDI video payload.
•
HDTV payload
•
ISC1 payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
Optical Data Unit Level 0
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
270M SDI video payload.
•
STM4 payload
•
STM64 payload
•
STM1 payload
•
STM16 payload
•
STM256 payload
•
DS3 payload
<CKTID>
(Optional) Cross-connect ID. The default is Blank or None. String of ASCII characters. Maximum length is 48. If CKTID is empty or null the CKTID field will not be displayed.
<ODU1START>
ODU1 Start
<ODU1END>
ODU1 End
<TSSTART>
Time Slot Start
<TSEND>
Time Slot End
<ODU0START>
(Optional) ODU0 Start.
<ODU0END>
(Optional) ODU0 End
<PSTPSTQ>
Service state. The parameter is PST_PSTQ, which provides the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
23.111 RTRV-OCHNC
The Retrieve Optical Channel Network Connection (RTRV-OCHNC) command retrieves the OCH wavelength connection provisioning information.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-OCHNC:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OCHNC:VA454-22:CHANWL-1-3-TX-1530.33:116;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
(For legacy package)
SID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<WCT>:[CKTID=<CKTID>]::<PSTPSTQ>"
;(For flex package)
SID DATE TIME
M CTAG COMPLD
"<SRC>,<DST>:<WCT>:[CKTID=<CKTID>],[WLOPWR],[OPWR],[VOAATTN],[FREQ],[WIDTH],[DSPWROFS],[USPWROFS]::<PSTPSTQ>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHANWL-1-3-TX-1530.33,
LINEWL-4-1-RX-1530.33:1WAY:CKTID=\"OCHNC-1\":UNLOCKED-ENABLED"
;
Table 23-117 Output Parameter Support
<SRC>
Source access identifier from the "CHANNEL" section. In two-way wavelength connection sources, both directions need to be indicated.
<DST>
Destination access identifier from the "LINEWL" section. In two-way wavelength connection sources, both directions need to be indicated.
<WCT>
Wavelength connection type. The parameter type is WCT. The default is 1WAY.
•
A unidirectional wavelength connection for one specified ring direction.
•
A bidirectional wavelength connection for both the ring directions.
<CKTID>
(Optional) Cross-connect ID. The default is Blank or None. String of ASCII characters. Maximum length is 48. If CKTID is empty or null the CKTID field will not be displayed.
<WLOPWR>
The value of calibrated output power that the VOA is going to set as a result of its attenuation. WLOPWR is a float.
<OPWR>
Optical power.
<VOAATTN>
The value of calibrated attenuation for the VOA expressed in dBm. The range is 0.0 to +30.0. VOAATTN is a float.
<FREQ>
Optical wavelength
<WIDTH>
Width
<DSPWROFS>
Down stream power offset.
<USPWROFS>
Up stream power offset.
<PSTPSTQ>
Service state. The parameter is PST_PSTQ, which provides the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
23.112 RTRV-ODU0
The Retrieve Optical Data Unit Level 0 (RTRV-ODU0) command retrieves the list of ODU0 entities on the AR-XPE card.
Usage Guidelines
•
•
•
Category
NCS
Security
Retrieve
Input Format
RTRV-ODU0:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-ODU0::ODU0-2-2-1-1-1:1;
Input Parameters
<AID>
ODU0 from the "ALL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ODU0-2-2-1-1-1"
;
Table 23-118 Output Parameter Support
<AID>
ODU0 from the "ALL" section.
23.113 RTRV-OMS
The Retrieve Optical Multiplex Section (RTRV-OMS) command retrieves the attributes (service parameters) and state of an OMS facility.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-OMS:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OMS:PENNGROVE:BAND-6-1-RX:236;
Input Parameters
<AID>
Access identifier from the "BAND" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>],
EXPBAND=<EXPBAND>,[ACTBAND=<ACTBAND>],[ILOSS=<ILOSS>],
[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>],[VOAPWR=<VOAPWR>],
[VOAREFATTN=<VOAREFATTN>],[VOAREFPWR=<VOAREFPWR>],
[REFOPWR=<REFOPWR>],[CALOPWR=<CALOPWR>],[CHPOWER=<CHPOWER>],
[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BAND-6-1-RX::RDIRN=W-E,OPTYPE=ADD,OPWR=10.0,EXPBAND=1530.33-1532.68,
ACTBAND=1530.33-1532.68,ILOSS=1.0,VOAMODE=ATTN,VOAATTN=0.5,
VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,REFOPWR=10.5,CALOPWR=0.5,
CHPOWER=2.0,NAME=\"OMS PORT\":UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-119 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<RDIRN>
Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<OPTICALPORTTYPE>
The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
•
The signal is added to the port.
•
Common Port
•
The signal is dropped from the port.
•
Express/Add/Drop port
•
Logical port on Raman CTP card.
•
COM channels (without OSC) that continue the signal from the previous card
•
Input DCU port
•
IN-DEG optical port type
•
Rx managed port on Raman CTP card used for span continuity check.
•
IN-UPG optical port type
•
The express channel that continues the signal from the previous card
•
All the channels that continue the signal from the previous card
•
OSC channel that continues the signal from the previous card
•
COM channels (without OSC) that continue the signal to the next card
•
Output DCU port
•
OUT-DEG optical port type
•
Tx managed port on Raman CTP card used for span continuity check.
•
OUT-EDRA-PUMP optical port type
•
Express channel that continues the signal to the next card
•
All the channels that continue the signal to the next card
•
OSC channel that continue the signal to the next card
•
OUT-UPG optical port type
•
PORT optical port type
<POWER>
(Optional) The optical power measured at this port. It can be the input or output power according to port type. POWER is a string.
<EXPBAND>
The expected value of band for this port. The parameter type is OPTICAL_BAND (optical band).
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit.
<ACTBAND>
(Optional) Identifies the manufacturing optical band (group of four contiguous wavelengths) for this port. The parameter type is OPTICAL_BAND (optical band).
•
Band 1
•
Band 2
•
Band 3
•
Band 4
•
Band 5
•
Band 6
•
Band 7
•
Band 8
•
This band is not yet configured/retrieved from unit.
<ILOSS>
(Optional) Insertion loss expressed in dBm. ILOSS applies to output ports only.
<VOAMODE>
(Optional) The working control mode of the VOA. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
•
VOA has a fixed attenuation.
•
VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>
(Optional) The value of calibrated attenuation for the VOA. VOAATTN is a float and a string.
<VOAPWR>
(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. VOAPWR is a float and a string.
<VOAREFATTN>
(Optional) The value of reference attenuation for the VOA. VOAREFATTN is a float and a string.
<VOAREFPWR>
(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. VOAREFPWR is a float and a string.
<REFOPWR>
(Optional) The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. REFOPWR is a float and a string.
<CALOPWR>
(Optional) The value of the calibrated optical power expected for the output added to the calculated value which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. CALOPWR is a float and a string.
<CHPOWER>
(Optional) The per channel optical power. The parameter type is REVERTIVE_TIME (revertive time).
•
Revertive time is 0.5 to 12.0 minutes.
<NAME>
(Optional) Facility name. NAME is a string.
<PSTPSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.114 RTRV-OPM
The Retrieve Optical Monitoring Parameter (RTRV-OPM) command retrieves the optical power monitoring parameters present at the OCH layer in a reconfigurable OADM (ROADM) node.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-OPM:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OPM:VA454-22:OPM-5-1530.33:116;
Input Parameters
<AID>
Access identifier from the "OPM" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[POWEROUT=<POWEROUT>],[POWERADD=<POWERADD>],
[POWERPT=<POWERPT>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"OPM-5-1530.33::POWEROUT=9.0,POWERADD=10.0,POWERPT=11.0:"
;
Table 23-120 Output Parameter Support
<AID>
Access identifier from the "OPM" section.
<POWEROUT>
(Optional) The value of the output power associated to the add or pass-through channel port of the 32WSS card. POWEROUT is a float.
<POWERADD>
(Optional) The value of the input power associated to the add channel port of 32WSS card. POWERADD is mutually exclusive with the POWERPT parameter. POWERADD is a float.
<POWERRPT>
(Optional) The value of the input power associated to the pass-through channel port of 32WSS card. POWERPT is mutually exclusive with the POWERADD parameter. POWERRPT is a float.
23.115 RTRV-OPMODE
The Retrieve Operation Mode (RTRV-OPMODE) command retrieves the operation modes created on that node. In Trunkport list, the first port number indicates the working port and second port number indicates the protect port number.
Usage Guidelines
•
•
•
•
•
–
–
Category
NCS
Security
Provisioning
Input Format
RTRV-OPMODE:[<TID>]:<aid>:<CTAG>;
Input Example
RTRV-OPMODE::SLOT-2:1;
Input Parameters
<AID>
Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
<AID>,[<OPMODE>],[<PEERSLOTS>],[<TRUNKPORTS>],[<CLIENTPORTS>],[<RATE>],[<CTMAP>]
;
Output Example
100g 2012-05-22 12:39:49
M 1 COMPLD
"SLOT-2,OPMODE=CFP-TXP,PEERSLOTS=SLOT-3,"
"SLOT-3,OPMODE=CFP-TXP,PEERSLOTS=SLOT-5&SLOT-2,CLIENTPORTS=1&2,"
"SLOT-5,OPMODE=CFP-TXP,PEERSLOTS=SLOT-3,"
Output Parameters
23.116 RTRV-OPMOD-PTSYS
The Retrieve Operation Mode Packet Transport System (RTRV-OPMOD-PTSYS) command retrieves the operation mode of the CPT 50 panel.
Usage Guidelines
This command is valid for PTSYS. Retrieves the operation mode of the PTSYS.
Category
Equipment
Security
Retrieve
Input Format
RTRV-OPMOD-PTSYS:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OPMOD-PTSYS::ALL:1;
Input Parameters
<AID>
PTSYS AID. Access identifier from the "EQPT" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<PTSYS AID>:<MODE>";Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"PTSYS-1:NMS";
23.117 RTRV-OTS
The Retrieve Optical Transport System (RTRV-OTS) command retrieves the attributes (service parameters) and state of an OTS facility.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-OTS:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-OTS:PENNGROVE:LINE-6-1-RX:236;
Input Parameters
<AID>
Access identifier from the "LINE" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:<OPTICALPORTTYPE>,[<POWER>],[<OSCPWR>],[<ILOSS>],[<VOAMODE>],[<VOAATTN>],[<VOAPWR>],[<VOAREFATTN>],[<VOAREFPWR>],[<OSRI>],[<AMPLMODE>],[<AMPLMODEFLG>],[<CHPOWER>],[<CHPOWERFLG>],[<GAIN>],[<EXPGAIN>],[<EXPGAINFLG>],[<REFOPWR>],[<OFFSET>],[<REFTILT>],[<REFTILTFLG>],[<CALTILT>],[<ASEOPWR>],[<DCULOSS>],[<AWGST>],[<HEATST>],[<NAME>],[<SOAK>],[<SOAKLEFT>],[<WRKCHANNELS>],[<RATIO>],[<RAMAN_STATUS>],[<RAMAN_QUALITY>],[<TIME>],[<DATE>],[<RAMAN_RESTORE_FC>],[<TIME_FC>],[<DATE_FC>],[<FG>],[<CG>],[<SWSTATE>]:<PST>,[<SST>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"LINE-6-1-RX:RDIRN=W-E,OPTYPE=ADD,OPWR=10.0,ILOSS=1.0,VOAMODE=ATTN,
VOAATTN=0.5,VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,OSRI=Y,
AMPLMODE=GAIN,CHPOWER=-10.0,GAIN=3.0,EXPGAIN=3.0,REFOPWR=10.0,
OFFSET=0.0,REFTILT=3.0,CALTILT=0.0,ASEOPWR=5.0,DCULOSS=1.2,
AWGST=WARM-UP,HEATST=ON,
NAME=\"OTS PORT\":UNLOCKED-DISABLED,AUTOMATICINSERVICE"
;
Table 23-122 Output Parameter Support
<AID>
Access identifier from the "LINE" section.
<RDIRN>
Ring direction of the optical line. The parameter type is RDIRN_MODE, which is the optical ring direction.
•
The direction of the signal is from east to west (clockwise).
•
The direction of the signal is from west to east (counterclockwise).
<ROLE>
The role the unit is playing in the protection group.
•
The entity is the protection unit in the protection group.
•
The entity is the working unit in the protection group.
<STATUS>
The status of the unit in the protection pair.
•
The entity is the active unit on the shelf
•
The entity is the standby unit on the shelf
<OPTICALPORTTYPE>
The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
•
The signal is added to the port.
•
Common port
•
The signal is dropped from the port.
•
Express/Add/Drop port
•
Logical port on Raman CTP card.
•
COM channels (without OSC) that continue the signal from the previous card
•
Input DCU port
•
IN-DEG optical port type
•
Rx managed port on Raman CTP card used for span continuity check.
•
The express channel that continues the signal from the previous card
•
All the channels that continue the signal from the previous card
•
OSC channel that continues the signal from the previous card
•
Input RAMAN line facility
•
IN-UPG optical port type
•
COM channels (without OSC) that continue the signal to the next card
•
Output DCU port.
•
OUT-DEG optical port type
•
Tx managed port on Raman CTP card used for span continuity check.
•
OUT-EDRA-PUMP optical port type
•
Express channel that continues the signal to the next card
•
All the channels that continue the signal to the next card
•
OSC channel that continue the signal to the next card
•
Output RAMAN line facility
•
OUT-UPG optical port type
•
PORT optical port type
<POWER>
(Optional) The optical power measured at this port. It can be the input or output power according to port type. POWER is a float.
<OSCPWR>
(Optional) The optical power of the OSC channel inside the OTS port.
<ILOSS>
(Optional) Insertion loss.
<VOAMODE>
(Optional) The working control mode of the VOA. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
•
VOA has a fixed attenuation.
•
VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>
(Optional) The value of calibrated attenuation for the VOA. VOAATTN is a float.
<VOAPWR>
(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. VOAPWR is a float.
<VOAREFATTN>
(Optional) The value of reference attenuation for the VOA. VOAREFATTN is a float.
<VOAREFPWR>
(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. VOAREFPWR is a float.
<OSRI>
(Optional) OSRI enabled or disabled. Present only on a port where the safety is supported. Defaults to off. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<AMPLMODE>
(Optional) The optical amplification control mode. The parameter type is AMPL_MODE, which defines amplifier control mode.
•
The amplifier always maintains a fixed gain.
•
The amplifier maintains the output power to a fixed value.
<AMPLMODEFLG>
(Optional) Parameter status flag indicating the state of the amplifier control mode.
<CHPOWER>
(Optional) The per channel optical power. Applicable only to amplified OTS ports.
<CHPOWERFLG>
(Optional) Parameter status flag indicating the state of the channel power.
<GAIN>
(Optional) The value of the gain of the amplifier. Defaults to 21 dB for a preamplifier and 20 dB for a booster amplifier.
<EXPGAIN>
(Optional) The expected gain value to be reached from an amplifier when the node is in a NCS access network. EXPGAIN is a float.
<EXPGAINFLG>
Parameter status flag indicating the state of the expected gain.
<REFOPWR>
(Optional) The value of the calculated optical power expected for the output line added to the calibration value, which equals the total expected output power. REFOPWR is a float.
<OFFSET>
(Optional) The value of the calibrated optical power expected for the output line, which is added to the calculated value to have the total expected output power. OFFSET is a float.
<REFTILT>
(Optional) The calculated tilt value to be added to the user provided calibration value. REFTILT is a float.
<REFTILTFLG>
Parameter status flag indicating the state of the calculated tilt.
<CALTILT>
(Optional) The amplifier calibration tilt offset to be added to the calculated reference value. CALTILT is a float.
<ASEOPWR>
(Optional) The value of the calibrated optical power expected for the output line which is provided by the user, added to the calculated value to have the total expected output power. ASEOPWR is a float.
<DCULOSS>
(Optional) The value of insertion loss associated to DCU in between the two stages of a preamplifier unit. DCULOSS is a float.
<AWGST>
(Optional) The status assumed by arrayed waveguide grating (AWG). The parameter value is AWG_STATUS, which is the AWG status list.
•
The AWG is on.
•
The AWG is warming up.
<HEATST>
(Optional) The status assumed by the heater. The parameter type is HEATER_STATUS, which is the heater status list.
•
The heater is off.
•
The heater is on.
<NAME>
(Optional) Port name. NAME is a string.
<SOAK>
(Optional) Locked-Automatic In Service to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows:
•
•
•
<WRKCHANNELS>
Number of working OCHNC channels carried by the facility.
<RATIO>
Indicates the Raman Pump Power ratio.
<RAMAN_STATUS>
Indicates the Raman setup state.
•
Raman is not tuned. Default values are set.
•
Raman is tuning.
•
Raman is tuned but not verified.
•
Raman is tuned with values not measured but calculated.
•
Raman setup has been accepted by the user.
•
Raman is tuned and verified.
<RAMAN_QUALITY>
Indicates the Raman quality setup results.
•
Setup good
•
Setup needs acceptance
•
Setup unaccepted
•
Setup forced
<TIME>
Identifies the time. Time is a string. Default value is - current time.
<DATE>
Identifies the date. Date is a string. Default value is - current date.
<RAMAN_RESTORE_FC>
Restores Raman after fiber cut.
•
Restores Raman after fiber cut fails.
•
Restores Raman after fiber cut is not executed.
•
Restores Raman after fiber cut is OK.
•
Restores Raman after fiber cut is PENDING.
<CG>
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
•
TDCU coarse grain value
<FG>
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
•
TDCU fine grain value
<SWITCH_STATE >
The parameter type is SWITCH_STATE , indicates the switch state.
•
Swtich state is auto.
•
Switch state is open.
<SWSTATE>
Software switch state.
•
Auto
•
Logo
<PST>
(Optional) Primary state of the entity. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SST>
(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.118 RTRV-OTU
The Retrieve Optical Transport Unit Level (RTRV-OTU) command retrieves the attributes (service parameters) and state of an OTU facility.
Usage Guidelines
The OVRCLK is the new parameter added and applicable for RTRV-OTU command on 10x10G-LC SFP+ ports only.
The RTRV-OTU4 is modified by adding a new parameter NUMOFLANES, which describes the number of sublanes provisioned on Aggregate ports of CFP-LC cards.
Category
NCS
Security
Retrieve
Input Format
RTRV-<OTU>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-OTU2:PENNGROVE:FAN-6-1-1:236;
Input Parameters
<AID>
Access identifier from the "LINE" section and "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<PORTNAME>],GCC=<GCC>],[DWRAP=<DWRAP>],[FEC=<FEC>],[PAYLOADMAP=<PAYLOADMAP>],[OSDBER=<OSDBER>],[PMMODE=<PMMODE>],[NUMOFLANES=<NUMOFLANES>]:<PST_PSTQ>,[<SSTQ>]";Output Example
100g 2012-05-22 13:52:07
M 1 COMPLD
"VFAC-3-1-1:,,WORK,STBY:GCC=N,FREQ=USE-TWL1,LOSSB=AUTOPROV,SOAK=32,,SQUELCHMODE=ODU-AIS,ADMSSM=STU,NUMOFLANES=10:OOS-MA,DSBLD
Table 23-123 Output Parameter Support
<AID>
Access identifier from the "LINE" section.
<ROLE>
The role the unit is playing in the protection group.
•
The entity is the protection unit in the protection group.
•
The entity is the working unit in the protection group.
<STATUS>
The status of the unit in the protection pair.
•
The entity is the active unit on the shelf.
•
The entity is the standby unit on the shelf.
<OSDBER>
OTN SDBER. Can only be provisioned on the working port. Defaults to 1E-7.
Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5
•
SDBER is 1E-6
•
SDBER is 1E-7
•
SDBER is 1E-8
•
SDBER is 1E-9
<GCC>
Identifies the generic communication channel (GCC) connection of the port.
•
GCC can be utilized.
•
GCC cannot be utilized.
<DWRAP>
(Optional) The ITU-T G.709 monitoring digital wrapper. It is either on or off. The system default is ON. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the NCS port. The parameter type is ON_OFF (disable or enable an attribute). To enable ITU-T G.709 monitoring, there should be no GCC on the NCS port and the payload (in which the card is configured) should not be UNFRAMED. To disable ITU-T G.709 monitoring, there should be no GCC on the NCS port, the FEC should be turned to off, there should be no overhead circuit created on the NCS port, and none of the client ports on the card should be part of a Y-cable protection group (muxponder only).
•
Disable an attribute.
•
Enable an attribute.
<FEC>
(Optional) Forward error correction. It can be enabled only if ITU-T G.709 monitoring is turned ON. It is either off or enabled in standard or enhanced mode. The system default is standard FEC enabled. The FEC level PM and thresholds apply if the FEC is turned ON. The parameter type is FEC_MODE, which specifies the type of forward error correction.
•
Enhanced FEC is enabled.
•
Enhanced FEC 1.4 is enabled.
•
Enhanced FEC 1.7 is enabled.
•
20 % Enhanced FEC supported on fixed trunk port of 100G-LC-C card.
•
High Gain 7% FEC.
•
FEC is disabled.
•
Standard FEC is enabled.
<PRE-FEC-PSM>
The parameter type is PROACTIVE_PROT.
•
Proactive protection is disabled.
•
Proactive protection is enabled.
<PAYLOADMAP>
(Optional) The type of payload mapping. It can be enabled only if ITU-T G.709 monitoring is turned ON and FEC is enabled. The parameter type is PAYLOAD_MAPPING, which is the payload mapping mode.
•
Asynchronous mapping mode
•
ODU multiplex structure mode
•
Synchronous mapping mode
•
Mapping with no FIXEDSTUFF
<FREQ>
(Optional) The parameter type is OPTICAL_WLEN, which indicates the optical wavelength.
•
Wavelength 1310
•
Wavelength 1470
•
Wavelength 1490
•
Wavelength 1510
•
Wavelength 1528.77
•
Wavelength 1529.16
•
Wavelength 1529.55
•
Wavelength 1529.94
•
Wavelength 1530
•
Wavelength 1530.33
•
Wavelength 1530.73
•
Wavelength 1531.12
•
Wavelength 1531.51
•
Wavelength 1531.90
•
Wavelength 1532.29
•
Wavelength 1532.68
•
Wavelength 1533.07
•
Wavelength 1533.47
•
Wavelength 1533.86
•
Wavelength 1534.25
•
Wavelength 1534.64
•
Wavelength 1535.04
•
Wavelength 1535.43
•
Wavelength 1535.82
•
Wavelength 1536.22
•
Wavelength 1536.61
•
Wavelength 1537
•
Wavelength 1537.40
•
Wavelength 1537.79
•
Wavelength 1538.19
•
Wavelength 1538.58
•
Wavelength 1538.98
•
Wavelength 1539.37
•
Wavelength 1539.77
•
Wavelength 1540.16
•
Wavelength 1540.56
•
Wavelength 1540.95
•
Wavelength 1541.35
•
Wavelength 1541.75
•
Wavelength 1542.14
•
Wavelength 1542.35
•
Wavelength 1542.54
•
Wavelength 1542.94
•
Wavelength 1543.33
•
Wavelength 1543.73
•
Wavelength 1544.13
•
Wavelength 1544.53
•
Wavelength 1544.92
•
Wavelength 1545.32
•
Wavelength 1545.72
•
Wavelength 1546.12
•
Wavelength 1546.52
•
Wavelength 1546.92
•
Wavelength 1547.32
•
Wavelength 1547.72
•
Wavelength 1548.12
•
Wavelength 1548.51
•
Wavelength 1548.92
•
Wavelength 1549.32
•
Wavelength 1549.71
•
Wavelength 1500
•
Wavelength 1550.12
•
Wavelength 1550.52
•
Wavelength 1550.92
•
Wavelength 1551.32
•
Wavelength 1551.72
•
Wavelength 1552.12
•
Wavelength 1552.52
•
Wavelength 1552.93
•
Wavelength 1553.33
•
Wavelength 1553.73
•
Wavelength 1554.13
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.34
•
Wavelength 1555.75
•
Wavelength 1556.15
•
Wavelength 1556.55
•
Wavelength 1556.96
•
Wavelength 1557.36
•
Wavelength 1557.77
•
Wavelength 1558.17
•
Wavelength 1558.58
•
Wavelength 1558.98
•
Wavelength 1559.39
•
Wavelength 1559.79
•
Wavelength 1560.20
•
Wavelength 1560.61
•
Wavelength 1561.01
•
Wavelength 1561.42
•
Wavelength 1561.83
•
Wavelength 1570
•
Wavelength 1570.83
•
Wavelength 1571.24
•
Wavelength 1571.65
•
Wavelength 1572.06
•
Wavelength 1572.48
•
Wavelength 1572.89
•
Wavelength 1573.30
•
Wavelength 1573.71
•
Wavelength 1574.13
•
Wavelength 1574.54
•
Wavelength 1574.95
•
Wavelength 1575.37
•
Wavelength 1575.78
•
Wavelength 1576.20
•
Wavelength 1576.61
•
Wavelength 1577.03
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
•
Wavelength 1594.22
•
Wavelength 1594.64
•
Wavelength 1595.06
•
Wavelength 1595.49
•
Wavelength 1596.34
•
Wavelength 1596.76
•
Wavelength 1597.19
•
Wavelength 1597.62
•
Wavelength 1598.04
•
Wavelength 1598.47
•
Wavelength 1598.89
•
Wavelength 1599.32
•
Wavelength 1599.75
•
Wavelength 1600.06
•
Wavelength 1601.03
•
Wavelength 1601.46
•
Wavelength 1601.88
•
Wavelength 1602.31
•
Wavelength 1602.74
•
Wavelength 1603.17
•
Wavelength 1603.60
•
Wavelength 1604.03
•
Wavelength 1610
•
Use Tunable Wavelength 1
<LOSSB>
(Optional) The parameter type is REACH, which indicates the reach values.
•
100GBASE-LR4
•
100GBASE-SR10
•
40GBASE-FR
•
40GBASE-LR4
•
Reach supported on 40GIGE payload on CFP-LC card.
•
4I1-9D1F
•
C4S1-2D1
•
FE-BX
•
FX
•
GE-BX
•
GE-EX
•
LX-10
•
TEN-GE-LRM
•
TEN-GE-ZR
•
VSR2000-3R2
•
Autoprovisioning
•
Reach CX
•
Reach CX1
•
Reach DX
•
Reach HX
•
Reach I1
•
Reach IR-1
•
Reach IR-2
•
Reach L1
•
Reach L2
•
Reach L3
•
Reach LR-1
•
Reach LR-2
•
Reach LR-3
•
Reach LX
•
Long haul 10G Ethernet with 1310 nm wavelength
•
Longhaul 2.5G Ethernet with 1550 nm wavelength
•
Long haul 10G Ethernet with 1550 nm wavelength
•
Shorthaul 2.5G Ethernet with 1310 nm wavelength
•
Short haul 10G Ethernet in 1310 nm wavelength
•
Reach SC
•
Reach S1
•
Reach S2
•
Reach SR
•
Reach SR-1
•
Reach SX
•
Reach T
•
10 GE extended range
•
10 GE long range
•
10 GE short range
•
Reach VX
•
Reach ZX
<OVRCLK>
Indicates whether the optical trunk is over-clocked or not. It can be Y or N. The default is N.
<SQUELCHMODE>
Shuts down the far-end laser in response to certain defects.
•
Squelch is enabled
•
No Squelch
•
Squelch is disabled
<ADMSSM>
(Optional) SSM selectable. Only applicable to BITS-IN when SSM is disabled.
The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SONET.
•
Do Not Use For Synchronization
•
Primary Reference Source, Stratum 1 Traceable
•
Reserved For Network Synchronization Use
•
SONET Minimum Clock Traceable
•
Stratum 2 Traceable
•
Stratum 3 Traceable
•
Stratum 3E Traceable
•
Stratum 4 Traceable
•
Synchronized, Traceability Unknown
•
Transit Node Clock (2nd Generation Only)
<PORTNAME>
(Optional) Port name. PORTNAME is a string.
<CMDMDE>
(Optional) Command mode. Normal (NORM) mode is the default behavior for all commands but you can specify forced (FRCD) mode to force the system to override a state where the command would normally be denied. The FRCD mode of operation is applicable to delete a virtual concatenated (VCAT) member cross-connect in Unlocked-Enabled or Locked-Disabled, AutomaticInService service states.
<NUMOFLANES>
Indentifies the number of sublanes on the aggregate port with values 1 or 4.
<PST_PSTQ>
Primary state. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.119 RTRV-PATH-OCH
The Retrieve Path Optical Channel (RTRV-PATH-OCH) command retrieves the OCH path inside a node. An OCH path is a list of AIDs that addresses all the possible facility and internal OCHs that are associated to the same wavelength.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-PATH-OCH:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-PATH-OCH:PENNGROVE:CHAN-6-2:236;
Input Parameters
<AID>
Access identifier from the "CrossConnectId" section, "LINEWL" section, and "BANDWL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[WLEN],[PATH>]:";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-6-2::WLEN=1530.33,PATH=LINEWL-1-3-RX-1530.33&
LINEWL-1-1-TX-1530.33&LINEWL-3-1-RX-1530.33&CHAN-3-1-TX&CHAN-6-2:";
Table 23-124 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section, "LINEWL" section, and "BANDWL" section.
<WLEN>
(Optional) Defines the optical wavelength value.
•
Wavelength 1529.16
•
Wavelength 1530.33
•
Wavelength 1530.72
•
Wavelength 1531.12
•
Wavelength 1531.90
•
Wavelength 1532.68
•
Wavelength 1534.25
•
Wavelength 1535.04
•
Wavelength 1535.82
•
Wavelength 1536.61
•
Wavelength 1538.19
•
Wavelength 1538.98
•
Wavelength 1548.91
•
Wavelength 1549.72
•
Wavelength 1550.12
•
Wavelength 1550.92
•
Wavelength 1551.72
•
Wavelength 1552.52
•
Wavelength 1554.13
•
Wavelength 1554.94
•
Wavelength 1555.75
•
Wavelength 1556.55
•
Wavelength 1558.17
•
Wavelength 1558.98
•
Wavelength 1559.79
•
Wavelength 1560.61
•
Wavelength 1562.23
•
Wavelength 1562.64
•
Wavelength 1563.05
•
Wavelength 1563.45
•
Wavelength 1563.86
•
Wavelength 1564.27
•
Wavelength 1564.68
•
Wavelength 1565.09
•
Wavelength 1565.50
•
Wavelength 1565.90
•
Wavelength 1566.31
•
Wavelength 1566.72
•
Wavelength 1577.44
•
Wavelength 1577.86
•
Wavelength 1578.27
•
Wavelength 1578.69
•
Wavelength 1579.10
•
Wavelength 1579.52
•
Wavelength 1579.93
•
Wavelength 1580.35
•
Wavelength 1580.77
•
Wavelength 1581.18
•
Wavelength 1581.60
•
Wavelength 1582.02
•
Wavelength 1582.44
•
Wavelength 1582.85
•
Wavelength 1583.27
•
Wavelength 1583.69
•
Wavelength 1584.11
•
Wavelength 1584.53
•
Wavelength 1584.95
•
Wavelength 1585.36
•
Wavelength 1585.78
•
Wavelength 1586.20
•
Wavelength 1586.62
•
Wavelength 1587.04
•
Wavelength 1587.46
•
Wavelength 1587.88
•
Wavelength 1588.30
•
Wavelength 1588.73
•
Wavelength 1589.15
•
Wavelength 1589.57
•
Wavelength 1589.99
•
Wavelength 1590.41
•
Wavelength 1590.83
•
Wavelength 1591.26
•
Wavelength 1591.68
•
Wavelength 1592.10
•
Wavelength 1592.52
•
Wavelength 1592.95
•
Wavelength 1593.37
•
Wavelength 1593.79
<PATH>
(Optional) Access OCH layer of optical network/client cards from the "CHANNEL" section.
23.120 RTRV-PM-<MOD2>
The Retrieve Performance Monitoring for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 5GIB, 8GFC, CHGRP, CLNT, AUTO, 3GVIDEO, D1VIDEO, DS3I, DV6000, DVBASI, E1, E3, E4, T3, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDLC, HDSDI, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3STP1G, ISC3PEER2G, ISC3STP2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, OTL, OTU1, OTU2, OTU3, OTU4, POS, SDSDI, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-PM-<MOD2>) command retrieves the PM parameter values for a specified card type. See Table 29-1 for supported modifiers by platform.
Note
Usage Guidelines
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Category
Performance
Security
Retrieve
Input Format
RTRV-PM-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<DATE>],[<TIME>];Input Example
RTRV-PM-E1:TID:FAC-2-1:123::CVL,10-UP,NEND,RCV,15-MIN,04-11,12-45;
Table 23-125 Input Parameter Support
<AID>
Access identifier from the "ALL" section. All of the VC, and VT1, Facility AIDs are supported.
<MONTYPE>
(Optional) Monitored type. A null value defaults to all MONTYPEs applicable to the modifier. The parameter type is ALL_MONTYPE, which is the monitored type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed in tenths of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed in tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
•
A count of frames received on a particular interface that exceed the maximum permitted frame size.
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count-Path Detected
•
High-Order Path Negative Pointer Justification Count-Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive SES
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count-Path Detected
•
Negative Pointer Justification Count-Path Generated
•
Average Receive Power in one tenth of a microwatt
•
Maximum Receive Power in one tenth of a microwatt
•
Minimum Receive Power in one tenth of a microwatt
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed in tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<MONLEV>
(Optional) The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>
(Optional) Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility
•
Action occurs on the near end of the facility
<DIRECTION>
(Optional) Type of direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Receive direction only
•
Transmit direction only
<TMPER>
(Optional) Accumulation time period for performance counters. If TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length is every 24 hours. For NCS PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history data available.
•
Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<DATE>
(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of DATE is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to current date.
<TIME>
(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of TIME is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to current time.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<MONDAT>],[<MONTM>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,E1:CVL,21,COMPL,NEND,RCV,15-MIN,04-11,12-45"
;ABC 2012-05-15 02:59:20
M 1 RTRV
"CHAN-1-7-2,OCH:,93899775.1,COMPL,NEND,RCV,15-MIN,05-15,02-45"
Table 23-126 Output Parameter Support
<AID>
Access identifier from the "ALL" section. All of the VC, and VT1, Facility AIDs are supported.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
10 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
10-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
Auto
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
40-Gigabit Ethernet
•
Channel group
•
Client facility for MXP/TXP cards
•
DS3i-N-12 facility
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 facility
•
E3 facility
•
E100 alarm
•
E1000 alarm
•
E4 alarm
•
ENV alarm
•
ETH facility
•
EQPT facility
•
Fast Ethernet port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload.
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 peer
•
2-Gbps ISC3 peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 12G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port facility
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 facility
•
STM1E facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
TCC facility
•
VC11 path
•
VC12 path
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
<MONTYPE>
Monitored type. The parameter type is ALL_MONTYPE, which is the monitored type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed in tenths of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed in tenths of a percentage.
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed in tenths of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed in tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
•
A count of frames received on a particular interface that exceed the maximum permitted frame size.
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count - Path Detected
•
High-Order Path Pointer Justification Count Seconds - Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive SES
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification - Path Detected
•
Negative Pointer Justification - Path Generated
•
Average Receive Power in tenths of a microW
•
Maximum Receive Power in tenths of a microW
•
Minimum Receive Power in tenths of a microW
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed in tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<MONVAL>
The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. MONVAL is a string.
<VLDTY>
(Optional) Indicates whether the information for the specified time period was accumulated over the entire time period or some portion thereof. Validity indicator for the reported PM data. The parameter type is VALIDITY, which is the response validity.
•
Complete response
•
Partial response
<LOCN>
(Optional) Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRECTION>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
•
Transmit direction only
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length is every 24 hours. For NCS PM data only, one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<MONDAT>
(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of MONDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MONDAT is a string.
<MONTM>
(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MONTM is a string.
23.121 RTRV-PM-ALL
The Retrieve Performance Monitoring All (RTRV-PM-ALL) command retrieves the values of all the performance monitoring parameters for the specified AID. When the ALL AID is used, the response will include the PM parameters for all cards and ports in the chassis.
Usage Guidelines
•
•
•
•
•
•
•
•
•
•
•
–
–
•
•
•
•
•
•
Category
Performance
Security
Retrieve
Input Format
RTRV-PM-ALL:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>],
[<DIRECTION>],[<TMPER>],[<DATE>],[<TIME>];Input Example
RTRV-PM-ALL:TID:FAC-2-1:123::CVL,10-UP,NEND,RCV,15-MIN,04-11,12-45;
Table 23-127 Input Parameter Support
<AID>
Access identifier from the "ALL" section. All of the VC, and VT1, Facility AIDs are supported.
<MONTYPE>
Monitoring type. A null value defaults to all montypes applicable to the modifier. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VC Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count, Path Detected
•
High-Order Path Negative Pointer Justification Count, Path Generated
•
High-Order Path, Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds, Path Detected
•
High-Order Path Pointer Justification Count Seconds, Path Generated
•
High-Order Path Positive Pointer Justification Count, Path Detected
•
High-Order Path, Positive Pointer Justification Count, Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for OC3-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order Positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count, Path Detected
•
Negative Pointer Justification Count, Path Generated
•
Average Receive Power in one tenth of a microwatt
•
Maximum Receive Power in one tenth of a microwatt
•
Minimum Receive Power in one tenth of a microwatt
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microwatt
•
Maximum Transmit Power in one tenth of a microwatt
•
Minimum Transmit Power in one tenth of a microwatt
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
Positive Pointer Justification Count, Path Detected
•
Positive Pointer Justification Count, Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<MONLEV>
The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>
Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility
•
Action occurs on the near end of the facility
<DIRECTION>
Type of direction. Must not be null. The parameter type is DIRECTION (transmit and receive directions).
•
Both transmit and receive directions.
•
Receive direction only.
•
Transmit direction only.
<TMPER>
Accumulation time period for performance counters. If TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24-hours. For NCS PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<DATE>
The beginning date of the PM or storage register period specified in TMPER. The format of DATE is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to current date.
<TIME>
The beginning time of day of the PM or storage register period specified in TMPER. The format of TIME is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to current time.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],[<DIRECTION>],
[<TMPER>],[<MONDAT>],[<MONTM>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,E1:CVL,21,COMPL,NEND,RCV,15-MIN,04-11,12-45";
Table 23-128 Output Parameter Support
<AID>
Access identifier from the "ALL" section. All of the VC, and VT1, Facility AIDs are supported.
<AIDTYPE>
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet
•
10 Gigabit Ethernet
•
40 Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
10-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
8-Gigabit Fibre Channel payload
•
Client facility for MXP/TXP cards
•
DS3I facility
•
E3 facility
•
E100 facility
•
E1000 facility
•
ETH facility
•
EQPT facility
•
Fast Ethernet Port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
1.5G HD-SDI video payload
•
1-Gbps ISC3 Peer
•
2 Gbps ISC3 Peer
•
1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1 Gbps ISC1, ISC2, and ISC3 compatibility
•
270M SDI video payload.
•
STM1 facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
Optical channel
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transports Unit Level 1
•
Optical Transports Unit Level 2
•
Optical Transports Unit Level 3
•
Optical Transports Unit Level 4
•
POS port facility
•
VC3 path
•
VC4 path
•
VC4-2C path
•
VC4-3C path
•
VC4-6C path
•
VC4-4C path
•
VC4-8C path
•
VC4-12C path
•
VC4-16C path
•
VC4-64C path
•
T3 facility
•
TCC
•
VC11 path
•
VC12 path
<MONTYPE>
Monitored type. The parameter type is ALL_MONTYPE, which is the monitoring type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
OTN—Background Block Errors—Path Monitor Point
•
OTN—Background Block Errors—Section Monitor Point
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as one tenth of a percentage
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Controlled Slip Seconds—Path (DSXM-12 FDL/T1.403 PM count)
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Second Type A-Path (DS3XM-12 DS1 PM count)
•
Errored Second Type B-Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor point expressed as one tenth of a percentage
•
Errored Seconds Ratio—Section monitor point expressed as one tenth of a percentage
•
Errored Seconds—Section
•
Errored Seconds—VC Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count, Path Detected
•
High-Order Path, Negative Pointer Justification Count, Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds, Path Detected
•
High-Order Path Pointer Justification Count Seconds, Path Generated
•
High-Order Path Positive Pointer Justification Count, Path Detected
•
High-Order Path, Positive Pointer Justification Count, Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for OC3-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds-A
•
Low-Order Path Errored Seconds-B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count, Detected
•
Low Order Negative Pointer Justification Count, Generated
•
Low-Order Positive Pointer Justification Count, Detected
•
Low-Order positive Pointer Justification Count, Generated
•
Low-Order Path Severely Errored Period
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count, Path Detected
•
Negative Pointer Justification Count, Path Generated
•
Average Receive Power in one tenth of a microwatt
•
Maximum Receive Power in one tenth of a microwatt
•
Minimum Receive Power in one tenth of a microwatt
•
Normalized Optical Receive Power for OC3-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in one tenth of a microwatt
•
Maximum Transmit Power in one tenth of a microwatt
•
Minimum Transmit Power in one tenth of a microwatt
•
Normalized value for Optical Power Transmitted for the OC3-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in one tenth of a dBm
•
Optical Power—Maximum Interval Value in one tenth of a dBm
•
Optical Power—Minimum Interval Value in one tenth of a dBm
•
Positive Pointer Justification Count, Path Detected
•
Positive Pointer Justification Count, Path Generated
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Network Path (DS3XM-12 DS1 PM count)
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Network Path (DS3XM-12 DS1 PM count)
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<MONVAL>
The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. MONVAL is a string.
<VLDTY>
(Optional) Indicates whether the information for the specified time period was accumulated over the entire time period or some portion thereof. Validity indicator for the reported PM data. The parameter type is VALIDITY, which is the response validity.
•
Complete response
•
Partial response
<LOCN>
(Optional) Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<DIRECTION>
The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
•
Both transmit and receive directions
•
Receive direction only
•
Transmit direction only
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length; every 24-hours. For NCS PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<MONDAT>
(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of MONDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MONDAT is a string.
<MONTM>
(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MONTM is a string.
23.122 RTRV-PMMODE-<VC_PATH>
The Retrieve Performance Mode of PM Data Collection for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC12, VC416C, VC42C, VC4-48C or VC43C (RTRV-PMMODE-<VC_PATH>) command retrieves the type of PM mode that has been previously set in the NE. This command can be used to identify whether the PM parameters are Section, Line, or Path type, and to identify whether or not the PM are being collected by the NE.
Usage Guidelines
•
•
•
•
•
•
Category
Performance
Security
Retrieve
Input Format
RTRV-PMMODE-<VC_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>;
Input Example
RTRV-PMMODE-VC4:CISCO:VC4-4-1-1-1:123::NEND;
Table 23-129 Input Parameter Support
<SRC>
Source access identifier from the "CrossConnectId" section.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Must not be null. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
Output Format
SID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:[<LOCN>],<MODETYPE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-1-1-1:NEND,P"
;
Table 23-130 Output Parameter Support
<CROSSCONNECTID>
Access identifier from the "CrossConnectId" section.
<LOCN>
(Optional) Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<MODETYPE>
The type of PM parameters that the entity or the sub entity is to store as a result of an attribute change. The parameter type is PM_MODE, which is the type of PM parameters.
•
Transport Path PM parameters
23.123 RTRV-PMSCHED-<MOD2>
The Retrieve Performance Monitoring Schedule for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 5GIB, 8GFC, CHGRP, CLNT, D1VIDEO, DS3I, DV6000, DVBASI, E1, E3, E4, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDLC, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, OTU2, OTU3, OTU4, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, VC12, 3GVIDEO, HDSDI, ISC3STP1G, ISC3STP2G, OTU1, or SDSDI (RTRV-PMSCHED-<MOD2>) command retrieves the PM reporting schedule that was set for the NE by the SCHED-PMREPT command. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Performance
Security
Retrieve
Input Format
RTRV-PMSCHED-<MOD2>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-PMSCHED-ISC3STP2G::VFAC-13-5-7-1:777;
Input Parameters
<AID>
Access identifier from the "ALL" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
Output Format
SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],, [<MONLEV>],<LOCN>,,[<TMPER>],[<TMOFST>],[<INHMODE>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-3-1-1,ISC3STP2G:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW"
;
Table 23-131 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2, which is the line/path modifier.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
40-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
D1 Video
•
DS3i-N-12 Line
•
DV6000
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1
•
E3
•
E4 frame, only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode
•
ESCON
•
ETRCLO
•
ETH facility
•
FSTE facility
•
G1000 facility
•
GFP over POS, virtual ports partitioned using GFP's multiplexing capability
•
Gigabit Ethernet
•
1.5G HD-SDI video payload.
•
HDTV
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 peer
•
2-Gbps ISC3 peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
STM1 facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
Optical channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port
•
270M SDI video payload.
•
STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
•
VC11 path
•
VC12 path
<REPTINVL>
Reporting interval. How often a report is to be generated and sent to the appropriate NE. REPTINVL is a string.
<REPTDAT>
Report date. Date for the next report. REPTDAT is a string.
<REPTTM>
Report time. The time of day for the next PM report. REPTTM is a string.
Note
<NUMINVL>
(Optional) The remaining number of intervals over which PM is to be reported. NUMINVL is an integer.
<MONLEV>
(Optional) The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length is every 24 hours. For NCS PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<TMOFST>
(Optional) Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. TMOFST is a string.
<INHMODE>
(Optional) Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). The parameter type is INH_MODE, which indicates whether or not the function is inhibited.
•
Function is allowed.
•
Function is inhibited.
23.124 RTRV-PMSCHED-ALL
The Retrieve Performance Schedule All (RTRV-PMSCHED-ALL) command retrieves all the PM reporting schedules that were set for the NE using the SCHED-PMREPT command.
Usage Guidelines
None
Category
Performance
Security
Retrieve
Input Format
RTRV-PMSCHED-ALL:[<TID>]::<CTAG>;
Input Example
RTRV-PMSCHED-ALL:CISCO-NODE::123;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],,
[<MONLEV>],<LOCN>,,[<TMPER>],<TMOFST>,[<INHMODE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-3-1,STM1:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW"
;
Table 23-132 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2, which is the line/path modifier.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
40-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Channel group
•
D1 Video
•
DS3i-N-12 Line
•
DV6000
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1
•
E3
•
E4 frame, only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode
•
ESCON
•
ETRCLO
•
FSTE facility
•
G1000 facility
•
GFP over POS, virtual ports partitioned using GFP's multiplexing capability
•
Gigabit Ethernet
•
1.5G HD-SDI video payload.
•
HDTV
•
High-level data link control (HDLC) frame mode.
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 Peer
•
2-Gbps ISC3 Peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
STM1 facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
Optical channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port
•
Resilient Ethernet Protocol
•
270M SDI video payload.
•
STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
•
VC11 path
•
VC12 path
<REPTINVL>
Reporting interval. How often a report is to be generated and sent to the appropriate NE. REPTINVL is a string.
<REPTDAT>
Report date. Date for the next report. REPTDAT is a string.
<REPTTM>
Report time. The time of day for the next PM report. REPTTM is a string.
<NUMINVL>
(Optional) The remaining number of intervals over which PM is to be reported. NUMINVL is an integer.
<MONLEV>
(Optional) The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length is every 24 hours. For NCS PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<TMOFST>
(Optional) Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. TMOFST is a string.
<INHMODE>
(Optional) Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). The parameter type is INH_MODE, which indicates whether the function is inhibited.
•
Function is allowed.
•
Function is inhibited.
23.125 RTRV-POS
The Retrieve Packet Over NCS (RTRV-POS) command retrieves the back-end port information for the Ethernet card when the back-end port is working in POS mode.
Usage Guidelines
•
•
•
Category
Ports
Security
Retrieve
Input Format
RTRV-POS:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-POS:TID:VFAC-1-1:CTAG;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[ADMINSTATE=<ADMINSTATE>],[JUMBO=<MTU>],[ENCAP=<ENCAP>],
[RPRSPAN=<RPRSPAN>],[EDGE=<EDGE>],[NAME=<NAME>]:";
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-1-1::ADMINSTATE=DOWN,JUMBO=N,ENCAP=RPR-GFP-F,RPRSPAN=EAST,
EDGE=Y,NAME=\"RPR\":"
;
Table 23-133 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<ADMINSTATE>
(Optional) Administration state. The parameter type is UP_DOWN (up or down).
•
Down
•
Up
<ENCAP>
(Optional) Frame encapsulation type
•
CBR mapping mode.
•
GFP mapping mode.
•
GMP mapping mode is supported only on 8GFC on 10x10G-LC card.
•
Transparent mapping mode.
•
RPR-over-GFP frame mode
<JUMBO>
Jumbo frame values
•
Yes
•
No
<RPRSPAN>
RPR span values
•
East direction
•
West direction
•
RPR edge values
•
Yes
•
No
<NAME>
Port name, facility name, or VCAT group name.
23.126 RTRV-PROTNSW-<MOD2NCSPAYLOAD>
The Retrieve Protection Switch for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 8GFC, D1VIDEO, DV6000, DVBASI, ETRCLO, FSTE, GIGE, HDTV, ISC1, ISC3, OTU3, OTU4, PASSTHRU, 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, or ISC3STP2G (RTRV-PROTNSW-<MOD2NCSPAYLOAD>) command retrieves the protection switch status of client facilities.
Usage Guidelines
The command supports the modifier 3GVIDEO, SDSDI, HDSDI, AUTO, OTU1, ISC3STP1G, ISC3STP2G.
Category
Performance
Security
Retrieve
Input Format
RTRV-PROTNSW-<MOD2NCSPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];
Input Example
RTRV-PROTNSW-ISC3STP1G:CISCO:VFAC-13-5-7-1:007;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AIDUNIONID>:<SC>,[<SWITCHTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1:FRCD,MANWKSWBK"
;
Table 23-134 Output Parameter Support
<AIDUNIONID>
Access identifier from the "FACILITY" section.
<SC>
Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lock out of protection
•
Lock out of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
MS-SPRing switch type
•
MS-SPRing span switch type
23.127 RTRV-PROTNSW-<STM_TYPE>
The Retrieve Protection Switch for STM1, STM4, STM16, or STM64 (RTRV-PROTNSW=<STM_TYPE>) command retrieves the switching state of a NCS line specified in the AID. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Protection
Security
Retrieve
Input Format
RTRV-PROTNSW-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-PROTNSW-STM16:CISCO:FAC-5-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SC>,[<SWITCHTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1:MAN,MANWKSWBK"
;
Table 23-135 Output Parameter Support
<AID>
Access identifier from the "FACILITY" section.
<SC>
Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lock out of protection
•
Lock out of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
MS-SPRing switch type
•
MS-SPRing span switch type
23.128 RTRV-PROTNSW-<OCN_TYPE>
The Retrieve Protection Switch for OC3, OC12, OC48, OC192, OC768 (RTRV-PROTNSW-<OCN_TYPE>) command retrieves the switching state of a SONET line specified in the AID.
Usage Guidelines
See Table 29-1 for supported modifiers by platform.
Category
Protection
Security
Retrieve
Input Format
RTRV-PROTNSW-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-PROTNSW-OC48:CISCO:FAC-5-1:123;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SC>,[<SWITCHTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-5-1:MAN,MANWKSWBK"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<SC>
Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lockout of protection.
•
Lockout of working.
•
Manual switch of working unit back to working.
•
Manual switch of working unit back to the protection unit.
•
BLSR ring switch type.
•
BLSR span switch type.
23.129 RTRV-PROTNSW-<PATH>
The Retrieve Protection Switch for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-PROTNSW-<PATH>) command retrieves the switching state of a NCS SNCP VC path specified in the AID. Because Telcordia GR-1400 does not allow LOCKOUT_OF_WORKING on the SNCP WORKING path/AID, the "AID:LOCKOUT,LOCKOUTOFWK" is not presented in the protection switch retrieval result.
See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Protection
Security
Retrieve
Input Format
RTRV-PROTNSW-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];
Input Example
RTRV-PROTNSW-VC4:CISCO:VC4-5-1-1:123;
Input Parameters
<SRC>
Source access identifier from the "CrossConnectId" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<CROSSCONNECTID>:<SC>,[<SWITCHTYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-5-1-1:MAN,MANWKSWBK"
;
Table 23-136 Output Parameter Support
<CROSSCONNECTID>
Access identifier from the "CrossConnectId" section.
<SC>
Switch command that is to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lock out of protection
•
Lock out of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
MS-SPRing switch type
•
MS-SPRing span switch type
23.130 RTRV-PROTNSW-OCH
The Retrieve Protection Switch Optical Channel (RTRV-PROTNSW-OCH) command retrieves the protection switch status of a TXPP_MR_2.5G card.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-PROTNSW-OCH:VA454-22:CHAN-2-2:100;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SW>,<SWTYPE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2:FRCD,FRCDWKSWBK"
;
Table 23-137 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<SW>
Indicates the switch operation. The parameter type is SW, which is the type of switch to be initiated.
•
APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
•
CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
Indicates the switch type operation. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lock out of protection
•
Lock out of working
•
Manual switch of working unit back to working
•
Manual switch of working unit back to the protection unit
•
MS-SPRing switch type
•
MS-SPRing span switch type
23.131 RTRV-PROTNSW-OTS
The Retrieve Protection Switch OTS (RTRV-PROTNSW-OTS) command retrieves the protection switch status of a TXPP_MR_2.5G card or OTU2-XP card in splitter mode.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-PROTNSW-OTS:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-PROTNSW-OTS:VA454-22:CHAN-2-2:100;
Input Parameters
<AID>
Access identifier from the "CHANNEL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SW>,<SWTYPE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2:FRCD,FRCDWKSWBK"
;Output Parameters
Table 23-138 Output Parameter Support
<AID>
Access identifier from the "CHANNEL" section.
<SW>
Indicates the switch operation. The parameter type is SW, which is the type of switch to be initiated.
•
CLEAR switch state. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
•
Forces a switch unless another FRCD or LOCKOUT is in effect.
•
Locks the facility out of switching. The system cannot switch to this facility to carry service.
•
Requests a manual switch of the facility.
<SWITCHTYPE>
Indicates the switch type operation. The parameter type is SWITCH_TYPE, which is the BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
•
Working unit is forced to switch back to working.
•
Working unit is forced to switch to the protection unit.
•
Lockout of protection.
•
Lockout of working.
•
Manual switch of working unit back to working.
•
Manual switch of working unit back to the protection unit.
23.132 RTRV-PROTOCOL
The Retrieve Protocol (RTRV-PROTOCOL) command retrieves the status of a protocol/service supported in the NE. Valid protocols include: SHELL, EMS, TL1, and SNMP. If the AID is not specified, the status of all of the protocols is retrieved.
Usage Guidelines
If the AID is TL1, the status can be retrieved to show if the protocol is in SECURE or UNSECURE mode.
Category
Security
Security
Retrieve
Input Format
RTRV-PROTOCOL:[<TID>]:[<AID>]:<CTAG>;
Input Example
RTRV-PROTOCOL::EMS:123;
Output Format
SID DATE TIME
M CTAG COMPLD
"<PROTOCOLAID>:<PROTOCOLSTAT>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"EMS:UNSECURE"
;
23.133 RTRV-PRBS
(Cisco NCS 2002 and Cisco NCS 2006) The Retrieve PseudoRandom Binary Sequence (RTRV-PRBS) is used to retrieve the PRBS configuration.
Usage Guidelines
•
•
•
•
•
Category
Ports
Security
Maintenance
Input Format
RTRV-PRBS:[<TID>]:<aid>:<CTAG>[::::];
Input Example
RTRV-PRBS::CHAN-7-2-1:1;
Table 23-141 RTRV-PRBS Command - Parameter Support
<AID>
Access Identifier.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:[PRBSGENPATTERN=<PRBSGENPATTERN>],[PRBSDETPATTERN=<PRBSDETPATTERN>],[PATTERNSYNCSTATUS=<PATTERNSYNCSTATUS>];"Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-7-2,OCH:PRBSGENPATTERN=NONE,PRBSDETPATTERN=NONE,PATTERNSYNCSTATUS=PATTERN-NONE"
;
23.134 RTRV-PTHTRC-<PATH>
The Retrieve Path Trace for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, VC12 (RTRV-PTHTRC-<PATH>) command retrieves the contents of the NCS path trace message. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
The path trace message is a 64-character string with the last two characters reserved for the terminating CR (carriage return) and the LF (line feed). The message can be an incoming path trace message, an expected incoming path trace message, or an outgoing path trace message that is inserted into the path overhead of the outgoing signal.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The path trace mode defaults to OFF mode. The MANUAL mode performs the comparison of the received string with the user-entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user-entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.
When the transmitted string is queried under the OFF, MANUAL, or AUTO path trace mode, the transmitted string is the provisioned transmit string.
Note
•
•
•
•
•
•
•
•
Category
Troubleshooting and Test Access
Security
Retrieve
Input Format
RTRV-PTHTRC-<PATH>:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>][:<LOCN>];
Input Example
RTRV-PTHTRC-VC4:CISCO:VC4-2-1-1:123::EXPTRC:NEND;
Table 23-143 Input Parameter Support
<SRC>
Source access identifier from the "CrossConnectId" section.
<MSGTYPE>
Type of autonomous message to be retrieved. A null value defaults to INCTRC. The parameter type is MSGTYPE, which is the type of trace message.
•
Expected incoming path trace message
•
Incoming path trace message
•
Outgoing path trace message
<LOCN>
Location associated with a particular command in reference to the entity identified by the AID. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
Output Format
SID DATE TIME
M CTAG COMPLD
"<TRACMSG>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"TRACMSG"
;Output Parameters
<TRACMSG>
The path trace message returned to the requester. The message can be up to 64 characters in length with the last two characters reserved for the CR and LF. TRACMSG is a string.
23.135 RTRV-PTSYS
The Retrieve Packet Transport System (RTRV-PTSYS) command retrieves the provisioned information of the CPT 50 panel.
Usage Guidelines
This command is valid for CPT 50 panel. Retrieves the PTSYS information provisioned on the Node.
Category
Equipment
Security
Retrieve
Input Format
RTRV-PTSYS:[<TID>]:<AID>:<CTAG>;
Input Example
PTSYS-1:PTSYSID=1,OPMODE=NMS,MEMLIST=\"SLOT-3-36&SLOT-2&PTSA;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<PTSYS AID>:<MODE>,<MEMLIST>,<FOGLIST>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"PTSYS-1:PTSYSID=1,OPMODE=NMS,MEMLIST=\"SLOT-3&PTSA-37\",FOGLIST=\"FOG-1-36";
23.136 RTRV-QNQ-CHGRP
The Retrieve QinQ Channel Group (RTRV-QNQ-CHGRP) command retrieves the IEEE 802.1Q tunneling (QinQ) relationship between the CE-VLAN and the S-VLAN for Gigabit Ethernet uniport provisioning associated to a channel group.
Usage Guidelines
None
Category
Channel Group
Security
Retrieve
Input Format
RTRV-QNQ-CHGRP:[<TID>]:<AID>:<CTAG>::<FIRSTCEVLANID>,<LASTCEVLANID>,
<SVLANID>[:];Input Example
RTRV-QNQ-CHGRP::CHGRP-1-1:1::110,110,1208;
Table 23-145 Input Parameter Support
<AID>
Access identifier from the "CHGRP" section.
<FIRSTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LASTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Set a Cos value
•
The COS is set according to DSCP to COS mapping table.
•
Use the Customer COS
•
The COS will be provisioned on CVLAN basis (QinQ selective mode)
Output Format
SID DATE TIME
M CTAG COMPLD "<AID>:<FIRSTCEVLANID>,<LASTCEVLANID>,<SVLANID>:RULE=<RULE>,[INTERNALVLAN=<INTERNAL_VLAN_ID>],[INGRESSCOS=<INGRESSCOS>[:];
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHGRP-1-1:110,111,1208:RULE=DOUBLE-ADD,INTERNALVLAN=18,INGRASSCOS="
;
Table 23-146 Output Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<FIRSTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LASTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<RULE>
Used to represent the Rules allowed for VLAN tagging operations. Default is ADD.
•
The S-VLAN tag is added to the CE-VLAN tag.
•
The S-VLAN tag substitutes the CE-VLAN tag (single Q).
•
XLTE and ADD rule applied together. This rule request to supply an internal S-VLAN. First the Internal VLAN substitutes the Customer VLAN, then Service Provider VLAN TAG (S-VLAN) is added
•
ADD rule applied two times. This rule request to supply an internal S-VLAN. First the Internal VLAN is added, then Service Provider VLAN TAG (S-VLAN) is added to have a double tag
<INTERNAL_VLAN_ID>
Internal VLAN ID
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Set a Cos value
•
The COS is set according to DSCP to COS mapping table.
•
Use the Customer COS.
•
The COS provisioned on CVLAN basis (QinQ selective mode)
23.137 RTRV-QNQ-ETH
The Retrieve QinQ Ethernet (RTRV-QNQ-ETH) command retrieves the IEEE 802.1Q tunneling (QinQ) relationship between the CE-VLAN and the S-VLAN for Gigabit Ethernet uniport provisioning associated to an L2 Ethernet port.
Usage Guidelines
None
Category
Ethernet
Security
Retrieve
Input Format
RTRV-QNQ-ETH:[<TID>]:<AID>:<CTAG>::<FIRSTCEVLANID>,<LASTCEVLANID>,
<SVLANID>[:];Input Example
RTRV-QNQ-ETH:PETALUMA:ETH-1-1-1:238::110,110,1208;
Table 23-147 Input Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<FIRSTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LASTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Set a Cos value
•
The COS is set according to DSCP to COS mapping table.
•
Use the Customer COS
•
The COS will be provisioned on CVLAN basis (QinQ selective mode)
Output Format
SID DATE TIME
M CTAG COMPLD "<AID>:<FIRSTCEVLANID>,<LASTCEVLANID>,<SVLANID>:RULE=<RULE>,[INTERNALVLAN=<INTERNAL_VLAN_ID>],[INGRESSCOS=<INGRESSCOS>[:];
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-1-1-1:110,111,1208:RULE=XLTE:"
;
Table 23-148 Output Parameter Support
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
<FIRSTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LASTCEVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<SVLANID>
VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<RULE>
Used to represent the Rules allowed for VLAN tagging operations. Default is ADD.
•
The S-VLAN tag is added to the CE-VLAN tag.
•
The S-VLAN tag substitutes the CE-VLAN tag (single Q).
•
XLTE and ADD rule applied together. This rule request to supply an internal S-VLAN. First the Internal VLAN substitutes the Customer VLAN, then Service Provider VLAN TAG (S-VLAN) is added
•
ADD rule applied two times. This rule request to supply an internal S-VLAN. First the Internal VLAN is added, then Service Provider VLAN TAG (S-VLAN) is added to have a double tag
<INTERNAL_VLAN_ID>
Internal VLAN ID
<INGRESSCOS>
Identifies the COS value set in the S-VLAN tag.
•
Set a Cos value
•
The COS is set according to DSCP to COS mapping table.
•
Use the Customer COS.
•
The COS provisioned on CVLAN basis (QinQ selective mode)
23.138 RTRV-RAMAN
Retrieve RAMAN command retrieves the attributes of a RAMAN measure.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-RAMAN:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-RAMAN:PENNGROVE:LINE-6-1-TX:236;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<aid>:<meas_index>:<minramanlev>,<maxramanlev>,<date>,<time>";
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"LINE-6-1-TX:1:MINRAMANLEV=1.0,MAXRAMANLEV=2.0,TIME=00-00-00,DATE=02-02-07;
Output Parameters
23.139 RTRV-REP
The Retrieve Resilient Ethernet Protocol (RTRV-REP) command retrieves the Resilient Ethernet Protocol (REP) configuration on the ethernet port of GE_XP or 10GE_XP card.
Usage Guidelines
•
•
Category
Ethernet
Security
Retrieve
Input Format
RTRV-REP:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-REP:PENNGROVE:CHAN-16-1-RX:114;
Input Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "ETH" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[SEGMENTID=<SEGMENTID>],[EDGE=<EDGE>],[PORTROLE=<PORTROLE>],[PREFERRED=<PREFERRED>],[PREEMPTDELAY=<PREEMPTDELAY>][:]";
Output Example
SID DATE TIME
M CTAG COMPLD
ETH-16-1-1::SEGMENTID=1,EDGE=Y,PORTROLE=NO_NEIGHBOR,PREFERRED=N,
REEMPTDELAY=0"
;Output Parameters
<AID>
Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the "FACILITY" section.
<SEGMENTID>
Indicates the segment ID for REP segment. The valid range is from 0 to 1024.
<EDGE>
Configures the port as an edge port.
•
To configure the port as an edge port.
•
Not to configure the port as an edge port.
<PORTROLE>
The parameter type is REP_PORT_ROLE, which indicates the port's role in a REP Segment for the ethernet ports.
•
Indicates that the port is a primary port.
•
Indicates that the port has no neighbor port in the segment.
•
Indicates that the port is a primary port and has no neighbor port in the segment.
•
Indicates that the port is a regular port.
•
Indicates that the port is an edge port.
<PREFERRED>
Indicates that the port is the preferred alternate port. Or the preferred port for VLAN load balancing.
•
Yes
•
No
23.140 RTRV-RMONTH-<MOD2_RMON>
The Retrieve Remote Monitoring Threshold for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, 8GFC, CHGRP, FSTE, G1000, ETH, GFP, GFPOS, GIGE, HDLC, ISCCOMPAT, ISC3PEER1G, ISC3PEER2G, OCH, POS, 3GVIDEO, SDSDI , HDSDI, AUTO, ISC3STP1G, or ISC3STP2G (RTRV-RMONTH-<MOD2_RMON>) command retrieves an entry in the remote monitoring (RMON) alarm table for the threshold of data statistics managed by the RMON engine. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
The command supports the modifier 3GVIDEO, SDSDI , HDSDI, AUTO, OTU1, ISC3STP1G, ISC3STP2G, and OTU2.
Category
Performance
Security
Provisioning
Input Format
RTRV-RMONTH-<MOD2_RMON>:[<TID>]:<SRC>:<CTAG>::[<MONTYPE>],,,,[<INTVL>]:[RISE=<RISE>],[FALL=<FALL>],[SAMPLE=<SAMPLE>],[STARTUP=<STARTUP>][:];
Input Example
RTRV-RMONTH-ISC3STP1G::VFAC-4-1-1:1::MEDIAINDSTATSRXLCVERRORS,,,,10:RISE=10,FALL=1,SAMPLE=ABSOLUTE;
Table 23-151 Input Parameter Support
<AID>
Access identifier from the "FACILITY" section. AID for the facility that the data statistic is managed by.
<MONTYPE>
(Optional) Monitored type. Type of RMON monitored data statistic. A null value is equivalent to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed in tenths of a percentage.
•
OTN—Background Block Error Ratio—Section Monitor Point expressed in tenths of a percentage.
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed in tenths of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed in tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
•
A count of frames received on a particular interface that exceed the maximum permitted frame size.
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count - Path Detected
•
High-Order Path Pointer Justification Count Seconds - Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive SES
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count-Path Detected
•
Negative Pointer Justification Count-Path Generated
•
Average Receive Power in one tenth of a microwatt
•
Maximum Receive Power one tenth of a microwatt
•
Minimum Receive Power in one tenth of a microwatt
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed in tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<INTVL>
(Optional) The interval in seconds over which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds). A null value is equivalent to ALL.
<RISE>
(Optional) The rising threshold for the sampled statistic. A valid value is any integer. A null value is equivalent to ALL.
<FALL>
(Optional) The falling threshold. A valid value is any integer smaller than the rising threshold. A null value is equivalent to ALL.
<SAMPLE>
(Optional) The method of calculating the value to be compared to the thresholds. A null value is equivalent to ALL. The parameter type is SAMPLE_TYPE, which describes how the data will be calculated during the sampling period.
•
Comparing directly
•
Comparing with the current value of the selected variable subtracted from the last sample
<STARTUP>
(Optional) Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. A null value is equivalent to ALL. The parameter type is STARTUP_TYPE, which indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold.
•
Generates the event when the sample is smaller than or equal to the falling threshold.
•
Generates the event when the sample is greater than or equal to the rising threshold.
•
Generates the event when the sample is crossing the rising threshold or the falling threshold.
Output Format
RTRV-RMONTH-SDSDI:CISCO:VFAC-2-5-1:1234::MEDIAINDSTATSRXLCVERRORS,,,,100:RISE=1000, FALL=100,SAMPLE=DELTA,STARTUP=RISING;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-2-5-1,SDSDI: MEDIAINDSTATSRXLCVERRORS,,,,100:INDEX=2,RISE=1000,FALL=100, SAMPLE=DELTA,STARTUP=RISING"
;
Table 23-152 Output Parameter Support
<AIDUNIONID>
Access identifier from the "FACILITY" section.
<AIDTYPE>
The type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2_RMON, which is the line modifier.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
40-Gigabit Ethernet
•
8-Gigabit Fibre Channel payload
•
Ethernet
•
Fast Ethernet (10/100 Megabits per second)
•
Gigabit Ethernet (used for G1000 ports)
•
Generic framing protocol over NCS
•
Gigabit Ethernet (used for non-G1000 ports)
•
Optical channel
•
Optical Transport Unit Level 4
•
Packet over NCS
<MONTYPE>
Monitored type. Type of RMON monitored data statistic. The parameter type is ALL_MONTYPE, which is the monitored type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor point expressed in tenths of a percentage
•
Errored Seconds Ratio—Section monitor point expressed in tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
•
A count of frames received on a particular interface that exceed the maximum permitted frame size.
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including frame check sequence [FCS] octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count-Path Detected
•
High-Order Path Negative Pointer Justification Count-Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive severely errored seconds (SES)
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Multiplex Section-Protection switch count
•
Multiplex Section-Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count-Path Detected
•
Negative Pointer Justification Count-Path Generated
•
Average Receive Power in tenths of a microW
•
Maximum Receive Power in tenths of a microW
•
Minimum Receive Power in tenths of a microW
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed in tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
<INTVL>
The interval in seconds over which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds).
<INDEX>
The index for the threshold created by the system in the RMON threshold table. INDEX is an integer.
<RISE>
The rising threshold for the sampled statistic. A valid value is any integer.
<FALL>
The falling threshold. A valid value is any integer smaller than the rising threshold.
<SAMPLE>
The method of calculating the value to be compared to the thresholds. The parameter type is SAMPLE_TYPE, which describes how the data will be calculated during the sampling period.
•
Comparing directly
•
Comparing with the current value of the selected variable subtracted by the last sample
<STARTUP>
Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. The parameter type is STARTUP_TYPE, which indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold.
•
Generates the event when the sample is smaller than or equal to the falling threshold.
•
Generates the event when the sample is greater than or equal to the rising threshold.
•
Generates the event when the sample is crossing the rising threshold, or the falling threshold.
23.141 RTRV-ROLL-<MOD_PATH>
The Retrieve Roll for VC3, VC44C, VC464C, VC48C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-ROLL-<MOD_PATH>) command retrieves roll data parameters. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
None
Category
Bridge and Roll
Security
Retrieve
Input Format
RTRV-ROLL-<MOD_PATH>:[<TID>]:<SRC>:<CTAG>;
Input Example
RTRV-ROLL-VC4:CISCO:VC4-1-1-1:6;
Input Parameters
<SRC>
Source access identifier from the "VC" section. Roll path (VC).
Output Format
SID DATE TIME
M CTAG COMPLD
"<FROM>,<TO>:RFROM=<RFROM>,RTO=<RTO>,RMODE=<RMODE>,
VLDSIG=<VLDSIG>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-1-1-1,VC4-2-1-1:RFROM=VC4-2-1-1,RTO=VC4-3-1-1,RMODE=AUTO,VLDSIG=N"
;
Table 23-153 Output Parameter Support
<FROM>
One of the termination points (legs) of the existing cross-connection. AID from the "VC" section.
<TO>
One of the termination points (legs) of the existing cross-connection. AID from the "VC" section.
<RFROM>
The termination point of the existing cross-connect that is to be rolled. AID from the "VC" section.
<RTO>
The termination point that will become a leg of the new cross-connection. AID from the "VC" section.
<RMODE>
(Optional) The rolling mode of operation. The parameter type is RMODE, which specifies the roll mode.
•
Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous endpoint.
•
Manual. Enter the corresponding delete roll/bulkroll command to delete the previous endpoint.
<VLDSIG>
Shows whether or not the roll has received a valid signal. VLDSIG is Y if the signal is valid and N if it is not. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
23.142 RTRV-ROUTE
The Retrieve Route (RTRV-ROUTE) command retrieves static routes.
Usage Guidelines
•
•
Category
System
Security
Retrieve
Input Format
RTRV-ROUTE:[<TID>]::<CTAG>::[<DESTIP>],[<IPMASK>],[<NXTHOP>],[<COST>];
Input Example
RTRV-ROUTE:CISCO::123::10.64.72.57,255.255.255.0,10.64.10.1,200;
Output Format
SID DATE TIME
M CTAG COMPLD
",:<DESTIP>,<IPMASK>,<NXTHOP>,<COST>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
",:\"10.64.72.57\",\"255.255.255.0\",\"10.64.10.1\",200"
;
23.143 RTRV-ROUTE-GRE
The Retrieve Route Generic Routing Encapsulation (RTRV-ROUTE-GRE) command displays the existing GRE tunnels.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-ROUTE-GRE:[<TID>]::<CTAG>[::::];
Input Example
RTRV-ROUTE-GRE:CISCO::123;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
",:IPADDR=<IPADDR>,IPMASK=<IPMASK>,NSAP=<NSAP>,COST=<COST>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
",:IPADDR=10.64.72.57,IPMASK=255.255.255.0,
NSAP=39840F80FFFFFF0000DDDDAA000010CFB4910200,COST=110"
;
23.144 RTRV-SHELFSTAT
The RTRV-SHELFSTAT command retrieves and reports the temperature and voltage of the shelf.
Usage Guidelines
None
Category
Equipment
Security
Retrieve
Input Format
RTRV-SHELFSTAT:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-SHELFSTAT:CISCO454::1;
Output Format
SID DATE TIME
M CTAG COMPLD
"AID:AIDTYPE,TEMPERATURE= <TEMPERATURE>,VOLTAGEA= <VOLTAGEA>,VOLTAGEB= <VOLTAGEB>[,VOLTAGEC= <VOLTAGEC>,VOLTAGED= <VOLTAGED>]"
;Output Example
TID-000 2008-07-19 18:57:00
M 001 COMPLD
":SHELF,TEMPERATURE=22C,VOLTAGEA=51760,VOLTAGEB=51783,VOLTAGEC=51760,VOLTAGED=51783"
;
23.145 RTRV-SLV-WDMANS
The Retrieve Span Loss Verification Wavelength Division Multiplexing Automatic Node Setup (RTRV-SLV-WDMANS) command retrieves the expected span loss verification provisioned by the ED-SLV-WDMANS command.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-SLV-WDMANS:VA454-22:WDMANS-E:116;
Input Parameters
<AID>
Access identifier from the "WDMANS" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[ROLE=<ROLE>],[HIGHSLVEXP=<HIGHSLVEXP>],[LOWSLVEXP=<LOWSLVEXP>],
[SLVACT=<SLVACT>],[RESOLUTION=<RESOLUTION>,[TYPE=<TYPE>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"WDMANS-E::HIGHSLVEXP=10.0,LOWSLVEXP=5.0,SLVACT=10.0,RESOLUTION=1.0:"
;
Table 23-158 Output Parameter Support
<AID>
Access identifier from the "WDMANS" section.
<ROLE>
The role the unit is playing in the protection group.
•
The entity is the protection unit in the protection group.
•
The entity is the working unit in the protection group.
<HIGHSLVEXP>
(Optional) The high range value of the expected span loss verification. HIGHSLVEXP is a float.
<LOWSLVEXP>
(Optional) The low range value of the expected span loss verification. LOWSLVEXP is a float.
<SLVACT>
(Optional) The value of the calculated span loss verification. SLVACT is a float.
<RESOLUTION>
(Optional) The value of the resolution applied to the calculated span loss verification. RESOLUTION is a float.
<TYPE>
Indicates the type of the calculated span loss verification.
•
Span Loss calculated with OSC channel.
•
Span Loss calculated with OSC channel.
23.146 RTRV-STCN-REP
The RTRV Segment Topology Change Notification Resilient Ethernet Protocol (RTRV-STCN-REP) command retrieves the Segment Topology Change Notification (STCN) for REP Segment on the ethernet ports.
Usage Guidelines
•
•
Category
Ethernet
Security
Retrieve
Input Format
RTRV-STCN-REP:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-STCN-REP:CISCO:ETH-16-1-1:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[STCNENABLED=<STCNENABLED>],[SEGRANGE=<SEGRANGE>],[STCNPORT=<STCNPORT>]"
;Output Example
SID DATE TIME
M CTAG COMPLD
"ETH-16-1-1::STCNENABLED=Y,SEGRANGE=\"1000-1020"\&1020-1021,
STCNPORT=ETH-16-2-1"
<AID>
Access identifier from the "FACILITY" section.
<STCNENABLED>
To enable or disable the Segment Topology Notification on ethernet entity for REP.
•
Enables STCN on the ethernet port.
•
Disables STCN on the ethernet port.
<SEGRANGESTART>
Indicates the segment range start value for the STCN. The valid range is from 0 to 1024.
<SEGRANGEEND>
Indicates the segment range end value for the STCN. The valid range is from 0 to 1024.
<STCNPORT>
Determines on which ethernet port the STCN should be sent. STCNPORT is an AID, it takes ETH AID value. The default is NULL.
Output Parameters
23.147 RTRV-STM1E
The Retrieve STM1E (RTRV-STM1E) command retrieves the attributes and state information of a STM1E facility.
Usage Guidelines
None
Category
Ports
Security
Retrieve
Input Format
RTRV-STM1E:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-STM1E:CISCO1:FAC-6-1:8888;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[PAYLOAD=<PAYLOAD>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],
[PJMON=<PJMON>],[SFBER=<SFBER>],[SDBER=<SDBER>],[SOAK=<SOAK>],
[SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-6-1::PAYLOAD=STM1E,SYNCMSG=Y,SENDDUS=N,PJMON=48,SFBER=1E-4,
SDBER=1E-6,SOAK=10,SOAKLEFT=12-25,NAME=\"STM1EPORT\":UNLOCKED-DISABLED,
AUTOMATICINSERVICE"
;
Table 23-159 Output Parameter
<AID>
Access identifier from the "FACILITY" section.
<PAYLOAD>
(Optional) The payload for the card. The parameter type is PAYLOAD, which identifies the payload type.
•
100 Gigabit Ethernet.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit Ethernet
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
Auto
•
Video mode
•
DVBASI payload
•
E4-FRAMED payload mode for NCS STM1E-12 card
•
E4-UNFRAMED payload mode for NCS STM1E-12 card
•
ESCON mode
•
ETR/CLO payload mode
•
FSTE payload
•
Gigabit Ethernet Payload
•
High-level data link control (HDLC) frame mode.
•
HDTV mode
•
1.5G HD-SDI video payload.
•
IB payload
•
ISC1 mode
•
ISC3 mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 4
•
NCS STM4 mode
•
NCS STM1 mode
•
NCS STM16 mode
•
NCS STM1E payload mode
•
Pass-through mode
•
NCS Payload mode
•
SDI-D1-Video mode
•
270M SDI video payload.
<SYNCMSG>
(Optional) Indicates if synchronization messaging is enabled or disabled. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<SENDDUS>
(Optional) Indicates if the facility will send the DUS value as the synchronization message. The parameter type is ON_OFF (disable or enable an attribute).
•
Disable an attribute.
•
Enable an attribute.
<PJMON>
(Optional) Identifies an STM port PJMON. Defaults to 0 (zero). PJMON is an integer. Set a valid VC4 number of the optical port.
Note
<SFBER>
(Optional) The port signal failure threshold. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
•
SFBER is 1E-3.
•
SFBER is 1E-4.
•
SFBER is 1E-5.
<SDBER>
(Optional) Port signal degrade threshold. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
•
SDBER is 1E-5.
•
SDBER is 1E-6.
•
SDBER is 1E-7.
•
SDBER is 1E-8.
•
SDBER is 1E-9.
<SOAK>
(Optional) Locked-Automatic In Service to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>
(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows:
•
•
•
<NAME>
(Optional) Port name. NAME is a string.
<PSTPSTQ>
Primary state. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
23.148 RTRV-SRVTYPE
The Retrieve Service Type (RTRV-SRVTYPE) command retrieves the service type on the ports of the TNC card.
Category
Ports
Security
Retrieve
Input Format
RTRV-SRVTYPE:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-SRVTYPE::ALL:CTAG;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<SRVTYPE>;"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1-1:UDC"
;Output Parameters
23.149 RTRV-SYNCN
The Retrieve Synchronization (RTRV-SYNCN) command retrieves the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources can be specified (that is, PRIMARY, SECOND, and THIRD).
Usage Guidelines
•
•
Category
Synchronization
Security
Retrieve
Input Format
RTRV-SYNCN:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-SYNCN:BOYES:SYNC-NE:234;
Input Parameters
<AID>
Access identifier from the "SYNC_REF" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<REF>,<REFVAL>,[<QREF>],[<STATUS>],[<PROTECTSTATUS>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE:PRI,FAC-1-2,G811,ACT,WORK"
;
Table 23-160 Output Parameter Support
<AID>
Access identifier from the "SYNC_REF" section.
<REF>
Rank of synchronization reference. Access identifier from the "SYNCSW" section.
<REFVAL>
Value of a synchronization reference. Access identifier from the "SYN_SRC" section.
<QREF>
(Optional) Indicates whether the working or protect card (in a protection group) provides timing. This parameter has no significance if the reference source is BITS or INTERNAL and is left blank. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for NCS.
•
Do Not Use For Synchronization
•
ITU-T G.811 Standard
•
Reserved For Network Synchronization Use
•
ITU-T G.812T Standard
•
Synchronized, Traceability Unknown
•
ITU-T G.812TL Standard
•
Synchronous Equipment Timing Source
•
Incoming timing signal cannot be used for synchronization as it has an alarm like LOS, LOF, AIS-L.
<STATUS>
(Optional) Status. The parameter type is STATUS, which is the status of the unit in the protection pair.
•
The entity is the active unit in the shelf.
•
Status is unavailable.
•
The entity is the standby unit in the shelf.
<PROTECTSTATUS>
(Optional) Applicable to 1+1 protection. Designates the role of the entity in the protection group, either working or protect. The parameter type is SIDE, which is the role the unit plays in the protection group.
•
The entity is a protection unit in the protection group.
•
The entity is a working unit in the protection group.
23.150 RTRV-TACC
The Retrieve Test Access (RTRV-TACC) command retrieves details associated with a test access point (TAP). The TAP is identified by the TAP number. The ALL input TAP value means that the command will return all the configured TACCs in the NE.
Usage Guidelines
None
Category
Troubleshooting and Test Access
Security
Retrieve
Input Format
RTRV-TACC:[<TID>]:<TAP>:<CTAG>;
Input Example
RTRV-TACC:CISCO:241:CTAG;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<TAP>:<TACC_AIDA>,<TACC_AIDB>,[<MD>],[<CROSSCONNECTID1>],
<AIDUNIONID>,<PATHWIDTH>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"241:VC4-12-1-1,VC4-12-1-2,MONE,VC4-2-1-1,VC4-5-1-1,VC4"
;
Table 23-161 Output Parameter Support
<TAP>
The assigned number for the AID being used as a test access point. TAP is an integer.
<TACC_AIDA>
Access identifier from the "CrossConnectId" section. The A path of the test access point. The first VC path of the TAP.
<TACC_AIDB>
Access identifier from the "CrossConnectId" section. The B path of the test access point. The second VC path of the TAP. For single FAD TAP, this path will be empty.
<MD>
(Optional) Test access mode. It identifies the mode of access between the TAP and the circuit connected to the TAP. The parameter type is TACC_MODE, which is the test access mode.
•
Indicates to split both the A and B paths. Connect the line incoming from E direction to the line outgoing in the E direction, and connect this looped configuration to the FAD. The line outgoing in the F direction shall have a QRS connected, and the line incoming from the F direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
•
Indicates to split both the A and B paths. Connect the line incoming from F direction to the line outgoing in the F direction, and connect this looped configuration to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
•
Indicates that a monitor connection is to be provided from the FAD to the A transmission path of the accessed circuit.
•
Indicates that a monitor connection is to be provided from the FAD1 to a DFAD, or the odd pair of a FAP, to the A transmission path and from FAD2 of the same DFAD, or the even pair of a FAP, to the B transmission path of the accessed circuit.
•
Indicates that a monitor connection is to be provided from the FAD to the B transmission path of the accessed circuit.
•
Indicates that a connection is to be provided from both the E and F sides of the A transmission path of the circuit under test to the FAD and split the A transmission path. Intrusive test access mode.
•
Indicates that a connection is to be provided from both the E and F sides of the B transmission path of the circuit under test to the FAD and split the B transmission path. Intrusive test access mode.
•
Indicates to split both the A and B paths and connect the E side of the accessed circuit to the FAD. The line outgoing in the F direction shall have a QRS connected, and the line incoming from the F direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
•
Indicates to split both the A and B paths, and connect the E side of the accessed circuit to FAD1 and the F side to FAD2. Intrusive test access mode.
•
Indicates to split both the A and B paths, and connect the F side of the accessed circuit to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
<CROSSCONNECTID1>
(Optional) Access identifier from the "CrossConnectId" section. The E path of the cross-connect.
<AIDUNIONID>
Access identifier from the "AidUnionId" section.
<PATHWIDTH>
Cross-connect width. The parameter type is CRS_TYPE, which is the cross-connection type.
•
All VC cross-connects
•
VC3 cross-connect
•
VC4 cross-connect
•
VC4-2C cross-connect
•
VC4-3C cross-connect
•
VC4-4C cross-connect
•
VC4-6C cross-connect
•
VC4-8C cross-connect
•
VC4-12C cross-connect
•
VC4-16C cross-connect
•
VC4-64C cross-connect
•
VC11 cross-connect
•
VC12 cross-connect
23.151 RTRV-TADRMAP
The Retrieve Target Identifier Address Mapping (RTRV-TADRMAP) command retrieves the contents of the TADRMAP table.
Usage Guidelines
When MODE is NSAP, TID name of the NODE can be specified to trigger TARP.
Category
System
Security
Provisioning
Input Format
RTRV-TADRMAP:[<TID>]:[<AID>]:<CTAG>[:::MODE=<MODE>];
Input Example
RTRV-TADRMAP:CISCO:AIP:100:::MODE=PROV;
Table 23-162 Input Parameter Support
<AID>
Access identifier from the "ALL" section.
<MODE>
(Optional) Must not be null. The parameter type is MODE, which determines the category of addresses to return.
•
Discovered and provisioned addresses
•
Discovered addresses
•
IP addresses
•
NSAP addresses
•
Provisioned
Output Format
SID DATE TIME
M CTAG COMPLD
"[TID=<TID>],[IP ADDRESS =<IPADDRESS>],[NSAP=<NSAP>]"
;Output Examples
1.
M 001 COMPLD
"TID=RANGERS1,IP ADDRESS = 64.101.245.5,
NSAP=39840FFFFFFFOOOODDDDAA01D00F0400000700"
;1.
M 001 COMPLD
"TID=RANGERS1,IP ADDRESS ="[3ffe:0501:0008:0000:0260:97ff:fe40:efab]", NSAP=39840FFFFFFFOOOODDDDAA01D00F0400000700"
;
23.152 RTRV-TH-<MOD2>
The Retrieve Threshold for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 4GFC, 2GFICON, 5GIB, 8GFC, CLNT, D1VIDEO, DS3I, DV6000, DVBASI, E1, E3, E4, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, OTU3, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, VC12, 3GVIDEO, SDSDI , HDSDI, AUTO, OTL, OTU1, OTU2, OTU4, ISC3STP1G, or ISC3STP2G (RTRV-TH-<MOD2>) command retrieves the threshold level of one or more monitored parameters. See Table 29-1for supported modifiers by platform.
Usage Guidelines
The command supports the modifier 3GVIDEO, SDSDI , HDSDI, AUTO, OTU1, ISC3STP1G, and ISC3STP2G.
•
•
•
•
•
•
•
•
•
Category
Performance
Security
Retrieve
Input Format
RTRV-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],[<TMPER>][::];
Input Example
RTRV-TH-OCH:100G-LC-C:CHAN-7-2:1::OSNR-MIN,NEND,15-MIN;
Table 23-164 Input Parameter Support
<AID>
Access identifier from the "ALL" section. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier.
<MONTYPE>
(Optional) Monitored type. A null value is equivalent to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list.
Note
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed in tenths of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed in tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count-Path Detected
•
High-Order Path Negative Pointer Justification Count-Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive SES
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count-Path Detected
•
Negative Pointer Justification Count-Path Generated
•
Average Receive Power in tenths of a microW
•
Maximum Receive Power in tenths of a microW
•
Minimum Receive Power in tenths of a micro W
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<LOCN>
(Optional) Location associated with a particular command in reference to the entity identified by the AID. LOCN defaults to NEND. A null value is equivalent to ALL. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<TMPER>
(Optional) Accumulation time period for performance counters. Defaults to 15-MIN. Must not be null. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length is every 24 hours. For NCS PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
•
Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<MONTYPE>,[<LOCN>],,<THLEV>,[<TMPER>]"
;
Output Example
100g 2012-05-15 14:28:19
M 1 COMPLD
"CHAN-2-2,OCH:OSNR-MAX,NEND,,40.0,15-MIN"
;
Table 23-165 Output Parameter Support
<AID>
Access identifier from the "ALL" section.
<AIDTYPE>
(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
•
100 Gigabit Ethernet.
•
10 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
10-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Channel group
•
Client facility for MXP/TXP cards
•
DS3i-N-12 facility
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 facility
•
E100 facility
•
E1000 facility
•
E3 facility
•
E4 facility
•
EQPT facility
•
ETH facility
•
Fast Ethernet port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 peer
•
2-Gbps ISC3 peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port alarm
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 alarm
•
STM1E alarm
•
STM4 alarm
•
STM16 alarm
•
STM64 alarm
•
VC11 alarm
•
VC12 alarm
•
VC3 alarm
•
VC44C alarm
•
VC38C alarm
•
VC464C alarm
•
VC48C alarm
•
VC4 alarm
•
VC416C alarm
•
VC42C alarm
•
VC43C alarm
<MONTYPE>
Monitored type. The parameter type is ALL_MONTYPE, which is the monitored type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed as tenths of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed as tenths of a percentage
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed as tenths of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed as tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count-Path Detected
•
High-Order Path Negative Pointer Justification Count-Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive SES
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Protection switch count
•
Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count-Path Detected
•
Negative Pointer Justification Count-Path Generated
•
Average Receive Power in tenths of a micro W
•
Maximum Receive Power in tenths of a micro W
•
Minimum Receive Power in tenths of a micro W
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<LOCN>
(Optional) Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<THELV>
Threshold level. THLEV is a float.
<TMPER>
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
•
Performance parameter accumulation interval length is every 24 hours. For NCS PM data only one day of history data is available. For RMON managed PM data, seven days of history data are available.
•
Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
•
Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
•
Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
•
Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
23.153 RTRV-TH-ALL
The Retrieve Threshold All (RTRV-TH-ALL) command retrieves the threshold level of all monitored parameters on the NE.
Usage Guidelines
•
•
•
•
•
Category
Performance
Security
Retrieve
Input Format
RTRV-TH-ALL:[<TID>]::<CTAG>::[<MONTYPE>],[<LOCATION>],[<TMPER>][::];
Input Example
RTRV-TH-ALL:CHARGERS6::123::CVL,NEND,15-MIN;
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>,<AIDTYPE>:<MONTYPE>,<LOCATION>,,<THLEV>,<TMPER>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-1-1,E3:CVL,NEND,,1,15-MIN"
;
Table 23-167 Output Parameter Support
<AID>
Access identifier from the "AidUnionId" section.
<AIDTYPE>
Specifies the type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type for certain generic TL1 commands.
•
100 Gigabit Ethernet.
•
10 Gigabit Ethernet.
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
2-Gigabit Fibre Channel payload
•
10-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
Channel group
•
Client facility for MXP/TXP cards
•
DS3i-N-12 facility
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1 facility
•
E3 facility
•
E100 facility
•
E1000 facility
•
E4 facility
•
ENV facility
•
ETH facility
•
EQPT facility
•
Fast Ethernet port facility
•
G1000 facility
•
Gigabit Ethernet port facility
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload
•
InterSystem Channel, a protocol defined by IBM (ISC1) payload
•
1-Gbps ISC3 peer
•
2-Gbps ISC3 peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical channel
•
Optical Data Unit Level 0
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Channel Transport Lane.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port facility
•
Resilient Ethernet Protocol
•
270M SDI video payload
•
STM1 facility
•
STM1E facility
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
VC11 path
•
VC12 path
•
VC3 path
•
VC44C path
•
VC38C path
•
VC464C path
•
VC48C path
•
VC4 path
•
VC416C path
•
VC42C path
•
VC43C path
<MONTYPE>
Monitored type. A null value defaults to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list.
•
Alarm Indication Signal Seconds—Path
•
All possible values
•
NCS Background Block Errors Path
•
OTN—Background Block Errors—Path Monitor Point
•
NCS Background Block Error Ratio
•
OTN—Background Block Error Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Error Ratio—Section Monitor Point expressed in tenths of a percentage
•
OTN—Background Block Errors—Section Monitor Point
•
FEC—Bit Errors Corrected
•
The number of bit errors corrected by the FEC algorithm
•
8B10B—Code Group Violations
•
Coding Violations—CP-Bit Path
•
Coding Violations—Line
•
Coding Violations—Path
•
Coding Violations—Section
•
Coding Violations—Section
•
8B10B—Data Code Groups
•
Errored Seconds—CP—Bit Path
•
Errored Seconds—Line
•
Errored Seconds—Path
•
OTN—Errored Seconds—Path Monitor Point
•
Errored Second—Ratio
•
Errored Seconds Ratio—Path monitor Point expressed in tenths of a percentage
•
Errored Seconds Ratio—Section monitor Point expressed in tenths of a percentage
•
Errored Seconds—Section
•
OTN—Errored Seconds—Section Monitor Point
•
Errored Seconds—VC Path
•
The total number of good packets received that were directed to a multicast address
•
Number of transmit packets that are collisions
•
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
•
Number of received frames dropped at the port level
•
The total number of packets received that were less than 64 octets
•
The total number of packets received that are longer than 1518 octets
•
The total number of octets of data
•
The total number of packets received that are longer than 1518 octets
•
The total number of packets (including bad packets, broadcast packets, and multicast packets) received
•
The total number of packets received that are less than 64 octets
•
Failure Count—Line
•
OTN—Failure Count—Path Monitor Point
•
OTN—Failure Count—Section Monitor Point
•
Availability Ratio
•
High-Order Path Background Block Error
•
High-Order Path Background Block Error Ratio
•
High-Order Path Errored Block
•
High-Order Path Errored Second
•
High-Order Path Errored Seconds—A
•
High-Order Path Errored Seconds—B
•
High-Order Path Errored Second Ratio
•
High-Order Path Failure Count
•
High-Order Path Negative Pointer Justification Count-Path Detected
•
High-Order Path Negative Pointer Justification Count-Path Generated
•
Outage Intensity
•
High-Order Path Pointer Justification Count Difference
•
High-Order Path Pointer Justification Count Seconds-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Detected
•
High-Order Path Positive Pointer Justification Count-Path Generated
•
The number of SEP events in available time
•
High-Order Path Severely Errored Seconds
•
High-Order Path Severely Errored Second Ratio
•
High-Order Path Unavailable Seconds
•
Number of broadcast packets received since the last counter reset
•
The number of inbound packets
•
Receive Error Byte
•
The number of inbound packets (or transmission units) that contained errors
•
Receive Framing Error
•
Receive Interpacket Junk
•
Number of multicast packets received since the last counter reset
•
Number of bytes transmitted since the last counter reset
•
Number of unicast packets received since the last counter reset
•
Number of broadcast packets transmitted
•
The number of outbound packets
•
The number of outbound packets (or transmission units) that could not be transmitted because of errors
•
Number of multicast packets transmitted
•
Received payload CRC errors
•
Number of unicast packets transmitted
•
8B10B—Idle Ordered Sets
•
Invalid Packet Count
•
Average Laser Bias Current in microA
•
Maximum Laser Bias Current in microA
•
Minimum Laser Bias Current in microA
•
Normalized Laser Bias Current for STM1-8
•
Normalized Laser Bias Current—Higher Threshold
•
Normalized Laser Bias Current—Lower Threshold
•
Loss of Signal Seconds—Line
•
Low-Order Path Background Block Error
•
Low-Order Path Background Block Error Ratio
•
Low-Order Path Errored Block
•
Low-Order Path Errored Second
•
Low-Order Path Errored Seconds—A
•
Low-Order Path Errored Seconds—B
•
Low-Order Path Errored Second Ratio
•
Low-Order Path Failure Count
•
Low-Order Negative Pointer Justification Count-Detected
•
Low-Order Negative Pointer Justification Count-Generated
•
Low-Order Positive Pointer Justification Count-Detected
•
Low-Order Positive Pointer Justification Count-Generated
•
A sequence of between 3 to 9 consecutive SES
•
Low-Order Path Severely Errored Period Intensity
•
Low-Order Path Severely Errored Seconds
•
Low-Order Path Unavailable Seconds
•
Multiplex Section-Protection switch count
•
Multiplex Section-Protection switch duration
•
8B10B—Non Idle Ordered Sets
•
Negative Pointer Justification Count-Path Detected
•
Negative Pointer Justification Count-Path Generated
•
Average Receive Power in tenths of a microW
•
Maximum Receive Power in tenths of a microW
•
Minimum Receive Power in tenths of a microW
•
Normalized Optical Receive Power for STM1-8
•
Maximum value for OPRN
•
Minimum value for OPRN
•
Average Transmit Power in tenths of a microW
•
Maximum Transmit Power in tenths of a microW
•
Minimum Transmit Power in tenths of a microW
•
Normalized value for Optical Power Transmitted for STM1-8 card
•
Maximum value for OPTN
•
Minimum value for OPTN
•
Optical Power—Average Interval Value in tenths of a dBm
•
Optical Power—Maximum Interval Value in tenths of a dBm
•
Optical Power—Minimum Interval Value in tenths of a dBm
•
Positive Pointer Justification Count-Path Detected
•
Positive Pointer Justification Count-Path Generated
•
Enum to hold PRE-FECBER value
•
Protection Switching Count
•
Protection Switching Count—Ring
•
Protection Switching Count—Span
•
Protection Switching Count—Working
•
Protection Switching Duration
•
Protection Switching Duration—Ring
•
Protection Switching Duration—Span
•
Protection Switching Duration—Working
•
Severely Errored Framing/AIS Second—CP-Bit Path
•
Severely Errored Framing/AIS Seconds Path
•
Severely Errored Framing Seconds
•
Severely Errored Second—CP-Bit Path
•
Severely Errored Second—Line
•
Severely Errored Second—Path
•
OTN—Severely Errored Second—Path
•
Severely Errored Second—Ratio
•
OTN—Severely Errored Second Ratio—Path Monitor Point expressed in tenths of a percentage
•
OTN—Severely Errored Second Ratio—Section Monitor Point expressed in tenths of a percentage
•
Severely Errored Second—Section
•
OTN—Severely Errored Second—Section Monitor Point
•
Severely Errored Second—VC Path
•
Unavailable Second—CP-Bit Path
•
Unavailable Second—Line
•
Unavailable Second—Path
•
OTN—Unavailable Second—Path Monitor Point
•
OTN—Unavailable Second—Section Monitor Point
•
Unavailable Second—VC Path
•
FEC—Uncorrectable Words
•
Valid Packet Count
•
Minimum Optical Signal To Noise Ratio.
•
Maximum Optical Signal To Noise Ratio.
•
Average Optical Signal To Noise Ratio.
•
Minimum Polarization Mode Dispersion.
•
Maximum Polarization Mode Dispersion.
•
Average Polarization Mode Dispersion.
<LOCATION>
The location. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
•
Action occurs on the far end of the facility.
•
Action occurs on the near end of the facility.
<THLEV>
Threshold level. Indicates the threshold value. THLEV is a float.
<TMPER>
The accumulation time period for performance counters. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management counter.
•
Performance parameter accumulation interval length is every 24 hours.
•
Performance parameter accumulation interval length is every 1 hour.
•
Performance parameter accumulation interval length is every 1 minute.
•
Performance parameter accumulation interval length is every 15 minutes.
•
Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON-managed PMs.
23.154 RTRV-TOD
The Retrieve Time of Day (RTRV-TOD) command retrieves the system date and time at the instant when the command was executed. The time returned is in Coordinated Universal Time (UTC).
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-TOD:[<TID>]::<CTAG>;
Input Example
RTRV-TOD:CAZADERO::230;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,<DIFFERENCE>:<TMTYPE>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"2002,05,08,17,01,33,840:LINT"
;
23.155 RTRV-TRAPTABLE
The Retrieve Trap Table (RTRV-TRAPTABLE) command retrieves a trap destination entry identified by a specific trap destination address.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-TRAPTABLE:[<TID>]:[<AID>]:<CTAG>;
Input Examples
1.
2.
Input Parameters
<AID>
Access identifier from the "IPADDR" section. IP address identifying the trap destination. Only a numeric IP address is allowed. A null value is equivalent to ALL.
Output Format
SID DATE TIME
M CTAG COMPLD
"<DEST>,<TRAPPORT>,<COMMUNITY>,<SNMPVERSION>"
;Output Examples
1.
M 001 COMPLD
"1.2.3.4,162,\"PRIVATE\",SNMPV1"
;2.
M 001 COMPLD
"3ffe:0501:0008:0000:0260:97ff:fe40:efab,162,\"PRIVATE\",SNMPV1"
;
Table 23-169 Output Parameter Support
<DEST>
Access identifier from the "IPADDR" section.
<TRAPPORT>
UDP port number associated with the trap destination. Defaults to 162. TRAPPORT is an integer.
<COMMUNITY>
Community name associated to the trap destination. Maximum of 32 characters. COMMUNITY is a string.
<SNMPVERSION>
SNMP version number. Defaults to SNMPv1. The parameter type is SNMP_VERSION, which is the SNMP version.
•
SNMP version 1 (default)
•
SNMP version 2
23.156 RTRV-TRC-<STM_MSSPR>
The Retrieve Trace Client for STM4, STM64, or STM16 (RTRV-TRC-<STM_MSSPR>) command retrieves the valid J1 expected trace string, retrieved trace string, trace mode, C2 byte, and VC bandwidth of the STM port only if the port has a MS-SPRing. See Table 29-1 for supported modifiers by platform.
Usage Guidelines
•
•
Category
MS-SPRing
Security
Retrieve
Input Format
RTRV-TRC-<STM_MSSPR>:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-TRC-STM16:CISCO:FAC-6-1:238;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[C2=<C2>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VC4-6-1-25::LEVEL=VC4,EXPTRC="EXPTRCSTRING",INCTRC="INCTRCSTRING",
TRCMODE=AUTO,C2=0X04"
;
Table 23-170 Output Parameter Support
<AID>
Access identifier from the "VC" section.
<LEVEL>
(Optional) The rate of the cross-connect. The parameter type is VC_PATH, which is the modifier for some VC commands.
•
VC3 level
•
VC4-4C level
•
VC4-64C level
•
VC4-8C level
•
VC4 level
•
VC4-16C level
•
VC4-2C level
•
VC4-3C level
<EXPTRC>
(Optional) Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR and LF. EXPTRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters including CR and LF. INCTRC is a string.
<TRCMODE>
(Optional) Trace mode. The parameter type is TRCMODE (trace mode).
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Turn off path trace capability. Nothing will be reported.
<C2>
(Optional) The C2 byte hex code. Applicable only to VC-level paths in NCS (VCn). The parameter type is C2_BYTE, which is the C2 byte hex code.
•
Unequipped
•
Equipped-Non Specific Payload
•
VT-Structured VC-1 SPE
•
Locked VT mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-over-NCS Mapping
•
VT-structured VC4-1 SPE with 1VTx payload defect
•
VT-structured VC4-1 SPE with 2VTx payload defects
•
VT-structured VC4-1 SPE with 3VTx payload defects
•
VT-structured VC4-1 SPE with 4VTx payload defects
•
VT-structured VC4-1 SPE with 5VTx payload defects
•
VT-structured VC4-1 SPE with 6VTx payload defects
•
VT-structured VC4-1 SPE with 7VTx payload defects
•
VT-structured VC4-1 SPE with 8VTx payload defects
•
VT-structured VC4-1 SPE with 9VTx payload defects
•
VT-structured VC4-1 SPE with 10VTx payload defects
•
VT-structured VC4-1 SPE with 11VTx payload defects
•
VT-structured VC4-1 SPE with 12VTx payload defects
•
VT-structured VC4-1 SPE with 13VTx payload defects
•
VT-structured VC4-1 SPE with 14VTx payload defects
•
VT-structured VC4-1 SPE with 15VTx payload defects
•
VT-structured VC4-1 SPE with 16VTx payload defects
•
VT-structured VC4-1 SPE with 17VTx payload defects
•
VT-structured VC4-1 SPE with 18VTx payload defects
•
VT-structured VC4-1 SPE with 19VTx payload defects
•
VT-structured VC4-1 SPE with 20VTx payload defects
•
VT-structured VC4-1 SPE with 21VTx payload defects
•
VT-structured VC4-1 SPE with 22VTx payload defects
•
VT-structured VC4-1 SPE with 23VTx payload defects
•
VT-structured VC4-1 SPE with 24VTx payload defects
•
VT-structured VC4-1 SPE with 25VTx payload defects
•
VT-structured VC4-1 SPE with 26VTx payload defects
•
VT-structured VC4-1 SPE with 27VTx payload defects
•
VT-structured VC4-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
23.157 RTRV-TRC-<OCN_BLSR>
The Retrieve Trace Client for OC12, OC192, OC48, or OC768 (RTRV-TRC-<OCN_BLSR>) command retrieves the valid J1 expected trace string, retrieved trace string, trace mode, C2 byte, and STS bandwidth of the OC-N port only if the port has a BLSR.
Usage Guidelines
•
•
•
Category
BLSR
Security
Retrieve
Input Format
RTRV-TRC-<OCN_BLSR>:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-TRC-OC48:CISCO:FAC-6-1:238;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>],
[TRCMODE=<TRCMODE>],[C2=<C2>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"STS-6-1-25::LEVEL=STS1,EXPTRC="EXPTRCSTRING",INCTRC="INCTRCSTRING",
TRCMODE=AUTO,C2=0X04"
;Output Parameters
<AID>
Access identifier from the "VC" section.
<LEVEL>
(Optional) The rate of the cross-connect. The parameter type is STS_PATH, which is the modifier for some STS commands.
•
Synchronous Transport Signal level 1 (51 Mbps)
•
Synchronous Transport Signal level 12 Concatenated (622 Mbps)
•
Synchronous Transport Signal level 18 Concatenated (933 Mbps)
•
Synchronous Transport Signal level 192 (9952 Mbps)
•
Synchronous Transport Signal level 24 Concatenated (1240 Mbps)
•
Synchronous Transport Signal level 36 Concatenated (1866 Mbps)
•
Synchronous Transport Signal level 3 Concatenated (155 Mbps)
•
Synchronous Transport Signal level 48 Concatenated (2488 Mbps)
•
Synchronous Transport Signal level 3 Concatenated (310 Mbps)
•
Synchronous Transport Signal level 9 Concatenated (465 Mbps)
<EXPTRC>
(Optional) Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). EXPTRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters including CR and LF. INCTRC is a string.
<TRCMODE>
(Optional) Trace mode. The parameter type is TRCMODE (trace mode).
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIM-P is detected.
•
Use the provisioned expected string as the expected string
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIM-P is detected.
•
Turn off path trace capability. Nothing will be reported
<C2>
(Optional) The C2 byte hex code. Applicable only to STS-level paths in SONET (STSn). The parameter type is C2_BYTE, which is the C2 byte hex code.
•
Unequipped
•
Equipped-Non Specific payload
•
VT-Structured STS-1 SPE
•
Locked VT Mode
•
Asynchronous Mapping for DS3
•
Asynchronous Mapping for DS4NA
•
Mapping for ATM
•
Mapping for DQDB
•
Asynchronous Mapping for FDDI
•
HDLC-Over-SONET Mapping
•
VT-structured STS-1 SPE with 1VTx payload defect
•
VT-structured STS-1 SPE with 2VTx payload defects
•
VT-structured STS-1 SPE with 3VTx payload defects
•
VT-structured STS-1 SPE with 4VTx payload defects
•
VT-structured STS-1 SPE with 5VTx payload defects
•
VT-structured STS-1 SPE with 6VTx payload defects
•
VT-structured STS-1 SPE with 7VTx payload defects
•
VT-structured STS-1 SPE with 8VTx payload defects
•
VT-structured STS-1 SPE with 9VTx payload defects
•
VT-structured STS-1 SPE with 10VTx payload defects
•
VT-structured STS-1 SPE with 11VTx payload defects
•
VT-structured STS-1 SPE with 12VTx payload defects
•
VT-structured STS-1 SPE with 13VTx payload defects
•
VT-structured STS-1 SPE with 14VTx payload defects
•
VT-structured STS-1 SPE with 15VTx payload defects
•
VT-structured STS-1 SPE with 16VTx payload defects
•
VT-structured STS-1 SPE with 17VTx payload defects
•
VT-structured STS-1 SPE with 18VTx payload defects
•
VT-structured STS-1 SPE with 19VTx payload defects
•
VT-structured STS-1 SPE with 20VTx payload defects
•
VT-structured STS-1 SPE with 21VTx payload defects
•
VT-structured STS-1 SPE with 22VTx payload defects
•
VT-structured STS-1 SPE with 23VTx payload defects
•
VT-structured STS-1 SPE with 24VTx payload defects
•
VT-structured STS-1 SPE with 25VTx payload defects
•
VT-structured STS-1 SPE with 26VTx payload defects
•
VT-structured STS-1 SPE with 27VTx payload defects
•
VT-structured STS-1 SPE with 28VTx payload defects
•
O.181 Test Signal (TSS1 to TSS3) Mapping
•
Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
23.158 RTRV-TRC-OCH
The Retrieve Trace Optical Channel (RTRV-TRC-OCH) command retrieves the sent trace string, expected trace string, received trace string, trace mode, and the trace level for the NCS J0 section and the TTI PATH and SECTION monitoring levels of the NCS facility.
Usage Guidelines
•
–
–
•
–
–
–
•
–
–
–
–
Category
NCS
Security
Retrieve
Input Format
RTRV-TRC-OCH:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];
Input Example
RTRV-TRC-OCH:CISCO:CHAN-2-2:100::EXPTRC,TTI-PM;
Table 23-171 Input Parameter Support
<SRC>
Access identifier from the "CHANNEL" section.
<MSGTYPE>
Type of autonomous message to be retrieved. A null value is equivalent to ALL. The parameter type is MSGTYPE, which is the type of trace message.
•
Expected incoming path trace message
•
Incoming path trace message
•
Outgoing path trace message
<TRCLEVEL>
The trace level to be managed. A null value is equivalent to ALL. The parameter type is TRCLEVEL, which is the trace mode options.
•
Identifies the NCS J0 section trace level.
•
Identifies the TTI path monitoring point.
•
Identifies the TTI section monitoring point.
Output Format
SID DATE TIME
M CTAG COMPLD
"<CHANNEL>,<MOD>::[TRCLEVEL=<TRCLEVEL>],[EXPTRC=<EXPTRC>],
[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CHAN-2-2,OCH::TRCLEVEL=TTI-PM,EXPTRC=\"AAA\",TRC=\"AAA\",
INCTRC=\"AAA\",TRCMODE=MAN,TRCFORMAT=64-BYTE"
;
Table 23-172 Output Parameter Support
<CHANNEL>
Access identifier from the "CHANNEL" section.
<MOD>
Indicates an OCH AID type. The parameter type is MOD2, which is the line/path modifier.
•
10-Gigabit Fibre Channel payload
•
10-Gigabit fiber connectivity payload
•
1-Gigabit Fibre Channel payload
•
1-Gigabit fiber connectivity payload
•
1-Gigabit ISC3 compatible
•
2-Gigabit Fibre Channel payload
•
2-Gigabit fiber connectivity payload
•
2-Gigabit ISC3 compatible
•
3G-SDI video payload.
•
4-Gigabit Fibre Channel payload
•
4-Gigabit fiber connectivity payload
•
40-Gigabit Ethernet
•
100-Gigabit Ethernet
•
5Gbps InfiniBand (IB_5G) payload
•
8-Gigabit Fibre Channel payload
•
Channel group
•
D1 video
•
DS3i-N-12 line
•
Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload
•
E1
•
E3
•
E4 frame. Only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
•
ESCON
•
ETRCLO
•
FSTE facility
•
G1000 facility
•
GFP over POS, virtual ports partitioned using GFP's multiplexing capability
•
Gigabit Ethernet
•
High-level data link control (HDLC) frame mode.
•
1.5G HD-SDI video payload.
•
HDTV
•
1-Gbps ISC3 peer
•
2-Gbps ISC3 peer
•
1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
•
ISC-3 STP 1G video payload.
•
ISC-3 STP 2G video payload.
•
1-Gbps ISC1, ISC2, and ISC3 compatibility
•
MSISC
•
Optical Channel
•
OCH client connection
•
OCH network connection
•
OCH termination
•
Optical Multiplex Section
•
Optical Transport Section
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
•
POS port
•
Resilient Ethernet Protocol
•
Raman Pump Amplifier
•
270M SDI video payload.
•
STM1 facility
•
STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of NCS STM1E-12 card
•
STM4 facility
•
STM16 facility
•
STM64 facility
•
VC3 path
•
VC4-4C path
•
VC3-8C path
•
VC4-64C path
•
VC4-8C path
•
VC4 path
•
VC4-16C path
•
VC4-2C path
•
VC4-3C path
•
VC11 path
•
VC12 path
<TRCLEVEL>
(Optional) The trace level to be managed. The parameter type is TRCLEVEL, which is the trace mode options.
•
Identifies the NCS J0 section trace level.
•
Identifies the TTI path monitoring point.
•
Identifies the TTI section monitoring point.
<EXPTRC>
(Optional) Expected path trace content. A 64 character ASCII string.
<TRC>
(Optional) The path trace message to be transmitted. The trace byte continuously transmits a 64 byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00), CR, and LF. TRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is a string.
<TRCMODE>
(Optional) Trace mode. The parameter type is TRCMODE (trace mode).
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Turn off path trace capability. Nothing will be reported.
<TRCFORMAT>
(Optional) The size of the trace message. If in NCS mode, only 1 or 16 bytes is applicable for the J0 section trace. The TTI level trace is only 64 bytes. The parameter type is TRCFORMAT, which is the trace format.
•
1-byte trace message
•
16-byte trace message
•
64-byte trace message
23.159 RTRV-TRC-OTU
The Retrieve Trace Optical Transport Unit Level (RTRV-TRC-OTU) command retrieves the sent trace string, expected trace string, received trace string, trace mode, and the trace level for the NCS J0 section and the TTI PATH and SECTION monitoring levels of the NCS facility.
Usage Guidelines
•
–
–
•
–
–
–
•
–
–
–
–
Category
NCS
Security
Retrieve
Input Format
RTRV-TRC-OTU:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];
Input Example
RTRV-TRC-OTU1:CISCO:VFAC-2-2-1:100::EXPTRC,TTI-PM;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<CHANNEL>,<MOD>::[TRCLEVEL=<TRCLEVEL>],[EXPTRC=<EXPTRC>], [TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>], [TRCFORMAT=<TRCFORMAT>]"
;
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-2-2-1,OTU1::TRCLEVEL=TTI-PM,EXPTRC=\"AAA\",TRC=\"AAA\", INCTRC=\"AAA\",TRCMODE=MAN,TRCFORMAT=64-BYTE"
;
Output Parameters
Table 23-173 Output Parameter Support
<CHANNEL>
Access identifier from the "CHANNEL" section.
<MOD>
Indicates an OTU AID type. The parameter type is MOD2, which is the line/path modifier.
•
Optical Transport Unit Level 1
•
Optical Transport Unit Level 2
•
Optical Transport Unit Level 3
•
Optical Transport Unit Level 4
<TRCLEVEL>
(Optional) The trace level to be managed. The parameter type is TRCLEVEL, which is the trace mode options.
•
Identifies the NCS J0 section trace level.
•
Identifies the TTI path monitoring point.
•
Identifies the TTI section monitoring point.
<EXPTRC>
(Optional) Expected path trace content. A 64 character ASCII string.
<TRC>
(Optional) The path trace message to be transmitted. The trace byte continuously transmits a 64 byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00), CR, and LF. TRC is a string.
<INCTRC>
(Optional) The incoming path trace message contents. INCTRC is a string.
<TRCMODE>
(Optional) Trace mode. The parameter type is TRCMODE (trace mode).
•
Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.
•
Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Use the provisioned expected string as the expected string.
•
Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected.
•
Turn off path trace capability. Nothing will be reported.
<TRCFORMAT>
(Optional) The size of the trace message. If in NCS mode, only 1 or 16 bytes is applicable for the J0 section trace. The TTI level trace is only 64 bytes. The parameter type is TRCFORMAT, which is the trace format.
•
1-byte trace message
•
16-byte trace message
•
64-byte trace message
23.160 RTRV-TUNNEL-FIREWALL
The Retrieve Tunnel Firewall (RTRV-TUNNEL-FIREWALL) command retrieves the contents of the firewall tunnel table.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-TUNNEL-FIREWALL:[<TID>]::<CTAG>;
Input Example
RTRV-TUNNEL-FIREWALL:TID::CTAG;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>],
[DEST MASK=<DESTMASK>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7,
DEST MASK=255.255.255.0"
;
23.161 RTRV-TUNNEL-PROXY
The Retrieve Tunnel Proxy (RTRV-TUNNEL-PROXY) command retrieves the contents of the proxy tunnel table.
Usage Guidelines
None
Category
System
Security
Retrieve
Input Format
RTRV-TUNNEL-PROXY:[<TID>]::<CTAG>;
Input Example
RTRV-TUNNEL-PROXY:TID::100;
Input Parameters
None
Output Format
SID DATE TIME
M CTAG COMPLD
"[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>],
[DEST MASK=<DESTMASK>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7,
DEST MASK=255.255.255.0"
;
23.162 RTRV-UNICFG
The Retrieve User Network Interface Configuration (RTRV-UNICFG) command retrieves the attributes and service parameters of the UNI configuration created.
Usage Guidelines
•
Category
NCS
Security
Provisioning
Input Format
RTRV-UNICFG:[<TID>]:<src>:<CTAG>::[:];
Input Example
RTRV-UNICFG::LINE-2-3:1;
Table 23-176 Input Parameter Support
<SRC>
Source AID from the "ALL" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>:<RVRSAID>,<RSYSIP>,<RIFCIP>,<MSTPIP>,<COMMIP>,<VALMODE>,<VALZONE>,<DESCR>,<ADMINSTATE>,<RESTTYPE>,<CKTLABEL>,<UPSTRMPWR>,<DNSTRMPWR>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"LINE-2-1:LINE-4-3,10.11.12.13,14.15.16.17,18.19.20.21,22.23.24.25,VALMODE=FULL,VALZONE=GREEN,DESCR=CISCO,USPWROFS=0.0,DSPWROFS=2.0";
Table 23-177 Output Parameter Support
<SRC>
Source AID from the "ALL" section.
<RVRSAID>
Destination AID from the "ALL" section.
<RSYSIP>
Remote system IP.
<RIFCIP>
Remote interface IP.
<MSTPIP>
MSTP interface IP.
<COMMIP>
Communication IP.
<VALMODE>
Identifies the validation mode.
•
No optical validation is performed.
•
The optical validation is performed as indicated in VALZONE parameter.
<VALZONE>
Identifies the validation operate zone.
•
Not evaluated.
•
Margin > 3 sigma.
•
1 < margin < 3 sigma.
•
0 < margin < 1 sigma.
•
-3 < margin < 0 sigma.
•
Margin < -3 sigma.
<ADMINSTATE>
Identifies the adminstate is UP or DOWN.
•
Indicates Adminstate is UP and UNI Services can be activated.
•
Indicates Adminstate is DOWN and UNI Services cannot be activated.
<RESTTYPE>
Indentifies the restoration type on UNI configuration.
•
None restoration type for UNICFG.
•
Restore restoration type for UNICFG.
<CKTLABEL>
Circuit label.
<CKTPRIORITY>
Circuit Priority.
<DSPWROFS>
Down stream power offset.
<USPWROFS>
Up stream power offset.
23.163 RTRV-USER-SECU
The Retrieve User Security (RTRV-USER-SECU) command retrieves the security information of a specified user or list of users. The keyword ALL can be used to obtain a list of all users. For security reasons, the password cannot be retrieved.
Usage Guidelines
•
•
Category
Security
Security
Retrieve
Note
Input Format
RTRV-USER-SECU:[<TID>]:<UID>:<CTAG>;
Input Example
RTRV-USER-SECU::CISCO15:1;
Input Parameters
<UID>
User identifier. The user ID or the keyword ALL. If you are not a Superuser, you can only specify your own user ID. Must not be null. UID is a string.
Output Format
SID DATE TIME
M CTAG COMPLD
"<UID>:,<PRIVILEGE>:LOGGEDIN=<LOGGEDIN>,[NUMSESSIONS=<NUMSESS>],
[LOCKEDOUT=<LOCKEDOUT>],[DISABLED=<DISABLED>]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"CISCO15:,SUPER:LOGGEDIN=YES,NUMSESSIONS=1,LOCKEDOUT=NO,DISABLED=NO"
;
23.164 RTRV-VCG
The Retrieve Virtual Concatenated Group (RTRV-VCG) command retrieves all the attributes provisioned for a VCG.
Usage Guidelines
None
Category
VCAT
Security
Retrieve
Input Format
RTRV-VCG:[<TID>]:<SRC>:<CTAG>[::::];
Input Example
RTRV-VCG:NODE1:VFAC-1-1:1234;
Input Parameters
<SRC>
Source access identifier from the "FACILITY" section. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID.
Output Format
SID DATE TIME
M CTAG COMPLD
"<SRC>::TYPE=<TYPE>,TXCOUNT=<TXCOUNT>,CCT=<CCT>,[LCAS=<LCAS>],
[BUFFERS=<BUFFERS>],[NAME=<NAME>]:<PST>"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VFAC-1-1::TYPE=VC3,TXCOUNT=8,CCT=2WAY,LCAS=LCAS,BUFFERS=DEFAULT,
NAME="VCG2":UNLOCKED"
;
Table 23-179 Output Parameter Support
<SRC>
Source access identifier from the "FACILITY" section. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID.
<TYPE>
The type of the entity being provisioned. Null indicates not applicable. TYPE can be a CLEI code or another value. The type of member cross-connect. ML1000-2 and ML100T-12 cards support VC3, VC4C, and VC44C. The FC_MR-4 card supports VC4C only. The parameter type is MOD_PATH, which is the VC path modifier.
•
VC3 Path
•
VC4-4C Path
•
VC3-8C Path
•
VC4-64C Path
•
VC4-8C Path
•
VC4 Path
•
VC4-16C Path
•
VC4-2C Path
•
VC4-3C Path
•
VC11 Path
•
VC12 Path
<TXCOUNT>
Number of VCG members in the transmit direction. For ML1000-2 and ML100T-12 cards, the only valid value is 2. For the FC_MR-4 card, the only valid value is 8. TXCOUNT is an integer.
<CCT>
Type of connection: one-way or two-way. Cross-connect type for the VCG member cross-connects. The parameter type is CCT, which is the type of cross-connect to be created.
•
A unidirectional connection from a source tributary to a destination tributary.
•
SNCP multicast drop (1-way continue)
•
SNCP multicast end node (1-way continue)
•
A bidirectional connection between the two tributaries
Note
•
A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
•
A bidirectional connection between the two tributaries
•
A bidirectional drop and continue connection applicable only to SNCP traditional and integrated DRIs
•
A bidirectional connection between the two tributaries on the extra protection path/fiber
•
Diagnostics cross-connect. Supports BERT (MS-SPRing PCA diagnostics cross-connect).
<LCAS>
(Optional) Link capacity adjustment scheme. The parameter type is LCAS, which is the link capacity adjustment scheme mode for the VCG created.
•
LCAS is enabled.
•
No LCAS.
•
Supports the temporary removal of a VCG member during the member failure. Only supported by the ML1000-2 and ML100T-12 cards.
<BUFFERS>
(Optional) Buffer type. The default value is DEFAULT. The FC_MR-4 card supports DEFAULT and EXPANDED buffers. Other data cards support DEFAULT buffers only. The parameter type is BUFFER_TYPE, which is the buffer type used in the VCAT.
•
Default buffer value
•
Expanded buffer value
<NAME>
(Optional) Name of the VCAT group. NAME is a string.
<PST>
Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
•
In service
•
Out of service
23.165 RTRV-VLAN
The Retrieve Virtual LAN (RTRV-VLAN) command retrieves a virtual LAN entry from the VLAN database. The VLAN database is a collection of VLANs used in an NE.
Usage Guidelines
If the AID is invalid, an IIAC (Invalid AID) error message is returned.
Category
Ethernet
Security
Retrieve
Input Format
RTRV-VLAN:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-VLAN:ROCKS:VLAN-4096:1;
Input Parameters
<AID>
The AID is used to access the VLAN.
•
The AID for a single VLAN. The value 0 is reserved for untagged VLANs.
Output Format
SID DATE TIME
M CTAG COMPLD "<AID>::[NAME=<NAME>],[PROTN=<PROTN>][MACLEARNING=<MACLEARNING>],[IGMPENABLE=<IGMPENABLE>],[IGMPFASTLEAVE=<IGMPFASTLEAVE>],[IGMPSUPP=<IGMPSUPP>][:]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"VLAN-4096::NAME="MYVLAN",PROTN=Y,MACLEARNING=Y, IGMPENABLE=Y,IGMPFASTLEAVE=Y,IGMPSUPP=Y"
;
23.166 RTRV-VLAN-ETH
The VLAN attributes on a L2 ethernet port command retrieves the VLAN Profile associated to the L2 Ethernet prot - VLAN.
It also retrieves the alarm status of a VLAN associated to a L2 ethernet port and the Multicast MAC address list.
Usage Guidelines
This command accept the ALL AID.
Category
ETHERNET
Security
Retrieve
Input Format
RTRV-VLAN-ETH[:<TID>]:<AID>:<CTAG>[::<VLAN_ID>],[<VLAN_TYPE>][::];
Input Example
RTRV-VLAN-ETH:TID:ETH-1-1-1:CTAG::110;
Input Parameters
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>:<VLANID>,<VLANTYPE>:[<ALM>],[<ALMDAT>],[<ALMTM>],[<BWP>],[<IGMPIP>]:"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ETH-1-1-1:110:ALM=VLAN-AIS,ALMDAT=08-07,ALMTM=16-38-57,BWP=23:";
;Output Parameters
23.167 RTRV-VLB-REP
The Retrieve VLAN Load Balancing Resilient Ethernet Protocol (RTRV-VLB-REP) command retrieves the VLAN Load Balancing (VLB) for REP Segment on the ethernet ports.
Usage Guidelines
•
•
Category
Ethernet
Security
Retrieve
Input Format
RTRV-VLB-REP:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-VLB-REP:CISCO:ETH-16-2-1:1;
Input Parameters
<AID>
Access identifier from the "FACILITY" section.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[VLBENABLED=<VLBENABLED>],[VLANRANGE=<VLANRANGE>],
[REPPORTID=<REPPORTID>],[PREFERRED=<PREFERRED>]"
;Output Example
SID DATE TIME
M CTAG COMPLD
"ETH-16-2-1::VLBENABLED=Y,VLANRANGE=1010-1024&1010-1025,
REPPORTID=0X0134A543456785A8,PREFERRED=N"
;Output Parameters
<AID>
Access identifier from the "FACILITY" section.
<VLBENABLED>
Enables or disables the segment topology notification on ethernet entity for REP.
•
Enables STCN on the ethernet port.
•
Disables STCN on the ethernet port.
<VLBOPERATION>
Adds or removes the range for STCN notification.
•
Adds the range to a list of segment ranges for STCN notification.
•
Removes the range from a list of segment ranges for STCN notification.
<VLANRANGESTART>
Indicates the VLAN range start value for VLB on REP. The valid range is 0 to 1024.
<VLANRANGEEND>
Indicates the VLAN range end value for VLB on REP. The valid range is from 0 to 1024.
<PREFERRED>
Indicates that the port is the preferred alternate port. Or the preferred port for VLAN load balancing.
•
Yes
•
No
<REPPORTID>
Determines the REP port to trigger VLB.
23.168 RTRV-WDMANS
The Retrieve Wavelength Division Multiplexing Automatic Node Setup (RTRV-WDMANS) command retrieves the automatic optical node setup application attributes.
Usage Guidelines
None
Category
NCS
Security
Maintenance
Input Format
RTRV-WDMANS:[<TID>]:<AID>:<CTAG>:[<WLEN>]:;
Input Example
RTRV-WDMANS::LINE-1-13-2-TX:77::1530.33;
Input Parameters
Output Format
(For legacy package)
SID DATE TIME
M CTAG COMPLD
"<AID>:[<WLEN>]:[VOAATTN=<VOAATTN>],[VOAATTNFLG=<VOAATTNFLG>],[POWEROSC=<POWEROSC>],[POWEROSCFLG=<POWEROSCFLG>],[NTWTYPE=<NTWTYPE>],[NTWTYPEFLG=<NTWTYPEFLG>],[CHLOSS=<CHLOSS>],[CHLOSSFLG=<CHLOSSFLG>],[GAIN=<GAIN>],[GAINFLG=<GAINFLG>],[TILT=<TILT>],[TILTFLG=<TILTFLG>],[CHPWR=<CHPWR>],[CHPWRFLG=<CHPWRFLG>],[AMPLMODE=<AMPLMODE>],[AMPLMODEFLG=<AMPLMODEFLG>],[RATIO=<RATIO>],[RATIOFLG=<RATIOFLG>],[OSCLOSS=<OSCLOSS>],[OSCLOSSFLG=<OSCLOSSFLG>],[OPTICALNODETYPE=<OPTICALNODETYPE>],[DITHER=<DITHER>],[DITHERFLG=<DITHERFLG>],[TOTALPWR=<TOTALPWR>],[TOTALPWRFLG=<TOTALPWRFLG>],[HIGHSLVEXP=<HIGHSLVEXP>],[HIGHSLVEXPFLG=<HIGHSLVEXPFLG>],[LOWSLVEXP=<LOWSLVEXP>],[LOWSLVEXPFLG=<LOWSLVEXPFLG>],TOTALPWRDBM=<TOTALPWRDBM>][LASTRUNDAT=<LASTRUNDAT>],[LASTRUNTM=<LASTRUNTM>][:]";(For flex package)
SID DATE TIME
M CTAG COMPLD
"<AID>:[<WLEN>]:[VOAATTN=<VOAATTN>],[VOAATTNFLG=<VOAATTNFLG>],[POWEROSC=<POWEROSC>],[POWEROSCFLG=<POWEROSCFLG>],[NTWTYPE=<NTWTYPE>],[NTWTYPEFLG=<NTWTYPEFLG>],[CHLOSS=<CHLOSS>],[CHLOSSFLG=<CHLOSSFLG>],[GAIN=<GAIN>],[GAINFLG=<GAINFLG>],[TILT=<TILT>],[TILTFLG=<TILTFLG>],[CHPWR=<CHPWR>],[CHPWRFLG=<CHPWRFLG>],[AMPLMODE=<AMPLMODE>],[AMPLMODEFLG=<AMPLMODEFLG>],[RATIO=<RATIO>],[RATIOFLG=<RATIOFLG>],[OSCLOSS=<OSCLOSS>],[OSCLOSSFLG=<OSCLOSSFLG>],[OPTICALNODETYPE=<OPTICALNODETYPE>],[DITHER=<DITHER>],[DITHERFLG=<DITHERFLG>],[TOTALPWR=<TOTALPWR>],[TOTALPWRFLG=<TOTALPWRFLG>],[HIGHSLVEXP=<HIGHSLVEXP>],[HIGHSLVEXPFLG=<HIGHSLVEXPFLG>],[LOWSLVEXP=<LOWSLVEXP>],[LOWSLVEXPFLG=<LOWSLVEXPFLG>],TOTALPWRDBM=<TOTALPWRDBM>],[CHPWROFFSET ],[CHPWROFFSETFLG ],[ENABLELOGO],[ENABLELOGOFLG ],[LASTRUNDAT=<LASTRUNDAT>],[LASTRUNTM=<LASTRUNTM>][:]";Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
CHAN-1-13-1-TX::CHPWR=-14.1,CHPWRFLG=PROV,
"WDMNODE::NTWTYPE=METRO-CORE,NTWTYPEFLG=DFLT,OPTICALNODETYPE=OADM,LASTRUNDAT=2009-09-03,LASTRUNTM=11-52-18,:"Output Parameters
23.169 RTRV-WDMSIDE
The Retrieve Wavelength Division Multiplexing Side (RTRV-WDMSIDE) command retrieves the WDM side and defines its attributes.
Usage Guidelines
None
Category
NCS
Security
Maintenance
Input Format
RTRV-WDMSIDE:[<TID>]:<AID>:<CTAG>[::::];
Input Example
RTRV-WDMSIDE:PENNGROVE:WDMSIDE-A:114;
Input Parameters
<AID>
The AID is used to access the WDM side of an NCS node. This is applicable to WDMANS and APC applications of the NE.
•
NCS side identifier.
Output Format
SID DATE TIME
M CTAG COMPLD
"<AID>::[ROLE=<ROLE>],LINEIN=<LINEIN>,LINEOUT=<LINEOUT>,[OCS=<OSC>][:]"
;Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"WDMSIDE-A::LINEIN=LINE-1-3-RX,LINEOUT=LINE-1-3-TX,OSC=FAC-8-1"
;Output Parameters
<AID>
The AID is used to access the WDM side of an NCS node. This is applicable to WDMANS and APC applications of the NE.
•
NCS side identifier.
<ROLE>
The role the unit is playing in the protection group.
•
The entity is the protection unit in the protection group.
•
The entity is the working unit in the protection group.
<LINEIN>
Used to access the OTS layer of optical network units.
•
Indicates all the OTSs of the NE. The ALL AID is applicable only for retrieve commands.
•
All the lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-ALL.
•
The receive/transmit lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-[DIRN].
<LINEOUT>
Used to access the OTS layer of optical network units.
•
Indicates all the OTSs of the NE. The ALL AID is applicable for retrieve-only commands.
•
All the lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-ALL.
•
The receive/transmit lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-[DIRN].
<OSC>
(Optional) Facility AID from the "FACILITY" section.
23.170 RTRV-WLEN
The Retrieve Wavelength (RTRV-WLEN) command retrieves the wavelength provisioning information.
Usage Guidelines
None
Category
NCS
Security
Retrieve
Input Format
RTRV-WLEN:[<TID>]:<AID>:<CTAG>;
Input Example
RTRV-WLEN:PENNGROVE:WLEN-A-ADD-1530.33:114;
Input Parameters
<AID>
Access identifier from the "WLEN" section.
Output Format
(For legacy package)
SID DATE TIME
M CTAG COMPLD
"<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>],[TOSIDE=<TOSIDE>],[SRC=<SRC>],
[DST=<DST>]:<PST_PSTQ>,[<SSTQ>]"
;(For flex package)
SID DATE TIME
M CTAG COMPLD
"<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>],[TOSIDE=<TOSIDE>],[FREQ],[WIDTH],[SRC=<SRC>],[DST=<DST>]:<PST_PSTQ>,[<SSTQ>]"
Output Example
TID-000 1998-06-20 14:30:00
M 001 COMPLD
"WLEN-A-ADD-1530.33:1WAY:SIZE=MULTI-RATE,CKTID=CKTID,SRC=CHAN-4-1-RX,
DST=LINEWL-1-3-TX-1530.33:OOS-AU,AINS"
;Output Parameters
<AID>
Access identifier from the "WLEN" section.
<CCT>
Identifies the wavelength connection types.
•
A unidirectional wavelength connection for one specified ring direction.
•
A bidirectional wavelength connection for both the ring directions
<SIZE>
Identifies the NCS circuit size used on a wavelength.
<CKTID>
(Optional) Circuit identification parameter that contains the a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. CKTID is a string.
<TOSIDE>
The AID is used to access the WDM side of a NCS node.
•
NCS side identifier.
<FREQ>
Optical wavelength.
<WIDTH>
Width.
<SRC>
Source access identifier from the "LINEWL" section.
<DST>
Destination AID of the cross-connection from the "LINEWL" section.
<PST_PSTQ>
Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (PST) and primary state qualifier (PSTQ).
•
In service and normal
•
Out of service and autonomous
•
Out of service, autonomous and management
•
Out of service and management
<SSTQ>
(Optional) Secondary state of the entity. The parameter type is secondary state (SST), which provides additional information pertaining to PST and PSTQ.
•
Automatic in service
•
Disabled
•
Loopback
•
Mismatch of equipment and attributes
•
Maintenance mode
•
Out of group
•
Software downloading
•
Unassigned
•
Unequipped
