ONS SDH TL1 Command Guide R8.5.1 -- RTRV Commands (D through O)

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-DS3I
- 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-E1
- 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-E3
- 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-E4
- 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-EQPT
- 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-ESCON
- 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-ETH
- 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-EXT-CONT
- 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-FAC
- 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
- 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-<MOD2DWDMPAYLOAD>
- 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-FFP-<STM_TYPE>
- 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-FFP-OCH
- 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-FSTE
- 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-FTPSERVER
- 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-G1000
- 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-GFP
- 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-GIGE
- 19.1 Usage Guidelines
- 19.2 Category
- 19.3 Security
- 19.4 Input Format
- 19.5 Input Example
- 19.6 Input Parameters
- 19.7 Output Format
- 19.8 Output Example
- 19.9 Output Parameters
20 RTRV-HDLC
- 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-HDR
- 21.1 Category
- 21.2 Security
- 21.3 Input Format
- 21.4 Input Example
- 21.5 Input Parameters
22 RTRV-INV
- 22.1 Usage Guidelines
- 22.2 Category
- 22.3 Security
- 22.4 Input Format
- 22.5 Input Examples
- 22.6 Input Parameters
- 22.7 Output Format
- 22.8 Output Example
- 22.9 Output Parameters
23 RTRV-L2-ETH
- 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
- 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-CTRL
- 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-LMP-TLINK
- 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-LMP-DLINK
- 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-LNK
- 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-LNKTERM
- 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-LOG
- 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-MAP-NETWORK
- 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-APC
- 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-GEN
- 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-IPMAP
- 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-PATH
- 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-NE-SYNCN
- 36.1 Usage Guidelines
- 36.2 Category
- 36.3 Security
- 36.4 Input Format
- 36.5 Input Examples
- 36.6 Input Parameters
- 36.7 Output Format
- 36.8 Output Examples
- 36.9 Output Parameters
37 RTRV-NE-WDMANS
- 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-NETYPE
- 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-NNI-ETH
- 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-OCH
- 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-OCHCC
- 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-OCHNC
- 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-OMS
- 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-OPM
- 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-OTS
- 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-PATH-OCH
- 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

RTRV-DFLT-SECU

(Cisco ONS 15454 SDH and ONS 15600 SDH) 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/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 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. DURAL is 0 for RTRV users, 60 minutes for MAINT users, 30 minutes for PROV users, and 15 minutes for SUPER users. TMOUT is an integer.
<UOUT>	UID aging interval, expressed in days. If a user ID 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 45 to 90 days. UOUT is an integer.
<PFRCD>	Indicates 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	No
YES	Yes
<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 user ID, regardless of the method of login (for example, CTC, TL1, etc.). Default is MUL TIPLE. 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.
SINGLE	A user can log into the NE only once (includes both CTC and TL1 sessions).
MULTIPLE	A user can log into the same NE many times.
<PRIVLVL>	(Optional) User's access privilege. The 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-DS3I

(Cisco ONS 15454 SDH) The Retrieve DS3I (RTRV-DS3I) command retrieves the properties of a DS3i-N-12 facility.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

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

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::FMT=<FMT>,LINECDE=<LINECDE>,LBO=<LBO>,[INHFELPBK=<INHFELPBK>], [TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[SFBER=<SFBER>],[SDBER=<SDBER>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-2::FMT=C-BIT,LINECDE=B3ZS,LBO=0-225,INHFELPBK=N,TACC=8, TAPTYPE=DUAL,SFBER=1E-4,SDBER=1E-6,SOAK=10,SOAKLEFT=12-25, NAME=\"DS3I PORT\":UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<FMT>	Digital signal format. The parameter type is DS_LINE_TYPE, which is the DS123 line type.
C-BIT	M13 line type.
M13	Frame format is ESF.
UNFRAMED	Line type is unframed.
<LINECDE>	Line code. The parameter type is DS_LINE_CODE, which is the DS123 line code.
B3ZS	Bipolar with three-zero substitution
<LBO>	Line build out 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.
<INHFELPBK>	(Optional) Far-end loopback inhibition attribute of the port. If it is Y, the automatic far-end loopbacks are inhibited. It is either on or off. The system default is N. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<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
<SFBER>	(Optional) Signal failure threshold. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) Signal degrade threshold. The parameter type is SD_BER, which is the threshold for declaring signal degrade on a facility or path.
1E-5	SDBER is 1E-5.
1E-6	SDBER is 1E-6.
1E-7	SDBER is 1E-7.
1E-8	SDBER is 1E-8.
1E-9	SDBER is 1E-9.
<SOAK>	(Optional) Locked-AutomaticInService to Unlocked transition soak time as measured in 15-minute intervals.
<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: When the port is in Locked, Locked_Maintenance or Unlocked state, the parameter will not appear. When the port is in Locked_AutomaticInService state but the countdown has not started due to fault signal, the value will be SOAKLEFT=NOT-STARTED. When the port is in Locked_AutomaticInService state and the countdown has started, the value will be shown in HH-MM format.
<NAME>	(Optional) Port name. NAME is a string.
<PSTPSTQ>	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
<SST>	(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

RTRV-E1

(Cisco ONS 15454 SDH) The Retrieve E1 (RTRV-E1) command retrieves the attributes of an E1 port facility.

Usage Guidelines

The ADMSSM, RETIME, SABIT, SYNCMSG, SENDDUS, and PROVIDESYNC parameters are only displayed on the DS1/E1-56 card.

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-E1:TID:FAC-1-1:1234;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::LINECDE=<LINECDE>,FMT=<FMT>,[TACC=<TACC>],[TAPTYPE=<TAPTYPE>], [SFBER=<SFBER>],[SDBER=<SDBER>],[SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>], [NAME=<NAME>],[SYNCMSG=<SYNCMSG>],[SENDDUS=<SENDDUS>], [RETIME=<RETIME>],[ADMSSM=<ADMSSM>],[PROVIDESYNC=<PROVIDESYNC>], [SABIT=<SABIT>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-1::LINECDE=HDB3,FMT=E1-MF,TACC=8,TAPTYPE=DUAL,SFBER=1E-4, SDBER=1E-6,SOAK=10,SOAKLEFT=12-25,NAME=\"E1PORT\",SYNCMSG=N, SENDDUS=N,RETIME=N,ADMSSM=STU,PROVIDESYNC=N, SABIT=BYTE-4:UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the FACILITY. The entity in the NE to which the command pertains.
<LINECDE>	Line code. Defaults to HDB3. The parameter type is LINE_CODE (line code).
AMI	Line code value is AMI.
B8ZS	Line code value is B8ZS (bipolar with eight-zero substitution).
HDB3	Line code is HDB3.
<FMT>	Digital signal frame format. Defaults to E1-MF. The parameter type is FRAME_FORMAT, which is the frame format for a E1 port.
D4	Frame format is D4.
E1-CRCMF	SDH E1 CRCMF frame format
E1-MF	SDH E1 MF frame
E1-UNFRAMED	SDH E1 unframed format
ESF	Frame format is ESF.
UNFRAMED	Frame format is unframed.
<TACC>	(Optional) TAP number within a range of 0 to 999. Indicates whether the digroup being provisioned is to be used as a test access digroup. When TACC is 0 (zero), the TAP is deleted. Default is N. TACC is an integer.
<TAPTYPE>	(Optional) TAP type. Defaults to DUAL. The parameter type is TAPTYPE, which is the test access point type.
DUAL	Dual FAD
SINGLE	Single FAD
<SFBER>	(Optional) Signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) Signal degrade threshold. 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. Defaults to 32. 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: 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 fault signal, the value will be SOAKLEFT=NOT-STARTED. When the port is in Locked_AutomaticInService state and the countdown has started, the value will be shown in HH-MM format.
<NAME>	(Optional) NAME is a string. Defaults to NULL. Maximum length is 32 characters.
<SYNCMSG>	(Optional) The facility is enabled to provide the synchronization clock. This applies to an MXPD-10G card only if the payload is SDH and the card termination mode is as follows: TRANSPARENT: All client ports are available for all timing selections. No trunk ports are available. LINE: All ports are available for all timing selections. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<SENDDUS>	(Optional) The facility sends out a Do Not Use for Synchronization Message. This does not apply to the TXPD-10G card. This applies to an MXPD-10G card only if the payload is SDH and the card termination mode is as follows: TRANSPARENT: All client ports are available for all timing selections. No trunk ports are available. LINE: All ports are available for all timing selections. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<RETIME>	(Optional) Indicates the RETIME function for all the facilities on this card. Applies only to the DS1/E1-56 card. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<ADMSSM>	(Optional) SSM selectable value. Only displayed when SSM is disabled. The parameter type is SYNC_CLOCK_REF_QUALITY_LEVEL, which is the clock source quality level for SDH.
DUS_SDH	Do Not Use For Synchronization
G811	G811 Standard
RES_SDH	Reserved For Network Synchronization Use
G812T	G812T Standard
STU_SDH	Synchronized, Traceability Unknown
G812TL	G812TL Standard
SETS	Synchronous Equipment Timing Source
<PROVIDESYNC>	(Optional) Indicates whether the facility provides synchronization. Defaults to N.
Y	Yes
N	No
<SABIT>	(Optional) When the frame format selection is E1, SABIT is the BIT used to receive and transmit the SSM. The parameter type is SABITS (SA BITS).
BYTE-4	SABIT is BYTE-4.
BYTE-5	SABIT is BYTE-5.
BYTE-6	SABIT is BYTE-6.
BYTE-7	SABIT is BYTE-7.
BYTE-8	SABIT is BYTE-8.
<PSTPSTQ>	Administrative state in the PST-PSTQ format. The parameter type is PSTPSTQ, 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-E3

(Cisco ONS 15454 SDH) The Retrieve E3 (RTRV-E3) command retrieves the attributes of an E3 port facility.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-E3:TID:FAC-1-1:1234;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<AID>::[TACC=<TACC>],[TAPTYPE=<TAPTYPE>],[SFBER=<SFBER>],[SDBER=<SDBER>], [SOAK=<SOAK>],[SOAKLEFT=<SOAKLEFT>],[NAME=<NAME>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-2::TACC=8,TAPTYPE=SINGLE,SFBER=1E-4,SDBER=1E-6,SOAK=10, SOAKLEFT=12-25,NAME=\"E3 PORT\":UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the FACILITY. The entity in the NE to which the command pertains.
<TACC>	(Optional) TAP number within a range of 0 to 999. Indicates whether the digroup being provisioned is to be used as a test access digroup. When TACC is 0 (zero), the TAP is deleted. Default is N. TACC is an integer.
<TAPTYPE>	(Optional) TAP type. Defaults to DUAL. The parameter type is TAPTYPE, which is the test access point type.
DUAL	Dual FAD
SINGLE	Single FAD
<SFBER>	(Optional) Signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) Signal degrade threshold. 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. Defaults to 32. 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: 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 fault signal, the value will be SOAKLEFT=NOT-STARTED. When the port is in Locked_AutomaticInService state and the countdown has started, the value will be shown in HH-MM format.
<NAME>	(Optional) Port Name. NAME is a string. Defaults to NULL. Maximum length is 32 characters.
<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-E4

(Cisco ONS 15454 SDH) The Retrieve E4 (RTRV-E4) command retrieves the attributes of an E4 port facility. RTRV-E4 only applies to Ports 9 and 12 of the STM1E card when in E4-FRAMED or E4-UNFRAMED mode.

Usage Guidelines

None

Category

Ports

Security

Retrieve

Input Format

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

Input Example

RTRV-E4:CISCO:FAC-6-9:8888;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

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

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-6-9::PAYLOAD=E4-UNFRAMED,SFBER=1E-4,SDBER=1E-6,SOAK=10, SOAKLEFT=12-25,NAME=\"E4 PORT\":Unlocked-Disabled,AutomaticInService" ;

Output Parameters

<AID>	Access identifier from the FACILITY. The entity in the NE to which the command pertains.
<PAYLOAD>	(Optional) The payload for the card. 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
DV6000	Video mode
E4-FRAMED	E4-FRAMED payload mode for SDH STM1E-12 card
E4-UNFRAMED	E4-UNFRAMED payload mode for SDH STM1E-12 card
ESCON	ESCON mode
ETRCLO	ETR/CLO payload mode
GIGE	Gigabit Ethernet payload
HDTV	HDTV mode
ISC1	ISC1 mode
ISC3	ISC3 mode
STM4	SDH STM4 mode
STM1	SDH STM1 mode
STM16	SDH STM16 mode
PASS-THROUGH	Pass through mode
SDH	SDH payload mode
SDI-D1-VIDEO	SDI-D1-Video mode
<SFBER>	(Optional) Signal failure threshold. Defaults to 1E-4. The parameter type is SF_BER, which is the threshold for declaring signal failure on a facility or path.
1E-3	SFBER is 1E-3.
1E-4	SFBER is 1E-4.
1E-5	SFBER is 1E-5.
<SDBER>	(Optional) Signal degrade threshold. 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. Defaults to 32. 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: 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 fault signal, the value will be NOT-STARTED. When the port is in Locked_AutomaticInService state and the countdown has started, the value will be shown in HH-MM format.
<NAME>	(Optional) Facility name. String. Defaults to NULL. Maximum length is 32 characters.
<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-EQPT

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Equipment (RTRV-EQPT) command retrieves the data parameters and state parameters associated with an equipment unit. The RTRV-EQPT command also retrieves shelf parameters.

Usage Guidelines

This command returns the PRTYPE, PROTID, RVTM, and RVRTV parameters for a card inside of 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 (Unlocked/Locked) values.
Preprovisioned cards (without being plugged in) will display Locked,AutomaticInService for PST and SST. After the card is plugged in and has gone through its initialization sequence, the card automatically goes to Unlocked (PST).
CARDMODE parameter is displayed for ML-Series and FC_MR-4 cards.

The following action will return an error message:

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:E1-42,EQUIP,,ACT:PROTID=SLOT-13,PRTYPE=1-1,RVRTV=Y,RVTM=8.5, CARDNAME=DESCRIPTION,IOSCFG="IOS CONFIG INFO FOR ML SERIES CARD", CARDMODE=DWDM-LINE,PEERID=SLOT-1,REGENNAME="THIS GROUP", TRANSMODE=SDH,RETIME=Y,SHELFROLE=NC:UNLOCKED-DISABLED, AUTOMATICINSERVICE&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) Modena mapper card
CE-100T-8	(ONS 15454, ONS 15310-CL, ONS 15310-MA) Exige/Elise mapper card
CE-MR-10	(ONS 15454, ONS 15454 SDH) Lotus20g ce2 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. SDH card status is shown on its card level. 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 on the shelf.
<CARDNAME>	(Optional) Contains the manufacturing name of the card when it is different from the EQUIPMENT_TYPE.
<CARDMODE>	(Optional) Card mode. The parameter type is CARDMODE (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.
DS1E1-DS1ONLY	DS1 mode on DS1/E1 card
DS1E1-E1ONLY	E1 mode on DS1/E1 card
DWDM-LINE	Line terminating mode
DWDM-SECTION	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 FPGA using GFP framing type
ML-HDLC	ML-Series card in DOS FPGA using HDLC framing type
ML-IEEE-RPR	ML-Series card in DOS FPGA which supports Resilient Packet Ring (RPR).
MXPMR10DME-4GFC	4-Gbps Fibre Channel/FICON mode for the Cisco ONS 15454 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 1 and 5
MXPMR10DME-4GFC-FCGEISC	4-Gbps Fibre Channel/FICON supported on port one and Fibre Channel, GIGE and ISC modes for the Cisco ONS 15454 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 5 to 8
MXPMR10DME-FCGEISC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 SDH 1MXP_MR_10DME_C or MXP_MR_10DME_L card supported on all eight ports
MXPMR10DME-FCGEISC-4GFC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card 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 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card supported on all eight ports
MXPMR10G-4GFC	4-Gbps Fibre Channel/FICON mode for the Cisco ONS 15454 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 1 and 5
MXPMR10G-FCGEISC-4GFC	Fibre Channel, GIGE, and ISC modes for the Cisco ONS 15454 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card 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 SDH MXP_MR_10DME_C or MXP_MR_10DME_L card supported on Ports 5 to 8
MXPMR25G-ESCON	ESCON mode for the Cisco ONS 15454 SDH 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 SDH MXP_2.5G_10G card
<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>	Secondary state of the entity. SSTQ is listable. 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-ESCON

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

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

Category

DWDM

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) 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>	(Optional) 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.
<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 SDH) 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. RTRV-POS will display the MTU, which is common for front and backend ports.

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

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

Category

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::ADMINSTATE=DOWN,LINKSTATE=DOWN,FLOWCTRL=SYMMETRIC, DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,EXPDUPLEX=EXPDUPLEX, EXPSPEED=EXPSPEED,VLANCOS=VLANCOS,IPTOS=IPTOS,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>	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 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 SDH and ONS 15600 SDH) 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 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>	(Optional) Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type.
AIRCOND	Air conditioning
ENGINE	Engine
FAN	Fan
GEN	Generator
HEAT	Heat
LIGHT	Light
MISC	Miscellaneous
SPKLR	Sprinkler

Output Format

SID DATE TIME M CTAG COMPLD "<AID>:[<CONTTYPE>],<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
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 (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.
OPER	The environmental control state is CLOSE.
RLS	The environmental control state is OPEN.

RTRV-FAC

(Cisco ONS 15454 SDH and ONS 15600 SDH) 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>:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-2-9::PAYLOAD=E4-FRAMED:UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

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
DV6000	Video mode
E4-FRAMED	E4-FRAMED payload mode for SDH STM1E-12 card
E4-UNFRAMED	E4-UNFRAMED payload mode for SDH STM1E-12 card
ESCON	ESCON mode
ETRCLO	ETR/CLO payload mode
GIGE	Gigabit Ethernet Payload
HDTV	HDTV mode
ISC1	ISC1 mode
ISC3	ISC3 mode
STM4	SDH STM4 mode
STM1	SDH STM1 mode
STM16	SDH STM16 mode
PASS-THROUGH	Pass through mode
SDH	SDH Payload mode
SDI-D1-VIDEO	SDI-D1-Video mode
<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. SSTQ is a string.

RTRV-FFP

(Cisco ONS 15454 SDH and ONS 15600 SDH) 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:STM16: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.
<LEVEL>	Optical rate the protection group was defined against. The parameter type is STM_TYPE, which is the modifier used to differentiate various levels of STM.
STM4	Optical Carrier Level 12 (622 Mbps)
STM64	Optical Carrier Level 192 (10 Gbps)
STM1	Optical Carrier Level 3 (155 Mbps)
STM16	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 (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 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 SDH) The Retrieve Facility Protection Group for 10GFC, 10GIGE, 1GFC, 1GFICON, 2GFC, 2GFICON, D1VIDEO, DV6000, ETRCLO, GIGE, HDTV, ISC1, ISC3, or PASSTHRU (RTRV-FFP-<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 (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-<STM_TYPE>

(Cisco ONS 15454 SDH) The Retrieve Facility Protection Group for STM1, STM4, STM16, and STM64 (RTRV-FFP-<STM_TYPE>) command retrieves the optical facility protection information. See Table 27-1 for supported modifiers by platform.

Usage Guidelines

None

Category

Protection

Security

Retrieve

Input Format

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

Input Example

RTRV-FFP-STM1:PETALUMA:FAC-1-1:1;

Input Parameters

<AID>

Access identifier from the FACILITY.

Output Format

SID DATE TIME M CTAG COMPLD "<WORK>,<PROTECT>::[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::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.
<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. 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 (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 SDH) The Retrieve Facility Protection Group Optical Channel (RTRV-FFP-OCH) command retrieves the protection group information for the TXP_MR_2.5G and the TXPP_MR_2.5G card trunk ports.

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 (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 SDH) The Retrieve Fast Ethernet (RTRV-FSTE) command retrieves the front end port information of the 10/100 Mbps Fast Ethernet card.

Usage Guidelines

This command retrieves the front-end port information of fast (10/100 Mbps) ethernet cards. MTU is not displayed for Elise and Exige. RTRV-POS will display the MTU, which is common for front and backend ports.

SELECTIVEAUTO parameter is applicable only when EXPSPEED and EXPDUPLEX is 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>],[SUPPRESS=<SUPPRESS>],[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::ADMINSTATE=DOWN,LINKSTATE=DOWN,MTU=1500,FLOWCTRL=SYMMETRIC, DUPLEX=AUTO,SPEED=AUTO,FLOW=FLOW,EXPDUPLEX=EXPDUPLEX, EXPSPEED=EXPSPEED,VLANCOS=VLANCOS,IPTOS=IPTOS,OPTICS=1000-BASE-LX, NAME=\"FSTE PORT\", SOAK=32,SOAKLEFT=\"12-25\",, SELECTIVEAUTO=N, 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.
<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 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 SDH and ONS 15600 SDH) 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).
OFF	Disable an attribute.
ON	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).
OFF	Disable an attribute.
ON	Enable an attribute.
<TIMER>	Specifies the timeout value of the FTP Server in minutes.

RTRV-G1000

(Cisco ONS 15454 SDH) 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>], [LIENABLE=<LIENABLE],[LITIMER=<LITIMER>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "FAC-1-1::MFS=1548,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\", LIENABLE=Y, LITIMER=300:UNLOCKED-DISABLED, AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the FACILITY.
<MFS>	(Optional) 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>	(Optional) 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) Gigabit Interface Converter (GBIC) type. 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
<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. String.
<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 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. 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-GFP

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Generic Framing Protocol (RTRV-GFP) command retrieves the attributes of GFP encapsulation and applies to the FC_MR-4, CE-1000-4, and CE-100T-8 cards.

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: The FAC AID is used for the FC_MR-4 card.

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) The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<GFPBUF>	(Optional) GFP buffer size. GFPBUF is an integer.
<FILTER>	The parameter type is GFP_FILTER, which provides filter feature in GFP.
EGRESS	Active filter feature egress port
NONE	Turn off filter feature

RTRV-GIGE

(Cisco ONS 15454 SDH and ONS 15600 SDH) 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=`"GIGE PORT\",FREQ=1550,LOSSB=SX,SOAK=32, SOAKLEFT=\"12-22\"LIENABLE=Y, LITIMER=300:UNLOCKED,AUTOMATICINSERVICE" ;

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	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, 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) 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.73	Wavelength 1530.73
1531.12	Wavelength 1531.12
1531.51	Wavelength 1531.51
1531.90	Wavelength 1531.90
1532.29	Wavelength 1532.29
1532.68	Wavelength 1532.68
1533.07	Wavelength 1533.07
1533.47	Wavelength 1533.47
1533.86	Wavelength 1533.86
1534.25	Wavelength 1534.25
1534.64	Wavelength 1534.64
1535.04	Wavelength 1535.04
1535.43	Wavelength 1535.43
1535.82	Wavelength 1535.82
1536.22	Wavelength 1536.22
1536.61	Wavelength 1536.61
1537	Wavelength 1537
1537.40	Wavelength 1537.40
1537.79	Wavelength 1537.79
1538.19	Wavelength 1538.19
1538.58	Wavelength 1538.58
1538.98	Wavelength 1538.98
1539.37	Wavelength 1539.37
1539.77	Wavelength 1539.77
1540.16	Wavelength 1540.16
1540.56	Wavelength 1540.56
1540.95	Wavelength 1540.95
1541.35	Wavelength 1541.35
1541.75	Wavelength 1541.75
1542.14	Wavelength 1542.14
1542.35	Wavelength 1542.35
1542.54	Wavelength 1542.54
1542.94	Wavelength 1542.94
1543.33	Wavelength 1543.33
1543.73	Wavelength 1543.73
1544.13	Wavelength 1544.13
1544.53	Wavelength 1544.53
1544.92	Wavelength 1544.92
1545.32	Wavelength 1545.32
1545.72	Wavelength 1545.72
1546.12	Wavelength 1546.12
1546.52	Wavelength 1546.52
1546.92	Wavelength 1546.92
1547.32	Wavelength 1547.32
1547.72	Wavelength 1547.72
1548.12	Wavelength 1548.12
1548.51	Wavelength 1548.51
1548.92	Wavelength 1548.92
1549.32	Wavelength 1549.32
1549.71	Wavelength 1549.71
1550	Wavelength 1500
1550.12	Wavelength 1550.12
1550.52	Wavelength 1550.52
1550.92	Wavelength 1550.92
1551.32	Wavelength 1551.32
1551.72	Wavelength 1551.72
1552.12	Wavelength 1552.12
1552.52	Wavelength 1552.52
1552.93	Wavelength 1552.93
1553.33	Wavelength 1553.33
1553.73	Wavelength 1553.73
1554.13	Wavelength 1554.13
1554.13	Wavelength 1554.13
1554.94	Wavelength 1554.94
1555.34	Wavelength 1555.34
1555.75	Wavelength 1555.75
1556.15	Wavelength 1556.15
1556.55	Wavelength 1556.55
1556.96	Wavelength 1556.96
1557.36	Wavelength 1557.36
1557.77	Wavelength 1557.77
1558.17	Wavelength 1558.17
1558.58	Wavelength 1558.58
1558.98	Wavelength 1558.98
1559.39	Wavelength 1559.39
1559.79	Wavelength 1559.79
1560.20	Wavelength 1560.20
1560.61	Wavelength 1560.61
1561.01	Wavelength 1561.01
1561.42	Wavelength 1561.42
1561.83	Wavelength 1561.83
1570	Wavelength 1570
1570.83	Wavelength 1570.83
1571.24	Wavelength 1571.24
1571.65	Wavelength 1571.65
1572.06	Wavelength 1572.06
1572.48	Wavelength 1572.48
1572.89	Wavelength 1572.89
1573.30	Wavelength 1573.30
1573.71	Wavelength 1573.71
1574.13	Wavelength 1574.13
1574.54	Wavelength 1574.54
1574.95	Wavelength 1574.95
1575.37	Wavelength 1575.37
1575.78	Wavelength 1575.78
1576.20	Wavelength 1576.20
1576.61	Wavelength 1576.61
1577.03	Wavelength 1577.03
1577.44	Wavelength 1577.44
1577.86	Wavelength 1577.86
1578.27	Wavelength 1578.27
1578.69	Wavelength 1578.69
1579.10	Wavelength 1579.10
1579.52	Wavelength 1579.52
1579.93	Wavelength 1579.93
1580.35	Wavelength 1580.35
1580.77	Wavelength 1580.77
1581.18	Wavelength 1581.18
1581.60	Wavelength 1581.60
1582.02	Wavelength 1582.02
1582.44	Wavelength 1582.44
1582.85	Wavelength 1582.85
1583.27	Wavelength 1583.27
1583.69	Wavelength 1583.69
1584.11	Wavelength 1584.11
1584.53	Wavelength 1584.53
1584.95	Wavelength 1584.95
1585.36	Wavelength 1585.36
1585.78	Wavelength 1585.78
1586.20	Wavelength 1586.20
1586.62	Wavelength 1586.62
1587.04	Wavelength 1587.04
1587.46	Wavelength 1587.46
1587.88	Wavelength 1587.88
1588.30	Wavelength 1588.30
1588.73	Wavelength 1588.73
1589.15	Wavelength 1589.15
1589.57	Wavelength 1589.57
1589.99	Wavelength 1589.99
1590	Wavelength 1590
1590.41	Wavelength 1590.41
1590.83	Wavelength 1590.83
1591.26	Wavelength 1591.26
1591.68	Wavelength 1591.68
1592.10	Wavelength 1592.10
1592.52	Wavelength 1592.52
1592.95	Wavelength 1592.95
1593.37	Wavelength 1593.37
1593.79	Wavelength 1593.79
1594.22	Wavelength 1594.22
1594.64	Wavelength 1594.64
1595.06	Wavelength 1595.06
1595.49	Wavelength 1595.49
1596.34	Wavelength 1596.34
1596.76	Wavelength 1596.76
1597.19	Wavelength 1597.19
1597.62	Wavelength 1597.62
1598.04	Wavelength 1598.04
1598.47	Wavelength 1598.47
1598.89	Wavelength 1598.89
1599.32	Wavelength 1599.32
1599.75	Wavelength 1599.75
1600.06	Wavelength 1600.06
1601.03	Wavelength 1601.03
1601.46	Wavelength 1601.46
1601.88	Wavelength 1601.88
1602.31	Wavelength 1602.31
1602.74	Wavelength 1602.74
1603.17	Wavelength 1603.17
1603.60	Wavelength 1603.60
1604.03	Wavelength 1604.03
1610	Wavelength 1610
USE-TWL1	Use Tunable Wavelength 1
<LOSSB>	(Optional) The parameter type is REACH, which is the reach value.
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) 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.
<PST>	Primary state. The parameter type is PST, which is the current overall service condition of an entity.
Unlocked	In service
Locked	Out of service
<SST>	Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

RTRV-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 SDH and ONS 15600 SDH) 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.

Category

System

Security

Retrieve

Input Format

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

Input Example

RTRV-HDR:SONOMA::232;

Input Parameters

None

RTRV-INV

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Inventory (RTRV-INV) command retrieves a listing of the equipment inventory. For each unit in the system, it identifies the unit's firmware numbers and Common Language Equipment Identifier (CLEI) codes, and the system's product ID and version ID.

Usage Guidelines

For multishelf, the inventory parameters are retrieved by using RTRV-INV and the BP AID. Because there is more that one shelf, the SHELFID is specified in BP AID.

Category

System

Security

Retrieve

Input Format

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

Input Examples

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

Input Parameters

<AID>

Access identifier from the EQPT or the 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) Plug-in vendor ID. PLUGINVENDORID is an 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. PLUGINSN 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 (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 plug-in module. MODULETYPE is a 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 SDH) 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>],[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":Unlocked-disabled,AINS" ;

Output Parameters

<AID>	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	Disables MAC learning
<INGRESSCOS>	Identifies the CoS value set in the service provider (S-VLAN) tag.
<ETHERCETYPE>	Identifies a customer specific Ethernet type. If the customer uses a nonstandard 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 nonstandard 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 CE-VLAN IDs and S-VLAN IDs.
<NAME>	(Optional) Facility name. NAME is a string.
<CMDMDE>	(Optional) Command mode. 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 Unlocked-Enabled or Locked-Disabled, AutomaticInService 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 SDH and ONS 15600 SDH) 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 an 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 SDH and ONS 15600 SDH) 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:00 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 LOCALPORT to send messages.
<LOCALPORT>	LOCALPORT is 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 in 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 such 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 SDH and ONS 15600 SDH) 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 that support the LMP protocol, and where the LMP protocol 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 SDH and ONS 15600 SDH) The Retrieve Link Management Protocol Data Link (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 SDH) 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

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 result in an add/drop connection from a drop point to an add point
HITLESS	Link between two OMS points that result 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 (optical band).
1530.33-1532.68	Band 1
1534.25-1536.61	Band 2
1538.19-1540.56	Band 3
1542.14-1544.53	Band 4
1546.12-1548.51	Band 5
1550.12-1552.52	Band 6
1554.13-1556.55	Band 7
1558.17-1560.61	Band 8
USE-DEFAULT	This band is not yet configured/retrieved from 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, 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
<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
<SST>	(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-LNKTERM

(Cisco ONS 15454 SDH) 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 an integer.

RTRV-LOG

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Log (RTRV-LOG) command retrieves the alarm log of the NE.

Usage Guidelines

The only option for LOGNM is ALARM.

Category

Log

Security

Superuser

Input Format

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

Input Example

RTRV-LOG:CISCO::123::ALARM;

Input Parameters

<LOGNM>

Log to be retrieved. The value must be ALARM. LOGNM is a 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:\"RS-DCC 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 SDH or ONS 15600 SDH 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 Table 26-1 for a list of conditions.
<OCRTIME>	(Optional) Time when the specific event or violation occurred, HH-MM-SS.
<OCRDATE>	(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 SDH and ONS 15600 SDH) The Retrieve Map Network (RTRV-MAP-NETWORK) command retrieves all the NE attributes that are accessible from the gateway NE (GNE). The NE attributes include the node IP address (IPADDR), the 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

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,ONS15454SDH" ;

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.
ONS15454	ONS 15454
ONS15454SDH	ONS 15454 SDH
ONS15600	ONS 15600
ONS15600SDH	ONS 15600 SDH
UNKNOWN	Unknown product type

RTRV-NE-APC

(Cisco ONS 15454 SDH) The Retrieve Network Amplification Power Control (RTRV-NE-APC) command retrieves the APC application ports involved in node setup 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, 4MD-xx.x, 32MUX, 32DMX, AD-1C-xx.x, AD-2C-xx.x, AD-4C-xx.x, AD-1B-xx.x, and AD-4B-xx.x 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 SDH and ONS 15600 SDH) 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 node 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

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. IIPOOPRT is an integer.
<NTP>	(Optional) Node Network Timing Protocol (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) The 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 SDH and ONS 15600 SDH) The Retrieve Network Element Internet Protocol Map (RTRV-NE-IPMAP) command retrieves the IP address and node name of the NEs that have the DCC connection with this NE.

Usage Guidelines

This command only reports the active DCC link. If there is no active 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 SDH) 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

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>	Flag used to indicate whether PDI-P should be generated on the outgoing VT-structured VCs. The parameter type is ON_OFF (disable or enable an attribute).
N	Disable an attribute.
Y	Enable an attribute.
<XCMODE>	Cross-connect mode. The parameter type is XCMODE, which is applicable only to a node with cross-connect cards (for example, XC-VXC-10G) that support cross-connect mode change.
MIXED	Both VC11 and VC12 cross-connects can be provisioned on the node.
VC11	Only VC11 cross-connects can be provisioned on the node.
VC12	Only VC12 cross-connects can be provisioned on the node.

RTRV-NE-SYNCN

(Cisco ONS 15454 SDH and ONS 15600 SDH) The Retrieve Network Element Synchronization (RTRV-NE-SYNCN) command retrieves the synchronization attributes of the NE.

Usage Guidelines

Although mixed mode timing is supported, it is not recommended. Refer to the Cisco ONS SDH and Cisco ONS 15600 SDH 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 SDH line(s).
Mixed mode: The node derives its timing from the BITS input or SDH lines.

Category

Synchronization

Security

Retrieve

Input Format

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

Input Examples

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 Examples

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

Output Parameters

<AID>	(Optional) The node or shelf access identifier from the SHELF. If omitted, it addresses the node or first shelf of the node.
<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 SDH 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-PRS	Better than Primary Reference Source. Valid setting for Generation-1 and Generation-2 SSM Set.
ABOVE-ST2	Between ST2 and STU . Valid setting for Generation-1 and Generation-2 SSM Set.
ABOVE-ST3	For Generation-1 SSM set, between ST3 and ST2. For Generation-2 SSM set, between ST3 and ST3E.
ABOVE-ST3E	Between ST3E and TNC. Valid setting only for Generation-2 SSM set.
ABOVE-ST4	Between ST4 and ST3. Valid setting for Generation-1 and Generation-2 SSM Set.
ABOVE-STU	Between STU and PRS. Valid setting for Generation-1 and Generation-2 SSM Set. This is Default Setting.
ABOVE-TNC	Between TNC and ST2. Valid setting only for Generation-2 SSM set.
BELOW-ST4	Below ST4 but still usable. Valid setting for Generation-1 and Generation-2 SSM Set.
SAME-AS-DUS	Disable the RES message by equating it to DUS. Valid setting for Generation-1 and Generation-2 SSM Set.
<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 (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 SDH) 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>]::<CTAG>;

Input Example

RTRV-NE-WDMANS:PENNGROVE::114;

Input Parameters

None

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=AMPLMODE" ;

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
DS3I	DS3i-N-12 line
DV6000	DV6000
E1	E1
E3	E3
E4	E4 frame. Only applicable to STM1E Port 9 through 12 when it is in E4-FRAMED or E4-UNFRAMED mode.
ESCON	ESCON
ETRCLO	ETRCLO
FSTE	FSTE facility
G1000	G1000 facility
GFPOS	GFP over POS. Virtual ports partitioned using GFP's multiplexing capability.
GIGE	Gigabit Ethernet
HDTV	HDTV
ISC3PEER1G	1-Gbps ISC3 Peer
ISC3PEER2G	2-Gbps ISC3 Peer
ISC3PEER2R	1-Gbps or 2-Gbps ISC3 peer used in transparent (2R) mode
ISCCOMPAT	1-Gbps ISC1, ISC2, and ISC3 compatibility
OCH	Optical Channel
OCHCC	OCH client connection
OCHNC	OCH network connection
OCHTERM	OCH termination
OMS	Optical Multiplex Section
OTS	Optical Transport Section
POS	POS port
STM1	STM1 facility
STM1E	STM1E facility. Only applicable to the STM1E facility (when it is in STM1E mode) of the SDH STM1E-12 card.
STM4	STM4 facility
STM16	STM16 facility
STM64	STM64 facility
VC3	VC3 path
VC44C	VC4-4C path
VC38C	VC3-8C path
VC464C	VC4-64C path
VC48C	VC4-8C path
VC4	VC4 path
VC416C	VC4-16C path
VC42C	VC4-2C path
VC43C	VC4-3C path
VC11	VC11 path
VC12	VC12 path
<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 setpoint because the calculated value is out of the allowed range.
PORT-IN-SERVICE	WDM-ANS cannot modify the setpoint because the ports are in Unlocked 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 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 VOA attenuation reference parameter.
VOAREFPWR	WDM-ANS has regulated the VOA power reference parameter.

RTRV-NETYPE

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

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>	The NE equipment vendor name. VENDOR is a string.
<MODEL>	The NE equipment model name. The parameter type is PRODUCT_TYPE, which is the product (NE) type.
ONS15310CL	ONS 15310-CL
ONS15310MA	ONS 15310-MA
ONS15454	ONS 15454
ONS15454SDH	ONS 15454 SDH
ONS15455	ONS 15454 SDH
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 SDH) 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:PETALUMA: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>:<SVLANID>[::]" ;

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 SDH) 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 SDH and Cisco ONS 15600 SDH TL1 Reference Guide for specific card provisioning rules.
Primary=Locked and secondary=AutomaticInService 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.
<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
<SST>	(Optional) Secondary state. The parameter type is SST, which provides additional information pertaining to PST and PSTQ.
AutomaticInService	Automatic in service
Disabled	Disabled
Loopback	Loopback
MismatchofEquipmentAlarm	Mismatch of equipment and attributes
Maintenance	Maintenance mode
OutOfGroup	Out of group
SoftwareDownload	Software downloading
Unassigned	Unassigned
NotInstalled	Unequipped

RTRV-OCHCC

(Cisco ONS 15454 SDH) 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=STM64,CTKID=\"OCHCC\":UNLOCKED-ENABLED" ;

Output Parameters

<AID>	Access identifier from the CHANNEL.
<PAYLOAD>	(Optional) 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. The 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-Gigabit 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
STM4	STM4 payload
STM64	STM64 payload
STM1	STM1 payload
STM16	STM16 payload
T3	DS3 payload
<CKTID>	(Optional) 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 SDH) 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\":UNLOCKED-ENABLED" ;

Output Parameters

<SRC>	Source access identifier from the CHANNEL. In two-way wavelength connection sources, both directions need to be indicated.
<DST>	Destination access identifier from the LINEWL. In two-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>	(Optional) 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 SDH) 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>]:<PSTPSTQ>,[<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=1530.33-1532.68, ACTBAND=1530.33-1532.68,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\":UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

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 OSC) that continue the signal from the previous card
IN-DC	Input DCU port
IN-EXP	The 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 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 band for this port. The parameter type is OPTICAL_BAND (optical band).
1530.33-1532.68	Band 1
1534.25-1536.61	Band 2
1538.19-1540.56	Band 3
1542.14-1544.53	Band 4
1546.12-1548.51	Band 5
1550.12-1552.52	Band 6
1554.13-1556.55	Band 7
1558.17-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-1532.68	Band 1
1534.25-1536.61	Band 2
1538.19-1540.56	Band 3
1542.14-1544.53	Band 4
1546.12-1548.51	Band 5
1550.12-1552.52	Band 6
1554.13-1556.55	Band 7
1558.17-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 (revertive time).
0.5 to 12.0	Revertive time is 0.5 to 12.0 minutes.
<NAME>	(Optional) Facility name. NAME is a string.
<PSTPSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state of the entity. 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-OPM

(Cisco ONS 15454 SDH) The Retrieve Optical Monitoring Parameter (RTRV-OPM) command retrieves the optical power monitoring parameters present at the OCH layer in a reconfigurable OADM (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 the 32WSS card. POWEROUT is a float.
<POWERADD>	(Optional) The value of the input power associated to the add channel port of 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 32WSS card. POWERPT is mutually exclusive with the POWERADD parameter. POWERRPT is a float.

RTRV-OTS

(Cisco ONS 15454 SDH) 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>]:<PSTPSTQ>,[<SSTQ>]" ;

Output Example

TID-000 1998-06-20 14:30:00 M 001 COMPLD "LINE-6-1-RX:RDIRN=W-E,OPTYPE=ADD,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\":UNLOCKED-DISABLED,AUTOMATICINSERVICE" ;

Output Parameters

<AID>	Access identifier from the LINE.
<RDIRN>	Ring direction of the optical line. The parameter type is RDIRN_MODE, which is the optical ring direction.
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	The 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 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 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 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 a preamplifier and 20 dB for a 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>	(Optional) The status assumed by arrayed waveguide grating (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) Port name. NAME is a string.
<PSTPSTQ>	Primary state of the entity. The parameter type is PST_PSTQ, which is the service state of the entity described by the PST and PSTQ.
Unlocked-Enabled	In service and normal
Unlocked-Disabled	Out of service and autonomous
Locked-Disabled	Out of service, autonomous and management
Locked-Enabled	Out of service and management
<SSTQ>	(Optional) Secondary state of the entity. 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-PATH-OCH

(Cisco ONS 15454 SDH) The Retrieve Path Optical Channel (RTRV-PATH-OCH) command retrieves the OCH path inside a node. An OCH path is a list of AIDs that addresses all the possible facility and internal OCHs that are 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],[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>	(Optional) Defines the optical wavelength value.
1530.33	Wavelength 1530.33
1530.72	Wavelength 1530.72
1531.12	Wavelength 1531.12
1531.90	Wavelength 1531.90
1532.68	Wavelength 1532.68
1534.25	Wavelength 1534.25
1535.04	Wavelength 1535.04
1535.82	Wavelength 1535.82
1536.61	Wavelength 1536.61
1538.19	Wavelength 1538.19
1538.98	Wavelength 1538.98
1539.77	Wavelength 1539.77
1540.56	Wavelength 1540.56
1542.14	Wavelength 1542.14
1542.94	Wavelength 1542.94
1543.73	Wavelength 1543.73
1544.53	Wavelength 1544.53
1546.12	Wavelength 1546.12
1546.92	Wavelength 1546.92
1547.72	Wavelength 1547.72
1548.11	Wavelength 1548.11
1548.51	Wavelength 1548.51
1548.91	Wavelength 1548.91
1549.72	Wavelength 1549.72
1550.12	Wavelength 1550.12
1550.92	Wavelength 1550.92
1551.72	Wavelength 1551.72
1552.52	Wavelength 1552.52
1554.13	Wavelength 1554.13
1554.94	Wavelength 1554.94
1555.75	Wavelength 1555.75
1556.55	Wavelength 1556.55
1558.17	Wavelength 1558.17
1558.98	Wavelength 1558.98
1559.79	Wavelength 1559.79
1560.61	Wavelength 1560.61
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.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
<PATH>	(Optional) Access OCH layer of optical network/client cards from the CHANNEL.

RTRV Commands (P through W)

Currently 0.00/5
1
2
3
4
5

Rating: 0.0/5 (0 votes cast)

ONS SDH TL1 Command Guide R8.5.1 -- RTRV Commands (D through O)

From DocWiki

Contents

RTRV-DFLT-SECU

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-DS3I

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-E1

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-E3

Usage Guidelines

Category

Security

Input Format

Input Example

Input Parameters

Output Format

Output Example

Output Parameters

RTRV-E4

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