Chapter 5, Command Line Reference

Command Line Reference

This chapter describes the ONS 15216 EDFA1 software command set and includes information about each command's syntax, function, and password protection status.

Note To obtain the syntax for any command, enter the command followed by a space and the question mark character (?). To obtain a complete list of all commands, type the HELP command.

ONS 15216 EDFA1 Operation

There are two types of ONS 15216 EDFA1 operations: special and normal.

Special ONS 15216 EDFA1 operations are described in Table 5-1.

Commands for operating the ONS 15216 EDFA1 under normal conditions are discussed in detail beginning in the "User Commands" section. Under normal operation, the unit behaves according to the specifications outlined in "Applications."

Table 5-1 Special Operations
Special Operation	Duration	Alarm Impact	Control Loop Impact
Download	2 minutes	All alarm checking, except loss of input power, is stopped. If the loss of signal alarm is set, it cannot be cleared until after the download. Alarm states are retained.	None
Cutover	12 seconds	All alarm checking, except loss of input power, is stopped. If the loss of signal alarm is set, it cannot be cleared until after the download. Alarm states are retained.	Loop control suspended while software restarts.
Software Reset	12 seconds	All alarm checking, except loss of input power, is stopped. Alarm states are retained.	Loop control suspended while software restarts.
Power Reset	12 seconds	Alarms set to voltage LOW (VLO) within 1 second after power is applied and 5V supply stable.	Loop control not yet initialized.

Note With the exception of a power reset, Special Operations commands will not interrupt service.

User Commands

Each command in this chapter is described in the following format:


Command:	Command Name
Syntax:	Help information associated with a given command is displayed by issuing COMMAND ?
Password:	Password protection status
Configuration:	Command affects configuration data; the data must be saved using the CONFIG command to retain it through a reset, power down, or cutover operation
Brief Description:	Simple description of command
Explanation:	Demonstration, relevant parameters, parsing rules, and warnings

If you need additional information about a specific command or its syntax, enter the command followed by a question mark (?).

The following example displays the HELP command screen . See the "HELP" section for more specific information.

Example 5-1 HELP Command:

0-0>HELP

System Status     System Commands   Setup Commands    Maintenance

------------------------------------------------------------------------

   ALARM            ALMDSBL          SET_LOSTH        CUTOVER

   HELP             ALMENBL          SETGT            LOAD

   LD               CONFIG           SETI             SETADDR

   PRM              LOGOUT           SETOUT           SRESET

   STAT             PASS             SETP

VER

------------------------------------------------------------------------

Enter 'Command ?' for syntax

0-0>

Measurement Parameters

The format for measurement parameters is as follows:

% [width].[precision]type,

Additional parameters include:

•Width-total field width

•Precision-number of decimals

•Type- float (f) or signed decimals (d)

Additional information regarding measurement parameters can be found in the "PRM" section.

Login Session

@XY


Command:	@XY
Syntax:	None given
Password:	N/A
Configuration:	N/A
Brief Description:	Login to unit with address XY

Explanation:

To begin a command session, you need to log in to the ONS 15216 EDFA1 . Typing the '@' character while logged into a unit immediately terminates the command session. Table 5-2 displays the ONS 15216 EDFA1 address parameters.

Example 5-2 @XY Command:

@xy

x-y>

Table 5-2 EDFA Address Parameters
Parameter	Format	Description
x	0-9	First half of EDFA address
y	0-9	Second half of EDFA address

Note The Default Address for the ONS 15216 EDFA1 is 00.

To begin a session, enter @xy followed by a carriage return (where xy is the address of the module). The address of the ONS 15216 EDFA1 is a two-digit number from 00 to 99. In this document, the default address 00 is used for the ONS 15216 EDFA1.

The ONS 15216 EDFA1 ends every command by returning the following prompt: a-b> (where ab is the address of the ONS 15216 EDFA1). The prompt does not appear with the following commands:

•CONFIG

•SRESET

•STAT

•CUTOVER

•LOAD

The LOGOUT command should always be used to terminate a session.

Password Protection

Password protection is applied to commands that can change the mode of the ONS 15216 EDFA1 operation. You are required to enter the password at login to gain access to these commands.

CISCO is the default password. See the "PASS" section for information about changing passwords

Error Handling

Unaccepted commands result in an error message. Table 5-3 lists and describes error messages.

Example 5-3 Error Message:

0-0>COMMAND

Error message

0-0>

Table 5-3 Error Messages
Error Message	Description
No such command	Command does not exist
Syntax:xxxxx	The syntax for the given command is wrong; generally this error message appears if a command argument is invalid or out of range
Ser in full	Serial input fifo is full, caused by overflowing the command input
Cmd fifo empty	Command fifo is empty, caused by serial errors
Cmd trunc 1	Command line is truncated, caused by serial errors
Cmd trunc 2	Command line is truncated, caused by serial errors
Cmd trunc 3	Command line is truncated, caused by serial errors
Cmd too long	Command name is too long
NO termin space	No terminating white space is found, caused by serial errors
Cmd line too long	Command line is too long

System Status Commands

This section describes system status commands.


Command:	ALARM
Syntax:	ALARM D\|C
Password:	N/A
Configuration:	N/A
Brief Description:	Displays alarm status or clears alarm counts

ALARM

Explanation:

Table 5-4 lists the alarms tracked by the ONS 15216 EDFA1.

Table 5-4 Alarms Tracked by the ONS 15216 EDFA1
Name	Description	Threshold
LCRNT	Excessive pump current	Drive current is greater than 95% of end-of-life value. Current must drop to 90% of end-of-life value for alarm to clear.
LTMP	Laser chip temp out-of-range	Chip temperature is deviating more than 10�C from setpoint.
LPOUT	Loss of output power	EDFA output power is deviating more than 2 dB from the setpoint. Tracking of this alarm is disabled when the EDFA is operating in constant gain mode.
LPIN	Loss of input power	EDFA input power is below the loss of input threshold. Input power must rise greater than 1 dB over the loss of input threshold for alarm to clear.
GAIN	Gain out-of-range	Gain has deviated more than 2 dB from the setpoint. Tracking of this alarm is disabled when the EDFA is not operating in constant gain mode.
CTMP	Case temperature out-of-range	Case temperature is less than -5�C or greater than 65�C.

To display the current status of alarms, type the ALARM D command.

Example 5-4 ALARM D command:

0-0>ALARM D

                 Pump 1       Pump 2

Name  Type     Crnt  Cnt    Crnt  Cnt   Descr

LCRNT Minor    xxxxx yyy    xxxxx yyy   Excessive pump crnt/pump bias

LTMP  Minor    xxxxx yyy    xxxxx yyy   LD temp out-of-range

                 EDFA 1

Name  Type     Crnt  Cnt   Descr

LPOUT Major    xxxxx yyy   Loss outp pwr

LPIN  Major    xxxxx yyy   Loss inp pwr

GAIN  Major    xxxxx yyy   Gain out-of-range

CTMP  Major    xxxxx yyy   Case temp out-of-range

0-0>

Table 5-5 provides information for interpreting the results of an ALARM D command.

Table 5-5 Alarms
Parameter	Value	Description
XXXXX	Alarm	Alarm is set
	Dsbl	Alarm is disabled
	OK	Alarm is cleared
YYY	0..255	Count of alarm activations.

To clear all alarm counts, type the ALARM C command.

Example 5-5 Alarm C Command:

0-0>ALARM C

Alarms cleared

0-0>

HELP


Command:	HELP
Syntax:	HELP
Password:	N/A
Configuration:	N/A
Brief Description:	Lists available commands
Detailed:	Displays list of available user commands.

Example 5-6 HELP command results:

0-0>HELP

System Status     System Commands   Setup Commands    Maintenance

------------------------------------------------------------------------

   ALARM            ALMDSBL          SET_LOSTH        CUTOVER

   HELP             ALMENBL          SETGT            LOAD

   LD               CONFIG           SETI             SETADDR

   PRM              LOGOUT           SETOUT           SRESET

   STAT             PASS             SETP

VER

------------------------------------------------------------------------

Enter 'Command ?' for syntax

0-0>

LD


Command:	LD
Syntax:	LD
Password:	N/A
Configuration:	N/A
Brief Description:	Display the control mode of each laser diode pump.
Explanation:	Displays the current laser status (see Example 5-7 ). Laser modes of operation are listed in Table 5-6.

Example 5-7 LD Command:

0-0>LD

LD n: mmmmmmmmmmmmmmmmmmmmmmmm

LD n: mmmmmmmmmmmmmmmmmmmmmmmm

0-0>

Table 5-6 Laser Diode Pump Parameters
Parameter	Value	Description
n	1.2	Laser diode pump number
mmmm...	Const Pump Crnt xxx(mA)	Constant current mode
	Const Pump Power yyy(mW)	Constant pump power mode
	Const Outp Power zz(mW)	Constant output power mode. Only Pump laser 2 may be in this mode.
	Temp Compensated	Temperature compensated constant gain mode
	Idle	Control is off. Pump current set to zero.
xxx	0..300	Pump bias current range for constant pump current mode
yyy	0..100	Pump power range for constant pump power mode
zz	0..65	EDFA power range for constant EDFA output power mode

PRM


Command:	PRM
Syntax:	PRM 1\|2
Password:	N/A
Configuration:	N/A
Brief Description:	Displays the latest measurements for the specified laser pump and EDFA
Explanation:	When the PRM 1\|2 command is entered, the parameters for pump 1 and 2 are displayed. (see Example 5-8). This command displays the same line of parameters as the STAT command without the header and one line at a time.

Example 5-8 PRM Command:

0-0>PRM 1

1  aaa.a/bb.b  ccccc ddd.dd  eeee.ee   ff.ff ggg.g  hhhh.h/iiii.ii jjjj.jj/kkk.kk  lll.l

0-0>PRM 2

2  aaa.a/bb.b  ccccc ddd.dd  eeee.ee   ff.ff ggg.g  hhhh.h/iiii.ii jjjj.jj/kkk.kk  lll.l

0-0>

Note Note: White space, asterisks, and forward slashes are required field delimiters.

Use the following formats to specify displayed parameters such as width, precision, and type:

•%[width].[precision]type,

•Width -total field width

•Precision -number of decimals

•Type -float (f) or signed decimal (d)

Table 5-7 lists the measurement parameters used to interpret the results of a PRM 1|2 command.

Table 5-7 PRM Measurement Parameters
Parameter	Format	Description
aaa.a	%5.1f	Laser chip temperature
bb.b	%4.1f	Laser chip temperature setpoint
ccccc	%5d	Laser TEC current
ddd.dd	%6.2f	Laser power
eeee.ee	%7.2f	Laser current
ff.ff	%5.2f	EDFA Ambient temperature
ggg.gg	%5.1f	EDFA DC voltage
hhhh.h	%6.1f	EDFA input power in �W
iiii.ii	%7.2f	EDFA input power in dBm
jjjj.jj	%7.2f	EDFA output power in mW
kkk.kk	%6.2f	EDFA output power in dBm
lll.l	%5.1f	EDFA Gain

STAT


Command:	STAT
Syntax:	STAT [interval], 1-255 sec
Password:	N/A
Configuration:	N/A
Brief Description:	Print the control mode of each pump and then periodically print the pump and EDFA status.
Explanation:	Displays EDFA status ( Example 5-9).

The period between updates ranges from 1 to 255 seconds and is specified as an argument to the STAT command. The default update rate is one time per second. To end the status-update printing and return to the prompt, press <Ctrl-X>.

While in STAT mode, line feeds are suppressed, and only carriage returns can achieve the effect of a continuously updated status line under a stationary header. This mode is intended for a craftsperson, whereas the PRM command is intended for a computer controlling the EDFA.

Laser diode pump control modes are displayed in the same format as the LD command. The only exception is that the note <<< Ctrl-X to Stop >>> which is printed on the same line as the first laser diode pump's control mode.

Format fields are identical to the PRM command.

Example 5-9 STAT Command:

0-0>STAT 1

LD 1: Const Pump Crnt   10(mA)                       <<<  Ctrl-X to Stop   >>>

LD 2: Const Pump Crnt   10(mA)

LD     T/To     TEC    LDPwr    LDCrnt   Amb    DC        In             Out        Gain

        (C)    (mA)    (mW)      (mA)    (C)    (V)    (uW/dBm)       (mW/dBm)      (dBm)

1   25.5/25.5     39   0.49     9.92   30.25   5.2     0.0/-120.00    0.00/-90.00   30.0

VER


Command:	VER
Syntax:	VER
Password:	N/A
Configuration:	N/A
Brief Description:	Displays general information about the EDFA
Explanation:	Displays module details.

Example 5-10 VER Command:

0-0>VER

CISCO Optical Amplifier, ver.4.20,  May 05, 00

Ser.# Q17DA1100003    Rev. B

Active Plane: 1

Inactive ver. 4.16

ALARM D  to see alarms

0-0>

0-0>VER

aaaaaaaaaaaaaaaaaaaaaaaa, ver.bbbb,  cccccccccc

Ser.# dddddddddddd    Rev. eeeeeeeee

Active Plane: f

Inactive ver. gggg

hhhhhhhhhhhhhhhhhhhhhh

0-0>

Fixed widths are variable unless specified. Delimiters include the comma, period, pound, colon, space, carriage return, and line feed. Use Table 5-8 to interpret the VER command details.

Table 5-8 VER Parameters
Parameter	Format	Description
aaa...	up to 50 characters	Product name
bbbb	%4.2f	Product version number. *This must be allowed to grow to %5.2f in the future.
ccc...	xxx yy,zz	Firmwave build date
ddd...	up to 12 characters	Serial number
eee...	up to 9 characters	Hardware version number
f	0 o 1.	Active firmware plane
gggg	%4.2f	Product version number. *This must be allowed to grow to %5.2f in the future
hhh...	ALARM D to see alarms	String is displayed if one or more alarms are active
xxx	Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec	Month of active firmware build
yy	%02d	Day of firmware build
zz	%02d	Year of active firmware build

System Commands

The following section describes system commands.

ALMDSBL


Command:	ALMDSBL
Syntax:	ALMDSBL <name> 1\|2
Password:	Yes
Configuration:	Yes
Brief Description:	Disables an alarm

Explanation:

When an alarm is linked exclusively to a pin, that alarm can be disabled and its output pin set to VLO (Voltage Low). The exceptions are the loss of output alarm and the gain alarms.

For example, to disable the laser-chip temperature alarm of the second pump, type ALMDSBL LTMP 2. The alarms display. If the alarm is active, pin 10 on the DB-25 connector changes states from VHI (Voltage High) to VLO.

0-0>ALMDSBL LTMP 2

0-0>ALARM D

                 Pump 1       Pump 2

Name  Type     Crnt  Cnt    Crnt  Cnt   Descr

LCRNT Minor     OK     0     OK     0   Excessive pump crnt/pump bias

LTMP  Minor     OK     0    Dsbl    0   LD temp out-of-range

                 EDFA 1

Name  Type     Crnt  Cnt   Descr

LPOUT Major    Dsbl    0   Loss outp pwr

LPIN  Major    Dsbl    0   Loss inp pwr

GAIN  Major    Dsbl    0   Gain out-of-range

CTMP  Major     OK     1   Case temp out-of-range

Note When operating the EDFA in the default constant gain mode, the LPOUT alarm is disabled and the alarms are not reported.

ALMENBL


Command:	ALMENBL
Syntax:	ALMENBL <name> 1\|2
Password:	Yes
Configuration:	Yes
Brief Description:	Enables alarm checking for the specified alarm

Explanation:

The following example displays a disabled alarm (the second laser pump's chip temperature alarm), enabled by the ALMENBL LTMP 2 command:

Example 5-11 ALMENBL Command:

0-0>ALARM D

                 Pump 1       Pump 2

Name  Type     Crnt  Cnt    Crnt  Cnt   Descr

LCRNT Minor     OK     0     OK     0   Excessive pump crnt/pump bias

LTMP  Minor     OK     0    Dsbl    0   LD temp out-of-range

                 EDFA 1

Name  Type     Crnt  Cnt   Descr

LPOUT Major    Dsbl    0   Loss outp pwr

LPIN  Major    Dsbl    0   Loss inp pwr

GAIN  Major    Dsbl    0   Gain out-of-range

CTMP  Major     OK     1   Case temp out-of-range

0-0>ALMENBL LTMP 2

0-0>ALARM D

                 Pump 1       Pump 2

Name  Type     Crnt  Cnt    Crnt  Cnt   Descr

LCRNT Minor     OK     0     OK     0   Excessive pump crnt/pump bias

LTMP  Minor     OK     0     OK     0   LD temp out-of-range

                 EDFA 1

Name  Type     Crnt  Cnt   Descr

LPOUT Major    Dsbl    0   Loss outp pwr

LPIN  Major    Dsbl    0   Loss inp pwr

GAIN  Major    Dsbl    0   Gain out-of-range

CTMP  Major     OK     1   Case temp out-of-range

0-0>

CONFIG


Command:	CONFIG
Syntax:	CONFIG S
Password:	Yes
Configuration:	Yes
Brief Description:	Saves the current EDFA configuration

Explanation:

Configuration data consists of the control mode for each laser, all alarm enable/disable states, and loss of input threshold. After reset, the EDFA will use the saved configuration as the starting point for EDFA control.

As shown in Figure 5-1, entering the CONFIG S command followed by the letter Y saves the configuration. If you enter CONFIG S followed by the letter N, the save operation will be cancelled.

Figure 5-1 CONFIG S Command Path Diagram

Note Following the Y path above, only "Saved" will be returned, followed by a new line. Following the N path above, "Cancelled" is returned with a prompt.

LOGOUT


Command:	LOGOUT
Syntax:	LOGOUT
Password:	N/A
Configuration:	N/A
Brief Description:	Logout of current session

Explanation:

The LOGOUT command returns the current prompt and terminates the command line interface serial session. The ONS 15216 EDFA1 will not respond to any further commands unless you perform a login or address bootstrap.

Example 5-12 LOGOUT Command:

0-0>LOGOUT

0-0>

Warning Configuration changes are lost at LOGOUT unless these changes are saved using the CONFIG S command ( CONFIG).

Setup Commands

The following section describes setup commands.

SET_LOSTH


Command:	SET_LOSTH
Syntax:	SET_LOSTH [D\|<value, -15 to -31dBm>]
Password:	Yes
Configuration:	Yes
Brief Description:	Set, get, or disable the loss-of-signal threshold

Explanation:

This command performs the following three functions:

•Sets and enables the loss-of-optical-input signal threshold

•Obtains and displays the current loss-of-optical-input signal threshold

•Disables the loss-of-optical-input signal alarm

Figure 5-1 The following example displays the SET_LOSTH command.

Example 5-13 SET LOSTH Command:

0-0>SET_LOSTH aaa.aa

OK

0-0>SET_LOSTH

bbb.bbdBm

0-0>SET_LOSTH D

OK

0-0>

Use Table 5-9 to interpret the results of a SET_LOSTH command

Table 5-9 LOS Threshold Parameters
Parameter	Format	Description
aaa.aa	%6.2f	Setpoint LOS Threshold
bbb.bb	%6.2f	Current LOS Threshold The value returned by SET_LOSTH. This accounts for rounding and table look-up accuracy.

Note The default loss-of-optical-input signal threshold is -30 dBm.

PASS


Command:	PASS
Syntax:	PASS <password> [<new password>]
Password:	N/A
Configuration:	Yes
Brief Description:	Gains access to password protected commands and can change password

Explanation:

Before using any password protected commands, you must first enter the correct password. For example, you must enter the correct password before switching the ONS 15216 EDFA1 operating mode to temperature-compensated constant gain mode (SETGT command, see Figure 5-1).

The system returns a "wrong password" for any incorrect passwords entered. When you enter the correct password, all password protected commands become accessible.

To change the password, use the PASS command followed by the old password and then the new password. In Example 5-14, after you enter the correct password (ENTER) the password is changed with the new PASS ENTER OPEN command.

Note To retain the new password, you need to save the configuration.

Example 5-14 PASS Command:

0-0>SETGT

Password required

0-0>PASS ABCD

Wrong password

0-0>PASS ENTER

 Pass OK

0-0>PASS ENTER OPEN

Password changed

0-0>SETGT

LD 1: Temp Compensated

LD 2: Temp Compensated

0-0>

Note CISCO is the default password.

SETGT


Command:	SETGT
Syntax:	SETGT
Password:	Yes
Configuration:	Yes
Brief Description:	Sets the laser diode pump control mode to constant gain with possible temperature compensation

Explanation:

The SETGT command switches the module operation to constant gain mode Figure 5-1. When the command switches laser diode pump control modes to constant gain, the LPOUT alarm (loss of output) is disabled and the GAIN alarm is enabled.

Example 5-15 SETGT Command:

0-0>SETGT

LD 1: Temp Compensated

LD 2: Temp Compensated

0-0>SETG

LD 1: Const Gain

LD 2: Const Gain

0-0>

Note Constant gain mode is the default mode of operation.

SETI


Command:	SETI
Syntax:	SETI 1\|2 <value, decimal (0-300mA)>
Password:	Yes
Configuration:	Yes
Brief Description:	Sets specified laser diode pump control to constant current mode

Explanation:

The SETI command is used to change the laser diode pump current ( Figure 5-1).

When setting a laser in constant current mode, the GAIN alarm is automatically disabled. The output power alarm continues to function, testing for a 2 dB deviation of output power from the last output power setpoint.

If necessary, the ALMDSBL command (see the "ALMDSBL" section) can be used to disable the LPOUT alarm.

Note A value of zero will place the specified laser in idle mode.

Example 5-16 SETI Command:

0-0>SETI n xxx

LD n: Const Pump Crnt  xxx(mA)

0-0>

0-0>SETI 1 0

0-0>

Use Table 5-10 to interpret the SETI commands.

Table 5-10 Laser Diode Pump Parameters
Parameter	Format	Description
n	1 or 2	Laser diode pump number
xxx	0..300	Laser diode pump current setpoint in mA. A value of zero will place the laser in IDLE mode and will cause the control mode line not to display.

SETOUT


Command:	SETOUT
Syntax:	SETOUT <value, decimal (0-65mW)>
Password:	Yes
Configuration:	Yes
Brief Description:	Set EDFA in constant output power mode

Explanation:

Constant EDFA output power mode has a configuration of 75 mW constant pump power for the first-stage pump laser and the second-stage laser controlling the overall EDFA output power. Use the SETOUT command to set the control point for the second-stage laser. The LPOUT alarm is automatically enabled and the GAIN alarm is automatically disabled when the SETOUT command is successfully issued.

A value of zero for the EDFA output power setpoint puts both pumps into IDLE mode. In this case, no control mode line is displayed after you enter the SETOUT command.

Example 5-17 SETOUT Command:

0-0>SETOUT aa.a

LD 1: Const Pump Power  75(mW)

LD 2: Const Outp Power  bb(mW)

0-0>SETOUT 0

0-0>LD

LD 1: Idle

LD 2: Idle

0-0>

Use Table 5-11 to interpret SETOUT command details.

Table 5-11 EDFA Power Parameters
Parameter	Format	Description
aa.a	0..65.0	Set EDFA output power setpoint with 0.1mW
bb	0..65	Current output power setpoint is rounded to nearest whole number

SETP


Command:	SETP
Syntax:	SETP 1\|2 <value, decimal (0-100mW)>
Password:	Yes
Configuration:	Yes
Brief Description:	Sets specified laser to constant pump power mode

Explanation:

The SETP command sets Laser diode "1" or "2" to constant pump laser power mode ( Example 5-18). The GAIN alarm is automatically disabled when the SETP command is successfully issued.

A value of zero for the pump power setpoint places the pump in IDLE mode. In this case, no control mode line is displayed after the SETP command.

Example 5-18 SETP Command:

0-0>SETP n xxx

LD n: Const Pump Power xxx(mW)

0-0>SETP n 0

0-0>

Table 5-12 can be used to interpret the SETP command details.

Table 5-12 Laser Diode Pump Parameters
Parameter	Format	Description
n	1 or 2	Laser diode pump number
xxx	0..100	Set laser diode pump power in mW

Maintenance Commands

The following are maintenance commands.

CUTOVER


Command:	CUTOVER
Syntax:	CUTOVER
Password:	Yes
Configuration:	Yes
Brief Description:	Executes firmware from the inactive plane and changes inactive plane status to the default active plane

Explanation:

After a new firmware version is downloaded to the EDFA's inactive plane, the CUTOVER command begins executing the new firmware. The cutover process is similar to a cold restart, except that information about control loops is stored and recovered after booting so that the EDFA can resume control where it left off. Alarm reporting can be incorrect during a cutover. Cutoveris approximately 12 seconds.

If any unsaved configuration parameters are present when the cutover command is issued, a prompt appears that permits you to save the modified parameters. All unsaved modified parameters will be lost during the cutover process.

Figure 5-2 CUTOVER Command Diagram

Use Table 5-13 to interpret the CUTOVER command details.

Table 5-13 Active/Inactice Plane Parameters
Parameter	Format	Description
aaaa	%4.2f	Active plane firmware version. This must be allowed to grow %5.2f in the future.
bbbb	%4.2f	Inactive plane firmware version. This must be allowed to grow %5.2f in the future.

LOAD


Command:	LOAD
Syntax:	LOAD Start\|Abort\|Report
Password:	Yes
Configuration:	N/A
Brief Description:	Download firmware to the EDFA

Explanation:

Enter the LOAD START command to download new firmware. During the download process, feedback consisting of an increasing page count appears every second on the terminal screen ( Example 5-19). Each page represents one loaded 128 byte flash page; there are two cyclic redundancy checks (CRCs)at the end of the load procedure. For a successful load, the CRC will match the Cisco-provided CRC (Cisco provides the CRC with its firmware upgrade).

If during download the rate of updates halts and no CRC is displayed within 10 seconds of the halt, the download has failed.

Note In the figure below at the "0 pages loaded line" , CR/LF (carriage return/line feed) pairs have been substituted for LFs to enhance readability. The actual download procedure only uses LFs.

Example 5-19 LOAD START Command:

0-0>LOAD START

Ready for loading

0-0>@LLF

   0 pages loaded

nnnn

xxxx xxxx

Use Table 5-13 to interpret the LOAD START command results.

Table 5-14 Load Parameters
Parameter	Format	Description
nnnn	0-9999	Pages loaded; 1 page = 128 bytes
xxxx	CRC	16-bit hex CRC of flash plane, repeated twice

A LOAD ABORT command reverts an EDFA that is waiting for a firmware upload to normal mode. Any firmware file sent to the EDFA is rejected. You must reissue the LOAD START command for the EDFA to take action on a firmware file ( Example 5-19).

Example 5-20 LOAD ABORT Command

0-0>LOAD ABORT

Aborted

0-0>

Note The LOAD REPORT command is used only for diagnostic purposes.

SETADDR


Command:	SETADDR
Syntax:	SETADDR xx, where xx is decimal number
Password:	N/A
Configuration:	Yes
Brief Description:	Sets the address of the ONS 15216 EDFA1. This command enables a unique address to be assigned to each EDFA in systems where two or more ONS 15216 EDFA1s are used within one networking platform.

Explanation:

Enter SETADDR<xx> to assign an address to the EDFA module ( Example 5-21).

Example 5-21 SET ADDR Command:

0-0>SETADDR xy

x-y>

Use Table 5-14 to interpret and issue SETADDR commands.

Table 5-15 EDFA Address Parameters
Parameter	Format	Description
x	0-9	First half of EDFA address
y	0-9	Second half of EDFA address

SRESET


Command:	SRESET
Syntax:	SRESET
Password:	N/A
Configuration:	N/A
Brief Description:	Software reset for EDFA

Explanation:

The SRESET command reboots the EDFA.

Example 5-22 SRESET Command:

0-0>SRESET

LD 1: Temp Compensated

LD 2: Temp Compensated

Caution

Only use this command if the EDFA has entered an inconsistent state.

After bootup, the current control mode of the EDFA is broadcast. In Example 5-22, the EDFA has the temperature-compensated constant gain mode as the default mode of operation.

Note Alarms are not valid during the booting period (12 seconds). This command does not affect service.

!SETADDR


Command:	!SETADDR
Syntax:	!SETADDR xx, where xx is decimal number
Password:	N/A
Configuration:	Yes
Brief Description:	Bootstraps the EDFA address

Explanation:

An exclamation point placed at the beginning of the SETADDR command overrides the logon requirement of the EDFA. This allows a new address to be assigned without knowledge of the EDFA's current address. After the confirmation prompt is returned, the user is logged out. In practice, the exclamation point shown in the following example is not echoed back ( Example 5-23).

Example 5-23 !SETADDR Command:

!SETADDR xy

x-y>

Use Table 5-16 to interpret and issue the !SETADDR command.

Table 5-16 EDFA Address Parameters
Parameter	Format	Description
x	0-9	First half of EDFA address
y	0-9	Second half of EDFA address

Command Summary

Table 5-17 summarizes all the user commands presented in this chapter. Commands are listed in alphabetical order.

Table 5-17 Command Summary
Command Syntax	Function	Description
@XY	Login to unit with XY address	To begin a command session, first log into the EDFA module. Typing the @ character while already logged into a unit immediately terminates the command session.
ALARM D ALARM C	Alarm Status Display Alarm Status Clear	This command displays the alarm status. This command clears all of the alarm counts.
ALMDSBL<name> 1\|2 ALMENBL<name> 1\|2	Alarm Enable /Disable	This command disables alarm number n. This command enables alarm number n. Unless saved with the CONFIG S command, the alarm remains disabled/ enabled until the next reset.
CONFIG S	Configuration Save Command	This command saves the current settings.
CUTOVER	Firmware Cutover	This command switches operation from the active plane to the inactive plane to install a new version of firmware.
HELP	Command Display	This command displays a list of commands available to the user.
INACTIMER <minutes>	Inactivity Command	This command sets the inactivity timeout. If no keyboard activity is detected during this timeout, the EDFA automatically logs out. (Minutes = 1 to 255)
LD	Laser Status Display	This command displays the control mode of each laser diode pump..
LOAD Start \| Abort \| Report	Firmware Download to EDFA	This command initializes the module to accept remote downloads of new firmware.
LOGOUT	Logout Command	This command logs out of the current unit. The command will return to the current prompt and then terminate the command line interface serial session with the EDFA.
PASS <password.> [<new password>]	Password	This command enables password-protected commands and can change passwords.
PRM 1\|2	Parameter Display	This command enables the parameters for pumps one and two.
SETADDR xx (where xx is a decimal number)	Sets address of EDFA	This command assigns a two-digit address value (range 0 to 99) to an EDFA.
!SETADDR xx (where xx is a decimal number)	Bootstraps the EDFA address	An exclamation point placed at the beginning of the SETADDR command overrides the EDFA's logon requirement. This allows a new address to be assigned without knowledge of the EDFA's current address. After the confirmation prompt is returned, the user is logged out.
SET_LOSTH [D] <value,-15 to -31 dBm>]	Set, get, or disable the loss of signal threshold	This command performs three functions: set and enable the loss-of-input signal threshold, get the current loss-of-input signal threshold, or disable the loss-of-input signal alarm.
SETGT	Sets laser diode pump control modes to constant gain	This command sets the laser pump control modes to constant gain with possible temperature compensation. When switching laser diode pump control modes to constant gain, the loss of output alarm, LPOUT, is disabled and the GAIN alarm is enabled.
SETI 1\|2 <value, decimal (0-300) mA)>	Sets specified laser diode pump control to constant current mode	This command sets Laser 1 or 2 to Constant Pump Laser Current at set <value> in mA.
SETOUT <value, decimal (0-65 mW)>	Sets EDFA in constant output power mode	Constant EDFA output power mode has the first-stage pump laser configured for 75mW of constant pump power and the second-stage laser controlling the overall EDFA output power. The SETOUT command is used to set the control point for the second-stage laser. The LPOUT alarm is automatically enabled and the GAIN alarm is automatically disabled when you successfully issue the SETOUT command. A value of zero for the EDFA output power setpoint puts both pumps into IDLE mode. In this case, no control mode line displays after you issue the SETOUT command.
SETP 1\|2 <value, decimal (0-100 mW)>	Sets specified laser in constant pump power mode	The GAIN alarm is automatically disabled when the SETP command is successfully issued. A value of zero for the pump power setpoint places the pump in IDLE mode. In this case, no control mode line displays after the SETP command.
SRESET	Software Reset	This command initiates a reboot of the EDFA. This command should only be used if the EDFA has entered an inconsistent state.
STAT [interval], 1-255 sec	Displays the control mode of each pump and then periodically displays pump and EDFA status.	This command provides a continuous display of all monitored parameters. You can set the period between updates from 1 to 255 seconds. It is specified as an argument to the STAT command. Type Ctrl-X to return to the prompt from the status display.
VER	Version Display	This command displays general information about the EDFA.

Table Of Contents

Command Line Reference

ONS 15216 EDFA1 Operation

User Commands

Measurement Parameters

Login Session

@XY

Password Protection

Error Handling

System Status Commands

ALARM

HELP

LD

PRM

STAT

VER

System Commands

ALMDSBL

ALMENBL

CONFIG

LOGOUT

Setup Commands

SET_LOSTH

PASS

SETGT

SETI

SETOUT

SETP

Maintenance Commands

CUTOVER

LOAD

SETADDR

SRESET

!SETADDR

Command Summary