Cisco ONS SONET TL1 Command Guide, Release 6.0
Chapter 21, RTRV Commands
Downloads: This chapterpdf (PDF - 3.52MB) The complete bookPDF (PDF - 11.52MB) | Feedback

RTRV Commands

Table Of Contents

RTRV Commands

21.1  RTRV-<MOD1FCPAYLOAD>

21.2  RTRV-<MOD1FICONPAYLOAD>

21.3  RTRV-<MOD2DWDMPAYLOAD>

21.4  RTRV-<MOD_RING>

21.5  RTRV-<OCN_TYPE>

21.6  RTRV-<PATH>

21.7  RTRV-10GIGE

21.8  RTRV-ALM-<MOD2ALM>

21.9  RTRV-ALM-ALL

21.10  RTRV-ALM-BITS

21.11  RTRV-ALM-ENV

21.12  RTRV-ALM-EQPT

21.13  RTRV-ALM-SYNCN

21.14  RTRV-ALMTH-<MOD2>

21.15  RTRV-ALMTH-EQPT

21.16  RTRV-ALS

21.17  RTRV-APC

21.18  RTRV-ATTR-CONT

21.19  RTRV-ATTR-ENV

21.20  RTRV-AUDIT-LOG

21.21  RTRV-BFDLPM-<MOD2>

21.22  RTRV-BITS

21.23  RTRV-BULKROLL<OCN_TYPE>

21.24  RTRV-CMD-SECU

21.25  RTRV-COND-<MOD2ALM>

21.26  RTRV-COND-ALL

21.27  RTRV-COND-BITS

21.28  RTRV-COND-ENV

21.29  RTRV-COND-EQPT

21.30  RTRV-COND-SYNCN

21.31  RTRV-CONSOLE-PORT

21.32  RTRV-CRS

21.33  RTRV-CRS-<PATH>

21.34  RTRV-DFLT-SECU

21.35  RTRV-DS1

21.36  RTRV-EC1

21.37  RTRV-EQPT

21.38  RTRV-ESCON

21.39  RTRV-EXT-CONT

21.40  RTRV-FAC

21.41  RTRV-FFP

21.42  RTRV-FFP-<MOD2DWDMPAYLOAD>

21.43  RTRV-FFP-<OCN_TYPE>

21.44  RTRV-FFP-OCH

21.45  RTRV-FSTE

21.46  RTRV-G1000

21.47  RTRV-GFP

21.48  RTRV-GIGE

21.49  RTRV-HDLC

21.50  RTRV-HDR

21.51  RTRV-INV

21.52  RTRV-LNK

21.53  RTRV-LNK-<MOD2O>

21.54  RTRV-LNKTERM

21.55  RTRV-LOG

21.56  RTRV-MAP-NETWORK

21.57  RTRV-NE-APC

21.58  RTRV-NE-GEN

21.59  RTRV-NE-IPMAP

21.60  RTRV-NE-PATH

21.61  RTRV-NE-SYNCN

21.62  RTRV-NE-WDMANS

21.63  RTRV-NETYPE

21.64  RTRV-OCH

21.65  RTRV-OMS

21.66  RTRV-OPM

21.67  RTRV-OSC

21.68  RTRV-OTS

21.69  RTRV-PM-<MOD2>

21.70  RTRV-PMMODE-<STS_PATH>

21.71  RTRV-PMSCHED-<MOD2>

21.72  RTRV-PMSCHED-ALL

21.73  RTRV-POS

21.74  RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

21.75  RTRV-PROTNSW-<OCN_TYPE>

21.76  RTRV-PROTNSW-<PATH>

21.77  RTRV-PROTNSW-OCH

21.78  RTRV-PROTOCOL

21.79  RTRV-PTHTRC-<PATH>

21.80  RTRV-RMONTH-<MOD2_RMON>

21.81  RTRV-ROLL-<MOD_PATH>

21.82  RTRV-ROUTE

21.83  RTRV-ROUTE-GRE

21.84  RTRV-SLV-WDMANS

21.85  RTRV-STS

21.86  RTRV-SYNCN

21.87  RTRV-T1

21.88  RTRV-T3

21.89  RTRV-TACC

21.90  RTRV-TADRMAP

21.91  RTRV-TH-<MOD2>

21.92  RTRV-TH-ALL

21.93  RTRV-TOD

21.94  RTRV-TRAPTABLE

21.95  RTRV-TRC-<OCN_BLSR>

21.96  RTRV-TRC-OCH

21.97  RTRV-TUNNEL-FIREWALL

21.98  RTRV-TUNNEL-PROXY

21.99  RTRV-USER-SECU

21.100  RTRV-VCG

21.101  RTRV-VT

21.102  RTRV-WDMANS

21.103  RTRV-WLEN


RTRV Commands



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


This chapter provides RTRV (retrieve) commands for the Cisco ONS 15454, ONS 15327, ONS 15600 and ONS 15310-CL.

21.1  RTRV-<MOD1FCPAYLOAD>

Retrieve (1GFC, 2GFC)

Usage Guidelines

Cisco ONS 15454

This command retrieves the attributes related with the Fibre Channel port.

See Table 27-1 on page 27-1 for supported modifiers by platform.

Category

Ports

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

RLS-LPBK-<MOD2>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RLS-PROTNSW-<OCN_TYPE>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALMTH-<MOD2>

RTRV-ALS

RTRV-DS1

RTRV-EC1

RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-PROTNSW-<OCN_TYPE>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-1 RTRV-<MOD1FCPAYLOAD> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28. Must not be null


Output Format

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

Output Example

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

Output Parameters

Table 21-2 RTRV-<MOD1FCPAYLOAD> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28

ROLE

The port role in Y-cable protection (WORK or PROT). Optional

Parameter type is SIDE—the role the unit is playing in the protection group

PROT

The entity is a protection unit in the protection group

WORK

The entity is a working unit in the protection group

STATUS

A port status in Y-cable protection (ACT or STBY). Optional

Parameter type is STATUS—the status of the unit in the protection pair

ACT

The entity is the active unit in the shelf

NA

Status is unavailable

STBY

The entity is the standby unit in the shelf

LINKRATE

The actual rate running on the fibre channel port. It can differ from the payload type provisioned

Parameter type is LINKRATE—the link rate on a fibre channel port

1GFC

The rate is 1 G fibre channel

1GFICON

The rate is 1 G FICON

2GFC

The rate is 2 G fibre channel

2GFICON

The rate is 2 G FICON

UNKNOWN

The rate is unknown

UNPLUGGED

The SFP is not plugged into the fibre channel port so the link rate cannot be detected

LINKSTATE

Link state

Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter

DN

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

UP

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

LINKRCVRY

Link recovery

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

DISTEXTN

Distance extension. Optional

Parameter type is DISTANCE_EXTENSION—distance extension

B2B

Buffer to buffer flow control

NONE

No distance extension

LINKCREDITS

Number of link credits. Integer. Optional

MFS

Maximum frame size. Integer. Optional

ENCAP

Frame encapsulation type. Optional

Parameter type is ENCAP—frame encapsulation type

GFP_F

GFP frame mode

GFP_T

GFP transparent mode

HDLC

HDLC frame mode

HDLC_LEX

HDLC LAN extension frame mode

HDLC_X86

HDLC X.86 frame mode

NAME

Identifies the port name. String. Optional

SOAK

OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional

SOAKLEFT

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

1530.33

Wavelength 1

1531.12

Wavelength 2

1531.90

Wavelength 3

1532.68

Wavelength 4

1534.25

Wavelength 5

1535.04

Wavelength 6

1535.82

Wavelength 7

1536.61

Wavelength 8

1538.19

Wavelength 9

1538.98

Wavelength 10

1539.77

Wavelength 11

1540.56

Wavelength 12

1542.14

Wavelength 13

1542.94

Wavelength 14

1543.73

Wavelength 15

1544.53

Wavelength 16

1546.12

Wavelength 17

1546.92

Wavelength 18

1547.72

Wavelength 19

1548.51

Wavelength 20

1550.12

Wavelength 21

1550.92

Wavelength 22

1551.72

Wavelength 23

1552.52

Wavelength 24

1554.13

Wavelength 25

1554.94

Wavelength 26

1555.75

Wavelength 27

1556.55

Wavelength 28

1558.17

Wavelength 29

1558.98

Wavelength 30

1559.79

Wavelength 31

1560.61

Wavelength 32

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

Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)

IS_NR

In service - normal

OOS-AU

Out of service - autonomous

OOS-AUMA

Out of service - autonomous and management

OOS-MA

Out of service - management

SST

Secondary state of the entity. Optional

Parameter type is SST—provides additional information pertaining to PST and PSTQ

AINS

Automatic in service

DSBLD

Disabled

LPBK

Loopback

MEA

Mismatch of equipment and attributes

MT

Maintenance mode

OOG

Out of group

SWDL

Software downloading

UAS

Unassigned

UEQ

Unequipped


21.2  RTRV-<MOD1FICONPAYLOAD>

Retrieve (1GFICON, 2GFICON)

Usage Guidelines

Cisco ONS 15454

This command returns fibre channel-specific settings for ports which have been configured to carry FICON traffic using the ENT-FICON command. The MXPP_MR_2.5G card only supports the GFP-T frame type

See Table 27-1 on page 27-1 for supported modifiers by platform.

Category

Ports

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

RLS-LPBK-<MOD2>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RLS-PROTNSW-<OCN_TYPE>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALMTH-<MOD2>

RTRV-ALS

RTRV-DS1

RTRV-EC1

RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-PROTNSW-<OCN_TYPE>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-3 RTRV-<MOD1FICONPAYLOAD> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28. Must not be null


Output Format

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

Output Example

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

Output Parameters

Table 21-4 RTRV-<MOD1FICONPAYLOAD> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28

ROLE

The port role in Y-cable protection (WORK or PROT). Optional

Parameter type is SIDE—the role the unit is playing in the protection group

PROT

The entity is a protection unit in the protection group

WORK

The entity is a working unit in the protection group

STATUS

A port status in Y-cable protection (ACT or STBY). Optional

Parameter type is STATUS—the status of the unit in the protection pair

ACT

The entity is the active unit in the shelf

NA

Status is unavailable

STBY

The entity is the standby unit in the shelf

LINKRATE

The actual rate running on the fibre channel port. It can differ from the payload type provisioned

Parameter type is LINKRATE—the link rate on a fibre channel port

1GFC

The rate is 1 G fibre channel

1GFICON

The rate is 1 G FICON

2GFC

The rate is 2 G fibre channel

2GFICON

The rate is 2 G FICON

UNKNOWN

The rate is unknown

UNPLUGGED

The SFP is not plugged into the fibre channel port so the link rate cannot be detected

LINKSTATE

Link state

Parameter type is DIRN—specifies the discriminating level for the requested monitored parameter

DN

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

UP

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

LINKRCVRY

Link recovery

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

DISTEXTN

Distance extension. Optional

Parameter type is DISTANCE_EXTENSION—distance extension

B2B

Buffer to buffer flow control

NONE

No distance extension

LINKCREDITS

Number of link credits. Integer. Optional

MFS

Maximum frame size. Integer. Optional

ENCAP

Frame encapsulation type. Optional

Parameter type is ENCAP—frame encapsulation type

GFP_F

GFP frame mode

GFP_T

GFP transparent mode

HDLC

HDLC frame mode

HDLC_LEX

HDLC LAN extension frame mode

HDLC_X86

HDLC X.86 frame mode

NAME

Identifies the port name. String. Optional

SOAK

OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional

SOAKLEFT

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

1530.33

Wavelength 1

1531.12

Wavelength 2

1531.90

Wavelength 3

1532.68

Wavelength 4

1534.25

Wavelength 5

1535.04

Wavelength 6

1535.82

Wavelength 7

1536.61

Wavelength 8

1538.19

Wavelength 9

1538.98

Wavelength 10

1539.77

Wavelength 11

1540.56

Wavelength 12

1542.14

Wavelength 13

1542.94

Wavelength 14

1543.73

Wavelength 15

1544.53

Wavelength 16

1546.12

Wavelength 17

1546.92

Wavelength 18

1547.72

Wavelength 19

1548.51

Wavelength 20

1550.12

Wavelength 21

1550.92

Wavelength 22

1551.72

Wavelength 23

1552.52

Wavelength 24

1554.13

Wavelength 25

1554.94

Wavelength 26

1555.75

Wavelength 27

1556.55

Wavelength 28

1558.17

Wavelength 29

1558.98

Wavelength 30

1559.79

Wavelength 31

1560.61

Wavelength 32

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

Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)

IS_NR

In service - normal

OOS-AU

Out of service - autonomous

OOS-AUMA

Out of service - autonomous and management

OOS-MA

Out of service - management

SST

Secondary state of the entity. Optional

Parameter type is SST—provides additional information pertaining to PST and PSTQ

AINS

Automatic in service

DSBLD

Disabled

LPBK

Loopback

MEA

Mismatch of equipment and attributes

MT

Maintenance mode

OOG

Out of group

SWDL

Software downloading

UAS

Unassigned

UEQ

Unequipped


21.3  RTRV-<MOD2DWDMPAYLOAD>

Retrieve (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, PASSTHRU)

Usage Guidelines

Cisco ONS 15454

This command retrieves the configuration parameter of a DWDM client.

See Table 27-1 on page 27-1 for supported modifiers by platform.

Category

DWDM

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

RLS-LPBK-<MOD2>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RLS-PROTNSW-<OCN_TYPE>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALMTH-<MOD2>

RTRV-ALS

RTRV-DS1

RTRV-EC1

RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-PROTNSW-<OCN_TYPE>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-5 RTRV-<MOD2DWDMPAYLOAD> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28. Must not be null


Output Format

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

;

Output Example

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

Output Parameters

Table 21-6 RTRV-<MOD2DWDMPAYLOAD> Output Parameters 

Parameter and Values
Description

AIDUNIONID

Access identifier from the "25.1.2  AidUnionId" section on page 25-9

AIDTYPE

A type of access identifier

Parameter type is MOD2DWDMPAYLOAD—payload types applicable to DWDM ports

10GFC

10 gigabit fibre channel payload

10GIGE

10 gigabit Ethernet

1GFC

1 gigabit fibre channel payload

1GFICON

1 gigabit FICON payload

2GFC

2 gigabit fibre channel payload

2GFICON

2 gigabit FICON payload

D1VIDEO

D1Video payload

DV6000

DV6000 payload

ETRCLO

ETR_CLO payload

GIGE

Gigabit Ethernet payload

HDTV

HDTV payload

ISC1

ISC1 payload

ISC3

ISC3 payload

PASSTHRU

Any pass through (2R) payload

ROLE

The port role in Y-cable protection (WORK or PROT). Optional

Parameter type is SIDE—the role the unit is playing in the protection group

PROT

The entity is a protection unit in the protection group

WORK

The entity is a working unit in the protection group

STATUS

A port status in Y-cable protection (ACT or STBY). Optional

Parameter type is STATUS—the status of the unit in the protection pair

ACT

The entity is the active unit in the shelf

NA

Status is unavailable

STBY

The entity is the standby unit in the shelf

NAME

Identifies the port name. String. Optional

LBCL

Displays the current value of the laser current. Float. Optional

OPT

Displays the current value of the transmitted optical power. Float. Optional

OPR

Displays the current value of the received optical power. Float. Optional

FREQ

Optional. Parameter type is OPTICAL_WLEN—optical wavelength

1530.33

Wavelength 1

1531.12

Wavelength 2

1531.90

Wavelength 3

1532.68

Wavelength 4

1534.25

Wavelength 5

1535.04

Wavelength 6

1535.82

Wavelength 7

1536.61

Wavelength 8

1538.19

Wavelength 9

1538.98

Wavelength 10

1539.77

Wavelength 11

1540.56

Wavelength 12

1542.14

Wavelength 13

1542.94

Wavelength 14

1543.73

Wavelength 15

1544.53

Wavelength 16

1546.12

Wavelength 17

1546.92

Wavelength 18

1547.72

Wavelength 19

1548.51

Wavelength 20

1550.12

Wavelength 21

1550.92

Wavelength 22

1551.72

Wavelength 23

1552.52

Wavelength 24

1554.13

Wavelength 25

1554.94

Wavelength 26

1555.75

Wavelength 27

1556.55

Wavelength 28

1558.17

Wavelength 29

1558.98

Wavelength 30

1559.79

Wavelength 31

1560.61

Wavelength 32

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

Parameter type is PST_PSTQ—service state of the entity described by the primary state (PST) and a primary state qualifier (PSTQ)

IS_NR

In service - normal

OOS-AU

Out of service - autonomous

OOS-AUMA

Out of service - autonomous and management

OOS-MA

Out of service - management

SST

Secondary state of the entity. Optional

Parameter type is SST—provides additional information pertaining to PST and PSTQ

AINS

Automatic in service

DSBLD

Disabled

LPBK

Loopback

MEA

Mismatch of equipment and attributes

MT

Maintenance mode

OOG

Out of group

SWDL

Software downloading

UAS

Unassigned

UEQ

Unequipped


21.4  RTRV-<MOD_RING>

Retrieve Bidirectional Line Switched Ring

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600

This command retrieves the BLSR information of the NE. A two-fiber or four-fiber BLSR can be retrieved.


Note Cisco ONS 15600 and ONS 15327 do not support four-fiber BLSR.


Output examples:

4F BLSR

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

2F BLSR

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

The following actions will return error messages:

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

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

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


NoteOnly ALL, NULL, BLSR-ALL, or BLSR-RINGID is allowed for this command.

A NULL AID defaults to the AID ALL.

The list AID format is supported.


Category

BLSR

Security

Retrieve

Related Commands

DLT-<MOD_RING>

ED-<MOD_RING>

ENT-<MOD_RING>

EX-SW-<OCN_BLSR>

RTRV-TRC-<OCN_BLSR>


Input Format

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

Input Example

RTRV-BLSR:PETALUMA:ALL:123;

Input Parameters

Table 21-7 RTRV-<MOD_RING> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.3  AidUnionId1" section on page 25-12. Identifies the BLSR of the NE. Only ALL, null or a list of BLSR-# in AID are allowed. A null value is equivalent to ALL


Output Format

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

;

Output Example

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

Output Parameters

Table 21-8 RTRV-<MOD_RING> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.3  AidUnionId1" section on page 25-12. Identifies the BLSR of the NE. Optional

RINGID

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

NODEID

The BLSR node ID of the NE. NODEID ranges from 0 to 31. String. Optional

MODE

Mode with which the command is to be implemented. Identifies the BLSR mode; either two-fiber or four-fiber. Optional

Parameter type is BLSR_MODE—BLSR mode

2F

Two-fiber BLSR

4F

Four-fiber BLSR

RVRTV

Revertive mode. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

RVTM

Revertive time. RVTM is not allowed to be set while "RVRTV" is N

Parameter type is REVERTIVE_TIME—revertive time

0.5 to 12.0

Revertive time is 0.5 to 12.0 minutes

SRVRTV

The span revertive mode for four-fiber BLSR only

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

SRVTM

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

Parameter type is REVERTIVE_TIME—revertive time

0.5 to 12.0

Revertive time is 0.5 to 12.0 minutes

EASTWORK

East working facility. AID from the "25.1.14  FACILITY" section on page 25-28

WESTWORK

West working facility. AID from the "25.1.14  FACILITY" section on page 25-28

EASTPROT

East protecting facility. AID from the "25.1.14  FACILITY" section on page 25-28

WESTPROT

West protecting facility. AID from the "25.1.14  FACILITY" section on page 25-28


21.5  RTRV-<OCN_TYPE>

Retrieve (OC3, OC12, OC48, OC192)

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the attributes (for example, service parameters) and the state of an OC-N facility.

See Table 27-1 on page 27-1 for supported modifiers by platform.

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


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


UNI-C DCC provisioning notes:

1. The attributes DCC(Y/N) and mode (SONET/SDH) remain the same in the ED/RTRV-OCN commands when the DCC is used for UNI-C, in which case the port attribute UNIC is enabled (UNIC=Y).

2. UNI-C DCC termination cannot be deleted by the regular DCC de-provisioning command.

3. If the DCC is created under regular SONET provisioning, and this port is used by UNI-C, the port is converted as an UNI-C DCC automatically.

4. De-provisioning UNI-C IF/IB IPCC will free up DCC termination automatically.

5. The parameters ALSMODE, ALSRCINT, and ALSRCPW are only applicable for OC3-8, OC192 and OC48ELR cards.

6. SSMRCV will display the quality of the individual port.

7. SSM selectable (ADMSSM) and synchronization messaging for output (SYNCMSGOUT) are not applicable to the ONS 15600.

8. J0 Support (EXPTRC, TRC, TRCMODE and TRCFORMAT parameters) are supported by: DWDM cards with an OC-n payload, the MRC-12 card and the OC192-XFP card. J0 is not supported by OC3-8, OC-12, OC-48, OC-192 and other SONET optical cards.

Category

BLSR

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS

OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

REPT PM <MOD2>

RLS-PROTNSW-<OCN_TYPE>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALMTH-<MOD2>

RTRV-ALS

RTRV-DS1

RTRV-EC1RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-9 RTRV-<OCN_TYPE> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28. Must not be null


Output Format

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

Output Example

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

Output Parameters

Table 21-10 RTRV-<OCN_TYPE> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28

ROLE

An OCn port role. Optional

Parameter type is SIDE—the role the unit is playing in the protection group

PROT

The entity is a protection unit in the protection group

WORK

The entity is a working unit in the protection group

STATUS

An OCn port status. Optional

Parameter type is STATUS—the status of the unit in the protection pair

ACT

The entity is the active unit in the shelf

NA

Status is unavailable

STBY

The entity is the standby unit in the shelf

DCC

Indicates whether or not the section DCC is to be used. Optional

Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol

N

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

Y

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

AREA

Area ID. Shows up only if the DCC is enabled. String. Optional

TMGREF

The termination to be used, whether primary or secondary. Identifies if an OCn port has a timing reference. Defaults to N. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

SYNCMSG

Synchronization status message

Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol

N

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

Y

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

SENDDUS

The facility will send the DUS (Don't use for Synchronization) value in 0x0f bits pattern as the sync status message for that facility. Defaults to N. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

PJMON

Identifies an OC-N port PJMON. PJMON is an integer. It defaults to 0 (zero). 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

An OCn port signal failure threshold. Defaults to 1E-4. Optional

Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path

1E-3

SFBER is 1E-3

1E-4

SFBER is 1E-4

1E-5

SFBER is 1E-5

SDBER

An OCn port signal degrade threshold. Defaults 1E-7. Optional

Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path

1E-5

SDBER is 1E-5

1E-6

SDBER is 1E-6

1E-7

SDBER is 1E-7

1E-8

SDBER is 1E-8

1E-9

SDBER is 1E-9

MODE

OCn port mode. Defaults to SONET. Optional

Parameter type is OPTICAL_MODE—the facility's optical mode

SDH

SDH/ETSI optical mode using European/International format

SONET

SONET/ANSI optical mode using the American format

WVLEN

An OCn port wavelength in nanometers. For example, WVLEN=1310.00 means it operates at 1310 nm in the DWDM application. Float. Optional

RINGID

The BLSR RINGID with which the port is connected. RINGID ranges from 0 to 9999. Integer. Optional

BLSRTYPE

The BLSR type with which the port is connected. Optional

Parameter type is BLSR_TYPE—BLSR type of an OCn port

EASTPROT

The OCn port is an east protecting port

EASTWORK

The OCn port is an east working port

WESTPROT

The OCn port is an west protecting port

WESTWORK

The OCn port is an west working port

MUX

BLSR extension byte. Optional

Parameter type is MUX_TYPE—BLSR extension byte

E2

E2 byte (orderwire)

F1

F1 byte (user)

K3

K3 byte

Z2

Z2 byte

UNIC

Indicates if the port connects to the UCP. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

SOAK

OOS-AINS to IS transition soak time as measured in 15-minute intervals. Integer. Optional

SOAKLEFT

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

Displays the quality of the individual port. Optional

Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—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

The open shortest path first protocol. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

LDCC

The line DCC connection on the port. Optional

Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol

N

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

Y

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

NAME

Name. String. Optional

LBCL

Displays the current value of the laser current. Float. Optional

OPT

Displays the current value of the transmitted optical power. OPT is only displayed for DWDM cards. Float. Optional

OPR

Received optical power. Float. Optional

EXPTRC

Expected path trace content. String. Optional

TRC

Path trace message to be transmitted. String. Optional

TRCMODE

Path trace mode. Applicable only to STS-level Paths in SONET. Defaults to the OFF mode. Optional

Parameter type is TRCMODE—trace mode

AUTO

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

AUTO-NO-AIS

Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP is detected

MAN

Use the provisioned expected string as the expected string

MAN-NO-AIS

Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP is detected

OFF

Turn off path trace capability. Nothing will be reported

TRCFORMAT

Trace message size. Optional

Parameter type is TRCFORMAT—trace format

1-BYTE

1-byte trace message

16-BYTE

16-byte trace message

64-BYTE

64-byte trace message

Y

Enable an attribute

ADMSSM

SSM selectable value. Only displayed when SSM is disabled. Optional

Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for 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

Indicates that the facility will send the DUS (Don't use for synchronization) value in 0xff bits pattern as the sync status message for that facility. Defaults to N. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

AISONLPBK

AIS on loopback. Optional

Parameter type is AIS_ON_LPBK—Indicates if 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

1530.33

Wavelength 1

1531.12

Wavelength 2

1531.90

Wavelength 3

1532.68

Wavelength 4

1534.25

Wavelength 5

1535.04

Wavelength 6

1535.82

Wavelength 7

1536.61

Wavelength 8

1538.19

Wavelength 9

1538.98

Wavelength 10

1539.77

Wavelength 11

1540.56

Wavelength 12

1542.14

Wavelength 13

1542.94

Wavelength 14

1543.73

Wavelength 15

1544.53

Wavelength 16

1546.12

Wavelength 17

1546.92

Wavelength 18

1547.72

Wavelength 19

1548.51

Wavelength 20

1550.12

Wavelength 21

1550.92

Wavelength 22

1551.72

Wavelength 23

1552.52

Wavelength 24

1554.13

Wavelength 25

1554.94

Wavelength 26

1555.75

Wavelength 27

1556.55

Wavelength 28

1558.17

Wavelength 29

1558.98

Wavelength 30

1559.79

Wavelength 31

1560.61

Wavelength 32

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

Indicates whether the far-end NE on the DCC is a foreign NE. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

FOREIGNIPADDRESS

The IP address of the far-end NE on the DCC. Used only if FOREIGNFEND is Y. String. Optional

PST_PSTQ

Admin state in the PST_PSTQ format

Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)

IS-NR

In service - normal

OOS-AU

Out of service - autonomous

OOS-AUMA

Out of service - autonomous and management

OOS-MA

Out of service - management

SSTQ

Secondary state of the entity. Optional

Parameter type is SST—provides additional information pertaining to PST and PSTQ

AINS

Automatic in service

DSBLD

Disabled

LPBK

Loopback

MEA

Mismatch of equipment and attributes

MT

Maintenance mode

OOG

Out of group

SWDL

Software downloading

UAS

Unassigned

UEQ

Unequipped


21.6  RTRV-<PATH>

Retrieve (STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, VT2)

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the attributes associated with an STS/VT path.

See Table 27-1 on page 27-1 for supported modifiers by platform.

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

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

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 the contents of the expected incoming path trace are provisioned by the user in the ED-STS_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.

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

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

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

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

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

The following actions will result in error messages:

Sending this command while BLSRPTHTYPE=PCA, whether there is BLSR switch or not, the PCA path J1/C2 data will be returned (if there is PCA circuit on the AID).

Sending this command with an STS AID without circuits and no BLSR switched on the STS will return an error message.


NoteAn optional parameter BLSRPTHTYPE is introduced into this command to provide more options to retrieve J1/C2 of a particular BLSR path. This field is valid only if the queried AID port has BLSR. The BLSRPTHTYPE defaults to "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 the 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.

The VT1.5 J2 path trace provisioning is supported on the DS3XM-12 card and the 15454 CE-100T-8 card VT1.5 path using the ED-VT1, RTRV-VT1 and RTRV-PTHTRC-VT1 commands. The 15310-CL CE-100T-8 card supports J2 path trace.

Test access is not supported on the ONS 15310-CL. J2 is not supported on the 15310-CL-CTX card of the ONS 15310-CL, however the CE-100T-8 card supports J2 in the ONS 15310-CL.

For the selector path on a BLSR, the SWPDIP path attribute is not editable and is always in ON state.

SFBER and SDBER are applied for the ONS 15310-CL and the ONS 15454 when the ONS 15454 has an XC-VXC-10G card.


Category

Paths

Security

Retrieve

Related Commands

DLT-CRS-<PATH>

DLT-ROLL-<MOD_PATH>

ED-<MOD_PATH>

ED-CRS-<PATH>

ED-NE-PATH

ENT-CRS-<PATH>

ENT-ROLL-<MOD_PATH>

OPR-PROTNSW-<PATH>

RLS-PROTNSW-<PATH>

RTRV-CRS-<PATH>

RTRV-NE-PATH

RTRV-PROTNSW-<PATH>

RTRV-PTHTRC-<PATH>

RTRV-ROLL-<MOD_PATH>


Input Format

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

Input Example

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

Input Parameters

Table 21-11 RTRV-<PATH> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  CrossConnectId1" section on page 25-20. Must not be null

BLSRPTHTYPE

The BLSR path type only if the port is on the BLSR. Defaults to NON-PCA. Applicable only to STS-level paths in SONET. A null value defaults to NON-PCA

Parameter type is BLSR_PTH_TYPE—BLSR path type only if the port is on the BLSR

NON-PCA

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

PCA

The AID is on the BLSR PCA path


Output Format

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

Output Example

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

Output Parameters

Table 21-12 RTRV-<PATH> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  CrossConnectId1" section on page 25-20

LEVEL

The rate of the cross-connect. Indicates the rate of the cross-connected channel. Applicable only to STS path in SONET. Optional

Parameter type is PATH—modifier for path commands

STS1

Synchronous transport signal/module level-1 (51.84 Mbps)

STS3C

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

STS6C

Synchronous transport signal/module level-6 (311.04 Mbps)

STS9C

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

STS12C

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

STS18C

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

STS24C

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

STS36C

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

STS48C

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

STS192C

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

SFBER

An STS path signal failure threshold which only applies to path protection. Applicable only to STS-level paths in SONET. Defaults to 1E-4. Optional

Parameter type is SF_BER—the threshold for declaring signal failure on a facility or path

1E-3

SFBER is 1E-3

1E-4

SFBER is 1E-4

1E-5

SFBER is 1E-5

SDBER

An STS path signal degrade threshold which only applies to path protection. Applicable only to STS-level paths in SONET. Defaults 1E-6. Optional

Parameter type is SD_BER—the threshold for declaring signal degrade on a facility or path

1E-5

SDBER is 1E-5

1E-6

SDBER is 1E-6

1E-7

SDBER is 1E-7

1E-8

SDBER is 1E-8

1E-9

SDBER is 1E-9

RVRTV

Revertive mode. Only applies to path protection. The value Y indicates that the protection switching system reverts service to the original line after restoration. The value N indicates that the protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

RVTM

Revertive time. Only applies to path protection

Parameter type is REVERTIVE_TIME—revertive time

0.5 to 12.0

Revertive time is 0.5 to 12.0 minutes

SWPDIP

Switch on PDI-P. Applicable only to STS-level paths in SONET. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

HOLDOFFTIMER

Hold off timer. Integer. Optional

EXPTRC

Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). Applicable to STS-level paths in SONET. Defaults to NULL when path protection path is created. Supported on the CE-100T-8 card (ONS 15310-CL) provisioned in mapper mode. String. Optional

TRC

The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to 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. String. Optional

INCTRC

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

TRCMODE

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

Parameter type is TRCMODE—trace mode

AUTO

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

AUTO-NO-AIS

Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected

MAN

Use the provisioned expected string as the expected string

MAN-NO-AIS

Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected

OFF

Turn off path trace capability. Nothing will be reported

TRCFORMAT

Trace message size. Optional

Parameter type is TRCFORMAT—trace format

1-BYTE

1-byte trace message

16-BYTE

16-byte trace message

64-BYTE

64-byte trace message

Y

Enable an attribute

TACC

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

TAPTYPE

TAP type. Not applicable to the ONS 15310-CL. Optional

Parameter type is TAPTYPE—test access point type

DUAL

Dual FAD

SINGLE

Single FAD

UPSRPTHSTATE

Indicates whether a given AID is the working or standby path of a path protection cross-connect. Optional

Parameter type is STATUS—status of the unit in the protection pair

ACT

The entity is the active unit in the shelf

NA

Status is unavailable

STBY

The entity is the standby unit in the shelf

C2

The c2 byte hex code. Applicable only to STS-level paths in SONET (STSn). Optional

Parameter type is C2_BYTE—c2 byte hex code

0X00

Unequipped

0X01

Equipped-Non Specific payload

0X02

VT-Structured STS-1 SPE

0X03

Locked VT Mode

0X04

Asynchronous Mapping for DS3

0X12

Asynchronous Mapping for DS4NA

0X13

Mapping for ATM

0X14

Mapping for DQDB

0X15

Asynchronous Mapping for FDDI

0X16

HDLC-Over-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 AIS-L is being generated by an optical card or cross-connect downstream

BLSRPTHSTATE

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

Parameter type is BLSR_PTH_STATE—the BLSR path state only if the port is on the BLSR

PCAPTHACT

Indicates the BLSR is un-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

Admin state in the PST_PSTQ format

Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)

IS-NR

In service - normal

OOS-AU

Out of service - autonomous

OOS-AUMA

Out of service - autonomous and management

OOS-MA

Out of service - management

SSTQ

Secondary state of the entity. Optional

Parameter type is SST—provides additional information pertaining to PST and PSTQ

AINS

Automatic in service

DSBLD

Disabled

LPBK

Loopback

MEA

Mismatch of equipment and attributes

MT

Maintenance mode

OOG

Out of group

SWDL

Software downloading

UAS

Unassigned

UEQ

Unequipped


21.7  RTRV-10GIGE

Retrieve 10GIGE

Usage Guidelines

Cisco ONS 15454

This command retrieves the 10 Gbps-specific parameters for a port that has been configured to support the gigabyte Ethernet payload with the ENT-10GIGE command.

Category

Ports

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS

OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

REPT PM <MOD2>

RLS-PROTNSW-<OCN_TYPE>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<MOD_RING>

RTRV-<OCN_TYPE>

RTRV-ALMTH-<MOD2>

RTRV-ALS

RTRV-DS1

RTRV-EC1RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-13 RTRV-10GIGE Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28. Must not be null


Output Format

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

Output Example

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

Output Parameters

Table 21-14 RTRV-10GIGE Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.14  FACILITY" section on page 25-28

ROLE

The port role in Y-cable protection (WORK or PROT). Optional

Parameter type is SIDE—the role the unit is playing in the protection group

PROT

The entity is a protection unit in the protection group

WORK

The entity is a working unit in the protection group

STATUS

A port status in Y-cable protection (ACT or STBY). Optional

Parameter type is STATUS—the status of the unit in the protection pair

ACT

The entity is the active unit in the shelf

NA

Status is unavailable

STBY

The entity is the standby unit in the shelf

NAME

Port name. String. Optional

MACADDR

The MAC address for the 10 gigabyte Ethernet payload. String. Optional

LBCL

Displays the current value of the laser current. Float. Optional

OPT

Displays the current value of the transmitted optical power. Float. Optional

OPR

Displays the current value of the received optical power. Float. Optional

FREQ

Optional. Parameter type is OPTICAL_WLEN—optical wavelength

1530.33

Wavelength 1

1531.12

Wavelength 2

1531.90

Wavelength 3

1532.68

Wavelength 4

1534.25

Wavelength 5

1535.04

Wavelength 6

1535.82

Wavelength 7

1536.61

Wavelength 8

1538.19

Wavelength 9

1538.98

Wavelength 10

1539.77

Wavelength 11

1540.56

Wavelength 12

1542.14

Wavelength 13

1542.94

Wavelength 14

1543.73

Wavelength 15

1544.53

Wavelength 16

1546.12

Wavelength 17

1546.92

Wavelength 18

1547.72

Wavelength 19

1548.51

Wavelength 20

1550.12

Wavelength 21

1550.92

Wavelength 22

1551.72

Wavelength 23

1552.52

Wavelength 24

1554.13

Wavelength 25

1554.94

Wavelength 26

1555.75

Wavelength 27

1556.55

Wavelength 28

1558.17

Wavelength 29

1558.98

Wavelength 30

1559.79

Wavelength 31

1560.61

Wavelength 32

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

Admin state in the PST_PSTQ format

Parameter type is PST_PSTQ—service state of the entity described by the primary state (SST) and a primary state qualifier (PSTQ)

IS-NR

In service - normal

OOS-AU

Out of service - autonomous

OOS-AUMA

Out of service - autonomous and management

OOS-MA

Out of service - management

SSTQ

Secondary state of the entity. Optional

Parameter type is SST—provides additional information pertaining to PST and PSTQ

AINS

Automatic in service

DSBLD

Disabled

LPBK

Loopback

MEA

Mismatch of equipment and attributes

MT

Maintenance mode

OOG

Out of group

SWDL

Software downloading

UAS

Unassigned

UEQ

Unequipped


21.8  RTRV-ALM-<MOD2ALM>

Retrieve Alarm (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS1, E100, E1000, E3, E4, EC1, FSTE, G1000, GFPOS, GIGE, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC12, VC3, VCG, VT1, VT2, WLEN)

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves and sends the current status of alarm conditions. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.

See Table 27-1 on page 27-1 for supported modifiers by platform.


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



Note The [<AIDTYPE>] shows STS1 for STS alarms.


Category

Fault

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-15 RTRV-ALM-<MOD2ALM> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.2  AidUnionId" section on page 25-9. Must not be null

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

 

Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL

NSA

The condition is non-service affecting

SA

The condition is service affecting


Output Format

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

;

Output Example

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

Output Parameters

Table 21-16 RTRV-ALM-<MOD2ALM> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1

AIDTYPE

Type of access identifier. Optional

Parameter type is MOD2ALM—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

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

T1

T1 alarm

T3

T3 alarm

UDCDCC

UDCDCC alarm

UDCF

UCDF alarm

VCG

Virtual Concatenation Group alarm

VT1

VT1 alarm

VT2

VT2 alarm

WLEN

Wavelength Path Provisioning

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional


21.9  RTRV-ALM-ALL

Retrieve Alarm All

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves and sends the current status of all active alarm conditions. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.

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

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

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

Category

Fault

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-17 RTRV-ALM-ALL Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1. A null value is equivalent to ALL. String

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDITION

The type of alarm condition. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL

NSA

The condition is non-service affecting

SA

The condition is service affecting


Output Format

SID DATE TIME
M CTAG COMPLD
"[<AID>],[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>],[<AIDDET>]"

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2,EQPT:MN,PWRRESTART,NSA,,,,:\"POWER FAIL RESTART\",DS1-14"
;

Output Parameters

Table 21-18 RTRV-ALM-ALL Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1. Optional

AIDTYPE

Type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

DESC

A condition description. String. Optional

AIDDET

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


21.10  RTRV-ALM-BITS

Retrieve Alarm Building Integrated Timing Supply

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves and sends the current status of alarm conditions associated with the BITS facility. The alarm condition or severity retrieved is specified using the input parameters as a filter.

Category

Synchronization

Security

Retrieve

Related Commands

CLR-COND-SECU

ED-BITS

ED-NE-SYNCN

ED-SYNCN

OPR-SYNCNSW

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RLS-SYNCNSW

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-BITS

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN

RTRV-NE-SYNCN

RTRV-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-19 RTRV-ALM-BITS Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.5  BITS" section on page 25-13. Must not be null

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

The condition type for an alarm or reported event. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL

NSA

The condition is non-service affecting

SA

The condition is service affecting


Output Format

SID DATE TIME
M CTAG COMPLD
"<AID>,[<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,,,,:[<DESC>]"

;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,,,,:\"LOSS OF SIGNAL\","
;

Output Parameters

Table 21-20 RTRV-ALM-BITS Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.5  BITS" section on page 25-13. Optional

AIDTYPE

Type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

DESC

A condition description. String. Optional


21.11  RTRV-ALM-ENV

Retrieve Alarm Environment

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the environmental alarms.

Category

Environment

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-21 RTRV-ALM-ENV Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26. Must not be null

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

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

ALMTYPE

The alarm type for the environmental alarm. A null value is equivalent to ALL

Parameter type is ENV_ALM—environmental alarm types

AIRCOMPR

Air compressor failure

AIRCOND

Air conditioning failure

AIRDRYR

Air dryer failure

BATDSCHRG

Battery discharging

BATTERY

Battery failure

CLFAN

Cooling fan failure

CPMAJOR

Centralized power major failure

CPMINOR

Centralized power minor failure

ENGINE

Engine failure

ENGOPRG

Engine operating

ENGTRANS

Standby engine transfer

EXPLGS

Explosive gas

FIRDETR

Fire detector failure

FIRE

Fire

FLOOD

Flood

FUELLEAK

Fuel leak

FUSE

Fuse failure

GASALARM

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

HATCH

CEV hatch fail

GEN

Generator failure

HIAIR

High 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

48V power supply failure

PWR-139

-139V power converter

PWR-190

-190V power converter

PWRMJ

Power supply major

PWRMN

Power supply minor

RECT

Rectifier failure

RECTHI

Rectifier high voltage

RECTLO

Rectifier low voltage

RINGGENMJ

Ringing generator major

RINGGENMN

Ringing generator minor

RTACADSL

AC or AC/rectifier power fail ADSL equipment

RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

RTACPWR

AC or AC/rectifier power fail DCL equipment

RTACPWRENG

Commercial AC fail, site equipped with standby engine

RTBAYPWR

AC power loss distributed power RT bay

RTRVENG

Retrieve standby engine, commercial AC restored

SMOKE

Smoke

TEMP

High-low temperature

TOXICGAS

Toxic gas

TREPEATER

T-repeater shelf

VENTN

Ventilation system failure


Output Format

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

;

Output Example

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

Output Parameters

Table 21-22 RTRV-ALM-ENV Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

ALMTYPE

The alarm type for the environmental alarm. A null value is equivalent to ALL

Parameter type is ENV_ALM—environmental alarm types

AIRCOMPR

Air compressor failure

AIRCOND

Air conditioning failure

AIRDRYR

Air dryer failure

BATDSCHRG

Battery discharging

BATTERY

Battery failure

CLFAN

Cooling fan failure

CPMAJOR

Centralized power major failure

CPMINOR

Centralized power minor failure

ENGINE

Engine failure

ENGOPRG

Engine operating

ENGTRANS

Standby engine transfer

EXPLGS

Explosive gas

FIRDETR

Fire detector failure

FIRE

Fire

FLOOD

Flood

FUELLEAK

Fuel leak

FUSE

Fuse failure

GASALARM

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

HATCH

CEV hatch fail

GEN

Generator failure

HIAIR

High 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

48V power supply failure

PWR-139

-139V power converter

PWR-190

-190V power converter

PWRMJ

Power supply major

PWRMN

Power supply minor

RECT

Rectifier failure

RECTHI

Rectifier high voltage

RECTLO

Rectifier low voltage

RINGGENMJ

Ringing generator major

RINGGENMN

Ringing generator minor

RTACADSL

AC or AC/rectifier power fail ADSL equipment

RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

RTACPWR

AC or AC/rectifier power fail DCL equipment

RTACPWRENG

Commercial AC fail, site equipped with standby engine

RTBAYPWR

AC power loss distributed power RT bay

RTRVENG

Retrieve standby engine, commercial AC restored

SMOKE

Smoke

TEMP

High-low temperature

TOXICGAS

Toxic gas

TREPEATER

T-repeater shelf

VENTN

Ventilation system failure

OCRDAT

Date. Optional

OCRTM

Time. Optional

DESC

A condition description. String. Optional


21.12  RTRV-ALM-EQPT

Retrieve Alarm Equipment

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves and sends the current status of alarm conditions associated with the equipment units. The alarm condition or severity to be retrieved is specified using the input parameters as a filter.

Category

Equipment

Security

Retrieve

Related Commands

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

CLR-COND-SECU

DLT-EQPT

ED-EQPT

ENT-EQPT

INH-SWDX-EQPT

INH-SWTOPROTN-EQPT

INH-SWTOWKG-EQPT

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-SYNCN

RTRV-ALMTH-EQPT

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN

RTRV-EQPT

SET-ALMTH-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT


Input Format

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

Input Example

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

Input Parameters

Table 21-23 RTRV-ALM-EQPT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.13  EQPT" section on page 25-27. Must not be null

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

The condition type for an alarm or a reported event. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL

NSA

The condition is non-service affecting

SA

The condition is service affecting


Output Format

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

;

Output Example

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

Output Parameters

Table 21-24 RTRV-ALM-EQPT Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.13  EQPT" section on page 25-27. Optional

AIDTYPE

Type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date. Optional

OCRTM

Time. Optional

DESC

A condition description. String. Optional


21.13  RTRV-ALM-SYNCN

Retrieve Alarm Synchronization

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves and sends the current status of alarm conditions associated with a synchronization facility. The alarm condition or severity to be retrieved can be specified by using the input parameters as a filter.

Category

Synchronization

Security

Retrieve

Related Commands

CLR-COND-SECU

ED-BITS

ED-NE-SYNCN

ED-SYNCN

OPR-SYNCNSW

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RLS-SYNCNSW

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-BITS

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN

RTRV-NE-SYNCN

RTRV-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-25 RTRV-ALM-SYNCN Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.25  SYNC_REF" section on page 25-40. Must not be null

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

The condition type for an alarm or a reported event. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service. A null value is equivalent to ALL

NSA

The condition is non-service affecting

SA

The condition is service affecting


Output Format

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

;

Output Example

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

Output Parameters

Table 21-26 RTRV-ALM-SYNCN Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.23  SYN" section on page 25-39

AIDTYPE

Type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

CONDTYPE

Condition type for an alarm or a reported event

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date. Optional

OCRTM

Time. Optional

DESC

A condition description. String. Optional


21.14  RTRV-ALMTH-<MOD2>

Retrieve Alarm Threshold (10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, VT2)

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15310-CL

This command retrieves the alarm threshold values. The only applicable MOD2 values are OC3, OC12, OC48, OC192, OCH, OMS, and OTS.

Category

DWDM

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS

OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

REPT PM <MOD2>

RLS-LPBK-<MOD2>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RLS-PROTNSW-<OCN_TYPE>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALS

RTRV-DS1

RTRV-EC1

RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-PROTNSW-<OCN_TYPE>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-27 RTRV-ALMTH-<MOD2> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1. Must not be null

CONDTYPE

Alarm threshold. A null value is equivalent to ALL

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

BATV-EHIGH

Battery Voltage - Extremely High

BATV-ELOW

Battery Voltage - Extremely Low

BATV-HIGH

Battery Voltage - High

BATV-LOW

Battery Voltage - Low

GAIN-HDEG

Gain not reached—High Degrade Threshold

GAIN-HFAIL

Gain not reached—High Failure Threshold

GAIN-LDEG

Gain not reached—Low Degrade Threshold

GAIN-LFAIL

Gain not reached—Low Failure Threshold

LBCL-HIGH

Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]

OPR-HIGH

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]

OPR-LOW

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm

OPT-HIGH

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPT-LOW

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPWR-HDEG

Optical Power—High Degrade Threshold

OPWR-HFAIL

Optical Power—High Failure Threshold

OPWR-LDEG

Optical Power—Low Degrade Threshold

OPWR-LFAIL

Optical Power—Low Failure Threshold

VOA-HDEG

VOA Attenuation—High Degrade Threshold

VOA-HFAIL

VOA Attenuation—High Failure Threshold

VOA-LDEG

VOA Attenuation—Low Degrade Threshold

VOA-LFAIL

VOA Attenuation—Low Failure Threshold


Output Format

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

;

Output Example

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

Output Parameters

Table 21-28 RTRV-ALMTH-<MOD2> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1

MOD

AID type

Parameter type is MOD2—line/path modifier

10GFC

10 Gigabit fibre channel

10GIGE

10 Gigabit Ethernet

1GFC

1 Gigabit fibre channel

1GFICON

1 Gigabit FICON

2GFC

2 Gigabit fibre channel

2GFICON

2 Gigabit FICON

D1VIDEO

D1 Video

DS1

DS1 line of a DS3XM card

DS3I

DS3I line

DV6000

DV6000

EC1

EC1 facility

ESCON

ESCON

ETRCLO

ETR_CLO

FSTE

FSTE facility

G1000

G1000 facility

GFPOS

Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability

GIGE

GIG Ethernet

HDTV

HDTV

ISC1

ISC1

OC3

OC3 facility

OC12

OC12 facility

OC48

OC48 facility

OC192

OC192 facility

OCH

Optical channel

OMS

Optical Multiplex Section

OTS

Optical Transport Section

POS

POS port

STS1

STS1 path

STS3C

STS3C path

STS6C

STS6C path

STS9C

STS9C path

STS18C

STS18C path

STS12C

STS12C path

STS24C

STS24C path

STS36C

STS36C path

STS48C

STS48C path

STS192C

STS192C path

T1

T1/DS1 facility/line

T3

T1/DS1 facility/line

VT1

VT1 Path

VT2

VT2 Path

CONDTYPE

Condition type for an alarm or a reported event

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

BATV-EHIGH

Battery Voltage - Extremely High

BATV-ELOW

Battery Voltage - Extremely Low

BATV-HIGH

Battery Voltage - High

BATV-LOW

Battery Voltage - Low

GAIN-HDEG

Gain not reached—High Degrade Threshold

GAIN-HFAIL

Gain not reached—High Failure Threshold

GAIN-LDEG

Gain not reached—Low Degrade Threshold

GAIN-LFAIL

Gain not reached—Low Failure Threshold

LBCL-HIGH

Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]

OPR-HIGH

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]

OPR-LOW

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm

OPT-HIGH

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPT-LOW

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPWR-HDEG

Optical Power—High Degrade Threshold

OPWR-HFAIL

Optical Power—High Failure Threshold

OPWR-LDEG

Optical Power—Low Degrade Threshold

OPWR-LFAIL

Optical Power—Low Failure Threshold

VOA-HDEG

VOA Attenuation—High Degrade Threshold

VOA-HFAIL

VOA Attenuation—High Failure Threshold

VOA-LDEG

VOA Attenuation—Low Degrade Threshold

VOA-LFAIL

VOA Attenuation—Low Failure Threshold

THLEVEL

Threshold level. Float


21.15  RTRV-ALMTH-EQPT

Retrieve Alarm Threshold Equipment

Usage Guidelines

Cisco ONS 15454

This command retrieves the alarm thresholds for the power level monitoring on an NE.

Category

Equipment

Security

Retrieve

Related Commands

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

DLT-EQPT

ED-EQPT

ENT-EQPT

INH-SWDX-EQPT

INH-SWTOPROTN-EQPT

INH-SWTOWKG-EQPT

REPT ALM EQPT

REPT EVT EQPT

RTRV-ALM-EQPT

RTRV-COND-EQPT

RTRV-EQPT

SET-ALMTH-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT


Input Format

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

Input Example

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

Input Parameters

Table 21-29 RTRV-ALMTH-EQPT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.7  CHANNEL" section on page 25-14

CONDTYPE

Must not be null

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

BATV-EHIGH

Battery Voltage - Extremely High

BATV-ELOW

Battery Voltage - Extremely Low

BATV-HIGH

Battery Voltage - High

BATV-LOW

Battery Voltage - Low

GAIN-HDEG

Gain not reached—High Degrade Threshold

GAIN-HFAIL

Gain not reached—High Failure Threshold

GAIN-LDEG

Gain not reached—Low Degrade Threshold

GAIN-LFAIL

Gain not reached—Low Failure Threshold

LBCL-HIGH

Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]

OPR-HIGH

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]

OPR-LOW

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm

OPT-HIGH

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPT-LOW

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPWR-HDEG

Optical Power—High Degrade Threshold

OPWR-HFAIL

Optical Power—High Failure Threshold

OPWR-LDEG

Optical Power—Low Degrade Threshold

OPWR-LFAIL

Optical Power—Low Failure Threshold

VOA-HDEG

VOA Attenuation—High Degrade Threshold

VOA-HFAIL

VOA Attenuation—High Failure Threshold

VOA-LDEG

VOA Attenuation—Low Degrade Threshold

VOA-LFAIL

VOA Attenuation—Low Failure Threshold


Output Format

SID DATE TIME
M CTAG COMPLD
",<MOD2B>:<CONDTYPE>,,,<DNFIELD>"

;

Output Example

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

Output Parameters

Table 21-30 RTRV-ALMTH-EQPT Output Parameters 

Parameter and Values
Description

MOD2B

Alarm type

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

CONDTYPE

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

BATV-EHIGH

Battery Voltage - Extremely High

BATV-ELOW

Battery Voltage - Extremely Low

BATV-HIGH

Battery Voltage - High

BATV-LOW

Battery Voltage - Low

GAIN-HDEG

Gain not reached—High Degrade Threshold

GAIN-HFAIL

Gain not reached—High Failure Threshold

GAIN-LDEG

Gain not reached—Low Degrade Threshold

GAIN-LFAIL

Gain not reached—Low Failure Threshold

LBCL-HIGH

Laser Bias current in uA as 1/10% High Warning Threshold, Low Warning Threshold Measured value [0.0%, 100.0%]

OPR-HIGH

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm]

OPR-LOW

Receive power in 1/10 uW Measured value [-40.0 dBm,+30.0 dBm

OPT-HIGH

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPT-LOW

Transmit power in 1/10 uW. Measured value [-40.0 dBm,+30.0 dBm]

OPWR-HDEG

Optical Power—High Degrade Threshold

OPWR-HFAIL

Optical Power—High Failure Threshold

OPWR-LDEG

Optical Power—Low Degrade Threshold

OPWR-LFAIL

Optical Power—Low Failure Threshold

VOA-HDEG

VOA Attenuation—High Degrade Threshold

VOA-HFAIL

VOA Attenuation—High Failure Threshold

VOA-LDEG

VOA Attenuation—Low Degrade Threshold

VOA-LFAIL

VOA Attenuation—Low Failure Threshold

DNFIELD

Float


21.16  RTRV-ALS

Retrieve Automatic Laser Shutoff

Usage Guidelines

Cisco ONS 15454, 15310-CL

This 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

Category

Ports

Security

Retrieve

Related Commands

DLT-<MOD1PAYLOAD>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-DS1

ED-EC1

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ED-TRC-<MOD2DWDMPAYLOAD>

ED-TRC-<OCN_TYPE>

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS

OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

REPT PM <MOD2>

RLS-LPBK-<MOD2>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RLS-PROTNSW-<OCN_TYPE>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALMTH-<MOD2>

RTRV-DS1

RTRV-EC1

RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMMODE-<STS_PATH>

RTRV-PMSCHED-<MOD2>

RTRV-PMSCHED-ALL

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-PROTNSW-<OCN_TYPE>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

RTRV-TRC-<MOD2DWDMPAYLOAD>

RTRV-TRC-<OCN_TYPE>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Related Commands

Table 21-31 RTRV-ALS Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.2  AidUnionId" section on page 25-9. Must not be null


Output Format

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

;

Output Example

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

Output Parameters

Table 21-32 RTRV-ALS Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.2  AidUnionId" section on page 25-9

AIDTYPE

Type of access identifier

Parameter type is MOD2—line/path modifier

10GFC

10 Gigabit fibre channel

10GIGE

10 Gigabit Ethernet

1GFC

1 Gigabit fibre channel

1GFICON

1 Gigabit FICON

2GFC

2 Gigabit fibre channel

2GFICON

2 Gigabit FICON

D1VIDEO

D1 Video

DS1

DS1 line of a DS3XM card

DS3I

DS3I line

DV6000

DV6000

EC1

EC1 facility

ESCON

ESCON

ETRCLO

ETR_CLO

FSTE

FSTE facility

G1000

G1000 facility

GFPOS

Generic Framing Protocol over Packet Over SONET. Virtual Ports partitioned using GFP's Multiplexing Capability

GIGE

GIG Ethernet

HDTV

HDTV

ISC1

ISC1

OC3

OC3 facility

OC12

OC12 facility

OC48

OC48 facility

OC192

OC192 facility

OCH

Optical channel

OMS

Optical Multiplex Section

OTS

Optical Transport Section

POS

POS port

STS1

STS1 path

STS3C

STS3C path

STS6C

STS6C path

STS9C

STS9C path

STS18C

STS18C path

STS12C

STS12C path

STS24C

STS24C path

STS36C

STS36C path

STS48C

STS48C path

STS192C

STS192C path

T1

T1/DS1 facility/line

T3

T1/DS1 facility/line

VT1

VT1 Path

VT2

VT2 Path

ALSMODE

ALS is enabled or disabled

Parameter type is ALS_MODE—the working mode for automatic laser shutdown

AUTO

Automatic

DISABLED

Disabled

MAN

Manual

MAN-RESTART

Manual restart for test

ALSRCINT

ALS recovery interval. The range is 60 to 300 seconds. Integer. Optional

ALSRCPW

ALS recovery pulse width. The range is 2.0 to 100.00 seconds, in increments of 100 ms. Float. Optional

LSRSTAT

Status of the laser. Optional

Parameter type is LASER_STATUS—laser status

APR

Laser is switched on but is working automatic power reduction

OFF

Laser is switched off

ON

Laser is switched on


21.17  RTRV-APC

Operate Amplification Power Control

Usage Guidelines

Cisco ONS 15454

This command retrieves the APC application attributes.

Category

DWDM

Security

Maintenance

Related Commands

DLT-LNK-<MOD2O>

DLT-LNKTERM

DLT-OSC

DLT-WLEN

ED-DWDM

ED-FFP-OCH

ED-LNK-<MOD2O>

ED-LNKTERM

ED-OCH

ED-OMS

ED-OSC

ED-OTS

ED-TRC-OCH

ED-WDMANS

ED-WLEN

ENT-LNK-<MOD2O>

ENT-LNKTERM

ENT-OSC

ENT-WLEN

OPR-LASER-OTS

OPR-PROTNSW-OCH

OPR-WDMANS

RLS-LASER-OTS

RLS-PROTNSW-OCH

RTRV-FFP-OCH

RTRV-LNK-<MOD2O>

RTRV-LNKTERM

RTRV-NE-WDMANS

RTRV-OCH

RTRV-OMS

RTRV-OSC

RTRV-OTS

RTRV-PROTNSW-OCH

RTRV-TRC-OCH

RTRV-WDMANS

RTRV-WLEN


Input Format

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

Input Example

RTRV-APC:PENNGROVE::114;

Input Parameters

Table 21-33 RTRV-APC Input Parameters 

Parameter and Values
Description

 

Output Format

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

Output Example

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

Output Parameters

Table 21-34 RTRV-APC Output Parameters 

Parameter and Values
Description

APCENABLE

The enable/disable of the APC application. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute

APCSTATE

Indicates the status of the APC application. Optional

Parameter type is APC_STATE—APC status

DISABLE

The APC is disabled by the user and is not working

FORCED-DISABLE

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

WORKING

The APC is enabled by the user and is working


21.18  RTRV-ATTR-CONT

Retrieve Attribute Control

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves and sends the attributes associated with an external control. These attributes are used when an external control is operated or released. To set these attributes, use the SET-ATTR-CONT command.

Category

Environment

Security

Retrieve

Related Commands

OPR-ACO-ALL

OPR-EXT-CONT

REPT ALM ENV

REPT EVT ENV

RLS-EXT-CONT

RTRV-ALM-ENV

RTRV-ATTR-ENV

RTRV-COND-ENV

RTRV-EXT-CONT

SET-ATTR-CONT

SET-ATTR-ENV

SET-ATTR-SECUDFLT


Input Format

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

Input Example

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

Input Parameters

Table 21-35 RTRV-ATTR-CONT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26. Identifies the external control for which attributes are being set. Must not be null

CONTTYPE

Environmental control type. A null value is equivalent to ALL

Parameter type is CONTTYPE—Environmental control types

AIRCOND

Air conditioning

ENGINE

Engine

FAN

Fan

GEN

Generator

HEAT

Heat

LIGHT

Light

MISC

Miscellaneous

SPKLR

Sprinkler


Output Format

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

Output Example

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

Output Parameters

Table 21-36 RTRV-ATTR-CONT Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26. Identifies the external control for which attributes are being set. Must not be null

CONTTYPE

Environmental control type. A null value is equivalent to ALL

Parameter type is CONTTYPE—Environmental control types

AIRCOND

Air conditioning

ENGINE

Engine

FAN

Fan

GEN

Generator

HEAT

Heat

LIGHT

Light

MISC

Miscellaneous

SPKLR

Sprinkler


21.19  RTRV-ATTR-ENV

Retrieve Attribute Environment

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the attributes associated with an environmental alarm.

Category

Environment

Security

Retrieve

Related Commands

OPR-ACO-ALL

OPR-EXT-CONT

REPT ALM ENV

REPT EVT ENV

RLS-EXT-CONT

RTRV-ALM-ENV

RTRV-ATTR-CONT

RTRV-COND-ENV

RTRV-EXT-CONT

SET-ATTR-CONT

SET-ATTR-ENV

SET-ATTR-SECUDFLT


Input Format

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

Input Example

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

Input Parameters

Table 21-37 RTRV-ATTR-ENV Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26. Must not be null

NTFCNCDE

Two-letter notification code

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

ALMTYPE

The alarm type for the environmental alarm. A null value is equivalent to ALL

Parameter type is ENV_ALM—environmental alarm types

AIRCOMPR

Air compressor failure

AIRCOND

Air conditioning failure

AIRDRYR

Air dryer failure

BATDSCHRG

Battery discharging

BATTERY

Battery failure

CLFAN

Cooling fan failure

CPMAJOR

Centralized power major failure

CPMINOR

Centralized power minor failure

ENGINE

Engine failure

ENGOPRG

Engine operating

ENGTRANS

Standby engine transfer

EXPLGS

Explosive gas

FIRDETR

Fire detector failure

FIRE

Fire

FLOOD

Flood

FUELLEAK

Fuel leak

FUSE

Fuse failure

GASALARM

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

HATCH

CEV hatch fail

GEN

Generator failure

HIAIR

High 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

-139V power converter

PWR-190

-190V power converter

PWRMJ

Power supply major

PWRMN

Power supply minor

RECT

Rectifier failure

RECTHI

Rectifier high voltage

RECTLO

Rectifier low voltage

RINGGENMJ

Ringing generator major

RINGGENMN

Ringing generator minor

RTACADSL

AC or AC/rectifier power fail ADSL equipment

RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

RTACPWR

AC or AC/rectifier power fail DCL equipment

RTACPWRENG

Commercial AC fail, site equipped with standby engine

RTBAYPWR

AC power loss distributed power RT bay

RTRVENG

Retrieve standby engine, commercial AC restored

SMOKE

Smoke

TEMP

High-low temperature

TOXICGAS

Toxic gas

TREPEATER

T-repeater shelf

VENTN

Ventilation system failure


Output Format

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

Output Example

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

Output Parameters

Table 21-38 RTRV-ATTR-ENV Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26. Must not be null

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

ALMTYPE

The alarm type for the environmental alarm. Optional

Parameter type is ENV_ALM—environmental alarm types

AIRCOMPR

Air compressor failure

AIRCOND

Air conditioning failure

AIRDRYR

Air dryer failure

BATDSCHRG

Battery discharging

BATTERY

Battery failure

CLFAN

Cooling fan failure

CPMAJOR

Centralized power major failure

CPMINOR

Centralized power minor failure

ENGINE

Engine failure

ENGOPRG

Engine operating

ENGTRANS

Standby engine transfer

EXPLGS

Explosive gas

FIRDETR

Fire detector failure

FIRE

Fire

FLOOD

Flood

FUELLEAK

Fuel leak

FUSE

Fuse failure

GASALARM

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

HATCH

CEV hatch fail

GEN

Generator failure

HIAIR

High 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

-139V power converter

PWR-190

-190V power converter

PWRMJ

Power supply major

PWRMN

Power supply minor

RECT

Rectifier failure

RECTHI

Rectifier high voltage

RECTLO

Rectifier low voltage

RINGGENMJ

Ringing generator major

RINGGENMN

Ringing generator minor

RTACADSL

AC or AC/rectifier power fail ADSL equipment

RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

RTACPWR

AC or AC/rectifier power fail DCL equipment

RTACPWRENG

Commercial AC fail, site equipped with standby engine

RTBAYPWR

AC power loss distributed power RT bay

RTRVENG

Retrieve standby engine, commercial AC restored

SMOKE

Smoke

TEMP

High-low temperature

TOXICGAS

Toxic gas

TREPEATER

T-repeater shelf

VENTN

Ventilation system failure

DESC

Alarm description. String. Optional


21.20  RTRV-AUDIT-LOG

Retrieve Audit Log

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the contents of the audit log stored in the NE. Audit records contain information for user operations such as login, logout, change of provisioning parameters and other changes a user might make when connected to the NE. Audit records do not store operations related to parameter retrieval.

Category

Log

Security

Superuser

Related Commands

ALW-MSG-DBCHG

INH-MSG-DBCHG

REPT DBCHG

RTRV-LOG


Input Format

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

Input Example

RTRV-AUDIT-LOG:::1;

Input Parameters

Table 21-39 RTRV-AUDIT-LOG Input Parameters 

Parameter and Values
Description

 

Output Format

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

Output Example

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

Output Parameters

Table 21-40 RTRV-AUDIT-LOG Output Parameters 

Parameter and Values
Description

ENTRYNUM

Entry number. Integer

OCRDAT

Date

OCRTM

Time

TASKID

Task ID. String

TXSTATUS

Parameter type is TX_STATUS—indicates the status of the transferred file

COMPLD

The file transmission is completed

IP

The file transmission is in process

START

The file transmission is started

DESCRIPTION

Description of event. Description format varies depending on the event and can include parameters used during the event. String


21.21  RTRV-BFDLPM-<MOD2>

Retrieve BFDL Performance Monitoring (DS1, T1)

Usage Guidelines

Cisco ONS 15454

This command retrieves the BFDL (enhanced 24-hour ES, UAS, BES, CSS and LOFC) performance monitoring parameters and applies to the DS3XM-12 card DS1 under BFDL mode. This command returns the current 15-minute and current 24-hour BFDL PMs and the 96 15-minute history requested type PMs.

For example:

Input:

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

Output:

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

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

Category

Performance

Security

Retrieve

Related Commands

ED-DS1

ED-T1

ED-T3

RTRV-DS1

RTRV-E1

RTRV-E3

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-T1

RTRV-T3


Input Format

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

Input Example

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

Input Parameters

Table 21-41 RTRV-BFDLPM-<MOD2> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.11  DS1" section on page 25-26. Must not be null

REQTYPE

Indicates requested BFDL PM type. Must not be null

Parameter type is REQTYPE—requested PM type

ENH-24HR-BES

The enhanced 24-hour BES performance data

ENH-24HR-CSS-AND-LOFC

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

ENH-24HR-ES

The enhanced 24-hour ES performance data

ENH-24HR-SES

The enhanced 24-hour SES performance data

ENH-24HR-UAS

The enhanced 24-hour UAS performance data


Output Format

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

Output Example

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

Output Parameters

Table 21-42 RTRV-BFDLPM-<MOD2> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.11  DS1" section on page 25-26

MONTYPE

Monitored type which includes: BES, CSS, ES, LOFC, SES, UAS. String

MONVAL

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

BUCKET

The BIN of each BFDL PM. String


21.22  RTRV-BITS

Retrieve Building Integrated Timing Supply

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the BITS configuration command. For BITS facility, 64 K and 6 MHz are only applicable to the ONS 15454. SSM selectable (ADMSSM) is not applicable to the ONS 15600.

Category

Synchronization

Security

Retrieve

Related Commands

ED-BITS

ED-NE-SYNCN

ED-SYNCN

OPR-SYNCNSW

REPT ALM BITS

REPT ALM SYNCN

REPT EVT BITS

REPT EVT SYNCN

RLS-SYNCNSW

RTRV-ALM-BITS

RTRV-ALM-SYNCN

RTRV-COND-BITS

RTRV-COND-SYNCN

RTRV-NE-SYNCN

RTRV-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-43 RTRV-BITS Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.5  BITS" section on page 25-13. Must not be null


Output Format

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

Output Example

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

Output Parameters

Table 21-44 RTRV-BITS Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.5  BITS" section on page 25-13

LINECDE

Line code. Optional

Parameter type is LINE_CODE—line code

AMI

Line code value is AMI

B8ZS

Line code value is B8ZS (bipolar with three-zero substitution)

FMT

Digital signal frame format. Optional

Parameter type is FRAME_FORMAT—frame format for a T1 port

D4

Frame format is D4

ESF

Frame format is ESF

UNFRAMED

Frame format is unframed

LBO

Line build out settings. BITS line build out. Default value is 0 to 133. Integer. Optional

Parameter type is BITS_LineBuildOut—BITS line buildout

0-133

BITS line buildout range is 0-133

134-266

BITS line buildout range is 134-266

267-399

BITS line buildout range is 267-399

400-533

BITS line buildout range is 400-533

534-655

BITS line buildout range is 534-655

SYNCMSG

Indicates if the BITS facility supports synchronization status message. Default is on (Y)

Parameter type is EXT_RING—indicates if the ring supports the extended K1/K2/K3 protocol

N

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

Y

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

AISTHRSHLD

Alarm indication signal threshold. Optional

Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET

DUS

Do Not Use For Synchronization

PRS

Primary Reference Source, Stratum 1 Traceable

RES

Reserved For Network Synchronization Use

SMC

SONET Minimum Clock Traceable

ST2

Stratum 2 Traceable

ST3

Stratum 3 Traceable

ST3E

Stratum 3E Traceable

ST4

Stratum 4 Traceable

STU

Synchronized, Traceability Unknown

TNC

Transit Node Clock (2nd Generation Only)

SABIT

When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. Optional

Parameter type is SABITS—SA BITS

BYTE-4

SABIT is BYTE-4

BYTE-5

SABIT is BYTE-5

BYTE-6

SABIT is BYTE-6

BYTE-7

SABIT is BYTE-7

BYTE-8

SABIT is BYTE-8

IMPEDANCE

When the frame format selection is E1, IMPEDANCE is the terminal impedance of the BITS-IN port. Optional

Parameter type is IMPEDANCE—the terminal impedance of the BITS-IN port

120-OHM

Impedance of 120 ohms

75-OHM

Impedance of 75 ohms

BITSFAC

BITS facility settings. Optional

Parameter type is BITS_FAC—BITS facility rate. 64 K and 6 MHz are only applicable to the ONS 15454

2 M

2 MHz rate

64 K

64 K rate

6 M

6 MHz rate

E1

E1 rate

T1

T1 rate

ADMSSM

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

Note Not applicable for the ONS 15600

Parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL—clock source quality level for SONET

DUS

Do Not Use For Synchronization

PRS

Primary Reference Source, Stratum 1 Traceable

RES

Reserved For Network Synchronization Use

SMC

SONET Minimum Clock Traceable

ST2

Stratum 2 Traceable

ST3

Stratum 3 Traceable

ST3E

Stratum 3E Traceable

ST4

Stratum 4 Traceable

STU

Synchronized, Traceability Unknown

TNC

Transit Node Clock (2nd Generation Only)

PST

Primary state. Optional

Parameter type is PST—indicates the current overall service condition of an entity

IS

In service

OOS

Out of service


21.23  RTRV-BULKROLL<OCN_TYPE>

Retrieve Bulkroll (OC12, OC192, OC3, OC48)

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600

This command retrieves roll data parameters on a line.

See Table 27-1 on page 27-1 for supported modifiers by platform.

Category

Bridge and Roll

Security

Provisioning

Related Commands

DLT-<MOD1PAYLOAD>

DLT-BULKROLL-<OCN_TYPE>

DLT-FFP-<MOD2DWDMPAYLOAD>

DLT-FFP-<OCN_TYPE>

ED-<GIGE_TYPE>

ED-<MOD1FCPAYLOAD>

ED-<MOD1FICONPAYLOAD>

ED-<MOD2DWDMPAYLOAD>

ED-<OCN_TYPE>

ED-ALS

ED-BULKROLL-<OCN_TYPE>

ED-DS1

ED-DS3I

ED-EC1

ED-FAC

ED-FFP-<MOD2DWDMPAYLOAD>

ED-FFP-<OCN_TYPE>

ED-FSTE

ED-G1000

ED-GFP

ED-HDLC

ED-POS

ED-T1

ED-T3

ENT-<MOD1PAYLOAD>

ENT-FFP-<MOD2DWDMPAYLOAD>

ENT-FFP-<OCN_TYPE>

INIT-REG-<MOD2>

OPR-ALS

OPR-LPBK-<MOD2>

OPR-PROTNSW-<MOD2DWDMPAYLOAD>

OPR-PROTNSW-<OCN_TYPE>

REPT PM <MOD2>

REPT RMV <MOD2_IO>

REPT RST <MOD2_IO>

RLS-LPBK-<MOD2>

RLS-PROTNSW-<MOD2DWDMPAYLOAD>

RLS-PROTNSW-<OCN_TYPE>

RMV-<MOD2>

RST-<MOD2>

RTRV-<MOD1FCPAYLOAD>

RTRV-<MOD1FICONPAYLOAD>

RTRV-<MOD2DWDMPAYLOAD>

RTRV-<OCN_TYPE>

RTRV-10GIGE

RTRV-ALMTH-<MOD2>

RTRV-ALS

RTRV-DS1

RTRV-DS3I

RTRV-EC1

RTRV-FAC

RTRV-FFP-<MOD2DWDMPAYLOAD>

RTRV-FFP-<OCN_TYPE>

RTRV-FSTE

RTRV-G1000

RTRV-GFP

RTRV-GIGE

RTRV-HDLC

RTRV-PM-<MOD2>

RTRV-PMSCHED-<MOD2>

RTRV-POS

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

RTRV-PROTNSW-<OCN_TYPE>

RTRV-T1

RTRV-T3

RTRV-TH-<MOD2>

SCHED-PMREPT-<MOD2>

SET-ALMTH-<MOD2>

SET-TH-<MOD2>


Input Format

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

Input Example

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

Input Parameters

Table 21-45 RTRV-BULKROLL-<OCN_TYPE> Input Parameters 

Parameter and Values
Description

SRC

Source AID from the "25.1.14  FACILITY" section on page 25-28. Must not be null


Output Format

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

Output Example

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

Output Parameters

Table 21-46 RTRV-BULKROLL-<OCN_TYPE> Output Parameters 

Parameter and Values
Description

FROM

One of the end points. Access identifier from the "25.1.14  FACILITY" section on page 25-28 for line level rolling and bulk rolling

RFROM

The termination point of the existing cross-connect that is to be rolled. The AID is from the "25.1.10  CrossConnectId1" section on page 25-20 (except VCM and FACILITY)

RTO

The termination point that will become a leg of the new cross-connection. The AID is from the "25.1.10  CrossConnectId1" section on page 25-20 (except VCM and FACILITY)

RMODE

The rolling mode of operation. Optional

Parameter type is ALS_MODE—specifies the working mode for the automatic laser shutdown (ALS) functionality

AUTO

Automatic

DISABLED

Disabled

MAN

Manual

MAN-RESTART

Manual Restart for Test

VLDSIG

The rolling mode of operation. Optional

Parameter type is ON_OFF—disable or enable an attribute

N

Disable an attribute

Y

Enable an attribute


21.24  RTRV-CMD-SECU

Retrieve Command Security

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the current command security level of the command specified in the AID field.

Category

Security

Security

Superuser

Related Commands

ACT-USER

ALW-MSG-SECU

ALW-USER-SECU

CANC

CANC-USER

CANC-USER-SECU

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

INH-USER-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT


Input Format

RTRV-CMD-SECU:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-CMD-SECU::INIT-REG:1;

Input Parameters

Table 21-47 RTRV-CMD-SECU Input Parameters 

Parameter and Values
Description

AID

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


Output Format

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

Output Example

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

Output Parameters

Table 21-48 RTRV-CMD-SECU Output Parameters 

Parameter and Values
Description

AID

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

CAP

Command access privilege

Parameter type is PRIVILEGE—security level

PROV

Provision security level

SUPER

Superuser security level


21.25  RTRV-COND-<MOD2ALM>

Retrieve Condition (1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, DS1, E100, E1000, E3, E4, EC1, FSTE, G1000, GFPOS, GIGE, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, UDCDCC, UDCF, VC12, VC3, VCG, VT1, VT2, WLEN)

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the current standing condition and state associated with an entity.

See Table 27-1 on page 27-1 for supported modifiers by platform.

Category

Fault

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

RTRV-COND-T3:TID:FAC-2-1:229::LOS;

Input Parameters

Table 21-49 RTRV-COND-<MOD2ALM> Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1. Must not be null

TYPEREQ

The type of condition to be retrieved. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions


Output Format

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

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,T3:CR,LOS,SA,01-01,16-00-20,,,\"LOS OF SIGNAL\""
;

Output Parameters

Table 21-50 RTRV-COND-<MOD2ALM> Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1

AIDTYPE

Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2ALM—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

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

T1

T1 alarm

T3

T3 alarm

UDCDCC

UDCDCC alarm

UDCF

UCDF alarm

VCG

Virtual Concatenation Group alarm

VT1

VT1 alarm

VT2

VT2 alarm

WLEN

Wavelength Path Provisioning

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

TYPEREP

The condition itself

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition, Optional

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional

DESC

Condition description. String. Optional


21.26  RTRV-COND-ALL

Retrieve Condition All

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the current standing condition for all entities.

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

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

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

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

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

Category

Fault

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-<MOD2ALM>

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

RTRV-COND-ALL:TID:ALL:229::LOS;

Input Parameters

Table 21-51 RTRV-COND-ALL Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1. String. A null value is equivalent to ALL

TYPEREQ

The type of condition to be retrieved. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions


Output Format

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

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"FAC-2-1,OC3:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;

Output Parameters

Table 21-52 RTRV-COND-ALL Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.1  ALL" section on page 25-1 that has an alarm condition

AIDTYPE

Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

TYPEREP

The type of condition to be retrieved

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition, Optional

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional

DESC

Condition description. String. Optional


21.27  RTRV-COND-BITS

Retrieve Condition Building Integrated Timing Supply

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the standing conditions on BITS.

Category

Synchronization

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-53 RTRV-COND-BITS Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.5  BITS" section on page 25-13. Must not be null

TYPEREQ

The type of condition to be retrieved. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions


Output Format

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

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"BITS-1,BITS:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;

Output Parameters

Table 21-54 RTRV-COND-BITS Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.5  BITS" section on page 25-13 that has an alarm condition

AIDTYPE

Type of access identifier. Specifies the type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

BITS

BITS alarm

CLNT

Client facility for MXP/TXP cards

COM

Common alarm

DS1

DS1 alarm

DS3I

DS2I alarm

E100

E100 alarm

E1000

E1000 alarm

EC1

EC1 alarm

ENV

ENV alarm

EQPT

EQPT alarm

FSTE

Fast Ethernet Port alarm

G1000

G1000 alarm

GIGE

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

TYPEREP

The type of condition to be retrieved

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition, Optional

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional

DESC

Condition description. String. Optional


21.28  RTRV-COND-ENV

Retrieve Environmental Condition

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the environmental conditions.

Category

Environment

Security

Retrieve

Related Commands

CLR-COND-SECU

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-EQPT

RTRV-COND-SYNCN


Input Format

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

Input Example

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

Input Parameters

Table 21-55 RTRV-COND-ENV Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26. Must not be null

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

NTFCNCDE

Two-letter notification code. A null value is equivalent to ALL

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

ALMTYPE

The alarm type for the environmental alarm. A null value is equivalent to ALL

Parameter type is ENV_ALM—environmental alarm types

AIRCOMPR

Air compressor failure

AIRCOND

Air conditioning failure

AIRDRYR

Air dryer failure

BATDSCHRG

Battery discharging

BATTERY

Battery failure

CLFAN

Cooling fan failure

CPMAJOR

Centralized power major failure

CPMINOR

Centralized power minor failure

ENGINE

Engine failure

ENGOPRG

Engine operating

ENGTRANS

Standby engine transfer

EXPLGS

Explosive gas

FIRDETR

Fire detector failure

FIRE

Fire

FLOOD

Flood

FUELLEAK

Fuel leak

FUSE

Fuse failure

GASALARM

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

HATCH

CEV hatch fail

GEN

Generator failure

HIAIR

High 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

-139V power converter

PWR-190

-190V power converter

PWRMJ

Power supply major

PWRMN

Power supply minor

RECT

Rectifier failure

RECTHI

Rectifier high voltage

RECTLO

Rectifier low voltage

RINGGENMJ

Ringing generator major

RINGGENMN

Ringing generator minor

RTACADSL

AC or AC/rectifier power fail ADSL equipment

RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

RTACPWR

AC or AC/rectifier power fail DCL equipment

RTACPWRENG

Commercial AC fail, site equipped with standby engine

RTBAYPWR

AC power loss distributed power RT bay

RTRVENG

Retrieve standby engine, commercial AC restored

SMOKE

Smoke

TEMP

High-low temperature

TOXICGAS

Toxic gas

TREPEATER

T-repeater shelf

VENTN

Ventilation system failure


Output Format

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

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"ENV-IN-1:MJ,OPENDR,01-01,16-02-15,,,,\"OPEN DOOR\""
;

Output Parameters

Table 21-56 RTRV-COND-ENV Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.12  ENV" section on page 25-26

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

ALMTYPE

The alarm type for the environmental alarm

Parameter type is ENV_ALM—environmental alarm types

AIRCOMPR

Air compressor failure

AIRCOND

Air conditioning failure

AIRDRYR

Air dryer failure

BATDSCHRG

Battery discharging

BATTERY

Battery failure

CLFAN

Cooling fan failure

CPMAJOR

Centralized power major failure

CPMINOR

Centralized power minor failure

ENGINE

Engine failure

ENGOPRG

Engine operating

ENGTRANS

Standby engine transfer

EXPLGS

Explosive gas

FIRDETR

Fire detector failure

FIRE

Fire

FLOOD

Flood

FUELLEAK

Fuel leak

FUSE

Fuse failure

GASALARM

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

HATCH

CEV hatch fail

GEN

Generator failure

HIAIR

High 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

-139V power converter

PWR-190

-190V power converter

PWRMJ

Power supply major

PWRMN

Power supply minor

RECT

Rectifier failure

RECTHI

Rectifier high voltage

RECTLO

Rectifier low voltage

RINGGENMJ

Ringing generator major

RINGGENMN

Ringing generator minor

RTACADSL

AC or AC/rectifier power fail ADSL equipment

RTACCRIT

AC or AC/rectifier power fail DCL equipment critical site

RTACPWR

AC or AC/rectifier power fail DCL equipment

RTACPWRENG

Commercial AC fail, site equipped with standby engine

RTBAYPWR

AC power loss distributed power RT bay

RTRVENG

Retrieve standby engine, commercial AC restored

SMOKE

Smoke

TEMP

High-low temperature

TOXICGAS

Toxic gas

TREPEATER

T-repeater shelf

VENTN

Ventilation system failure

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional

DESC

Condition description. String. Optional


21.29  RTRV-COND-EQPT

Retrieve Condition Equipment

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the equipment conditions.

Category

Equipment

Security

Retrieve

Related Commands

ALW-SWDX-EQPT

ALW-SWTOPROTN-EQPT

ALW-SWTOWKG-EQPT

CLR-COND-SECU

DLT-EQPT

ED-EQPT

ENT-EQPT

INH-SWDX-EQPT

INH-SWTOPROTN-EQPT

INH-SWTOWKG-EQPT

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-ALMTH-EQPT

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-SYNCN

RTRV-EQPT

SET-ALMTH-EQPT

SW-DX-EQPT

SW-TOPROTN-EQPT

SW-TOWKG-EQPT


Input Format

RTRV-COND-EQPT:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];

Input Example

RTRV-COND-EQPT:TID:SLOT-1:229::LOS;

Input Parameters

Table 21-57 RTRV-COND-EQPT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.13  EQPT" section on page 25-27 that has an alarm condition. Must not be null

TYPEREQ

The type of condition to be retrieved. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions


Output Format

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

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-1,EQPT:CR,LOS,SA,01-01,16-02-15,,,\"LOS OF SIGNAL\""
;

Output Parameters

Table 21-58 RTRV-COND-EQPT Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.13  EQPT" section on page 25-27 that has an alarm condition

AIDTYPE

Type of facility, link or other addressable entity targeted by the message. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

TYPEREP

The type of condition to be retrieved

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition, Optional

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional

DESC

Condition description. String. Optional


21.30  RTRV-COND-SYNCN

Retrieve Condition Synchronization

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves the synchronization condition.

Category

Synchronization

Security

Retrieve

Related Commands

CLR-COND-SECU

ED-BITS

ED-NE-SYNCN

ED-SYNCN

OPR-SYNCNSW

REPT ALM <MOD2ALM>

REPT ALM BITS

REPT ALM COM

REPT ALM ENV

REPT ALM EQPT

REPT ALM SECU

REPT ALM SYNCN

REPT EVT <MOD2ALM>

REPT EVT BITS

REPT EVT COM

REPT EVT ENV

REPT EVT EQPT

REPT EVT FXFR

REPT EVT IOSCFG

REPT EVT SECU

REPT EVT SESSION

REPT EVT SYNCN

RLS-SYNCNSW

RTRV-ALM-<MOD2ALM>

RTRV-ALM-ALL

RTRV-ALM-BITS

RTRV-ALM-ENV

RTRV-ALM-EQPT

RTRV-ALM-SYNCN

RTRV-BITS

RTRV-COND-<MOD2ALM>

RTRV-COND-ALL

RTRV-COND-BITS

RTRV-COND-ENV

RTRV-COND-EQPT

RTRV-NE-SYNCN

RTRV-SYNCN


Input Format

RTRV-COND-SYNCN:[<TID>]:<AID>:<CTAG>::[<TYPEREQ>][,,,];

Input Example

RTRV-COND-SYNCN:TID:SYNC-NE:229::LOS;

Input Parameters

Table 21-59 RTRV-COND-SYNCN Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.25  SYNC_REF" section on page 25-40 that has an alarm condition. Must not be null

TYPEREQ

The type of condition to be retrieved. A null value is equivalent to ALL

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions


Output Format

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

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SYNC-NE,SYNCN:MJ,FRNGSYNC,SA,01-01,16-02-15,,,
\"FREE RUNNING SYNCHRONIZATION MODE\""
;

Output Parameters

Table 21-60 RTRV-COND-SYNCN Output Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.23  SYN" section on page 25-39 that has an alarm condition

AIDTYPE

Type of facility, link or other addressable entity targeted by the message. The value is always SYNCN. Optional

Parameter type is MOD2B—alarm type

1GFC

1 Gigabit fibre channel alarm

1GFICON

1 Gigabit FICON alarm

2GFC

2 Gigabit fibre channel alarm

2GFICON

2 Gigabit FICON alarm

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

GIG Ethernet port alarm

MIC

MIC alarm (ONS 15327)

MIC-EXT

MIC-EXT (ONS 15327)

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

XTC

XTC alarm (ONS 15327)

NTFCNCDE

Two-letter notification code. Optional

Parameter type is NOTIF_CODE—two-character notification code associated with an autonomous message

CL

The condition causing the alarm has cleared

CR

A critical alarm

MJ

A major alarm

MN

A minor alarm

NA

The condition is not alarmed

NR

The alarm is not reported

TYPEREP

The type of condition to be retrieved

Parameter type is CONDITION—any problem detected on an ONS 15454, ONS 15327, ONS 15310-CL, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, Not-Alarmed conditions (NA), and Not-Reported (NR) conditions. See Chapter 26, "Conditions" for a list of conditions

SRVEFF

The effect on service caused by the standing alarm or condition, Optional

Parameter type is SERV_EFF—the effect of the alarm on service

NSA

The condition is non-service affecting

SA

The condition is service affecting

OCRDAT

Date when the specific event or violation occurred. Optional

OCRTM

Time when the specific event or violation occurred. Optional

DESC

Condition description. String. Optional


21.31  RTRV-CONSOLE-PORT

Retrieve Console Port

Usage Guidelines

Cisco ONS 15454, 15310

This command retrieves the status of the console port from the ML-Series cards.

Category

Security

Security

Retrieve

Related Commands

ACT-USER

ALW-CONSOLE-PORT

ALW-MSG-SECU

ALW-USER-SECU

CANC

CANC-USER

CANC-USER-SECU

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-PROTOCOL

ED-USER-SECU

ENT-USER-SECU

INH-CONSOLE-PORT

INH-MSG-SECU

INH-USER-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-AUDIT-LOG

RTRV-CMD-SECU

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT


Input Format

RTRV-CONSOLE-PORT:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-CONSOLE-PORT:CISCONODE:SLOT-2:123;

Input Parameters

Table 21-61 RTRV-CONSOLE-PORT Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.13  EQPT" section on page 25-27. Must not be null


Output Format

SID DATE TIME
M CTAG COMPLD
"<EQPT>:[PORT=<PORT>]"
;

Output Example

TID-000 1998-06-20 14:30:00
M 001 COMPLD
"SLOT-2:PORT=ENABLED"
;

Output Parameters

Table 21-62 RTRV-CONSOLE-PORT Output Parameters 

Parameter and Values
Description

EQPT

Identifies the slot number for the data card. String

PORT

Status of the console port on the data card. Optional

Parameter type is PORTSTAT—the status of the console port on the card

DISABLED

The port is disabled

ENABLED

The port is enabled


21.32  RTRV-CRS

Retrieve Cross-Connect

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command retrieves all the cross-connections based on the required PATH types.


NoteA NULL AID defaults to ALL (NE).

A NULL PATH defaults to all the existing cross-connections.

The LEVEL in the output field is an optional field, and is used to indicate the bandwidth of the PATH cross-connection.

Both DRITYPE and DRINODE optional fields are available to support BLSR-DRI. DRITYPE is applied only if the cross-connect is a drop-and-continue connection (1WAYDC or 2WAYDC), and defaults to path protection for the DRI. DRINODE must be specified only if at least one end of the connection is on the BLSR, and defaults to NA.

The DS3XM-12 card allows portless STS1/VT1.5 cross-connection provisioning on the portless ports.

CKTID is a string of ASCII characters. The maximum length of CKTID is 48. If the CKTID is EMPTY or NULL it will not appear.


Category

Cross Connections

Security

Retrieve

Related Commands

DLT-CRS-<PATH>

ED-CRS-<PATH>

ENT-CRS-<PATH>

RTRV-CRS-<PATH>


Input Format

RTRV-CRS:[<TID>]:[<AID>]:<CTAG>:::[CRSTYPE=<CRSTYPE>][:];

Input Example

RTRV-CRS:CISCO:ALL:123:::CRSTYPE=STS;

Input Parameters

Table 21-63 RTRV-CRS Input Parameters 

Parameter and Values
Description

AID

Access identifier from the "25.1.10  CrossConnectId1" section on page 25-20 that can be facility, STS, VT or ALL. The ALL AID defaults to NE, which means it reports all the existing cross-connections on the NE. A null value is equivalent to ALL

CRSTYPE

The cross-connection type. Defaults to all existing cross-connections. A null value is equivalent to ALL

Parameter type is PATH—modifier for path commands

STS1

Synchronous transport signal/module level-1 (51.84 Mbps)

STS3C

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

STS6C

Synchronous transport signal/module level-6 (311.04 Mbps)

STS9C

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

STS12C

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

STS18C

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

STS24C

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

STS36C

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

STS48C

Synchronous transport