Table Of Contents
TL1 Commands
9.1 Connection to the ONS 15216 EDFA2
9.2 Explanation of Command Parameters
9.2.1 Source Identifier (sid) and Target Identifier (tid)
9.2.2 Command Code Modifier (ccm)
9.2.3 Access Identifier (aid)
9.2.4 Correlation Tag (ctag)
9.3 Notation
9.4 Summary of Autonomous Alarms and Messages
9.5 Summary of Security Permissions for TL1 Commands
9.6 TL1 Commands and Autonomous Messages
9.6.1 ACT-USER
9.6.2 ALW-MSG-ALL
9.6.3 APPLY
9.6.4 CANC-USER
9.6.5 COPY-RFILE
9.6.6 CPY-MEM
9.6.7 DLT-RFILE
9.6.8 DLT-USER-SECU
9.6.9 ED-DAT
9.6.10 ED-DWDM
9.6.11 ED-EQPT
9.6.12 ED-NE-GEN
9.6.13 ED-PID
9.6.14 ED-USER-SECU
9.6.15 ENT-USER-SECU
9.6.16 INH-MSG-ALL
9.6.17 INIT-SYS
9.6.18 REPT ALM DWDM
9.6.19 REPT ALM EQPT
9.6.20 REPT EVT DWDM / REPT EVT EQPT
9.6.21 REPT EVT FXFR
9.6.22 RTRV-ALM-ALL
9.6.23 RTRV-ALM-DWDM
9.6.24 RTRV-ALM-EQPT
9.6.25 RTRV-AO
9.6.26 RTRV-ATTR-ALL
9.6.27 RTRV-ATTR-DWDM
9.6.28 RTRV-ATTR-EQPT
9.6.29 RTRV-COND-ALL
9.6.30 RTRV-COND-DWDM
9.6.31 RTRV-COND-EQPT
9.6.32 RTRV-DFLT-SECU
9.6.33 RTRV-DWDM
9.6.34 RTRV-EQPT
9.6.35 RTRV-HDR
9.6.36 RTRV-INV
9.6.37 RTRV-NE-GEN
9.6.38 RTRV-RFILE
9.6.39 RTRV-TH-DWDM
9.6.40 RTRV-TH-EQPT
9.6.41 RTRV-TOD
9.6.42 RTRV-USER-SECU
9.6.43 SET-ATTR-DWDM
9.6.44 SET-ATTR-EQPT
9.6.45 SET-ATTR-SECUDFLT
9.6.46 SET-TH-DWDM
9.6.47 SET-TH-EQPT
9.6.48 STA-LOCL-RST
TL1 Commands
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.1 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 the "Log In via LAN Port Using Telnet (Optional)" section.)
9.2 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.2.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. While the TL1 shell uses the sid/tid name in its command line prompt, the ASH shell uses the host name. The sid/tid name is the same as the sysName in the SNMP MIBs.
9.2.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.
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
FXFR
|
File transfer parameters.
|
9.2.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, EQPT, PWR-A, PWR-B) 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-EQPT and RTRV-COND-EQPT, 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.
|
EQPT
|
General parameters of the ONS 15216 EDFA2 (not directly affecting optical signal).
|
PWR-A
|
Affecting Power Bus A.
|
PWR-B
|
Affecting Power Bus B.
|
ALL
|
Any or all of the preceding (command input only).
|
9.2.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.3 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.4 Summary of Autonomous Alarms and Messages
Table 9-4 summarizes the ONS 15216 EDFA2 autonomous alarms and cleared alarms.
Table 9-4 TL1 Autonomous Alarms and Cleared Alarms
TL1 Autonomous Message
|
Condition Type (condtype)
|
Condition Descriptor (conddescr)
|
Access Identifier (aid)
|
Default Notification Code (ntfcncde) 1
|
|
REPT ALM DWDM3
|
LOS
|
Loss Of Signal (input power)
|
1
|
MJ/CL
|
SA
|
REPT ALM DWDM3
|
GAIN
|
Gain Out Of Range
|
1
|
MJ/CL
|
SA
|
REPT ALM DWDM3
|
LPOUT
|
Loss Of Output Power
|
1
|
MJ/CL
|
SA
|
REPT ALM EQPT
|
CTMP
|
Case Temperature Out Of Range
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
DBBACKUP
|
Database Backup In Progress
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
DBRESTORE
|
Database Restore In Progress
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
LCRNT1
|
Excessive Pump1 Current
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
LCRNT2
|
Excessive Pump2 Current
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
LTMP1
|
Excessive Pump1 Temperature
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
LTMP2
|
Excessive Pump2 Temperature
|
EQPT
|
MN/CL
|
NSA
|
REPT ALM EQPT
|
PWRBUSA
|
Power Bus A (voltage) Alarm
|
PWR-A
|
MN/CR4
/CL
|
NSA
|
REPT ALM EQPT
|
PWRBUSB
|
Power Bus B (voltage) Alarm
|
PWR-B
|
MN/CR4
/CL
|
NSA
|
REPT ALM EQPT
|
SFTWDOWN
|
Software Download In Progress
|
EQPT
|
MN/CL
|
NSA
|
Table 9-5 summarizes the ONS 15216 EDFA2 autonomous events.
Table 9-5 TL1 Autonomous Events
TL1 Autonomous Message
|
Condition Type (condtype)
|
Condition Descriptor (conddescr)
|
Access Identifier (aid)
|
Condition Effect (condeff) 1
|
REPT EVT DWDM
|
ALSCHGD
|
ALS (automatic laser shutdown) Changed
|
1
|
TC
|
REPT EVT DWDM
|
CTRLMODE1
|
Pump1 Control Mode Changed
|
1
|
TC
|
REPT EVT DWDM
|
CTRLMODE2
|
Pump2 Control Mode Changed
|
1
|
TC
|
REPT EVT DWDM
|
GAIN
|
Gain Out Of Range (alarm)
|
1
|
SC/CL
|
REPT EVT DWDM
|
GAINCHGD
|
Overall Gain Changed
|
1
|
TC
|
REPT EVT DWDM
|
LOS
|
Loss Of Signal (input power) (alarm)
|
1
|
SC/CL
|
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
|
LPOUT
|
Loss Of Output Power (alarm)
|
1
|
SC/CL
|
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 EQPT
|
CONFIGSAVED
|
Config Saved
|
EQPT
|
TC
|
REPT EVT EQPT
|
CTMP
|
Case Temperature Out Of Range (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
CUTOVERRESET
|
(Software) Reset After Cutover
|
EQPT
|
TC
|
REPT EVT EQPT
|
DBBACKUP
|
Database Backup In Progress (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
DBBKRTCRCERR
|
Database Backup/Restore CRC Error
|
EQPT
|
TC
|
REPT EVT EQPT
|
DBBKRTERR
|
Database Backup/Restore Error
|
EQPT
|
TC
|
REPT EVT EQPT
|
DBBKRTFILEERR
|
Database Backup/Restore File Error
|
EQPT
|
TC
|
REPT EVT EQPT
|
DBBKRTOBJERR
|
Database Backup/Restore Object Error
|
EQPT
|
TC
|
REPT EVT EQPT
|
DBBKRTSNMPERR
|
Database Backup/Restore SNMP Error
|
EQPT
|
TC
|
REPT EVT EQPT
|
DBBKRTTOERR
|
Database Backup/Restore Timeout Error
|
EQPT
|
TC
|
REPT ALM EQPT
|
DBRESTORE
|
Database Restore In Progress (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
LCRNT1
|
Excessive Pump1 Current (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
LCRNT2
|
Excessive Pump2 Current (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
LTMP1
|
Excessive Pump1 Temperature (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
LTMP2
|
Excessive Pump2 Temperature (alarm)
|
EQPT
|
SC/CL
|
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
|
PWRBUSA
|
Power Bus A (voltage) Alarm
|
PWR-A
|
SC/CL
|
REPT EVT EQPT
|
PWRBUSB
|
Power Bus B (voltage) Alarm
|
PWR-B
|
SC/CL
|
REPT EVT EQPT
|
PWRBUSMAXCHGD
|
Power Bus Max (voltage) Changed
|
PWR-A
|
TC
|
REPT EVT EQPT
|
PWRBUSMINCHGD
|
Power Bus Min (voltage) Changed
|
PWR-A
|
TC
|
REPT EVT EQPT
|
PWRBUSMODE
|
Power Bus Mode Changed
|
PWR-B
|
TC
|
REPT EVT EQPT
|
SEVERITYCHGD
|
Severity Changed from CR|MJ|MN|NA|NR to CR|MJ|MN|NA|NR
|
EQPT
|
TC
|
REPT ALM EQPT
|
SFTWDOWN
|
Software Download In Progress (alarm)
|
EQPT
|
SC/CL
|
REPT EVT EQPT
|
SFTWDOWNERR
|
Software Load Error
|
EQPT
|
TC
|
REPT EVT EQPT
|
SOFTWARERESET
|
Software Reset
|
EQPT
|
TC
|
REPT EVT EQPT
|
SOFTWARERESETERR
|
Software Reset Error
|
EQPT
|
TC
|
Table 9-6 summarizes the ONS 15216 EDFA2 file transfer events.
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
|
9.5 Summary of Security Permissions for TL1 Commands
Table 9-7 summarizes the security permissions (access levels) for each available TL1 command and autonomous message.
9.6 TL1 Commands and Autonomous Messages
9.6.1 ACT-USER
Command Types
ACT-USER
Activates user session (login).
Syntax Description
ACT-USER:[<tid>]:<uid>:<ctag>::<pid>;
Example 9-1 ACT-USER Command
Amp01:ONS15216 EDFA2> ACT-USER:Amp01:JOE:123::***;
Table 9-8 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 +, #, and %.
|
9.6.2 ALW-MSG-ALL
Command Types
ALW-MSG-ALL
Permits or resumes the dispatch of automatic messages from the ONS 15216 EDFA2 that were inhibited by an INH-MSG-ALL call. All alarms in existence at the time that this command restores them are transmitted via REPT ALM and REPT EVT messages. If a previously inhibited user executes ALW-MSG-ALL, the user will not receive notifications of alarms raised before execution of ALW-MSG-ALL.
Syntax Description
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-9 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:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
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).
|
DBBACKUP
|
"Database Backup In Progress" alarm (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" alarm (cerent15216EdfaOpDbRestore).
|
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).
|
SFTWDOWN
|
"Software Download In Progress" alarm (cerent15216EdfaOpLoad).
|
| |
ALSCHGD
|
"ALS (automatic laser shutdown) Changed" (cerent15216EdfaALSModeEnable).
|
CONFIGSAVED
|
"Config Saved".
|
CTRLMODE1
|
"Pump1 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=1).
|
CTRLMODE2
|
"Pump2 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=2).
|
CUTOVERRESET
|
(Software) "Reset after Cutover" (cerent15216EdfaOpCutover).
|
DBBKRTCRCERR
|
"Database Backup/Restore CRC Error" (cerent15216EdfaActionOpResult).
|
DBBKRTERR
|
"Database Backup/Restore Error" (cerent15216EdfaActionOpResult).
|
DBBKRTFILEERR
|
"Database Backup/Restore File Error" (cerent15216EdfaActionOpResult).
|
DBBKRTOBJERR
|
"Database Backup/Restore Object Error" (cerent15216EdfaActionOpResult).
|
DBBKRTSNMPERR
|
"Database Backup/Restore SNMP Error" (cerent15216EdfaActionOpResult).
|
DBBKRTTOERR
|
"Database Backup/Restore Timeout Error" (cerent15216EdfaActionOpResult).
|
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).
|
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).
|
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).
|
SEVERITYCHGD
|
"Severity Changed from CR|MJ|MN|NA|NR to CR|MJ|MN|NA|NR".
|
SFTWDOWNERR
|
"Software Load Error".
|
SOFTWARERESET
|
"Software Reset" (cerent15216EdfaOpReset).
|
SOFTWARERESETERR
|
"Software Reset Error" (cerent15216EdfaActionOpResult).
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
9.6.3 APPLY
Command Types
APPLY
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 Description
APPLY:[<tid>]::<ctag>;
Example 9-3 APPLY Command
Amp01:ONS15216 EDFA2> APPLY:Amp01::1234;
9.6.4 CANC-USER
Command Types
CANC-USER
Cancels user session (logoff).
Syntax Description
CANC-USER:[<tid>]:<uid>:<ctag>;
Example 9-4 CANC-USER Command
Amp01:ONS15216 EDFA2> CANC-USER:Amp01:JOE:100;
Table 9-10 CANC-USER Syntax Description
Parameter
|
Syntax
|
Description
|
uid
|
string
|
The user's identifier (user name).
|
9.6.5 COPY-RFILE
Command Types
COPY-RFILE
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 the "REPT EVT FXFR" section for information on the autonomous response messages.
Syntax Description
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.2.1",DEST="file://localhost/15216EdfaSw_2.2.1",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.2.1,START,,
;
Amp01 2002-04-30 11:35:24
A 8 REPT EVT FXFR
EQPT:15216EdfaSw_2.2.1,COMPLD,SUCCESS,1963195
;
Table 9-11 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.6.6 CPY-MEM
Command Types
CPY-MEM
Copies the log file or system configuration 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 Description
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-12 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.
|
CFG
|
ONS 15216 EDFA2 system configuration file, only when fromdev is specified to be DBCFG or 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:
|
DBCFG
|
ONS 15216 EDFA2 configuration parameters from IDROM, CFGROM, RAM, and FFS.
|
MEM
|
ONS 15216 EDFA2 non-persistent memory (RAM).
|
FFS
|
ONS 15216 EDFA2 persistent memory (flash file system).
|
tofile
|
CFG
|
ONS 15216 EDFA2 system configuration in memory.
The system must be rebooted using INI-SYS for changes to the system configuration to take effect.
|
any other 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.6.7 DLT-RFILE
Command Types
DLT-RFILE
Deletes a file from the flash file system (FFS) of the ONS 15216 EDFA2.
Syntax Description
DLT-RFILE:[<tid>]::<ctag>::FILE=<localfilename>;
Example 9-9 DLT-RFILE Command
Amp01:ONS15216 EDFA2> DLT-RFILE:Amp01::1234::FILE=snmp.cfg;
Table 9-13 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.6.8 DLT-USER-SECU
Command Types
DLT-USER-SECU
Deletes (removes) an existing user from the system.
Syntax Description
DLT-USER-SECU:[<tid>]:<uid>:<ctag>;
Example 9-10 DLT-USER-SECU Command
Amp01:ONS15216 EDFA2> DLT-USER-SECU:Amp01:jsmith:123;
Table 9-14 DLT-USER-SECU Syntax Description
Parameter
|
Syntax
|
Description
|
uid
|
string
|
The user identifier (user name) of the existing user to be removed.
|
9.6.9 ED-DAT
Command Types
ED-DAT
Edits the date and/or time of the ONS 15216 EDFA2.
Syntax Description
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-15 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.6.10 ED-DWDM
Command Types
ED-DWDM
Configures the ONS 15216 EDFA2 optical control parameters.
Syntax Description
ED-DWDM:[<tid>]:<aid>:<ctag>:::[PUMP1CTRLMODE=<pump1ctrlmode>],[PUMP1CTRLVALUE=<pump1ctrlv
alue>],[PUMP2CTRLMODE=<pump2ctrlmode>],[PUMP2CTRLVALUE=<pump2ctrlvalue>],[OVERALLGAIN=<ove
rallgain>],[PREATT=<preatt>],[ALS=<als>];
Example 9-12 ED-DWDM Command
Amp01:ONS15216 EDFA2> ED-DWDM:Amp01:ALL:123:::PUMP1CTRLMODE=GAINTEMP;
Table 9-16 ED-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).
|
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:
|
GAINTEMP
|
Constant Gain Temperature Compensated mode (manufacturer default) (cerent15216EdfaPumpCfgControlMode set to constGainTempComp). Setting one pump sets the other pump to the same mode.
|
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.
|
CRNT
|
Constant Pump Current mode (cerent15216EdfaPumpCfgControlMode set to constCurrent). Setting one pump sets the other pump to the same mode.
|
PWR
|
Constant Pump Power mode (cerent15216EdfaPumpCfgControlMode set to constPower). Setting one pump sets the other pump to the same mode.
|
IDLE
|
Pump is shut down (cerent15216EdfaPumpCfgControlMode set to idle). Setting one pump sets the other pump to the same mode.
|
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 - 650
|
Output power in units of 10 mW when mode is OPWR (sets cerent15216EdfaPumpCfgConstOutPower). The default value is 0.
|
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.
|
overallgain
|
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).
|
als
|
|
Automatic Laser Shutdown (sets cerent15216EdfaALSModeEnable).
|
ENABLED
|
When input power (signal) goes below the LOSTH value, the laser pumps are shut down until the input signal is restored beyond the value of LOSHYST.
|
DISABLED
|
ASE is present (typically -3.5 dBm) at the output during LOS state.
|
9.6.11 ED-EQPT
Command Types
ED-EQPT
Configures the ONS 15216 EDFA2 equipment (power bus) parameters.
Syntax Description
ED-EQPT:[<tid>]:<aid>:<ctag>:::PWRBUSMODE=<pwrbusmode>;
Example 9-13 ED-EQPT Command
Amp01:ONS15216 EDFA2> ED-EQPT:Amp01:ALL:123:::PWRBUSMODE=SIMPLEX;
Table 9-17 ED-EQPT 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.6.12 ED-NE-GEN
Command Types
ED-NE-GEN
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 INIT-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 RS-232 (EIA/TIA-232) Port Using HyperTerminal" section).
Syntax Description
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-18 ED-NE-GEN Syntax Description
Parameter
|
Syntax
|
Description
|
name
|
string
|
System's sid/tid name (sysName).
|
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.6.13 ED-PID
Command Types
ED-PID
Edits password.
Syntax Description
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-19 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 +, #, and %.
|
9.6.14 ED-USER-SECU
Command Types
ED-USER-SECU
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 Description
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-20 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 +, #, and %.
|
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.6.15 ENT-USER-SECU
Command Types
ENT-USER-SECU
Creates a new user in the system; specifies the user identifier, password and access level of the new user.
Syntax Description
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-21 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 +, #, and %.
|
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.6.16 INH-MSG-ALL
Command Types
INH-MSG-ALL
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 Description
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-22 INH-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:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
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).
|
DBBACKUP
|
"Database Backup In Progress" alarm (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" alarm (cerent15216EdfaOpDbRestore).
|
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).
|
SFTWDOWN
|
"Software Download In Progress" alarm (cerent15216EdfaOpLoad).
|
ALSCHGD
|
"ALS (automatic laser shutdown) Changed" (cerent15216EdfaALSModeEnable).
|
CONFIGSAVED
|
"Config Saved".
|
CTRLMODE1
|
"Pump1 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=1).
|
CTRLMODE2
|
"Pump2 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=2).
|
CUTOVERRESET
|
(Software) "Reset after Cutover" (cerent15216EdfaOpCutover).
|
DBBKRTCRCERR
|
"Database Backup/Restore CRC Error" (cerent15216EdfaActionOpResult).
|
DBBKRTERR
|
"Database Backup/Restore Error" (cerent15216EdfaActionOpResult).
|
DBBKRTFILEERR
|
"Database Backup/Restore File Error" (cerent15216EdfaActionOpResult).
|
DBBKRTOBJERR
|
"Database Backup/Restore Object Error" (cerent15216EdfaActionOpResult).
|
DBBKRTSNMPERR
|
"Database Backup/Restore SNMP Error" (cerent15216EdfaActionOpResult).
|
DBBKRTTOERR
|
"Database Backup/Restore Timeout Error" (cerent15216EdfaActionOpResult).
|
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).
|
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).
|
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).
|
SEVERITYCHGD
|
"Severity Changed from CR|MJ|MN|NA|NR to CR|MJ|MN|NA|NR".
|
SFTWDOWNERR
|
"Software Load Error".
|
SOFTWARERESET
|
"Software Reset" (cerent15216EdfaOpReset).
|
SOFTWARERESETERR
|
"Software Reset Error" (cerent15216EdfaActionOpResult).
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
9.6.17 INIT-SYS
Command Types
INIT-SYS
Reboots the system.
Syntax Description
INIT-SYS:[<tid>]:<aid>:<ctag>::<ph>;
Example 9-19 INIT-SYS Command
Amp01:ONS15216 EDFA2> INIT-SYS:Amp01:ALL:1234::1;
Table 9-23 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.6.18 REPT ALM DWDM
Command Types
REPT ALM DWDM
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 Description
<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-24 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:
|
*C
|
Critical alarm.
|
**
|
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:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
CL
|
Cleared alarm.
|
NA
|
Not alarmed.
|
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.6.19 REPT ALM EQPT
Command Types
REPT ALM EQPT
Reports when a general alarm (not directly affecting optical signal) is logged or cleared (derived from cerent15216EdfaAlarmState).
Syntax Description
<sid> <date> <time>
<almcde> <atag> REPT ALM EQPT
"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;
Example 9-21 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-25 REPT ALM EQPT Syntax Description
Parameter
|
Syntax
|
Description
|
almcde
|
|
The alarm severity code for the TL1 message. Possible values are:
|
*C
|
Critical alarm.
|
**
|
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:
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
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:
|
CTMP
|
"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).
|
DBBACKUP
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
LCRNT1
|
"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).
|
LCRNT2
|
"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).
|
LTMP1
|
"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).
|
LTMP2
|
"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).
|
PWRBUSA
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
|
"Software Download In Progress" (cerent15216EdfaOpLoad).
|
date
|
yyyy-mm-dd
|
Date of origination of TL1 message.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
CL
|
Cleared alarm.
|
NA
|
Not alarmed.
|
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.6.20 REPT EVT DWDM / REPT EVT EQPT
Command Types
REPT EVT DWDM or REPT EVT EQPT
Reports autonomous events. Reports when an event is logged.
Syntax Description
<sid> <date> <time>
A <atag> REPT EVT <ccm>
"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,,,,:<conddescr>"
;
Example 9-22 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\""
;
Example 9-23 Example REPT EVT EQPT Standing Condition Message
Amp01 2003-07-25 18:06:52
A 1 REPT EVT EQPT
"EQPT:DBBACKUP,SC,7-25,18-6-52,,,,:\"DATABASE BACKUP\""
;
Example 9-24 Example REPT EVT EQPT Cleared Standing Condition Message
Amp01 2003-07-25 18:06:52
A 1 REPT EVT EQPT
"EQPT:DBBACKUP,CL,7-25,18-6-52,,,,:\"DATABASE BACKUP\""
;
Table 9-26 REPT EVT DWDM / 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.
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
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
(ccm)
|
|
Condition type identifies the type of event (maps to cerent15216EdfaLogEventID). Possible condtype and corresponding conddescr (in quotes) are:
|
ALSCHGD
(DWDM)
|
"ALS (automatic laser shutdown) Changed" (cerent15216EdfaALSModeEnable).
|
CTRLMODE1
(DWDM)
|
"Pump1 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=1).
|
CTRLMODE2
(DWDM)
|
"Pump2 Control Mode Changed" (cerent15216EdfaControlMode for cerent15216EdfaPumpCfgPumpNumber=2).
|
GAIN
(DWDM)
|
"Gain Out of Range" alarm (cerent15216EdfaAlarmGain).
|
GAINCHGD
(DWDM)
|
"Overall Gain Changed" (cerent15216EdfaConstGainOverallGain).
|
LOS
(DWDM)
|
"Loss of Signal" (input power) alarm (cerent15216EdfaAlarmLpin).
|
LOSHYSTCHGD
(DWDM)
|
"LOS (loss of signal) Hysteresis Changed" (cerent15216EdfaLOSHysteresis).
|
LOSTHCHGD
(DWDM)
|
"LOS (loss of signal) Threshold Changed" (cerent15216EdfaLOSThreshold).
|
LPOUT
(DWDM)
|
"Loss of Output Power" alarm (cerent15216EdfaAlarmLpout).
|
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).
|
CONFIGSAVED
(EQPT)
|
"Config Saved".
|
CTMP
(EQPT)
|
"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).
|
CUTOVERRESETERR
(EQPT)
|
(Software) "Reset After Cutover Error".
|
| |
DBBACKUP
(EQPT)
|
"Database Backup In Progress" alarm (cerent15216EdfaOpDbBackup).
|
DBBKRTCRCERR
(EQPT)
|
"Database Backup/Restore CRC Error" (cerent15216EdfaActionOpResult).
|
DBBKRTERR
(EQPT)
|
"Database Backup/Restore Error" (cerent15216EdfaActionOpResult).
|
DBBKRTFILEERR
(EQPT)
|
"Database Backup/Restore File Error" (cerent15216EdfaActionOpResult).
|
DBBKRTOBJERR
(EQPT)
|
"Database Backup/Restore Object Error" (cerent15216EdfaActionOpResult).
|
DBBKRTSNMPERR
(EQPT)
|
"Database Backup/Restore SNMP Error" (cerent15216EdfaActionOpResult).
|
DBBKRTTOERR
(EQPT)
|
"Database Backup/Restore Timeout Error" (cerent15216EdfaActionOpResult).
|
DBRESTORE
(EQPT)
|
"Database Restore In Progress" alarm (cerent15216EdfaOpDbRestore).
|
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).
|
MAXCTMPCHGD
(EQPT)
|
"Max Case Temperature Changed" (cerent15216EdfaCtmpMax).
|
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).
|
PWRBUSA
(EQPT)
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
(EQPT)
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
PWRBUSMAXCHGD
(EQPT)
|
"Power Bus Max (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMax).
|
PWRBUSMINCHGD
(EQPT)
|
"Power Bus Min (voltage) Changed" (cerent15216EdfaPowerBusDCVoltageMin).
|
| |
PWRBUSMODE
(EQPT)
|
"Power Bus Mode Changed" (cerent15216EdfaPowerBusMode).
|
SEVERITYCHGD
(EQPT)
|
"Severity Changed from CR|MJ|MN|NA|NR to CR|MJ|MN|NA|NR".
|
SFTWDOWN
(EQPT)
|
"Software Download In Progress" alarm (cerent15216EdfaOpLoad).
|
SFTWDOWNERR
(EQPT)
|
"Software Load Error".
|
SOFTWARERESET
(EQPT)
|
"Software Reset" (cerent15216EdfaOpReset).
|
SOFTWARERESETERR
(EQPT)
|
"Software Reset Error" (cerent15216EdfaActionOpResult).
|
condeff
|
|
Effect of the condition.
|
TC
|
Transient condition.
|
SC
|
Standing condition.
|
CL
|
Cleared standing 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.6.21 REPT EVT FXFR
Command Types
REPT EVT FXFR
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 Description
<sid> <date> <time>
A <atag> REPT EVT FXFR
"<aid>:<filename>,<fxfr_status>[,<fxfr_rslt>][,<bytes_xfrd>]"
;
Example 9-25 REPT EVT FXFR Message
Amp01 2001-06-18 14:48:44
A 141 REPT EVT FXFR
"EQPT:VMRLS20.EXE,COMPLD,SUCCESS,8051"
;
Table 9-27 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.
|
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.6.22 RTRV-ALM-ALL
Command Types
RTRV-ALM-ALL
Generates a report on all active 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 Description
RTRV-ALM-ALL:[<tid>]::<ctag>::[<ntfcncde>],[<condtype>],[<srveff>][,,,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,:<conddescr>"
;
Example 9-26 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-28 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).
|
PWR-A
|
Affecting Power Bus A.
|
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
(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).
|
DBBACKUP
(EQPT)
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
(EQPT)
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
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).
|
PWRBUSA
(EQPT)
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
(EQPT)
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
(EQPT)
|
"Software Download In Progress" (cerent15216EdfaOpLoad).
|
date
|
yyyy-mm-dd
|
Date of origination of TL1 message.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NULL
|
Defaults to ALL.
|
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.6.23 RTRV-ALM-DWDM
Command Types
RTRV-ALM-DWDM
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 Description
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-27 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-29 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:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NULL
|
Defaults to ALL.
|
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.6.24 RTRV-ALM-EQPT
Command Types
RTRV-ALM-EQPT
Generates a report on all active alarms.
Syntax Description
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-30 RTRV-ALM-EQPT Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Possible valies are:
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
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:
|
CTMP
|
"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).
|
DBBACKUP
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
LCRNT1
|
"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).
|
LCRNT2
|
"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).
|
LTMP1
|
"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).
|
LTMP2
|
"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).
|
PWRBUSA
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
|
"Software Download In Progress" (cerent15216EdfaOpLoad).
|
date
|
yyyy-mm-dd
|
Date of origination of TL1 message.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NULL
|
Defaults to ALL.
|
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.6.25 RTRV-AO
Command Types
RTRV-AO
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 Description
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-31 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.6.26 RTRV-ATTR-ALL
Command Types
RTRV-ATTR-ALL
Retrieves the notification codes for all attributes.
Syntax Description
RTRV-ATTR-ALL:[<tid>]::<ctag>::[<ntfcncde>],[<condtype>][,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,<ccm>:<ntfcncde>,<condtype>,,,"
;
Example 9-30 RTRV-ATTR-ALL Command and Response
Amp01:ONS15216 EDFA2> RTRV-ATTR-ALL:Amp01::229::,,,,;
Amp01 2002-06-20 14:30:00
M 229 COMPLD
ю"EQPT,EQPT:MN,LCRNT1,,"
ю"EQPT,EQPT:MN,LCRNT2,,"
ю"EQPT,EQPT:MN,LTMP1,,"
ю"EQPT,EQPT:MN,LTMP2,,"
ю"1,DWDM:MJ,LOS,,"
ю"1,DWDM:MJ,GAIN,,"
ю"1,DWDM:MJ,LPOUT,,"
ю"EQPT,EQPT:MN,CTMP,,"
ю"PWR-A,EQPT:MN,PWRBUSA,,"
ю"PWR-B,EQPT:MN,PWRBUSB,,"
ю"EQPT,EQPT:MN,DBBACKUP,,"
ю"EQPT,EQPT:MN,DBRESTORE,,"
ю"EQPT,EQPT:MN,SFTWDOWN,,"
;
Table 9-32 RTRV-ATTR-ALL Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Possible values are:
|
1
|
Directly affecting the optical signal.
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
PWR-B
|
Affecting Power Bus B.
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Deafults to ALL.
|
condtype
|
|
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).
|
DBBACKUP
(EQPT)
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
(EQPT)
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
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).
|
PWRBUSA
(EQPT)
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
(EQPT)
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
(EQPT)
|
"Software Download In Progress" (cerent15216EdfaOpLoad).
|
ALL
|
Any or all of the above.
|
NULL
|
Defaults to ALL.
|
9.6.27 RTRV-ATTR-DWDM
Command Types
RTRV-ATTR-DWDM
Retrieves the notification codes for DWDM attributes.
Syntax Description
RTRV-ATTR-DWDM:[<tid>]:[aid]:<ctag>::[<ntfcncde>],[<condtype>][,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,<ccm>:<ntfcncde>,<condtype>,,,"
;
Example 9-31 RTRV-ATTR-DWDM Command and Response
Amp01:ONS15216 EDFA2> RTRV-ATTR-DWDM:Amp01:1:229::MJ,,,,;
Amp01 2002-06-20 14:30:00
M 229 COMPLD
"1,DWDM:MJ,LOS,,,"
"1,DWDM:MJ,GAIN,,"
"1,DWDM:MJ,LPOUT,,"
;
Table 9-33 RTRV-ATTR-DWDM Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
1 and ALL have same input effecct.
|
1
|
Directly affecting the optical signal.
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
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).
|
ALL
|
Any or all of the above.
|
NULL
|
Defaults to ALL.
|
9.6.28 RTRV-ATTR-EQPT
Command Types
RTRV-ATTR-EQPT
Retrieves the notification codes for the eqiupment attributes.
Syntax Description
RTRV-ATTR-EQPT:[<tid>]:[aid]:<ctag>::[<ntfcncde>],[<condtype>][,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,<ccm>:<ntfcncde>,<condtype>,,,"
;
Example 9-32 RTRV-ATTR-EQPT Command and Response
Amp01:ONS15216 EDFA2> RTRV-ATTR-EQPT:Amp01::229::,,,,;
Amp01 2002-06-20 14:30:00
M 229 COMPLD
ю"EQPT,EQPT:MN,LCRNT1,,"
ю"EQPT,EQPT:MN,LCRNT2,,"
ю"EQPT,EQPT:MN,LTMP1,,"
ю"EQPT,EQPT:MN,LTMP2,,"
ю"EQPT,EQPT:MN,CTMP,,"
ю"PWR-A,EQPT:MN,PWRBUSA,,"
ю"PWR-B,EQPT:MN,PWRBUSB,,"
ю"EQPT,EQPT:MN,DBBACKUP,,"
ю"EQPT,EQPT:MN,DBRESTORE,,"
ю"EQPT,EQPT:MN,SFTWDOWN,,"
;
Table 9-34 RTRV-ATTR-EQPT Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Possible values are:
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
PWR-B
|
Affecting Power Bus B.
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
ALL
|
Any or all of the preceding (command input only).
|
NULL
|
Defaults to ALL.
|
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).
|
DBBACKUP
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
LCRNT1
|
"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).
|
LCRNT2
|
"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).
|
LTMP1
|
"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).
|
LTMP2
|
"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).
|
PWRBUSA
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
|
"Software Download In Progress" (cerent15216EdfaOpLoad).
|
ALL
|
Any or all of the above.
|
NULL
|
Defaults to ALL.
|
9.6.29 RTRV-COND-ALL
Command Types
RTRV-COND-ALL
Generates a report on the condition (state) of all alarms and standing conditions.
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 Description
RTRV-COND-ALL:[<tid>]::<ctag>::[<condtype>][,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;
Example 9-33 RTRV-COND-ALL Command and Response
Amp01:ONS15216 EDFA2> RTRV-COND-ALL:Amp01::229::;
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.
|
PWR-A
|
Affecting Power Bus A.
|
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
(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).
|
DBBACKUP
(EQPT)
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
(EQPT)
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
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).
|
PWRBUSA
(EQPT)
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
| |
PWRBUSB
(EQPT)
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
(EQPT)
|
"Software Download In Progress" (cerent15216EdfaOpLoad).
|
date
|
yyyy-mm-dd
|
Date of origination of TL1 message.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
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.6.30 RTRV-COND-DWDM
Command Types
RTRV-COND-DWDM
Generates a report on the condition (state) of DWDM alarms and standing conditions.
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 Description
RTRV-COND-DWDM:[<tid>]:<aid>:<ctag>::[<condtype>][,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,<ccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;
Example 9-34 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:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
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.6.31 RTRV-COND-EQPT
Command Types
RTRV-COND-EQPT
Generates a report on the condition (state) of general alarms and standing conditions.
Syntax Description
RTRV-COND-EQPT:[<tid>]:<aid>:<ctag>::[<condtype>][,,,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,,,<conddescr>"
;
Example 9-35 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-37 RTRV-COND-EQPT Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
EQPT and ALL have same input effect.
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
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:
|
CTMP
|
"Case Temperature Out of Range" alarm (cerent15216EdfaAlarmCtmp).
|
DBBACKUP
|
"Database Backup In Progress" alarm (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" alarm (cerent15216EdfaOpDbRestore).
|
LCRNT1
|
"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).
|
LCRNT2
|
"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).
|
LTMP1
|
"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).
|
LTMP2
|
"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).
|
PWRBUSA
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
|
"Software Download In Progress" alarm (cerent15216EdfaOpLoad).
|
date
|
yyyy-mm-dd
|
Date of origination of TL1 message.
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
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.6.32 RTRV-DFLT-SECU
Command Types
RTRV-DFLT-SECU
Retrieves the timeout value(s) for user access level(s).
Syntax Description
RTRV-DFLT-SECU:[<tid>]:<aid>:<ctag>;
<sid> <date> <time>
M <ctag> COMPLD
"<aid>:AL=<al>,TMOUT=<timeout>"
;
Example 9-36 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-38 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.
|
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.6.33 RTRV-DWDM
Command Types
RTRV-DWDM
Retrieves the ONS 15216 EDFA2 optical control configuration.
Syntax Description
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>,PUMP1CTRLMODEMEASURED=<pump1
ctrlmodemeasured>,PUMP1CTRLVALUEMEASURED=<pump1ctrlvaluemeasured>,PUMP2CTRLMODEMEASURED=<p
ump2ctrlmodemeasured>,PUMP2CTRLVALUEMEASURED=<pump2ctrlvaluemeasured>,OVERALLGAINMEASURED=
<gainmeasured>,CONFIGGAIN=<gain>,PREATTMEASURED=<preattmeasured>,ALS=<als>"
;
Example 9-37 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=1934,INPWRDBM=-714,OUTPWRMILLIW=3532,OUTPWRDBM=1548,PUMP1CTRLMODE=GAINTE
MP,PUMP1CTRLVALUE=220,PUMP2CTRLMODE=GAINTEMP,PUMP2CTRLVALUE=220,PUMP1CTRLMODEMEASURED=GAIN
TEMP,PUMP1CTRLVALUEMEASURED=220,PUMP2CTRLMODEMEASURED=GAINTEMP,PUMP2CTRLVALUEMEASURED=220,
OVERALLGAINMEASURED=225,CONFIGGAIN=220,PREATTMEASURED=-5,ALS=DISABLED"
;
Table 9-39 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 configured control mode (maps to cerent15216EdfaPumpCfgControlMode for the corresponding pump). Possible values are:
|
GAINTEMP
|
Constant Gain Temperature Compensated mode (manufacturer default) (cerent15216EdfaPumpCfgControlMode set to constGainTempComp).
|
OPWR
|
Constant Output Power mode (cerent15216EdfaPumpCfgControlMode set to constOutputPower). A valid mode only for pump 2.
|
CRNT
|
Constant Pump Current mode (cerent15216EdfaPumpCfgControlMode set to constCurrent).
|
PWR
|
Constant Pump Power mode (cerent15216EdfaPumpCfgControlMode set to constPower).
|
IDLE
|
Pump is shut down (cerent15216EdfaPumpCfgControlMode set to idle).
|
pump1ctrlvalue,
pump2ctrlvalue
|
|
Pump 1 or pump 2 configured control value. This value's interpretation depends on the control mode of the corresponding pump. Possible values are:
|
0 - 650
|
Output power in units of 10 mW when mode is OPWR (gets cerent15216EdfaPumpCfgConstOutPower).
|
0 - 300
|
Current value in mA when mode is CRNT (gets cerent15216EdfaPumpCfgConstPumpCurrent).
|
0 - 100
|
Pump power in mW when mode is PWR (gets cerent15216EdfaPumpCfgConstPumpPower).
|
pump1ctrlmodemeasured,
pump2ctrlmodemeasured
|
|
Pump 1 or pump 2 measured control mode. Possible values are same as pump1ctrlmode and pump2ctrlmode, as shown above.
|
pump1ctrlvaluemeasured,
pump2ctrlvaluemeasured
|
|
Pump 1 or pump 2 measured control value. Possible values are same as pump1ctrlvalue and pump2ctrlvalue, as shown above.
|
gainmeasured
|
0 - 230
|
Value of gain in units of 10 dB when mode is GAINTEMP (gets cerent15216EdfaConstGainOverallGainMeasured).
|
gain
|
130 - 220
|
Value of configured gain setpoint in units of 10 dB when mode is GAINTEMP (gets cerent15216EdfaConstGainOverallGainMeasured). Same as OVERALLGAIN.
|
preattmeasured
|
0 - 110
|
Gain pre-attenuation value in units of 10 dB (gets cerent15216EdfaVariableGainPreAttenuationMeasured).
|
als
|
|
Automatic Laser Shutdown (sets cerent15216EdfaALSModeEnable).
|
ENABLED
|
When input power (signal) goes below the LOSTH value, the laser pumps are shut down until the input signal is restored beyond the value of LOSHYST.
|
DISABLED
|
ASE is present (typically -3.5 dBm) at the output during LOS state.
|
9.6.34 RTRV-EQPT
Command Types
RTRV-EQPT
Retrieves the ONS 15216 EDFA2 equipment parameter configuration.
Syntax Description
RTRV-EQPT:[<tid>]:<aid>:<ctag>;
<sid> <date> <time>
M <ctag> COMPLD
"<aid>:PWRBUSMODE=<pwrbusmode>"
,
Example 9-38 RTRV-EQPT Command and Response
Amp01:ONS15216 EDFA2> RTRV-EQPT:Amp01:ALL:123;
Amp01 2002-06-20 14:30:00
M 123 COMPLD
"PWR-B:PWRBUSMODE=DUPLEX"
;
Table 9-40 RTRV-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
|
|
PWR-A, PWR-B, and ALL have same input effect.
|
PWR-A
|
Affecting Power Bus A.
|
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 bus B (cerent15216EdfaPowerBusMode set to duplex).
|
9.6.35 RTRV-HDR
Command Types
RTRV-HDR
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 Description
RTRV-HDR:[<tid>]::<ctag>;
<sid> <date> <time>
M <ctag> COMPLD
;
Example 9-39 RTRV-HDR Command and Response
Amp01:ONS15216 EDFA2> RTRV-HDR:Amp01::100;
Amp01 2001-06-08 08:10:50
M 100 COMPLD
;
Table 9-41 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.6.36 RTRV-INV
Command Types
RTRV-INV
Retrieves the inventory information of the ONS 15216 EDFA2.
Syntax Description
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=<model>,MODELNAME=<mod
el>"
;
Example 9-40 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=ONS15216 EDFA2,NAME=Amp01,HARDWAREREV=74-3608-01-A0-C0,FIR
MWAREREV=v2.3.15,SOFTWAREREV=v2.4.0,SERIALNUM=DIT0533000P,MFGNAME=Cisco Systems,MODELNAME=
216EDFA2-A"
;
Table 9-42 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.
|
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 (sysName).
|
serialnum
|
string
|
System serial number (cerent15216EdfaPhysicalSerialNum).
|
swrev
|
string
|
Software revision number (cerent15216EdfaPhysicalSoftwareRev).
|
9.6.37 RTRV-NE-GEN
Command Types
RTRV-NE-GEN
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 Description
RTRV-NE-GEN:[<tid>]::<ctag>;
<sid> <date> <time>
M <ctag> COMPLD
"<aid>:NAME=<name>,IPADDR=<ipaddr>,IPMASK=<ipmask>,DEFRTR=<defrtr>,MACADDRESS=<macaddre
ss>,BOOTRECORDTYPE1=<bootrectype1>,BOOTFILENAME1=<bootfilename1>,BOOTIPADDR1=<bootipaddr1>
,BOOTRECORDTYPE2=<bootrectype2>,BOOTFILENAME2=<bootfilename2>,BOOTIPADDR2=<bootipaddr2>,CL
I=<cli>"
;
Example 9-41 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,MACADDRES
S=000D56727245,BOOTRECORDTYPE1=FLASH,BOOTFILENAME1=15216EdfaSw_2.4.0,BOOTIPADDR1=0.0.0.0,B
OOTRECORDTYPE2=TFTP,BOOTFILENAME2=bin/15216EdfaSw_2.0.1,BOOTIPADDR2=172.22.128.249,CLI=TL1
"
;
Table 9-43 RTRV-NE-GEN Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Always EQPT.
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
name
|
string
|
System's sid/tid name (sysName).
|
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).
|
macaddress
|
string
|
MAC address of the system (cerent15216EdfaSromIpMgmtMacAddress).
|
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.6.38 RTRV-RFILE
Command Types
RTRV-RFILE
Lists a specific file or all files on the flash file system of the ONS 15216 EDFA2.
Syntax Description
RTRV-RFILE:[<tid>]::<ctag>::[<localfilename>+];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>:<localfilename>"
;
Example 9-42 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.4.0,passwd"
;
Example 9-43 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-44 RTRV-RFILE Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Always EQPT.
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
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.6.39 RTRV-TH-DWDM
Command Types
RTRV-TH-DWDM
Retrieves optical threshold and set point values for the ONS 15216 EDFA2.
Syntax Description
RTRV-TH-DWDM:[<tid>]:<aid>:<ctag>::[<thresholdtype>][,][,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>,DWDM:<thresholdtype>,,,<thresholdvalue>"
;
Example 9-44 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-45 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 dB.
|
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 dB.
|
LPOUTHYST
|
Loss of output power hysteresis (cerent15216EdfaLpoutHysteresis).
thresholdvalue can be between 0 and 1000, with default of 100, in units of 100 dB.
|
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.6.40 RTRV-TH-EQPT
Command Types
RTRV-TH-EQPT
Retrieves general threshold values for the ONS 15216 EDFA2.
Syntax Description
RTRV-TH-EQPT:[<tid>]:<aid>:<ctag>::[<thresholdtype>][,][,];
<sid> <date> <time>
M <ctag> COMPLD
"<aid>:<thresholdtype>,,,<thresholdvalue>"
;
Example 9-45 RTRV-TH-EQPT Command and Response
Amp01:ONS15216 EDFA2> RTRV-TH-EQPT:Amp01:ALL:123::;
Amp01 2001-06-08 09:00:05
M 123 COMPLD
"EQPT:MAXCTMP,,,65"
"EQPT:MAXCTMPHYST,,,1"
"EQPT:MINCTMP,,,-5"
"EQPT:MINCTMPHYST,,,1"
"PWR-A:PWRBUSMIN,,,420"
"PWR-A:PWRBUSMAX,,,570"
"PWR-B:PWRBUSMIN,,,420"
"PWR-B:PWRBUSMAX,,,570"
;
Table 9-46 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
|
|
Possible values are:
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
PWR-B
|
Affecting Power Bus B.
|
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 70 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.
|
PWRBUSMIN
|
Power bus minimum voltage (cerent15216EdfaPowerBusDCVoltageMin).
thresholdvalue can be between 350 and 700, with default of 420, 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.6.41 RTRV-TOD
Command Types
RTRV-TOD
Retrieves the date and time of the ONS 15216 EDFA2.
Syntax Description
RTRV-TOD:[<tid>]::<ctag>[::];
<sid> <date> <time>
M <ctag> COMPLD
"<tmody>,<tmtype>,<tmsrcdv>,<tmsrcst>"
;
Example 9-46 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-47 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.6.42 RTRV-USER-SECU
Command Types
RTRV-USER-SECU
Retrieves the access level of an existing user from the system. Does not return the password.
Syntax Description
RTRV-USER-SECU:[<tid>]:<uid>:<ctag>;
<sid> <date> <time>
M <ctag> COMPLD
"<uid>,<al>"
;
Example 9-47 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-48 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.6.43 SET-ATTR-DWDM
Command Types
SET-ATTR-DWDM
Sets the alarm severity (notification code) that is reported when a DWDM alarm is raised or cleared (derived from cerent15216EdfaAlarmState).
The notification code NA (Not Alarmed) reports a detected condition type by a REPT EVT message. The condition can be retrieved with the RTRV-COND command. The notification code NR (Not Reported) is not be reported by REPT EVT, but is retrievable via the RTRV-COND command.
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. This prioritization is not affected by the provisioned alarm severity. 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 on the ONS 15216 EDFA2.
Syntax Description
SET-ATTR-DWDM:[<TID>]:[<aid>]:<ctag>::[<ntfcncde>],[<condtype>][,,,];
Example 9-48 SET-ATTR-DWDM Command
Amp01:ONS15216 EDFA2> SET-ATTR-DWDM:Amp01:ALL:123::CR,LOS;
Table 9-49 SET-ATTR-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).
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
NULL
|
Deafults to NA.
|
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).
|
NULL
|
Defaults to ALL.
|
9.6.44 SET-ATTR-EQPT
Command Types
SET-ATTR-EQPT
Sets the alarm severity that is reported when a EQPT alarm is logged or cleared (derived from cerent15216EdfaAlarmState).
The notification code NA (NotAlarm) reports a detected condition type by a REPT EVT message. The condition can be retrieved with the RTRV-COND command. The notification code NR (Not Reported) is not be reported by REPT EVT, but is retrievable via the RTRV-COND command.
Syntax Description
SET-ATTR-EQPT:[<TID>]:[<aid>]:<ctag>::[<ntfcncde>],[<condtype>][,,,];
Example 9-49 SET-ATTR-EQPT Command
Amp01:ONS15216 EDFA2> SET-ATTR-EQPT:Amp01:PWR-A:123::CR,PWRBUSA,,,;
Table 9-50 SET-ATTR-EQPT Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Possible values are:
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Affecting Power Bus A.
|
PWR-B
|
Affecting Power Bus B.
|
ALL
|
Any or all of the preceding (command input only).
|
ntfncde
|
|
Notification code (maps to cerent15216EdfaAlarmPriority). Possible values are:
|
CR
|
Critical alarm.
|
MJ
|
Major alarm.
|
MN
|
Minor alarm.
|
NA
|
Not alarmed.
|
NR
|
Not reported.
|
NULL
|
Deafults to NA.
|
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).
|
DBBACKUP
|
"Database Backup In Progress" (cerent15216EdfaOpDbBackup).
|
DBRESTORE
|
"Database Restore In Progress" (cerent15216EdfaOpDbRestore).
|
LCRNT1
|
"Excessive Pump1 Current" alarm (cerent15216EdfaAlarmLcrnt1).
|
LCRNT2
|
"Excessive Pump2 Current" alarm (cerent15216EdfaAlarmLcrnt2).
|
LTMP1
|
"Excessive Pump1 Temperature" alarm (cerent15216EdfaAlarmLtmp1).
|
LTMP2
|
"Excessive Pump2 Temperature" alarm (cerent15216EdfaAlarmLtmp2).
|
PWRBUSA
|
"Power Bus A (voltage) Alarm" (cerent15216EdfaAlarmPowerBusA).
|
PWRBUSB
|
"Power Bus B (voltage) Alarm" (cerent15216EdfaAlarmPowerBusB).
|
SFTWDOWN
|
"TFTP Software Load" (cerent15216EdfaOpLoad).
|
NULL
|
Defaults to ALL.
|
9.6.45 SET-ATTR-SECUDFLT
Command Types
SET-ATTR-SECUDFLT
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 Description
SET-ATTR-SECUDFLT:[<tid>]::<ctag>::AL=<al>,TMOUT=<timeout>[,][,][,][,][,];
Example 9-50 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.6.46 SET-TH-DWDM
Command Types
SET-TH-DWDM
Sets optical threshold values for the ONS 15216 EDFA2.
Syntax Description
SET-TH-DWDM:[<tid>]:<aid>:<ctag>::<thresholdtype>,<thresholdvalue>[,,];
Example 9-51 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 dB.
|
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 dB.
|
LPOUTHYST
|
Loss of output power hysteresis (cerent15216EdfaLpoutHysteresis).
thresholdvalue can be between 0 and 1000, with default of 100, in units of 100 dB.
|
9.6.47 SET-TH-EQPT
Command Types
SET-TH-EQPT
Sets general threshold values for the ONS 15216 EDFA2.
Syntax Description
SET-TH-EQPT:[<tid>]:<aid>:<ctag>::<thresholdtype>,<thresholdvalue>[,,];
Example 9-52 SET-TH-EQPT Command
Amp01:ONS15216 EDFA2> SET-TH-EQPT:Amp01:ALL:123::MAXCTMP,60;
Table 9-53 SET-TH-EQPT Syntax Description
Parameter
|
Syntax
|
Description
|
aid
|
|
Possible values are:
|
EQPT
|
General parameters of the ONS 15216 EDFA2.
|
PWR-A
|
Sets Power Bus A and Power Bus B.
|
PWR-B
|
Sets Power Bus A and Power Bus B.
|
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 70 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.
|
PWRBUSMIN
|
Power bus minimum voltage (cerent15216EdfaPowerBusDCVoltageMin).
thresholdvalue can be between 350 and 700, with default of 420, in units of -10 VDC.
The power bus threshold has a 1.0V tolerance and a 1.0V hysteresis. If the minimum threshold is configured at 400 (-40 VDC), the alarm may raise anywhere between -42 to -40.5V and will not clear until the voltage goes above -41VDC.
|
PWRBUSMAX
|
Power bus maximum voltage (cerent15216EdfaPowerBusDCVoltageMax).
thresholdvalue can be between 350 and 700, with default of 570, in units of -10 VDC.
The power bus threshold has a 1.0V tolerance and a 1.0V hysteresis. If the maximum threshold is configured at 570 (-57 VDC), the alarm may raise anywhere between -57 to -58.5V and will not clear until the voltage goes below -56 VDC.
|
9.6.48 STA-LOCL-RST
Command Types
STA-LOCL-RST
Instructs the ONS 15216 EDFA2 to restore all the manufacturing default settings and reset the unit. The files on the flash file system (FFS), the date and time, and the values of manufacturing calibration are not affected. When this command is entered the unit resets itself.
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 Description
STA-LOCL-RST:[<tid>]::<ctag>;
Example 9-53 STA-LOCL-RST Command
Amp01:ONS15216 EDFA2> STA-LOCL-RST:Amp01::10;
