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.

(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

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

(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

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

Output Parameters

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

•1GFC

1-Gigabit Fibre Channel payload

•1GFICON

1-Gigabit fiber connectivity payload

•2GFC

2-Gigabit Fibre Channel payload

•2GFICON

2-Gigabit fiber connectivity payload

•D1VIDEO

D1Video payload

•DV6000

DV6000 payload

•ETRCLO

ETR_CLO payload

•GIGE

Gigabit Ethernet payload

•HDTV

High definition television (HDTV) payload

•ISC1

ISC1 payload

•ISC3

ISC3 payload

•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

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

Output Parameters

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

Usage Guidelines

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.

Output Parameters

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

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

(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

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

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.

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.

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.

Input Example

Input Parameters

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.

Output Parameters

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

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

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

<INCTRC>

(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to STS-level paths in SONET (STSn). Defaults to null when a path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. INCTRC is a string.

<TRCMODE>

(Optional) Path trace mode. Applicable only to STS-level paths in SONET (STSn). Defaults to OFF when a path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. The parameter type is TRCMODE (trace mode).

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

(Optional) Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N. Not applicable to the ONS 15310-CL.

<TAPTYPE>

(Optional) TAP type. Not applicable to the ONS 15310-CL. The parameter type is TAPTYPE, which is the test access point type

•DUAL

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.

Input Example

Input Parameters

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, ONS 15310-CL, ONS 15310-MA, 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.

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, ONS 15310-CL, ONS 15310-MA, 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.

21.10 RTRV-ALM-ALL

(Cisco ONS 15454, 15327, 15600, 15310) 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:

Input Format

Input Example

Input Parameters

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, ONS 15310-CL, ONS 15310-MA, 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.

Output Parameters

(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

•BITS

Building integrated timing supply (BITS) alarm

•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

•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

•OC3

OC3 alarm

•OC12

OC12 alarm

•OC48

OC48 alarm

•OC192

OC192 alarm

•OCH

Optical channel

•OMS

Optical Multiplex Section

•OTS

Optical Transport Section

•POS

Packet over SONET (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

<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, ONS 15310-CL, ONS 15310-MA, 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, 15327, 15600, 15310) 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.

Input Example

Input Parameters

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, ONS 15310-CL, ONS 15310-MA 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.

Output Example

Output Parameters

(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

•BITS

BITS alarm

•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

•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

<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, ONS 15310-CL, ONS 15310-MA, 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.

Output Example

Output Parameters

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, ONS 15310-CL, 15310-MA 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, 15327, 15600, 15310) 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.

Input Example

Input Parameters

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, ONS 15310-CL, ONS 15310-MA 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.

Output Example

Output Parameters

(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

•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

<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, ONS 15310-CL, ONS 15310-MA 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, 15327, 15600, 15310) 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.

Input Example

Input Parameters

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, ONS 15310-CL, ONS 15310-MA 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.

Output Example

Output Parameters

(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

•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

<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, ONS 15310-CL, ONS 15310-MA 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.

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, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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.

Output Parameters

(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, 15327, 15600, 15310) 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.

•AUDIBLE

ONS 15310-MA only

•AIRCOND

Air conditioning

•ENGINE

Engine

•FAN

Fan

•GEN

Generator

•HEAT

Heat

•LIGHT

Light

•MISC

Miscellaneous

•SPKLR

Sprinkler

Output Format

SID DATE TIMEM CTAG COMPLD "<AID>:[<CONTTYPE>]";

Output Example

TID-000 1998-06-20 14:30:00M 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.

Output Example

Output Parameters

(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, 15327, 15600, 15310) 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.

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.

21.25 RTRV-CMD-SECU

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 TIMEM CTAG COMPLD "<AID>:<CAP>";

Output Example

TID-000 1998-06-20 14:30:00M 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.

Input Example

Input Parameters

The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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.

Output Example

Output Parameters

(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

•CLNT

Client facility for MXP/TXP cards

•DS1

DS1 alarm

•DS3I

DS3I alarm

•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

•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

•OC3

OC3 alarm

•OC12

OC12 alarm

•OC48

OC48 alarm

•OC192

OC192 alarm

•OCH

Optical channel

•OCHTERM

OCH termination

•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

•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, ONS 15310-CL, ONS 15310-MA, 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>

(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.27 RTRV-COND-ALL

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

Usage Guidelines

This command does not return all conditions that are returned by other, more specific RTRV-COND commands; RTRV-COND-ALL returns a subset of these conditions. Telcordia GR-253-CORE, Section 6.2.1.8.4 states 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-ALLRTRV-COND-ENVRTRV-COND-BITSRTRV-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, ONS 15310-CL, ONS 15310-MA 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.

Output Parameters

(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

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

•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

<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, ONS 15310-CL, ONS 15310-MA, 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>

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

Input Format

Input Example

Input Parameters

The type of condition to be retrieved. A null value is equivalent to ALL. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA 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.