LPS800 Um Comm 02

LoopStar® 800 Series
TL1 Commands
LPS-800 LPS-810
Product Catalog: LPS-FRM8xx-Lx

Document Number: LPS800-UM-COMM-02
REVISION HISTORY
The Revision History provides a summary of any changes in this manual. Please make sure you are using the
latest revision of this manual.
July 29, 2005
Revision Release Date Revisions Made

01 January 12, 2005 Initial Release
02 July 29, 2005 Updated with LPS-800 Release 2 and
LPS-810 Release 1.
This manual is available online at ADC’s website (www.adc.com/documentationlibrary/) or you can order copies
of the manual by contacting your sales representative. Please ask for document number LPS800-UM-COMM-02.
Copyright
©2005 ADC Telecommunications, Inc. All rights reserved.
Trademark Information
ADC and LoopStar are registered trademarks of ADC Telecommunications, Inc. No right, license, or interest to such trade-
marks is granted hereunder, and you agree that no such right, license, or interest shall be asserted by you with respect to
such trademark.
Other product names mentioned in this practice are used for identification purposes only and may be trademarks or regis-
tered trademarks of their respective companies.
Disclaimer of Liability
Information contained in this document is company private to ADC Telecommunications, Inc., and shall not be modified,
used, copied, reproduced or disclosed in whole or in part without the written consent of ADC.
Contents herein are current as of the date of publication. ADC reserves the right to change the contents without prior notice.
In no event shall ADC be liable for any damages resulting from loss of data, loss of use, or loss of profits, and ADC further
disclaims any and all liability for indirect, incidental, special, consequential or other similar damages. This disclaimer of
liability applies to all products, publications and services during and after the warranty period.
Table of Contents
About This Manual .........................................................................................................vii
Introduction .............................................................................................................................. vii
Related Manuals ...................................................................................................................... vii
Organization ............................................................................................................................ viii
Intended Audience .................................................................................................................. viii
Conventions ............................................................................................................................ viii
Inspecting Your Shipment .........................................................................................................ix
Chapter 1: TL1 Overview ............................................................................................... 1-1
Input Command Messages ...................................................................................................... 1-1
Acknowledgments .................................................................................................................... 1-2
Output Response Messages .................................................................................................... 1-3
Autonomous Messages ............................................................................................................ 1-5
Message Summary .................................................................................................................. 1-7
Chapter 2: TL1 Messages Description ......................................................................... 2-1
TL1 Messages by Category ..................................................................................................... 2-1
TL1 Messages by Units ............................................................................................................ 2-7
TL1 Messages by Category and Units ................................................................................... 2-10
TL1 Commands by Alphabetization ....................................................................................... 2-16
Chapter 3: TL1 Parameters ............................................................................................ 3-1
Access Identifier (AID) ............................................................................................................. 3-1
OCN ......................................................................................................................................... 3-4
Parameter Description ............................................................................................................3-11
XCS PROTECTION SWITCH ................................................................................................ 3-52
Chapter 4: Error Codes .................................................................................................. 4-1
Errors List ................................................................................................................................. 4-1
Chapter 5: Alarms and Values ....................................................................................... 5-1
Alarm and Condition List .......................................................................................................... 5-1
Autonomous Message List ..................................................................................................... 5-15
Performance and Threshold List ............................................................................................ 5-20
Appendix A: Product Support ..................................................................................... A-1
Glossary ......................................................................................................................GL-1
LPS800-UM-COMM-02 iii
Table of Contents July 29, 2005
iv LPS800-UM-COMM-02
List of Tables
Table 1-1. TL1 Message Summary ...................................................................................... 1-7
Table 2-1. TL1 messages by category ................................................................................. 2-1
Table 2-2. TL1 Messages by Units ....................................................................................... 2-7
Table 2-3. TL1 Messages by Category and Units .............................................................. 2-10
Table 3-1. LoopStar 1600 ..................................................................................................... 3-2
Table 3-2. LoopStar 800 ....................................................................................................... 3-3
Table 3-3. BITS values ......................................................................................................... 3-8
Table 3-4. SYNCAID values ................................................................................................. 3-8
Table 3-5. ACTFLOWCTRL values .................................................................................... 3-11
Table 3-1. AISTH values .................................................................................................... 3-11
Table 3-2. BCSENABLE values ......................................................................................... 3-12
Table 3-3. CARDTYPE values ........................................................................................... 3-13
Table 3-4. DIRECTION values ........................................................................................... 3-15
Table 3-1. EXTHDR values ................................................................................................ 3-15
Table 3-2. FCSTYPE values .............................................................................................. 3-21
Table 3-3. FLOWCTRL values ........................................................................................... 3-21
Table 3-4. INTFTYPE values ............................................................................................. 3-21
Table 3-5. J1 MODE values ............................................................................................... 3-22
Table 3-6. LINE BUILD OUT (DS1 PORT) values ............................................................. 3-22
Table 3-7. LINE BUILD OUT (DS3 PORT) values ............................................................. 3-22
Table 3-8. LOG values ....................................................................................................... 3-22
Table 3-9. LOOPBACK TYPE values ................................................................................. 3-23
Table 3-10.MACLPBK values ............................................................................................ 3-23
Table 3-11.PATHTYPE values ........................................................................................... 3-24
Table 3-12.PHYLPBK values ............................................................................................. 3-24
Table 3-13.PORTENABLE values ..................................................................................... 3-28
Table 3-14.PPTENABLE values ........................................................................................ 3-28
Table 3-15.PROTOCOL values ......................................................................................... 3-28
Table 3-16.PROVISION_STATE values ............................................................................ 3-29
Table 3-17.PST_STATE values ......................................................................................... 3-29
Table 3-18.PTPMODE values ............................................................................................ 3-29
Table 3-19.RES values ...................................................................................................... 3-30
Table 3-20.REVERTIVE MODE ......................................................................................... 3-30
Table 3-21.REVERTIVE TIME ........................................................................................... 3-30
Table 3-22.RMON values ................................................................................................... 3-31
Table 3-23.SCRAMBLER values ....................................................................................... 3-35
Table 3-24.SM values ........................................................................................................ 3-35
LPS800-UM-COMM-02 v
List of Tables July 29, 2005
Table 3-25.SN values ......................................................................................................... 3-36

Table 3-26.SNMP values ................................................................................................... 3-37
Table 3-27.SSM Generation 1st Message set .................................................................. 3-37
Table 3-28.SSM Generation 2nd Message set .................................................................. 3-38
Table 3-29.Mapping for SSM from 2nd generation to 1st generation ................................ 3-38
Table 3-30.SST_STATE values ......................................................................................... 3-39
Table 3-31.SVTIMER values ............................................................................................. 3-40
Table 3-32.SWDL values ................................................................................................... 3-41
Table 3-33.SWITCH STATE OF OPTICAL PORT values .................................................. 3-42
Table 3-34.SWITCH STATE OF STS PATH OR VT PATH values ..................................... 3-44
Table 3-35.SYNCLBO values ............................................................................................ 3-44
Table 3-36.SYNCSTATE values ........................................................................................ 3-45
Table 3-37.SYSTEM values ............................................................................................... 3-45
Table 3-38.TACC values .................................................................................................... 3-47
Table 3-39.TACCMODE values ......................................................................................... 3-47
Table 3-40.TAGTYPE values ............................................................................................. 3-47
Table 3-41.TPS_PRIORITY ............................................................................................... 3-48
Table 3-42.TPSPRI values ................................................................................................. 3-48
Table 3-43.UNCRC values ................................................................................................. 3-48
Table 3-44.WAVE FREQUENCY (THz) values ................................................................. 3-49
Table 3-45.WAVELENGTH (nm) values ............................................................................ 3-50
Table 3-46.WORKMODE values of EFS8 ......................................................................... 3-52
Table 3-47.WORKMODE values of EGT2 ......................................................................... 3-52
Table 3-48.XCS PROTECTION SWITCH values .............................................................. 3-52
vi LPS800-UM-COMM-02
ABOUT THIS MANUAL
INTRODUCTION
This manual applies to LoopStar® 800 Series software.
RELATED MANUALS
The following table lists the manuals in the LoopStar 800 Series (LPS-800/LPS-810) suite of documents. In this
document, the LoopStar 800 Series is designated as “LPS-8xx.” The current manual is highlighted.
Manual Usage
LoopStar® 800 Series TL1 Commands Manual Detailed introduction to the TL1 commands used in the LoopStar
800 Series.
LoopStar® 800 Series System Application and Acquaints you with the LoopStar 800 Series and describes how
Engineering Guide to build the required network using the LoopStar 800 Series.
LoopStar® 800 Series WebLCT Introduces configuration and maintenance operations of

LoopStar 800 Series LCT.
LoopStar® 800 Series EMS Operations Introduces configuration and maintenance operations of
LoopStar 800 Series EMS.
LoopStar® 800 Series EMS System Introduces the application, functional characteristics, system
Description architecture, and networking mode of the LoopStar 800 Series
EMS, appended with standards that the LoopStar 800 Series
EMS complies with, abbreviations and performance indices.
LoopStar® 800 Series EMS Installation Introduces installation procedures and FAQs of the LoopStar 800
Manual Series EMS running on Windows 2000 and Solaris 8 platforms.
LoopStar® 800 Series Installation Manual Describes how to install the LoopStar 800 Series.
LoopStar® 800 Series Hardware Description Describes the LoopStar 800 Series system hardware including
Manual chassis, power interface module, fan tray assembly, plug-in units,
and the interfaces.
LoopStar® 800 Series System Administration Describes how to implement and use the LoopStar 800 Series in
Manual a network management system (NMS).
LoopStar® 800 Series Maintenance Manual Describes how to perform routine maintenance and how to
troubleshoot the LoopStar 800 Series system.
LoopStar® 800 Series Alarm and Performance Describes alarm and performance monitoring.
Reference Manual
LPS800-UM-COMM-02 vii
About This Manual July 29, 2005
ORGANIZATION
This manual includes the following chapters:
Chapter Description
Chapter 1: “TL1 Overview” Introduces the TL1 command input command massages,
acknowledgments, output response messages, and autonomous
messages.
Chapter 2: “TL1 Messages Description” Provides descriptions on TL1 commands and autonomous
messages for the LoopStar 800 Series.
Chapter 3: “TL1 Parameters” Introduces the TL1 access identifier (AID) and parameters.
Chapter 5: “Alarms and Values” Lists the alarms, errors, threshold, and performance.
Appendix A: “Product Support” Provides information on how to contact the ADC Technical
Support group.
Appendix B: Glossary Defines abbreviations, acronyms, and terms for the LoopStar 800
Series product line.
INTENDED AUDIENCE
This manual is intended for:
• Operations groups
• Maintenance engineers
CONVENTIONS
The following style conventions and terminology are used throughout this guide.
Element Meaning
Bold font Text that you must input exactly as shown (e.g., type 1 for card 1), menu buttons
(e.g., ACCEPT SHELF OPTIONS) or menu screen options (e.g., ALARMS screen) that
you must select
Italic font Variables that you must determine before inputting the correct value (e.g., Password )
Monospace font References to screen prompts (e.g., Invalid Password...Try Again:.)
Reader Alert Meaning

Alerts you to supplementary information
IMPORTANT Alerts you to supplementary information that is essential to the completion of a task
!
Alerts you to possible equipment damage from electrostatic discharge
ATTENTION
viii LPS800-UM-COMM-02
July 29, 2005 About This Manual
Reader Alert Meaning
CAUTION Alerts you to possible data loss, service-affecting procedures, or other similar type
problems
Alerts you that failure to take or avoid a specific action might result in hardware damage or
WARNING
loss of service
DANGER
Alerts you that failure to take or avoid a specific action might result in personal harm
INSPECTING YOUR SHIPMENT

Upon receipt of the equipment:
• Unpack each container and visually inspect the contents for signs of damage. If the equipment has been dam-
aged in transit, immediately report the extent of damage to the transportation company and to ADC. Order
replacement equipment, if necessary.
• Check the packing list to ensure complete and accurate shipment of each listed item. If the shipment is short
or irregular, contact ADC as described in Appendix A: Product Support on page A-1. If you must store the
equipment for a prolonged period, store the equipment in its original container.
LPS800-UM-COMM-02 ix
About This Manual July 29, 2005
x LPS800-UM-COMM-02
Chapter 1
TL1 OVERVIEW
INPUT COMMAND MESSAGES
This chapter discusses the structure of a TL1 input command message and the functionality of its component parts.
General Format
The general structure of a TL1 input message is of the form:
<COMMAND_CODE>:<STAGING_PARAMETER_BLOCKS>:<MESSAGE_PAYLOAD_BLOCK(S)>;
The <COMMAND_CODE> determines the action (that is, pragmatics) to be taken at the NE as a result of receiving
the input message.
The <STAGING_PARAMETER_BLOCKS> determine the target NE and the identity of the object to be acted upon
by the input message.
The <MESSAGE_PAYLOAD_BLOCK(S)> is the subject matter relating to the action to be performed by the input
message.
The semi-colon character (;) terminates a TL1 input message.
Command Code
Each command must begin with a command code consisting of a mandatory verb followed by up to two other
optional modifiers, each separated by a hyphen (-).
<COMMAND CODE>::=<VERB>[-<MODIFIER>[-<MODIFIER>]]
The <VERB> identifies the action to be taken at the NE as a result of receiving a TL1 message from an OS (for
example, ENT, ED, and RTRV).
The <MODIFIER>s are optional depending upon the specific command and the application domain. In normal TL1
command usage, the first modifier identifies the object of the verb where the action is to be applied in the NE. The
second modifier further modifies the object of the verb and is interpreted differently for different operations domains.
Staging Parameter Blocks

The structure of the staging parameter blocks consists of the following series:
:[<TID>]:[<AID(s)>]:<CTAG>:[GB]:
The target identifier (TID) is a unique name given to each system when it is installed. The name identifies the
particular NE (in this case, the LPS-8xx), to which each command is directed. Each TID can have a maximum of 20
ASCII characters limited to letters, digits, and hyphens, but each TID must start with an alphabetic character. The
presence of the TID is required in all input commands, but its value can be null (represented by two successive
colons). The TID can be null when the operating system directly communicates with the target NE. The
recommended value for the TID, when it is used, is the target’s CLEI code.
The access identifier (AID) is an access code used to identify and address specific objects within the LPS-8xx.
These objects include individual pieces of equipment, transport spans, access tributaries, and other objects.
The correlation tag (CTAG) is a unique identifier given to each input command by the operator. When the LPS-8xx
system responds to a specific command, it includes the command’s CTAG in the reply.
LPS800-UM-COMM-02 1-1
Chapter 1: TL1 Overview July 29, 2005
The general block (GB) includes support parameters whose values affect the way in which the input command is to
be executed in the LPS-8xx. The presence of the GB in all input commands is a requirement but its value may be
null (that is, the GB is represented by two successive colons).
Message Payload
The remaining part of any TL1 input command is the payload or subject matter of the message. This section of the
message may consist of zero or more data blocks.
The data items within a data block may either be name-defined (of the form <KEY_WORD>=<VALUE>) or position-
defined where the values are specified and the keyword is implied by its position in the data block. All of the data
items must be of the same type within a given data block. The semantics of the data items are operation domain-
specific and vary according to the operation to be performed as a result of the input message.
ACKNOWLEDGMENTS
There are three types of TL1 output messages: acknowledgments, output response messages, and autonomous
messages. This section deals with acknowledgments, section Output Response Messages on page 1-3 describes
output response messages, and section Autonomous Messages on page 1-5 describes autonomous messages.
General Format
An acknowledgment is a brief output message generated in response to an input command message. In general, an
acknowledgment is later followed by an output response message to the command. However, in some
circumstances, an acknowledgment is the only output message triggered by a command.
Each of these acknowledgments follows the 2-second rule, which states that an acknowledgment should be used if
an output response message to the command cannot be transmitted within 2 seconds of its receipt.
The format of an acknowledgment is as follows:
<ACKNOWLEDGMENT CODE>^<CTAG><cr><lf>
<
The <ACKNOWLEDGMENT CODE> identifies the reason for the acknowledgment. The <CTAG> identifies the
associated input command. The less than (<) character is the acknowledgment terminator. The valid values for
acknowledgment codes and their meanings are given in the following subsections.
In Progress (IP) and Printout Follows (PF)

The request has been initiated. These acknowledgments should produce subsequent output messages that give a
termination report alone or a termination report and results of the command.
These acknowledgments imply that the command is being executed. They are used often for test and access
messages requiring a long execution time, for example, a 1-minute noise test. These acknowledgments may be
followed by either completed or denied output response messages.
All Right (OK)

The command was received and the requested action was initiated and completed.
Specific uses for the OK acknowledgment are defined in message set criteria documents (for example, GR-199-
CORE, GR-833-CORE, and GR-834-CORE). In addition, OK is used in response to a command that has been
canceled by inclusion of the CAN (cancel) character.
1-2 LPS800-UM-COMM-02
July 29, 2005 Chapter 1: TL1 Overview
No Acknowledgment (NA)
Under abnormal conditions, NA should be sent when a command has been accepted but control of the processing
has been lost, making correct acknowledgment impossible. Initiation or execution of the requested command is
uncertain.
This acknowledgment should be used only in dire circumstances since the state of execution status is unknown.
This acknowledgment can also be used to respond to a command that is garbled during transmission. If the CTAG
value of the command could not be determined, then the single character zero (0) should be used as the
acknowledgment CTAG value.
No Good (NG)
The command is valid, but the requested action conflicts with current system or equipment status (for example, an
attempt to restore an in-service unit). For inadequate system resources, use RL instead of NG.
This acknowledgment is seldom used because specific error codes in output response messages can be employed
to signify the same information. However, it can be used if desired.
Repeat Later (RL)

The requested action cannot be executed due to unavailable system resources caused by system overload,
excessive queue lengths, busy programs, and so on. The command may be entered again later.
OUTPUT RESPONSE MESSAGES

This section describes the structure of a TL1 output response message and the functionality of its component parts.
A TL1 output response message is the response to a TL1 input command message.
General Format
The general structure of a TL1 output response message is of the form
<HEADER><RESPONSE IDENTIFICATION>[<TEXT BLOCK>]<TERMINATOR>
The <HEADER> represents information common to all output response messages; that is, it is independent of the
type of output response.
The <RESPONSE IDENTIFICATION> identifies the type of output response message. Five types of output
response messages are defined in this document.
The <TEXT BLOCK> represents information specific to the particular output response message. This component is
optional.
The <TERMINATOR> indicates the termination or continuation of the output response message.
The following sections further describe the structure of the above component constructs.
Header
The form of the header is
<cr><lf><lf>^^^<SID>^<YEAR>-<MONTH>-<DAY>^<HOUR>:<MINUTE>:<SECOND>
The source identifier (SID) is restricted to 20 characters maximum and identifies the LPS-8xx generating the
message.
The <SID> value is checked by the NE against the TID parameter of the input command to verify that the NE's SID
matches the command's intended target (that is, TID).
The <YEAR>-<MONTH>-<DAY> construct generally represents the day on which the command is executed.
The <HOUR>:<MINUTE>:<SECOND> construct generally represents the time when the command is executed.
Response Identification
The form of the response identification is
<cr><lf>M^^<CTAG>^<COMPLETION CODE>
The character M signifies that the message is the response to an input command message.
The output response message shall have the same <CTAG> value as the corresponding input command message
for enabling the OS to associate the received output response message with a previously sent command.
The <COMPLETION CODE> are COMPLD, DENY, PRTL, DELAY, and RTRV. The semantics of the completion
codes are:
COMPLD Represents total successful execution of the input command.

DENY Represents total denial of the input command.
PRTL Represents partial successful execution of the input command. This
response code shall be returned for output response to input
commands specifying multiple AID of which only a subset (but not
an empty subset) has been successfully executed If all AIDs have
failed to be executed, the response code shall be DENY. This
response code is valid when the contingency flag in the general
block is false (that is, best effort).
DELAY Represents successful queuing of the input command submitted for
delayed activation.
RTRV1 Represents output response of an input retrieve command (that is,
with command verb RTRV) that retrieves extensive amount of
information from the NE and thus causes lengthy processing in the
NE for gathering all the requested information. For effective
operation, the NE may start returning available information to the
OS even before all the requested information is gathered. In this
case, the RTRV completion code may be used. Multiple responses
with RTRV completion codes are permitted for the same RTRV
command, but the final response must have a COMPLD completion
code.
1
The use of this completion code depends on the application domain.
When the CTAG of an input command cannot be identified (for example, during dial-up asynchronous connections
with noise and errors prevalent), either the 2-letter acknowledgment NA may be returned or the DENY response
containing the appropriate error message with the CTAG set to the single character zero (0) may be returned.
Text Block
The form of the response text is
((<cr><lf>^^^<UNQUOTED LINE>)|(<cr><lf>^^^”<QUOTED LINE>”)| (<cr><lf>^^^/*<COMMENT>*

/))*
The <UNQUOTED LINE> consists of name- or position-defined parameters. The unquoted line is for representing
error codes in some response messages. The error code is specified by four characters that may contain numerals
after the first character, if appropriate. Section “4.2 Errors List” shows a list of existing error codes. These error
codes have been used in various TL1 message documents.
The <QUOTED LINE> consists of parable text and shall always be preceded and followed by the double-quote
character (''). The syntax of the parsable text is equivalent to that of an input command message.
The <COMMENT> component is used to allow free format (that is, human readable, not machine parsable) text.
The free form text shall always be preceded by the pair of characters slash asterisk (/*) and followed by the pair of
characters asterisk slash (*/).
Terminator
The form of the terminator is
<cr><lf>(;|>)
The semicolon (;) character is used to indicate the termination of the output response message. The greater than (>)
character is used to indicate that more output associated with this response will follow under another header.
It is a requirement that the size of an output message shall not exceed 4096 bytes.
AUTONOMOUS MESSAGES
An autonomous message is a message that is sent from the NE to the appropriate OS without having an explicit
input message associated with it (such as the normal Input Command / Output Response message pair). Typical
scenarios where autonomous messages are used include:
• Reporting of alarmed and/or non-alarmed trouble events

• Reporting of scheduled diagnostic tests in the NE
• Reporting of Performance Monitoring Data
• Reporting of a change in the NE's database
• Periodic reporting of selected NE conditions
General Format
The general structure of a TL1 autonomous message is
<HEADER><AUTO ID>[<TEXT BLOCK>]<TERMINATOR>
The <HEADER> represents information common to all output response and autonomous messages.
The <AUTO ID> identifies the severity and the nature of the autonomous message. The severity is indicated through
the use of an alarm code, which will be discussed in further detail.
The <TEXT BLOCK> represents information specific to the particular autonomous message. This entry is optional
and will be discussed in further detail.
The <TERMINATOR> indicates the completion or continuation of the autonomous message. This entry is required
in all types of TL1 messages.
Header
The <HEADER> is the standard response header that is defined in Output Response Messages on page 1-3. It
contains system identifier SID, and date and time stamps. The header is a required entry in all TL1 output response
and autonomous messages. For a more detailed explanation of its parameters and syntax, see Header on page 1-3.
Identification of Output (AUTO ID)

The auto id entry for an autonomous message is of the following form
<cr><lf><ALMCDE>^<ATAG>^<VERB>[^<MODIFIER>[^<MODIFIER>]]
1. Alarm code (ALMCDE)

<ALMCDE> is the alarm code. The alarm code indicates the severity of the autonomous message. Valid
values for <ALMCDE> in decreasing order of severity are as follows:
*C Critical alarm
** Major alarm
*^ Minor alarm
A^ Non-alarm message
Critical, Major, and Minor correspond to the reporting of alarmed events. The Non-alarm message designa-
tion is used when the NE is reporting non-alarmed events, periodic measurements, or results of previously
scheduled diagnostics or audits.
If multiple alarms are reported in the same message, the alarm code is the highest severity of those being
reported.
2. Autonomously generated correlation tag (ATAG)
<ATAG> is a decimal number made up of an integer part and an optional fractional component. The
<ATAG> serves two purposes.
• It allows an OS to determine if it has failed to receive any spontaneous outputs by checking for omissions
in the sequence of messages received.
• It allows an OS to correlate spontaneous outputs triggered by a common problem. (To accomplish this,
the NE involved must be capable of recognizing and categorizing common problems.)
3. Verb and modifier
The <VERB>[^<MODIFIER>[^<MODIFIER>]] entry identifies the nature of the spontaneous output and
allows for quick identification of the semantics of the information in the text block.
The <VERB> is the autonomous message verb and is a required entry. In most cases, the verb in an
autonomous message will be REPT (Report). The autonomous message verb can have up to two optional
<MODIFIER>s. The first modifier is used to modify the verb. The second modifier is used to specify the
object generating the message.
Text Block
The optional <TEXT BLOCK> is used to represent information specific to the particular autonomous message. The
format of the text block is as follows:
((<cr><lf>^^^<UNQUOTED LINE>)|(<cr><lf>^^^<QUOTED LINE>)| (<cr><lf>^^^<COMMENT>))+
A more complete description of the individual components is in Text Block on page 1-5.
Terminator
The <TERMINATOR> block has the form
<cr><lf>(;|>)
and is required as the termination block for all TL1 message types. For more information regarding message size,
completion, and continuation designations, see “Terminator” on page 1-5.
MESSAGE SUMMARY
The following table lists all LoopStar commands and autonomous messages. A brief description of the message is
provided along with a designation of the corresponding LPS version(s) to which the message applies.
Table 1-1. TL1 Message Summary

Commands/Messages Description LoopStar Version(s) Page No.
ABT-CMD Aborts SWDL, DBFDL, or DBFUL processing. LPS800, LPS810 2-16
ACT-USER Enables a user to operate the NE. LPS800, LPS810 2-18
ALW-LPBK-<T1/T3> Allows far-end loopback of T1/T3 port in the LPS800, LPS810 2-19
transmux unit.
ALW-MSG-ALL Instructs the NE to enter a mode in which all LPS800, LPS810 2-20
the REPT ALM and REPT EVT autonomous
messages are reported.
ALW-MSG-DBCHG Enables REPT DBCHG. LPS800, LPS810 2-21
ALW-PMREPT-ALL Instructs an NE to resume processing those LPS800, LPS810 2-23
PM reports that are inhibited.
ALW-SWDX-EQPT Allows automatic or manual switching on a LPS800 2-24
system containing duplex or redundent
equipment.
ALW-USER-SECU Used by a super user to allow (i.e., reinstate) a LPS800, LPS810 2-25
UID that has been disabled by the INH-USER-
SECU command, so the user can establish a
session with the NMS again.
CANC-USER Logs a user off the NE. LPS800, LPS810 2-26
CHG-TACC-<T1/T3> Changes the test access (TACC) mode for the LPS800 2-27
circuit being tested.
COMMIT-SW Commits the new downloaded software LPS800, LPS810 2-29
package.
CONN-TST-<T1/T3> Sets up the bit sequence test connection with LPS800, LPS810 2-30
all necessary settings for the internal bit
sequence generator and detector.
COPY RFILE Downloads a new software package from the LPS800, LPS810 2-33
location specified by the FTP URL.
CPY-MEM Copies a file from RAM disk to Flash. LPS800, LPS810 2-36
DISC-TST-<T1/T3> Instructs NE to release the test connection. LPS800, LPS810 2-37
DLT-CAR Deletes an entry of the CAR of unit. LPS800, LPS810 2-38
DLT-COS Deletes a COS in the unit. LPS800, LPS810 2-39
DLT-CRS-<STS_PATH> Deletes a cross connection with a cross LPS810 2-40
connection type.

DLT-CRS-<STS_PATH/ Deletes a cross connection with a cross LPS800 2-43
VT_PATH> connection type.
DLT-CRS-DCC Deletes a DCC cross channel. LPS800, LPS810 2-46
DLT-CRS-OHBYTE Deletes an overhead byte cross. LPS800, LPS810 2-48
DLT-EQPT Deletes a unit from a slot in the NE. LPS800, LPS810 2-49
DLT-EQPT-PG Deletes the specified equipment protection LPS800 2-50
group.
DLT-ETHLINK Deletes an Ethernet link in the unit. LPS800, LPS810 2-52
DLT-FFP-<OCN> Provides for disconnecting members of or an LPS800, LPS810 2-53
entire optical facility protection group.
DLT-FLOW Deletes a flow entry of the unit. LPS800, LPS810 2-54
DLT-IPROUTE-STATIC Deletes static routes from the route table. LPS800, LPS810 2-56
DLT-RFILE Deletes one file in the NE. LPS800, LPS810 2-57
DLT-SNMPTRAPINFO Deletes the SNMP trap information. LPS800, LPS810 2-58
DLT-SQL-<STS_PATH> Deletes the squelch table entries on demand LPS800 2-59
for the addressed NE.
DLT-TIDIPMAP Deletes a static TID-IP mapping. LPS810 2-60
DLT-USER-SECU Deletes a user in the NE. LPS800, LPS810 2-61
ED-<OCN> Edits the attributes of an OC-N (OC3, OC12) LPS800, LPS810 2-63
facility.
ED-<STS_PATH> Edits the attributes associated with an STS LPS800, LPS810 2-65
path (STS1, STS3C, STS6C, STS9C,
STS12C).
ED-<VT_PATH> Edits the attributes associated with a VT LPS800, LPS810 2-68
(VT1.5/VT2) path.
ED-BITS Edits the attributes of an NE’s external clock. LPS800 2-69
ED-CAR Edits the CAR attribute. LPS800, LPS810 2-73
ED-COS Edits a class of service (COS) attribute in the LPS800, LPS810 2-74
unit.
ED-CRS-<STS_PATH> Edits the attributes of a normal cross LPS810 2-76
connection.
ED-CRS-<STS_PATH/ Edits the attributes of a normal cross LPS800 2-79
VT_PATH> connection.
ED-DAT Sets the date and the time. LPS800, LPS810 2-81
ED-DCC Edits the link protocol type of a DCC channel. LPS800, LPS810 2-83
ED-EQPT Edits the unit type and attributes for a given LPS800, LPS810 2-84
equipment slot in the NE.
ED-EQPT-PG Edits the attribute of an equipment protection LPS800 2-86
group.
ED-ETH-EQPT Edits the Ethernet attributes in the unit. LPS800, LPS810 2-87
ED-FETH Edits the attribute of a fast Ethernet port. LPS800, LPS810 2-88
ED-FFP-<OCN> Edits the attributes of an optical facility LPS800, LPS810 2-90
protection group.

ED-FLOW Edits a flow entry of the unit. LPS800, LPS810 2-93
ED-GETH Edits the attribute of a Gigabit Ethernet port. LPS800 2-94
ED-LAN Edits the attributes and state of a LAN facility. LPS800, LPS810 2-97
ED-NEID Edits the ID number of a NE. LPS800, LPS810 2-99
ED-OSPF-DCC Edits the DCC-type interface(s) parameters of LPS800, LPS810 2-100
OSPF protocol.
ED-OSPF-LAN Edits the LAN-type interface(s) parameters of LPS800, LPS810 2-101
OSPF protocol.
ED-OSPF-SYS Edits the system parameters of OSPF LPS800, LPS810 2-102
protocol.
ED-PID Modifies a user password. LPS800, LPS810 2-104
ED-RIP-DCC Modifies the DCC-type interface(s) LPS800, LPS810 2-105
parameters of RIP protocol.
ED-RIP-LAN Modifies the LAN-type interface(s) parameters LPS800, LPS810 2-106
of RIP protocol.
ED-RIP-SYS Modifies the system parameters of RIP LPS800, LPS810 2-108
protocol.
ED-RMONALMCTRL- Edits the parameters of an alarm table which LPS800, LPS810 2-110
<MOD2> contains the parameters that affect the
condition of report events.
ED-RMONHISTCTRL- Edits all history control parameters. LPS800, LPS810 2-111
<MOD2>
ED-SERIAL Edits the attributes and state of the serial port. LPS800, LPS810 2-113
ED-SQL-<STS_PATH> Manually edits the squelch table entry at the LPS800 2-115
addressed node.
ED-SYNC Edits the attributes of one synchronization LPS800, LPS810 2-116
reference list of NE.
ED-SYNCLIST Edits the synchronization reference list that LPS800, LPS810 2-118
the system clock can track in.
ED-SYS Edits the attributes of the system. LPS800, LPS810 2-120
ED-T1 Edits the attributes associated with the DS1/ LPS800, LPS810 2-122
T1 port.
ED-T3 Edits the attributes associated with the DS3/ LPS800, LPS810 2-123
T3 port.
ED-TPL-<OCN> Manually edits the topology map at the LPS800, LPS810 2-125
addressed node.
ED-USER-SECU Edits a user's attributes. LPS800, LPS810 2-126
ED-VCG Edits the attribute of a virtual concatenation LPS800, LPS810 2-128
group.
ENT-CAR Creates an entry of the CAR of unit. LPS800, LPS810 2-131
ENT-COS Creates a class of service (COS) in the unit. LPS800, LPS810 2-133
ENT-CRS-<STS_PATH> Creates a cross connection with a cross LPS810 2-134
connection type.

ENT-CRS-<STS_PATH/ Creates a cross connection with a cross LPS800 2-137
VT_PATH> connection type.
ENT-CRS-DCC Creates a DCC cross channel. LPS800, LPS810 2-140
ENT-CRS-OHBYTE Creates an overhead byte cross. LPS800, LPS810 2-142
ENT-EQPT Enters the unit type and attributes for a given LPS800, LPS810 2-143
equipment slot in the NE.
ENT-EQPT-PG Creates an equipment protection group. LPS800 2-145
ENT-ETHLINK Creates an Ethernet link in the unit. LPS800, LPS810 2-147
ENT-FFP-<OCN> Used to create an optical facility protection LPS800, LPS810 2-148
group.
ENT-FLOW Enters a flow entity of the unit. LPS800, LPS810 2-151
ENT-IPROUTE-STATIC Adds static routes to the route table. LPS800, LPS810 2-152
ENT-SQL-<STS_PATH> Manually enters the squelch table entry at the LPS800 2-154
addressed node.
ENT-TIDIPMAP Creates a static TID-IP mapping entry. LPS800, LPS810 2-155
ENT-USER-SECU Adds a user account to operate the NE. LPS800, LPS810 2-156
INH-LPBK-<T1/T3> Inhibits far-end loopback, and if the AID is LPS800, LPS810 2-158
NULL, it applies to the whole NE.
INH-MSG-ALL Inhibits all REPT ALM and REPT EVT LPS800, LPS810 2-159
autonomous messages from being
transmitted.
INH-MSG-DBCHG Inhibits REPT DBCHG. LPS800, LPS810 2-160
INH-PMREPT-ALL Instructs an NE to enter a mode in which all LPS800, LPS810 2-161
PM reporting is inhibited.
INH-SWDX-EQPT Inhibits automatic or manual switching on a LPS800 2-163
system containing duplex equipment.
INH-USER-SECU Used by an appropriate administrator to inhibit LPS800, LPS810 2-164
user access.
INIT-LOG Initializes a specified log of the NE. LPS800, LPS810 2-165
INIT-REG-<MOD2> Instructs an NE to initialize one or more LPS800, LPS810 2-166
storage registers or event counters associated
with an equipment unit, facility in the NE to a
specific value.
INIT-RMONHIST- Clears history counters specified by LPS800, LPS810 2-168
<MOD2> MONTYPE in the statistics table.
INIT-RMONSTAT- Clears counters specified by MONTYPE in the LPS800, LPS810 2-170
<MOD2> statistics table.
INIT-SQL-<OCN> recreates the squelch table entries on demand LPS800, LPS810 2-172
for the addressed NE.
INIT-STAT-DCC Clears the DCC information of an OC-N LPS800, LPS810 2-174
facility, including the data transmitting
information and error information.
INIT-SYS Reboots a single unit or the whole system. LPS800, LPS810 2-175

INIT-TPL-<OCN> Recreates the topology on demand for the LPS800, LPS810 2-176
entire ring.
OPR-ACO-ALL Instructs an NE to cut off the office audible LPS800, LPS810 2-177
alarm indications without changing the local
alarm indications.
OPR-EXT-CONT Instructs an NE to operate an external control. LPS800 2-179
OPR-LPBK-<FETH> Instructs an NE to operate a loopback on a LPS810 2-180
specified Ethernet port.
OPR-LPBK-<FETH/ Instructs an NE to operate a loopback on a LPS800 2-182
GETH> specified Ethernet port.
OPR-LPBK-<OCN/T1/ Instructs an NE to operate a loopback on a LPS800, LPS810 2-183
T3/STS_PATH> specified port or path.
OPR-PROTNSW-<OCN> Operates a protection switch. LPS800, LPS810 2-185
OPR-PROTNSW- Instructs an NE to execute an external switch LPS810 2-186
<STS_PATH> command.
OPR-PROTNSW- Instructs an NE to execute an external switch LPS800 2-188
<STS_PATH/VT_PATH> command.
OPR-PROTNSW-EQPT Instructs the NE to perform an equipment unit LPS800 2-189
protection switch.
OPR-SYNCNSW Used to instruct a NE to switch LPS800, LPS810 2-191
synchronization references.
REPT ACCESS Gives a warning to the login user who cannot LPS800, LPS810 2-192
WARNING operate the NE legally.
REPT ALM <MOD2> Generated by the NE to inform the OS of the LPS800, LPS810 2-193
occurrence of an alarm condition from a
facility, path or equipment.
REPT ALM ENV Generated by the NE to inform the OS of the LPS800, LPS810 2-195
occurrence of an environmental alarm.
REPT DBCHG Generated by the NE to inform the OS of the LPS800, LPS810 2-197
change of database.
REPT EVT <MOD2> Generated by the NE to inform the OS of the LPS800, LPS810 2-198
occurrence of a event condition from a facility,
a path, or equipment.
REPT EVT ACTIVATED Reports that the whole system works well after LPS800, LPS810 2-200
INIT-SYS command is used to activate the
new software.
REPT EVT Reports that event board (unit) matching LPS800, LPS810 2-201
BDMATCHFAILED failed.
REPT EVT Reports that there is no software in new LPS800, LPS810 2-201
BDNOMATCHHW package to match the hardware version (unit
type or PCB version) of a unit.
REPT EVT COMMITEND Reports successful use of the commit LPS800, LPS810 2-202
command.
REPT EVT Reports unsuccessful use of the commit LPS800, LPS810 2-203
COMMITFAILED command.

REPT EVT Reports completion of the CPY-MEM LPS800, LPS810 2-203
CPYMEMEND command.
REPT EVT FXFR Reports completion of the file transfer. LPS800, LPS810 2-205
REPT EVT FXFRHALT Reports link break event when transferring LPS800, LPS810 2-206
files using a COPY-RFILE.
REPT EVT NOSWINPKG Reports there is no software in the package LPS800, LPS810 2-207
for a unit.
REPT EVT PROGRESS Reports the rate of completion of command LPS800, LPS810 2-208
COPY-RFILE or CPY-MEM.
REPT EVT Reports that SWDL has been aborted and the LPS800, LPS810 2-209
ROLLBACKEND system has rolled back to the old version of
the software package.
REPT EVT Reports that when an error occurs in the LPS800, LPS810 2-210
ROLLBACKSTART system during SWDL, the system begins to
roll back to the old software package.
REPT EVT SECU Reports that the user password is out of time LPS800, LPS810 2-211
when the user attempts to login.
REPT EVT Reports when errors occur during the software LPS800, LPS810 2-212
SLVMATCHFAILED version matching process of the XO unit.
REPT EVT Reports when there is no software in the new LPS800, LPS810 2-213
SLVNOMATCHHW package that matches the hardware version
(unit type or PCB version) of the XO unit.
REPT EVT VBLP Reports the STP state of virtual bridge logical LPS800, LPS810 2-214
port.
REPT EVT VCG Reports the link capacity adjustment scheme LPS800, LPS810 2-215
(LCAS) member state of VCG.
REPT LOGOFF Reports the logoff event to a user who has LPS800, LPS810 2-216
been logged off.
REPT PM <MOD2> Generated by an NE to inform the OS or LPS800, LPS810 2-217
maintenance personnel of PM information.
REPT RMON FALLING Reports the falling event of RMON. LPS800, LPS810 2-219
REPT RMON RISING Reports the rising event of RMON. LPS800, LPS810 2-220
REPT RSLT <T1/T3> Reports the bit sequence test result. LPS800, LPS810 2-221
REPT SW Reports the event of XCS protection switch. LPS800 2-222
RLS-EXT-CONT Instructs an NE to close an external control. LPS800 2-222
RLS-LPBK-<FETH> Instructs NE to release a loopback on a LPS810 2-224
specified Ethernet port.
RLS-LPBK-<FETH/ Instructs NE to release a loopback on a LPS800 2-225
GETH> specified Ethernet port.
RLS-LPBK-<OCN/T1/T3/ Instructs NE to release a loopback on a LPS800, LPS810 2-227
STS_PATH> specified port (OC-N, DS1, DS3 or STS-N).
RLS-PROTNSW-<OCN> Instructs a SONET NE to release (clear) a LPS800, LPS810 2-228
SONET OC-N line protection switch request
between a working line and a protection line
that was established.

RLS-PROTNSW- Instructs NE to release a SONET path LPS810 2-229
<STS_PATH> protection switch request that was established
with the external command.
RLS-PROTNSW- Instructs NE to release a SONET path LPS800 2-231
<STS_PATH/VT_PATH> protection switch request that was established
with the external command.
RLS-PROTNSW-EQPT Instructs the NE to release an equipment unit LPS800 2-232
protection switch.
RLS-SYNCNSW Used to release a pending manual switch or LPS800, LPS810 2-233
lockout operation that has initialed by OPR-
SYNCNSW command.
RMV-<OCN/T1/T3/ Changes the service state of the specified port LPS800, LPS810 2-235
STS_PATH> (optical or electrical port) to out of service -
Maintenance (OOS-MA, MT).
RST-<OCN/T1/T3/ Instructs an NE to restore facility to service. LPS800, LPS810 2-236
STS_PATH>
RTRV-RMONHISTCTRL- Retrieves the parameters of history control LPS800, LPS810 2-237
<MOD2> table.
RTRV-<OCN> Retrieves attributes of the OC-N facility. LPS800, LPS810 2-239
RTRV-<STS_PATH> Retrieves the attributes of the STS path with LPS800, LPS810 2-242
entered AID.
RTRV-<VT_PATH> Retrieves the attributes of VT path with LPS800, LPS810 2-245
entered AID.
RTRV-ALM-<MOD2> Retrieves alarm of facility or path. LPS800, LPS810 2-247
RTRV-ALM-ENV Requests that an NE retrieve specified LPS800, LPS810 2-250
environmental alarms.
RTRV-AO Allows the OS to retrieve a copy of a queued LPS800, LPS810 2-252
autonomous message or a missing
autonomous message.
RTRV-ATTR-<MOD2> Instructs an NE to send the current notification LPS800, LPS810 2-254
code associated with the specified events.
RTRV-ATTR-CONT Retrieves the attributes associated with an LPS800 2-257
external control.
RTRV-ATTR-ENV Requests that an NE send the attributes LPS800, LPS810 2-259
associated with an environmental alarm.
RTRV-BACKUP-INFO Instructs NE to retrieve the state of LPS800 2-261
synchronization.
RTRV-BITS Used to retrieve the attributes of NE’s external LPS800 2-262
clock.
RTRV-CAR Retrieves the CAR attribute. LPS800, LPS810 2-265
RTRV-COND-<MOD2> Retrieves the current standing condition and LPS800, LPS810 2-267
state associated with an entity.
RTRV-COS Retrieves a COS in the unit. LPS800, LPS810 2-270
RTRV-CRS Retrieves the proper attributes for all cross LPS800, LPS810 2-272
connections in the specified NE.

RTRV-CRS- Retrieves the proper attributes for the STS LPS810 2-273
<STS_PATH> path cross connections.
RTRV-CRS- Retrieves the proper attributes for the STS LPS800 2-275
<STS_PATH/VT_PATH> path cross connections.
RTRV-CRS-OHBYTE Retrieves the cross information of overhead LPS800, LPS810 2-277
bytes.
RTRV-DAT Retrieves the time and date parameters of NE. LPS800, LPS810 2-279
RTRV-DCC Retrieves the DCC attributes and its protocol LPS800, LPS810 2-280
type.
RTRV-EQPT Retrieves all the attributes of a given LPS800, LPS810 2-282
equipment unit.
RTRV-EQPT-PG Retrieves the parameters for the specified LPS800 2-284
equipment protection group.
RTRV-ETH-EQPT Retrieves the Ethernet attributes in the unit. LPS800, LPS810 2-286
RTRV-ETHLINK Retrieves an Ethernet link in the unit. LPS800, LPS810 2-287
RTRV-ETH-VER Retrieves the version of Ethernet NE software. LPS800, LPS810 2-289
RTRV-EXIST-SYNC Retrieves the existing synchronization LPS800, LPS810 2-290
reference sources.
RTRV-EXT-CONT Instructs an NE to send the control state of an LPS800 2-292
external control.
RTRV-FETH Retrieves the attributes of an Ethernet port. LPS800, LPS810 2-293
RTRV-FFP-<OCN> Retrieves the attributes of an optical facility LPS800, LPS810 2-295
protection group.
RTRV-FFP-ALL Retrieves the attributes of all the optical facility LPS800, LPS810 2-298
protection groups regardless of SONET line
protection.
RTRV-FLOW Retrieves a flow entry of the unit. LPS800, LPS810 2-301
RTRV-GETH Retrieves the attributes of a Gigabit Ethernet LPS800 2-303
port.
RTRV-HDR Requests that an NE simply reply with a LPS800, LPS810 2-305
normal response indicating COMPLD, along
with information that the NE has about itself,
namely the <SID>, <DATE>, and <TIME>.
RTRV-IP-ROUTE Retrieves all the information of route. LPS800, LPS810 2-306
RTRV-IPROUTE- Retrieves all the information of static IP route. LPS800, LPS810 2-308
STATIC
RTRV-LAN Retrieves the attributes and state of an LAN LPS800, LPS810 2-309
facility.
RTRV-LOG Retrieves the log of the NE. LPS800, LPS810 2-310
RTRV-LPBK-<FETH> Retrieves the loopback state of the Ethernet LPS810 2-312
port.
RTRV-LPBK-<FETH/ Retrieves the loopback state of the Ethernet LPS800 2-313
GETH> port.

RTRV-LPBK- <OCN/T1/ Retrieves the loopback state of the OCN/T1/ LPS800, LPS810 2-315
T3/STS_PATH> T3 port or STS path.
RTRV-LPBKFEAC-<T1/ Retrieves whether the far end loopback is LPS800, LPS810 2-316
T3> allowed.
RTRV-NEID Retrieves the ID number of an NE. LPS800, LPS810 2-317
RTRV-OSPF-ALL Retrieves all parameters of OSPF protocol LPS800, LPS810 2-318
(include OSPF-SYS, OSPF-DCC and
OSPF-LAN).
RTRV-PKGVER Retrieve the versions of the software package LPS800, LPS810 2-321
active program.
RTRV-PM-<MOD2> Instructs an NE to send its current set of PM LPS800, LPS810 2-322
data associated with one or more equipment
units, facilities, links, or signaling links within
the NE.
RTRV-PMDAY Retrieves the start time of daily PM data LPS800, LPS810 2-326
collection period.
RTRV-RFILE Retrieves a list of files in the NE. LPS800, LPS810 2-327
RTRV-RIP-ALL Retrieves all the parameters of RIP protocol LPS800, LPS810 2-329
(including RIP-SYS, RIP-DCC, RIP-LAN).
RTRV-RMONALMCTRL- Retrieves the parameters of alarm table which LPS800, LPS810 2-331
<MOD2> contains the parameters that affect the
condition of report events.
RTRV-RMONHIST- Retrieves the performance history. LPS800, LPS810 2-333
<MOD2>
RTRV-RMONSTAT- Retrieves the current performance messages. LPS800, LPS810 2-335
<MOD2>
RTRV-RSLT-<T1/T3> Retrieves the result of bit sequence test LPS800, LPS810 2-336
connection with all necessary settings for the
internal bit sequence generator and detector.
RTRV-SERIAL Retrieves serial parameters. LPS800, LPS810 2-337
RTRV-SNMPTRAPINFO Retrieves the SNMP trap information. LPS800, LPS810 2-338
RTRV-SQL- Retrieves the squelch table entries for the LPS800, LPS810 2-340
<STS_PATH> addressed NE.
RTRV-STAT-DCC Retrieves the DCC information of a OC-N LPS800, LPS810 2-341
facility, including the data transmitting
information and error information.
RTRV-STATE Retrieves the system state during software LPS800, LPS810 2-343
downloading (SWDL).
RTRV-STAT-TCP Retrieves all the TCP connections information. LPS800, LPS810 2-345
RTRV-SYNC Retrieves the attributes of one or all LPS800, LPS810 2-346
synchronization reference lists of NE.
RTRV-SYNCLIST Retrieves the synchronization reference list LPS800, LPS810 2-349
and the attributes of the reference source that
is in the list.
RTRV-SYS Retrieves the attributes of the system. LPS800, LPS810 2-351

RTRV-T1 Retrieves attributes of the DS1 facilities. LPS800, LPS810 2-353
RTRV-T3 Retrieves the DS3 facilities configuration. LPS800, LPS810 2-354
RTRV-TACC Retrieves details associated with a test access LPS800 2-357
port (TAP).
RTRV-TH-<MOD2> Instructs an NE to send the current threshold LPS800, LPS810 2-359
level of one or more monitored parameters for
which violation will trigger an automatic
message.
RTRV-TH-ALL Instructs an NE to send the current threshold LPS800, LPS810 2-362
level of all monitored parameters for which
violation will trigger an automatic message.
RTRV-TIDIPMAP Retrieves all the static TID-IP mapping LPS800, LPS810 2-364
information.
RTRV-TOD Retrieves the system date and time at the LPS800, LPS810 2-365
instant when the command was executed.
RTRV-TPL-<OCN> Retrieves the topology map at the addressed LPS800, LPS810 2-368
node.
RTRV-TST-<T1/T3> Retrieves the bit sequence test connection. LPS800, LPS810 2-369
RTRV-USER-SECU Retrieves the security attributes of a user. LPS800, LPS810 2-372
RTRV-VCG Retrieves the attribute of a virtual LPS800, LPS810 2-374
concatenation group.
SET-ATTR-<MOD2> Instructs an NE to set the notification code LPS810 2-377
associated with the specified event.
SET-ATTR-ENV Requests the NE or office environment LPS800, LPS810 2-379
monitor set the attributes associated with an
environmental alarm.
SET-PMDAY Allows the start time of the daily PM data LPS800, LPS810 2-381
collection period to begin at any hour of the
day.
SET-SID Instructs the NE to change its system LPS800, LPS810 2-383
identification code to given value.
SET-TH-<MOD2> Instructs an NE to set the threshold level for a LPS800, LPS810 2-384
monitored parameter that, when exceeded,
will trigger an automatic message.
SW-DX-EQPT Instructs NE to execute an XCS unit protection LPS800 2-386
switch.
Chapter 2
TL1 MESSAGES DESCRIPTION
This chapter provides descriptions on TL1 commands and autonomous messages for the LPS-8xx system,
including:
• TL1 messages by category
• TL1 messages by units
• TL1 messages by categories and units
• TL1 messages by alphabetization
For information on command parameters, please refer to “TL1 Parameters” on page 3-1.
TL1 MESSAGES BY CATEGORY

Table 2-1. TL1 messages by category
Category Commands or Autonomous Messages
Alarm and Condition ALW-MSG-ALL
ALW-MSG-DBCHG
INH-MSG-ALL
INH-MSG-DBCHG
OPR-ACO-ALL
OPR-EXT-CONT
REPT ALM <MOD2>
REPT ALM ENV
REPT EVT <MOD2>
REPT EVT VCG
REPT DBCHG
RTRV-ALM-<MOD2>
RTRV-ALM-ENV
RTRV-AO
RTRV-ATTR-<MOD2>
RTRV-ATTR-CONT
RTRV-ATTR-ENV
RTRV-COND-<MOD2>
RTRV-SNMPTRAPINFO
SET-ATTR-<MOD2>
SET-ATTR-CONT
SET-ATTR-ENV
Chapter 2: TL1 Messages Description July 29, 2005

Communication DLT-CRS-DCC
DLT-CRS-OHBYTE
DLT-TIDIPMAP
ED-DCC
ED-LAN
ED-OSPF-DCC
ED-OSPF-LAN
ED-OSPF-SYS
ED-RIP-DCC
ED-RIP-LAN
ED-RIP-SYS
ED-SERIAL
ENT-CRS-DCC
ENT-CRS-OHBYTE
ENT-IPROUTE-STATIC
ENT-TIDIPMAP
INIT-STAT-DCC
RTRV-CRS-OHBYTE
RTRV-DCC
RTRV-IPROUTE
RTRV-LAN
RTRV-OSPF-ALL
RTRV-RIP-ALL
RTRV-SERIAL
RTRV-STAT-DCC
RTRV-STAT-TCP
RTRV-TIDIPMAP
Cross Connection DLT-CRS-<STS_PATH/VT_PATH>
ED-CRS-<STS_PATH/VT_PATH>
ENT-CRS-<STS_PATH/VT_PATH>
RTRV-CRS
RTRV-CRS-<STS_PATH/VT_PATH>
Equipment DLT-EQPT
ED-EQPT
ENT-EQPT
RTRV-EQPT
July 29, 2005 Chapter 2: TL1 Messages Description

Ethernet DLT-CAR
DLT-COS
DLT-ETHLINK
DLT-FLOW
ED-CAR
ED-COS
ED-FETH
ED-FLOW
ED-GETH
ED-VCG
ENT-CAR
ENT-COS
ENT-ETHLINK
ENT-FLOW
REPT EVT VCG
RTRV-CAR
RTRV-COS
RTRV-ETHLINK
RTRV-FETH
RTRV-FLOW
RTRV-GETH
RTRV-VCG
RTRV-ETH-VER

Facility CONN-TST-<T1/T3>
DISC-TST-<T1/T3>
ED-<OCN>
ED-<STS_PATH>
ED-<VT_PATH>
ED-T1
ED-T3
RMV-<OCN/T1/T3/STS_PATH>
RST-<OCN/T1/T3/STS_PATH>
RTRV-<OCN>
RTRV-<STS_PATH>
RTRV-<VT_PATH>
RTRV-T1
RTRV-T3
RTRV-TST-<T1/T3>
Loopback ALW-LPBK-<T1/T3>
INH-LPBK-<T1/T3>
OPR-LPBK-<OCN/T1/T3/STS_PATH>
RLS-LPBK-<OCN/T1/T3/STS_PATH>
OPR-LPBK-<FETH/GETH>
RTRV-LPBK-<FETH/GETH>
RLS-LPBK-<FETH/GETH>

Performance ALW-PMREPT-ALL
ED-RMONALMCTRL-<MOD2>
ED-RMONHISTCTRL-<MOD2>
INH-PMREPT-ALL
INIT-REG-<MOD2>
REPT PM <MOD2>
REPT RMON FALLING
REPT RMON RISING
RTRV-PM-<MOD2>
RTRV-PMDAY
RTRV-RMONALMCTRL-<MOD2>
RTRV-RMONHIST-<MOD2>
RTRV-RMONHISTCTRL-<MOD2>
RTRV-RMONSTAT-<MOD2>
RTRV-TH-<MOD2>
RTRV-TH-ALL
SET-PMDAY
SET-TH-<MOD2>
Security ACT-USER
ALW-USER-SECU
CANC-USER
DLT-USER-SECU
ED-PID
ED-USER-SECU
ENT-USER-SECU
INH-USER-SECU
RTRV-USER-SECU
SONET Line Protection DLT-FFP-<OCN>
ED-FFP-<OCN>
ENT-FFP-<OCN>
OPR-PROTNSW-<OCN>
RLS-PROTNSW-<OCN>
RTRV-FFP-<OCN>
RTRV-FFP-ALL

Synchronization ED-BITS
ED-SYNC
ED-SYNCLIST
OPR-SYNCNSW
RLS-SYNCNSW
RTRV-BITS
RTRV-EXIST-SYNC
RTRV-SYNC
RTRV-SYNCLIST
System ABT-CMD
CPY-MEM
COMMIT-SW
COPY-RFILE
DLT-RFILE
ED-NEID
INIT-SYS
RTRV-NEID
RTRV-RFILE
SET-SID
ED-SYS
RTRV-SYS
RTRV-PKGVER
RTRV-TOD
ED-DAT
RTRV-DAT
RTRV-BACKUP-INFO
TL1 RTRV-HDR
DSn (TPSa) protection/XCSb protection ALW-SWDX-EQPT
INH-SWDX-EQPT
DLT-EQPT-PG
ED-EQPT-PG
ENT-EQPT-PG
RTRV-EQPT-PG
OPR-PROTNSW-EQPT
RLS-PROTNSW-EQPT
UPSR OPR-PROTNSW-<STS_PATH/VT_PATH>
RLS-PROTNSW-<STS_PATH/VT_PATH>

BLSR DLT-FFP-<OCN>
ED-FFP-<OCN>
ENT-FFP-<OCN>
RTRV-FFP-<OCN>
RTRV-FFP-ALL
ENT-SQL-<STS_PATH>
ED-SQL-<STS_PATH>
RTRV-SQL-<STS_PATH>
INIT-SQL-<OCN>
ED-TPL-<OCN>
RTRV-TPL-<OCN>
INIT-TPL-<OCN>
OPR-PROTNSW-<OCN>
RLS-PROTNSW-<OCN>
a. TPS means tributary protection switching, also calls DSn protection
b. XCS protection means protection of cross-connect, timing and system control unit which includes XCS, XCSH, GXCS and XO
series units.
TL1 MESSAGES BY UNITS

Table 2-2. TL1 Messages by Units
Unit Commands or Autonomous Messages
GXCS ALW-SWDX-EQPT INH-SWDX-EQPT RTRV-ALM-<MOD2>
XCS ALW-MSG-ALL INH-MSG-ALL RTRV-ALM-ENV
XCSH DLT-CRS-<STS_PATH/ INIT-SYS RTRV-ATTR-<MOD2>
VT_PATH>
XO unit OPR-ACO-ALL RTRV-BITS
(XO12D, DLT-EQPT OPR-PROTNSW-EQPT RTRV-COND-<MOD2>
XO12, ED-CRS-<STS_PATH/
XO3D, OPR-SYNCNSW RTRV-CRS-<STS_PATH/
VT_PATH>
and XO3) VT_PATH>
REPT ALM <MOD2>
ED-BITS RTRV-EQPT
REPT ALM ENV
ED-SYNC RTRV-SYNC
REPT EVT <MOD2>
ED-SYNCLIST
RTRV-SYNCLIST
REPT SW
ENT-CRS-<STS_PATH/ SET-ATTR-<MOD2>
VT_PATH> RLS-PROTNSW-EQPT
SET-SID
ENT-EQPT RLS-SYNCNSW

XO unit ALW-MSG-ALL INH-MSG-ALL RTRV-<OCN>
(optical ALW-MSG-DBCHG INH-MSG-DBCHG RTRV-<STS_PATH>
module of
XO12D, DLT-EQPT INIT-REG-<MOD2> RTRV-ALM-<MOD2>
XO12, DLT-FFP OPR-PROTNSW-<OCN> RTRV-ALM-ENV
XO3D,
and XO3) ED-<OCN > OPR-LPBK-<OCN/ RTRV-ATTR-<MOD2>
STS_PATH>
OC192 ED-FFP-<OCN> RTRV-EQPT
OPR-SYNCNSW
OC48 ED-<STS_PATH> RTRV-FFP-<OCN>
REPT ALM <MOD2>
OC48B ED-<VT_PATH> RTRV-PM-<MOD2>
REPT EVT <MOD2>
OC12Q ED-ALM-LAIS RTRV-TH-<MOD2>
REPT PM
OC12D ED-FFP-OCN RTRV-<VT_PATH>
RLS-PROTNSW-<OCN/
OC12 ENT-EQPT SET-ATTR-<MOD2>
STS_PATH>
OC3Q ENT-FFP-<OCN> SET-TH-<MOD2>
RLS-LPBK-<OCN>
OC3D
OC3
PLT1 ALW-LPBK-<T1> INIT-REG-<MOD2> RTRV-ATTR-<MOD2>
PDT1 DLT-EQPT-PG OPR-LPBK-<T1> RTRV-EQPT
PDM3 DLT-EQPT OPR-PROTNSW-EQPT RTRV-LPBK-<T1>
DLT-EQPT-PG REPT ALM <MOD2> RTRV-PM-<MOD2>
ED-<VT_PATH> REPT EVT <MOD2> RTRV-T1
ED-T1 REPT PM RTRV-TH-<MOD2>
ED-EQPT-PG RLS-LPBK-<T1> RTRV-PROTNSW-EQPT
ENT-ALM RLS-PROTNSW-EQPT RTRV-<VT_PATH>
ENT-EQPT RTRV-<STS_PATH> SET-ATTR-<MOD2>
ENT-EQPT-PG RTRV-ALM-<MOD2> SET-TH-<MOD2>
INH-LPBK-<T1>
PLT3 DLT-EQPT-PG OPR-PROTNSW-EQPT RTRV-COND-ENV
PDT3 DLT-EQPT REPT ALM <MOD2> RTRV-EQPT
PQT3 ED-T3 REPT EVT <MOD2> RTRV-PM-<MOD2>
PDM3 ED-EQPT-PG RLS-LPBK-<T3> RTRV-T3
ENT-EQPT RLS-PROTNSW-EQPT RTRV-TH-<MOD2>
ENT-EQPT-PG RTRV-<STS_PATH> RTRV-EQPT-PG
INIT-REG-<MOD2> RTRV-ALM-<MOD2> SET-ATTR-<MOD2>
OPR-LPBK-<T3> RTRV-ATTR-<MOD2> SET-TH-<MOD2>

PDT1P DLT-EQPT-PG CONN-TST-<T1/T3>
PQT3P DLT-EQPT DISC-TST-<T1/T3>
PDM3P ED-EQPT-PG RTRV-TST-<T1/T3>
ENT-EQPT-PG
RTRV-EQPT-PG
EFS8 DLT-EQPT ENT-ETHLINK RTRV-FLOW
EGT2 DLT-COS ENT-COS RTRV-ETHLINK
DLT-CAR ENT-FLOW RTRV-LPBK-<FETH/GETH>
DLT-FLOW OPR-LPBK-<FETH/GETH> RTRV-VCG
DLT-ETHLINK REPT ALM <MOD2> RTRV-COS
ED-FETH REPT EVT <MOD2> RTRV-FETH
ED-GETH REPT EVT LCAS RTRV-RMONALMCTRL-
<MOD2>
ED-VCG REPT EVT VCG
ED-CAR REPT RMON FALLING
ED-FLOW REPT RMON RISING
RTRV-EQPT
ED-COS RLS-LPBK-<FETH/GETH>
SET-ATTR-<MOD2>
ENT-EQPT RTRV-ALM-<MOD2>
ENT-CAR RTRV-ATTR-<MOD2>
RTRV-CAR
RTRV-GETH
TL1 MESSAGES BY CATEGORY AND UNITS

Table 2-3. TL1 Messages by Category and Units
Commands or Autonomous Messages Category Units
ABT-CMD System XO, XCS, XCSH, GXCS
ACT-USER Security XO, XCS, XCSH, GXCS
ALW-LPBK-<T1/T3> Loopback PLT1, PDT1, PLT3, PDT3, PQT3,
PDM3
ALW-MSG-ALL Alarm and condition XO, XCS, XCSH, GXCS
ALW-MSG-DBCHG Alarm and condition XO, XCS, XCSH, GXCS
ALW-PMREPT-ALL Performance XO, XCS, XCSH, GXCS
ALW-SWDX-EQPT XCS Protection XO, XCS, XCSH, GXCS
ALW-USER-SECU Security XO, XCS, XCSH, GXCS
CANC-USER Security XO, XCS, XCSH, GXCS
COMMIT-SW System XO, XCS, XCSH, GXCS
CONN-TACC-<T1/T3> Facility PQT3P, PDM3P, PDT1P
CONN-TST-<T1/T3> Facility PQT3P, PDM3P, PDT1P
COPY-RFILE System XO, XCS, XCSH, GXCS
CPY-MEM System XO, XCS, XCSH, GXCS
DLT-CAR Ethernet EFS8, EGT2
DLT-COS Ethernet EFS8, EGT2
DLT-CRS-<STS_PATH/VT_PATH> UPSR OC3Q, OC3D, OC3, OC12Q,
OC12D, OC12, OC48, OC48B,
OC192, XO12, XO3
DLT-CRS-DCC Communication OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3, XCS, XCSH,
GXCS
DLT-CRS-OHBYTE Communication EFS8, EGT2
DLT-EQPT Equipment All units
DLT-EQPT-PG DSn (TPS) protection PLT1, PDT1, PDT1P, PLT3, PDT3,
PQT3, PQT3P, PDM3, PDM3P
DLT-ETHLINK Ethernet EFS8, EGT2
DLT-FFP-<OCN> SONET line protection/ OC3Q, OC3D, OC3, OC12Q,
BLSR OC12D, OC12, OC48, OC48B,
OC192, XO12, XO3
DLT-FLOW Ethernet EFS8, EGT2
DLT-IPROUTE-STATIC Communications OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3, XCS, XCSH.
GXCS
DLT-RFILE System XO, XCS, XCSH, GXCS
DLT-SNMPTRAPINFO Alarm and condition XO, XCS, XCSH, GXCS
DLT-TIDIPMAP Communication XO, XCS, XCSH, GXCS

DLT-USER-SECU Security XO, XCS, XCSH, GXCS
ED-<OCN> Facility OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
ED-<STS_PATH> Facility OC3Q, OC3D, OC3, OC12Q,
GXCS
ED-<VT_PATH> Facility OC3Q, OC3D, OC3, OC12Q,
GXCS, PLT1, PDT1
ED-BITS Synchronization XO, XCS, XCSH, GXCS
ED-CAR Ethernet EFS8, EGT2
ED-COS Ethernet EFS8, EGT2
ED-CRS-<STS_PATH/VT_PATH> Cross connection All units
ED-DAT System XO, XCS, XCSH, GXCS
ED-DCC Communication XO, XCS, XCSH, GXCS
ED-EQPT Equipment All units
ED-EQPT-PG Performance EFS8, EGT2
ED-FETH Ethernet EFS8, EGT2
ED-FFP-<OCN> APS OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
ED-FLOW Ethernet EFS8, EGT2
ED-GETH Ethernet EGT2
ED-LAN Communication XO, XCS, XCSH, GXCS
ED-NEID Communication XO, XCS, XCSH, GXCS
ED-OSPF-DCC Communication XO, XCS, XCSH, GXCS
ED-OSPF-LAN Communication XO, XCS, XCSH, GXCS
ED-OSPF-SYS Communication XO, XCS, XCSH, GXCS
ED-PID Security XO, XCS, XCSH, GXCS
ED-RIP-DCC Communication XO, XCS, XCSH, GXCS
ED-RIP-LAN Communication XO, XCS, XCSH, GXCS
ED-RIP-SYS Communication XO, XCS, XCSH, GXCS
ED-RMONALMCTRL-<MOD> Performance/RMON XO, XCS, XCSH, GXCS
ED-RMONHISTCTRL-<MOD> Performance/RMON XO, XCS, XCSH, GXCS
ED-SERIAL Communication XO, XCS, XCSH, GXCS
ED-SYNC Synchronization XO, XCS, XCSH, GXCS
ED-SYNCLIST Synchronization XO, XCS, XCSH, GXCS
ED-SYS System XO, XCS, XCSH, GXCS
ED-T1 Facility PLT1, PDT1

ED-T3 Facility PLT3, PDT3, PQT3, PDM3
ED-USER-SECU Security XO, XCS, XCSH, GXCS
ED-VCG Ethernet EFS8, EGT2
ENT-CAR Ethernet EFS8, EGT2
ENT-COS Ethernet EFS8, EGT2
ENT-CRS-<STS_PATH/VT_PATH> Cross connection All units
ENT-CRS-DCC Communication XO, XCS, XCSH, GXCS
ENT-CRS-OHBYTE Communication EFS8
ENT-EQPT Equipment All units
ENT-EQPT-PG EQPT Protection PLT1, PDT1, PLT3, PDT3, PQT3
ENT-ETHLINK Ethernet EFS8, EGT2
ENT-FFP-<OCN> APS OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
ENT-IPROUTE-STATIC Communication XO, XCS, XCSH, GXCS
ENT-TIDIPMAP Communication XO, XCS, XCSH, GXCS
ENT-USER-SECU Security XO, XCS, XCSH, GXCS
INH-LPBK-<T1,T3> Loopback PLT1, PDT1, PLT3, PDT3, PQT3,
PDM3
INH-MSG-ALL Alarm and condition XO, XCS, XCSH, GXCS
INH-MSG-DBCHG Alarm and condition XO, XCS, XCSH, GXCS
INH-PMREPT-ALL Performance XO, XCS, XCSH, GXCS
INH-SWDX-EQPT EQPT protection XO, XCS, XCSH, GXCS
INH-USER-SECU Security XO, XCS, XCSH, GXCS
INIT-LOG System XO, XCS, XCSH, GXCS
INIT-REG-<MOD2> Performance XO, XCS, XCSH, GXCS
INIT-RMONHIST-<MOD> Performance/RMON EFS8, EGT2
INIT-RMONSTAT-<MOD> Performance/RMON EFS8, EGT2
INIT-STAT-DCC Communication XO, XCS, XCSH, GXCS
INIT-SYS System XO, XCS, XCSH, GXCS
OPR-ACO-ALL Alarm and condition XO, XCS, XCSH, GXCS
OPR-EXT-CONT Alarm and condition XO, XCS, XCSH, GXCS
OPR-LPBK-<OCN/T/T/STS_PATH> Loopback PLT1, PDT1, PLT3, PDT3, PQT3,
PDM3
OPR-PROTNSW-<OCN> APS OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
OPR-PROTNSW-<STS_PATH/VT_PATH> UPSR XO, XCS, XCSH, GXCS
OPR-PROTNSW-EQPT EQPT protection XO, XCS, XCSH, GXCS
OPR-SYNCNSW Synchronization XO, XCS, XCSH, GXCS
REPT ALM-<MOD2> Alarm and condition All units

REPT ALM ENV Alarm and condition All units
REPT DBCHG Alarm and condition All units
REPT EVT<MOD2> Alarm and condition All units
REPT EVT VCG Alarm and condition EFS8, EGT2
REPT PM <MOD2> Performance All units
REPT RMON FALLING Performance/RMON EFS8, EGT2
REPT RMON RISING Performance/RMON EFS8, EGT2
REPT SW Alarm and condition XO, XCS, XCSH, GXCS
REPTÂCCESS^WARNING Alarm and condition XO, XCS, XCSH, GXCS
REPTÊVTÂCTIVATED Alarm and condition XO, XCS, XCSH, GXCS
REPTÊVT^BDMATCHFAILED Alarm and condition All units
REPTÊVT^BDNOMATCHHW Alarm and condition All units
REPTÊVT^COMMITEND Alarm and condition All units
REPTÊVT^COMMITFAILED Alarm and condition All units
REPTÊVT^CPYMEMEND Alarm and condition All units
REPTÊVT^FXFR Alarm and condition All units
REPTÊVT^FXFRHALT Alarm and condition All units
REPTÊVT^NOSWINPKG Alarm and condition All units
REPTÊVT^PROGRESS Alarm and condition All units
REPTÊVT^ROLLBACKEND Alarm and condition All units
REPTÊVT^ROLLBACKSTART Alarm and condition All units
REPTÊVT^SECU Alarm and condition XO, XCS, XCSH, GXCS
REPTÊVT^SLVMATCHFAILED Alarm and condition XO, XCS, XCSH, GXCS
REPTÊVT^SLVNOMATCHHW Alarm and condition XO, XCS, XCSH, GXCS
REPT^LOGOFF Alarm and condition XO, XCS, XCSH, GXCS
RLS-EXT-CONT Alarm and condition XO, XCS, XCSH, GXCS
RLS-LPBK-<OCN/T/T/STS_PATH> Loopback All units
RLS-PROTNSW-<OCN> APS OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
RLS-PROTNSW-<STS_PATH/VT_PATH> UPSR OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
RLS-PROTNSW-EQPT EQPT protection PLT1, PDT1, PLT3, PQT3
RLS-SYNCNSW Synchronization XO unit
RMV-<OCN/T1/T3/STS_PATH> Facility OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3 PLT1, PDT1,
PLT3, PDT3, PQT3, PDM3

RST-<OCN/T1/T3/STS_PATH> Facility OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3, PLT1, PDT1,
RTRV-RMONHISTCTRL-<MOD2> Performance/RMON EFS8, EGT2
RTRV-<OCN> Facility OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
RTRV-<STS_PATH> Facility OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3, PLT1, PDT1,
RTRV-<VT_PATH> Facility OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3, PLT1, PDT1
RTRV-ALM-<MOD2> Alarm and condition XO, XCS, XCSH, GXCS
RTRV-ALM-ENV Alarm and condition XO, XCS, XCSH, GXCS
RTRV-AO Alarm and condition XO, XCS, XCSH, GXCS
RTRV-ATTR-<MOD2> Alarm and condition XO, XCS, XCSH, GXCS
RTRV-ATTR-CONT Alarm and condition XO, XCS, XCSH, GXCS
RTRV-ATTR-ENV Alarm and condition XO, XCS, XCSH, GXCS
RTRV-BACKUP-INFO System XO, XCS, XCSH, GXCS
RTRV-BITS Synchronization XO, XCS, XCSH, GXCS
RTRV-CAR Ethernet EFS8, EGT2
RTRV-COND-<MOD2> Alarm and condition XO, XCS, XCSH, GXCS
RTRV-COS Ethernet EFS8, EGT2
RTRV-CRS Cross connection XO, XCS, XCSH, GXCS
RTRV-CRS-<STS_PATH/VT_PATH> Cross connection XO, XCS, XCSH, GXCS
RTRV-CRS-OHBYTE Communication XO, XCS, XCSH, GXCS
RTRV-DAT Communication XO, XCS, XCSH, GXCS
RTRV-DCC Communication XO, XCS, XCSH, GXCS
RTRV-EQPT Equipment All units
RTRV-EQPT-PG EQPT protection PLT1, PDT1, PLT3, PDT3, PQT3,
PDM3
RTRV-ETHLINK Ethernet EFS8, EGT2
RTRV-EXIST-SYNC Synchronization XO, XCS, XCSH, GXCS
RTRV-EXT-CONT Alarm and condition EFS8, EGT2
RTRV-FETH Ethernet EFS8, EGT2
RTRV-FFP-<OCN> APS OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3

RTRV-FFP-ALL APS OC3Q, OC3D, OC3, OC12Q,
OC192, XO12, XO3
RTRV-FLOW Ethernet EFS8, EGT2
RTRV-GETH Ethernet EGT2
RTRV-HDR TL1 XO, XCS, XCSH, GXCS
RTRV-IPROUTE Communication XO, XCS, XCSH, GXCS
RTRV-LAN Communication XO, XCS, XCSH, GXCS
RTRV-LOG System XO, XCS, XCSH, GXCS
RTRV-NEID System XO, XCS, XCSH, GXCS
RTRV-OSPF-ALL Communication XO, XCS, XCSH, GXCS
RTRV-PKGVER System XO, XCS, XCSH, GXCS
RTRV-PM-<MOD2> Performance OC3Q, OC3D, OC3, OC12D, OC12,
OC12Q, OC48, OC192, XO12, XO3,
XCS, XCSH. GXCS, PLT1, PDT1,
RTRV-PMDAY Performance XO, XCS, XCSH, GXCS
RTRV-RFILE System XO, XCS, XCSH, GXCS
RTRV-RIP-ALL Communication XO, XCS, XCSH, GXCS
RTRV-RMONALMCTRL-<MOD2> Performance/RMON EFS8, EGT2
RTRV-RMONHIST-<MOD2> Performance/RMON EFS8, EGT2
RTRV-RMONSTAT-<MOD2> Performance/RMON EFS8, EGT2
RTRV-SERIAL System XO, XCS, XCSH, GXCS
RTRV-SNMPTRAPINFO Alarm and condition XO, XCS, XCSH, GXCS
RTRV-STAT-DCC Communication XO, XCS, XCSH, GXCS
RTRV-STAT-TCP Communication XO, XCS, XCSH, GXCS
RTRV-SYNC Synchronization XO, XCS, XCSH, GXCS
RTRV-SYNCLIST Synchronization XO, XCS, XCSH, GXCS
RTRV-SYS System XO, XCS, XCSH, GXCS
RTRV-T1 Facility PLT1, PDT1, PDM3
RTRV-T3 Facility PLT3, PDT3, PQT3, PDM3
RTRV-TH-<MOD2> Performance All units
RTRV-TH-ALL Performance All units
RTRV-TIDIPMAP Communication XO, XCS, XCSH, GXCS
RTRV-TOD System XO, XCS, XCSH, GXCS
RTRV-USER-SECU Security XO, XCS, XCSH, GXCS
RTRV-VCG Ethernet EFS8, EGT2
SET-ATTR-<MOD2> Alarm and condition XO, XCS, XCSH, GXCS
SET-ATTR-CONT Alarm and condition XO, XCS, XCSH, GXCS
SET-ATTR-ENV Alarm and condition XO, XCS, XCSH, GXCS

SET-PMDAY Performance XO, XCS, XCSH, GXCS
SET-SID System XO, XCS, XCSH, GXCS
SET-TH-<MOD2> Performance All units
SW-DX-EQPT Equipment XO, XCS, XCSH, GXCS
TL1 COMMANDS BY ALPHABETIZATION

General Convention
<TID>: Target Identifier
<AID>: Access Identifier, identifies the equipment unit, facility, subscriber line, trunk, link, packet link, or signaling
link in the NE, depending on the command code modifier, on which performance monitoring data is being retrieved.
<CTAG>: Correlation Tag
<rsphdr>: Response Header. It has the format of:
<SID>^<YYYY-MM-DD>^<HH:MM:SS>
&&: The double-ampersand is reserved for expressing a ranges of values. An example of this usage is RANGE =
1&&10 to enter the values 1, 2, 3, 10. Compound parameters may be also grouped, but note that double-
ampersand (&&) can only be used to range over the last field of the compound parameter (for example, 2-5-1 && -
10 means 2-5-1 & 2-5-2 & ... & 2-5-10)
ABT-CMD
Note: For LoopStar product compatibility, see Table 1-1, “TL1 Message Summary,” on page 1-7.
Command ABT-CMD
Explanation Abort command
Function This command aborts SWDL, DBFDL or DBFUL processing. When executing
this command, the system will abort SWDL, DBFDL, or DBFUL and try to roll
back to the state before SWDL, DBFDL, or DBFUL. (SWDL means downloading
software package from PC to NE; DBFDL means downloading database from
PC to NE; DBFUL means uploading database from NE to PC.)
Category System
Security Maintenance
Related Messages
Input Format ABT-CMD:[<TID>]::<CTAG>;
Input Parameter Parameter Description
Output Normal
Format <cr><lf><lf>
^^^<rsphdr><cr><lf>
A^^<ctag>^REPTÊVT^ROLLBACKSTART<cr><lf>
^^^<cr><lf>
;
<cr><lf><lf>
^^^<rsphdr><cr><lf>
A^^<ctag>^REPTÊVT^ROLLBACKEND<cr><lf>
^^^<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^DENY<cr><lf>
^^^<errcode><cr><lf>
^^^"/*<error description>/*<cr><lf>
^^^/*error text*/<cr><lf>
;
Output Parameter Parameter Description
Errors
Example Input ABT-CMD:::C;
Normal LoopStar 800 2004-01-01 14:23:22
A 142 REPT EVT ROLLBACKSTART
;
LoopStar 800 2004-01-01 14:24:04

A 143 REPT EVT ROLLBACKEND
;
Error LoopStar 800 2004-01-01 14:32:51
M C DENY
SNVS
/*NOT IN VALID STATE, EXECUTE COMMAND FAILED*/
;
Notes This command can only abort software package download-processing or
database files downloading and uploading.
ACT-USER
Command ACT-USER
Explanation Activate user
Function This command enables a user to operate the NE.
Category Security
Security Retrieve
Related Messages CANC-USER
Input Format ACT-USER:[<TID>]:<UID>:<CTAG>::<PID>;
<UID> User identifier. It is any combination of 4 to 16 alphanumeric
characters. It is a string and must not be null.
<PID> User password. It is any combination of 6 to 16 alphanumeric
Output normal <cr><lf><lf>
Format
^^^<rsphdr><cr><lf>
m^^<ctag>^^compld<cr><lf>
^^^/*last log time:yyyy-mm-dd hh:mm:ss*/
;
error <cr><lf><lf>
^^^<rsphdr><cr><lf>
m^^<ctag>^deny<cr><lf>
[^^^"<error description>"<cr><lf>]
[^^^/*error text*/<cr><lf>]
;
<cr><lf><lf>
^^^<rsphdr><cr><lf>
m^^<ctag>^deny<cr><lf>
^^^<errcode><cr><lf>
^^^"/*<error description>/*<cr><lf>
^^^/*error text*/<cr><lf>
;
Errors
Example Input ACT-USER::SONET:C::SONET;

Normal LoopStar 800 2004-01-01 02:15:27
M C COMPLD
"Last log time:2004-01-01 2:2:20"
;
Error LoopStar 800 2004-01-01 02:15:27
14 REPT ACCESS WARNING
/*NOTICE: This is a private communication system.
Unauthorized access or use may lead to prosecution.*/
;
Notes A terminator only supports one user to login. If system supports SNMP function,
the SNMP inner-user "SNMPUSER" will automatically log in.
ALW-LPBK-<T1/T3>
Command ALW-LPBK-<T1/T3>
Explanation Allow loopback (T1/T3)
Function This command allows far-end loopback of T1/T3 port in the transmux unit.
Category Loopback
Related Messages INH-LPBK-<T1/T3>
Input Format ALW-LPBK-<T1/T3>:[<TID>]:<AID>:<CTAG>;

Format
^^^<rsphdr><cr><lf>
M^^<ctag>COMPLD<cr><lf>
;
error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
(^^^"<error description>"<cr><lf>)*
(^^^/*error text*/<cr><lf>)*
;
Errors
Example Input ALW-LPBK-T1::FAC-4-1:C;
Normal LoopStar 800 2004-01-01 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:54:55
M C DENY
PLNA
/*LOGIN NOT ACTIVE*/
;
Notes A terminator only supports one user to login. If system supports SNMP function,
the SNMP inner-user "SNMPUSER" will automatically log in.
ALW-MSG-ALL
Command ALW-MSG-ALL
Explanation Allow autonomous messages report
Function This command instructs the NE to enter a mode in which all the REPT ALM and
REPT EVT autonomous messages are reported. See the INH-MSG-ALL
command to inhibit these autonomous messages. When a user logins, the REPT
ALM and REPT EVT messages are allowed by default. This command is based
on user.
Category System
Security Retrieve
Related Messages INH-MSG-ALL
Input Format ALW-MSG-ALL:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
;
error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ALW-MSG-ALL:::100;
Normal LoopStar 800 2004-07-08 15:15:55
M 100 COMPLD
;
Error LoopStar 800 2004-07-08 15:42:05
M 100 DENY
IBEX
/*INPUT BLOCK, EXTRA*/
/*ALW-MSG-ALL:::123;*/
;
Notes The alarm and event messages can be reported by default when executing INH-
MSG-ALL to inhibit these autonomous messages. After NE reboot, these
autonomous messages can be also reported to user.
ALW-MSG-DBCHG
Command ALW-MSG-DBCHG
Explanation Allow database changing message report
Function This command enables REPT DBCHG. When a user logins, the REPT DBCHG
messages are not allowed by default. This command is based on user.
Category System
Security Retrieve
Related Messages INH-MSG-DBCHG

REPT DBCHG
Input Format ALW-MSG-DBCHG:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
;
error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ALW-MSG-DBCHG:::100;
Normal LoopStar 800 2004-11-26 15:19:57
M 100 COMPLD
;
LoopStar 800 2004-11-26 15:19:57

A 950 REPT DBCHG
"DATE=2004-11-26,TIME=15-19-
57,SOURCE=S,USERID=SONET,DBCHGSEQ=15:ALW-MSG-DBCHG"
;
Error LoopStar 800 2004-07-08 15:58:11
M 100 DENY
IBEX
/*ALW-MSG-DBCHG:::123;*/
;
Notes
ALW-PMREPT-ALL
Command ALW-PMREPT-ALL
Explanation Allow performance monitoring report
Function This command instructs an NE to resume processing those PM reports that are
inhibited. Reporting can be inhibited by INH-PMREPT-ALL command.
Any NE whose PM reports are inhibited by INH-PMREPT-ALL command should
include the appropriate condition type information in response to a RETRIEVE-
CONDITION request. This command is based on user.
Category Performance
Security Retrieve
Related Messages INH-PMREPT-ALL
Input Format ALW-PMREPT-ALL:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Example Input ALW-PMREPT-ALL:SONET-NE::C;

Normal LoopStar 800 2004-01-01 00:00:00
M C COMPLD
;
Error LoopStar 800 2004-01-01 00:00:00
M C DENY
IIAC
"Invalid access identifier"
;
Notes The PM messages are inhibited reporting to user by default, when issuing ALW-
PMREPT-ALL to allow these autonomous messages. But after NE reboot, these
autonomous messages can still inhibit reporting to user.
ALW-SWDX-EQPT
Command ALW-SWDX-EQPT
Explanation Allow switch duplex equipment
Function This command allows automatic or manual switching on a system containing
duplex or redundent equipment. Use the INH-SWDX-EQPT command to inhibit
the switching to duplex.
Category XCS protection
Related Messages INH-SWDX-EQPT
REPT SW
SW-DX-EQPT
Input Format ALW-SWDX-EQPT:[<TID>]:<EQPT>:<CTAG>;
<EQPT> The target slot which will be allowed, such as SLOT-9.
Format ^^^<rsphdr><cr><lf>
^^^<cr><lf>
;
error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Example Input ALW-SWDX-EQPT::SLOT-9:C;

Normal LoopStar 800 2004-01-01 07:07:36
M C COMPLD
;
Error LoopStar 800 2004-01-01 00:00:00
M C DENY
IIAC
"Invalid access identifier"
;
Notes
ALW-USER-SECU
Command ALW-USER-SECU
Explanation Allow user security.
Function This command is used by a super user to allow (i.e., reinstate) a UID that has
been disabled by the INH-USER-SECU command, so the user can establish a
session with the NMS again.
Category Security
Security Superuser
Related Messages INH-USER-SECU
Input Format ALW-USER-SECU:[<TID>]::<CTAG>::<UID>;
Output Normal <cr><lf><lf>
Format
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ALW-USER-SECU:::100::USERNAME;
Normal LoopStar 800 2004-01-01 15:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-11-15 02:30:50
M 100 DENY
PIUC
/*STATED USER PRIVILEGE CODE IS ILLEGAL,SM_NOT_EXIST*/
;
Notes
CANC-USER
Command CANC-USER
Explanation Cancel user
Function This command logs a user off the NE.
Category Security
Security Retrieve
Related Messages ACT-USER
Input Format CANC-USER:[<TID>]:<UID>:<CTAG>;

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input CANC-USER::USERNAME:C;
Ack
Normal LoopStar 800 2004-01-01 15:23:20
M C COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00

M C DENY
PLNA
/*The user has not logged in.*/
;
Notes Users with privilege of PROV (provisioning), MAINT (maintenance) and RTRV
(retrieve) can only cancel themselves, while a SUPER user can cancel other
users.
CHG-TACC-<T1/T3>
Command CHG-TACC-<T1/T3>
Explanation Change test access (T1/T3)
Function This command changes the test access (TACC) mode for the circuit being tested.
Category Test Access
Security Provisioning
Related Messages CONN-TACC-<T1/T3>

RTRV-TACC
DISC-TACC
Input Format CHG-TACC-<T1/T3>:[<TID>]:<TAP>:<CTAG>::<TACCMODE>;
<TAP> <TAP> defines the DSn port as a test access port with a selected
unique TAP number. The TAP number ranges from 1 to 999.
<TAP> is an integer.
<TACCMODE> <TACCMODE> indicates the test access mode. <TACCMODE>
must not be null. Valid values for <TACCMODE> are:
MONE (Monitor access with signal detector on A path);
MONF (Monitor access with signal detector on B path);
MONEF (Monitor access with signal detector on A and B paths);
SPLTA (Split access on A path with signal detector from
equipment, QRS on facility side);
SPLTB (Split access on B path with signal detector from
equipment, QRS on equipment side);
SPLTE (Split access on A and B paths with signal detector from
SPLTF (Split access on A and B paths with signal detector from
facility, QRS on facility side);
SPLTEF (Split access on A and B paths for testing in both
equipment and facility directions).
Output Normal ^^^<cr><lf><lf>
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input CHG-TACC-T1:SONET-NE:255:C::MONE;

Normal LoopStar 800 2004-01-01 09:29:46
M C COMPLD
;
Error LoopStar 800 2004-01-01 09:29:45

M C DENY
RTEN
/*REQUESTED TAP DOES NOT EXIST,REQUESTED TAP DOES NOT
EXIST*/
/*0X9B65*/
;
Notes
COMMIT-SW
Command COMMIT-SW
Explanation Commit software
Function This command commits the new downloaded software package. After executing
this command, the system cannot roll back.
Category System
Security Super-user
Related Messages
Input Format COMMIT-SW:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input COMMIT-SW:::C;
Normal LoopStar 800 2004-01-01 15:23:20
M C COMPLD
;
Notes
CONN-TST-<T1/T3>
Command CONN-TST-<T1/T3>
Explanation Connect test (T1, T3)
Function This command sets up the bit sequence test connection with all necessary setting
for the internal bit sequence generator and detector.
Category Facility
Related Messages DISC-TST-<T1/T3>
REPT RSLT <T1/T3>
RTRV-RSLT-<T1/T3>
Input Format CONN-TST-<T1/T3>:[<TID>]:<AID>:<CTAG>::<TSTMD>,[<TSTSIG>],
[<DUR>],[<RI>];

<AID> Access identifier
<TSTMD> <TSTMD> indicates the requested test mode, it is similar to test
access mode. The expected entries for this parameter are listed
below:
MONE indicates a monitor connection of an internal signal
presence detector on the A transmission path.
MONF indicates a monitor connection of a signal presence
detector on the B transmission path.
SPLTA indicates split the A transmission path, connect a test
signal in the F direction, and a signal presence detector in the E
direction.
SPLTB indicates split the B transmission path, connect a test
signal in the E direction, and a signal presence detector in the F
direction.
SPLTE indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the E direction
and a test signal to the line outgoing in the E direction. The line
outgoing in the F direction shall have an AIS signal connected,
and the line incoming from the F direction shall be terminated by
the nominal characteristic impedance of the line.
SPLTF indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the F direction
and a test signal to the line outgoing in the F direction. The line
outgoing in the E direction shall have an AIS signal connected,
and the line incoming from the E direction shall be terminated by
the nominal characteristic impedance of the line.
LOOPE indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the E direction
and connect this line to the line outgoing in the E direction. The
line outgoing in the F direction shall have an AIS signal
connected, and the line incoming from the F direction shall be
terminated by the nominal characteristic impedance of the line.
LOOPF indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the F direction
and connect this line to the line outgoing in the F direction. The
line outgoing in the E direction shall have an AIS signal
connected, and the line incoming from the E direction shall be
terminated by the nominal characteristic impedance of the line.
Default is SPLTE.
Note: MONEF and SPLTEF are not supported for there

is only one pair of test signal generator and detector
provided.
Input Parameter <TSTSIG> Pattern of test signal generated at the bit sequence generator,
(cont.) and expected at the bit sequence detector. The valid values are
listed below:
2E23 indicates the conventional pseudo-random pattern with bit
sequence length of 2E23-1.
2E15 indicates the conventional pseudo-random pattern with bit
sequence length of 2E15-1.
<DUR> The time in minutes that bit sequence test sustains. The
expected time should be from 0 to 9999 minutes. "0" (CO) in this
field indicates the test shall continue until terminated by the
DISC-TST-<T1/T3> command. Default is "0" (CO).
<RI> Report Interval in seconds. Valid value ranges from 1 to 3600.
Default is 1 second.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input CONN-TST-T1::FAC-3-1:123::MONE;
Normal LoopStar 800 2004-01-01 14:30:00
M C COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00
M C COMPLD
PLNA
;
Notes 1. A corresponding sustained condition is raised when a test is in progress.

Also the test state (running or stop) to indicate whether the corresponding
facility is under bit sequence test can be determined when the elapsed time
in REPT event is equal to the duration assigned by CONN-TST-<T1/T3>
command, so the test connection will be released automatically.
2. The framing format of the test signal is always unframed, and the line cod-
ing format of the test signal is consistent with the setting of ED-T1/T3 com-
mands.
3. The number of test sessions available at the same time depends on the
specific equipment and the testing mode.
4. It needed to send AIS downstream for the circuit splitted.
COPY RFILE
Command COPY-RFILE
Explanation Copy remote files
Function This command downloads a new software package from the location specified
by the FTP URL. It is also used to backup and restore the system database.
Category System
Security Superuser
Related Messages
Input Format COPY-RFILE:[<TID>]:[<AID>]:<CTAG>::<FTYPE>,<SRCURL>,<DSTURL>,
<OVERWRITE>;

<AID> SLOT-N or NULL. Only when <FTYPE> is RFR or RFBU
can use SLOT-N. The null value defaults to active xcs unit.
<FTYPE> File transfer protocol. Valid value can be:
SWDL (Software package downloading from remote PC to
NE);
DBFDL (Downloading database from PC to NE);
DBFUL (Uploading database from NE to PC);
RFR (Remote file restore (Remote server to NE) Do not
support standby XCS unit);
RFBU (Remote file backup (NE to remote server). Do not
support standby XCS unit).
<SRCURL> Specifies the source of the file to be transferred. Valid format
is FTP URL (when <FTYPE> is SWDL, DBFDL or RFR),
FILE URL (when <FTYPE> is RFBU) and NULL (when
<FTYPE> is DBFUL).
The format of the FTP URL should be:
"FTP://
<USERID>:<PASSWORD>@<FTPHOSTIP>[:<PORT>]/
[URL-PATH]"
where:
<USERID> is the userid to connect to the computer with the
package file.
<PASSWORD> is the password used to connect to the
computer with the package file.
<FTPHOSTIP> and <PORT> is the IP address and port
number of the computer with the package file.
<URL_PATH> is the long path name to the package file.
The format of the FILE URL should be:
"FILE://<URL-PATH>"
<DSTURL> See <SRCURL> above.
<OVERWRITE> Valid value can be:
YES (Overwrite existing file of same directory location and
filename);
NO (Do not overwrite file, fail the file transfer if file already
exists).
Note: This parameter is only available for RFR.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input COPY-RFILE:::C::SWDL,"ftp://testuser:pass@129.9.0.222/newpkg/
new_ne.pkg","",YES;
Normal LoopStar 800 2004-06-20 15:18:53
M 100 COMPLD
;
Error LoopStar 800 2004-06-20 15:26:16
M 100 DENY
SNVS
/*NOT IN VALID STATE, NSERR_SWDL_GET_FROM_SRV*/
;
Notes
CPY-MEM
Command CPY-MEM
Explanation Copy memory
Function This command copies file from RAM disk to Flash. This command only support
in NE, not supporting remote copy. In distributed storage it is a null operation. It
will copy the new software package just downloaded in RAM disk into NE
standby bank, and also the destination units.
Category System
Security Superuser
Related Messages
Input Format CPY-MEM:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input CPY-MEM:::1001;
Normal LoopStar 800 2004-06-20 15:20:42
M 1001 COMPLD
;
Error SONET-NE 2004-06-20 15:23:10
M 1001 DENY
SNVS
/*NOT IN VALID STATE, NSERR_SWDL_STATE_ERR*/
;
DISC-TST-<T1/T3>
Command DISC-TST-<T1/T3>
Explanation Disconnect test (T1/T3)
Function This command instructs NE to release the test connection.
Category Facility
Related Messages CONN-TST-<T1/T3>
CHG-TACC-<T1/T3>
REPT RSLT <T1/T3>
RTRV-RSLT-<T1/T3>
Input Format DISC-TST-<T1/T3>:[<TID>]:[<AID>]:<CTAG>;
<AID> Access identifier. See section "T1/T3" in Chapter 3 TL1
Parameters on page ??.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DISC-TST-T1::FAC-5-1:123;

Normal LoopStar 800 2004-01-01 14:30:00
M 230 COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00
M 230 COMPLD
PLNA
;
Notes
DLT-CAR
Command DLT-CAR
Explanation Delete committed access rate (CAR)
Function This command deletes an entry of the CAR of unit.
Category Ethernet
Related Messages ENT-CAR
ED-CAR
RTRV-CAR
Input Format DLT-CAR:[<TID>]:<AID>:<CTAG>;
<AID> Ethernet CAR identifier. Valid format is CAR-<SLOT ID>-
<CAR ID>. The <CAR ID> ranges from 1 to 1024.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors ETH_BID_ERR (The unit ID is invalid.)

CFG_BD_NOT_EXIST (The unit does not exist.)
CFG_BDTYPE_MISMATCH (The unit type is not Ethernet unit.)
CFG_CMD_NOT_SUPPORT (Not support this command.)
ERR_ETH_PARA_CARID (The car ID parameter is invalid.)
ERR_ETH_CARID_NOTEXIST (The car ID parameter does not exist.)
ERR_ETH_CAR_IN_FLOW (The car has bound a flow.)
Example Input DLT-CAR::CAR-5-10:100;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 100 DENY
IIAC
"INVALID ACCESS IDENTIFIER"
;
Notes
DLT-COS
Command DLT-COS
Explanation Delete class of service (COS)
Function This command deletes a COS in the unit.
Category Ethernet
Related Messages ENT-COS
ED-COS
RTRV-COS
Input Format DLT-COS:[<TID>]:<AID>:<CTAG>;
<AID> Indicates the identify of COS. Valid value is <ETN_COSID>. The
format is COS-<SLOT ID>-<COS ID>.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

CFG_BDTYPE_MISMATCH (The unit is not Ethernet unit.)
CFG_CMD_NOT_SUPPORT (Do not support this command.)
ERR_ETH_PARA_COSID (The COS ID parameter is invalid.)
ERR_ETH_COS_IN_FLOW (The COS is associated to a FLOW.)
ERR_ETH_COSID_NOTEXIST (The COS ID does not exist.)
Example Input DLT-COS::COS-1-1:100;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error SONET-NE 2004-01-01 12:23:20
M 101 DENY
IIAC
;
Notes
DLT-CRS-<STS_PATH>
Command DLT-CRS-<STS_PATH>
Explanation Delete cross connection (STS1/STS3C/STS6C/STS9C/STS12C/STS24C/

STS48C/STS192C)
Function This command deletes a cross connection with a cross connection type.
1. For the 1-way cross-connections the AIDs must be in the same order as
originally entered; for the 2-way cross-connections, either order will work.
2. This command does not support deleting multiple cross-connections.
3. Parameter <INCL> means inclusive. The value Y indicates that the
requested (for disconnection) channel is to be disconnected regardless
of its red-lined status; the value N implies a normal disconnect in most
cases, and no disconnect if the channel was designated as RDLD.
4. The AID format in the deletion command is the same as the AID format in
the retrieved response message. For example, if the output of any
retrieved AID is "F1&F2, T1: CCT", the deletion command with the AID
format (F1&F2, T1) is required to delete this cross-connection.
5. "&" can be used in the AID field of this command.
a. If there is a 1-WAY common cross connection with:
from point: F1
to points: T1
The following command is used to delete it
DLT-CRS-<STS_PATH>:[<TID>]:F1,T1:<CTAG>;
b. If there is a 2-WAY common cross connection with:
from point: F1
to points: T1
or
DLT-CRS-<STS_PATH>:[<TID>]:T1,F1:<CTAG>;
c. If there is a selector with:
from point: F1, F2
to points: T1
DLT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1:<CTAG>;
d. If there is a UPSR with:
from point: F1, F2
to points: T1
DLT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1:<CTAG>;
Function (cont.) e. The following command is used to delete the two 1-way selectors
with:
from point: F1,F2
to points: T1
and from point F1,F2
to points: T2
DLT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>;
f. The following command is used to disconnect two UPSRs with:
from point: F1,F2
to points: T1,T2
DLT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>;
or
DLT-CRS-<STS_PATH>:[<TID>]:T1&T2,F1&F2:<CTAG>;
g. If there is one 1-way selector from F1 and F2 to T1, following com-
mand will convert it to 1-way common cross connection from F1 to
T1.
h. If there is one UPSR from F1 and F2 to T1, following command will
convert it to 2-way common cross connection from F1 to T1.
Category Cross connection
Related Messages ENT-CRS-<STS_PATH>
RTRV-CRS-<STS_PATH>
ED-CRS-<STS_PATH>
Input Format DLT-CRS-<STS_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>:::
[INCL=<INCL>];
<STS_PATH The modifier that identifies the type of STS and VT path. Valid
> value can be STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, or STS192C.
<FROM> Source identifier at one end of a cross connection. <FROM> does
not support "&" and "&&" deleting multiple cross connections
here. (See “STS-N” in Chapter 3: TL1 Parameters)
<TO> Target identifier at one end of a cross connection. <TO> does not
support "&" and "&&" deleting multiple cross connections here.
(See “STS-N” in Chapter 3: TL1 Parameters)
<INCL> Inclusive (red-lined circuits). Valid value is Y or N. Default is N.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-CRS-STS1::STS-5-1,STS-5-1:C:::INCL=Y;
Normal LoopStar 800 2004-01-01 07:28:49
M 100 COMPLD
;
Error LoopStar 800 2004-01-1 07:28:49

M 100 DENY
PLNA
;
Notes Only LoopStar 1600 supports STS24C, STS48C, and STS 192C.
DLT-CRS-<STS_PATH/VT_PATH>
Command DLT-CRS-<STS_PATH/VT_PATH>
Explanation Delete cross connection (STS1/STS3C/STS6C/STS9C/STS12C/STS24C/
STS48C/STS192C/VT1.5/VT2)
Function This command deletes a cross connection with a cross connection type.
3. Parameter <INCL> means inclusive. The value Y indicates that the
requested (for disconnection) channel is to be disconnected regardless
of its red-lined status; the value N implies a normal disconnect in most
cases, and no disconnect if the channel was designated as RDLD.
4. The AID format in the deletion command is the same as the AID format in
the retrieved response message. For example, if the output of any
retrieved AID is "F1&F2, T1: CCT", the deletion command with the AID
format (F1&F2, T1) is required to delete this cross-connection.
a. If there is a 1-WAY common cross connection with:
from point: F1
to points: T1
DLT-CRS-<STS_PATH/VT_PATH>:[<TID>]:F1,T1:<CTAG>;
b. If there is a 2-WAY common cross connection with:
from point: F1
to points: T1
or
DLT-CRS-<STS_PATH/VT_PATH>:[<TID>]:T1,F1:<CTAG>;
c. If there is a selector with:
from point: F1, F2
to points: T1
DLT-CRS-<STS_PATH/VT_PATH>:[<TID>]:F1&F2,T1:<CTAG>;
d. If there is a UPSR with:
from point: F1, F2
to points: T1
DLT-CRS-<STS_PATH/VT_PATH>:[<TID>]:F1&F2,T1:<CTAG>;
Function (cont.) e. The following command is used to delete the two 1-way selectors
with:
from point: F1,F2
to points: T1
to points: T2
DLT-CRS-<STS_PATH/
VT_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>;
f. The following command is used to disconnect two UPSRs with:
from point: F1,F2
to points: T1,T2
DLT-CRS-<STS_PATH/
VT_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>;
or
DLT-CRS-<STS_PATH/
VT_PATH>:[<TID>]:T1&T2,F1&F2:<CTAG>;
g. If there is one 1-way selector from F1 and F2 to T1, following com-
mand will convert it to 1-way common cross connection from F1 to
T1.
h. If there is one UPSR from F1 and F2 to T1, following command will
convert it to 2-way common cross connection from F1 to T1.
Category Cross connection
Related Messages ENT-CRS-<STS_PATH/VT_PATH>
Input Format DLT-CRS-<STS_PATH/VT_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>:::
[INCL=<INCL>];
<STS_PATH The modifier that identifies the type of STS and VT path. Valid
/VT_PATH> value can be STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1.5 or VT2.
<FROM> Source identifier at one end of a cross connection. <FROM> does
not support "&" and "&&" deleting multiple cross connections
here. (See “STS-N” and ”VT1.5” in Chapter 3: TL1 Parameters.)
<TO> Target identifier at one end of a cross connection. <TO> does not
support "&" and "&&" deleting multiple cross connections here.
(See STS-N” and ”VT1.5” in Chapter 3: TL1 Parameters.)
<INCL> Inclusive (red-lined circuits). Valid value is Y or N. Default is N.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-CRS-STS1::STS-5-1,STS-5-1:C:::INCL=Y;
Normal LoopStar 800 2004-01-01 07:28:49
M 100 COMPLD
;
Error LoopStar 800 2004-01-1 07:28:49

M 100 DENY
PLNA
;
Notes Only LoopStar 1600 supports STS24C, STS48C, and STS 192C.
DLT-CRS-DCC
Command DLT-CRS-DCC
Explanation Delete cross DCC
Function This command deletes a DCC cross channel.
Category Communication

ED-COS
RTRV-COS
Input Format DLT-CRS-DCC:[<TID>]:<FROM_DCCID>;
<FROM_DC Access identifier, indicate the source DCC channel. Valid format
CID> is DCC-<SLOT ID>-<FACILITY ID>-<CHANNEL ID>. The valid
value of <CHANNEL ID> is:
1 (SDCC (D1 to D3));
2 (LDCC (D4 to D12));
3 (LDCC2 (D4 to D6));
4 (LDCC3 (D7 to D9));
5 (LDCC4 (D10 to D12)).
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-CRS-DCC::DCC-1-2-1:C;
Normal LoopStar 800 2004-01-01 15:23:20
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:23:20
M C DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,NO DCCPHYINFO
EXISTES*/
;
Notes
DLT-CRS-OHBYTE
Command DLT-CRS- OHBYTE

Explanation Delete cross overhead bytes
Function This command deletes an overhead byte cross.
Related Messages
Input Format DLT-CRS-OHBYTE:[<TID>]:<FROM_AID>:<CTAG>::< FROM_BYTE >;
<FROM_AID> Access identifier. It is the same with the OC-N facility,
such as FAC-2-1.
<FROM_BYTE> The source byte of the cross. Any of the overhead bytes
is valid, including the D1 to D12 byte.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-CRS-OHBYE::FAC-2-1:C::E1;

Normal LoopStar 800 2004-01-01 15:23:20
M C COMPLD
;
Error LoopStar 800 2004-11-10 15:38:33
M C DENY
IENE
EXISTES*/
/*0X9827*/
;
Notes
DLT-EQPT
Command DLT-EQPT
Explanation Delete equipment
Function This command deletes a unit from a slot in the NE. It also automatically deletes
all port facilities assigned by the unit.
The following rules must be complied if you want to delete a unit:
1. There is no cross-connect on the unit;
2. There is no protection group on the unit, including SONET line protection
projection group, BLSR protection group, DSn (TPS) protection group,
UPSR protection group;
3. For OC-N line unit, the optical ports on this unit should not be in the tim-
ing source list;
4. The state for the equipment should be OOS-MA (OOS-AUMA) or AINS;
5. The main control unit (GXCS/XCS/XCSH/XO3/XO3D/XO12/XO12D) can
not be deleted. Otherwise the operation will be denied.
Category Equipment
Related Messages ED-EQPT
RTRV-EQPT
Input Format DLT-EQPT:[<TID>]:< AID >:<CTAG>;
<AID> The equipment unit identifier. It is an access identifier
from the section EQPT in Chapter 3 TL1 Parameters on
page ??.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-EQPT::SLOT-2:C;
Normal LoopStar 800 2004-01-01 11:37:18
M C COMPLD
;
Error LoopStar 800 2004-01-01 11:37:18
M C DENY
PLNA
;
Notes
DLT-EQPT-PG
Command DLT-EQPT-PG
Explanation Delete equipment protection group (PG)
Function This command deletes the specified equipment protection group.
Category DSn (TPS) protection
Related Messages ENT-EQPT-PG, ED-EQPT-PG, RTRV-EQPT-PG
Input Format DLT-EQPT-PG:[<TID>]:<AID>:<CTAG>;

<AID> Access identifier of any equipment in the protection group.
Valid value is shown in the section EQPT in Chapter 3 TL1
Parameters on page ??.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-EQPT-PG::SLOT-4:C;
Normal LoopStar 800 2004-01-01 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:54:55
M C DENY
PLNA
;
Notes 1. This command is not valid for XCS 1+1 protection groups which is inher-
ently created when the second XCS exists and deleted when the first
XCS is deleted.
2. The switch will be released automatically before the PG deleted if the PG
in a switching state.
DLT-ETHLINK
Command DLT-ETHLINK
Explanation Delete Ethernet link.
Function This command deletes an Ethernet link in the unit.
Category Ethernet
Related Messages ENT-ETHLINK
RTRV-ETHLINK
Input Format DLT-ETHLINK:[<TID>]:<LINK_FROM>,<LINK_TO>:<CTAG>:::
[INTAG=<INTAG>];
<LINK_FROM> The <ETN_PORT> which the link is from.Valid format is
FAC/VCG-<EQPT>-<PORT>.
<LINK_TO> The <ETN_PORT> which the link is to. Valid format is
<INTAG> Incoming tag. Valid value ranges from 1 to 4095. The tag
can be VLAN tag. It is optional and here means EPL.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors CFG_BD_NOT_EXIST (The unit does not exist.)

ETH_PORT_ERR (The port ID error.)
ETH_VLANIDERR (The VLAN ID error.)
ETH_LINK_NOEXIST (Expected eelete link does not exist.)
Example Input DLT-ETHLINK::FAC-1-2,VCG-1-4:100;

Normal SONET-NE 2004-01-01 12:23:20
M 100 COMPLD
;
Error SONET-NE 2004-01-01 12:23:20
M 101 DENY
IIAC
;
Notes
DLT-FFP-<OCN>
Command DLT-FFP-<OCN>
Explanation Delete facility protection group of optical level (OC3/OC12/OC48/OC192)
Function This command provides for disconnecting members of or an entire optical facility
protection group.
Category BLSR/SONET line protection
Related Messages ED-FFP-<OCN>
ENT-FFP-<OCN>
RTRV-FFP-<OCN>
RTRV-FFP-ALL
Input Format DLT-FFP-<OCN>:[TID]:<AID>:<CTAG>;
<OCN> The modifier that identifies the type of optical carrier
(OC) level. Valid value can be OC3 (not available to
BLSR), OC12, OC48, or OC192.
<AID> Access identifier identifies the OC-N port, which is in the
SONET line protection/BLSR group.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-FFP-OC3:SONET-NE:FAC-2-1:123;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
;
Error LoopStar 800 2004-03-08 09:59:42
M 100 DENY
IPNV
/*PARAMETER NOT VALID*/
/*38663:CFG_BAD_SLOTID*/
;
Notes The BLSR function part of this command can not be provided in the LoopStar
800 and LoopStar 810.
DLT-FLOW
Command DLT-FLOW
Explanation Delete flow
Function This command deletes a flow entry of the unit.
Category Ethernet
Related Messages ENT-FLOW

ED-FLOW
RTRV-FLOW
Input Format DLT-FLOW:[<TID>]:<AID>:<CTAG>;
<AID> Ethernet flow identifier. Valid format is FLOW-<SLOT ID>-
<FLOW ID>.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors ETH_BID_ER (The unit ID is invalid.)

CFG_CMD_NOT_SUPPORT (Do not support this command.
ETH_PARA_FLOWID (The flow ID parameter is invalid.)
ETH_FLOWID_NOTEXIST (The flow ID does not exist.)
Example Input DLT-FLOW::FLOW-1-10:100;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 101 DENY
IIAC
;
Notes
DLT-IPROUTE-STATIC
Command DLT-IPROUTE-STATIC
Explanation Delete IP route static
Function This command deletes static routes from the route table.
Related Messages ENT-IPROUTE-STATIC
RTRV-IPROUTE-STATIC
Input Format DLT-IPROUTE-STATIC:<TID>::<CTAG>:::DESTIP=<DESTIP>;
<DESTIP> Destination IP address.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-IPROUTE-STATIC:::100:::DESTIP=129.9.0.2;

Normal SONET-NE 2004-07-10 15:57:06
M 100 COMPLD
;
Error SONET-NE 2004-07-10 15:59:12
M 100 DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,THE ROUTE DOESN'T
EXIST*/
;
Notes
DLT-RFILE
Command DLT-RFILE
Explanation Delete remote file
Function This command deletes one file in NE. Delete a file in the <AID> specified unit of NE.
Category System
Related Messages
Input Format DLT-RFILE:[<TID>]:[<AID>]:<CTAG>::<FILEURL>;
<AID> SLOT-N or NULL. NULL value defaults to actived XCS unit.
<FILEUR> Valid format is "file://<url-path>". It identifies a file URL.
This parameter is used to specify a file path.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-RFILE:::C::"file://ofs1/hwx/ne.ini";
Normal LoopStar 800 2004-01-01 15:01:47
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:04:35
M C DENY
SDNR
/*DATA NOT READY,FILE DOES NOT EXIST*/
/*0X90B3*/
;
Notes
DLT-SNMPTRAPINFO
Command DLT-SNMPTRAPINFO
Explanation Delete SNMP trap information
Function This command deletes the SNMP trap information.
Category SNMP
Related Messages RTRV-SNMPTRAPINFO
Input Format DLT-SNMPTRAPINFO:[<TID>]::<CTAG>:::IP=<IPADDRESS>;
<IPADDRESS> IP address. The valid value is A, B and C type IP address.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-SNMPTRAPINFO:::100:::ip=129.9.0.3
Normal LoopStar 800 2004-01-01 15:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-07-13 16:23:34

M 100 DENY
IDMS
/*DATA MISSING, trap information wanted to delete is no exist */
;
Notes
DLT-SQL-<STS_PATH>
Command DLT-SQL-<STS_PATH>
Explanation Deletes squelch table entries (STS1/STS3C/STS6C/STS9C/STS12C/STS24C/
STS48C/STS192C)
Function This command deletes the squelch table entries on demand for the addressed NE.
This command is DENIED if the <SQLMODE> is AUTO, see ENT-FFP-<OCN>,
DLT-FFP-<OCN>, and RTRV-FFP-<OCN> for parameter <SQLMODE>. This
command can affect squelched traffic if executed when there are exiting switches.
Category BLSR
Related Messages ENT-SQL-<STS_PATH>
ED-SQL-<STS_PATH>
RTRV-SQL-<STS_PATH>
INIT-SQL-<OCN>
Input Format DLT-SQL-<STS_PATH>:[<TID>]:<AID>: <CTAG>;
<STS_PATH> The modifier that identifies the type of STS path. Valid
value can be STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C or STS192C.
<AID> Identifies the STS path for which the entry is to be edited or
entered. Value is applicable in section STS-N AID in
Chapter 3: TL1 Parameters on page ??.

;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-SQL-STS1::STS-3-1-1:1;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
;
Error LoopStar 800 2004-03-08 09:59:42
M 100 DENY
IPNV
;
Notes This command cannot be provided in the LoopStar 800 and LoopStar 810.
DLT-TIDIPMAP
Command DLT-TIDIPMAP
Explanation Delete TID-IP mapping.
Function This command deletes a static TID-IP mapping.
Related Messages ENT-TIDIPMAP
RTRV-TIDIPMAP
Input Format DLT-TIDIPMAP:[<TID>]:<CTAG>:::TID=<TID>;

;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-TIDIPMAP::C:::TID="NE101";
Normal LoopStar 800 2004-03-07 09:50:17
M C COMPLD
;
Error LoopStar 800 2004-03-08 09:59:42
M C DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST, NO INFORMATION FOUND*/
;
Notes
DLT-USER-SECU
Command DLT-USER-SECU
Explanation Delete user security
Function This command deletes a user in the NE.
Category Security
Security Superuser
Related Messages ENT-USER-SECU

ED-USER-SECU
RTRV-USER-SECU
INH-USER-SECU
Input Format DLT-USER-SECU:[<TID>]:<UID>:<CTAG>;
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input DLT-USER-SECU::USERNAME:C;
Normal LoopStar 800 2004-07-10 15:51:13
M C COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00
M C DENY
PIUC
/*STATED USER PRIVILEGE CODE IS ILLEGAL,USER NOT EXIST*/
/*0X9101*/
;
Notes You cannot delete the default user of the NE or a user which is online.
ED-<OCN>
Command ED-<OCN>
Explanation Edit (OC3, OC12, OC48, OC192)
Function This command edits the attributes of an OC-N (OC3, OC12, OC48, OC192)
facility.
Category Facility
Related Messages RTRV-<OCN>
Input Format ED-<OCN>:[<TID>]:<AID>:<CTAG>:::[BERSF=<BERSF>,]
[BERSD=<BERSD>,][LSRSTAT=<LSRSTAT>,][MANSSM=<MANSSM>,]
[TSSM=<TSMM>,][SVTIMER=<SVTIMER>,][PRI =<PRI>][:[<PST>][,<SST>]];
<OCN> The modifier that identifies the type of optical carrier (OC)
level. Valid values can be OC3, OC12, OC48, or OC192.
<AID> Identifies an OC-N access identifier. Valid values are shown in
the section "OCN".
<BERSF> Identifies the threshold of line (B2) SFBER on a facility. Valid
values are shown in the section "BER".
<BERSD> Identifies the threshold of line (B2) SDBER on a facility. Valid
values are shown in the section "BER".
<LSRSTAT> Laser state. Valid value is OPEN or CLOSE. Default value is
OPEN.
<MANSSM> Manually set the S1 byte of timing reference. NE will suppress
the timing switch base on this parameter as the quality of the
incoming synchronous source. Valid values are STU, PRS,
ST2, TNC, ST3E, ST3, PNO, CLEAR or DUS. Default value is
CLEAR. This parameter can be modified only by OCN in the
clock reference list.
<TSSM> Enable transmit S1 byte. Valid value is Y (enable) or N
(disable). Default value is Y.
<SVTIMER> Identifies the signal validation timer in minutes. Valid values
are shown in section "SVTIMER".
<PRI> The priority of the edited port. It is valid only when the port is in
a SONET line protection group. Valid value is HIGH and LOW.
Default value is LOW, which means the lowest switching
privilege.
<PST> The primary state of the AID port. Valid values for this are
shown in the "PROVISION_STATE" section. The state of port
should not be modified to OOS, if it is in the clock reference
list.
<SST> The secondary state of the AID port. Valid values for this are
shown in the "PROVISION_STATE" section.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-OC48::FAC-1-1:C::::IS;
Normal LoopStar 800 2004-01-01 12:20:12
M C COMPLD
;
Error SONET-NE 2004-01-01 12:20:12
M C DENY
SAIS
/*Status, Already In Service*/
;
Notes 1. Facility must be OOS-MA or OOS-AUMA before traffic affecting
parameters (LSRSTAT) can be edited.
2. Only following combinations of PST and SST are valid: IS,
OOS or AINS.
3. The threshold of section (B1) SFBER on a facility is fixed to 1E-5,
SDBER is fixed to 1E-6 and cannot be edited.
ED-<STS_PATH>
Command ED-<STS_PATH>
Explanation Edit STS Path (STS1, STS3C, STS12C)
Function This command edits the attributes associated with an STS-level path.
Category Facility
Related Messages RTRV-<STS_PATH>
Input Format ED-<STS_PATH>:[<TID>]:<AID>:<CTAG>:::[RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][SWPDIP=<SWPDIP>,][DELAYTIME=<DELAYTIME>,]
[BERSF=<BERSF>,][BERSD=<BERSD>,][J1TRCMODE=<J1TRCMODE>,]
[EXPTRCJ1=<EXPTRCJ1>,][TRCJ1=<TRCJ1>,][EXPTRCC2=<EXPTRCC2>],
[TRCC2=<TRCC2>] [:<PST>];

value can be STS1, STS3C, STS6C, STS9C, STS12C,
<AID> Access identifier for STS path. Valid values are shown in
the section "STSN".
<RVRTV> Identifies a revertive mode which only applies to UPSR.
Valid values are shown in the section "REVERTIVE
MODE".
<RVTM> Identifies a revertive time which only applies to UPSR.
Valid values are shown in the section "REVERTIVE TIME".
<SWPDIP> Optional switching condition. Valid value is Y (switch when
existing PDI-P) or N (do not switch when existing PDI-P).
Default value is N.
<DELAYTIME> Delay time. It is an integer. Valid value ranges from 0 to 255
Unit is 100 milliseconds. Default value is 0.
<BERSF> Threshold of path (B3) SFBER on a facility. Valid values
are shown in the section "BER".
<BERSD> Threshold of path (B3) SDBER on a facility. Valid values
are shown in the section "BER".
<J1TRCMODE> Path trace mode. Valid values are shown in the section "J1
MODE".
<EXPTRCJ1> Expected path trace (J1) message content to be received.
It is any 62 character string quoted with double quotation
marks and does not support space without double
quotation marks.
<TRCJ1> Path trace message to be transmitted. It is any 62 character
string quoted with double quotation marks and does not
support space without double quotation marks. Default
value is null characters. This parameter only applies to
STS_PATH which is in cross-connect from DSn unit to
OC-N unit.
Input Parameter <EXPTRCC2> Expected C2 byte hex code. Valid values are shown in
(cont.) section "C2" of Charpter 3 TL1 Parameters. Default value is
LOAD.
<TRCC2> C2 byte hex code to be transmitted. Valid values are shown
in section "C2" of Charpter 3 TL1 Parameters. This
parameter only applies to STS_PATH which is in cross-
connect from DSn unit to OC-N unit.
<PST> Means the primary state of the AID path. Valid values are
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-STS1::STS-1-1-1:C::::IS;
Normal LoopStar 800 2004-01-01 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:54:55
M C DENY
PLNA
;
Notes Valid states are OOS or IS.
ED-<VT_PATH>
Command ED-<VT_PATH>
Explanation Edit VT Path
Function This command edits the attributes associated with a VT (VT1.5/VT2) path.
Category Facility
Related Messages RTRV-<VT_PATH>
Input Format ED-<VT_PATH>:[<TID>]:<AID>:<CTAG>:::[RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][DELAYTIME=<DELAYTIME>,][BERSDV=<BERSDV>,]
[BERSFV=<BERSFV>,][:<PST>];
<VT_PATH> The modifier that identifies the type of VT path. Valid value is
VT1.5 or VT2.
<AID> Identifies a access identifier for VT path. Valid values are
shown in the section "VTN".
<RVRTV> Identifies a revertive mode which only applies to UPSR. Valid
values are shown in the section "REVERTIVE MODE".
<RVTM> Identifies a revertive time which only applies to UPSR, valid
value is in the section "REVERTIVE TIME".
<DELAYTIME> Identifies the delay time. It is an integer. Valid value ranges
from 0 to 255 in 100 ms increments. Default value is 0.
<BERSDV> BIP2 SD threshold. Valid value are shown in the section
"BER".
<BERSFV> BIP2 SF threshold Valid value are shown in the section
"BER".
<PST> Means the primary state of the AID path. Valid values are
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
(^^^"<error description>"<cr><lf>) *
(^^^/*error text*/<cr><lf>) *
;
Errors
Example Input ED-VT1::VT1-1-3-1-1-1:C::::IS;
Normal LoopStar 800 2004-01-01 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:54:55
M C DENY
PLNA
;
Notes Valid states are OOS or IS.
ED-BITS
Command ED-BITS
Explanation Edit building integrated timing supply (BITS)
Function This command edits the attributes of external clock of NE. There are two
external clock interface for each NE, they are BITS-1 and BITS-2. And for each
BITS interface, there are two types of attributes for BITS-IN and BITS-OUT
individual.
This command can be used to edit each type of attributes of each external clock
interface by special AIDs and parameters. See the parameters description for
detail.
Category Synchronization
Related Messages RTRV-BITS
Input Format ED-BITS:[<TID>]:<AID#BITSIN-1/BITSIN-2>:<CTAG>:::
[LINECDE=<LINECDE>,][FMT=<FMT>,][MANSSM=<MANSSM>,]
[SVTIMER=<SVTIMER>][:<PST>[,<SST>]];
ED-BITS:[<TID>]:<AID#BITSOUT-1/BITSOUT-2>:<CTAG>:::[LBO=<LBO>,]
[LINECDE=<LINECDE>,][FMT=<FMT>,][AISTH=<AISTH>,][TSSM=<TSSM>,]
[MSGMODE=<MSGMODE>,][SVTIMER=<SVTIMER>][:<PST>[,<SST>]];

<AID> Access identifier of BITS facility. Valid values are BITSIN-1
(input interface of BITS-1), BITSIN-2 (input interface of BITS-
2), BITSOUT-1 (output interface of BITS-1) or BITSOUT-2
(output interface of BITS-2).
<LBO> Line buildout. Valid values are shown in the section "LINE
BUILDOUT". The meaning is same as that of DS1. Default
value is 1. This parameter is only for BITSOUT interface. The
state of the AID facility should be OOS-MA or OOS-AUMA
before editing this attribute.
Input Parameter <LINECDE> Line code. Valid value is B8ZS or AMI. Default value is
(cont.) B8ZS. This parameter means input line code for BITS-IN
interface or output line code for BITS-OUT interface
specially. The state of the AID facility should be OOS-MA or
OOS-AUMA before editing this attribute.
<FMT> Frame format. Valid format is ESF or SF. Default value is
ESF. This parameter means input frame format for BITS-IN
interface or output frame format for BITS-OUT interface
specially. For BITS-OUT interface, this attribute can be
edited to SF only if the <MSGMODE> is AIS. The state of the
AID facility should be OOS-MA or OOS-AUMA before editing
this attribute.
<AISTH> The quality threshold of incoming SSM. If the incoming SSM
is lower than AISTH, NE will insert AIS into the outgoing
signal of this BITS clock. Valid values are STU, PRS, ST2,
TNC, ST3E, ST3, PNO or DUS. Default value is DUS. This
parameter is only for BITS-OUT interface. This attribute can
be edited only if the MSGMODE is AIS. PNO mean the RES
quality class that the user provisioned. See "RES quality
class" section for detail.
<MANSSM> Manually set tht S1 byte of timing reference. NE will presses
BITS-IN synchronous source. Valid valuea are STU, PRS,
ST2, TNC, ST3E, ST3, PNO, CLEAR or DUS. Default value
is CLEAR. This parameter is only for BITS-IN interface, and
it can be modified only by BITS-IN in the clock reference list.
PNO mean the RES quality class that the user provisioned.
See "RES quality class" section for detail.
<TSSM> Enable transmit S1 byte. Valid value is Y (enable) or N
(disable). Default value is Y. This parameter is only for BITS-
OUT interfaces.
<MSGMODE> Pass-through mode or AIS mode. Valid value is PASSTHRU
(use pass-through mode) or AIS (use AIS mode). Default
value is PASSTHRU. This parameter is only for BITS-OUT
interface. This attribute can be edited to PASSTHRU if only
the FMT is ESF.
<SVTIMER> Signal validation timer in minutes. Only valid if Auto In-
Service feature is supported. <SVTIMER> is a string, and
theformat is HH-MM. Valid value ranges from 00-01 to 48-
00. Default value is 00-01.
<PST> Means the primary state of the AID port. Valid values are
shown in the "PROVISION_STATE" section. The state of
BITS-IN should not be modified to OOS, if it is in the clock
reference list.
<SST> Means the secondary state of the AID port. Valid values are

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-BITS::BITSIN-1:C:::LINECDE=AMI,FMT=ESF,MANSSM=STU,
SVTIMER=0-5;
ED-BITS::BITSOUT-1:C:::LBO=1,LINECDE=B8ZS,FMT=EFS,AISTH=PROS,
MSGMODE=AIS,SVTIMER=05-00;
Normal LoopStar 800 2004-01-01 09:25:57
M C COMPLD
;
Error LoopStar 800 2004-01-01 09:25:59
M C DENY
IDNC
/*DATA NOT CONSISTENT*/
;
Notes
ED-CAR
Command ED-CAR
Explanation Edit committed access rate (CAR)
Function This command edits the CAR attribute.
Category Ethernet
DLT-CAR
RTRV-CAR
Input Format ED-CAR:[<TID>]:<AID>:<CTAG>:::[CARENABLE=<CARENABLE>],
[CIR=<CIR>];
<CAR ID>. The <CAR ID> ranges from 1 to 2048.
<CARENABLE> Enable state of CAR. Valid value is Y (1) or N (0). The initial
value is N (0). It is optional and will not change until it is set.
<CIR> Committed information rate of CAR. Its unit is 1 kbits/s,
and generally, its step is 64 kbit. It is optional and will not
change until it is set.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

CFG_CMD_NOT_SUPPORT (NOT support this command.)
ERR_ETH_PARA_CARID (The CAR ID parameter is invalid.)
ERR_ETH_PARA_CARCIR (The CAR CIR parameter is invalid.)
ERR_ETH_GRANULARITY_NOT_SUPPORT (The CAR CIR parameter does
not support this granularity.)
ERR_ETH_CARID_NOTEXIST (The CAR ID parameter does not exist.)
Example Input ED-CAR::CAR-5-10:100:::CARENABLE=Y,CIR=10240;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 101 DENY
IIAC
;
Notes
ED-COS
Command ED-COS
Explanation Edit class of service (COS)
Function This command edits a class of service (COS) attribute in the unit.
Category Ethernet
RTRV-COS
DLT-COS
Input Format ED-COS:[<TID>]:<AID>:<CTAG>:::[SIMPLEPRI=<SIMPLEPRI>];

<AID> Indicates the identify of COS. Valid value is <ETN_COSID> which
format is COS-<SLOT ID>-<COS ID>.
<SIMPLEPRI> Indicates the simple priority. It is optional and will not change until
it is set. <SIMPLEPRI> does not have default value and is
available only if <COSTYPE> is SIMPLE (see ENT-COS).
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

ERR_ETH_PARA_PKTFORWARD (The SIMPLEPRI parameter is invalid.)
Example Input ED-COS::COS-5-1:100:::SIMPLEPRI=1;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 101 DENY
IIAC
;
Notes
ED-CRS-<STS_PATH>
Command ED-CRS-<STS_PATH>
Explanation Edit cross-connection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C)
Function This command edits the attributes of a normal cross connection.
3. The AID format in the command is the same as the AID format in the
retrieved response message. For example, if the output of any retrieved
AID is "F1&F2,T1:CCT", the command with the AID format (F1&F2,T1) is
required to edit this cross-connection.
4. Following command are used to edit the name of the specified.
ED-CRS-<STS_PATH>::F1,T1:<CTAG>:::CKTID=FISTONE;
5. <PREFERREDPATH> parameter means the work path of UPSR.
6. Following command are used to change the preferred path from F1 to F2.
ED-CRS-<STS_PATH>::F1&F2,T1:<CTAG>:::PREFERREDPATH=F2;
7. If the specified cross connection is 1-way, following command is used to
change the preferred path from F1 to F2.
ED-CRS-<STS_PATH>::F1&F2,T1&T2:<CTAG>:::PREFERREDPATH
=F2;
8. If the specified cross connection is 2-way,
a. following command is used to change the preferred path from F1 to F2.
ED-CRS-<STS_PATH>::F1&F2,T1&T2:<CTAG>:::
PREFERREDPATH =F2;
b. following command is used to change the preferred path from T1
to T2.
PREFERREDPATH =T2;
c. following command is used to change the preferred path from T1 to T2
and from F1 to F2.
PREFERREDPATH =F2&T2;
9. If switch state is not idle, or there is auto switching condition (such as AIS,
LOF, PLM-P ) edit the preferred path will result an error.
10. Following command is used to edit the red-lined state of the specified
cross-connection.
ED-CRS-<STS_PATH>::F1,T1:<CTAG>::::,RDLD-DEA;
Category Cross-connection

RTRV-CRS-<STS_PATH>
DLT-CRS-<STS_PATH>
Input Format ED-CRS-<STS_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>:::
[PREFERREDPATH=<PREFERREDPATH>,][CKTID=<CKTID>]:[,<SST>];
<STS_PATH> Identifies the type of STS and VT path. Valid values are STS1,
STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, or
STS192C.
<FROM> Access identifier. It can be the source or destination of cross
connection, or any one path of source or destination. It can be null
which means retrieving all cross connections with entered rate
level. "&" is allowed. (See STS and VT parameter descriptions in
Chapter 3: TL1 Parameters.)
<TO> Access identifier identifies the other end of the STS cross
connection. If creating 1-to-N one-way cross-connection, multiple
'&' and '&&'are allowed, else only one "&"is allowed. <TO> cannot
be null.
<PREFERRE Preferred path. <PREFERREDPATH> is only supplied for UPSR.
DPATH> <PREFERREDPATH> indicates which source will be protected.
One "&" is allowed.
<CKTID> The circuit identification. It is an alphanumeric string. The max
length is 32 characters. The <CKTID> parameter contains the
common language circuit ID or other alias of the circuit being
provisioned.
<SST> Redline state. Valid values are shown in the section "SST STATE"
in Chapter 3: TL1 Parameters.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-CRS-STS1::STS-3-1-1&STS-4-1-1,STS-5-1-1:123:::PREFERREDPATH=

STS-3-1-1,CKTID=SHENZHEN:,RDLD;
Normal LoopStar 800 2004-03-15 15:54:55
M 116 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 116 DENY
PLNA
;
Notes Only LoopStar 1600 supports STS24C, STS48C, and STS192C.
Command ED-CRS-<STS_PATH/VT_PATH>
Explanation Edit cross-connection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1.5, VT2)
Function This command edits the attributes of a normal cross connection.
3. The AID format in the command is the same as the AID format in the
retrieved response message. For example, if the output of any retrieved
AID is "F1&F2,T1:CCT", the command with the AID format (F1&F2,T1) is
required to edit this cross-connection.
4. Following command are used to edit the name of the specified.
ED-CRS-<STS_PATH/VT_PATH>::F1,T1:<CTAG>:::CKTID=FISTONE;
5. <PREFERREDPATH> parameter means the work path of UPSR.
6. Following command are used to change the preferred path from F1 to F2.
ED-CRS-<STS_PATH/
VT_PATH>::F1&F2,T1:<CTAG>:::PREFERREDPATH=F2;
7. If the specified cross connection is 1-way, following command is used to
change the preferred path from F1 to F2.
ED-CRS-<STS_PATH/
VT_PATH>::F1&F2,T1&T2:<CTAG>:::PREFERREDPATH =F2;
8. If the specified cross connection is 2-way,
a. following command is used to change the preferred path from F1 to F2.
ED-CRS-<STS_PATH/
VT_PATH>::F1&F2,T1&T2:<CTAG>:::PREFERREDPATH =F2;
b. following command is used to change the preferred path from T1
to T2.
ED-CRS-<STS_PATH/
VT_PATH>::F1&F2,T1&T2:<CTAG>:::PREFERREDPATH =T2;
c. following command is used to change the preferred path from T1 to T2
and from F1 to F2.
ED-CRS-<STS_PATH/
VT_PATH>::F1&F2,T1&T2:<CTAG>:::PREFERREDPATH =F2&T2;
9. If switch state is not idle, or there is auto switching condition (such as AIS,
LOF, PLM-P ) edit the preferred path will result an error.
10. Following command is used to edit the red-lined state of the specified
cross-connection.
ED-CRS-<STS_PATH/VT_PATH>::F1,T1:<CTAG>::::,RDLD-DEA;

Input Format ED-CRS-<STS_PATH/VT_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>:::
[PREFERREDPATH=<PREFERREDPATH>,][CKTID=<CKTID>]:[,<SST>];
<STS_PATH/ Identifies the type of STS and VT path. Valid values are STS1,
VT_PATH> STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,
VT1.5 or VT2.
<FROM> Access identifier. It can be the source or destination of cross
connection, or any one path of source or destination. It can be null
which means retrieving all cross connections with entered rate
level. "&" is allowed. (See STS and VT parameter descriptions in
<TO> Access identifier identifies the other end of the STS cross
connection. If creating 1-to-N one-way cross-connection, multiple
'&' and '&&'are allowed, else only one "&"is allowed. <TO> cannot
be null.
<PREFERRE Preferred path. <PREFERREDPATH> is only supplied for UPSR.
DPATH> <PREFERREDPATH> indicates which source will be protected.
One "&" is allowed.
<CKTID> The circuit identification. It is an alphanumeric string. The max
length is 32 characters. The <CKTID> parameter contains the
provisioned.
<SST> Redline state. Valid values are shown in the section "SST STATE"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-CRS-STS1::STS-3-1-1&STS-4-1-1,STS-5-1-1:123:::PREFERREDPATH=

STS-3-1-1,CKTID=SHENZHEN:,RDLD;
Normal LoopStar 800 2004-03-15 15:54:55
M 116 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 116 DENY
PLNA
;
Notes Only LoopStar 1600 supports STS24C, STS48C, and STS192C.
ED-DAT
Command ED-DAT
Explanation Edit date
Function This command sets the date and the time.
Category System
Related Messages RTRV-DAT
Input Format ED-DAT:[<TID>]::<CTAG>::[<DATE>],[<TIME>],[<TMZONE>],[<DSTIME>];
<DATE> Identifies the current date in a format of YYYY-MM-DD, where
YYYY is the last two digits of the year ranging from 1990 to 2087,
MM is the month of the year ranging from 1 to 12, and DD is the
day of the month ranging from 1 to 31.
<TIME> Identifies the current time in a format of HH-MM-SS, where HH is
the hour in a 24 hour format ranging from 00 to 23, MM is the
minute ranging from 00 to 59, and SS is the second ranging from
00 to 59.
<TMZONE> Identifies a time zone. Valid values are Eastern, Central,
Mountain, Pacific, Alaska, Hawaii, Samoa or UTC. <TMZONE>
also supporting general time zone GMT-n and GMT+n.
<DSTIME> Identifies whether support daylight saving time or not. Valid value
is Y (support) or N (not support).

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

ERR_ETH_PARA_PKTFORWARD (The SIMPLEPRI parameter is invalid.)
Example Input ED-DAT:::100::2002-08-26,13-23-45,Eastern,N;
Normal LoopStar 800 2004-01-01 00:00:00
M 100 COMPLD
;
Error LoopStar 800 2004-07-08 15:37:20
M 100 DENY
IPEX
/*PARAMETER EXTRA*/
/*ED-DAT:::1000::2004-3-2,2-0-0,UTC,N;*/
;
Notes
ED-DCC
Command ED-DCC
Explanation Edit DCC
Function This command edits the link protocol type of a DCC channel.
Related Messages RTRV-DAT
Input Format ED-DCC:[<TID>]:<AID>:<CTAG>:::[PROTOCOL=<PROTYPE>];
<AID> Access identifier which indicates the DCC channel. Valid format is
DCC-<UNIT ID>-<PORT ID>-<CHANNEL>. The valid values of
<CHANNEL> are
1 (SDCC, D1 to D3);
2 (LDCC, D4 to D12);
3 (LDCC2, D4 to D6);
4 (LDCC3, D7 to D9);
5 (LDCC4, D10 to D12).
<PROTYPE> The protocol of DCC link layer. Default is AUTO. The valid
values are:
• TRANSPARENT (there is no link protocol, the channel is free
for in CRS);
• PPP (set IP stack is in this channel);
• LAPD (set OSI stack is in this channel);
• ECC (set ECC stack is in this channel);
• AUTO (auto-negotiation or default protocol stack).
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-DCC::DCC-1-1-1:C:::PROTOCOL=TRANSPARENT;
Normal LoopStar 800 2004-11-15 05:04:28
M C COMPLD
;
Error LoopStar 800 2004-11-15 05:04:28
M C DENY
SDNC
/*INPUT DATA IS NOT CONSISTENT WITH NE DATA,ERROR IN
PARAMETER*/
;
Notes Now setting protocol stack in a single port is not supported. But auto-negotiation is
supported.
ED-EQPT
Command ED-EQPT
Explanation Edit equipment
Function This command edits the unit type and attributes for a given equipment slot in the
NE. Three attributes can be modified for a unit:
1. Priority of working unit in the DSn (TPS) protection group.
2. Unit type and interface type the unit.
3. State for the equipment.
Above three attributes can be modified once a time for a TL1 command, which
means user cannot modify both unit type and state at the same time, and so on.
Category Equipment
Related Messages RTRV-EQPT
DLT-EQPT
Input Format ED-EQPT:[<TID>]:<AID>:<CTAG>:::[TPSPRI=<TPSPRI>],
[PROVTYPE=<CARDTYPE>],[INTFTYPE=<INTFTYPE>]:[[<PST>],[<SST>]];

<AID> The equipment unit identifier. It is an access identifier from the
section "EQPT" in Chapter 3: TL1 Parameters.
<TPSPRI> Identifies the priority of the unit if the unit is a working unit of a
DSn (TPS) protection group. For any other units, this parameter is
not available. This attribute will be used when muti-units fault in a
DSn (TPS) protection group. Valid values for <TPSPRI> are
shown in the "TPS_PRIORITY" section.
<CARDTYPE> Identifies the unit type. Valid values for <CARDTYPE> are shown
in section "CARDTYPE" of Chapter 3: TL1 Parameters.
<INTFTYPE> Identifies the unit interface type. Valid values for <INTFTYPE> are
shown in Chapter 3: TL1 Parameters. This parameter is optional
and can be used only for DSn units.
<PST> Identifies the primary state of the AID unit. Valid values are shown
in the "PROVISION_STATE" section.
<SST> Identifies the secondary state of the AID unit. Valid values are
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-EQPT:SONET-NE:SLOT-7:C::::IS;
Normal LoopStar 800 2004-11-15 05:04:28
M C COMPLD
;
Error LoopStar 800 2004-01-01 07:28:39
M C DENY
PLNA
;
Notes This command is only applied for the unit type modification during unit upgrade. It
cannot be used to modify unit type in common circumstance.
ED-EQPT-PG
Command ED-EQPT-PG
Explanation Edit equipment protection group
Function This command edits the attribute of an equipment protection group.
Related Messages RTRV-EQPT-PG
DLT-EQPT-PG
ENT-EQPT-PG
Input Format ED-EQPT-PG:[<TID>]:<AID>:<CTAG>:::[RVRTV=<RVRTV>][RVTM=<RVTM>]
[,WORK=<WORK>];
<AID> Identifies any equipment in a protection group. Valid values are
shown in the section "EQUIPMENT AID".
<RVRTV> Revertive mode. Valid values are shown in the section
"REVERTIVE MODE".
<RVTM> Revertive time. Valid values are shown in the section
"REVERTIVE-TIME".
<WORK> Working equipment AID(s). Support "&" which means more than
one working unit. Valid values are shown in the section
"EQUIPMENT AID".
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-EQPT-PG::SLOT-4:C:::RVRTV=Y,RVTM=5,WORK=SLOT-3&SLOT-5;

Normal LoopStar 800 2004-01-01 18:08:44
M C COMPLD
;
Error LoopStar 800 2004-01-01 18:08:44
M C DENY
PLNA
;
Notes 1. This command is not valid for XCS protection group.
2. If there are working units be added to the PG, the working and related
interface units must be created before the PG by auto provisioning or
ENT-EQPT command.
3. The working units cannot be added to the PG when it includes a unit in
OOS-MA or OOS-AUMA state.
4. The working parameter is the new working units of the PG. All the working
unit in the protection group and not in the parameter will be deleted.
5. The editing of the PSTYPE is not supported because only the 1-N type is
supported. The value of the RVRTV can only be Y.
ED-ETH-EQPT
Command ED-ETH-EQPT
Explanation Edit Ethernet equipment
Function This command edits the Ethernet attributes in the unit.
Category Configuration
Related Messages RTRV-ETH-EQPT
Input Format ED-ETH-EQPT:[<TID>]:<AID>:<CTAG>:::[JUMBOTYPE=<JUMBOTYPE>];
<AID> Indicates the slot. Valid value is SLOT-N.
<JUMBOTYPE> Indicates the type field value of jumbo frame. It is optional and will
not change until it is set.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-ETH-EQPT::SLOT-1:100:::JUMBOTYPE=34887;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 100 DENY
IIAC
"invalid access identifier"
;
Notes
ED-FETH
Command ED-FETH
Explanation Edit Fast Ethernet
Function This command edits the attribute of a fast Ethernet port.
Category Ethernet
Related Messages RTRV-FETH
Input Format ED-FETH:[<TID>]:<AID>:<CTAG>:::[WORKMODE=<WORKMODE>],

[FLOWCTRL=<FLOWCTRL>],[MTU=<MTU>],[PORTENABLE=
<PORTENABLE>],[TAGTYPE=<TAGTYPE>],[PVID=<PVID>],[PVPRI=
<PVPRI>],[PSVID=<PSVID>],[PSVPRI=<PSVPRI>],[STAGTYPE=
<STAGTYPE>],[SVENABLE=<SVENABLE>]:[PST];
<AID> Ethernet facility which is compose of slot ID and port ID.
Valid format is FAC-<SLOT ID>-<PORT ID>. Support &
or && symbol.
<WORKMODE> The work mode of the port. It is optional and will not
<FLOWCTRL> The non-auto-negotiation flow control attribute of the
port. It is optional and will not change until it is set.
<MTU> The maximum transmission unit of the port. It is
optionaland will not change until it is set.
<PORTENABLE> Enable or disable the port. It is optional and will not
change until it is set. Valid value is Y (enable) or N
(disable).
<PVID> The default VLAN ID of the port. It is optional and will
not change until it is set.
<PVPRI> The priority of the default VLAN for the port. It is
optional and will not change until it is set.
<TAGTYPE> The tag type of the port. It is optional and will not
<PSVID> Indicates the default service VLAN ID of the port. It is
<PSVPRI> Indicates the priority of the default service VLAN for the
<STAGTYPE> Indicates the service VLAN tag attribute of the port. It is
<SVENABLE> Indicates the service VLAN enable attribute of the port.
It is optional and will not change until it is set.
<PST> Indicates the Ethernet port state. Valid can be IS or
OOS. It is optional. <PST> must be transferred to OOS
state first when change the following parameters:
<PORTENABLE>, <WORKMODE>, <MACLPBK>,
<PHYLPBK, MTU>, <TAGTYPE>, <PVID>,
<SVENABLE>, <STAGTYPE> and <PSVID>.

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-FETH::FAC-5-2:100:::WORKMODE=AUTO,FLOWCTRL=DISABLE,
MTU=1522,PORTENABLE=Y,TAGTYPE=ACCESS,PVID=22,PVPRI=2,
PSVID=1000,PSVPRI=7,STAGTYPE=TAGAWARE;
ED-FETH::FAC-5-2:100:::SVENABLE=N;
ED-FETH::FAC-5-2:100::::OOS;
Normal LoopStar 800 2004-01-01 14:30:00
M 100 COMPLD
;
Example Error LoopStar 800 2004-01-01 14:30:00
M 100 DENY
IIAC
;
Notes
ED-FFP-<OCN>
Command ED-FFP-<OCN>
Explanation Edit facility protection Ggroup (OC3, OC12, OC48, OC192)
Function This command edits the attributes of an optical facility protection group.
Related Messages ENT-FFP-<OCN>

DLT-FFP-<OCN>
RTRV-FFP-<OCN>
RTRV-FFP-ALL
Input Format ED-FFP-<OCN>:[<TID>]:<AID>:<CTAG>:::[FFPTYPE=<FFPTYPE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIRN=<PSDIRN>],
[TPLMODE=<TPLMODE>],[SQLMODE=<SQLMODE>],[RINGID=<RINGID>],
[NODEID=<NODEID>];
<OCN> Identifies the type of optical carrier (OC) level. Valid values are
OC3 (not for BLSR), OC12, OC48, or OC192.
<AID> The facility AID of any OC-N that is part of the protection group.
<FFPTYPE> The type of protection group. Valid values are:
1+1 (1+1 protection architecture);
1-N (1:N protection architecture);
2BLSR (2-fiber BLSR);
4BLSR (4-fiber BLSR).
The 1+1 OPT protection architecture cannot be changed to
1+1 or 1-N and neither conversely.
"REVERTIVE MODE". Default value is N. This parameter
cannot be changed in 1+1 OPT mode.
"REVERTIVE-TIME". In BLSR mode, the ring and span RVTM
are the same, and 99 means non-revertive mode.
<PSDIRN> Switching mode. Valid value is UNI (unidirectional switching) or
BI (directional switching). This parameter is only applicable to
SONET line protection. This parameter cannot be changed in
1+1 OPT mode.
<TPLMODE> Topology mode. Valid value is AUTO (automatic) or MAN
(manual). The default value is AUTO. This parameter is only
applicable to BLSR.
<SQLMODE> Squelch mode. Valid value is AUTO (automatic) or MAN
(manual). The default value is AUTO. This parameter is only
applicable to BLSR.
Input Parameter <RINGID> Identifier of a BLSR ring. It is a string of up to 16 characters.

(cont.) <NODEID> Identifier of node in a BLSR ring. It is an integer and ranges
from 0 to 15. This parameter is only applicable to BLSR.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input 1+1 SONET protection example:
ED-FFP-OC3:SONET-NE:FAC-2-
1:100:::FFPTYPE=1+1,RVRTV=Y,RVTM=5,PSDIRN=BI;
BLSR example:
ED-FFP-OC12:SONET-NE:FAC-3-
1:100:::FFPTYPE=2BLSR,RVRTV=Y,RVTM=5,TPLMODE=AUTO,
SQLMODE=AUTO,RINGID=1,NODEID=1;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
;
Error LoopStar 800 2004-03-08 09:59:42
M 100 DENY
IPNV
;
ED-FLOW
Command ED-FLOW
Explanation Edit flow
Function This command edits a flow entry of the unit.
Category Ethernet
DLT-FLOW
RTRV-FLOW
Input Format ED-FLOW:[<TID>]:<AID>:<CTAG>:::[CARID=<ETN_CARID>],
[COSID=<ETN_COSID>];
<FLOW ID>.
<ETN_CARID> Indicates the associated CAR. Valid format is CAR-
<SLOT ID>-<CAR ID>. Null value means the flow does
not have CAR.
<ETN_COSID> Indicates the identify of COS. Valid format is COS-<slot
ID>-<COS ID>. Null value means the flow does not
have COS.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

ETH_PARA_FLOWID (The flow ID parameter is invalid.)
ETH_PARA_CARID (The <ETN_CARID> parameter is invalid.)
ETH_PARA_COSID (The <ETN_COSID> parameter is invalid.)
ETH_FLOWID_NOTEXIST (The flow ID does not exist.)
ETH_CAR_NOTSUPPORT (CAR is not supported for this flow.)
ETH_CARID_NOTEXIST (The CAR ID does not exist.)
ETH_COSID_NOTEXIST (The COS ID does not exist._
ETH_CARUSED_INDIFFBLOCK (CAR can not be used in different block.)
Example Input ED-FLOW::FLOW-5-1:100:::CARID=CAR-5-20,COSID=COS-5-10;
ED-FLOW::FLOW-5-1:100:::CARID=NULL,COSID=NULL;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 100 DENY
IIAC
;
Notes
ED-GETH
Command ED-GETH
Explanation Edit Gigabit Ethernet
Function This command edits the attribute of a Gigabit Ethernet port.
Related Messages RTRV-GETH
Input Format ED-GETH:[<TID>]:<AID>:<CTAG>:::[WORKMODE=<WORKMODE>],
[FLOWCTRL=<FLOWCTRL>],[MTU=<MTU>],[PORTENABLE=
<PORTENABLE>]:[PST];

<AID> Ethernet facility which is compose of slot ID and port ID.
Valid format is FAC-<SLOT ID>-<PORT ID>. Support &
or && symbol.
<WORKMODE> The work mode of the port. It is optional and will not
change until it is set. Valid values are:
• AUTO (AUTO is the initial value and means auto-
negotiation.);
• FULL1000M (1000 Mbit/s full-duplex mode.).
<FLOWCTRL> The non-auto-negotiation flow control attribute of the
<MTU> The maximum transmission unit of the port. It is
<PORTENABLE> Enable or disable the port. It is optional and will not
<PST> Indicates the Ethernet port state. Valid can be IS or
OOS. It is optional. PST must be transferred to OOS
state first when changing the following parameters
<PORTENABLE>, <WORKMODE>, <MACLPBK>,
<PHYLPBK>,<MTU>, <TAGTYPE>, <PVID>,
<SVTPID>, <SVENABLE>, <STAGTYPE> and
<PSVID>.
Output Input ED-GETH::FAC-5-2:100:::WORKMODE=AUTO,FLOWCTRL=DISABLE,
Format MTU=1522,PORTENABLE=Y;
ED-GETH::FAC-5-2:100::::OOS;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 100 DENY
IIAC
;
Errors
Example Input ED-GETH::FAC-5-2:100:::WORKMODE=AUTO,FLOWCTRL=DISABLE,

MTU=1522,PORTENABLE=Y;
ED-GETH::FAC-5-2:100::::OOS;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 100 DENY
IIAC
;
Notes
ED-LAN
Command ED-LAN
Explanation Edit LAN
Function This command edits the attributes and state of a LAN facility.
Related Messages
Input Format ED-LAN:[<TID>]:<AID>:<CTAG>:::[IP=<IPADDR>,][MASK=<SUBNETMASK>,]
[ENABLE=<ENABLE>];
<AID> Access identifier which indicates the LAN number. The
valid value is LAN-1.
<IPADDR> IP address. The valid value is A, B and C type IP address.
Null value means that not to change the value before
setting.
<SUBNETMASK> Subnet mask address. Null value means that not to
change the value before setting.
<ENABLE> Enable state. The valid value is N (user will not have
access to this port or management flow through this port.)
or Y (this port is enabled and users are allowed to use this
port for communication with NE.) Null value means that
not to change the value before setting.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-LAN::LAN-1:C:::IP=192.168.0.33,MASK=255.255.255.0,ENABLE=Y;

Normal LoopStar 800 2004-01-01 15:23:20
M C COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00
M C DENY
PLNA
/*LONGIN NOT ACTIVE*/
;
Notes 1. If modifying any parameters in the IP stack (IP address or subnet mask),
It should effective without restart of the unit. Or its neighbors - It should
update itself and its neighbors without requiring any reset to it self or its
neighbors. Created automatically when XCS unit is inserted. For both
XCS-A and XCS-B there only one LAN port active any time.
2. It is not recommended to set <ENABLE> to N. Because if the LAN port is
disabled, user cannot access the equipment over LAN and can only
access the equipment over serial port.
ED-NEID
Command ED-NEID
Explanation Edit NE ID.
Function This command edits the ID number of a NE. The ID is necessary to Qx Interface.
Related Messages RTRV-NEID
Input Format ED-NEID:[<TID>]::<CTAG>:::ID=<NEID>;
<NEID> The ID of a NE. The valid value ranges from 65537 to
16695279 (equal to 0x10001 to 0xfebfef).
Format
^^^<rsphdr><cr><lf>
<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-NEID:::100:::ID=1048595;
Normal LoopStar 800 2004-03-04 15:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-03-04 14:30:00
M 100 DENY
PLNA
;
Notes This command is a only for the Qx interface.
ED-OSPF-DCC
Command ED-OSPF-DCC
Explanation Edit open shortest path first (OSPF) DCC
Function This command edits the DCC-type interface(s) parameters of OSPF protocol.
Related Messages
Input Format ED-OSPF-DCC:[<TID>]::<CTAG>:::[COST=<COST>],[HELLO=<HELLOTIMER>],
[DEAD=<DEADTIMER>],[RETRANSMIT=<RETRANSMITTIMER>],
[DELAY=<TRANSITDELAY>],[NOTSILENCE=<NOT_SILENCE>];
<COST> Identifies the cost. Valid value ranges from 1 ot 65535. Default
value is 100.
<HELLOTIMER> Identifies the hello timer. Valid value ranges from 1 to 255.
Default value is 1.
<DEADTIMER> Identifies the dead timer. Valid value ranges from 1 to 65535.
Default value is 6. <DEADTIMER> should be at least 4 times of
<HELLOTIMER>.
<RETRANSMITTI Identifies the re-transmit timer. Valid value ranges from 1 to
MER> 65535. Default value is 5.
<DELAY> Identifies the transit delay. Valid value ranges from 1 to 3600.
Default value is 1.
<NOT_SILENCE> Flag. Valid value is Y or N. Default value is Y.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-100 LPS800-UM-COMM-02
Errors
Example Input ED-OSPF-DCC:::C:::COST=150;
Normal LoopStar 800 2004-07-10 16:01:49
M C COMPLD
;
Error LoopStar 800 2004-07-10 16:11:58
M C DENY
SDNR
/*DATA NOT READY,FAILED IN TIPS CALL*/
;
Notes
ED-OSPF-LAN
Command ED-OSPF-LAN
Explanation Edit open shortest path first (OSPF) LAN
Function This command edits the LAN-type interface(s) parameters of OSPF protocol.
Related Messages
Input Format ED-OSPF-LAN:[<TID>]::<CTAG>:::[COST=<COST>],[HELLO=
<HELLOTIMER>],[DEAD=<DEADTIMER>],[RETRANSMIT=
<RETRANSMITTIMER>],[DELAY=<TRANSITDELAY>],[NOTSILENCE=
<NOT_SILENCE>],[DRPRI=<OSPFDRPRI>];
<COST> Identifies the cost. Valid value ranges from 1 ot 65535.
Default value is 100.
<HELLOTIMER> Identifies the hello timer. Valid value ranges from 1 to 255.
Default value is 10.
<DEADTIMER> Identifies the dead timer. Valid value ranges from 1 to
65535. Default value is 40. <DEADTIMER> should be at
least 4 times of <HELLOTIMER>.
<RETRANSMITTIMER> Identifies the re-transmit timer. Valid value ranges from 1 to
65535. Default value is 5.
<TRANSITDELAY> Identifies the transit delay. Valid value ranges from 1 to
<NOT_SILENCE> Flag. Valid value is Y or N. Default value is N.
<OSPFDRPRI> Identifies the OSPF priority. Valid value ranges from 1 to
LPS800-UM-COMM-02 2-101

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-OSPF-LAN:::C:::COST=150;
Normal LoopStar 800 2004-07-10 16:01:49
M C COMPLD
;
Error LoopStar 800 2004-07-10 16:12:42
M C DENY
SDNC
/*INPUT DATA IS NOT CONSISTENT WITH NE DATA,ILLEGAL PARAMETER*/
;
Notes
ED-OSPF-SYS
Command ED-OSPF-SYS
Explanation Edit open shortest path first (OSPF).
Function This command edits the system parameters of OSPF protocol. It edits the name
and position of NE device.
Related Messages
2-102 LPS800-UM-COMM-02
Input Format ED-OSPF-SYS:<TID>::<CTAG>:::ENABLE=[WORKFLAG],AREA=[AREAID],

STUB=[FLAG],NSSA=[FLAG],IMPORTRIP=[FLAG],IMPORTSTATIC=[FLAG],
IMPORTDIRECT=[FLAG];
<ENABLE> The enable falg. Valid value is Y or N. Default value
is Y.
<AREA> Identifies the area ID. It is IP address format. Default
valud is 0.0.0.0.
<STUB> Stub area falg. Valid value is Y or N. Default value
is N.
<NSSA> Not-so-stubby area (NSSA) flag. Valid value is Y or
N. Default value is N.
<IMPORTRIP> Import RIP flag. Valid value is Y or N. Default
value is N.
<IMPORTSTATIC> Import static routes flag. Valid value is Y or N. Default
value is N.
<IMPORTDIRECT> Import direct routes flag. Valid value is Y or N. Default
value is N.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-OSPF-SYS:::C:::ENABLE=Y;
Normal LoopStar 800 2004-07-10 16:01:49
M C COMPLD
;
Error LoopStar 800 2004-07-10 16:10:27
M C DENY
SDNC
/*INPUT DATA IS NOT CONSISTENT WITH NE DATA,ILLEGAL
PARAMETER*/
;
LPS800-UM-COMM-02 2-103
ED-PID
Command ED-PID
Explanation Edit password
Function This command modifies a user password. It can only modify the current user's
own password.
Category Security
Security Retrieve
Related Messages ED-USER-SECU
Input Format ED-PID:[<TID>]:[<UID>]:<CTAG>::[<PID>],<NEWPID>;
<UID> User identifier which is to be edited. It is any combination of 4 to
16 alphanumeric characters. It is a string and is optional.
<PID> The old password. It is a string, length of which is from 6 to 16.
<NEWPID> The new password. It is a string, length of which is 6 to 16. And
it must include one letter and one non-letter character at least.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-104 LPS800-UM-COMM-02
Example Input ED-PID::USERNAME:C::OLDPASS,PASS_WORD;

Normal LoopStar 800 2001-01-01 15:23:20
M C COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00
M C DENY
PLNA
/*THE USER TO BE MODIFIED IS ONLINE.*/
;
Notes
ED-RIP-DCC
Command ED-RIP-DCC
Explanation Edit routing information protocol (RIP) DCC
Function This command modifies the DCC-type interface(s) parameters of RIP protocol.
Related Messages
Input Format ED-RIP-DCC:<TID>::<CTAG>:::VER=[VERSION],CAST=[CASTTYPE],
AUTH=[AUTHTYPE],PASSWORD=[STRING],RECV=[FALG],SEND=[FALG];
<VER> Specifies the RIP version used. Valid value is 2.
<CAST> Valid value is BROADCAST or MULTICAST. Default value is
MULTICAST.
<AUTH> Authentication mechanism type. Valid value is SIMPLE or
NONE. Default value is NONE.
<PASSWORD> Simple password. It is a string with 0 to 16 characters. Default
is null.
<RECV> RIP receive version flag. Valid value is Y or N. Default
value is N.
<SEND> RIP send version flag. Valid value is Y or N. Default value
is N.
LPS800-UM-COMM-02 2-105

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-RIP-DCC:::100:::VER=2;
Normal LoopStar 800 2004-07-10 16:01:49
M 100 COMPLD
;
Error LoopStar 800 2004-07-10 16:04:03
M 100 DENY
SDNR
/*DATA NOT READY,FAILED IN SETTING RIP*/
;
Notes
ED-RIP-LAN
Command ED-RIP-LAN
Explanation Edit routing information protocol (RIP) LAN
Function This command modifies the LAN-type interface(s) parameters of RIP protocol.
Related Messages
Input Format ED-RIP-LAN:<TID>::<CTAG>:::VER=<VERSION>,CAST=<CASTTYPE>,
AUTH=<AUTHTYPE>,PASSWORD=<STRING>,RECV=<FALG>,
SEND=<FALG>;
2-106 LPS800-UM-COMM-02

<VER> Specifies the RIP version used. Valid values are 0, 1 or 2.
Default value is 1. 0 means set <VER> with default value 1.
<CAST> Valid values are DEFAULT, BROADCAST or MULTICAST.
Default value is BROADCAST. DEFAULT means set
<CAST> with default value BROADCAST.
<PASSWORD> Simple password. It is a string with 0 to 16 characters. Default
is null.
<RECV> RIP receive version flag. Valid value is Y or N. Default
value is Y.
<SEND> RIP send version flag. Valid value is Y or N. Default
value is Y.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-RIP-LAN:::100:::VER=1;
Normal LoopStar 800 2004-07-10 16:01:49
M 100 COMPLD
;
Error LoopStar 800 2004-07-10 16:09:40
M 100 DENY
SDNC
/*INPUT DATA IS NOT CONSISTENT WITH NE DATA,ILLEGAL
PARAMETER*/
;
Notes
LPS800-UM-COMM-02 2-107
ED-RIP-SYS
Command ED-RIP-SYS
Explanation Edit routing information protocol (RIP) System
Function This command modifies the system parameters of RIP protocol.
Related Messages
Input Format ED-RIP-SYS:<TID>::<CTAG>:::[ENABLE=<ENABLE>,][IMPORTOSPF=
<IMPORTOSPF>,][IMPORTSTATIC=<IMPORTSTATIC>,][IMPORTDIRECT=
<IMPORTDIRECT>];
<ENABLE> The enable falg. Valid value is Y or N. Default value is N.
<IMPORTOSPF> Import OSPF routes flag. It is only available if <ENABLE> is
Y. Valid value is Y or N. Default value is N.
<IMPORTSTATIC> Import static routes flag. It is only available if <ENABLE> is Y.
Valid value is Y or N. Default value is N.
<IMPORTDIRECT> Import direct routes flag. It is only available if <ENABLE> is Y.
Valid value is Y or N. Default value is N.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-108 LPS800-UM-COMM-02
Example Input ED-RIP-SYS:::C:::ENABLE=Y,IMPORTOSPF=Y,IMPORTSTATIC=Y,

IMPORTDIRECT=Y;
Normal LoopStar 800 2004-07-10 16:01:49
M C COMPLD
;
Error LoopStar 800 2004-07-10 16:02:34
M C DENY
SDNR
/*DATA NOT READY,RIP DOESN'T RUN*/
;
Notes
LPS800-UM-COMM-02 2-109
ED-RMONALMCTRL-<MOD2>
Command ED-RMONALMCTRL-<MOD2>
Explanation Edit RMON alarm control (fast Ethernet, Gigabit Ethernet, all)
Function This command edits the parameters of alarm table which contains the
parameters that affect the condition of report events.
Category RMON
Related Messages RTRV-RMONALMCTRL-<MOD2>
Input Format ED-RMONALMCTRL-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],
[<RPTMODE>],[<INTERVAL>],[<RTHR>],[<FTHR>],[<ENFLAG>];
<MOD2> Valid values are FETH, GETH or ALL. ALL means all the fast
Ethernet and Gigabit Ethernet ports in NE.
<AID> Valid format is FAC-<SLOT ID>-<PORT ID>. <AID> is
optional and defaults to ALL, that means all ports in this
<MOD2> in the NE. If the <MOD2> is ALL then <AID>
is null.
<MONTYPE> Identifies the RMON parameters supported. Valid values are
shown in section "PM" of Chapter 3: TL1 Parameters. The
null value defaults to ALL.
<RPTMODE> Report mode. Valid values are:
• RPTUP (only report rising events);
• RPTDOWN (only report falling events);
• RPTALL (report both rising and falling events).
Default value is RPTALL. The null value means RPTALL.
<INTERVAL> Alarm sample interval. By default, the interval is 10 seconds.
Valid value ranges from 5 to 30 (seconds). The null value
means that can not change the value first setting.
<RTHR> Rising threshold. Valid value ranges from 1 to 4294967295
(0xFFFFFFFF). It must greater then falling threshold. The
null value means that cannot change the value first setting.
<FTHR> Falling threshold. Valid value ranges from 0 to 4294967294
(0xFFFFFFFE). It must less than the rising threshold. The
null value means that cannot change the value first setting.
<ENFLAG> States flag. Valid value is ENABLE or DISABLE. Default
value is DISABLE. The null value means that cannot change
the value first setting.
2-110 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-RMONALMCTRL-GETH::FAC-1-1:100::RXBBAD,RPTALL,10,,,ENABLE;
Normal LoopStar 800 2004-01-01 14:33:44
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 14:34:45
M 100 DENY
IIAC
/*INVALID ACCESS IDENTIFIER (AID),SLOT PARA ERROR*/
/*0X9CA0*/
;
Notes
ED-RMONHISTCTRL-<MOD2>
Command ED-RMONHISTCTRL-<MOD2>
Explanation Edit RMON history control (fast Ethernet, Gigabit Ethernet, all)
Function This command edits all history control parameters.
Category RMON
Related Messages RTRV-RMONHIST-<MOD2>
LPS800-UM-COMM-02 2-111
Input Format ED-RMONHISTCTRL-<MOD2>:[<TID>]:[<AID>]:<CTAG>::<PRDTP>,

[<RECNUM>],[<PRD>],[<ENFLAG>];
<MOD2> in the NE. If the <MOD2> is ALL then <AID>
is null.
<PRDTP> Period type. Valid values are 30S, 30M, PRDVAR or
PRDALL. If this parameter is not PRDVAR then <PRD>
must be null.
<RECNUM> Max record number. Valid value ranges from 1 to 50. Default
value is 50. The null value means that do not change the
value first setting.
<PRD> Period. Valid value ranges from 300 to 86400 seconds,
namely 5 minutes to 24 hours. If this parameter is not null,
then <PRDTP> must be PRDVAR. If the <PRDTP> is
PRDVAR this parameter must not be null. The null value
means that do not change the value first setting.
<ENFLAG> States flag. Valid value is ENABLE or DISABLE. By default,
the ENFLAG is DISABLE if <PRDTP> is 30S and PRDVAR,
if <PRDTP> is 30M then <ENFLAG> is enabled. The null
value means that do not change the value first setting.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-112 LPS800-UM-COMM-02
Example Input ED-RMONHISTCTRL-GETH::FAC-1-1:100::30S,,,ENABLE;

Normal LoopStar 800 2004-01-01 14:30:44
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 14:29:45
M 100 DENY
IDRG
/*DATA RANGE ERROR,RMON_PARA_ERROR*/
/*0X9CA3*/
;
Notes
ED-SERIAL
Command ED-SERIAL
Explanation Edit serial
Function This command edits the attributes and state of the serial port.
Related Messages RTRV-SERIAL
Input Format ED-SERIAL:[<TID>]::<CTAG>:::[BAUDRATE=<BAUDRATE>],
[LINKWAY=<LINKWAY>],[WORKSTATE=<WORKSTATE>];
<BAUDRATE> The baud rate of the serial. Valid values are 1200, 2400,
4800, 9600, 19200, 38400, 57600 or 115200. Default value
is 38400.
<LINKWAY> The link way of serial. Valid values are TL1, MML or NMS.
Default value is TL1.
<WORKSTATE> Work state. Valid value is OPEN or CLOSE. Default value is
OPEN.
LPS800-UM-COMM-02 2-113

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-SERIAL:::C:::BAUDRATE=38400;
Normal LoopStar 800 2004-01-01 15:23:20
M C COMPLD
;
Error LoopStar 800 2004-01-01 14:30:00
M C DENY
PLNA
;
Notes The initial workstate of serial port is Enable. The workstate is stored in the
database.
2-114 LPS800-UM-COMM-02
ED-SQL-<STS_PATH>
Command ED-SQL-<STS_PATH>
Explanation Edit squelch table (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,
STS192C)
Function This command manually edits the squelch table entry at the addressed node.
This should only be used for test purposes by experienced user. The parameter
<SQLMODE> must be MANUAL for this command to work, see ENT-FFP-
<OCN>, DLT-FFP-<OCN>, and RTRV-FFP-<OCN> for parameter
<SQLMODE>.
Category BLSR
DLT-SQL-<STS_PATH>
RTRV-SQL-<STS_PATH>
INIT-SQL-<STS_PATH>
Input Format ED-SQL-<STS_PATH>:[<TID>]:<AID>:<CTAG>:::[SRC=<SRC>]
[,DST=<DST>];
<STS_PATH> Identifies the type of STS path. Valid values are STS1,
STS192C.
<AID> Identifies the STS path for which the entry is to be edited/
entered. Valid value is applicable STS AID.
<SRC> Source node ID of incoming path where the path entered
the ring. Valid value ranges from 0 to 15.
<DST> Destination node ID of outgoing path where the path
dropped the ring. Valid value ranges from 0. to 15.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-115
Errors
Example Input ED-SQL-STS1::STS-3-1-1:1:::SRC=1,DST=2;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
;
Error LoopStar 800 2004-03-08 09:59:42
M 100 DENY
IPNV
;
Notes This command is not available in the LoopStar 800 and 810.
ED-SYNC
Command ED-SYNC
Explanation Edit synchronization reference
Function This command edits the attributes of one synchronization reference list of NE.
Each NE has three synchronization reference lists. They are system clock
reference list, BITS-1 output clock reference list, and BITS-2 output clock
reference. This command can edit the attributes of each list. And for some
attributes, they will effect the all these three lists of NE at the same time, so the
attribute of all three reference list will be changed together. See the parameters
description for detail.
Related Messages RTRV-SYNC
Input Format ED-SYNC:[<TID>]:<AID>:<CTAG>:::[TMGMODE=<TMGMODE>,]
[SSMMAP=<SSMMAP>,][SSMEN=<SSMEN>,][RVRTV=<RVRTV>,]
[RVTM=<RVTM>,][PNO=<PNO>];
2-116 LPS800-UM-COMM-02

<AID> Access identifier of synchronization reference list.
Valid values are:
• SYNCCLOCK (system clock reference list);
• SYNCOUT-1 (output clock reference list of BITS-1);
• SYNCOUT-2 (output clock reference list of BITS-2).
<TMGMODE> Timing Mode. Valid values are INT (internal mode), EXT
(external mode), LINE (line mode), or MIXED (mixed mode).
Default value can be the following:
• For SYNCCLOCK of LoopStar 1600 and 800, the default
will be EXT.
• For SYNCOUT-1 and SYNCOUT-2 of LoopStar 1600 and
800, the default will be LINE.
• For SYNCCLOCK of LoopStar 810, the default will be LINE.
If the timing mode is changed between EXT and INT, or EXT
and LINE, or INT and LINE, and the change from MIXED to INT,
the reference list will be cleared.
<SSMMAP> Map for outgoing SSM to 1st generation synchronization status
messages. Valid values are:
• Y (map the outgoing SSM to GEN1);
• N (Map the outgoing SSM to GEN2).
Default value is N. This attribute will affect all the three
synchronization reference lists.
<SSMEN> Enable use of synchronization status messages. Valid value is Y
(enable) or N (disable). Default value is N. This attribute will
affect all the three synchronization reference lists.
<PNO> SSM value that user provisionable. See section "RES" for detail.
Default value is DUS. This attribute will affect all the three
<RVRTV> Support revertive or nonrevertive switching. Valid value is Y
(revertive mode) or N (non-revertive mode). Default value is N.
<RVTM> Wait to restore timer after the fail reference restore to good.
Valid value ranges from 0 to 12 (min). Default value is 5 (min).
This attribute can be modified and will effect only if the
<RVRTV> is Y. If the <RVRTV> was modified to N, the <RVTM>
will be automatically reset to the default value (5 min).
Format
^^^<rsphdr><cr><lf>
;
LPS800-UM-COMM-02 2-117
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-SYNC::SYNCCLOCK:C:::TMGMODE=LINE,SSMMAP=Y,SSMEN=N,
PNO=ST3,RVRTV=Y,RVTM=5;
Normal LoopStar 800 2004-03-15 15:54:55
M 123 COMPLD
;
Error LoopStar 800 2004-01-01 15:19:38
M C DENY
;
Notes
ED-SYNCLIST
Command ED-SYNCLIST
Explanation Edit synchronization reference list
Function This command edits the synchronization reference list that the system clock or
BITS outgoing clock can track in.
There are three synchronization reference lists in NE. they are system clock
reference list and BITS-1 and BITS-2 outgoing clock reference list. One
synchronization reference list can contain 10 references source at most.
Specially, internal clock reference source is in all reference lists as a default
reference source, but it cannot be edited and is invisible.
Related Messages RTRV-SYNCLIST
Input Format ED-SYNCLIST:[<TID>]:<AID>:<CTAG>::SYNCAID+;
2-118 LPS800-UM-COMM-02

<AID> Access identifier of synchronization reference list. Valid
values are:
• SYNCCLOCK (system clock reference list),
• SYNCOUT-1 (output clock reference list of BITS-1),
<SYNCAID> Timing reference facility AIDs. See section "SYNCAID"
for detail.
The range of <SYNCAID> will is limited by the Timing mode
of the list.
EXT mode: Only can use BITS-IN facility AIDs.
LINE mode: Only can use facility AIDs.
MIXED mode: Both BITS-IN facility AIDs and facility AIDs.
INT mode: Neither of these AIDs.
The order implies the priority of timing switch, the first
<SYNCAID> having the highest priority.
Priority only applies when <RVRTV> attribute of reference
list is revertive.
There are 10 <SYNCAID> can be edited into the list at most.
The state of the facility (<SYNCAID>) which was used to be
edit into the list should not be OOS-MA or OOS-AUMA.
When the timing mode is changed, the list maybe change
under the role that description in "ED-SYNC" section.
If a <SYNCAID> which was in the list is removed from the
new list and is not in other list, the LOCKOUT and MANSSM
attributes of the synchronization reference source that the
<SYNCAID> means will be cleared. Otherwise they will be
keeping on.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-119
Example Input ED-SYNCLIST::SYNCCLOCK:C:: FAC-1-1,FAC-1-2;

Normal LoopStar 800 2004-01-01 15:19:38
M C COMPLD
;
Error LoopStar 800 2004-01-01 15:19:38
M C DENY
;
Notes
ED-SYS
Command ED-SYS
Explanation Edit system
Function This command edits the attributes of the system. If auto-provisioning function is
enabling using this command, a unit will be automatically created with all its default
attributes once it is plugged-in. By default, the system enables this auto-
provisioning function.
Category System
Security Super-user
Related Messages RTRV-SYS
INIT-SYS
Input Format ED-SYS:[<TID>]::<CTAG>:::[AUTOP=<AUTOP>,][LPBKSAVEFLAG=
<LPBKSAVEFLAG>,][NELOCATION=<NELOCATION>,][NEMEMO=
<NEMEMO>];
2-120 LPS800-UM-COMM-02

<AUTOP> Auto-provisioning enable/disable flag. Valid value is Y
(enable) or N (disable).
<LPBKSAVEFLAG> The flag which indicates whether the loopback is saved in
database or not. Valid value is Y (save), or N (not save).
<NELOCATION> NE location. Valid value is a 32 bytes string.
<NEMEMO> NE memo. Valid value is a 64 bytes string.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-SYS:::C:::AUTOP=Y,LPBKSAVEFLAG=Y,NELOCATION="NEW
YORK",NEMEMO="North-east 4BLSR ring";
Normal LoopStar 800 2004-01-01 11:37:18
M C COMPLD
;
Error LoopStar 800 2004-01-01 11:37:18
M C DENY
PLNA
;
Notes
LPS800-UM-COMM-02 2-121
ED-T1
Command ED-T1
Explanation Edit T1
Function This command edits the attributes associated with the DS1/T1 port.
Category Facility
Related Messages RTRV-T1
Input Format ED-T1:[<TID>]:<AID>:<CTAG>:::[LBO=<LBO>][,LINECDE=<LINECDE>]
[,FMT=<FMT>][,SVTIMER=<SVTIMER>][,TACC=<TACC>],[:<PST>[,<SST>]];
<AID> Access identifier. Valid values are shown in the section "T1/
T3".
<LBO> Line build out. valid value is shown in the section "LINE
BUILD OUT".
<LINECDE> Line coding. Valid value is AMI or B8ZS. Default is AMI
(including DS1 port in PDM3 unit).
<FMT> Frame format. Valid value is SF, ESF or UNFRAMED.
<SVTIMER> Signal validation timer in minutes. Valid values are shown in
section "SVTIMER".
<TACC> Defines the DS1/T1 port as a test access port with a
selected unique TAP number. Valid values are shown in
section "TACC".
<PST> Primary and primary state qualifier state. Valid values are
shown in section "PST_STATE".
<SST> Secondary state. Valid values are shown in section
"SST_STATE".
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-122 LPS800-UM-COMM-02
Errors
Example Input ED-T1::FAC-3-1:C:::REQ=HIGH,LBO=1,LINECDE=AMI,FMT=SF,
SVTIMER=00-25,TACC=1:IS;
Normal LoopStar 800 2004-01-01 18:08:44
M C COMPLD
;
Error LoopStar 800 2004-01-01 18:08:44
M C COMPLD
PLNA
;
Notes 1. Facility needs to be OOS before its traffic affecting parameters (LBO,
LINECODE, and FMT) can be edited.
2. Only the following combinations of state of PST and SST are valid:
• IS
• OOS
• OOS, AINS
ED-T3
Command ED-T3
Explanation Edit T3
Function This command edits the attributes associated with the DS3/T3 port.
Category Facility
Related Messages RTRV-T3
ENT-T3
DLT-T3
Input Format ED-T3:[<TID>]:<AID>:<CTAG>:[REQ=<REQ>][,LBO=<LBO>][,FMT=<FMT>]
[,SVTIMER=<SVTIMER>][,TACC=<TACC>],[:<PST>[,<SST>]];
LPS800-UM-COMM-02 2-123

<AID> Access identifier. Valid values are shown in the section
"T1/T3".
<REQ> High or low receive equalizer. Valid value is HIGH (high
receive equalizer gain), or LOW (low receive equalizer gain).
Default value is HIGH.
The higher gain setting is designed to optimally equalize a
nominally shaped (meets the pulse template) pulse driven
DS3 or STS-1 waveform that is driven into 0 feet to 900 feet
of cable. Square shaped pulses such as E3 or DS3-HIGH
require less high frequency gain and should use the low
EQ gain setting.
<LBO> Line build out. Valid values are shown in the section "LINE
BUILD OUT".
<FMT> Frame format. Valid values are CBIT, M23 or UNFRAMED.
Default is CBIT.
For PDM3 unit, if the port type is DS3_ASYN_STS1, then
<FMT> can be CBIT, M23 or UNFRAMED. If the port type is
DS3_TMUX_DS1, then the <FMT> only can be CBIT or
M23. See <INTFTYPE> parameter in ED-EQPT command
for the detail information of DS3 port type.
section "SVTIMER".
section "TACC".
shown in table "PST STATE".
<SST> Secondary state. Valid values are shown in table "SST
STATE".
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-124 LPS800-UM-COMM-02
Example Input ED-T3::FAC-4-1:C:::LBO=2,FMT=CBIT,SVTIMER=00-25,TACC=1:OOS;
Normal LoopStar 800 2004-01-01 18:08:44

M C COMPLD
;
Error LoopStar 800 2004-01-01 18:08:44
M C COMPLD
SNOS
/*Status, Not currently Out of Service*/
;
Notes 1. The facility must be OOS before its traffic affecting parameters (LBO,
REQ, FMT, and LINECODE) can be edited.
2. Only the following combinations of state of PST and SST are valid:
• IS
• OOS
• OOS, AINS
ED-TPL-<OCN>
Command ED-TPL-<OCN>
Explanation Edit topology map (OC12, OC48, OC192)
Function This command manually edits the topology map at the addressed node.
Experienced user should only use this for test purposes. The parameter
<TPLMODE> must be MANUAL for this command to work, see ENT-FFP-
<TPLMODE>.
Category BLSR
Related Messages RTRV-TPL-<OCN>
INIT-TPL-<OCN>
Input Format ED-TPL-<OCN>:[<TID>]:<AID>: <CTAG>:::RINGMAP=<RINGMAP>;
level. Valid values are OC12, OC48, or OC192.
<AID> AID of any OC-N facility associated with the BLSR
protection group.
<RINGMAP> Node IDs. They must be unique with rest of the node IDs
entered. Any number of values 0 through 15 may be entered.
Does not have to be consecutive.
LPS800-UM-COMM-02 2-125

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ED-TPL-OC12:SONET-NE:FAC-1-2:100:::RINGMAP=1&2&3;
Normal LoopStar 800 2004-03-09 18:08:44
M 100 COMPLD
;
Error LoopStar 800 2004-03-09 18:08:44
M 100 DENY
IPNV
;
Notes This command is not available in the LoopStar 800 and LoopStar 810.
ED-USER-SECU
Command ED-USER-SECU
Explanation Edit user security
Function This command edtis a user's attributes.
Category Security
Security Super-user
2-126 LPS800-UM-COMM-02
Related Messages ENT-USER-SECU

DLT-USER-SECU
RTRV-USER-SECU
INH-USER-SECU
Input Format ED-USER-SECU:[<TID>]:<UID>:<CTAG>::[NEWUID=<NEWUID>],[NEWPID=
<NEWPID>],[UPC=<UPC>]:[TMOUTEN=<TMOUTEN>],[TMOUTLN=
<TMOUTLN>],[PAGE=<PAGE>],[UAGE=<UAGE>];
<UID> User identifier which is to be edited. It is any combination of 4 to
16 alphanumeric characters. It is a string and must not be null.
<NEWUID> New user identifier. It is a string, length of which is from 4 to 16.
The user name must include one letter at least, and it cannot
include ",", ":" and ";". It cannot be as same as the name which
has already existed in the NE.
<NEWPID> The new password. It is a string, length of which is from 6 to 16.
And it must include one letter and one non-letter character at
least. The command cannot modify online user's PID. To modify
online user's (your own) password, use ED-PID command.
<UPC> The user's privilege level. Valid valus are RTRV (retrieve),
MAINT (maintenance), PROV (provisioning) or SUPER
(superuser).
<TMOUTEN> The flag which allows user can cancel automatically. Valid value
ENABALE or DISABALE. Default value is ENABALE.
<TMOUTLN> The time of canceling user automatically. The unit of the time is
minute, and it ranges from 5 to 60. This parameter becomes
effective when <TMOUTEN> is ENABALE. Default value is 60.
<PAGE> The time in which the password is in effect. The unit of the time
is day, and it ranges from 25-999, but 0 express the password is
always in effect. Default value is 0.
<UAGE> The time in which the user's name is in effect. The unit of the
time is day, and it ranges from 1 ro 999, but 0 express the user
is always in effect. Default value is 0.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-127
Errors
Example Input ED-USER-SECU::USERNAME:100::NEWPID=NEW_PID,UPC=RTRV:
TMOUTEN=DISABLE,TMOUTLN=0,PAGE=0,UAGE=0;
or
ED-USER-SECU::USERNAME:100::NEWPID=NEW_PID
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
/* Repeated user's name.*/
;
Notes 1. You cannot modify the user name and other attributes at the same time.
After you modified the user name, the identifier of the user is changed,
and you will be noted the user is not online when you modified other
attributes at the same time.
2. You cannot modify the user name, time in which the user name is in
effect and user level if the target user is default user in the NE.
3. The command cannot modify online user PID. To modify online user
(your own) password, use ED-PID command.
ED-VCG
Command ED-VCG
Explanation Edit VC group
Function This command edits the attribute of a virtual concatenation group.
Related Messages RTRV-VCG
Input Format ED-VCG:[<TID>]:<AID>:<CTAG>:::[PATHTYPE=<PATHTYPE>],[UPPATH=
<UPPATH>],[DOWNPATH=<DOWNPATH>],[PROTOCOL=<PROTOCOL>],
[SCRAMBLER=<SCRAMBLER>],[FCSTYPE=<FCSTYPE>],[ENDIAN=
<ENDIAN>],[EXTHDR=<EXTHDR>],[REVCRC=<REVCRC>]],[TAGTYPE=
<TAGTYPE>],[PVID=<PVID>],[PVPRI=<PVPRI>],[PSVID=<PSVID>],[PSVPRI=
<PSVPRI>],[STAGTYPE=<STAGTYPE>],[SVENABLE=<SVENABLE>]:[PST];
2-128 LPS800-UM-COMM-02

<AID> Valid formant is VCG-<SLOT ID>-<VCG ID>.
<PATHTYPE> The path type of VCG. Valid values are shown in section
"PATHTYPE". Its initial value is NULL (NULL means clear
the path). It is optional. The VCG members will not change
until it is set. <PATHTYPE>, <UPPATH> and
<DOWNPATH> must be set at the same time.
<UPPATH> The time slot number of up direction which assigned to the
VCG ID. Its initial value is 0 (0 means clear the path). It is
optional. The VCG members will not change until it is set.
<PATHTYPE>, <UPPATH> and <DOWNPATH> must be
set at the same time.
<DOWNPATH> The time slot number of down direction which assigned to
the VCG ID. Its initial value is 0 (0 means clear the path). It
is optional. The VCG members will not change until it is
set. <PATHTYPE>, <UPPATH> and <DOWNPATH> must
be set at the same time.
<PROTOCOL> The protocol type to encapsulate the Ethernet service.
Valid values are GFP, LAPS, HDLC or PPP. The initial
value is GFP. It is optional and will not change until it
is set.
<SCRAMBLER> The scrambler type. Valid values are DISABLE, X43 or
X48. It is optional. Required only if <PROTOCOL> is
LAPS, HDLC or GFP.
<FCSTYPE> The frame check sequence type. Valid values are NONE,
FCS32 or FCS16. It is optional. Required only if
<PROTOCOL> is LAPS, HDLC or GFP.
<ENDIAN> The transmission order. Valid value is BIS or LITTLE. It is
optional. Required only if <PROTOCOL> is LAPS, HDLC
or GFP.
<EXTHDR> The extension header option. Valid value is Y or N. the
initial value is N. It is optional. Required only if
<PROTOCOL> is GFP.
<REVCRC> Indicates whether FCS is CRC reversed or not. Valid
value is Y or N. It is optional. Required only if
<PROTOCOL> is LAPS or HDLC.
<PVID> The default VLAN ID of the port ranges from 0 to 4096. It
is optional and will not change until it is set.
<PVPRI> The priority of the default VLAN for the port ranges from 0
to 7. the initial value is 0 (the lowest). "7" means the
highest priority. It is optional and will not change until it
is set.
<TAGTYPE> The tag type of the port. Valid values are TAGAWARE,
ACCESS, or HYBRID. The initial value is TAGAWARE. It
is optional and will not change until it is set.
LPS800-UM-COMM-02 2-129
Input Parameter <PSVID> Indicates the default service VLAN ID of the port ranges
(cont.) from 0 to 4096. It is optional and will not change until it
is set.
<STAGTYPE> Indicates the service VLAN tag attribute of the port ranges
from 0 to 7. the initial value is 0 (the lowest). "7" means the
highest priority.. It is optional and will not change until it
is set.
Valid vlue is Y or N. It is optional and will not change until
it is set.
<PST> Indicates the Ethernet port state. Valid value is IS or OOS.
It is optional. <PST> must be changed to OOS state firstly
when change the following parameters: <UPPATH>,
<DOWNPATH>, <LCASEN>, <PROTOCOL>,
<SCRAMBLER>, <FCSTYPE>, <ENDIAN>, <EXTHDR>,
<REVCRC>, <TAGTYPE>, <PVID>, <SVTPID>,
<SVENABLE>, <STAGTYPE> and <PSVID>.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-130 LPS800-UM-COMM-02
Example Input 1. Normal:

ED-VCG::VCG-5-
1:100:::PATHTYPE=STS1V,UPPATH=1&&3,DOWNPATH=1&&3,PROT
OCOL=GFP,SCRAMBLER=X43,FCSTYPE=FCS32,ENDIAN=LITTLE,E
XTHDR=Y,TAGTYPE=TAGAWARE,PVID=1,PVPRI=0,PSVID=1000,PS
VPRI=7,STAGTYPE=TAGAWARE;
ED-VCG::VCG-5-1:100:::SVENABLE=Y;
ED-VCG::VCG-5-1:100::::OOS;
2. Change path type:

ED-VCG::VCG-5-
1:100:::PATHTYPE=STS3V,UPPATH=1&&3,DOWNPATH=1&&3:OOS;
Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 101 DENY
IIAC
;
Notes The <DOWNPATHTYPE> must equal to <UPPATHTYPE>.
The <DOWNPATH> must equal to <UPPATH>.
ENT-CAR
Command ENT-CAR
Explanation Enter committed access rate (CAR)
Function This command creates an entry of the CAR of unit.
Category Ethernet
Related Messages ED-CAR
DLT-CAR
RTRV-CAR
Input Format ENT-CAR:[<TID>]:<AID>:<CTAG>:::[CARENABLE=<CARENABLE>],[CIR=<CIR>];
LPS800-UM-COMM-02 2-131

<CAR ID>. <CAR ID> ranges from 1 to 2048.
<CARENABLE> Enable state of CAR. Valid value can be Y or N. The initial
value is N. It is optional and will not change until it is set.
<CIR> Committed information rate (CIR) of CAR. Its unit is 1 kbits/s,
and generally, its step is 64 kbit. It is optional and will not
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors ETH_BID_ERR (The unit ID is invalid.);

CFG_BD_NOT_EXIST (The unit does not exist.);
CFG_BDTYPE_MISMATCH (The unit type is not Ethernet unit.);
CFG_CMD_NOT_SUPPORT (Do not support this command.);
ERR_ETH_PARA_CARID (The CAR ID parameter is invalid.);
ERR_ETH_CARID_EXIST (The CAR ID has already existed.);
ERR_ETH_PARA_CARCIR (The CAR CIR parameter is invalid.);
ERR_ETH_GRANULARITY_NOT_SUPPORT (The CAR CIR parameter does not
support this granularity.);
ERR_ETH_CAR_ALREADY_FULL (The number of CAR is over maxterm.).
Example Input ENT-CAR::CAR-5-10:100:::CARENABLE=Y,CIR=10240;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
;
Error LoopStar 800 2004-01-01 12:23:20
M 101 DENY
IIAC
;
Notes
2-132 LPS800-UM-COMM-02
ENT-COS
Command ENT-COS
Explanation Enter class of service (COS)
Function This command creates a class of service (COS) in the unit.
Category Ethernet
Related Messages ED-COS
RTRV-COS
DLT-COS
Input Format ENT-COS:[<TID>]:<AID>:<CTAG>:::[COSTYPE=<COSTYPE>];
<AID> Indicates the identify of COS. Valid value is <ETN_COSID>.
The format is COS-<SLOT ID>-<COS ID>.
<COSTYPE> Indicates type of COS. It is optional. If not specified, it defaults
to SIMPLE.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-133

CFG_BDTYPE_MISMATCH (The unit is not Ethernet unit.);
ERR_ETH_PARA_COSID (The COS ID parameter is invalid.);
ERR_ETH_COSTYPE_NOTSUPPORT (The type of COS is not supported.);
ERR_ETH_COS_ALREADY_FULL (The quantity of COS has reached the
maximum.);
ERR_ETH_COSID_EXIST (The COS has already existed.).
Example Input ENT-COS::COS-5-1:100:::COSTYPE=SIMPLE;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes
ENT-CRS-<STS_PATH>
Command ENT-CRS-<STS_PATH>
Explanation Enter cross connection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C).
2-134 LPS800-UM-COMM-02
Function This command creates a cross connection with a cross connection type.
1. When a UPSR cross-connection is created, the path presented by the first AID is
configured to be the preferred path by default. For example, the AID (F1) of the
cross-connection (created by ENT-CRS-STS1::F1&F2,T1:123;) is the preferred
path. But user can also set the preferred path by parameter <PREFERRED-
PATH>.
a. Following command is used to create a 1-way common cross connection:
from points: F1,
to points: T1
ENT-CRS-<STS_PATH>:[<TID>]:F1,T1:<CTAG>::1WAY;
b. The following command is used to create a 2-way common cross connec-
tion
from point: F1
to points: T1
c. The following command is used to create a 1-way selector:
from point: F1, F2
to points: T1
ENT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1:<CTAG>::1WAY;
d. The following command is used to create UPSR (a 1-way selector and 1-
way bridge with):
from point: F1,F2
to points: T1
ENT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1:<CTAG>::2WAY;
or
ENT-CRS-<STS_PATH>:[<TID>]:T1,F1&F2:<CTAG>::2WAY;
e. The following command is used to create two 1-way selectors with:
from point: F1,F2
to points: T1
to points: T2
ENT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>::1WAY;
f. The following command is used to create broadcast with:
from point: F1,
to points: T1,T2,T3,T4
ENT-CRS-<STS_PATH>:[<TID>]:F1,T1&T2&T3&T4:<CTAG>::1WAY;
g. The following command is used to interconnect two UPSRs with:
from point: F1,F2
to points: T1,T2
ENT-CRS-<STS_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>::2WAY;
LPS800-UM-COMM-02 2-135
Function (cont.) h. If there is one 1-way common cross connection from F1 to T1, fol-
lowing command will convert it to 1-way selector, and the preferred
path is F1.
i. If there is one 2-way common cross connection from F1 to T1,
following command will convert it to UPSR, and the preferred path
is F1.
Related Messages DLT-CRS-<STS_PATH>
RTRV-CRS-<STS_PATH>
ED-CRS-<STS_PATH>
Input Format ENT-CRS-<STS_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>::
[<CCT>]:[PREFERREDPATH=<PREFERREDPATH>,][CKTID=<CKTID>]:
[,<SST>];
<STS_PATH> The modifier that identifies the type of STS and VT path. Valid
values are STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, or STS192C.
<FROM> Access identifier. It can be source or destination of cross
connection, or any one path of source or destination. It can be
null, that means retrieve all cross connection with entered rate
level. "&" is allowed. (See “STS” parameter description in
<TO> Access identifier identifies the other end of the cross
connection. If creating 1-to-N one-way cross-connection,
multiple '&' and '&&'are allowed. Else only one "&" is allowed.
<TO> cannot be null. (See "STS" parameter description in
<PREFERRED Preferred path. <PREFERREDPATH> is only supplied for
PATH> UPSR. Two values separated by "&" are applicable to only
UPSR with 2 sources and 2 destinations. (See "STS"
parameter description in Chapter 3: TL1 Parameters.)
<CCT> Cross connect type. Valid value is 1WAY or 2WAY. Default
value is 2WAY.
<CKTID> The circuit identification. It is a string of max length 32 ASCII
characters. The circuit identification parameter contains the
provisioned. Default value is NULL.
<SST> Redline state. Valid states are shown in the section
"SST_STATE". Default state is RDLD-DEA.
2-136 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ENT-CRS-STS1::STS-3-1-1,STS-4-1-1:C::1WAY:CKTID=A1:,RDLD;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes 1. Only LoopStar 1600 supports STS24C, STS48C, and STS192C.
ENT-CRS-<STS_PATH/VT_PATH>
Command ENT-CRS-<STS_PATH/VT_PATH>
Explanation Enter cross connection (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1.5, VT2).
LPS800-UM-COMM-02 2-137
Function This command creates a cross connection with a cross connection type.
1. When a UPSR cross-connection is created, the path presented by the first AID is
configured to be the preferred path by default. For example, the AID (F1) of the
cross-connection (created by ENT-CRS-STS1::F1&F2,T1:123;) is the preferred
path. But user can also set the preferred path by parameter <PREFERRED-
PATH>.
a. Following command is used to create a 1-way common cross connection:
from points: F1,
to points: T1
ENT-CRS-<STS_PATH/VT_PATH>:[<TID>]:F1,T1:<CTAG>::1WAY;
b. The following command is used to create a 2-way common cross connec-
tion
from point: F1
to points: T1
c. The following command is used to create a 1-way selector:
from point: F1, F2
to points: T1
ENT-CRS-<STS_PATH/VT_PATH>:[<TID>]:F1&F2,T1:<CTAG>::1WAY;
d. The following command is used to create UPSR (a 1-way selector and 1-
way bridge with):
from point: F1,F2
to points: T1
ENT-CRS-<STS_PATH/VT_PATH>:[<TID>]:F1&F2,T1:<CTAG>::2WAY;
or
ENT-CRS-<STS_PATH/VT_PATH>:[<TID>]:T1,F1&F2:<CTAG>::2WAY;
e. The following command is used to create two 1-way selectors with:
from point: F1,F2
to points: T1
to points: T2
ENT-CRS-<STS_PATH/
VT_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>::1WAY;
f. The following command is used to create broadcast with:
from point: F1,
to points: T1,T2,T3,T4
ENT-CRS-<STS_PATH/
VT_PATH>:[<TID>]:F1,T1&T2&T3&T4:<CTAG>::1WAY;
g. The following command is used to interconnect two UPSRs with:
from point: F1,F2
to points: T1,T2
ENT-CRS-<STS_PATH/
VT_PATH>:[<TID>]:F1&F2,T1&T2:<CTAG>::2WAY;
2-138 LPS800-UM-COMM-02
Function (cont.) h. If there is one 1-way common cross connection from F1 to T1, fol-
lowing command will convert it to 1-way selector, and the preferred
path is F1.
i. If there is one 2-way common cross connection from F1 to T1,
following command will convert it to UPSR, and the preferred path
is F1.
Related Messages DLT-CRS-<STS_PATH/VT_PATH>
Input Format ENT-CRS-<STS_PATH/VT_PATH>:[<TID>]:<FROM>,<TO>:<CTAG>::
[<CCT>]:[PREFERREDPATH=<PREFERREDPATH>,][CKTID=<CKTID>]:
[,<SST>];
<STS_PATH/ The modifier that identifies the type of STS and VT path. Valid
VT_PATH> values are STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1.5, or VT2.
<FROM> Access identifier. It can be source or destination of cross
connection, or any one path of source or destination. It can be
null, that means retrieve all cross connection with entered rate
level. "&" is allowed. (See STS and VT Parameter Description)
connection. If creating 1-to-N one-way cross-connection,
multiple '&' and '&&'are allowed. Else only one "&" is allowed.
<TO> cannot be null. (See "STS" and "VT" parameter
description)
<PREFERRED Preferred path. <PREFERREDPATH> is only supplied for
PATH> UPSR. Two values separated by "&" are applicable to only
UPSR with 2 sources and 2 destinations. (See "STS" and "VT"
parameter description)
<CCT> Cross connect type. Valid value is 1WAY or 2WAY. Default
value is 2WAY.
provisioned. Default value is NULL.
<SST> Redline state. Valid states are shown in the section
"SST_STATE". Default state is RDLD-DEA.
LPS800-UM-COMM-02 2-139

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ENT-CRS-STS1::STS-3-1-1,STS-4-1-1:C::1WAY:CKTID=A1:,RDLD;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes 1. Only LoopStar 1600 supports STS24C, STS48C, and STS192C.
2. LoopStar 800 does not support VT1/VT2-level UPSR and selector.
ENT-CRS-DCC
Command ENT-CRS-DCC
Explanation Enter cross DCC
Function This command creates a DCC cross channel.
Related Messages
Input Format ENT-CRS-DCC:[<TID>]:<FROM_DCCID>,<TO_DCCID>:<CTAG>:;
2-140 LPS800-UM-COMM-02

<FROM_DCCID> Access identifier indicates the DCC channel. Valid format is
DCC-<SLOT ID>-<PORT ID>-<CHANNEL>. The valid value of
<CHANNEL> is:
1 (SDCC, D1 to D3)
2 (LDCC, D4 to D12)
3 (LDCC2 D4 to D6)
4 (LDCC3, D7 to D9)
5 (LDCC4, D10 to D12)
<TO_DCCID> See <FROM_DCCID>.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ENT-CRS-DCC::DCC-1-2-1,DCC-2-3-4:C;
Normal LoopStar 800 2004-03-12 07:28:39
M C COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M C DENY
SNVS
/*NOT IN VALID STATE, THE SLOT IS USED ALREADY*/
;
Notes 1. RTRV-CRS-OHBYTE commands can retrieve this modifies.
So RTRV-CRS-DCC command is not present.
2. To set a transparent DCC channel, set the DCC protocol as transparent.
For example: ED-DCC::DCC-1-1-1:S:::PROTOCOL=TRANSPARENT;
LPS800-UM-COMM-02 2-141
ENT-CRS-OHBYTE
Command ENT-CRS-OHBYTE
Explanation Enter cross overhead
Function This command creates an overhead byte cross.
Related Messages
Input Format ENT-CRS-OHBYTE:[<TID>]:<FROM_AID>,<TO_AID>:<CTAG>::
<FROM_BYTE>,<TO_BYTE>;
<FROM_AID> Access identifier. It is the same as the OC-N facility, such as
FAC-2-1.
<TO_AID> Access identifier. It is the same as the OC-N facility, such as
FAC-2-1.
<FROM_BYTE> The source byte of the cross. Any of the overhead bytes of E1,
F1, D1 to D12, K1, K2 or E2 byte.
<TO_BYTE> The destination byte of the cross. Any of the overhead bytes of
E1, F1, D1 to D12, K1, K2 or E2 byte.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-142 LPS800-UM-COMM-02
Example Input ENT-CRS-OHBYTE::FAC-1-2,FAC-2-3:C::E1,D2;

Normal LoopStar 800 2004-03-12 07:28:39
M C COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M C DENY
IIAC
/*INVALID ACCESS IDENTIFIER (AID),INVALID PARAMETER:FAC-1-2*/
/*ENT-CRS-
OHBYTE:[<TID>]:<From_AID>,<To_AID>:<CTAG>::<From_Byte>,<To_Byte>;EN
T-CRS-OHBYTE::FAC-1-2,FAC-2-3:100::E1,D2;*/
;
Notes To set a transparent DCC channel, set the DCC protocol as transparent. For
example: ED-DCC::DCC-1-1-1:S:::PROTOCOL=TRANSPARENT;
ENT-EQPT
Command ENT-EQPT
Explanation Enter equipment
Function This command enters the unit type and attributes for a given equipment slot in the
NE. It also automatically enters all port facilities supported by the unit, assigning
default values to all port facility attributes.
Category Equipment
Related Messages
Input Format ENT-EQPT:[<TID>]:<AID>:<CTAG>::<CARDTYPE>:[INTFTYPE=<INTFTYPE>]:
[[<PST>],[<SST>]];
section “EQPT” in Chapter 3: TL1 Parameters.
<CARDTYPE> The AID unit type. Valid values for <CARDTYPE> are shown in
Chapter 3: TL1 Parameters.
<INTFTYPE> The AID unit interface type. Valid values are shown in section
"INTFTYPE" of Chapter 3: TL1 Parameters. This parameter is
optional and can be used only for DSn units.
[[<PST>],[<SST>]] <PST> means the primary state of the AID unit. <SST> means
the secondary state of the AID unit. Valid values for this are
LPS800-UM-COMM-02 2-143

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ENT-EQPT:SONET-NE:SLOT-7:C::PDT1:INTFTYPE=DS1_ASYN_VT1:,AINS;
Normal LoopStar 800 2004-03-12 07:28:39
M C COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M C DENY
PLNA
;
Notes 1. The active common control unit (GXCS/XCS/XCSH/XO3/XO3D/XO12/
XO12D) is automatically entered when system power on. No need to enter
by this command. The standby common controll unit should be entered by
this command.
2. FAN/PIU/ATE unit is automatically entered when system power on. No
need to enter by this command.
3. All service processing unit and interface unit should be entered by
this command.
2-144 LPS800-UM-COMM-02
ENT-EQPT-PG
Command ENT-EQPT-PG
Explanation Enter equipment protection group
Function This command creates an equipment protection group.
Related Messages RTRV-EQPT-PG
DLT-EQPT-PG
ED-EQPT-PG
Input Format ENT-EQPT-PG:[<TID>]:<AID>:<CTAG>:::[RVRTV=<RVRTV>,][RVTM=<RVTM>,]
[PSTYPE=<PSTYPE>,]WORK=<WORK>;
<AID> AID of any equipment in a protection group. Valid value is
shown in the section “EQPT” of Chapter 3: TL1 Parameters.
"REVERTIVE MODE". Default value is Y.
"REVERTIVE TIME". The default value is 5 (minutes).
<PSTYPE> Protection architecture. Valid value is 1-N. Default value
is 1-N.
<WORK> List of working equipment AIDs. "&" used in the WORK field
means 1: N protection with more than one working unit.
Valid equipment AID is shown in the section "EQPT".
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
[^^^”<error description>“<cr><lf>]
;
Errors
LPS800-UM-COMM-02 2-145
Example Input ENT-EQPT-PG::SLOT-4:C:::RVRTV=Y,PSTYPE=1-N,RVTM=5,WORK=

SLOT-5&SLOT-6;
Normal LoopStar 800 2004-03-12 07:28:39
M C COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M C DENY
PLNA
;
Notes 1. This command is not valid for XCS protection group as it is automatically
created when the second XCS is plugged in.
2. The working and related interface unit must be created before the PG by
auto provisioning or ENT-EQPT command.
3. The PG cannot be created when it include a unit in OOS-MA or OOS-
AUMA state.
4. Only 1-N is supported of the <PSTYPE> parameter. The value of the
<RVRTV> can only be Y.
2-146 LPS800-UM-COMM-02
ENT-ETHLINK
Command ENT-ETHLINK
Explanation Enter Ethernet link
Function This command creates an Ethernet link in the unit.
Category Ethernet
Related Messages RTRV-ETHLINK
DLT-ETHLINK
Input Format ENT-ETHLINK:[<TID>]:<LINK_FROM>,<LINK_TO>:<CTAG>:::[INTAG=<INTAG>],
[CTYPE=<CTYPE>];
<LINK_FROM> The <ETN_PORT> which the link is from. Valid format is
<LINK_TO> The <ETN_PORT> which the link is to. Valid format is FAC/
VCG-<EQPT>-<PORT>.
<INTAG> Incoming Tag. Valid value ranges from 1 to 4095. The tag
can be VLAN tag. It is optional and here means EPL.
<CTYPE> Valid value is 1WAY or 2WAY. Default value is 2WAY.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors CFG_BD_NOT_EXIST (The unit does not exist.);

ETH_PORT_USED (The port has been used.);
ETH_VLANIDERR (The VLAN ID error.);
ETH_PARAERR_LINKCTYPE (The link direction error.);
ETH_BAD_ENABLEID (The Q-in-Q has been enabled.);
ETH_PORT_ERR (The port ID error.).
LPS800-UM-COMM-02 2-147
Example Input ENT-ETHLINK::FAC-1-2,VCG-1-4:100:::INTAG=3, CTYPE=1WAY;

ENT-ETHLINK::FAC-1-2,VCG-1-4:100:::INTAG=3;
ENT-ETHLINK::FAC-1-2,VBLP-1-1-20:100;
ENT-ETHLINK::FAC-1-2,FAC-1-4:100;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes
ENT-FFP-<OCN>
Command ENT-FFP-<OCN>
Explanation Enter facility protection group (OC3, OC12, OC48, OC192)
Function This command is used to create an optical facility protection group. It also
provides for entering attributes of the protection group. This command can be
used to create SONET line protection and BLSR.
DLT-FFP-<OCN>
RTRV-FFP-<OCN>
RTRV-FFP-ALL
Input Format ENT-FFP-<OCN>:[<TID>]:<PROTECT>,<WORK>:<CTAG>:::FFPTYPE=
<FFPTYPE>,[RVRTV=<RVRTV>][,RVTM=<RVTM>],[PSDIRN=<PSDIRN>].
[RINGID=<RINGID>],[NODEID=<NODEID>],[TPLMODE=<TPLMODE>],
[SQLMODE=<SQLMODE>];
2-148 LPS800-UM-COMM-02

level. Valid values are OC3 (SONET line protection only),
OC12, OC48, or OC192.
<PROTECT> Protecting optical facilities. Valid format is FAC-<SLOT
ID>-<PORT ID>.
If <FFPTYPE> is SONET line protection, this parameter
is protecting optical port.
If <FFPTYPE> is 2BLSR, this parameter is west optical
port (West1Port).
If <FFPTYPE> is 4BLSR, this parameter is the two west
optical ports (West1Port&West2Port).
<WORK> Working optical facilities protected by <PROTECT>.
Valid format is FAC-<SLOT ID>-<PORT ID>.
If <FFPTYPE> is SONET line protection, then this
parameter is protected OCN port(s), multiple protected
ports are specified by "&"or "&&" notation.
If <FFPTYPE> is 2BLSR, this parameter is the east port.
If <FFPTYPE> is 4BLSR, this parameter is the two east
optical ports (East1Port&East2Port).
<FFPTYPE> The type of protection group. Valid values are
1-N (1: N protection architecture);
1+1OPT (1+1 optimized protection architecture);
2BLSR (two-fiber BLSR);
4BLSR (four-fiber BLSR).
"REVERTIVE MODE". Default value is N. In SONET line
protection 1+1OPT mode, this parameter can only be N.
"REVERTIVE TIME". In BLSR mode, the ring and span
RVTM are the same, and 99 means non-revertive mode.
Through the only revertive mode of 1+1OPT is non-
revertive, the revertive time can also be changed.
<PSDIRN> Switching mode. Valid value is UNI (unidirectional
switching) or BI (bi-directional switching). This parameter
is only applicable to SONET line protection. In SONET
line protection 1+1OPT mode, this parameter can only be
BI.
<RINGID> Identifier of a BLSR ring. It is a string of up to 16
characters.
LPS800-UM-COMM-02 2-149
Input Parameter <NODEID> Identifier of node in a BLSR ring. It is an integer and

(cont.) ranges from 0 to 15. This parameter is only applicable to
BLSR.
(manual). Default value is AUTO. This parameter is only
applicable to BLSR.
applicable to BLSR.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Example Input 1. 1+1 protection example:

ENT-FFP-OC3:SONET-NE:FAC-2-1,FAC-3-
1:100:::FFPTYPE=1+1,RVRTV=Y,RVTM=5,PSDIRN=BI;
2. BLSR example:
ENT-FFP-OC12:SONET-NE:FAC-2-1&FAC-2-2,FAC-3-3&FAC-3-
4:100:::PSTYPE=4BLSR,RVRTV=Y,RVTM=5,RINGID=1,NODEID=1,T
PLMODE=AUTO,SQLMODE=AUTO;
Normal LoopStar 800 2004-03-12 09:25:57
M 100 COMPLD
;
Error LoopStar 800 2004-03-12 09:25:57
M 100 DENY
IPNV
;
2-150 LPS800-UM-COMM-02
ENT-FLOW
Command ENT-FLOW
Explanation Enter flow
Function This command enters a flow entity of the unit. At present, support following flow
types:
1. According to incoming port (FAC or VCG).
2. According to compounding between incoming port and incoming tag.
Category Ethernet
Related Messages ED-FLOW
DLT-FLOW
RTRV-FLOW
Input Format ENT-FLOW:[<TID>]:<AID>:<CTAG>:::[PORT=<ETN_PORT>],[INTAG=
<INTAG>];
<FLOW ID>.
<ETN_PORT> Ethernet port identifier. Valid format is FAC/VCG-<EQPT>-
<PORT>. It is optional and has no default value.
can be VLAN tag. It is optional and has no default value.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-151

ETH_PARA_FLOWID (The flow ID parameter is invalid.);
ETH_FLOWTYPE_NOTSUPPORT (Do not support this type of flow.);
ETH_PORT_ERR (The ETN_PORT parameter is invalid.);
ETH_VLANIDERR (The INTAG parameter is invalid.);
ETH_FLOW_BLOCK_ALREADY_FULL (The quantity of COS has reached the
maximum.);
ETH_FLOWID_EXIST (This flow ID has been used.);
ETH_PORT_USED (The port is used by another flow.);
ETH_FLOW_EXIST (The flow has already existed.).
Example Input ENT-FLOW::FLOW-1-1:100:::PORT=FAC-5-2;
ENT-FLOW::FLOW-1-2:101:::PORT=VCG-5-2,INTAG=3;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes
ENT-IPROUTE-STATIC
Command ENT-IPROUTE-STATIC
Explanation Enter IP route static
Function This command adds static routes to the route table.
Related Messages DLT-IPROUTE-STATIC
RTRV-IPROUTE-STATIC
2-152 LPS800-UM-COMM-02
Input Format ENT-IPROUTE-STATIC:<TID>::<CTAG>:::DESTIP=<DESTADDR>,

GATEWAY=<GATEWAY>,MASK=<MASK>;
<DESTADDR> Destination IP address.
<GATEWAY> Gateway address.
<MASK> IP mask address.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ENT-IPROUTE-STATIC:::C:::DESTIP=129.9.0.2GATEWAY=129.9.0.1:MASK=
255.255.255.0;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
SDNC
PARAMETER*/
;
Notes
LPS800-UM-COMM-02 2-153
ENT-SQL-<STS_PATH>
Command ENT-SQL-<STS_PATH>
Explanation Enter squelch table(STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C)
Function This command manually enters the squelch table entry at the addressed node.
This should only be used for test purposes by experienced user. The parameter
<SQLMODE> must be MANUAL for this command to work, see ENT-FFP-
<SQLMODE>.
Category BLSR
Related Messages ED-SQL-<STS_PATH>
DLT-SQL-<STS_PATH>
RTRV-SQL-<STS_PATH>
INIT-SQL-<STS_PATH>
Input Format ENT-SQL-<STS_PATH>:[<TID>]:<AID>: <CTAG>:::[SRC=<SRC>][,DST=
<DST>];
values are STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C, or STS192C.
<AID> Identifies the STS path for which the entry is to be
edited/entered. Value is applicable STS AID.
<SRC> Identifies the source node ID of incoming path where the
path entered the ring. Valid value ranges from 0 to 15.
<DST> Identifies the destination node ID of outgoing path where
the path dropped the ring. Valid value ranges from
0 to 15.
2-154 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
IPNV
;
ENT-TIDIPMAP
Command ENT-TIDIPMAP
Explanation Enter TID-IP mapping.
Function This command creates a static TID-IP mapping entry.
Related Messages DLT-TIDIPMAP
Input Format ENT-TIDIPMAP:[<TID>]::<CTAG>:::TID=<TID>,IP=<IPADDR>;
LPS800-UM-COMM-02 2-155

<IPADDR> The IP address of the NE.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^DENY<cr> <lf>
^^^<errcde><cr><lf>
;
Errors
Example Input ENT-TIDIPMAP::C:::TID="NE101",IP=192.168.0.101;
Normal LoopStar 800 2004-07-10 15:39:50
M C COMPLD
;
Error LoopStar 800 2004-07-10 15:40:17
M C DENY
SDNC
PARAMETER*/
;
Notes
ENT-USER-SECU
Command ENT-USER-SECU
Explanation Enter user security.
Function This command adds a user account to operate the NE.
Category Security
Security Super-user
2-156 LPS800-UM-COMM-02
Related Messages DLT-USER-SECU

ED-USER-SECU
RTRV-USER-SECU
INH-USER-SECU
Input Format ENT-USER-SECU:[<TID>]:<UID>:<CTAG>::<PID>,,<UPC>:TMOUTEN=
[<TMOUTEN>],TMOUTLN=[<TMOUTLN>],PAGE=[<PAGE>],UAGE=
[<UAGE>];
<PID> The password. It is a string, length of which is from 6 to 16. And
it must include one letter and one non-letter character at least.
(superuser).
<TMOUTEN> The flag which allows user can cancel automatically. Valid value
ENABALE or DISABALE. Default value is ENABALE.
effective when <TMOUTEN> is ENABALE. Default value is 60.
is day, and it ranges from 25-999, but 0 express the password is
time is day, and it ranges from 1 ro 999, but 0 express the user is
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-157
Example Input ENT-USER-SECU::USERNAME:C::PASS_WORD,,MAINT:TMOUTEN=

ENABLE,TMOUTLN=30,PAGE=30,UAGE=30;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
/*Repeated user name*/
;
Notes The maximum number of the users in a NE is 240.
INH-LPBK-<T1/T3>
Command INH-LPBK-<T1/T3>
Explanation Inhibit loopback (T1, T3).
Function This command inhibits far-end loopback, and if the AID is NULL, it applies to the
whole NE.
Category Loopback
Related Messages ALW-LPBK
Input Format INH-LPBK-<T1/T3>:[<TID>]:<AID>:<CTAG>;

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-158 LPS800-UM-COMM-02
Errors
Example Input INH-LPBK-T1::FAC-4-1:C;
Ack
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
;
Notes
INH-MSG-ALL
Command INH-MSG-ALL
Explanation Inhibit autonomous messages report all.
Function This command inhibits all REPT ALM and REPT EVT autonomous messages
from being transmitted. See the ALW-MSG-ALL to resume these autonomous
messages. When a user logins, the REPT ALM and REPT EVT messages are
allowed by default. This command is based on user.
Category System
Related Messages ALW-MSG-ALL
Input Format INH-MSG-ALL:[<TID>]::<CTAG>;
LPS800-UM-COMM-02 2-159

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INH-MSG-ALL:::C;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
IBEX
/*INH-MSG-ALL:::123;*/
;
Notes
INH-MSG-DBCHG
Command INH-MSG-DBCHG
Explanation Inhibit DB change message report.
Function This command inhibits REPT DBCHG. When a user logins, the REPT DBCHG
messages are not allowed by default. This command is based on user.
Category System
Related Messages ALW-MSG-DBCHG
2-160 LPS800-UM-COMM-02
Input Format INH-MSG-DBCHG:[<TID>]::<CTAG>;


Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INH-MSG-DBCHG:::100;
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
IBEX
/*INH-MSG-DBCHG:::123;*/
;
Notes
INH-PMREPT-ALL
Command INH-PMREPT-ALL
Explanation Inhibit performance monitoring report.
LPS800-UM-COMM-02 2-161
Function INHIBIT-PERFORMANCE MONITORING REPORT instructs an NE to enter a

mode in which all PM reporting is inhibited. Periodic reporting can be resumed by
using the ALLOW-PERFORMANCE MONITORING REPORT command.
Any NE for which PM reports are inhibited with the INHIBIT-PERFORMANCE
MONITORING REPORT command should include the appropriate condition type
information in response to a RETRIEVE-CONDITION request.
Related Messages ALW-PMREPT-ALL
Input Format INH-PMREPT-ALL:[<TID>]::<CTAG>;

;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INH-PMREPT-ALL:::C;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
IIAC
/*INVALID ACCESS IDENTIFIER (AID),PARAMETER EXTRA*/
/*INH-PMREPT-ALL:::123;*/
;
Notes NOT support INH-PMREPT-MOD2.
2-162 LPS800-UM-COMM-02
INH-SWDX-EQPT
Command INH-SWDX-EQPT
Explanation Inhibit protecton switch equipment.
Function This command inhibits automatic or manual switching on a system containing
duplex equipment. Use the ALW-SWDX-EQPT command to release the inhibit if
necessary.
Category SONET XCS protection switch
Related Messages ALW-SWDX-EQPT
REPT SW
SW-DX-EQPT
Input Format INH-SWDX-EQPT:[<TID>]:<EQPT>:<CTAG>;
<EQPT> The target slot which will be inhibited, such as SLOT-9.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-163
Example Input INH-SWDX-EQPT::SLOT-9:C;

Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
IIAC
/*INVALID ACCESS IDENTIFIER (AID),PARAMETER EXTRA*/
/*INH-PMREPT-ALL:::123;*/
;
Notes
INH-USER-SECU
Command INH-USER-SECU
Explanation Inhibit user security.
Function This command is used by an appropriate administrator to inhibit, for example,
disable an existing user (without deleting the user account), so the user can be
denied a session with the NE/M (for example, the user cannot log on). If a UID
has not been used for a period exceeding UAGE, it is required that the said UID
be disabled. A disabled UID can be reinstated by using the ALW-USER-SECU
command. Unused UIDs increase the risk of unauthorized access and, hence,
should not be allowed to be used. The idea is that a user who is temporarily
inactive, but may become active again, does not have to be deleted from the
system.
Category Security
Security Super-user
Related Messages ALW-USER-SECU
ED-USER-SECU
DLT-USER-SECU
RTRV-USER-SECU
Input Format INH-USER-SECU:[<TID>]::<CTAG>::<UID>;
2-164 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INH-USER-SECU:::C::USERNAME;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PIUC
/*STATED USER PRIVILEGE CODE IS ILLEGAL,USER NOT EXIST*/
/*0X9101*/
;
Notes You cannot forbid the default user of the NE or a user which is online.
INIT-LOG
Command INIT-LOG
Explanation Initialize log.
Function This command initialize a specified log of the NE.
Category Log
Related Messages RTRV-LOG
Input Format INIT-LOG:[<TID>]:[<AID>]:<CTAG>::<LOGNAME>;
LPS800-UM-COMM-02 2-165

<AID> Valid value is SLOT-N. NULL value means the current active
XCS unit.
<LOGNAME> The name of the log files to be retrieved. Valid value is OPT.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INIT-LOG:::100::OPT;
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
SDNR
/*DATA NOT READY, LOG DOES NOT EXIST*/
;
Notes This command empty the specifically log file.
INIT-REG-<MOD2>
Command INIT-REG-<MOD2>
Explanation Initialize storage registers (OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C,
STS12C, STS48C, STS192C, VT1, EQPT, ALL)
2-166 LPS800-UM-COMM-02
Function This command instructs an NE to initialize one or more storage registers or event
counters associated with an equipment unit, facility in the NE to a specific value.
In the most common instances, these registers will contain PM information
accumulated in previous intervals.
Related Messages
Input Format INIT-REG-<MOD2>:[<TID>]:[<AID>]::<CTAG>::<MONTYPE>,[<MONVAL>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>][,<MONTM>];
<MOD2> Valid value can be OC3, OC12, OC48, OC192, T1, T3,
STS1, STS3C, STS12C, STS48C, STS192C, VT1, EQPT or
ALL.
<AID> Access Identifier identifies the equipment unit, facility,
subscriber line, trunk, link, packet link, or signaling link in the
NE, depending on the command code modifier, on which
performance monitoring data is being retrieved.
<MONTYPE> Specifies the type of monitored parameter for which a value
is requested.
<MONVAL> <MONVAL> is the value to which the register identified by
<MONTYPE> is to be initialized. It is a decimal number. A
null value is 0.
<LOCN> Indicates the location, in reference to the entity identified by
the <AID>, being performance monitored. Valid value is
NEND or FEND. NEND refers to PM values obtained at the
identified entity, and FEND refers to PM values obtained at a
distant entity that is connected to the identified entity. A null
value is ALL.
<DIRN> Specifies the direction of monitoring relative to the entity
identified by the <AID>. A null value is ALL. Valid value is
TRMT (transmit direction only) or RCV (receive direction
only).
<TMPER> Specifies the accumulation time period for the PM
information. Valid value is 15-MIN or 1-DAY. A null value of
<TMPER> defaults to 15-MIN.
<MONDAT> The date of the beginning of the requested PM period
specified in <TMPER>. Valid format is MM-DD (Month-Day).
For example, 03-01. A null value defaults to the current date.
<MONTM> The beginning time of day of the requested PM period
specified in <TMPER>. Valid format is HH-MM (Hour-Munite
in 24-hour). For example, 13-30. A null value defaults to the
current time.
LPS800-UM-COMM-02 2-167

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INIT-REG-T1::FAC-3-1:C::LPBBE,3,,,15-MIN,03-01,13-45;
Normal LoopStar 800 2004-06-20 14:30:00
M C COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M C DENY
IDRG
/*DATA RANGE ERROR*/
;
Notes When <MONDAT> and <MONTM> are all null, it initializes the current PM data.
If any of them are not null, it initializes the history PM data.
INIT-RMONHIST-<MOD2>
Command INIT-RMONHIST-<MOD2>
Explanation Initialize RMON history (FETH, GETH, ALL).
Function This command clears history counters specified by MONTYPE in statistics table.
Category RMON
Related Messages
Input Format INIT-RMONHIST-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>];
2-168 LPS800-UM-COMM-02

<MOD2> <MOD2> supports FETH, GETH and ALL. ALL means all
FETH and GETH ports in NE.
<AID> Valid format is FAC-<SLTO ID>-<PORT ID>. <AID> is
optional. Default value is ALL, which means all ports in this
MOD2 in the network element. If <MOD2> is ALL, <AID>
is null.
<MONTYPE> Identifies the RMON parameters supported. Default value
is ALL.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INIT-RMONSTAT-FETH::FAC-1-2:100::;
Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 100 DENY
IIAC
/*0X9CA0*/
;
Notes
LPS800-UM-COMM-02 2-169
INIT-RMONSTAT-<MOD2>
Command INIT-RMONSTAT-<MOD2>
Explanation Initialize RMON state (FETH, GETH, ALL).
Function This will clear counters specified by MONTYPE in statistics table.
Category RMON
Related Messages
Input Format INIT-RMONSTAT-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>];
<MOD2> <MOD2> supports FETH, GETH and ALL. ALL means all
FETH and GETH ports in NE.
optional. Default value is ALL, which means all ports in this
<MOD2> in the network element. If <MOD2> is ALL, <AID>
is null.
<MONTYPE> <MONTYPE> is all the RMON parameters supported.
Default value is ALL.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-170 LPS800-UM-COMM-02
Example Input INIT-RMONSTAT-GETH::FAC-1-1:100::RXBBAD;

Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 100 DENY
IIAC
/*0X9CA0*/
;
Notes
LPS800-UM-COMM-02 2-171
INIT-SQL-<OCN>
Command INIT-SQL-<OCN>
Explanation Initiate squelch table (OC12, OC48, OC192).
Function This command recreates the squelch table entries on demand for the addressed
NE. This command is DENIED if the <SQLMODE> is MAN, see ENT-FFP-
<SQLMODE>. This command can affect squelched traffic if executed when there
are exiting switches.
Category BLSR
ED-SQL-<STS_PATH>
RTRV-SQL-<STS_PATH>
DLT-SQL-<STS_PATH>
Input Format INIT-SQL-<OCN>:[<TID>]:<AID>:<CTAG>;
level. Valid value can be OC12, OC48, or OC192.
<AID> AID of any OCN facility associated with the BLSR
protection group.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-172 LPS800-UM-COMM-02
Example Input INIT-SQL-OC12::FAC-1-1:1;

Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 100 DENY
IPNV
;
Notes This command can not be provided in the LoopStar 800 and LoopStar 810.
LPS800-UM-COMM-02 2-173
INIT-STAT-DCC
Command INIT-STAT-DCC
Explanation Initialize state DCC.
Function This command cleares the DCC information of an OC-N facility, including the
data transmitting information and error information.
Related Messages RTRV-STAT-DCC
Input Format INIT-STAT-DCC:[<TID>]:<AID>:<CTAG>;
<AID> DCC AID identifier. See section "DCC" in Chapter 3: TL1
Parameters.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INIT-SQL-OC12::FAC-1-1:1;
Normal LoopStar 800 2004-06-20 14:30:00
M C COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M C DENY
SDNC
PARAMETER*/
;
2-174 LPS800-UM-COMM-02
INIT-SYS
Command INIT-SYS
Explanation Initialize system.
Function This command reboots a single unit or the whole system. This command will
reset a single unit or the whole system based on <AID>. According to <TYPE> it
will erase databases before reset the whole system or activate the new software
when SWDL.
Category System
Security Super-user
Related Messages ED-SYS
RTRV-SYS
Input Format INIT-SYS:[<TID>]:<AID>:<CTAG>::<TYPE>;
<AID> Valid value is SLOT-N or SLOT-ALL. SLOT-ALL means the
whole system.
<TYPE> Identifies the reboot type. Valid values are
COLD (cold restart, reload FPGA.);
WARM (warm restart, do not reload FPGA.);
DBERASE (erase databases then do warm restart. This
value is available only when the <AID> is XCS unit.).
SWDL (Only used for SWDL, reset unit at least one of its
SW/INI/EXTBIOS/FPGA has been downloaded. If FPGA is
changed it should do cold restart, otherwise warm restart.
<AID> is SLOT-ALL while activate the whole system, and
before that, you can activate a specified unit using <AID>. If
there is no file changed on that specified unit, the command
will return DENIED.).
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-175
Errors
Example Input INIT-SYS::SLOT-ALL:1002::SWDL;
Normal LoopStar 800 2004-06-20 14:30:00
M 1002 COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 1002 DENY
SNVS
/*NOT IN VALID STATE, NSERR_SWDL_STATE_ERR*/
;
Notes For SWDL, there have some restriction. If there is a standby XCS online, then
activating whole system will reset the standby to run the new software first,
otherwise active XCS. If new software in XCS running stably after 5 min then the
system will activate all the other units downloaded new software and not be
activated yet. Of course there will be a switch when having standby XCS. If no
file changed for XCS in new package, the system will activate slot units directly.
Activating single unit first cannot activate XCS.
INIT-TPL-<OCN>
Command INIT-TPL-<OCN>
Explanation Initiate topology map(OC12, OC48, OC192).
Function This command recreates the topology on demand for the entire ring. This
command is DENIED if the <TPLMODE> is MAN, see ENT-FFP-<OCN>, DLT-
FFP-<OCN>, and RTRV-FFP-<OCN> for parameter <TPLMODE>. This
command can affect traffic if executed when there are exiting switches.
Category BLSR
Related Messages ED-TPL-<OCN>
RTRV-TPL-<OCN>
Input Format INIT-TPL-<OCN>:[<TID>]:<AID>:<CTAG>;
level. Valid value can be OC12, OC48, or OC192.
<AID> <AID> of any OCN facility associated with the BLSR
protection group.
2-176 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input INIT-TPL-OC12:SONET-NE:FAC-1-2:100;
Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 100 DENY
IPNV
;
Notes This command can not be provided in the LoopStar 800 and LoopStar 810.
OPR-ACO-ALL
Command OPR-ACO-ALL
Explanation Operate alarm cutoff all.
Function This command instructs an NE to cut off the office audible alarm indications
without changing the local alarm indications. This command should not have any
effect on any effect on future alarms at the NE, but rather should direct the NE to
provide conditioning only on those alarms that are currently active. The NE
should remain able to transmit its current alarm or status condition if retrieved
by OS.
LPS800-UM-COMM-02 2-177
Category Environment
Related Messages
Input Format OPR-ACO-ALL:[<TID>]::<CTAG>;

;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors INVALID SYNTAX OR PUNCTUATION

Example Input OPR-ACO-ALL:::C;
Normal LoopStar 800 2004-06-20 14:30:00
M C COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M C DENY
IISP
/*INVALID SYNTAX OR PUNCTUATION*/
/*Format:OPR-ACO-ALL:[<tid>]::<ctag>;
SAMPLE:
OPR-ACO-ALL:::1;
*/
;
Notes
2-178 LPS800-UM-COMM-02
OPR-EXT-CONT
Command OPR-EXT-CONT
Explanation Operate external control.
Function This command instructs an NE to operate an external control. The control can be
operated momentarily or continuously.
Category Alarms and Conditions
Related Messages RLS-EXT-CONT
RTRV-EXT-CONT
Input Format OPR- EXT-CONT:[<TID>]:<AID>:<CTAG>::[< CONTTYPE >],[<DUR>];
<AID> The AID of external control.
<CONTTYPE> The type of control. A null value for <CONTTYPE>
requests the operation of all controls identified by the
<AID> parameter.
<DUR> Specifies the duration of the external control operation
(for example, the duration of the relay activation). Valid
values of it are CONTS (continuously) and MNTRY
(momentarily, 5 seconds here). A NULL means MNTRY.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-179
Errors SLOT PARAMETER ERROR

CONDITION TYPE PARAMETER ERROR
CONDITION ATTRIBUTE ERROR
PORT PARAMETER ERROR
CHANNEL PARAMETER ERROR
PARAMETER ERROR
WITHOUT UNIT IN THIS SLOT
CONTROL PARAMETER ERROR
Example Input OPR-EXT-CONT::CONT-7:C::CONT-AIRCOND,CONTS;
Normal LoopStar 800 2004-06-20 14:30:00
M C COMPLD
;
Error LoopStar 800 2004-06-20 14:30:00
M 1 DENY
IPNC
/*PARAMETER NOT CONSISTENT, PARAMETER ERROR */
;
Notes This command is not available to the LoopStar 810.
OPR-LPBK-<FETH>
Command OPR-LPBK-<FETH>
Explanation Operate loopback (Fast Ethernet).
Function This command instructs NE to operate a loopback on a specified Ethernet port.
Category Loopback
Related Messages RLS-LPBK-<FETH>
RTRV-LPBK-<FETH>
Input Format OPR-LPBK-<FETH>:[<TID>]:<AID>:<CTAG>::<LPBKTYPE>:
LPBKMODE=<LPBKMODE>;
2-180 LPS800-UM-COMM-02

<AID> Access identifier identifies the Ethernet facility. Valid
format is FAC-<SLOT ID>-<PORT ID>. It supports "&"
and "&&".
<LPBKTYPE> Loopback type. Valid value is FACILITY or TERMINAL.
It is compulsory.
<LPBKMODE> Loopback mode. Valid value is MAC (MAC loopback) or
PHY (physical loopback). It is compulsory.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input OPR-LPBK-FETH::FAC-5-2:100::FACILITY:LPBKMODE=MAC;
Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IIAC
;
Notes
LPS800-UM-COMM-02 2-181
OPR-LPBK-<FETH/GETH>
Command OPR-LPBK-<FETH/GETH>
Explanation Operate loopback (fast Ethernet, Gigabit Ethernet).
Function This command instructs NE to operate a loopback on a specified Ethernet port.
Category Loopback
Related Messages RLS-LPBK-<FETH/GETH>
Input Format OPR-LPBK-<FETH/GETH>:[<TID>]:<AID>:<CTAG>::<LPBKTYPE>:
LPBKMODE=<LPBKMODE>;
and "&&".
It is compulsory.
PHY (physical loopback). It is compulsory.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
2-182 LPS800-UM-COMM-02
Example Input OPR-LPBK-FETH::FAC-5-2:100::FACILITY:LPBKMODE=MAC;

Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IIAC
;
Notes
OPR-LPBK-<OCN/T1/T3/STS_PATH>
Command OPR-LPBK-<OCN/T1/T3/STS_PATH>
Explanation Operate loopback (OC-N, T1, T3, STS_PATH).
Function This command instructs NE to operate a loopback on a specified port or path.
The loopback may be accomplished at either the near end, the far end, or on the
line. It is assumed that the specified entity is in a state that allows a loopback to
occur. If not, an error response should be issued by the NE.
Category Loopback
Related Messages
Input Format OPR-LPBK-<OCN/T1/T3/STS_PAH>:[<TID>]:<AID>:<CTAG>::,,,<LPBKTYPE>;
<OCN> The modifier that identifies the type of optical carrier
(OC) level. Valid values are OC3, OC12, OC48, or
OC192.
STS24C, STS48C, or STS192C.
<AID> Access identifier identifies the port or path. If <AID> is
the ID of path, that means cross-connection loopback.
<LPBKTYPE> Loopback mode. Valid modes are shown in the section
"LOOPBACK TYPE" of Chapter 3: TL1 Parameters.
LPS800-UM-COMM-02 2-183

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input OPR-LPBK-OC3::FAC-6-1:C::,,,FACILITY;
Normal LoopStar 800 2004-03-15 18:55:23
M C COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M C DENY
IPNV
/*PARAMETER NOT VALID, Operation Refused Based on Current State!*/
/*0X9F83*/
;
Notes To operate a loopback, the port must have been previously removed.
2-184 LPS800-UM-COMM-02
OPR-PROTNSW-<OCN>
Command OPR-PROTNSW-<OCN>
Explanation Operate a protection switch (OC3, OC12, OC48, OC192).
Function This command operates a protection switch.
Related Messages RLS-PROTNSW-<OCN>
Input Format OPR-PROTNSW-<OCN>:[<TID>]:<AID>:<CTAG>::<SC>:[<ST>];
<OCN> Identifies the type of optical carrier (OC) level. Valid values are
OC3, OC12, OC48, or OC192.
<AID> Identifies the OC-N port in the SONET line protection/BLSR
group.
<SC> The switch command that is to be initiated. Valid values for
<SC> is one of the followings:
LOCKOUT (lockout, SONET line protection only);
FRCD (forced switch);
MAN (manual switch);
EXERCISE (exercise switch);
LP (lock of protection, BLSR only);
LOW (lock of work, BLSR only);
LKALL (lock all protection, BLSR only);
LPG (lockout of protection group, 1+1 OPT only).
For 1+1 OPT protection architecture, only FRCD, MAN and LPG
are permitted.
<ST> Only used for BLSR. Valid value is RING or SPAN.
LPS800-UM-COMM-02 2-185

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input 1+1 protection example:
OPR-PROTNSW-OC3::FAC-2-1:123::FRCD;
Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IPNV
;
Notes The BLSR function part of this command cannot be provided in the LoopStar 800
and LoopStar 810.
OPR-PROTNSW-<STS_PATH>
Command OPR-PROTNSW-<STS_PATH>
Explanation Operate protection switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C).
2-186 LPS800-UM-COMM-02
Function This command instructs NE to execute external switch command.

1. This command applies to UPSR configuration only.
2. If you send this command on the destination AID, a DENY (Invalid AID,
should use working/protect AID) message will be returned.
3. To get the protection switching state (manual, lockout, force), use the
RTRV-COND-ALL or RTRV-ALM-ALL commands.
Category UPSR
Related Messages RLS-PROTNSW-<STS_PATH>
Input Format OPR-PROTNSW-<STS_PATH>:[<TID>]:<AID>:<CTAG>::<SC>;
STS192C.
<AID> Access identifier identifies the STS path. Must be
working path or protecting path. (See "STS-N" parameter
description in Chapter 3: TL1 Parameters.)
<SC> External switch command. Valid value is shown in the
section "SWITCH STATE OF STS PATH OR VT PATH"
of Chapter 3: TL1 Parameters.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-187
Example Input OPR-PROTNSW-STS1::STS-2-1-1:123::MANUAL;

Normal LoopStar 800 2004-03-15 15:54:55
M 123 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 123 COMPLD
PLNA
;
Notes
OPR-PROTNSW-<STS_PATH/VT_PATH>
Command OPR-PROTNSW-<STS_PATH/VT_PATH>
Explanation Operate protection switch (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
Function This command instructs NE to execute external switch command.
1. This command applies to UPSR configuration only.
2. The VT_PATH AID should be working or protect path AID only.
3. If you send this command on the destination AID, a DENY (Invalid AID,
should use working/protect AID) message will be returned.
4. To get the protection switching state (manual, lockout, force), use the
RTRV-COND-ALL or RTRV-ALM-ALL commands.
Category UPSR
Related Messages RLS-PROTNSW-<STS_PATH/VT_PATH>
Input Format OPR-PROTNSW-<STS_PATH/VT_PATH>:[<TID>]:<AID>:<CTAG>::<SC>;
<STS_PATH/ Identifies the type of STS and VT path. Valid values are
VT_PATH> STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
<AID> Access identifier identifies the STS/VT path. Must be
working path or protecting path. (See "STS-N" and "VT"
sections of Chapter 3: TL1 Parameters)
<SC> External switch command. Valid value is shown in the
section "SWITCH STATE OF STS PATH OR VT PATH"
2-188 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input OPR-PROTNSW-STS1::STS-2-1-1:123::MANUAL;
Normal LoopStar 800 2004-03-15 15:54:55
M 123 COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 123 COMPLD
PLNA
;
Notes
OPR-PROTNSW-EQPT
Command OPR-PROTNSW-EQPT
Explanation Operate protection switch equipment.
Function This command instructs the NE to perform an equipment unit protection switch.
This command is only applied to both DSn (TPS) and XCS protections.
Related Messages RLS-PROTNSW-EQPT
Input Format OPR-PROTNSW-EQPT:[<TID>]:<AID>:<CTAG>::<SC>;
LPS800-UM-COMM-02 2-189

<AID> Equipment AID. See "EQPT" section in Chapter 3: TL1
Parameters.
<SC> The switch command that is to be initiated. Valid <SC> is
one of the following: LOCKOUT, FRCD, MAN. For XCS
protection, LOCKOUT is not available.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input OPR-PROTNSW-EQPT::SLOT-5:C::MAN;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
;
Notes 1. This command is used for DSn (TPS) protection and XCS1+1. For
XCS1+1, only MAN and FRCD switch operations are valid.
2. For DSn (TPS) protection, Each successful switch request should be fol-
lowed by the appropriate switch event.
3. When the protection unit is failed, the FRCD switch can be initialized but
the MAN switch cannot.
2-190 LPS800-UM-COMM-02
OPR-SYNCNSW
Command OPR-SYNCNSW
Explanation Operate the synchronization reference switch.
Function This command is used to instruct a NE to switch synchronization references.
Synchronization reference switches initiated with this command remain active
until they are released via the RLS-SYNCNSW command. The general
switching hierarchy in GR-253-CORE will be applied.
Special description about this command is shown in Note session.
Related Messages RLS-SYNCNSW
Input Format OPR-SYNCNSW:[<TID>]:[<AID>]:<CTAG>::<SYNCAID>,<SWMODE>;
<AID> Access identifier of synchronization reference list. Valid
values are
SYNCCLOCK (system clock reference list);
SYNCOUT-1 (BITS-1 output clock reference list);
SYNCOUT-2 (BITS-2 output clock reference list).
<SYNCAID> Timing reference facility AIDs. See "SYNCAID" for detail. The
<SYNCAID> must be in the list that <AID> points out.
<SWMODE> Switch mode. Valid values are:
LOCKOUT (excluded from switching in a particular sync list);
MAN (manually switch to a reference source);
FRCD (forced switch to a reference source).
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-191
Errors
Example Input OPR-SYNCNSW::SYNCCLOCK:C::FAC-1-1,FRCD;
Normal LoopStar 800 2004-03-15 18:55:23
M C COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M C DENY
;
Notes 1. The switch state can be query by RTRV-SYNCLIST command.
2. Forced switch can be done to any quality of synchronization reference.
3. Manual switch can be only done to the highest quality of synchronization
reference. If two synchronization reference has the same hightest quality,
the lower priority reference can be manually switched to be a tacing
reference.
REPT ACCESS WARNING
Command REPT ACCESS WARNING

Explanation Report access warning.
Function This command gives a warning to the login user who cannot operate the NE
legally. This warning will be seem as the gist of the suit.
Category Security
Security Retrieve
Related Messages
Input Format –
Output Format <cr><lf><lf>

^^^<SID>^<DATE>^<TIME><cr><lf>
A^^<ATAG>^REPTÂCCESS^WARNING<cr><lf>
^^^/*WARN*/<cr><lf>
;
WARN The content of the warning (string).
Errors
2-192 LPS800-UM-COMM-02
Example Input ACT-USER::USERCTX:C::CTXCTX1;

Normal LoopStar 800 2004-03-04 15:23:20
M C COMPLD
"Last log time:04-1-1 19:48:54"
;
Error LoopStar 800 2004-03-04 15:23:20
A 6 REPT ACCESS WARNING
;
Notes
REPT ALM <MOD2>
Command REPT ALM <MOD2>

Explanation Report alarms (ALL, OC3, OC12, OC48, OC192, EC1, FETH, GETH, VCG, T1,
T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,
VT1, EQPT, DS1, DS3, SYNC, SYNCALL, SYNCFAC, BITS).
Function This is an autonomous message generated by the NE to inform the OS of the
occurrence of an alarm condition from a facility, path or equipment.
A non-alarmed event is not reported with this message; the REPT EVT message
is used. This characteristic shall be settable by using the SET-ATTR command.
But only SC event can be changed to alarm by using the SET-ATTR command.
Security Retrieve
Related Messages RTRV-ALM-<MOD2>
RTRV-COND-<MOD2>
REPT EVT <MOD2>
Input Format –

<ALMCODE>^<ATAG>^REPTÂLM^^<MOD2><cr><lf>
^^^"[<AID>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],[<OCRT
M>],[<LOCN>],[<DIRN>]:[<CONDDESCR>]"<cr><lf>
;
LPS800-UM-COMM-02 2-193

<MOD2> The second modifier of the report message which identifies
the type of the entity that reports trouble.
Valid valus are ALL, OC3, OC12, OC48, OC192, EC1,
FETH, GETH, VCG, T1, T3, STS1, STS3C, STS6C,
STS9C, STS12C, STS24C, STS48C, STS192C, VT1,
EQPT, DS1, DS3, SYNC, SYNCALL, SYNCFAC or BITS.
<AID> The AID of the entity that reports trouble.
<NTFCNCDE> Associated with <CONDTYPE>. Valid values are CR
(critical alarm), MJ (major alarm), MN (minor alarm) or CL
(cleared alarm).
<CONDTYPE> Identifies the type of alarm indication.
<SRVEFF> The effect on service caused by the alarm condition.
<OCRDAT> <OCRDAT> is the date when the event occurred.
<OCRTM> <OCRTM> is the time of day when the event occurred.
<LOCN> The single location for which an alarm condition is being
reported and refers to the entity identified by the AID. Thus,
NEND (near end) refers to alarm conditions occurring at the
identified entity, and FEND (far end) refers to alarm
conditions occurring at a distant entity that is connected to
the identified entity. Likewise, LINE [-x] refers to an
intermediate point.
<DIRN> <DIRN> is the direction of the event and is relative to the
entity identified by the <AID>. Valid value is TRMT (transmit
direction only) or RCV (receive direction only).
<CONDDESCR> The detailed text description of the alarm condition.
Errors
Example Input
Normal LoopStar 800 2004-11-09 05:24:58
** 125 REPT ALM EQPT
"SLOT-3:MJ,BDSTATUS,NSA,2004-11-09,05-24-58,NEND,RCV:\"Card
removed\","
;>
Notes
2-194 LPS800-UM-COMM-02
REPT ALM ENV
Command REPT ALM ENV

Explanation Report alarm environment.
occurrence of an environmental alarm.
Category Alarm and Condition
Security Retrieve
Related Messages RTRV-ALM-ENV
Input Format –

Format
<ALMCODE>^<ATAG>^REPTÂLMÊNV<cr><lf>
^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>][,<ALMMSG
>]:[SN=<ALMSN>]"<cr><lf>
;
<ALMCODE> <ALMCODE> identifies the nature of the autonomous
message based on its priority of action. The valid values of
<ALMCODE> in decreasing order of severity are as follows:
*C Critical alarm; ** Major alarm; *^ Minor alarm; A^
Automatic Message.
<AID> The AID of the input switch for environment monitoring.
<NTFCNCDE> Associated with <ALMTYPE>. The <NTFCNCDE> is an
abbreviated code identifying the alarm and the valid values
are
CR (critical alarm), MJ (major alarm), MN (minor alarm) or
CL (cleared alarm).
<ALMTYPE> <ALMTYPE> is the type of environmental alarm returned by
the various ENV commands listed in section "FAULT".
<ALMMSG> <ALMMSG> is the text message associated with the
environmental alarm. It is comprised of a maximum of 63
characters.
<SN> The number of alarm message, only for Huawei EMS.
LPS800-UM-COMM-02 2-195

PARAMETER ERROR
Example Input
Normal LoopStar 800 2004-03-04 15:23:20
** 157 REPT ALM ENV
"ENV-1:MJ,ENV-AIRCOND,2004-07-09,15-06-55:\"CARD TYPE
MISMATCH\","
;
Notes
2-196 LPS800-UM-COMM-02
REPT DBCHG
Command REPT DBCHG

Explanation Report database change.
change of database. DBCHG is reported when any command except RTRV is
completed or when a unit is plugged or unplugged. REPT DBCHG message will
be reported to all log-in users.
Category System
Related Messages ALW-MSG-DBCHG
INH-MSG-DBCHG
Input Format

A^^<ATAG>^REPT^DBCHG<cr><lf>
^^^"DATE=<DATE>,TIME=<TIME>,[SOURCE=<SOURCE>],[USERID=<USERI
D>],DBCHGSEQ=<DBCHGSEQ>:<COMMAND>"<cr><lf>
;
<DATE> <DATE> is the date when the event occurred.
<TIME> <TIME> is the time of day when the event occurred.
<SOURCE> <SOURCE> is the CTAG of input command if it is present.
<USERID> <USERID> is the username or userid who initializes the
command.
<DBCHGSEQ> <DBCHGSEQ> is the sequential number of the DBCHG
event. Valid values are integers between 0 and 9999.
<COMMAND> It is the input command excluding the last character
semicolon and the TID part, which triggers the database
change. If the DBCHG is triggered by hardware change,
"PLUG-IN" and "UNPLUG" are used as the command code.
Errors
LPS800-UM-COMM-02 2-197
Example Input ENT-USER-SECU::TESTUSER1:100::PASS123,,MAINT;

Normal LoopStar 800 2004-03-04 15:23:20
M 100 COMPLD
/*
Error LoopStar 800 2004-03-04 15:23:20
A 10 REPT DBCHG
"DATE=2004-07-08,TIME=15-11-
29,SOURCE=100,USERID=SONET,DBCHGSEQ=2:ED-USER-
SECU:TESTUSER1:,,,:TMOUTEN=ENABLE,TMOUTLN=30"
*/
;
Notes This message is used to immediately report to OS database changes that have
occurred as a result of commands entered, and changes due to external events
such as board insertion or removal.
Even If only one parameter of a non-RTRV command is set successfully, this
command should be reported by REPT DBCHG, although the command
response is DENY. But if the command is completely denied, the command
should NOT be reported by REPT DBCHG.
REPT EVT <MOD2>
Command REPT EVT <MOD2>

Explanation Report event (ALL, OC3, OC12, OC48, OC192, EC1, FETH, GETH, VCG, T1,
T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,
occurrence of a event condition from a facility, a path or equipment.
This message may also be used to report the recovery from off-normal or trouble
conditions that were reported initially by REPT-EVT. This is done by using the
<CONDTYPE> sent by the original event report and using the value CL for
<CONDEFF>.
Security Retrieve
Related Messages REPT ALM <MOD2>
RTRV-ALM-<MOD2>
RTRV-COND-<MOD2>
REPT ALM ENV
RTRV-ALM-ENV
2-198 LPS800-UM-COMM-02
Input Format
<MOD2> Type of AID. Valid value is one of these: T1, T3, VT1,
STS1, STS3C, STS12C, OC3, OC12.
Format
A^^<ATAG>^REPTÊVT^<MOD2><cr><lf>
^^^"[<AID>]:<CONDTYPE>,[<CONDEFF>],[<OCRDAT>],[<OCRTM>],[<LOCN
>],[<DIRN>],[<MONVAL>],[<THVAL>],[<TMPER>]:[<CONDDESC>]"<cr><lf>
;
the type of the entity that reports trouble. Valid values are
ALL, OC3, OC12, OC48, OC192, EC1, FETH, GETH, VCG,
T1, T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1, EQPT, DS1, DS3, SYNC,
SYNCALL, SYNCFAC or BITS.
<AID> The AID of the entity that reports event. Refer to Charpter 3
TL1 Parameters for its possible values.
<CONDTYPE> Identifies the condition type of event.
<CONDEFF> Indicates the effect of the event on the condition of the NE.
The event may initiate a standing condition, which can later
be retrieved using the RTRV-COND command or may
initiate a transient condition that does not change the basic
condition of the NE for an extended time period. Valid
values for <CONDEFF> are CL (standing condition cleared),
SC (standing condition raised) or TC (transient condition). A
null value for <CONDEFF> defaults to TC.
reported and refers to the entity identified by the <AID>.
Thus, NEND (near end) refers to alarm conditions occurring
at the identified entity, and FEND (far end) refers to alarm
intermediate point. This is optional.
<DIRN> <DIRN> is the direction of the event and is relative to the
entity identified by the <AID>. It is optional. Valid value is
TRMT (transmit direction only) or RCV (receive direction
only).
<MONVAL> <MONVAL> is the monitored value and is a float.
<MONVAL> is an integer and optional.
<THVAL> <THVAL> is the threshold value and is a float. <THVAL> is
an integer and optional.
LPS800-UM-COMM-02 2-199
Output Parameter <TMPER> <TMPER> is the accumulation time period for the PM
(cont.) information if the <CONDTYPE> is of the from T-x for a
threshold violation.
<CONDDESCR> It is the detailed text description of the alarm condition.
Errors
Example Input
Normal LoopStar 800 2004-03-04 15:23:20
A 544 REPT EVT T3
"FAC-7-1:T-SES-L,TC,2004-09-22,20-21-21,NEND,RCV,1,1,15-MIN:\"TCA -
SEVERELY ERROR SECONDS - LINE\","
;
Notes
REPT EVT ACTIVATED
Command REPT EVT ACTIVATED

Explanation Reports user that the whole system works well after INIT-SYS command
activating the new software.
Function After the user activate new software with command INIT-SYS, it will take some
time to reset units which software having been upgraded in some sequence, and
waiting some time to see if the system run well. There may even has a switch
between active and standby XCS units. It means the new software works well
and can be committed.
Category System
Security Retrieve
Related Messages
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPTÊVTÂCTIVATED<cr><lf>
""
;
Errors
Example Input
Normal LoopStar 800 2004-10-16 09:38:01
A 27 REPT EVT ACTIVATED
;
2-200 LPS800-UM-COMM-02
REPT EVT BDMATCHFAILED
Command REPT EVT BDMATCHFAILED

Explanation Report event board (unit) matching failed.
Function When error occurs during matching process of unit, the event will be issued.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^BDMATCHFAILED<cr><lf>
^^^"AID=<AID>,BDTYPE=<BDTYPE>,PCB=<PCB>"
;
<AID> Valid value is SLOT-N.
<BDTYPE> Unit type.
<PCB> Hardware version.
Errors
Example Input
Normal LoopStar 800 2004-10-16 09:38:01
A 27 REPT EVT BDMATCHFAILED
"AID=SLOT-4,BDTYPE=68,PCB=2"
;
Notes
REPT EVT BDNOMATCHHW
Command REPT EVT BDNOMATCHHW

Explanation Report that there is no software in new package matched with hardware version
(unit type or PCB version) of a unit.
Function There is no software in new package matched with hardware version (unit type
or PCB version) of a unit. This event issued during matching process.
Category System
LPS800-UM-COMM-02 2-201
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^BDHWNOTMATCH<cr><lf>
^^^"AID=<AID>,BDTYPE=<BDTYPE>,PCB=<PCB>"
;
<BDTYPE> Unit type.
<PCB> Hardware version.
Errors
Example Input
Normal LoopStar 800 2004-10-16 09:38:01
A 29 REPT EVT BDNOTMATCHHW
"AID=SLOT-4,BDTYPE=68,PCB=2"
;
Notes
REPT EVT COMMITEND
Command REPT EVT COMMITEND

Explanation Report event of commit command.
Function After committing, all units will copy new software package from standby bank to
active bank. NE will issue this event to inform user the completion of command
and NE turns to normal state.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^COMMITEND<cr><lf>
"";
Errors
2-202 LPS800-UM-COMM-02
Example Input
Normal LoopStar 800 2004-10-16 09:38:01
A 28 REPT EVT COMMITEND
;
Notes
REPT EVT COMMITFAILED
Command REPT EVT COMMITFAILED

Explanation Report event of commit command.
Function There is error occurred in the implement of commit command. But NE will not
rollback any more during it, and NE turns to normal state.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^COMMITFAILED<cr><lf>
"";
Errors
Example Input
Normal LoopStar 800 2004-10-16 09:38:01
A 48 REPT EVT COMMITFAILED
;
Notes
REPT EVT CPYMEMEND
Command REPT EVT CPYMEMEND

Explanation Report event of CPY-MEM end.
LPS800-UM-COMM-02 2-203
Function This autonomous message reports the completion of CPY-MEM command. After
CPY-MEM synchronize new software package to standby XCS and download
new software to target slot units, NE will issue this event to inform user the
completion of command.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^CPYMEMEND<cr><lf>
""
;
Errors
Example Input
Normal LoopStar 800 2004-10-16 09:38:01
A 25 REPT EVT CPYMEMEND
;
Notes
2-204 LPS800-UM-COMM-02
REPT EVT FXFR
Command REPT EVT FXFR

Explanation Report event file transfer.
Function This autonomous message reports the completion of the file transfer. After user
initialize a file transfer using COPY-RFILE command, NE will issue this event to
inform the user when file transfer complete. When an integrated software
package transfer complete report this event.
Category System
Security Retrieve
Related Messages
Input Format

A^^^<ATAG>^REPTÊVT^FXFR<cr><lf>
""
;
Errors
Example Input
Normal LoopStar 800 2004-06-20 14:44:06
A 24 REPT EVT FXFR
;
Notes
LPS800-UM-COMM-02 2-205
REPT EVT FXFRHALT
Command REPT EVT FXFRHALT

Explanation Report event file transfer halt.
Function This autonomous message reports link break event when transfer files during
the executing of COPY-RFILE. COPY-RFILE command gets files from FTP
server, and if the link between NE and FTP server breaks, NE issues this event
inform user, and wait some time before rollback automatically, during which user
can use same command trying to continue file transfer.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^ FXFRHALT<cr><lf>
^^^"TRANSFEREDFILES=<FINISHED>,TOTALNUM=<TOTAL>,WTIME=<WTI
ME>"<cr><lf>
;
<FINISHED> The amounts of files have been transferred.
<TOTAL> The total amount of files.
<WTIME> The time before automatically rollback, the unit is minute.
Errors
Example Input
Normal LoopStar 800 2004-01-01 02:10:37
A 13 REPT EVT FXFRHALT
"TRANSFEREDFILES=8,TOTALNUM=12,WTIME=5"
;
Notes
2-206 LPS800-UM-COMM-02
REPT EVT NOSWINPKG
Command REPT EVT NOSWINPKG

Explanation Report event no software in the package.
Function Report that there is no software in the package for a unit. In CPY-MEM process,
there is no software in new package matched with the type of a unit. The
software of this unit will not be updated. User can choose abort SWDL or ignore.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^NOSWINPKG<cr><lf>
^^^"AID=<AID>,BDTYPE=<BDTYPE>,PCB=<PCB>"<cr><lf>
;
<BDTYPE> Unit type.
<PCB> Hardware version. It is a string.
Errors
Example Input
Normal LoopStar 800 2004-01-01 02:12:37
A 13 REPT EVT NOSWINPKG
"AID=4,BDTYPE=0X0044,PCB=0X02"
Notes
LPS800-UM-COMM-02 2-207
REPT EVT PROGRESS
Command REPT EVT PROGRESS

Explanation Report event progress.
Function This autonomous message reports the rate of completion of command COPY-
RFILE or CPY-MEM. For COPY-RFILE, first parameter is the files have been
transferred, the other is the total files should be transferred. For CPY-MEM, first
one is the amount of slot units having been downloaded new software, second
one is total amount of slot units which should be downloaded new software.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^PROGRESS<cr><lf>
^^^"TRANSFEREDFILES=<FINISHED>,TOTALNUM=<TOTAL>"<cr><lf>
;
<FINISHED> The amounts of files have been transferred of slot units
have been downloaded new software.
<TOTAL> The total amount of files or slot units.
Errors
Example Input
Normal LoopStar 800 2004-01-01 03:15:16
A 13 REPT EVT PROGRESS
"TRANSFEREDFILES=8,TOTALNUM=12"
;
Notes
2-208 LPS800-UM-COMM-02
REPT EVT ROLLBACKEND
Command REPT EVT ROLLBACKEND

Explanation Report event roll back end.
Function This autonomous message reports that SWDL has been aborted and the system
has rolled back to the old version software package. If there is an error occur
during SWDL or user send ABT-CMD command to abort SWDL, the system roll
back and the event issued in the end of rollback.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^ROLLBACKEND<cr><lf>
""
;
<FINISHED> The amounts of files have been transferred of slot units
have been downloaded new software.
<TOTAL> The total amount of files or slot units.
Errors
Example Input
Normal LoopStar 800 2004-06-20 15:17:33
A 49 REPT EVT ROLLBACKEND
;
Notes
LPS800-UM-COMM-02 2-209
REPT EVT ROLLBACKSTART
Command REPT EVT ROLLBACKSTART

Explanation Report event roll back start.
Function This autonomous message reports that when an error occurs in the systerm
during SWDL, the systerm begin to roll back to the old software package. If there
is an error occurs during SWDL, the system roll back and the event issued,
which parameter inform the begin of rollback. But if user aborts SWDL manually
the beginning of rollback will not be reported.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^ROLLBACKSTART<cr><lf>
""
;
Errors
Example Input
Normal LoopStar 800 2004-06-20 15:07:33
A 48 REPT EVT ROLLBACKSTART
;
Notes
2-210 LPS800-UM-COMM-02
REPT EVT SECU
Command REPT EVT SECU

Explanation Report event security.
Function This autonomous message reports the event to user that the user password is
out of time when user login.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPT^LOGOFF<cr><lf>
^^^"<AID>:<CONDTYPE>,[<CONDEF>],,,,,,,:[<CONDDESCR>]"
;
<AID> Here is "COM".
<CONDTYPE> Valid value is PIDEXPR (the user password is out of time).
<CONDEF> Here is "TC" (transient condition).
Errors
Example Input ACT-USER::USERCTX:C::CTXCTX1;
Normal SONET-NE 2004-01-01 19:49:38
M C COMPLD
"Last log time:04-1-1 19:48:54"
;
Error SONET-NE 2004-01-01 19:49:38
5 REPT EVT SECU
"COM:PIDEXPR,TC,,,,,,,:PID EXPIRED"
SONET-NE 2003-01-01 19:49:38
6 REPT ACCESS WARNING
;
Notes If user is reported that the password is out of time when he login, he must modify
the password. The user can only use the password out of time three times. If it is
beyond 3 times, the user cannot log in any more.
LPS800-UM-COMM-02 2-211
REPT EVT SLVMATCHFAILED
Command REPT EVT SLVMATCHFAILED

Explanation Report event software load version match failed.
Function This autonomous message is reported when error occurs during software
version matching process of active XCS, the event will be issued.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^SLVMATCHFAILED<cr><lf>
""
;
Errors
Example Input
Normal LoopStar 800 2004-06-20 15:33:14
A 33 REPT EVT SLVMATCHFAILED
;
Notes
2-212 LPS800-UM-COMM-02
REPT EVT SLVNOMATCHHW
Command REPT EVT SLVNOMATCHHW

Explanation Report event software load version no match of hardware.
Function This autonomous message is reported when there is no software in new
package matched with hardware version (unit type or PCB version) of active
XCS. This event issued during matching process.
Category System
Security Retrieve
Related Messages
A^^^<ATAG>^REPTÊVT^SLVHWNOTMATCH<cr><lf>
""
;
Errors
Example Input
Normal LoopStar 800 2004-06-20 15:33:14
A 32 REPT EVT SLVHWNOTMATCH
;
Notes
LPS800-UM-COMM-02 2-213
REPT EVT VBLP
Command REPT EVT VBLP

Explanation Report event virtual bridge logical port.
Function This autonomous message reports the STP state of virtual bridge logical port.
Security Retrieve
Related Messages
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>
A^^<ATAG>^REPTÊVT^VBLP<cr><lf>
^^^"<AID>:<CONDTYPE>,<CONDEFF>"<cr><lf>
;
<AID> Indicates the slot ID, virtual bridge ID and port ID. Valid
format is VBLP-<SLOT ID>-<VB ID>-<LP ID>.
<CONDTYPE> Indicates the type of event. Valid values are
STPPORT-DISABLE, STPPORT-LISTENING, STPPORT-
LEARNING, STPPORT-FORWARDING, STPPORT-
BLOCKING or STPPORT-DISCARDING.
Valid value can be TC.
Errors
Example Input
Normal LoopStar 800 2004-06-20 15:33:14
A 100 REPT EVT VBLP
"VBLP-1-2-3:STPPORT-DISABLE"
;
Notes
2-214 LPS800-UM-COMM-02
REPT EVT VCG
Command REPT EVT VCG

Explanation Report event VC group.
Function This autonomous message reports the link capacity adjustment scheme (LCAS)
member state of VCG.
Security Retrieve
Related Messages
A^^<ATAG>^REPTÊVT^VCG<cr><lf>
^^^"<AID>::<CONDTYPE>,<CONDEFF>,<DIRECTION>,<PATHTYPE>,<PATH
>"<cr><lf>
;
<AID> Indicates the slot ID and VCG ID. Valid format is VCG-
<SLOT ID>-<VCG ID>.
<CONDTYPE> Indicates the type of event. Valid value is LCAS-ADD-
SUCCESS, LCAS-ADD-TIMEOUT, LCAS-DEL-SUCCESS,
LCAS-DEL-TIMEOUT or LCAS-RESTORE.
Valid value can be TC.
<DIRECTION> The direction which assigned to the VCG ID. Valid value is
UP or DOWN.
<PATHTYPE> The path type of VCG. Valid values are VT1.5V, STS1V,
STS3V or STS1C.
<PATH> The time slot number which assigned to the VCG ID. Valid
value ranges from 1 to MAX_PATH_NUM and support the &
and && symbol.
Errors
Example Input
Normal LoopStar 800 2004-06-20 15:33:14
A 100 REPT EVT LCAS
"VCG-5-3::LCAS-ADD-SUCCESS,TC,UP,VC3V,1&&3"
;
Notes
LPS800-UM-COMM-02 2-215
REPT LOGOFF
Command REPT LOGOFF

Explanation Report log off.
Function This autonomous message reports the logoff event to user which has been
logged off.
Category Security
Security Retrieve
Related Messages
A^^^<ATAG>^REPT^LOGOFF<cr><lf>
^^^"<AID>:<CONDTYPE>,[<CONDEF>],,,,,,,:[<CONDDESCR>]"<cr><lf>
;
<AID> Here is "COM".
<CONDTYPE> The type of logoff. It includes the following types:
• CMD LOGOFF (logoff by command),
• FORCE LOGOFF (ogoff forcibly),
• UIDEXP LOGOFF (logoff because the user is
out of time),
• AUTO LOGOFF (logoff automatically).
<CONDEFF> Here is "TC" (transient condition).
Errors
Example Input CANC-USER::USERCTX:C;
Normal LoopStar 800 2004-06-20 15:33:14
M C COMPLD
;
Error LoopStar 800 2004-01-01 02:10:37
13 REPT LOGOFF "COM:CMD LOGOFF,TC,,,,,,,:USER COMMAND LOG
OFF"
;
Notes
2-216 LPS800-UM-COMM-02
REPT PM <MOD2>
Command REPT PM <MOD2>

Explanation Report performance monitoring (ALL, OC3, OC12, OC48, OC192, T1, T3,
STS1, STS3C, STS12C, STS48C, STS192C, VT1).
Function REPT PM <MOD2> is generated by an NE to inform the OS or maintenance
personnel of PM information. Parameters are provided to report PM data from
multiple data collection intervals in a single message for NEs that store a history
of PM information. REPT PM is an automatic message that is generated by the
NE.
PM data may also be retrieved on demand by a RETRIEVE-PM command,
however REPT PM is not used to respond to a RETRIEVE-PM command (see
RETRIEVE-PM response format).
Related Messages ALW-PMREPT-ALL
INH-PMREPT-ALL
Format
^^^<rsphdr><cr><lf>
A^^<atag>^REPT^PM^<MOD2>
<cr><lf> <rspblk>+
;
where <rspblk> has the format:

^^^"[<AID>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],[<DIRN>],[<TMP
ER>],[<MONDAT>][,<MONTM>]"<cr><lf>
LPS800-UM-COMM-02 2-217

<MOD2> The second modifier of the report message which
identifies the type of the entity that reports trouble. Valid
value can be: ALL, OC3, OC12, OC48, OC192, T1, T3,
STS1, STS3C, STS12C, STS48C, STS192C or VT1.
<AID> Access identifier identifies the single equipment unit,
facility, link, packet link, or signaling link in the NE to which
the retrieved monitored parameter value pertains.
<MONTYPE> Indicates the type of monitored parameter whose value is
being reported.
<MONVAL> Identifies the measured value of the monitored parameter.
<VLDTY> Identifies the validity indicator for the reported PM data. It
indicates whether the information for the specified time
period is accumulated over the entire time period or some
portion of it.
<LOCN> Indicates the location, in reference to the entity identified
by the <AID>, from which the PM value is being retrieved.
Thus, NEND (near end) refers to PM values obtained at
the identified entity, and FEND (far end) refers to PM
values obtained at a distant entity that is connected to the
identified entity.
<DIRN> Indicates the direction of PM relative to the entity identified
by the <AID>. Valid value is TRMT (transmit direction only)
or RCV (receive direction only).
<TMPER> Indicates the accumulation time period for the PM
information.
<MONDAT> Indicates the date of the beginning of the PM period
specified in <TMPER>.
<MONTM> Indicates the beginning time of day of the PM period
Example Input
Normal LoopStar 800 2004-11-09 17:25:12
A C REPT PM T1
"FAC-5-1,T1:LPBBE,2,VALID,NEND,RCV,15-MIN,11-09,17-15"
;
Notes
2-218 LPS800-UM-COMM-02
REPT RMON FALLING
Command REPT RMON FALLING

Explanation Report RMON falling (event).
Function This autonomous message reports the falling event of RMON.
Category RMON
Security Retrieve
Related Messages
<ALMCODE>^^<ATAG>^REPT^RMON^FALLING<cr><lf>
^^^"<AID>:<MONTYPE>,<OCRDAT>,<OCRTM>,<INTERVAL>,<VALUE>,<FT
HR>"<cr><lf>
;
<AID> Access identifier. Valid format is FAC-<SLOT ID>-<PORT
ID>.
<MONTYPE> Performance ID.
<OCRDAT> The date of the beginning of the requested PM period
specified in <TMPER>.The format of <OCRDAT> is YYYY-
MM-DD,
<OCRTM> The beginning time of day of the requested PM period
<INTERVAL> Alarm sample interval.
<VALUE> The statistic value in an interval.
<FTHR> Falling threshold.
Example LoopStar 800 2004-05-24 17:07:43
A 1 REPT RMON FALLING
"FAC-1-1:ETHJAB,2004-03-24,16-05-34,10,0,1"
;
Notes <ALMCODE> is A.
Before next rising event be reported, no falling event could be reported. Namely,
the continuous falling events cannot be reported.
LPS800-UM-COMM-02 2-219
REPT RMON RISING
Command REPT RMON RISING

Explanation Report RMON rising (event).
Function This autonomous message reports the rising event of RMON.
Category RMON
Security Retrieve
Related Messages
<ALMCODE>^^<ATAG>^REPT^RMON^RISING<cr><lf>
^^^"<AID>:<MONTYPE>,<OCRDAT>,<OCRTM>,<INTERVAL>,<VALUE>,<RT
HR>"<cr><lf>
;
<AID> Access identifier. Valid format is FAC-<SLOT ID>-<PORT
ID>.
<MONTYPE> Performance ID.
<OCRDAT> The date of the beginning of the requested PM period
specified in <tmper>.The format of <OCRDAT> is YYYY-
MM-DD.
<OCRTM> The beginning time of day of the requested PM period
<INTERVAL> Alarm sample interval.
<VALUE> The statistic value in an interval.
<RTHR> Rising threshold.
A 1 REPT RMON RISING
"FAC-1-1:ETHDROP,2004-03-24,16-05-34,10,10,9"
;
Notes <ALMCODE> is A.
Before next falling event be reported, no rising event could be reported. Namely,
the continuous rising events cannot be reported.
2-220 LPS800-UM-COMM-02
REPT RSLT <T1/T3>
Command REPT RSLT <T1/T3>

Explanation Report result (T1/T3).
Function This autonomous message reports the bit sequence test result.
Category Test
DISC-TST-<T1/T3>
RTRV-RSLT-<T1/T3>
<ALMCODE>^^<ATAG>^REPT^TSTRSLT<cr><lf>
^^^<AID>:IPFLAG=<IPFLAG>,ET=<ET>,ESAIS=<ESAIS>[-
<OC>],ESLSS=<ESLSS>[-<OC>], ESBE=<ESBE>[-<OC>], TBE=<TBE>[-
<OC>];<cr><lf>
;
<AID> Access identifier.
<IPFLAG> Flag identifies whether the test is in process or completed.
Valid value is IP (in progress) and COMPLD (completed).
<ET> Elapsed time of testing. The unit is minute.
<ESAIS> Errored seconds count based on AIS detected. If the count
reaches the maximum, a literal "OC" is added following it.
<ESLSS> Errored seconds count based on LSS (Loss of sequence
synchronization) detected. If the count reaches the
maximum, a literal "OC" is added following it.
<ESBE> Errored seconds count based on bit error detected. If the
count reaches the maximum, a literal "OC" is added
following it.
<TBE> Total bit error count (32 bit counter). If the count reaches the
Notes 1. All maximum values of these counters are 2E23 - 1 = 4,294,967,295
2. The priority from high to low of these events are AIS, LSS.
LPS800-UM-COMM-02 2-221
REPT SW
Command REPT SW
Explanation Report switch.
Function This autonomous message reports the event of XCS protection switch.
Category Equipment
Related Messages
^^^<rsphdr><cr><lf>
**<ctag>^REPT^SW<cr><lf>
^^^"<ACT_SLOT>,<STANDBY_SLOT>"<cr><lf>
;
<ACT_SLOT> Active working unit after switch. Valid values are:
1 or 2 (LoopStar 800);
9 or 10 (LoopStar 1600).
<STANDBY_SLOT> Standby protection unit after switch. Valid values are:
1 or 2 (LoopStar 800);
9 or 10 (LoopStar 1600).
Errors
* 3 REPT SW
"9,10"
;
Notes
RLS-EXT-CONT
Command RLS-EXT-CONT
Explanation Release external control.
Function Instructs an NE to close an external control. The control can be operated
momentarily or continuously.
2-222 LPS800-UM-COMM-02

Related Messages OPR-EXT-CONT
RTRV-EXT-CONT
Input Format RLS- EXT-CONT:[<TID>]:<AID>:<CTAG>:[< CONTTYPE >][,<DUR>];
<AID> The AID of external control. See "CONT" in section
"Houskeeping" of Chapter 3: TL1 Parameters.
<CONTTYPE> <CONTTYPE> is the type of control. A null value for
<CONTTYPE> requests the operation of all controls
identified by the <AID> parameter.
<DUR> Specifies the duration of the external control operation
(for example, the duration of the relay activation). Valid
value is CONTS (continuously) or MNTRY
(momentarily, 5 seconds here). A NULL value means
MNTRY.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

PARAMETER ERROR
LPS800-UM-COMM-02 2-223
Example Input RLS-EXT-CONT::CONT-7:C::CONT-AIRCOND;

Normal LoopStar 800 2004-03-15 18:55:23
M C COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M C DENY
IPNC
/*PARAMETER NOT CONSISTENT, PARAMETER ERROR*/
;
Notes This command is not available with the LoopStar 810.
RLS-LPBK-<FETH>
Command RLS-LPBK-<FETH>
Explanation Release loopback (Fast Ethernet).
Function This command instructs NE to release a loopback on a specified Fast Ethernet
port.
Category Loopback
Related Messages OPR-LPBK-<FETH>
RTRV-LPBK-<FETH>
Input Format RLS-LPBK-<FETH>:[<TID>]:<AID>:<CTAG>;
and "&&".
2-224 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input RLS-LPBK-FETH::FAC-5-2:100;
Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IIAC
;
Notes
Command RLS-LPBK-<FETH/GETH>
Explanation Release loopback (Fast Ethernet/Gigabit Ethernet).
Function This command instructs NE to release a loopback on a specified Ethernet port.
Category Loopback
Related Messages OPR-LPBK-<FETH/GETH>
Input Format RLS-LPBK-<FETH/GETH>:[<TID>]:<AID>:<CTAG>;
LPS800-UM-COMM-02 2-225

and "&&".
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input RLS-LPBK-FETH::FAC-5-2:100;
Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IIAC
;
Notes
2-226 LPS800-UM-COMM-02
RLS-LPBK-<OCN/T1/T3/STS_PATH>
Command RLS-LPBK-<OCN/T1/T3/STS_PATH>
Explanation Release loopback (OC-N, T1, T3, STS path).
Function This command instructs NE to release a loopback on a specified port (OC-N,
DS1, DS3 or STS-N).
Category Loopback
Related Messages
Input Format RLS-LPBK-<OCN/T1/T3/STS_PAH>:[<TID>]:<AID>:<CTAG>;
<OCN> The modifier that identifies the type of optical carrier (OC) level.
Valid values are OC3, OC12, OC48 or OC192.
<STS_PATH> The modifier that identifies the type of STS path. Valid values
are STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C or STS192C.
<AID> Access identifier identifies the port. For OC-N AID, see section
"OCN" in Chapter 3: TL1 Parameters. For STS-N AID, see
section "STS-N" in Chapter 3: TL1 Parameters. For DSn AID,
see section "T1/T3" in Chapter 3: TL1 Parameters.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-227
Example Input RLS-LPBK-OC48::FAC-6-1:C;

Normal LoopStar 800 2004-03-15 18:55:23
M C COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M C DENY
SNVS
/*NOT IN VALID STATE, Parameter Entered STAM module Is Invalid*/
;
Notes
RLS-PROTNSW-<OCN>
Command RLS-PROTNSW-<OCN>
Explanation Release protection switch (OC3, OC12, OC48, OC192).
Function This command instructs a SONET NE to release (clear) a SONET OC-N line protection
switch request between a working line and a protection line that was established.
For 1+1 OPT mode, if lock protection group and forced switch coexists, then using this
command can release lock protection group for the first time, and forced switch can be
released if using this command again.
Category BLSR/SONET line protection.
Related Messages OPR-PROTNSW-<OCN>
Input Format RLS-PROTNSW-<OCN>:[<TID>]:<AID>:<CTAG>;
<AID> Access identifies of OC-N which is in the SONET line
protection/BLSR group.
2-228 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input RLS-PROTNSW-OC3::FAC-2-1:123;
Normal LoopStar 800 2004-03-09 18:08:44
M 100 COMPLD
;
Error LoopStar 800 2004-03-09 18:08:44
M 100 DENY
IPNV
;
Notes This command is not available in the LoopStar 800 and LoopStar 810.
RLS-PROTNSW-<STS_PATH>
Command RLS-PROTNSW-<STS_PATH>
Explanation Release protection switch type (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C).
Function This command instructs NE to release a SONET path protection switch request that
was established with the external command.
Category UPSR
Related Messages OPR-PROTNSW-<STS_PATH>
LPS800-UM-COMM-02 2-229
Input Format RLS-PROTNSW-<STS_PATH>:[<TID>]:<AID>:<CTAG>;

<STS_PATH> The modifier that identifies the type of STS and VT path. Valid
values are STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, or STS192C.
<AID> Access identifier. It must be working path or protecting path,
see the "STS-N" section in Chapter 3: TL1 Parameters.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr> <cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input RLS-PROTNSW-STS1::STS-2-1-1:C;
Normal LoopStar 800 2004-03-09 18:08:44
M 123 COMPLD
;
Error LoopStar 800 2004-03-09 18:08:44
M 123 DENY
PLNA
;
Notes
2-230 LPS800-UM-COMM-02
RLS-PROTNSW-<STS_PATH/VT_PATH>
Command RLS-PROTNSW-<STS_PATH/VT_PATH>
Explanation Release protection switch type (STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1, VT2).
Function This command instructs NE to release a SONET path protection switch request that
was established with the external command.
Category UPSR
Related Messages OPR-PROTNSW-<STS_PAHT/VT_PATH>
Input Format RLS-PROTNSW-<STS_PATH/VT_PATH>:[<TID>]:<AID>:<CTAG>;
<STS_PATH/ The modifier that identifies the type of STS and VT path. Valid
VT_PATH> values are STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, STS192C, VT1.5 or VT2.
<AID> Access identifier. It must be working path or protecting path,
see "STS-N" and "VT1.5" sections in Chapter 3: TL1
Parameters.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr> <cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-231
Example Input RLS-PROTNSW-STS1::STS-2-1-1:C;

Normal LoopStar 800 2004-03-09 18:08:44
M 123 COMPLD
;
Error LoopStar 800 2004-03-09 18:08:44
M 123 DENY
PLNA
;
Notes
RLS-PROTNSW-EQPT
Command RLS-PROTNSW-EQPT
Explanation Release protection switch equipment.
Function This command instructs the NE to release an equipment unit protection switch.
Related Messages OPR-PROTNSW-EQPT
Input Format RLS-PROTNSW-EQPT:[<TID>]:<AID>:<CTAG>;
<AID> Equipment AID. Valid values are shown in the section "EQPT"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-232 LPS800-UM-COMM-02
Errors
Example Input RLS-PROTNSW-EQPT::SLOT-5:C;
Normal LoopStar 800 2004-03-09 18:08:44
M C COMPLD
;
Error LoopStar 800 2004-03-09 18:08:44
M C DENY
PLNA
;
Notes 1. This command is used for both DSn (TPS) protection and XCS.
2. For XCS, only FRCD switch need to release.
RLS-SYNCNSW
Command RLS-SYNCNSW
Explanation Release synchronization switch.
Function This command is used to release a pending manual switch or lockout operation that
has initialed by OPR-SYNCNSW command. The general switching hierarchy in GR-
253-CORE will be applied. Special description about this command is shown in the
Notes.
Related Messages OPR-SYNCNSW
Input Format RLS-SYNCNSW:[<TID>]:[<AID>]:<CTAG>::SYNCAID;
<AID> Access Identifier of synchronization reference list.
Valid values are:
• SYNCCLOCK (system clock reference list)
• SYNCOUT-1 (output clock reference list of BITS-1)
<SYNCAID> Timing reference facility AIDs. See section "SYNCAID" for
detail. The <SYNCAID> must be in the list that <AID> points out.
LPS800-UM-COMM-02 2-233

;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input RLS-SYNCNSW::SYNCCLOCK:C::FAC-1-1;
Normal LoopStar 800 2004-04-23 11:13:56
M C COMPLD
;
Error LoopStar 800 2004-03-02 14:30:00
M C DENY
;
Notes 1. If the reference source that <SYNCAID> means has been lockout, this
command will release the lockout state of this reference source, it means
that this reference source is included into the list.
2. If the reference source that <SYNCAID> means has been manual or
forced switch, or has not been operated by OPR-SYNCNSW command
(for example, has not been lockout or manual switch or forced switch),
this command will release the manual or forced switch, if it had initialed.
2-234 LPS800-UM-COMM-02
RMV-<OCN/T1/T3/STS_PATH>
Command RMV-<OCN/T1/T3/STS_PATH>
Explanation Remove (OC-N, T1, T3, STS path).
Function This command changes the service state of the specified port (optical or electrical
port) to out of service - Maintenance (OOS-MA, MT). After the remove command,
there is no alarm generated for the corresponding facility and existing alarms must
be cleared. Any conditions are reported NR and PM continues to be collected and
marked invalid. This command required before issuing the loop back command.
Category Facility
Related Messages
Input Format RMV-<OCN/T1/T3/STS_PATH>:[<TID>]:<AID>:<CTAG>
<STS_PATH> The modifier that identifies the type of STS path. Valid values
are STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C or STS192C.
<AID> Access identifier identifies the <OCN/T1/T3/STS_PATH>. For
OC-N AID, see section "OCN" in Chapter 3: TL1 Parameters.
For STS_PATH AID, see section "STS-N" in Chapter 3: TL1
Parameters. For DSn AID, see section "T1/T3" in Chapter 3:
TL1 Parameters.
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-235
Example Input RMV-OC3::FAC-2-1: C;

Normal LoopStar 800 2004-04-23 11:13:56
M C COMPLD
;
Error LoopStar 800 2004-03-02 14:30:00
M C DENY
IISP
/*RMV-OC3::FAC-2-1:C;*/
;
Notes
RST-<OCN/T1/T3/STS_PATH>
Command RST-<OCN/T1/T3/STS_PATH>
Explanation Reset (OC-N, T1, T3, STS path).
Function This command instructs an NE to restore facility to service. The entity is changed
from a maintenance state to the original state. Existing alarms must be reported.
Category Facility
Related Messages
Input Format RST-<OCN/T1/T3/STS_PATH>:[<TID>]:<AID>:<CTAG>
<STS_PATH> The modifier that identifies the type of STS path. Valid values are
STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C or
STS192C.
<AID> Access identifier identifies the <OCN/T1/T3/STS_PATH>. For OC-
N AID, see section "OCN" in Chapter 3: TL1 Parameters. For
STS_PATH AID, see section "STS-N" in Chapter 3: TL1
Parameters. For DSn AID, see section "T1/T3" in Chapter 3: TL1
Parameters.
2-236 LPS800-UM-COMM-02

;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input RST-OC3::FAC-2-1:C;
Normal LoopStar 800 2004-03-09 18:08:44
M C COMPLD
;
Error LoopStar 800 2004-03-09 18:08:44
M C DENY
PLNA
;
Notes
RTRV-RMONHISTCTRL-<MOD2>
Command RTRV-RMONHISTCTRL-<MOD2>
Explanation Retrieve RMON history control (FETH, GETH, ALL).
Function This command retrieves the parameters of history control table.
Category RMON
Security Retrieve
Related Messages ED-<OCN_TYPE>
Input Format RTRV-RMONHISTCTRL-<MOD2>:[<TID>]:[<AID>]:<CTAG>:: [<PRDTP>];
LPS800-UM-COMM-02 2-237

<MOD2> <MOD2> supports FETH, GETH and ALL. ALL means all the
FETH and GETH ports in a NE.
<AID> The valid format is FAC-<SLOT ID>-<PORT ID>. <AID> is
optional and default value is ALL, which means all ports in this
<MOD2> in the network element. If the <MOD2> is ALL, the
<AID> is null.
<PRDTP> Period type. Valid values are 30S, 30M, PRDVAR or PRDALL.
Default value is ALL.
^^^"<AID>,<AIDTYPE>:<PRDTP>,<RECNUM>,<PRD>,<ENFLAG>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> Access identifier. Valid format is FAC-<SLOT ID>-<PORT ID>.
<AIDTYPE> The type of access identifier <MOD2>.
<PRDTP> Period type. Valid values are 30S, 30M, PRDVAR or PRDALL.
<RECNUM> Records number. The max records are 50.
<PRD> Period. The unit is second.
<ENFLAG> Enable flag. Valid value is ENABLE or DISABLE.
Errors
2-238 LPS800-UM-COMM-02
Example Input RTRV-RMONHISTCTRL-FETH::FAC-1-2:100::;

Normal LoopStar 800 2004-03-13 14:14:36
M 100 COMPLD
"FAC-1-2,FETH:30S,50,30,ENABLE"
"FAC-1-2,FETH:30M,50,1800,ENABLE"
"FAC-1-2,FETH:PRDVAR,50,3600,DISABLE"
;
Error LoopStar 800 2004-03-13 14:14:36
M 100 DENY
IDRG
/*DATA RANGE ERROR,RMON_BID_ERROR*/
/*0X9CA0*/
;
Notes
RTRV-<OCN>
Command RTRV-<OCN>
Explanation Retrieve (OC3, OC12, OC48, OC192).
Function This command retrieves attributes of the OC-N facility.
Category Facility
Security Retrieve
Related Messages ED-<OCN>
Input Format RTRV-<OCN>:[<TID>]:<AID>:<CTAG>;
level. Valid values are OC3, OC12, OC48 or OC192.
<AID> OC-N access identifier. Valid values are shown in the
section "OCN".
LPS800-UM-COMM-02 2-239

Format
^^^<rsphdr><cr><lf>
^^^"<AID>::[SWITCHSTATE=<SWITCHSTATE>],BERSF=<BERSF>,BERSD=<B
ERSD>[,LSRSTAT=<LSRSTAT>],[WVLEN=<WVLEN>],[WVFREQ=<WVFREQ>],
[,TSSM=<TSSM>][,MANSSM=<MANSSM>][,SSMIN=<SSMIN>][,PRI=<PRI>],SV
TIMER=<SVTIMER>:<PST>[,<SST>]"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-240 LPS800-UM-COMM-02

<AID> OC-N access Identifier. Valid values are shown in the section
"OCN" of Chapter 3: TL1 Parameters.
<SWITCHSTATE> It is only valid when the port is in the SONET line protection
protection group or BLSR protection group. Valid values are
shown in the section "SWITCH STATE OF OPTICAL PORT"
<BERSF> Threshold of line (B2) BERSF on a facility. Valid value is in
the section "BER" of Chapter 3: TL1 Parameters.
<BERSD> Threshold of line(B2) BERSD on a facility. Valid value is in the
section "BER" of Chapter 3: TL1 Parameters.
<LSRSTAT> Laser status. Valid value is OPEN or CLOSE.
<WVLEN> The wave length of the laser. Valid values are shown in the
section "WAVELENGTH" of Chapter 3: TL1 Parameters.
<WVFREQ> The frequency of the laser. Valid values are shown in the
section "WAVE FREQUENCY" of Chapter 3: TL1
Parameters.
<TSSM> Enable transmit S1 byte. Valid value is Y (Enable) or N
(Disable). Default value is Y.
<MANSSM> Manually set the S1 byte of timing reference. NE will presses
incoming synchronous source. Valid values are STU, PRS,
ST2, TNC, ST3E, ST3, PNO, CLEAR or DUS. Default value is
CLEAR.
<SSMIN> Received really SSM. No matter whether the SSM protocol is
enabled or disabled, this attribute is the actually incoming
SSM.
<SVTIMER> Signal validation timer. Valid values are shown in section
"SVTIMER" of Chapter 3: TL1 Parameters.
<PRI> The priority of the edited port. It is valid only when the port is
in a SONET line protection group. Valid value is HIGH or
LOW. Default value is LOW, which means the lowest
switching privilege.
<PST> <PST> means the primary state of the entity. Valid values are
shown in the "PST_STATE" section of Charpter 3 TL1
Parameters.
<SST> <SST> means the secondary state of the entity. Valid values
are shown in the "SST_STATE" section of Charpter 3 TL1
Parameters.
Errors
LPS800-UM-COMM-02 2-241
Example Input RTRV-OC48::FAC-4-1:C;

Normal LoopStar 800 2004-03-13 14:14:36
M C COMPLD
"FAC-4-1::BERSF=1E-3,BERSD=1E-
6,LSRSTATE=OPEN,TSSM=N,MANSSM=CLEAR,SSMIN=DUS,SVTIMER=00-
01:IS-NR"
;
Error LoopStar 800 2004-03-13 14:14:36
M C DENY
PLNA
;
Notes 1. Valid values for PST is IS-NR, OOS-AU, OOS-MA or OOS-AUMA.
2. Valid values for SST is AINS, MT, LPBK, SGEO, FAF, ACT, STYC or
STYH.
RTRV-<STS_PATH>
Command RTRV-<STS_PATH>
Explanation Retrieve (STS1, STS3C, STS6C, STS9C STS12C, STS24C, STS48C, STS192C).
Function This command retrieves the attributes of the STS path with entered AID.
Category Facility
Security Retrieve
Related Messages ED-<STS_PATH>
Input Format RTRV-<STS_PATH>:[<TID>]:<AID>:<CTAG>;
STS3C, STS6C, STS9C, STS12C, STS24C, STS48C or
STS192C.
<AID> Identifier of STS path. Valid values are shown in the section
"STS-N" of Chapter 3: TL1 Parameters.
2-242 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf> M^^<ctag>COMPLD<cr><lf>
^^^"<AID>::[RVRTV=<RVRTV>][RVTM=<RVTM>][,SWPDIP=<SWPDIP>][,DELA
YTIME=<DELAYTIME>],BERSF=<BERSF>,BERSD=<BERSD>[,J1TRCMODE=<
J1TRCMODE>][,EXPTRCJ1=<EXPTRCJ1>][,TRCJ1=<TRCJ1>][,INCTRCJ1=<IN
CTRCJ1>][,EXPTRCC2=<EXPTRCC2>][,TRCC2=<TRCC2>][,INCTRCC2=<INCT
RCC2>][,SQL=<SQL>],[SWITCHSTATE=<SWITCHSTATE>]:<PST>[,<SST>]"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-243

<AID> Identifier of STS path. Valid values are shown in the section
"STS-N" of Chapter 3: TL1 Parameters.
<RVRTV> A revertive mode. It only applies to UPSR. Valid values are
shown in the section "REVERTIVE MODE" of Chapter 3: TL1
Parameters.
"REVERTIVE TIME" of Chapter 3: TL1 Parameters.
<SWPDIP> Optional switching condition. Valid value is Y (switch when
existing PDI-P) or N (do not switch when existing PDI-P).
Default value is N.
<DELAYTIME> Delay time. It is an integer. Valid value ranges from 0 to 255 in
100 ms increments.
<BERSF> Threshold of path (B3) SFBER on a facility. Valid values are
shown in the section "BER" of Chapter 3: TL1 Parameters.
<BERSD> Threshold of path (B3) SDBER on a facility. Valid values are
shown in the section "BER" of Chapter 3: TL1 Parameters.
<J1TRCMODE> Path trace mode. Valid values are shown in the section "J1
MODE" of Chapter 3: TL1 Parameters.
<EXPTRCJ1> The expected path traces message (J1) contents.
<TRCJ1> The path trace message contents (J1) to be transmitted.
<INCTRCJ1> The path trace message received.
<EXPTRCC2> The expected C2 byte hex code. Valid values are shown in
table C2.
<TRCC2> The C2 byte hex code to be transmitted. Valid values are
shown in section "C2" of Chapter 3: TL1 Parameters.
<INCTRCC2> The C2 byte hex code received. Valid values are shown in
section "C2" of Chapter 3: TL1 Parameters.
<SQL> The flag of squelch. This parameter only supplies for BLSR.
Valid value is Y or N.
<SWITCHSTATE> It is only valid when the port is in the UPSR protection group.
Valid values are shown in the section "SWITCH STATE OF
STS PATH OR VT PATH" of Chapter 3: TL1 Parameters.
shown in the "PST_STATE" section of Chapter 3: TL1
Parameters.
are shown in the "SST_STATE" section of Chapter 3: TL1
Parameters.
Errors
2-244 LPS800-UM-COMM-02
Example Input RTRV-STS1::STS-1-1-1:C;

Normal LoopStar 800 2004-03-13 14:14:36
M C COMPLD
"STS-1-1-1::BERSF=1E-4,BERSD=1E-
6,J1TRCMODE=OFF,EXPTRCJ1=HUAWEI,TRCJ1=HUAWEI,INCTRCJ1=HUAW
EI,EXPTRCC2=LOAD,TRCC2=LOAD,INCTRCC2=UNLOAD:IS-NR"
;
Error LoopStar 800 2004-03-13 14:14:36
M C DENY
PLNA
;
Notes 1. Valid values for PST is IS-NR, OOS-AU, OOS-MA or OOS-AUMA
2. Valid values for SST is MT, LPBK, SGEO or FAF.
3. This command is available only if cross-connect and service have been
created.
RTRV-<VT_PATH>
Command RTRV-<VT_PATH>
Explanation Retrieve (VT1.5, VT2).
Function This command retrieves the attributes of VT path with entered AID.
Category Facility
Security Retrieve
Related Messages
Input Format RTRV-<VT_PATH>:[<TID>]:<AID>:<CTAG>;
<VT> The modifier that identifies the type of VT path. Valid value is
VT1.5 or VT2.
<AID> Access identifier of VT path retrieved. Valid values are shown
in the section "VT1.5" of Chapter 3: TL1 Parameters.
LPS800-UM-COMM-02 2-245

Format
^^^<rsphdr><cr><lf>
^^^"<AID>::[RVTRV=<RVRTV>,][RVTM=<RVTM>,][DELAYTIME=<DELAYTIME>,][
RV5=<RV5>,][BERSDV=<BERSDV>,][BERSFV=<BERSFV>],[SWITCHSTATE=<S
WITCHSTATE>]:<PST>[,<SST>]"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> Identifier of VT path retrieved.
<RVRTV> A revertive mode. This parameter only applies to UPSR. Valid
values are shown in the section "REVERTIVE MODE" of
Chapter 3: TL1 Parameters.
<RVTM> Revertive time. Valid values are in the section "REVERTIVE
TIME" of Chapter 3: TL1 Parameters.
<DELAYTIME> Delay time. It is an integer. Valid value ranges from 0 to 255 in
100 ms increments.
<RV5> Incoming V5 byte.
<BERSDV> BIP2 SD threshold value.
<BERSFV> BIP2 SF threshold value.
<SWITCHSTATE> It is only valid when the port is in the UPSR protection group.
Valid values are shown in the section "SWITCH STATE OF
STS PATH OR VT PATH" of Chapter 3: TL1 Parameters.
Parameters.
Parameters.
Errors
2-246 LPS800-UM-COMM-02
Example Input RTRV-VT1::VT1-1-1-1-1-1:C;

Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"VT1-1-3-1-1-
1::RVRTV=Y,RVTM=1.0,DELAYTIME=100,SRV5=UNEQ,RV5=UNEQ,BIP2SFBER
=1E-5,BIP2SDBER=1E-3:IS-NR";
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
;
Notes 1. Valid values for PST is IS-NR, OOS-AU, OOS-MA or OOS-AUMA
2. Valid values for SST is MT, LPBK, SGEO or FAF.
RTRV-ALM-<MOD2>
Command RTRV-ALM-<MOD2>
Explanation Retrieve alarm.
Function This command retrieves alarm of facility or path. It instructs an NE to retrieve and
send the current status of its alarm conditions associated with one or more
facilities, paths, or equipment.
The command may be used to retrieve NE information, which in turn may be
used to update an OS database when it is suspected that autonomous alarm
messages issued by the NE using REPORT ALARM were not received or
properly processed. It may also be used to evaluate the system before or after
NE maintenance.
The alarm conditions to be retrieved can be specified by using the input
parameters as the filter, i.e., existing conditions satisfying all the specified input
parameters will be reported in the message response.
Environmental alarms are not expected in responses to RTRV-ALM-ALL. The
separate command RTRV-ALM-ENV is used.
Category Alarms and conditions
Security Retrieve
LPS800-UM-COMM-02 2-247

REPT EVT <MOD2>
RTRV-COND-<MOD2>
REPT ALM ENV
RTRV-ALM-ENV
Input Format RTRV-ALM-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDTYPE>],[<SRVEFF>],[<LOCN>],[<DIRN>];
<MOD2> The second modifier of the retrieve command which identifies
the type of the entity that is retrieved. Valid values are ALL,
OC3, OC12, OC48, OC192, EC1, FETH, GETH, VCG, T1, T3,
STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,
STS192C, VT1, EQPT, DS1, DS3, SYNC, SYNCALL,
SYNCFAC or BITS.
<AID> The AID of the entity that is retrieved. Refer to Charpter 3 for
its possible values. If <MOD2> is ALL, it must be NULL.
<NTFCNCDE> The notification code of the retrieved alarm. Valid values are
CR (critical alarm), MJ (major alarm) or MN (minor alarm). If it'
is null, alarms of every notification code will be retrieved.
<CONDTYPE> The alarm condition types. If it is null, alarms of every type will
be retrieved.
<SRVEFF> The effect on service caused by the alarm condition. A null
value is equivalent to ALL.
reported and refers to the entity identified by the <AID>. Thus,
identified entity, and FEND (far end) refers to alarm conditions
occurring at a distant entity that is connected to the identified
entity. Likewise, LINE [-x] refers to an intermediate point. A
null value is equivalent to NEND.
<DIRN> The direction of the alarm condition and is relative to the entity
identified by the <AID>. A null value is equivalent to ALL. Valid
value is TRMT (transmit direction only) or RCV (receive
direction only).
2-248 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^"[<AID>][,<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRD
AT>],[<OCRTM>],[<LOCN>],[<DIRN>],,,:[<CONDDESCR>]"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
(^^^/*error text*/<cr><lf>) * ;
<AID> Refer to the input <AID>.
<AIDTYPE> The type of access identifier.
CR (critical alarm), MJ (major alarm) or MN (minor alarm).
<CONDTYPE> Alarm condition type.
<OCRDAT> The date when the triggering event occurred.
<OCRTM> The time of day when the triggering event occurred.
reported and refers to the entity identified by the AID.
identified by the AID. Valid value is TRMT (transmit direction
only) or RCV (receive direction only).
<CONDDESC> <CONDDESC> is the text message associated with the alarm
condition. It is comprised of a maximum of 63 characters.
<AIDDET> <AIDDET> is the supplementary equipment identification used
to identify the location of the reported trouble. This is used in
conjunction with the AID.
<SN> The number of alarm message. Only for Huawei EMS.
PARAMETER ERROR
LPS800-UM-COMM-02 2-249
Example Input RTRV-ALM-EQPT::SLOT-3:1::CR,BDSTATUS,SA,NEND,RCV;

Normal LoopStar 800 2004-03-08 14:30:00
M 1 COMPLD
"SLOT-3,EQPT:CR,BDSTATUS,SA,2004-11-09,05-36-
39,NEND,RCV,,,:\"Card removed\","
;
Error LoopStar 800 2004-03-08 14:30:00
M 1 DENY
IISP
/*Format:RTRV-ALM-
<MOD2>:[<tid>]:[<aid>]:<ctag>::[<ntfcncde>],[<condtype>],[<srveff>],[<locn>],[<
dirn>];
<MOD2>
:ALL,OC3,OC12,OC48,OC192,EC1,FETH,GETH,VCG,T1,T3,STS1,STS3C,ST
S6C,STS9C,STS12C,STS24C,STS48C,STS192C,VT1,EQPT,DS1,DS3,SYNC,
SYNCALL,SYNCFAC,BITS;
<ntfcncde>: CR,MJ,MN;
<srveff> : SA,NSA;
<locn> : NEND,FEND;
<dirn> : TRMT,RCV;
SAMPLE:
RTRV-ALM-OC48::FAC-2-1:1::CR,LOS,SA,NEND,RCV;
*/
;
Notes
RTRV-ALM-ENV
Command RTRV-ALM-ENV
Explanation Retrieve alarm environment.
Function This command requests that an NE retrieve specified environmental alarms. The
command can be used to retrieve NE information, which in turn may be used to
update an OS environmental alarm database.
Category Alarm and Conditions
Security Retrieve
Related Messages REPT ALM ENV
2-250 LPS800-UM-COMM-02
Input Format RTRV-ALM-ENV:[<TID>]:[<ENVAID>]:<CTAG>::[<NTFCNCDE>],

[<ALMTYPE>];
<ENVAID> AID of the input switch for environment monitoring. A null value
is equivalent to ALL.
CR (critical alarm), MJ (major alarm) or MN (minor alarm). A
null value is equivalent to ALL.
<ALMTYPE> <ALMTYPE> is the alarm type for the environmental alarm. A
null value is equivalent to ALL.
Format
M^^<CTAG>^COMPLD<cr><lf>
^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>][,<ALMMSG
>]"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<NTFCNCDE> Refer to the Input parameter.
the various ENV commands listed in Chapter 3 FAULT.
<OCRDAT> The date when the environmental alarm occurred.
<OCRTM> The time of day when the environmental alarm occurred.
characters.
PARAMETER ERROR
LPS800-UM-COMM-02 2-251
Example Input RTRV-ALM-ENV:::C;

Normal LoopStar 800 2004-08-27 14:52:19
M C COMPLD
"ENV-1:MJ,ENV-AIRCOND,2004-07-02,16-40-47,\"\""
"ENV-5:MJ,ENV-AIRCOND,2004-07-02,16-43-17,\"\""
;
Error LoopStar 800 2004-08-27 14:52:19
M C DENY
IDRG
/*DATA RANGE ERROR, */
;
Notes
RTRV-AO
Command RTRV-AO
Explanation Retrieve automatic output.
Function This command allows the OS to retrieve a copy of a queued autonomous
message or a missing autonomous message. The message can be retrieved
includes REPT DBCHG, REPT EVT, REPT ALM.
Category LOG
Security Retrieve
Related Messages REPT DGCHG, REPT EVT, REPT ALM
Input Format RTRV-AO:[<TID>]::<CTAG>:::[ATAGSEQ=<ATAGSEQ>],
[MSGTYPE=<MSGTYPE>],[DBCHGSEQ=<DBCHGSEQ>];
<ATAGSEQ> Integral part of the ATAG of the autonomous message to be
retrieved. Valid values are integers. This parameter may be
used together with <MSGTYPE>. The keyword shall not be
used if the <DBCHGSEQ> keyword is used. A null value is all.
<MSGTYPE> Type of autonomous message to be retrieved. Valid values are
modifiers of any valid TL1 autonomous messages. Valid values
are DBCHG, ALM, and EVT for "REPT DBCHG", "REPT ALM",
and "REPT EVT" respectively. A null value is all. The keyword
shall not be used if the <DBCHGSEQ> keyword is used.
<DBCHGSEQ> Sequence number of REPT DBCHG message. Valid values
are integers between 0 and 9999. This keyword shall not be
used if <ATAGSEQ> and/or <MSGTYPE> are used. If
<MSGTYPE>is DBCHG, then this parameter must be null.
2-252 LPS800-UM-COMM-02

Format
M^^<ctag>^COMPLD [<cr><lf>
/* <cr><lf>
(<autonomous message including the message header, but without the
termination indicator, i.e., ";"><cr><lf>)*
*/]<cr><lf>
;
Error <cr><lf><lf>
M^^<ctag>^DENY <cr><lf>
^^^<errcde> <cr><lf>
^^^/*error text*/ <cr><lf>
;
<NTFCNCDE> Refer to the Input parameter.
the various ENV commands listed in Chapter 3 FAULT.
<OCRDAT> The date when the environmental alarm occurred.
<OCRTM> The time of day when the environmental alarm occurred.
characters.
Errors
LPS800-UM-COMM-02 2-253
Example Input RTRV-AO:::100:::MSGTYPE=DBCHG;

Normal LoopStar 800 2004-08-27 14:52:19
M 100 COMPLD
/*
SONET-NE 2004-07-08 15:08:39

A 10 REPT DBCHG
"DATE=2004-07-08,TIME=15-11-
29,SOURCE=100,USERID=SONET,DBCHGSEQ=2:ED-USER-
SECU:TESTUSER1:,,,:TMOUTEN=ENABLE,TMOUTLN=30"
*/
;
Error LoopStar 800 2004-08-27 14:52:19
M 100 DENY
IPEX
/*PARAMETER EXTRA*/
/*RTRV-
AO:[<TID>]::<CTAG>:::[ATAGSEQ=<atagseq>],[MSGTYPE=<msgtype>],[DBC
HGSEQ=<dbchgseq>];
RTRV-AO:::100:::DBCHGSEQ=123;*/
;
Notes If the NE resets, all the automatic messages will be lost.
Maximum 10000 AO messages can be stored in AO buffer. The length of each
message is variable.
If all three parameters <ATAGSEQ>, <MSGTYPE>, and <DBCHGSEQ> are
null, then none of the stored autonomous messages will be retrieved. However,
a complete normal response shall still be sent.
RTRV-ATTR-<MOD2>
Command RTRV-ATTR-<MOD2>
Explanation Retrieve attribute (OC3, OC12, OC48, OC192, EC1, FETH, GETH, VCG, T1, T3,
STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C, VT1,
EQPT, DS1, DS3, SYNC, SYNCALL, SYNCFAC, BITS).
Function This command instructs an NE to send the current notification code associated
with the specified events. This attribute governs whether the event is reported
automatically by the NE on each occurrence of the event.
Category Alarm and conditions
2-254 LPS800-UM-COMM-02
Security Retrieve
Related Messages SET-ATTR-<MOD2>
Input Format RTRV-ATTR-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDTYPE>],[<LOCN>],[<DIRN>],,[<SRVEFF>];
<MOD2> The second modifier of the retrieve command which
identifies the type of the entity that is retrieved. Valid
value can be: OC3, OC12, OC48, OC192, EC1, FETH,
GETH, VCG, T1, T3, STS1, STS3C, STS6C, STS9C,
STS12C, STS24C, STS48C, STS192C, VT1, EQPT,
DS1, DS3, SYNC, SYNCALL, SYNCFAC, or BITS.
<NTFCNCDE> Notification code specifies the type of notification to be
generated by an NE on the occurrence of the event
described in <CONDTYPE>. A null value is ALL
<CONDTYPE> Identifies the type of event for which a notification
attribute <NTFCNCDE> is being changed. A null value
is ALL.
Thus, NEND (near end) refers to alarm conditions
occurring at the identified entity, and FEND (far end)
refers to alarm conditions occurring at a distant entity
that is connected to the identified entity. Likewise, LINE
[-x] refers to an intermediate point. A null value is
equivalent to NEND.
<DIRN> The direction of the alarm condition and is relative to the
entity identified by the <AID>. A null value is equivalent
to ALL. Valid value is TRMT (transmit direction only) or
RCV (receive direction only).
<SRVEFF> The effect on service caused by the standing or alarm
condition. A null value is ALL.
LPS800-UM-COMM-02 2-255

Format
^^^<rsphdr><cr><lf>
<rspblk> +
;

^^^"<aid>[,<aidtype>]:[<ntfcncde>],<condtype>,
[<locn>],[<dirn>],[,< srveff>]"<cr><lf>
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
generated by an NE on the occurrence of the event
described in <CONDTYPE>.
<CONDTYPE> Identifies the type of event for which a notification
attribute <NTFCNCDE> is being changed.
Thus, NEND (near end) refers to alarm conditions
occurring at the identified entity, and FEND (far end)
refers to alarm conditions occurring at a distant entity
that is connected to the identified entity. Likewise, LINE
[-x] refers to an intermediate point. A null value is
equivalent to NEND.
entity identified by the <AID>. Valid value is TRMT
(transmit direction only) or RCV (receive direction only).
condition.
2-256 LPS800-UM-COMM-02

PARAMETER ERROR
Example Input RTRV-ATTR-EQPT::SLOT-3:C::MJ,BDSTATUS,NEND,RCV,,SA;
Normal LoopStar 800 2004-06-20 14:30:00
M C COMPLD
"SLOT-3:MJ,BDSTATUS,NEND,RCV,,SA"
;
Error LoopStar 800 2004-06-20 14:30:00
M C DENY
IDRG
/*DATA RANGE ERROR, CONDITION TYPE PARAMETER ERROR*/
;
Notes
RTRV-ATTR-CONT
Command RTRV-ATTR-CONT
Explanation Retrieve attribute control.
Function This command retrieves the attributes associated with an external control. These
attributes are used when an external control is operated or released.
Category Alarm and Conditions
Security Retrieve
Related Messages SET-ATTR-CONT
Input Format RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>];
<AID> Access identifier identifies the external control for which
attributes are being retrieved. The <AID> must not be null.
See section "Housekeeping" for the values of <AID>.
<CONTTYPE> The type of external control. A null value is equivalent to ALL.
LPS800-UM-COMM-02 2-257

Format
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>:[<CONTTYPE>]"<cr><lf>
;
Error <cr><lf><lf>
M^^<CTAG>^DENY <cr><lf>
;
<AID> Access identifier identifies the external control for which
attributes are being retrieved.
<CONTTYPE> The type of control assigned to the external control identified
by <AID>. Valid values are shown in section "Fault". A null
value for <CONTTYPE> means no control type is assigned to
the external control identified by the <AID> parameter.
PARAMETER ERROR
Example Input RTRV-ATTR-CONT::CONT-1:100;
Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
"CONT-1:AIRCOND"
;
Error LoopStar 800 2004-06-20 14:30:00
M 100 DENY
IPNC
/*PARAMETER NOT CONSISTENT,PARAMETER ERROR*/
/*0X950E*/
;
2-258 LPS800-UM-COMM-02
Notes 1. This command is not available in the LoopStar 810.

2. If a null value for <CONTTYPE> will response like:
SONET-NE 2004-01-01 12:23:20
M 100 COMPLD
"CONT-1:"
;
RTRV-ATTR-ENV
Command RTRV-ATTR-ENV
Explanation Retrieve attribute environment.
Function This command retrieves the attributes associated with an environmental alarm.
These attributes are included when an environmental alarm is reported or
retrieved.
Category Alarm and Condition
Security Retrieve
Related Messages SET-ATTR-ENV
Input Format RTRV-ATTR-ENV: [<TID>]:<ENVAID>:<CTAG>::[<NTFCNCDE>]
[,<CONDTYPE>];
<ENVAID> Access identifier. Must not be null. See section
"Housekeeping" for the values of <ENVAID>.
generated by an NE on the occurrence of the event described
in <CONDTYPE>. A null value is equivalent to ALL.
<CONDTYPE> The condition type for the environmental alarm. A null value is
equivalent to ALL.
LPS800-UM-COMM-02 2-259

Format
^^^<rsphdr><cr><lf>
^^^"<AID>:[<NTFCNCDE>],[<CONTTYPE>],\"<ALMMSG>\""<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
in <CONDTYPE>.
<CONDTYPE> The condition type for the environmental alarm.
environmental alarm specified by the <AID> parameter. The
content of <ALMMSG> should be contained in a text string of
no more than 63 characters enclosed within double quotation
marks. A null value in this parameter means there is no
message text for the environmental alarm.
Errors
Example Input RTRV-ATTR-ENV::ENV-1:C;
Normal LoopStar 800 2004-07-15 14:56:12
M C COMPLD
"ENV-1:CR,ENV-AIRCOND,\"sdfsfsd\""
;
Error LoopStar 800 2004-07-15 14:57:18
M C DENY
IIAC
/*INVALID ACCESS IDENTIFIER (AID),INVALID PARAMETER:ENV-333*/
/*RTRV-ATTR-ENV::ENV-1:100;*/
;
Notes
2-260 LPS800-UM-COMM-02
RTRV-BACKUP-INFO
Command RTRV-BACKUP-INFO
Explanation Retrieve backup information.
Function This command instructs NE to retrieve the state of synchronization.
Category SONET XCS protection switch
Related Messages
Input Format RTRV-BACKUP-INFO:[<TID>]::<CTAG>;
<ENVAID> Access identifier. Must not be null. See section
"Housekeeping" for the values of <ENVAID>.
in <CONDTYPE>. A null value is equivalent to ALL.
<CONDTYPE> The condition type for the environmental alarm. A null value is
equivalent to ALL.
^^^"BACKUPINFO=<BACKUP_INFO>"<cr><lf>
;
Error <<cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-261

<BACKUP_INFO> The valid values are:
• SYNCIDLE (means that there are no messages between
two units, such as only one unit is online, or the
communication between them failed),
• SHAKEHAND (means that the two units have finished
shaking hands, but have not synchronized),
• SYNCING (database file synchronization failed, or
database file recovered failed, or the standby XCS unit is
not ready in synchronization),
• COMPLETED (synchronization successful, only in this
state, XCS switch is safe),
• SMOOTHDATA (smoothing data for integrity and
harmony).
Errors
Example Input RTRV-BACKUP-INFO:::C;
Normal LoopStar 800 2004-07-15 14:56:12
M C COMPLD
"BACKUPINFO=SYNCOVER"
;
Error
Notes
RTRV-BITS
Command RTRV-BITS
Explanation Retrieve building integrated timing supply (BITS)
Function This command is used to retrieve the attributes of external clock of NE.
There are two external clock interface for each NE, they are BITS-1 and
BITS-2. And for each BITS interface, there are two types of attributes for
BITS-IN and BITS-OUT individual.
This command can be used to retrieve each type of attributes of each
external clock interface by special <AID>s. See the Parameters description
for details.
Security Retrieve
Related Messages ED-BITS
Input Format RTRV-BITS:[<TID>]:[<AID>]:<CTAG>;
2-262 LPS800-UM-COMM-02

<AID> Access identifier of BITS facility. Valid values are:
• BITSIN-1 (input interface of BITS-1),
• BITSIN-2 (input interface of BITS-2),
• BITSOUT-1 (output interface of BITS-1),
• BITSOUT-2 (output interface of BITS-2),
• NULL value for all BITS-IN & BITS-OUT interfaces.
See "BITS" section for details.
Format
^^^<rsphdr><cr><lf>
^^^"<AID#BITSIN-1/BITSIN-
2>::LINECDE=<LINECDE>,FMT=<FMT>,SVTIMER=<SVTIMER>,[MANSS
M=<MANSSM>,][SSMIN=<SSMIN>,]:[<PST>[,<SST>]"
^^^"<AID#BITSOUT-1/BITSOUT-
2>::[LBO=<LBO>,]LINECDE=<LINECDE>,FMT=<FMT>,[MSGMODE=<MS
GMODE>,][AISTH=<AISTH>,]SVTIMER=<SVTIMER>,[TSSM=<TSSM>,]:[
<PST>[,<SST>]"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-263

<AID> Access identifier of BITS facility.
<LBO> Line build out. Valid values are shown in the section
"LINE BUILD OUT". The meaning is same as DS1's.
Default value is 1. This parameter is only for BITS-OUT
interface.
<LINECDE> Line code. Valid value is B8ZS or AMI. Default value is
B8ZS. This parameter means input line code for BITS-
IN interface or output line code for BITS-OUT interface
specially.
<FMT> Frame format. Valid value is ESF or SF. Default value is
ESF. This parameter means input frame format for
BITS-IN interface or output frame format for BITS-OUT
interface specially.
<AISTH> The quality threshold of incoming SSM. If the incoming
SSM is lower than AISTH, NE will insert AIS into the
outgoing signal of this BITS clock. Valid values are STU,
PRS, ST2, TNC, ST3E, ST3, PNO or DUS. Default
value is DUS. This parameter is only for BITS-OUT
interface. This attribute is visible only if the
<MSGMODE> is AIS. PNO mean the RES quality class
that the user provisioned. See section "RES" for detail.
<MANSSM> Manually set the S1 byte of timing reference. NE will
presses the timing switch base on this parameter as the
quality of the BITS-IN synchronous source. Valid values
are STU, PRS, ST2, TNC, ST3E, ST3, PNO, CLEAR or
DUS. Default value is CLEAR. This parameter is only for
BITS-IN interface. PNO mean the RES quality class that
the user provisioned. See section "RES" for detail.
<SSMIN> Received really SSM. No matter whether the SSM
protocol is enabled or disabled, this attribute is the
actually incoming SSM. This parameter is only for BITS-
IN interface.
<TSSM> Enable transmit S1 byte. Valid value is Y (Enable) or N
(Disable). Default value is Y. This parameter is only for
BITS-OUT interface.
<MSGMODE> Pass-through mode or AIS mode. Valid value is
PASSTHRU (use pass-rhrough mode), or AIS (use AIS
mode). Default value is PASSTHRU. This parameter is
only for BITS-OUT interface.
<SVTIMER> Signal validation timer in minutes. Only valid if auto in-
service feature is supported. <SVTIMER> is a string,
and format is HH-MM. Valid value ranges from 00-01 to
48-00. Default value is 00-01.
<PST> <PST> means the primary state of the entity. Valid
values are shown in the "PST_STATE" section.
<SST> <SST> means the secondary state of the entity. Valid
values are shown in the "SST_STATE" section.
Errors
2-264 LPS800-UM-COMM-02
Example Input RTRV-BITS::BITSIN-1:C;

Normal LoopStar 800 2004-01-01 15:18:57
M C COMPLD
"BITSIN-1::LINECDE=B8ZS,FMT=ESF,SVTIMER=00-
01,MANSSM=TNC,SSMIN=DUS:OOS-AU,FAF"
"BITSIN-2::LINECDE=B8ZS,FMT=ESF,SVTIMER=00-
01,MANSSM=CLEAR,SSMIN=DUS:OOS-AU,AINS&FAF"
"BITSOUT-
1::LBO=1,LINECDE=B8ZS,FMT=ESF,MSGMODE=AIS,AISTH=PRS,SVTI
MER=05-00,TSSM=Y:OOS-MA"
"BITSOUT-
2::LBO=1,LINECDE=B8ZS,FMT=ESF,MSGMODE=PASSTHRU,SVTIMER
=00-01,TSSM=Y:IS-NR"
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
;
Notes
RTRV-CAR
Command RTRV-CAR
Explanation Retrieve committed access rate (CAR).
Function This command retrieves the CAR attribute.
Category Ethernet
Security Retrieve
ED-CAR
DLT-CAR
Input Format RTRV-CAR:[<TID>]:<AID>:<CTAG>;
<AID> Ethernet CAR identifier. Valid format is CAR-<SLOT
ID>-<CAR ID>. <CAR ID> ranges from 1 to 2048.
Support & or && symbol. Support ALL.
LPS800-UM-COMM-02 2-265

Format
^^^"<ETN_CARID>::CARENABLE=<CARENABLE>,CIR=<CIR>"<cr><lf>
;
Error <cr><lf><lf>
M^^<CTAG>^DENY<cr><lf>
^^^<error code><cr><lf>
^^^"<error description>"<cr><lf>
;
<AID> Ethernet CAR identifier.
<CARENABLE> Enable state of CAR. Valid value can be Y (1) or N (0).
<CIR> Committed information rate (CIR) of CAR. Its unit is
1 kbits/s.
Errors ETH_BID_ERR (the unit ID is invalid);
CFG_BD_NOT_EXIST (the unit does not exist);
CFG_BDTYPE_MISMATCH (the unit type is not Ethernet unit).
CFG_CMD_NOT_SUPPORT (do not support this command);
ERR_ETH_PARA_CARID (the CAR ID parameter is invalid);
CFG_GET_NULL (there are no matched CAR record).
Example Input RTRV-CAR::CAR-1-10:100;
RTRV-CAR::CAR-1-ALL:100;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
"CAR-1-10::CARENABLE=Y,CIR=10240"
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes
2-266 LPS800-UM-COMM-02
RTRV-COND-<MOD2>
Command RTRV-COND-<MOD2>
Explanation Retrieve condition (ALL OC3, OC12, OC48, OC192, EC1, FETH, GETH, VCG,
T1, T3, STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C, STS192C,
Function This command retrieves the current standing condition and state associated with
an entity.
Security Retrieve
REPT EVT <MOD2>
RTRV-ALM-<MOD2>
REPT ALM ENV
RTRV-ALM-ENV
REPT ALM EQPT
REPT EVT EQPT
RTRV-ALM-EQPT
RTRV-COND-EQPT
Input Format RTRV-COND-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<TYPEREP>],
[<LOCN>],[<DIRN>];
LPS800-UM-COMM-02 2-267

<MOD2> The second modifier of the retrieve command which
identifies the type of the entity that is retrieved. Valid values
are ALL OC3, OC12, OC48, OC192, EC1, FETH, GETH,
VCG, T1, T3, STS1, STS3C, STS6C, STS9C, STS12C,
STS24C, STS48C, STS192C, VT1, EQPT, DS1, DS3,
SYNC, SYNCALL, SYNCFAC or BITS.
<AID> The AID of the entity that is retrieved. Refer to Charpter 3 for
its possible values. If <MOD2> is ALL, it must be NULL.
<TYPEREP> If it is NULL, all the standing conditions of the specified
object will be retrieved.
Thus, NEND (near end) refers to alarm conditions occurring
at the identified entity, and FEND (far end) refers to alarm
intermediate point. A NULL value is equivalent to NEND.
entity identified by the AID. A NULL value is equivalent to
ALL. Valid value is TRMT (transmit direction only) or RCV
(receive direction only).
Format
^^^<rsphdr><cr><lf>
^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDA
T>],[<OCRTM>],[<LOCN>],[<DIRN>],,,:[<CONDDESCR>],:[SN=<ALMSN>]"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-268 LPS800-UM-COMM-02

<AID> Refer to the input <AID>.
CR (critical alarm), MJ (major alarm), MN (minor alarm), NA
(not alarmed), NR (not reported) or CL (cleared alarm).
<TYPEREP> Alarm condition type.
<OCRDAT> The date when the triggering event occurred.
<OCRTM> The time of day when the triggering event occurred.
entity identified by the <AID>. Valid value is TRMT (transmit
direction only) or RCV (receive direction only).
<CONDDESC> <CONDDESC> is the text message associated with the
alarm condition. It is comprised of a maximum of 63
characters.
<SN> The number of SC event message. Only for Huawei EMS.
PARAMETER ERROR
Example Input RTRV-COND-EQPT::SLOT-3:1::BDSTATUS,NEND,RCV;
Normal LoopStar 800 2004-03-15 15:54:55
M 1 COMPLD
"SLOT-3,EQPT:CR,BDSTATUS,SA,2004-11-09,05-36-
39,NEND,RCV,,,:\"Card removed\","
;
Error LoopStar 800 2004-03-15 15:54:55
M 1 DENY
IDRG
/*DATA RANGE ERROR,CONDITION TYPE PARAMETER ERROR*/
;
Notes
LPS800-UM-COMM-02 2-269
RTRV-COS
Command RTRV-COS
Explanation Retrieve class of service (COS).
Function This command retrieves a COS in the unit.
Category Ethernet
Security Retrieve
ED-COS
DLT-COS
Input Format RTRV-COS:[<TID>]:<AID>:<CTAG>;
<AID> Indicates the COS. Valid value is <ETN_COSID>. The format
is COS-<SLOT ID>-<COS ID>. Support ALL.
Format
^^^"<AID>::COSTYPE=<COSTYPE>,[SIMPLEPRI=<SIMPLEPRI>]"<cr><lf>
;
Error <cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
;
<AID> Indicates the COS. Valid value is <ETN_COSID>. The format
is COS-<SLOT ID>-<COS ID>.
<COSTYPE> Indicates the type of COS.
<SIMPLEPRI> Indicates the simple priority. It is optional and required only if
<COSTYPE> is SIMPLE.
Errors ETH_BID_ERR (the unit ID is invalid);
CFG_BD_NOT_EXIST (the unit does not exist);
CFG_BDTYPE_MISMATCH (the unit is not Ethernet unit);
CFG_CMD_NOT_SUPPORT (do not support this command);
ERR_ETH_GET_NULL (there is no COS).
2-270 LPS800-UM-COMM-02
Example Input RTRV-COS::COS-1-1:100;

RTRV-COS::COS-1-ALL:100;
RTRV-COS:::100;
Normal LoopStar 800 2004-01-01 12:23:20
M 100 COMPLD
"COS-1-11::COSTYPE=SIMPLE,SIMPLEPRI=1"
;
LoopStar 800 2004-01-01 12:23:20

M 100 COMPLD
"COS-1-11::COSTYPE=TAGPRI,TAGPRI0=0,TAGPRI1=0,TAGPRI2=0,
TAGPRI3=0,TAGPRI4=1,TAGPRI5=1,TAGPRI6=1,TAGPRI7=1"
;
LoopStar 800 2004-01-01 12:23:20

M 100 COMPLD
"COS-1-11::COSTYPE=IPTOS,IPTOSD=1,IPTOST=1,IPTOSR=1,IPTOSC=1"
;
Error LoopStar 800 2004-03-15 15:54:55
M 101 DENY
IIAC
;
Notes
LPS800-UM-COMM-02 2-271
RTRV-CRS
Command RTRV-CRS
Explanation Retrieve cross connection.
Function This command retrieves the proper attributes for all cross connections in the
specified NE.
Security Retrieve
Input Format RTRV-CRS:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
("<FROM>,<TO>:<CCT>,<LEVEL>:[PREFERREDPATH=<PREFERREDPATH
>,][ACTIVEPATH=<ACTIVEPATH>,][CKTID=<CKTID>];[,<SST>]" <cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-272 LPS800-UM-COMM-02

<FROM> Access identifier identifies one end of the cross connection
(see "STS-N" and "VT1.5" sections in Charpter 3 TL1
Parameters).
connection (see "STS-N" and "VT1.5" sections in Charpter 3
TL1 Parameters).
<PREFERREDP Preferred path. <PREFERREDPATH> is only supplied for
ATH> UPSR. Two values separated by & are applicable to only
UPSR with 2 sources and 2 destinations (see "STS-N" and
"VT1.5" sections in Charpter 3 TL1 Parameters).
<CCT> Cross connect type. Valid value is 1WAY or 2WAY.
provisioned. If included, it may not contain any blank spaces.
If <CKTID> is NULL, then it will not be shown.
<SST> Redline state. If <SST> is RDLD_DEA, then it will not be
shown.
Errors
Example Input RTRV-CRS:::C;
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
... "STS-1-1-1,STS-2-1-1:2WAY,STS1"
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
IIAC
;
Notes
RTRV-CRS-<STS_PATH>
Command RTRV-CRS-<STS_PATH>
Explanation Retrieve cross Connection (STS1, STS3C, STS6C STS9C, STS12C, STS24C,
STS48C, STS192C).
LPS800-UM-COMM-02 2-273
Function This command retrieves the proper attributes for the STS path cross connections.
1. The following command is used to retrieve all level cross-connections with
specified path F1:
RTRV-CRS-<STS_PATH>::F1:<CTAG>;
2. F1&F2 means working path and protect path, so following command is used
to retrieve all UPSR cross-connections with specified two paths F1 and F2:
RTRV-CRS-<STS_PATH>::F1&F2:<CTAG>;
3. The following command is used to retrieve all cross-connections with anyone

path between F1 and F2:
RTRV-CRS-<STS_PATH>::F1&&F2:<CTAG>;
4. The following command is used to retrieve all the cross-connections:

RTRV-CRS-<STS_PATH>:::<CTAG>;
Security Retrieve
DLT-CRS-<STS_PATH>
ED-CRS-<STS_PATH>
Input Format RTRV-CRS-<STS_PATH>:[<TID>]:[<AID>]:<CTAG>;
<STS_PATH> Identifies the type of STS and VT path. Valid value can be
STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
STS48C, or STS192C.
<AID> Access identifier. It can be source or destination of cross
connection, or any one path of source or destination. It can
be null, which means retrieve all cross connections with
entered rate level. "&" and "&&" is supported.
^^^"<STS>:LEVEL=<XCLEVELRSP>,MODE=<XCLOOPMODE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-274 LPS800-UM-COMM-02

(see "STS-N" in Chapter 3: TL1 Parameters).
connection (see "STS-N" in Chapter 3: TL1 Parameters).
<PREFERREDPATH> Preferred path. <PREFERREDPATH> is only supplied for
UPSR. Two values separated by & are applicable to only
UPSR with 2 sources and 2 destinations (see "STS-N" in
Chapter 3: TL1 Parameters)
provisioned. If <CKTID> is NULL, then it will not be shown.
shown.
Errors
Example Input RTRV-CRS-STS1::STS-1-1-1:C;
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
"STS-1-3-1&STS-1-2-1,STS-7-4:2WAY,STS1:PREFERREDPATH=STS-1-3-
1,ACTIVEPATH=STS-1-3-1,CKTID=MERRY:,RDLD"
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
IIAC
;
Notes 1. Only LoopStar 1600 supports STS24C, STS48C and STS192C.
Command RTRV-CRS-<STS_PATH/VT_PATH>
Explanation Retrieve cross Connection (STS1, STS3C, STS6C STS9C, STS12C, STS24C,
LPS800-UM-COMM-02 2-275
Function This command retrieves the proper attributes for the STS path cross connections.
1. The following command is used to retrieve all level cross-connections with
specified path F1:
RTRV-CRS-<STS_PATH/VT_PATH>::F1:<CTAG>;
2. F1&F2 means working path and protect path, so following command is used
to retrieve all UPSR cross-connections with specified two paths F1 and F2:
RTRV-CRS-<STS_PATH/VT_PATH>::F1&F2:<CTAG>;
3. The following command is used to retrieve all cross-connections with anyone

path between F1 and F2:
RTRV-CRS-<STS_PATH/VT_PATH>::F1&&F2:<CTAG>;
4. The following command is used to retrieve all the cross-connections:

RTRV-CRS-<STS_PATH/VT_PATH>:::<CTAG>;
Security Retrieve
Input Format RTRV-CRS-<STS_PATH/VT_PATH>:[<TID>]:[<AID>]:<CTAG>;
<STS_PATH/ Identifies the type of STS and VT path. Valid value can be
VT_PATH> STS1, STS3C, STS6C, STS9C, STS12C, STS24C,
<AID> Access identifier. It can be source or destination of cross
connection, or any one path of source or destination. It can
be null, which means retrieve all cross connections with
entered rate level. "&" and "&&" is supported.
^^^"<STS>:LEVEL=<XCLEVELRSP>,MODE=<XCLOOPMODE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-276 LPS800-UM-COMM-02

(see "STS-N" and "VT1.5" sections in Chapter 3: TL1
Parameters).
connection (see "STS-N" and "VT1.5" sections in Chapter 3:
TL1 Parameters).
<PREFERREDPATH> Preferred path. <PREFERREDPATH> is only supplied for
UPSR. Two values separated by & are applicable to only
UPSR with 2 sources and 2 destinations (see "STS-N" and
"VT1.5" sections in Chapter 3: TL1 Parameters)
provisioned. If <CKTID> is NULL, then it will not be shown.
shown.
Errors
Example Input RTRV-CRS-STS1::STS-1-1-1:C;
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
"STS-1-3-1&STS-1-2-1,STS-7-4:2WAY,STS1:PREFERREDPATH=STS-1-3-
1,ACTIVEPATH=STS-1-3-1,CKTID=MERRY:,RDLD"
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
IIAC
;
Notes 1. Only LoopStar 1600 supports STS24C, STS48C and STS192C.
2. The LoopStar 800 does not support VT1/VT2 level UPSR and selector.
RTRV-CRS-OHBYTE
Command RTRV-CRS-OHBYTE
Explanation Retrieve cross overhead bytes.
Function This command retrieves the cross information of overhead bytes.
LPS800-UM-COMM-02 2-277
Security Retrieve
Related Messages
Input Format RTRV-CRS-OHBYTE:[<TID>]:<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"<FROM_AID><TO_AID><FROM_BYTE><DST_BYTE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<FROM_AID> The source AID.
<TO_AID> The destination AID.
<FROM_BYTE> The source overhead byte of the cross.
<DST_BYTE> The destination overhead byte of the cross.
Errors
Example Input RTRV-CRS- OHBYTE:::C;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"FAC-2-1,FAC-6-1,D1,D1"
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,NO DCCPHYINFO EXISTES*/
;
Notes
2-278 LPS800-UM-COMM-02
RTRV-DAT
Command RTRV-DAT
Explanation Retrieve date.
Function This command retrieves the time and date parameters of NE.
Category System
Security Retrieve
Related Messages ED-DAT
Input Format RTRV-DAT:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"<DATE>,<TIME>,<TMZONE>,<DSTTIME>"<cr><lf>
;
Error
<DATE> <DATE> is the current date in a format of: YY-MM-DD,
where YY is the last two digits of the year ranging from 00
to 99, MM is the month of the year ranging from 1 to 12,
and DD is the day of the month ranging from 1 to 31.
<TIME> <TIME> is the current time in a format of: HH-MM-SS,
where HH is the hour in a 24 hour format ranging from 00 to
23, MM is the minute ranging from 00 to 59, and SS is the
second ranging from 00 to 59.
<TMZONE> Valid values are EASTERN, CENTRAL, MOUNTAIN,
PACIFIC, ALASKA, HAWAII, SAMOA or UTC (also
supports general time zone: GMT-n and GMT+n).
<DSTIME> Flag of supporting daylight saving time. Valid value is
Y or N.
Errors
LPS800-UM-COMM-02 2-279
Example Input RTRV-DAT:::100;

Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
"04-01-01,00:00:00,PACIFIC,N"
;
Error LoopStar 800 2004-07-10 15:35:51
M C DENY
IENE
EXISTES*/
;
Notes
RTRV-DCC
Command RTRV-DCC
Explanation Retrieve DCC.
Function This command retrieves the DCC attributes and its protocol type.
Security Retrieve
Related Messages ED-DAT
Input Format RTRV-DCC:[<TID>]:<AID>:<CTAG>;
<AID> The DCC AID identifier indicates the DCC channel. Valid
format is <DCC>-<SLOT ID>-<PORT ID>-<CHANNEL ID>.
The valid values of <CHANNEL ID> are 1 (SDCC: D1 to
D3), 2 (LDCC: D4 to D12), 3 (LDCC2: D4 to D6), 4
(LDCC3, D7 to D9) or 5 (LDCC4, D10 to D12).
2-280 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^"RATE=<RATE>,CHANNEL=<CHANNEL>,PROTYPE
=<PROTYPE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> DCC AID identifier.
<PROTYPE> The protocol of DCC link layer. Valid values are
TRANSPARENT (there is no link protocol, the channel is
free for in CRS),
PPP (when IP stack is in use),
LAPD (when ISO stack is in use),
ECC (when ECC stack is in use),
AUTO (Auto-negotiation or default protocol stack).
Errors
Example Input RTRV-DCC::DCC-6-1-1:C;
Normal LoopStar 800 2004-03-07 09:50:17
M C COMPLD
"AUTO"
;
Error LoopStar 800 2004-07-10 15:35:51
M C DENY
SDNC
PARAMETER*/
;
Notes
LPS800-UM-COMM-02 2-281
RTRV-EQPT
Command RTRV-EQPT
Explanation Retrieve equipment.
Function This command retrieves all attributes for a given unit.
Category Equipment
Security Retrieve
Related Messages DLT-EQPT
ED-EQPT
Input Format RTRV-EQPT:[<TID>]:[<AID>]:<CTAG>;
“EQPT” section in Chapter 3: TL1 Parameters.
^^^"<AID>::[PROVTYPE=<CARDTYPE>,][INTFTYPE=<INTFTYPE>,]
[ACTTYPE=<CARDTYPE>,][TPSPRI=<TPSPRI>,]
[SWITCHSTATE=<SWITCHSTATE>,][SN=<SN>,][CLEI=<CLEI>,]
[DOM=<DOM> ,][PCBVER=<PCBVER>,][SWVER=<SWVER>,]
[FPGAVER=<FPGAVER>,][EPLDVER=<EPLDVER>,]
[BIOSVER=<BIOSVER>,] [MAC=<MAC>]:<PST>,[<SST>]"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-282 LPS800-UM-COMM-02

“EQPT” section of Chapter 3: TL1 Parameters.
<CARDTYPE> The AID unit type. Valid values are shown in Chapter 3: TL1
Parameters. "PROVTYPE" means the logical unit type
provisioned by user, "ACTTYPE" means the physical unit type
inserted in the slot.
<INTFTYPE> The AID unit interface type. Valid values are shown in Chapter
3: TL1 Parameters. This parameter is optional and can be used
only for tribute units.
<TPSPRI> The priority of the AID unit if the unit is a working unit of a DSn
(TPS) protection group. For any other units, this parameter is
not available. This attribute will be used when muti-units fault in
a DSn (TPS) protection group. Valid values are shown in the
"TPS_PRIORITY" section of Chapter 3: TL1 Parameters.
<SWITCHSTA The switch state of the AID unit if the unit is a unit of a DSn
TE> (TPS) protection group. Valid values are shown in the
"EQUIPMENT_SWITCH_STATE" section of Chapter 3: TL1
Parameters.
<SN> The serial number for the equipment. Valid value is a string and
is optional.
<CLEI> The CLEI code for the equipment. Valid value is a string and is
optional.
<DOM> The date when the unit was manufactured and is optional.
<PCBVER> The PCB version for the equipment. Valid value is a string and
is optional.
<SWVER> The software version for the equipment. Valid value is a string
and is optional.
Output Parameter <FPGAVER> The FPGA version for the equipment. Valid value is a string
(cont.) and is optional.
<EPLDVER> The EPLD version for the equipment. Valid value is a string
and is optional.
<BIOSVER> The BIOS version for the equipment. Valid value for
<BIOSVER> is a string and is optional.
<MAC> The MAC address for the equipment if it is an Ethernet unit.
Valid value is a string like "00-B0-D0-E3-4C-DE" and is
optional.
Parameters.
Parameters.
Errors
LPS800-UM-COMM-02 2-283
Example Input RTRV-EQPT:: SLOT-9:C;

Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"SLOT-
10::PROVTYPE=XCSH,ACTTYPE=XCSH,CLEI=0000000000,SWVER=1.11,FP
GAVER=(U2)120(U7)110,BIOSVER=9.6.20:IS-NR"
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
;
Notes Parameters <SN>, <CLEI>, <DOM>, <PCBVER>, <SWVER>, <FPGAVER>,
<EPLDVER>, <BIOSVER> and <MAC> could only be shown when physical unit
is online.
RTRV-EQPT-PG
Command RTRV-EQPT-PG
Explanation Retrieve equipment protection group.
Function This command retrieves the parameters for the specified equipment
protection group.
Related Messages ENT-EQPT-PG
ED-EQPT-PG
DLT-EQPT-PG
Input Format RTRV-EQPT-PG:[<TID>]:[<AID>]:<CTAG>;
<AID> Identifier of equipment AID. Null value means all.
2-284 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^("<AID>::RVRTV=<RVRTV>,RVTM=<RVTM>,PSTYPE=<PSTYPE>,WORK
=<WORK>, SWSTATE=<SWSTATE>")+<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> AID of protecting equipment. Valid values are shown in the
“EQPT” section of Chapter 3: TL1 Parameters.
"REVERTIVE MODE".
"REVERTIVE-TIME".
<PSTYPE> Protection architecture.
<WORK> AID(s) of working equipment. It supports "&" symbol.
<SWSTATE> Switch state of the protection group. Valid value is IDLE or
SWITCHING.
Errors
Example Input RTRV-EQPT-PG:::C;
Normal LoopStar 800 2004-03-07 09:50:17
M C COMPLD
"SLOT-4::RVRTV=Y,RVTM=5,PSTYPE=1-N,WORK=SLOT-3&SLOT-
5&SLOT-6,SWSTATE=IDLE"
;
Error LoopStar 800 2004-07-10 15:35:51
M C DENY
PLNA
;
Notes
LPS800-UM-COMM-02 2-285
RTRV-ETH-EQPT
Command RTRV-ETH-EQPT
Explanation Retrieve Ethernet equipment.
Function This command retrieves the Ethernet attributes in the unit.
Security Retrieve
Related Messages ED-ETH-EQPT
Input Format RTRV-ETH-EQPT:[<TID>]:<AID>:<CTAG>;
<AID> Indicates the slot. Valid value can SLOT-<EQPT>.
It supports ALL.
Format
^^^"<AID>::JUMBOTYPE=<JUMBOTYPE>"<cr><lf>
;
Error <cr><lf><lf>
;
<AID> Indicates the slot.
<JUMBOTYPE> Indicates the type field value of jumbo frame.
Errors
2-286 LPS800-UM-COMM-02
Example Input RTRV-ETH-EQPT::SLOT-1:100;

RTRV-ETH-EQPT:::100;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
"SLOT-1::JUMBOTYPE=34887"
;
Error LoopStar 800 2004-07-10 15:35:51
M 101 DENY
IIAC
"invalid access identifier"
;
Notes
RTRV-ETHLINK
Command RTRV-ETHLINK
Explanation Retrieve Ethernet link.
Function Retrieve an Ethernet link in the unit.
Category Ethernet
Security Retrieve
Related Messages ENT-ETHLINK
DLT-ETHLINK
Input Format RTRV-ETHLINK:[<TID>]:<LINK_FROM>,<LINK_TO>:<CTAG>:::
[INTAG=<INTAG>];
FAC/VCG-<EQPT>-<PORT>. It supports ALL.
VCG-<EQPT>-<PORT>. It supports ALL. It does not
support Ethernet link from VBLP to VBLP.
can be VLAN tag. It is optional. If not specified, it defaults to
retrieve all INTAGs.
LPS800-UM-COMM-02 2-287

Format
^^^"<LINK_FROM>,<LINK_TO>::[INTAG=<INTAG>],CTYPE=<CTYPE>"<cr><l
f>
;
Error <cr><lf><lf>
^^^<error code> <cr><lf>
;
VCG-<EQPT>-<PORT>.
can be VLAN tag.
<CTYPE> Valid value can be 1WAY or 2WAY.
Errors CFG_BD_NOT_EXIST (The unit does not exist.);
ETH_PORT_ERR (The port ID error.);
ETH_VLANIDERR (The VLAN ID is error.);
ERR_ETH_GET_NULL (Expected link is NULL.).
2-288 LPS800-UM-COMM-02
Example Input 1. Retrieve the link according to specified FROM and TO:
RTRV-ETHLINK::FAC-1-2,VCG-1-4:100;
RTRV-ETHLINK::FAC-1-2,VCG-1-4:100:::INTAG=1;
2. Retrieve all links within a NE:

RTRV-ETHLINK:::101;
RTRV-ETHLINK::ALL,ALL:101;
3. Retrieve all links within a unit:

RTRV-ETHLINK::FAC-1-ALL,ALL:102;
4. Retrieve all links according to specified FROM:

RTRV-ETHLINK::FAC-1-1,ALL:103;
5. Retrieve all links according to specified TO:

RTRV-ETHLINK::ALL,VCG-1-1:104;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
"FAC-1-2,VCG-1-4::INTAG=2,CTYPE=1WAY"
;
Error LoopStar 800 2004-07-10 15:35:51
M 100 DENY
IIAC
;
Notes
RTRV-ETH-VER
Command RTRV-ETH-VER
Explanation Retrieve Ethernet version.
Function This command retrieves the version of Ethernet NE software.
Security Retrieve
Related Messages
Input Format RTRV-ETH-VER:[<TID>]::<CTAG>;
LPS800-UM-COMM-02 2-289

Format
^^^"ETHSOFTVER=<ETHSOFTVER>,ETHSOFTDATE=<ETHSOFTDATE>"
<cr><lf>
;
Error
<ETHSOFTVER> The version of Ethernet NE software.
<ETHSOFTDATE> The release date of Ethernet NE software.
Errors
Example Input RTRV-ETH-VER:::100
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
"ETHSOFTVER=ECFV100R002ST03,ETHSOFTDATE=20040831"
;
Error
Notes
RTRV-EXIST-SYNC
Command RTRV-EXIST-SYNC
Explanation Retrieve the existing synchronization reference sources.
Function This command is used to retrieve the existing synchronization reference
sources; it can help the user know whether a reference source has failed.
Security Retrieve
Related Messages
Input Format RTRV-EXIST-SYNC:[<TID>]::<CTAG>;
2-290 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^("SYNCNUM=<SYNCNUM>::<SYNCAID>"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<SYNCNUM> The number of synchronization reference source, Count from 1
to N. (N means the maximum counted number of the existing
source.) Use this parameter to know how many reference
sources exist.
<SYNCAID> Timing reference facility AIDs. See the "SYNCAID" section in
Chapter 3: TL1 Parameters for details.
Errors
Example Input RTRV-EXIST-SYNC:::C;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"SYNCNUM=1::BITSIN-1"
"SYNCNUM=2::BITSIN-2"
;
Error LoopStar 800 2004-03-15 15:54:55
M A DENY
PLNA
;
Notes
LPS800-UM-COMM-02 2-291
RTRV-EXT-CONT
Command RTRV-EXT-CONT
Explanation Retrieve external control.
Function Instructs an NE to send the control state of an external control. The command can
be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT
command.
Security Retrieve
Related Messages OPR-EXT-CONT
RLS-EXT-CONT
Input Format RTRV- EXT-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>];
<AID> It is the AID of external control and must not be null. See section
"Housekeeping".
<CONTTYPE> <CONTTYPE> is the type of control. A null value requests the
operation of all controls identified by the <AID> parameter.
Format
^^^<rsphdr><cr><lf>
<rspblk> +
;
^^^"<AID>:[<CONTTYPE>],<DUR>[,<CONTSTATE>]"<cr><lf>
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-292 LPS800-UM-COMM-02

<AID> The AID of external control.
<CONTTYPE> The type of control.
<DUR> The duration for which the external control can be operated.
<CONSTATE> The control state of the external control. Valid values are OPR
(operated), RLS (released) or NA (not applicable, that is,
<DUR> is MNTRY). A null value defaults to NA. If <DUR> is
CONTS, <CONTSTATE> must not be null.
PARAMETER ERROR
Example Input RTRV-EXT-CONT::CONT-7:C;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"CONT-7:CONT-AIRCOND,CONTS,RLS"
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
IPNC
;
Notes The LoopStar 810 does not support this command.
RTRV-FETH
Command RTRV-FETH
Explanation Retrieve Fast Ethernet.
Function This command retrieves the attributes of a fast Ethernet port.
Security Retrieve
Related Messages ED-FETH
LPS800-UM-COMM-02 2-293
Input Format RTRV-FETH:[<TID>]:<AID>:<CTAG>;

<AID> Ethernet facility. Valid format is FAC-<SLOT ID>-
<PORT ID>. It supports & or && symbol and does not
support ALL.
Format ^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
^^^"<AID>::[WORKMODE=<WORKMODE>],[ACTWORKMODE=<ACTWORKMO
DE>],[FLOWCTRL=<FLOWCTRL>],[ACTFLOWCTRL=<ACTFLOWCTRL>],[MTU
=<MTU>],[ACTPORTENABLE=<ACTPORTENABLE>],[PORTENABLE=<PORTE
NABLE>],[TAGTYPE=<TAGTYPE>],[PVID=<PVID>,PVPRI=<PVPRI>],[PSVID=<
PSVID>,PSVPRI=<PSVPRI>],[STAGTYPE=<STAGTYPE>],[SVENABLE=<SVEN
ABLE>]:<PST>"<cr><lf>
;
Error <cr><lf><lf>
;
<AID> Ethernet facility.
<WORKMODE> The work mode of the port.
<ACTWORKMODE> The actual work mode of the port.
<FLOWCTRL> The non-auto-negotiation flow control attribute of the port.
<ACTFLOWCTRL> The actual flow control state of the port.
<MTU> The max packet length of the port.
<PORTENABLE> Enable or disable the port.
<ACTPORTENABLE> The actual enable state of the port.
<PVID> The default VLAN ID of the port.
<PVPRI> The priority of the default VLAN for the port.
<TAGTYPE> The tag type of the port.
<PSVID> Indicates the default service VLAN ID of the port.
<PSVPRI> Indicates the priority of the default service VLAN for
the port.
<STAGTYPE> Indicates the service VLAN tag attribute of the port.
<PST> Indicates the Ethernet port state. Valid values are IS-NR,
OOS-AU, OOS-MA or OOS-AUMA.
Errors
2-294 LPS800-UM-COMM-02
Example Input RTRV-FETH::FAC-5-2:100;

Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
"FAC-5-
2::WORKMODE=AUTO,ACTWORKMODE=FULL100M,FLOWCTRL=DISABLE,A
CTFLOWCTRL=DISABLE,MTU=1522,PORTENABLE=Y,ACTPORTENABLE=Y,T
AGTYPE=ACCESS,PVID=22,PVPRI=2,PSVID=1000,PSVPRI=7,STAGTYPE=TA
GAWARE,SVENABLE=Y:IS-NR"
;
Error LoopStar 800 2004-06-20 14:30:00
M 101 DENY
IIAC
;
Notes
RTRV-FFP-<OCN>
Command RTRV-FFP-<OCN>
Explanation Retrieve facility protection group (OC3, OC12, OC48, OC192).
Function This command retrieves the attributes of an optical facility protection group.
Security Retrieve
DLT-FFP-<OCN>
ENT-FFP-<OCN>
RTRV-FFP-ALL
Input Format RTRV-FFP-<OCN>:[<TID>]:[<AID>]:<CTAG>;
level. Valid values are OC3 (SONET line protection only),
OC12, OC48, or OC192.
<AID> Access identifier of the OCN port, which is in a SONET line
protection or BLSR group. This should be an optional
parameter. If not given, the default is "ALL" which means
that all FFP groups for the given OCN are retrieved.
LPS800-UM-COMM-02 2-295

Format
("<PROTECT>,<WORK>:<PORTLEVEL>:FFPTYPE=<FFPTYPE>,[RINGID=<R
INGID>],[NODEID=<NODEID>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PSDIR
N=<PSDIRN>],[TPLMODE=<TPLMODE>],[SQLMODE=<SQLMODE>],[SWSTA
TE=<SWSTATE>]"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<PROTECT> Protecting optical facilities. Valid format is FAC-<SLOT ID>-
<PORT ID>.
If <FFPTYPE> is SONET line protection, this parameter is
protecting optical port.
If <FFPTYPE> is 2BLSR, this parameter is west optical port
(West1Port).
<WORK> Working optical facilities protected by <PROTECT>. Valid
format is FAC-<SLOT ID>-<PORT ID>.
If <FFPTYPE> is SONET line protection, then this parameter
is protected OCN port(s), multiple protected ports are
specified by "&"or "&&" notation.
If <FFPTYPE> is 2BLSR, this parameter is the east port.
<PORTLEVEL> Identifies the type of optical carrier (OC) level. Valid value
can be OC12, OC48, or OC192.
2-296 LPS800-UM-COMM-02
Output Parameter <RINGID> Identifier of a BLSR ring. It is a string of up to 16 characters.

(cont.) <NODEID> Identifier of node in a BLSR ring. It is an integer and ranges
"REVERTIVE MODE".
"REVERTIVE TIME". In BLSR mode, the ring and span
RVTM are the same, and 99 means non-revertive mode.
<PSDIRN> Switching mode. Valid value is UNI (unidirectional switching)
or BI (bi-directional switching). This parameter is only
applicable to SONET line protection.
applicable to BLSR.
applicable to BLSR.
<SWSTATE> Switch state of the protection group.
For BLSR, valid values are IDLE, RING-SW-E, RING-SW-
W, RING-SW-WE, SPAN-SW-E, SPAN-SW-W, SPAN-SW-
WE, FULL-PT or KBYTE-PT.
For SONET line protection, valid values are IDLE,
SWITCHING, LPG&IDLE, LPG&SWITCHING or
UNKNOWN. (LPG&IDLE and LPG&SWITCHING are only
used in 1+1 SONET line protection architecture when
locking a 1+1 SONET line protection group. When the switch
state of SONET line protection is overtimed, the state is
UNKNOWN).
Errors
Example Input RTRV-FFP-OC3:SONET-NE:FAC-2-1:100;
Normal LoopStar 800 2004-03-12 09:25:57
M 100 COMPLD
"FAC-1-1,FAC-1-
2:OC12:FFPTYPE=2BLSR,RINGID=1,NODEID=1,RVRTV=Y,RVTM=6,TPLMO
DE=AUTO,SQLMODE=AUTO,SWSTATE=IDLE"
;
Error LoopStar 800 2004-03-12 09:25:57
M 100 DENY
IPNV
;
LPS800-UM-COMM-02 2-297
RTRV-FFP-ALL
Command RTRV-FFP-ALL
Explanation Retrieve facility protection group all.
Function This command retrieves the attributes of all the optical facility protection groups
regardless of SONET line protection or BLSR.
Security Retrieve
DLT-FFP-<OCN>
RTRV-FFP-<OCN>
ENT-FFP-<OCN>
Input Format RTRV-FFP-ALL:[<TID>]::<CTAG>;

Format
^^^("<PROTECT>,<WORK>:<PORTLEVEL>:FFPTYPE=<FFPTYPE>,[RINGID
=<RINGID>][NODEID=<NODEID>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],[PS
DIRN=<PSDIRN>],[TPLMODE=<TPLMODE>],[SQLMODE=<SQLMODE>],[SW
STATE=<SWSTATE>]"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-298 LPS800-UM-COMM-02

<PORT ID>.
If <FFPTYPE> is SONET line protection, this parameter is
protecting optical port.
(West1Port).
LPS800-UM-COMM-02 2-299
Output Parameter <WORK> Working optical facilities protected by <PROTECT>. Valid

(cont.) format is FAC-<SLOT ID>-<PORT ID>.
If <FFPTYPE> is SONET line protection, then this parameter
is protected OCN port(s), multiple protected ports are
specified by "&"or "&&" notation.
If <FFPTYPE> is 2BLSR, this parameter is the east port
(East1Port).
<PORTLEVEL> Identifies the type of optical carrier (OC) level. Valid value
can be OC12, OC48, or OC192.
<RINGID> Identifier of a BLSR ring. It is a string of up to 16 characters.
<NODEID> Identifier of node in a BLSR ring. It is an integer and ranges
"REVERTIVE MODE" in Chapter 3: TL1 Parameters.
"REVERTIVE TIME" in Chapter 3: TL1 Parameters. In BLSR
mode, the ring and span RVTM are the same, and 99 means
non-revertive mode.
<PSDIRN> Switching mode. Valid value is UNI (unidirectional switching)
or BI (bi-directional switching). This parameter is only
applicable to SONET line protection.
applicable to BLSR.
applicable to BLSR.
<SWSTATE> Switch state of the protection group.
For BLSR, valid values are IDLE, RING-SW-E, RING-SW-
W, RING-SW-WE, SPAN-SW-E, SPAN-SW-W, SPAN-SW-
WE, FULL-PT or KBYTE-PT.
For SONET line protection, valid values are IDLE,
SWITCHING, LPG&IDLE, LPG&SWITCHING or
UNKNOWN. (LPG&IDLE and LPG&SWITCHING are only
used in 1+1 SONET line protection architecture when
locking a 1+1 SONET line protection group. When the switch
state of SONET line protection is overtimed, the state is
UNKNOWN).
2-300 LPS800-UM-COMM-02
Errors
Example Input RTRV-FFP-ALL:SONET-NE::100;
Normal LoopStar 800 2004-03-15 15:41:15
M 100 COMPLD
"FAC-1-1,FAC-1-
2:OC12:FFPTYPE=2BLSR,RINGID=1,NODEID=1,RVRTV=Y,RVTM=6,TPLMO
DE=AUTO,SQLMODE=AUTO,SWSTATE=IDLE"
;
Error LoopStar 800 2004-03-15 15:41:15
M 100 DENY
IPNV
;
RTRV-FLOW
Command RTRV-FLOW
Explanation Retrieve flow.
Function This command retrieves a flow entry of the unit.
Category Ethernet
Security Retrieve
ED-FLOW
DLT-FLOW
Input Format RTRV-FLOW:[<TID>]:<AID>:<CTAG>;
<FLOW ID>. Support & or && symbol. Support ALL.
LPS800-UM-COMM-02 2-301

Format
^^^"<AID>::[PORT=<ETN_PORT>],[INTAG=<INTAG>],[TAGPRI=<TAGPRI>],[
CARID=<ETN_CARID>],[COSID=<ETN_COSID>]"<cr><lf>
;
Error <cr><lf><lf>
^^^"<error description>" <cr><lf>
;
<AID> Ethernet flow identifier. Valid format is FLOW-<SLOT
ID>-<FLOW ID>.
<ETN_PORT> Ethernet port identifier. Valid format is FAC/VCG-
<EQPT>-<PORT>. It is optional.
can be VLAN tag. It is optional.
<TAGPRI> Indicates tag priority. Valid value can be 0 to 7. It is
optional and without default value.
<ETN_CARID> Indicates the associated CAR. Valid format is CAR-
<SLOT ID>-<CAR ID>.
<ETN_COSID> Indicates the identify of COS. Valid format is COS-
<SLOT ID>-<COS ID>.
CFG_GET_NULL (There are no flow record.).
2-302 LPS800-UM-COMM-02
Example Input RTRV-FLOW::FLOW-5-1:100;

RTRV-FLOW::FLOW-5-1&-2:100;
RTRV-FLOW::FLOW-5-1&&-4:100;
RTRV-FLOW::FLOW-5-ALL:100;
Normal LoopStar 800 2004-03-12 07:28:39
M 100 COMPLD
"FLOW-1-1::PORT=FAC-1-2,INTAG=3,CARID=CAR-1-10,COSID=COS-1-20"
;
Error LoopStar 800 2004-03-12 07:28:39
M 100 DENY
IIAC
;
Notes
RTRV-GETH
Command RTRV-GETH
Explanation Retrieve Gigabit Ethernet.
Function This command retrieves the attribute of a Gigabit Ethernet port.
Security Retrieve
Related Messages ED-GETH
Input Format RTRV-GETH:[<TID>]:<AID>:<CTAG>;
<AID> Ethernet facility. Valid format is FAC-<SLOT ID>-
<PORT ID> and does not support ALL.
LPS800-UM-COMM-02 2-303

Format
^^^"<AID>::[WORKMODE=<WORKMODE>],[ACTWORKMODE=<ACTWORKMO
DE>],[FLOWCTRL=<FLOWCTRL>],[ACTFLOWCTRL=<ACTFLOWCTRL>],[MTU
=<MTU>],[ACTPORTENABLE=<ACTPORTENABLE>],[PORTENABLE=<PORTE
NABLE>]:<PST>"<cr><lf>
;
Error <cr><lf><lf>
;
<AID> Ethernet facility.
<WORKMODE> The work mode of the port. It is optional and will
not change until it is set. Valid values are
AUTO (AUTO is the initial value and means
auto-negotiation.);
FULL1000M (1000 Mbit/s full-duplex mode.).
<ACTWORKMODE> The actual work mode of the port. Value values are
FULL1000M (1000Mbps full-duplex mode) or
NEGOTIATING (in process of negotiating).
<FLOWCTRL> The non-auto-negotiation flow control attribute of
the port.
<ACTFLOWCTRL> The actual flow control state of the port.
<MTU> The max packet length of the port.
<PORTENABLE> Enable or disable the port.
<ACTPORTENABLE> The actual enable state of the port.
<PST> Indicates the Ethernet port state. Valid values are IS-NR,
OOS-AU, OOS-MA or OOS-AUMA.
Errors
2-304 LPS800-UM-COMM-02
Example Input RTRV-GETH::FAC-5-2:100;

Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
"FAC-5-
2::WORKMODE=AUTO,ACTWORKMODE=FULL1000M,FLOWCTRL=DISABLE,
ACTFLOWCTRL=DISABLE,MACLPBK=RLB,PHYLPBK=NOLB,MTU=1522,PORT
ENABLE=Y,ACTPORTENABLE=Y:IS-NR"
;
Error LoopStar 800 2004-06-20 14:30:00
M 101 DENY
IIAC
;
Notes
RTRV-HDR
Command RTRV-HDR
Explanation Retrieve header.
Function This command requests that an NE simply reply with a normal response
indicating COMPLD, along with information that the NE has about itself, namely
the <SID>, <DATE>, and <TIME>.
Category System
Security Retrieve
Related Messages RTRV-TOD
SET-DAT
INIT-SYS
INIT-MEM
SET-SID
Input Format RTRV-HDR:[<TID>]::<CTAG>;
LPS800-UM-COMM-02 2-305

Format
;
Error <cr><lf><lf>
;
Errors
Example Input RTRV-HDR:::C;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
IBEX
/*Format:RTRV-HDR:[<TID>]::<CTAG>;
Example:RTRV-HDR:::100;*/
;
Notes
RTRV-IP-ROUTE
Command RTRV-IP-ROUTE
Explanation Retrieve IP route.
Function This command retrieves all the information of route.
Security Retrieve
Related Messages
Input Format RTRV-IP-ROUTE:<TID>::<CTAG>;
2-306 LPS800-UM-COMM-02

^^^"<DESTADDR><GATEWAY><MASK><PROTOCOL>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<DSTIPADDR> Address of destination IP.
<MASK> Mask.
<PROTOCOL> Protocol. Valid values are OSPF, RIP or STATIC.
Errors
Example Input RTRV-IPROUTE:::C;
Normal LoopStar 800 2002-03-04 14:30:00
M 10 COMPLD
"127.0.0.0,127.0.0.1,255.0.0.0,DIRECT"
"127.0.0.1,127.0.0.1,255.255.255.255,DIRECT"
"129.9.0.0,129.9.191.240,255.255.0.0,DIRECT"
"129.9.191.240,127.0.0.1,255.255.255.255,DIRECT"
"129.9.255.255,129.9.191.240,255.255.255.255,DIRECT"
"255.255.255.255,129.9.191.240,255.255.255.255,DIRECT"
;
Error LoopStar 800 2002-03-04 14:30:00
M C DENY
PLNA
;
Notes
LPS800-UM-COMM-02 2-307
RTRV-IPROUTE-STATIC
Command RTRV-IPROUTE-STATIC
Explanation Retrieve IP route static.
Function This command retrieves all the information of static IP route.
Security Retrieve
Related Messages ENT-IPROUTE-STATIC
DLT-IPROUTE-STATIC
Input Format RTRV-IPROUTE:<TID>::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"<DESTADDR><GATEWAY><MASK>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<DSTIPADDR> Address of destination IP.
<MASK> Mask.
Errors
2-308 LPS800-UM-COMM-02
Example Input RTRV-IPROUTE-STATIC:::C;

Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"129.99.0.0,129.99.1.1,255.255.0.0,0,0"
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,THE ROUTE DOESN'T
EXIST*/
;
Notes
RTRV-LAN
Command RTRV-LAN
Explanation Retrieve LAN.
Function This command retrieves the attribute of a LAN facility.
Security Retrieve
Related Messages
Input Format RTRV-LAN:[<TID>]:[<AID>]:<CTAG>;
<AID> Access identifier. The valid value is LAN-1. <AID> is
optional for this command. If <AID> is null (not specified
by the user), then it should default to all LAN ports
supported. Now only support LAN-1.
LPS800-UM-COMM-02 2-309

Format
^^^<rsphdr><cr><lf>
^^^"IP=<IPADDR>,MASK=<SUBNETMASK>,ENABLE=<ENABLE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<IPADDR> IP Address.
<SUBNETMASK> The subnet mask address.
<ENABLE> Flag of primary state. Valid value is Y or N.
Errors
Example Input RTRV-LAN::LAN-1:C;
Normal LoopStar 800 2004-03-15 15:54:55
M 100 COMPLD
"129.9.17.31,255.255.0.0,Y"
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
PLNA
;
Notes
RTRV-LOG
Command RTRV-LOG
Explanation Retrieve log.
Function This command retrieves the log of the NE.
Category System
2-310 LPS800-UM-COMM-02
Security Retrieve
Related Messages INIT-LOG
Input Format RTRV-LOG:[<TID>]:<AID>:<CTAG>::<LOGNAME>;
<AID> SLOT-N or NULL. NULL value means the current active
XCS/GXCS/XO unit.
<LOGNAME> The name of the log files to be retrieved. Currently, only
operation log is retrievable.
^^^"<LOGNAME>"<cr><lf>
(^^^/*<CONTENTS>*/ <cr><lf>)*
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
;
<LOGNAME> Refer to the input parameter.
<CONTENTS> If the retrieved log is OPT, it is a string of the complete
input command except the ";" at the end of it.
Errors
Example Input RTRV-LOG:::C::OPT;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"OPT"
/*2004-11-16:02-31-52:sonet,ED-OC3::FAC-4-4:S::::OOS*/
"OPT"
/*2004-11-16:02-32-17:sonet,ED-OC3::FAC-2-1:S::::OOS*/
;
Error LoopStar 800 2004-03-15 15:54:55
M C DENY
SDNR
/*DATA NOT READY, LOG DOES NOT EXIST*/
;
Notes If the sequence /* or */ occurs within the contents of a message log, it is
represented by \/* or \*/ (escape */), respectively.
LPS800-UM-COMM-02 2-311
RTRV-LPBK-<FETH>
Command RTRV-LPBK-<FETH>
Explanation Retrieve loopback (Fast Ethernet).
Function This command retrieves the loopback state of the Ethernet port.
Category Loopback
Security All users
Related Messages OPR-LPBK-<FETH>
RLS-LPBK-<FETH>
Input Format RTRV-LPBK-<FETH>:[<TID>]:<AID>:<CTAG>;
<AID> Access identifier identifies the Ethernet facility. Valid format
is FAC-<SLOT ID>-<PORT ID>. It supports "&" and "&&".
^^^"<AID>::LPBKTYPE=<LPBKTYPE>,LPBKMODE=<LPBKMODE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
is FAC-<SLOT ID>-<PORT ID>.
PHY (physical loopback).
Errors
2-312 LPS800-UM-COMM-02
Example Input RTRV-LPBK-FETH::FAC-2-1&FAC-2-2:100;

Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
"FAC-2-1::LPBKTYPE=FACILITY,LPBKMODE=MAC"
"FAC-2-1::LPBKTYPE=FACILITY,LPBKMODE=PHY"
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IIAC
;
Notes
Command RTRV-LPBK-<FETH/GETH>
Explanation Retrieve loopback (fast Ethernet, Gigabit Ethernet).
Function This command retrieves the loopback state of the Ethernet port.
Category Loopback
Security All users
Related Messages OPR-LPBK-<FETH/GETH>
Input Format RTRV-LPBK-<FETH/GETH>:[<TID>]:<AID>:<CTAG>;
is FAC-<SLOT ID>-<PORT ID>. It supports "&" and "&&".
LPS800-UM-COMM-02 2-313

Format
^^^<rsphdr><cr><lf>
^^^"<AID>::LPBKTYPE=<LPBKTYPE>,LPBKMODE=<LPBKMODE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
is FAC-<SLOT ID>-<PORT ID>.
PHY (physical loopback).
Errors
Example Input RTRV-LPBK-FETH::FAC-2-1&FAC-2-2:100;
Normal LoopStar 800 2004-03-15 18:55:23
M 100 COMPLD
;
Error LoopStar 800 2004-03-15 18:55:23
M 100 DENY
IIAC
;
Notes
2-314 LPS800-UM-COMM-02
RTRV-LPBK- <OCN/T1/T3/STS_PATH>
Command RTRV-LPBK- <OCN/T1/T3/STS_PATH>

Explanation Retrieve Loopback (OC-N, T1, T3, STS path).
Function This command retrieves the loopback state of the OCN/T1/T3 port or STS path.
Category Loopback
Security Retrieve
Related Messages
Input Format RTRV-LPBK-<OCN/T1/T3/STS_PATH>:[<TID>]:<AID>:<CTAG>;
level. Valid values are OC3, OC12, OC48 or OC192.
<AID> Access identifier identifies the <OCN/T1/T3/STS_PATH>.
Format
^^^<rsphdr><cr><lf>
^^^"<CFGAID>::LPBKTYPE=<LPBKTYPE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<LPBKTYPE> Loopback type. Valid values are FACILITY, TERMINAL,
CRS, DS1FEAC, DS3FEAC or NO_LOOP.
Errors
LPS800-UM-COMM-02 2-315
Example Input RTRV-LPBK-OC3::FAC-2-1:C;

Normal LoopStar 800 2004-03-15 18:55:23
M C COMPLD
"FAC-2-1::LPBKTYPE=FACILITY"
;
Error LoopStar 800 2004-03-15 18:55:23
M C DENY
IPNV
/*PARAMETER NOT VALID,CFG_BAD_PARA*/
/*0X9742*/
;
Notes
RTRV-LPBKFEAC-<T1/T3>
Command RTRV-LPBKFEAC-<T1/T3>
Explanation Retrieve loopback (T1, T3).
Function This command retrieves whether the far end loopback is allowed. The <AID>
cannot be NULL.
Category Loopback
Related Messages ALW-LPBK
INH-LPBK
Input Format RTRV-LPBKFEAC-<T1/T3>:[<TID>]:<AID>:<CTAG>;
2-316 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^"<AID>::<ENFLAG>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<ENFLAG> Enable flag. Valid value is ENABLE or DISABLE.
Errors
Example Input RTRV-LPBKFEAC-T1::FAC-5-1:C;
Normal LoopStar 800 2004-03-12 07:28:39
M C COMPLD
FAC-5-1::ENABLE
;
Error LoopStar 800 2004-03-12 07:28:39
M C DENY
PLNA
;
Notes
RTRV-NEID
Command RTRV-NEID
Explanation Retrieve NE ID.
Function This command retrieves the ID number of an NE.
Security Retrieve
Related Messages
LPS800-UM-COMM-02 2-317
Input Format RTRV-NEID:[<TID>]::<CTAG>;


Format
^^^<rsphdr><cr><lf>
^^^"<NEID>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<NEID> The ID and subnet of a NE. Valid value ranges from
65537 to 16695279.
Errors
Example Input RTRV-NEID:::C;
Normal LoopStar 800 2004-03-12 07:28:39
M C COMPLD
"638960"
;
Error LoopStar 800 2004-03-12 07:28:39
M C DENY
PLNA
;
Notes
RTRV-OSPF-ALL
Command RTRV-OSPF-ALL
Explanation Retrieve open shortest path first (OSPF) all.
2-318 LPS800-UM-COMM-02
Function This command retrieves all parameters of OSPF protocol (include OSPF-SYS,
OSPF-DCC and OSPF-LAN).
Security Retrieve
Related Messages
Input Format RTRV-OSPF-ALL:<TID>::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"OSPFFLAG=<WORKFLAG>,AREA=<AREAID>,STUBFLAG=<FLAG>,
NSSAFLAG=<FLAG>,IMPORTRIP=<FLAG>,IMPORTSTATIC=<FLAG>,
IMPORTDIRECT=<FLAG>,INTERFACETYPE=<TYPE>,COST=<COST>,
HELLOTIMER=<HELLOTIMER>,DEADTIMER=<DEADTIMER>,
RETRANSMITTIMER=<RETRANSMITTIMER>,
TRANSITDELAY=<TRANSITDELAY>,NOTSILENCE=<FLAG>,
OSPFDRPRI=<OSPFDRPRI>"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-319

<WORKFLAG> WORKFLAG: Y/N (default Y)
<AREAID> AREAID: IP Address format (default 0.0.0.0)
<STUBFLAG> FLAG: Y/N (default N)
<NSSAFLAG> FLAG: Y/N (default N)
<IMPORTRIP> FLAG: Y/N (default N)
<IMPORTSTATIC> FLAG: Y/N (default N)
<IMPORTDIRECT> FLAG: Y/N (default N)
<INTERFACETYPE> DCC or LAN.
<COST> Identifies the cost. Valid value ranges from 1 ot 65535.
Default value 100 for DCC interface and default value
10 for LAN interface. The DCC cost is bigger than
LAN cost.
<HELLOTIMER> Identifies the hello timer. Valid value ranges from 1 to
255. Default value 1 for DCC interface and default
value 10 for LAN interface.
<DEADTIMER> Identifies the dead timer. Valid value ranges from 1 to
65535. Default value 6 for DCC interface and defaut
value 40 for LAN interface.
2-320 LPS800-UM-COMM-02
Output Parameter <RETRANSMITTIMER> Identifies the re-transmit timer. Valid value ranges
(cont.) from 1 to 65535. Default value is 5.
<TRANSITDELAY> Identifies the transit delay. Valid value ranges from 1
to 3600. Default value is 1.
<NOTSILENCE> Flag. Valid value is Y or N. Default value Y for DCC
interface and default value N for LAN interface.
<OSPFDRPRI> Identifies the OSPF priority. Valid value ranges from 1
to 255. Default value is 1. Because DCC interfaces
have no Dr_priority, so it is set as 4294967295
(0xffffffff). For LAN interfaces, it ranges from 1 to 255
(default value 1 for LAN interfaces).
Errors
Example Input RTRV-OSPF-ALL:::C;
Normal SONET 2004-07-27 18:28:39
M C COMPLD
"OSPFFLAG=Y,AREA=0.0.0.0,STUBFLAG=N,NSSAFLAG=N,
IMPORTRIP=N,IMPORTSTATIC=N,IMPORTDIRECT=N,
INTERFACETYPE=LAN,COST=10,HELLOTIMER=10,DEADTIMER=40,
RETRANSMITTIMER=5,TRANSITDELAY=1,NOTSILENCE=N,OSPFDRPRI=1"
"OSPFFLAG=Y,AREA=0.0.0.0,STUBFLAG=N,NSSAFLAG=N,
IMPORTRIP=N,IMPORTSTATIC=N,IMPORTDIRECT=N,
INTERFACETYPE=DCC,COST=100,HELLOTIMER=1,DEADTIMER=6,
RETRANSMITTIMER=5,TRANSITDELAY=1,NOTSILENCE=Y,
OSPFDRPRI=4294967295"
;
Error
Notes
RTRV-PKGVER
Command RTRV-PKGVER
Explanation Retrieve package version.
Function This command is used to retrieve the versions of the software package active and
standby program. If there are no software package in XCS unit, then return empty
message but the command response is completed.
Category System
Security Retrieve
Related Messages
Input Format RTRV-PKGVER:[<TID>]::<CTAG>;
LPS800-UM-COMM-02 2-321

Format
^^^"ACTSWPVER=<ACTSWPVER>,STDBYSWPVER=<STDBYSWPVER>"
;
Error
<ACTSWPVER> Active bank software package version.
<STDBYSWPVER> Standby bank software package version.
Errors
Example Input RTRV-PKGVER:::C;
Normal LoopStar 800 2004-03-08 18:21:59
M C COMPLD
"ACTSWPVER=1.00.02,STDBYSWPVER=1.00.02"
;
Error
Notes
RTRV-PM-<MOD2>
Command RTRV-PM-<MOD2>
Explanation Retrieve performance (ALL, OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C,
STS12C, STS48C, STS192C, EQPT, VT1).
Function This command instructs an NE to send its current set of PM data associated with
one or more equipment units, facilities, links, or signaling links within the NE.
Security Retrieve
Related Messages
Input Format RTRV-PM-<MOD2>:[<TID>]:[<AID>]::<CTAG>::[<MONTYPE],[<MONLEV>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>],[<MONTM>];
2-322 LPS800-UM-COMM-02

<MOD2> The second modifier of the report message which identifies the
type of the entity that reports trouble. Valid values are ALL,
OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C, STS12C,
STS48C, STS192C, EQPT or VT1.
<AID> A null value is ALL.
<MONTYPE> Specifies the type of monitored parameter for which a value is
requested. A null value is ALL.
<MONLEV> Specifies the discriminating level for the requested monitored
parameter. A null value for <MONLEV> defaults to 1-UP.
<LOCN> Indicates the location, in reference to the entity identified by the
<AID>, being performance monitored. Thus, NEND (near end)
refers to PM values obtained at the identified entity, and FEND
(far end) refers to PM values obtained at a distant entity that is
connected to the identified entity. A null value defaults to NEND.
identified by the <AID>. <DIRN> defaults to ALL. Valid value is
TRMT (transmit direction only) or RCV (receive direction only).
<TMPER> Specifies the accumulation time period for the PM information. A
null value defaults to 15-MIN.
<MONDAT> The date of the beginning of the requested PM period specified
in <TMPER>.The format of <MONDAT> is MM-DD. A null value
defaults to the current date.
<MONTM> The beginning time of day of the requested PM period specified
in <TMPER>. A null value defaults to the current time.
LPS800-UM-COMM-02 2-323
Output Normal The response format depends on whether any specified PM values exist.
Format
If there are no values to report, the format is as follows:
<cr><lf><lf>
^^^<rspdhr><cr><lf>
;
Otherwise, if there is at least one PM value to report, the format is as follows:

<cr><lf><lf>
^^^<rsphdr><cr><lf>
<rspblk> +
;

^^^"<AID>[,<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],[<DI
RN>],[<TMPER>],[<MONDAT>][,<MONTM>]"<cr><lf>
In this case, the normal response MUST contain at least one occurrence of
<rspblk>. It is allowed to contain multiple <rspblk>s if applicable.
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-324 LPS800-UM-COMM-02

<AID> Access Identifier identifies the single equipment unit, facility,
link, packet link, or signaling link in the NE to which the retrieved
monitored parameter value pertains.
<AIDTYPE> Specifies the type of AID.
<MONTYPE> Indicates the type of monitored parameter for which a value is
retrieved.
<MONVAL> The measured value of the monitored parameter.
<VLDTY> The validity indicator for historical monitoring information. It
indicates whether the information for the specified time period
was accumulated over the entire time period or some portion
of it.
<AID>, from which the PM value is being retrieved.
<DIRN> The direction of PM relative to the entity identified by the <AID>.
<TMPER> Indicates the accumulation time period for the PM information.
<MONDAT> The date of the beginning of the PM period specified in
<TMPER>.
<MONTM> The beginning time of day of the PM period specified in
<TMPER>.
Errors
Example Input RTRV-PM-OC48::FAC-4-1::123::CV-S,0-UP,NEND,,15-MIN,01-01,17-15;
Normal LoopStar 800 2004-03-08 14:30:00
M 123 COMPLD
"FAC-4-1,OC48:CV-S,2,VALID,NEND,RCV,15-MIN,01-01,17-15"
;
Error LoopStar 800 2004-03-08 14:30:00
M 123 DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST*/
/*38416:PER_QUERY_NULL_OBJECT*/
;
Notes
LPS800-UM-COMM-02 2-325
RTRV-PMDAY
Command RTRV-PMDAY
Explanation Retrieve performance day.
Function This command retrieves the start time of daily PM data collection period.
The current start time of the daily data collection period may be set by using
the SET-PMDAY command.
Security Retrieve
Related Messages SET-PMDAY
Input Format RTRV-PMDAY:[<TID>]::<CTAG>;

^^^"<PM-DAY-START>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
The (^^^"<error description>"<cr><lf>) and (^^^/*error text*/<cr><lf>) error

response blocks are OPTIONAL and, if desired, MULTIPLE repetitions are
allowed.
<PM-DAY- The format for <PM-DAY-START> is HOD. HOD stands
START> for Hour-Of-Day and ranges from 0 to 23.
Errors
2-326 LPS800-UM-COMM-02
Example Input RTRV-PMDAY:::C;

Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
^^^"7"<cr><lf>
;
Error LoopStar 800 2004-03-08 14:30:00
M C DENY
PLNA
;
Notes
RTRV-RFILE
Command RTRV-RFILE
Explanation Retrieve remote file.
Function This command is used to retrieve a list of files in NE.
Category System
Related Messages
Input Format RTRV-RFILE:[<TID>]:[<AID>]:<CTAG>::<FILEURL>;
<AID> SLOT-N or NULL. NULL is the current active XCS unit.
<FILEURL> Valid format is "file://<url-path>". It identifies a file URL. This
parameter is used to specify a file or directory and must not
be null.
LPS800-UM-COMM-02 2-327

Format
^^^"AID=<AID>,FILETYPE=<FILETYPE>,FILENAME=<FILENAME>,VERSION
=<FILEVERSION>,FILESIZE=<FILESIZE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<errcde><cr><lf>
;
<AID> SLOT-N.
<FILETYPE> Identifies the type of the file. Valid values are FPGA, INI,
BIOS, NESOFT or BDSOFT.
<FILENAME> Identifies the name of the file.
<FILEVERSION> Identifies the version or the file.
<FILESIZE> Identifies the size of the file in bytes.
Errors
Example Input RTRV-RFILE::SLOT-7:C::"file://ofs1/hwx/ne.ini";
Normal LoopStar 800 2004-05-24 17:07:43
M C COMPLD
"AID=SLOT-7,FILETYPE=INI,FILENAME=ne.ini,VERSION=1.00.04,
FILESIZE=3540"
;
Error LoopStar 800 2004-05-24 17:07:43
M C DENY
SDNR
/*DATA NOT READY,FILE DOES NOT EXIST*/
/*0X90B3*/
;
Notes
2-328 LPS800-UM-COMM-02
RTRV-RIP-ALL
Command RTRV-RIP-ALL
Explanation Retrieve RIP all.
Function This command retrieves all the parameters of RIP protocol (include RIP-SYS, RIP-
DCC, RIP-LAN).
Security Retrieve
Related Messages
Input Format RTRV-RIP-ALL:<TID>::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"ENABLE=[WORKFLAG],IMPORTOSPF=[FLAG],IMPORTSTATIC=[FLAG],IMP
ORTDIRECT=[FLAG]INTERFACETYPE=[TYPE],VER=[VERSION],CAST=[CASTT
YPE],AUTH=[AUTHTYPE],PASSWORD=[STRING],RECV=[FALG],SEND=[FALG]"
<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-329

<ENABLE> The enable flag. Valid value is Y or N. Default value is N.
<IMPORTOSPF> Import OSPF routes flag. It is only available if <ENABLE> is
<IMPORTSTATIC> Import static routes flag. It is only available if <ENABLE> is
<IMPORTDIRECT> Import direct routes flag. It is only available if <ENABLE> is
<INTERFACETYPE> Interface type. Valid value is DCC or LAN.
<VER> Specifies the RIP version used. Default value 2 for DCC
interface and default value 1 for LAN interface.
<CAST> Cast type. Valid value is BROADCAST or MULTICAST.
Default value MULTICAST for DCC interface and default
value BROADCAST for LAN interface.
<PASSWORD> Simple password. It is a string with 0 to 16 characters.
Default is null.
<RECV> RIP receive version flag. Valid value is Y or N. Default value
N for DCC interface and default value Y for LAN interface.
<SEND> RIP send version flag. Valid value is Y or N. Default value N
for DCC interface and default value Y for LAN interface.
Errors
Example Input RTRV-RIP-ALL:::C;
Normal LoopStar 800 2004-05-24 17:07:43
M C COMPLD
"RIPFLAG=Y,IMPORTOSPF=N,IMPORTSTATIC=N,IMPORTDIRECT=N,INTERFA
CETYPE=LAN,VERSION=2,CASTTYPE=BROADCAST,AUTHTYPE=SIMPLE,PA
SSWORD=abc,RECEIVE=Y,SEND=Y"
"RIPFLAG=Y,IMPORTOSPF=N,IMPORTSTATIC=N,IMPORTDIRECT=N,INTERFA
CETYPE=DCC,VERSION=2,CASTTYPE=MULTICAST,AUTHTYPE=SIMPLE,PAS
SWORD=bcd,RECEIVE=Y,SEND=Y"
;
Error
Notes
2-330 LPS800-UM-COMM-02
RTRV-RMONALMCTRL-<MOD2>
Command RTRV-RMONALMCTRL-<MOD2>
Explanation Retrieve RMON alarm control (fast Ethernet, Gigabit Ethernet, all).
Function This command retrieves the parameters of alarm table which contains the
parameters that affect the condition of report events.
Category RMON
Security Retrieve
Related Messages ED-RMONALMCTRL-<MOD2>
Input Format RTRV-RMONALMCTRL-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>];
<AID> Valid format is FAC-<UNIT ID>-<PORT ID>. <AID> is
<MOD2> in the NE. If the <MOD2> is ALL then <AID> is
null.
^^^"<AID>,<AIDTYPE>:<MONTYPE>,<RPTMODE>,<INTERVAL>,< RTHR
>,<FTHR>,<ENFLAG>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-331

<AID> Access identifier, FAC-<UNIT ID>-<PORT ID>.
<AIDTYPE> The type of access identifier.(mod2)
<RPTMODE> Report mode. Valid values are
RPTUP (only report rising events);
RPTDOWN (only report falling events);
RPTALL (report both rising and falling events).
<INTERVAL> Alarm sample interval. By default, the interval is 10 seconds.
Valid value ranges from 5 to 30 (seconds).
<RTHR> Rising threshold. Valid value ranges from 1 to 4294967295
(0xFFFFFFFF). It must greater then falling threshold.
<FTHR> Falling threshold. Valid value ranges from 0 to 4294967294
(0xFFFFFFFE). It must less than the rising threshold.
<ENFLAG> States flag. Valid value is ENABLE or DISABLE.
Errors
Example Input RTRV-RMONALMCTRL-ALL:::100::;
Normal LoopStar 800 2004-05-24 17:07:43
M 100 COMPLD
"FAC-1-1,GETH:ETHDROP,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHUNDER,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHOVER,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHFRG,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHJAB,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:RXBBAD,RPTALL,10,9,1,ENABLE"
"FAC-1-1,GETH:TXBBAD,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHCOL,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHALI,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHFCS,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHLATECOL,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHEXCCOL,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:TXDEFFRM,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHCARERR,RPTALL,10,9,1,DISABLE"
"FAC-1-1,GETH:ETHCRCALI,RPTALL,10,9,1,DISABLE"
;
Error LoopStar 800 2004-01-01 14:28:13
M 100 DENY
IIAC
/*0X9CA0*/
;
Notes
2-332 LPS800-UM-COMM-02
Command RTRV-RMONHIST-<MOD2>
Explanation Retrieve RMON history control (fast Ethernet, Gigabit Ethernet, all).
Function This command retrieves the history performances.
Category RMON
Security Retrieve
Related Messages ED-RMONHISTCTRL-<MOD2>
Input Format RTRV-RMONHIST-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],
[<MONLEVEL>],[<PRDTP>],[<MONDAT >],[<MONTM >];
null.
<MONTYPE> <MONTYPE> is all the RMON parameters supported, see
section "RMON" in Charpter 3 TL1 Parameters. Default
value is ALL.
<MONLEVEL> Specifies the discriminating level for the requested
monitored parameter. Valid value is 1-UP or 0-UP which
shows counters only equal or above 1 or zero. Default value
is 1-up.
<PRDTP> Period type. Valid values are 30S, 30M, PRDVAR or
PRDALL. A null value is 30M.
specified in <TMPER>. The format of <MONDAT> is YYYY-
MM-DD. A null value for <MONDAT> defaults to the current
date.
specified in <TMPER>. A null value for <MONTM> defaults
to the current time (HH-MM-SS).
LPS800-UM-COMM-02 2-333

Format
^^^<rsphdr><cr><lf>
^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONLEVEL>,<MONDAT>,<MONTM>,
<H4B>,<L4B>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> Valid format is FAC-<SLOT ID>-<PORT ID>.
<MONTYPE> Performance ID. See section "RMON" in Charpter 3 TL1
Parameters.
specified in <TMPER>. The format of <MONDAT> is YYYY-
MM-DD.
<H4B> Higher 4 bytes of PM value.
<L4B> Lower 4 bytes of PM value.
Errors
Example Input RTRV-RMONHIST-GETH::FAC-1-1:100::RXPKTS,1-UP,30S,2004-4-5,;
Normal LoopStar 800 2004-05-24 17:07:43
M 100 COMPLD
"FAC-1-1,GETH:RXPKTS,2004-04-05,14-05-18,0,30"
"FAC-1-1,GETH:RXPKTS,2004-04-05,14-05-48,0,29"
"FAC-1-1,GETH:RXPKTS,2004-04-05,14-06-18,0,30"
"FAC-1-1,GETH:RXPKTS,2004-04-05,14-06-48,0,32"
"FAC-1-1,GETH:RXPKTS,2004-04-05,14-07-19,0,30"
;
Error LoopStar 800 2004-01-01 14:28:13
M 100 DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,RMON_QUERY_NULL*/
/*0X9CA6*/
;
Notes
2-334 LPS800-UM-COMM-02
Command RTRV-RMONSTAT-<MOD2>
Explanation Retrieve RMON state (fast Ethernet, Gigabit Ethernet, all).
Function This command retrieves the current performances message.
Category RMON
Security Retrieve
Related Messages
Input Format RTRV-RMONSTAT-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],
[<MONLEVEL>];
null.
<MONTYPE> <MONTYPE> is all the RMON parameters supported, see
section "RMON" in Charpter 3 TL1 Parameters. Default
value is ALL.
is 1-up.
Format
^^^<rsphdr><cr><lf>
^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONLEVEL>,<MONDAT>,<MONTM>,
<H4B>,<L4B>"<cr><lf>
;
Error
LPS800-UM-COMM-02 2-335

<AID> Valid format is FAC-<SLOT ID>-<PORT ID>.
<MONTYPE> Performance ID. See section "RMON" in Chapter 3: TL1
Parameters.
is 1-up.
specified in <TMPER>.The format of <MONDAT> is YYYY-
MM-DD. A null value for <MONDAT> defaults to the current
date.
specified in <TMPER>. A null value for <MONTM> defaults
to the current time (HH-MM-SS).
<VALUE> PM value.
Errors
Example Input RTRV-RMONSTAT-ALL:::100::RXPKT64,1-UP;
Normal LoopStar 800 2004-05-24 17:07:43
M 100 COMPLD
"FAC-1-1,GETH:RXPKT64,2004-04-05,14-49-40,0,1000"
"FAC-1-2,FETH:RXPKT64,2004-04-05,14-49-40,0,118"
"FAC-2-1,GETH:RXPKT64,2004-04-05,14-49-40,0,112"
;
Error LoopStar 800 2004-01-01 14:28:13
M 100 DENY
IDRG
/*DATA RANGE ERROR,RMON_BID_ERROR*/
/*0X9CA0*/
;
Notes
RTRV-RSLT-<T1/T3>
Command RTRV-RSLT-<T1/T3>
Explanation Retrieve result (T1/T3).
Function This command retrieves the result of bit sequence test connection with all
necessary setting for the internal bit sequence generator and detector.
2-336 LPS800-UM-COMM-02
Category Facility
DISC-TST-<T1/T3>
REPT RSLT <T1/T3>
Input Format RTRV-RSLT-<T1/T3>:[<TID>]:<AID>:<CTAG>;
^^^<rsphdr><cr><lf>
^^^"<AID>::<AID>:IPFLAG=<IPFLAG>,ET=<ET>,ESAIS=<ESAIS>[-
<OC>],ESLSS=<ESLSS>[-<OC>],ESBE=<ESBE>[-<OC>],TBE=<TBE>[-
<OC>]"
;
<IPFLAG> Flag identifies whether the test is in process or completed.
Valid value is IP (in progress) and COMPLD (completed).
<ET> Elapsed time of testing. The unit is minute.
<ESAIS> Errored seconds count based on AIS detected. If the count
reaches the maximum, a literal "OC" is added following it.
<ESLSS> Errored seconds count based on LSS (Loss of sequence
synchronization) detected. If the count reaches the maximum,
a literal "OC" is added following it.
<ESBE> Errored seconds count based on bit error detected. If the
count reaches the maximum, a literal "OC" is added
following it.
<TBE> Total bit error count (32 bit counter). If the count reaches the
Notes 1. All maximum values of these counters are 2E23 - 1 = 4,294,967,295.
2. The priority from high to low of these events are AIS, LSS.
3. "OC" means out of count.
RTRV-SERIAL
Command RTRV-SERIAL
Explanation Retrieve serial.
Function This command retrieves the parameter of the serial.
Security Retrieve
LPS800-UM-COMM-02 2-337
Related Messages ED-SERIAL

Input Format RTRV-SERIAL:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"BAUDRATE=<BAUDRATE>,LINKWAY=<LINKWAY>,WORKSTATE=<WO
RKSTATE>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<BAUDRATE> The baud rate of the serial. Valid values are 1200, 2400,
4800, 9600, 19200, 38400, 57600 or 115200.
<LINKWAY> The link way of serial. Valid values are TL1, MML or NMS.
<WORKSTATE> Work state. Valid value is OPEN or CLOSE.
Errors
Example Input RTRV-SERIAL:::C;
Normal LoopStar 800 2004-05-24 17:07:43
M C COMPLD
"38400,TL1,OPEN"
;
Error
Notes
RTRV-SNMPTRAPINFO
Command RTRV-SNMPTRAPINFO
Explanation Retrieve SNMP trap information.
2-338 LPS800-UM-COMM-02
Function This command retrieves the SNMP trap information. The information includes the IP
address and the port number of Network Manager, the read community, the write
community and the version of the trap.
Category SNMP
Security Retrieve
Related Messages DLT-SNMPTRAPINFO
Input Format RTRV-SNMPTRAPINFO:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"IP=<IPADDRESS>,PORT=<PORTNUMBER>,RCOMMUNITY=<RDCOMMUNIT
Y>,WCOMMUNITY=<WTCOMMUNITY>,TRAPVER=<TRAPVERSION>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<IPADDRESS> IP address. The valid value is A, B and C type IP address.
<PORTNUMBER> The UDP connection port number.
<RDCOMMUNITY> Read community.
<WRITECOMMUNITY> Write community.
<TRAPVERSION> SNMP trap version.
Errors IDMS
Example Input RTRV-SNMPTRAPINFO:::100;
Normal LoopStar 800 2004-05-24 17:07:43
M 100 COMPLD
"IP=129.9.0.5,PORT=162,RCOMMUNITY=PUBLIC,WCOMMUNITY=PRIVATE,TRAP
VER=1"
;
Error LoopStar 800 2004-05-24 17:07:43
M 100 DENY
IDMS
/*DATA MISSING, trap information is empty*/
;
Notes
LPS800-UM-COMM-02 2-339
RTRV-SQL-<STS_PATH>
Command RTRV-SQL-<STS_PATH>
Explanation Retrieve squelch table (STS1, STS3C, STS6C, STS9C, STS12C, STS24C, STS48C,
STS192C).
Function This command retrieves the squelch table entries for the addressed NE.
Category BLSR
Security Retrieve
DLT-SQL-<STS_PATH>
ED-SQL-<STS_PATH>
INIT-SQL-<STS_PATH>
Input Format RTRV-SQL-<STS_PATH>:[<TID>]:[<AID>]:<CTAG>;
STS192C.
<AID> Identifies the STS path for which the entry is to be retrieved.
This is optional parameter. If not entered, all entries will be
retrieved. Value is applicable STS AID.
Format
^^^<rsphdr><cr><lf>
^^^("<AID>::SRC=<SRC>,DST=<DST>"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-340 LPS800-UM-COMM-02

<AID> Identifies the STS path for which the entry is to be edited/
entered. Value is applicable STS AID.
<SRC> Source node ID of incoming path where the path entered the
ring. Valid value ranges from 0 to 15.
<DST> Destination node ID of outgoing path where the path
dropped the ring. Valid value ranges from 0. to 15.
Errors
Normal LoopStar 800 2004-05-24 17:07:43
M 100 COMPLD
"STS-3-1-1:SRC=1,DST=2"
;
Error LoopStar 800 2004-05-24 17:07:43
M 100 DENY
IPNV
;
RTRV-STAT-DCC
Command RTRV-STAT-DCC
Explanation Retrieve state DCC.
Function This command retrieves the DCC information of a OC-N facility, including the data
transmitting information and error information.
Security Retrieve
Related Messages INIT-STAT-DCC
Input Format RTRV-STAT-DCC:[<TID>]:<AID>:<CTAG>;
<AID> DCC AID identifier. See section "DCC" in Chapter 3: TL1
Parameters.
LPS800-UM-COMM-02 2-341

Format
^^^<rsphdr><cr><lf>
^^^"SCC-NO=<SCC-NO>,PEER-SCC-NO=<PEER-SCC-NO>,RECV-
PACKET=<RECV-PACKET>,RECV-BYTE=<RECV-BYTE>,SEND-
PACKET=<SEND-PACKET>,SEND-BYTE=<SEND-
BYTE>,QFULL=<QFULL>,NO=<NO>,CR=<CR>,AB=<AB>,UN=<UN>,RXF=<RXF>,
TXB=<TXB>,CRCERRS=<FCS-ERRORS>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> DCC AID identifier.
<SCC-NO> CPU channel number.
<PEER-SCC-NO> The peers CPU channel number. If it is 255, it means the
peer CPU channel number cannot be retrieved. It is 255 only
when the protocol of this AID is not ECC.
<RECV-PACKET> Received packet number.
<SEND-PACKET> Send packet number.
<RECV-BYTE> Received byte number.
<SEND-BYTE> Send byte number.
<QFULL> The number of the send queue is full.
<NO> The NO error times.
<CR> The CRC error times.
<AB> The AB error times.
<UN> The UN error times.
<RXF> The RxF error times.
<TXB> The TxB error times.
Errors
2-342 LPS800-UM-COMM-02
Example Input RTRV-STAT-DCC::DCC-6-1-1:C;

Normal LoopStar 800 2004-05-24 17:07:43
M C COMPLD
"DCC-2-1-1,0,255,0,6274,0,112932,0,0,0,0,0,0,6274"
;
Error LoopStar 800 2004-05-24 17:07:43
M C DENY
SDNC
/*INPUT DATA IS NOT CONSISTENT WITH NE DATA,ERROR IN PARAMETER*/
;
Notes When retrieving the DCC state, the protocol type of DCC cannot be TRANSPARENT.
RTRV-STATE
Command RTRV-STATE
Explanation Retrieve state.
Function This command retrieves the system state during software downloading (SWDL).
Category System
Related Messages
Input Format RTRV-STATE:[<TID>]::<CTAG>::<FTYPE>;
<FTYPE> The software download or upload type. Valid values are:
• SWDL (software package downloading from remote PC
to NE);
• DBFDL (downloading database from PC to NE);
• DBFUL (uploading database from NE to PC).
LPS800-UM-COMM-02 2-343

Format
^^^<rsphdr><cr><lf>
^^^"FTYPE=<FTYPE>,MAINSTATE=<MAINSTATE>,SUBSTATE=<SUBSTATE>"<cr
><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<FTYPE> The software download or upload type.
<MAINSTATE> The state of downloading. Valid values are NORMAL,
CPYFILESTART, CPYFILEEND, CPYMEMSTART,
CPYMEMEND, ACTIVE, ACTIVATED, ROLLBACK,
UPLOADING, DOWNLOADING, DOWNLOADEND or
CPYFILEHALT.
<SUBSTATE> The substate of downloading. Valid value is NORMAL or
CPYFILEHALT.
Errors
Example Input RTRV-STATE:::100::SWDL;
Normal LoopStar 800 2004-05-24 17:07:43
M C COMPLD
"FTYPE=DBFUL,MAINSTATE=NORMAL,SUBSTATE=NORMAL"
;
Error LoopStar 800 2004-05-24 17:07:43
M C DENY
SDNC
/*INPUT DATA IS NOT CONSISTENT WITH NE DATA,ERROR IN PARAMETER*/
;
Notes
2-344 LPS800-UM-COMM-02
RTRV-STAT-TCP
Command RTRV-STAT-TCP
Explanation Retrieve state TCP.
Function This command retrieves all the TCP connections information.
Category
Security Retrieve
Related Messages
Input Format RTRV-STAT-TCP:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"PEER-IP=<PEERIPADDR>,PORT=<PORT>,PEER-
PORT=<PEERPORT>,RECV-PACKET=<RECV-PACKET>,RECV-BYTE=<RECV-
BYTE>,SEND-PACKET=<RECV-PACKET>,SEND-BYTE=<SEND-
BYTE>,CONNTIMES=<CONNTIMES>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<PEERIPADDR> The TCP connection IP address of peer.
<PORT> The TCP connection port number of self.
<PEERPORT> The TCP Connection port number of peer.
<RECV-PACKET> Received packet number.
<SEND-PACKET> Send packet number.
<RECV-BYTE> Received byte number.
<SEND-BYTE> Send byte number.
<CONNTIMES> Connect times.
Errors
LPS800-UM-COMM-02 2-345
Example Input RTRV-STAT-TCP::LAN-1:C;

Normal LoopStar 800 2004-05-24 17:07:43
M C COMPLD
"129.9.0.128,1400,1893,84,1448,145,10560,1"
;
Error
Notes
RTRV-SYNC
Command RTRV-SYNC
Explanation Retrieve synchronization.
Function This command retrieves the attributes of one or all synchronization reference lists
of NE. Each NE has three synchronization reference lists. They are system clock
reference list, output clock reference list of BITS-1, and output clock reference list
of BITS-2.
Security Retrieve
Related Messages ED-SYNC
Input Format RTRV-SYNC:[<TID>]:<AID>:<CTAG>;
Valid values are:
• SYNCCLOCK (system clock reference list)
• Null for all three lists
2-346 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^("<AID>::TMGMODE=<TMGMODE>,SSMMAP=<SSMMAP>,SSMEN=<SSME
N>,PNO=<PRO>,RVRTV=<RVRTV>,[RVTM=<RVTM>,]CLOCKMODE=<CLOCK
MODE>;"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-347

<TMGMODE> Timing Mode. Valid values are INT (internal mode), EXT
(external mode), LINE (line mode), or MIXED (mixed mode).
Default value can be the following:
• For SYNCCLOCK of LoopStar 1600 and 800, the default will
be EXT.
• For SYNCOUT-1 and SYNCOUT-2 of LoopStar 1600 and
800, the default will be LINE.
• For SYNCCLOCK of LoopStar 810, the default will be LINE.
<SSMMAP> Map for outgoing SSM to 1st generation synchronization status
messages. Valid values are:
• Y (map the outgoing SSM to GEN1);
• N (Map the outgoing SSM to GEN2).
• Default value is N. This attribute will affect all the three
<SSMEN> Enable use of synchronization status messages. Valid value is Y
(enable) or N (disable). Default value is N. This attribute will
affect all the three synchronization reference lists.
<PNO> SSM value that user provisionable. See section "RES" for detail.
Default value is DUS. This attribute will affect all the three
<RVRTV> Support revertive or nonrevertive switching. Valid value is Y
(revertive mode) or N (non-revertive mode). Default value is N.
<RVTM> Wait to restore timer after the fail reference restore to good.
Valid value ranges from 0 to 12 (min). Default value is 5 (min).
This attribute can be modified and will effect only if the
<RVRTV> is Y.
<CLOCKMODE> Current clock mode of a synchronization reference list. Valid
values are:
• NORMAL (tracking mode);
• HOLDOVER (hold over state for the clock that just failure
before change to others);
• FAST-START (the clock is in fast-start state);
• FREE-RUN (the clock is tracking the internal clock).
• For SYNCOUT-1 and SYNCOUT-2, if the reference list is
null or all the references in the list are failure, it will track the
clock of SYNCCLOCK, so SYNCOUT-1 and SYNCOUT-2
will not be in the free-run mode.
Errors
2-348 LPS800-UM-COMM-02
Example Input RTRV-SYNC::SYNCCLOCK:C;

Normal LoopStar 800 2004-10-15 09:30:48
M C COMPLD
"SYNCCLOCK::TMGMODE=LINE,SSMMAP=Y,SSMEN=N,PNO=ST3,RVRTV=Y,
RVTM=5,CLOCKMODE=FREE-RUN"
;
Error LoopStar 800 2004-10-15 09:32:02
M C DENY
;
Notes
RTRV-SYNCLIST
Command RTRV-SYNCLIST
Explanation Retrieve synchronization reference list.
Function This command retrieves the synchronization reference list and the attributes of the
reference source that is in the list.
Security Retrieve
Related Messages ED-SYNCLIST
Input Format RTRV-SYNCLIST:[<TID>]:<AID>:<CTAG>;
Valid values are:
• SYNCCLOCK (system clock reference list),
• SYNCOUT-1 (output clock reference list of BITS-1),
• Null value for all three lists.
LPS800-UM-COMM-02 2-349
Output Normal <cr><lf><lf>^^^<rsphdr><cr><lf>

Format
^^^("<AID>::<SYNCAID>,<MANSSM>,<REFSSM>, <STATE>;"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<AID> Access Identifier of synchronization reference list.
<SYNCAID> Timing reference facility AIDs. See the "SYNCAID" section in
Chapter 3: TL1 Parameters for details.
<MANSSM> Manually set the S1 byte of timing reference. NE will presses the
timing switch base on this parameter as the quality of the
incoming synchronous source. Valid values are STU, PRS, ST2,
TNC, ST3E, ST3, PNO, CLEAR or DUS. Default value is
CLEAR. PNO mean the RES quality class that the user
provisioned. See the "RES" section in Chapter 3: TL1
Parameters for details.
<REFSSM> Detected incoming SSM for the timing reference facility. Valid
values are PRS, ST2, TNC, ST3E, ST3 , DUS or PNO. This
attribute means the SSM that NE uses to process the timing
switch.
<STATE> State of timing reference facility. See the "SYNCSTATE" section
in Chapter 3: TL1 Parameters for details.
Errors
2-350 LPS800-UM-COMM-02
Example Input RTRV-SYNCLIST::SYNCCLOCK:C;

Normal LoopStar 800 2004-10-15 09:30:48
M C COMPLD
"SYNCCLOCK::BITSIN-1,TNC,DUS,REFFAIL"
"SYNCOUT-1::FAC-3-1,PRS,PRS,NORMAL"
"SYNCOUT-1::FAC-5-1,DUS,DUS,FRCD&DQL"
"SYNCOUT-1::FAC-5-2,STU,STU,NORMAL"
"SYNCOUT-1::FAC-6-1,CLEAR,ST3,NORMAL"
"SYNCOUT-2::BITSIN-1,TNC,DUS,REFFAIL"
"SYNCOUT-2::BITSIN-2,CLEAR,DUS,REFFAIL"
;
Error LoopStar 800 2004-10-15 09:32:02
M C DENY
;
Notes
RTRV-SYS
Command RTRV-SYS
Explanation Retrieve system.
Function This command retrieves the attributes of the system.
Category System
Security Retrieve
Related Messages ED-SYS
INIT-SYS
Input Format RTRV-SYS:[<TID>]::<CTAG>;
LPS800-UM-COMM-02 2-351

Format
^^^<rsphdr><cr><lf>
^^^"DEVICETYPE=<DEVICETYPE>,SHELFTYPE=<SHELFTYPE>,AUTOP=<AUTO
P>,LPBKSAVEFLAG=<LPBKSAVEFLAG>,NELOCATION=<NELOCATION>,NEMEM
O=<NEMEMO>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<DEVICETYPE> Device type. Valid values are LOOPSTAR800,
LOOPSTAR800C, and LOOPSTAR1600.
<SHELFTYPE> Shelf type. Valid value is TYPE_I or TYPE_II.
<AUTOP> Auto-provisioning enable flag. Valid value is Y (support unit
auto-provisioning) or N (do not support unit auto-provisioning).
<LPBKSAVEFLAG> The flag which indicates whether the loopback is saved in
database or not. Valid value is Y (save), or N (not save).
<NELOCATION> NE location. Valid value is a 32 bytes string.
<NEMEMO> NE memo. Valid value is a 64 bytes string.
Errors
Example Input RTRV-SYS:::C;
Normal LoopStar 800 2004-10-15 09:30:48
M C COMPLD
"DEVICETYPE=METRO800,SHELFTYPE=TYPE_I,AUTOP=Y,LPBKSAVEFLAG=Y,
NELOCATION="NEW YORK", NEMEMO="North-east 4BLSR ring"
;
Error LoopStar 800 2004-10-15 09:32:02
M C DENY
PLNA
;
Notes
2-352 LPS800-UM-COMM-02
RTRV-T1
Command RTRV-T1
Explanation Retrieve T1
Function This command retrieves attributes of the DS1 facilities.
Category Facility
Security Retrieve
Related Messages ED-T1
Input Format RTRV-T1:[<TID>]:<AID>:<CTAG>;
T3" in Chapter 3: TL1 Parameters.
Format
^^^<rsphdr><cr><lf>
^^^"<FAC>::LBO=<LBO>,LINECDE=<LINECDE>,FMT=<FMT>,SVTIMER=<SV
TIMER>,TACC=<TACC>:<PST>[,<SST>]"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-353

<FAC> Facility AID.
BUILD OUT" in Chapter 3: TL1 Parameters.
<LINECDE> Line coding. Valid value is AMI or B8ZS.
<FMT> Frame format. Valid value is SF, ESF or UNFRAMED.
section "SVTIMER" in Chapter 3: TL1 Parameters.
section "TACC" in Chapter 3: TL1 Parameters.
shown in section "PST_STATE" in Chapter 3: TL1
Parameters..
<SST> Secondary state. Valid values are shown in section
"SST_STATE" in Chapter 3: TL1 Parameters..
Errors
Example Input RTRV-T1::FAC-4-1:C;
Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
"FAC-4-1::LBO=1,LINECDE=AMI,FMT=SF,SVTIMER=00-01,TACC=1::OOS-
MA"
;
Error LoopStar 800 2004-03-08 14:30:00
M C COMPLD
IDNV
/*Input Data Not Valid*/
;
Notes 1. Valid value for PST is IS-NR, OOS-AU, OOS-MA or OOS-AUMA.
2. Valid value for SST is AINS, MT, LPBK, SGEO, FAF or TS.
RTRV-T3
Command RTRV-T3
Explanation Retrieve T3
Function This command retrieves the DS3 facilities configuration.
Category Facility
Security Retrieve
2-354 LPS800-UM-COMM-02
Related Messages ED-T3

ENT-T3
DLT-T3
Input Format RTRV-T3:[<TID>]:<AID>:<CTAG>;
Format
^^^<rsphdr><cr><lf>
^^^"<AID>::REQ=<REQ>,LBO=<LBO>,FMT=<FMT>,LINECDE=<LINECDE>,S
VTIMER=<SVTIMER>,TACC=<TACC>:<PST>[,<SST>]]"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-355

<REQ> High or low receive equalizer. Valid value is HIGH (high
receive equalizer gain), or LOW (low receive equalizer gain).
Default value is HIGH.
The higher gain setting is designed to optimally equalize a
nominally shaped (meets the pulse template) pulse driven
DS3 or STS-1 waveform that is driven into 0 feet to 900 feet
of cable. Square shaped pulses such as E3 or DS3-HIGH
require less high frequency gain and should use the low EQ
gain setting.
BUILD OUT" in Chapter 3: TL1 Parameters.
<FMT> Frame format. Valid values are CBIT, M23 or UNFRAMED.
Default is CBIT.
For PDM3 unit, if the port type is DS3_ASYN_STS1, then
<FMT> can be CBIT, M23 or UNFRAMED. If the port type is
DS3_TMUX_DS1, then the <FMT> only can be CBIT or
M23. See <INTFTYPE> parameter in ED-EQPT command
for the detail information of DS3 port type.
<LINECDE> DS3 line code. Valid value is B3ZS.
section "SVTIMER" in Chapter 3: TL1 Parameters.
<TACC> <TACC> defines the T3 port as a test access port with a
table TACC.
<PST> <PST> means the primary state of the entity.
Valid values for this are shown in the "PST_STATE" section
<SST> <SST> means the secondary state of the entity.
Valid values for this are shown in the "SST_STATE" section
Errors
Example Input RTRV-T3::FAC-4-1:C;
Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
"FAC-4-1::LBO=1,FMT=CBIT,LINECDE=B3ZS,SVTIMER=00-
01,TACC=1:OOS-MA"
;
Error LoopStar 800 2004-03-08 14:30:00
M C COMPLD
PLNA
;
2-356 LPS800-UM-COMM-02
Notes 1. Valid value for PST is IS-NR, OOS-AU, OOS-MA, or OOS-AUMA.

2. Valid value for SST is AINS, MT, LPBK, SGEO, FAF, TS, ACT, STYC,
or STYH.
RTRV-TACC
Command RTRV-TACC
Explanation Retrieve test access.
Function This command retrieves details associated with a test access port (TAP). The
TAP is identified by the TAP number. The ALL input TAP value means that the
command will return all the configured TACCs in the NE.
Category Test Access
Security Retrieve
Related Messages CONN-TACC-<T1/T3>
CHG-TACC-<T1/T3>
DISC-TACC
Input Format RTRV-TACC:[<TID>]:[< TAP >]:<CTAG>;
<TAP> <TAP> indicates the assigned numeric number for the AID
being used as a TAP. The TAP number must be an integer with
a range from 1 to 999. The ALL means that the command will
return all the configured TACCs in the NE. <TAP> is a string.
NULL value means retrieving all.
^^^"<TAP>,<FROM>,<TO>,<TACCMODE>"
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
LPS800-UM-COMM-02 2-357

<TAP> <TAP> defines the T1 port as a test access port with a selected
unique TAP number. The TAP number ranges from 1 to 999.
<TAP> is an integer.
<FROM> <FROM> is the facility AID that was designated as a test
access point and assigned to the TAP.
<TO> <TO> indicates the E side AID of a circuit connected to the
TACC or under test.
<TACCMODE> <TACCMODE> indicates the test access mode,
<TACCMODE> must not be null. Valid values are:
• MONE (monitor access with signal detector on A path);
• MONF (monitor access with signal detector on B path);
• MONEF (monitor access with signal detector on A and B
paths);
• SPLTA (split access on A path with signal detector from
equipment, QRS on facility side);
• SPLTB (split access on B path with signal detector from
• SPLTE (split access on A and B paths with signal detector
from equipment, QRS on equipment side);
• SPLTF (split access on A and B paths with signal detector
from facility, QRS on facility side);
• SPLTEF (Split access on A and B paths for testing in both
equipment and facility directions).
Errors
Example Input RTRV-TACC:SONET-NE:255:C;
Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
"255,FAC-5-3,FAC-5-1,MONE"
;
Error LoopStar 800 2004-03-08 14:30:00
M C DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,CFG_GET_NULL*/
/*0X9706*/
;
Notes
2-358 LPS800-UM-COMM-02
RTRV-TH-<MOD2>
Command RTRV-TH-<MOD2>
Explanation Retrieve threshold (ALL, OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C,
STS12C, STS48C, STS192C, VT1).
Function This command instructs an NE to send the current threshold level of one or more
monitored parameters for which violation will trigger an automatic message.
These threshold levels may apply to one or more equipment units, facilities,
subscriber lines, trunks, links, packet links, or signaling links in the NE.
Security Retrieve
Related Messages SET-TH-<MOD2>
Input Format RTRV-TH-<MOD2>:[<TID>]:[<AID>]:<CTAG>[::[<MONTYPE>],[<LOCN>],
[<TMPER>]];
<MOD2> The second modifier of the report message which identifies the
type of the entity that reports trouble. Valid values are ALL,
OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C, STS12C,
STS48C, STS192C or VT1.
<AID> Access identifier identifies the equipment unit, facility,
NE, depending on the command code modifier, for which
threshold levels are being retrieved.
requested. Null value is ALL.
connected to the identified entity. A null value is equivalent to
NEND.
<TMPER> Specifies the accumulation time period for the PM information.
A null value is 15m.
LPS800-UM-COMM-02 2-359

Format
^^^<rsphdr><cr><lf>
<rspblk>+
;

^^^"<AID>,[<AIDTYPE>]:<MONTYPE>,[<LOCN>],[<DIRN>],<THVAL>,[<TMPE
R>]"<cr><lf>
The normal response MUST contain at least one occurrence of <rspblk>. It is
allowed to contain multiple <rspblk>s if applicable.
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

allowed.
<MONTYPE> Identifies the particular monitored parameter for which
threshold level is being retrieved.
<LOCN> The location from where the threshold is being retrieved and
refers to the entity Identified by the AID. Thus, NEND (near
end) refers to the threshold of a parameter being monitored at
the identified entity, and FEND (far end) refers to the threshold
of a parameter being monitored at a distant entity that is
connected to the identified entity.
<DIRN> Identifies the direction of the threshold level being reported and
is relative to the entity identified by the AID. Valid value is
<THVAL> The current threshold level for the monitored parameter.
Errors
2-360 LPS800-UM-COMM-02
Example Input RTRV-TH-T1::FAC-5-1:C::LPBBE,NEND,15-MIN;

Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
"FAC-5-1,T1:LPBBE,NEND,RCV,30,20,15-MIN"<cr><lf>
;
Error LoopStar 800 2004-03-08 14:30:00
M C DENY
PLNA
;
Notes
LPS800-UM-COMM-02 2-361
RTRV-TH-ALL
Command RTRV-TH-ALL
Explanation Retrieve threshold all.
Function This command instructs an NE to send the current threshold level of all
monitored parameters for which violation will trigger an automatic message.
These threshold levels may apply to one or more equipment units, facilities,
subscriber lines, trunks, links, packet links, or signaling links in the NE.
Security Retrieve
Related Messages RTRV-TH-<MOD2>
Input Format RTRV-TH-ALL:[<TID>]::<CTAG>[::[<MONTYPE>],[<LOCN>],[<TMPER>]];
requested. A null value is ALL.
connected to the identified entity. A null value is near end.
Valid value is 15-MIN or 1-DAY. A null value is 15-MIN.
2-362 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
<rspblk> +
;

^^^"<AID>[,<AIDTYPE>]:<MONTYPE>,[<LOCN>],[<DIRN>],<THVAL>,[<TMPE
R>]"<cr><lf>
The normal response MUST contain at least one occurrence of <rspblk>. It is
allowed to contain multiple <rspblk>s if applicable.
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;

allowed.
<MONTYPE> Identifies the particular monitored parameter for which
threshold level is being retrieved.
<LOCN> The location from where the threshold is being retrieved and
refers to the entity identified by the <AID>. Thus, NEND (near
end) refers to the threshold of a parameter being monitored at
the identified entity, and FEND (far end) refers to the threshold
of a parameter being monitored at a distant entity that is
connected to the identified entity.
<DIRN> Identifies the direction of the threshold level being reported and
is relative to the entity identified by the AID. Valid value is
<THVAL> The current threshold value for the monitored parameter. Valid
data types for <THVAL> for a given <MONTYPE> are the
same as those for the corresponding <MONVAL>.
LPS800-UM-COMM-02 2-363
Errors
Example Input RTRV-TH-ALL:::C::LPBBE,NEND,15-MIN;
Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
"FAC-5-1,T1:LPBBE,NEND,RCV,30,20,15-MIN"
;
Error LoopStar 800 2004-03-08 14:30:00
M C DENY
PLNA
;
Notes
RTRV-TIDIPMAP
Command RTRV-TIDIPMAP
Explanation Retrieve TID-IP mapping.
Function This command retrieves all the static TID-IP mapping information.
Security Retrieve
Related Messages ENT-TIDIPMAP
DLT-TIDIPMAP
Input Format RTRV- TIDIPMAP:[<TID>]::<CTAG>;
2-364 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
^^^"TID=<TID>,IP=<IPADDR>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<IPADDR> The IP address of the NE.
<MODE> In which mode the map relationship between <TID> and
<IPADDR> get. Valid value is AUTOMODE or MANMODE.
Errors
Example Input RTRV-TIDIPMAP:::C;
Normal LoopStar 800 2004-07-31 11:30:50
M C COMPLD
"NE240,129.9.0.1,MANMODE"
;
Error LoopStar 800 2004-07-31 11:32:12
M C DENY
IENE
/*SPECIFIED OBJECT ENTITY DOES NOT EXIST,NO INFORMATION
FOUND*/
;
Notes
RTRV-TOD
Command RTRV-TOD
Explanation Retrieve time of day.
LPS800-UM-COMM-02 2-365
Function This command retrieves the system date and time at the instant when the
command was executed. The time returned is in Coordinated Universal Time
(UTC).
Category System
Security Retrieve
Related Messages
Input Format RTRV-TOD:[<TID>]::<CTAG>;

Format
^^^<rsphdr><cr><lf>
^^^"<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,<TMTYPE>"
<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<YEAR> The current calendar year ranges from 1990 to 2087.
<MONTH> The month of the year ranges from 01 to 12.
<DAY> The day of the month ranges from 01 to 31.
<HOUR> The hour of the day ranges from 00 to 23.
<MINUTE> The minute of the hour ranges from 00 to 59.
<SECOND> The minute of the hour ranges from 00 to 59.
<TMTYPE> The type of time being returned. The value of this parameter is
fixed at Coordinated Universal Time (UTC).
Errors
2-366 LPS800-UM-COMM-02
Example Input RTRV-TOD:::C;

Normal LoopStar 800 2004-07-31 11:30:50
M C COMPLD
"2004,02,23,12,23,20,UTC"
;
Error LoopStar 800 2004-07-31 11:32:12
M C DENY
IIDT
/*INVALID DATA PARAMETER*/
;
Notes
LPS800-UM-COMM-02 2-367
RTRV-TPL-<OCN>
Command RTRV-TPL-<OCN>
Explanation Retrieve topology (OC12, OC48, OC192).
Function This command retrieves the topology map at the addressed node.
Category BLSR
Security Retrieve
Related Messages ED-TPL-<OCN>
INIT-TPL-<OCN>
Input Format RTRV-TPL-<OCN>:[<TID>]:[<AID>]:<CTAG>;
Valid values are OC12, OC48 or OC192.
<AID> AID of any OC-N facility associated with the BLSR protection
group. It is an optional parameter. If not given, the default is "ALL"
which means that all FFP groups are retrieved.
Format
^^^<rsphdr><cr><lf>
^^^("<WORK>,<PROTECT>::RINGMAP=<RINGMAP>"<cr><lf>)+
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-368 LPS800-UM-COMM-02

<PORT ID>.
(West1Port).
If <FFPTYPE> is 4BLSR, this parameter is the two west optical
ports (West1Port&West2Port).
<WORK> Working optical facilities protected by <PROTECT>. Valid
format is FAC-<SLOT ID>-<PORT ID>.
If <FFPTYPE> is 2BLSR, this parameter is the east port
(East1Port).
If <FFPTYPE> is 4BLSR, this parameter is the two east optical
ports (East1Port&East2Port).
<RINGMAP> Node IDs. They must be unique with rest of the node IDs
entered. Any number of values 0 through 15 may be entered.
Does not have to be consecutive.
Errors
Example Input RTRV-TPL-OC12:SONET-NE::100;
Normal LoopStar 800 2004-07-31 11:30:50
M 1 COMPLD
"FAC-1-1,FAC-1-2:::RINGMAP=1&2"
;
Error LoopStar 800 2004-07-31 11:32:12
M 1 DENY
IPNV
/*0X9742*/
;
RTRV-TST-<T1/T3>
Command RTRV-TST-<T1/T3>
Explanation Retrieve test (T1, T3).
Function This command retrieves the bit sequence test connection.
Category Facility
Security Retrieve
LPS800-UM-COMM-02 2-369

DISC-TST-<T1/T3>
Input Format RTRV-TST-<T1/T3>:[<TID>]:<AID>:<CTAG>;
^^^"<AID>::<TSTMD>,<TSTSIG>,<DUR>,<RI>"<cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-370 LPS800-UM-COMM-02

<TSTMD> <MD> indicates the requested test mode, it is similar to test
access mode. The expected entries for this parameter are
listed below:
MONE indicates a monitor connection of a internal signal
presence detector on the A transmission path.
MONF indicates a monitor connection of a signal presence
detector on the B transmission path.
SPLTA indicates split the A transmission path, connect a test
signal in the F direction, and a signal presence detector in
the E direction.
SPLTB indicates split the B transmission path, connect a test
signal in the E direction, and a signal presence detector in
the F direction.
SPLTE indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the E
direction and a test signal to the line outgoing in the E
direction. The line outgoing in the F direction shall have a
AIS signal connected, and the line incoming from the F
direction shall be terminated by the nominal characteristic
impedance of the line.
SPLTF indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the F
direction and a test signal to the line outgoing in the F
direction. The line outgoing in the E direction shall have a
AIS signal connected, and the line incoming from the E
LOOPE indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the E
direction and connect this line to the line outgoing in the E
direction. The line outgoing in the F direction shall have a
AIS signal connected, and the line incoming from the F
LOOPF indicates split both the A and B paths and connect a
signal presence detector to the line incoming from the F
direction and connect this line to the line outgoing in the F
direction. The line outgoing in the E direction shall have a
AIS signal connected, and the line incoming from the E
Note: MONEF and SPLTEF aren't supported for there is only
one pair of test signal generator and detector provided.
LPS800-UM-COMM-02 2-371
Output Parameter <TSTSIG> Pattern of test signal generated at the bit sequence
(cont.) generator, and expected at the bit sequence detector. The
valid values are listed below:
2E23 indicates the conventional pseudo-random pattern with
bit sequence length of 2E23 -1.
2E15 indicates the conventional pseudo-random pattern with
bit sequence length of 2E15 -1.
<DUR> The time in minutes that bit sequence test sustains.The
expected time should be from 0 to 9999 minutes. "0" (CO) in
this field indicates the test shall continue until terminated by
the DISC-TST-<T1/T3> command.
<RI> Report Interval in seconds. Valid value ranges from 1 to
3600.
Errors
Example Input RTRV-TST-T1::FAC-3-1:123;
Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"FAC-3-1::MONE,2E23,1,1"
;
Error LoopStar 800 2004-03-15 15:54:55
M 1 DENY
IPNV
/*0X9742*/
;
Notes
RTRV-USER-SECU
Command RTRV-USER-SECU
Explanation Retrieve user security.
Function This command retrieves the security attributes of a user.
Category Security
Security Retrieve
Related Messages
Input Format RTRV-USER-SECU:[<TID>]:[<UID>]:<CTAG>;
2-372 LPS800-UM-COMM-02

<UID> User identifier which is to be retrieved. It is any combination of
4 to 16 alphanumeric characters. It is a string; a null value
means all users.
Format
^^^<rsphdr><cr><lf>
^^^<UID>:,<UPC>:TMOUTEN=<TMOUTEN>,TMOUTLN=<TMOUTLN>,PAGE=<PA
GE>,UAGE=<UAGE>,USTATE=<USTATE>,LASTLOGINTM=<LASTLOGINTIME>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
<UID> User identifier.
(superuser).
<TMOUTEN> The flag which allows user can cancel automatically. Valid
value ENABALE or DISABALE.
effective when <TMOUTEN> is ENABALE.
is day, and it ranges from 25-999.
time is day, and it ranges from 1 ro 999.
<USTATE> The state of a user. Valid states are
INACT/ACT (online or not online);
ALW/INH (the user is allowed or forbidden to be used);
UIDUNEXP/UIDEXP (the user is in time or out of time);
PIDUNEXP/PIDEXP (the password is in time or out of time).
<LASTLOGINTIME> The user lastest login date and time. Valid format is YYYY-MM-
DD HH-MM-SS. For exmple, 2004-12-08 14-20-26.
Errors
LPS800-UM-COMM-02 2-373
Example Input RTRV-USER-SECU::USERNAME:C;

Normal LoopStar 800 2004-03-15 15:54:55
M C COMPLD
"USERNAME:,RTRV:TMOUTEN=ENABLE,TMOUTLN=60,PAGE=0,UAGE=0,USTA
TE=INACT&ALW&UIDUNEXP&PIDUNEXP,LASTLOGINTM=2004-12-08 14-20-26"
;
Error LoopStar 800 2004-03-15 15:54:55
M 100 DENY
PIUC
/*STATED USER PRIVILEGE CODE IS ILLEGAL,SM_NOT_EXIST*/
/*0X9101*/
;
Notes
RTRV-VCG
Command RTRV-VCG
Explanation Retrieve VC group.
Function This command retrieves the attribute of a virtual concatenation group.
Security Retrieve
Related Messages ED-VCG
Input Format RTRV-VCG:[<TID>]:<AID>:<CTAG>;
<AID> Valid formant is VCG-<SLOT ID>-<VCG ID>. Support &
and && symbols. Support ALL.
2-374 LPS800-UM-COMM-02

Format
^^^"<AID>::[PATHTYPE=<PATHTYPE>],[UPPATH=<UPPATH>],[ACTUPPATH
=<ACTUPPATH>],[DOWNPATH=<DOWNPATH>],[ACTDOWNPATH=<ACTDO
WNPATH>],[PROTOCOL=<PROTOCOL>,[SCRAMBLER=<SCRAMBLER>],[FC
STYPE=<FCSTYPE>],[ENDIAN=<ENDIAN>],[EXTHDR=<EXTHDR>],[REVCRC
=<REVCRC>]],[TAGTYPE=<TAGTYPE>],[PVID=<PVID>,PVPRI=<PVPRI>],[PS
VID=<PSVID>,PSVPRI=<PSVPRI>],[STAGTYPE=<STAGTYPE>],[SVENABLE
=<SVENABLE>]:<PST>" <cr><lf>
;
Error <cr><lf><lf>
;
LPS800-UM-COMM-02 2-375

<AID> Identifier of VC group.
<PATHTYPE> The path type of VCG. Valid values are shown in
section "PATHTYPE".
<UPPATH> The time slot number of up direction which assigned to
the VCG ID. The value can be 1 to MAX_PATH_NUM
and support & and && symbols.
<ACTUPPATH> The actual time slot number of up direction which
assigned to the VCG ID. The value can be 1 to
MAX_PATH_NUM and support & and && symbols.
<DOWNPATH> The time slot number of down direction which assigned
to the VCG ID, the value can be 1 to MAX_PATH_NUM
and support the & and && symbol.
<ACTDOWNPATH> The actual time slot number of down direction which
assigned to the VCG ID. The value can be 1 to
MAX_PATH_NUM and support & and && symbols.
<PROTOCOL> The protocol type to encapsulate the Ethernet service.
Valid values are GFP, LAPS, HDLC or PPP.
<SCRAMBLER> The scrambler type. Valid values are DISABLE, X43 or
X48. It is optional. Required only if <PROTOCOL> is
LAPS, HDLC or GFP.
<FCSTYPE> The frame check sequence type. Valid values are
NONE, FCS32 or FCS16. It is optional. Required only if
<PROTOCOL> is LAPS, HDLC or GFP.
<ENDIAN> The transmission order. Valid value is BIS or LITTLE. It
is optional. Required only if <PROTOCOL> is LAPS,
HDLC or GFP.
<EXTHDR> The extension header option. Valid value is Y or N. the
initial value is N. It is optional. Required only if
<PROTOCOL> is GFP.
<REVCRC> Indicates whether FCS is CRC reversed or not. Valid
value is Y or N. It is optional. Required only if
<PROTOCOL> is LAPS or HDLC.
<PVID> The default VLAN ID of the port.
<PVPRI> The priority of the default VLAN for the port.
<TAGTYPE> The tag type of the port.
<PSVID> Indicates the default service VLAN ID of the port.
port.
<STAGTYPE> Indicates the service VLAN tag attribute of the port.
<PST> Indicates the Ethernet port state. Valid values are IS-
NR, OOS-AU, OOS-MA, or OOS-AUMA.
Errors
2-376 LPS800-UM-COMM-02
Example Input RTRV-VCG::VCG-5-10:100;

Normal LoopStar 800 2004-06-20 14:30:00
M 100 COMPLD
"VCG-5-
10::PATHTYPE=STS1V,UPPATH=1&&3,ACTUPPATH=1&&3,DOWNPATH=1&
&3,ACTDOWNPATH=1&&3,PROTOCOL=GFP,SCRAMBLER=DISABLE,FCST
YPE=FCS32,ENDIAN=BIG,EXTHDR=Y,TAGTYPE=TAGAWARE,PVID=1,PVP
RI=0,PSVID=1000,PSVPRI=7,STAGTYPE=TAGAWARE,SVENABLE=Y:IS-NR"
;
Error LoopStar 800 2004-06-20 14:30:00
M 101 DENY
IIAC
;
Notes
SET-ATTR-<MOD2>
Command SET-ATTR-<MOD2>
Explanation Set attribute (OC3, OC12, FETH, VCG, T1, T3, STS1, STS3C, STS6C, STS9C,
STS12C, EQPT, DS1, DS3, SYNC, SYNCALL, SYNCFAC).
Function This command instructs an NE to set the notification code associated with the
specified event. This attribute governs whether the event is reported
automatically by the NE on each occurrence of the event. For events reported
automatically, it also specifies whether the event notification is alarmed (reported
via REPORT ALARM) or not alarmed (reported via REPORT EVENT).
Security Retrieve
Related Messages RTRV-ATTR-<MOD2>
Input Format SET-ATTR-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDTYPE>],[<LOCN>],[<DIRN>],,[<SRVEFF>];
LPS800-UM-COMM-02 2-377

<MOD2> The second modifier of the retrieve command which identifies
the type of the entity that is provisioned. Valid values are
OC3, OC12, FETH, VCG, T1, T3, STS1, STS3C, STS6C,
STS9C, STS12C, EQPT, DS1, DS3, SYNC, SYNCALL or
SYNCFAC. It must not be ALL.
<AID> Access identifier. It must not be null.
in <CONDTYPE>. A null value means that not to change the
value before setting.
<CONDTYPE> Identifies the type of event for which a notification attribute
(<NTFCNCDE>) is being changed. A null value is ALL.
reported and refers to the entity identified by the <AID>. Thus,
identified entity, and FEND (far end) refers to alarm conditions
occurring at a distant entity that is connected to the identified
entity. Likewise, LINE [-x] refers to an intermediate point. A
null value is equivalent to NEND.
identified by the AID. A null value is equivalent to ALL. Valid
value is TRMT (transmit direction only) or RCV (receive
direction only).
condition. A null value is means that not to change the value
before setting.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-378 LPS800-UM-COMM-02

PARAMETER ERROR
Example Input SET-ATTR-EQPT::SLOT-3:1::MJ,BDSTATUS,NEND,RCV,,SA;
Normal LoopStar 800 2004-07-15 14:56:06
M 1 COMPLD
;
Error LoopStar 800 2004-07-15 14:59:26
M 1 DENY
IDRG
/*DATA RANGE ERROR, */
;
Notes
SET-ATTR-ENV
Command SET-ATTR-ENV
Explanation Set attribute environment.
Function This command requests the NE or office environment monitor set the attributes
associated with an environmental alarm. These attributes are included when an
environmental alarm is reported or retrieved. An alarm should be unprovisioned
and you should wait for any raised alarm to clear before reprovisioning the alarm
to another alarm type.
If the <NTFCNCDE>, <ALMTYPE> and <ALMMSG> parameters are omitted,
the environmental alarm specified by <AID> is unprovisioned.
Related Messages RTRV-ATTR-ENV
Input Format SET-ATTR-ENV:[<TID>]:<ENVAID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>],
[<ALMMSG>];
LPS800-UM-COMM-02 2-379

<ENVAID> Access identifier. It must not be null.
in <CONDTYPE>. A null value means that not to change the
value before setting.
the various ENV commands listed in section "FAULT" of
Charpter 3 TL1 Parameters. The default value is "MISC"
(Miscellaneous).
environmental alarm specified by the <AID> parameter.
The content of <ALMMSG> should be contained in a text
string of no more than 63 characters enclosed within double
quotation marks.
A null value means that there is no message text for the
environmental alarm. "Miscellaneous" will be displayed.
<rspblk> +
;

^^^"<AID>:[<NTFCNCDE>,<ALMTYPE>[,<ALMMSG>]]"<cr><lf>
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
2-380 LPS800-UM-COMM-02

PARAMETER ERROR
Example Input SET-ATTR-ENV::ENV-1:C::CR,ENV-AIRCOND,"sdfsfsd";
Normal LoopStar 800 2004-07-15 14:56:06
M C COMPLD
;
Error LoopStar 800 2004-07-15 14:59:26
M C DENY
IPNC
;
Notes A null value for <NTFCNCDE>, <ALMTYPE>, and <ALMMSG> unassigns the
value of these three parameters; otherwise a null value for <NTFCNCDE>
leaves it unchanged.
SET-PMDAY
Command SET-PMDAY
Explanation Set performance start time of a day.
Function This command sets the start time of the daily PM data collection period. The start
time of PM data collection can begin at any hour of the day.
Related Messages RTRV-PMDAY
Input Format SET-PMDAY:[<TID>]::<CTAG>::<PM-DAY-START>;
LPS800-UM-COMM-02 2-381

<PM-DAY-START> The format is HOD. HOD stands for "hour of day" and
ranges from 0 to 23. To effect resetting the NE clock to the
default value of 00:00 hours, the <SET-PM-START>
parameter should contain the value 0. A null value for
<SET-PM-START> is not allowed. If a null value is
entered, the NE shall send an error response, with
appropriate error text, and deny the SET-PMDAY
command.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input SET-PMDAY:::C::7;
Normal LoopStar 800 2004-01-01 12:23:20
C COMPLD
;
Error LoopStar 800 2004-01-01 12-20-20
M C DENY
PLNA
;
Notes
2-382 LPS800-UM-COMM-02
SET-SID
Command SET-SID
Explanation Set system identification (SID).
Function This command instructs the NE to change its system identification code to given
value. Where appropriate, the value of this SID code is used as the target
identifier in an input command and source identifier in an output or autonomous
message.
Category System
Related Messages
Input Format SET-SID:[<TID>]::<CTAG>::<SID>;
<SID> <SID> identifies the new name of the target NE. The maximum
length is 20 characters.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-383
Example Input SET-SID:::C::SONET-NE;

Normal LoopStar 800 2004-01-01 00:00:00
M C COMPLD
;
Error LoopStar 800 2004-01-01 00:00:00
M C DENY
IIDT
/*INVALID DATA PARAMETER*/
;
Notes
SET-TH-<MOD2>
Command SET-TH-<MOD2>
Explanation Set threshold (ALL, OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C,
STS12C, STS48C, STS192C, VT1).
Function This command instructs an NE to set the threshold level for a monitored
parameter that, when exceeded, will trigger an automatic message. The
threshold level may apply to one or more equipment units, facilities in the NE.
Related Messages
Input Format SET-TH-<MOD2>:[<TID>]:[<AID>]::<CTAG>::<MONTYPE>,<THVAL>,
[<LOCN>],[<DIRN>],[<TMPER>];
2-384 LPS800-UM-COMM-02

the type of the entity that reports trouble. Valid value can be:
ALL, OC3, OC12, OC48, OC192, T1, T3, STS1, STS3C,
STS12C, STS48C, STS192C or VT1.
<MONTYPE> The performance threshold type. It must not be null.
<THVAL> The desired threshold value to be set for <MONTYPE>. It
must not be null. <THVAL> is the user-defined or system-
specified threshold level if <CONDTYPE> is a threshold
violation. This value should be provided if this alarm report
has resulted from degradation that has exceeded the defined
or specified threshold level. Valid values are identical in
format to that of the <MONVAL> associated with this
alarm report.
<LOCN> Indicates the location, in reference to the entity identified by
the <AID>, being performance monitored. Thus, NEND (near
end) refers to pm values obtained at the identified entity, and
FEND (far end) refers to pm values obtained at a distant entity
that is connected to the identified entity. A null value is NEND.
identified by the <AID>. A null value is ALL. Valid value
is TRMT (transmit direction only) or RCV (receive
direction only).
<TMPER> Specifies the accumulation time period for the PM
information. A null value is 15-MIN.
Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
LPS800-UM-COMM-02 2-385
Example Input SET-TH-OC3::FAC-1-2:C::ALL,1000,NEND,,15-MIN;

Normal LoopStar 800 2004-03-08 14:30:00
M C COMPLD
;
Error LoopStar 800 2004-03-08 14:30:00
M C DENY
PLNA
;
Notes
SW-DX-EQPT
Command SW-DX-EQPT
Explanation Switch duplex equipment.
Function This command instructs NE to execute an XCS unit protection switch.
Category Equipment
Related Messages INH-SWDX-EQPT
REPT SW
ALW-SWDX-EQPT
Input Format SW-DX-EQPT:[<TID>]:<EQPT>:<CTAG>::<HSCSWMODE>;
<EQPT> The slot identifier of an XCS unit.
<HSCSWMODE> XCS switch mode. Valid values are MANUAL (manual
switch), FORCE (forced switch), CLEAR (clear switch).
2-386 LPS800-UM-COMM-02

Format
^^^<rsphdr><cr><lf>
;
Error <cr><lf><lf>
^^^<rsphdr><cr><lf>
^^^<errcde><cr><lf>
;
Errors
Example Input SW-DX-EQPT::SLOT-9:100::MANUAL;
Normal LoopStar 800 2004-03-07 09:50:17
M 100 COMPLD
;
SONET_NE 2004-03-07 09:50:17

* 3 REPT SW
"9,10"
;
Error LoopStar 800 2004-03-08 09:59:42
M 100 DENY
IPNV
;
Notes 1. Manual switch does not need clear.
2. XCS represents the units of XCS/XCSH (LoopStar 1600) and XO
(LoopStar 800).
LPS800-UM-COMM-02 2-387
2-388 LPS800-UM-COMM-02
Chapter 3
TL1 PARAMETERS
This chapter introduces the TL1 access identifier (AID) and parameters.
ACCESS IDENTIFIER (AID)

DCC
Supported TL1
AID type AID format Description commands Notes
LAN – LAN LAN-1 Network ED • Auto-created when
management management
ENT
XCS unit is created.
port on XCS LAN port On the standby unit
units DLT this port is disabled
DCC DCC-<SLOT ID>-<FACILITY ID>-1 SONET ED • Auto-created when
SONET DCC for example: DCC-1-1-1 section DCC ENT facility is created
(D1-D3)
DLT
192 kbit/s
DCC-<SLOT ID>-<FACILITY ID>-2 SONET line ED • Need to be manually
DCC (D4-D12) ENT created
for example: DCC-1-1-2
• Only if there are no
576K Bits DLT LDCC do not exist
on this facility
DCC-<SLOT ID>-<FACILITY ID>-3 Partial line ED • Need to be manually
DCC (D4-D6) created
for example: DCC-1-1-3 ENT
192 kbit/s DLT LDCC exists on this
facility
DCC (D7-D9) created
for example: DCC-1-1-4 ENT
192 kbit/s DLT LDCC exists on this
facility
DCC (D10- created
for example:DCC-1-1-5 ENT
D12) • Only if there are no
DLT LDCC exists on this
192 kbit/s
facility
Chapter 3: TL1 Parameters July 29, 2005
EQPT
Table 3-1. LoopStar 1600

AID format AID type Unit type Value Notes
<string>-<slot#> Optical unit OC192 SLOT-{1-2}
SLOT-N OC48 SLOT-{1-8}
OC48B
OC12D SLOT-{1-8}
OC12Q
OC12
OC3Q SLOT-{1-8}
OC3D
OC3
Electrical unit PLT3 SLOT-{4, 5-8}
PDT3
PQT3
PDM3 SLOT-{4, 5-8}
PLT1 SLOT-{3,5-8}
PDT1
<string>-<slot#> Ethernet unit EFS8 SLOT-{1-8}
SLOT-N EGT2
XCS unit XCSH SLOT-{9,10}
XCS
Fan unit FAN SLOT-{11} FAN unit is auto-provisioned.
Power PIU SLOT-{12-13} This unit is auto-provisioned.
interface unit
Alarm & timing ATE SLOT-{14} This unit is auto-provisioned.
& expanding
unit
Tributary I/O PQI3 SLOT-{15-16} These units are auto-provisioned.
unit
PQI1
PDI13
POI3
PQSI3
DWDM unit BA2 SLOT-{1-8}
PBA
July 29, 2005 Chapter 3: TL1 Parameters
Table 3-2. LoopStar 800

AID format AID type Unit type Pattern Notes
<string>-<slot#> Optical unit XO12D SLOT-{1~2}
SLOT-N XO12
XO3D
XO3
OC12 SLOT-{3~6}
OC12D SLOT-{4~6}
OC3Q SLOT-{3-6}
OC3D
OC3
Electrical unit PLT3 SLOT-{3, 5-6}
PQT3
PDM3 SLOT-{3, 5-6}
PLT1 SLOT-{3-6}
PDT1
Ethernet unit EFS8 SLOT-{3-6}
Fan unit FAN SLOT-{7} FAN unit is auto-provisioned.
Power interface unit PIU SLOT-{8-9} These units are auto-
provisioned.
I/O unit PSI1 SLOT-{11} These units are auto-
provisioned.
POI3
PI13
OCN
AID format Unit type Pattern

<string>-<slot#>-<port #>: OC3 FAC-{N}-1
FAC-N-M XO3
OC3D FAC-{N}-{1-2}
XO3D
OC3Q FAC-{N}-{1-4}
OC12 FAC-{N}-{1}
XO12
OC12D FAC-{N}-{1-2}
XO12D
OC12Q FAC-{N}-{1-4}
OC48 FAC-{N}-{1}
OC48B
OC192 FAC-{N}-{1}
T1/T3
In the following table, N is the slot of the optical unit, this value is related with the NE type; for the valid value of the
equipment slot, please see “EQPT” on page 3-2.
AID type AID format Unit type Pattern Notes

T1 <string>-<slot#>-<port #>: PLT1 FAC-N-{1-14}
FAC-N-M PDT1 FAC-N-{1-28}
PDT1P FAC-N-{1-28}
T3 <string>-<slot#>-<port #>: PLT3 FAC-N-{1-3}
(Transmux)
FAC-N-M PDT3 FAC-N-{1-6}
PQT3 FAC-N-{1-12}
PQT3P
PQM3 FAC-N-{1-12}
PQM3P
PDM3 FAC-N-{1-6}
PDM3P
T1 <string>-<slot#>-<ds3#>-<ds1#>: PQM3 FAC-N-{1-12}-{1-28}
(Transmux) FAC-N-M-Y PQM3P
PDM3 FAC-N-{1-6}-{1-28}
PDM3P
Ethernet
AID type AID Description Restrictions

ETN_IPPORT <slot#>-<port#> The AID can be specified by Valid Commands:
using the IP-a-b format, where a ED-<ETN_ETY>
and b indicate the equipment
and Ethernet port number. RTRV-<ETN_ETY>
ETN_VCTRUNK <slot#>-<vcg#> The AID can be specified by Valid Commands:

using the VCTRUNK-a-b format,
ED-VCTRUNK
where a and b indicate the
equipment and virtual RTRV-VCTRUNK
concatenation trunk.
ETN_PORT <slot#>-<port#> The AID can be specified by Valid Commands:
using <ETH_IPPORT> or
Or ED-ETHPORT
<ETH_VCTRUNK>.
<slot#>-<vcg#> RTRV-ETHPORT
ETN_VBLP <slot#>-<vb#>-<lp#> The AID can be specified by
using the LP-a-b-c format,
where a,b,and c indicate the
equipment, virtual bridge, and
the virtual bridge logical port
number.
ETN_CARID <slot#>-<carid#> The AID can be specified by Valid Commands:
using the CAR-a-b format, ENT-CAR
where a and b indicate the
equipment and the identifier of DLT-CAR
Committed Access Rate. ED-CAR
RTRV-CAR
ETN_PORTVLAN <slot#>-<port#>-<vlanid#> The AID can be specified by Valid Commands:
using the a-b format, where a
OR ENT/ED/DLT/RTRV-
using <ETH_PORT> format and
EVPL
<slot#>-<vcg#>-<vlanid#> b indicate Virtual LAN identifier.
ENT/DLT/RTRV-LSP
ENT/DLT/RTRV-LINK
LINK_FROM <slot#>-<vb#>-<lp#> The AID can be specified by Valid Commands:
using <ETN_VBLP> or
OR ENT-LINK
<ETN_PORT> or
<slot#>-<port#> <ETN_PORTVLAN> to indicate DLT-LINK
OR LSP source. RTRV-LINK
<slot#>-<vcg#> ENT-LSP
OR DLT-LSP
<slot#>-<port#>-<vlanid#> RTRV-LSP
OR
<slot#>-<vcg#>-<vlanid#>
AID type AID Description Restrictions

LINK_TO <slot#>-<vb#>-<lp#> The AID can be specified by Valid Commands:
using <ETN_VBLP> or
OR ENT-LINK
<ETN_PORT> to indicate LSP
<slot#>-<port#> destination. RTRV-LINK
OR ENT-LSP
<slot#>-<vcg#> RTRV-LSP
EPL_FROM <slot#>-<port#> The AID can be specified by Valid Commands:
using <ETN_PORT> or
OR ENT-EPL/EVPL
<ETN_PORTVLAN> to indicate
<slot#>-<vcg#> the source of an Ethernet ED-EPL/EVPL
OR Private Line. DLT-EPL/EVPL
<slot#>-<port#>-<vlanid#> RTRV-EPL/EVPL
OR
EPL_TO <slot#>-<port#> The AID can be specified by Valid Commands:
using <ETN_PORT> or
OR ENT-EPL/EVPL
<ETN_PORTVLAN> to indicate
<slot#>-<vcg#> the destination of an Ethernet ED-EPL/EVPL
OR Private Line. RTRV-EPL/EVPL
<slot#>-<port#>-<vlanid#>
OR
Housekeeping
AID type AID format Notes

CONT <string>-<cont#>: N=1 to 4 (LoopStar 810)
CONT-N N=1 to 8 (LoopStar 800)
N=1 to 8 (LoopStar 1600)
Note that the former 6 CONT cannot be set.
ENV <string>-<env#>: N=1 to 4 (LoopStar 810)
ENV-N N=1 to 8 (LoopStar 800)
N=1 to 8 (LoopStar 1600)
STS-N
In the following table, N is the slot of the optical unit, this value is related with the NE type; for details on the valid
value of the equipment slot, please see “EQPT”. To optical port, M is the port. Valid value is related with the optical
unit type, please see “OCN”. To electrical unit and Ethernet unit, there is not port number field in STS path AID.
AID format AID type Unit type Notes

<string>-<slot#>- Optical unit OC3 STS1:
<port #>-<sts#>: XO3 STS-N-M-{1,2,3}
STS-N-M-Y OC3D STS3C:
XO3D STS-N-M-1
OC3Q
OC12 STS1:
XO12 STS-N-M-{1-12}
OC12D STS3C:
XO12D STS-N-M-{1,4,7,9}
OC12Q STS6C:
STS-N-M-{1,4,7}
STS9C:
STS-N-M-{1,4}
STS12C:
STS-N-M-1
OC-48 STS1:
OC48B STS-N-M-{1-12}
STS3C:
STS-N-M-{1,4,7,10,13,16,19,22,25,28,31,34,37,40,43,46}
STS6C:
STS-N-M-{1,4,7,13,16,19,25,28,31,37,40,43}
STS9C:
STS-N-M-{1,4,13,16,25,28,37,40}
STS12C:
STS-N-M-{1,13,25,37}
STS24C:
STS-N-M-{1,25}
STS48C:
STS-N-M-1
OC192 STS1: STS-N-M-{1-12}

STS3C: STS-N-M-{1, 4, 7, 10-190}
STS6C: STS-N-M-{1, 4, 7, 13, 16, 19, 25, 28, 31, 37, 40, 43…}
STS9C: STS-N-M-{1, 4, 13, 16, 25, 28, 37, 40,}
STS12C: STS-N-M-{1, 13, 25, 37, 49, 61, 73, 85, 97, 109, 121, 133,
145, 161, 173, 181}
STS24C: STS-N-M-{1, 25, 49, 73, 97, 121, 145, 169}
STS48C: STS-N-M-{1, 49, 97, 145}
STS192C: STS-N-M-{1}

<string>-<slot#>- Electrical unit PLT3 STS-N-{1,2,3}
<sts#>:
PDT3 STS-N-{1,2,3,4,5,6}
STS-N-Y
PQT3 STS-N-{1-12}
PQM3 STS-N-{1-12}
PQM3P
PDM3 STS-N-{1-6}
PDM3P
<string>-<slot#>- Ethernet unit ET4GS STS-N-{1-24}

<sts#>:
EFS8
STS-N-Y
EGT2
BITS
Table 3-3. BITS values

Value Description
BITSIN-1 External clock 1 input interface
BITSIN-2 External clock 2 input interface
BITSOUT-1 External clock 1 output interface
BITSOUT-2 External clock 2 output interface
SYNCAID
Table 3-4. SYNCAID values

Value Description
BITS<IN|OUT>-<1|2> External clock interface (refer to BITS)
FAC-x-y Line clock (refer to “OCN”)
VT1.5

<string>-<slot#>-<port#>- Optical unit OC3 Y=1..3
<STS#>-<VT grp>-<Vt#>:
XO3 S=1..7
VT1-N-M-Y-S-T
OC3D T=1..4
XO3D
OC3Q
OC12 Y=1..12
XO12 S=1..7
OC12D T=1..4
XO12D
OC12Q
OC12O
OC-48 Y=1..48
OC48B S=1..7
T=1..4
OC192 Y=1..192
S=1..7
T=1..4
<string>-<slot#>-<STS#>- Electrical unit PLT1 Y=1

<VT grp>-<Vt#>: S=1..7
VT1-N-Y-S-T T=1..4
PDT1 Y=1
PDT1P S=1..7
T=1..4
PLDTM Y=1
S=1..7
T=1..4
No VT AIDs for the DS3 ports.
PQM3 Y=1..12
PQM3P S=1..7
T=1..4
PDM3 Y=1..6
PDM3P S=1..7
T=1..4
<string>-<slot#>-<STS#>- Ethernet unit Y= 1..48 (To ET4GS, Y=1..24, to

<VT grp>-<Vt#>: other Ethernet unit’s STS valid value,
VT1-N-Y-S-T please see the table “STS-N” table)
S=1..7
T=1..4
(In LoopStar 1600 R1, VT level is not
supported )
PARAMETER DESCRIPTION
ACTFLOWCTRL
The actual flow control attribute of the port.
Table 3-5. ACTFLOWCTRL values

Value Description
DISABLE Disable the flow control of the port (close the flow control function of
bidirectional traffic)
ENABLE Enable the flow control of the port (send and receive)
SEND Enable the send flow control (only send)
RECV Enable the receive flow control (only receive)
ACTWORKMODE
The actual work mode of the port.
Table 4. ACTWORKMODE values
Value Description
HALF10M 10Mbps half-duplex mode
FULL10M 10Mbps full-duplex mode
NEGOTIATING In process of negotiating
AISTH
The AIS threshold of external clock.
For example, supposing user set the AIS=ST3, when the quality level of clock source is worse than ST3, AIS will be
inserted to the external clock output.
Table 3-1. AISTH values

Value Description
STU Synchronized, traceability unknown
PRS Primary reference source, Stratum 1 traceable
ST2 Stratum 2 traceable
TNC Transit node clock
ST3E Stratum 3E
Value Description
ST3 Stratum 3 traceable
SMC SONET minimum clock traceable, Now it is not support yet.
DUS (default) Do not use for synchronization
PNO Reserved for network synchronization use
BCSENABLE
The broadcast packet suppression enable status, initial value is N.
Table 3-2. BCSENABLE values

Value Description
Y Yes: enable
N No: disable
BCSTH
The percentage of the broadcast packets engross the total bandwidth planned, ranges from 1 to 10. Initial value is 3
(meaning 30%). When the bandwidth used by broadcast packets exceeds CSTH*10%, the broadcast packets will
be suppressed (i.e., dropped).
BER
Value Description
1E-3 to 1E-5 SFBER ranges from 1E-3 to 1E-5, Default threshold is 1E-4.
1E-5 to 1E-9 SDBER ranges from 1E-5 to 1E-9, Default threshold is 1E-6.
C2
Value Description
UNEQ 0x00 The C2 content to be transmitted is unloaded.
EQPD (default) 0x01 The C2 content to be transmitted is loaded with normal SPE.
VT-STS1 0x02 The C2 content to be transmitted: STS-1 SPE of VT structure.
Default value for C2 in DS1 unit
LOCK-VT 0x03 The C2 content to be transmitted: lock VT mode.
DS3 0x04 The C2 content to be transmitted: DS3 asynchronous mapping.
Default value for C2 in DS3 port.
Value Description
DS4NA 0x12 The C2 content to be transmitted: DS4NA asynchronous
mapping.
ATM 0x13 The C2 content to be transmitted: ATM mapping.
DQDB 0x14 The C2 content to be transmitted: DQDB mapping.
FDDI 0x15 The C2 content to be transmitted: FDDI asynchronous

mapping.
HDLC-OVER-SONET 0x16 The C2 content to be transmitted: HDLC-OVER-SONET

mapping.
LAPS 0x18
GFP 0x1b
PDI-{1 to 28} 0xe1-0xfc The C2 content to be transmitted: defect, it can only be

retrieved in received C2, and cannot be edited and retrieved in
transmitted C2 and expected C2.
O.181 0xfe The C2 content to be transmitted: O.181 testing signal.
Other byte Hex code Non standard C2.
CARDTYPE
Table 3-3. CARDTYPE values

Value Description
OC3Q 4 x OC-3 optical interface unit
OC3D 2 x OC-3 optical interface unit
OC3 1 x OC-3 optical interface unit
OC12Q 4 x OC-12 optical interface unit
OC12D 2 x OC-12 optical interface unit
OC48B 1 x OC-48 optical interface unit
PLT1 14 x DS1 processing unit
PDT1 28 x DS1 processing unit
PDT1P 28 x DS1 processing protection unit
PQT3 12 x DS3 processing unit
PQT3P 12 x DS1 processing protection unit
Value Description
PDT3 6 x DS3 processing unit
PLT3 3 x DS3 processing unit
PDM3 6 x DS3 Transmux processing unit
PDM3P 6 x DS3 Transmux processing protection unit
ET4GS 4 x 10/100BASE-T and 1 x 1000BASE-SX/LX Ethernet unit
EFS8 8 x 10/100BASE-T Ethernet Unit
EGT2 2 x 1000BASE-LX/1000BASE-SX Ethernet unit
XO12 Higher order cross-connect, control, timing and 1 x OC-12 optical
interface integrated unit
XO12D Higher order cross-connect, control, timing and 2 x OC-12 optical
XO3 Higher order cross-connect, control, timing and 1 x OC-3 optical
XO3D Higher order cross-connect, control, timing and 2 x OC-3 optical
XCS Cross-connect, control and timing unit
XCSH Higher order cross-connect, control and timing unit
GXCS General cross-connect, system control and timing unit
FAN Fan unit. This unit type is auto-provisioned when system power on,
can be retrieved only.
PIU Power interface unit. This unit type is auto-provisioned when system
power on, can be retrieved only.
PQI1L 56 x DS3 interface unit, left. This unit type is auto-provisioned when
system power on, can be retrieved only.
PQI1R 56 x DS3 interface unit, right. This unit type is auto-provisioned when
PHI3A 48 x DS3 interface unit, BNC connector, right. This unit type is auto-
provisioned when system power on, can be retrieved only.
PHI3B 48 x DS3 interface unit, BNC connector, left. This unit type is auto-
provisioned when system power on, can be retrieved only.
POI3 24 x DS3 interface unit. This unit type is auto-provisioned when
PQSI3 12 x DS3 interface unit. This unit type is auto-provisioned when
PQI3 12 x DS3 interface unit. This unit type is auto-provisioned when
PQI1 56 x DS1 interface unit. This unit type is auto-provisioned when
Value Description
PDI13 28 x DS1 + 6 x DS3 interface unit. This unit type is auto-provisioned
when system power on, can be retrieved only.
PSI1 84 % DS1 interface unit. This unit type is auto-provisioned when
POI3 24 % DS3 interface unit. This unit type is auto-provisioned when
PI13 28 % DS1+12 % DS3 interface unit. This unit type is auto-provisioned
when system power on, can be retrieved only.
DIRECTION
The direction of the VCG
Table 3-4. DIRECTION values

Value Description
UP Up direction
DOWN Down direction
DOWNPATH
Indicates the time slot number of the VCG down direction; support the & and && symbol, ranges from 1 to
MAX_PATH_NUM. Its maximum number (MAX_PATH_NUM) will be different in different devices.
ENDIAN
The transmission order. The initial value is LITTLE.
Table 4. ENDIAN values
Value Description
BIG BIG: byte-wise big-endian order
LITTLE LITTLE: bit-wise little-endian order
EXTHDR
Indicates whether extension of the LLC header exists. The initial value is N.
Table 3-1. EXTHDR values

Value Description
Y Yes: Exist EXTHDR
N No: Don't exist EXTHDR
FAULT
Keyword Domain Description Restrictions

<ALMMSG> Test message <ALMMSG> is the text message SET-ATTR-ENV
associated with an environmental RTRV-ATTR-
alarm. The content of <ALMMSG> ENV,REPT ALM
should be contained in a text string of ENV,RTRV-ALM-
no more than 63 characters enclosed ENV
within a pair of double quotes.
<ALMCODE> *C Critical alarm <ALMCODE> identifies the nature of REPT ALM

** Major alarm the automatic message based on its <MOD2>, REPT
priority of action. ALM ENV
*^ Minor alarm
A^ Automatic message

<ALMTYPE> <ALMTYPE> Description <ALMTYPE> is the type of environmental RTRV-ALM-
AIRCOMPR (air compressor failure) alarm returned by the various ENV ENV,SET-ATTR-
commands listed below. ENV,RTRV-ATTR-
AIRCOND (air conditioning failure) ENV,REPT ALM ENV
AIRDRYR (air dryer failure)
BATDSCHRG (battery discharging)
BATTERY (battery failure)
CLFAN (cooling fan failure)
CPMAJOR (centralized power major
environmental alarm or major equipment
failure, for example, FITL systems)
CPMINOR (centralized power minor
environmental alarm or minor equipment
failure. for example, FITL systems)
ENGINE (engine failure)
ENGOPRG (engine operating)
EXPLGS (explosive gas)
FIRDETR (fire detector failure)
FIRE (fire)
FLOOD (flood)
FUSE (fuse failure)
GEN (generator failure)
HIAIR (high airflow)
HIHUM (high humidity)
HITEMP (high temperature)
HIWTR (high water)
INTRUDER (intrusion)
LWBATVG (low battery voltage)
LWFUEL (low fuel)
LWHUM (low humidity)
LWPRES (low cable pressure)
LWTEMP (low temperature)
LWWTR (low water)
MISC (miscellaneous)
OPENDR (open door)
PUMP (pump failure)
POWER (commercial power failure)
PWR-48 (–48 V power supply failure)
RECT (rectifier failure)
RECTHI (rectifier high voltage)
RECTLO (rectifier low voltage)
SMOKE (smoke)
TOXICGAS (toxic gas)
VENTN (ventilation system failure)

<CONDDESCR> Text Message <CONDDESCR> is a detailed text RTRV-ALM-
description of the condition, state, <MOD2>,RTRV-
trouble (ALM commands) or specific COND-
event. <CONDDESCR> should contain <MOD2>,REPT
a text string of no more than 64 ALM <MOD2>,
characters enclosed within a pair of
escaped quotes.
<CONDTYPE> Show in “Chapter 5 Alarm and <CONDTYPE> identifies the type of RTRV-COND-
Condition” event, condition or alarm indication <MOD2>,RTRV-
being ALM-
<MOD2>,REPT
ALM
<MOD2>,RTRV-
ATTR-
<MOD2>,SET-
ATTR-
<MOD2>,REPT
EVT <MOD2>
<CONTTYPE> AIRCOND (air conditioning) <CONTTYPE> identifies the type of RTRV-ATTR-

ENGINE (engine) external control requested of the NE. CONT,SET-ATTR-
CONT,OPR-EXT-
FAN (fan) CONT,RLS-EXT-
GEN (generator) CONT,RTRV-EXT-
CONT
HEAT (heat)
LIGHT (light)
MISC (miscellaneous)
SPKLR (sprinkler)
<DIRN> TRMT (transmit direction only) <DIRN> specifies the direction RTRV-ALM-
RCV (receive direction only) associated with particular information <MOD2>,RTRV-
(action to perform, information COND-
requested, information reported, etc.). <MOD2>,SET-
ATTR-
<MOD2>,RTRV-
ATTR-
<MOD2>,REPT
ALM
<MOD2>,REPT
EVT <MOD2>
<LOCN> NEND (near end - condition, alarm, or <LOCN> identifies the location (line RTRV-ALM-
event occurred at the near end of the unit, alarm, loopback, etc.) associated <MOD2>,RTRV-
system) with a particular command. In general, COND-
FEND (far end - condition, alarm, or the location is in reference to the entity <MOD2>,SET-
event occurred at the far end of the identified by the <AID>. ATTR-
system) <MOD2>,RTRV-
ATTR-
<MOD2>,REPT
ALM
<MOD2>,REPT
EVT <MOD2>

<MONVAL> number <MONVAL> is the value to which the REPT EVT
register identified by <MONTYPE> is to <MOD2>
be initialized (INIT-REG) or is the
measured value of a monitored
parameter (in a RESPONSE or
AUTOMATIC message). The value is in
the form of numeric counts or rates.
<NTFCNCDE> CR (critical alarm) <NTFCNCDE> is the notification code RTRV-ALM-

MJ (major alarm) associated with alarm conditions. <MOD2>,RTRV-
COND-
MN (minor alarm) <MOD2>,SET-
NA (not alarmed) ATTR-
<MOD2>,RTRV-
NR (not reported)
ATTR-
CL (cleared alarm) <MOD2>,REPT
ALM
<MOD2>,RTRV-
ALM-ENV,REPT
ALM ENV,SET-
ATTR-ENV,RTRV-
ATTR-ENV
<OCRDAT> MOY stands for month of year and <OCRDAT> is the date when the RTRV-ALM-
has a range of 1 to 12. specific event or violation occurred. <MOD2>,RTRV-
DOM stands for day of month and COND-
has a range of 1 to 31. <MOD2>REPT
ALM
<MOD2>,REPT
ALM ENV,RTRV-
ALM-ENV
<OCRTM> The format for <OCRTM> is HOD- <OCRTM> is the time of day when the RTRV-ALM-
MOH-SOM. specific event or violation occurred. <MOD2>,RTRV-
HOD stands for hour of day and has a COND-
range of 0 to 23. <MOD2>,REPT
ALM
MOH stands for minute of hour and <MOD2>,REPT
has a range of 0 to 59. ALM ENV,REPT
SOM stands for second of minute and EVT <MOD2>
has a range of 0 to 59.
<SRVEFF> SA (service-effecting condition, <SRVEFF> is the effect on service RTRV-ALM-

immediate action required) caused by the standing or alarm <MOD2>,RTRV-
NSA (non-service-effecting condition, condition. COND-
action required) <MOD2>,REPT
ALM
<MOD2>,REPT
EVT <MOD2>,SET-
ATTR-
<MOD2>,RTRV-
ATTR-<MOD2>
<THVAL> Number <THVAL> indicates the threshold value. REPT EVT

<MOD2>

<TMPER> 15-MIN <TMPER> is the accumulation time REPT EVT
1-DAY period for Performance Monitoring <MOD2>
parameters.
If the command where <TMPER>
appears includes a <CONDTYPE>,
<TYPEREQ>, or <TYPEREP>, then
this parameter is applicable only when
<CONDTYPE>, <TYPEREQ>, or
<TYPEREP> is of the form T-x. T-x
indicates a threshold violation on
<MONTYPE> x (valid values for x are
shown in Appendix E). If
<CONDTYPE>, <TYPEREQ>, or
<typerep> is not of the form T-x, then
<TMPER> does not pertain and should
be null.
<CONDEFF> <CONDEFF> indicates the effect of the REPT EVT

event on the condition of the NE. The <MOD2>
event may initiate a standing condition,
which can later be retrieved using the
RETRIEVECONDITION command or
may initiate a transient condition that
does not change the basic condition of
the NE for an extended time period.
A null value for <CONDEFF> defaults
to TC.
Parameter grouping shall not be used
with this parameter.
<TYPEREP> Valid values can find in the condition <TYPEREQ> is the type of condition or RTRV-COND-
list of the product state to be retrieved. <MOD2>
Valid values can find in the condition list
of the product
<DUR> Valid values of it are CONTS It specifies the duration of the external OPR-EXT-CONT,
(continuously) and MNTRY control operation (for example:, the RLS-EXT-CONT
(Momentarily, 5 seconds here). duration of the relay activation).
FCSTYPE
The frame check sequence type.
If <PROTOCOL> is LAPS or HDLC, this parameter must be FCS32 or FCS16. If <PROTOCOL> is LAPS,
<FCSTYPE> of EFS8 can only be FCS32. The initial value is FCS32.
Table 3-2. FCSTYPE values

Value Description
NONE NONE
FCS32 FCS32
FCS16 FCS16
FLOWCTRL
The non-auto-negotiation flow control attribute of the port, the initial value is DISABLE.
Table 3-3. FLOWCTRL values

Value Description
DISABLE Disable the flow control of the port (close the flow control function of
bidirectional traffic)
ENABLE Enable the flow control of the port (send and receive)
SEND Enable the send flow control (only send)
RECV Enable the receive flow control (only receive)
INTFTYPE
Table 3-4. INTFTYPE values

Value Description
DS3_ASYN_STS1 DS3 signal asynchronous mapped into STS1. Default for DS3 unit.
DS3_TMUX_DS1 Multiplexing and de-multiplexing of DS1s to/from DS3. Default for
Transmux unit (PDM3).
DS1_ASYN_VT1 DS1 signal asynchronous mapped into VT1. Default for DS1 unit.
EC1 EC1 signal mapped into STS1.
J1 MODE
Table 3-5. J1 MODE values

Value Description
MANUAL Performs the comparison of the received string with the user-
entered expected string.
AUTO Performs the comparison of the present received string with an
expected string set to a previously received string. If there is a
mismatch, TIM-P alarm is raised.
OFF Don’t perform the comparison. Default value is OFF.
LINE BUILD OUT (DS1 PORT)
Table 3-6. LINE BUILD OUT (DS1 PORT) values

Value Description
1 Cable length range from 0 to 131 feet.
LINE BUILD OUT (DS3 PORT)
Table 3-7. LINE BUILD OUT (DS3 PORT) values

Value Description
LOG
Table 3-8. LOG values

<AID> SLOT-N SLOT-N. NULL value means the current
active XCS unit.
<LOGNAME> The name of the log files to be retrieved.
LOOPBACK TYPE
Table 3-9. LOOPBACK TYPE values

Value Description
FACILITY A type of loopback that connects the incoming received signal
immediately following the optical-to-electrical conversion (after
descrambling) to the associated transmitter in the return direction.
The higher-order cross-connection, OC-N and DSn unists support
facility loopback (the lower-order coss-connection does not support
facility loopback).
TERMINAL A loopback that connects the signal that is about to be transmitted
(after scrambling but before the electrical-to-optical conversion) is
connected to the associated, incoming receiver.
The higher-order cross-connection, OC-N and DSn unists support
terminal loopback (the lower-order coss-connection does not support
terminal loopback).
DS1FEAC The FEAC (or far-end) loopback provisioning for T1.
Only the DS1 port of Transmux unit support DS1FEAC.
DS3FEAC The FEAC (or far-end) loopback provisioning for T3.
Only the DS3 port of Transmux unit support DS3FEAC.
CRS A path level loopback which is established at the cross-connect matrix
level (the XC unit). An STS level cross-connect loopback causes an
AIS-P to be sent on the outgoing direction of transmission.
MACLPBK
The loopback mode on MAC-Layer of the port.
Table 3-10. MACLPBK values

Value Description
NOLB No loopback
RLB Remote loopback
LLB Local loopback
MTU
Indicates the Maximum Transmission Unit of the port, i.e. maximum packet size; the initial value is 1522. The valid
value ranges from 1518 to 9600.
PATH
The time slot of the VCG, support the & and && symbol, ranges from 1 to MAX_PATH_NUM.
Its maximum number (MAX_PATH_NUM) will be different in different devices.
PATHTYPE
The path type of VCG.
Table 3-11. PATHTYPE values

Value Description
STS1V SONET virtual concatenation: STS1V
STS3V SONET virtual concatenation: STS3V
VT1.5V SONET virtual concatenation: VT1.5V
STS1C SONET adjacent concatenation: STS1C
PHYLPBK
The loopback mode on PHY-Layer of the port.
Table 3-12. PHYLPBK values

Value Description
NOLB No loopback
RLB Remote loopback
LLB Local loopback
PM

<LOCN> NEND or FEND Indicates the location, in reference to the
entity identified by the <AID>, being
performance monitored. Thus, "near end"
refers to PM values obtained at the identified
entity, and "far end" refers to PM values
obtained at a distant entity that is connected to
the identified entity.
<DIRN> BTH, RCV or Specifies the direction of monitoring relative to
TRMT the entity identified by the <AID>.
<TMPER> 15-MIN, 1-DAY Specifies the accumulation time period for the
PM information.
<MONLEV> 0-UP, 1-UP Specifies the discriminating level for the
requested monitored parameter.
<THVAL> 0 to 4294967294 <THVAL> is the current threshold value for
the monitored parameter. Valid data types for
<THVAL> for a given <MONTYPE> are the
same as those for the corresponding
<MONVAL>.
<MONDAT> MOY-DOM <MONDAT> is the date of the beginning of the
requested PM period specified in <TMPER>.
The format of <MONDAT> is MM-DD.
<MONTM> HOD-MOH <MONTM> is the beginning time of day of the
requested PM period specified in <TMPER>.
The format of <MONTM> is HH-MM.
<MOD2> ALL, OC3, OC12,
OC48, OC192, T1,
T3, STS1, STS3C,
STS12C,
STS48C,
STS192C, VT1,
EQPT
<VLDTY> VALID/INVALID The validity indicator for historical monitoring
information. It indicates whether the
or
information for the specified time period was
COMPL/NA accumulated over the entire time period or
some portion of it.

<MONTYPE> BDTEMPCUR Specifies the type of monitored parameter for
which a value is requested.
BDTEMPMAX
BDTEMPMIN
CVCP-P
CV-L
CV-P
CVP-P
CV-S
CV-V
ESCP-P
ES-L
ES-P
ESP-P
ES-S
ES-V
LAPDBVCUR
LAPDBVMAX
LAPDBVMIN
LBCCUR
LBCMAX
LBCMIN
LCCCUR
LCCMAX
LCCMIN
LTEMPCUR
LTEMPMAX
LTEMPMIN
OPRCUR
OPRMAX
OPRMIN
OPTCUR
OPTMAX
OPTMIN

MONTYPE (cont.) PJCS-PDet Specifies the type of monitored parameter for
which a value is requested.
PJCS-VDet
PSC
PSD
SESCP-P
SES-L
SES-P
SESP-P
SES-S
SES-V
UASCP-P
UAS-L
UAS-P
UASP-P
UAS-V
PMUTEMPCUR
PMUTEMPMAX
PMUTEMPMIN
<PM-DAY-START> 0–23 The format for <PM-DAY-START> is HOD.
HOD stands for "hour of day" and ranges from
0 to 23.
To effect resetting the NE clock to the default
value of 00:00 hours, the <set-pmstart>
parameter should contain the value 0.
A null value for <PM-DAY-START> is not
allowed. If a null value is entered, the NE shall
send an error response, with appropriate error
text, and deny the SET-PMDAY command.
<TCATYPE> T-montype <TCATYPE> is the type of threshold violations
to be retrieved. Valid values can be:
T-x To be used with one or more AIDs to
request the return of reported threshold
violations for <montype> x.
ALL To be used with one or more AIDs to
request a return of all the threshold crossings
that were reported.
A null value will cause ALL threshold
crossings to be retrieved.

<CONDTYPE> T-montype <CONDTYPE> identifies the type of event,
condition, or alarm indication being reported.
For this command, <CONDTYPE> is the type
of threshold violation being reported on this
line of the message.
PORTENABLE
The enable state of the port, the initial value is N for Ethernet port.
Table 3-13. PORTENABLE values

Value Description
Y Yes, means enable
N No, means disable
PPTENABLE
Indicates whether flow control frame transmit to next hop transparent. The initial value is N.
Table 3-14. PPTENABLE values

Value Description
Y Yes, means enable
N No, means disable
PROTOCOL
The protocol type to encapsulate the Ethernet. The initial value is GFP.
Table 3-15. PROTOCOL values

Value Description
GFP Generic Framing Procedure
LAPS Link Access Procedure
HDLC High Level Data Link Control
PROVISION_STATE
Table 3-16. PROVISION_STATE values

Value Description
IS In-service.
OOS Out-of-service.
AINS Automatic in-service. For equipment and port facility, this state is available;
but for STS or VT path facility, this state is unavailable.
PST_STATE
Table 3-17. PST_STATE values

Value Description
IS-NR In-service, normal.
OOS-MA Out-of-service, management,
OOS-AU Out-of-service, autonomous.
OOS-AUMA Out-of-service, autonomous-and-management, maintenance
PTPMODE
The point-to-point attribute of the port, the initial value is AUTO.
Table 3-18. PTPMODE values

Value Description
AUTO The point-to-point status of the MAC to be determined in accordance
with the specific MAC procedures
FORCETRUE The MAC to be treated as if it is connected to a point-to-point LAN
segment, regardless of any indications to the contrary that are
generated by the MAC entity
FORCEFALSE The MAC to be treated as if it is connected to a non-point-to-point
LAN segment, regardless of any indications to the contrary that are
generated by the MAC entity. (See also 802.1W)
PVID
The default VLAN Identifier of the port ranges from 1 to 4095. The initial value is 1.
PVPRI
The default VLAN PRI of the port ranges from 0 to 7. The initial value is 0 (lowest). “7” means the highest priority.
RES
The synchronize quality of NE that the user provided.
Table 3-19. RES values

Value Description
ABOVEPRS Better than Primary Reference Source
PRS Equating to PRS
ABOVESTU Between STU and PRS
STU Equating to STU
ABOVEST2 Between ST2 and STU
ST2 Equating to ST2
ABOVETNC Between TNC and ST2, only for GEN2
TNC Equating to TNC, only for GEN2
ABOVEST3E Between ST3E and TNC, only for GEN2
ST3E Equating to ST3E, only for GEN2
ABOVEST3 Between ST3 and ST3E
ST3 Equating it ST3
DUS Disable the RES message
REVERTIVE MODE
Table 3-20. REVERTIVE MODE

Value Description
Y Revertive mode.
N No-revertive mode.
REVERTIVE TIME
Table 3-21. REVERTIVE TIME

Value Description
5 to 12 Revertive time, range from 5 to 12 minutes, default is 5
minutes, in increments of 1 minute.
RMON
Table 3-22. RMON values

<MOD2> ALL FETH and GETH are port type of the board in Ne. ALL means all
FETH FETH and GETH ports in NE.
GETH
<MONTYPE> ETHDROP The total number of events in which packets were dropped by the
probe due to lack of resources.
ETHALI A count of frames received on a particular interface that are not an

integral number of octets in length and do not pass the FCS check.
ETHCARERR
ETHCOL The best estimate of the total number of collisions on this Ethernet
segment.
ETHCRCALI A count of frames received on a particular interface that are not an

integral number of octets in length and do not pass the FCS check,
and that are an integral number of octets in length but do not pass
the FCS check.
ETHEXCCOL A count of frames for which transmission on a particular interface

fails due to excessive collisions.
ETHFCS A count of frames received on a particular interface that are an

integral number of octets in length but do not pass the FCS check.
ETHFRG The total number of packets received that were less than 64 octets
in length (excluding framing bits but including FCS octets) and had
either a bad Frame Check Sequence (FCS) with an integral
number of octets (FCS Error) or a bad FCS with a non-integral
number of octets (Alignment Error).
ETHJAB The total number of packets received that were longer than 1518
octets (excluding framing bits, but including FCS octets), and had
either a bad Frame Check Sequence (FCS) with an integral
number of octets (FCS Error) or a bad FCS with a non-integral
number of octets (Alignment Error).
ETHLATECOL A count of frames for which transmission on a particular interface

fails due to continuous collisions.
ETHMULCOL A count of successfully transmitted frames on a particular interface

for which transmission is inhibited by more than one collision.
ETHOVER The total number of packets received that were longer than 1518
octets (excluding framing bits, but including FCS octets) and were
otherwise well formed.
ETHUNDER The total number of packets received that were less than 64 octets
long (excluding framing bits, but including FCS octets) and were
otherwise well formed.
ETHUNICOL A count of successfully transmitted frames on a particular interface

for which transmission is inhibited by exactly one collision.

<MONTYPE> (cont.) PERALL
PKT1024 The total number of packets (including bad packets) transmitted and
received that were between 1024 and 1518 octets in length
inclusive (excluding framing bits but including FCS octets).
received that were between 128 and 255 octets in length inclusive
(excluding framing bits but including FCS octets).
received that were between 1519 and 1522 octets in length
inclusive (excluding framing bits but including FCS octets).
received that were 64 octets in length (excluding framing bits but
including FCS octets).
RXBBAD The total number of octets of bad packets received on the network
(excluding framing bits but including FCS octets)
RXBGOOD The total number of octets of good packets received on the network
(excluding framing bits but including FCS octets)
RXBRDCAST The total number of good packets received that were directed to the
broadcast address.
RXMULCAST The total number of good packets received that were directed to a
multicast address.
RXOCTETS The total number of octets of data (including those in bad packets)
received on the network (excluding framing bits but including FCS
octets).
RXPAUSE A count of MAC Control frames received on this interface with an

OPCODE indicating the PAUSE operation.
RXPKT1024 The total number of packets (including bad packets) received that
were between 1024 and 1518 octets in length inclusive (excluding
framing bits but including FCS octets).

<MONTYPE> (cont.) RXPKT256 The total number of packets (including bad packets) received that
were 64 octets in length (excluding framing bits but including FCS
octets).
RXPKTS The total number of packets (including bad packets) received on the
network (excluding framing bits but including FCS octets).
RXUNICAST The total number of good packets received that were directed to a
unicast address.
TXBBAD The total number of octets of bad packets transmitted on the

network (excluding framing bits but including FCS octets)
TXBGOOD The total number of octets of good packets transmitted on the

network (excluding framing bits but including FCS octets)
TXBRDCAST The total number of good packets transmitted that were directed to
the broadcast address.
TXDEFFRM
TXMULCAST The total number of good packets transmitted that were directed to
a multicast address.
TXPAUSE A count of MAC Control frames transmitted on this interface with an

OPCODE indicating the PAUSE operation.
TXPKT1024 The total number of packets (including bad packets) transmitted that

<MONTYPE> (cont.) TXPKT64 The total number of packets (including bad packets) transmitted that
were 64 octets in length (excluding framing bits but including FCS
octets).
TXUNICAST The total number of good packets transmitted that were directed to
a unicast address.
<MONLEVEL> 0-UP, 1-UP Specifies the discriminating level for the requested monitored
parameter.
<OCRDAT> YYYY-MM-DD DATE is the current date in a format of: YYYY-MM-DD, where
YYYY is the last two digits of the year ranging from 1990 to 2087,
MM is the month of the year ranging from 1 to 12, and DD is the day
of the month ranging from 1 to 31.
<OCRTM> HH-MM-SS TIME is the current time in a format of: HH-MM-SS, where HH is the
hour in a 24 hour format ranging from 00 to 23, MM is the minute
ranging from 00 to 59, and SS is the second ranging from 00 to 59.
<PRDTP> 30S Period type of history control table.

30M
PRDVAR
PRDALL
<RECNUM> 1 to 50 Records number of the history.
<PRD> 300 to 86400 Specifies period of prdvar of history control table.
<ENFLAG> ENABLE Specifies the states of History contol table or Alarm control table.
DISABLE
<RPTMODE> RPTUP Report mode of the alarm control table.

RPTDOWN
RPTALL
<INTERVAL> 5 to 600 Alarm sample interval.
<RTHR> 1 to 4294967295 The value of rising threshold.
<FTHR> 0 to 4294967294 The value of falling threshold.
<LASTTIME> 0 to 4294967295 Duration.
<PACKET> 0 to 4294967295 Packets of rmon perfermens insert into counter every second.
SCRAMBLER
The scrambler type.
Table 3-23. SCRAMBLER values

Value Description
DISABLE DISABLE
X43 X43
X48 X48
SM
Table 3-24. SM values

<UID> The User Identifier. It’s a string of 4 ACT-USER
to 16 characters, each of which CANC-USER
must be visible character (including
space) excluding TL1 syntax ED-PID
characters, such as the double ENT-USER-SECU
quotation, comma, colon, and
semicolon. DLT-USER-SECU
It is a nonconfidential identifier that ED-USER-SECU

uniquely determines a user (such RTRV-USER-SECU
as the user’s login ID). This
INH-USER-SECU
parameter is the “key” for each
record in this view. Each user must ALW-USER-SECU
have a unique UID.
<PID> A string of 6 to 16 characters, each ACT-USER
of which must be visible character ED-PID
(including space) excluding TL1
syntax characters, such as the ENT-USER-SECU
double quotation, comma, colon, ED-USER-SECU
and semicolon.
RTRV-USER-SECU
<ASN> Y Only for Huawei EMS, the default ACT-USER
value is N.
N
<UPC> RTRV The user’s privilege level ENT-USER-SECU
MAINT ED-USER-SECU
PROV RTRV-USER-SECU
SUPER
<TMOUTEN> ENABLE The flag which allows user can ENT-USER-SECU
DISABLE cancel automatically. The value of ED-USER-SECU
this flag is “ENABALE” and
“DISABALE”. The default value is RTRV-USER-SECU
“ENABALE”.
<TMOUTLN> 5 to 60 The time of canceling user ENT-USER-SECU

automatically. The unit of the time ED-USER-SECU
is minute, and it is from 5 to 60.
This parameter becomes effective RTRV-USER-SECU
when the value of TMOUTEN is
“ENABALE”. The default value is
60 (User do no any operation with
the NE in 60 minutes).
<PAGE> 25 to 999 The time in which the password is ENT-USER-SECU
in effect. The unit of the time is day, ED-USER-SECU
0
and it’s from 25-999, but 0 express
the password is always in effect. RTRV-USER-SECU
The default value is 0.
<UAGE> 1 to 999 The time in which the user’s name ENT-USER-SECU
is in effect. The unit of the time is
0 ED-USER-SECU
day, and it’s from 1-999, but 0
express the user is always in effect. RTRV-USER-SECU
The default value is 0.
<CONDTYPE> CMD The type of logoff. It’s include REPT^LOGOFF
LOGOFF following types: REPTÊVT^SECU
FORCE CMD LOGOFFlogoff by command
LOGOFF
FORCE LOGOFFlogoff forcibly
UIDEXP UIDEXP LOGOFFlogoff because
LOGOFF the user is out of time
AUTO AUTO LOGOFFlogoff automatically
LOGOFF
<CONDEF> TC Here is “TC” (transient condition) REPT^LOGOFF
REPTÊVT^SECU
SN
Table 3-25. SN values

Value Description
1 The highest priority for the unit in a TPS protection group
2 The secondary priority for the unit in a TPS protection group
3 The third priority for the unit in a TPS protection group
4 The lowest priority for the unit in a TPS protection group
SNMP
Table 3-26. SNMP values

IPAddress The type A, B and C A IP address of the trapinfo that will DLT-SNMPTRAPINFO
IP address be handled ENT-SNMPTRAPINFO
PortNumber valid number The UDP connection port number ENT-SNMPTRAPINFO
rdcommunity private Read community ENT-SNMPTRAPINFO
privacy
wtcommunity private Write community ENT-SNMPTRAPINFO
privacy
trapversion v1 SNMP trap version ENT-SNMPTRAPINFO
v2
v3
SSM
There are two set of SSM are used in the system. Here list out both these two set SSM messages and the mapping
relations between these two set of messages.
Table 3-27. SSM Generation 1st Message set

Value Description
PRS Primary reference source, Stratum1
STU Synchronization traceability unknown
ST2 Stratum2
ST3 Stratum3
SMC SONET minimum clock
ST4 Stratum 4, it is not support yet.
DUS Do not use for timing Synchronization
PNO Reserved:quality level set by user
CLEAR* Clear the manually SSM
Table 3-28. SSM Generation 2nd Message set

Value Description
PRS Primary reference source, Stratum1
STU Synchronization traceability unknown
ST2 Stratum2
TNC Transit note clock
ST3E Stratum3E
ST3 Stratum3
SMC SONET minimum clock
ST4 Stratum 4, it is not support yet.
DUS Do not use for timing Synchronization
PNO Reserved:quality level set by user
CLEARa Clear the manually SSM
a. CLEAR can be used only for the MANSSM parameter for clear the manually SSM.
Table 3-29. Mapping for SSM from 2nd generation to 1st generation
GEN 2 GEN1
PRS PRS
STU STU
ST2 ST2
TNC ST3
ST3E ST3
ST3 ST3
SMC SMC
ST4 ST4
DUS DUS
PNO RES
SST_STATE
Table 3-30. SST_STATE values

Value Description
ACT Active.
The entity is currently in use and has spare operating capacity for further
usage demand.
This SST only used when the entity is in the protection group.
AINS Automatic in-service.
The entity is in a delay transition (to IS state. The transition to IS is
pending on the correction of off-normal conditions on the entity (such as
UEQ for equipment or FAF for termination point)
FAF Facility failure
The associated transport facility is OOS.
This SST is only used for port or path facility.
FLT Fault
The entity is OOS because it is faulty.
This SST is only used for equipment entity.
LPBK Loopback
Loopback activity is currently being performed on the entity.
MEA Mismatch of equipment and attributes.
The entity is installed with improper equipment or circuit pack, or the
correct equipment has improper attributes.
MT Maintenance
The entity has been manually removed from service for maintenance
activity; this value shall be accompanied with the PST value OOS-MA or
OOS-AUMA.
STBYC Standby-cold
The entity is to back up another entity, but is not synchronized with the
backup entity. An entity with a cold standby status will not be immediately
able to take over the role of the backed-up entity, and will require some
initialization activity.
This SST only used when the entity is in the 1-N or 4-BLSR protection
group.
STBYH Standby-hot
The entity is to back up another entity, and is synchronized with the
backed-up entity. An entity with a hot standby status will be immediately
able to take over the role of the backed-up entity, without the need for
initialization activity.
This SST only used when the entity is in the 1+1 protection group.
Value Description
SGEO Supporting entity outage
The associated supporting entity has outage. This value is for qualifying
the OOS-AU state of an entity when its supporting entity is OOS-AU,
OOS-MA, or OOS-AUMA.
SWDL Software downloading.
Software download activity is currently performed on the entity. For
example, this value is applicable to software type entity (such as data file
or executable file) and software loadable equipment.
UAS Unassigned
The entity has not been assigned with the necessary provisioning data;
this value is used for clarifying the PSTQ value MA and AUMA. No service
activity and maintenance activity (including monitoring, testing, and
service recovery) are permitted in this state since the necessary data has
not been assigned.
UEQ Unequipped.
The equipment entity has not been equipped with the necessary
hardware, or the software entity has not been loaded with the necessary
data or code. This value is used for clarifying the PSTQ value AU.
RDLD This value indicates that the entity is a special (red-lined) circuit. A red-
lined entity can only be deleted by commands with proper value
specifications (i.e., with the keyword INCL equal to Y in the DELETE
command).
This SST is only used for cross connection.
RDLD-DEA Deactive RDLD state, only used for cross connection.
TS Testing activity, test access is currently being conducted on the entity.
SVTIMER
Table 3-31. SVTIMER values

Value Description
From 00-00 to Signal Validation Timer in minutes. Only valid if auto in-service
feature is supported. <SVTIMER> is a string, and format is:
48-00
HH-MM;
HH – Hour, it is an integer ranging from 0 to 48;
MM – Minute, it is an integer ranging from 0 to 59. The longest
time is 48 hours. Default is 00-01.
SWDL
Table 3-32. SWDL values

<AID> SLOT-N or SLOT-N or NULL. Only when FTYPE is
NULL RFR or RFBU can use SLOT-N. The
null value is active xcs unit.
<FTYPE> SWDL SWDL: Software package downloading
from remote PC to NE.
DBFDL
DBFDL: Downloading database from
DBFUL
PC to NE
RFR
DBFUL: Uploading database from NE to
RFBU PC.
RFR: Remote file restore (Remote
server to NE) Not support standby XCS
unit.
RFBU: Remote file backup (NE to
remote server). Not support standby
XCS unit.
<SRCURL> SWDL: FTP URL
DBFDL: FTP URL
DBFUL: NULL
RFR: FTP URL
RFBU: FILE URL
<DSTURL> SWDL: FTP URL
DBFDL: NULL
DBFUL: FTP URL
RFR: FILE URL
RFBU: FTP URL
<OVERWRITE> YES YES: Overwrite existing file of same
directory location and filename.
NO
NO: Do not overwrite file, fail the file
transfer if file already exists.
Notes, This parameter is only used for
RFR.

<TYPE> COLD COLD: cold restart, reload FPGA.
WARM WARM: warm restart, don’t reload
FPGA.
DBERASE
DBERASE: erase databases then do
SWDL
warm restart. Only AID is null or AID is
XCS unit can use this type.
SWDL: Only used for SWDL, reset unit
at least one of its SW/INI/EXTBIOS/
FPGA has been downloaded. If FPGA is
changed it should do cold restart,
otherwise warm restart. <AID> is null
while activate the whole system, and
before that, you can activate a specified
unit using <AID>. If there is no file
changed on that specified unit, the
command will return DENIED.
SWITCH STATE OF OPTICAL PORT
Table 3-33. SWITCH STATE OF OPTICAL PORT values

Value Description
FRCD Forced switch. It is only valid when the port in the SONET
line protection group.
MAN Manual switch. It is only valid when the port in the SONET
EXERCISE Exercise switch. It is only valid when the port in the SONET
NR Not report
WTR Wait to restore
DNR It is only valid when the port in the SONET line protection
group.
SD Signal degrade
SF Signal failure
LOCKOUT Lockout. It is only valid when the port in the SONET line
protection group.
LOW-S Lock of work, span

LOW-R Lock of work, ring
FRCD-S Force, Span
FRCD-R Force, Ring
Value Description
MAN-R Manual, Ring
MAN-S Manual, Span
EXER-S Exercise, Span
EXER-R Exercise, Ring
LKALL Lock all protection
LOW-S&LOW-R&LKALL Lock of work, Span and Lock of work, Ring and Lock all
protection
LOW-S&LOW-R Lock of work, Span and Lock of work, Ring
LOW-R&LKALL Lock of work, Ring and lock all protection
LOW-S&LKALL Lock of work, Span and lock all protection
LOW-S&LOW-R&LKALL&SF Lock of work, Span and lock of work, Ring and lock all
protection and SF
LOW-S&LOW-R&LKALL&SD Lock of work, Span and lock of work, Ring and lock all
protection and SD
LOW-S&LOW-R&SF Lock of work, Span and lock of work, Ring and SF
LOW-S&LOW-R&SD Lock of work, Span and lock of work, Ring and SD

LOW-S&LKALL&SF Lock of work, Span and lock all protection and SF
LOW-S&LKALL&SD Lock of work, Span and lock all protection and SD
LOW-R&LKALL&SF Lock of work, Ring and lock all protection and SF
LOW-R&LKALL&SD Lock of work, Ring and lock all protection and SD
LOW-S&SF Lock of work, Span and SF
LOW-S&SD Lock of work, Span and SD

LOW-R&SF Lock of work, Ring and SF
LOW-R&SD Lock of work, Ring and SD
LOW-S&MAN-R Lock of work, Span and manual, Ring
LOW-S&EXER-R Lock of work, Span and exercise, Ring
LOW-S&FRCD-R Lock of work, Span and force, Ring
LOW-S&WTR Lock of work, Span and WTR
LOW-R&MAN-S Lock of work, Ring and manual, Span
LOW-R&EXER-S Lock of work, Ring and exercise, Ring
LOW-R&FRCD-S Lock of work, Ring and force, Ring
Value Description
LOW-R&WTR Lock of work, Ring and WTR
LP-S Lock of protection, Span
LOW-R&LP-S Lock of work, Ring & Lock of protection, Span

LOW-S&LP-S Lock of work, Span & Lock of protection, Span
SWITCH STATE OF STS PATH OR VT PATH
Table 3-34. SWITCH STATE OF STS PATH OR VT PATH values

Value Description
IDLE Idle
WTRSTATE Wait to restore
AUTO_SW Automatic switch
MAN_P_W Manually switch to the working unit
MAN_W_P Manually switch to the protecting unit
FRC_P_W Forced switch to the working unit
FRC_W_P Forced switch to the protecting unit
LOCKOUT Lock to the working unit
CLEAR Clear
INVALID Invalid
SYNCLBO
The line build out of synchronization BITS output DS1.
Table 3-35. SYNCLBO values

Value Description
1 Cable length from 0 to 133 feet
SYNCSTATE
The state of the synchronization reference source.
Table 3-36. SYNCSTATE values

Value Description
ACT The reference source is being tracked
MAN Manually switch to the reference source.
FRCD Force switch to the reference source
NORMAL The reference source is exist logically and has not been forced to
switch
WTR The reference source is in waiting to restore (WTR) state
DQL The quality of the reference source is lower than ST3
LOCKOUT The reference source has been locked out.
REFFAIL The reference source is fail
FRCD&REFFAIL Force switch to the reference source, and the reference source is
fail
FRCD&DQL Force switch to the reference source, and the quality of the
reference source is lower than ST3.
LOCKOUT&REFFAIL The reference source has been locked out, and it is fail.
LOCKOUT&DQL The reference source has been locked out, and the quality of the
reference source is lower than ST3.
SYSTEM
Table 3-37. SYSTEM values

<DATE> YYYY-MM-DD DATE is the current date in a format of:
YYYY-MM-DD, where YYYY is the last
two digits of the year ranging from 1990
to 2087, MM is the month of the year
ranging from 1 to 12, and DD is the day
of the month ranging from 1 to 31.
<TIME> HH-MM-SS TIME is the current time in a format of:
HH-MM-SS, where HH is the hour in a
24 hour format ranging from 00 to 23,
MM is the minute ranging from 00 to 59,
and SS is the second ranging from
00 to 59.

<TMZONE> UTC Can be Eastern, Central, Mountain or
Pacific, Hawaii (Add general time zone
Pacific
GMT-n,UTC).
Mountain
American time zone:
Central
ALASKA (GMT-9)
Eastern
SAMOA (GMT-11)
Hawaii
Pacific (GMT-8)
GMT-1
Mountain (GMT-7)
GMT-2
Central (GMT-6)
GMT-3
Eastern (GMT-5)
GMT-4
Hawaii (GMT-10)
ALASKA
SAMOA GMT-12
GMT+1
GMT+2
GMT+3
GMT+4
GMT+5
GMT+6
GMT+7
GMT+8
GMT+9
GMT+10
GMT+11
GMT+12
<DSTIME> Y Support Daylight Saving Time: Y|N.
N
<SID> <SID> identifies the new name of the
target NE. Using sid as tid. The max
length of characters is 20.
TACC
Table 3-38. TACC values

Value Description
0 to 999 The TAP number ranges from 0–999. When TACC is 0, the TAP is
invalid. < TACC > is an integer.
TACCMODE
<TACCMODE> indicates the test access mode.
Table 3-39. TACCMODE values

Value Description
MONE Monitor access with signal detector on A path
MONF Monitor access with signal detector on B path
MONEF Monitor access with signal detector on A and B paths
SPLTA Split access on A path with signal detector from equipment, QRS
on facility side
SPLTB Split access on B path with signal detector from equipment, QRS
on equipment side
SPLTE Split access on A and B paths with signal detector from equipment,
QRS on equipment side
SPLTF Split access on A and B paths with signal detector from facility,
QRS on facility side
SPLTEF Split access on A and B paths for testing in both equipment and
facility directions
TAGTYPE
The tag attribute of the port; the initial value is TAGAWARE.
Required only if LABELPORT is N and PORTCHECK is Y.
Table 3-40. TAGTYPE values

Value Description
TAGAWARE TAGAWARE
ACCESS ACCESS
HYBRID HYBRID
TAP
<TAP> indicates the test access path number selected by the NE. The <TAP> number must be an integer with a
range of 1 to 999.
TPS_PRIORITY
Table 3-41. TPS_PRIORITY

Value Description
1 to 4 TPS priority, range from 1 to 4. 1 is the highest value and 4
are the lowest. Default is 4, the lowest.
TPSPRI
Table 3-42. TPSPRI values

Value Description
1 The highest priority for the unit in a TPS protection group
2 The secondary priority for the unit in a TPS protection group
3 The third priority for the unit in a TPS protection group
4 The lowest priority for the unit in a TPS protection group
UNCRC
Indicates whether FCS is CRC reversed or not. Valid value can be Y or N. The initial value is Y.
Table 3-43. UNCRC values

Value Description
Y Yes: invert CRC
N No: Don't invert CRC
UPPATH
Indicates the time slot number of the VCG up direction; support the & and && symbol, ranges from 1 to
MAX_PATH_NUM. Its maximum number (MAX_PATH_NUM) will be different in different devices.
WAVE FREQUENCY
Table 3-44. WAVE FREQUENCY (THz) values

Value Description
192.1 Wave No.1
192.2 Wave No.2
192.3 Wave No.3
192.4 Wave No.4
192.5 Wave No.5
192.6 Wave No.6
192.7 Wave No.7
192.8 Wave No.8
192.9 Wave No.9
193 Wave No.10
193.1 Wave No.11
193.2 Wave No.12
193.3 Wave No.13
193.4 Wave No.14
193.5 Wave No.15
193.6 Wave No.16
193.7 Wave No.17
193.8 Wave No.18
193.9 Wave No.19
194 Wave No.20
194.1 Wave No.21
194.2 Wave No.22
194.3 Wave No.23
194.4 Wave No.24
194.5 Wave No.25
194.6 Wave No.26
194.7 Wave No.27
194.8 Wave No.28
194.9 Wave No.29
Value Description
195 Wave No.30
195.1 Wave No.31
195.2 Wave No.32
195.3 Wave No.33
195.4 Wave No.34
195.5 Wave No.35
195.6 Wave No.36
195.7 Wave No.37
195.8 Wave No.38
195.9 Wave No.39
196 Wave No.40
WAVELENGTH
Table 3-45. WAVELENGTH (nm) values

Value Description
1561.69 Wave No.1
1560.87 Wave No.2
1560.06 Wave No.3
1559.25 Wave No.4
1558.44 Wave No.5
1557.63 Wave No.6
1556.82 Wave No.7
1556.02 Wave No.8
1555.21 Wave No.9
1554.40 Wave No.10
1553.60 Wave No.11
1552.80 Wave No.12
1551.99 Wave No.13
1551.19 Wave No.14
1550.39 Wave No.15
1549.59 Wave No.16
Value Description
1548.79 Wave No.17
1547.99 Wave No.18
1547.19 Wave No.19
1546.39 Wave No.20
1545.60 Wave No.21
1544.80 Wave No.22
1544.00 Wave No.23
1543.21 Wave No.24
1542.42 Wave No.25
1541.62 Wave No.26
1540.83 Wave No.27
1540.04 Wave No.28
1539.25 Wave No.29
1538.46 Wave No.30
1537.67 Wave No.31
1536.89 Wave No.32
1536.10 Wave No.33
1535.31 Wave No.34
1534.53 Wave No.35
1533.74 Wave No.36
1532.96 Wave No.37
1532.18 Wave No.38
1531.39 Wave No.39
1530.61 Wave No.40
WORKMODE
The work mode of the port; the initial value is AUTO.
Table 3-46. WORKMODE values of EFS8

Value Description
AUTO Auto Negotiation
Table 3-47. WORKMODE values of EGT2

Value Description
AUTO Auto Negotiation
XCS PROTECTION SWITCH

Table 3-48. XCS PROTECTION SWITCH values
<HSCSWMODE> FORCE A/S switching type. SW-DX-EQPT
MANUAL
CLEAR
<ACT_SLOT> 1 or 2 (LoopStar Slot number of active REPT SW
800); working unit.
9 or 10 (LoopStar
1600);
<STDBY_SLOT> 1 or 2 (LoopStar Slot number of REPT SW
800); standby protecting
unit.
9 or 10 (LoopStar
1600);
Chapter 4
ERROR CODES
ERRORS LIST
For the description of each alarm, see “Alarms and Values” on page 5-1 in this manual.
TL1 error code Category NE error code Description

EANS EQUIPAGE NSERR_CFG_EQUIPAGE_ACCESS_ Access not supported
NOT_SUPPORTED
EATN EQUIPAGE Not valid for access type
EFON EQUIPAGE Feature option not provided
EN2T EQUIPAGE Not 2-wire terminate and leave
ENAC EQUIPAGE Not equipped with alarm cutoff
ENAD EQUIPAGE Not equipped with audit capability
ENAR EQUIPAGE Not equipped with automatic

reconfiguration
ENAT EQUIPAGE Request not valid for access type
ENDG EQUIPAGE Not equipped with diagnostic capability
ENDS EQUIPAGE NSERR_CFG_XCS_NOT_INSTALL Not equipped with duplex switching
ENEA EQUIPAGE Not equipped with error analysis

capability
ENEQ EQUIPAGE Not equipped
ENEX EQUIPAGE Not equipped with exercise capability
ENFE EQUIPAGE Feature not provided
ENFL EQUIPAGE Not equipped for fault locating
ENHN EQUIPAGE Not hybrid network
ENMB EQUIPAGE Not multipoint bridge
ENMD EQUIPAGE Not equipped with memory device
ENPM EQUIPAGE Not equipped for performance monitoring
ENPS EQUIPAGE Not equipped with protection switching
ENRE EQUIPAGE Not recognized equipage
ENRI EQUIPAGE Not equipped for retrieving specified

information
ENRS EQUIPAGE Not equipped for restoration
ENSA EQUIPAGE Not equipped for scheduling audit
ENSG EQUIPAGE Not software generic
ENSI EQUIPAGE Not equipped for setting specified

information
Chapter 4: Error Codes July 29, 2005

ENSS EQUIPAGE Not equipped with synchronization
switching
ENTL EQUIPAGE Not terminate and leave
ERLC EQUIPAGE Red-lined circuit
ERNS EQUIPAGE RTU does not support command
ESPG EQUIPAGE Software program
ETNS EQUIPAGE TSC does not support command
FNCR FAULT NE failure – circuit restored to last

condition – monitor or terminate
FNDT FAULT No dial tone detected
FNEC FAULT NTE has lost 8-kHz byte clock
FNSC FAULT NTE has lost 64-kHz bit clock
FRCE FAULT RTU component or configuration error
FRDA FAULT RTU does not answer the call
FREC FAULT RTU 8-kHz byte clock lost
FRNR FAULT RTU does not reply
IBEX INPUT Block, extra
IBMS INPUT Block, missing
IBNC INPUT Block, not consistent
ICNV INPUT Command not valid
IDMS INPUT Data missing
IDNC INPUT Data not consistent
IDNV INPUT NSERR_CFG_LMS_BAD_KBYTE Data not valid
IDRG INPUT Data range error
IEAE INPUT Entity to be created already exists
IENE INPUT NSERR_CFG_TPS_ALREADY_EXIST Specified object entity does not exist

NSERR_CFG_PROT_NOT_EXIST
NSERR_CFG_GET_NULL
NSERR_CFG_BD_NOT_EXIST
NSERR_CFG_XC_NOT_EXIST
NSERR_CFG_TPS_NOT_EXIST
NSERR_CFG_UPSR_NOT_EXIST
IIAC INPUT Invalid access identifier (AID)
IICM INPUT Invalid command
IICT INPUT Invalid correlation tag
IIDT INPUT Invalid data parameter
July 29, 2005 Chapter 4: Error Codes

IIFM INPUT Invalid data format
IIPG INPUT Invalid parameter grouping
IISP INPUT Invalid syntax or punctuation
IITA INPUT Invalid target identifier
INAC INPUT NSERR_CFG_ACCESS_NUMBER_ Access number not correct

NOT_CORRECT
INUP INPUT Non-null unimplemented parameter
IPEX INPUT Parameter extra
IPMS INPUT Parameter missing
IPNC INPUT NSERR_CFG_LOOPMODE_ERR Parameter not consistent

NSERR_CFG_SYNNUM_ERR
NSERR_CFG_SYNPOS_ERR
NSERR_CFG_LOCKOUT_INTERNAL_
SYN_ERR
NSERR_CFG_LOCKMODE_ERR
NSERR_CFG_RESTORE_MODE_ERR
NSERR_CFG_MANUAL_QUALITYMODE_
ERR
NSERR_CFG_SWITCH_STATE_ERR
NSERR_CFG_SYN_NOTEXIST_PRI_
ERR
NSERR_CFG_RESTORE_TIME_ERR
NSERR_CFG_S1_PROTOCOLMODE_ERR
NSERR_CFG_SSMMODE_ERR
NSERR_CFG_PARALEN_ERR

IPNV INPUT NSERR_CFG_BAD_MATRIX_LEVEL Parameter not valid
NSERR_CFG_TPS_WKBD_INVALID
NSERR_CFG_TPS_PROTBD_INVALID
NSERR_CFG_TPS_IBD_INVALID
NSERR_CFG_PROTOCOL_VERIFY_
FAILURE
NSERR_CFG_XC_NUM_TOO_MUCH
NSERR_CFG_UPSR_LOW_PRIORITY
NSERR_CFG_BAD_STATE
NSERR_CFG_BAD_INTFTYPE
NSERR_CFG_BAD_PDIP
NSERR_CFG_BAD_RDLD
NSERR_CFG_BAD_PREFERREDPATH
NSERR_CFG_BAD_XCNAME
NSERR_STAM_INTERNAL_ERROR
NSERR_STAM_STATE_REFUSE_
OPEATION
NSERR_STAM_AINSNODE_FAILURE
NSERR_STAM_DMM_FAILURE
NSERR_CFG_BAD_TIMING_MODE
NSERR_CFG_BAD_SSM_GEN
NSERR_CFG_BAD_PROTOCAL_ENABLE
NSERR_CFG_BAD_PASSMODE
NSERR_CFG_PATH_NOT_EXIST
NSERR_CFG_BAD_PATH_LEVEL
NSERR_CFG_SLOT_USED
NSERR_CFG_CANT_ADD_BD
NSERR_CFG_BAD_ALS_OPENTIME
NSERR_CFG_BAD_ALS_CLOSETIME
NSERR_CFG_BAD_ALS_TESTTIME
NSERR_CFG_BAD_TPLMODE
NSERR_CFG_BAD_SQLMODE
NSERR_CFG_BAD_NODEID
NSERR_CFG_BLSR_NOT_EXIST
NSERR_CFG_BLSR_LOW_PRI

IPNV (cont.) INPUT NSERR_CFG_BLSR_RINGMAP_NOT_ Parameter not valid
READY
NSERR_CFG_BLSR_SQLTB_NULL
NSERR_CFG_BLSR_IN_SWITCH_STATE
NSERR_CFG_BLSR_SNDPDU_PARAM
NSERR_CFG_BLSR_SNDPDU_DATALEN
NSERR_CFG_BLSR_SNDPDU_SOCKET
NSERR_CFG_PORT_ERR
NSERR_CFG_BAD_DIR
NSERR_CFG_BAD_PARA
NSERR_CFG_BAD_STC2
NSERR_CFG_BAD_SRC2
NSERR_CFG_BAD_GAIN
NSERR_CFG_BAD_SRV5
NSERR_CFG_BAD_XCID
NSERR_CFG_BAD_VTID
NSERR_CFG_BAD_ALMID
NSERR_CFG_BAD_FRAME
NSERR_CFG_BAD_ACTID
NSERR_CFG_BAD_STSID
NSERR_CFG_BAD_CONID
NSERR_CFG_BAD_BDTYPE
NSERR_CFG_BAD_SLOTID
NSERR_CFG_BAD_PORTID
NSERR_CFG_BAD_TH_VAL
NSERR_CFG_BAD_PATHID
NSERR_CFG_BAD_MODEID
NSERR_CFG_BAD_BIP2TH
NSERR_CFG_BAD_USEDID
NSERR_CFG_BAD_RVTMODE
NSERR_CFG_BAD_WTRTIME
NSERR_CFG_BAD_NESTATE
NSERR_CFG_BAD_TH_TYPE
NSERR_CFG_BAD_TRCMODE
NSERR_CFG_BAD_TOH_POS
NSERR_CFG_BAD_OHPOSID
NSERR_CFG_BAD_XCLEVEL
NSERR_CFG_BAD_LMS_TYPE
NSERR_CFG_BAD_LOOPMODE

IPNV (cont.) INPUT NSERR_CFG_BAD_PORTTYPE Parameter not valid
NSERR_CFG_BAD_ENABLEID
NSERR_CFG_BAD_LINECODE
NSERR_CFG_BAD_LMS_PGID
NSERR_CFG_BAD_LMS_PUID
NSERR_CFG_BAD_TPS_PGID
NSERR_CFG_BAD_TPS_PUID
NSERR_CFG_BAD_TPS_PRIO
NSERR_CFG_BAD_EXT_SWCMD
NSERR_CFG_UPSR_BAD_PUID
NSERR_BDRSP_BAD_PARALEN
NSERR_CFG_BAD_LMS_SWMODE
NSERR_CFG_BAD_TOH_STATUS
NSERR_CFG_BAD_SYN_SOURCE
NSERR_CFG_BAD_SYNCLASSID
NSERR_CFG_DBFID_NOTEXIST
NSERR_CFG_BAD_TPS_PGID
NSERR_CFG_BAD_TPS_PUID
NSERR_CFG_BAD_TPS_PRIO
NSERR_CFG_BAD_EXT_SWCMD
NSERR_CFG_UPSR_BAD_PUID
NSERR_BDRSP_BAD_PARALEN
NSERR_CFG_BAD_LMS_SWMODE
NSERR_CFG_BAD_TOH_STATUS
NSERR_CFG_BAD_SYN_SOURCE
NSERR_CFG_BAD_SYNCLASSID
NSERR_CFG_DBFID_NOTEXIST
ISCH INPUT Syntax invalid character
ISPC INPUT Syntax punctuation
ITSN INPUT Invalid/inactive test session number
PICC PRIVILEGE Illegal command code
PIMA PRIVILEGE Invalid memory address
PIMF PRIVILEGE Invalid memory file

PIUC PRIVILEGE Stated user privilege code is illegal
PLNA PRIVILEGE Login not active
RABY RESOURCE NSERR_CFG_RESOURCE_ALL_TAPS_BU All taps busy

SY
RALB RESOURCE All units of requested type are busy
RANB RESOURCE Access network busy

RCBY RESOURCE Circuit busy
RCIN RESOURCE Requested circuit id does not exist
RNAN RESOURCE Requested NE access number does not

exist
RNAU RESOURCE Requested NE access number

unassigned
RNBY RESOURCE NSERR_BAD_BDRSP NE is busy

NSERR_BDRSP_CMD_OVERTIME
RRCB RESOURCE Unit specified by routing code busy
RRNG RESOURCE Requested change exceeds range

RTBY RESOURCE NSERR_CFG_REQUESTED_TAP_BUSY Requested tap busy
RTEN RESOURCE NSERR_CFG_REQUESTED_TAP_DOES_N Requested tap does not exist

OT_EXIST
RTUB RESOURCE NSERR_CFG_RESOURCE_TEST_UNIT_B Test unit busy

USY
SAAL STATUS Already allowed
SAAS STATUS Already assigned
SABT STATUS NSERR_CFG_SWITCH_DENIED Aborted

NSERR_CFG_CANT_DEL_BD
NSERR_ADD_UPSR_FAILED
NSERR_CFG_NEED_TO_BACKUP
SACS STATUS Access unit can't sync on facility signal
SADC STATUS NSERR_CFG_ALREADY_DISCONNECTED Already disconnected
SADS STATUS Access unit in diagnostic state
SAIN STATUS NSERR_CFG_POH_DISABLE Already inhibited
SAIS STATUS NSERR_CFG_PROTOCOL_ALREADY_ Already in-service

START
NSERR_CFG_CRS_CAN_NOT_DLT
SAMS STATUS Already in maintenance state
SAOP STATUS Already operated
SAOS STATUS Already out-of-service
SAPF STATUS Access path continuity check failed
SAPR STATUS Already in protection state
SARB STATUS All resources busy
SATF STATUS Automatic test failed
SCAT STATUS Circuit is already connected to another

tap
SCBS STATUS Channel busy

SCIS STATUS Circuit in split condition
SCNA STATUS Command not able to be aborted
SCNF STATUS Command not found
SCNS STATUS Circuit not in split condition
SCOS STATUS Channel out-of-service
SCSD STATUS Cannot split DS0B circuit
SCSN STATUS Invalid command sequence
SDAS STATUS Diagnosis already started
SDBE STATUS Internal data base error
SDFA STATUS Duplex unit failed
SDLD STATUS Duplex unit locked
SDNA STATUS Duplex unit not available
SDNC STATUS Input data is not consistent with NE data
SDNR STATUS Data not ready
SDNS STATUS Diagnosis not started yet
SEOS STATUS NTE is out-of-service
SFAS STATUS Fault locating already started
SFNS STATUS Fault locating not started yet
SFYA STATUS Facility reports yellow alarm
SLNS STATUS Log not started yet
SLOS STATUS TSC to RTU link out of service
SNCC STATUS Not cross-connected
SNCN STATUS NTE unable to execute command
SNDS STATUS NTE is in a diagnostic state
SNIM STATUS NTE access complete, circuit was in

monitor state
SNIS STATUS Not in service
SNML STATUS No monitor line established
SNNB STATUS NTE could not sync on DS0B signal
SNNS STATUS NTE could not sync on ds1 signal
SNOS STATUS NTE is out-of-service
SNPR STATUS Not in protection state
SNRM STATUS System not in restoration mode

SNRS STATUS Not reserved
SNSR STATUS No switch request outstanding

SNVS STATUS Not in valid state
SNYA STATUS NTE has detected a yellow alarm
SOSE STATUS Operating system error
SOST STATUS Out-of-service, testing
SPFA STATUS Protection unit failed
SPLD STATUS Protection unit locked
SPNA STATUS Process not able to be aborted
SPNF STATUS Process not found
SRAC STATUS Requested access configuration is invalid
SRAN STATUS Unable to release access system
SRCI STATUS Requested command(s) inhibited
SRCN STATUS Requested condition already exists
SROF STATUS Requested operation failed
SROS STATUS Required RTU out of service
SRQN STATUS Invalid request
SRTN STATUS Unable to release tap
SRTO STATUS Reply timeout occurred
SSCE STATUS Systemic (snider) communications error
SSNG STATUS Subrate selected is incorrect
SSNP STATUS Test signal not pseudo-random
SSNQ STATUS Test signal not QRS
SSPN STATUS Speed selected is incorrect
SSRD STATUS Switch request denied
SSRE STATUS System resources exceeded
SSTP STATUS Execution stopped due to hardware or

software problem
STAB STATUS Test aborted
STLC STATUS Tap unable to locate channel
STNO STATUS TSC/RTU to TAU link out of service
STOS STATUS Test access unit out of service
STTI STATUS Tap idle
SWFA STATUS Working unit failed
SWLD STATUS Working unit locked
Chapter 5
ALARMS AND VALUES
This chapter lists the alarms, errors, threshold, and performance.
ALARM AND CONDITION LIST
Alarm Service
Condition Type AID type severity effecting LOCN DIRM Description
REFFAIL BITS/OC3/ MN NSA NEND RCV Synchronization reference
OC12/OC48/ source failure
OC192
SSM-DQL BITS/OC3/ MN NSA NEND NA Synchronization reference
OC12/OC48/ source in SSM is less than
OC192 ST3
SSM-LOS BITS/OC3/ MN NSA NEND RCV Loss of synchronization
OC12/OC48/ message
OC192
MANUAL-SSM-SET BITS/OC3/ NA NSA NEND RCV Manually set the SSM of a
OC12/OC48/ synchronization reference
OC192
ALS E100 NA SA FEND TRMT Automatically shutdown the
transmitting laser on detecting
LOS
LASER-NOT-EXIST E100 MJ SA NEND NA Laser not exist in Ethernet unit
LINK-ERR E100 CR SA NEND NA Link error
LOS E100 CR SA NEND RCV Loss of signal
LPBK-TERMINAL E100 NA SA NEND NA Ports are in facility loopback
operation
ALS E1000 NA SA FEND TRMT Automatically shutdown the
transmitting laser on detecting
LOS
LASER-NOT-EXIST E1000 MJ SA NEND NA laser not exist in Ethernet unit
LINK-ERR E1000 CR SA NEND NA Link error
LOS E1000 CR SA NEND RCV Loss of signal
LPBK-TERMINAL E1000 NA SA NEND NA Ports are in facility loopback
operation
INTF-RMV EQPT CR SA NEND NA Interface unit is offline
ATE-RMV EQPT MJ SA NEND NA ATE unit is offline or loosed in
the slot
Chapter 5: Alarms and Values July 29, 2005
Alarm Service
EQPT-SA EQPT CR SA NEND NA Service-affecting equipment
failure
EQPT-NSA EQPT MN NSA NEND NA None service-affecting
equipment failure
UPGRADE-IP EQPT/OC3/ NA NSA NEND NA Upgrade in progress
OC12/OC48/
OC192
LOW SYNC/EQPT/ NA NSA NEND/ NA Lockout of working unit
VT1/OC3/ FEND
OC12/OC48/
OC192/STS1/
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
LOW-R OC12/OC48/ NA NSA NEND NA Lockout of working ring
OC192
LOW-S OC12/OC48/ NA NSA NEND NA Lockout of working span
OC192
LOCKOUT OC3/OC12/ NA NSA NEND NA Lockout of the LAPS protocol
OC48/OC192
SWDL-CHGMNG- EQPT CR SA NEND NA SWDL change message
MISMATCH mismatch
SWDL-ACTIVATED EQPT CR SA NEND NA SWDL activated for long time
SWDL- EQPT CR SA NEND NA SWDL NE package check file
NEPKGCHECK minssing
CHAN-FAIL-SLOTN EQPT MJ NSA NEND NA Channel fail
COMMIT-TIMEOUT EQPT MJ NSA NEND NA Software package not commit
in time
DBMS-CFG- EQPT MJ NSA NEND NA The configure data is not
BACKUP-FAILED consistent between the active
unit and the standby unit
DBMS-ERROR EQPT MJ SA NEND NA Database error
EQPT-FAIL EQPT CR/MN SA/NSA NEND NA Service-affecting equipment
failure
FAN-FAIL EQPT MJ/CR SA NEND NA Critical if two or more fans fail
FAN-RMV EQPT MN NSA NEND NA FAN offline
July 29, 2005 Chapter 5: Alarms and Values
Alarm Service
FRCD EQPT NA NSA NEND NA Forced switch
HSC-UNAVAIL EQPT MJ NSA/SA NEND NA Hot switch control unavailable
SA: failure in the active unit.
NSA: failure in the standby
unit.
INTF-FAIL EQPT CR/MN SA/NSA NEND NA Interface unit fail
INTF-MEA EQPT CR/MN SA/NSA NEND NA Interface unit type error
INVALID-EQPT EQPT MJ NSA NEND NA The inserted physical unit is
not support by the slot
LP EQPT NA NSA NEND NA Lockout of protection unit
LW EQPT NA NSA NEND NA Lockout of working unit
MAN EQPT NA NSA NEND NA Manual switch
MEA EQPT MJ SA NEND NA Unit type error
NEBD-DATA-MEA EQPT MJ NSA NEND NA The configure data is not
consistent between NE
software and unit software
NESF-LOST EQPT CR SA NEND NA Software lost
PROTECT-MODE EQPT MN NSA NEND NA Database is in protect mode
PWR-FAIL EQPT MJ NSA NEND NA Failures for the power supply
RMV EQPT MJ SA NEND NA Unit is offline or loosed in
the slot
SV-MEA EQPT MN NSA NEND NA Software version mismatch
TEMP-HI EQPT MN NSA NEND NA High temperature
WTR EQPT NA NSA NEND NA Wait to recover
AIS-L OC3/OC12/ NR SA/NSA NEND RCV SONET AIS-line
OC48/OC192
ALS OC3/OC12/ NA SA NEND RCV/ Automatic laser shutdown –
OC48/OC192 TRMT LOS
APSCM OC3/OC12/ MN NSA NEND NA The channel number in the
OC48/OC192 received K2 byte is not
identical to the channel
number transmitted in the
K1 byte.
DCC-FAIL OC3/OC12/ MN NSA NEND RCV DCC failure indication
OC48/OC192
ETSQL OC3/OC12/ MN NSA NEND NA Extra traffic is being squelched
OC48/OC192
Alarm Service
EXER OC3/OC12/ NA NSA NEND/ NA Exercise switch
OC48/OC192 FEND
EXER-R OC3/OC12/ NA NSA NEND NA Exercise switch –Ring
OC48/OC192
EXER-S OC3/OC12/ NA NSA NEND NA Exercise switch –Span
OC48/OC192
FRCD OC3/OC12/ NA NSA NEND/ NA Forced switch
OC48/OC192 FEND
FRCD-R OC3/OC12/ NA NSA NEND NA Force switch of ring
OC48/OC192
FRCD-S OC3/OC12/ NA NSA NEND NA Force switch of Span
OC48/OC192
IN-PWR-HIGH OC3/OC12/ MN SA/NSA NEND RCV Input power exceeds standard
OC48/OC192 level
IN-PWR-LOW OC3/OC12/ MN SA/NSA NEND RCV Input power is lower than
OC48/OC192 standard level
LAPDBV-HIGH OC3/OC12/ MN SA/NSA NEND TRMT Laser APD bias voltage
OC48/OC192 exceeds standard level
LAPDBV-LOW OC3/OC12/ MN SA/NSA NEND TRMT Laser APD bias voltage is
OC48/OC192 lower than standard level
APSB OC3/OC12/ MN NSA NEND NA Detection of invalid K-bytes.
OC48/OC192
FEPRLF OC3/OC12/ MN NSA FEND NA Far-end protection channel
OC48/OC192 detects SF condition.
APSMM OC3/OC12/ MN NSA NEND NA LAPS mode mismatch - switch
OC48/OC192 mode
APSTM OC3/OC12/ MN NSA FEND NA LAPS mode mismatch -
OC48/OC192 architecture
LASER-NOT-EXIST OC3/OC12/ MJ/MN SA/NSA NEND NA Laser is not plugged-in
OC48/OC192
LASER-SHUT OC3/OC12/ NA SA NEND RCV/ Laser shut down
OC48/OC192 TRMT
LBC-HIGH OC3/OC12/ MN SA/NSA NEND TRMT Laser bias current exceeds
OC48/OC192 high threshold
LBC-LOW OC3/OC12/ MN SA/NSA NEND TRMT Laser bias current is lower
OC48/OC192 than low threshold
LCC-HIGH OC3/OC12/ MN SA/NSA NEND NA Laser diode cooling current
OC48/OC192 exceeds standard level
Alarm Service
LCC-LOW OC3/OC12/ MN SA/NSA NEND NA Laser diode cooling current is
OC48/OC192 lower than standard level
LOF OC3/OC12/ CR/MN SA/NSA NEND RCV Loss of frame
OC48/OC192
LOS OC3/OC12/ CR/MN SA/NSA NEND RCV Loss of signal
OC48/OC192
LP OC3/OC12/ NA NSA NEND/ NA Lockout of protection unit
OC48/OC192 FEND
LPBKFACILITY OC3/OC12/ NA SA NEND RCV/ Facility loopback
OC48/OC192 TRMT
LPBKTERM OC3/OC12/ NA SA NEND RCV/ Terminal loopback,
OC48/OC192 TRMT
LP-S OC3/OC12/ NA NSA NEND NA Lockout of protection span
OC48/OC192
LSQL OC3/OC12/ NA NSA NEND NA Persistent line squelching
OC48/OC192
LSR-EOL OC3/OC12/ MN NSA NEND RCV/ Laser approaching end of life
OC48/OC192 TRMT
LTEMP-HIGH OC3/OC12/ MN SA/NSA NEND NA Laser temperature exceeds
LTEMP-LOW OC3/OC12/ MN SA/NSA NEND NA Laser temperature is lower
OC48/OC192 than standard level
LW OC3/OC12/ NA NSA NEND/ NA Lockout of working unit
OC48/OC192 FEND
LW-R OC3/OC12/ NA NSA NEND NA Lockout of working-ring
OC48/OC192
LW-S OC3/OC12/ NA NSA NEND NA Lockout of working-span
OC48/OC192
MAN OC3/OC12/ NA NSA NEND/ NA Manual switch
OC48/OC192 FEND
MAN-R OC3/OC12/ NA NSA NEND NA Manual switch of ring
OC48/OC192
MAN-S OC3/OC12/ NA NSA NEND NA Manual switch of Span
OC48/OC192
NODEID-MISM OC3/OC12/ MJ NSA NEND NA Node ID duplicated or
OC48/OC192 mismatched
NO-LSR-PARA OC3/OC12/ MN NSA NEND NA Laser parameter-table file
OC48/OC192 is lost
Alarm Service
OUT-PWR-HIGH OC3/OC12/ NA SA NEND TRMT Out power exceeds standard
OC48/OC192 level
OUT-PWR-LOW OC3/OC12/ NA SA NEND TRMT Out power is lower than
PRIMARYCHN- OC3/OC12/ NR NSA NEND NA Primary channel change
CHANGE OC48/OC192
RFI-L OC3/OC12/ NR NSA FEND RCV Remote failure indication - line
OC48/OC192
RINGM-MM OC3/OC12/ MN NSA NEND NA RING mode mismatched,
OC48/OC192 some nodes in Auto and some
in Manual mode
OOF OC3/OC12/ MJ/MN SA/NSA NEND RCV Out of frame
OC48/OC192
SD-L OC3/OC12/ MJ/MN SA/NSA NEND RCV Signal degrade - line
OC48/OC192
SD-S OC3/OC12/ MJ/MN SA/NSA NEND RCV Signal degrade -section
OC48/OC192
SF-L OC3/OC12/ CR/MN SA/NSA NEND RCV Signal failure - line
OC48/OC192
SF-S OC3/OC12/ CR/MN SA/NSA NEND RCV Signal failure - section
OC48/OC192
SQLALM OC3/OC12/ MJ NSA NEND NA Squelch table needs updating
OC48/OC192 or is invalid
SQLM-MM OC3/OC12/ MN NSA NEND NA Squelch mode mismatched,
OC48/OC192 some nodes in Auto and some
in manual mode
TF OC3/OC12/ MJ/MN SA/NSA NEND TRMT Transmitter failure
OC48/OC192
TPLALM OC3/OC12/ MJ NSA NEND NA Topology needs updating or is
OC48/OC192 invalid
WTR OC3/OC12/ NA NSA NEND/ NA Wait to recover
OC48/OC192 FEND
XCON-MM OC3/OC12/ MN NSA NEND NA Cross-connection type is
OC48/OC192 mismatched with adjacent
node
Alarm Service
AIS-P STS1/ NR SA/NSA NEND RCV SONET AIS - path
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
ERFI-P-CONN STS1/ NR NSA FEND RCV Enhanced remote connectivity
STS3C/ failure indication - STS path
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
ERFI-P-PLD STS1/ NR NSA FEND RCV Enhanced remote payload
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
ERFI-P-SER STS1/ NR NSA FEND RCV Enhanced remote server
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
FRCD STS1/ NA NSA NEND NA Forced switch
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
Alarm Service
LOP-P STS1/ CR/MN SA/NSA NEND RCV SONET loss of pointer STS-
STS3C/ path
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
LPBKFACILITY-P STS1/ NA SA NEND NA Loopback, facility - STS path
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C
LPBKTERM-P STS1/ NA SA NEND NA Loopback, terminal - STS path
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C
LW STS1/ NA NSA NEND NA Lockout of working unit
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
MAN STS1/ NA NSA NEND NA Manual switch
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
PDI-P STS1/ CR/MJ/ SA/NSA NEND RCV Payload defect indication-
STS3C/ MN STS
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
Alarm Service
PLM-P STS1/ CR/MN SA/NSA NEND RCV Payload label mismatch - STS
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
RFI-P STS1/ NR NSA FEND RCV SONET remote failure
STS3C/ indication - STS path
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
SD-P STS1/ MJ/MN SA/NSA NEND RCV Signal degrade STS-path
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
SF-P STS1/ CR/MN SA/NSA NEND RCV Signal failure STS-path
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
TIM-P STS1/ CR/MN SA/NSA NEND RCV SONET trace identifier
STS3C/ mismatch STS-path
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
Alarm Service
UNEQ-P STS1/ CR/MN SA/NSA NEND RCV Unequipped - STS
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
WTR STS1/ NA NSA NEND NA Wait to restore
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
LPBKCRS STS1/ NA SA NEND NA Loopback, cross-connect
STS3C/
STS6C/
STS9C/
STS12C/
STS24C/
STS48C/
STS192C
FREERUN-SYNC SYNC MN NSA NEND NE is in free run
synchronization mode
FSTSYNC SYNC NA NSA NEND NA A fast start synchronization
mode alarm
HLDOVER-SYNC SYNC NA NSA NEND NA In holdover synchronization
mode
MANUAL-SSM-SET SYNC NA NSA NSA RCV Manual set a reference's SSM
SSM-DQL SYNC/OC3/ MN NSA NEND NA Timing source in SSM less
OC12/OC48/ than ST3
OC192
SSM-LOS SYNC/OC3/ NA NSA NEND NA Timing source in SSM invalid
OC12/OC48/
OC192
SYNC-FRCD-SW SYNC NA SA/NSA NEND RCV Forced switch
SYNC-LOCKOUT- SYNC NA NSA NEND RCV Lockout switch
SW
SYNC-LOS SYNC NA NSA NEND NA Timing source in sync list loss
SYNC-MANUAL- SYNC NA NSA NEND RCV Manual switch
SW(rvrtv=n)
Alarm Service
AIS T1 NA SA NEND TRMT DS1 Tx alarm indication signal
AIS T1 NR SA NEND RCV DS1 Rx alarm indication signal
INHLPBK T1 NA SA NEND NA Automatic loopback inhibited
LOF T1 CR/MN SA/NSA NEND RCV DS1 Rx loss of frame
LOF T1 MJ/MN SA/NSA NEND TRMT DS1 Tx loss of frame
LOS T1 CR/MN SA/NSA NEND RCV Loss of DS1 signal
LPBKALLDS1FEAC T1 NA SA NEND RCV Rx Loop back, all DS1s in DS3
FEAC
LPBKDS1FEAC T1 NA SA NEND TRMT Tx Loop back, DS1 FEAC
LPBKDS1FEAC T1 NA SA NEND RCV Rx Loop back, DS1 FEAC
LPBK-FACILITY T1 NA SA NEND NA Ports are in facility loopback
operation
LPBK-TERMINAL T1 NA SA NEND NA Ports are in terminal loopback
operation
RAI T1 NA NSA FEND TRMT
DS1 Tx remote alarm
indication
RAI T1 NR NSA FEND RCV
DS1 Rx remote alarm
indication
AIC T3 MJ/MN SA NEND RCV DS3 receive path mismatch of
framing application
AIC T3 MJ/MN SA NEND TRMT DS3 transmit path mismatch of
framing application
AIS T3 NA SA NEND TRMT DS3 Tx alarm indication signal
AIS T3 NR SA NEND RCV DS3 Rx alarm indication signal
INHLPBK T3 NA SA NEND NA Automatic loopback inhibited
LOF T3 MJ/MN SA/NSA NEND RCV DS3 Rx loss of frame
LOF T3 MJ/MN SA/NSA NEND TRMT DS3 Tx loss of frame
LOS T3 CR/MN SA/NSA NEND RCV Loss of DS3 signal
LPBKALLDS3FEAC T3 NA SA NEND RCV Rx loop back, all DS1s in DS3
FEAC
LPBKDS3FEAC T3 NA SA NEND TRMT Tx loop back, DS1 FEAC
LPBKDS3FEAC T3 NA SA NEND RCV Rx loop back, DS1 FEAC
LPBK-FACILITY T3 NA SA NEND NA Ports are In facility loopback
operation
Alarm Service
LPBK-TERMINAL T3 NA SA NEND NA Ports are in terminal loopback
operation
RAI T3 NA NSA FEND TRMT DS3 Tx remote alarm
indication
RAI T3 NR NSA FEND RCV DS3 Rx remote alarm
indication
TSA T1/T3 NA SA NEND NA Test session is active
LOA-P VCGROUP MJ SA NEND RCV The alignment of H4
multiframe lost
LOM-P VCGROUP MJ SA NEND RCV H4 multiframe lost
SQM-P VCGROUP MJ SA NEND RCV H4 multiframe sequence
number mismatched
AIS-V VT1 NR SA/NSA NEND TRMT VT path alarm indication signal
ERFI-V-CONN VT1 NR NSA FEND TRMT VT path remote connectivity
failure indication
ERFI-V-PLD VT1/T1 NR NSA FEND TRMT VT path remote payload failure
indication
ERFI-V-SER VT1 NR NSA FEND TRMT VT path remote server failure
indication
FRCD VT1 NA NSA NEND NA Forced switch
LOP-V VT1 MJ/MN SA/NSA NEND RCV Loss of VT pointer
LW VT1 NA NSA NEND NA Lockout of working unit
MAN VT1 NA NSA NEND NA Manual switch
PLM-V VT1 CR/MN SA/NSA NEND RCV VT path payload label
mismatch
RFI-V VT1 NR SA FEND TRMT VT path remote failure
indication
SD-V VT1 CR/MN SA/NSA NEND RCV BER signal degrade – VT path
SF-V VT1 CR/MN SA/NSA NEND RCV BER signal failure – VT path
UNEQ-V VT1 CR/MN SA/NSA NEND RCV VT path unequipped
WTR VT1 NA NSA NEND NA Wait to restore
ENV-AIRCOMPR ENV CR NSA NEND NA Air compressor failure
ENV-AIRCOND ENV CR NSA NEND NA Air conditioning failure
Alarm Service
ENV-AIRDRYR ENV CR NSA NEND NA Air dryer failure
ENV-BATDSCHRG ENV CR NSA NEND NA Battery discharging
ENV-BATTERY ENV CR NSA NEND NA Battery failure
ENV-CLFAN ENV CR NSA NEND NA Cooling fan failure
ENV-CPMAJOR ENV CR NSA NEND NA Centralized power major

environmental alarm or major
ENV-CPMINOR ENV CR NSA NEND NA Centralized power minor

environmental alarm or minor
ENV-ENGINE ENV CR NSA NEND NA Engine failure

ENV-ENGOPRG ENV CR NSA NEND NA Engine operating
ENV-EXPLGS ENV CR NSA NEND NA Explosive gas

ENV-FIRDETR ENV CR NSA NEND NA Fire detector failure
ENV-FIRE ENV CR NSA NEND NA Fire
ENV-FLOOD ENV CR NSA NEND NA Flood

ENV-FUSE ENV CR NSA NEND NA Fuse failure
ENV-GEN ENV CR NSA NEND NA Generator failure
ENV-HIAIR ENV CR NSA NEND NA High airflow

ENV-HIHUM ENV CR NSA NEND NA High humidity
ENV-HITEMP ENV CR NSA NEND NA High temperature
ENV-HIWTR ENV CR NSA NEND NA High water

ENV-INTRUDER ENV CR NSA NEND NA Intrusion
ENV-LWBATVG ENV CR NSA NEND NA Low battery voltage
ENV-LWFUEL ENV CR NSA NEND NA Low fuel
Alarm Service
ENV-LWHUM ENV CR NSA NEND NA Low humidity
ENV-LWPRES ENV CR NSA NEND NA Low cable pressure
ENV-LWTEMP ENV CR NSA NEND NA Low temperature
ENV-LWWTR ENV CR NSA NEND NA Low water

ENV-MISC ENV CR NSA NEND NA Miscellaneous
ENV-OPENDR ENV CR NSA NEND NA Open door

ENV-PUMP ENV CR NSA NEND NA Pump failure
ENV-POWER ENV CR NSA NEND NA Commercial power failure
ENV-PWR-48 ENV CR NSA NEND NA 48 volt power supply failure

ENV-RECT ENV CR NSA NEND NA Rectifier failure
ENV-RECTHI ENV CR NSA NEND NA Rectifier high voltage
ENV-RECTLO ENV CR NSA NEND NA Rectifier low voltage
ENV-SMOKE ENV CR NSA NEND NA Smoke
ENV-TOXICGAS ENV CR NSA NEND NA Toxic gas

ENV-VENTN ENV CR NSA NEND NA Ventilation system failure
CONT-AIRCOND ENV NA NSA NEND NA Air conditioning
CONT-ENGINE ENV NA NSA NEND NA Engine

CONT-FAN ENV NA NSA NEND NA Fan
CONT-GEN ENV NA NSA NEND NA Generator
CONT-HEAT ENV NA NSA NEND NA Heat

CONT-LIGHT ENV NA NSA NEND NA Light
CONT-MISC ENV NA NSA NEND NA Miscellaneous
CONT-SPKLR ENV NA NSA NEND NA Sprinkler
AUTONOMOUS MESSAGE LIST
Autonomous
AID type message Severity LOCN DIRN Description
OC3/OC12/ TCA-coding violations -

T-CV-L NA NEND RCV
OC48/OC192 line
OC3/OC12/ TCA-coding violations -

T-CV-L NA FEND RCV
OC48/OC192 line
OC3/OC12/ TCA - coding violations -

T-CV-S NA NEND RCV
OC48/OC192 section
OC3/OC12/
T-ES-L NA NEND RCV TCA - error seconds -line
OC48/OC192
OC3/OC12/
T-ES-L NA FEND RCV TCA - error seconds - line
OC48/OC192
OC3/OC12/ TCA - error seconds -

T-ES-S NA NEND RCV
OC48/OC192 section
OC3/OC12/ TCA - severely error

T-SES-L NA NEND RCV
OC48/OC192 seconds - line

T-SES-L NA FEND RCV

T-SES-S NA NEND RCV
OC48/OC192 seconds - section
OC3/OC12/ TCA - unavailable

T-UAS-L NA NEND RCV
OC3/OC12/ TCA - unavailable

T-UAS-L NA FEND RCV
STS1/STS3C/
STS6C/
STS9C/
TCA - coding violation -
STS12C/ T-CV-P NA NEND RCV
STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
STS12C/ T-CV-P NA FEND RCV
STS path
STS24C/
STS48C/
STS192C
Autonomous
STS1/STS3C/
STS6C/
STS9C/
TCA - error seconds -
STS12C/ T-ES-P NA NEND RCV
STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
STS12C/ T-ES-P NA FEND RCV
STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
TCA - severely error
STS12C/ T-SES-P NA NEND RCV
seconds - STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
STS12C/ T-SES-P NA FEND RCV
seconds - STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
T-UAS-P TCA - unavailable
STS12C/ NA NEND RCV
seconds - STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
T-UAS-P TCA - unavailable
STS12C/ NA FEND RCV
seconds - STS path
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/ TCA - pointer justification
STS12C/ T-PJCS-PDet NA NEND RCV count seconds - VT path
STS24C/ detect
STS48C/
STS192C
Autonomous

T1 T-CV-L NA NEND RCV
line

T1 T-CV-P NA NEND RCV/TRMT
path

T1 T-CV-P NA FEND RCV/TRMT
path
T1 T-ES-L NA NEND RCV TCA - error seconds - line
T1 T-ES-L NA FEND RCV/TRMT TCA - error seconds - line
T1 T-ES-P NA NEND RCV/TRMT TCA -error seconds - path

T1 T-ES-P NA FEND RCV/TRMT
path

T1 T-SES-L NA NEND RCV
seconds - line

T1 T-SES-P NA NEND RCV/TRMT
seconds - path

T1 T-SES-P NA FEND RCV/TRMT
seconds - path
TCA - unavailable
T1 T-UAS-L NA NEND RCV
seconds - line
TCA - unavailable
T1 T-UAS-P NA NEND RCV/TRMT
seconds - path
TCA - unavailable
T1 T-UAS-P NA FEND RCV/TRMT
seconds - path
TCA - CP bit parity errors

T3 T-CVCP-P NA NEND RCV/TRMT
- path
TCA - CP bit parity errors

T3 T-CVCP-P NA FEND RCV/TRMT
- path

T3 T-CV-L NA NEND RCV
line

T3 T-CVP-P NA NEND RCV/TRMT
path
TCA - CP bit error

T3 T-ESCP-P NA NEND RCV/TRMT
seconds - path
TCA - CP bit error

T3 T-ESCP-P NA FEND RCV/TRMT
seconds - path
T3 T-ES-L NA NEND RCV TCA - error seconds - line

T3 T-ESP-P NA NEND RCV/TRMT
path
Autonomous
TCA - CP Bit severely

T3 T-SESCP-P NA NEND RCV/TRMT
error seconds - path
TCA - CP Bit severely

T3 T-SESCP-P NA FEND RCV/TRMT
error seconds - path

T3 T-SES-L NA NEND RCV
seconds - line

T3 T-SESP-P NA NEND RCV/TRMT
seconds - path
TCA - CP Bit unavailable

T3 T-UASCP-P NA NEND RCV/TRMT
seconds - path
TCA - CP Bit unavailable

T3 T-UASCP-P NA FEND RCV/TRMT
seconds - path

T3 T-UASP-P NA NEND RCV/TRMT
seconds - path

VT1 T-CV-V NA NEND RCV
VT path

VT1 T-CV-V NA FEND RCV
VT path
TCA - error seconds - VT

VT1 T-ES-V NA NEND RCV
path
TCA - error seconds - VT

VT1 T-ES-V NA FEND RCV
path
TCA - pointer justification

VT1 T-PJCS-VDet NA NEND RCV count seconds - VT path
detect

VT1 T-SES-V NA NEND RCV
seconds - VT path

VT1 T-SES-V NA FEND RCV
seconds - VT path
TCA - unavailable
VT1 T-UAS-V NA NEND RCV
seconds - VT path
TCA - unavailable
VT1 T-UAS-V NA FEND RCV
seconds - VT path
Working unit switch to the

EQPT WKSWPR NA NEND NA
protecting unit
Switch back to the

EQPT WKSWBK NA NEND NA
working unit
EQPT SECU-ALM MN NEND NA Login illegal
OC3/OC12/ Node state change to

RINGSWITCH NA NEND NA
OC48/OC192 switched
Autonomous
OC3/OC12/ Node state change to

SPANSWITCH NA NEND NA
OC48/OC192 switched
OC3/OC12/
SW-FAIL NA NEND NA Switch fail event
OC48/OC192
OC3/OC12/ SWTOPASST Node state change to

NA NEND NA
OC48/OC192 HRU pass through
OC3/OC12/ Switch back to the

WKSWBK NA NEND NA
OC48/OC192 working unit
OC3/OC12/ Working unit switch to the

WKSWPR NA NEND NA
OC48/OC192 protecting unit
STS1/STS3C/
STS6C/
STS9C/
STS12C/ SW-FAIL NA NEND NA Switch event
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
Switch back to the
STS12C/ WKSWBK NA NEND NA
working unit
STS24C/
STS48C/
STS192C
STS1/STS3C/
STS6C/
STS9C/
Working unit switch to the
STS12C/ WKSWPR NA NEND NA
protecting unit
STS24C/
STS48C/
STS192C
In normal synchronization
SYNC NORMAL NA NEND NA
mode.
SYNC-SSM- Receive SSM of reference

SYNC NA NEND NA
CHANGE source make a change
SYNC SYNC-SW NA NEND NA Switch event
TIMING-
Timing source mode
SYNC MODE- NA NEND NA
change
CHANGE
PERFORMANCE AND THRESHOLD LIST
AID type PM type Description LOCN DIRN 15-min threshold 1-day threshold
DS1 line CV-L Code violation -line NEND RCV 1...13,340...16,383 1...133,400...1048,575
ES-L Errored second-line NEND RCV 1...65...900 1...648...65,535
FEND RCV/TRMT 1...65...900 1...648...65,535
SES-L Severely errored second -line NEND RCV 1...10...900 1...100...65,535
DS1 path CV-P Code violation-path NEND RCV/TRMT 1...13,296...16,383 1...132,960... 1,048,575
FEND RCV/TRMT 1...13,296...16,383 1...132,960... 1,048,575
ES-P Errored second-path NEND RCV/TRMT 1...65...900 1...648...65,535
FEND RCV/TRMT 1...65...900 1...648...65,535
SES-P Severely error second-path NEND RCV/TRMT 1...10...900 1...100...65,535
FEND RCV/TRMT 1...10...900 1...100...65,535
UAS-P Unavailable second-path NEND RCV/TRMT 1...10...900 1...10...65,535
FEND RCV/TRMT 1...10...900 1...10...65,535
DS3 line CV-L Code violation-line NEND RCV 1...387...16,383 1...3,865... 1048,575
SES-L Severely errored second-line NEND RCV 1...4...900 1...40...65,535
DS3 path CVCP-P Code violation-path, CP-bit NEND RCV/TRMT 1...382...16,383 1...3,820...1,048,575
CVCP-P Code violation-path, CP-bit FEND RCV/TRMT 1...382...900 1...3,820...1,048,575
CVP-P Code violation-path,P-bit NEND RCV/TRMT 1...382... 16,383 1...3,820...1048,575
ESCP-P Errored second-path, CP-bit NEND RCV/TRMT 1...25...900 1...250...65,535
FEND RCV/TRMT 1...25...900 1...250...65,535
ESP-P Errored second-path, P-bit NEND RCV/TRMT 1...25...900 1...250...65,535
SESCP-P Severely errored second- NEND RCV/TRMT 1...4...900 1...40...65,535

path, CP-bit
FEND RCV/TRMT 1...4...900 1...40...65535
SESP-P Severely errored second- NEND RCV/TRMT 1...4...900 1...40...65,535

path, P-bit
UASCP-P Unavailable second-path, NEND RCV/TRMT 1...10...900 1...10...65,535

CP-bit
FEND RCV/TRMT 1...10...900 1...10...65,535
UASP-P Unavailable second-path, NEND RCV/TRMT 1...10...900 1...10...65,535

P-bit
VT path CV-V Code violation-VT path NEND RCV 1...13296...16,383 1...132960...1,048,575
FEND RCV 1...13296...16,383 1...132960...1,048,575
ES-V Errored second-VT path NEND RCV 1...10...900 1...100...65,535
FEND RCV 1...10...900 1...100...65,535
SES-V Severely Errored second-VT NEND RCV 1...1...900 1...7...65,535

path
FEND RCV 1...1...900 1...7...65,535
UAS-V Unavailable second-VT path NEND RCV 1...10...900 1...10...65,535
FEND RCV 1...10...900 1...10...65,535
PJCS-VDet Pointer justification count NEND RCV 1...10...900 1...100...65,535

second- VT path detected
Section CV-S Code violation-section NEND RCV 1...1500...16,383 1...15000...1,048,575
ES-S Errored second-section NEND RCV 1...50...900 1...100...65535
SES-S Severely errored second- NEND RCV 1...50...900 1...100...65535

section
Line CV-L Code violation-line NEND RCV 1...1500...16,383 1...15000...1,048,575
FEND RCV 1...1500...16,383 1...15000...65,535
FEND RCV 1...87...900 1...870...65,535
SES-L Severely errored second-line NEND RCV 1...1...900 1...10...65,535
FEND RCV 1...1...900 1...10...65,535
UAS-L Unavailable second-line NEND RCV 1...10...900 1...10...65,535
FEND RCV 1...10...900 1...10...65,535
PSC Protection switching count NEND RCV NR NR
PSD Protection switching duration NEND RCV NR NR
STS path CV-P Code violation-path NEND RCV Rate (STS-Nc) Rate (STS-Nc)
STS-1c: 1...15...16383 STS-1c: 1...125... 1048575
STS-3c: 1...25...16383 STS-3c: 1...250... 1048575
STS-6c: 1...25...16383 STS-6c: 1...250... 1048575
STS-9c: 1...25...16383 STS-9c: 1...250... 1048575
STS-12c: STS-12c: 1...750... 1048575
1...75...16383 STS-24c: 1...750... 1048575
STS-24c: STS-48c: 1...2250... 1048575
1...75...16383
STS-192c: 1...6750... 1048575
STS-48c:
1...225...16383
STS-192c:
1...675...16383
FEND RCV Rate (STS-Nc) Rate (STS-Nc)

STS-1c: 1...15...16383 STS-1c: 1...125... 1048575
STS-3c: 1...25...16383 STS-3c: 1...250... 1048575
STS-6c: 1...25...16383 STS-6c: 1...250... 1048575
STS-9c: 1...25...16383 STS-9c: 1...250... 1048575
STS-12c: STS-12c: 1...750... 1048575
1...75...16383 STS-24c: 1...750... 1048575
STS-24c: STS-48c: 1...2250... 1048575
1...75...16383
STS-192c: 1...6750... 1048575
STS-48c:
1...225...16383
STS-192c:
1...675...16383
ES-P Errored second-path NEND RCV Rate (STS-Nc) Rate (STS-Nc)

STS-1c: 1...12...900 STS-1c: 1...100... 65535
STS-3c: 1...20...900 STS-3c: 1...200... 65535
STS-6c: 1...20...900 STS-6c: 1...200... 65535
STS-9c: 1...20...900 STS-9c: 1...200... 65535
STS-12c: 1...60...900 STS-12c: 1...600... 65535
STS-24c: 1...60...900 STS-24c: 1...600... 65535
STS-48c: 1...180...900 STS-48c: 1...1800... 65535
STS-192c: STS-192c: 1...5400... 65535
1...540...900
FEND RCV Rate (STS-Nc) Rate (STS-Nc)

STS-1c: 1...12...900 STS-1c: 1...100... 65535
STS-3c: 1...20...900 STS-3c: 1...200... 65535
STS-6c: 1...20...900 STS-6c: 1...200... 65535
STS-9c: 1...20...900 STS-9c: 1...200... 65535
STS-12c: 1...60...900 STS-12c: 1...600... 65535
STS-24c: 1...60...900 STS-24c: 1...600... 65535
STS-48c: 1...180...900 STS-48c: 1...1800... 65535
STS-192c: STS-192c: 1...5400... 65535
1...540...900
STS path SES-P Severely errored second-path NEND RCV 1...3...900 1...7...65,535
(cont.)
FEND RCV 1...3...900 1...7...65,535
UAS-P Unavailable second-path NEND RCV 1...10...900 1...10...65,535
FEND RCV 1...10...900 1...10...65,535
PJCS-PDet Pointer justification count NEND RCV 1...10...900 1...100...65,535

second- STS path detected
Physical BDTEMPCUR Unit temperature current NEND NA NA NA
BDTEMPMAX Unit temperature Maximum NEND NA NA NA
BDTEMPMIN Unit temperature Minimum NEND NA NA NA
LBCCUR Laser bias current NEND RCV NA NA
LBCMAX Laser Bias maximum NEND RCV NA NA
LBCMIN Laser Bias minimum NEND RCV NA NA
OPTCUR Optical power transmitted NEND TRMT NA NA

current
OPTMAX Optical power transmitted NEND TRMT NA NA

maximum
OPTMIN Optical power transmitted NEND TRMT NA NA

minimum
OPRCUR Optical power received NEND RCV NA NA

current
OPRMAX Optical power received NEND RCV NA NA

maximum
OPRMIN Optical power received NEND RCV NA NA

minimum
LCCCUR Laser diode cooling current NEND RCV/TRMT NA NA
LCCMAX Laser diode cooling maximum NEND RCV/TRMT NA NA
LCCMIN Laser diode cooling minimum NEND RCV/TRMT NA NA
LTEMPCUR Laser temperature current NEND RCV/TRMT NA NA
LTEMPMAX Laser temperature maximum NEND RCV/TRMT NA NA
LTEMPMIN Laser temperature minimum NEND RCV/TRMT NA NA
LAPDBVCUR Laser APD bias voltage NEND RCV/TRMT NA NA

current
LAPDBVMAX Laser APD bias voltage NEND RCV/TRMT NA NA
maximum
LAPDBVMI Laser APD bias voltage

NEND RCV/TRMT NA NA
N minimum
PMUTEMPC
PIU temperature current NEND NA NA NA
UR
PMUTEMP
PIU temperature maximum NEND NA NA NA
MAX
PMUTEMP
PIU temperature minimum NEND NA NA NA
MIN
Appendix A
PRODUCT SUPPORT
ADC Customer Service Group provides expert pre-sales support and training for all of its products. Technical
support is available 24 hours a day, 7 days a week by contacting the ADC Technical Assistance Center.
Sales Assistance: 800.366.3891 Quotation Proposals, Ordering and Delivery General,

and Product Information
Systems Integration: 800.366.3891 Complete Solutions (from concept to installation),
Network Design and Integration Testing, System Turn-
Up and Testing, Network Monitoring (upstream or
downstream), Power Monitoring and Remote
Surveillance, Service/Maintenance Agreements, and
Systems Operation
ADC Technical Assistance Center: Technical Information, System/Network Configuration,
800.366.3891 Product Specification and Application, Training
(product-specific), Installation and Operation
Email: wsd.support@adc.com Assistance, and Troubleshooting and Repair/Field
Assistance
Online Technical Support: www.adc.com/Knowledge_Base/index.jsp
Online Technical Publications: www.adc.com/documentationlibrary/
technicalpublications/
Product Return Department: 800.366.3891 ADC Return Material Authorization (RMA) number and
instructions must be obtained before returning products.
Email: repair.return@adc.com
LPS800-UM-COMM-02 A-1
Appendix A: Product Support July 29, 2005
A-2 LPS800-UM-COMM-02
GLOSSARY
A
ABR – Available Bit Rate
ACE – Adaptive Communication Environment
ADM – Add/Drop Multiplexer
ADSL – Asymmetric Digital Subscriber Line
AIS – Alarm Indication Signal
ALS – Automatic Laser Shutdown
AM – Administration Module
AMI – Alternate Mark Inversion Code
ANSI – American National Standard Institute
AP – Span-Powered Access Point
APS – Automatic Protection Switching
ASCII – American Standard Code for Information Interchange
ASN.1 – Abstract Syntax Notation One
ATM – Asynchronous Transfer Mode
AWG – American Wire Gauge
B
B-DCS – Broadband digital cross connects
BER – Bit Error Rate
BIOS – Basic Input/Output System
BIP – Bit Interleaved Parity
BITS – Building Integrated Timing Supply
BLSR – Bi-directional Line Switched Ring
BML – Business Management Layer
BOM – Bill of Materials
C
CA – Certificate Authority
CAR – Committed Access Rate
CD – CD/CD-ROM
CDE – Common Desktop Environment
CM – Communication Module
CMISE – Common Management Information Service Element
CO – Central Office
CORBA – Common Object Request Broker Architecture
CoS – Class of Service
CPU – Central Processing Unit
CR – Carriage Return
CTS – Clear To Send
CUI – Code User Interface
LPS800-UM-COMM-02 GL-1
Glossary July 29, 2005
D
DBCHG – Database Changed
DC – Direct Current
DCN – Data Communication Network
DDN – Digital Data Network
DHCP – Dynamic Host Configuration Protocol
DLC – Digital Loop Carrier
DN – Distinguished Name
DNI – Dual Node Interconnection
DNS – Domain Naming System
DRI – Dual Ring Interconnection
DSL – Digital Subscriber Loop
DSLAM – Digital Subscriber Line Access Multiplexer
DSSS – Direct Sequence Spread Spectrum
DUS – Do not use for timing synchronization
DWDM – Dense Wavelength Division Multiplexing
DXC – Digital Cross Connect System
E
ECC – Embedded Control Channel
EC-1 – Electrical Carrier Level 1
EFS – Error-free second
EMC – Electro Magnetic Compatibility
EML – Element Management Layer
EMI – Electro Magnetic Interference
EMS – Element Management System
EPL – Ethernet Private Line
EPLAN – Ethernet Private LAN
EPS – Equipment Protection Switch
ES – Errored second
ESCON – Enterprise System Connection
ESD – Electrostatic Discharge
EVPL – Ethernet Virtual Private Line
EVPLAN – Ethernet Virtual Private LAN
F
FAQ – Frequently Asked Questions
FCAPS – Fault Management, Configuration Management, Accounting Management, Performance Management,
Security Management
FE – Fast Ethernet
FEAC – Far-End Alarm Control
FICON – Fiber Connection
FLASH – FLASH memory
FSVP – Fiber Share Virtual Path
FTP – File Transfer Protocol
GL-2 LPS800-UM-COMM-02
July 29, 2005 Glossary
G
GCM – Global Cluster Manager
GE – Gigabit Ethernet
GFP – Generic Framing Procedure
GNE – Gateway Network Element
G.SHDSL – Single-pair High-speed Digital Subscriber Line
GUI – Graphic User Interface
H
HA – High-Availability
HDLC – High-level Data Link Control
HTTP – Hypertext Transfer Protocol
HTTPS – Hypertext Transfer Protocol Secure
I
IC – Integrated Circuit
IGMP – Internet Group Management Protocol
iMAP – Integrated Management Application Platform
IP – Internet Protocol
IR – Intermediate Reach
ISDN – Integrated Services Digital Network
ITU-T – International Telecommunication Union-Telecommunication Standardization Sector
L
LAG – Link Aggregation Group
LAN – Local Area Nertwork
LAPS – Line Automatic Protection Switching
LBO – Line Build-Out
LCAS – Link Capacity Adjustment Scheme
LCS – Leased Circuit Service
LCT – Local Craft Terminal
LED – Light Emitting Diode
LLC – Logical Link Control
LOF – Loss Of Frame
LOP – Loss Of Pointer
LOS – Loss Of Signal
LPT – Link Pass Through
LR – Long Reach
LSP – Label Switch Path
M
MAC – Media Access Control
MADM – Multiple Add/Drop Multiplexer
MCF – Message Communication Function
MDI – Multi-Document Interface
MDP – Message Dispatch Process
Mgr – Manager
MIB – Management Information Base
MIT – Managed Object Instance Tree
MLM – Multi-Longitudinal Mode (laser)
MLT – Mechanized Loop Testing
MML – Man Machine Language
MO – Managed Object
MPLS – Multiprotocol Label Switching
MPPE – Microsoft Point-to-Point Encryption Protocol
MS – Multiplex Section
MTIE – Maximum Time Interval Error
MUX – Multiplexer
N
NE – Network Element
NEL – Network Element Level
NEBS – Network Equipment Building System
NIC – Network Interface Card
NM – Network Management
NML – Network Management Layer
NMS – Network Management System
NP – Network Processor
NT1 – Network Termination Type-1
O
OAM – Operation Administration and Maintenance
OAM&P – Operation, Administration, Maintenance and Provisioning
OC-1 – Optical Carrier Level 1
OC-N – Optical Carrier Level N
OEM – Original Equipment Manufacturer
OH – Overhead
OIF – Optical Internetworking Forum
ORL – Optical Return Loss
OSF – Operation System Function
OSI – Open Systems Interconnection
OSP – Outside Plant
OSPF – Open Shortest Path First
P
PC – Personal Computer
PDH – Plesiochronous Digital Hierarchy
PE – Provider Edge
PGND – Protection Ground
PIU – Power Interface Unit
PLM – Payload Label Mismatch
PM – Performance Management
POH – Path Overhead
POTS – Plain Old Telephone Service
PP – Path Protection
PRS – Primary reference source
PST – Primary State
PSTN – Public Switched Telephone Network
PTP – Point-to-Point
Q
QoS – Quality of Service
R
RADIUS – Remote Authentication Dial-In Service
RAM – Remote Access Multiplexer
RAS – Remote Access Server
RDI – Remote Defect Indication
RDMS – Relational Database Management System
REG – Regenerators
RES – Reserved for Network Synchronization Use
RMA – Return Material Authorization
RMS – Root-Mean-Square
RMON – Remote Monitoring
RPR – Resilient Packet Ring
RS – Regenerator Section
RTS – Request To Send
RUP – Rational Unified Process
S
SCB – Serial Communication Bus
SCC – System Control and Communication Mode
SCSI – Small Computer Systems Interface
SD – Signal Degradation
SDBER – Signal Degrade Bit Error Ratio
SDH – Synchronous Digital Hierarchy
SEFS – Severely errored frame second
SEMF – Synchronous Equipment Management Function
SES – severely errored second
SF – Signal Failure
SIF – SONET Interoperability Forum
SLM – Single Longitudinal Mode
SMC – SONET minimum clock
SML – Service Management Layer
SMS – Service Management System
SMTP – Simple Mail Transfer Protocol
SN – Sequence Number
SNCMP – Sub-Network Connection Multiple Protection
SNCP – Sub-Network Connection Protection
SNML – Sub-Network Management Layer
SNMP – Simple Network Management Protocol
SNMS – Sub-Network Management System
SOH – Section Overhead
SONET – Synchronous Optical Network
SPE – Synchronous Payload Envelope
SSID – Service Set Identifier (Wireless Network Name)
SSL – Secure Sockets Layer
SSM – Synchronization Status Marker
SSR – Side-mode Suppression Ratio
SST – Secondary State
STP – Spanning Tree Protocol
STS – Synchronous Transport Signal
STS-1 – Synchronous Transport Signal Level 1
STU – Sync traceability unknown
T
TCM – Tandem Connection Measurement
TC-PAM – Trellis Coded Pulse Amplitude Modulation
TCP/IP – Transmission Control Protocol/Internet Protocol
TDEV – Time Deviation
TDM – Time Division Multiplex
TKIP – Temporary Key Integrity Protocol
TL1 – Transaction Language 1
TM – Terminal Multiplex
TMF – Telecommunication Management Forum
TMN – Telecommunication Management Network
TNC – Transit node clock
TOH – transport overhead
TPS – Tributary Protection Switching
TTL – Time To Live
TU – Tributary Unit
U
UAS – Unavailable Seconds
UBR – Unspecified Bit Rate
UML – Unified Modeling Language
UNEQ – Unequipped
UPS – Uninterrupted Power Supply
UPSR – Unidirectional Path Switched Ring
V
VC – Virtual Circuit
VCI – Virtual Circuit Identifier
VCS – Veritas Cluster Server
VLAN – Virtual Local Area Network
VOD – Video On Demand
VPI – Virtual Path Identifier
VPN – Virtual Private Network
VT – Virtual Tributary
VVR – Veritas Volume Replication
VxVM – Veritas Volume Manager
W
WAN – Wide Area Network
WDM – Wavelength Division Multiplexing
WECA – Wireless Ethernet Compatibility Alliance
WEP – Wired Equivalent Privacy
WLAN – Wireless Local Area Network
WPA – WiFi Protected Access
WSF – Workstation Function
WTR – Wait-to-Restore
Certification and Warranty
FCC Class A Compliance
This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15
of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when
the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio
frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful
interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful
interference in which case the user will be required to correct the interference at his own expense.
Limited Warranty
Product warranty is determined by your service agreement. Refer to the ADC Warranty/Software Handbook for
additional information, or contact your sales representative or Customer Service for details.
Modifications
The FCC requires the user to be notified that any changes or modifications made to this device that are not
expressly approved by ADC voids the user’s warranty.
All wiring external to the products should follow the provisions of the current edition of the National Electrical Code.
Safety Standards Compliance
This equipment has been tested and verified to comply with the applicable sections of the following safety stan-
dards:
• GR 63-CORE - Network Equipment-Building System (NEBS) Requirements
• GR 1089-CORE - Electromagnetic Compatibility and Electrical Safety
• Binational Standard, UL-60950 3rd Edition/CSA1459 C22.2 No. 60950-00: Safety of Information Technology
Equipment
For technical assistance, refer to “Appendix A: Product Support” on page A-1.
World Headquarters
ADC Telecommunications, Inc.
PO Box 1101
Minneapolis, MN 55440-1101 USA
For Technical Assistance
Tel: 800.366.3891
LoopStar® 800 Series

TL1 Commands
Product Catalog: LPS-FRM8xx-Lx

Document Number: LPS800-UM-COMM-01
´-@L¶2s¨
1332442

LPS800 Um Comm 02

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

LPS800 Um Comm 02

Uploaded by

Copyright:

Available Formats

LoopStar® 800 Series

Product Catalog: LPS-FRM8xx-Lx

Revision Release Date Revisions Made

Table 3-25.SN values ......................................................................................................... 3-36

LoopStar® 800 Series WebLCT Introduces configuration and maintenance operations of

Reader Alert Meaning

Reader Alert Meaning

INSPECTING YOUR SHIPMENT

The semi-colon character (;) terminates a TL1 input message.

Staging Parameter Blocks

The format of an acknowledgment is as follows:

In Progress (IP) and Printout Follows (PF)

All Right (OK)

Repeat Later (RL)

OUTPUT RESPONSE MESSAGES

<HEADER><RESPONSE IDENTIFICATION>[<TEXT BLOCK>]<TERMINATOR>

COMPLD Represents total successful execution of the input command.

((<cr><lf>^^^<UNQUOTED LINE>)|(<cr><lf>^^^”<QUOTED LINE>”)| (<cr><lf>^^^/*<COMMENT>*

• Reporting of alarmed and/or non-alarmed trouble events

<HEADER><AUTO ID>[<TEXT BLOCK>]<TERMINATOR>

Identification of Output (AUTO ID)

1. Alarm code (ALMCDE)

((<cr><lf>^^^<UNQUOTED LINE>)|(<cr><lf>^^^<QUOTED LINE>)| (<cr><lf>^^^<COMMENT>))+

Table 1-1. TL1 Message Summary

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

Commands/Messages Description LoopStar Version(s) Page No.

TL1 MESSAGES BY CATEGORY

Category Commands or Autonomous Messages

Category Commands or Autonomous Messages

Category Commands or Autonomous Messages

Category Commands or Autonomous Messages

Category Commands or Autonomous Messages

Category Commands or Autonomous Messages

TL1 MESSAGES BY UNITS

Unit Commands or Autonomous Messages

Unit Commands or Autonomous Messages

TL1 MESSAGES BY CATEGORY AND UNITS

Commands or Autonomous Messages Category Units

Commands or Autonomous Messages Category Units

Commands or Autonomous Messages Category Units

Commands or Autonomous Messages Category Units

Commands or Autonomous Messages Category Units

Commands or Autonomous Messages Category Units

TL1 COMMANDS BY ALPHABETIZATION

LoopStar 800 2004-01-01 14:24:04

Example Input ACT-USER::SONET:C::SONET;

Output normal <cr><lf><lf>

Output Parameter Parameter Description

Output normal <cr><lf><lf>

Related Messages INH-MSG-DBCHG

Output normal <cr><lf><lf>

LoopStar 800 2004-11-26 15:19:57

Output normal <cr><lf><lf>

Example Input ALW-PMREPT-ALL:SONET-NE::C;

Example Input ALW-SWDX-EQPT::SLOT-9:C;

Output Parameter Parameter Description

((<cr><lf>^^^<UNQUOTED LINE>)|(<cr><lf>^^^”<QUOTED LINE>”)| (<cr><lf>^^^/<COMMENT>