Chapter 3, TL1 Command Descriptions

TL1 Command Descriptions

This chapter contains descriptions of the TL1 commands for the ONS 15216 100 GHz OADMs.

3.1 Opening a TL1 Session

To begin using TL1, you must log into the OADM via the EIA/TIA-232 port.

Procedure: Log In to Initiate a TL1 Session

Step 1 Connect a serial EIA/TIA-232 straight cable from the serial port of the PC to the DB-9 connector on the front panel of the ONS 15216 OADM.

Step 2 Open the HyperTerminal application in the Accessories folder of the Windows Start menu.

Step 3 Set up the HyperTerminal session with the following parameters:

•Emulation: ANSI, 9600 bps

•Data bits: 8

•Parity: None

•Stop bit: 1

•Flow Control: None.

Step 4 Log into the OADM using the ACT-USER command in the following format:

ACT-USER:SOADM:CISCO15:001;

Step 5 Press Enter. The ONS 15216 OADM should then respond:

^^^SOADM^<date>^<time>

M^^001^COMPLD

Step 6 Set the ONS 15216 SOADM's geographical location, source identifier, IP address, and subnet mask information using the ED-NE-GEN command in the following format:

ED-NE-GEN:SOADM::003:::[NAME=<name>],[LONGITUDE=<longitude>],[LATITUDE=<latitude>],[IPADDR
ESS=<ipaddress>],[IPMASK=<ipmask>],[GATEWAY=<gateway>];

The OADM is now ready for remote communications with any other device on the same subnet via TL1 over TCP/IP.

Note The OADM will reboot so that the new IP address may be mapped to the MAC address of the OADM unit.

Step 7 Telnet to the IP address set in Step 6 and specify port 3083.

Step 8 Log in to OADM unit using ACT-USER command.

Step 9 Verify the information entered in Step 6 using the RTRV-NE-GEN command.

Procedure: Recover Lost Password

Warning Performing this procedure will cause an interruption of service.

Step 1 Connect a serial cable from the serial port of the PC to the DB-9 connector on the front panel of the ONS 15216 OADM and start the HyperTerminal application at 9600 bps.

Step 2 Power off the ONS 15216 OADM, and switch it back on after waiting a minimum of 5 seconds.

Step 3 During the boot-up process, a prompt appears in the following format: SOADM>.When this prompt appears, press the tilde (~) key.

Step 4 Enter Y (yes) to enable user recovery when the user recovery prompt appears.

Step 5 Repeat Step 1.

The default user account of CISCO15 with no password is now re-enabled, allowing the user to log in and modify user accounts as necessary. All other SOADM settings are retained during this process.

Procedure: In-Service TL1 Software Upgrade

Note The following software upgrade procedure applies to software upgrades from any 2.0.X load through the upgrade to 2.1.X or 2.2.X.

Step 1 On the TL1 port, use theACT-USER command to log into an admin level (RWA) user account.

Step 2 Issue the RTRV-NE-GEX command to retrieve the current executing file name (soadma.out or soadmb.out).

Step 3 Initialize the SOADM FTP server by issuing the INIT-SYS::ALL:123::2;

Step 4 On a workstation, FTP to the IP address of the ONS 15216 OADM. Access FTP using an admin (RWA) level user name and password.

Step 5 Issue the bin command to ensure that the new software is uploaded in binary format.

Step 6 Upload the new software.

a. If the current executing file name is soadmb.out, issue the put drive:\path..\<new software load name>.out /fd/soadma.out command

b. if the current executing file name is soadma.out, issue the put drive:\path..\<new software load name>.out /fd/soadmb.out command.

Step 7 Close the FTP session by typing quit.

Step 8 On the TL1 port, issue the INIT-SYS::ALL:123::1; command to restart the controller board.

This terminates the user session.

3.2 TL1 Commands

The ONS 15216 OADM TL1 commands are broken into seven categories: Environment, Equipment, Fault, Log, Performance, Security, and System. Table 3-1 lists the commands by category. Following the table, the commands are listed and described alphabetically.

Table 3-1 ONS 15216 OADM TL1 Commands by Category
Category	Command
Environment	REPT ALM COM RTRV-ALM-COM
Equipment	RST-EQPT
Fault	REPT ALM DWDM REPT EVT DWDM RTRV-ALM-ALL RTRV-ALM-DWDM RTRV-COND-ALL RTRV-COND-DWDM
Log	RTRV-AO
Performance	ED-DWDM RTRV-NE-GEN RTRV-TH-DWDM SET-TH-DWDM
Security	DLT-USER-SECU ED-PID ED-USER-SECU ENT-USER-SECU RTRV-DFLT-SECU RTRV-USER-SECU SET-ATTR-SECUDFLT
System	ACT-USER ALW-MSG-ALL CANC-USER ED-DAT ED-NE-GEN INH-MSG-ALL INIT-SYS RTRV-DWDM RTRV-INV RTRV-HDR RTRV-STATUS

3.2.1 ACT-USER: Activate User

The ACT-USER command sets up a session NE.


Section	ACT-USER Description
Category	System
Security	Read Only
Related Messages	ALW-MSG-ALL CANC-USER DLT-USER-SECU ED-DAT ED-PID ED-USER-SECU ENT-USER-SECU INH-MSG-ALL INIT-SYS RTRV-HDR RTRV-USER-SECU
Input Format	ACT-USER:[<TID>]:<UID>:<CTAG>::<PID>;
Input Parameters	•<UID> is the user identifier and a string. •<PID> is the user login password or private identifier and a string.
Example	Input ACT-USER:TID:JOE:100::******;
Errors	-

3.2.2 ALW-MSG-ALL: Allow Message All

The ALW-MSG-ALL command permits or resumes the dispatch of automatic messages from the NE which were inhibited by an INH-MSG call. Unreported alarms in existence at the time of restoration should be transmitted to the operating system with the Report Alarm message.


Section	ALW-MSG-ALL Description
Category	System
Security	-
Defined	Telcordia GR-833
Related Messages	ACT-USER CANC-USER ED-DAT INH-MSG-ALL INIT-SYS RTRV-HDR
Input Format	ALW-MSG-ALL:[TID]:[aid]:<ctag>::[<ntfcncde>],[<automsg>][,];
Input Parameters	•<aid> Access ID. The <aid> is optional, and a null value is equivalent to "ALL". • <ntfcncde> is a 2-character notification code associated with some automatic messages. <ntfcncde> is of type NotificationCode. • <automsg> is the type of event for which automatic reporting is to be resumed after having been in the INH-MSG mode. <automsg> is of type Automsg.
Example	Input ALW-MSG-ALL:TID:ALL:123::CR,LOSDROP;
Errors	This command can generate any of the default errors.

3.2.3 CANC: Cancel

Reports the occurrence of a session timeout event. CANC is an autonomous message transmitted by the NE to a user when a session established by that user is terminated because no messages were exchanged for a long period of time, a timeout. The timeout period is set based on the user's privilege. When a timeout occurs, the corresponding port drops and the next session initiation at that port requires the regular login procedure.


Section	CANC Description
Category	Security
Security	Retrieve
Defined
Related Messages	ACT-USER CANC-USER RTRV-DFLT-SECU SET-ATTR-SECUDFLT
Output Format	SID DATE TIME A ATAG CANC <UID> ;
Output Parameters	<UID> refers to the user's identification whose session is terminated due to timeout; <UID> is any combination of up to 10 alphanumeric characters. <UID> is a string.
Example	Output TID-000 1998-06-20 14:30:00 A 001 CANC CISCO15
Errors	This command can generate any of the default errors.

3.2.4 CANC-USER: Cancel User

The CANC-USER cancels a login session or logs off.


Section	CANC-USER Description
Category	System
Security	Read Only
Defined	Telcordia TR-835
Related Messages	ACT-USER ALW-MSG-ALL DLT-USER-SECU ED-DAT ED-PID ED-USER-SECU ENT-USER-SECU INH-MSG-ALL INIT-SYS RTRV-HDR RTRV-USER-SECU
Input Format	CANC-USER:[TID]:<uid>:<ctag>;
Input Parameters	<uid> is the user's identifier for the session to be cancelled. <uid> is a string.
Example	Input CANC-USER:TID:JOE:100;
Errors	This command can generate any of the default errors.

3.2.5 DLT-USER-SECU: Delete User Security

The DLT-USER-SECU command enables administrators to remove users. Only an administrator can do this. The AID block contains the user identifier.


Section	DLT-USER Description
Category	System
Security	Administrator
Defined	Telcordia TR-835
Related Messages	ACT-USER CANC-USER ED-PID ED-USER-SECU ENT-USER-SECU RTRV-USER-SECU
Input Format	DLT-USER-SECU:[TID]:<uid>:<ctag>;
Input Parameters	<uid> is the user's identifier.<uid> is a string.
Example	Input DLT-USER-SECU:TID:UID:1223;
Errors	This command can generate any of the default errors.

3.2.6 ED-DAT: Edit Date and Time

The ED-DAT command allows you to edit the date and/or time of the NE.


Section	CANC-USER Description
Category	System
Security	Read/Write
Defined	Telcordia GR-199
Related Messages	ACT-USER ALW-MSG-ALL CANC-USER INH-MSG-ALL INIT-SYS RTRV-HDR
Input Format	ED-DAT:[TID]::<ctag>::[date],[time];
Input Parameters	[date] Change the date to this value. May be optional if [time] field is not null. [time] Change the time to this value. May be optional if [date] field is not null.
Example	Input ED-DAT:TID::CTAG::YYYY-MM-DD,HH-MM-SS;
Errors	This command can generate any of the default errors.

3.2.7 ED-DWDM: Edit DWDM

The ED-DWDM command sets the configuration mode for each pair of add/drop channels in an OADM. ED-DWDM has three modes: SETPOINT, OFF, and DISABLE. The drop channel loss of signal alarm can be enabled or disabled using the ED-NE-GEN command. Refer to Table 2-9 on page 2-7 for a description of the configuration modes. The acceptable range of values for the default add channel power setpoint is -29 to +3.


Section	ED-DWDM Description
Category	Performance
Security	Read/Write
Defined	Telcordia GR-199 as part of the generic ED-modifier message
Related Messages	-
Input Format	ED-DWDM:[TID]:<aid>:<ctag>::[<configmode>]:[<dftpwradd>][:];
Input Parameters	•<aid> is the access identifier AID-SOADM. The access identifier refers to the Add port of the add/drop channel pair. •<configmode> sets the configuration mode. <configmode> is of type Configmode. •<dftpwradd> is the default add channel power, and may be a positive value (expressed with a "+" symbol when entering value) or a negative value (expressed with a "-" symbol when entering vaule. <dftpwradd> is a float.
Example	Input ED-DWDM:TID:AID:CTAG::SETPOINT:-3.0;
Errors	This command can generate any of the default errors.

3.2.8 ED-NE-GEN: Edit Network Element GEN

The ED-NE-GEN command edits the NE's TID, node name, location, and IP address. The command also enables and disables the drop channel signal loss alarm (ON: enable; OFF: disable).

You must edit the IP address and IP mask at the same time. After the IP address is changed, the system will be restarted with the new IP address.

The input format in the following table applies to the Four-Channel ONS 15216 OADM. For the One-Channel and Two-Channel modules, ignore the fields that do not apply. You do not need to follow the order shown in the input format example.


Section	ED-NE-GEN Description
Category	System
Security	Read/Write/Administrator
Related Messages	-
Input Format	ED-NE-GEN:[TID]::<ctag>:::[NAME=<name>],[LONGITUDE=<longitude>],[LATITUDE=<latitude>],[IPADDRESS= <ipaddress>],[IPMASK=<ipmask>],[GATEWAY=<gateway>],[ALM-LOSDROP-WEST-1=<almLosdropWest1>],[ALM-LOSDROP-EAST-1=<almLosdropEast1>],[ALM-LOSDROP-WEST-2=<almLosdropWest2>],[ALM-LOSDROP-EAST-2=<almLosdropEast2>],[ALM-LOSDROP-WEST-3=<almLosdropWest3>],[ALM-LOSDROP-EAST-3=<almLosdropEast3>],[ALM-LOSDROP-WEST-4=<almLosdropWest4>],[ALM-LOSDROP-EAST-4=<almLosdropEast4>];
Input Parameters	•<tid> is the source ID for the NE. <tid> is a string. • <name> is the node name for each OADM. <name> is a string. • <longitude> is the longitude of the NE location. <longitude> is a string. • <latitude> is the latitude of the NE location. <latitude> is a string. • <ipaddress> is the IP address of the NE. <ipaddress> is a string. • <ipmask> is the subnet mask of the NE. <ipmask> is a string. •<gateway> is the gateway for the NE to use. <gateway> is a string.
Example	Input ED-NE-GEN:<tid>::CTAG:::NAME=SOADM-1,LONGITUDE=100,LATITUDE=45,IPADDRESS=IPADDRESS,IPMASK=IPMASK,GATEWAY=GATEWAY,ALM-LOSDROP-WEST-1=ON, ALM-LOSDROP-EAST-1=ON, ALM-LOSDROP-WEST-2=ON, ALM-LOSDROP-EAST-2=ON, ALM-LOSDROP-WEST-3=ON, ALM-LOSDROP-EAST-3=ON, ALM-LOSDROP-WEST-4=ON, ALM-LOSDROP-EAST-4=ON;
Errors	This command can generate any of the default errors.

3.2.9 ED-PID: Edit Password

The ED-PID command allows you to change your own password. Other user identification and access changes can only be made by users with write access. All PID (password) values must be an ASCII string of up to 10 characters, two of which must be non-alphabetic and one of which must be a special character ("#", "%", or "+" only).


Section	ED-PID Description
Category	Security
Security	Read/Write
Defined	Telcordia TR-835
Related Messages	ACT-USER CANC-USER DLT-USER-SECU ED-USER-SECU ENT-USER-SECU RTRV-USER-SECU
Input Format	ED-PID:[TID]:<uid>:<ctag>::<oldpid>,<newpid>;
Input Parameters	•<uid> is the identifier for the user. <uid> is a string. • <oldpid> is the old password for the user. <oldpid> is a string. • <newpid> is the new password for the user. <newpid> is a string.
Example	Input ED-PID:TID:JOE:CTAG::***,***;
Errors	This command can generate any of the default errors.

3.2.10 ED-USER-SECU: Edit User Security

The ED-USER-SECU command allows administrators to edit a user's privileges, password, or ID.

Note The <PID> is a string of up to 10 characters where at least 2 characters are non-alphabetic with at least one special character (+, %, or #).


Section	ED-USER-SECU Description
Category	Security
Security	Administrator
Defined	Telcordia TR-835
Related Messages	ACT-USER CANC-USER DLT-USER-SECU ED-PID ENT-USER-SECU RTRV-USER-SECU
Input Format	ED-USER-SECU:[TID]:<uid>:<ctag>::<newuid>,<newpid>,,<uap>;
Input Parameters	•<uid> is the user identifier. <uid> is a string. •<newuid> is the user's new identifier. <newuid> is a string. •<newpid> is the user's new password. <newpid> is a string. •<uap> is the user's access privilege. It is a type of user privilege.
Example	Input ED-USER-SECU:TID:Jone:1::Mike,*****,,RWA;
Errors	This command can generate any of the default errors.

3.2.11 ENT-USER-SECU: Enter User Security

The ENT-USER-SECU command allows administrators to add a user account. Up to 21 (20 in addition to default) user accounts may be created.

Note The <PID> is a string of up to 10 characters where at least 2 characters are non-alphabetic with at least one special character (+, %, or #).


Section	ENT-USER-SECU Description
Category	Security
Security	Administrator
Defined	Telcordia TR-835
Related Messages	ACT-USER CANC-USER DLT-USER-SECU ED-PID ED-USER-SECU RTRV-USER-SECU
Input Format	ENT-USER-SECU:[TID]:<uid>:<ctag>::<pid>,,<uap>[:];
Input Parameters	•<uid> is the user identifier. <uid> is a string. •<pid> is the password or private identifier of the user. <pid> is a string. •<uap> is the access privilege of the user. <uap> is of type UserPrivilege.
Example	Input ENT-USER-SECU:TID:Joan:CTAG::A1+B2,,RW;
Errors	This command can generate any of the default errors.

3.2.12 INH-MSG-ALL: Inhibit Message All

The INH-MSG-ALL command instructs the NE to disable the transmission of autonomous messages. Enable the transmission of autonomous messages with the ALW-MSG command. Alarms will still be generated and available using RTRV-COND or RTRV-ALM. It should be noted that each new session allows every alarm to be viewed (equivelent to issuing the ALW-MSG-ALL command).


Section	INH-MSG-ALL Description
Category	System
Security	-
Defined	telcordia GR-833
Related Messages	ACT-USER ALW-MSG-ALL CANC-USER ED-DAT INIT-SYS RTRV-HDR
Input Format	INH-MSG-ALL:[TID]:[aid]:<ctag>::[<ntfcncde>],[<automsg>][,];
Input Parameters	•<aid> is the access ID. The <aid> is optional; a null value is equivalent to "ALL". • <ntfcncde> is a 2-character notification code associated with some automatic messages. <ntfcncde> is of type NotificationCode. • <automsg> is the type of event that will be automatically reported while autonomous messages are disabled. <automsg> is of type Automsg.
Example	Input INH-MSG-ALL:TID:ALL:124::MN,OUTOFMATCHTH;
Errors	This command can generate any of the default errors.

3.2.13 INIT-SYS: Initialize System

The INIT-SYS command initializes the entire NE to the default values for its TL1 interface and general parameters such as date and time.


Section	INIT-SYS Description
Category	System
Security	Read/Write/Administrator
Defined	Telcordia GR-833
Related Messages	ACT-USER ALW-MSG-ALL CANC-USER ED-DAT INH-MSG-ALL RTRV-HDR
Input Format	INIT-SYS:[TID]:<aid>:<ctag>::<ph>;
Input Parameters	•<aid> is the access ID. The <aid> is mandatory, and has a value of "EQPT". •<ph> is the phase of the system software to be activated during the booting process. Two versions of software can reside on an ONS 15216 OADM at any time. Setting the phase to a value of 0 will cause a software restart. Setting the phase to a value of 1 causes the TL1 software to switch to the other resident software load. Sending phase 1 again will cause the ONS 15216 to toggle back to the other file. ONS 15216 OADMs ship with only one phase (version) of software loaded. Setting the <ph> field to a value of 2 will initialize the OADM FTP server, and setting the field with a value of 3 will close the FTP server.
Example	Input INIT-SYS:TID:EQPT:1234::1;
Errors	This command can generate any of the default errors.

3.2.14 REPT ALM COM: Report Alarm Common

REPT ALM COM reports common equipment alarms. For the ONS 15216 OADM, it reports the following alarms: power feed A failure, power feed B failure.


Section	REPT ALM COM Description
Category	Environmental
Security	Read Only
Defined	Telcordia GR-833
Related Messages	REPT ALM DWDM REPT EVT DWDM RTRV-ALM-DWDM RTRV-COND-DWDM RTRV-ALM-COM SET-ATTR-SECUDFLT
Output Format	TID DATE TIME A ATAG REPT ALM COM ":<ntfcncde>,<almtype>,<ocrdat>, <ocrtm>,<conddescr>";
Output Parameters	•<ntfcncde> is the alarm level. It signals the severity of a new condition and has a value of CL (CLEAR) when this message signals that a condition is clear. <ntfcncde> is of type NotificationCode. • <almtype> is the alarm type. <almtype> is of type almtype. •<ocrdat> is the date when the triggering event occurred. •<ocrtm> is the time of day when the triggering event occurred. •<conddescr> is the detailed description of the alarm. <conddescr> is a string.
Output Example	001 REPT ALM COM "COM:MN,PWRAFAIL,NSA,02-26,12-00-00,,,,:\"POWER A FAILURE\""
Errors	This command can generate any of the default errors.

3.2.15 REPT ALM DWDM: Report Alarm DWDM

REPT ALM messages are generated autonomously by an NE to report a standing condition that requires immediate attention or to report that the condition is cleared. It does not signal environmental alarms; they are signaled using the REPT ALM COM command. It also does not signal non-alarmed conditions; they are signaled with the REPT-EVT command.


Section	REPT ALM DWDM Description
Category	Fault
Security	Read Only
Related Messages	REPT EVT DWDM RTRV-ALM-DWDM RTRV-COND-DWDM
Output Format	TID DATE TIME ** ATAG REPT ALM DWDM "<aid>:<ntfcncde>,<automsg>, <srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>, <almval>,<thlev>,:<conddescr>"
Output Parameters	•<aid> identifies the entity in the NE that the command pertains to. AID_SOADM is the add/drop channel pair identifier. •<ntfcncde> is a 2-character notification code. <ntfcncde> is of type NotificationCode. •<automsg> is the type of alarm indication. <automsg> is of type AlarmCondition. •<srveff> is the effect on service caused by the alarm condition. <srveff> is of type Service Effect. •<ocrdat> is the date when the event occurred. •<ocrtm> is the time when the event occurred. •<locn> is the location of the failure and refers to the entity identified by the AID. <locn> is of type Location. •<dirn> is the direction of the alarm and is relative to the entity identified by the AID. <dirn> is of type Direction. •<almval> is the measured value of a monitored parameter. For WEAKADD and OUTMATCH alarms, <almval> is the current add channel power. <almval> is a string. •<thlev> is the threshold level. <thlev> is a string. • <conddescr> is the detailed description of the trouble. <conddescr> is a string.
Example	Output TID-000 98-06-20 14-30-00** 001 REPT ALM DWDM "AID:CR,LOSADD,SA,12-28,12-00-00,FEND,AZ,-35,-32,:\"ADD CHANNEL SIGNAL LOSS\";
Errors	-

3.2.16 REPT EVT DWDM: Report Event DWDM

The REPT EVT DWDM alarm reports changes to the loss of signal threshold, the add/drop mismatching threshold, the VOA configuration mode, and the default add channel power.


Section	REPT EVT DWDM Description
Category	Fault
Security	Read Only
Defined	Telcordia GR-833
Related Messages	REPT ALM DWDM RTRV-ALM-DWDM RTRV-COND-DWDM
Output Format	TID DATE TIME ATAG REPT EVTDWDM"<aid>:<automsg>, <condeff>, <ocrdat>,<ocrtm>,<locn>,<dirn>,<newval>,<oldval>,:<conddescr>";
Ouput Parameters	•<aid> identifies the entity in the NE that the command pertains to. AID_SOADM is an add/drop channel pair identifier. •<automsg> is the type of event. <automsg> is of type Evt_DWDM. •<condeff> indicates the effect of the event on the condition of the NE. <condeff> is of type ConditionEffect. •<ocrdat> is the date when the event occurred. •<ocrtm> is the time of day when the event occurred. •<locn> is the location of the event and refers to the entity identified by the AID. <locn> is of type Location. •<dirn> is the direction of the event and is relative to the entity identified by the AID. <dirn> is of type Direction. •<newval> is the new threshold for the monitored parameter. <newval> is a string. •<oldval> is the old threshold for the monitored parameter. <oldval> is a string. • <conddescr> is the detailed description of the specific event. <conddescr> is a string.
Example	Output A 001 REPT EVT DWDM"AID:LOSTH,TC,12-28,12-00-00, LINE,NA,-32,-30, :\"SIGNAL LOSS THRESHOLD IS CHANGED\";
Errors

3.2.17 RST-EQPT:Restore Equipment

The RST-EQPT command instructs the NE to restore the equipment.

Note Setting the <mode> field to a value of NORM restores the default setup for the specified channel, including the working mode, default setpoint, and default thresholds. The FRCD command is used in case of rare VOA resets in case the VOA is locked.


Section	RST-EQPT Description
Category	Equipment
Security	Read/Write
Related Messages
Input Format	RST-EQPT:[TID]:<aid>:<ctag>::<mode>;
Input Parameters	•<aid> is the access identifier AID_SOADM. •<mode> is the mode which you will use to implement the command. <mode> is of type ModeofSwitch.
Example	Input RST-EQPT:TID:SOADM-WEST-1:123::NORM;
Errors	This command can generate any of the default errors.

3.2.18 RTRV-ALM-ALL: Retrieve Alarm All

This command retrieves all active alarms. The following alarms can be retrieved by using the RTRV-ALM-ALL command: Loss add channel power; Loss drop channel power; Add channel is out of tolerance; Add chanel is weak. Power supply A failure. Power supply B failure.


Section	RTRV-ALM-ALL Description
Category	Fault
Security	Read Only
Defined	Telcordia GR-833
Related Messages	REPT ALM DWDM REPT EVT DWDM RTRV-ALM-COM RTRV-ALM-DWDM RTRV-COND-ALL RTRV-COND-DWDM SET-ATTR-SECUDFLT
Input Format	RTRV-ALM-ALL:[TID]:[<aid>]:<CTAG>::[<ntfcncde>],[<alarmcondition>][,,,,];
Input Parameters	•[aid] is the AID ALL. A null value is equivalent to ALL. •[ntfncode] is a 2-character notification code. A null values is equivalent to ALL. •[alarmcondition] is the alarm type. A null value is equivalent to ALL.
Example	Input RTRV-ALM-ALL:TID:AID:229::MJ,WEAKADD;
Output Format	M CTAG COMPLD "<aid>,<dwdm>:<ntfcncde>,<alarmcondition>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>,:<conddescr>";
Output Parameters	•<aid> identifies the entity in the NE to which the command pertains. Access Identifier identifies an equipment unit, facility, link, packet link, or signaling link in the NE. <aid> is a String. •<dwdm> is a String. •<ntfcncde> is a 2-character notification code. <ntfcncde> is of type NotificationCode. •<alarmcondition> is the alarm type. <alarmcondition> is of type AlarmMsg. •<srveff> is the effect on service caused by alarm condition.<srveff> is of type ServiceEffect. •<ocrdat> is the date when the triggered alarm occurred. <ocrdat> is a Date. •<ocrtm> is the time when the triggered alarm occurred.<ocrtm> is a Time. •<locn> is the single location for which an alarm condition is being reported and refers to the entity identified by the AID. <locn> is of type Location. •<dirn> is the direction of the alarm condition and is relative to the entity identified by the AID. <dirn> is of type Direction. •<conddescr> is the detailed description of the alarm. <conddescr> is a String.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMPLD "AID,DWDM:MJ,WEAKADD,NSA,2002-1-31,00-00-00,NEND,ZA,: \"ADD CHANNEL SIGNAL IS LOWER THAN DROP CHANNEL SIGNAL FOR MATCH\""
Errors	This command can generate any of the default errors.

3.2.19 RTRV-ALM-COM: Retrieve Alarm Common

This command retrieves all active enviroronmental alarms. The following alarms can be retrieved: power feed A failure, power feed B failure.

Note The "PWR" LED on the front panel of the OADM unit will illuminate if either of the two power feeds (A or B) falls above -40 VDC.


Section	RTRV-ALM-COM Description
Category	Fault
Security	Read Only
Defined	Telcordia GR-833
Related Messages	REPT ALM COM REPT ALM DWDM REPT EVT DWDM RTRV-ALM-DWDM RTRV-COND-DWDM SET-ATTR-SECUDFLT
Input Format	RTRV-ALM-COM:[TID]:[<aid>]:<CTAG>::[<ntfcncde>],[<almtype>][,,,,];
Input Parameters	•[aid] is the access identifier. [aid] value is COM. •<ntfcncde> is a 2-character notification code associated with some automatic messages. <ntfcncde> is of type NotificationCode. •<almtype> is the alarm type. <almtype> is of type almtype.
Example	Input RTRV-ALM-COM:SOADM:COM:01::MN,PWRAFAIL;
Output Format	SID DATE TIME M CTAG COMPLD "<aid>,COM:<ntfcncde>,<almtype>,,<ocrdat>,<ocrtm>,,,:<conddescr>"
Output Parameters	•<aid> identifies the entity in the NE to which the command pertains. Access Identifier identifies an equipment unit, facility, link, packet link, or signaling link in the NE. <aid> is a String. •<ntfcncde> is a 2-character notification code. <ntfcncde> is of type NotificationCode. •<almtype> is the alarm type. <almtype> is of type almtype. •<ocrdat> is the date when the triggered alarm occurred. <ocrdat> is a Date. •<ocrtm> is the time when the triggered alarm occurred.<ocrtm> is a Time. •<conddescr> is the detailed description of the alarm. <conddescr> is a String.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMPLD "COM,COM:MN,PWRAFAIL,,01-20,10-00-00,,,:\"POWER A FAILURE\""
Errors	This command can generate any of the default errors.

3.2.20 RTRV-ALM-DWDM: Retrieve Alarm DWDM

Note The "LOS" LED on the front panel of the OADM unit will illuminate if there is a loss of drop and/or add channel power. Express (through) channels are not monitored. Additionally, the "FAIL" LED on the front panel of the OADM unit will illuminate if a power mismatch occurs between the add channel power and the SETPOINT value.

You can use RTRV-ALM commands to generate a report on the current state of all alarm conditions within the NE. The RTRV-ALM-DWDM command retrieves the following alarms:

•Loss in the add channel power.

•Loss in the drop channel power.

•A power mismatch between the add channel power and user SETPOINT value is out of tolerance.


Section	RTRV-ALM-DWDM Description
Category	Fault
Security	Read Only
Defined	Telcordia GR-833
Related Messages	REPT ALM DWDM REPT EVT DWDM RTRV-COND-DWDM
Input Format	RTRV-ALM-DWDM:[TID]:[<aid>]:<ctag>::[<ntfcncde>],[<alarmcondition>][,,,,];
Input Parameters	•<aid> is the access identifier. For this command, the AID parameter is the add/drop channel pair identifier. <aid> is a string. •<ntfcncde> is the notification code associated with the alarm conditions being retrieved. <ntfcncde> is of type NotificationCode. A null value is equivalent to ALL. • <alarmcondition> is the type of alarm condition. <alarmcondition> is of type AlarmCondition. A null value is equivalent to ALL.
Example	Input RTRV-ALM-DWDM:TID:AID:229::MJ,WEAKADD;
Output Format	TID DATE TIME M CTAG COMPLD "<aid>,DWDM:<ntfcncde>, <alarmconditon>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>,:<conddescr>";
Output Parameters	•<aid> is the access identifier. In this case, it is the add/drop channel pair identifier. <aid> is a string. •<ntfcncde> is the alarm level. It signals the severity of a new condition and has a value of CL (CLEAR) when this message signals that a condition is clear. <ntfcncde> is of type NotificationCode. • <alarmconditon> is the single type of alarm condition being reported on this particular line. <alarmconditon> is of type AlarmCondition. •<srveff> is the effect on service caused by alarm condition. srveff is of type ServiceEffect. •<ocrdat> is the date when the triggering event occurred. •<ocrtm> is the time of day when the triggering event occurred. •<locn> is the single location for which an alarm condition is being reported and refers to the entity identified by the AID. <locn> is of type Location. •<dirn> is the direction of the alarm condition and is relative to the entity identified by the AID. <dirn> is of type Direction. •<conddescr> is the detailed description of the alarm. <conddescr> is a string.
Output Example	TID-000 00-00 00-00-00 M 001 COMPLD"AID,DWDM:MJ,WEAKADD, NSA,00-00,00-00-00,NEND,ZA,:\"ADD CHANNEL SIGNAL IS LOWER THAN DROP CHANNEL SIGNAL FOR MATCH\";
Errors	This command can generate any of the default errors.

3.2.21 RTRV-AO: Retrieve Autonomous Output

The RTRV-AO command allows the OS to retrieve a copy of queued autonomous messages or missing autonomous messages. Examples of autonomous messages are REPT ALM and REPT EVT.

Note You can retrieve up to 1000 of the most recent autonomous messages (alarms and events). Normally you should limit this number to less than 200 or alarm reporting and activity by other users might be impacted. If no message range is specified, the last 20 messages are retrieved. To retrieve a large number of messages, obtain the log files through FTP by following steps 1-4 of the "In Service Upgrade Procedure", then using the "get" command to download "aologA.txt" and "aologB.txt".


Section	RTRV-AO Description
Category	Log
Security	Read Only
Defined	Telcordia GR-199
Related Messages	-
Input Format	RTRV-AO:[TID]:[<ao_id>]:<ctag>:::[ATAGSEQ=<atagseq>],[MSGTYPE =<msgtype>];
Input Parameters	•<ao_id> identifies each channel in the ONS 15216 OADM that the command pertains to. <ao_id> is AID_SOADM. A null value is equivalent to ALL. •<atagseq> is a rangeable integer that is an integral part of the ATAG of the autonomous message to be retrieved. ATAGSEQ = a&&b means a list ATAG range from a to b, with a and b as integers. A null value is equivalent to ALL. •<msgtype> is a message type, including EVT and ALM. <msgtype> is of type MessageType. A null value is equivalent to ALL.
Example	Input RTRV-AO:TID:AID:CTAG:::ATAGSEQ=20&&30,MSGTYPE=EVT;
Output Example	A 1 REPT EVT DWDM "SOADM-WEST-1:VOACONFIG,TC,08-08,08-46-59,LINE,NA,OFF,SETPOINT,:\"CHANGE VOA CONFIGURATION MODE\""
Output Parameters	If none of the stored automatic messages satisfy the selection criteria, a normal response is sent with no attached messages. If one or more stored autonomous messages satisfy the criteria, then the messages are reported in the normal response in ATAG order. If <atagseq> is NULL, the 20 latest messages are retrieved.
Errors	This command can generate any of the default errors.

3.2.22 RTRV-COND-ALL: Retrieve Condition All

The RTRV-COND-ALL command returns the current condition(s) related to the NE.


Section	RTRV-COND-ALL Description
Category	Fault
Security	Read Only
Related Messages	REPT ALM COM REPT ALM DWDM REPT EVT DWDM RTRV-ALM-ALL RTRV-ALM-COM RTRV-ALM-DWDM RTRV-COND-DWDM SET-ATTR-SECUDFLT
Input Format	RTRV-COND-ALL:[TID]:[<aid>]:<CTAG>::[<alarmcondition>][,,,];
Input Parameters	•<aid> is the AID ALL. A null value is equivalent to ALL. •<alarmcondition> is the alarm type. A null value is equivalent to ALL.
Example	Input RTRV-COND-DWDM:TID:AID:229::LOSADD;
Output Format	TID DATE TIME M CTAG COMPLD"<aid>,DWDM:<ntfcncde>, <alarmcondition>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>,<conddescr>";
Output Parameters	•<aid> identifies the entity in the NE to which the command pertains. Access Identifier identifies an equipment unit, facility, link, packet link, or signaling link in the NE. aid is a String. •<dwdm> access ID. dwdm is a String. •<ntfcncde> is a 2-character notification code. ntfcncde is of type NotificationCode. •<alarmcondition> is the condition type. alarmcondition is of type AlarmMsg. •<srveff> is the effect on service caused by alarm condition. srveff is of type ServiceEffect. •<ocrdat> is the date when the triggered alarm occurred. ocrdat is a Date. •<ocrtm> is the time when the triggered alarm occurred. ocrtm is a Time. •<locn> is the single location for which an alarm condition is being reported and refers ot the entity identified by the AID. locn is of type Location. •<dirn> is the direction of the alarm condition and is relative to the entity identified by the AID. dirn is of type Direction. •<conddescr> is the detailed description of the alarm. conddescr is a String.
Output Example	"AID,DWDM:CR,LOSADD,SA,00-00,00-00-00,FEND,AZ,\"LOSADD NOT ALARMED\""
Errors	This command can generate any of the default errors.

3.2.23 RTRV-COND-DWDM: Retrieve Condition DWDM

The RTRV-COND-DWDM command returns the current condition(s) related to optical channels in the NE.


Section	RTRV-COND-DWDM Description
Category	Fault
Security	Read Only
Related Messages	REPT ALM DWDM REPT EVT DWDM RTRV-ALM-DWDM
Input Format	RTRV-COND-DWDM:[TID]:[<aid>]:<ctag>::[<alarmcondition>][,,,];
Input Parameters	•<aid> Identifies the entity in the NE that the command pertains to. In this command, the <aid> parameter is AID_SOADM. A null value is equivalent to ALL. • <alarmcondition> is the type of condition to be retrieved. <alarmcondition> is of type AlarmCondition. A null value is equivalent to ALL.
Example	Input RTRV-COND-DWDM:TID:AID:229::LOSADD;
Output Format	TID DATE TIME M CTAG COMPLD"<aid>,DWDM:<ntfcncde>, <alarmcondition>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>,<conddescr>";
Output Parameters	•<aid> is the access identifier. For this command the AID parameter is the add/drop channel pair identifier. <aid> is a string. •<ntfcncde> is the notification code associated with the alarm conditions being retrieved. <ntfcncde> is of type NotificationCode. •<alarmcondition> is the type of indication reported on this line of the message. <alarmcondition> is of type AlarmCondition. •<srveff> is the effect on service caused by the alarm condition. <srveff> is of type ServiceEffect. •<ocrdat> is the date when the triggering event occurred. •<ocrtm> is the time of day when the triggering event occurred. •<locn> is the location of the alarm condition and refers to the entity identified by the AID. <locn> is of type Location. •<dirn> is the direction of the alarm and is relative to the entity identified by the AID. <dirn> is of type Direction. •<conddescr> is a detailed description of the condition. <conddescr> is a string.
Output Example	TID-000 06-20 14-30-00 M 001 COMPLD"AID,DWDM:CR,LOSADD, SA,06-20,12-00-00,FEND,AZ,\"LOSADD NOT ALARMED\" ;
Errors	This command can generate any of the default errors.

3.2.24 RTRV-DFLT-SECU: Retrieve Default Security

This command is used to retrieve the time interval of auto-logout associated with each user security level.


Section	RTRV-DFLT-SECU Description
Category	Security
Security	Read/Write/Administrator
Defined	-
Related Messages	ACT-USER CANC-USER DLT-USER-SECU ED-PID ED-USER-SECU ENT-USER-SECU RTRV-USER-SECU SET-ATTR-SECUDFLT
Input Format	RTRV-DFLT-SECU:[TID]:<uap>:<ctag>;
Input Parameters	<uap> is the user access privelege. <uap> is of type UserPrivelege. <uap> must not be null.
Example	Input RTRV-DFLT-SECU:TID:RWA:0001;
Output Format	SID DATE TIME CTAG COMPLD "TMOUT=<tmout>";
Output Parameters	•<tmout> is the time interval of auto logout. Value range is from 1 to 999 minutes. <tmout> is a string.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMPLD "TMOUT=60MIN";
Errors	This command can generate any of the default errors.

3.2.25 RTRV-DWDM: Retrieve DWDM

The RTRV-DWDM command retrieves the VOA configuration mode, the add channel power level, and the drop channel power level of the OADM.

Note The CALCSETP feature of the ONS 15216 OADM is a calculated value, and represents the OADM's recommended optical power level setting for a particular add channel as specified by the [aid]. Following this recommendation when selecting the setpoint value for a particular add channel will allow the composite outgoing signal (composed of express channels and newly added channels) to be as flat as possible. The formula used for this calculation is as follows: CALCSETP = PWRDROP + ILDROP - ILTHRU.


Section	RTRV-DWDM Description
Category	Performance
Security	Read Only
Defined	Telcordia GR-199 as part of RTRV-{modifier}-{modifier}
Related Messages	ED-DWDM
Input Format	RTRV-DWDM:[TID]:<aid>:<ctag>[::::];
Input Parameters	<aid> is the access identifier. For this command, the AID parameter is the add/drop channel pair identifier. <aid> is the AID AID_SOADM. The <aid> can be ALL.
Example	Input RTRV-DWDM:TID:AID:CTAG;
Output Format	TID DATE TIME CTAG COMPLD <aid>:CONFIGMODE=<configmode>, DFTPWRADD=<dftpwradd>,PWRADD=<pwradd>,PWRDROP=<pwrdrop>,ILADD=<iladd>,ILDROP=<ildrop>,ILTHRU=<ilthru>,CALCSETP=<calcsetp>";
Output Parameters	•<aid> is the access identifier. For this command, the AID parameter is AID-SOADM. The <aid> refers to the Add port of the add/drop channel pair. • <configmode> is the VOA configuration mode. <configmode> is of type Configmode. • <dftpwradd> is the default add channel power. <dftpwradd> is a string. • <pwradd> is the add channel power. <pwradd> is a string. • <pwrdrop> is the drop channel power. The <pwrdrop> is for the drop channel of the add/drop channel pair specified by the add channel <aid>. <pwrdrop> is a string. •<iladd> is the calculated insertion loss for the add channel. <iladd> is a string. •<ildrop> is the calculated insertion loss for the drop channel. <ildrop> is a string. •<ilthru> is the calculated insertion loss for the express/through channels. <ilthru> is a string. •<calcsetp> is the recommended set point for the corrseponding add channel. <calcsetp> is a string.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMPLD"AID:CONFIGMODE=SETPOINT, DFTPWRADD=5DBM,PWRADD=5DBM,PWRDROP=-28DBM,ILADD=0.5DB,ILDROP=1.0DB,ILTHRU=1.5DB,CALCSETP=-5DBM";
Errors	This command can generate any of the default errors.

3.2.26 RTRV-HDR: Retrieve Header

The RTRV-HDR command returns the current time and TID of the NE.


Section	RTRV-HDR Description
Category	System
Security	Read Only
Defined	Telcordia GR-833
Related Messages	ACT-USER ALW-MSG-ALL CANC-USER ED-DAT INH-MSG-ALL INIT-SYS
Input Format	RTRV-HDR:[TID]::<ctag>;
Example	Input RTRV-HDR:TID::100;
Errors	This command can generate any of the default errors.

3.2.27 RTRV-INV: Retrieve Inventory

The RTRV-INV command returns the CLEI code of the NE.


Section	RTRV-INV Description
Category	System
Security	Read Only
Defined	Telcordia GR-199
Related Messages	ACT-USER ALW-MSG-ALL CANC-USER ED-DAT INH-MSG-ALL INIT-SYS
Input Format	RTRV-INV:[TID]:[aid]:<ctag>[::::];
Input Parameters	<aid> is the access identifier. The AID parameter can be EQPT or ALL.
Example	Input RTRV-INV:TID:ALL:100;
Output Format	SID DATE TIME M CTAG COMPLD "<aid>:[CLEI=<clei>]"
Output Parameters	•<aid> is the access identifier. The AID parameter is EQPT. •[clei] is a String. [clei] is optional.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMPLD "EQPT:CLEI=<clei>"
Errors	This command can generate any of the default errors.

3.2.28 RTRV-NE-GEN: Retrieve Network Element General

The RTRV-NE-GEN command retrieves the following ONS 15216 OADM generic data:

•Inventory information (including manufacturer name, model number, serial number, software version, date of software update, firmware version, and date of firmware update)

•Channel number and corresponding wavelength of each channel

•Status of the drop channel signal loss alarm (ON: enable; OFF: disable)

•Name

•IP address

•Location


Section	RTRV-NE-GEN Description
Category	System
Security	Read Only
Defined	-
Related Messages	ED-NE-GEN
Input Format	RTRV-NE-GEN:TID::CTAG;
Example	Input RTRV-NE-GEN:<tid>::100;
Output Format	TID DATE TIME M CTAG COMPLD"[VENDOR=<vendor>],[MODEL= <model>],[SN=<sn>],[SOFTWARE=<software>],[SOFTWAREUPDATE=<softwareupdate>],[FIRMWARE=<firmware>],[FIRMWAREUPDATE=<firmwareupdate>][BOOTLOADER=VerXX.XX.XX],[CHANNUM=<channum>],[LAMBDA1=<lambda1>],[LAMBDA2=<lambda2>],[LAMBDA3=<lambda3>],[LAMBDA4=<lambda4>],[ALM-LOSDROP-WEST-1=<almLosdropWest1>],[ALM-LOSDROP-EAST-1=<almLosdropEast1>], [ALM-LOSDROP-WEST-2=<almLosdropWest2>],[ALM-LOSDROP-EAST-2= <almLosdropEast2>],[ALM-LOSDROP-WEST-3=<almLosdropWest3>],[ALM-LOSDROP-EAST-3=<almLosdropEast3>],[ALM-LOSDROP-WEST-4=<almLos dropWest4>],[ALM-LOSDROP-EAST-4=<almLosdropEast4>],[NAME=<name>],[LONGITUDE=<longitude>],[LATITUDE=<latitude>],[IPADDRESS=<ipaddress>],[IPMASK=<ipmask>],[GATEWAY=<gateway>],[A_POWER=<a_power>],[B_POWER=<b_power>];
Output Parameters	•<vendor> is the name. <vendor> is a string. <vendor> is optional. •<model> is the model number of the NE. <model> is a string. <model> is optional. •<sn> is the serial number. <sn> is a string. <sn> is optional. •<software> is the software version. <software> is a string. <software> is optional. •<softwareupdate> is the software update date. <softwareupdate> is a string. <softwareupdate> is optional. •<firmware> is the firmware version. <firmware> is a string. <firmware> is optional. •<firmwareupdate> is the firmware update date. <firmwareupdate> is a string. <firmwareupdate> is optional. •<channum> is the channel number. <channum> is a string. <channum> is optional. •<lambda1> is the wavelength of channel 1. <lambda1> is a string. <lambda1> is optional. •<lambda2> is the wavelength of channel 2. <lambda2> is a string. <lambda2> is optional. •<lambda3> is the wavelength of channel 3. <lambda3> is a string. <lambda3> is optional. •<lambda4> is the wavelength of channel 4. <lambda4> is a string. <lambda4> is optional. •<almLosdropWest1> is the status of the signal loss alarm switch of drop channel 1 (westbound ONS 15216 OADM). <almLosdropWest1> is a string. <almLosdropWest1> is optional. •<almLosdropEast1> is the status of the signal loss alarm switch of drop channel 1 (eastbound ONS 15216 OADM). <almLosdropEast1> is a string. <almLosdropEast1> is optional. •<almLosdropWest2> is the status of the signal loss alarm switch of drop channel 2 (westbound ONS 15216 OADM). <almLosdropWest2> is a string. <almLosdropWest2> is optional. •<almLosdropEast2> is the status of the signal loss alarm switch of drop channel 2 (eastbound ONS 15216 OADM). <almLosdropEast2> is a string. <almLosdropEast2> is optional. •<almLosdropWest3> is the status of the signal loss alarm switch of drop channel 3 (westbound ONS 15216 OADM). <almLosdropWest3> is a string. <almLosdropWest3> is optional. •<almLosdropEast3> is the status of the signal loss alarm switch of drop channel 3 (eastbound ONS 15216 OADM). <almLosdropEast3> is a string. <almLosdropEast3> is optional. •<almLosdropWest4> is the status of the signal loss alarm switch of drop channel 4 (westbound ONS 15216 OADM). <almLosdropWest4> is a string. <almLosdropWest4> is optional.
	•<almLosdropEast4> is the status of the signal loss alarm switch of drop channel 4 (eastbound ONS 15216 OADM). <almLosdropEast4> is a string. <almLosdropEast4> is optional. •<name> is the node name for each OADM. <name> is a string. <name> is optional. •<longitude> is the longitude of the NE location. longitude is a string. <longitude> is optional. •<latitude> is the Latitude of the NE location. <latitude> is a string. <latitude> is optional. •<ipaddress> is the IP address of the NE. <ipaddress> is a string. <ipaddress> is optional. •<ipmask> is the subnet mask of the NE. <ipmask> is a string. <ipmask> is optional. •<gateway> is the default gateway of the NE. <gateway> is a string. <gateway> is optional. •<a_power> is the state of the A side DC power feed. <a_power> is a string. •<b_power> is the state of the B side DC power feed. <b_power> is a string.
Output Example	One-Channel Module TID-000 98-06-20 14-30-00 M001COMPLD"VENDOR=CISCO, MODEL=SOADM-1CH-1530.33, SN=0001,SOFTWARE=2.0.0, SOFTWAREUPDATE=1-3-2001,FIRMWARE=1.2.7, FIRMWAREUPDATE=1-3-2001,CHANNUM=1,LAMBDA1=1530.33,ALM-LOSDROP-WEST-1=ON,ALM-LOSDROP-EAST-1=ON,NAME=SOADM-1,LONGITUDE=100,LATITUDE=45,IPADDRESS=10.0.0.2,IPMASK=255.0.0.0,A_POWER=OPERATING, B_POWER=OPERATING"; Two-Channel Module TID-000 98-06-20 14-30-00M 001 COMPLD"VENDOR=CISCO, MODEL=SOADM-2CH-1530.33,SN=0001,SOFTWARE=2.0.0,SOFTWARE UPDATE=1-3-2001,FIRMWARE=1.2.7,FIRMWAREUPDATE=1-3-2001,CHANNUM=2,LAMBDA1=1530.33,LAMBDA2=1531.12,ALM-LOSDROP-WEST-1=ON, ALM-LOSDROP-EAST-1=ON,ALM-LOSDROP-WEST-2=ON,ALM-LOSDROP-EAST-2=ON,NAME=SOADM-1,LONGITUDE=100,LATITUDE=45,IPADDRESS=10.0.0.2,IPMASK=255.0.0.0,A_POWER=OPERATING, B_POWER=OPERATING; Four-Channel Module TID-000 98-06-20 14-30-00M 001 COMPLD "VENDOR=CISCO,MODEL=SOADM-4CH-1530.33,SN=0001, SOFTWARE=2.0.0,SOFTWAREUPDATE=1-3-2001,FIRMWARE=1.2.7,FIRMWAREUPDATE=1-3-2001,CHANNUM=4,LAMBDA1=1530.33,LAMBDA2=1531.12,LAMBDA3=1531.90,LAMBDA4=1532.68, ALM-LOSDROP-WEST-1=ON, ALM-LOSDROP-EAST-1=ON,ALM-LOSDROP-WEST-2=ON,ALM-LOSDROP-EAST-2=ON,ALM-LOSDROP-WEST-3=ON,ALM-LOSDROP-EAST-3=ON, ALM-LOSDROP-WEST-4=ON,ALM-LOSDROP-EAST-4=ON,NAME= SOADM-1,LONGITUDE=100,LATITUDE=45,IPADDRESS=IPADDRESS, IPMASK=IPMASK,A_POWER=OPERATING, B_POWER=OPERATING;
Errors	This command can generate any of the default errors.

3.2.29 RTRV-STATUS: Retrieve Status

RTRV-STATUS command retrieves the user logged on status for the past 1 day from the current date and time.


Section	RTRV-STATUS Description
Category	System
Security	Read Only
Related Messages	-
Input Format	RTRV-STATUS:[TID]:<ocrdat>,<ocrtm>:<ctag>;
Input Parameters	•<ocrdat> is the date when the triggering event occurred. •<ocrtm> is the time of day when the triggering event occurred.
Input Example	RTRV-STATUS:TID:2002-05-21,10-10-00:123;
Output Format	TID DATE TIME M CTAG COMPLD"<ocrdat>,<ocrtim>:,<uid>,";
Output Parameters	•<ocrdat> is the date when the triggering event occurred. •<ocrtm> is the time of day when the triggering event occurred. •<uid> is the user ID.
Output Example	SID DATE TIME M CTAG COMPLD "<ocrdat>,<ocrtm>:,CISCO15,"
Errors	This command can generate any of the default errors.

3.2.30 RTRV-TH-DWDM: Retrieve Threshold DWDM

The RTRV-TH-DWDM command retrieves the loss signal and the add/drop mismatching thresholds.


Section	RTRV-TH-DWDM Description
Category	Performance
Security	Read Only
Related Messages	SET-TH-DWDM
Input Format	RTRV-TH-DWDM:[TID]:<aid>:<ctag>::[<montype>][,,];
Input Parameters	•<aid> is the access identifier. For this command, the AID parameter is the add/drop channel pair identifier. <aid> is the AID_SOADM. A null value is equivalent to ALL. •<montype> is the monitored type. <montype> is of type Threshold_DWDM. A null value is equivalent to ALL.
Example	Input RTRV-TH-DWDM:TID:SOADM-WEST-1:123::LOSTH;
Output Format	TID DATE TIME M CTAG COMPLD"<aid>,DWDM:<montype >,,,<thlev>";
Output Parameters	•<aid> is the access identifier. For this command, the AID parameter is the add/drop channel pair identifier AID-SOADM. •<montype> is the monitored type. <montype> is of type Threshold-DWDM. •<thlev> is the threshold level. <thlev> is a string.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMP "AID,DWDM:LOSTH,,,-30DBM";
Errors	This command can generate any of the default errors.

3.2.31 RTRV-USER-SECU: Retrieve User Security

The RTRV-USER-SECU command retrieves the privilege/security level of one or more users. This command does not return a user's password. Only an administrator can invoke the general version of this command that does not specify the <uid>. Individual users can only retrieve their own information by specifying their own <uid>. The AID block contains the user identifier(s).


Section	RTRV-USER-SECU Description
Category	Security
Security	Admin
Defined	Telcordia TR-835
Related Messages	ACT-USER CANC-USER DLT-USER-SECU ED-PID ED-USER-SECU ENT-USER-SECU
Input Format	RTRV-USER-SECU:[TID]:[<uid>]:<ctag>;
Input Parameters	<uid> is the identifier of the user. If this field is absent, the records of all users are returned. <uid> is a string.
Example	Input RTRV-USER-SECU:TID:admin:123;
Output Format	TID DATE TIME M CTAG COMPLD "<uid>:,<uap>";
Output Parameters	•<uid> is the identifier of the user. <uid> is a string. •<uap> is the user's access privilege, a type of user privilege. <uap> is of type UserPrivilege.
Output Example	TID-000 98-06-20 14-30-00 M 001 COMPLD "admin:,RWA";
Errors	This command can generate any of the default errors.

3.2.32 SET-ATTR-SECUDFLT: Set Attribute Security Default

This command is used to set the time interval of auto logout associated with each user access level. The user should note that he/she should manually log out and log back in for changes to the user timeout value to take effect.

Note When the auto-logout timer terminates a user session due to inactivity, the device will issue the CANC-SESSION autonomous message to inform the user that his/her session is no longer active.


Section	SET-ATTR-SECUDFLT Description
Category	Security
Security	Read/Write
Defined	-
Related Messages	REPT ALM DWDM REPT EVT DWDM RTRV-ALM-DWDM RTRV-COND-DWDM RTRV-DFLT-SECU
Input Format	SET-ATTR-SECUDFLT:[TID]::<ctag>::AL=<uap>,TMOUT=<tmout>[,,,,];
Input Parameters	•<tmout> is the time interval of auto logout. Value range is from 1 to 99 minutes. <tmout> is a string. A value of 0 disables the auto logout feature. •<uap> is the user access privelege. <uap> is of type user privelege. <uap> must not be null.
Input Example	SET-ATTR-SECUDFLT:TID::123::AL=RWA,TMOUT=12;
Errors	This command can generate any of the default errors.

3.2.33 SET-TH-DWDM: Set Threshold DWDM

The SET-TH-DWDM command sets the loss signal and the add/drop mismatching thresholds.


Section	SET-TH-DWDM Description
Category	Performance
Security	Read/Write
Defined	-
Related Messages	RTRV-TH-DWDM
Input Format	SET-TH-DWDM:[TID]:<aid>:<ctag>::<montype>,<thlev>[,,];
Input Parameters	•<aid> is the access identifier. For this command, the AID parameter is the add/drop channel pair identifier. <aid> is the AID-SOADM. •<montype> is the monitored type. <montype> is of type Threshold-DWDM. •<thlev> is the threshold level. <thlev> is a float.
Example	Input SET-TH-DWDM:TID:SOADM-WEST-1:123::LOSTH,30;
Errors	This command can generate any of the default errors.

Table Of Contents