cc/td/doc/product/ong/15216/216edf
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table Of Contents

TL1 Commands

9.1 Introduction

9.2 Connection to the ONS 15216 EDFA2

9.3 Explanation of Command Parameters

9.3.1 Source Identifier (sid) and Target Identifier (tid)

9.3.2 Command Code Modifier (ccm)

9.3.3 Access Identifier (aid)

9.3.4 Correlation Tag (ctag)

9.4 Notation

9.5 Summary of Autonomous Alarms and Messages

9.6 Summary of Security Permissions for TL1 Commands

9.7 TL1 Commands and Autonomous Messages

9.7.1 ACT-USER

9.7.2 ALW-MSG-ALL

9.7.3 APPLY

9.7.4 CANC-USER

9.7.5 COPY-RFILE

9.7.6 CPY-MEM

9.7.7 DLT-RFILE

9.7.8 DLT-USER-SECU

9.7.9 ED-DAT

9.7.10 ED-DWDM

9.7.11 ED-ENV

9.7.12 ED-NE-GEN

9.7.13 ED-PID

9.7.14 ED-USER-SECU

9.7.15 ENT-USER-SECU

9.7.16 INH-MSG-ALL

9.7.17 INIT-SYS

9.7.18 REPT ALM DWDM

9.7.19 REPT ALM ENV

9.7.20 REPT ALM EQPT

9.7.21 REPT EVT DWDM / REPT EVT ENV / REPT EVT EQPT

9.7.22 REPT EVT FXFR

9.7.23 RTRV-ALM-ALL

9.7.24 RTRV-ALM-DWDM

9.7.25 RTRV-ALM-ENV

9.7.26 RTRV-ALM-EQPT

9.7.27 RTRV-AO

9.7.28 RTRV-COND-ALL

9.7.29 RTRV-COND-DWDM

9.7.30 RTRV-COND-ENV

9.7.31 RTRV-COND-EQPT

9.7.32 RTRV-DFLT-SECU

9.7.33 RTRV-DWDM

9.7.34 RTRV-ENV

9.7.35 RTRV-HDR

9.7.36 RTRV-INV

9.7.37 RTRV-NE-GEN

9.7.38 RTRV-RFILE

9.7.39 RTRV-TH-DWDM

9.7.40 RTRV-TH-ENV

9.7.41 RTRV-TH-EQPT

9.7.42 RTRV-TOD

9.7.43 RTRV-USER-SECU

9.7.44 SET-ATTR-SECUDFLT

9.7.45 SET-TH-DWDM

9.7.46 SET-TH-ENV

9.7.47 SET-TH-EQPT

9.7.48 STA-LOCL-RST


TL1 Commands


9.1 Introduction

This chapter provides the details of TL1 commands supported by the Cisco ONS 15216 EDFA2. This chapter also maps various TL1 command parameters to their SNMP counterpart attributes in the ONS 15216 EDFA2 MIB (CERENT-15216-EDFA-MIB.mib).

9.2 Connection to the ONS 15216 EDFA2

The ONS 15216 EDFA2 system supports up to ten simultaneous Telnet connections via the Ethernet LAN port. TL1 sessions are available on TCP/IP port 3082 for raw TL1 and/or port 3083 for TL1 over Telnet. When connected, the ACT-USER command activates a session. (See "Log In via LAN Port Using Telnet (Optional)" section on page 8-3.)

9.3 Explanation of Command Parameters

TL1 messages are grouped into autonomous and non-autonomous types. Autonomous messages are generated as a result of activity on the network elements such as alarms, thresholds, alerts and status information. No request is required in order to receive autonomous messages. Non-autonomous messages consist of a request command and a response from the ONS 15216 EDFA2. Autonomous messages and non-autonomous commands use a common set of parameters. Some of the most common parameters are defined in the following sections.

9.3.1 Source Identifier (sid) and Target Identifier (tid)

The source identifier (sid) or target identifier (tid) parameters uniquely identify an ONS 15216 EDFA2. For the ONS 15216 EDFA2, sid and tid are the same. The sid/tid name is used only by the TL1 shell in the ONS 15216 EDFA2. While the TL1 shell uses the sid/tid name in its command line prompt, the ASH shell uses the host name.

9.3.2 Command Code Modifier (ccm)

The command code modifier (ccm) identifies the object of the action being applied by the verb of the TL1 command. Some command code modifiers for the ONS 15216 EDFA2 are described in Table 9-1.

Table 9-1 Command Code Modifiers

ccm
Description

DWDM

Optical parameters.

ENV

Environmental (power bus) parameters.

EQPT

General parameters of the ONS 15216 EDFA2.

INV

Inventory parameters.

NE-GEN

IP communications parameters.


9.3.3 Access Identifier (aid)

The access identifier (aid) parameter uniquely identifies an object within the ONS 15216 EDFA2. For the ONS 15216 EDFA2, there are four specific aids (1, PWR-A, PWR-B, EQPT) and the ALL aid, as described in Table 9-2. All autonomous messages identify their specific aid in the message. For all command inputs that require an aid as a mandatory parameter, the ALL aid is accepted as well as any relevant specific aids. If the ALL aid is used in a command, the response contains the appropriate specific aid. For the commands RTRV-ALM-ENV and RTRV-COND-ENV, inputting a specific aid filters the response to information relevant to that aid.

Table 9-2 Access Identifiers

aid
Description

1

Directly affecting the optical signal.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).


9.3.4 Correlation Tag (ctag)

The correlation tag (ctag) is a unique tag associated with a command. If the user specifies a ctag while entering a command, the response of that command from the ONS 15216 EDFA2 TL1 agent carries the same ctag value. The ctag consists of no more than six alphanumeric characters.

9.4 Notation

The commands described in this document use the symbols shown in Table 9-3 to describe the command format. These symbols are derived from the Telcordia Network Maintenance: Network Element and Transport Surveillance Messages Manual (Generic Requirements, GR-833-CORE).

Table 9-3 TL1 Notation Symbols

Symbol
Meaning
Description

[ ]

Optional expression

Square brackets indicate the parameters are optional. An optional parameter means that if a user inputs an empty field for an optional parameter, then a default value (or a default action) will be substituted automatically in the transmitted input field. The default value, or null value, is defined in the parameter descriptions of the messages.

< >

Variable expression

Angle brackets enclose one or more variable items in the command line, e.g., <date>, <time>, <aid>, etc.

Italics are used to note variables in paragraph text, e.g., date, time, aid, etc.

+

More than one time

Plus signs indicate that preceding symbol or group of symbols (enclosed in parentheses) may occur one or more times.

   text

Indent of three spaces

An indented line indicates an entry of three spaces in the command line.


9.5 Summary of Autonomous Alarms and Messages

Table 9-4 summarizes the ONS 15216 EDFA2 autonomous alarms. Table 9-5 summarizes the ONS 15216 EDFA2 autonomous events. Table 9-6 summarizes the ONS 15216 EDFA2 file transfer events. Table 9-7 summarizes the ONS 15216 EDFA2 clear alarms.

Table 9-4 TL1 Autonomous Alarms 

TL1 Autonomous Message
Condition Type (condtype)
Condition Descriptor (conddescr)
Access Identifier (aid)
Notification Code (ntfcncde)
Service Effect (srveff)

REPT ALM DWDM

LOS

Loss Of Signal (input power)

1

MJ

SA

REPT ALM DWDM

GAIN

Gain Out Of Range

1

MJ

SA

REPT ALM DWDM

LPOUT

Loss Of Output Power

1

MJ

SA

REPT ALM ENV

PWRBUSA

Power Bus A (voltage) Alarm

PWR-A

MJ

-

REPT ALM ENV

PWRBUSB

Power Bus B (voltage) Alarm

PWR-B

MJ

-

REPT ALM EQPT

CTMP

Case Temperature Out Of Range

EQPT

MN

NSA

REPT ALM EQPT

LCRNT1

Excessive Pump1 Current

EQPT

MN

NSA

REPT ALM EQPT

LCRNT2

Excessive Pump2 Current

EQPT

MN

NSA

REPT ALM EQPT

LTMP1

Excessive Pump1 Temperature

EQPT

MN

NSA

REPT ALM EQPT

LTMP2

Excessive Pump2 Temperature

EQPT

MN

NSA



Note The messages for Loss of Signal (LOS), Gain Out of Range (GAIN), and Loss of Output Power (LPOUT) are prioritized (in the order just listed) so that only one message can be delivered at one time. For example, if the ONS 15216 EDFA2 detects both a loss of input signal and a loss of output power at the same time, it will deliver only the Loss of Signal (LOS) message to the user. This prioritized filtering of alarms does not occur with the SNMP delivery of alarms of the ONS 15216 EDFA2.


Table 9-5 TL1 Autonomous Events 

TL1 Autonomous Message
Condition Type (condtype)
Condition Descriptor (conddescr)
Access Identifier (aid)
Condition Effect (condeff)

REPT EVT DWDM

CTRLMODE1

Pump1 Control Mode Changed

1

TC

REPT EVT DWDM

CTRLMODE2

Pump2 Control Mode Changed

1

TC

REPT EVT DWDM

GAINCHGD

Overall Gain Changed

1

TC

REPT EVT DWDM

LOSHYSTCHGD

LOS (loss of signal) Hysteresis Changed

1

TC

REPT EVT DWDM

LOSTHCHGD

LOS (loss of signal) Threshold Changed

1

TC

REPT EVT DWDM

LPOUTCHGD

Loss Of Output Power Setpoint Changed

1

TC

REPT EVT DWDM

LPOUTDEVCHGD

Lpout (loss of output power) Deviation Changed

1

TC

REPT EVT DWDM

LPOUTHYSTCHGD

Lpout (loss of output power) Hysteresis Changed

1

TC

REPT EVT DWDM

PREATTCHGD

Pre-attenuation Changed

1

TC

REPT EVT ENV

PWRBUSMAXCHGD

Power Bus Max (voltage) Changed

PWR-A

TC

REPT EVT ENV

PWRBUSMINCHGD

Power Bus Min (voltage) Changed

PWR-A

TC

REPT EVT ENV

PWRBUSMODE

Power Bus Mode Changed

PWR-B

TC

REPT EVT EQPT

MAXCTMPCHGD

Max Case Temperature Changed

EQPT

TC

REPT EVT EQPT

MAXCTMPHYSTCHGD

Max Ctmp (case temperature) Hysteresis Changed

EQPT

TC

REPT EVT EQPT

MINCTMPCHGD

Min Case Temperature Changed

EQPT

TC

REPT EVT EQPT

MINCTMPHYSTCHGD

Min Ctmp (case temperature) Hysteresis Changed

EQPT

TC

REPT EVT EQPT

CUTOVERRESET

(Software) Reset After Cutover

EQPT

TC

REPT EVT EQPT

SOFTWARELOAD

(New) Software Load

EQPT

TC

REPT EVT EQPT

SOFTWARERESET

Software Reset

EQPT

TC


Table 9-6 TL1 Autonomous File Transfer Events 

Autonomous TL1 Message
File Transfer Status (fxfr_status)
File Transfer Result (fxfr_rslt)
Access Identifier (aid)

REPT EVT FXFR

START

 

EQPT

REPT EVT FXFR

COMPLD

SUCCESS

EQPT

FAILURE

EQPT


Table 9-7 TL1 Autonomous Clear Alarms 

TL1 Autonomous Message
Condition Type (condtype)
Condition Descriptor (conddescr)
Access Identifier (aid)
Notification Code (ntfcncde)
Service Effect (srveff)

REPT ALM DWDM

LOS

Loss Of Signal (input power)

1

CL

SA

REPT ALM DWDM

GAIN

Gain Out Of Range

1

CL

SA

REPT ALM DWDM

LPOUT

Loss Of Output Power

1

CL

SA

REPT ALM ENV

PWRBUSA

Power Bus A (voltage) Alarm

PWR-A

CL

-

REPT ALM ENV

PWRBUSB

Power Bus B (voltage) Alarm

PWR-B

CL

-

REPT ALM EQPT

CTMP

Case Temperature Out Of Range

EQPT

CL

NSA

REPT ALM EQPT

LCRNT1

Excessive Pump1 Current

EQPT

CL

NSA

REPT ALM EQPT

LCRNT2

Excessive Pump2 Current

EQPT

CL

NSA

REPT ALM EQPT

LTMP1

Excessive Pump1 Temperature

EQPT

CL

NSA

REPT ALM EQPT

LTMP2

Excessive Pump2 Temperature

EQPT

CL

NSA


9.6 Summary of Security Permissions for TL1 Commands

Table 9-8 summarizes the security permissions (access levels) for each available TL1 command and autonomous message.

Table 9-8 TL1 Commands and Messages Security Permissions (Access Levels) 

Command or Message
Description
User Access Levels
R
RW
RWA

ACT-USER

Activates user session (login).
See ACT-USER.

Yes

Yes

Yes

ALW-MSG-ALL

Allows automatic (REPT) messages.
See ALW-MSG-ALL.

Yes

Yes

Yes

APPLY

Applies software cutover.
See APPLY.

No

No

Yes

CANC-USER

Cancels user session (logoff).
See CANC-USER.

Yes

Yes

Yes

COPY-RFILE

Copies remote or local file to FFS.
See COPY-RFILE.

No

Yes

Yes

CPY-MEM

Copies log file from RAM to FFS.
See CPY-MEM.

No

Yes

Yes

DLT-RFILE

Deletes file from FFS.
See DLT-RFILE.

No

Yes

Yes

DLT-USER-SECU

Deletes a user.
See DLT-USER-SECU.

No

No

Yes

ED-DAT

Edits date and time.
See ED-DAT.

No

Yes

Yes

ED-DWDM

Edits optical parameters.
See ED-DWDM.

No

Yes

Yes

ED-ENV

Edits power bus mode.
See ED-ENV.

No

Yes

Yes

ED-NE-GEN

Edits general IP-related parameters.
See ED-NE-GEN.

No

Yes

Yes

ED-PID

Edits user password.
See ED-PID.

Yes
(own UID)

Yes
(own UID)

Yes
(all UIDs)

ED-USER-SECU

Edits a user's name and parameters.
See ED-USER-SECU.

No

No

Yes

ENT-USER-SECU

Enters new user.
See ENT-USER-SECU.

No

No

Yes

INH-MSG-ALL

Inhibits some automatic messages.
See INH-MSG-ALL.

Yes

Yes

Yes

INIT-SYS

Initializes (reboots) system.
See INIT-SYS.

No

Yes

Yes

REPT ALM DWDM

Message that reports optical alarm activation/clearing.
See REPT ALM DWDM.

Yes

Yes

Yes

REPT ALM ENV

Message that reports power-bus alarm activation/clearing.
See REPT ALM ENV.

Yes

Yes

Yes

REPT ALM EQPT

Message that reports general alarm activation/clearing.
See REPT ALM EQPT.

Yes

Yes

Yes

REPT EVT DWDM
REPT EVT ENV
REPT EVT EQPT

Message that reports event logging.
See REPT EVT DWDM / REPT EVT ENV / REPT EVT EQPT.

Yes

Yes

Yes

REPT EVT FXFR

Message that reports FTP file transfer.
See REPT EVT FXFR.

Yes

Yes

Yes

RTRV-ALM-ALL

Retrieves all current alarms.
See RTRV-ALM-ALL.

Yes

Yes

Yes

RTRV-ALM-DWDM

Retrieves current optical alarms.
See RTRV-ALM-DWDM.

Yes

Yes

Yes

RTRV-ALM-ENV

Retrieves current power-bus alarms.
See RTRV-ALM-ENV.

Yes

Yes

Yes

RTRV-ALM-EQPT

Retrieves current general alarms.
See RTRV-ALM-EQPT.

Yes

Yes

Yes

RTRV-AO

Retrieves most-recent autonomous output (REPT) messages.
See RTRV-AO.

Yes

Yes

Yes

RTRV-COND-ALL

Retrieves condition (state) of all current alarms.
See RTRV-COND-ALL.

Yes

Yes

Yes

RTRV-COND-DWDM

Retrieves condition (state) of current optical alarms.
See RTRV-COND-DWDM.

Yes

Yes

Yes

RTRV-COND-ENV

Retrieves condition (state) of current power-bus alarms.
See RTRV-COND-ENV.

Yes

Yes

Yes

RTRV-COND-EQPT

Retrieves condition (state) of current general alarms.
See RTRV-COND-EQPT.

Yes

Yes

Yes

RTRV-DFLT-SECU

Retrieves timeouts for access levels.
See RTRV-DFLT-SECU.

No

No

Yes

RTRV-DWDM

Retrieves optical parameters.
See RTRV-DWDM.

Yes

Yes

Yes

RTRV-ENV

Retrieves power bus mode.
See RTRV-ENV.

Yes

Yes

Yes

RTRV-HDR

Retrieves header (pings NE).
See RTRV-HDR.

Yes

Yes

Yes

RTRV-INV

Retrieves inventory parameters.
See RTRV-INV.

Yes

Yes

Yes

RTRV-NE-GEN

Retrieves general IP-related parameters.
See RTRV-NE-GEN.

Yes

Yes

Yes

RTRV-RFILE

Retrieves files on FFS.
See RTRV-RFILE.

Yes

Yes

Yes

RTRV-TH-DWDM

Retrieves optical thresholds.
See RTRV-TH-DWDM.

Yes

Yes

Yes

RTRV-TH-ENV

Retrieves power-bus thresholds.
See RTRV-TH-ENV.

Yes

Yes

Yes

RTRV-TH-EQPT

Retrieves general thresholds.
See RTRV-TH-EQPT.

Yes

Yes

Yes

RTRV-TOD

Retrieves date and time.
See RTRV-TOD.

Yes

Yes

Yes

RTRV-USER-SECU

Retrieves access level of user(s).
See RTRV-USER-SECU.

Yes
(own UID)

Yes
(own UID)

Yes
(all UIDs)

SET-ATTR-SECUDFLT

Sets timeout values for access levels.
See SET-ATTR-SECUDFLT.

No

No

Yes

SET-TH-DWDM

Sets optical thresholds.
See SET-TH-DWDM.

No

Yes

Yes

SET-TH-ENV

Sets power-bus thresholds.
See SET-TH-ENV.

No

Yes

Yes

SET-TH-EQPT

Sets general thresholds.
See SET-TH-EQPT.

No

Yes

Yes

STA-LOCL-RST

Resets all parameters to manufacturer's default values.
See STA-LOCL-RST.

No

No

Yes


9.7 TL1 Commands and Autonomous Messages

9.7.1 ACT-USER

Command: ACT-USER
Description: Activates user session (login).
Syntax:
ACT-USER:[<tid>]:<uid>:<ctag>::<pid>;

Example 9-1 ACT-USER Command

Amp01:ONS15216 EDFA2> ACT-USER:Amp01:JOE:123::***;

Table 9-9 ACT-USER Syntax Description 

Parameter
Syntax
Description

uid

string

The user's identifier (user name). Can be any combination of up to 10 alphanumeric characters.

pid

string

The user's private identifier (password). The password must be a string of up to 10 characters, where at least 2 are non-alphabetic characters and at least 1 is a special character. Special characters are +, #, %, etc. (defined in Telcordia GR-831-CORE).


9.7.2 ALW-MSG-ALL

Command: ALW-MSG-ALL
Description: Permits or resumes the dispatch of automatic messages from the ONS 15216 EDFA2 that were inhibited by an INH-MSG call. All alarms in existence at the time that this command restores them are transmitted via REPT ALM and REPT EVT messages.
Syntax:
ALW-MSG-ALL:[<tid>]::<ctag>::[<ntfcncde>],[<condtype>][,];

Example 9-2 ALW-MSG-ALL Command

Amp01:ONS15216 EDFA2> ALW-MSG-ALL:Amp01::123::MJ,LOS;

Table 9-10 ALW-MSG-ALL Syntax Description 

Parameter
Syntax
Description

ntfncde

 

Notification code of the alarm or event that is to be allowed (maps to cerent15216EdfaAlarmPriority for active alarms). A null maps to none of the codes, i.e., with a null, all existing ntfncde inhibitions are kept unchanged. Possible values are:

MJ

Major alarm.

MN

Minor alarm.

NA

No alarm.

CL

Cleared alarm.

condtype

 

Condition type of the alarm or event that is to be allowed. (Maps to cerent15216EdfaLogEventID.) ALL maps to all types. A null maps to none of the types, i.e., with a null, all existing condtype inhibitions are kept unchanged. Possible condtype and corresponding conddescr (in quotes) are:

LOS

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

CTMP

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

POWERBUSA

"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).

POWERBUSB

"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).

CTRLMODE1

"Pump1 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=1).

CTRLMODE2

"Pump2 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=2).

 

GAINCHGD

"Overall Gain Changed" (cerent15216EdfaConstGainOverallGain).

LOSHYSTCHGD

"LOS (loss of signal) Hysteresis Changed" (cerent15216EdfaLOSHysteresis).

LOSTHCHGD

"LOS (loss of signal) Threshold Changed" (cerent15216EdfaLOSThreshold).

LPOUTCHGD

"Loss of Output Power Setpoint Changed" (cerent15216EdfaLpoutSetpoint).

LPOUTDEVCHGD

"Lpout (loss of output power) Deviation Changed" (cerent15216EdfaLpoutDeviation).

LPOUTHYSTCHGD

"Lpout (loss of output power) Hysteresis Changed" (cerent15216EdfaLpoutHysteresis).

PREATTCHGD

"Pre-attenuation Changed" (cerent15216EdfaVariableGainPreAttenuation).

PWRBUSMAXCHGD

"Power Bus Max (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMax).

PWRBUSMINCHGD

"Power Bus Min (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMin).

PWRBUSMODE

"Power Bus Mode Changed" (cerent15216EdfaPowerBusMode).

MAXCTMPCHGD

"Max Case Temperature Changed" (cerent15216EdfaCtmpMax).

MAXCTMPHYSTCHGD

"Max Ctmp (case temperature) Hysteresis Changed" (cerent15216EdfaCtmpMaxHysteresis).

MINCTMPCHGD

"Min Case Temperature Changed" (cerent15216EdfaCtmpMin).

MINCTMPHYSTCHGD

"Min Ctmp (case temperature) Hysteresis Changed" (cerent15216EdfaCtmpMinHysteresis).

CUTOVERRESET

(Software) "Reset after Cutover" (cerent15216EdfaOpCutover).

SOFTWARELOAD

(New) "Software Load" (cerent15216EdfaOpLoad).

SOFTWARERESET

"Software Reset" (cerent15216EdfaOpReset).

ALL

All condtype preceding.


9.7.3 APPLY

Command: APPLY
Description: Applies a software cutover in the memory. There are two boot file entries. This command exchanges boot file entries 1 and 2 so that when the system is restarted (by the INIT-SYS command), it boots with the image that was (before the execution of this command) at the second entry.
Syntax:
APPLY:[<tid>]::<ctag>;

Example 9-3 APPLY Command

Amp01:ONS15216 EDFA2> APPLY:Amp01::1234;

9.7.4 CANC-USER

Command: CANC-USER
Description: Cancels user session (logoff).
Syntax:
CANC-USER:[<tid>]:<uid>:<ctag>;

Example 9-4 CANC-USER Command

Amp01:ONS15216 EDFA2> CANC-USER:Amp01:JOE:100;

Table 9-11 CANC-USER Syntax Description 

Parameter
Syntax
Description

uid

string

The user's identifier (user name).


9.7.5 COPY-RFILE

Command: COPY-RFILE
Description: Copies a local or remote file to the persistent memory (flash file system) on the ONS 15216 EDFA2. Depending on the value specified for the TYPE parameter, this command can be used to download a remote software image file to the ONS 15216 EDFA2 as its second boot entry (to cutover-upgrade later using the APPLY command), to copy a remote or local file to the ONS 15216 EDFA2 flash file system, or to copy a file on the ONS 15216 EDFA2 flash file system to a remote or local file. There may be a delay while this command executes. See REPT EVT FXFR for information on the autonomous response messages.
Syntax:
COPY-RFILE:[<tid>]::<ctag>::TYPE=<type>,SRC=<src>,[DEST=<dest>],[OVERWRITE=<overwrite>];

Example 9-5 COPY-RFILE Command and Response

Amp01:ONS15216 EDFA2> COPY-RFILE:Amp01::1234::TYPE=SWDL,SRC="ftp://user1:passwd@192.168.85 .10:21/bin/15216EdfaSw_2.1.0",DEST="file://localhost/15216EdfaSw_2.1.0",OVERWRITE=YES;
   Amp01 2002-04-30 11:34:05
M 100 COMPLD
/* COPY-RFILE */
;
   Amp01 2002-04-30 11:34:05
A 7 REPT EVT FXFR
EQPT:15216EdfaSw_2.1.0,START,,
;
   Amp01 2002-04-30 11:35:24
A 8 REPT EVT FXFR
EQPT:15216EdfaSw_2.1.0,COMPLD,SUCCESS,2013987
;

Table 9-12 COPY-RFILE Syntax Description 

Parameter
Syntax
Description

type

 

Specifies the type and direction of transfer. Possible values are:

RFR

Restore a file from remote server to the ONS 15216 EDFA2's flash file system.

RFBU

Backup a file from the ONS 15216 EDFA2's flash file system to the remote server (overwrite is always YES for this type).

SWDL

Download a software image file to the ONS 15216 EDFA2's flash file system and update the second boot entry to point to this file.

src,
dest

string

src and dest must both be URLs. Both FTP and file URLs are supported.

An FTP URL has the following format:

ftp:[//[<userid>[:<password>]@]<ftphost>[:<port>]]/<urlpath>

A file URL (referring to the local system) has the following format:

file://localhost/<urlpath>

where

<userid> is the FTP user identifier

<password> is the FTP password for the user

<ftphost> is the IP address of the FTP server

<port> is the port number to connect to

<urlpath> is the path in the following format: <cwd1>/<cwd2>/.../<cwdn>/<filename>

where <cwd1>...<cwdn> are directory levels and <filename> is the file name

overwrite

 

Possible values are:

YES

Overwrite existing file of the same name at the destination.

NO

Do not overwrite if file with same name exists at the destination. This is the default if overwrite is null.


9.7.6 CPY-MEM

Command: CPY-MEM
Description: Copies the log file in the non-persistent memory (RAM) or a specified file on the persistent memory (flash file system) to a file with a specified name on the persistent memory.
Syntax:
CPY-MEM:[<tid>]::<ctag>::[<fromfile>],[<fromdev>],[<tofile>];

Example 9-6 CPY-MEM Command and Response (Copy LOG File from RAM as aolog.txt on FFS)

Amp01:ONS15216 EDFA2> CPY-MEM:Amp01::123::LOG,MEM,;
   Amp01 2002-07-16 09:49:01
M 123 COMPLD
   /* CPY-MEM */
;

Example 9-7 CPY-MEM Command and Response (Copy LOG File from RAM as aolog.txt on FFS using Null)

Amp01:ONS15216 EDFA2> CPY-MEM:Amp01::123::,,;
   Amp01 2002-07-16 09:46:01
M 123 COMPLD
   /* CPY-MEM */
;

Example 9-8 CPY-MEM Command and Response (Copy aolog.txt on FFS as logfile20020716.txt on FFS)

Amp01:ONS15216 EDFA2> CPY-MEM:Amp01::123::aolog.txt,FFS,logfile20020716;
   Amp01 2002-07-16 09:50:38
M 123 COMPLD
   /* CPY-MEM */
;

 

Table 9-13 CPY-MEM Syntax Description 

Parameter
Syntax
Description

fromfile

 

Name of the source file. A null means LOG. Can be null only when fromdev is also null.

LOG

ONS 15216 EDFA2 system log file, only when fromdev is specified to be MEM or null.

any other string

The name of the source file when fromdev is specified to be FFS. If fromdev is specified to be MEM or null, any string other than LOG is invalid.

File names are case sensitive.

fromdev

 

Device on which the source file exists. A null means MEM. Possible values are:

MEM

ONS 15216 EDFA2 non-persistent memory (RAM).

FFS

ONS 15216 EDFA2 persistent memory (flash file system).

tofile

string

The name string of the destination file. A null value is valid only when fromfile is LOG or null and fromdev is MEM or null. When null is valid, the system log file (LOG) is saved as aolog.txt.

File names are case sensitive.

If copying from RAM (MEM) and the destination file name already exists, the destination file is overwritten. If copying from FFS and the destination file name already exists, the execution fails.


9.7.7 DLT-RFILE

Command: DLT-RFILE
Description: Deletes a file from the flash file system (FFS) of the ONS 15216 EDFA2.
Syntax:
DLT-RFILE:[<tid>]::<ctag>::FILE=<localfilename>;

Example 9-9 DLT-RFILE Command

Amp01:ONS15216 EDFA2> DLT-RFILE:Amp01::1234::FILE=snmp.cfg;

Table 9-14 DLT-RFILE Syntax Description 

Parameter
Syntax
Description

localfilename

string

Name of the file on the flash file system of the ONS 15216 EDFA2 that is to be deleted. File names are case sensitive.


9.7.8 DLT-USER-SECU

Command: DLT-USER-SECU
Description: Deletes (removes) an existing user from the system.
Syntax:
DLT-USER-SECU:[<tid>]:<uid>:<ctag>;

Example 9-10 DLT-USER-SECU Command

Amp01:ONS15216 EDFA2> DLT-USER-SECU:Amp01:jsmith:123;

Table 9-15 DLT-USER-SECU Syntax Description 

Parameter
Syntax
Description

uid

string

The user identifier (user name) of the existing user to be removed.


9.7.9 ED-DAT

Command: ED-DAT
Description: Edits the date and/or time of the ONS 15216 EDFA2.
Syntax:
ED-DAT:[<tid>]::<ctag>::<utcdate>,<utctime>;

Example 9-11 ED-DAT Command

Amp01:ONS15216 EDFA2> ED-DAT:Amp01::123::2001-12-18,02-24-55;

Table 9-16 ED-DAT Syntax Description 

Parameter
Syntax
Description

utcdate

yyyy-mm-dd

Change date to this value in universal coordinated time (UTC), which is the same as Greenwich Mean Time (GMT) Modifies cerent15216EdfaRtcDateAndTimeGMTString. Can not be null if utctime is also null.

utctime

hh-mm-ss

Change time to this value in universal coordinated time (UTC), which is the same as Greenwich Mean Time (GMT). (A time zone can not be set using TL1.) Modifies cerent15216EdfaRtcDateAndTimeGMTString. Can not be null if utcdate is also null.


9.7.10 ED-DWDM

Command: ED-DWDM
Description: Configures the ONS 15216 EDFA2 optical control parameters.
Syntax:
ED-DWDM:[<tid>]:<aid>:<ctag>:::[PUMP1CTRLMODE=<pump1ctrlmode>],[PUMP1CTRLVALUE=<pump1ctrlv alue>],[PUMP2CTRLMODE=<pump2ctrlmode>],[PUMP2CTRLVALUE=<pump2ctrlvalue>],[OVERALLGAIN=<gai n>],[PREATT=<preatt>];

Example 9-12 ED-DWDM Command

Amp01:ONS15216 EDFA2> ED-DWDM:Amp01:ALL:123:::PUMP1CTRLMODE=GAINTEMP;

Table 9-17 ED-DWDM Syntax Description 

Parameter
Syntax
Description

aid

1

ALL

1 and ALL have same input effect.

pump1ctrlmode,
pump2ctrlmode

 

Pump 1 or pump 2 control mode (maps to cerent15216EdfaPumpCfgControlMode for the corresponding pump). Generally, pump1ctrlmode and pump2ctrlmode must be the same value. One exception is OPWR which is not valid for pump 1 and can only be set for pump 2. Possible values are:

CRNT

Constant Pump Current mode (cerent15216EdfaPumpCfgControlMode set to constCurrent). Must set pump 1 and pump 2 to this mode at the same time.

PWR

Constant Pump Power mode (cerent15216EdfaPumpCfgControlMode set to constPower). Must set Pump 1 and Pump 2 to this mode at the same time.

OPWR

Constant Output Power mode (cerent15216EdfaPumpCfgControlMode set to constOutputPower). This is not a valid mode for pump 1. If pump 2 is set to OPWR, pump 1 gets automatically set to PWR with a value of 75 mW.

GAINTEMP

Constant Gain Temperature Compensated mode (manufacturer default) (cerent15216EdfaPumpCfgControlMode set to constGainTempComp). If one pump is set to GAINTEMP, the other pump automatically gets set to GAINTEMP also.

pump1ctrlvalue,
pump2ctrlvalue

 

Pump 1 or pump 2 control value. This value's interpretation depends on the control mode of the corresponding pump. Command fails if control mode is GAINTEMP. Possible values are:

0 - 300

Current value in mA when mode is CRNT (sets cerent15216EdfaPumpCfgConstPumpCurrent). The default value is 0. Must set pump 1 and pump 2 at the same time.

0 - 100

Pump power in mW when mode is PWR (sets cerent15216EdfaPumpCfgConstPumpPower). The default value is 0. Must set pump 1 and pump 2 at the same time.

0 - 650

Output power in units of 10 mW when mode is OPWR (sets cerent15216EdfaPumpCfgConstOutPower). The default value is 0.

gain

130 - 220

Value of gain in units of 10 dB when mode is GAINTEMP (sets cerent15216EdfaConstGainOverallGain).

preatt

10 - 100

Gain pre-attenuation value in units of 10 dB when mode is other than GAINTEMP (sets cerent15216EdfaVariableGainPreAttenuation).


9.7.11 ED-ENV

Command: ED-ENV
Description: Configures the ONS 15216 EDFA2 environmental (power bus) parameters.
Syntax:
ED-ENV:[<tid>]:<aid>:<ctag>:::PWRBUSMODE=<pwrbusmode>;

Example 9-13 ED-ENV Command

Amp01:ONS15216 EDFA2> ED-ENV:Amp01:ALL:123:::PWRBUSMODE=SIMPLEX;

Table 9-18 ED-ENV Syntax Description 

Parameter
Syntax
Description

aid

PWR-A

PWR-B

ALL

PWR-A, PWR-B, and ALL have same input effect.

pwrbusmode

 

Power bus mode. Possible values are:

SIMPLEX

Simplex mode. Requires power only to bus A. Sets cerent15216EdfaPowerBusMode to simplex.

DUPLEX

Duplex mode (default). Requires power to both bus A and bus B. Sets cerent15216EdfaPowerBusMode to duplex.


9.7.12 ED-NE-GEN

Command: ED-NE-GEN
Description: Edit general parameters of the ONS 15216 EDFA2. Edits ONS 15216 EDFA2's sid (source identifier)/tid (target identifier), IP address, IP mask, and IP address of the default router. The ONS 15216 EDFA2 needs to be manually rebooted for the changes to take effect. (Use the INI-SYS command to manually reboot after changing parameters.) Also edits the boot table content: to return to the TL1 shell from the ASH shell, use the ASH command shell type modify tl1 (step 3. in "Log In via EIA/TIA-232 Port Using HyperTerminal" section on page 8-1).
Syntax:
ED-NE-GEN:[<tid>]::<ctag>:::[NAME=<name>],[IPADDR=<ipaddr>],[IPMASK=<ipmask>],[DEFRTR=<def rtr>],[BOOTRECORDTYPE1=<bootrectype1>],[BOOTFILENAME1=<bootfilename1>],[BOOTIPADDR1=<booti paddr1>],[BOOTRECORDTYPE2=<bootrectype2>],[BOOTFILENAME2=<bootfilename2>],[BOOTIPADDR2=<bo otipaddr2>],[CLI=<cli>];

Example 9-14 ED-NE-GEN Command

Amp01:ONS15216 EDFA2> ED-NE-GEN:Amp01::123:::NAME=Amp01,IPADDR=192.167.3.4,IPMASK=255.255. 255.0,DEFRTR=192.167.3.20,BOOTRECORDTYPE2=TFTP,BOOTFILENAME2=15216EdfaSw_1.4.0,BOOTIPADDR2 =192.168.3.4,CLI=ASH;

Table 9-19 ED-NE-GEN Syntax Description 

Parameter
Syntax
Description

name

string

System's sid/tid name.

ipaddr

string

IP address of the system (cerent15216EdfaSromIpMgmtEnetAddress).

ipmask

string

Subnet mask of the system (cerent15216EdfaSromIpMgmtEnetSubNetMask).

defrtr

string

IP address of the default router (cerent15216EdfaSromIpMgmtDefaultRouterAddress).

bootrectype1

 

Boot record type (cerent15216EdfaBootType for first entry). Possible values are:

FLASH

Boot from flash.

TFTP

Boot through TFTP.

bootfilename1

string

Boot file name (cerent15216EdfaBootFileName for first entry). File names are case sensitive.

bootipaddr1

string

IP address to boot from if bootrectype1 is set to TFTP (cerent15216EdfaBootIpAddress for first entry).

bootrectype2

 

Boot record type (cerent15216EdfaBootType for second entry). Possible values are:

FLASH

Boot from flash.

TFTP

Boot through TFTP.

bootfilename2

string

Boot file name (cerent15216EdfaBootFileName for second entry). File names are case sensitive.

bootipaddr2

string

IP address to boot from if bootrectype2 is set to TFTP (cerent15216EdfaBootIpAddress for second entry).

cli

 

Default type of command line interface for all EIA/TIA-232 and default telnet port user sessions with the ONS 15216 EDFA2. Possible values are:

TL1

TL1shell interface (manufacturer default).

ASH

ASH shell interface - ONS 15216 EDFA2's native interface.


9.7.13 ED-PID

Command: ED-PID
Description: Edits password.
Syntax:
ED-PID:[<tid>]:<uid>:<ctag>::<oldpid>,<newpid>;

Example 9-15 ED-PID Command

Amp01:ONS15216 EDFA2> ED-PID:Amp01:JOE:123::OLDPW,NEWPW;

Table 9-20 ED-PID Syntax Description 

Parameter
Syntax
Description

uid

string

The user's identifier (user name).

oldpid

string

The user's old password.

newpid

string

The user's new private identifier (password). Must be a string of up to 10 characters, where at least 2 are non-alphabetic characters and at least 1 is a special character. Special characters are +, #, %, etc. (defined in Telcordia GR-831-CORE).


9.7.14 ED-USER-SECU

Command: ED-USER-SECU
Description: Edits the user identifier, password and access level of an existing user. Per TR-835, only those data parameters that are to be edited are entered while those that are unaffected are omitted. If any position-defined parameter is omitted, a comma is to be used as the delimiter.
Syntax:
ED-USER-SECU:[<tid>]:<uid>:<ctag>::<newuid>,<pid>,,<al>[:];

Example 9-16 ED-USER-SECU Command

Amp01:ONS15216 EDFA2> ED-USER-SECU:Amp01:jsmith:123::johnsmith,****,,RW;

Table 9-21 ED-USER-SECU Syntax Description 

Parameter
Syntax
Description

uid

string

The user identifier (user name) of the existing user whose parameters are being modified.

newuid

string

New user identifier (user name) for the existing user. Can be any combination of up to 10 alphanumeric characters.

pid

string

The user's new private identifier (password). Must be a string of up to 10 characters, where at least 2 are non-alphabetic characters and at least 1 is a special character. Special characters are +, #, %, etc. (defined in Telcordia GR-831-CORE).

al

 

New access level of the user. See "Summary of Security Permissions for TL1 Commands" section for access level permissions.

R

Read only privileges.

RW

Read and write privileges.

RWA

Read, write, and administrative privileges.


9.7.15 ENT-USER-SECU

Command: ENT-USER-SECU
Description: Creates a new user in the system; specifies the user identifier, password and access level of the new user.
Syntax:
ENT-USER-SECU:[<tid>]:<uid>:<ctag>::<pid>,,<al>[:];

Example 9-17 ENT-USER-SECU Command

Amp01:ONS15216 EDFA2> ENT-USER-SECU:Amp01:jsmith:123::****,,RW;

Table 9-22 ENT-USER-SECU Syntax Description 

Parameter
Syntax
Description

uid

string

The user identifier (user name) of the new user being created. Can be any combination of up to 10 alphanumeric characters.

pid

string

The user's private identifier (password). Must be a string of up to 10 characters, where at least 2 are non-alphabetic characters and at least 1 is a special character. Special characters are +, #, %, etc. (defined in Telcordia GR-831-CORE).

al

 

Access level of the user. See "Summary of Security Permissions for TL1 Commands" section for access level permissions.

R

Read only privileges.

RW

Read and write privileges.

RWA

Read, write, and administrative privileges.


9.7.16 INH-MSG-ALL

Command: INH-MSG-ALL
Description: Prohibits the dispatch of some automatic messages from the ONS 15216 EDFA2 as specified in the parameters. Does not affect response from RTRV commands.
Syntax:
INH-MSG-ALL:[<tid>]::<ctag>::[<ntfcncde>],[<condtype>][,];

Example 9-18 INH-MSG-ALL Command

Amp01:ONS15216 EDFA2> INH-MSG-ALL:Amp01::123::MJ,LOS;

Table 9-23 INH-MSG-ALL Syntax Description 

Parameter
Syntax
Description

ntfncde

 

Notification code of the alarm or event that is to be inhibited (maps to cerent15216EdfaAlarmPriority for active alarms). A null maps to none of the codes, i.e., with a null, all existing ntfncde allowances are kept unchanged. Possible values are:

MJ

Major alarm.

MN

Minor alarm.

NA

No alarm.

CL

Cleared alarm.

condtype

 

Condition type of the alarm or event that is to be inhibited (maps to cerent15216EdfaLogEventID). ALL maps to all types. A null maps to none of the types, i.e., with a null, all existing condtype allowances are kept unchanged. Possible condtype and corresponding conddescr (in quotes) are:

LOS

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

CTMP

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

POWERBUSA

"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).

POWERBUSB

"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).

CTRLMODE1

"Pump1 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=1).

CTRLMODE2

"Pump2 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=2).

 

GAINCHGD

"Overall Gain Changed" (cerent15216EdfaConstGainOverallGain).

LOSHYSTCHGD

"LOS (loss of signal) Hysteresis Changed" (cerent15216EdfaLOSHysteresis).

LOSTHCHGD

"LOS (loss of signal) Threshold Changed" (cerent15216EdfaLOSThreshold).

LPOUTCHGD

"Loss of Output Power Setpoint Changed" (cerent15216EdfaLpoutSetpoint).

LPOUTDEVCHGD

"Lpout (loss of output power) Deviation Changed" (cerent15216EdfaLpoutDeviation).

LPOUTHYSTCHGD

"Lpout (loss of output power) Hysteresis Changed" (cerent15216EdfaLpoutHysteresis).

PREATTCHGD

"Pre-attenuation Changed" (cerent15216EdfaVariableGainPreAttenuation).

PWRBUSMAXCHGD

"Power Bus Max (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMax).

PWRBUSMINCHGD

"Power Bus Min (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMin).

PWRBUSMODE

"Power Bus Mode Changed" (cerent15216EdfaPowerBusMode).

MAXCTMPCHGD

"Max Case Temperature Changed" (cerent15216EdfaCtmpMax).

MAXCTMPHYSTCHGD

"Max Ctmp (case temperature) Hysteresis Changed" (cerent15216EdfaCtmpMaxHysteresis).

MINCTMPCHGD

"Min Case Temperature Changed" (cerent15216EdfaCtmpMin).

MINCTMPHYSTCHGD

"Min Ctmp (case temperature) Hysteresis Changed" (cerent15216EdfaCtmpMinHysteresis).

CUTOVERRESET

(Software) "Reset after Cutover" (cerent15216EdfaOpCutover).

SOFTWARELOAD

(New) "Software Load" (cerent15216EdfaOpLoad).

SOFTWARERESET

"Software Reset" (cerent15216EdfaOpReset).

ALL

All condtype preceding.


9.7.17 INIT-SYS

Command: INIT-SYS
Description: Reboots the system.
Syntax:
INIT-SYS:[<tid>]:<aid>:<ctag>::<ph>;

Example 9-19 INIT-SYS Command

Amp01:ONS15216 EDFA2> INIT-SYS:Amp01:ALL:1234::1;

Table 9-24 INIT-SYS Syntax Description 

Parameter
Syntax
Description

aid

string

EQPT

ALL

EQPT and ALL have same input effect.

ph

integer

1

Level of initialization. Always 1.


9.7.18 REPT ALM DWDM

Command: REPT ALM DWDM
Description: Reports when a DWDM alarm is logged or cleared (derived from cerent15216EdfaAlarmState).

Note The REPT ALM DWDM messages for Loss of Signal, Gain Out of Range, and Loss of Output Power are prioritized (in the order just listed) so that only one message can be delivered at one time. For example, if the ONS 15216 EDFA2 detects both a loss of input signal and a loss of output power at the same time, it will deliver only the Loss of Signal message to the user. This prioritized filtering of alarms does not occur with the SNMP delivery of alarms of the ONS 15216 EDFA2.


Syntax:
   <sid> <date> <time>
<almcde> <atag> REPT ALM DWDM
   "<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;

Example 9-20 REPT ALM DWDM Message

   Amp01 2001-06-18 14:50:44
** 142 REPT ALM DWDM
   "1:MJ,LOS,SA,6-18,14-50-44,,:\"Loss Of Signal\""
;

Table 9-25 REPT ALM DWDM Syntax Description 

Parameter
Syntax
Description

time

hh:mm:ss

Time of origination of TL1 message.

almcde

 

The alarm severity code for the TL1 message. Possible values are:

**

Major alarm.

*

Minor alarm.

A

No alarm. Occurs only when ntfncde is NA.

atag

0 - 999

An integer between 0 and 999 used as a sequence number in autonomous messages.

aid

 

Always 1.

1

Directly affecting the optical signal.

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

LOS

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.


9.7.19 REPT ALM ENV

Command: REPT ALM ENV
Description: Reports when a power bus alarm is logged or cleared (derived from cerent15216EdfaAlarmState).
Syntax:
   <sid> <date> <time>
<almcde> <atag> REPT ALM ENV
   "<aid>:<ntfcncde>,<condtype>,<ocrdat>,<ocrtm>,<conddescr>"
;

Example 9-21 REPT ALM ENV Message

   Amp01 2001-06-18 14:48:44
** 141 REPT ALM ENV
   "PWR-A:MJ,PWRBUSA,6-18,14-48-44,\"Power Bus A Alarm\""
;

Table 9-26 REPT ALM ENV Syntax Description 

Parameter
Syntax
Description

almcde

The alarm severity code for the TL1 message. Possible values are:

**

Major alarm.

*

Minor alarm.

A

No alarm. Occurs only when ntfncde is NA.

atag

0 - 999

An integer between 0 and 999 used as a sequence number in autonomous messages .

aid

 

Possible values are:

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

PWRBUSA

"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).

PWRBUSB

"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.20 REPT ALM EQPT

Command: REPT ALM EQPT
Description: Reports when a general alarm (not directly affecting optical signal or power bus) is logged or cleared (derived from cerent15216EdfaAlarmState).
Syntax:
   <sid> <date> <time>
<almcde> <atag> REPT ALM EQPT
   "<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;

Example 9-22 REPT ALM EQPT Message

   Amp01 2001-06-18 14:48:44
* 141 REPT ALM EQPT
   "EQPT:MN,LCRNT1,NSA,6-18,14-48-44,,:\"Excessive Pump1 Current\""
;

Table 9-27 REPT ALM EQPT Syntax Description 

Parameter
Syntax
Description

almcde

 

The alarm severity code for the TL1 message. Possible values are:

**

Major alarm.

*

Minor alarm.

A

No alarm. Occurs only when ntfncde is NA.

atag

0 - 999

An integer between 0 and 999 used as a sequence number in autonomous messages .

aid

 

Always EQPT.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

CTMP

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.21 REPT EVT DWDM / REPT EVT ENV / REPT EVT EQPT

Command: REPT EVT DWDM or REPT EVT ENV or REPT EVT EQPT
Description: Reports autonomous events. Reports when an event is logged.
Syntax:
   <sid> <date> <time>
A <atag> REPT EVT <ccm>
   "<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,,,,:<conddescr>"
;

Example 9-23 REPT EVT DWDM Message

   Amp01 2001-06-18 14:48:44
A 141 REPT EVT DWDM
   "1:CTRLMODE1,TC,6-18,14-48-44,,,,:\"Pump1 Control Mode Changed\""
;

Table 9-28 REPT EVT DWDM / REPT EVT ENV / REPT EVT EQPT Syntax Description 

Parameter
Syntax
Description

atag

0 - 999

An integer between 0 and 999 used as a sequence number in autonomous messages .

aid

 

Possible values are:

1

Directly affecting the optical signal.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype
(ccm)

 

Condition type identifies the type of event (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

 

CTRLMODE1
(DWDM)

"Pump1 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=1).

 

CTRLMODE2
(DWDM)

"Pump2 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=2).

 

GAINCHGD
(DWDM)

"Overall Gain Changed" (cerent15216EdfaConstGainOverallGain).

 

LOSHYSTCHGD
(DWDM)

"LOS (loss of signal) Hysteresis Changed" (cerent15216EdfaLOSHysteresis).

 

LOSTHCHGD
(DWDM)

"LOS (loss of signal) Threshold Changed" (cerent15216EdfaLOSThreshold).

 

LPOUTCHGD
(DWDM)

"Loss of Output Power Setpoint Changed" (cerent15216EdfaLpoutSetpoint).

 

LPOUTDEVCHGD
(DWDM)

"Lpout (loss of output power) Deviation Changed" (cerent15216EdfaLpoutDeviation).

 

LPOUTHYSTCHGD
(DWDM)

"Lpout (loss of output power) Hysteresis Changed" (cerent15216EdfaLpoutHysteresis).

 

PREATTCHGD
(DWDM)

"Pre-attenuation Changed" (cerent15216EdfaVariableGainPreAttenuation).

 

PWRBUSMAXCHGD
(EVN)

"Power Bus Max (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMax).

 

PWRBUSMINCHGD
(EVN)

"Power Bus Min (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMin).

 

PWRBUSMODE
(EVN)

"Power Bus Mode Changed" (cerent15216EdfaPowerBusMode).

 

MAXCTMPCHGD
(EQPT)

"Max Case Temperature Changed" (cerent15216EdfaCtmpMax).

condtype
(ccm)

MAXCTMPHYSTCHGD
(EQPT)

"Max Ctmp (case temperature) Hysteresis Changed" (cerent15216EdfaCtmpMaxHysteresis).

 

MINCTMPCHGD
(EQPT)

"Min Case Temperature Changed" (cerent15216EdfaCtmpMin).

 

MINCTMPHYSTCHGD
(EQPT)

"Min Ctmp (case temperature) Hysteresis Changed" (cerent15216EdfaCtmpMinHysteresis).

 

CUTOVERRESET
(EQPT)

(Software) "Reset after Cutover" (cerent15216EdfaOpCutover).

 

SOFTWARELOAD
(EQPT)

(New) "Software Load" (cerent15216EdfaOpLoad).

 

SOFTWARERESET
(EQPT)

"Software Reset" (cerent15216EdfaOpReset).

condeff

string

TC

Effect of the condition. Always TC (transient condition).

date

yyyy-mm-dd

Date of origination of TL1 message.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.22 REPT EVT FXFR

Command: REPT EVT FXFR
Description: Reports autonomous events related to the FTP file transfer (see "COPY-RFILE" section). Reports when an event related to the file transfer is logged.
Syntax:
   <sid> <date> <time>
A <atag> REPT EVT FXFR
   "<aid>:<filename>,<fxfr_status>[,<fxfr_rslt>][,<bytes_xfrd>]"
;

Example 9-24 REPT EVT FXFR Message

   Amp01 2001-06-18 14:48:44
A 141 REPT EVT FXFR
   "EQPT:VMRLS20.EXE,COMPLD,SUCCESS,8051"
;

Table 9-29 REPT EVT FXFR Syntax Description 

Parameter
Syntax
Description

atag

0 - 999

An integer between 0 and 999 used as a sequence number in autonomous messages.

aid

 

Always EQPT.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

bytes_xfrd

 

Total number of bytes transferred when fxfr_status is COMPLD. See fxfr_status below.

filename

 

Identifies the name of the file that is being transferred.

fxfr_rslt

 

File transfer result indicates success or failure of the file transfer. This is displayed only when the file transfer has completed (i.e., fxfr_status is COMPLD). Possible values are:

SUCCESS

File transfer was successful.

FAILURE

File transfer failed.

fxfr_status

 

File transfer status of ONS 15216 EDFA2's file transfer at the current time. (The option IP (in progress) has not been implemented.) Possible values are:

START

File transfer has started.

COMPLD

File transfer has completed.

date

yyyy-mm-dd

Date of origination of TL1 message.

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.23 RTRV-ALM-ALL

Command: RTRV-ALM-ALL
Description: Generates a report on all active alarms (except environmental (ENV) alarms as per Telcordia GR-833-CORE). Note that the ccm does not appear in the response for EQPT alarms.

Note The messages for Loss of Signal (LOS), Gain Out of Range (GAIN), and Loss of Output Power (LPOUT) are prioritized (in the order just listed) so that only one message can be delivered at one time. For example, if the ONS 15216 EDFA2 detects both a loss of input signal and a loss of output power at the same time, it will deliver only the Loss of Signal (LOS) message to the user. This prioritized filtering of alarms does not occur with the SNMP delivery of alarms of the ONS 15216 EDFA2.


Syntax:
RTRV-ALM-ALL:[<tid>]::<ctag>::[<ntfcncde>],[<condtype>],[<srveff>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;

Example 9-25 RTRV-ALM-ALL Command and Response

Amp01:ONS15216 EDFA2> RTRV-ALM-ALL:Amp01::229::MN,LCRNT1,NSA,,;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "1,DWDM:MJ,LOS,SA,6-20,14-25-30,,:\"Loss Of Signal\""
   "EQPT,EQPT:MN,LCRNT1,NSA,6-20,14-25-30,,:\"Excessive Pump1 Current\""
;

Table 9-30 RTRV-ALM-ALL Syntax Description 

Parameter
Syntax
Description

aid

 

Possible values are:

1

Directly affecting the optical signal

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus)

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below

condtype
(ccm)

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

LOS
(DWDM)

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN
(DWDM)

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT
(DWDM)

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

CTMP
(EQPT)

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1
(EQPT)

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2
(EQPT)

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1
(EQPT)

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2
(EQPT)

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.24 RTRV-ALM-DWDM

Command: RTRV-ALM-DWDM
Description: Generates a report on active DWDM alarms.

Note The messages for Loss of Signal (LOS), Gain Out of Range (GAIN), and Loss of Output Power (LPOUT) are prioritized (in the order just listed) so that only one message can be delivered at one time. For example, if the ONS 15216 EDFA2 detects both a loss of input signal and a loss of output power at the same time, it will deliver only the Loss of Signal (LOS) message to the user. This prioritized filtering of alarms does not occur with the SNMP delivery of alarms of the ONS 15216 EDFA2.


Syntax:
RTRV-ALM-DWDM:[<tid>]:<aid>:<ctag>::[<ntfcncde>],[<condtype>],[<srveff>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;

Example 9-26 RTRV-ALM-DWDM Command and Response

Amp01:ONS15216 EDFA2> RTRV-ALM-DWDM:Amp01:ALL:229::,,;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "1,DWDM:MJ,LOS,SA,6-20,14-25-30,,:\"Loss Of Signal\""
;

Table 9-31 RTRV-ALM-DWDM Syntax Description 

Parameter
Syntax
Description

aid

 

1 and ALL have same input effect.

1

Directly affecting the optical signal.

ALL

Any or all of the preceding (command input only).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

LOS

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.25 RTRV-ALM-ENV

Command: RTRV-ALM-ENV
Description: Generates a report on specific or all active environmental (power bus) alarms.
Syntax:
RTRV-ALM-ENV:[<tid>]:<aid>:<ctag>::[<ntfcncde>],[<condtype>];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,<ccm>:<ntfcncde>,<condtype>,<ocrdat>,<ocrtm>,<conddescr>"
;

Example 9-27 RTRV-ALM-ENV Command and Response

Amp01:ONS15216 EDFA2> RTRV-ALM-ENV:Amp01:ALL:229::MJ,PWRBUSA;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "PWR-A,ENV:MJ,PWRBUSA,6-20,14-25-30,\"Power Bus A Alarm\""
;

Table 9-32 RTRV-ALM-ENV Syntax Description 

Parameter
Syntax
Description

aid

 

Specifying PWR-A or PWR-B in input has a filter effect on the response.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

ALL

Any or all of the preceding (command input only).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

PWRBUSA

"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).

PWRBUSB

"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.26 RTRV-ALM-EQPT

Command: RTRV-ALM-EQPT
Description: Generates a report on all active alarms (except environmental alarms as per Telcordia GR-833-CORE).
Syntax:
RTRV-ALM-EQPT:[<tid>]:<aid>:<ctag>::[<ntfcncde>],[<condtype>],[<srveff>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;

Example 9-28 RTRV-ALM-EQPT Command and Response

Amp01:ONS15216 EDFA2> RTRV-ALM-EQPT:Amp01:ALL:229::MN,LCRNT1,NSA,,;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "EQPT:MN,LCRNT1,NSA,6-20,14-25-30,,:\"Excessive Pump1 Current\""
;

Table 9-33 RTRV-ALM-EQPT Syntax Description 

Parameter
Syntax
Description

aid

 

EQPT and ALL have same input effect.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

CTMP

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

CL

Cleared alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.27 RTRV-AO

Command: RTRV-AO
Description: Retrieves autonomous output.
Allows the operating system to retrieve a copy of queued autonomous messages or missing autonomous messages. Examples of autonomous messages are REPT ALM and REPT EVT.
Users can retrieve up to the latest 1000 autonomous messages (alarms and events). Normally, users should limit the retrieval to less than 200 messages to prevent alarm reporting and other active users from being impacted. To retrieve more than 200 messages, it is recommended that the user saves the autonomous message log to a file using the CPY-MEM command and then get the file through FTP using the COPY-RFILE command.
If none of the stored automatic messages satisfy the selection criteria, then a complete normal response is sent. If one or more stored autonomous messages satisfy the criteria, then the messages should be reported in the normal response in ATAG order.
Syntax:
RTRV-AO:[<tid>]::<ctag>:::[ATAGSEQ=<atagseq>][,MSGTYPE=<msgtype>];

Example 9-29 RTRV-AO Command

Amp01:ONS15216 EDFA2> RTRV-AO:Amp01::123:::ATAGSEQ=20&&30,MSGTYPE=EVT;

Table 9-34 RTRV-AO Syntax Description 

Parameter
Syntax
Description

atagseq

 

atag is an integer between 0 and 999 used by the ONS 15216 EDFA2 to sequentially number in autonomous messages. atagseq can be a single atag number or a range of numbers in the form AA&&BB, where AA and BB are integers. If null, the 20 latest messages will be retrieved.

msgtype

 

Type of message. A null value means both ALM and EVT.

ALM

Alarm message.

EVT

Event message.


9.7.28 RTRV-COND-ALL

Command: RTRV-COND-ALL
Description: Generates a report on the condition (state) of all alarms (except environmental alarms). Note that the ccm does not appear in the response for EQPT alarms.

Note The messages for Loss of Signal (LOS), Gain Out of Range (GAIN), and Loss of Output Power (LPOUT) are prioritized (in the order just listed) so that only one message can be delivered at one time. For example, if the ONS 15216 EDFA2 detects both a loss of input signal and a loss of output power at the same time, it will deliver only the Loss of Signal (LOS) message to the user. This prioritized filtering of alarms does not occur with the SNMP delivery of alarms of the ONS 15216 EDFA2.


Syntax:
RTRV-COND-ALL:[<tid>]::<ctag>::[<condtype>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;

Example 9-30 RTRV-COND-ALL Command and Response

Amp01:ONS15216 EDFA2> RTRV-COND-ALL:Amp01::229::LCRNT1;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "1,DWDM:MJ,LOS,SA,6-20,14-25-30,,,\"Loss Of Signal\""
   "EQPT,EQPT:MN,LCRNT1,NSA,6-20,14-25-30,,,\"Excessive Pump1 Current\""
;

Table 9-35 RTRV-COND-ALL Syntax Description 

Parameter
Syntax
Description

aid

 

Possible values are:

1

Directly affecting the optical signal.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype
(ccm)

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

LOS
(DWDM)

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN
(DWDM)

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT
(DWDM)

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

CTMP
(EQPT)

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1
(EQPT)

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2
(EQPT)

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1
(EQPT)

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2
(EQPT)

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.29 RTRV-COND-DWDM

Command: RTRV-COND-DWDM
Description: Generates a report on the condition (state) of DWDM alarms.

Note The messages for Loss of Signal (LOS), Gain Out of Range (GAIN), and Loss of Output Power (LPOUT) are prioritized (in the order just listed) so that only one message can be delivered at one time. For example, if the ONS 15216 EDFA2 detects both a loss of input signal and a loss of output power at the same time, it will deliver only the Loss of Signal (LOS) message to the user. This prioritized filtering of alarms does not occur with the SNMP delivery of alarms of the ONS 15216 EDFA2.


Syntax:
RTRV-COND-DWDM:[<tid>]:<aid>:<ctag>::[<condtype>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;

Example 9-31 RTRV-COND-DWDM Command and Response

Amp01:ONS15216 EDFA2> RTRV-COND-DWDM:Amp01:ALL:229::LOS;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "1,DWDM:MJ,LOS,SA,6-20,14-25-30,,,\"Loss Of Signal\""
;

Table 9-36 RTRV-COND-DWDM Syntax Description 

Parameter
Syntax
Description

aid

 

1 and ALL have same input effect.

1

Directly affecting the optical signal.

ALL

Any or all of the preceding (command input only).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

LOS

"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).

GAIN

"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).

LPOUT

"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.30 RTRV-COND-ENV

Command: RTRV-COND-ENV
Description: Generates a report on the condition (state) of environmental (power bus) alarms.
Syntax:
RTRV-COND-ENV:[<tid>]:<aid>:<ctag>::[<condtype>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;

Example 9-32 RTRV-COND-ENV Command and Response

Amp01:ONS15216 EDFA2> RTRV-COND-ENV:Amp01:ALL:229::PWRBUSA;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "PWR-A,ENV:MJ,PWRBUSA,NSA,6-20,14-25-30,,,\"Power Bus A Alarm\""
;

Table 9-37 RTRV-COND-ENV Syntax Description 

Parameter
Syntax
Description

aid

 

Specifying PWR-A or PWR-B in input has a filter effect on the response.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

ALL

Any or all of the preceding (command input only).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

PWRBUSA

"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).

PWRBUSB

"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.31 RTRV-COND-EQPT

Command: RTRV-COND-EQPT
Description: Generates a report on the condition (state) of general alarms.
Syntax:
RTRV-COND-EQPT:[<tid>]:<aid>:<ctag>::[<condtype>][,,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;

Example 9-33 RTRV-COND-EQPT Command and Response

Amp01:ONS15216 EDFA2> RTRV-COND-EQPT:Amp01:ALL:229::LCRNT1;
   Amp01 2002-06-20 14:30:00
M 229 COMPLD
   "EQPT:MN,LCRNT1,NSA,6-20,14-25-30,,,\"Excessive Pump1 Current\""
;

Table 9-38 RTRV-COND-EQPT Syntax Description 

Parameter
Syntax
Description

aid

 

EQPT and ALL have same input effect.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).

conddescr

 

Detailed text description of the event. The conddescr is 1 to 64 characters of ASCII text. See condtype below.

condtype

 

Condition type identifies the type of alarm (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:

CTMP

"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).

LCRNT1

"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).

LCRNT2

"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).

LTMP1

"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).

LTMP2

"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).

date

yyyy-mm-dd

Date of origination of TL1 message.

ntfncde

 

Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:

MJ

Major alarm.

MN

Minor alarm.

NA

No alarm.

ocrdat

m-d

Date (month-day) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

ocrtm

h-m-s

Time (hour-minute-second) of the event occurrence (derived from cerent15216EdfaDateAndTimeString).

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

srveff

 

Effect on service. Possible values are:

SA

Service affecting.

NSA

Non-service affecting.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.32 RTRV-DFLT-SECU

Command: RTRV-DFLT-SECU
Description: Retrieves the timeout value(s) for user access level(s).
Syntax:
RTRV-DFLT-SECU:[<tid>]:<aid>:<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:AL=<al>,TMOUT=<timeout>"
;

Example 9-34 RTRV-DFLT-SECU Command and Response

Amp01:ONS15216 EDFA2> RTRV-DFLT-SECU:Amp01:ALL:123;
   Amp01 2002-01-12 08:01:05
M 123 COMPLD
   "EQPT:AL=R,TMOUT=60"
   "EQPT:AL=RW,TMOUT=30"
   "EQPT:AL=RWA,TMOUT=15"
;

Table 9-39 RTRV-DFLT-SECU Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

EQPT and ALL have same input effect.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).

al

 

Access level of the user. See "Summary of Security Permissions for TL1 Commands" section for access level permissions.

R

Read only privileges.

RW

Read and write privileges.

RWA

Read, write, and administrative privileges.

timeout

integer

Timeout in minutes.


9.7.33 RTRV-DWDM

Command: RTRV-DWDM
Description: Retrieves the ONS 15216 EDFA2 optical control configuration.
Syntax:
RTRV-DWDM:[<tid>]:<aid>:<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:INPWRMICROW=<inputpoweruw>,INPWRDBM=<inputpowerdbm>,OUTPWRMILLIW=<outputpowermw> ,OUTPWRDBM=<outputpowerdbm>,PUMP1CTRLMODE=<pump1ctrlmode>,PUMP1CTRLVALUE=<pump1ctrlvalue>, PUMP2CTRLMODE=<pump2ctrlmode>,PUMP2CTRLVALUE=<pump2ctrlvalue>,OVERALLGAINMEASURED=<gainmea sured>,PREATTMEASURED=<preattmeasured>"
;

Example 9-35 RTRV-DWDM Command and Response

Amp01:ONS15216 EDFA2> RTRV-DWDM:Amp01:ALL:123;
   Amp01 2002-06-20 14:30:00
M 124 COMPLD
   "1:INPWRMICROW=264,INPWRDBM=-1578,OUTPWRMILLIW=172,OUTPWRDBM=237,PUMP1CTRLMODE=GAINTEMP ,PUMP1CTRLVALUE=169,PUMP2CTRLMODE=GAINTEMP,PUMP2CTRLVALUE=169,OVERALLGAINMEASURED=169,PREA TTMEASURED=60"
;

Table 9-40 RTRV-DWDM Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

1 and ALL have same input effect.

1

Directly affecting the optical signal.

ALL

Any or all of the preceding (command input only).

inputpoweruw

0 - 99999

Input power (signal) in units of 10 microW (cerent15216EdfaInPoweruW).

inputpowerdbm

-999999 - 999999

Input power (signal) in units of 100 dBm (cerent15216EdfaInPowerdBm).

outputpowermw

0 - 999999

Output power in units of 100 mW (cerent15216EdfaOutPowermW).

outputpowerdbm

-99999 - 99999

Output power in units of 100 dBm (cerent15216EdfaOutPowerdBm).

pump1ctrlmode, pump2ctrlmode

 

Pump 1 or pump 2 control mode (maps to cerent15216EdfaPumpCfgControlMode for the corresponding pump). Possible values are:

CRNT

Constant Pump Current mode (cerent15216EdfaPumpCfgControlMode set to constCurrent).

PWR

Constant Pump Power mode (cerent15216EdfaPumpCfgControlMode set to constPower).

OPWR

Constant Output Power mode (cerent15216EdfaPumpCfgControlMode set to constOutputPower). A valid mode only for pump 2.

GAINTEMP

Constant Gain Temperature Compensated mode (manufacturer default) (cerent15216EdfaPumpCfgControlMode set to constGainTempComp).

IDLE

Pump is shut down (cerent15216EdfaPumpCfgControlMode set to idle).

pump1ctrlvalue,
pump2ctrlvalue

 

Pump 1 or pump 2 control value. This value's interpretation depends on the control mode of the corresponding pump. Possible values are:

0 - 300

Current value in mA when mode is CRNT (gets cerent15216EdfaPumpCfgConstPumpCurrent).

0 - 100

Pump power in mW when mode is PWR (gets cerent15216EdfaPumpCfgConstPumpPower).

0 - 650

Output power in units of 10 mW when mode is OPWR (gets cerent15216EdfaPumpCfgConstOutPower).

gainmeasured

0 - 230

Value of gain in units of 10 dB when mode is GAINTEMP (gets cerent15216EdfaConstGainOverallGainMeasured).

preattmeasured

0 - 110

Gain pre-attenuation value in units of 10 dB (gets cerent15216EdfaVariableGainPreAttenuationMeasured).


9.7.34 RTRV-ENV

Command: RTRV-ENV
Description: Retrieves the ONS 15216 EDFA2 environmental parameter configuration.
Syntax:
RTRV-ENV:[<tid>]:<aid>:<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:PWRBUSMODE=<pwrbusmode>"
;

Example 9-36 RTRV-ENV Command and Response

Amp01:ONS15216 EDFA2> RTRV-ENV:Amp01:ALL:123;
   Amp01 2002-06-20 14:30:00
M 123 COMPLD
   "PWR-B:PWRBUSMODE=DUPLEX"
;

Table 9-41 RTRV-ENV Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

PWR-A, PWR-B, and ALL have same input effect.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

ALL

Any or all of the preceding (command input only).

pwrbusmode

 

Power bus mode setting (cerent15216EdfaPowerBusMode). Possible values are:

SIMPLEX

Simplex mode. Requires power only to bus A (cerent15216EdfaPowerBusMode set to simplex).

DUPLEX

Duplex mode (manufacturer default). Requires power to both bus A and B. (cerent15216EdfaPowerBusMode set to duplex).


9.7.35 RTRV-HDR

Command: RTRV-HDR
Description: Retrieves header. Sends standard keep-alive message used to ping the ONS 15216 EDFA2. It also returns the current date, time, and sid/tid name of the ONS 15216 EDFA2 in the reply.
Syntax:
RTRV-HDR:[<tid>]::<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
;

Example 9-37 RTRV-HDR Command and Response

Amp01:ONS15216 EDFA2> RTRV-HDR:Amp01::100;
   Amp01 2001-06-08 08:10:50
M 100 COMPLD
;

Table 9-42 RTRV-HDR Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.


9.7.36 RTRV-INV

Command: RTRV-INV
Description: Retrieves the inventory information of the ONS 15216 EDFA2.
Syntax:
RTRV-INV:[<tid>]:<aid>:<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:CLEI=<cleicode>,DESCR=<descr>,NAME=<name>,HARDWAREREV=<hwrev>, FIRMWAREREV=<fwrev>,SOFTWAREREV=<swrev>,SERIALNUM=<serialnum>,MFGNAME=<mfg>,MODELNAME=<mod el>"
;

Example 9-38 RTRV-INV Command and Response

Amp01:ONS15216 EDFA2> RTRV-INV:Amp01:ALL:123;
   Amp01 2002-01-12 08:01:05
M 123 COMPLD
   "EQPT:CLEI=IPI01AA0AAA,DESCR=ONS15216EDFA2,NAME=Amp01,HARDWAREREV=v3.0.0, FIRMWAREREV=v1.3.1,SOFTWAREREV=v2.1.7,SERIALNUM=DIT0533000P,MFGNAME=Cisco Systems,MODELNAME=511112"
;

Table 9-43 RTRV-INV Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

EQPT and ALL have same input effect.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).

cleicode

string

CLEI code (cerent15216EdfaCLEI).

descr

string

System description (cerent15216EdfaPhysicalDescr).

fwrev

string

Firmware revision number (cerent15216EdfaPhysicalFirmwareRev).

hwrev

string

Hardware revision number (cerent15216EdfaPhysicalHardwareRev).

mfg

string

Manufacturer name (cerent15216EdfaPhysicalMfgName).

model

string

Model name (cerent15216EdfaPhysicalModelName).

name

string

System's sid/tid name (does not map to an SNMP attribute).

serialnum

string

System serial number (cerent15216EdfaPhysicalSerialNum).

swrev

string

Software revision number (cerent15216EdfaPhysicalSoftwareRev).


9.7.37 RTRV-NE-GEN

Command: RTRV-NE-GEN
Description: Retrieves general parameters of the ONS 15216 EDFA2. Retrieves sid/tid name, IP address and mask, and default router information. Also retrieves the boot table content.
Syntax:
RTRV-NE-GEN:[<tid>]::<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:NAME=<name>,IPADDR=<ipaddr>,IPMASK=<ipmask>,DEFRTR=<defrtr>, BOOTRECORDTYPE1=<bootrectype1>, BOOTFILENAME1=<bootfilename1>,BOOTIPADDR1=<bootipaddr1>, BOOTRECORDTYPE2=<bootrectype2>,BOOTFILENAME2=<bootfilename2>, BOOTIPADDR2=<bootipaddr2>,CLI=<cli>"
;

Example 9-39 RTRV-NE-GEN Command and Response

Amp01:ONS15216 EDFA2> RTRV-NE-GEN:Amp01::123;
   Amp01 2002-01-12 08:01:05
M 123 COMPLD
   "EQPT:NAME=Amp01,IPADDR=172.22.87.100,IPMASK=255.255.255.0,DEFRTR=172.22
.87.2,BOOTRECORDTYPE1=FLASH,BOOTFILENAME1=15216EdfaSw_2.1.0,BOOTIPADDR1=0.0.0.0,
BOOTRECORDTYPE2=TFTP,BOOTFILENAME2=bin/15216EdfaSw_2.0.1,BOOTIPADDR2=1
72.22.128.249,CLI=TL1"
;

Table 9-44 RTRV-NE-GEN Syntax Description 

Parameter
Syntax
Description

aid

 

Always EQPT.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

name

string

System's sid/tid name.

ipaddr

string

IP address of the system (cerent15216EdfaSromIpMgmtEnetAddress).

ipmask

string

Subnet mask of the system (cerent15216EdfaSromIpMgmtEnetSubNetMask).

defrtr

string

IP address of the default router (cerent15216EdfaSromIpMgmtDefaultRouterAddress).

bootrectype1

 

Boot record type (cerent15216EdfaBootType for first entry). Possible values are:

FLASH

Boot from flash.

TFTP

Boot through TFTP.

bootfilename1

string

Boot file name (cerent15216EdfaBootFileName for first entry). File names are case sensitive.

bootipaddr1

string

IP address to boot from if bootrectype1 is set to TFTP (cerent15216EdfaBootIpAddress for first entry).

bootrectype2

 

Boot record type (cerent15216EdfaBootType for second entry). Possible values are:

FLASH

Boot from flash.

TFTP

Boot through TFTP.

bootfilename2

string

Boot file name (cerent15216EdfaBootFileName for second entry). File names are case sensitive.

bootipaddr2

string

IP address to boot from if bootrectype2 is set to TFTP (cerent15216EdfaBootIpAddress for second entry).

cli

 

Default type of command line interface for all EIA/TIA-232 and default telnet port user sessions with the ONS 15216 EDFA2. Possible values are:

TL1

TL1shell interface (manufacturer default).

ASH

ASH shell interface - ONS 15216 EDFA2's native interface.


9.7.38 RTRV-RFILE

Command: RTRV-RFILE
Description: Lists a specific file or all files on the flash file system of the ONS 15216 EDFA2.
Syntax:
RTRV-RFILE:[<tid>]::<ctag>::[<localfilename>+];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:<localfilename>"
;

Example 9-40 RTRV-RFILE Command and Response (List all Files)

Amp01:ONS15216 EDFA2> RTRV-RFILE:Amp01::123::;
   Amp01 2002-01-12 08:01:05
M 123 COMPLD
   "EQPT:snmp.cfg,15216EdfaSw_2.1.0,passwd"
;

Example 9-41 RTRV-RFILE Command and Response (List a Specific File)

Amp01:ONS15216 EDFA2> RTRV-RFILE:Amp01::123::snmp.cfg;
   Amp01 2002-01-12 08:01:05
M 123 COMPLD
   "EQPT:snmp.cfg"
;

Table 9-45 RTRV-RFILE Syntax Description 

Parameter
Syntax
Description

aid

 

Always EQPT.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

localfilename

string

Name of the file on the flash file system of the ONS 15216 EDFA2 that is to be listed. A null value in the request means all files are to be listed. A null value in the response means the file specified does not exist. File names are case sensitive.


9.7.39 RTRV-TH-DWDM

Command: RTRV-TH-DWDM
Description: Retrieves optical threshold and set point values for the ONS 15216 EDFA2.
Syntax:
RTRV-TH->][,][,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,DWDM:<thresholdtype>,,,<thresholdvalue>"
;

Example 9-42 RTRV-TH-DWDM Command and Response

Amp01:ONS15216 EDFA2> RTRV-TH-DWDM:Amp01:ALL:123::LPOUTDEV;
   Amp01 2001-06-08 09:00:05
M 123 COMPLD
   "1,DWDM:LPOUTDEV,,,1000"
;

Table 9-46 RTRV-TH-DWDM Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

1 and ALL have same input effect.

1

Directly affecting the optical signal.

ALL

Any or all of the preceding (command input only).

threshholdtype and thresholdvalue pairs

 

Type of threshold or set point that is to be retrieved. A null value is equivalent to ALL. Possible to specify values for one or more of the following:

LOSHYST

Loss of signal (input power) hysteresis (cerent15216EdfaLOSHysteresis).

thresholdvalue can be between 0 and 1000, with default of 100, in units of 100 dBm.

LOSTH

Loss of signal (input power) threshold (cerent15216EdfaLOSThreshold).

thresholdvalue can be between -3100 and -1500, with default of -3000, in units of 100 dBm.

LPOUTDEV

Loss of output power deviation (cerent15216EdfaLpoutDeviation).

thresholdvalue can be between 0 and 1000, with default of 200, in units of 100 dBm.

LPOUTHYST

Loss of output power hysteresis (cerent15216EdfaLpoutHysteresis).

thresholdvalue can be between 0 and 1000, with default of 100, in units of 100 dBm.

LPOUTSETPT

Loss of output power set point (cerent15216EdfaLpoutSetpoint). This read-only value is only valid when amplifier is in Constant Output Power (OPWR) and Constant Pump Power (PWR) modes. Can be disregarded when in Constant Gain Temperature Compensated (GAINTEMP) or Constant Pump Current (CRNT) mode.

thresholdvalue is read-only and automatically determined by the pump control mode with a possible value between 0 and 1000 in units of 10 mW.


9.7.40 RTRV-TH-ENV

Command: RTRV-TH-ENV
Description: Retrieves threshold values of the environmental (power bus) parameters of the ONS 15216 EDFA2.
Syntax:
RTRV-TH-ENV:[<tid>]:<aid>:<ctag>::[<thresholdtype>][,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>,ENV:<thresholdtype>,,,<thresholdvalue>"
;

Example 9-43 RTRV-TH-ENV Command and Response

Amp01:ONS15216 EDFA2> RTRV-TH-ENV:Amp01:ALL:123::PWRBUSMIN;
   Amp01 2002-07-16 14:24:29
M 123 COMPLD
   "PWR-A,ENV:PWRBUSMIN,,,420"
;

Table 9-47 RTRV-TH-ENV Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

PWR-A, PWR-B, and ALL have same input effect.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

ALL

Any or all of the preceding (command input only).

threshholdtype and thresholdvalue pairs

 

Type of threshold that is to be retrieved. A null value is equivalent to ALL. Possible to specify values for one or more of the following:

PWRBUSMIN

Power bus minimum voltage (cerent15216EdfaPowerBusDCVoltageMin).

thresholdvalue can be between 350 and 700, with default of 400, in units of -10 VDC.

PWRBUSMAX

Power bus maximum voltage (cerent15216EdfaPowerBusDCVoltageMax).

thresholdvalue can be between 350 and 700, with default of 570, in units of -10 VDC.


9.7.41 RTRV-TH-EQPT

Command: RTRV-TH-EQPT
Description: Retrieves general threshold values for the ONS 15216 EDFA2.
Syntax:
RTRV-TH-EQPT:[<tid>]:<aid>:<ctag>::[<thresholdtype>][,][,];
   <sid> <date> <time>
M <ctag> COMPLD
   "<aid>:<thresholdtype>,,,<thresholdvalue>"
;

Example 9-44 RTRV-TH-EQPT Command and Response

Amp01:ONS15216 EDFA2> RTRV-TH-EQPT:Amp01:ALL:123::MAXCTMP;
   Amp01 2001-06-08 09:00:05
M 123 COMPLD
   "EQPT:MAXCTMP,,,60"
;

Table 9-48 RTRV-TH-EQPT Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

aid

 

EQPT and ALL have same input effect.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).

threshholdtype and thresholdvalue pairs

 

Type of threshold or set point that is to be retrieved. A null value is equivalent to ALL. Possible to specify values for one or more of the following:

MAXCTMP

Maximum case temperature (cerent15216EdfaCtmpMax).

thresholdvalue can be between 20 and 70, with default of 65 in units of °C.

MAXCTMPHYST

Maximum case temperature hysteresis (cerent15216EdfaCtmpMaxHysteresis).

thresholdvalue can be between 0 and 10, with default of 1, in units of °C.

MINCTMP

Minimum case temperature (cerent15216EdfaCtmpMin).

thresholdvalue can be between -10 and 10, with default of -5, in units of °C.

MINCTMPHYST

Minimum case temperature hysteresis (cerent15216EdfaCtmpMinHysteresis).

thresholdvalue can be between 0 and 10, with default of 1, in units of °C.


9.7.42 RTRV-TOD

Command: RTRV-TOD
Description: Retrieves the date and time of the ONS 15216 EDFA2.
Syntax:
RTRV-TOD:[<tid>]::<ctag>[::];
   <sid> <date> <time>
M <ctag> COMPLD
   "<tmody>,<tmtype>,<tmsrcdv>,<tmsrcst>"
;

Example 9-45 RTRV-TOD Command and Response

Amp01:ONS15216 EDFA2> RTRV-TOD:Amp01::123;
   Amp01 2002-06-20 14:30:00
M 123 COMPLD
   "2002,06,20,14,30,00,000,UTC,GPS,IS-ACT"
;

Table 9-49 RTRV-TOD Syntax Description 

Parameter
Syntax
Description

date

yyyy-mm-dd

Date of origination of TL1 message.

time

hh:mm:ss

Time of origination of TL1 message.

tmody

format:

YYYY
MM
DD
HH
MM
SS
sss


01 - 12
01 - 31
00 - 23
00 - 59
00 - 59
000

Time of day of the format: YYYY,MM,DD,HH,MM,SS,sss

Current calendar year
Month
Day
Hour
Minutes
Seconds
Sub-seconds, currently fixed at 000.

tmtype

UTC

Type of time, currently fixed at universal coordinated time (UTC), which is the same as Greenwich Mean Time (GMT).

tmsrcdv

GPS

Time source deviation, currently fixed at GPS.

tmsrcst

IS-ACT

State of the time source, of the format <primaryState>-<secondaryState> (per Telcordia GR-1093-CORE), currently fixed at IS-ACT (In_Service, Active).


9.7.43 RTRV-USER-SECU

Command: RTRV-USER-SECU
Description: Retrieves the access level of an existing user from the system. Does not return the password.
Syntax:
RTRV-USER-SECU:[<tid>]:<uid>:<ctag>;
   <sid> <date> <time>
M <ctag> COMPLD
   "<uid>,<al>"
;

Example 9-46 RTRV-USER-SECU Command and Response

Amp01:ONS15216 EDFA2> RTRV-USER-SECU:Amp01:jsmith:123;
   Amp01 2002-05-13 17:23:16
M 123 COMPLD
   "jsmith,RW"
;

Table 9-50 RTRV-USER-SECU Syntax Description 

Parameter
Syntax
Description

sid

string

Source identifier uniquely identifies the source of a TL1 autonomous command.

al

 

Access level of the user. See "Summary of Security Permissions for TL1 Commands" section for access level permissions.

R

Read only privileges.

RW

Read and write privileges.

RWA

Read, write, and administrative privileges.

uid

string

User identifier (user name) of the existing user. If no user identifier is specified and the current user has RWA access level, it will list all existing users and their security levels.


9.7.44 SET-ATTR-SECUDFLT

Command: SET-ATTR-SECUDFLT
Description: Sets the timeout value of user sessions for users with a specific access level. If no communication occurs for this time, the user session is closed by the ONS 15216 EDFA2 TL1 agent. Users affected by changes to the timeout must log out and log in again for the change to take effect.
Syntax:
SET-ATTR-SECUDFLT:[<tid>]::<ctag>::AL=<al>,TMOUT=<timeout>[,][,][,][,][,];

Example 9-47 SET-ATTR-SECUDFLT Command

Amp01:ONS15216 EDFA2> SET-ATTR-SECUDFLT:Amp01::123::AL=RW,TMOUT=45;

Table 9-51 SET-ATTR-SECUDFLT Syntax Description 

Parameter
Syntax
Description

al

 

Access level for which the timeout is being set. See "Summary of Security Permissions for TL1 Commands" section for access level permissions.

R

Read only privileges.

RW

Read and write privileges.

RWA

Read, write, and administrative privileges.

timeout

0 - 99

Value of the timeout in minutes for the corresponding access level. Defaults are:

R = 60 min.
RW = 30 min.
RWA = 15 min.

0 means no timeout.


9.7.45 SET-TH-DWDM

Command: SET-TH-DWDM
Description: Sets optical threshold values for the ONS 15216 EDFA2.
Syntax:
SET-TH-DWDM:[<tid>]:<aid>:<ctag>::<thresholdtype>,<thresholdvalue>[,,];

Example 9-48 SET-TH-DWDM Command

Amp01:ONS15216 EDFA2> SET-TH-DWDM:Amp01:ALL:123::LOSTH,-1500;

Table 9-52 SET-TH-DWDM Syntax Description 

Parameter
Syntax
Description

aid

 

1 and ALL have same input effect.

1

Directly affecting the optical signal.

ALL

Any or all of the preceding (command input only).

threshholdtype and thresholdvalue pairs

string

Type of threshold that is to be set. The threshold is set to the thresholdvalue that follows the comma. Possible to specify values for one or more of the following:

LOSHYST

Loss of signal (input power) hysteresis (cerent15216EdfaLOSHysteresis).

thresholdvalue can be between 0 and 1000, with default of 100, in units of 100 dBm.

LOSTH

Loss of signal (input power) threshold (cerent15216EdfaLOSThreshold).

thresholdvalue can be between -3100 and -1500, with default of -3000, in units of 100 dBm.

LPOUTDEV

Loss of output power deviation (cerent15216EdfaLpoutDeviation).

thresholdvalue can be between 0 and 1000, with default of 200, in units of 100 dBm.

LPOUTHYST

Loss of output power hysteresis (cerent15216EdfaLpoutHysteresis).

thresholdvalue can be between 0 and 1000, with default of 100, in units of 100 dBm.


9.7.46 SET-TH-ENV

Command: SET-TH-ENV
Description: Sets threshold values of the environmental (power bus) parameters of the ONS 15216 EDFA2.
Syntax:
SET-TH-ENV:[<tid>]:<aid>:<ctag>::<thresholdtype>,<thresholdvalue>[,,];

Example 9-49 SET-TH-ENV Command

Amp01:ONS15216 EDFA2> SET-TH-ENV:Amp01:PWR-A:100::PWRBUSMIN,450;

Table 9-53 SET-TH-ENV Syntax Description 

Parameter
Syntax
Description

aid

 

PWR-A, PWR-B, and ALL have same input effect.

PWR-A

Affecting Power Bus A (or both A and B).

PWR-B

Affecting Power Bus B.

ALL

Any or all of the preceding (command input only).

threshholdtype and thresholdvalue pairs

 

Type of threshold that is to be set. The threshold is set to the thresholdvalue that follows the comma. Possible to specify values for one or more of the following:

PWRBUSMIN

Power bus minimum voltage (cerent15216EdfaPowerBusDCVoltageMin).

thresholdvalue can be between 350 and 700, with default of 400, in units of -10 VDC.

PWRBUSMAX

Power bus maximum voltage (cerent15216EdfaPowerBusDCVoltageMax).

thresholdvalue can be between 350 and 700, with default of 570, in units of -10 VDC.


9.7.47 SET-TH-EQPT

Command: SET-TH-EQPT
Description: Sets general threshold values for the ONS 15216 EDFA2.
Syntax:
SET-TH-EQPT:[<tid>]:<aid>:<ctag>::<thresholdtype>,<thresholdvalue>[,,];

Example 9-50 SET-TH-EQPT Command

Amp01:ONS15216 EDFA2> SET-TH-EQPT:Amp01:ALL:123::MAXCTMP,60;

Table 9-54 SET-TH-EQPT Syntax Description 

Parameter
Syntax
Description

aid

 

EQPT and ALL have same input effect.

EQPT

General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal or power bus).

ALL

Any or all of the preceding (command input only).

threshholdtype and thresholdvalue pairs

string

Type of threshold that is to be set. The threshold is set to the thresholdvalue that follows the comma. Possible to specify values for one or more of the following:

MAXCTMP

Maximum case temperature (cerent15216EdfaCtmpMax).

thresholdvalue can be between 20 and 70, with default of 65 in units of °C.

MAXCTMPHYST

Maximum case temperature hysteresis (cerent15216EdfaCtmpMaxHysteresis).

thresholdvalue can be between 0 and 10, with default of 1, in units of °C.

MINCTMP

Minimum case temperature (cerent15216EdfaCtmpMin).

thresholdvalue can be between -10 and 10, with default of -5, in units of °C.

MINCTMPHYST

Minimum case temperature hysteresis (cerent15216EdfaCtmpMinHysteresis).

thresholdvalue can be between 0 and 10, with default of 1, in units of °C.


9.7.48 STA-LOCL-RST

Command: STA-LOCL-RST
Description: Instructs the ONS 15216 EDFA2 to restore all the manufacturing default settings. The files on the flash file system (FFS), the date and time, the sid/tid name (name), and the values of manufacturing calibration are not affected. This command must be followed by the INIT-SYS command to take effect.

Warning This command resets the IP address, deletes the user directory, reverts CISCO15 to the default password, and resets other parameters to restore the unit to its state as shipped from manufacturing.


Syntax:
STA-LOCL-RST:[<tid>]::<ctag>;

Example 9-51 STA-LOCL-RST Command

Amp01:ONS15216 EDFA2> STA-LOCL-RST:Amp01::10;

hometocprevnextglossaryfeedbacksearchhelp

Posted: Sun Apr 2 12:14:50 PDT 2006
All contents are Copyright © 1992--2006 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.