Cisco ONS SONET TL1 Command Guide, Releases 9.2.1 and 9.2.2
Chapter 21, RTRV Commands
Downloads: This chapterpdf (PDF - 4.0MB) The complete bookPDF (PDF - 11.63MB) | Feedback

Table of Contents

RTRV Commands

RTRV Commands


Note The terms "Unidirectional Path Switched Ring" and "UPSR" may appear in Cisco literature. These terms do not refer to using Cisco ONS 15xxx products in a unidirectional path switched ring configuration. Rather, these terms, as well as "Path Protected Mesh Network" and "PPMN," refer generally to Cisco's path protection feature, which may be used in any topological network configuration. Cisco does not recommend using its path protection feature in any particular topological network configuration.


This chapter provides retrieve (RTRV) commands for the Cisco ONS 15454, Cisco ONS 15600, Cisco ONS 15454 M2, and Cisco ONS 15454 M6.


Note All commands supported on the Cisco ONS 15454 platform are also supported on Cisco ONS 15454 M2 and Cisco ONS 15454 M6 platforms.


21.1 RTRV-<MOD1FCPAYLOAD>

(Cisco ONS 15454) The Retrieve 1GFC, 2GFC, 4 GFC, 5GIB, 8GFC, or 10GFC (RTRV-<MOD1FCPAYLOAD>) command retrieves the attributes related with the Fibre Channel port.

 
Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Category

Ports

Security

Retrieve

Input Format

RTRV-<MOD1FCPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-1GFC:CISCO:FAC-6-1:888;

Input Parameters

<AID>

Access identifier from the “FACILITY” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:,,[<ROLE>],[<STATUS>]:LINKRATE=<LINKRATE>,LINKSTATE=<LINKSTATE>,
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,[<SST>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-1-1:,,WORK,ACT:LINKRATE=1GFC,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,
NAME=\"FC PORT\",SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,
LOSSB=LR-1:OOS-MA,MT”
;

Output Parameters

<AID>

Access identifier from the “FACILITY” section.

<ROLE>

(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role played by the unit in the protection group.

  • PROT

The entity is a protection unit in the protection group.

  • WORK

The entity is a working unit in the protection group.

<STATUS>

(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is the status of the unit in the protection pair.

  • ACT

The entity is the active unit in the shelf.

  • NA

Status is unavailable.

  • STBY

The entity is the standby unit in the shelf.

<LINKRATE>

The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned. The parameter type is LINKRATE, which is the link rate on a Fibre Channel port.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • UNKNOWN

The rate is unknown.

  • UNPLUGGED

The Small Form-factor Pluggable (SFP) is not plugged into the Fibre Channel port, so the link rate cannot be detected.

<LINKSTATE>

Link state. The parameter type is DIRN, which specifies the discriminating level for the requested monitored parameter.

  • DN

Monitored parameter with values equal to or greater than the level of LEV will be reported.

  • UP

Monitored parameter with values equal or less than the value of LEV will be reported.

<LINKRCVRY>

Link recovery. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

Enable an attribute.

<DISTEXTN>

(Optional) Distance extension. The parameter type is DISTANCE_EXTENSION (distance extension).

  • B2B

Buffer to buffer flow control

  • NONE

No distance extension

<LINKCREDITS>

(Optional) Number of link credits. LINKCREDITS is an integer.

<MFS>

(Optional) Maximum frame size. MFS is an integer.

<ENCAP>

(Optional) Frame encapsulation type. The parameter type is ENCAP (frame encapsulation type).

  • GFP_F

Generic framing procedure (GFP) frame mode

  • GFP_T

GFP transparent mode

  • HDLC

High-level data link control (HDLC) frame mode

  • HDLC_LEX

HDLC LAN extension frame mode

  • HDLC_X86

HDLC X.86 frame mode

<NAME>

(Optional) Identifies the port name. NAME is a string.

<SOAK>

(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.

<SOAKLEFT>

(Optional) Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for <SOAKLEFT> are as follows:

  • When the port is in OOS, OOS_MT or IS state, the parameter will not appear.
  • When the port is in OOS_AINS state but the countdown has not started due to a fault signal, the value will be SOAKLEFT=NOT-STARTED.
  • When the port is in OOS_AINS state and the countdown has started, the value will be shown in HH-MM format.

<FREQ>

(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).

  • 1310

Wavelength 1310

  • 1470

Wavelength 1470

  • 1490

Wavelength 1490

  • 1510

Wavelength 1510

  • 1528.77

Wavelength 1528.77

  • 1529.55

Wavelength 1529.55

  • 1529.94

Wavelength 1529.94

  • 1530

Wavelength 1530

  • 1530.33

Wavelength 1530.33

  • 1530.73

Wavelength 1530.73

  • 1531.12

Wavelength 1531.12

  • 1531.51

Wavelength 1531.51

  • 1531.90

Wavelength 1531.90

  • 1532.29

Wavelength 1532.29

  • 1532.68

Wavelength 1532.68

  • 1533.07

Wavelength 1533.07

  • 1533.47

Wavelength 1533.47

  • 1533.86

Wavelength 1533.86

  • 1534.25

Wavelength 1534.25

  • 1534.64

Wavelength 1534.64

  • 1535.04

Wavelength 1535.04

  • 1535.43

Wavelength 1535.43

  • 1535.82

Wavelength 1535.82

  • 1536.22

Wavelength 1536.22

  • 1536.61

Wavelength 1536.61

  • 1537

Wavelength 1537

  • 1537.40

Wavelength 1537.40

  • 1537.79

Wavelength 1537.79

  • 1538.19

Wavelength 1538.19

  • 1538.58

Wavelength 1538.58

  • 1538.98

Wavelength 1538.98

  • 1539.37

Wavelength 1539.37

  • 1539.77

Wavelength 1539.77

  • 1540.16

Wavelength 1540.16

  • 1540.56

Wavelength 1540.56

  • 1540.95

Wavelength 1540.95

  • 1541.35

Wavelength 1541.35

  • 1541.75

Wavelength 1541.75

  • 1542.14

Wavelength 1542.14

  • 1542.35

Wavelength 1542.35

  • 1542.54

Wavelength 1542.54

  • 1542.94

Wavelength 1542.94

  • 1543.33

Wavelength 1543.33

  • 1543.73

Wavelength 1543.73

  • 1544.13

Wavelength 1544.13

  • 1544.53

Wavelength 1544.53

  • 1544.92

Wavelength 1544.92

  • 1545.32

Wavelength 1545.32

  • 1545.72

Wavelength 1545.72

  • 1546.12

Wavelength 1546.12

  • 1546.52

Wavelength 1546.52

  • 1546.92

Wavelength 1546.92

  • 1547.32

Wavelength 1547.32

  • 1547.72

Wavelength 1547.72

  • 1548.12

Wavelength 1548.12

  • 1548.51

Wavelength 1548.51

  • 1548.92

Wavelength 1548.92

  • 1549.32

Wavelength 1549.32

  • 1549.71

Wavelength 1549.71

  • 1550

Wavelength 1500

  • 1550.12

Wavelength 1550.12

  • 1550.52

Wavelength 1550.52

  • 1550.92

Wavelength 1550.92

  • 1551.32

Wavelength 1551.32

  • 1551.72

Wavelength 1551.72

  • 1552.12

Wavelength 1552.12

  • 1552.52

Wavelength 1552.52

  • 1552.93

Wavelength 1552.93

  • 1553.33

Wavelength 1553.33

  • 1553.73

Wavelength 1553.73

  • 1554.13

Wavelength 1554.13

  • 1554.13

Wavelength 1554.13

  • 1554.94

Wavelength 1554.94

  • 1555.34

Wavelength 1555.34

  • 1555.75

Wavelength 1555.75

  • 1556.15

Wavelength 1556.15

  • 1556.55

Wavelength 1556.55

  • 1556.96

Wavelength 1556.96

  • 1557.36

Wavelength 1557.36

  • 1557.77

Wavelength 1557.77

  • 1558.17

Wavelength 1558.17

  • 1558.58

Wavelength 1558.58

  • 1558.98

Wavelength 1558.98

  • 1559.39

Wavelength 1559.39

  • 1559.79

Wavelength 1559.79

  • 1560.20

Wavelength 1560.20

  • 1560.61

Wavelength 1560.61

  • 1561.01

Wavelength 1561.01

  • 1561.42

Wavelength 1561.42

  • 1561.83

Wavelength 1561.83

  • 1570

Wavelength 1570

  • 1570.83

Wavelength 1570.83

  • 1571.24

Wavelength 1571.24

  • 1571.65

Wavelength 1571.65

  • 1572.06

Wavelength 1572.06

  • 1572.48

Wavelength 1572.48

  • 1572.89

Wavelength 1572.89

  • 1573.30

Wavelength 1573.30

  • 1573.71

Wavelength 1573.71

  • 1574.13

Wavelength 1574.13

  • 1574.54

Wavelength 1574.54

  • 1574.95

Wavelength 1574.95

  • 1575.37

Wavelength 1575.37

  • 1575.78

Wavelength 1575.78

  • 1576.20

Wavelength 1576.20

  • 1576.61

Wavelength 1576.61

  • 1577.03

Wavelength 1577.03

  • 1577.44

Wavelength 1577.44

  • 1577.86

Wavelength 1577.86

  • 1578.27

Wavelength 1578.27

  • 1578.69

Wavelength 1578.69

  • 1579.10

Wavelength 1579.10

  • 1579.52

Wavelength 1579.52

  • 1579.93

Wavelength 1579.93

  • 1580.35

Wavelength 1580.35

  • 1580.77

Wavelength 1580.77

  • 1581.18

Wavelength 1581.18

  • 1581.60

Wavelength 1581.60

  • 1582.02

Wavelength 1582.02

  • 1582.44

Wavelength 1582.44

  • 1582.85

Wavelength 1582.85

  • 1583.27

Wavelength 1583.27

  • 1583.69

Wavelength 1583.69

  • 1584.11

Wavelength 1584.11

  • 1584.53

Wavelength 1584.53

  • 1584.95

Wavelength 1584.95

  • 1585.36

Wavelength 1585.36

  • 1585.78

Wavelength 1585.78

  • 1586.20

Wavelength 1586.20

  • 1586.62

Wavelength 1586.62

  • 1587.04

Wavelength 1587.04

  • 1587.46

Wavelength 1587.46

  • 1587.88

Wavelength 1587.88

  • 1588.30

Wavelength 1588.30

  • 1588.73

Wavelength 1588.73

  • 1589.15

Wavelength 1589.15

  • 1589.57

Wavelength 1589.57

  • 1589.99

Wavelength 1589.99

  • 1590

Wavelength 1590

  • 1590.41

Wavelength 1590.41

  • 1590.83

Wavelength 1590.83

  • 1591.26

Wavelength 1591.26

  • 1591.68

Wavelength 1591.68

  • 1592.10

Wavelength 1592.10

  • 1592.52

Wavelength 1592.52

  • 1592.95

Wavelength 1592.95

  • 1593.37

Wavelength 1593.37

  • 1593.79

Wavelength 1593.79

  • 1594.22

Wavelength 1594.22

  • 1594.64

Wavelength 1594.64

  • 1595.06

Wavelength 1595.06

  • 1595.49

Wavelength 1595.49

  • 1596.34

Wavelength 1596.34

  • 1596.76

Wavelength 1596.76

  • 1597.19

Wavelength 1597.19

  • 1597.62

Wavelength 1597.62

  • 1598.04

Wavelength 1598.04

  • 1598.47

Wavelength 1598.47

  • 1598.89

Wavelength 1598.89

  • 1599.32

Wavelength 1599.32

  • 1599.75

Wavelength 1599.75

  • 1600.06

Wavelength 1600.06

  • 1601.03

Wavelength 1601.03

  • 1601.46

Wavelength 1601.46

  • 1601.88

Wavelength 1601.88

  • 1602.31

Wavelength 1602.31

  • 1602.74

Wavelength 1602.74

  • 1603.17

Wavelength 1603.17

  • 1603.60

Wavelength 1603.60

  • 1604.03

Wavelength 1604.03

  • 1610

Wavelength 1610

  • USE-TWL1

Use Tunable Wavelength 1

<LOSSB>

(Optional) Parameter type is REACH (reach values).

  • AUTOPROV

Autoprovisioning

  • CX

Reach CX

  • DX

Reach DX

  • HX

Reach HX

  • I1

Reach I1

  • IR-1

Reach IR-1

  • IR-2

Reach IR-2

  • L1

Reach L1

  • L2

Reach L2

  • L3

Reach L3

  • LR-1

Reach LR-1

  • LR-2

Reach LR-2

  • LR-3

Reach LR-3

  • LX

Reach LX

  • S1

Reach S1

  • S2

Reach S2

  • SR

Reach SR

  • SR-1

Reach SR-1

  • SX

Reach SX

  • T

Reach T

  • VX

Reach VX

  • ZX

Reach ZX

<PST_PSTQ>

Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by primary state (PST) and primary state qualifier (PSTQ).

  • IS_NR

In Service and Normal

  • OOS-AU

Out of Service and Autonomous

  • OOS-AUMA

Out of Service and Autonomous Management

  • OOS-MA

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.

  • AINS

Automatic In-Service

  • DSBLD

Disabled

  • LPBK

Loopback

  • MEA

Mismatch of Equipment

  • MT

Maintenance

  • OOG

Out of Group

  • SWDL

Software Download

  • UAS

Unassigned

  • UEQ

Unequipped

21.2 RTRV-<MOD1FICONPAYLOAD>

(Cisco ONS 15454) The Retrieve 1GFICON, 2GFICON, or 4GFICON (RTRV-<MOD1FICONPAYLOAD>) command returns Fibre Channel-specific settings for ports that have been configured to carry FICON traffic using the ENT-FICON command.

 
Usage Guidelines

The MXPP_MR_2.5G card only supports the GFP-T frame type.

See Table 28-1 for supported modifiers by platform.

Category

Ports

Security

Retrieve

Input Format

RTRV-<MOD1FICONPAYLOAD>:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-1GFICON:CISCO:FAC-1-1:123;

Input Parameters

<AID>

Access identifier from the “FACILITY” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:,,[<ROLE>],[<STATUS>]:[LINKRATE=<LINKRATE>],[LINKSTATE=<LINKSTATE>],
[LINKRCVRY=<LINKRCVRY>],[DISTEXTN=<DISTEXTN>],
[LINKCREDITS=<LINKCREDITS>],[MFS=<MFS>],[ENCAP=<ENCAP>],[NAME=<NAME>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:
<PST_PSTQ>,<SST>”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-1-1:,,WORK,ACT:LINKRATE=1GFICON,LINKSTATE=UP,LINKRCVRY=Y,
DISTEXTN=NONE,LINKCREDITS=0,MFS=2148,ENCAP=GFP-T,NAME=\"FC PORT\",
SOAK=32,SOAKLEFT=\"12-25\",FREQ=1550,LOSSB=LR-1:OOS-MA,MT”
;

Output Parameters

<AID>

Access identifier from the “FACILITY” section.

<ROLE>

(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role that the unit is playing in the protection group.

  • PROT

The entity is a protection unit in the protection group.

  • WORK

The entity is a working unit in the protection group.

<STATUS>

(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is the status of the unit in the protection pair.

  • ACT

The entity is the active unit in the shelf.

  • NA

Status is unavailable.

  • STBY

The entity is the standby unit in the shelf.

<LINKRATE>

The actual rate running on the Fibre Channel port. It can differ from the payload type provisioned. The parameter type is LINKRATE, which is the link rate on a Fibre Channel port.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • UNKNOWN

The rate is unknown.

  • UNPLUGGED

The SFP is not plugged into the Fibre Channel port so the link rate cannot be detected.

<LINKSTATE>

Link state. The parameter type is DIRN, which specifies the discriminating level for the requested monitored parameter.

  • DN

Monitored parameter with values equal to or greater than the level of LEV will be reported.

  • UP

Monitored parameter with values equal or less than the value of LEV will be reported.

<LINKRCVRY>

Link recovery. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

Enable an attribute.

<DISTEXTN>

(Optional) Distance extension. The parameter type is DISTANCE_EXTENSION (distance extension).

  • B2B

Buffer to buffer flow control

  • NONE

No distance extension

<LINKCREDITS>

(Optional) Number of link credits. LINKCREDITS is an integer.

<MFS>

(Optional) Maximum frame size. MFS is an integer.

<ENCAP>

(Optional) Frame encapsulation type. The parameter type is ENCAP (frame encapsulation type).

  • GFP_F

GFP frame mode

  • GFP_T

GFP transparent mode

  • HDLC

HDLC frame mode

  • HDLC_LEX

HDLC LAN extension frame mode

  • HDLC_X86

HDLC X.86 frame mode

<NAME>

(Optional) Identifies the port name. NAME is a string.

<SOAK>

(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.

<SOAKLEFT>

(Optional) Time remaining for the transition from OOS-AINS to IS measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for <SOAKLEFT> are as follows:

  • When the port is in OOS, OOS_MT, or IS state, the parameter will not appear.
  • When the port is in OOS_AINS state but the countdown has not started due to a fault signal, the value will be SOAKLEFT=NOT-STARTED.
  • When the port is in OOS_AINS state and the countdown has started, the value will be shown in HH-MM format.

<FREQ>

(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).

  • 1310

Wavelength 1310

  • 1470

Wavelength 1470

  • 1490

Wavelength 1490

  • 1510

Wavelength 1510

  • 1528.77

Wavelength 1528.77

  • 1529.55

Wavelength 1529.55

  • 1529.94

Wavelength 1529.94

  • 1530

Wavelength 1530

  • 1530.33

Wavelength 1530.33

  • 1530.73

Wavelength 1530.73

  • 1531.12

Wavelength 1531.12

  • 1531.51

Wavelength 1531.51

  • 1531.90

Wavelength 1531.90

  • 1532.29

Wavelength 1532.29

  • 1532.68

Wavelength 1532.68

  • 1533.07

Wavelength 1533.07

  • 1533.47

Wavelength 1533.47

  • 1533.86

Wavelength 1533.86

  • 1534.25

Wavelength 1534.25

  • 1534.64

Wavelength 1534.64

  • 1535.04

Wavelength 1535.04

  • 1535.43

Wavelength 1535.43

  • 1535.82

Wavelength 1535.82

  • 1536.22

Wavelength 1536.22

  • 1536.61

Wavelength 1536.61

  • 1537

Wavelength 1537

  • 1537.40

Wavelength 1537.40

  • 1537.79

Wavelength 1537.79

  • 1538.19

Wavelength 1538.19

  • 1538.58

Wavelength 1538.58

  • 1538.98

Wavelength 1538.98

  • 1539.37

Wavelength 1539.37

  • 1539.77

Wavelength 1539.77

  • 1540.16

Wavelength 1540.16

  • 1540.56

Wavelength 1540.56

  • 1540.95

Wavelength 1540.95

  • 1541.35

Wavelength 1541.35

  • 1541.75

Wavelength 1541.75

  • 1542.14

Wavelength 1542.14

  • 1542.35

Wavelength 1542.35

  • 1542.54

Wavelength 1542.54

  • 1542.94

Wavelength 1542.94

  • 1543.33

Wavelength 1543.33

  • 1543.73

Wavelength 1543.73

  • 1544.13

Wavelength 1544.13

  • 1544.53

Wavelength 1544.53

  • 1544.92

Wavelength 1544.92

  • 1545.32

Wavelength 1545.32

  • 1545.72

Wavelength 1545.72

  • 1546.12

Wavelength 1546.12

  • 1546.52

Wavelength 1546.52

  • 1546.92

Wavelength 1546.92

  • 1547.32

Wavelength 1547.32

  • 1547.72

Wavelength 1547.72

  • 1548.12

Wavelength 1548.12

  • 1548.51

Wavelength 1548.51

  • 1548.92

Wavelength 1548.92

  • 1549.32

Wavelength 1549.32

  • 1549.71

Wavelength 1549.71

  • 1550

Wavelength 1500

  • 1550.12

Wavelength 1550.12

  • 1550.52

Wavelength 1550.52

  • 1550.92

Wavelength 1550.92

  • 1551.32

Wavelength 1551.32

  • 1551.72

Wavelength 1551.72

  • 1552.12

Wavelength 1552.12

  • 1552.52

Wavelength 1552.52

  • 1552.93

Wavelength 1552.93

  • 1553.33

Wavelength 1553.33

  • 1553.73

Wavelength 1553.73

  • 1554.13

Wavelength 1554.13

  • 1554.13

Wavelength 1554.13

  • 1554.94

Wavelength 1554.94

  • 1555.34

Wavelength 1555.34

  • 1555.75

Wavelength 1555.75

  • 1556.15

Wavelength 1556.15

  • 1556.55

Wavelength 1556.55

  • 1556.96

Wavelength 1556.96

  • 1557.36

Wavelength 1557.36

  • 1557.77

Wavelength 1557.77

  • 1558.17

Wavelength 1558.17

  • 1558.58

Wavelength 1558.58

  • 1558.98

Wavelength 1558.98

  • 1559.39

Wavelength 1559.39

  • 1559.79

Wavelength 1559.79

  • 1560.20

Wavelength 1560.20

  • 1560.61

Wavelength 1560.61

  • 1561.01

Wavelength 1561.01

  • 1561.42

Wavelength 1561.42

  • 1561.83

Wavelength 1561.83

  • 1570

Wavelength 1570

  • 1570.83

Wavelength 1570.83

  • 1571.24

Wavelength 1571.24

  • 1571.65

Wavelength 1571.65

  • 1572.06

Wavelength 1572.06

  • 1572.48

Wavelength 1572.48

  • 1572.89

Wavelength 1572.89

  • 1573.30

Wavelength 1573.30

  • 1573.71

Wavelength 1573.71

  • 1574.13

Wavelength 1574.13

  • 1574.54

Wavelength 1574.54

  • 1574.95

Wavelength 1574.95

  • 1575.37

Wavelength 1575.37

  • 1575.78

Wavelength 1575.78

  • 1576.20

Wavelength 1576.20

  • 1576.61

Wavelength 1576.61

  • 1577.03

Wavelength 1577.03

  • 1577.44

Wavelength 1577.44

  • 1577.86

Wavelength 1577.86

  • 1578.27

Wavelength 1578.27

  • 1578.69

Wavelength 1578.69

  • 1579.10

Wavelength 1579.10

  • 1579.52

Wavelength 1579.52

  • 1579.93

Wavelength 1579.93

  • 1580.35

Wavelength 1580.35

  • 1580.77

Wavelength 1580.77

  • 1581.18

Wavelength 1581.18

  • 1581.60

Wavelength 1581.60

  • 1582.02

Wavelength 1582.02

  • 1582.44

Wavelength 1582.44

  • 1582.85

Wavelength 1582.85

  • 1583.27

Wavelength 1583.27

  • 1583.69

Wavelength 1583.69

  • 1584.11

Wavelength 1584.11

  • 1584.53

Wavelength 1584.53

  • 1584.95

Wavelength 1584.95

  • 1585.36

Wavelength 1585.36

  • 1585.78

Wavelength 1585.78

  • 1586.20

Wavelength 1586.20

  • 1586.62

Wavelength 1586.62

  • 1587.04

Wavelength 1587.04

  • 1587.46

Wavelength 1587.46

  • 1587.88

Wavelength 1587.88

  • 1588.30

Wavelength 1588.30

  • 1588.73

Wavelength 1588.73

  • 1589.15

Wavelength 1589.15

  • 1589.57

Wavelength 1589.57

  • 1589.99

Wavelength 1589.99

  • 1590

Wavelength 1590

  • 1590.41

Wavelength 1590.41

  • 1590.83

Wavelength 1590.83

  • 1591.26

Wavelength 1591.26

  • 1591.68

Wavelength 1591.68

  • 1592.10

Wavelength 1592.10

  • 1592.52

Wavelength 1592.52

  • 1592.95

Wavelength 1592.95

  • 1593.37

Wavelength 1593.37

  • 1593.79

Wavelength 1593.79

  • 1594.22

Wavelength 1594.22

  • 1594.64

Wavelength 1594.64

  • 1595.06

Wavelength 1595.06

  • 1595.49

Wavelength 1595.49

  • 1596.34

Wavelength 1596.34

  • 1596.76

Wavelength 1596.76

  • 1597.19

Wavelength 1597.19

  • 1597.62

Wavelength 1597.62

  • 1598.04

Wavelength 1598.04

  • 1598.47

Wavelength 1598.47

  • 1598.89

Wavelength 1598.89

  • 1599.32

Wavelength 1599.32

  • 1599.75

Wavelength 1599.75

  • 1600.06

Wavelength 1600.06

  • 1601.03

Wavelength 1601.03

  • 1601.46

Wavelength 1601.46

  • 1601.88

Wavelength 1601.88

  • 1602.31

Wavelength 1602.31

  • 1602.74

Wavelength 1602.74

  • 1603.17

Wavelength 1603.17

  • 1603.60

Wavelength 1603.60

  • 1604.03

Wavelength 1604.03

  • 1610

Wavelength 1610

  • USE-TWL1

Use Tunable Wavelength 1

<LOSSB>

(Optional) Parameter type is REACH (reach values).

  • AUTOPROV

Autoprovisioning

  • CX

Reach CX

  • DX

Reach DX

  • HX

Reach HX

  • I1

Reach I1

  • IR-1

Reach IR-1

  • IR-2

Reach IR-2

  • L1

Reach L1

  • L2

Reach L2

  • L3

Reach L3

  • LR-1

Reach LR-1

  • LR-2

Reach LR-2

  • LR-3

Reach LR-3

  • LX

Reach LX

  • S1

Reach S1

  • S2

Reach S2

  • SR

Reach SR

  • SR-1

Reach SR-1

  • SX

Reach SX

  • T

Reach T

  • VX

Reach VX

  • ZX

Reach ZX

<PST_PSTQ>

Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.

  • IS_NR

In Service and Normal

  • OOS-AU

Out of Service and Autonomous

  • OOS-AUMA

Out of Service and Autonomous Management

  • OOS-MA

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.

  • AINS

Automatic In-Service

  • DSBLD

Disabled

  • LPBK

Loopback

  • MEA

Mismatch of Equipment

  • MT

Maintenance

  • OOG

Out of Group

  • SWDL

Software Download

  • UAS

Unassigned

  • UEQ

Unequipped

21.3 RTRV-<MOD2DWDMPAYLOAD>

(Cisco ONS 15454) The Retrieve D1VIDEO, DV6000, DVBASI, ETRCLO, HDTV, ISCCOMPAT, ISC1, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G and PASSTHRU (RTRV-<MOD2DWDMPAYLOAD>) command retrieves the configuration parameter of a dense wavelength division multiplexing (DWDM) client.

 
Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Category

DWDM

Security

Retrieve

Input Format

RTRV-<MOD2DWDMPAYLOAD>:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-HDTV:MILAN:FAC-1-1:100;

Input Parameters

<AID>

Access identifier from the “FACILITY” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AIDUNIONID>,<AIDTYPE>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[LBCL=<LBCL>],
[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-1-1-1,HDTV:,,WORK,ACT:NAME=\"NY PORT\",LBCL=10.0,OPT=10.0,OPR=10.0,
FREQ=1550,LOSSB=LR-1:OOS-AU,AINS”
;

Output Parameters

<AIDUNIONID>

Access identifier from the “AidUnionId” section

<AIDTYPE>

A type of access identifier. The parameter type is MOD2DWDMPAYLOAD, which contains the payload types applicable to DWDM ports.

  • 10GFC

10-Gigabit Fibre Channel payload

  • 10GIGE

10-Gigabit Ethernet

  • 40GIGE

40-Gigabit Ethernet

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • D1VIDEO

D1Video payload

  • DV6000

DV6000 payload

  • DVBASI

DVBASI payload

  • ETRCLO

ETR_CLO payload

  • GIGE

Gigabit Ethernet payload

  • HDTV

High definition television (HDTV) payload

  • ISC1

ISC1 payload

  • ISC3

ISC3 payload

  • OTU3

Optical Transport Unit Level 3

  • PASSTHRU

Any pass-through (2R) payload

<ROLE>

(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role the unit is playing in the protection group.

  • PROT

The entity is a protection unit in the protection group.

  • WORK

The entity is a working unit in the protection group.

<STATUS>

(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is the status of the unit in the protection pair.

  • ACT

The entity is the active unit in the shelf.

  • NA

Status is unavailable.

  • STBY

The entity is the standby unit in the shelf.

<NAME>

(Optional) Identifies the port name. NAME is a string.

<LBCL>

(Optional) Displays the current value of the laser current. LBCL is a float.

<OPT>

(Optional) Displays the current value of the transmitted optical power. OPT is a float.

<OPR>

(Optional) Displays the current value of the received optical power. OPR is a float.

<FREQ>

(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).

  • 1310

Wavelength 1310

  • 1470

Wavelength 1470

  • 1490

Wavelength 1490

  • 1510

Wavelength 1510

  • 1528.77

Wavelength 1528.77

  • 1529.55

Wavelength 1529.55

  • 1529.94

Wavelength 1529.94

  • 1530

Wavelength 1530

  • 1530.33

Wavelength 1530.33

  • 1530.73

Wavelength 1530.73

  • 1531.12

Wavelength 1531.12

  • 1531.51

Wavelength 1531.51

  • 1531.90

Wavelength 1531.90

  • 1532.29

Wavelength 1532.29

  • 1532.68

Wavelength 1532.68

  • 1533.07

Wavelength 1533.07

  • 1533.47

Wavelength 1533.47

  • 1533.86

Wavelength 1533.86

  • 1534.25

Wavelength 1534.25

  • 1534.64

Wavelength 1534.64

  • 1535.04

Wavelength 1535.04

  • 1535.43

Wavelength 1535.43

  • 1535.82

Wavelength 1535.82

  • 1536.22

Wavelength 1536.22

  • 1536.61

Wavelength 1536.61

  • 1537

Wavelength 1537

  • 1537.40

Wavelength 1537.40

  • 1537.79

Wavelength 1537.79

  • 1538.19

Wavelength 1538.19

  • 1538.58

Wavelength 1538.58

  • 1538.98

Wavelength 1538.98

  • 1539.37

Wavelength 1539.37

  • 1539.77

Wavelength 1539.77

  • 1540.16

Wavelength 1540.16

  • 1540.56

Wavelength 1540.56

  • 1540.95

Wavelength 1540.95

  • 1541.35

Wavelength 1541.35

  • 1541.75

Wavelength 1541.75

  • 1542.14

Wavelength 1542.14

  • 1542.35

Wavelength 1542.35

  • 1542.54

Wavelength 1542.54

  • 1542.94

Wavelength 1542.94

  • 1543.33

Wavelength 1543.33

  • 1543.73

Wavelength 1543.73

  • 1544.13

Wavelength 1544.13

  • 1544.53

Wavelength 1544.53

  • 1544.92

Wavelength 1544.92

  • 1545.32

Wavelength 1545.32

  • 1545.72

Wavelength 1545.72

  • 1546.12

Wavelength 1546.12

  • 1546.52

Wavelength 1546.52

  • 1546.92

Wavelength 1546.92

  • 1547.32

Wavelength 1547.32

  • 1547.72

Wavelength 1547.72

  • 1548.12

Wavelength 1548.12

  • 1548.51

Wavelength 1548.51

  • 1548.92

Wavelength 1548.92

  • 1549.32

Wavelength 1549.32

  • 1549.71

Wavelength 1549.71

  • 1550

Wavelength 1500

  • 1550.12

Wavelength 1550.12

  • 1550.52

Wavelength 1550.52

  • 1550.92

Wavelength 1550.92

  • 1551.32

Wavelength 1551.32

  • 1551.72

Wavelength 1551.72

  • 1552.12

Wavelength 1552.12

  • 1552.52

Wavelength 1552.52

  • 1552.93

Wavelength 1552.93

  • 1553.33

Wavelength 1553.33

  • 1553.73

Wavelength 1553.73

  • 1554.13

Wavelength 1554.13

  • 1554.13

Wavelength 1554.13

  • 1554.94

Wavelength 1554.94

  • 1555.34

Wavelength 1555.34

  • 1555.75

Wavelength 1555.75

  • 1556.15

Wavelength 1556.15

  • 1556.55

Wavelength 1556.55

  • 1556.96

Wavelength 1556.96

  • 1557.36

Wavelength 1557.36

  • 1557.77

Wavelength 1557.77

  • 1558.17

Wavelength 1558.17

  • 1558.58

Wavelength 1558.58

  • 1558.98

Wavelength 1558.98

  • 1559.39

Wavelength 1559.39

  • 1559.79

Wavelength 1559.79

  • 1560.20

Wavelength 1560.20

  • 1560.61

Wavelength 1560.61

  • 1561.01

Wavelength 1561.01

  • 1561.42

Wavelength 1561.42

  • 1561.83

Wavelength 1561.83

  • 1570

Wavelength 1570

  • 1570.83

Wavelength 1570.83

  • 1571.24

Wavelength 1571.24

  • 1571.65

Wavelength 1571.65

  • 1572.06

Wavelength 1572.06

  • 1572.48

Wavelength 1572.48

  • 1572.89

Wavelength 1572.89

  • 1573.30

Wavelength 1573.30

  • 1573.71

Wavelength 1573.71

  • 1574.13

Wavelength 1574.13

  • 1574.54

Wavelength 1574.54

  • 1574.95

Wavelength 1574.95

  • 1575.37

Wavelength 1575.37

  • 1575.78

Wavelength 1575.78

  • 1576.20

Wavelength 1576.20

  • 1576.61

Wavelength 1576.61

  • 1577.03

Wavelength 1577.03

  • 1577.44

Wavelength 1577.44

  • 1577.86

Wavelength 1577.86

  • 1578.27

Wavelength 1578.27

  • 1578.69

Wavelength 1578.69

  • 1579.10

Wavelength 1579.10

  • 1579.52

Wavelength 1579.52

  • 1579.93

Wavelength 1579.93

  • 1580.35

Wavelength 1580.35

  • 1580.77

Wavelength 1580.77

  • 1581.18

Wavelength 1581.18

  • 1581.60

Wavelength 1581.60

  • 1582.02

Wavelength 1582.02

  • 1582.44

Wavelength 1582.44

  • 1582.85

Wavelength 1582.85

  • 1583.27

Wavelength 1583.27

  • 1583.69

Wavelength 1583.69

  • 1584.11

Wavelength 1584.11

  • 1584.53

Wavelength 1584.53

  • 1584.95

Wavelength 1584.95

  • 1585.36

Wavelength 1585.36

  • 1585.78

Wavelength 1585.78

  • 1586.20

Wavelength 1586.20

  • 1586.62

Wavelength 1586.62

  • 1587.04

Wavelength 1587.04

  • 1587.46

Wavelength 1587.46

  • 1587.88

Wavelength 1587.88

  • 1588.30

Wavelength 1588.30

  • 1588.73

Wavelength 1588.73

  • 1589.15

Wavelength 1589.15

  • 1589.57

Wavelength 1589.57

  • 1589.99

Wavelength 1589.99

  • 1590

Wavelength 1590

  • 1590.41

Wavelength 1590.41

  • 1590.83

Wavelength 1590.83

  • 1591.26

Wavelength 1591.26

  • 1591.68

Wavelength 1591.68

  • 1592.10

Wavelength 1592.10

  • 1592.52

Wavelength 1592.52

  • 1592.95

Wavelength 1592.95

  • 1593.37

Wavelength 1593.37

  • 1593.79

Wavelength 1593.79

  • 1594.22

Wavelength 1594.22

  • 1594.64

Wavelength 1594.64

  • 1595.06

Wavelength 1595.06

  • 1595.49

Wavelength 1595.49

  • 1596.34

Wavelength 1596.34

  • 1596.76

Wavelength 1596.76

  • 1597.19

Wavelength 1597.19

  • 1597.62

Wavelength 1597.62

  • 1598.04

Wavelength 1598.04

  • 1598.47

Wavelength 1598.47

  • 1598.89

Wavelength 1598.89

  • 1599.32

Wavelength 1599.32

  • 1599.75

Wavelength 1599.75

  • 1600.06

Wavelength 1600.06

  • 1601.03

Wavelength 1601.03

  • 1601.46

Wavelength 1601.46

  • 1601.88

Wavelength 1601.88

  • 1602.31

Wavelength 1602.31

  • 1602.74

Wavelength 1602.74

  • 1603.17

Wavelength 1603.17

  • 1603.60

Wavelength 1603.60

  • 1604.03

Wavelength 1604.03

  • 1610

Wavelength 1610

  • USE-TWL1

Use Tunable Wavelength 1

<LOSSB>

(Optional) Parameter type is REACH (reach values).

  • AUTOPROV

Autoprovisioning

  • CX

Reach CX

  • DX

Reach DX

  • HX

Reach HX

  • I1

Reach I1

  • IR-1

Reach IR-1

  • IR-2

Reach IR-2

  • L1

Reach L1

  • L2

Reach L2

  • L3

Reach L3

  • LR-1

Reach LR-1

  • LR-2

Reach LR-2

  • LR-3

Reach LR-3

  • LX

Reach LX

  • S1

Reach S1

  • S2

Reach S2

  • SR

Reach SR

  • SR-1

Reach SR-1

  • SX

Reach SX

  • T

Reach T

  • VX

Reach VX

  • ZX

Reach ZX

<PST_PSTQ>

Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.

  • IS_NR

In Service and Normal

  • OOS-AU

Out of Service and Autonomous

  • OOS-AUMA

Out of Service and Autonomous Management

  • OOS-MA

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.

  • AINS

Automatic In-Service

  • DSBLD

Disabled

  • LPBK

Loopback

  • MEA

Mismatch of Equipment

  • MT

Maintenance

  • OOG

Out of Group

  • SWDL

Software Download

  • UAS

Unassigned

  • UEQ

Unequipped

21.4 RTRV-<MOD_RING>

(Cisco ONS 15454 and ONS 15600) The Retrieve Bidirectional Line Switched Ring (RTRV-<MOD_RING>) command retrieves the bidirectional line switched ring (BLSR) information of the NE. A two-fiber or four-fiber BLSR can be retrieved.


Note Cisco ONS 15600 does not support four-fiber BLSR.


 
Usage Guidelines

Output examples:

4F BLSR:

“BLSR-N43AB::RINGID=N43AB,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,SRVRTV=Y,
SRVTM=5.0,EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,EASTPROT=FAC-12-1,
WESTPROT=FAC-13-1”

2F BLSR:

“BLSR-N12EF::RINGID=N12EF,NODEID=2,MODE=2F,RVRTV=Y,RVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1”

  • The following actions will return error messages:

If the system fails on getting IOR, a SROF (Get IOR Failed) error message is returned.

If the AID is invalid, an IIAC (Invalid AID) error message is returned.

If the BLSR does not exist, a SRQN (BLSR Does Not Exist) error message is returned.

  • Only ALL, NULL, BLSR-ALL, or BLSR-RINGID is allowed for this command.
  • A NULL AID defaults to the AID ALL.
  • The list AID format is supported.

Category

BLSR

Security

Retrieve

Input Format

RTRV-<MOD_RING>:[<TID>]:[<AID>]:<CTAG>[::::];

Input Example

RTRV-BLSR:PETALUMA:ALL:123;

Input Parameters

<AID>

Access identifier from the “AidUnionId1” section. Identifies the BLSR of the NE. Only ALL, null, or a list of BLSR-# is allowed. A null value is equivalent to ALL.

Output Format

SID DATE TIME
M CTAG COMPLD
“[<AID>]::[RINGID=<RINGID>],[NODEID=<NODEID>],[MODE=<MODE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SRVRTV=<SRVRTV>],[SRVTM=<SRVTM>],
[EASTWORK=<EASTWORK>],[WESTWORK=<WESTWORK>],[EASTPROT=<EASTPROT>],
[WESTPROT=<WESTPROT>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“BLSR-43::RINGID=43,NODEID=3,MODE=4F,RVRTV=Y,RVTM=5.0,SRVRTV=Y,SRVTM=5.0,
EASTWORK=FAC-5-1,WESTWORK=FAC-6-1,EASTPROT=FAC-12-1,WESTPROT=FAC-13-1”
;

Output Parameters

<AID>

(Optional) Access identifier from the “AidUnionId1” section. Identifies the BLSR of the NE.

<RINGID>

(Optional) The BLSR ID of the NE. String of up to six characters. Valid characters are A-Z and 0-9.

<NODEID>

(Optional) The BLSR node ID of the NE. NODEID is a string and ranges from 0 to 31.

<MODE>

(Optional) Mode with which the command is to be implemented. Identifies the BLSR mode; either two-fiber or four-fiber. The parameter type is BLSR_MODE (BLSR mode).

  • 2F

Two-fiber BLSR

  • 4F

Four-fiber BLSR

<RVRTV>

(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Does not revert service to original line after restoration.

  • Y

Reverts service to original line after restoration.

<RVTM>

Revertive time. RVTM is not allowed to be set while RVRTV is N. The parameter type is REVERTIVE_TIME.

  • 0.5 to 12.0

Revertive time is 0.5 to 12.0 minutes.

<SRVRTV>

The span revertive mode for four-fiber BLSR only. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

Enable an attribute.

<SRVTM>

The span revertive time for four-fiber BLSR only. SRVTM is not allowed to be set while SRVRTV is N. The parameter type is REVERTIVE_TIME.

  • 0.5 to 12.0

Revertive time is 0.5 to 12.0 minutes.

<EASTWORK>

East working facility. AID from the “FACILITY” section.

<WESTWORK>

West working facility. AID from the “FACILITY” section.

<EASTPROT>

East protecting facility. AID from the “FACILITY” section.

<WESTPROT>

West protecting facility. AID from the “FACILITY” section.

21.5 RTRV-<OCN_TYPE>

(Cisco ONS 15454) The Retrieve OC3, OC12, OC48, or OC192 command retrieves the attributes (for example, service parameters) and the state of an OC-N facility.

 
Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Both RINGID and BLSRTYPE identify the OC-N port connected with a BLSR. These attributes are only presented for the OC-12, OC-48, and OC-192 ports within a BLSR connection. The RTRV-<MOD_RING> command with the AID BLSR-RINGID can provide more information about a BLSR.


Note This command does not show the WVLEN attribute if the OC-N port has a zero value.


Category

Ports

Security

Retrieve

Input Format

RTRV-<OCN_TYPE>:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-OC48:PENNGROVE:FAC-6-1:236;

Input Parameters

<AID>

Access identifier from the “FACILITY” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:,,[<ROLE>],[<STATUS>]:[DCC=<DCC>],[AREA=<AREA>],[TMGREF=<TMGREF>],
[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>],[PJMON=<PJMON>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[MODE=<MODE>],[WVLEN=<WVLEN>],
[RINGID=<RINGID>],[BLSRTYPE=<BLSRTYPE>],[MUX=<MUX>],[UNIC=<UNIC>],
[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SSMRCV=<SSMRCV>],[OSPF=<OSPF>],
[LDCC=<LDCC>],[NAME=<NAME>],[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT=<TRCFORMAT>],[ADMSSM=<ADMSSM>],
[SENDDUSFF=<SENDDUSFF>],[AISONLPBK=<AISONLPBK>],
[FREQ=<FREQ>],[LOSSB=<LOSSB>],[FOREIGNFEND=<FOREIGNFEND>],
[FOREIGNIPADDRESS=<FOREIGNIPADDRESS>],:<PSTPSTQ>,[<SSTQ>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-6-1:,,WORK,ACT:DCC=Y,AREA=10.92.63.1,TMGREF=N,SYNCMSG=N,SENDDUS=N,
PJMON=48,SFBER=1E-4,SDBER=1E-6,MODE=SINGLESHELF,WVLEN=1310.00,RINGID=43,
BLSRTYPE=WESTWORK,MUX=E2,UNIC=Y,
SOAKLEFT=\"12-25\",SSMRCV=STU,OSPF=Y,LDCC=Y,NAME=\"OCN PORT\",LBCL=10.0,
OPT=10.0,OPR=10.0,EXPTRC=\"AAA\",TRC=\"AAA\",TRCMODE=MAN,
TRCFORMAT=16-BYTE,ADMSSM=PRS,SENDDUSFF=N,AISONLPBK=AIS_ON_LPBK_ALL,
FREQ=1550,LOSSB=LR-1,FOREIGNFEND=Y,
FOREIGNIPADDRESS=10.92.63.44,:OOS-AU,AINS”
;

Output Parameters

<AID>

Access identifier from the “FACILITY” section.

<ROLE>

(Optional) An OC-N port role. The parameter type is SIDE, which is the role the unit is playing in the protection group.

  • PROT

The entity is a protection unit in the protection group.

  • WORK

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.

  • ACT

The entity is the active unit in the shelf.

  • NA

Status is unavailable.

  • STBY

The entity is the standby unit in the shelf.

<DCC>

(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.

  • N

The ring does not support the extended K1/K2/K3 protocol.

  • Y

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).

  • N

Disable an attribute.

  • Y

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.

  • N

The ring does not support the extended K1/K2/K3 protocol.

  • Y

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).

  • N

Disable an attribute.

  • Y

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 The PJMON number displayed in TL1 interface does not correspond to the PJVC4MON number in CTC, but instead corresponds to the STS number of the optical port.

<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.

  • 1E-3

SFBER is 1E-3.

  • 1E-4

SFBER is 1E-4.

  • 1E-5

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.

  • 1E-5

SDBER is 1E-5.

  • 1E-6

SDBER is 1E-6.

  • 1E-7

SDBER is 1E-7.

  • 1E-8

SDBER is 1E-8.

  • 1E-9

SDBER is 1E-9.

<MODE>

(Optional) OC-N port mode. Defaults to SONET. The parameter type is OPTICAL_MODE, which is the facility’s optical mode.

  • SINGLESHELF

The NE contains only one shelf and the AID representation does not consider the shelf identifier for command requests/response and autonomous reports.

  • MULTISHELF

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.

  • MULTISHELFETH

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.

  • EASTPROT

The OC-N port is an east protecting port.

  • EASTWORK

The OC-N port is an east working port.

  • WESTPROT

The OC-N port is an west protecting port.

  • WESTWORK

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

E2 byte (orderwire)

  • F1

F1 byte (user)

  • K3

K3 byte

  • Z2

Z2 byte

<UNIC>

(Optional) Indicates if the port connects to the UCP. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

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:

  • When the port is in OOS, OOS_MT, or IS state, the parameter will not appear.
  • When the port is in OOS_AINS but the countdown has not started due to a fault signal, the value will be SOAKLEFT=NOT-STARTED.
  • When the port is in OOS_AINS state and the countdown has started, the value will be shown in HH-MM format.

<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.

  • DUS

Do Not Use For Synchronization

  • PRS

Primary Reference Source, Stratum 1 Traceable

  • RES

Reserved For Network Synchronization Use

  • SMC

SONET Minimum Clock Traceable

  • ST2

Stratum 2 Traceable

  • ST3

Stratum 3 Traceable

  • ST3E

Stratum 3E Traceable

  • ST4

Stratum 4 Traceable

  • STU

Synchronized, Traceability Unknown

  • TNC

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).

  • N

Disable an attribute.

  • Y

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.

  • N

The ring does not support the extended K1/K2/K3 protocol.

  • Y

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).

  • AUTO

Use the previously received path trace string as the expected string. Not applicable to MXP/TXP cards.

  • AUTO-NO-AIS

Use the previously received path trace string as the expected string and do not turn on alarm indication signal (AIS) and remote defect indication (RDI) if TIM-P is detected.

  • MAN

Use the provisioned expected string as the expected string.

  • MAN-NO-AIS

Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIM-P is detected.

  • OFF

Turn off path trace capability. Nothing will be reported.

<TRCFORMAT>

(Optional) Trace message size. The parameter type is TRCFORMAT (trace format).

  • 1-BYTE

1-byte trace message

  • 16-BYTE

16-byte trace message

  • 64-BYTE

64-byte trace message

  • Y

Enable an attribute.

<ADMSSM>

(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.

  • DUS

Do Not Use For Synchronization

  • PRS

Primary Reference Source, Stratum 1 Traceable

  • RES

Reserved For Network Synchronization Use

  • SMC

SONET Minimum Clock Traceable

  • ST2

Stratum 2 Traceable

  • ST3

Stratum 3 Traceable

  • ST3E

Stratum 3E Traceable

  • ST4

Stratum 4 Traceable

  • STU

Synchronized, Traceability Unknown

  • TNC

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).

  • N

Disable an attribute.

  • Y

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_ONLPBK_FACILITY

AIS is sent on facility loopbacks.

  • AIS_ON_LPBK_ALL

AIS is sent on all loopbacks.

  • AIS_ON_LPBK_OFF

AIS is not sent on loopbacks.

  • AIS_ON_LPBK_TERMINAL

AIS is sent on terminal loopbacks.

<FREQ>

(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).

  • 1310

Wavelength 1310

  • 1470

Wavelength 1470

  • 1490

Wavelength 1490

  • 1510

Wavelength 1510

  • 1528.77

Wavelength 1528.77

  • 1529.55

Wavelength 1529.55

  • 1529.94

Wavelength 1529.94

  • 1530

Wavelength 1530

  • 1530.33

Wavelength 1530.33

  • 1530.73

Wavelength 1530.73

  • 1531.12

Wavelength 1531.12

  • 1531.51

Wavelength 1531.51

  • 1531.90

Wavelength 1531.90

  • 1532.29

Wavelength 1532.29

  • 1532.68

Wavelength 1532.68

  • 1533.07

Wavelength 1533.07

  • 1533.47

Wavelength 1533.47

  • 1533.86

Wavelength 1533.86

  • 1534.25

Wavelength 1534.25

  • 1534.64

Wavelength 1534.64

  • 1535.04

Wavelength 1535.04

  • 1535.43

Wavelength 1535.43

  • 1535.82

Wavelength 1535.82

  • 1536.22

Wavelength 1536.22

  • 1536.61

Wavelength 1536.61

  • 1537

Wavelength 1537

  • 1537.40

Wavelength 1537.40

  • 1537.79

Wavelength 1537.79

  • 1538.19

Wavelength 1538.19

  • 1538.58

Wavelength 1538.58

  • 1538.98

Wavelength 1538.98

  • 1539.37

Wavelength 1539.37

  • 1539.77

Wavelength 1539.77

  • 1540.16

Wavelength 1540.16

  • 1540.56

Wavelength 1540.56

  • 1540.95

Wavelength 1540.95

  • 1541.35

Wavelength 1541.35

  • 1541.75

Wavelength 1541.75

  • 1542.14

Wavelength 1542.14

  • 1542.35

Wavelength 1542.35

  • 1542.54

Wavelength 1542.54

  • 1542.94

Wavelength 1542.94

  • 1543.33

Wavelength 1543.33

  • 1543.73

Wavelength 1543.73

  • 1544.13

Wavelength 1544.13

  • 1544.53

Wavelength 1544.53

  • 1544.92

Wavelength 1544.92

  • 1545.32

Wavelength 1545.32

  • 1545.72

Wavelength 1545.72

  • 1546.12

Wavelength 1546.12

  • 1546.52

Wavelength 1546.52

  • 1546.92

Wavelength 1546.92

  • 1547.32

Wavelength 1547.32

  • 1547.72

Wavelength 1547.72

  • 1548.12

Wavelength 1548.12

  • 1548.51

Wavelength 1548.51

  • 1548.92

Wavelength 1548.92

  • 1549.32

Wavelength 1549.32

  • 1549.71

Wavelength 1549.71

  • 1550

Wavelength 1500

  • 1550.12

Wavelength 1550.12

  • 1550.52

Wavelength 1550.52

  • 1550.92

Wavelength 1550.92

  • 1551.32

Wavelength 1551.32

  • 1551.72

Wavelength 1551.72

  • 1552.12

Wavelength 1552.12

  • 1552.52

Wavelength 1552.52

  • 1552.93

Wavelength 1552.93

  • 1553.33

Wavelength 1553.33

  • 1553.73

Wavelength 1553.73

  • 1554.13

Wavelength 1554.13

  • 1554.13

Wavelength 1554.13

  • 1554.94

Wavelength 1554.94

  • 1555.34

Wavelength 1555.34

  • 1555.75

Wavelength 1555.75

  • 1556.15

Wavelength 1556.15

  • 1556.55

Wavelength 1556.55

  • 1556.96

Wavelength 1556.96

  • 1557.36

Wavelength 1557.36

  • 1557.77

Wavelength 1557.77

  • 1558.17

Wavelength 1558.17

  • 1558.58

Wavelength 1558.58

  • 1558.98

Wavelength 1558.98

  • 1559.39

Wavelength 1559.39

  • 1559.79

Wavelength 1559.79

  • 1560.20

Wavelength 1560.20

  • 1560.61

Wavelength 1560.61

  • 1561.01

Wavelength 1561.01

  • 1561.42

Wavelength 1561.42

  • 1561.83

Wavelength 1561.83

  • 1570

Wavelength 1570

  • 1570.83

Wavelength 1570.83

  • 1571.24

Wavelength 1571.24

  • 1571.65

Wavelength 1571.65

  • 1572.06

Wavelength 1572.06

  • 1572.48

Wavelength 1572.48

  • 1572.89

Wavelength 1572.89

  • 1573.30

Wavelength 1573.30

  • 1573.71

Wavelength 1573.71

  • 1574.13

Wavelength 1574.13

  • 1574.54

Wavelength 1574.54

  • 1574.95

Wavelength 1574.95

  • 1575.37

Wavelength 1575.37

  • 1575.78

Wavelength 1575.78

  • 1576.20

Wavelength 1576.20

  • 1576.61

Wavelength 1576.61

  • 1577.03

Wavelength 1577.03

  • 1577.44

Wavelength 1577.44

  • 1577.86

Wavelength 1577.86

  • 1578.27

Wavelength 1578.27

  • 1578.69

Wavelength 1578.69

  • 1579.10

Wavelength 1579.10

  • 1579.52

Wavelength 1579.52

  • 1579.93

Wavelength 1579.93

  • 1580.35

Wavelength 1580.35

  • 1580.77

Wavelength 1580.77

  • 1581.18

Wavelength 1581.18

  • 1581.60

Wavelength 1581.60

  • 1582.02

Wavelength 1582.02

  • 1582.44

Wavelength 1582.44

  • 1582.85

Wavelength 1582.85

  • 1583.27

Wavelength 1583.27

  • 1583.69

Wavelength 1583.69

  • 1584.11

Wavelength 1584.11

  • 1584.53

Wavelength 1584.53

  • 1584.95

Wavelength 1584.95

  • 1585.36

Wavelength 1585.36

  • 1585.78

Wavelength 1585.78

  • 1586.20

Wavelength 1586.20

  • 1586.62

Wavelength 1586.62

  • 1587.04

Wavelength 1587.04

  • 1587.46

Wavelength 1587.46

  • 1587.88

Wavelength 1587.88

  • 1588.30

Wavelength 1588.30

  • 1588.73

Wavelength 1588.73

  • 1589.15

Wavelength 1589.15

  • 1589.57

Wavelength 1589.57

  • 1589.99

Wavelength 1589.99

  • 1590

Wavelength 1590

  • 1590.41

Wavelength 1590.41

  • 1590.83

Wavelength 1590.83

  • 1591.26

Wavelength 1591.26

  • 1591.68

Wavelength 1591.68

  • 1592.10

Wavelength 1592.10

  • 1592.52

Wavelength 1592.52

  • 1592.95

Wavelength 1592.95

  • 1593.37

Wavelength 1593.37

  • 1593.79

Wavelength 1593.79

  • 1594.22

Wavelength 1594.22

  • 1594.64

Wavelength 1594.64

  • 1595.06

Wavelength 1595.06

  • 1595.49

Wavelength 1595.49

  • 1596.34

Wavelength 1596.34

  • 1596.76

Wavelength 1596.76

  • 1597.19

Wavelength 1597.19

  • 1597.62

Wavelength 1597.62

  • 1598.04

Wavelength 1598.04

  • 1598.47

Wavelength 1598.47

  • 1598.89

Wavelength 1598.89

  • 1599.32

Wavelength 1599.32

  • 1599.75

Wavelength 1599.75

  • 1600.06

Wavelength 1600.06

  • 1601.03

Wavelength 1601.03

  • 1601.46

Wavelength 1601.46

  • 1601.88

Wavelength 1601.88

  • 1602.31

Wavelength 1602.31

  • 1602.74

Wavelength 1602.74

  • 1603.17

Wavelength 1603.17

  • 1603.60

Wavelength 1603.60

  • 1604.03

Wavelength 1604.03

  • 1610

Wavelength 1610

  • USE-TWL1

Use Tunable Wavelength 1

<LOSSB>

(Optional) Parameter type is REACH (reach values).

  • AUTOPROV

Autoprovisioning

  • CX

Reach CX

  • DX

Reach DX

  • HX

Reach HX

  • I1

Reach I1

  • IR-1

Reach IR-1

  • IR-2

Reach IR-2

  • L1

Reach L1

  • L2

Reach L2

  • L3

Reach L3

  • LR-1

Reach LR-1

  • LR-2

Reach LR-2

  • LR-3

Reach LR-3

  • LX

Reach LX

  • S1

Reach S1

  • S2

Reach S2

  • SR

Reach SR

  • SR-1

Reach SR-1

  • SX

Reach SX

  • T

Reach T

  • VX

Reach VX

  • ZX

Reach ZX

<FOREIGNFEND>

(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).

  • N

Disable an attribute.

  • Y

Enable an attribute.

<FOREIGNIPADDRESS>

(Optional) The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. FOREIGNIPADDRESS is a string.

<PST_PSTQ>

Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.

  • IS-NR

In Service and Normal

  • OOS-AU

Out of Service and Autonomous

  • OOS-AUMA

Out of Service and Autonomous Management

  • OOS-MA

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.

  • AINS

Automatic In-Service

  • DSBLD

Disabled

  • LPBK

Loopback

  • MEA

Mismatch of Equipment

  • MT

Maintenance

  • OOG

Out of Group

  • SWDL

Software Download

  • UAS

Unassigned

  • UEQ

Unequipped

21.6 RTRV-<PATH>

(Cisco ONS 15454) The Retrieve STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, VT1, or VT2 (RTRV-<PATH>) command retrieves the attributes associated with an STS/VT path.

 
Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Supported AIDs are: ALL, SLOT-N (N=1,2,...,ALL), and STS/VT-specific AIDs.

The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and UPSRPTHSTATE parameters only apply to path protection configurations.

The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SONET STS Path overhead.

The EXPTRC indicates that the contents of the expected incoming path trace are provisioned by the user in the ED-STS_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.

The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode performs the comparison of the received string with the user entered expected string. The AUTO mode performs the comparison of the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.

When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user entered string. When an expected string is queried under the AUTO path trace mode, the expected string is a copy of the acquired received string or NULL if the string has not been acquired.

When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is a copy of the received string or NULL if the string has not been received.

J1 (EXPTRC) is implemented on the DS1/DS1N, DS3E/DS3NE, DS3XM, EC1, DS3/EC1-48, OC3, OC48AS, OC192, MRC-12, and OC192-XFP cards.

TRC and INCTRC are supported on DS1N, DS3NE, DS3/EC1-48, and DS3XM cards.

The following actions will result in error messages:

  • If you send this command while BLSRPTHTYPE=PCA, whether there is a BLSR switch or not, the protection channel access (PCA) path J1/C2 data will be returned (if there is PCA circuit on the AID).
  • Sending this command with an STS AID that does not have circuits and where no BLSR is switched on the STS will return an error message.
  • In LAN to WAN card mode, ALL aid is not supported for RTRV-VC464c.

Note • An optional input parameter, BLSRPTHTYPE, is introduced into this command to provide more options to retrieve the J1/C2 of a particular BLSR path. This field is valid only if the queried AID port has BLSR. The BLSRPTHTYPE defaults to the “non-pca” path type if the BLSR is switched, or defaults to all BLSR path types if there is no BLSR switching.

  • An optional output parameter, BLSRPTHSTATE, is introduced into this command output. Each J1/C2 output data of this command will include the BLSR path state information.
  • After BLSR switching, the J1/IPPM/C2 data can be retrieved over the protection path. J1 trace string, trace mode, or threshold is not allowed on the protection path.
  • HOLDOFFTIMER is not specific to a path. Instead, it is applicable to the path protection selector.
  • VT1.5 J2 path trace provisioning is supported on the DS3XM-12 card and the ONS 15454 CE-100T-8 card VT1.5 path using the ED-VT1, RTRV-VT1, and RTRV-PTHTRC-VT1 commands.
  • For the selector path on a BLSR, the SWPDIP path attribute is not editable and is always in the ON state.
  • SFBER and SDBER are applied for the ONS 15454 when the ONS 15454 has an XC-VXC-10G card.


 

Category

Paths

Security

Retrieve

Input Format

RTRV-<PATH>:[<TID>]:<AID>:<CTAG>[:::BLSRPTHTYPE=<BLSRPTHTYPE>][:];

Input Example

RTRV-STS3C:FERNDALE:STS-2-1-4:238:::BLSRPTHTYPE=NON-PCA;

Input Parameters

<AID>

Access identifier from the “CrossConnectId1” section.

<BLSRPTHTYPE>

The BLSR path type only if the port is on the BLSR. No value or a null value defaults to NON-PCA. Applicable only to STS-level paths in SONET. The parameter type is BLSR_PTH_TYPE, which is the BLSR path type only if the port is on the BLSR.

  • NON-PCA

The AID is on the working path, or the cross-connection card protection path.

  • PCA

The AID is on the BLSR PCA path.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>::[LEVEL=<LEVEL>],[SFBER=<SFBER>],[SDBER=<SDBER>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[SWPDIP=<SWPDIP>],[HOLDOFFTIMER=<HOLDOFFTIMER>],
[EXPTRC=<EXPTRC>],[TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>],
[TRCFORMAT =<TRCFORMAT>],[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],
[UPSRPTHSTATE=<UPSRPTHSTATE>],[C2=<C2>],
[BLSRPTHSTATE=<BLSRPTHSTATE>]:<PST_PSTQ>,[<SSTQ>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“STS-2-1-4::LEVEL=STS1,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y,
HOLDOFFTIMER=2000,EXPTRC=“EXPTRCSTRING”,TRC=“TRCSTRING”,
INCTRC=“INCTRCSTRING”,TRCMODE=AUTO,TRCFORMAT=64-BYTE,TACC=8,
TAPTYPE=DUAL,UPSRPTHSTATE=ACT,C2=0X04,
BLSRPTHSTATE=PROTPTHACT:OOS-AU,AINS”
;

Output Parameters

<AID>

Access identifier from the “CrossConnectId1” section.

<LEVEL>

(Optional) The rate of the cross-connect. Indicates the rate of the cross-connected channel. Applicable only to the STS path in SONET. The parameter type is PATH, which is the modifier for path commands.

  • STS1

Synchronous transport signal/module level 1 (51.84 Mbps)

  • STS3C

Synchronous transport signal/module level 3 concatenated (155.52 Mbps)

  • STS6C

Synchronous transport signal/module level 6 (311.04 Mbps)

  • STS9C

Synchronous transport signal/module level 9 concatenated (466.56 Mbps)

  • STS12C

Synchronous transport signal/module level 12 concatenated (622.08 Mbps)

  • STS18C

Synchronous transport signal/module level 18 concatenated (933.12 Mbps)

  • STS24C

Synchronous transport signal/module level 24 concatenated (1244.16 Mbps)

  • STS36C

Synchronous transport signal/module level 36 concatenated (1866.24 Mbps)

  • STS48C

Synchronous transport signal/module level 48 concatenated (2488.32 Mbps)

  • STS192C

Synchronous transport signal/module level 192 concatenated (9953.28 Mbps)

<SFBER>

(Optional) An STS path signal failure threshold that only applies to path protection. Applicable only to STS-level paths in SONET. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.

  • 1E-3

SFBER is 1E-3.

  • 1E-4

SFBER is 1E-4.

  • 1E-5

SFBER is 1E-5.

<SDBER>

(Optional) An STS path signal degrade threshold that only applies to path protection. Applicable only to STS-level paths in SONET. Defaults 1E-6. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.

  • 1E-5

SDBER is 1E-5.

  • 1E-6

SDBER is 1E-6.

  • 1E-7

SDBER is 1E-7.

  • 1E-8

SDBER is 1E-8.

  • 1E-9

SDBER is 1E-9.

<RVRTV>

Revertive mode. Only applies to path protection. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Does not revert service to original line after restoration.

  • Y

Reverts service to original line after restoration.

<RVTM>

Revertive time. Only applies to path protection. The parameter type is REVERTIVE_TIME.

  • 0.5 to 12.0

Revertive time is 0.5 to 12.0 minutes.

<SWPDIP>

(Optional) Switch on PDI-P. Applicable only to STS-level paths in SONET. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

Enable an attribute.

<HOLDOFFTIMER>

(Optional) Hold off timer. HOLDOFFTIMER is an integer.

<EXPTRC>

(Optional) Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). Applicable to STS-level paths in SONET. Defaults to NULL when a path protection path is created. EXPTRC is a string.

<TRC>

(Optional) The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to STS-level paths in SONET. Applicable to VT-level paths for the DS3XM-12 card on the ONS 15454. TRC is a string.

<INCTRC>

(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to STS-level paths in SONET (STSn). Defaults to null when a path protection path is created. INCTRC is a string.

<TRCMODE>

(Optional) Path trace mode. Applicable only to STS-level paths in SONET (STSn). Defaults to OFF when a path protection path is created. The parameter type is TRCMODE (trace mode).

  • AUTO

Use the previously received path trace string as the expected string (not applicable to MXP_2.5G_10G and TXP_MR_10G cards).

  • AUTO-NO-AIS

Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIM-P detected.

  • MAN

Use the provisioned expected string as the expected string.

  • MAN-NO-AIS

Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIM-P detected.

  • OFF

Turn off path trace capability. Nothing will be reported.

<TRCFORMAT>

(Optional) Trace message size. The parameter type is TRCFORMAT (trace format).

  • 1-BYTE

1-byte trace message

  • 16-BYTE

16-byte trace message

  • 64-BYTE

64-byte trace message

  • Y

Enable an attribute.

<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

Dual FAD

  • SINGLE

Single FAD

<UPSRPTHSTATE>

(Optional) Indicates whether a given AID is the working or standby path of a path protection cross-connect. The parameter type is STATUS, which is the status of the unit in the protection pair.

  • ACT

The entity is the active unit in the shelf.

  • NA

Status is unavailable.

  • STBY

The entity is the standby unit in the shelf.

<C2>

(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.

  • 0X00

Unequipped

  • 0X01

Equipped Non-Specific payload

  • 0X02

VT-Structured STS-1 synchronous payload envelope (SPE)

  • 0X03

Locked VT Mode

  • 0X04

Asynchronous Mapping for DS3

  • 0X12

Asynchronous Mapping for DS4 North American (NA)

  • 0X13

Mapping for ATM

  • 0X14

Mapping for DQDB

  • 0X15

Asynchronous Mapping for FDDI

  • 0X16

HDLC-Over-SONET Mapping

  • 0XE1

VT-structured STS-1 SPE with 1VTx payload defect

  • 0XE2

VT-structured STS-1 SPE with 2VTx payload defects

  • 0XE3

VT-structured STS-1 SPE with 3VTx payload defects

  • 0XE4

VT-structured STS-1 SPE with 4VTx payload defects

  • 0XE5

VT-structured STS-1 SPE with 5VTx payload defects

  • 0XE6

VT-structured STS-1 SPE with 6VTx payload defects

  • 0XE7

VT-structured STS-1 SPE with 7VTx payload defects

  • 0XE8

VT-structured STS-1 SPE with 8VTx payload defects

  • 0XE9

VT-structured STS-1 SPE with 9VTx payload defects

  • 0XEA

VT-structured STS-1 SPE with 10VTx payload defects

  • 0XEB

VT-structured STS-1 SPE with 11VTx payload defects

  • 0XEC

VT-structured STS-1 SPE with 12VTx payload defects

  • 0XED

VT-structured STS-1 SPE with 13VTx payload defects

  • 0XEE

VT-structured STS-1 SPE with 14VTx payload defects

  • 0XEF

VT-structured STS-1 SPE with 15VTx payload defects

  • 0XF0

VT-structured STS-1 SPE with 16VTx payload defects

  • 0XF1

VT-structured STS-1 SPE with 17VTx payload defects

  • 0XF2

VT-structured STS-1 SPE with 18VTx payload defects

  • 0XF3

VT-structured STS-1 SPE with 19VTx payload defects

  • 0XF4

VT-structured STS-1 SPE with 20VTx payload defects

  • 0XF5

VT-structured STS-1 SPE with 21VTx payload defects

  • 0XF6

VT-structured STS-1 SPE with 22VTx payload defects

  • 0XF7

VT-structured STS-1 SPE with 23VTx payload defects

  • 0XF8

VT-structured STS-1 SPE with 24VTx payload defects

  • 0XF9

VT-structured STS-1 SPE with 25VTx payload defects

  • 0XFA

VT-structured STS-1 SPE with 26VTx payload defects

  • 0XFB

VT-structured STS-1 SPE with 27VTx payload defects

  • 0XFC

VT-structured STS-1 SPE with 28VTx payload defects

  • 0XFE

O.181 Test Signal (TSS1 to TSS3) Mapping

  • 0XFF

Reserved, however, C2 is 0XFF if an AIS-L is being generated by an optical card or cross-connect downstream.

<BLSRPTHSTATE>

(Optional) The BLSR path state only if the port is on the BLSR. Applicable only to STS-level paths in SONET (STSn). The parameter type is BLSR_PTH_STATE, which is the BLSR path state only if the port is on the BLSR.

  • PCAPTHACT

Indicates the BLSR is not switched and its PCA path is in the active state.

  • PCAPTHSTB

Indicates the BLSR is switched and its PCA path is in the standby state.

  • PROTPTHACT

Indicates the BLSR is switched and its protection path is in the active state.

  • WKGPTHACT

Indicates the BLSR is not switched and its working path is in the active state.

  • WKGPTHSTB

Indicates the BLSR is switched and its working path is in the standby state.

<PST_PSTQ>

Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.

  • IS-NR

In Service and Normal

  • OOS-AU

Out of Service and Autonomous

  • OOS-AUMA

Out of Service and Autonomous Management

  • OOS-MA

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.

  • AINS

Automatic In-Service

  • DSBLD

Disabled

  • LPBK

Loopback

  • MEA

Mismatch of Equipment

  • MT

Maintenance

  • OOG

Out of Group

  • SWDL

Software Download

  • UAS

Unassigned

  • UEQ

Unequipped

21.7 RTRV-10GIGE

(Cisco ONS 15454) The Retrieve 10GIGE (RTRV-10GIGE) command retrieves the 10 Gbps-specific parameters for a port that has been configured to support the Gigabit Ethernet payload with the ENT-10GIGE command.

 
Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

RTRV-10GIGE:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-10GIGE:TID:FAC-1-1:100;

Input Parameters

<AID>

Access identifier from the “FACILITY” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:,,[<ROLE>],[<STATUS>]:[NAME=<NAME>],[MACADDR=<MACADDR>],
[LBCL=<LBCL>],[OPT=<OPT>],[OPR=<OPR>],[FREQ=<FREQ>],
[LOSSB=<LOSSB>]:<PSTPSTQ>,[<SST>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-6-1:,,WORK,ACT:NAME=\"NY PORT\",MACADDR=00-0E-AA-BB-CC-FF,LBCL=10.0,
OPT=10.0,OPR=10.0,FREQ=1550,LOSSB=SX:OOS-AU,AINS”
;

Output Parameters

<AID>

Access identifier from the “FACILITY” section.

<ROLE>

(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role the unit is playing in the protection group.

  • PROT

The entity is a protection unit in the protection group.

  • WORK

The entity is a working unit in the protection group.

<STATUS>

(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is the status of the unit in the protection pair.

  • ACT

The entity is the active unit in the shelf.

  • NA

Status is unavailable.

  • STBY

The entity is the standby unit in the shelf.

<NAME>

(Optional) Port name. NAME is a string.

<MACADDR>

(Optional) The MAC address for the 10-Gigabit Ethernet payload. MACADDR is a string.

<LBCL>

(Optional) Displays the current value of the laser current. LBCL is a float.

<OPT>

(Optional) Displays the current value of the transmitted optical power. OPT is a float.

<OPR>

(Optional) Displays the current value of the received optical power. OPR is a float.

<FREQ>

(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).

  • 1310

Wavelength 1310

  • 1470

Wavelength 1470

  • 1490

Wavelength 1490

  • 1510

Wavelength 1510

  • 1529.55

Wavelength 1529.55

  • 1529.94

Wavelength 1529.94

  • 1530

Wavelength 1530

  • 1530.33

Wavelength 1530.33

  • 1530.73

Wavelength 1530.73

  • 1531.12

Wavelength 1531.12

  • 1531.51

Wavelength 1531.51

  • 1531.90

Wavelength 1531.90

  • 1532.29

Wavelength 1532.29

  • 1532.68

Wavelength 1532.68

  • 1533.07

Wavelength 1533.07

  • 1533.47

Wavelength 1533.47

  • 1533.86

Wavelength 1533.86

  • 1534.25

Wavelength 1534.25

  • 1534.64

Wavelength 1534.64

  • 1535.04

Wavelength 1535.04

  • 1535.43

Wavelength 1535.43

  • 1535.82

Wavelength 1535.82

  • 1536.22

Wavelength 1536.22

  • 1536.61

Wavelength 1536.61

  • 1537

Wavelength 1537

  • 1537.40

Wavelength 1537.40

  • 1537.79

Wavelength 1537.79

  • 1538.19

Wavelength 1538.19

  • 1538.58

Wavelength 1538.58

  • 1538.98

Wavelength 1538.98

  • 1539.37

Wavelength 1539.37

  • 1539.77

Wavelength 1539.77

  • 1540.16

Wavelength 1540.16

  • 1540.56

Wavelength 1540.56

  • 1540.95

Wavelength 1540.95

  • 1541.35

Wavelength 1541.35

  • 1541.75

Wavelength 1541.75

  • 1542.14

Wavelength 1542.14

  • 1542.35

Wavelength 1542.35

  • 1542.54

Wavelength 1542.54

  • 1542.94

Wavelength 1542.94

  • 1543.33

Wavelength 1543.33

  • 1543.73

Wavelength 1543.73

  • 1544.13

Wavelength 1544.13

  • 1544.53

Wavelength 1544.53

  • 1544.92

Wavelength 1544.92

  • 1545.32

Wavelength 1545.32

  • 1545.72

Wavelength 1545.72

  • 1546.12

Wavelength 1546.12

  • 1546.52

Wavelength 1546.52

  • 1546.92

Wavelength 1546.92

  • 1547.32

Wavelength 1547.32

  • 1547.72

Wavelength 1547.72

  • 1548.12

Wavelength 1548.12

  • 1548.51

Wavelength 1548.51

  • 1548.92

Wavelength 1548.92

  • 1549.32

Wavelength 1549.32

  • 1549.71

Wavelength 1549.71

  • 1550

Wavelength 1500

  • 1550.12

Wavelength 1550.12

  • 1550.52

Wavelength 1550.52

  • 1550.92

Wavelength 1550.92

  • 1551.32

Wavelength 1551.32

  • 1551.72

Wavelength 1551.72

  • 1552.12

Wavelength 1552.12

  • 1552.52

Wavelength 1552.52

  • 1552.93

Wavelength 1552.93

  • 1553.33

Wavelength 1553.33

  • 1553.73

Wavelength 1553.73

  • 1554.13

Wavelength 1554.13

  • 1554.13

Wavelength 1554.13

  • 1554.94

Wavelength 1554.94

  • 1555.34

Wavelength 1555.34

  • 1555.75

Wavelength 1555.75

  • 1556.15

Wavelength 1556.15

  • 1556.55

Wavelength 1556.55

  • 1556.96

Wavelength 1556.96

  • 1557.36

Wavelength 1557.36

  • 1557.77

Wavelength 1557.77

  • 1558.17

Wavelength 1558.17

  • 1558.58

Wavelength 1558.58

  • 1558.98

Wavelength 1558.98

  • 1559.39

Wavelength 1559.39

  • 1559.79

Wavelength 1559.79

  • 1560.20

Wavelength 1560.20

  • 1560.61

Wavelength 1560.61

  • 1561.01

Wavelength 1561.01

  • 1561.42

Wavelength 1561.42

  • 1561.83

Wavelength 1561.83

  • 1570

Wavelength 1570

  • 1570.83

Wavelength 1570.83

  • 1571.24

Wavelength 1571.24

  • 1571.65

Wavelength 1571.65

  • 1572.06

Wavelength 1572.06

  • 1572.48

Wavelength 1572.48

  • 1572.89

Wavelength 1572.89

  • 1573.30

Wavelength 1573.30

  • 1573.71

Wavelength 1573.71

  • 1574.13

Wavelength 1574.13

  • 1574.54

Wavelength 1574.54

  • 1574.95

Wavelength 1574.95

  • 1575.37

Wavelength 1575.37

  • 1575.78

Wavelength 1575.78

  • 1576.20

Wavelength 1576.20

  • 1576.61

Wavelength 1576.61

  • 1577.03

Wavelength 1577.03

  • 1577.44

Wavelength 1577.44

  • 1577.86

Wavelength 1577.86

  • 1578.27

Wavelength 1578.27

  • 1578.69

Wavelength 1578.69

  • 1579.10

Wavelength 1579.10

  • 1579.52

Wavelength 1579.52

  • 1579.93

Wavelength 1579.93

  • 1580.35

Wavelength 1580.35

  • 1580.77

Wavelength 1580.77

  • 1581.18

Wavelength 1581.18

  • 1581.60

Wavelength 1581.60

  • 1582.02

Wavelength 1582.02

  • 1582.44

Wavelength 1582.44

  • 1582.85

Wavelength 1582.85

  • 1583.27

Wavelength 1583.27

  • 1583.69

Wavelength 1583.69

  • 1584.11

Wavelength 1584.11

  • 1584.53

Wavelength 1584.53

  • 1584.95

Wavelength 1584.95

  • 1585.36

Wavelength 1585.36

  • 1585.78

Wavelength 1585.78

  • 1586.20

Wavelength 1586.20

  • 1586.62

Wavelength 1586.62

  • 1587.04

Wavelength 1587.04

  • 1587.46

Wavelength 1587.46

  • 1587.88

Wavelength 1587.88

  • 1588.30

Wavelength 1588.30

  • 1588.73

Wavelength 1588.73

  • 1589.15

Wavelength 1589.15

  • 1589.57

Wavelength 1589.57

  • 1589.99

Wavelength 1589.99

  • 1590

Wavelength 1590

  • 1590.41

Wavelength 1590.41

  • 1590.83

Wavelength 1590.83

  • 1591.26

Wavelength 1591.26

  • 1591.68

Wavelength 1591.68

  • 1592.10

Wavelength 1592.10

  • 1592.52

Wavelength 1592.52

  • 1592.95

Wavelength 1592.95

  • 1593.37

Wavelength 1593.37

  • 1593.79

Wavelength 1593.79

  • 1594.22

Wavelength 1594.22

  • 1594.64

Wavelength 1594.64

  • 1595.06

Wavelength 1595.06

  • 1595.49

Wavelength 1595.49

  • 1596.34

Wavelength 1596.34

  • 1596.76

Wavelength 1596.76

  • 1597.19

Wavelength 1597.19

  • 1597.62

Wavelength 1597.62

  • 1598.04

Wavelength 1598.04

  • 1598.47

Wavelength 1598.47

  • 1598.89

Wavelength 1598.89

  • 1599.32

Wavelength 1599.32

  • 1599.75

Wavelength 1599.75

  • 1600.06

Wavelength 1600.06

  • 1601.03

Wavelength 1601.03

  • 1601.46

Wavelength 1601.46

  • 1601.88

Wavelength 1601.88

  • 1602.31

Wavelength 1602.31

  • 1602.74

Wavelength 1602.74

  • 1603.17

Wavelength 1603.17

  • 1603.60

Wavelength 1603.60

  • 1604.03

Wavelength 1604.03

  • 1610

Wavelength 1610

  • USE-TWL1

Use Tunable Wavelength 1

<LOSSB>

(Optional) The parameter type is REACH (reach values).

  • AUTOPROV

Autoprovisioning

  • CX

Reach CX

  • DX

Reach DX

  • HX

Reach HX

  • I1

Reach I1

  • IR-1

Reach IR-1

  • IR-2

Reach IR-2

  • L1

Reach L1

  • L2

Reach L2

  • L3

Reach L3

  • LR-1

Reach LR-1

  • LR-2

Reach LR-2

  • LR-3

Reach LR-3

  • LX

Reach LX

  • S1

Reach S1

  • S2

Reach S2

  • SR

Reach SR

  • SR-1

Reach SR-1

  • SX

Reach SX

  • T

Reach T

  • VX

Reach VX

  • ZX

Reach ZX

<PST_PSTQ>

Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the SST and PSTQ.

  • IS-NR

In Service and Normal

  • OOS-AU

Out of Service and Autonomous

  • OOS-AUMA

Out of Service and Autonomous Management

  • OOS-MA

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.

  • AINS

Automatic In-Service

  • DSBLD

Disabled

  • LPBK

Loopback

  • MEA

Mismatch of Equipment

  • MT

Maintenance

  • OOG

Out of Group

  • SWDL

Software Download

  • UAS

Unassigned

  • UEQ

Unequipped

21.8 RTRV-ALM-<MOD2ALM>

(Cisco ONS 15454) The Retrieve Alarm for (10GFC, 10GIGE, 40GIGE, 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, MSISC, OC12, OC192, OC3, OC48, OC768, OCH, OMS, OTS, OTU2, OTU3, POS, RPRIF, STM1, STM4, STM16, STM64, STM1E, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC3,VC4,VC4-2c,VC4-3c,VC4-4c,VC4-16c,VC4-64c, VC11, VC12, VC3, VCG, VT1, VT2, or WLEN (RTRV-ALM-<MOD2ALM>) command retrieves and sends the current status of alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.

 
Usage Guidelines

See Table 28-1 for supported modifiers by platform.


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



Note The AIDTYPE shows STS1 for STS alarms.


Category

Fault

Security

Retrieve

Input Format

RTRV-ALM-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>][<LOCN>],[<DIRN>][,];

Input Example

RTRV-ALM-OC12:ELDRIDGE:FAC-5-1:225::MN,SD,SA,NEND,RCV;

Input Parameters

<AID>

Access identifier from the “AidUnionId” section.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-5-1,OC12:MJ,SD,SA,09-05,12-30-20,NEND,RCV:\"BER AT SIGNAL DEGRADE LEVEL\","
;

Output Parameters

<AID>

Access identifier from the “ALL” section.

<AIDTYPE>

(Optional) Type of access identifier. The parameter type is MOD2ALM (alarm type).

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 1GISC3

1-Gigabit ISC3 compatible

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • CLNT

Client facility for MXP/TXP cards

  • CHGRP

Channel group

  • DS1

DS1 alarm

  • DS3I

DS3I alarm

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GFPOS

Generic framing protocol over packet over SONET virtual port alarm

  • GIGE

Gigabit Ethernet port alarm

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • ML1000-2

(ONS 15454) ML-Series two port Gigabit Ethernet card

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OCHTERM

OCH termination

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • UDCDCC

UDC-DCC alarm

  • UDCF

UCD-F alarm

  • VCG

Virtual concatenation group alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

  • WLEN

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.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

The condition is service affecting.

<OCRDAT>

(Optional) Date when the specific event or violation occurred, MM-DD.

<OCRTM>

(Optional) Time when the specific event or violation occurred, HH-MM-SS.

<LOCN>

Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<DESC>

(Optional) A condition description. DESC is a string.

21.9 RTRV-ALMTYPE

(Cisco ONS 15454) The Retrieve Alarm Type command retrieves all system and user-defined alarm types.

 
Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

RTRV-ALMTYPE:[<TID>]::<CTAG>;

Input Example

RTRV-ALMTYPE:CISCONODE::1;

Input Parameters

None.

Output Format

SID DATE TIME
M CTAG COMPLD
"<TYPEOFALM>,<ALMTYPE>"
;

Output Examples

CISCONODE 2007-06-26 14:30:00
M 1 COMPLD
"SYSTEMDEFINED,AIRCOMPR"
;

Output Parameters

<TYPEOFALM>

Specifies the type of alarm, that is, system or user-defined.

  • SYSTEMDEFINED

Specifies a system-defined alarm type.

  • USERDEFINED

Specifies a user-defined alarm type.

<ALMTYPE>

Specifies user-defined alarm types associated with virtual wires in environmental alarm inputs.

21.10 RTRV-ALM-ALL

(Cisco ONS 15454) The Retrieve Alarm All (RTRV-ALM-ALL) command retrieves and sends the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.

 
Usage Guidelines

According to Telcordia GR-833, the RTRV-ALM-ALL command only reports EQPT, COM, T1, T3, OCN, EC1, STSN, VT1, DS1, E100, E1000, G1000, ML-Series, TXP, and MXP alarms. To retrieve all the NE alarms, issue all of the following commands:

RTRV-ALM-ALL
RTRV-ALM-BITS
RTRV-ALM-ENV
RTRV-ALM-SYNCN

Category

Fault

Security

Retrieve

Input Format

RTRV-ALM-ALL:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDITION>],[<SRVEFF>],[<LOCN>],[<DIRN>],[,];

Input Example

RTRV-ALM-ALL:COTATI:ALL:229::MN,PWRRESTART,NSA,NEND,RCV;

Input Parameters

<AID>

Access identifier from the “ALL” section. A null value is equivalent to ALL. AID is a string.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

<CONDITION>

The type of alarm condition. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

Output Format

SID DATE TIME
M CTAG COMPLD
“[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<LOCN>],[<DIRN>]:
[<DESC>],[<AIDDET>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“SLOT-2,EQPT:MN,PWRRESTART,NSA,08-01,14-25-59,NEND,RCV:\"POWER FAIL RESTART\", DS1-14"
;

Output Parameters

<AID>

(Optional) Access identifier from the “ALL” section.

<AIDTYPE>

(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • BITS

Building integrated timing supply (BITS) alarm

  • CHGRP

Channel group

  • CLNT

Client facility for muxponder (MXP) and transponder (TXP) cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS3i-N-12 alarm

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • HDLC

High-level data link control (HDLC) frame mode.

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • ML1000-2

(ONS 15454) ML-Series two port Gigabit Ethernet card

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

Packet over SONET (POS) port alarm

  • REP

Resilient Ethernet Protocol

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<NTFCNCDE>

Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<OCRDAT>

(Optional) Date when the specific event or violation occurred, MM-DD.

<OCRTM>

(Optional) Time when the specific event or violation occurred, HH-MM-SS.

<DESC>

(Optional) A condition description. DESC is a string.

<AIDDET>

(Optional) AIDDET uses the same addressing rules as the AID, but specifies AID type and additional details about the entity being managed. The supplementary equipment identification.

21.11 RTRV-ALM-BITS

(Cisco ONS 15454) The Retrieve Alarm Building Integrated Timing Supply (RTRV-ALM-BITS) command retrieves and sends the current status of alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.

 
Usage Guidelines

None

Category

Synchronization

Security

Retrieve

Input Format

RTRV-ALM-BITS:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],
[<LOCN>],[<DIRN>];

Input Example

RTRV-ALM-BITS:ELVERANO:BITS-1:228::CR,LOS,SA;

Input Parameters

<AID>

Access identifier from the “BITS” section.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

The condition type for an alarm or reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

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,,,,:\“LOSS OF SIGNAL\”,”
;

Output Parameters

<AID>

(Optional) Access identifier from the “BITS” section.

<AIDTYPE>

(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • 40GIGE

40-Gigabit Ethernet

  • BITS

BITS alarm

  • CHGRP

Channel group

  • CLNT

Client facility for MXP/TXP cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS3i-N-12 alarm

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • HDLC

High-level data link control (HDLC) frame mode.

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC 768 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • REP

Resilient Ethernet Protocol

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<NTFCNCDE>

Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

The condition is service affecting.

<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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<DESC>

(Optional) A condition description. DESC is a string.

21.12 RTRV-ALM-ENV

(Cisco ONS 15454) The Retrieve Alarm Environment (RTRV-ALM-ENV) command retrieves the environmental alarms.

 
Usage Guidelines

None

Category

Environment

Security

Retrieve

Input Format

RTRV-ALM-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];

Input Example

RTRV-ALM-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;

Input Parameters

<AID>

Access identifier from the “ENV” section.

Note For RTRV-ALM-ENV, only ENV-IN-{1-4} is a valid AID for ONS 15454. ENV-OUT-{1,6} is not a valid AID for RTRV-ALM-ENV.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<ALMTYPE>

The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm types.

  • AIRCOMPR

Air compressor failure

  • AIRCOND

Air conditioning failure

  • AIRDRYR

Air dryer failure

  • BATDSCHRG

Battery discharging

  • BATTERY

Battery failure

  • CLFAN

Cooling fan failure

  • CPMAJOR

Centralized power major failure

  • CPMINOR

Centralized power minor failure

  • ENGINE

Engine failure

  • ENGOPRG

Engine operating

  • ENGTRANS

Standby engine transfer

  • EXPLGS

Explosive gas

  • FIRDETR

Fire detector failure

  • FIRE

Fire

  • FLOOD

Flood

  • FUELLEAK

Fuel leak

  • FUSE

Fuse failure

  • GASALARM

Explosive gas, toxic gas, ventilation fail, or gas monitor fail

  • HATCH

Controlled Environment Vault (CEV) hatch fail

  • GEN

Generator failure

  • HIAIR

High airflow

  • HIHUM

High humidity

  • HITEMP

High temperature

  • HIWTR

High water

  • INTRUDER

Intrusion

  • LEVELCON

Level converter

  • LVDADSL

Secondary ADSL low voltage disconnect

  • LVDBYPAS

Low voltage disconnected bypass

  • LWBATVG

Low battery voltage

  • LWFUEL

Low fuel

  • LWHUM

Low humidity

  • LWPRES

Low cable pressure

  • LWTEMP

Low temperature

  • LWWTR

Low water

  • MISC

Miscellaneous

  • OPENDR

Open door

  • POWER

Commercial power failure

  • PUMP

Pump failure

  • PWR-48

48 V power supply failure

  • PWR-139

–139 V power converter

  • PWR-190

–190 V power converter

  • PWRMJ

Power supply major

  • PWRMN

Power supply minor

  • RECT

Rectifier failure

  • RECTHI

Rectifier high voltage

  • RECTLO

Rectifier low voltage

  • RINGGENMJ

Ringing generator major

  • RINGGENMN

Ringing generator minor

  • RTACADSL

AC or AC/rectifier power fail ADSL equipment

  • RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

  • RTACPWR

AC or AC/rectifier power fail DCL equipment

  • RTACPWRENG

Commercial AC fail, site equipped with standby engine

  • RTBAYPWR

AC power loss distributed power RT bay

  • RTRVENG

Retrieve standby engine, commercial AC restored

  • SMOKE

Smoke

  • TEMP

High-low temperature

  • TOXICGAS

Toxic gas

  • TREPEATER

T-repeater shelf

  • VENTN

Ventilation system failure

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>],[<DESC>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“ENV-IN-1:MJ,OPENDR,08-01,14-25-59,\“OPEN DOOR\””
;

Output Parameters

<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.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<ALMTYPE>

The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm types.

  • AIRCOMPR

Air compressor failure

  • AIRCOND

Air conditioning failure

  • AIRDRYR

Air dryer failure

  • BATDSCHRG

Battery discharging

  • BATTERY

Battery failure

  • CLFAN

Cooling fan failure

  • CPMAJOR

Centralized power major failure

  • CPMINOR

Centralized power minor failure

  • ENGINE

Engine failure

  • ENGOPRG

Engine operating

  • ENGTRANS

Standby engine transfer

  • EXPLGS

Explosive gas

  • FIRDETR

Fire detector failure

  • FIRE

Fire

  • FLOOD

Flood

  • FUELLEAK

Fuel leak

  • FUSE

Fuse failure

  • GASALARM

Explosive gas, toxic gas, ventilation fail, or gas monitor fail

  • HATCH

CEV hatch fail

  • GEN

Generator failure

  • HIAIR

High airflow

  • HIHUM

High humidity

  • HITEMP

High temperature

  • HIWTR

High water

  • INTRUDER

Intrusion

  • LEVELCON

Level converter

  • LVDADSL

Secondary ADSL low voltage disconnect

  • LVDBYPAS

Low voltage disconnected bypass

  • LWBATVG

Low battery voltage

  • LWFUEL

Low fuel

  • LWHUM

Low humidity

  • LWPRES

Low cable pressure

  • LWTEMP

Low temperature

  • LWWTR

Low water

  • MISC

Miscellaneous

  • OPENDR

Open door

  • POWER

Commercial power failure

  • PUMP

Pump failure

  • PWR-48

48 V power supply failure

  • PWR-139

–139 V power converter

  • PWR-190

–190 V power converter

  • PWRMJ

Power supply major

  • PWRMN

Power supply minor

  • RECT

Rectifier failure

  • RECTHI

Rectifier high voltage

  • RECTLO

Rectifier low voltage

  • RINGGENMJ

Ringing generator major

  • RINGGENMN

Ringing generator minor

  • RTACADSL

AC or AC/rectifier power fail ADSL equipment

  • RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

  • RTACPWR

AC or AC/rectifier power fail DCL equipment

  • RTACPWRENG

Commercial AC fail, site equipped with standby engine

  • RTBAYPWR

AC power loss distributed power RT bay

  • RTRVENG

Retrieve standby engine, commercial AC restored

  • SMOKE

Smoke

  • TEMP

High-low temperature

  • TOXICGAS

Toxic gas

  • TREPEATER

T-repeater shelf

  • VENTN

Ventilation system failure

OCRDAT

(Optional) Date when the specific event or violation occurred, MM-DD.

OCRTM

(Optional) Time when the specific event or violation occurred, HH-MM-SS.

DESC

(Optional) A condition description. DESC is a string.

21.13 RTRV-ALM-EQPT

(Cisco ONS 15454) The Retrieve Alarm Equipment (RTRV-ALM-EQPT) command retrieves and sends the current status of alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.

 
Usage Guidelines

None

Category

Equipment

Security

Retrieve

Input Format

RTRV-ALM-EQPT:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],[<SRVEFF>],
[<LOCN>],[<DIRN>];

Input Example

RTRV-ALM-EQPT:TWOROCK:SLOT-7:227::MJ,HITEMP,NSA;

Input Parameters

<AID>

Access identifier from the “EQPT” section.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

The condition type for an alarm or a reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

Output Format

SID DATE TIME
M CTAG COMPLD
“[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“SLOT-7,EQPT:MJ,HITEMP,NSA,08-01,14-25-59,,:\“HI TEMPERATURE\”,”
;

Output Parameters

<AID>

(Optional) Access identifier from the “EQPT” section.

<AIDTYPE>

(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • BITS

BITS alarm

  • CHGRP

Channel group

  • CLNT

Client facility for MXP/TXP cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS3I alarm

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • HDLC

High-level data link control (HDLC) frame mode.

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • REP

Resilient Ethernet Protocol

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<NTFCNCDE>

Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<OCRDAT>

(Optional) Date when the specific event or violation occurred, MM-DD.

<OCRTM>

(Optional) Time when the specific event or violation occurred, HH-MM-SS.

<DESC>

(Optional) A condition description. DESC is a string.

21.14 RTRV-ALM-SYNCN

(Cisco ONS 15454) The Retrieve Alarm Synchronization (RTRV-ALM-SYNCN) command retrieves and sends the current status of alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.

 
Usage Guidelines

None

Category

Synchronization

Security

Retrieve

Input Format

RTRV-ALM-SYNCN:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>],[<LOCN>],[<DIRN>];

Input Example

RTRV-ALM-SYNCN:FULTON:SYNC-NE:226::CR,FAILTOSW,SA;

Input Parameters

<AID>

Access identifier from the “SYNC_REF” section.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

The condition type for an alarm or a reported event. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service. A null value is equivalent to ALL.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,
[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>]:[<DESC>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“SYNC-NE,SYNCN:CR,FAILTOSW,SA,08-01,
14-25-59,,:\“FAILURE TO SWITCH TO PROTECTION\”,”
;

Output Parameters

<AID>

Access identifier from the “SYN” section.

<AIDTYPE>

(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • BITS

BITS alarm

  • CHGRP

Channel group

  • CLNT

Client facility for MXP/TXP cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS3I alarm

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • HDLC

High-level data link control (HDLC) frame mode.

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • REP

Resilient Ethernet Protocol

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<NTFCNCDE>

Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<OCRDAT>

(Optional) Date when the specific event or violation occurred, MM-DD.

<OCRTM>

(Optional) Time when the specific event or violation occurred, HH-MM-SS.

<DESC>

(Optional) A condition description. DESC is a string.

21.15 RTRV-ALMTH-<MOD2>

( Cisco ONS 15454) The Retrieve Alarm Threshold for 10GFC, 10GIGE, 40GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 5GIB, 8GFC, CLNT, D1VIDEO, DS1, DV6000, DVBASI , E1, E3, E4, EC1, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OC768, OCH, OMS, OTS, OTU3, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (RTRV-ALMTH-<MOD2>) command retrieves the alarm threshold values. The only applicable MOD2 values are OC3, OC12, OC48, OC192, OCH, OMS, and OTS.

 
Usage Guidelines

None

Category

Fault

Security

Retrieve

Input Format

RTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<CONDTYPE>][,,::];

Input Example

RTRV-ALMTH-{MOD2}::CHAN-2-2:1::OPT-HIGH;

Input Parameters

<AID>

Access identifier from the “ALL” section.

<CONDTYPE>

Alarm threshold. A null value is equivalent to ALL. The parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.

  • ADD-HDEG

ADD Power - High Degrade

  • ADD-HFAIL

ADD Power - High Failure

  • ADD-LDEG

ADD Power - Low Degrade

  • ADD-LFAIL

ADD Power - Low Failure

  • BATV-LOW

Battery Voltage—Low

  • GAIN-HDEG

Gain not reached—High Degrade Threshold

  • GAIN-HFAIL

Gain not reached—High Failure Threshold

  • GAIN-LDEG

Gain not reached—Low Degrade Threshold

  • GAIN-LFAIL

Gain not reached—Low Failure Threshold

  • LBCL-HIGH

Laser Bias Current in microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent).

  • OPR-HIGH

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPR-LOW

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-HIGH

Transmit power in one tenth of a microwatt. Measured value (–40.0 dBm, +30.0 dBm).

  • OPT-LOW

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPWR-HDEG

Optical Power—High Degrade Threshold

  • OPWR-HFAIL

Optical Power—High Failure Threshold

  • OPWR-LDEG

Optical Power—Low Degrade Threshold

  • OPWR-LFAIL

Optical Power—Low Failure Threshold

  • VOA-HDEG

VOA Attenuation—High Degrade Threshold

  • VOA-HFAIL

VOA Attenuation—High Failure Threshold

  • VOA-LDEG

VOA Attenuation—Low Degrade Threshold

  • VOA-LFAIL

VOA Attenuation—Low Failure Threshold

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>,<MOD>:<CONDTYPE>,,,<THLEVEL>”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“CHAN-2-2,OCH:OPT-HIGH,,,20”
;

Output Parameters

<AID>

Access identifier from the “ALL” section.

<MOD>

AID type. The parameter type is MOD2, which is the line/path modifier.

  • 10GFC

10-Gigabit Fibre Channel payload

  • 10GFICON

10-Gigabit fiber connectivity payload

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 1GISC3

1-Gigabit ISC3 compatible

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 2GISC3

2-Gigabit ISC3 compatible

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • D1VIDEO

D1 video

  • DS1

DS1 line of a DS3XM card

  • DS3I

DS3I line

  • DV6000

DV6000

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • EC1

EC1 facility

  • ESCON

ESCON

  • ETRCLO

ETR_CLO

  • FSTE

FSTE facility

  • G1000

G1000 facility

  • GFPOS

GFP over POS. Virtual ports partitioned using GFP’s multiplexing capability.

  • GIGE

Gigabit Ethernet

  • HDTV

HDTV

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • OC3

OC-3 facility

  • OC12

OC-12 facility

  • OC48

OC-48 facility

  • OC192

OC-192 facility

  • OC768

OC-768 facility

  • OCH

Optical Channel

  • OCHCC

OCH client connection

  • OCHNC

OCH network connection

  • OCHTERM

OCH termination

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port

  • STS1

STS1 path

  • STS3C

STS3c path

  • STS6C

STS6c path

  • STS9C

STS9c path

  • STS18C

STS18c path

  • STS12C

STS12c path

  • STS24C

STS24c path

  • STS36C

STS36c path

  • STS48C

STS48c path

  • STS192C

STS192c path

  • T1

T1/DS1 facility/line

  • T3

T1/DS1 facility/line

  • VT1

VT1 path

  • VT2

VT2 path

<CONDTYPE>

Condition type for an alarm or a reported event. The parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.

  • BATV-EHIGH

Battery Voltage—Extremely High

  • BATV-ELOW

Battery Voltage—Extremely Low

  • BATV-HIGH

Battery Voltage—High

  • BATV-LOW

Battery Voltage—Low

  • GAIN-HDEG

Gain not reached—High Degrade Threshold

  • GAIN-HFAIL

Gain not reached—High Failure Threshold

  • GAIN-LDEG

Gain not reached—Low Degrade Threshold

  • GAIN-LFAIL

Gain not reached—Low Failure Threshold

  • LBCL-HIGH

Laser Bias Current in microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent).

  • OPR-HIGH

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPR-LOW

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-HIGH

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-LOW

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPWR-HDEG

Optical Power—High Degrade Threshold

  • OPWR-HFAIL

Optical Power—High Failure Threshold

  • OPWR-LDEG

Optical Power—Low Degrade Threshold

  • OPWR-LFAIL

Optical Power—Low Failure Threshold

  • VOA-HDEG

VOA Attenuation—High Degrade Threshold

  • VOA-HFAIL

VOA Attenuation—High Failure Threshold

  • VOA-LDEG

VOA Attenuation—Low Degrade Threshold

  • VOA-LFAIL

VOA Attenuation—Low Failure Threshold

<THLEVEL>

Threshold level. THLEVEL is a float.

21.16 RTRV-ALMTH-EQPT

(Cisco ONS 15454 and ONS 15600) The Retrieve Alarm Threshold Equipment (RTRV-ALMTH-EQPT) command retrieves the alarm thresholds for the power level monitoring on an NE.

 
Usage Guidelines

None

Category

Equipment

Security

Retrieve

Input Format

RTRV-ALMTH-EQPT:[<TID>]:[<AID>]:<CTAG>::[<CONDTYPE>][,,::];

Input Example

RTRV-ALMTH-EQPT:::1::BATV-HIGH;

RTRV-ALMTH-EQPT::SHELF-2:1::BATV-HIGH;

Input Parameters

<AID>

The node or shelf access identifier from the “SHELF” section. If omitted it addresses the node or first shelf of the node.

<CONDTYPE>

Must not be null. The parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.

  • BATV-EHIGH

Battery Voltage—Extremely High

  • BATV-ELOW

Battery Voltage—Extremely Low

  • BATV-HIGH

Battery Voltage—High

  • BATV-LOW

Battery Voltage—Low

  • GAIN-HDEG

Gain not reached—High Degrade Threshold

  • GAIN-HFAIL

Gain not reached—High Failure Threshold

  • GAIN-LDEG

Gain not reached—Low Degrade Threshold

  • GAIN-LFAIL

Gain not reached—Low Failure Threshold

  • LBCL-HIGH

Laser Bias Current in microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold Measured value (0.0 percent, 100.0 percent)

  • OPR-HIGH

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPR-LOW

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-HIGH

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-LOW

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPWR-HDEG

Optical Power—High Degrade Threshold

  • OPWR-HFAIL

Optical Power—High Failure Threshold

  • OPWR-LDEG

Optical Power—Low Degrade Threshold

  • OPWR-LFAIL

Optical Power—Low Failure Threshold

  • VOA-HDEG

VOA Attenuation—High Degrade Threshold

  • VOA-HFAIL

VOA Attenuation—High Failure Threshold

  • VOA-LDEG

VOA Attenuation—Low Degrade Threshold

  • VOA-LFAIL

VOA Attenuation—Low Failure Threshold

Output Format

SID DATE TIME
M CTAG COMPLD
“[<AID>],<MOD2B>:<CONDTYPE>,,,<DNFIELD>”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“SHELF-1,EQPT:BATV-HIGH,,,-52.0,”
;

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“,EQPT:BATV-HIGH,,,-52.0,"”
;

Output Parameters

<AID>

The node or shelf access identifier from the “SHELF” section. If omitted, it addresses the node or the first shelf of the node.

<MOD2B>

Alarm type. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • BITS

BITS alarm

  • CLNT

Client facility for MXP/TXP cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS3I alarm

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • POS

POS port alarm

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<CONDTYPE>

Parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, 4MD-xx.x, 32MUX-O, 32DMX-O, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x cards.

  • BATV-EHIGH

Battery Voltage—Extremely High

  • BATV-ELOW

Battery Voltage—Extremely Low

  • BATV-HIGH

Battery Voltage—High

  • BATV-LOW

Battery Voltage—Low

  • GAIN-HDEG

Gain not reached—High Degrade Threshold

  • GAIN-HFAIL

Gain not reached—High Failure Threshold

  • GAIN-LDEG

Gain not reached—Low Degrade Threshold

  • GAIN-LFAIL

Gain not reached—Low Failure Threshold

  • LBCL-HIGH

Laser Bias Current in microA as one tenth of a percent. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent).

  • OPR-HIGH

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPR-LOW

Receive power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-HIGH

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPT-LOW

Transmit power in one tenth of a microwatt. Measured value (–0.0 dBm, +30.0 dBm).

  • OPWR-HDEG

Optical Power—High Degrade Threshold

  • OPWR-HFAIL

Optical Power—High Failure Threshold

  • OPWR-LDEG

Optical Power—Low Degrade Threshold

  • OPWR-LFAIL

Optical Power—Low Failure Threshold

  • VOA-HDEG

VOA Attenuation—High Degrade Threshold

  • VOA-HFAIL

VOA Attenuation—High Failure Threshold

  • VOA-LDEG

VOA Attenuation—Low Degrade Threshold

  • VOA-LFAIL

VOA Attenuation—Low Failure Threshold

<DNFIELD>

DNFIELD is a float.

21.17 RTRV-ALS

(Cisco ONS 15454) The Retrieve Automatic Laser Shutoff (RTRV-ALS) command retrieves the ALS attributes of an OC-N facility and all the facilities that support the ALS feature. This command is used to retrieve the ALS parameter of the OC48 and OC192 ports on the MXP_2.5G_10E, TXP_MR_10E, TXP_MR_2.5G, TXPP_MR_2.5G, MXP_2.5G_10G, and TXP_MR_10G cards.

 
Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

RTRV-ALS:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-ALS:PENNGROVE:FAC-1-1:1

Input Parameters

<AID>

Access identifier from the “AidUnionId” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>,<AIDTYPE>::[ALSMODE=<ALSMODE>],[ALSRCINT=<ALSRCINT>],
[ALSRCPW=<ALSRCPW>],[LSRSTAT=<LSRSTAT>],[OSRI=<OSRI>]”

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“FAC-6-1,OC192::ALSMODE=DISABLED,ALSRCINT=100,ALSRCPW=2.0,LSRSTAT=ON:”
;

Output Parameters

<AID>

Access identifier from the “AidUnionId” section.

<AIDTYPE>

Type of access identifier.The parameter type is MOD2, which is the line/path modifier.

  • 10GFC

10-Gigabit Fibre Channel payload

  • 10GFICON

10-Gigabit fiber connectivity payload

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 1GISC3

1-Gigabit ISC3 compatible

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 2GISC3

2-Gigabit ISC3 compatible

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • D1VIDEO

D1 video

  • DS1

DS1 line of a DS3XM card

  • DS3I

DS3I line

  • DV6000

DV6000

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • EC1

EC1 facility

  • ESCON

ESCON

  • ETRCLO

ETR_CLO

  • FSTE

FSTE facility

  • G1000

G1000 facility

  • GFPOS

GFP over POS. Virtual ports partitioned using GFP’s multiplexing capability.

  • GIGE

Gigabit Ethernet

  • HDTV

HDTV

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2-Gigabit ISC3 Peer

  • ISC3PEER2R

1-Gigabit or 2-Gigabit ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1-Gigabit ISC1, ISC2, and ISC3 compatibility

  • OC3

OC-3 facility

  • OC12

OC-12 facility

  • OC48

OC-48 facility

  • OC192

OC-192 facility

  • OC768

OC768 facility

  • OCH

Optical Channel

  • OCHCC

OCH client connection

  • OCHNC

OCH network connection

  • OCHTERM

OCH termination

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port

  • STS1

STS1 path

  • STS3C

STS3c path

  • STS6C

STS6c path

  • STS9C

STS9c path

  • STS18C

STS18c path

  • STS12C

STS12c path

  • STS24C

STS24c path

  • STS36C

STS36c path

  • STS48C

STS48c path

  • STS192C

STS192c path

  • T1

T1/DS1 facility/line

  • T3

T1/DS1 facility/line

  • VT1

VT1 path

  • VT2

VT2 path

<ALSMODE>

ALS is enabled or disabled. The parameter type is ALS_MODE, which is the working mode for automatic laser shutdown.

  • AUTO

Automatic

  • DISABLED

Disabled

  • MAN

Manual

  • MAN-RESTART

Manual restart for test

<ALSRCINT>

(Optional) ALS interval. The range is 60 to 300 seconds. ALSRCINT is an integer.

<ALSRCPW>

(Optional) ALS recovery pulse width. The range is 2.0 to 100.00 seconds, in increments of 100 ms. ALSRCPW is a float.

<LSRSTAT>

(Optional) Status of the laser. The parameter type is LASER_STATUS (laser status).

  • APR

Laser is switched on but is working automatic power reduction.

  • OFF

Laser is switched off.

  • ON

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).

  • N

Disable an attribute.

  • Y

Enable an attribute.

21.18 RTRV-APC

(Cisco ONS 15454) The Operate Amplifier Power Control (RTRV-APC) command retrieves the APC application attributes.

 
Usage Guidelines

None

Category

DWDM

Security

Maintenance

Input Format

RTRV-APC:[<TID>]::<CTAG>;

Input Example

RTRV-APC:PENNGROVE:WDMSIDE-A:114;

Input Parameters

None that require description

Output Format

SID DATE TIME
M CTAG COMPLD
“::[APCENABLE=<APCENABLE>],[APCSTATE=<APCSTATE>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“::APCENABLE=Y,APCSTATE=WORKING”
;

Output Parameters

<WDMSIDE>

The AID is used to access the WDM side of an MSTP node.

  • WDMSIDE-{UNKNOWN,A,B,C,D,E,F,G,H}

MSTP side identifier

<APCENABLE>

(Optional) Enable or disable the APC application. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

Enable an attribute.

<APCSTATE>

(Optional) Indicates the status of the APC application. The parameter type is APC_STATE (APC status).

  • DISABLE

The APC is disabled by the user and is not working.

  • FORCED-DISABLE

The APC has been internally disabled by the node and is not working.

  • WORKING

The APC is enabled by the user and is working.

21.19 RTRV-ATTR-CONT

( Cisco ONS 15454) The Retrieve Attribute Control (RTRV-ATTR-CONT) command retrieves and sends the attributes associated with an external control. These attributes are used when an external control is operated or released. To set these attributes, use the SET-ATTR-CONT command.

 
Usage Guidelines

None

Category

Environment

Security

Retrieve

Input Format

RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>[::<CONTTYPE>];

Input Example

RTRV-ATTR-CONT:CISCO:ENV-OUT-2:123::AIRCOND;

Input Parameters

<AID>

Access identifier from the “ENV” section. Identifies the external control for which attributes are being set.

<CONTTYPE>

Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.

  • AIRCOND

Air conditioning

  • ENGINE

Engine

  • FAN

Fan

  • GEN

Generator

  • HEAT

Heat

  • LIGHT

Light

  • MISC

Miscellaneous

  • SPKLR

Sprinkler

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:[<CONTTYPE>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“ENV-OUT-2:AIRCOND”
;

Output Parameters

<AID>

Access identifier from the “ENV” section. Identifies the external control for which attributes are being set.

<CONTTYPE>

Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.

  • AIRCOND

Air conditioning

  • ENGINE

Engine

  • FAN

Fan

  • GEN

Generator

  • HEAT

Heat

  • LIGHT

Light

  • MISC

Miscellaneous

  • SPKLR

Sprinkler

21.20 RTRV-ATTR-ENV

( Cisco ONS 15454) The Retrieve Attribute Environment (RTRV-ATTR-ENV) command retrieves the attributes associated with an environmental alarm.

 
Usage Guidelines

None

Category

Environment

Security

Retrieve

Input Format

RTRV-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];

Input Example

RTRV-ATTR-ENV:CISCO:ENV-IN-1:123::MJ,OPENDR;

Input Parameters

<AID>

Access identifier from the “ENV” section.

<NTFCNCDE>

Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<ALMTYPE>

The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm type.

  • AIRCOMPR

Air compressor failure

  • AIRCOND

Air conditioning failure

  • AIRDRYR

Air dryer failure

  • BATDSCHRG

Battery discharging

  • BATTERY

Battery failure

  • CLFAN

Cooling fan failure

  • CPMAJOR

Centralized power major failure

  • CPMINOR

Centralized power minor failure

  • ENGINE

Engine failure

  • ENGOPRG

Engine operating

  • ENGTRANS

Standby engine transfer

  • EXPLGS

Explosive gas

  • FIRDETR

Fire detector failure

  • FIRE

Fire

  • FLOOD

Flood

  • FUELLEAK

Fuel leak

  • FUSE

Fuse failure

  • GASALARM

Explosive gas, toxic gas, ventilation fail, or gas monitor fail

  • HATCH

CEV hatch fail

  • GEN

Generator failure

  • HIAIR

High airflow

  • HIHUM

High humidity

  • HITEMP

High temperature

  • HIWTR

High water

  • INTRUDER

Intrusion

  • LEVELCON

Level converter

  • LVDADSL

Secondary ADSL low voltage disconnect

  • LVDBYPAS

Low voltage disconnect bypass

  • LWBATVG

Low battery voltage

  • LWFUEL

Low fuel

  • LWHUM

Low humidity

  • LWPRES

Low cable pressure

  • LWTEMP

Low temperature

  • LWWTR

Low water

  • MISC

Miscellaneous

  • OPENDR

Open door

  • POWER

Commercial power failure

  • PUMP

Pump failure

  • PWR-48

48 V power supply failure

  • PWR-139

–139 V power converter

  • PWR-190

–190 V power converter

  • PWRMJ

Power supply major

  • PWRMN

Power supply minor

  • RECT

Rectifier failure

  • RECTHI

Rectifier high voltage

  • RECTLO

Rectifier low voltage

  • RINGGENMJ

Ringing generator major

  • RINGGENMN

Ringing generator minor

  • RTACADSL

AC or AC/rectifier power fail ADSL equipment

  • RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

  • RTACPWR

AC or AC/rectifier power fail DCL equipment

  • RTACPWRENG

Commercial AC fail, site equipped with standby engine

  • RTBAYPWR

AC power loss distributed power RT bay

  • RTRVENG

Retrieve standby engine, commercial AC restored

  • SMOKE

Smoke

  • TEMP

High-low temperature

  • TOXICGAS

Toxic gas

  • TREPEATER

T-repeater shelf

  • VENTN

Ventilation system failure

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:[<NTFCNCDE>],[<ALMTYPE>],[<DESC>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“ENV-IN-1:MJ,OPENDR,\“OPEN DOOR\””
;

Output Parameters

<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.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<ALMTYPE>

(Optional) The alarm type for the environmental alarm. The parameter type is ENV_ALM, which is the environmental alarm type.

  • AIRCOMPR

Air compressor failure

  • AIRCOND

Air conditioning failure

  • AIRDRYR

Air dryer failure

  • BATDSCHRG

Battery discharging

  • BATTERY

Battery failure

  • CLFAN

Cooling fan failure

  • CPMAJOR

Centralized power major failure

  • CPMINOR

Centralized power minor failure

  • ENGINE

Engine failure

  • ENGOPRG

Engine operating

  • ENGTRANS

Standby engine transfer

  • EXPLGS

Explosive gas

  • FIRDETR

Fire detector failure

  • FIRE

Fire

  • FLOOD

Flood

  • FUELLEAK

Fuel leak

  • FUSE

Fuse failure

  • GASALARM

Explosive gas, toxic gas, ventilation fail or gas monitor fail

  • HATCH

CEV hatch fail

  • GEN

Generator failure

  • HIAIR

High airflow

  • HIHUM

High humidity

  • HITEMP

High temperature

  • HIWTR

High water

  • INTRUDER

Intrusion

  • LEVELCON

Level converter

  • LVDADSL

Secondary ADSL low voltage disconnect

  • LVDBYPAS

Low voltage disconnect bypass

  • LWBATVG

Low battery voltage

  • LWFUEL

Low fuel

  • LWHUM

Low humidity

  • LWPRES

Low cable pressure

  • LWTEMP

Low temperature

  • LWWTR

Low water

  • MISC

Miscellaneous

  • OPENDR

Open door

  • POWER

Commercial power failure

  • PUMP

Pump failure

  • PWR-48

48V power supply failure

  • PWR-139

–139 V power converter

  • PWR-190

–190 V power converter

  • PWRMJ

Power supply major

  • PWRMN

Power supply minor

  • RECT

Rectifier failure

  • RECTHI

Rectifier high voltage

  • RECTLO

Rectifier low voltage

  • RINGGENMJ

Ringing generator major

  • RINGGENMN

Ringing generator minor

  • RTACADSL

AC or AC/rectifier power fail ADSL equipment

  • RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

  • RTACPWR

AC or AC/rectifier power fail DCL equipment

  • RTACPWRENG

Commercial AC fail, site equipped with standby engine

  • RTBAYPWR

AC power loss distributed power RT bay

  • RTRVENG

Retrieve standby engine, commercial AC restored

  • SMOKE

Smoke

  • TEMP

High-low temperature

  • TOXICGAS

Toxic gas

  • TREPEATER

T-repeater shelf

  • VENTN

Ventilation system failure

<DESC>

(Optional) Alarm description. DESC is a string.

21.21 RTRV-AUDIT-LOG

( Cisco ONS 15454) The Retrieve Audit Log (RTRV-AUDIT-LOG) command retrieves the contents of the audit log stored in the NE. Audit records contain information for user operations such as login, logout, change of provisioning parameters and other changes a user might make when connected to the NE. Audit records do not store operations related to parameter retrieval.

 
Usage Guidelines

None

Category

Log

Security

Superuser

Input Format

RTRV-AUDIT-LOG:[<TID>]::<CTAG>;

Input Example

RTRV-AUDIT-LOG:::1;

Input Parameters

None that require description

Output Format

SID DATE TIME
M CTAG COMPLD
“ <ENTRYNUM>,<OCRDAT>,<OCRTM>,<TASKID>,<TXSTATUS>,<DESCRIPTION>”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“ 17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,
\17172,2004-10-05,09-52-44, TPROVMGR,COMPLD,\"DESCRIPTION\””
;

Output Parameters

<ENTRYNUM>

Entry number. ENTRYNUM is an integer.

<OCRDAT>

Date when the specific event or violation occurred, MM-DD.

<OCRTM>

Time when the specific event or violation occurred, HH-MM-SS.

<TASKID>

Task ID. TASKID is a string.

<TXSTATUS>

Parameter type is TX_STATUS, which indicates the status of the transferred file.

  • COMPLD

The file transmission is completed.

  • IP

The file transmission is in process.

  • START

The file transmission is started.

<DESCRIPTION>

Description of event. Description format varies depending on the event and can include parameters used during the event. DESCRIPTION is a string.

21.22 RTRV-BFDLPM-<MOD2>

(Cisco ONS 15454) The Retrieve BFDL Performance Monitoring (DS1, T1) command retrieves the BFDL (enhanced 24-hour ES, UAS, BES, CSS, and LOFC) performance monitoring parameters and applies to the DS3XM-12 card DS1 under BFDL mode. This command returns the current 15-minute and current 24-hour BFDL performance monitoring (PM) parameters and the 96 15-minute history requested type PM parameters.

 
Usage Guidelines

For example, the following input:

RTRV-BFDLPM-DS1::DS1-14-1-1:1:::REQTYPE=ENH-24HR-ES;

Will retrieve the following output:

DS1-14-1-1:ES,30,CURR-15MIN-INV DS1-14-1-1:UAS,40,CURR-15MIN-INV DS1-14-1-1:BES,50,CURR-15MIN-INV DS1-14-1-1:SES,60,CURR-15MIN-INV DS1-14-1-1:CSS,70,CURR-15MIN-INV DS1-14-1-1:LOFC,80,CURR-15MIN-INV DS1-14-1-1:ES,30,CURR-24HR-INV DS1-14-1-1:UAS,40,CURR-24HR-INV DS1-14-1-1:BES,50,CURR-24HR-INV DS1-14-1-1:SES,60,CURR-24HR-INV DS1-14-1-1:CSS,70,CURR-24HR-INV DS1-14-1-1:LOFC,80,CURR-24HR-INV DS1-14-1-1:ES,30,1-15MIN-INV DS1-14-1-1:ES,40,2-15MIN-INV
DS1-14-1-1:ES,50,3-15MIN-INV
DS1-14-1-1:ES,80,96-15MIN-INV

Sending this command with a REQTYPE of ENH-24HR-CSS-AND-LOFC will retrieve 96 15-minute PM parameters for both CSS and LOFC. The command is applied on the DS3XM-12 DS1 under BFDL mode, ESF frame format, C-BIT IS port with an IS VT circuit configuration.

Category

Performance

Security

Retrieve

Input Format

RTRV-BFDLPM-<MOD2>:[<TID>]:<AID>:<CTAG>:::REQTYPE=<REQTYPE>;

Input Example

RTRV-BFDLPM-DS1:TID:DS1-14-1-1:123:::REQTYPE=ENH-24HR-ES;

Input Parameters

<AID>

Access identifier from the “DS1” section.

<REQTYPE>

Indicates requested BFDL PM type. Must not be null. The parameter type is REQTYPE, which is the requested PM type.

  • ENH-24HR-BES

The enhanced 24-hour BES performance data

  • ENH-24HR-CSS-AND-LOFC

The enhanced 24-hour CSS-AND-LOFC performance data

  • ENH-24HR-ES

The enhanced 24-hour ES performance data

  • ENH-24HR-SES

The enhanced 24-hour SES performance data

  • ENH-24HR-UAS

The enhanced 24-hour UAS performance data

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:<MONTYPE>,<MONVAL>,<BUCKET>”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“DS1-14-1-1:ES,55,CURR-15MIN-INV”
;

Output Parameters

<AID>

Access identifier from the “DS1” section.

<MONTYPE>

Monitored type which includes: BES, CSS, ES, LOFC, SES, UAS. MONTYPE is a string.

<MONVAL>

The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. MONVAL is a string.

<BUCKET>

The BIN of each BFDL PM. BUCKET is a string.

21.23 RTRV-BITS

(Cisco ONS 15454) The Retrieve Building Integrated Timing Supply (RTRV-BITS) command retrieves the BITS configuration command. For BITS facility, 64 K and 6 MHz are only applicable to the ONS 15454. SSM selectable (ADMSSM) is not applicable to the ONS 15600.

 
Usage Guidelines

None

Category

Synchronization

Security

Retrieve

Input Format

RTRV-BITS:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-BITS:SONOMA:BITS-1:782;

Input Parameters

<AID>

Access identifier from the “BITS” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>::[LINECDE=<LINECDE>],[FMT=<FMT>],[LBO=<LBO>],
[SYNCMSG=<SYNCMSG>],[AISTHRSHLD=<AISTHRSHLD>],[SABIT=<SABIT>],
[IMPEDANCE=<IMPEDANCE>],[BITSFAC=<BITSFAC>],[ADMSSM=<ADMSSM>]:[<PST>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“BITS-1::LINECDE=AMI,FMT=ESF,LBO=0-133,SYNCMSG=N,AISTHRSHLD=PRS,
SABIT=BYTE-4,IMPEDANCE=120-OHM,BITSFAC=T1,ADMSSM=PRS:IS”
;

Output Parameters

<AID>

Access identifier from the “BITS” section

<LINECDE>

(Optional) Line code. The parameter type is LINE_CODE.

  • AMI

Line code value is AMI.

  • B8ZS

Line code value is B8ZS (binary eight-zero substitution).

<FMT>

(Optional) Digital signal frame format. The parameter type is FRAME_FORMAT, which is the frame format for a T1 port.

  • D4

Frame format is D4.

  • ESF

Frame format is ESF.

  • UNFRAMED

Frame format is unframed.

<LBO>

(Optional) Line buildout settings. BITS line buildout. Default value is 0 to 133. LBP is an integer. The parameter type is BITS_LineBuildOut, which is the BITS line buildout.

  • 0–133

BITS line buildout range is 0–133.

  • 134–266

BITS line buildout range is 134–266.

  • 267–399

BITS line buildout range is 267–399.

  • 400–533

BITS line buildout range is 400–533.

  • 534–655

BITS line buildout range is 534–655.

<SYNCMSG>

Indicates if the BITS facility supports synchronization status message. Default is Y. The parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.

  • N

The ring does not support the extended K1/K2/K3 protocol.

  • Y

The ring does support the extended K1/K2/K3 protocol.

<AISTHRSHLD>

(Optional) Alarm indication signal threshold. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SONET.

  • DUS

Do Not Use For Synchronization

  • PRS

Primary Reference Source, Stratum 1 Traceable

  • RES

Reserved For Network Synchronization Use

  • SMC

SONET Minimum Clock Traceable

  • ST2

Stratum 2 Traceable

  • ST3

Stratum 3 Traceable

  • ST3E

Stratum 3E Traceable

  • ST4

Stratum 4 Traceable

  • STU

Synchronized, Traceability Unknown

  • TNC

Transit Node Clock (2nd Generation Only)

<SABIT>

(Optional) When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. The parameter type is SABITS (SA BITS).

  • BYTE-4

SABIT is BYTE-4.

  • BYTE-5

SABIT is BYTE-5.

  • BYTE-6

SABIT is BYTE-6.

  • BYTE-7

SABIT is BYTE-7.

  • BYTE-8

SABIT is BYTE-8.

<IMPEDANCE>

(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

  • 120-OHM

Impedance of 120 ohms

  • 75-OHM

Impedance of 75 ohms

<BITSFAC>

(Optional) BITS facility settings. The parameter type is BITS_FAC, which is the BITS facility rate. 64 K and 6 MHz are only applicable to the ONS 15454.

  • 2 M

2 MHz rate

  • 64 K

64 K rate

  • 6 M

6 MHz rate

  • E1

E1 rate

  • T1

T1 rate

<ADMSSM>

(Optional) SSM selectable. Only applicable to BITS-IN when SSM is disabled.

Note Not applicable for the ONS 15600.

The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SONET.

  • DUS

Do Not Use For Synchronization

  • PRS

Primary Reference Source, Stratum 1 Traceable

  • RES

Reserved For Network Synchronization Use

  • SMC

SONET Minimum Clock Traceable

  • ST2

Stratum 2 Traceable

  • ST3

Stratum 3 Traceable

  • ST3E

Stratum 3E Traceable

  • ST4

Stratum 4 Traceable

  • STU

Synchronized, Traceability Unknown

  • TNC

Transit Node Clock (2nd Generation Only)

<PST>

(Optional) Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.

  • IS

In Service

  • OOS

Out of Service

21.24 RTRV-BULKROLL-<OCN_TYPE>

(Cisco ONS 15454) 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 28-1 for supported modifiers by platform.

Category

Bridge and Roll

Security

Provisioning

Input Format

RTRV-BULKROLL-<OCN_TYPE>:[<TID>]:<SRC>:<CTAG>;

Input Example

RTRV-BULKROLL-OC12:CISCO:FAC-3-1:1;

Input Parameters

<SRC>

Source AID from the “FACILITY” section.

Output Format

SID DATE TIME
M CTAG COMPLD
“<FROM>:RFROM=<RFROM>,RTO=<RTO>,[RMODE=<RMODE>],VLDSIG=<VLDSIG>”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“STS-3-1-1:RFROM=STS-3-1-1,RTO=STS-5-1-1,RMODE=AUTO,VLDSIG=Y”
;

Output Parameters

<FROM>

One of the end points. Access identifier from the “FACILITY” section for line level rolling and bulk rolling.

<RFROM>

The termination point of the existing cross-connect that is to be rolled. The AID is from the “CrossConnectId1” section (except VCM and FACILITY).

<RTO>

The termination point that will become a leg of the new cross-connection. The AID is from the “CrossConnectId1” section (except VCM and FACILITY).

<RMODE>

(Optional) The rolling mode of operation. The parameter type is RMODE, which specifies the roll mode.

  • AUTO

Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous end-point.

  • MAN

Manual. Enter the corresponding delete roll/bulkroll command to delete the previous end-point.

  • MAN

Manual

  • MAN-RESTART

Manual Restart for Test

<VLDSIG>

(Optional) The rolling mode of operation. The parameter type is ON_OFF (disable or enable an attribute).

  • N

Disable an attribute.

  • Y

Enable an attribute.

21.25 RTRV-BWP-ETH

(Cisco ONS 15454)

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

 

Table 21-1 Input Parameter Support

Parameter
Description

<AID>

This AID is used to access BWP.

  • BWP-ALL

All aid for BWP.

  • BWP-{1-10000}

Single AID for BWP. The valid identifiers ranges from 1 to 10000.

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

Table 21-2 Output Parameter Support

Parameter
Description

<AID>

This AID is used to access BWP.

  • BWP-ALL

All aid for BWP.

  • BWP-{1-10000}

Single AID for BWP. The valid identifiers ranges from 1 to 10000.

<NAME>

The BWP name. BWP name is a String.

<CIR>

Ingress committed information rate. This is a value between 0 and 100. Default value is - 100.

<CBS>

Ingress committed burst bucket size.

  • 4K

4 Kbit bucket size

  • 8K

16 Kbit bucket size

  • 16K

32 Kbit bucket size

  • 32K

64 Kbit bucket size

  • 64K

128 Kbit bucket size

  • 128K

256 Kbit bucket size

  • 256K

512 Kbit bucket size

  • 512K

1 Mbit bucket size

  • 1M

2 Mbit bucket size

  • 2M

4 Mbit bucket size

  • 4M

8 Mbit bucket size

  • 8M

16 Mbit bucket size

  • 16M

16 Kbit bucket size

<PBS>

Ingress peak burst bucket size

  • 4K

4 Kbit bucket size

  • 8K

8 Kbit bucket size

  • 16K

16 Kbit bucket size

  • 32K

32 Kbit bucket size

  • 64K

64 Kbit bucket size

  • 128K

128 Kbit bucket size

  • 256K

256 Kbit bucket size

  • 512K

512 Kbit bucket size

  • 1M

1 Mbit bucket size

  • 2M

2 Mbit bucket size

  • 4M

4 Mbit bucket size

  • 8M

8 Mbit bucket size

  • 16M

16 Mbit bucket size

<PIR>

Peak information rate. This is a value between 0 and 100. Default value is - 100.

<CFMSTATE>

Link Integrity status

  • Y

Enabled

  • N

Disabled

21.26 RTRV-CFM

(Cisco ONS 15454) The Retrieve Connectivity Fault Management (RTRV-CFM) command retrieves the Connectivity Fault Management (CFM) protocol state at the port level.

 
Usage Guidelines

  • This command is applicable only to GE_XP and 10GE_XP cards.
  • The card should be in Layer2 over DMDM mode.

Category

Port

Security

Retrieve

Input Format

RTRV-CFM:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-CFM:454-156:ETH-1-1-1:1;

Input Parameter

<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”
;

Output Parameters

<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.

  • ENABLE

Indicates the CFM is enabled on the port.

  • DISABLE

Indicates the CFM is disabled on the port.

21.27 RTRV-CHGRP

(Cisco ONS 15454) 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”
;

Output Parameters

<AID>

Access identifier from the “CHGRP” section.

<NIMODE>

Identifies the Ethernet Network Interface Mode.

  • NNI

(Default) Network-Network Interface Mode

  • UNI

User-Network Interface Mode

<LACPMODE>

LACP mode values

  • ON

Manual mode of LACP

  • ACTIVE

Active mode of LACP

  • PASSIVE

Passive mode of LACP

<HASHINGALGO>

Hashing algorithm value

  • HASHING_SA_VLAN_INCOMING_PORT

The Hashing Algorithm value is HASHING_SA_VLAN_INCOMING_PORT.

  • HASHING_DA_VLAN_INCOMING_PORT

The Hashing Algorithm is HASHING_DA_VLAN_INCOMING_PORT.

  • HASHING_SA_DA_VLAN_INCOMING_PORT

The Hashing Algorithm is HASHING_SA_DA_VLAN_INCOMING_PORT.

  • HASHING_SRC_IP_TCP_UDP

The Hashing Algorithm is HASHING_SRC_IP_TCP_UDP.

  • HASHING_DST_IP_TCP_UDP

The Hashing Algorithm is HASHING_DST_IP_TCP_UDP

  • HASHING_SRC_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

10004. Indicates jumbo size.

  • 1500

1500

  • 1548

1548

  • 9600

9600. Indicates jumbo size.

  • 64

64

  • 9700

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_MBPS

100 Megabits per second

  • 10_GBPS

10 Gigabits per second

  • 10_MBPS

10 Megabits per second

  • 1_GBPS

1 Gigabit per second

<EXPSPEED>

(Optional) Ethernet speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.

  • 100_MBPS

100 Megabits per second

  • 10_GBPS

10 Gigabits per second

  • 10_MBPS

10 Megabits per second

  • 1_GBPS

1 Gigabit per second

  • AUTO

Auto

<CIR>

Ingress committed information rate. The value ranges from 0 to 100. The default value is 100.

<CBS>

Ingress committed burst bucket size.

  • 4K

4 Kbit bucket size

  • 8K

16 Kbit bucket size

  • 16K

32 Kbit bucket size

  • 32K

64 Kbit bucket size

  • 64K

128 Kbit bucket size

  • 128K

256 Kbit bucket size

  • 256K

512 Kbit bucket size

  • 512K

1 Mbit bucket size

  • 1M

2 Mbit bucket size

  • 2M

4 Mbit bucket size

  • 4M

8 Mbit bucket size

  • 8M

16 Mbit bucket size

  • 16M

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.

  • Y

Enables the MAC learning on the interface.

  • N

Disables the MAC learning on the interface.

<INGRESSCOS>

Identifies the COS value set in the S-VLAN tag.

  • 0 to 7

Set a Cos value

  • TRUST

Use the Customer COS

  • VLAN

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.

  • Y

Enables the BPDU tag.

  • N

Disables the BPDU tag.

<QNQMODE>

This is used to represent the QinQ mode operations.

  • Selective

The S-VLAN tag is added only on specified CE-VLANs. The other packets are dropped.

  • Transparent

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.

21.28 RTRV-CMD-SECU

(Cisco ONS 15454) 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

<AID>

Access identifier string. Identifies the entity in the NE to which the command pertains. It is the command verb along with verb modifier(s), as it currently exists. It can be a single command or a block of commands, where the block might include all commands. Only INIT-REG will be supported. String.

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>:<CAP>”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“INIT-REG:PROV”
;

Output Parameters

<AID>

(Optional) Access identifier. It can be a single command or a block of commands, where the block can include all commands. Only INIT-REG is supported. AID is a string.

<CAP>

Command access privilege. The parameter type is PRIVILEGE, which is the security level.

  • PROV

Provisioning security level

  • SUPER

Superuser security level

21.29 RTRV-COND-<MOD2ALM>

( Cisco ONS 15454) The Retrieve Condition for 10GFC, 10GIGE, 40GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, 5GIB, 8GFC, CHGRP, DS1, DS3I, DVBASI, E1, E100, E1000, E3, E4, EC1, ETH, FSTE, G1000, HDLC, ETH, GFPOS, GIGE, ILK, ISCCOMPAT, ISC1, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, MSISC, OC12, OC192, OC3, OC48, OC768, OCH, OMS, OTS, OTU2, OTU3, POS, RPRIF, STM1, STM4, STM16, STM64, STM1E, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC11, VC12, VC3, VC4, VC4-2c,VC4-3c, VC4-4c, VC4-8c, VC4-16c, VC4-64c, VCG, VT1, VT2, WLEN, or RPRIF
(RTRV-COND-<MOD2ALM>) command retrieves the current standing condition and state associated with an entity.

 
Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Category

Fault

Security

Retrieve

Input Format

RTRV-COND-<MOD2ALM>:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];

Input Example

RTRV-COND-RPRIF:DXT:RPRIF-2-0:229::FORCE-REQ;

Input Parameters

<AID>

Access identifier from the “ALL” section.

<TYPEREQ>

The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<LOCN>

Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],<LOCN>,<DIRECTION>,[<DESC>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“RPRIF-2-0,T3:MJ,FORCE-REQ,SA,01-01,16-00-20,NEND,RCV,\"FORCED SWITCH REQUEST\""
;

Output Parameters

<AID>

Access identifier from the “ALL” section.

<AIDTYPE>

(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2ALM, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 1GISC3

1-Gigabit ISC3 compatible

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • CLNT

Client facility for MXP/TXP cards

  • CHGRP

Channel group

  • DS1

DS1 alarm

  • DS3I

DS3I alarm

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GFPOS

Generic framing protocol over packet over SONET virtual port alarm

  • GIGE

Gigabit Ethernet port alarm

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1-Gigabit ISC3 Peer

  • ISC3PEER2G

2 Gbps ISC3 Peer

  • ISC3PEER2R

1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1 Gbps ISC1, ISC2, and ISC3 compatibility

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OCHTERM

OCH termination

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • UDCDCC

UDC-DCC alarm

  • UDCF

UCD-F alarm

  • VCG

Virtual concatenation group alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

  • WLEN

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.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<TYPEREP>

The condition itself. The parameter type is CONDITION, which is any problem detected on an ONS 15454 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

(Optional) The effect on service caused by the standing alarm or condition The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<DESC>

(Optional) Condition description. DESC is a string.

21.30 RTRV-COND-ALL

( Cisco ONS 15454) The Retrieve Condition All (RTRV-CON-ALL) command retrieves the current standing condition for all entities .

 
Usage Guidelines

According to Telcordia GR-833, the RTRV-COND-ALL command only reports EQPT, COM, and rr (T1, T3, OCn, EC1, STSn, VT1, DS1, E100, E1000, G1000, ML-Series, TXP and MXP) alarms.

This command does not return all conditions that are returned by other, more specific RTRV-COND commands; RTRV-COND-ALL returns a subset of these conditions. Telcordia GR-253-CORE, Section 6.2.1.8.4 states a retrieval that returns ALL conditions from a node (RTRV-COND-ALL) must omit any conditions that are “same root cause” as other raised conditions. The section also states any retrieval of a subset of the conditions from a node, regardless of how the subsetting occurs, should not omit these “same root cause” conditions.

RTRV-COND-STS1, for example, includes “same root cause” conditions in the set it returns and RTRV-COND-ALL does not.

To retrieve all the NE conditions, issue all of the following commands:

RTRV-COND-ALL
RTRV-COND-ENV
RTRV-COND-BITS
RTRV-COND-SYNCN

Category

Fault

Security

Retrieve

Input Format

RTRV-COND-ALL:[<TID>]:[<AID>]:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];

Input Example

RTRV-COND-ALL:DXT:ALL:229::FORCE-REQ;

Input Parameters

<AID>

Access identifier from the “ALL” section. String. A null value is equivalent to ALL.

<TYPEREQ>

The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<LOCN>

Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

Output Format

SID DATE TIME
M CTAG COMPLD
“<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],<LOCN>,<DIRECTION>,[<DESC>]”
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
“RPRIF-2-0,T3:MJ,FORCE-REQ,SA,01-01,16-00-20,NEND,RCV,\"FORCED SWITCH REQUEST\""
;

Output Parameters

<AID>

Access identifier from the “ALL” section that has an alarm condition.

<AIDTYPE>

(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40-GiGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • BITS

BITS alarm

  • CHGRP

Channel group

  • CLNT

Client facility for MXP/TXP cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS3I alarm

  • DVBASI

Digital Video Broadband Asynchronous Serial Interface (DVBASI) payload

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • HDLC

High-level data link control (HDLC) frame mode.

  • ISC1

InterSystem Channel, a protocol defined by IBM (ISC1) payload

  • ISC3PEER1G

1 Gbps ISC3 Peer

  • ISC3PEER2G

2 Gbps ISC3 Peer

  • ISC3PEER2R

1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1 Gbps ISC1, ISC2, and ISC3 compatibility

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • REP

Resilient Ethernet Protocol

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<NTFCNCDE>

(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<TYPEREP>

The type of condition to be retrieved. The parameter type is CONDITION, which is any problem detected on an ONS 15454 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

(Optional) The effect on service caused by the standing alarm or condition The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<DESC>

(Optional) Condition description. DESC is a string.

21.31 RTRV-COND-BITS

( Cisco ONS 15454) The Retrieve Condition Building Integrated Timing Supply (RTRV-COND-BITS) command retrieves the standing conditions on BITS.

 
Usage Guidelines

None

Category

Synchronization

Security

Retrieve

Input Format

RTRV-COND-BITS:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>],[<LOCN>],[<DIRN>];

Input Example

RTRV-COND-BITS:TID:BITS-1:229::LOS;

Input Parameters

<AID>

Access identifier from the “BITS” section.

<TYPEREQ>

The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454 or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<LOCN>

Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

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\””
;

Output Parameters

<AID>

Access identifier from the “BITS” section that has an alarm condition.

<AIDTYPE>

(Optional) Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.

  • 1GFC

1-Gigabit Fibre Channel payload

  • 1GFICON

1-Gigabit fiber connectivity payload

  • 2GFC

2-Gigabit Fibre Channel payload

  • 2GFICON

2-Gigabit fiber connectivity payload

  • 4GFC

4-Gigabit Fibre Channel payload

  • 4GFICON

4-Gigabit fiber connectivity payload

  • 40GIGE

40-Gigabit Ethernet

  • 5GIB

5Gbps InfiniBand (IB_5G) payload

  • 8GFC

8-Gigabit Fibre Channel payload

  • BITS

BITS alarm

  • CHGRP

Channel group

  • CLNT

Client facility for MXP/TXP cards

  • COM

Common alarm

  • DS1

DS1 alarm

  • DS3I

DS2I alarm

  • E100

E100 alarm

  • E1000

E1000 alarm

  • EC1

EC1 alarm

  • ENV

ENV alarm

  • EQPT

EQPT alarm

  • FSTE

Fast Ethernet Port alarm

  • G1000

G1000 alarm

  • GIGE

Gigabit Ethernet port alarm

  • HDLC

High-level data link control (HDLC) frame mode.

  • ISC3PEER1G

1 Gbps ISC3 Peer

  • ISC3PEER2G

2 Gbps ISC3 Peer

  • ISC3PEER2R

1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode

  • ISCCOMPAT

1 Gbps ISC1, ISC2, and ISC3 compatibility

  • MSISC

MSISC

  • OC3

OC3 alarm

  • OC12

OC12 alarm

  • OC48

OC48 alarm

  • OC192

OC192 alarm

  • OC768

OC768 alarm

  • OCH

Optical channel

  • OMS

Optical Multiplex Section

  • OTS

Optical Transport Section

  • OTU3

Optical Transport Unit Level 3

  • POS

POS port alarm

  • REP

Resilient Ethernet Protocol

  • STS1

STS1 alarm

  • STS3C

STS3c alarm

  • STS6C

STS6c alarm

  • STS9C

STS9c alarm

  • STS18C

STS18c alarm

  • STS12C

STS12c alarm

  • STS24C

STS24c alarm

  • STS36C

STS36c alarm

  • STS48C

STS48c alarm

  • STS192C

STS192c alarm

  • SYNCN

SYNCN alarm

  • T1

T1 alarm

  • T3

T3 alarm

  • TCC

TCC alarm

  • VT1

VT1 alarm

  • VT2

VT2 alarm

<NTFCNCDE>

(Optional) Two-letter notification code. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<TYPEREP>

The type of condition to be retrieved. The parameter type is CONDITION, which is any problem detected on an ONS 15454 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Chapter 27, “Conditions” for a list of conditions.

<SRVEFF>

(Optional) The effect on service caused by the standing alarm or condition. The parameter type is SERV_EFF, which is the effect of the alarm on service.

  • NSA

The condition is non-service affecting.

  • SA

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.

  • FEND

Action occurs on the far end of the facility.

  • NEND

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.

  • BTH

Both transmit and receive directions

  • RCV

Receive direction only

<DESC>

(Optional) Condition description. DESC is a string.

21.32 RTRV-COND-ENV

( Cisco ONS 15454) The Retrieve Environmental Condition (RTRV-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;

Input Parameters

<AID>

Access identifier from the “ENV” section.

Note For RTRV-ALM-ENV, only ENV-IN-{1-4} is a valid AID for ONS 15454. ENV-OUT-{1,6} is not a valid AID for RTRV-ALM-ENV.

<NTFCNCDE>

Two-letter notification code. A null value is equivalent to ALL. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.

  • CL

The condition causing the alarm has cleared.

  • CR

A critical alarm.

  • MJ

A major alarm.

  • MN

A minor alarm.

  • NA

The condition is not alarmed.

  • NR

The alarm is not reported.

<ALMTYPE>

The alarm type for the environmental alarm. A null value is equivalent to ALL. The parameter type is ENV_ALM, which is the environmental alarm type.

  • AIRCOMPR

Air compressor failure

  • AIRCOND

Air conditioning failure

  • AIRDRYR

Air dryer failure

  • BATDSCHRG

Battery discharging

  • BATTERY

Battery failure

  • CLFAN

Cooling fan failure

  • CPMAJOR

Centralized power major failure

  • CPMINOR

Centralized power minor failure

  • ENGINE

Engine failure

  • ENGOPRG

Engine operating

  • ENGTRANS

Standby engine transfer

  • EXPLGS

Explosive gas

  • FIRDETR

Fire detector failure

  • FIRE

Fire

  • FLOOD

Flood

  • FUELLEAK

Fuel leak

  • FUSE

Fuse failure

  • GASALARM

Explosive gas, toxic gas, ventilation fail, or gas monitor fail

  • HATCH

CEV hatch fail

  • GEN

Generator failure

  • HIAIR

High airflow

  • HIHUM

High humidity

  • HITEMP

High temperature

  • HIWTR

High water

  • INTRUDER

Intrusion

  • LEVELCON

Level converter

  • LVDADSL

Secondary ADSL low voltage disconnect

  • LVDBYPAS

Low voltage disconnect bypass

  • LWBATVG

Low battery voltage

  • LWFUEL

Low fuel

  • LWHUM

Low humidity

  • LWPRES

Low cable pressure

  • LWTEMP

Low temperature

  • LWWTR

Low water

  • MISC

Miscellaneous

  • OPENDR

Open door

  • POWER

Commercial power failure

  • PUMP

Pump failure

  • PWR-48

48 V power supply failure

  • PWR-139

–139 V power converter

  • PWR-190

–190 V power converter

  • PWRMJ

Power supply major

  • PWRMN

Power supply minor

  • RECT

Rectifier failure

  • RECTHI

Rectifier high voltage

  • RECTLO

Rectifier low voltage

  • RINGGENMJ

Ringing generator major

  • RINGGENMN

Ringing generator minor

  • RTACADSL

AC or AC/rectifier power fail ADSL equipment

  • RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

  • RTACPWR

AC or AC/rectifier power fail DCL equipment

  • RTACPWRENG

Commercial AC fail, site equipped with standby engine