Professional Documents
Culture Documents
Reference Guide
Copyright Notice
© Copyright 2005, 2006, 2007, 2008, 2009, 2010 JDS Uniphase Corporation
WaveShifter, WaveReady, and DenseMount are registered trademarks, and WR3500F, WR3500F-HP,
WR3100, COM-200, WRA-110, WRA-113, WRA-116, WRA-119, WRA-217, WRA-217OSC, WRA-217L,
WRA-219, WRA-219OSC, WRM-782, WRM-8004, WRS-051, WRT-740, WRT-760, WRT-780, WRT-781,
WRT-840, WRT-842, WRT-852, Node Manager, Multi-Node Manager, LP530, LightAmp and BrightAmp
are trademarks of JDS Uniphase Corporation.
All other trademarks mentioned in this document or Web site are the property of their respective owners.
For a complete list of trademarks, see Notices.pdf in the Software directory of the System Release Package
CDROM.
Notice
This material is protected by the copyright and trade secret laws of the United States and other countries.
Nothing in this document can be reproduced in any manner, either wholly or in part for any use whatsoever,
without the express written consent of JDS Uniphase Corporation.
Every effort was made to ensure that this information product was complete and accurate at the time of
printing. However, information is subject to change without notice. Revisions of this document or new
editions of it may be issued to incorporate such changes. JDS Uniphase Corporation in no way warrants the
information contained in this document.
Intended Audience
This guide is intended for network operators and technicians intending to use a TL1
interface to manage a WaveReady system.
Typographical Conventions
This document uses these typographic conventions:
• Bold text is used to emphasize parameters, input fields, menu options, ports and
light emitting diodes (LEDs) located on WaveReady module front panels.
• Italic text is used to reference titles of other publications and for emphasis.
• Courier text is used to indicate paths and filenames, user input, and system
output.
Document History
Document
Release Date Number Description
R4.4.1 June 2008 21063484-005 WaveReady Releases 4.4.0 and 4.4.1 provide support for
standard release features described in the applicable user
guides.In addition, release 4.4.0 provides support for new
equipment:
• WaveReady Transponder 780
• WRA-217L
• WRA-219 Release 4.4.1 also provides support for:
- Remote Fan Alarm Monitoring via linked WRT-840s
- Ethernet Management Link via WRT-780
R4.5.4 February 2009 21063484-006 WaveReady Releases 4.5.1, 4.5.3 and 4.5.4 provide support
for standard release features described in the applicable
user guides. In addition, these releases provide support for
new equipment:
• WaveReady Transponder 852
• WaveReady 3500F-2 shelf
R4.6.0 May 2009 21063484-007 WaveReady Release 4.6.0 provides support for standard
4.6.0 features described in the applicable user guides. In
addition, this release provides support for new equipment:
• WaveReady Muxponder 782
• This release also renames the WR3500F-HP shelf.
R4.6.3 June 2009 21063484-008 WaveReady Release 4.6.3 provides support for standard
4.6.3 features described in the applicable user guides. In
addition, this release provides support for new equipment:
• WaveReady Reconfigurable Optical Add/Drop Multi-
plexer (WRS-051)
Document
Release Date Number Description
R4.6.6 October 2009 21063484-009 WaveReady Release 4.6.6 provides support for standard
4.6.6 features described in the applicable user guides. In
addition, this release provides support for:
• IPv6 Addressing
• WRA-2xxOSC variants
• Node Manager access to CLI management sessions of the
WRM-8004
• Added Node Manager features
R 4.7 April 2010 21063484-010 WaveReady Release 4.7 provides support for standard 4.7
features described in the applicable user guides. In addition,
this release provides support for new equipment:
• WaveReady Multi-Node Manager
• WRT-781
• Updated SFP and XFP support and specifications
• Fast Fault Propagation update for 3s pulsing and rapidly
toggling LOS and LOL.
Ordering Information
Refer to the Product Release CD or contact JDSU customer support.
WaveReady Documents
Document
Number Product
21048030-010 WaveReady™ WR3100 Shelf Models DMS-3100DC002, DMS-3100AC002 Installation
and User Guide
21061772-002 WaveReady™ WR3100 Shelf Power Supply Installation and User Guide
Document
Number Product
21063701-010 WaveReady™ SNMP Reference Manual
21058348-010 WaveReady™ Transponder 760 Model WRT-760DT241B Installation and User Guide
21079332-010 WaveReady™ Transponder 840 Model WRT-840DT100B Installation and User Guide
10135542 LightAmp DWDM Optical Amplifier Model LAP-MCH00R00A Installation and User’s
Manual
21052361-012 WaveReady™ System Release 4.7.1 and Node Manager Release 4.7.1 Release Notes
Introduction
Transaction Language 1 (TL1) is an industry-recognized protocol used by
WaveReady products to exchange messages between individual modules and a
network management system that monitors and manages the system. WaveReady
modules support TL1 messages for network operations, provisioning, surveillance,
and commissioning.
The network management system communicates with the WaveReady
Communications 200 module (COM-200) through Transmission Control
Protocol/Internet Protocol (TCP/IP) connections. Users access modules and issue
TL1 commands through TCP/IP Telnet sessions.
The TL1 interface facilitates the performance of the following tasks:
• Commissioning
• Testing
• Provisioning
• Alarm and network surveillance
• Protection switching
Standards Compliance
The TL1 surveillance interface meets the following Telcordia Technologies, Inc.
standards:
• GR-833-CORE Issue 4 “Network Maintenance—Network Element and Transport
Surveillance Messages"
• GR-811-CORE, "Operations Application Messages – TL1 Message Index"
• GR-835-CORE, "OTGR: Operations Applications – NE/NS Security Administration
Messages"
• SR-1665, "NMA Operations System Generic Transport Network Element Interface
Support"
• GR-1093-CORE, "Generic State Requirements for Network Elements"
The WaveReady COM-200 manages security access to the modules in the system
through these log-in services:
• Identification
• Authentication
• System access control
• Resource access control
• Security log
The COM-200 maintains a Security log (database) of events related to security
management. Logged events include:
System Access
The WaveReady system controls access to the system and monitors user sessions.
System access control has the following features:
• Displays a “no trespassing” warning when a log-in is initiated.
• A log-in procedure is suspended after three unsuccessful attempts.
• A session is terminated if it is idle for 25 (default) consecutive minutes (user must
log-in again and initiate a new session).
Default Accounts
The WaveReady system supports two default user accounts. The SUPERUSER
account is carried by the backplane EEPROM, can not be deleted, retains its
password on the shelf (and, therefore does not move with the COM-200 card). The
SUPERUSER account should therefore should be reserved for
emergency/recovery procedures only.
JDSU recommends that provisioned accounts be used for general use. To this end,
each COM-200 ships with a default provisioned account called ADMINUSER
which should be used if no other accounts are created.
The SUPERUSER and ADMINUSER accounts have the maximum authorization
privileges, cannot be deleted, and are not visible to other users. These default
accounts (and users with user access privilege (UAP) level 5) are authorized to
create and delete other user accounts, and assign user access privileges to accounts.
When installed, the COM-200 module is initialized with two default user
accounts:
• Default superuser account using the backplance EEPROM with default user
identification and password (TL1 parameter <uid> is SUPERUSER and TL1
parameter <pid> is Sup%9User).
The extent of a user's access to the system is determined by the level of user access
privilege (UAP) assigned to the account.
Each user that is added to the system must have user access privileges (UAP)
assigned, to identify the extent of the user's authorization level (AL) for each
command function category (FC). UAPs take the following form:
<fc><al>[&<fc><al>[&<fc><al> [&<fc><al>[&<fc><al>]]]]
Multiple functional category authorization levels (FCALs) are assigned by using
single ampersands (&) as delimiters. When multiple FCALs are specified, the
order is not important.
TL1 commands are grouped into the following five Function Categories:
• Security Administration (S)
• Provisioning (P)
• Performance Monitoring (PM)
• Maintenance (M)
• Test Access (T)
For each FC, a user can have one of six authorization level values. The allowable
values are:
• 0 (zero)—where 0 means the user is not authorized to issue those commands
• from 1 (low, default) to 5 (high)
NOTE: At a minimum, users must be assigned at least an S1 in order to log-in, log-out, and
change their own passwords.
The following table lists the possible FCAL values
Values Description
M0 Maintenance level 0, no authorization
Values Description
S3 Security & Administration level 3, medium authorization
Passwords
- period (.)
- number sign (#)
- percentage sign (%)
- plus sign (+)
- underscore (_), and
- hyphen or dash (-)
The following characters are not supported for the password:
- semicolon (;)
- colon (:)
- ampersand (&)
- comma (,)
- question mark (?), and
- all control characters
NOTE: The system does not prevent a user from selecting a password that is currently associ-
ated with an enabled or disabled user account.
_ 2. If this is the first login by a new user account, enter the user name and password
assigned by the network administrator.
TL1 Prompt
The TL1 prompt is indicated by “agent>” displayed on the left side of the screen.
TL1 command syntax uses a semicolon (;) to indicate the end of a command. A
TL1 command is executed immediately after the semicolon is typed. Pressing
Enter is not necessary to execute the command.
NOTE: A semicolon is shown at the end of all TL1 commands in this guide.
- period (.)
- number sign (#)
- percentage sign (%)
- plus sign (+)
- underscore (_), and
- hyphen or dash (-)
The following characters are not supported for the password:
- semicolon (;)
- colon (:)
- ampersand (&)
- comma (,)
- question mark (?), and
- all control characters
NOTE: The system does not prevent a user from selecting a password that is currently associ-
ated with an enabled or disabled user account.
When a COM-200 is first installed in a WaveReady shelf, the initial log-in must
use the factory default username and password. The defaults are:
Username: SUPERUSER
Password: Sup%9User
Command Structure
TL1 command syntax has a rigid structure that follows these rules.
• All commands begin with a verb, followed by a hyphen, and a modifier, for
example ED-EQPT (Edit-Equipment), or -ALM (Retrieve-Alarm).
• A second hyphen and a secondary modifier can follow the first, for example
RTRV-ALM-EQPT (Retrieve-Alarm-Equipment).
• The <tid> is next, usually followed by the <aid> and <ctag> fields.
• The <ctag> can be followed by a general block containing additional parameters
needed for the command.
The following is an example of aTL1 command, showing the typical TL1
command structure: VERB-MODIFIER:<tid>:<aid>:<ctag>::parameter-list;
NOTE: The order of <aid>, <ctag>, and additional parameters can vary from one command
group to another. See the detailed command descriptions in this manual, for specific informa-
tion.
TL1 Notation
The following table lists the meaning of the notations used to define the language
of TL1 messages.
Notation Description
cr ASCII carriage return
^ ASCII space
Notation Description
& In a command, a single ampersand (&) can be used to separate
individual equipment and facility objects when listing multiple
items in the same parameter.
TL1 Punctuation
TL1 commands use colons (:), commas (,) and semicolons (;).
• Colons and commas separate command elements
• Semicolons are the signal to the system that the command is complete. The
system executes the command immediately after a semicolon is typed on the
command line.
TL1 also uses ampersands singly (&) to list items.
NOTE: All the punctuation shown in the command descriptions must be typed or the system
cannot execute the command.
TL1 Messages
Autonomous Messages
Response Messages
The first line contains the source identifier (SID) of the equipment that originally
sent the message, and the date and time (YY-MM-DD and HH:MM:SS) the
message was sent.
The format of the header of a normal completion or error response is:
^^^<rsphdr> <cr> <lf>
where <rsphdr> has the format:
<source identifier>^<date>^<time>
• The SID matches the TID of the NE responding to the command.
• The date is in the form YY-MM-DD
• The time is expressed in terms of a 24 hour clock, and has the form HH:MM:SS.
The second line of the TL1 response header identifies if the response is an
autonomous or a non-autonomous message.
Unless otherwise indicated in the detailed syntax description in this document, the
normal, successful response format for TL1 input commands is as follows:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Error Response
If a TL1 command is not successful, the system returns a DENY response with a
TL1 error. A description of the situation under which the problem occurred is
reported with the error code. For a complete list, see Error Codes on page 11-47.
The format of an error message is as follows:
sid date time
M ctag DENY
<errcde>
/* <errmsg> */
Some TL1 responses and autonomous messages include a date and time parameter
indicating when the event occurred. The format of this occurrence date and
occurrence time differs from the format of the date and time described in the
standard normal response.
The format of the <ocrdat> is MOY-DOM, where
• MOY (month-of-year)-range is 1-12
• DOM (day-of-month)-range is 1-31
The format of the <ocrtm> is HOD-MOH-SOM, where
• HOD (hour-of-day)-range is 0-23
• MOH (minute-of-hour)-range is 0-59
• SOM (second-of-minute)-range is 0-59
After typing the semicolon on the command line, the system either completes or
denies the command. If, however, the system does not respond after two seconds,
the system returns the following intermediate acknowledgement response, which
indicates the progress of the request:
<acknowledgement code>[^<ctag>]<cr><lf>
where <acknowledgement code> is IP, NA, or RL.
The TL1 prompt does not return until the command completes successfully, or
fails.
The following table lists the possible values for the acknowledgement
(<acknowledgement code>) field.
Value Description
IP In Progress The system is executing the command. Other messages
follow, for example, a CMPLD response.
RL Repeat Later The system cannot execute the command due to a lack
of system resources.
Some TL1 commands allow listing multiple values for a single parameter, using an
ampersand (&) to separate each item in the list. The format for listing parameter
values is:
<First value>&<Second value>
The WaveReady system does not support listing and ranging of AIDs. In general,
one—and only one—<aid> is permitted for most TL1 commands. Some
commands are exceptions, and can interpret a blank or null <aid> or the word
"ALL" as referring to all slots. See the detailed command descriptions for these
exceptions.
VERB-MODIFIER:<tid>:<aid>:<ctag>::<First value>&<Second value>&<Third
value>;
The system identifier (SID) or target identifier (TID) is between 1-20 characters in
length and is composed of a combination of alphanumerics (ASCII letters or
digits) and underscores (_) or dashes (-). The SID must begin with a letter, and if a
dash (-) is included, the dash must be followed by a letter. A SID as a Network
Element identifier must be unique within a network. Therefore, to ensure its
uniqueness, the SID default value is based on shelf serial number.
NOTE: A changed TID is not activated until the COM-200 reboots.
The CTAG is used to match an input command to the result of the command.
The format of the CTAG is alphanumeric and can be up to six characters in length.
The system returns the CTAG with all response messages, including confirmation,
failed and syntax error messages, and retrieved reports. The system does not
return the CTAG with autonomous messages.
The correlation tag (CTAG) is an OSS-assigned integer that correlates
acknowledgments, errors, and responses with an originating request.
A CTAG is a sequential command identifier used with every command input.
The CTAG is part of the staging block of a TL1 input message. A CTAG is a TL1
identifier, which means that its valid value is a string of no longer than 6
characters. The CTAG block is required, and allows one parameter - CTAG.
The CTAG must be assigned by the OS and must be included in NE input and
response messages where specified.The OS arbitrarily assigns a non-zero CTAG
value for the input message. The NE copies this value into the appropriate CTAG
field of the output response(s) associated with that input command. The CTAG is
required in responses when an NE is capable of processing more than one input
command at a time.
Conversely, its exclusion implies that an NE is capable of processing only one
input command at a time. In an acknowledgement that has a code of NA (no
acknowledgement possible). The NA code sometimes occurs because of garbled
transmission. If the CTAG value of the command cannot be determined, then the
single character zero (0) should be used as the acknowledgment CTAG value. For
a rejected command, the CTAG may not be available for inclusion in the response.
In this case, the single character "0" (zero) will be output for the CTAG. When long
responses (more than 4096) characters occur, they may be split. In such cases, the
greater than (>) termination character is used for each message segment, and all
segments have the same CTAG value.
message. Generally the ATAG consists of an integer number (e.g., 113). They are
typically in sequence, incremented by one for each message.
By checking the ATAG of each message received, the OSS can verify that no
messages are lost. If a message is lost between the NE and the manager, the
manager sees an ATAG out of sequence and can request that missing data be
re-sent.
TL1 does not impose a restriction on the length of an ATAG, but an individual
environment might. The GR-833 restricts the ATAG to a 10-character maximum.
TL1 Modifiers
The WaveReady system supports five TL1 command modifiers: EQPT, OCH,
OSC, COM and ALL. For more information about how these modifiers apply to
individual alarms, events, and conditions, see Alarm and Event Condition
Reporting on page 11-4.
• EQPT refers to equipment-related conditions or events that apply to a single
module, but not all modules (for example, changing the state of a module from
out-of-service to in-service).
• OCH refers to conditions or events that are associated with an optical channel,
such as a bi-directional optical port on an WRT-760 module (for example, a loss of
input signal).
• OSC refers to conditions or events that are associated with supervisory channel
between transponders.
• COM refers to shelf-level conditions or events, such as an electrical power failure.
It is not specific to the COM-200.
• ALL refers to all modifiers: EQPT, OCH, OSC, and COM.
The Access Identification code (AID) directs and input command to its intended
physical or data entity inside the NE. Equipment modules and facilities are typical
examples of entities addressed by the access code.
The WaveReady system does not support listing and ranging of AIDs. In general,
one—and only one—AID is valid in most TL1 commands. Some commands are
exceptions, and can interpret a blank or null <aid>, or the word "ALL" as referring
to all <aid>s. See specific detailed command descriptions for these exceptions.
single port or the whole transponder. The TID of input commands for the far-end
port or transponder is the TID of the near-end shelf.
NOTE: If a COM-200 IS present at the far end, the TID of the far end shelf is used instead.The
'F' portion of this parameter refers to 'far end', while the <port number> is only used if the
command relates to a specific optical port on that far end transponder. For example, a valid
TL1 AID for a far-end transponder could be "1-2-2-F", while a valid AID for a specific port
on a far-end transponder could be "1-2-2-F-2".
AID Definitions
The following tables list and detail the specific AIDs used by the WaveReady
system.
ALL
{A-H}-1-{60.0,59.0,58.0,57.0,56.0,55.0,54.0,53.0,52.0,51.0,5
0.0,49.0,48.0,47.0,46.0,45.0,44.0,43.0,42.0,41.0,40.0,39.0,3
8.0,37.0,36.0,35.0,34.0,33.0,32.0,31.0,30.0,29.0,28.0,27.0,2
6.0,25.0,24.0,23.0,22.0,21.0,20.0,19.0,18.0,17.0}
AllChannelsIncAll ALL
{A-H}-1-{60.0,59.0,58.0,57.0,56.0,55.0,54.0,53.0,52.0,51.0,5
0.0,49.0,48.0,47.0,46.0,45.0,44.0,43.0,42.0,41.0,40.0,39.0,3
8.0,37.0,36.0,35.0,34.0,33.0,32.0,31.0,30.0,29.0,28.0,27.0,2
6.0,25.0,24.0,23.0,22.0,21.0,20.0,19.0,18.0,17.0}
AllMuxponders {1-3}-{1-13}-{1}
{1-3}-{1-13}-{2-4}-F-{1}
AllNetworkPorts {1-3}-{1-13}-{1-2}-2
{1-3}-{1-13}-{2-4}
{1-3}-{1-13}-{2-4}-F-{2-4}
AllPorts {1-3}-{1-13}-{1-2}-{1-2}
{1-3}-{1-13}-{1-4}
{1-3}-{1-13}-{2-4}-F-{1-4} {A-H}-1-1
{1-3}-{1-13}-{1-2}-{1-2}
{1-3}-{1-13}-{1-4}
{1-3}-{1-13}-{2-4}-F-{1-4}
{A-H}-1-1
{A-H}-1-ALL
{A-H}-1-{60.0,59.0,58.0,57.0,56.0,55.0,54.0,53.0,52.0,51.0,5
0.0,49.0,48.0,47.0,46.0,45.0,44.0,43.0,42.0,41.0,40.0,39.0,3
8.0,37.0,36.0,35.0,34.0,33.0,32.0,31.0,30.0,29.0,28.0,27.0,2
6.0,25.0,24.0,23.0,22.0,21.0,20.0,19.0,18.0,17.0}
AllPortsIncALL ALL
{1-3}-{1-13}-{1-2}-{1-2}
{1-3}-{1-13}-{1-4}
{1-3}-{1-13}-{2-4}-F-{1-4}
{A-H}-1-1
AllSlots 1-C
{1-3}-{1-13}
{1-3}-{1-13}-{2-4}-F
{A-H}-1
AllSlotsAndChannels ALL
{A-H}-1
{A-H}-1-ALL
{A-H}-1-{60.0,59.0,58.0,57.0,56.0,55.0,54.0,53.0,52.0,51.0,5
0.0,49.0,48.0,47.0,46.0,45.0,44.0,43.0,42.0,41.0,40.0,39.0,3
8.0,37.0,36.0,35.0,34.0,33.0,32.0,31.0,30.0,29.0,28.0,27.0,2
6.0,25.0,24.0,23.0,22.0,21.0,20.0,19.0,18.0,17.0}
{1-3}-{1-13}
{1-3}-{1-13}-{1-2}-{1-2}
{1-3}-{1-13}-{1-4}
{1-3}-{1-13}-{2-4}-F
{1-3}-{1-13}-{2-4}-F-{1-4}
AllSlotsAndTransponders {1-3}-{1-13}
{1-3}-{1-13}-2-F-{1}
{1-3}-{1-13}-{1-2}
{1-3}-{1-13}-{2-4}-F
AllSlotsIncALL 1-C
ALL
{1-3}-{1-13}
{1-3}-{1-13}-{2-4}-F
{A-H} -1
AllTransponders {1-3}-{1-13}-{1-2}
{1-3}-{1-13}-{1-2}-2-F-{1-2}
AllTranspondersIncALL ALL
{1-3}-{1-13}-{1-2}
{1-3}-{1-13}-{1-2}-2-F-{1-2}
Comm 1-C
AllChannels
Pattern Description
{A-H}-1-ALL All optical wavelength channels on an
external shelf.
AllChannelsIncAll
Pattern Description
ALL All optical wavelength channels
AllMuxponders
Pattern Description
{1-3}-{1-13}-{1} Localmuxponder
AllNetworkPorts
This represents all local and remote network ports. Network ports can be 2 or 3
depending on the optical card/module.
Pattern Description
{1-3}-{1-13}-{1-2}-2 Local transponder network port
AllPorts
This represents all local and remote ports (client and network side.).
Pattern Description
{1-3}-{1-13}-{1-2}-{1-2} Transponder-based Ports
AllPortsAndChannels
Pattern Description
ALL All ports
Pattern Description
{A-H}-1-ALL All optical wavelength channels on an
external shelf.
AllPortsIncALL
This represents all local and remote ports, along with the ALL aid which
encompasses all local and remote ports..
Pattern Description
ALL All ports
AllSlots
This represents all local and remote slots (including the COM-200)..
Pattern Description
1-C COM-200 Module
AllSlotsAndChannels
Represents all optical wavelength channels and slots that have optical wavelength
channels..
Pattern Description
ALL All optical wavelength channels
AllSlotsAndPorts
Pattern Description
1-C Communications Module
AllSlotsAndTransponders
This represents all the traffic entities within the system: i.e. cards and/or
transponders..
Pattern Description
{1-3}-{1-13} ) Shelf-Slot (for local modules
AllSlotsIncALL
This represents all local and remote slots (including the COM-200), along with the
ALL aid which encompasses all local and remote slots (including the COM-200).
Pattern Description
1-C COM-200 Module
AllSlots
This represents all local and remote slots (including the COM-200)..
Pattern Description
1-C COMM Module
Pattern Description
{1-3}-{1-13}-{2-4}-F Shelf-Slot-NetworkPort-F (for remote
modules)
AllSlotsAnd Channels
Represents all optical wavelength channels and slots that have optical wavelength
channels...
Pattern Description
ALL All optical wavelength channels.
AllSlotsAndPorts
Pattern Description
1-C Comm Module
Pattern Description
{1-3}-{1-13}-{2-4}-F-{1-4} All Remote Ports
AllSlotsAndTransponder
Represents all the traffic entities within the system; i.e. cards and/or
transponders...
Pattern Description
{1-3}-{1-13} Shelf-Slot (for local modules)
AllTransponders
This corresponds to the transponder entity within a card which encompasses the
behavior and provisioning details related to an O-E_O data path between two
ports..
Pattern Description
{1-3}-{1-13}-{1-2} Transponder datapath.
AllTranspondersIncAll
Pattern Description
ALL All transponders.
COMM
Pattern Description
1-C COM-200 Module
The state of a card affects the module's ability to execute TL1 commands. The
characteristics of the possible states for a module are described in this section.
The LightAmp and BrightAmp modules do not support state configurations.
The primary state (PST) parameter indicates the current service condition of the
module.
For a list of primary states, see PrimaryState on page 2-43.
PSTQ In-service
When a module is in-service, the PSTQ indicates whether the module is totally, or
only partially in-service. WaveReady modules support only one in-service state:
PSTQ Out-of-service
When a module is out-of-service, the PSTQ indicates if the module is OOS as the
result of a management command, or as the result of some condition within the
module itself, for example the result of an event that occurred. Communication
modules equipment supports AU, MA, and AUMA qualifiers for the OOS state:
• AU (Autonomous)
• MA (Management)
• AUMA (Autonomous and Management)
The secondary state (SST) parameter carries additional information related to the
PST and PSTQ states. For example, the SST can indicate the type of, and/or reason,
for the external command or the event that occurred in the module.
For a list of reported secondary states, see Secondary State on page 2-48
NOTE: Multiple SST values can apply to a single module at any given moment.
The following table lists the states and error codes that can affect TL1 commands if
the target module or port is unavailable.
Table 2-1:State Restrictions and Error Codes
All TL1 commands supported except: The module named UEQ ENEQ (Equipage,
RTRV-EQPT, RTRV-ALM-EQPT, in the AID Not Equipped)
RTRV-COND-EQPT, and all commands
only applicable to a COM-200.
RMV-EQPT or ED-EQPT OOS-MA OOS-AUMA Deny with SAMS Deny with SAMS
with <pst> OOS ("Clear" messages error code error code
are sent for all
active alarms on
the equipment
unit)
RST-EQPT or ED-EQPT Deny with SAIS Deny with SUFA IS-NR Deny with SUFA
with <pst> IS error code (Status, Unit (Status, Unit
Failed) Failed)
When the software Activate SWDL Activate SWDL Activate SWDL Activate SWDL
download process starts
When software download Deactivate SWDL Deactivate SWDL Deactivate SWDL Deactivate SWDL
is finished
Amplifier Mode
Values Description
BOOSTER In this mode, the amplifier provides a
constant output power for varying input
powers.
AmpOperatingMode
AmpOperatingMode
Values Description
CONSTANTGAIN Amplifier is operating in constant signal
gain mode
BackupCardStatus
Used to indicate the status of cards when the backup command is completed.
Values Description
Card_Type_Not_Supported Module is not backup supported.
BackUpGlobalStatus
Used to indicate the global status of a backup command when it has completed.
Values Description
FAILED One or more cards in the NE are not OK. A
backup file is created only if at least one
card is OK.
BackUpState
Values Description
BACKING_UP Backup in progress
BankSpecifier
Values Description
BANK A Software Load Bank A
CardType
Values Description
COM-200 COM-200 card type
Values Description
WRS051 WRS-ROADM unit type
CondEff
Values Description
CL Cleared
SC Standing Condition
TC Transient Condition
ControllerMode
Values Description
EXTERNAL_CONTROL No Comment Defined.
Dirn
Values Description
NA Not applicable
RCV
TRMT
EffectOfDataPathDown
This type describes whether or not the Inband supervisory management channel
will go autonomously out of service when the supporting port changes to OOS
state.
Values Description
NONE The Inband supervisory management
channel will not change to OOS when the
supporting port changes to OOS.
EnabledDisabled
Values Description
DISABLED Disabled parameter value
FtpMode
Values Description
ACTIVE No Comment Defined
LocationType
Values Description
FEND Far-end: The condition, alarm or event
occurred at the far end of the system.
LogName
Values Description
EVTLOG The event log contains a history of alarms,
notifications, and state changes.
LPBKTYPEENUM
Loopback type.
Values Description
FACILITY The facility loopback is meant to test the
optics, i.e. fiber and SFP.
MonitorType
Monitored Type
Values Description
AISS Count of number of seconds containing
one or more Alarm Indication Signal (AIS)
defects.
Values Description
ETHERSTATSBROADCASTPKTS The number of multicast packets,
excluding broadcast packets,
Values Description
ETHERSTATS TOTALERRPKTS Total Errored Packet Count. Count of
number of received errored packets
including:
• FCS errored packet (FCSERRC counter)
• length Out-of-Range packet received
• undersized (<=63 bytes) packet
• oversized packet
• framing error received
• interpacket junk (symbols received
between packets that are not Idle)
• packet fragments (packets <= 63 with
valid FCS and well formed)
• jabber packets (packets >MaxSize with
valid FCS)
Values Description
UTILIZATION Indicates the bandwidth utilization
during the reporting interval as a
percentage (0 to 100).
NotificationCode
Values Description
CL Cleared
CR Critical
MJ Major
MN Minor
NA Not Alarmed
NR Not Reported
OnClientLOS
Specifies what action should be taken on the network side laser when an LOS is
detected on the client side.
Values Description
OFF Turn the network laser off when an LOS is
detected on the client side
OnOff
Values Description
OFF OFF
ON ON
PhysicalEthernetDuplex
Values Description
FULLDUPLEX Full duplex
PhysicalEthernetSpeed
Values Description
MBIT10 10 Mbit per second
PMValidity
Indicates whether the information for the specified time period was accumulated
over the entire time period or some portion of the time period.
Values Description
ADJ Data has been manually adjusted or
initialized.
Values Description
LONG Data accumulated over greater than the
indicated time period.
PrimaryState
Values Description
IS In-service
OOS Out-of-service
Procedure Type
Values Description
AUTO-CHANNEL-TURNUP A procedure to bring into service,
wavelength channels which are currently
out of service and have an optical signal
on the provisioned from-port.
ResetReason
Values Description
POWER_ON The system was reset due to a power-up
condition.
RestartModeType
Values Description
COLD Cold restart of the entity. This restart is
service affecting.
RestoreCardStatus
Used for indicating the status of cards when the restore command has completed
Values Description
BACKED_UP_NETWORK_ No comment defined
WAVELENGTH_NOT_ SUPPORTED
RestoreGlobalStatus
Used to indicate the global status of a restore command when it has completed.
Values Description
CONTROLLER_SOFTWARE_ The controller does not run the same
LOAD_MISMATCH software version as the one stored in the
backup file.
RxDtOptimizationMode
Values Description
AUTO Automatic RxDT mode
SCCM_COMEQPT
Second command code modifier used for COM and EQPT specific commands.
Values Description
COM COM modifier
SCCM_OCH_OSC_OCHC
Second command code modifier used for OCH and OSC specific commands.
Values Description
OCH OCH modifier
SCCM_PM
Values Description
ETHERNET Modifier for Ethernet
SCCM_PM_NOALL
Values Description
ETHERNET Modifier for Ethernet
SCCM_NOALL
Values Description
COM COM modifier
Secondary State
This is a key parameter which should be customized specifically for the NEtype.
Primary state of the entity. Multiple values may be specified. See GR-1093 for
more information on primary and secondary states.
Values Description
ACT Active
BLKD Blocked.
BUSY Busy
DCHL D-Channel
DGN Diagnostic
DISCD Disconnected
DSBLD Disabled
EX Exercise
Values Description
FLT Fault
FRCD Forced
IDLE Idle
LPBK Loopback
MON Monitor
MT Maintenance
NBK No Backup
OVFL Overflow
PPS Pre/Post-service
PRTCL Protocol
PWR Power
RDLD Redlined
SB Suspend Both
Values Description
SGEO Supporting entity outage
SO Suspend Origination
ST Suspend Termination
STBYC Standby-cold
STBYH Standby-hot
TRMB Terminated-Both
TRMF Terminated-From
TRMT Terminated-To
TS Test
UAS Unassigned
UEQ Unequipped
WRK Working
SecurityEvents
Service Effect
Values Description
NSA Non-Service Affecting condition
Switch Command
Values Description
FRCDTOP No Comment Defined
SwitchConfig
Values Description
BLOCKED No Comment Defined
SwitchMode
Values Description
FIXED Fixed-threshold switching
SwitchType
Values Description
FRCD The working interface has been forced to the protection interface, or
the protecting interface has been switched to the working interface.
ThresholdType
Values Description
MAXCTMP Maximum case temperature. Integer value in degrees C.
Range = 20 to 70
Values Description
OTUKSD BER threshold to raise an OTUk Signal Degrade Alarm
TimePeriod
Values Description
1-DAY One day
15-MIN 15 minutes
UNTIMED Untimed
TraceLevel
Values Description
TTI_OTN_SM
TraceMode
Values Description
MANUAL Manual
OFF Off
TrafficMode
Values Description
2RREGENERATOR In 2R regenerator mode the transponder performs 2R on
uni-directionally traffic from the receive to the transmit side
of the network port. 2R regeneration stands for reshaping
and retransmission of the signal, and 3R adds retiming of the
signal
REGENERATOR_AIS In this mode, all ports are looped back, and traffic is
translated from the Rx to the Tx port on each port
independently. AIS is enabled on the network ports.
Automatic rate locking is supported on each regenerator
port independently of all others. However, note that in this
mode, manual locking rate is still set for port pairs (client and
network), NOT for each port individually.
Values Description
TRANSPONDER_AIS In this mode, client traffic is translated between the client
and network interface pairs bi-directionally. AIS (Alarm
Indication Signal) is enabled on the network port.
UpGradeStatus
Values Description
BUSY Indicated the upgrade procedure is busy.
UserAccessPrivileges
For more information about User Access Privileges, see User Access Privilege on
page 2-4.
XferType
Transfer type
Values Description
BANKCOPY No Comment Defined
YesNo
Values Description
N No
Y Yes
YesNoWord
Yes and No word used for enabling or disabling some TL1 parameters.
Values Description
NO No
YES Yes
CANC on page 3-2 N/A The COM-200 sends this message to the user
when the session times out as a result of
inactivity.
REPT ALM SECU on page 3-9 S5 This message is generated by the COM-200
module to an administrator, indicating the
occurrence of an alarmed event related to
NE security.
ACT-USER on page 4-1 N/A Log-in and initiate a TL1 session with an
NE/NS.
SET-SID on page 4-20 M4 Setting the system ID (SID) changes the TID
of the target module.
RTRV-LNKS on page 5-26 P1 Use this command to report the local TL1
routing information stored in the selected
COM-200.
Backup, Upgrade, File and Log Commands. See Backup and Restore Commands on page 7-1
RTRV-UPGRD-STAT on page 7-10 S1 Retrieves the software load tags for the
active (currently running) and inactive (boot)
banks for a module or the node.The
LightAmp and BrightAmp modules do not
support the use of the command.
PM4 INIT-REG-OTN
PM4 INIT-REG-OCN
PM4 INIT-REG-ETHERNET
PM1 RTRV-PM-ALL
PM1 RTRV-PM-ETHERNET
PM1 RTRV-PM-OCN
PM1 RTRV-PM-OTN
PM1 RTRV-PMMODE-ALL
PM1 RTRV-PMMODE-ETHERNET
PM1 RTRV-PMMODE-OCN
PM1 RTRV-PMMODE-OTN
SET-PMMODE on page 8-7 PM4 Set Performance Mode. Set the performance
mode for the target of the specified
secondary command.
PM4 SET-PMMODE-OTN
PM4 SET-PMMODE-OCN
PM4 SET-PMMODE-ETHERNET
Alarm and Event commands See Alarm and Event Commands on page 10-1
OPR-ACO-ALL on page 10-4 N/A Instructs the target module to turn off the
audible alarm. This command has no effect
on future alarms; it only effects the active
alarms. Disabling the audible alarm does not
clear the alarm. There is no "release" ACO
command.
REPT ALM <SCCMNOALL> on page 10-5 N/A Modules generate this message to report
the occurrence of an alarmed event
(notification code CR, MJ or MN) when the
message is not inhibited. When the
condition ceases to exist, the module
generates a corresponding automatic "clear"
(CL) message.
REPT EVT <SCCMNOALL> on page 10-6 N/A Report Event. The module generates this
autonomous message to report
non-alarmed events.
REPT EVT SESSION on page 10-8 S1 The COM-200 generates this autonomous
message when a TL1 session is initiated.
SET-DESC-<SCCM_COMEQPT> on page 10-48 P4 Set Description. Set the description for the
given condition types for the target
specified by the secondary command.
REPT ALM <SCCMNOALL> on page 11-2 N/A The module generates these autonomous
messages to report the occurrence and
clearing of alarmed events.
REPT EVT <SCCMNOALL> on page 11-2 N/A The module generates this autonomous
message to report non-alarmed events.
REPT EVT SESSION on page 11-3 N/A The COM-200 generates this autonomous
message when a TL1 session is initiated.
ALW-USER-SECU
Description
This command requires a Security and Administration Level 5 User Access Privilege.
Input Format
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
aid
Must be ‘1-C’. Only the Communications module supports disabling and reinstating
of uids on an ‘all or nothing’ basis. Uids cannot be disabled on a per-module basis.
aid is the AID COMM on page 2-29.
ctag
Correlation tag
uid
The id of the user whose login session is to be re-instated.
uid is a string.
Input Example
ALW-USER-SECU:Node198:1-C:100::smith99;
CANC
This automonous message does not require a User Access Privilege Level.
Description
The COM-200 sends this message to the user when the session times out as a result
of inactivity. Time-out is specified by the SESSIONTMOUT parameter.
Output Format
Output Parameters
uid
UID uid is a string.
Output Example
DLT-USER-SECU
This command requires a Security and Administration Level 5 User Access
Privilege.
Description
Input Format
DLT-USER-SECU:[TID]:<uid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed. See System Identifier Format <SID> or Target Iden-
tifier Format <TID> on page 2-15
uid
The id of the user whose account is to be closed.
uid is a string
ctag
Correlation tag
Input Example
DLT-USER-SECU:Node198:smith99:100;
ED-PID
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
Allow a user to change their own password. Other user identification and access
changes may only be made by privileged/super-users.
Input Format
ED-PID:[TID]:<uid>:CTAG::<oldpid>,<newpid>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
uid
The user’s own identifier.
uid is a string.
ctag
Correlation tag
oldpid
The existing password.
oldpid is a string.
newpid
Password identifiers are between 6 and 10 characters in length, and are composed of
a combination of Roman (also known as Latin or English) alphanumeric (letters A
through Z; numbers 0 through 9) and special characters.
• period (.)
• number sign (#)
• percentage sign (%)
• plus sign (+)
• underscore (_)
• hyphen (-)
The password must start with an Roman alphanumeric character, and contain at
least one Roman alphabetic character, one Roman numeric, and one special char-
acter. The following characters are not supported for the password:
• semicolon (;)
• colon (:)
• ampersand (&)
• comma (,)
• question mark (?)
• all control characters
newpid is a string.
Input Example
ED-PID:Node198:smith99:100::oldP%8wrd,newP%9wrd;
ED-USER-SECU
This command requires a Security and Administration Level 5 User Access
Privilege.
Description
Input Format
ED-USER-SECU:[TID]:<uid>:CTAG::[<newuid>],[<newpid>],,[<uap>
]:[PAGE=<page>], [PCNN=<pcnn>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
uid
The current uid of the user whose security parameters are to be changed.
uid is a string.
ctag
Correlation tag
newuid
The new uid to replace the old uid. UIDs must be 6 to 10 characters in length.
newuid is a string.
newpid
The new password to replace the old one. PIDs must be 6 to 10 characters in length
and contain at least one Roman alphabetic, one Roman numeric, and one special
character.
newpid is a string.
uap
The new access privileges of the user.
uap is a string and is listable.
page
Password aging interval in days. Any integer between 1 and 999, inclusive. A value
of 999 means that the password will never expire.
page is a integer.
pcnn
The number of times (log-ins) that an existing password can continue to be used
before a new password becomes mandatory. Any integer between 1 and 999, inclu-
sive.
pcnn is a integer.
Input Example
ED-USER-SECU:Node198:smith99:100::newP%9wrd,,4:PAGE=90,PCNN=
90;
ENT-USER-SECU
This command requires a Security and Administration Level 5 User Access
Privilege.
Description
Use this administrator-level command to create a new user account and assign the
user access privileges (UAPs).
Input Format
ENT-USER-SECU:[TID]:<uid>:CTAG::<newpid>,,<uap>:[PAGE=<page>
],[PCNN=<pcnn>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
uid
The uid to be assigned to the new user. uid is a string.
ctag
Correlation tag
newpid
The new password to replace the old one.
Password identifiers are between 6 and 10 characters in length, and are composed of
a combination of Roman alphanumeric (letters A through Z; numbers 0 through 9)
and special characters.
• period (.)
• semicolon (;)
• colon (:)
• ampersand (&)
• comma (,)
• question mark (?)
• all control characters
newpid is a string.
uap
The new access privileges of the user. Refer to GR-835-CORE Appendix B.2.1 uap
is a string and is listable.
page
Password aging interval in days. Any integer between 1 and 999, inclusive. The
factory default is 60 days. page is a integer.
pcnn
The number of times (log-ins) that an existing password can continue to be used
before a new password becomes mandatory. Any integer between 1 and 999, inclu-
sive. pcnn is a integer.
Input Example
ENT-USER-SECU:Node198:smith99:100::newP%6wrd,,4:PAGE=90,PCNN
=90;
INH-USER-SECU
This command requires a Security and Administration Level 5 User Access
Privilege.
Description
Input Format
INH-USER-SECU:[TID]:<aid>:CTAG::<uid>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
aid
Must be ‘1-C’. Only Communications module supports disabling and reinstating of
uids on an ‘all or nothing’ basis. Uids cannot be disabled on a per-module basis.
aid is the AID COMM on page 2-29.
ctag
Correlation tag
uid
The id of the user whose login session is to be disabled.
uid is a string.
Input Example
INH-USER-SECU:Node198:1-C:100::smith99;
Description
Output Format
Output Parameters
aid
If = T-UIDAGE, then this is the user id that is to be disabled.
If = LOGBUFR90-SECULOG or LOGBUFROVFL – SECULOG, then this is the
name of the security log.
aid is a string.
ntfcncde
The notification code associated with the event.
ntfcncde is of type NotificationCode on page 2-41. [CL, CR, MJ, MN]
secualmtype
Depending on the type of alarm, can have any of the following values:
Output Example
RTRV-ALM-SECU
This command requires a Security and Administration Level 4 User Access
Privilege.
Description
Input Format
RTRV-ALM-SECU:[TID]:<aid>:CTAG;
Input Parameters
aid
Must be ‘1-C’. Only the Communications module generates security-related alarms.
aid is the AID COMM on page 2-29.
Input Example
RTRV-ALM-SECU:Node198:1-C:100;
Output Format
M CTAG COMPLD
"<aid>:<name>,[<desc>]:[<code>],[<type>],,[<msg>]"
;
Output Parameters
aid
aid is a string.
name
Name by which the alarm is recognized. name is a string.
desc
Optional description of the alarm. Maximum 64 characters, enclosed within escaped
quotes. desc is a string.
desc is optional.
code
Notification code associated with the alarm. code is of type NotificationCode on
page 2-41. code is optional. [CR, MJ, MN]
type
The only allowable type of notification is "message". type is a string. type is optional.
msg
Text of the alarm message. Maximum 64 characters, enclosed within escaped quotes.
msg is a string.
msg is optional.
Output Example
RTRV-USER-SECU
This command requires a Security and Administration Level 4 User Access
Privilege.
Description
Input Format
RTRV-USER-SECU:[TID]:[<uid>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
uid
The id of the user whose security parameters are being retrieved. A null value or ‘All’
for <uid> may be used to indicate all existing users on the NE.
ctag
Correlation tag.
Input Example
RTRV-USER-SECU:Node198:smith99:100;
Output Format
Output Parameters
uid
The user id.
uid is a string.
uap
The user access privileges corresponding to the user specified by the <uid>. uap is
a string.
page
Password aging interval in days.
page is a integer.
pcnn
The number of days that an existing password can continue to be used before a new
password becomes mandatory.
pcnn is a integer.
Output Example
RTRV-HLP-AID
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
This is a Help Command. Retrieve information listing the AID pattern supported
for the given command (VMM).
Input Format
RTRV-HLP-AID:[TID]:[<vmm>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
vmm
Command (or Verb-Modifier-Modifier) for which the supported AID patterns are
returned. If not specified, all commands and AID patterns are returned.
vmm is a string.
Input Example
RTRV-HLP-AID:Node198:ED-EQPT:35;
Output Format
Output Parameters
vmm
The command or verb-modifier-modifier.
vmm is a string.
aidpattern
AID pattern associated with the command. aidpattern is a string.
aidpattern is optional.
level
LEVEL
level is a string.
Output Example
RTRV-HLP-CMD
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
Input Format
RTRV-HLP-CMD:[TID]:[<vmm>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
vmm
Command or verb-modifier-modifier. If the command is not specified, all
commands are returned.
vmm is a string.
Input Example
RTRV-HLP-CMD:Node198:ED-XPDR:100;
Output Format
Output Parameters
cmdpattern
The command syntax for the specified command.
cmdpattern is a string.
RTRV-HLP-ENUM
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
Input Format
RTRV-HLP-ENUM:[TID]:[<enum>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
enum
Enumerator name or parameter type. If an enumerator name is specified, a list of the
valid values is returned. If the enumerator is not specified, a list of all enumerator
names is returned.
enum is a string.
Input Example
RTRV-HLP-ENUM:Node198:trafficmode:100;
Output Format
Output Parameters
enumNameOrValue
Enumerator name or value.
enumNameOrValue is a string.
Output Example
ACT-USER
Use the ACT-USER command to request a login session with the target COMM200.
A valid user identifier (UID) and password identifier (PID) is required to use this
command.
Description
For security reasons, TL1 displays an asterisk (*) for each password character typed.
Input Format
ACT-USER:[TID]:<userid>:CTAG::<pid>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
userid
The identifier of the user requesting the login.
userid is a string.
ctag
Correlation tag
pid
The user’s password.
pid is a string.
Input Example
ACT-USER:Node198:smith99:100::Pa%9wrd;
Output Format
"<uid>:<date_time>,<num_login_attempts>"
;
Output Parameters
uid
The identifier of the user logging in.
uid is a string.
date_time
Refers to the date and time of the user’s last successful login. The format is
yyyy-mm-dd hh-mm-ss.
date_time is a string.
num_login_attempts
The number of unsuccessful login attempts recorded since the last successful login.
num_login_attempts is a integer.
Output Example
CANC-USER
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
Use this command to terminate an active TL1 user session with the target module.
The UID of the active session is required in order to log-out.
A session can only be terminated from the account that initiated the session.
Input Format
CANC-USER:[TID]:<uid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
uid
The user's identifier for the session to be cancelled.
uid is a string.
ctag
Correlation tag.
Input Example
CANC-USER:Node198:smith99:100;
CANC-USER-SECU
This command requires a Security and Administration Level 5 User Access
Privilege.
Description
Input Format
CANC-USER-SECU:[TID]:<uid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
uid
The id of the user whose login session is to be terminated.
uid is a string.
ctag
Correlation tag
Input Example
CANC-USER-SECU:Node198:smith99:100;
ED-DAT
This command requires a Provisioning Level 3 User Access Privilege.
Description
Use this command to change the date and time stored in the COM-200. Other
modules automatically update their date and time from the associated COM-200.
Events in logs are time stamped with this date and time. The input command
requires the user to enter either the date or the time, or both.
Values for hours, minutes, seconds, days, months and years must be expressed as
two-digit numbers.
Input Format
ED-DAT:[TID]::CTAG::[<date>],[<time>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
date
The current date (year, month, day) yy-mm-dd where: 70-99 = 1970-1999 or00-69
= 2000-2069mm:01-12dd:01-31
date is a date.
time
Change time to this value. hh-mm-ss, where: hh: 00-23 mm: 00-59 ss: 00-59
time is a time.
Input Example
ED-DAT:Node1988::100::10-02-03,21:04:42;
ED-NTP
This command requires a Provisioning Level 3 User Access Privilege.
Description
Use this command to configure the status of the NTP service on the COMM200.
The default is off. When enabled the NTP client queries the provisioned NTP
server at 10 minute intervals to update the system time. Queries are done to the
NTP server(s) every 10 minutes. The NTPFAIL alarm is raised if after 100 queries,
no valid response has been received. This service is enabled at the system level.
NOTE: When the NTP service is enabled, the system time may be drastically different from the
time discovered on the servers. In this situation, various time-outs, such as the TL1 user
session in-activity time, may be affected. To limit time-out side effects, use the ED-DAT
command to set the system time closer to the NTP server time before enabling the NTP client.
Input Format
ED-NTP:[TID]::CTAG:::[STATUS=<status>],[NTPSERVER1=<ntpserve
r1>], [NTPSERVER2=<ntpserver2>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
status
Status of the NTP client. Used to determine if the NTP client is active. When the field
is "off" the NTP client does not synchronize with external sources. The factory
default value is "off".
When the NTP service is turned on, ED-DAT commands will be denied.
status is of type OnOff on page 2-42.
ntpserver1
The primary NTP server used for time synchronization. The factory default value is
0.0.0.0.
ntpserver1 is a string.
ntpserver2
The secondary NTP server used for time synchronization should the primary NTP
server be unavailable. If a value of 0.0.0.0 is specified, this address will not be used,
only the primary server is used. The factory default value is 0.0.0.0.
ntpserver2 is a string.
Input Example
ED-NTP:Node198::100:::STATUS=OFF,NTPSERVER1=10.75.23.1,
NTPSERVER2=10.24.194.17;
INIT-SYS
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
INIT-SYS:[TID]:<aid>:CTAG::RESTARTMODE=<restartmode>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
aid
Access identifier of the target module.
aid is the AID AllSlots on page 2-24.
ctag
Correlation tag
restartmode
RESTARTMODE
restartmode is of type RestartModeType on page 2-45. Specified restart mode.
WARM
is not traffic affecting, COLD is traffic affecting
Input Example
INIT-SYS:Node198:1-C:100::RESTARTMODE=COLD;
RTRV-CONTROLLER-MODE
This command requires a Provisioning Level 1 User Access Privilege.
Description
This commands retrieves information about the operating mode of the controller.
The operating mode SHELF_ALARMING_ONLY allows fan fail alarms to be
reported by a remote Communications module. The Communications module
associated with the remote EOC of the assigned slot will receive and fan failure
notifications
Input Format
RTRV-CONTROLLER-MODE:[TID]:<src>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
aid
Access identifier of the target module.
aid is the AID AllSlots on page 2-24.
ctag
Correlation tag
Input Example
RTRV-CONTROLLER-MODE:Node198:1-4:99;
Output Format
Output Parameters
mode
Operating mode of the Communications module.
mode is of type ControllerMode on page 2-35. mode is optional. Values are
NORMAL and SHELF_ALARMING_ONLY.
targetslot
The slot to which alarm notifications are targeted.
targetslot is the AID AllSlots on page 2-24. targetslot is optional.
Output Example
RTRV-HDR
This command requires a Maintenance Level 1 User Access Privilege.
Description
This command instructs the target module to reply with a normal response
indicating a successfully completed (COMPLD) command.
This command is used as a monitoring tool by the network management system.
Input Format
RTRV-HDR:[TID]::CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
Input Example
RTRV-HDR:Node198::100;
RTRV-NETYPE
This command requires a Maintenance Level 1 User Access Privilege.
Description
Input Format
RTRV-NETYPE:[TID]::CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
Input Example
RTRV-NETYPE:NODE198::100;
Output Format
Output Parameters
aid
Access identifier that identifies the Communications module (1-C).
aid is a string.
clei
Common Language Equipment Id of the shelf. 10-digit alpha-numeric.
clei is a string.
mac
Mac address of the shelf. Format is xx.xx.xx.xx.xx.xx.
mac is a string.
ipaddr
IP address for a management interface. This consists of four bytes converted into
decimal numbers. Each number is separated by a decimal point (".") and has an
integer value between 0 and 255 (inclusive).
ipaddr is a string.
gtwyaddr
The Gateway Internet Protocol (IP) Address. Only applicable to a Communications
module.This consists of four bytes converted into decimal numbers. Each number is
separated by a decimal point (".") and has an integer value between 0 and 255 (inclu-
sive).
gtwyaddr is a string.
subnetmask
The Subnet Internet Protocol (IP) Address Mask. Only applicable to a Communica-
tions module.This consists of four bytes converted into decimal numbers. Each
number is separated by a decimal point ("."). The first threes numbers have an
integer value between 0 and 255 (inclusive), and the last number must be smaller
than 255.
subnetmask is a string.
hwrev
Shelf hardware revision number. 3-digit integer.
hwrev is a string.
mktpn
Marketing part number. 20 character alpha-numeric.
mktpn is a string.
eepromVer
Backplane eeprom version number. 3-digit integer.
eepromVer is a integer.
backplaneSn
Serial Number of the shelf. 35-digit alphanumeric. Note: The backplane serial
number matches the shelf serial number.
backplaneSn is a string.
shelftype
Type of mounting solution. Valid values are:
• 3100AC,
• 3100DC,
• 3500F, and
• 3500F-HP
shelftype is a string.
ip6addr
IP6ADDR ip6addr is a string.
ip6pfix
IP6PFIX ip6pfix is a integer.
ip6gtwyaddr
IP6GTWYADDR ip6gtwyaddr is a string
Output Example
RTRV-NTP
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve configuration data associated with the NTP service.
When enabled, the service polls the configured NTP server at 10 minute intervals
for system time updates.
Input Format
RTRV-NTP:[TID]::CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
Input Example
RTRV-NTP:Node198::99;
Output Format
Output Parameters
aid
Set to 1-C.
aid is a string.
status
Status of the NTP client. Used to determine if the NTP client is active. When the field
is "off" the NTP client does not synchronize with external sources.
status is of type OnOff on page 2-42.
ntpserver1
The primary NTP server used for time synchronization.
ntpserver1 is a string. Default is 0.0.0.0
ntpserver2
The secondary NTP server used for time synchronization should the primary NTP
server be unavailable.
ntpserver2 is a string. Default is 0.0.0.0
Output Example
RTRV-STATS-SESSION
This command requires a Security and Administration Level 4 User Access
Privilege.
Description
Input Format
RTRV-STATS-SESSION:[TID]::CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
Input Example
RTRV-STATS-SESSION:Node198::85;
Output Format
Output Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
maxallowtelnet
Maximum number of Telnet sessions allowed. This includes ports 23 and 3083.
maxallowtelnet is a integer.
maxallowraw
Maximum number of RAW TL1 sessions allowed (i.e. port 3082).
maxallowraw is a integer.
usedtelnet
Number of Telnet sessions used.
usedtelnet is a integer.
usedraw
Number of RAW TL1 sessions used.
usedraw is a integer.
availtelnet
Number of available Telnet sessions.
availtelnet is a integer.
availraw
Number of available RAW TL1 sessions.
availraw is a integer.
Output Example
RTRV-STATUS
This command requires a Maintenance Level 1 User Access Privilege.
Description
Use this command to retrieve the number of user accounts logged into the NE/NS,
as well as the accounts that are temporarily disabled at the time of the command.
This command is available to any user.
Input Format
RTRV-STATUS:[TID]::CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
Input Example
RTRV-STATUS:Node198::86;
Output Format
Output Parameters
ctag
Correlation tag
ocrdat
The current date. The format is MOY-DOM. MOY stands for month of year and has
a range of 1 to 12. DOM stands for day of month and has a range of 1 to 31.
ocrdat is a date.
ocrtm
The current time. The format for is HOD-MOH-SOM. HOD stands for hour of day
and has a range of 0 to 23. MOH stands for minute of hour and has a range of 0 to
59. SOM stands for second of minute and has a range of 0 to 59.
ocrtm is a time.
uids
A list of user ids that are currently logged onto the NE, delimited by ‘&’. If a user is
logged into more that one session, multiple entries will appear in the list.
uids is a string and is listable.
inhibiteduids
The user ids that are currently inhibited., delimited by ‘&’.
inhibiteduids is a string and is listable.
Output Example
SET-CONTROLLER-MODE
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
SET-CONTROLLER-MODE:[TID]:<src>:CTAG::[MODE=<mode>],
[TARGETSLOT=<targetslot>];
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
src
AID src is the AID COMM on page 2-29.
mode
Communications module operating mode.
mode is of type ControllerMode on page 2-35.
targetslot
The slot to which alarm notifications are targeted. For proper operation, this slot
should contain a module that supports remote fan fail reporting, with operational
EOC. targetslot is the AID AllSlots on page 2-24.
Input Example
SET-CONTROLLER-MODE:Node198:1-C:87::MODE=NORMAL,
TARGETSLOT=1-C;
SET-SID
This command requires a Maintenance Level 4 User Access Privilege.
Description
The system identifier (SID) or target identifier (TID) is between 1-20 characters in
length and is composed of a combination of alpha numerics (ASCII letters or
digits) and underscores (_) or dashes (-). The SID must begin with a letter, and if a
dash (-) is included, the dash must be followed by a letter. A SID as a Network
Element identifier must be unique within a network. Therefore, to ensure its
uniqueness, the SID default value is based on shelf serial number.
NOTE: If a TID changes, it is not activated until the COM-200 is rebooted.
Input Format
SET-SID:[TID]::CTAG::<sid>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
sid
New target identifier of the target COM-200. The string parameter has a maximum
length of 20 characters.
sid is a string.
Input Example
SET-SID:Node198::CTAG::Acme_Company_NE;
ED-EQPT
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to set operating parameters for, or change the state of, the target
module. Parameter changes are limited to three (3) changes per command.
The operating parameters and the state of the module can not be changed in the
same command. It is necessary to use two commands to set operating parameters
and then change the state.
Input Format
ED-EQPT:[TID]:<aid>:CTAG:::[ID=<id>],[IPADDR=<ipaddr>],
[SUBNETMASK=<subnetmask>],[GTWYADDR=<gtwyaddr>],
[SWITCHPORT1CONF=<switchport1conf>],
[SWITCHPORT2CONF=<switchport2conf>],
[SWITCHPORT3CONF=<switchport3conf>],
[PHYETHAUTOSENSING=<phyethautosensing>],
[PHYETHSPEED=<phyethspeed>],[PHYETHDUPLEX=<phyethduplex>],
[SESSIONTMOUT=<sessiontmout>],[PASSWDRENTY=<passwrdrenty>],
[SNMP=<snmp>],[SNMPTRAPS=<snmptraps>],
[SNMPTRAPDEST1=<snmptrapdest1>],
[SNMPTRAPDEST2=<snmptrapdest2>],
[SNMPTRAPDEST3=<snmptrapdest3>],
[SNMPTRAPDEST4=<snmptrapdest4>],
[READCOMMUNITY=<readcommunity>],
[WRITECOMMUNITY=<writecommunity>],[DHCP=<dhcp>],[APS=<aps>],
[SWMODE=<swmode>],[RVRTV=<rvrtv>],[ASLTH=<aslth>],
[UWSR=<uwsr>],[LWSR=<lwsr>],[SRPL=<srpl>],
[SENSEPRIOR=<senseprior>],
[MANUALDATALOCKRATE=<manualdatalockrate>],
[SENSEMONITOR=<sensemonitor>],[AMPOPRMODE=<ampoprmode>],
[TARGETGAIN=<targetgain>],[TARGETPOWER=<targetpower>],
[LOSSHUTDOWN=<losshutdown>],
[AUTORATELOCKING=<autoratelocking>],[IP6ADDR=<ip6addr>],
[IP6PFIX=<ip6pfix>],[IP6GTWYADDR=<ip6gtwyaddr>]:[PST=<pst>]
;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target module. Note: Null is not an acceptable value for the
<aid>.
aid is the AID AllSlots on page 2-24.
id
Module ID. This unique identifier consists of a string of up to 60 characters.
id is a string.
ipaddr
IP address for the Ethernet management interface. Only applicable to a Communi-
cations module. This consists of four bytes converted into decimal numbers. Each
number is separated by a decimal point (".") and has an integer value between 0 and
255 (inclusive). If successfully entered the changed value will only take effect after
the card reset. 0.0.0.0 is an invalid address. The factory default value is 10.0.0.2.
ipaddr is a string. The default value is "10.0.0.2".
gtwyaddr
The Gateway Internet Protocol (IP) Address. Only applicable to a Communications
module.This consists of four bytes converted into decimal numbers. Each number is
separated by a decimal point (".") and has an integer value between 0 and 255 (inclu-
sive). If successfully entered the changed value will only take effect after the card
reset. 0.0.0.0 is a invalid address. The factory default value is 0.0.0.0.
gtwyaddr is a string. The default value is "0.0.0.0".
subnetmask
The Subnet Internet Protocol (IP) Address Mask. Only applicable to a Communica-
tions module.This consists of four bytes converted into decimal numbers. Each
number is separated by a decimal point ("."). The first threes numbers have an
integer value between 0 and 255 (inclusive), and the last number must be smaller
than 255. If successfully entered the changed value will only take effect after the card
reset. The factory default value is 255.255.255.0.
subnetmask is a string. The default value is "255.255.255.0".
switchport1conf
SWITCHPORT1CONF
switchport1conf is of type SwitchConfig on page 2-51.
switchport2conf
SWITCHPORT2CONF
switchport2conf is of type SwitchConfig on page 2-51.
switchport3conf
SWITCHPORT3CONF
switchport3conf is of type SwitchConfig on page 2-51.
phyethautosensing
Specifies whether the Ethernet physical layer configuration (PHYETHSPEED and
PHYETHDUPLEX) is set through auto-negotiation or manually. The card needs to
be restarted for a change to take effect.
phyethautosensing is of type OnOff on page 2-42
phyethspeed
If PHYETHAUTOSENSING is turned on, this is the Ethernet physical layer speed.
The card needs to be restarted for a change to take effect.
phyethspeed is of type PhysicalEthernetDuplex on page 2-42.
phyethduplex
If PHYETHAUTOSENSING is turned on, this is the Ethernet physical layer duplex.
The card needs to be restarted for a change to take effect.
phyethduplex is of type PhysicalEthernetSpeed on page 2-42.
sessiontmout
The timeout interval, in minutes, after which an inactive user session will be auto-
matically terminated by the Communications module. Integer between 1 and 999.
Upon expiry, the Communications module sends a ^Canc automatic message to
notify the OS. The factory default value is 999 minutes.
sessiontmout is a integer. The default value is " 999".
passwdreentry
PASSWDREENTRY is introduced to the RTRV-EQPT and ED-EQPT command for
the COM-200 card. This parameter defines the first-time password re-entry behav-
iour for all TL1 users on the system. The value is either ENABLED or DISABLED.
passwdreentry is of type EnabledDisabled on page 2-36. The default value is
"Disabled".
snmp
Status of the SNMP agent. Used to determine if the SNMP agent should be activated.
When the field is "disabled" the SNMP agent does not generate traps or respond to
SNMP requests. The changed value takes effect after the module is reset. The factory
default is Disabled.
snmp is of type EnabledDisabled on page 2-36. The default value is "Disabled".
snmptraps
Status of SNMP traps. Used to permit or prevent the generation of traps by the agent.
The agent must be enabled in order for this option to be effective. A change to this
field is effective immediately. No reset of the COM-200 is required. The factory
default is Disabled.
snmptraps is of type EnabledDisabled on page 2-36. The default value is " Disabled".
snmptrapdest1
First destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest1 is a string.
snmptrapdest2
Second destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest2 is a string.
snmptrapdest3
Third destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest3 is a string.
snmptrapdest4
Fourth destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest4 is a string.
readcommunity
The SNMP read community string. A restart is required for changes for this field to
take effect.
readcommunity is a string.
writecommunity
The SNMP write community string. A restart is required for changes for this field to
take effect.
writecommunity is a string.
dhcp
The parameter is not supported. Status of the DHCP client on the COM-200. If
enabled, DHCP protocol will be used by the Communications module to automat-
ically configure IP addressing information. If disabled, static IP addressing will be
used.
dhcp is of type EnabledDisabled on page 2-36.
aps
Turns auto mode (i.e., Automatic Protection Switching) on or off.
aps is of type OnOff on page 2-42.
swmode
Sets auto mode behaviour to relative-threshold switching or fixed-threshold
switching (note: if unit is currently in manual mode, this does not change to auto
mode). The factory default value is FIXED.
swmode is of type SwitchMode on page 2-51. The default value is " FIXED".
rvrtv
Enable or disable automatic switchback feature. The factory default value is Y.
rvrtv is of type YesNo on page 2-56. The default value is "Y".
aslth
Absolute Switching Level Threshold (dBm). Integer in the range of 0 to –35.
aslth is a integer.
uwsr
Upper Window Switching Range (dB). Integer >= 6dB.
uwsr is a integer.
lwsr
Lower Window Switching Range (dB). Integer >= 6dB.
lwsr is a integer.
srpl
Set Reference Power Level. Saves the current input power on each optical path as the
reference power level for relative switching mode.
srpl is of type YesNo on page 2-56.
senseprior
SENSEPRIOR
senseprior is of type OnOff on page 2-42.
manualdatalockrate
MANUALDATALOCKRATE
manualdatalockrate is a string.
sensemonitor
SENSEMONITOR
sensemonitor is of type OnOff on page 2-42
ampoprmode
Amplifier Operating mode.
ampoprmode is of type AmpOperatingMode on page 2-32.
targetgain
For WRA-XXX cards. WRA-110: 7 to 13dB, WRA-113: 7 to 19dB, WRA-116: 7 to
26dB, WRA-119: 7 to 26dB, WRA-217: 13 to 23 dB. Float with one decimal preci-
sion.
targetgain is a string.
targetpower
For WRA-XXX cards. WRA-1XX: -10dB to MAX_OUTPUT_POWER, WRA-2XX:
-6dB to MAX_OUTPUT_POWER. Float with one decimal precision.
targetpower is a string.
losshutdown
For WRA-XXX cards. When enabled, the unit will turn off the pump laser when a
LOS condition is detected on the input port.
losshutdown is of type YesNoWord on page 2-56
autoratelocking
AUTORATELOCKING
autoratelocking is of type EnabledDisabled on page 2-36
ip6addr
IP6ADDR ip6addr is a string.
ip6pfix
IP6PFIX ip6pfix is a integer.
ip6gtwyaddr
IP6GTWYADDR ip6gtwyaddr is a string.
pst
Primary state. The value IS puts a module administratively up. Alternatively, the
same can be accomplished with the command RST-EQPT.Likewise, the value OOS
puts a module administratively down. Alternatively, the same can be accomplished
with the command RMV-EQPT. Primary state. An IS value puts a module into an
in-service (up) state.
NOTE: Issuing an RST-EQPT command has the same result.
An OOS value puts a module into an out-of-service (down) state. Take the ports for
a module out-of-service before taking the module out-of-service. A COM-200
module can not be taken out-of-service.
NOTE: Issuing an RMV-EQPT command has the same result.
pst is of type PrimaryState on page 2-43. [IS, OOS]
Input Example
ED-EQPT:Node198:1-C:100::<null>:ID=AcmeCompanyNE,
IPADDR=10.13.129.198,GTWYADDR=10.13.128.0,
SUBNETMASK=255.255.252.0,
;
OPR-PROC-EQPT
Description
Input Format
OPR-PROC-EQPT:[TID]:<src>:CTAG::PROCEDURE=<procedure>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
src
Access identifier of the target module. Note: Null is not an acceptable value for the
<aid>.
src is the AID AllSlots.
ctag
Correlation tag
procedure
The procedure to activate on the specified entity.
procedure is of type Procedure Type on page 2-43.
Input Example
OPR-PROC-EQPT:Node198:1-C:100::PROCEDURE=AUTO-CHANNEL-TURNUP
;
RMV-EQPT
This command requires a Provisioning Level 4 User Access Privilege.
Description
This command instructs the target module to change from the in-service (IS) state
to the out-of-service (OOS) state so that maintenance activities can be performed.
If a port is still in service, a "Command Invalid" response will be returned.
NOTE: The LightAmp and BrightAmp modules do not support state configuration.
Input Format
RMV-EQPT:[TID]:<aid>:CTAG::,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the NRP module for which the command is
intended. Only module-level AIDs are acceptable (i.e., not port-level AIDs).
aid is the AID AllSlots on page 2-24.
Input Example
RMV-EQPT:Node198:1-C:65::,;
RST-EQPT
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs an equipment unit (module) to change from its current out-of -service
(OOS) state to an in-service state.
This module must be in-service (see "RST-EQPT") before any of its ports can be
put in-service.
NOTE: The LightAmp and BrightAmp modules do not support state configuration.
Input Format
RST-EQPT:[TID]:<aid>:CTAG::,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the module(s) for which the command is intended.
Only module-level AIDs are acceptable (i.e., not port-level AIDs).
aid is the AID AllSlots on page 2-24.
Input Example
RST-EQPT:Node198:1-C:65::,;
RTRV-EQPT
This command requires a Provisioning Level 1 User Access Privilege.
Description
This command instructs the target module to return configuration and state
information.
Input Format
RTRV-EQPT:[TID]:[<aid>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target module. A null or "All" value can be used to indicate
all equipment units installed in the WaveReady™ series shelf.
aid is the AID AllSlotsIncALL on page 2-26.
Input Example
RTRV-EQPT:Node198:1-C:100;
Output Format
[TRAFFICMODE=<trafficmode>],[AMPLIFIERMODE=<amplifiermode>],
[SENSEMONITOR=<sensemonitor>],[MAXSAFEATTEN=<maxsafeatten>],
[UPTIME=<uptime>],[LASTRESETREASON=<lastresetreason>],
[AMPOPRMODE=<ampoprmode>],[TARGETGAIN=<targetgain>],
[TARGETPOWER=<targetpower>],[LOSSHUTDOWN=<losshutdown>],
[PUMPCURRENT=<pumpcurrent>],[VOAATTENUATION=<voaattenuation>
],[SIGNALGAIN=<signalgain>],[LASERSTATUS=<laserstatus>],
[AUTORATELOCKING=<autoratelocking>],[IP6ADDR=<ip6addr>],
[IP6PFIX=<ip6pfix>],[IP6GTWYADDR=<ip6gtwyaddr>]:
[<pstpstq>],[<sst>]" ;
Output Parameters
aid
aid is a string.
clei
Common language equipment identifier code of the module.
clei is a string. clei is optional.
moduletype
The type of a module. The valid values are:
• COMM200
• COMM100
• WRT740
• WRT760
• WRT780
• WRT781
• WRT840
• WRT842
• WRT852
• WRM-782
• WRS-051
• LIGHTAMP
• BRIGHTAMP
• LP530
• LP530SM
• WRA110
• WRA113
• WRA116
• WRA119
• WRA217
• WRA217L
• WRA219
• UNKNOWN
• WS500LX
• WS510SX
• WS540LX
• WS550SX
moduletype is a string. moduletype is optional.
id
The id of the Module.
id is a string. id is optional.
vendorname
Vendor Name
vendorname is a string. vendorname is optional.
marketingname
Marketing Name
marketingname is a string. marketingname is optional.
mktpn
Marketing part number
mktpn is a string. mktpn is optional.
mnftpn
Manufacturing part number.
mnftpn is a string. mnftpn is optional.
sn
Serial Number of a module.
sn is a string. sn is optional.
hwrev
Hardware revision of the module.
hwrev is a string. hwrev is optional.
swbootpn
Software boot part number.
swbootpn is a string. swbootpn is optional.
swpn
Application software part number. Format is R<major>.<minor>.<mtnc>.<build>
(for example, R3.0.0.26).
swpn is a string. swpn is optional.
fpgaswpn
WRM-782 small FPGA version
cpldswpn
WRM-782 CPLD version
fpga0swpn
WRM-782 traffic FP GA0 version
fpga1swpn
WRM-782 traffic FP GA1 version
edfaswpn
EDFA software part number on WRA-XXX cards. Format is
<major>.<minor>.<bug-fix>.<build>.
edfaswpn is a string. edfaswpn is optional.
sessiontmout
The timeout interval, in minutes, after which an inactive user session will be auto-
matically terminated by the Communications module. Integer between 1 and 999.
The Communications module sends a ^Canc automatic message to notify the OS.
The factory default value is 999 minutes.
sessiontmout is a integer. sessiontmout is optional.
passwdreentry
PASSWDREENTRY is introduced to the RTRV-EQPT and ED-EQPT command for
the COM-200 card. This parameter defines the password re-entry behaviour for all
TL1 users on the system. The value is either ENABLED or DISABLED.
passwdreentry is of type EnabledDisabled on page 2-36. The default value is
"Disabled".
ipaddr
IP address for a management interface. Only applicable to a Communications
module.This consists of four bytes converted into decimal numbers. Each number is
separated by a decimal point (".") and has an integer value between 0 and 255 (inclu-
sive). If successfully entered the changed value will only take effect after the card
reset. 0.0.0.0 is an invalid address. The factory default value is 10.0.0.2.
gtwyaddr
The Gateway Internet Protocol (IP) Address. Only applicable to a COM-200
module.This consists of four bytes converted into decimal numbers. Each number is
separated by a decimal point (".") and has an integer value between 0 and 255 (inclu-
sive). If successfully entered the changed value will only take effect after the card
reset. 0.0.0.0 is a invalid address. The factory default value is 0.0.0.0.
gtwyaddr is a string. gtwyaddr is optional.
subnetmask
The Subnet Internet Protocol (IP) Address Mask. Only applicable to a Communica-
tions module.This consists of four bytes converted into decimal numbers. Each
number is separated by a decimal point ("."). The first threes numbers have an
integer value between 0 and 255 (inclusive), and the last number must be smaller
than 255. If successfully entered the changed value will only take effect after the card
reset. The factory default value is 255.255.255.0.
subnetmask is a string. subnetmask is optional.
switchport1conf
SWITCHPORT1CONF
switchport1conf is a string. switchport1conf is optional.
switchport2conf
SWITCHPORT2CONF
switchport2conf is a string.
switchport2conf is optional.
switchport3conf
SWITCHPORT3CONF
switchport3conf is a string. switchport3conf is optional.
phyethautosensing
Specifies whether the Ethernet physical layer configuration (PHYETHSPEED and
PHYETHDUPLEX) is set through auto-negotiation or manually.
phyethautosensing is of type OnOff on page 2-42
phyethautosensing is optional.
phyethspeed
If PHYETHAUTOSENSING is turned on, this is the Ethernet physical layer speed.
phyethspeed is of type PhysicalEthernetSpeed on page 2-42
phyethspeed is optional.
phyethduplex
If PHYETHAUTOSENSING is turned on, this is the Ethernet physical layer duplex.
snmp
Status of the SNMP agent. Used to determine if the SNMP agent should be activated.
When the field is "disabled" the SNMP agent does not generate traps or respond to
SNMP requests. The factory default = "DISABLED".
snmp is of type EnabledDisabled on page 2-36
snmp is optional.
snmptraps
Status of SNMP traps. Used to permit or prevent the generation of traps by the agent.
The agent must be enabled in order for this option to be effective. The factory default
= "DISABLED".
snmptraps is of type EnabledDisabled on page 2-36.
snmptraps is optional.
snmptrapdest1
First destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest1 is a string.
snmptrapdest1 is optional.
snmptrapdest2
Second destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest2 is a string.
snmptrapdest2 is optional.
snmptrapdest3
Third destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest3 is a string.
snmptrapdest3 is optional.
snmptrapdest4
Fourth destination IP address for SNMP traps, if enabled. An address of 0.0.0.0 (the
default address) disables this trap destination.
snmptrapdest4 is a string.
snmptrapdest4 is optional.
readcommunity
The SNMP read community string.
readcommunity is a string.
readcommunity is optional.
writecommunity
The SNMP write community string.
writecommunity is a string.
writecommunity is optional.
temp
Measured temperature of the module case in degrees Celcius.
temp is a string.
temp is optional.
ltemp
Measured temperature of the pump laser in degrees Celsius on WRA-XXX cards.
ltemp is a string.
ltemp is optional.
svclks
aps
Reports whether auto mode (i.e., Automatic Protection Switching) is on or off. APS
is off (i.e., unit is in manual mode) when a) an OPR-PROTNSW command has been
accepted but not released; or, b) the mode button on the front panel has been
pressed.
aps is a string.
aps is optional.
swmode
Reports auto mode behaviour as either relative-threshold switching or
fixed-threshold switching.
swmode is a string.
swmode is optional.
rvrtv
Disable/Enable automatic switchback feature. Only applicable to LP 530.
rvrtv is a string.
rvrtv is optional.
aslth
Absolute switching threshold in dBm. Integer in the range of -35 to 0.
aslth is a integer.
aslth is optional.
uwsr
Upper Window Switching Range (dB). Real number, 3 decimal places.
uwsr is a integer.
uwsr is optional.
lwsr
Lower Window Switching Range (dB). Real number, 3 decimal places.
lwsr is a integer.
lwsr is optional.
actpath
Indicates the current position of the switch (PRI or SEC).
actpath is a string.
actpath is optional.
senseprior
Reports whether sense priority mode = ON/OFF.
senseprior is a string.
senseprior is optional.
sfpmissing
‘YES’ indicates that an SFP transceiver is physically absent. ‘NO’ indicates that it is
present. If the value of this field is ‘YES’, then all other SFP-related fields are
defaulted as follows:
• sfpbitratemax = 0
• sfpbitratemin = 0
• sfpwavelength = 0
• sfpvendorname = "" (empty string)
• sfppartnumber = "" (empty string)
• sfpserialnumber = "" (empty string)
sfpmissing is of type YesNoWord on page 2-56.
sfpmissing is optional.
sfpbitratemax
Maximum bit rate of the SFP transceiver.
sfpbitratemax is a integer.
sfpbitratemax is optional.
sfpbitratemin
Minimum bit rate of the SFP transceiver.
sfpbitratemin is a integer.
sfpbitratemin is optional.
sfpwavelength
Nominal wavelength of the SFP transceiver.
sfpwavelength is a float.
sfpwavelength is optional.
trunkwavelength
Nominal wavelength of the trunk interface.
trunkwavelength is a float.
trunkwavelength is optional.
sfpvendorname
SFP vendor name.
sfpvendorname is a string.
sfpvendorname is optional.
sfppartnumber
Part number of the SFP.
sfppartnumber is a string.
sfppartnumber is optional.
sfpserialnumber
SFPSERIALNUMBER
sfpserialnumber is a string.
sfpserialnumber is optional.
manualdatalockrate
The 3R provisioned data rate must be manually configured to allow the user data to
flow properly through the module.
The WRT-840 module only supports a single bi-directional data rate to be config-
ured. Remove the card from service before changing this attribute. manualdatalock-
rate is a string.
manualdatalockrate is optional.
trafficmode
TRAFFICMODE
trafficmode is of type TrafficMode on page 2-53.
trafficmode is optional.
amplifiermode
AMPLIFIERMODE
amplifiermode is of type Amplifier Mode on page 2-32
amplifiermode is optional.
sensemonitor
SENSEMONITOR
sensemonitor is of type OnOff on page 2-42
sensemonitor is optional.
maxsafeatten
26.9 maxsafeatten is a string.
maxsafeatten is optional.
uptime
Time in seconds since the last reset.
uptime is a integer. uptime is optional.
lastresetreason
LASTRESETREASON
lastresetreason is of typeResetReason on page 2-44. lastresetreason is optional.
ampoprmode
Amplifier Operating Mode.
ampoprmode is of type AmpOperatingMode on page 2-32. ampoprmode is optional.
targetgain
For WRA-XXX cards. WRA-1XX: 13 to 26dB, WRA-2XX: 13 to 23 dB. Float with
one decimal precision.
targetgain is a string. targetgain is optional.
targetpower
For WRA-XXX cards. WRA-1XX: -3dB to MAX_OUTPUT_POWER, WRA-2XX:
-6dB to MAX_OUTPUT_POWER. Float with one decimal precision.
targetpower is a string. targetpower is optional.
losshutdown
For WRA-XXX cards. When enabled, the unit will turn off the pump laser when a
LOS condition is detected on the input port.
losshutdown is of typeYesNoWord on page 2-56. losshutdown is optional.
pumpcurrent
For WRA-XXX cards. The measured pump current in mA. Float with one decimal
precision.
voaattenuation
For WRA-XXX cards. The measured VOA attenuation, in dB. Float with one
decimal precision.
voaattenuation is a string. voaattenuation is optional.
signalgain
For WRA-XXX cards. The measured signal gain in dB. Float with one decimal preci-
sion.
signalgain is a string. signalgain is optional.
laserstatus
LASERSTATUS
laserstatus is of type EnabledDisabled on page 2-36. laserstatus is optional.
autoratelocking
Selects the WRT-780/840/842 locking mode by indicating whether automatic rate
locking is ENABLED or DISABLED. When this field is set to DISABLED, manual
rate locking is used.
NOTE: This field can only be changed when the EQPT is in maintenance state.
autoratelocking is of type EnabledDisabled on page 2-36. autoratelocking is
optional.
ip6addr
IP6ADDR ip6addr is a string. ip6addr is optional.
ip6pfix
IP6PFIX ip6pfix is a integer. ip6pfix is optional.
ip6gtwyaddr
IP6GTWYADDR ip6gtwyaddr is a string. ip6gtwyaddr is optional.
pstpstq
Primary state-Primary State Qualifier, i.e. {IS|OOS}-{NR|AU|MA|AUMA}
pstpstq is of type PrimaryState on page 2-43. pstpstq is optional.
sst
Secondary state.
sst is of type Secondary State on page 2-48 and is listable. sst is optional.
Output Example
M 100 COMPLD
"1-5:CLEI:MODULETYPE=WRT 780A,ID=CustomerOne,
VENDORNAME=JDSUniphase,MARKETINGNAME=WRT-780A,
MKTPN=WRM-728DT000B,MNFTPN=WRT780A,
SN=JS-09A7M0028,HWREV=007,SWBOOTPN=R4.9.0.054,
SWPN=R4.9.0.054,SENSEMONITOR=DISABLED”
;
RTRV-PROC-EQPT
This command requires a Provisioning Level 1 User Access Privilege.
Description
Input Format
RTRV-PROC-EQPT:[TID]:<src>:CTAG::[PROCEDURE=<procedure>];
Input Parameters
tidTarget identifier of the network element or system that contains the module to
which the command is directed.
src
Access identifier of the target.
src is the AID AllSlots on page 2-24.
ctag
Correlation tag
Input Example
RTRV-PROC-EQPT:Node198:1-C:100::
PROCEDURE=AUTO-CHANNEL-TURNUP;
Output Format
Output Parameters
aid
Identifies the entity in the NE to which the command pertains.
aid is the AID AllSlots on page 2-24.
procedure
The procedure for which the status applies.
procedure is of type Procedure Type on page 2-43.
status
The status of the given procedure.
status is a string.
Output Example
RTRV-INV
This command requires a Provisioning Level 1 User Access Privilege.
Description
Input Format
RTRV-INV:[TID]:[<aid>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed. Optional. If left blank, the default = the GNE.
ctag
Correlation tag
aid
AID
aid is the AID AllSlotsIncALL on page 2-26.
Input Example
RTRV-INV:Node198:1-C:100;
Output Format
Output Parameters
aid
Access identifier that identifies the NRP module. Only module-level access identi-
fiers apply (i.e., not port-level).
aid is a string.
moduletype
The type of a module.
moduletype is a string. Possible values:
• COMM200
• WRT740
• WRT760
• WRT780
• WRT781
• WRT840
• WRT842
• WRT852
• WRM-782
• WRS-051
• LIGHTAMP
• BRIGHTAMP
• LP530
• WRA110
• WRA113
• WRA116
• WRA119
• WRA217
• WRA217L
• WRA219
• UNKNOWN
swpn
Application software part number. Same as the SWPN returned in the RTRV-EQPT
response. Format is R<Major>.<Minor>.<Mtnc>.<Build> (e.g. R3.0.0.26).
swpn is a string.
Output Example
RTRV-LNKS
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to report the local TL1 routing information stored in the
selected COM-200. Used in conjunction with the RTRV-TIDS command to
retrieve the nodes and SVC links to reflect the current known topology of the node
being queried.
Input Format
RTRV-LNKS:[TID]::CTAG;
Input Example
RTRV-LNKS:Node198::100;
Output Format
Output Parameters
aid
Supervisory communications port through which a remote TID can be reached.
Corresponds to the aid of the port that is used to route TL1 messages to the remote
TID.
aid is a string.
tid
TID of the remote NE.
tid is a string.
remoteaid
Port AID at the far end of the SVC link.
remoteaid is a string.
Output Example
RTRV-TIDS
This command requires a Provisioning Level 1 User Access Privilege.
Description
This command retrieves the global TL1 routing table for the subnetwork. Used in
conjunction with the RTRV-LNKS command to retrieve the nodes and Inband
supervisory management channel links to reflect the current known topology of
the node being queried.
Input Format
RTRV-TIDS:Node198::100;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed. Optional. If left blank, the default = the GNE.
ctag
Correlation tag
Input Example
RTRV-TIDS:TID::CTAG;
Output Format
Output Parameters
tid
TID of the remote NE.
tid is a string.
metric
The number of nodes from the selected NE to the far end TID. For example, NEs that
are connected through one supervisory link are 1 hop away.
metric is a integer.
Output Example
ALW-OSC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to enable the supervisory channel on the specified port.
NOTE: Not all modules and not all traffic modes support a supervisory channel. For more
information on the capabilities of a particular module, see the module documentation.
note: This command will be phased out in future releases. It is recommended to use the
ED-SVC command instead. See ED-SVC on page 6-6.
Input Format
ALW-OSC:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag.
aid
Only applicable to transponder network side ports in the local NE. This command
will not be accepted by remote transponders (i.e., where the port AID contains "-F".
(See Invalid Input Example below.)
aid is the AID AllPorts on page 2-23.
ALW-OSC:TID:3-11-1-2:100;
ALW-OSC:TID:3-9-1-2-F-1-1:100;
ED-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs the NE to set configuration parameters that are specific to the optical
port specified by the <aid>. The four-part AID structure of a WRT-780 port is
supported by this command.
The primary state and other port-specific parameters cannot be changed in the
same ED-OCH command. Separate commands are required. An ED-OCH
command containing entries in both the <pst> and the <port specific parameters>
blocks will be denied.
Input Format
ED-OCH:[TID]:<aid>:CTAG:::[ID=<id>],
[LASERDISABLE=<laserdisable>],
[ONCLIENTLOS=<onclientlos>],[BITRATE=<bitrate>],
[WAVELENGTH=<wavelength>],[GAINTARGET=<gaintarget>],
[OUTPUTPWRTARGET=<outputpwrtarget>],
[LOSTHRESHOLD=<losthreshold>],
[LOSHYSTERESIS=<loshysteresis>],
[LOOTHRESHOLD=<loothreshold>],
[LOOHYSTERESIS=<loohysteresis>],
[INPUTDEGRADETHRESHOLD=<inputdegradethreshold>],
[INPUTDEGRADEHYSTERESIS=<inputdegradehysteresis>],
[OUTPUTDEGRADETHRESHOLD=<outputdegradethreshold>],
[OUTPUTDEGRADEHYSTERESIS=<outputdegradehysteresis>],
[RXDTOPTMODE=<rxdtoptmode>],[MANUALRXDT=<manualrxdt>]:
[PST=<pst>]
;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag.
aid
Access identifier that identifies the optical port for which the command is intended.
aid is the AID AllPorts on page 2-23.
id
A user-assigned name, for port identification purposes.
id is optional
laserdisable
Manual override to disable the laser associated with the specified network-side tran-
sponder port. Only lasers belonging to transponders in the local shelf can be disabled
using this parameter. Lasers in remote transponders (i.e., where the port AID
contains "-F") can not be disabled.
laserdisable is of type YesNo on page 2-56.
onclientlos
Specifies what action should be taken on the network side laser when an LOS is
detected on the client side.
OFF = Turn the network laser off when an LOS is detected on the client side
SQUELCH = Squelch the line data but maintain supervisory communications when
an LOS is detected on the client side.
onclientlos is of type OnClientLOS on page 2-41. The default value is " SQUELCH " .
bitrate
BITRATE
bitrate is a integer.
wavelength
WAVELENGTH
wavelength is a string.
gaintarget
GAINTARGET gaintarget is a string.
outputpwrtarget
OUTPUTPWRTARGET
outputpwrtarget is a string.
losthreshold
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
losthreshold is a string.
loshysteresis
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
loshysteresis is a string.
loothreshold
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
loothreshold is a string.
loohysteresis
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
loohysteresis is a string.
inputdegradethreshold
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
inputdegradethreshold is a string.
inputdegradehysteresis
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
inputdegradehysteresis is a string.
outputdegradethreshold
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
outputdegradethreshold is a string.
outputdegradehysteresis
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
outputdegradehysteresis is a string.
rxdtoptmode
WRT-84x specific. Indicates the receiver decision threshold adjustment optimiza-
tion mode. This value can only be changed when the network port is in maintenance
state.
rxdtoptmode is of type RxDtOptimizationMode on page 2-46.
manualrxdt
WRT-84x specific. Indicates the receiver decision threshold in percent. Used in
MANUAL optimization mode (RXDTOPTMODE) only. This value can only be
changed when the network port is in maintenance state.
manualrxdt is a string.
sfptemp
Shows the measured internal temperature in degrees C of the SFP. Note: This value
is not valid with Copper SFPs installed in a WRT-780 and will report "0."
sfptemp is a string
sfplaserbiascurrent
Shows the measured bias current, in mA, that is being applied to the laser diode
within the specified SFP. Note: This value is not valid with Copper SFPs installed in
a WRT-780 and will report "0."
pst
Primary state. The value IS puts a port administratively up. Alternatively, the same
can be accomplished with the command RST-OCH. Likewise, the value OOS puts a
port administratively down. Alternatively, the same can be accomplished with the
command RMV-OCH.
pst is of type PrimaryState on page 2-43. [IS, OOS].
Note: Issuing an RMV-OCH command has the same result.
Note: Taking a Copper SFP installed in a WRT-780 out of service does not affect the
traffic.
Input Example
ED-OCH:Node:3-1-1-1:100:::LASERDISABLE=N,ONCLIENTLOS=OFF,
BITRATE=1,WAVELENGTH=1310:IS;
ED-SVC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
ED-SVC:[TID]:<aid>:CTAG:::
[EFFECTOFDATAPATHDOWN=<effectofdatapathdown>]:[PST=<pst>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the local network optical port for which the
command is intended.
aid is the AID AllNetworkPorts on page 2-23.
effectofdatapathdown
This attribute is used to control whether or not the SVC will go autonomously out
of service when the supporting network port changes to OOS state.
TURNOFF: If this attribute is set to "turnoff", the SVC will autonomously go out of
service when the supporting network port changes to OOS state.
NONE: If this attribute is set to "none", the SVC will not change to OOS when the
supporting network port changes to OOS state.
effectofdatapathdown is of type EffectOfDataPathDown on page 2-36.
pst
Primary state. The value IS puts a port administratively up. Alternatively, the same
can be accomplished with the command RST-OCH. Likewise, the value OOS puts a
port administratively down. Alternatively, the same can be accomplished with the
command RMV-OCH.
pst is of type PrimaryState on page 2-43. [IS, OOS]
Taking
a Copper SFP installed in a WRT-780 out of service does not affect the traffic
directly, however, since its state propagates to its associated optical SFP, end-to-end
Ethernet traffic will be affected.
Input Example
ED-SVC:Node198:3-1-1-2:100:::TURNOFF:IS;
ED-OCHC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs the NE to set configuration parameters that are specific to the wavelength
channel specified by the <aid>.
The primary state and other wavelength-specific parameters cannot be changed in
the same ED-OCH command. Separate commands are required. An ED-OCH
command containing entries in both the <pst> and the <wavelength specific
parameters> blocks will be denied.
Input Format
ED-OCHC:[TID]:<src>:CTAG:::[ID=<id>],
[OUTPUTPWRTARGET=<outputpwrtarget>],
[FROMPORT=<fromport>]:[PST=<pst>];
Input Parameters
src
Access identifier that identifies the wavelength channel for which the command is
intended. i is the AID AllChannelsIncAll on page 2-22
and is listable and rangeable.
id
Customer configurable identifier for the wavelength channel. id is a string.
outputpwrtarget
Output power target level in dBm.
outputpwrtarget is a string.
fromport
The port from which wavelength channel connection is added. All connections
terminate to port 1 or the common port.
fromport is a integer.
pst
Primary state. The value IS puts a wavelength channel administratively in service.
Alternatively, the same can be accomplished with the command RST-OCHC. Like-
wise, the value OOS puts a wavelength channel administratively out of service. Alter-
natively, the same can be accomplished with the command RMV-OCHC.
pst is of type Primary state (PST) on page 2-29. [IS, OOS]
Input Example
ED-OCHC:Node198:ALL:100:::ID=CustomerOne,
OUTPUTPWRTARGET=-5,FROMPORT=1:IS;
ED-XPDR
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to set the configuration parameters for the WRT-780
transponder ports. The WRT-780 supports two independently configurable
transponders, each of which has one client and one network port. The settings
configured for the transponder affect the operation of the client and network ports
associated with the transponder.
To change the rate locking mode or the manual data lock rate, both the client and
the network port associated with the transponder must be in a maintenance state.
Input Format
ED-XPDR:[TID]:<aid>:CTAG:::
[MANUALDATALOCKRATE=<manualdatalockrate>],
[AUTORATELOCKING=<autoratelocking>],
[EXPECTEDRXBITRATE=<expectedrxbitrate>],
[FASTFAULTPROP=<fastfaultprop>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
AID
aid is the AID AllTransponders on page 2-28.
manualdatalockrate
MANUALDATALOCKRATE
manualdatalockrate is a string. Before changing this parameter, the ports for the
transponder must be OOS.
autoratelocking
AUTORATELOCKING
autoratelocking is of type EnabledDisabled on page 2-36.
Enables or disables Automatic Rate Locking independently for each of the two tran-
sponders. When enabled, the ports of the associated transponder automatically
attempt to lock on any of the supported data rates. When disabled, the ports attempt
to lock on only the user-provisioned manual lock data rate.
The locking behavior applies to each port independent of all other ports, and applies
whether the port is looped back or not. The ports must be out of service to change
this setting.
expectedrxbitrate
EXPECTEDRXBITRATE. When Automatic Rate Locking mode is enabled for a
transponder, an expected bit rate can be specified. If the port locks onto a bit-rate
that is different than the expected bit rate, the port will continue to accept the data,
but a Bit Rate Mismatch alarm will be generated. If this parameter is set to 0, then no
bit rate comparison is performed. This value can be modified while the transponder
ports are in-service.
expectedrxbitrate is a string.
fastfaultprop
FASTFAULTPROP
fastfaultprop is of type EnabledDisabled on page 2-36.
If an LOS or LOL condition is detected on one of the transponder ports when Fast
Fault Propagation is enabled (and no loopback operation is in effect), the laser on the
other transponder port will shut down. The usual debounce raise time does not
apply. The debounce recovery time will be as usual. See the transponder documen-
tation for details.
Fast Fault Propagation should be enabled only when the TL1 is deployed in a
protected network where service is switched between redundant TL1 transponders
by an optical layer protection switch such as a WaveReady LP530.
Input Example
ED-XPDR:Node198:1-8-2:100:::MANUALDATALOCKRATE=GBE/1250,
AUTORATELOCKING=DISABLED,EXPECTEDRXBITRATE=0,
FASTFAULTPROP=DISABLED;
ED-MXP
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to set the configuration parameters for the WRM-782
muxponder ports. The WRM-782 supports one muxponder transponders, with
three client and one network port. The settings configured for the musponder
affect the operation of the client and network ports.
To change the rate locking mode or the manual data lock rate, both the client and
the network port associated with the muxponder must be in a maintenance state.
Input Format
ED-MXP:[TID]:<aid>:[CTAG]:::
[NETWORKMANUALDATALOCKRATE=<networkmanualdatalockrate>],
[CLIENT1MANUALDATALOCKRATE=<client1manualdatalockrate>],
[CLIENT2MANUALDATALOCKRATE=<client2manualdatalockrate>],
[CLIENT3MANUALDATALOCKRATE=<client3manualdatalockrate>],
[AUTORATELOCKING=<autoratelocking>],
[FASTFAULTPROP=<fastfaultprop>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
AID
aid is the AID AllTransponders on page 2-28.
networkmanualdatalockrate
NETWORKMANUALDATALOCKRATE
networkmanualdatalockrate is a string. This parameter determines the incoming
data rate that the network port will lock on to. Before changing this parameter, the
ports of the muxponder must be OOS.
clientXmanualdatalockrate
CLIENTXMANUALDATALOCKRATE
clientxmanualdatalockrate is a string. This parameter determines the incoming
data rate that the specified client port will lock on to.Before changing this parameter,
the ports for the muxponder must be OOS.
autoratelocking
AUTORATELOCKING
autoratelocking is of type EnabledDisabled on page 2-36.
Enables
or disables Automatic Rate Locking for the muxponder. When enabled, the ports
automatically attempt to lock on any of the supported data rates. When disabled, the
ports attempt to lock on only the user-provisioned manual lock data rate.
The
locking behavior applies to each port independent of all other ports, and applies
whether the port is looped back or not. The ports must be OOS to change this setting.
fastfaultprop
FASTFAULTPROP
fastfaultprop is of type EnabledDisabled on page 2-36.
If an LOS or LOL condition is detected on one of the muxponder client ports when
Fast Fault Propagation is enabled (and no loopback operation is in effect), a remote
signal fail alarm will shut down the upstream network port laser. If an LOS or LOL
condition is detected on the muxponder network port, the client port lasers will shut
down. The usual debounce raise time does not apply. The debounce recovery time
will be as usual. See the muxponder documentation for details.
Fast Fault Propagation should be enabled only when the muxponder is deployed in
a protected network where service is switched between redundant muxponders by
an optical layer protection switch such as a WaveReady LP530.
Fast Fault Propagation is the only configurable parameter in release 4.6.0.
Input Example
ED-MXP:Node198:3-1-1:100:::
NETWORKMANUALDATALOCKRATE=OTU1OVERCLOCKED4G,
CLIENT1MANUALDATALOCKRATE=GBE/1250,
CLIENT2MANUALDATALOCKRATE=GBE/1250,
CLIENT3MANUALDATALOCKRATE=GBE/1250,
AUTORATELOCKING=DISABLED,FASTFAULTPROP=DISABLED;
INH-OSC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to disable the supervisory channel on the specified port.
note: This command is phased out in future releases. It is recommended to use the ED-SVC
command instead. See ED-SVC on page 6-6.
Input Format
INH-OSC:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Only applicable to transponder network side ports in the local NE. This command
will not be accepted by remote transponders (i.e., where the port AID contains "-F".
See Input Example below for invalid command.) aid is the AID AllPorts on page
2-23.
Input Example
INH-OSC:Node198:3-10-1-2:100;
INIT-XPDR
This command requires a Provisioning Level 4 User Access Privilege.
Description
This command causes a warm or cold restart of the specified transponder. A warm
restart is not traffic affecting. A cold restart is traffic affecting only for the specified
transponder.
Input Format
INIT-XPDR:[TID]:<aid>:CTAG:: RESTARTMODE=<restartmode>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the transponder for which the command is intended.
aid is the AID AllTransponders on page 2-28.
restartmode
Indicates the level of the restart.
restartmode is of type RestartModeType on page 2-45
Input Example
INIT-XPDR:Node198:3-10-2-F-1:100::RESTARTMODE=COLD;
OPR-LPBK-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to instruct the specified transponder port to operate the
loopback function.
For the WRT-840, this command will only be accepted when the corresponding
port is in an administrative out-of-service state (i.e., OOS-MA or OOS-AUMA). If
the port is still in service, a "Command Invalid" response will be returned.
The WRT-840 supports the looping back of optical ports (client and network) one
at a time. Therefore, separate commands are needed to instruct each of the optical
ports to loop-back (as specified by the command).
For WRT-7xx transponder modules, all ports must be administratively out of
service before this command can be executed (on any port). If the ports are still in
service, a "Command Invalid" response will be returned. The hardware provides a
loopback on the client and working trunk ports when a loopback command is
applied to any port.
For WRT-740 and WRT-760 transponder modules, all ports must be
administratively out of service before this command can be executed (on any
port). If the ports are still in service, a "Command Invalid" response will be
returned. The hardware provides a loopback on the client and working trunk ports
when a loopback command is applied to any port.
For WRM-782 modules, a client port must be administratively removed from
service before initiating a terminal or facility loopback on that port. All WRM-782
ports must be administratively removed from service before initiating network
port loopbacks. If the port is still in service, a "Command Invalid" response will be
returned.
During a network side facility loopback, the network port laser is re-enabled, while
the client port lasers stay off. On the other hand, during a network side terminal
loopback, both the client and network port laser are re-enabled.
Note that a port that is ‘looped-back’ should report this condition in response to a
RTRV-COND-EQPT command.
Input Format
OPR-LPBK-OCH:[TID]:<aid>:CTAG::,,,[LOOPBACKTYPE=<lpbktype>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the port for which the command is intended.
aid is the AID AllPorts on page 2-23.
lpbktype
Specifies the loopback type. lpbktype is either LPBKTYPEENUM.
Input Example
OPR-LPBK-OCH:Node198:1-10-2-2:100::,,,FACILITY;
RLS-LPBK-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Purpose
Use this command to instruct the specified transponder port to exit loopback
mode.
Input Format
RLS-LPBK-OCH:[TID]:<aid>:CTAG::,,,[LOOPBACKTYPE=<lpbktype>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the port for which the command is intended.
aid is the AID AllPorts on page 2-23.
lpbktype
Specifies the loopback type. lpbktype is either FACILITY or TERMINAL.
Input Example
RLS-LPBK-OCH:Node198:1-10-2-2:100::,,,FACILITY;
RMV-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
This command instructs the specified port to change from the in-service (IS) state
to the out-of-service (OOS) state so that maintenance activities can be performed.
NOTE: The LightAmp and BrightAmp modules do not support state configuration.
NOTE: Taking a Copper SFP installed in a WRT-780 out of service does not affect the traffic
directly, however, since its state propagates to its associated optical SFP, end-to-end Ethernet
traffic will be affected.
Input Format
RMV-OCH:[TID]:<aid>:CTAG::,;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the port for which the command is intended.
aid is the AID AllPorts on page 2-23.
Input Example
RMV-OCH:Node198:2-3-1-2:65::,;
RMV-OCHC
This command requires a Provisioning Level 4 User Access Privilege. Use this
command to remove an optical channel connection from service.
Input Format
RMV-OCHC:[TID]:<src>:CTAG::;
Input Parameters
tid
Target identifier of the network element.
src
AID src is the AID AllChannelsIncAll on page 2-22
This parameter listable and rangeable; a list or range of optical channels can be
configured at the same time.
ctag
Correlation tag
Input Example
RMV-OCHC:Node198:ALL:66::;
RST-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to instruct a port to change from an out-of -service (OOS) state
to an in-service (IS) state.
The module must be in-service before any of its ports can be put in-service.
NOTE: The LightAmp and BrightAmp modules do not support state configuration.
Input Format
RST-OCH:[TID]:<aid>:CTAG::;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the NRP module(s) for which the command is
intended. Only port-level AIDs are acceptable (i.e., not module-level AIDs).
aid is the AID AllPorts on page 2-23
Input Example
RST-OCH:Node198:1-5-1-2:67::;
RST-OCHC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
RST-OCHC:[TID]:<src>:CTAG::;
Input Parameters
tid
Target identifier of the network element.
src
AID src is the AID AllChannelsIncAll on page 2-22
This parameter listable and rangeable; a list or range of optical channels can be
configured at the same time.
ctag
Correlation tag
Input Example
RST-OCHC:Node198:ALL:68::;
RTRV-ALM-OCH
This command requires a Maintenance Level 1 User Access Privilege.
Description
Use this command to retrieve optical channel (port) level events and alarms.
Input Format
RTRV-ALM-OCH:[TID]:[<aid>]:CTAG::[<ntfcncde>],[<condtype>],
[<srveff>],,,;
Input Parameters
tid
Target identifier of the network element.
src
AID src is the AID AllSlotsAndPorts on page 2-25
. This parameter is listable and rangeable; a list or range of optical channels can be
configured at the same time.
ctag
Correlation tag
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The service effect.
srveff is of type Service Effect on page 2-51.
Input Example
RTRV-ALM-OCH:Node198:1-5-2:69::MJ, LOS,SA,,,;
Output Format
Output Parameters
aid
AID aid is a string.
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The service effect.
srveff is of type Service Effect on page 2-51.
ocrdat
The occurrence date.
ocrdat is a string.
ocrtm
The occurrence time.
ocrtm is a string.
conddescr
The condition description.
conddescr is a string.
Output Example
RTRV-ALM-OSC
This command requires a Maintenance Level 1 User Access Privilege.
Description
Use this command to retrieve optical supervisory channel level events and alarms.
Input Format
RTRV-ALM-OSC:[TID]:[<aid>]:CTAG::[<ntfcncde>],[<condtype>],
[<srveff>],,,;
Input Parameters
tid
Target identifier of the network element.
src
AID src is the AID AllChannelsIncAll on page 2-22
. This parameter listable and rangeable; a list or range of optical channels can be
configured at the same time.
ctag
Correlation tag
Input Example
Output Format
Output Parameters
aid
AID aid is a string.
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The service effect.
srveff is of type Service Effect on page 2-51.
ocrdat
The occurrence date.
ocrdat is a string.
ocrtm
The occurrence time.
ocrtm is a string.
conddescr
The condition description.
conddescr is a string.
Output Example
RTRV-ATTR-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to retrieve alarm attributes for optical channel (port)
modifiers.
Input Format
RTRV-ATTR-OCH:[TID]:<aid>:CTAG::[<ntfcncde>],[<condtype>],,,
;
Input Parameters
tid
Target identifier of the network element.
aid
AID is the AID AllPorts on page 2-23
. This parameter listable and rangeable; a list or range of optical channels can be
configured at the same time.
ctag
Correlation tag
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-ATTR-OCH:Node198:3-8-2-1:72::CL, LOS,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_OCH_OSC_OCHC on page 2-47.
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
dirn is of type Dirn on page 2-35.
Output Example
RTRV-ATTR-OSC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to retrieve alarm attributes for optical supervisory channel
related alarms and events.
Input Format
RTRV-ATTR-OSC:[TID]:<aid>:CTAG::[<ntfcncde>],[<condtype>],,,
;
Input Parameters
tid
Target identifier of the network element.
aid
AID src is the AID AllPorts on page 2-23
This parameter is listable and rangeable; a list or range of optical channels can be
configured at the same time.
ctag
Correlation tag
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-ATTR-OSC:Node198:3-12-2-2:73::CL, LOL,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_OCH_OSC_OCHC on page 2-47.
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
dirn is of type Dirn on page 2-35.
Output Example
RTRV-COND-OCH
This command requires a Maintenance Level 1 User Access Privilege.
Description
Input Format
RTRV-COND-OCH:[TID]:<aid>:CTAG::[<condtype>],,,;
Input Parameters
tid
Target identifier of the network element.
aid
AID src is the AID AllPorts on page 2-23. This parameter is listable and rangeable; a
list or range of optical channels can be configured at the same time.
ctag
Correlation tag
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-COND-OCH:Node198:1-12-1-2:74:: BITRATEMIS,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_OCH_OSC_OCHC on page 2-47.
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The service effect.
srveff is of type Service Effect on page 2-51.
ocrdat
The occurrence date.
ocrdat is a string.
ocrtm
The occurrence time.
ocrtm is a string.
dirn
Direction.
dirn is of type Dirn on page 2-35.
dnField
dnField is a string.
Output Example
RTRV-COND-OSC
This command requires a Maintenance Level 1 User Access Privilege.
Description
Input Format
RTRV-COND-OSC:[TID]:<aid>:CTAG::[<condtype>],,,;
Input Parameters
tid
Target identifier of the network element.
aid
AID src is the AID AllPorts on page 2-23. This parameter is listable and rangeable; a
list or range of optical channels can be configured at the same time.
ctag
Correlation tag
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-COND-OSC:Node198:1-12-1-2:75:: MJ,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_OCH_OSC_OCHC on page 2-47.
ntfcncde
The notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The service effect.
srveff is of type Service Effect on page 2-51.
ocrdat
The occurrence date.
ocrdat is a string.
ocrtm
The occurrence time.
ocrtm is a string.
dirn
Direction.
dirn is of type Dirn on page 2-35.
dnField
dnField is a string.
Output Example
RTRV-OCH
This command requires a Provisioning Level 1 User Access Privilege.
Description
Input Format
RTRV-OCH:[TID]:[<aid>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier that identifies the optical port for which the command is intended.
aid is the AID AllPorts on page 2-23. The four-part AID structure of a WRT-780
port is supported by this command.
Input Example
RTRV-OCH:Node198:2-10-2-2:76;
Output Format
[B2BRXDT=<b2brxdt>],[SFPTEMP=<sfptemp>],
[SFPLASERBIASCURRENT=<sfplaserbiascurrent>]
:<pstpstq>,[<sst>]" ;
Output Parameters
tid
Target identifier of the network element or system that contains the COM-200
module to which the command is sent.
ctag
Correlation tag
aid
Access identifier of the optical port.
aid is a string.
porttype
The type of a module. The valid values are:
• WS Client Port
• WS Network Port
• LP Primary Port
• LP Protection Port
• WS760 Client Port
• WS760 Network Port
• WRA Rx port
• WRA Tx port.
porttype is a string.
customerid
customerid is a user-assigned name, for port identification purposes.
customerid is a text-string.
laserdisabled
Status of manual override associated with the specified transponder port.
If there is an embedded management channel associated with this port and it is IS
and the user data-path is disabled on the network port, the network port will leave
its laser enabled so that the embedded management channel can continue to operate.
When the embedded management channel is OOS and the user data-path is disabled
on the network port, the network port will disable the laser.
laserdisabled is of type YesNo on page 2-56. laserdisabled is optional.
onclientlos
Specifies what action should be taken on the network side laser when an LOS is
detected on the client side and when a client port goes out-of-service.
OFF = The network laser will be turned off when an LOS is detected on the client side
SQUELCH = The line data will be squelched but supervisory communications will
be maintained when an LOS is detected on the client side.
onclientlos is of type OnClientLOS on page 2-41. onclientlos is optional.
outputpwr
Output power. For WRA-XXX cards, this is a float with one decimal precision.
outputpwr is a string. outputpwr is optional. Shows the power level in dBm of the
optical signal currently being transmitted. If no optical signal is being transmitted
this value is a large negative number.Note: This value is not valid with Copper SFPs
installed in a WRT-780 and will report "0."
signaloutputpwr
For WRA-XXX cards. This is the signal with ASE (Amplifier Systematic Emissions)
compensation. Float with one decimal precision.
signaloutputpwr is a string. signaloutputpwr is optional.
inputpwr
Input power. For WRA-XXX cards, this is a float with one decimal precision.
inputpwr is a string. inputpwr is optional. Shows the power level in dBm of the
incoming optical signal currently being received. If no optical signal is being
received this value is a large negative number.Note: This value is not valid with
Copper SFPs installed in a WRT-780 and will report "0."
bitrate
Bit rate setting configured using the ED-OCH command. Integer value, rounded to
the nearest in Mbps. Valid values are as follows:
• 0: The transponder will attempt to lock onto the bit rate present on the
interface.
• 10 – 10000: The expected bit rate to the nearest integer in Mbps.
Note: The subset of allowable values depends on the type of SFP installed.
bitrate is a integer. bitrate is optional.
actbitrate
The actual (measured) bit rate to the nearest Mbps.
actbitrate is a integer. actbitrate is optional.
reach
The dispersion limited reach of the network side transmitter, in km. Shows the reach
or dispersion limit of the selected port. Note: This value is not valid with Copper
SFPs installed in a WRT-780 and will report "0."
reach is a integer. reach is optional.
outputstatus
Client side laser status.
outputstatus is of type OnOff on page 2-42 outputstatus is optional.
inputstatus
Client side Rx status. Indicates whether or not optical power is present.
inputstatus is of type OnOff on page 2-42. inputstatus is optional.
sfpmissing
YES indicates that an SFP/XFP transceiver is physically absent. NO indicates that it
is present. If the value of this field is YES, all other SFP-related fields are defaulted as
follows:
• sfpbitratemax = 0
• sfpbitratemin = 0
• wavelength = 0
• sfpvendorname = "" (empty string)
• sfppartnumber = "" (empty string)
• sfpserialnumber = "" (empty string)
sfpmissing is of type YesNoWord on page 2-56. sfpmissing is optional
sfpbitratemax
Maximum bit rate of the SFP/XFP transceiver. Expressed in hundreds of Mbps.
sfpbitratemax is a integer. sfpbitratemax is optional.
sfpbitratemin
Minimum bit rate of the SFP/XFP transceiver. Expressed in hundreds of Mbps.
sfpbitratemin is a integer. sfpbitratemin is optional.
wavelength
The nominal wavelength of the network side transmitter in nm. Shows the wave-
length of the selected port. Note: This value is not valid with Copper SFPs installed
in a WRT-780 and will report "0."
wavelength is a string. wavelength is optional.
sfpvendorname
SFP/XFP vendor name.
sfpvendorname is a string. sfpvendorname is optional.
sfppartnumber
Part number of the SFP/XFP.
sfppartnumber is a string. sfppartnumber is optional.
sfpserialnumber
Serial number of the SFP/XFP.
sfpserialnumber is a string. sfpserialnumber is optional.
activelpbks
Indicates the type of active loopbacks:
• FACILITY,
• TERMINAL
uwslth
10.2
uwslth is a string. uwslth is optional.
lwslth
10.2
lwslth is a string. lwslth is optional.
rpl
10.2
rpl is a string. rpl is optional.
actrxbitrate
The Actual Receive Bitrate in Mbps. Note: This parameter is only supported on
client-side ports.
actrxbitrate is a integer. actrxbitrate is optional.
acttxbitrate
The Actual Transmit Bitrate in Mbps. Note: This parameter is only supported on
client-side ports.
acttxbitrate is a integer. acttxbitrate is optional.
datapathsquelched
YES
datapathsquelched is of type YesNoWord on page 2-56. datapathsquelched is
optional.
lasertemp
Indicates the temperature of the laser module.
lasertemp is a string. lasertemp is optional.
gain
gain is a string. gain is optional.
outputpwrtarget
outputpwrtarget is a string. outputpwrtarget is optional.
gaintarget
23.0 gaintarget is a string. gaintarget is optional.
losthreshold
Specific to WRA-XXX cards Rx ports. Float with one decimal precision. losthreshold
is a string. losthreshold is optional.
loshysteresis
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
loshysteresis is a string. loshysteresis is optional.
loothreshold
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
loothreshold is a string. loothreshold is optional.
loohysteresis
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
loohysteresis is a string. loohysteresis is optional.
inputdegradethreshold
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
inputdegradethreshold is a string. inputdegradethreshold is optional.
inputdegradehysteresis
Specific to WRA-XXX cards Rx ports. Float with one decimal precision.
inputdegradehysteresis is a string. inputdegradehysteresis is optional.
outputdegradethreshold
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
outputdegradethreshold is a string. outputdegradethreshold is optional.
outputdegradehysteresis
Specific to WRA-XXX cards Tx ports. Float with one decimal precision.
outputdegradehysteresis is a string. outputdegradehysteresis is optional.
rxdtoptmode
WRT-84x specific. Indicates the receiver decision threshold adjustment optimiza-
tion mode.
manualrxdt
WRT-84x specific. Indicates the receiver decision threshold in percent. Used in
MANUAL optimization mode (RXDTOPTMODE) only.
manualrxdt is a string. manualrxdt is optional.
actualrxdt
WRT-84x specific. Indicates the measured receiver decision threshold in percent.
actualrxdt is a string. actualrxdt is optional.
b2brxdt
B2BRXDT b2brxdt is a string. b2brxdt is optional.
sfptemp
Shows the measured internal temperature in degrees C of the SFP.Note: This value
is not valid with Copper SFPs installed in a WRT-780 and will report "0."
sfptemp is a string. sfptemp is optional.
sfplaserbiascurrent
Shows the measured bias current that is being applied to the laser diode within the
specified SFP in mA. Note: This value is not valid with Copper SFPs installed in a
WRT-780 and will report "0."
sfplaserbiascurrent is a string. sfplaserbiascurrent is optional.
clei
Common Language Equipment Identification code (CLEI).
clei is a string. clei is optional.
tunablelaser
TNABLELASER tunablelaser is of type YesNo on page 2-56. tunablelaser is optional.
pstpstq
Primary state-Primary State Qualifier, i.e. {IS|OOS}-{NR|AU|MA|AUMA}
pstpstq is of type PrimaryState on page 2-43.
sst
Secondary state.
sst is of type Secondary State on page 2-48 and is listable. sst is optional.
Output Example
M 76 COMPLD
"4-1-1:PORTTYPE=WS ClientPort,ID=\"CustomerX\",
LASERDISABLED=N, OUTPUTPWR=2.76, INPUTPWR=-20.22,
ACTBITRATE=1250, REACH=40, SFPMISSING=NO,
SFPBITRATEMAX=4250000, SFPBITRATEMIN=1062500,
WAVELENGTH=1470.00, SFPPARTNUMBER=WRT-SFPI3C42SC-047,
SFPSERIALNUMBER=UD50CWE, ACTIVELPBKS=FACILITY, SFPTEMP=28.0,
SFPLASERBIASCURRENT=7.01:OOS-MA, LPBK"
;
RTRV-SVC
This command requires a Provisioning Level 1 User Access Privilege.
Description
Input Format
RTRV-SVC:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
Access identifier of the target optical port.
aid is the AID AllNetworkPorts on page 2-23
Input Example
RTRV-SVC:Node198:3-7-2-2:77;
Output Format
Output Parameters
aid
Access identifier of the port.
aid is a string.
fskversion
Version of the FSK.
fskversion is a string.
fskrate
Nominal baud rate of the supervisory channel.
fskrate is a integer.
portinuse
The port number that is being used to transmit and receive the supervisory channel.
For example: portinuse = 2 or 3 for the WRT-760 module, since redundant network
ports exist.
portinuse is a string.
effectofdatapathdown
This attribute is used to view whether or not the SVC goes autonomously out of
service when the supporting network port changes to OOS state. If this attribute is
set to "TURNOFF", the SVC will autonomously go out of service when the
supporting network port changes to OOS state. If this attribute is set to "NONE", the
SVC will not change to OOS when the supporting network port changes to OOS
state.
effectofdatapathdown is a string. effectofdatapathdown is optional.
pstpstq
Primary state-Primary State Qualifier, i.e. {IS|OOS}-{NR|AU|MA|AUMA}
pstpstq is of type PrimaryState on page 2-43.
sst
Secondary state. FAF refers to facility failure (i.e., LOS). PRTCL refers to failure due
to protocol reasons (i.e., failure to negotiate link)
sst is of type Secondary State on page 2-48 and is listable. sst is optional.
Output Example
RTRV-XPDR
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve the configuration settings for the specified
transponder.
Input Format
RTRV-XPDR:[TID]:[<aid>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
AID
Input Examples
RTRV-XPDR:TID:1-4-2:77;
Output Format
Output Parameters
aid
AID
aid is a string.
manualdatalockrate
MANUALDATALOCKRATE
manualdatalockrate is a string.
autoratelocking
AUTORATELOCKING
autoratelocking is of type EnabledDisabled on page 2-36.
expectedrxbitrate
EXPECTEDRXBITRATE
expectedrxbitrate is a string.
fastfaultprop
FASTFAULTPROP
fastfaultprop is of type EnabledDisabled on page 2-36.
Output Example
RTRV-MXP
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve the configuration settings for the specified
muxponder.
Input Format
RTRV-MXP:[TID]:[<aid>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
AID
aid is the AID AllTranspondersIncAll on page 2-28. Three-part muxponder AID.
(1-3-1)
Input Example
RTRV-MXP:Node198:1-4-2:78;
Output Format
Output Parameters
aid
aid is the AID AllMuxponders.
numberofclientportsnumberofclientports
is a integer. numberofclientports is optional.
networkmanualdatalockrate
networkmanualdatalockrate is a string. networkmanualdatalockrate is optional.
client1manualdatalockrate
client1manualdatalockrate is a string. client1manualdatalockrate is optional.
client2manualdatalockrate
client2manualdatalockrate is a string. client2manualdatalockrate is optional.
client3manualdatalockrate
client3manualdatalockrate is a string. client3manualdatalockrate is optional.
autoratelocking
AUTORATELOCKING autoratelocking is of type EnabledDisabled.
fastfaultprop
FASTFAULTPROP fastfaultprop is of type EnabledDisabled.
trafficmode
TRAFFICMODE trafficmode is of type TrafficMode.
Output Example
RTRV-OCHC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
RTRV-OCHC:[TID]:[<src>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
Access identifier that identifies the wavelength channel for which the command is
intended.
src is the AID AllChannelsIncAll and is listable and rangeable.
Input Example
RTRV-OCHC:Node198:ALL:84;
Output Format
Output Parameters
aid
Access identifier of the wavelength channel.
aid is a string.
id
Customer configurable identifier for the wavelength channel.
id is a string. id is optional.
wavelength
Wavelength specification in nanometers.
wavelength is a string. wavelength is optional.
outputpwrtarget
Output power target level in dBm.
outputpwrtarget is a string. outputpwrtarget is optional.
actualpwr
Actual output power in dBm.
actualpwr is a string. actualpwr is optional.
attenuation
Current attenuation in dB.
attenuation is a string. attenuation is optional.
fromport
The port from which wavelength channel connection is added. All connections
terminate to port 1 or the common port. fromport is the AID AllSlotsAndPorts on
page 2-25. fromport is optional.
estinputpwr
estinputpwr is a string. estinputpwr is optional.
minrecoutpwr
minrecoutpwr is a string. minrecoutpwr is optional.
pstpstq
Primary state-Primary State Qualifier, i.e. {IS|OOS}-{NR|AU|MA|AUMA}
pstpstq is of type PrimaryState on page 2-43.
sst
Secondary state. sst is of type Secondary State on page 2-48 and is listable. sst is
optional.
Output Example
SET-ATTR-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs an NE to set the notification code associated with the specified condition
type. Only standing conditions can be assigned alarmed notification codes (CR,
MJ or MN), however they can also be made non-alarmed. Transient conditions
can only be non-alarmed (i.e., NA or NR).
Input Format
SET-ATTR-OCH:[TID]:<aid>:CTAG::[<ntfcncde>],<condtype>,,,;
Input Parameters
id
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
Access identifier of the target module or port.
aid is the AID AllPorts on page 2-23.
ntfcncde
The notification code to be assigned to the specified condition. A null defaults to
NA.
ntfcncde is of type NotificationCode on page 2-41. The default value is "NA".
condtype
The type of event for whose notification code is to be changed. A null value will cause
notification attributes for all event types matching <aid> to be set.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
input Example
SET-ATTR-OCH:TID:3-8-2-2:85::MN, LOS,,,;
SET-ATTR-OCHC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs an NE to set the notification code associated with the specified condition
type. Only standing conditions can be assigned alarmed notification codes (CR,
MJ or MN), however they can also be made non-alarmed. Transient conditions
can only be non-alarmed (i.e., NA or NR).
Input Format
SET-ATTR-OCHC:[TID]:<aid>:CTAG::[<ntfcncde>],<condtype>,,,;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
AID
aid is the AID AllChannels on page 2-21.
ntfcncde
The notification code to be assigned to the specified condition. A null defaults to
NA.
ntfcncde is of type NotificationCode on page 2-41. The default value is "NA".
condtype
The type of event for whose notification code is to be changed. A null value will cause
notification attributes for all event types matching <aid> to be set.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-ATTR-OCHC:Node198:1-1-ALL:85::MJ, BITRATEMIS,,, ;
SET-ATTR-OSC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs an NE to set the notification code associated with the specified condition
type. Only standing conditions can be assigned alarmed notification codes (CR,
Input Format
SET-ATTR-OSC:[TID]:<aid>:CTAG::[<ntfcncde>],<condtype>,,,;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
AID
aid is the AID AllPorts on page 2-23.
ntfcncde
The notification code to be assigned to the specified condition. A null defaults to
NA.
ntfcncde is of type NotificationCode on page 2-41. The default value is "NA".
condtype
The type of event for whose notification code is to be changed. A null value will cause
notification attributes for all event types matching <aid> to be set.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-ATTR-OSC:TID:3-8-2-2:86::MJ, LOL,,,
;
SET-TRAFFICMODE
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to set the traffic mode of the WRT-740, WRT-781 and
WRT-8xx modules.
All ports, client and network, must be out of service (OOS-MA) as well as the
module must be OOS-MA prior to attempting to SET-TRAFFICMODE.
SET-TRAFFICMODE shall reject the request if this condition is not met. A
SET-TRAFFICMODE command will initiate a COLD restart of the module
It is important to note that the following WRT-852 traffic modes do not support a
supervisory channel. If a remote (or far-end) module is switched to one of the
following traffic modes (via a supervisory channel) the existing supervisory
channel will be disabled, a new supervisory channels can not be opened, and
therefore the traffic mode (and other configuration parameters) can not be
subsequently changed:
• Transponder
• Regenerator
• Dual Regenerator
• Regenerator (OC-192/STM-64/10GE WAN over OTN)
• Regenerator (10 GE LAN over OTN)
Input Format
SET-TRAFFICMODE:[TID]:<aid>:CTAG::<trafficmode>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
AID
aid is the AID AllSlotsAndTransponders on page 2-26.
trafficmode
TRAFFICMODE
Input Example
SET-TRAFFICMODE:Node198:1-12:87::2RREGENERATOR;
COPY-BACKUP
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to copy a backup file from the NE to a specified location.
NOTE: The backup file must exist on the NE for this command to work. Issue the
INIT-BACKUP and OPR-BACKUP commands to create the backup file on the NE, if one
does not exist already.
Input Format
COPY-BACKUP:[TID]:[<src>]:CTAG::URLTYPE=<urltype>,
URL=<url>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
This is the NE AID.
src is the AID ALL on page 2-19.
urltype
URLTYPE is a string with a value of "FTP".
urltype is a string.
url
This parameter is a fully qualified FTP URL describing where the file is to be copied.
It includes the username, password, server, port, path, and filename such as
"ftp://[<userid>[:<password>]@]<ftphost>[:<port>]/<urlpath>"
url is a string.
Input Examples
COPY-BACKUP:Node198:E-1-ALL:100::FTP,ftp://Smith99:Pa$8wrd@h
ostsitename:18/www.yourwebsite.com;
INIT-BACKUP
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to delete the backup file stored on the NE.
NOTE: Issue the INIT-BACKUP command before issuing an OPR-BACKUP command,
otherwise the backup will fail. The only time this is not true is when a backup has never been
done.
NOTE:To keep a copy of the backup file before deleting it, issue the COPY-BACKUP
command prior to the INIT-BACKUP.
Input Format
INIT-BACKUP:[TID]:[<src>]:CTAG::;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
This is the NE AID.
src is the AID ALL on page 2-19.
Input Example
INIT-BACKUP:Node198:E-1-ALL:100::<null>;
OPR-BACKUP
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to trigger a backup. The system backs up the entire NE into a
single backup file which is stored on the NE.
NOTE: The OPR-BACKUP command is not acknowledged when issued. When the backup
finishes the system sends a BACKUP_CMD_ CMPLT autonomous event message to report
the status.
NOTE: When the OPR-BACKUP command completes, issue a COPY-BACKUP command to
copy the backup file to another location.
NOTE: The Backup will only work on a subtending NE if the subtending NE has an active
Ethernet connection (for FTP access by the operator).
note: See REPT EVT <SCCMNOALL> on page 11-2 for a more detailed explanation of the
autonomous message response.
Precautions
Input Format
OPR-BACKUP:[TID]:[<src>]:CTAG::;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
AID
src is the AID ALL on page 2-19.
Input Example
OPR-BACKUP:Node198:E-1-ALL:100::<null>;
RST-BACKUP
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to restore configuration data from a backup file, to one or more
modules in the shelf. The file is retrieved through FTP using the URL provided.
NOTE: The system sends a RESTORE_CMD_ CMPLT event message to indicate the status
when the restoration has completed.
Requirements
These are the restrictions and requirements for restoring configuration data to one
or more modules in the Node:
• The restore is performed by user-request only.
• To restore any entity in the NE, the software version of the COM-200 controller
must be exactly the same as the one that was backed up.
• The software version of each module being restored must match the one that
was backed up.
• The module being restored to must be installed in the same slot in the
WaveReady shelf as the module that was backed up.
• The System ID must match the System ID that was in use when the backup file
was created. If the current System ID does not match the backup, change it (see
SET-SID on page 4-20), perform the data restore, and then change it back.
NOTE: Every system identifier must be unique within a managed network.
• The backup files are CRC protected and a corrupted backup file will be rejected at
restore.
• The restore will only work on a subtending NE if the subtending NE has an active
Ethernet connection (for FTP access by the operator).
Precautions
Input Format
RST-BACKUP:[TID]:[<src>]:CTAG::URLTYPE=<urltype>, URL=<url>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
ALL or a specific card.
src is the AID AllSlotsIncALL on page 2-26.
urltype
URLTYPE is a string with a value of "FTP".
urltype is a string.
url
Only required if the URLTYPE is FTP. This parameter is a fully qualified FTP URL
describing where the backup file is residing. It includes the username, password,
server, port, path, and filename such as "ftp://[<userid>[:<pass-
word>]@]<ftphost>[:<port>]/<urlpath>"
url is a string.
Input Examples
RST-BACKUP:Node198:E-1-ALL:100::URLTYPE=FTP,
URL=ftp://Smith99:Pa$8wrd@hostsitename:18/www.yourwebsite.co
m;
RTRV-BACKUP
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve the available backup files from the NE.
Input Format
RTRV-BACKUP:[TID]:[<src>]:CTAG::;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
AID.
src is the AID ALL on page 2-19
Input Example
RTRV-BACKUP:Node198:3-4-2-2:100::;
Output Format
Output Parameters
backupfile
Name of the backup file.
backupfile is a string.
size
Size of the backup file, in bytes.
size is a integer.
Output Examples
RTRV-BACKUP-STAT
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve the backup or restore status for individual modules
or the entire NE.
Input Format
RTRV-BACKUP-STAT:[TID]:[<src>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
AID
src is the AID ALL on page 2-19.
Input Example
RTRV-BACKUP-STAT:Node198:E-1-ALL:100;
Output Format
Output Parameters
status
Current status of the backup and restore.
status is of type BackUpState on page 2-33.
Output Examples
RTRV-UPGRD-STAT
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
Use this command to retrieve software load tags for the active and inactive (boot)
banks on the module, and information about which bank is active. This assists in
determining whether the active and inactive banks are synchronized.
NOTE: WRT-7xx modules only support one boot load and a preferred bank instead of an
active bank. If the preferred bank is corrupted, the module boots to the other bank. A subse-
quent RTRV-UPGRD-STAT command to the WRT-7xx will respond with an active bank
pointing to the corrupted bank.
NOTE: The LightAmp, BrightAmp and LP530 modules are not upgradeable and do not
support the use of the RTRV-UPGRD-STAT command.
Input Format
RTRV-UPGRD-STAT:[TID]:[<src>]:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
src
Access identifier of the target module. A null or "All" value can be used to indicate
all equipment units installed in the WaveReady™ series shelf.
src is the AID AllSlotsIncALL on page 2-26.
Input Examples
RTRV-UPGRD-STAT:Node198:1-C:100;
Output Format
Output Parameters
aid
AID for the requested equipment.
aid is a string.
status
Indicates the upgrade status of the card. On a WRA-XXX card: if the ppc 405
AND/OR the EDFA are upgrading, the status is "BUSY" - otherwise it is "OK".
status is of type UpGradeStatus on page 2-55.
apploadtaga
Application load name in bank A.
apploadtaga is a string.
apploadtagb
Application load name in bank B.
apploadtagb is a string.
bootloadtaga
Boot load name in bank A.
bootloadtaga is a string. bootloadtaga is optional.
bootloadtagb
Boot load name in bank B.
bootloadtagb is a string. bootloadtagb is optional.
activebank
Indicates which is the active bank. For the COM-200, WRT840 and WRA-XXX, this
indicates the bank currently booted. For the WRT7xx cards, this indicates the bank
from which the load will boot in the next reset.
activebank is of type BankSpecifier on page 2-34.
edfaloadtaga
For WRA-XXX card. EDFA load in bank A.
edfaloadtaga is a string. edfaloadtaga is optional. edfaloadtagb For WRA-XXX card.
EDFA load in bank B. edfaloadtagb is a string. edfaloadtagb is optional.
edfaactivebank
For WRA-XXX card. Indicates which is the active bank of the EDFA.
edfaactivebank is of type BankSpecifier on page 2-34. edfaactivebank is optional.
emod1loadtaga
For embedded modules. Software load in bank A.
emod1loadtaga is a string. emod1loadtaga is optional.
emod1loadtagb
For embedded modules. Software load in bank B.
emod1loadtagb is a string. emod1loadtagb is optional.
emod1activebank
For embedded modules. Current active bank.
emod1activebank is of type BankSpecifier. emod1activebank is optional.
Output Example
ED-SWBASELINE
This command requires a Security and Administration Level 4 User Access
Privilege.
Description
Use this command to edit the software load baseline of the system. The
LOADMISMATCH alarm is generated when the actual software load on a card
does not match what is indicated in this software load baseline.
Input Format
ED-SWBASELINE:[TID]::CTAG::CARDTYPE=<cardtype>,
[APPLOADTAG=<apploadtag>],[BOOTLOADTAG=<bootloadtag>],
[EDFALOADTAG=<edfaloadtag>],[EMOD1LOADTAG=<emod1loadtag>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
cardtype
Indicates the card type as displayed in the RTRV-INV or RTRV-EQPT command.
cardtype is of type CardTypes.
apploadtag
Indicates the software application load as displayed by the RTRV-INV or
RTRV-EQPT command. apploadtag is a string.
bootloadtag
Indicates the software boot load as displayed by the RTRV-EQPT command. boot-
loadtag is a string.
edfaloadtag
For WRA-XXX cards. Indicates the software EDFA load as displayed by the
RTRV-EQPT command. edfaloadtag is a string.
emod1loadtag
EMOD1LOADTAG emod1loadtag is a string.
Input Example
ED-SWBASELINE:Node198::100::CARDTYPE=COMM200,
APPLOADTAG=16B,BOOTLOADTAG=16A,
EDFALOADTAG=15B,EMOD1LOADTAG=15A;
RTRV-SWBASELINE
This command requires a Security and Administration Level 1 User Access
Privilege.
Description
Use this command to retrieve the software load baseline of the system. The
LOADMISMATCH alarm is generated when the actual software load on a card
does not match what is indicated in this software load baseline.
Input Format
RTRV-SWBASELINE:[TID]::CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
Input Example
RTRV-SWBASELINE:Node198::100;
Output Format
Output Parameter
cardtype
Indicates the card type as displayed in the RTRV-INV or RTRV-EQPT command.
cardtype is of type CardTypes.
apploadtag
Indicates the software application load as displayed by the RTRV-INV or
RTRV-EQPT command. apploadtag is a string.
bootloadtag
Indicates the software boot load as displayed by the RTRV-EQPT command. boot-
loadtag is a string. bootloadtag is optional.
edfaloadtag
EDFALOADTAG edfaloadtag is a string. edfaloadtag is optional.
emod1loadtag
EMOD1LOADTAG emod1loadtag is a string. emod1loadtag is optional.
Output Example
COPY-RFILE
This command requires a Security and Administration Level 4 User Access
Privilege.
Description
used after a software download to synchronize the software load from the active to
the inactive bank of a module or modules in a node.
NOTE: To synchronize the software load directly from the module’s active bank to its inactive
bank, for the COM-200, WRT-840, WRT-842, and WRA-1xx/217 modules, use the
COPY-RFILE command with the TYPE parameter BANKCOPY. For the WRT-740/760, the
software load cannot be synchronized directly from the module's active bank. Issue the
COPY-RFILE command twice using the software download syntax.
NOTE: Issue the INIT-SYS command following a successful software download to enable the
new file to be used.
NOTE: WRA-1xx/217 modules also support download of the amplifier EDFA load.
NOTE:The LightAmp, BrightAmp and LP530 modules do not support the COPY-RFILE
command.
Input Format
COPY-RFILE:[TID]:<aid>:CTAG::TYPE=<xfertype>,SRC=<srcurl>,DE
ST=<desturl>, [FTPMODE=<ftpmode>],,[FTTD=<fttd>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
The module to which the software is being downloaded. Null and ‘All’ are invalid in
this case.
aid is the AID AllSlots on page 2-24.
xfertype
SWDL is used for software that is transferred directly to a WaveReady module’s APP
or BOOT target locations. Null is not a valid value.
xfertype is of type XferType on page 2-55.
srcurl
{<ftp>|MEMORY} = Location of file to transfer.
desturl
{BOOT|APP|MEMORY|EDFA} = Location of file to transfer. Valid destinations are:
• BOOT Usage: Supported by all NRP modules. The boot software for the NRP
Module
• APP Usage: Supported by all NRP Modules.
• MEMORY Usage: Supported by the CM only. This is an extra memory loca-
tion within the CM for file caching (i.e. in a multi-module software upgrade
scenario).
• EDFA Usage: supported by the WRA card only. Indicates the EDFA load.
desturl is a string.
ftpmode
Indicates where the NE should use active (PORT) or passive (PASV) mode FTP to
retrieve the file.
ftpmode is of type FtpMode on page 2-36. fttd Not used. fttd is a string.
Input Examples
COPY-RFILE:Node198:1-C:100::BANKCOPY,LUMOS,LUMOS,ACTIVE,
<null>,LUMOS;
INIT-LOG
This command requires a Maintenance Level 4 User Access Privilege.
Description
This command instructs the target module to clear the contents of the specified
log.
Input Format
INIT-LOG:[TID]:[<aid>]:CTAG::<lognm>,;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
Access identifier that identifies the NRP module(s) for which the command is
intended.
aid is the AID COMM on page 2-29.
lognm
Name of the log to clear. Acceptable value depends on the target module. Only the
COM-200 has a Security log.
lognm is of type LogName on page 2-37.
Input Example
INIT-LOG:Node198:1-C:100::ALARMLOG,;
RTRV-LOG
This command requires a Maintenance Level 1 User Access Privilege.
Description
This command instructs the target module to return the contents of a log.
NOTE: The condition type "database change" (DBCHG) indicates when a configuration
change has taken place. The log only appears for specific modules and specific database
changes.
Input Format
RTRV-LOG:[TID]:[<aid>]:CTAG::<lognm>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed
ctag
Correlation tag
aid
Access identifier that identifies the NRP module for which the command is
intended.
aid is the AID AllSlots on page 2-24.
lognm
Name of the log to retrieve. Acceptable value depends on the target module. Only the
COM-200 has a Security log.
lognm is of type LogName on page 2-37.
Input Example
RTRV-LOG:Node198:1-C:100::UPGRDLOG;
If <Lognm> is ALARMLOG, <log entries> has the following format:
<aid>:<ntfcncde>,<condtype>,<condeff>,<srveff>,<ocrdat>,<ocrtm>,:<conddesc
r><cr><lf>
If <Lognm> is SECULOG, <log entries> has the following format:
<aid>:<ntfcncde>,<secualmtype>,<ntfcntype>,<ocrdat>,<ocrtm>:<con
ddescr><cr><lf>
NOTE: The first <log entries> block does not contain any spaces. Subsequent <log entries>
blocks begin with five spaces ("^^^^^") for alignment. The last <log entries> block that is
returned does NOT include <cr><lf> at the end.
NOTE: An event log that returns the <condition type> DBCHG indicates that a configuration
change has taken place. The type of configuration change is described by <conddescr>. This
log only appears for specific modules and specific database changes.
Output Example
TID TIMESTAMP
M CTAG COMPLD
"UPGRDLOG"
/*
A-1:,BANKCOPYFAIL,,03-11,16-53-36,,:\"Bank Copy
Fail\":APPLOADTAGA= R4.6.3.022, APPLOADTAGB=R4.6.3.022,
BOOTLOADTAGA= R4.6.3.022, BOOTLOADTAGB=R4.6.3.022,
ACTIVEBANK=BANKB, EMOD1LOADTAGA=R1.0.0.014,
EMOD1LOADTAGB=R1.0.0.144, EMOD1ACTIVEBANK=BANKB:DEST=STANDBY
A-1:,SWDL,,03-11,14-39-06,,:/"Software download was
successful.\":EMOD1LOADTAGB =Unreadable
Version:TARGETLOADTAG=R1.0.0.144, DEST=EMOD1
A-1:,SWDLSTART,,03-11,16-38-24,,:\"Software download
started.\": APPLOADTAGA= R4.5.4.015, APPLOADTAGB=R4.6.3.022,
BOOTLOADTAGA=R4.5.4.015, BOOTLOADTAGB=R4.6.3.022,
ACTIVEBANK=BANKB, EMOD1LOADTAGA=R1.0.0.014,
EMOD1LOADTAGB=R1.0.0.014,
EMOD1ACTIVEBANK=BANKA:TARGETLOADTAG=R1.0.0.144, DEST=EMOD
1-C:,SWDL,,03-11,16-35-12,,:\"Software download was
successful.\"::DEST=MEMORY
1-C:SWDLFAIL,,03-11,16-32-06,,:\"Software download was
unsuccessful. FTP communication failure.\"::DEST=MEMORY
A-1:, SWDLFAIL,,03-11,16-30-54,,:\"Software download was
unsuccessful. Source memory image not
available.\"::DEST=EMOD1
1-C:NR,UPGRDLOGCLR,TC, NSA,03-11,13-29-49,,:LOG_CLEARED
*/
INIT-REG
The following commands require a Performance Monitoring Level 4User Access
Privilege.
Description
Use the following commands to initialize monitor counts for the target of the
specified secondary command.
Initialize Register SCCM_PM instructs the PM system to initialize monitor counts
for the specified SCCM to 0.
Input Format
INIT-REG-[SCCM]:[TID]:<src>:CTAG::<skipped>;
Input Parameters
SCCM
Secondary command. Specifies the traffic protocol to be monitored. Variables are:
OTN
OCN
ETHERNET
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag.
src
AID src is the AID.AllPorts on page 2-23 .
Input Example
INIT-REG-OTN:Node198:3-3-1-2:81::;
INIT-REG-OCN:Node198:3-3-1-2:82::;
INIT-REG-ETHERNET:Node198:3-3-1-2:83::;
Output Format
Output Example
RTRV-PM
The following commands require a Performance Monitoring Level 4 User Access
Privilege.
Description
Use these commands to retrieve performance monitoring data for the target of the
specified secondary command.
Input Example
RTRV-PM-[SCCM]:[TID]:<src>:CTAG::<SKIPPED>;
Input Parameters
SCCM
Secondary command. Specifies the traffic protocol to be monitored. Variables are:
ALL
OTN
OCN
ETHERNET
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag.
src
Access identifier of the target optical port. src is the AID.AllPorts on page 2-23
Input Examples
RTRV-PM-ALL:Node198:1-12-2:84::;
RTRV-PM-ETHERNET:Node198:3-7-1-2-F-1-2:85::;
RTRV-PM-OCN:Node198:3-7-1-2-F-1-2:86::;
RTRV-PM-OTN:Node198:3-7-1-2-F-1-2:87::;
Output Format
Output Parameters
aid
Identifies the entity in the NE to which the command pertains. aid is a string.
sccm
Specifies the facility (or sub-entity) to which the command pertains. sccm is of type.
SCCM_PM on page 2-47
montype
Monitored type or counter. montype is of type.MonitorType on page 2-38
monvall
The value to which the register identified by montype is to be initialized to or the
measured value of a monitored parameter. The value is in the form of numeric
counts or rates. monvall is a string.
vldty
Indicates whether the information for the specified time period was accumulated
over the entire time period or some portion thereof. vldty is of type.PMValidity on
page 2-42
locn
The location associated with a particular command. locn is of type.LocationType on
page 2-37
dirn
The direction relative to the entity defined in the "aid" field. dirn is of type.Dirn on
page 2-35
tmper
The accumulation period for performance counters. tmper is of type.TimePeriod on
page 2-53
mondat
The beginning date of the PM or storage register period specified in tmper. The
format is MM-DD. mondat is a string.
montm
The beginning time of day of the PM or storage register period specified in tmper.
The format is HH-MM. montm is a string.
Output Example
RTRV-PMMODE
These commands require a Performance Monitoring Level 4 User Access Privilege.
Description
These commands return the current status of the PM subsystems for the target of
the specified secondary command.
There are 3 possible modifiers for each port, OCN, ETHERNET, and OTN and
each have their own activation option for UNTIMED collection. The default is for
collection to be OFF.
Input Format
RTRV-PMMODE-[SCCM]:[TID]:<src>:CTAG::<skipped>;
Input Parameters
SCCM
Secondary command. Specifies the traffic protocol to be monitored. Variables are:
ALL
OTN
OCN
ETHERNET
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed. .
ctag
Correlation tag
src
AID src is the AID.AllPortsIncALL on page 2-24
Input Example
RTRV-PMMODE-ALL:Node198:ALL:88::;
RTRV-PMMODE-ETHERNET:Node198:1-4-2:89::;
RTRV-PMMODE-OCN:Node198:ALL:100::;
RTRV-PMMODE-OTN:Node198:ALL:100::;
Output Format
"<aid>,<sccm>:<montype>,<monvall>,<vldty>,<locn>,<dirn>,<tmp
er>,<mondat>,<montm>"
;
Output Parameters
aid
Identifies the entity in the NE to which the command pertains. aid is a string..
sccm
Specifies the facility (or sub-entity) to which the command pertains. sccm is of type
SCCM_PM.
untimedcol
Parameter indicates whether UNTIMED bin collection is currently accumulating.
untimedcol is of type.OnOff on page 2-42
Output Example
SET-PMMODE
These commands require a Performance Monitoring Level 4 User Access
Privilege.
Description
Use these commands to set the performance mode for the target of the specified
secondary command.
Instructs the PM subsystem to set the mode of PM data collection.
Input format
SET-PMMODE-[SCCM]:[TID]:<src>:CTAG::<untimedbin>;
Input Parameters
SCCM
Secondary command. Specifies the traffic protocol to be monitored. Variables are:
OTN
OCN
ETHERNET
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
src
AID src is the AID.AllPorts on page 2-23
untimedbin
Parameter indicates to start or stop UNTIMED bin collection. untimedbin is of
type.OnOff on page 2-42
Input Example
SET-PMMODE-OTN:Node198:1-8-2-2-F-1-1:100::OFF;
SET-PMMODE-OCN:Node198:1-8-2-2:99::UNTIMEDBIN=OFF;
SET-PMMODE-ETHERNET:Node198:1-8-2-2:100::UNTIMEDBIN=OFF;
Output Format
Output Example
DLT-FFP-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
DLT-FFP-OCH:[TID]:<aid>:CTAG:::;
Input Parameter
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of either the working or protecting port on the card where a facility
protection group is to be deleted.
aid is the AID AllNetworkPorts on page 2-23.
Input Example
DLT-FFP-OCH:Node198:2-8-1-2:100:::;
ED-FFP-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
ED-FFP-OCH:[TID]:<aid>:CTAG:::[PROTNAME=<protname>],
[RVRTV=<rvrtv>], [RVTM=<rvtm>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of either the working or protecting port on the card where a facility
protection group is to be modified.
aid is the AID AllNetworkPorts on page 2-23.
protname
Name of the protection group. String, 32 characters max.
protname is a string.
rvrtv
Integer identifying whether or not revertive mode is active. Valid values are:
rvtm
Identifies the revertive time-out (aka ‘wait to restore’ time) in seconds. Valid range
is 5 to 1000.
rvtm is a integer.
Input Example
ED-FFP-OCH:Node198:3-1-2-2:100::<null>:PROTNAME=LUMOS,
RVRTV=1,RVTM=1;
ENT-FFP-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
ENT-FFP-OCH:[TID]:<aid>:CTAG:::WORKID=<workid>,
PROTID=<protid>, [PROTNAME=<protname>], [RVRTV=<rvrtv>],
[RVTM=<rvtm>];
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of either the working or protecting port on the card where a facility
protection group is to be created.
aid is the AID AllNetworkPorts on page 2-23.
workid
Port number of the working interface. Must refer to a network-facing optical port on
a card. NOTE: This refers to the port number only and not the full AID of the port.
workid is a integer.
protid
Port number of the protecting interface. Must refer to a network-facing optical port
on a card. NOTE: This refers to the port number only and not the full AID of the
port.
protid is a integer.
protname
Name of the protection group. String, 32 characters max. Default is empty string.
protname is a string.
rvrtv
Integer identifying whether or not revertive mode is active. Valid values are:
0: Revertive mode is off.
1: Revertive mode is on.
rvrtv is a integer.
rvtm
Identifies the revertive time-out (aka ‘wait to restore’ time) in seconds. Valid range
is 5 to 1000. The factory default value is 300.
rvtm is a integer. The default value is "300".
Input Examples
ENT-FFP-OCH:Node198:3-1-1-2:100::<null>:WORKID=1,
PROTID=1,PROTNAME=LUMOS,RVRTV=1, RVTM=1;
OPR-PROTNSW-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to instruct the protection switch to perform one of the
following functions:
• Perform a forced switch to the protection path only if the alternate path is
operational
• Perform a forced switch to the working path unless it is locked out
• Enter lockout mode without switching paths, effectively disabling APS
Input Format
OPR-PROTNSW-OCH:[TID]:<aid>:CTAG::<sc>:;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the port for which the command is intended.
aid is the AID AllPorts on page 2-23.
sc
Represents the switch command to be initiated.
FRCD - Causes the unit to switch to the alternate line and enter manual mode. A
WRT-760 will deny a request of forced switch if the AID identifies a working line
(i.e., switching to protection line) and a protection line has failed. However, the card
will accept a forced switch back to a failed working line.
LOCKOUT - Causes the unit to enter manual mode with service switched away from
the protection line.
If the AID specifies a WRT-760 protecting interface: The working interface will be
inhibited from switching to the specified protection interface.
Switching requests (i.e., OPR-PROTNSW with the sc parameter FRCD) are rejected
unless a RLS-PROTNSW command is executed.
For FRCD and LOCKOUT switch commands, automatic protection switching is
disabled and the unit that the AID identifies remains in manual mode until an
RLS-PROTNSW command is received. While a switch command is active, subse-
quent OPR-PROTNSW commands with higher priority may be executed.
sc is of type SwitchType on page 2-52.
Input Example
OPR-PROTNSW-OCH:Node198:1-11-1-1:100::FRCD:<null>;
RLS-PROTNSW-OCH
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
RLS-PROTNSW-OCH:[TID]:<aid>:CTAG::;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the port for which the command is intended.
aid is the AID AllPorts on page 2-23
Input Example
RLS-PROTNSW-OCH:Node198:1-11-1-1:100::<null>;
RTRV-FFP-OCH
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve the attributes of the specified facility protection
group.
Input Format
RTRV-FFP-OCH:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of either the working or protecting port on the card where a facility
protection group is to be modified.
aid is the AID AllNetworkPorts on page 2-23.
Input Examples
RTRV-FFP-OCH:Node198:2-12-1-2:100;
Output Format
Output Parameters
aid
Access identifier of the working interface.
aid is a string.
workid
Port number of the working interface. Must refer to a network-facing optical port on
a card. NOTE: This refers to the port number only and not the full AID of the port.
workid is a integer.
protid
Port number of the protecting interface. Must refer to a network-facing optical port
on a card. NOTE: This refers to the port number only and not the full AID of the
port.
protid is a integer.
protname
Name of the protection group. String, 32 characters max. The default is null.
protname is a string.
rvrtv
Integer identifying whether or not revertive mode is active. Valid values are:
0: Revertive mode is off.
1: Revertive mode is on.
rvrtv is a integer.
rvtm
Identifies the revertive time-out (aka ‘wait to restore’ time) in seconds. Valid range
is 5 to 1000.
rvtm is a integer.
sc
Switch command currently in effect.
activeid
Port number of the active port. Refers to a network-facing port. NOTE: This refers
to the port number only and not the full AID of the port.
activeid is a integer.
Output Example
RTRV-PROTNSW-OCH
This command requires a Provisioning Level 1 User Access Privilege.
Description
Use this command to retrieve the switching command that is currently in effect on
the specified interface.
Input Format
RTRV-PROTNSW-OCH:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of either the working or protecting port on the card where a facility
protection group is to be modified.
aid is the AID AllNetworkPorts on page 2-23.
Input Example
RTRV-PROTNSW-OCH:Node198:3-7-1-2:100;
Output Format
Output Parameters
aid
Access identifier that identifies the optical port to which the command applies.
aid is a string.
swtype
The type of protection switching command that is currently in effect. Valid values
are:
NONE:
No switch command is in effect on the specified interface.
swtype is of type SwitchType on page 2-52. swtype is optional.
Output Example
"1-2:
FRCD"
;
ALW-MSG-ALL
This command requires a Maintenance Level 4 User Access Privilege.
Description
Input Format
ALW-MSG-ALL:[TID]:[<aid>]:CTAG::,<condtype>,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the target module for which the command is
intended. A null value or ‘All’ for <aid> is used to indicate all units currently
installed in the shelf.
aid is the AID ALL on page 2-19.
condtype
The type of event for which automatic reporting is to be allowed. A null value will
cause all messages specified, regardless of event type to be allowed.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
ALW-MSG-ALL:Node198:E-1-ALL:56::,ABS-SW-THRESHOLD-CHANGED,;
INH-MSG-ALL
This command requires a Maintenance Level 4 User Access Privilege.
Description
Input Format
INH-MSG-ALL:[TID]:[<aid>]:CTAG::,<condtype>,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the target module for which the command is
intended. A null value or ‘All’ for <aid> is used to indicate all units currently
installed in the shelf.
condtype
The type of event for which automatic reporting is to be inhibited. A null value will
cause all messages specified, regardless of event type to be inhibited.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
INH-MSG-ALL:Node198:2-11-1-2:56::, ABS-SW-THRESHOLD-CHANGED,;
OPR-ACO-ALL
This command requires a Maintenance Level 1 User Access Privilege.
Description
Use this command to turn off the audible alarm by opening the alarm relay
contacts in the COM-200. The alarm cut-off (ACO) function relates to alarm
relays only. Front panel LEDs, and status information that is accessible through
TL1 commands, are not affected.
The OPR-ACO-ALL command acknowledges existing conditions that are
contributing to an alarm relay closure. If the ACO button is pressed, the relays
remain open until a new alarm condition occurs. If an alarm condition that was
cut-off is cleared and then recurs, this constitutes a new alarm and the relays close
again. There is no time-out or disable associated with the ACO.
NOTE: Audible alarms are cut off until the alarm condition is cleared.
Input Format
OPR-ACO-ALL:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target COM-200. "1-C"’ is the only acceptable value. Only the
Communications module supports this command, which is the equivalent of
pushing the ACO button on the front panel of the Communications module.
aid is the AID COMM on page 2-29.
Input Example
OPR-ACO-ALL:Node198:1-C:56;
REPT-ALM-COM
REPT-ALM-EQPT
REPT-ALM-OCH
REPT-ALM-OCHC
REPT-ALM-OSC
Description
REPT-EVT-COM
REPT-EVT-EQPT
REPT-EVT-OCH
REPT-EVT-OCHC
REPT-EVT-OSC
Description
The COM-200 generates this autonomous message when a TL1 session is initiated.
Two non-alarmed events can trigger this message:
• A user requests a session with the COM-200.
• The module is required to send an advisory warning message (regarding
unauthorized entry/use) before granting system access to the user.
NOTE: If the module allows a grace period during which the user can continue to use
the password, this information is included in the message.
Output Format
Output Parameters
aid
Value is always null. This message can only originate from the Communications
module.
aid is a string.
exp
Indicates the status of the user’s password.
pcn
This parameter appears only if
Under
these conditions, the <pcn> parameter shows the number of days remaining during
which the existing password is valid. Refer to GR-835-CORE.
pcn is a string. pcn is optional.
Output Example
RTRV-ALM-<SCCM_COMEQPT>
RTRV-ALM-COM
Description
Input Format
RTRV-ALM-COM:[TID]:<aid>:CTAG::<ntfcncde>,<condtype>,<srveff
>, <skipped1>, <skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
aid is the AID AllSlotsIncALL on page 2-26
.
ntfcncde
ntfcncde is of type NotificationCode on page 2-41 . [CR, MJ, MN]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
srveff is of type Service Effect on page 2-51
Input Example
RTRV-ALM-COM:Node198:1-C:56::CL, ABS-SW-THRESHOLD-CHANGED,
NSA,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
ocrdat
ocrdat is a string.
ocrtm
ocrtm is a string.
conddescr
conddescr is a string.
Output Example
RTRV-ALM-EQPT
Description
Input Format
RTRV-ALM-EQPT:[TID]:<aid>:CTAG::<ntfcncde>,<condtype>,
<srveff>,<skipped1>,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
Input Example
RTRV-ALM-EQPT:Node198:1-C:56::CL,
ABS-SW-THRESHOLD-CHANGED,NSA,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_COMEQPT on page 2-46
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
srveff is of type Service Effect on page 2-51.
ocrdat
ocrdat is a string.
ocrtm
ocrtm is a string.
conddescr
conddescr is a string.
Output Example
RTRV-ALM-ALL
This command requires a Maintenance Level 1 User Access Privilege.
Description
This command instructs the target module to return a list of the current alarm
conditions associated with the specified equipment unit(s) or port(s).
Alarm conditions to retrieve can be specified by using input parameters as filters.
Input Format
RTRV-ALM-ALL:[TID]:[<aid>]:CTAG::[<ntfcncde>],
[<condtype>],[<srveff>],,,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the target module for which the command is
intended. A null value or ‘All’ for <aid> may be used to indicate all units currently
installed in the shelf.
aid is the AID ALL on page 2-19.
ntfcncde
A null defaults to all applicable notification codes.
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN]
condtype
A null defaults to all applicable condition types with the severity CR, MJ or MN.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
A null defaults to all applicable service affect types.
srveff is of type Service Effect on page 2-51.
Input Examples
RTRV-ALM-ALL:Node198:1-10-1-2:56::CL,
ABS-SW-THRESHOLD-CHANGED,NSA,,, ;
Output Format
^^^"<aid>,<aidtype>:<ntfcncde>,<condtype>,<srvell>,<ocrdat>,
<ocrtm>,,:<conddescr>,"<cr><lf>
;
One <rspblk> is returned for every alarm that meets the criteria defined in the
command.
Output Parameters
aid
Access identifier of the target module.
aid is a string.
sccm
Second Command Code Modifier corresponding to the aid.
sccm is of type SCCM_NOALL on page 2-48.
ntfcncde
The notification code associated with the alarm.
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN]
condtype
The type of alarm condition being described in this response block.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The effect on service associated with the condition.
srveff is of type Service Effect on page 2-51.
ocrdat
The date (month, day) when the event occurred. The format is mm-dd.
ocrdat is a string.
ocrtm
The time (hour, minute, second) when the event occurred. The format is hh-mm-ss.
ocrtm is a string.
conddescr
Detailed text description of the alarm condition, enclosed within escaped quotes.
(i.e., \"text\")
conddescr is a string.
Output Example
RTRV-ALM-OCHC
This command requires a Maintenance Level 1 User Access Privilege.
Description
Input Format
RTRV-ALM-OCHC:[TID]:[<aid>]:CTAG::[<ntfcncde>],[<condtype>],
[<srveff>],,,;
Input Parameters
aid
Access identifier that identifies the port for which the command is intended. aid is
the AID AllSlotsAndChannels on page 2-25
ntfcncde
ntfcncde is of type NotificationCode on page 2-41 . [CR, MJ, MN]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
srveff is of type Service Effect on page 2-51
Input Example
RTRV-ALM-OCHC:Node198:ALL:56::CL,
ABS-SW-THRESHOLD-CHANGED,NSA,,,;
Output Format
Output Parameters
aid
Access identifier.
aid is a string.
ntfcncde
Notification code.
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN]
condtype
Condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
Service effect.
srveff is of type Service Effect on page 2-51.
ocrdat
Occurrence date.
ocrdat is a string.
ocrtm
Occurrence time.
ocrtm is a string.
conddescr
Condition descriptor.
conddescr is a string.
Output Example
RTRV-ATTR-<SCCM_COMEQPT>
RTRV-ATTR-COM
Description
Use this command to retrieve alarm attributes for COM modifiers. Refer to
RTRV-ATTR-ALL on page 10-21 for command and parameter descriptions.
Input Format
RTRV-ATTR-COM:[TID]:<aid>:CTAG::<ntfcncde>,<condtype>,
<skipped1>,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
aid is the AID AllSlotsIncALL on page 2-26. A null value defaults to "ALL".
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-ATTR-COM:Node198:1-C:56::CL,
ABS-SW-THRESHOLD-CHANGED,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_COMEQPT on page 2-46.
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
dirn is of type Dirn on page 2-35.
Output Example
RTRV-ATTR-EQPT
Description
Use this command to retrieve alarm attributes for EQPT modifiers. Refer to
RTRV-ATTR-ALL on page 10-21 for command and parameter descriptions.
Input Format
RTRV-ATTR-EQPT:[TID]:<aid>:CTAG::<ntfcncde>,<condtype>,
<skipped1>,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
aid is the AID AllSlotsIncALL on page 2-26. A null value defaults to "ALL".
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-ATTR-EQPT:Node198:1-C:56::CL,
ABS-SW-THRESHOLD-CHANGED,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_COMEQPT on page 2-46
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
dirn is of type Dirn on page 2-35.
Output Example
RTRV-ATTR-ALL
This command requires a Provisioning Level 4 User Access Privilege.
Description
Use this command to instruct the target module to return the notification code
associated with the event specified by the <condtype>.
Alarm conditions to retrieve can be specified by using input parameters as filters.
Input Format
RTRV-ATTR-ALL:[TID]:[<aid>]:CTAG::[<ntfcncde>],
[<condtype>],,,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the target module for which the command is
intended. A null value or ‘All’ for <aid> may be used to indicate all units currently
installed in the shelf.
aid is the AID ALL on page 2-19. A null value defaults to "ALL".
ntfcncde
A null defaults to all applicable notification codes.
ntfcncde is of type NotificationCode on page 2-41.
condtype
A null defaults to all applicable condition types with the severity CR, MJ or MN.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-ATTR-ALL:Node198:E-1-ALL:56::CL,
ABS-SW-THRESHOLD-CHANGED,,,;
Output Format
Output Parameters
aid
Access identifier of the target module.
aid is a string.
sccm
Second Command Code Modifier corresponding to the aid.
sccm is of type SCCM_NOALL on page 2-48.
ntfcncde
The notification code associated with the alarm.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The type of alarm condition being described in this response block.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
Direction. Note: Not applicable.
dirn is of type Dirn on page 2-35.
Output Example
RTRV-ATTR-OCHC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Input Format
RTRV-ATTR-OCHC:[TID]:<aid>:CTAG::[<ntfcncde>],[<condtype>],,
,;
Input Parameters
aid
The Access Identifier.
aid is the AID AllChannels on page 2-21. A null value defaults to "ALL".
ntfcncde
Notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
Condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-ATTR-OCHC:Node198:E-1-ALL:56::CL,
ABS-SW-THRESHOLD-CHANGED,,,
;
Output Format
Output Parameters
aid
Access Identifier. I is a string.
sccm
Secondary command modifiere.
sccm is of type SCCM_OCH_OSC_OCHC on page 2-47.
ntfcncde
Notification code.
ntfcncde is of type NotificationCode on page 2-41.
condtype
Condition type.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
Direction.
dirn is of type Dirn on page 2-35.
Output Example
RTRV-ATTR-SECULOG
This command requires a Security & Administration Level 4 User Access
Privilege.
Description
Input Format
RTRV-ATTR-SECULOG:[TID]:<aid>:CTAG;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Must be ‘1-C’. Only the Communications module logs security-related events.
aid is the AID COMM on page 2-29.
Input Example
RTRV-ATTR-SECULOG:Node198:1-C:56;
Output Format
Output Parameters
aid
Access identifier of the target module. The value is always "1-C".
aid is a string.
upslg
Sets the condition for security log upload. Note: Not supported.
upslg is a string.
warn
Security message to display before a session is initiated. Maximum of 20 lines,
enclosed in escaped quotes (i.e., \"warning message\").
warn is a string.
logevent
List of security events to record. Note: Not supported. logevent is a string and is
listable.
logevent is optional.
Output Example
RTRV-COND-<SCCM_COMEQPT>
RTRV-COND-COM
Description
Input Format
RTRV-COND-COM:[TID]:<aid>:CTAG::<condtype>,<skipped1>,
<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
aid is the AID AllSlotsIncALL on page 2-26. A null value defaults to "ALL".
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-COND-COM:Node198:1-C:56:: ABS-SW-THRESHOLD-CHANGED,,,;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_COMEQPT on page 2-46.
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
srveff is of type Service Effect on page 2-51.
ocrdat
ocrdat is a string.
ocrtm
ocrtm is a string.
dirn
dirn is of type Dirn on page 2-35.
dnField
dnField is a string.
Output Example
RTRV-COND-EQPT
Description
Input Format
RTRV-COND-EQPT:[TID]:<aid>:CTAG::<condtype>,
<skipped1>,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
aid is the AID AllSlotsIncALL on page 2-26. A null value defaults to "ALL".
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-COND-EQPT:Node198:1-C:56:: ABS-SW-THRESHOLD-CHANGED,,,;
Output Format
"<aid>,<sccm>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm
>,,<dirn>,<dnField>"
;
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_COMEQPT on page 2-46.
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
srveff is of type Service Effect on page 2-51.
ocrdat
ocrdat is a string.
ocrtm
ocrtm is a string.
dirn
dirn is of type Dirn on page 2-35.
dnField
dnField is a string.
Output Example
RTRV-COND-ALL
This command requires a Maintenance Level 1 User Access Privilege.
Description
This command instructs the target module to return its current standing
conditions. The condition type acts as a filter for the command response.
Input Format
RTRV-COND-ALL:[TID]:[<aid>]:CTAG::[<condtype>],,,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the target module for which the command is
intended. A null value or ‘All’ for <aid> may be used to indicate all units currently
installed in the shelf.
aid is the AID ALL on page 2-19. A null value defaults to "ALL".
condtype
A null defaults to all applicable condition types with the severity CR, MJ or MN.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-COND-ALL:Node198:E-1-ALL:56::ABS-SW-THRESHOLD-CHANGED,,
,;
Output Format
;
If there are no conditions to report, the response is the response shown above.
However, if one or more conditions exist the following response format is used:
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
<rspblk> + ;
Where <rspblk> has the following format:
^^^"<aid>,<aidtype>:[<ntfcncde>],<typerep>,[<srveff>],<ocrda
t>,<ocrtm>,,<dirn>,<conddescr>"<cr><lf>
Multiple <rspblk>s are included, if applicable.
Output Parameters
aid
Access identifier of the target module.
aid is a string.
sccm
Second Command Code Modifier corresponding to the aid.
sccm is of type SCCM_NOALL on page 2-48.
ntfcncde
The notification code associated with the alarm.
ntfcncde is of type NotificationCode on page 2-41.
condtype
The type of alarm condition being described in this response block.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
The effect on service associated with the condition.
srveff is of type Service Effect on page 2-51.
ocrdat
The date (month, day) when the event occurred. The format is mm-dd.
ocrdat is a string.
ocrtm
The time (hour, minute, second) when the event occurred. The format is hh-mm-ss.
ocrtm is a string.
dirn
Direction. Note: Not applicable.
dirn is of type Dirn on page 2-35.
dnField
Detailed text description of the alarm condition, enclosed within escaped quotes.
(i.e., \"text\")
dnField is a string.
Output Example
RTRV-COND-OCHC
This command requires a Maintenance Level 1 User Access Privilege.
Description
Input Format
RTRV-COND-OCHC:[TID]:<aid>:
::<condtype>,,,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
aid is the AID AllPortsIncALL on page 2-24. A null value defaults to "ALL".
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-COND-OCHC:Node198:E-1-ALL:56::
ABS-SW-THRESHOLD-CHANGED,<null>,<null>,<null>;;
Output Format
Output Parameters
aid
aid is a string.
sccm
sccm is of type SCCM_OCH_OSC_OCHC on page 2-47.
ntfcncde
ntfcncde is of type NotificationCode on page 2-41. [CR, MJ, MN, NA, NR]
condtype
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
srveff
srveff is of type Service Effect on page 2-51.
ocrdat
ocrdat is a string.
ocrtm
ocrtm is a string.
dirn
dirn is of type Dirn on page 2-35.
dnField
dnField is a string.
Output Example
RTRV-DESC-<SCCM_COMEQPT>
This command requires a Provisioning Level 1 User Access Privilege.
Use this command to retrieve descriptions for condition-types for which the
condition may be changed with SET-DESC-<COM|EQPT>. This command is
used to support retrieval of message text specified for the WRT-840/842 module
Sense Input alarm.
RTRV-DESC-COM
Description
Use this command to retrieve descriptions for condition-types for which the
condition may be changed with SET-DESC-COM.
Input Format
RTRV-DESC-COM:[TID]:<src>:CTAG::<desc>,<condtype>,<skipped1>
, <skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
src
AID
src is the AID AllSlots on page 2-24.
desc
DESC
desc is a string.
condtype
CONDTYPE
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-DESC-COM:Node198:1-C:56::LUMOS,
ABS-SW-THRESHOLD-CHANGED,<null>,<null>,<null>;
Output Format
Output Parameters
aid
AID
aid is a string.
sccm
SCCM
sccm is of type SCCM_COMEQPT on page 2-46.
desc
DESC
desc is a string.
condtype
CONDTYPE
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
DIRN
dirn is of type Dirn on page 2-35.
Output Example
RTRV-DESC-EQPT
Description
Retrieve descriptions for condition-types for which the condition may be changed
with SET-DESC-EQPT.
Input Format
RTRV-DESC-EQPT:[TID]:<src>:CTAG::<desc>,<condtype>,<skipped1
>, <skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
src
AID
desc
DESC
desc is a string.
condtype
CONDTYPE
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
RTRV-DESC-EQPT:Node198:1-C:56::LUMOS,
ABS-SW-THRESHOLD-CHANGED,<null>,<null>,<null>;
Output Format
Output Parameters
aid
AID
aid is a string.
sccm
SCCM
sccm is of type SCCM_COMEQPT on page 2-46.
desc
DESC
desc is a string.
condtype
CONDTYPE
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
dirn
DIRN
dirn is of type Dirn on page 2-35.
Output Example
RTRV-MSG-ALL
This command requires a Maintenance Level 3 User Access Privilege.
Description
Use this command to instruct the network element to return the current inhibited
condition(s) of the network element.
Input Format
RTRV-MSG-ALL:[TID]:[<aid>]:CTAG::,,,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target module or port. A null or "All" value indicates all units
currently installed in the shelf/shelves.
aid is the AID ALL on page 2-19.
Input Example
RTRV-MSG-ALL:Node198:E-1-ALL:56::<null>,<null>,<null>,<null>
;
Output Format
Output Parameters
aid
Access identifier of the target module or port.
aid is a string.
aidtype
Not currently used.
aidtype is of type SCCM_NOALL on page 2-48. aidtype is optional.
typerep
The type of condition(s) that is inhibited.
Typereps are listed in Non-Security Alarm and Event Conditions on page 11-6.
Output Example
RTRV-TH-<SCCM_EQPTOCH>
These commands require a Provisioning Level 1 User Access Privilege.
Use these commands to retrieve threshold settings for the target of the command.
RTRV-TH-EQPT
Description
Use this command to retrieve threshold settings for the target equipment.
Input Format
RTRV-TH-EQPT:[TID]:<aid>:CTAG::<skipped>,<skipped1>,<skipped
2>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the equipment for which the command is intended.
aid is the AID AllSlotsAndPorts on page 2-25
.
Input Example
RTRV-TH-EQPT:Node198:1-C:56::<null>,<null>,<null>;
Output Format
Output Parameters
aid
Access identifier that identifies the optical port to which the command applies. aid
is a string.
thresholdtype
The type of threshold or set point that is to be set.
thresholdtype
is of type ThresholdType on page 2-52
.
thresholdvalue
The value of the specified threshold. thresholdvalue is a integer.
Output Example
RTRV-TH-OCH
Description
Use this command to retrieve threshold settings for the target optical channel.
Input Format
RTRV-TH-OCH:[TID]:<aid>:CTAG::<skipped>,<skipped1>,<skipped2
>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access Identifier identifies the facility in the NE, depending on the command code
modifier, for which threshold levels are being retrieved. aid is the AID AllSlotsAnd-
Ports on page 2-25
.
Input Example
RTRV-TH-OCH:Node198:1-C:56::<null>,<null>,<null>;
Output Format
Output Parameters
aid
Access identifier that identifies the optical port to which the command applies.
aid is a string.
thresholdtypeThe
type of threshold or set point that is to be set.
thresholdvalueThe
value of the specified threshold.
thresholdvalue is a string.
Output Example
SET-ATTR-<SCCM_COMEQPT>
SET-ATTR-COM
Description
Instructs the NE to set the notification code associated with the specified condition
type. Only standing conditions can be assigned alarmed notification codes (CR,
MJ or MN), however they can also be made non-alarmed. Transient conditions
can only be non-alarmed (i.e., NA or NR).
Input Format
SET-ATTR-COM:[TID]:<aid>:CTAG::<ntfcncde>,<condtype>,
<skipped1>,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target module or port.
aid is the AID AllSlotsIncALL on page 2-26. The default value is "ALL".
ntfcncde
The notification code to be assigned to the specified condition. A null defaults to
NA.
ntfcncde is of type NotificationCode on page 2-41. The default value is "NA". [CR,
MJ, MN, NR]
condtype
The type of event for whose notification code is to be changed. A null value will cause
notification attributes for all event types matching <aid> to be set.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-ATTR-COM:Node198:1-C:56::CL,ABS-SW-THRESHOLD-CHANGED,<nu
ll>,<null>,<null>;
SET-ATTR-EQPT
Description
Instructs the NE to set the notification code associated with the specified condition
type. Only standing conditions can be assigned alarmed notification codes (CR,
MJ or MN), however they can also be made non-alarmed. Transient conditions
can only be non-alarmed (i.e., NA or NR).
Input Format
SET-ATTR-EQPT:[TID]:<aid>:CTAG::<ntfcncde>,<condtype>,
<skipped1>,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target module or port.
aid is the AID AllSlotsIncALL on page 2-26. The default value is "ALL".
ntfcncde
The notification code to be assigned to the specified condition. A null defaults to
NA.
ntfcncde is of type NotificationCode on page 2-41. The default value is "NA". [CR,
MJ, MN, NR]
condtype
The type of event for whose notification code is to be changed. A null value will cause
notification attributes for all event types matching <aid> to be set.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-ATTR-EQPT:Node198:1-C:56::CL,
ABS-SW-THRESHOLD-CHANGED,<null>,<null>,<null>;
SET-ATTR-OCHC
This command requires a Provisioning Level 4 User Access Privilege.
Description
Instructs an NE to set the notification code associated with the specified condition
type. Only standing conditions can be assigned alarmed notification codes (CR,
MJ or MN), however they can also be made non-alarmed. Transient conditions
can only be non-alarmed (i.e., NA or NR).
Input Format
SET-ATTR-OCHC:[TID]:<aid>:CTAG::[<ntfcncde>],<condtype>,,,;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Access identifier of the target module or port.
aid is the AID AllChannels on page 2-21.
ntfcncde
The notification code to be assigned to the specified condition. A null defaults to
NA.
ntfcncde is of type NotificationCode on page 2-41. The default value is "NA".
condtype
The type of event for whose notification code is to be changed. A null value will cause
notification attributes for all event types matching <aid> to be set.
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-ATTR-OCHC:Node198:E-1-ALL:56::CL,ABS-SW-THRESHOLD-CHANGE
D,<null>,<null>,<null>
;
SET-ATTR-SECULOG
This command requires a Security and Administration Level 5 User Access
Privilege.
Description
Input Format
SET-ATTR-SECULOG:[TID]:<aid>:CTAG::[WARN=<warn>],;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
aid
Must be ‘1-C’. Only the Communications module logs security-related events.
aid is the AID COMM on page 2-29.
warn
Security message to be displayed before session is initiated. String, 20 lines max
enclosed in quotes (i.e., WARN="warning message").
warn is a string.
Input Example
SET-ATTR-SECULOG:Node198:1-C:56::LUMOS,<null>;
SET-DESC-<SCCM_COMEQPT>
These commands require a Provisioning Level 4 User Access Privilege.
Use these commands to set the description for the given condition types. This
command is used to set the message text for the WRT-840/842 sense input alarm.
SET-DESC-COM
Description
Input Format
SET-DESC-COM:[TID]:<src>:CTAG::<desc>,<condtype>,<skipped1>,
<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
src
AID
src is the AID AllSlots on page 2-24.
desc
DESC
desc is a string.
condtype
CONDTYPE
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-DESC-COM:Node198:1-C:56::LUMOS,
ABS-SW-THRESHOLD-CHANGED,<null>,<null>,<null>;
SET-DESC-EQPT
Description
Input Format
SET-DESC-EQPT:[TID]:<src>:CTAG::<desc>,<condtype>,<skipped1>
,<skipped2>,<skipped3>;
Input Parameters
tid
Target identifier of the network element or system that contains the module to
which the command is directed.
ctag
Correlation tag
src
AID
src is the AID AllSlots on page 2-24.
desc
DESC
desc is a string.
condtype
CONDTYPE
Condition types are listed in Non-Security Alarm and Event Conditions on page 11-6.
Input Example
SET-DESC-EQPT:Node198:1-C:56::LUMOS,ABS-SW-THRESHOLD-CHANGED
,<null>,<null>,<null>;
SET-TH-<SCCM_EQPTOCH>
Use these commands to set general threshold values for the equipment specified
by the secondary command.
SET-TH-EQPT
Description
Use this command to set general threshold values for the specified equipment.
Input Format
SET-TH-EQPT:[TID]:<aid>:CTAG::<thresholdtype>,<thresholdvalu
e>,<skipped>, <skipped1>;
Input Parameters
aid
Access identifier that identifies the equipment for which the command is intended.
Must be a ‘card-level’ aid. aid is the AID AllPorts on page 2-23
.
thresholdtype
The type of threshold or set point that is to be set.
thresholdtype
is of type ThresholdType on page 2-52
.
thresholdvalue
The value of the specified threshold.
thresholdvalue
is a integer.
Input Example
SET-TH-EQPT:Node198:1-C:56::FECUNCWORD,1,<null>,<null>;
SET-TH-OCH
Description
Sets the current threshold level of one or more monitored parameters for which
violation will trigger an automatic message.
Input Format
SET-TH-OCH:[TID]:<aid>:CTAG::<thresholdtype>,<thresholdvalue
>,<skipped>, <skipped1>;
Input Parameters
tid
Target identifier of the network element or system that contains the COM-200 to
which the command is directed.
ctag
Correlation tag
aid
Access identifier that identifies the equipment for which the command is intended.
Must be a ‘card-level’ aid. aid is the AID AllSlotsAndPorts .
thresholdtype
The type of threshold or set point that is to be set.
thresholdtype
is of type ThresholdType on page 2-52
thresholdvalue
The value of the specified threshold.
thresholdvalue
is a integer.
Input Example
SET-TH-OCH:Node198:1-C:56::FECUNCWORD,1,<null>,<null>;
CANC
This autonomous message is displayed when the user has a Security and
Administration Level 1 User Access Privilege.
Description
The COM-200 sends this message to the user when the session times out as a result
of inactivity. Time-out is specified by the SESSIONTMOUT parameter.
See CANC on page 3-2 for more information.
The module generates these autonomous messages to report the occurrence and
clearing of alarmed events.
See REPT ALM <SCCMNOALL> on page 10-5
Output Format
<cr><lf><lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS><cr><lf>
<almcode>^<atag>
REPT^ALM^{EQPT|COM|OCH|OSC}
<cr><lf><rspblk> + ;
Where <rspblk> has the format:
^^^"<aid>:<ntfncncde>,<condtype>,<srveff>,
<ocrdat>,<ocrtm>,,:<conddescr>,"<cr><lf>
One <rspblk> is displayed for each alarm.
Output Format
<cr><lf><lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS><cr><lf>
A^^<atag>^REPT^EVT^{EQPT|COM|OCH|OSC}<cr><lf>
<rspblk> + ;
Where <rspblk> has the format:
^^^"<aid>:<condtype>,<condeff>,
<ocrdat>,<ocrtm>,,,,:<conddescr>,"<cr><lf>
One <rspblk> is displayed for each event.
Table 11-1:REPT^EVT Autonomous Message Responses
condeff Condition effect: Reports the effect of See Non-Security Alarm and
the event on the condition of the Event Conditions on page
module. 11-6
ocrdat Occurrence date: The date when the See Occurrence Date and
event occurred. Time on page 2-13
ocrtm Occurrence time: The time when the See Occurrence Date and
event occurred. Time on page 2-13
The COM-200 generates this autonomous message when a TL1 session is initiated.
Two non-alarmed events can trigger this message:
• A user requests a session with the COM-200.
• The module is required to send an advisory warning message (regarding
unauthorized entry/use) before granting system access to the user.
NOTE: If the module allows a grace period during which the user can continue to use
the password, this information is included in the message.
Output Format
<cr><lf><lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS><cr><lf>
A^^<atag>^REPT^EVT^SESSION<cr><lf>
^^^"<aid>:<exp>,[<pcn>]"<cr><lf>^^^/*Free format text
regarding access warning*/<cr><lf>;
Alarms
Alarms are conditions with the notification codes: CR, MJ or MN. The system
reports alarms in response to either a RTRV-ALM or RTRV-COND command,
Events
The system records events with condition type "not reported" (NR) in the specific
module's Event Log. NR conditions can be either standing conditions (SC) or
transient conditions (TC). Retrieve all un-cleared, NR standing conditions by
issuing a RTRV-COND command. The system does not report transient
conditions, but their occurrence is shown in the Event Log for the module.
Table 10-5 lists the alarm and event condition parameters. ‘Table 10-6’ on page
10-8 and ‘Table 10-7’ on page 10-32 list the condition codes and descriptions of
specific alarms and events.
NOTE: The RTRV-COND command retrieves current standing events (non-cleared events
with the notification code NA) as well as current standing alarms (non-cleared alarms with
the notification codes: CR, MJ and MN).
Condition Descriptor:
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
Condition Descriptor:
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
ACOON ACO-aid-ACO_ACTIVATED
Condition Descriptor:
AID: 1-C
Modifier: EQPT
Notification Code: NA
Condition Effect: SC
AID: {1-3}-{1-13}-{1-3}
Modifier: OCH
Notification Code: NA
Condition Effect: SC
AID: {1-3}-{1-13}-{1-3}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
AUTO_INSERVICE_ COMPLETED
AUTO_SERVICE_STARTED
Condition Descriptor:
AID: ALL
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
AID: {1-3}-{1-13}
Modifier: OCH
Condition Effect:
Applicable Hardware:
BITRATEMIS A port's input signal data rate is different from the configured bit
rate. Only applicable when the port is configured to operate at only
one data rate.
AID: {1-3}-{1-13}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
CALDATAINV Calibration Data Invalid. Occurs if any, or all of the calibration data is
missing or invalid.
Condition Descriptor:
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
CTMP This alarm indicates that the case temperature of the module has
gone outside of the operator specified thresholds. Typical causes
for this alarm include, fan failure on the shelf, or a change in
operating environment temperature (e.g. HVAC failure in CO). To
clear this fault the operator must restore the operating
environment temperature to its normal operating level.
Modifier: EQPT
Notification Code: MN
Condition Effect:
Notification Code: NA
Condition Effect: TC
AID: {A-F}-1
Modifier: COM
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
AID: 1-3}-{1-13}-2
Modifier: OSC
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}-2
Modifier: OSC
Notification Code: NA
Condition Effect: SC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
Condition Descriptor:
AID: 1-C
Modifier: EQPT
Notification Code: NR
Condition Effect: TC
Modifier: EQPT
Notification Code: MJ
Condition Effect: SC
FAN-FAIL Indicates that one or more fan modules has failed. Applies to
WaveReady 3500F/3500F-HP shelves only.
AID: 1-C
Modifier: COM
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: 1-C
Modifier: COM
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
Modifier: COM
Service Effect: SA
Condition Effect: SC
Modifier: COM
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}-{1-4}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
FEC_UW The FEC Uncorrected Code Word Threshold has been exceeded.
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Condition Effect: TC
GAINOUTOFRANGE Raised in constant gain mode only, this alarm indicates that the
actual (measured) gain has deviated from the user-provisioned set
point by more than a factory-set amount. The pump laser will not
be disabled when this fault is detected.
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: 1-C
Modifier: COM
Notification Code: MN
Condition Effect: TC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
Condition Descriptor:
AID: {1-3}-{1-13}-1
Modifier: OCH
Notification Code: MN
Condition Effect: SC
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
INTERNALPWRFAIL Indicates that one of the internally derived power supply voltages is
low. The message text that accompanies the alarm notification
identifies the nominal voltage of the specific supply (i.e., 5V, 3.3V,
2.5V or 1.2V) This alarm cannot be cleared by operator intervention
and therefore the module must be replaced. If this is a WRA-xxx
card, the pump laser will not be disabled when this fault is
detected.
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
Condition Descriptor:
AID: 1-C
Modifier: COM
Notification Code: MN
Condition Effect: TC
LAGE Indicates that the ratio of pump laser output power to bias current
has degraded and therefore its end of life is near. The pump laser
will not be disabled when this fault is detected.
Condition Descriptor:
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
LASER Laser aging alert. Indicates that the transmit power on the laser is
degraded and therefore its end of life is near. This fault is raised
based on an indication that comes directly from the laser module
declaring an end-of-life defect.
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}-1
Modifier: OCH
Notification Code: NR
Condition Effect: SC
LASERENABLED Indicates that the pump laser has been turned on, either manually
because the Card was manually put into service by the user, or
automatically due to an LOS fault clearing on the Rx port (with the
‘LOS Shutdown’ feature enabled).
LFAIL Indicates that the ratio of pump laser output power to bias current
has exceeded its end-of-life threshold. The pump laser will not be
disabled when this fault is detected.
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
Condition Descriptor:
AID: 1-C
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
LINKDOWN Link Down. Indicates that a management connection has been lost.
AID: [1-3}-{1-13}-{1-4}
Modifier: OCH
Notification Code: MN
Condition Effect: TC
Condition Descriptor:
AID: 1-C
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
LOF Loss of Frame. Synchronization with the native traffic frame has
been lost.
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
LOGBUFR90-EVTLOG
AID: 1-C
Modifier: EQPT
Condition Effect: TC
AID: 1-C
Modifier: EQPT
Condition Effect: TC
LOL Loss of lock on the input signal of the specified port. If this is a
protected port on a WRT-760 this condition is a loss of lock on the
input signal on one of the network interfaces. Minor and NSA
because the alternate network interface is functional.
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
LOL Loss of lock on the input signal of the specified port. If this is a
protected port on a WRT-760 this condition is a loss of lock on the
input signal on one of the network interfaces. Minor and NSA
because the alternate network interface is functional.
AID: {1-3}-{1-13}-{2-3}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}-{2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}-{2-3}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
MAXCTMPCHG
AID: {1-3}-{1-13}
Modifier: EQPT
Condition Effect: TC
MAXCTMPHYSTCHG
Modifier: EQPT
Condition Effect: TC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Condition Effect: SC
AID: {1-3}-{1-13}
Modifier: EQPT
Condition Effect: TC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
Condition Effect: TC
NTPFAIL The NTP service has been unable to contact any of the provisioned
NTP servers to obtain the correct time.
AID: 1-C
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
OTU_AIS
AID: 1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
AID: 1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MN
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MN
Condition Effect: TC
OTU_LOF Loss of Frame. Synchronization with the received OTUk frame has
been lost on the specified port.
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MN
Condition Effect: TC
OTU_SF Signal Fail. The estimated BER has exceeded the user-configurable
signal fail threshold. BER is estimated based on the ratio of section
Sonitor BIP-8 Error Count (x027) to Rx Frame count (x02E).
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Condition Effect: TC
OTU_TIM
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: TC
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
OUTPUTSIGNAL DEGRADE Indicates that the optical power measured on the output port has
dropped below the user-configurable Signal Degrade Threshold on
the Tx port. To clear this fault, an optical input power equal to the
Signal Degrade Threshold plus the Signal Degrade Hysteresis must
be restored at the input port.
AID: {1-3}-{1-13}-2
Modifier: OCH
Notification Code: MN
Condition Effect: SC
AID: 1-3}-{1-13}-{2-3}
Modifier: OCH
Notification Code: NA
Condition Effect: TC
PWR Indicates that one of the redundant power supplies has failed.
Notification code is MN by default when unit is installed in slot C.
Otherwise, notification code is NR by default.
AID: {1-3}-{1-13}
Modifier: EQPT
Condition Effect: SC
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
RECEIVEFAIL Receive failure. The network side receiver has been overloaded.
AID: 1-3}-{1-13}-{2-3}
Modifier: OCH
Notification Code: MN
Condition Effect: SC
RECEIVEOVERLOAD Receiver Overload. Indicates that the input optical power being
received on the port is currently above the saturation point of the
receiver.
AID: {1-3}-{1-13}-2
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}-1[-2-F-1]-2
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
Condition Descriptor:
Modifier: EQPT
Notification Code: NA
Service Effect:
Condition Effect: TC
Condition Descriptor:
AID: 1-3}-{1-13}-2
Modifier: OCH
Notification Code: NA
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MN
Condition Effect: TC
SENSEFAULT Indicates that the sense input has been activated externally. It will
be reported only if the SenseMonitor attribute on the card has been
configured to ‘ON’.
AID: {1-3}-{1-13}-2-F
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
AID: {1-3}-{1-13}-{1-2}
Modifier: OCH
Notification Code: MJ
Condition Effect: TC
AID: {1-3}-{1-13}-{1-2}-{1-2}
Modifier: OCH
Notification Code: MJ
Condition Effect: SC
SFPEVENT SFP removed, or SFP inserted. Raised when the SFP/XFP is inserted
or removed. Always informs the user of SFP/XFP insert/remove
actions, even in the case where the SFP/XFP missing alarm is
masked by port MA state.
AID: 1-3}-{1-13}-1
Modifier: OCH
Notification Code: NA
Condition Effect: TC
AID: WRT-740/WRT-760/WRT-840:
{1-3}-{1-13}-1 WRT-780:
{1-3}-{1-13}-{1-2}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
SFPNOTSUP Indicates that the removeable pluggable (SFP/XFP) which has been
inserted in in the corresponding port is not qualified. The
pluggable is disabled to avoid damage to the card.
AID: {1-3}-{1-13}-{1-2}-{1-2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
AID: {1-3}-{1-13}-1
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
SMACT Sense Priority Mode Active. The operating mode of the protection
switch is changed to Sense Priority.
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code:
Service Effect:
Condition Effect: SC
SUBNETCHGD Report that the Internet Protocol Subnet Mask has been changed.
AID: 1-C
Modifier: COM
Notification Code: MN
Condition Effect: TC
AID: {1-3}-{1-13}-2
Modifier: OCH
Notification Code: MN
Condition Effect: SC
SVC-PHYLNKFAIL SVC Physical Link Failure. Declared when there is no physical carrier
present to support the Inband supervisory management channel.
This fault can be caused either by someone removing the Inband
supervisory management channel from service at the far end, or a
failure of the Inband supervisory management channel
transmitting hardware at the far end, or a failure of the Inband
supervisory management channel receiving hardware at the near
end.
AID: {1-3}-{1-13}-2
Modifier: OCH
Notification Code: MN
Condition Effect: SC
Modifier: EQPT
Notification Code: NR
Condition Effect: TC
Modifier: EQPT
Notification Code: NR
Condition Effect: TC
SWLOADMISMATCH A mismatch of the software baseline load vs the actual load has
been detected on a traffic card
AID: {1-3}-{1-13}[-2-F]
Modifier: EQPT
Notification Code: MN
Condition Effect: SC
AID: 1-C
Modifier: COM
Notification Code: MN
Condition Effect: TC
UEQ A module has been properly disconnected (or removed) from the
given slot number.
AID: {1-3}-{1-13}
Modifier: EQPT
Notification Code: NA
Condition Effect: TC
WAVELENGTH- DEVIATION This fault indicates that the wavelength measured on the DWDM
network port has deviated from the nominal channel wavelength
by more than 25 picometers. This is a latching, fault that causes the
DWDM network port laser to be shut down. This fault cannot be
cleared.
AID: {1-3}-{1-13}-{1}[-{2}-F]-{2}
Modifier: OCH
Notification Code: MJ
Service Effect: SA
Condition Effect: SC
Security Events
Events shown below with alarmed notification codes (CR, MJ or MN) are reported
autonomously using the REPT^ALM^SECU message and retrieved using
RTRV-ALM-SECU. The reporting of these alarms may be inhibited /allowed
using the INH-MSG-SECU and ALW-MSG-SECU commands. The notification
codes associated with security alarms can be changed using
SET-ATTR-SECUALM, however they may only be changed to CR, MJ or MN (i.e.,
not NA or NR). By default, all alarmed security events are logged in the security
log. The user may inhibit and allow the logging of these events using the
INH-LOG-SECU and ALW-LOG-SECU commands.
Events with notification code NR are not reported autonomously, and their
notification code cannot be changed (i.e., they cannot be configured to be reported
autonomously). All of these events are logged by default in the security log. A list
of security events that will be logged by the system can be retrieved using
RTRV-ATTR-SECULOG and modified using SET-ATTR-SECULOG. Security
logs are retrieved using the RTRV-LOG command with the ‘logname’ parameter
set to ‘SECULOG’.
By default, the Security log is enabled, and autonomous messages are disabled
Table 11-5:Security Events
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
LOGBUFR90- SECULOG Reported when the security log is full to 90% of capacity.
Notification Code: NR
Condition Effect: TC
LOGBUFROVFL- SECULOG Reported when the security log reaches capacity and overflows.
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
PIDAGED Reported when the PID has aged for this user (uid).
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Notification Code: NR
Condition Effect: TC
Error Codes
Errors may be generated by any command or command response message. The
format of an error message is as follows:
sid date time
M ctag DENY
<errcde>
/* <errmsg> */
;
This table lists and describes TL1 Error Codes and Error Messages for the
WaveReady system.
IEAE input Input, Entity Already Exists. The entity the user
is trying to create, such as an FFP (protection)
group, already exists.
Claims
Immediately inform JDSU and, if necessary, the carrier, if:
• the contents of the shipment are incomplete
• the unit or any of its components are damaged or defective
• the unit does not pass the initial inspection
Returns
JDSU only accepts returns for which an approved Return Material Authorization
(RMA) has been issued by JDSU sales personnel. The RMA must be obtained before
returning any equipment to JDSU.
NOTE: The owner’s name and address, the model number and full serial number of the unit,
the RMA number and an itemized statement of claimed defects must be included with the
returned material.
Shipping
Materials should be returned in the original packing material and shipping
container. If these are not available, follow these packaging guidelines:
• Wrap the unit in anti-static packaging. Use anti-static connector covers, as
applicable.
• Pack the unit in a reliable shipping container.
• Use enough shock-absorbing material (10-15 cm or 4-6 in.) on all sides) to cushion
the unit and prevent it from moving inside the container. Pink poly anti-static foam
is the best material.
Web
www.jdsu.com/waveready
Phone
Fax
Country Code
Australia 0011
Europe 00
002 Fax
Israel 014
0041 ITJ
0061 IDC
Malaysia 00
New Zealand 00
Singapore 001
002 Dacom
007 Tele2
Taiwan 00
E-mail
support@jdsu.com
Ordering Documentation
Please contact Technical Support for information on how to obtain other
WaveReady installation and user's manuals.
Parameter/Command Description
ED-EQPT, RTRV-EQPT PASSWRDRENTY added as new parameter
Parameter/Command Description
CardType WRT-781 added as new card type
Parameter/Command Description
CLEI CLEI added as new parameter to RTRV-OCH
Commands Description
RTRV-NETYPE This command displays the
communication module hardware and
software revision information.
• AllTranspondersIncALL
• AllSlotsAnd Channels
• AllSlotsAndPorts
• AllTranspondersIncAll
• AllMuxponders
These new parameters have been added or modified:
• CardType
• MonitorType
• SCCM_PM_NO_ALL
• SCCM_NOALL
Commands Description
RTRV-ALM-OCH Use this command to retrieve alarms for OCHC
modifiers.
Commands Description
RTRV-ATTR-OCHC Retrieve optical wavelength channel alarm attributes
Commands Description
OPR-PROC-EQPT Activate a procedure on an EQPT entity.
Commands Description
ED-OCHC Edit optical wavelength channel
Commands Description
RTRV-CONTROLLER-MODE This commands retrieves information
about the operating mode of the
controller.
Commands Description
RTRV-PMMODE-<SCCM_PM> Retrieve performance mode information
for the target of the specified secondary
command.
Commands Description
RTRV-OCH The following values are not valid with copper SFPs installed
in a WRT-780 and will return "0"
• inputpwr
• outputpwr
• wavelength
• reach
• sfptemperature
• sfplaserbiascurrent
Commands Description
RMV-OCH Noted exceptions in WRT-780 performance with Copper SFPs
RTRV-ALRM The following list of alarms are not applicable to Copper SFPs
installed in a WRT-780:
• LASER
• LFAIL
• LOS
• OUTPUTPWROUTOFRANGE
• RECEIVEOVERLOAD
The following alarm does not return appropriate information:
• LOS
Command Description
RTRV/ED-OCH Commands extended to support requesting and displaying
WRT-780 ports with their 4-part AID structure (ie: 1-3-1-1)
RTRV/ED-XPDR Two new commands added to allow for querying and setting
transponder-specific information. The AID structure for these
commands is the 3-part transponder AID (ie: 1-3-1)
Table A-6: Condition Type Updates in Release 4.4.0 shows the modification to the
Condition Codes for Release 4.2. See TL1 Autonomous Messages on page 11-1
Command Description
WaveReady TL1 Parameter Types on page A list of TL1 Parameter types and
2-32 definitions was added.
INIT-BACKUP on page 7-3 Delete the backup file from the NE.
Command Description
RTRV-BACKUP on page 7-7 Retrieve the existing backup file.
Command Description
COPY-RFILE Added support for download of the EDFA load for the
WRA-1xx/217 module.
Command Description
SET-TRAFFICMODE The WRT-740 supports transponder, regenerator and 2R
regenerator modes. In 2R regenerator mode the WRT-740
performs 2R regeneration on uni-directionally traffic from
the receive to the transmit side of the network port.
Command Description
ED-NTP Enables the COMM200 NTP service which updates the
system time from the configured NTP server.
RTRV-UPGRD-STAT Retrieves the software load tags for the active (currently
running) and inactive (boot) banks for a module or the
node.
Command Description
RTRV-EQPT • viewing and setting traffic mode for WRT-840 See
"RTRV-EQPT on page 5-10.
• The uptime parameter indicates the number of
seconds since the last restart
(wrt-740/760/840/COM-200).
• The lastresetreason parameter indicates the reason for
the last restart (wrt-740/760/840/ COM-200).
• The trafficmode parameter indicates the traffic mode
of the module. This is transponder or regenerator for
the wrt-840 and transponder, regenerator or
2rregenerator for the wrt-740.
• The parameter amplifiermode indicates if the
LightAmp or BrightAmp module is in booster or
preamp mode.
RTRV-OCH The laserdisable parameter is added for the LightAmp
and BrightAmp modules.
Table A-11: Conditions (Alarms and Events) shows the modification to the
Condition Codes for Release 4.2. See TL1 Autonomous Messages on page 11-1.
Table A-11:Conditions (Alarms and Events)
Condition Description
Software Load Mismatch A mismatch has been detected between the software
baseline load and the actual load on a traffic card.
Embedded Management This fault indicates that the data link layer protocol
Channel Data Link Failure supporting the Inband supervisory management
channel has failed.
Condition Description
BankCopyFail Indicates the failure of a bank synchronization command
COPY-RFILE.
NTP Server contact failure NTP service is unable to contact any of the provisioned
NTP servers to obtain the time.
Internal hardware failure Miscellaneous internal hardware failure (a laser failure for
example) for the LightAmp and BrightAmp modules.
Loss of input signal Loss of input signal on the client side input for the
LightAmp and BrightAmp modules.
Laser aging alert Laser transmit power is degraded and therefore near EOL
for the LightAmp and BrightAmp modules.
Laser disabled Laser has been disabled by the operator for the
LightAmp and BrightAmp modules.
Laser temperature is out of The temperature of one of the network interface lasers is
range out of range for the LightAmp and BrightAmp modules.
Receiver Overload Indicates that the input optical power being received on
the port is currently above the saturation point of the
receiver for the LightAmp and BrightAmp modules.
Command Description
ED-SVC instructing the network element to set configuration
parameters that are specific to the embedded management
channel specified by the <aid> for WRT-740, WRT-760, WRT-840.
See ED-SVC on page 6-6.
Table A-13: TL1 command updates in Release 4.1 lists the modifications to the TL1
commands for Release 4.1.
Table A-13:TL1 command updates in Release 4.1
Command Description
ALW-MSG-ALL removed support for NTFCNCDE parameter. See
ALW-MSG-ALL on page 10-2.
ENT-USER-SECU Removed support for the PCND and UOUT parameters. See
ENT-USER-SECU on page 3-7.
INIT-LOG Only valid AIDs are 1-C or null. See INIT-LOG on page 7-17.
• ALW-MSG-EQPT
• ALW-MSG-COM
• ALW-MSG-OCH
• ALW-MSG-OSC
• ALW-MSG-SECU
• INH-LOG-SECU
• INH-MSG-EQPT
• INH-MSG-COM
• INH-MSG-OCH
• INH-MSG-OSC
• INH-MSG-SECU
• RTRV-ALM-SECU
• SET-ATTR-SECUALM
Table A-14: Conditions (Alarms and Events) shows the modification to the
Condition Codes for Release 4.1. See Alarm and Event Condition Reporting on
page 11-4.
Table A-14:Conditions (Alarms and Events)
Command Description
REPT-EVT added condition codes BITRATECHG, LINKADD, LINKREM removed
condition codes INHMSG, ROUTEADD, REOUTEREM, TCPNTSTARTED