ONS SDH TL1 Command Guide R8.5.1 -- RTRV Commands (P through W)

From DocWiki

1 RTRV-PM-<MOD2>
- 1.1 Usage Guidelines
- 1.2 Category
- 1.3 Security
- 1.4 Input Format
- 1.5 Input Example
- 1.6 Input Parameters
- 1.7 Output Format
- 1.8 Output Example
- 1.9 Output Parameters
2 RTRV-PM-ALL
- 2.1 Usage Guidelines
- 2.2 Category
- 2.3 Security
- 2.4 Input Format
- 2.5 Input Example
- 2.6 Input Parameters
- 2.7 Output Format
- 2.8 Output Example
- 2.9 Output Parameters
3 RTRV-PMMODE-<VC_PATH>
- 3.1 Usage Guidelines
- 3.2 Category
- 3.3 Security
- 3.4 Input Format
- 3.5 Input Example
- 3.6 Input Parameters
- 3.7 Output Format
- 3.8 Output Example
- 3.9 Output Parameters
4 RTRV-PMSCHED-<MOD2>
- 4.1 Usage Guidelines
- 4.2 Category
- 4.3 Security
- 4.4 Input Format
- 4.5 Input Example
- 4.6 Input Parameters
- 4.7 Output Format
- 4.8 Output Example
- 4.9 Output Parameters
5 RTRV-PMSCHED-ALL
- 5.1 Usage Guidelines
- 5.2 Category
- 5.3 Security
- 5.4 Input Format
- 5.5 Input Example
- 5.6 Input Parameters
- 5.7 Output Format
- 5.8 Output Example
- 5.9 Output Parameters
6 RTRV-POS
- 6.1 Usage Guidelines
- 6.2 Category
- 6.3 Security
- 6.4 Input Format
- 6.5 Input Example
- 6.6 Input Parameters
- 6.7 Output Format
- 6.8 Output Example
- 6.9 Output Parameters
7 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
- 7.1 Usage Guidelines
- 7.2 Category
- 7.3 Security
- 7.4 Input Format
- 7.5 Input Example
- 7.6 Input Parameters
- 7.7 Output Format
- 7.8 Output Example
- 7.9 Output Parameters
8 RTRV-PROTNSW-<STM_TYPE>
- 8.1 Usage Guidelines
- 8.2 Category
- 8.3 Security
- 8.4 Input Format
- 8.5 Input Example
- 8.6 Input Parameters
- 8.7 Output Format
- 8.8 Output Example
- 8.9 Output Parameters
9 RTRV-PROTNSW-<PATH>
- 9.1 Usage Guidelines
- 9.2 Category
- 9.3 Security
- 9.4 Input Format
- 9.5 Input Example
- 9.6 Input Parameters
- 9.7 Output Format
- 9.8 Output Example
- 9.9 Output Parameters
10 RTRV-PROTNSW-OCH
- 10.1 Usage Guidelines
- 10.2 Category
- 10.3 Security
- 10.4 Input Format
- 10.5 Input Example
- 10.6 Input Parameters
- 10.7 Output Format
- 10.8 Output Example
- 10.9 Output Parameters
11 RTRV-PROTOCOL
- 11.1 Usage Guidelines
- 11.2 Category
- 11.3 Security
- 11.4 Input Format
- 11.5 Input Example
- 11.6 Input Parameters
- 11.7 Output Format
- 11.8 Output Example
- 11.9 Output Parameters
12 RTRV-PTHTRC-<PATH>
- 12.1 Usage Guidelines
- 12.2 Category
- 12.3 Security
- 12.4 Input Format
- 12.5 Input Example
- 12.6 Input Parameters
- 12.7 Output Format
- 12.8 Output Example
- 12.9 Output Parameters
13 RTRV-QNQ-ETH
- 13.1 Usage Guidelines
- 13.2 Category
- 13.3 Security
- 13.4 Input Format
- 13.5 Input Example
- 13.6 Input Parameters
- 13.7 Output Format
- 13.8 Output Example
- 13.9 Output Parameters
14 RTRV-RMONTH-<MOD2_RMON>
- 14.1 Usage Guidelines
- 14.2 Category
- 14.3 Security
- 14.4 Input Format
- 14.5 Input Example
- 14.6 Input Parameters
- 14.7 Output Format
- 14.8 Output Example
- 14.9 Output Parameters
15 RTRV-ROLL-<MOD_PATH>
- 15.1 Usage Guidelines
- 15.2 Category
- 15.3 Security
- 15.4 Input Format
- 15.5 Input Example
- 15.6 Input Parameters
- 15.7 Output Format
- 15.8 Output Example
- 15.9 Output Parameters
16 RTRV-ROUTE
- 16.1 Usage Guidelines
- 16.2 Category
- 16.3 Security
- 16.4 Input Format
- 16.5 Input Example
- 16.6 Input Parameters
- 16.7 Output Format
- 16.8 Output Example
- 16.9 Output Parameters
17 RTRV-ROUTE-GRE
- 17.1 Usage Guidelines
- 17.2 Category
- 17.3 Security
- 17.4 Input Format
- 17.5 Input Example
- 17.6 Input Parameters
- 17.7 Output Format
- 17.8 Output Example
- 17.9 Output Parameters
18 RTRV-SLV-WDMANS
- 18.1 Usage Guidelines
- 18.2 Category
- 18.3 Security
- 18.4 Input Format
- 18.5 Input Example
- 18.6 Input Parameters
- 18.7 Output Format
- 18.8 Output Example
- 18.9 Output Parameters
19 RTRV-STM1E
- 19.1 Usage Guidelines
- 19.2 Category
- 19.3 Security
- 19.4 Input Format
- 19.5 Input Example
- 19.6 Input Parameters
- 19.7 Output Format
- 19.8 Output Example
- 19.9 Output Parameters
20 RTRV-SYNCN
- 20.1 Usage Guidelines
- 20.2 Category
- 20.3 Security
- 20.4 Input Format
- 20.5 Input Example
- 20.6 Input Parameters
- 20.7 Output Format
- 20.8 Output Example
- 20.9 Output Parameters
21 RTRV-TACC
- 21.1 Usage Guidelines
- 21.2 Category
- 21.3 Security
- 21.4 Input Format
- 21.5 Input Example
- 21.6 Input Parameters
- 21.7 Output Format
- 21.8 Output Example
- 21.9 Output Parameters
22 RTRV-TADRMAP
- 22.1 Usage Guidelines
- 22.2 Category
- 22.3 Security
- 22.4 Input Format
- 22.5 Input Example
- 22.6 Input Parameters
- 22.7 Output Format
- 22.8 Output Example
- 22.9 Output Parameters
23 RTRV-TH-<MOD2>
- 23.1 Usage Guidelines
- 23.2 Category
- 23.3 Security
- 23.4 Input Format
- 23.5 Input Example
- 23.6 Input Parameters
- 23.7 Output Format
- 23.8 Output Example
- 23.9 Output Parameters
24 RTRV-TH-ALL
- 24.1 Usage Guidelines
- 24.2 Category
- 24.3 Security
- 24.4 Input Format
- 24.5 Input Example
- 24.6 Input Parameters
- 24.7 Output Format
- 24.8 Output Example
- 24.9 Output Parameters
25 RTRV-TOD
- 25.1 Usage Guidelines
- 25.2 Category
- 25.3 Security
- 25.4 Input Format
- 25.5 Input Example
- 25.6 Input Parameters
- 25.7 Output Format
- 25.8 Output Example
- 25.9 Output Parameters
26 RTRV-TRAPTABLE
- 26.1 Usage Guidelines
- 26.2 Category
- 26.3 Security
- 26.4 Input Format
- 26.5 Input Example
- 26.6 Input Parameters
- 26.7 Output Format
- 26.8 Output Example
- 26.9 Output Parameters
27 RTRV-TRC-<STM_MSSPR>
- 27.1 Usage Guidelines
- 27.2 Category
- 27.3 Security
- 27.4 Input Format
- 27.5 Input Example
- 27.6 Input Parameters
- 27.7 Output Format
- 27.8 Output Example
- 27.9 Output Parameters
28 RTRV-TRC-OCH
- 28.1 Usage Guidelines
- 28.2 Category
- 28.3 Security
- 28.4 Input Format
- 28.5 Input Example
- 28.6 Input Parameters
- 28.7 Output Format
- 28.8 Output Example
- 28.9 Output Parameters
29 RTRV-TUNNEL-FIREWALL
- 29.1 Usage Guidelines
- 29.2 Category
- 29.3 Security
- 29.4 Input Format
- 29.5 Input Example
- 29.6 Input Parameters
- 29.7 Output Format
- 29.8 Output Example
- 29.9 Output Parameters
30 RTRV-TUNNEL-PROXY
- 30.1 Usage Guidelines
- 30.2 Category
- 30.3 Security
- 30.4 Input Format
- 30.5 Input Example
- 30.6 Input Parameters
- 30.7 Output Format
- 30.8 Output Example
- 30.9 Output Parameters
31 RTRV-USER-SECU
- 31.1 Usage Guidelines
- 31.2 Category
- 31.3 Security
- 31.4 Input Format
- 31.5 Input Example
- 31.6 Input Parameters
- 31.7 Output Format
- 31.8 Output Example
- 31.9 Output Parameters
32 RTRV-VC
- 32.1 Usage Guidelines
- 32.2 Category
- 32.3 Security
- 32.4 Input Format
- 32.5 Input Example
- 32.6 Input Parameters
- 32.7 Output Format
- 32.8 Output Example
- 32.9 Output Parameters
33 RTRV-VCG
- 33.1 Usage Guidelines
- 33.2 Category
- 33.3 Security
- 33.4 Input Format
- 33.5 Input Example
- 33.6 Input Parameters
- 33.7 Output Format
- 33.8 Output Example
- 33.9 Output Parameters
34 RTRV-VLAN
- 34.1 Usage Guidelines
- 34.2 Category
- 34.3 Security
- 34.4 Input Format
- 34.5 Input Example
- 34.6 Input Parameters
- 34.7 Output Format
- 34.8 Output Example
- 34.9 Output Parameters
35 RTRV-WDMANS
- 35.1 Usage Guidelines
- 35.2 Category
- 35.3 Security
- 35.4 Input Format
- 35.5 Input Example
- 35.6 Input Parameters
- 35.7 Output Format
- 35.8 Output Example
- 35.9 Output Parameters
36 RTRV-WDMSIDE
- 36.1 Usage Guidelines
- 36.2 Category
- 36.3 Security
- 36.4 Input Format
- 36.5 Input Example
- 36.6 Input Parameters
- 36.7 Output Format
- 36.8 Output Example
- 36.9 Output Parameters
37 RTRV-WLEN
- 37.1 Usage Guidelines
- 37.2 Category
- 37.3 Security
- 37.4 Input Format
- 37.5 Input Example
- 37.6 Input Parameters
- 37.7 Output Format
- 37.8 Output Example
- 37.9 Output Parameters
- 37.10 Output Format
- 37.11 Output Example
- 37.12 Output Parameters
- 37.13 Output Format
- 37.14 Output Example
- 37.15 Output Parameters

RTRV-PM-<MOD2>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Performance Monitoring for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS3I, DV6000, E1, E3, E4, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-PM-<MOD2>) command retrieves the PM parameter values for a specified card type. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

MONLEV is in the format of LEV-DIRN.
After an MS-SPRing switch, the working path is switched out, the traffic goes through the protection path, and the intermediate path performance monitoring (IPPM) can be retrieved from the protection VC path.
If there is a VC PCA on the protection path, the PCA path is preemptive during an MS-SPRing switch. If you send this command on the protection path after an MS-SPRing switch, the command returns the PMs from the protection path rather than the PCA path.
Some MOD2 entities, for example, OCH, CLNT, and Optical (STM), support negative MONTYPE values. By default, this command defaults to 0-UP (that is, MONTYPEs are returned when the MONVAL is 0 or higher). To retrieve the negative values, you must issue 0-DN in the MONLEV field.
For client ports, laser and SDH PMs are applicable and will appear. If the card payload is in SDH mode, then SDH PMs will appear (as long as the MONLEV criteria is met).
Trunk port laser PMs are always available. Laser PMs are only for near-end. If ITU-T G.709 is enabled, then the OTN PMs will appear. If ITU-T G.709 is enabled and FEC is enabled, then the FEC PMs will appear. If the card payload is in SDH mode, then SDH PMs will appear. All PM MONVALUEs should pass the MONLEV filter criteria.
For DWDM cards, the MONLEV filter criteria will not support a floating point. It will be returned and interpreted as an integer.
RTRV-PM-<MOD2> can also be used to retrieve the RMON-managed PM data.

Category

Performance

Security

Retrieve

Input Format

RTRV-PM-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>], [<DIRECTION>],[<TMPER>],[<DATE>],[<TIME>];

Input Example

RTRV-PM-E1:TID:FAC-2-1:123::CVL,10-UP,NEND,RCV,15-MIN,04-11,12-45;

Input Parameters

<AID>	Access identifier from the ALL. All of the VC, and VT1, Facility AIDs are supported.
<MONTYPE>	(Optional) Monitored type. A null value defaults to all MONTYPEs applicable to the modifier. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
dot3StatsFCSErrors	A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
dot3StatsFrameTooLong	A count of frames received on a particular interface that exceed the maximum permitted frame size.
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count-Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count-Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in one tenth of a microwatt
OPR-MAX	Maximum Receive Power in one tenth of a microwatt
OPR-MIN	Minimum Receive Power in one tenth of a microwatt
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed in tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed in tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<MONLEV>	(Optional) The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>	(Optional) Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility
NEND	Action occurs on the near end of the facility
<DIRECTION>	(Optional) Type of direction. The parameter type is DIRECTION, which is the transmit and receive directions.
RCV	Receive direction only
TRMT	Transmit direction only
<TMPER>	(Optional) Accumulation time period for performance counters. If TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length is every 24 hours. For SDH PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history data available.
15-MIN	Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<DATE>	(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of DATE is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to current date.
<TIME>	(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of TIME is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to current time.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>], [<DIRECTION>],[<TMPER>],[<MONDAT>],[<MONTM>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1,E1:CVL,21,COMPL,NEND,RCV,15-MIN,04-11,12-45" ;

Output Parameters

<AID>	Access identifier from the ALL.
<AIDTYPE>	(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
BITS	BITS alarm
CLNT	Client facility for MXP/TXP cards
COM	Common alarm
DS3I	DS3i-N-12 alarm
E1	E1 alarm
E100	E100 alarm
E1000	E1000 alarm
E3	E3 alarm
E4	E4 alarm
ENV	ENV alarm
EQPT	EQPT alarm
FSTE	Fast Ethernet port alarm
G1000	G1000 alarm
GIGE	Gigabit Ethernet port alarm
ISC3PEER1G	1-Gbps ISC3 peer
ISC3PEER2G	2-Gbps ISC3 peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
OCH	Optical channel
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port alarm
STM1	STM1 alarm
STM1E	STM1E alarm
STM4	STM4 alarm
STM16	STM16 alarm
STM64	STM64 alarm
SYNCN	SYNCN alarm
TCC	TCC alarm
VC11	VC11 alarm
VC12	VC12 alarm
VC3	VC3 alarm
VC44C	VC44C alarm
VC38C	VC38C alarm
VC464C	VC464C alarm
VC48C	VC48C alarm
VC4	VC4 alarm
VC416C	VC416C alarm
VC42C	VC42C alarm
VC43C	VC43C alarm
<MONTYPE>	Monitored type. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage.
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage.
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
dot3StatsFCSErrors	A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
dot3StatsFrameTooLong	A count of frames received on a particular interface that exceed the maximum permitted frame size.
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count - Path Detected
HP-NPJC-PGEN	High-Order Path Pointer Justification Count Seconds - Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification - Path Detected
NPJC-PGEN	Negative Pointer Justification - Path Generated
OPR-AVG	Average Receive Power in tenths of a microW
OPR-MAX	Maximum Receive Power in tenths of a microW
OPR-MIN	Minimum Receive Power in tenths of a microW
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed in tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed in tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<MONVAL>	The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. MONVAL is a string.
<VLDTY>	(Optional) Indicates whether the information for the specified time period was accumulated over the entire time period or some portion thereof. Validity indicator for the reported PM data. The parameter type is VALIDITY, which is the response validity.
COMPL	Complete response
PRTL	Partial response
<LOCN>	(Optional) Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<DIRECTION>	The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
BTH	Both transmit and receive directions
RCV	Receive direction only
TRMT	Transmit direction only
<TMPER>	(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length is every 24 hours. For SDH PM data only, one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<MONDAT>	(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of MONDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MONDAT is a string.
<MONTM>	(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MONTM is a string.

RTRV-PM-ALL

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Performance Monitoring All (RTRV-PM-ALL) command retrieves the values of all the performance monitoring parameters for the specified AID. When the ALL AID is used, the response will include the PM parameters for all cards and ports in the chassis.

Usage Guidelines

The format of MONLEV is LEV-DIRN.
The format of MONDAT is MM-DD, where MM (month of the year) ranges from 1 to 12 and DD (day of the month) ranges from 1 to 31.
The format for MONTM is HH-MM, where HH (hour of the day) ranges from 0 to 23 and MM (minute of the hour) ranges from 0 to 59.
If the TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null if MONTM is not null.
A null value for MONLEV defaults to 1-UP.
A null value for MONDAT defaults to the current date (MM-DD).
A null value for MONTM defaults to the current time (HH-MM).
Unless otherwise stated, DS-1 cards are the only cards that support both the RCV and TRMT directions. All other cards only support the RCV direction.
After MS-SPRing switching, the working path is switched out, the traffic goes through the protection path, and the IPPM can be retrieved from the protection VC path.
If there is a VC PCA on the protection path, during the MS-SPRing switching, the PCA path is preemptive; sending this command on the protection path after a MS-SPRing switch, the command returns the PMs from the protection path, not from the PCA path.
Some MOD2 entities; for example, OCH, CLNT, and Optical (OCn), support negative MONTYPE values. By default, this command defaults to 0-UP (return MONTYPEs where the MONVAL is 0 or higher). To retrieve the negative values, you must issue 0-DN in the MONLEV field. The rules are as follows:
- Client port only-Laser and SDH PMs are applicable and will appear. If the card payload is in SDH mode, then SDH PMs will appear, provided the MONLEV criteria is met.
- Trunk port Laser PMs are always available. Laser PMs are only for near end. If ITU-T G.709 is enabled, then the OTN PMs will appear. If ITU-T G.709 and FEC are enabled, then the FEC PMs will appear. If the card payload is in SDH mode, then SDH PMs will appear. All PM MONVALUEs should pass the MONLEV filter criteria.
For DWDM cards, the MONLEV filter criteria will not support a floating point. It will be returned and interpreted as an integer.
If the DS-1 mode of the DS3XM-12 card is FDL, the DS-1 path can retrieve FDL/T.403 FEND PM counts up to 32 15-minute intervals in the RTRV-PM-DS1 command.
BTH is not supported for the direction. A null value for direction should take care of TRMT and RCV.
RTRV-PM-ALL command can also be used to retrieve the RMON managed PM data.

Category

Performance

Security

Retrieve

Input Format

RTRV-PM-ALL:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<MONLEV>],[<LOCN>], [<DIRECTION>],[<TMPER>],[<DATE>],[<TIME>];

Input Example

RTRV-PM-ALL:TID:FAC-2-1:123::CVL,10-UP,NEND,RCV,15-MIN,04-11,12-45;

Input Parameters

<AID>	The DS1 AID is used access DS1 frame layer of the DS3XM. Format is DS1-[SLOT]-[DS3PORT]-[DS1PORT].
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
CLNT	Client facility
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	GFP over packet over SDH. Virtual ports partitioned using GFP's multiplexing capability.
GIGE	Gigabit Ethernet
HDTV	HDTV
ISC3PEER1G	1 Gbps ISC3 Peer
ISC3PEER2G	2 Gbps ISC3 Peer
ISC3PEER2R	1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1 Gbps ISC1, ISC2, and ISC3 compatibility
STM1	STM1 facility
STM4	STM4 facility
STM16	STM16 facility
STM64	STM64 facility
OCH	Optical channel
OCHCC	OCH client connection
OCHNC	OCH network connection
OCHTERM	OCH termination
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port
VC3	VC3 path
VC4	VC4 path
VC4-2C	VC4-2C path
VC4-3C	VC4-3C path
VC4-6C	VC4-6C path
VC4-4C	VC4-4C path
VC4-8C	VC4-8C path
VC4-12C	VC4-12C path
VC4-16C	VC4-16C path
VC4-64C	VC4-64C path
T1	T1/DS1 facility/line
T3	T3/DS1 facility/line
VC11	VC11 path
VC12	VC12 path
<MONTYPE>	Monitoring type. A null value defaults to all montypes applicable to the modifier. The parameter type is ALL_MONTYPE, which is the monitoring type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed as one tenth of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed as one tenth of a percentage
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CSSP	Controlled Slip Seconds-Path (DSXM-12 FDL/T1.403 PM count)
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESAP	Errored Second Type A-Path (DS3XM-12 DS1 PM count)
ESBP	Errored Second Type B-Path (DS3XM-12 DS1 PM count)
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESNPFE	Errored Second-Network Path (DS3XM-12 DS1 PM count)
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed as one tenth of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed as one tenth of a percentage
ESS	Errored Seconds-Section
ESV	Errored Seconds-VC Path
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count, Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count, Path Generated
HP-OI	High-Order Path, Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds, Path Detected
HP-PJCS-PGEN	High-Order Path Pointer Justification Count Seconds, Path Generated
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count, Path Detected
HP-PPJC-PGEN	High-Order Path, Positive Pointer Justification Count, Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for OC3-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count, Detected
LP-NPJC-GEN	Low Order Negative Pointer Justification Count, Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count, Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count, Generated
LP-SEP	Low-Order Path Severely Errored Period
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count, Path Detected
NPJC-PGEN	Negative Pointer Justification Count, Path Generated
OPR-AVG	Average Receive Power in one tenth of a microwatt
OPR-MAX	Maximum Receive Power in one tenth of a microwatt
OPR-MIN	Minimum Receive Power in one tenth of a microwatt
OPRN	Normalized Optical Receive Power for OC3-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in one tenth of a microwatt
OPT-MAX	Maximum Transmit Power in one tenth of a microwatt
OPT-MIN	Minimum Transmit Power in one tenth of a microwatt
OPTN	Normalized value for Optical Power Transmitted for the OC3-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in one tenth of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in one tenth of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in one tenth of a dBm
PPJC-PDET	Positive Pointer Justification Count, Path Detected
PPJC-PGEN	Positive Pointer Justification Count, Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SEFSP	Severely Errored Framing Seconds-Path (DS3XM-12 DS1 PM count)
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESNPFE	Severely Errored Second-Network Path (DS3XM-12 DS1 PM count)
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed as one tenth of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed as one tenth of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASNPFE	Unavailable Second-Network Path (DS3XM-12 DS1 PM count)
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<MONLEV>	The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>	Location associated with a particular command in reference to the entity identified by the AID. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility
NEND	Action occurs on the near end of the facility
<DIRECTION>	Type of direction. Must not be null. The parameter type is DIRECTION (transmit and receive directions).
BTH	Both transmit and receive directions.
RCV	Receive direction only.
TRMT	Transmit direction only.
<TMPER>	Accumulation time period for performance counters. If TMPER is 1-DAY, MONTM is not applicable (null), and is treated as null. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length; every 24-hours. For SDH PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<DATE>	The beginning date of the PM or storage register period specified in TMPER. The format of DATE is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. A null value defaults to current date.
<TIME>	The beginning time of day of the PM or storage register period specified in TMPER. The format of TIME is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. A null value defaults to current time.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],[<DIRECTION>], [<TMPER>],[<MONDAT>],[<MONTM>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1,DS1-14:CVL,21,COMPL,NEND,RCV,15-MIN,04-11,12-45" ;

Output Parameters

<AID>	The DS1 AID is used access DS1 frame layer of the DS3XM. Format is DS1-[SLOT]-[DS3PORT]-[DS1PORT].
<AIDTYPE>	(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
BITS	BITS alarm
CLNT	Client facility for MXP/TXP cards
COM	Common alarm
DS1	DS1 alarm
DS3I	DS3I alarm
E100	E100 alarm
E1000	E1000 alarm
EC1	EC1 alarm
ENV	ENV alarm
EQPT	EQPT alarm
FSTE	Fast Ethernet Port alarm
G1000	G1000 alarm
GIGE	Gigabit Ethernet port alarm
ISC3PEER1G	1-Gbps ISC3 Peer
ISC3PEER2G	2 Gbps ISC3 Peer
ISC3PEER2R	1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1 Gbps ISC1, ISC2, and ISC3 compatibility
STM1	STM1 alarm
STM4	STM4 alarm
STM16	STM16 alarm
STM64	STM64 alarm
OCH	Optical channel
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port alarm
VC3	VC3 alarm
VC4	VC4 alarm
VC4-2C	VC4-2C alarm
VC4-3C	VC4-3C alarm
VC4-6C	VC4-6C alarm
VC4-4C	VC4-4C alarm
VC4-8C	VC4-8C alarm
VC4-12C	VC4-12C alarm
VC4-16C	VC4-16C alarm
VC4-64C	VC4-64C alarm
SYNCN	SYNCN alarm
T1	T1 alarm
T3	T3 alarm
TCC	TCC alarm
VC11	VC11 alarm
VC12	VC12 alarm
<MONTYPE>	Monitored type. The parameter type is ALL_MONTYPE, which is the monitoring type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed as one tenth of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed as one tenth of a percentage
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CSSP	Controlled Slip Seconds-Path (DSXM-12 FDL/T1.403 PM count)
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESAP	Errored Second Type A-Path (DS3XM-12 DS1 PM count)
ESBP	Errored Second Type B-Path (DS3XM-12 DS1 PM count)
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESNPFE	Errored Second-Network Path (DS3XM-12 DS1 PM count)
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor point expressed as one tenth of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor point expressed as one tenth of a percentage
ESS	Errored Seconds-Section
ESV	Errored Seconds-VC Path
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count, Path Detected
HP-NPJC-PGEN	High-Order Path, Negative Pointer Justification Count, Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds, Path Detected
HP-PJCS-PGEN	High-Order Path Pointer Justification Count Seconds, Path Generated
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count, Path Detected
HP-PPJC-PGEN	High-Order Path, Positive Pointer Justification Count, Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for OC3-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count, Detected
LP-NPJC-GEN	Low Order Negative Pointer Justification Count, Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count, Detected
LP-PPJC-GEN	Low-Order positive Pointer Justification Count, Generated
LP-SEP	Low-Order Path Severely Errored Period
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count, Path Detected
NPJC-PGEN	Negative Pointer Justification Count, Path Generated
OPR-AVG	Average Receive Power in one tenth of a microwatt
OPR-MAX	Maximum Receive Power in one tenth of a microwatt
OPR-MIN	Minimum Receive Power in one tenth of a microwatt
OPRN	Normalized Optical Receive Power for OC3-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in one tenth of a microwatt
OPT-MAX	Maximum Transmit Power in one tenth of a microwatt
OPT-MIN	Minimum Transmit Power in one tenth of a microwatt
OPTN	Normalized value for Optical Power Transmitted for the OC3-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in one tenth of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in one tenth of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in one tenth of a dBm
PPJC-PDET	Positive Pointer Justification Count, Path Detected
PPJC-PGEN	Positive Pointer Justification Count, Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SEFSP	Severely Errored Framing Seconds-Path (DS3XM-12 DS1 PM count)
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESNPFE	Severely Errored Second-Network Path (DS3XM-12 DS1 PM count)
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed as one tenth of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed as one tenth of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASNPFE	Unavailable Second-Network Path (DS3XM-12 DS1 PM count)
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<MONVAL>	The value to which the register identified by MONTYPE is to be initialized to or the measured value of a monitored parameter. The value is in the form of numeric counts or rates. MONVAL is a string.
<VLDTY>	(Optional) Indicates whether the information for the specified time period was accumulated over the entire time period or some portion thereof. Validity indicator for the reported PM data. The parameter type is VALIDITY, which is the response validity.
COMPL	Complete response
PRTL	Partial response
<LOCN>	(Optional) Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<DIRECTION>	The PM count retrieval direction. The parameter type is DIRECTION, which is the transmit and receive directions.
BTH	Both transmit and receive directions
RCV	Receive direction only
TRMT	Transmit direction only
<TMPER>	(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length; every 24-hours. For SDH PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<MONDAT>	(Optional) The beginning date of the PM or storage register period specified in TMPER. The format of MONDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31. MONDAT is a string.
<MONTM>	(Optional) The beginning time of day of the PM or storage register period specified in TMPER. The format of MONTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59. MONTM is a string.

RTRV-PMMODE-<VC_PATH>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Performance Mode of PM Data Collection for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, or VC43C (RTRV-PMMODE-<VC_PATH>) command retrieves the type of PM mode that has been previously set in the NE. This command can be used to identify whether the PM parameters are Section, Line, or Path type, and to identify whether or not the PM are being collected by the NE.

Usage Guidelines

See Table 27-1 for supported modifiers by platform.
The PM mode and state of an entity is set by using the SET-PMMODE command.
This command returns the categories that are enabled only.
This near-end monitoring of the IPPM only supports STM1, STM4, STM16, and STM64 on VC Path.
The far-end IPPM data collection is supported by the MRC-12 card only.
This release of software will support only the Path (P) mode type PM parameters with this command, that is, this command will not be applicable for Line (L) and Section (S) mode types. It should be noted that the PM monitoring for Line (L) and Section (S) are supported by the ONS 15454 SDH, and storing of PM data is always performed.

Category

Performance

Security

Retrieve

Input Format

RTRV-PMMODE-<VC_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>;

Input Example

RTRV-PMMODE-VC3:CISCO:VC4-4-1-2:123::NEND;

Input Parameters

<SRC>	Source access identifier from the CrossConnectId.
<LOCN>	Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Must not be null. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.

Output Format

SID DATE TIME M CTAG COMPLD "<CROSSCONNECTID>:[<LOCN>],<MODETYPE>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VC4-4-1-2:NEND,P" ;

Output Parameters

<CROSSCONNECTID>	Access identifier from the CrossConnectId.
<LOCN>	(Optional) Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<MODETYPE>	The type of PM parameters that the entity or the sub entity is to store as a result of an attribute change. The parameter type is PM_MODE, which is the type of PM parameters.
P	Transport Path PM parameters

RTRV-PMSCHED-<MOD2>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Performance Monitoring Schedule for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS3I, DV6000, E1, E3, E4, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-PMSCHED-<MOD2>) command retrieves the PM reporting schedule that was set for the NE by the SCHED-PMREPT command. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

None

Category

Performance

Security

Retrieve

Input Format

RTRV-PMSCHED-<MOD2>:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-PMSCHED-STM1:CISCO-NODE:FAC-3-1:123;

Input Parameters

<AID>

Access identifier from the ALL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],, [<MONLEV>],<LOCN>,,[<TMPER>],[<TMOFST>],[<INHMODE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-3-1,STM1:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW" ;

Output Parameters

<AID>	Access identifier from the ALL.
<AIDTYPE>	(Optional) Type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2, which is the line/path modifier.
10GFC	10-Gigabit Fibre Channel payload
10GIGE	10-Gigabit Ethernet
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
D1VIDEO	D1 Video
DS3I	DS3i-N-12 Line
DV6000	DV6000
E1	E1
E3	E3
E4	E4 frame, only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode
ESCON	ESCON
ETRCLO	ETRCLO
FSTE	FSTE facility
G1000	G1000 facility
GFPOS	GFP over POS, virtual ports partitioned using GFP's multiplexing capability
GIGE	Gigabit Ethernet
HDTV	HDTV
ISC3PEER1G	1-Gbps ISC3 peer
ISC3PEER2G	2-Gbps ISC3 peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
STM1	STM1 facility
STM4	STM4 facility
STM16	STM16 facility
STM64	STM64 facility
OCH	Optical channel
OCHCC	OCH client connection
OCHNC	OCH network connection
OCHTERM	OCH termination
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port
STM1E	STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card
VC3	VC3 path
VC44C	VC44C path
VC38C	VC38C path
VC464C	VC464C path
VC48C	VC48C path
VC4	VC4 path
VC416C	VC416C path
VC42C	VC42C path
VC43C	VC43C path
VC11	VC11 path
VC12	VC12 path
<REPTINVL>	Reporting interval. How often a report is to be generated and sent to the appropriate NE. REPTINVL is a string.
<REPTDAT>	Report date. Date for the next report. REPTDAT is a string.
<REPTTM>	Report time. The time of day for the next PM report. REPTTM is a string. Note: PM schedule processing is performed every 5 minutes. Therefore, specifying a REPTINVL of 5-MIN or less would be processed at the earliest every 5 minutes.
<NUMINVL>	(Optional) The remaining number of intervals over which PM is to be reported. NUMINVL is an integer.
<MONLEV>	(Optional) The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>	Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<TMPER>	(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length is every 24 hours. For SDH PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<TMOFST>	(Optional) Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. TMOFST is a string.
<INHMODE>	(Optional) Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). The parameter type is INH_MODE, which indicates whether or not the function is inhibited.
ALW	Function is allowed.
INH	Function is inhibited.

RTRV-PMSCHED-ALL

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Performance Schedule All (RTRV-PMSCHED-ALL) command retrieves all the PM reporting schedules that were set for the NE using the SCHED-PMREPT command.

Usage Guidelines

None

Category

Performance

Security

Retrieve

Input Format

RTRV-PMSCHED-ALL:[<TID>]::<CTAG>;

Input Example

RTRV-PMSCHED-ALL:CISCO-NODE::123;

Input Parameters

None

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMINVL>],, [<MONLEV>],<LOCN>,,[<TMPER>],<TMOFST>,[<INHMODE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-3-1,STM1:30-MIN,5-25,14-46,100,,1-UP,NEND,,15-MIN,0-0-15,ALW" ;

Output Parameters

<AID>	Access identifier from the ALL.
<AIDTYPE>	(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2, which is the line/path modifier.
10GFC	10-Gigabit Fibre Channel payload
10GIGE	10-Gigabit Ethernet
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
D1VIDEO	D1 Video
DS3I	DS3i-N-12 Line
DV6000	DV6000
E1	E1
E3	E3
E4	E4 frame, only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode
ESCON	ESCON
ETRCLO	ETRCLO
FSTE	FSTE facility
G1000	G1000 facility
GFPOS	GFP over POS, virtual ports partitioned using GFP's multiplexing capability
GIGE	Gigabit Ethernet
HDTV	HDTV
ISC3PEER1G	1-Gbps ISC3 Peer
ISC3PEER2G	2-Gbps ISC3 Peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
STM1	STM1 facility
STM4	STM4 facility
STM16	STM16 facility
STM64	STM64 facility
OCH	Optical channel
OCHCC	OCH client connection
OCHNC	OCH network connection
OCHTERM	OCH termination
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port
STM1E	STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card
VC3	VC3 path
VC44C	VC44C path
VC38C	VC38C path
VC464C	VC464C path
VC48C	VC48C path
VC4	VC4 path
VC416C	VC416C path
VC42C	VC42C path
VC43C	VC43C path
VC11	VC11 path
VC12	VC12 path
<REPTINVL>	Reporting interval. How often a report is to be generated and sent to the appropriate NE. REPTINVL is a string.
<REPTDAT>	Report date. Date for the next report. REPTDAT is a string.
<REPTTM>	Report time. The time of day for the next PM report. REPTTM is a string.
<NUMINVL>	(Optional) The remaining number of intervals over which PM is to be reported. NUMINVL is an integer.
<MONLEV>	(Optional) The discriminating level of the requested monitored parameter in the format of LEVEL-DIRN, where LEVEL is the measured value of the monitored parameter (MONVAL) and DIRN is the type of direction. A null value defaults to 1-UP. MONLEV is a string.
<LOCN>	Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<TMPER>	(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length is every 24 hours. For SDH PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.
<TMOFST>	(Optional) Time offset between reporting/diagnostics/exercises; from the end of the last complete accumulation time period to the beginning of the accumulation time period specified by TMPER. TMOFST is a string.
<INHMODE>	(Optional) Indicates whether a function is inhibited by an INH command. Indicates whether the reporting of PM data is inhibited (by the INH-PMREPT-ALL command) or is allowed (by the ALW-PMREPT-ALL command). The parameter type is INH_MODE, which indicates whether the function is inhibited.
ALW	Function is allowed.
INH	Function is inhibited.

RTRV-POS

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Packet Over SDH (RTRV-POS) command retrieves the back-end port information for the Ethernet card when the back-end port is working in POS mode.

Usage Guidelines

RTRV-POS is supported for ML-Series cards.
For ML-Series cards, the EDGE, RPRSPAN, JUMBO, ADMINSTATE, ENCAP, and NAME parameters are valid when the card mode is in ML-IEEE-RPR. Other parameters, including PST and SST, are not valid.
Because the back-end port is virtual, the Virtual Facility (VFAC) AID should be used when issuing the command.

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-POS:TID:VFAC-1-1:CTAG;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[ADMINSTATE=<ADMINSTATE>],[JUMBO=<MTU>],[ENCAP=<ENCAP>], [RPRSPAN=<RPRSPAN>],[EDGE=<EDGE>],[NAME=<NAME>]:"; ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VFAC-1-1::ADMINSTATE=DOWN,JUMBO=N,ENCAP=RPR-GFP-F,RPRSPAN=EAST, EDGE=Y,NAME=\"RPR\":" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<ADMINSTATE>	(Optional) Administration state. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<ENCAP>	(Optional) Frame encapsulation type
RPR-GFP-F	RPR-over-GFP frame mode
<JUMBO>	Jumbo frame values
Y	Yes
N	No
<RPRSPAN>	RPR span values
EAST	East direction
WEST	West direction
<EDGE>	RPR edge values
Y	Yes
N	No
<NAME>	Port name, facility name, or VCAT group name.

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

(Cisco ONS 15454 SDH) The Retrieve Protection Switch for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RTRV-PROTNSW-<MOD2DWDMPAYLOAD>) command retrieves the protection switch status of client facilities.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>:[<TID>]:<SRC>:<CTAG>[::::];

Input Example

RTRV-PROTNSW-HDTV:CISCO:FAC-1-1-1:100;

Input Parameters

<SRC>

Source access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AIDUNIONID>:<SC>,[<SWITCHTYPE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1-1:FRCD,MANWKSWBK" ;

Output Parameters

<AIDUNIONID>	Access identifier from the FACILITY.
<SC>	Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
MAN	Requests a manual switch of the facility.
<SWITCHTYPE>	(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lock out of protection
LOCKOUTOFWK	Lock out of working
MANWKSWBK	Manual switch of working unit back to working
MANWKSWPR	Manual switch of working unit back to the protection unit
RING	MS-SPRing switch type
SPAN	MS-SPRing span switch type

RTRV-PROTNSW-<STM_TYPE>

(Cisco ONS 15454 SDH) The Retrieve Protection Switch for STM1, STM4, STM16, or STM64 (RTRV-PROTNSW=<STM_TYPE>) command retrieves the switching state of a SDH line specified in the AID. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

None

Category

Protection

Security

Retrieve

Input Format

RTRV-PROTNSW-<STM_TYPE>:[<TID>]:<AID>:<CTAG>[::::];

Input Example

RTRV-PROTNSW-STM16:CISCO:FAC-5-1:123;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<SC>,[<SWITCHTYPE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-5-1:MAN,MANWKSWBK" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<SC>	Switch command to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
MAN	Requests a manual switch of the facility.
<SWITCHTYPE>	(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lock out of protection
LOCKOUTOFWK	Lock out of working
MANWKSWBK	Manual switch of working unit back to working
MANWKSWPR	Manual switch of working unit back to the protection unit
RING	MS-SPRing switch type
SPAN	MS-SPRing span switch type

RTRV-PROTNSW-<PATH>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Protection Switch for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-PROTNSW-<PATH>) command retrieves the switching state of a SDH SNCP VC path specified in the AID. Because Telcordia GR-1400 does not allow LOCKOUT_OF_WORKING on the SNCP WORKING path/AID, the "AID:LOCKOUT,LOCKOUTOFWK" is not presented in the protection switch retrieval result. See Table 27-1 for supported modifiers by platform.

Note: RTRV-PROTNSW-VT1 accepts STS-1 AID when STS-1 cross connection is made using the DS1 card. This will allow the user to retrieve all the VT1 conditions/alarms that are raised by DS-1 card when STS-1 cross connect is created.

Usage Guidelines

None

Category

Protection

Security

Retrieve

Input Format

RTRV-PROTNSW-<PATH>:[<TID>]:<SRC>:<CTAG>[::::];

Input Example

RTRV-PROTNSW-VC3:CISCO:VC4-5-1-1:123;

Input Parameters

<SRC>

Source access identifier from the CrossConnectId.

Output Format

SID DATE TIME M CTAG COMPLD "<CROSSCONNECTID>:<SC>,[<SWITCHTYPE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VC4-5-1-1:MAN,MANWKSWBK" ;

Output Parameters

<CROSSCONNECTID>	Access identifier from the CrossConnectId.
<SC>	Switch command that is to be initiated on the paths. The parameter type is SW, which is the type of switch to be initiated.
APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
MAN	Requests a manual switch of the facility.
<SWITCHTYPE>	(Optional) Switch type. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lock out of protection
LOCKOUTOFWK	Lock out of working
MANWKSWBK	Manual switch of working unit back to working
MANWKSWPR	Manual switch of working unit back to the protection unit
RING	MS-SPRing switch type
SPAN	MS-SPRing span switch type

RTRV-PROTNSW-OCH

(Cisco ONS 15454 SDH) The Retrieve Protection Switch Optical Channel (RTRV-PROTNSW-OCH) command retrieves the protection switch status of a TXPP_MR_2.5G card.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

RTRV-PROTNSW-OCH:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-PROTNSW-OCH:VA454-22:CHAN-2-2:100;

Input Parameters

<AID>

Access identifier from the CHANNEL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<SW>,<SWTYPE>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-2-2:FRCD,FRCDWKSWBK" ;

Output Parameters

<AID>	Access identifier from the CHANNEL.
<SW>	Indicates the switch operation. The parameter type is SW, which is the type of switch to be initiated.
APS-CLEAR	APS-CLEAR switch state. It is a read-only switch state and is not allowed in the OPR-PROTNSW-xxx commands.
CLEAR	CLEAR switch state. The CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. The EXERCISE switch state is not allowed in the OPR-PROTNSW-xxx commands.
FRCD	Forces a switch unless another FRCD or LOCKOUT is in effect.
LOCKOUT	Locks the facility out of switching. The system cannot switch to this facility to carry service.
MAN	Requests a manual switch of the facility.
<SWITCHTYPE>	Indicates the switch type operation. The parameter type is SWITCH_TYPE, which is the MS-SPRing switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-STM commands. They are not applicable for the OPR-PROTNSW-STM commands. RING and SPAN are the only allowed values for MS-SPRing protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lock out of protection
LOCKOUTOFWK	Lock out of working
MANWKSWBK	Manual switch of working unit back to working
MANWKSWPR	Manual switch of working unit back to the protection unit
RING	MS-SPRing switch type
SPAN	MS-SPRing span switch type

RTRV-PROTOCOL

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Protocol (RTRV-PROTOCOL) command retrieves the status of a protocol/service supported in the NE. Valid protocols include: SHELL, EMS, TL1, and SNMP. If the AID is not specified, the status of all of the protocols is retrieved.

Usage Guidelines

If the AID is TL1, the status can be retrieved to show if the protocol is in SECURE or UNSECURE mode.

Category

Security

Retrieve

Input Format

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

Input Example

RTRV-PROTOCOL::EMS:123;

Input Parameters

<AID>	(Optional) Identifies the protocol/service to which the command pertains. Defaults to ALL. A null value is equivalent to ALL. The parameter type is PROTOCOLAID, which is the AID for the protocol/service.
EMS	CTC or CTM protocol/service
SHELL	Shell/file system access protocol
SNMP	SNMP protocol/service
TL1	TL1 protocol service

Output Format

SID DATE TIME M CTAG COMPLD "<PROTOCOLAID>:<PROTOCOLSTAT>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "EMS:UNSECURE" ;

Output Parameters

<PROTOCOLAID>	Identifies the protocol/service to which the command pertains. The parameter type is PROTOCOLAID, which is the AID for the protocol/service.
EMS	CTC or CTM protocol/service
SHELL	Shell/file system access protocol
SNMP	SNMP protocol/service
TL1	TL1 protocol service
<PROTOCOLSTAT>	Identifies the status of the protocol/service. The parameter type is PROTOCOLSTAT, which is the status of the protocol.
DISABLED	The protocol cannot be used
SECURE	The protocol is enabled and communications using the protocol are sure, for example, through SSH. Not applicable for SNMP protocols.
UNSECURE	The protocol is enabled but communication is not secure, for example, through Telnet.

RTRV-PTHTRC-<PATH>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Path Trace for VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, VC12 (RTRV-PTHTRC-<PATH>) command retrieves the contents of the SDH path trace message. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

The path trace message is a 64-character string with the last two characters reserved for the terminating CR (carriage return) and the LF (line feed). The message can be an incoming path trace message, an expected incoming path trace message, or an outgoing path trace message that is inserted into the path overhead of the outgoing signal.

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

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

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

When the transmitted string is queried under the OFF, MANUAL, or AUTO path trace mode, the transmitted string is the provisioned transmit string.

Notes:

A null value for the <MSGTYPE> defaults to INCTRC.
Only the NEND of the location value is supported. A null value of the location defaults to NEND.
Sending a FEND of the location with this command will return an "unsupported LOCN value" error message.
J1 (EXPTRC/INCTRC) is implemented on the E1, E3, E4, DS3i-N-12, STM, MRC-12, and STM64-XFP cards.
TRC is supported only on E1, E3, E4, DS3i-N-12, MRC-12, and STM64-XFP cards.
The virtual facility AID (VFAC) is only valid on slots holding ML-Series cards.
After the MS-SPRing switch, the working path is switched out and the traffic goes through the protection path. The J1 trace message can be retrieved from the protection VC path.
If there is an VC PCA on the protection path during the MS-SPRing switch, the PCA path is preemptive. If this command is sent on the protection path after a MS-SPRing switch, the command will return the trace message off of the protection path and not from the PCA path.
According to Telcordia GR-833, RTRV-PTHTRC-<PATH> can only have a single output row. Therefore, you cannot specify multiple AIDs using "&'" with this command because each AID would require its own output row. You also cannot use AIDs that end in "ALL" because this might also result in multiple output rows.

Category

Troubleshooting and Test Access

Security

Retrieve

Input Format

RTRV-PTHTRC-<PATH>:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>][:<LOCN>];

Input Example

RTRV-PTHTRC-VC3:CISCO:VC4-2-1-1:123::EXPTRC:NEND;

Input Parameters

<SRC>	Source access identifier from the CrossConnectId.
<MSGTYPE>	Type of autonomous message to be retrieved. A null value defaults to INCTRC. The parameter type is MSGTYPE, which is the type of trace message.
EXPTRC	Expected incoming path trace message
INCTRC	Incoming path trace message
TRC	Outgoing path trace message
<LOCN>	Location associated with a particular command in reference to the entity identified by the AID. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.

Output Format

SID DATE TIME M CTAG COMPLD "<TRACMSG>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "TRACMSG" ;

Output Parameters

The path trace message returned to the requester. The message can be up to 64 characters in length with the last two characters reserved for the CR and LF. TRACMSG is a string.

RTRV-QNQ-ETH

(Cisco ONS 15454 SDH) The Retrieve QinQ Ethernet (RTRV-QNQ-ETH) command retrieves the IEEE 802.1Q tunneling (QinQ) relationship between the CE-VLAN and the S-VLAN for Gigabit Ethernet uniport provisioning associated to an L2 Ethernet port.

Usage Guidelines

None

Category

Ethernet

Security

Retrieve

Input Format

RTRV-QNQ-ETH:[<TID>]:<AID>:<CTAG>::<FIRSTCEVLANID>,<LASTCEVLANID>, <SVLANID>[:];

Input Example

RTRV-QNQ-ETH:PETALUMA:ETH-1-1-1:238::110,110,1208;

Input Parameters

<AID>	Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.
<FIRSTCEVLANID>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LASTCEVLANID>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<SVLANID>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<FIRSTCEVLANID>,<LASTCEVLANID>,<SVLANID>:RULE=<RULE>[:]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "ETH-1-1-1:110,111,1208:RULE=XLTE:" ;

Output Parameters

<AID>	Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.
<FIRSTCEVLANID>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<LASTCEVLANID>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<SVLANID>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<RULE>	Used to represent the Rules allowed for VLAN tagging operations. Default is ADD.
ADD	The S-VLAN tag is added to the CE-VLAN tag.
XLTE	The S-VLAN tag substitutes the CE-VLAN tag (single Q).

RTRV-RMONTH-<MOD2_RMON>

(Cisco ONS 15454 SDH) The Retrieve Remote Monitoring Threshold for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, 4GFC, 4GFICON, FSTE, G1000, ETH, GFPOS, GIGE, ISCCOMPAT, ISC3PEER1G, ISC3PEER2G, OCH, POS (RTRV-RMONTH-<MOD2_RMON>) command retrieves the thresholds defined in the RMON alarm table. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

None

Category

Performance

Security

Retrieve

Input Format

RTRV-RMONTH-<MOD2_RMON>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],,,, [<INTVL>]:[RISE=<RISE>],[FALL=<FALL>],[SAMPLE=<SAMPLE>], [STARTUP=<STARTUP>][:];

Input Example

RTRV-RMONTH-GIGE:CISCO:FAC-2-1:1234::ETHERSTATSOCTETS,,,,100:RISE=1000, FALL=100,SAMPLE=DELTA,STARTUP=RISING;

Input Parameters

<AID>	Access identifier from the FACILITY. AID for the facility that the data statistic is managed by.
<MONTYPE>	(Optional) Monitored type. Type of RMON monitored data statistic. A null value is equivalent to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage.
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage.
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
dot3StatsFCSErrors	A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
dot3StatsFrameTooLong	A count of frames received on a particular interface that exceed the maximum permitted frame size.
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count - Path Detected
HP-NPJC-PGEN	High-Order Path Pointer Justification Count Seconds - Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in one tenth of a microwatt
OPR-MAX	Maximum Receive Power one tenth of a microwatt
OPR-MIN	Minimum Receive Power in one tenth of a microwatt
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed in tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed in tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<INTVL>	(Optional) The interval in seconds over which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds). A null value is equivalent to ALL.
<RISE>	(Optional) The rising threshold for the sampled statistic. A valid value is any integer. A null value is equivalent to ALL.
<FALL>	(Optional) The falling threshold. A valid value is any integer smaller than the rising threshold. A null value is equivalent to ALL.
<SAMPLE>	(Optional) The method of calculating the value to be compared to the thresholds. A null value is equivalent to ALL. The parameter type is SAMPLE_TYPE, which describes how the data will be calculated during the sampling period.
ABSOLUTE	Comparing directly
DELTA	Comparing with the current value of the selected variable subtracted from the last sample
<STARTUP>	(Optional) Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. A null value is equivalent to ALL. The parameter type is STARTUP_TYPE, which indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold.
FALLING	Generates the event when the sample is smaller than or equal to the falling threshold.
RISING	Generates the event when the sample is greater than or equal to the rising threshold.
RISING-OR-FALLING	Generates the event when the sample is crossing the rising threshold or the falling threshold.

Output Format

SID DATE TIME M CTAG COMPLD "<AIDUNIONID>,<AIDTYPE>:<MONTYPE>,,,,<INTVL>:INDEX=<INDEX>, RISE=<RISE>,FALL=<FALL>,SAMPLE=<SAMPLE>,STARTUP=<STARTUP>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1,GIGE:ETHERSTATSOCTETS,,,,100:INDEX=2,RISE=1000,FALL=100, SAMPLE=DELTA,STARTUP=RISING" ;

Output Parameters

<AIDUNIONID>	Access identifier from the FACILITY.
<AIDTYPE>	The type of facility, link or other addressable entity targeted by the message. The parameter type is MOD2_RMON, which is the line modifier.
10GFC	10-Gigabit Fibre Channel payload
10GIGE	10-Gigabit Ethernet
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
FSTE	Fast Ethernet (10/100 Megabits per second)
G1000	Gigabit Ethernet (used for G1000 ports)
GFPOS	Generic framing protocol over SDH
GIGE	Gigabit Ethernet (used for non-G1000 ports)
OCH	Optical channel
POS	Packet over SDH
<MONTYPE>	Monitored type. Type of RMON monitored data statistic. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
dot3StatsFCSErrors	A count of frames received on a particular interface that are an integral number of octets in length but do not pass the FCS check.
dot3StatsFrameTooLong	A count of frames received on a particular interface that exceed the maximum permitted frame size.
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including frame check sequence [FCS] octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count-Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count-Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive severely errored seconds (SES)
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Multiplex Section-Protection switch count
MS-PSD	Multiplex Section-Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in tenths of a microW
OPR-MAX	Maximum Receive Power in tenths of a microW
OPR-MIN	Minimum Receive Power in tenths of a microW
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed in tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed in tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<INTVL>	The interval in seconds over which the data is sampled and compared with the rising and falling threshold. A valid value is any integer larger than or equal to 10 (seconds).
<INDEX>	The index for the threshold created by the system in the RMON threshold table. INDEX is an integer.
<RISE>	The rising threshold for the sampled statistic. A valid value is any integer.
<FALL>	The falling threshold. A valid value is any integer smaller than the rising threshold.
<SAMPLE>	The method of calculating the value to be compared to the thresholds. The parameter type is SAMPLE_TYPE, which describes how the data will be calculated during the sampling period.
ABSOLUTE	Comparing directly
DELTA	Comparing with the current value of the selected variable subtracted by the last sample
<STARTUP>	Dictates whether an event will generate if the first valid sample is greater than or equal to the rising threshold, less than or equal to the falling threshold, or both. The parameter type is STARTUP_TYPE, which indicates whether an event will be generated when the first valid sample is crossing the rising or falling threshold.
FALLING	Generates the event when the sample is smaller than or equal to the falling threshold.
RISING	Generates the event when the sample is greater than or equal to the rising threshold.
RISING-OR-FALLING	Generates the event when the sample is crossing the rising threshold, or the falling threshold.

RTRV-ROLL-<MOD_PATH>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Roll for VC3, VC44C, VC464C, VC48C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-ROLL-<MOD_PATH>) command retrieves roll data parameters. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

None

Category

Bridge and Roll

Security

Retrieve

Input Format

RTRV-ROLL-<MOD_PATH>:[<TID>]:<SRC>:<CTAG>;

Input Example

RTRV-ROLL-VC3:CISCO:VC4-1-1-1:6;

Input Parameters

<SRC>

Source access identifier from the VC. Roll path (VC).

Output Format

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

Output Example

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

Output Parameters

<FROM>	One of the termination points (legs) of the existing cross-connection. AID from the VC.
<TO>	One of the termination points (legs) of the existing cross-connection. AID from the VC.
<RFROM>	The termination point of the existing cross-connect that is to be rolled. AID from the VC.
<RTO>	The termination point that will become a leg of the new cross-connection. AID from the VC.
<RMODE>	(Optional) The rolling mode of operation. The parameter type is RMODE, which specifies the roll mode.
AUTO	Automatic. When a valid signal is available, the roll under AUTO mode will automatically delete the previous endpoint.
MAN	Manual. Enter the corresponding delete roll/bulkroll command to delete the previous endpoint.
<VLDSIG>	Shows whether or not the roll has received a valid signal. VLDSIG is Y if the signal is valid and N if it is not. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.

RTRV-ROUTE

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Route (RTRV-ROUTE) command retrieves static routes.

Usage Guidelines

There is no Domain Name Server (DNS) service available on the node. Only numeric IP addresses will be accepted.
The optional parameters DESTIP, IPMASK, NXTHOP, and COST are used to filter the retrieved static routes. In the absence of any optional parameter, all the static routes on the node will be retrieved.

Category

System

Security

Retrieve

Input Format

RTRV-ROUTE:[<TID>]::<CTAG>::[<DESTIP>],[<IPMASK>],[<NXTHOP>],[<COST>];

Input Example

RTRV-ROUTE:CISCO::123::10.64.72.57,255.255.255.0,10.64.10.1,200;

Input Parameters

<DESTIP>	(Optional) Destination IP. DESTIP is a string. A null value is equivalent to ALL.
<IPMASK>	(Optional) IP mask. IPMASK is a string. A null value is equivalent to ALL.
<NXTHOP>	(Optional) Next hop. NXTHOP is a string. A null value is equivalent to ALL.
<COST>	(Optional) Unsigned integer. Valid range is from 1 to 32,797. A null value is equivalent to ALL.

Output Format

SID DATE TIME M CTAG COMPLD ",:<DESTIP>,<IPMASK>,<NXTHOP>,<COST>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD ",:\"10.64.72.57\",\"255.255.255.0\",\"10.64.10.1\",200" ;

Output Parameters

<DESTIP>	Destination IP. DESTIP is a string.
<IPMASK>	IP mask. IPMASK is a string.
<NXTHOP>	Next hop. NXTHOP is a string.
<COST>	Cost. COST is an integer.

RTRV-ROUTE-GRE

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Route Generic Routing Encapsulation (RTRV-ROUTE-GRE) command displays the existing GRE tunnels.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

RTRV-ROUTE-GRE:[<TID>]::<CTAG>[::::];

Input Example

RTRV-ROUTE-GRE:CISCO::123;

Input Parameters

None

Output Format

SID DATE TIME M CTAG COMPLD ",:IPADDR=<IPADDR>,IPMASK=<IPMASK>,NSAP=<NSAP>,COST=<COST>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD ",:IPADDR=10.64.72.57,IPMASK=255.255.255.0, NSAP=39840F80FFFFFF0000DDDDAA000010CFB4910200,COST=110" ;

Output Parameters

<IPADDR>	IP address of the tunnel endpoint. IPADDR is a string.
<IPMASK>	Subnet mask for the tunnel endpoint. IPMASK is a string.
<NSAP>	NSAP address for the tunnel endpoint. NSAP is a string.
<COST>	Routing cost associated with the tunnel. COST is an integer.

RTRV-SLV-WDMANS

(Cisco ONS 15454 SDH) The Retrieve Span Loss Verification Wavelength Division Multiplexing Automatic Node Setup (RTRV-SLV-WDMANS) command retrieves the expected span loss verification provisioned by the ED-SLV-WDMANS command.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

RTRV-SLV-WDMANS:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-SLV-WDMANS:VA454-22:WDMANS-E:116;

Input Parameters

<AID>

Access identifier from the WDMANS.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[HIGHSLVEXP=<HIGHSLVEXP>],[LOWSLVEXP=<LOWSLVEXP>], [SLVACT=<SLVACT>],[RESOLUTION=<RESOLUTION>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "WDMANS-E::HIGHSLVEXP=10.0,LOWSLVEXP=5.0,SLVACT=10.0,RESOLUTION=1.0:" ;

Output Parameters

<AID>	Access identifier from the WDMANS.
<HIGHSLVEXP>	(Optional) The high range value of the expected span loss verification. HIGHSLVEXP is a float.
<LOWSLVEXP>	(Optional) The low range value of the expected span loss verification. LOWSLVEXP is a float.
<SLVACT>	(Optional) The value of the calculated span loss verification. SLVACT is a float.
<RESOLUTION>	(Optional) The value of the resolution applied to the calculated span loss verification. RESOLUTION is a float.

RTRV-STM1E

(Cisco ONS 15454 SDH) The Retrieve STM1E (RTRV-STM1E) command retrieves the attributes and state information of a STM1E facility.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-STM1E:CISCO1:FAC-6-1:8888;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[PAYLOAD=<PAYLOAD>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>], [PJMON=<PJMON>],[SFBER=<SFBER>],[SDBER=<SDBER>],[SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-6-1::PAYLOAD=STM1E,SYNCMSG=Y,SENDDUS=N,PJMON=48,SFBER=1E-4, SDBER=1E-6,SOAK=10,SOAKLEFT=12-25,NAME=\"STM1EPORT\":UNLOCKED-DISABLED, AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<PAYLOAD>	(Optional) The payload for the card. The parameter type is PAYLOAD, which identifies the payload type.
10GFC	10-Gigabit Fibre Channel payload
10GIGE	10-Gigabit Ethernet
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
DV6000	Video mode
E4-FRAMED	E4-FRAMED payload mode for SDH STM1E-12 card
E4-UNFRAMED	E4-UNFRAMED payload mode for SDH STM1E-12 card
ESCON	ESCON mode
ETRCLO	ETR/CLO payload mode
GIGE	Gigabit Ethernet Payload
HDTV	HDTV mode
ISC1	ISC1 mode
ISC3	ISC3 mode
STM4	SDH STM4 mode
STM1	SDH STM1 mode
STM16	SDH STM16 mode
STM1E	SDH STM1E payload mode
PASS-THROUGH	Pass-through mode
SDH	SDH Payload mode
SDI-D1-VIDEO	SDI-D1-Video mode
<SYNCMSG>	(Optional) Indicates if synchronization messaging is enabled or disabled. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<SENDDUS>	(Optional) Indicates if the facility will send the DUS value as the synchronization message. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<PJMON>	Identifies an STM port PJMON. PJMON is an integer.
<SFBER>	(Optional) The port signal failure threshold. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) Port signal degrade threshold. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
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.
<SOAK>	(Optional) Locked-Automatic In Service to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>	(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows: When the port is in Locked;Locked,Maintenance; or Unlocked state, the parameter is not displayed. When the port is in Locked,AutomaticInService state but the countdown has not started due to a fault signal, the value will be SOAKLEFT=NOT-STARTED. When the port is in Locked,AutomaticInService state and the countdown has started, the value will be shown in HH-MM format.
<NAME>	(Optional) Port name. NAME is a string.
<PSTPSTQ>	Primary state. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

RTRV-SYNCN

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Synchronization (RTRV-SYNCN) command retrieves the synchronization reference list used to determine the sources for the NE's reference clock and the BITS output clock. For each clock, up to three synchronization sources can be specified (that is, PRIMARY, SECOND, and THIRD).

Usage Guidelines

To retrieve/set the timing mode, SSM message set, and Quality of RES information, use the RTRV-NE-SYNCN and ED-NE-SYNCN commands.
The output example shown here is in line timing mode.

Category

Synchronization

Security

Retrieve

Input Format

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

Input Example

RTRV-SYNCN:BOYES:SYNC-NE:234;

Input Parameters

<AID>

Access identifier from the SYNC_REF.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<REF>,<REFVAL>,[<QREF>],[<STATUS>],[<PROTECTSTATUS>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "SYNC-NE:PRI,FAC-1-2,G811,ACT,WORK" ;

Output Parameters

<AID>	Access identifier from the SYNC_REF.
<REF>	Rank of synchronization reference. Access identifier from the SYNCSW.
<REFVAL>	Value of a synchronization reference. Access identifier from the SYN_SRC.
<QREF>	(Optional) Indicates whether the working or protect card (in a protection group) provides timing. This parameter has no significance if the reference source is BITS or INTERNAL and is left blank. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SDH.
DUS_SDH	Do Not Use For Synchronization
G811	ITU-T G.811 Standard
RES_SDH	Reserved For Network Synchronization Use
G812T	ITU-T G.812T Standard
STU_SDH	Synchronized, Traceability Unknown
G812TL	ITU-T G.812TL Standard
SETS	Synchronous Equipment Timing Source
SSM-FAILED	Incoming timing signal cannot be used for synchronization as it has an alarm like LOS, LOF, AIS-L.
<STATUS>	(Optional) Status. The parameter type is STATUS, which is the status of the unit in the protection pair.
ACT	The entity is the active unit in the shelf.
NA	Status is unavailable.
STBY	The entity is the standby unit in the shelf.
<PROTECTSTATUS>	(Optional) Applicable to 1+1 protection. Designates the role of the entity in the protection group, either working or protect. The parameter type is SIDE, which is the role the unit plays in the protection group.
PROT	The entity is a protection unit in the protection group.
WORK	The entity is a working unit in the protection group.

RTRV-TACC

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Test Access (RTRV-TACC) command retrieves details associated with a test access point (TAP). The TAP is identified by the TAP number. The ALL input TAP value means that the command will return all the configured TACCs in the NE.

Usage Guidelines

None

Category

Troubleshooting and Test Access

Security

Retrieve

Input Format

RTRV-TACC:[<TID>]:<TAP>:<CTAG>;

Input Example

RTRV-TACC:CISCO:241:CTAG;

Input Parameters

<TAP>

The assigned number for AID being used as a test access point. TAP must be an integer within a range of 1 to 999. The ALL TAP value returns all the configured TACCs in this NE. TAP is a string. TAP must not be null.

Output Format

SID DATE TIME M CTAG COMPLD "<TAP>:<TACC_AIDA>,<TACC_AIDB>,[<MD>],[<CROSSCONNECTID1>], <AIDUNIONID>,<PATHWIDTH>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "241:VC4-12-1-1,VC4-12-1-2,MONE,VC4-2-1-1,VC4-5-1-1,VC4" ;

Output Parameters

<TAP>	The assigned number for the AID being used as a test access point. TAP is an integer.
<TACC_AIDA>	Access identifier from the CrossConnectId. The A path of the test access point. The first VC path of the TAP.
<TACC_AIDB>	Access identifier from the CrossConnectId. The B path of the test access point. The second VC path of the TAP. For single FAD TAP, this path will be empty.
<MD>	(Optional) Test access mode. It identifies the mode of access between the TAP and the circuit connected to the TAP. The parameter type is TACC_MODE, which is the test access mode.
LOOPE	Indicates to split both the A and B paths. Connect the line incoming from E direction to the line outgoing in the E direction, and connect this looped configuration to the FAD. The line outgoing in the F direction shall have a QRS connected, and the line incoming from the F direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
LOOPF	Indicates to split both the A and B paths. Connect the line incoming from F direction to the line outgoing in the F direction, and connect this looped configuration to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
MONE	Indicates that a monitor connection is to be provided from the FAD to the A transmission path of the accessed circuit.
MONEF	Indicates that a monitor connection is to be provided from the FAD1 to a DFAD, or the odd pair of a FAP, to the A transmission path and from FAD2 of the same DFAD, or the even pair of a FAP, to the B transmission path of the accessed circuit.
MONF	Indicates that a monitor connection is to be provided from the FAD to the B transmission path of the accessed circuit.
SPLTA	Indicates that a connection is to be provided from both the E and F sides of the A transmission path of the circuit under test to the FAD and split the A transmission path. Intrusive test access mode.
SPLTB	Indicates that a connection is to be provided from both the E and F sides of the B transmission path of the circuit under test to the FAD and split the B transmission path. Intrusive test access mode.
SPLTE	Indicates to split both the A and B paths and connect the E side of the accessed circuit to the FAD. The line outgoing in the F direction shall have a QRS connected, and the line incoming from the F direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
SPLTEF	Indicates to split both the A and B paths, and connect the E side of the accessed circuit to FAD1 and the F side to FAD2. Intrusive test access mode.
SPLTF	Indicates to split both the A and B paths, and connect the F side of the accessed circuit to the FAD. The line outgoing in the E direction shall have a QRS connected, and the line incoming in the E direction shall have a QRS connected, and the line incoming from the E direction shall be terminated by the nominal characteristic impedance of the line. Intrusive test access mode.
<CROSSCONNECTID1>	(Optional) Access identifier from the CrossConnectId. The E path of the cross-connect.
<AIDUNIONID>	Access identifier from the AidUnionId.
<PATHWIDTH>	Cross-connect width. The parameter type is CRS_TYPE, which is the cross-connection type.
VC	All VC cross-connects
VC3	VC3 cross-connect
VC4	VC4 cross-connect
VC42c	VC4-2C cross-connect
VC43C	VC4-3C cross-connect
VC44C	VC4-4C cross-connect
VC46C	VC4-6C cross-connect
VC48C	VC4-8C cross-connect
VC412C	VC4-12C cross-connect
VC416C	VC4-16C cross-connect
VC464C	VC4-64C cross-connect
VC11	VC11 cross-connect
VC12	VC12 cross-connect

RTRV-TADRMAP

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Target Identifier Address Mapping (RTRV-TADRMAP) command retrieves the contents of the TADRMAP table.

Usage Guidelines

When MODE is NSAP, TID name of the NODE can be specified to trigger TARP.

Category

System

Security

Provisioning

Input Format

RTRV-TADRMAP:[<TID>]:[<AID>]:<CTAG>[:::MODE=<MODE>];

Input Example

RTRV-TADRMAP:CISCO:AIP:100:::MODE=PROV;

Input Parameters

<AID>	Access identifier from the ALL.
<MODE>	(Optional) Must not be null. The parameter type is MODE, which determines the category of addresses to return.
ALL	Discovered and provisioned addresses
DISC	Discovered addresses
IP	IP addresses
NSAP	NSAP addresses
PROV	Provisioned

Output Format

SID DATE TIME M CTAG COMPLD "[TID=<TID>],[IP ADDRESS =<IPADDRESS>],[NSAP=<NSAP>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "TID=RANGERS1,IP ADDRESS = 64.101.245.5, NSAP=39840FFFFFFFOOOODDDDAA01D00F0400000700" ;

Output Parameters

<TID>	(Optional) Target identifier. TID is a string.
<IPADDRESS>	(Optional) IP address. IPADDRESS is a string.
<NSAP>	(Optional) NSAP address. NSAP is a string.

RTRV-TH-<MOD2>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Threshold for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS3I, DV6000, E1, E3, E4, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, STM4, STM64, STM1, STM16, OCH, OMS, OTS, POS, STM1E, VC3, VC44C, VC38C, VC464C, VC48C, VC4-12C, VC4, VC416C, VC42C, VC43C, VC11, or VC12 (RTRV-TH-<MOD2>) command retrieves the threshold level of one or more monitored parameters. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

Refer to the Cisco ONS SDH and Cisco ONS 15600 SDH TL1 Reference Guide for specific card provisioning rules.
After the MS-SPRing switches, the working path is switched out, the traffic goes through the protection path, and the threshold can be retrieved from the protection path.
If there is a VC PCA on the protection path, the PCA path is preemptive during the MS-SPRing switch. Sending this command on the protection path after MS-SPRing switch, the command returns the PMs from the protection path, not from the PCA path.
The message is issued to retrieve the thresholds for PM and the alarm thresholds. If it is used to retrieve the alarm thresholds, the time period is not applicable.
The presentation rules are as follows: Client port only-Laser, Alarm, and SDH Thresholds are applicable and will appear. Laser and alarm thresholds are only available for near-end. If the card payload is in SDH mode, then SDH thresholds will appear. The receiver temperature montypes (RXT) are only applicable to the trunk port. The transceiver voltage montypes (XCVR) are not applicable, though they are displayed or handled.
Laser and Alarm thresholds are always available. Laser and alarm thresholds are only for near-end. If ITU-T G.709 is enabled, then the OTN thresholds will appear. If ITU-T G.709 is enabled and FEC is enabled, then the FEC thresholds will appear. If the card payload is in SDH mode, then SDH thresholds will appear. The XCVR montypes are not applicable, though they are displayed or handled.

Category

Performance

Security

Retrieve

Input Format

RTRV-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::[<MONTYPE>],[<LOCN>],[<TMPER>][::];

Input Example

RTRV-TH-T3:CISCO:FAC-1-3:1234::CVL,NEND,15-MIN;

Input Parameters

<AID>	Access identifier from the ALL.
<MONTYPE>	(Optional) Monitored type. A null value is equivalent to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list. Note: MONTYPE defaults to CVL for STM, to ESP for VCn, to UASV for VT1.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count-Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count-Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in tenths of a microW
OPR-MAX	Maximum Receive Power in tenths of a microW
OPR-MIN	Minimum Receive Power in tenths of a micro W
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed as tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed as tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<LOCN>	(Optional) Location associated with a particular command in reference to the entity identified by the AID. LOCN defaults to NEND. A null value is equivalent to ALL. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<TMPER>	(Optional) Accumulation time period for performance counters. Defaults to 15-MIN. Must not be null. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length is every 24 hours. For SDH PM data only one day of history data is available. For RMON managed PM data seven days of history data are available.
1-HR	Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,[<AIDTYPE>]:<MONTYPE>,[<LOCN>],,<THLEV>,[<TMPER>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-3,E3:CVL,NEND,,1,15-MIN" ;

Output Parameters

<AID>	Access identifier from the ALL.
<AIDTYPE>	(Optional) Type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type.
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
BITS	BITS alarm
CLNT	Client facility for MXP/TXP cards
COM	Common alarm
DS3I	DS3i-N-12 alarm
E1	E1 alarm
E100	E100 alarm
E1000	E1000 alarm
E3	E3 alarm
E4	E4 alarm
ENV	ENV alarm
EQPT	EQPT alarm
FSTE	Fast Ethernet port alarm
G1000	G1000 alarm
GIGE	Gigabit Ethernet port alarm
ISC3PEER1G	1-Gbps ISC3 peer
ISC3PEER2G	2-Gbps ISC3 peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
OCH	Optical channel
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port alarm
STM1	STM1 alarm
STM1E	STM1E alarm
STM4	STM4 alarm
STM16	STM16 alarm
STM64	STM64 alarm
SYNCN	SYNCN alarm
TCC	TCC alarm
VC11	VC11 alarm
VC12	VC12 alarm
VC3	VC3 alarm
VC44C	VC44C alarm
VC38C	VC38C alarm
VC464C	VC464C alarm
VC48C	VC48C alarm
VC4	VC4 alarm
VC416C	VC416C alarm
VC42C	VC42C alarm
VC43C	VC43C alarm
<MONTYPE>	Monitored type. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed as tenths of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed as tenths of a percentage
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed as tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed as tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count-Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count-Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in tenths of a micro W
OPR-MAX	Maximum Receive Power in tenths of a micro W
OPR-MIN	Minimum Receive Power in tenths of a micro W
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed as tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed as tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<LOCN>	(Optional) Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<THELV>	Threshold level. THLEV is a float.
<TMPER>	(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center.
1-DAY	Performance parameter accumulation interval length is every 24 hours. For SDH PM data only one day of history data is available. For RMON managed PM data, seven days of history data are available.
1-HR	Performance parameter accumulation interval length is every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available.
1-MIN	Performance parameter accumulation interval length is every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available.
15-MIN	Performance parameter accumulation interval length is every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON managed PMs.

RTRV-TH-ALL

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Threshold All (RTRV-TH-ALL) command retrieves the threshold level of all monitored parameters on the NE.

Usage Guidelines

Refer to the Cisco ONS SDH and Cisco ONS 15600 SDH TL1 Reference Guide for specific card provisioning rules.
After the MS-SPRing switches, the working path is switched out, the traffic goes through the protection path, and the threshold can be retrieved from the protection VC path.
If there is a VC PCA on the protection path, the PCA path is preemptive during the MS-SPRing switch. If you send this command on the protection path after the MS-SPRing switch, the command returns the PMs from the protection path, not from the PCA path.
Multiple RTRV completion codes will be seen after the execution of this command according to Telcordia GR-1831-CORE for bulk retrievals. The final completion code after the multiple RTRV codes is COMPLD.
Some monitored types are not available for some cards or cross-connect types. In that case, a 0 value will appear for the monitored type. This will happen only in the scenario where a user requests the thresholds of a specific monitored parameter on the NE and the monitored type does not apply to that card or cross-connect type. When the user does not filter by monitored type, the applicable thresholds will be retrieved.
If the user requests the thresholds of a particular monitored type and the monitored type is not applicable to some of the entities, DENY is not returned.

Category

Performance

Security

Retrieve

Input Format

RTRV-TH-ALL:[<TID>]::<CTAG>::[<MONTYPE>],[<LOCATION>],[<TMPER>][::];

Input Example

RTRV-TH-ALL:CHARGERS6::123::CVL,NEND,15-MIN;

Input Parameters

<MONTYPE>	(Optional) Monitored type. A null value defaults to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitoring point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count-Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count-Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B- Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in micro A
LBCL-MAX	Maximum Laser Bias Current in micro A
LBCL-MIN	Minimum Laser Bias Current in micro A
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Protection switch count
MS-PSD	Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in tenths of a microW
OPR-MAX	Maximum Receive Power in tenths of a microW
OPR-MIN	Minimum Receive Power in tenths of a microW
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed in tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed in tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<LOCATION>	(Optional) The location. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility
NEND	Action occurs on the near end of the facility
<TMPER>	(Optional) The accumulation time period for performance counters. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management counter.
1-DAY	Performance parameter accumulation interval length is every 24 hours.
1-HR	Performance parameter accumulation interval length is every 1 hour.
1-MIN	Performance parameter accumulation interval length is every 1 minute.
15-MIN	Performance parameter accumulation interval length is every 15 minutes.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON-managed PMs.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,<AIDTYPE>:<MONTYPE>,<LOCATION>,,<THLEV>,<TMPER>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1,E3:CVL,NEND,,1,15-MIN" ;

Output Parameters

<AID>	Access identifier from the AidUnionId.
<AIDTYPE>	Specifies the type of facility, link, or other addressable entity targeted by the message. The parameter type is MOD2B, which is the alarm type for certain generic TL1 commands.
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
BITS	BITS alarm
CLNT	Client facility for MXP/TXP cards
COM	Common alarm
DS3I	DS3i-N-12 alarm
E1	E1 alarm
E100	E100 alarm
E1000	E1000 alarm
E3	E3 alarm
E4	E4 alarm
ENV	ENV alarm
EQPT	EQPT alarm
FSTE	Fast Ethernet port alarm
G1000	G1000 alarm
GIGE	Gigabit Ethernet port alarm
ISC3PEER1G	1-Gbps ISC3 peer
ISC3PEER2G	2-Gbps ISC3 peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
OCH	Optical channel
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port alarm
STM1	STM1 alarm
STM1E	STM1E alarm
STM4	STM4 alarm
STM16	STM16 alarm
STM64	STM64 alarm
SYNCN	SYNCN alarm
TCC	TCC alarm
VC11	VC11 alarm
VC12	VC12 alarm
VC3	VC3 alarm
VC44C	VC44C alarm
VC38C	VC38C alarm
VC464C	VC464C alarm
VC48C	VC48C alarm
VC4	VC4 alarm
VC416C	VC416C alarm
VC42C	VC42C alarm
VC43C	VC43C alarm
<MONTYPE>	Monitored type. A null value defaults to ALL. The parameter type is ALL_MONTYPE, which is the monitored type list.
AISSP	Alarm Indication Signal Seconds-Path
ALL	All possible values
BBEP	SDH Background Block Errors Path
BBE-PM	OTN-Background Block Errors-Path Monitor Point
BBER	SDH Background Block Error Ratio
BBER-PM	OTN-Background Block Error Ratio-Path Monitor Point expressed in tenths of a percentage
BBER-SM	OTN-Background Block Error Ratio-Section Monitor Point expressed in tenths of a percentage
BBE-SM	OTN-Background Block Errors-Section Monitor Point
BIEC	FEC-Bit Errors Corrected
CGV	8B10B-Code Group Violations
CVCPP	Coding Violations-CP-Bit Path
CVL	Coding Violations-Line
CVP	Coding Violations-Path
CVS	Coding Violations-Section
CVV	Coding Violations-Section
DCG	8B10B-Data Code Groups
ESCPP	Errored Seconds-CP-Bit Path
ESL	Errored Seconds-Line
ESP	Errored Seconds-Path
ES-PM	OTN-Errored Seconds-Path Monitor Point
ESR	Errored Second-Ratio
ESR-PM	Errored Seconds Ratio-Path monitor Point expressed in tenths of a percentage
ESR-SM	Errored Seconds Ratio-Section monitor Point expressed in tenths of a percentage
ESS	Errored Seconds-Section
ES-SM	OTN-Errored Seconds-Section Monitor Point
ESV	Errored Seconds-VC Path
etherStatsBroadcastPkts	The total number of good packets received that were directed to a multicast address
etherStatsCollisions	Number of transmit packets that are collisions
etherStatsCRCAlignErrors	The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets
etherStatsDropEvents	Number of received frames dropped at the port level
etherStatsFragments	The total number of packets received that were less than 64 octets
etherStatsJabbers	The total number of packets received that are longer than 1518 octets
etherStatsOctets	The total number of octets of data
etherStatsOversizePkts	The total number of packets received that are longer than 1518 octets
etherStatsPkts	The total number of packets (including bad packets, broadcast packets, and multicast packets) received
etherStatsUndersizePkts	The total number of packets received that are less than 64 octets
FCP	Failure Count-Line
FC-PM	OTN-Failure Count-Path Monitor Point
FC-SM	OTN-Failure Count-Section Monitor Point
HP-AR	Availability Ratio
HP-BBE	High-Order Path Background Block Error
HP-BBER	High-Order Path Background Block Error Ratio
HP-EB	High-Order Path Errored Block
HP-ES	High-Order Path Errored Second
HP-ESA	High-Order Path Errored Seconds-A
HP-ESB	High-Order Path Errored Seconds-B
HP-ESR	High-Order Path Errored Second Ratio
HP-FC	High-Order Path Failure Count
HP-NPJC-PDET	High-Order Path Negative Pointer Justification Count-Path Detected
HP-NPJC-PGEN	High-Order Path Negative Pointer Justification Count-Path Generated
HP-OI	Outage Intensity
HP-PJCDIFF	High-Order Path Pointer Justification Count Difference
HP-PJCS-PDET	High-Order Path Pointer Justification Count Seconds-Path Detected
HP-PPJC-PDET	High-Order Path Positive Pointer Justification Count-Path Detected
HP-PPJC-PGEN	High-Order Path Positive Pointer Justification Count-Path Generated
HP-SEPI	The number of SEP events in available time
HP-SES	High-Order Path Severely Errored Seconds
HP-SESR	High-Order Path Severely Errored Second Ratio
HP-UAS	High-Order Path Unavailable Seconds
ifInBroadcastPkts	Number of broadcast packets received since the last counter reset
ifInDiscards	The number of inbound packets
ifInErrorBytePktss	Receive Error Byte
ifInErrors	The number of inbound packets (or transmission units) that contained errors
ifInFramingErrorPkts	Receive Framing Error
ifInJunkInterPkts	Receive Interpacket Junk
ifInMulticastPkts	Number of multicast packets received since the last counter reset
ifInOctets	Number of bytes transmitted since the last counter reset
ifInUcastPkts	Number of unicast packets received since the last counter reset
ifOutBroadcastPkts	Number of broadcast packets transmitted
ifOutDiscards	The number of outbound packets
ifOutErrors	The number of outbound packets (or transmission units) that could not be transmitted because of errors
ifOutMulticastPkts	Number of multicast packets transmitted
ifOutPayloadCrcErrors	Received payload CRC errors
ifOutUcastPkts	Number of unicast packets transmitted
IOS	8B10B-Idle Ordered Sets
IPC	Invalid Packet Count
LBCL-AVG	Average Laser Bias Current in microA
LBCL-MAX	Maximum Laser Bias Current in microA
LBCL-MIN	Minimum Laser Bias Current in microA
LBCN	Normalized Laser Bias Current for STM1-8
LBCN-HWT	Normalized Laser Bias Current-Higher Threshold
LBCN-LWT	Normalized Laser Bias Current-Lower Threshold
LOSSL	Loss of Signal Seconds-Line
LP-BBE	Low-Order Path Background Block Error
LP-BBER	Low-Order Path Background Block Error Ratio
LP-EB	Low-Order Path Errored Block
LP-ES	Low-Order Path Errored Second
LP-ESA	Low-Order Path Errored Seconds-A
LP-ESB	Low-Order Path Errored Seconds-B
LP-ESR	Low-Order Path Errored Second Ratio
LP-FC	Low-Order Path Failure Count
LP-NPJC-DET	Low-Order Negative Pointer Justification Count-Detected
LP-NPJC-GEN	Low-Order Negative Pointer Justification Count-Generated
LP-PPJC-DET	Low-Order Positive Pointer Justification Count-Detected
LP-PPJC-GEN	Low-Order Positive Pointer Justification Count-Generated
LP-SEP	A sequence of between 3 to 9 consecutive SES
LP-SEPI	Low-Order Path Severely Errored Period Intensity
LP-SES	Low-Order Path Severely Errored Seconds
LP-UAS	Low-Order Path Unavailable Seconds
MS-PSC	Multiplex Section-Protection switch count
MS-PSD	Multiplex Section-Protection switch duration
NIOS	8B10B-Non Idle Ordered Sets
NPJC-PDET	Negative Pointer Justification Count-Path Detected
NPJC-PGEN	Negative Pointer Justification Count-Path Generated
OPR-AVG	Average Receive Power in tenths of a microW
OPR-MAX	Maximum Receive Power in tenths of a microW
OPR-MIN	Minimum Receive Power in tenths of a microW
OPRN	Normalized Optical Receive Power for STM1-8
OPRN-MAX	Maximum value for OPRN
OPRN-MIN	Minimum value for OPRN
OPT-AVG	Average Transmit Power in tenths of a microW
OPT-MAX	Maximum Transmit Power in tenths of a microW
OPT-MIN	Minimum Transmit Power in tenths of a microW
OPTN	Normalized value for Optical Power Transmitted for STM1-8 card
OPTN-MAX	Maximum value for OPTN
OPTN-MIN	Minimum value for OPTN
OPWR-AVG	Optical Power-Average Interval Value in tenths of a dBm
OPWR-MAX	Optical Power-Maximum Interval Value in tenths of a dBm
OPWR-MIN	Optical Power-Minimum Interval Value in tenths of a dBm
PPJC-PDET	Positive Pointer Justification Count-Path Detected
PPJC-PGEN	Positive Pointer Justification Count-Path Generated
PSC	Protection Switching Count
PSC-R	Protection Switching Count-Ring
PSC-S	Protection Switching Count-Span
PSC-W	Protection Switching Count-Working
PSD	Protection Switching Duration
PSD-R	Protection Switching Duration-Ring
PSD-S	Protection Switching Duration-Span
PSD-W	Protection Switching Duration-Working
SASCPP	Severely Errored Framing/AIS Second-CP-Bit Path
SASP	Severely Errored Framing/AIS Seconds Path
SEFS	Severely Errored Framing Seconds
SESCPP	Severely Errored Second-CP-Bit Path
SESL	Severely Errored Second-Line
SESP	Severely Errored Second-Path
SES-PM	OTN-Severely Errored Second-Path
SESR	Severely Errored Second-Ratio
SESR-PM	OTN-Severely Errored Second Ratio-Path Monitor Point expressed in tenths of a percentage
SESR-SM	OTN-Severely Errored Second Ratio-Section Monitor Point expressed in tenths of a percentage
SESS	Severely Errored Second-Section
SES-SM	OTN-Severely Errored Second-Section Monitor Point
SESV	Severely Errored Second-VC Path
UASCPP	Unavailable Second-CP-Bit Path
UASL	Unavailable Second-Line
UASP	Unavailable Second-Path
UAS-PM	OTN-Unavailable Second-Path Monitor Point
UAS-SM	OTN-Unavailable Second-Section Monitor Point
UASV	Unavailable Second-VC Path
UNC-WORDS	FEC-Uncorrectable Words
VPC	Valid Packet Count
<LOCATION>	The location. A null value defaults to NEND. The parameter type is LOCATION, which is the location where the action is to take place.
FEND	Action occurs on the far end of the facility.
NEND	Action occurs on the near end of the facility.
<THLEV>	Threshold level. Indicates the threshold value. THLEV is a float.
<TMPER>	The accumulation time period for performance counters. A null value defaults to 15-MIN. The parameter type is TMPER, which is the accumulation time period for the performance management counter.
1-DAY	Performance parameter accumulation interval length is every 24 hours.
1-HR	Performance parameter accumulation interval length is every 1 hour.
1-MIN	Performance parameter accumulation interval length is every 1 minute.
15-MIN	Performance parameter accumulation interval length is every 15 minutes.
RAW-DATA	Performance parameter accumulation interval starts from the last time the counters were cleared. This is only applicable to RMON-managed PMs.

RTRV-TOD

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Time of Day (RTRV-TOD) command retrieves the system date and time at the instant when the command was executed. The time returned is in Coordinated Universal Time (UTC).

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

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

Input Example

RTRV-TOD:CAZADERO::230;

Input Parameters

None

Output Format

SID DATE TIME M CTAG COMPLD "<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,<DIFFERENCE>:<TMTYPE>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "2002,05,08,17,01,33,840:LINT" ;

Output Parameters

<YEAR>	The current calendar year. YEAR is a string.
<MONTH>	The month of the year. Ranges from 01 to 12. MONTH is a string.
<DAY>	The day of the month. Ranges from 01 to 31. DAY is a string.
<HOUR>	The hour of the day. Ranges from 00 to 23. HOUR is a string.
<MINUTE>	The minute of the hour. Ranges from 00 to 59. MINUTE is a string.
<SECOND>	The second of the minute. Ranges from 00 to 59. SECOND is a string.
<DIFFERENCE>	The number of minutes off UTC. The parameter type is DIFFERENCE, which is the number of minutes off UTC.
-120	2 hours before UTC
-180	3 hours before UTC
-210	3.5 hours before UTC
-240	4 hours before UTC
-300	5 hours before UTC
-360	6 hours before UTC
-420	7 hours before UTC
-480	8 hours before UTC
-540	9 hours before UTC
-60	1 hour before UTC
-600	10 hours before UTC
-660	11 hours before UTC
0	UTC
120	2 hours after UTC
180	3 hours after UTC
210	3.5 hours after UTC
240	4 hours after UTC
270	4.5 hours after UTC
300	5 hours after UTC
330	5.5 hours after UTC
345	5.75 hours after UTC
360	6 hours after UTC
390	6.5 hours after UTC
420	7 hours after UTC
480	8 hours after UTC
540	9 hours after UTC
570	9.5 hours after UTC
60	1 hour after UTC
600	10 hours after UTC
630	10.5 hours after UTC
660	11 hours after UTC
690	11.5 hours after UTC
720	12 hours after UTC
765	12.75 hours after UTC
780	13 hours after UTC
840	14 hours after UTC
<TMTYPE>	Identifies the time zone. TMTYPE is a string.

RTRV-TRAPTABLE

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Trap Table (RTRV-TRAPTABLE) command retrieves a trap destination entry identified by a specific trap destination address.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

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

Input Example

RTRV-TRAPTABLE::1.2.3.4:1;

Input Parameters

<AID>

Access identifier from the IPADDR. IP address identifying the trap destination. Only a numeric IP address is allowed. A null value is equivalent to ALL.

Output Format

SID DATE TIME M CTAG COMPLD "<DEST>,<TRAPPORT>,<COMMUNITY>,<SNMPVERSION>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "1.2.3.4,162,\"PRIVATE\",SNMPV1" ;

Output Parameters

<DEST>	Access identifier from the IPADDR.
<TRAPPORT>	UDP port number associated with the trap destination. Defaults to 162. TRAPPORT is an integer.
<COMMUNITY>	Community name associated to the trap destination. Maximum of 32 characters. COMMUNITY is a string.
<SNMPVERSION>	SNMP version number. Defaults to SNMPv1. The parameter type is SNMP_VERSION, which is the SNMP version.
SNMPV1	SNMP version 1 (default)
SNMPV2	SNMP version 2

RTRV-TRC-<STM_MSSPR>

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Trace Client for STM4, STM64, or STM16 (RTRV-TRC-<STM_MSSPR>) command retrieves the valid J1 expected trace string, retrieved trace string, trace mode, C2 byte, and VC bandwidth of the STM port only if the port has a MS-SPRing. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

This command only applies to STM-16 AS and STM-64 cards.
Sending this command over unsupported MS-SPRing path trace cards or unequipped cards will result in a J1 Trace Not Supported On This Card (IIAC) error.

Category

MS-SPRing

Security

Retrieve

Input Format

RTRV-TRC-<STM_MSSPR>:[<TID>]:<AID>:<CTAG>;

Input Example

RTRV-TRC-STM16:CISCO:FAC-6-1:238;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[LEVEL=<LEVEL>],[EXPTRC=<EXPTRC>],[INCTRC=<INCTRC>], [TRCMODE=<TRCMODE>],[C2=<C2>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VC4-6-1-25::LEVEL=VC4,EXPTRC="EXPTRCSTRING",INCTRC="INCTRCSTRING", TRCMODE=AUTO,C2=0X04" ;

Output Parameters

<AID>	Access identifier from the VC.
<LEVEL>	(Optional) The rate of the cross-connect. The parameter type is VC_PATH, which is the modifier for some VC commands.
VC3	VC3 level
VC44C	VC4-4C level
VC464C	VC4-64C level
VC48C	VC4-8C level
VC4	VC4 level
VC416C	VC4-16C level
VC42C	VC4-2C level
VC43C	VC4-3C level
<EXPTRC>	(Optional) Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR and LF. EXPTRC is a string.
<INCTRC>	(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters including CR and LF. INCTRC is a string.
<TRCMODE>	(Optional) Trace mode. The parameter type is TRCMODE (trace mode).
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.
<C2>	(Optional) The C2 byte hex code. Applicable only to VC-level paths in SDH (VCn). The parameter type is C2_BYTE, which is the C2 byte hex code.
0X00	Unequipped
0X01	Equipped-Non Specific Payload
0X02	VT-Structured VC-1 SPE
0X03	Locked VT mode
0X04	Asynchronous Mapping for DS3
0X12	Asynchronous Mapping for DS4NA
0X13	Mapping for ATM
0X14	Mapping for DQDB
0X15	Asynchronous Mapping for FDDI
0X16	HDLC-over-SDH Mapping
0XE1	VT-structured VC4-1 SPE with 1VTx payload defect
0XE2	VT-structured VC4-1 SPE with 2VTx payload defects
0XE3	VT-structured VC4-1 SPE with 3VTx payload defects
0XE4	VT-structured VC4-1 SPE with 4VTx payload defects
0XE5	VT-structured VC4-1 SPE with 5VTx payload defects
0XE6	VT-structured VC4-1 SPE with 6VTx payload defects
0XE7	VT-structured VC4-1 SPE with 7VTx payload defects
0XE8	VT-structured VC4-1 SPE with 8VTx payload defects
0XE9	VT-structured VC4-1 SPE with 9VTx payload defects
0XEA	VT-structured VC4-1 SPE with 10VTx payload defects
0XEB	VT-structured VC4-1 SPE with 11VTx payload defects
0XEC	VT-structured VC4-1 SPE with 12VTx payload defects
0XED	VT-structured VC4-1 SPE with 13VTx payload defects
0XEE	VT-structured VC4-1 SPE with 14VTx payload defects
0XEF	VT-structured VC4-1 SPE with 15VTx payload defects
0XF0	VT-structured VC4-1 SPE with 16VTx payload defects
0XF1	VT-structured VC4-1 SPE with 17VTx payload defects
0XF2	VT-structured VC4-1 SPE with 18VTx payload defects
0XF3	VT-structured VC4-1 SPE with 19VTx payload defects
0XF4	VT-structured VC4-1 SPE with 20VTx payload defects
0XF5	VT-structured VC4-1 SPE with 21VTx payload defects
0XF6	VT-structured VC4-1 SPE with 22VTx payload defects
0XF7	VT-structured VC4-1 SPE with 23VTx payload defects
0XF8	VT-structured VC4-1 SPE with 24VTx payload defects
0XF9	VT-structured VC4-1 SPE with 25VTx payload defects
0XFA	VT-structured VC4-1 SPE with 26VTx payload defects
0XFB	VT-structured VC4-1 SPE with 27VTx payload defects
0XFC	VT-structured VC4-1 SPE with 28VTx payload defects
0XFE	O.181 Test Signal (TSS1 to TSS3) Mapping
0XFF	Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.

RTRV-TRC-OCH

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Trace Optical Channel (RTRV-TRC-OCH) command retrieves the sent trace string, expected trace string, received trace string, trace mode, and the trace level for the SDH J0 section and the TTI PATH and SECTION monitoring levels of the DWDM facility.

Usage Guidelines

On the client port:
- Only the J0 section trace applies.
- The J0 section trace applies only if the card termination mode is not transparent and the payload is SDH.
On the DWDM port:
- The J0 section trace and the TTI path and section trace monitoring point traces are allowed.
- The J0 section trace is allowed only if the payload for the card is set to SDH.
- The J0 section trace is allowed only if the card termination mode is not transparent. The TTI path and section trace is allowed only if ITU-T G.709 (DWRAP) is enabled.
Depending on the settings, the following filtering applies:
- If no TRCLEVEL is provided, all TRCLEVELs are reported as applicable.
- If TRCLEVEL is provided and no MSGTYPE is provided, all applicable MSGTYPEs for the given level are displayed.
- If no MSGTYPE is provided, all MSGTYPEs are reported as applicable.
- If an MSGTYPE is provided with out a TRCLEVEL, then the given MSGTYPE for all TRCLEVELs are displayed.

Category

DWDM

Security

Retrieve

Input Format

RTRV-TRC-OCH:[<TID>]:<SRC>:<CTAG>::[<MSGTYPE>],[<TRCLEVEL>][::];

Input Example

RTRV-TRC-OCH:CISCO:CHAN-2-2:100::EXPTRC,TTI-PM;

Input Parameters

<SRC>	Access identifier from the CHANNEL.
<MSGTYPE>	Type of autonomous message to be retrieved. A null value is equivalent to ALL. The parameter type is MSGTYPE, which is the type of trace message.
EXPTRC	Expected incoming path trace message
INCTRC	Incoming path trace message
TRC	Outgoing path trace message
<TRCLEVEL>	The trace level to be managed. A null value is equivalent to ALL. The parameter type is TRCLEVEL, which is the trace mode options.
J0	Identifies the SDH J0 section trace level.
TTI-PM	Identifies the TTI path monitoring point.
TTI-SM	Identifies the TTI section monitoring point.

Output Format

SID DATE TIME M CTAG COMPLD "<CHANNEL>,<MOD>::[TRCLEVEL=<TRCLEVEL>],[EXPTRC=<EXPTRC>], [TRC=<TRC>],[INCTRC=<INCTRC>],[TRCMODE=<TRCMODE>], [TRCFORMAT=<TRCFORMAT>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-2-2,OCH::TRCLEVEL=TTI-PM,EXPTRC=\"AAA\",TRC=\"AAA\", INCTRC=\"AAA\",TRCMODE=MAN,TRCFORMAT=64-BYTE" ;

Output Parameters

<CHANNEL>	Access identifier from the CHANNEL.
<MOD>	Indicates an OCH AID type. The parameter type is MOD2, which is the line/path modifier.
10GFC	10-Gigabit Fibre Channel payload
10GFICON	10-Gigabit fiber connectivity payload
1GFC	1-Gigabit Fibre Channel payload
1GFICON	1-Gigabit fiber connectivity payload
1GISC3	1-Gigabit ISC3 compatible
2GFC	2-Gigabit Fibre Channel payload
2GFICON	2-Gigabit fiber connectivity payload
2GISC3	2-Gigabit ISC3 compatible
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
D1VIDEO	D1 video
DS3I	DS3i-N-12 line
DV6000	DV6000
E1	E1
E3	E3
E4	E4 frame. Only applicable to STM1E Ports 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
ESCON	ESCON
ETRCLO	ETRCLO
FSTE	FSTE facility
G1000	G1000 facility
GFPOS	GFP over POS, virtual ports partitioned using GFP's multiplexing capability
GIGE	Gigabit Ethernet
HDTV	HDTV
ISC3PEER1G	1-Gbps ISC3 peer
ISC3PEER2G	2-Gbps ISC3 peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
OCH	Optical Channel
OCHCC	OCH client connection
OCHNC	OCH network connection
OCHTERM	OCH termination
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port
STM1	STM1 facility
STM1E	STM1E facility, only applicable to the STM1E facility (when it is in STM1E mode) of SDH STM1E-12 card
STM4	STM4 facility
STM16	STM16 facility
STM64	STM64 facility
VC3	VC3 path
VC44C	VC4-4C path
VC38C	VC3-8C path
VC464C	VC4-64C path
VC48C	VC4-8C path
VC4	VC4 path
VC416C	VC4-16C path
VC42C	VC4-2C path
VC43C	VC4-3C path
VC11	VC11 path
VC12	VC12 path
<TRCLEVEL>	(Optional) The trace level to be managed. The parameter type is TRCLEVEL, which is the trace mode options.
J0	Identifies the SDH J0 section trace level.
TTI-PM	Identifies the TTI path monitoring point.
TTI-SM	Identifies the TTI section monitoring point.
<EXPTRC>	(Optional) Expected path trace content. A 64 character ASCII string.
<TRC>	(Optional) The path trace message to be transmitted. The trace byte continuously transmits a 64 byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00), CR, and LF. TRC is a string.
<INCTRC>	(Optional) The incoming path trace message contents. INCTRC is a string.
<TRCMODE>	(Optional) Trace mode. The parameter type is TRCMODE (trace mode).
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>	(Optional) The size of the trace message. If in SDH mode, only 1 or 16 bytes is applicable for the J0 section trace. The TTI level trace is only 64 bytes. The parameter type is TRCFORMAT, which is the trace format.
1-BYTE	1-byte trace message
16-BYTE	16-byte trace message
64-BYTE	64-byte trace message

RTRV-TUNNEL-FIREWALL

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Tunnel Firewall (RTRV-TUNNEL-FIREWALL) command retrieves the contents of the firewall tunnel table.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

RTRV-TUNNEL-FIREWALL:[<TID>]::<CTAG>;

Input Example

RTRV-TUNNEL-FIREWALL:TID::CTAG;

Input Parameters

None

Output Format

SID DATE TIME M CTAG COMPLD "[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>], [DEST MASK=<DESTMASK>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7, DEST MASK=255.255.255.0" ;

Output Parameters

<SRCADDR>	(Optional) Source IP address. SRCADDR is a string.
<SRCMASK>	(Optional) Source mask. SRCMASK is a string.
<DESTADDR>	(Optional) Destination IP address. DESTADDR is a string.
<DESTMASK>	(Optional) Destination mask. DESTMASK is a string.

RTRV-TUNNEL-PROXY

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Tunnel Proxy (RTRV-TUNNEL-PROXY) command retrieves the contents of the proxy tunnel table.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

RTRV-TUNNEL-PROXY:[<TID>]::<CTAG>;

Input Example

RTRV-TUNNEL-PROXY:TID::100;

Input Parameters

None

Output Format

SID DATE TIME M CTAG COMPLD "[SRC ADDR=<SRCADDR>],[SRC MASK=<SRCMASK>],[DEST ADDR=<DESTADDR>], [DEST MASK=<DESTMASK>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "SRC ADDR=64.101.150.10,SRC MASK=255.255.255.0,DEST ADDR=64.101.144.7, DEST MASK=255.255.255.0" ;

Output Parameters

<SRCADDR>	(Optional) Source IP address. SRCADDR is a string.
<SRCMASK>	(Optional) Source mask. SRCMASK is a string.
<DESTADDR>	(Optional) Destination IP address. DESTADDR is a string.
<DESTMASK>	(Optional) Destination mask. DESTMASK is a string.

RTRV-USER-SECU

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve User Security (RTRV-USER-SECU) command retrieves the security information of a specified user or list of users. The keyword ALL can be used to obtain a list of all users. For security reasons, the password cannot be retrieved.

Usage Guidelines

A Superuser can retrieve any user's security information. A user with MAINT, PROV, or RTRV privileges can only retrieve their own information.
When using the keyword ALL, all users created for the system are displayed. This includes users created outside of the TL1 environment (that is, user IDs and passwords greater than 10 characters in length). Although displayed through the RTRV-USER-SECU command, these users will not be able to log into the TL1 environment.

Category

Security

Retrieve

Note: Maintenance, Provisioning, and Retrieve users can retrieve their own information only.

Input Format

RTRV-USER-SECU:[<TID>]:<UID>:<CTAG>;

Input Example

RTRV-USER-SECU::CISCO15:1;

Input Parameters

<UID>

User identifier. The user ID or the keyword ALL. If you are not a Superuser, you can only specify your own user ID. Must not be null. UID is a string.

Output Format

SID DATE TIME M CTAG COMPLD "<UID>:,<PRIVILEGE>:LOGGEDIN=<LOGGEDIN>,[NUMSESSIONS=<NUMSESS>], [LOCKEDOUT=<LOCKEDOUT>],[DISABLED=<DISABLED>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CISCO15:,SUPER:LOGGEDIN=YES,NUMSESSIONS=1,LOCKEDOUT=NO,DISABLED=NO" ;

Output Parameters

<UID>	User identifier. The user ID that was retrieved. UID is a string.
<PRIVILEGE>	The privilege level of the user. The parameter type is PRIVILEGE, which is the security level.
MAINT	Maintenance security level. 60 minutes of idle time.
PROV	Provision security level. 30 minutes of idle time.
RTRV	Retrieve security level. Unlimited idle time.
SUPER	Superuser security level. 15 minutes of idle time.
<LOGGEDIN>	Indicates if the user is logged in to the NE. The parameter type is YES_NO, which indicates whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE.
NO	No
YES	Yes
<NUMSESS>	(Optional) The number of times the user is logged into the NE. NUMSESS is an integer.
<LOCKEDOUT>	(Optional) Indicates if the user is locked out of the NE. The parameter type is YES_NO, which indicates whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE.
NO	No
YES	Yes
<DISABLED>	(Optional) Indicates if the user is disabled. The parameter type is YES_NO, which indicates whether the user's password is about to expire, the user is logged into the NE, or the user is locked out of the NE.
NO	No
YES	Yes

RTRV-VC

(Cisco ONS 15600 SDH) The Retrieve VC (RTRV-VC) command retrieves the attributes associated with a VC path.

Usage Guidelines

See Table 27-1 for supported modifiers by platform.
Supported AIDs are: ALL, SLOT-N (N=1,2,...,ALL), and VC-specific AIDs
The SFBER, SDBER, RVRTV, RVTM, SWPDIP, HOLDOFFTIMER, and SNCPPTHSTATE parameters only apply to SNCP.
The path trace message is a 64 character string including the terminating CR (carriage return) and LF (line feed) that is transported in the J1 byte of the SONET VC path overhead.
The EXPTRC indicates the contents of the expected incoming path trace that are provisioned by the user in the ED-VC_PATH command. The TRC indicates the contents of the outgoing path trace message. The INCTRC indicates the contents of the incoming path trace message.
The path trace mode has three modes: OFF, MANUAL, and AUTO. The mode defaults to OFF. The MANUAL mode compares the received string with the user entered expected string. The AUTO mode compares the present received string with an expected string set to a previously received string. If there is a mismatch, the TIM-P alarm is raised. When the path trace mode is in OFF mode, there is no path trace processing, and all the alarm and state conditions are reset.
When the expected string is queried under the OFF path trace mode, the expected string is a copy of the provisioned string, or NULL. When an expected string is queried under the MANUAL path trace mode, the expected string is a copy of the user entered string. When an expected string is queried under the AUTO path trace mode, the expected string is either a copy of the acquired received string, or NULL if the string has not been acquired.
When the incoming string is queried under the OFF path trace mode, the incoming string is NULL. When an incoming string is queried under the MANUAL or AUTO path trace mode, the incoming string is either a copy of the received string, or NULL if the string has not been received.
J1 (EXPTRC) is implemented on the STM1, STM16AS, STM64, MRC-12, and STM64-XFP cards.

Note: This command is available in Software Release 8.0.1 and all subsequent releases. It is not available in R8.0.0 and earlier.

Category

Paths

Security

Retrieve

Input Format

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

Input Example

RTRV-VC4:FERNDALE:VC4-2-1-4:238:::MSSPRPTHTYPE=NON-PCA;

Input Parameters

<AID>	Access identifier from the CrossConnectId1.
<MSSPRPTHTYPE>	The MS-SPRing path type (only if the port is on the MS-SPRing). Defaults to NON-PCA. Applicable only to VC-level paths in SDH. A null value defaults to NON-PCA. Parameter type is MSSPR_PTH_TYPE, which is the MS-SPRing path type only if the port is on the MS-SPRing.
NON-PCA	The AID is on the working path, or the cross-connection card protection path.
PCA	The AID is on the MS-SPRing PCA path.

Output Format

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

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VC4-2-1-4::LEVEL=VC3,SFBER=1E-3,SDBER=1E-5,RVRTV=Y,RVTM=1.0,SWPDIP=Y, HOLDOFFTIMER=2000,EXPTRC="EXPTRCSTRING",TRC="TRCSTRING", INCTRC="INCTRCSTRING",TRCMODE=AUTO,TACC=8,TAPTYPE=DUAL, SNCPPTHSTATE=ACT,C2=0X04, MSSPRPTHSTATE=PROTPTHACT:UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the CrossConnectId1.
<LEVEL>	(Optional) The rate of the cross-connected channel. Applicable only to high-order paths (VC4). Parameter type is PATH, which is the modifier for path commands.
VC3	Synchronous Transport Signal/Module Level-1 (51 Mbps)
VC44C	Synchronous Transport Signal/Module Level-12 Concatenated (622 Mbps)
VC38C	Synchronous Transport Signal/Module Level-18 Concatenated (933 Mbps)
VC464C	Synchronous Transport Signal/Module Level-192 Concatenated (9952 Mbps)
VC48C	Synchronous Transport Signal/Module Level-24 Concatenated (1240 Mbps)
VC4	Synchronous Transport Signal/Module Signal Level-3 Concatenated (155 Mbps)
VC416C	Synchronous Transport Signal/Module Level-48 Concatenated (2488 Mbps)
VC42C	Synchronous Transport Signal/Module level-6 (310 Mbps)
VC43C	Synchronous Transport Signal/Module Level-9 Concatenated (465 Mbps)
VC12	Virtual Tributary 2, Virtual Channel 12
<SFBER>	(Optional) An VC path signal failure threshold which only applies to SNCP. Applicable only to High-Order paths. Defaults to 1E-4. Parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) An VC path signal degrade threshold that only applies to SNCP. Applicable only high-order paths. Defaults 1E-6. Parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
1E-5	SDBER is 1E-5.
1E-6	SDBER is 1E-6.
1E-7	SDBER is 1E-7.
1E-8	SDBER is 1E-8.
1E-9	SDBER is 1E-9.
<RVRTV>	Revertive mode. Only applies to SNCP. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. Parameter type is ON_OFF (disable or enable an attribute).
N	Does not revert service to original line after restoration.
Y	Reverts service to original line after restoration.
<RVTM>	Revertive time. Only applies to SNCP. Parameter type is REVERTIVE_TIME (revertive time).
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<SWPDIP>	Switch on PDI-P. Applicable only to VC-level paths (VCn). Optional. Parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<HOLDOFFTIMER>	(Optional) HOLDOFFTIMER is an integer.
<EXPTRC>	(Optional) Expected path trace content. Indicates the expected path trace message (J1) contents. EXPTRC is any 64-character ASCII string, including the terminating CR (carriage return) and LF (line feed). Applicable to VC-level paths (VCn). Defaults to NULL when SNCP path is created. EXPTRC is a string.
<TRC>	(Optional) The path trace message to be transmitted. The trace byte (J1) continuously transmits a 64-byte, fixed length ASCII string, one byte at a time. A null value defaults to the NE transmitting 62 null characters (hex 00) and CR and LF. A null value defaults to the NE transmitting null characters (Hex 00). Applicable to VC-level paths (VCn). TRC is a string.
<INCTRC>	(Optional) The incoming path trace message contents. INCTRC is any combination of 64 characters. Applicable only to VC-level paths in (VCn). Defaults to Null when an SNCP path is created. INCTRC is a string.
<TRCMODE>	(Optional) Path trace mode. Applicable only to VC-level paths (VCn). Defaults to OFF when an SNCP path is created. The parameter type is TRCMODE, which is the trace mode.
AUTO	NOT applicable to MXP_2.5G_10G and TXP_MR_10G cards. Use the previously received path trace string as the expected string.
AUTO-NO-AIS	Use the previously received path trace string as the expected string and do not turn on AIS and RDI if TIMP detected.
MAN	Use the provisioned expected string as the expected string.
MAN-NO-AIS	Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIMP detected.
OFF	Turn off path trace capability. Nothing will be reported.
<TACC>	(Optional) Test access. Indicates whether the digroup being provisioned is to be used as a test access digroup. Defaults to N.
<TAPTYPE>	(Optional) TAP type, where parameter type is TAPTYPE, which is the test access point type.
DUAL	Dual FAD
SINGLE	Single FAD
<SNCPPTHSTATE>	(Optional) Indicates whether a given AID is the working or standby path of a SNCP cross-connect. Parameter type is STATUS, which is the status of the unit in the protection pair.
ACT	The entity is the active unit in the shelf.
NA	Status is unavailable.
STBY	The entity is the standby unit in the shelf.
<C2>	(Optional) The C2-byte hexadecimal code. Applicable only to VC-level paths (VCn). Parameter type is C2_BYTE, which is the C2-byte hexadecimal code.
0X00	Unequipped
0X01	Equipped-Non Specific payload
0X02	VT-Structured VC-1 SPE
0X03	Locked VT mode
0X04	Asynchronous Mapping for DS3
0X12	Asynchronous Mapping for DS4NA
0X13	Mapping for ATM
0X14	Mapping for DQDB
0X15	Asynchronous Mapping for FDDI
0X16	HDLC-Over-SDH Mapping
0XE1	VT-structured VC4-1 SPE with 1VTx payload defect
0XE2	VT-structured VC4-1 SPE with 2VTx payload defects
0XE3	VT-structured VC4-1 SPE with 3VTx payload defects
0XE4	VT-structured VC4-1 SPE with 4VTx payload defects
0XE5	VT-structured VC4-1 SPE with 5VTx payload defects
0XE6	VT-structured VC4-1 SPE with 6VTx payload defects
0XE7	VT-structured VC4-1 SPE with 7VTx payload defects
0XE8	VT-structured VC4-1 SPE with 8VTx payload defects
0XE9	VT-structured VC4-1 SPE with 9VTx payload defects
0XEA	VT-structured VC4-1 SPE with 10VTx payload defects
0XEB	VT-structured VC4-1 SPE with 11VTx payload defects
0XEC	VT-structured VC4-1 SPE with 12VTx payload defects
0XED	VT-structured VC4-1 SPE with 13VTx payload defects
0XEE	VT-structured VC4-1 SPE with 14VTx payload defects
0XEF	VT-structured VC4-1 SPE with 15VTx payload defects
0XF0	VT-structured VC4-1 SPE with 16VTx payload defects
0XF1	VT-structured VC4-1 SPE with 17VTx payload defects
0XF2	VT-structured VC4-1 SPE with 18VTx payload defects
0XF3	VT-structured VC4-1 SPE with 19VTx payload defects
0XF4	VT-structured VC4-1 SPE with 20VTx payload defects
0XF5	VT-structured VC4-1 SPE with 21VTx payload defects
0XF6	VT-structured VC4-1 SPE with 22VTx payload defects
0XF7	VT-structured VC4-1 SPE with 23VTx payload defects
0XF8	VT-structured VC4-1 SPE with 24VTx payload defects
0XF9	VT-structured VC4-1 SPE with 25VTx payload defects
0XFA	VT-structured VC4-1 SPE with 26VTx payload defects
0XFB	VT-structured VC4-1 SPE with 27VTx payload defects
0XFC	VT-structured VC4-1 SPE with 28VTx payload defects
0XFE	O.181 Test Signal (TSS1 to TSS3) Mapping
0XFF	Reserved, however, C2 is 0XFF if AIS-L is being generated by an optical card or cross-connect downstream.
<MSSPRPTHSTATE>	(Optional) The MS-SPRing path state only if the port is on the MS-SPRing. Applicable only to VC-level paths in SDH (VCn). Parameter type is MSSPR_PTH_STATE, which is the MS-SPRing path state only if the port is on the MS-SPRing.
PCAPTHACT	Indicates the MS-SPRing un-switched; its PCA path is in the active state.
PCAPTHSTB	Indicates the MS-SPRing switched; its PCA path is in the standby state.
PROTPTHACT	Indicates the MS-SPRing switched; its protection path is in the active state.
WKGPTHACT	Indicates the MS-SPRing un-switched; its working path is in the active state.
WKGPTHSTB	Indicates the MS-SPRing switched; its working path is in the standby state.
<PSTPSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state of the entity. Parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

RTRV-VCG

(Cisco ONS 15454 SDH) The Retrieve Virtual Concatenated Group (RTRV-VCG) command retrieves all the attributes provisioned for a VCG.

Usage Guidelines

None

Category

VCAT

Security

Retrieve

Input Format

RTRV-VCG:[<TID>]:<SRC>:<CTAG>[::::];

Input Example

RTRV-VCG:NODE1:FAC-1-1:1234;

Input Parameters

<SRC>

Source access identifier from the FACILITY. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID.

Output Format

SID DATE TIME M CTAG COMPLD "<SRC>::TYPE=<TYPE>,TXCOUNT=<TXCOUNT>,CCT=<CCT>,[LCAS=<LCAS>], [BUFFERS=<BUFFERS>],[NAME=<NAME>]:<PST>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::TYPE=VC3,TXCOUNT=8,CCT=2WAY,LCAS=LCAS,BUFFERS=DEFAULT, NAME="VCG2":UNLOCKED" ;

Output Parameters

<SRC>	Source access identifier from the FACILITY. ML1000-2 and ML100T-12 cards use the VFAC AID. The FC_MR-4 card uses the FAC AID.
<TYPE>	The type of the entity being provisioned. Null indicates not applicable. TYPE can be a CLEI code or another value. The type of member cross-connect. ML1000-2 and ML100T-12 cards support VC3, VC4C, and VC44C. The FC_MR-4 card supports VC4C only. The parameter type is MOD_PATH, which is the VC path modifier.
VC3	VC3 Path
VC44C	VC4-4C Path
VC38C	VC3-8C Path
VC464C	VC4-64C Path
VC48C	VC4-8C Path
VC4	VC4 Path
VC416C	VC4-16C Path
VC42C	VC4-2C Path
VC43C	VC4-3C Path
VC11	VC11 Path
VC12	VC12 Path
<TXCOUNT>	Number of VCG members in the transmit direction. For ML1000-2 and ML100T-12 cards, the only valid value is 2. For the FC_MR-4 card, the only valid value is 8. TXCOUNT is an integer.
<CCT>	Type of connection: one-way or two-way. Cross-connect type for the VCG member cross-connects. The parameter type is CCT, which is the type of cross-connect to be created.
1WAY	A unidirectional connection from a source tributary to a destination tributary.
1WAYDC	SNCP multicast drop (1-way continue)
1WAYEN	SNCP multicast end node (1-way continue)
1WAYMON	A bidirectional connection between the two tributaries Note: 1WAYMON is not supported with TL1. However, it is still supported from CTC. Using CTC, you can create 1WAYMON cross-connects that can be retrieved through TL1.
1WAYPCA	A unidirectional connection from a source tributary to a destination tributary on the protection path/fiber
2WAY	A bidirectional connection between the two tributaries
2WAYDC	A bidirectional drop and continue connection applicable only to SNCP traditional and integrated DRIs
2WAYPCA	A bidirectional connection between the two tributaries on the extra protection path/fiber
DIAG	Diagnostics cross-connect. Supports BERT (MS-SPRing PCA diagnostics cross-connect).
<LCAS>	(Optional) Link capacity adjustment scheme. The parameter type is LCAS, which is the link capacity adjustment scheme mode for the VCG created.
LCAS	LCAS is enabled.
NONE	No LCAS.
SW-LCAS	Supports the temporary removal of a VCG member during the member failure. Only supported by the ML1000-2 and ML100T-12 cards.
<BUFFERS>	(Optional) Buffer type. The default value is DEFAULT. The FC_MR-4 card supports DEFAULT and EXPANDED buffers. Other data cards support DEFAULT buffers only. The parameter type is BUFFER_TYPE, which is the buffer type used in the VCAT.
DEFAULT	Default buffer value
EXPANDED	Expanded buffer value
<NAME>	(Optional) Name of the VCAT group. NAME is a string.
<PST>	Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
Unlocked	In service
Locked	Out of service

RTRV-VLAN

(Cisco ONS 15454 SDH) The Retrieve Virtual LAN (RTRV-VLAN) command retrieves a virtual LAN entry from the VLAN database. The VLAN database is a collection of VLANs used in an NE.

Usage Guidelines

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

Category

Ethernet

Security

Retrieve

Input Format

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

Input Example

RTRV-VLAN:ROCKS:VLAN-4096:1;

Input Parameters

<AID>	The AID is used to access the VLAN.
VLAN-{0-4096}	The AID for a single VLAN. The value 0 is reserved for untagged VLANs.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[NAME=<NAME>],[PROTN=<PROTN>]:" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VLAN-4096::NAME="MYVLAN",PROTN=Y:" ;

Output Parameters

<AID>	The AID is used to access the VLAN.
VLAN-{0-4096}	The AID for a single VLAN. The value 0 is reserved for untagged VLANs.
<NAME>	Indicates the VLAN name.
<PROTN>	Indicates the VLAN protection (enabled or disabled).
Y	VLAN protection is enabled.
N	(Default) VLAN protection is disabled.

RTRV-WDMANS

(Cisco ONS 15454 SDH) The Retrieve Wavelength Division Multiplexing Automatic Node Setup (RTRV-WDMANS) command retrieves the automatic optical node setup application attributes.

Usage Guidelines

None

Category

DWDM

Security

Maintenance

Input Format

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

Input Example

RTRV-WDMANS:PENNGROVE:WDMANS-W:114;

Input Parameters

<WDMSIDE>	The AID is used to access the WDM side on an DWDM node.
WDMSIDE-{UNKNOWN,A,B,C,D,E,F,G,H}	DWDM side identifier
<WDMNODE>	The AID is used to access the WDM node on an DWDM node.
WDMNODE	DWDM side identifier

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[POWERIN=<POWERIN>],[POWEROUT=<POWEROUT>], [POWEREXP=<POWEREXP>],[NTWTYPE=<NTWTYPE>], [OPTICALTYPE=<OPTICALTYPE>],[LASTRUNDAT=<LASTRUNDAT>], [LASTRUNTM=<LASTRUNTM>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "WDMNODE::NTWTYPE=METRO-CORE,OPTICALTYPE=OADM,NEPLAUNCH=10.0, FEPLAUNCH=10.0,PPMESH=4-DEGREE,DITHER=10.0,LASTRUNDAT=01-01-01, LASTRUNTM=10-55-00,LASTCALCDAT=01-01-01,LASTCALCTM=10-55-00:" ;

Output Parameters

<WDMSIDE>	The AID is used to access the WDM side on an DWDM node.
WDMSIDE-{UNKNOWN,A,B,C, D,E,F,G,H}	DWDM side identifier
<WDMNODE>	The AID is used to access the WDM node on an DWDM node.
WDMNODE	DWDM side identifier
<POWERIN>	(Optional) Input power for an OADM section of an OADM NE. POWERIN is a float.
<POWERINFLG>	Status flag indicating the state of the WDMANS parameter.
<POWEROUT>	(Optional) Output power for an OADM or multiplex/demultiplex section of HUB, TERMINAL, or OADM nodes. POWEROUT is a float.
<POWEROUTFLG>	Status flag indicating the state of the WDMANS parameter.
<POWEREXP>	(Optional) Express power for a multiplex/demultiplex section of a HUB or TERMINAL NE. POWEREXP is a float.
<POWEREXPFLG>	Status flag indicating the state of the WDMANS parameter.
<NTWTYPE>	(Optional) Type of network with DWDM node installed. The parameter type is DWDM_RING_TYPE, which is the network type where the NE is installed.
METRO-ACCESS	The network where a DWDM node is installed is a metro access network.
METRO-CORE	The network where a DWDM node is installed is a metro core network.
NONE	A node that does not have a standard DWDM configuration.
<OPTICALTYPE>	(Optional) The optical configuration type for the NE. The parameter type is OPTICAL_NODE_TYPE, which is the optical configuration type for the NE.
HUB	A terminal site EAST, WEST, or both with 32-channel multiplexer and demultiplexer cards
LINE-AMPLIFIED	A line site with booster amplifier cards
OADM	A site with OADM cards
OSC-REG	An OSC regeneration site with two OSC-CSM cards in each side
ROADM	A site with ROADM cards
TDM-HYBRID	A time-division multiplexing (TDM) node with an amplifier directly connected to a TXP/MXP card
UNKNOWN	The node type is undefined.
<NEPLAUNCH>	Near-end launch power calculated by the node when the user ran the calculation of WDMANS parameters.
<FEPLAUNCH>	Far-end launch power received by the node when user ran the calculation of WDMANS parameters.
<PPMESH>	Defines the degree of the node having the WXC cards.
<DITHER>	It is a number that uniquely identifies a node having at least a WXC card inside the DWDM network.
<LASTRUNDAT>	(Optional) The last date when the WDMANS application was run automatically or by user request. The format is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<LASTRUNTM>	(Optional) The last time when the WDMANS application was run automatically or by user request. The format is HH-MM, where HH (hour of day) ranges from 1 to 23 and MM (minute of hour) ranges from 0 to 59.
<LASTCALCDAT>	(Optional) The last date when the WDMANS application was run automatically or by user request. The format is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<LASTCALSTM>	(Optional) The last time when the WDMANS application was run automatically or by user request. The format is HH-MM, where HH (hour of day) ranges from 1 to 23 and MM (minute of hour) ranges from 0 to 59.

RTRV-WDMSIDE

(Cisco ONS 15454 SDH) The Retrieve Wavelength Division Multiplexing Side (RTRV-WDMSIDE) command retrieves the WDM side and defines its attributes.

Usage Guidelines

None

Category

DWDM

Security

Maintenance

Input Format

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

Input Example

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

Input Parameters

<AID>	The AID is used to access the WDM side of an DWDM node. This is applicable to WDMANS and APC applications of the NE.
WDMSIDE-{A,B,C,D,E,F,G,H}	DWDM side identifier.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::LINEIN=<LINEIN>,LINEOUT=<LINEOUT>,[OCS=<OSC>][:]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "WDMSIDE-A::LINEIN=LINE-1-3-RX,LINEOUT=LINE-1-3-TX,OSC=FAC-8-1" ;

Output Parameters

<AID>	The AID is used to access the WDM side of an DWDM node. This is applicable to WDMANS and APC applications of the NE.
WDMSIDE-{A,B,C,D,E,F,G,H}	DWDM side identifier.
<LINEIN>	Used to access the OTS layer of optical network units.
ALL	Indicates all the OTSs of the NE. The ALL AID is applicable only for retrieve commands.
LINE[-{1-8}]-{1-6,12-17}-{1-3}-ALL	All the lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-ALL.
LINE[-{1-8}]-{1-6,12-17}-{1-3}-{RX,TX}	The receive/transmit lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-[DIRN].
<LINEOUT>	Used to access the OTS layer of optical network units.
ALL	Indicates all the OTSs of the NE. The ALL AID is applicable for retrieve-only commands.
LINE[-{1-8}]-{1-6,12-17}-{1-3}-ALL	All the lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-ALL.
LINE[-{1-8}]-{1-6,12-17}-{1-3}-{RX,TX}	The receive/transmit lines (COM=1, OSC=2, LINE=3) in OPT-BST, OPT-BST-E, OPT-BST-L, OPT-AMP-17-C, and OPT-AMP-23-C cards where the format is LINE-[SHELF]-[SLOT]-[PORT]-[DIRN].
<OSC>	(Optional) Facility AID from the FACILITY.

RTRV-WLEN

(Cisco ONS 15454) The Retrieve Wavelength (RTRV-WLEN) command retrieves the wavelength provisioning information.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-WLEN:PENNGROVE:WLEN-A-ADD-1530.33:114;

Input Parameters

<AID>

Access identifier from the WLEN.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>],[TOSIDE=<TOSIDE>],[SRC=<SRC>], [DST=<DST>]:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "WLEN-A-ADD-1530.33:1WAY:SIZE=MULTI-RATE,CKTID=CKTID,SRC=CHAN-4-1-RX, DST=LINEWL-1-3-TX-1530.33:OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the WLEN.
<CCT>	Identifies the wavelength connection types.
1WAY	A unidirectional wavelength connection for one specified ring direction.
2WAY	A bidirectional wavelength connection for both the ring directions
<SIZE>	Identifies the DWDM circuit size used on a wavelength.
<CKTID>	(Optional) Circuit identification parameter that contains the a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. CKTID is a string.
<TOSIDE>	The AID is used to access the WDM side of a DWDM node.
WDMSIDE-{A,B,C,D,E,F,G,H}	DWDM side identifier.
<SRC>	Source access identifier from the LINEWL.
<DST>	Destination AID of the cross-connection from the LINEWL.
<PST_PSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (PST) and primary state qualifier (PSTQ).
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is secondary state (SST), which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>],[TOSIDE=<TOSIDE>],[SRC=<SRC>], [DST=<DST>]:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "WLEN-A-ADD-1530.33:1WAY:SIZE=MULTI-RATE,CKTID=CKTID,SRC=CHAN-4-1-RX, DST=LINEWL-1-3-TX-1530.33:OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the WLEN.
<CCT>	Identifies the wavelength connection types.
1WAY	A unidirectional wavelength connection for one specified ring direction.
2WAY	A bidirectional wavelength connection for both the ring directions
<SIZE>	Identifies the DWDM circuit size used on a wavelength.
<CKTID>	(Optional) Circuit identification parameter that contains the a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. CKTID is a string.
<TOSIDE>	The AID is used to access the WDM side of a DWDM node.
WDMSIDE-{A,B,C,D,E,F,G,H}	DWDM side identifier.
<SRC>	Source access identifier from the LINEWL.
<DST>	Destination AID of the cross-connection from the LINEWL.
<PST_PSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (PST) and primary state qualifier (PSTQ).
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is secondary state (SST), which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<CCT>:[SIZE=<SIZE>],[CKTID=<CKTID>],[TOSIDE=<TOSIDE>],[SRC=<SRC>], [DST=<DST>]:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "WLEN-A-ADD-1530.33:1WAY:SIZE=MULTI-RATE,CKTID=CKTID,SRC=CHAN-4-1-RX, DST=LINEWL-1-3-TX-1530.33:OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the WLEN.
<CCT>	Identifies the wavelength connection types.
1WAY	A unidirectional wavelength connection for one specified ring direction.
2WAY	A bidirectional wavelength connection for both the ring directions
<SIZE>	Identifies the DWDM circuit size used on a wavelength.
<CKTID>	(Optional) Circuit identification parameter that contains the a common language ID or other alias of the circuit being provisioned. It cannot contain blank spaces. CKTID is a string.
<TOSIDE>	The AID is used to access the WDM side of a DWDM node.
WDMSIDE-{A,B,C,D,E,F,G,H}	DWDM side identifier.
<SRC>	Source access identifier from the LINEWL.
<DST>	Destination AID of the cross-connection from the LINEWL.
<PST_PSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the primary state (PST) and primary state qualifier (PSTQ).
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is secondary state (SST), which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

Currently 0.00/5
1
2
3
4
5

Rating: 0.0/5 (0 votes cast)

ONS SDH TL1 Command Guide R8.5.1 -- RTRV Commands (P through W)

From DocWiki

Contents

RTRV-PM-<MOD2>

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-PM-ALL

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-PMMODE-<VC_PATH>

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-PMSCHED-<MOD2>

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-PMSCHED-ALL

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-POS

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-PROTNSW-<MOD2DWDMPAYLOAD>

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-PROTNSW-<STM_TYPE>

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters