ONS SONET TL1 Command Guide R8.5.1 -- RTRV Commands (D through P)

From DocWiki

1 RTRV-DFLT-SECU
- 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-DS1
- 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-EC1
- 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-EQPT
- 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-ESCON
- 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-ETH
- 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-EXT-CONT
- 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-FAC
- 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-FFP
- 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-FFP-<MOD2DWDMPAYLOAD>
- 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-FFP-<OCN_TYPE>
- 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-FFP-OCH
- 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-FSTE
- 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-FTPSERVER
- 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-G1000
- 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-GFP
- 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-GIGE
- 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-HDLC
- 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-HDR
- 19.1 Usage Guidelines
- 19.2 Category
- 19.3 Security
- 19.4 Input Format
- 19.5 Input Example
- 19.6 Input Parameters
20 RTRV-INV
- 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-L2-ETH
- 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-LMP
- 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-LMP-CTRL
- 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-LMP-TLINK
- 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-LMP-DLINK
- 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-LNK
- 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-LNKTERM
- 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-LOG
- 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-MAP-NETWORK
- 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-NE-APC
- 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-NE-GEN
- 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-NE-IPMAP
- 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-NE-PATH
- 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-NE-SYNCN
- 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-NE-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-NETYPE
- 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-NNI-ETH
- 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
38 RTRV-OCH
- 38.1 Usage Guidelines
- 38.2 Category
- 38.3 Security
- 38.4 Input Format
- 38.5 Input Example
- 38.6 Input Parameters
- 38.7 Output Format
- 38.8 Output Example
- 38.9 Output Parameters
39 RTRV-OCHCC
- 39.1 Usage Guidelines
- 39.2 Category
- 39.3 Security
- 39.4 Input Format
- 39.5 Input Example
- 39.6 Input Parameters
- 39.7 Output Format
- 39.8 Output Example
- 39.9 Output Parameters
40 RTRV-OCHNC
- 40.1 Usage Guidelines
- 40.2 Category
- 40.3 Security
- 40.4 Input Format
- 40.5 Input Example
- 40.6 Input Parameters
- 40.7 Output Format
- 40.8 Output Example
- 40.9 Output Parameters
41 RTRV-OMS
- 41.1 Usage Guidelines
- 41.2 Category
- 41.3 Security
- 41.4 Input Format
- 41.5 Input Example
- 41.6 Input Parameters
- 41.7 Output Format
- 41.8 Output Example
- 41.9 Output Parameters
42 RTRV-OPM
- 42.1 Usage Guidelines
- 42.2 Category
- 42.3 Security
- 42.4 Input Format
- 42.5 Input Example
- 42.6 Input Parameters
- 42.7 Output Format
- 42.8 Output Example
- 42.9 Output Parameters
43 RTRV-OTS
- 43.1 Usage Guidelines
- 43.2 Category
- 43.3 Security
- 43.4 Input Format
- 43.5 Input Example
- 43.6 Input Parameters
- 43.7 Output Format
- 43.8 Output Example
- 43.9 Output Parameters
44 RTRV-PATH-OCH
- 44.1 Usage Guidelines
- 44.2 Category
- 44.3 Security
- 44.4 Input Format
- 44.5 Input Example
- 44.6 Input Parameters
- 44.7 Output Format
- 44.8 Output Example
- 44.9 Output Parameters
45 RTRV-PM-<MOD2>
- 45.1 Usage Guidelines
- 45.2 Category
- 45.3 Security
- 45.4 Input Format
- 45.5 Input Example
- 45.6 Input Parameters
- 45.7 Output Format
- 45.8 Output Example
- 45.9 Output Parameters
46 RTRV-PM-ALL
- 46.1 Usage Guidelines
- 46.2 Category
- 46.3 Security
- 46.4 Input Format
- 46.5 Input Example
- 46.6 Input Parameters
- 46.7 Output Format
- 46.8 Output Example
- 46.9 Output Parameters
47 RTRV-PMMODE-<STS_PATH>
- 47.1 Usage Guidelines
- 47.2 Category
- 47.3 Security
- 47.4 Input Format
- 47.5 Input Example
- 47.6 Input Parameters
- 47.7 Output Format
- 47.8 Output Example
- 47.9 Output Parameters
48 RTRV-PMMODE-<VT_PATH>
- 48.1 Usage Guidelines
- 48.2 Category
- 48.3 Security
- 48.4 Input Format
- 48.5 Input Example
- 48.6 Input Parameters
- 48.7 Output Format
- 48.8 Output Example
- 48.9 Output Parameters
49 RTRV-PMSCHED-<MOD2>
- 49.1 Usage Guidelines
- 49.2 Category
- 49.3 Security
- 49.4 Input Format
- 49.5 Input Example
- 49.6 Input Parameters
- 49.7 Output Format
- 49.8 Output Example
- 49.9 Output Parameters
50 RTRV-PMSCHED-ALL
- 50.1 Usage Guidelines
- 50.2 Category
- 50.3 Security
- 50.4 Input Format
- 50.5 Input Example
- 50.6 Input Parameters
- 50.7 Output Format
- 50.8 Output Example
- 50.9 Output Parameters
51 RTRV-POS
- 51.1 Usage Guidelines
- 51.2 Category
- 51.3 Security
- 51.4 Input Format
- 51.5 Input Example
- 51.6 Input Parameters
- 51.7 Output Format
- 51.8 Output Example
- 51.9 Output Parameters
52 RTRV-PROTNSW-<MOD2DWDMPAYLOAD>
- 52.1 Usage Guidelines
- 52.2 Category
- 52.3 Security
- 52.4 Input Format
- 52.5 Input Example
- 52.6 Input Parameters
- 52.7 Output Format
- 52.8 Output Example
- 52.9 Output Parameters
53 RTRV-PROTNSW-<OCN_TYPE>
- 53.1 Usage Guidelines
- 53.2 Category
- 53.3 Security
- 53.4 Input Format
- 53.5 Input Example
- 53.6 Input Parameters
- 53.7 Output Format
- 53.8 Output Example
- 53.9 Output Parameters
54 RTRV-PROTNSW-<PATH>
- 54.1 Usage Guidelines
- 54.2 Category
- 54.3 Security
- 54.4 Input Format
- 54.5 Input Example
- 54.6 Input Parameters
- 54.7 Output Format
- 54.8 Output Example
- 54.9 Output Parameters
55 RTRV-PROTNSW-OCH
- 55.1 Usage Guidelines
- 55.2 Category
- 55.3 Security
- 55.4 Input Format
- 55.5 Input Example
- 55.6 Input Parameters
- 55.7 Output Format
- 55.8 Output Example
- 55.9 Output Parameters
56 RTRV-PROTOCOL
- 56.1 Usage Guidelines
- 56.2 Category
- 56.3 Security
- 56.4 Input Format
- 56.5 Input Example
- 56.6 Input Parameters
- 56.7 Output Format
- 56.8 Output Example
- 56.9 Output Parameters
57 RTRV-PTHTRC-<PATH>
- 57.1 Usage Guidelines
- 57.2 Category
- 57.3 Security
- 57.4 Input Format
- 57.5 Input Example
- 57.6 Input Parameters
- 57.7 Output Format
- 57.8 Output Example
- 57.9 Output Parameters

RTRV-DFLT-SECU

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Default Security (RTRV-DFLT-SECU) command retrieves the system-wide default values associated with several security parameters.

Usage Guidelines

None

Category

Security

Superuser

Input Format

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

Input Example

RTRV-DFLT-SECU:CISCO:ALL:123;

Input Parameters

<AID>

Access identifier. ALL is the only acceptable value. AID is a string.

Output Format

SID DATE TIME M CTAG COMPLD "<NE>:PAGE=<PAGE>,PCND=<PCND>,MXINV=<MXINV>,DURAL=<DURAL>, TMOUT=<TMOUT>,UOUT=<UOUT>,PFRCD=<PFRCD>,POLD=<POLD>,PINT=<PINT>, LOGIN=<LOGIN>,PRIVLVL=<PRIVLVL>],[PDIF=<PDIF>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "TCC2:PAGE=40,PCND=5,MXINV=5,DURAL=30,TMOUT=0,UOUT=60,PFRCD=NO, POLD=5,PINT=20,LOGIN=MULTIPLE,PRIVLVL=RTRV,PDIF=1" ;

Output Parameters

<NE>	The node name of the NE where the system values are to be retrieved.
<PAGE>	Password aging interval. It is the number of days before a user is prompted to change his or her password. 0 indicates the policy is turned off and is the default. If PAGE is turned on for all privilege levels and is not specified for each privilege level, it defaults to 45 days. PAGE ranges from 20 to 90 days. PAGE is an integer.
<PCND>	Number of days a password can be used before a new one is mandatory (for example, the warning period). Default is 5 days. PCND ranges from 2 to 20 days. PCND is an integer.
<MXINV>	Maximum number of consecutive and invalid session set up attempts allowed to occur before an intrusion attempt is suspected (for example, "Failed Logins Before Lockout" from CTC). 0 indicates the policy is turned off. Default is 5. MXINV ranges from 0 to 10. MXINV is an integer.
<DURAL>	Time interval (in seconds) during which a user ID is locked out when an intrusion attempt is suspected (for example, the "Lockout Duration"). If the user is locked out until unlocked by a Superuser, DURAL=INFINITE. Default is 30 seconds. DURAL ranges from 0 to 600 seconds. DURAL is 0 for RTRV users, 60 minutes for MAINT users, 30 minutes for PROV users, and 15 minutes for SUPER users. DURAL is a string.
<TMOUT>	Interval (in minutes) after which a session is terminated if no messages are exchanged between the user and the NE. 0 indicates that the session will not timeout. TMOUT is an integer.
<UOUT>	UID aging interval, expressed in days. If a userid has not been used in UOUT days, the user will be forced to change his/her password (or logout) at the next login. No other command is allowed until the password has been changed. 0 indicates the policy is turned off and is the default. UOUT ranges from 1 to 99 days. UOUT is an integer.
<PFRCD>	Indicates if a password change is required when a new user establishes a session to the NE for the first time. (For example, "Require password change on 1st login"). Default is NO. 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	Password change is not required.
YES	Password change is required.
<POLD>	Number of prior passwords that cannot be reused (for example, "Prevent reusing last X passwords"). Default is 1. POLD ranges from 0 to 10. POLD is an integer.
<PINT>	Number of days that must pass before a password can be changed. If PINT is 0, the policy is turned off. Default is off. PINT ranges from 20 to 95 days. PINT is an integer.
<LOGIN>	Number of times a user can log into an NE. LOGIN is either SINGLE or MULTIPLE. If LOGIN is SINGLE, a user can only log into an NE one time with any given userid, regardless of the method of login (for example, CTC, TL1, etc.). Default is MULTIPLE. The parameter type is USER_LOGINS, which is the number of times a user can log into the same NE with the same user ID.
MULTIPLE	A user can log into the same NE many times.
SINGLE	A user can log into the NE only once (includes both CTC and TL1 sessions).
<PRIVLVL>	Parameter type is PRIVILEGE, which is the security level.
MAINT	Maintenance security level. Unlimited idle time.
PROV	Provision security level. 60 minutes of idle time.
RTRV	Retrieve security level. 30 minutes of idle time.
SUPER	Superuser security level. 15 minutes of idle time.
<PDIF>	(Optional) Indicates how many characters must differ between old and new passwords. Default minimum character difference is 1. Ranges from 0 to 5 characters. PDIF is an integer.

RTRV-DS1

(Cisco ONS 15454) The Retrieve DS1 (RTRV-DS1) command retrieves the test access attributes on a DS1 layer of a DS3XM card.

Usage Guidelines

Both the MODE and the FMT fields of this command are applied for the DS3XM-12 card only.
If the DS1 mode of the DS3XM-12 is ATT, the DS1 path can retrieve AT&T/54016 FEND PM counts up to 96 15-minute intervals; if the DS1 mode of the DS3XM-12 is FDL, the DS1 path can retrieve FDL/T1-403 FEND PM counts up to 32 15-minute intervals in RTRV-PM-DS1.
For the DS3XM-12 card, the DS1 frame format NE default is AUTO_PROV_FMT for the first 30 seconds to determine the real format. After 30 seconds, the DS1 frame format is the detected frame. If the frame format is not determined, it will be in the UNFRAMED format.
For the preprovisioning DS3XM-12 card, its DS1 frame format defaults to UNFRAMED.
For the DS3XM-12 card, the DS1-configurable attributes (PM, TH, alarm, etc.) only apply to the ported ports (1 to 12) and the VT-mapped (odd) portless ports in xxx-xxx-DS1 commands. Provisioning or retrieving DS1 attributes on the DS3-mapped (even) portless ports in xxx-xxx-DS1 commands is not allowed.
The parameters BERTMODE, BERTPATTERN, BERTERRCOUNT, BERTERRRATE, and BERTSYNCSTATUS apply only to DS1/E1-56 and DS3XM-12 cards
BERT is implemented on a single port.

Category

Ports

Security

Retrieve

Input Format

RTRV-DS1:[<TID>]:<DS1AID>:<CTAG>[::::];

Input Example

RTRV-DS1:PETALUMA:DS1-2-1-6-12:123;

Input Parameters

The DS1 path access identifier of the DS3XM card from the DS1.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[AISONLPBK=<AISONLPBK>], [MODE=<MODE>],[FMT=<FMT>],[BERTMODE=<BERTMODE>], [BERTPATTERN=<BERTPATTERN>],[BERTERRCOUNT=<BERTERRCOUNT>], [BERTERRRATE=<BERTERRRATE>], [BERTSYNCSTATUS=<BERTSYNCSTATUS>]";

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "DS1-2-1-6-12::TACC=8,TAPTYPE=SINGLE,MODE=FDL,FMT=ESF,BERTMODE=NONE, BERTPATTERN=NONE,BERTERRCOUNT=0,BERTERRRATE=NONE, BERTSYNCSTATUS=N";

Output Parameters

<AID>	(Optional) Access identifier from the DS1.
<TACC>	(Optional) Indicates whether the digroup being provisioned is to be used as a test access digroup. Default is N. TACC is an integer.
<TAPTYPE>	(Optional) TAP type. The parameter type is TAPTYPE, which is the test access point type.
DUAL	Dual FAD
SINGLE	Single FAD
<AISONLPBK>	(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates if an AIS is sent on a loopback.
AIS_ONLPBK_FACILITY	AIS is sent on facility loopbacks.
AIS_ON_LPBK_ALL	AIS is sent on all loopbacks.
AIS_ON_LPBK_OFF	AIS is not sent on loopbacks.
AIS_ON_LPBK_TERMINAL	AIS is sent on terminal loopbacks.
<MODE>	(Optional) Mode. The parameter type is DS1MODE, which is the DS1 path mode of the DS3XM-12 card
ATT	Indicates the DS1 path of the DS3XM-12 is in AT&T 54016 mode.
FDL	Indicates the DS1 path of the DS3XM-12 is in FDL T1-403 mode.
<FMT>	(Optional) Digital signal frame format. The parameter type is FRAME_FORMAT, which is the frame format for a T1 port.
D4	Frame format is D4.
ESF	Frame format is ESF.
UNFRAMED	Frame format is unframed.
<BERTMODE>	Specifies the mode [Test Pattern Generator (TPG) or Test Pattern Monitor (TPM)] of the port for BERT.
NONE	BERT mode not enabled.
TPGM-L	Test pattern generator and monitor on line side.
TPGM-B	Test pattern generator and monitor on backplane.
TPG-L	Test pattern generator on line side.
TPM-L	Test pattern monitor on line side.
TPG-B	Test pattern generator on backplane.
TPM-B	Test pattern monitor on backplane.
<BERTPATTERN>	Specifies the error pattern to be injected for BERT.
NONE	BERT pattern not enabled.
PRBS15	PRBS15 test pattern.
PRBS20	PRBS20 test pattern.
PRBS23	PRBS23 test pattern.
QRSS	QRSS test pattern.
ALT-ONE-ALT-ZERO	Alternate one and zero pattern.
<BERTERRCOUNT>	Integer value. Value -1 indicates that BERT is disabled/not supported.
<BERTERRRATE>	Specifies the BERT error rate received.
NONE	No bit errors.
SINGLE	Single bit error.
1E-3	Bit errors in 1E-3 rate.
1E-4	Bit errors in 1E-4 rate.
1E-5	Bit errors in 1E-5 rate.
1E-6	Bit errors in 1E-6 rate.
<BERTSYNCSTATUS>	Synchronization status of BERT values. The parameter type is Y_N, which specifies if synchronization status is up or down.
Y	BERT synchronization status is up.
N	BERT synchronization status is down.

RTRV-EC1

(Cisco ONS 15454, ONS 15310-MA) The Retrieve Electrical Carrier (RTRV-EC1) command retrieves the facility status of an EC1 card.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-EC1:CISCO:FAC-1-1:1234;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[PJMON=<PJMON>],[LBO=<LBO>],[RXEQUAL=<RXEQUAL>],[SOAK=<SOAK>], [SOAKLEFT=<SOAKLEFT>],[SFBER=<SFBER>],[SDBER=<SDBER>],[NAME=<NAME>], [EXPTRC=<EXPTRC>],[TRC=<TRC>],[TRCMODE=<TRCMODE>], [TRCFORMAT=<TRCFORMAT>],[AISONLPBK=<AISONLPBK>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::PJMON=0,LBO=0-225,RXEQUAL=Y,SOAK=52,SOAKLEFT=12-25,SFBER=1E-4, SDBER=1E-7,NAME=\"EC1 PORT\",EXPTRC="AAA",TRC="AAA",TRCMODE=MAN, TRCFORMAT=16-BYTE,AISONLPBK=AIS_ON_LPBK_ALL:IS-NR,AINS" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<PJMON>	(Optional) A SONET pointer monitor attribute of an EC1 port. PJMON is an integer.
<LBO>	(Optional) Line buildout settings. LBO is an integer. The parameter type is E_LBO, which is the electrical signal line buildout.
0-225	Electrical signal line buildout range is 0-225.
226-450	Electrical signal line buildout range is 226-450.
<RXEQUAL>	(Optional) Parameter type is EXT_RING, which indicates if the ring supports the extended K1/K2/K3 protocol.
N	The ring does not support the extended K1/K2/K3 protocol.
Y	The ring does support the extended K1/K2/K3 protocol.
<SOAK>	IS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>	(Optional) Time remaining for the transition from OOS-AINS to IS measured in 1-minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows: When the port is in OOS, OOS_MT, or IS state, the parameter will not appear. When the port is in IS-AINS but the countdown has not started due to fault signal, the value will be SOAKLEFT=NOT-STARTED. When the port is in IS_AINS state and the countdown has started, the value will be shown in HH-MM format.
<SFBER>	(Optional) Signal failure threshold. The default value is 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) 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.
<NAME>	(Optional) Port Name. NAME is a string.
<EXPTRC>	(Optional) EXPTRC is a string.
<TRC>	(Optional) TRC is a string.
<TRCMODE>	(Optional) Trace mode. The parameter type is TRCMODE.
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 TIM-P is detected.
MAN	Use the provisioned expected string as the expected string.
MAN-NO-AIS	Use the provisioned expected string as the expected string and do not turn on AIS and RDI if TIM-P is detected.
OFF	Turn off path trace capability. Nothing will be reported.
<TRCFORMAT>	(Optional) Trace message size. The parameter type is TRCFORMAT (trace format).
1-BYTE	1-byte trace message
16-BYTE	16-byte trace message
64-BYTE	64-byte trace message
Y	Enable an attribute.
<AISONLPBK>	(Optional) AIS on loopback. The parameter type is AIS_ON_LPBK, which indicates if an AIS is sent on a loopback.
AIS_ONLPBK_FACILITY	AIS is sent on facility loopbacks.
AIS_ON_LPBK_ALL	AIS is sent on all loopbacks.
AIS_ON_LPBK_OFF	AIS is not sent on loopbacks.
AIS_ON_LPBK_TERMINAL	AIS is sent on terminal loopbacks.
<PST_PSTQ>	Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the SST and PSTQ.
IS-NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-EQPT

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Equipment (RTRV-EQPT) command retrieves the data parameters and state parameters associated with a card or shelf.

Usage Guidelines

This command returns the PRTYPE, PROTID, RVTM, and RVRTV parameters for a card inside a protection group according to the following scenarios:

A working AID/card within a 1:1 protection group will return PRTYPE, PROTID, RVTM, and RVRTV.
A protection/AID card within a 1:1 protection group will return PRTYPE, RVTM, and RVRTV.
A working AID/card within a 1:N protection group will return PRTYPE, PROTID, RVTM, and RVRTV=Y.
A protection AID/card of a 1:1 protection group will return PRTYPE, RVTM, and RVRTV=Y.
An unprotected AID/card will return the AID type, equip (equip/unequip), status (act/standby), and state (IS/OOS) values.
Preprovisioned cards (without being plugged in) will display OOS,AINS for PST and SST. After the card is plugged in and has gone through its initialization sequence, the card automatically goes to IS state (PST).
The CARDMODE parameter is displayed for ML-Series Ethernet, FC_MR-4, DS1/E1-56, and DWDM xponder cards.
The RETIME and TRANSMODE parameters are only displayed for the DS1/E1-56 card.

Error conditions:

The NE will generate an error when the equipment is not provisioned.

Category

Equipment

Security

Retrieve

Input Format

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

Input Example

RTRV-EQPT:MIRABEL:SLOT-12:230;

Input Parameters

<AID>

Access identifier from the EQPT.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<AIDTYPE>,<EQUIP>,<EQUIP>,,[<STATUS>]:[CARDNAME=<CARDNAME>],CARDMODE=<CARDMODE>],:[<PSTPSTQ>,<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "SLOT-12:DS1,EQUIP,,ACT:PROTID=SLOT-13,PRTYPE=1-1,RVRTV=Y,RVTM=8.5, CARDNAME=DESCRIPTION,IOSCFG="IOS CONFIG INFO FOR ML SERIES CARD", CARDMODE=DS3XM12-STS48,PEERID=SLOT-1,REGENNAME="THIS GROUP", TRANSMODE=SONET,RETIME=Y,SHELFROLE=NC:OOS-AU,AINS&UEQ" ;

Output Parameters

<AID>	Access identifier from the EQPT.
<AIDTYPE>	The type of facility, link, or other addressable entity targeted by the message. The parameter type is EQUIPMENT-TYPE (equipment type).
10GE-XP	(ONS 15454) 2 x 10 Gbps. muxponder/L2 ethernet switch card
32-DMX	(ONS 15454) 32 channel optical demultiplexer
32-DMX-L	(ONS 15454) 32 channel optical demultiplexer for L-band
32-DMX-O	(ONS 15454) 32 channel unidirectional optical demultiplexer This overrides the old equipment type DMX-32 present in the 4.6 and earlier releases.
32-MUX-O	(ONS 15454) 32 channel unidirectional optical multiplexer This overrides the old equipment type MUX-32 present in the 4.6 and earlier releases.
32-WSS	(ONS 15454) 32 channel optical wavelength selective switch for C Band
40-DMX-C	(ONS 15454) 40 channel optical demultiplexer for C Band
40-MUX-C	(ONS 15454) 40 channel optical multiplexer for C Band
40-WSS-C	(ONS 15454) 40 channel optical wavelength switch selector for C Band
40-WXC-C	(ONS 15454) 40 channel optical wavelength cross-connect/wavelength router for C Band
AD-1B	(ONS 15454) Optical add/drop multiplexed (OADM) 1 band filter
AD-1C	(ONS 15454) Optical add/drop multiplexed (OADM) 1 channel filter
AD-2C	(ONS 15454) Optical add/drop multiplexed (OADM) 2 channels filter
AD-4B	(ONS 15454) Optical add/drop multiplexed (OADM) 4 bands filter
AD-4C	(ONS 15454) Optical add/drop multiplexed (OADM) 4 channels filter
ADM-10G	(ONS 15454) 16 x OC3/OC12/OC48/GIGE and OC192/Trunk ADM 10 Gbps card
AIC	(ONS 15454) AIC card
AICI	(ONS 15454) AICI Card
ASAP-4	(ONS 15600) Any service any port (ASAP) carrier card with four PIM slots
CE-1000-4	(ONS 15454) CE-1000-4 mapper card
CE-100T-8	(ONS 15454, ONS 15310-CL, ONS 15310-MA) CE-100T-8 mapper card
CE-MR-10	(ONS 15454, ONS 15454 SDH) CE-MR-10 data card
CE-MR-6	(ONS 15310-MA) CE-MR-6 data card
CTX-2500	(ONS 15310-MA) CTX card
CXC	(ONS 15600) Cross connect card
DS1-28-DS3-EC1-3	(ONS 15310-MA) DS1-28-DS3-EC1-3 card
DS1-84-DS3-EC1-3	(ONS 15310-MA) DS1-84-DS3-EC1-3 card
DS1-E1-56	(ONS 15454) DS1-E1-56 card
DS1I	(ONS 15454) DS1I card
DS1N	(ONS 15454) DS1N card
DS3	(ONS 15454) DS3 card
DS3-EC1-48	(ONS 15454) DS3-EC1-48 card type
DS3E	(ONS 15454) DS3E card
DS3I	(ONS 15454) DS3I card
DS3IN	(ONS 15454) DS3IN card
DS3N	(ONS 15454) DS3N card
DS3NE	(ONS 15454) DS3NE card
DS3XM	(ONS 15454) DS3XM card
DS3XM-12	(ONS 15454) DS3XM-12 card
E1-42	(ONS 15454) 42 port E1 card
E1000T	(ONS 15454) E1000T card
E100T	(ONS 15454) E100T card
E3	(ONS 15454) E3 card
EC1	(ONS 15454) EC1 card
FC-MR-4	(ONS 15454) FC-MR-4 card
FILLER-CARD	(ONS 15454, ONS 15600, ONS 15310-CL, ONS 15310-MA) Blank filler card
G1000-4	(ONS 15454) A 4-port G1000 card
GE-XP	(ONS 15454) 20 x 1 Gbps muxponder/L2 ethernet switch card
MD-4	(ONS 15454) Four channel optical multiplexer/demultiplexer
ML-100T-8	(ONS 15454, ONS 15310-CL, ONS 15310-MA) Exige/Elise mapper card
ML1000-2	(ONS 15454) Daytona 2-port GigE
ML100T-12	(ONS 15454) Daytona 12-port FSTE
ML100X-8	(ONS 15454) 8-port 100T card with optical interface
MRC-12	(ONS 15454) Humvee - 12-port multirate optical card
MRC-2.5G-4	(ONS 15454) 4-port MRC 2.5G (Hummer 4 15454-ANSI card)
MRC-2.5G-12	(ONS 15454) 12-port MRC 2.5G (Hummer 12 15454-ETSI card)
MXP-2.5G-10E	(ONS 15454) Monviso 10G (4 * 2.5G) muxponder card with enhanced FEC
MXP-2.5G-10EX	(ONS 15454) Cengalo 10G (4 * 2.5G) muxponder with enhanced FEC card
MXP-2.5G-10G	(ONS 15454) Skane 10G (4 * 2.5G) muxponder card
MXP-MR-2.5G	(ONS 15454) Bernina multirate 2.5G muxponder unprotected
MXPP-MR-2.5G	(ONS 15454) Bernina multirate 2.5G muxponder protected
MXPP-MR-10DME	(ONS 15454) Multirate 10Gbps datamux
MXPP-MR-10DMEX	(ONS 15454) Multirate 10Gbps datamux with enhanced dispersion
OC12	(ONS 15454, ONS 15327) OC12 card
OC12-4	(ONS 15454) A 4-port OC12 card
OC192	(ONS 15454) OC192 card
OC192-XFP	(ONS 15454, ONS 15454 SDH) Mongoose - 1-port OC192 XFP
OC192-4/STM64-4	(ONS 15600) 4-port OC192 card
OC192-4-DWDM/STM64-4-DWDM	(ONS 15600) Leatherneck: 4-port OC192 card with tunable laser for C band
OC3	(ONS 15454) OC3 card
OC3-8	(ONS 15454) 8-port OC3 card
OC48	(ONS 15454) OC48 card
OC48-16/STM16-16	(ONS 15600) 16-port OC48 card
OPT-AMP-17-C	(ONS 15454) Optical booster/pre-amplifier for C band 17 dBm
OPT-AMP-23-C	(ONS 15454) Optical booster/pre-amplifier for C band 23 dBm
OPT-AMP-L	(ONS 15454) Optical booster/pre-amplifier for L band
OPT-AMP-C	(ONS 15454) Optical booster/pre-amplifier for C band
OPT-BST	(ONS 15454) Optical booster amplifier
OPT-BST-E	(ONS 15454) Optical booster enhanced amplifier for C band
OPT-BST-L	(ONS 15454) Optical booster amplifier for L band
OPT-PRE	(ONS 15454) Optical pre-amplifier
OSC-CSM	(ONS 15454) Optical service channel (OSC) with combiner/separator module (SCM)
OSCM	(ONS 15454) Optical service channel (OSC) module
PIM-1	(ONS 15600) 1-port pluggable interface module
PIM-4	(ONS 15600) 4-port pluggable interface module
PPM-1	(ONS 15454, ONS 15600, ONS 15310-CL, ONS 15310-MA) Pluggable port module with one SFP port
SSXC	(ONS 15600) Cross connect card
STM1E-12	(ONS 15454 SDH) STM1E-12 card
TCC	(ONS 15454) TCC card
TXP-MR-10E	(ONS 15454) Skane 10G multirate transponder card with enhanced FEC
TXP-MR-10G	(ONS 15454) Skane 10G multirate transponder card
TXP-MR-2.5G	(ONS 15454) Rockwell multirate 2.5G unprotected
TXPP-MR-2.5G	(ONS 15454) Rockwell multirate 2.5G protected
XC	(ONS 15454) XC card
XC10G	(ONS 15454) XC10G card
XCVT	(ONS 15454) XCVT card
XCVXC-10G	(ONS 15454) XCVXC-10G card
XCVXC-2.5G	(ONS 15454) XCVXC-2.5G card
XCVXL-10G	(ONS 15454) XCVXL-10G card
XCVXL-2.5G	(ONS 15454) XCVXL-2.5G card
<EQUIP>	Indicates if the equipment is physically present. The parameter type is EQUIP, which is the presence of a plug-in unit.
EQUIP	The unit is equipped-present.
UNEQUIP	The unit is unequipped-absent.
<STATUS>	(Optional) Indicates a status. SONET card status is shown on its card level. The parameter type is STATUS.
ACT	The entity is the active unit in the shelf.
NA	Status is unavailable.
STBY	The entity is the standby unit on the shelf.
<CARDNAME>	(Optional) The card name of the card, PIM, or PPM equipment. CARDNAME is a string.
<CARDMODE>	(Optional) Card mode. The parameter type is CARDMODE, which is the card mode. Card mode is applicable to cards that have multiple capabilities, for example, the ML-Series card can operate in two distinct modes: Linear Mapper Mode and L2/L3 Mode.
AMPL-BST	The optical amplifier is working as an optical booster
AMPL-PRE	The optical amplifier is working as an optical preamplifier
DS3XM12-STS12	The DS3XM-12 card in the STS12 backplane rate mode
DS3XM12-STS48	The DS3XM-12 card in the STS48 backplane rate mode
DWDM-LINE	Line terminating mode
DWDM-SEC	Section terminating mode
DWDM-TRANS-AIS	Transparent mode AIS
DWDM-TRANS-SQUELCH	Transparent mode SQUELCH
FCMR-DISTEXTN	FC_MR-4 card with distance extension support
FCMR-LINERATE	FC_MR-4 card without distance extension support
ML-GFP	ML-Series card in DOS field-programmable gate array (FPGA) using generic framing procedure (GFP) framing type
ML-HDLC	ML-Series card in DOS FPGA using high-level data link control (HDLC) framing type
ML-IEEE-RPR	Ml-Series card in DOS FPGA THAT supports Resilient Packet Ring (RPR)
MXPMR10DME-4GFC	4-Gbps Fibre Channel/FICON mode for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on Ports 1 and 5
MXPMR10DME-4GFC-FCGEISC	4-Gbps Fibre Channel/FICON supported on Port 1 and Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on Ports 5 to 8
MXPMR10DME-FCGEISC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on all eight ports
MXPMR10DME-FCGEISC-4GFC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on Ports 1 to 4 and 4-Gbps Fibre Channel/FICON supported on Port 5
MXPMR10G-FCGEISC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on all eight ports
MXPMR10G-4GFC	4-Gbps Fibre Channel/FICON mode for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on Ports 1 and 5
MXPMR10G-FCGEISC- 4GFC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on Ports 1 to 4 and 4-Gbps Fibre Channel/FICON supported on Port 5
MXPMR10G-4GFC- FCGEISC	4-Gbps Fibre Channel/FICON supported on Port 1 and Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 MXP_MR_10DME_C and MXP_MR_10DME_L cards supported on Ports 5 to 8.
MXPMR25G-ESCON	ESCON mode for the Cisco ONS 15454 MXP_2.5G_10G card
MXPMR25G-FCGE	Fibre channel or GIGE mode for the MXP_2.5G_10G card
MXPMR25G-MIXED	Mixed Fibre Channel, GIGE, and ESCON modes for the Cisco ONS 15454 MXP_2.5G_10G card
<PST_PSTQ>	Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
IS-NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	Secondary state of the entity. Listable. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-ESCON

(Cisco ONS 15454) The Retrieve Enterprise System Connection (RTRV-ESCON) command retrieves the Fibre Channel-specific settings for ports that have been configured to carry ESCON traffic using the ENT-ESCON command.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

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

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[ENCAP=<ENCAP>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1:,,WORK,ACT:ENCAP=GFP-T" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<ROLE>	(Optional) The port role in Y-cable protection (WORK or PROT). The parameter type is SIDE, which is the role the unit is playing in the protection group.
PROT	The entity is a protection unit in the protection group.
WORK	The entity is a working unit in the protection group.
<STATUS>	(Optional) A port status in Y-cable protection (ACT or STBY). The parameter type is STATUS, which is the status of the unit in the protection pair.
ACT	The entity is the active unit in the shelf.
NA	Status is unavailable.
STBY	The entity is the standby unit in the shelf.
<ENCAP>	(Optional) Encapsulation frame type. The parameter type is ENCAP, which is the frame encapsulation type.
GFP_F	GFP Frame Mode
GFP_T	GFP Transparent Mode
HDLC	HDLC Frame Mode
HDLC_LEX	HDLC LAN Extension Frame Mode
HDLC_X86	HDLC X.86 Frame Mode

RTRV-ETH

(Cisco ONS 15454) The Retrieve Ethernet (RTRV-ETH) command retrieves the front-end port information of an Ethernet card.

Usage Guidelines

This command retrieves the front-end port information of 10/100/1000 Mbps Ethernet cards. However, RTRV-POS will display the MTU, which is common for front and backend ports.

The SELECTIVEAUTO parameter is applicable only when EXPSPEED and EXPDUPLEX are not set to AUTO mode.

Note: This command is available in Software Release 8.0.1 and later. It is not available in R8.0.0 and later.

Category

Ethernet

Security

Provisioning

Input Format

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

Input Example

RTRV-ETH:TID:FAC-1-1:CTAG;

Input Parameters

<AID>

Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[LINKSTATE=<LINKSTATE>],[FLOWCTRL=<FLOWCTRL>],[DUPLEX=<DUPLEX>], [SPEED=<SPEED>],[FLOW=<FLOW>],[EXPDUPLEX=<EXPDUPLEX>], [EXPSPEED=<EXPSPEED>],[VLANCOS=<VLANCOS>],[IPTOS=<IPTOS>], [OPTICS=<OPTICS>],[NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [SELECTIVEAUTO=<SELECTIVEAUTO>],[LITIMER=<LITIMER>]:<PST_PSTQ>,[<SSTQ>]";

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::LINKSTATE=DOWN,FLOWCTRL=SYMMETRIC, DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,EXPDUPLEX=AUTO, EXPSPEED=AUTO,VLANCOS=7,IPTOS=255,OPTICS=1000-BASE-LX, NAME=\"ETH PORT\",SOAK=32,SOAKLEFT=\"12-25\", SELECTIVEAUTO=N, LITIMER=200:OOS-AU,AINS";

Output Parameters

<AID>	Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY
<ADMINSTATE>	(Optional) Administration type. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<LINKSTATE>	Link state. The parameter type is UP_DOWN, which indicates an up or down value.
DOWN	Down
UP	Up
<MTU>	(Optional) Maximum transmission unit. MTU is an integer.
<FLOWCTRL>	Flow control. The parameter is FLOW, which indicates the type of flow control that has been negotiated for an Ethernet port. Defaults to NONE.
ASYMMETRIC	Asymmetric flow control
ASYMMETRIC_LOCAL	Asymmetric local flow control
NONE	No flow control
PASSTHRU	Pass-through flow control
SYMMETRIC	Symmetric flow control
<OPTICS>	(Optional) Optics. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
1000_BASE_CX	1000BaseCX
1000_BASE_LX	1000BaseLX
1000_BASE_SX	1000BaseSX
1000_BASE_ZX	1000BaseZX
CWDM_1470	CWDM 1470
CWDM_1490	CWDM 1490
CWDM_1510	CWDM 1510
CWDM_1530	CWDM 1530
CWDM_1550	CWDM 1550
CWDM_1570	CWDM 1570
CWDM_1590	CWDM 1590
CWDM_1610	CWDM 1610
ITU_100G_1530_33	ITU-100G 1530.33
ITU_100G_1531_12	ITU-100G 1531.12
ITU_100G_1531_90	ITU-100G 1531.90
ITU_100G_1532_68	ITU-100G 1532.68
ITU_100G_1534_25	ITU-100G 1534.25
ITU_100G_1535_04	ITU-100G 1535.04
ITU_100G_1535_82	ITU-100G 1535.82
ITU_100G_1536_61	ITU-100G 1536.61
ITU_100G_1538_19	ITU-100G 1538.19
ITU_100G_1538_98	ITU-100G 1538.98
ITU_100G_1539_77	ITU-100G 1539.77
ITU_100G_1540_56	ITU-100G 1540.56
ITU_100G_1542_14	ITU-100G 1542.14
ITU_100G_1542_94	ITU-100G 1542.94
ITU_100G_1543_73	ITU-100G 1543.73
ITU_100G_1544_53	ITU-100G 1544.53
ITU_100G_1546_12	ITU-100G 1546.12
ITU_100G_1546_92	ITU-100G 1546.92
ITU_100G_1547_72	ITU-100G 1547.72
ITU_100G_1548_51	ITU-100G 1548.51
ITU_100G_1550_12	ITU-100G 1550.12
ITU_100G_1550_92	ITU-100G 1550.92
ITU_100G_1551_72	ITU-100G 1551.72
ITU_100G_1552_52	ITU-100G 1552.52
ITU_100G_1554_13	ITU-100G 1554.13
ITU_100G_1554_94	ITU-100G 1554.94
ITU_100G_1555_75	ITU-100G 1555.75
ITU_100G_1556_55	ITU-100G 156.55
ITU_100G_1558_17	ITU-100G 1558.17
ITU_100G_1558_98	ITU-100G 1558.98
ITU_100G_1559_79	ITU-100G 1559.79
ITU_100G_1560_61	ITU-100G 1560.61
UNKNOWN	Unknown Optical Type
UNPLUGGED	Unplugged
<DUPLEX>	The parameter is ETHER_DUPLEX, which indicates duplex mode. Defaults to AUTO.
AUTO	Auto mode
FULL	Full mode
HALF	Half mode
<SPEED>	The parameter type is ETHER_SPEED, which indicates Ethernet speed. Defaults to AUTO.
100_MBPS	100 Megabits per seconds
10_GBPS	10 Gigabits per second
10_MBPS	10 Megabits per second
1_GBPS	1 Gigabit per second
AUTO	Automatic
<FLOW>	(Optional) Flow. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<EXPDUPLEX>	(Optional) Ethernet duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
AUTO	Auto mode
FULL	Full mode
HALF	Half mode
<EXPSPEED>	(Optional) Expected speed. Due to the auto-negotiation feature, actual speed may differ from expected speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
100_MBPS	100 Megabits per second
10_GBPS	10 Gigabits per second
10_MBPS	10 Megabits per second
1_GBPS	1 Gigabit per second
AUTO	Auto
<SELECTIVEAUTO>	(Optional) Selective auto-negotiation. The parameter is Y or N (enable or disable auto-negotiation) This indicates selective auto-negotiation of EXPSPEED and EXPDUPLEX only.
Y	Enable selective auto-negotiation.
N	Disable selective auto-negotiation. The default value is N.
<VLANCOS>	(Optional) Priority queueing threshold based on VLAN class of service for incoming Ethernet packets. VLANCOS is an integer.
<IPTOS>	(Optional) Priority queing threshold based on IP type of service for incoming Ethernet packets. IPTOS is an integer.
<NAME>	(Optional) Facility name. NAME is a string.
<SOAK>	(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>	(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows: 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.
<LITIMER>	(Optional) Link integrity timer duration in the range between 200 ms and 5000 ms in multiples of 100 ms.
<PSTPSTQ>	Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
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 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-EXT-CONT

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve External Control (RTRV-EXT-CONT) command retrieves the control state of an external control. The command can be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT command.

Usage Guidelines

If the CONTTYPE is null, the existing CONTTYPE on this AID will be returned.
The duration is not supported. It defaults to CONTS.

Category

Environment

Security

Retrieve

Input Format

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

Input Example

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

Input Parameters

<AID>	Access identifier from the ENV. The only valid AID for RTRV-EXT-CONT is ENV-OUT-{1-2}.
<CONTTYPE>	Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
AIRCOND	Air conditioning
AUDIBLE	ONS 15310-MA only
ENGINE	Engine
FAN	Fan
GEN	Generator
HEAT	Heat
LIGHT	Light
MISC	Miscellaneous
SPKLR	Sprinkler

Output Format

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

Output Example

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

Output Parameters

<AID>	Access identifier from the ENV. Identifies the external control for which the control state is being retrieved.
<CONTTYPE>	(Optional) Environmental control type. The parameter type is CONTTYPE, which is the environmental control type.
AIRCOND	Air conditioning
AUDIBLE	ONS 15310-MA only
ENGINE	Engine
FAN	Fan
GEN	Generator
HEAT	Heat
LIGHT	Light
MISC	Miscellaneous
SPKLR	Sprinkler
<DUR>	Duration of operation. The duration for which the external control can be operated. The parameter type is Duration.
CONTS	Continuous duration
<CONTSTATE>	(Optional) Control state of the external control. The parameter type is CONT_MODE, which is the current state of the environmental control.
NA	Not applicable (for example, duration is MNTRY).
OPER	The environmental control state is CLOSE.
RLS	The environmental control state is OPEN.

RTRV-FAC

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Facility (RTRV-FAC) command retrieves the payload type of the facility. It can also dump all the facilities on a given card and is applicable to all cards.

Note: You must retrieve card information only from the working card and not from the protect card.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-FAC:CISCO:FAC-2-9:2223;

Input Parameters

<SRC>

Source access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<SRC>::PAYLOAD=<PAYLOAD>:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-9::PAYLOAD=E4-FRAMED:OOS-AU,AINS" ;

Output Parameters

<SRC>	Source access identifier from the FACILITY.
<PAYLOAD>	(Optional) Payload type of the facility. The parameter type is PAYLOAD, which identifies 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
DS3	DS3 mode
DV6000	Video mode
EC1	EC1 mode
ESCON	ESCON mode
ETRCLO	ETR_CLO payload mode
GIGE	Gigabit Ethernet Payload
HDTV	HDTV mode
ISC1	ISC1 Mode
ISC3	ISC3 Mode
OC12	SONET OC12 mode
OC3	SONET OC3 mode
OC48	SONET OC48 mode
PASS-THROUGH	Pass through mode
SDI-D1-VIDEO	SDI-D1-Video mode
SONET	SONET Payload Mode
<PST_PSTQ>	Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
IS-NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	(Optional) Secondary state. SSTQ is a string.

RTRV-FFP

(Cisco ONS 15454) The Retrieve Facility Protection Group (RTRV-FFP) command retrieves all optical 1+1 protection groups.

Usage Guidelines

None

Category

Protection

Security

Retrieve

Input Format

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

Input Example

RTRV-FFP:HERNDON:FAC-1-1:1;

Input Parameters

AID	Optical facility access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>:<LEVEL>:[PROTID=<PROTID>],[RVRTV=<RVRTV>], [RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>], [DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1,FAC-1-1:OC48:PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0,PSDIRN=BI, VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED" ;

Output Parameters

<WORK>	The working port access identifier from the FACILITY.
<PROTECT>	The protected port access identifier from the FACILITY.
<PROTTYPE>	(Optional) Protection group type. PROTTYPE is a string.
<LEVEL>	Optical rate the protection group was defined against. The parameter type is OCN_TYPE, which is the modifier used to differentiate various levels of OC-N.
OC12	Optical Carrier level 12 (622 Mbps)
OC192	Optical Carrier level 192 (10 Gbps)
OC3	Optical Carrier level 3 (155 Mbps)
OC48	Optical Carrier level 48 (2.4 Gbps)
<PROTID>	(Optional) Protection group name. PROTID is a string.
<RVRTV>	(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N, non-revertive.
N	Does not revert service to original line after restoration.
Y	Reverts service to original line after restoration.
<RVTM>	(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>	(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
BI	Bidirectional protection switching
UNI	Unidirectional protection switching
<VRGRDTM>	(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
0.5	500 ms
1.0	1 second
<DTGRDTM>	(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
0.0	0 seconds
0.05	50 ms
0.1	100 ms
0.5	500 ms
1.0	1 second
2.0	2 seconds
3.0	3 seconds
4.0	4 seconds
5.0	5 seconds
<RCGRDTM>	(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
0.0	0 seconds
0.05	50 ms
0.1	100 ms
0.5	500 ms
1.0	1 second
2.0	2 seconds
3.0	3 seconds
4.0	4 seconds
5.0	5 seconds
6.0	6 seconds
7.0	7 seconds
8.0	8 seconds
9.0	9 seconds
10.0	10 seconds
<OPOTYPE>	(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
OPTIMIZED	Optimized 1+1
STANDARD	Standard 1+1

RTRV-FFP-<MOD2DWDMPAYLOAD>

(Cisco ONS 15454) The Retrieve Facility Protection Group for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RTRV-FP-<MOD2DWDMPAYLOAD>) command retrieves Y-cable protection on client facilities.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-FFP-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>,<AIDUNIONID1>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>], [RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1-1,FAC-2-1-1::PROTTYPE=Y-CABLE,PROTID=\"DC-METRO\", RVRTV=N,RVTM=1.0,PSDIRN=BI" ;

Output Parameters

<AIDUNIONID>	Access identifier from the FACILITY.
<AIDUNIONID1>	Access identifier from the FACILITY.
<PROTTYPE>	(Optional) The type of facility protection. The parameter type is PROTTYPE, which is the protection type for DWDM client facilities.
Y-CABLE	Y-cable protection for the client ports on TXP_MR_10G, MXP_2.5G_10G, TXP_MR_2.5G, and TXPP_MR_2.5G cards.
<PROTID>	(Optional) Y-cable protection group identifier. PROTID is a string.
<RVRTV>	(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
N	Does not revert service to original line after restoration.
Y	Reverts service to original line after restoration.
<RVTM>	(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>	(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
BI	Bidirectional protection switching
UNI	Unidirectional protection switching

RTRV-FFP-<OCN_TYPE>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Facility Protection Group for OC3, OC12, OC48, or OC192 (RTRV-FFP-<OCN_TYPE>) command retrieves the optical facility protection information.

Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Note: Optimized 1+1 and related attributes only apply to the ONS 15454.

Note: ONS 15310-CL does not support OC48 and OC192.

Category

Protection

Security

Retrieve

Input Format

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

Input Example

RTRV-FFP-OC3:PETALUMA:OC3-1-1:1;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>], [RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],[VRGRDTM=<VRGRDTM>], [DTGRDTM=<DTGRDTM>],[RCGRDTM=<RCGRDTM>],[OPOTYPE=<OPOTYPE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1,FAC-1-1::PROTTYPE=Y-CABLE,PROTID="PROT_NAME",RVRTV=Y,RVTM=1.0, PSDIRN=BI,VRGRDTM=0.5,DTGRDTM=1.0,RCGRDTM=1.0,OPOTYPE=OPTIMIZED" ;

Output Parameters

<WORK>	Access identifier from the FACILITY. Identifies the working port.
<PROTECT>	Access identifier from the FACILITY. Identifies the protection port.
<PROTTYPE>	(Optional) Protection group type. Applicable only to DWDM cards. The parameter type is PROTTYPE, which is the protection type for DWDM client facilities.
Y-CABLE	Y-cable protection for the client ports on TXP_MR_10G, MXP_2.5G_10G, TXP_MR_2.5G, and TXPP_MR_2.5G cards.
<PROTID>	(Optional) Free-form text string name given to the 1+1 protection group. PROTID is a string.
<RVRTV>	(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N, non-revertive.
N	Does not revert service to original line after restoration.
Y	Reverts service to original line after restoration.
<RVTM>	(Optional) Revertive time. Defaults to 5.0 minutes. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>	(Optional) Protection switch operation. Identifies the switching mode. Defaults to UNI. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
BI	Bidirectional
NONE	Not in transponder mode
UNI	Unidirectional
<VRGRDTM>	(Optional) Verification guard timer. Only applies to optimized 1+1. The parameter type is VERIFICATION_GUARD_TIMER, which is the optimized 1+1 verification guard timer.
0.5	500 ms
1.0	1 second
<DTGRDTM>	(Optional) Detection guard timer. Only applies to optimized 1+1. The parameter type is DETECTION_GUARD_TIMER, which is the optimized 1+1 detection guard timer.
0.0	0 seconds
0.05	50 ms
0.1	100 ms
0.5	500 ms
1.0	1 second
2.0	2 seconds
3.0	3 seconds
4.0	4 seconds
5.0	5 seconds
<RCGRDTM>	(Optional) Recovery guard timer. Only applies to optimized 1+1. The parameter type is RECOVERY_GUARD_TIMER, which is the optimized 1+1 recovery guard timer.
0.0	0 seconds
0.05	50 ms
0.1	100 ms
0.5	500 ms
1.0	1 second
2.0	2 seconds
3.0	3 seconds
4.0	4 seconds
5.0	5 seconds
6.0	6 seconds
7.0	7 seconds
8.0	8 seconds
9.0	9 seconds
10.0	10 seconds
<OPOTYPE>	(Optional) 1+1 protection type. The parameter type is ONE_PLUS_ONE, which is the 1+1 protection type.
OPTIMIZED	Optimized 1+1
STANDARD	Standard 1+1

RTRV-FFP-OCH

(Cisco ONS 15454) The Retrieve Facility Protection Group Optical Channel (RTRV-FFP-OCH) command retrieves the protection group information for the TXP_MR_2.5G and TXPP_MR_2.5G card trunk port.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

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

Input Parameters

<AID>

Access identifier from the CHANNEL.

Output Format

SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>::[PROTTYPE=<PROTTYPE>],[PROTID=<PROTID>], [RVRTV=<RVRTV>],[RVTM=<RVTM>,[,PSDIRN=<PSDIRN>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-2-2,CHAN-2-3::PROTTYPE=SPLITTER,PROTID=\"TRUNK PROT\",RVRTV=Y, RVTM=1.0,PSDIRN=UNI" ;

Output Parameters

<WORK>	The working port access identifier from the CHANNEL.
<PROTECT>	The protected port access identifier from the CHANNEL.
<PROTTYPE>	(Optional) Protection group type. PROTTYPE is a string.
<PROTID>	(Optional) Protection group name. PROTID is a string.
<RVRTV>	(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Defaults to N. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
N	Does not revert service to original line after restoration.
Y	Reverts service to original line after restoration.
<RVTM>	(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<PSDIRN>	(Optional) Protection switch operation. Direction of reversion. The parameter type is UNI_BI, which is the unidirectional and bidirectional switch operations.
BI	Bidirectional protection switching
UNI	Unidirectional protection switching

RTRV-FSTE

(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA) The Retrieve Fast Ethernet (RTRV-FSTE) command retrieves the front-end port information of a Fast Ethernet (10/100 Mbps) card. MTU is not displayed for the ML-100T-8 and CE-100T-8 cards.

Usage Guidelines

This command retrieves the front-end port information of Fast Ethernet (10/100 Mbps) cards. MTU is not displayed for CE-100T-8 and ML-100T-8. However, RTRV-POS will display the MTU, which is common for front and backend ports.

The SELECTIVEAUTO parameter is applicable only when EXPSPEED and EXPDUPLEX are not set to AUTO mode.

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-FSTE:TID:FAC-1-1:CTAG;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[ADMINSTATE=<ADMINSTATE>],[LINKSTATE=<LINKSTATE>],[MTU=<MTU>], [FLOWCTRL=<FLOWCTRL>],[DUPLEX=<DUPLEX>],[SPEED=<SPEED>],[FLOW=<FLOW>], [EXPDUPLEX=<EXPDUPLEX>],[EXPSPEED=<EXPSPEED>],[VLANCOS=<VLANCOS>], [IPTOS=<IPTOS>],[OPTICS=<OPTICS>],[NAME=<NAME>],[SUPPRESS=<SUPPRESS>] [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[SELECTIVEAUTO=<SELECTIVEAUTO>], [LIENABLE=<LIENABLE],[LITIMER=<LITIMER>]:<PST_PSTQ>,[<SSTQ>]";

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,FLOWCTRL=SYMMETRIC, DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,EXPDUPLEX=HALF,EXPSPEED=10_MBPS, VLANCOS=2,IPTOS=4,OPTICS=1000-BASE-LX,NAME=\"FSTE PORT\", SOAK=32,SOAKLEFT=\"12-25\",, SELECTIVEAUTO=N,LIENABLE=Y, LITIMER=200:OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<ADMINSTATE>	(Optional) Administration type. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<LINKSTATE>	(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<MTU>	(Optional) Maximum transmission unit. MTU is an integer.
<FLOWCTRL>	(Optional) Flow control. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
ASYMMETRIC	Asymmetric flow control
ASYMMETRIC_LOCAL	Asymmetric local flow control
NONE	No flow control
PASSTHRU	Passthrough flow control
SYMMETRIC	Symmetric flow control
<OPTICS>	(Optional) Optics. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
1000_BASE_CX	1000BaseCX
1000_BASE_LX	1000BaseLX
1000_BASE_SX	1000BaseSX
1000_BASE_ZX	1000BaseZX
CWDM_1470	CWDM 1470
CWDM_1490	CWDM 1490
CWDM_1510	CWDM 1510
CWDM_1530	CWDM 1530
CWDM_1550	CWDM 1550
CWDM_1570	CWDM 1570
CWDM_1590	CWDM 1590
CWDM_1610	CWDM 1610
ITU_100G_1530_33	ITU-100G 1530.33
ITU_100G_1531_12	ITU-100G 1531.12
ITU_100G_1531_90	ITU-100G 1531.90
ITU_100G_1532_68	ITU-100G 1532.68
ITU_100G_1534_25	ITU-100G 1534.25
ITU_100G_1535_04	ITU-100G 1535.04
ITU_100G_1535_82	ITU-100G 1535.82
ITU_100G_1536_61	ITU-100G 1536.61
ITU_100G_1538_19	ITU-100G 1538.19
ITU_100G_1538_98	ITU-100G 1538.98
ITU_100G_1539_77	ITU-100G 1539.77
ITU_100G_1540_56	ITU-100G 1540.56
ITU_100G_1542_14	ITU-100G 1542.14
ITU_100G_1542_94	ITU-100G 1542.94
ITU_100G_1543_73	ITU-100G 1543.73
ITU_100G_1544_53	ITU-100G 1544.53
ITU_100G_1546_12	ITU-100G 1546.12
ITU_100G_1546_92	ITU-100G 1546.92
ITU_100G_1547_72	ITU-100G 1547.72
ITU_100G_1548_51	ITU-100G 1548.51
ITU_100G_1550_12	ITU-100G 1550.12
ITU_100G_1550_92	ITU-100G 1550.92
ITU_100G_1551_72	ITU-100G 1551.72
ITU_100G_1552_52	ITU-100G 1552.52
ITU_100G_1554_13	ITU-100G 1554.13
ITU_100G_1554_94	ITU-100G 1554.94
ITU_100G_1555_75	ITU-100G 1555.75
ITU_100G_1556_55	ITU-100G 156.55
ITU_100G_1558_17	ITU-100G 1558.17
ITU_100G_1558_98	ITU-100G 1558.98
ITU_100G_1559_79	ITU-100G 1559.79
ITU_100G_1560_61	ITU-100G 1560.61
UNKNOWN	Unknown Optical Type
UNPLUGGED	Unplugged
<DUPLEX>	(Optional) Duplex mode. The parameter type is ETHER_DUPLEX (duplex mode).
AUTO	Auto mode
FULL	Full mode
HALF	Half mode
<SPEED>	(Optional) Speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
100_MBPS	100 Mbps
10_GBPS	10 Gbps
10_MBPS	10 Mbps
1_GBPS	1 Gbps
AUTO	Auto
<FLOW>	(Optional) Flow. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<EXPDUPLEX>	(Optional) Ethernet duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
AUTO	Auto mode
FULL	Full mode
HALF	Half mode
<EXPSPEED>	(Optional) Expected speed. Due to the auto-negotiation feature, actual speed may differ from expected speed. The parameter type is ETHER_SPEED, which is the Ethernet speed.
100_MBPS	100 Mbps
10_GBPS	10 Gbps
10_MBPS	10 Mbps
1_GBPS	1 Gbps
AUTO	Auto
<SELECTIVEAUTO>	(Optional) Selective auto-negotiation. The parameter is Y or N (enable or disable auto-negotiation) This indicates selective auto-negotiation of EXPSPEED and EXPDUPLEX only.
Y	Enable selective auto-negotiation.
N	Disable selective auto-negotiation. The default value is N.
<VLANCOS>	(Optional) Priority queuing threshold based on VLAN class of service of incoming Ethernet packets. VLANCOS is an integer in the range 0 to 7. Defaults to 7.
<IPTOS>	(Optional) Priority queuing threshold based on IP type of service of incoming Ethernet packets. IPTOS is an integer in the range 0 to 255. Defaults to 255.
<NAME>	(Optional) Facility name. NAME is a string.
<SUPPRESS>	Pre-service alarm flag for data ports.
ON	Enable suppress.
OFF	Disable suppress. Default is Off.
<SOAK>	(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>	(Optional) Time remaining for the transition from Locked-AutomaticInService to Unlocked measured in 1 minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows: When the port is in Locked, Locked_Maintenance or Unlocked state, the parameter will not appear. When the port is in Locked_AutomaticInService 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.
<LIENABLE>	(Optional) Enable link itegrity timer. Takes either Y or N. Value Y enables the LITIMER and value N disbales LITIMER. By default LITIMER is enabled.
<LITIMER>	(Optional) Link integrity timer duration in the range between 200 ms and 5000 ms in multiples of 100 ms.
<PSTPSTQ>	Administrative state in the PST_PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and the PSTQ.
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 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-FTPSERVER

(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve FTP Server (RTRV-FTPSERVER) command retrieves FTP server entries.

Releases prior to 8.5 provided limited FTP support to ENEs on enabling proxy/firewall. This implied that the database backup and IOS config file backup (COPY-RFILE, COPY-IOSCFG) to ENEs could not be performed because of security considerations.

Provisioning a list of legal FTP hosts using ENT/ED/DLT/RTRV-FTPSERVER commands overcome the above limitations and allows database backup/restore and software download to an ENE even on enabling proxy/firewall.

You can provision the FTP hosts configured in the ACL to elapse after a specified interval of time. You can then use the COPY-RFILE command to perform database backup/restore or software download to and from this list of legal FTP hosts provisioned to the ENEs.

Additionally, TL1 supports the TID to IP address translation for the GNE TID specified in the FTP URL of COPY-RFILE and COPY-IOSCFG commands.

Disabling firewall (Proxy only) allows all FTP operations (software download, database backup/restore and IOS config file backup/restore) to ENEs.

Usage Guidelines

FTP server entries cannot be retrieved using the TIMER filter.

Category

ENE

Security

Retrieve

Input Format

RTRV-FTPSERVER:[<TID>]::<CTAG>:::[IPADDR=<IPADDR>],[IPMASK=<IPMASK>], [ENABLE=<ENABLE>];

Input Example

RTRV-FTPSERVER:::A:::IPADDR=10.20.30.40

Input Parameters

<IPADDR>	Specifies the IP address of the FTP server.
<IPMASK>	Specifies the subnet mask of the FTP server.
<ENABLE>	Specifies the enable/disable option of the FTP server. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.

Output Format

SID DATE TIME M CTAG COMPLD ",:IPADDR=<IPADDR>,IPMASK=<IPMASK>, ENABLE=<ENABLE>,TIMER=<TIMER>" ;

Output Example

SID DATE TIME M CTAG COMPLD ",:IPADDR=10.20.30.40,IPMASK=255.0.0.0, ENABLE=Y,TIMER=10" ;

Output Parameters

<IPADDR>	Specifies the IP address of the FTP Server.
<IPMASK>	Specifies the subnet mask of the FTP Server.
<ENABLE>	Specifies the enable/disable option of the FTP Server. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<TIMER>	Specifies the timeout value of the FTP Server in minutes.

RTRV-G1000

(Cisco ONS 15454) The Retrieve G1000 Facility (RTRV-G1000) command retrieves the G1000 facilities configuration.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-G1000:TID:FAC-1-1:CTAG;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[MFS=<MFS>],[FLOW=<FLOW>],[LAN=<LAN>],[OPTICS=<OPTICS>], [TRANS=<TRANS>],[TPORT=<TPORT>],[LOWMRK=<LOWMRK>], [HIWMRK=<HIWMRK>],[AUTONEG=<AUTONEG>],[ENCAP=<ENCAP>], [NAME=<NAME>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [LITIMER=<LITIMER>]:<PST_PSTQ>,[<SSTQ>]";

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::MFS=9032,FLOW=N,LAN=ASYMMETRIC,OPTICS=UNKNOWN,TRANS=NONE, TPORT=FAC-5-1,LOWMRK=20,HIWMRK=492,AUTONEG=Y,ENCAP=GFP_T, NAME=\"G1000 PORT\",SOAK=32,SOAKLEFT=\"12-25\",LITIMER=200:OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<MFS>	Maximum frame size. The parameter type is MFS_TYPE, which is the maximum frame size used by an Ethernet card.
1548	Normal frame size
JUMBO	Jumbo frame size
<FLOW>	Flow control. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<LAN>	(Optional) Local-area network. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
ASYMMETRIC	Asymmetric flow control
ASYMMETRIC_LOCAL	Asymmetric local flow control
NONE	No flow control
PASSTHRU	Passthrough flow control
SYMMETRIC	Symmetric flow control
<OPTICS>	(Optional) GBIC type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
1000_BASE_CX	1000 Base CX
1000_BASE_LX	1000 Base LX
1000_BASE_SX	1000 Base SX
1000_BASE_ZX	1000 Base ZX
CWDM_1470	CWDM 1470
CWDM_1490	CWDM 1490
CWDM_1510	CWDM 1510
CWDM_1530	CWDM 1530
CWDM_1550	CWDM 1550
CWDM_1570	CWDM 1570
CWDM_1590	CWDM 1590
CWDM_1610	CWDM 1610
ITU_100G_1530_33	ITU-100G 1530.33
ITU_100G_1531_12	ITU-100G 1531.12
ITU_100G_1531_90	ITU-100G 1531.90
ITU_100G_1532_68	ITU-100G 1532.68
ITU_100G_1534_25	ITU-100G 1534.25
ITU_100G_1535_04	ITU-100G 1535.04
ITU_100G_1535_82	ITU-100G 1535.82
ITU_100G_1536_61	ITU-100G 1536.61
ITU_100G_1538_19	ITU-100G 1538.19
ITU_100G_1538_98	ITU-100G 1538.98
ITU_100G_1539_77	ITU-100G 1539.77
ITU_100G_1540_56	ITU-100G 1540.56
ITU_100G_1542_14	ITU-100G 1542.14
ITU_100G_1542_94	ITU-100G 1542.94
ITU_100G_1543_73	ITU-100G 1543.73
ITU_100G_1544_53	ITU-100G 1544.53
ITU_100G_1546_12	ITU-100G 1546.12
ITU_100G_1546_92	ITU-100G 1546.92
ITU_100G_1547_72	ITU-100G 1547.72
ITU_100G_1548_51	ITU-100G 1548.51
ITU_100G_1550_12	ITU-100G 1550.12
ITU_100G_1550_92	ITU-100G 1550.92
ITU_100G_1551_72	ITU-100G 1551.72
ITU_100G_1552_52	ITU-100G 1552.52
ITU_100G_1554_13	ITU-100G 1554.13
ITU_100G_1554_94	ITU-100G 1554.94
ITU_100G_1555_75	ITU-100G 1555.75
ITU_100G_1556_55	ITU-100G 156.55
ITU_100G_1558_17	ITU-100G 1558.17
ITU_100G_1558_98	ITU-100G 1558.98
ITU_100G_1559_79	ITU-100G 1559.79
ITU_100G_1560_61	ITU-100G 1560.61
UNKNOWN	Unknown Optical Type
UNPLUGGED	Unplugged
<TRANS>	(Optional) Transponder mode. The parameter type is TRANS_MODE, which is the G1000 transponder mode.
BI	Bidirectional
NONE	Not in transponder mode
UNI	Unidirectional
<TPORT>	(Optional) Transponding port access identifier from the FACILITY.
<LOWMRK>	(Optional) Low watermark value. LOWMRK is an integer.
<HIWMRK>	(Optional) High watermark value. HIWMRK is an integer.
<AUTONEG>	(Optional) Automatic negotiation. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<ENCAP>	(Optional) Frame encapsulation type. The parameter type is ENCAP, which is the frame encapsulation type.
GFP_F	GFP frame mode
GFP_T	GFP transparent mode
HDLC	HDLC frame mode
HDLC_LEX	HDLC LAN extension frame mode
HDLC_X86	HDLC X.86 frame mode
<NAME>	(Optional) Facility name. NAME is a string.
<SOAK>	(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>	(Optional) Time remaining for the transition from OOS-AINS to IS measured in 1-minute intervals. The format is HH-MM where HH ranges from 00 to 48 and MM ranges from 00 to 59. Rules for SOAKLEFT are as follows: When the port is in OOS, OOS_MT or IS state, the parameter will not appear. When the port is in OOS_AINS state but the countdown has not started due to a fault signal, the value will be SOAKLEFT=NOT-STARTED. When the port is in OOS_AINS state and the countdown has started, the value will be shown in HH-MM format.
<LITIMER>	Link integrity timer duration.
<PSTPSTQ>	Administrative state in the PST-PSTQ format. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
IS-NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-GFP

(Cisco ONS 15454, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Generic Framing Protocol (RTRV-GFP) command retrieves GFP information for the ONS 15454 CE-100T-8 and CE-1000-4 cards, the ONS 15454 FC_MR-4 card, and the ONS 15310-CL CE-100T-8 card.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

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

Input Parameters

<SRC>

Source access identifier from the FACILITY.

Note: VFAC AID is used for the CE-100T-8 cards on 15310-CL and 15454. ML-100T-8 GFP management is done by the Cisco IOS CLI and not by the TL1 interface. FAC AID is used for ONS 15454 FC_MR-4

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[FCS=<FCS>],[AUTOTHGFPBUF=<AUTOTHGFPBUF>], [GFPBUF=<GFPBUF>],[FILTER=<FILTER>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::FCS=FCS-32,AUTOTHGFPBUF=Y,GFPBUF=16,FILTER=EGRESS" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<FCS>	(Optional) Payload frame check sequence. The parameter type is FCS, which is the frame check sequence.
FCS-16	Frame check sequencing using 16 bits
FCS-32	Frame check sequencing using 32 bits
NONE	No frame check sequence
<AUTOTHGFPBUF>	(Optional) Flag used to indicate whether PDI-P should be generated on the outgoing VT-structured STSs. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<GFPBUF>	(Optional) GFPBUF is an integer.
<FILTER>	(Optional) Parameter type is GFP_FILTER, which is the filter.
EGRESS	Activate filter on egress port.
NONE	Turn off filter.

RTRV-GIGE

(Cisco ONS 15454, ONS 15600) The Retrieve Gigabit (GIGE, 10GIGE) Ethernet (RTRV-GIGE) command retrieves the front-end port information for a 1 Gigabit Ethernet card.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-GIGE:TID:FAC-1-1:CTAG;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:,,<ROLE>,<STATUS>:[ADMINSTATE=<ADMINSTATE>], [LINKSTATE=<LINKSTATE>],[MTU=<MTU>],[ENCAP=<ENCAP>], [FLOWCTRL=<FLOWCTRL>],[AUTONEG=<AUTONEG>],[HIWMRK=<HIWMRK>], [LOWMRK=<LOWMRK>],[OPTICS=<OPTICS>],[DUPLEX=<DUPLEX>], [SPEED=<SPEED>],[NAME=<NAME>],[FREQ=<FREQ>],[LOSSB=<LOSSB>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[LIENABLE=<LIENABLE>], [LITIMER=<LITIMER>]:<PST>,<SST>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1:,,WORK,ACT:ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1548, ENCAP=GFP-F,FLOWCTRL=SYMMETRIC,AUTONEG=Y,HIWMRK=485,LOWMRK=25, OPTICS=1000_BASE_SX,DUPLEX=AUTO,SPEED=AUTO,NAME=`"GIGEPORT\", FREQ=1550,LOSSB=SX,SOAK=32, SOAKLEFT=\"12-22\"LIENABLE=Y, LITIMER=300:IS,AINS";

Output Parameters

<AID>	Access identifier from the FACILITY.
<ROLE>	Identifies the port role in a Y-cable protection scheme. The parameter type is SIDE, which is the role the unit is playing in the protection group.
PROT	The entity is a protection unit in the protection group.
WORK	The entity is a working unit in the protection group.
<STATUS>	Identifies a port status in a Y-cable protection scheme. The parameter type is STATUS, which is the status of the unit in the protection pair.
ACT	The entity is the active unit in the shelf.
NA	Status is unavailable.
STBY	The entity is the standby unit in the shelf.
<ADMINSTATE>	(Optional) Administration type. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<LINKSTATE>	(Optional) Link protocol. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<MTU>	(Optional) Maximum transmission unit. MTU is an integer.
<ENCAP>	(Optional) Encapsulation frame type. The parameter type is ENCAP, which is the frame encapsulation type.
GFP_F	GFP Frame Mode
GFP_T	GFP Transparent Mode
HDLC	HDLC Frame Mode
HDLC_LEX	HDLC LAN Extension Frame Mode
HDLC_X86	HDLC X.86 Frame Mode
<FLOWCTRL>	(Optional) Flow control. The parameter type is FLOW, which is the type of flow control that has been negotiated for an Ethernet port.
ASYMMETRIC	Asymmetric flow control
ASYMMETRIC_LOCAL	Asymmetric local flow control
NONE	No flow control
PASSTHRU	Passthrough flow control
SYMMETRIC	Symmetric flow control
<AUTONEG>	(Optional) Automatic negotiation. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<LOWMRK>	(Optional) Low watermark value. LOWMRK is an integer.
<HIWMRK>	(Optional) High watermark value. HIWMRK is an integer.
<OPTICS>	(Optional) Optics type. The parameter type is OPTICS, which is the type of Gigabit Ethernet optics being used.
1000_BASE_CX	1000 Base CX
1000_BASE_LX	1000 Base LX
1000_BASE_SX	1000 Base SX
1000_BASE_ZX	1000 Base ZX
CWDM_1470	CWDM 1470
CWDM_1490	CWDM 1490
CWDM_1510	CWDM 1510
CWDM_1530	CWDM 1530
CWDM_1550	CWDM 1550
CWDM_1570	CWDM 1570
CWDM_1590	CWDM 1590
CWDM_1610	CWDM 1610
ITU_100G_1530_33	ITU-100G 1530.33
ITU_100G_1531_12	ITU-100G 1531.12
ITU_100G_1531_90	ITU-100G 1531.90
ITU_100G_1532_68	ITU-100G 1532.68
ITU_100G_1534_25	ITU-100G 1534.25
ITU_100G_1535_04	ITU-100G 1535.04
ITU_100G_1535_82	ITU-100G 1535.82
ITU_100G_1536_61	ITU-100G 1536.61
ITU_100G_1538_19	ITU-100G 1538.19
ITU_100G_1538_98	ITU-100G 1538.98
ITU_100G_1539_77	ITU-100G 1539.77
ITU_100G_1540_56	ITU-100G 1540.56
ITU_100G_1542_14	ITU-100G 1542.14
ITU_100G_1542_94	ITU-100G 1542.94
ITU_100G_1543_73	ITU-100G 1543.73
ITU_100G_1544_53	ITU-100G 1544.53
ITU_100G_1546_12	ITU-100G 1546.12
ITU_100G_1546_92	ITU-100G 1546.92
ITU_100G_1547_72	ITU-100G 1547.72
ITU_100G_1548_51	ITU-100G 1548.51
ITU_100G_1550_12	ITU-100G 1550.12
ITU_100G_1550_92	ITU-100G 1550.92
ITU_100G_1551_72	ITU-100G 1551.72
ITU_100G_1552_52	ITU-100G 1552.52
ITU_100G_1554_13	ITU-100G 1554.13
ITU_100G_1554_94	ITU-100G 1554.94
ITU_100G_1555_75	ITU-100G 1555.75
ITU_100G_1556_55	ITU-100G 156.55
ITU_100G_1558_17	ITU-100G 1558.17
ITU_100G_1558_98	ITU-100G 1558.98
ITU_100G_1559_79	ITU-100G 1559.79
ITU_100G_1560_61	ITU-100G 1560.61
UNKNOWN	Unknown Optical Type
UNPLUGGED	Unplugged
<DUPLEX>	(Optional) Duplex mode. The parameter type is ETHER_DUPLEX, which is the duplex mode.
AUTO	Auto mode
FULL	Full mode
HALF	Half mode
<SPEED>	(Optional) Speed. The parameter type is ALS_MODE, which is the automatic laser shutdown mode.
AUTO	Automatic
DISABLED	Disabled
MAN	Manual
MAN-RESTART	Manual restart for test
<NAME>	(Optional) Facility name. NAME is a string.
<FREQ>	(Optional) Parameter type is OPTICAL_WLEN (optical wavelength).
1310	Wavelength 1310
1470	Wavelength 1470
1490	Wavelength 1490
1510	Wavelength 1510
1529.55	Wavelength 1529.55
1529.94	Wavelength 1529.94
1530	Wavelength 1530
1530.33	Wavelength 1530.33
1530.73	Wavelength 1530.73
1531.12	Wavelength 1531.12
1531.51	Wavelength 1531.51
1531.90	Wavelength 1531.90
1532.29	Wavelength 1532.29
1532.68	Wavelength 1532.68
1533.07	Wavelength 1533.07
1533.47	Wavelength 1533.47
1533.86	Wavelength 1533.86
1534.25	Wavelength 1534.25
1534.64	Wavelength 1534.64
1535.04	Wavelength 1535.04
1535.43	Wavelength 1535.43
1535.82	Wavelength 1535.82
1536.22	Wavelength 1536.22
1536.61	Wavelength 1536.61
1537	Wavelength 1537
1537.40	Wavelength 1537.40
1537.79	Wavelength 1537.79
1538.19	Wavelength 1538.19
1538.58	Wavelength 1538.58
1538.98	Wavelength 1538.98
1539.37	Wavelength 1539.37
1539.77	Wavelength 1539.77
1540.16	Wavelength 1540.16
1540.56	Wavelength 1540.56
1540.95	Wavelength 1540.95
1541.35	Wavelength 1541.35
1541.75	Wavelength 1541.75
1542.14	Wavelength 1542.14
1542.35	Wavelength 1542.35
1542.54	Wavelength 1542.54
1542.94	Wavelength 1542.94
1543.33	Wavelength 1543.33
1543.73	Wavelength 1543.73
1544.13	Wavelength 1544.13
1544.53	Wavelength 1544.53
1544.92	Wavelength 1544.92
1545.32	Wavelength 1545.32
1545.72	Wavelength 1545.72
1546.12	Wavelength 1546.12
1546.52	Wavelength 1546.52
1546.92	Wavelength 1546.92
1547.32	Wavelength 1547.32
1547.72	Wavelength 1547.72
1548.12	Wavelength 1548.12
1548.51	Wavelength 1548.51
1548.92	Wavelength 1548.92
1549.32	Wavelength 1549.32
1549.71	Wavelength 1549.71
1550	Wavelength 1500
1550.12	Wavelength 1550.12
1550.52	Wavelength 1550.52
1550.92	Wavelength 1550.92
1551.32	Wavelength 1551.32
1551.72	Wavelength 1551.72
1552.12	Wavelength 1552.12
1552.52	Wavelength 1552.52
1552.93	Wavelength 1552.93
1553.33	Wavelength 1553.33
1553.73	Wavelength 1553.73
1554.13	Wavelength 1554.13
1554.13	Wavelength 1554.13
1554.94	Wavelength 1554.94
1555.34	Wavelength 1555.34
1555.75	Wavelength 1555.75
1556.15	Wavelength 1556.15
1556.55	Wavelength 1556.55
1556.96	Wavelength 1556.96
1557.36	Wavelength 1557.36
1557.77	Wavelength 1557.77
1558.17	Wavelength 1558.17
1558.58	Wavelength 1558.58
1558.98	Wavelength 1558.98
1559.39	Wavelength 1559.39
1559.79	Wavelength 1559.79
1560.20	Wavelength 1560.20
1560.61	Wavelength 1560.61
1561.01	Wavelength 1561.01
1561.42	Wavelength 1561.42
1561.83	Wavelength 1561.83
1570	Wavelength 1570
1570.83	Wavelength 1570.83
1571.24	Wavelength 1571.24
1571.65	Wavelength 1571.65
1572.06	Wavelength 1572.06
1572.48	Wavelength 1572.48
1572.89	Wavelength 1572.89
1573.30	Wavelength 1573.30
1573.71	Wavelength 1573.71
1574.13	Wavelength 1574.13
1574.54	Wavelength 1574.54
1574.95	Wavelength 1574.95
1575.37	Wavelength 1575.37
1575.78	Wavelength 1575.78
1576.20	Wavelength 1576.20
1576.61	Wavelength 1576.61
1577.03	Wavelength 1577.03
1577.44	Wavelength 1577.44
1577.86	Wavelength 1577.86
1578.27	Wavelength 1578.27
1578.69	Wavelength 1578.69
1579.10	Wavelength 1579.10
1579.52	Wavelength 1579.52
1579.93	Wavelength 1579.93
1580.35	Wavelength 1580.35
1580.77	Wavelength 1580.77
1581.18	Wavelength 1581.18
1581.60	Wavelength 1581.60
1582.02	Wavelength 1582.02
1582.44	Wavelength 1582.44
1582.85	Wavelength 1582.85
1583.27	Wavelength 1583.27
1583.69	Wavelength 1583.69
1584.11	Wavelength 1584.11
1584.53	Wavelength 1584.53
1584.95	Wavelength 1584.95
1585.36	Wavelength 1585.36
1585.78	Wavelength 1585.78
1586.20	Wavelength 1586.20
1586.62	Wavelength 1586.62
1587.04	Wavelength 1587.04
1587.46	Wavelength 1587.46
1587.88	Wavelength 1587.88
1588.30	Wavelength 1588.30
1588.73	Wavelength 1588.73
1589.15	Wavelength 1589.15
1589.57	Wavelength 1589.57
1589.99	Wavelength 1589.99
1590	Wavelength 1590
1590.41	Wavelength 1590.41
1590.83	Wavelength 1590.83
1591.26	Wavelength 1591.26
1591.68	Wavelength 1591.68
1592.10	Wavelength 1592.10
1592.52	Wavelength 1592.52
1592.95	Wavelength 1592.95
1593.37	Wavelength 1593.37
1593.79	Wavelength 1593.79
1594.22	Wavelength 1594.22
1594.64	Wavelength 1594.64
1595.06	Wavelength 1595.06
1595.49	Wavelength 1595.49
1596.34	Wavelength 1596.34
1596.76	Wavelength 1596.76
1597.19	Wavelength 1597.19
1597.62	Wavelength 1597.62
1598.04	Wavelength 1598.04
1598.47	Wavelength 1598.47
1598.89	Wavelength 1598.89
1599.32	Wavelength 1599.32
1599.75	Wavelength 1599.75
1600.06	Wavelength 1600.06
1601.03	Wavelength 1601.03
1601.46	Wavelength 1601.46
1601.88	Wavelength 1601.88
1602.31	Wavelength 1602.31
1602.74	Wavelength 1602.74
1603.17	Wavelength 1603.17
1603.60	Wavelength 1603.60
1604.03	Wavelength 1604.03
1610	Wavelength 1610
USE-TWL1	Use Tunable Wavelength 1
<LOSSB>	(Optional) Parameter type is REACH (reach values).
AUTOPROV	Autoprovisioning
CX	Reach CX
DX	Reach DX
HX	Reach HX
I1	Reach I1
IR-1	Reach IR-1
IR-2	Reach IR-2
L1	Reach L1
L2	Reach L2
L3	Reach L3
LR-1	Reach LR-1
LR-2	Reach LR-2
LR-3	Reach LR-3
LX	Reach LX
S1	Reach S1
S2	Reach S2
SR	Reach SR
SR-1	Reach SR-1
SX	Reach SX
T	Reach T
VX	Reach VX
ZX	Reach ZX
<SOAK>	(Optional) IS-AINS to IS transition soak time as measured in 15-minute intervals. SOAK is an integer.
<SOAKLEFT>	(Optional) OOS-AINS to IS transition soak time as measured in one minute intervals. The format is HH-MM, where HH ranges from 00 to 48, and MM ranges from 00 to 59. The rules for SOAKLEFT are as follows: When the port is in OOS, OOS-MT to IS state, the parameter will not be displayed. When the port is in IS-AINS state, but the countdown has not stated due to faulty signal, the value will be SOAKLEFT=\"NOT-STARTED\". When the port is in IS-AINS state and the countdown has started, the value will be shown in HH-MM format.
<LIENABLE>	(Optional) Enable link itegrity timer. Takes either Y or N. Value Y enables the LITIMER and value N disbales LITIMER. By default LITIMER is enabled.
<LITIMER>	(Optional) Link integrity timer duration in the range between 200 ms and 5000 ms in multiples of 100 ms.
<PST>	Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
IS	In Service
OOS	Out of Service
<SST>	Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-HDLC

(Cisco ONS 15600) The Retrieve High-Level Data Link Control (RTRV-HDLC) command retrieves HDLC-related attributes.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-HDLC:TID:VFAC-SLOT-PORT:CTAG;

Input Parameters

<AID>

Access identifier from the FACILITY. The ONS 15600 ASAP card uses the VFAC AID.

Output Format

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

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "VFAC-SLOT-PORT::FCS=FCS-16" ;

Output Parameters

<AID>	Access identifier from the FACILITY. The ONS 15600 ASAP card uses the VFAC AID.
<FCS>	(Optional) Payload frame check sequence. The parameter type is FCS, which is the frame check sequence.
FCS-16	Frame check sequencing using 16 bits
FCS-32	Frame check sequencing using 32 bits
NONE	No frame check sequence

RTRV-HDR

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Header (RTRV-HDR) command retrieves the header of a TL1 response message. It is used by TL1 clients to determine if the link to the NE is still active and if the NE is responding to commands.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

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

Input Example

RTRV-HDR:SONOMA::232;

Input Parameters

None that require description

RTRV-INV

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Inventory (RTRV-INV) command retrieves a list of the equipment inventory. For each unit in the system, the list identifies the unit's firmware numbers and Common Language Equipment Identifier (CLEI) codes, and the system's product ID and version ID. This command also retrieves the inventory information from pluggable modules using the AID PPM-SLOT-PORT format. For multishelf nodes, the inventory parameters are retrieved by using RTRV-INV command with the BP AID. Because there is more that one shelf, the SHELFID is specified in the BP AID.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

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

Input Example

RTRV-INV:OCCIDENTAL:SLOT-15:301;

Input Parameters

<AID>

Access identifier from the EQPT or ALL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,<AIDTYPE>::[PLUGTYPE=<PLUGTYPE>],[PN=<PN>],[HWREV=<HWREV>], [FWREV=<FWREV>],[SN=<SN>],[CLEI=<CLEI>],[TWL=<TWL>], [PLUGINVENDORID=<PLUGINVENDORID>],[PLUGINPN=<PLUGINPN>], [PLUGINHWREV=<PLUGINWREV>], [PLUGINFWREV=<PLUGINFWREV>], [PLUGINSN=<PLUGINSN>],[ILOSSREF=<ILOSSREF>],[PID=<PID>],[VID=<VID>], [FPGA=<FPGA>],[MODULETYPE=<MODULETYPE>]";

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "SLOT-15,OC3-IR-4::PLUGTYPE=SX-IR-SW-SN,PN=87-31-00002,HWREV=004K, FWREV=76-99-00009-004A,SN=013510,CLEI=NOCLEI,TWL1=1546.12,TWL2=1546.92, TWL3=1547.72,TWL4=1548.51,PLUGINVENDORID=012345,PLUGINPN=ABCDE, PLUGINHWREV=ABCDE,PLUGINFWREV=01-02-03,PLUGINSN=01234,ILOSSREF=1.0, PID=CISCO_ONS15454,VID=V01,FPGA=F451,MODULETYPE=101" ;

Output Parameters

<AID>	Access identifier from the EQPT
<AIDTYPE>	Specifies the type of (AID) facility, link or other addressable entity targeted by the message. AIDTYPE is a string.
<PLUGTYPE>	(Optional) Describes the type of plug-in. PLUGTYPE is a string.
<PN>	(Optional) Hardware part number. PN is a string.
<HWREV>	(Optional) Hardware revision. HWREV is a string.
<FWREV>	(Optional) Firmware revision. It is also known as Bootrom revision. FWREV is a string.
<SN>	(Optional) Serial number. SN is a string.
<CLEI>	(Optional) Common language equipment identifier code for the equipment. CLEI is a string.
<TWL1>	(Optional) Tunable wavelength 1.
1310	Wavelength 1310
1470	Wavelength 1470
1490	Wavelength 1490
1510	Wavelength 1510
1529.55	Wavelength 1529.55
1529.94	Wavelength 1529.94
1530	Wavelength 1530
1530.33	Wavelength 1530.33
1530.73	Wavelength 1530.73
1531.12	Wavelength 1531.12
1531.51	Wavelength 1531.51
1531.90	Wavelength 1531.90
1532.29	Wavelength 1532.29
1532.68	Wavelength 1532.68
1533.07	Wavelength 1533.07
1533.47	Wavelength 1533.47
1533.86	Wavelength 1533.86
1534.25	Wavelength 1534.25
1534.64	Wavelength 1534.64
1535.04	Wavelength 1535.04
1535.43	Wavelength 1535.43
1535.82	Wavelength 1535.82
1536.22	Wavelength 1536.22
1536.61	Wavelength 1536.61
1537	Wavelength 1537
1537.40	Wavelength 1537.40
1537.79	Wavelength 1537.79
1538.19	Wavelength 1538.19
1538.58	Wavelength 1538.58
1538.98	Wavelength 1538.98
1539.37	Wavelength 1539.37
1539.77	Wavelength 1539.77
1540.16	Wavelength 1540.16
1540.56	Wavelength 1540.56
1540.95	Wavelength 1540.95
1541.35	Wavelength 1541.35
1541.75	Wavelength 1541.75
1542.14	Wavelength 1542.14
1542.35	Wavelength 1542.35
1542.54	Wavelength 1542.54
1542.94	Wavelength 1542.94
1543.33	Wavelength 1543.33
1543.73	Wavelength 1543.73
1544.13	Wavelength 1544.13
1544.53	Wavelength 1544.53
1544.92	Wavelength 1544.92
1545.32	Wavelength 1545.32
1545.72	Wavelength 1545.72
1546.12	Wavelength 1546.12
1546.52	Wavelength 1546.52
1546.92	Wavelength 1546.92
1547.32	Wavelength 1547.32
1547.72	Wavelength 1547.72
1548.12	Wavelength 1548.12
1548.51	Wavelength 1548.51
1548.92	Wavelength 1548.92
1549.32	Wavelength 1549.32
1549.71	Wavelength 1549.71
1550	Wavelength 1500
1550.12	Wavelength 1550.12
1550.52	Wavelength 1550.52
1550.92	Wavelength 1550.92
1551.32	Wavelength 1551.32
1551.72	Wavelength 1551.72
1552.12	Wavelength 1552.12
1552.52	Wavelength 1552.52
1552.93	Wavelength 1552.93
1553.33	Wavelength 1553.33
1553.73	Wavelength 1553.73
1554.13	Wavelength 1554.13
1554.13	Wavelength 1554.13
1554.94	Wavelength 1554.94
1555.34	Wavelength 1555.34
1555.75	Wavelength 1555.75
1556.15	Wavelength 1556.15
1556.55	Wavelength 1556.55
1556.96	Wavelength 1556.96
1557.36	Wavelength 1557.36
1557.77	Wavelength 1557.77
1558.17	Wavelength 1558.17
1558.58	Wavelength 1558.58
1558.98	Wavelength 1558.98
1559.39	Wavelength 1559.39
1559.79	Wavelength 1559.79
1560.20	Wavelength 1560.20
1560.61	Wavelength 1560.61
1561.01	Wavelength 1561.01
1561.42	Wavelength 1561.42
1561.83	Wavelength 1561.83
1570	Wavelength 1570
1570.83	Wavelength 1570.83
1571.24	Wavelength 1571.24
1571.65	Wavelength 1571.65
1572.06	Wavelength 1572.06
1572.48	Wavelength 1572.48
1572.89	Wavelength 1572.89
1573.30	Wavelength 1573.30
1573.71	Wavelength 1573.71
1574.13	Wavelength 1574.13
1574.54	Wavelength 1574.54
1574.95	Wavelength 1574.95
1575.37	Wavelength 1575.37
1575.78	Wavelength 1575.78
1576.20	Wavelength 1576.20
1576.61	Wavelength 1576.61
1577.03	Wavelength 1577.03
1577.44	Wavelength 1577.44
1577.86	Wavelength 1577.86
1578.27	Wavelength 1578.27
1578.69	Wavelength 1578.69
1579.10	Wavelength 1579.10
1579.52	Wavelength 1579.52
1579.93	Wavelength 1579.93
1580.35	Wavelength 1580.35
1580.77	Wavelength 1580.77
1581.18	Wavelength 1581.18
1581.60	Wavelength 1581.60
1582.02	Wavelength 1582.02
1582.44	Wavelength 1582.44
1582.85	Wavelength 1582.85
1583.27	Wavelength 1583.27
1583.69	Wavelength 1583.69
1584.11	Wavelength 1584.11
1584.53	Wavelength 1584.53
1584.95	Wavelength 1584.95
1585.36	Wavelength 1585.36
1585.78	Wavelength 1585.78
1586.20	Wavelength 1586.20
1586.62	Wavelength 1586.62
1587.04	Wavelength 1587.04
1587.46	Wavelength 1587.46
1587.88	Wavelength 1587.88
1588.30	Wavelength 1588.30
1588.73	Wavelength 1588.73
1589.15	Wavelength 1589.15
1589.57	Wavelength 1589.57
1589.99	Wavelength 1589.99
1590	Wavelength 1590
1590.41	Wavelength 1590.41
1590.83	Wavelength 1590.83
1591.26	Wavelength 1591.26
1591.68	Wavelength 1591.68
1592.10	Wavelength 1592.10
1592.52	Wavelength 1592.52
1592.95	Wavelength 1592.95
1593.37	Wavelength 1593.37
1593.79	Wavelength 1593.79
1594.22	Wavelength 1594.22
1594.64	Wavelength 1594.64
1595.06	Wavelength 1595.06
1595.49	Wavelength 1595.49
1596.34	Wavelength 1596.34
1596.76	Wavelength 1596.76
1597.19	Wavelength 1597.19
1597.62	Wavelength 1597.62
1598.04	Wavelength 1598.04
1598.47	Wavelength 1598.47
1598.89	Wavelength 1598.89
1599.32	Wavelength 1599.32
1599.75	Wavelength 1599.75
1600.06	Wavelength 1600.06
1601.03	Wavelength 1601.03
1601.46	Wavelength 1601.46
1601.88	Wavelength 1601.88
1602.31	Wavelength 1602.31
1602.74	Wavelength 1602.74
1603.17	Wavelength 1603.17
1603.60	Wavelength 1603.60
1604.03	Wavelength 1604.03
1610	Wavelength 1610
USE-TWL1	Use Tunable Wavelength 1
<PLUGINVENDORID>	(Optional) Plugin vendor ID. Integer.
<PLUGINPN>	(Optional) Third-party plug-in module HW part number. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINPN is a string.
<PLUGINHWREV>	(Optional) Third-party plug-in module hardware revision. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINHWREV is a string.
<PLUGINFWREV>	(Optional) Third-party plug-in module firmware. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINFWREV is a string.
<PLUGINSN>	(Optional) Third-party plug-in module serial number. Applicable only to optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and OADM cards. PLUGINSW is a string.
<ILOSSREF>	(Optional) The insertion loss reference calculated by the unit as worst insertion loss of all the unit. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes
<PID>	(Optional) Product ID of the module. PID is a string.
<VID>	(Optional) Vendor ID. VID is a string.
<FPGA>	(Optional) FPGA version. FPGA is a string.
<MODULETYPE>	(Optional) Describes the type of embedded plugin module. String.

Note: If the SFP contains manufacturing information or data that is not compliant with Telcordia GR-831 (Appendix A), the system automatically adds quotes (\"\") around the invalid characters in the TL1 response. TL1 is Telcordia GR-831 compliant after Software Release 7.0.4.

RTRV-L2-ETH

(Cisco ONS 15454) The Retrieve Layer 2 Ethernet (RTRV-L2-ETH) command retrieves the Layer 2 port information of the Ethernet card.

Usage Guidelines

None

Category

Ethernet

Security

Retrieve

Input Format

RTRV-L2-ETH:[<TID>]:<AID>:<CTAG>[:::];

Input Example

RTRV-L2-ETH:PETALUMA:FAC-1-1:CTAG;

Input Parameters

<AID>

Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[NIMODE=<TYPE>],[MACLEARNING=<MACLEARNING>],[ INGRESSCOS=<INGRESSCOS>],[ETHERCETYPE=<ETHERCETYPE>], [ETHERSTYPE=<ETHERSTYPE>],[ALWMACADDR=<ALWMACADDR>], [INHMACADDR=<INHMACADDR>],[BPDU=<BPDU>],[ACTBRIDGESTATE=<ACTBRIDGESTATE>],[BRIDGESTATE=<BRIDGESTATE>],[QNQMODE=<QNQMODE>], [TRNSPSVLAN=<TRNSPSVLAN>],[NAME=<NAME>]:[<PST>[,<SST>]]

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "ETH-1-1-1::NIMODE=NNI,MACLEARNING=Y,INGRESSCOS=8,ETHERCETYPE=8100, ETHERSTYPE=8100,ALWMACADDR=aa-bb-cc-dd-ee-ff&zz-yy-ww-tt-ss-rr,,BPDU=Y, BRIDGESTATE=DISABLED,,QNQMODE=TRANSPARENT,TRNSPSVLAN=4096, NAME="Ethernet":OOS-AU,AINS" ;

Output Parameters

<ETHERNET>	Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.
<NIMODE>	Identifies the Ethernet network interface mode.
NNI	(Default) Network-network interface mode
UNI	User-network interface mode
<MACLEARNING>	MAC address learning mode. This activates MAC address learning on the interface to avoid packet broadcasting.
Y	Enables MAC learning
N	Disable MAC learning
<INGRESSCOS>	Identifies the CoS value set in the service provider VLAN (S-VLAN) tag.
<ETHERCETYPE>	Identifies a customer specific Ethernet type. If the customer uses a non-standard Ethernet type, the incoming packets will be accepted only if the customer VLAN (CE-VLAN) Ethernet type matches this parameter.
<ETHERSTYPE>	Identifies a customer specific Ethernet type. If the customer uses a non-standard Ethernet type, the incoming packets will be accepted only if the CE-VLAN Ethernet type matches this parameter.
<ALWMACADDR>	Identifies the allowed MAC addresses filtered out by the L2 Ethernet port. Every single MAC address is in the format of aa-bb-cc-dd-ee-ff, where every digit is in a hexadecimal form.
<INHMACADDR>	Identifies the inhibited MAC addresses filtered out by the L2 Ethernet port. Every single MAC address is in the format of aa-bb-cc-dd-ee-ff, where every digit is in a hexadecimal form.
<BPDU>	Bridge Protocol Data Unit (BPDU) management mode; Drop/Passthrough BPDU tagged packets.
Y	Enables the BPDU tag.
N	Disables the BPDU tag.
<BRIDGESTATE>	Defines if the traffic is blocked on the port.
UNKNOWN	Unknown state
DISABLED	Disabled state
BLOCKING	Blocking state
LISTENING	Listening state
LEARNING	Learning state
FORWARDING	Forwarding state
BROKEN	Broken state
<ACTBRIDGESTATE>	Defines if the traffic is blocked on the port.
UNKNOWN	Unknown state
DISABLED	Disabled state
BLOCKING	Blocking state
LISTENING	Listening state
LEARNING	Learning state
FORWARDING	Forwarding state
BROKEN	Broken state
<QNQMODE>	This is used to represent the IEEE 802.1Q tunneling (QinQ) mode operations.
SELECTIVE	The S-VLAN tag is added only on specified CE-VLANs. The other packets are dropped.
TRANSPARENT	The S-VLAN tag is always added where all packets having the S-VLAN-ID identified by the TRNSPSVLAN parameter are allowed.
<TRNSPSVLAN>	VLAN identifier. A VLAN ID is a number between 1 and 4096. The value 0 is reserved for untagged VLANs. This identifier is used for customer VLAN IDs and service provider VLAN IDs.
<NAME>	(Optional) Facility name. NAME is a string.
<CMDMDE>	The parameter type is command mode (CMDMDE). Normal (NORM) mode is the default behavior for all commands but you can specify forced (FRCD) mode to force the system to override a state where the command would normally be denied. The FRCD mode of operation is applicable to delete a virtual concatenated (VCAT) member cross-connect in IS-NR or OOS-AU,AINS service states.
<PST>	Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
IS	In service
OOS	Out of service
<SST>	Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic in service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of equipment and attributes
MT	Maintenance mode
OOG	Out of group
SWDL	Software downloading
UAS	Unassigned
UEQ	Unequipped

RTRV-LMP

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Link Management Protocol (RTRV-LMP) command retrieves the global LMP protocol attributes.

Usage Guidelines

This command is only available on platforms that support the LMP protocol.

Category

LMP

Security

Provisioning

Input Format

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

Input Example

RTRV-LMP:PETALUMA::704;

Input Parameters

None.

Output Format

SID DATE TIME

M CTAG COMPLD "::ENABLE=<ENABLE>,[WDM=<WDM>],[ROLE=<ROLE>],[NODEID=<NODEID>], [OPSTATE=<OPSTATE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "::ENABLE=Y,WDM=Y,ROLE=PEER,NODEID=198.133.219.25,OPSTATE=UP"

Output Parameters

<ENABLE>	LMP protocol status
Y	Protocol is enabled.
N	Protocol is disabled.
<WDM>	Determines if the LMP WDM extensions are in effect.
Y	The LMP WDM extensions are in effect.
N	The LMP WDM extensions are not in effect.
<ROLE>	The role the LMP protocol is configured to play.
OLS	The LMP protocol is configured to respond as a Optical Line System.
PEER	The LMP protocol is configured to respond as a peer node.
<NODEID>	LMP Node ID. NODEID is a stable IP address that is always reachable if there is any connectivity to it. The default LMP node ID value is the IP address of the node.
<OPSTATE>	Indicates the operational status of the LMP protocol stack.
UP	LMP protocol is active.
DOWN	LMP protocol is not active.

RTRV-LMP-CTRL

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Link Management Protocol Control Channel (RTRV-LMP-CTRL) command retrieves the attributes of an LMP control channel.

Usage Guidelines

This command is only available on platforms that support the LMP protocol.

Category

LMP

Security

Provisioning

Input Format

RTRV-LMP-CTRL:[<TID>]:<SRC>:<CTAG>;

Input Example

RTRV-LMP-CTRL:PETALUMA:CC-123:704;

Input Parameters

<SRC>	The LMP control channel AID.
CTRL-ALL	Specifies all the control channels.
CTRL-{1-4}	Specifies an individual control channel.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::REMOTEID=<REMOTEID>,LOCALPORT=<LOCALPORT>,REMOTEIP=<REMOTEIP>, [HELLO=<HELLO>],[HELLOMIN=<HELLOMIN>],[HELLOMAX=<HELLOMAX>], [DEAD=<DEAD>],[DEADMIN=<DEADMIN>],[DEADMAX=<DEADMAX>], [OPSTATE=<OPSTATE>]:[<PST>[,<SST>]] ;

Output Example

TID-000 1998-06-20 14:30:0 M 001 COMPLD "CTRL-2::REMOTEID=15.15.15.115,LOCALPORT=FAC-1-1-1,REMOTEIP=126.0.0.1,HELLO=50, HELLOMIN=300,HELLOMAX=5000,DEAD=12000,DEADMIN=2000,DEADMAX=20000, OPSTATE=UP:OOS,DSBLD" ;

Output Parameters

<REMOTEID>	Distinguishes the LMP control channel messages that are using the same local port to send messages.
<LOCALPORT>	The pathway that the LMP control channel will use to send and receive messages.
<REMOTEIP>	Remote IP address with which the LMP control channel sends and receives messages.
<HELLO>	The time interval within which the LMP protocol sends HELLO messages.
<HELLOMIN>	Minimum hello time the LMP control channels can send out HELLO messages to the remote node.
<HELLOMAX>	The maximum amount of time the LMP control channel can wait between HELLO messages.
<DEAD>	Time interval an LMP control channel will wait for a HELLO message from the remote side before listing the control channel as down.
<DEADMIN>	The minimum amount of time that an LMP control channel can wait before listing the control channel status as down.
<DEADMAX>	The maximum amount of time that an LMP control channel can wait before listing the control channel status as down.
<OPSTATE>	Indicates the operational status of the LMP protocol stack.
UP	The control channel is communicating with its counterpart on the remote node.
DOWN	The control channel is not communicating with its counterpart on the remote node.
GOING DOWN	The LMP stack sets the ControlChannelDown bit in all the messages it sends. This is mainly because of administrative action.
GOING UP	The control channel is in the process of transitioning to the UP state.
CFG-SND	The control channel is in the parameter negotiation state. In this state, the node periodically sends a Config message, and is expecting the other side to reply with either a ConfigAck or ConfigNack message. The control channel Finite State Machine (FSM) does not transition into the ACTIVE state until the remote side positively acknowledges the parameters.
CFG-RCV	The control channel is in the parameter negotiation state. In this state, the node is waiting for acceptable configuration parameters from the remote side. After these parameters are received and acknowledged, the FSM can transition to the ACTIVE state response.
ACTIVE	In this state, the node periodically sends a Hello message and is waiting to receive a valid Hello message. After a valid Hello message is received, it can transition to the UP state.
ACT-FAILED	Activation of the control channel failed.
UNKNOWN	Unknown or unexpected state.
<PST>	Primary state. The parameter type is PST, which indicates the current overall service condition of an entity.
IS	In Service
OOS	Out of Service
<SST>	Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-LMP-TLINK

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Link Management Protocol (RTRV-LMP-TLINK) command retrieves the attributes of an LMP Traffic Engineering (TE) link.

Usage Guidelines

This command is limited to nodes where the LMP protocol is supported and has been enabled.

Category

LMP

Security

Provisioning

Input Format

RTRV-LMP-TLINK:[<TID>]:<SRC>:<CTAG>;

Input Example

RTRV-LMP-TLINK:PETALUMA:TLINK-123:704;

Input Parameters

<SRC>	LMP TE link AID values.
TLINK-ALL	Specifies all the TE links.
TLINK-{1-256}	Specifies an individual TE link.

Output Format

SID DATE TIME M CTAG COMPLD "<SRC>::[REMOTEID=<REMOTEID>],[DWDM=<DWDM>],[REMOTETE=<REMOTETE>], [MUXCAP=<MUXCAP>],[OPSTATE=<OPSTATE>]:[<PST>[,<SST>]]" ;

Output Example

TID-000 1998-06-20 14:30:0 M CTAG COMPLD "TLINK-2::REMOTEID=15.15.15.115,DWDM=Y,REMOTETE=3,MUXCAP=LAMBDA, OPSTATE=UP:IS" ;

Output Parameters

<SRC>	LMP TE link AID values.
TLINK-ALL	Specifies all the TE links.
TLINK-{1-256}	Specifies an individual TE link.
<REMOTEID>	Remote node ID associated with the LMP TE link.
<DWDM>	Indicates whether or not the LMP TE link supports DWDM.
Y	The LMP TE link supports DWDM.
N	The LMP TE link does not support DWDM.
<REMOTETE>	Remote ID used by the far-end LMP TE link.
<MUXCAP>	The muxponder capability of the LMP TE link.
PKTSWITCH1	Packet Switching 1
PKTSWITCH2	Packet Switching 2
PKTSWITCH3	Packet Switching 3
PKTSWITCH4	Packet Switching 4
LAYER2	Layer 2 switching
TDM	Time-division multiplexing (TDM) switching
LAMBDA	Lambda switching
FIBER	Fiber switching
<OPSTATE>	Indicates the operational status of a TE link.
DEGRADED	In this state, all LMP control channels are down, but the TE link still includes some data links that are allocated to user traffic.
INIT	Data links have been allocated to the TE link, but the configuration has not yet been synchronized with the LMP neighbor. A LinkSummary message is periodically transmitted to the LMP neighbor.
UP	The TE link is communicating with its counterpart on the remote node.
DOWN	The TE link is not communicating with its counterpart on the remote node.
UNKNOWN	Unknown or unexpected state.
<PST>	Primary state. This parameter indicates the current overall service condition of an entity.
IS	In service
OOS	Out of service
<SST>	Secondary state. This parameter provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-LMP-DLINK

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Link Management Protocol (RTRV-LMP-DLINK) command retrieves the attributes of an LMP data link.

Usage Guidelines

This command is only applicable on a node where the LMP protocol is supported and enabled.

Category

LMP

Security

Provisioning

Input Format

RTRVD-LMP-DLINK:[<TID>]:<SRC>:<CTAG>;

Input Example

RTRV-LMP-DLINK:PETALUMA:FAC-14-1-1:704;

Input Parameters

<SRC>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[LINKTYPE=<LINKTYPE>],[REMOTEID=<REMOTEID>],[TELINK=<TELINK>], [OPSTATE=<OPSTATE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-14-1-1::LINKTYPE=PORT,REMOTEID=45,TELINK=TLINK-4,OPSTATE=UP-ALLOC"

Output Parameters

<SRC>	Access identifier from the FACILITY.
<LINKTYPE>	The type of LMP data link.
PORT	Port data link.
COMPONENT	Component data link.
<REMOTEID>	The remote LMP data link ID.
<TELINK>	Used to map LMP data links to LMP TE links.
<OPSTATE>	Indicates the operational status of an LMP data link.
TESTING	The data link is being tested. An LMP test message is periodically sent through the link.
DOWN	The data link is not communicating with its counterpart on the remote node.
UP-ALLOC	The link is up and has been allocated for data traffic.
UP-FREE	The link has been successfully tested and is now put in the pool of resources (in-service). The link has not yet been allocated to data traffic.

RTRV-LNK

(Cisco ONS 15454) The Retrieve Link (RTRV-LNK) command retrieves all the (optical) links created in the NE. The end information is returned along with the type of (optical) link.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-LNK:PENNGROVE::114;

Input Parameters

None that require description

Output Format

SID DATE TIME M CTAG COMPLD "<FROM>,<TO>::[OLNKT=<OLNKT>],[CTYPE=<CTYPE>],[RDIRN=<RDIRN>], [BAND=<BAND>],[WLEN=<WLEN>]:<PSTPSTQ>,[<SST>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "BAND-6-1-TX,BAND-13-1-RX::OLNKT=HITLESS,CTYPE=PROV, RDIRN=W_E, BAND=1530.32-1532.68,WLEN=1530.32:OOS-AU,AINS" ;

Output Parameters

<FROM>	Access identifier from the ALL. Identifies an entity at one end of the optical link.
<TO>	Access identifier from the ALL. Identifies an entity at the other end of the optical link.
<OLNKT>	(Optional) Optical link type. The parameter type is OPTICAL_LINK_TYPE, which is the type of optical link between two optical facilities.
ADD-DROP	Link between two points that results in an add/drop connection from a drop point to an add point
HITLESS	Link between two OMS points that results in a hitless connection from a drop point to an add point of a consecutive band/channel filter
OTS	Link between two OTS points
OTS-INTLEAV	Link between two OTS points interrupted by an interleaver card that the system does not monitor.
<CTYPE>	(Optional) The type of cross-connection. Indicates if the optical link is provisioned by the user or automatically created by the NE. The parameter type is CREATION_TYPE, which is the optical link creation type.
AUTO	Automatically created by the NE
PROV	Provisioned by the user
<RDIRN>	(Optional) Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
E-W	The direction of the signal is from east to west (clockwise).
W-E	The direction of the signal is from west to east (counterclockwise).
<BAND>	(Optional) The optical band (group of four contiguous wavelengths) for this optical link. BAND is present only when there is a link between two OMS entities. The parameter type is OPTICAL_BAND.
1530.33 to 1532.68	Band 1
1534.25 to 1536.61	Band 2
1538.19 to 1540.56	Band 3
1542.14 to 1544.53	Band 4
1546.12 to 1548.51	Band 5
1550.12 to 1552.52	Band 6
1554.13 to 1556.55	Band 7
1558.17 to 1560.61	Band 8
USE-DEFAULT	This band is not yet configured/retrieved from the unit.
<WLEN>	(Optional) Optical wavelength for this optical link. WLEN is present only when there is a link between two OCH entities. The parameter type is OPTICAL_WLEN (optical wavelength).
1310	Wavelength 1310
1470	Wavelength 1470
1490	Wavelength 1490
1510	Wavelength 1510
1529.55	Wavelength 1529.55
1529.94	Wavelength 1529.94
1530	Wavelength 1530
1530.33	Wavelength 1530.33
1530.72	Wavelength 1530.72
1531.12	Wavelength 1531.12
1531.51	Wavelength 1531.51
1531.90	Wavelength 1531.90
1532.29	Wavelength 1532.29
1532.68	Wavelength 1532.68
1533.07	Wavelength 1533.07
1533.47	Wavelength 1533.47
1533.86	Wavelength 1533.86
1534.25	Wavelength 1534.25
1534.64	Wavelength 1534.64
1535.04	Wavelength 1535.04
1535.43	Wavelength 1535.43
1535.82	Wavelength 1535.82
1536.22	Wavelength 1536.22
1536.61	Wavelength 1536.61
1537	Wavelength 1537
1537.40	Wavelength 1537.40
1537.79	Wavelength 1537.79
1538.19	Wavelength 1538.19
1538.58	Wavelength 1538.58
1538.98	Wavelength 1538.98
1539.37	Wavelength 1539.37
1539.77	Wavelength 1539.77
1540.16	Wavelength 1540.16
1540.56	Wavelength 1540.56
1540.95	Wavelength 1540.95
1541.35	Wavelength 1541.35
1541.75	Wavelength 1541.75
1542.14	Wavelength 1542.14
1542.35	Wavelength 1542.35
1542.54	Wavelength 1542.54
1542.94	Wavelength 1542.94
1543.33	Wavelength 1543.33
1543.73	Wavelength 1543.73
1544.13	Wavelength 1544.13
1544.53	Wavelength 1544.53
1544.92	Wavelength 1544.92
1545.32	Wavelength 1545.32
1545.72	Wavelength 1545.72
1546.12	Wavelength 1546.12
1546.52	Wavelength 1546.52
1546.92	Wavelength 1546.92
1547.32	Wavelength 1547.32
1547.72	Wavelength 1547.72
1548.11	Wavelength 1548.11
1548.51	Wavelength 1548.51
1548.91	Wavelength 1548.91
1549.32	Wavelength 1549.32
1549.72	Wavelength 1549.72
1550	Wavelength 1500
1550.12	Wavelength 1550.12
1550.52	Wavelength 1550.52
1550.92	Wavelength 1550.92
1551.32	Wavelength 1551.32
1551.72	Wavelength 1551.72
1552.12	Wavelength 1552.12
1552.52	Wavelength 1552.52
1552.93	Wavelength 1552.93
1553.33	Wavelength 1553.33
1553.73	Wavelength 1553.73
1554.13	Wavelength 1554.13
1554.13	Wavelength 1554.13
1554.94	Wavelength 1554.94
1555.34	Wavelength 1555.34
1555.75	Wavelength 1555.75
1556.15	Wavelength 1556.15
1556.55	Wavelength 1556.55
1556.96	Wavelength 1556.96
1557.36	Wavelength 1557.36
1557.77	Wavelength 1557.77
1558.17	Wavelength 1558.17
1558.58	Wavelength 1558.58
1558.98	Wavelength 1558.98
1559.39	Wavelength 1559.39
1559.79	Wavelength 1559.79
1560.20	Wavelength 1560.20
1560.61	Wavelength 1560.61
1561.01	Wavelength 1561.01
1561.42	Wavelength 1561.42
1561.83	Wavelength 1561.83
1570	Wavelength 1570
1570.83	Wavelength 1570.83
1571.24	Wavelength 1571.24
1571.65	Wavelength 1571.65
1572.06	Wavelength 1572.06
1572.48	Wavelength 1572.48
1572.89	Wavelength 1572.89
1573.30	Wavelength 1573.30
1573.71	Wavelength 1573.71
1574.13	Wavelength 1574.13
1574.54	Wavelength 1574.54
1574.95	Wavelength 1574.95
1575.37	Wavelength 1575.37
1575.78	Wavelength 1575.78
1576.20	Wavelength 1576.20
1576.61	Wavelength 1576.61
1577.03	Wavelength 1577.03
1577.44	Wavelength 1577.44
1577.86	Wavelength 1577.86
1578.27	Wavelength 1578.27
1578.69	Wavelength 1578.69
1579.10	Wavelength 1579.10
1579.52	Wavelength 1579.52
1579.93	Wavelength 1579.93
1580.35	Wavelength 1580.35
1580.77	Wavelength 1580.77
1581.18	Wavelength 1581.18
1581.60	Wavelength 1581.60
1582.02	Wavelength 1582.02
1582.44	Wavelength 1582.44
1582.85	Wavelength 1582.85
1583.27	Wavelength 1583.27
1583.69	Wavelength 1583.69
1584.11	Wavelength 1584.11
1584.53	Wavelength 1584.53
1584.95	Wavelength 1584.95
1585.36	Wavelength 1585.36
1585.78	Wavelength 1585.78
1586.20	Wavelength 1586.20
1586.62	Wavelength 1586.62
1587.04	Wavelength 1587.04
1587.46	Wavelength 1587.46
1587.88	Wavelength 1587.88
1588.30	Wavelength 1588.30
1588.73	Wavelength 1588.73
1589.15	Wavelength 1589.15
1589.57	Wavelength 1589.57
1589.99	Wavelength 1589.99
1590	Wavelength 1590
1590.41	Wavelength 1590.41
1590.83	Wavelength 1590.83
1591.26	Wavelength 1591.26
1591.68	Wavelength 1591.68
1592.10	Wavelength 1592.10
1592.52	Wavelength 1592.52
1592.95	Wavelength 1592.95
1593.37	Wavelength 1593.37
1593.79	Wavelength 1593.79
1594.22	Wavelength 1594.22
1594.64	Wavelength 1594.64
1595.06	Wavelength 1595.06
1595.49	Wavelength 1595.49
1596.34	Wavelength 1596.34
1596.76	Wavelength 1596.76
1597.19	Wavelength 1597.19
1597.62	Wavelength 1597.62
1598.04	Wavelength 1598.04
1598.47	Wavelength 1598.47
1598.89	Wavelength 1598.89
1599.32	Wavelength 1599.32
1599.75	Wavelength 1599.75
1600.06	Wavelength 1600.06
1601.03	Wavelength 1601.03
1601.46	Wavelength 1601.46
1601.88	Wavelength 1601.88
1602.31	Wavelength 1602.31
1602.74	Wavelength 1602.74
1603.17	Wavelength 1603.17
1603.60	Wavelength 1603.60
1604.03	Wavelength 1604.03
1610	Wavelength 1610
USE-TWL1	Use Tunable Wavelength 1
<PST_PSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the SST and PSTQ.
IS_NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SST>	(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-LNKTERM

(Cisco ONS 15454, ONS 15310-CL) The Retrieve Provisionable Patchcord Termination (RTRV-LNKTERM) command retrieves information about one or more provisionable patchcord (PP) terminations.

Usage Guidelines

All the terminations can be retrieved using ALL or LNKTERM-ALL as the AID.
If the PP termination does not exist, an error message will be returned.

Category

Provisionable Patchcords

Security

Retrieve

Input Format

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

Input Example

RTRV-LNKTERM::LNKTERM-2:CTAG;

Input Parameters

<AID>

Access identifier from the LNKTERM.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::PORT=<PORT>,[REMOTENODE=<REMOTENODE>], [REMOTELNKTERMID=<REMOTELNKTERMID>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "LNKTERM-2::PORT=FAC-3-1,REMOTENODE=172.20.221.225,REMOTELNKTERMID=21" ;

Output Parameters

<AID>	Access identifier from the LNKTERM.
<PORT>	Access identifier from the AidUnionId.
<REMOTENODE>	(Optional) Remote node. REMOTENODE is a string.
<REMOTELNKTERMID>	(Optional) Remote link term ID. REMOTELNKTERMID is a string.

RTRV-LOG

Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Log (RTRV-LOG) command retrieves the alarm log of the NE.

Usage Guidelines

The only option reported for LOGNM is ALARM.

Category

Log

Security

Retrieve

Input Format

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

Input Example

RTRV-LOG:CERENT::123::ALARM;

Input Parameters

<LOGNM>

Log to be retrieved. The log name is ALARM. String.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,<ALMNUMBER>:CURRENT=<CURRENT>,[PREVIOUS=<PREVIOUS>], <CONDITION>,<SRVEFF>,[TIME=<OCRTIME>],[DATE=<OCRDAT>]:<ALMDESCR>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-3-1,18:CURRENT=MJ,PREVIOUS=CL,EOC,NSA,TIME=16-33-04, DATE=1971-02-03:\"SDCC TERMINATION FAILURE\"" ;

Output Parameters

<AID>	Access identifier from the ALL.
<ALMNUMBER>	Alarm number of the log. ALMNUMBER is an integer.
<CURRENT>	Current severity. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message.
CL	The condition causing the alarm has cleared.
CR	A critical alarm.
MJ	A major alarm.
MN	A minor alarm.
NA	The condition is not alarmed.
NR	The alarm is not reported.
<PREVIOUS>	(Optional) Previous severity. The parameter type is COND_EFF, which is the state of the condition upon the affected unit.
CL	Standing condition cleared
SC	Standing condition raised
TC	Transient condition
<CONDITION>	Condition type for an alarm or a reported event. The parameter type is CONDITION, which is any problem detected on an ONS 15454, ONS 15310-CL, ONS 15310-MA, or ONS 15600 shelf, whether or not the problem is reported (that is, whether or not it generates a trouble notification). Reported conditions include alarms, NA conditions, and NR conditions. See Conditions for a list of conditions.
<OCRTIME>	(Optional) Time when the specific event or violation occurred, HH-MM-SS. Time when alarm was triggered.
<OCRDAT>	(Optional) Date when the specific event or violation occurred, MM-DD. Date when alarm was triggered.
<ALMDESCR>	Alarm description. ALMDESCR is a string.

RTRV-MAP-NETWORK

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Map Network (RTRV-MAP-NETWORK) command retrieves all the NE attributes which are accessible from the GNE (gateway NE). The NE attributes include the node IP address (IPADDR), node name (TID), and the product type of the NE (PRODUCT).

Usage Guidelines

The product type field in the response will appear as "unknown" for nodes that are not running the same version of software.

Category

System

Security

Retrieve

Input Format

RTRV-MAP-NETWORK:[<TID>]::<CTAG>;

Input Example

RTRV-MAP-NETWORK:CISCO::123;

Input Parameters

None that require description

Output Format

SID DATE TIME M CTAG COMPLD "<IPADDR>,<NODENAME>,<PRODUCT>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "172.20.222.225,TID-000,15454" ;

Output Parameters

<IPADDR>	Node IP address. IPADDR is a string.
<NODENAME>	Node name (TID). NODENAME is a string.
<PRODUCT>	Product type of the NE. The parameter type is PRODUCT_TYPE, which is the product (NE) type.
ONS15310CL	ONS 15310-CL
ONS15310MA	ONS 15310-MA
ONS15454	ONS 15454
ONS15600	ONS 15600
UNKNOWN	Unknown product type

RTRV-NE-APC

(Cisco ONS 15454) The Retrieve Network Amplification Power Control (RTRV-NE-APC) command retrieves the APC application ports involved in node set-up regulation.

Usage Guidelines

None

Category

System

Security

Maintenance

Input Format

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

Input Example

RTRV-NE-APC:PENNGROVE:CHAN-16-1-RX:114;

Input Parameters

<AID>

Access identifier from the CHANNEL. A null value is equivalent to ALL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,<MOD>::[MODIFDAT=<MODIFDAT>],[MODIFTM=<MODIFTM>], [CHECKDAT=<CHECKDAT>],[CHECKTM=<CHECKTM>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-16-1-RX,OCH::MODIFDAT=04-11-02,MODIFTM=12-35-00, CHECKDAT=04-11-02,CHECKTM=12-55-00" ;

Output Parameters

<AID>	Access identifier from the CHANNEL.
<MOD>	AID type. The parameter type is MOD2O, which is the facility types for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards.
4GFC	4-Gigabit Fibre Channel payload
4GFICON	4-Gigabit fiber connectivity payload
ISC3PEER1G	1 Gbps ISC3 peer
ISC3PEER2G	2 Gbps ISC3 peer
ISC3PEER2R	1 Gbps ISC1, ISC2, and ISC3 compatibility
ISCCOMPAT	1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode
OCH	Optical channel
OMS	Optical multiplexer section
OTS	Optical trace section
<MODIFDAT>	(Optional) The last date when the APC application modified this port. The format of MODIFDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<MODIFTM>	(Optional) The last time when the APC application modified this port. The format of MODIFTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59.
<CHECKDAT>	(Optional) The last date when the APC application controlled and validated this port. The format of CHECKDAT is MM-DD, where MM (month of year) ranges from 1 to 12 and DD (day of month) ranges from 1 to 31.
<CHECKTM>	(Optional) The last time when the APC application controlled and validated this port. The format of CHECKTM is HH-MM, where HH (hour of day) ranges from 0 to 23 and MM (minute of hour) ranges from 0 to 59.

RTRV-NE-GEN

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element General (RTRV-NE-GEN) command retrieves the general NE attributes.

Usage Guidelines

ETHIPADDR and ETHIPMASK are disabled in this command. ETHIPADDR and ETHIPMASK are used to show the Ethernet interface address and mask. Both default to the nodes' IP address and masks.

Category

System

Security

Retrieve

Input Format

RTRV-NE-GEN:[<TID>]::<CTAG>;

Input Example

RTRV-NE-GEN:CISCO::123;

Input Parameters

None that require description

Output Format

SID DATE TIME M CTAG COMPLD "[IPADDR=<IPADDR>],[IPMASK=<IPMASK>],[DEFRTR=<DEFRTR>], [IIOPPORT=<IIOPPORT>],[NTP=<NTP>],[ETHIPADDR=<ETHIPADDR>], [ETHIPMASK=<ETHIPMASK>],[NAME=<NAME>],[SWVER=<SWVER>],[LOAD=<LOAD>], [PROTSWVER=<PROTSWVER>],[PROTLOAD=<PROTLOAD>],[DEFDESC=<DEFDESC>], [PLATFORM=<PLATFORM>],[SECUMODE=<SECUMODE>],[SUPPRESSIP=<SUPPRESSIP>], [PROXYSRV=<PROXYSRV>],[FIREWALL=<FIREWALL>],[AUTOPM=<AUTOPM>], [SERIALPORTECHO=<SERIALPORTECHO>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "IPADDR=192.168.100.52,IPMASK=255.255.255.0,DEFRTR=192.168.100.1, IIOPPORT=57970,NTP=192.168.100.52,ETHIPADDR=172.20.208.225, ETHIPMASK=255.255.255.0,NAME="NODENAME",SWVER=2.01.03, LOAD=02.13-E09A-08.15,PROTSWVER=2.01.02,PROTLOAD=02.12-E09A-09.25, DEFDESC=\"NE DEFAULTS FEATURE\",PLATFORM=15454-ANSI,SECUMODE=NORMAL, SUPPRESSIP=YES,PROXYSRV=N,FIREWALL=N,AUTOPM=NO,SERIALPORTECHO=Y" ;

Output Parameters

<IPADDR>	(Optional) Node IP address. IPADDR is a string.
<IPMASK>	(Optional) Node IP mask. IPMASK is a string.
<DEFRTR>	(Optional) Node default router. DEFRTR is a string.
<IIOPPORT>	(Optional) Node IIOP port. IIOPPORT is an integer.
<NTP>	(Optional) Node NTP timing source address. NTP is a string.
<ETHIPADDR>	Not supported in this release.
<ETHIPMASK>	Not supported in this release.
<NAME>	(Optional) Facility name. NAME is a string.
<SWVER>	(Optional) Software version. SWVER is a string.
<LOAD>	(Optional) Load. LOAD is a string.
<PROTSWVER>	(Optional) Protect software version. PROTSWVER is a string.
<PROTLOAD>	(Optional) Protect load. PROTLOAD is a string.
<DEFDESC>	(Optional) Provides a default description for the NE. DEFDESC is a string.
<PLATFORM>	(Optional) Platform. PLATFORM is a string.
<SECUMODE>	(Optional) Security mode of the NE. The parameter type is NE_SECURE_MODE, which is the security mode of the NE.
REPEATER	The front port and backplane are sharing the same IP network.
SECURE	The front port and backplane are independent and in different IP subnetworks.
<SUPPRESSIP>	(Optional) Parameter type is YES_NO, which is 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
<PROXYSRV>	(Optional) Indicates if the proxy server is enabled or disabled.
Y	Proxy server is enabled.
N	Proxy server is disabled.
<FIREWALL>	(Optional) Indicates if the firewall is enabled or disabled.
Y	Firewall is enabled.
N	Firewall is disabled.
<AUTOPM>	(Optional) AUTOPM is a flag to indicate if autonomous PM reporting to TL1 clients is enabled or disabled.
Y	Auto PM reporting is enabled.
N	Auto PM reporting is disabled.
<SERIALPORTECHO>	(Optional) Indicates if the echo is turned on for TL1 serial port sessions.
Y	Echo is turned on.
N	Echo is turned off.

RTRV-NE-IPMAP

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element Internet Protocol Map (RTRV-NE-IPMAP) command retrieves the IP address and node name of the NEs that have a DCC connection with this NE.

Usage Guidelines

This command only reports the discovered DCC link. If there is no discovered DCC link on the port (or the node), the command will return COMPLD without IPMAP information.

Category

Network

Security

Retrieve

Input Format

RTRV-NE-IPMAP:[<TID>]:[<AID>]:<CTAG>;

Input Example

RTRV-NE-IPMAP:CISCO:FAC-12-1:123;

Input Parameters

<AID>

Access identifier from the FACILITY. The port of an NE carrying the DCC connection. A null value defaults to the whole NE. A null value is equivalent to ALL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:<IPADDR>,<NODENAME>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-12-1:172.20.208.225,NODENAME2" ;

Output Parameters

<AID>	Access identifier from the FACILITY. Port of an NE carrying the DCC connection.
<IPADDR>	Node IP address. IPADDR is a string.
<NODENAME>	Network element name. NODENAME is a string.

RTRV-NE-PATH

(Cisco ONS 15454, ONS 15310-CL, and ONS 15310-MA) The Retrieve Network Element Path (RTRV-NE-PATH) command retrieves the path-level attributes on an NE.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

RTRV-NE-PATH:[<TID>]::<CTAG>[::::];

Input Example

RTRV-NE-PATH:::CTAG;

Input Parameters

None that require description

Output Format

SID DATE TIME M CTAG COMPLD "[PDIP=<PDIP>],[XCMODE=<XCMODE>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "PDIP=Y,XCMODE=MIXED" ;

Output Parameters

<PDIP>	(Optional) Flag used to indicate whether PDI-P should be generated on the outgoing VT-structured STSs. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<XCMODE>	(Optional) Cross-connect mode. The parameter type is XCMODE, which is applicable only to a node with cross-connect cards that support cross-connect mode change.
MIXED	Both VT1 and VT2 cross-connects can be provisioned on the node.
VT1	Only VT1 cross-connects can be provisioned on the node.
VT2	Only VT2 cross-connects can be provisioned on the node.

RTRV-NE-SYNCN

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element Synchronization (RTRV-NE-SYNCN) command retrieves the synchronization attributes of the NE.

Usage Guidelines

Although mixed mode timing is supported in this release, it is not recommended. Refer to the Cisco ONS SONET TL1 Reference Guide for more information.
The timing modes are:
- External mode: The node derives its timing from the BITS inputs.
- Line mode: The node derives its timing from the SONET line(s).
- Mixed mode: The node derives its timing from the BITS input or SONET lines.

Category

Synchronization

Security

Retrieve

Input Format

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

Input Example

RTRV-NE-SYNCN:CISCO:SHELF-2:123;

Input Parameters

<AID>

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

Output Format

SID DATE TIME M CTAG COMPLD "[<AID>]::[TMMD=<TMMD>],[SSMGEN=<SSMGEN>],[QRES=<QRES>], [RVRTV=<RVRTV>],[RVTM=<RVTM>],[SYSTMN=<SYSTMN>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "SHELF-2::TMMD=LINE,SSMGEN=GEN1,QRES=ABOVE-G811,RVRTV=Y,RVTM=8.0, SYSTMN=SONET" ;

Output Parameters

<AID>	The node or shelf access identifier from the SHELF. If omitted it addresses the node or first shelf of the node. Must not be null
<TMMD>	(Optional) Timing mode. The parameter type is TIMING_MODE, which is the timing mode for the current node.
EXTERNAL	The node derives its clock from the BITS input.
LINE	The node derives its clock from the SONET lines.
MIXED	The node derives its clock from the mixed timing mode.
<SSMGEN>	(Optional) Synchronization status message generator. The parameter type is SYNC_GENERATION, which is the synchronization status message set generation.
GEN1	First generation SSM set
GEN2	Second generation SSM set
<QRES>	(Optional) Quality of the RES. The parameter type is SYNC_QUALITY_LEVEL, which is the network synchronization quality level.
ABOVE-G811	Better than G811
ABOVE-STU_SDH	Between STU_SDH and G811 (default setting)
ABOVE-G812T	Between G812T and STU_SDH
ABOVE-G812L	Between G812L and G812T
ABOVE-SETS	Between SETS and G812L
BELOW-SETS	Below SETS but still usable
SAME-AS-DUS_SDH	Disable the RES message by equating to DUS_SDH
<RVRTV>	(Optional) Revertive mode. The value Y indicates that protection switching system reverts service to the original line after restoration. The value N indicates that protection switching system does not revert service to the original line after restoration. RVRTV is applicable only for 1+1 protection switching. Null defaults to N. The parameter type is ON_OFF (disable or enable an attribute).
N	Does not revert service to original line after restoration.
Y	Reverts service to original line after restoration.
<RVTM>	(Optional) Revertive time. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<SYSTMN>	(ONS 15454 only) Identifies the system timing standard used by the node.
SONET	SONET timing standard
SDH	SDH timing standard

RTRV-NE-WDMANS

(Cisco ONS 15454) The Retrieve Network Element Wavelength Division Multiplexing Automatic Node Setup (RTRV-NE-WDMANS) command retrieves the optical node setup (WDMANS) application ports involved in node setup regulation.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-NE-WDMANS:PENNGROVE:ALL:114;

Input Parameters

<AID>

The access identifier from the ALL. A null value is equivalent to ALL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>,<AIDTYPE>::[REGULATED=<REGULATED>,][PARAM=<PARAM>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-16-1-RX,OCH::REGULATED=OUT-OF-RANGE,PARAM=VOAATTN" ;

Output Parameters

<AID>	Access identifier from the ALL. AID is port regulated.
<AIDTYPE>	Specifies the type of facility, link, or other addressable entity targeted by the message. A type of access identifier. The parameter type is MOD2, which is the line/path modifier.
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
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 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
OC3	OC-3 facility
OC12	OC-12 facility
OC48	OC-48 facility
OC192	OC-192 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
STS1	STS1 path
STS3C	STS3c path
STS6C	STS6c path
STS9C	STS9c path
STS18C	STS18c path
STS12C	STS12c path
STS24C	STS24c path
STS36C	STS36c path
STS48C	STS48c path
STS192C	STS192c path
T1	T1/DS1 facility/line
T3	T1/DS1 facility/line
VT1	VT1 path
VT2	VT2 path
<REGULATED>	(Optional) The status of the port after a node setup regulation. The parameter type is REGULATED_PORT_TYPE, which is the optical configuration types for NEs.
FAILED	WDM-ANS encountered a failure while regulating this port.
NOT-APPLICABLE	WDM-ANS does not foresee any algorithm or does not have any value to set for the parameter.
OUT-OF-RANGE	WDM-ANS cannot modify the set point because the calculated value is out of the allowed range.
PORT-IN-SERVICE	WDM-ANS cannot modify the set point because the ports are in IS state.
REGULATED	WDM-ANS has successfully regulated this port.
UNCHANGED	WDM-ANS has not changed this port.
<PARAM>	(Optional) The regulated parameter inside of the specified port. The parameter type is REGULATED_PARAM_NAME, which is the name of the parameter regulated by the WDMANS application.
AMPLMODE	WDM-ANS has regulated the amplifier control mode parameter.
CHPOWER	WDM-ANS has regulated the amplifier per the channel power parameter.
GAIN	WDM-ANS has regulated the amplifier gain parameter.
OPWR-LFAIL	WDM-ANS has regulated the OPWR-LFAIL threshold parameter.
REFTILT	WDM-ANS has regulated the amplifier tilt reference parameter.
VOAREFATTN	WDM-ANS has regulated the variable optical attenuator (VOA) attenuation reference parameter.
VOAREFPWR	WDM-ANS has regulated the VOA power reference parameter.

RTRV-NETYPE

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Network Element Type (RTRV-NETYPE) command retrieves the NE's equipment-related information.

Usage Guidelines

None

Category

System

Security

Retrieve

Input Format

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

Input Example

RTRV-NETYPE:GAUR1::1;

Input Parameters

None that require description

Output Format

SID DATE TIME M CTAG COMPLD "<VENDOR>,<MODEL>,<NETYPE>,<SW_ISSUE>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CISCO,ONS15454,ADM&MSPP&MSTP,5.00.00" ;

Output Parameters

<VENDOR>	NE equipment vendor name. VENDOR is a string.
<MODEL>	NE equipment model. The parameter type is PRODUCT_TYPE, which is the product (NE) type.
ONS15310CL	ONS 15310-CL
ONS15310MA	ONS 15310-MA
ONS15454	ONS 15454
ONS15600	ONS 15600
UNKNOWN	Unknown product type
<NETYPE>	NE equipment type. Abbreviation of NE type can be used. The grouping sign "&" can be used to indicate multifunction NE type, for example, ADM&MSPP means Add-Drop Multiplexers and Multiservice Provisioning Platform. Listable. The parameter type is NETYPE, which is the NE equipment type.
ADM	Add-Drop Multiplexers
DCS	Digital Cross-Connect System
MSPP	Multiservice Provisioning Platform
MSSP	Multiservice Switching Platform
MSTP	Multiservice Transport Platform
<SW_ISSUE>	The software release issue of the NE. SW_ISSUE is a string.

RTRV-NNI-ETH

(Cisco ONS 15454) The Retrieve Network-to-Network Interface Ethernet (RTRV-NNI-ETH) command retrieves the NNI selective S-VLAN-ID table associated to an L2 Ethernet port.

Usage Guidelines

This command accepts the ALL AID.

Category

Ethernet

Security

Retrieve

Input Format

RTRV-NNI-ETH:[<TID>]:<AID>:<CTAG>::[<SVLANID>][::];

Input Example

RTRV-NNI-ETH:TID:ETH-1-1-1:CTAG::110;

Input Parameters

<AID>	Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.
<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>:<S_VLAN_ID>[::]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "ETH-1-1-1:110::" ;

Output Parameters

<AID>	Ethernet AIDs are used to access L2 Ethernet ports. Access identifier from the FACILITY.
<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.

RTRV-OCH

(Cisco ONS 15454) The Retrieve Optical Channel (RTRV-OCH) command retrieves the attributes (service parameters) and state of an OCH facility.

Usage Guidelines

Refer to the Cisco ONS SONET TL1 Reference Guide for specific card provisioning rules.

Note: Primary=OOS and secondary=AINS states do not apply to Ethernet mode.

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-OCH:PENNGROVE:CHAN-6-2:236;

Input Parameters

<AID>

Access identifier from the CHANNEL.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:,,[<ROLE>],[<STATUS>]:[EXPWLEN=<EXPWLEN>],[LOSSB=<LOSSB>], [NAME=<PORTNAME>],[GCC=<GCC>],[GCCRATE=<GCCRATE>],[DWRAP=<DWRAP>], [FEC=<FEC>],[PAYLOADMAP=<PAYLOADMAP>],[OSFBER=<OSFBER>], [OSDBER=<OSDBER>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[LBCL=<[LBCL>], [OPT=<OPT>],[OPR=<OPR>]:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-6-1:,,WORK,ACT:EXPWLEN=1530.33,LOSSB=DWDM,NAME="NYPORT",GCC=Y,GCCRATE=192K,DWRAP=Y,FEC=STD,PAYLOADMAP=ASYNCH,OSFBER=1E-4,OSDBER=1E-5, SOAK=52,SOAKLEFT=12-25,LBCL=10.0,OPT=10.0,OPR=10.0:OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the CHANNEL.
<ROLE>	(Optional) Identifies an OCH port role. The parameter type is SIDE, which is the role the unit is playing in the protection group.
PROT	The entity is a protection unit in the protection group.
WORK	The entity is a working unit in the protection group.
<STATUS>	(Optional) The port status. The parameter type is STATUS, which is the status of the unit in the protection pair.
ACT	The entity is the active unit in the shelf.
NA	Status is unavailable.
STBY	The entity is the standby unit in the shelf.
<EXPWLEN>	(Optional) Optical wavelength for this port. Applicable only to the following types of cards: optical service channel cards, optical amplifier cards, dispersion compensation units, multiplexer and demultiplexer cards, and optical add/drop multiplexing (OADM) cards. The parameter type is OPTICAL_WLEN, which is the optical wavelength.
1310	Wavelength 1310
1470	Wavelength 1470
1490	Wavelength 1490
1510	Wavelength 1510
1529.55	Wavelength 1529.55
1529.94	Wavelength 1529.94
1530	Wavelength 1530
1530.33	Wavelength 1530.33
1530.72	Wavelength 1530.72
1531.12	Wavelength 1531.12
1531.51	Wavelength 1531.51
1531.90	Wavelength 1531.90
1532.29	Wavelength 1532.29
1532.68	Wavelength 1532.68
1533.07	Wavelength 1533.07
1533.47	Wavelength 1533.47
1533.86	Wavelength 1533.86
1534.25	Wavelength 1534.25
1534.64	Wavelength 1534.64
1535.04	Wavelength 1535.04
1535.43	Wavelength 1535.43
1535.82	Wavelength 1535.82
1536.22	Wavelength 1536.22
1536.61	Wavelength 1536.61
1537	Wavelength 1537
1537.40	Wavelength 1537.40
1537.79	Wavelength 1537.79
1538.19	Wavelength 1538.19
1538.58	Wavelength 1538.58
1538.98	Wavelength 1538.98
1539.37	Wavelength 1539.37
1539.77	Wavelength 1539.77
1540.16	Wavelength 1540.16
1540.56	Wavelength 1540.56
1540.95	Wavelength 1540.95
1541.35	Wavelength 1541.35
1541.75	Wavelength 1541.75
1542.14	Wavelength 1542.14
1542.35	Wavelength 1542.35
1542.54	Wavelength 1542.54
1542.94	Wavelength 1542.94
1543.33	Wavelength 1543.33
1543.73	Wavelength 1543.73
1544.13	Wavelength 1544.13
1544.53	Wavelength 1544.53
1544.92	Wavelength 1544.92
1545.32	Wavelength 1545.32
1545.72	Wavelength 1545.72
1546.12	Wavelength 1546.12
1546.52	Wavelength 1546.52
1546.92	Wavelength 1546.92
1547.32	Wavelength 1547.32
1547.72	Wavelength 1547.72
1548.11	Wavelength 1548.11
1548.51	Wavelength 1548.51
1548.91	Wavelength 1548.91
1549.32	Wavelength 1549.32
1549.72	Wavelength 1549.72
1550	Wavelength 1500
1550.12	Wavelength 1550.12
1550.52	Wavelength 1550.52
1550.92	Wavelength 1550.92
1551.32	Wavelength 1551.32
1551.72	Wavelength 1551.72
1552.12	Wavelength 1552.12
1552.52	Wavelength 1552.52
1552.93	Wavelength 1552.93
1553.33	Wavelength 1553.33
1553.73	Wavelength 1553.73
1554.13	Wavelength 1554.13
1554.13	Wavelength 1554.13
1554.94	Wavelength 1554.94
1555.34	Wavelength 1555.34
1555.75	Wavelength 1555.75
1556.15	Wavelength 1556.15
1556.55	Wavelength 1556.55
1556.96	Wavelength 1556.96
1557.36	Wavelength 1557.36
1557.77	Wavelength 1557.77
1558.17	Wavelength 1558.17
1558.58	Wavelength 1558.58
1558.98	Wavelength 1558.98
1559.39	Wavelength 1559.39
1559.79	Wavelength 1559.79
1560.20	Wavelength 1560.20
1560.61	Wavelength 1560.61
1561.01	Wavelength 1561.01
1561.42	Wavelength 1561.42
1561.83	Wavelength 1561.83
1570	Wavelength 1570
1570.83	Wavelength 1570.83
1571.24	Wavelength 1571.24
1571.65	Wavelength 1571.65
1572.06	Wavelength 1572.06
1572.48	Wavelength 1572.48
1572.89	Wavelength 1572.89
1573.30	Wavelength 1573.30
1573.71	Wavelength 1573.71
1574.13	Wavelength 1574.13
1574.54	Wavelength 1574.54
1574.95	Wavelength 1574.95
1575.37	Wavelength 1575.37
1575.78	Wavelength 1575.78
1576.20	Wavelength 1576.20
1576.61	Wavelength 1576.61
1577.03	Wavelength 1577.03
1577.44	Wavelength 1577.44
1577.86	Wavelength 1577.86
1578.27	Wavelength 1578.27
1578.69	Wavelength 1578.69
1579.10	Wavelength 1579.10
1579.52	Wavelength 1579.52
1579.93	Wavelength 1579.93
1580.35	Wavelength 1580.35
1580.77	Wavelength 1580.77
1581.18	Wavelength 1581.18
1581.60	Wavelength 1581.60
1582.02	Wavelength 1582.02
1582.44	Wavelength 1582.44
1582.85	Wavelength 1582.85
1583.27	Wavelength 1583.27
1583.69	Wavelength 1583.69
1584.11	Wavelength 1584.11
1584.53	Wavelength 1584.53
1584.95	Wavelength 1584.95
1585.36	Wavelength 1585.36
1585.78	Wavelength 1585.78
1586.20	Wavelength 1586.20
1586.62	Wavelength 1586.62
1587.04	Wavelength 1587.04
1587.46	Wavelength 1587.46
1587.88	Wavelength 1587.88
1588.30	Wavelength 1588.30
1588.73	Wavelength 1588.73
1589.15	Wavelength 1589.15
1589.57	Wavelength 1589.57
1589.99	Wavelength 1589.99
1590	Wavelength 1590
1590.41	Wavelength 1590.41
1590.83	Wavelength 1590.83
1591.26	Wavelength 1591.26
1591.68	Wavelength 1591.68
1592.10	Wavelength 1592.10
1592.52	Wavelength 1592.52
1592.95	Wavelength 1592.95
1593.37	Wavelength 1593.37
1593.79	Wavelength 1593.79
1594.22	Wavelength 1594.22
1594.64	Wavelength 1594.64
1595.06	Wavelength 1595.06
1595.49	Wavelength 1595.49
1596.34	Wavelength 1596.34
1596.76	Wavelength 1596.76
1597.19	Wavelength 1597.19
1597.62	Wavelength 1597.62
1598.04	Wavelength 1598.04
1598.47	Wavelength 1598.47
1598.89	Wavelength 1598.89
1599.32	Wavelength 1599.32
1599.75	Wavelength 1599.75
1600.06	Wavelength 1600.06
1601.03	Wavelength 1601.03
1601.46	Wavelength 1601.46
1601.88	Wavelength 1601.88
1602.31	Wavelength 1602.31
1602.74	Wavelength 1602.74
1603.17	Wavelength 1603.17
1603.60	Wavelength 1603.60
1604.03	Wavelength 1604.03
1610	Wavelength 1610
USE-TWL1	Use Tunable Wavelength 1
<LOSSB>	The parameter type is REACH, which indicates the reach values.
AUTOPROV	Autoprovisioning
CX	Reach CX
DX	Reach DX
HX	Reach HX
I1	Reach I1
IR-1	Reach IR-1
IR-2	Reach IR-2
L1	Reach L1
L2	Reach L2
L3	Reach L3
LR-1	Reach LR-1
LR-2	Reach LR-2
LR-3	Reach LR-3
LX	Reach LX
S1	Reach S1
S2	Reach S2
SR	Reach SR
SR-1	Reach SR-1
SX	Reach SX
T	Reach T
VX	Reach VX
ZX	Reach ZX
<PORTNAME>	(Optional) Port name. PORTNAME is a string.
<GCC>	Identifies the generic communication channel (GCC) connection of the port.
Y	GCC can be utilized.
N	GCC cannot be utilized.
<GCCRATE>	(Optional) The data rate of the GCC traffic. The default is 192 Kbps. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the DWDM port. The parameter type is GCCRATE, which is the data rate of the GCC traffic.
192K	192 Kbps
576K	576 Kbps
<DWRAP>	(Optional) The ITU-T G.709 monitoring digital wrapper. It is either on or off. The system default is ON. For MXP_2.5G_10G and TXP_MR_10G cards, this applies only to the DWDM port. The parameter type is ON_OFF (disable or enable an attribute). To enable ITU-T G.709 monitoring, there should be no GCC on the DWDM port and the payload (in which the card is configured) should not be UNFRAMED. To disable ITU-T G.709 monitoring, there should be no GCC on the DWDM port, the FEC should be turned to off, there should be no overhead circuit created on the DWDM port, and none of the client ports on the card should be part of a Y-cable protection group (muxponder only).
N	Disable an attribute.
Y	Enable an attribute.
<FEC>	(Optional) Forward error correction. It can be enabled only if ITU-T G.709 monitoring is turned ON. It is either off or enabled in standard or enhanced mode. The system default is standard FEC enabled. The FEC level PM and thresholds apply if the FEC is turned ON. The parameter type is FEC_MODE, which specifies the type of forward error correction.
ENH	Enhanced FEC is enabled.
OFF	FEC is disabled.
STD	Standard FEC is enabled.
<PAYLOADMAP>	(Optional) The type of payload mapping. It can be enabled only if ITU-T G.709 monitoring is turned ON and FEC is enabled. The parameter type is PAYLOAD_MAPPING, which is the payload mapping mode.
ASYNCH	Asynchronous mapping mode
ODU	ODU multiplex structure mode
SYNCH	Synchronous mapping mode
<OSFBER>	(Optional) The signal failure threshold at the OTN level. 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.
<OSDBER>	OTN SDBER. Can only be provisioned on the working port. Defaults to 1E-7. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path
1E-5	SDBER is 1E-5.
1E-6	SDBER is 1E-6.
1E-7	SDBER is 1E-7.
1E-8	SDBER is 1E-8.
1E-9	SDBER is 1E-9.
<SOAK>	(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals. A value of 4 equals a soak time of 1 hour. The allowable range is 0 to 192 intervals (maximum of 48 hours). SOAK is an integer.
<SOAKLEFT>	(Optional) OOS-AINS to IS transition soak time as measured in 15-minute intervals, so a value of 4 translates to a soak time of 1 hour. The allowable range is 0 to 192 intervals, 48 hours maximum.
<LBCL>	(Optional) Displays the current value of the laser current. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<OPT>	(Optional) Displays the current value of the transmitted optical power. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<OPR>	(Optional) Displays the current value of the received optical power. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<PST_PSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
IS_NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-OCHCC

(Cisco ONS 15454) The Retrieve Optical Channel Client Connection (RTRV-OCHCC) command retrieves the OCH client connection provisioning information.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-OCHCC:VA454-22:FAC-2-1-1:116;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[PAYLOAD=<PAYLOAD>],[CTKID=<CTKID>]:<PSTPSTQ>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1-1::PAYLOAD=OC192,CTKID=\"OCHCC\":IS-NR" ;

Output Parameters

<AID>	Access identifier from the CHANNEL.
<PAYLOAD>	Indicates the payload of the connection which is equivalent to the type of the payload configured on the facility port where the connection is originated or terminated. Parameter type is MOD1PAYLOAD.
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	D1Video payload
DV6000	DV6000 payload
EC1	EC1 payload
ESCON	ESCON payload
ETRCLO	ETRCLO payload
GIGE	1 G Ethernet payload
HDTV	HDTV payload
ISC3PEER1G	1 Gbps ISC3 Peer
ISC3PEER2G	2 Gbps ISC3 Peer
ISC3PEER2R	1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1 Gbps ISC1, ISC2, and ISC3 compatibility
OC12	OC12 payload
OC192	OC192 payload
OC3	OC3 payload
OC48	OC48 payload
T3	DS3 payload
<CKTID>	Cross-connect ID. The default is Blank or None. String of ASCII characters. Maximum length is 48. If CKTID is empty or null the CKTID field will not be displayed.
<PSTPSTQ>	Service state. The parameter is PST_PSTQ, which provides 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

RTRV-OCHNC

(Cisco ONS 15454) The Retrieve Optical Channel Network Connection (RTRV-OCHNC) command retrieves the OCH wavelength connection provisioning information.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-OCHNC:VA454-22:CHANWL-1-3-TX-1530.33:116;

Input Parameters

<AID>

Access identifier from the CHANNEL.

Output Format

SID DATE TIME M CTAG COMPLD "<SRC>,<DST>:<WCT>:[CKTID=<CKTID>]::<PSTPSTQ>" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHANWL-1-3-TX-1530.33,LINEWL-4-1-RX-1530.33:1WAY:CKTID=\"OCHNC-1\":IS-NR" ;

Output Parameters

<SRC>	Source access identifier from the CHANNEL. In 2-way wavelength connection sources both directions need to be indicated.
<DST>	Destination access identifier from the LINEWL. In 2-way wavelength connection sources both directions need to be indicated.
<WCT>	Wavelength connection type. The parameter type is WCT. The default is 1WAY.
1WAY	A unidirectional wavelength connection for one specified ring direction.
2WAY	A bidirectional wavelength connection for both the ring directions.
<CKTID>	Cross-connect ID. The default is Blank or None. String of ASCII characters. Maximum length is 48. If CKTID is empty or null the CKTID field will not be displayed.
<PSTPSTQ>	Service state. The parameter is PST_PSTQ, which provides 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

RTRV-OMS

(Cisco ONS 15454) The Retrieve Optical Multiplex Section (RTRV-OMS) command retrieves the attributes (service parameters) and state of an OMS facility.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-OMS:PENNGROVE:BAND-6-1-RX:236;

Input Parameters

<AID>

Access identifier from the BAND.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>], EXPBAND=<EXPBAND>,[ACTBAND=<ACTBAND>],[ILOSS=<ILOSS>], [VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>],[VOAPWR=<VOAPWR>], [VOAREFATTN=<VOAREFATTN>],[VOAREFPWR=<VOAREFPWR>], [REFOPWR=<REFOPWR>],[CALOPWR=<CALOPWR>],[CHPOWER=<CHPOWER>], [NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "BAND-6-1-RX::RDIRN=W-E,OPTYPE=ADD,OPWR=10.0,EXPBAND=UNKNOWN, ACTBAND=1530.33_1531.12,ILOSS=1.0,VOAMODE=ATTN,VOAATTN=0.5, VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,REFOPWR=10.5,CALOPWR=0.5, CHPOWER=2.0,NAME=\"OMS PORT\":OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the CHANNEL.
<RDIRN>	Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
E-W	The direction of the signal is from east to west (clockwise).
W-E	The direction of the signal is from west to east (counterclockwise).
<OPTICALPORTTYPE>	The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
ADD	The signal is added to the port.
DROP	The signal is dropped from the port.
IN-COM	COM channels (without an OSC) that continue the signal from the previous card.
IN-DC	Input dispersion compensation unit (DCU) port.
IN-EXP	Express channel that continues the signal from the previous card.
IN-LINE	All the channels that continue the signal from the previous card.
IN-OSC	OSC channel that continues the signal from the previous card.
OUT-COM	COM channels (without an OSC) that continue the signal to the next card.
OUT-DC	Output DCU port.
OUT-EXP	Express channel that continues the signal to the next card.
OUT-LINE	All the channels that continue the signal to the next card.
OUT-OSC	OSC channel that continue the signal to the next card.
<POWER>	(Optional) The optical power measured at this port. It can be the input or output power according to port type. POWER is a string.
<EXPBAND>	The expected value of the band for this port. The parameter type is OPTICAL_BAND (optical band).
1530.33 to 1532.68	Band 1
1534.25 to 1536.61	Band 2
1538.19 to 1540.56	Band 3
1542.14 to 1544.53	Band 4
1546.12 to 1548.51	Band 5
1550.12 to 1552.52	Band 6
1554.13 to 1556.55	Band 7
1558.17 to 1560.61	Band 8
USE-DEFAULT	This band is not yet configured/retrieved from unit.
<ACTBAND>	(Optional) Identifies the manufacturing optical band (group of four contiguous wavelengths) for this port. The parameter type is OPTICAL_BAND (optical band).
1530.33 to 1532.68	Band 1
1534.25 to 1536.61	Band 2
1538.19 to 1540.56	Band 3
1542.14 to 1544.53	Band 4
1546.12 to 1548.51	Band 5
1550.12 to 1552.52	Band 6
1554.13 to 1556.55	Band 7
1558.17 to 1560.61	Band 8
USE-DEFAULT	This band is not yet configured/retrieved from unit.
<ILOSS>	(Optional) Insertion loss expressed in dBm. ILOSS applies to output ports only.
<VOAMODE>	(Optional) The working control mode of the VOA. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
ATTN	VOA has a fixed attenuation.
POWER	VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>	(Optional) The value of calibrated attenuation for the VOA. VOAATTN is a float and a string.
<VOAPWR>	(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. VOAPWR is a float and a string.
<VOAREFATTN>	(Optional) The value of reference attenuation for the VOA. VOAREFATTN is a float and a string.
<VOAREFPWR>	(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. VOAREFPWR is a float and a string.
<REFOPWR>	(Optional) The value of the calculated optical power expected for the output line added to the calibration value which equals the total expected output power. REFOPWR is a float and a string.
<CALOPWR>	(Optional) The value of the calibrated optical power expected for the output added to the calculated value, which equals the total expected output power. Expressed in dBm. Defaults to 0 dBm. CALOPWR is a float and a string.
<CHPOWER>	(Optional) The per-channel optical power. The parameter type is REVERTIVE_TIME.
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<NAME>	(Optional) Facility name. NAME is a string.
<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 a primary state qualifier (PSTQ).
IS_NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-OPM

(Cisco ONS 15454) The Retrieve Optical Monitoring Parameter (RTRV-OPM) command retrieves the optical power monitoring parameters present at the OCH layer in a reconfigurable optical add/drop multiplexing (ROADM) node.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-OPM:VA454-22:OPM-5-1530.33:116;

Input Parameters

<AID>

Access identifier from the OPM.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[POWEROUT=<POWEROUT>],[POWERADD=<POWERADD>], [POWERPT=<POWERPT>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "OPM-5-1530.33::POWEROUT=9.0,POWERADD=10.0,POWERPT=11.0:" ;

Output Parameters

<AID>	Access identifier from the OPM.
<POWEROUT>	(Optional) The value of the output power associated to the add or pass-through channel port of a 32WSS card. POWEROUT is a float.
<POWERADD>	(Optional) The value of the input power associated to the add channel port of a 32WSS card. POWERADD is mutually exclusive with the POWERPT parameter. POWERADD is a float.
<POWERRPT>	(Optional) The value of the input power associated to the pass-through channel port of a 32WSS card. POWERPT is mutually exclusive with the POWERADD parameter. POWERPT is a float.

RTRV-OTS

(Cisco ONS 15454) The Retrieve Optical Transport System (RTRV-OTS) command retrieves the attributes (service parameters) and state of an OTS facility.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-OTS:PENNGROVE:LINE-6-1-RX:236;

Input Parameters

<AID>

Access identifier from the LINE.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:RDIRN=<RDIRN>,OPTYPE=<OPTICALPORTTYPE>,[OPWR=<POWER>], [ILOSS=<ILOSS>],[VOAMODE=<VOAMODE>],[VOAATTN=<VOAATTN>], [VOAPWR=<VOAPWR>],[VOAREFATTN=<VOAREFATTN>], [VOAREFPWR=<VOAREFPWR>],[OSRI=<OSRI>],[AMPLMODE=<AMPLMODE>], [CHPOWER=<CHPOWER>],[GAIN=<GAIN>],[EXPGAIN=<EXPGAIN>], [REFOPWR=<REFOPWR>],[OFFSET=<OFFSET>],[REFTILT=<REFTILT>], [CALTILT=<CALTILT>],[ASEOPWR=<ASEOPWR>],[DCULOSS=<DCULOSS>], [AWGST=<AWGST>],[HEATST=<HEATST>],[NAME=<NAME>]:<PST_PSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "LINE-6-1-RX:RDIRN=W-E,OPTYPE=IN,OPWR=10.0,ILOSS=1.0,VOAMODE=ATTN, VOAATTN=0.5,VOAPWR=0.0,VOAREFATTN=3.5,VOAREFPWR=5.0,OSRI=Y, AMPLMODE=GAIN,CHPOWER=-10.0,GAIN=3.0,EXPGAIN=3.0,REFOPWR=10.0, OFFSET=0.0,REFTILT=3.0,CALTILT=0.0,ASEOPWR=5.0,DCULOSS=1.2, AWGST=WARM-UP,HEATST=ON,NAME=\"OTS PORT\":OOS-AU,AINS" ;

Output Parameters

<AID>	Access identifier from the LINE.
<RDIRN>	Ring directionality of the optical line. The parameter type is RDIRN_MODE, which is the optical ring directionality.
E-W	The direction of the signal is from east to west (clockwise).
W-E	The direction of the signal is from west to east (counterclockwise).
<OPTICALPORTTYPE>	The optical port type. The parameter type is OPTICAL_PORT_TYPE, which qualifies the optical port of a card.
ADD	The signal is added to the port.
DROP	The signal is dropped from the port.
IN-COM	COM channels (without OSC) that continue the signal from the previous card.
IN-DC	Input DCU port.
IN-EXP	Express channel that continues the signal from the previous card.
IN-LINE	All the channels that continue the signal from the previous card.
IN-OSC	OSC channel that continues the signal from the previous card.
OUT-COM	Identifies the COM channels (without OSC) that continue the signal to the next card.
OUT-DC	Output DCU port.
OUT-EXP	Identifies the express channel that continues the signal to the next card.
OUT-LINE	Identifies all the channels that continue the signal to the next card.
OUT-OSC	Identifies the OSC channel that continues the signal to the next card.
<POWER>	(Optional) The optical power measured at this port. It can be the input or output power according to port type. POWER is a float.
<ILOSS>	(Optional) Insertion loss.
<VOAMODE>	(Optional) The working control mode of the VOA. The parameter type is VOA_CNTR_MODE, which defines the VOA control mode.
ATTN	VOA has a fixed attenuation.
POWER	VOA controls the attenuation to obtain a fixed output power.
<VOAATTN>	(Optional) The value of calibrated attenuation for the VOA. VOAATTN is a float.
<VOAPWR>	(Optional) The value of calibrated output power that the VOA is going to set as a result of its attenuation. VOAPWR is a float.
<VOAREFATTN>	(Optional) The value of reference attenuation for the VOA. VOAREFATTN is a float.
<VOAREFPWR>	(Optional) The value of reference output power that the VOA is going to set as a result of its attenuation. VOAREFPWR is a float.
<OSRI>	(Optional) OSRI enabled or disabled. Present only on a port where the safety is supported. Defaults to off. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<AMPLMODE>	(Optional) The optical amplification control mode. The parameter type is AMPL_MODE, which defines the amplifier control mode.
GAIN	The amplifier always maintains a fixed gain.
POWER	The amplifier maintains the output power to a fixed value.
<CHPOWER>	(Optional) The per channel optical power. Applicable only to amplified OTS ports.
<GAIN>	(Optional) The value of the gain of the amplifier. Defaults to 21 dB for preamplifier and 20 dB for booster amplifier.
<EXPGAIN>	(Optional) The expected gain value to be reached from an amplifier when the node is in a DWDM access network. EXPGAIN is a float.
<REFOPWR>	(Optional) The value of the calculated optical power expected for the output line added to the calibration value, which equals the total expected output power. REFOPWR is a float.
<OFFSET>	(Optional) The value of the calibrated optical power expected for the output line, which is added to the calculated value to have the total expected output power. OFFSET is a float.
<REFTILT>	(Optional) The calculated tilt value to be added to the user provided calibration value. REFTILT is a float.
<CALTILT>	(Optional) The amplifier calibration tilt offset to be added to the calculated reference value. CALTILT is a float.
<ASEOPWR>	(Optional) The value of the calibrated optical power expected for the output line, which is provided by the user, added to the calculated value to have the total expected output power. ASEOPWR is a float.
<DCULOSS>	(Optional) The value of insertion loss associated to DCU in between the two stages of a preamplifier unit. DCULOSS is a float.
<AWGST>	The status assumed by AWG. The parameter value is AWG_STATUS, which is the AWG status list.
ON	The AWG is on.
WARM-UP	The AWG is warming up.
<HEATST>	(Optional) The status assumed by the heater. The parameter type is HEATER_STATUS, which is the heater status list.
OFF	The heater is off.
ON	The heater is on.
<NAME>	(Optional) Name of the port. NAME is a string.
<PST_PSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
IS_NR	In Service and Normal
OOS-AU	Out of Service and Autonomous
OOS-AUMA	Out of Service and Autonomous Management
OOS-MA	Out of Service and Management
<SSTQ>	(Optional) Secondary state of the entity. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AINS	Automatic In-Service
DSBLD	Disabled
LPBK	Loopback
MEA	Mismatch of Equipment
MT	Maintenance
OOG	Out of Group
SWDL	Software Download
UAS	Unassigned
UEQ	Unequipped

RTRV-PATH-OCH

(ONS 15454) The Retrieve Path Optical Channel (RTRV-PATH-OCH) command retrieves the OCH path inside a node. An OCH path is a list of access identifiers that addresses all the possible facility and internal optical channels that are all associated to the same wavelength.

Usage Guidelines

None

Category

DWDM

Security

Retrieve

Input Format

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

Input Example

RTRV-PATH-OCH:PENNGROVE:CHAN-6-2:236;

Input Parameters

<AID>

Access identifier from the CHANNEL, LINEWL, and BANDWL.

Output Format

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

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "CHAN-6-2::WLEN=1530.33,PATH=LINEWL-1-3-RX-1530.33&LINEWL-1-1-TX-1530.33& LINEWL-3-1-RX-1530.33&CHAN-3-1-TX&CHAN-6-2:" ;

Output Parameters

<AID>	Access identifier from the CHANNEL, LINEWL, and BANDWL.
<WLEN>	Defines the optical wavelength. The parameter type is OPTICAL_WLEN (optical wavelength).
1530.33	Wavelength C Band - 1/40
1530.72	Wavelength 1530.72
1531.12	Wavelength C Band - 2/40
1531.90	Wavelength C Band - 3/40
1532.68	Wavelength C Band - 4/40
1534.25	Wavelength C Band - 6/40
1535.04	Wavelength C Band - 7/40
1535.82	Wavelength C Band - 8/40
1536.61	Wavelength C Band - 9/40
1538.19	Wavelength C Band - 11/40
1538.98	Wavelength C Band - 12/40
1539.77	Wavelength C Band - 13/40
1540.56	Wavelength C Band - 14/40
1542.14	Wavelength C Band - 16/40
1542.94	Wavelength C Band - 17/40
1543.73	Wavelength C Band - 18/40
1544.53	Wavelength C Band - 19/40
1546.12	Wavelength C Band - 21/40
1546.92	Wavelength C Band - 22/40
1547.72	Wavelength C Band - 23/40
1548.11	Wavelength 1548.11
1548.51	Wavelength C Band - 24/40
1548.91	Wavelength 1548.91
1549.72	Wavelength 1549.72
1550.12	Wavelength C Band - 26/40
1550.92	Wavelength C Band - 27/40
1551.72	Wavelength C Band - 28/40
1552.52	Wavelength C Band - 29/40
1554.13	Wavelength C Band - 31/40
1554.94	Wavelength C Band - 32/40
1555.75	Wavelength C Band - 33/40
1556.55	Wavelength C Band - 34/40
1558.17	Wavelength C Band - 36/40
1558.98	Wavelength C Band - 37/40
1559.79	Wavelength C Band - 38/40
1560.61	Wavelength C Band - 39/40
1577.44	L-Band Wavelength 1577.44
1577.86	L-Band Wavelength 1577.86
1578.27	L-Band Wavelength 1578.27
1578.69	L-Band Wavelength 1578.69
1579.10	L-Band Wavelength 1579.10
1579.52	L-Band Wavelength 1579.52
1579.93	L-Band Wavelength 1579.93
1580.35	L-Band Wavelength 1580.35
1580.77	L-Band Wavelength 1580.77
1581.18	L-Band Wavelength 1581.18
1581.60	L-Band Wavelength 1581.60
1582.02	L-Band Wavelength 1582.02
1582.44	L-Band Wavelength 1582.44
1582.85	L-Band Wavelength 1582.85
1583.27	L-Band Wavelength 1583.27
1583.69	L-Band Wavelength 1583.69
1584.11	L-Band Wavelength 1584.11
1584.53	L-Band Wavelength 1584.53
1584.95	L-Band Wavelength 1584.95
1585.36	L-Band Wavelength 1585.36
1585.78	L-Band Wavelength 1585.78
1586.20	L-Band Wavelength 1586.20
1586.62	L-Band Wavelength 1586.62
1587.04	L-Band Wavelength 1587.04
1587.46	L-Band Wavelength 1587.46
1587.88	L-Band Wavelength 1587.88
1588.30	L-Band Wavelength 1588.30
1588.73	L-Band Wavelength 1588.73
1589.15	L-Band Wavelength 1589.15
1589.57	L-Band Wavelength 1589.57
1589.99	L-Band Wavelength 1589.99
1590.41	L-Band Wavelength 1590.41
1590.83	L-Band Wavelength 1590.83
1591.26	L-Band Wavelength 1591.26
1591.68	L-Band Wavelength 1591.68
1592.10	L-Band Wavelength 1592.10
1592.52	L-Band Wavelength 1592.52
1592.95	L-Band Wavelength 1592.95
1593.37	L-Band Wavelength 1593.37
1593.79	L-Band Wavelength 1593.79
<PATH>	Access identifier from the CHANNEL or the LINEWL.

RTRV-PM-<MOD2>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETH, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (RTRV-PM-<MOD2>) command retrieves the values of PM parameters for a specified card type.

Usage Guidelines

See Table 28-1 for supported modifiers by platform.
MONLEV is in the format of 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 there are no errors to report, the response will be COMPLD (completed).
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 BLSR switching, the working path is switched out, the traffic goes through the protection path, and the IPPM can be retrieved from the protection STS path.
If there is a STS PCA on the protection path, during the BLSR switching, the PCA path is preemptive; sending this command on the protection path after a BLSR 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 SONET PMs are applicable and will appear. If the card payload is in SONET mode, then SONET 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 SONET mode, then SONET 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.
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-T1: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 STS, VT1, Facility, and DS1 AIDs are supported.
<MONTYPE>	Monitored 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-VT 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, 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-VT 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-VT 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. The parameter type is DIRECTION (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 SONET 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

ID 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>	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
DS1	DS1 alarm
DS3I	DS3I alarm
E100	E100 alarm
E1000	E1000 alarm
EC1	EC1 alarm
ENV	ENV alarm
EQPT	EQPT alarm
FSTE	Fast Ethernet Port alarm
G1000	G1000 alarm
GIGE	Gigabit Ethernet port alarm
ISC3PEER1G	1 Gbps ISC3 Peer
ISC3PEER2G	2 Gbps ISC3 Peer
ISC3PEER2R	1 Gbps or 2 Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1 Gbps ISC1, ISC2, and ISC3 compatibility
OC3	OC3 alarm
OC12	OC12 alarm
OC48	OC48 alarm
OC192	OC192 alarm
OCH	Optical channel
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port alarm
STS1	STS1 alarm
STS3C	STS3c alarm
STS6C	STS6c alarm
STS9C	STS9c alarm
STS18C	STS18c alarm
STS12C	STS12c alarm
STS24C	STS24c alarm
STS36C	STS36c alarm
STS48C	STS48c alarm
STS192C	STS192c alarm
SYNCN	SYNCN alarm
T1	T1 alarm
T3	T3 alarm
TCC	TCC alarm
VT1	VT1 alarm
VT2	VT2 alarm
<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
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.
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-VT 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-VT 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-VT 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. MOVAL 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 SONET 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-PM-ALL

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) 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 BLSR switching, the working path is switched out, the traffic goes through the protection path, and the IPPM can be retrieved from the protection STS path.
If there is a STS PCA on the protection path, during the BLSR switching, the PCA path is preemptive; sending this command on the protection path after a BLSR 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 SONET PMs are applicable and will appear. If the card payload is in SONET mode, then SONET 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 SONET mode, then SONET 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 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
OC3	OC3 facility
OC12	OC12 facility
OC48	OC48 facility
OC192	OC192 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
STS1	STS1 path
STS3C	STS3c path
STS6C	STS6c path
STS9C	STS9c path
STS18C	STS18c path
STS12C	STS12c path
STS24C	STS24c path
STS36C	STS36c path
STS48C	STS48c path
STS192C	STS192c path
T1	T1/DS1 facility/line
T3	T3/DS1 facility/line
VT1	VT1 path
VT2	VT2 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-VT 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-VT 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-VT 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 SONET 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
OC3	OC3 alarm
OC12	OC12 alarm
OC48	OC48 alarm
OC192	OC192 alarm
OCH	Optical channel
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port alarm
STS1	STS1 alarm
STS3C	STS3c alarm
STS6C	STS6c alarm
STS9C	STS9c alarm
STS18C	STS18c alarm
STS12C	STS12c alarm
STS24C	STS24c alarm
STS36C	STS36c alarm
STS48C	STS48c alarm
STS192C	STS192c alarm
SYNCN	SYNCN alarm
T1	T1 alarm
T3	T3 alarm
TCC	TCC alarm
VT1	VT1 alarm
VT2	VT2 alarm
<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-VT 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-VT 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-VT 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 SONET 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-<STS_PATH>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance Mode of PM Data Collection for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, or STS9C (RTRV-PMMODE-<STS_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 PMs are being collected by the NE.

Usage Guidelines

See Table 28-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 intermediate-path performance monitoring (IPPM) only supports OC3, OC12, OC48, OC192, and EC1 on the STS 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. Note that the PM monitoring for Line (L) and Section (S) are supported by the ONS 15454, and the storing PM data is always performed.
This command only returns the categories that are enabled (pmstate is ON), and does not return the categories that are disabled (pmstate is OFF).

Category

Performance

Security

Retrieve

Input Format

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

Input Example

RTRV-PMMODE-STS1:CISCO:STS-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 "STS-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 subentity 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-PMMODE-<VT_PATH>

(Cisco ONS 15310-MA) The Retrieve Performance Mode of PM Data Collection for VT1 and VT2 (RTRV-PMMODE-<VT_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 PMs are being collected by the NE.

Usage Guidelines

The PM mode and state of an entity is set by using the SET-PMMODE command.
This command returns the categories that are enabled (pmstate is ON) only. It does not return the categories that are disabled (pmstate is OFF).
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.

Category

Performance

Security

Retrieve

Input Format

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

Input Example

RTRV-PMMODE-VT1:CISCO:VT-1-1-2-2:1::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. Must not be null.
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 "VT1-1-1-2-2:NEND,P" ;

Output Parameters

<CROSSCONNECTID>	Access identifier from the CrossConnectId1.
<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.
<MODETYPE>	The type of PM parameters that the entity or the subentity 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, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance Monitoring Schedule for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, CLNT, D1VIDEO, DS1, DV6000, E1, E3, E4, EC1, ESCON, ETRCLO, ETH, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ILK, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OCH, OMS, OTS, POS, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, T1, T3, VC12, VC3, VT1, or VT2 (RTRV-PMSCHED-<MOD2>) command retrieves the PM reporting schedule that was set for the NE by the SCHED-PMREPT command.

Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Category

Performance

Security

Retrieve

Input Format

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

Input Example

RTRV-PMSCHED-OC3: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,OC3: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
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 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
OC3	OC3 facility
OC12	OC12 facility
OC48	OC48 facility
OC192	OC192 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
STS1	STS1 path
STS3C	STS3c path
STS6C	STS6c path
STS9C	STS9c path
STS18C	STS18c path
STS12C	STS12c path
STS24C	STS24c path
STS36C	STS36c path
STS48C	STS48c path
STS192C	STS192c path
T1	T1/DS1 facility/line
T3	T1/DS1 facility/line
VT1	VT1 path
VT2	VT2 path
<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 the PM will be reported. NUMINVL is an integer.
<LOCN>	Location associated with a particular command. Identifies the location from which the PM mode will 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; every 24 hours. For SONET 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.
<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-PMSCHED-ALL

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Performance Schedule All (RTRV-PMSCHED-ALL) command retrieves all the PM reporting schedules that were set for the NE by 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 that require description

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,OC3: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
DS1	DS-1 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 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
OC3	OC-3 facility
OC12	OC-12 facility
OC48	OC-48 facility
OC192	OC-192 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
STS1	STS1 path
STS3C	STS3c path
STS6C	STS6c path
STS9C	STS9c path
STS18C	STS18c path
STS12C	STS12c path
STS24C	STS24c path
STS36C	STS36c path
STS48C	STS48c path
STS192C	STS192c path
T1	T1/DS1 facility/line
T3	T1/DS1 facility/line
VT1	VT1 path
VT2	VT2 path
<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.
<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; every 24 hours. For SONET 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.
<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, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Packet Over SONET (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

This command is supported for the ML-Series cards, but for the ONS 15310-CL ML-100T-8 card, ADMINSTATE, ENCAP, SOAK, and SOAKLEFT information will not appear.
For the ML-Series card, the EDGE, RPRSPAN, JUMBO, ADMINSTATE, ENCAP, and NAME parameters are valid when the card mode is ML-IEEE-RPR. Other parameters, including PST and SST, are not valid in this mode.
This command is supported for the ASAP card, but ADMINSTATE information will not appear.
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 type. The parameter type is UP_DOWN (up or down).
DOWN	Down
UP	Up
<ENCAP>	Frame encapsulation
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) 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. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. 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 BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lockout of protection.
LOCKOUTOFWK	Lockout of working.
MANWKSWBK	Manual switch of working unit back to working.
MANWKSWPR	Manual switch of working unit back to the protection unit.
RING	BLSR ring switch type.
SPAN	BLSR span switch type.

RTRV-PROTNSW-<OCN_TYPE>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Protection Switch for OC3, OC12, OC48, or OC192 (RTRV-PROTNSW-<OSC_TYPE>) command retrieves the switching state of a SONET line specified in the AID.

Usage Guidelines

See Table 28-1 for supported modifiers by platform.

Category

Protection

Security

Retrieve

Input Format

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

Input Example

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

Input Parameters

<AID>

Access identifier from the FACILITY.

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. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. 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 BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lockout of protection.
LOCKOUTOFWK	Lockout of working.
MANWKSWBK	Manual switch of working unit back to working.
MANWKSWPR	Manual switch of working unit back to the protection unit.
RING	BLSR ring switch type.
SPAN	BLSR span switch type.

RTRV-PROTNSW-<PATH>

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Protection Switch for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RTRV-PROTNSW-<PATH>) command retrieves the switching state of a SONET path protection STS path specified in the AID. Because Telcordia GR-1400 does not allow LOCKOUT_OF_WORKING on the path protection WORKING path/AID, the "AID:LOCKOUT,LOCKOUTOFWK" does not appear in this protection switch retrieval result.

Usage Guidelines

See Table 28-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.

Category

Protection

Security

Retrieve

Input Format

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

Input Example

RTRV-PROTNSW-STS1:CISCO:STS-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 "STS-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. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. 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 BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lockout of protection.
LOCKOUTOFWK	Lockout of working.
MANWKSWBK	Manual switch of working unit back to working.
MANWKSWPR	Manual switch of working unit back to the protection unit.
RING	BLSR ring switch type.
SPAN	BLSR span switch type.

RTRV-PROTNSW-OCH

(Cisco ONS 15454) 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. CLEAR switch state is not allowed in the OPR-PROTNSW-xxx commands.
EXERCISE	EXERCISE switch state. 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 BLSR switch type. MANWKSWBK, MANWKSWPR, FRCDWKSWBK, FRCDWKSWPR, LOCKOUTOFPR, and LOCKOUTOFWK are retrieve-only values for RTRV-PROTNSW-OCn commands. They are not applicable for the OPR-PROTNSW-OCn commands. RING and SPAN are the only allowed values for BLSR protection.
FRCDWKSWBK	Working unit is forced to switch back to working.
FRCDWKSWPR	Working unit is forced to switch to the protection unit.
LOCKOUTOFPR	Lockout of protection.
LOCKOUTOFWK	Lockout of working.
MANWKSWBK	Manual switch of working unit back to working.
MANWKSWPR	Manual switch of working unit back to the protection unit.
RING	BLSR ring switch type.
SPAN	BLSR span switch type.

RTRV-PROTOCOL

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Protocol (RTRV-PROTOCOL) command retrieves the status of a protocol or service supported in the NE. Valid protocols include SHELL, EMS, TL1, and SNMP. If the AID is not specified, the status of all 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 or 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/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 or service to which the command pertains. The parameter type is PROTOCOLAID, which is the AID for the protocol/service.
EMS	CTC/CTM protocol/service
SHELL	Shell/file system access protocol
SNMP	SNMP protocol/service
TL1	TL1 protocol/service
PROTOCOLSTAT	Identifies the status of the protocol or 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, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Retrieve Path Trace for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS6C, STS9C, VT1, or VT2 (RTRV-PTHTRC-<PATJ>) command retrieves the contents of the SONET path trace message.

Usage Guidelines

See Table 28-1 for supported modifiers by platform.

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, which 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 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 DS1/DS1N, DS3E/DS3NE, DS3XM, EC1, OC3, OC48A, OC192, OC192-XFP, and MRC-12 cards.
TRC is supported only on DS1(N), DS3(N)E, and DS3XM cards.
The VCAF AID is only valid on slots holding ML-Series cards.
After the BLSR 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 STS path.
If there is an STS PCA on the protection path during the BLSR switch, the PCA path is preemptive. If this command is sent on the protection path after a BLSR switch, the command will return the trace message off of the protection path and not from the PCA path.
The J2 path trace on the VT1.5 is supported on the VT1.5 cross-connection of the DS3XM-12 card in Software R5.0 and later.
The VT2 modifier is not supported in this release.
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 it's own output row. You also cannot use the AIDs that end in ALL because this might also result in multiple output rows.
On the ONS 15310-MA, J2 path trace is supported on DS1 ports only. J2 path trace is not supported on ONS 15310-MA OCn ports and EC1 ports.

Category

Troubleshooting and Test Access

Security

Retrieve

Input Format

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

Input Example

RTRV-PTHTRC-STS1:CISCO:STS-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 (carriage return) and the LF (line feed). TRACMSG is a string.

RTRV Commands (Q through W)

Currently 0.00/5
1
2
3
4
5

Rating: 0.0/5 (0 votes cast)

ONS SONET TL1 Command Guide R8.5.1 -- RTRV Commands (D through P)

From DocWiki

Contents

RTRV-DFLT-SECU

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-DS1

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-EC1

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-EQPT

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-ESCON

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-ETH

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-EXT-CONT

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-FAC

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters