Huawei TL1
Huawei TL1
Huawei TL1
D.2 Configuring NE
This section lists the commands used to edit and retrieve system configurations.
D.1 TL1 Overview
This chapter introduces input command messages, acknowledgments, output response
messages, and autonomous messages of the TL1 command.
General Format
The following is the general structure of TL1 input commands:
<COMMAND_CODE>:<STAGING_PARAMETER_BLOCKS>:<MESSAGE_PAYLOAD_BLOCK(S)>;
<COMMAND_CODE>
Determines the action (that is, pragmatics) to be taken at the NE as a result of
receiving the input message.
<STAGING_PARAMETER_BLOCKS>
Determines the target NE and the identifier of the object to be acted upon by the
input message.
<MESSAGE_PAYLOAD_BLOCK(S)>
The subject matter relating to the action to be performed by the input message.
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>]]
<VERB>
The semantics of the verb are to identify the action to be taken at the NE as a result
of receiving a TL1 message from an OS (for example, ENT, ED, or RTRV).
<MODIFIER>
Command code modifiers 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 may have diverse interpretations
in various operation domains.
<TID>
The target identifier (TID) is a unique name given to each system when it is
installed. The name identifies the particular NE. 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 this parameter can be entered with
nothing. In this case, the parameter is represented by two consecutive colons (::).
This parameter can be entered with nothing when the operating system directly
communicates with the target NE. The recommended value for the TID, when it is
used, is the common language equipment identification (CLEI) code of the target
NE.
<AID(s)>
The access identifier (AID) is an access code used to identify and address specific
objects within the system. Typical examples of objects addressed in the AID
parameter value are: individual pieces of equipment, transport spans, and access
tributaries
<CTAG>
The correlation tag (CTAG) is a unique identifier given to each input command by
the operator. When the system responds to a specific command, it includes the
command's CTAG in the reply. The CTAG is included in the system's reply to a
specific command.
[GB]
The general block (GB) includes support parameters whose values affect the way in
which the input command is to be executed in the system. The presence of the GB in
all input commands is a requirement, but this parameter can be entered with nothing.
In this case, the parameter is represented by two consecutive colons (::).
The general block may be in a format like <parameter=value>. The value may take
value1/value2/value3. This means that value can be value1, value2 or value3.
Message Payload
The remaining part of a TL1 input command is the payload or subject matter of the message.
This section of the message may consist of zero or several 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 with the operation to be performed as a result of the input message.
D.1.2 Acknowledgments
An acknowledgment is a brief output message generated in response to an input command
message.
An acknowledgment is usually followed by an output response message to the command.
However, in some circumstances, an acknowledgment is the only output message triggered
by a command.
Acknowledgments follow the 2-second rule (that is, an acknowledgement is displayed if an
output response message cannot be transmitted within 2 seconds of its receipt).
The following is the format of an acknowledgment:
<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.
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, 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 (an attempt to restore an in-service unit for example). Repeat Later (RL) is displayed in
scenarios with inadequate system resources.
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.
General Format
The general structure of a TL1 output response message is as follows:
<HEADER><RESPONSE IDENTIFICATION>[<TEXT BLOCK>]<TERMINATOR>
<HEADER>
It represents information common to all output response messages; that is, it is
independent of the type of output response.
<RESPONSE IDENTIFICATION>
It identifies the type of output response message. Five types of output response
messages are defined in this document.
<TEXT BLOCK>
It represents information specific to the particular output response message. This
component is optional.
<TERMINATOR>
It indicates the termination or continuation of the output response message.
Header
The form of the header is as follows:
<cr><lf><lf>^^^<SID>^<YEAR>-<MONTH>-<DAY>^<HOUR>:<MINUTE>:<SECOND>
<SID>
The source identifier (SID) is restricted to 20 characters maximum and identifies the
NE 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).
<YEAR>-<MONTH>-<DAY>
The <YEAR>-<MONTH>-<DAY> construct generally represents the day on which
the command is executed.
<HOUR>:<MINUTE>:<SECOND>
The <HOUR>:<MINUTE>:<SECOND> construct generally represents the time
when the command is executed.
Response Identification
The form of the response identification is as follows:
<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 will 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> will be displayed as COMPLD, DENY, PRTL, DELAY, or
RTRV. The semantics of the completion codes are listed in the following table.
PRTL Represents partial successful execution of the input command. This response
code will be returned when input commands specifying multiple AIDs 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 will 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.
RTRVa Represents output response of an input retrieve command (that is, with
command verb RTRV) that retrieves extensive amounts 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. 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.
Notes:
Completion code Description
When the CTAG of an input command cannot be identified (for example, during dial-up
asynchronous connections with noise and errors prevalent), there are two possible results:
The 2-letter acknowledgment NA is returned.
A DENY response and error message with CTAG set to the single character zero (0)
is returned.
Text Block
The form of the text block is:
((<cr><lf>^^^<UNQUOTED LINE>)|(<cr><lf>^^^"<QUOTED LINE>")|
(<cr><lf>^^^/*<COMMENT>*/))*
<UNQUOTED LINE>
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.
<QUOTED LINE>
The <QUOTED LINE> consists of parsable text and is preceded and followed by
quotation marks (''). The syntax of the parsable text is equivalent to that of an input
command message.
<COMMENT>
The <COMMENT> component is used to allow free format text (that is, human
readable, not machine parsable). The free form text is preceded and followed by a
forward slash and asterisk (/*).
Terminitor
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.
Output messages cannot exceed 4096 bytes.
D.1.4 Autonomous Messages
An autonomous message is a message that is sent from the NE to the appropriate OS without
any explicit input message associated with it (such as the normal Input Command/Output
Response message pair).
The following are the typical scenarios where autonomous messages are used:
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 following is the general structure of a TL1 autonomous message:
<HEADER><AUTO ID>[<TEXT BLOCK>]<TERMINATOR>
<HEADER>
The <HEADER> represents information common to all output response and
autonomous messages.
<AUTO ID>
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 details.
<TEXT BLOCK>
The <TEXT BLOCK> represents information specific to the particular autonomous
message. This entry is optional and will be discussed in further details.
<TERMINATOR>
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 D.1.3 Output Response
Messages. It contains system identifier SID, 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.
*C Critical alarm
** Major alarm
Alarm code Description
*^ Minor alarm
A^ Non-alarm message
Critical, major, and minor correspond to the reporting of alarmed events. The non-
alarm message designation is used when the NE is reporting non-alarmed events,
periodic measurements, or results of previously scheduled diagnostics or audits.
The value of the most severe alarm will be reported in scenarios with multiple
alarms.
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.)
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>))+
Terminator
The form of the <TERMINATOR> block is as follows:
<cr><lf>(;|>)
It is required as the termination block for all TL1 message types. The semicolon (;) is used to
indicate the termination of the output response message. The greater than sign (>) is used to
indicate that more output associated with this response will follow under another header.
D.2 Configuring NE
This section lists the commands used to edit and retrieve system configurations.
D.2.1 ED-DAT
Sets the time and date.
Function
This command sets the time and date of an NE.
Usage Note
The <TMZONE> setting will not take effect if the time zone parameter is disabled.
Category
System
Security
Super
Command Syntax
ED-DAT:[<TID>]::<CTAG>::[<DATE>],[<TIME>],[<TMZONE>],[<DSTIME>];
Command Parameters
Parameter Description Default Value
<TMZONE> Indicates the time zone. The valid values are Eastern, Central, NA
Mountain, Pacific, Alaska, Hawaii, Samoa and UTC (also
including general time zones GMT-n and GMT+n).
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
ED-DAT:::100::2002-08-26,13-23-45,Eastern,N;
Response Message
NE 2004-04-09 17:31:00
M 100 COMPLD
;
Related Commands
D.2.2 RTRV-DAT
D.2.2 RTRV-DAT
Retrieves the time and date.
Function
This command retrieves the time and date parameters of an NE.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-DAT:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<DATE>,<TIME>,<TMZONE>,<DSTIME>"<cr><lf>
;
Response Parameters
Parameter Description
<DATE> Indicates the current date in a format of YYYY-MM-DD; where, YYYY is 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> Indicates 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> Indicates the time zone. The valid values are Eastern, Central, Mountain,
Pacific, Alaska, Hawaii, Samoa, and UTC (also including general time zones
GMT-n and GMT+n).
NOTE:
When <TIMEZONE> is set to UTC, the value of this parameter is displayed as
NON_TZ instead of UTC in the response message.
<DSTIME> Indicates whether DST is enabled. The valid values are Y and N.
Example
Command
RTRV-DAT:::100;
Response Message
NE 2004-04-09 17:31:04
M 100 COMPLD
"2004-04-09,17-31-04,PACIFIC,N"
;
Related Commands
D.2.1 ED-DAT
D.2.3 ED-DST
Sets DST.
Function
This command instructs an NE to set DST.
Usage Note
None
Category
MON
Security
Super
Command Syntax
ED-DST:
[<TID>]::<CTAG>::<FLAG>,<ADJMODE>,<ADJWAY>,<ADJMINUTE>,<STARTMONT
H>,<STARTDAY>,<STARTWEEKDAY>,<STARTHOUR>,<STARTMINUTE>,<ENDMON
TH>,<ENDDAY>,<ENDWEEKDAY>,<ENDHOUR>,<ENDMINUTE>;
Command Parameters
Parameter Description Default Value
abbreviation (jan, feb, mar, apr, may, jun, jul, aug, sep,
oct, nov or dec).
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-DST:::1::enable,BYWEEK,FORWARD, 60, apr, 1, tue, 13, 0, oct, 3, tue, 14,
0;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.2.4 RTRV-DST
D.2.4 RTRV-DST
Retrieves the DST settings on an NE.
Function
This command retrieves the DST setting on the NE.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-DST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"FLAG=<FLAG>,ADJMODE=<ADJMODE>,ADJWAY=<ADJWAY>,ADJ_MINUTE=<ADJMINUTE>,ST
ART_MONTH=<STARTMONTH>,START_DAY=<STARTDAY>,START_WEEKDAY=<STARTWEEKDAY>,ST
ART_HOUR=<STARTHOUR>,START_MINUTE=<STARTMINUTE>,END_MONTH=<ENDMONTH>,END_DA
Y=<ENDDAY>,END_WEEKDAY=<ENDWEEKDAY>,END_HOUR=<ENDHOUR>,<END_MINUTE>=<ENDMIN
UTE>,DST_STATUS=<DSTSTATUS>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DST:::100;
Response Message
NE 2006-05-19 12:12:52
M 100 COMPLD
"FLAG=ENABLE,ADJMODE=BYWEEK,ADJWAY=FORWARD,ADJ_MINUTE=60,START_MONTH=APR,ST
ART_DAY=1,START_WEEKDAY=TUE,START_HOUR=13,START_MINUTE=0,END_MONTH=OCT,END_
DAY=3,END_WEEKDAY=TUE,END_HOUR=14,END_MINUTE=0,DST_STATUS=TRUE"
;
Related Commands
D.2.3 ED-DST
D.2.5 ED-SYS
Edits the attributes of the system.
Function
This command edits the attributes of the system.
Usage Note
None
Category
System
Security
Super
Command Syntax
ED-SYS:[<TID>]::<CTAG>:::[CC=<CC>,][NSC=<NSC>,][OPERSPEC=<OPERSPEC>,]
[BUZZER=<BUZZER>,][AUTOP=<AUTOP>,][PWRMODE=<PWRMODE>,]
[NELOCATION=<NELOCATION>,][NEMEMO=<NEMEMO>,]
[STATELEVEL=<STATELEVEL>,][LPBKAUTORLS=<LPBKAUTORLS>,]
[LPBKTIME=<LPBKTIME>,][IPAAUTOENTIME=<IPAAUTOENTIME>,]
[NODEID=<NODEID>,][IPAAUTOSHUT=<IPAAUTOSHUT>,]
[IPAALMDLY=<IPAALMDLY>,][OLSEN=<OLSEN>];
Command Parameters
Default
Parameter Description Value
<CC> Indicates the country code. The valid value is a three-character USA
ISO 3166 Geographic/Political Country Code (G/PCC). The
code for the United States is "USA" in uppercase.
The field is used for fault type and fault location (FTFL).
<NSC> Indicates an ITU carrier code (ICC). This code consists of one NA
to six left-justified characters, alphabetic, or leading alphabetic
with trailing numeric.
The field is used for FTFL.
<OPERSPEC> Indicates the operator specific. The valid value is a string with NA
118 bytes.
The field is used for FTFL.
<BUZZER> Indicates whether the buzzer of the NE is turned on. The valid OFF
values are ON and OFF.
<PWRMODE> Indicates the power consumption mode. The valid values are NORMAL
as follows:
NORMAL: indicates that the NE is in normal running
mode.
SAVING: indicates that the NE is in energy
conservation mode.
ENHSAV: indicates that the NE is in enhanced energy
conservation mode.
NOTE:
Certain hardware units on the standby cross-connect cards are shut
down in ENHSAV mode. Hence, the faults on the hardware units
cannot be detected.
<STATELEVEL> Indicates the state level. The valid values are FULL (full state FULL
model) and COMPLEX (complex state model). For details,
see STATELEVEL.
<LPBKTIME> Indicates the time taken for the loopback to be released 00-05
automatically. It is valid only when the auto-release loopback
function (<LPBKAUTORLS>) is enabled.
The valid format is HH-MM; where: HH ranges from 00 to 48
and MM ranges from 00 to 59. That is, LPBKTIME ranges
from 00-01 to 48-00.
<IPAAUTOENTIME> Indicates the interval for automatically enabling the IPA 01-00
function. The IPA function is used to control lasers. To avoid
personal injuries caused by lasers, the NE automatically
enables the IPA function after the IPA function is disabled for
a maximum of one hour (01-00).
The valid format is HH-MM; where: HH ranges from 00 to 01
and MM ranges from 00 to 59.
<NODEID> Indicates the node ID of the node, for example, 1.1.1.1. If this NA
parameter is set after the ASON feature is enabled, the NE is
automatically reset.
<IPAAUTOSHUT> Indicates the switch for automatically disabling the laser after NA
the IPA detection board fails. The valid value is Y|N.
<IPAALMDLY> Indicates the delay time after the IPA detection alarms. 10(ms)
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-SYS:::C:::AUTOP=Y, NELOCATION="NEW YORK",NEMEMO="North-east 4BLSR
ring",STATELEVEL=COMPLEX,LPBKAUTORLS=ENABLE,LPBKTIME=00-
06,NODEID=1.1.1.2,IPAAUTOSHUT=N;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.2.6 RTRV-SYS
D.2.6 RTRV-SYS
Retrieves the attributes of the system.
Function
This command retrieves the attributes of the system.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-SYS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"DEVICETYPE=<DEVICETYPE>,SHELFTYPE=<SHELFTYPE>,NEVERSION=<NEVERSION>,CC=
<CC>,NSC=<NSC>,OPERSPEC=<OPERSPEC>,BUZZER=<BUZZER>,AUTOP=<AUTOP>,NELOCATION
=<NELOCATION>,NEMEMO=<NEMEMO>,STATELEVEL=<STATELEVEL>,LPBKAUTORLS=<LPBKAUTO
RLS>,
[LPBKTIME=<LPBKTIME>],IPAAUTOENTIME=<IPAAUTOENTIME>,PWRMODE=<PWRMODE>,RATED
PWR=<RATEDPWR>,ACTPWR=<ACTPWR>,SAVEDPWR=<SAVEDPWR>,[NODEID=<NODEID>],
[IPAAUTOSHUT=<IPAAUTOSHUT>],[IPAALMDLY=<IPAALMDLY>],OLSEN=<OLSEN>"<cr><lf>
;
Response Parameters
Parameter Description
<DEVICETYPE> Indicates the device type. The valid values are OSN3800A, OSN6800A,
OSN8800T16, OSN8800T32, and OSN8800T64.
<SHELFTYPE> Indicates the shelf type. The valid values are SHELF8800T32E,
SHELF8800T64E, STDSHELF and NASHELF.
<NEVERSION> Indicates the NE software and patch package version. The valid value is a
40-byte string, for example, V100R006C00.
<CC> Indicates the country code. The valid value is a three-character ISO 3166
Geographic/Political Country Code (G/PCC). The code for the United
States is "USA" in uppercase.
The field is used for FTFL.
<NSC> Indicates an ITU carrier code (ICC). This code consists of one to six left-
justified characters, alphabetic, or leading alphabetic with trailing
numeric.
The field is used for FTFL.
<OPERSPEC> Indicates the operator specific. The field is used for FTFL
<BUZZER> Indicates whether the buzzer of the NE is turned on. The valid values are
ON and OFF.
<PWRMODE> Indicates the power consumption mode. The valid values are as follows:
NORMAL: indicates that the NE is in the normal running mode.
SAVING: indicates that the NE is in the energy conservation
mode.
ENHSAV: indicates that the NE is in enhanced energy
conservation mode.
<SAVEDPWR> Indicates the reduced power consumption after the energy conservation
function is enabled.
<STATELEVEL> Indicates the state level. The valid values are FULL (full state model) and
COMPLEX (complex state model). For details, see STATELEVEL.
<LPBKTIME> Indicates the time taken for the loopback to be released automatically. It is
valid only when the auto-release loopback function is enabled.
The valid format is HH-MM; where: HH ranges from 00 to 48 and MM
ranges from 00 to 59.
<IPAAUTOENTIME> Indicates the interval for automatically enabling the IPA function. The
IPA function is used to control lasers. To avoid personal injuries caused
by lasers, the NE automatically enables the IPA function after the IPA
function is disabled for a maximum of one hour (01-00).
The valid format is HH-MM; where: HH ranges from 00 to 01 and MM
ranges from 00 to 59.
<NODEID> Indicates the node ID of the node, for example, 1.1.1.1. If this parameter
is set after the ASON feature is enabled, the NE is automatically reset.
<IPAAUTOSHUT> Indicates the switch for automatically disabling the laser after the IPA
detection board fails. The valid value is Y|N.
<IPAALMDLY> Indicates the delay time after the IPA detection alarms.
Example
Command
RTRV-SYS:::C;
Response Message
NE 2008-11-11 20:37:10
M C COMPLD
"DEVICETYPE=OSN6800A,SHELFTYPE=NASHELF,NEVERSION=V100R010C00SPC100,CC=,NSC=
\"\",OPERSPEC=\"\",BUZZER=OFF,AUTOP=Y,NELOCATION=\"\",NEMEMO=\"\",STATELEVE
L=FULL,LPBKAUTORLS=DISABLE,LPBKTIME=00-00,IPAAUTOENTIME=01-
00,PWRMODE=NORMAL,RATEDPWR=706,ACTPWR=499,SAVEDPWR=195,NODEID=172.0.0.199,I
PAAUTOSHUT=N,IPAALMDLY=10,OLSEN=N"
;
;
Related Commands
D.2.5 ED-SYS
D.2.7 RTRV-HDR
Retrieves the header information.
Function
This command requests an NE to reply with a normal response indicating COMPLD and
header information, that is, the source identifier, the date, and the time.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-HDR:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
RTRV-HDR:::100;
Response Message
NE 2004-07-08 16:01:36
M 100 COMPLD
;
Related Commands
None
D.2.8 SET-TIP-MOD
Set mode of the TL1 tips.
Function
This command is issued to set mode of the TL1 tips.
Usage Note
None
Category
TL1
Security
Debug
Command Syntax
SET-TIP_MOD:[<TID>]:<TIP_TYPE>:<CTAG>::<TIP_VALUE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
SET-TIP-MOD::HELP:100::ENABLE;
Response Message
NE 2012-04-26 17:41:17
M 100 COMPLD
;
D.2.9 RTRV-HEALTH-STATE
Retrieves the status of an NE for software loading.
Function
This command is issued upon the user's request. MON sends a health check request to all the
registered modules (with MON health check framework), then collects the responses from
those modules and displays the information to the user.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-HEALTH-STATE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"CONTENT=GCP Contrl Plane State,HEALTH_STATUS=POK,RESULT=ION is stopped
or initializing now!,ADVICE=Please wait and then try again!"<cr><lf>
;
Response Parameters
Parameter Description
<HEALTH_STATUS> Indicates the status of the NE. The valid values are as follows:
OK: indicates the normal state of the specific function.
POK: indicates the state that may affect software loading.
NG: indicates the abnormal state of the specific function.
<ADVICE> Indicates an advisement that can be applied to clear the fault in situations of
the abnormal status of a specific function.
Example
Command
RTRV-HEALTH-STATE:::100;
Response Message
NE 2008-07-19 15:59:52
M 100 COMPLD
"CONTENT=Channel State,HEALTH_STATUS=OK,RESULT=The Channel state is
OK!,ADVICE="
"CONTENT=Master And Slave
State,HEALTH_STATUS=POK,RESULT=Unknown,ADVICE=Unknown"
;
Related Commands
None
D.2.10 RTRV-LOCALIZATION
Retrieves the status of time localization.
Function
This command retrieves the status of time localization.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-LOCALIZATION:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<LOCALIZATION_STATUS> "<cr><lf>
;
Response Parameters
Parameter Description
LOCALIZATION_STATUS Indicates the status of time localization. The valid values are as
follows:
0: indicates that time localization is disabled.
1: indicates that time radicalization is enabled (starting year:
1990).
2: indicates that time radicalization is enabled (starting year:
1970).
Example
Command
RTRV-LOCALIZATION:::1;
Response Message
NE 2007-09-19 11:17:54
M 1 COMPLD
"1"
;
Related Commands
None
D.2.11 RTRV-NETYPE
Retrieves the NE type.
Function
This command retrieves the type of an NE.
Usage Note
None
Category
Equipment
Security
Retrieve
Command Syntax
RTRV-NETYPE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<VENDID>,<DEVICETYPE>,<EQUIPTYPE>,<NEVERSION>"
;
Response Parameters
Parameter Description
<VENDID> Indicates the vendor identifier of the equipment. The valid value is a
string.
<DEVICETYPE> Indicates the device type. The valid values are OSN6800A, OSN3800A,
OSN8800T16, OSN8800T32, and OSN8800T64.
<EQUIPTYPE> Indicates the equipment type. It is a 40-byte string. The valid values are as
follows:
ADM: indicates an add/drop multiplexer.
MSPP: indicates a multi-service provisioning platform.
<NEVERSION> Indicates the software release version of the NE. It is a 40-byte string.
Example
Command
RTRV-NETYPE:::C;
Response Message
NE 2008-07-10 16:13:16
M C COMPLD
"HUAWEI,OSN8800T32,ADM&MSPP,8800V100R002C00"
;
Related Commands
None
D.2.12 RTRV-TOD
Retrieves the time of day.
Function
This command retrieves the system date and time at the instant when the command was
executed. The time is returned in coordinated universal time (UTC).
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-TOD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,<TMTYPE>"<cr><lf>
;
Response Parameters
Parameter Description
<YEAR> Indicates the current calendar year that ranges from 1990 to 2087.
<MONTH> Indicates the month of the year. The valid values are 01, 02, 03, 04, 05, 06, 07, 08,
09, 10, 11, and 12.
<DAY> Indicates the day of the month, which ranges from 01 to 31.
<HOUR> Indicates the hour of the day, which ranges from 00 to 23.
<MINUTE> Indicates the minute of the hour, which ranges from 00 to 59.
<SECOND> Indicates the second of the minute, which ranges from 00 to 59.
<TMTYPE> Indicates the type of the time value returned. The value of this parameter is always
in UTC.
Example
Command
RTRV-TOD:::100;
Response Message
NE 2003-02-28 12:23:20
M 1000 COMPLD
"2003,02,23,12,23,20,UTC"
;
Related Commands
D.2.1 ED-DAT
D.2.2 RTRV-DAT
D.2.13 SET-SID
Sets the system identification.
Function
This command changes the system identification (SID) code to a specified value. Where
appropriate, the value of this SID code is used as the target identifier in an input command
and the source identifier in an output or autonomous message.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
SET-SID:[<TID>]::<CTAG>::<SID>;
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-SID:::100::NE;
Response Message
NE 2004-07-08 16:02:46
M 100 COMPLD
;
Related Commands
None
D.2.14 ED-WEAKALMSTATE
Configures the weak mapping alarm status of a board to open or close
Function
This command configures the weak mapping alarm status of a board to open or close
Usage Note
None.
Category
Facility
Security
Provisioning
Command Syntax
ED-WEAKALMSTATE:[<TID>]::<CTAG>:::
[WEAKALMSTATE=<WEAKALMSTATE>]
Command Parameters
Parameters Description Default Value
OPEN.
CLOSE
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-WEAKALMSTATE:::C:::WEAKALMSTATE=OPEN
Response Message
NEW-NE 2016-01-26 20:05:23
M C COMPLD;
Related Commands
D.6.11 RTRV-LEDSTATE
D.2.15 RTRV-WEAKALMSTATE
Queries the weak mapping alarm status of a board to open or close
Function
This command queries the weak mapping alarm status of a board to open or close
Usage Note
None.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-WEAKALMSTATE:[<TID>]::<CTAG>
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"[<AID>]::[WEAKALMSTATE=<WEAKALMSTATE>]"<cr><lf> ;
Response Parameters
Parameter Description
Example
Command
RTRV-WEAKALMSTATE:::C ;
Response Message
NEW-NE 2016-01-26 20:05:27
M C COMPLD
"WEAKALMSTATE=OPEN"
Related Commands
D.6.10 ED-LEDSTATE
D.3 Configuring DCC
This section lists commands used to configure a DCC channel to communicate with a
maintenance computer.
D.3.1 ED-<GCC/DCC>
Edits GCC/DCC parameters
Function
This command edits the attributes, state, and link protocol types of a GCC/DCC channel.
Usage Note
None
Category
Communication
Security
Provisioning
Command Syntax
ED-<GCC/DCC>:[<TID>]:[<AID>]:<CTAG>:::[NEGO=<NEGO>],[TYPE=<TYPE>],
[RATEMODE=<RATEMODE>],[BIND=<BIND>],[PROTOCOL=<PROTYPE>];
Command Parameters
<RATEMODE> Indicates the rate mode. This parameter is only valid for NA
GCC channel 3 of certain ports with a rate of ODU2 or
higher. The channel mainly supports ASON services.
The valid values are as follows:
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-GCC::FAC-1-2-1-1:C:::PROTOCOL=TRANSPARENT;
Response Message
NE 2004-07-08 17:18:06
M C COMPLD
;
Related Commands
D.3.2 RTRV-<GCC/DCC>
D.3.2 RTRV-<GCC/DCC>
Retrieves the GCC/DCC channel parameters.
Function
This command retrieves the GCC/DCC attributes and its protocol type.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-<GCC/DCC>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<AID>:[NEGO=<NEGO>],TYPE=<TYPE>,
[RATEMODE=<RATEMODE>],BIND=<BIND>,PROTOCOL=<PROTYPE>,BANDWIDTH=<BANDWIDTH>,
CHANSTATE=<CHANSTATE>", "<cr><lf>
Response Parameters
Parameter Description
<AID> The access identifier which indicates the GCC/DCC channel. The valid
formats are as follows:
For DCC: DCC-<SHELF ID>-<SLOT ID>-<PORT ID>-
<CHANNEL ID>
For GCC: FAC/CLNT/SRVN-<SHELF ID>-<SLOT ID>-<PORT
ID>-<CHANNEL ID>
DCC is valid for SONET/OSC. The valid values of <CHANNEL ID> are:
1: (SDCC, DCC1-DCC3)
2: (LDCC, DCC4-DCC12)
3: (ETHA, Ethernet channel A)
4: (ETHB, Ethernet channel B)
GCC is valid for OTN. The valid values of <CHANNEL ID> are:
1: (GCC0)
2: (GCC1-GCC2)
3: (RESA)
<TYPE> Indicates the communication type that the channel supports. The valid
values are as follows:
MANAGE: indicates the management channel, which is used for
the communication of management.
ASON: indicates the ASON channel, which is used for the
communication of ASON services.
<RATEMODE> Indicates the rate mode. This parameter is only valid for GCC channel 3 of
certain ports with a rate of ODU2 or higher. The channel mainly supports
ASON services. The valid values are as follows:
9: 9-byte mode with an actual rate of 9 x 64 kbit/s.
24: 24-byte mode with an actual rate of 24 x 64 kbit/s.
<BIND> Indicates whether the channel supports the function of binding multiple
fibers. The NE binds all channels (that can be bound together) into a
communication channel, thus increasing the communication rate between
NEs.
Y: The channel can be bound with other channels.
N: The channel cannot be bound with other channels.
Parameter Description
<PROTOCOL> Indicates the protocol of the DCC/GCC link layer. The valid values are as
follows:
TRANSPARENT : There are not any link protocols, and the
channel is free in CRS.
PPP: IP stack is set in this channel.
<CHANSTATE> Indicates the data sending and receiving state of the CPU channel which is
assigned to the optical interface. The valid values are as follows:
OK: The sending and receiving states are okay.
RX_F: The sending state is okay, but the receiving fails.
TX_F: The receiving state is okay, but the sending fails.
RX_F&TX_F: All fail.
Example
Command
RTRV-DCC::DCC-1-6-2-1:C;
Response Message
NE 2005-08-10 16:12:51
M C COMPLD
"DCC-1-6-2-
1:TYPE=MANAGE,BIND=Y,PROTOCOL=PPP,BANDWIDTH=3*64K,CHANSTATE=OK"
;
Related Commands
D.3.1 ED-<GCC/DCC>
D.3.3 RTRV-DETAIL-<GCC/DCC>
Retrieves the GCC/DCC channel parameters.
Function
This command retrieves the GCC/DCC attributes and its protocol type.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-DETAIL-<GCC/DCC>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<AID>:[NEGO=<NEGO>],TYPE=<TYPE>,
[RATEMODE=<RATEMODE>],BIND=<BIND>,PROTOCOL=<PROTYPE>,BANDWIDTH=<BANDWIDTH>,
CHANSTATE=<CHANSTATE>,CHANID=<CHANID>", "<cr><lf>
Response Parameters
Parameter Description
<AID> The access identifier which indicates the GCC/DCC channel. The valid
formats are as follows:
For DCC: DCC-<SHELF ID>-<SLOT ID>-<PORT ID>-
<CHANNEL ID>
For GCC: FAC/CLNT/SRVN-<SHELF ID>-<SLOT ID>-<PORT
Parameter Description
ID>-<CHANNEL ID>
DCC is valid for SONET/OSC. The valid values of <CHANNEL ID> are:
1: (SDCC, DCC1-DCC3)
2: (LDCC, DCC4-DCC12)
3: (ETHA, Ethernet channel A)
4: (ETHB, Ethernet channel B)
GCC is valid for OTN. The valid values of <CHANNEL ID> are:
1: (GCC0)
2: (GCC1-GCC2)
3: (RESA)
<TYPE> Indicates the communication type that the channel supports. The valid
values are as follows:
MANAGE: indicates the management channel, which is used for
the communication of management.
ASON: indicates the ASON channel, which is used for the
communication of ASON services.
<RATEMODE> Indicates the rate mode. This parameter is only valid for GCC channel 3 of
certain ports with a rate of ODU2 or higher. The channel mainly supports
ASON services. The valid values are as follows:
9: 9-byte mode with an actual rate of 9 x 64 kbit/s.
24: 24-byte mode with an actual rate of 24 x 64 kbit/s.
<BIND> Indicates whether the channel supports the function of binding multiple
fibers. The NE binds all channels (that can be bound together) into a
communication channel, thus increasing the communication rate between
NEs.
Y: The channel can be bound with other channels.
N: The channel cannot be bound with other channels.
<PROTOCOL> Indicates the protocol of the DCC/GCC link layer. The valid values are as
follows:
TRANSPARENT : There are not any link protocols, and the
channel is free in CRS.
PPP: IP stack is set in this channel.
<CHANSTATE> Indicates the data sending and receiving state of the CPU channel which is
assigned to the optical interface. The valid values are as follows:
OK: The sending and receiving states are okay.
Parameter Description
Example
Command
RTRV-DETAIL-GCC::SRV3-1-13-2-3:A;
Response Message
NE-91-5 2012-04-15 00:49:27
M A COMPLD
"SRV3-1-13-2-
3:NEGO=N,TYPE=ASON,RATEMODE=9,BIND=Y,PROTOCOL=PPP,BANDWIDTH=9*64K,CHANSTATE
=RX_F,CHANID=27"
;
Related Commands
D.3.2 RTRV-<GCC/DCC>
D.3.4 RTRV-DCC-CHANERR
Retrieves the channel error info of the GCC/DCC channel.
Function
This command instructs an NE to retrieve the channel error info of the GCC/DCC channel.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-DCC-CHANERR:[<TID>]::<CTAG>:::CHANID=<CHANID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"QFULL=<QFULL>,LG=<LG>,NO=<NO>,CR=<CR>,AB=<AB>,UN=<UN>,MRF=<MRF>,RXF=<RX
F>,TXB=<TXB>,RXERR=<RXERR>,TXERR=<TXERR>", "<cr><lf>
;
Response Parameters
Parameter Description
<QFULL> Indicates the number of times when the GCC/DCC channel's packet
sending queue is full.
<LG> Indicates the number of packets whose length exceed the maximum packet
length the NE can process.
<NO> Indicates the number of packets whose bits length is not multiple of 8.
<UN> Indicates the number of packets which have receive Overrun errors.
<MRF> Indicates the number of packets which have Maximum receive frame
length violation errors.
<RXERR> Indicates the number of packets which are received with errors.
<TXERR> Indicates the number of packets which are sended with errors.
Example
Command
RTRV-DCC-CHANERR:::a:::CHANID=27;
Response Message
NE-91-5 2012-04-15 03:30:24
M A COMPLD
"QFULL=0,LG=0,NO=0,CR=0,AB=0,UN=0,MRF=0,RXF=0,TXB=66,RXERR=0,TXERR=0"
;
Related Commands
D.3.3 RTRV-DETAIL-<GCC/DCC>
D.3.5 RTRV-DCC-CHANINFO
Retrieves the channel info of the GCC/DCC channel.
Function
This command instructs an NE to retrieve the channel info of the GCC/DCC channel.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-DCC-CHANINFO:[<TID>]::<CTAG>:::CHANID=<CHANID>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"CHANID=<CHANID>,STATE=<STATE>,EVENT=<EVENT>,PEER_CHANID=<PEER_CHANID>,T
RNS_NUMS=<TRNS_NUMS>,TRNS_BYTES=<TRNS_BYTES>,RECV_NUMS=<RECV_NUMS>,RECV_BYT
ES=<RECV_BYTES>,RX_SR=<RX_SR>,TX_SR=<TX_SR>,LAST_STATE=<LAST_STATE>",
"<cr><lf>
;
Response Parameters
Parameter Description
<PEER_CHANID> Indicates the NE channel ID associated with the GCC/DCC channel of the
peer NE.
<TRNS_NUMS> Indicates the number of packets sended from the GCC/DCC channel.
<TRNS_BYTES> Indicates the number of bytes sended from the GCC/DCC channel.
<RECV_NUMS> Indicates the number of packets received from the GCC/DCC channel.
<RECV_BYTES> Indicates the number of bytes received from the GCC/DCC channel.
<RX_SR> Indicates the number of packets which are received with errors.
<TX_SR> Indicates the number of packets which are sended with errors.
Example
Command
RTRV-DCC-CHANINFO:::a:::CHANID=27;
Response Message
NE-91-5 2012-04-15 04:02:04
M A COMPLD
"CHANID=27,STATE=0,EVENT=0,PEER_CHANID=0,TRNS_NUMS=222,TRNS_BYTES=3996,RECV
_NUMS=0,RECV_BYTES=0,RX_SR=0,TX_SR=0,LAST_STATE=0"
;
Related Commands
D.3.3 RTRV-DETAIL-<GCC/DCC>
D.3.6 DLT-CRS-OHBYTE
Deletes cross overhead bytes.
Function
This command deletes cross overhead bytes.
Usage Note
None
Category
Communication
Security
Provisioning
Command Syntax
DLT-CRS-OHBYTE:[<TID>]:<FROM_AID>:<CTAG>::<FROM_BYTE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-CRS-OHBYTE::FAC-1-2-1:10::E1;
Response Message
NE 2004-07-10 15:35:00
M 10 COMPLD
;
Related Commands
D.3.7 ENT-CRS-OHBYTE
D.3.8 RTRV-CRS-OHBYTE
D.3.7 ENT-CRS-OHBYTE
Creates cross overhead bytes.
Function
This command creates cross overhead bytes.
Usage Note
None
Category
Communication
Security
Provisioning
Command Syntax
ENT-CRS-OHBYTE:[<TID>]:<FROM_AID>, <TO_AID>:<CTAG>::<FROM_BYTE>,
<TO_BYTE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Example
Command
ENT-CRS-OHBYTE::FAC-1-2-1,FAC-1-6-1:10::D1,D1;
Response Message
NE 2004-07-10 15:33:17
M 10 COMPLD
;
Related Commands
D.3.8 RTRV-CRS-OHBYTE
D.3.6 DLT-CRS-OHBYTE
D.3.8 RTRV-CRS-OHBYTE
Retrieves the information about cross overhead bytes.
Function
This command retrieves the information about cross overhead bytes.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-CRS-OHBYTE:[<TID>]::<CTAG>;
Command Parameters
Parameter Description
Response Syntax
cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<FROM_AID>,<TO_AID>,<FROM_BYTE>,<TO_BYTE>"<cr><lf>
;
Response Parameters
Parameter Description
<FROM_BYTE> Indicates the source byte of the cross. Overhead bytes include D1-
D12, E1, E2 and F1.
<TO_BYTE> The destination byte of the cross. Overhead bytes include D1-D12,
E1, E2 and F1.
Example
Command
RTRV-CRS-OHBYTE:::100;
Response Message
NE 2004-07-10 15:36:49
M 100 COMPLD
"FAC-1-2-1,FAC-1-6-1,D1,D1"
;
Related Commands
D.3.7 ENT-CRS-OHBYTE
D.3.6 DLT-CRS-OHBYTE
D.3.9 ED-VACANTSLOT
Sets the DCC/GCC channel allocation trigger status for all vacant slots on the current NE to
enable or disable.
Function
This command sets the DCC/GCC channel allocation trigger status for all vacant slots on the
current NE to enable or disable.
Usage Note
None
Category
Communication
Security
Provisioning
Command Syntax
ED-VACANTSLOT:[<TID>]::<CTAG>:::[VACANTSLOT=<VACANTSLOT>];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-VACANTSLOT:::C:::VACANTSLOT=ENABLE;
Response Message
NE 2008-11-11 21:32:07 M C COMPLD ;
Related Commands
D.6.9 RTRV-CLNT
D.3.10 RTRV-VACANTSLOT
Retrieves the DCC/GCC channel allocation trigger status of NE level for all vacant slots.
Function
This command retrieves the DCC/GCC channel allocation trigger status of NE level for all
vacant slots.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-VACANTSLOT:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^VACANTSLOT=<VACANTSLOT> ;
Response Parameters
Parameters Description
<VACANTSLOT> Indicates the DCC/GCC channel allocation trigger status. Valid values are
enable and disable.
Example
Command
RTRV-VACANTSLOT:::C;
Response Message
NE 2005-08-10 16:12:51 M C COMPLD "VACANTSLOT=ENABLE" ;
Related Commands
D.6.8 ED-CLNT
D.4 Communication Management
This section lists commands which used to configure the communication path.
D.4.1 Configuring VLAN
This section lists commands which used to configure LAN to communicate with maintenance
computer.
ED-LAN
Modifies the LAN parameters.
Function
This command changes the attributes and state of a LAN facility.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
ED-LAN:[<TID>]:<LAN_AID>:<CTAG>:::[IP=<IPADDR>], [MASK=<SUBNETMASK>],
[GATEWAY=<GATEWAY>], [ENABLE=<ENABLE>],[ARPPROXY=<ARPSTATE>],
[CONMODE=<CONMODE>],[SNDIP=<SndIpAddr>],[SNDMASK=<SndSubMask>];
Command Parameters
NA
<SUBNETMASK> Indicates the subnet mask address. The value will not
be changed if nothing is entered for this parameter.
NOTE:
For configuration of the subnet mask addresses of the NEs,
it is recommended that users configure all NEs in the same
net segment with the same subnet mask.
When the IP address of an NE is changed from 129.9.xx.xx
to 192.168.xx.xx, the subnet mask is changed to
255.255.255.0 automatically. But when the IP address of
the NE is changed back to 129.9.xx.xx, the subnet mask is
not changed and is still 255.255.255.0. If there are other
NEs in the network segment 129.9.xx.xx, some NEs may
not communicate normally, so it is recommended that users
configure the subnet mask back to 255.255.0.0 manually.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-LAN::LAN-
1:100:::IP=129.9.0.1,MASK=255.255.255.0,GATEWAY=129.9.0.1,ENABLE=Y,ARPPROXY
=ENABLE,CONMODE=ALL,SNDIP=130.9.0.22,SNDMASK=255.255.255.0;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
RTRV-LAN
DLT-ACL
Delete an ACL rule.
Function
This command is issued to delete an ACL rule.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
DLT-ACL:[<TID>]::<CTAG>::RULEID=<RULEID>
Command Parameters
<RULEID> The Index of an exist ACL rule, If the ruleid is set 4294967295, that NA
means delete all ACL rules.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-ACL:::100::RULEID=10
Response Message
NEW-NE 2011-05-25 20:23:32
M 100 COMPLD
;
ED-ACL
Modify the ACL rule.
Function
This command is issued to modify an ACL rule.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ED-ACL:
[<TID>]::<CTAG>::RULEID=<RULEID>,OP=<OP>,SOURCE=<SOURCE>,WILDCAR
D=<WILDCARD>
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-ACL:::100::RULEID=10,OP=DENY,SOURCE=128.8.0.0,WILDCARD=0.0.255.255
Response Message
NEW-NE 2011-05-25 20:23:32
M 100 COMPLD
;
ENT-ACL
Add the ACL rule.
Function
This command is issued to add an ACL rule.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ENT-ACL:
[<TID>]::<CTAG>::RULEID=<RULEID>,OP=<OP>,SOURCE=<SOURCE>,WILDCAR
D=<WILDCARD>
Command Parameters
<RULEID> The Index of ACL rule, number ,can be 0-4294967295.If the ruleid NA
is set 4294967295, that means the acl will be allocated a valid index
by the system.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-ACL:::100::RULEID=10,OP=DENY,SOURCE=129.9.0.0,WILDCARD=0.0.255.255
Response Message
NEW-NE 2011-05-25 20:23:32
M 100 COMPLD
;
RTRV-ACL
Retrieves all ACL rules.
Function
This command is issued to retrieve ACL rules.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-ACL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"RULEID=<RULEID>,OP=<OP>,SOURCE=<SOURCE>,WILDCARD=<WILDCARD>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
rtrv-acl:::100;
Response Message
NEW-NE 2011-07-29 19:28:38
M 100 COMPLD
"RULEID=10,OP=PERMIT,SOURCE=129.8.0.0,WILDCARD=0.0.255.255"
RTRV-LAN
Retrieves the LAN parameters.
Function
This command retrieves the attributes and state of a LAN facility.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-LAN:[<TID>]:[<LAN_AID>]:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf>
^^^"IP=<IPADDR><cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"IP=<IPADDR>,MASK=<SUBNETMASK>,GATEWAY=<GATEWAY>,MAC=<MAC>,ENABLE=<ENABL
E>,ARPPROXY=<ARPSTATE>,CONMODE=<CONMODE>,SNDIP=<DCNIPADDR>,SNDMASK=<DCNSUBN
ETMASK>"<cr><lf>
;
Response Parameters
Parameter Description
<IPADDR> Indicates the IP address. The valid values are A, B, and C class IP
addresses.
<CONMODE> Indicates the encryption mode. The valid values NOSSL,and ALL.
<DCNIPADDR> Indicates the DCN IP address.
<DCNSUBNETMASK> Indicates the DCN subnet mask address.
Example
Command
RTRV-LAN::LAN-1:100;
Response Message
NE 2004-07-08 17:16:08
M 10 COMPLD
"IP=129.9.0.1,MASK=255.255.0.0,GATEWAY=129.9.0.1,MAC=08-00-3e-10-00-
0b,ENABLE=Y,ARPPROXY=ENABLE,CONMODE=ALL,SNDIP=0.0.0.0,SNDMASK=0.0.0.0"
;
Related Commands
ED-LAN
ED-COM-SERVICE
Edit the service status of communication.
Function
This command is issued to open or close communication service.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ED-COM-SERVICE:[<TID>]::<CTAG>::<COMSERVICE>,<COMSRVSTATE>;
Command Parameters
Parameter Description Default Value
<COMSRVSTATE> The state of service. The valid values are open and close. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-COM-SERVICE:::100::FTPCLIENT,OPEN;
Response Message
NEW-NE 2012-02-07 20:23:32
M 100 COMPLD
;
Related Commands
RTRV-COM-SERVICE
RTRV-COM-SERVICE
Retrieves the information of the communication service.
Function
This command is issued to retrieve the information of the communication service.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
RTRV-COM-SERVICE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"SERVICE=<COMSERVICE>,STATE=<COMSRVSTATE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
rtrv-com-service:::100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"SERVICE=FTPCLIENT,STATE=OPEN"
"SERVICE=SFTPCLIENT,STATE=OPEN"
"SERVICE=TELSERVER,STATE=OPEN"
"SERVICE=STELSERVER,STATE=OPEN"
"SERVICE=RAWTL1,STATE=OPEN"
"SERVICE=RAWTELSERVER,STATE=OPEN"
"SERVICE=MULTINETSEARCH,STATE=OPEN"
"SERVICE=TL1GNESERVICE,STATE=OPEN"
;
Related Commands
ED-COM-SERVICE
ACT-SSL-CAFILE
Activates the SSL certificate file.
Function
This command is issued to activates the SSL certificate file.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ACT-SSL-CAFILE:[<TID>]::<CTAG>;
Command Parameters
NONE
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ACT-SSL-CAFILE:::100
Response Message
NEW-NE 2012-02-22 20:23:32
M 100 COMPLD
;
ED-SSL
Edit the SSLVER switch of communication.
Function
This command is issued to enable or disable SSLVER.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ED-SSL:[<TID>]::<CTAG>:::SSLVER=<SSLVER>,SSLVERSWITCH=<SWITCH>;
Command Parameters
Parameter Description Default Value
<SSLVER> The type of SSL. The valid values are sslv3,tls10 and all. NA
<SWITCH> The switch of SSL. The valid values are enable and disable. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SSL:::100:::SSLVER=SSLV3, SSLVERSWITCH=ENABLE;
Response Message
NEW-NE 2012-02-07 20:23:32
M 100 COMPLD
;
Related Commands
RTRV-COM-SERVICE
RTRV-SSL
Retrieves the information of the sslver switch.
Function
This command is issued to retrieve the information of the sslver switch.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-SSL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"SSLVER=<SSLVER>,SSLVERSWITCH=<SWITCH>"<cr><lf>
;
Response Parameters
Parameter Description
<SSLVER> The type of SSL version. The valid values are sslv3,tls10 and all.
<SWITCH> The state of SSL version. The valid values are enable and disable.
Example
Command
rtrv-ssl:::100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"SSLVER=SSLV3, SSLVERSWITCH=ENABLE"
;
Related Commands
ED-COM-SERVICE
ED-SSL-MODE
Modify the SSL mode.
Function
This command is issued to modify the SSL mode.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ED-SSL-MODE:[<TID>]::<CTAG>::SSLMODE=<SSLMODE>
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-SSL-MODE:::100::SSLMODE=BOTH
Response Message
NEW-NE 2012-02-22 20:23:32
M 100 COMPLD
;
RTRV-SSL-MODE
Retrieves the SSL mode.
Function
This command is issued to retrieve the SSL mode.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-SSL-MODE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SSLMODE=<SSLMODE>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-SSL-MODE:::100;
Response Message
NEW-NE 2012-02-22 19:28:38 M 100 COMPLD
"SSLMODE=BOTH"
ED-ADVANCED-ACL
Modify the advanced ACL rule.
Function
This command is issued to modify an advanced ACL rule.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ED-ADVANCED-ACL:
[<TID>]::<CTAG>::RULEID=<RULEID>,OP=<OP>,SOURCE=<SOURCE>,SRCWILD
CARD=<SRCWILDCARD>,DESTINATION=<DESTINATION>,DSTWILDCARD=<DS
TWILDCARD>,PROTOCOL=<PROTOCOLTYPE>,[SRCPORT=<SRCPORTACL>],
[DSTPORT=<DSTPORTACL>],[ICMPTYPE=<ICMPTYPE>],
[ICMPCODE=<ICMPCODE>]
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-ADVANCED-
ACL:::100::RULEID=10,OP=DENY,SOURCE=128.9.0.0,SRCWILDCARD=0.0.255.255,DESTI
NATION=128.8.0.0,DSTWILDCARD=0.0.255.255,PROTOCOL=IP;
Response Message
NEW-NE 2012-02-22 20:23:32
M 100 COMPLD
;
ENT-ADVANCED-ACL
Add the advanced ACL rule.
Function
This command is issued to add an advanced ACL rule.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ENT-ADVANCED-ACL:
[<TID>]::<CTAG>::RULEID=<RULEID>,OP=<OP>,SOURCE=<SOURCE>,SRCWILD
CARD=<SRCWILDCARD>,DESTINATION=<DESTINATION>,DSTWILDCARD=<DS
TWILDCARD>,PROTOCOL=<PROTOCOLTYPE>,[SRCPORT=<SRCPORTACL>],
[DSTPORT=<DSTPORTACL>],[ICMPTYPE=<ICMPTYPE>],
[ICMPCODE=<ICMPCODE>]
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-ADVANCED-
ACL:::100::RULEID=10,OP=DENY,SOURCE=128.9.0.0,SRCWILDCARD=0.0.255.255,DESTI
NATION=128.8.0.0,DSTWILDCARD=0.0.255.255,PROTOCOL=IP;
Response Message
NEW-NE 2012-02-22 20:23:32
M 100 COMPLD
;
RTRV-ADVANCED-ACL
Retrieves all advanced ACL rules.
Function
This command is issued to retrieve advanced ACL rules.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-ADVANCED-ACL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"RULEID=<RULEID>,OP=<OP>,SOURCE=<SOURCE>,SRCWILDCARD=<SRCWILDCARD>,DESTI
NATION=<DESTINATION>,DSTWILDCARD=<DSTWILDCARD>,PROTOCOL=<PROTOCOLTYPE>,SRCP
ORT=<SRCPORTACL>,DSTPORT=<DSTPORTACL>,ICMPTYPE=<ICMPTYPE>,ICMPCODE=<ICMPCOD
E>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-ADVANCED-ACL:::100;
Response Message
NEW-NE 2012-02-22 19:28:38
M 100 COMPLD
"RULEID=10,OP=PERMIT,SOURCE=128.9.0.0,SRCWILDCARD=0.0.255.255,DESTINATION=1
28.8.0.0,DSTWILDCARD=0.0.255.255,PROTOCOLTYPE=ip,SRCPORT=0xffffffff,DSTPORT
=0xffffffff,ICMPTYPE=0xff,ICMPCODE=0xff"
DLT-ADVANCED-ACL
Delete an advanced ACL rule.
Function
This command is issued to delete an advanced ACL rule.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
DLT-ADVANCED-ACL:[<TID>]::<CTAG>::RULEID=<RULEID>
Command Parameters
<RULEID> The Index of an exist advanced ACL rule, If the ruleid is set NA
4294967295, that means delete all advanced ACL rules.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-ADVANCED-ACL:::100::RULEID=10;
Response Message
NEW-NE 2012-02-22 20:23:32
M 100 COMPLD
;
RTRV-IPIF-INFO
Retrieves information about all IP interfaces.
Function
This command retrieves information about all IP interfaces of an NE.
Usage Note
None
Category
TIPS
Security
Retrieve
Command Syntax
RTRV-IPIF-INFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"NAME=<INTERFACE_INFO>:INDEX=<INTERFACE_INDEX>:IP=<IP_ADDR>:MASK=<IP_MAS
K>:FLAG=<IP_FLAG>:LTYPE=<LINK_TYPE>:LMTU=<LINK_MTU>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-IPIF-INFO:::100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"NAME=ETH1:INDEX=386:IP=129.9.0.20:MASK=255.255.0.0:FLAG=0:LTYPE=ETHERNET:L
MTU=1500",
"NAME=PPP-0-2-255-1-257-
1:INDEX=518:IP=129.9.0.20:MASK=255.255.0.0:FLAG=1:LTYPE=PPP:LMTU=960"
;
Related Commands
None
RTRV-PPPIF-COUNT
Retrieves the message count information about a PPP interface.
Function
This command retrieves the message count information about a PPP interface.
Usage Note
None
Category
TIPS
Security
Retrieve
Command Syntax
RTRV-PPPIF-COUNT:[<TID>]::<CTAG>::<INTERFACE_INDEX>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"INDEX=<INTERFACE_INDEX>:IN=<RECV_IP_NUM>:OUT=<SEND_IP_NUM> "<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PPPIF-COUNT:::100::1;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"INDEX=1:IN=1000:OUT=1500"
Related Commands
None
RTRV-PPPIF-STATE
Retrieves the negotiation information about a PPP interface.
Function
This command retrieves the negotiation information about a PPP interface.
Usage Note
None
Category
TIPS
Security
Retrieve
Command Syntax
RTRV-PPPIF-STATE:[<TID>]::<CTAG>::<INTERFACE_INDEX>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"INDEX=<INTERFACE_INDEX>:NEGOSTATE=<NEGO_STATE>:NEGOTYPE=<NEGO_TYPE>:FSM
STATE=<FSM_STATE> "<cr><lf>
;
Response Parameters
Parameter Description
<NEGO_STATE> Indicates the negotiation state. The valid values are as follows:
DEAD
ESTABLISH
AUTHENTICATE
CBCP
NETWORK
TERMINATE
<NEGO_TYPE> Indicates the negotiation type. The valid values are as follows:
LCP
NCP
<FSM_STATE> Indicates the finite state machine (FSM) state. The valid values are
as follows:
INITIAL
STARTING
CLOSED
STOPPED
CLOSING
STOPPING
REQSENT
ACKRCVD
ACKSENT
Parameter Description
OPENED
Example
Command
RTRV-PPPIF-STATE:::100::1;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"INDEX=1:NEGOSTATE=ESTABLISH:NEGOTYPE=NCP:FSMSTATE=OPENED"
Related Commands
None
RTRV-ROUTE-INFO
Retrieves the information about the route table.
Function
This command retrieves the information about the route table.
Usage Note
None
Category
TIPS
Security
Retrieve
Command Syntax
RTRV-ROUTE-INFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"IP=<IP_ADDR>:MASK=<IP_MASK>:HOPNEXT=<HOP_NEXT>:INTERFACE=<INTERFACE_INF
O>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-ROUTE-INFO:::100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"IP=127.0.0.0:MASK=255.0.0.0:HOPNEXT=127.0.0.1:INTERFACE=InLoopBack0"
"IP=129.9.16.2:MASK=255.255.255.255:HOPNEXT=127.0.0.1:INTERFACE=InLoopBack0
"
;
Related Commands
None
D.4.3 Configuring Serial
This section lists commands which used to configure serial port to communicate with
maintenance computer.
ED-SERIAL
Modifies serial port parameters.
Function
This command modifies the attributes and state of the serial port.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
ED-SERIAL:[<TID>]::<CTAG>:::[BAUDRATE=<BAUDRATE>],
[LINKWAY=<LINKWAY>],[WORKSTATE=<WORKSTATE>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SERIAL:::100:::BaudRate=38400;
Response Message
NE 2004-07-10 15:35:00
M 100 COMPLD
;
Related Commands
RTRV-SERIAL
RTRV-SERIAL
Retrieves serial interface parameters.
Function
This command retrieves the parameters of a serial interface.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-SERIAL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" <SRLM_BAUDRATE>,<SRLM_LINKWAY>,<SRLM_STATE>" <cr><lf>
;
Response Parameters
Parameter Description
<SRLM_STATE> Indicates the working status of the serial interface. The valid
Parameter Description
Example
Command
RTRV-SERIAL:::10;
Response Message
NE 2004-07-10 16:24:31
M 10 COMPLD
"38400,TL1,OPEN"
;
Related Commands
ED-SERIAL
D.4.4 Configuring IP
This section lists commands which used to configure IP to communicate with maintenance
computer.
DLT-TIDIPMAP
Deletes a static TID-IP mapping.
Function
This command deletes a static TID-IP mapping.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
DLT-TIDIPMAP:[<TID>]::<CTAG>:::TID=<TID>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-TIDIPMAP:::100:::TID=NE101;
Response Message
NE 2004-07-10 15:51:13
M 100 COMPLD
;
Related Commands
ENT-TIDIPMAP
RTRV-TIDIPMAP
ENT-TIDIPMAP
Creates a static TID-IP mapping.
Function
This command creates a static TID-IP mapping.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
ENT-TIDIPMAP:[<TID>]::<CTAG>:::TID=<TID>,IP=<IPADDR>;
Command Parameters
<IPADDR> Indicates the IP address of the NE. The IP address must be valid NA
and cannot be a loop address (127.0.0.1).
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-TIDIPMAP:::100:::TID=NE101,IP=192.168.0.101;
Response Message
NE 2004-07-10 15:39:50
M 100 COMPLD ;
Related Commands
DLT-TIDIPMAP
RTRV-TIDIPMAP
RTRV-TIDIPMAP
Retrieves all the TID-IP mapping information.
Function
This command retrieves all the TID-IP mapping information.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-TIDIPMAP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" <TID>,<IPADDR>,<MODE> "<cr><lf>
;
Response Parameters
Parameter Description
<MODE> Indicates the mode in which the mapping relation between TID
and IPAddr is set up. The valid values are AUTOMODE and
MANMODE.
Example
Command
RTRV-TIDIPMAP:::100;
Response Message
NE 2004-07-10 15:53:04
M 100 COMPLD
"NE,129.9.0.1,MANMODE"
;
Related Commands
ENT-TIDIPMAP
DLT-TIDIPMAP
DLT-IPROUTE-STATIC
Deletes static routes.
Function
This command deletes static routes from the route table.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
DLT-IPROUTE-STATIC:<TID>::<CTAG>:::DESTIP=<DESTIP>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-IPROUTE-STATIC:::100::: DESTIP=129.9.0.2;
Response Message
NE 2004-07-10 15:57:06
M 100 COMPLD
;
Related Commands
ENT-IPROUTE-STATIC
RTRV-IPROUTE-STATIC
ENT-IPROUTE-STATIC
Adds static routes.
Function
This command adds static routes to the route table.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
ENT-IPROUTE-
STATIC:<TID>::<CTAG>:::DESTIP=<DESTIP>,MASK=<SUBNETMASK>,GATEWAY
=<GATEWAY_LAN>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-IPROUTE-
STATIC:::10:::DESTIP=129.8.0.0,MASK=255.255.0.0,GATEWAY=129.9.0.1;
Response Message
NE 2004-07-10 15:57:06
M 10 COMPLD
;
Related Commands
DLT-IPROUTE-STATIC
RTRV-IPROUTE-STATIC
RTRV-IPROUTE-STATIC
Retrieves static routes.
Function
This command retrieves static routes from the route table.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-IPROUTE-STATIC:<TID>::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"[<DESTIP>],[<MASK>],[<GATEWAY>],[<BID>],[<PORT>]"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-IPROUTE-STATIC:::100;
Response Message
NE 2004-07-10 16:00:08
M 100 COMPLD
"129.8.0.0,255.255.0.0,129.9.0.1,0,0"
;
Related Commands
ENT-IPROUTE-STATIC
DLT-IPROUTE-STATIC
RTRV-IPROUTE
Retrieves all route information.
Function
This command retrieves all route information.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-IPROUTE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<DESTADDR>,<MASK>,<GATEWAY>,<PROTOCOL>,<METRIC>,<IFNAME>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-IPROUTE:::S;
Response Message
NE 2008-12-06 16:28:17
M S RTRV
"127.0.0.0,255.0.0.0,127.0.0.1,DIRECT,0,InLoopBack0"
"127.0.0.1,255.255.255.255,127.0.0.1,DIRECT,0,InLoopBack0"
"129.9.0.0,255.255.0.0,129.9.11.19,DIRECT,0,Ethernet1"
"129.9.0.5,255.255.255.255,129.9.11.24,OSPF,120,PPP-0-2-255-1-2-3"
"129.9.0.100,255.255.255.255,129.9.11.24,OSPF,120,PPP-0-2-255-1-2-3"
"129.9.11.15,255.255.255.255,129.9.11.24,OSPF,120,PPP-0-2-255-1-2-3"
"129.9.11.17,255.255.255.255,129.9.11.24,OSPF,120,PPP-0-2-255-1-2-3"
"129.9.11.18,255.255.255.255,129.9.11.24,OSPF,160,PPP-0-2-255-1-2-3"
"129.9.11.19,255.255.255.255,127.0.0.1,DIRECT,0,InLoopBack0"
"129.9.11.21,255.255.255.255,129.9.11.24,OSPF,80,PPP-0-2-255-1-2-3"
"129.9.11.24,255.255.255.255,129.9.11.24,DIRECT,0,PPP-0-2-255-1-0-1"
"129.9.11.24,255.255.255.255,129.9.11.24,DIRECT,0,PPP-0-2-255-1-2-3"
"129.9.11.34,255.255.255.255,129.9.11.24,OSPF,120,PPP-0-2-255-1-2-3"
>
>
NE 2008-12-06 16:28:17
M S COMPLD
"129.9.255.255,255.255.255.255,129.9.11.19,DIRECT,0,Ethernet1"
"255.255.255.255,255.255.255.255,129.9.11.19,DIRECT,0,Ethernet1"
;
>
Related Commands
ENT-IPROUTE-STATIC
DLT-IPROUTE-STATIC
RTRV-STAT-TCP
Retrieves the TCP connection information.
Function
This command retrieves the information about the TCP active sessions.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-STAT-TCP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"PEERIP=<PEERIPADDR>,PORT=<PORT>,PEERPORT=<PEERPORT>,RECVPACKET=<RECV_PA
CKET>,RECVBYTE=<RECV_BYTE>,SENDPACKET=<SEND_PACKET>,SENDBYTE=<SEND_BYTE>,CO
NNTIMES=<CONNTIMES>."<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-STAT-TCP:::100;
Response Message
NE 2005-12-19 20:21:27
M 100 COMPLD
"PEERIP=129.9.16.17,PORT=1600,PEERPORT=1118,RECVPACKET=25,RECVBYTE=664,SEND
PA
CKET=0,SENDBYTE=0,CONNTIMES=1"
;
Related Commands
None
RTRV-TCPIP-INFO
Retrieves the TCP/IP information.
Function
This command retrieves the information about the TCP/IP.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
RTRV-TCPIP-INFO:[<TID>]::<CTAG>::<TYPE_STR>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<TYPE_INFO>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-TCPIP-INFO:::100::"TCPIP_ShowNetStatus";
Response Message
NEW-NE 2011-10-11 00:10:50
M 100 RTRV
"
Proto Local Address Foreign Address State
"
"TCP4 0.0.0.0:23 0.0.0.0:0 Listening
"
"TCP4 0.0.0.0:80 0.0.0.0:0 Listening
"
"TCP4 0.0.0.0:1400 0.0.0.0:0 Listening
"
"TCP4 0.0.0.0:2008 0.0.0.0:0 Listening
"
"TCP4 0.0.0.0:3081 0.0.0.0:0 Listening
"
"TCP4 0.0.0.0:3082 0.0.0.0:0 Listening
"
"TCP4 0.0.0.0:5432 0.0.0.0:0 Listening
"
"TCP4 130.9.0.2:23 130.9.0.130:4864 Established
"
"UDP4 0.0.0.0:0 0.0.0.0:0
"
"UDP4 0.0.0.0:161 0.0.0.0:0
"
>
>
IP-PING
Communicates with an NE on a network through the ping command.
Function
This command checks the communication with an NE by using the ping command.
Usage Note
The command sends 3 packets and each packet has 56 bytes. TTL is 255.
Category
Communication
Security
Maintenance
Command Syntax
IP-PING:[<TID>]::<CTAG>::<TARGETIP>,[<PING_PKSIZE>],[<PING_PKCNT>],
[<PING_INTERVAL>],[<PING_TIMEOUT>];
Command Parameters
[PING_TIMEOUT] Indicates the time of timeout for a ping packet. The 2000
range is 1 to 20000, unit:ms.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<PINGRESULT>"
<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
IP-PING:::100::129.9.35.210;
Response Message
NE 2004-07-13 16:11:19
M 100 COMPLD
"\"
PING 129.9.35.210: 56 data bytes\""
"\" Reply from 129.9.35.210: bytes=56 Sequence=1 ttl=128 time=1 ms\""
"\" Reply from 129.9.35.210: bytes=56 Sequence=2 ttl=128 time=1 ms\""
"\" Reply from 129.9.35.210: bytes=56 Sequence=3 ttl=128 time=1 ms\""
"\"
--- 129.9.35.210 ping statistics ---\""
"\" 3 packet(s) transmitted\""
"\" 3 packet(s) received\""
"\" Percent 0.00% packet lost \""
"\" round-trip min/avg/max = 1/1/1 ms\""
"\"\""
;
Related Commands
None
IP-TRACERT
Traces the path to an NE on a network.
Function
This command traces the path to an NE on the network.
Usage Note
The user needs to input the maximum number of hops in this command. By default, the
system sends three test data packets for each hop, and the expiration time is five seconds for
each packet. As a result, the proper hop is needed when you input the parameter in the
command.
The command does not support the trace of the local IP address, loopback address, network
segment address, and broadcast address.
Category
Communication
Security
Maintenance
Command Syntax
IP-TRACERT:[<TID>]::<CTAG>::<TARGETIP>,[MAX_HOPS];
Command Parameters
Response Parameters
Parameter Description
Example
Command
IP-TRACERT:::100::129.9.35.210;
Response Message
NE 2004-07-13 16:14:42
M 100 CMPLD
"\"
traceroute to 129.9.35.210(129.9.35.210) 30 hops max,40 bytes packet \""
"\"
1 129.9.35.210 0 ms 0 ms 0 ms \""
"\"\""
;
>
Related Commands
None
RTRV-COM-FIREWALL
Retrieves the state of the communication firewall.
Function
This command is issued to retrieve the information of the communication firewall function.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-COM-FIREWALL:[<TID>]::<CTAG>::<GETFIREWALL_TYPE>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"FIREWALLTYPE=<FIREWALL_TYPE>,FIREWALLSTATE=<FIREWALL_STATE>,FIREWALLVAL
UE=<FIREWALL_VALUE>"<cr><lf>
;
Response Parameters
None
Example
Command
RTRV-COM-FIREWALL:::100::malform;
Response Message
NEW-NE 2014-11-18 05:53:15
M 100 COMPLD
"FIREWALLTYPE=MALFORM:FIREWALLSTATE=OPEN:FIREWALLVALUE=50"
;
Related Commands
RTRV-COM-SERVICE
RTRV-COM-MALFORM
Retrieves the information of the malform.
Function
This command is issued to retrieve the information of the malform.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
RTRV-COM-MALFORM:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"NAME=<INTERFACE_INFO>,IPHEAD=<IPHEAD_ATTACKCOUNT>,IPOPT=<IPOPT_ATTACKCO
UNT>,UNKOWNPRO=<UNKOWNPRO_ATTACKCOUNT>,IPSPOOF=<IPSPOOF_ATTACKCOUNT>,REASST
IMEOUT=<REASSTIMEOUT_ATTACKCOUNT>,REASSERROR=<REASSERROR_ATTACKCOUNT>,INVAL
IDTCP=<INVALIDTCP_ATTACKCOUNT>,LAND=<LAND_ATTACKCOUNT>,ICMP=<ICMP_ATTACKCOU
NT>,IGMPFRAGMENT=<IGMPFRAGMENT_ATTACKCOUNT>,OTHERS=<OTHERS_ATTACKCOUNT>"<cr
><lf>
;
Response Parameters
Parameter Description
Command
rtrv-com-malform:::100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"NAME=ETH1:IPHEAD=0:IPOPT=0:UNKOWNPRO=0:IPSPOOF=0:REASSTIMEOUT=0:REASSERROR
=0:INVALIDTCP=0:LAND=0:ICMP=0:IGMPFRAGMENT=0:OTHERS=0"
"NAME=Wifi:IPHEAD=0:IPOPT=0:UNKOWNPRO=0:IPSPOOF=0:REASSTIMEOUT=0:REASSERROR
=0:INVALIDTCP=0:LAND=0:ICMP=0:IGMPFRAGMENT=0:OTHERS=0"
;
Related Commands
ED-COM-SERVICE
RTRV-COM-ARPBLACKLIST
Retrieves the table of the communication ARP black list.
Function
This command is issued to retrieves the table of the communication ARP black list.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
RTRV-COM-ARPBLACKLIST:[<TID>]::<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"IP=<FIREWALL_IP>,IFINDEX=<FIREWALL_IFINDEX>,MACADDR=<FIREWALL_MACADDR_O
NE>,ATTACKCOUNT=<FIREWALL_ATTACKCOUNT>,WARNINGSTATE=<FIREWALL_STATE>,MACADD
R=<FIREWALL_MACADDR_TWO>,MACADDR=<FIREWALL_MACADDR_THREE>,MACADDR=<FIREWALL
_MACADDR_FOUR>,MACADDR=<FIREWALL_MACADDR_FIVE>,MACADDR=<FIREWALL_MACADDR_SI
X>,MACADDR=<FIREWALL_MACADDR_SEVEN>,MACADDR=<FIREWALL_MACADDR_EIGHT>,MACADD
R=<FIREWALL_MACADDR_NINE>,MACADDR=<FIREWALL_MACADDR_TEN>"<cr><lf>
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-COM-ARPBLACKLIST:::100;
Response Message
NEW-NE 2014-11-18 05:53:15
M 100 COMPLD
"IP=129.9.131.3:IFINDEX=386:MACADDR=12-34-56-78-91-
26:ATTACKCOUNT=2271:WARNINGSTATE=OPEN:MACADDR=12-34-56-78-91-27:MACADDR=12-
34-56-78-91-28:MACADDR=12-34-56-78-91-29:MACADDR=12-34-56-78-91-
2a:MACADDR=12-34-56-78-91-2b:MACADDR=12-34-56-78-91-2c:MACADDR=12-34-56-78-
91-2d:MACADDR=12-34-56-78-91-2e:MACADDR=12-34-56-78-91-25"
;
Related Commands
RTRV-COM-SERVICE
ED-CAPTURE
To control an DCN packet capture
Function
This command is issued to control an DCN packet capture
Usage Note
NA
Category
Communication
Security
Debug
Command Syntax
ED-CAPTURE:[<TID>]::<CTAG>::<CAP_INTF>,<CAP_BID>,
[<CAP_SUBCARD>],<CAP_PORT>,[<CAP_CHANNEL>],
[<CAP_LOGICID>],<CAP_DIRT>,<CAP_STATE>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
Response Parameters
None
Example
Command
ED-CAPTURE:::100::OUTBOUND,SLOT-1-11,255,1,0,0,BOTH,CREATE;
Response Message
NEW-NE 2012-05-31 11:34:57
M 100 COMPLD
;
Related Commands
ED-CAPTURE-RULE
RTRV-CAPTURE
RTRV-CAPTURE-BUF
RTRV-CAPTURE
To query the state of the all DCN Packet Capture
Function
This command is issued to query the state of the all DCN Packet Capture
Usage Note
NA
Category
Communication
Security
Debug
Command Syntax
RTRV-CAPTURE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"NO=<CAP_NUM>,STATE=<CAP_STATE>,INTFTYPE=<CAP_INTF>,BID=<CAP_BID>,SUBCAR
D=<CAP_SUBCARD>,PORT=<CAP_PORT>,CHANNEL=<CAP_CHANNEL>,LOGICID=<CAP_LOGICID>
,BUFADDR=<CAP_BUFADDR>,SHOWDIR=<CAP_DIRT>,RULE=<CAP_RULE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-CAPTURE:::100;
Response Message
NEW-NE 2012-06-01 07:28:55
M 100 COMPLD
"NO=1,STATE=CREATE,INTFTYPE=OUTBOUND,BID=SLOT-1-
11,SUBCARD=255,PORT=1,CHANNEL=0,LOGICID=0,BUFADDR=
301478664,SHOWDIR=BOTH,RULE=\"P1=0x12,\""
"NO=2,STATE=0x00,INTFTYPE=0x00,BID=NULL,SUBCARD=0,PORT=0,CHANNEL=0,LOGICID=
0,BUFADDR=0,SHOWDIR
=0x00,RULE=\"\""
Related Commands
ED-CAPTURE
ED-CAPTURE-RULE
RTRV-CAPTURE-BUF
ED-CAPTURE-RULE
To set a filter rule for packet capture.
Function
This command is issued to set a filter rule for packet capture.
Usage Note
NA
Category
Communication
Security
Debug
Command Syntax
ED-CAPTURE-RULE:[<TID>]::<CTAG>::<CAP_INTF>,<CAP_BID>,
[<CAP_SUBCARD>],<CAP_PORT>,[<CAP_CHANNEL>],
[<CAP_LOGICID>],<CAP_DIRT>,<CAPRULE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
Response Parameters
None
Example
Command
ED-CAPTURE-RULE:::100::OUTBOUND,SLOT-1-11,255,1,0,0,BOTH,"P1=0x12";
Response Message
NEW-NE 2012-05-31 11:34:57
M 100 COMPLD
;
Related Commands
ED-CAPTURE
RTRV-CAPTURE
RTRV-CAPTURE-BUF
RTRV-CAPTURE-BUF
To query details of an DCN packet capture
Function
This command is issued to query details of an DCN packet capture
Usage Note
NA
Category
Communication
Security
Debug
Command Syntax
RTRV-CAPTURE-BUF:
[<TID>]::<CTAG>::<CAP_INTF>,<CAP_BID>,<CAP_SUBCARD>,<CAP_PORT>,<CAP_
CHANNEL>,<CAP_LOGICID>,<CAP_DIRT>,<CAP_COUNT>;
Command Parameters
Parameter Description Default Value
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<CAP_PACKET>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-CAPTURE-BUF:::100::OUTBOUND,SLOT-1-11,255,1,0,0,BOTH,10;
Response Message
NEW-NE 2012-06-01 10:46:33
M 100 COMPLD
"Number DIR Date Time IntfType Bid SubCard PORT Channel
LogicID Length "
" NO DATA"
;
Related Commands
ED-CAPTURE
ED-CAPTURE-RULE
RTRV-CAPTURE
ENT-MTKEY
Modifies the maintenance key.
Function
This command modifies the maintenance key.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
ENT-MTKEY:[<TID>]::<CTAG>:::MTKEY=<DCN_MTKEY>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-MTKEY:::100:::MTKEY="mtkey_42436";
Response Message
WIN-NE 2016-01-11 15:19:14 M S COMPLD
Related Commands
None
ENT-REMOTE-STIPROUTE
Adds remote static routes.
Function
This command adds static routes to the remote route table.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
ENT-REMOTE-STIPROUTE:
[<TID>]::<CTAG>:::IFINDEX=<DCN_IFINDEX>,DESTIP=<DCN_DESTIP>,MASK=<D
CN_MASK>,GATEWAY=<DCN_GATWAY>,LOCALIP=<DCN_LOCALIP>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-REMOTE-
STIPROUTE:::100:::IFINDEX=0x12345678,DESTIP=129.9.0.1,MASK=255.255.255.255,
GATEWAY=129.9.0.2, LOCALIP=129.9.84.31;
Response Message
WIN-NE 2016-01-11 15:19:14 M S COMPLD
Related Commands
DLT-REMOTE-STIPROUTE
RTRV-REMOTE-STIPROUTE
DLT-REMOTE-STIPROUTE
Deletes remote static routes.
Function
This command deletes static routes to the remote route table.
Usage Note
None.
Category
Communication
Security
Debug
Command Syntax
DLT-REMOTE-STIPROUTE:
[<TID>]::<CTAG>:::IFINDEX=<DCN_IFINDEX>,DESTIP=<DCN_DESTIP>,LOCALIP
=<DCN_LOCALIP>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-REMOTE-STIPROUTE:::100::: IFINDEX =0x12345678, DESTIP =129.9.0.1,
LOCALIP =129.9.84.31;
Response Message
WIN-NE 2016-01-11 15:19:14
M S COMPLD
Related Commands
ENT-REMOTE-STIPROUTE
RTRV-REMOTE-STIPROUTE
RTRV-REMOTE-STIPROUTE
Retrieves remote static routes.
Function
This command Retrieves static routes to the remote route table.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
RTRV-REMOTE-STIPROUTE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<DCN_DESTIP>,<DCN_MASK>,<DCN_GATWAY>,<DCN_BID>,<DCN_PID>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-REMOTE-STIPROUTE:::100:::IFINDEX=0x12345678;
Response Message
WIN-NE 2016-03-04 17:47:48
M 100 COMPLD
"129.9.0.1,255.255.255.255,0.0.0.0,0,0"
Related Commands
ENT-REMOTE-STIPROUTE
DLT-REMOTE-STIPROUTE
ENT-REMOTE-TIDIPMAP
Creates a remote static TID-IP mapping.
Function
This command creates a remote static TID-IP mapping.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
ENT-REMOTE-TIDIPMAP:
[<TID>]::<CTAG>:::IFINDEX=<DCN_IFINDEX>,TID=<DCN_TID>,IP=<DCN_IP>,LOC
ALIP=<DCN_LOCALIP>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-REMOTE-
TIDIPMAP:::100:::IFINDEX=0x12345678,TID=NE101,IP=192.168.0.101,LOCALIP=129.
9.84.31;
Response Message
WIN-NE 2016-03-16 15:19:14 M S COMPLD
Related Commands
DLT-REMOTE-TIDIPMAP
RTRV-REMOTE-TIDIPMAP
DLT-REMOTE-TIDIPMAP
Deletes a remote static TID-IP mapping .
Function
This command deletes a remote static TID-IP mapping.
Usage Note
None.
Category
Communication
Security
Debug
Command Syntax
DLT-REMOTE-TIDIPMAP:
[<TID>]::<CTAG>:::IFINDEX=<DCN_IFINDEX>,TID=<DCN_TID>,LOCALIP=<DCN_
LOCALIP>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-REMOTE-
TIDIPMAP:::100:::IFINDEX=0x12345678,TID=NE101,LOCALIP=129.9.84.31;
Response Message
WIN-NE 2016-03-16 15:21:14
M S COMPLD
Related Commands
ENT-REMOTE-TIDIPMAP
RTRV-REMOTE-TIDIPMAP
RTRV-REMOTE-TIDIPMAP
Retrieves all the remote TID-IP mapping information.
Function
This command Retrieves all the remote TID-IP mapping information.
Usage Note
None
Category
Communication
Security
Debug
Command Syntax
RTRV-REMOTE-TIDIPMAP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<DCN_TID>,<DCN_IP>,<DCN_MODE>"<cr><lf>
;
Response Parameters
Parameter Description
<DCN_MODE> Indicates the mode in which the mapping relation between TID and IPAddr is
set up. The valid values are AUTOMODE and MANMODE.
Example
Command
RTRV-REMOTE-TIDIPMAP:::100:::IFINDEX=0x12345678;
Response Message
WIN-NE 2016-04-06 11:15:20
M 100 COMPLD
"WIN-NE,129.9.84.31,AUTOMODE"
"WIN-NE11111111111111,129.9.84.34,MANMODE"
;
Related Commands
ENT-REMOTE-TIDIPMAP
DLT-REMOTE-TIDIPMAP
D.4.5 Configuring OSPF
This section lists commands to configure OSPF protocol
ED-OSPF-AUTH
Modifies the authentication of the OSPF protocol.
Function
This command modifies the authentication of the OSPF protocol.
Usage Note
This command can be successfully issued only after the OSPF protocol is enabled.
Category
Communication
Security
Super
Command Syntax
ED-OSPF-AUTH:
[<TID>]::<CTAG>:::INTERFACE=<AUTHINTERFACE>,AUTHTYPE=<AUTHAUTHT
YPE>,PASSWORD=<AUTHPASSWORD>,KEYID=<AUTHKEYID>;
Command Parameters
<AUTHINTERFACE> Indicates the interface type. The valid values are LAN NA
and DCC.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-OSPF-AUTH:::100:::INTERFACE=LAN;AUTHTYPE=MD5;PASSWORD="abc";KEYID=1;
Response Message
NE 2004-07-10 16:01:49 M 100 COMPLD ;
Related Commands
RTRV-OSPF-ALL
ED-OSPF-DCC
Modifies the DCC-type interface parameters of the OSPF protocol.
Function
This command modifies the DCC-type interface parameters of the OSPF protocol.
Usage Note
This command can be successfully issued only after the OSPF protocol is enabled.
Category
Communication
Security
Maintenance
Command Syntax
ED-OSPF-DCC:[<TID>]::<CTAG>:::[COST=<COST>],[HELLO=<HELLOTIME>],
[DEAD=<DEADTIME>],[RETRANSMIT=<RETRANSMIT_TIME>],
[DELAY=<TRANSIT_DELAY_TIME>],[NOTSILENCE=<NOT_SILENCE>];
Command Parameters
<COST> Indicates the cost. The valid value ranges from 1 to 100
65535. Entering "0" will set this parameter to the
default value.
<HELLOTIME> Indicates the timer of sending hello from the port. The 10
valid value ranges from 1 to 255. Entering "0" will set
this parameter to the default value.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-OSPF-DCC:::100:::COST=150;
Response Message
NE 2004-07-10 16:01:49 M 100 COMPLD ;
Related Commands
RTRV-OSPF-ALL
ED-OSPF-LAN
Modifies the LAN-type interface parameters of the OSPF protocol.
Function
This command modifies the LAN-type interface parameters of the OSPF protocol.
Usage Note
This command can be successfully issued only after the OSPF protocol is enabled.
Category
Communication
Security
Maintenance
Command Syntax
ED-OSPF-LAN:[<TID>]:<AID>:<CTAG>:::[COST=<COST>],
[HELLO=<HELLOTIME>],[DEAD=<DEADTIME>],
[RETRANSMIT=<RETRANSMITTIME>],[DELAY=<TRANSITDELAY>],
[DRPRI=<PRIORITY>],[NOTSILENCE=<NOT_SILENCE>];
Command Parameters
<HELLOTIME> Indicates the hello timer. The valid value ranges from 1 to 10
255. Entering "0" will set this parameter to the default
Parameter Description Default Value
value.
<DEADTIME> Indicates the dead timer. The valid value ranges from 1 to 40
65535. <DEADTIMER> must be larger than
<HELLOTIMER>. Entering "0" will set this parameter to
the default value.
<TRANSITDELAY> Indicates the transit delay. The valid value ranges from 1 1
to 3600. Entering "0" will set this parameter to the default
value.
<PRIORITY> Indicates the OSPF priority. The valid value ranges from 1 1
to 255. Entering "0" will set this parameter to the default
value.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-OSPF-LAN:::100:::cost=150;
Response Message
NE 2004-07-10 16:01:49 M 100 COMPLD ;
Related Commands
RTRV-OSPF-ALL
ED-OSPF-SYS
Modifies the system parameters of the OSPF protocol.
Function
This command modifies the system parameters of the OSPF protocol.
Usage Note
This command can be successfully issued only after the OSPF protocol is enabled.
Category
Communication
Security
Maintenance
Command Syntax
ED-OSPF-SYS:[<TID>]::<CTAG>:::[ENABLE=<OSPF_ENABLE>],[AREA=<AREA>],
[STUB=<STUB_FLAG>],[NSSA=<NSSA_FLAG>],
[IMPORTSTATIC=<IMPORT_STATIC>],[IMPORTDIRECT=<IMPORT_DIRECT>],
[IMPORTDEFRT=<IMPORTDEFRT>],[AUTHTYPE=<OSPFAUTHTYPE>];
Command Parameters
<AREA> Indicates the area ID. The valid values are IP addresses 0.0.0.0
ranging from 0.0.0.0 to 255.255.255.254.
NOTE:
Modification of <AREA> initializes other parameters in area
configuration with default values. The parameters include
<STUB_FLAG> and <NSSA_FLAG>. The value of
<STUB_FLAG> or <NSSA_FLAG> cannot be changed if
<AREA> is set to 0.0.0.0 (backbone area).
<STUB_FLAG> Indicates the stub area flag. The valid values are Y and N
N.
<IMPORT_STATIC> Indicates the import static routes flag. The valid values N
are Y and N.
<IMPORT_DIRECT> Indicates the import direct routes flag. The valid values N
are Y and N.
<IMPORTDEFRT> Indicates the import default routes flag. The valid values N
are Y and N.
<OSPFAUTHTYPE> Indicates the area's authentication type. The valid values
are HMAC-SHA256,MD5, SIMPLE and NONE.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-OSPF-SYS:::100:::ENABLE=Y;
Response Message
NE 2004-07-10 16:01:49 M 100 COMPLD ;
Related Commands
RTRV-OSPF-ALL
RTRV-OSPF-ALL
Retrieves all parameters of the OSPF protocol (OSPF-SYS, OSPF-DCC, and OSPF-LAN).
Function
This command retrieves all parameters of the OSPF protocol (OSPF-SYS, OSPF-DCC, and
OSPF-LAN).
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-OSPF-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"
Enable=<OSPF_ENABLE>,AREA=<AREA>,STUB=<STUB_FLAG>,NSSA=<NSSA_FLAG>,IMPORTST
ATIC=<IMPORTSTATIC_FLAG>,IMPORTDIRECT=<IMPORTDIRECT_FLAG>,INTERFACE=<INTERF
ACE>,COST=<COST>,HELLO=<HELLOTIMER>,DEAD=<DEADTIMER>,RETRANSMIT=<RETRANSMIT
TIMER>,Delay=<TRANSITDELAY>,NOTSILENCE=<NOT_SILENCE>,DRPRI=<OSPF_DRPRI>,IMP
ORTDEFRT=<IMPORTDEFRT_FLAG>,AUTHTYPE=<OSPFAUTHTYPE>;
Response Parameters
Parameter Description
<AREA> Indicates the area ID. The valid value is an IP address ranging
from 0.0.0.0 (default) to 255.255.255.254.
<STUB_FLAG> Indicates the flag. The valid values are Y and N (default=N).
<NSSA_FLAG> Indicates the flag. The valid values are Y and N (default=N).
<IMPORTSTATIC_FLAG> Indicates the flag. The valid values are Y and N (default=N).
<IMPORTDIRECT_FLAG> Indicates the flag. The valid values are Y and N (default=N).
<INTERFACE> Indicates the type of the interface. The valid values are Y, DCC
and LAN.
<COST> Indicates the cost. The valid value ranges from 1 to 65535. The
default value is 100.
<HELLOTIMER> Indicates the hello timer. The valid value ranges from 1 to 255
(default=10).
<DEADTIMER> Indicates the dead timer. The valid value ranges from 1 to 65535.
The default value is 40.
<RETRANSMITTIMER> Indicates the retransmission timer. The valid value ranges from 1
to 65535. The default value is 5.
<TRANSITDELAY> Indicates the transmission delay. The valid value ranges from 1 to
3600 (default=1). The default value is 1.
<NOT_SILENCE> Indicates the flag. The valid values are Y and N (default=Y).
Command
RTRV-OSPF-ALL:::100
Response Message
NE 2004-07-10 16:13:16
M 100 COMPLD
"ENABLE=Y,AREA=0.0.0.0,STUB=N,NSSA=N,IMPORTSTATIC=N,IMPORTDIRECT=N,INTERFAC
E=LAN,COST=10,HELLO=10,DEAD=40,RETRANSMIT=5,DELAY=1,NOTSILENCE=N,
DRPRI=1,IMPORTDEFRT=N,AUTHTYPE=none"
"ENABLE=Y,AREA=0.0.0.0,STUB=N,NSSA=N,IMPORTSTATIC=N,IMPORTDIRECT=N,INTERFAC
E=DCC,COST=100,HELLO=1,DEAD=6,RETRANSMIT=5,DELAY=1,NOTSILENCE=Y,DRPRI=42949
67295,IMPORTDEFRT=N,AUTHTYPE=none"
;
Related Commands
ED-OSPF-SYS
ED-OSPF-DCC
ED-OSPF-LAN
RTRV-OSPF-INFO
Retrieves the OSPF information.
Function
This command retrieves the information about the OSPF.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
RTRV-OSPF-INFO:[<TID>]::<CTAG>::<DCN_OSPF_INFO_TYPE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<DCN_OSPF_INFO>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-OSPF-ALL:::100::NBR;
Response Message
Area 0.0.0.0 interface 129.9.158.2(Ethernet1)'s neighbors
RouterID: 129.9.169.21 Address: 129.9.169.21
State: Full Mode:Nbr is Master Priority: 1
DR: 129.9.169.21 BDR: 129.9.158.2 MTU: 0
Dead timer due in 35 sec
Retrans timer interval: 5
Neighbor is up for 00:02:10
Authentication Sequence: [ 0 ]
RTRV-OSPF-AUTH
Retrieves the authentication parameters of the OSPF protocol.
Function
This command retrieves the authentication parameters of the OSPF protocol.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-OSPF-AUTH:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"INTERFACE=<AUTHINTERFACE>,AUTHTYPE=<AUTHAUTHTYPE>,PASSWORD=<AUTHPASSWOR
D>,KEYID=<AUTHKEYID>"<cr><lf>
;
Response Parameters
Parameter Description
<AUTHINTERFACE> Indicates the interface type. The valid values are LAN and DCC.
<AUTHAUTHTYPE> Indicates the type of authentication. The valid values are HMAC-
SHA256,MD5 , SIMPLE and NONE.
<AUTHPASSWORD> Indicates the password of the authentication. If the authentication
mode is authentication in plain text the value has 1 to 8
characters.If the authentication mode is authentication in MD5 or
HMAC-SHA256 the value has 1 to 255 characters.If the
authentication mode is no authentication, the password is empty.
<AUTHKEYID> Indicates the ID of the key that is verified by the ospf protocol.
Example
Command
RTRV-OSPF-AUTH:::100;
Response Message
NE 2007-05-28 06:49:58
M 100 COMPLD
INTERFACE=LAN;AUTHTYPE=MD5;PASSWORD="abc";KEYID=1
INTERFACE=DCC;AUTHTYPE=SIMPLE;PASSWORD="123";KEYID=0
;
Related Commands
ENT-NTP-AUTHPARA
ED-NTP-AUTHPARA
DLT-NTP-AUTHPARA
D.4.6 Configuring NTP
This section lists commands which used to configure NTP protocol.
DLT-NTP-ACCTL
Deletes the access control of NTP.
Function
This command is issued to delete the NTP access control.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
DLT-NTP-ACCTL:[<TID>]::<CTAG>:::ACLNUM=<NTP_ACLNUM>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-NTP-ACCTL:::100:::ACLNUM=1;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
ENT-NTP-ACCTL
RTRV-NTP-ACCTL
ENT-NTP-ACCTL
Adds access control information about the NTP.
Function
This command adds the access control information about the NTP.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
ENT-NTP-ACCTL:[<TID>]::<CTAG>:::ACLNUM=<NTP_ACLNUM>,SRCIP=<SRCIP>,
[SRCNSAP=<SRCNSAP>],[ADDRACCESS=<ADDR_ACCESS>],
[NTPACCESS=<NTP_ACCESS>];
Command Parameters
<NTP_ACCESS> Indicates the working mode of the NTP. The valid values Peer
are as follows:
Query: Only responds to the query of other NEs.
SYN: Only responds to the time request of other
NEs.
Server: Responds to the query and time request of
other NEs. It cannot be synchronized to remote
servers.
Peer: Responds to the query and time request of
other NEs. It can be synchronized to remote servers.
Response Syntax
cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-NTP-ACCTL:::100:::ACLNUM=1,SRCIP=129.9.0.1,ADDRACCESS =ACCEPT,
NTPACCESS =SYN;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
DLT-NTP-ACCTL
RTRV-NTP-ACCTL
RTRV-NTP-ACCTL
Retrieves the access controls of an NTP.
Function
This command retrieves the information about the NTP access controls.
Usage Note
None
Category
NTP
Security
Maintenance
Command Syntax
RTRV-NTP-ACCTL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"ACLNUM=<NTP_ACLNUM>,SRCIP=<SRC_IP>,SRCNSAP=<SRC_NSAP>,ADDRACCESS=<ADDR_
ACCESS>,NTPACCESS=<NTP_ACCESS>"<cr><lf>
;
Response Parameters
Parameter Description
NTP_ACLNUM Indicates the number of NTP access controls. The valid value
ranges from 1 to 250.
NTP_ACCESS Indicates the working mode of the NTP. The valid values are as
follows:
QUERY: Only responds to the query of other NEs.
SYN: Only responds to the time request of other NEs.
SERVER: Responds to the query and time request of other
NEs. It cannot be synchronized to remote servers.
PEER: Responds to the query and time request of other
NEs. It can be synchronized to remote servers.
Example
Command
RTRV-NTP-ACCTL:::100;
Response Message
NE 2007-05-28 06:51:59
M 100 COMPLD
"ACLNUM=250,SRCIP=129.9.0.1,SRCNSAP=,ADDRACCESS=ACCEPT,NTPACCESS=SERVER"
;
Related Commands
ENT-NTP-ACCTL
DLT-NTP-ACCTL
DLT-NTP-AUTHPARA
Deletes NTP authentication parameters.
Function
This command deletes the NTP authentication parameters.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
DLT-NTP-AUTHPARA:[<TID>]::<CTAG>:::KEYID=<NTP_KEYID>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-NTP-AUTHPARA:::100:::KEYID=12;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
ENT-NTP-AUTHPARA
ED-NTP-AUTHPARA
RTRV-NTP-AUTHPARA
ED-NTP-AUTHPARA
Modifies the parameters of NTP authentication.
Function
This command changes the Network Time Protocol (NTP) authentication information.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
ED-NTP-AUTHPARA:[<TID>]::<CTAG>:::[AUTHTYPE=<NTP_AUTHTYPE>],
[KEYID=< NTP_KEYID>],[KEY=<NTP_KEY>],[STATE=<NTP_TRUSTSTATE>];
Command Parameters
<NTP_AUTHTYPE> Indicates the authentication type applied. Only MD5 is supported. MD5
<NTP_KEYID> Indicates the ID of the key that is verified by the NTP protocol. NA
The valid values are integers ranging from 1 to 1024.
Parameter Description Default
Value
<NTP_TRUSTSTATE> Indicates the state of NTP authentication. The valid values are Y N
(authenticated) and N (unauthenticated).
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-NTP-AUTHPARA:::100:::AUTHTYPE=MD5,KEYID=12,KEY="abc",STATE=Y;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
ENT-NTP-AUTHPARA
DLT-NTP-AUTHPARA
RTRV-NTP-AUTHPARA
ENT-NTP-AUTHPARA
Creates the information about NTP authentication.
Function
This command adds the information about NTP authentication.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
ENT-NTP-AUTHPARA:[<TID>]::<CTAG>:::
[AUTHTYPE=<NTP_AUTHTYPE>],KEYID=<NTP_KEYID>,KEY=<NTP_KEY>,
[STATE=<NTP_TRUSTSTATE>];
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-NTP-AUTHPARA:::100:::AUTHTYPE=MD5,KEYID=12,KEY="abc",STATE=Y;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
ED-NTP-AUTHPARA
DLT-NTP-AUTHPARA
RTRV-NTP-AUTHPARA
RTRV-NTP-AUTHPARA
Retrieves NTP authentication parameters.
Function
This command retrieves NTP authentication parameters.
Usage Note
None
Category
NTP
Security
Super
Command Syntax
RTRV-NTP-AUTHPARA:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"AUTHTYPE=<NTP_AUTHTYPE>,KEYID=<NTP_KEYID>,KEY=<NTP_KEY_RTRV>,STATE=<NTP
_TRUSTSTATE>"<cr><lf>
;
Response Parameters
Parameter Description
<NTP_KEYID> Indicates the ID of the key that is verified by the NTP protocol.
The valid value is an integer ranging from 1 to 1024.
<NTP_TRUSTSTATE> Indicates the state of NTP authentication. The valid values are Y
(authentic) and N (unauthentic).
Example
Command
RTRV-NTP-AUTHPARA:::100;
Response Message
NE 2007-05-28 06:49:58
M 100 COMPLD
"AUTHTYPE=MD5,KEYID=1,KEY=\"wangfei\",STATE=Y"
;
Related Commands
ENT-NTP-AUTHPARA
ED-NTP-AUTHPARA
DLT-NTP-AUTHPARA
DLT-NTP-SERVER
Deletes an NTP server.
Function
This command deletes an NTP server.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
DLT-NTP-SERVER:[<TID>]::<CTAG>:::SERVERIP=<NTP_SERVERIP>,
[SERVERNSAP=<NTP_SERVERNSAP>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-NTP-SERVER:::100:::SERVERIP=129.9.0.1;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
ENT-NTP-SERVER
RTRV-NTP-SERVER
ENT-NTP-SERVER
Creates the information about an NTP server.
Function
This command adds an NTP server.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
ENT-NTP-SERVER:[<TID>]::<CTAG>:::SERVERIP=<NTP_SERVERIP>,
[SERVERNSAP=<NTP_SERVERNSAP>],[VERSION=<NTP_VERSION>],
[TRUSTKEY=<TRUSTKEY>],[PRIORITY=<PRI_SERVER>];
Command Parameters
Parameter Description Default Value
3
<NTP_VERSION> Indicates the version information. The valid values are
integers ranging from 1 to 3.
NOTE:
Version 1 is not supported in C/S mode.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-NTP-SERVER:::100:::SERVERIP=129.9.0.1,VERSION=3,PRIORITY=Y;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
DLT-NTP-SERVER
RTRV-NTP-SERVER
RTRV-NTP-SERVER
Retrieves NTP servers.
Function
This command retrieves NTP servers.
Usage Note
None
Category
NTP
Security
Super
Command Syntax
RTRV-NTP-SERVER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SERVERIP=<NTP_SERVERIP>,SERVERNSAP=<NTP_SERVERNSAP>,VERSION=<NTP_VERSIO
N>,TRUSTKEY=<TRUSTKEY>,PRIORITY=<PRI_SERVER>"<cr><lf>
;
Response Parameters
Parameter Description
<NTP_SERVERIP> Indicates the IP address of an NTP server. The valid values are A, B, and
C class IP addresses.
<NTP_SERVERNSAP> Indicates the NSAP address of an NTP server. This parameter contains 40
bytes.
<NTP_VERSION> Indicates the version information. The valid value is an integer ranging
from 1 to 3.
NOTE:
Version 1 is not supported in C/S mode.
<TRUSTKEY> Indicates the ID of the key that is verified by the NTP protocol. The valid
value is an integer ranging from 0 to 1024.
<PRI_SERVER> Indicates the priority of an NTP server. The valid values are Y (higher
priority) and N (lower priority).
Example
Command
RTRV-NTP-SERVER:::100;
Response Message
NE 2007-05-28 06:49:23
M 100 COMPLD
"SERVERIP=129.9.35.23,SERVERNSAP=,VERSION=3,TRUSTKEY=1,PRIORITY=Y"
;
Related Commands
ENT-NTP-SERVER
DLT-NTP-SERVER
ED-NTP-SYS
Modifies the system parameters of an NTP.
Function
This command modifies system parameters of an NTP.
Usage Note
Switching quickly between enable and disable is not allowed.
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Super
Command Syntax
ED-NTP-SYS:[<TID>]::<CTAG>:::[ENABLE=<NTP_ENABLE>],
[AUTH=<AUTH_ENABLE>],[SERVER=<SRVENABLE>];
Command Parameters
<NTP_ENABLE> Indicates whether the NTP is enabled. The valid values are Y N
(enable NTP) and N (disable NTP).
<SRVENABLE> Indicates whether the NTP local server is enabled. The valid Y
values are Y (enable NTP server) and N (disable NTP server)
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-NTP-SYS:::100:::ENABLE=Y,AUTH=Y,SERVER=N;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
RTRV-NTP-SYS
RTRV-NTP-SYS
Retrieves system parameters of an NTP.
Function
This command retrieves system parameters of an NTP.
Usage Note
None
Category
NTP
Security
Maintenance
Command Syntax
RTRV-NTP-SYS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"ENABLE=<NTP_ENABLE>,AUTH=<AUTH_ENABLE>,SERVER=<SRVENABLE>"<cr><lf>
;
Response Parameters
Parameter Description
<NTP_ENABLE> Indicates whether the NTP is enabled. The valid values are Y
(enable) and N (disable).
<SRVENABLE> Indicates whether NTP server is enabled. The valid values are Y
(enable) and N (disable).
Example
Command
RTRV-NTP-SYS:::100;
Response Message
NE 2007-05-28 06:47:02
M 100 COMPLD
"ENABLE=Y,AUTH=Y,SERVER=Y"
;
Related Commands
ED-NTP-SYS
RTRV-NTP-STATUSINFO
Retrieves status information about an NTP.
Function
This command retrieves the status information about an NTP.
Usage Note
None
Category
NTP
Security
Retrieve
Command Syntax
RTRV-NTP-STATUSINFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"STATUS=<NTP_SYNSTATUS>,REFIP=<REF_IP>,REFNSAP=<REF_NSAP>"<cr><lf>
;
Response Parameters
Parameter Description
<NTP_SYNSTATUS> Indicate whether the NE is synchronized with the NTP server. The
valid values are SYNCHRONIZED and UNSYNCHRONIZED.
Example
Command
RTRV-NTP-STATUSINFO:::100;
Response Message
NE 2007-05-28 06:50:43
M 100 COMPLD
"STATUS=SYNCHRONIZED,REFIP=129.9.35.23,REFNSAP="
;
Related Commands
None
ED-NTP-LOGLEVEL
Modifies the level of an NTP log.
Function
This command Modifies the level of an NTP log.
Usage Note
Switching quickly between enable and disable is not allowed.
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Debug
Command Syntax
ED-NTP-LOGLEVEL:[<TID>]::<CTAG>::<NTPLOGLEVEL>,<LOGENABLE>;
Command Parameters
<NTPLOGLEVEL> Indicates the level of an NTP log. The valid values are err (add NA
err information in dcnerr.log) ,normal(add normal information
in dcn.log), acl(add acl information in dcn.log) and all (include
err,normal,acl).
<LOGENABLE> Indicates whether the level of an NTP log is enabled. The valid NA
values are Y (enable the level) and N (disable the level).
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-NTP-LOGLEVEL:::S::err,Y;
Response Message
WIN-NE 2016-01-11 15:19:14 M S COMPLD ;
Related Commands
RTRV-NTP-LOGLEVEL
RTRV-NTP-LOGLEVEL
Retrieves the state of NTP log level.
Function
This command retrieves the state of NTP log level.
Usage Note
This command can be successfully issued only after the NTP protocol is enabled.
Category
NTP
Security
Debug
Command Syntax
RTRV-NTP-LOGLEVEL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<NTPLOGLEVEL>,<LOGENABLE>"<cr><lf>
;
Response Parameters
Parameter Description
<NTPLOGLEVEL> Indicates the level of an NTP log. The valid values are err (add err
information in dcnerr.log) ,normal(add normal information in dcn.log),
acl(add acl information in dcn.log) and all (include err,normal,acl).
<LOGENABLE> Indicates whether the level of an NTP log is enabled. The valid values are Y
(enable the level) and N (disable the level).
Example
Command
RTRV-NTP-LOGLEVEL:::100;
Response Message
WIN-NE 2016-01-13 14:12:16
M 100 COMPLD
"ERR,Y"
"NORMAL,Y"
"ACL,Y"
Related Commands
ED-NTP-LOGLEVEL
D.4.7 Configuring SNMP
This section lists commands which used to configure SNMP protocol to communicate with
the equipment or network management center..
DLT-SNMP-ACCESSIP
Deletes the IP address from the SNMP agent.
Function
This command deletes an NMS IP address from the SNMP agent.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
DLT-SNMP-ACCESSIP:[<TID>]:<IPAddress>:<CTAG>
Command Parameters
Response Parameters
None
Example
Command
DLT-SNMP-ACCESSIP::129.9.0.100:c;
Response Message
NE 2006-02-23 16:19:03
M C COMPLD
;
Related Commands
ENT-SNMP-ACCESSIP
ED-SNMP-ACCESSIP
RTRV-SNMP-ACCESSIP
ED-SNMP-ACCESSIP
Changes the access level.
Function
This command changes the access level for a legal IP address.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ED-SNMP-ACCESSIP:[TID]:<IPADDRESS>:<CTAG>:::LEVEL=<ACCESSLEVEL>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SNMP-ACCESSIP::129.9.0.100:C:::LEVEL=R
Response Message
NE 2006-02-23 15:52:50
M C COMPLD
;
Related Commands
ENT-SNMP-ACCESSIP
RTRV-SNMP-ACCESSIP
DLT-SNMP-ACCESSIP
ENT-SNMP-ACCESSIP
Enters the IP address into the SNMP agent.
Function
This command enters the get/set IP address into the SNMP agent so that manager can access
to the SNMP agent. The default value before delivery is null. An IP address of no more than
32 bits is allowed.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ENT-SNMP-ACCESSIP:[<TID>]:<IPADDRESS>:<CTAG>:::
[LEVEL=<ACCESSLEVEL>]
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-SNMP-ACCESSIP::129.9.0.102:C;
Response Message
NE 2006-02-23 15:48:59
M C COMPLD ;
Related Commands
RTRV-SNMP-ACCESSIP
ED-SNMP-ACCESSIP
DLT-SNMP-ACCESSIP
RTRV-SNMP-ACCESSIP
Retrieves the IP address related information.
Function
This command retrieves the IP address related information.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-ACCESSIP:[<TID>]:[<IPAddress>]:<CTAG>
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"IPADDRESS=<IPADDRESS>:LEVEL=<ACCESSLEVEL>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SNMP-ACCESSIP::129.9.0.100:C;
Response Message
NE 2006-02-23 14:26:01
M C COMPLD
"IPADDRESS=129.9.0.100:LEVEL=RW"
;
Related Commands
ENT-SNMP-ACCESSIP
ED-SNMP-ACCESSIP
DLT-SNMP-ACCESSIP
DLT-SNMP-TRAPINFO
Deletes the trap configuration information.
Function
This command deletes the trap configuration information about the specified IP address.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
DLT-SNMP-TRAPINFO:[<TID>]:<IPADDRESS>:<CTAG>
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-SNMP-TRAPINFO::129.9.0.100:C;
Response Message
NE 2006-02-23 16:57:48
M C COMPLD
;
Related Commands
RTRV-SNMP-TRAPINFO
ED-SNMP-TRAPINFO
ENT-SNMP-TRAPINFO
ED-SNMP-TRAPINFO
Modifies the trap configuration information.
Function
This command modifies the trap configuration information, including port number, trap
community, trap version and trap security user name.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ED-SNMP-TRAPINFO:[<TID>]:<IPADDRESS>:<CTAG>:::[PORT=<PORTNUMBER>],
[TCOMMUNITY=<TPCOMMUNITY>],[VER=<TRAPVERSION>],
[TUSERNAME=<TUSERNAME>]
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SNMP-TRAPINFO::129.9.0.100:C:::PORT=120;
Response Message
NE 2006-02-23 16:48:25
M C COMPLD
;
Related Commands
RTRV-SNMP-TRAPINFO
ENT-SNMP-TRAPINFO
DLT-SNMP-TRAPINFO
ENT-SNMP-TRAPINFO
Adds trap information.
Function
This command adds trap information to the SNMP agent so that the SNMP trap message can
be transmitted to the SNMP manager. A maximum of 32 IP addresses are supported.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ENT-SNMP-TRAPINFO:[<TID>]:<IPADDRESS>:<CTAG>:::
[PORT=<PORTNUMBER>],
[TCOMMUNITY=<TPCOMMUNITY>],VER=<TRAPVERSION>,
[TUSERNAME=<TUSERNAME>]
Command Parameters
Parameter Description Default Value
<IPADDRESS> Indicates the IP address of SNMP trap. The valid values are -
A, B, and C class IP addresses, except the network address
started with 127.
<TRAPVERSION> Indicates the trap version. The valid values are V1,V2 and -
V3. If this parameter is V3, the parameter is required and the
parameter TCOMMUNITY must be ignored; If this
parameter is V1 or V2, the parameter TCOMMUNITY is
required and the parameter TUSERNAME must be ignored.
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-SNMP-TRAPINFO::129.9.0.100:100:::PORT=162,TCOMMUNITY=Public,VER=V1;
Response Message
NE 2006-02-23 16:40:33
M C COMPLD
;
Related Commands
RTRV-SNMP-TRAPINFO
ED-SNMP-TRAPINFO
DLT-SNMP-TRAPINFO
RTRV-SNMP-TRAPINFO
Retrieves the trap configuration information.
Function
This command retrieves the trap configuration information about a specified IP address.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-TRAPINFO:[<TID>]:[<IPADDRESS >]:<CTAG>
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" IPADDRESS=<IPADDRESS>,PORT=<PORTNUMBER>,
[TCOMMUNITY=<TPCOMMUNITY>],VER=<TRAPVERSION>,
[TUSERNAME=<TUSERNAME>]"<cr><lf>
;
Response Parameters
Parameter Description
<IPADDRESS> Indicates the IP address of SNMP trap. The valid values are A, B,
and C class IP addresses, except 127 network address.
<TRAPVERSION> Indicates the trap version. The valid values are V1,V2 and V3.
Example
Command
RTRV-SNMP-TRAPINFO:::C;
Response Message
NE 2006-02-23 16:26:00
M C COMPLD
"IPADDRESS=129.9.0.12,PORT=162,TCOMMUNITY=Public,VER=V1"
"IPADDRESS=129.9.0.100,PORT=162,TCOMMUNITY=Public,VER=V1"
;
Related Commands
ENT-SNMP-TRAPINFO
ED-SNMP-TRAPINFO
DLT-SNMP-TRAPINFO
ED-SNMP-COMMUNITY
Changes the read community and write community.
Function
This command changes the read community and write community.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ED-SNMP-COMMUNITY:[<TID>]::<CTAG>:::[RCOMUNITY=<RDCOMMUNITY>],
[WCOMMUNITY=<WTCOMMUNITY>],[VERIFYFLG=<VERIFYFLG>];
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SNMP-COMMUNITY:::C:::RCOMMUNITY=Public,WCOMMUNITY=Private
Response Message
NE 2006-02-23 17:07:36
M C COMPLD
;
Related Commands
RTRV-SNMP-COMMUNITY
RTRV-SNMP-COMMUNITY
Retrieves the information about all communities.
Function
This command retrieves the information about all communities that have been configured.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-COMMUNITY:[<TID>]::<CTAG>
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"[RCOMMUNITY=<RDOMMUNITY>],
[WCOMMUNITY=<WTCOMMUNITY>],VERIFYFLG=<VERIFYFLG>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SNMP-COMMUNITY:::100
Response Message
NE 2006-02-23 13:10:11
M 100 COMPLD
"RCOMMUNITY=public,WCOMMUNITY=private,VERIFYFLG=ENABLE"
Related Commands
ED-SNMP-COMMUNITY
ED-SNMP-VER
Changes the SNMP version.
Function
This command changes the SNMP version.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ED-SNMP-VER:[<TID>]::<CTAG>::<VERSION>;
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SNMP-VER:::100::SNMPV1
Response Message
NE 2006-02-23 17:07:36
M C COMPLD
;
Related Commands
RTRV-SNMP-COMMUNITY
RTRV-SNMP-VER
Retrieves the SNMP version information.
Function
This command retrieves the SNMP version information.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-VER:[<TID>]::<CTAG>
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<VERSION>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SNMP-VER:::100
Response Message
NE 2013-02-23 13:10:11
M 100 COMPLD
"SNMPV3"
Related Commands
ED-SNMP-COMMUNITY
REPT^SNMPVERSION^WARNING
Reports an version warning.
Function
This event is reported to warn the user who change SNMP version that SNMPv1/SNMPv2c
is not secure.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^ REPT^SNMPVERSION^WARNING <cr><lf>
/*WARN*/
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2014-06-14 19:49:38
A 6 REPT SNMPVERSION WARNING
"Warning: SNMPv1/SNMPv2c is not secure, and it is recommended to use
SNMPv3"
;
Related Commands
None
ED-SNMP-USER
Edit SNMP USM user info.
Function
This command edits SNMP USM user info, including authentication password, encrypt
password and the VACM group.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ED-SNMP-USER:[TID]:<UserName>:<CTAG>::[AuthPwd=<AuthPwd#>]:
[PrivPwd=<PrivPwd>]:[GroupName=<GroupName>],
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SNMP-
USER::SNMPTEST:100::AuthPwd=Nesoft@!:PrivPwd=PrivPwd2:GroupName=szhwGroup;"
;
Response Message
NE 2006-02-23 15:52:50
M C COMPLD
;
Related Commands
ENT-SNMP-USER
DLT-SNMP-USER
RTRV-SNMP-USER
ENT-SNMP-USER
Add SNMP USM user.
Function
This command adds SNMP USM user, and set user authentication protocol, authentication
password, encrypt protocol, encrypt password and the VACM group.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ENT-SNMP-USER:
[TID]:<UserName>:<CTAG>::AuthType=<AuthType>,AuthPwd=<AuthPwd>,PrivType=<
PrivType>,PrivPwd=<PrivPwd>,GroupName=<GroupName>,
Command Parameters
Response Parameters
None
Example
Command
ENT-SNMP-USER::SNMPTEST:100::AuthType=HMAC-MD5-
96,AuthPwd=Nesoft@!,PrivType=CBC-DES,PrivPwd=Nesoft@!2,GroupName=szhwGroup;
Response Message
NE 2006-02-23 15:52:50
M C COMPLD
;
DLT-SNMP-USER
Delete the SNMP USM user.
Function
This command deletes SNMP USM user.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
DEL-SNMP-USER:[TID]:<UserName>:<CTAG>,
Command Parameters
Response Parameters
None
Example
Command
DLT-SNMP-USER::SNMPTEST:100;
Response Message
NE 2006-02-23 15:52:50
M C COMPLD
;
RTRV-SNMP-USER
Retrieves the usm user information.
Function
This command retrieves the information of the usm users.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-USER:[<TID>]:[<UserName >]:<CTAG>
Command Parameters
Response Parameters
Parameter Description
Example
Command
RTRV-SNMP-USER:::100;
Response Message
ED-SNMP-SECU
Edit the snmp security para.
Function
This command edits the security para, including the ip lock attempt times and lock duration.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
ED-SNMP-SECU:[TID]::<CTAG>::[InvCount=<InvCount>]:[LockTime=<LockTime>],
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SNMP-SECU:::100::INVCOUNT=4:LockTime=5;
Response Message
NE 2006-02-23 15:52:50
M C COMPLD
;
RTRV-SNMP-SECU
Retrieves the security para.
Function
This command retrieves the security para.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-SECU:[<TID>]::<CTAG>
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<INVCOUNT>"<cr><lf>
^^^"<LOCKTIME>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SNMP-SECU:::100;
Response Message
NE 2014-11-13 08:12:54
M 100 COMPLD
"INVCOUNT=4,LOCKTIME=4"
;
RTRV-SNMP-GROUP
Retrieves the group information.
Function
This command retrieves the information of VACM groups.
Usage Note
None
Category
SNMP
Security
Super
Command Syntax
RTRV-SNMP-GROUP:[<TID>]:[<GroupName >]:<CTAG>
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"GroupName"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SNMP-GROUP::szhwGroup:100;
Response Message
NE 2006-02-23 16:26:00
M 100 COMPLD
"szhwGroup,privacy,authPriv,usm,szhwView,szhwView,szhwView"
;
D.5 Equipment Management
This section lists the commands used to configure the equipment hardware.
D.5.1 ENT-EQPT
Creates logical equipment.
Function
This command creates a logical shelf, a unit, or an SFP (small form-factor pluggable) on the
unit. It also automatically generates all port facilities supported by the unit and assigns
default values to all port facility attributes.
Usage Note
After a logical card that supports SFP is created (automatically or manually), the associated
SFP and facility objects are created based on the physical SFP module. If the type of the
physical SFP module cannot be recognized, a colorless port is created.
The facility object is gigabit-Ethernet (GETH) by default if an electrical or optical port is
created as an SFP object on cards that support the SFP module and have Layer-2 switching
and processing capability.
Category
Equipment
Security
Provisioning
Command Syntax
ENT-EQPT:[<TID>]:<AID>:<CTAG>::<TYPE>::[<PST>,][<SST>];
Command Parameters
Parameter Description Default Value
<TYPE> Indicates the AID unit type, that is, the shelf type, card NA
type, or SFP type.
The valid values are as follows when this command is
used to create a shelf:
SHELF6800A: indicates that the shelf type is
OptiX OSN 6800A.
SHELF8800T16: indicates that the shelf type is
OptiX OSN 8800T16.
SHELF8800T32: indicates that the shelf type is
OptiX OSN 8800T32.
SHELF8800T32E: indicates that the shelf type is
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Example
Command
ENT-EQPT::SLOT-1-7:C::13LSX::,AINS;
Response Message
NE 2008-01-01 11:37:18 M C COMPLD ;
Related Commands
D.5.3 DLT-EQPT
D.5.2 ED-EQPT
D.5.4 RTRV-EQPT
D.5.2 ED-EQPT
Edits attributes of a unit in an NE.
Function
This command edits attributes of a unit in an NE. The following attributes can be modified:
State of the equipment
Upper temperature threshold
Lower temperature threshold
The TYPE/WORKMODE parameter cannot be set with other parameters at the same time.
Parameters other than TYPE/WORKMODE can be set at the same time.
Usage Note
This command is only applicable in modifying the unit type during unit upgrade, not during
normal circumstances.
The state of the unit, the port, or the SFP must be OOS-MA, OOS-AUMA or AINS before
TYPE or interface type is modified.
Category
Equipment
Security
Provisioning
Command Syntax
ED-EQPT:[<TID>]:<AID>:<CTAG>:::[PROVTYPE=<TYPE>,]
[WORKMODE=<WORKMODE>,][SVTPID=<SVTPID>,]
[UPTEMPTH=<UPTEMPTH>,][DOWNTEMPTH=<DOWNTEMPTH>,]
[FANSPEED=<FANSPEED>,][FANSPEEDMODE=<FANSPEEDMODE>,]
[MCASCANSPAN=<MCASCANSPAN>,][MCAMONTYPE=<MCAMONTYPE>],
[PWRTH=<PWRTH>],[SHELFLBL=<SHELFLBL>],[USERLBL=<USERLBL>],
[WAVECHK=<WAVECHK>],[LATDURATION=<LATDURATION>],
[HDALMEN=<HDALMEN>],[HDERROFFSET=<HDERROFFSET>],
[HDBADOFFSET=<HDBADOFFSET>],[OCHNIMEN=<OCHNIMEN>]:[[<PST>,]
[<SST>]];
Command Parameters
Param Default
eter Description Value
<AID Indicates the equipment unit identifier. The valid formats corresponding to the NA
> shelf, card and SFP are as follows:
For shelves: SHELF-<SHELF ID>
For cards: SLOT-<SHELF ID>-<SLOT ID>
For SFPs: SLOT-<SHELF ID>-<SLOT ID>-<PORT ID>
For sub-boards, the valid format of <AID> is SLOT-<SHELF ID>-<SLOT
ID>-<PORT ID>. In the format, the value of <PORT ID> for the TN55NPO2N
board is 2 and that for the TN55NPO2E board is 5 because both the boards
Param Default
eter Description Value
support only one sub-board (the sub-board type is 54PQ2). An example of the
command is as follows: ED-EQPT::SLOT-1-3-2:c::::oos
The valid values of <AID> for specific units are provided in EQPT.
Q2
unit:
NO
RM
AL
For
54N
S3
unit:
RE
G
For
11L
SX
R/1
2LS
XL
R
unit:
OR
EG
<SVT Indicates the service VLAN TPID field of the port. This parameter is optional. It is 0X810
PID> only valid for the L4G and TBE. 0
<UPT Indicates the upper temperature threshold in intervals of 1.0 degrees centigrade. 65
EMPT Range: 60 to 70
H> Unit: degrees centigrade
This parameter is different for the following cards:
For TN11LOG, the range is 62 to 72, the default value is 67. But In the device type
of OptiX OSN 3800A, the range is 69 to 79, the default value is 74.
For TN12LOG, the range is 65 to 75, the default value is 70. But In the device type
of OptiX OSN 3800A, the range is 60 to 70, the default value is 65.
For
TN12TMX,TN13LSX,TN12LDX,TN16XCH,TN54THA,TN54TOA,TN54TOG,T
N53TQX,TN53NQ2,TN53ND2,TN53NS2,TN53TDX,TN55TQX,TN16SCC,TN11
RAU1,TN54THA(STND),TN54TOA(STND),TN55TQX(STND),TN53TDX(STN
D),TN55NO2,TN55NO2(REG),TN11RAU2, the range is 65 to 75, the default
value is 70.
For TN11LOA, the range is 67 to 77, the default value is 72.
For TN11TBE, the range is 67 to 77, the default value is 72. But In the device type
of OptiX OSN 3800A, the range is 72 to 82, the default value is 77.
For TN54TSXL, the range is 68 to 78, the default value is 73.
For
TN53TSXL,TN16AUX,TN11LSQ,TNK4XCT,TNK4SXM,TNK4SXH,TN52TDX,
TN52STG,TNK2STG,TN55NS3,TN54ENQ2(STND), the range is 70 to 80, the
default value is 75.
For TN52NS3,TN54NQ2, the range is 72 to 82, the default value is 77.
Param Default
eter Description Value
For TN11LOM,the range is 72 to 82, the default value is 77. But In the device type
of OptiX OSN 3800A, the range is 74 to 84, the default value is 79.
For TN52NS2,the range is 73 to 83, the default value is 78. But In the device type
of OptiX OSN 3800A, the range is 75 to 85, the default value is 80.
For TN52ND2, TN52NQ2, TN52TQX, TNK2XCT,TN11LSQR,TN54TEM28,
TNK2SXM,TN12ND2,TN54NS3,TN11LEM24,TN11LEX4,TN51NQ2,TN11LTX,
TN12LSC,TN54NS4,TN54NS4(REG),TN54NS3(STND), the range is 75 to 85, the
default value is 80.
For
TN52TOM,TN53XCH,TN55NPO2(STND),TN55NPO2E,TNK2USXH,TN16UXC
M, the range is 80 to 90, the default value is 85.
For TN52XCH,TN52UXCH,TNK2UXCT, the range is 85 to 95, the default value
is 90.
For TN14LSX,the range is 60 to 70, the default value is 65. But In the device type
of OptiX OSN 3800A, the range is 57 to 67, the default value is 62.
For TN52ND2(STND), the range is 65 to 75, the default value is 70.
For TN54TTX, the range is 73 to 83, the default value is 78.
For TN54TSC, the range is 80 to 90, the default value is 85.
For TN55TTX, TN56TOX, the range is 67 to 77, the default value is 72.
For TN15LTX, the range is 73 to 83, the default value is 78.But In the device type
of OptiX OSN 8800T16A, the range is 70 to 80, the default value is 75.
For TN54GS4, the range is 73 to 83, the default value is 78.But In the device type
of OptiX OSN 8800T16A, the range is 80 to 90, the default value is 85.
For TN13VA4, TN15FIU, the range is 60 to 70, the default value is 65. But In the
device type of OptiX OSN 3800A, the range is 58 to 68, the default value is 63.
For TN13VA1, the range is 60 to 70, the default value is 65. But In the device type
of OptiX OSN 3800A, the range is 58 to 68, the default value is 63.
For TN12RAU1, TN12RAU2, the range is 58 to 68, the default value is 63.
For TN12RDU9, TN13OBU1, the range is 60 to 70, the default value is 65.
For TN17LSCM, the range is 70 to 80, the default value is 75.But In the device
type of OptiX OSN 3800A, the range is 60 to 70, the default value is 65.
For TN97NS4, the range is 67to 77, the default value is 72. But in the device type
of OptiX OSN 8800T16A, the range is 68 to 78, the default value is 73.
For TN17LSC, the range is 72 to 82, the default value is 77. But in the device type
of OptiX OSN 8800T16A, the range is 71 to 81, the default value is 76.
For TN17LTX, the range is 72 to 82, the default value is 77. But in the device type
of OptiX OSN 6800A, the range is 71 to 81, the default value is 76. In the device
type of OptiX OSN 8800T16A, the range is 70 to 80, the default value is 75.
<DO Indicates the lower temperature threshold in intervals of 1.0 degrees centigrade. 0
WNT Range: 0 to 10
EMPT Unit: degrees centigrade
H>
<FAN Indicates the fan speed. The valid values are HIGH, MID-HIGH, MID, MID-LOW, HIGH
SPEE LOW, and STOP.
D>
Param Default
eter Description Value
<FAN Indicates the fan speed control mode. The valid values are AUTO and MANUAL. AUTO
SPEE When the fan card operates in MANUAL mode, the actual operating status of the
DMO card is the same as the configured operating status of the card. When the fan card
DE> operates in AUTO mode, the FANSPEED parameter indicates the adjusted fan
speed.
This parameter is only valid for the fan card.
<MC Indicates the scan time span of the multi-channel spectrum analysis. 10
ASCA The valid values are from 5 to 49995; in minutes. The value must be a multiple of
NSPA five.
N> The default value is 10 minutes.
<MC Indicates the wavelength monitored type. The valid values are as follows: NRZD
AMO NRZDRZ RZ
NTYP 100GCRZ
E>
50GCRZ
100G40G
50G40G
This parameter is only valid for the MCA card.
PWR The power threshold of the shelf. It is invalid for the card or SFP/XFP. 350 W
TH The unit is watt (W). The power threshold can be a value in the range of: for an
1-350 W for an OptiX OSN 3800 shelf OptiX
OSN
1-1350 W for an OptiX OSN 6800 shelf 3800
1-2400 W for an OptiX OSN 8800 T16, T32, or T64 shelf shelf
1350
W for
an
OptiX
OSN
6800
shelf
2400
W for
an
OptiX
OSN
8800
T16,
T32, or
T64
shelf
<SHE Indicates the shelf label. <SHELFLBL> is an optional parameter used for entering NA
LFLB the physical location of the shelf. It is composed of a maximum of 16 ASCII
Param Default
eter Description Value
Example
Command
ED-EQPT::SLOT-1-1-7:C::::IS;
Response Message
NE 2004-01-01 11:37:18 M C COMPLD ;
Related Commands
D.5.1 ENT-EQPT
D.5.4 RTRV-EQPT
D.5.3 DLT-EQPT
D.5.3 DLT-EQPT
Deletes equipment.
Function
This command deletes a unit.
Usage Note
Before users delete the equipment, the state of the equipment should be set to OOS-MA
(OOS-AUMA) or AINS.
Category
Equipment
Security
Provisioning
Command Syntax
DLT-EQPT:[<TID>]:<AID>:<CTAG>:::[INCL=<INCL>];
Command Parameters
Default
Parameter Description Value
<AID> Indicates the equipment unit identifier. The valid formats are as NA
follows:.
For shelves: SHELF-<SHELF ID>
For cards: SLOT-<SHELF ID>-<SLOT ID>
Default
Parameter Description Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Example
Command
DLT-EQPT::SLOT-1-2:C:::INCL=Y
Response Message
NE 2004-01-01 11:37:18 M C COMPLD ;
Related Commands
D.5.1 ENT-EQPT
D.5.2 ED-EQPT
D.5.4 RTRV-EQPT
D.5.4 RTRV-EQPT
Retrieves information about equipment.
Function
This command retrieves all the attributes of a piece of given equipment.
Usage Note
Parameters <SN>, <CLEI>, <DOM>, <PCBVER>, <SWVER>, <FPGAVER>,
<BIOSVER>, <DESCR> are displayed only when the physical unit is online.
In the case of SFP, nothing is entered for parameters <SWVER>, <FPGAVER>,
<BIOSVER>, <PCBVER>, <SVTPID>, <FANSPEEDMODE>, <FANSPEED>, and
<MCASCANSPAN> are null.
When retrieving the attributes of SHELF-<SHELF ID>, the attributes of the slot units and the
SFPs which belong to the shelf will not be displayed. Similarly, when retrieving the attributes
of SLOT-<SHELF ID>-<SLOT ID>, the attributes of the SFPs which are located on the slot
unit will not be displayed.
Category
Equipment
Security
Retrieve
Command Syntax
RTRV-EQPT:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameter Description Default Value
<AID> Indicates the equipment unit identifier. The valid formats are NA
as follows.
For shelves: SHELF-<SHELF ID>, where <SHELF
ID> can be ALL to retrieve all the shelves.
For cards: SLOT-<SHELF ID>-<SLOT ID>, where
<SHELF ID> can be ALL(SLOT-ALL) to retrieve all the
slot units on each shelf, and <SLOT ID> can be
ALL(SLOT-<SHELF ID>-ALL) to retrieve all the slot
units on the shelf specified by <SHELF ID>.
For SFPs: SLOT-<SHELF ID>-<SLOT ID>-<PORT
ID>, where <PORT ID> can be ALL.SLOT-ALL-ALL-
ALL will retrieve all XFP/SFPs on the NE
For sub-boards, the valid format of AID is SLOT-
<SHELF ID>-<SLOT ID>-<PORT ID>. In the format,
the value of <PORT ID> for the TN55NPO2N board is 2
and that for the TN55NPO2E board is 5 because both the
boards support only one sub-board (the sub-board type is
54PQ2). <PORT ID> can be ALL. For example, the sub-
board type that is returned is 54PQ2 after the ENT-
EQPT::SLOT-1-3-2:C command is executed.
The valid values of <AID> for specific units are provided
in EQPT.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[FILTER=<FILTER>,][PROVTYPE=<TYPE>,][ACTTYPE=<TYPE>,][UPTEMPTH=<UPTEMPTH>,]
[DOWNTEMPTH=<DOWNTEMPTH>,][SWITCHSTATE=<SWITCHSTATE>,][SN=<SN>,]
[CLEI=<CLEI>,][PARTNUM=<PARTNUM>,][DOM=<DOM>,][PCBVER=<PCBVER>,]
[SWVER=<SWVER>,][FPGAVER=<FPGAVER>,][BIOSVER=<BIOSVER>,][MODVER=<MODVER>,]
[WORKMODE=<WORKMODE>,][SVTPID=<SVTPID>,][FANSPEED=<FANSPEED>,]
[FANSPEEDMODE=<FANSPEEDMODE>,][MCASCANSPAN=<MCASCANSPAN>,]
[MCAMONTYPE=<MCAMONTYPE>,][RATEDPWR=<RATEDPWR>,][ACTPWR=<ACTPWR>,]
[PWRTH=<PWRTH>,][USEDCRS=<USEDCRS>,][DESCR=<DESCR>,][SHELFLBL=<SHELFLBL>,]
[USERLBL=<USERLBL>,][HDALMEN=<HDALMEN>,][HDERROFFSET=<HDERROFFSET>,]
[HDBADOFFSET=<HDBADOFFSET>,][LATDURATION=<LATDURATION>,]
[OCHNIMEN=<OCHNIMEN>]:<PST>,[<SST>]"<cr><lf> ;
Response Parameters
Parameter Description
<AID> Indicates the equipment unit identifier. The valid formats are as follows:
For shelves: SHELF-<SHELF ID>.
For cards: SLOT-<SHELF ID>-<SLOT ID>.
For SFPs: SLOT-<SHELF ID>-<SLOT ID>-<PORT ID>
For sub-boards, the valid format of AID is SLOT-<SHELF ID>-
<SLOT ID>-<PORT ID>.
<FILTER> Indicates the parameters can be retrieved. The valid values are
CARDTYPE or ALL.
SHELF8800T32E
SHELF8800T64
SHELF8800T64E
<SN> Indicates the serial number of the equipment/SFP. The valid value is a
string.
<CLEI> Indicates the CLEI code of the equipment/SFP. The valid value is a
string.
<PARTNUM> Indicates the part number of the unit/SFP. The valid value is a unique
eight-digit number for each unit.
<PCBVER> Indicates the PCB version of the equipment. The valid value is a string.
<SWVER> Indicates the software version and patch version of the equipment. The
valid value is a string, such as 3.14H001
<FPGAVER> Indicates the FPGA version of the equipment. The valid value is a string.
<BIOSVER> Indicates the BIOS version of the equipment. The valid value is a string.
<MODVER> Indicates the module version of the equipment. The valid value is a
string, such as (M1)XXX. If there are multiple modules, the versions of
the modules are displayed together.
<SVTPID> Indicates the service VLAN TPID field of the port. This parameter is
optional. It is only valid for the L4G and TBE.
<FANSPEED> Indicates the fan speed. The valid values are HIGH, MID, LOW, MID-
HIGH,MID-LOW and STOP. This parameter is editable in MANUAL
mode.
The parameter is only valid for the fan card.
<FANSPEEDMODE> Indicates the fan speed control mode. The valid values are AUTO and
MANUAL.
This parameter is only valid for the fan card.
<MCASCANSPAN> Indicates the scan time span of the multi-channel spectrum analysis.
The valid values are from 5 to 49995; units are in minutes. The value
must be a multiple of five.
This parameter is only valid for the MCA card.
<MCAMONTYPE> Indicates the wavelength monitoring type. The valid values are as
follows:
NRZDRZ
100GCRZ
50GCRZ
100G40G
50G40G
This parameter is only valid for the MCA card.
<RATEDPWR> Indicates the rated power consumption of the shelf and card.
<ACTPWR> Indicates the actual power consumption of the shelf and card.
<PWRTH> Indicates the power consumption threshold of the shelf.
<USEDCRS> Indicates the cross-connect capacity as configured. This parameter is
only valid for shelves and the value format is N*STS1.
<DESCR> Indicates the description of the unit or SFP. It is a string. The equipment
unit description is displayed as NULL.
NOTE:
This parameter is applicable only for entering or editing shelf AIDs, but it is
retrievable for any level of equipment AID that is associated with a labeled shelf
AID.
<LATDURATION> Specifies the time period during which the preconfigured latency
measurement mode takes effect. The time period starts counting from the
time of specifying the ODUk channel latency measurement mode for a
board. When the specified time period elapses, the preconfigured ODUk
latency measurement mode is deleted automatically.
The parameter value range is [180, 65535] expressed in seconds.
<HDALMEN> Enables the EQPT-NSA/EQPT-SA alarm.
<HDERROFFSET> Indicates the offset of over temperature alarm EQPT-NSA.
<HDBADOFFSET> Indicates the offset of over temperature alarm EQPT-SA.
<OCHNIMEN> Indicates whether OLP or QCP board, as the layer of OCh non-
intervention monitor(OCh NIM),can report OCH-LOS-P or OCHM-
LOS-P alm.The valid value is Y(can report alm) or N(can't report alm).
<EFICOMMODE> Indicates the serial port work mode of EFI board.The valid values are F1
and OAM.
Example
Command
RTRV-EQPT::SLOT-1-11:C;
Response Message
NE 2008-10-12 15:54:55 M C COMPLD "SLOT-1-
11::PROVTYPE=11TQX,ACTTYPE=11TQX,UPTEMPTH=65,DOWNTEMPTH=0,SN=21023161151087
000012,PARTNUM=02316115,DOM=2008-08-03,DESCR=\"OptiX OSN 6800,TN1M1TQX01,4
x 10G Tributary Service Processing
Board\",PCBVER=VER.B,SWVER=3.13,FPGAVER=(U6)120(U14)200(U15)200,BIOSVER=2.2
6/2.62,RATEDPWR=72,ACTPWR=72:IS-NR" ;
Related Commands
D.5.1 ENT-EQPT
D.5.2 ED-EQPT
D.5.3 DLT-EQPT
D.5.5 RTRV-ETH-EQPT
Queries the attributes of Ethernet equipment.
Function
This command queries the attributes of Ethernet equipment.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-ETH-EQPT:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::BDMAC=<BDMAC>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-ETH-EQPT::SLOT-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"SLOT-1-1::BDMAC=00-00-00-00-00-01"
;
Related Commands
ENT-VB
ED-VB
DLT-VB
D.6 Facility Management
This section lists the commands used to configure and maintain the facilities.
D.6.1 ED-<FCMOD2>
Edits the attributes of the FC logical facility.
Function
This command edits the attributes of the FC.
Usage Note
<FCMOD2> includes FC50,FC100, FC200, FC400, FC800 and FC1200.
Category
Facility
Security
Provisioning
Command Syntax
ED-<FCMOD2>:[<TID>]:<AID>:<CTAG>:::[ EXTERN=<EXTERN>],
[DELAYTIME=<DELAYTIME>]:[<PST>];
Command Parameters
Parameters Description Default Value
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS (in-service) and OOS (out-of-service).
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-FC100::CLNT-1-8-1-1:C::::oos;
Response Message
NE 2008-09-03 09:01:04
M C COMPLD
;
Related Commands
D.6.2 RTRV-<FCMOD2>
D.6.2 RTRV-<FCMOD2>
Retrieves the attributes of the FC logical facility.
Function
This command retrieves the attributes of the FC logical facility.
Usage Note
<FCMOD2> includes FC100, FC200, FC400, FC800 and FC1200.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-<FCMOD2>:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid values are as follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[EXTERN=<EXTERN>],[DELAYTIME=<DELAYTIME>],
[SWITCHSTATE=<SWITCHSTATE>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameters Description
<EXTERN> Indicates whether the FC distance extension function is enabled. The valid
values are as follows:
DISABLE
ENABLE
<DELAYTIME> This parameter is only valid for the channels in an SNCP group.
Indicates the delay time (hold-off time). It is an integer ranging from 0 to
100, which is expressed in 0.1 seconds.
Parameters Description
<SWITCHSTATE> Indicates the state of the switching. It is only valid when the port is in the
protection group. The valid values are provided in SWITCHSTATE.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-FC100::CLNT-1-8-1-1:C;
Response Message
NE 2008-09-03 09:01:12
M C COMPLD
"CLNT-1-8-1-1::EXTERN=DISABLE:OOS-AUMA,SGEO"
;
Related Commands
D.6.1 ED-<FCMOD2>
D.6.3 ED-<OCN/STMN>
Edits the attributes of the SONET OCN/STMN.
Function
This command edits the attributes of the SONET OCN/STMN.
Usage Note
OCN includes OC3, OC12, OC48, OC192 and OC768. STMN includes STM1, STM4,
STM16, STM64 and STM256.
Category
Facility
Security
Provisioning
Command Syntax
ED-<OCN/STMN>:[<TID>]:<AID>:<CTAG>:::[B1SFBER=<B1SFBER>],
[B1SDBER=<B1SDBER>],[TRCJ0MODE=<TRCJ0MODE>],
[TRCJ0FMT=<TRCJ0FMT>],[TRCJ0=<TRCJ0>],[EXPTRCJ0=<EXPTRCJ0>],
[PRBS=<PRBS>],[DELAYTIME=<DELAYTIME>]:[<PST>];
Command Parameters
Parameter Description Default Value
<B1SFBER> Indicates the SF BER threshold for the overhead byte (B1) on 1E-3
a facility. The valid value ranges from 1E-5 to 1E-3.
<B1SDBER> Indicates the SD BER threshold for the overhead byte (B1) on 1E-6
a facility. The valid value ranges from 1E-9 to 1E-5.
<TRCJ0MODE> Indicates the trace J0 mode. The valid values are as follows: MAN
MAN: The manually provisioned string is used as the
expected string.
DISABLE: Ability to trace the path is disabled so
there is not any reported data.
<PRBS> During a PRBS test in the OCN mode, the transmitted PRBS OFF
code streams are not valid OCN frames. Enable the PRBS test
mode on the receive side so that the test can be completed.
The valid values are as follows:
OFF: The PRBS test function is disabled.
ON: The PRBS test function is enabled.
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OC12::CLNT-1-1-1-1:C:::TRCJ0FMT=64,TRCJ0=HWTEST;
Response Message
NE 2008-06-01 11:37:18
M C COMPLD
;
Related Commands
D.6.4 RTRV-<OCN/STMN>
D.6.4 RTRV-<OCN/STMN>
Retrieves the attributes of the OCN/STMN facility.
Function
This command retrieves the attributes of the OCN/STMN facility.
Usage Note
OCN includes OC3, OC12, OC48, OC192 and OC768. STMN includes STM1, STM4,
STM16, STM64 and STM256.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-<OCN>:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid formats are as follows.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::B1SFBER=<B1SFBER>,B1SDBER=<B1SDBER>,TRCJ0MODE=<TRCJ0MODE>,TRCJ0F
MT=<TRCJ0FMT>,[TRCJ0=<TRCJ0>],EXPTRCJ0=<EXPTRCJ0>,INCTRCJ0=<INCTRCJ0>,
[PRBS=<PRBS>],[DELAYTIME=<DELAYTIME>],
[SWITCHSTATE=<SWITCHSTATE>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameters Description
<B1SFBER> Indicates the SF BER threshold for the overhead byte (B1) on a facility. The
valid value ranges from 1E-5 to 1E-3. The default value is 1E-3.
<B1SDBER> Indicates the SD BER threshold for the overhead byte (B1) on a facility.
The valid value ranges from 1E-9 to 1E-5. The default value is 1E-6.
<TRCJ0MODE> Indicates the trace J0 mode. The valid values are as follows:
MAN: The manually provisioned string is used as the expected
string.
DISABLE: Ability to trace the path is disabled so there is not any
reported data.
Parameters Description
<TRCJ0FMT> Indicates the format of the J0 byte to be transmitted. The valid values are as
follows:
1: indicates the 1-byte mode.
16: indicates the 16-byte mode.
64: indicates the 64-byte mode.
<TRCJ0> Indicates the J0 byte to be transmitted. The valid value depends on the
<TRCJ0FMT>. This parameter is only valid for cards that can generate the
J0 byte.
<PRBS> During a PRBS test in the OCN mode, the transmitted PRBS code streams
are not valid OCN/STMN frames. Enable the PRBS test mode on the
receive side so that the test can be completed.
OFF: The PRBS test function is disabled.
ON: The PRBS test function is enabled.
<DELAYTIME> This parameter is only valid for the channels in an SNCP group.
Indicates the delay time. It is an integer ranging from 0 to 100, which is
expressed in 0.1 seconds.
Delay time is required when multiple protection schemes are configured.
Switching is not initiated until the delay time is expended when a
malfunction is discovered at a port.
Use the default value when only one type of protection is configured.
<SWITCHSTATE> Indicates the state of the switching. It is only valid when the port is in the
protection group. The valid values are provided in SWITCHSTATE.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-OC3::CLNT-1-7-1-1:C;
Response Message
NE 1990-01-03 08:34:44
M C COMPLD
"CLNT-1-7-1-1::B1SFBER=1E-3,B1SDBER=1E-
6,TRCJ0MODE=DISABLE,TRCJ0FMT=16,EXPTRCJ0=\" \",INCTRCJ0=\" \
",PRBS=OFF,:OOS-AU,SGEO"
;
Related Commands
D.6.3 ED-<OCN/STMN>
D.6.5 RTRV-FECER-<OTUN/OCHS>
Queries pre-FEC or post-FEC BER.
Function
This command queries pre-FEC or post-FEC BER.
Usage Note
OTUn includes OTU1, OTU2, OTU3, OTU5G, OCHS and OTU4,
Category
Facility
Security
Retrieve
Command Syntax
RTRV-FECER-<OTUN>:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid formats are as follows:
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[BEFECBER=<BEFECBER>],[AFTFECBER=<AFTFECBER>]"<cr><lf> ;
Response Parameters
Parameters Description
<BEFECBER> Indicates the pre-FEC BER, in the format of m.xE-n. In the format, m.x
stands for the coefficient, -n stands for the index, and there are at most two
decimal places. The parameter value is INVALID when a BER is invalid.
<AFTFECBER> Indicates the post-FEC BER, in the format of m.xE-n. In the format, m.x
stands for the coefficient, -n stands for the index, and there are at most two
decimal places. The parameter value is INVALID when a BER is invalid.
Example
Command
RTRV-FECER-OTU1::SRV1-1-6-1:D;
Response Message
NE 2008-01-03 09:18:24 M D COMPLD "SRV1-1-6-1::BEFECBER=1.5E-
6,AFTFECBER=1.5E-6" ;
Related Commands
D.15.3 ED-<OTUN>
D.6.6 ED-<TRAFFICMOD2>
Edits the attributes of the logical facility.
Function
This command edits the attributes of the logical facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-<TRAFFICMOD2>:[<TID>]:<AID>:<CTAG>:::[DELAYTIME=<DELAYTIME>]:
[<PST>];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-FICON::CLNT-1-6-1-1:C::::OOS;
Response Message
NE 2008-06-01 12:37:18
M C COMPLD
;
Related Commands
D.6.7 RTRV-<TRAFFICMOD2>
D.6.7 RTRV-<TRAFFICMOD2>
Retrieves the attributes of the logical facility.
Function
This command retrieves the attributes of the logical facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-<TRAFFICMOD2>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[DELAYTIME=<DELAYTIME>],[SWITCHSTATE=<SWITCHSTATE>]:<PST>,<SST>"<cr><lf> ;
Response Parameters
Parameters Description
<DELAYTIME> This parameter is only valid for the channels in an SNCP group.
Indicates the delay time. It is an integer ranging from 0 to 100, which is
Parameters Description
<SWITCHSTATE> Indicates the state of switching. It is valid only when the port is in the
protection group. The valid values are provided in SWITCHSTATE.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-FICON::CLNT-1-6-1-1:D;
Response Message
NE 2008-10-06 18:25:59 M D COMPLD "CLNT-1-6-1-1:::OOS-AUMA,SGEO" ;
Related Commands
D.6.6 ED-<TRAFFICMOD2>
D.6.8 ED-CLNT
Edits the attributes of the logical client facility.
Function
This command edits the attributes of the facility.
Usage Note
When the TQX board accesses services through the LP3 and LP4 optical interfaces on the
client side, it must be housed in slot 1, slot 4, slot 11, or slot 14 when deploying an
OSN6800A device.
Category
Facility
Security
Provisioning
Command Syntax
ED-CLNT:[<TID>]:<AID>:<CTAG>:::[WORKMODE=<WORKMODE>],
[PLDTYPE=<PLDTYPE>],[RATE=<RATE>];
Command Parameters
Parameters Description Default Value
OTU1->ODU1->n*ANY->2*ODU0->ODU1-
>cross-connect board.
OTU1-ODU0: indicates that the board
functions as a tributary board and receives the
ODU1 service. The service mapping trail is OTU1-
>ODU1->2*ODU0->cross-connection board.
OTU1-ANY-ODU0: indicates that the board
functions as a tributary board and receives the
ODU1 service. The service mapping trail is OTU1-
>ODU1->n*ANY->2*ODU0->cross-connect
board.
OTU1-ANY-ODU0-OTU1: indicates that the
board functions as a line and tributary board and
receives the ODU1 service. The service mapping
trail is OTU1->ODU1->n*ANY->2*ODU0-
>ODU1->OTU1->line side.
ANY-OTU1: indicates that the board
functions as a line and tributary board and receives
the ODU1 service. In non-cascading mode, the
service mapping trail is OTU1/ANY->ODU1-
>OTU1->line side. In cascading mode, the service
mapping trail is n*ANY->ODU1->OTU1->line
side.
ANY-ODUFLEX-NONAGGR:service
package that enables 8 x GE services to be
encapsulated into ODU0 services.
For the 54TOA, 54THA, 11LOA, 55TQX, and 53TDX
boards, valid values are as follows:
NONE: indicates that the port is not used. All
the boards support this mode.
ANY-ODUFLEX: tributary ODUFlex mode.
In this mode, client-side signals (2.5 Gbit/s to 4.25
Gbit/s for 54TOA and 54THA, 8 Gbit/s to 10
Gbit/s for 53TDX and 55TQX) are encapsulated
into ODUFlex signals and then output to the WDM
side. The 54TOA, 54THA, 55TQX, and 53TDX
boards support this mode.
ANY-ODU2: tributary ODU2 non-
convergency mode. In this mode, 8 Gbit/s to 10
Gbit/s client-side signals are encapsulated into
ODU2 signals and then output to the WDM side.
The 55TQX and 53TDX boards support this mode.
OTU1-ODU0: tributary ODU1-ODU0 mode.
In this mode, a board functions as a tributary board
and receives the OTU1 service. The service
mapping trail is OTU1->ODU1->2*ODU0->cross-
connection board. The 54TOA and 54THA board
supports this mode.
ANY-ODU0-NONAGGR: tributary ODU0
non-convergence mode. The service mapping trail
Parameters Description Default Value
<PLDTYPE> Indicates the service type that the port supports. The NA
valid values are as follows:
ANY
GETH
XGETH (For the TBE unit, there are two
working modes: 10GE WAN and 10GE LAN.)
Parameters Description Default Value
FETH
OTU1
OTU2
OTU3
OTU5G
STM1
STM4
STM16
STM64
STM256
OC3
OC12
OC48
OC192
OC768
FC100
FC200
FC400
FC800
FC1200
FICON
FICONEXP(FICON Express)
FICON4G
FICON8G
HDSDI
DVBASI(DVB-ASI)
SDI
ESCON
FDDI
ISC1G
ISC2G
ETR
CLO
IBSDR
CBR10G
CPRI1
CPRI2
CPRI3
3GSDI
HDSDIRBR
3GSDIRBR
NOTE:
This parameter cannot be set with other parameters at the
Parameters Description Default Value
same time.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-CLNT::CLNT-1-6-1-4:C:::PLDTYPE=ESCON;
Response Message
NE 2008-11-11 21:32:07 M C COMPLD ;
Related Commands
D.6.9 RTRV-CLNT
D.6.9 RTRV-CLNT
Retrieves the attributes of the logical client facility.
Function
This command retrieves the attributes of the logical client facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-CLNT:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid formats are as follows:
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[WORKMODE=<WORKMODE>,][PLDTYPE=<PLDTYPE>,][RATE=<RATE>]"<cr><lf> ;
Response Parameters
Parameters Description
<WORKMODE> Indicates the working mode and is applicable only to the 52TOM board. If the
value ends with ODUn, the board functions as a tributary board. In this mode,
the services are transmitted to the cross-connect board. If the value ends with
OTUn, the board functions as a line and tributary board. In this mode, the
service is not transmitted to the cross-connect board but is output directly. The
description of each value is as follows:
Parameters Description
<PLDTYPE> Indicates the service type that the port supports. The valid values are as follows:
GETH
XGETH (For the TBE unit, there are two working modes: 10GE WAN
and 10GE LAN.)
FETH
OTU1
OTU2
OTU3
OTU5G
STM1
STM4
STM16
Parameters Description
STM64
STM256
OC3
OC12
OC48
OC192
OC768
FC100
FC200
FC400
FC800
FC1200
FICON
FICONEXP(FICON Express)
FICON4G
HDSDI
DVBASI(DVB-ASI)
SDI
ESCON
FDDI
ISC1G
ISC2G
ETR
CLO
IBSDR
IBDDR
ANY
IBSDR
CBR10G
CPRI1
CPRI2
CPRI3
3GSDI
HDSDIRBR
3GSDIRBR
<RATE> Indicates the rate of a service type. It is applicable only to Any services.
Example
Command
RTRV-CLNT::CLNT-1-6-1-4:C;
Response Message
NE 2008-11-11 21:32:26
M C COMPLD
"CLNT-1-6-1-4::PLDTYPE=ESCON" ;
Related Commands
D.6.8 ED-CLNT
D.6.10 ED-LEDSTATE
Configures the status of the stat indicator on a board.
Function
This command configures the status of the stat indicator on a board.
Usage Note
None.
Category
Facility
Security
Provisioning
Command Syntax
ED-LEDSTATE:[<TID>]:<AID>:<CTAG>:::[LEDSTATE=<LEDSTATE>]
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ed-ledstate::slot-1-9:s:::ledstate=on;
Response Message
NE 2011-06-13 08:59:05
M S COMPLD;
Related Commands
D.6.11 RTRV-LEDSTATE
D.6.11 RTRV-LEDSTATE
Queries the status of the stat indicator on a board.
Function
This command queries the status of the stat indicator on a board.
Usage Note
None.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-LEDSTATE:[<TID>]:<AID>:<CTAG>
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[LEDSTATE=<LEDSTATE>]"<cr><lf> ;
Response Parameters
Parameter Description
Example
Command
rtrv-ledstate::slot-1-9:s;
Response Message
NE 2011-06-13 08:59:04
M S COMPLD
"SLOT-1-3::LEDSTATE=OFF";
Related Commands
D.6.10 ED-LEDSTATE
D.6.12 ED-EC
Edits the attributes of the physical electric facility.
Function
This command edits the attributes of the physical electric facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-EC:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<PORTMEMO>],
[PLDTYPE=<PLDTYPE>],[SVTIMER=<SVTIMER>]:[[<PST>],[<SST>]];
Command Parameters
Parameters Description Default Value
<PLDTYPE> Indicates the service type at the port. This parameter is GETH
only valid for cards that support Ethernet layer 2
processing. The valid values are as follows:
FETH
GETH
<SVTIMER> Indicates the signal validation timer; units are expressed 00-15
in minutes. It is valid only when Auto In-Service is
supported. SVTIMER is a string in an HH-MM (00-
15...48-00) format.
HH: hour
MM: minute
<SST> Indicates the secondary state. The valid values are AINS, NA
SB, and SB-DEA. It can be set to SB if the entity is in
OOS-MA; no outgoing traffic is allowed and incoming
traffic is ignored. When PWRMODE is set to SAVING,
the port is in a power-saving state.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-EC::FAC-1-8-3:C:::PLDTYPE=FETH;
Response Message
NE 2008-11-11 21:12:53
M C COMPLD
;
Related Commands
D.6.13 RTRV-EC
D.6.13 RTRV-EC
Retrieves the attributes of the physical electric facility.
Function
This command retrieves the attributes of the physical electric facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-EC:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],[SILKSCREEN=<SILKSCREEN>],TYPE=<TYPE>,
[PLDTYPE=<PLDTYPE>],SVTIMER=<SVTIMER>:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameters Description
<PORTMEMO> Indicates additional information about the optical port. It is a string that
consists of no more than 64 bytes. Usually it is used to identify the port
name.
Parameters Description
<SILKSCREEN> Indicates the character string silk-screened at the corresponding port on the
front panel.
<TYPE> Indicates the port type. Electrical ports can only serve as client-side ports.
The valid value is CLIENT.
<PLDTYPE> Indicates the service type at the port. This parameter is only valid for cards
that support Ethernet layer 2 processing. The valid values are as follows:
FETH
GETH
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is
valid only when Auto In-Service is supported. SVTIMER is a string in an
HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PST> Indicates the status of the primary state qualifier. The valid values are IS and
OOS.
Example
Command
RTRV-EC::FAC-1-16-3:C;
Response Message
AAAAA 1990-01-01 15:22:46
M C COMPLD
"FAC-1-16-3::PORTMEMO=\"\",TYPE=CLIENT,PLDTYPE=GETH,SVTIMER=00-15:OOS-
AU,AINS&SGEO"
;
>
Related Commands
D.6.12 ED-EC
D.6.14 ED-CFP
Edits the attributes of the physical optical carrier facility.
Function
This command edits the attributes of the physical optical carrier facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-CFP:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<PORTMEMO>],
[LSRSTATE=<LSRSTATE>],[ALS=<ALS>],[LOSTH=<LOSTH>],
[DELAYTIME=<DELAYTIME>],[SVTIMER=<SVTIMER>]:[[<PST>],[<SST>]];
Command Parameters
Parameter Description Default Value
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN
OPEN and CLOSE.
<SVTIMER> Indicates the signal validation timer; units are expressed 00-15
in minutes. It is valid only when Auto In-Service is
supported. SVTIMER is a string in an HH-MM (00-
15...48-00) format.
HH: hour
Parameter Description Default Value
MM: minute
<SST> Indicates the secondary state. The valid values are AINS, NA
SB and SB-DEA.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-CFP::FAC-1-4-3:D:::ALS=ENABLE;
Response Message
NE 2008-06-01 11:37:18
M C COMPLD
;
Related Commands
D.6.15 RTRV-CFP
D.6.15 RTRV-CFP
Retrieves the attributes of the physical optical carrier facility.
Function
This command retrieves the attributes of the physical optical carrier facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-CFP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],SILKSCREEN=<SILKSCREEN>,
[LSRSTATE=<LSRSTATE>],[ALS=<ALS>],[LOSTH=<LOSTH>],[DELAYTIME=<DELAYTIME>],
[SWITCHSTATE=<SWITCHSTATE>],SVTIMER=<SVTIMER>:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameters Description
<PORTMEMO> Indicates additional information about the optical port. It is a string that
consists of no more than 64 bytes. Usually it is used to identify the port
name.
<SILKSCREEN> Indicates the character string silk-screened at the corresponding port on the
front panel.
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and CLOSE.
<ALS> Indicates the automatic laser shutdown flag. The valid values are ENABLE
and DISABLE.
<LOSTH> Indicates the threshold power value of the LOS. This parameter is only valid
for the DCP/OLP unit.
<LOSTH> is measured in units of 1.0 dBm.
<SWITCHSTATE> Indicates the state of the switching. It is only valid when the port is in the
protection group. The valid values are provided in SWITCHSTATE.
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is
valid only when Auto In-Service is supported. SVTIMER is a string in an
HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-CFP::FAC-1-7-3:C;
Response Message
NE 1990-01-03 08:37:13
M C COMPLD
"FAC-1-7-3::PORTMEMO=\"\",SILKSCREEN=TX1/RX1
( IP3 ),LSRSTATE=CLOSE,ALS=ENABLE,SVTIMER=00-15:OOS-AU,AINS&SGEO"
;
Related Commands
D.6.14 ED-CFP
D.6.16 ED-OC
Edits the attributes of the physical optical carrier facility.
Function
This command edits the attributes of the physical optical carrier facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OC:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<PORTMEMO>],
[LSRSTATE=<LSRSTATE>],[ALS=<ALS>],[OFC=<OFC>,][PLDTYPE=<PLDTYPE>],
[CLNTPLDTYPE=<CLNTPLDTYPE>],[MAXSPEED=<MAXSPEED>],
[LOSTH=<LOSTH>],[DELAYTIME=<DELAYTIME>],[TSMODE=<TSMODE>],
[SVTIMER=<SVTIMER>]:[[<PST>],[<SST>]];
Command Parameters
Parameter Description Default Value
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN
OPEN and CLOSE.
OTU3
OTU5G
STM1
STM4
STM16
STM64
STM256
OC3
OC12
OC48
OC192
OC768
FC100
FC200
FC400
FC1200
FICON
FICONEXP(FICON Express)
FICON4G
HDSDI
DVBASI(DVB-ASI)
SDI
ESCON
FDDI
ISC1G
ISC2G
ETR
CLO
Only FETH, GETH, and 10GETH are valid values for
layer 2 processing cards.
All the preceding values are valid for the transparent
transmit card. MAXSPEED is invalid (not displayed upon
query) unless PLDTYPE is set to ANY.
NOTE:
This parameter cannot be set with other parameters at the same
time.
<TSMODE> Indicates the timeslot allocation mode. The valid values RANDOM
are as follows:
FIX: The number of timeslots allocated is fixed.
RANDOM: The number of timeslots allocated is
random.
<SVTIMER> Indicates the signal validation timer; units are expressed 00-15
in minutes. It is valid only when Auto In-Service is
supported. SVTIMER is a string in an HH-MM (00-
15...48-00) format.
HH: hour
MM: minute
<SST> Indicates the secondary state. The valid values are AINS, NA
SB and SB-DEA.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-OC::FAC-1-4-3:D:::ALS=ENABLE,PLDTYPE=ANY,MAXSPEED=24700;
Response Message
NE 2008-06-01 11:37:18
M C COMPLD
;
Related Commands
D.6.17 RTRV-OC
D.6.17 RTRV-OC
Retrieves the attributes of the physical optical carrier facility.
Function
This command retrieves the attributes of the physical optical carrier facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OC:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],SILKSCREEN=<SILKSCREEN>,
[LSRSTATE=<LSRSTATE>],[TYPE=<TYPE>],[ALS=<ALS>],[OFC=<OFC>],
[PLDTYPE=<PLDTYPE>],[CLNTPLDTYPE=<CLNTPLDTYPE>],[MAXSPEED=<MAXSPEED>],
[ACTSPEED=<ACTSPEED>],[LOSTH=<LOSTH>],[ELAYTIME=<DELAYTIME>],
[SWITCHSTATE=<SWITCHSTATE>],TSMODE=<TSMODE>,SVTIMER=<SVTIMER>:<PST>,<SST>"<
cr><lf>
;
Response Parameters
Parameters Description
<PORTMEMO> Indicates additional information about the optical port. It is a string that
consists of no more than 64 bytes. Usually it is used to identify the port
name.
<SILKSCREEN> Indicates the character string silk-screened at the corresponding port on the
front panel.
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and CLOSE.
<TYPE> Indicates the port type. Colorless optical ports can only serve as client-side
ports.
The valid values are CLIENT and LINE.
<ALS> Indicates the automatic laser shutdown flag. The valid values are ENABLE
and DISABLE.
<OFC> Indicates whether OFC is enabled or disabled. This parameter is only valid
to ISC1G/ISC2G/IBSDR/IBDDR services. The valid values are ENABLE
and DISABLE.
<PLDTYPE> Indicates the service type at the port. This parameter is only valid for
Ethernet Layer 2 processing cards, LSX and transparent transmit cards
(LWX). The valid values are as follows:
ANY
GETH
10GETH (There are two working modes for TBE units: 10GE
WAN and 10GE LAN.)
FETH
OTU1
OTU2
OTU3
OTU5G
STM1
STM4
STM16
STM64
STM256
OC3
OC12
OC48
OC192
OC768
Parameters Description
FC100
FC200
FC400
FC1200
FICON
FICONEXP(FICON Express)
FICON4G
HDSDI
DVBASI(DVB-ASI)
SDI
ESCON
FDDI
ISC1G
ISC2G
ETR
CLO
Only FETH, GETH, and 10GETH are valid values for layer 2 processing
cards.
All the preceding values are valid for the transparent transmit card.
MAXSPEED is invalid (not displayed upon query) when PLDTYPE is not
set to ANY.
<CLNTPLDTYPE> Indicates the service type at the client side. This parameter is only valid for
cards which support OTUk services on the client side.
<MAXSPEED> Indicates the maximum bearer rate of client services. This parameter is only
valid for transparent transmit cards such as the TN12LWXS. The value is
expressed in Mbit/s. MAXSPEED is valid when PLDTYPE is set to ANY.
<ACTSPEED> Indicates the actual bit rate of client services. The value is expressed in
Mbit/s.
<LOSTH> Indicates the threshold power value of the LOS. This parameter is only valid
for the DCP/OLP unit.
<LOSTH> is measured in units of 1.0 dBm.
<SWITCHSTATE> Indicates the state of the switching. It is only valid when the port is in the
protection group. The valid values are provided in SWITCHSTATE.
<TSMODE> Indicates the timeslot allocation mode. The valid values are as follows:
Parameters Description
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is
valid only when Auto In-Service is supported. SVTIMER is a string in an
HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-OC::FAC-1-7-3:C;
Response Message
NE 1990-01-03 08:37:13
M C COMPLD
"FAC-1-7-3::PORTMEMO=\"\",SILKSCREEN=TX1/RX1
( IP3 ),LSRSTATE=CLOSE,TYPE=CLIENT,ALS=ENABLE,SVTIMER=00-15:OOS-
AU,AINS&SGEO"
;
Related Commands
D.6.16 ED-OC
D.6.18 ED-OCH
Edits the attributes of the physical OCH facility.
Function
This command edits the attributes of the physical OCH facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OCH:[<TID>]:<AID>:<CTAG>:::[CNTRFEQ=<CNTRFREQ>],
[PORTMEMO=<PORTMEMO>],[LSRSTATE=<LSRSTATE>],[TYPE=<TYPE>],
[ALS=<ALS>],[OFC=<OFC>],[BANDTYPE=<BANDTYPE>],[WVNUM=<WVNUM>],
[ADBANDTYPE=<ADBANDTYPE>],[ADWVNUM=<ADWVNUM>],
[EXPBANDTYPE=<EXPBANDTYPE>],[EXPWVNUM=<EXPWVNUM>],
[PLDTYPE=<PLDTYPE>],[CLNTPLDTYPE=<CLNTPLDTYPE>],
[MAXSPEED=<MAXSPEED>],[LOSTH=<LOSTH>],[EXPPWR=<EXPPWR>],
[ATTEN=<ATTEN>],[VOAOFFSET=<VOAOFFSET>],[DELAYTIME=<DELAYTIME>],
[TSMODE=<TSMODE>],[SVTIMER=<SVTIMER>],
[PMDTOLERANCE=<PMDTOLERANCE>]:[[<PST>],[<SST>]];
Command Parameters
Default
Parameters Description Value
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN OPEN
and CLOSE.
<TYPE> Indicates the port type (client-or line-side). This parameter is CLIENT
only valid for cards that support configurable client-side and
line-side working modes.
CLIENT
LINE
NOTE:
This parameter cannot be set with other parameters at the same
time.
<BANDTYPE> Indicates the working band of the port. The valid values are NA
Default
Parameters Description Value
<EXPBANDTYPE> Indicates the expected receive band at the port. The valid NA
values are CBAND, CWDMBAND, and TX. The value TX
indicates that the expected receive band is the same as the
transmit band.
<EXPBANDWIDTH> Indicates the expected receive band's band width at the port. NA
The value TX indicates that the expected receive band is the
same as the transmit band.
<PLDTYPE> Indicates the service type at the port. This parameter is only NA
valid for the Ethernet Layer 2 processing card (L4G and TBE)
and the transparent transmit card (LWX). The valid values are
as follows:
ANY
GETH
10GETH (There are two working modes for TBE
units: 10GE WAN and 10GE LAN.)
FETH
OTU1
OTU2
OTU3
OTU5G
STM1
STM4
Default
Parameters Description Value
STM16
STM64
STM256
OC3
OC12
OC48
OC192
OC768
FC100
FC200
FC400
FC1200
FICON
FICONEXP (FICON Express)
FICON4G
HDSDI
DVBASI(DVB-ASI)
SDI
ESCON
FDDI
ISC1G
ISC2G
ETR
CLO
Only FETH, GETH, and 10GETH are valid values for Layer
2 processing cards.
All the preceding values are valid for transparent transmit
cards. MAXSPEED is invalid (not displayed upon query)
unless PLDTYPE is set to ANY.
NOTE:
This parameter cannot be set with other parameters at the same
time.
<CLNTPLDTYPE> Indicates the service type at the client side. This parameter is NA
only valid for the card that supports the OTUk services on the
client side.
The valid values are OTN and CLIENT.
<TSMODE> Indicates the timeslot allocation mode. The valid values are as RANDOM
follows:
FIX: The number of timeslots allocated is fixed.
RANDOM: The number of timeslots allocated is
random.
<SVTIMER> Indicates the signal validation timer; units are expressed in 00-15
minutes. It is valid only when Auto In-Service is supported.
SVTIMER is a string in an HH-MM (00-15...48-00) format.
HH: hour
MM: minute
<PMDTOLERANCE> Indicates the PMD tolerance at the port. The valid values are 30
as follows:
30,60.
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
<SST> Indicates the secondary state. The valid values are AINS, SB, NA
and SB-DEA. It can be set to SB if the entity is in OOS-MA;
no outgoing traffic is allowed and incoming traffic is ignored.
When PWRMODE is set to SAVING, the port is in the
power-saving state.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OCH::FAC-1-4-3:C:::PLDTYPE=FETH;
ED-OCH::FAC-1-26-1:C:::CNTRFREQ=195.75625THz,ATTEN=1;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.19 RTRV-OCH
D.6.19 RTRV-OCH
Retrieves the attributes of the physical OCH facility.
Function
This command retrieves the attributes of the physical OCH facility
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OCH:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
specific units.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[CNTRFREQ=<CNTRFEQ>],
[PORTMEMO=<PORTMEMO>],SILKSCREEN=<SILKSCREEN>,[LSRSTATE=<LSRSTATE>],
[TYPE=<TYPE>],[ALS=<ALS>],[OFC=<OFC>],[BANDTYPE=<BANDTYPE>],
[WVNUM=<WVNUM>],[ACTBANDTYPE=<ACTBANDTYPE>],[ACTWVNUM=<ACTWVNUM>],
[ADBANDTYPE=<ADBANDTYPE>],[ADWVNUM=<ADWVNUM>],[ADWV=<ADWV>],
[ACTADBANDTYPE=<ACTADBANDTYPE>],[ACTADWVNUM=<ACTADWVNUM>],
[ACTADWV=<ACTADWV>],[WVNUMRANGE=<WVNUMRANGE>],[PLDTYPE=<PLDTYPE>],
[CLNTPLDTYPE=<CLNTPLDTYPE>],[MAXSPEED=<MAXSPEED>],[ACTSPEED=<ACTSPEED>],
[LOSTH=<LOSTH>],[EXPPWR=<EXPPWR>],[ATTEN=<ATTEN>],[MINATTEN=<MINATTEN>],
[MAXATTEN=<MAXATTEN>],[DELAYTIME=<DELAYTIME>],[SWITCHSTATE=<SWITCHSTATE>],
[TSMODE=<TSMODE>],[SVTIMER=<SVTIMER>],
[PMDTOLERANCE=<PMDTOLERANCE>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameter Description
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and CLOSE.
<TYPE> Indicates the port type (client-side or line-side). The valid values are as
follows:
CLIENT
LINE
<ALS> Indicates whether the automatic laser shutdown is enabled. The valid
values are ENABLE and DISABLE.
<BANDTYPE> Indicates the working band of the port. The valid values are CBAND
and CWDMBAND.
Parameter Description
<ACTBANDTYPE> Indicates the actual working band of the port. The valid values are
CBAND and CWDMBAND (Coarse Wavelength Division Multiplexing
Band).
<ADBANDTYPE> Indicates the band type of add/drop wavelengths. The valid values are
CBAND and CWDMBAND. This parameter is only valid for the MR
series card.
<ADWVNUM> Indicates the add/drop wavelength number. This parameter is only valid
for the MR series card.
<ACTADBANDTYPE> Indicates the actual band type of add/drop wavelengths. The valid values
are CBAND and CWDMBAND. This parameter is only valid for the
MR series card.
<ACTADWVNUM> Indicates the actual add/drop wavelength number. This parameter is only
valid for the MR series card.
<WVNUMRANGE> Indicates the actual operating wavelength range that the port supports.
The range is expressed by using &&. For example, 1&&40.
<EXPBANDTYPE> Indicates the expected receive band at the port. The valid values are
CBAND, CWDMBAND, and TX. The value TX indicates that the
expected receive band is the same as the transmit band.
<EXPWVNUM> Indicates the number of the expected receive wavelength. The valid
values are from 1 to 80, and TX. The value TX indicates that the number
of the expected receive wavelength is the same as that of the transmit
wavelength.
<EXPCNTRFREQ> Indicates the expected receive band's center frequence at the port. The
value TX indicates that the expected receive band is the same as the
transmit band.
<EXPBANDWIDTH> Indicates the expected receive band's band width at the port. The value
TX indicates that the expected receive band is the same as the transmit
band.
<CNTRFREQRANGE> Indicates the actual operating wavelength's center frequence range that
the port supports. The range is expressed by using &&.
<BANDWIDTHRANGE> Indicates the actual operating wavelength's band width range that the
port supports. The range is expressed by using &&.
<PLDTYPE> Indicates the service type at the port. This parameter is only valid for the
Ethernet Layer 2 processing card (TBE and L4G) and the transparent
transmit card (LWX). The valid values are as follows:
ANY
GETH
10GETH (There are two working modes for TBE units: 10GE
WAN and 10GE LAN.)
FETH
OTU1
OTU2
OTU3
OTU5G
STM1
STM4
STM16
STM64
STM256
OC3
OC12
OC48
OC192
OC768
FC100
Parameter Description
FC200
FC400
FC1200
FICON
FICONEXP(FICON Express)
FICON4G
HDSDI
DVBASI(DVB-ASI)
SDI
ESCON
FDDI
ISC1G
ISC2G
ETR
CLO
Only FETH, GETH, and 10GETH are valid values for layer 2
processing cards.
All the preceding values are valid for transparent transmit cards.
MAXSPEED is invalid (not displayed upon query) unless PLDTYPE is
set to ANY.
<CLNTPLDTYPE> Indicates the service type at the client side. This parameter is only valid
for cards that support OTUk services on the client side.
<LOSTH> Indicates the threshold power value of the LOS. This parameter is only
valid for the DCP/OLP unit.
<LOSTH> is measured in units of 1.0 dBm.
<MAXSPEED> Indicates the maximum bearer rate of client services. This parameter is
only valid for transparent transmit cards such as the LWX. The value is
expressed in Mbit/s. MAXSPEED is valid when PLDTYPE is set to
ANY.
<ACTSPEED> Indicates the actual bit rate of client services. The value is expressed in
Mbit/s.
<ATTEN> Indicates the attenuation applied at the interface. The value is expressed
in dBm and is accurate to 0.1 dBm.
<DELAYTIME> This parameter is only valid for the ports of a protection group.
Indicates the delay time. It is an integer ranging from 0 to 100, which is
expressed in 0.1 seconds.
Delay time is required when multiple protection schemes are configured.
Switching is not initiated until the delay time is expended when a
malfunction is discovered at a port.
Use the default value when only one type of protection is configured.
<SWITCHSTATE> Indicates the state of the switching. It is only valid when the port is in
the protection group. For the valid values of <SWITCHSTATE>, refer
to SWITCHSTATE.
<TSMODE> Indicates the timeslot allocation mode. The valid values are as follows:
FIX: The number of timeslots allocated is fixed.
RANDOM: The number of timeslots allocated is random.
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is
valid only when Auto In-Service is supported. SVTIMER is a string in
an HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PMDTOLERANCE> Indicates the PMD tolerance at the port. The valid values are as follows:
30,60.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-OCH::FAC-1-2-1:D;
Response Message
NE 2008-11-17 08:25:01
M D COMPLD
"FAC-1-2-
1::PORTMEMO=\"\",SILKSCREEN=OUT1/IN1( OP1 ),LSRSTATE=OPEN,BANDTYPE=CBAND,WV
NUM=1,WV=196.05THz/1529.16nm,ACTBANDTYPE=CBAND,ACTWVNUM=1,ACTWV=196.05THz/1
529.16nm,WVNUMRANGE=1&&80,SVTIMER=00-15,PMDTOLERANCE=30:IS-NR"
;
Related Commands
D.6.18 ED-OCH
D.6.20 ED-OMS
Edits the attributes of the OMS facility.
Function
This command edits the attributes of the OMS facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OMS:[<TID>]:<AID>:<CTAG>::::[[<PST>],[<SST>]];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OMS::FAC-1-1-1:100::::OOS;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.25 RTRV-OTS
D.6.21 RTRV-OMS
Retrieves the attributes of the OMS facility.
Function
This command retrieves the attributes of the OMS facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OMS:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid format is FAC-
<SHELF ID>-<SLOT ID>-
<PORT ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>:::<PST>,<SST>"<cr><lf>
Response Parameters
Parameters Description
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-OMS::FAC-1-2-1:C;
Response Message
AAAAA 2008-11-01 20:45:44
M C COMPLD
"FAC-1-2-1:::OOS-AUMA,SGEO"
;
Related Commands
D.6.24 ED-OTS
D.6.22 ED-OSC
Edits optical supervisory channel.
Function
This command edits the attributes of the OSC port.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OSC:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<PORTMEMO>],
[LSRSTATE=<LSRSTATE>],[BEFECSDBER=<BEFECSDBER>],[DEGTH=<DEGTH>],
[DEGTIME=<DEGTIME>],[SVTIMER=<SVTIMER>]:[[<PST>],[<SST>]];
Command Parameters
Parameter Description Default Value
<LSRSTATE> Indicates the status of the laser. The valid values OPEN
are OPEN and CLOSE.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-OSC::FAC-1-2-1:C:::LSRSTATE=OPEN;
Response Message
NE 2008-06-01 11:37:18
M C COMPLD
;
Related Commands
D.6.23 RTRV-OSC
D.6.23 RTRV-OSC
Retrieves optical supervisory channel.
Function
This command retrieves the attribute of the OSC port.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OSC:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],SILKSCREEN=<SILKSCREEN>,
[LSRSTATE=<LSRSTATE>],[WV=<WV>],[BEFECSDBER=<BEFECSDBER>],[DEGTH=<DEGTH>],
[DEGTIME=<DEGTIME>],SVTIMER=<SVTIMER>:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameters Description
<PORTMEMO> Indicates additional information about the optical port. It is a string that
consists of no more than 64 bytes. Usually it is used to identify the port
name.
<SILKSCREEN> Indicates the character string silk-screened at the corresponding port on the
front panel.
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and CLOSE.
<WV> Indicates the operating wavelength information of the port. The valid format
is frequency/wavelength: xxxxTHz/xxxnm.
<BEFECSDBER> Indicates the SD threshold before FEC. The valid value ranges from 1E-12 to
1E-1. The default value is 1E-4.
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is
valid only when Auto In-Service is supported. SVTIMER is a string in an
HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PST> Indicates the status of the primary state qualifier. The valid values are IS (in-
service) and OOS (out-of-service).
Example
Command
RTRV-OSC::FAC-1-2-1:C;
Response Message
NE 2008-06-01 11:37:18
M C COMPLD
"FAC-1-2-1::PORTMEMO=\"\",SILKSCREEN=TM1/RM1,SVTIMER=00-15:OOS-
AU,AINS&SGEO"
;
Related Commands
D.6.22 ED-OSC
D.6.24 ED-OTS
Edits the attributes of the OTS facility.
Function
This command edits the attributes of the OTS facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OTS:[<TID>]:<AID>:<CTAG>:::[TIMACT=<TIMACT>],
[TIMMODE=<TIMMODE>],[EXPTTISAPI=<EXPTTISAPI>],
[EXPTTIDAPI=<EXPTTIDAPI>],[TTISAPI=<TTISAPI>],[TTIDAPI=<TTIDAPI>],
[TTIOPER=<TTIOPER>]:[[<PST>],[<SST>]];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OTS::FAC-1-1-1:100:::TIMACT=ENABLE,TIMMODE=SAPI;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.25 RTRV-OTS
D.6.25 RTRV-OTS
Retrieves the attributes of the OTS facility.
Function
This command retrieves the attributes of the OTS facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OTS:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid format is FAC-
<SHELF ID>-<SLOT ID>-
<PORT ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::TIMACT=<TIMACT>,TIMMODE=<TIMMODE>,EXPTTISAPI=<EXPTTISAPI>,EXPTTI
DAPI=<EXPTTIDAPI>,TTISAPI=<TTISAPI>,TTIDAPI=<TTIDAPI>,TTIOPER=<TTIOPER>,INC
TTISAPI=<INCTTISAPI>,INCTTIDAPI=<INCTTIDAPI>,INCTTIOPER=<INCTTIOPER>:<PST>,
<SST>"<cr><lf>
Response Parameters
Parameters Description
<TIMACT> Indicates whether the reporting of the after-TIM response is enabled. The
valid values are as follows:
ENABLE
DISABLE
The TTI is defined by ITU-T G.709 as a 64-byte string and contains SAPI,
DAPI, and OPER.
DAPI: maximum 15-character destination access point identifier.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-OTS::FAC-1-2-1:C;
Response Message
AAAAA 2008-11-01 20:45:44
M C COMPLD
"FAC-1-2-
1::TIMACT=DISABLE,TIMMODE=OFF,EXPTTISAPI="AA",EXPTTIDAPI="BB",TTISAPI="CC",
TTIDAPI="",TTIOPER="",INCTTISAPI="",INCTTIDAPI="",INCTTIOPER="":OOS-
AUMA,SGEO"
;
Related Commands
D.6.24 ED-OTS
D.6.26 RTRV-PORT
Retrieves the type of the facilities.
Function
This command retrieves the type of the facilities.
The facility entities include: all of the exiting physical and logical ports and their sub-ports.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-PORT:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
("^^^AID:[ACTTYPE=<ACTTYPE>,]PLDTYPE=<PLDTYPE>,[<TYPE>]" <cr><lf>)+
;
Response Parameters
Parameters Description
<ACTTYPE> Indicates the type of the physical port which is only valid for the external
physical port.
EQPT
OC
EC
OCH
WDM
OSC
CFP
Parameters Description
<PLDTYPE> Indicates the actual type of the port specified by <AID>. The valid values are as
follows:
ANY: any
GETH: GETH
10GETH: 10GETH LAN
10GETHWAN: 10GETH WAN
FETH: FETH
OTU1: OTU-1
OTU2: OTU-2
OTU3: OTU-3
OTU5G: OTU-5G
ODU1: ODU-1
ODU2: ODU-2
ODU3: ODU-3
ODU5G: ODU-5G
ODU0: ODU-0
OC3: OC-3
OC12: OC-12
OC48: OC-48
OC192: OC-192
OC768: OC-768
FC100: FC-100
FC200: FC-200
FC400: FC-400
FC800: FC-800
FC1200: FC-1200
FICON: FICON
FICONEXP: FICON Express
FICON4G: FICON4G
FICON8G: FICON8G
HDSDI: HDSDI
DVBASI: DVB-ASI
SDI: SDI
ESCON: ESCON
FDDI: FDDI
ISC1G: ISC1G
ISC2G: ISC2G
ETR: ETR
CLO: CLO
IBSDR: IBSDR
IBDDR: IBDDR
IBQDR: IBQDR
3GSDI: 3GSDI
HDSDIRBR: HDSDIRBR
Parameters Description
3GSDIRBR: 3GSDIRBR
UNEQ: the type is not specified
NA: The specified channel does not exist because of type conflict
Example
Command
RTRV-PORT::SLOT-1-11:C;
Response Message
NE18 2008-11-14 07:28:43
M D RTRV
"SLOT-1-11-3::ACTTYPE=EQPT,TYPE=EQPT"
"SLOT-1-11-4::ACTTYPE=EQPT,TYPE=EQPT"
"SLOT-1-11-5::ACTTYPE=EQPT,TYPE=EQPT"
"SLOT-1-11-6::ACTTYPE=EQPT,TYPE=EQPT"
"SLOT-1-11-7::ACTTYPE=EQPT,TYPE=EQPT"
"SLOT-1-11-8::ACTTYPE=EQPT,TYPE=EQPT"
"FAC-1-11-3::ACTTYPE=OC,PLDTYPE=GETH,TYPE=LPT|FIBER|NEPORT|OC|OCH"
"FAC-1-11-4::ACTTYPE=OC,PLDTYPE=GETH,TYPE=LPT|FIBER|NEPORT|OC|OCH"
"FAC-1-11-5::ACTTYPE=OC,PLDTYPE=GETH,TYPE=LPT|FIBER|NEPORT|OC|OCH"
"FAC-1-11-6::ACTTYPE=OC,PLDTYPE=GETH,TYPE=LPT|FIBER|NEPORT|OC|OCH"
"FAC-1-11-7::ACTTYPE=OC,PLDTYPE=GETH,TYPE=LPT|FIBER|NEPORT|OC|OCH"
"FAC-1-11-8::ACTTYPE=OC,PLDTYPE=GETH,TYPE=LPT|FIBER|NEPORT|OC|OCH"
"FAC-1-11-1::ACTTYPE=OCH,TYPE=LPT|FIBER|NEPORT|OCH"
"ACC-1-11-1::PLDTYPE=GETH,TYPE=GETH"
"ACC-1-11-2::PLDTYPE=GETH,TYPE=GETH"
"ACC-1-11-3::PLDTYPE=GETH,TYPE=GETH"
>
>
Related Commands
None
D.6.27 ED-WDM
Edits the attributes of the WDM.
Function
This command edits the attributes of the WDM.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-WDM:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<PORTMEMO>],
[LSRSTATE=<LSRSTATE>],[ALS]=<ALS>,[PROWORKBAND=<PROWORKBAND>],
[AUTOBLCK=<AUTOBLCK>],[RATEDPOWER=<RATEDPOWER>],
[STDGAIN=<STDGAIN>],[SFTH=<SFTH>],[LOSTH=<LOSTH>],
[PWROFFSET=<PWROFFSET>],[ATTEN=<ATTEN>],
[VOAOFFSET=<VOAOFFSET>],[PMDCOEF=<PMDCOEF>],[CDCOEF=<CDCOEF>],
[FIBERTYPE=<FIBERTYPE>],[TXDC=<TXDC>],[RXDC=<RXDC>],
[DELAYTIME=<DELAYTIME>],[RLSTARTUPUPTH=<RLSTARTUPUPTH>],
[RLSTARTUPDOWNTH=<RLSTARTUPDOWNTH>],
[RLALMUPTH=<RLALMUPTH>],[RLALMDOWNTH=<RLALMDOWNTH>],
[RLENABLE=<RLENABLE>],[WORKMODE=<OAWORKMODE>],
[OUTPWR=<OALOCKPWR>],[SVTIMER=<SVTIMER>],[FIBERLEN=<FIBERLEN>],
[MAXWVNUM=<MAXWVNUM>],[FIBERINPWR=<FIBERINPWR>],
[BLOCKSTATE=<BLOCKSTATE>],[MONSWITCH=<MONSWITCH>],
[MAXOUTPWR=<MAXOUTPWR>],[EOLVAL=<EOLVAL>],
[RAMANALS=<RAMANALS>],[PPCARDSTATE=<PPCARDSTATE>],
[DETCTEN=<DETCTEN>]:[[<PST>][,<SST>]];
Command Parameters
Default
Parameters Description Value
<LSRSTATE> Indicates the state of the laser. The valid values are OPEN
OPEN and CLOSE.
<FIBERTYPE> Indicates the fiber type. This parameter is only valid for NA
FIU ports and must be consistent with the type of fiber
used. This parameter is required by ASON. The valid
values are as follows:
G652
LEAF
TW-RS
TW-C
TWPLUS
G653
SMF-LS
Default
Parameters Description Value
G654B
G656
G654A
Tera_light
<RLENABLE> Enables the RL (Return Loss) check. Range: ENABLE| ENABLE for
DISABLE. the
TN11RAU1/2
, DISABLE
for the
TN12RAU1/2
<WORKMODE> Indicates the work mode of the amplifier board.The valid LOCKGAIN
value is
Default
Parameters Description Value
LOCKGAIN/LOCKPWR/MAXGAIN/PLLOCKPWR/A
PC.
<SVTIMER> Indicates the signal validation timer; units are expressed 00-15
in minutes. This parameter is only valid if the Auto In-
Service feature is supported. SVTIMER is a string in an
HH-MM format.
HH: hour, which is an integer ranging from 0 to
48.
MM: minute, which is an integer ranging from 0
to 59. The maximum timer setting is 48 hours.
<FIBERLEN> Indicates the fiber length.This parameter is only valid for 0
FIU ports and must be consistent with the length of fiber
used.
<MAXWVNUM> Provision working max wavelength number: c80, c40, c80
cwdm. 0xff.
<FIBERINPWR> Indicates the in power of the fiber. NA
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-WDM::FAC-1-1-2:C::::IS;
Response Message
NE 2004-01-01 11:37:18 M C COMPLD ;
Related Commands
D.6.28 RTRV-WDM
D.6.28 RTRV-WDM
Retrieves the attributes of the WDM.
Function
This command retrieves the attributes of the WDM.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-WDM:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[PORTMEMO=<PORTMEMO>],SILKSCREEN=<SILKSCREEN>,[LSRSTATE=<LSRSTATE>],
[ALS=<ALS>],[ACTGAIN=<ACTGAIN>],[STDGAIN=<STDGAIN>],
[MAXGAINTH=<MAXGAINTH>],[MINGAINTH=<MINGAINTH>],
[ACTMAXGAINTH=<ACTMAXGAINTH>],[ACTMINGAINTH=<ACTMINGAINTH>],
[AUTOBLCK=<AUTOBLCK>],[RATEDPOWER=<RATEDPOWER>],
[PROWORKBAND=<PROWORKBAND>],[ACTWORKBAND=<ACTWORKBAND>],[SFTH=<SFTH>],
[LOSTH=<LOSTH>],[PWROFFSET=<PWROFFSET>],[ATTEN=<ATTEN>],
[MINATTEN=<MINATTEN>],[MAXATTEN=<MAXATTEN>],[PMDCOEF=<PMDCOEF>],
[CDCOEF=<CDCOEF>],[FIBERTYPE=<FIBERTYPE>],[TXDC=<TXDC>],[RXDC=<RXDC>],
[DELAYTIME=<DELAYTIME>],[RLSTARTUPUPTH=<RLSTARTUPUPTH>],
[RLSTARTUPDOWNTH=<RLSTARTUPDOWNTH>],[RLALMUPTH=<RLALMUPTH>],
[RLALMDOWNTH=<RLALMDOWNTH>],[RLENABLE=<RLENABLE>],[WORKMODE=<OAWORKMODE>],
[OUTPWR=<OALOCKPWR>],[SWITCHSTATE=<SWITCHSTATE>],[SVTIMER=<SVTIMER>],
[FIBERLEN=<FIBERLEN>],[MAXWVNUM=<MAXWVNUM>],[KEYSTATE=<KEYSTATE>],
[BLOCKSTATE=<BLOCKSTATE>],[MONSWITCH=<MONSWITCH>],
[FIBERINPWR=<FIBERINPWR>],[MAXOUTPWRDOWNTH=<MAXOUTPWRDOWNTH>],
[MAXOUTPWRUPTH=<MAXOUTPWRUPTH>],[MAXOUTPWR=<MAXOUTPWR>],[EOLVAL=<EOLVAL>],
[RAMANALS=<RAMANALS>],[PPCARDSTATE=<PPCARDSTATE>],
[PPCARDONLINE=<PPCARDONLINE>],[DETCTEN=<DETCTEN>]:<PST>,<SST>"<cr><lf>
Response Parameters
Parameters Description
<LSRSTATE> Indicates the state of the laser. The valid values are OPEN and
CLOSE.
<ALS> Indicates whether the automatic laser shutdown is enabled. The valid
values are ENABLE and DISABLE.
<STDGAIN> Indicates the standard gain of the optical amplifier. This parameter is
only valid for the OA unit. The unit is 1.0 dB.
<MAXGAINTH> Indicates the maximum threshold of the gain. The unit is 1.0 dB.
This parameter is only valid for the OA unit.
<MINGAINTH> Indicates the minimum threshold of the gain. The unit is 1.0 dB.
This parameter is only valid for the OA unit.
<ACTMAXGAINTH> The actual maximum threshold of the gain. Only for the OA unit.
The parameter value INVALID indicates that the dispersion
compensation value exceeds the upper limit.
Parameters Description
<ACTMINGAINTH> The actual minimum threshold of the gain. Only for the OA unit. The
parameter value INVALID indicates that the dispersion
compensation value exceeds the lower limit.
<RATEDPOWER> Indicates the rated power of the laser. This parameter only is valid
for the OA unit.
<PROWORKBAND> Indicates the provisioned operating wavelength band type. The valid
values are as follows:
C-ALL: indicates all C band wavelengths.
C-ODD: indicates all C band odd wavelengths.
C-EVEN: indicates all C band even wavelengths.
<ACTWORKBAND> Indicates the actual operating wavelength band type. The valid
values are as follows:
C-ALL: indicates all C band wavelengths.
C-ODD: indicates all C band odd wavelengths.
C-EVEN: indicates all C band even wavelengths.
<SFTH> Indicates the threshold optical power of the SF (signal fail). This
parameter is only valid for the DCP/OLP unit.
<LOSTH> Indicates the threshold power value of the LOS (Loss of Signal).
<LOSTH> is measured in units of 1.0 dBm.
<PWROFFSET> Indicates the original power offset between the working port and
protection port. This parameter is only valid for the DCP/OLP unit.
<FIBERTYPE> Indicates the fiber type. This parameter is only valid for FIU ports
and must be consistent with the type of fiber used. This parameter is
required by ASON. The valid values are as follows:
G652
LEAF
TW-RS
TW-C
TWPLUS
G653
SMF-LS
G654B
G656
G654A
Tera_light
<DELAYTIME> This parameter is only valid for the ports of a protection group.
Indicates the delay time. It is an integer ranging from 0 to 100, which
is expressed in 0.1 seconds.
Delay time is required when multiple protection schemes are
configured. Switching is not initiated until the delay time is
expended when a malfunction is discovered at a port.
Use the default value when only one type of protection is configured.
<RLSTARTUPUPTH> The upper threshold of RL (Return Loss) to starting the pump. Only
for the Raman unit.
<RLSTARTUPDOWNTH> The down threshold of RL (Return Loss) to starting the pump. Only
for the Raman unit.
<RLALMUPTH> The upper threshold of RL (Return Loss) alarm. Only for the Raman
unit.
<RLALMDOWNTH> The down threshold of RL (Return Loss) alarm. Only for the Raman
Parameters Description
<WORKMODE> Indicates the work mode of the amplifier board.The valid value is
LOCKGAIN/LOCKPWR/MAXGAIN/PLLOCKPWR/APC
<SWITCHSTATE> Indicates the state of switching. It is only valid when the port is in
the protection group. The valid values are provided
in SWITCHSTATE.
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes.
This parameter is only valid if the Auto In-Service feature is
supported. SVTIMER is a string in an HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59. The
maximum timer setting is 48 hours.
<FIBERLEN> Indicates the fiber length.This parameter is only valid for FIU ports
and must be consistent with the length of fiber used.
<MAXWVNUM> Provision working max wavelength number.
<FIBERINPWR> Indicates the in power of the fiber.
<MAXOUTPWRDOWNTH> Lower threshold of the maximum output optical power of the OA
board.
<MAXOUTPWRUPTH> Upper threshold of the maximum output optical power of the OA
board.
<MAXOUTPWR> Maximum output optical power of the OA board.
<BLOCKSTATE> Indicates the block state of the MCS Switch.
<MONSWITCH> Indicates the Mon port.
<KEYSTATE> Indicates the state of the key.
<EOLVAL> Indicates the in EOL value of line.
<RAMANALS> Enables the raman card als check. Range: ENABLE|DISABLE. The
default is ENABLE
<DETCTEN> Enables the Supports fiber status detection check. Range: ENABLE|
DISABLE. The default is ENABLE
<PPCARDSTATE> Indicates the state of the PPCARD. The valid value is OPEN or
CLOSE.
<PPCARDONLINE> Indicates the state of the PPCARD. The valid value is ONLINE or
OFFLINE.
Parameters Description
Example
Command
RTRV-WDM::FAC-1-5-1:D;
Response Message
NE 2008-11-13 10:38:47 M D COMPLD "FAC-1-5-
1::PORTMEMO=\"\",SILKSCREEN=TO11/RI11,LOSTH=-35.0,SVTIMER=00-15:OOS-
AU,AINS&SGEO" ;
Related Commands
D.6.27 ED-WDM
D.6.29 RMV-<MOD2>
Removes the port or channel from service and places it into the maintenance state.
Function
This command changes the service state of the specified port (optical or electrical port) to
Out of Service - Maintenance (OOS-MA, MT). There are not any alarms generated for the
corresponding facility and the existing alarms must be cleared after this command is issued.
All conditions that are reported as NR and PM continue to be collected and marked as
invalid. This command is required before the loopback or PRBS test command is issued.
Usage Note
None
Category
Facility
Security
Maintenance
Command Syntax
RMV-<MOD2>:[<TID>]:<AID>:<CTAG>
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
RMV-OC::FAC-1-4-1:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.30 RST-<MOD2>
D.6.30 RST-<MOD2>
Restores the port or channel back into service.
Function
This command instructs an NE to restore the facility to service. The entity is changed from a
maintenance state to the original state. Existing alarms are reported.
Usage Note
The WDM-side optical interfaces 1 and 2 have only one laser on the dual fed and selective
receiving unit. A loopback on any of the two interfaces makes the two turn to the loopback
state at the same time. Hence, after the loopback at optical interface 1 is released, modify the
state to IS manually if optical interface 2 is still in the MT or OOS state.
Category
Facility
Security
Maintenance
Command Syntax
RST-<MOD2>:[<TID>]:<AID>:<CTAG>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
RST-OC::FAC-1-4-1:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.29 RMV-<MOD2>
D.6.31 ED-PL
Edits the attributes of the Raman pump laser.
Function
This command modifies the attributes of the Raman pump laser.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-PL:[<TID>]:<AID>:<CTAG>:::[LOCKPOWER=<LOCKPOWER>],
[LSRSTATE=<LSRSTATE>]:[<PST>];
Command Parameters
Parameter Description Default Value
<LSRSTATE> Indicates the status of the laser. The valid values are CLOSE
OPEN and CLOSE.
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PL::FAC-1-120-1-1:C::: LOCKPOWER=6,LSRSTATE=OPEN;
Response Message
NE 04-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.32 RTRV-PL
D.6.32 RTRV-PL
Retrieves the attributes of the Raman pump laser.
Function
This command retrieves the attributes of the Raman pump laser.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-PL:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[LSRSTATE=<LSRSTATE>],[LOCKPOWER=<LOCKPOWER>],
[UPLOCKPOWERTH=<UPLOCKPOWERTH>],
[DOWNLOCKPOWERTH=<DOWNLOCKPOWERTH>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the equipment unit identity. The valid format is FAC-
<SHELF ID>-<SLOT ID>-<PORT ID>-<PATH ID>.
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and
CLOSE.
<LOCKPOWER> Indicates the locked power of the pump laser. This parameter only
applies to Raman units. The valid value ranges from 5.0 to 30.0,and
-60.0.
Example
Command
rtrv-pl::fac-1-127-1-1:c;
Response Message
NE 2009-01-12 09:17:22
M C COMPLD
"FAC-1-127-1-
1::LSRSTATE=CLOSE,LOCKPOWER=20.0,UPLOCKPOWERTH=26.1,DOWNLOCKPOWERTH=20.0:IS
-NR"
;
Related Commands
D.6.31 ED-PL
D.6.33 ED-VCG
Edits the attributes of the VCG facility.
Function
This command edits the attributes of the VCG facility.
Usage Note
The ED-VCG is used to edit the bandwidth at an inverse multiplexing port of the 10GE card.
Category
Facility
Security
Provisioning
Command Syntax
ED-VCG:[<TID>]:<AID>:<CTAG>::::[<PST>];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-VCG::CLNT-1-7-1:C::::OOS;
Response Message
NE 2008-11-13 15:33:04
M C COMPLD
;
Related Commands
D.6.34 RTRV-VCG
D.6.34 RTRV-VCG
Retrieves the attributes of the VCG facility.
Function
This command retrieves the attributes of the VCG facility.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-VCG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::PATHTYPE=<PATHTYPE>,UPPATH=<UPPATH>,DOWNPATH=<DOWNPATH>:<PST>,<S
ST>"<cr><lf>
;
Response Parameters
Table D-1 Output parameters
Parameters Description
<PATHTYPE> Indicates the path type of VCG. The valid values are ODU1V and ODU2V.
<UPPATH> Indicates the time slot number in the uplink direction, which is assigned for
the VCG ID. The initial digit of the value is 0 (0 means that the path is
cleared). The VCG member is changed only when it is set.
The value must be consecutive and start from 1. For example, 1&&4.
Parameters Description
<DOWNPATH> Indicates the time slot number in the downlink direction, which is assigned
for the VCG ID. The initial digit of the value is 0 (0 means that the path is
cleared). The VCG member is changed only when it is set.
The value must be consecutive and start from 1. For example, 1&&4.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-VCG::CLNT-1-7-1:C;
Response Message
NE 2008-11-13 15:33:04
M C COMPLD
"CLNT-1-7-1::PATHTYPE=ODU2V,UPPATH=1&&4,DOWNPATH=1&&4,:OOS-AUMA,SGEO"
;
Related Commands
D.6.33 ED-VCG
D.6.35 ACT-CFG-TEMP
Sets service packages.
Function
This command sets service packages for a board.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ACT-CFG-TEMP:[<TID>]:<AID>:<CTAG>:::[TEMPNAME=<TEMPNAME>],
[ADDXCFLG=<ADDXCFLG>];
Command Parameters
Parameter Description Default Value
<TEMPNAME> Indicates the name of a service package. The valid values are N
as follows:
OC48-ODU1: service package that enables 4 x STM-
16 or 8 x STM-16 services on a tributary board to be
encapsulated into ODU1 services.
GE-ODU0: service package that enables 8 x GE or 16
x GE services to be encapsulated into ODU0 services.
OC3-OTU1: service package that enables 7 x STM-1
services on a tributary-line board to be encapsulated into
ODU1 services.
FE-ODU0-OTU1: service package that enables 7 x FE
services on a tributary-line board to be encapsulated into
ODU0 services.
OTU1-OTU1: service package that enables 4 x OTU1
services to be regenerated.
OTU1-ANY-ODU0-ODU1: service package that
enables 4 x OTU1 services on a tributary board to be
encapsulated into ODU1_ODU0 services.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Example
Command
ACT-CFG-TEMP::FAC-1-1:D:::TEMPNAME=GE-ODU0-NONAGGR,ADDXCFLG=XC;
Response Message
NE 2004-01-01 11:37:18 M C COMPLD ;
Related Commands
None
D.6.36 RTRV-PWR
Queries the optical power.
Function
This command queries the optical power of an optical port.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-PWR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[OPR=<OPR>],[OPT=<OPT>]"<cr><lf> ;
Response Parameters
Parameters Description
<OPR> Indicates the input optical power of the current optical port.
<OPT> Indicates the output optical power of the current optical port.
Example
Command
RTRV-PWR::FAC-1-1-2:D;
Response Message
NE-91-7 2011-01-22 11:57:11
M D COMPLD
"FAC-1-1-2::OPR=-2.2"
;
Related Commands
None
D.6.37 RTRV-OPMOD
Retrieves the type of the optical module.
Function
This command retrieves the type of the optical module.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OPMOD:[<TID>]:[<AID>]:<CTAG>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::INBAND=<INBANDNOISE>"<cr><lf>)+
Response Parameters
Parameter Description
Example
Command
RTRV-OPMOD::FAC-1-2-4:C;
Response Message
NE 2004-01-01 11:37:18 M C COMPLD "FAC-1-2-4::NAME=TN11RAU1" ;
Related Commands
None
D.6.38 SET-CFG-SNDFLG
Sets the board configuration deliver flag.
Function
This command sets the board configuration deliver flag.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
SET-CFG-SNDFLG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
"SENDBDDATAFLAG-IS-SETTING"
;
Example
Command
SET-CFG-SNDFLG:::100;
Response Message
NEW-NE 2012-08-27 18:20:28
M 100 COMPLD
"SENDBDDATAFLAG-IS-SETTING"
;
Related Commands
None
D.6.39 ED-OCHM
Edits the attributes of the physical OCHM facility.
Function
This command edits the attributes of the physical OCHM facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OCHM:[<TID>]:<AID>:<CTAG>:::
[PORTMEMO=<SETPORTMEMO>],ODDEVEN=<ODDEVEN>,
[LSRSTATE=<LSRSTATE>],[SVTIMER=<SVTIMER>]:[[<PST>],[<SST>]];
Command Parameters
Default
Parameters Description Value
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and OPEN
CLOSE.
<SVTIMER> Indicates the signal validation timer; units are expressed in 00-15
minutes. It is valid only when Auto In-Service is supported.
SVTIMER is a string in an HH-MM (00-15...48-00) format.
HH: hour
Default
Parameters Description Value
MM: minute
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
<SST> Indicates the secondary state. The valid values are AINS, SB, NA
and SB-DEA. It can be set to SB if the entity is in OOS-MA;
no outgoing traffic is allowed and incoming traffic is ignored.
When PWRMODE is set to SAVING, the port is in the power-
saving state.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OCHM::FAC-1-4-3:C:::ODDEVEN=EVEN;
Response Message
NE 2014-01-01 11:37:18
M C COMPLD
;
Related Commands
D.15.8 RTRV-OCHM
D.6.40 ED-OCHS
Edits the attributes of the physical OCHS facility.
Function
This command edits the attributes of the physical OCHS facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-OCHS:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<PORTMEMO>],
[LSRSTATE=<LSRSTATE>],[BANDTYPE=<BANDTYPE>],[WVNUM=<WVNUM>],
[SVTIMER=<SVTIMER>],[FEC=<FEC>],[BEFECSDBER=<BEFECSDBER>],
[QVALUE=<QVALUE>],[STCNTRFREQ=<STCNTRFREQ>],
[STBANDWIDTH=<STBANDWIDTH>],[EXPCNTRFREQ=<EXPCNTRFREQ>],
[EXPBANDWIDTH=<EXPBANDWIDTH>]:[[<PST>],[<SST>]];
Command Parameters
Default
Parameters Description Value
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and OPEN
CLOSE.
<BANDTYPE> Indicates the working band of the port. The valid values are NA
CBAND and CWDMBAND.
<SVTIMER> Indicates the signal validation timer; units are expressed in 00-15
minutes. It is valid only when Auto In-Service is supported.
SVTIMER is a string in an HH-MM (00-15...48-00) format.
HH: hour
MM: minute
correction,AFEC/OFF/STDFEC/AUTO/HFEC/SDFEC/SDFEC2
<BEFECSDBER> Indicates the threshold of the signal degraded before FEC alarm. NA
The valid value ranges from 1E-12 to 1E-1
<EXPBANDWIDTH> Indicates the expected receive band's band width at the port. NA
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OCHS::FAC-1-4-3:C::::OOS;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.15.7 RTRV-OCHS
D.6.41 ED-E1PORT
Edits the attributes of the physical E1PORT facility.
Function
This command edits the attributes of the physical E1PORT facility.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-E1PORT:[<TID>]:<AID>:<CTAG>:::[PORTMEMO=<SETPORTMEMO>],
[SVTIMER=<SVTIMER>]:[[<PST>],[<SST>]];
Command Parameters
Default
Parameters Description Value
<SVTIMER> Indicates the signal validation timer; units are expressed in 00-15
minutes. It is valid only when Auto In-Service is supported.
SVTIMER is a string in an HH-MM (00-15...48-00) format.
HH: hour
MM: minute
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
<SST> Indicates the secondary state. The valid values are AINS, SB, NA
and SB-DEA. It can be set to SB if the entity is in OOS-MA;
no outgoing traffic is allowed and incoming traffic is ignored.
When PWRMODE is set to SAVING, the port is in the power-
saving state.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-E1PORT::FAC-1-2-1:D:::PORTMEMO=E1PORT;
Response Message
NE 2014-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.42 RTRV-E1PORT
D.6.42 RTRV-E1PORT
Retrieves the attributes of the physical E1PORT facility.
Function
This command retrieves the attributes of the physical E1PORT facility
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-E1PORT:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],[SILKSCREEN=<SILKSCREEN>],
[SVTIMER=<SVTIMER>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameter Description
<PORTMEMO> Indicates additional information about the optical port. It is a string that
consists of no more than 64 bytes. Usually it is used to identify the port name.
<SILKSCREEN> Indicates the character string silk-screened at the corresponding port on the
front panel.
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is valid
only when Auto In-Service is supported. SVTIMER is a string in an HH-MM
format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PST> Indicates the status of the primary state qualifier. The valid values are IS and
OOS.
Example
Command
RTRV-E1PORT::FAC-1-2-1:D;
Response Message
NE 2013-11-17 08:25:01
M D COMPLD
"FAC-3-17-1::SVTIMER=00-15:IS-NR"
Related Commands
D.6.41 ED-E1PORT
D.6.43 ED-ALL-ATTEN
Configures the attributes of the attenuation.
Function
This command configures the attributes of the attenuation.
Usage Note
None.
Category
Facility
Security
Maintenance
Command Syntax
ED-ALL-ATTEN:[<TID>]:<AID>:<CTAG>:::[WVNUM=<WVNUM>],
[ALLATTEN=<ALLATTEN>]
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-ALL-ATTEN::SLOT-1-3:C::WVNUM=80,ALLATTEN=\"10.1,12.1,13.1\;
Response Message
NE 2011-06-13 08:59:05
M S COMPLD;
Related Commands
D.6.11 RTRV-LEDSTATE
D.7 Configuring RPR
This section lists the commands used to configure rpr.
D.7.1 ED-RPR
Edits the RPR function.
Function
This command edits the RPR function.
Usage Note
None
Category
Equipment
Security
Provisioning
Command Syntax
ED-RPR:[<TID>]:<RPRAID>:<CTAG>::[NODEID=<RPRNODEID>],
[NODENAME=<NODENAME>],[RPRENABLE=<RPRENABLE>],
[R0RATEA=<R0RATEA>],[R0RATEA0=<R0RATEA0>],
[R0RATEBCIR=<R0RATEBCIR>],[R0LINKWEIGHT=<R0LINKWEIGHT>],
[R1RATEA=<R1RATEA>],[R1RATEA0=<R1RATEA0>],
[R1RATEBCIR=<R1RATEBCIR>],[R1LINKWEIGHT=<R1LINKWEIGHT>],
[PROTECTMODE=<PROTECTMODE>],[RESTOREMODE=<RESTOREMODE>],
[HOLDOFFTIME=<HOLDOFFTIME>],[WTRTIME=<WTRTIME>],
[SLOWTIME=<SLOWTIME>],[ATDTIME=<ATDTIME>];
Command Parameters
<NODEID> Indicates the NODE ID. The valid values are 0,and 0
1.
<SLOWTIME> indicates the RPR slow time. The valid value is 100
from 100 to 1000.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-RPR::RPR-5-
1:100:::NODEID=1,NODENAME=HWRPR,RPRENABLE=Y,R0RATEA=200,R0RATEA0=100,R0RATE
BCIR=100,R0LINKWEIGHT=1,R1RATEA=200,R1RATEA0=100,R1RATEBCIR=100,R1LINKWEIGH
T=1,PROTECTMODE=STEERING,RESTOREMODE=Y,HOLDOFFTIME=0,WTRTIME=10,SLOWTIME=10
00,ATDTIME=1;
Response Message
NE 2014-06-23 11:37:18
M 100 COMPLD
;
Related Commands
D.26.2 RTRV-LPT
D.7.2 OPR-PROTNSW-RPR
Performs the RPR protection switching.
Function
Performs the RPR protection switching.
Usage Note
None
Category
PROTNSW
Security
Maintenance
Command Syntax
OPR-PROTNSW-RPR:
[<TID>]:<RPRAID>:<CTAG>::<RPRSWITCH>:RPRSIDE<RPRSIDE>;
Command Parameters
<RPRSIDE> Indicates the RPR protect switch side. The valid values are 1,and NA
2.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
OPR-PROTNSW-RPR::RPR-5-1:100::MAN:RPRSIDE=EAST;
Response Message
NE 2003-02-29 12:23:50
M 100 COMPLD
;
Related Commands
RLS-PROTNSW-<MOD2>
D.7.3 RLS-PROTNSW-RPR
Releases the RPR protection switching.
Function
This command instructs the NE to release RPR protection switching request that is created by
the external command.
Usage Note
None
Category
PROTNSW
Security
Maintenance
Command Syntax
RLS-PROTNSW-RPR:[<TID>]:<RPRAID>:<CTAG>:::RPRSIDE=<RPRSIDE>;
Command Parameters
<RPRSIDE> Indicates the RPR protect switch side. The valid values are 1,and NA
2.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
RLS-PROTNSW-RPR::RPR-5-1:100:::RPRSIDE=EAST;
Response Message
NE 2003-02-29 12:24:50
M 100 COMPLD
;
Related Commands
OPR-PROTNSW-<MOD2>
D.7.4 RTRV-RPR
Queries the RPR detail information.
Function
This command queries the RPR detail information.
Usage Note
None
Category
equipment
Security
Retrieve
Command Syntax
RTRV-RPR:[<TID>]:<RPRAID>:<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<RPRAID>::
[NODEID=<RPRNODEID>#N\"65535\">],NODENAME=<NODENAME>,RPRENABLE=<RPRENABLE>,
R0RATEA=<R0RATEA>,R0RATEA0=<R0RATEA0>,R0RATEBCIR=<R0RATEBCIR>,R0LINKWEIGHT=
<R0LINKWEIGHT>,R1RATEA=<R1RATEA>,R1RATEA0=<R1RATEA0>,R1RATEBCIR=<R1RATEBCIR
>,R1LINKWEIGHT=<R1LINKWEIGHT>,PROTECTMODE=<PROTECTMODE>,RESTOREMODE=<RESTOR
EMODE>,HOLDOFFTIME=<HOLDOFFTIME>,WTRTIME=<WTRTIME>,SLOWTIME=<SLOWTIME>,ATDT
IME=<ATDTIME>";
Response Parameters
Parameters Description
Command
RTRV-RPR::RPR-5-1:100;
Response Message
NE 2011-11-07 11:55:04 M C COMPLD "RPR-5-
1:100:::NODEID=1,NODENAME=HWRPR,RPRENABLE=Y,R0RATEA=200,R0RATEA0=100,R0RATE
BCIR=100,R0LINKWEIGHT=1,R1RATEA=200,R1RATEA0=100,R1RATEBCIR=100,R1LINKWEIGH
T=1,PROTECTMODE=STEERING,RESTOREMODE=Y,HOLDOFFTIME=0,WTRTIME=10,SLOWTIME=10
00,ATDTIME=1" ;
Related Commands
None
D.7.5 RTRV-TOPO-RPR
Queries the RPR topo detail information.
Function
This command queries the RPR topo detail information.
Usage Note
None
Category
equipment
Security
Retrieve
Command Syntax
RTRV-TOPO-RPR:[<TID>]:<RPRAID>:<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"<RPRAID>::NODEID=<RPRNODEID>,NODENAME=<NODENAME>,R0HOPNUM=<R0HOPNUM>,R1
HOPNUM=<R1HOPNUM>,PROTECTMODE=<PROTECTMODE>,EASTADJACENTNODE=<EASTADJACENTN
ODE>,WESTADJACENTNODE=<WESTADJACENTNODE>,EASTPROTECTSTATE=<EASTPROTECTSTATE
>,WESTPROTECTSTATE=<WESTPROTECTSTATE>,EASTSWITCHSTATE=<EASTSWITCHSTATE>,WES
TSWITCHSTATE=<WESTSWITCHSTATE>,EASTRESERVEDA0=<EASTRESERVEDA0>,WESTRESERVED
A0=<WESTRESERVEDA0>,EASTLINKWEIGHT=<EASTLINKWEIGHT>,WESTLINKWEIGHT=<WESTLIN
KWEIGHT>,R0ARRIVEABLE=<R0ARRIVEABLE>,R1ARRIVEABLE=<R1ARRIVEABLE>,SERVICEDIR
=<SERVICEDIR>";
Response Parameters
Parameters Description
Example
Command
RTRV-TOPO-RPR::RPR-5-1:100;
Response Message
NE 2011-11-07 11:55:04 M C COMPLD "RPR-5-
1:100:::NODEID=1,NODENAME=HWRPR,R0HOPNUM=1,R1HOPNUM=1,PROTECTMODE=1,EASTADJ
ACENTNODE=1,WESTADJACENTNODE=1,EASTPROTECTSTATE=1,WESTPROTECTSTATE=1,EASTSW
ITCHSTATE=1,WESTSWITCHSTATE=1,EASTRESERVEDA0=2,WESTRESERVEDA0=2,EASTLINKWEI
GHT=1,WESTLINKWEIGHT=1,R0ARRIVEABLE=1,R1ARRIVEABLE=1,SERVICEDIR=1" ;
Related Commands
None
D.7.6 RTRV-TP-RPR
Queries the RPR topo detail information.
Function
This command queries the RPR topo detail information.
Usage Note
None
Category
equipment
Security
Retrieve
Command Syntax
RTRV-TP-RPR:[<TID>]:<RPRAID>:<CTAG>:::
[RPRSIDE=<RPRSIDE#N\"ALL\"$\"ALL\">];
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"<RPRAID>::RPRSIDE=<RPRSIDE>,PROTECTSTATE=<PROTECTSTATE>,SWITCHSTATE=<SW
ITCHSTATE>,PROTECTCOUNT=<PROTECTCOUNT>,PROTECTTIME=<PROTECTTIME>,LASTREQUES
T=<LASTREQUEST>";
Response Parameters
Parameters Description
Command
RTRV-TP-RPR::RPR-5-1:100:::RPRSIDE=EAST;
Response Message
NE 2011-11-07 11:55:04 M C COMPLD "RPR-5-
1:100::RPRSIDE=1,PROTECTSTATE=1,SWITCHSTATE=1,PROTECTCOUNT=1,PROTECTTIME=1,
LASTREQUEST=1" ;
Related Commands
None
D.8 Configuring Fiber
This section lists the commands used to configure and retrieve logical fiber connections
between NEs.
D.8.1 ENT-FIBER
Creates a logical fiber connection.
Function
This command creates a logical fiber connection between cards. The fiber connection is
directional
Usage Note
The source or sink port must be on the local NE.
Category
Facility
Security
Provisioning
Command Syntax
ENT-FIBER:[<TID>]:<SRCPORT>,<DSTPORT>:<CTAG>:::[SRCTID=<SRCTID>,]
[DSTTID=<DSTTID>];
Command Parameters
Parameters Description Default Value
<SRCPORT> Indicates the source port from which the fiber is connected. NA
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>.
Parameters Description Default Value
<SRCTID> Indicates the source TID of the NE from which the fiber is NA
connected. If nothing is entered for this parameter, it
indicates that the source NE of the fiber connection to be
created is the local NE.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
Example
Command
ENT-FIBER::FAC-1-13-1,FAC-1-13-1:C:::SRCTID=NE23,DSTTID=NE26;
Response Message
NE714 2009-09-21 10:58:17
M C COMPLD
Related Commands
D.8.2 DLT-FIBER
D.8.3 RTRV-FIBER
D.8.2 DLT-FIBER
Deletes a logical fiber connection.
Function
This command deletes a logical fiber connection between cards. The fiber connection is
directional.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
DLT-FIBER:[<TID>]:<SRCPORT>,<DSTPORT>:<CTAG>:::[SRCTID=<SRCTID>,]
[DSTTID=<DSTTID>];
Command Parameters
Parameters Description Default Value
<SRCPORT> Indicates the source port from which the fiber is connected. NA
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>.
For the valid values of specific units, refer to FIBER.
<SRCTID> Indicates the source TID of the NE from which the fiber is NA
connected. If nothing is entered for this parameter, it indicates
that the source NE of the fiber connection to be deleted is the
local NE.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
Example
Command
DLT-FIBER::FAC-3-9-1,FAC-2-11-1:C:::SRCTID=NE1,DSTTID=NE2;
Response Message
NE714 2009-09-21 10:58:29
M C COMPLD
;
Related Commands
D.8.1 ENT-FIBER
D.8.3 RTRV-FIBER
D.8.3 RTRV-FIBER
Retrieves information about the logical fiber connection.
Function
This command retrieves information about the logical fiber connection.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-FIBER:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameters Description Default Value
AID Indicates the access identifier. The valid format is FAC- ALL
<SHELF ID>-<SLOT ID>-<PORT ID>.
This parameter can be set to ALL. <PORT ID> can be ALL
to retrieve information about all fiber connections to FAC-
<SHELF ID>-<SLOT ID>.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"<SRCPORT>,<DSTPORT>::SRCTID=<SRCTID>,DSTTID=<DSTTID>;" ;
Response Parameters
Parameters Description
<SRCPORT> Indicates the source port from which the fiber is connected.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
Parameters Description
<SRCTID> Indicates the source TID of the NE from which the fiber is connected.
<DSTTID> Indicates the destination TID of the NE to which the fiber is connected.
Example
Command
RTRV-FIBER:::C;
Response Message
NE714 2009-09-21 10:58:27 M C COMPLD "FAC-2-3-1,FAC-3-2-
1::SRCTID=NE1,DSTTID=NE2" ;
Related Commands
D.8.2 DLT-FIBER
D.8.1 ENT-FIBER
D.8.4 ENT-WMU-CONN
Creates the monitoring mapping for the wavelengths between the WMU and OTU.
Function
This command creates the monitoring mapping for the wavelengths between the WMU and
OTU.
Users need to create monitoring mapping for the wavelengths between the WMU and OTU
by running this command when logical connections between the WMU and OTU cannot be
learnt based on the existing fiber connection configuration (for example, no fiber connections
are created or inter-NE fiber connections exist).
When the NE can determine the logical connections between the WMU and OTU, it neglects
the monitoring mapping for the wavelengths between the WMU and OTU created by users.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ENT-WMU-CONN:[<TID>]:<WMUPORT>,<OTUPORT>:<CTAG>:::
[OTUNE=<OTUNE>];
Command Parameters
<OTUNE> Indicates the name of the TID of the NE where the OTU NA
is located. If nothing is entered for this parameter, it
indicates that the NE where the OTU is located is the
local NE.
The valid value is a string of less than or equal to 20
characters which is composed of letters, digits and
hyphens. The string should begin with a letter and
cannot end with a hyphen.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-WMU-CONN::FAC-2-3-1,FAC-1-2-1:C:::OTUNE=NE01
Response Message
NE 1990-01-01 15:00:00
M C COMPLD
;
Related Commands
D.8.5 DLT-WMU-CONN
D.8.6 RTRV-WMU-CONN
D.8.5 DLT-WMU-CONN
Deletes a monitoring mapping for the wavelengths between the WMU and OTU.
Function
This command deletes a monitoring mapping for the wavelengths between the WMU and
OTU.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
DLT-WMU-CONN:[<TID>]:<WMUPORT>,<OTUPORT>:<CTAG>:::
[OTUNE=<OTUNE>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-WMU-CONN::FAC-2-3-1,FAC-1-2-1:C
Response Message
NE 1990-01-01 15:00:00
M C COMPLD
;
Related Commands
D.8.4 ENT-WMU-CONN
D.8.6 RTRV-WMU-CONN
D.8.6 RTRV-WMU-CONN
Retrieves the monitoring mapping for the wavelengths between the WMU and the OTU.
Function
This command retrieves the monitoring mapping for the wavelengths between the WMU and
the OTU.
If a port number of the WMU is entered in the command, the system retrieves all the
monitoring mapping for the wavelengths between the port on the WMU and the
ports/channels on the OTU and returns the values in separate records.
If a port/channel number is entered in the command, the system retrieves the monitoring
mapping for the wavelengths between the port/channel on the OTU and the corresponding
port on the WMU.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-WMU-CONN:<TID>:[<AID>]:<CTAG>:::[OTUNE=<OTUNE>];
Command Parameters
Parameter Description Default Value
<OTUNE> Indicates the name of the TID of the NE where the OTU is NA
located. If nothing is entered for this parameter, it indicates
that the NE where the OTU is located is the local NE.
The valid value is a string of less than or equal to 20
characters, which is composed of letters, digits and
hyphens. The string should begin with a letter and cannot
end with a hyphen.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<WMUPORT>,<OTUPORT>:::OTUNE=<OTUNE>" <cr><If>)
;
Response Parameters
Parameter Description
<OTUNE> Indicates the name of the TID of the NE where the OTU is
located.
The valid value is a string of less than or equal to 20 characters,
which is composed of letters, digits and hyphens. The string
should begin with a letter and cannot end with a hyphen.
Example
Command
RTRV-WMU-CONN::FAC-2-2-1:C
Response Message
NE 2005-01-01 01:01:00
M C COMPLD
"FAC-2-2-1,FAC-3-2-1:::OTUNE=NE-8;"
;
Related Commands
D.8.4 ENT-WMU-CONN
D.8.5 DLT-WMU-CONN
D.9 Configuring Cross-Connections
This section lists the commands used to configure cross-connections.
D.9.1 Configuring OXC
This section lists the commands used to configure an OXC.
ENT-PXC-OCH
Creates a cross-connection (OCH).
Function
This command creates an OCH layer cross-connection.
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
ENT-PXC-OCH:[<TID>]:<FROM>,<TO>:<CTAG>::[<CCT>],[<CRSTYPE>]:
[BANDTYPE=<BANDTYPE>,][CNTRFREQ=<CNTRFREQ>,]
[BANDWIDTH=<BANDWIDTH>,][WVNUM=<WVNUM>,]
[OPAMODE=<OPAMODE>,][CONSTR=<CONSTR>,][CKTID=<CKTID>]:,[<SST>];
Command Parameters
Parameter Description Default Value
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
<CNTRFREQ> Indicates the center frequency, such as 192.10625THz. NULL
<BANDWIDTH> Indicates the bandwidth, such as 37.5GHz. NULL
<WVNUM> Indicates the number of the wavelength channels. NA
<OPAMODE> Indicates the optical power adjustment mode. The valid AUTO
values are MAN and AUTO.
NOTE:
This parameter can be empty when CRSTYPE is set to
INTRA.
<CONSTR> Specifies one or more constraint ports. If more than one NULL
constraint port exists, separate them with the mark (&).
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<SST> Indicates the red-lined state. The valid values are shown RDLD-DEA
in section SST_STATE.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-PXC-OCH::FAC-1-1-1,FAC-1-4-1:C::2WAY,E2E:WVNUM=1,CKTID=A1:,RDLD;
ENT-PXC-OCH::FAC-1-1-1,FAC-1-4-
1:C::1WAY,E2E:CNTRFREQ=195.75625THz,BANDWIDTH=37.5GHz,OPAMODE=MAN,CKTID=A1:
,RDLD;
Response Message
NE 2008-03-04 15:23:20 M 100 COMPLD ;
Related Commands
DLT-PXC-OCH
ED-PXC-OCH
RTRV-PXC-OCH
ED-PXC-OCH
Edits a cross-connection (OCH).
Function
This command modifies an OCH layer cross-connection.
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
ED-PXC-OCH:[<TID>]:<FROM>,<TO>:<CTAG>:::[BANDTYPE=<BANDTYPE>,]
[WVNUM=<WVNUM>,][SRCCNTRFREQ=<SRCCNTRFREQ>,]
[DSTBANDTYPE=<DSTBANDTYPE>,][DSTWVNUM=<DSTWVNUM>,]
[DSTCNTRFREQ=<DSTCNTRFREQ>,][OPAMODE=<OPAMODE>,]
[CKTID=<CKTID>]:,[<SST>];
Command Parameters
Parameters Description Default Value
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-PXC-OCH::FAC-1-1-1,FAC-1-4-1:C:::WVNUM=1,CKTID=A1:,RDLD;
ED-PXC-OCH::FAC-1-1-1,FAC-1-4-
1:C:::SRCCNTRFREQ=195.75625THz,OPAMODE=AUTO,CKTID=A1:,RDLD;
Response Message
NE 2008-09-04 15:23:20 M 100 COMPLD ;
Related Commands
DLT-PXC-OCH
ENT-PXC-OCH
RTRV-PXC-OCH
DLT-PXC-OCH
Deletes a cross-connection (OCH).
Function
This command deletes an OCH layer cross-connection.
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
DLT-PXC-OCH:[<TID>]:<FROM>,<TO>:<CTAG>::[<CRSTYPE>]:
[BANDTYPE=<BANDTYPE,>][WVNUM=<WVNUM>,]
[SRCCNTRFREQ=<SRCCNTRFREQ>,][DSTBANDTYPE=<DSTBANDTYPE>,]
[DSTWVNUM=<DSTWVNUM>,][DSTCNTRFREQ=<DSTCNTRFREQ>,]
[INCL=<INCL>];
Command Parameters
Parameters Description Default Value
<BANDTYPE> Indicates the type of the wavelength band. The default CBAND
and only available value for this parameter is CBAND.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-PXC-OCH:FAC-1-1-1,FAC-1-4-1:100::WVNUM=1,INCL=Y;
DLT-PXC-OCH::FAC-1-1-1,FAC-1-4-1:100::E2E:SRCCNTRFREQ=195.75625THz,INCL=Y;
Response Message
NE 2008-03-04 15:23:20 M 100 COMPLD ;
Related Commands
ENT-PXC-OCH
ED-PXC-OCH
RTRV-PXC-OCH
RTRV-PXC-OCH
Retrieves information on a cross-connection (OCH).
Function
This command retrieves the information on an OCH layer cross-connection.
Usage Note
None
Category
Cross-connection
Security
Retrieve
Command Syntax
RTRV-PXC-OCH:[<TID>]:[<AID>]:<CTAG>:::[BANDTYPE=<BANDTYPE>,]
[WVNUM=<WVNUM>,][SRCCNTRFREQ=<SRCCNTRFREQ>,]
[DSTBANDTYPE=<DSTBANDTYPE>,][DSTWVNUM=<DSTWVNUM>,]
[DSTCNTRFREQ=<DSTCNTRFREQ>];
Command Parameters
Parameters Description Default Value
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>:<CCT>,<CRSTYPE>:BANDTYPE=<BANDTYPE>,WVNUM=<WVNUM>,SRCCNTRFREQ
=<SRCCNTRFREQ>,SRCBANDWIDTH=<SRCBANDWIDTH>,
[DSTBANDTYPE=<DSTBANDTYPE>,DSTWVNUM=<DSTWVNUM>,DSTCNTRFREQ=<DSTCNTRFREQ>,DS
TBANDWIDTH=<DSTBANDWIDTH>],OPAMODE=<OPAMODE>,WV=<WV>,
[DSTWV=<DSTWV>],CKTID=<CKTID>:,<SST>" <cr><lf>)+ ;
Response Parameters
Parameters Description
<CCT> Indicates the type of the cross-connection. The valid values are as
follows:
2WAY: indicates that the cross-connection is bidirectional.
1WAY: indicates that the cross-connection is unidirectional.
<CRSTYPE> Indicates the cross-connection type. The valid values are as follows:
E2E: indicates that the cross-connection is end-to-end.
INTRA: indicates that the cross-connection is only within a
unit.
<BANDTYPE> Indicates the type of the wave band. The default and only available
value for this parameter is CBAND.
<WV> Indicates the wavelength information of the optical channel. The valid
format is frequency/wavelength: xxxxTHz/xxxnm.
Example
Command
RTRV-PXC-OCH:::c;
Response Message
NE 2009-01-16 08:21:44 M C COMPLD "FAC-2-10-1,FAC-2-10-
4:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=4,
DSTBANDTYPE=CBAND,DSTWVNUM=78,WV=195.90THz/1530.33nm,
DSTWV=192.20THz/1559.79nm "
"FAC-2-14-1,FAC-2-1-1:1WAY,E2E:BANDTYPE=CBAND,WVNUM=78,
DSTBANDTYPE=CBAND,DSTWVNUM=2,OPAMODE=AUTO,WV=192.20THz/1559.79nm,
DSTWV=196.00THz/1529.55nm " ;
Related Commands
DLT-PXC-OCH
ED-PXC-OCH
ENT-PXC-OCH
RTRV-PXCINFO-OCH
Retrieves information on a cross-connection information (OCH).
Function
This command queries the sub-cross-connections in an end-to-end optical cross-connection.
Usage Note
None
Category
Cross connection
Security
Retrieve
Command Syntax
RTRV-PXCINFO-OCH:[<TID>]:<FROM>,<TO>:<CTAG>:::
[BANDTYPE=<BANDTYPE>,][WVNUM=<WVNUM>,]
[SRCCNTRFREQ=<SRCCNTRFREQ>,][DSTBANDTYPE=<DSTBANDTYPE>,]
[DSTWVNUM=<DSTWVNUM>,][DSTCNTRFREQ=<DSTCNTRFREQ>];
Command Parameters
Parameters Description Default Value
<FROM> Indicates the slot number and port number of the source NA
units.
Parameters Description Default Value
<TO> Indicates the slot number and port number of the sink NA
units.
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>:<CCT>,<CRSTYPE>:BANDTYPE=<BANDTYPE>,WVNUM=<WVNUM>,
[DSTBANDTYPE=<DSTBANDTYPE>,DSTWVNUM=<DSTWVNUM>];" <cr><lf>)+ ;
Response Parameters
Parameters Description
<CCT> Indicates the type of the cross-connection. The valid values are 2WAY
and 1WAY.
<CRSTYPE> Indicates the cross-connection type. The values are E2E and INTRA.
INTRA is the only valid cross-connection type for this scenario.
<BANDTYPE> Indicates the type of the wave band. The default and only available
value for this parameter is CBAND.
Example
Command
RTRV-PXCINFO-OCH::FAC-2-14-1,FAC-2-1-1:C:::wvnum=78;
RTRV-PXCINFO-OCH::FAC-1-1-1,FAC-1-14-1:C:::SRCCNTRFREQ=192.10625THz;
Response Message
NE 2009-01-16 08:23:19 M C COMPLD "FAC-2-16-1,FAC-2-16-
4:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-15-1,FAC-2-15-
2:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-10-1,FAC-2-10-
8:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-13-8,FAC-2-13-
11:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-13-11,FAC-2-13-
2:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-3-1,FAC-2-3-
5:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-3-5,FAC-2-3-
4:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" "FAC-2-1-3,FAC-2-1-
1:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=78" ;
Related Commands
RTRV-PXC-OCH
RTRV-PXC-WASTAGE
Queries the line insertion loss that is set.
Function
This command queries the line insertion loss that is set.
Usage Note
None
Category
Cross-connection
Security
Retrieve
Command Syntax
RTRV-PXC-WASTAGE:[<TID>]::<CTAG>:::LOCAID=<LOCAID>,
[SRCNE=<SRCNE>],[DSTNE=<DSTNE>],[OTHAID=<OTHAID>],
[PXCDATA=<PXCDATA>];
Command Parameters
Parameters Description Default Value
<LOCAID> Indicates the optical port number of the local NE for which NA
the insertion loss is set.
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<SRCNE> Indicates the name of the TID of the NE where the source NA
OCh is located
<DSTNE> Indicates the name of the TID of the NE where the sink NA
OCh is located
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("LOCAID=<LOCAID>,
[SRCNE=<SRCNE>,DSTNE=<DSTNE>],OTHAID=<OTHAID>,PXCDATA=<PXCDATA>" <cr><lf>)+
;
Response Parameters
Parameters Description
<LOCAID> Indicates the optical port number of the local NE for which the insertion
loss is set.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<SRCNE> Indicates the name of the TID of the NE where the source OCh is
located
<DSTNE> Indicates the name of the TID of the NE where the sink OCh is located
Example
Command
RTRV-PXC-WASTAGE:::c;
Response Message
NE 2009-01-16 08:21:44 M C COMPLD "FAC-2-10-1,FAC-2-10-
4:1WAY,INTRA:BANDTYPE=CBAND,WVNUM=4,
DSTBANDTYPE=CBAND,DSTWVNUM=78,WV=195.90THz/1530.33nm,
DSTWV=192.20THz/1559.79nm "
"FAC-2-14-1,FAC-2-1-1:1WAY,E2E:BANDTYPE=CBAND,WVNUM=78,
DSTBANDTYPE=CBAND,DSTWVNUM=2,OPAMODE=AUTO,WV=192.20THz/1559.79nm,
DSTWV=196.00THz/1529.55nm " ;
Related Commands
DLT-PXC-WASTAGE
ED-PXC-WASTAGE
DLT-PXC-WASTAGE
Deletes the insertion loss.
Function
This command deletes the insertion loss.
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
RTRV-PXC-WASTAGE:[<TID>]::<CTAG>:::LOCAID=<LOCAID>,
[SRCNE=<SRCNE>],[DSTNE=<DSTNE>],[OTHAID=<OTHAID>],
[PXCDATA=<PXCDATA>];
Command Parameters
Parameters Description Default Value
<SRCNE> Indicates the name of the TID of the NE where the source NA
OCH is located
<DSTNE> Indicates the name of the TID of the NE where the sink NA
OCH is located
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-PXC-WASTAGE:::C:::LOCAID=FAC-1-1-1&FAC-1-3-1&FAC-1-5-
1,SRCNE=NE2,OTHAID=FAC-1-2-1,PXCDATA=\"WVTOTAL=1,WVNUM=4;
Response Message
NE 2008-03-04 15:23:20 M 100 COMPLD ;
Related Commands
ED-PXC-WASTAGE
RTRV-PXC-WASTAGE
ED-PXC-WASTAGE
Sets the insertion loss.
Function
This command sets the insertion loss.
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
ED-PXC-WASTAGE:[<TID>]::<CTAG>:::LOCAID=<LOCAID>,[SRCNE=<SRCNE>],
[DSTNE=<DSTNE>],[OTHAID=<OTHAID>],[PXCDATA=<PXCDATA>];
Command Parameters
Parameters Description Default Value
<LOCAID> Indicates the optical port number of the local NE for which NA
the insertion loss is set.
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<SRCNE> Indicates the name of the TID of the NE where the source NA
OCh is located
<DSTNE> Indicates the name of the TID of the NE where the sink NA
OCh is located
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-PXC-WASTAGE:::C:::LOCAID=FAC-1-1-1&FAC-1-3-1&FAC-1-5-
1,SRCNE=NE2,OTHAID=FAC-1-2-1,PXCDATA=\"WVTOTAL=1,WVNUM=4,WASTAGE=3;
Response Message
NE 2008-09-04 15:23:20 M 100 COMPLD ;
Related Commands
DLT-PXC-WASTAGE
RTRV-PXC-WASTAGE
ED-OXC-NEPORT
Edits the edge port of an NE.
Function
When creating an end-to-end optical cross-connection, users must run this command at the
source and sink interfaces of all units except the OTU and the FIU unit.
Usage Note
None
Category
Cross Connection
Security
Provisioning
Command Syntax
ED-OXC-NEPORT:[<TID>]:<AID>:CTAG:::[IN=<IN>],[OUT=<OUT>],
[MARK=<MARK>];
Command Parameters
<IN> Indicates the attribute of the input edge port. The valid ENABLE
values are ENABLE and DISABLE.
This parameter must be set to ENABLE if the AID port
is the source interface when users create an end-to-end
optical cross-connection.
<OUT> Indicates the attribute of the output edge port. The valid ENABLE
values are ENABLE and DISABLE.
This parameter must be set to ENABLE if the AID port
is the sink interface when users create an end-to-end
optical cross-connection.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OXC-NEPORT::FAC-1-3-1:C:::IN=ENABLE,OUT=DISABLE;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-OXC-NEPORT
RTRV-OXC-NEPORT
Retrieves the edge port of an NE.
Function
This command instructs the NE to retrieve the edge port status of the optical cross-
connection.
Usage Note
The optical interface will not be displayed if the attribute of the edge ports IN and OUT are
on the same optical interface.
Category
Cross Connection
Security
Retrieve
Command Syntax
RTRV-OXC-NEPORT:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::IN=<IN>,OUT=<OUT>,[MARK=<MARK>];"<cr><lf>
;
Response Parameters
Parameter Description
<IN> Indicates the attribute of the edge port IN. The valid values are ENABLE
and DISABLE.
<OUT> Indicates the attribute of the edge port OUT. The valid values are ENABLE
and DISABLE.
<MARK> Indicates the memo information of the protection group. It is a string with
no more than 64 characters.
Example
Command
RTRV-OXC-NEPORT:::C
RTRV-OXC-NEPORT::FAC-1-3-ALL:C
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
"FAC-1-3-1::IN=ENABLE,OUT=DISABLE"
;
Related Commands
ED-OXC-NEPORT
RTRV-OCCUP-WAVE
Queries reserved wavelength resources at the optical layer.
Function
This command queries the wavelength resources reserved for ASON services. In scenarios
with a revertive ASON service, the original trail or wavelength is reserved for restoration
when the service is rerouted. The reserved wavelength cannot be used to carry a static
service.
Usage Note
None
Category
Cross-connection
Security
Retrieve
Command Syntax
RTRV-OCCUP-WAVE:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::BANDTYPE=<BANDTYPE>,WV=<WV>,OCCUP=<OCCUP>"<cr><lf>)+
;
Response Parameters
Parameter Description
<AID> Indicates the number of a reserved wavelength at the specified port on the
FIU. The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>-
<CHANNEL ID>.
<BANDTYPE> Indicates the band of the port. The valid values is CBAND.
<WV> Indicates the information about the wavelength specified by <AID>. The
valid format is frequency/wavelength: xxxxTHz/xxxnm.
<OCCUP> Indicates whether the wavelength is reserved by ASON. The valid values are
Y and N.
Y: indicates that the wavelength is reserved.
N: indicates that the wavelength is not reserved.
Example
Command
RTRV-OCCUP-WAVE::FAC-1-8-1:C;
Response Message
NE 2009-11-11 20:37:10
M C COMPLD
"FAC-1-8-1-1::BANDTYPE=CBAND,WV=196.05THz/1529.16nm,OCCUP=Y"
;
Related Commands
None
ENT-PXC-OCHM
Creates a cross-connection (OCHM).
Function
This command creates an OCHM layer cross-connection.
Usage Note
None.
Category
Cross-connection
Security
Provisioning
Command Syntax
ENT-PXC-OCHM:[<TID>]:<FROM>,<TO>:<CTAG>::[<CCT>],[<CRSTYPE>]:
[BANDTYPE=<BANDTYPE>,]CNTRFREQ1=<CNTRFREQ1>,BANDWIDTH1=<BAND
WIDTH1>,[CNTRFREQ2=<CNTRFREQ2>,][BANDWIDTH2=<BANDWIDTH2>,]
[CNTRFREQ3=<CNTRFREQ3>,][BANDWIDTH3=<BANDWIDTH3>,]
[CNTRFREQ4=<CNTRFREQ4>,][BANDWIDTH4=<BANDWIDTH4>,]
[OPAMODE=<OPAMODE>,][CONSTR=<CONSTR>,][CKTID=<CKTID>]:,[<SST>];
Command Parameters
Parameter Description Default Value
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
<CNTRFREQ1> Indicates the center frequency of the 1st wave, such as NULL
196.0THz.
<BANDWIDTH1> Indicates the band width of the 1st wave, such as NULL
50.0GHz.
<CNTRFREQ2> Indicates the center frequency of the 2nd wave, such as NULL
196.0THz.
<BANDWIDTH2> Indicates the band width of the 2nd wave, such as NULL
50.0GHz.
<CNTRFREQ3> Indicates the center frequency of the 3rd wave, such as NULL
196.0THz.
<BANDWIDTH3> Indicates the band width of the 3rd wave, such as NULL
50.0GHz.
<CNTRFREQ4> Indicates the center frequency of the 4th wave, such as NULL
196.0THz.
<BANDWIDTH4> Indicates the band width of the 4th wave, such as NULL
50.0GHz.
<OPAMODE> Indicates the optical power adjustment mode. The valid AUTO
values are MAN and AUTO.
<CONSTR> Specifies one or more constraint ports. If more than one NULL
constraint port exists, separate them with the mark (&).
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<SST> Indicates the red-lined state. The valid values are RDLD-DEA
shown in section SST_STATE.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-PXC-OCHM::FAC-2-2-1,FAC-2-7-
1:C::1WAY,E2E:CNTRFREQ1=196.00THz,BANDWIDTH1=50.0GHz,CNTRFREQ2=195.90THz,BA
NDWIDTH2=50.0GHz,CNTRFREQ3=195.80THz,BANDWIDTH3=50.0GHz,CNTRFREQ4=195.70THz
,BANDWIDTH4=50.0GHz,OPAMODE=MAN,CKTID=A1:,RDLD;
Response Message
NE 2014-06-18 16:34:32 M 100 COMPLD ;
Related Commands
DLT-PXC-OCHM
ED-PXC-OCHM
RTRV-PXC-OCHM
ED-PXC-OCHM
Edits a cross-connection (OCHM).
Function
This command modifies an OCHM layer cross-connection.
Usage Note
None.
Category
Cross-connection
Security
Provisioning
Command Syntax
ED-PXC-OCHM:[<TID>]:<FROM>,<TO>:<CTAG>:::[BANDTYPE=<BANDTYPE>,]
[SRCCNTRFREQ=<SRCCNTRFREQ>,][DSTBANDTYPE=<DSTBANDTYPE>,]
[DSTCNTRFREQ=<DSTCNTRFREQ>,][OPAMODE=<OPAMODE>,]
[CKTID=<CKTID>]:,[<SST>];
Command Parameters
Parameters Description Default Value
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-PXC-OCHM::FAC-2-2-1,FAC-2-7-
1:C:::SRCCNTRFREQ=196.0THz,OPAMODE=MAN,CKTID=A2:,RDLD;
Response Message
NE 2014-06-18 19:52:50 M 100 COMPLD ;
Related Commands
DLT-PXC-OCHM
ENT-PXC-OCHM
RTRV-PXC-OCHM
RTRV-PXC-OCHM
Retrieves information on a cross-connection (OCHM).
Function
This command retrieves the information on an OCHM layer cross-connection.
Usage Note
None
Category
Cross-connection
Security
Retrieve
Command Syntax
RTRV-PXC-OCHM:[<TID>]:[<AID>]:<CTAG>:::[BANDTYPE=<BANDTYPE>,]
[SRCCNTRFREQ=<SRCCNTRFREQ>,][DSTBANDTYPE=<DSTBANDTYPE>,]
[DSTCNTRFREQ=<DSTCNTRFREQ>];
Command Parameters
Parameters Description Default Value
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
<SRCCNTRFREQ> Indicates the center frequency of the source 1st wave, NULL
such as such as 196.0THz.
<DSTBANDTYPE> Indicates the type of the band to which the sink CBAND
wavelength belongs.
<DSTCNTRFREQ> Indicates the center frequency of the destination 1st NULL
wave, such as such as 196.0THz.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>:<CCT>,<CRSTYPE>:BANDTYPE=<BANDTYPE>,SRCCNTRFREQ1=<SRCCNTRFREQ
1>,SRCBANDWIDTH1=<SRCBANDWIDTH1>,SRCCNTRFREQ2=<SRCCNTRFREQ2>,SRCBANDWIDTH2=
<SRCBANDWIDTH2>,SRCCNTRFREQ3=<SRCCNTRFREQ3>,SRCBANDWIDTH3=<SRCBANDWIDTH3>,S
RCCNTRFREQ4=<SRCCNTRFREQ4>,SRCBANDWIDTH4=<SRCBANDWIDTH4>,
[DSTBANDTYPE=<DSTBANDTYPE>,DSTCNTRFREQ1=<DSTCNTRFREQ1>,DSTBANDWIDTH1=<DSTBA
NDWIDTH1>,DSTCNTRFREQ2=<DSTCNTRFREQ2>,DSTBANDWIDTH2=<DSTBANDWIDTH2>,DSTCNTR
FREQ3=<DSTCNTRFREQ3>,DSTBANDWIDTH3=<DSTBANDWIDTH3>,DSTCNTRFREQ4=<SRCCNTRFRE
Q4>,DSTBANDWIDTH4=<DSTBANDWIDTH4>],OPAMODE=<OPAMODE>,CKTID=<CKTID>:,<SST>"
<cr><lf>)+ ;
Response Parameters
Parameters Description
<CCT> Indicates the type of the cross-connection. The valid values are as
follows:
2WAY: indicates that the cross-connection is bidirectional.
1WAY: indicates that the cross-connection is unidirectional.
<CRSTYPE> Indicates the cross-connection type. The valid values are as follows:
E2E: indicates that the cross-connection is end-to-end.
<BANDTYPE> Indicates the type of the wave band. The default and only available
value for this parameter is CBAND.
<SRCCNTRFREQ1> Indicates the center frequency of the source 1st wave, such as
196.0THz.
<SRCBANDWIDTH1> Indicates the band width of the source 1st wave, such as 50.0GHz.
<SRCCNTRFREQ2> Indicates the center frequency of the source 2nd wave, such as
196.0THz.
<SRCBANDWIDTH2> Indicates the band width of the source 2nd wave, such as 50.0GHz.
<SRCCNTRFREQ3> Indicates the center frequency of the source 3rd wave, such as
196.0THz.
<SRCBANDWIDTH3> Indicates the band width of the source 3rd wave, such as 50.0GHz.
<SRCCNTRFREQ4> Indicates the center frequency of the source 4th wave, such as
196.0THz.
<SRCBANDWIDTH4> Indicates the band width of the source 4th wave, such as 50.0GHz.
<DSTBANDTYPE> Indicates the type of the band to which the destination wave belongs.
<DSTCNTRFREQ1> Indicates the center frequency of the destination 1st wave, such as
196.0THz.
<DSTBANDWIDTH1> Indicates the band width of the destination 1st wave, such as 50.0GHz.
<DSTCNTRFREQ2> Indicates the center frequency of the destination 2nd wave, such as
196.0THz.
<DSTBANDWIDTH2> Indicates the band width of the destination 2nd wave, such as 50.0GHz.
<DSTCNTRFREQ3> Indicates the center frequency of the destination 3rd wave, such as
196.0THz.
<DSTBANDWIDTH3> Indicates the band width of the destination 3rd wave, such as 50.0GHz.
<DSTCNTRFREQ4> Indicates the center frequency of the destination 4th wave, such as
196.0THz.
<DSTBANDWIDTH4> Indicates the band width of the destination 4th wave, such as 50.0GHz.
Parameters Description
<OPAMODE> Indicates the optical power adjustment mode. The valid value is either
MAN or AUTO.
NOTE:
This parameter is displayed for E2E type cross-connections.
Example
Command
RTRV-PXC-OCHM:::c;
Response Message
NE 2009-01-16 08:21:44 M C COMPLD "FAC-2-2-1,FAC-2-7-
1:1WAY,E2E:BANDTYPE=CBAND,SRCCNTRFREQ1=196.000000THz,SRCBANDWIDTH1=50.000GH
z,SRCCNTRFREQ2=195.900000THz,SRCBANDWIDTH2=50.000GHz,SRCCNTRFREQ3=195.80000
0THz,SRCBANDWIDTH3=50.000GHz,SRCCNTRFREQ4=195.700000THz,SRCBANDWIDTH4=50.00
0GHz,OPAMODE=MAN,CKTID=\"A1\":,RDLD"
;
Related Commands
DLT-PXC-OCHM
ED-PXC-OCHM
ENT-PXC-OCHM
RTRV-PXCINFO-OCHM
Retrieves information on a cross-connection information (OCHM).
Function
This command queries the sub-cross-connections in an end-to-end optical cross-connection
(OCHM).
Usage Note
None.
Category
Cross connection
Security
Retrieve
Command Syntax
RTRV-PXCINFO-OCHM:[<TID>]:<FROM>,<TO>:<CTAG>:::
[BANDTYPE=<BANDTYPE>,]SRCCNTRFREQ=<SRCCNTRFREQ>,
[DSTBANDTYPE=<DSTBANDTYPE>,][DSTCNTRFREQ=<DSTCNTRFREQ>];
Command Parameters
Parameters Description Default Value
<FROM> Indicates the slot number and port number of the source NA
units.
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<TO> Indicates the slot number and port number of the sink NA
units.
The valid format is FAC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
<BANDTYPE> Indicates the type of the wave band. The default and CBAND
only available value for this parameter is CBAND.
<SRCCNTRFREQ> Indicates the center frequency of the source 1st wave, NULL
such as 196.0THz.
<DSTBANDTYPE> Indicates the type of the band to which the destination CBAND
wave belongs.
<DSTCNTRFREQ> Indicates the center frequency of the destination 1st NULL
wave, such as 196.0THz.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>:<CCT>,<CRSTYPE>:BANDTYPE=<BANDTYPE>,SRCCNTRFREQ1=<SRCCNTRFREQ
1>,SRCBANDWIDTH1=<SRCBANDWIDTH1>,SRCCNTRFREQ2=<SRCCNTRFREQ2>,SRCBANDWIDTH2=
<SRCBANDWIDTH2>,SRCCNTRFREQ3=<SRCCNTRFREQ3>,SRCBANDWIDTH3=<SRCBANDWIDTH3>,S
RCCNTRFREQ4=<SRCCNTRFREQ4>,SRCBANDWIDTH4=<SRCBANDWIDTH4>,
[DSTBANDTYPE=<DSTBANDTYPE>,DSTCNTRFREQ1=<DSTCNTRFREQ1>,DSTBANDWIDTH1=<DSTBA
NDWIDTH1>,DSTCNTRFREQ2=<DSTCNTRFREQ2>,DSTBANDWIDTH2=<DSTBANDWIDTH2>,DSTCNTR
FREQ3=<DSTCNTRFREQ3>,DSTBANDWIDTH3=<DSTBANDWIDTH3>,DSTCNTRFREQ4=<SRCCNTRFRE
Q4>,DSTBANDWIDTH4=<DSTBANDWIDTH4>];" <cr><lf>)+ ;
Response Parameters
Parameters Description
<CCT> Indicates the type of the cross-connection. The valid values are 2WAY
and 1WAY.
<CRSTYPE> Indicates the cross-connection type. The values are E2E and INTRA.
INTRA is the only valid cross-connection type for this scenario.
<BANDTYPE> Indicates the type of the wave band. The default and only available
value for this parameter is CBAND.
<SRCCNTRFREQ1> Indicates the center frequency of the source 1st wave, such as
196.0THz.
<SRCBANDWIDTH1> Indicates the band width of the source 1st wave, such as 50.0GHz.
<SRCCNTRFREQ2> Indicates the center frequency of the source 2nd wave, such as
196.0THz.
<SRCBANDWIDTH2> Indicates the band width of the source 2nd wave, such as 50.0GHz.
<SRCCNTRFREQ3> Indicates the center frequency of the source 3rd wave, such as
196.0THz.
<SRCBANDWIDTH3> Indicates the band width of the source 3rd wave, such as 50.0GHz.
<SRCCNTRFREQ4> Indicates the center frequency of the source 4th wave, such as
196.0THz.
<SRCBANDWIDTH4> Indicates the band width of the source 4th wave, such as 50.0GHz.
<DSTBANDTYPE> Indicates the type of the band to which the destination wave belongs.
<DSTCNTRFREQ1> Indicates the center frequency of the destination 1st wave, such as
196.0THz.
<DSTBANDWIDTH1> Indicates the band width of the destination 1st wave, such as 50.0GHz.
<DSTCNTRFREQ2> Indicates the center frequency of the destination 2nd wave, such as
196.0THz.
<DSTBANDWIDTH2> Indicates the band width of the destination 2nd wave, such as 50.0GHz.
<DSTCNTRFREQ3> Indicates the center frequency of the destination 3rd wave, such as
196.0THz.
<DSTBANDWIDTH3> Indicates the band width of the destination 3rd wave, such as 50.0GHz.
<DSTCNTRFREQ4> Indicates the center frequency of the destination 4th wave, such as
196.0THz.
<DSTBANDWIDTH4> Indicates the band width of the destination 4th wave, such as 50.0GHz.
Example
Command
RTRV-PXCINFO-OCHM::FAC-2-2-1,FAC-2-7-1:C:::SRCCNTRFREQ=196.0THz;
Response Message
NE 2009-01-16 08:23:19 M C COMPLD "FAC-2-3-2,FAC-2-3-
1:1WAY,INTRA:BANDTYPE=CBAND,SRCCNTRFREQ1=196.000000THz,SRCBANDWIDTH1=50.000
GHz,SRCCNTRFREQ2=195.900000THz,SRCBANDWIDTH2=50.000GHz,SRCCNTRFREQ3=195.800
000THz,SRCBANDWIDTH3=50.000GHz,SRCCNTRFREQ4=195.700000THz,SRCBANDWIDTH4=50.
000GHz" "FAC-2-6-1,FAC-2-6-
2:1WAY,INTRA:BANDTYPE=CBAND,SRCCNTRFREQ1=196.000000THz,SRCBANDWIDTH1=50.000
GHz,SRCCNTRFREQ2=195.900000THz,SRCBANDWIDTH2=50.000GHz,SRCCNTRFREQ3=195.800
000THz,SRCBANDWIDTH3=50.000GHz,SRCCNTRFREQ4=195.700000THz,SRCBANDWIDTH4=50.
000GHz" "FAC-2-7-3,FAC-2-7-
1:1WAY,INTRA:BANDTYPE=CBAND,SRCCNTRFREQ1=196.000000THz,SRCBANDWIDTH1=50.000
GHz,SRCCNTRFREQ2=195.900000THz,SRCBANDWIDTH2=50.000GHz,SRCCNTRFREQ3=195.800
000THz,SRCBANDWIDTH3=50.000GHz,SRCCNTRFREQ4=195.700000THz,SRCBANDWIDTH4=50.
000GHz" ;
Related Commands
RTRV-PXC-OCHM
DLT-PXC-OCHM
Deletes a cross-connection (OCHM).
Function
This command deletes an OCHM layer cross-connection.
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
DLT-PXC-OCHM:[<TID>]:<FROM>,<TO>:<CTAG>::[<CRSTYPE>]:
[BANDTYPE=<BANDTYPE>,][SRCCNTRFREQ=<SRCCNTRFREQ>,]
[DSTBANDTYPE=<DSTBANDTYPE>,][DSTCNTRFREQ=<DSTCNTRFREQ>,]
[INCL=<INCL>];
Command Parameters
Parameters Description Default Value
<BANDTYPE> Indicates the type of the wavelength band. The default CBAND
and only available value for this parameter is CBAND.
<SRCCNTRFREQ> Indicates the center frequency of the source 1st wave, NULL
such as 196.0THz.
<DSTBANDTYPE> Indicates the type of the band to which the sink CBAND
wavelength belongs.
<DSTCNTRFREQ> Indicates the center frequency of the destination 1st NULL
wave, such as 196.0THz.
<INCL> Indicates inclusive. The valid values are as follows: N
Y: indicates that the requested channel is
disconnected regardless of its red-lined state.
N: indicates that the status of the cross-
connection is considered to determine whether the
requested channel should be disconnected.
NOTE:
A red-lined connection can be deleted only when <INCL> is
set to Y.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-PXC-OCHM::FAC-2-2-1,FAC-2-7-1:100::E2E:SRCCNTRFREQ=196.0THz,INCL=Y;
Response Message
NE 2014-06-19 09:40:15 M 100 COMPLD ;
Related Commands
ENT-PXC-OCHM
ED-PXC-OCHM
RTRV-PXC-OCHM
D.9.2 Configuring EXC
This section lists the commands used to configure an EXC.
ENT-CRS-<MOD2>
Creates a cross-connection.
Function
This command creates an electrical layer cross-connection.
The symbol "&" can be used in the AID field of this command to indicate multiple objects.
The following command is used to create a common one-way cross-connection from
point F1 to point T1.
ENT-CRS-<MOD2>:[<TID>]:F1,T1:<CTAG>::1WAY;
The following command is used to create a common two-way cross-connection from
point F1 to point T1.
ENT-CRS-<MOD2>:[<TID>]:F1,T1:<CTAG>::2WAY;
The following command is used to create a one-way selector from points F1&F2 to
point T1.
ENT-CRS-<MOD2>:
[<TID>]:F1&F2,T1:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<OTNL
EVEL>],1WAY;
The following command is used to create SNCP (a one-way selector and one-way
bridge) from points F1&F2 to point T1. (Either of the two commands can be used.)
ENT-CRS-<MOD2>:
[<TID>]:F1&F2,T1:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<OT
NLEVEL>],2WAY;
ENT-CRS-<MOD2>:
[<TID>]:T1,F1&F2:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<OT
NLEVEL>],2WAY;
The following command is used to create two one-way selectors, one from points
F1&F2 to point T1 and the other from points F1&F2 to point T2.
ENT-CRS-<MOD2>:
[<TID>]:F1&F2,T1&T2:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<O
TNLEVEL>],1WAY;
The following command is used to create broadcast from point F1 to points
T1&T2&T3&T4.
ENT-CRS-<MOD2>:[<TID>]:F1,T1&T2&T3&T4:<CTAG>::1WAY;
The following command is used to interconnect two SNCP cross-connections from
points F1&F2 to points T1&T2.
ENT-CRS-<MOD2>:
[<TID>]:F1&F2,T1&T2:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<O
TNLEVEL>],2WAY;
If there is one common one-way cross-connection from F1 to T1, the following
command will convert it to a one-way selector; the preferred path is F1.
ENT-CRS-<MOD2>:
[<TID>]:F2,T1:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<OTNLEV
EL>],1WAY;
If there is one common two-way cross-connection from F1 to T1, the following
command will convert it to SNCP; the preferred path is F1.
ENT-CRS-<MOD2>:
[<TID>]:F2,T1:<CTAG>::SNCPTYPE=<SNCPTYPE>[,OTNLEVEL=<OTNLEV
EL>],2WAY;
Usage Note
When an SNCP 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-ODU1::F1&F2,T1:123;) is the preferred path. The user can also set
the preferred path by using parameter <PREFERREDPATH>.
Category
Cross-connection
Security
Provisioning
Command Syntax
ENT-CRS-<MOD2>:[<TID>]:<FROM>,<TO>:<CTAG>::[<CCT>]:[TS=<TS>],
[PLDRATE=<PLDRATE>],[PLDTYPE=<PLDTYPE>],[SNCPTYPE=<SNCPTYPE>]
[,OTNLEVEL=<OTNLEVEL>][,PREFERREDPATH=<PREFERREDPATH>]
[,RVRTV=<RVRTV>][,RVTM=<RVTM>][,SDFLAG=<SDFLAG]
[,CONFRIMTIME=<CONFRIMTIME>][,CKTID=<CKTID>]:,[<SST>];
Command Parameters
Parameters Description Default Value
<SST> Indicates the red-lined state. The valid states are RDLD-DEA
provided in section SST_STATE.
Response Syntax
<cr><lf><lf> ^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf> M^^<CTAG>^COMPLD
<cr><lf> ;
Example
Command
ENT-CRS-ODU1::CLNT-1-7-1,SRV2-1-3-1:C::2WAY:CKTID=A1:,RDLD;
Response Message
NE 2003-02-28 12:23:20 M 100 COMPLD ;
Related Commands
ED-CRS-<MOD2>
DLT-CRS-<MOD2>
RTRV-CRS
ED-CRS-<MOD2>
Edits a cross-connection.
Function
This command edits the attributes of an electrical layer cross-connection.
The symbol "&" can be used in the AID field of this command to indicate multiple
objects.
The AIDs must be in the same order as originally entered for the one-way cross-
connections. Either order will work for the two-way cross-connections.
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", a command with the AID format (F1&F2,T1) is required to edit
this cross-connection.
The following command is used to edit the name of the specified cross-connection.
ED-CRS-<MOD2>::F1,T1:<CTAG>:::CKTID=FISTONE;
The following command is used to edit the red-lined state of the specified cross-
connection.
ED-CRS-<MOD2>::F1,T1:<CTAG>::::,RDLD-DEA;
Usage Note
This command edits the preferred path when the switching state is not idle to ensure that the
future automatic switching is performed successfully.
Category
Cross-connection
Security
Provisioning
Command Syntax
ED-CRS-<MOD2>:[<TID>]:<FROM>,<TO>:<CTAG>::: [OTNLEVEL=<OTNLEVEL>,]
[RVRTV=<RVRTV>,][RVTM=<RVTM>,][SDFLAG=<SDFLAG>,]
[CONFRIMTIME=<CONFRIMTIME>][CKTID=<CKTID>]:,[<SST>];
Command Parameters
Default
Parameters Description Value
<MOD2> The <MOD2> includes ODUn, OTUn, STSn, etc. For other NA
<MOD2> values, see the service type parameter in D.6.8 ED-
CLNT.
<RVRTV> Indicates the revertive mode which only applies to SNCP. The N
valid values are Y and N.
<SST> Indicates the red-lined state. The valid values are provided in NA
section SST_STATE.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
ED-CRS-ODU1::CLNT-3-1-1&CLNT-4-1-1,SRV1-5-1-1:123:::CKTID=SHENZHEN:,RDLD;
Response Message
NE 2003-02-28 12:23:50
M 100 COMPLD
;
Related Commands
ENT-CRS-<MOD2>
DLT-CRS-<MOD2>
RTRV-CRS
DLT-CRS-<MOD2>
Deletes a cross-connection.
Function
This command deletes a cross-connection.
The AIDs must be in the same order as originally entered for the one-way cross-
connections. Either order will work for the two-way cross-connections.
This command does not support deleting multiple cross-connections.
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.
If there is a common one-way cross-connection from point F1 to point T1, the
following command is used to delete it.
DLT-CRS-<MOD2>:[<TID>]:F1,T1:<CTAG>;
If there is a common two-way cross-connection from point F1 to point T1, the
following commands are used to delete it. (Either of the two commands can be
deleted.)
DLT-CRS-<MOD2>:[<TID>]:F1,T1:<CTAG>;
DLT-CRS-<MOD2>:[<TID>]:T1,F1:<CTAG>;
If there is a selector from points F1& F2 to point T1, the following command is used
to delete it.
DLT-CRS-<MOD2>:[<TID>]:F1&F2,T1:<CTAG>;
The following command is used to delete two one-way selectors:
From points F1&F2 to point T1
From points F1&F2 to point T2
DLT-CRS-<MOD2>:[<TID>]:F1&F2,T1&T2:<CTAG>;
If there is one one-way selector form F1 and F2 to T1, the following command will
convert it to a common one-way cross-connection from F1 to T1.
DLT-CRS-<MOD2>:[<TID>]:F2,T1:<CTAG>;
If there is one SNCP from F1 and F2 to T1, the following command will convert it to
a common two-way cross-connection from F1 to T1.
DLT-CRS-<MOD2>:[<TID>]:F2,T1:<CTAG>;
Usage Note
None
Category
Cross-connection
Security
Provisioning
Command Syntax
DLT-CRS-<MOD2>:[<TID>]:<FROM>,<TO>:<CTAG>:::[INCL=<INCL>];
Command Parameters
Parameters Description Default Value
<MOD2> The <MOD2> includes ODUn, OTUn, and STSn. For other NA
<MOD2> values, see the service type parameter in D.6.8 ED-
CLNT.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-CRS-ODU1::SRV1-1-5-1-1,CLNT-1-1-1:C:::INCL=Y;
Related Commands
ED-CRS-<MOD2>
ENT-CRS-<MOD2>
RTRV-CRS
RTRV-CRS
Retrieves a cross-connection.
Function
This command retrieves the attributes for the cross-connections.
Usage Note
None
Category
Cross-connection
Security
Retrieve
Command Syntax
RTRV-CRS:[<TID>]:[<OTNCRSAID#N\"SLOT-ALL\">]:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>:<CCT>,<LEVEL>:[TS=<TS>][,PLDRATE=<PLDRATE>]
[,PLDTYPE=<PLDTYPE>][,SNCPTYPE=<SNCPTYPE>][,OTNLEVEL=<OTNLEVEL>]
[,PREFERREDPATH=<PREFERREDPATH>][,ACTIVEPATH=<ACTIVEPATH>,][,RVRTV=<RVRTV>]
[,RVTM=<RVTM>][,SDFLAG=<SDFLAG>][,CONFRIMTIME=<CONFRIMTIME>]
[,AUTOFLAG=<AUTOFLAG>][,CKTID=<CKTID>]:[,<SST>]" <cr><lf>)+ ;
Response Parameters
Parameters Description
<CCT> Indicates the type of the cross-connection. The valid values are as
follows:
2WAY: indicates that the cross-connection is bidirectional.
1WAY: indicates that the cross-connection is unidirectional.
<LEVEL> Indicates the level of the cross-connection. The valid values are as
follows:
FETH/GETH/XGETH
OTU1/OTU2/OTU3/OTU5G
ODU0/ODU1/ODU2/ODU3/ODU5G/ODUFLEX
STS3/STS12/STS48/STS192/STS768
STM1/STM4/STM16/STM64/STM256
FC100/FC200/FC400/FC1000/FC1200
FICON/FICONEXP
HDSDI
DVBASI/SDI
ESCON
FDDI
Parameters Description
ISCIG
ISC2G
<PLDRATE> Indicates the rate of a channel service and is valid only when ODUflex
services are configured on the channel.
<PLDTYPE> Indicates the type of a channel service and is valid only when ODUflex
services are configured on the channel.
<TS> Indicates the bandwidth occupied by the ODUflex service when the
service is queried. This parameter is unavailable when other services
are queried.
<SNCPTYPE> Indicates the SNCP protection type The valid values are as follows:
swsncp: SW SNCP protection
snci: SNC/I
sncn: SNC/N
sncs: SNC/S
NA: Non-SNCP group
<PREFERREDPATH> Indicates the preferred path. It is only available for SNCP. Two values
separated by "&" are only applicable to SNCP with two sources or two
destinations.
<ACTIVEPATH> Indicates the active path. It is only available for SNCP. Two values
separated by "&" are applicable to only SNCP with 2 sources or 2
destinations. The active path is the actual working path of the SNCP.
<RVTM> This parameter is available only for SNCP and when <RVRTV> is
enabled.
Indicates the revertive time expressed in minutes. It ranges from 5 to
12. The default value is 5.
<SST> Indicates the red-lined state. This parameter is omitted in the response
when <SST> is set to RDLD-DEA.
Example
Command
RTRV-CRS::SLOT-1-6:C;
Response Message
Omitted.
Related Commands
ED-CRS-<MOD2>
ENT-CRS-<MOD2>
DLT-CRS-<MOD2>
RTRV-CRS-LOG
Retrieves the SNCP event records.
Function
This command retrieves the SNCP event records.
Usage Note
The logs of deleted protection groups cannot be queried.
Category
SNCP
Security
Retrieve
Command Syntax
RTRV-CRS-LOG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^<FROM>,<TO>:,<LEVEL>:PSEVENT=<PSEVENT>,EVENTPARA=<EVENTPARA>,DATE=<DATE
>,TIME=<TIME>"<cr><lf>)+ ;
Response Parameters
Parameter Description
<DATE> Indicates the date when the event happens. The valid format is YY-MM-DD.
<TIME> Indicates the time when the event happens. The valid format is HH-MM-SS.
Example
Command
RTRV-CRS-LOG:::K;
Response Message
NE-122-23 2014-03-17 10:55:02
M K COMPLD
"SRV2-1-14-1&SRV2-1-13-1,CLNT-1-5-
1:,ODU2:PSEVENT=START_PROTOCL,EVENTPARA=0,DATE=2014-03-15,TIME=21-34-00";
Related Commands
None
RTRV-CRS-DBG
Retrieves a cross-connection.
Function
This command retrieves the attributes for the cross-connections.
Usage Note
None
Category
Cross-connection
Security
Maintenance
Command Syntax
RTRV-CRS—DBG:[<TID>]::<CTAG>;
Command Parameters
Parameters Description Default Value
NA NA NA
Response Syntax
Omitted
Response Parameters
Parameters Description
Example
Command
RTRV-CRS-DBG:[<TID>]::C;
Response Message
Omitted.
Related Commands
ED-CRS-<MOD2>
ENT-CRS-<MOD2>
DLT-CRS-<MOD2>
RTRV-CRS-<MOD2>
Retrieves a cross-connection.
Function
This command retrieves the attributes for the cross-connections.
Symbol "&" is used in the AID field of this command to indicate multiple objects.
The following command is used to retrieve all level cross-connections with specified
path F1:
RTRV-CRS-<MOD2>::F1:<CTAG>;
F1&F2 indicates the working path and protection path respectively, so the following
command is used to retrieve all the SNCP cross-connections with the specified two
paths of F1 and F2:
RTRV-CRS-<MOD2>::F1&F2:<CTAG>;
Use the following commands to retrieve all the cross-connections with any path
between F1 and F2.
For example, create 4 cross-connections by using the following four commands:
ENT-CRS-ODU1::CLNT-7-1-1,CLNT-10-1-1:S::2WAY:CKTID=CHA9;
ENT-CRS-ODU1::CLNT-7-1-2,CLNT-10-1-2:S::2WAY:CKTID=CHA9;
ENT-CRS-ODU1::CLNT-7-1-3,CLNT-10-1-3:S::2WAY:CKTID=CHA9;
ENT-CRS-ODU1::CLNT-7-1-4,CLNT-10-1-4:S::2WAY:CKTID=CHA9;
The RTRV-CRS-ODU1::STS-7-1-1&&-4:S command can retrieve all the cross-
connections between the two ODU1s.
The following command is used to retrieve all the cross-connections:
RTRV-CRS-<MOD2>:::<CTAG>;
Usage Note
None
Category
Cross-connection
Security
Retrieve
Command Syntax
RTRV-CRS-<MOD2>:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameters Description Default Value
<MOD2> The <MOD2> includes ODUn, OTUn, and STSn. For other NA
<MOD2> values, see the service type parameter in D.6.8 ED-
CLNT.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>:<CCT>,<LEVEL>:[TS=<TS>][,PLDRATE=<PLDRATE>]
[,PLDTYPE=<PLDTYPE>][,SNCPTYPE=<SNCPTYPE>][,OTNLEVEL=<OTNLEVEL>]
[,PREFERREDPATH=<PREFERREDPATH>][,ACTIVEPATH=<ACTIVEPATH>,][,RVRTV=<RVRTV>]
[,RVTM=<RVTM>][,SDFLAG=<SDFLAG>][,CONFRIMTIME=<CONFRIMTIME>]
[,AUTOFLAG=<AUTOFLAG>][,CKTID=<CKTID>]:[,<SST>]" <cr><lf>)+ ;
Response Parameters
Parameters Description
<CCT> Indicates the type of the cross-connection. The valid values are as
follows:
2WAY: indicates that the cross-connection is bidirectional.
1WAY: indicates that the cross-connection is unidirectional.
<LEVEL> Indicates the level of the cross-connection. The valid values are as
follows:
FETH/GETH/XGETH
OTU1/OTU2/OTU3/OTU5G
ODU0/ODU1/ODU2/ODU3/ODU5G/ODUFLEX
STS3/STS12/STS48/STS192/STS768
STM1/STM4/STM16/STM64/STM256
FC100/FC200/FC400/FC1000/FC1200
FICON/FICONEXP
HDSDI
DVBASI/SDI
ESCON
FDDI
ISCIG
ISC2G
<PLDRATE> Indicates the rate of a channel service and is valid only when ODUflex
services are configured on the channel.
<PLDTYPE> Indicates the type of a channel service and is valid only when ODUflex
services are configured on the channel.
<TS> Indicates the bandwidth occupied by the ODUflex service when the
service is queried. This parameter is unavailable when other services
are queried.
<SNCPTYPE> Indicates the SNCP protection type The valid values are as follows:
swsncp: SW SNCP protection
snci: SNC/I
sncn: SNC/N
sncs: SNC/S
NA: Non-SNCP group
It is displayed only when the SNCP type is SNCS or SNCN. The valid
values are as follows:
SNC/S: TCM1-TCM6
SNC/N: PM, TCM1-TCM6
<PREFERREDPATH> Indicates the preferred path. It is only available for SNCP. Two values
separated by "&" are only applicable to SNCP with two sources or two
destinations.
<ACTIVEPATH> Indicates the active path. It is only available for SNCP. Two values
separated by "&" are applicable to only SNCP with 2 sources or 2
destinations. The active path is the actual working path of the SNCP.
<RVTM> This parameter is available only for SNCP and when <RVRTV> is
enabled.
Indicates the revertive time expressed in minutes. It ranges from 5 to
12. The default value is 5.
<SST> Indicates the red-lined state. This parameter is omitted in the response
when <SST> is set to RDLD-DEA.
Example
Command
RTRV-CRS-ODU1::CLNT-1-2-1:C;
Response Message
NGWDM-NE 2003-03-12 07:28:39 M 100 COMPLD "CLNT-1-3-1&CLNT-1-2-1,SRV1-1-
7-1-1:2WAY,ODU1:SNCPTYPE=SNCI,PREFERREDPATH=CLNT-1-3-1,ACTIVEPATH=CLNT-1-3-
1,CKTID=MERRY:,RDLD" ;
Related Commands
ED-CRS-<MOD2>
ENT-CRS-<MOD2>
DLT-CRS-<MOD2>
D.10.1 ENT-CRS-OHFE
Creates a pass-through FE service in the OSC.
Function
This command creates a pass-through FE service in the OSC. After the pass-through FE
service is created in the OSC, the FE port on the ST2 board where the OSC is located cannot
be used to transparently transmit third-party management information.
Usage Note
None
Category
Communication
Security
Provisioning
Command Syntax
ENT-CRS-OHFE:[<TID>]:<FROM>,<TO>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Example
Command
ENT-CRS-OHFE::FAC-1-2-1,FAC-1-3-1:10;
Response Message
NE 2011-01-25 15:33:17 M 10 COMPLD ;
Related Commands
D.10.2 RTRV-CRS-OHFE
D.10.3 DLT-CRS-OHFE
D.10.2 RTRV-CRS-OHFE
Retrieves the cross of a transparent FE channel of OSC.
Function
Retrieves the cross of a transparent FE channel of OSC.
Usage Note
None
Category
Communication
Security
Retrieve
Command Syntax
RTRV-CRS-OHFE:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description
Response Syntax
cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<FROM>,<TO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-CRS-OHFE:::100;
Response Message
NE 2011-01-20 15:36:49
M 10 COMPLD
"FAC-1-2-1,FAC-1-6-1"
;
Related Commands
D.10.1 ENT-CRS-OHFE
D.10.3 DLT-CRS-OHFE
D.10.3 DLT-CRS-OHFE
Deletes the cross of a transparent FE channel of OSC.
Function
Deletes the cross of a transparent FE channel of OSC.
Usage Note
None
Category
Communication
Security
Provisioning
Command Syntax
DLT-CRS-OHFE:[<TID>]:<FROM>,<TO>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Example
Command
DLT-CRS-OHFE::FAC-1-2-1,FAC-1-3-1:10;
Response Message
NE 2011-01-25 15:33:17
M 10 COMPLD
;
Related Commands
D.10.2 RTRV-CRS-OHFE
D.10.1 ENT-CRS-OHFE
ENT-EQPT-PG
Creates equipment level protection group.
Function
This command creates equipment level protection group. It corresponds to the BPS protection
group function.
Usage Note
None
Category
EQPT protection
Security
Provisioning
Command Syntax
ENT-EQPT-PG:[<TID>]:<AID>:<CTAG>:::WORK=<WORK>,[CTRL=<CTRL>]:
[<PGSTATE>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-EQPT-PG::SLOT-1-4:C:::WORK=SLOT-1-5,CTRL=N:IS;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-EQPT-PG
DLT-EQPT-PG
ED-EQPT-PG
ED-EQPT-PG
Edits equipment level protection group.
Function
This command edits the attributes of equipment level protection group.
Usage Note
None
Category
EQPT protection
Security
Provisioning
Command Syntax
ED-EQPT-PG:[<TID>]:<AID>:<CTAG>::::[<PGSTATE>];
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Example
Command
ED-EQPT-PG::SLOT-1-4:C::::OOS;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-EQPT-PG
DLT-EQPT-PG
ENT-EQPT-PG
DLT-EQPT-PG
Deletes equipment level protection group.
Function
This command deletes equipment level protection group.
Usage Note
None
Category
EQPT protection
Security
Provisioning
Command Syntax
DLT-EQPT-PG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Example
Command
DLT-EQPT-PG::SLOT-1-4:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-EQPT-PG
DLT-EQPT-PG
ENT-EQPT-PG
RTRV-EQPT-PG
Retrieves equipment level protection group.
Function
This command retrieves the parameters for a specified equipment level protection group.
Usage Note
None
Category
EQPT protection
Security
Retrieve
Command Syntax
RTRV-EQPT-PG:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^("<AID>::RVRTV=<RVRTV>,PSTYPE=<PSTYPE>,WORK=<WORK>,CTRL=
<CTRL>,SWSTATE=<SWSTATE>:<PGSTATE>")+<cr><lf>
;
Response Parameters
Parameter Description
<RVRTV> Indicates the revertive mode. The only valid value supported by BPS is N (non-
revertive mode).
<PSTYPE> Indicates the protection type. 1+1 indicates the BPS protection.
<CTRL> Indicates whether the protection card can disable service output.
N: indicates that the protection card is not able to disable service output. In
this scenario, no control unit is available. (default value).
Y: indicates that the protection card is able to disable service output. In this
scenario, the SCS is the control unit.
<WORK> Indicates the AID(s) of the working card.
<SWSTATE> Indicates the switching status of the protection group. The valid values are as
follows:
IDLE: The service is running on the working card.
SWITCHING: The service is running on the protection card.
<PGSTATE> Indicates the state of the protection group. The valid values are IS (in-service) and
OOS (out-of-service).
Example
Command
RTRV-EQPT-PG:::C;
Response Message
NGWDM-NE 2004-01-01 15:54:55
M C COMPLD
"SLOT-1-4::RVRTV=N,PSTYPE=1+1,CTRL=N,WORK=SLOT-1-3,SWSTATE=IDLE:IS"
;
Related Commands
ENT-EQPT-PG
ED-EQPT-PG
DLT-EQPT-PG
OPR-PROTNSW-EQPT
Performs equipment level protection switching.
Function
This command instructs an NE to perform equipment level protection switching.
Usage Note
None
Category
EQPT protection
Security
Maintenance
Command Syntax
OPR-PROTNSW-EQPT:[<TID>]:<AID>:<CTAG>::<SC>:[<DIRN>];
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
OPR-PROTNSW-EQPT::SLOT-1-5:C::MAN:BTH;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RLS-PROTNSW-EQPT
RLS-PROTNSW-EQPT
Releases equipment level protection switching.
Function
This command instructs the NE to release equipment level protection switching.
Usage Note
None
Category
EQPT protection
Security
Maintenance
Command Syntax
RLS-PROTNSW-EQPT:[<TID>]:<AID>:<CTAG>::[<DIRN>];
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Example
Command
RLS-PROTNSW-EQPT::SLOT-1-5:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
OPR-PROTNSW-EQPT
ENT-FFP-<OCH/OC/WDM/CFP>
Creates a facility protection group of the optical level, such as OCH, OC, WDM or CFP.
Function
This command creates an optical facility protection group. It can also be used to input
attributes of the protection group.
Usage Note
None
Category
FFP protection
Security
Provisioning
Command Syntax
ENT-FFP-<OCH/OC/WDM/CFP>:
[<TID>]:<PROTECT>,<WORK>:<CTAG>:::FFPTYPE=<FFPTYPE>,
[PROTNE=<PROTNE>],[WORKNE=<WORKNE>],[MARK=<MARK>],
[PSDIRN=<PSDIRN>],[APSCHN=<APSCHN>],[APSMFIDX=<APSMFIDX>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[SDFLAG=<SDFLAG>],
[CONFRIMTIME=<CONFRIMTIME>],[DETECT=<DETECT>],[CTRL=<CTRL>],
[CTRLNE=<CTRLNE>]:[<FFPSTATE>];
Command Parameters
Parameter Description Default
Value
<FFPTYPE> Indicates the type of protection group. The valid values are as NA
follows:
OLP1+1: indicates optical line protection.
INNER1+1: indicates intra-card 1+1 protection.
Client1+1: indicates client-side 1+1 protection.
OLP1V1: indicates optical line 1V1 protection.
<SDFLAG> Indicates the signal degrade flag. The valid values are ENABLE DISABLE
and DISABLE.
<FFPSTATE> Indicates the state of the protection group. The valid values are IS
IS (In-service) and OOS (out-of-service).
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-FFP-WDM::FAC-1-11-2,FAC-1-11-1:100:::FFPTYPE=OLP1+1,RVRTV=Y;
Response Message
NE 2006-01-07 09:50:17
M 100 COMPLD
;
Related Commands
ED-FFP-<OCH/OC/WDM/CFP>
DLT-FFP-<OCH/OC/WDM/CFP>
RTRV-FFP-<OCH/OC/WDM/CFP/ALL>
ED-FFP-<OCH/OC/WDM/CFP>
Edits a facility protection group of the optical level, such as OCH, OC, WDM or CFP.
Function
This command edits the attributes of an optical facility protection group.
Usage Note
None
Category
FFP protection
Security
Provisioning
Command Syntax
ED-FFP-<OCH/OC/WDM/CFP>:[<TID>]:<AID>:<CTAG>:::[NE=<NE>],
[MARK=<MARK>],[PSDIRN=<PSDIRN>],[APSCHN=<APSCHN>],
[APSMFIDX=<APSMFIDX>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],
[SDFLAG=<SDFLAG>],[SFCOND=<SFCOND>],[SDCOND=<SDCOND>],
[CONFRIMTIME=<CONFRIMTIME>]:[<FFPSTATE>];
Command Parameters
Default
Parameter Description Value
NA
<MOD2> The valid values are as follows:
<FFPSTATE> Indicates the state of the facility protection group. The valid values NA
are IS (in-service) and OOS (out-of-service).
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-FFP-OC::FAC-2-2-1:C:::MARK=TEST,RVRTV=Y,RVTM=8;
Response Message
NE 2006-01-07 09:50:17
M 100 COMPLD
;
Related Commands
ENT-FFP-<OCH/OC/WDM/CFP>
DLT-FFP-<OCH/OC/WDM/CFP>
RTRV-FFP-<OCH/OC/WDM/CFP/ALL>
DLT-FFP-<OCH/OC/WDM/CFP>
Deletes a facility protection group of the optical level, such as OCH, OC, WDM or CFP.
Function
This command deletes an entire optical facility protection group of a specified optical carrier
(OCH/OC/WDM/CFP) level.
Usage Note
None
Category
FFP protection
Security
Provisioning
Command Syntax
DLT-FFP-<OCH/OC/WDM/CFP>:[<TID>]:<AID>:<CTAG>:::[NE=<NE>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
DLT-FFP-OC::FAC-2-2-1:100;
Response Message
NE 2006-01-07 09:50:17
M 100 COMPLD
;
Related Commands
ED-FFP-<OCH/OC/WDM/CFP>
ENT-FFP-<OCH/OC/WDM/CFP>
RTRV-FFP-<OCH/OC/WDM/CFP/ALL>
RTRV-FFP-<OCH/OC/WDM/CFP/ALL>
Retrieves the attributes of a facility protection group of the optical level, such as OCH, OC,
WDM or CFP.
Function
This command retrieves the attributes of an optical facility protection group.
Usage Note
None
Category
FFP protection
Security
Retrieve
Command Syntax
RTRV-FFP-<OCH/OC/WDM/CFP/ALL>:[<TID>]:[<AID>]:<CTAG>:::[NE=<NE>];
Command Parameters
ALL
<MOD2> The valid values are as follows:
Response Parameters
Parameter Description
is required.
<CTRLNE> The NE on which the control unit (OLP) is located. If the control unit is local,
nothing is entered for this parameter.
<MARK> Indicates the protection group memo information. It is a string with no more
than 64 characters. The default value is NULL.
<PSDIRN> Indicates the switching mode ,The valid value is UNI(unidirectional switching)
or BI(bidirectional switching).
<APSCHN> Indicates the channel transporting APS bytes.
<APSMFIDX> Indicates the index of Multi Frame Alignment Signal for transporting APS
bytes.
<RVRTV> Indicates the revertive mode. The valid values are as follows:
Y: indicates the revertive mode.
N: indicates the non-revertive mode.
The default value is N.
<RVTM> Indicates the revertive time.
<SDFLAG> Indicates the signal degrade flag. The valid values are ENABLE and
DISABLE.
<SFCOND> Specifies the SF condition. This parameter is valid only for client 1+1
protection.
When OTN services are received on the client side, the valid values are as
follows:
PM: PM layer SF conditions are enabled but TCM layer SF conditions are
disabled.
TCM: TCM layer SF conditions are enabled but PM layer SF conditions are
disabled.
PM|TCM: Both PM and TCM layer SF conditions are enabled.
NULL: Both PM and TCM layer SF conditions are disabled.
When non-OTN services are received on the client side, the valid values are as
follows:
REMC-SF: REMC-SF is enabled for triggering protection switching.
NULL: REMC-SF is disabled from triggering protection switching.
<SDCOND> Specifies the SD condition. This parameter is valid only for client 1+1
protection.
When OTN services are received on the client side, the valid values are as
follows:
PM: PM layer SD conditions are enabled but TCM layer SD conditions are
disabled.
PM: TCM layer SD conditions are enabled but PM layer SD conditions are
disabled.
PM|TCM: Both PM and TCM layer SD conditions are enabled.
NULL: Both PM and TCM layer SD conditions are disabled.
When non-OTN services are received on the client side, the valid values are as
follows:
Parameter Description
Example
Command
RTRV-FFP-WDM::ALL:C;
Response Message
NE 2008-11-18 14:08:37 M C COMPLD "FAC-1-11-2,FAC-1-11-
1:WDM:MARK=\"\",FFPTYPE=OLP1+1,RVRTV=Y,RVTM=5,SDFLAG=DISABLE,:IS" "FAC-1-
13-2,FAC-1-13-
1:WDM:MARK=\"\",FFPTYPE=OLP1+1,RVRTV=N,RVTM=0,SDFLAG=DISABLE,:IS" ;
Related Commands
ED-FFP-<OCH/OC/WDM/CFP>
DLT-FFP-<OCH/OC/WDM/CFP>
ENT-FFP-<OCH/OC/WDM/CFP>
RTRV-FFP-LOG
Retrieves the FFP event records.
Function
This command retrieves the FFP event records.
Usage Note
The logs of deleted protection groups cannot be queried.
Category
FFP protection
Security
Maintenance
Command Syntax
RTRV-FFP-LOG:[<TID>]:<AID>:<CTAG>:::[NE=<NE>];
Command Parameters
Description Default Value
Parameter
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^<AID>:
[NE=<NE>],EVENTNO=<EVENTNO>,PSEVENT=<PSEVENT>,EVENTPARA=<EVENTPARA>,DATE=<D
ATE>,TIME=<TIME>"<cr><lf>)+ ;
Response Parameters
Parameter Description
<AID> Indicates the access identifier that identifies the OCh/OC/WDM/CFP port in the
FFP group.
<NE> Indicates the NE on which the optical facility is located. If the optical facility is
local, nothing is entered for this parameter.
<EVENTNO> Indicates the event number that increases from 1 to 65535. The maximum record
number of 1-N is 250 and the limit of the 1+1 protection group is 1250.
<DATE> Indicates the date when the event happens. The valid format is YY-MM-DD.
<TIME> Indicates the time when the event happens. The valid format is HH-MM-SS.
Example
Command
RTRV-FFP-LOG::FAC-2-2-1:C1;
Response Message
NE 2006-02-01 11:37:18
M C1 COMPLD
FAC-2-1-1::EVENTNO=1,PSEVENT=SFSW,EVENTPARA=0x010f0200,DATE=2005-11-
12,TIME=11-33-23;
Related Commands
INIT-FFP-LOG
INIT-FFP-LOG
Clear the FFP event records.
Function
This command clears the FFP event records.
Usage Note
None
Category
FFP protection
Security
Maintenance
Command Syntax
INIT-FFP-LOG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-FFP-LOG:::S;
Response Message
NE-122-23 2012-08-02 20:11:25
M S COMPLD
;
>
Related Commands
RTRV-FFP-LOG
OPR-PROTNSW-<OCH/OC/WDM/CFP>
Performs a protection switching of an optical level, such as OCH, OC, WDM or CFP.
Function
This command performs a protection switching.
Usage Note
If this command is successfully executed, the channel indicated by the input parameter AID
turns to a non-working state.
Category
FFP protection
Security
Maintenance
Command Syntax
OPR-PROTNSW-<OCH/OC/WDM/CFP>:[<TID>]:<AID>:<CTAG>::<SC>:[<DIRN>]
[,<NE>];
Command Parameters
Parameter Description Default Value
NA
<MOD2> The valid values are as follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
OPR-PROTNSW-OC::FAC-2-2-1:100::FRCD;
Response Message
NE 2006-01-07 09:50:17
M 100 COMPLD
;
Related Commands
RLS-PROTNSW-<OCH/OC/WDM/CFP>
RLS-PROTNSW-<OCH/OC/WDM/CFP>
Releases a protection switching (OCH/OC/WDM/CFP).
Function
This command instructs an NE to release (clear) line protection switching between a working
line and an established protection line.
Usage Note
Releasing switching command can release only external switching commands. After a
switching is released, the protection group returns to a proper state. For example, if the
working channel and protection channel are both normal, the group returns to the working
channel. If the working channel is faulty and the protection channel is normal, the group
switches to the protection channel.
Category
FFP protection
Security
Maintenance
Command Syntax
RLS-PROTNSW-<OCH/OC/WDM/CFP>:[<TID>]:<AID>:<CTAG>::[<DIRN>][,<NE>];
Command Parameters
NA
<MOD2> The valid values are as follows:
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
RLS-PROTNSW-OC::FAC-2-2-1:100;
Response Message
NE 2006-01-07 09:50:17
M 100 COMPLD
;
Related Commands
OPR-PROTNSW-<OCH/OC/WDM/CFP>
D.11.3 Configuring SNCP Protection
This section lists the commands used to configure SNCP protection.
NOTE:
For configuring SNCP protection, refer to D.9.2 Configuring EXC.
RLS-PROTNSW-<MOD2>
Releases a protection switching.
Function
This command instructs the NE to release path protection switching request that is created by
the external command.
Usage Note
None
Category
SNCP
Security
Maintenance
Command Syntax
RLS-PROTNSW-<MOD2>:[<TID>]:<AID>:<CTAG>::[<DIRN>];
Command Parameters
Example
Command
RLS-PROTNSW-ODU1::SRV1-1-2-1-1:C;
Response Message
NE 2003-02-29 12:24:50
M 100 COMPLD
;
Related Commands
OPR-PROTNSW-<MOD2>
OPR-PROTNSW-<MOD2>
Performs the protection switching.
Function
This command instructs an NE to execute the external switching command.
This command is applicable to SNCP configuration only.
The AID must be a working or protection path AID. A DENY message will be
returned when users send this command with the sink AID.
Use the RTRV-COND-ALL or RTRV-ALM-ALL command to retrieve the protection
switching state (manual, lockout, or force).
Usage Note
None
Category
SNCP
Security
Maintenance
Command Syntax
OPR-PROTNSW-<MOD2>:[<TID>]:<AID>:<CTAG>::<SC>:[<DIRN>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
OPR-PROTNSW-ODU1::SRV1-1-1-1-1:123::MAN:BTH;
Response Message
NE 2003-02-29 12:23:50
M 100 COMPLD
;
Related Commands
RLS-PROTNSW-<MOD2>
D.12.1 ED-AUTOSYNC-ENABLE
Edit the attribute for automatic synchronization.
Function
The command edit the attribute for automatic synchronization.
Usage Note
None
Category
HBU
Security
Maintenance
Command Syntax
ED-AUTOSYNC-ENABLE:[<TID>]:<SLOT_ID>:<CTAG>::<AUTOSYNC>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-AUTOSYNC-ENABLE::SLOT-1-18:100::ENABLE;
Response Message
M1050 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
None
D.12.2 REPT^SW
Reports the SCC switching.
Function
This event is reported to indicate that an SCC protection switching occurred.
Usage Note
None
Category
Equipment
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
A^^<ctag>^REPT^SW<cr><lf>
^^^"<ACT_SLOT>,<STANDBY_SLOT>"<cr><lf>
;
Response Parameters
Parameter Description
<ACT_SLOT> Indicates the slot of the working card after the switching.
<STANDBY_SLOT> Indicates the slot of the protection card after the switching.
Example
Command
None
Response Message
NE 2004-06-17 18:03:52
A 41 REPT SW
"SLOT-18,SLOT-17"
;
Related Commands
None
D.12.3 RTRV-BACKUP-INFO
Retrieves the backup information about the SCC.
Function
This command retrieves the backup information about the SCC.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-BACKUP-INFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"BACKUPINFO=<BACKUP_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
SHAKE HANDS: The two cards finished shaking hands, but backup
has not started yet.
IN PROGRESS: The memory data or database files are being backed
up, or database files are being recovered.
COMPLETED: The backup is successful. It is only in this state that
SCC switching does not have any impact.
SMOOTHDATA: Data is being smoothed to ensure the integrity of the
data.
WAITREQUEST: It indicates the request for audit state.
BACKUPREQUEST: It indicates the request for backup state.
Example
Command
RTRV-BACKUP-INFO:::100;
Response Message
NE 1990-02-07 07:16:23
M 100 COMPLD
"BACKUPINFO= COMPLETED"
;
Related Commands
None
D.12.4 ALW-SWDX-EQPT
Allows an automatic or manual switching.
Function
This command allows an automatic or manual switching on a system containing duplex
equipment. Use the INH-SWDX-EQPT command to inhibit the switching if necessary.
Usage Note
None
Category
SCC protection switch
Security
Maintenance
Command Syntax
ALW-SWDX-EQPT:[<TID>]:<HSCSLOT_NUM>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
ALW-SWDX-EQPT::SLOT-1-9:100;
Response Message
NE 1990-02-07 07:07:36
M 100 COMPLD
;
Related Commands
D.12.5 INH-SWDX-EQPT
D.12.5 INH-SWDX-EQPT
Inhibits an automatic or manual switching.
Function
This command inhibits an automatic or manual switching on a system containing duplex
equipment. Use the ALW-SWDX-EQPT command to release the inhibition if necessary.
Usage Note
None
Category
SCC protection switch
Security
Maintenance
Command Syntax
INH-SWDX-EQPT:[<TID>]:<HSCSLOT_NUM>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
INH-SWDX-EQPT::SLOT-1-9:100;
Response Message
NE 2004-02-07 07:07:36
M 100 COMPLD
;
Related Commands
D.12.4 ALW-SWDX-EQPT
D.12.6 RTRV-BATCHBAK-CAUSEHIS
Retrieves history records of the batch backup reason.
Function
This command retrieves history records of the batch backup reason.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-BATCHBAK-CAUSEHIS:[<TID>]:<SLOT_ID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SLOT_ID=<SLOT_ID>,BEGIN_TIME=<HBU_TIME_BEGIN>,BATCH_REASON=<HBU_BATCH_R
EASON>,BATCH_TIMES=<HBU_BATCH_TIMES>,TIME_OUT=<HBU_BATCH_TIMEOUT>,RESULT=<H
BU_SYNC_RESULT>,END_TIME=<HBU_TIME_END>"<cr><lf>
;
Response Parameters
Parameter Description
<HBU_BATCH_TIMES> Times from batch time out which result batch backup.
Command
RTRV-BATCHBAK-CAUSEHIS::SLOT-9:100;
Response Message
NE 2006-05-19 11:03:16
M 100 COMPLD
"SLOT_ID=SLOT-9,BEGIN_TIME=\"2006-05-19
07:18:24\",BATCH_REASON=AFTERSW,BATCH_TIMES=0,TIME_OUT=300000,RESULT=SYNC
OK,END_TIME=\"2006-05-19 07:18:49\""
"SLOT_ID=SLOT-9,BEGIN_TIME=\"2006-05-19
07:31:58\",BATCH_REASON=AFTERSW,BATCH_TIMES=0,TIME_OUT=300000,RESULT=SYNCIN
G...,END_TIME=\"1990-00-00 00:00:00\""
Related Commands
None
D.12.7 RTRV-MSCOM-INTRPHIS
Retrieves history interruption due to the active/standby switching.
Function
This command retrieves history interruption due to the active/standby switching.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-MSCOM-INTRPHIS:[<TID>]:<SLOT_ID>:<CTAG>;
Command Parameters
Response Parameters
Parameter Description
Example
Command
RTRV-MSCOM-INTRPHIS::SLOT-1-18:100;
Response Message
OSP-118 2011-06-23 18:37:04
M 100 COMPLD
"SLOT_ID=SLOT-1-18,TIME=2011-06-22 12-57-
54,COM_STATE=OK,STDBY_ONLINE=HBUONLINE"
;
Related Commands
None
D.12.8 RTRV-AUTOSYNC-ENABLE
Retrieves the automatic synchronization status.
Function
This command retrieves the automatic synchronization status.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-AUTOSYNC-ENABLE:[<TID>]:<SLOT_ID>:<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AUTOSYNC>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-AUTOSYNC-ENABLE::SLOT-1-17:100;
Response Message
NE 2005-08-02 18:25:07
M 100 COMPLD
"ENABLE"
;
Related Commands
D.36.4 SET-DBMS-AUTOBACKUP
D.12.9 RTRV-SWITCH-HIS
Retrieves records of the recent active/standby switching actions.
Function
This command retrieves the records of the recent active/standby switching actions.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-SWITCH-HIS:[<TID>]:<HSCSLOT_NUM>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SLOT_NUM=<HSCSLOT_NUM>,SWITCH_TIME=<HSC_SWITCH_TIME>,MANUAL_SWITCH=<FOR
CE_LOCK_SUPPORT>,AUTO_SWITCH=<HSC_SWITCH_AUTO>,"FORCE_SWITCH=<HSC_SWITCH_FO
RCE>,PLUG_SWITCH=<HSC_SWITCH_PLUG>,BIOS_LINGER=<HSC_BIOS_LINGER>,BIOS_RESET
=<HSC_BIOS_RESET>,"AS_ENABLE=<HSCSWENABLE>,SELF_AS=<HSC_AS_TYPE>,PEER_ONLIN
E=<HSC_BDONLINE>,SELF_WORK=<STDBY_WORK>,PEER_WORK=<HSC_WORK_PEER>,READY_STA
TE=<HSC_READY_STATE>,SOFT_DETECT=<HSC_SOFT_DETECT>,BAD_CODE=<HSC_BAD_CODE>"
<cr><lf>
;
Response Parameters
Parameter Description
<HSC_BDONLINE> Indicates the online flag before switching of the peer card.
<STDBY_WORK> Indicates the working state of the local card before switching.
<HSC_WORK_PEER> Indicates the working state of the peer card before switching.
Example
Command
RTRV-SWITCH-HIS::SLOT-9:100;
Response Message
NE 2006-05-19 11:04:53
M 100 COMPLD
"SLOT_NUM=SLOT-9,SWITCH_TIME=\"2006-05-19
07:31:41\",MANUAL_SWITCH=YES,AUTO_SWITCH=NO,FORCE_SWITCH=NO,PLUG_SWITCH=NO,
BIOS_LINGER=NO,BIOS_RESET=NO,AS_ENABLE=ENABLE,SELF_AS=ACTIVE,PEER_ONLINE=ON
LINE,SELF_WORK=GOOD,PEER_WORK=BAD,READY_STATE=DISABLE,SOFT_DETECT=DISABLE,B
AD_CODE=0"
"SLOT_NUM=SLOT-10,SWITCH_TIME=\"2006-05-19
07:44:34\",MANUAL_SWITCH=YES,AUTO_SWITCH=NO,FORCE_SWITCH=NO,PLUG_SWITCH=NO,
BIOS_LINGER=NO,BIOS_RESET=NO,AS_ENABLE=ENABLE,SELF_AS=ACTIVE,PEER_ONLINE=ON
LINE,SELF_WORK=GOOD,PEER_WORK=BAD,READY_STATE=DISABLE,SOFT_DETECT=DISABLE,B
AD_CODE=0"
;
Related Commands
None
D.12.10 RTRV-BAD-INFO
Retrieves bad information about the active/standby switching.
Function
This command retrieves bad information about the active/standby switching.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-BAD-INFO:[<TID>]:<HSCSLOT_NUM>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SLOT_NUM=<HSCSLOT_NUM>,FILE_NAME=<HSC_FILE_NAME>,FILE_LINE=<HSC_FILE_LI
NE>"<cr><lf>
;
Response Parameters
Parameter Description
<HSC_FILE_NAME> Indicates the name of the file that is bad. It is a string with a
maximum of 20 characters.
Example
Command
RTRV-BAD-INFO::SLOT-9:100;
Response Message
NE 2006-05-19 11:00:58
M 100 COMPLD
"SLOT_NUM=SLOT-9,FILE_NAME=\"xcs_xcs_harddrv.cpp\",FILE_LINE=3685"
"SLOT_NUM=SLOT-9,FILE_NAME=\"xcs_xcs_harddrv.cpp\",FILE_LINE=3685"
"SLOT_NUM=SLOT-9,FILE_NAME=\"xcs_xcs_harddrv.cpp\",FILE_LINE=3685"
"SLOT_NUM=SLOT-9,FILE_NAME=\"xcs_xcs_harddrv.cpp\",FILE_LINE=3685"
;
Related Commands
None
D.12.11 RTRV-BACKUPMOD-INFO
Retrieves the information about the batch backup module.
Function
This command retrieves the information about the batch backup module.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-BACKUPMOD-INFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"
BACKUPMODID=<BACKUP_MOD_ID>,BACKUPSUBMODID=<BACKUP_SUBMODID>,BACKUPNUM=<BAC
KUP_NUM>,ENTRYID=<ENTRY_ID>,FILENUM=<HBU_FILENUM>,MODREADY=<MOD_READY>,SMOD
READY=<SMOD_READY>,A2S=<A2S_RECV>,ISPOST=<IS_POST>,POSTRESULT=<POST_RESULT>
"<cr><lf>
;
Response Parameters
Parameter Description
<A2S_RECV> Indicates whether the state of the standby card is changed from
active to standby successfully.
Example
Command
RTRV-BACKUPMOD-INFO:::100;
Response Message
NE 1990-02-07 07:07:36
M 100 COMPLD
"BACKUPMODID=12,BACKUPSUBMODID=0,BACKUPNUM=0,ENTRYID=130,FILENUM=0,MODREADY
=READY,SMODREADY=READY,A2S=RECIEVE,ISPOST=NOTNEED,POSTRESULT=IDLE"
;
Related Commands
None
D.12.12 RTRV-BATCH-PROCESS
Retrieves the batch backup process.
Function
This command retrieves the batch backup process.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-BATCH-PROCESS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf> M^^<ctag>^COMPLD
<cr><lf> ^^^"
PEERONLINE=<HBU_BDONLINE>,VERVERIFY=<VERSION_VERIFY>,SYNCENABLE=<SYNC_ENABL
E>,NESTATE=<NE_STATE>,ASCOM=<AS_COM>,LASTAPPMOD=<LAST_APP_MOD>,DBMSRSPRECV=
<DBMS_RSP_RECV>,DBMSRSPRESLT=<DBMS_RSP_RESULT>,RECORSPRECV=<RECOVER_RSP_REC
V>,RECVERLASTAPP=<RECOVER_LASTMOD>,CFGSTDBYXC=<CFG_STDBY_XC>,POSTRECV=<POST
_RECOVER_RECV>,POSTLASTMOD=<POST_RECOVER_LASTMOD>,SMOOTHLASTAPP=<SMOOTH_LAS
TMOD>,ACTVERINFO=<ACTIVE_VERINFO>,STDVERINFO=<STDBY_VERINFO>"<cr><lf> ;
Response Parameters
Parameter Description
<LAST_APP_MOD> Indicates the last module which reponds to the HBU module.
<RECOVER_LASTMOD> Indicates the ID of the last module of the standby card that
provides the HBU module with the response indicating the end
of the recovery.
<CFG_STDBY_XC> Indicates whether the active card receives the response from the
standby card about the total config take effects.
Example
Command
RTRV-BATCH-PROCESS:::100;
Response Message
NE 1990-02-07 07:07:36 M 100 COMPLD
"PEERONLINE=0,VERVERIFY=SUCCESS,SYNCENABLE=ENABLE,NESTATE=NE_RUNNING,ASCOM=
SUCCESS,LASTAPPMOD=65535,DBMSRSPRECV=NOTREVEIVE,DBMSRSPRESLT=0,RECORSPRECV=
REVEIVE,RECVERLASTAPP=9,CFGSTDBYXC=RECEIVE,POSTRECV=RECEIVE,POSTLASTMOD=655
35,SMOOTHLASTAPP=0,ACTVERINFO= NeSoft(T) 5.51.04.21T01 Platform(D)
050021B012,STDVERINFO= NeSoft(T) 5.51.04.21T01 Platform(D) 050021B012" ;
Related Commands
None
D.12.13 RTRV-SYNC-ENABLE
Retrieves the reason of synchronization enabling or diabling.
Function
This command retrieves the reason of synchronization enabling or diabling.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-SYNC-ENABLE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"HANDLE=<HANDLE>,FILENAME=<FILE_NAME>,FILELINE=<FILE_LINE>"
<cr><lf>
;
Response Parameters
NA
Example
Command
RTRV-SYNC-ENABLE:::100;
Response Message
NE 1990-02-07 07:07:36
M 100 COMPLD
;
Related Commands
None
D.12.14 RTRV-DX-MODE
Retrieves the switching mode.
Function
This command retrieves the switching mode.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-DX-MODE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"SWITCHMODE=<SWITCH_MODE>"<cr><lf>
;
Response Parameters
Parameter Description
<SWITCH_MODE> Indicates the switching mode. The valid values are COLD (reset
occurs after the switching) and WARM (no reset occurs after the
switching).
Example
Command
RTRV-DX-MODE:::100;
Response Message
NE 1990-02-07 07:07:36
M 100 COMPLD
"SWITCHMODE=WARM"
;
Related Commands
None
D.12.15 RTRV-DX-WORK
Retrieves the ID and working status of the active SCC card and the ID and working status of
the standby SCC card.
Function
This command retrieves the ID and working status of the active SCC card and the ID and
working status of the standby SCC card.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-DX-WORK:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"
ACTSLOT=<ACT_SLOT>,ACTWORK=<ACT_WORK>,STDBYSLOT=<STDBY_SLOT>,STDBYWORK=<STD
BY_WORK>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DX-WORK:::100;
Response Message
NE 2006-05-19 11:00:58
M 100 COMPLD
"ACTSLOT=SLOT-1-17,ACTWORK=GOOD,STDBYSLOT=SLOT-1-18,STDBYWORK=GOOD"
;
Related Commands
None
D.12.16 RTRV-DX-EQPT
Retrieves the ID of the active SCC card and the ID of the standby SCC card.
Function
This command retrieves the ID of the active SCC card and the ID of the standby SCC card.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-DX-EQPT:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^" ACTSLOT=<ACT_SLOT>,STDBYSLOT=<STDBY_SLOT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DX-EQPT:::100;
Response Message
NE 2006-05-19 11:00:58
M 100 COMPLD
"ACTSLOT=SLOT-1-17,STDBYSLOT=SLOT-1-18"
;
Related Commands
None
D.12.17 RTRV-HD-STA
Retrieves the hardware status.
Function
This command retrieves the hardware status.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-HD-STA:[<TID>]:<HSCSLOT_NUM>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^" HDSTA=<HD_STA>"<cr><lf>
;
Response Parameters
Parameter Description
Command
RTRV-HD-STA::SLOT-18:100;
Response Message
NE 2006-05-19 11:00:58
M 100 COMPLD
HDSTA=<HF: 2>
;
Related Commands
None
D.12.18 RTRV-AS-ENABLE
Retrieves whether the switching is enabled or disabled.
Function
This command retrieves whether the switching is enabled or disabled.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-AS-ENABLE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^" ASENABLE=<HSCSWENABLE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-AS-ENABLE:::100;
Response Message
NE 2006-05-19 11:00:58
M 100 COMPLD
ASENABLE=ENABLE;
;
Related Commands
None
D.12.19 RTRV-FORCELOCK-SUPPORT
Retrieves the information about whether the forced/locked switching is supported.
Function
This command retrieves the information about whether the forced/locked switching is
supported.
Usage Note
Supported by OSP08 and later versions.
Category
SCC protection switch
Security
Retrieve
Command Syntax
RTRV-FORCELOCK- SUPPORT:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<FORCE_LOCK_SUPPORT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-FORCELOCK-SUPPORT:::100;
Response Message
NE 1990-02-07 07:07:36
M 100 COMPLD
"YES"
;
Related Commands
None
D.12.20 RTRV-MANU-ENABLE
Retrieves the information about whether the switching is enabled or disabled and the reason.
Function
This command retrieves the information about whether the switching is enabled or disabled
and the reason.
Usage Note
None
Category
SCC protection switching
Security
Retrieve
Command Syntax
RTRV-MANU-ENABLE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"
HANDLE=<HSC_HANDLE>,FILENAME=<HSCFILE_NAME>,FILELINE=<HSCFILE_LINE>"<cr><lf
>
;
Response Parameters
Parameter Description
Example
Command
RTRV-MANU-ENABLE:::100;
Response Message
NE 2006-05-19 11:00:58
M 100 COMPLD
;
Related Commands
None
D.12.21 SW-DX-EQPT
Executes SCC protecting switch.
Function
This command executes SCC protecting switch.
Usage Note
None
Category
SCC protection switching
Security
Maintenance
Command Syntax
SW-DX-EQPT:[<TID>]:<HSCSLOT_NUM>:<CTAG>::<HSCSWMODE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
SW-DX-EQPT::SLOT-1-17:100::MANUAL;
Response Message
M 100 COMPLD
;
>
Related Commands
None
ENT-ERPS
Creates ERPS on a card.
Function
This command creates ERPS on a card.
Usage Note
ERPS defines the APS protocol and a protection switching mechanism for an ETH layer
Ethernet ring.
Category
Configuration
Security
Provisioning
Command Syntax
ENT-ERPS:
[<TID>]:<AID>:<CTAG>:::EASTPORT=<EASTPORT>,WESTPORT=<WESTPORT>,RP
LPORT=<RPLPORT>,RPLOWNER=<RPLOWNER>,CTRLVLAN=<CTRLVLAN>,DMA
C=<DMAC>,[GUARDTIME=<GUARDTIME>],[HOLDTIME=<HOLDTIME>],
[WTRTIME=<WTRTIME>],[MEL=<MEL>],[INTERVAL=<INTERVAL>];
Command Parameters
Parameter Description Default Value
<AID> ERPS-<SHELF>-<SLOT>-<ERPS> NA
<EASTPORT> Indicates the east port. The valid values are as follows: NA
1-MAX_ETH_PORT: indicates an Ethernet port.
0x8001-0x8000+MAX_ETH_VCTRUNK: indicates
a VCTRUNK.
The valid formats are as follows:
Parameter Description Default Value
FAC-<SHELF>-<SLOT>-<PORT>
ACC-<SHELF>-<SLOT>-<PORT>
<WESTPORT> Indicates the west port. The valid values are as follows: NA
1-MAX_ETH_PORT: indicates an Ethernet port.
0x8001-0x8000+MAX_ETH_VCTRUNK: indicates
a VCTRUNK.
The valid formats are as follows:
FAC-<SHELF>-<SLOT>-<PORT>
ACC-<SHELF>-<SLOT>-<PORT>
<RPLOWNER> Indicates the RPL owner flag. The valid values are as NOTOWNER
follows:
NOTOWNER: indicates that it is not an
RPLOWNER.
OWNER: indicates that it is an RPLOWNER.
<CTRLVLAN> Indicates the VLAN that carries the control message of the NA
ERPS protocol. The valid value ranges from 1 to 4094. This
parameter cannot be the same as a service VLAN.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-ERPS::ERPS-1-1-1:100:::EASTPORT=FAC-1-1-2,WESTPORT=FAC-1-1-
3,RPLPORT=FAC-1-1-2,RPLOWNER=OWNER,CTRLVLAN=1,DMAC=01-19-A7-00-00-
01,GUARDTIME=500,HOLDTIME=100,WTRTIME=5,MEL=4,INTERVAL=5;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-ERPS
DLT-ERPS
RTRV-ERPS
ED-ERPS
Edits ERPS attributes.
Function
This command edits ERPS attributes.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-ERPS:[<TID>]:<AID>:<CTAG>:::[CTRLVLAN=<CTRLVLAN>],[DMAC=<DMAC>],
[GUARDTIME=<GUARDTIME>],[HOLDTIME=<HOLDTIME>],
[WTRTIME=<WTRTIME>],[MEL=<MEL>],[INTERVAL=<INTERVAL>];
Command Parameters
Parameter Description Default Value
<CTRLVLAN> Indicates the VLAN that carries the control message of the NA
ERPS protocol.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-ERPS::ERPS-1-1-1:100:::CTRLVLAN=1,DMAC=01-19-A7-00-00-
01,GUARDTIME=500,HOLDTIME=100,WTRTIME=5,MEL=4,INTERVAL=5;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-ERPS
DLT-ERPS
RTRV-ERPS
RTRV-ERPS
Retrieves ERPS attributes.
Function
This command retrieves ERPS attributes.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-ERPS:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::EASTPORT=<EASTPORT>,WESTPORT=<WESTPORT>,RPLPORT=<RPLPORT>,RPLOWN
ER=<RPLOWNER>,CTRLVLAN=<CTRLVLAN>,DMAC=<DMAC>,NODEID=<NODEID>,
[LASTREQUEST=<LASTREQUEST>],[RECVPKTRB=<RECVPKTRB>],
[RECVPKTDNF=<RECVPKTDNF>],[FSMSTATE=<FSMSTATE>],
[RECVPKTNODEID=<RECVPKTNODEID>],[GUARDTIME=<GUARDTIME>],
[HOLDTIME=<HOLDTIME>],[WTRTIME=<WTRTIME>],[MEL=<MEL>],
[INTERVAL=<INTERVAL>]"<cr><lf>
;
Response Parameters
Parameter Description
<EASTPORT> Indicates the east port. The valid formats are as follows:
FAC-<SHELF>-<SLOT>-<PORT>
ACC-<SHELF>-<SLOT>-<PORT>
<WESTPORT> Indicates the west port. The valid formats are as follows:
FAC-<SHELF>-<SLOT>-<PORT>
ACC-<SHELF>-<SLOT>-<PORT>
<RPLPORT> Indicates the RPL port. The valid formats are as follows:
FAC-<SHELF>-<SLOT>-<PORT>
ACC-<SHELF>-<SLOT>-<PORT>
0xFFFF: indicates an invalid port.
<RPLOWNER> Indicates the enable status of RPLOwner. The valid values are Y(1) and
N(0). The default value is N(0).
<CTRLVLAN> Indicates the identifier of the VLAN for control message of the ERPS
protocol.
<LASTREQUEST> Indicates the type of the most recent ERPS switching request. The valid
values are as follows:
RAPS(NR): a ring network automatic protection switching (RAPS)
message indicating no request
RAPS(NR,RB): an RAPS message indicating no request and that
the ring protection link is blocked
WTR-RUNNING: a message indicating that the WTR timer is in a
running state.
WTR-EXPIRES: a message indicating that the WTR timer has
timed out
RAPS(SF): an RAPS message indicating a signal failure
LOCAL-SF: a message indicating a signal failure on the local node
LOCAL-CLEAR-SF: a message indicating that the signal failure
on the local node is cleared
INITIAL-REQUEST: the initial request
<RECVPKTRB> Indicates the RB status on the current ring. The valid values are as follows:
NORB
RB
<RECVPKTDNF> Indicates whether the DNF status is contained in a remote request. The
valid values are as follows:
NODNF
DNF
<FSMSTATE> Indicates the status of the state machine on the current node.
IDLE
PROTECTION
<RECVPKTNODEID> Indicates the source node of the switching request, that is, the source MAC
address of the switching.
Example
Command
RTRV-ERPS::ERPS-1-1-10:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"ERPS-1-1-1:: EASTPORT=FAC-1-1-2, WESTPORT=FAC-1-1-3, RPLPORT=FAC-1-1-2,
RPLOWNER=OWNER,CTRLVLAN=1,DMAC=01-19-A7-00-00-01, NODEID=01-19-A7-00-00-
01,LASTREQUEST= LOCAL-SF,RECVPKTRB=RB,RECVPKTDNF=DNF,FSMSTATE= PROTECTION,
RECVPKTNODEID =01-80-C2-00-00-
00,GUARDTIME=500,HOLDTIME=100,WTRTIME=5,MEL=4,INTERVAL=5"
;
Related Commands
ENT-ERPS
ED-ERPS
DLT-ERPS
DLT-ERPS
Deletes ERPS.
Function
This command deletes ERPS on a card.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-ERPS:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf> ;
Response Parameters
None
Example
Command
DLT-ERPS::ERPS-1-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-ERPS
ED-ERPS
RTRV-ERPS
REPT^EVT^ERPS
Reports the switching state of ERPS.
Function
This command reports the switching state of ERPS.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
A^^<ATAG>^REPT^EVT^ERPS<cr><lf>
^^^"<AID>:<REQUEST>,<STATE>" <cr><lf>
;
Response Parameters
Parameter Description
<REQUEST> Indicates the type of the most recent ERPS switching request. The valid
values are as follows:
RAPS(NR): a ring network automatic protection switching (RAPS)
message indicating no request
RAPS(NR,RB): an RAPS message indicating no request and that
the ring protection link is blocked
WTR-RUNNING: a message indicating that the WTR timer is in a
running state.
WTR-EXPIRES: a message indicating that the WTR timer has
timed out
RAPS(SF): an RAPS message indicating a signal failure
LOCAL-SF: a message indicating a signal failure on the local node
LOCAL-CLEAR-SF: a message indicating that the signal failure on
the local node is cleared
INITIAL-REQUEST: the initial request
Example
Command
RTRV-ERPS::ERPS-1-1-1:100;
Response Message
NE 2003-02-28 12:23:20
A 100 REPT EVT ERPS
"ERPS-1-1-2: Local SF, Protection "
;
Related Commands
None
D.13.2 Configuring LAG
This section lists the commands used to configure the LAG function.
ENT-LAG
Creates a link aggregation group (LAG).
Function
This command creates a LAG in the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-LAG:[<TID>]:<AID>:<CTAG>:::[TYPE=<TYPE>],[BALANCE=<BALANCE>],
[SLVPORTS=<SLVPORTS>],[NAME=<NAME>],
[LAGSHAREMODE=<LAGSHAREMODE>],[LAGHOTIME=<LAGHOTIME>];
Command Parameters
Parameter Description Default Value
string of 0 to 31 bytes.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-LAG::ACC-1-3-1:100:::TYPE=MANUAL,BALANCE=Y,SLVPORTS=ACC-1-3-
2,NAME=HUAWEI,LAGSHAREMODE=IP,LAGHOTIME=500;
Response Message
NE 2005-08-05 16:55:00
M 100 COMPLD
;
Related Commands
ED-LAG
DLT-LAG
RTRV-LAG
ED-LAG
Edits a LAG (link aggregation group).
Function
This command modifies the attributes of the LAG in the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-LAG:[<TID>]:<AID>:<CTAG>:::[SLVPORTS=<SLVPORTS>],[NAME=<NAME>],
[LAGSHAREMODE=<LAGSHAREMODE>],[LAGHOTIME=<LAGHOTIME>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-LAG::ACC-1-3-1:100:::SLVPORTS=ACC-1-3-
2,NAME=HUAWEI,LAGSHAREMODE=IP,LAGHOTIME=500;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-LAG
DLT-LAG
RTRV-LAG
DLT-LAG
Deletes a link aggregation group (LAG).
Function
This command deletes a LAG in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-LAG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-LAG::FAC-1-12-4:1;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-LAG
ED-LAG
RTRV-LAG
RTRV-LAG
Retrieves the attributes of a link aggregation group (LAG).
Function
This command retrieves the attributes of a LAG in a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-LAG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Supports ALL.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[TYPE=<TYPE>],[BALANCE=<BALANCE>],[SLVPORTS=<SLVPORTS>],
[REFPORT=<REFPORT>],[LOCSYSPRI=<LOCSYSPRI>],[LOCSYSMAC=<LOCSYSMAC>],
[DSTSYSPRI=<DSTSYSPRI>],[DSTSYSMAC=<DSTSYSMAC>],[SELECTED=<SELECTED>],
[STANDBY=<STANDBY>],[LOCPORT=<LOCPORT>],[WORKSTATE=<WORKSTATE>],
[LOCPORTSTA=<LOCPORTSTA>],[LOCPORTPRI=<LOCPORTPRI>],
[LOCOPRKEY=<LOCOPRKEY>],[LOCLACP=<LOCLACP>],[DSTPORT=<DSTPORT>],
[DSTPORTPRI=<DSTPORTPRI>],[DSTOPRKEY=<DSTOPRKEY>],[DSTLACP=<DSTLACP>],
[ACTPORTS=<ACTPORTS>],[NAME=<NAME>]"<cr><lf>
;
Response Parameters
Parameter Description
<WORKSTATE> Indicates the status of the local LAG port. The valid values are Y and N.
<LOCPORTSTA> Indicates the local port state. The valid values are SELECTED, STANDBY
and UNSELECTED.
<LOCLACP> Indicates the local Link Aggregation Control Protocol (LACP) state.
The valid value ranges from 0 to 255.
<NAME> Indicates the name of the LAG. The valid value is a string of 0 to 31 bytes.
Example
Command
RTRV-LAG::FAC-1-12-4:1;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"FAC-1-1-1::TYPE=MANUAL,BALANCE=Y,SLVPORTS=FAC-1-2-1,REFPORT=FAC-1-
3,LOCSYSPRI=32768,LOCSYSMAC=00-00-00-00-00-01,DSTSYSPRI=32768,DSTSYSMAC=00-
00-00-00-00-02,SELECTED=1,STANDBY=0,LOCPORT=FAC-1-1-
2,WORKSTATE=Y,LOCPORTSTA=SELECTED,LOCPORTPRI=32768,LOCLACP=ENABLE,DSTPORT=F
AC-1-1-2,DSTPORTPRI=32768,DSTLACP=ENABLE,ACTPORTS=FAC-1-1-1&FAC-1-1-
2,NAME=HUAWEI"
;
Related Commands
ENT-LAG
ED-LAG
DLT-LAG
ED-LAGSYS
Edits system attributes of a link aggregation group (LAG).
Function
This command modifies the attributes of a LAG.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-LAGSYS:[<TID>]:<AID>:<CTAG>:::[PRIORITY=<PRIORITY>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-LAGSYS::SLOT-1-14:100:::PRIORITY=1;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
RTRV-LAGSYS
RTRV-LAGSYS
Retrieves the attributes of a LAG system.
Function
This command retrieves the attributes of a LAG system.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-LAGSYS:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<SLOT>::[PRIORITY=<PRIORITY>],[MAC=<MAC>]"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-LAGSYS::SLOT-1-ALL:100;
RTRV-LAGSYS::SLOT-1-1:100;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"SLOT-1-1::PRIORITY=1,MAC=00-00-00-00-00-01"
;
Related Commands
ED-LAGSYS
ED-LAGPORT
Edits ports in a link aggregation group (LAG).
Function
This command modifies attributes of ports in a LAG.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-LAGPORT:[<TID>]:<AID>:<CTAG>:::PRIORITY=<PRIORITY>;
Command Parameters
Parameter Para Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-LAGPORT::FAC-1-1-4:100:::PRIORITY=1;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
RTRV-LAGPORT
RTRV-LAGPORT
Retrieves the port attributes of a link aggregation group (LAG).
Function
This command retrieves the port attributes of a LAG.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-LAGPORT:<TID>:[<AID>]:<CTAG>:::[FRAMETYPE=<FRAMETYPE>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[LOCSYSPRI=<LOCSYSPRI>],[LOCSYSMAC=<LOCSYSMAC>],
[PRIORITY=<PRIORITY>],[KEY=<KEY>],[LOCLACP=<LOCLACP>],
[DSTSYSPRI=<DSTSYSPRI>],[DSTSYSMAC=<DSTSYSMAC>],[DSTPORT=<DSTPORT>],
[DSTPRI=<DSTPRI>],[DSTKEY=<DSTKEY>],[DSTLACP=<DSTLACP>],
[<RCVLACPDUNUM>=<RCVLACPDUNUM>],[<RCVERRLACPDUNUM >=<RCVERRLACPDUNUM>],
[<SNDLACPDUNUM>=<SNDLACPDUNUM>]"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the Ethernet facility which is composed of the slot number
and port ID.
The valid formats are as follows:
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>
ACC-<SHELF ID>-<SLOT ID>-<PORT ID>
<LOCLACP> Indicates the local LACP (link aggregation control protocol) state.
The valid value ranges from 0 to 255.
Command
RTRV-LAGPORT::FAC-1-1-ALL:100;
RTRV-LAGPORT::FAC-1-1-4:100:::FRAMETYPE=RCVLACPDU;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"FAC-1-1-5::LOCSYSPRI=32768,LOCSYSMAC=00-00-ef-10-38-
10,PRIORITY=32768,KEY=257,LOCLACP=71,DSTSYSPRI=32768,DSTSYSMAC=00-00-00-00-
00-
00,DSTPRI=32768,DSTKEY=0,DSTLACP=48,RCVLACPDUNUM=0,RCVERRLACPDUNUM=0,SNDLAC
PDUNUM=0"
;
Related Commands
ED-LAGPORT
INIT-LAGPORT
Initializes the port attributes of a LAG.
Function
This command initiates the port attributes of a LAG.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
INIT-LAGPORT:[<TID>]:<AID>:<CTAG>:::[FRAMETYPE=<FRAMETYPE>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the Ethernet facility of the slot number and port NA
ID.
The valid formats are as follows:
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>
ACC-<SHELF ID>-<SLOT ID>-<PORT ID>
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-LAGPORT::FAC-1-1-1:100:::FRAMETYPE=ALL;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ED-LAGPORT
RTRV-LAGPORT
ENT-DLAG
Creates a distributed link aggregation group (DLAG).
Function
This command creates a DLAG between two units.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-DLAG:[<TID>]:<AID>:<CTAG>:::[MSTPORTPRI=<MSTPORTPRI>],
[SLVPORT=<SLVPORT>],[SLVPORTPRI=<SLVPORTPRI>],[NAME=<NAME>],
[SYSPRI=<SYSPRI>],[RVRTV=<RVRTV>];
Command Parameters
Parameter Description Default Value
<MSTPORTPRI> Indicates the priority of the master port on the LAG. 32768
The port with the higher priority is the master port if a LAG
involves two or more cards.
The valid value ranges from 0 to 65535.
<SLVPORTPRI> Indicates the priority of the slave port on the LAG. 32768
The valid value ranges from 0 to 65535.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-DLAG::FAC-1-1-3:100:::MSPORTPRI=8,SLVPORT=FAC-1-1-
4,SLVPORTPRI=8,NAME=aaa,SYSPRI=9,RVRTV=N;
Response Message
NE 2008-08-05 16:55:00
M 100 COMPLD
;
Related Commands
ED-DLAG
DLT-DLAG
RTRV-DLAG
ED-DLAG
Edits a distributed link aggregation group (DLAG).
Function
This command modifies the attributes of a DLAG between two units.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-DLAG:[<TID>]:<AID>:<CTAG>:::[MSTPORTPRI=<MSTPORTPRI>],
[SLVPORTPRI=<SLVPORTPRI>],[NAME=<NAME>],[SYSPRI=<SYSPRI>],
[RVRTV=<RVRTV>];
Command Parameters
Parameter Description Default Value
<MSTPORTPRI> Indicates the priority of the master port on the LAG. 32768
Parameter Description Default Value
The port with the higher priority is the master port if a LAG
involves two or more cards.
The valid value ranges from 0 to 65535.
<SLVPORTPRI> Indicates the priority of the slave port on the LAG. 32768
The valid value ranges from 0 to 65535.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-DLAG::FAC-1-1-3-4:100:::MSTPORTPRI=8,SLVPORTPRI=8,NAME=DLAG-
A,SYSPRI=9,RVRTV=n;
Response Message
NE 2005-08-05 16:55:00
M 100 COMPLD
;
Related Commands
ENT-DLAG
DLT-DLAG
RTRV-DLAG
DLT-DLAG
Deletes a distributed link aggregation group (DLAG).
Function
This command deletes a DLAG between two units.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-LAG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-DLAG::FAC-1-1-10:100;
Response Message
NE 2004-07-10 15:33:17
M 10 COMPLD
;
Related Commands
ENT-DLAG
ED-DLAG
RTRV-DLAG
RTRV-DLAG
Retrieves the information about a distributed link aggregation group (DLAG).
Function
This command retrieves the attributes of a DLAG between two units.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-DLAG:[<TID>]:<AID>:<CTAG>:::[FRAMETYPE=<FRAMETYPE>];
Command Parameters
<FRAMETYPE> Indicates the frame type. The valid value are as follows: ALL
RCVLACPDU
RCVERRLACPDU
SNDLACPDU
ALL
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"::[MSTPORT=<MSTPORT>],[MSTPORTPRI=<MSTPORTPRI>],[SLVPORT=<SLVPORT>],
[SLVPORTPRI=<SLVPORTPRI>],[NAME=<NAME>],[SYSPRI=<SYSPRI>],
[SYSMAC=<SYSMAC>],[RVRTV=<RVRTV>],[WORKPORT=<WORKPORT>],
[LOCMSTPORT=<LOCMSTPORT>],[LOCMSTPORTSTA=<LOCMSTPORTSTA>],
[LOCMSTPORTPRI=<LOCMSTPORTPRI>],[LOCMSTOPRKEY=<LOCMSTOPRKEY>],
[LOCMSTLACP=<LOCMSTLACP>], [DSTSYSPRI=<DSTSYSPRI>],[DSTSYSMAC=<DSTSYSMAC>],
[DSTMSTPORT=<DSTMSTPORT>],[DSTMSTPORTPRI=<DSTMSTPORTPRI>],
[DSTMSTOPRKEY=<DSTMSTOPRKEY>],[DSTMSTLACP=<DSTMSTLACP>],
[LOCSLVPORT=<LOCSLVPORT>],[LOCSLVPORTSTA=<LOCSLVPORTSTA>],
[LOCSLVPORTPRI=<LOCSLVPORTPRI>],[LOCSLVOPRKEY=<LOCSLVOPRKEY>],
[LOCSLVLACP=<LOCSLVLACP>],[DSTSLVPORT=<DSTSLVPORT>],
[DSTSLVPORTPRI=<DSTSLVPORTPRI>],[DSTSLVOPRKEY=<DSTSLVOPRKEY>],
[DSTSLVLACP=<DSTSLVLACP>],[SHAREMODE=<SHAREMODE>],
[<MSTRCVLACPDUNUM>=<MSTRCVLACPDUNUM>],
[<MSTRCVERRLACPDUNUM>=<MSTRCVERRLACPDUNUM>],
[<MSTSNDLACPDUNUM>=<MSTSNDLACPDUNUM>],
[<SLVRCVLACPDUNUM>=<SLVRCVLACPDUNUM>],
[<SLVRCVERRLACPDUNUM>=<SLVRCVERRLACPDUNUM>],
[<SLVSNDLACPDUNUM>=<SLVSNDLACPDUNUM>]"<cr><lf>;
Response Parameters
Parameter Para Description
<NAME> Indicates the name of the DLAG. The valid format is a string of 0
to 31 bytes.
<RVRTV> Indicates the revertive mode. The valid values are Y (revertive
mode) and N (non-revertive mode).
<LOCMSTPORTSTA> Indicates the local master port state. The valid values are
SELECTED and STANDBY.
<DSTMSTLACP> Indicates the destination master LACP state. The valid values are
ENABLE and DISABLE.
<LOCSLVPORTSTA> Indicates the local slave port state. The valid values are
SELECTED and STANDBY.
<LOCSLVLACP> Indicates the local slave LACP state. The valid values are
ENABLE and DISABLE.
<DSTSLVLACP> Indicates the destination slave LACP state. The valid values are
ENABLE and DISABLE.
<SHAREMODE> Indicates the share mode. The valid values are SHARE and
NONSHARE.
Example
Command
RTRV-DLAG::FAC-2-5-5:C;
Response Message
NE 2008-08-25 18:38:24
M C COMPLD
"FAC-3-11::MSPORTPRI=8,SLVPORT=FAC-4-
11,SLVPORTPRI=8,NAME=aaa,SYSPRI=9,SYSMAC=00-ab-ca-ef-12-
34,RVRTV=Y,WORKPORT=FAC-0-0,LOCMSTPORT=FAC-3-
11,LOCMSTPORTSTA=UNSELECTED,LOCMSTPORTPRI=8,LOCMSTOPRKEY=33025,LOCMSTLACP=7
1,DSTSYSPRI=32768,DSTSYSMAC=00-00-00-00-00-
00,DSTMSTPORTPRI=32768,DSTMSTOPRKEY=0,DSTMSTLACP=48,LOCSLVPORT=FAC-4-
11,LOCSLVPORTSTA=UNSELECTED,LOCSLVPORTPRI=8,LOCSLVOPRKEY=33025,LOCSLVLACP=7
1,DSTSLVPORTPRI=32768,DSTSLVOPRKEY=0,DSTSLVLACP=48,SHAREMODE=NONSHARE"
;
Related Commands
ENT-DLAG
ED-DLAG
DLT-DLAG
DLT-MCLAG
Deletes a multi-chassis link aggregation group (MC-LAG).
Function
This command deletes an MC-LAG.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MCLAG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-MCLAG::FAC-1-1-3:100;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MCLAGENT-LAG
ED-MCLAGED-LAG
RTRV-MCLAGRTRV-LAG
ED-MCLAG
Modifies a multi-chassis link aggregation group (MC-LAG).
Function
This command modifies an MC-LAG.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-MCLAG:[<TID>]:<AID>:<CTAG>:::[MCSP=<MCSP>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[ASSPORT=<ASSPORT>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-MCLAG::FAC-1-1-3:100:::MCSP=ACC-1-1-1,RVRTV=N,RVTM=0,ASSPORT=FAC-1-1-5;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MCLAGENT-LAG
RTRV-MCLAGDLT-LAG
DLT-MCLAGRTRV-LAG
ENT-MCLAG
Creates a multi-chassis link aggregation group (MC-LAG).
Function
This command creates an MC-LAG.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MCLAG:[<TID>]:<AID>:<CTAG>:::RMTLAG=<RMTLAG>,MCSP=<MCSP>,
[PROTTYPE=<PROTTYPE>],[RVRTV=<RVRTV>],[RVTM=<RVTM>],
[ASSPORT=<ASSPORT>];
Command Parameters
Parameter Description Default Value
<PROTTYPE> Indicates the type of protection that can be configured with ERPS
MC-LAG.
ERPS
MSSNCP
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MCLAG::FAC-1-1-1:100:::RMTLAG=FAC-5,MCSP=ACC-1-1-
1,PROTTYPE=ERPS,RVRTV=Y,RVTM=0,ASSPORT=FAC-1-1-3;
Response Message
NE 2005-08-05 16:55:00
M 100 COMPLD
;
Related Commands
ED-MCLAGED-LAG
RTRV-MCLAGDLT-LAG
DLT-MCLAGRTRV-LAG
RTRV-MCLAG
Query an MC-LAG.
Function
This command query an MC-LAG.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MCLAG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::RMTLAG=<RMTLAG>,MCSP=<MCSP>,PROTTYPE=<PROTTYPE>,[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[ASSPORT=<ASSPORT>],[MCLAGSTAT=<MCLAGSTAT>],
[LAGSTAT=<LAGSTAT>]"<cr><lf>
;
Response Parameters
Parameter Description
<PROTTYPE> Indicates the type of protection that can be configured with MC-LAG.
ERPS
MSSNCP
<MCLAGSTAT> Indicates the working status of the MC-LAG. The local LAG cooperates
with the remote LAG when the communication between them is normal.
They work independently and the client equipment selectively receives
services when the communication between them is abnormal.
COLLABORATIVE: The local LAG cooperates with the remote LAG.
INDEPENDENT: The local LAG and remote LAG work independently.
Example
Command
RTRV-MCLAG::FAC-1-2-3:100;
RTRV-MCLAG::FAC-1-2-ALL:100;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"FAC-1-1-1::RMTLAG=FAC-1-1-1,MCSP=ACC-1-1-
1,PROTTYPE=ERPS,RVRTV=Y,RVTM=5,ASSPORT=FAC-1-1-2&FAC-1-1-
3,MCLAGSTAT=COLLABORATIVE,LAGSTAT=ACTIVE"
;
Related Commands
ENT-MCLAGENT-LAG
ED-MCLAGED-LAG
DLT-MCLAGDLT-LAG
DLT-MCSP
Deletes a multi-chassis service path (MCSP).
Function
This command deletes an MCSP.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MCSP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-MCSP::FAC-1-1-4:100;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MCSPENT-LAG
ED-MCSPED-LAG
RTRV-MCSPRTRV-LAG
ED-MCSP
Modifies a multi-chassis service path (MCSP).
Function
This command modifies an MCSP.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-MCSP:[<TID>]:<AID>:<CTAG>:::[MONTM=<MONTM>];
Command Parameters
Parameter Description Default Value
<MONTM> Indicates the interval for sending Hello packets that are 1
used for monitoring faults.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-MCSP::FAC-1-1-3:100:::MONTM=10;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MCSPENT-LAG
RTRV-MCSPDLT-LAG
DLT-MCSPRTRV-LAG
ENT-MCSP
Creates a multi-chassis synchronization protocol (MCSP).
Function
This command creates an MCSP.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MCSP:[<TID>]:<AID>:<CTAG>:::COMMFLAG=<COMMFLAG>,
[MONTM=<MONTM>];
Command Parameters
Parameter Description Default Value
<MONTM> Indicates the interval for sending Hello packets that are 1
used for monitoring faults.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MCSP::FAC-1-1-3:100:::MONTM=10;
Response Message
NE 2005-08-05 16:55:00
M 100 COMPLD
;
Related Commands
ED-MCSPED-LAG
RTRV-MCSPDLT-LAG
DLT-MCSPRTRV-LAG
RTRV-MCSP
Queries an MCSP.
Function
This command queries an MCSP.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MCSP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Parameters
Parameter Description
<COMMFLAG> Indicates the MCSP number. The MCSP number is unique on each board.
The local MSCP can communicate with the peer MCSP only when they
have the same number.
The value ranges from 1 to MAX_ETH_MCSP.
Note: MAX_ETH_MCSP indicates the maximum number of
MCSPs that can be configured on a board.
<MONTM> Indicates the interval for sending Hello packets that are used for monitoring
faults.
Example
Command
RTRV-MCSP::ACC-1-2-3:100;
RTRV-MCSP::ACC-1-2-ALL:100;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"FAC-1-1-1::COMMFLAG=1,MONTM=10,STAT=UP"
;
Related Commands
ENT-MCLAGENT-LAG
ED-MCLAGED-LAG
DLT-MCLAGDLT-LAG
INIT-LACP-PKT
Clears statistics on the number of transmitted and received Link Aggregation Control
Protocol (LACP) packets.
Function
This command clears statistics on the number of transmitted and received LACP packets.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
INIT-LACP-PKT:[<TID>]:<AID>:<CTAG>:::PKTTYPE=<PKTTYPE>;
Command Parameters
Parameter Description Default Value
<AID> Indicates the Ethernet facility of the slot number and port NA
ID.
The valid formats are as follows:
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>
ACC-<SHELF ID>-<SLOT ID>-<PORT ID>
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-LACP-PKT::FAC-1-1-1:100:::PKTTYPE=1;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
RTRV-LACP-PKTED-LAGPORT
RTRV-LAGPORT
RTRV-LACP-PKT
Queries statistics on the number of transmitted and received LACP packets.
Function
This command queries statistics on the number of transmitted and received LACP packets.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-LACP-PKT:<TID>:[<AID>]:<CTAG>:::PKTTYPE=<PKTTYPE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::PKTTYPE=<PKTTYPE>,PKTCNT=<PKTCNT>"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the Ethernet facility which is composed of the slot number and port
ID.
The valid formats are as follows:
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>
ACC-<SHELF ID>-<SLOT ID>-<PORT ID>
Example
Command
RTRV-LACP-PKT::FAC-1-1-1:100:::PKTTYPE=1;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"FAC-1-1-1::PKTTYPE=1,PKTCNT=100"
"FAC-1-1-1::PKTTYPE=2,PKTCNT=0"
"FAC-1-1-1::PKTTYPE=3,PKTCNT=10"
Related Commands
INIT-LACP-PKTED-LAGPORT
INIT-LAGSTAT-<FETH/GETH>
Clear the counter of linkagg port.
Function
Clear the counter of linkagg port.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
INIT-LAGSTAT-<FETH/GETH>:
[<TID>]:<AID>:<CTAG>:::FRAMETYPE=<FRAMETYPE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-LAGSTAT-GETH::FAC-1-1-4:100:::FRAMETYPE=RCVLACPDU;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-LAGSTAT-<FETH/GETH>
RTRV-STATE-LAGPORT
Retrieve the state of the state machine in a LAGPORT.
Function
This command retrieves the state of the state machine in a LAGPORT.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RTRV-STATE-LAGPORT:<TID>:[<AID>]:<CTAG>:::[SMTYPE=<SMTYPE>];
Command Parameters
Parameter Description Default Value
MUX(Multiplexer mathine):3
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[SMTYPE=<SMTYPE>],[CURSTATE=<CURSTATE>],[PRESTATE=<PRESTATE>],
[REASON=<REASON>]"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the Ethernet facility which is composed of the slot number and port
ID.
The valid formats are as follows:
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>
ACC-<SHELF ID>-<SLOT ID>-<PORT ID>
<REASON> Indicates why the state of the state machine changes into <CURSTATE>.
Example
Command
RTRV-STATE-LAGPORT::FAC-1-1:100:::SMTYPE=RX;
RTRV-STATE-LAGPORT::FAC-1-ALL:100:::SMTYPE=RX;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"FAC-1-1::SMTYPE=RX,CURSTATE=RXINIT,LSTSTATE=RXINIT,REASON=INITIALIZE"
;
Related Commands
ED-LAGPORT
D.13.3 Configuring STP
This section lists the commands used to configure the STP function.
ED-STP-VB
Edits the spanning tree protocol (STP) of a virtual bridge.
Function
This command modifies the spanning tree protocol of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-STP-VB:[<TID>]:<AID>:<CTAG>:::[STPENABLE=<STPENABLE>],
[STPMODE=<STPMODE>],[BPRI=<BPRI>],[HELLOTIME=<HELLOTIME>],
[MAXAGE=<MAXAGE>],[FWDDELAY=<FWDDELAY>];
Command Parameters
Parameter Description Default Value
<STPMODE> Indicates the working mode of the rapid spanning tree RSTP
protocol (RSTP). The valid values are as follows:
STP: The RSTP operates in the STP compatibility
mode.
RSTP: The RSTP operates normally.
This parameter is required only if the equipment supports
RSTP.
<BPRI> Indicates the priority of the bridge. The valid value ranges NA
from 0 to 65535, among which "0" is the highest priority.
<FWDDELAY> Indicates the time interval for switching the port state, the 15
port state includes: discarding, learning and forwarding.
<FWDDELAY> is a integer. The valid value ranges from
4(s) to 30(s).
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-STP-VB::VB-1-4-
1:100:::STPENABLE=Y,STPMODE=STP,BPRI=1,HELLOTIME=2,MAXAGE=20,FWDDELAY=15;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-STP-VB
INIT-STP-VB
RTRV-STP-VB
Retrieves the attributes of the Spanning Tree Protocol (STP) within a virtual bridge
Function
This command retrieves the attributes of the STP protocol within a virtual bridge.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-STP-VB:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::STPENABLE=<STPENABLE>,STPMODE=<STPMODE>,BPRI=<BPRI>,BMAC=<BMAC>,
HELLOTIME=<HELLOTIME>,ACTHELLOTIME=<ACTHELLOTIME>,MAXAGE=<MAXAGE>,ACTMAXAGE
=<ACTMAXAGE>,FWDDELAY=<FWDDELAY>,ACTFWDDELAY=<ACTFWDDELAY>,DROOTPRI=<DROOTP
RI>,DROOTMAC=<DROOTMAC>,ROOTPATH=<ROOTPATH>,ROOTPORTID=<ROOTPORTID>,HOLDTIM
E=<HOLDTIME>"<cr><lf>
;
Response Parameters
Parameter Description
<STPENABLE> Indicates whether the STP protocol is enabled. The valid values are Y and
N.
<STPMODE> Indicates the work mode of the Rapid Spanning Tree Protocol (RSTP). The
valid values are as follows:
STP: The RSTP operates in STP Compatibility mode.
RSTP: The RSTP operates normally.
This parameter is required only if the equipment supports RSTP.
<BPRI> Indicates the priority of a virtual bridge. The valid value ranges from 0 to
65535, among which "0" is the highest priority.
<ACTHELLOTIME> Indicates the actual HELLOTIME. The valid value ranges from 1(s) to
10(s).
<MAXAGE> Indicates the aging time of the BPDU. It is an integer. The valid value
ranges from 6(s) to 40(s). The initial value is 20(s).
<ACTMAXAGE> The actual MAXAGE. The valid value ranges from 6(s) to 40(s).
<FWDDELAY> Indicates the time interval for switching the port state, the port state
includes: discarding, learning and forwarding. <FWDDELAY>It is an
integer. The valid value ranges from 4(s) to 30(s). The initial value is 15(s).
<ACTFWDDELAY> Indicates the actual FWDDELAY. The valid value ranges from 4(s) to
30(s).
<HOLDTIME> Indicates the period from the latest reset or initialization till the current time.
The valid value ranges from 1 to 10.
Example
Command
RTRV-STP-VB::VB-1-4-1:100;
RTRV-STP-VB::VB-1-4-ALL:101;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-1-4-1::STPENABLE=Y,STPMODE=STP,BPRI=1,BMAC=00-32-0B-0E-10-
0D,HELLOTIME=1,ACTHELLOTIME=1,MAXAGE=20,ACTMAXAGE=20,FWDDELAY=10,ACTFWDDELA
Y=10,MAXINC=2,DROOTPRI=1,DROOTMAC=00-32-0B-0E-10-
0E,ROOTPATH=1,ROOTPORTID=12,HOLDTIME=5"
;
Related Commands
ED-STP-VB
INIT-STP-VB
INIT-STP-VB
Initializes the spanning tree protocol (STP) of a VB.
Function
This command is used to initialize the STP.
This command initializes the STP bridge attributes (such as <STPMODE>,<BPRI>,
<HELLOTIME>, <MAXAGE>, <FWDDELAY>) and STP port attributes (such as
<PORTPRI>, <PATHCOST>, <ADMEDGE>) to retain the default values, which will result
in reforming the topology.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
INIT-STP-VB:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-STP-VB::VB-1-4-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-STP-VB
RTRV-STP-VB
ED-STP-VBLP
Edits parameters of the spanning tree protocol within a VBLP.
Function
This command modifies the parameters of the spanning tree protocol within a VBLP.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-STP-VBLP:[<TID>]:<AID>:<CTAG>:::[STPPORTENABLE=<STPPORTENABLE>],
[PORTPRI=<PORTPRI>],[PATHCOST=<PATHCOST>],[ADMEDGE=<ADMEDGE>],
[AUTOEDGEDETECTEN =<AUTOEDGEDETECTEN>];
Command Parameters
Parameter Description Default
Value
<PORTPRI> Indicates the priority of the port. The valid value 128
ranges from 0 to 240,and can be divided by 16.among
which "0" is the highest priority.
Parameter Description Default
Value
<PATHCOST> Indicates the path cost of the root bridge. For Ethernet
For cards compliant with [802.1w] standard, the valid interface: 19
value ranges from 1 to 65535. For VC-Trunk
For cards compliant with [802.1D] standard, the valid interface: 4
value ranges from 1 to 200000000.
The default values vary depending on the interfaces.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-STP-VBLP::VBLP-1-1-1-
3:100:::STPPORTENABLE=Y,PORTPRI=128,PATHCOST=19,ADMEDGE=N;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-STP-VBLP
RTRV-STP-VBLP
Retrieves parameters of the STP protocol within a VBLP.
Function
This command instructs an NE to retrieve the parameters of the STP protocol within a VBLP.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-STP-VBLP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::STPPORTENABLE=<STPPORTENABLE>,PORTPRI=<PORTPRI>,PATHCOST=<PATHCO
ST>,ACTPATHCOST=<ACTPATHCOST>,ADMEDGE=<ADMEDGE>,ACTADMEDGE=<ACTADMEDGE>,POR
TID=<PORTID>,PORTSTATE=<PORTSTATE>,DPORTID=<DPORTID>,DROOTPRI=<DROOTPRI>,DR
OOTMAC=<DROOTMAC>,DCOST=<DCOST>,DBPRI=<DBPRI>,DBMAC=<DBMAC>,UPTIME=<UPTIME>
,AUTOEDGEDETECTEN=<AUTOEDGEDETECTEN>"<cr><lf>
;
Response Parameters
Parameter Description
<STPPORTENABLE> Indicates whether the VBLP is enabled. The valid value can be Y or
N.
<PORTPRI> Indicates the priority of a VBLP. The valid value ranges from 0 to
255, among which "0" is the highest priority and "128" is the initial
value.
<PATHCOST> It is an integer. The valid values range from 1 to 65535. The initial
value varies depending on the device.
Parameter Description
<PORTSTATE> Indicates the current state of a VBLP. The valid values are as
follows:
DISABLE
LISTENING
LEARNING
FORWARDING
BLOCKING
DISCARDING
<UPTIME> Indicates the time elapsed since the port was last reset or initialized.
The value is expressed in seconds.
<AUTOEDGEDETECTEN> Indicates the enabling flag of automatic edge detection. The valid
values are ENABLE and DISABLE (default).
Example
Command
RTRV-STP-VBLP::VBLP-1-1-1-3:100;
RTRV-STP-VBLP::VBLP-1-1-1-ALL:101;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VBLP-1-1-1-
3::STPPORTENABLE=Y,PORTPRI=128,PATHCOST=19,ACTPATHCOST=19,ADMEDGE=N,ACTADME
DGE=N,PORTID=10,PORTSTATE=FORWARDING,DPORTID=12,DROOTPRI=1,DROOTMAC=00-32-
0B-0E-10-0D,DCOST=30,DBPRI=4,DBMAC=00-32-0B-0E-10-
0E,UPTIME=50,AUTOEDGEDETECTEN=DISABLE"
;
Related Commands
ED-STP-VBLP
SW-STP-VBLP
Switches the STP state of the VBLP.
Function
This command switches the STP state of the VBLP to send bridge protocol data unit (BPDU)
of the rapid spanning tree protocol (RSTP) to the interconnected network.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
SW-STP-VBLP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
SW-STP-VBLP::VBLP-1-1-1-3:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
None
REPT^EVT^VBLP
Reports the STP state of a virtual bridge logical port (VBLP).
Function
This command is used for an NE to report the STP state of a VBLP.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
A^^<ATAG>^REPT^EVT^VBLP<cr><lf>
^^^"<AID>:<CONDYPE>,<CONDEFF>" <cr><lf> ;
Response Parameters
Parameter Description
<CONDYPE> Indicates the type of the event. The valid values are as follows:
STPPORT-DISABLE (0)
STPPORT-LISTENING (1)
STPPORT-LEARNING (2)
STPPORT-FORWARDING (3)
STPPORT-BLOCKING (4)
STPPORT-DISCARDING (5)
<CONDEFF> Indicates the impact of the event on the NE. The valid value is TC.
Example
Command
None
Response Message
NE 2003-02-28 12:23:20
A 100 REPT EVT VBLP
"VBLP-1-1-1-2-3:STPPORT-DISABLE,TC"
;
Related Commands
None
ENT-VLANSNCP-PG
Creates a VLAN SNCP group.
Function
This command creates a VLAN SNCP protection group.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-VLANSNCP-PG:
[<TID>]::<CTAG>:::WORKLINKFROM=<WORKLINKFROM>,WORKLINKTO=<WO
RKLINKTO>,[WORKLINKINTAG=<WORKLINKINTAG>],
[WORKLINKINSTAG=<ORKLINKINSTAG>],BACKUPLINKFROM=<BACKUPLINK
FROM>,BACKUPLINKTO=<BACKUPLINKTO>,
[BACKUPLINKINTAG=<BACKUPLINKINTAG>],
[BACKUPLINKINSTAG=<BACKUPLINKINSTAG>],[SOURCEIP =<SOURCEIP>],
[RVRTV =<RVRTV>],[RVTM=<RVTM>],[HOLDOFFTIME=<HOLDOFFTIME>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-VLANSNCP-PG:::100:::WORKLINKFROM=FAC-1-3-4,WORKLINKTO=FAC-1-3-
5,WORKLINKINTAG=1,BACKUPLINKFROM=FAC-1-3-6,BACKUPLINKTO=FAC-1-3-
5,BACKUPLINKINTAG=1,RVRTV=N,RVTM=0;
Response Message
NE 2008-08-25 18:54:51
M 100 COMPLD
;
Related Commands
ED-VLANSNCP-PG
DLT-VLANSNCP-PG
RTRV-VLANSNCP-PG
ED-VLANSNCP-PG
Edits the parameters of a VLAN SNCP group.
Function
This command edits the parameters of a VLAN SNCP group.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-VLANSNCP-PG:
[<TID>]::<CTAG>:::LINKFROM=<LINKFROM>,LINKTO=<WORKLINKTO>,
[LINKINTAG=<LINKINTAG>],[LINKINSTAG=<LINKINSTAG>],[RVRTV=<RVRTV>],
[RVTM=<RVTM>],[HOLDOFFTIME=<HOLDOFFTIME>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-VLANSNCP-PG:::10:::LINKFROM=FAC-1-3-4,LINKTO=FAC-1-3-
5,LINKINTAG=1,RVRTV=Y,HOLDOFFTIME=100;
Response Message
NE 2003-02-28 12:23:20
M 10 COMPLD
;
Related Commands
ENT-VLANSNCP-PG
DLT-VLANSNCP-PG
RTRV-VLANSNCP-PG
RTRV-VLANSNCP-PG
Retrieves the parameters of a VLAN SNCP group.
Function
This command retrieves the parameters of a VLAN SNCP group.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-VLANSNCP-PG:[<TID>]::<CTAG>:::LINKFROM =<LINKFROM>,LINKTO =
<LINKTO>,[LINKINTAG =<LINKINTAG>],[LINKINSTAG =<LINKINSTAG>]
Command Parameters
Parameter Description Default Value
<LINKFROM> Indicates the source of the working link. The valid value NA
is FAC/ACC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<LINKTO> Indicates the sink of the working link. The valid value is NA
FAC/ACC-<SHELF ID>-<SLOT ID>-<PORT ID>.
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<WORKLINKFROM>,<WORKLINKTO>,<BACKUPLINKFROM>,<BACKUPLINKTO>::
[WORKLINKINTAG=<WORKLINKINTAG>],[WORKLINKINSTAG=<WORKLINKINSTAG>],
[WORKLINKSTATE=<WORKLINKSTATE>],[BACKUPLINKINTAG=<BACKUPLINKINTAG>],
[BACKUPLINKINSTAG=<BACKUPLINKINSTAG>],[BACKUPLINKSTATE=<BACKUPLINKSTATE>],
[RVRTV=<RVRTV>],[RVTM=<RVTM>],[HOLDOFFTIME=<HOLDOFFTIME>],
[SWSTATE=<SWSTATE>],[ACTIVELINK=<ACTIVELIKE>]"<cr><lf>
Response Parameters
Parameter Description
<WORKLINKFROM> Indicates the source of the working link. The valid format is
FAC/ACC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<WORKLINKTO> Indicates the sink of the working link. The valid format is FAC/ACC-
<SHELF ID>-<SLOT ID>-<PORT ID>.
<BACKUPLINKFROM> Indicates the source of the backup link. The valid format is FAC/ACC-
<SHELF ID>-<SLOT ID>-<PORT ID>.
<BACKUPLINKTO> Indicates the sink of the backup link. The valid format is FAC/ACC-
<SHELF ID>-<SLOT ID>-<PORT ID>.
<WORKLINKINTAG> Indicates the tag of incoming packets over the working link. It can be a
VLAN ID. This parameter is optional and denotes an EPL in this
document. See ENT-ETHLINK.
<WORKLINKINSTAG> Indicates the incoming service VLAN tag of the working link.
This parameter is optional. See ENT-ETHLINK.
<WORKLINKSTATE> Indicates the status of the working link. The valid values are
NORMAL and SF (signal fail).
<BACKUPLINKINTAG> Indicates the tag of incoming packets from the backup link. It can be a
VLAN ID. This parameter is optional and denotes an EPL in this
document.
<BACKUPLINKINSTAG> Indicates the incoming service VLAN tag of the backup link.
This parameter is optional. See ENT-ETHLINK.
Parameter Description
<BACKUPLINKSTATE> Indicates the status of the backup link. The valid values are NORMAL
and SF (signal fail).
<RVRTV> Indicates the revertive mode. The valid values are Y (revertive mode)
and N (non-revertive mode).
<HOLDOFFTIME> Indicates the hold-off time (units in 0.1s) of VLAN SNCP protection.
<SWSTATE> Indicates the protection switching status. The valid values of switching
status are as follows:
IDLE
AUTO_SW
WTR
MANUAL
FRCD
LOCKOUT
Example
Command
RTRV-VLANSNCP-PG:::C:::LINKFROM=FAC-1-11-3,LINKTO=ACC-1-11-1,LINKINTAG=1;
Response Message
NE 2008-08-02 21:20:39
M C COMPLD
"ACC-2-4-15,FAC-2-4-11,ACC-2-4-16,FAC-2-4-
11::WORKLINKINTAG=200,WORKLINKSTATE=SF,BACKUPLINKINTAG=200,BACKUPLINKSTATE=
NORMAL,RVRTV=Y,RVTM=6,HOLDOFFTIME=0,SWSTATE=AUTO_SW,ACTIVELINK=ACC-2-4-16"
;
Related Commands
ENT-VLANSNCP-PG
ED-VLANSNCP-PG
DLT-VLANSNCP-PG
DLT-VLANSNCP-PG
Deletes a VLAN SNCP group.
Function
This command deletes a VLAN SNCP protection group.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-VLANSNCP-PG:[<TID>]::<CTAG>:::LINK_FROM =<LINKFROM>,LINKTO =
<LINKTO>,[LINKINTAG =<LINKINTAG>][LINKINSTAG =<LINKINSTAG>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
Response Parameters
None
Example
Command
DLT-VLANSNCP-PG:::10:::LINKFROM=FAC-1-3-4,LINKTO=FAC-1-3-5,LINKINTAG=1
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-VLANSNCP-PG
ED-VLANSNCP-PG
RTRV-VLANSNCP-PG
OPR-PROTNSW-VLANSNCP
Operates the protection switching of a VLAN SNCP group.
Function
This command is used to operate the protection switching of a VLAN SNCP group.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
OPR-PROTNSW-VLANSNCP:
[<TID>]::<CTAG>:::LINK_FROM=<LINKFROM>,LINKTO =<LINKTO>,[LINKINTAG
=<LINKINTAG>],[LINKINSTAG=<LINKINSTAG>],SC=<SC>,[DIRN=<DIRN>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
Response Parameters
None
Example
Command
OPR-PROTNSW-VLANSNCP:::100:::LINKFROM=FAC-1-3-4,LINKTO=FAC-1-3-
5,LINKINTAG=1,SC=FRCD,DIRN=BTH;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RLS-PROTNSW-VLANSNCP
RLS-PROTNSW-VLANSNCP
Releases the protection switching of a VLAN SNCP group.
Function
This command releases the protection switching of a VLAN SNCP group.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RLS-PROTNSW-VLANSNCP:
[<TID>]::<CTAG>:::LINKFROM=<LINKFROM>,LINKTO=<LINKTO>,
[LINKINTAG=<LINKINTAG>],[LINKINSTAG=<LINKINSTAG>],[DIRN=<DIRN>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
Response Parameters
None
Example
Command
RLS-PROTNSW-VLANSNCP:::10:::LINKFROM=FAC-1-3-4,LINKTO=FAC-1-3-
5,LINKINTAG=1,DIRN=BTH;
Response Message
NE 2003-02-28 12:23:20
M 10 COMPLD
;
Related Commands
OPR-PROTNSW-VLANSNCP
ED-<FETH/GETH/XGETH/100GETH/40GETH>
Edits the attributes of the Ethernet port.
Function
This command modifies the attributes of an FE, GE, 10GE, 100GE or 40GE port.
Usage Note
When a TQX card is used, the client-side optical interfaces (LP1-LP4) must comply with the
following configuration rules when 10GE LAN services are accessed and the GFP
encapsulation format is adopted:
If the service type for the LP1 optical interface is configured as 10GE LAN, the LP2
optical interface is invalid (the service type must be set to None).
NOTE:
When the configured service (for example, 10GE LAN, OC-192, STM64, and OTU2E) for the LP1
optical interface is not encapsulated based on the GFP format, the LP2 optical interface is not
affected.
The data encapsulation format for the LP2 optical interface cannot be GFP.
Optical interfaces LP3 and LP4 are independent from optical interfaces LP1 and LP2.
The relationship between optical interfaces LP3 and LP4 is the same as the
relationship between optical interfaces LP1 and LP2.
When 10GE LAN services are accessed and the GFP encapsulation format is adopted on a
TDX card, the relationship between optical interfaces LP1 and LP2 is the same as the
relationship between optical interfaces LP1 and LP2 of the TQX card.
Category
Configuration
Security
Provisioning
Command Syntax
ED-<FETH/GETH/XGETH/100GETH/40GETH>:[<TID>]:<AID>:<CTAG>:::
[WORKMODE=<WORKMODE>],[FLOWCTRL=<FLOWCTRL>],
[FLOWCTRLAUTO=<FLOWCTRLAUTO>],[MTU=<MTU>],
[PORTENABLE=<PORTENABLE>],[PORTCHECK=<PORTCHECK>],
[TAGTYPE=<TAGTYPE>],[PVID=<PVID>],[PVPRI=<PVPRI>],
[BCSENABLE=<BCSENABLE>],[BCSTH=<BCSTH>],[PORTTYPE=<PORTTYPE>],
[LABELTYPE=<LABELTYPE>],[PTPMODE=<PTPMODE>],[PSVID=<PSVID>],
[PSVPRI=<PSVPRI>],[STAGTYPE=<STAGTYPE>],[SVENABLE=<SVENABLE>],
[MDIMODE=<MDIMODE>],[ROUTEMAC=<ROUTEMAC>],
[B1SFBER=<B1SFBER>],[B1SDBER=<B1SDBER>],[TRCJ0MODE=<TRCJ0MODE>],
[TRCJ0FMT=<TRCJ0FMT>],[INSCODE=<INSCODE>],[TRCJ0=<TRCJ0>],
[EXPTRCJ0=<EXPTRCJ0>],[MAPMODE=<MAPMODE>],
[DELAYTIME=<DELAYTIME>],[SVTIMER=<SVTIMER>],
[ETHBIP8TH=<ETHBIP8TH>]:[<PST>],[<SST>];
Command Parameters
Parameter Description Default Value
<TAGTYPE> Indicates the tag attribute of the port. The valid TAGAWARE
values are as follows:
TAGAWARE
HYBRID
ACCESS
This parameter is optional.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf> ;
Response Parameters
None
Example
Command
ED-FETH::FAC-1-1-5-
2:100:::WORKMODE=AUTO,FLOWCTRLAUTO=DISABLE,MTU=1522,PTPMODE=AUTO,PORTENABLE
=Y,PORTCHECK=Y,TAGTYPE=ACCESS,PVID=22,PVPRI=2,BCSENABLE=Y,BCSTH=3,PPTENABLE
=N,PORTTYPE=UNI,PSVID=1000,PSVPRI=7,STAGTYPE=TAGAWARE,SVENABLE=Y:OOS;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD ;
Related Commands
RTRV-<FETH/GETH/XGETH/100GETH/40GETH>
RMV-<FETH/GETH/XGETH>
Removes the Ethernet port from service an places it into the maintenance (MT) state.
Function
This command is used for a specified Ethernet port to enter the MT state.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RMV-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
RMV-FETH::FAC-1-5-2:100;
Response Message
NE 2005-07-06 10:23:20
M 100 COMPLD
;
Related Commands
RST-<FETH/GETH/XGETH>
RTRV-<FETH/GETH/XGETH/100GETH/40GETH>
Retrieves the attributes of an Ethernet port.
Function
This command retrieves the attributes of an Ethernet port.
Usage Note
None.
Category
Configuration.
Security
Retrieve
Command Syntax
RTRV-<FETH/GETH/XGETH/100GETH/40GETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::WORKMODE=<WORKMODE>,ACTWORKMODE=<ACTWORKMODE>,FLOWCTRL=<FLOWCTRL
>,FLOWCTRLAUTO=<FLOWCTRLAUTO>,ACTFLOWCTRL=<ACTFLOWCTRL>,MTU=<MTU>,
[PTPMODE=<PTPMODE>],[ACTPTPMODE=<ACTPTPMODE>], [PORTENABLE=<PORTENABLE>],
[PORTCHECK=<PORTCHECK>],[TAGTYPE=<TAGTYPE>],[PVID=<PVID>],[PVPRI=<PVPRI>],
[BCSENABLE=<BCSENABLE>],[BCSTH=<BCSTH>],[PPTENABLE=<PPTENABLE>],
[PORTTYPE=<PORTTYPE>],[LABELTYPE=<LABELTYPE>],[PSVID=<PSVID>],
[PSVPRI=<PSVPRI>],[STAGTYPE=<STAGTYPE>],[SVENABLE=<SVENABLE>],
[SVTPID=<SVTPID>],[MACADDR=<MACADDR>],[ROUTEMAC=<ROUTEMAC>],
[MDIMODE=<MDIMODE>],[B1SFBER=<B1SFBER>],[B1SDBER=<B1SDBER>],
[TRCJ0MODE=<TRCJ0MODE>],[TRCJ0FMT=<TRCJ0FMT>],[INSCODE=<INSCODE>],
[TRCJ0=<TRCJ0>],[EXPTRCJ0=<EXPTRCJ0>],[INCTRCJ0=<INCTRCJ0>],
[MAPMODE=<MAPMODE>],[DELAYTIME=<DELAYTIME>],[SWITCHSTATE=<SWITCHSTATE>],
[SVTIMER=<SVTIMER>],[ETHBIP8TH=<ETHBIP8TH>]:<PST>,<SST>"<cr><lf>
Response Parameters
Parameter Description
<WORKMODE> Indicates the working mode of the port. The valid values are as follows:
AUTO: Auto Negotiation
Parameter Description
<FLOWCTRLAUTO> Indicates the auto-negotiation flow control attribute of the port and whether
the automatic flow control is enabled. The valid values are in section
"FLOWCTRLAUTO" of TL1 Parameters.
<PORTENABLE> Indicates whether the port is enabled. The valid values are Y (enable) and N
(disable).
<PVPRI> Indicates the priority of the default VLAN for the port.
<TAGTYPE> Indicates the tag attribute of the port. The valid values are as follows:
TAGAWARE
HYBRID
ACCESS
<BCSTH> Indicates the threshold for broadcast ; that is, the percentage of the total
planned bandwidth that broadcast packets occupy.
<PPTENABLE> Indicates whether flow control frames are transmitted to the next hop
Parameter Description
transparently.
<PORTTYPE> Indicates the type of the port identified by AID. The valid values are as
follows:
User to network interface (UNI)
NUNI
Network to network interface (NNI)
Customer VLAN tag aware (CAWARE)
Service VLAN tag aware (SAWARE)
<PSVPRI> Indicates the priority of the default service VLAN for the port.
NOTE:
This parameter is not valid for NGWDM equipment.
<ROUTEMAC> Indicates the MAC address of the remote router in the DBPS protection
group.
<B1SFBER> Indicates the SF BER threshold for the overhead byte (B1) on a facility.
The valid value ranges from 1E-5 to 1E-3.
This parameter is valid only when the <WORKMODE> is 10GFULLWAN.
<B1SDBER> Indicates the SD BER threshold for the overhead byte (B1) on a facility.
The valid value ranges from 1E-9 to 1E-5.
This parameter is valid only when the <WORKMODE> is 10GFULLWAN.
<TRCJ0> Indicates the J0 byte which is expected to be transmitted. The valid value
depends on the format specified by <TRCJ0FMT>.
This parameter is valid for the units which support generating the J0 byte
and only when the <WORKMODE> is 10GFULLWAN.
<DELAYTIME> Indicates the delay time, that is, hold-off time. The valid value is an integer
ranging from 0 to 255 in units of 100 ms.
Delay time is required when multiple protection schemes are configured.
Switching is not initiated until the delay time is expended when a
malfunction is discovered at a port.
<SWITCHSTATE> Indicates the protection switching status. It is only valid when the port is in
the protection group.
For the valid values of this parameter, refer to SWITCHSTATE.
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is
valid only when Auto In-Service is supported. SVTIMER is a string in an
Parameter Description
HH-MM format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
The maximum timer setting is 48 hours.
<ETHBIP8TH> Threshold of ETH BIP8. The valid value ranges from 1 to 5. The default is
3.
<PST> Indicates the Ethernet port state.
This valid values are IS and OOS.
Example
Command
RTRV-FETH::FAC-5-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FAC-5-
2::WORKMODE=AUTO,ACTWORKMODE=FULL100M,FLOWCTRL=DISABLE,FLOWCTRLAUTO=DISABLE
,ACTFLOWCTRL=DISABLE,MTU=1522,PTPMODE=AUTO,PORTENABLE=Y,PORTCHECK=Y,TAGTYPE
=ACCESS,PVID=22,PVPRI=2,BCSENABLE=Y,BCSTH=3,PPTENABLE=N,PORTTYPE=UNI,PSVID=
1000,PSVPRI=7,STAGTYPE=TAGAWARE,SVENABLE=Y,SVTPID=34832,MACADDR=00-e0-fc-
59-b2-70:IS"
;
Related Commands
ED-<FETH/GETH/XGETH/100GETH/40GETH>
RST-<FETH/GETH/XGETH>
Restores the Ethernet port into service.
Function
This command is used for a specified Ethernet port of the NE to exit the maintenance state.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RST-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
RST-FETH::FAC-1-5-2:100;
Response Message
NE 2005-07-06 10:23:20
M 100 COMPLD
;
Related Commands
RMV-<FETH/GETH/XGETH>
OPR-LPBK-<FETH/GETH/XGETH>
Operates a loopback on the Ethernet port.
Function
This command is used for an NE to operate a loopback on a specified Ethernet port.
Usage Note
The loopback can be performed only when the Ethernet port is in the MT state.
Category
Configuration
Security
Maintenance
Command Syntax
OPR-LPBK-<FETH/GETH/XGETH>:
[<TID>]:<AID>:<CTAG>::<LPBKMODEETH>:LPBKTYPE=<LPBKTYPE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
OPR-LPBK-GETH::FAC-1-2-5:100::MAC:LPBKTYPE=TERMINAL;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RLS-LPBK-<FETH/GETH/XGETH>
RLS-LPBK-<FETH/GETH/XGETH>
Releases the loopback of an Ethernet port.
Function
This command is used for an NE to release the loopback of a specified Ethernet port.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RLS-LPBK-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>::<LPBKMODEETH>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
RLS-LPBK-FETH::FAC-1-5-2:100::MAC;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
OPR-LPBK-<FETH/GETH/XGETH>
RTRV-LPBK-<FETH/GETH/XGETH>
Retrieves the loopback information about a specified Ethernet port
Function
This command instructs the NE to retrieve the loopback information about a specified
Ethernet port.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-LPBK-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::LOCN=<LOCN>,LPBKTYPE=<LPBKTYPE>"<cr><lf> ;
Response Parameters
Parameter Description
<LOCN> Indicates the loopback mode. The valid values are MAC (MAC loopback)
and PHY (physical loopback).
<LPBKTYPE> Indicates the loopback type. The valid values are FACILITY and
TERMINAL.
Example
Command
RTRV-LPBK-GETH::FAC-1-3-4:100;
Response Message
NE 2009-01-01 11:37:18
M C COMPLD
"FAC-1-3-4::LOCN=MAC,LPBKTYPE=TERMINAL"
Related Commands
OPR-LPBK-<FETH/GETH/XGETH>
ED-ETH-VCG
Edits the attributes of an Ethernet VCG port.
Function
This command modifies the attributes of an Ethernet VCG port.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-ETH-VCG:[<TID>]:<AID>:<CTAG>:::[ENCPROTOCOL=<ENCPROTOCOL>],
[SCRAMBLER=<SCRAMBLER>],[EXTHDR=<EXTHDR>],[REVCRC=<REVCRC>],
[FCSTYPE=<FCSTYPE>],[ENDIAN=<ENDIAN>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf> ;
Response Parameters
None
Example
Command
ED-ETH-VCG::ACC-1-5-3:100:::ENCPROTOCOL=GFP-
F,SCRAMBLER=X43,FCSTYPE=FCS32,ENDIAN=LITTLE,EXTHDR=Y;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD ;
Related Commands
RTRV-ETH-VCGRTRV-<FETH/GETH/XGETH/100GETH/40GETH>
RTRV-ETH-VCG
Queries the attributes of an Ethernet VCG port.
Function
This command queries the attributes of an Ethernet VCG port.
Usage Note
None.
Category
Configuration.
Security
Retrieve
Command Syntax
RTRV-ETH-VCG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::ENCPROTOCOL=<ENCPROTOCOL>,SCRAMBLER=<SCRAMBLER>,EXTHDR=<EXTHDR>,
REVCRC=<REVCRC>,FCSTYPE=<FCSTYPE>,ENDIAN=<ENDIAN>:<PST>,<SST>"<cr><lf>
Response Parameters
Parameter Description
The valid values are HDLC, GFP-F, GFP-T, PPP, and LAPS.
<SCRAMBLER> Indicates the scrambling mode that is used by the scrambler of the
encapsulation protocol.
The valid values are DISABLE, X43, and X48.
Example
Command
RTRV-ETH-VCG::ACC-5-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"ACC-5-2::ENCPROTOCOL=GFP-
F,SCRAMBLER=X43,FCSTYPE=FCS32,ENDIAN=LITTLE,EXTHDR=Y:IS"
;
Related Commands
ED-ETH-VCGED-<FETH/GETH/XGETH/100GETH/40GETH>
ED-PORT-TRAFFIC
Edits the traffic attribute of a port.
Function
This command modifies the traffic attribute of a port.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-PORT-TRAFFIC:[<TID>]:<AID>:<CTAG>:::[NTMENABLE=<NTMENABLE>],
[NTMTIME=<NTMTIME>],[TRFCTH=<TRFCTH>],[TRFCTIME=<TRFCTIME>],
[FLUXMON=<FLUXMON>];
Command Parameters
Parameter Description Default Value
<TRFCTH> Indicates the maximum traffic that is allowed by a 100 (FE port), 1000 (GE
port. An alarm is reported when the traffic port), 10000 (10GE port)
receives at a port exceeds this parameter.
The value ranges from 1 Mbit/s to 100 Mbit/s for
an FE port, ranges from 1 Mbit/s to 1000 Mbit/s
for a GE port, and ranges from 1 Mbit/s to 10000
Mbit/s for a 10GE port.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf> ;
Response Parameters
None
Example
Command
ED-PORT-TRAFFIC::FAC-1-5-2:100:::NTMENABLE=Y,NTMTIME=15,
TRFCTH=100,TRFCTIME=30,FLUXMON=Y;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD ;
Related Commands
RTRV-PORT-TRAFFICRTRV-<FETH/GETH/XGETH/100GETH/40GETH>
RTRV-PORT-TRFFLUXRTRV-<FETH/GETH/XGETH/100GETH/40GETH>
RTRV-PORT-TRAFFIC
Queries the traffic attribute of a port.
Function
This command queries the traffic attribute of a port.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-ETH-VCG:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::NTMENABLE=<NTMENABLE>,NTMTIME=<NTMTIME>,TRFCTH=<TRFCTH>,TRFCTIME
=<TRFCTIME>,FLUXMON=<FLUXMON>:<PST>,<SST>"<cr><lf>
Response Parameters
Parameter Description
<NTMTIME> Indicates the time that allows a port to receive no traffic. An alarm is
reported when the time that a port does not receive any traffic exceeds this
parameter.
The value ranges from 1 minute to 30 minutes.
<TRFCTIME> Indicates the time that allows a port to receive traffic exceeding the value of
TRCTH. An alarm is reported when the time that a port receives traffic
higher than the value of TRCTH exceeds this parameter.
The value ranges from 0 minute to 30 minutes.
<FLUXMON> Indicates whether the traffic of a port is monitored.
The valid values are Y and N.
Example
Command
RTRV-PORT-TRAFFIC::FAC-5-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FAC-5-
2::NTMENABLE=ENABLE,NTMTIME=15,TRFCTH=100,TRFCTIME=10,FLUXMON=Y:IS"
;
Related Commands
ED-PORT-TRAFFICED-<FETH/GETH/XGETH/100GETH/40GETH>
RTRV-PORT-TRFFLUXED-<FETH/GETH/XGETH/100GETH/40GETH>
RTRV-PORT-TRFFLUX
Queries historical traffic records of a port.
Function
This command queries historical traffic records of a port.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-PORT-TRFFLUX:
[<TID>]:<AID>:<CTAG>:::<BGNDATE>:<BGNTIME>:<ENDDATE>:<ENDTIME>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::BGNDATE=<BGNDATE>,BGNTIME=<BGNTIME>,ENDDATE=<ENDDATE>,ENDTIME=<E
NDTIME>:<PST>,<SST>"<cr><lf>
Response Parameters
Parameter Description
<RECFLAG> Indicates the flag that represents whether flow records are generated.
The valid values are Y and N.
<RXRATE> Indicates the flow receiving rate at the time specified by RECDATE and
RECTIME. The unit is Kbit/s. The value of this parameter is 0 when
RECFLAG is N.
Parameter Description
<TXRATE> Indicates the flow transmitting rate at the time specified by RECDATE and
RECTIME. The unit is Kbit/s. The value of this parameter is 0 when
RECFLAG is N.
Example
Command
RTRV-PORT-TRFFLUX::FAC-1-1-2:100:::2003-02-28,09-00-00,2003-02-28,12-00-00;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FAC-1-1-2::RECDATE=2003-02-28,RECTIME=10-00-
00,RECFLAG=Y,RXRATE=10,TXRATE=10:IS"
"FAC-1-1-2::RECDATE=2003-02-28,RECTIME=10-15-
00,RECFLAG=Y,RXRATE=10,TXRATE=10:IS"
"FAC-1-1-2::RECDATE=2003-02-28,RECTIME=10-30-
00,RECFLAG=Y,RXRATE=10,TXRATE=10:IS"
;
Related Commands
ED-PORT-TRAFFICED-<FETH/GETH/XGETH/100GETH/40GETH>
RTRV-PORT-TRAFFICED-<FETH/GETH/XGETH/100GETH/40GETH>
D.14.2 Configuring Flow
This section lists the commands used to configure the Ethernet service flow.
ENT-FLOW
Creates a flow.
Function
This command creates a flow entity of the unit. Currently, the flow can be classified as
follows:
By the incoming port (FAC or ACC).
By the incoming port and incoming tag.
In the future, the flow can be classified as follows:
By the incoming tag.
By the incoming port, incoming tag, and incoming tag priority.
By the MAC address.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-FLOW:[<TID>]:<AID>:<CTAG>:::PORT=<PORT>,[INTAG=<INTAG>],
[INSTAG=<INSTAG>],[TAGPRI=<TAGPRI>],[LABEL=<LABEL>];
Command Parameters
<INTAG> Indicates the incoming tag. The tag can be a VLAN tag. NA
This parameter is optional and has no default value.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-FLOW::FLOW-1-1-1:100:::PORT=FAC-2-1-1;
ENT-FLOW::FLOW-1-1-2:100:::PORT=ACC-2-1-1,INTAG=3;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
DLT-FLOW
ED-FLOW
RTRV-FLOW
ED-FLOW
Edits a flow.
Function
This command modifies a flow entity of the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-FLOW:[<TID>]:<AID>:<CTAG>:::[CARID=<CARID>],[COSID=<COSID>],
[PKTSTATEN=<PKTSTATEN>],[PKTSTATCLR=<PKTSTATCLR>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-FLOW::FLOW-1-1-1:100:::CARID=CAR-1-1-20,COSID=COS-1-1-
10,PKTSTATEN=Y,PKTSTATCLR=Y;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-FLOW
DLT-FLOW
RTRV-FLOW
DLT-FLOW
Deletes the flow.
Function
This command deletes a flow entry of the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-FLOW:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-FLOW::FLOW-1-1-10:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-FLOW
ED-FLOW
RTRV-FLOW
RTRV-FLOW
Retrieves a flow entry of the unit.
Function
This command retrieves a flow entry of a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-FLOW:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Parameters
Parameter Description
<INTAG> Indicates the incoming tag. The tag can be a VLAN tag.
<TAGPRI> Indicates the priority of <INTAG>. The valid value ranges from 0 to 7.
This parameter is optional and has no default value.
<CARID> Indicates the associated CAR. The valid format is CAR-<SLOT ID>-<CAR
ID>.
<COSID> Indicates the identifier of CoS. The valid format is COS-<SHELF ID>-
<SLOT ID>-<COS ID>.
<PKTSTATEN> Indicates whether the function of collecting statistics on flow packets is
enabled. The system starts to collect statistics on flow packets after users set
this parameter to Y.
The valid values are N and Y.
<PKTRIGHTH4> Indicates the most significant four bytes in the number of correct flow
packets. This parameter is displayed only when users set PKTSTATEN to
Y.
<PKTRIGHTL4> Indicates the least significant four bytes in the number of correct flow
packets. This parameter is displayed only when users set PKTSTATEN to
Y.
<PKTERRH4> Indicates the most significant four bytes in the number of error flow packets.
This parameter is displayed only when users set PKTSTATEN to Y.
<PKTERRL4> Indicates the least significant four bytes in the number of error flow packets.
This parameter is displayed only when users set PKTSTATEN to Y.
<PKTTOTALH4> Indicates the most significant four bytes in the number of all flow packets.
This parameter is displayed only when users set PKTSTATEN to Y.
Parameter Description
<PKTTOTALL4> Indicates the least significant four bytes in the number of all flow packets.
This parameter is displayed only when users set PKTSTATEN to Y.
<PKTBYTEH4> Indicates the most significant four bytes in the total length of all flow
packets. This parameter is displayed only when users set PKTSTATEN to
Y.
<PKTBYTEL4> Indicates the least significant four bytes in the total length of all flow
packets. This parameter is displayed only when users set PKTSTATEN to
Y.
<FLUXMONEN> Indicates whether traffic monitoring is enabled for a flow. The system starts
to periodically record the traffic of a flow after users set this parameter to Y.
The valid values are N and Y.
Example
Command
RTRV-FLOW::FLOW-1-1-1:100;
RTRV-FLOW::FLOW-1-1-ALL:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FLOW-1-1-1::PORT=FAC-1-1-2,INTAG=3,CARID=CAR-1-1-10,COSID=COS-1-1-
20,PKTSTATEN=N,FLUXMONEN=Y";
Related Commands
ED-FLOW
ENT-FLOW
DLT-FLOW
ENT-ETHLINK
Creates an Ethernet link.
Function
This command creates an Ethernet link in the unit.
Usage Note
The relation between action and TAG parameters required by the action is listed in the
following table. "MUST" means the parameter must be entered, "MAY" means the parameter
is optional, hyphen("-") means the parameter cannot be entered.
Action INTAG OUTTAG INSTAG OUTSTAG OUTTAGPRI OUTSTAGPRI
Category
Provision
Security
Provisioning
Command Syntax
ENT-ETHLINK:[<TID>]:<LINKFROM>,<LINKTO>:<CTAG>:::[INTAG=<INTAG>],
[OUTTAG=<OUTTAG>],[INSTAG=<INSTAG>],[OUTSTAG=<OUTSTAG>],
[OUTTAGPRI=<OUTTAGPRI>],[OUTSTAGPRI=<OUTSTAGPRI>],
[CTYPE=<CTYPE>],[OAMFLAG=<OAMFLAG>];
Command Parameters
Parameter Description Default Value
<LINKTO> Indicates the sink of the Ethernet link. The valid values NA
are as follows:
PORT: FAC/ACC-<SHELF ID>-<SLOT ID>-
<PORT ID>
VBLP: VBLP-<SHELF ID>-<SLOT ID>-<VB
ID>-<VBLP ID>
Ethernet links between VBLPs are not supported.
<OAMFLAG> Indicates whether the OAM of the link is enabled. The DISABLE
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
Example for VLAN switch link:
ENT-ETHLINK::FAC-1-1-2,ACC-1-1-4:100:::INTAG=3,OUTTAG=5,CTYPE=1WAY;
Example for VLAN link:
ENT-ETHLINK::FAC-1-1-1-2,ACC-1-1-1-4:100:::INTAG=3,OUTTAG=3,CTYPE=1WAY;
Example for LPT:
ENT-ETHLINK::FAC-1-1-1-2,ACC-1-1-1-4:100:::LPTENABLE=Y;
This example is not valid for NGWDM equipment.Example for VB link:
ENT-ETHLINK::FAC-1-1-1-2,VBLP-1-1-1-1-20:100;
Example for general port link:
ENT-ETHLINK::FAC-1-1-1-2,FAC-1-1-1-4:100:::CTYPE=1WAY;
Example for poping S-VLAN & C-VLAN:
EENT-ETHLINK::FAC-1-1-1-2,ACC-1-1-1-4:100:::INTAG=3,INSTAG=10, CTYPE=1WAY;
Example for pushing S-VLAN & C-VLAN:
ENT-ETHLINK::FAC-1-1-1-2,ACC-1-1-1-4:100:::OUTTAG=3,OUTSTAG=10,CTYPE=1WAY;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-ETHLINK
DLT-ETHLINK
RTRV-ETHLINK
ED-ETHLINK
Edits the Ethernet link.
Function
This command modifies the attributes of an Ethernet link in the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-ETHLINK:[<TID>]:<LINKFROM>,<LINKTO>:<CTAG>:::[INTAG=<INTAG>],
[INSTAG=<INSTAG>],[OUTTAGPRI=<OUTTAGPRI>],
[OUTSTAGPRI=<OUTSTAGPRI>],[CTYPE=<CTYPE>],[OAMFLAG =<OAMFLAG >];
Command Parameters
Parameter Description Default Value
<OAMFLAG> Indicates the enabling state of the link OAM (for the DISABLE
VLANSNCP protection). The valid values are
ENABLE and DISABLE.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-ETHLINK::FAC-1-1-2,ACC-1-1-4:100:::CTYPE=2WAY;
Response Message
NE 2005-07-14 09:55:00
M 100 COMPLD
;
Related Commands
ENT-ETHLINK
DLT-ETHLINK
RTRV-ETHLINK
DLT-ETHLINK
Deletes the Ethernet link.
Function
This command deletes an Ethernet link in the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-ETHLINK:[<TID>]:<LINKFROM>,<LINKTO>:<CTAG>:::[INTAG=<INTAG>],
[INSTAG=<INSTAG>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
Example for EPL:
DLT-ETHLINK::FAC-1-1-2,ACC-1-1-4:100;
Example for EVPL:
DLT-ETHLINK::FAC-1-1-2,ACC-1-1-4:100:::INTAG=3;
Example for forwarding based S-VLAN & C-VLAN:
DLT-ETHLINK::FAC-1-1-2,ACC-1-1-4:100:::INTAG=3,INSTAG=4;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-ETHLINK
ED-ETHLINK
RTRV-ETHLINK
RTRV-ETHLINK
Retrieves the information about an Ethernet link.
Function
This command retrieves the information about an Ethernet link in a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-ETHLINK:[<TID>]:[<LINK_FROM>,<LINK_TO>]:<CTAG>:::
[INTAG=<INTAG>],[INSTAG=<INSTAG>];
Command Parameters
Parameter Description Default Value
<LINKFROM> Indicates the source end of the Ethernet link. The valid NA
values are as follows:
PORT: FAC/ACC-<SHELF ID>-<SLOT ID>-
<PORT ID>
VBLP: VBLP-<SHELF ID>-<SLOT ID>-<VB
ID>-<VBLP ID>
SLOT: SLOT-<SHELF>-<SLOT>
Enter SLOT-<SHELF>-<SLOT> to retrieve the link
information about the specified card.
The values of source <SLOT> and end <SLOT>
must be same.
If the value of <SLOT> is ALL, all of the link
information for the cards on the shelf will be
retrieved.
Supports ALL, which means to retrieve the information
at the NE level.
<LINKTO> Indicates the sink end of the Ethernet link. The valid NA
values are as follows:
PORT: FAC/ACC-<SHELF ID>-<SLOT ID>-
<PORT ID>
VBLP: VBLP-<SHELF ID>-<SLOT ID>-<VB
ID>-<VBLP ID>
SLOT: SLOT-<SHELF>-<SLOT>
Enter SLOT-<SHELF>-<SLOT> to retrieve the link
information about the specified card.
The values of source <SLOT> and end <SLOT>
must be same.
If the value of <SLOT> is ALL, all of the link
information for the cards on the shelf will be
retrieved.
Supports ALL, which means to retrieve the information
at the NE level.
The Ethernet link from VBLP to VBLP is not supported.
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<LINK_FROM>,<LINK_TO>:: [INTAG=<INTAG>],[OUTTAG=<OUTTAG>],
[INSTAG=<INSTAG>],[OUTSTAG=<OUTSTAG>],[OUTTAGPRI=<OUTTAGPRI>],
[OUTSTAGPRI=<OUTSTAGPRI>],[CTYPE=<CTYPE>],[BANDWIDTH=<BANDWIDTH >],
[OAMFLAG=<OAMFLAG>]"<cr><lf>
;
Response Parameters
Parameter Para Description
<INTAG> Indicates the incoming tag. The tag can be a VLAN tag.
This parameter is optional and denotes an EPL in this document.
<OUTTAG> Indicates the out tag. The tag can be a VLAN tag.
This parameter is optional and denotes an EPL in this document.
<OUTTAGPRI> Indicates the default priority of the VLAN tag of outgoing client services.
This parameter is optional. See "Usage Note" in ENT-ETHLINK.
<OUTSTAGPRI> Indicates the default priority of the VLAN tag of outgoing services.
This parameter is optional. See "Usage Note" in ENT-ETHLINK.
Parameter Para Description
<OAMFLAG> Indicates whether the OAM is enabled for the link (used for the VLAN SNCP
protection). The valid values are as follows:
DISABLE: disabled (default)
ENABLE: enabled
Example
Command
Retrieves the link according to specified FROM and TO:
RTRV-ETHLINK::FAC-1-1-2,ACC-1-1-4:100;
RTRV-ETHLINK::FAC-1-1-2,ACC-1-1-4:100:::INTAG=1;
Retrieves all links within a card:
RTRV-ETHLINK::SLOT-1-1,SLOT-1-1:100;
RTRV-ETHLINK::SLOT-1-all,SLOT-1-all:100;
Retrieves all links within an NE:
RTRV-ETHLINK:::100;
RTRV-ETHLINK::all,all:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FAC-1-1-2,ACC-1-1-4::INTAG=2,OUTTAG=2,CTYPE=1WAY"
"FAC-1-1-1,ACC-1-1-
1::INTAG=2,OUTTAG=NULL,INSTAG=10,OUTSTAG=NULL,CTYPE=1WAY"
"FAC-1-1-1,ACC-1-1-
1::OUTTAG=10,OUTSTAG=20,OUTTAGPRI=0,OUTSTAGPRI=7,CTYPE=1WAY"
;
Related Commands
ENT-ETHLINK
ED-ETHLINK
DLT-ETHLINK
ENT-PW
Creates the PW.
Function
This command creates PW.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-PW:[<TID>]:<ENT_PWID>:<CTAG>:::INPORT=<INPORT>,
[INACPORT=<ENT_ACPORTID>],[FWINLABEL=<FWINLABEL>],
[FWOUTLABEL=<FWOUTLABEL>],[OUTPORT=<OUTPORT>],
[TUNNEL=<ENT_TUNNELID>],[BWINLABEL=<BWINLABEL>],
[BWOUTLABEL=<BWOUTLABEL>],[BWOUTLABEL=<BWOUTLABEL>],
[NHIP=<NHIP>],[EXPVALUE=<EXPVALUE>],[BANDWIDTH=<BANDWIDTH>];
Command Parameters
Parameter Description Default Value
<ENT_PWID> PW index. NA
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-PW::PW-1-1:100:::INPORT=FAC-1-1,INACPORT=ACPORT-1-
1,FWOUTLABEL=1000,TUNNEL=TUNNEL-1-10,BWINLABEL=16,EXPVALUE=0,BANDWIDTH=64;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-PW
DLT-PW
RTRV-PW
ED-PW
Edits the specified pw.
Function
This command modifies the attributes of the specified pw.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-PW:[<TID>]:[<TID>]:<ED_PWID>:<CTAG>:::[EXPVALUE=<EXPVALUE>],
[BANDWIDTH=<BANDWIDTH>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-PW::PW-1-10:100:::EXPVALUE=0,BANDWIDTH=64;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-PW
DLT-PW
RTRV-PW
RTRV-PW
Retrieves the information about PW.
Function
This command retrieves the information about PW.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-PW:[<TID>]:<RTRV_PWID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<RTRV_PWID>::TYPE=<PWTYPE>,[INPORT=<INPORT>],[INACPORT=<ENT_ACPORTID>],
[FWINLABEL=<FWINLABEL>],[FWOUTLABEL]=<FWOUTLABEL>,[OUTPORT]=<OUTPORT>,
[TUNNEL]=<ENT_TUNNELID>,[BWINLABEL]=<BWINLABEL>,[BWOUTLABEL]=<BWOUTLABEL>,
[NHIP]=<NHIP>,[EXPVALUE]=<EXPVALUE>,[BANDWIDTH]=<BANDWIDTH>;"<cr><lf>
;
Response Parameters
Parameter Description
<PWTYPE> PW type
Example
Command
RTRV-PW::PW-1-10:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"PW-1-1:100:::INPORT=FAC-1-1,INACPORT=ACPORT-1-
1,FWOUTLABEL=1000,TUNNEL=TUNNEL-1-10,BWINLABEL=16,EXPVALUE=0,BANDWIDTH=64"
;
Related Commands
ENT-PW
ED-PW
DLT-PW
DLT-PW
Deletes the specified pw.
Function
This command deletes a specified pw.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-PW:[<TID>]:<ENT_PWID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-PW::PW-1-10:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-PW
ED-PW
RTRV-PW
ENT-TUNNEL
Creates the TUNNEL.
Function
This command creates TUNNEL.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-TUNNEL:[<TID>]:<ENT_TUNNELID>:<CTAG>:::INPORT=<INPORT>,
[INTNLABEL=<INTNLABEL>],[OUTPORT=<OUTPORT>],
[OUTTNLABEL=<OUTTNLABEL>],[NHIP=<NHIP>],[RETTUNNEL=<RETTUNNEL>],
[EXPMODE=<EXPMODE>],[EXPVALUE=<EXPVALUE>],
[TTSILSRID=<TTSILSRID>],[TTSITUNNELID=<TTSITUNNELID>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-TUNNEL::TUNNEL-1-1:100:::OUTPORT=VCG-1-
4,OUTTNLABEL=20,NHIP=10.11.12.13,EXPMODE=VALUE,EXPVALUE=0,TTSILSRID=192.168
.0.1,TTSITUNNELID=1;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-TUNNEL
DLT-TUNNEL
RTRV-TUNNEL
DLT-TUNNEL
Deletes the specified tunnel.
Function
This command deletes a specified tunnel.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-TUNNEL:[<TID>]:<ENT_TUNNELID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-TUNNEL::TUNNEL-1-10:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-TUNNEL
ED-TUNNEL
RTRV-TUNNEL
RTRV-TUNNEL
Retrieves the information about tunnel.
Function
This command retrieves the information about tunnel.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-TUNNEL:[<TID>]:<RTRV_TUNNEL>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<RTRV_TUNNEL>::TYPE=<TUNNELTYPE>,[INPORT=<INPORT>],
[INTNLABEL=<INTNLABEL>],[OUTPORT]=<OUTPORT>,[OUTTNLABEL]=<OUTTNLABEL>,
[NHIP]=<NHIP>,[RETTUNNEL]=<RETTUNNEL>,
[EXPMODE]=<EXPMODE>[EXPVALUE]=<EXPVALUE>,[TTSILSRID]=<TTSILSRID>,
[TTSITUNNELID]=<TTSITUNNELID>;"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-TUNNEL::TUNNEL-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"TUNNEL-1-1::TYPE=ENGRESS, INPORT=FAC-1-1, INTNLABEL=20,OUTPORT= VCG-1-
4,OUTTNLABEL=20,NHIP=10.11.12.12,RETTUNNEL=TUNNEL-1-
2,EXPMODE=VALUE,EXPVALUE=0,TTSILSRID=192.168.0.1,TTSITUNNELID=1"
;
Related Commands
ENT-TUNNEL
ED-TUNNEL
DLT-TUNNEL
ED-TUNNEL
Edits the information of a tunnel.
Function
This command modifies the attributes of the specified tunnel.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-TUNNEL:[<TID>]:[<TID>]:<ENT_TUNNELID>:<CTAG>:::
[RETTUNNEL=<RETTUNNEL>],[EXPMODE=<EXPMODE>],
[EXPVALUE=<EXPVALUE>],[TTSILSRID=<TTSILSRID>],
[TTSITUNNELID=<TTSITUNNELID>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-TUNNEL::TUNNEL-1-
10:100:::EXPMODE=VALUE,EXPVALUE=0,TTSILSRID=192.168.0.1,TTSITUNNELID=2;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-TUNNEL
DLT-TUNNEL
RTRV-TUNNEL
ENT-VB
Creates a virtual bridge (VB).
Function
This command creates a VB.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-VB:[<TID>]:<AID>:<CTAG>:::[VBNAME=<VBNAME>],
[FDBAGTM=<FDBAGTM>],[FILTER=<FILTER>],[LEARNMODE=<LEARNMODE>],
[MACAGETIMEUNIT=<MACAGETIMEUNIT>],
[IGMPSNPDISCAR=<IGMPSNPDISCAR>],[TYPE=<TYPE>],
[STPTXHOLDCOUNT=<STPTXHOLDCOUNT>];
Command Parameters
Parameter Description Default Value
<FDBAGTM> Indicates the filtering database aging time, that is, the 5
Parameter Description Default Value
<MACAGETIMEUNIT> Indicates the unit used for the aging time of the MAC MIN
address. The valid values are as follows:
MIN: minute
HOUR: hour
DAY: day
<IGMPSNPDISCAR> Indicates whether IGMP snooping packets are Y
discarded.
N: not discarded
Y: discarded
<TYPE> Indicates the VB type. The valid values are as follows: 802.1q
802.1q VB
802.1d VB
802.1ad VB
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-VB::VB-1-1-1:100:::VBNAME="VB-
HW",FDBAGTM=20,FLTREN=Y,LEARNMODE=IVL,IGMPSNPDISCAR=N;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-VB
DLT-VB
RTRV-VB
ED-VB
Edits the parameters of a virtual bridge (VB).
Function
This command modifies a VB on the unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-VB:[<TID>]:<AID>:<CTAG>:::[VBNAME=<VBNAME>],
[FDBAGTM=<FDBAGTM>],[MACAGETIMEUNIT=<MACAGETIMEUNIT>],
[IGMPSNPDISCAR=<IGMPSNPDISCAR>],[FLTREN=<FLTREN>],
[LEARNMODE=<LERANMODE>],[TYPE=<TYPE>],[STPTXHOLDCOUNT =
<STPTXHOLDCOUNT>];
Command Parameters
Parameter Description Default Value
<MACAGETIMEUNIT> Indicates the unit used for the aging time of the MIN
MAC address. The valid values are as follows:
MIN: minute
HOUR: hour
DAY: day
<IGMPSNPDISCAR> Indicates whether IGMP snooping packets are Y
discarded.
N: not discarded
Y: discarded
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-VB::VB-1-1-2:100:::VBNAME="VB-
HW",FDBAGTM=20,FLTREN=N,LEARNMODE=SVL,IGMPSNPDISCAR=N;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-VB
DLT-VB
RTRV-VB
DLT-VB
Deletes a virtual bridge (VB).
Function
This command deletes a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-VB:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-VB::VB-1-1-2:101;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-VB
ED-VB
RTRV-VB
RTRV-VB
Retrieves the information about a virtual bridge (VB).
Function
This command retrieves the information about a VB.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-VB:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<VBID>::VBNAME=<VBNAME>,VBLPNUM=<VBLPNUM>,FDBAGTM=<FDBAGTM>,
[MACAGETIMEUNIT=<MACAGETIMEUNIT>],FLTREN=<FLTREN>,LEARNMODE=<LEARNMODE>,
[TYPE=<TYPE>],[STPTXHOLDCOUNT=<STPTXHOLDCOUNT>],
[IGMPSNPDISCAR=<IGMPSNPDISCAR>]"<cr><lf>
;
Response Parameters
Parameter Description
<FDBAGTM> Indicates the filtering database aging time, that is, the aging time of the
MAC address. The valid value ranges from 1 to 120, which is expressed
in minutes. The initial value is 5.
NOTE:
Currently, all VBs share the same FDBAGTM.
Parameter Description
<MACAGETIMEUNIT> Indicates the unit used for the aging time of the MAC address. The valid
values are as follows:
MIN: minute
HOUR: hour
DAY: day
<IGMPSNPDISCAR> Indicates whether IGMP snooping packets are discarded.
N: not discarded
Y: discarded
<FLTREN> Indicates whether the ingress filter is enabled. The valid values are Y and
N.
This parameter is optional. The initial value is Y.
<LEARNMODE> Indicates the VLAN learning constraints. The valid values are as follows:
SVL (shared virtual local area network learning): In this mode,
the VB learns the MAC address of only the message source. The
VLAN ID in the MAC address table is uniformly set.
IVL (independent virtual local area network learning): In this
mode, the VB learns the MAC address of the message source and the
carried VLAN ID, and then stores them into the MAC address table.
This parameter is optional. The initial value is IVL.
Example
Command
RTRV-VB::VB-1-1-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-1-1-2::VBNAME="VB-
HW",FDBAGTM=20,FLTREN=N,LEARNMODE=SVL,IGMPSNPDISCAR=Y"
;
Related Commands
ENT-VB
ED-VB
DLT-VB
ENT-VLANENTRY-VB
Creates a VLAN filter entry of a VB.
Function
This command creates a VLAN filter entry of a VB.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-VLANENTRY-VB:[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,
[VBLPLIST=<VBLPLIST>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-VLANENTRY-VB::VB-1-1-1:100:::VLANID=2,VBLPLIST=VBLP-1-1-1-1&&-4;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ED-VLANENTRY-VB
DLT-VLANENTRY-VB
RTRV-VLANENTRY-VB
ED-VLANENTRY-VB
Edits the VLAN filtering entry of a virtual bridge.
Function
This command edits the VLAN filtering entry of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-VLANENTRY-VB:[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,
[VBLPLIST=<VBLPLIST>];
Command Parameters
Parameter Description Default Value
<VBLPLIST> Indicates the list logical ports of the VB. The valid NA
format is VBLP-<SHELF ID>-<SLOT ID>-<VB
ID>-<VBLP ID>.
This parameter supports the "&" and "&&" symbols.
The valid format is as follows:
VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-
<VBLP ID>&VBLP-<SHELF ID>-<SLOT ID>-
<VB ID>-<VBLP ID>
VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-
<VBLP ID>&&>-<VBLP ID>
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-VLANENTRY-VB::VB-1-1-1:100:::VLANID=2,VBLPLIST=VBLP-1-1-1-1&VBLP-1-1-1-
2&VBLP-1-1-1-6;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-VLANENTRY-VB
DLT-VLANENTRY-VB
RTRV-VLANENTRY-VB
DLT-VLANENTRY-VB
Deletes the VLAN filtering entry of a virtual bridge.
Function
This command deletes the VLAN filtering entry of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-VLANENTRY-VB:[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-VLANENTRY-VB::VB-1-1-1:100:::VLANID=2;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-VLANENTRY-VB
ED-VLANENTRY-VB
RTRV-VLANENTRY-VB
RTRV-VLANENTRY-VB
Retrieves the VLAN entry of a virtual bridge.
Function
This command retrieves the VLAN entry of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-VLANENTRY-VB:[<VLANID>]:<AID>:<CTAG>:::[VLANID=<VLANID>];
Command Parameters
Parameter Description Default Value
<AID> VB-<SHELF>-<SLOT>-<VB> NA
Supports the "&" and "&&" symbols.
Supports ALL, which indicates all values will be
retrieved.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::VLANID=<VLANID>,VBLPLIST=<VBLPLIST>"<cr><lf>
;
Response Parameters
Parameter Description
<VBLPLIST> Indicates the list of VB logical ports. The valid format is VBLP-<SHELF
ID>-<SLOT ID>-<VB ID>-<VBLP ID>.
Supports the "&" and "&&" symbols.
Example
Command
RTRV-VLANENTRY-VB::VB-1-4-1:100:::VLANID=2;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-1-4-1::VLANID=2,VBLPLIST=VBLP-1-4-1-1&VBLP-1-4-1-2&VBLP-1-4-1-6"
;
Related Commands
ENT-VLANENTRY-VB
ED-VLANENTRY-VB
DLT-VLANENTRY-VB
ED-VBLP
Edits a virtual bridge logical port (VBLP).
Function
This command modifies the attributes of a logic port in a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-VBLP:[<TID>]:<AID>:<CTAG>:::[MACLIMIT=<MACLIMIT>],
[ISOLATION=<ISOLATION>];
Command Parameters
Parameter Description Default Value
<ISOLATION> Indicates the isolation mode in a VBLP. The valid values HUB
are HUB and SPOKEN.
NOTE:
If <ISOLATION> of a port is configured as HUB, this
port can interconnect to other HUB ports or SPOKEN ports.
If <ISOLATION> of a port is configured as SPOKEN,
this port can only interconnect to other HUB ports.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-VBLP::VBLP-1-1-2-1:100:::MACLIMIT=100,ISOLATION=HUB;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
Related Commands
RTRV-VBLP
RTRV-VBLP
Retrieves the information about a virtual bridge logical port (VBLP).
Function
This command instructs the NE to retrieve the information about the logical port in a virtual
bridge.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-VBLP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[ISOLATION=<ISOLATION>]"<cr><lf>
;
Response Parameters
Parameter Description
<ISOLATION> Indicates the isolation mode of a VBLP. The valid values are HUB and
SPOKEN.
This parameter is optional.
NOTE:
If the <ISOLATION> of a port is configured as HUB, this port can
interconnect to other HUB ports or SPOKEN ports.
If the <ISOLATION> of a port is configured as SPOKEN, this port can
only interconnect to other HUB ports.
Example
Command
RTRV-VBLP::VBLP-1-1-2-1:100;
RTRV-VBLP::VBLP-1-1-1-ALL:101;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VBLP-1-1-2-1::ISOLATION=HUB"
;
Related Commands
ED-VBLP
INIT-MACENTRY
Initialize the MAC-address forwarding entry of a card.
Function
This command initializes the MAC-address forwarding entry of a card.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
INIT-MACENTRY:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-MACENTRY::SLOT-1-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
None
ENT-PORT-VLANGROUP
Edit a VLAN group for a port.
Function
This command creates a VLAN group for a port.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-PORT-VLANGROUP:
[<TID>]:<AID>:<CTAG>:::TOPID=<TOPID>,CVLANNUM=<CVLANNUM>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-PORT-VLANGROUP::FAC-1-3-4:100:::TOPID=1,CVLANNUM=1
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-PORT-VLANGROUP
DLT-PORT-VLANGROUP
RTRV-PORT-VLANGROUP
ED-PORT-VLANGROUP
Edits the VLAN group of a port.
Function
This command modifies the VLAN group of a port.
Usage Note
For NGWDM equipment, this command is only valid for the TBE.
Category
Configuration
Security
Provisioning
Command Syntax
ED-PORT-VLANGROUP:
[<TID>]:<AID>:<CTAG>:::TOPID=<TOPID>,CVLANNUM=<CVLANNUM>;
Command Parameters
Parameter Description Default Value
<PORT ID>.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-PORT-VLANGROUP::FAC-1-3-4:100:::TOPID=8,CVLANNUM=2
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-PORT-VLANGROUP
DLT-PORT-VLANGROUP
RTRV-PORT-VLANGROUP
DLT-PORT-VLANGROUP
Deletes the VLAN group of a port.
Function
This command deletes the port VLAN group.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-PORT-VLANGROUP:[<TID>]:<AID>:<CTAG>::TOPID=<TOPID>;
Command Parameters
Parameter Description Default Value
ID>-<PORT ID>.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-PORT-VLANGROUP::FAC-1-3-4:100:::TOPID=1
Response Message
NE 2005-11-02 09:48:24
M 100 COMPLD
;
Related Commands
ENT-PORT-VLANGROUP
ED-PORT-VLANGROUP
RTRV-PORT-VLANGROUP
RTRV-PORT-VLANGROUP
Retrieves the VLAN group information about a port
Function
This command retrieves the VLAN group information about a port.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-PORT-VLANGROUP:[<TID>]:<AID>:<CTAG>::[TOPID=<TOPID>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[TOPID=<TOPID>],[CVLANNUM=<CVLANNUM>]"<cr><lf>
Response Parameters
Parameter Description
CVLANNUM = 2^n.
n = 0,1,2,.... .
TOPID + CVLANNUM <= 4096.
CVLANNUM is one factor for TOPID.
Example
Command
RTRV-PORT-VLANGROUP::FAC-1-5-4:100:::TOPID=1
Response Message
NE 2008-10-16 03:43:01
M 100 COMPLD
"FAC-1-5-4::TOPID=1,CVLANNUM=7"
;
Related Commands
ENT-PORT-VLANGROUP
ED-PORT-VLANGROUP
DLT-PORT-VLANGROUP
ENT-MACENTRY-VB
Creates a static MAC filter entry of a virtual bridge (VB).
Function
This command creates a static MAC filter entry of the VB.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MACENTRY-VB:
[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,MACADDR=<MACADDR>,FLTRMO
DE=<FILTMODE>,[FWDVBLP=<FWDVBLP>];
Command Parameters
Parameter Description Default
Value
<VLANID> Indicates the identifier of the VLAN entry. The valid value ranges NA
from 1 to 4095. This parameter is optional and the default VLAN
ID can be used only when <LEARNMODE> of the VB is set to
SVL (see ENT-VB).
<FLTRMODE> Indicates the filter mode. The valid values are SA, DA, BOTH, FORWARD
and FORWARD.
SA: discards the data whose source MAC address is the
same as the specified MAC address. The entry functions as a
MAC address blacklist.
DA: discards the data whose sink MAC address is the
same as the specified MAC address. The entry functions as a
MAC address blacklist.
BOTH: discards the data whose source MAC address or
sink MAC address is the same as the specified MAC address.
The entry functions as a MAC address blacklist.
FORWARD: forwards the data packets whose source
MAC address is the specified MAC address (<MACADDR>)
at the specified VBLP (<FWDVBLP>). The entry functions as
the entry of the static MAC address.
NOTE:
The SA and DA are not valid for NGWDM equipment.
<FWDVBLP> Indicates that the data packets whose source MAC address is the NA
specified MAC address (<MACADDR>) will be forwarded at the
VBLP.
The valid format is VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-
<VBLPID>.
This parameter is available only when <FLTRMODE> is set to
FORWARD.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MACENTRY-VB::VB-1-4-1:100:::VLANID=2,MACADDR=00-32-0B-0E-10-
0D,FLTRMODE=FORWARD,FWDVBLP=VBLP-1-4-1-2;
ENT-MACENTRY-VB::VB-1-4-1:100:::VLANID=2,MACADDR=00-32-0B-0E-10-
0E,FLTRMODE=BOTH;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
DLT-MACENTRY-VB
RTRV-MACENTRY-VB
DLT-MACENTRY-VB
Deletes a static MAC filtering entry of a virtual bridge.
Function
This command deletes a static MAC filtering entry.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MACENTRY-VB:[<TID>]:<AID>:<CTAG>:::
[VLANID=<VLANID>],MACADDR=<MACADDR>;
Command Parameters
Parameter Description Default Value
ID>.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-MACENTRY-VB::VB-1-4-1:100:::VLANID=2,MACADDR=00-32-0B-0E-10-0D;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-MACENTRY-VB
RTRV-MACENTRY-VB
RTRV-MACENTRY-VB
Retrieves the static MAC filtering entry of a virtual bridge.
Function
This command retrieves a static MAC filtering entry of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MACENTRY-VB:[<TID>]:[<AID>]:<CTAG>:::[VLANID=<VLANID>]
Command Parameters
Parameter Description Default Value
<VLANID> Indicates the identifier of the VLAN entry. The valid value NA
ranges from 0 to 4095.
This parameter is optional. If not specified, it outputs the
MAC entries of all VLANIDs.
<VLANID> cannot be entered if the <LEARNMODE> of
the VB is SVL (see ENT-VB).
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[VLANID=<VLANID>,]MACADDR=<MACADDR>,FLTRMODE=<FLTRMODE>,
[FWDVBLP=<VBLP>]"<cr><lf>
;
Response Parameters
Parameter Para Description
<VLANID> Indicates the identifier of the VLAN entry. The valid value ranges from 0 to
4095.
<VLANID> will not be displayed if the <LEARNMODE> of the VB is
SVL (see ENT-VB).
<MACADDR> Indicates the 48-bit MAC address. The valid format is XX-XX-XX-XX-
XX-XX.
This parameter is optional. If not specified, it outputs the MAC entries of all
MAC addresses.
This parameter is required only if <FLAG> (see RTRV-FWDTABPHY-
VB) is set to STATIC.
<FLTRMODE> Indicates the filter mode. The valid values are SA, DA, BOTH, and
FORWARD.
SA: discards the data whose source MAC address is the same as the
Parameter Para Description
Example
Command
RTRV-MACENTRY-VB::VB-1-4-1:100:::VLANID=2;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-1-4-1::VLANID=2,MACADDR=00-32-0B-0E-10-
0D,FLTRMODE=FORWARD,FWDVBLP=VBLP-1-4-1-2"
;
Related Commands
ENT-MACENTRY-VB
DLT-MACENTRY-VB
RTRV-FWDTABPHY-VB
Queries the physical forwarding tables of the VB in batches.
Function
The command queries the physical forwarding tables of the VB in batches.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-FWDTABPHY-VB:[<TID>]:[<AID>]:<CTAG>:::[VLANID=<VLANID>],
[MACADDR=<MACADDR>],[FLAG=<FLAG>],[MAXNUM=<MACMAXNUM>];
Command Parameters
Parameter Description Default Value
<VLANID> Indicates the identifier of the VLAN entry. The valid value NA
ranges from 1 to 4095.
This parameter is optional. If not specified, it outputs the
MAC entries of all VLANIDs.
<VLANID> cannot be entered if the <LEARNMODE> of
the VB is SVL (see ENT-VB).
<MACADDR> Indicates the 48-bit MAC address. The valid format is XX- NA
XX-XX-XX-XX-XX.
This parameter is optional. If not specified, it outputs the
MAC entries of all MAC addresses.
This parameter is required only if <FLAG> is set to
STATIC.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[VLANID=<VLANID>],MACADDR=<MACADDR>,[FWDVBLP=<VBLP>],
[MACSTATE=<MACSTATE>]"<cr><lf>
;
Response Parameters
Parameter Para Description
<VLANID> Indicates the identifier of the VLAN entry. The valid value ranges from 0 to
4095.
<MACADDR> Indicates the 48-bit MAC address. The valid format is XX-XX-XX-XX-
XX-XX.
This parameter is optional. If not specified, it outputs the MAC entries of all
MAC addresses.
This parameter is required only if <FLAG> is set to STATIC.
<MACSTATE> Indicates the MAC address state. The valid values are as follows:
STATIC: indicates the MAC address is manually specified.
DYNAMIC: indicates the MAC address is self-learned.
STATIC-END: indicates the MAC address is the last one of the
static MAC addresses.
DYNAMIC-END: indicates the MAC address is the last one of the
dynamic MAC addresses.
Example
Command
RTRV-FWDTABPHY-VB::VB-1-4-1:100:::VLANID=2,FLAG=BEGIN,MAXNUM=100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-1-4-1::VLANID=2,MACADDR=00-32-0B-0E-10-0D,FWDVBLP=VBLP-4-1-
2,MACSTATE=DYNAMIC "
;
Related Commands
ENT-MACENTRY-VB
DLT-MACENTRY-VB
RTRV-MACSTAT
Retrieves the number of the MAC addresses which are learned by a card.
Function
The command queries the number of the MAC addresses which are learned by a card.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MACSTAT:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::DYNAMIC_NUM=<DYNAMIC_NUM>,STATIC_NUM=<STATIC_NUM>,BLACKLIST_NUM=
<BLACKLIST_NUM>"<cr><lf>
;
Response Parameters
Parameter Para Description
<AID> Indicates the equipment unit identifier. The valid format is SLOT-
<SHELF>-<SLOT>.
Example
Command
RTRV-MACSTAT::SLOT-1-4:100;
Response Message
NE 2005-08-29 10:30:00
M 100 COMPLD
"SLOT-1-4::DYNAMIC_NUM=200,STATIC_NUM=100,BLACKLIST_NUM=50";
Related Commands
None
D.14.7 Configuring IGMP
This section lists the commands used to configure the IGMP function.
ED-IGMP-VB
Edits the Internet Group Management Protocol (IGMP) snooping attributes of a virtual
bridge.
Function
This command modifies the IGMP snooping attributes of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-IGMP-VB:[<TID>]:<AID>:<CTAG>:::[IGSPENABLE=<IGSPENABLE>],
[ROUTERAGTM=<ROUTERAGTM>],[NORSPTIMES=<NORSPTIMES>];
Command Parameters
Parameter Description Default Value
<ROUTERAGTM> Indicates the aging time of the Router port. The valid 8
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-IGMP-VB::VB-1-4-1:100:::IGSPENABLE=Y,ROUTERAGTM=5,NORSPTIMES=2;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-IGMP-VB
RTRV-IGMP-VB
Retrieves the IGMP snooping attributes of a virtual bridge (VB).
Function
This command retrieves the IGMP snooping attributes of a VB.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-IGMP-VB:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[IGSPENABLE=<IGSPENABLE>],[ROUTERAGTM=<ROUTERAGTM>],
[NORSPTIMES=<NORSPTIMES>]"<cr><lf>
;
Response Parameters
Parameter Description
<IGSPENABLE> Indicates whether IGMP snooping is enabled. The valid values are Y and N.
<ROUTERAGTM> Indicates the aging time of the Router port. The valid value ranges from 1
(min) to 120 (min).
NOTE:
Currently, all VBs share the same ROUTERAGTM.
<NORSPTIMES> Indicates the maximum number of times for a member not responding to
IGMP query packets before the member is aging. The value ranges from 1 to
4.
Example
Command
RTRV-IGMP-VB::VB-1-4-1:100;
RTRV-IGMP-VB::VB-1-4-ALL:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-4-1::IGSPENABLE=Y,ROUTERAGTM=8,NORSPTIMES=3"
;
Related Commands
ED-IGMP-VB
ENT-IGMPTABLE-VB
Creates the IGMP table within a VLAN of a virtual bridge.
Function
This command creates the multicast group member of an IGMP within a VLAN of a virtual
bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-IGMPTABLE-VB:[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,MACADDR =
<MACADDR>,[VBLPLIST=<VBLPLIST>]
Command Parameters
Parameter Para Description Default Value
<VLANID> Indicates the identifier of the VLAN entry. The valid value NA
ranges from 0 to 4095.
NOTE:
For TBE cards, the range is from 1 to 4095.
For L4G cards, the range is from 1 to 4094.
<VBLPLIST> Indicates the list of the VB logical ports, the valid format is NA
VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-<VBLP ID>.
Supports the "&" and "&&" symbols.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-IGMPTABLE-VB::VB-1-1-1:100:::VLANID=2,MACADDR=01-00-5e-45-e5-
f6,VBLPLIST=VBLP-1-1-1-1;
Response Message
NE 2007-11-02 09:48:24
M 100 COMPLD
;
Related Commands
ED-IGMPTABLE-VB
DLT-IGMPTABLE-VB
RTRV-IGMPTABLE-VB
ED-IGMPTABLE-VB
Edits the IGMP table within a VLAN of a virtual bridge.
Function
This command modifies the multicast group of an IGMP within a VLAN of a virtual bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-IGMPTABLE-VB:[<TID>]:<AID>:<CTAG>:::VLANID =<VLANID>,MACADDR =
<MACADDR>,[<VBLPLIST>=<VBLPLIST>]
Command Parameters
Parameter Para Description Default Value
<VLANID> Indicates the identifier of the VLAN entry. The valid value NA
ranges from 0 to 4095
NOTE:
For TBE cards, the range is from 1 to 4095.
For L4G cards, the range is from 1 to 4094.
<VBLPLIST> Indicates the list of the VB logical ports, the valid format is NA
VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-<VBLP ID>.
Supports the "&" and "&&" symbols. The valid format is
as follows:
VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-
<VBLP ID>&VBLP-<SHELF ID>-<SLOT ID>-<VB
ID>-<VBLP ID>
VBLP-<SHELF ID>-<SLOT ID>-<VB ID>-
<VBLP ID>&&-<VBLP ID>
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-IGMPTABLE-VB::VB-1-7-1:100:::VLANID=2,MACADDR=01-00-5e-45-e5-f6;
ED-IGMPTABLE-VB::VB-1-7-1:100:::VLANID=2,MACADDR=01-00-5e-45-e5-
f6,VBLPLIST=VBLP-1-7-1-1;
ED-IGMPTABLE-VB::VB-1-7-1:100:::VLANID=2,MACADDR=01-00-5e-45-e5-
f6,VBLPLIST=VBLP-1-7-1-1&VBLP-1-7-1-2;
Response Message
NE 2008-10-16 02:32:56
M 100 COMPLD
;
Related Commands
ENT-IGMPTABLE-VB
DLT-IGMPTABLE-VB
RTRV-IGMPTABLE-VB
DLT-IGMPTABLE-VB
Deletes an item of the IGMP table within a VLAN of a virtual bridge.
Function
This command deletes the multicast group members of an IGMP within a VLAN of a virtual
bridge.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-IGMPTABLE-VB:[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,MACADDR =
<MACADDR>;
Command Parameters
Parameter Para Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-IGMPTABLE-VB::VB-1-1-1:100:::VLANID=2,MACADDR=01-00-5e-45-e5-f6;
Response Message
NE 2008-09-22 21:01:29
M 100 COMPLD
;
Related Commands
ENT-IGMPTABLE-VB
ED-IGMPTABLE-VB
RTRV-IGMPTABLE-VB
RTRV-IGMPTABLE-VB
Retrieves the IGMP table within a VLAN of a virtual bridge.
Function
This command retrieves all the multicast group members of an IGMP within a VLAN of a
virtual bridge.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-IGMPTABLE-VB:[<TID>]:<AID>:<CTAG>:::[VLANID=<VLANID>];
Command Parameters
Parameter Para Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::VLANID=<VLANID>,MACADDR=<MACADDR>,VBLPLIST=<VBLPLIST>"<cr><lf>
;
Response Parameters
Parameter Description
<VBLPLIST> Indicates the list of the VB logical ports, the valid format is VBLP-
<SHELF ID>-<SLOT ID>-<VB ID>-<VBLP ID>.
Supports the "&" and "&&" symbols.
Example
Command
RTRV-IGMPTABLE-VB::VB-1-1-1:100:::VLANID=2;
RTRV-IGMPTABLE-VB::VB-1-1-1:100;
Response Message
NE 2008-09-22 20:57:57
M 100 COMPLD
"VB-1-1-1::VLANID=2,MACADDR=01-00-5e-45-e5-f6,VBLPLIST=VBLP-1-1-1-1"
;
Related Commands
ENT-IGMPTABLE-VB
ED-IGMPTABLE-VB
DLT-IGMPTABLE-VB
RTRV-MCGROUP-VB
Retrieves the multicast group parameters within a virtual bridge.
Function
This command retrieves the actual multicast group parameters within a virtual bridge.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MCGROUP-VB:[<TID>]:<AID>:<CTAG>:::[VLANID=<VLANID>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::VLANID=<VLANID>,[ROUTERPORTLIST=<ROUTERPORT>],
[MACADDR=<MACADDR>],[VBLPLIST=<VBLPLIST>]"<cr><lf>;
Response Parameters
Parameter Description
<MACADDR> Indicates the 48 bit MAC address. The valid format is XX-XX-XX-XX-
XX-XX.
<VBLPLIST> Indicates the list of the VB logical ports, the format is VBLP-<SLOT ID>-
Parameter Description
Example
Command
RTRV-MCGROUP-VB::VB-1-4-1:100:::VLANID=100;
Response Message
NE 2008-09-10 00:54:11
M 100 COMPLD
"VB-1-4-1::VLANID=100,ROUTERPORTLIST=VBLP-1-4-1-4,MACADDR=01-00-5e-00-29-
65,VBLPLIST=VBLP-1-4-1-4"
;
Related Commands
None
ED-IGMP-QKLV
Edits the quick leaving attribute of the Internet Group Management Protocol (IGMP).
Function
This command modifies the quick leaving attribute of the IGMP.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-IGMP-QKLV:
[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,VBLPLIST=<VBLPLIST>,QKLVEN=<
QKLVEN>;
Command Parameters
Parameter Description Default Value
<VB ID>.
<VBLPLIST> Indicates the list logical ports of the VB. The valid NA
format is VBLP-<SHELF ID>-<SLOT ID>-<VB
ID>-<VBLP ID>.
This parameter supports the "&" and "&&" symbols.
<QKLVEN> Indicates whether quick leaving is enabled for the N
IGMP. The valid values are Y and N.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-IGMP-QKLV::VB-1-1-1:100:::VLANID=2,VBLPLIST=VBLP-1-1-1-1&VBLP-1-1-1-
2&VBLP-1-1-1-6,QKLVEN=Y;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-IGMP-QKLVENT-VLANENTRY-VB
DLT-VLANENTRY-VB
RTRV-VLANENTRY-VB
RTRV-IGMP-QKLV
Queries the quick leaving attribute of the IGMP.
Function
This command queries the quick leaving attribute of the IGMP.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-IGMP-QKLV:
[<TID>]:<AID>:<CTAG>:::VLANID=<VLANID>,VBLPLIST=<VBLPLIST>;
Command Parameters
Parameter Description Default Value
<AID> VB-<SHELF>-<SLOT>-<VB> NA
Supports the "&" and "&&" symbols.
Supports ALL, which indicates all values will be
retrieved.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::VLANID=<VLANID>,VBLPLIST=<VBLPLIST>"<cr><lf>
;
Response Parameters
Parameter Description
<VBLP> Indicates the VB logical port. The valid format is VBLP-<SHELF ID>-
<SLOT ID>-<VB ID>-<VBLP ID>.
<QKLVEN> Indicates whether quick leaving is enabled for the IGMP. The valid values
are Y and N.
Example
Command
RTRV-IGMP-QKLV::VB-1-4-1:100:::VLANID=2,VBLP-1-4-1-1&&VBLP-1-4-1-3;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"VB-1-4-1::VLANID=2,VBLP=VBLP-1-4-1-1,QKLVEN=Y"
"VB-1-4-1::VLANID=2,VBLP=VBLP-1-4-1-2,QKLVEN=N"
"VB-1-4-1::VLANID=2,VBLP=VBLP-1-4-1-3,QKLVEN=N"
;
Related Commands
ED-IGMP-QKLVENT-VLANENTRY-VB
ED-VLANENTRY-VB
DLT-VLANENTRY-VB
REPT^EVT^IGMPMEMFULL
Reports an event indicating that the number of dynamic members in the IGMP reaches the
maximum.
Function
This commands reports an event indicating that the number of dynamic members in the
IGMP reaches the maximum. When the event is reported, no new members can be added to
the IGMP.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
A^^<ATAG>^REPT^EVT^VBLP<cr><lf>
^^^"<AID>:<CONDYPE>,<CONDEFF>" <cr><lf> ;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2003-02-28 12:23:20
A 100 REPT EVT IGMPMEMFULL
"SLOT-1-1:256,TC"
;
Related Commands
None
D.14.8 Configuring QoS
This section lists the commands used to configure the QoS function, such as committed
access rate (CAR), class of service (CoS), and queue.
ENT-CAR
Creates the committed access rate (CAR).
Function
This command creates an entry for the CAR within a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-CAR:[<TID>]:<AID>:<CTAG>:::[CARENABLE=<CARENABLE>],[CIR=<CIR>],
[PIR=<PIR>],[DCBS=<DCBS>],[DMBS=<DMBS>];
Command Parameters
Parameter Description Default Value
<PIR> Indicates the peak information rate. The unit is 1 kbit/s and 0
the step length is 64 kbit/s. This parameter is optional.
<DCBS> Indicates the delta committed burst size. The unit is 1 KB. 0
This parameter is optional.
<DMBS> Indicates the delta maximum burst size. The unit is 1 KB. 0
This parameter is optional.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-CAR::CAR-1-1-10:100:::CARENABLE=Y,CIR=10240,PIR=20480;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-CAR
DLT-CAR
RTRV-CAR
ED-CAR
Edits the committed access rate (CAR).
Function
This command modifies the attributes of the specified CAR within a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-CAR:[<TID>]:<AID>:<CTAG>:::[CARENABLE=<CARENABLE>],[CIR=<CIR>],
[PIR=<PIR>],[DCBS=<DCBS>],[DMBS=<DMBS>];
Command Parameters
Parameter Description Default Value
<DCBS> Indicates the delta committed burst size. The unit is 1 KB. 0
This parameter is optional.
<DMBS> Indicates the delta maximum burst size. The unit is 1 KB. 0
This parameter is optional.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-CAR::CAR-1-1-10:100:::CARENABLE=Y,CIR=10240,PIR=20480;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-CAR
DLT-CAR
RTRV-CAR
DLT-CAR
Deletes the committed access rate (CAR).
Function
This command deletes an entry of the CAR within a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-CAR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-CAR::CAR-1-1-10:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-CAR
ED-CAR
RTRV-CAR
RTRV-CAR
Retrieves the information about committed access rate (CAR).
Function
This command retrieves the information about CAR.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-CAR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<CARID>::CARENABLE=<CARENABLE>,CIR=<CIR>,PIR=<PIR>,DCBS=<DCBS>,DMBS=<DM
BS>"<cr><lf>
;
Response Parameters
Parameter Description
<CIR> Indicates the committed information rate of the CAR. Unit is 1 kbit/s.
<DCBS> Indicates the delta committed burst size. The unit is 1 KB.
<DMBS> Indicates the delta maximum burst size. The unit is 1 KB.
Example
Command
RTRV-CAR::CAR-1-1-10:100;
RTRV-CAR::CAR-1-1-ALL:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"CAR-1-1-10::CARENABLE=Y,CIR=10240,PIR=20480,DCBS=0,DMBS=0"
;
Related Commands
ENT-CAR
ED-CAR
DLT-CAR
ENT-COS
Creates the class of service (CoS).
Function
This command creates an entry for the CoS within an unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-COS:[<TID>]:<AID>:<CTAG>:::[COSTYPE=<COSTYPE>];
Command Parameters
Parameter Description Default Value
<COSTYPE> Indicates the type of CoS. The valid values are as follows: SIMPLE
SIMPLE
TAGPRI
IPTOS
MPLSEXP
DSCP
This parameter is optional and the default value is
SIMPLE.
NOTE:
IAGPRI is not valid for L4G.
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-COS::COS-1-1-1:100:::COSTYPE=SIMPLE;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-COS
DLT-COS
RTRV-COS
ED-COS
Edits the class of service (CoS).
Function
This command modifies an entry of the CoS within a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-COS:[<TID>]:<AID>:<CTAG>:::[SIMPLEPRI=<SIMPLEPRI>],
[TAGPRI0=<TAGPRI0>],[TAGPRI1=<TAGPRI1>],[TAGPRI2=<TAGPRI2>],
[TAGPRI3=<TAGPRI3>],[TAGPRI4=<TAGPRI4>],[TAGPRI5=<TAGPRI5>],
[TAGPRI6=<TAGPRI6>],[TAGPRI7=<TAGPRI7>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-COS::COS-1-1-1:100:::SIMPLEPRI=1;
ED-COS::COS-1-1-
1:100:::TAGPRI0=0,TAGPRI1=0,TAGPRI2=0,TAGPRI3=0,TAGPRI4=1,TAGPRI5=1,TAGPRI6
=1,TAGPRI7=1;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-COS
DLT-COS
RTRV-COS
DLT-COS
Deletes the class of service (CoS).
Function
This command deletes an entry of the CoS within a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-COS:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-COS::COS-1-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-COS
ED-COS
RTRV-COS
RTRV-COS
Retrieves the class of service (CoS).
Function
This command retrieves the information about the CoS within a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-COS:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
<AID> Indicates the identifier of the CoS. The valid format is COS- NA
<SHELF ID>-<SLOT ID>-<COS ID>.
Supports the <COS ID> to be entered as ALL to retrieve all
the CoS of the unit.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::COSTYPE=<COSTYPE>,[SIMPLEPRI=<SIMPLEPRI>],[TAGPRI0=<TAGPRI0>],
[TAGPRI1=<TAGPRI1>],[TAGPRI2=<TAGPRI2>],[TAGPRI3=<TAGPRI3>],
[TAGPRI4=<TAGPRI4>],[TAGPRI5=<TAGPRI5>],[TAGPRI6=<TAGPRI6>],
[TAGPRI7=<TAGPRI7>]"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the identifier of the CoS. The valid format is COS-<SHELF ID>-
<SLOT ID>-<COS ID>.
<COSTYPE> Indicates the type of the CoS. The valid values are as follows:
SIMPLE
TAGPRI
This parameter is optional. The default value is SIMPLE.
<SIMPLEPRI> Indicates the simple priority. The valid value ranges from 0 to 7. This
parameter is optional. <SIMPLEPRI> does not have a default value and is
available only when <COSTYPE> is set to SIMPLE (See ENT-COS).
<TAGPRIn> Indicates the priority corresponding to tag priority n. The valid value
ranges from 0 to 7. This parameter is optional. This parameter is valid only
when <COSTYPE> is set to TAGPRI (See ENT-COS).
Example
Command
RTRV-COS::COS-1-1-1:100;
RTRV-COS::COS-1-2-ALL:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"COS-1-1-11::COSTYPE=SIMPLE,SIMPLEPRI=1"
;
NE 2003-02-28 12:23:20
M 100 COMPLD
"COS-1-2-
11::COSTYPE=TAGPRI,TAGPRI0=0,TAGPRI1=0,TAGPRI2=0,TAGPRI3=0,TAGPRI4=1,TAGPRI
5=1,TAGPRI6=1,TAGPRI7=1"
;
Related Commands
ENT-COS
ED-COS
DLT-COS
ED-QUEUE
Edits the queue.
Function
This command edits the parameters of the queue.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-QUEUE:[<TID>]:<AID>:<CTAG>:::QUEUEID=<QUEUEID>,
[SHAPINGENABLE=<SHAPINGENABLE>],[CIR=<CIR>],[PIR=<PIR>],
[DCBS=<DCBS>],[DMBS=<DMBS>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-QUEUE::fac-1-10-1:100:::QUEUEID=1,SHAPINGENABLE=Y,CIR=10240,PIR=20480;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-QUEUE
RTRV-QUEUE
Retrieves the parameters of a queue.
Function
This command retrieves the parameters of a queue.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-QUEUE:[<TID>]:<AID>:<CTAG>:::[<QUEUEID>=<QUEUEID>];
Command Parameters
<QUEUEID> Indicates the ID of the port queue. The valid value ranges NA
from 1 to 8 or it can be ALL.
"ALL" means to retrieve the information about all queues.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::<QUEUEID>=<QUEUEID>,<SHAPINGENABLE>=<SHAPINGENABLE>,CIR=<CIR>,PI
R=<PIR>,DCBS=<DCBS>,DMBS=<DMBS>"<cr><lf>
;
Response Parameters
Parameter Description
<QUEUEID> Indicates the ID of the port queue. The valid value ranges from 1 to 8.
<SHAPINGENABLE> Indicates whether shaping is enabled. The valid values are Y and N.
<CIR> Indicates the committed information rate of shaping. The unit is 1 kbit/s and
generally the step length is 64 kbit.
<PIR> Indicates the peak information rate. The unit is 1 kbit/s and generally its
step length is 64.
<DCBS> Indicates the delta committed burst size. The unit is 1 KB.
<DMBS> Indicates the delta maximum burst size. The unit is 1 KB.
Example
Command
RTRV-QUEUE::FAC-1-1-10:100;
Response Message
M1050 2003-02-28 12:23:20
M 100 COMPLD
"FAC-1-1-
10::QUEUEID=1,SHAPINGENABLE=Y,CIR=10240,PIR=20480,DCBS=0,DMBS=0"
;
Related Commands
ED-QUEUE
ED-PORT-SHAPING
Edits the shaping attribute of a port.
Function
This command modifies the shaping attribute of a port.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-PORT-SHAPING:[<TID>]:<AID>:<CTAG>:::[SHAPINGEN=<SHAPINGEN>],
[CIR=<CIR>],[DCBS=<DCBS>],[PIR=<PIR>],[DMBS=<DMBS>];
Command Parameters
Parameter Description Default Value
<DCBS> Indicates the delta committed burst size. The unit is 1 KB. 0
This parameter is optional.
<PIR> Indicates the peak information rate. The unit is 1 kbit/s and 0
generally the step length is 64 kbit/s. This parameter is
optional.
<DMBS> Indicates the delta maximum burst size. The unit is 1 KB. 0
This parameter is optional.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-PORT-SHAPING::fac-1-10-1:100:::SHAPINGEN=Y,CIR=10240,PIR=20480;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
RTRV-PORT-SHAPINGRTRV-QUEUE
RTRV-PORT-SHAPING
Queries the shaping attribute of a port.
Function
This command queries the shaping attribute of a port.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-PORT-SHAPING:[<TID>]:<AID>:<CTAG>;
Command Parameters
<PORT ID>.
Supports the "&" and "&&" symbols.
Supports ALL, which indicates all values will be retrieved.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::<SHAPINGEN>=<SHAPINGEN>,CIR=<CIR>,PIR=<PIR>,DCBS=<DCBS>,DMBS=<DM
BS>"<cr><lf>
;
Response Parameters
Parameter Description
<SHAPINGEN> Indicates whether shaping is enabled. The valid values are Y and N.
<CIR> Indicates the committed information rate of the shaping. The unit is 1 kbit/s
and generally the step length is 64 kbit.
<PIR> Indicates the peak information rate. The unit is 1 kbit/s and generally its step
length is 64 kbit/s.
<DCBS> Indicates the delta committed burst size. The unit is 1 KB.
<DMBS> Indicates the delta maximum burst size. The unit is 1 KB.
Example
Command
RTRV-PORT-SHAPING::FAC-1-1-10:100;
Response Message
M1050 2003-02-28 12:23:20
M 100 COMPLD
"FAC-1-1-10::SHAPINGEN=Y,CIR=10240,PIR=20480,DCBS=0,DMBS=0"
;
Related Commands
ED-PORT-SHAPINGED-QUEUE
ENT-MIRROR
Creates a mirror port.
Function
This command creates a mirror port in the unit. All packets of the mirror port can be
duplicated to another specified port, which then can collect and analyze the traffic of the
mirror port.
Usage Note
If any service is running on the monitored port, an error message will be displayed.
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MIRROR:[<TID>]:<AID>:<CTAG>:::[INGRESS=<INGRESS>],
[EGRESS=<EGRESS>];
Command Parameters
Parameter Description Default Value
<EGRESS> Indicates the egress mirror port. The packets sent by the NA
egress mirror port are duplicated to the specified
monitored port (<AID>).
The valid format is FAC/ACC-<SHELF ID>-<SLOT
ID>-<PORT ID>.
This parameter is optional. The default setting will
indicate absence of an egress mirror port.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MIRROR::FAC-1-1-1:100:::INGRESS=FAC-1-1-2,EGRESS=FAC-1-1-4;
ENT-MIRROR::FAC-1-1-1:102:::INGRESS=ACC-1-1-2,EGRESS=ACC-1-1-3;
ENT-MIRROR::FAC-1-1-1:102:::INGRESS=ACC-1-1-2;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ED-MIRROR
DLT-MIRROR
RTRV-MIRROR
ED-MIRROR
Edits a mirror port.
Function
This command modifies the attributes of a mirror port in the unit.
Usage Note
If there is a service existing on the observing port, an error result will be returned.
Category
Configuration
Security
Provisioning
Command Syntax
ED-MIRROR:[<TID>]:<AID>:<CTAG>:::[INGRESS=<INGRESS>],
[EGRESS=<EGRESS>];
Command Parameters
Parameter Description Default Value
<INGRESS> Indicates the ingress mirror port. The packets received are NA
copied to the specified observing port (<AID>).
The valid format is FAC/ACC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
This parameter is optional. An ingress mirror port will not be
indicated unless this parameter is set.
<EGRESS> Indicates the egress mirror port. The packets sent are copied NA
to the specified observing port (<AID>).
The valid format is FAC/ACC-<SHELF ID>-<SLOT ID>-
<PORT ID>.
This parameter is optional. An egress mirror port will not be
indicated unless this parameter is set.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-MIRROR::FAC-1-1-1:100:::INGRESS=FAC-1-1-2,EGRESS=FAC-1-1-4;
ED-MIRROR::FAC-1-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
ENT-MIRROR
DLT-MIRROR
RTRV-MIRROR
RTRV-MIRROR
Retrieves information about a mirror port.
Function
This command retrieves information about a mirror port in a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MIRROR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[INGRESS=<INGRESSMIRROR>],[EGRESS=<EGRESSMIRROR>]"<cr><lf>
;
Response Parameters
Parameter Description
<INGRESS> Indicates the ingress mirror port. The packets received are copied to a
specified observing port (<AID>).
Parameter Description
<EGRESS> Indicates the egress mirror port. The packets sent are copied to the
specified observing port(<AID>).
The valid format is FAC/ACC-<SHELF ID>-<SLOT ID>-<PORT ID>.
This parameter is optional. An egress mirror port will not be indicated
unless this parameter is set.
Example
Command
RTRV-MIRROR::FAC-1-1-1:100;
RTRV-MIRROR::FAC-1-1-ALL:100;
RTRV-MIRROR::ALL:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FAC-1-1-1::INGRESS=FAC-1-1-2,EGRESS=FAC-1-1-4"
;
Related Commands
ENT-MIRROR
ED-MIRROR
DLT-MIRROR
DLT-MIRROR
Deletes a mirror port.
Function
This command deletes a mirror port in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MIRROR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-MIRROR::FAC-1-1-1:100;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ENT-MIRROR
ED-MIRROR
RTRV-MIRROR
D.14.10 Configuring OAM
This section lists the commands used to configure the Ethernet OAM function.
OPR-OAM-LB
Operates an Ethernet OAM loopback test.
Function
This command is used to operate an Ethernet OAM loopback test.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
OPR-OAM-LB:[<TID>]:<AID>:<CTAG>:::LBTYPE=<LBTYPE>,
[DSTMPID=<DSTMPID>],[DSTMACADDR =<DSTMACADDR >];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::LBTYPE=<MPSTDTYPE>,[DSTMPID=<DSTMPID>],
[DSTMACADDR=<DSTMACADDR>],[OAMRESULT=<OAMRESULT>]"<cr><lf>
;
Response Parameters
Parameter Description
<LBTYPE> Indicates the type of an LB test. The valid values are as follows:
MP: LB test based on MP
MACADDR: LB test based on MAC address
<OAMRESULT> Indicates the test result. The valid values are FAIL and SUCCESS.
Example
Command
OPR-OAM-LB::MP-1-1-10:100:::LBTYPE=MP,DSTMPID=2;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
"MP-1-1-10::DSTMPID=2,OAMRESULT=SUCCESS"
;
Related Commands
ENT-MD
DLT-MD
RTRV-MD
OPR-OAM-LT
Operates an Ethernet OAM link trace test.
Function
This command is used to operate an Ethernet OAM link trace test.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
OPR-OAM-LT:[<TID>]:<AID>:<CTAG>:::DSTMPID=<DSTMPID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[DSTMPID=<DSTMPID],[RSPMPID=<RSPMPID>],
[RSPMACADDR=<RSPMACADDR>],[RSPMPTYPE=<RSPMPTYPE>],[HOPNUM=<HOPNUM>],
[OAMRESULT=<OAMRESULT>]"<cr><lf>
;
Response Parameters
Parameter Description
<RSPMACADDR> Indicates the RSP MP address. This parameter is valid for standard MP.
<RSPMPTYPE> Indicates the RSP MP type. The valid values are as follows:
MEP: maintenance end point.
MIP: maintenance intermediate point.
NULL: unknown MP type.
<HOPNUM> Indicates the hop number. The valid value ranges from 0 to 255.
Parameter Description
<OAMRESULT> Indicates test result. The valid values are FAIL and SUCCESS.
Example
Command
OPR-OAM-LT::MP-1-1-10:100:::DSTMPID=2;
Response Message
NE 2008-08-05 17:50:00
M 100 COMPLD
"MP-1-1-
10::DSTMPID=2,RSPMPID=3,RSPMPTYPE=MEP,HOPNUM=1,OAMRESULT=SUCCESS"
;
Related Commands
ENT-MD
DLT-MD
RTRV-MD
ENT-MD
Creates a maintenance domain (MD).
Function
This command creates an MD of Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MD[<TID>]:<AID>:<CTAG>:::LEVEL=<LEVEL>,NAMETYPE=<NAMETYPE>,
[NAME=<NAME>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MD::MD-1-2-1:1:::LEVEL=0,NAMETYPE=STRING,NAME="MD1"
Response Message
NE 2008-08-25 18:54:51
M 1 COMPLD
;
Related Commands
DLT-MD
RTRV-MD
DLT-MD
Deletes an MD (maintenance domain).
Function
This command deletes a MD for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MD:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-MD::MD-1-1-10:100;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MD
RTRV-MD
RTRV-MD
Retrieves the maintenance domain (MD).
Function
This command retrieves an MD for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MD:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[LEVEL=<LEVEL>],[NAMETYPE=<NAMENAME>],[NAME=<NAME>],
[MALIST=<MAID>]"<cr><lf>
;
Response Parameters
Parameter Description
<LEVEL> Indicates the level of the MD, which is used to identify different customers.
The valid value ranges from 0 to 7. The value "0" indicates the highest
priority.
<NAME> Indicates the MD name. It is a string which contains no more than 20 ASCII
characters.
<MALIST> The identifier of the MA (a collection of MPs of the same VLAN ID within
an MD).
Parameter Description
Example
Command
RTRV-MD::MD-1-1-10:100;
RTRV-MD::MD-1-1-ALL:100;
RTRV-MD::ALL:100;
Response Message
NE 2008-08-05 18:05:00
M 100 COMPLD
"MD-1-1-10:: LEVEL=7,NAMETYPE=NONAME,NAME=,MALIST=MA-1-11-1&MA-1-11-2"
;
Related Commands
ENT-MD
DLT-MD
ENT-MA
Creates a maintenance association (MA).
Function
This command creates an MA for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MA:[<TID>]:<AID>:<CTAG>:::MDID=<MD_AID>,NAME=<MANAME>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MA::MA-1-2-1:1:::MDID=MD-1-2-1,NAME=MA1;
Response Message
NE 2008-08-25 18:54:51
M 1 COMPLD
;
Related Commands
DLT-MA
RTRV-MA
DLT-MA
Deletes a maintenance association (MA).
Function
This command deletes an MA for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MA:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-MA::MA-1-1-10:100;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MA
RTRV-MA
RTRV-MA
Retrieves the maintenance association (MA).
Function
This command retrieves the MA for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MA:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[MD=<SPEC_MDID>],[NAME=<MANAME>]"<cr><lf>
;
Response Parameters
Parameter Description
<NAME> Indicates the MA name. It is a string which contains no more than 20 ASCII
characters.
Example
Command
RTRV-MA::MA-1-1-10:100;
RTRV-MA::MA-1-1-ALL:100;
RTRV-MA::ALL:100;
Response Message
NE 2005-08-05 18:05:00
M 100 COMPLD
"MA-1-1-10::MD=MD-1-1-1,NAME=HUAWEI"
;
Related Commands
ENT-MA
DLT-MA
ENT-MP
Creates a maintenance point (MP).
Function
This command creates an MP for Ethernet OAM in a unit.
Usage Note
For NGWDM equipment, the OAM function is not supported by the L4G.
Category
Configuration
Security
Provisioning
Command Syntax
ENT-MP:
[<TID>]:<AID>:<CTAG>:::STANDARDTYPE=<STANDARDTYPE>,SRVTYPE=<SRVTY
PE>,LINKFROM=<LINKFROM>,LINKTO=<LINKTO>,[INTAG=<INTAG>],
[INSTAG=<INSTAG>],[VLANID=<VLANID>],
[LEVEL=<LEVEL>],MPTYPE=<MPTYPE>,MPDIR=<MPDIR>,
[CCTIMER=<CCTIMER>],[LBTIME=<LBTIME>],[LTTIME=<LTTIME>],
[MCCCSTATUS=<MCCCSTATUS>],[MD=<MD>],[MA=<MA>],
[MACADDR=<MACADDR>],[IPADDR=<IPADDR>],
[PINGFRAMELENGTH=<PINGFRAMELENGTH>],
[PINGOVERTIME=<PING_OVER_TIME>],
[PDFRAMELENGTH=<PDFRAMELENGTH>],[PDOVERTIME=<PDOVERTIME>],
[AISSTATE=<AISSTATE>],[CLIENTLAYER=<CLIENTLAYER>],
[AISPERIOD=<AISPERIOD>];
Command Parameters
Parameter Description Default Value
<STANDARDTYPE> Indicates the type of the MP. The valid values are as NA
follows:
NOSTANDARDMP: draft 3 MP
STANDARDMP: standard MP
<LBTIME> Indicates the period when an LB test times out. This 5000 (ms)
parameter is used for the LB test.
The valid value ranges from 3000 to 60000 (units in
milliseconds with the step length of 100).
<LTTIME> Indicates the period when an LT test times out. This 5000(ms)
parameter is used for the LT test that serves the same
purpose as that of the LB test.
Parameter Description Default Value
<CLIENTLAYER> Indicates the client layer. The valid value ranges from 7
1 to 7.
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-MP::MP-1-12-2:C:::STANDARDTYPE=STANDARDMP,SRVTYPE=LINK,LINKFROM=FAC-1-
12-3,LINKTO=ACC-1-12-
1,VLANID=2,MPTYPE=MEP,MPDIR=INGRESS,CCTIMER=4,LBTIME=5000,LTTIME=5000,MCCCS
TATUS=INACTIVE,MD=MD-1-12-1,MA=MA-1-12-1,MACADDR=01-80-c2-00-00-
30,IPADDR=10.1.1.2,PINGFRAMELENGTH=64,PINGOVERTIME=3,PDFRAMELENGTH=64,PDOVE
RTIME=3,AISSTATE=ACTIVE,CLIENTLAYER=7,AISPERIOD=60000;
Response Message
NE 2008-08-25 18:54:51
M C COMPLD
;
Related Commands
ED-MP
DLT-MP
RTRV-MP
ED-MP
Edits the maintenance point (MP).
Function
This command modifies the MP for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-MP:[<TID>]:<AID>:<CTAG>:::[CCTIMER=<CCTIMER>],[LBTIME=<LBTIME>],
[LTTIME=<LTTIME>],[MCCCSTATUS=<MCCCSTATUS>],
[MACADDR=<MPCCMAC>],[IPADDR=<MPIP>],
[PINGFRAMELENGTH=<MPPINGFRMLEN>],
[PINGOVERTIME=<MPPINGOVERTIME>],
[PDFRAMELENGTH=<MPPDFRMLEN>],[PDOVERTIME=<MPPDOVERTIME>],
[AISSTATE=<AISSTATE>],[CLIENTLAYER=<CLIENTLAYER>],
[AISPERIOD=<AISPERIOD>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-MP::MP-1-12-
2:C:::CCTIMER=4,LBTIME=5000,LTTIME=5000,MCCCSTATUS=INACTIVE,MD=MD-1-12-
1,MA=MA-1-12-1,MACADDR=01-80-c2-00-00-
30,IPADDR=10.1.1.2,PINGFRAMELENGTH=64,PINGOVERTIME=3,PDFRAMELENGTH=64,PDOVE
RTIME=3,AISSTATE=ACTIVE,CLIENTLAYER=7,AISPERIOD=60000;
Response Message
NE 2008-08-25 18:54:51
M C COMPLD
;
Related Commands
ENT-MP
DLT-MP
RTRV-MP
DLT-MP
Deletes a maintenance point (MP).
Function
This command deletes an MP for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
DLT-MP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Parameters
None
Example
Command
DLT-MP::MP-1-1-10:100;
Response Message
NE 2005-08-05 17:50:00
M 100 COMPLD
;
Related Commands
ENT-MP
ED-MP
RTRV-MP
RTRV-MP
Retrieves a maintenance point (MP).
Function
This command retrieves an MP for Ethernet OAM in a unit.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-MP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::STANDARDTYPE=<STANDARDTYPE>,SRVTYPE=<SRVTYPE>,LINKFROM=<LINKFROM
>,LINKTO=<LINKTO>,[INTAG=<INTAG>],[INSTAG=<INSTAG>],[VLANID=<VLANID>],
[LEVEL=<LEVEL>],MPTYPE=<MPTYPE>,MPDIR=<MPDIR>,CCTIMER=<CCTIMER>,LBTIME=<LBT
IME>,LTTIME=<LTTIME>,MCCCSTATUS=<MCCCSTATUS>,[MD=<MD>],[MA=<MA>],
[ MACADDR=<MACADDR>],[IPADDR=<IPADDR>],[PINGFRAMELENGTH=<PINGFRAMELENGTH>],
[PINGOVERTIME=<PINGOVERTIME>],[PDFRAMELENGTH=<PDFRAMELENGTH>],
[PDOVERTIME=<PDOVERTIME>],[AISSTATE=<AISSTATE>],
[CLIENTLAYER=<CLIENTLAYER>],[AISPERIOD=AISPERIOD]"<cr><lf>
;
Response Parameters
Parameter Description
<STANDARDTYPE> Indicates the type of the MP. The valid values are as follows:
NOSTANDARDMP: draft 3 MP
STANDARDMP: standard MP
<INTAG> Indicates the tag of incoming packets. The tag can be a VLAN ID. This
parameter is optional and indicates an EPL in this response.
<INSTAG> Indicates the VLAN tag of the incoming service. This parameter is
optional.
Parameter Description
<LEVEL> Indicates the level of OAM frames, which is used to identify different
customers.
The valid value ranges from 0 to 7. The value "0" indicates the highest
priority.
<CCTIMER> Indicates the transmission cycle of the continuity check (CC) message.
This parameter is used for the CC test.
<LBTIME> Displays the LB test timeout time. This parameter is used for the LB
test.
The valid value ranges from 3000 to 60000. Units are in milliseconds
and the step length is 100.
<LTTIME> Displays the LT test timeout time. This parameter is used for the LT
test, which serves the same purpose as that of the LB test.
The valid value ranges from 3000 to 60000. Units are in milliseconds
and the step length is 100.
<CLIENTLAYER> Indicates the client layer. The valid value ranges from 1 to 7.
Sets the alarm suppression level of a node. This level should be higher
than the level of the MD in which the node resides.
<AISPERIOD> Indicates the AIS period (units are in milliseconds and there are not any
step lengths).
Example
Command
RTRV-MP::MP-1-12-1:C;
Response Message
NE 2008-08-25 00:27:16
M C COMPLD
"MP-1-12-1::STANDARDTYPE=STANDARDMP,SRVTYPE=LINK,LINKFROM=FAC-1-12-
3,LINKTO=ACC-1-12-
1,VLANID=1,LEVEL=0,MPTYPE=MEP,MPDIR=INGRESS,CCTIMER=5000,LBTIME=5000,LTTIME
=5000,MCCCSTATUS=INACTIVE,MD=MD-1-12-1,MA=MA-1-12-1,MACADDR=01-80-c2-00-00-
30,IPADDR=10.1.1.1,PINGFRAMELENGTH=64,PINGOVERTIME=3,PDFRAMELENGTH=64,PDOVE
RTIME=3,AISSTATE=ACTIVE,CLIENTLAYER=7,AISPERIOD=60000"
;
Related Commands
ENT-MP
DLT-MP
ED-MP
REPT^EVT^OAMSERVICELOOP
Reports service loop events.
Function
When the OAM service loop is detected by the ETHOAM protocol, the MP service loop
events will be reported.
This function is only valid for nonstandard MPs.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
A^^<ATAG>^REPT^EVT^OAMSERVICELOOP<cr><lf>
^^^"<AID>:<PORT>,<VLANID>,<LEVEL>,<DIR>" <cr><lf>
;
Response Parameters
Parameter Description
<PORT> Indicates the channel on which the service loop occurred. The valid format
is FAC/ACC-<SHELF>-<SLOT>-<PORT>.
Example
Command
None
Response Message
NE 2008-12-11 15:11:53
* 667681 REPT EVT OAMSERVICELOOP
"MP-1-3-1:FAC-1-3-1,1,0,EGRESS"
;
>
Related Commands
None
STA-OAM-PING
Starts an OAM ping test.
Function
This command instructs an NE to start a ping test.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
STA-OAM-PING:[<TID>]:<AID>:<CTAG>:::DSTIP=<DSTIP>,PINGTIME =
<PINGTIME>;
Command Parameters
Parameter Description Default Value
Response Parameters
None
Example
Command
STA-OAM-PING::MP-1-12-2:a:::dstip=129.9.0.100,pingtime=100;
Response Message
NE 1990-01-03 10:36:49
M A COMPLD
;
Related Commands
None
STP-OAM-PING
Stops an Ethernet OAM ping test.
Function
This command instructs an NE to stop a ping test.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
STP-OAM-PING:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS>
<cr><lf>M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STP-OAM-PING::MP-1-12-2:a;
Response Message
NE 2008-01-03 10:36:49
M A COMPLD
;
Related Commands
None
STA-OAM-PERDECT
Starts Ethernet OAM performance detection
Function
This command instructs an NE to start Ethernet OAM performance detection.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
STA-OAM-PERDECT:
[<TID>]:<AID>:<CTAG>:::DSTMP=<DSTMP>,PDTIME=<PDTIME>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STA-OAM-PERDECT::MP-1-12-1:1:::DSTMP=2,PDTIME=10;
Response Message
NE 1990-01-03 12:59:28
M 1 COMPLD
;
Related Commands
None
STP-OAM-PERDECT
Stops Ethernet OAM performance detection.
Function
This command instructs an NE to stop Ethernet OAM performance detection.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
STP-OAM-PERDECT:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STP-OAM-PERDECT::MP-1-12-1:1;
Response Message
NEW-NE 1990-01-03 12:59:28
M 1 COMPLD
;
Related Commands
None
ED-P2POAM-ADMIN
Edits the administration parameters of the point-to-point OAM.
Function
This command modifies the administration parameters of the point-to-point OAM.
Usage Note
None
Category
Configuration
Security
Provisioning
Command Syntax
ED-P2POAM-ADMIN:[<TID>]:<AID>:<CTAG>:::
[P2POAMENABLE=<P2POAMENABLE>],[P2POAMMODE=<P2POAMMODE>],
[LNKEVTNTFY=<LNKEVTNTFY>],[RSPRMTLB=<RSPRMTLB>],
[ERRFRMWINDOW=<ERRFRMWINDOW>],[ERRFRMTH=<ERRFRMTH>],
[ERRFRMPRDWINDOW=<ERRFRMPRDWINDOW>],
[ERRFRMPRDTH=<ERRFRMPRDTH>],
[ERRFRMSECWINDOW=<ERRFRMSECWINDOW>],
[ERRFRMSECTH=<ERRFRMSECTH>],[UNIOPEREN=<UNIOPEREN>],
[RMTLBCNTL=<RMTLBCNTL>],[LDPORTBLOCK=<LDPORTBLOCK>],
[LDENABLE=<LDENABLE>];
Command Parameters
Parameter Description Default Value
<ERRFRMPRDWINDOW> Indicates the monitoring time window of the error Maxpps (The
frame period (units in frames). value varied
The value is determined as follows: with different
1. Based on the MaxSpeed (units are in bits units.)
and valid values are: 10M, 100M, 1000M, or
10000M) that the specific card supports, the
following formula is used to compute the
maximum number of frames that the port can
receive per second at the maximum speed. (The
frames are computed at 64 bytes; preambles at 8
bytes; and IPG*Speed 96 bits.).
Maxpps (number of frames received per second) =
MaxSpeed/(Frame*8 + Preamble*8 + IPG*Speed)
= MaxSpeed/(64*8 + 8*8 + 96). The result should
be an integer.
NOTE:
The values of Maxpps at each rate are as follows:
10 Mbit/s: 14880
100 Mbit/s: 148800
1000 Mbit/s: 1488000
10 Gbit/s: 14880000
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-P2POAM-ADMIN::FAC-1-2-
4:100:::P2POAMENABLE=DISABLE,P2POAMMODE=ACTIVE,LNKEVTNTFY=ENABLE,RSPRMTLB=D
ISABLE,ERRFRMWINDOW=1000,ERRFRMTH=1,ERRFRMPRDWINDOW=14880000,ERRFRMPRDTH=1,
ERRFRMSECWINDOW=60,ERRFRMSECTH=1,UNIOPEREN=DISABLE,LDPORTBLOCK=ENABLE,LDENA
BLE=DISABLE
Response Message
NE 2005-08-05 16:55:00
M 100 COMPLD
;
Related Commands
RTRV-P2POAM-ADMIN
RTRV-P2POAM-ADMIN
Retrieves the administration parameters of the point-to-point OAM
Function
This command retrieves the administration parameters of the point-to-point OAM.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-P2POAM-ADMIN:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::[P2POAMENABLE=<P2POAMENABLE>],[P2POAMMODE=<P2POAMMODE>],
[LNKEVTNTFY=<LNKEVTNTFY>],[RSPRMTLB=<RSPRMTLB>],
[ERRFRMWINDOW=<ERRFRMWINDOW>],[ERRFRMTH=<ERRFRMTH>],
[ERRFRMPRDWINDOW=<ERRFRMPRDWINDOW>],[ERRFRMPRDTH=<ERRFRMPRDTH>],
[ERRFRMPRDTH=<ERRFRMPRDTH>],[ERRFRMSECWINDOW=<ERRFRMSECWINDOW>],
[ERRFRMSECTH=<ERRFRMSECTH>],[UNIOPEREN=<UNIOPEREN>],
[RMTLBSTATE=<RMTLBSTATE>],[LDPORTBLOCK=<LDPORTBLOCK>],[LDENABLE
=<LDENABLE>]"<cr><lf>
;
Response Parameters
Parameter Description
<P2POAMENABLE> Indicates whether the Ethernet OAM is enabled. The valid values are
DISABLE and ENABLE.
<P2POAMMODE> Indicates the working mode of Ethernet OAM. The valid values are
PASSIVE and ACTIVE.
<RMTLBSTATE> Indicates the state of the remote loopback in Ethernet OAM. The
valid value is as follows:
NOLOOP: no loopback
STALOOP: start loopback at local point.
RSPLOOP: response to remote loopback.
<LDPORTBLOCK> Indicates whether port blocking is enabled. The valid values are
Parameter Description
<LDENABLE> Indicates whether loopback detection is enabled. The valid values are
DISABLE and ENABLE.
<RMTLNKEVTNTFY> Indicates whether the remote reporting of Ethernet OAM link events
is supported by the opposite port. The valid values are DISABLE
and ENABLE.
<RMTP2POAMMODE> Indicates the Ethernet OAM work mode of the opposite port. The
valid values are PASSIVE and ACTIVE.
<RMTMAXOAMPKTLEN> Indicates the maximum length of the OAM packet of the opposite
port (units in bytes).
Example
Command
RTRV-P2P0AM-ADMIN::FAC-1-2-4:C;
Response Message
NE 2008-01-06 20:25:54
M C COMPLD
"FAC-1-2-
4::P2POAMENABLE=ENABLE,P2POAMMODE=ACTIVE,LNKEVTNTFY=ENABLE,RSPRMTLB=DISABLE
,ERRFRMWINDOW=1000,ERRFRMPRDWINDOW=14880000,ERRFRMPRDTH=1,ERRFRMSECWINDOW=6
0,ERRFRMSECTH=1,LDPORTBLOCK=ENABLE,LDENABLE=DISABLE"
;
>
Related Commands
ED-P2POAM-ADMIN
STA-PING-<FETH/GETH/XGETH>
Starts sending Ethernet test frames.
Function
This command instructs an NE to start sending Ethernet test frames.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
STA-PING-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>:::
[PKTNUM=<PKTNUM>];
Command Parameters
Parameter Description Default Value
<MOD2> The valid values for modifier 2 are FETH, GETH and NA
XGETH (10GETH).
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STA-PING-GETH::ACC-1-1-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STP-PING-<FETH/GETH/XGETH>
RTRV-PING-<FETH/GETH/XGETH>
STP-PING-<FETH/GETH/XGETH>
Stops sending Ethernet test frames.
Function
This command instructs an NE to stop sending Ethernet test frames.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
STP-PING-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<MOD2> The valid values for modifier 2 are FETH, GETH and NA
XGETH (10GETH).
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STP-PING-GETH::ACC-1-1-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STA-PING-<FETH/GETH/XGETH>
RTRV-PING-<FETH/GETH/XGETH>
RTRV-PING-<FETH/GETH/XGETH>
Retrieves the parameters of a ping test.
Function
This command instructs the NE to retrieve the state and count of Ethernet test frames.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
RTRV-PING-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<MOD2> The valid values for modifier 2 are FETH, GETH and NA
XGETH (10GETH).
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::TESTMODE=<TESTMODE>,[PKTNUM=<PKTNUM>],TOTALSEND=<TOTALSEND>,
[RESPONDRECV=<RESPONDRECV>,NORMALRECV=<NORMALRECV>]"<cr><lf>
;
Response Parameters
Parameter Description
<PKTNUM> Indicates the number of test packets. By default, packets are continuously sent
until a user changes this parameter.
This parameter is optional. It is required only when <TESTMODE> is set to
BURST.
Example
Command
RTRV-PING-GETH::ACC-1-1-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"ACC-1-1-
2::TESTMODE=BURST,PKTNUM=200,TOTALSEND=200,RESPONDRECV=200,NORMALRECV=0"
;
Related Commands
STA-PING-<FETH/GETH/XGETH>
STP-PING-<FETH/GETH/XGETH>
INIT-PING-<FETH/GETH/XGETH>
Initializes the ping test parameters.
Function
This command initializes the counter for Ethernet test frames.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
INIT-PING-<FETH/GETH/XGETH>:[<TID>]:<AID>:<CTAG>:::
[COUNTERTYPE=<COUNTERTYPE>];
Command Parameters
Parameter Description Default Value
<MOD2> The valid values for modifier 2 are FETH, GETH and NA
XGETH (10GETH).
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-PING-GETH::ACC-1-1-1:100:::COUNTERTYPE=NORM-RECV;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STA-PING-<FETH/GETH/XGETH>
RTRV-PING-<FETH/GETH/XGETH>
REPT^EVT^PING
Reports the frame test event.
Function
This command reports the result of the frame test.
Usage Note
None
Category
Configuration
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
A^^<ATAG>^REPT^EVT^PING<cr><lf>
^^^"<AID>:<RESPONDRECV>,<NORMALRECV>,<TOTALSEND>,<IPFLAG>" <cr><lf> ;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2003-02-28 12:23:20
A 100 REPT EVT PING
"ACC-1-5-3:100,100,100,COMPLD"
;
Related Commands
None
STA-CAPT
Create port capture rules.
Function
This command instructs an NE create port capture rules.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
STA-CAPT:[<TID>]:<STA_PCSN>:<CTAG>:::PORT=<INPORT>,
[VLANID=<PKTVLANID>],[CAPTDIR=<CAPTDIR>],[PKTTYPE=<DFTPKTTYPE>],
[CAPTNUM=<CAPTNUM>];
Command Parameters
Parameter Description Default Value
<CAPTDIR> Indicates the direction from which the user will capture NA
packet. Valid value can be as follows:TX: 1 RX: 2
,Optional, default value is TX.
<PKTTYPE> Type of the packet that will be captured. Valid value can GFPCMF
be as follows:
GFPCMF:1(If <PORT> is ACC-<SLOT ID>-<PORT>)
Parameter Description Default Value
LPT:2
IGMP:3
RSTP:4
MPLSOAM:5
ETHOAM:6
LACP:7.
this is Optional, default value is GFPCMF
<CAPTNUM> Indicates the total count of packet. NA
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STA-CAPT::PCSN-1-1:100:::PORT=FAC-1-
1,VLANID=1,CAPTDIR=RX,PKTTYPE=RSTP,CAPTNUM=10;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STP-CAPT
RTRV-CAPT
STP-CAPT
Delete port capture rules.
Function
This command instructs an NE delete port capture rules.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
STP-CAPT:[<TID>]:<STA_PCSN>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STP-CAPT::PCSN-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STA-CAPT
RTRV-CAPT
RTRV-CAPT
Retrieve port capture rules.
Function
This command instructs the NE to retrieve port capture rules.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RTRV-CAPT:[<TID>]:<RTRV_PCSN>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::PORT=<INPORT>,[VLANID=<PKTVLANID>],CAPTDIR=<CAPTDIR>,
[PKTTYPE]=<DFTPKTTYPE>,[CAPTNUM]=<CAPTNUM>,[PKTLEN]=<DFTPKTLEN>,
[PACKET]=<DFTPKT>;"<cr><lf>
;
Response Parameters
Parameter Description
<VLANID> Indicates the identify of a vlan.Valid value can range from 0 to 4095. Default
to capture packet from the port.
<CAPTDIR> Indicates the direction from which the user will capture packet. Valid value can
Parameter Description
Example
Command
RTRV-CAPT::PCSN-1-1:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"PCSN-1-1::PORT=FAC-1-1-
1,VLANID=100,CAPTDIR=TX,PKTTYPE=GFPCMF,CAPTNUM=10,PKTLEN=10,PACKET=10"
;
Related Commands
STA-CAPT
STP-CAPT
INIT-TEST-<FETH/GETH/VCG>
Initialize all the ethernet test packet counter.
Function
This command initializes the ethernet test packet counter.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
INIT-TEST-<FETH/GETH/VCG>:
[<TID>]:<AID>:<CTAG>:::COUNTERTYPE=<COUNTERTYPE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INIT-TEST-FETH::FAC-1-2-3:102:::COUNTERTYPE=ALL;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STA-TEST-<FETH/GETH/VCG>
STP-TEST-<FETH/GETH/VCG>
RTRV-TEST-<FETH/GETH/VCG>
RTRV-TEST-<FETH/GETH/VCG>
Retrieves the packet content of a port test.
Function
This command instructs the NE to retrieve the packet content of a port test.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
RTRV-PING-<FETH/GETH/VCG>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^"<AID>::TESTMODE=<TESTMODE>,[PKTNUM=<PKTNUM>],TOTALSEND=<TOTALSEND>,
[CURRENTSEND]=<CURRENTSEND>,[PKTLEN]=<PKTLEN>,[PKTTYPE]=<PKTTYPE>,
[STUFFTYPE]=<PKTDATATYPE>,[PKTMACDA]=<PKTMACDA>,[PKTMACSA]=<PKTMACSA>,
[PKTIPDA]=<PKTIPDA>,[PKTIPSA]=<PKTIPSA>,[PKTVLANID]=<PKTVLANID>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-TEST-FETH::FAC-1-2:100;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
"FAC-1-
1::TESTMODE=BURST,PKTNUM=6000,TOTALSEND=3000,CURRENTSEND=500,PKTLEN=128,PKT
TYPE=CUSTOM,STUFFTYPE=0xAA,PKTMACDA=01-02-03-04-05-06,PKTMACSA=06-05-04-03-
02-01"
;
Related Commands
STA-TEST-<FETH/GETH/VCG>
STP-TEST-<FETH/GETH/VCG>
STA-TEST-<FETH/GETH/VCG>
Starts Ethernet port test.
Function
This command instructs an NE to start sending Ethernet port test frames.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
STA-TEST-<FETH/GETH/VCG>:[<TID>]:<AID>:<CTAG>:::[PKTNUM=<PKTNUM>],
[PKTLEN=<PKTLEN>],[PKTTYPE=<PKTTYPE>],[STUFFTYPE=<PKTDATATYPE>],
[PKTMACDA=<PKTMACDA>],[PKTMACSA=<PKTMACSA>],
[PKTIPDA=<PKTIPDA>],[PKTIPSA=<PKTIPSA>],[PKTVLANID=<PKTVLANID>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STA-TEST-GETH::FAC-1-2-
3:100:::PKTNUM=200,PKTLEN=128,PKTTYPE=IP,STUFFTYPE=4,PKTMACDA=01-02-03-04-
05-06,PKTMACSA=01-02-03-04-05-
06,PKTIPDA=10.11.12.13,PKTIPSA=10.11.12.13,PKTVLANID=1;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STP-TEST-<FETH/GETH/VCG>
RTRV-TEST-<FETH/GETH/VCG>
STP-TEST-<FETH/GETH/VCG>
Stops Ethernet port test.
Function
This command instructs an NE to stop Ethernet port test.
Usage Note
None
Category
Configuration
Security
Maintenance
Command Syntax
STP-TEST-<FETH/GETH/VCG>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
STP-TEST-FETH::FAC-1-2-3:102;
Response Message
NE 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
STA-TEST-<FETH/GETH/VCG>
RTRV-TEST-<FETH/GETH/VCG>
Function
This command edits the attributes of the ODUn logical facility.
Usage Note
ODUn includes ODU0,ODU1,ODU2,ODU5G,ODU3,ODU4 and ODUflex.
Category
Facility
Security
Provisioning
Command Syntax
ED-<ODUN>:[<TID>]:<AID>:<CTAG>:::[TYPE=<TYPE>],
[SPEEDCHG=<SPEEDCHG>],[ENCAP=<ENCAP>],[BIP8MODE=<BIP8MODE>],
[DEGTH=<DEGTH>],[DEGTIME=<DEGTIME>],
[DEGINTERVAL=<DEGINTERVAL>],[SFBER=<SFBER>],[SDBER=<SDBER>],
[TIMACT=<TIMACT>],[TIMMODE=<TIMMODE>],[EXPTTISAPI=<EXPTTISAPI>],
[EXPTTIDAPI=<EXPTTIDAPI>],[TTISAPI=<TTISAPI>],[TTIDAPI=<TTIDAPI>],
[TTIOPER=<TTIOPER>],[EXPPT=<EXPPT>],[STPT=<STPT>],
[FTFLOPER=<FTFLOPER>],[LCKEN=<LCKEN>],
[NONINTRMON=<NONINTRMON>],[DELAYTIME=<DELAYTIME>],
[PLM2AIS=<PLM2AIS>],[MSIM2AIS=<MSIM2AIS>],[VCPLM2AIS=<VCPLM2AIS>],
[GCCTRANS=<GCCTRANS>],[RESTRANS=<RESTRANS>],[LATTYPE=<LATTYPE>],
[RATETOL=<RATETOL>],[AUTOMSIEN=<AUTOMSIEN>],[EXPMSI=<EXPMSI>],
[EXPMSITS=<EXPMSITS>],[MSI=<MSI>],[MSITS=<MSITS>]:[<PST>];
Command Parameters
Default
Parameters Description Value
<TYPE> ODU2 and ODU3 have a standard mode and a high-speed The default
mode. This parameter is only valid for ODU2 and ODU3. The value varies
valid values are as follows: with
STD: indicates the standard mode; the rate is 10.7 different
Gbit/s (ODU2) or 43 Gbit/s (ODU3). units.
ODU2E: The bit rate is 11.1 Gbit/s.
ODU3E: The bit rate is 44 Gbit/s.
<BIP8MODE> Indicates the BIP8 error detection mode of an OTN. The valid The default
values are as follows: value varies
POISSON with
BURST different
units.
<DEGTH> Indicates the SD threshold for bit errors in BURST mode. This ODU0:3050
parameter is valid only when <BIP8MODE> is set to BURST. ODU1: 6126
The value ranges are as follows: ODU5G:
ODU0: 1-10167 12303
ODU1: 1-20420 ODU2:
ODU5G: 1-41012 24607
ODU2: 1-82025 ODU3:
ODU3: 1-329491 98847
ODU4: 1-856387 ODU4:
256916
ODUFLEX: For ODUflex (N = 1), the DEG value
range is the same as that of ODU0; for ODUflex (N = 2), the
maximum DEG threshold is 2 x ODU0 maximum threshold.
For ODUflex (N = [3,7]), the maximum DEG threshold is (N
– 0.5) x ODU0 maximum threshold.
<FTFLOPER> Indicates the operator-specific field that contains the fault type NA
and fault location information. It is a string with no more than
118 bytes.
<DELAYTIME> This parameter is only valid for the channels in an SNCP group. NA
Indicates the delay time. It is an integer ranging from 0 to 100,
which is expressed in 0.1 seconds.
Delay time is required when multiple protection schemes are
configured. Switching is not initiated until the delay time is
expended when a malfunction is discovered at a port.
Use the default value when only one type of protection is
Default
Parameters Description Value
configured.
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-ODU1::CLNT-1-1-1-1:100:::BIP8MODE=POISSON;
Response Message
NE 2008-06-01 10:30:18 M 100 COMPLD ;
Related Commands
D.15.2 RTRV-<ODUN>
D.15.2 RTRV-<ODUN>
Retrieves the attributes of the ODUn logical facility.
Function
This command retrieves the attributes of the ODUn logical facility.
Usage Note
ODUn includes ODU0, ODU1, ODU2, ODU5G, ODU3, ODU4 and ODUflex.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-<ODUN>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[TYPE=<TYPE>],[SPEEDCHG=<SPEEDCHG>],[ENCAP=<ENCAP>],[BIP8MODE=<BIP8MODE>],
[DEGTH=<DEGTH>],[DEGTIME=<DEGTIME>],[DEGINTERVAL=<DEGINTERVAL>],
[SFBER=<SFBER>],[SDBER=<SDBER>],[TIMACT=<TIMACT>],[TIMMODE=<TIMMODE>],
[EXPTTISAPI=<EXPTTISAPI>],[EXPTTIDAPI=<EXPTTIDAPI>],[TTISAPI=<TTISAPI>],
[TTIDAPI=<TTIDAPI>],[TTIOPER=<TTIOPER>],[INCTTISAPI=<INCTTISAPI>],
[INCTTIDAPI=<INCTTIDAPI>],[INCTTIOPER=<INCTTIOPER>],[EXPPT=<EXPPT>],
[STPT=<STPT>],[INCPT=<INCPT>],[EXPVCPT=<EXPVCPT>],[INCVCPT=<INCVCPT>],
[FTFLOPER=<FTFLOPER>],[INCFWFT=<INCFWFT>],[INCFWOI=<INCFWOI>],
[INCFWOPER=<INCFWOPER>],[INCBWFT=<INCBWFT>],[INCBWOI=<INCBWOI>],
[INCBWOPER=<INCBWOPER>],[LCKEN=<LCKEN>],[NONINTRMON=<NONINTRMON>],
[DELAYTIME=<DELAYTIME>],[SWITCHSTATE=<SWITCHSTATE>],[PLM2AIS=<PLM2AIS>],
[MSIM2AIS=<MSIM2AIS>],[VCPLM2AIS=<VCPLM2AIS>],[GCCTRANS=<GCCTRANS>],
[RESTRANS=<RESTRANS>],[LATVALUE=<LATVALUE>],[TS=<TS>],
[RATETOL=<RATETOL>]:<PST>,<SST>"<cr><lf> ;
Response Parameters
Parameters Description
<TYPE> ODU2 and ODU3 have a standard mode and a high-speed mode. This
parameter is only valid for ODU2 and ODU3.
STD: indicates standard mode; the bit rate is 10.7 Gbit/s (ODU2) or
43 Gbit/s (ODU3).
ODU2E: The bit rate is 11.1 Gbit/s.
ODU3E: The bit rate is 44 Gbit/s.
INVALID: unknown rate.
<SPEEDCHG> Indicates whether the rate of ODUN is variable. The valid values are as
follows:
ENABLE: the rate of ODUN is variable.
DISABLE: the rate of ODUN is fixed.
<ENCAP> Indicates the encapsulation mode. It is only valid for channels where the
encapsulation mode is configurable.
ODU2: ODU2 cross-connection is configurable on this channel.
ODU2_TMUX_ODU1: ODU1 signals are encapsulated into ODU2
signals, and the inner ODU1 cross-connection is configurable on this
channel.
ODU1_TMUX_ODU0: ODU0 signals are encapsulated into ODU1
signals, and the inner ODU0 cross-connection is configurable on this
channel.
ODU3_TMUX: ODU1 and ODU2 signals are encapsulated into
ODU3 signals. The inner ODU1 and ODU2 cross-connections are
configurable on this channel.
ODU3: ODU3 cross-connection is configurable on this channel.
AUTO: AUTO mode
<BIP8MODE> Indicates the BIP8 error detection mode of an OTN. The valid values are as
follows:
POISSON
Parameters Description
BURST
<DEGTH> Indicates the signal degrade (SF) threshold for bit errors in BURST mode.
This parameter is only valid when the BIP8MODE is set to BURST.
The value ranges are as follows:
ODU0: 1-10167
ODU1: 1-20420
ODU5G: 1-41012
ODU2: 1-82025
ODU3: 1-329491
ODU4: 1-856387
ODUFLEX: For ODUflex (N = 1), the DEG value range is the same
as that of ODU0;for ODUflex (N = 2), the maximum DEG threshold is 2
x ODU0 maximum threshold. For ODUflex (N = [3,7]), the maximum
DEG threshold is (N - 0.5) x ODU0 maximum threshold.
<DEGTIME> Indicates the DEG detection time expressed in seconds. This parameter is
valid only when BIP8MODE is set to BURST.
The value range is 1-10.
<DEGINTERVAL> Indicates the DEG detection time. Valid values include 10 ms, 100 ms, and
1000 ms.
<SFBER> Indicates the threshold of OTN ODUk PM BIP-8 SFBER on a facility. This
parameter is valid only when BIP8MODE is set to POISSON.
The valid value ranges from 1E-5 to 1E-3. The default value is 1E-3.
<SDBER> Indicates the threshold of OTN ODUk PM BIP-8 SDBER on a facility. This
parameter is valid only when BIP8MODE is set to POISSON.
The valid value ranges from 1E-9 to 1E-5. The default value is 1E-6.
<TIMACT> Indicates whether the reporting of the after-TIM response is enabled. The
valid values are as follows:
ENABLE
DISABLE
<EXPPT> Indicates the expected PT byte. The value is hexagonal integer with a single
byte. Some of the values are defined in the OTN specifications as follows.
0x00: Not available
0x01: Experimental mapping
0x02: Asynchronous CBR mapping
0x03: Bit synchronous CBR mapping
0x04: ATM mapping
0x05: GFP mapping
0x06: Virtual Concatenated signal
0x07: PCS codeword transparent Ethernet mapping
0x08: FC-1200 into OPU2e mapping
Parameters Description
<INCPT> Indicates the incoming PT byte. The value is a hexagonal integer with a
single byte, the meaning of each parameter is the same with the <EXPPT>.
<EXPVCPT> Indicates the expected virtual concatenation PT byte. This parameter is only
valid for the virtually concatenated ODU channels.
<INCVCPT> Indicates the incoming PT byte. This parameter is only valid for the
virtually concatenated ODU channels.
<FTFLOPER> Indicates the operator-specific field that contains the fault type and fault
location information.
<LCKEN> Indicates whether maintenance signal insertion is enabled. The valid values
are as follows:
ENABLE
DISABLE
<NONINTRMON> Indicates whether non-intrusive monitoring is enabled. The valid values are
as follows:
ENABLE
DISABLE
<DELAYTIME> This parameter is only valid for the channels in an SNCP group.
Indicates the delay time. It is an integer ranging from 0 to 100, which is
expressed in 0.1 seconds.
Delay time is required when multiple protection schemes are configured.
Switching is not initiated until the delay time is expended when a
malfunction is discovered at a port.
Use the default value when only one type of protection is configured.
<SWITCHSTATE> Indicates the state of the switching. It is only valid when the port is in the
protection group. The valid values are provided in SWITCHSTATE.
<PLM2AIS> Indicates whether PLM-triggered AIS insertion is enabled. The valid values
are as follows:
ENABLE
DISABLE
<LATVALUE> Indicates the signal transmission latency on a specified path. The parameter
value is expressed in microseconds.
Assuming that the latency of the A<==>B<==>C<==>D service path needs
to be measured, A and D are the source and sink ODUk channels of the
service, and B and C are the intermediate ODUk channels that the service
traverses. If the latency measurement mode is set to INSERT for A, to
TRANSPARENT for B and C, and to LOOP for D, the user can know the
signal transmission latency from A to D by retrieving information about A.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
Parameters Description
and OOS.
Example
Command
RTRV-ODU1::CLNT-1-8-1:C;
Response Message
NE 2008-11-01 09:21:21 M C COMPLD "CLNT-1-8-
1::BIP8MODE=POISSON,SFBER=1E-3,SDBER=1E-
6,TIMACT=DISABLE,TIMMODE=OFF,EXPTTISAPI=\"\",EXPTTIDAPI=\"\",TTISAPI=\"\",T
TIDAPI=\"\",TTIOPER=\"\",FTFLOPER=\"\",LCKEN=DISABLE,PLM2AIS=DISABLE,:OOS-
AU,SGEO" ;
Related Commands
D.15.1 ED-<ODUN>
D.15.3 ED-<OTUN>
Edits the attributes of OTUn logical facility.
Function
This command edits the attributes of the OTUn.
Usage Note
OTUn includes OTU1, OTU2, OTU3, OTU5G and OTU4.
Category
Facility
Security
Provisioning
Command Syntax
ED-<OTUN>:[<TID>]:<AID>:<CTAG>:::[AUTOADAPT=<AUTOADAPT>],
[FEC=<FEC>],[BEFECSDBER=<BEFECSDBER>],[TYPE=<TYPE>],
[BIP8MODE=<BIP8MODE>],[DEGTH=<DEGTH>],[DEGTIME=<DEGTIME>],
[QVALUE=<QVALUE>],[DEGINTERVAL=<DEGINTERVAL>],[SFBER=<SFBER>],
[SDBER=<SDBER>],[TIMACT=<TIMACT>],[TIMMODE=<TIMMODE>],
[EXPTTISAPI=<EXPTTISAPI>],[EXPTTIDAPI=<EXPTTIDAPI>],
[TTISAPI=<TTISAPI>],[TTIDAPI=<TTIDAPI>],[TTIOPER=<TTIOPER>],
[AFECLVL=<AFECLVL>]:[<PST>];
Command Parameters
Parameter Description Default Value
<FEC> Indicates the forward error correction (FEC). The valid The default
values are as follows: value varies
OFF: indicates that FEC is disabled. with the
STDFEC: indicates that standard FEC is enabled. different units.
AFEC: indicates that advanced FEC is enabled.
AUTO: Automatically detects the FEC mode.
HFEC: indicates that High performance FEC is
enabled.
SDFEC: indicates that soft decision FEC is enabled.
SDFEC2: indicates that soft decision 2 FEC is enabled.
HFEC2: indicates that High performance FEC 2 is
enabled.
HFECPLUS: indicates that High performance FEC
Plus is enabled.
<BEFECSDBER> Indicates the signal degrade (SD) threshold before FEC. For STDFEC,
The valid value ranges from 1E-12 to 1E-1. the default
value is 1E-6.
For AFEC, the
default value is
1E-4. For
HFEC, the
default value is
7E-4.For
SDFEC, the
default value is
7E-3.For
SDFEC2, the
default value is
1.6E-2.
<TYPE> OTU2 and OTU3 have a standard and high-speed mode. STD
This parameter is only valid for OTU2 and OTU3. The
valid values are as follows:
STD: indicates standard mode; the bit rate is 10.7
Parameter Description Default Value
<BIP8MODE> Indicates the BIP8 error detection mode of an OTN. The The default
valid values are as follows: value varies
POISSON with the
BURST different units.
<DEGTH> Indicates the SD threshold for bit errors in BURST mode. OTU1: 6126
This parameter is only valid when BIP8MODE is set to OTU5G: 12303
BURST. The valid values are as follows:
OTU2: 24607
OTU1: 1-20420
OTU3: 98847
OTU5G: 1-41012
OTU4: 256916
OTU2: 1-82025
OTU3: 1-329491
OTU4: 1-856387
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-OTU1::CLNT-1-1-1:100:::FEC=OFF;
Response Message
NE 2004-01-01 11:37:18 M 100 COMPLD ;
Related Commands
D.15.4 RTRV-<OTUN>
D.15.4 RTRV-<OTUN>
Retrieves the attributes of the OTUn logical facility.
Function
This command retrieves the attributes of the OTUn logical facility.
Usage Note
OTUn includes OTU1,OTU2,OTU3,OTU5G and OTU4.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-<OTUN>:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> The valid formats are as follows:
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::AUTOADAPT=<AUTOADAPT>,FEC=<FEC>,BEFECSDBER=<BEFECSDBER>,TYPE=<TY
PE>,BIP8MODE=<BIP8MODE>,DEGTH=<DEGTH>,DEGTIME=<DEGTIME>,DEGINTERVAL=<DEGINT
ERVAL>,SFBER=<SFBER>,SDBER=<SDBER>,TIMACT=<TIMACT>,TIMMODE=<TIMMODE>,EXPTTI
SAPI=<EXPTTISAPI>,EXPTTIDAPI=<EXPTTIDAPI>,TTISAPI=<TTISAPI>,TTIDAPI=<TTIDAP
I>,TTIOPER=<TTIOPER>,INCTTISAPI=<INCTTISAPI>,INCTTIDAPI=<INCTTIDAPI>,INCTTI
OPER=<INCTTIOPER>,AFECLVL=<AFECLVL>,QVALUE=<QVALUE>:<PST>,<SST>"<cr><lf> ;
Response Parameters
Parameters Description
<BEFECSDBER> Indicates the SD threshold before FEC. The valid value ranges from 1E-12
to 1E-1.
the default value is 1E-4 when <FEC> is set to AFEC, 1E-6 when <FEC> is
set to STDFEC, 8.5E-4 when <FEC> is set to HFEC.For SDFEC2, the
default value is 1.6E-2.
<TYPE> OTU2 and OTU3 have a standard and high-speed mode. This parameter is
only valid for OTU2 and OTU3.
STD: indicates the standard mode; the bit rate is 10.7 Gbit/s
(OTU2) or 43 Gbit/s (OTU3).
OTU2E: The bit rate is 11.1 Gbit/s.
OTU3E: The bit rate is 44 Gbit/s.
<BIP8MODE> Indicates the BIP8 error detection mode of an OTN. The valid values are as
follows:
POISSON
BURST
<DEGTH> Indicates the SD threshold for bit errors in BURST mode. This parameter is
only valid when BIP8MODE is set to BURST.
The valid values are as follows:
OTU1: 1-20420
OTU5G: 1-41012
OTU2: 1-82025
OTU3: 1-329491
OTU4: 1-856387
Parameters Description
<DEGTIME> Indicates the DEG detection time expressed in seconds. This parameter is
only valid when BIP8MODE is set to BURST.
The valid value ranges from 1 to 10.
<DEGINTERVAL> Indicates the DEG detection time. Valid values include 10 ms, 100 ms, and
1000 ms.
<SFBER> Indicates the threshold of OTN OTUk SM BIP-8 SFBER on a facility. This
parameter is valid only when BIP8MODE is set to POISSON.
The valid value ranges from 1E-5 to 1E-3. The default value is 1E-3.
<SDBER> Indicates the threshold of OTN OTUk SM BIP-8 SDBER on a facility. This
parameter is valid only when BIP8MODE is set to POISSON.
The valid value ranges from 1E-9 to 1E-5. The default value is 1E-6.
The TTI is defined by ITU-T G.709 as a 64-byte string and contains SAPI,
DAPI, and OPERR.
OPER: maximum 32-character operator specific.
Example
Command
RTRV-OTU1::SRV1-1-6-1:D;
Response Message
NE 2008-01-03 09:18:24 M D COMPLD "SRV1-1-6-
1::AUTOADAPT=Y,FEC=STDFEC,BEFECSDBER=1E-
6,BIP8MODE=POISSON,DEGTH=3064,DEGTIME=7,SFBER=1E-3,SDBER=1E-
6,TIMACT=DISABLE,TIMMODE=OFF,EXPTTISAPI=\"\",EXPTTIDAPI=\"\",TTISAPI=\"\",T
TIDAPI=\"\",TTIOPER=\"\",:OOS-AU,SGEO" ;
Related Commands
D.15.3 ED-<OTUN>
D.15.5 ED-<TCMMOD2>
Edits the attributes of TCM.
Function
This command edits the attributes of the TCM.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-<TCMMOD2>:[<TID>]:<AID>:<CTAG>:::[BIP8MODE=<BIP8MODE>],
[DEGTH=<DEGTH>],[DEGTIME=<DEGTIME>],
[DEGINTERVAL=<DEGINTERVAL>],[SFBER=<SFBER>],[SDBER=<SDBER>],
[TIMACT=<TIMACT>],[TIMMODE=<TIMMODE>],[EXPTTISAPI=<EXPTTISAPI>],
[EXPTTIDAPI=<EXPTTIDAPI>],[TTISAPI=<TTISAPI>],[TTIDAPI=<TTIDAPI>],
[TTIOPER=<TTIOPER>],[SRCEN=<SRCEN>],[SRCMODE=<SRCMODE>],
[SINKEN=<SINKEN>],[SINKMODE=<SINKMODE>],[LCKEN=<LCKEN>],
[NONINTRMON=<NONINTRMON>],[LTCACTEN=<LTCACTEN>],
[LATTYPE=<LATTYPE>]:[<PST>];
Command Parameters
Parameters Description Default Value
<BIP8MODE> Indicates the BIP8 error detection mode of an OTN. The valid The default
values are as follows: value varies
POISSON with the
BURST different units.
Parameters Description Default Value
<DEGTH> Indicates the SD threshold for bit errors in BURST mode. ODU1TCMi:
This parameter is only valid when BIP8MODE is set to 6126
BURST. ODU5GTCMi:
The value ranges are as follows: 12303
ODU1TCMi: 1-20420 ODU2TCMi:
ODU5GTCMi: 1-41012 24607
ODU2TCMi: 1-82025 ODU3TCMi:
ODU3TCMi: 1-329491 98847
ODU0TCMi: 1-10167 ODU0TCMi:
1000
ODU4TCMi: 1-856387
ODU4TCMi:
256916
<SRCEN> Indicates whether the source is enabled. The valid values are DISABLE
as follows:
ENABLE
DISABLE
<SRCMODE> Indicates the source mode. The valid values are as follows: TRAN
OPER: operational
TRAN: transparent
<SINKEN> Indicates whether the sink is enabled. The valid values are as DISABLE
follows:
ENABLE
DISABLE
<SINKMODE> Indicates the sink mode. The valid values are as follows: TRAN
OPER: operational
MON: monitoring
TRAN: transparent
<PST> Indicates the status of the primary state qualifier. The valid NA
values are IS and OOS.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Example
Command
ED-ODU1TCM1::CLNT-1-1-1:C:::LTCACTEN=ENABLE;
Response Message
NE 2004-01-01 11:37:18 M C COMPLD ;
Related Commands
D.15.6 RTRV-<TCMMOD2>
D.15.6 RTRV-<TCMMOD2>
Retrieves the attributes of the TCM.
Function
This command retrieves the attributes of the TCM.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-<TCMMOD2>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::BIP8MODE=<BIP8MODE>,DEGTH=<DEGTH>,DEGTIME=<DEGTIME>,DEGINTERVAL=
<DEGINTERVAL>,SFBER=<SFBER>,SDBER=<SDBER>,TIMACT=<TIMACT>,TIMMODE=<TIMMODE>
,EXPTTISAPI=<EXPTTISAPI>,EXPTTIDAPI=<EXPTTIDAPI>,TTISAPI=<TTISAPI>,TTIDAPI=
<TTIDAPI>,TTIOPER=<TTIOPER>,INCTTISAPI=<INCTTISAPI>,INCTTIDAPI=<INCTTIDAPI>
,INCTTIOPER=<INCTTIOPER>,SRCEN=<SRCEN>,SRCMODE=<SRCMODE>,SINKEN=<SINKEN>,SI
NKMODE=<SINKMODE>,LCKEN=<LCKEN>,NONINTRMON=<NONINTRMON>,LTCACTEN=<LTCACTEN>
,LATVALUE=<LATVALUE>:<PST>,<SST>"<cr><lf>+ ;
Response Parameters
Parameters Description
<DEGTH> Indicates the SD threshold for bit errors in BURST mode. This parameter is
only valid when BIP8MODE is set to BURST.
<DEGTIME> Indicates the DEG detection time expressed in seconds. This parameter is
only valid when BIP8MODE is set to BURST.
The valid value ranges from 1 to 10.
<DEGINTERVAL> Indicates the DEG detection time. Valid values include 10 ms, 100 ms, and
1000 ms.
<SFBER> Indicates the threshold of OTN OTUk SM BIP-8 SFBER on a facility. This
parameter is only valid when BIP8MODE is set to POISSON.
<SDBER> Indicates the threshold of OTN OTUk SM BIP-8 SDBER on a facility. This
parameter is only valid when BIP8MODE is set to POISSON.
<SRCMODE> Indicates the source mode. The valid values are as follows:
OPER: operational
TRAN: transparent
<SINKMODE> Indicates the sink mode. The valid values are as follows:
OPER: operational
MON: monitoring
TRAN: transparent
<LATVALUE> Indicates the signal transmission latency on a specified path. The parameter
value is expressed in microseconds.
Assuming that the latency of the A<==>B<==>C<==>D service path needs
Parameters Description
to be measured, A and D are the source and sink ODUk channels of the
service, and B and C are the intermediate ODUk channels that the service
traverses. If the latency measurement mode is set to INSERT for A, to
TRANSPARENT for B and C, and to LOOP for D, the user can know the
signal transmission latency from A to D by retrieving information about A.
<PST> Indicates the status of the primary state qualifier. The valid values are IS
and OOS.
Example
Command
RTRV-ODU1TCM1::SRV1-1-7-1:C;
Response Message
NEW-NE 2008-09-03 08:41:25 M C COMPLD "SRV1-1-7-
1::BIP8MODE=POISSON,SFBER=1E-3,SDBER=1E-
6,TIMACT=DISABLE,TIMMODE=OFF,EXPTTISAPI=\"\",EXPTTIDAPI=\"\",TTISAPI=\"\",T
TIDAPI=\"\",TTIOPER=\"\",INCTTISAPI=\" \",INCTTIDAPI=\"
\",INCTTIOPER=\" \",SRCEN=DISABLE,SRCMODE=TR
AN,SINKEN=DISABLE,SINKMODE=TRAN,LCKEN=DISABLE,NONINTRMON=DISABLE,LTCACTEN=D
ISABLE:IS-NR" ;
Related Commands
D.15.5 ED-<TCMMOD2>
D.15.7 RTRV-OCHS
Retrieves the attributes of the physical OCHS facility.
Function
This command retrieves the attributes of the physical OCHS facility
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OCHS:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],SILKSCREEN=<SILKSCREEN>,
[LSRSTATE=<LSRSTATE>],[BANDTYPE=<BANDTYPE>],[WVNUM=<WVNUM>],[WV=<WV>],
[ACTBANDTYPE=<ACTBANDTYPE>],[ACTWVNUM=<ACTWVNUM>],[ACTWV=<ACTWV>],
[WVNUMRANGE=<WVNUMRANGE>],[SVTIMER=<SVTIMER>],[FEC=<FEC>],
[BEFECSDBER=<BEFECSDBER>],[QVALUE=<QVALUE>],[STCNTRFREQ=<STCNTRFREQ>],
[STBANDWIDTH=<STBANDWIDTH>],[EXPCNTRFREQ=<EXPCNTRFREQ>],
[EXPBANDWIDTH=<EXPBANDWIDTH>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameter Description
<PORTMEMO> Indicates the optical port memo. It is a string consists of not more
than 64 bytes. Usually it is used to identify the port name.
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and
CLOSE.
<BANDTYPE> Indicates the working band of the port. The valid values are
CBAND and CWDMBAND.
<ACTBANDTYPE> Indicates the actual working band of the port. The valid values
are CBAND and CWDMBAND (Coarse Wavelength Division
Multiplexing Band).
<WVNUMRANGE> Indicates the actual operating wavelength range that the port
supports. The range is expressed by using &&. For example,
1&&40.
<BEFECSDBER> Indicates the threshold of the signal degraded before FEC alarm.
The valid value ranges from 1E-12 to 1E-1
<EXPCNTRFREQ> Indicates the expected receive band's center frequence at the port.
<EXPBANDWIDTH> Indicates the expected receive band's band width at the port.
<PST> Indicates the status of the primary state qualifier. The valid
values are IS and OOS.
Example
Command
RTRV-OCHS::FAC-1-2-1:D;
Response Message
NE 2013-11-17 08:25:01
M D COMPLD
"FAC-3-17-
1::PORTMEMO=\"\",SILKSCREEN=OUT1/IN1,LSRSTATE=OPEN,BANDTYPE=CBAND,WVNUM=26,
WV=194.80THz/1538.98nm,ACTBANDTYPE=CBAND,ACTWVNUM=26,ACTWV=194.80THz/1538.9
8nm,WVNUMRANGE=26,SVTIMER=00-15:IS-NR"
Related Commands
D.6.40 ED-OCHS
D.15.8 RTRV-OCHM
Retrieves the attributes of the physical OCHM facility.
Function
This command retrieves the attributes of the physical OCHM facility
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OCHM:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[PORTMEMO=<PORTMEMO>],[SILKSCREEN=<SILKSCREEN>],
[ODDEVEN=<ODDEVEN>],[LSRSTATE=<LSRSTATE>],
[SVTIMER=<SVTIMER>]:<PST>,<SST>"<cr><lf>
;
Response Parameters
Parameter Description
<PORTMEMO> Indicates additional information about the optical port. It is a string that
consists of no more than 64 bytes. Usually it is used to identify the port name.
<LSRSTATE> Indicates the status of the laser. The valid values are OPEN and CLOSE.
<SILKSCREEN> Indicates the character string silk-screened at the corresponding port on the
front panel.
<ODDEVEN> Indicates the odd or even bandtype attribute of the port.The valid values are
ODD and EVEN
<SVTIMER> Indicates the signal validation timer; units are expressed in minutes. It is valid
only when Auto In-Service is supported. SVTIMER is a string in an HH-MM
format.
HH: hour, which is an integer ranging from 0 to 48.
MM: minute, which is an integer ranging from 0 to 59.
<PST> Indicates the status of the primary state qualifier. The valid values are IS and
OOS.
Example
Command
RTRV-OCHM::FAC-1-2-1:D;
Response Message
NE 2013-11-17 08:25:01
M D COMPLD
"FAC-3-17-1::ODDEVEN=EVEN,SVTIMER=00-15:IS-NR"
Related Commands
D.6.39 ED-OCHM
ENT-IPA
Creates an IPA group.
Function
This command creates an IPA group.
Usage Note
An error message will be returned when an existing IPA group is entered.
Category
IPA
Security
Provisioning
Command Syntax
ENT-IPA:[<TID>]:<DECT>,<OPRT>:<CTAG>:::[BAND=<BAND>]
[,RAMANTID=<RAMANTID>,RAMANBID =<RAMANBID>];
Command Parameters
Parameter Description Default Value
<BAND> Indicates the band type of a line. The only available value for CBAND
this parameter is CBAND.
<RAMANTID> Indicates the name of the NE TID in which the Raman unit lies. NA
The valid value is a string of less than or equal to 20 characters
which is composed of letters, digits and hyphens. The string
should begin with a letter and cannot end with a hyphen.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-IPA::FAC-1-1-1,FAC-1-5-2:C:::BAND=CBAND;
Response Message
NE 2005-11-02 09:48:24
M C COMPLD
;
Related Commands
ED-IPA
RTRV-IPA
DLT-IPA
ED-IPA
Edits an IPA group.
Function
This command edits the control attributes of an IPA group.
Usage Note
None
Category
IPA
Security
Provisioning
Command Syntax
ED-IPA:[<TID>]:<DECT>,<OPRT>:<CTAG>:::[RESTART=<RESTART>,]
[LSROFF=<LSROFF>,][LSRON=<LSRON>,][TESTTM=<TESTTM>,]
[RXLOSTH=<RXLOSTH>,][SAFE=<SAFE>,][RSPULSE=<RSPULSE>,]
[RMNALMFLAG=<RMNALMFLAG>,][ENABLE=<ENABLE>,]
[ROPOPRT=<ROPOPRT>,][RAMANOPRT=<RAMANOPRT>,]
[EXTFUNCSW=<EXTFUNCSW>];
Command Parameters
Parameter Description Default Value
<RESTART> Indicates the restart mode. The valid values are as follows: MAN
MAN: restarts the laser switch manually.
AUTO: restarts the laser switch automatically.
<TESTTM> Indicates the time the laser switch is held on when the test 80
mode is active..
Range: 80-1000 (units in seconds).
<RXLOSTH> The card detects the input optical power of the Raman card. If -30.0
the optical power is less than the <RXLOSTH>, a LOS event
Parameter Description Default Value
<SAFE> Uses the safe-level power when users open the laser switch. N
The valid values are Y and N.
Sets the security control mode of the IPA. The IPA security
switch is set to meet the requirements for long-distance
networking. Do not restrain the output optical power to a very
low value.
When the security control switch is shut down, it
indicates that the IPA is restarted, and all the optical power
detection cards are enabled.
When the security control switch is open, it indicates
that the IPA is restarted, and the optical power is restrained
to less than 10 dBm.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-IPA::FAC-1-1-1,FAC-1-2-2:C:::RESTART=AUTO,LSROFF=100,LSRON=40,SAFE=Y;
Response Message
NE 2005-11-02 09:48:24
M C COMPLD
;
Related Commands
ENT-IPA
RTRV-IPA
DLT-IPA
DLT-IPA
Deletes an IPA group.
Function
This command deletes an IPA group.
Usage Note
This command deletes all information about an IPA group including the ASTDECT.
When the communication between subracks fails and the IPA group has Raman parameters
that belong to another rack, this command does not delete the IPA parameters and returns a
communication failure.
Category
IPA
Security
Provisioning
Command Syntax
DLT-IPA:[<TID>]:<DECT>,<OPRT>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-IPA::FAC-1-1-1,FAC-1-2-2:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ED-IPA
RTRV-IPA
ENT-IPA
RTRV-IPA
Retrieves an IPA group.
Function
This command retrieves the control attributes of an IPA group.
Usage Note
If ALL is input for this parameter, all the IPA groups will be retrieved. If only DECT or
OPRT are entered, then this command will retrieve the related IPA group.
Category
IPA
Security
Retrieve
Command Syntax
RTRV-IPA:[<TID>]:[<DECT>,<OPRT>]:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<DECT>,<OPRT>::BAND=<BAND>[,RAMANTID=<RAMANTID>]
[,RAMANBID=<RAMANBID>],RESTART=<RESTART>,LSROFF=<LSROFF>,LSRON=<LSRON>,TEST
TM=<TESTTM>,RXLOSTH=<RXLOSTH>,SAFE=<SAFE>,RSPULSE=<RSPULSE>[,RMNALMFLAG=<RM
NALMFLAG>],ENABLE=<ENABLE>,STATE=<STATE>")
;
Response Parameters
Parameter Description
<RAMANTID> Indicates the name of the NE where the Raman unit is located. The
<RAMANTID> is string of less than or equal to 20 characters which is
composed of letters, digits and hyphens. The string should begin with a
letter and cannot end with a hyphen.
NOTE:
This parameter is not displayed if the IPA pair is not configured with
<RAMANTID>.
<RAMANBID> Indicates the slot where the Raman unit is located. The valid format is
SLOT-<SHELF ID>-<SLOT ID>.
NOTE:
This parameter is not displayed if the IPA pair is not configured with
<RAMANBID>.
<TESTTM> Indicates the time the laser switch is held on when the test mode is active.
Range: 80-1000 (units in seconds).
The default value is 80 seconds.
<RXLOSTH> The card detects the input optical power of the Raman card. If the optical
Parameter Description
power is less than the <RXLOSTH>, a LOS event is reported to the SCC
card. The SCC card determines whether to enable the IPA function.
Range: -35.0 to -14.0 (unit is 1.0 dB). The default value is -30.0.
NOTE:
After the detection card is configured with a Raman card, the LOS threshold
changes. The LOS threshold with a single wavelength is different from one with
multiple wavelengths. Hence, the LOS threshold should be set according to the
actual situation of the network.
<SAFE> Indicates whether a safe level power is used when a laser switch is open.
The valid values are Y and N.
The default value is N.
<RSPULSE> Indicates whether a restart pulse is used when the timer or a command
requires opening the laser switch.
The valid values are Y and N.
The default value is Y.
NOTE:
The RSPULSE value must be Y if the IPA pair does not set the OSC auxiliary
detection equipment.
<RMNALMFLAG> Indicates whether the detecting function of the IPA pair is enabled.
The valid values are Y or N. The default value is N.
NOTE:
When <RMNALMFLAG> is set to Y, alarms of the Raman card are set as trigger
conditions for starting IPA. The Raman card acts like a detection card.
<STATE> Indicates the current state of an IPA group. The valid values are as follows:
END: A detection period has been completed.
LSRON: The laser switch is open.
LSROFF: The laser switch is closed.
ALM: Alarms are present.
RESTART: The IPA restarts.
SAFEDECT: It indicates to perform detection in security mode.
BEGIN: It indicates to wait to begin a new IPA control period.
<EXTFUNCSW> Indicates whether the extend function of the IPA group is enabled.
The valid values are Y and N.
The default value is N.
Example
Command
RTRV-IPA:::C;
Response Message
NE 2006-05-08 16:44:52
M C COMPLD
"FAC-1-11-1,FAC-1-3-
4::BAND=CBAND,RESTART=AUTO,LSROFF=100,LSRON=2.00,TESTTM=80,SAFE=N,RSPULSE=Y
,ENABLE=Y,STATE=BEGIN,EXTFUNCSW=N" "FAC-1-3-1,FAC-1-11-
4::BAND=CBAND,RESTART=AUTO,LSROFF=100,LSRON=2.00,TESTTM=80,SAFE=N,RSPULSE=Y
,ENABLE=Y,STATE=BEGIN,EXTFUNCSW=N" ;
Related Commands
ED-IPA
ENT-IPA
DLT-IPA
ED-IPA-WDM
Edits the IPA attributes of a port.
Function
This command is used to edit the IPA attributes of a port.
Usage Note
None
Category
IPA
Security
Provisioning
Command Syntax
ED-IPA-WDM:[<TID>]:<AID>:<CTAG>:::[ENABLE=<ENABLE>]
[,RESTART=<RESTART>][,LSROFF=<LSROFF>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-IPA-WDM::FAC-2-1-1:C100:::ENABLE=Y,RESTART=AUTO,LSROFF=100;
Response Message
NE 05-01-01 00:00:00
M C100 COMPLD
;
Related Commands
RTRV-IPA-WDM
OPR-IPA-WDM
OPR-IPA-WDM
Manually restarts port IPA.
Function
This command is used to manually restart port IPA.
Usage Note
None
Category
IPA
Security
Provisioning
Command Syntax
OPR-IPA-WDM:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
OPR-IPA-WDM::FAC-2-1-1:C100;
Response Message
NE 05-01-01 00:00:00
M C100 COMPLD
;
Related Commands
ED-IPA-WDM
RTRV-IPA-WDM
RTRV-IPA-WDM
Retrieves the IPA attributes of a port.
Function
This command is used to retrieve the IPA attributes of a port.
Usage Note
None
Category
IPA
Security
Retrieve
Command Syntax
RTRV-IPA-WDM:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-IPA-WDM::FAC-2-1-1:C100;
Response Message
NE 05-01-01 00:00:00
M C100 COMPLD
"FAC-2-1-1::ENABLE=Y,RESTART=AUTO,LSROFF=100";
Related Commands
ED-IPA-WDM
OPR-IPA-WDM
OPR-IPA
Operates an IPA group.
Function
This command is used to operate an IPA group.
If RESTART is set to AUTO, IPA automatically enables the laser periodically. When
RESTART is set to MAN, use this command to enable the laser manually.
This command can be used only when <RESTART> is set to MAN, <ENABLE> is set to Y,
and <STATE> is set to LSROFF.
Usage Note
None
Category
IPA
Security
Provisioning
Command Syntax
OPR-IPA:[<TID>]:<DECT>,<OPRT>:<CTAG>::<FLAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
OPR-IPA::FAC-1-1-1,FAC-1-2-2:C::TEST;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ED-IPA
ENT-IPA-ASTDECT
Creates an auxiliary detection board (on the same NE with the shutdown board) for an IPA
group.
Function
This command creates an auxiliary detection unit for an IPA group.
Usage Note
One command creates only one ASTDECT unit. The maximum number of ASTDECT units
is 4.
Category
IPA
Security
Provisioning
Command Syntax
ENT-IPA-ASTDECT:[<TID>]:<DECT>,<OPRT>:<CTAG>::<ASTDECT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-IPA-ASTDECT::FAC-1-4-1,FAC-1-1-2:C::FAC-1-2-1;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-IPA-ASTDECT
DLT-IPA-ASTDECT
DLT-IPA-ASTDECT
Deletes an auxiliary detection board (on the same NE with the shutdown board) for an IPA
group.
Function
This command deletes an auxiliary detection unit for an IPA group.
Usage Note
One command deletes only one ASTDECT unit.
Category
IPA
Security
Provisioning
Command Syntax
DLT-IPA-ASTDECT:[<TID>]:<DECT>,<OPRT>:<CTAG>::<ASTDECT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
DLT-IPA-ASTDECT::FAC-1-1-1,FAC-1-2-2:C::FAC-1-6-1;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-IPA-ASTDECT
ENT-IPA-ASTDECT
RTRV-IPA-ASTDECT
Retrieves all auxiliary detection boards (on the same NE with the shutdown board) of an IPA
group.
Function
This command retrieves all auxiliary detection units of an IPA group.
Usage Note
None
Category
IPA
Security
Retrieve
Command Syntax
RTRV-IPA-ASTDECT:[<TID>]:<DECT>,<OPRT>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<DECT>,<OPRT>::[<ASTDECT1>][,<ASTDECT2>][,< ASTDECT3>][,< ASTDECT4>]")
;
Response Parameters
Parameter Description
Example
Command
RTRV-IPA-ASTDECT::FAC-1-4-1,FAC-1-1-2:C;
Response Message
NE 2008-11-22 14:18:50
M C COMPLD
"FAC-1-4-1,FAC-1-1-2::FAC-1-2-1"
;
Related Commands
ENT-IPA-ASTDECT
DLT-IPA-ASTDECT
REPT^EVT^IPA
Reports an IPA group event.
Function
This autonomous message is generated by an NE to inform the OS or maintenance personnel
about IPA information.
Usage Note
None
Category
IPA
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^EVT^IPA <cr> <lf>
(^^^"[<DECT>,<OPRT>]:<EVENTID>" <cr> <lf>)+
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-01-01 11:37:18
A 1 REPT EVT IPA
"FAC-1-1-2,FAC-1-2-2:START"
;
Related Commands
None
ENT-IPA-ASTDECTEXT
Creates an auxiliary detection board (on the same NE with the shutdown board or a different
NE from the NE where the shutdown board resides) for an IPA group.
Function
This command creates an auxiliary detection unit for an IPA group.
Usage Note
One command creates only one ASTDECT unit. The maximum number of ASTDECT units
is 4.
Category
IPA
Security
Provisioning
Command Syntax
ENT-IPA-ASTDECTEXT:[<TID>]:<DECT>,<OPRT>:<CTAG>::
[<ASTTID>],<ASTDECT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-IPA-ASTDECTEXT::FAC-1-4-1,FAC-1-1-2:C::,FAC-1-2-1;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-IPA-ASTDECT
DLT-IPA-ASTDECT
DLT-IPA-ASTDECTEXT
Deletes an auxiliary detection board (on the same NE with the shutdown board or a different
NE from the NE where the shutdown board resides) for an IPA group.
Function
This command deletes an auxiliary detection unit for an IPA group.
Usage Note
One command deletes only one ASTDECT unit.
Category
IPA
Security
Provisioning
Command Syntax
DLT-IPA-ASTDECTEXT:[<TID>]:<DECT>,<OPRT>:<CTAG>::
[<ASTTID>],<ASTDECT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
DLT-IPA-ASTDECTEXT::FAC-1-1-1,FAC-1-2-2:C::,FAC-1-6-1;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-IPA-ASTDECT
ENT-IPA-ASTDECT
RTRV-IPA-ASTDECTEXT
Retrieves all auxiliary detection boards (on the same NE with the shutdown board or a
different NE from the NE where the shutdown board resides) of an IPA group.
Function
This command retrieves all auxiliary detection units of an IPA group.
Usage Note
None
Category
IPA
Security
Retrieve
Command Syntax
RTRV-IPA-ASTDECTEXT:[<TID>]:<DECT>,<OPRT>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<DECT>,<OPRT>::[<ASTTID1>],[<ASTDECT1>],[<ASTTID2>],[<ASTDECT2>],
[<ASTTID3>],[< ASTDECT3>],[<ASTTID4>],[< ASTDECT4>]")
;
Response Parameters
Parameter Description
Example
Command
RTRV-IPA-ASTDECTEXT::FAC-1-4-1,FAC-1-1-2:C;
Response Message
NE-127-26 2014-08-11 09:16:19
M C COMPLD
"FAC-1-4-1,FAC-1-1-2::NE-127-26,FAC-1-2-1,OTM-128-49,FAC-1-14-1"
;
Related Commands
ENT-IPA-ASTDECT
DLT-IPA-ASTDECT
RTRV-IPA-AUXOPRT
Retrieves an IPA aux equipment.
Function
This command retrieves the control attributes of an IPA aux equipment.
Usage Note
None
Category
IPA
Security
Retrieve
Command Syntax
RTRV-IPA-AUXOPRT:[<TID>]:<DECT>,<IPAOPRT>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<DECT>,<OPRT>::AUXTYPE=<AUXTYPE>,AUXOPRT=<AUXOPRT>");
Response Parameters
Parameter Description
Example
Command
RTRV-IPA-AUXOPRT::FAC-1-1-1,FAC-1-2-1:C;
Response Message
NE 2006-05-08 16:44:52
M C COMPLD
"FAC-1-11-1,FAC-1-3-4::AUXTYPE=RAMAN,AUXOPRT=SLOT-1-2";
Related Commands
ED-IPA
ENT-IPA
DLT-IPA
DLT-IPA-AUXOPRT
Deletes an IPA aux equipment.
Function
This command deletes an IPA aux equipment.
Usage Note
None
Category
IPA
Security
Provisioning
Command Syntax
DLT-IPA-AUXOPRT:
[<TID>]:<DECT>,<IPAOPRT>:<CTAG>:::AUXTYPE=<AUXTYPE>,AUXOPRT=<AUX
OPRT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-IPA-AUXOPRT::FAC-1-1-1,FAC-1-2-2:C:::AUXTYPE=RAMAN,AUXOPRT=SLOT-1-5;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ED-IPA
RTRV-IPA
ENT-IPA
ENT-IPA-AUXOPRT
Creates an IPA aux equipment.
Function
This command creates an IPA AUX equipment.
Usage Note
An error message will be returned when an existing IPA aux equipment is entered.
Category
IPA
Security
Provisioning
Command Syntax
ENT-IPA-AUXOPRT:
[<TID>]:<DECT>,<IPAOPRT>:<CTAG>:::AUXTYPE=<AUXTYPE>,AUXOPRT=<AUXO
PRT>;
Command Parameters
Parameter Description Default Value
<AUXTYPE> Indicates the control aux type. ROP indicates rop board type; NA
RAMAN indicates raman board type.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-IPA-AUXOPRT::FAC-1-1-1,FAC-1-5-2:C:::AUXTYPE=RAMAN,AUXOPRT=SLOT-1-5;
Response Message
NE 2005-11-02 09:48:24
M C COMPLD
;
Related Commands
ED-IPA
RTRV-IPA
DLT-IPA
ENT-APE
Creates an APE group.
Function
This command creates an APE group.
Usage Note
None
Category
APE
Security
Provisioning
Command Syntax
ENT-APE:[<TID>]:<AID>:<CTAG>:::[BAND=<BAND>][,ODDNE=<ODDNE>]
[,ODDBD=<ODDBD>][,EVENNE=<EVENNE>][,EVENBD=<EVENBD>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of the analyzer equipment, for example, the port NA
of an MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
The valid value is provided in APE.
<ODDNE> Indicates the TID of the odd wave adjustment equipment. NULL
When the <ODDNE> is NULL, it indicates that the odd wave
adjustment equipment does not exit.
<EVENNE> Indicates the TID of the even wave adjustment equipment. NULL
When the <EVENNE> is NULL, it indicates that the even wave
adjustment equipment does not exit.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ENT-APE::FAC-1-2-1:C:::BAND=CBAND,ODDNE=ShenZhen1,ODDBD=SLOT-1-
2,EVENNE=ShenZhen2,EVENBD=SLOT-1-9;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ED-APE
RTRV-APE
DLT-APE
OPR-APE
ED-APE
Edits an APE group.
Function
This command edits the control attributes of an APE group.
Usage Note
None
Category
APE
Security
Provisioning
Command Syntax
ED-APE:[<TID>]:<AID>:<CTAG>:::[AUTOADJ=<AUTOADJ>][,TH=<TH>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of the analyzer equipment, for example, the NA
port of an MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-APE::FAC-1-2-1:C:::AUTOADJ=Y,TH=2.0;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-APE
DLT-APE
OPR-APE
ENT-APE
DLT-APE
Deletes an APE group.
Function
This command deletes an APE group.
Usage Note
None
Category
APE
Security
Provisioning
Command Syntax
DLT-APE:[<TID>]:<AID>:<CTAG>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-APE::FAC-1-2-1:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ED-APE
RTRV-APE
OPR-APE
ENT-APE
OPR-APE
Operates an APE group.
Function
This command starts/stops the adjustment of an APE group.
Usage Note
None
Category
APE
Security
Maintenance
Command Syntax
OPR-APE:[<TID>]:<AID>:<CTAG>::<OPRT>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Example
Command
OPR-APE::FAC-1-2-1:C::START;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
ED-APE
RTRV-APE
DLT-APE
ENT-APE
RTRV-APE
Retrieves an APE group.
Function
This command retrieves the control attributes of an APE group.
Usage Note
None
Category
APE
Security
Retrieve
Command Syntax
RTRV-APE:[<TID>]:[<AID>]:<CTAG>
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of an analyzer port, for example, the port of an NA
MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>
When nothing is entered for this parameter, it indicates all APE
groups are retrieved.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::BAND=<BAND>[,ODDNE=<ODD_NEID>][,ODDBD=<ODDBD>]
[,EVENNE=<EVENNE>]
[,EVENBD=<EVENBD>],AUTOADJ=<AUTOADJ>,TH=<TH>,STATE=<STATE>"<cr><lf>)+
Response Parameters
Parameter Description
<AID> Indicates the AID of an analyzer port, for example, the port of an MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
Parameter Description
<TH> Indicates the threshold of un-equilibrium. This is the power threshold for
the APE pair to report an unbalanced power event.
Range: 0.5-3.0 (unit is 1.0 dBm).
<STATE> Indicates the state of an APE pair. The valid values are as follows:
NORMAL: The pair is in the normal state.
ABNORMAL: The pair detects that the waves are in a state of un-
equilibrium.
ADJUSTING: The APE pair is adjusting the waves for pre-
equilibrium.
PREV_ADJUSTING: The upstream pair is adjusting the waves for
pre-equilibrium.
Example
Command
RTRV-APE:::C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
"FAC-1-12-1::BAND=CBAND,ODDNE=SHENZHEN1,ODDBD=SLOT-
2,EVENNE=SHENZHEN2,EVENBD=SLOT-9,AUTOADJ=Y,TH=1.5,STATE=NORMAL"
"FAC-1-12-4::BAND=CBAND,ODDNE=SHENZHEN10,ODDBD=SLOT-
3,EVENNE=SHENZHEN20,EVENBD=SLOT-10,AUTOADJ=Y,TH=1.3,STATE=NORMAL"
;
Related Commands
ED-APE
DLT-APE
OPR-APE
ENT-APE
ED-APE-WCH
Edits a channel of an APE group.
Function
This command edits the attributes of a channel of an APE group.
Usage Note
None
Category
APE
Security
Provisioning
Command Syntax
ED-APE-WCH:[<TID>]:<AID>:<CTAG>:::[BANDTYPE=<BANDTYPE>]
[,STDBIAS=<STDBIAS>][,ENABLE=<ENABLE>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of an analyzer port, for example, the port of NA
an MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>-<CHANNEL ID>.
<BANDTYPE> Indicates the type of wave band. The only available value for CBAND
this parameter is CBAND.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-APE-WCH::FAC-1-2-1-1:C:::BANDTYPE=CBAND,STDBIAS=1.0,ENABLE=Y;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-APE-WCH
RTRV-APE-WCH
Retrieves the wavelengths of an APE group.
Function
This command retrieves the attributes of each channel.
Usage Note
None
Category
APE
Security
Retrieve
Command Syntax
RTRV-APE-WCH:[<TID>]:<AID>:<CTAG>:::[BANDTYPE=<BANDTYPE>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of an analyzer port, for example, the port of an NA
MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>-<CHANNEL ID>.
Support the "&" and "&&" symbol.
<BANDTYPE> Indicates the type of wave band. The only available value for this CBAND
parameter is CBAND.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::BANDTYPE=BANDTYPE,ENABLE=<ENABLE>,STDBIAS=<STDBIAS>,FACTBIAS=<F
ACTBIAS>" <cr><lf>)+
;
Response Parameters
Parameter Description
<AID> Indicates the AID of a channel. This parameter supports the "&" and "&&"
symbols.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>-
<CHANNEL ID>. The <CHANNEL ID> supports ALL.
<BANDTYPE> Indicates the type of wave band. The default and only available value for
this parameter is CBAND.
Example
Command
RTRV-APE-WCH::fac-1-11-4-80&FAC-1-11-4-72:C;
Response Message
NE 1990-01-01 11:59:46
M C COMPLD
"FAC-1-11-4-72::BAND=CBAND,ENABLE=Y,STDBIAS=12.7,FACTBIAS=12.7"
"FAC-1-11-4-80::BAND=CBAND,ENABLE=Y,STDBIAS=-0.8,FACTBIAS=-1.0"
;
Related Commands
ED-APE-WCH
REPT^EVT^APE
Reports an APE group event.
Function
This autonomous message is generated by an NE to inform the OS or maintenance personnel
about the APE information.
Usage Note
None
Category
APE
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^EVT^APE <cr> <lf>
(^^^"<AID>:<EVENTID>:[WAVE=<WAVE>][,REASON=<REASON>][,NE=<NE>]
[,EQPT=<EQPT>][,BDERR=<BDERR>]" <cr> <lf>)+
;
Response Parameters
Parameter Description
<AID> Indicates the AID of an analyzer port, for example, the port of an MCA.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<EVENTID> Indicates the event type. The valid values are as follows:
UNEQ: The channel power is unequal.
SUCC: The adjustment was successful.
FAIL: The adjustment failed.
ADDWAVE: Wavelengths were added.
DROPWAVE: Wavelengths were dropped.
<REASON> Indicates why the adjustment failed. This parameter is valid when <EVENTID>
is set to FAIL.
Parameter Description
<NE> Indicates the TID of a failed NE. It is a string with no more than 20 bytes.
This parameter is valid when <EVENTID> is set to FAIL.
<EQPT> Indicates the AID of the failed equipment. It indicates which equipment reports
an error. The valid format is SLOT-<SHELF ID>-<SLOT ID>.
This parameter is valid when <EVENTID> is set to FAIL.
<BDERR> Indicates the error code responded from a unit, if the failure is caused by unit
operation failure.
This parameter is valid when <EVENTID> is set to FAIL.
The valid values are as follows:
CMD-INVALID: The parameters in the command are incorrect.
PARA-ERR: The parameter length is incorrect.
OPR-FAIL: Execution of the command failed.
NOT-SUPPORTED: This command is not supported.
DISCARDED: The command is discarded.
BUSY: The command is being executed. The result cannot be returned
yet.
NOT-READY: The card is not prepared and the command cannot be
executed yet.
OVERTIME: Command execution times out.
Example
Command
None
Response Message
NE 2004-01-01 11:37:18
A 1 RETP EVT APE
"FAC-1-12-3:UNEQ:WAVE=ADDWAVE,"
;
Related Commands
None
ED-APE-AUTOREP
Edits the auto response flag of APE.
Function
This command is to edit the auto response flag of APE.
Usage Note
None
Category
APE
Security
Provisioning
Command Syntax
ED-APE-AUTOREP:[<TID>]::<CTAG>:::[AUTOREP=<APE_AUTOREP>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-APE-AUTOREP:::C:::AUTOREP=ENABLE;
Response Message
NEW-NE 2014-06-16 23:44:16
M C COMPLD
;
Related Commands
RTRV-APE-AUTOREP
RTRV-APE-AUTOREP
retrieves the auto response flag of APE.
Function
This command is to retrieve the auto response flag of APE.
Usage Note
None
Category
APE
Security
Retrieve
Command Syntax
RTRV-APE-AUTOREP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD
("AUTOREP=<APE_AUTOREP>"<cr><lf>)+
;
Response Parameters
Description Default Value
Parameter
Example
Command
RTRV-APE-AUTOREP:::C;
Response Message
NEW-NE 2014-06-17 01:08:34
M C COMPLD
"AUTOREP=ENABLE"
;
Related Commands
ED-APE-AUTOREP
ENT-ALC-NODE
Creates an ALC node.
Function
This command creates an ALC node on an NE.
Usage Note
None
Category
ALC
Security
Provisioning
Command Syntax
ENT-ALC-NODE:[<TID>]:<CHAIN>:<CTAG>:::[REFER=<REFER>]
[,PREVNE=<PREVNE>][,NEXTNE=<NEXTNE>][,DETECTOR=<DETECTOR>]
[,VOA=<VOA>][,AUTOFLAG=<AUTOFLAG>][,TH=<THRESHOLD>]
[,DEGTH=<DEGTH>][,BIAS=<BIAS>][,MONVOA=<MONVOA>];;
Command Parameters
Parameter Description Default Value
<REFER> Indicates the AID of the reference device on the node. NULL
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
Parameter Description Default Value
ID>.
NULL indicates that the node does not have a reference device.
Refer to ALC for the valid values of <REFER> for specific
units.
<DETECTOR> Indicates the AID of the detection device on the node. NULL
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>.
NULL indicates that the node does not have a detection device.
Refer to ALC for the valid values of <DETECTOR> for specific
units.
<VOA> Indicates the AID of the VOA (variable optical attenuator) NULL
device on the node.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>.
NULL indicates that the node does not have a VOA device.
Refer to ALC for the valid values of <VOA> for specific units.
<THRESHOLD> The power is considered abnormal when the difference between 2.0
the actual power and the reference power exceeds this value.
Range: 0.5 to 3.0 (unit is 1.0 dB). The default value is 2.0.
<DEGTH> Indicates the threshold for reporting a line degradation alarm. 2.0
When the line degrades to a certain degree so that the difference
between the actual attenuation and the reference attenuation
exceeds the threshold, an alarm indicating that the line
degradation exceeds expectation is reported.
Range: 0.5 to 15 (unit is 1.0 dB). The default value is 2.0.
Parameter Description Default Value
<MONVOA> Indicates the AID of the VOA (variable optical attenuator) NULL
device on the downstream node.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>.
NULL indicates that the node does not have a VOA device.
Refer to ALC for the valid values of <VOA> for specific units.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-ALC-NODE::ALC-1:C:::PREVNE=NE-01,NEXTNE=NE-03,DETECTOR=FAC-1-3-
4,VOA=FAC-1-1-1,TH=1.5;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
RTRV-ALC-NODE
ED-ALC-NODE
DLT-ALC-NODE
ED-ALC-NODE
Edits the parameters of an ALC node.
Function
This command edits the parameters of an ALC node on an NE.
Usage Note
None
Category
ALC
Security
Provisioning
Command Syntax
ED-ALC-NODE:[<TID>]:<CHAIN>:<CTAG>:::[AUTOFLAG=<AUTOFLAG>]
[,TH=<THRESHOLD>][,DEGTH=<DEGTH>][,BIAS=<BIAS>]
[,MONVOA=<MONVOA>];
Command Parameters
Parameter Description Default Value
<DEGTH> Indicates the threshold for reporting a line degradation alarm. 2.0
When the line degrades to a certain degree so that the difference
between the actual attenuation and the reference attenuation
exceeds the threshold, an alarm indicating that the line
degradation exceeds expectation is reported.
Range: 0.5 to 15 (unit is 1.0 dB). The default value is 2.0.
Response Parameters
None
Example
Command
ED-ALC-NODE::ALC-1:C:::TH=1.0,BIAS=-5;
Response Message
NE 2005-01-01 00:00:00
M C COMPLD
;
Related Commands
DLT-ALC-NODE
ENT-ALC-NODE
RTRV-ALC-NODE
DLT-ALC-NODE
Deletes an ALC node.
Function
This command deletes an ALC node on an NE.
Usage Note
None
Category
ALC
Security
Provisioning
Command Syntax
DLT-ALC-NODE:[<TID>]:<CHAIN>:<CTAG>;
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-ALC-NODE::ALC-1:C;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
ED-ALC-NODE
ENT-ALC-NODE
RTRV-ALC-NODE
RTRV-ALC-NODE
Retrieves the information of an ALC node.
Function
This command retrieves the information of an ALC node on an NE.
Usage Note
None
Category
ALC
Security
Retrieve
Command Syntax
RTRV-ALC-NODE:[<TID>]:[<CHAIN>]:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> (^^^"<CHAIN>:
[IDX=<NODE>],REFER=<REFER>,PREVNE=<PREVNE>,NEXTNE=<NEXTNE>,DETECTOR=<DETECT
OR>,VOA=<VOA>[,AUTOFLAG=<AUTOFLAG">],TH=<THRESHOLD>,DEGTH=<DEGTH>,BIAS=<BIA
S>[,LINEATTEN=<LINEATTEN>][,REFATTEN=<REFATTEN>][,GAIN=<GAIN>]
[,REFGAIN=<REFGAIN>][,NODEATTEN=<NODEATTEN>]
[,ACCBIAS=<ACCBIAS>],STATE=<STATE>[,MONVOA=<MONVOA>]"<cr><If>)+ ;
Response Parameters
Parameter Description
<THRESHOLD> The power is considered abnormal when the difference between the actual
power and the reference power exceeds this value.
Range: 0.5 to 3.0 (unit is 1.0 dB).
<DEGTH> Indicates the threshold for reporting a line degradation alarm. When the line
degrades to a certain degree so that the difference between the actual attenuation
and the reference attenuation exceeds the threshold, an alarm indicating that the
line degradation exceeds expectation is reported.
Range: 0.5 to 15 (unit is 1.0 dB). The default value is 2.0.
<LINEATTEN> Indicates the attenuation introduced by the transmission line (Line attenuation =
Output optical power of the upstream node - Input optical power of the local
node).
The valid format is unsigned float (unit is 1.0 dB).
The transmission line attenuation includes the VOA attenuation if a VOA exists.
The parameter is not displayed if the <LINEATTEN> value is invalid.
<REFATTEN> Indicates the reference line attenuation in the transmission. This parameter
serves as a nominal attenuation value for monitoring the line degradation. An
alarm is reported when the difference between the actual attenuation and the
value of this parameter exceeds the value of <DEGTH>. The value of this
parameter can be changed by using the OPR-ALC-NODE command. The
attenuation does not include the attenuation of the attenuators on the ALC link
but the attenuation of other attenuators that are not configured on the ALC link.
The valid format is unsigned float (unit is 1.0 dB).
The parameter is not displayed if the <REFATTEN> value is invalid.
<GAIN> Indicates the gain of the local node <DETECTOR>. The valid format is
unsigned float (unit is 1.0 dB).
This parameter is not displayed if the <GAIN> value is invalid.
<REFGAIN> Indicates the reference gain for an amplifier in the ALC function. When the
ALC function is used for adjusting the optical power, the attenuation or gain is
adjusted with the presumption that there is minimal deviation of the amplifier
gain from <REFGAIN>.
The valid format is unsigned float (unit is 1.0 dB).
Parameter Description
<NODEATTEN> Indicates the current attenuation of the VOA unit of the local node. The valid
format is unsigned float (unit is 1.0 dB).
The parameter is not displayed if the <NODEATTEN> value is invalid.
<ACCBIAS> Indicates the accumulated optical power deviation of the local node. The valid
format is signed float (unit is 1.0 dB).
<ACCBIAS> of the reference node is 0.
This parameter is not displayed if the <ACCBIAS> value is invalid.
Example
Command
RTRV-ALC-NODE:::C;
Response Message
NE 05-01-01 00:00:00 M C COMPLD "ALC-1:IDX=NO-1,REFER=FAC-1-3-
4,PERVID=NULL,NEXTNE=NE-
02,DETECTOR=NULL,VOA=NULL,AUTOFLAG=N,TH=2.5,DEGTH=2.0,BIAS=0.5,ACCBIAS=0,ST
ATE=IDLE" ; "ALC-2:IDX=NO-5,REFER=NULL,PREVNE=NE-04,NEXTNE=NE-
06,DETECTOR=FAC-1-9-2,VOA=FAC-1-1-
1,TH=2.0,DEGTH=2.0,BIAS=1.5,LINEATTEN=19.2,REFATTEN=15.0,GAIN=23.0,REFGAIN=
23.0,NODEATTEN=3.2,ACCBIAS=0.3,STATE=IDLE,MONVOA=FAC-5-5-2"; ;
Related Commands
DLT-ALC-NODE
ED-ALC-NODE
ENT-ALC-NODE
OPR-ALC-NODE
OPR-ALC-CHAIN
Operates an ALC chain.
Function
This command manually starts or stops the adjustment process on the chain.
This operation only be carried out on the first node of the ALC chain.
Usage Note
None
Category
ALC
Security
Maintenance
Command Syntax
OPR-ALC-CHAIN:[<TID>]:<CHAIN>:<CTAG>::<OPRT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
OPR-ALC-CHAIN::ALC-1:C::START;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
RTRV-ALC-CHAIN
RTRV-ALC-CHAIN
Retrieves an ALC chain.
Function
This command retrieves the information of all ALC nodes on a chain.
Usage Note
None
Category
ALC
Security
Retrieve
Command Syntax
RTRV-ALC-CHAIN:[<TID>]:<CHAIN>:<CTAG>;
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"
<CHAIN>:[IDX=<NODE>][,NENAME=<NENAME>][,LINEATTEN=<LINEATTEN>]
[,GAIN=<GAIN>][,NODEATTEN=<NODEATTE>][,ACCBIAS=<ACCBIAS>]
[,STATE=<NODESTATE>][,COMM=<COMM>][,CHAINSTATE=< CHAINSTATE>]
" <cr><If>)
;
Response Parameters
Parameter Description
<IDX> Indicates the statistic result of node index. The valid format is NO-<N>.
This parameter is not displayed if the node response is not received or the
node does not exist.
<LINEATTEN> Indicates the attenuation introduced by the transfer line (Line attenuation =
Output optical power of the upstream node - Input optical power of the
local node).
The valid format is unsigned float (unit is 1.0 dB). this parameter is not
displayed for the first node.
The transfer line attenuation includes VOA attenuation if a VOA exists.
This parameter is not displayed if the node response is not received or the
node does not exist.
<NODEATTEN> Indicates the current attenuation of the VOA unit of the local node.
The valid format is unsigned float (unit is 1.0 dB). NODEATTEN equals
zero if the node does not have a VOA device.
This parameter is not displayed if the node response is not received or the
node does not exist.
<ACCBIAS> Indicates the accumulated optical power deviation of the local node.
The valid format is signed float (unit is 1.0 dB).
This parameter is not displayed if the node response is not received or the
node does not exist.
<CHAINSTATE> Indicates the current state of a chain, which is displayed on only the first
node.
The valid values are as follows:
IDLE: It indicates that the chain is idle, and it is not abnormally
occupied on any node.
INVALID: It indicates that the chain is invalid.
ADJUSTING: It indicates that the chain started the adjustment, but
the adjustment is not complete.
ABNR: It indicates that some nodes have anomalies on the chain,
but the adjustment is not started.
COMMFAIL: The communication is abnormally occupied, and the
chain state is unclear.
This parameter is not displayed if the node response is not received or the
node does not exist.
Example
Command
RTRV-ALC-CHAIN::ALC-1:C;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
"ALC-1:IDX=NO-1,NENAME=NE-
01,LINEATTEN=0,GAIN=21.0,NODEATTEN=0,ACCBIAS=0.0,STATE=IDLE,COMM=SUCCESS,CH
AINSTATE=COMMFAIL;
ALC-1:IDX=NO-2,NENAME=NE-
02,LINEATTEN=18.0,GAIN=20.2,NODEATTEN=2.0,ACCBIAS=0.1,STATE=IDLE,COMM=
SUCCESS;
ALC-1:IDX=NO-3,NENAME=NE-
03,LINEATTEN=20.0,GAIN=22.0,NODEATTEN=1.2,ACCBIAS=0.2,STATE=IDLE,COMM=
SUCCESS;
ALC-1:IDX=NO-4,NENAME=NE-
04,LINEATTEN=19.8,GAIN=23.0,NODEATTEN=3.1,ACCBIAS=0.5,STATE=IDLE,COMM=
SUCCESS;
ALC-1:NENAME=NE-05,STATE=NOEXIST,COMM= SUCCESS; "
;
Related Commands
OPR-ALC-CHAIN
OPR-ALC-NODE
Samples the ALC reference value.
Function
This command collects the current attenuation of the optical power and gain of the amplifier
on the line as reference values REFATTEN and REFGAIN. The value REFATTEN is used
for determining whether an alarm is generated and REFGAIN is used as a reference value in
priority for ALC adjustment.
Usage Note
None
Category
ALC
Security
Provisioning
Command Syntax
OPR-ALC-NODE:[<TID>]:<CHAIN>:<CTAG>::<OPRT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
OPR-ALC-NODE::ALC-1:C::SAMP;
Response Message
NE 05-01-01 00:00:00 M C COMPLD ;
Related Commands
RTRV-ALC-NODE
INIT-ALC-LOG
Clears the records of an ALC event.
Function
This command clears the records of an ALC event.
Usage Note
None
Category
ALC
Security
Maintenance
Command Syntax
INIT-ALC-LOG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
INIT-ALC-LOG:::C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-ALC-LOG
RTRV-ALC-LOG
Queries the records of an ALC event.
Function
This command queries the records of an ALC event.
Usage Note
None
Category
ALC
Security
Retrieve
Command Syntax
RTRV-ALC-LOG:[<TID>]:[CHAIN]:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<CHAIN>,<EVENT>,<EVTINFO>:DATA=<DATE>,TIME=<TIME>""<cr><lf>)+
;
Response Parameters
Parameter Description
<EVENT> Indicates the event identifier. Possible events are listed as follows:
ABSTRACT: The abstract that contains all the basic information
about the chain adjustment.
Parameter Description
Example
Command
RTRV-ALC-LOG:::C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
"ALC-1,NODE-FAIL,CHAIN-TIME-OUT,OUTTIME=10: DATA=2006-02-27,TIME=16-47-
45"
"ALC-1,CHAIN-FAIL,IDX=NO-1,NENAME=HEXING: DATA=2006-02-27,TIME=16-47-45"
;
Related Commands
INIT-ALC-LOG
REPT^EVT^ALC
Reports an ALC event.
Function
This autonomous message is generated by an NE to inform maintenance personnel of the
ALC information.
Usage Note
None
Category
ALC
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^EVT^ALC <cr> <lf>
^^^"< CHAIN>::EVENT=<EVTTYPE>,<EXTPARA>" <cr> <lf>
;
Response Parameters
Parameter Description
<EVTTYPE> Indicates the ALC event type. Possible ALC events are as follows:
ABSTRACT: The abstract that contains all the basic information
about the chain adjustment.
NODE-ABNR: The state of the current node is abnormal.
NODE-FAIL: The node adjustment failed.
NODE-SUCC: The node adjustment succeeded.
NODE-RESU: The node state restored to normal.
NODE-ACK: It indicates the chain node adjustment response
event. Only the first chain node can report this event.
CHAIN-START: The chain adjustment started.
CHAIN-STOP: The chain adjustment stopped.
CHAIN-FINISH: The chain adjustment is complete.
CHAIN-FAIL: The communication is abnormal in the current
chain. The current chain state is unknown.
CHAIN-ABNR: The current chain state is abnormal. Some node
states are abnormal.
CHAIN-RESU: The current chain communication or state was
restored.
NENAME Indicates the NE name of the last chain node if its state is
abnormal. ABNRIDX and NENAME are not displayed
when the chain does not detect an abnormal node.
NODE-ABNR IDX Indicates the index number of the current node. The valid
format is NO-<N>.
ACCBIAS Indicates the cumulative value of the gain bias of all the
upstream-node amplifiers.
The valid format is signed float (unit is 1.0 dB).
NODE-FAIL REASON Indicates the cause of event possibly. The causes are listed
as follow:
NODE-STATE-ERR: There is an error in the state
of the current node.
CARD-RSP-ERR: It indicates an error in the unit
command response.
DEVICE-ALM-EXIST: A device alarm exists.
CHAIN-NO-EXIST: The chain does not exist.
CHAIN-CHAOS: It indicates the chaotic chain
configuration.
NODE-TIME-OUT: The node adjustment process
timed out.
NO-PERMIT-ERR: The current node is still
abnormal after the adjustment is complete.
NODE-SUCC NULL Indicates there are not any extended parameters in this
event.
NODE-RESU IDX Indicates the index number of the current node. The valid
format is NO-<N>.
ACCBIAS Indicate the cumulative value of the gain bias of all the
upstream-node amplifiers.
The valid format is signed float (unit is 1.0 dB). The
reference node is not displayed.
NODE-ACK IDX Indicates the index ID of the node that sends adjustment
responses. The valid format is NO-<N>.
RESULT Indicates the result of the node adjustment. The valid values
are SUCCESS and FAIL.
CHAIN-START NULL Indicates there are not any extended parameters in this
event.
IDX Indicates the index of the node that requested the chain
adjustment interruption. The valid format is NO-<N>.
NENAME Indicates the index of the node that requested the chain
adjustment interruption.
CHAIN-FINISH NULL Indicates there are not any extended parameters in this
event.
CHAIN-FAIL IDX Indicates the index of the node that detected the chain
communication was abnormal. The valid format is NO-
<N>.
CHAIN-ABNR IDX Indicates the index of the node in an abnormal state. The
valid format is NO-<N>.
CHAIN-RESU IDX Indicates the index of node in an abnormal state. The valid
format is NO-<N>.
Example
Command
None
Response Message
NE 2004-01-01 11:37:18
A 1 REPT EVT ALC
"ALC-1::CHAIN START"
;
Related Commands
None
OPR-RPCASE-<WDM>
Calibrates amplified spontaneous emission (ASE) for Raman boards.
Function
This command calibrates ASE for Raman boards to ensure the automatic level control (ALC)
feature can function properly.
Usage Note
None
Category
Facility
Security
Maintenance
Command Syntax
OPR-RPCASE-<WDM>:[<TID>]:<RULEAID>:<CTAG>;
Command Parameters
Default
Parameters Description Value
<RULEAID> Indicates the equipment unit identity. The valid format is FAC- NA
<SHELF ID>-<SLOT ID>-<PORT ID>-<PATH ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
OPR-RPCASE-WDM::FAC-1-4-9:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
RTRV-RPCASE-<WDM>
RTRV-RPCASE-<WDM>
Retrieves ASE calibration information of Raman boards.
Function
This command retrieves ASE calibration information of Raman boards.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-RPCASE-{WDM}:[<TID>]:<RULEAID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<RULEAID>::FIBERTYPE=<NGWDMFIBERTYPE>,BARCODE=<BARCODE>,IDENTIFYFLAG=<I
DENTIFYFLAG>"<cr><lf>
;
Response Parameters
Parameter Description
<RULEAID> Indicates the equipment unit identity. The valid format is FAC-<SHELF ID>-
<SLOT ID>-<PORT ID>-<PATH ID>.
Example
Command
RTRV-RPCASE-WDM::FAC-1-4-9:C;
Response Message
NE11 2012-08-23 09:50:06
M C COMPLD
"FAC-1-2-
9::FIBERTYPE=G652,BARCODE=000PBW0000000111,IDENTIFYFLAG=2018915346"
;
Related Commands
OPR-RPCASE-<WDM>
Function
This command creates a node on an OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ENT-OD-SEC:
[<TID>]:<SECID>:<CTAG>::<NODENUM>,<NODETYPE>,<NODEPOS>,<NEID>,<BDP
ORT>,<BDTYPE>,[<ATTACHNO>],[<ATTACHPORT>];
Command Parameters
Parameter Description Default Value
<BDTYPE> Indicates the type of the board where the node resides. NA
<ATTACHPORT> Indicates the port AID which the OPM or OSC is associated. FAC-1–0–0
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-OD-SEC::SEC-1:C::10,BOARD,1,NEW-NE,FAC-1-1-1,13OAU1,0,,;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
D.17.3 RTRV-OD-SEC
D.17.2 DLT-OD-SEC
D.17.2 DLT-OD-SEC
Deletes an OD section.
Function
This command deletes an OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
DLT-OD-SEC:[<TID>]:<SECID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-OD-SEC::SEC-3:C
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
D.17.1 ENT-OD-SEC
D.17.3 RTRV-OD-SEC
D.17.3 RTRV-OD-SEC
Retrieves the OD section information.
Function
This command retrieves the OD section information.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-SEC:[<TID>]:<SECID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>:<NODENUM>,<NODETYPE>,<NODEPOS>,<NEID>,<BDPORT>,<BDTYPE>,
[<ATTACHNO>],[<ATTACHPORT>]"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
BOARD
OPM
OSC
<BDTYPE> Indicates the type of the board where the node resides. NA
<ATTACHPORT> Indicates the port AID which the OPM or OSC is associated. FAC-1–0–0
Example
Command
RTRV-OD-SEC::SEC-3:C
Response Message
NE 05-01-01 00:00:00
M C COMPLD
"SEC-3:13,BOARD,1,NE32-15,FAC-1-2-1,12OAU1"
"SEC-3:13,BOARD,2,NE32-15,FAC-1-2-4,12OAU1"
"SEC-3:13,OPM,3,NE32-15,FAC-1-13-1,11OPM8,2"
"SEC-3:13,BOARD,4,NE64-14,FAC-1-2-1,12OAU1"
"SEC-3:13,BOARD,5,NE64-14,FAC-1-2-4,12OAU1"
"SEC-3:13,BOARD,6,NE64-14,FAC-1-15-1,11OBU1"
"SEC-3:13,BOARD,7,NE64-14,FAC-1-15-2,11OBU1"
"SEC-3:13,BOARD,8,NE64-14,FAC-1-14-1,13OAU1"
"SEC-3:13,BOARD,9,NE64-14,FAC-1-14-4,13OAU1"
"SEC-3:13,OPM,10,NE64-14,FAC-1-7-3,11MCA4,7"
"SEC-3:13,OPM,11,NE64-14,FAC-1-7-1,11MCA4,9"
"SEC-3:13,OSC,12,NE32-15,FAC-1-33-1,12SC2,2"
"SEC-3:13,OSC,13,NE64-14,FAC-1-13-1,12SC2,9"
;
Related Commands
D.17.1 ENT-OD-SEC
D.17.2 DLT-OD-SEC
D.17.4 RTRV-PORT-ODATTR
Retrieves the ID of OD section by port.
Function
This command retrieves the ID of OD section by port.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-PORT-ODATTR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>:<SECID>,<TID>"<cr><lf>)+
;
Response Parameters
None
Example
Command
RTRV-PORT-ODATTR::FAC-1-12-1:C;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
" FAC-1-12-1:SEC-1,NE-1-1"
Related Commands
D.17.1 ENT-OD-SEC
D.17.2 DLT-OD-SEC
D.17.3 RTRV-OD-SEC
D.17.5 AUD-OD-SEC
Verifies if the section ID of the optical doctor (OD) is valid.
Function
This command verifies if the section ID of an OD is valid.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
AUD-OD-SEC:[<TID>]:<SECID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<SECID> Indicates the section IDs that are connected using &. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
AUD-OD-SEC::SEC-3&SEC-4:C
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
D.17.1 ENT-OD-SEC
D.17.2 DLT-OD-SEC
D.17.3 RTRV-OD-SEC
D.17.6 ED-OD-OSNREN
Edits the OD OSNR reporting enable flag.
Function
This command edits the OD OSNR reporting enable flag.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-OD-OSNREN:[<TID>]:<AID>:<CTAG>::<STATE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OD-OSNREN::FAC-1-1-1:C::ENABLE;
Response Message
NE 2005-11-02 09:48:24
M C COMPLD
;
Related Commands
D.17.7 RTRV-OD-OSNREN
D.17.7 RTRV-OD-OSNREN
Retrieves the OD OSNR reporting enable flag.
Function
This command retrieves the OD OSNR reporting enable flag.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-OSNREN:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>:<STATE>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-OD-OSNREN::FAC-1-1-1:C;
Response Message
NE 2005-11-02 09:48:24
M C COMPLD
"FAC-1-1-1:DISABLE"
;
Related Commands
D.17.6 ED-OD-OSNREN
D.17.8 RTRV-OD-OSNRLOSS
Retrieves the OSNR loss of the OD section.
Function
This command retrieves the OSNR loss of the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-OSNRLOSS:[<TID>]:<SECID>:<CTAG>::<SOURCE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>::SOURCE=<SOURCE>,OAIDX=<OAIDX>,WVNUM=<WVNUM>,OSNRLOSS=<OSNRLOS
S>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<OSNRLOSS> Indicates the OSNR loss of the wavelength in units of 1.0. For NA
example, 25.6 indicates that the OSNR is 25.6 .
Example
Command
RTRV-OD-OSNRLOSS::SEC-1:C::OD;
Response Message
NE61 2012-12-26 13:52:53
M C COMPLD
"SEC-1::SOURCE=OD,WVNUM=72,OSNRLOSS=0.0"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.9 RTRV-OD-OSNR
Retrieves the OSNR of the OD section.
Function
This command retrieves the OSNR of the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-OSNR:[<TID>]:<SECID>:<CTAG>::<SOURCE>,<OAIDX>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>::SOURCE=<SOURCE>,OAIDX=<OAIDX>,WVNUM=<WVNUM>,VLDTY=<VLDTY>,WVO
SNR=<WVOSNR>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<VLDTY> Indicates whether the OSNR is valid. The valid values are NA
VALID and INVALID.
<WVOSNR> Indicates the OSNR of the wavelength in units of 1.0 dB. For NA
example, 25.6 indicates that the OSNR is 25.6 dB.
Example
Command
RTRV-OD-OSNR::SEC-1:C::OD,1;
Response Message
NE61 2012-12-26 14:24:57
M C COMPLD
"SEC-1::SOURCE=OD,OAIDX=1,WVNUM=72,VLDTY=INVALID,WVOSNR=INVALID"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.10 STA-OD-CALC
Starts a calculation of the OD section.
Function
This command starts a calculation of the OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
STA-OD-CALC:
[<TID>]:<SECID>:<CTAG>::<SOURCE>,<SYSTEM_WAVENUM>,<WAVELEN_LIST>;
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
STA-OD-CALC::SEC-1:C::MDS6630,C80,18,20,22,24;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
D.17.1 ENT-OD-SEC
D.17.2 DLT-OD-SEC
D.17.3 RTRV-OD-SEC
D.17.11 RTRV-OD-ADJVAL
Retrieves the attenuation and target power of the OD section.
Function
This command retrieves the attenuation and target power of the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-ADJVAL:[<TID>]:<SECID>:<CTAG>::<SOURCE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>::SOURCE=<SOURCE>,WVNUM=<WVNUM>,VOAOFFSET=<VOAOFFSET>,GOALPWR=<
GOALPWR>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
Command
RTRV-OD-ADJVAL::SEC-1:C::OD;
Response Message
NE61 2012-12-26 17:09:04
M C COMPLD
"SEC-1::SOURCE=OD,WVNUM=68,VOAOFFSET=0.7,GOALPWR=0.2"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.12 RTRV-OD-WVPWR
Retrieves the power of single wave length of a specific OA in the OD section.
Function
This command retrieves the power of single wave length of a specific OA in the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-WVPWR:[<TID>]:<SECID>:<CTAG>::<SOURCE>,<OAIDX>;
Command Parameters
Parameter Description Default Value
from 0)
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>::SOURCE=<SOURCE>,SOURCE=<SOURCE>,OAIDX=<OAIDX>,WVNUM=<WVNUM>,I
NPWR=<INPWR>,OUTPWR=<OUTPWR>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-OD-WVPWR::SEC-1:C::OD,0;
Response Message
NE61 2012-12-26 13:48:43
M C RTRV
"SEC-1::SOURCE=OD,OAIDX=0,WVNUM=24,INPWR=-22.1,OUTPWR=-60.0"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.13 RTRV-OD-AVRPWR
Retrieves the average input and output power of a specific OA in the section.
Function
This command retrieves the average input and output power of a specific OA in the section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-AVRPWR:[<TID>]:<SECID>:<CTAG>::<SOURCE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>::SOURCE=<SOURCE>,SOURCE=<SOURCE>,OAIDX=<OAIDX>,INAVRPWR=<INAVR
PWR>,OUTAVRPWR=<OUTAVRPWR>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-OD-AVRPWR::SEC-1:C::OD;
Response Message
NE61 2012-12-26 13:32:05
M C COMPLD
"SEC-1::SOURCE=OD,OAIDX=0,INAVRPWR=-22.2,OUTAVRPWR=9"
"SEC-1::SOURCE=OD,OAIDX=1,INAVRPWR=-33.2,OUTAVRPWR=6"
"SEC-1::SOURCE=OD,OAIDX=2,INAVRPWR=-21.8,OUTAVRPWR=5"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.14 RTRV-OD-STATE
Retrieves the state of the OD calculation.
Function
This command retrieves the state of the OD calculation.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-STATE:[<TID>]:<SECID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-OD-STATE::SEC-1:C;
Response Message
NE61 2012-12-26 13:20:30
M C COMPLD
"SEC-1::STATE=IDLE"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.15 RTRV-MCA-PWR
Retrieves the power of every wavelength detected by MCA.
Function
This command retrieves the power of every wavelength detected by MCA.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-MCA-PWR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<AID> Indicates the MCA port access identifier. The valid format is NA
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.(<SHELF ID> is
omitted on 3800 devices.)
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::WVNUM=<WVNUM>,ISNOISE=<ISNOISE>,WVPWR=<WVPWR>"<cr><lf>)+
;
Response Parameters
None
Example
Command
RTRV-MCA-PWR::FAC-1-12-1:C;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
"FAC-1-12-1::WVNUM=1,ISNOISE=YES,WVPWR=-60.0"
D.17.16 RTRV-OD-SECSTA
Retrieves the state of the EMCA calculation of OD section.
Function
This command retrieves the state of the EMCA calculation of OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-SECSTA:[<TID>]:<SECID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<SECID>::MAINSTATE=<MAINSTATE>,SUBSTATE=<SUBSTATE>,OSCSTATE=<OSCSTATE>
,TIMEOUT=<TIMEOUT>,PARA1=<PARA1>,PARA2=<PARA2>,PARA3=<PARA3>,PARA4=<PARA4>,
PARA5=<PARA5>,PARA6=<PARA6>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<MAINSTATE> Indicates the mian state of the EMCA calculation. The valid NA
values are as follows:
INIT: Section is initing
INIT_OK: Section initied, and checked is OK
INIT_ERR: Section initied, but checked is error
OSCROUTE_INIT: OSC init
OSCROUTE_INITING: OSC is initing
OSCROUTE_INIT_FINISH: OSC init is finished
GETTING_PARA: Getting section parameter
GOT_PARA: Got section parameter
GOT_PARA_ERR: Got error parameter
EMCA_START: EMCA starts
EMCA_WORKING: EMCA is working
EMCA_START_ERR: EMCA is working with error
REFRESHING_PARA: Parameter is refreshing
REFRESHED_PARA: Parameter is refeshed
REFRESHED_PARA_ERR: Parameter is refeshed with
error
SEC_STATE_DELETED: Section state is deleted
<SUBSTATE> Indicates the sub state of the EMCA calculation. The valid NA
values are as follows:
Normal
NO_BOARD: No main optical line board
Parameter Description Default Value
<OSCSTATE> Indicates the OSC state of the EMCA calculation. The valid NA
values are as follows:
NULL: NO OSC
OK: OSC is OK
ERROR: OSC is error
Example
Command
RTRV-OD-SECSTA::SEC-1:C;
Response Message
NE61 2012-12-26 13:20:30
M C COMPLD
"SEC-1::STATE=IDLE"
;
Related Commands
D.17.3 RTRV-OD-SEC
D.17.1 ENT-OD-SEC
D.17.2 DLT-OD-SEC
D.17.17 ED-OD-OAPWR
Edits the enable flag and threshold of OA power in the OD section.
Function
This command Edits the enable flag and threshold of OA power in the OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-OD-OAPWR:[<TID>]:<AID>:<CTAG>:::[DETECTEN=<DETECTEN>,]
[DETECTTH=<DETECTTH>,][ALMREPEN=<ALMREPEN>,];
Command Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
<ALMREPEN> Power Alarm automatic Report flag. The valid values are: DISABLE
ENABLE
DISABLE
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OD-OAPWR::FAC-1-5-3:C:::DETECTEN=ENABLE,DETECTTH=1.6,ALMREPEN=ENABLE;
Response Message
NEW-NE 2014-06-21 00:55:16
M C COMPLD
;
Related Commands
D.17.18 RTRV-OD-OAPWR
D.17.18 RTRV-OD-OAPWR
Retrieves the enable flag and threshold of OA power in the OD section.
Function
This command retrieves the enable flag and threshold of OA power in the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-OAPWR:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::DETECTEN=<SOURCE>,DETECTTH=<SOURCE>,ALMREPEN=<ALMREPEN>"<cr><lf
>)+
;
Response Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
<ALMREPEN> Power Alarm automatic Report flag. The valid values are: DISABLE
ENABLE
DISABLE
Example
Command
RTRV-OD-OAPWR::FAC-1-5-3:C;
Response Message
NEW-NE 2014-06-21 00:54:58
M C COMPLD
"FAC-2-2-3::DETECTEN=DISABLE,DETECTTH=1.5,ALMREPEN=ENABLE"
;
Related Commands
D.17.17 ED-OD-OAPWR
D.17.19 ED-OD-PWRFLAT
Edits the enable flat and threshold of power in the OD section.
Function
This command Edits the enable flat and threshold of power in the OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-OD-PWRFLAT:[<TID>]:<AID>:<CTAG>:::[DETECTEN=<DETECTEN>,]
[DETECTTH=<DETECTTH>,][ALMREPEN=<ALMREPEN>,];
Command Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OD-PWRFLAT::FAC-1-5-3:C:::DETECTEN=ENABLE,DETECTTH=1.6,ALMREPEN=ENABLE;
Response Message
NEW-NE 2014-06-21 00:55:16
M C COMPLD
;
Related Commands
D.17.20 RTRV-OD-PWRFLAT
D.17.20 RTRV-OD-PWRFLAT
Retrieves the enable flat and threshold of power in the OD section.
Function
This command retrieves the enable flat and threshold of power in the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-PWRFLAT:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::DETECTEN=<DETECTEN>,DETECTTH=<DETECTTH>,ALMREPEN=<ALMREPEN>"<cr
><lf>)+
;
Response Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
Example
Command
RTRV-OD-PWRFLAT::FAC-2-2-3:C;
Response Message
NEW-NE 2014-06-21 01:07:34
M C COMPLD
"FAC-2-2-3::DETECTEN=DISABLE,DETECTTH=3.0,ALMREPEN=ENABLE"
;
Related Commands
D.17.19 ED-OD-PWRFLAT
D.17.21 ED-OD-OSNRLOSSFLAT
Edits the OSNR loss flat in the OD section.
Function
This command Edits the enable flat and threshold of OA power in the OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-OD-OSNRLOSSFLAT:[<TID>]:<AID>:<CTAG>:::[DETECTEN=<DETECTEN>,]
[DETECTTH=<DETECTTH>,][ALMREPEN=<ALMREPEN>,];
Command Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
<ALMREPEN> Power Alarm automatic Report flat. The valid values are: DISABLE
ENABLE
DISABLE
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OD-OSNRLOSSFLAT::FAC-1-5-
3:C:::DETECTEN=ENABLE,DETECTTH=1.6,ALMREPEN=ENABLE;
Response Message
NEW-NE 2014-06-21 00:55:16
M C COMPLD
;
Related Commands
D.17.22 RTRV-OD-OSNRLOSSFLAT
D.17.22 RTRV-OD-OSNRLOSSFLAT
Retrieves the OSNR loss flat in the OD section.
Function
This command retrieves the OSNR loss flat in the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-PWRFLAT:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::DETECTEN=<DETECTEN>,DETECTTH=<DETECTTH>,ALMREPEN=<ALMREPEN>"<cr
><lf>)+
;
Response Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
<ALMREPEN> Power Alarm automatic Report flat. The valid values are: DISABLE
ENABLE
DISABLE
Example
Command
RTRV-OD-OSNRLOSSFLAT::FAC-2-2-3:C;
Response Message
NEW-NE 2014-06-21 01:19:05
M C COMPLD
"FAC-2-2-3::DETECTEN=ENABLE,DETECTTH=1.6,ALMREPEN=ENABLE"
;
Related Commands
D.17.21 ED-OD-OSNRLOSSFLAT
D.17.23 ED-OD-CHN
Edits the enable flag of CHN in the OD section.
Function
This command Edits the enable flag of CHN in the OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-OD-CHN:[<TID>]:<AID>:<CTAG>:::[WVDETECTEN=<WVDETECTEN>,]
[OSNREN=<OSNREN>,];
Command Parameters
Parameter Description Default Value
<WVDETECTEN> Enable the wavelength detection flag. The valid values are: N
Y
N
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OD-CHN::FAC-1-5-3-1:C:::WVDETECTEN=Y,OSNREN=Y;
Response Message
NEW-NE 2014-06-21 01:45:31
M C COMPLD
;
Related Commands
D.17.24 RTRV-OD-CHN
D.17.24 RTRV-OD-CHN
Retrieves the enable flag of CHN in the OD section.
Function
This command retrieves the enable flag of CHN in the OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OD-CHN:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::WVDETECTEN=<WVDETECTEN>,OSNREN=<OSNREN>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<WVDETECTEN> Enable the wavelength detection flag. The valid values are: N
Y
N
Example
Command
RTRV-OD-CHN::FAC-2-2-3-ALL:C;
Response Message
NEW-NE 2014-06-21 01:52:09
M C RTRV
"FAC-2-2-3-1::WVDETECTEN=Y,OSNREN=Y"
"FAC-2-2-3-2::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-3::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-4::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-5::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-6::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-7::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-8::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-9::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-10::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-11::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-12::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-13::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-14::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-15::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-16::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-17::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-18::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-19::WVDETECTEN=N,OSNREN=N"
"FAC-2-2-3-20::WVDETECTEN=N,OSNREN=N"
>
Related Commands
D.17.23 ED-OD-CHN
D.17.25 OPR-OLC
Operates an OLC group of OD section.
Function
This command starts/stops the adjustment of an OLC group of OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
OPR-OLC:[<TID>]:<RULEAID>:<CTAG>::<OLCOPRT>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Example
Command
OPR-OLC::FAC-1-2-1:C::START;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.17.26 ED-ATTR-OLC
D.17.27 RTRV-ATTR-OLC
D.17.26 ED-ATTR-OLC
Edits the attributes of OLC parameters of OD section.
Function
This command edits the attributes of OLC parameters of OD section.
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-ATTR-OLC:[<TID>]:<RULEAID>:<CTAG>:::[AUTOREPEN=<AUTOREPEN>,]
[ADJSWEN=<ADJSWEN>,][EOLEN=<EOLEN>,]
[ABNORMALEN=<ABNORMALEN>,][ABNORMALTH=<ABNORMALTH>,];
Command Parameters
Parameter Description Default Value
<AUTOREPEN> The state of alarm report. Only for the mon port of OA unit. ENABLE
The valid values:
ENABLE
DISABLE
Parameter Description Default Value
RESTART
<ADJSWEN> Enables or disables the automatic adjustment. Only for the DISABLE
mon port of OA unit. The valid values:
ENABLE
DISABLE
<EOLEN> Enables or disables the EOL detection. The first port of OTS DISABLE
receive direction. The valid values:
ENABLE
DISABLE
<ABNORMALEN> Enables or disables the OMS loss compensation. Only for the DISABLE
mon port of OA unit. The valid values:
ENABLE
DISABLE
<ABNORMALTH> The threshold of OMS loss compensation. Only for the mon 2.0
port of OA unit. Range: 1.0–3.0
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-ATTR-OLC::FAC-2-2-
3:C:::AUTOREPEN=enable,ADJSWEN=enable,ABNORMALEN=enable,ABNORMALTH=1.2;
ED-ATTR-OLC::FAC-2-1-1:C:::EOLEN=DISABLE;
Response Message
NEW-NE 2014-06-21 00:55:16
M C COMPLD
;
Related Commands
D.17.27 RTRV-ATTR-OLC
D.17.27 RTRV-ATTR-OLC
Retrieves the attributes of OLC parameters of OD section.
Function
This command retrieves the attributes of OLC parameters OD section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-ATTR-OLC:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<RULEAID>::[ADJSTATE=<ADJSTATE>,][AUTOREPEN=<AUTOREPEN>,]
[ACTATTEN=<ACTATTEN>,][ADJSWEN=<ADJSWEN>,]
[EOLEN=<EOLEN>,][ABNORMALEN=<ABNORMALEN>,]
[ABNORMALTH=<ABNORMALTH>,]"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<ADJSTATE> The line state of OMS loss compensation, Only for the mon NA
port of OA unit. The valid values:
INVALID
IDLE
ABNORMAL
ADJUST
ALMEXIST
FAIL
<AUTOREPEN> The state of alarm report. Only for the mon port of OA unit. ENABLE
The valid values:
ENABLE
Parameter Description Default Value
DISABLE
RESTART
<ACTATTEN> The line attenuation of OMS loss compensation. The first port NA
of OTS receive direction, unit in 1.0 dB.
<ADJSWEN> Enables or disables the automatic adjustment. Only for the DISABLE
mon port of OA unit. The valid values:
ENABLE
DISABLE
<EOLEN> Enables or disables the EOL detection. The first port of OTS DISABLE
receive direction. The valid values:
ENABLE
DISABLE
<ABNORMALEN> Enables or disables the OMS loss compensation. Only for the DISABLE
mon port of OA unit. The valid values:
ENABLE
DISABLE
<ABNORMALTH> The threshold of OMS loss compensation. Only for the mon 2.0
port of OA unit. Range: 1.0–3.0
Example
Command
RTRV-ATTR-OLC::FAC-2-2-3:C;
RTRV-ATTR-OLC::FAC-2-1-1:C;
RTRV-ATTR-OLC:::C;
Response Message
NEW-NE 2014-06-23 18:48:07
M C COMPLD
"FAC-2-2-
3::ADJSTATE=INVALID,AUTOREPEN=ENABLE,ADJSWEN=ENABLE,ABNORMALEN=ENABLE,ABNOR
MALTH=1.2"
;
RTRV-ATTR-OLC::FAC-2-1-1:C
Related Commands
D.17.26 ED-ATTR-OLC
D.17.28 REPT^EVT^OLCADJ^FINISH
Reports an OLC adjust finished event.
Function
This autonomous message is generated by an NE to inform maintenance personnel of the
OLC adjust finished information.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^EVT^ALC <cr> <lf>
^^^"<RULEAID>::RSV0=<RSV0>,RSV1=<RSV1>" <cr> <lf>
;
Response Parameters
Parameter Description
<RSV0> Indicates the attenuation applied at the interface. The value is expressed in
dBm and is accurate to 0.1 dBm.
<RSV1> Indicates the actual gain of the optical amplifier. This parameter is only
valid for the OA unit.
Example
Command
None
Response Message
NE 2004-01-01 11:37:18
A 1 REPT EVT OLCADJFINISH
"FAC-2-2-3::RSV0=0.1,RSV1=200"
;
Related Commands
None
D.17.29 ED-OSNRCHN
Edits the enable flag of the wavelength OSNR(optical signal-to-noise ratio).
Function
This command Edits the enable flag of the wavelength OSNR(optical signal-to-noise ratio).
Usage Note
None
Category
OD
Security
Provisioning
Command Syntax
ED-OSNRCHN:[<TID>]:<AID>:<CTAG>:::[OSNREN=<OSNREN>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OSNRCHN::FAC-1-5-3-1:C:::OSNREN=Y;
Response Message
NEW-NE 2014-06-21 01:45:31
M C COMPLD
;
Related Commands
D.17.30 RTRV-OSNRCHN
D.17.30 RTRV-OSNRCHN
Retrieves the enable flag of the wavelength OSNR(optical signal-to-noise ratio).
Function
This command retrieves the enable flag of the wavelength OSNR(optical signal-to-noise
ratio).
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-OSNRCHN:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::OSNREN=<OSNREN>"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<AID> AID of Optical Amplifier Unit. For example, mon port of board. NA
Example
Command
RTRV-OD-CHN::FAC-2-2-3-ALL:C;
Response Message
NEW-NE 2014-06-21 01:52:09
M C RTRV
"FAC-2-2-3-1::OSNREN=Y"
"FAC-2-2-3-2::OSNREN=N"
"FAC-2-2-3-3::OSNREN=N"
"FAC-2-2-3-4::OSNREN=N"
"FAC-2-2-3-5::OSNREN=N"
"FAC-2-2-3-6::OSNREN=N"
"FAC-2-2-3-7::OSNREN=N"
"FAC-2-2-3-8::OSNREN=N"
"FAC-2-2-3-9::OSNREN=N"
"FAC-2-2-3-10::OSNREN=N"
"FAC-2-2-3-11::OSNREN=N"
"FAC-2-2-3-12::OSNREN=N"
"FAC-2-2-3-13::OSNREN=N"
"FAC-2-2-3-14::OSNREN=N"
"FAC-2-2-3-15::OSNREN=N"
"FAC-2-2-3-16::OSNREN=N"
"FAC-2-2-3-17::OSNREN=N"
"FAC-2-2-3-18::OSNREN=N"
"FAC-2-2-3-19::OSNREN=N"
"FAC-2-2-3-20::OSNREN=N"
>
Related Commands
D.17.29 ED-OSNRCHN
D.17.31 STA-ODFLEX-CALC
Starts a calculation of the OD FLEX section.
Function
This command starts a calculation of the OD FLEX section.
Usage Note
None
Category
OD FLEX
Security
Provisioning
Command Syntax
STA-ODFLEX-CALC:
[<TID>]:<EMCA_SECID>:<CTAG>::<EMCA_ADJUST_SOURCE>,<EMCA_TOTAL>,<EM
CA_NUM>,<EMCA_FLEXWAVENUM>;
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
STA-ODFLEX-CALC::SEC-1:C::MDS6630,10,1,195.65THz&195.95THz;
Response Message
NE 05-01-01 00:00:00
M C COMPLD
;
Related Commands
D.17.1 ENT-OD-SEC
D.17.2 DLT-OD-SEC
D.17.3 RTRV-OD-SEC
D.17.32 RTRV-MCAFLEX-PWR
Retrieves the power of every wavelength detected by MCA FLEX.
Function
This command retrieves the power of every wavelength detected by MCA FLEX.
Usage Note
None
Category
OD FLEX
Security
Retrieve
Command Syntax
RTRV-MCAFLEX-PWR:[<TID>]:<EMCA_BDPORT>:<CTAG>;
Command Parameters
Parameter Description Default Value
<AID> Indicates the MCA port access identifier. The valid format is NA
FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.(<SHELF ID> is
omitted on 3800 devices.)
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<EMCA_BDPORT>::TOTAL=<EMCA_TOTAL>,NO=<EMCA_NUM>,CNTRFREQ=<EMCA_CENTER>
,BANDWIDTH=<EMCA_WIDTH>,ISNOISE=<EMCA_ISNOISE>,WVPWR=<EMCA_WVPWR>"<cr><lf>)
+
;
Response Parameters
None
Example
Command
RTRV-MCAFLEX-PWR::FAC-1-12-1:C;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
"FAC-1-6-
1:TOTAL=107,NO=1,CNTRFREQ=196056250,BANDWIDTH=37500,ISNOISE=NO,MCAPWR=-
20.3";
D.17.33 RTRV-ODFLEX-ADJVAL
Retrieves the attenuation and target power of the OD FLEX section.
Function
This command retrieves the attenuation and target power of the OD FLEX section.
Usage Note
None
Category
OD FLEX
Security
Retrieve
Command Syntax
RTRV-ODFLEX-ADJVAL:
[<TID>]:<EMCA_SECID>:<CTAG>::<EMCA_ADJUST_SOURCE>;
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<EMCA_SECID>::SOURCE=<EMCA_ADJUST_SOURCE>,TOTAL=<EMCA_TOTAL>,NO=<EMCA_
NUM>,CNTRFREQ=<EMCA_CENTER>,BANDWIDTH=<EMCA_WIDTH>,VOAOFFSET=<VOAOFFSET>,GO
ALPWR=<PWR_OPT>"<cr><lf>)+
;
Response Parameters
Parameter Description Default
Value
Example
Command
RTRV-ODFLEX-ADJVAL::SEC-1:C::OD;
Response Message
NE61 2012-12-26 17:09:04
M C COMPLD
"SEC-
1::SOURCE=OD,TOTAL=107,NO=1,CNTRFREQ=196.056250THz,BANDWIDTH=37.500GHz,VOAO
FFSET=-0.5,GOALPWR=0.2"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.34 RTRV-ODFLEX-WVPWR
Retrieves the power of single wave length of a specific OA in the OD FLEX section.
Function
This command retrieves the power of single wave length of a specific OA in the OD FLEX
section.
Usage Note
None
Category
OD FLEX
Security
Retrieve
Command Syntax
RTRV-ODFLEX-WVPWR:
[<TID>]:<EMCA_SECID>:<CTAG>::<EMCA_ADJUST_SOURCE>,<EMCA_OAINDEX>;
Command Parameters
Default
Parameter Description Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<EMCA_SECID>::SOURCE=<EMCA_ADJUST_SOURCE>,OAIDX=<EMCA_OAINDEX>,OATID=<
EMCA_NEID>,INPORT=<EMCA_INPORT>,OUTPORT=<EMCA_OUTPORT>,TOTAL=<EMCA_TOTAL>,N
O=<EMCA_NUM>,CNTRFREQ=<EMCA_CENTER>,BANDWIDTH=<EMCA_WIDTH>,INPWR=<INPUT_WAV
E_POWER>,OUTPWR=<OUTPUT_WAVE_POWER>"<cr><lf>)+
;
Response Parameters
Parameter Description Default
Value
Example
Command
RTRV-ODFLEX-WVPWR::SEC-1:C::OD,0;
Response Message
NE61 2012-12-26 13:48:43
M C RTRV
"SEC-1::SOURCE=OD,OAIDX=1,OATID=NEW-NE,INPORT=FAC-1-11-1,OUTPORT=FAC-1-
11-4,TOTAL=107,NO=1,CNTRFREQ=196.056250THz,BANDWIDTH=37.500GHz,INPWR=-
23.2,OUTPWR=-5.1"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.35 RTRV-ODFLEX-OSNR
Retrieves the OSNR of the OD FLEX section.
Function
This command retrieves the OSNR of the OD FLEX section.
Usage Note
None
Category
OD FLEX
Security
Retrieve
Command Syntax
RTRV-ODFLEX-OSNR:
[<TID>]:<EMCA_SECID>:<CTAG>::<EMCA_ADJUST_SOURCE>,<EMCA_OAINDEX>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<EMCA_SECID>::SOURCE=<EMCA_ADJUST_SOURCE>,OAIDX=<EMCA_OAINDEX>,OATID=<
EMCA_NEID>,INPORT=<EMCA_INPORT>,OUTPORT=<EMCA_OUTPORT>,TOTAL=<EMCA_TOTAL>,N
O=<EMCA_NUM>,CNTRFREQ=<EMCA_CENTER>,BANDWIDTH=<EMCA_WIDTH>,VLDTY=<EMCA_VALI
D_FLAG>,WVOSNR=<>WVOSNR"<cr><lf>)+
;
Response Parameters
Parameter Description Default
Value
Command
RTRV-OD-OSNR::SEC-1:C::OD,1;
Response Message
NE61 2012-12-26 14:24:57
M C COMPLD
"SEC-1::SOURCE=OD,OAIDX=1,OATID=NEW-NE,INPORT=FAC-1-11-1,OUTPORT=FAC-1-
11-
4,TOTAL=107,NO=1,CNTRFREQ=196.056250THz,BANDWIDTH=37.500GHz,VLDTY=VALID,WVO
SNR=25.9"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.36 RTRV-ODFLEX-OSNRLOSS
Retrieves the OSNR loss of the OD FLEX section.
Function
This command retrieves the OSNR loss of the OD FLEX section.
Usage Note
None
Category
OD
Security
Retrieve
Command Syntax
RTRV-ODFLEX-OSNRLOSS:
[<TID>]:<EMCA_SECID>:<CTAG>::<EMCA_ADJUST_SOURCE>;
Command Parameters
Default
Parameter Description Value
MDS6630
ASON
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<EMCA_SECID>::SOURCE=<EMCA_ADJUST_SOURCE>,TOTAL=<EMCA_TOTAL>,NO=<EMCA_
NUM>,CNTRFREQ=<EMCA_CENTER>,BANDWIDTH=<EMCA_WIDTH>,OSNRLOSS=<OSNRLOSS>"<cr>
<lf>)+
;
Response Parameters
Parameter Description Default
Value
Example
Command
RTRV-ODFLEX-OSNRLOSS::SEC-1:C::OD;
Response Message
NE61 2012-12-26 13:52:53
M C COMPLD
"SEC-
1::SOURCE=OD,TOTAL=107,NO=1,CNTRFREQ=196.056250THz,BANDWIDTH=37.500GHz,OSNR
LOSS=27.4"
;
Related Commands
D.17.10 STA-OD-CALC
D.17.37 RTRV-OLC-ADJREC
Retrieves the OLC adjusted records.
Function
This command retrieves the OLC adjusted records.
Usage Note
NEID indicates the NE ip.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-OLC-ADJREC:[<TID>]:<FIRNEID>,<FIROA>,<ADJSTATIME>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"FIRNEID=<FIRNEID>,FIROA=<FIROA>,ADJSTATIME=<ADJSTATIME>::
[ADJTIME=<ADJTIME>],[PREVOANEID=<PREVOANEID>],[PREVOA=<PREVOA>],
[PREVOABEFATTEN=<PREVOABEFATTEN>],[PREVOAAFTATTEN=<PREVOAAFTATTEN>],
[LOCNEID=<LOCNEID>],[RAMAN=<RAMAN>],[RAMANBEFSTDGAN=<RAMANBEFSTDGAN>],
[RAMANAFTSTDGAN=<RAMANAFTSTDGAN>],[FIRVOA=<FIRVOA>],
[FIRVOABEFATTEN=<FIRVOABEFATTEN>],[FIRVOAAFTATTEN=<FIRVOAAFTATTEN>],
[FIROAINPORT=<FIROAINPORT>],[FIROAOUTPORT=<FIROAOUTPORT>],
[FIROABEFINPWR=<FIROABEFINPWR>],[FIROABEFOUTPWR=<FIROABEFOUTPWR>],
[FIROABEFSTDGAIN=<FIROABEFSTDGAIN>],[FIROAAFTINPWR=<FIROAAFTINPWR>],
[FIROAAFTOUTPWR=<FIROAAFTOUTPWR>],[FIROAAFTSTDGAIN=<FIROAAFTSTDGAIN>],
[SECVOA=<SECVOA>],[SECVOABEFATTEN=<SECVOABEFATTEN>],
[SECVOAAFTATTEN=<SECVOAAFTATTEN>],[SECOAINPORT=<SECOAINPORT>],
[SECOAOUTPORT=<SECOAOUTPORT>],[SECOABEFINPWR=<SECOABEFINPWR>],
[SECOABEFOUTPWR=<SECOABEFOUTPWR>],[SECOABEFSTDGAIN=<SECOABEFSTDGAIN>],
[SECOAAFTINPWR=<SECOAAFTINPWR>],[SECOAAFTOUTPWR=<SECOAAFTOUTPWR>],
[SECOAAFTSTDGAIN=<SECOAAFTSTDGAIN>],[BEFLINEATTEN=<BEFLINEATTEN>],
[AFTLINEATTEN=<AFTLINEATTEN>],[BEFACCDIFF=<BEFACCDIFF>],
[BEFACCDIFFSUM=<BEFACCDIFFSUM>],[AFTACCDIFF=<AFTACCDIFF>],
[AFTACCDIFFSUM=<AFTACCDIFFSUM>],[ABRTH=<ABRTH>],[RESTYPE=<RESTYPE>],
[RESULT=<ADJRESULT>]"<cr><lf>;
Response Parameters
Parameters Description
<FIROA> OA board slot ID and MON optical port on the first node.
<FIROABEFINPWR> Input optical power of the first EDFA board before commissioning.
<FIROABEFOUTPWR> Output optical power of the first EDFA board before commissioning.
<FIROAAFTINPWR> Input optical power of the first EDFA board after commissioning.
<FIROAAFTOUTPWR> Output optical power of the first EDFA board after commissioning.
<FIROAAFTSTDGAIN> Nominal gain of the first EDFA board after commissioning.
<SECOABEFINPWR> Input optical power of the second EDFA board before commissioning.
<SECOABEFOUTPWR> Output optical power of the second EDFA board before commissioning.
<SECOAAFTINPWR> Input optical power of the second EDFA board after commissioning.
<SECOAAFTOUTPWR> Output optical power of the second EDFA board after commissioning.
Example
Command
RTRV-OLC-ADJREC::129.9.9.9,FAC-1-1-1,1990-1-1-12-1-1:C;
Response Message
NE 2008-11-01 09:21:21 M C COMPLD "FIRNEID=10.10.10.10,FIROA=FAC-1-1-
1,ADJSTATIME=1991-01-01 09-01-
01ADJTIME=10,PREVOANEID=10.10.10.10,PREVOA=FAC-1-1-
1,PREVOABEFATTEN=0.1,PREVOAAFTATTEN=0.5,LOCNEID=10.10.10.10,RAMAN=FAC-1-1-
1,RAMANBEFSTDGAN=0.1,RAMANAFTSTDGAN=0.5,FIRVOA=FAC-1-1-
1,FIRVOABEFATTEN=0.1,FIRVOAAFTATTEN=0.5,FIROAINPORT=FAC-1-1-
1,FIROAOUTPORT=1,FIROABEFINPWR=-0.1,FIROABEFOUTPWR=-
0.1,FIROABEFSTDGAIN=0.1,FIROAAFTINPWR=-0.5,FIROAAFTOUTPWR=-
0.5,FIROAAFTSTDGAIN=0.5,SECVOA=FAC-1-1-
1,SECVOABEFATTEN=0.1,SECVOAAFTATTEN=0.5,SECOAINPORT=FAC-1-1-
1,SECOAOUTPORT=1,SECOABEFINPWR=-0.1,SECOABEFOUTPWR=-
0.1,SECOABEFSTDGAIN=0.1,SECOAAFTINPWR=-0.5,SECOAAFTOUTPWR=-
0.5,SECOAAFTSTDGAIN=0.5,BEFLINEATTEN=0.1,AFTLINEATTEN=0.5,BEFACCDIFF=0.1,BE
FACCDIFFSUM=0.1,AFTACCDIFF=0.5,AFTACCDIFFSUM=0.5,ABRTH=1.0,RESTYPE=10,RESUL
T=10";
Related Commands
D.15.1 ED-<ODUN>
D.17.38 ED-OD-FLEX
Edits the enable flag of CHN in the OD FLEX section.
Function
This command Edits the enable flag of CHN in the OD FLEX section.
Usage Note
None
Category
OD FLEX
Security
Provisioning
Command Syntax
ED-OD-FLEX:[<TID>]:<AID>:<CTAG>:::CNTRFREQ=<CNTRFREQ>,
[WVDETECTEN=<WVDETECTEN>,][OSNREN=<OSNREN>,];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OD-FLEX::FAC-1-5-3:C:::CNTRFREQ=192.10625THz,WVDETECTEN=Y,OSNREN=Y;
Response Message
NEW-NE 2014-06-21 01:45:31
M C COMPLD
;
Related Commands
D.17.24 RTRV-OD-CHN
D.17.39 RTRV-OD-FLEX
Retrieves the enable flag of CHN in the OD FLEX section.
Function
This command retrieves the enable flag of CHN in the OD FLEX section.
Usage Note
None
Category
OD FLEX
Security
Retrieve
Command Syntax
RTRV-OD-FLEX:[<TID>]:<RULEAID>:<CTAG>:::CNTRFREQ=<CNTRFREQ>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<RULEAID>::CNTRFREQ=<CNTRFREQ>,[WVDETECTEN=<WVDETECTEN>],
[OSNREN=<APE_ENABLE>]"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-OD-FLEX::FAC-2-2-3:C:::CNTRFREQ=192.10625THz;
Response Message
NEW-NE 2014-06-21 01:52:09
M C RTRV
"FAC-2-2-3::CNTRFREQ=192.10625THz,WVDETECTEN=Y,OSNREN=Y";
Related Commands
D.17.23 ED-OD-CHN
D.18 Configuring MCA
This section lists the commands used to configure the MCA function.
D.18.1 ED-MCACHN
Edits the channel monitor attributes of the MCA.
Function
This command edits the channel monitor attributes of the multi-channel spectrum analyzer
unit (MCA), which helps to analyze the optical wavelength, optical power, and OSNR of a
specific channel.
Usage Note
None
Category
MCA
Security
Provisioning
Command Syntax
ED-MCACHN:
[<TID>]:<AID>:<CTAG>:::BANDTYPE=<BANDTYPE>,MONFLAG=<MONFLAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-MCACHN::FAC-1-1-1-1:C:::BANDTYPE=CBAND,MONFLAG=Y;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.18.2 RTRV-MCACHN
D.18.3 RTRV-MCADATA
D.18.2 RTRV-MCACHN
Retrieves the channel monitor attributes of the MCA.
Function
This command retrieves the channel monitor attributes of the MCA, which helps to analyze
the optical wavelength, optical power, and OSNR of a specific channel.
Usage Note
None
Category
MCA
Security
Retrieve
Command Syntax
RTRV-MCACHN:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::BANDTYPE=<BANDTYPE>,MONFLAG=<MONFLAG>"<cr><lf>
;
Response Parameters
Parameters Description
AID Indicates the MCA channel access identifier. The valid format is FAC-
<SHELF ID>-<SLOT ID>-<PORT ID>-<PATH ID>.
Parameters Description
Example
Command
RTRV-MCACHN::FAC-1-8-1-1:C;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
" FAC-1-8-1-1::BANDTYPE=CBAND,MONFLAG=Y"
;
Related Commands
D.18.1 ED-MCACHN
D.18.3 RTRV-MCADATA
Retrieves results from monitoring the MCA.
Function
This command retrieves results from monitoring the MCA, such as the optical power, central
wavelength, OSNR, and number of channels.
Usage Note
None
Category
MCA
Security
Retrieve
Command Syntax
RTRV-MCADATA:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::BANDTYPE=<BANDTYPE>,WVTOTAL=<WVTOTAL>,WVNUM=<WVNUM>,WVCENTER=<WV
CENTER>,WVOFFSET=<WVOFFSET>,WVPOWER=<WVPOWER>,WVOSNR=<WVOSNR>"<cr><lf>
;
Response Parameters
Table D-3 RTRV-MCADATA output parameters
Parameters Description
AID Indicates the MCA port access identifier. The valid format is FAC-
<SHELF ID>-<SLOT ID>-<PORT ID>.
WVTOTAL Indicates the total number of wavelength channels in the current band
defined as BANDTYPE above.
WVPOWER Indicates the optical power of the wavelength in units of 1.0 dBm.
For example, -27.3 indicates that the optical power is -27.3 dBm.
Example
Command
RTRV-MCADATA::FAC-1-12-1:C;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
"FAC-1-12-
1::BANDTYPE=CBAND,WVTOTAL=0,WVNUM=1,WVCENTER=1529.16,WVOFFSET=0.00,WVPOWER=
-60.0,WVOSNR=-60.0"
Related Commands
D.18.1 ED-MCACHN
D.18.2 RTRV-MCACHN
D.18.4 ED-SLICEMAP
Edit the slice map.
Function
This command edit the slice map.
Usage Note
The maximum number of slice should be 20 for one command. If there are 96 slices, the total
number of this command should be 5.
Category
MCA
Security
Provisioning
Command Syntax
ED-SLICEMAP:[<TID>]:<AID>:<CTAG>::<PACKNUM>,<PACKSN>:[<CNTRFREQ1>,]
[<BANDWIDTH1>,]...[<CNTRFREQ20>,][<BANDWIDTH20>];
Command Parameters
Parameter Description Default Value
<BANDWIDTH1> Indicates the band width of the 1st wave, such as NULL
50.0GHz.
<CNTRFREQ2> Indicates the center frequency of the 2nd wave, such as NULL
196.0THz.
<BANDWIDTH2> Indicates the band width of the 2nd wave, such as NULL
50.0GHz.
<CNTRFREQ3> Indicates the center frequency of the 3rd wave, such as NULL
196.0THz.
<BANDWIDTH3> Indicates the band width of the 3rd wave, such as NULL
50.0GHz.
<CNTRFREQ4> Indicates the center frequency of the 4th wave, such as NULL
196.0THz.
<BANDWIDTH4> Indicates the band width of the 4th wave, such as NULL
50.0GHz.
<CNTRFREQ5> Indicates the center frequency of the 1st wave, such as NULL
196.0THz.
<BANDWIDTH5> Indicates the band width of the 1st wave, such as NULL
50.0GHz.
<CNTRFREQ6> Indicates the center frequency of the 2nd wave, such as NULL
196.0THz.
<BANDWIDTH6> Indicates the band width of the 2nd wave, such as NULL
50.0GHz.
<CNTRFREQ7> Indicates the center frequency of the 3rd wave, such as NULL
196.0THz.
<BANDWIDTH7> Indicates the band width of the 3rd wave, such as NULL
50.0GHz.
<CNTRFREQ8> Indicates the center frequency of the 4th wave, such as NULL
196.0THz.
<BANDWIDTH8> Indicates the band width of the 4th wave, such as NULL
50.0GHz.
<CNTRFREQ9> Indicates the center frequency of the 1st wave, such as NULL
196.0THz.
<BANDWIDTH9> Indicates the band width of the 1st wave, such as NULL
50.0GHz.
<CNTRFREQ10> Indicates the center frequency of the 2nd wave, such as NULL
196.0THz.
<BANDWIDTH10> Indicates the band width of the 2nd wave, such as NULL
50.0GHz.
<CNTRFREQ11> Indicates the center frequency of the 3rd wave, such as NULL
196.0THz.
<BANDWIDTH11> Indicates the band width of the 3rd wave, such as NULL
50.0GHz.
Parameter Description Default Value
<CNTRFREQ12> Indicates the center frequency of the 4th wave, such as NULL
196.0THz.
<BANDWIDTH12> Indicates the band width of the 4th wave, such as NULL
50.0GHz.
<CNTRFREQ13> Indicates the center frequency of the 1st wave, such as NULL
196.0THz.
<BANDWIDTH13> Indicates the band width of the 1st wave, such as NULL
50.0GHz.
<CNTRFREQ14> Indicates the center frequency of the 2nd wave, such as NULL
196.0THz.
<BANDWIDTH14> Indicates the band width of the 2nd wave, such as NULL
50.0GHz.
<CNTRFREQ15> Indicates the center frequency of the 3rd wave, such as NULL
196.0THz.
<BANDWIDTH15> Indicates the band width of the 3rd wave, such as NULL
50.0GHz.
<CNTRFREQ16> Indicates the center frequency of the 4th wave, such as NULL
196.0THz.
<BANDWIDTH16> Indicates the band width of the 4th wave, such as NULL
50.0GHz.
<CNTRFREQ17> Indicates the center frequency of the 1st wave, such as NULL
196.0THz.
<BANDWIDTH17> Indicates the band width of the 1st wave, such as NULL
50.0GHz.
<CNTRFREQ18> Indicates the center frequency of the 2nd wave, such as NULL
196.0THz.
<BANDWIDTH18> Indicates the band width of the 2nd wave, such as NULL
50.0GHz.
<CNTRFREQ19> Indicates the center frequency of the 3rd wave, such as NULL
196.0THz.
<BANDWIDTH19> Indicates the band width of the 3rd wave, such as NULL
50.0GHz.
<CNTRFREQ20> Indicates the center frequency of the 4th wave, such as NULL
196.0THz.
<BANDWIDTH20> Indicates the band width of the 4th wave, such as NULL
50.0GHz.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-SLICEMAP::FAC-1-12-
4:C::1,1,196.056250THz,37.500GHz,196.018750THz,37.500GHz,195.981250THz,37.5
00GHz,195.943750THz,37.500GHz;
Response Message
NE 2014-06-18 16:34:32 M 100 COMPLD ;
Related Commands
D.18.6 RTRV-SLICEMAP
D.18.5 RTRV-SLICE-ANALYDATA
D.18.5 RTRV-SLICE-ANALYDATA
Retrieves results from monitoring the MCA(flex grid).
Function
This command retrieves results from monitoring the MCA(flex grid), such as the optical
power, central wavelength, actual wavelength, and OSNR.
Usage Note
None
Category
MCA
Security
Retrieve
Command Syntax
RTRV-SLICE-ANALYDATA:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::STDCNTRFREQ=<STDCNTRFREQ>,ACTCNTRFREQ=<ACTCNTRFREQ>,FREQOFFSET=<
BANDOFFSET>,OPWR=<OPWR>,OSNR=<OSNR>"<cr><lf>
;
Response Parameters
Table D-4 RTRV-MCADATA output parameters
Parameters Description
AID Indicates the MCA port access identifier. The valid format is FAC-
<SHELF ID>-<SLOT ID>-<PORT ID>.
OPWR Indicates the optical power of the wavelength in units of 1.0 dBm.
For example, -27.3 indicates that the optical power is -27.3 dBm.
OSNR Indicates the optical power of the wavelength in units of 1.0 dBm.
For example, -27.3 indicates that the optical power is -27.3 dBm.
Example
Command
RTRV-SLICE-ANALYDATA::FAC-1-12-1:C;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
"FAC-1-12-
1::STDCNTRFREQ=192200000,ACTCNTRFREQ=192200592,FREQOFFSET=592,OPWR=-9.6"
Related Commands
D.18.4 ED-SLICEMAP
D.18.6 RTRV-SLICEMAP
D.18.6 RTRV-SLICEMAP
Retrieves the slice map.
Function
This command retrieves the slice map.
Usage Note
None.
Category
MCA
Security
Retrieve
Command Syntax
RTRV-SLICEMAP:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ("<AID>:
[CNTRFREQ=<CNTRFREQ>],[BANDWIDTH=<BANDWIDTH>];" <cr><lf>)+ ;
Response Parameters
Parameters Description
<AID> Indicates the MCA port access identifier. The valid format is FAC-
<SHELF ID>-<SLOT ID>-<PORT ID>.
Refer to MCA for the valid values of <AID> for specific units.
<CNTRFREQ> Indicates the center frequency of the source 1st wave, such as
196.0THz.
<BANDWIDTH> Indicates the band width of the source 1st wave, such as 50.0GHz.
Example
Command
RTRV-SLICEMAP::FAC-1-23-4:C;
Response Message
NE 2009-01-16 08:23:19 M C COMPLD "FAC-1-12-
1:CNTRFREQ=193.950000THz,BANDWIDTH=50.000GHz" ;
Related Commands
D.18.4 ED-SLICEMAP
D.18.5 RTRV-SLICE-ANALYDATA
D.18.7 ED-SLICEWV
Edit the slice map.
Function
This command edit the slice map.
Usage Note
NONE.
Category
EMCA
Security
Provisioning
Command Syntax
ED-SLICEWV:
[<TID>]:<RULEAID>:<CTAG>::CNTRFREQ=<OPMCNTRFREQ>,BANDWIDTH=<OPM
BANDWIDTH>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-SLICEWV::FAC-1-12-4:C::CNTRFREQ=196.056250THz,BANDWIDTH=37.500GHz;
Response Message
NE 2016-06-18 16:34:32 M 100 COMPLD ;
Related Commands
D.18.6 RTRV-SLICEMAP
D.18.5 RTRV-SLICE-ANALYDATA
D.18.8 DLT-SLICEWV
Deletethe slice map.
Function
This command deletethe slice map.
Usage Note
NONE.
Category
EMCA
Security
Provisioning
Command Syntax
DLT-SLICEWV:
[<TID>]:<RULEAID>:<CTAG>::CNTRFREQ=<OPMCNTRFREQ>,BANDWIDTH=<OPM
BANDWIDTH>;
Command Parameters
Parameter Description Default Value
Response Parameters
None
Example
Command
DLT-SLICEWV::FAC-1-12-4:C::CNTRFREQ=196.056250THz,BANDWIDTH=37.500GHz;
Response Message
NE 2016-06-18 16:34:32 M 100 COMPLD ;
Related Commands
D.18.6 RTRV-SLICEMAP
D.18.5 RTRV-SLICE-ANALYDATA
D.19.1 ED-TDC
Edits the attributes of the tunable dispersion compensator (TDC).
Function
This command edits the TDC attributes.
Usage Note
None
Category
Facility
Security
Provisioning
Command Syntax
ED-TDC:[<TID>]:<AID>:<CTAG>:::[AUTOADJ=<AUTOADJ>],
[TDCVAL=<TDCVAL>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the TDC access identifier. The valid value is provided NA
in TDC.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-TDC::FAC-1-16-1:C:::AUTOADJ=DISABLE;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.19.3 RTRV-TDC
D.19.2 OPR-TDC
D.19.2 OPR-TDC
Modifies the status of the TDC scan.
Function
This command modifies the status of the TDC scan.
Usage Note
None
Category
Facility
Security
Maintenance
Command Syntax
OPR-TDC:[<TID>]:<AID>:<CTAG>::<OPRT>;
Command Parameters
Default
Parameter Description Value
<AID> Indicates the TDC access identifier. The valid value is provided NA
in TDC.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<OPRT> Indicates the TDC scan status. The valid values are STARTSCAN NA
and STOPSCAN.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
OPR-TDC::FAC-1-1-1:C::STARTSCAN;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.19.3 RTRV-TDC
D.19.1 ED-TDC
D.19.3 RTRV-TDC
Retrieves the attributes of the TDC.
Function
This command retrieves the attributes of the TDC.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-TDC:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[TDCSTATE=<TDCSTATE>],[AUTOADJ=<AUTOADJ>],[TDCVAL=<TDCVAL>],
[TDCMAX=<TDCMAX>],[TDCMIN=<TDCMIN>],[TDCSTEP=<TDCSTEP>],
[ACTDCVAL=<ACTDCVAL>]"<cr><lf> ;
Response Parameters
Parameters Description
<TDCSTATE> Indicates the current state of dispersion adjustment. The valid values are IDLE,
SUCCESS, FAIL, and ADJUSTING.
<AUTOADJ> Indicates whether dispersion fine adjustment is enabled. The valid values are
ENABLE and DISABLE (default).
<TDCSTEP> Indicates the adjustment step adopted by the dispersion compensation modules.
It is an integer. The unit is ps/nm.
Command
RTRV-TDC::FAC-1-1-1:C;
Response Message
NE 1990-01-01 11:22:19 M C COMPLD "FAC-1-1-1::AUTOADJ=DISABLE,TDCVAL=-
1" ;
Related Commands
D.19.2 OPR-TDC
D.19.1 ED-TDC
D.20 Configuring OTDR
D.20.1 ED-OTDR
Edits an FD System.
Function
This command edits the control attributes of FD System.
Usage Note
None
Category
OTDR
Security
Provisioning
Command Syntax
ED-OTDR:[<TID>]:<AID>:<CTAG>:::[DETCTMODE=<DETCTMODE>,]
[PULSEWIDTH=<PULSEWIDTH>,][DETCTDISTANCE=<DETCTDISTANCE>,]
[DETCTTIME=<DETCTTIME>,][LATESTDATA=<LATESTDATA>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-OTDR::FAC-1-2-9-
1:c:::DETCTMODE=ManualOnline,PULSEWIDTH=100,DETCTDISTANCE=10,
DETCTTIME=60,LATESTDATA=100;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.20.3 RTRV-OTDR
D.20.5 RTRV-DETCTPARARNG-OTDR
D.20.4 RTRV-RSLT-OTDR
D.20.2 OPR-OTDR
D.20.2 OPR-OTDR
Operates an OTDR group.
Function
This command starts/stops the adjustment of an OTDR group.
Usage Note
None
Category
OTDR
Security
Provisioning
Command Syntax
OPR-OTDR:[<TID>]:<AID>:<CTAG>::<OPRTSTATE>
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Example
Command
OPR-OTDR::FAC-1-2-9-1:C::START;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.20.1 ED-OTDR
D.20.3 RTRV-OTDR
D.20.5 RTRV-DETCTPARARNG-OTDR
D.20.4 RTRV-RSLT-OTDR
D.20.3 RTRV-OTDR
Retrieves an FD System.
Function
This command retrieves the control attributes of FD System.
Usage Note
None
Category
OTDR
Security
Retrieve
Command Syntax
RTRV-OTDR:[<TID>]:[<AID>]:<CTAG>
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of an analyzer port, for example, the port of an NA
12RAU1.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>-<PATH ID>
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::[OTDRSTATE=<OTDRSTATE>][,DETCTMODE=<DETCTMODE>]
[,PULSEWIDTH=<PULSEWIDTH>][,DETCTDISTANCE=<DETCTDISTANCE>]
[,DETCTTIME=<DETCTTIME>][,LATESTDATA=<LATESTDATA>][,DURATION=<DURATION>]
[,DECFIBERLENGTH=<DECFIBERLENGTH>]
[,OTDRDELAYTIME=<OTDRDELAYTIME>]"<cr><lf>)+
Response Parameters
Parameter Description
<AID> Indicates the AID of an analyzer port, for example, the port of an 12RAU.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>-<PATH
ID>.
Parameter Description
Example
Command
RTRV-OTDR::FAC-1-15-1-1:C;
Response Message
NEO-128-160 2016-09-20 09:41:32
M C COMPLD
FAC-1-15-1-
1::OTDRSTATE=TESSUCCEED,DETCTMODE=MANUALOFFLINE,PULSEWIDTH=100,DETCTDISTANC
E=30,DETCTTIME=120,LATESTDATA=0,DURATION=0,DECFIBERLENGTH=167,OTDRDELAYTIME
=8
;
Related Commands
D.20.2 OPR-OTDR
D.20.1 ED-OTDR
D.20.5 RTRV-DETCTPARARNG-OTDR
D.20.4 RTRV-RSLT-OTDR
D.20.4 RTRV-RSLT-OTDR
Retrieves FD System data.
Function
This command retrieves the control attributes of FD System data.
Usage Note
None
Category
OTDR
Security
Retrieve
Command Syntax
RTRV-RSLT-OTDR:[<TID>]:[<AID>]:<CTAG>
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of an analyzer port, for example, the port of an NA
12RAU1.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>-<PATH ID>
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::[OTDRPKTSN=<OTDRPKTSN>][,OTDRTPKTNUM=<OTDRTPKTNUM>]
[,OTDRPKTLEN=<OTDRPKTLEN>][,OTDRRESINFO=<OTDRRESINFO>]
[,OTDRPKTINFO=<OTDRPKTINFO>]"<cr><lf>)+
Response Parameters
Parameter Description
<AID> Indicates the AID of an analyzer port, for example, the port of an 12RAU.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
Example
Command
RTRV-RSLT-OTDR::FAC-1-2-9-1:D;
Response Message
NEW-NE 2015-01-14 16:49:51
M D RTRV
"FAC-1-23-1-
1::OTDRPKTSN=1,OTDRTPKTNUM=30,OTDRPKTLEN=1024,OTDRRESINFO=65535,OTDRPKTINFO
=0x4d 61 70 00 64 00 76 00 00 00 08 00 47 65 6e 50 61 72 61 6d 73 00 64 00
33 00 00 00 53 75 70 50 61 72 61 6d 73 00 64 00 2e 00 00 00 46 78 64 50 61
72 61 6d 73 00 64 00 5c 00 00 00 4b 65 79 45 76 65 6e 74 73 00 64 00 22 00
00 00 44 61 74 61 50 74 73 00 64 00 44 75 00 00 48 55 41 57 45 49 20 20 20
00 64 00 3a 00 00 00 43 6b 73 75 6d 00 64 00 08 00 00 00 47 65 6e 50 61 72
61 6d 73 00 45 4e 43 49 44 00 46 49 44 00 8c 02 e7 05 4f 4c 00 54 4c 00 43
43 44 00 42 43 00 00 00 00 00 00 00 00 4f 50 00 43 4d 54 00 53 75 70 50 61
72 61 6d 73 00 48 55 41 57 45 49 20 20 20 00 4d 46 49 44 00 4f 54 44 52 00
4f 4d 49 44 00 4f 4d 53 4e 00 53 52 00 4f 54 00 46 78 64 50 61 72 61 6d 73
00 00 00 00 00 6b 6d 06 3b 00 00 00 00 00 00 00 00 01 00 20 03 40 4b 4c 00
10 27 00 00 3e 3d 02 00 2a 03 0d 00 00 00 00 00 00 00 00 00 dc 05 00 00 00
00 00 00 96 00 60 ea 00 00 96 00 a8 de 88 13 53 54 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 4b 65 79 45 76 65 6e 74 73 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 44 61 74 61 50 74 73 00
98 3a 00 00 01 00 98 3a 00 00 e8 03 df 07 53 05 58 03 bd 01 72 00 00 00 77
00 7e 01 fc 02 fd 04 be 07 f0 0b 64 14 28 20 27 15 6a 12 43 11 b7 10 75 10
5f 10 63 10 79 10 9a 10 c1 10 ef 10 20 11 54 11 8b 11 c2 11 fb 11 35 12 6e
12 a8 12 e2 12 1d 13 59 13 97 13 d7 13 19 14 5c 14 a0 14 e3 14 27 15 68 15
a8 15 e5 15 1d 16 53 16 86 16 b8 16 e8 16 18 17 49 17 7c 17 b0 17 e8 17 21
18 5d 18 9b 18 da 18 1c 19 61 19 a8 19 f1 19 3c 1a 86 1a d0 1a 1a 1b 60 1b
a2 1b e0 1b 1a 1c 51 1c 85 1c b6 1c e5 1c 15 1d 45 1d 75 1d a6 1d d8 1d 0c
1e 43 1e 7c 1e b7 1e f5 1e 36 1f 77 1f b9 1f fc 1f 41 20 86 20 ce 20 16 21
5e 21 a9 21 f4 21 3f 22 8b 22 d9 22 26 23 77 23 ca 23 1c 24 6f 24 c2 24 0f
25 58 25 9e 25 dd 25 18 26 4f 26 82 26 b1 26 e3 26 14 27 42 27 70 27 9f 27
ce 27 01 28 37 28 6a 28 a2 28 e2 28 23 29 69 29 b2 29 fa 29 47 2a 94 2a e1
2a 28 2b 6d 2b ac 2b e5 2b 1d 2c 50 2c 83 2c b8 2c ec 2c 1d 2d 55 2d 91 2d
c7 2d 02 2e 40 2e 79 2e b9 2e ff 2e 43 2f 85 2f d3 2f 18 30 59 30 a2 30 e6
30 20 31 59 31 84 31 a8 31 d2 31 f7 31 0d 32 2a 32 4f 32 70 32 a5 32 dc 32
0f 33 49 33 8a 33 b4 33 df 33 0f 34 36 34 5d 34 8f 34 bd 34 e9 34 2a 35 6a
35 9e 35 dc 35 15 36 44 36 85 36 c0 36 f0 36 2c 37 7e 37 c0 37 12 38 64 38
9f 38 e5 38 29 39 5a 39 76 39 9f 39 b1 39 ae 39 be 39 d0 39 eb 39 11 3a 27
3a 2c 3a 4c 3a 81 3a 8b 3a a7 3a d1 3a ec 3a 22 3b 6d 3b a7 3b e4 3b 45 3c
75 3c 9e 3c f4 3c 5c 3d b1 3d 1a 3e 41 3e 64 3e cc 3e 1c 3f 44 3f 68 3f 94
3f bb 3f 4a 40 ef 40 56 41 cf 41 34 42 55 42 bc 42 35 43 88 43 b9 43 10 44
10 44 41 44 f9 44 37 45 0a 45 16 45 1a 45 30 45 b7 45 28 46 19 46 2e 46 70
46 40 46 75 46 ce 46 f9 46 70 47 3e 48 cd 48 94 49 ae 4a fb 4a 9a 4a 64 4b
3e 4b 0d 4b f4 4b 45 4c a4 4c cf 4d de 4e 0b 4e eb 4e 99 4f 1b 4f b2 4f 5c
50 a7 50 1a 52 01 54 2a 52 4b 50 34 50 d6 4f 04 50 a5 50 67 4f 76 4f 56 52
b4 55 21 56 2c 57 f8 55 83 55 05 58 60 5b f8 59 f9 5c 8d 65 0c 65 57 7c 07
60 f2 5a 26 5b de 59 41 63 8a 7c 8a 63 47 69 0c 60 10 5b 8c 56 51 55 84 59
51 5d 42 5a f2 5b e8 5e 4d 5b 60 5f 85 68 54 64 52 62 4c 63 c0 5c 45 5c d9"
>
Related Commands
D.20.2 OPR-OTDR
D.20.1 ED-OTDR
D.20.5 RTRV-DETCTPARARNG-OTDR
D.20.3 RTRV-OTDR
D.20.5 RTRV-DETCTPARARNG-OTDR
Retrieves detect para range.
Function
This command retrieves the control attributes of FD System.
Usage Note
None
Category
OTDR
Security
Retrieve
Command Syntax
RTRV-DETCTPARARNG-OTDR:[<TID>]:[<AID>]:<CTAG>:::
[OTDRRNGMODE=<OTDRRNGMODE>],[PULSEWIDTH=<PULSEWIDTH>]
Command Parameters
Default
Parameter Description Value
<AID> Indicates the AID of an analyzer port, for example, the port of NA
an 12RAU1.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT
ID>-<PATH ID>
<OTDRRNGMODE> The mode of OTDR detection. NA
<PULSEWIDTH> The dispersion pulsewitch value. The value range is NA
determined by the corresponding dispersion compensation
module.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::[OTDRRNGMODE=<OTDRRNGMODE>][,PULSEWIDTH=<PULSEWIDTH>]
[,MAXDETCTDISTANCE=<MAXDETCTDISTANCE>]
[,DFLTDETCTDISTANCE=<DFLTDETCTDISTANCE>]
[,MINDETCTDISTANCE=<MINDETCTDISTANCE>][,MAXDETCTTIME=<MAXDETCTTIME>]
[,DFLTDETCTTIME=<DFLTDETCTTIME>][,MINDETCTTIME=<MINDETCTTIME>]"<cr><lf>)+
Response Parameters
Parameter Description
<AID> Indicates the AID of an analyzer port, for example, the port of an
12RAU.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>-
<PATH ID>.
<OTDRRNGMODE> Indicates the mode of OTDR detection.
<PULSEWIDTH> Indicates the dispersion pulsewitch value.
Command
RTRV-DETCTPARARNG-OTDR::FAC-1-2-9-
1:D:::OTDRRNGMODE=ManualOnline,PULSEWIDTH=0;
Response Message
NEW-NE 1990-02-01 08:19:21
M C RTRV
"FAC-1-2-9-
1::OTDRRNGMODE=ManualOnline,PULSEWIDTH=20000,MAXDETCTDISTANCE=80,DFLTDETCTD
ISTANCE=80,MINDETCTDISTANCE=40,MAXDETCTTIME=260,DFLTDETCTTIME=60,MINDETCTTI
ME=40"
"FAC-1-2-9-
1::OTDRRNGMODE=ManualOnline,PULSEWIDTH=10000,MAXDETCTDISTANCE=60,DFLTDETCTD
ISTANCE=60,MINDETCTDISTANCE=30,MAXDETCTTIME=260,DFLTDETCTTIME=60,MINDETCTTI
ME=40"
"FAC-1-2-9-
1::OTDRRNGMODE=ManualOnline,PULSEWIDTH=4000,MAXDETCTDISTANCE=40,DFLTDETCTDI
STANCE=40,MINDETCTDISTANCE=20,MAXDETCTTIME=260,DFLTDETCTTIME=60,MINDETCTTIM
E=40"
"FAC-1-2-9-
1::OTDRRNGMODE=ManualOnline,PULSEWIDTH=800,MAXDETCTDISTANCE=35,DFLTDETCTDIS
TANCE=35,MINDETCTDISTANCE=15,MAXDETCTTIME=260,DFLTDETCTTIME=60,MINDETCTTIME
=40"
"FAC-1-2-9-
1::OTDRRNGMODE=ManualOnline,PULSEWIDTH=200,MAXDETCTDISTANCE=25,DFLTDETCTDIS
TANCE=15,MINDETCTDISTANCE=5,MAXDETCTTIME=260,DFLTDETCTTIME=60,MINDETCTTIME=
40"
"FAC-1-2-9-
1::OTDRRNGMODE=ManualOnline,PULSEWIDTH=100,MAXDETCTDISTANCE=15,DFLTDETCTDIS
TANCE=10,MINDETCTDISTANCE=5,MAXDETCTTIME=260,DFLTDETCTTIME=60,MINDETCTTIME=
40"
;
Related Commands
D.20.4 RTRV-RSLT-OTDR
D.20.2 OPR-OTDR
D.20.1 ED-OTDR
D.20.3 RTRV-OTDR
D.21 Configuting PIDADJ
D.21.1 ED-ATTR-PIDADJ
Edits the attributes of PID adjusting.
Function
This command edits the attributes of PID adjusting.
Usage Note
None
Category
PIDADJ
Security
Provisioning
Command Syntax
ED-ATTR-PIDADJ:[<TID>]:<PIDADJ-BID-PORT>:<CTAG>:::[PIDADJ=<PIDADJ>];
Command Parameters
Parameter Description Default Value
<PIDADJ> Enable or disable PID adjusting. The valid values are: ENABLE
ENABLE
DISABLE
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
ED-ATTR-PIDADJ::FAC-2-1-1:C:::PIDADJ=DISABLE;
Response Message
NEW-NE 2014-06-21 00:55:16
M C COMPLD
;
Related Commands
D.17.27 RTRV-ATTR-OLC
D.21.2 RTRV-ATTR-PIDADJ
Retrieves the attributes of PID adjusting.
Function
This command retrieves the attributes of PID adjusting.
Usage Note
None
Category
PIDADJ
Security
Retrieve
Command Syntax
RTRV-ATTR-PIDADJ:[<TID>]:<PIDADJ-BID-PORT>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<PIDADJ-BID-PORT>::[PIDADJ=<PIDADJ>]"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
<PIDADJ> Enable or disable PID adjusting. The valid values are: ENABLE
ENABLE
DISABLE
Example
Command
RTRV-ATTR-PIDADJ::FAC-2-1-1:C;
RTRV-ATTR-PIDADJ:::C;
Response Message
NEW-NE 2014-06-23 18:50:08
M C COMPLD
"FAC-2-1-1::PIDADJ=DISABLE"
;
Related Commands
D.17.26 ED-ATTR-OLC
D.21.3 RTRV-STATE-PIDADJ
Retrieves the PIDADJ current state of PIDADJ.
Function
This command retrieves the PIDADJ current state of PIDADJ.
Usage Note
None
Category
PIDADJ
Security
Retrieve
Command Syntax
RTRV-STATE-PIDADJ:[<TID>]:<PIDADJ-BID-PORT>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<PIDADJ-BID-PORT>::[ADJSTATE=<ADJSTATE>,]"<cr><lf>)+
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-STATE-PIDADJ::FAC-2-1-1:C;
Response Message
RTRV-STATE-PIDADJ::FAC-2-1-1:C
Related Commands
D.17.26 ED-ATTR-OLC
D.22 System Monitor
This section lists the commands used to monitor a system.
D.22.1 ED-DST-V2
Sets DST for the new DST standard.
Function
This command sets DST for the new DST starndard.
Usage Note
None
Category
MON
Security
Super
Command Syntax
ED-DST-V2:
[<TID>]::<CTAG>::<FLAG>,<BEGINADJMODE>,<ENDADJMODE>,<ADJMINUTE>,<
STARTMONTH>,<STARTDAY>,<STARTHOUR>,<STARTMINUTE>,<STARTWEEK>,<
STARTWEEKDAY>,<ENDMONTH>,<ENDDAY>,<ENDHOUR>,<ENDMINUTE>,<END
WEEK>,<ENDWEEKDAY>;
Command Parameters
Parameter Description Default Value
abbreviation
(jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec).
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-DST-
V2:::1::enable,DATE,WEEK_FORWORD,60,apr,1,13,0,1,fri,oct,3,14,0,2,mon;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.2.4 RTRV-DST
D.22.2 RTRV-DST-V2
Retrieves DST information setted by ED-DST-V2.
Function
This command retrieves DST information setted by ED-DST-V2.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-DST-V2:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-
dd>^<"FLAG=<FLAG>,BEGINADJMODE=<BEGINADJMODE>,ENDADJMODE=<ENDADJMODE>,ADJ_M
INUTE=<ADJMINUTE>,START_MONTH=<STARTMONTH>,START_DAY=<STARTDAY>,START_HOUR=
<STARTHOUR>,START_MINUTE=<STARTMINUTE>,START_WEEK=<STARTWEEK>,START_WEEKDAY
=<STARTWEEKDAY>,END_MONTH=<ENDMONTH>,END_DAY=<ENDDAY>,END_HOUR=<ENDHOUR>,EN
D_MINUTE=<ENDMINUTE>,END_WEEK=<ENDWEEK>,END_WEEKDAY=<ENDWEEKDAY>,DST_STATUS
=<DSTSTATUS>"> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-DST-V2:::1;
Response Message
DESMOINESPH-6800A-2 2012-05-15 22:23:14
M 1 COMPLD
"FLAG=ENABLE,BEGINADJMODE=DATE,ENDADJMODE=WEEK_FORWARD,ADJ_MINUTE=120,START
_MONTH=JAN,START_DAY=1,START_HOUR=0,START_MINUTE=0,START_WEEK=1,START_WEEKD
AY=SUN,END_MONTH=SEP,END_DAY=4,END_HOUR=14,END_MINUTE=0,END_WEEK=1,END_WEEK
DAY=SAT,DST_STATUS=TRUE"
;
Related Commands
D.2.4 RTRV-DST
D.22.3 RTRV-CHECK-PERIOD
Get the mon internal period of the CPU and VFS check.
Function
Get the mon internal period of the CPU and VFS check.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-CHECK-PERIOD:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"CPUCHECKPERIOD=<cpuperiod>,VFSCHECKPERIOD=<vfsperiod>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-CHECK-PERIOD::SLOT-1-8:100;
Response Message
NE 2000-01-03 15:08:11
M 100 COMPLD
"CPUCHECKPERIOD=60,VFSCHECKPERIOD=3600"
;
Related Commands
None
D.22.4 RTRV-CPU-PEAKINFO
Query CPU occupancy peak value and current value
Function
Query CPU occupancy peak value and current value
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-CPU-PEAKINFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Parameters
Parameter Description
Example
Command
RTRV-CPU-PEAKINFO::SLOT-1-8:100;
Response Message
NE 2011-12-19 15:43:38
M 100 RTRV
"TASKNAME=BOX,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=_TIL,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=_EXC,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=VIDL,TASK_CUR=74,TASK_PEAK=74"
"TASKNAME=TICK,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tFtpServer,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=ECCPING,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tVos100ms,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tVos1s,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tVfsWorker,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tVfsSender,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tVfsSchemer,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tRackId,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tSrlmSend,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tBDMLow1S,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tDmmCCardSend,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tDmmCardRecv,TASK_CUR=0,TASK_PEAK=0"
"TASKNAME=tDmmCtrlTimer,TASK_CUR=0,TASK_PEAK=0"
>
>
Related Commands
None
D.22.5 RTRV-CPUUSAGE
Query the CPU information of all tasks
Function
Query the CPU information of all tasks
Usage Note
None
Category
MON
Security
Super
Command Syntax
RTRV-CPUUSAGE:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"TASKNAME=<TASKNAME>,SWITCHCNT=<SWITCHCNT>,MINTIME=<MINTIME>,MAXTIME=<MA
XTIME>,RECENTTIME=<RECENTTIME>,SECTIME=<SECTIME>,MSECTIME=<MSECTIME>,CPUUSA
GE=<CPUUSAGE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-CPUUSAGE::SLOT-1-18:100;
Response Message
NE 2000-01-03 14:37:02
M 100 RTRV
"TASKNAME=BOX,SWITCHCNT=1906346,MINTIME=2,MAXTIME=7750,RECENTTIME=11,SECTIM
E=0,MSECTIME=41711889,CPUUSAGE= 0.00%"
"TASKNAME=_TIL,SWITCHCNT=0,MINTIME=0,MAXTIME=0,RECENTTIME=0,SECTIME=0,MSECT
IME=0,CPUUSAGE= 0.00%"
"TASKNAME=_EXC,SWITCHCNT=0,MINTIME=0,MAXTIME=0,RECENTTIME=0,SECTIME=0,MSECT
IME=0,CPUUSAGE= 0.00%"
;
Related Commands
None
D.22.6 RTRV-LIST
This command displays the task or semaphore or timer or message queue information based
on the key.
Function
Displays the task or semaphore or timer or message queue information based on the key.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-LIST:[<TID>]:<MON_BOARD_ID>:<CTAG>::<resourcetype>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MonListInfo>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-LIST::SLOT-1-18:100::sem;
Response Message
WEBSTERCITY-6800A-1 2012-06-06 16:52:57
M 100 RTRV
" ******************************************************"
" Max Semaphore = 2000"
" Total binary Semaphore = 67"
" Total count Semaphore = 20"
" Total mutex Semaphore = 288"
" ------------------------------------------------------"
" Sema4Name Sema4ID OSSemID Count Mode Type"
" ------------------------------------------------------"
" cbr 1 113338224 1 FIFO Binary"
" cbn 2 113338352 1 FIFO Binary"
" sSTLPool 3 115140536 1 FIFO Binary"
" sVos100ms 4 115140720 1 FIFO Mutex "
" sVos1s 5 115140848 1 FIFO Mutex "
" sVFSFileStub 6 115142112 1 FIFO Mutex "
>
>
Related Commands
None
D.22.7 RTRV-SCCID
This command obtains the SCC board id.
Function
Obtains the SCC board id.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-SCCID:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SccID=<SCCID>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SCCID:::100;
Response Message
WEBSTERCITY-6800A-1 2012-06-06 15:20:26
M 100 COMPLD
"SCCID=18"
;
>
Related Commands
None
D.22.8 RTRV-MEMPEAK-INFO
Get memory peak usage info
Function
Get memory peak usage info.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-MEMPEAK-INFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Parameters
Parameter Description
Example
Command
RTRV-MEMPEAK-INFO::SLOT-1-18:100;
Response Message
DESMOINESPH-6800A-2 2012-05-15 22:36:27
M 100 COMPLD
"PTNUMBER=PT1,PEAK=17284348,CURRENT=17283896"
"PTNUMBER=PT2,PEAK=99299188,CURRENT=95935292"
;
Related Commands
None
D.22.9 RTRV-MEMUSAGE-INFO
Get memory usage info
Function
Get memory usage info.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-MEMUSAGE-INFO:
[<TID>]:<MON_BOARD_ID>:<CTAG>::<MON_MODULE_ID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"PARTITIONID=<PRT_ID>,ALLOCSIZE=<ALLOC_SIZE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-MEMUSAGE-INFO::SLOT-1-8:100::9;
Response Message
NE 2000-01-03 15:35:52
M 100 COMPLD
"PARTITIONID=0,ALLOCSIZE=0"
"PARTITIONID=1,ALLOCSIZE=21139307"
;
Related Commands
None
D.22.10 RTRV-MEMUTIL-INFO
Get memory utilization of the system.
Function
Get memory utilization of the system in all the memory partitions.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-MEMUTIL-INFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"PARTID=<PART_ID>,TOTALSIZE=<TOTAL_SIZE>,USEDSIZE=<USED_SIZE>,FREESIZE=<
FREE_SIZE>,USERATIO=<USE_RATIO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-MEMUTIL-INFO::SLOT-1-8:100;
Response Message
NE 2000-01-03 15:27:35
M 100 COMPLD
"PARTID=0,TOTALSIZE=58717476,USEDSIZE=14014388,FREESIZE=44703088,USERATIO=2
3"
"PARTID=1,TOTALSIZE=278804488,USEDSIZE=103849020,FREESIZE=174955468,USERATI
O=37"
;
Related Commands
None
D.22.11 RTRV-MODULE-DUMPINFO
Query dump information of a module.
Function
Query dump information of a module.
Usage Note
None
Category
MON
Security
Super
Command Syntax
RTRV-MODULE-DUMPINFO:
[<TID>]:<MON_BOARD_ID>:<CTAG>::<MM_CLASSID>,<MM_FUNCID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"INFO=<MODULE_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-MODULE-DUMPINFO::slot-1-8:100::"HSC.IHSC.CHSCModule","00018";
Response Message
NE118 2000-01-03 15:15:55
M 100 COMPLD
"INFO=CHSCModule"
"INFO= m_dwHscTimerID = 0x8d4cebc"
"INFO= m_wTwoLogicBoardIDSum = 35"
"INFO= m_wTwoPhyBoardIDSum = 35"
"INFO= m_dwManualCmdFlag = 40321"
"INFO= m_dwCount = 0"
"INFO= m_dwHandleMaker = 3"
"INFO= g_dwHscPrint = 0"
;
Related Commands
None
D.22.12 RTRV-MODULE-LISTINFO
Query module information of the given module
Function
Query module information of the given module
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-MODULE-LISTINFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"CLASS_ID=<MM_CLASSID>,FUNC_ID=<MM_FUNCID>,PTR_ADDR=<MM_PTRADDR>"<cr><lf
>
;
Response Parameters
Parameter Description
<MM_CLASSID> The string of the class ID. It is a string with a maximum of 1400
bytes.
Example
Command
RTRV-MODULE-LISTINFO::SLOT-1-8:100;
Response Message
NE 2000-01-03 15:21:38
M 100 RTRV
"CLASS_ID=DMM.IDMM.CDMM,FUNC_ID=DMM,PTR_ADDR=205613964"
"CLASS_ID=CRM.ICRM.CCRM,FUNC_ID=CRM,PTR_ADDR=205850008"
"CLASS_ID=BDM.IBDManager.CBDMManager,FUNC_ID=BDM,PTR_ADDR=205864132"
"CLASS_ID=Sm.ISmReg.CSmReg,FUNC_ID=00018,PTR_ADDR=205603528"
"CLASS_ID=MMI.IMMI.CMmiModule,FUNC_ID=00018,PTR_ADDR=205939548"
"CLASS_ID=HSC.IHSC.CHSCModule,FUNC_ID=00018,PTR_ADDR=205948916"
"CLASS_ID=HBU.IHBU.CHBUModule,FUNC_ID=00018,PTR_ADDR=205961136"
"CLASS_ID=PE.IPeManager.CPeManager,FUNC_ID=00018,PTR_ADDR=205988444"
;
Related Commands
None
D.22.13 RTRV-QUELENALM-STATE
Get Queue length alarm flag
Function
Get Queue length alarm flag
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-QUELENALM-STATE:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<State>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-QUELENALM-STATE::SLOT-1-8:100;
Response Message
NEW-NE 1990-01-01 14:46:42
M 100 COMPLD
"STATUS=DISABLE"
;
>
Related Commands
None
D.22.14 RTRV-REBOOT-LOG
Get the reboot records of board
Function
Get the reboot records of board
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-REBOOT-LOG:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MonMemDmgInfo>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-REBOOT-LOG::SLOT-1-8:100;
Response Message
NE 2000-01-03 15:40:28
M 100 RTRV
"
****************************************************************
System startup time : 2005.07.27 11:02:05.000
System startup cputick : 0x00000000 e39940e8
System reboot at file : Unknow, Line: 0
System reboot by task : tShell0, VID: -1, OsalID: 0x63fa430
System reboot type : 1, Reset by calling reboot(0)
System reboot CPUID : -2
System reboot time : 2000.01.03 11:47:06.040
System reboot cputick : 0x00000181 ad4500f4
System reboot callstack:
<-- 0x018a86e0(CSTK_GetCallStackEx) <-- 0x018fa6d0(RBT_RebootSaveInfo)
<-- 0x018fb128(RBT_RebootVxHook) <-- 0x01ab34a0(reboot)
<-- 0x01ad62a8(shellInternalFunctionCall) <-- 0x01ada978(shellInterpCInit)
<-- 0x01adaa5c(shellInterpCInit) <-- 0x01adad58(shellInterpCInit)
<-- 0x01ade894(shellInterpCparse) "
>
>
NE 2000-01-03 15:40:28
M 100 COMPLD
"<-- 0x01adedb8(shellInterpCparse)
<-- 0x01ae3888(shellExec) <-- 0x01ae3e44(shellTask)
<-- 0x01a0bde4(vxTaskEntry)
****************************************************************
"
Related Commands
None
D.22.15 RTRV-RESERVEMEM
Query configuration information of general reserved memory
Function
Query configuration information of general reserved memory
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-RESERVEMEM:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"BLOCK_NUM=<RESVMEM_BLKNUM>,BLOCK_NAME=<RESVMEM_BLKNAME>,BLOCK_SIZE=<RES
VMEM_BLKSIZE>"<cr><lf>
^^^"POSITION=<RESVMEM_BLKPOS>,ISCONFIG=<RESVMEM_CFGFLAG>,ISALLOC=<RESVMEM_A
LLOCFLAG>"<cr><lf>
^^^"FILE=<RESVMEM_FILE>",LINE=<RESVMEM_LINE><cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-RESERVEMEM::SLOT-1-8:100;
Response Message
NE 2000-01-03 14:43:43
M 100 COMPLD
"BLOCK_NUM=0,BLOCK_NAME=MDBG,BLOCK_SIZE=102400,POSITION=534776376,ISCONFIG=
0,ISALLOC=1,FILE=vos_callstack.cpp,LINE=1157"
"BLOCK_NUM=1,BLOCK_NAME=NUSE,BLOCK_SIZE=102400,POSITION=534878776,ISCONFIG=
0,ISALLOC=1,FILE=vos_callstack.cpp,LINE=1201"
"BLOCK_NUM=2,BLOCK_NAME=C_PK,BLOCK_SIZE=14408,POSITION=534981176,ISCONFIG=0
,ISALLOC=1,FILE=mon_thr.cpp,LINE=1181"
"BLOCK_NUM=3,BLOCK_NAME=F_PK,BLOCK_SIZE=12,POSITION=534995584,ISCONFIG=0,IS
ALLOC=1,FILE=mon_thr.cpp,LINE=1225"
;
Related Commands
None
D.22.16 RTRV-SWTTHRINFO
Retrieves status of memory usage threshold check, VFS usage threshold check cpu usage
threshold check and message over check.
Function
Retrieves status of memory usage threshold check, VFS usage threshold check cpu usage
threshold check and message over check.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-SWTTHRINFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"name=<MSGTH_FIELD>,value=<MSGTH_VALUE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWTTHRINFO::SLOT-1-8:100;
Response Message
NE 2000-01-03 14:57:46
M 100 COMPLD
"NAME=MsgOverThrVal,VALUE=85"
"NAME=MsgOverThrSwt,VALUE=disable"
"NAME=MemOverThrVal,VALUE=85"
"NAME=MemOverThrSwt,VALUE=disable"
"NAME=VFSOverThrVal,VALUE=85"
"NAME=VFSOverThrSwt,VALUE=disable"
"NAME=CPUOverThrVal,VALUE=85"
"NAME=CPUOverThrSwt,VALUE=disable"
;
Related Commands
None
D.22.17 RTRV-SYMADDR
Retrieves the current function's call stack of the specified task
Function
Retrieves the current function's call stack of the specified task
Usage Note
None
Category
MON
Security
Super
Command Syntax
RTRV-SYMADDR:
[<TID>]:<MON_BOARD_ID>:<CTAG>::<MON_FILE_NAME_SIXTY>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SYMBOL_NAME=<MON_FILE_NAME_SIXTY>,SYMBOL_ADDRESS=<MON_SYMBOL_ADDR>"<cr>
<lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SYMADDR::SLOT-1-18:100::\"VOS_Entry\";
Response Message
NE 2000-01-03 14:16:14
M 100 COMPLD
"SYMBOL_NAME=VOS_Entry,SYMBOL_ADDRESS=19913448"
;
Related Commands
None
D.22.18 RTRV-TASKSTACK
Retrieves the symbol address of the symbol name given
Function
Retrieves the symbol address of the symbol name given
Usage Note
None
Category
MON
Security
Super
Command Syntax
RTRV-TASKSTACK:[<TID>]:<MON_BOARD_ID>:<CTAG>::<TaskName>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"StackDepth=<StackDepth>,FuncAddr=<FuncAddr>,FuncName=<FuncName>"<cr><lf
>
;
Response Parameters
Parameter Description
Command
RTRV-TASKSTACK::SLOT-1-8:100::\"tTL1CmdRsp\";
Response Message
NE 2000-01-03 14:04:46
M 100 COMPLD
"STACKDEPTH=0,FUNCADDR=26093876,FUNCNAME=OSAL_TaskDelay"
"STACKDEPTH=1,FUNCADDR=25975788,FUNCNAME=VOS_TaskDelay"
;
Related Commands
None
D.22.19 RTRV-TASKONMSGQUE
Retrives the list of tasks on a message queue.
Function
This command retrives the list of tasks on a message queue.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-TASKONMSGQUE:
[<TID>]:<MON_BOARD_ID>:<CTAG>::<MON_MSGQUE_NAME_FTN>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MonTaskInfo>"
;
Response Parameters
Parameter Description
Example
Command
RTRV-TASKONMSGQUE::SLOT-1-18:100::"qTL1Auto";
Response Message
DESMOINESPH-6800A-2 2012-05-15 22:52:38
M 100 RTRV
" *******************************************************"
" Queue ID = 31"
" Queue Name = qTL1Auto "
" Queue Mode = FIFO SYN"
" Total Length = 4096"
" Current Length = 0"
" Used Percent = 0%"
" Peak Length = 103"
" Peak Time = 2012.05.14 15:40:18"
" Max Msg Size = 16"
" Queue Msg Start Addr = 0x903cf80"
" Queue Msg Head Index = 200"
" Queue Msg Tail Index = 200"
" Total Write Count = 37064"
" Total Read Count = 57394"
" Total Overload Alarm Count = 0"
" Queue Overload Flag = 0"
" Total OverLoad Recover Count = 0"
>
Related Commands
None
D.22.20 RTRV-TASKONSEM
Retrives the list of tasks on a semaphore.
Function
This command retrives the list of tasks on a semaphore.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-TASKONSEM:[<TID>]:<MON_BOARD_ID>:<CTAG>::<MON_SEM_NAME>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MonTaskInfo>"
;
Response Parameters
Parameter Description
Command
RTRV-TASKONSEM::SLOT-1-18:100::"CSMMsgMId";
Response Message
DESMOINESPH-6800A-2 2012-05-15 23:02:50
M 100 RTRV
" ******************************************************"
" Semaphore Name = CSMMsgMId"
" Semaphore ID = 38"
" Semaphore Count = 1"
" Semaphore Mode = FIFO"
" Semaphore Type = Mutex "
" Create Task ID = 6"
" Last P Task ID = 124"
" Last V Task ID = 124"
" P Block Task ID = 0"
" Total Syn P Number = 9"
" Total Asy P Number = 0"
" Total V Number = 9"
" Syn P Timeout Number = 0"
" Syn P Fail Number = 0"
" Asy P Fail Number = 0"
" V Fail Number = 0"
" Mutex Recur Lock Number = 0"
" Mutex Owner OSAL Task ID = 0xffffffff"
" Mutex Owner Task ID = 0xffffffff"
>
>
Related Commands
None
D.22.21 RTRV-VFS-PEAKINFO
Query the available peak value of file system and current value
Function
Query the available peak value of file system and current value
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-VFS-PEAKINFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"VFS_REGION=<VFS_REGION>,VFSTH_CURVAL=<VFSTH_CURVAL>,VFSTH_PEAKVAL=<VFST
H_PEAKVAL>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-VFS-PEAKINFO::SLOT-1-8:100;
Response Message
NE 2000-01-03 14:37:02
M 100 COMPLD
"VFS_REGION=mfs,VFSTH_CURVAL=2107392,VFSTH_PEAKVAL=2107392"
"VFS_REGION=ofs1,VFSTH_CURVAL=23363584,VFSTH_PEAKVAL=23363584"
"VFS_REGION=ofs2,VFSTH_CURVAL=4177920,VFSTH_PEAKVAL=4177920"
;
Related Commands
None
D.22.22 RTRV-BDINFO-EQPT
Retrieves ELabel.
Function
This command retrieves the hardware and software information about the equipment.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-BDINFO-EQPT:[<TID>]:<SFTM_SLOT>:<CTAG>;
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
^^^"<contents>" <cr> <lf>
;
Response Parameters
None
Example
Command
RTRV-BDINFO-EQPT::SLOT-1-7:100
Response Message
NE 1990-02-18 21:57:41
M 100 COMPLD
"\"/$[ArchivesInfo Version]
/$ArchivesInfoVersion=2.0
/$[Log]
/$Log1=26817,030376730,2006-02-23
[Board Properties]
BoardType=SSC6SCC01
BarCode=0376731062000342
BOM=BOM0303767301
\""
"\"/$Item=03037673
/cDescription=
/eDescription=OptiX Metro 6100,SSC6SCC01,System Control&Communication Board
/$PCBVersion=
Manufactured=2006-02-23
ManufactureCode=1
/$CLEICode=
\""
"\"
/$[Daughter Board Properties]
/$Daughter_BoardNum=0
/$[Software]
/$SoftwareNum=0
\""
;
Related Commands
None
D.22.23 SET-CPUTESTSTA
Sets the switch flag to monitor the running status of all tasks.
Function
This command sets the switch flag to monitor the running status of all tasks.
Usage Note
None
Category
MON
Security
Super
Command Syntax
SET-CPUTESTSTA:[<TID>]:<MON_BOARD_ID>:<CTAG>::<CPUSTA>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-CPUTESTSTA::SLOT-1-18:100::ENABLE;
Response Message
NE 2005-08-02 17:52:45
M 100 COMPLD
;
Related Commands
D.36.3 RTRV-DBMS-AUTOBACKUP
D.22.24 WRT-BB
This command backs up the black box to flash.
Function
Backs up the black box to flash.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
WRT-BB:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
WRT-BB::SLOT-1-18:100
Response Message
WEBSTERCITY-6800A-1 2012-06-06 15:29:56
M 100 COMPLD
;
>
Related Commands
D.36.3 RTRV-DBMS-AUTOBACKUP
D.22.25 RTRV-CHECKSTACK
Get the information of the task stack
Function
Get the information of the task stack.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-CHECKSTACK:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MON_CHECK_STACK>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-CHECKSTACK::SLOT-1-18:100;
Response Message
NE169-21 1990-01-06 12:04:49
M 100 RTRV
" NAME ENTRY TID SIZE CUR HIGH MARGIN
------------ ------------ -------- ----- ----- ----- ------
"
"tJobTask 0x2db1758 0x58ce608 8000 312 1016 6984
(Exception Stack) 3792 0 208 3584
"
Related Commands
None
D.22.26 RTRV-IOSFDSHOW
Get the information of the I/O file driver
Function
Get the information of the I/O file driver.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-IOSFDSHOW:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MON_FDINFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-IOSFDSHOW::SLOT-1-18:100;
Response Message
NE169-21 1990-01-06 11:36:53
M 100 COMPLD
" fd name drv"
" 3 /tyCo/1 1 "
" 4 /aioPipe/0x8bffd30 2 "
Related Commands
None
D.22.27 RTRV-SEMINFO
Get the information of the semaphore
Function
Get the information of the semaphore.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-SEMINFO:[<TID>]:<MON_BOARD_ID>:<CTAG>::<MON_OBJID_VXSEM_ID>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<Mon_SEM_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SEMINFO::SLOT-1-18:100::148139104;
Response Message
NE169-21 1990-01-06 11:54:40
M 100 COMPLD
"Semaphore Id : 0x70725c8
Semaphore Type : BINARY
Task Queuing : FIFO
Pended Tasks : 0
"
"State : EMPTY "
"Options : 0x0 SEM_Q_FIFO
"
;
Related Commands
None
D.22.28 RTRV-SYSMEMINFO
Get the information of the system memory
Function
Get the information of the system memory.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-SYSMEMINFO:
[<TID>]:<MON_BOARD_ID>:<CTAG>::<MON_OBJID_SHOW_TYPE>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<Mon_MEM_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SYSMEMINFO::SLOT-1-18:100::0;
Response Message
NE169-21 1990-01-06 11:43:36
M 100 COMPLD
"
status bytes blocks avg block max block
-------- -------------- ---------- ---------- ----------
current
free 20830976 21166 984 19883456
alloc 34103408 25883 1317 -
internal 616 3 205 -
cumulative
alloc 2607674232 2089737 1247 -
peak
alloc 34405496 - - -
"
;
Related Commands
None
D.22.29 RTRV-MEM-BYPID
Querying the memory using information of the ne by pid.
Function
This command obtains the memory using information of the ne by pid. This command can be
executed on any board of NE.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-MEM-BYPID:[<TID>]:<MON_BOARD_ID>:<CTAG>::[<ModuleId>];
Command Parameters
Parameter Description
<ModuleId> module id
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS>
<cr><lf> M^^<CTAG>^COMPLD
<cr><lf>
^^^PART_ID=<PART_ID>,MODULEID=<MODULEID>,FileName=<FileName>,LineNum=<LineN
um>,ALLOC_SIZE=<ALLOC_SIZE>,BufCount=<BufCount>,TotalSize=<TotalSize><cr><l
f>
;
Response Parameters
Parameter Description
Example
Command
RTRV-MEM-BYPID::SLOT-70:100::1;
Response Message
NE 2012-03-25 17:46:15 M 100 COMPLD
"PART_ID=1,MODULEID=1,FILENAME=ipos/software/util/db/source/rm_dbpb1.c,LINE
NUM=193,ALLOC_SIZE=128,BUFCOUNT=1,TOTALSIZE=128"
;
D.22.30 RTRV-MEMUSE-TOPN
Querying the memory using information of the ne by pid.
Function
This command obtains the memory using information of the ne by pid. This command can be
executed on any board of NE.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-MEMUSE-TOPN:[<TID>]:<MON_SLOT_SOR>:<CTAG>::[<TOPN>];
Command Parameters
Parameter Description
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS>
<cr><lf> M^^<CTAG>^COMPLD
<cr><lf>
^^^MODULEID=<MODULEID>,ALLOC_SIZE=<ALLOC_SIZE><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-MEMUSE-TOPN::SLOT-1-17:101::1;
Response Message
NE 2012-03-25 17:46:15 M 100 COMPLD
"MODULEID=0,ALLOC_SIZE=26483628"
;
D.22.31 RTRV-QUEUEINFO
Querying the information of the queue.
Function
This command obtains the information of one queue. This command can be executed on any
board of NE.
Usage Note
None
Category
MON
Security
Debug
Command Syntax
RTRV-QUEUEINFO :[< TID>]:< MON_SLOT_SOR>:< CTAG>::[< QUEUEID>],[< DISP
LAYNUM>];
Command Parameters
Parameter Description
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS>
<cr><lf> M^^<CTAG>^COMPLD
<cr><lf>
^^^MON_QUEUE_ID=<MON_QUEUE_ID>,QueueName=<QueueName>,QueueIdx=<QueueIdx>,Qu
eueAdw0=<QueueAdw0>,QueueAdw1=<QueueAdw1>
,QueueAdw2=<QueueAdw2>,QueueAdw3=<QueueAdw3>,Queue_SrcBid=<Queue_SrcBid>,Qu
eue_SrcMod=<Queue_SrcMod>,Queue_SrcEnt=<Queue_SrcEnt>,Queue_DstBid=<Queue_D
stBid>,Queue_DstMod=<Queue_DstMod>,Queue_DstEnt=<Queue_DstEnt><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-QUEUEINFO::SLOT-1-18:100::273,0;
Response Message
NE 2012-03-25 17:46:15 M 100 COMPLD
"MON_QUEUE_ID=273,QUEUENAME=qQueueTest,QUEUEIDX=0,QUEUEADW0=285278208,QUEUE
ADW1=0,QUEUEADW2=0,QUEUEADW3=0,QUEUE_SRCBID=65535,QUEUE_SRCMOD=65535,QUEUE_
SRCENT=255,QUEUE_DSTBID=65535,QUEUE_DSTMOD=65535,QUEUE_DSTENT=255"
;
D.22.32 RTRV-TASKSEMINFO
Querying the semaphore information of the task.
Function
This command obtains the information of task's semaphores. This command can be executed
on any board of NE.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-TASKSEMINFO:[<TID>]:<MON_SLOT_SOR>:< CTAG>::[< TASKNAME>];
Command Parameters
Parameter Description
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS>
<cr><lf> M^^<CTAG>^COMPLD
<cr><lf>
^^^TaskId=<TaskId>,TASK_NAME=<TASK_NAME>,TaskSysId=<TaskSysId>,SemGetting=<
SemGetting>,SemOwner=<SemOwner>
,TaskState=<TaskState><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-TASKSEMINFO::SLOT-70:100::"SemLockTask0";
Response Message
NE 2012-03-25 17:46:15 M 100 COMPLD
"TASKID=222,TASK_NAME=SemLockTask0,TASKSYSID=0X2C1C,SEMGETTING=0XAC9B3C90,S
EMOWNER=0X2C1B,TASKSTATE=deadlock"
;
D.22.33 RTRV-ERRLOG
Retrieves the error log.
Function
This command retrieves the error log.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-ERRLOG:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
^^^"<contents>" <cr> <lf>
;
Response Parameters
None
Example
Command
RTRV-ERRLOG::SLOT-1-18:100;
Response Message
NE 2005-05-16 18:02:16
M 100 RTRV
"ResetLog:: total reset times = 37"
" No.001: 2005-05-14 14:31:08 BOARD=009 TYPE=0xf0000004
SOFTTYPE=001"
... ...
... ...
"FatalLog:: total = 101"
" 001# 2005-05-14 14:31:45 fatal task errorcode=0x00070001, Line
00057 in dbms_mfile.cpp"
" 002# 2005-05-14 14:31:45 fatal task errorcode=0xf0000010, Line
01230 in reset:tWebTask"
... ...
... ...
"ExceptLog:: total = 1"
" 001# 2005-05-14 14:39:22 ExcptErr: pc=0x00130d64, SR=0xb030,
FaultAddr=0x00000300, DataBuff=0xffffffff, taskname=tDmmCardRecv
"
"Fun SymBol:: total = 12"
"001# SymBol::DMM_FrgDel__Fv, EIPADDR=0x130d48, Depth=00, 14:39"
NE 2005-05-16 18:02:16
M 100 COMPLD
... ...
... ...
"012# SymBol::vxTaskEntry, EIPADDR=0xf51b80, Depth=11, 14:39
"
;
Related Commands
None
D.22.34 REPT^CPU^OVERTH
The ratio of CPU used over threshold event
Function
This event is reported to indicate that the ratio of CPU used is over threshold
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"TASK_NAME=<TaskName16>, TASK_RATIO= <CUR_RATIO>,
SlotNum=<SlotNum>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT ROLLBACKRSLT
" TASK_NAME=tCpuTestTask1, TASK_RATIO=9870, SlotNum=18"
;
Related Commands
None
D.22.35 REPT^USEDSPACE^OVERTH
VFS used space over event
Function
This event report that the used spacee of vfsis over the threshold
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"VFS_REGION=<VFS_REGION>,VFS_USEDSPACE=<VFS_USEDSPACE>,VFS_TOTALSPAC
E=<VFS_TOTALSPACE>,VFS_CURRATIO=<VFS_CURRATIO>,SlotNum=<SlotNum>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT USEDSPACE OVERTH
"
VFS_REGION=ofs1,VFS_USEDSPACE=28841984,VFS_TOTALSPACE=238841984,VFS_CURRATI
O=1207,SlotNum=7"
;
Related Commands
None
D.22.36 REPT^MSGNUM^OVERTH
Message number of message queue over event
Function
This event report that message number of message queue is over threshold
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"MSGQUE_NAME=<MSGQUE_NAME>,MSG_NUM=<MSG_NUM>,MSGQUE_LEN=<MSGQUE_LEN>
,MSG_RATIO=<MSG_RATIO>,SlotNum=<SlotNum>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT MSGNUM OVERTH
"MSGQUE_NAME=RtFibMsgQ,MSG_NUM=785,MSGQUE_LEN=1000,MSG_RATIO=7850,SlotNum=7
"
;
Related Commands
None
D.22.37 REPT^MEMUSED^OVERTH
Usage of memory over the threshold
Function
This event report that the usage of memory is over the threshold.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"MEM_USED_SIZE=<MEM_USED_SIZE>,MEM_TOTAL_SIZE=<MEM_TOTAL_SIZE>,MEM_C
UR_RATIO=<MEM_CUR_RATIO>,SlotNum=<SlotNum>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT MEMUSED OVERTH
"
MEM_USED_SIZE=297984,MEM_TOTAL_SIZE=48234496,MEM_CUR_RATIO=62,SlotNum=7"
;
Related Commands
None
D.22.38 REPT^SLICEMEMUSED^OVERTH
Slice memory over threshold event
Function
This event report the usage of slice memory is over the threshold.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"SLICEMEM_TYPE=<SLICE_MEM_TYPE>,SLICEMEM_SIZE=<SLICE_MEM_SIZE>,SLICE
MEM_USED=<SLICE_MEM_USED>,SLICEMEM_TOTAL=<SLICE_MEM_TOTAL>,SLICEMEM_CURRATI
O=<SLICE_MEM_CURRATIO>,SlotNum=<SlotNum>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT SLICEMEMUSED OVERTH
"
SLICEMEM_TYPE=1,SLICEMEM_SIZE=18980,SLICEMEM_USED=6262,SLICEMEM_TOTAL=87,SL
ICEMEM_CURRATIO=780,SlotNum=7 "
;
Related Commands
None
D.22.39 REPT^EVT^STARTDSTADJ
Starting adjust daylight saving time event
Function
This event report the DST adjustment event
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"ADJUST_WAY=<ADJWAY>,ADJUST_VALUE=<ADJMINUTE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT STARTDSTADJ
" ADJUST_WAY=Forward,ADJUST_VALUE=8 "
;
Related Commands
None
D.22.40 REPT^EVT^ENDDSTADJ
Ending adjust daylight saving time event
Function
This event report the DST adjustment ending event
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"ADJUST_WAY=<ADJWAY>,ADJUST_VALUE=<ADJMINUTE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT ENDDSTADJ
" ADJUST_WAY=Forward,ADJUST_VALUE=30 "
;
Related Commands
None
D.22.41 RTRV-FLASHCHECKINFO
Retrives the checking result of flash region
Function
This command retrives information about flash state.
Usage Note
None
Category
MON
Security
Maintenance
Command Syntax
RTRV-FLASHCHECKINFO:[<TID>]:<MON_BOARD_ID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"REGIONNAME=<REGIONNAME>,CHECKSTATE=<CHECKSTATE>,CHECKTIME=<CHECKTIME>"<
cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-FLASHCHECKINFO::SLOT-1-70:100
Response Message
WIN-NE 2005-04-16 17:55:34
M 100 COMPLD
"REGIONNAME=ofs1,CHECKSTATE=OK,CHECKTIME=2005-04-16 17-55-00"
"REGIONNAME=ofs2,CHECKSTATE=OK,CHECKTIME=2005-04-16 17-55-00"
;
Related Commands
None
D.23 Performance Management
This section lists commands which used to manage the system performance.
D.23.1 ED-PMALMCTRL-<MOD2>
Edits the parameters of the alarm table that affect the condition of reporting events.
Function
This command edits the parameters of the alarm table.
Usage Note
None
Category
Performance
Security
Provisioning
Command Syntax
ED-PMALMCTRL-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<LOCN>],
[<DIRN>],[<RPTMODE>],[<INTERVAL>],[<RTHR>],[<FTHR>],[<ENFLAG>];
Command Parameters
Indicates the second modifier of the report message, which identifies the type NA
<MOD2>
of the entity that reports the fault. The valid values are:
.ALL|100GETH|3GSDI|3GSDIRBR|40GETH|ANY|CBR10G|CFP|
COM
.DVBASI |EC|EQPT |ESCON |FC100 |FC1000 |FC1200 |FC200|
FC400
.FC800|FDDI|FETH|FICON|FICON10G|FICON4G|FICON8G|
FICONEXP
.GETH|HDSDI|HDSDIRBR|IBDDR|IBSDR|ISC1G|ISC2G|
MCACHN|OC|OC12
.OC192|OC3|OC48|OC768|OCH|ODU0|ODU0TCM1|ODU0TCM2|
ODU0TCM3
.ODU0TCM4|ODU0TCM5|ODU0TCM6|ODU1|ODU1TCM1|
ODU1TCM2|ODU1TCM3
.ODU1TCM4|ODU1TCM5|ODU1TCM6|ODU2|ODU2TCM1|
ODU2TCM2|ODU2TCM3
.ODU2TCM4|ODU2TCM5|ODU2TCM6|ODU3|ODU3TCM1|
ODU3TCM2|ODU3TCM3
.ODU3TCM4|ODU3TCM5|ODU3TCM6|ODU4 |ODU4TCM1|
ODU4TCM2|ODU4TCM3
.ODU4TCM4|ODU4TCM5|ODU4TCM6|ODU5G|ODU5GTCM1|
ODU5GTCM2|ODU5GTCM3
.ODU5GTCM4|ODU5GTCM5|ODU5GTCM6|ODUFLEX|
Parameter Description Default
Value
ODUFLEXTCM1|ODUFLEXTCM2
.ODUFLEXTCM3|ODUFLEXTCM4|ODUFLEXTCM5|
ODUFLEXTCM6|OMS|OSC|OTS|OTU1
.OTU2|OTU3|OTU4|OTU5G|PL|SDI|STM1|STM16|STM256|STM4|
STM64|WDM|XGETH
<AID> The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>. This ALL
parameter is optional. The default value is ALL, which indicates all ports in
the MOD2 on the NE. If <MOD2> is ALL, <AID> is null.
<MONTYP Indicates the PM parameters that are supported. The default value is ALL. ALL
E>
<LOCN> Indicates the location, in reference to the entity identified by the <AID>, NA
being performance monitored. The valid values are as follows:
NEND (near end condition, alarm, or event occurred at the near end
of the system)
FEND (far end condition, alarm, or event occurred at the far end of
the system)
<DIRN> Indicates the direction of monitoring relative to the entity identified by BTH
<AID>. The valid values are as follows:
BTH (both directions)
TRMT (transmit direction only)
RCV (receive direction only)
<RPTMOD Indicates the report mode. The valid value are as follows: RPTAL
E> RPTUP: indicates that only rising events are reported. L
RPTDOWN: indicates that only falling events are reported.
RPTALL: indicates that rising and falling events are reported.
The null value indicates that the last setting of the value does not change.
<INTERV Indicates the alarm sample interval. By default, the interval is 10 seconds. The 10
AL> valid value ranges from 5 to 600 seconds.
<RTHR> Indicates the rising threshold. The valid value ranges from 1 to 4294967295 NA
(0xFFFFFFFF). The rising threshold must be higher than the falling threshold.
<FTHR> Indicates the falling threshold. The valid value ranges from 0 to 4294967294 NA
(0xFFFFFFFE). The falling threshold must be lower than the rising threshold.
<ENFLAG Indicates the state flag. The valid values are ENABLE and DISABLE. By DISAB
> default, <ENFLAG> is DISABLE if <PRDTP> is 30s and prdvar. If LE
<PRDTP> is 30m, <ENFLAG> is ENABLE.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PMALMCTRL-FETH::FAC-4-1:500::ETHDROP,,,,,ENABLE;
Response Message
NE 2004-07-12 20:16:29
M 500 COMPLD
;
Related Commands
D.23.2 RTRV-PMALMCTRL-<MOD2>
D.23.2 RTRV-PMALMCTRL-<MOD2>
Retrieves parameters of the alarm table.
Function
This command retrieves parameters of the alarm table.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PMALMCTRL-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<LOCN>],
[<DIRN>];
Command Parameters
NA
<MOD2> Indicates the second modifier of the report message, which identifies the type
of the entity that reports the fault. The valid values are as follows:
Parameter Description Defau
lt
Value
ALL
COM,OC3,OC12,OC48,OC192,OC768
FETH,GETH,XGETH,VCG,OTU1,OTU2,OTU5G,OTU3,ODU1,ODU
2,ODU3,ODU5G
EC,OC,OCH,WDM,EQPT,OMS,OTS,OSC,MCACHN,FC100,FC200,
FC400,FC1000,FC1200
ODU0TCM1,ODU0TCM2,ODU0TCM3,ODU0TCM4,ODU0TCM5,O
DU0TCM6
ODU1TCM1,ODU1TCM2,ODU1TCM3,ODU1TCM4,ODU1TCM5,O
DU1TCM6
ODU2TCM1,ODU2TCM2,ODU2TCM3,ODU2TCM4,ODU2TCM5,O
DU2TCM6
ODU3TCM1,ODU3TCM2,ODU3TCM3,ODU3TCM4,ODU3TCM5,O
DU3TCM6
ODU5GTCM1,ODU5GTCM2,ODU5GTCM3,ODU5GTCM4,ODU5G
TCM5,ODU5GTCM6
<AID> The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>. This ALL
parameter is optional. The default value is ALL, which indicates all ports in the
MOD2 on the NE. If <MOD2> is ALL, <AID> is null.
<MONTYP Indicates the PM parameters that are supported. The default value is ALL. ALL
E>
<LOCN> Indicates the location, in reference to the entity identified by the <AID> being ALL
performance monitored. The valid values are as follows:
NEND (near end condition, alarm, or event occurred at the near end of
the system)
FEND (far end condition, alarm, or event occurred at the far end of the
system)
<DIRN> Indicates the direction of monitoring relative to the entity identified by <AID>. ALL
The valid values are as follows:
ALL (both directions)
TRMT (transmit direction only)
RCV (receive direction only)
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<AID>,<AIDTYPE>:<MONTYPE>,[<LOCN>],[<DIRN>],<RPTMODE>,
[<INTERVAL>],<RTHR>,<FTHR>,<ENFLAG>"<cr><lf>
;
Response Parameters
Parameter Description
<LOCN> Indicates the location, in reference to the entity identified by the <AID>, being
performance monitored. The valid values are as follows:
NEND (near end condition, alarm, or event occurred at the near end of the
system)
FEND (far end condition, alarm, or event occurred at the far end of the
system)
<DIRN> Indicates the direction of monitoring relative to the entity identified by <AID>.
The valid values are as follows:
ALL (both directions)
TRMT (transmit direction only)
RCV (receive direction only)
<RPTMODE> Indicates the report mode. The valid value are as follows:
RPTUP: indicates that only rising events are reported.
RPTDOWN: indicates that only falling events are reported.
RPTALL: indicates that rising and falling events are reported.
<INTERVAL> Indicates the alarm sample interval. By default, the interval is 10 seconds. The
valid value ranges from 5 to 600 seconds.
<RTHR> Indicates the rising threshold. The valid value ranges from 1 to 4294967295
(0xFFFFFFFF). The rising threshold must be higher than the falling threshold.
<FTHR> Indicates the falling threshold. The valid value ranges from 0 to 4294967294
(0xFFFFFFFE). The falling threshold must be lower than the rising threshold.
<ENFLAG> Indicates the state flag. The valid values are ENABLE and DISABLE.
Example
Command
RTRV-PMALMCTRL-FETH::FAC-4-1:400::ETHDROP;
Response Message
NE 2004-07-12 20:20:45
M 400 COMPLD
"FAC-4-1,FETH:ETHDROP,,,RPTALL,,1,0,ENABLE"
;
Related Commands
D.23.1 ED-PMALMCTRL-<MOD2>
D.23.3 ED-PMHISTCTRL
Modifies all history control parameters.
Function
This command modifies all history control parameters.
Usage Note
None
Category
Performance
Security
Provisioning
Command Syntax
ED-PMHISTCTRL:[<TID>]::<CTAG>::<PRDTP>, [<RECNUM>],[<PRD>],[<ENFLAG>]
Command Parameters
<PRDTP> Indicates the period type. The valid values are 30 seconds, 30 NA
minutes, prdvar, and prdvar2. <PRD> must be null unless the
parameter is prdvar.
<RECNUM> Indicates the maximum number of records. The valid value ranges NA
from 1 to 50. The default value varies according to the period.
<PRD> Indicates the period. If the PRDTP is prdvar,the valid value ranges NA
from 300 seconds to 43200 seconds, that is, 5 minutes to 12
hours.If the PRDTP is prdvar2,the valid value ranges from 300
seconds to 86400 seconds And the value must be the multiple of
30.<PRDTP> must be prdvar unless the parameter is null. If
<PRDTP> is prdvar, this parameter may be not null.
<ENFLAG> Indicates the state flag. The valid values are NOALTER
ENABLE/DISABLE/NOALTER.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PMHISTCTRL:::100::30S,,,ENABLE;
Response Message
NE 2004-07-12 19:41:28
M 100 COMPLD
;
Related Commands
D.23.4 RTRV-PMHISTCTRL
D.23.4 RTRV-PMHISTCTRL
Retrieves parameters of the history control table.
Function
This command retrieves parameters of the history control table.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PMHISTCTRL:[<TID>]::<CTAG>::[<PRDTP>];
Command Parameters
Parameter Description Default Value
<PRDTP> Indicates the period type. The valid values are 30s, 30m, prdvar, PRDALL
prdvar2, and PRDALL.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<PRDTP>,<RECNUM>,<PRD>,<ENFLAG>"<cr><lf>
;
Response Parameters
Parameter Description
<PRDTP> Indicates the period type. The valid values are 30s, 30m, prdvar, and
prdvar2.
<RECNUM> Indicates the maximum number of records. The valid value ranges from 1
to 50.
<PRD> Indicates the period. The valid values are 300-43200 seconds, that is, 5
minutes to 12 hours.
<ENFLAG> Indicates the state flag. The valid values are ENABLE and DISABLE. By
default, <ENFLAG> is DISABLE if <PRDTP> is 30s and prdvar. If
<PRDTP> is 30m, <ENFLAG> is ENABLE.
Example
Command
RTRV-PMHISTCTRL:::120::;
Response Message
NE 2004-07-12 20:05:41
M 120 COMPLD
"30S,16,30,DISABLE"
"30M,16,1800,ENABLE"
"PRDVAR,16,900,DISABLE"
"PRDVAR2,6,86400,DISABLE"
;
Related Commands
D.23.3 ED-PMHISTCTRL
D.23.5 INIT-REG-<MOD2>
Initializes storage records.
Function
This command initializes one or more storage records or event counters associated with an
equipment unit or facility on the NE to a specific value. In the most cases, these records
contain the PM information accumulated in previous intervals.
Usage Note
When <MONDAT> and <MONTM> are both null, it indicates that the current PM data is
cleared. If one of them is not null, it indicates that the history PM data is cleared.
Category
Performance
Security
Provisioning
Command Syntax
INIT-REG-<MOD2>:[<TID>]:[<AID>]:<CTAG>::<MONTYPE>,[<MONVAL>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>][,<MONTM>];
Command Parameters
<AID> Indicates the access identifier that identifies the equipment unit, ALL
facility, subscriber line, trunk, link, packet link, or signaling link
on the NE. This parameter depends on the command code
modifier and what kind of performance monitoring data is being
retrieved.
<MONTYPE> Indicates the type of monitored performance for which a value is ALL
requested.
<TMPER> Indicates the accumulation time period for the PM information. 15-MIN
The valid values are 15-MIN and 1-DAY.
<MONDAT> Indicates the date that the requested PM period specified in Current date
<TMPER> began. The valid format is MM-DD.
<MONTM> Indicates the time of the day that the requested PM period 00-00(HH-MM)
specified in <TMPER> began.
Response Syntax
<cr><lf> <lf>
^^^<rsphdr><cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
INIT-REG-OC3::FAC-1-3-1:100::ALL,10,,,15-MIN,7-1,0-0;
Response Message
NE 2004-07-08 15:57:49
M 100 COMPLD
;
Related Commands
None
D.23.6 RTRV-PM-<MOD2>
Retrieves the performance of <MOD2>.
Function
This command sends the current setting of PM data associated with one or more equipment
units, facilities, links, or signaling links within the NE.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PM-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<MONLEV>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>][,<MONTM>];
Command Parameters
<MONTYPE> Indicates the type of monitored performance for which a value ALL
is requested.
<MONLEV> Indicates the discriminating level for the requested monitored 1-UP
parameter.The valid values are 0-UP and 1-UP.
<TMPER> Indicates the accumulation time period for the PM information. 15-MIN
The valid values are 15-MIN and 1-DAY.
<MONDAT> Indicates the date that the requested PM period specified in The current date
<TMPER> began. The valid format is MM-DD.
<MONTM> Indicates the time of day that the requested PM period specified 00-00(HH-MM)
in <TMPER> began.
Response Syntax
The response format depends on whether any specified PM values exist.
If there are no values to report, the format is as follows:
<cr> <lf> <lf>
^^^<rspdhr> <cr> <lf>
M^^<ctag>COMPLD <cr> <lf> ;
Otherwise, if there is at least one PM value to report, the format is as follows:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<AID>[,<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>] [,<MONTM>]" <cr> <lf>
NOTE:
The normal response MUST contain at least one occurrence of <rspblk>. It is allowed to contain multiple
<rspblk>s if applicable.
Response Parameters
Parameter Description
<AID> Indicates the access identifier that identifies the equipment unit, facility, subscriber
line, trunk, link, packet link, or signaling link on the NE. This parameter depends
on the command code modifier and what kind of performance monitoring data is
being retrieved.
Parameter Description
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
<MONVAL> Indicates the discriminating level for the requested monitored parameter.
Indicates the validity indicator for the reported PM data. It indicates whether the
<VLDTY>
information for the specified time period is accumulated over the entire time period
or some portion of it.
The valid values are VALID and INVALID.
<LOCN> Indicates the location, in reference to the entity identified by <AID>, being
performance monitored. NEND (near end) refers to PM values obtained at the
identified entity. FEND (far end) refers to PM values obtained at a distant entity
that is connected to the identified entity.
<DIRN> Indicates the direction of monitoring relative to the entity identified by <AID>.
<DIRN> defaults to BTH, which indicates both directions. The valid values are
TRMT (transmit direction only) and RCV (receive direction only).
<TMPER> Indicates the accumulation time period for the PM information.
<MONDAT> Indicates the date that the requested PM period specified in <TMPER> began. The
valid format is MM-DD.
<MONTM> Indicates the time of day that the requested PM period specified in <TMPER>
began.
Example
Command
RTRV-PM-OC48::FAC-1-4-1:123::CV-S,0-UP,NEND,,15-MIN,04-09,17-00;
Response Message
NE 2003-04-09 17:25:12
M 123 COMPLD
"FAC-1-4-1,OC48:CV-S,2,VALID,NEND,RCV,15-MIN,04-09,17-15"
Related Commands
None
D.23.7 REPT^PM^<MOD2>
Reports information about the performance monitoring.
Function
This event is generated by an NE to inform the OS or maintenance personnel about the PM.
Parameters are provided to report the PM data from multiple data collection intervals in a
single message for NEs that store a history of the PM information. The REPT PM parameter
is an automatic message that is generated by the NE. Performance monitoring data can also
be retrieved on demand by using a RTRV-PM-<MOD2> command. However,
REPT^PM^<MOD2> is not used to respond to a RTRV-PM-<MOD2> command.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^PM^<MOD2>
<cr> <lf> <rspblk> + ;
where <rspblk> has the format:
^^^"[<AID>]:<MONTYPE>,<MONVAL>,[<VLDTY>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>]
[,<MONTM>]" <cr> <lf>
Response Parameters
Parameter Description
<MOD2> The valid values are EQPT, rr, LINK, PLK, SLK, and COM.
Indicates the access identifier for a single equipment unit, facility, link, packet link,
<AID>
or signaling link on the NE to which the retrieved monitored parameter value
pertains.
<MONTYPE> Indicates the type of the monitored parameter whose value is being reported.
Parameter Description
Example
Command
None
Response Message
NE 2004-07-08 16:14:01
A 335 REPT PM EQPT
"SLOT-1-3:BDTEMPMAX,312,INVALID,NEND,RCV,1-DAY,07-08,16-12"
;
Related Commands
D.30.12 ALW-PMREPT-ALL
D.30.13 INH-PMREPT-ALL
D.23.8 RTRV-PMDAY
Retrieves the start time for the daily collection of PM data.
Function
This command retrieves the start time of the daily PM data collection period of an NE. The
current start time of the daily data collection period can be set by using the SET-PMDAY
command.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PMDAY:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
^^^"<pm-day-start>" <cr> <lf>
;
Response Parameters
Parameter Description
<PM-DAY-START> The valid format is HOD, (hour-of-day) and ranges from 0 to 23.
Example
Command
RTRV-PMDAY:::123456;
Response Message
NE 2004-07-08 16:10:19
M 123456 COMPLD
"7"
;
Related Commands
D.23.9 SET-PMDAY
D.23.9 SET-PMDAY
Sets time of day that the performance monitoring starts.
Function
This command allows the start time of the daily PM data collection period to begin at any
hour of the day.
Usage Note
None
Category
Performance
Security
Provisioning
Command Syntax
SET-PMDAY:[<TID>]::<CTAG>::<PM-DAY-START>;
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Response Parameters
None
Example
Command
SET-PMDAY:::C::7;
Response Message
NE 2004-07-08 16:07:50
M C COMPLD
;
>
Related Commands
D.23.8 RTRV-PMDAY
D.23.10 RTRV-TH-<MOD2>
Retrieves a threshold.
Function
This command instructs an NE to send the current threshold level of one or more monitored
parameters that triggers an automatic message if the threshold is exceeded. These threshold
levels may apply to one or more equipment units, facilities, subscriber lines, trunks, links,
packet links, or signaling links on the NE.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-TH-<MOD2>:[<TID>]:[<AID>]:<CTAG>[::[<MONTYPE>],[<LOCN>]
[,<TMPER>]];
Command Parameters
Para Description D
met ef
er au
lt
V
al
ue
1G,ISC2G,MCACHN,OCH,PL,SDI,WDM
EC, OC, OMS, OTS, OSC
FC100, FC200, FC400, FC800, FC1200
ODU1TCM1, ODU1TCM2, ODU1TCM3, ODU1TCM4, ODU1TCM5,
ODU1TCM6
ODU2TCM1, ODU2TCM2, ODU2TCM3, ODU2TCM4, ODU2TCM5,
ODU2TCM6
ODU3TCM1, ODU3TCM2, ODU3TCM3, ODU3TCM4, ODU3TCM5,
ODU3TCM6
ODU5GTCM1, ODU5GTCM2, ODU5GTCM3, ODU5GTCM4, ODU5GTCM5,
ODU5GTCM6, CFPS, OCHS
<AI Indicates the access identifier for a equipment unit, facility, subscriber line, trunk, link, N
D> packet link, or signaling link on the NE. This parameter depends on <MOD2> and for A
which threshold levels are being retrieved.
<M Indicates the type of monitored performance for which a value is A
ON requested. MONTYPE shows the valid values of <MONTYPE>. L
TYP L
E>
<LO Indicates the location, in reference to the entity identified by <AID>, being performance A
CN monitored. NEND (near end) refers to PM values obtained at the identified entity. FEND L
> (far end) refers to PM values obtained at a distant entity that is connected to the identified L
entity. All values will be retrieved if nothing is entered for this parameter.
<T Indicates the accumulation time period for the PM information. The valid values are 15- 15
MP MIN and 1-DAY. The parameter defaults to 15-MIN if nothing is entered. -
ER> M
IN
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
<rspblk>+;
NOTE:
The normal response must contain at least one occurrence of <rspblk>. It is allowed to contain multiple
<rspblk>s.
Response Parameters
Parameter Description
<AID> Indicates the access identifier that identifies the equipment unit, facility, subscriber
line, trunk, link, packet link, or signaling link on the NE. This parameter depends on
the command code modifier and what kind of performance monitoring data is being
retrieved.
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
<LOCN> Indicates the location, in reference to the entity identified by <AID>, being
performance monitored. NEND (near end) refers to PM values obtained at the
identified entity. FEND (far end) refers to PM values obtained at a distant entity that
is connected to the identified entity.
<DIRN> Indicates the direction of monitoring relative to the entity identified by <AID>.
<DIRN> defaults to BTH, which indicates both directions. The valid values are
TRMT (transmit direction only) and RCV (receive direction only).
<THLEV> Indicates the current threshold level for the monitored parameter.
Example
Command
RTRV-TH-OC192::CLNT-1-1-1:C::ES-S,NEND,RCV,15-MIN;
Response Message
NE 2004-07-08 16:05:44
M C COMPLD
"CLNT-1-1-1,OC192:ES-S,NEND,RCV,65,15-MIN"
;
Related Commands
D.23.11 SET-TH-<MOD2>
D.23.11 SET-TH-<MOD2>
Sets the threshold.
Function
This command instructs an NE to set the threshold level for a monitored parameter that, when
exceeded, triggers an automatic message. The threshold level may apply to one or more
equipment units or facilities on the NE.
Usage Note
None
Category
Performance
Security
Provisioning
Command Syntax
SET-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::<MONTYPE>,<THLEV>,[<LOCN>],
[<DIRN>],[<TMPER>];
Command Parameters
NA
<MOD2> The valid values are as follows:
ALL
100GETH,3GSDI,3GSDIRBR,40GETH,ANY,CBR10G,CFP,COM
DVBASI,EC,EQPT,ESCON,FC100,FC1000,FC1200,FC200,FC400
FC800,FDDI,FETH,FICON,FICON10G,FICON4G,FICON8G,FICONE
XP
GETH,HDSDI,HDSDIRBR,IBDDR,IBSDR,ISC1G,ISC2G,MCACHN,
OC,OC12
OC192,OC3,OC48,OC768,OCH,ODU0,ODU0TCM1,ODU0TCM2,OD
U0TCM3
ODU0TCM4,ODU0TCM5,ODU0TCM6,ODU1,ODU1TCM1,ODU1TC
M2,ODU1TCM3
OODU1TCM4,ODU1TCM5,ODU1TCM6,ODU2,ODU2TCM1,ODU2T
CM2,ODU2TCM3
ODU2TCM4,ODU2TCM5,ODU2TCM6,ODU3,ODU3TCM1,ODU3TC
M2,ODU3TCM3
ODU3TCM4,ODU3TCM5,ODU3TCM6,ODU4,ODU4TCM1,ODU4TC
M2,ODU4TCM3
ODU4TCM4,ODU4TCM5,ODU4TCM6,ODU5G,ODU5GTCM1,ODU5
GTCM2,ODU5GTCM3
ODU5GTCM4,ODU5GTCM5,ODU5GTCM6,ODUFLEX,ODUFLEXT
Parameter Description Defa
ult
Value
CM1,ODUFLEXTCM2
ODUFLEXTCM3,ODUFLEXTCM4,ODUFLEXTCM5,ODUFLEXTC
M6,OMS,OSC,OTS,OTU1
OTU2,OTU3,OTU4,OTU5G,PL,SDI,STM1,STM16,STM256,STM4,ST
M64,WDM,XGETH,CFPS,OCHS
<AID> Indicates the access identifier that identifies the equipment unit, facility, ALL
subscriber line, trunk, link, packet link, or signaling link on the NE. This
parameter depends on the command code modifier and what kind of performance
monitoring data is being retrieved.
<MONTY Indicates the type of monitored performance for which a value is requested. All ALL
PE> values will be retrieved if nothing is entered for this parameter.
<THLEV> Indicates the desired threshold level to be set for <MONTYPE>. It should not be NA
null. <THLEV> 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 a degradation that has exceeded the defined or
specified threshold level. The 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 <AID>, being ALL
performance monitored. NEND (near end) refers to PM values obtained at the
identified entity. FEND (far end) refers to PM values obtained at a distant entity
that is connected to the identified entity. All values will be retrieved if nothing is
entered for this parameter.
<DIRN> Indicates the direction of monitoring relative to the entity identified by <AID>. BTH
<DIRN> defaults to BTH, which indicates both directions. The valid values are
TRMT (transmit direction only) and RCV (receive direction only).
<TMPER> Indicates the accumulation time period for the PM information. The parameter 15-
defaults to 15-MIN if nothing is entered. MIN
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
SET-TH-OCH::FAC-1-1-1:C::LBCMAX,0x100100,NEND,TRMT,15-MIN;
Response Message
NE 2004-07-08 16:00:01
M C COMPLD
;
Related Commands
D.23.10 RTRV-TH-<MOD2>
D.23.12 RTRV-ATTRTCA-<MOD2>
Retrieve attributes of threshold-crossing alerts (TCA).
Function
This command queries the report mode of performance threshold violation and the alarm
severity.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ATTRTCA-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDTYPE>],[<LOCN>],[<DIRN>],[<TMPER>],[<SRVEFF>],[<CONDEFF>];
Command Parameters
Parameter Description Default Value
<NTFCNCDE> This parameter indicates the alarm severity and it is valid only NA
when <CONDEFF> is SC. The valid values are CR(Critical
Alarm), MJ(Major Alarm), MN(Minor Alarm), NA(Ignore) and
NR(Not Report).
<SRVEFF> Indicates whether the alarms impact services. The valid values NA
are as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
A null value is equivalent to ALL.
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<CONDTYPE>,
[<LOCN>],[<DIRN>],[<TMPER>][,<SRVEFF>],<CONDEFF>" <cr> <lf>
;
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code that specifies the type of notification to be
generated by an NE upon the occurrence of the event described in
<CONDTYPE>.
Parameter Description
<CONDTYPE> Indicates the type of TCA for which the notification attributes
(<NTFCNCDE>and <CONDEFF>) are being changed.
<LOCN> Indicates the single location for which an alarm condition is being reported and
refers to the entity identified by the AID. NEND (near end) refers to PM values
obtained at the identified entity. FEND (far end) refers to PM values obtained at
a remote entity that is connected to the identified entity. Likewise, LINE[-x]
refers to an intermediate point.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity
identified by the AID.
<TMPER> Indicates the accumulation time period for the PM information if the
<CONDTYPE> is in a T-x format for a threshold violation.
This parameter is invalid at present and is not displayed in the query result.
<SRVEFF> Indicates whether the alarms impact services. The valid values are as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
All values will be retrieved if nothing is entered for this parameter.
<CONDEFF> Indicates whether an alarm or event is reported during a performance threshold
violation. The valid values are as follows:
TC: Reports an event.
SC: Reports an alarm.
Example
Command
RTRV-ATTRTCA-OC48::CLNT-1-3-1-1:1::,T-CV-S,NEND,RCV,,NSA,SC;
Response Message
NE 2004-11-09 06:27:05
M 1 COMPLD
"CLNT-1-3-1-1,OC48:1:MJ,T-CV-S,NEND,RCV,,NSA,SC"
;
Related Commands
D.23.13 SET-ATTRTCA-<MOD2>
D.23.13 SET-ATTRTCA-<MOD2>
Edits the attributes of threshold-crossing alert (TCA).
Function
This command sets the report mode of performance threshold violation to TC or SC and sets
the alarm severity.
Usage Note
When the report mode of performance threshold violation is set to SC, the alarm severity can
be set and the alarms are reported according to the preset alarm severity.
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
SET-ATTRTCA-<MOD2>: [<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],
[<CONDTYPE>],[<LOCN>],[<DIRN>],[<TMPER>],[<SRVEFF>],[<CONDEFF>];
Command Parameters
Parameter Description Defa
ult
Value
<MOD2> Indicates the type of the entity to be provisioned. When <MOD2>= ALL, only NA
following command is supported e.g. SET-ATTRTCA-ALL:::c::SC; This
command sets all TCAs to report as alarms (SC), with severity set to NA.
ALL
100GETH,3GSDI,3GSDIRBR,40GETH,ANY,CBR10G,CFP,COM,DV
BASI,EC,EQPT
ESCON,FC100,FC1000,FC1200,FC200,FC400,FC800,FDDI,FETH,FI
CON
FICON10G,FICON4G,FICON8G,FICONEXP,GETH,HDSDI,HDSDI
RBR,IBDDR,IBSDR
ISC1G,ISC2G,MCACHN,OC,OC12,OC192,OC3,OC48,OC768,OCH,
ODU0,ODU0TCM1
ODU0TCM2,ODU0TCM3,ODU0TCM4,ODU0TCM5,ODU0TCM6,O
DU1,ODU1TCM1,ODU1TCM2
ODU1TCM3,ODU1TCM4,ODU1TCM5,ODU1TCM6,ODU2,ODU2T
CM1,ODU2TCM2,ODU2TCM3
ODU2TCM4,ODU2TCM5,ODU2TCM6,ODU3,ODU3TCM1,ODU3T
CM2,ODU3TCM3,ODU3TCM4
ODU3TCM5,ODU3TCM6,ODU4,ODU4TCM1,ODU4TCM2,ODU4T
CM3,ODU4TCM4,ODU4TCM5
ODU4TCM6,ODU5G,ODU5GTCM1,ODU5GTCM2,ODU5GTCM3,O
DU5GTCM4,ODU5GTCM5
ODU5GTCM6,ODUFLEX,ODUFLEXTCM1,ODUFLEXTCM2,ODU
FLEXTCM3,ODUFLEXTCM4
ODUFLEXTCM5,ODUFLEXTCM6,OMS,OSC,OTS,OTU1,OTU2,OT
U3,OTU4,OTU5G,PL,SDI
STM1,STM16,STM256,STM4,STM64,WDM,XGETH
Parameter Description Defa
ult
Value
<NTFCNC This parameter indicates the alarm severity and it is valid only when NA
DE> <CONDEFF> is SC. The valid values are CR(Critical Alarm), MJ(Major
Alarm), MN(Minor Alarm), NA(Ignore) and NR(Not Report).
<CONDTY Indicates the notification code that specifies the type of notification to be NA
PE> generated by an NE upon the occurrence of the event described in
The parameter is optional.
<LOCN> Indicates the single location for which an alarm condition is being reported and NA
refers to the entity identified by the AID. NEND (near end) refers to PM values
obtained at the identified entity. FEND (far end) refers to PM values obtained at
a remote entity that is connected to the identified entity. Likewise, LINE[-x]
refers to an intermediate point. The parameter is optional.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity NA
identified by the AID. The parameter is optional.
<TMPER> Indicates the accumulation time period for the PM information if the NA
<CONDTYPE> is in a T-x format for a threshold violation.
The parameter is optional.
NOTE:
It is reserved for future use and thus must be left blank. Otherwise "PARAMETER
ERROR" will be returned.
<SRVEFF> Indicates whether the alarms impact services. The valid values are as follows: NA
NSA: The condition does not affect the services.
SA: The condition affects the services.
The parameter is optional.
This parameter is read only.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-ATTRTCA-OC48::FAC-1-2-1:1::, T-CV-S,NEND,RCV,,SA,TC;
Response Message
NE 2004-11-09 06:07:54
M 1 COMPLD
;
Related Commands
D.23.12 RTRV-ATTRTCA-<MOD2>
D.23.14 INIT-PMSTAT-<MOD2>
Clears counters specified by <MONTYPE> in the statistics table.
Function
This command clears counters specified by <MONTYPE> in the statistics table.
Usage Note
None
Category
Performance
Security
Provisioning
Command Syntax
INIT-PMSTAT-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<LOCN>],
[<DIRN>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
INIT-PMSTAT-FETH::FAC-1-4-1:200::ETHFCS;
Response Message
NE 2004-07-12 19:58:55
M 200 COMPLD ;
Related Commands
None
D.23.15 RTRV-PMSTAT-<MOD2>
Retrieves the current performance message.
Function
This command retrieves the current performances message.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PMSTAT-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<MONLEV>],
[<LOCN>],[<DIRN>];;
Command Parameters
<MONLEV> Indicates the counters only equal or above 1 or zero. The valid 1-UP
values are 1-UP and 0-UP.
both directions.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>,<AIDTYPE>:<MONTYPE>,[<LOCN>],
[<DIRN>],<OCRDAT>,<OCRTM>,<VALUE>"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the access identifier. The valid format is FAC-<SHELF ID>-
<SLOT ID>-<PORT ID>.
<OCRDAT> Indicates the date that the requested PM period specified in <TMPER>
began. The valid format is YYYY-MM-DD.
<OCRTM> Indicates the time of day that the requested PM period specified in
<TMPER> began. The valid format is (HH-MM-SS).
Example
Command
RTRV-PMSTAT-FETH::FAC-1-4-1:100::ALL,0-UP;
Response Message
NE 2004-07-12 19:49:52
M 100 RTRV
"FAC-1-4-1,FETH:TXPKT64,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT65,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT128,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT256,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT512,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT1024,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXUNICAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXMULCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXBRDCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXUNICAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXMULCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXBRDCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHDROP,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHOVER,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXBGOOD,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXBGOOD,2004-07-12,19-49-50,0"
>
>
NE 2004-07-12 19:49:52
M 100 COMPLD
"FAC-1-4-1,FETH:ETHALI,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHFCS,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHUNICOL,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHMULCOL,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHEXCCOL,2004-07-12,19-49-50,0"
;
Related Commands
None
D.23.16 INIT-PMHIST-<MOD2>
Clears history counters specified by <MONTYPE> in the statistics table.
Function
This command clears history counters specified by <MONTYPE> in the statistics table.
Usage Note
None
Category
Performance
Security
Provisioning
Command Syntax
INIT-PMHIST-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<LOCN>],
[<DIRN>];
Command Parameters
<MOD2> Indicates the second modifier of the report message, which identifies NA
the type of the entity that reports the fault. The valid values are FETH,
GETH , XGETH, FC, or ALL (ALL indicates all ports on the NE
whereas XGETH and FC are only valid for DWDM equipment).
<MONTYPE> Indicates the PM parameters that are supported. The default value is ALL
ALL.
ALL
<LOCN> Indicates the location, in reference to the entity identified by the
<AID>, being performance monitored. The valid values are as
follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
INIT-PMHIST-FETH::FAC-1-4-1:300::;
Response Message
NE 2004-07-12 20:01:35
M 300 COMPLD ;
Related Commands
D.23.17 RTRV-PMHIST-<MOD2>
D.23.17 RTRV-PMHIST-<MOD2>
Retrieves the history performances records between sample periods.
Function
This command retrieves the history performance records.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PMHIST-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<MONTYPE>],[<MONLEVEL>],
[<LOCN>],[<DIRN>],[<PRDTP>],[<OCRDAT>],[<OCRTM>];
Command Parameters
<MONLEVEL> Indicates the counters only equal to or above 1 or zero. The valid 1-UP
values are 1-UP and 0-UP.
<PRDTP> Indicates the period type. The valid values are 30s, 30m, prdvar, 30m
and prdvar2.
<OCRDAT> Indicates the date that the requested PM period specified in Current date
<TMPER> began. The valid format is YYYY-MM-DD.
<OCRTM> Indicates the time of day that the requested PM period specified Current time
in <TMPER> began. The valid format is (HH-MM-SS).
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>,<AIDTYPE>:<MONTYPE>,<PM_VLDTY>,[<LOCN>],
[<DIRN>],<PM_PRDTYPE>,<OCRDAT>,<OCRTM>,<VALUE>"<cr><lf>
;
Response Parameters
Parameter Description
<AID> Indicates the access identifier. The valid format is FAC-<SHELF ID>-
<SLOT ID>-<PORT ID>.
<PM_PRDTYPE> Indicates the period of the performance. The valid values are 15 minutes
and 24 hours.
<OCRDAT> Indicates the date that the requested PM period specified in <TMPER>
began. The valid format is YYYY-MM-DD.
<OCRTM> Indicates the time of day that the requested PM period specified in
<TMPER> began. The valid format is (HH-MM-SS).
Example
Command
RTRV-PMHIST-all:::100::,1-up,,,30m,2011-2-24,20-00-00;
Response Message
NE 2011-02-25 03:39:46
M 100 COMPLD
"CLNT-1-1-1,XGETH:RXPKT128,INVALID,,,30M,2011-02-24,20-00-
00,15201343621"
"CLNT-1-1-1,XGETH:TXPKT128,INVALID,,,30M,2011-02-24,20-00-
00,15201344538"
"CLNT-1-1-1,XGETH:RXBRDCAST,INVALID,,,30M,2011-02-24,20-00-
00,15201347480"
"CLNT-1-1-1,XGETH:TXBRDCAST,INVALID,,,30M,2011-02-24,20-00-
00,15201347465"
"CLNT-1-1-1,XGETH:RXOCTETS,INVALID,,,30M,2011-02-24,20-00-
00,1945771503744"
"CLNT-1-1-1,XGETH:RXPKTS,INVALID,,,30M,2011-02-24,20-00-00,15201339889"
"CLNT-1-1-1,XGETH:TXPKTS,INVALID,,,30M,2011-02-24,20-00-00,15201339003"
"CLNT-1-1-1,XGETH:TXOCTETS,INVALID,,,30M,2011-02-24,20-00-
00,1945771392384"
;
Related Commands
None
D.23.18 REPT^PM^FALLING
Reports the falling event.
Function
This event is reported to indicate the falling event.
Usage Note
Before the subsequent rising event is reported, no falling event can be reported. That is, no
continuous falling events can be reported.
Category
Performance
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
<ALARMCODE>^<ATAG>^REPT^PM^FALLING<cr><lf>
^^^"<AID>:<MONTYPE>,[<LOCN>],
[<DIRN>],<OCRDAT>,<OCRTM>,<VALUE>,<FTHR>"<cr><lf>
;
Response Parameters
Parameter Description
<LOCN> Indicates the location, in reference to the entity identified by <AID>, being
Parameter Description
<OCRDAT> Indicates the date that the requested PM period specified in <TMPER> began.
The valid format is YYYY-MM-DD.
<OCRTM> Indicates the date that the requested PM period specified in <TMPER> began.
The valid format is (HH-MM-SS).
Example
Command
None
Response Message
NE 2004-06-25 18:00:42
A 343 REPT PM FALLING
"FAC-1-4-1:ETHOVER,2004-06-25,18-00-41,0,0"
Related Commands
None
D.23.19 REPT^PM^RISING
Reports a rising event.
Function
This event is reported to indicate a rising event.
Usage Note
Before the subsequent falling event is reported, no rising event can be reported. That is, no
continuous rising events can be reported.
Category
Performance
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
<ALARMCODE>^<ATAG>^REPT^PM^RISING<cr><lf>
^^^"<AID>:<MONTYPE>,[<LOCN>],
[<DIRN>]<OCRDAT>,<OCRTM>,<VALUE>,<RTHR>"<cr><lf>
Response Parameters
Parameter Description
<LOCN> Indicates the location, in reference to the entity identified by <AID>, being
performance monitored. NEND (near end) refers to PM values obtained at the
identified entity. FEND (far end) refers to PM values obtained at a distant entity that
is connected to the identified entity.
<OCRDAT> Indicates the date that the requested PM period specified in <TMPER> began. The
valid format is YYYY-MM-DD.
<OCRTM> Indicates the time that the requested PM period specified in <TMPER> began. The
valid format is (HH-MM-SS).
Example
Command
None
Response Message
NE 2004-06-25 18:00:31
A 342 REPT PM RISING
"FAC-1-4-1:ETHOVER,,,2004-06-25,18-00-31,303,1"
Related Commands
None
D.23.20 RTRV-PM-BYBD
Retrieves the performance within the board.
Function
This command is issued to send its current setting of PM data associated with one or more
equipment units, facilities, links, or signaling links within the board.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PM-BYBD:[<TID>]:<BID>:<CTAG>::[<MONLEV>],[<TMPER>];
Command Parameters
<MONLEV> Indicates the discriminating level for the requested monitored 1-UP
parameter.The valid values are 0-UP and 1-UP.
<TMPER> Indicates the accumulation time period for the PM information. 15-MIN
Valid values are 15-MIN and 1-DAY.
Response Syntax
The response format depends on whether any specified PM values exist.
If there are no values to report, the format is as follows:
<cr> <lf> <lf>
^^^<rspdhr> <cr> <lf>
M^^<ctag>COMPLD <cr> <lf> ;
Otherwise, if there is at least one PM value to report, the format is as follows:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<AID>[,<AIDTYPE>]:<MONTYPE>,<MONVAL>,[<VLDTY>],
[<LOCN>],[<DIRN>],[<TMPER>],[<MONDAT>] [,<MONTM>]" <cr> <lf>
NOTE:
In this case, the normal response MUST contain at least one occurrence of <rspblk>. It is allowed to contain
multiple <rspblk>s if applicable.
Response Parameters
Parameter Description
<AID> Indicates the access identifier that identifies the equipment unit, facility, subscriber
line, trunk, link, packet link, or signaling link on the NE, depending on the
command code modifier and on which performance monitoring data is being
retrieved.
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
<MONVAL> Indicates the discriminating level for the requested monitored parameter.
Parameter Description
Indicates the validity indicator for the reported PM data. It indicates whether the
<VLDTY>
information for the specified time period is accumulated over the entire time period
or some portion of it.
Valid values are VALID and INVALID.
<LOCN> Indicates the location, in reference to the entity identified by <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.
<DIRN> Indicates the direction of monitoring relative to the entity identified by <AID>.
<DIRN> defaults to BTH, which indicates both directions. Valid values are TRMT
(transmit direction only) and RCV (receive direction only).
<TMPER> Indicates the accumulation time period for the PM information.
<MONDAT> Indicates the date of the beginning of the requested PM period specified in
<TMPER>. The format is MM-DD.
<MONTM> Indicates the beginning time of day of the requested PM period specified in
<TMPER>. The format is HH-MM.
Example
Command
RTRV-PM-BYBD::SLOT-1-4:123::0-UP,15-MIN;
Response Message
NE 2003-04-09 17:25:12
M 123 COMPLD
"FAC-1-4-1,OC48:CV-S,2,VALID,NEND,RCV,15-MIN,04-09,17-15"
Related Commands
None
D.23.21 RTRV-PMSTAT-BYBD
Retrieves the current performance message within the board.
Function
This command is issued to retrieve the current performances message within the board.
Usage Note
None
Category
Performance
Security
Retrieve
Command Syntax
RTRV-PMSTAT-BYBD:[<TID>]:<BID>:<CTAG>::[<MONLEV>];
Command Parameters
<MONLEV> Indicates the counters only equal or above 1 or zero. The valid 1-UP
value is 1-UP or 0-UP.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>,<AIDTYPE>:<MONTYPE>,[<LOCN>],
[<DIRN>],<OCRDAT>,<OCRTM>,<VALUE>"<cr><lf>
;
Response Parameters
Parameter Description
<LOCN> Indicates the location, in reference to the entity identified by <AID>, being
Parameter Description
<OCRDAT> Indicates the date of the beginning of the requested PM period specified in
<TMPER>. The format is YYYY-MM-DD.
<OCRTM> Indicates the beginning time of day of the requested PM period specified in
<TMPER>. The format is (HH-MM-SS).
Example
Command
RTRV-PMSTAT-BYBD::SLOT-1-4:100::0-UP;
Response Message
NE 2004-07-12 19:49:52
M 100 RTRV
"FAC-1-4-1,FETH:TXPKT64,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT65,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT128,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT256,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT512,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXPKT1024,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXUNICAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXMULCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXBRDCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXUNICAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXMULCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXBRDCAST,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHDROP,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHOVER,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:RXBGOOD,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:TXBGOOD,2004-07-12,19-49-50,0"
>
>
NE 2004-07-12 19:49:52
M 100 COMPLD
"FAC-1-4-1,FETH:ETHALI,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHFCS,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHUNICOL,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHMULCOL,2004-07-12,19-49-50,0"
"FAC-1-4-1,FETH:ETHEXCCOL,2004-07-12,19-49-50,0"
;
Related Commands
None
D.23.22 RTRV-PERFUN-BYBD
Retrieves the performance supporting function infomation of the board.
Function
This command is issued to retrieve the register function information of sdh performance to
the board for maintaining.
Usage Note
None
Category
Performance
Security
Maintenance
Command Syntax
RTRV-PERFUN-BYBD:[<TID>]:<BID>:<CTAG>::[<PERFUNID>];
Command Parameters
<BID> ID of board. NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<PERFUNID>,<MONTYPE>,<PRIMID>,<RELATION>,<TYPEFLAG>,<ALMID>,<ALMTYPE>,<
15MTRHIGH>,<15MTRLOW>,<15MTRMAX>,<24HTRHIGH>,<24HTRLOW>,<24HTRMAX>,<TCEID>"
<cr><lf>
;
Response Parameters
Parameter Description
<PERFUNID> Indicates the register function information of sdh performance for which a
value is requested. A null value is ALL.
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
A null value is ALL.
Command
RTRV-PERFUN-BYBD::SLOT-1-18:1234::;
Response Message
NEW-NE 1990-01-02 08:12:29
M 1234 COMPLD
"11,PLWCCUR,OFA_WORK_CUR,1,1,0,0,0,0,0,0,0,0,114"
;
Related Commands
None
D.23.23 RTRV-PEROBJ-BYBD
Retrieves the performance supporting object of the board.
Function
This command is issued to retrieve the register object of sdh performance to the board for
maintaining.
Usage Note
None
Category
Performance
Security
Maintenance
Command Syntax
RTRV-PEROBJ-BYBD:[<TID>]:<BID>:<CTAG>::[<MONTYPE>],<TMPER>;
Command Parameters
<BID> ID of board. NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<BID>,<MONTYPE>,<TMPER>,<PERSTATE>,<TRSTATE>,<HIGH>,<LOW>,<OBJTYPE>,<MO
D2>,<LOCN>,<DIRN>,<PARALEN>,<PARA>"<cr><lf>
;
Response Parameters
Parameter Description
<BID> ID of board.
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
A null value is ALL.
<TMPER> Indicates the accumulation time period for the PM information. The valid
values are 15-MIN and 1-DAY.
<LOCN> Indicates the location, in reference to the entity identified by the <AID>,
from which the PM value is being retrieved. Thus, "near end" refers to PM
values obtained at the identified entity, and "far end" refers to PM values
Parameter Description
Example
Command
RTRV-PEROBJ-BYBD::SLOT-1-18:1234::,15-MIN;
Response Message
NEW-NE 1990-01-01 22:23:49
M 1234 COMPLD
"SLOT-1-18,BDTEMPMAX,15-MIN,ENABLE,DISABLE,0,0,76,0X1A,NEND,RCV,2,0x00
78"
;
Related Commands
None
D.23.24 RTRV-PMFUN-BYBD
Retrieves the performance supporting function infomation of the board.
Function
This command is issued to retrieve the register function information of data performance to
the board for maintaining.
Usage Note
None
Category
Performance
Security
Maintenance
Command Syntax
RTRV-PMFUN-BYBD:[<TID>]:<BID>:<CTAG>::[<PMFUNID>];
Command Parameters
<BID> ID of board. NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<PMFUNID>,<MONTYPE>,<PRIMID1>,<PRIMID2>,<PRIMID3>,<PRIMID4>,<RELATION>,
<TYPEFLAG>,<ALMID>,<REPTYPE>,<REPALMTRMODE>,<TRHIGH>,<TRLOW>,<SELECTSTATE>"
<cr><lf>
;
Response Parameters
Parameter Description
<PMFUNID> Indicates the register function information of sdh performance for which a
value is requested. A null value is ALL.
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
A null value is ALL.
Example
Command
RTRV-PMFUN-BYBD::SLOT-1-18:1234::;
Response Message
NEW-NE 1990-01-02 08:12:29
M 1234 COMPLD
"11,PLWCCUR,OFA_WORK_CUR,OFA_TEMPERATURE,OFA_INP,OFA_OUTP,1,1,0,1,0,100,1,0
"
;
Related Commands
None
D.23.25 RTRV-PMOBJ-BYBD
Retrieves the performance supporting object of the board.
Function
This command is issued to retrieve the register object of data performance to the board for
maintaining.
Usage Note
None
Category
Performance
Security
Maintenance
Command Syntax
RTRV-PMOBJ-BYBD:[<TID>]:<BID>:<CTAG>::[<MONTYPE>];
Command Parameters
<BID> ID of board. NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<BID>,<MONTYPE>,<30SPERSTATE>,<30MPERSTATE>,<VAR1PERSTATE>,<VAR2PERSTAT
E>,<HIGH>,<LOW>,<TRSTATE>,<TRMODE>,<OBJTYPE>,<MOD2>,<LOCN>,<DIRN>,<PARALEN>
,<PARA>"<cr><lf>
;
Response Parameters
Parameter Description
<BID> ID of board.
<MONTYPE> Indicates the type of monitored performance for which a value is requested.
A null value is ALL.
<30SPERSTATE> ndicates the 30s period type state flag. The valid values are ENABLE and
DISABLE.
<30MPERSTATE> ndicates the 30m period type state flag. The valid values are ENABLE and
Parameter Description
DISABLE.
<VAR1PERSTATE> Indicates the prdvar period type state flag. The valid values are ENABLE
and DISABLE
<VAR2PERSTATE> Indicates the prdvar2 period type state flag. The valid values are ENABLE
and DISABLE
<LOCN> Indicates the location, in reference to the entity identified by the <AID>,
from which the PM value is being retrieved. 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.
Example
Command
RTRV-PMOBJ-BYBD::SLOT-1-2:1234::;
Response Message
NE118 2012-07-08 15:05:50
M 1234 COMPLD
"SLOT-1-
2,VUNI_RCVPKTS,DISABLE,ENABLE,DISABLE,DISABLE,1000,100,ENBALE,0,26,NEND,RCV
,2,"03""
;
Related Commands
None
D.23.26 SET-PERDISPLAY-<MOD2>
Set primitives of sdh performance display to NE.
Function
This command is issued to set primitives of sdh performance display to NE.
Usage Note
None
Category
Performance
Security
Debug
Command Syntax
SET-PERDISPLAY-<MOD2>:
[<TID>]:<PER_AID>:<CTAG>::<PER_PRIM>,<PER_DISPLAT_STATE>;
Command Parameters
<PER_DISPLAT_STATE> ENABLE/DISABLE NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
SET-PERDISPLAY-EQPT::SLOT-1-18:123::VC3CNT,ENABLE
Response Message
NE 2012-04-25 17:41:17
M 100 COMPLD
;
Related Commands
None
D.24.1 ALW-AUD-ALL
Allows the periodic automatic execution mode of audits.
Function
This command instructs an NE to automatically perform the specified, periodic audits that
were inhibited by the INH-AUD-ALL command.
Usage Note
None
Category
Environment
Security
Provisioning
Command Syntax
ALW-AUD-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Response Parameters
None
Example
Command
ALW-AUD-ALL:::1;
Response Message
NE 2004-11-09 09:01:13
M 1 COMPLD
;
Related Commands
D.24.2 INH-AUD-ALL
D.24.2 INH-AUD-ALL
Inhibits the periodic automatic execution mode of audits.
Function
This command is issued to disable the periodic automatic execution mode of audits. Audits
are resumed by issuing the ALW-AUD-ALL command.
Usage Note
None
Category
Environment
Security
Provisioning
Command Syntax
INH-AUD-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INH-AUD-ALL:::1;
Response Message
NE 2004-11-09 09:01:13
M 1 COMPLD
;
Related Commands
D.24.1 ALW-AUD-ALL
D.24.3 ALW-VSL-ALL
Enables LED indicators.
Function
This command instructs an NE to enable the LED indicators that were inhibited by the INH-
VSL-ALL command.
Usage Note
None
Category
Environment
Security
Provisioning
Command Syntax
ALW-VSL-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Response Parameters
None
Example
Command
ALW-VSL-ALL:::1;
Response Message
NE 2004-11-09 09:01:13
M 1 COMPLD
;
>
Related Commands
D.24.4 INH-VSL-ALL
D.24.4 INH-VSL-ALL
Inhibits LED indicators.
Function
This command disables LED indicators by using the ALW-VSL-ALL command.
Usage Note
None
Category
Environment
Security
Provisioning
Command Syntax
INH-VSL-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Response Parameters
None
Example
Command
INH-VSL-ALL:::1;
Response Message
NE 2004-11-09 09:01:13
M 1 COMPLD
;
Related Commands
D.24.3 ALW-VSL-ALL
D.24.5 ED-ALMTH-<MOD2>
Modifies the alarm threshold.
Function
This command modifies the alarm threshold. An event is generated if the threshold is
reached.
Usage Note
None
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
ED-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>:::ALMTHTYPE=<ALMTHTYPE>,
[EXPPWR=<EXPPWR>],[DOWNTH=<DOWNTH>],[UPTH=<UPTH>];
Command Parameters
<MOD2> WDM/OSC/OC/OCH/CFP NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-ALMTH-WDM::FAC-1-120-1:C:::ALMTHTYPE=OPR,DOWNTH=-10,UPTH=INVALID;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD ;
Related Commands
D.24.6 RTRV-ALMTH-<MOD2>
D.24.6 RTRV-ALMTH-<MOD2>
Retrieves the alarm threshold.
Function
This command retrieves the alarm threshold. An event is generated if the threshold is
reached.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>:::[ALMTHTYPE=<ALMTHTYPE>];
Command Parameters
Parameter Description Default Value
dBm)
LCC: cooling current (the unit is 1 mA)
LBC: offset current (the unit is 1 mA)
LTEMP: laser temperature (the unit is 1 °C)
MTEMP: chip temperature (the unit is 1°C)
AGOPR: total optical power input (the unit is 1 dBm)
AGOPT: total optical power output (the unit is 1 dBm)
PLWC: working current (the unit is 1 mA)
PLCC: laser cooling current (the unit is 1 mA)
PLTEMP: working temperature (the unit is 1
centigrade)
EDFBOXTEMP: erbium-doped fiber box temperature
(the unit is 1 °C)
MCC: module cooling current (the unit is 1 mA)
PLP: pump power
L1PLWC: working current of the first pump laser
L2PLWC: working current of the second pump laser
L3PLWC: working current of the third pump laser
L1PLCC: laser cooling current of the first pump laser
L2PLCC: laser cooling current of the second pump
laser
L3PLCC: laser cooling current of the third pump laser
L1PLTEMP: working temperature of the first pump
laser
L2PLTEMP: working temperature of the second pump
laser
L3PLTEMP: working temperature of the third pump
laser
PLPWR: Pump optical power
RPALM: the alarm of Reflection optical power
RPSHUT: the shutdown of Reflection optical power
ALL: all types.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::ALMTHTYPE=<ALMTHTYPE>,
[EXPPWR=<EXPPWR>,]UPTH=<UPTH>,DOWNTH=<DOWNTH>"<cr><lf>)+ ;
Response Parameters
Parameter Description
Example
Command
RTRV-ALMTH-OCH::FAC-1-1-1:C:::ALMTHTYPE=OPR;
Response Message
NE 2005-10-12 15:54:55
M C COMPLD
"FAC-1-1-1::ALMTHTYPE=OPR,UPTH=40,DOWNTH=-30" ;
Related Commands
D.24.5 ED-ALMTH-<MOD2>
D.24.7 RTRV-ALMTHRNG-<MOD2>
Queries the alarm threshold range for input optical power.
Function
This command queries the alarm threshold range for input optical power. The thresholds
include the upper threshold and lower threshold.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ALMTHRNG-<MOD2>:[<TID>]:<AID>:<CTAG>:::
[ALMTHTYPE=<ALMTHTYPE>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::ALMTHTYPE=<ALMTHTYPE>,OVERLOADUPTH
=<OVERLOADUPTH>,OVERLOADDOWNTH
=<OVERLOADDOWNTH>,DETECTUPTH=<DETECTUPTH>,DETECTDOWNTH=<DETECTDOWNTH>"<cr><
lf>)+;
Response Parameters
Parameter Description
<OVERLOADUPTH> Indicates the maximum value of the upper threshold of the performance
threshold-crossing alarm. This value is the overload point of the optical
power.
<OVERLOADDOWNTH> Indicates the minimum value of the upper threshold of the performance
threshold-crossing alarm.
<DETECTUPTH> Indicates the maximum value of the lower threshold of the performance
threshold-crossing alarm.
<DETECTDOWNTH> Indicates the minimum value of the lower threshold of the performance
threshold-crossing alarm. This value is the sensitivity of the optical
power.
Example
Command
RTRV-ALMTHRNG-OC::FAC-1-1-3:C
Response Message
NE 2010-04-12 15:54:55
M C COMPLD
"FAC-1-1-
3::ALMTHTYPE=OPR,OVERLOADUPTH=1.0,OVERLOADDOWNTH=0.0,DETECTUPTH=0.0,DETECTD
OWNTH=-4.0"
;
Related Commands
D.24.5 ED-ALMTH-<MOD2>
D.24.8 REPT^ALM^<MOD2>
Reports alarms.
Function
This is a message that is automatically generated by the NE to inform the OS of the
occurrence of an alarm on a facility, path, or equipment.
Non-alarmed events are not reported with alarm messages. Non-alarmed events are reported
by event messages. This feature can be set by using the SET-ATTR-<MOD2> command.
Only an SC event can be changed to an alarm by using the SET-ATTR-<MOD2> command.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
<almcde>^<atag>^REPT^ALM^^<MOD2><cr><lf>
^^^"[<AID>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],[<OCRTM>],[<LOCN>],
[<DIRN>],[<MONVAL>],[<THLEV>],[<TMPER>]:[<CONDDESCR>],[<AIDDET>]:
[SN=<SN>]"<cr><lf>
Response Parameters
Parameter Description
<MOD2> Indicates the second modifier of the report message, which identifies the type of
the entity that reports the fault.
<AID> Indicates the <AID> of the entity that reports the fault.
<NTFCNCDE> Indicates the alarm level of <CONDTYPE>. The valid values are CR (critical
alarm), MJ (major alarm), MN (minor alarm), and CL (cleared alarm).
<CONDTYPE> Indicates the type of the alarm indication. Refer to CONDTYPE for the valid
values and descriptions of the conditions reported.
<SRVEFF> Indicates whether the alarms impact services. The valid values are:
SA: The condition affects the services.
NSA: The condition does not affect the services.
<LOCN> Indicates the location, with reference to the entity identified by the <AID>, being
performance monitored. NEND (near end) refers to alarm conditions obtained at
the identified entity. FEND (far end) refers to alarm conditions obtained at a
remote entity that is connected to the identified entity.
<DIRN> Indicates the direction of monitoring relative to the entity identified by the
<AID>. The valid values are TRMT (transmit direction only) and RCV (receive
direction only). This parameter is optional.
<MONVAL> Indicates the measured value of a monitored parameter, which may contain data
related to transmission performance or circuit activity, if <CONDTYPE> is a
threshold violation. This parameter is optional.
<THLEV> Indicates the user-defined or system-specified threshold level if <CONDTYPE>
is a threshold violation. This parameter is optional.
<TMPER> Indicates the accumulation time period for the PM information if <CONDTYPE>
is in a T-x format for a threshold violation. The valid values are 15-MIN (15
minute) and 1-DAY (24 hour). This parameter is optional.
<CONDDESCR> Indicates the detailed text descriptions of the alarm condition.
<AIDDET> Indicates the supplementary equipment identification used to identify the location
of the reported trouble. This parameter is used in conjunction with <AID>.
<SN> Indicates the number of the alarm message. This parameter is valid only for
Huawei EMS.
Example
Command
None
Response Message
NE 2004-07-09 15:06:55
** 157 REPT ALM EQPT
"SLOT-1-1:MJ,MEA,NSA,2004-07-09,15-06-55,NEND,RCV,,,15-MIN:\"MISMATCH OF
EQUIPMENT AND ATTRIBUTES\","
;
Related Commands
D.24.13 RTRV-ALM-<MOD2>
D.24.27 RTRV-COND-<MOD2>
D.24.9 REPT^EVT^<MOD2>
D.24.9 REPT^EVT^<MOD2>
Reports events.
Function
This is a message that is generated by the NE to inform the OS of the occurrence of an event
from a facility, path or equipment. This message may also report the recovery from off-
normal or faulty conditions that are reported previously in response to the REPT-EVT
command. This can be realized by using the <CONDTYPE> in the original event report and
using the value CL for <CONDEFF>.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^EVT^<MOD2><cr><lf>
^^^"[<AID>]:<CONDTYPE>,[<CONDEFF>],[<OCRDAT>],[<OCRTM>],[<LOCN>],[<DIRN>],
, [<MONVAL>],[<THLEV>], [<TMPER>]:[<CONDDESCR>],[<AIDDET>]:[SN=<SN>]"<cr>
<lf>
Response Parameters
Parameter Description
<MOD2> Indicates the second modifier of the message which identifies the type
of the entity that reports the fault.
<AID> Indicates the AID of the entity that reports the fault.
<CONDEFF> Indicates the effect of the event on the NE. The event may initiate a
standing condition, which can later be retrieved by using the RTRV-
COND-<MOD2> command or may initiate a transient condition that
does not change the basic condition of the NE for an extended time
period. The valid values of <CONDEFF> are CL, SC, and TC. The
default value is TC.
<LOCN> Indicates the single location for which an alarm condition is being
reported and refers to the entity identified by <AID>. NEND (near end)
refers to alarm conditions obtained at the identified entity. FEND (far
end) refers to alarm conditions obtained at a remote entity that is
connected to the identified entity. Likewise, LINE[-x] refers to an
intermediate point. This parameter is optional.
<DIRN> Indicates the direction of the event and is relative to the entity identified
by <AID>. This parameter is optional.
<MONVAL> Indicates the monitored value and is a floating number. This parameter
is an integer and is optional.
<THLEV> Indicates the threshold value and is a floating number. This parameter is
an integer and is optional.
<SN> Indicates the number of the SC event. This parameter is valid only for
Huawei EMS.
Example
Command
None
Response Message
NE 2004-07-09 15:09:05
A 160 REPT EVT EQPT
"SLOT-1-1:MEA,SC,2004-07-09,15-09-05,NEND,RCV,,,:\"MISMATCH OF EQUIPMENT
AND ATTRIBUTES\","
;
>
Related Commands
D.24.8 REPT^ALM^<MOD2>
D.24.13 RTRV-ALM-<MOD2>
D.24.27 RTRV-COND-<MOD2>
D.24.18 REPT^ALM^ENV
D.24.17 RTRV-ALM-ENV
D.24.10 RLS-EXT-CONT
Releases an external control.
Function
This command releases an external control operation. The control can be operated
momentarily or continuously.
Usage Note
None
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
RLS-EXT-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>][,<DUR>];
Command Parameters
Parameter Description Default Value
<CONTTYPE> Indicates the type of the control operation. The valid format is NA
CONT-<CONTTYPE>.
All control operations identified by the AID parameter will be
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Response Parameters
None
Example
Command
RLS-EXT-CONT::CONT-7:1::CONT-AIRCOND;
Response Message
NE 2004-07-15 14:50:23
M 1 COMPLD
;
>
Related Commands
D.24.12 OPR-EXT-CONT
D.24.11 RTRV-EXT-CONT
D.24.11 RTRV-EXT-CONT
Retrieves an external control.
Function
This command sends the control state of an external control operation. The command can be
used to audit the result of the OPR-EXT-CONT or RLS-EXT-CONT command.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-EXT-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the AID of the external control operation. A value must NA
be entered for this parameter.
The valid format is CONT-<N>.
<CONTTYPE> Indicates the type of the control operation. The valid format is NA
CONT-<CONTTYPE>.
All controls identified by <AID> will be indicated if nothing is
entered for this parameter.
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<AID>:[<CONTTYPE>],<DUR>[,<CONSTATE>]" <cr> <lf>
Response Parameters
Parameter Description
DUR Indicates the duration that the external control operation can be performed.
CONSTATE Indicates the control state of the external control operation. The valid values are as
follows:
OPER: Operated
RLS: Released
Example
Command
RTRV-EXT-CONT::CONT-7:1;
Response Message
NE 2004-07-15 14:43:21
M 1 COMPLD
"CONT-7:CONT-AIRCOND,CONTS,RLS"
;
>
Related Commands
D.24.12 OPR-EXT-CONT
D.24.10 RLS-EXT-CONT
D.24.12 OPR-EXT-CONT
Performs an external control.
Function
This command performs an external control. The control can be performed momentarily or
continuously.
Usage Note
None
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
OPR-EXT-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>][,<DUR>];
Command Parameters
Parameter Description Default Value
<CONTTYPE> Indicates the type of the control. The valid format is CONT- NA
<CONTTYPE>.
All controls identified by AID will be indicated if nothing is
entered for this parameter.
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Response Parameters
None
Example
Command
OPR-EXT-CONT::CONT-7:1::CONT-AIRCOND,CONTS;
Response Message
NE 2004-07-15 14:46:57
M 1 COMPLD
;
Related Commands
D.24.10 RLS-EXT-CONT
D.24.11 RTRV-EXT-CONT
D.24.13 RTRV-ALM-<MOD2>
Retrieves alarms of a facility or path
Function
This command retrieves and sends the current alarms associated with one or more facilities,
paths or equipment.
This command may be used to retrieve the NE information, which then may be used to
update the OS database when it is suspected that the automatic alarm messages issued by the
NE upon the REPORT ALARM command are 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, that is, existing conditions satisfying all the specified input parameters will be reported
in the message response.
Environmental alarms are not expected to respond to the RTRV-ALM-ALL command. The
RTRV-ALM-ENV command is used to retrieve the environmental alarms.
Usage Note
None
Category
Alarm
Security
Retrieve
Command Syntax
RTRV-ALM-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<SRVEFF>],[<LOCN>],[<DIRN>],[<TMPER>];
Command Parameters
Parameter Description Default Value
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid NA
values are CR (Critical Alarm), MJ (Major Alarm), MN (Minor
Alarm), and CL (Cleared Alarm).
If nothing is entered for this parameter, alarms of every
notification code are retrieved.
<SRVEFF> Indicates whether the alarms impact services. The valid values NA
are as follows:
NSA: indicates that the alarm does not affect the
services.
SA: indicates that the alarm affects the services.
All values will be retrieved if nothing is entered for this
parameter.
<LOCN> Indicates the single location for which an alarm is being reported NA
and refers to the entity identified by <AID>. NEND (near end)
refers to PM values obtained at the identified entity. FEND (far
end) refers to PM values obtained at a remote entity that is
connected to the identified entity. All values will be retrieved if
nothing is entered for this parameter.
<DIRN> Indicates the direction of the alarm and is relative to the entity NA
Parameter Description Default Value
<TMPER> Indicates the accumulation time period for the PM information if ALL
<CONDTYPE> is in a T-x format for a threshold violation.
NOTE:
If users set this parameter to 15-MIN or 1-DAY, the threshold violation
alarms of the specified period are returned. If users set this parameter to
TMP-ALL, the threshold violation alarms of all periods are returned.
If users use a default parameter, the threshold violation alarms of all
periods and common alarms without period types are returned.
Response Syntax
<SID><DATE><TIME>
M CTAG COMPLD
^^^"[<AID>][,<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<TMPER>]:[<CONDDESCR>],[<AIDDET>]:[SN=<SN>]"
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid values are CR
(Critical Alarm), MJ (Major Alarm), MN (Minor Alarm), NA (Not Alarmed),
and NR (Not Reported).
<SRVEFF> Indicates whether the alarms impact services. The valid values are as follows:
NSA: indicates that the alarm does not affect the services.
SA: indicates that the alarm affects the services.
<LOCN> Indicates the single location for which an alarm is being reported and refers to the
entity identified by <AID>.
<DIRN> Indicates the direction of the alarm and is relative to the entity identified by
<AID>.
<TMPER> Indicates the accumulation time period for the PM information if the
<CONDTYPE> is in a T-x format for a threshold violation.
Parameter Description
<CONDDESCR> Indicates the text message associated with the alarm. It consists of no more than
63 characters.
<AIDDET> Indicates the supplementary equipment identification used to identify the location
of the reported fault. This parameter is used in conjunction with <AID>.
<SN> Indicates the number of the alarm. This parameter is valid only for Huawei EMS.
Example
Command
RTRV-ALM-ALL:::100;
Response Message
NE 2004-07-09 17:27:49
M 100 COMPLD
"SLOT-1-9,EQPT:CR,RMV,SA,2004-07-09,14-04-44,NEND,RCV,:\"Equipment
offline or uninstalled\"," "SLOT-1-2,EQPT:MN,MEA,NSA,2004-07-09,14-43-
29,NEND,RCV,:\"Mismatch of equipment and attributes\"," "SLOT-1-
3,EQPT:MN,MEA,NSA,2004-07-09,14-43-29,NEND,RCV,:\"Mismatch of equipment and
attributes\","
;
Related Commands
D.24.8 REPT^ALM^<MOD2>
D.24.9 REPT^EVT^<MOD2>
D.24.27 RTRV-COND-<MOD2>
D.24.18 REPT^ALM^ENV
D.24.17 RTRV-ALM-ENV
D.24.14 RTRV-ALM-CONTIME
Retrieves the time delay for starting an alarm or the time delay for clearing an alarm.
Function
This command retrieves the time delay for starting an alarm or the time delay for clearing an
alarm.
Usage Note
None
Category
Alarm
Security
Retrieve
Command Syntax
RTRV-ALM-CONTIME:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>
M^^<CTAG>^COMPLD<cr><lf>
^^^ENTRYTIME=<ENTRYTIME>,CLEARTIME=<CLEARTIME><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-ALM-CONTIME:::100;
Response Message
NE 2007-11-19 15:18:00
M 100 COMPLD
"ENTRYTIME=2,CLEARTIME=10"
;
Related Commands
D.24.16 SET-ALM-CONTIME
D.24.15 RTRV-DFTALMTH-<MOD2>
Retrieves the default alarm threshold.
Function
This command retrieves the default alarm threshold.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-DFTALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>:::
[ALMTHTYPE=<ALMTHTYPE>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"<AID>::ALMTHTYPE=<ALMTHTYPE>,UPTH=<UPTH>,DOWNTH=<DOWNTH>"<cr><lf>)+ ;
Response Parameters
Parameter Description
Example
Command
RTRV-DFTALMTH-OCH::FAC-1-1-1:C:::ALMTHTYPE=OPR;
Response Message
NE 2016-02-12 15:54:55
M C COMPLD
"FAC-1-1-3::ALMTHTYPE=OPR,UPTH=0,DOWNTH=0.6" ;
Related Commands
None
D.24.16 SET-ALM-CONTIME
Sets the time delay for starting an alarm or the time delay for clearing an alarm.
Function
This command edits the time delay for starting an alarm, or the time delay for clearing an
alarm.
Usage Note
None
Category
Alarm
Security
Provisioning
Command Syntax
SET-ALM-CONTIME:[<TID>]::<CTAG>::[ENTRYTIME=<ENTRYTIME>],
[CLEARTIME=<CLEARTIME>];
Command Parameters
Parameter Description Default
Value
<ENTRYTIME> Indicates the time delay for starting an alarm. The value must be 2
between 0 and 6 (units in seconds).
<CLEARTIME> Indicates the time delay for clearing an alarm. The value must be 10
between 0 and 20 (units in seconds).
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-ALM-CONTIME:::100::ENTRYTIME=3, CLEARTIME=8;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.24.14 RTRV-ALM-CONTIME
D.24.17 RTRV-ALM-ENV
Retrieves environmental alarms.
Function
This command requests an NE to retrieve the specified and outstanding environmental
alarms. This command can be used to retrieve NE information, which then may be used to
update an OS environmental alarm database.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ALM-ENV:[<TID>]:[<ENVAID>]:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Command Parameters
Parameter Description Default Value
this parameter.
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid NA
values are CR (critical alarm), MJ (major alarm), and MN (minor
alarm). All values will be retrieved if nothing is entered for this
parameter.
<ALMTYPE> Indicates the alarm type for the environmental alarm. All values NA
will be retrieved if nothing is entered for this parameter.
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
[^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>][,<ALMMSG>]:[SN=<SN>]"
<cr> <lf>]
;
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid values are CR
(critical alarm), MJ (major alarm), and MN (minor alarm).
<ALMMSG> Indicates the text message associated with the environmental alarm. It consists
of no more than 63 characters.
<SN> Indicates the number of the alarm message. This parameter is valid only for
Huawei EMS.
Example
Command
rtrv-alm-env:::3;
Response Message
NE 2004-07-02 16:57:47
M 3 COMPLD
"ENV-1:MJ,AIRCOND,2004-07-02,16-40-47,\"\""
"ENV-5:MJ,AIRCOND,2004-07-02,16-43-17,\"\""
;
Related Commands
D.24.18 REPT^ALM^ENV
D.24.18 REPT^ALM^ENV
Reports environmental alarms.
Function
This is a message that is automatically generated by the NE to inform the OS of the
occurrence of an environmental alarm.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
<ALMCODE>^<atag>^REPT^ALM^ENV<cr><lf>
^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>],[<OCRTM>]:[<ALMMSG>],
[SN=<SN>]"<cr><lf>
;
Response Parameters
Parameter Description
<ALMCODE> Indicates the attributes of the automatic message based on its action priority.
Valid values in descending order of severities are as follows: *C Critical
alarm, ** Major alarm, *^ Minor alarm, and A^ Automatic Message.
<NTFCNCDE> Indicates the notification code associated with <ALMTYPE>. The valid
values are CR (critical alarm), MJ (major alarm), MN (minor alarm), and CL
(cleared alarm).
Parameter Description
<ALMMSG> Indicates the text message associated with the environmental alarm. It consists
of no more than 63 characters.
<SN> Indicates the number of the alarm message. This parameter is only valid for
Huawei EMS.
Example
Command
None
Response Message
NEW-NE 2014-09-02 18:47:25
*C 4095 REPT ALM ENV
"ENV-1:CR,AIRCOND,2014-09-02,18-47-25,\"Air-condition out of
service\":SN=480016"
;
>
Related Commands
D.24.17 RTRV-ALM-ENV
D.24.19 RTRV-ATTR-<MOD2>
Retrieves the attribute that the event is reported automatically.
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. upon each occurrence of the event.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ATTR-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<LOCN>],[<DIRN>],[<TMPER>],[<SRVEFF>];
Command Parameters
Parameter Description Default Value
<SRVEFF> Indicates whether the alarms impact services. The valid values NA
for <SRVEFF> are as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
A null value is equivalent to ALL.
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<CONDTYPE>,
[<LOCN>],[<DIRN>],[<TMPER>][,<SRVEFF>]" <cr> <lf>
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code specifies the type of notification to be generated
by an NE upon the occurrence of the event described in <CONDTYPE>.
<CONDTYPE> Indicates the type of event for which a notification attribute (<NTFCNCDE>) is
being changed.
<LOCN> Indicates the single location for which an alarm condition is being reported and
refers to the entity identified by the AID. NEND (near end) refers to PM values
obtained at the identified entity. FEND (far end) refers to PM values obtained at
a distant entity that is connected to the identified entity. Likewise, LINE[-x]
refers to an intermediate point.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity
identified by the AID.
<TMPER> Indicates the accumulation time period for the PM information if the
<CONDTYPE> is in a T-x format for a threshold violation.
<SRVEFF> Indicates whether the alarms impact services. The valid values for <SRVEFF>
are as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
Example
Command
RTRV-ATTR-EQPT::SLOT-1-5:c::COMM-FAIL,NEND,,,NSA;
Response Message
NE127-100 1990-01-07 13:50:17
M C COMPLD
"SLOT-1-5,EQPT:MJ,COMM-FAIL,NEND,,,NSA"
;
>
Related Commands
D.24.20 SET-ATTR-<MOD2>
D.24.20 SET-ATTR-<MOD2>
Edits the attributes and state of an alarmed or non-alarmed event.
Function
This command instructs an NE to set the notification code associated with the specified
event. This attribute determines whether the event is reported automatically by the NE upon
each occurrence of the event. For events reported automatically, this command also specifies
whether the event notification is alarmed (reported with a REPORT ALARM) or non-
alarmed (reported with a REPORT EVENT).
Usage Note
None
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
SET-ATTR-<MOD2>: [<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<CONDTYPE>],
[<LOCN>],[<DIRN>],[<TMPER>],[<SRVEFF>];
Command Parameters
Paramete Description Defa
r ult
Valu
e
ODU5G,ODU5GTCM1,ODU5GTCM2,ODU5GTCM3,ODU5GTCM4,ODU5
GTCM5,ODU5GTCM6,ODUFLEX,ODUFLEXTCM1
.
ODUFLEXTCM2,ODUFLEXTCM3,ODUFLEXTCM4,ODUFLEXTCM5,OD
UFLEXTCM6,OMS,OSC,OTS,OTU1,OTU2,OTU3
.
OTU4,OTU5G,PL,SDI,STM1,STM16,STM256,STM4,STM64,WDM,XGETH,
CFPS,OCS,OCHM,OCHS,E1PORT
<NTFCN Indicates the notification code that specifies the type of notification to be generated NA
CDE> by an NE upon the occurrence of the event described in <CONDTYPE>. The
parameter is optional.
<CONDT Indicates the type of event for which a notification attribute (<NTFCNCDE>) is NA
YPE> being changed. The parameter is optional.
<LOCN> Indicates the single location for which an alarm condition is being reported and NA
refers to the entity identified by the AID. NEND (near end) refers to PM values
obtained at the identified entity. FEND (far end) refers to PM values obtained at a
remote entity that is connected to the identified entity. Likewise, LINE[-x] refers to
an intermediate point. The parameter is optional.
NOTE:
This parameter cannot be modified.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity identified NA
by the AID. The parameter is optional.
NOTE:
This parameter cannot be modified.
<TMPER Indicates the accumulation time period for the PM information if the NA
> <CONDTYPE> is in a T-x format for a threshold violation.
NOTE:
It is reserved for future use and thus must be left blank. Otherwise "PARAMETER
ERROR" will be returned.
<SRVEF Indicates whether the alarms impact services. The valid values for <SRVEFF> are NA
F> as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
The parameter is optional.
NOTE:
This parameter cannot be modified.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-ATTR-OC48::FAC-1-2-1:1::CR,LOS,NEND,RCV,,SA;
Response Message
NE 2004-11-09 06:07:54
M 1 COMPLD
;
Related Commands
D.24.19 RTRV-ATTR-<MOD2>
D.24.21 RTRV-ATTR-ENV
Retrieves the attributes of environmental alarms.
Function
This command sends the attributes associated with an environmental alarm. These attributes
are included when an environmental alarm is reported or retrieved.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ATTR-ENV:[<TID>]:<ENVAID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>];
Command Parameters
Parameter Description Default Value
<NTFCNCDE> Indicates the notification code, which specifies the type of the NA
notification to be generated by an NE upon the occurrence of
the event described in <CONDTYPE>. The valid values are CR
(critical alarm), MJ (major alarm), and MN (minor alarm).
<ALMTYPE> Indicates the type of the environmental alarm. All values will be NA
retrieved if nothing is entered for this parameter.
For alarm types, refer to ALARMTYPE
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
<rspblk> + ;
where <rspblk>has the format:
^^^"<AID>:[<NTFCNCDE>,<ALMTYPE>[,<ALMMSG>][,<DEFAULTSTATE>]]" <cr> <lf>
The normal response MUST contain at least one occurrence of <rspblk>.It is
allowed to contain multiple <rspblk>s if applicable.
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code, which specifies the type of the notification to
be generated by an NE upon the occurrence of the event described in
<CONDTYPE>.
The valid values are CR (critical alarm), MJ (major alarm), and MN (minor
alarm).
<ALMMSG> Indicates the text message associated with the environmental alarm specified
by <AID>.
It is a string with no more than 63 characters enclosed within a pair of escape
quotes.
A null value means there are not any message texts for the environmental
alarm.
<DEFAULTSTATE> Indicates the default state of an external control operation. The valid values
are NC and NO.
NC: Normal Close
Parameter Description
Example
Command
RTRV-ATTR-ENV::ENV-1:1;
Response Message
NE 2004-07-15 14:56:12
M 1 COMPLD
"ENV-1:CR,AIRCOND,\"smog_alarm\""
;
>
Related Commands
D.24.22 SET-ATTR-ENV
D.24.22 SET-ATTR-ENV
Sets the attributes of an environmental alarm. These attributes are included when an
environmental alarm is reported or retrieved.
Function
This command sets the attributes of an environmental alarm. These attributes are included
when an environmental alarm is reported or retrieved.
An alarm should be unProvisioninged and users 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 unProvisioninged.
Usage Note
A null value for <NTFCNCDE>, <ALMTYPE>, and <ALMMSG> unassigns the value of
these three parameters; otherwise a null value for <NTFCNCDE> leaves it unchanged.
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
SET-ATTR-ENV:[<TID>]:<ENVAID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>],
[<ALMMSG>],[<DEFAULTSTATE>];
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
Response Parameters
None
Example
Command
SET-ATTR-ENV::ENV-1:1::CR,AIRCOND,"smog_alarm";
Response Message
NE 2004-07-15 14:56:06
M 1 COMPLD
;
>
Related Commands
D.24.21 RTRV-ATTR-ENV
D.24.23 RTRV-ATTR-CONT
Retrieves the attributes of external control operations.
Function
This command retrieves the attributes associated with an external control operation. These
attributes are used when an external control operation is performed or released.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-ATTR-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the external control for which attributes are being NA
retrieved. A value must be entered for AID.
<CONTTYPE> Indicates the type of the external control. All values will be All
retrieved if nothing is entered for this parameter.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
[^^^"<AID>:[<CONTTYPE>][,<DEFAULTSTATE>]" <cr> <lf>]
;
Response Parameters
Parameter Description
<AID> Indicates the external control for which attributes are being retrieved
The valid format is CONT-<N>.
Parameter Description
<CONTTYPE> Indicates the type of the external control. The valid format is CONT-
<CONTTYPE>.
If a value is not entered for this parameter, a control type will not be
assigned.
<DEFAULTSTATE> Indicates the default state of an external control operation. The valid values
are NC and NO.
NC: Normal Close
NO: Normal Open
Example
Command
RTRV-ATTR-CONT:HWNE:CONT-7:100;
Response Message
NE 2004-07-05 20:02:00
M 1 COMPLD
"CONT-7:CONT-AIRCOND"
>
Related Commands
D.24.24 SET-ATTR-CONT
D.24.24 SET-ATTR-CONT
Sets the attributes associated with an external control operation.
Function
These attributes are used when an external control operation is performed or released.
Usage Note
None
Category
Alarms and Conditions
Security
Provisioning
Command Syntax
SET-ATTR-CONT:[<TID>]:<AID>:<CTAG>::[<CONTTYPE>][,<DEFAULTSTATE>];
Command Parameters
Parameter Description Default
Value
<AID> Indicates the external control operation for which attributes are NA
being retrieved. A value must be entered for this parameter.
The valid format is CONT-<N>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>;
Response Parameters
None
Example
Command
SET-ATTR-CONT::CONT-7:1::CONT-AIRCOND;
Response Message
NE 2004-07-15 14:52:58
M 1 COMPLD
;
Related Commands
D.24.23 RTRV-ATTR-CONT
D.24.25 RTRV-ATTR-CONTTM
Retrieves the attributes of the external control.
Function
This command sends the output period associated with an external control operation. The
output period is used when an external control operation is performed or released.
Usage Note
None
Category
Alarm
Security
Retrieve
Command Syntax
RTRV-ATTR-CONTTM:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<CONTAID>:<ALMPERIOD>" <cr> <lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-ATTR-CONTTM::CONT-7:100
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
"CONT-7:300"
Related Commands
D.24.26 SET-ATTR-CONTTM
D.24.26 SET-ATTR-CONTTM
Sets the output period associated with an external control operation. The output period is used
when an external control operation is performed or released.
Function
This command edits the output period associated with an external control operation.
Usage Note
None
Category
Alarm
Security
Provisioning
Command Syntax
SET-ATTR-CONTTM:[<TID>]:<AID>:<CTAG>::<PERIOD>;
Command Parameters
Parameter Description Default Value
<PERIOD> Indicates the value of the output period. The output period 300
must be between 300 ms and 10000 ms. The unit of time is
expressed in milliseconds, and the step length is 100 ms.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-ATTR-CONTTM::CONT-7:100::300;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.24.25 RTRV-ATTR-CONTTM
D.24.27 RTRV-COND-<MOD2>
Retrieves alarm standing conditions.
Function
This command retrieves the current standing condition and state associated with an entity.
Usage Note
None
Category
Alarms and Conditions
Security
Retrieve
Command Syntax
RTRV-COND-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<CONDTYPE>],[<LOCN>],
[<DIRN>],[<TMPER>];
Command Parameters
Parameter Description Default Value
<LOCN> Indicates the single location for which an alarm condition is being NA
reported and refers to the entity identified by <AID>. NEND (near
end) refers to alarm conditions obtained at the identified entity.
FEND (far end) refers to alarm conditions obtained at a remote
Parameter Description Default Value
<DIRN> Indicates the direction of the alarm condition and is relative to the NA
entity identified by <AID>. The valid values are RCV,TRMT. All
values will be retrieved if nothing is entered for this parameter.
<TMPER> Indicates the accumulation time period for the PM information if ALL
the <CONDTYPE> is in the format T-x for a threshold violation.
NOTE:
If users set this parameter to 15-MIN or 1-DAY, the threshold violation
alarms of the specified period are returned. If users set this parameter to
TMP-ALL, the threshold violation alarms of all periods are returned.
If users use a default parameter, the threshold violation alarms of all
periods and common alarms without period types are returned.
Response Syntax
<SID><DATE><TIME>
M CTAG COMPLD
^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<CONDTYPE>,[<SRVEFF>],[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<TMPER>]:[<CONDDESCR>],[<AIDDET>]:[SN=<SN>]"
;
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid values are CR
(Critical Alarm), MJ (Major Alarm), MN (Minor Alarm), NA (Not Alarmed),
NR (Not Reported).
<SRVEFF> Indicates whether the alarms impact services. The valid values are as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
<LOCN> Indicates the single location for which an alarm condition is being reported
and refers to the entity identified by <AID>.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity
identified by <AID>.
Parameter Description
<TMPER> Indicates the accumulation time period for the PM information if the
<CONDTYPE> is in a T-x format for a threshold violation.
<CONDDESCR> Indicates the text message associated with the alarm condition. It consists of
no more than 63 characters.
<SN> Indicates the number of the SC event message. This parameter is valid only
for Huawei EMS.
Example
Command
RTRV-COND-EQPT::SLOT-1-3:1::RMV,NEND,RCV;
Response Message
NE 2004-11-09 05:54:51
M 1 COMPLD
"SLOT-1-3,EQPT:CR,RMV,SA,2004-11-09,05-36-39,NEND,RCV,:\"Equipment
offline or uninstalled\","
;>
Related Commands
D.24.8 REPT^ALM^<MOD2>
D.24.9 REPT^EVT^<MOD2>
D.24.13 RTRV-ALM-<MOD2>
D.24.18 REPT^ALM^ENV
D.24.17 RTRV-ALM-ENV
D.24.28 OPR-ACO-ALL
Cuts off all audible alarms.
Function
This command cuts off audible alarm indications without changing local alarm indications.
This command is applicable to only the current alarms and does not impact future audible
alarms on the NE. The NE should be able to transmit its current alarms or status conditions if
the NE is retrieved by the OS.
Usage Note
None
Category
Environment
Security
Provisioning
Command Syntax
OPR-ACO-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
OPR-ACO-ALL:::1;
Response Message
NE 2004-11-09 09:01:13
M 1 COMPLD
;
Related Commands
None
D.24.29 OPR-ALM-CONFIRM
Confirm the TL1 alm.
Function
The command is to confirm the TL1 alm.
Usage Note
None
Category
ALM
Security
Retrieve
Command Syntax
OPR-ALM-CONFIRM:[<TID>]::<CTAG>::<ALM_NOTIFYID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
OPR-ALM-CONFIRM:::100::1&2&16;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
D.24.30 RTRV-ALM-CONFIRM
Retrieves whether enable the function of TL1 alm confirm.
Function
This command retrieves whether enable the function of TL1 alm confirm.
Usage Note
None
Category
ALM
Security
Retrieve
Command Syntax
RTRV-ALM-CONFIRM:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^<ENFLAG><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-ALM-CONFIRM:::100;
Response Message
NE 2010-04-24 17:47:13
M 100 COMPLD
"ENABLE"
;
D.24.31 ED-ALM-CONFIRM
Enable the function of TL1 alm confirm.
Function
This command enable the function of TL1 alm confirm.The user who longin the NE just can
set the attribute for himself.When he logout,the attribute of his own will be disable.It needs
that he resets the attribute when he login again.
Usage Note
None
Category
ALM
Security
Retrieve
Command Syntax
ED-ALM-CONFIRM:[<TID>]::<CTAG>::<ENFLAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-ALM-CONFIRM:::100::ENABLE;
Response Message
NE 2010-04-24 17:47:26
M 100 COMPLD
;
Related Commands
None
D.24.32 RTRV-COND-FROMBD
Retrieves alarm standing conditions by board.
Function
This command retrieves the current standing condition and state associated with an board.
Usage Note
None
Category
Alarms and Conditions
Security
Maintenance
Command Syntax
RTRV-COND-FROMBD:[<TID>]:<ALMBID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<SID><DATE><TIME>
M CTAG COMPLD
^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<ALMSTATE>,<CONDTYPE>,[<SRVEFF>],
[<OCRDAT>],[<OCRTM>],[<LOCN>],
[<DIRN>]:<PARALEN>,<APPPARALEN>,<INPARALEN>:<PARAINFO>"
;
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid values are CR
(Critical Alarm), MJ (Major Alarm), MN (Minor Alarm), NA (Not Alarmed), and
NR (Not Reported),and CL (Cleared Alarm).
<ALMSTATE> Indicates the alarm state.The valid values are
START,CONTINUE,END,INHIBITED,NOT_MONITOR,START_WOBBLE,EN
D_WOBBLE.
Parameter Description
<SRVEFF> Indicates whether the alarms impact services. The valid values are as follows:
NSA: The condition does not affect the services.
SA: The condition affects the services.
<LOCN> Indicates the single location for which an alarm condition is being reported and
refers to the entity identified by <AID>.The valid values are NEND,FEND.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity identified
by <AID>.The valid values are RCV,TRMT.
Example
Command
RTRV-COND-FROMBD::SLOT-1-3:1;
Response Message
NE 2004-11-09 05:54:51
M 1 COMPLD
"SLOT-1-3,EQPT:CR,START,RMV,SA,2004-11-09,05-36-39,NEND,RCV:2,0,0:00 03"
;>
Related Commands
D.24.8 REPT^ALM^<MOD2>
D.24.9 REPT^EVT^<MOD2>
D.24.13 RTRV-ALM-<MOD2>
D.24.18 REPT^ALM^ENV
D.24.17 RTRV-ALM-ENV
D.24.33 RTRV-ALLCOND-<MOD2>
Retrieves alarm standing conditions.
Function
This command retrieves the current standing condition and state associated with an entity.
Usage Note
None
Category
ALM
Security
Maintenance
Command Syntax
RTRV-ALLCOND-<MOD2>:[<TID>]:[<AID>]:<CTAG>::[<CONDTYPE>],[<LOCN>],
[<DIRN>],[<TMPER>];
Command Parameters
Parameter Description Default Value
<TMPER> Indicates the accumulation time period for the PM information if ALL
the CONDTYPE is in the format T-x for a threshold violation. If
users set this parameter to 15-MIN or 1-DAY, the threshold
violation alarms of the specified period are returned. If users set
this parameter to TMP-ALL, the threshold violation alarms of all
periods are returned. If users use a default parameter, the
threshold violation alarms of all periods and common alarms
without period types are returned.
Response Syntax
<SID><DATE><TIME>
M CTAG COMPLD
^^^"[<AID>][,<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,<ALMSTA>,[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<DIRN>],[<TMPER>]:[<CONDDESCR>],[<AIDDET>]:[SN=<SN>]"
Response Parameters
Parameter Description
<NTFCNCDE> Indicates the notification code of the retrieved alarm. The valid values are CR
(Critical Alarm), MJ (Major Alarm), MN (Minor Alarm), and CL (Cleared
Alarm).
<SRVEFF> Indicates whether the alarms impact services. The valid values are as follows:
NSA: The condition does not affect the services. SA: The condition affects the
services.
<ALMSTA> Indicates state of the retrieved alarm. The valid values are as follows: START,
INHIBIT, INVERSE, INHIBITING, or INH-INV.
<OCRDAT> Indicates the date when the triggering event occurs.
<LOCN> Indicates the single location for which an alarm condition is being reported and
refers to the entity identified by AID.
<DIRN> Indicates the direction of the alarm condition and is relative to the entity
identified by AID.
<TMPER> Indicates the accumulation time period for the PM information if the
CONDTYPE is in a T-x format for a threshold violation.
<CONDDESCR> Indicates the text message associated with the alarm condition. It consists of no
more than 63 characters.
<AIDDET> Indicates the supplementary equipment identification used to identify the location
of the reported fault. This parameter is used in conjunction with AID.
<SN> Indicates the number of the SC event message. This parameter is valid only for
Huawei EMS.
Example
Command
RTRV-ALLCOND-EQPT::SLOT-1-3:1::RMV,NEND,RCV;
Response Message
NE 2004-07-09 17:27:49
M 100 COMPLD
"SLOT-1-3,EQPT:CR,RMV,SA,2004-07-09,14-04-44,NEND,RCV,:"Equipment
offline or uninstalled"
;
Related Commands
D.24.8 REPT^ALM^<MOD2>
D.24.9 REPT^EVT^<MOD2>
D.24.27 RTRV-COND-<MOD2>
D.24.18 REPT^ALM^ENV
D.24.17 RTRV-ALM-ENV
D.25.1 DLT-SYSLOG-SERVER
Delete the server which receives the syslog.
Function
This command is issued to delete the server which receives the syslog.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
DLT-SYSLOG-SERVER:[<TID>]::<CTAG>::<SYSLOG_SERVER_IP>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-SYSLOG-SERVER:::100::129.9.0.1;
Response Message
TNE1505 2010-04-25 17:47:26
M 100 COMPLD
Related Commands
None
D.25.2 ED-SYSLOG-SERVER
Modify the attribute of the server which receives the syslog.
Function
This command is issued to modify the attribute of the server which receives the syslog.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
ED-SYSLOG-SERVER:
[<TID>]::<CTAG>::<SYSLOG_SERVER_IP>,<SYSLOG_SEND_MODE>,<SYSLOG_SE
RVER_PORT>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-SYSLOG-SERVER:::100::129.9.0.1,UDP,514;
Response Message
TNE1505 2010-04-25 17:47:26
M 100 COMPLD
Related Commands
None
D.25.3 ENT-SYSLOG-SERVER
Add the server to receive the syslog.
Function
This command is issued to add the server to receive the syslog.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
ENT-SYSLOG-SERVER:
[<TID>]::<CTAG>::<SYSLOG_SERVER_IP>,<SYSLOG_SEND_MODE>,<SYSLOG_SE
RVER_PORT>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-SYSLOG-SERVER:::100::129.9.0.1,UDP,514;
Response Message
TNE1505 2010-04-25 17:47:26
M 100 COMPLD
Related Commands
None
D.25.4 RTRV-SYSLOG-SERVER
Retrieve the server list which receives the syslog.
Function
This command is issued to retrieve the server list which receives the syslog.
Usage Note
None
Category
SYSLOG
Security
Maintenance
Command Syntax
RTRV-SYSLOG-SERVER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^<SYSLOG_SERVER_IP>,<SYSLOG_SEND_MODE>,<SYSLOG_SERVER_PORT><cr><lf>
;
Response Parameters
Parameter Description
<SYSLOG_SERVER_IP> the ip of the server which receives the syslog.The value is UDP or
TCP or TLS.
Example
Command
RTRV-SYSLOG-SERVER:::100;
Response Message
TNE1505 2010-04-24 17:47:13
M 100 COMPLD
"129.9.0.1,UDP,514"
"129.9.0.2,TCP,601"
"129.9.0.3,TCP,601"
;
Related Commands
D.23.9 SET-PMDAY
D.25.5 ED-SYSLOG-STATE
Enable the function of syslog.
Function
This command enable the function of syslog.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
ED-SYSLOG-STATE:[<TID>]::<CTAG>::<SYSLOG_ENFLAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-SYSLOG-STATE:::100::ENABLE;
Response Message
NE 2010-04-24 17:47:26
M 100 COMPLD
;
Related Commands
None
D.25.6 RTRV-SYSLOG-STATE
Retrieve whether enable the function of syslog.
Function
This command retrieves whether enable the function of syslog.
Usage Note
None
Category
SYSLOG
Security
Maintenance
Command Syntax
RTRV-SYSLOG-STATE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^<ENFLAG><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SYSLOG-STATE:::100;
Response Message
NE 2010-04-24 17:47:13
M 100 COMPLD
"ENABLE"
;
D.25.7 DLT-SYSLOG-LOGGROUP
Delete the facility and the severity of the log which will transfer to the syslog server.
Function
This command is issued to delete the facility and the severity of the log which will transfer to
the syslog server.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
DLT-SYSLOG-LOGGROUP:
[<TID>]::<CTAG>::<SYSLOG_FACILITY>,<SYSLOG_SEVERITY>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-SYSLOG-LOGGROUP:::100::4,1;
Response Message
TNE1505 2010-04-24 17:47:26
M 100 COMPLD
Related Commands
None
D.25.8 ENT-SYSLOG-LOGGROUP
Add the facility and the severity of the log which will transfer to the syslog server.
Function
This command is issued to add the facility and the severity of the log which will transfer to
the syslog server.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
ENT-SYSLOG-LOGGROUP:
[<TID>]::<CTAG>::<SYSLOG_FACILITY>,<SYSLOG_SEVERITY>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ENT-SYSLOG-LOGGROUP:::100::4,1;
Response Message
TNE1505 2010-04-24 17:47:26
M 100 COMPLD
Related Commands
None
D.25.9 RTRV-SYSLOG-LOGGROUP
Retrieve the list of the facility and the severity of the log which will transfer to the syslog
server.
Function
This command is issued to retrieve the list of the facility and the severity of the log which
will transfer to the syslog server.
Usage Note
None
Category
SYSLOG
Security
Maintenance
Command Syntax
RTRV-SYSLOG-LOGGROUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^FACILITY=<SYSLOG_FACILITY>,SEVERITY=<SYSLOG_SEVERITY><cr><lf>
;
Response Parameters
Parameter Description
<SYSLOG_FACILITY> the facility of the log which will transfer to the syslog server.The value is
4 or 16.
<SYSLOG_SEVERITY> the severity of the log which will transfer to the syslog server.
Example
Command
RTRV-SYSLOG-LOGGROUP:::100;
Response Message
TNE1505 2010-04-24 17:47:13
M 100 COMPLD
"FACILITY=4,SEVERITY=0"
"FACILITY=4,SEVERITY=1"
"FACILITY=4,SEVERITY=2"
"FACILITY=4,SEVERITY=3"
;
Related Commands
D.23.9 SET-PMDAY
D.25.10 DLT-SYSLOG-CERT
Delete the CA certificate of given server which receives the syslog.
Function
This command is issued to delete the CA certificate of given server which receives the
syslog.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
DLT-SYSLOG-CERT:[<TID>]::<CTAG>::<SYSLOG_CERT_NAME>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
DLT-SYSLOG-CERT:::100::"CA0.CRT";
Response Message
TNE1505 2010-04-25 17:47:26
M 100 COMPLD
Related Commands
None
D.25.11 RTRV-SYSLOG-CERT
Retrieve the CA certificate list of servers which receives the syslog.
Function
This command is issued to retrieve the CA certificate list of servers which receives the
syslog.
Usage Note
None
Category
SYSLOG
Security
Super
Command Syntax
RTRV-SYSLOG-CERT:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^<SYSLOG_CERT_NAME>,<SYSLOG_CERT_BEGINTIME>,<SYSLOG_CERT_ENDTIME>,<SYSLOG
_CERT_ISSUER><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SYSLOG-CERT:::S;
Response Message
2013-11-16 01:35:25
M S COMPLD
"CA0.CRT,2009-01-09 09-45-12,2019-01-07 09-45-12,Huawei"
;
Related Commands
D.23.9 SET-PMDAY
D.25.12 RTRV-LOG-OCP
Retrieves the OCP event records.
Function
This command retrieves the OCP event records.
Usage Note
None
Category
equipment
Security
Maintenance
Command Syntax
RTRV-LOG-OCP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ^^^"<OCPLOG>";
Response Parameters
Parameter Description
Example
Command
RTRV-LOG-OCP:::100;
Response Message
NE-122-23 2014-03-17 10:55:02
M K COMPLD
"OCPLOG";
Related Commands
None
D.26 Configuring LPT
This section lists the commands used to configure the LPT function.
D.26.1 ED-LPT
Edits the LPT function.
Function
This command edits the LPT function.
Usage Note
None
Category
Equipment
Security
Provisioning
Command Syntax
ED-LPT:[<TID>]:<AID>:<CTAG>::<LPTENABLE>:[RFSHUTLSR=<RFLPTSHUTLSR>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-LPT::FAC-1-1-1:100::ENABLE;
ED-LPT::FAC-1-1-1:100:::RFSHUTLSR=DISABLE;
Response Message
NE 2014-06-23 11:37:18
M 100 COMPLD
;
Related Commands
D.26.2 RTRV-LPT
D.26.2 RTRV-LPT
Retrieves the LPT function.
Function
This command retrieves all attributes of the LPT function.
Usage Note
None
Category
Equipment
Security
Retrieve
Command Syntax
RTRV-LPT:[<TID>]:[<AID >]:<CTAG>;
Command Parameters
Parameter Description
<AID> Indicates the equipment unit identifier. The valid format is FAC-<SHELF ID>-<SLOT
ID>-<PORT ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ^^^
(" <AID>::LPTENABLE=<LPTENABLE>:RFSHUTLSR=<RFLPTSHUTLSR> ")
;
Response Parameters
Parameter Description
<AID> Indicates the equipment unit identifier. The valid format is FAC-<SHELF ID>-
<SLOT ID>-<PORT ID>.
<LPTENABLE> Indicates the status of the LPT function. The valid values are ENABLE and
DISABLE.
<RFSHUTLSR> indicates whether REMOTE-FAULT is the LPT condition to shut laser. It can be
ENABLE and DISABLE.
Example
Command
RTRV-LPT::FAC-1-1-1:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
"FAC-1-1-1::LPTENABLE=ENABLE:RFSHUTLSR=ENABLE"
;
Related Commands
D.26.1 ED-LPT
D.27 Configuring Loopback
This section lists the commands used to check the connection between two points by the
loopback method.
D.27.1 OPR-LPBK-<MOD2>
Operates a loopback at a specified port or on a specified path.
Function
This command instructs an NE to operate a loopback at a specified port or on a specified
path. The loopback performs either at the near or far end of the line. The specified entity must
be in a state that allows a loopback to occur; otherwise, the NE will return an error response.
Usage Note
To operate a loopback, the state of the port/path must be OOS-MA, MT. Use D.6.29 RMV-
<MOD2> to change the state of the specified port/path to the out of service - maintenance
state (OOS-MA, MT).
This command cannot be used to loop back an Ethernet link.
Category
Loopback
Security
Maintenance
Command Syntax
OPR-LPBK-<MOD2>:[<TID>]:<AID>:<CTAG>::,,,[<LPBKTYPE>];
Command Parameters
Parameter Description Default Value
<AID> Indicates the access identifier that identifies the port or path. NA
If <AID> is the ID of the path, it indicates the cross-connect
loopback.
FAC/CLNT/SRVN-<SHELF ID>-<SLOT ID>-
<PORT ID>-<PATH/CHANNEL ID>
FAC/CLNT/SRVN-<SHELF ID>-<SLOT ID>-
Parameter Description Default Value
<PORT ID>
Refer to OC, OCH ODUN and OSC for the valid values of
<AID> for specific units.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
OPR-LPBK-OCH::FAC-1-7-1:c::,,,FACILITY;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.27.3 RTRV-LPBK-<MOD2>
D.27.2 RLS-LPBK-<MOD2>
D.6.29 RMV-<MOD2>
D.6.30 RST-<MOD2>
D.27.2 RLS-LPBK-<MOD2>
Releases the loopback at a specified port or on a specified path.
Function
This command instructs an NE to release a loopback on a specified port or path.
Usage Note
Users can configure the port or path by using D.6.30 RST-<MOD2> to exit the maintenance
state after releasing the loopback on a specified port or path.
Category
Loopback
Security
Maintenance
Command Syntax
RLS-LPBK-<MOD2>:[<TID>]:<AID>:<CTAG>;
Command Parameters
NA
<AID> Indicates the access identifier of the port.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
RLS-LPBK-OCH::FAC-1-6-1:C;
Response Message
NE 2008-06-01 15:38:18
M C COMPLD
;
Related Commands
D.27.1 OPR-LPBK-<MOD2>
D.27.3 RTRV-LPBK-<MOD2>
D.6.29 RMV-<MOD2>
D.6.30 RST-<MOD2>
D.27.3 RTRV-LPBK-<MOD2>
Retrieves the loopback state of the port or channel.
Function
This command retrieves the loopback state of the port or channel.
Usage Note
None
Category
Loopback
Security
Retrieve
Command Syntax
RTRV-LPBK-<MOD2>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::LPBKTYPE=<LPBKTYPE>"<cr><lf>
;
Response Parameters
Parameters Description
<MOD2> OC, OCH, ODU0, ODU1, ODU2, ODUFLEX, OSC, WDM, EC,
CFP,OCHM,E1PORT.
<AID> Indicates the access identifier that identifies the Ethernet facility. The valid
formats are as follows:
FAC/CLNT/SRVN-<SHELF ID>-<SLOT ID>-<PORT ID>-
<CHANNEL ID>
FAC/CLNT/SRVN-<SHELF ID>-<SLOT ID>-<PORT ID>
<LPBKTYPE> Indicates the loopback type. The valid values are FACILITY and
TERMINAL.
Example
Command
RTRV-LPBK-OC::FAC-1-2-1:100;
Response Message
NE 2004-01-01 13:40:05
M 100 COMPLD
"FAC-1-2-1::LPBKTYPE=FACILITY"
;
Related Commands
D.27.1 OPR-LPBK-<MOD2>
D.27.2 RLS-LPBK-<MOD2>
D.27.4 ED-BDXCLOOP
Edits the board's cross-connection loopback function.
Function
This command edits the board's cross-connection loopback function.
Usage Note
None
Category
Equipment
Security
Provisioning
Command Syntax
ED-BDXCLOOP:[<TID>]:<AID>:<CTAG>::<LOOPENABLE>;
Command Parameters
Response Parameters
None
Example
Command
ED-BDXCLOOP::SLOT-1-1:100::ENABLE;
Response Message
NE 2004-01-01 11:37:18
M 100 COMPLD
;
Related Commands
D.27.5 RTRV-BDXCLOOP
D.27.5 RTRV-BDXCLOOP
Retrieves the board's cross-connection loopback function.
Function
This command retrieves all attributes of the board's cross-connection loopback function.
Usage Note
None
Category
Equipment
Security
Retrieve
Command Syntax
RTRV-BDXCLOOP:[<TID>]:[<AID >]:<CTAG>;
Command Parameters
Parameter Description
<AID> Indicates the equipment unit identifier. The valid format is SLOT-<SHELF ID>-<SLOT
ID>.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf> ^^^
(" <AID>::BDXCLOOP=<LOOPENABLE> ")
;
Response Parameters
Parameter Description
<AID> Indicates the equipment unit identifier. The valid format is FAC-<SHELF ID>-
<SLOT ID>-<PORT ID>.
<LOOPENABLE> Indicates the status of the board's cross-connection loopback function. The valid
values are ENABLE and DISABLE.
Example
Command
RTRV-BDXCLOOP::SLOT-1-1:C;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
"SLOT-1-1::BDXCLOOP=ENABLE"
;
Related Commands
D.27.4 ED-BDXCLOOP
D.28 Connection Test
This section lists the commands used to test the connection by transmitting and detecting the
bit sequence between two points.
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
Sets up the bit sequence test connection.
Function
This command sets up the bit sequence test connection and the necessary parameters for the
internal bit sequence generator and detector.
Usage Note
OTUN includes OTU1, OTU2, OTU3, OTU4 and OTU5G. ODUN includes ODU2. OCN
includes OC3, OC12, OC48, OC192 and OC768. STMN includes STM1, STM4, STM16,
STM64 and STM256. They refer to the PRBS signals that the SONET card
generates,E1PORT.
A corresponding sustained condition is raised during the test. When the elapsed time
in the REPT event is equal to the duration assigned by the CONN-TST-
<OTUN/ODUN/OCN/STMN> command, the test status (running or stop, indicating
whether the corresponding facility is under the bit sequence test) can be determined
and the test connection can be released automatically.
When the test signals are unframing, the opposite side must be set to the PRBS mode.
The OCN/STMN PRBS frame header that the SONET card generates is incorrect.
Hence, when the SONET card is used for the PRBS test, the PRBS test function of
the corresponding service add/drop channels should be enabled so that the
nonstandard OCN/STMN PRBS frame header can be received.
The port must be in the maintenance state before this command is executed.
Category
Facility
Security
Maintenance
Command Syntax
CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>:[<TID>]:<AID>:<CTAG>::
[TSTMOD],[<TSTSIG>],[<DIR>],[<DUR>][<RI>];
Command Parameters
Default
Parameters Description Value
<TSTMOD> Indicates the test mode. The valid values are as follows: SPLTE
SPLTE: transmitting PRBS to the port side
SPLTF: transmitting PRBS to the system side
<TSTSIG> Indicates the test signal type. The valid values are PRBS and NULL- PRBS
CLIENT.
NOTE:
NULL-CLIENT is only valid for OTUN.
<DIR> Indicates the direction of PRBS test. The valid value is IN or OUT. OUT
IN indicates the test is towards inside the port. OUT indicates the test is
Default
Parameters Description Value
<DUR> Indicates the duration of the bit sequence test (in seconds). 0
The expected time ranges from 0 to 9999*60 seconds.
"0" (CO) indicates that the test will continue until terminated by
the D.28.3 DISC-TST-
<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT> command.
This parameter is valid only when <TSTSIG> is set to PRBS.
<RI> Indicates the report interval in seconds. The valid value ranges from 1 to 1
3600.
This parameter is valid only when <TSTSIG> is set to PRBS.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
CONN-TST-OTU1::FAC-1-3-1:C::,PRBS;
Response Message
NE 2004-01-01 11:37:18
M C COMPLD
;
Related Commands
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.6 RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.2 CONN-TST-<40GETH/100GETH>
Sets the attributes of Ethernet test frames and starts Ethernet service testing.
Function
This command sets the test frames of 40GE or 100GE Ethernet services.
Usage Note
The port must be in the maintenance state before this command is executed.
Category
Facility
Security
Maintenance
Command Syntax
CONN-TST-<40GETH/100GETH>:
[<TID>]:<AID>:<CTAG>::<TSTMOD>,<SENDMOD>,<PKTTYPE>,<PKTNUM>,<PKTLE
N>;
Command Parameters
Default
Parameters Description Value
<TSTMOD> Indicates the requested test mode similar to the test access mode. There is no
The valid values are as follows: default
SPLTE: transmitting test signals to the port side value.
SPLTF: transmitting test signals to the system side
<SENDMOD> Indicates the current test mode. The valid values are as follows: There is no
IDLE default
CONTINUOUS value.
BURST
NOTE:
At present, the value of this parameter can be CONTINUOUS only.
<PKTTYPE> Indicates the packet type of a test frame. The valid values are There is no
RANDOM or FIXED. default
RANDOM: indicates that the packet length is random. value.
FIXED: indicates that the packet length is fixed.
<PKTNUM> Indicates the packet number of a test frame, ranging from 1 to There is no
4294967295. This parameter is valid only when the value of default
<SENDMOD> is set to BURST. value.
<PKTLEN> Indicates the packet length of a test frame. The TN12LSC ranges There is no
from 1024 to 9600, and the TN54TSXL ranges from 64 to 1518. default
This parameter is valid only when the value of <PKTTYPE> is value.
Default
Parameters Description Value
FIXED.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
conn-tst-40geth::fac-1-24-3:w::splte,continuous,fixed,1000,1518;
Response Message
NE 2004-01-01 11:37:18 M C COMPLD ;
Related Commands
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.6 RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.3 DISC-TST-
<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
Releases a test connection.
Function
This command instructs the NE to release a test connection.
Usage Note
OTUN includes OTU1, OTU2, OTU3, OTU4 and OTU5G. ODUN includes ODU2. OCN
includes OC3, OC12, OC48, OC192 and OC768. STMN includes STM1, STM4, STM16,
STM64 and STM256,E1PORT. They refer to the PRBS signals that the SONET card
generates.
Category
Facility
Security
Maintenance
Command Syntax
DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>:[<TID>]:
[<AID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Example
Command
DISC-TST-OTU1::FAC-1-5-1:100;
Response Message
NE 2004-01-01 11:37:18
M 100 COMPLD
;
Related Commands
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.6 RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
Retrieves the result of bit sequence test connection.
Function
This command retrieves the result of bit sequence test connection with all necessary settings
for the internal bit sequence generator and detector.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>:[<TID>]:<AID>:<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::IPFLAG=<IPFLAG>,ST=<ST>,ET=<ET>,ESLSS=<ESLSS>,TBE=<TBE>"
;
Response Parameters
Parameters Description
<IPFLAG> Indicates the flag that identifies whether the test is in process or completed.
The valid values are IP (in progress) and COMPLD (completed).
<ST> Indicates the start time of the testing. The valid format is YYYY-MM-DD
HH-MM-SS.
<ESLSS> Indicates the errored seconds count based on LSS (loss of sequence
synchronization) detected.
Example
Command
RTRV-RSLT-OTU1::FAC-1-6-1:C;
Response Message
NE 2004-01-01 03:29:41
M C COMPLD
"FAC-1-6-1::IPFLAG=IP,ST=2008-11-18 14-10-10,ET=60,ESLSS=13,TBE=0"
;
Related Commands
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.6 RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.5 RTRV-RSLT-<40GETH/100GETH>
Queries Ethernet frame testing results.
Function
This command queries Ethernet frame testing results.
Usage Note
None
Category
Facility
Security
Retrieve
Command Syntax
RTRV-RSLT-<40GETH/100GETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::IPFLAG=<IPFLAG>,TXOCTETS=<TXOCTETS>,TXETHFCS=<TXETHFCS>,RXOCTETS
=<RXOCTETS>,RXETHFCS=<RXETHFCS>" ;
Response Parameters
Parameters Description
<IPFLAG> Indicates the flag that identifies whether the test is in process or completed.
Parameters Description
Example
Command
rtrv-rslt-40geth::fac-1-24-3:w;
Response Message
NE 2011-11-07 11:55:04 M C COMPLD "FAC-1-24-
3::IPFLAG=IP,TXOCTETS=124153261056,TXETHFCS=0,RXOCTETS=97206441570,RXETHFCS
=0" ;
Related Commands
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.6 RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.6 RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
Retrieves the bit sequence test connection.
Function
This command retrieves the bit sequence test connection.
Usage Note
OTUN includes OTU1, OTU2, OTU3, OTU4 and OTU5G. ODUN includes ODU2. OCN
includes OC3, OC12, OC48, OC192 and OC768. STMN includes STM1, STM4, STM16,
STM64 and STM256,E1PORT. They refer to the PRBS signals that the SONET card
generates.
This command is successfully completed only when the entity is in the testing state;
otherwise, an error will be returned.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-TST-<OTUN/ODUN/OCN/STMN/E1PORT>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^" <AID>::TSTMOD=<TSTMOD>,TSTSIG=<TSTSIG>,[DIR=<DUR>],[DIR=<DUR>],
[RI=<RI>]"<cr><lf>
;
Response Parameters
Parameters Description
<TSTMOD> Indicates the test mode. The valid values are as follows:
SPLTE: transmitting PRBS to the port side
SPLTF: transmitting PRBS to the system side
<TSTSIG> Indicates the test signal type. The valid values are PRBS and NULL-CLIENT.
<DIR> Indicates the direction of PRBS test. The valid value is IN or OUT. IN indicates
the test is towards inside the port. OUT indicates the test is towards outside the
port.
<DUR> Indicates the duration of the bit sequence test (in seconds). This parameter is
valid only when <TSTSIG> is set to PRBS.
The expected time ranges from 0 to 9999*60 seconds.
"0" (CO) indicates that the test will continue until terminated by the D.28.3
DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT> comm
and.
<RI> Indicates the report interval (in seconds). This parameter is valid only when
<TSTSIG> is set to PRBS.
The valid value ranges from 1 to 3600.
Example
Command
RTRV-TST-OTU1::FAC-1-3-1:C;
Response Message
NE 2008-11-01 14:30:00
M C COMPLD
"FAC-1-3-1::TSTMODE=SPLTE,TSTSIG=PRBS,DIR=OUT,DUR=0,RI=1"
;
Related Commands
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.7 RTRV-TST-<40GETH/100GETH>
Queries the attributes of Ethernet test frames.
Function
This command queries the attributes of Ethernet test frames.
Usage Note
This command is successfully completed only when the entity is in the testing state;
otherwise, an error will be returned.
Category
Facility
Security
Retrieve
Command Syntax
RTRV-TST-<40GETH/100GETH>:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Parameters
Parameters Description
<TSTMOD> Indicates the requested test mode similar to the test access mode. The valid
values are as follows:
SPLTE: transmitting test signals to the port side
SPLTF: transmitting test signals to the system side
<SENDMOD> Indicates the current test mode. The valid values as follows:
IDLE
CONTINUOUS
BURST
<PKTTYPE> Indicates the packet type of a test frame. The valid values are RANDOM or
FIXED.
RANDOM: indicates that the packet length is random.
FIXED: indicates that the packet length is fixed.
<PKTNUM> Indicates the packet number of a test frame, ranging from 1 to 4294967295.
<PKTLEN> Indicates the packet length of test frame. The TN12LSC ranges from 1024 to
9600, and the TN54TSXL ranges from 64 to 1518.
Example
Command
RTRV-TST-40geth::fac-1-24-3:D;
Response Message
NE 2011-11-07 11:54:54 M C COMPLD "FAC-1-24-
3::TSTMODE=SPLTE,SENDMOD=CONTINUOUS,PKTTYPE=FIXED,PKTNUM=0,PKTLEN=1518" ;
Related Commands
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.8 REPT^EVT^PRBS
D.28.8 REPT^EVT^PRBS
Reports the bit sequence test result.
Function
This autonomous message is used to report the bit sequence test result.
Usage Note
None
Category
Test
Security
Maintenance
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
<ALMCODE>^^<ATAG>^REPT^EVT^PRBS<cr><lf>
^^^<AID>:IPFLAG=<IPFLAG>,ST=<ST>,ET=<ET>,ESLSS=<ESLSS>[-<OC>],TBE=<TBE>[-
<OC>];<cr><lf>
;
Response Parameters
Parameters Description
<IPFLAG> Indicates whether the test is in process or completed. The valid values are IP
(in progress) and COMPLD (completed).
<ST> Indicates the start time of the testing. The valid format is \"YYYY-MM-DD
HH-MM-SS\".
<ESLSS> Indicates the errored seconds count based on LSS (loss of sequence
synchronization) detected. If the count reaches the maximum, a literal "OC" is
added following it.
<TBE> Indicates the total bit error count (32-bit counter). If the count reaches the
maximum, a literal "OC" is added following it.
Example
Command
None
Response Message
NE 2008-06-21 11:37:18
A C REPT RSLT OC48
"FAC-1-1-1::IPFLAG=IP,ST="2008-11-18 14-10-10",ET=60,ESLSS=13,TBE=0"
Related Commands
D.28.1 CONN-TST-<OTUN/ODUN/OCN/STMN/E1PORT>
D.28.3 DISC-TST-<OTUN/ODUN/OCN/STMN/40GETH/100GETH/E1PORT>
D.28.4 RTRV-RSLT-<OTUN/ODUN/OCN/STMN/E1PORT>
D.29 Configuring Orderwire
D.29.1 DLT-CRS-E1
Deletes a cross-connection (E1).
Function
This command deletes an E1 layer cross-connection.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
DLT-CRS-E1:[<TID>]:<FROM>,<TO>:<CTAG>:::[INCL=<INCL>];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
Example
Command
DLT-CRS-E1::FAC-1-1-1,FAC-1-3-1:C:::INCL=Y;
Response Message
NE714 2009-09-21 10:58:17
M C COMPLD
Related Commands
D.29.3 ENT-CRS-E1
D.29.2 ED-CRS-E1
D.29.4 RTRV-CRS-E1
D.29.2 ED-CRS-E1
Edits a cross-connection(E1).
Function
This command edits the attributes of a cross-connection(E1).
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
ED-CRS-E1:[<TID>]:<FROM>,<TO>:<CTAG>::::,[<SST>];
Command Parameters
Parameters Description Default Value
<SST> Indicates the red-lined state. The valid values are provided in RDLD-DEA
section SST_STATE.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
ED-CRS-E1::FAC-1-1-1,FAC-1-3-1:C::::,RDLD;
Response Message
NE 2003-02-28 12:23:50
M 100 COMPLD
;
Related Commands
D.29.3 ENT-CRS-E1
D.29.1 DLT-CRS-E1
D.29.4 RTRV-CRS-E1
D.29.3 ENT-CRS-E1
Creates a cross-connection (E1).
Function
This command creates an E1 layer cross-connection.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
ENT-CRS-E1:[<TID>]:<FROM>,<TO>:<CTAG>::::,<SST>;
Command Parameters
Parameters Description Default Value
<SST> Indicates the red-lined state. The valid values are shown in RDLD-DEA
section SST_STATE.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
Example
Command
ENT-CRS-E1::FAC-1-1-1,FAC-1-3-1:C::::,RDLD;
Response Message
NE714 2009-09-21 10:58:17
M C COMPLD
Related Commands
D.29.1 DLT-CRS-E1
D.29.2 ED-CRS-E1
D.29.4 RTRV-CRS-E1
D.29.4 RTRV-CRS-E1
Retrieves information on a cross-connection (E1).
Function
This command retrieves the information on an E1 layer cross-connection.
Usage Note
None
Category
Orderwire
Security
Retrieve
Command Syntax
RTRV-CRS-E1:[<TID>]:<CRSFROMAID>,<CRSTOAID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>::::,<SST>" <cr><lf>)+ ;
Response Parameters
Parameters Description
Example
Command
RTRV-CRS-E1:::c;
Response Message
NE 2009-01-16 08:21:44 M C COMPLD "FAC-1-1-1,FAC-1-3-1 "
"FAC-1-5-1,FAC-1-7-1::::,RDLD " ;
Related Commands
D.29.1 DLT-CRS-E1
D.29.2 ED-CRS-E1
D.29.3 ENT-CRS-E1
D.29.5 DLT-CRS-F1
Deletes the transparent transmission path of an F1 service.
Function
This command deletes the transparent transmission path of an F1 service.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
DLT-CRS-F1:[<TID>]:<FROM>,<TO>:<CTAG>:::[INCL=<INCL>];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
Example
Command
DLT-CRS-F1::FAC-1-1-1,FAC-1-3-1:C:::INCL=Y;
Response Message
NE714 2009-09-21 10:58:17
M C COMPLD
Related Commands
D.29.7 ENT-CRS-F1
D.29.6 ED-CRS-F1
D.29.8 RTRV-CRS-F1
D.29.6 ED-CRS-F1
Edits the status model of the transparent transmission path of an F1 service.
Function
This command edits the status model of the transparent transmission path of an F1 service.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
ED-CRS-F1:[<TID>]:<FROM>,<TO>:<CTAG>::::,[<SST>];
Command Parameters
Parameters Description Default Value
<FROM> Indicates the source end of the transparent transmission path of the NA
F1 service.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<TO> Indicates the sink end of the transparent transmission path of the F1 NA
service.
The valid format is FAC-<SHELF ID>-<SLOT ID>-<PORT ID>.
<SST> Indicates the red-lined state. The valid values are provided in RDLD-DEA
section SST_STATE.
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
ED-CRS-F1::FAC-1-1-1,FAC-1-3-1:C::::,RDLD;
Response Message
NE 2003-02-28 12:23:50
M 100 COMPLD
;
Related Commands
D.29.7 ENT-CRS-F1
D.29.5 DLT-CRS-F1
D.29.8 RTRV-CRS-F1
D.29.7 ENT-CRS-F1
Creates the transparent transmission path of an F1 service.
Function
This command creates the transparent transmission path of an F1 service.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
ENT-CRS-F1:[<TID>]:<FROM>,<TO>:<CTAG>::::,<SST>;
Command Parameters
Parameters Description Default Value
<SST> Indicates the red-lined state. The valid values are shown RDLD-DEA
in SST_STATE.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
Example
Command
ENT-CRS-F1::FAC-1-1-1,FAC-1-3-1:C::::,RDLD;
Response Message
NE714 2009-09-21 10:58:17
M C COMPLD
Related Commands
D.29.5 DLT-CRS-F1
D.29.6 ED-CRS-F1
D.29.8 RTRV-CRS-F1
D.29.8 RTRV-CRS-F1
Queries the transparent transmission paths of all F1 services.
Function
This command queries the transparent transmission paths of all F1 services.
Usage Note
None
Category
Orderwire
Security
Retrieve
Command Syntax
RTRV-CRS-F1:[<TID>]:<CRSFROMAID>,<CRSTOAID>:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<FROM>,<TO>::::,<SST>" <cr><lf>)+ ;
Response Parameters
Parameters Description
Example
Command
RTRV-CRS-F1:::c;
Response Message
NE 2009-01-16 08:21:44 M C COMPLD "FAC-1-1-1,FAC-1-3-1 "
"FAC-1-5-1,FAC-1-7-1::::,RDLD " ;
Related Commands
D.29.5 DLT-CRS-F1
D.29.6 ED-CRS-F1
D.29.7 ENT-CRS-F1
D.29.9 ED-OPH-ATTR
Edit the orderwire basic attributes.
Function
this command edit the orderwire basic attributes.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
ED-OPH-ATTR:[<TID>]:<AID>:<CTAG>:::[OSTATE=<OSTATE>],
[CWTTIME=<CWTTIME>],[SUBNETLEN=<SUBNETLEN>],[OPHSN=<OPHSN>],
[OPHNUM=<OPHNUM>],[MEETNUM=<MEETNUM>];
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
ED-OPH-ATTR::SLOT-1-
22:C:::OSTATE=WORK,CALLWTTIME=5,SUBNETLEN=1,OPHSN=1,OPHNUM=100,MEETNUM=101;
Response Message
NE 2003-02-28 12:23:50
M 100 COMPLD
;
Related Commands
D.29.10 RTRV-OPH-ATTR
D.29.10 RTRV-OPH-ATTR
Queries the orderwire basic attributes.
Function
This command queries the orderwire basic attributes.
Usage Note
None
Category
Orderwire
Security
Retrieve
Command Syntax
RTRV-OPH-ATTR:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ("<AID>::
[OSTATE=<OSTATE>]" <cr><lf>)+ ;
Response Parameters
Parameters Description
Example
Command
RTRV-OPH-ATTR::SLOT-1-22:C;
Response Message
NGWDM-NE 2003-03-12 07:28:39 M 100 COMPLD "SLOT-1-
22::OSTATE=WORK,CWTTIME=5,SUBNETLEN=1,OPHSN=1,OPHNUM=102,MEETNUM=103" ;
Related Commands
D.29.9 ED-OPH-ATTR
D.29.11 ED-OPH-LPORTATTR
Sets the optical port attributes of orderwires.
Function
This command sets the optical port attributes of orderwires.
Usage Note
None
Category
Orderwire
Security
Provisioning
Command Syntax
ED-OPH-LPORTATTR:[<TID>]:<AID>:<CTAG>::<LINEPORT>:
[ADDRCALLUSED=<ADDRCALLUSED>],[MEETTELUSED=<MEETTELUSED>],
[SUBNETID=<SUBNETID>];
Command Parameters
Default
Parameters Description Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
;
Example
Command
ED-OPH-LPORTATTR::SLOT-1-22::FAC-1-3-
1:ADDRCALLUSED=USE,MEETTELUSED=UNUSE,SUBNETID=1;
Response Message
NE 2003-02-28 12:23:50
M 100 COMPLD
;
Related Commands
D.29.12 RTRV-OPH-LPORTATTR
D.29.12 RTRV-OPH-LPORTATTR
Queries the optical port attributes of orderwire line boards.
Function
This command queries the optical port attributes of orderwire line boards.
Usage Note
None
Category
Orderwire
Security
Retrieve
Command Syntax
RTRV-OPH-LPORTATTR:[<TID>]:[<AID>]:<CTAG>;
Command Parameters
Parameters Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
("<AID>:<LINEPORT>:[ADDRCALLUSED=<ADDRCALLUSED>],
[MEETTELUSED=<MEETTELNUSED>],[SUBNETID=<SUBNETID>]" <cr><lf>)+ ;
Response Parameters
Parameters Description
Example
Command
RTRV-OPH-LPORTATTR::SLOT-1-22:C;
Response Message
NGWDM-NE 2003-03-12 07:28:39 M 100 COMPLD "SLOT-1-
22::ADDRCALLUSED=USE,MEETTELUSED=UNUSE,SUBNETID=1" ;
Related Commands
D.29.11 ED-OPH-LPORTATTR
D.30 System Maintenance
This section lists the commands used to maintain a system.
D.30.1 ABT-ERRPICK
Abort the current error picking process.
Function
When issue this command, error picking will be paused and clear all picked error
information, and roll pick state from PICKING back to IDLE.
Usage Note
None
Category
Errpick
Security
Maintenance
Command Syntax
ABT-ERRPICK:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
ABT-ERRPICK:::100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.30.8 RTRV-ERRPICK-TYPE
D.30.7 RTRV-ERRPICK-STATE
D.30.3 OPR-ERRPICK
D.30.2 ACK-ERRPICK
D.30.2 ACK-ERRPICK
Validate the error picking is finished.
Function
Issue this command means that user have confirm error pick operation, and NE can clear all
info picked, and set state to be IDLE, next pick operation can be performed.
Usage Note
None
Category
Errpick
Security
Maintenance
Command Syntax
ACK-ERRPICK:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
ACK-ERRPICK:::100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.30.8 RTRV-ERRPICK-TYPE
D.30.7 RTRV-ERRPICK-STATE
D.30.3 OPR-ERRPICK
D.30.3 OPR-ERRPICK
Operate the error picking.
Function
This command starts the error picking. For example:
Pick the current system data of one slot.
OPR-ERRPICK:::100::CURDATA, , 4, SLOT-1-1;
Usage Note
The error information picking action is allowed when the current state is IDLE.
Category
Errpick
Security
Maintenance
Command Syntax
OPR-ERRPICK:[<TID>]::<CTAG>::<ERRPICK_DATA>,
[<ERRPICK_TL1>],<ERRPICK_TYPE>,<ERRPICK_BOARD>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
OPR-ERRPICK:::100::ALLDATA,,4,SLOT-1-2;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.30.8 RTRV-ERRPICK-TYPE
D.30.7 RTRV-ERRPICK-STATE
D.30.1 ABT-ERRPICK
D.30.2 ACK-ERRPICK
D.30.4 REPT^EVT^ERRPICKEND
Error picking finished event
Function
This event report the pick result to user after pick operation end or timeout.
Usage Note
None
Category
Errpick
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^^COMPLD<cr><lf>
^^^<cr>"RESULT=<RESULT>, MODCOUNT = <MODCOUNT>,
FAILDMODCOUNT=<FAILDMODCOUNT>"<cr><lf>
;
Response Parameters
Parameter Description
<RESULT> Indicates the error picking state. valid values are as follows:
FAILURE: Error picking is success.
SUCCESS: Error picking is failed.
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT ERRPICKEND
" PICKSTATE = SUCCESS, MODCOUNT= 50, FAILMODCOUNT=0 "
;
Related Commands
None
D.30.5 REPT^EVT^ERRPICKPROGRESS
event of error picking progress and result.
Function
This event notifies user that progress and result of picking error info.
1. Operation will continue even failure is occur.
2. After all info is picked(progress is 100%), user can get all info by issue COPY-
RFILE command only one time.
Usage Note
None
Category
Errpick
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^EVT^ERRPICKPROGRESS <cr><lf>
"PROGRESS=<PROGRESS>, RESULT=<RESULT>"
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2007-04-12 16:09:26
A 28 REPT EVT ERRPICKPROGRESS
"PROGRESS=80, RESULT=SUCCESS"
Related Commands
None
D.30.6 REPT^EVT^ERRPICKUPLOAD
The event of upload file.
Function
This automatic message notify user that NE have picked some information and saved in files,
user can upload files by issue COPY-RFILE command. After file uploaded, these file will not
be uploaded next time, user can get all info by issue COPY-RFILE command many times.
Usage Note
None
Category
Errpick
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^EVT^ERRPICKUPLOAD <cr><lf>
;
Response Parameters
None
Example
Command
None
Response Message
NE 2007-04-12 16:09:26
A 28 REPT EVT ERRPICKUPLOAD
;
Related Commands
None
D.30.7 RTRV-ERRPICK-STATE
Retrieve the state of error picking.
Function
This command retrieves the state of error picking. When the NE is picking data, new error
picking operation is inhibited.
Usage Note
None
Category
Errpick
Security
Maintenance
Command Syntax
RTRV-ERRPICK-STATE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" <PICKSTATE> "<cr><lf>
;
Response Parameters
Parameter Description
<PICKSTATE> Indicates the error picking state. The valid value is IDLE or PICKING.
Example
Command
RTRV-ERRPICK-STATE:::100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"IDLE"
;
Related Commands
D.30.3 OPR-ERRPICK
D.30.8 RTRV-ERRPICK-TYPE
D.30.1 ABT-ERRPICK
D.30.2 ACK-ERRPICK
D.30.8 RTRV-ERRPICK-TYPE
Retrieve the error picking type information.
Function
This command query the information about picking type.
Usage Note
None
Category
Errpick
Security
Maintenance
Command Syntax
RTRV-ERRPICK-TYPE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" <TYPEID>,<TYPEINFO>"<cr><lf>
;
Response Parameters
Parameter Description
<DATATYPE> Indicates the pick type. The valid values are as follows: ASON, TDM, WDM,
SYS, DATA and ALL.
Example
Command
RTRV-ERRPICK-TYPE:::100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"4, SYS"
""
Related Commands
D.30.3 OPR-ERRPICK
D.30.7 RTRV-ERRPICK-STATE
D.30.1 ABT-ERRPICK
D.30.2 ACK-ERRPICK
D.30.9 ALW-MSG-ALL
Allows all REPT ALM and REPT EVT autonomous messages to be transmitted.
Function
This command instructs the NE to enter a mode in which all the REPT ALM and REPT EVT
autonomous messages are transmitted. The command is issued to suppress these autonomous
messages. When a user logs in to the NE, the REPT ALM and REPT EVT messages are
permitted by default. Users can modify the mode as needed.
Usage Note
The setting is stored in the NE database and is retained after the NE reboots.
Category
System
Security
Super
Command Syntax
ALW-MSG-ALL:[<TID>]::<CTAG>::;
Command Parameters
Parameter Description Default Value
NA NA NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ALW-MSG-ALL:::100;
Response Message
NE 2004-07-08 15:15:55
M 100 COMPLD
;
Related Commands
D.30.10 INH-MSG-ALL
D.30.11 RTRV-MSG-ALL
D.30.10 INH-MSG-ALL
Inhibits all REPT ALM and REPT EVT autonomous messages from being transmitted.
Function
This command inhibits all REPT ALM and REPT EVT autonomous messages from being
transmitted. See the description of the ALW-MSG-ALL command to resume these
autonomous messages. When a user logs in, the REPT ALM and REPT EVT messages are
permitted by default. Users can switch between modes as needed.
Usage Note
The setting is stored in a database and is retained after the NE reboots.
Category
System
Security
Super
Command Syntax
INH-MSG-ALL:[<TID>]::<CTAG>::;
Command Parameters
Parameter Description Default Value
NA NA NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INH-MSG-ALL:::100;
Response Message
NE 2004-07-08 15:16:48
M 100 COMPLD
;
Related Commands
D.30.9 ALW-MSG-ALL
D.30.11 RTRV-MSG-ALL
D.30.11 RTRV-MSG-ALL
Retrieves the mode of transmitting autonomous messages.
Function
This command retrieves the mode in which all the REPT ALM and REPT EVT autonomous
messages are transmitted.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-MSG-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MODE>" <cr> <lf>
;
Response Parameters
Parameter Description
<MODE> Indicates whether the reporting of the REPT ALM and REPT EVT
autonomous messages is enabled. The valid values are ENABLE
Parameter Description
and DISABLE.
Example
Command
RTRV-MSG-ALL:::100;
Response Message
NE 2004-07-08 15:15:55
M 100 COMPLD
"ENABLE"
;
Related Commands
D.30.10 INH-MSG-ALL
D.30.9 ALW-MSG-ALL
D.30.12 ALW-PMREPT-ALL
Resumes processing PM reports.
Function
This command instructs an NE to resume processing the PM reports that were inhibited.
Reporting can be inhibited by running the INH-PMREPT-ALL command.
Usage Note
The setting is stored in the NE database and is retained after the NE reboots.
Category
Performance
Security
Retrieve
Command Syntax
ALW-PMREPT-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ALW-PMREPT-ALL:::100;
Response Message
NE 2004-07-08 16:48:49
M 100 COMPLD
;
Related Commands
D.30.13 INH-PMREPT-ALL
D.30.14 RTRV-PMREPT-ALL
D.30.13 INH-PMREPT-ALL
Enables a mode in which all PM reports are inhibited.
Function
This command enables a mode in which all PM reports are inhibited. Periodic reports can be
resumed by using the ALW-PMREPT-ALL command.
Any NE where PM reports are inhibited by this command should include the appropriate
condition type information in response to the RTRV-COND-<MOD2> command.
Usage Note
The setting is stored in a database and is retained after the NE reboots.
Category
Performance
Security
Retrieve
Command Syntax
INH-PMREPT-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
INH-PMREPT-ALL:::100;
Response Message
NE 2004-07-08 16:50:11
M 100 COMPLD
;
Related Commands
D.30.12 ALW-PMREPT-ALL
D.30.14 RTRV-PMREPT-ALL
D.30.14 RTRV-PMREPT-ALL
Retrieves the mode of transmitting performance monitoring reports.
Function
This command retrieves the mode in which all the PM reports autonomous messages are
transmitted.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-PMREPT-ALL:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MODE>" <cr> <lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PMREPT-ALL:::100;
Response Message
NE 2004-07-08 15:15:55
M 100 COMPLD
"ENABLE"
;
Related Commands
D.30.13 INH-PMREPT-ALL
D.30.12 ALW-PMREPT-ALL
D.30.15 ALW-MSG-DBCHG
Enables automatic reporting of DBCHG (database change) messages.
Function
This command enables automatic reporting of DBCHG messages. By default, the automatic
reporting of DBCHG messagess is inhibited. Users can modify the default setting as needed
by running this command.
Usage Note
The setting is stored in the NE database and is retained after the NE reboots.
Category
System
Security
Super
Command Syntax
ALW-MSG-DBCHG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ALW-MSG-DBCHG:::100;
Response Message
NE 2004-07-08 15:19:57
M 100 COMPLD
;
Related Commands
D.30.16 INH-MSG-DBCHG
D.30.17 RTRV-MSG-DBCHG
D.30.20 REPT^DBCHG^TL1
D.30.16 INH-MSG-DBCHG
Inhibits REPT DBCHG messages.
Function
This command inhibits REPT DBCHG messages. When a user logs in, the REPT DBCHG
messages are inhibited by default.
Usage Note
The setting is stored in a database and is retained after the NE reboots.
Category
System
Security
Super
Command Syntax
INH-MSG-DBCHG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
INH-MSG-DBCHG:::100;
Response Message
NE 2004-07-08 15:20:28
M 100 COMPLD
;
Related Commands
D.30.15 ALW-MSG-DBCHG
D.30.17 RTRV-MSG-DBCHG
D.30.20 REPT^DBCHG^TL1
D.30.17 RTRV-MSG-DBCHG
Retrieves the mode of DBCHG (database change) autonomous reports.
Function
This command retrieves the mode in which all the DBCHG autonomous messages are
transmitted.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-MSG-DBCHG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<MODE>" <cr> <lf>
;
Response Parameters
Parameter Description
MODE Indicates the value of the switching. The valid values are
ENABLE and DISABLE.
Example
Command
RTRV-MSG-DBCHG:::100;
Response Message
NE 2004-07-08 15:15:55
M 100 COMPLD
"ENABLE"
;
Related Commands
D.30.15 ALW-MSG-DBCHG
D.30.16 INH-MSG-DBCHG
D.30.20 REPT^DBCHG^TL1
D.30.18 COPY-FILE
Copies files from one board to another board on an NE.
Function
This command copies files from one board to another board on an NE.
Usage Note
none
Category
System
Security
Super
Command Syntax
COPY-FILE:
[<TID>]::<CTAG>::<SFTM_SLOT_SOR>,<SFTM_SLOT_FILE_SOR>,<SFTM_SLOT_
DST>,<SFTM_SLOT_FILE_DST>
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
Example
Command
COPY-FILE:::100::SLOT-1-18,"/ofs1/hwx/ne.ini",SLOT-1-17,"/ofs1/hwx/ne.ini";
Response Message
NEW-NE 2011-07-29 03:50:08
M 100 COMPLD
;
Related Commands
NONE
D.30.19 INIT-SYS
Reboots a single card or the entire system, or only erase database.
Function
This command is issued to reboot a single card or the entire system according to the AID.
The databases are erased before the entire system is rebooted or the new software is activated
during software package downloading (SWDL) depending on the TYPE parameter.
This command is also used to only erase database without rebooting the entire system.
Usage Note
There are requirements to the SWDL:
If there is a standby system control and communication (SCC) card online, activating
the entire system resets the standby SCC to run the new software first; if there are
not any standby SCCs online, activating the entire system resets the active SCC.
If the new software in the SCC runs stably five minutes after the standby SCC is reset,
the system activates all the other cards that are loaded with the new software and are
not activated yet. In this scenario, switching occurs if the standby SCC is online.
If no file is changed for the SCC in the new package, the system will activate slot
units directly. Activating a single unit first cannot activate the SCC.
Category
System
Security
Maintenance
Command Syntax
INIT-SYS:[<TID>]:[<AID>]:<CTAG>::[<RESETLEVEL>]:[<SHELFID=<SHELFID>];
Command Parameters
Parameter Description Default
Value
<AID> Indicates the access identifier. SLOT-ALL denotes the entire system. NA
SLOT-ALL is the only valid value for SWDL/SWDLALL. Any other
SLOT-N-M for SWDL/SWDLALL does not support the SCC.
<RESETLEVEL> Indicates the level of a restart. The valid values are as follows: NA
COLD: indicates a cold restart. In this mode, FPGA is erased for
reloading.
WARM: indicates a warm restart. In this mode, FPGA is retained.
DBERASE: indicates erasing databases which allow delete before a
cold restart. This mode is used only when the AID is set to SCC.
DBERASEALL: indicates erasing all databases before a cold restart. It
is used only when the AID is set to SCC too. When input this database
type , the user must have privilege beyond administrator.
SWDL: used for SWDL only. In this mode, the card is restarted when
at least one of SW, INI, EXTBIOS, and FPGA is loaded. If a new
FPGA is loaded, a cold restart is required; in other scenarios, a warm
restart is required.
When the AID is set to SLOT-ALL, users can activate a specified card
according to the AID before activating the entire system. If no file is
changed on that card, DENIED is returned.
SWDLALL: Used for SWDL only. It is similar to the previous SWDL.
Do not configure protection for the services on all the boards or
initialize all the boards that are loaded with new software at the same
time after the SCC is activated.
DBFDL: indicates a newly activated DBMS. In this mode, the AID
should be set to the ID of the working SCC.
DB: Indicates erasing database on SCC without rebooting. Backup can
not be done in this mode, so you should rebooting the SCC manually
as soon as possible.
SWDLNE: For software download and all boards reset together.
<SHELFID> Indicates the shelf ID allocation mode. Either RESETLEVEL or NA
SHELFID can be entered.
AUTO: This command is usually used before network deployment, to
ensure that the shelf that delivers commands and all downstream slave
shelves are allocated with correct IDs according to the shelf self-
negotiation principles. If a shelf ID changes, the shelf is reset
automatically.
NOTE
Before applying this command, check the network cables cascading the
shelves and ensure that the actual network topology is consistent with
the network plan.
num# : This command is usually used to indicates the ID of the shelf
that delivers commands, which is a specified number. IDs are allocated
for all downstream slave shelves based on the cascaded cables of the
shelves. If a shelf ID changes, the shelf is reset automatically. In a
shelf expansion scenario, the following procedure is required, so that
Parameter Description Default
Value
new shelves are allocated with correct IDs. Before expansion, perform
the following operations on new shelves:
1. After a new shelf is installed properly, do not connect a network
cable to the shelf temporarily.
2. Power on the new shelf.
3. Determine the ID for the new shelf according to network
configuration principles. Set the shelf ID by running the INIT-SYS
command.
4. Several seconds later, check the shelf ID indicator and verify that the
shelf ID is consistent with the design. If they are inconsistent, repeat
step 3.
5. Cascade the shelves with network cables.
NOTE
The valid value ranges from 1 to 32.
CLEAR: This command is usually used to indicates that ID
information of the shelf that delivers commands and all downstream
slave shelves is cleared during manufacturing. After the ID information
is cleared, shelves are not reset temporarily. After the shelves are reset,
shelf IDs are automatically allocated again.
NOTE
For the master shelf, the AUTO, num#, and CLEAR command can be
applied by using network ports or serial ports, or be applied remotely.
For slave subrack, the AUTO, num#, and CLEAR command can only
be applied through serial ports.
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None.
Example
Command
INIT-SYS::SLOT-ALL:C::SWDL;
Response Message
NE 2004-06-20 15:24:42
M C COMPLD
;
Related Commands
None
D.30.20 REPT^DBCHG^TL1
Reports database changes.
Function
This is a message that is generated by the NE to inform the OS of the changes in the
databases. DBCHG is reported when any command except for RTRV is completed or when a
unit is inserted or removed. The REPT DBCHG message is reported to all logged in users.
Usage Note
The REPT DBCHG message is reported only after the ALW-MSG-DBCHG command is
successfully executed. The REPT DBCHG message is not reported after the INH-MSG-
DBCHG command is issued and executed.
This message is used to immediately inform the OS database of the changes due to the
execution of the command, and changes due to external events such as card insertion or
removal.
Even if only one parameter of a non-RTRV command is set successfully, this command will
be indicated by REPT DBCHG, although the command response is DENY. If the command
is completely denied, however, the command will not be indicated by REPT DBCHG.
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^DBCHG<cr><lf>
^^^"DATE=<DATE>,TIME=<TIME>,[SOURCE=<SOURCE>],
[USERID=<USERID>],DBCHGSEQ=<DBCHGSEQ>:<COMMAND>"<cr> <lf>
;
Response Parameters
Parameter Description
Parameter Description
<COMMAND> Indicates the input command (excluding the last character semicolon and the TID
part), which triggers the database changes. If the DBCHG is triggered by hardware
changes, PLUG-IN and UNPLUG are used as command codes.
Example
Command
ENT-USER-SECU::testuser1:100::pass123,,MAINT;
Response Message
NE 2004-07-15 11:22:52
M 100 COMPLD
;
>
NE 2004-07-15 11:22:52
A 5 REPT DBCHG
"DATE=2004-07-15,TIME=11-22-52,SOURCE=100,USERID=sonet,DBCHGSEQ=1:ENT-
USER-SECU:testuser1:********,,MAINT"
;
Related Commands
D.30.15 ALW-MSG-DBCHG
D.30.16 INH-MSG-DBCHG
D.30.17 RTRV-MSG-DBCHG
D.30.21 RTRV-CMDNODE-INFO
Retrieves command list in the TL1 queue.
Function
This command retrieves command list in the TL1 queue..
Usage Note
None
Category
None
Security
Retrieve
Command Syntax
RTRV-CMDNODE-INFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<SID><DATE><TIME>
M CTAG COMPLD
^^^"<CMDNAME>,<CMDCTAG>"
Response Parameters
Parameter Description
Example
Command
RTRV-CMDNODE-INFO:::j;
Response Message
NE118 2000-01-03 09:49:01
M J COMPLD
"RTRV-EQPT,D88"
;
>
Related Commands
None
D.30.22 RTRV-ELABEL
Obtains an equipment electronic label.
Function
This command obtains an equipment electronic label.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-ELABEL:[<TID>]::<CTAG>::<LABEL_TYPE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
^^^"<ELABELINFO>" <cr> <lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-ELABEL:::100::COMMON:
Response Message
NEW-NE 2011-07-29 03:35:34
M 100 COMPLD
"\"/$[System Integration Version]
/$SystemIntegrationVersion=3.0
[BackPlane_1]
/$[ArchivesInfo Version]
/$ArchivesInfoVersion=3.0
[Board Properties]
BoardType=OSN6800 equipment type
BarCode=
Item=
Description=OptiX OSN6800 VER.A motherboard type
Manufactured=
VendorName=Huawei
IssueNumber=
CLEICode=
BOM=
\""
;
Related Commands
None
D.30.23 RTRV-TEST-VER
Retrieves version information about board software and running status of the board software.
Function
This command retrieves version information about board software and running status of the
board software. The retrieved information includes memory of the board, version information
about the software running in the flash memory and running status of the software, basic
BIOS, extended BIOS, and version information and running status of the logic.
Usage Note
None
Category
SYSTEM
Security
Maintenance
Command Syntax
RTRV-TEST-VER:[<TID>]:<SFTM_SLOT>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SOFTNAME=<SoftName8>,SOFTVER=<SoftVer16>,SOFTVERDATE=<SoftVerDate>,SOFT
STATUS=<SoftStatus>,TESTVER=<TestVer>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-TEST-VER::SLOT-1-17:100;
Response Message
NE 2010-08-12 04:50:17
M 100 RTRV
"SOFTNAME=NFS,SOFTVER=5.51.06.10,SOFTVERDATE=20100730,SOFTSTATUS=Running,TE
STVER=T05"
"SOFTNAME=NSF1,SOFTVER=5.51.06.10,SOFTVERDATE=20100730,SOFTSTATUS=active,TE
STVER=T05"
"SOFTNAME=NSF2,SOFTVER=5.51.06.10,SOFTVERDATE=20100730,SOFTSTATUS=inactive,
TESTVER=T05"
"SOFTNAME=INI1,SOFTVER=5.51.06.12,SOFTVERDATE=20100708,SOFTSTATUS=active,TE
STVER=T02"
"SOFTNAME=INI2,SOFTVER=5.51.06.12,SOFTVERDATE=20100708,SOFTSTATUS=inactive,
TESTVER=T02"
"SOFTNAME=BIOS,SOFTVER=8.21.34,SOFTVERDATE=20081224,SOFTSTATUS=inactive,TES
TVER=T01"
"SOFTNAME=ExtBIOS,SOFTVER=9.21.42,SOFTVERDATE=20100302,SOFTSTATUS=active,TE
STVER=T01"
"SOFTNAME=Logic,SOFTVER=(U37)510,SOFTVERDATE=,SOFTSTATUS=,TESTVER="
"SOFTNAME=LogicE01,SOFTVER=(U8)100,SOFTVERDATE=,SOFTSTATUS=,TESTVER="
"SOFTNAME=LogicE02,SOFTVER=(U49)100,SOFTVERDATE=,SOFTSTATUS=,TESTVER="
>
NE 2010-08-12 04:50:17
M 100 COMPLD
"SOFTNAME=DRV,SOFTVER=1.60,SOFTVERDATE=20100626,SOFTSTATUS=active,TESTVER=T
17"
;
Related Commands
None
D.30.24 RTRV-VRCBVER
Retrieves the VRC version of NE.
Function
This command Retrieves the VRC version of NE.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-VRCBVER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"NE_VRCB=<NE_VRCB>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-VRCBVER:::100;
Response Message
NE 2011-08-31 03:45:58
M 100 COMPLD
"NE_VRCB=OSPV200R001C00B230"
;
Related Commands
None
D.30.25 ED-DUMP-SETCON
Set dump condition.
Function
This command set dump condition.
Usage Note
None
Category
Frame
Security
Maintenance
Command Syntax
ED-DUMP-SETCON::
[<TID>]::<CTAG>::<DUMP_BID>::<DUMP_DOMAIN>::<DUMP_LEVEL>;
Command Parameters
Parameter Description Default Value
Response Syntax
none
Response Parameters
none
Example
Command
ED-DUMP-SETCON:::100::17::11::1111;
Response Message
M 100 COMPLD
Related Commands
None
D.30.26 RTRV-GSP-TEST
Print some information.
Function
This command prints some information.
Usage Note
None
Category
Frame
Security
Maintenance
Command Syntax
RTRV-GSP-TEST:[<TID>]::<CTAG>::<CMD_STR>;
Command Parameters
CMD_STR
Response Syntax
[<RSP_CMD_STR>]
Response Parameters
Parameter Description
Example
Command
RTRV-GSP-TEST:::100::"prtmit";
Response Message
NE 2011-10-15 17:20:26
M 100 COMPLD
"Print to MML"
"GSP Test Respond End."
Related Commands
None
D.30.27 RTRV-VER
Retrieves the version related information of a platform or library.
Function
This command enquires about the version related information of a platform or library
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-VER:[<TID>]:<SFTM_SLOT>:<CTAG>::<SoftType>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"SoftName=<SoftName32>,SoftVer=<SoftVer256>,SoftVerDate=<SoftVerDate>"<c
r><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-VER::SLOT-1-17:100::PT;
Response Message
NE 1990-01-16 20:19:47
M 100 COMPLD
"SOFTNAME=PLATSOFT,SOFTVER=050031291,SOFTVERDATE=20130513"
;
Related Commands
None
D.30.28 ED-LSRAUTOOPEN
Edits the automatic open flag of the laser.
Function
This command modifies the automatic open flag of the laser.
Usage Note
None
Category
Facility
Security
Maintenance
Command Syntax
ED-LSRAUTOOPEN:[<TID>]:<AID>:<CTAG>:::
[LSRAUTOOPEN=<LSRAUTOOPEN>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ed-lsrautoopen::fac-1-2-1:C:::LSRAUTOOPEN=DISABLE;
Response Message
NE 04-01-01 11:37:18
M C COMPLD
;
Related Commands
D.6.32 RTRV-PL
D.30.29 RTRV-LSRAUTOOPEN
Retrieves the automatic open flag of laser .
Function
This command retrieves the automatic open flag of laser.
Usage Note
None
Category
Facility
Security
Maintenance
Command Syntax
RTRV-LSRAUTOOPEN:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<AID>::[LSRAUTOOPEN=<LSRAUTOOPEN>]
;
Response Parameters
Parameter Description
<AID> Indicates the equipment unit identity. The valid format is FAC-<SHELF ID>-
<SLOT ID>-<PORT ID>-<PATH ID>.
Example
Command
rtrv-lsrautoopen::fac-1-2-1:C;
Response Message
NE 2009-01-12 09:17:22
M C COMPLD
"FAC-1-2-1::LSRAUTOOPEN=ENABLE"
;
Related Commands
D.6.31 ED-PL
D.30.30 ED-DUMP-CLEARCODE
Clear dump code.
Function
This command clear dump code.
Usage Note
None
Category
Frame
Security
Maintenance
Command Syntax
ED-DUMP-CLEARCODE::[<TID>]::<CTAG>::<DUMP_BID>::<DUMP_TM>;
Command Parameters
Parameter Description Default Value
Response Syntax
none
Response Parameters
none
Example
Command
ED-DUMP-CLEARCODE:::100::17::1;
Response Message
M 100 COMPLD
Related Commands
None
D.30.31 ED-DUMP-SETCODE
Set dump code.
Function
This command set dump code.
Usage Note
None
Category
Frame
Security
Maintenance
Command Syntax
ED-DUMP-SETCODE::
[<TID>]::<CTAG>::<DUMP_BID>::<DUMP_TM>::<DUMP_CODE>;
Command Parameters
Parameter Description Default Value
Response Syntax
none
Response Parameters
none
Example
Command
ED-DUMP-SETCODE:::100::17::1::9017;
Response Message
M 100 COMPLD
Related Commands
None
D.31 Security Management
This section lists the commands which used to configure the security function to control
user's access.
D.31.1 ACT-USER
Allows a user to log in to an NE.
Function
This command allows a user to operate an NE.
Usage Note
A terminal supports one user to log in to an NE each time.
Category
Security
Security
Retrieve
Command Syntax
ACT-USER:[<TID>]:<UID>:<CTAG>::<PID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^/*last log time*/
;
Response Parameters
None
Example
Command
ACT-USER::SONET:100::SONET;
Response Message
NE 1990-01-01 02:15:27
M 100 COMPLD
"Last log time : 1990-1-1 2:2:20"
;
Related Commands
D.31.9 CANC-USER
D.31.2 ACT-USER-EMS
Allows a user to log in to an NE by using Huawei EMS.
Function
This command is run to allow a user to operate an NE.
Usage Note
A terminal supports only one user to log in to an NE each time.
Category
Security
Security
Retrieve
Command Syntax
ACT-USER-EMS:[<TID>]:<UID>:<CTAG>::<PID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^/*last log time*/
;
Response Parameters
None
Example
Command
ACT-USER-EMS::SONET:100::SONET;
Response Message
NE 1990-01-01 02:15:27
M 100 COMPLD
"Last log time : 1990-1-1 2:2:20"
;
Related Commands
D.31.9 CANC-USER
D.31.3 ALW-USER-SECU
Allows an inhibited user to log in to an NE.
Function
This command is used by a superuser to enable a UID that has been disabled by the INH-
USER-SECU command. This command allows a user to establish a session with the EMS
again.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ALW-USER-SECU:[<TID>]::<CTAG>::<UID>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ALW-USER-SECU:::100::USERNAME;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.31.7 INH-USER-SECU
D.31.4 DLT-USER-SECU
Deletes a user of the NE.
Function
This command deletes a user on the NE.
Usage Note
The default user of the NE and online users cannot be deleted.
Category
Security
Security
Super
Command Syntax
DLT-USER-SECU:[<TID>]:<UID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-USER-SECU::USERNAME:100;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.31.6 ENT-USER-SECU
D.31.5 ED-USER-SECU
D.31.8 RTRV-USER-SECU
D.31.5 ED-USER-SECU
Changes user attributes.
Function
This command changes user attributes.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-USER-SECU:[<TID>]:<UID>:<CTAG>::[<NEWUID>],[<NEWPID>],,[<UPC>]:
[TMOUTEN=<TMOUTEN>],[TMOUTLN=<TMOUTLN>],[PAGE=<PAGE>],
[UAGE=<UAGE>],[SYNACT=<SYNACT>],[SHOWHELP=<SHOWHELP>],
[DISABLELN=<DISABLELN>];
Command Parameters
<NEWPID> Specifies a new password. The new password must contain at least 8 NA
but not more than 16 characters in three out of the following four
types: (1) lowercase letters, (2) uppercase letters, (3) digits, (4)
special symbols (~!@#%^*()-_+<.> plus spaces). In addition, the
new password cannot reuse the last five passwords, or contain either
the username or the reverse username. Further, the new password
must use at least two characters different from the previous
password.
<UPC> Indicates the user level. There are five types of user levels: RTRV NA
Parameter Description Default
Value
<TMOUTLN> Indicates the time when the system deletes a user automatically. The 60
valid value ranges from 5 to 60 (units in minutes). This parameter is
available when the value of the parameter TMOUTEN is ENABLE.
The default value is 60.
<PAGE> Indicates the time when the password is active (units in days). The NA
valid value ranges from 25 to 999 and 0 indicates that the password
is always active.
<SHOWHELP> Indicates whether the help messages of the TL1 command are NA
displayed. The valid values are Y and N.
<UAGE> Indicates the time the user name stays active (units in days). The NA
valid value ranges from 0 to 999 and 0 indicates that the user name
is always active.
<SYNACT> Allows several users to use the same user name to be actively DISABLE
logged in to the system from different locations. The valid values
are ENABLE and DISABLE. The default value is DISABLE.The
password will not be changed by self if this parameter is
ENABLE,Only other administrators can change its password.
<DISABLELN> Indicates the time that the user not login.After this time it will 0
disable the user. The valid value ranges from 1 to 255 and 0
indicates disable the attribute.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-USER-SECU::USERNAME:100::,NEW_PASSWORD;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.6 ENT-USER-SECU
D.31.4 DLT-USER-SECU
D.31.8 RTRV-USER-SECU
D.31.6 ENT-USER-SECU
Creates the user security.
Function
This command adds a user to operate an NE.
Usage Note
A maximum of 240 users is supported on an NE.
Category
Security
Security
Super
Command Syntax
ENT-USER-SECU:[<TID>]:<UID>:<CTAG>::<PID>,,<UPC>:
[TMOUTEN=<TMOUTEN>],[TMOUTLN=<TMOUTLN>],[PAGE=<PAGE>],
[UAGE=<UAGE>],[SYNACT=<SYNACT>],[SHOWHELP=<SHOWHELP>],
[DISABLELN=<DISABLELN>];
Command Parameters
<PID> Specifies a new password. The new password must contain at least 8 NA
but not more than 16 characters in three out of the following four
types: (1) lowercase letters, (2) uppercase letters, (3) digits, (4)
Parameter Description Default
Value
<UPC> Indicates the user level. There are five types of user levels: RTRV NA
(retrieve), PROV (provisioning), MAINT (maintenance), SUPER
(super user).
<TMOUTEN> Indicates whether the automatic deletion of a user is enabled. The ENABLE
valid values are ENABLE and DISABLE.
<TMOUTLN> Indicates the time when the system deletes a user automatically. The 60 minutes
valid value ranges from 5 to 60 minutes. This parameter is effective
when TMOUTEN is set to ENABLE.
<PAGE> Indicates the time when the password is active (units in days). The 0
valid value ranges from 25 to 999 and 0 indicates that the password
is always active.
<UAGE> Indicates the time when the user name stays active (units in days). 0
The valid value ranges from 0 to 999 and 0 indicates that the user
name is always active.
<SYNACT> Allows several users to use the same user name to be actively DISABLE
logged in to the system from different locations. The valid values
are ENABLE and DISABLE. The default value is DISABLE. The
password will not be changed by self if this parameter is
ENABLE,Only other administrators can change its password. Only
users at the "RTRV", "PROV" or "MAINT" level can enable this
parameter.
<SHOWHELP> Indicates whether the help messages of the TL1 command are Y
displayed. The valid values are Y and N.
<DISABLELN> Indicates the time that the user not login.After this time it will 0
disable the user. The valid value ranges from 1 to 255 and 0
indicates disable the attribute.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-USER-
SECU::USERNAME:100::PASS_WORD,,MAINT:TMOUTEN=ENABLE,TMOUTLN=30,PAGE=30,UAGE
=30,SYNACT=ENABLE,SHOWHELP=Y,DISABLELN=50;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.4 DLT-USER-SECU
D.31.5 ED-USER-SECU
D.31.8 RTRV-USER-SECU
D.31.7 INH-USER-SECU
Inhibits the user security.
Function
This command is issued by an administrator to inhibit or disable an existing user (without
deleting the user account). The user will then be denied sessions with the NE/M (i.e., the user
cannot log in). If a UID has not been used and UAGE has expired, the preceding UID must
be displayed. A disabled UID can be re-instated by using the ALW-USER-SECU command.
Unused UIDs increase the risk of unauthorized access and thus should not be used. The
principle is that a user who is temporarily inactive, but may become active again, does not
have to be deleted from the system.
Usage Note
You cannot inhibit a user that is online.
Category
Security
Security
Super
Command Syntax
INH-USER-SECU:[<TID>]::<CTAG>::<UID>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
INH-USER-SECU:::100::USERNAME;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.31.3 ALW-USER-SECU
D.31.8 RTRV-USER-SECU
Retrieves user attributes.
Function
This command retrieves user attributes.
Usage Note
A common user can retrieve only the attributes about itself, but the administrator can retrieve
the attributes of all users.
Category
Security
Security
Retrieve
Command Syntax
RTRV-USER-SECU:[<TID>]:[<UID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<UID>:,<UPC>:TMOUTEN=<TMOUTEN>,TMOUTLN=<TMOUTLN>,PAGE=<PAGE>,UAGE=<UAGE
>,USTATE=<USTATE>,SYNACT=<SYNACT>,
[LASTLOGINTM=<LASTLOGINTIME>],SHOWHELP=<SHOWHELP>,
[ENCRYPTTYPE=<ENCRYPTTYPE>],DISABLELN=<DISABLELN>"
Response Parameters
Parameter Description
<UPC> Indicates the user level. There are five types of user levels: RTRV (retrieve),
PROV (provisioning), MAINT (maintenance), SUPER (super user), .
<TMOUTLN> Indicates the time when the system deletes a user automatically. It is
expressed in minutes.
<PAGE> Indicates the time when the password is active (units in days).
<UAGE> Indicates the time when the user name stays active (units in days).
Indicates the state of the user. The valid values are as follows:
<USTATE>
INACT/ACT: inactive or active (offline or online)
ALW/INH: user allowed or inhibited
UIDUNEXP/UIDEXP: user name has not expired or user name has
expired
PIDUNEXP/PIDEXP: password has not expired or password has
expired
Parameter Description
<SYNACT> Allows several users to use the same user name to be actively logged in to
the system from different locations. The valid values are ENABLE and
DISABLE. The default value is DISABLE.The password will not be
changed by self if this parameter is ENABLE,Only other administrators can
change its password.
<LASTLOGINTIME> Indicates the most recent login date and time of the user, for example, 2004-
12-08 14-20-26.
<SHOWHELP> Indicates whether the help messages of the TL1 command are displayed.
The valid values are Y and N.
<ENCRYPTTYPE> Indicates the encrypted type of the password of the user.
<DISABLELN> Indicates the time that the user not login.After this time it will disable the
user.
Example
Command
RTRV-USER-SECU::USERNAME:100;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
"USERNAME:,MAINT:TMOUTEN=ENABLE,TMOUTLN=30,PAGE=30,UAGE=30,USTATE=INACT&ALW
&UIDUNEXP&PIDUNEXP,LASTLOGI"
;
"USERNAME:,RTRV:TMOUTEN=ENABLE,TMOUTLN=60,PAGE=0,UAGE=0,USTATE=INACT&ALW&UI
DUNEXP&PIDUNEXT,SYNACT=ENABLE,LASTLOGINTM=2002-02-08 14-20-
26,SHOWHELP=Y,ENCRYPTTYPE=SHA256,DISABLELN=25"
;
Related Commands
D.31.6 ENT-USER-SECU
D.31.4 DLT-USER-SECU
D.31.5 ED-USER-SECU
D.31.9 CANC-USER
User logout.
Function
This command enables a user to log out of an NE.
Usage Note
Users levels of PROV (provisioning), MAINT (maintenance) and RTRV (retrieve) can only
log themselves out of an NE, but a superuser can log all users out of an NE.
Category
Security
Security
Retrieve
Command Syntax
CANC-USER:[<TID>]:<UID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
CANC-USER::USERNAME:100;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.31.1 ACT-USER
D.31.10 RTRV-CHECKINFO-SECU
Retrieves the check information.
Function
This command retrieves the check information.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-CHECKINFO-SECU:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
Parameter Description
<CHECKVALUE> Indicates the check value. The valid value ranges from 1 to 30
(units in days).
Example
Command
RTRV-CHECKINFO-SECU:::100;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
"30"
;
Related Commands
None
D.31.11 ED-LOCKDURATION
Sets the automatic unlocking time.
Function
This command is to set the automatic unlocking time.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-LOCKDURATION:[<TID>]::<CTAG>::<LOCKDURATION>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-LOCKDURATION:::100::120;
Response Message
NE1691 1990-01-04 13:20:56
M 100 COMPLD
;
Related Commands
None
D.31.12 RTRV-LOCKDURATION
Retrieves the automatic unlocking time.
Function
This command retrieves the automatic unlocking time.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-LOCKDURATION:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>
M^^<CTAG>^COMPLD<cr><lf>
^^^<LOCKDURATION><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-LOCKDURATION:::100;
Response Message
NE1691 1990-01-04 13:20:37
M 100 COMPLD
120
;
Related Commands
None
D.31.13 ED-INVATTEMPT-SECU
Modify the number of consecutive and invalid login attempts allowed to occur before the user
is locked.
Function
This command modifies the number of consecutive and invalid login attempts allowed to
occur before the user is locked.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-INVATTEMPT-SECU:[<TID>]::<CTAG>::<INVATTEMPT>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-INVATTEMPT-SECU:::100::6;
Response Message
NE 2013-12-15 15:23:20
M 100 COMPLD
;
Related Commands
RTRV-INVATTEMPT-SECU
D.31.14 RTRV-INVATTEMPT-SECU
Get the number of consecutive and invalid login attempts allowed to occur before the user is
locked.
Function
Get the number of consecutive and invalid login attempts allowed to occur before the user is
locked.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-INVATTEMPT-SECU:[<TID>]::<CTAG>;
Command Parameters
Parameter Description Default Value
NA NA NA
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<INVATTEMPT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-INVATTEMPT-SECU:::100;
Response Message
NE 2013-12-15 15:08:11
M 100 COMPLD
"5"
;
Related Commands
ED-INVATTEMPT-SECU
D.31.15 RTRV-LOCKEDUSER-SECU
Retrieves the locked users.
Function
This command retrieves the locked users.
Usage Note
The superusers can retrieve the locked users.
Category
Security
Security
Super
Command Syntax
RTRV-LOCKEDUSER-SECU:[<TID>]:[<UID>]:<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<UID>,<UNLOCKREMAINTIME>
Response Parameters
Parameter Description
Example
Command
RTRV-LOCKEDUSER-SECU:::100;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
"USERNAME,50"
;
Related Commands
D.31.6 ENT-USER-SECU
D.31.4 DLT-USER-SECU
D.31.5 ED-USER-SECU
D.31.16 ED-PID
Changes a user password.
Function
This command changes a user password. Only the password of the current user can be
changed.
Usage Note
Users can only change their own passwords.
Category
Security
Security
Retrieve
Command Syntax
ED-PID:[<TID>]::<CTAG>::<PID>,<NEWPID>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-PID:::100::OLDPASS,PASS_WORD;
Response Message
NE 2002-03-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.5 ED-USER-SECU
D.31.17 ED-WARNSCR
Modifies the warning screen information.
Function
This command modifies the warning screen information.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-WARNSCR:[<TID>]::<CTAG>::<WARNINGSCRN>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-WARNSCR:::100::"YOU ARE WELCOME";
Response Message
NE 2007-04-12 00:47:36
M 100 COMPLD
;
Related Commands
D.31.18 RTRV-WARNSCR
D.31.18 RTRV-WARNSCR
Retrieves the warning screen information.
Function
This command retrieves the warning screen information.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
RTRV-WARNSCR:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<WARNSCR>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-WARNSCR:::100;
Response Message
NE 2007-04-12 00:45:50
M 100 COMPLD
"some thing wrong!"
;
Related Commands
D.31.17 ED-WARNSCR
D.31.19 ED-WARNSCRSTATE
Sets the switch of the warning screen information.
Function
This command sets the switch of the warning screen information.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-WARNSCRSTATE:[<TID>]::<CTAG>::<WARNINGSCRN_STATE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-WARNSCRSTATE:::100::ENABLE;
Response Message
NE 2007-04-12 00:50:47
M 100 COMPLD
;
Related Commands
D.31.20 RTRV-WARNSCRSTATE
D.31.20 RTRV-WARNSCRSTATE
Retrieves the switch of the warning screen information.
Function
This command retrieves the switch of the warning screen information.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
RTRV-WARNSCRSTATE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<WARNSCR>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-WARNSCRSTATE:::100;
Response Message
NE 2007-04-12 00:54:00
M 100 COMPLD
"ENABLE"
;
Related Commands
D.31.19 ED-WARNSCRSTATE
D.31.21 REPT^LOGOFF
Reports log offs.
Function
This event is reported to indicate a logoff event.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^LOGOFF <cr><lf>
"<AID>:<CONDTYPE>,[<CONDEF>],,,,,,,:[<CONDDESCR>]";
Response Parameters
Parameter Description
<CONDTYPE> Indicates the type of the logoff. The valid values are as follows:
Example
Command
None
Response Message
NE 1990-01-01 02:10:37
A 13 REPT LOGOFF
"COM:CMD LOGOFF,TC,,,,,,,:User sonet logoff"
;
Related Commands
None
D.31.22 REPT^EVT^SECU
Reports a security event (user password has expired).
Function
This event is reported to indicate that user password has expired when the user logs in.
Usage Note
When the user logs in to the NE, a message indicating that the password is out of time is
reported. Then, the user must modify the password. Otherwise, the user can use the old
password to log for three times only. After three times, the user cannot log in to the NE.
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^SECU <cr><lf>
"<AID>:<CONDTYPE>,[<CONDEF>],,,,,,,:[<CONDDESCR>]";
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2003-01-01 19:49:38
A 5 REPT EVT SECU
"COM:PIDEXPR,TC,,,,,,,:PID EXPIRED"
;
Related Commands
None
D.31.23 REPT^ACCESS^WARNING
Reports an access warning.
Function
This event is reported to warn the login user that the user has no authority to operate the NE.
This warning is taken as the gist of the prosecution.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^ACCESS^WARNING <cr><lf>
/*WARN*/
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2003-01-01 19:49:38
A 6 REPT ACCESS WARNING
"NOTICE: This is a private communication system.
Unauthorized access or use may lead to prosecution."
;
Related Commands
None
D.31.24 REPT^ACCOUNTEXPIRED^WARNING
Gives the login user a warning.
Function
This event is reported to give a warning to the login user that the user account (the NE
administrator only) is about to expire.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^ACCOUNTEXPIRED^WARNING <cr><lf>
/*WARN*/
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2003-01-01 19:49:38
A 6 REPT ACCOUNTEXPIRED WARNING
"NOTICE: Your account already expire. Please check your account
information, set new account period of validity."
Related Commands
None
D.31.25 REPT^EVT^OPLOGNEEDUPLOAD
Reports that the operation log needs to be uploaded to the other storage facilities, so that it
will not be rewritten.
Function
This event is reported to indicate that the operation log is full and the user should upload the
log.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^EVT^ OPLOGNEEDUPLOAD <cr><lf>
;
Response Parameters
None
Example
Command
None
Response Message
NE 2006-11-10 15:57:06
A 10 REPT EVT OPLOGNEEDUPLOAD
Related Commands
None
D.31.26 REPT^EVT^OPLOGCIRCLE
Reports that the operation log is rewritten and the new log did not overwrite the old log.
Function
This event is reported to indicate that the operation log has been overflowed.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^EVT^ OPLOGCIRCLE<cr><lf>
;
Response Parameters
None
Example
Command
None
Response Message
NE 2006-11-10 15:57:06
A 10 REPT EVT OPLOGCIRCLE
Related Commands
None
D.31.27 REPT^MODIFYPASSWORD^NOTIFY
Reports that the login user needs to modify the password.
Function
This event is provided to remind the login user to modify the password.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^ REPT^MODIFYPASSWORD^NOTIFY <cr><lf>
/*WARN*/
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2005-07-01 11:34:20
A 918 REPT MODIFYPASSWORD NOTIFY
"NOTICE:This is a private password system.
Please modify your password immediately."
;
Related Commands
None
D.31.28 REPT^PASSWORD^NEEDMODIFY
Reports that the user's password need modify.
Function
This event is provided to remind the login user to modify the password.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^ REPT^PASSWORD^NEEDMODIFY <cr><lf>
;
Response Parameters
Parameter Description
None
None
Example
Command
None
Response Message
NE 2013-01-08 11:34:20
A 56557 REPT PASSWORD NEEDMODIFY
Related Commands
None
D.31.29 DLT-SSH-HOSTKEY
Delete the ssh hostkey
Function
This command is issued to delete the ssh hostkey.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
DLT-SSH-HOSTKEY:[<TID>]::<CTAG>::TYPE=<SSH_KEY_TYPE>;
Command Parameters
Parameter Description Default Value
<SSH_KEY_TYPE> Type of the key, the value can be c-rsa, c-dsa, s-rsa or s- NA
dsa, only support *-rsa now.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-SSH-HOSTKEY:::100::type=c-rsa;
Response Message
NEW-NE 2012-02-06 20:23:32
M 100 COMPLD
;
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
D.31.35 RTRV-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
Modify the passphrase of the ssh key.
Function
This command is issued to modify the passphrase of the ssh key.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ED-SSH-PASSPHRASE:[<TID>]::<CTAG>::TYPE=<SSH_KEY_TYPE>,
[PASSPHRASE=<SSH_KEY_PASSPHRASE>],
[NEWPASSPHRASE=<SSH_KEY_NEWPASSPHRASE>];
Command Parameters
Parameter Description Default
Value
SSH_KEY_TYPE Type of the key, the value can be c-rsa, c-dsa, s-rsa or s- NA
dsa, but only c-rsa is supported now.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SSH-PASSPHRASE:::100::type=c-
rsa,passphrase=Oldpp20111012,newpassphrase=Newpp20111012;
Response Message
NEW-NE 2012-02-06 20:23:32
M 100 COMPLD
;
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.31.31 DLT-SSH-PEERPUBKEY
Delete a client's public key to the device.
Function
This command delete a client's public key to the device.
Usage Note
None.
Category
Security
Security
Super
Command Syntax
DLT-SSH-PEERPUBKEY:[<TID>]:<PEERPUBKEYNAME>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
DLT-SSH-PEERPUBKEY::"PUBLICKEY001":100;
Response Message
NE 2012-02-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.33 ENT-SSH-PEERPUBKEY
D.31.32 ED-SSH-PEERPUBKEY
D.31.40 RTRV-SSH-PEERPUBKEYINFO
D.31.41 RTRV-SSH-PEERPUBKEYLIST
D.31.32 ED-SSH-PEERPUBKEY
Edit a client's public key to the device.
Function
This command edit a client's public key to the device.
Usage Note
None.
Category
Security
Security
Super
Command Syntax
ED-SSH-PEERPUBKEY:
[<TID>]:<PEERPUBKEYNAME>:<CTAG>::PUBKEYTYPE=<PEERPUBKEYTYPE>,PUB
KEYINFO=<PEERPUBKEYINFO>,
[PUBKEYCOMMENT=<PEERPUBKEYCOMMENT>];
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-SSH-
PEERPUBKEY::PUBLIC001:100::PUBKEYTYPE=RSA,PUBKEYINFO="AAAAB3NzaC1yc2EAAAABJ
QAAAQBqc/FDmC11ZL+YyF2rt6gLdMOZjEvOqtOqMOB8E0y61qGBqrvIJ3hU1gdf+WfHJ21DEDow
mQKFsV1fcbLis3ovh+qGjvrJMgM8BNr4zfsGVUw9dcBrqDTyNq0F0Hupoo0FlPUx4IhSnlB0GQt
RyKueikRVjAN4SjD5CQIgZRiL2OEvKeMXuZDg9/RmjIPfPTwctzVdpOR+jqtbr43NSpCPyykwL5
HDsa8KWLxjuIXHfXXHhe1f7P1Z1+rf7n62MCh3oXx5aUjxG0SRnDYsTB5v9AE+Oa4CR0WRkTHmG
caL1nK28jBI0g9k0ix34Ac0/aqxHfT8FtkKp8/77oBnn5H7",PUBKEYCOMMENT="comment";
Response Message
NE 2012-02-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.33 ENT-SSH-PEERPUBKEY
D.31.31 DLT-SSH-PEERPUBKEY
D.31.40 RTRV-SSH-PEERPUBKEYINFO
D.31.41 RTRV-SSH-PEERPUBKEYLIST
D.31.33 ENT-SSH-PEERPUBKEY
Add a client's public key to the device.
Function
This command adds a client's public key to the device.
Usage Note
A maximum of 32 keys is supported on an NE.
Category
Security
Security
Super
Command Syntax
ENT-SSH-PEERPUBKEY:
[<TID>]:<PEERPUBKEYNAME>:<CTAG>::PUBKEYTYPE=<PEERPUBKEYTYPE>,PUB
KEYINFO=<PEERPUBKEYINFO>,
[PUBKEYCOMMENT=<PEERPUBKEYCOMMENT>];
Command Parameters
Parameter Description Default
Value
<PEERPUBKEYCOMMENT> Indicates the comment of the public key, max length is 32; NA
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-SSH-
PEERPUBKEY::PUBLIC001:100::PUBKEYTYPE=RSA,PUBKEYINFO="AAAAB3NzaC1yc2EAAAABJ
QAAAQBqc/FDmC11ZL+YyF2rt6gLdMOZjEvOqtOqMOB8E0y61qGBqrvIJ3hU1gdf+WfHJ21DEDow
mQKFsV1fcbLis3ovh+qGjvrJMgM8BNr4zfsGVUw9dcBrqDTyNq0F0Hupoo0FlPUx4IhSnlB0GQt
RyKueikRVjAN4SjD5CQIgZRiL2OEvKeMXuZDg9/RmjIPfPTwctzVdpOR+jqtbr43NSpCPyykwL5
HDsa8KWLxjuIXHfXXHhe1f7P1Z1+rf7n62MCh3oXx5aUjxG0SRnDYsTB5v9AE+Oa4CR0WRkTHmG
caL1nK28jBI0g9k0ix34Ac0/aqxHfT8FtkKp8/77oBnn5H7",PUBKEYCOMMENT="comment";
Response Message
NE 2012-02-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.31 DLT-SSH-PEERPUBKEY
D.31.32 ED-SSH-PEERPUBKEY
D.31.41 RTRV-SSH-PEERPUBKEYLIST
D.31.40 RTRV-SSH-PEERPUBKEYINFO
D.31.34 ENT-SSH-HOSTKEY
Create the SSH hostkey.
Function
This command is issued to create the SSH hostkey.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ENT-SSH-HOSTKEY:[<TID>]::<CTAG>::TYPE=<SSH_KEY_TYPE>,
[MODULUS=<SSH_KEY_MODULUS>],[PASSPHRASE=<SSH_KEY_PASSPHRASE>],
[OVERWRITE=<SSH_KEY_OVERWRITE>];
Command Parameters
Parameter Description Default
Value
<SSH_KEY_TYPE> Type of the key, the value can be c-rsa, c-dsa, s-rsa or s- NA
dsa, but only *-rsa is supported now.
<SSH_KEY_MODULUS> The number of bits in the key, range from 2048 to 4096. 2048
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-SSH-HOSTKEY:::100::type=c-
rsa,modulus=2048,passphrase=Hostkey61136,overwrite=allow;
Response Message
NEW-NE 2012-02-7 20:23:32
M 100 COMPLD
;
Related Commands
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
Retrieves the information of the SSH hostkey.
Function
This command is issued to retrieve information of the ssh hostkey.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-SSH-HOSTKEY:[<TID>]::<CTAG>::TYPE=<SSH_KEY_TYPE>,
[PASSPHRASE=<SSH_KEY_PASSPHRASE>],[FORMAT=<SSH_KEY_FORMAT>];
Command Parameters
Parameter Description Default
Value
<SSH_KEY_TYPE> Type of the key, the value can be c-rsa, c-dsa, s-rsa or NA
s-dsa, but only *-rsa is supported now.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"KEYTYPE=<SSH_KEY_TYPE>,MODULUS=<SSH_KEY_MODULUS>,PASSPROTECT=<SSH_KEY_P
ASSPROT>,CREATETIME=<SSH_KEY_CTIME>,FINGERPRINT=<SSH_KEY_FINGERPRINT>,FORMA
T=<SSH_KEY_FORMAT>,PUBKEY=<SSH_KEY_PUBKEY>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-HOSTKEY:::100::type=c-rsa,passphrase=Hostkey61136,format=openssh;
Response Message
NEW-NE 1990-01-02 10:12:03
M 100 COMPLD
"KEYTYPE=C-RSA,MODULUS=2048,PASSPROTECT=YES,CREATETIME=\"1990-01-02
01:58:28\",FINGERPRINT=\"cc:73:f0:6c:e4:85:1f:08:c3:2f:c7:b9:49:8f:93:29\",
FORMAT=OPENSSH,PUBKEY=\"ssh-rsa
AAAAB3NzaC1yc2EAAAAEAAEAAQAAAQEA0iVz/TNpMgCwYU/TIgLPrJ9WWlMlgk3lTvGR4cEpP7h
pC6hiFKMCuebyGkDDUVfDz2ly87FPm1PDbOeEkMbAy44CUZK9DNPJQCk6FUPzKCj26nZade3Q5M
bHRSeiAPktZO8FdFxPPYQHPaFPZxCs5v1+BVjEjJYnlSx9OxjNYDPtRAAddsk46XWka/gQDSfuA
suoOfj3s7TdAFXxD4xdA0xljiv8Hl8Mtb8xTceYtTJitaYU4Scp6XwArCUf18LOS3N3XjP7ZVZO
jd9VfUjOhXr7VRysAEA3TCxZaRXWmMNrmDnrsdpJYj4wetZfJt9fjv0M+RM7Gkfi/KumAhYrcw=
= Huawei Technologies Co.,Ltd.\""
;
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
D.31.29 DLT-SSH-HOSTKEY
D.31.36 RTRV-SSH-HOSTKEYLIST
Retrieves the list of all SSH hostkey in the NE.
Function
This command instructs NE to retrieve the list of all SSH hostkey.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-SSH-HOSTKEYLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"KEYTYPE=<SSH_KEY_TYPE>,PASSPROTECT=<SSH_KEY_PASSPROT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-HOSTKEYLIST:::100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"KEYTYPE=C-RSA,PASSPROTECT=YES"
"KEYTYPE=S-RSA,PASSPROTECT=NO"
;
D.31.37 ED-USER-SSHPEERPUBKEY
assign or release a client's public key to a ssh user.
Function
This command assign or release a client's public key to a ssh user.
Usage Note
The ssh users are consistent with the local users of security management.
Category
Security
Security
Super
Command Syntax
ED-USER-SSHPEERPUBKEY:[<TID>]:<UID>:<CTAG>::
[PUBKEYNAME=<PEERPUBKEYNAME>];
Command Parameters
<PEERPUBKEYNAME> Indicates the name of the public key assigned to the user, 4-30 NA
characters, no case sensitive, spaces are not allowed. the user's
public key will be unassigned if nothing is entered for this
parameter
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-USER-SSHPEERPUBKEY::Username:100::PUBKEYNAME="PUBLIC001";
Response Message
NE 2012-02-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.6 ENT-USER-SECU
D.31.4 DLT-USER-SECU
D.31.39 RTRV-USER-SSH
D.31.33 ENT-SSH-PEERPUBKEY
D.31.32 ED-SSH-PEERPUBKEY
D.31.31 DLT-SSH-PEERPUBKEY
D.31.38 ED-USER-SSHAUTHTYPE
Changes ssh user's authentication type.
Function
This command changes ssh user's authentication type.
Usage Note
The ssh users are consistent with the local users of security management.
Category
Security
Security
Super
Command Syntax
ED-USER-SSHAUTHTYPE:
[<TID>]:<UID>:<CTAG>::<AUTHTYPE=<SSHAUTHTYPE>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-USER-SSHAUTHTYPE::Username:100::AUTHTYPE=PASSWORD;
Response Message
NE 2012-02-04 15:23:20 M 100 COMPLD ;
Related Commands
D.31.6 ENT-USER-SECU
D.31.4 DLT-USER-SECU
D.31.39 RTRV-USER-SSH
D.31.39 RTRV-USER-SSH
Retrieves ssh user's authentication type and client's public key.
Function
This command retrieves ssh user's authentication type and client's public key.
Usage Note
None.
Category
Security
Security
Super
Command Syntax
RTRV-USER-SSH:[<TID>]:[<UID>]:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<UID>:AUTHTYPE=<SSHAUTHTYPE>,PUBKEYNAME=<PEERPUBKEYNAME>"
Response Parameters
Parameter Description
<PEERPUBKEYNAME> Indicates the name of the client's public key assigned to the user.
Example
Command
RTRV-USER-SSH::Username:100;
Response Message
NE 2012-02-04 15:23:20
M 100 COMPLD
"Username:AUTHTYPE=PASSWORD,PUBKEYNAME="PUBLIC001";
Related Commands
D.31.38 ED-USER-SSHAUTHTYPE
D.31.37 ED-USER-SSHPEERPUBKEY
D.31.40 RTRV-SSH-PEERPUBKEYINFO
Retrieves the infomation of the SSH client's public key.
Function
This command is issued to retrieve infomation of the SSH client's public key.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-SSH-PEERPUBKEYINFO:[<TID>]:<PEERPUBKEYNAME>:<CTAG>;
Command Parameters
<PEERPUBKEYNAME> The name of the ssh client's public key, 4-30 characters, no case NA
sensitive, spaces are not allowed;
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"PUBKEYNAME=<PEERPUBKEYNAME>,PUBKEYTYPE=<PEERPUBKEYTYPE>,PUBKEYINFO=<PEE
RPUBKEYINFO>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-PEERPUBKEYINFO::PUBLIC:100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"PUBKEYNAME=PUBLIC001,PUBKEYTYPE=RSA,PUBKEYINFO="ssh-rsa
AAAAB3NzaC1yc2EAAAABJQAAAQBqc/FDmC11ZL+YyF2rt6gLdMOZjEvOqtOqMOB8E0y61qGBqrv
IJ3hU1gdf+WfHJ21DEDowmQKFsV1fcbLis3ovh+qGjvrJMgM8BNr4zfsGVUw9dcBrqDTyNq0F0H
upoo0FlPUx4IhSnlB0GQtRyKueikRVjAN4SjD5CQIgZRiL2OEvKeMXuZDg9/RmjIPfPTwctzVdp
OR+jqtbr43NSpCPyykwL5HDsa8KWLxjuIXHfXXHhe1f7P1Z1+rf7n62MCh3oXx5aUjxG0SRnDYs
TB5v9AE+Oa4CR0WRkTHmGcaL1nK28jBI0g9k0ix34Ac0/aqxHfT8FtkKp8/77oBnn5H7 rsa-
key-20120228"
"
D.31.41 RTRV-SSH-PEERPUBKEYLIST
Retrieves the list of the SSH client's public key.
Function
This command is issued to retrieve list of the SSH client's public key.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-SSH-PEERPUBKEYLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"PUBKEYNAME=<PEERPUBKEYNAME>,PUBKEYTYPE=<PEERPUBKEYTYPE>,
[PUBKEYCOMMENT=<PEERPUBKEYCOMMENT>]"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-PEERPUBKEYLIST:::100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"PUBKEYNAME=PUBLIC001,PUBKEYTYPE=RSA,PUBKEYCOMMENT=comment"
D.31.42 RTRV-SSH-SRVINFO
Retrieve running information of SSH server.
Function
This command instructs NE to retrieve running information of SSH server.
Usage Note
None
Category
Communication
Security
Maintenance
Command Syntax
RTRV-SSH-SRVINFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"VERSION=<SSH_SRV_VERSION>,CONNTIMEOUT=<SSH_SRV_CONNTIMEOUT>,AUTHRETRY=<
SSH_SRV_AUTHRETRY>,STATUS=<SSH_SRV_STATUS>,PORT=<SSH_SRV_PORT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-SRVINFO:::100;
Response Message
NEW-NE 2012-02-07 19:28:38
M 100 COMPLD
"VERSION=1.99,CONNTIMEOUT=60,AUTHRETRY=3,STATUS=ENABLE,PORT=22"
;
D.31.43 RTRV-SECULOG
Retrieve the seculog which supports retrieve all or by time.
Function
This command retrieves the seculog which supports retrieve all or by time.
Usage Note
None
Category
SM
Security
Super
Command Syntax
RTRV-SECULOG:[<TID>]::<CTAG>::[STARTDATE],[STARTTIME],[ENDDATE],
[ENDTIME];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^SECU_EVT_NAME=<SECU_EVT_NAME>,SECU_USER_NAME=<SECU_USER_NAME>,SECU_LOG_T
IME=<SECU_LOG_TIME>,SECU_RESRC=<SECU_RESRC>,SECU_IP=<SECU_IP>,SECU_TEITYPE=
<SECU_TEITYPE>,SECU_RESULT=<SECU_RESULT><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SECULOG:::100::2012-3-25,17-40-00,2012-3-25,17-50-00;
Response Message
NE 2012-03-25 17:46:15
M 100 COMPLD
"SECU_EVT_NAME=login,SECU_USER_NAME=sonet,SECU_LOG_TIME=2012-03-25 17-
45-03,SECU_RESRC=login
command,SECU_IP=129.9.132.16,SECU_TEITYPE=tl1,SECU_RESULT=S"
;
D.31.44 RTRV-PWDRECTYPE
Retrieves the encrypted type of the password.
Function
This command retrieves the encrypted type of the password.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-PWDRECTYPE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>
M^^<CTAG>^COMPLD<cr><lf>
^^^<ENCRYPTTYPE><cr><lf>
;
Response Parameters
Parameter Description
Command
RTRV-PWDRECTYPE:::100;
Response Message
NE1691 1990-01-04 13:20:37
M 100 COMPLD
"MD5"
;
Related Commands
None
D.31.45 ED-PWDRECTYPE
Sets the encrypted type of the password.
Function
This command is to set the encrypted type of the password.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-PWDRECTYPE:[<TID>]::<CTAG>::<ENCRYPTTYPE>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PWDRECTYPE:::100::MD5;
Response Message
NE1691 1990-01-04 13:20:56
M 100 COMPLD
;
Related Commands
None
D.31.46 RTRV-SECU-TYPE
Retrieve the security function type.
Function
This command query the information about security function type.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-SECU-TYPE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" <SECU_TYPE>"<cr><lf>
;
Response Parameters
Para Description
met
er
<SE Indicates the security function type. The valid values are as follows:
CU_ RADIUS,SYSLOG,SNMP,NTP,OPLOG,SUCELOG,SSH_SRV,SSH_CLIENT,BASIC_ACL,
TYP ADVANCE_ACL,USER_PW_SHA256,SNMP_COMMUNITY,SSL_CERTIFYCATE,SSH_
E> KEY_CREATE_ASYN,PWD_BLACKLIST,USERSECU_POLICY,USER_PW_PBKDF2,TL
S_SYSLOG,TRAP_COMMMUNITY,SNMP_VERSION,PWD_NOTIFY,DCN_ENCRYPT,E
XTECC_AUTH,NE_AUTO_REPORT,RADIUS_PROXY_AUTH,SSL_OPT,SFTP_FINGER
PRINT_AUTH,USER_LOCKDURATION,INVALID_ATTEMPTNUM.
Example
Command
RTRV-SECU-TYPE:::100;
Response Message
NEW-NE 2015-03-06 08:24:47
M 100 COMPLD
"RADIUS"
"SYSLOG"
"SNMP"
"NTP"
"OPLOG"
"SECULOG"
"SSH_SRV"
"SSH_CLIENT"
"BASIC_ACL"
"ADVANCE_ACL"
"USER_PW_SHA256"
"SNMP_COMMUNITY"
"SSL_CERTIFYCATE"
"SSH_KEY_CREATE_ASYN"
"PWD_BLACKLIST"
"USERSECU_POLICY"
"USER_PW_PBKDF2"
"TLS_SYSLOG"
"USER_LOCKDURATION"
"INVALID_ATTEMPTNUM"
"TRAP_COMMMUNITY"
"SNMP_VERSION"
"PWD_NOTIFY"
"RADIUS_PROXY_AUTH"
"SSL_OPT"
"SFTP_FINGERPRINT_AUTH"
;
Related Commands
D.30.3 OPR-ERRPICK
D.30.7 RTRV-ERRPICK-STATE
D.30.1 ABT-ERRPICK
D.30.2 ACK-ERRPICK
D.31.47 RTRV-AO
Retrieves the automatic output.
Function
This command retrieves a copy of a queued autonomous message or a missing autonomous
message. The messages that can be retrieved include: REPT DBCHG, REPT EVT, and REPT
ALM.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
RTRV-AO:[<TID>]::<CTAG>:::[ATAGSEQ=<ATAGSEQ>],[MSGTYPE=<MSGTYPE>],
[DBCHGSEQ=<DBCHGSEQ>];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD [<cr> <lf>
/* <cr><lf>
(<autonomous message including the message header, but without the
termination indicator, i.e., ";"> <cr> <lf>)*
*/] <cr> <lf>
;
Response Parameters
None
Example
Command
RTRV-AO:::100:::MSGTYPE=DBCHG;
Response Message
NE 2004-07-08 15:08:54
M 100 COMPLD
/*
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"
*/
;
Related Commands
D.24.8 REPT^ALM^<MOD2>
D.24.9 REPT^EVT^<MOD2>
D.31.48 RTRV-DBCHGSEQ
Retrieves the last sequence of dbchg event.
Function
This command retrieves the last sequence of dbchg event.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
RTRV-DBCHGSEQ:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^<LASTDBCHG_SEQ><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DBCHGSEQ:::123;
Response Message
NEW-NE 2011-10-24 10:56:30
M 123 COMPLD
"8"
;
>
D.31.49 DLT-PWD-BLACKLIST
Delete the password blacklist.
Function
This command is issued to delete the password blacklist.
Usage Note
None
Category
Security
Security
Super
Command Syntax
DLT-PWD-BLACKLIST:[<TID>]::<CTAG>::[<PWDBLACKLIST>];
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-PWD-BLACKLIST:::100::blacklist
Response Message
WIN-NE 2013-12-08 00:22:54
M 100 COMPLD
;
>
Related Commands
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.31.50 ENT-PWD-BLACKLIST
Add the password blacklist.
Function
This command is issued to add the password blacklist.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ENT-PWD-BLACKLIST:[<TID>]::<CTAG>::<PWDBLACKLIST>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-PWD-BLACKLIST:::100::blacklist
Response Message
WIN-NE 2013-12-08 00:22:54
M 100 COMPLD
;
>
Related Commands
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.31.51 RTRV-PWD-BLACKLIST
Retrieves all password blacklist.
Function
This command is issued to retrieve all password blacklist.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-PWD-BLACKLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<PWDBLACKLIST>"<cr><lf>
Response Parameters
Parameter Description
Example
Command
rtrv-pwd-blacklist:::100;
Response Message
WIN-NE 2013-12-08 00:45:48
M 100 COMPLD
"blacklist"
;
>
D.31.52 RTRV-PTPCMD-WHITELIST
Querying the cmd list which can execute in the function of optp-white-list
Function
Querying the cmd list which can execute in the function of optp-white-list
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-PTPCMD-WHITELIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^PTPCMD=<PTPCMD>,PTPMSG0=<PTPMSG0>,PTPMODID=<PTPMODID>,PTPENTRYID=<PTPENT
RYID>,PTPFUNC=<PTPFUNC>,PTPBRIEF=<PTPBRIEF><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PTPCMD-WHITELIST:::100 ;
Response Message
2014-07-24 00:39:44
M 100 COMPLD
"CMD=0X1098,MSG0=0X2,MODID=0X15,ENTRYID=1,FUNC=0X8C9FCC9,BRIEF=TESTCMD";
Related Commands
None
D.31.53 ED-PWDEXPIRE-NOTIFDAY
Sets the notify day before the password expires.
Function
This command is to set the notify day before the password expires.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-PWDEXPIRE-NOTIFDAY:[<TID>]::<CTAG>::<NOTIFDAY>;
Command Parameters
Parameter Description Default
Value
<NOTIFDAY> Indicates the notify day before the password expires, ranging from NA
3 to 15;
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PWDEXPIRE-NOTIFDAY:::100::7;
Response Message
NE1691 1990-01-04 13:20:56
M 100 COMPLD
;
Related Commands
None
D.31.54 REPT^PWD^WILLEXPIRE
Reports that password will expire in several days
Function
This event reports that password will expire in several days.
Usage Note
None
Category
Security
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<atag>^REPT^PWD^WILLEXPIRE<cr><lf>
^^^<cr>"UID=<UID>,DAYBEFPWDEXPIRE=<DAYBEFPWDEXPIRE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
WIN-NE 2014-10-15 12:00:00
A 17 REPT PWD WILLEXPIRE
"UID=zhang,DAYBEFPWDEXPIRE=10"
;
Related Commands
None
D.31.55 RTRV-PWDEXPIRE-NOTIFDAY
Retrieves the notify day before the password expires.
Function
This command retrieves the notify day before the password expires.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-PWDEXPIRE-NOTIFDAY:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>
M^^<CTAG>^COMPLD<cr><lf>
^^^NOTIFDAY=<NOTIFDAY><cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PWDEXPIRE-NOTIFDAY:::100;
Response Message
NE1691 1990-01-04 13:20:37
M 100 COMPLD
"NOTIFDAY=7"
;
Related Commands
None
D.31.56 ED-HISPWCNT
Sets the check times of the history password.
Function
This command is to set the check times of the history password.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-HISPWCNT:[<TID>]::<CTAG>::<HISPWCNT>;
Command Parameters
Parameter Description Default
Value
<HISPWCNT> Check times of the history password, 0 to 12, 0 means not check; 5
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-HISPWCNT:::100::6;
Response Message
WIN-NE 2014-11-06 18:32:51
M 100 COMPLD
;
Related Commands
None
D.31.57 ED-PWMINAGE
Sets the password min age.
Function
This command is to set the password min age.
Usage Note
None
Category
Security
Security
Super
Command Syntax
ED-PWMINAGE:[<TID>]::<CTAG>::<PWMINAGE>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PWMINAGE:::100::10;
Response Message
WIN-NE 2014-11-06 18:33:29
M 100 COMPLD
;
Related Commands
None
D.31.58 RTRV-SECU-CFG
Retrieves security configuration.
Function
This command retrieves security configuration.
Usage Note
None
Category
Security
Security
Super
Command Syntax
RTRV-SECU-CFG:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"EXPPWCNT=<EXPPWCNT>,PWMAXAGE=<PWMAXAGE>,PWMINAGE=<PWMINAGE>,HISPWCNT=<H
ISPWCNT>,TRLPERIOD=<TRLPERIOD>,ATTEMPTCNT=<ATTEMPTCNT>,LOCKDURATION=<LOCKDU
RATION>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SECU-CFG:::100;
Response Message
WIN-NE 2014-11-06 18:33:31
M 100 COMPLD
"EXPPWCNT=3,PWMAXAGE=0,PWMINAGE=17,HISPWCNT=8,TRLPERIOD=180,ATTEMPTCNT=5,LO
CKDURATION=600"
;
D.31.59 ENT-SSH-FINGERPRINT
Add or modify a ssh fingerprint to the device.
Function
This command is issued to add or modify a ssh fingerprint to the device.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ENT-SSH-FINGERPINT:
[<TID>]::<CTAG>::ServerIP=<Sftp_ServerIP>,Port=<Sftp_Port>,Alg=<Sftp_Alg>,Fingerpri
nt=<Sftp_Fingerprint>;
Command Parameters
Parameter Description Default Value
<Sftp_ServerIP> Indicates the SSH server ip. the IP is Ipv4, such as: NA
129.9.111.1.
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-SSH-
FINGERPRINT:::99::ServerIP=129.9.130.3,Port=22,Alg=MD5,Fingerprint="4d:98:7
0:e6:04:c9:2e:1b:ca:12:75:e1:bb:7d:dc:a4"
Response Message
NEW-NE 2015-01-7 20:23:32
M 99 COMPLD
;
Related Commands
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.31.60 DLT-SSH-FINGERPRINT
Delete the ssh fingerprint.
Function
This command is issued to delete the ssh fingerprint.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
DLT-SSH-FINGERPRINT:
[<TID>]::<CTAG>::ServerIP=<Sftp_ServerIP>,Port=<Sftp_Port>;
Command Parameters
Parameter Description Default Value
<Sftp_ServerIP> Indicates the SSH server ip. the IP is Ipv4, such as: NA
129.9.111.1.
<Sftp_Port> Indicates SSH server port. It's between 1 and 65535. NA
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-SSH-FINGERPRINT:::111::ServerIP=129.9.130.3,Port=22;
Response Message
NEW-NE 2012-02-06 20:23:32
M 111 COMPLD
;
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
D.31.35 RTRV-SSH-HOSTKEY
D.31.61 RTRV-SSH-FINGERPRINTLIST
Retrieves the list of the SSH server's fingerprint..
Function
This command is issued to retrieve list of the SSH server's fingerprint.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-SSH-FINGERPRINTLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"SERVERIP=<Sftp_ServerIP>,PORT=<Sftp_Port>,ALG=<Sftp_Alg>,FINGERPRINT=<S
ftp_Fingerprint>"<cr><lf>;
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-FINGERPRINTLIST:::100;
Response Message
NEW-NE 1990-01-02 10:12:03
M 100 COMPLD
"SERVERIP=129.9.130.3,PORT=22,ALG=MD5,FINGERPRINT=\"4d:98:70:e6:04:c9:2e:1b
:ca:12:75:e1:bb:7d:dc:a4\"";
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
D.31.29 DLT-SSH-HOSTKEY
D.31.62 ED-SSH-SRVAUTH
Edit a SSH client authentication switch to the device.
Function
This command edit a SSH client authentication switch to the device.
Usage Note
None.
Category
Security
Security
Super
Command Syntax
ED-SSH-SRVAUTH:[<TID>]::<CTAG>::SWITCH=<Sftp_Switch>;
Command Parameters
<Sftp_Switch> Indicates the SSH client fingerprint authentication switch. The value CLOSE
is OPEN or CLOSE.
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-SSH-SRVAUTH:::101::SWITCH=OPEN;
Response Message
NE 2012-02-04 15:23:20 M 101 COMPLD ;
Related Commands
D.31.33 ENT-SSH-PEERPUBKEY
D.31.31 DLT-SSH-PEERPUBKEY
D.31.40 RTRV-SSH-PEERPUBKEYINFO
D.31.41 RTRV-SSH-PEERPUBKEYLIST
D.31.63 RTRV-SSH-SRVAUTH
Retrieves the list of the SSH client authentication switch of the device.
Function
This command is issued to retrieve list of the SSH client authentication switch of the device.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
RTRV-SSH-SRVAUTH:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"SWITCH=<Sftp_Switch>"<cr><lf>;
Response Parameters
Parameter Description
Example
Command
RTRV-SSH-SRVAUTH:::100;
Response Message
NEW-NE 1990-01-02 10:12:03
M 100 COMPLD
"SWITCH=OPEN"
;
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
D.31.29 DLT-SSH-HOSTKEY
D.31.64 ENT-SSH-ASYNHOSTKEY
Asynchronous create the SSH hostkey.
Function
This command is issued to asynchronous create the SSH hostkey.
Usage Note
None
Category
Communication
Security
Super
Command Syntax
ENT-SSH-ASYNHOSTKEY:[<TID>]::<CTAG>::TYPE=<SSH_KEY_TYPE>,
[MODULUS=<SSH_KEY_MODULUS>],[PASSPHRASE=<SSH_KEY_PASSPHRASE>],
[OVERWRITE=<SSH_KEY_OVERWRITE>];
Command Parameters
Parameter Description Default
Value
<SSH_KEY_TYPE> Type of the key, the value can be c-rsa, c-dsa, s-rsa or s- NA
dsa, but only *-rsa is supported now.
<SSH_KEY_MODULUS> The number of bits in the key, range from 2048 to 4096. 2048
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-SSH-ASYNHOSTKEY:::100::type=c-
rsa,modulus=2048,passphrase=Hostkey61136,overwrite=allow;
Response Message
NEW-NE 2012-02-7 20:23:32
M 100 COMPLD
;
Related Commands
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.32.1 ED-PE-DBPERIOD
Changes the database backup period.
Function
This command changes the database backup period.
Usage Note
None
Category
System
Security
Super
Command Syntax
ED-PE-DBPERIOD:[<TID>]::<CTAG>::<PE_DBPERIOD>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-PE-DBPERIOD:::100::30;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.32.2 RTRV-PE-DBPERIOD
D.32.2 RTRV-PE-DBPERIOD
Retrieves the value of the database backup period.
Function
This command retrieves the database backup period.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-PE-DBPERIOD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" DBPERIOD =<VALUE>"<cr><lf>
;
Response Parameters
Parameter Description
<VALUE> Indicates the backup period expressed in minutes. The valid value ranges from 5
to 1440.
Example
Command
RTRV-PE-DBPERIOD:::100;
Response Message
NE 2006-07-20 10:03:08
M 100 COMPLD
" DBPERIOD =30"
;
Related Commands
D.32.1 ED-PE-DBPERIOD
D.32.3 ED-PE-DATA
Recovers the data of an NE from the peripheral equipment of the NE to the flash memory or
backs up the data from the NE to the peripheral equipment.
Function
This command enables the NE to backup data to the peripheral equipment. When the SCC
card is faulty, the data on the peripheral equipment of the NE can be recovered.
Usage Note
None
Category
System
Security
Super
Command Syntax
ED-PE-DATA:[<TID>]::<CTAG>::<PE_AID>,<PE_DATA_MOD>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD <cr><lf>
;
Response Parameters
None
Example
Command
ED-PE-DATA:::100::SLOT-1-17,BACKUP;
Response Message
NE 2006-07-20 10:03:08
M 100 COMPLD
;
Related Commands
None
D.32.4 RECOVER-PE-DATA
Recovers the peripheral equipment of the NE to flash memory.
Function
The NE can back up data to the peripheral equipment. When the SCC card is faulty, the data
on the peripheral equipment can be used for data recovery.
Usage Note
None
Category
System
Security
Super
Command Syntax
RECOVER-PE-DATA:[<TID>]:[<PE_AID#N"SLOT-0">]:<CTAG>::<PE_DATATYPE>,
[<PE_DATAFILE#N"">];
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
RECOVER-PE-DATA::SLOT-1-17:100::DB;
Response Message
NE 2006-07-20 10:03:08
M 100 COMPLD
;
Related Commands
None
D.32.5 RTRV-FREESPACE
Retrieves the free space of a file system device.
Function
This command retrieves the free space of a file system device.
Usage Note
None
Category
SFTM
Security
Retrieve
Command Syntax
RTRV-FREESPACE:[<TID>]:<SFTM_SLOT_SOR>:<CTAG>::<SFTM_DRV_NAME>
Command Parameters
Response Parameters
Parameter Description
Example
Command
RTRV-FREESPACE::SLOT-2:100::ofs1;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"BOARD=SLOT-1-18,DRIVER=ofs1,FREESPACE=71512064"
;
Related Commands
None
D.32.6 RTRV-PE-AUTOBACKUP
Retrieves the status of the automatic backup function of an NE.
Function
This command retrieves the status of the automatic backup function of an NE.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-PE-AUTOBACKUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" STATUS =<STATUS>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PE-AUTOBACKUP:::100;
Response Message
NE 2006-07-20 10:03:08
M 100 COMPLD
" STATUS=ENABLE"
;
Related Commands
D.32.7 SET-PE-AUTOBACKUP
D.32.7 SET-PE-AUTOBACKUP
Backs up the data from an NE to the peripheral equipment.
Function
Users can enable or disable the automatic backup function of an NE.
Usage Note
None
Category
System
Security
Super
Command Syntax
SET-PE-AUTOBACKUP:[<TID>]::<CTAG>::<PE_AUTO_BACK>
Command Parameters
Parameter Description Default Value
<PE_AUTO_BACK> Indicates the state. The valid values are Enable and Enable
Disable. Enable: indicates that the automatic backup
function is enabled.
Disable: indicates that the automatic backup function
is disabled.
Response Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
Response Parameters
None
Example
Command
SET-PE-AUTOBACKUP:::1::DISABLE;
Response Message
NE 2004-07-15 14:56:06
M 1 COMPLD
;
>
Related Commands
D.32.6 RTRV-PE-AUTOBACKUP
D.32.8 REPT^EVT^PEBACKUPFAIL
Reports that the NE fails to back up data to the peripheral equipment.
Function
This event is reported automatically by the NE to inform the user that the NE failed to backup
data to the peripheral equipment.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<date>^<time><cr><lf>
A^^<atag>^REPT^EVT^PEBACKUPFAIL <cr><lf>
^^^"DATATYPE=<PE_DATATYPE>,BID=<AID>"
;
Response Parameters
Parameter Description
<AID> Indicates the ID of the master card which needs to backup or recover data.
<PE_DATATYPE> Indicates the type of data which failed to back up from the NE to the
peripheral equipment. The data types are as follows:
ALL: indicates the configuration data, including DB, SOFT,
SYSPARA, PATCH, and OTHER data of the NE.
DB: indicates the database file of the NE.
SOFT: indicates the software, including INI files and FPGA.
SYSPARA: indicates the system configuration parameter.
PATCH: indicates the patch files of the NE.
OTHER: indicates other data of the NE.
Example
Command
None
Response Message
NE 2007-04-12 16:09:26
A 28 REPT EVT PEBACKUPFAIL
"DATATYPE=ALL,BID=SLOT-1-2"
;
Related Commands
None
D.32.9 RTRV-VERMATCH
Retrieves the match information about the software version.
Function
This command retrieves the match information about the software version.
Usage Note
None
Category
SFTM
Security
Maintenance
Command Syntax
RTRV-VERMATCH:[<TID>]:<SFTM_SLOT>:<CTAG>::<PATROL_TYPE>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"BID=<SFTM_SLOT>,TYPE=<TYPE>,MATCH_RESULT=<MATCH_RESULT>,MATCH_FILE_TYPE
=<MATCH_FILE_TYPE>,MATCH_FILE_NAME=<PATROL_MATCH_FNAME>,ACTIVE_FILE_REG=<AC
TIVE_FILE_REG>,ACTIVE_FILE_EXIST=<ACTIVE_FILE_EXIST>,ACTIVE_FILE_VER=<PATRO
L_FILE_VER>,STANDBY_FILE_REG=<PATROL_STANDBY_FREG>,STANDBY_FILE_EXIST=<PATR
OL_STANDBY_FEXIST>,STANDBY_FILE_VER=<PATROL_STANDBY_FVER>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-VERMATCH::SLOT-1-1:100::VERCHECK;
Response Message
NE 2006-04-05 14:43:35
M 100 RTRV
"BID=SLOT-1-
1,TYPE=,MATCH_RESULT=,MATCH_FILE_TYPE=,MATCH_FILE_NAME=,ACTIVE_FILE_REG=,AC
TIVE_FILE_EXIST=,ACTIVE_FILE_VER=,STANDBY_FILE_REG=,STANDBY_FILE_EXIST=,STA
NDBY_FILE_VER="
;
Related Commands
None
D.32.10 RTRV-DEVSPACE
Querying the information of the device space.
Function
This command obtains the information of the total space,the available free space and the used
space present in the specified device and in the board. This command can be executed on any
board of NE.
Usage Note
None
Category
MON
Security
Retrieve
Command Syntax
RTRV-DEVSPACE:[<TID>]:<MON_SLOT_SOR>:<CTAG>::[<DRIVER>];
Command Parameters
Parameter Description
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
^^^BOARD=<BOARD>,DRIVER=<DRIVER>,TOTALSPACE=<TOTALSPACE>,FREESPACE=<FREESPA
CE>,USEDSPACE=<USEDSPACE><cr><lf>
;
Response Parameters
Parameter Description
<TOTALSPACE> Total space present in the specified device and in the board.
Parameter Description
<FREESPACE> Free space present in the specified device and in the board.
<USEDSPACE> Used space present in the specified device and in the board.
Example
Command
RTRV-FREESPACE::SLOT-1-18:100::ofs1;
Response Message
NE 2012-03-25 17:46:15
M 100 COMPLD
"BOARD=SLOT-1-
18,DRIVER=ofs1,TOTALSPACE=126607360,FREESPACE=96415744,USEDSPACE=30191616"
;
D.33 System Update
This section lists commands which used to update the system.
D.33.1 ABT-CMD
Aborts SWDL, DBFDL or DBFUL processing.
Function
When issuing this command, the system aborts SWDL, DBFDL or DBFUL and attempts to
roll back to the state before SWDL, DBFDL or DBFUL. Software download (SWDL)
denotes downloading software packages from a PC to an NE. Database file download
(DBFDL) denotes downloading databases from a PC to an NE. Database file upload
(DBFUL) means uploading database from an NE to a PC.
Usage Note
This command can only abort software package downloading or database file downloading
and uploading.
Category
System
Security
Maintenance
Command Syntax
ABT-CMD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ABT-CMD:::100;
Response Message
NE 2004-06-20 15:07:32
M 100 COMPLD
;
Related Commands
None
D.33.2 ACT-SWDLGROUP
Activates a group.
Function
This command activates a group that needs to be activated.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
ACT-SWDLGROUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
ACT-SWDLGROUP:::100
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD;
;
Related Commands
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.11 ED-GROUPMODE
D.33.3 DLT-SWDLGROUP
Deletes the active SWDL group. After the groups are edited, users should use this command
to delete any empty groups that are generated.
Function
This command deletes an active group by group ID.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
DLT-SWDLGROUP:[<TID>]::<CTAG>::<SWDL_GROUPID>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
DLT-SWDLGROUP:::100::2;
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD;
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.11 ED-GROUPMODE
D.33.4 ED-SWDLGROUP
Edits the active SWDL group.
Function
This command edits the active group by group ID/active mode/card list.
Usage Note
This command can verify the conditions as follows:
The active SCC and the standby SCC must be set only in group 1.
NOTE:
The 1800 NA equipment does not support standby SCC. Edit the active SCC in group 1.
Category
SWDL
Security
Maintenance
Command Syntax
ED-SWDLGROUP:
[<TID>]::<CTAG>::<SWDL_GROUPID>,<GROUP_EDITMODE>,<GROUP_ACTMODE>,
<SWDL_BID>;
Command Parameters
Response Parameters
None
Example
Command
ED-SWDLGROUP:::100::2,COVER,MANUAL,SLOT-1-4&SLOT-1-5&SLOT-1-8;
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD
;
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.11 ED-GROUPMODE
D.33.5 ED-SWDL-CUSTOM
Set SWDL Downloading Type.
Function
When issuing this command, the system will download the package according to the
specified type
Usage Note
This command can set package downloading type.
Category
System
Security
Maintenance
Command Syntax
ED-SWDL-CUSTOM:[<TID>]::<CTAG>::<SWDL_CUSTOM>;
Command Parameters
Response Syntax
None
Response Parameters
None
Example
Command
ED-SWDL-CUSTOM:::100::CUSTOM;
Response Message
NE 2011-09-24 22:38:54
M 100 COMPLD
;
Related Commands
None
D.33.6 AUD-SWDLGROUP
Verifies the active SWDL group.
Function
This command verifies the active group. This command must be issued after the active group
is edited.
Usage Note
This command verifies the following items:
Whether every card is in one of the groups.
Whether every card is only in one of the groups.
Category
SWDL
Security
Maintenance
Command Syntax
AUD-SWDLGROUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
AUD-SWDLGROUP:::100;
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD
;
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.11 ED-GROUPMODE
D.33.7 RTRV-SWDLGROUP
Retrieves active SWDL groups. This command is often used when the groups are modified.
Function
This command retrieves all the active groups.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-SWDLGROUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<SWDL_GROUPID>,<GROUP_ACTMODE>,<SWDL_BID>"<cr><lf>
;
Response Parameters
Parameter Description
<SWDL_GROUPID> Indicates the group ID. The valid value ranges from 1 to 65535.
<GROUP_ACTMODE> Indicates the active mode. The valid values are MANUAL and
AUTO.
Example
Command
RTRV-SWDLGROUP:::100;
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD
"SWDL_GROUPID=1,GROUP_ACTMODE=AUTO,SWDL_BID=SLOT-1-29"
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.11 ED-GROUPMODE
D.33.8 ED-LOADSOFT
Set SWDL Downloading Switch.
Function
When issuing this command, if para is open, the system will keep package downloading
processing alone alway from the disturb of other process of SWDL if para is close other
process of SWDL can run, sush as file fpatrol.
Usage Note
This command can keep software package downloading processing alone.
Category
System
Security
Super
Command Syntax
ED-LOADSOFT:[<TID>]::<CTAG>::<SWITCH>;
Command Parameters
Response Parameters
None
Example
Command
ED-LOADSOFT:::100::OPEN;
Response Message
NE 2011-09-24 22:38:54
M 100 COMPLD
;
Related Commands
None
D.33.9 RTRV-LOADSOFT
Get package Downloading Switch Status.
Function
When issuing this command, the system will response the current package Downloading
Switch Status.
Usage Note
This command can response the current package Downloading Switch Status.
Category
System
Security
Retrieve
Command Syntax
RTRV-LOADSOFT:[<TID>]::<CTAG>;
Command Parameters
NULL
Response Syntax
SET_STATE=<SWITCH>,CUR_STATE=<CURTYPE>
;
Response Parameters
Example
Command
RTRV-LOADSOFT:::100;
Response Message
NE169-1 2012-05-15 10:49:28
M 100 COMPLD
"SET_STATE=CLOSE,CUR_STATE=IDLE"
;
>
Related Commands
None
D.33.10 RTRV-LOADSUPPORTINFO
Get information about how the ne support package loading.
Function
When issuing this command, if para is open, the system will gether the function information
sush as if the ne support CUSTOM package loading.
Usage Note
This command can gether the function information sush as if the ne support CUSTOM
package loading.
Category
System
Security
Retrieve
Command Syntax
RTRV-LOADSUPPORTINFO:[<TID>]::<CTAG>;
Command Parameters
NULL
Response Syntax
Response Parameters
None
Example
Command
RTRV-LOADSUPPORTINFO:::100;
Response Message
NE169-1 2012-05-15 15:23:15
M 100 COMPLD
"PATCHPKG,YES"
"SFTP,YES"
"SWDL,YES"
"PRESWDL,YES"
"GROUPACT,YES"
"SWDL_TOLERANCE,YES"
"SWDLFUNCTION,0x03"
"CUSTOMSWDL,YES"
"DIFFUSE,YES"
"DUFILEMAXSIZE,59751KB"
"DBMS,0x03";
Related Commands
None
D.33.11 ED-GROUPMODE
Sets the group mode of SWDL.
Function
This command sets the group mode by group ID and mode.
Usage Note
This command is valid when the software package is loaded.
Category
SWDL
Security
Maintenance
Command Syntax
ED-GROUPMODE:[<TID>]::<CTAG>::<SWDL_GROUPID>,<GROUP_ACTMODE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
ED-GROUPMODE:::100::1,MANUAL;
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD
;
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.12 RTRV-GROUPSTATUS
Retrieves the group status of SWDL.
Function
This command retrieves the group status.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-GROUPSTATUS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<SWDL_GROUPID>,<GROUP_ACTMODE>,<GROUP_ACTSTATUS>,<GROUP_ACTRESULT>"<cr>
<lf>
;
Response Parameters
Parameter Description
<SWDL_GROUPID> Indicates the group ID. The valid value ranges from 1 to 65535.
<GROUP_ACTMODE> Indicates the active mode. The valid values are MANUAL and
Parameter Description
AUTO.
<GROUP_ACTSTATUS> Indicates the active status. The valid values are as follows:
COMPLETED
READY
ACTIVING
PENDING
<GROUP_ACTRESULT> Indicates the active result. The valid values are as follows:
SUCCESS
FAIL
UNKNOWN
Example
Command
RTRV-GROUPSTATUS:::100;
Response Message
NE 2004-07-08 17:16:08
M 100 COMPLD
"SWDL_GROUPID=1,GROUP_ACTMODE=AUTO,GROUP_ACTSTATUS=READY,GROUP_ACTRESULT=UN
KNOWN"
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.11 ED-GROUPMODE
D.33.13 REPT^GROUP^ACTIVITED
Reports that a group has been activated.
Function
This event is reported by the SCC to provide information about the group, such as
SWDL_GROUPID, GROUP_ACTMODE, GROUP_ACTSTATUS, and
GROUP_ACTRESULT after a group is activated.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^ REPT^GROUP^ACTIVITED <cr><lf>
^^^"
SWDL_GROUPID=<SWDL_GROUPID>,GROUP_ACTMODE=<GROUP_ACTMODE>,GROUP_ACTSTATUS=<
GROUP_ACTSTATUS>,GROUP_ACTRESULT=<GROUP_ACTRESULT> "<cr><lf>
;
Response Parameters
Parameter Description
GROUP_ACTMODE Indicates the active mode. The valid values are MANUAL and
AUTO.
GROUP_ACTSTATUS Indicates the active status. The valid values are COMPLETED,
READY, ACTIVING, and PENDING.
GROUP_ACTRESULT Indicates the active result. The valid values are SUCCESS, FAIL,
and UNKNOWN.
Example
Command
None
Response Message
NE 2005-06-28 15:56:46
A 52 REPT GROUP ACTIVITED
" SWDL_GROUPID=3,GROUP_ACTMODE=AUTO,GROUP_ACTSTATUS=
COMPLETED,GROUP_ACTRESULT= SUCCESS"
;
Related Commands
None
D.33.14 COMMIT-SW
Commits the newly downloaded software package.
Function
This command is issued to commit the newly downloaded software package. After issuing
this command, users cannot roll back the software to the previous version.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
COMMIT-SW:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>;
Response Parameters
None
Example
Command
COMMIT-SW:::100;
Response Message
NE 2004-06-20 15:24:58
M 100 COMPLD
;
Related Commands
None
D.33.15 COPY-RFILE
Copy files from a PC to an NE , from an NE to a PC.
Function
This command supports downloading of remote files and uploading of local files.
Usage Note
xFtp url:
1.ftp://<user>:<password>@<ftpserverip>[:<port>]/[url-path]
2.sftp://<user>:<password>@<sshserverip>[:<port>]/[url-path]
3.sftp_key://<user>:<passphrase>@<sshserverip>[:<port>]/[url-path]
file url:
1.file://<url-path>
passphrase – The passphrase of the ssh private key file. See related command of ssh.
The RFR/RFBU parameters can be used for debug purpose only to download/upload a single
file. If the operation fails, automatic rollback can be performed, and there will be broken
files. You can use the DLT-FILE command to delete the broken files.
Category
System
Security
Super
Command Syntax
COPY-RFILE:[<TID>]:
[<AID>]:<CTAG>::<FTYPE>,<SRCURL>,<DSTURL>,<OVERWRITE>;
Command Parameters
Parameter Description Default Value
<OVERWRITE> yes or no NA
NOTE:
This parameter is only used for
RFR.
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
Response Parameters
None
Example
Command
COPY-
RFILE:::100::swdl,"ftp://user:password@129.9.1.1:21/pkg/new.pkg","",no;
COPY-
RFILE:::100::dbfdl,"ftp://user:password@129.9.1.1:21/backup/dbf.pkg","",no;
COPY-RFILE:::100::dbful,"","ftp://user:password@129.9.1.1:21/backup/",no;
COPY-
RFILE:::100::rfr,"sftp://user:password@129.9.1.1:22/backup/ne.ini","file://
ofs1/hwx/ne.ini",yes;
COPY-RFILE::SLOT-1-
18:100::rfr,"sftp://user:password@129.9.1.1:22/backup/ne.ini","file://ofs1/
hwx/ne.ini",yes;
COPY-
RFILE:::100::rfbu,"file://ofs1/hwx/ne.ini","sftp://user:password@129.9.1.1:
22/backup/ne.ini",no;
COPY-RFILE::SLOT-1-
18:100::rfbu,"file://ofs1/hwx/ne.ini","sftp://user:password@129.9.1.1:22/ba
ckup/ne.ini",no;
COPY-
RFILE:::100::fcdl,"sftp://user:password@129.9.1.1:22/pkg/new.pkg","",no;
COPY-RFILE:::100::logul,"","sftp://user:password@129.9.1.1:22/backup/",no;
COPY-
RFILE:::100::oplogul,"","sftp_key://user:passphrase@129.9.1.1:22/backup/",n
o;
COPY-
RFILE:::100::pelogul,"","sftp_key://user:passphrase@129.9.1.1:22/backup/",n
o;
COPY-RFILE:::100::infocol,"","sftp_key://user:@129.9.1.1:22/backup/",no;
COPY-
RFILE:::100::patchpkg,"sftp_key://user:@129.9.1.1:22/pkg/sph001.pkg","",no;
Response Message
NE 2004-06-20 15:18:53
M 100 COMPLD
;
Related Commands
D.31.34 ENT-SSH-HOSTKEY
D.31.30 ED-SSH-PASSPHRASE
D.31.29 DLT-SSH-HOSTKEY
D.31.35 RTRV-SSH-HOSTKEY
D.33.16 COPY-OLDVERFILE
Copy a file to sepecified board on an NE.
Function
This command Copy a file to sepecified board on an NE.
Usage Note
none
Category
System
Security
Super
Command Syntax
COPY-OLDVERFILE:[<TID>]::<CTAG>::<Slot_Num>,<SoftName>;
Command Parameters
Response Syntax
NULL
Example
Command
COPY-OLDVERFILE::SLOT-1-7:100::/ofs1/hwx/bdsoft.hwx"
Response Message
NEW-NE 2011-07-29 03:50:08
M 100 COMPLD
;
Related Commands
NONE
D.33.17 CPY-MEM
Copies files from the RAM disk to the flash memory.
Function
This command only supports file copy at a local NE, and does not support copying of remote
files. In distributed storage, it is a null operation. The command is issued to copy a recently
downloaded software package that is saved from the RAM disk into the standby bank of an
NE or other destination cards.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
CPY-MEM:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^<cr><lf>
Response Parameters
None
Example
Command
CPY-MEM:::100;
Response Message
NE 2004-06-20 15:20:42
M 100 COMPLD
;
Related Commands
None
D.33.18 DLT-FILE
Delete a specified file on an NE.
Function
This Command will Delete a specified file on an NE.
Usage Note
NONE
Category
software
Security
Super
Command Syntax
DLT-FILE:[<TID>]:
[<SFTM_SLOT_SOR>]:<CTAG>::<SFTM_FILE_NAME_SIXTY>
Command Parameters
Response Syntax
NONE
Response Parameters
None
Example
Command
DLT-FILE::SLOT-1-2:100::/ofs1/hwx/ne.ini;
Response Message
NEW-NE 2011-07-29 03:50:08
M 100 COMPLD
;
Related Commands
None
D.33.19 ENT-SWDU-DUINFO
Creates the software package diffusion information for the local NE.
Function
This command edits or set the address of the first node, upstream node, and downstream node
for the software package diffusion of the local NE.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
ENT-SWDU-DUINFO:[<TID>]::<CTAG>::<FirstNode>, <UpNode>, <DownNode>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-SWDU-DUINFO:::10::0x81090001,0x81090002,0x81090003;
Response Message
NE 2006-11-10 15:57:06
M 10 COMPLD ;
Related Commands
None
D.33.20 RESET-ACTGROUP
Reset Actgroup To default Product rule.
Function
This command Reset Actgroup To default Product rule.
Usage Note
none
Category
Software
Security
Maintenance
Command Syntax
RESET-ACTGROUP:[<TID>]::<CTAG>::
Command Parameters
NOTE:
None
Response Syntax
NONE
Example
Command
RESET-ACTGROUP:::100;
Response Message
NEW-NE 2011-07-29 03:50:08
M 100 COMPLD
;
Related Commands
NONE
D.33.21 RTRV-FILE
Get File Information.
Function
When issuing this command, the system will Get File Information.
Usage Note
This command can Get File Information.
Category
System
Security
Maintenance
Command Syntax
RTRV-FILE:[<TID>]:[<SFTM_SLOT\>]:<CTAG>::<FILEURL>;
Command Parameters
Response Syntax
Slot_Num=<SFTM_SLOT>,FileType=<OSPFILETYPE>
FileName=<FILENAME40>,Version=<FILEVERSION>,FileSize=<FILESIZE>;
Response Parameters
Parameter Description Default Value
Example
Command
RTRV-FILE::SLOT-1-17:100::"file://ofs1/hwx/ne.ini";
Response Message
NE169-1 2012-05-15 15:42:48
M 100 COMPLD
"SLOT_NUM=SLOT-1-
17,FILETYPE=INI,FILENAME=ne.ini,VERSION=5.51.08.13T01,FILESIZE=19524"
Related Commands
None
D.33.22 RTRV-FPATROL-STATE
Get Ne Fpatrol State.
Function
When issuing this command,the system will respone the state of ne fpatrol
Usage Note
This command can respone the state of ne fpatrol.
Category
System
Security
Retrieve
Command Syntax
RTRV-FPATROL-STATE:[<TID>]:[<SFTM_SLOT>]:<CTAG>::<PATROL_TYPE>;
Command Parameters
NA
<PATROL_TYPE> Indicates a PATROL_TYPE you
want to check. It can be any of
the following:
Response Syntax
<SFTM_SLOT>:<PATROL_TYPE>:<PATROL_STATE>;
Response Parameters
Example
Command
RTRV-FPATROL-STATE::SLOT-1-17:100::FILEPATROL;
Response Message
NE169-1 2012-05-15 15:31:25
M 100 COMPLD
"SLOT-1-17:FILEPATROL:START"
Related Commands
None
D.33.23 RTRV-SOFT-VER
Get Current NE soft version.
Function
When issuing this command, the system will response the current NE version including
soft/bios/exbios/logic.
Usage Note
This command can response the current NE version including soft/bios/exbios/logic.
Category
System
Security
Retrieve
Command Syntax
RTRV-SOFT-VER:[<TID>]:<SFTM_SLOT>:<CTAG>::<SFTM_VER_SOR>;
Command Parameters
Response Syntax
SoftName=<SoftName>,SoftVer=<SoftVer>
SoftVerDate=<SoftVerDate>,SoftStatus=<SoftStatus>;
Response Parameters
Example
Command
RTRV-SOFT-VER::SLOT-1-17:100::FILE;
Response Message
NE169-1 2012-05-15 10:58:58
M 100 RTRV
"SOFTNAME=NSF1,SOFTVER=5.51.08.13,SOFTVERDATE=20120511,SOFTSTATUS=active"
"SOFTNAME=NSF2,SOFTVER=5.51.08.13,SOFTVERDATE=20120511,SOFTSTATUS=inactive"
"SOFTNAME=NeSoft(D),SOFTVER=5.51.08.13,SOFTVERDATE=20120511,SOFTSTATUS="
"SOFTNAME=Platform,SOFTVER=5.00.28.613,SOFTVERDATE=20120512,SOFTSTATUS="
"SOFTNAME=INI1,SOFTVER=5.51.08.13,SOFTVERDATE=20120505,SOFTSTATUS=active"
"SOFTNAME=INI2,SOFTVER=5.51.08.13,SOFTVERDATE=20120505,SOFTSTATUS=inactive"
"SOFTNAME=BIOS,SOFTVER=8.20.66,SOFTVERDATE=20100423,SOFTSTATUS=inactive"
"SOFTNAME=ExtBIOS,SOFTVER=9.20.79,SOFTVERDATE=20120505,SOFTSTATUS=active"
"SOFTNAME=PCB,SOFTVER=VER.A,SOFTVERDATE=,SOFTSTATUS="
"SOFTNAME=Logic,SOFTVER=(U18)430,SOFTVERDATE=,SOFTSTATUS="
"SOFTNAME=LogicE01,SOFTVER=(U10)110,SOFTVERDATE=,SOFTSTATUS="
>
>
Related Commands
None
D.33.24 RTRV-SWDU-DUINFO
Retrieves the software package diffusion information about the local NE.
Function
This command retrieves the addresses of the first node, upstream node, and downstream node
for the software package diffusion of the local NE.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDU-DUINFO:[<TID>]::[<CTAG>];
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<DuNodeRole>,<DuNode>"
<cr><lf>
;
Response Parameters
Parameter Description
Indicates the type of the node. The valid values are FIRSTNODE, UPNODE,
<DuNodeRole> and DOWNNODE.
Example
Command
RTRV-SWDU-DUINFO:::10;
Response Message
NE 2006-11-10 15:57:06
M 10 COMPLD
"FIRSTNODE, 0x81090001"
"UPNODE, 0x81090002"
"DOWNNODE, 0x81090003"
"DOWNNODE, 0x81090004"
Related Commands
None
D.33.25 RTRV-SWDU-DUSTATE
Retrieves the software package diffusion state of the local NE.
Function
This command retrieves the state of the software package diffusion of the local NE.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDU-DUSTATE:[<TID>]::[<CTAG>];
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"DuState=<DuState>"
<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDU-DUSTATE:::10;
Response Message
NE 2006-11-10 15:57:06
M 10 COMPLD
"DUSTATE=NONE"
Related Commands
None
D.33.26 RTRV-UPGRADE-BDLIST
Retrieves the list of cards that are being upgraded.
Function
This command retrieves the list of cards that are being upgraded.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-UPGRADE-BDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"< SWDL_BID >,< INIT_TYPE >"<cr><lf>
;
Response Parameters
Parameter Description
INIT_TYPE Indicates the reset type. The valid values are as follows:
COLD: indicates the cold reset, during which the FPGA is
erased for reloading.
WARM: indicates the warm reset, during which the FPGA is not
erased.
NRST: indicates that no reset is necessary.
Example
Command
RTRV-UPGRADE-BDLIST:::100;
Response Message
NE 2004-07-08 17:16:08
M 10 COMPLD
"slot-1-1,COLD"
Related Commands
None
D.33.27 RTRV-PKGTYPE
Retrieves the type of software package customization. This command can only be used on the
U2000 to customize software packages.
Function
This command retrieves the type of software package customization. This command can only
be used on the U2000 to customize software packages.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-PKGTYPE:[<TID>]::<CTAG>::<BANK>;
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" PKG_CUSTOMIZE_TYPE=<PKGTYPE> "<cr><lf>
;
Response Parameters
Parameter Description
<PKGTYPE> Indicates the package customization type on the NE. The valid
values are as follows:
a specified NE.
Example
Command
RTRV-PKGTYPE:::100::ACTIVE;
Response Message
NE 2005-07-01 10:11:24
M 100 COMPLD
"PKG_CUSTOMIZE_TYPE=WHOLE"
;
Related Commands
None
D.33.28 RTRV-PKGVER
Retrieves the versions of the active and standby programs of the software package. If a
software package is not saved in the SCC, an empty message is returned but the command
response is complete.
Function
This command retrieves the versions of the active and standby programs of the software
package. If a software package is not saved in the SCC, an empty message is returned but the
command response is completed.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-PKGVER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"ACTSWPVER=<ACTSWPVER>, STDBYSWPVER=<STDBYSWPVER>"
Response Parameters
Parameter Description
Example
Command
RTRV-PKGVER:::100;
Response Message
NE 2004-06-20 15:11:03
M 100 COMPLD
"ACTSWPVER=V100R001C01B01k,STDBYSWPVER=V100R001C01B01k"
;
Related Commands
None
D.33.29 RTRV-PKTSTAT
Retrieves the packet statistics of the local NE.
Function
Retrieves the packet statistics of the local NE.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-PKTSTAT:[<TID>]::<SFTM_SLOT>:[<CTAG>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"
Total_Packet=<TOTAL_PKT>,Checksum_Error=<ERR_CKS_PKT>,Data_Error=<ERR_DATA_
PKT>,Valid_Packet=<VALID_PKT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
rtrv-pktstat::SLOT-1-18:100;
Response Message
NE 2000-01-03 10:44:46
M 100 COMPLD
"TOTAL_PACKET=0,CHECKSUM_ERROR=0,DATA_ERROR=0,VALID_PACKET=0"
;
>
Related Commands
None
D.33.30 RTRV-STATE
Retrieves the state during software package loading and database backup/restoration.
Function
This command retrieves the state during software package loading and database
backup/restore.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-STATE:[<TID>]::<CTAG>::<FTYPE>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"FTYPE=<FTYPE>,MAINSTATE=<MAINSTATE>,SUBSTATE=<SUBSTATE>"
;
Response Parameters
Parameter Description
<FTYPE> Indicates the type of the software loading. The valid values are as
follows:
SWDL: Downloads the software package from an FTP server
to the NE.
DBFUL: Backs up the database from the NE to an FTP
server.
DBFDL: Restores the database from an FTP server to the NE.
FCDL: Force to use custom-built method to download
software package
PELOGUL: uploading Log file in cf card from NE to PC.
OPLOGUL: uploading Operational Log file from NE to PC.
LOGUL: uploading log file from NE to PC.
POSTUL: uploading post file from NE to PC.
POSTHISUL: uploading history post file from NE to PC.
INFOCOL: uploading file from NE to PC.
<MAINSTATE> When <FTYPE> is set to SWDL/FCDL, the valid values are as follows:
NORMAL: indicates that an SWDL is not underway.
CPY_FILE_START: indicates that the copying of files is underway.
CPY_FILE_END: indicates that the COPY-RFILE command
succeeded and waits to proceed with the CPY-MEM command.
CPY_MEM_START: indicates that the CPY-MEM command is
underway.
CPY_MEM_END: indicates that the CPY-MEM succeeded and waits
to proceed with the INIT-SYS command.
ACTIVE: indicates that the NE is activating the newly loaded
software.
ACTIVATED: indicates that the newly loaded software has been
successfully activated and waits to proceeds with the COMMIT-SW
command.
COMMITTING: indicates that the COMMIT-SW command is
Parameter Description
underway.
ROLLBACK: indicates that the NE is rolled back due to the ABT-
CMD or some error occurred.
When the input parameter <FTYPE> is DBFDL, the valid values are as
follows:
NORMAL: indicates that the database restoration is not underway.
DOWNLOADING: indicates that database restoration is underway.
DOWNLOADEND: indicates the file downloading for database
restoration is finished and waits to proceed with the INIT-SYS command.
CPYFILE_HALT: indicates that some errors occurred during
database downloading and waits to resolve the problem and re-transfer by
using the same command.
When the input parameter <FTYPE> is
DBFUL/PELOGUL/OPLOGUL/LOGUL/POSTUL/POSTHISUL/INFOCOL,
the valid values are:
NORMAL: indicates that the database backup is not underway.
UPLOADING: indicates that the database backup is underway.
CPYFILE_HALT: indicates that some errors occurred during
database uploading and waits to resolve the problem and retransfer with
the same command.
<SUBSTATE> This parameter is valid only when <FTYPE> is set to SWDL and
<MAINSTATE> is set to NORMAL. <SUBSTATE> is always NORMAL
and can be ignored when <FTYPE> is set to DBFDL or DBFUL.
When <MAINSTATE> is set to NORMAL, valid values are as follows:
NORMAL: indicates that the SWDL can be executed.
UNSTABLE: indicates that the system is not stable because of a
reboot or AUTOSYNC/AUTOSWDL. Software downloads cannot be
executed in this situation.
AUTOSYNC: indicates that the package is synchronized to a newly
inserted standby SCC. Software downloads cannot be executed in this
situation.
AUTOSWDL: indicates that the system is automatically performing
an SWDL to a newly inserted card Software downloads cannot be
executed in this situation.
When the output parameter <MAINSTATE> is CPY_FILE_START, the valid
values are as follows:
NORMAL: indicates that the COPY-RFILE command is executed
normally.
SWDU: indicates in sdwu mode and the COPY-RFILE command is
executed normally.
CPYFILE_HALT: indicates that some errors occurred during file
downloading and waits to resolve the problem and re-transfer by using the
same command.
When <MAINSTATE> is set to ACTIVE, the valid values are as follows:
NORMAL: indicates that the NE is preparing to activate a certain
card.
Parameter Description
Example
Command
RTRV-STATE:::100::SWDL;
Response Message
NE 2004-04-07 15:16:07
M 100 COMPLD
"FTYPE=SWDL,MAINSTATE=NORMAL,SUBSTATE=NORMAL" ;
Related Commands
None
D.33.31 REPT^EVT^AUTOSWDL
Reports that an automatic SWDL is underway.
Function
An NE automatically updates its software with the files in the software package on the
inserted SCC card if there are any discrepancies between the software versions. The
REPT_EVT_AUTOSWDL response indicates an automatic SWDL is underway.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^AUTOSWDL<cr><lf>
^^^"AID=<BID>,EQPTTYPE=<BDTYPE>[,RSLT=<RSLT>]"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 1990-01-03 20:06:54
A 303 REPT EVT AUTOSWDL
"AID=SLOT-1-7,EQPTTYPE=11L4G,RSLT=SUCCESS"
;
Related Commands
None
D.33.32 REPT^EVT^AUTOSYNC
Reports when the software package of a newly inserted standby SCC is automatically
synchronized to the active SCC.
Function
Reports that the software package of a standby SCC that is inserted into an NE is
automatically synchronized to the active SCC if there are any discrepancies between the
software versions. The REPT_EVT_AUTOSYNC response indicates that an automatic
synchronization is underway.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^AUTOSYNC <cr><lf>
^^^"AID=<Bid>,EQPTTYPE=<BdType>[,RSLT=<rslt>]"<cr><lf>
;
Response Parameters
Parameters Description
<BDTYPE> Indicates the actual type of the card, for example, OC48.
<RSLT> Automatic download is still underway if a result is not displayed. The valid
values for results of AUTOSWDL are as follows:
SUCCESS: indicates that an automatic SWDL for the card was
successful.
SW-FAILURE: indicates that an automatic SWDL for the card failed
due to a software-related problem, such as a link break between the SCC
and the card.
HW-FAILURE: indicates that an automatic SWDL for the card failed
due to a hardware-related problem. Usually, the failure occurs because no
file for the card is found in the software package of the SCC.
Example
Command
None
Response Message
NE 2005-07-01 11:29:03
A 197 REPT EVT AUTOSYNC
"AID=SLOT-10,EQPTTYPE=OC48"
Related Commands
None
D.33.33 REPT^EVT^BDSWDL
Reports information about the cards that are to be upgraded during SWDL.
Function
After the COPY-RFILE command is issued to load all the files to the active SCC and before
the ending event is reported, the REPT_EVT_BDSWDL event is reported to the cards that
are to be upgraded during SWDL. Users should pay special attention to the reset type of the
card during the INIT-SYS process.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^BDSWDL<cr><lf>
^^^"AID=<BID>,BDTYPE=<BDTYPE>,INITTYPE=<INITTYPE>"<cr><lf>
;
Response Parameters
Parameter Description
<INITTYPE> Indicates the reset type of the card during the INIT-SYS process.
The valid values are as follows:
COLD: indicates a cold reset, during which the FPGA is
erased for reloading.
WARM: indicates a warm reset, during which the FPGA
is not erased.
NRST: indicates that a reset is unnecessary (no reset).
Example
Command
None
Response Message
NE 2005-06-28 15:56:46
A 52 REPT EVT BDSWDL
"AID=SLOT-1-4,BDTYPE=11L4G,INITTYPE=COLD"
;
NE 2005-06-28 15:56:46
A 53 REPT EVT BDSWDL
"AID=SLOT-1-7,BDTYPE=11L4G,INITTYPE=COLD"
;
Related Commands
None
D.33.34 REPT^EVT^COMMITRSLT
Reports the result of a commit operation.
Function
This event is reported to indicate the detailed result of a commit operation of a card.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^ COMMITRSLT <cr><lf>
"BID=<SLOT-S-N>,RSLT=<Result>" ;
Response Parameters
Parameter Description
Indicates the slot number of the card which is related to this commit
<SLOT-S-N> result.
<Result> Indicates the rollback result. The valid values are SUCCESS and
FAILURE.
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT COMMITRSLT
"BID=SLOT-1-9,RSLT=FAILURE " ;
Related Commands
None
D.33.35 REPT^EVT^CPYMEM
Reports the progress of a CPY-MEM command.
Function
This event is reported to indicate the completion percentage of a CPY-MEM command. This
event indicates the start and end time of the loading, whether the cards are loaded with
software, and how many cards need to be loaded.
Usage Note
This event is not reported when the software package of the standby SCC is synchronized to
that of the active SCC.
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^CPYMEM<cr><lf>
^^^"AID=<Bid>,XFRSTATUS=<xfr_status>,[RSLT=<rslt>][,SLOTSDONE=<slots_done>]
[,SLOTSTTL=<slots_total>]"<cr><lf>
;
Response Parameters
Parameter Description
<XFR_STATUS> Indicates the status of file transfer. The valid values are
COMPLTD and STARTED.
COMPLTD: indicates that the transfer is complete.
STARTED: indicates that the file transfer is underway.
<RSLT> Indicates the result of file transfer. The valid values are SUCCESS
and FAILURE. It is reported only when <XFR_STATUS> is set
to COMPLTD.
Example
Command
None
Response Message
NE 2005-06-28 15:57:17
A 57 REPT EVT CPYMEM
"AID=SLOT-1-8,XFRSTATUS=STARTED"
;
NE 2005-06-28 15:57:37
A 58 REPT EVT CPYMEM
"AID=SLOT-1-8,XFRSTATUS=COMPLTD,RSLT=SUCCESS,SLOTSDONE=2,SLOTSTTL=2"
;
Related Commands
None
D.33.36 REPT^EVT^FXFR
Function
1.After the user starts a file transfer by using the COPY-RFILE command, the NE reports the
REPT^EVT^FXFR event to inform the user when the file transfer is completed. When an
integrated software package transfer is completed, the NE reports this event.
2.After the software package of the standby SCC is synchronized to that of the active SCC
through the CPY-MEM command and the new software is loaded to the target cards, the NE
reports the REPT^EVT^FXFR event to inform the user of the completion of the CPY-MEM
command.
3.After the user activates the new software by using the INIT-SYS command, the cards take
time to perform resets as the software is upgraded in a certain sequence. In this scenario, wait
several minutes to check whether the system is functioning properly (switching may occur
between the active and standby SCCs). If the system is functioning properly, it indicates that
the new software works normally and can be committed.The NE reports the
REPT^EVT^FXFR event to inform the user of the completion of the INIT-SYS command.
4.After a COMMIT command is issued, all the cards copy the new software package from the
standby bank to the active bank. The NE reports the REPT^EVT^FXFR event to inform the
user of the completion of the COMMIT command, and then the NE changes to the normal
state.
5.REPT^EVT^FXFR,this event is reported to indicate that an error occurred during the
execution of the COMMIT command. The NE, however, does not roll back and turns to the
normal state.
6.REPT^EVT^FXFR,this event reports a board is excluded in swdl progress.Usually an error
has occured on that board.
7.REPT^EVT^FXFR,Reports that CPY-MEM excludebd task is started.
8.REPT^EVT^FXFR,Reports that activing excludebd task is started.
9.REPT^EVT^FXFR,this event reports the swdl package is customed automatically.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
If the event is one file transfer completed,response as follow:
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^FXFR<cr><lf>
"FILENAME=<FILENAME>, FXFR_STATUS=<FXFR_STATUS>,RSLT=<RESULT>,
FILES_DONE=<FILES_DONE>, FILES_TOTAL=<FILES_TOTAL>";
Other situation:
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^FXFR<cr><lf>
Response Parameters
Parameter Description
<FILENAME> Indicates the name of the current file that is being downloaded.
<FXFR_STATUS> Indicates file downloading status. The valid values are STARTED and
COMPLTD.
<RESULT> Indicates the file download result. The valid values are SUCCESS and
FAILURE. This parameter is only displayed when FXFR_STATUS is
set to COMPLTD.
Indicates how many files have been downloaded. This parameter is only
<FILES_DONE> displayed when FXFR_STATUS is set to COMPLTD.
<FILES_TOTAL> Indicates the total files that need to download. This parameter is only
displayed when FXFR_STATUS is set to COMPLTD.
Example
Command
None
Response Message
If the event is CPYFILE_END,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
"FILENAME=NE.INI,FXFR_STATUS=COMPLTD,RSLT=SUCCESS,FILES_DONE=2,FILES_TOTAL=
26",;,
If the event is CPYMEMEND,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":CPY-MEM-END,TC,,,,,,\",
If the event is ACTIVATED,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
"":ACTIVATED,TC,,,,,,\"",;,
If the event is COMMITEND,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":COMMIT-END,TC,,,,,,\",;,
If the event is COMMITFAILED,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":COMMIT-FAILED,TC,,,,,,\",;,
If the event is BOARD EXCLUDED,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":BOARD-EXCLUDED,TC,,,,,,",;,
If the event is DNLDEXCLUDEBD START,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":DNLD-EXCLUDEBD-START,TC,,,,,,",;,
If the event is ACTIVEEXCLUDEBD START,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":ACTIVE-EXCLUDEBD-START,TC,,,,,,",;,
If the event is AUTOCUSTOM,example like this:
NE 2009-10-18 17:39:46,
A 85214 REPT EVT FXFR,
":PKG-AUTO-CUSTOMIZED,TC,,,,,,",;,
Related Commands
None
D.33.37 REPT^EVT^FXFRHALT
Reports a link break event when files are transferred during the execution of the COPY-
RFILE command.
Function
This event is reported when files are obtained from the FTP server. If the link between the
NE and the FTP server breaks, the NE reports this event to inform the user, and then waits
several minutes before rollback occurs automatically. During the waiting time, the user can
use the same command to check whether the file transfer can be continued.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^ FXFRHALT <cr><lf>
"TRANSFEREDFILES=<FINISHED>, TOTALNUM=<TOTAL>, WTIME=<WTIME>"
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT FXFRHALT
"TRANSFEREDFILES=10,TOTALNUM=17,WTIME=15"
;
Related Commands
None
D.33.38 REPT^EVT^INIT
Reports a card initialization event during the execution of the INIT-SYS command of SWDL.
Function
This event is reported if a card starts to activate the new software when a new software is
activated by using the TL1 command: (INIT-SYS::SLOT-1-ALL:1001::SWDL;).
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
A^^^<ATAG>^REPT^EVT^INIT<cr><lf>
^^^"AID=<Bid>,INITTYPE=<InitType>"<cr><lf>
;
Response Parameters
Parameter Description
<InitType> Indicates the reset type of the unit during the execution of the INIT-SYS
command:
COLD: indicates a cold reset. In this case of a cold reset, the FPGA is
erased for reloading.
WARM: indicates a warm reset. In this case of a warm reset, the FPGA is
not erased.
NRST: indicates that a reset is unnecessary (no reset).
Example
Command
None
Response Message
NE 2005-06-28 15:58:49
A 61 REPT EVT INIT
"AID=SLOT-1-9,INITTYPE=COLD"
;
Related Commands
None
D.33.39 REPT^EVT^NOSWINPKG
Reports that there is not any software in the new package that matches with the type of the
card.
Function
In the execution of the CPY-MEM command, there is not any software in the new package
that matches with the type of the card. The software of the card is not updated. The user can
choose to terminate the SWDL or to ignore it.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^NOSWINPKG<cr><lf>
"AID=<AID>,BDTYPE=<BDTYPE>,PCB=<PCB>"
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 15:20:42
A 68 REPT EVT NOSWINPKG
"AID=SLOT-1-4,BDTYPE=11L4G,PCB=2"
;
Related Commands
None
D.33.40 REPT^EVT^PKGNOTSAME
Reports that the file transfer has resumed but the package file is different from when the
transfer was first initiated.
Function
This event is reported to indicate that the file transfer has resumed but the package file is
different from when the transfer was first initiated.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT ^PKGNOTSAME <cr><lf>
"";
Response Parameters
None
Example
Command
None
Response Message
NE 2004-06-20 14:55:15
A 27 REPT EVT PKGNOTSAME
;
Related Commands
None
D.33.41 REPT^EVT^ROLLBACKSTART
Reports that the system has started to roll back to the original software package when an error
occurs during the SWDL.
Function
Reports that the system has started to roll back to the original software package when an error
occurs during the SWDL. The beginning of the rollback will not be reported if the user
terminates the SWDL manually.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^ROLLBACKSTART<cr><lf>
"";
Response Parameters
None
Example
Command
None
Response Message
NE 2004-06-20 15:07:33
A 48 REPT EVT ROLLBACKSTART
;
Related Commands
None
D.33.42 REPT^EVT^ROLLBACKEND
Reports that the system has rolled back to the original software package when the SWDL was
not completed.
Function
When an error occurs during the SWDL or the user issues the ABT-CMD command to
terminate the SWDL, the system rolls back and this event is reported after the rollback is
performed.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^ROLLBACKEND<cr><lf>
"";
Response Parameters
None
Example
Command
None
Response Message
NE 2004-06-20 15:17:33
A 49 REPT EVT ROLLBACKEND
;
Related Commands
None
D.33.43 REPT^EVT^ROLLBACKRSLT
Reports the result of the rollback.
Function
This event is reported to indicate the detailed result of the rollback on a card.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
A^^^<ATAG>^REPT^EVT^ROLLBACKRSLT <cr><lf>
"BID=<SLOT-S-N>,RSLT=<RESULT>"
;
Response Parameters
Parameter Description
Indicates the slot number of the card which is related to this rollback
<BID> result.
<RESULT> Indicates the rollback result. The valid values are SUCCESS and
FAILURE.
Example
Command
None
Response Message
NE 2004-06-20 14:42:05
A 19 REPT EVT ROLLBACKRSLT
"BID=SLOT-1-9,RSLT=FAILURE "
;
Related Commands
None
D.33.44 ABT-COPY-END
Aborts SWDL processing to the state is CPY_FILE_END.
Function
When issuing this command, the system aborts SWDL and attempts to roll back to the state
of SWDL is CPY_FILE_END. Software download (SWDL) denotes downloading software
packages from a PC to an NE.
Usage Note
This command can only abort software package downloading.
Category
System
Security
Maintenance
Command Syntax
ABT-COPY-END:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ABT-COPY-END:::100;
Response Message
NE 2011-09-24 22:38:54
M 100 COMPLD
;
Related Commands
None
D.33.45 RTRV-SWDL-ONLINEBDLIST
Retrieves the information about the boards in the online card list.
Function
Retrieves the information about the boards in the online card list. the information include the
card ID, the acting group id, PCB, the card type, the number of flsh, the reset type, the main
state of SWDL, the sub-state of SWDL and the result of SWDL.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-ONLINEBDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"BID=< SWDL_BID >,SWDL_GROUPID=< SWDL_GROUPID >,
BdType=<BdType>,PCB=<PCB>,BdClass=<SWDL_BDCLASS>,OfsNum=<SWDL_OFSNUM>,INIT_
TYPE=<INIT_TYPE>,MainState=<SWDL_MAINSTATE>,SubState=<SWDL_SUBSTATE>,Result
=<SWDL_RESULT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-ONLINEBDLIST:::100;
Response Message
NE118 2000-01-01 08:47:59
M 100 COMPLD
"BID=SLOT-1-
18,SWDL_GROUPID=0,BDTYPE=1289,PCB=1,BDCLASS=OSP,OFSNUM=2,INIT_TYPE=NRST,MAI
NSTATE=NORMAL,SUBSTATE=NORMAL,RESULT=SUCCESS"
"BID=SLOT-1-
5,SWDL_GROUPID=0,BDTYPE=927,PCB=1,BDCLASS=OSP,OFSNUM=2,INIT_TYPE=NRST,MAINS
TATE=NORMAL,SUBSTATE=NORMAL,RESULT=LOSS_PKG"
"BID=SLOT-1-
13,SWDL_GROUPID=0,BDTYPE=919,PCB=1,BDCLASS=OSP,OFSNUM=1,INIT_TYPE=NRST,MAIN
STATE=NORMAL,SUBSTATE=NORMAL,RESULT=LOSS_PKG"
"BID=SLOT-1-
6,SWDL_GROUPID=0,BDTYPE=1197,PCB=1,BDCLASS=OSP,OFSNUM=1,INIT_TYPE=NRST,MAIN
STATE=NORMAL,SUBSTATE=NORMAL,RESULT=LOSS_PKG"
"BID=SLOT-1-
15,SWDL_GROUPID=0,BDTYPE=1568,PCB=1,BDCLASS=OSP,OFSNUM=1,INIT_TYPE=NRST,MAI
NSTATE=NORMAL,SUBSTATE=NORMAL,RESULT=LOSS_PKG"
;
Related Commands
None
D.33.46 RTRV-SWDL-DISTRIBUTEINFO
Retrieves the software distribute information of SWDL.
Function
This command retrieves the software distribute information.
Usage Note
None
Category
Swdl
Security
Maintenance
Command Syntax
RTRV-SWDL-DISTRIBUTEINFO:[<TID>]::<CTAG>::<SWDB_BID>,<SWDB_TYPE>;
Command Parameters
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^" SWDB_INFO =<SWDB_INFO> "<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-DISTRIBUTEINFO:::100::SLOT-1-17,SWDBSTATE;
Response Message
NE 2006-07-20 10:03:08
M 100 COMPLD
"SWDB_INFO=\"WORKING,CMPLD,WORKING\""
;
Related Commands
None
D.33.47 RTRV-SWDL-SUBGROUPSTATUS
Retrieves the subgroups status of SWDL.
Function
This command retrieves the subgroups status.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-SWDL-SUBGROUPSTATUS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<SWDL_GROUPID>,<SUB_GROUPIDX>,<GROUP_ACTMODE>,<GROUP_ACTSTATUS>,<GROUP_
ACTRESULT>"<cr><lf>
;
Response Parameters
Parameter Description
<SWDL_GROUPID> Indicates the group ID. The valid value ranges from 1 to 65535.
<GROUP_ACTMODE> Indicates the active mode. The valid values are MANUAL and
AUTO.
<GROUP_ACTSTATUS> Indicates the active status. The valid values are as follows:
COMPLETED
READY
ACTIVING
PENDING
<GROUP_ACTRESULT> Indicates the active result. The valid values are as follows:
SUCCESS
FAIL
UNKNOWN
Example
Command
RTRV-SWDL-SUBGROUPSTATUS:::100;
Response Message
NE 2011-09-24 17:53:16
M 100 COMPLD
"SWDL_GROUPID=1,SUB_GROUPIDX=1,GROUP_ACTMODE=AUTO,GROUP_ACTSTATUS=READY,GRO
UP_ACTRESULT=UNKNOWN"
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.7 RTRV-SWDLGROUP
D.33.11 ED-GROUPMODE
D.33.48 RTRV-SWDL-SUBGROUP
D.33.48 RTRV-SWDL-SUBGROUP
Retrieves active SWDL subgroups. This command is often used when the groups are
modified.
Function
This command retrieves all the active subgroups.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-SWDL-SUBGROUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"<SWDL_GROUPID>,<SUB_GROUPIDX>,<GROUP_ACTMODE>,<SWDL_BID>"<cr><lf>
;
Response Parameters
Parameter Description
<SWDL_GROUPID> Indicates the group ID. The valid value ranges from 1 to 65535.
<SUB_GROUPIDX> Indicates the subgroup ID. The valid value ranges from 1 to
65535.
<GROUP_ACTMODE> Indicates the active mode. The valid values are MANUAL and
AUTO.
Example
Command
RTRV-SWDL-SUBGROUP:::100;
Response Message
NE 2011-09-24 01:47:48
M 100 COMPLD
"SWDL_GROUPID=1,SUB_GROUPIDX=1,GROUP_ACTMODE=AUTO,SWDL_BID=SLOT-1-29"
Related Commands
D.33.2 ACT-SWDLGROUP
D.33.3 DLT-SWDLGROUP
D.33.4 ED-SWDLGROUP
D.33.6 AUD-SWDLGROUP
D.33.12 RTRV-GROUPSTATUS
D.33.11 ED-GROUPMODE
D.33.47 RTRV-SWDL-SUBGROUPSTATUS
D.33.49 RTRV-SWDL-BDLIST
Get Board information that will participate package loading.
Function
When issuing this command, if para is open, the system will response the information of
boards that particapate package loading
Usage Note
This command can response the information of boards that particapate package loading.
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-BDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
AID=<SWDL_BID>,BdType=<SWDL_NBDTYPE>
PCB=<PCB>,CLASS=<CLASS>;
Response Parameters
Example
Command
RTRV-SWDL-BDLIST:::100;
Response Message
NE169-1 2012-05-15 15:03:22
M 100 COMPLD
"AID=SLOT-1-17,BDTYPE=1564,PCB=0,CLASS=0"
"AID=SLOT-1-8,BDTYPE=1568,PCB=1,CLASS=0"
"AID=SLOT-1-7,BDTYPE=1262,PCB=1,CLASS=0"
"AID=SLOT-1-9,BDTYPE=1182,PCB=2,CLASS=0"
"AID=SLOT-1-2,BDTYPE=1277,PCB=2,CLASS=0"
"AID=SLOT-1-13,BDTYPE=1573,PCB=1,CLASS=0"
"AID=SLOT-1-4,BDTYPE=1277,PCB=2,CLASS=0"
"AID=SLOT-1-12,BDTYPE=1197,PCB=2,CLASS=0"
"AID=SLOT-1-6,BDTYPE=2296,PCB=0,CLASS=0"
Related Commands
None
D.33.50 RTRV-SWDL-CUSTOM
Get SWDL Downloading Type.
Function
When issuing this command, the system will response the current package downloading type.
Usage Note
This command can response the current package downloading type.
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-CUSTOM:[<TID>]::<CTAG>;
Command Parameters
NULL
Response Syntax
MASTERMODE=<SWDL_CUSTOM>,SLAVEMODE=<SWDL_CUSTOMSLAVE>
Response Parameters
NA
<SWDL_CUSTOM> The package loading type of
master board.The valid values
Parameter Description Default Value
are as follows:
WHOLE
CUSTOM
<SWDL_CUSTOMSLAVE> The package loading type of NA
slave board.The valid values are
as follows:
WHOLE
CUSTOM
Example
Command
RTRV-SWDL-CUSTOM:::100;
Response Message
NE169-1 2012-05-15 10:44:04
M 100 COMPLD
"MASTERMODE=WHOLE,SLAVEMODE=WHOLE"
Related Commands
None
D.33.51 RTRV-SWDU-DUMODE
Get package Diffusing mode.
Function
When issuing this command, the system will response the current package Diffusing mode.
Usage Note
This command can package Diffusing mode.
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDU-DUMODE:[<TID>]::<CTAG>;
Command Parameters
NULL
Response Syntax
DuMode=<DuMode>
Response Parameters
None
Example
Command
RTRV-SWDU-DUMODE:::123;
Response Message
NE169-1 2012-05-15 11:17:59
M 123 COMPLD
"DUMODE=DIFFUSE"
Related Commands
None
D.33.52 SET-FPATROL-STATE
Set Fpatrolon State On an NE.
Function
This command Set Fpatrolon State On an NE.
Usage Note
This command can set the state of ne fpatrol.
Category
System
Security
Maintenance
Command Syntax
SET-FPATROL-STATE:[<TID>]:
[<SFTM_SLOT#N\"SLOT_SCC\">]:<CTAG>::<PATROL_TYPE>
Command Parameters
Parameter Description Default Value
NA
<PATROL_TYPE> Indicates a PATROL_TYPE
you want to check.It can be
any of the following:
Response Syntax
NONE
Example
Command
SET-FPATROL-STATE::SLOT-2:100::FILEPATROL,STOP;;
Response Message
NEW-NE 2011-07-29 03:50:08
M 100 COMPLD
;
Related Commands
NONE
D.33.53 STA-NESOFT
Start software in specified device on an NE.
Function
This command Start software in specified device on an NE.
Usage Note
NONE
Category
System
Security
Maintenance
Command Syntax
STA-NESOFT:[<TID>]:[<SFTM_SLOT>]:<CTAG>::<NsfS>;
Command Parameters
Response Syntax
NONE
Response Parameters
NONE
Example
Command
STA-NESOFT::SLOT-17:100::NSF1;
Response Message
NE169-1 2012-05-15 15:31:25
M 100 COMPLD
Related Commands
None
D.33.54 REPT^ACTIVEEXCLUDEBD^END
Reports the event that activing excludebd ends.
Function
Reports the event that activing excludebd ends.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^ACTIVEEXCLUDEBD^END<cr><lf>
^^^"RSLT=<SWDL_RSLT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
OSP-TESTNE1 2013-06-24 21:59:44
A 640863 REPT ACTIVEEXCLUDEBD END
"RSLT=SUCCESS"
Related Commands
None
D.33.55 REPT^EVT^PRESWDLFAIL
Reports the preswdl operate fails.
Function
This event reports that an error occured in preswdl progress.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
A^^^<ATAG>^REPT^EVT^PRESWDLFAIL<cr><lf>
"";
Response Parameters
None
Example
Command
None
Response Message
OSP-TESTNE1 2013-06-24 21:49:32
Related Commands
None
D.33.56 REPT^EVT^PRESWDLSUCCESS
Reports the preswdl operate has been finished successfully.
Function
Reports the preswdl operate has been finished successfully.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
A^^^<ATAG>^REPT^EVT^PRESWDLSUCCESS<cr><lf>
"";
Response Parameters
None
Example
Command
None
Response Message
OSP-TESTNE1 2013-06-24 21:49:32
Related Commands
None
D.33.57 REPT^EVT^SFTMFAIL
Reports that software transport failed unexceptly.
Function
This event is reported to indicate that an error occured in bd software loading.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^SFTMFAIL <cr><lf>
"ERRCODE=<ERRCODEA>, NEID=<NE_IDA>,BoardID=<BOARD_IDA>"
Response Parameters
Parameter Description
Parameter Description
Example
Command
None
Response Message
NE 2004-06-20 14:44:05
A 19 REPT EVT SFTMFAIL
"ERRCODE=<ERRCODEA>, NEID=<NE_IDA>,BoardID=<BOARD_IDA>"
;
Related Commands
None
D.33.58 REPT^EVT^SFTMSTATE
Reports the packet numbers that have transfered.
Function
Reports the packet numbers that have transfered.This event notify users the progress of file
transfering.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^SFTMSTATE<cr><lf>
^^^"DOWNLOAD_FRAMES_NO=<LOAD_NUM>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
OSP-TESTNE1 2013-06-24 19:48:55
"DOWNLOAD_FRAMES_NO=24"
Related Commands
None
D.33.59 REPT^EVT^SFTMSUCCESS
Reports that software management operation finished successfully.
Function
Reports that software management operation finished successfully.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^EVT^SFTMSUCCESS <cr><lf>
"NEID=<NE_IDA>,BoardID=<BOARD_IDA>"
Response Parameters
Parameter Description
Example
Command
None
Response Message
OSP-TESTNE1 2013-06-24 19:48:55
"NEID=638960,BOARDID=SLOT-1-17"
Related Commands
None
D.33.60 REPT^SFTM^NOSOFT
This event is not used now.
Function
This event is not used now.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^SFTM^NOSOFT<cr><lf>
^^^"<SFTM_BID_BY>,<SFTM_BID>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
this event is not used now.
Related Commands
None
D.33.61 REPT^SOFTPACK^NOMATCH
Reports that the software pkg in active and standby bank do not match.
Function
Reports that the software pkg in active and standby bank do not match.This event is not used
now.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^SOFTPACK^NOMATCH<cr><lf>
^^^"<SFTM_BID>,<NOMATCH_TYPE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
this event is not used now.
Related Commands
None
D.33.62 RTRV-NESOFT-VER
Retrieves the NE software version.
Function
This command retrieves the NE software version.
Usage Note
This command is used only for the EMS.
Category
System
Security
Retrieve
Command Syntax
RTRV-NESOFT-VER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SoftName=<SoftName>,SoftVer=<SoftVer>,SoftVerDate=<SoftVerDate>,SoftSta
tus=<SoftStatus>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-NESOFT-VER:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"SOFTNAME=NSF1,SOFTVER=5.51.05.23,SOFTVERDATE=20091024,SOFTSTATUS=active"
"SOFTNAME=NSF2,SOFTVER=NULL,SOFTVERDATE=NULL,SOFTSTATUS=inactive"
"SOFTNAME=BIOS,SOFTVER=8.20.62,SOFTVERDATE=20090827,SOFTSTATUS=inactive"
"SOFTNAME=ExtBIOS,SOFTVER=9.20.62,SOFTVERDATE=20090918,SOFTSTATUS=active"
"SOFTNAME=Pcb,SOFTVER=TN51SCC VER.A,SOFTVERDATE=,SOFTSTATUS="
"SOFTNAME=Logic,SOFTVER=(U18)120,SOFTVERDATE=,SOFTSTATUS="
"SOFTNAME=LogicE01,SOFTVER=(U10)100,SOFTVERDATE=,SOFTSTATUS="
"SOFTNAME=LogicE02,SOFTVER=(U33)130,SOFTVERDATE=,SOFTSTATUS="
;
Related Commands
None
D.33.63 RTRV-SWDL-FAILEDBDLIST
Retrieves the information about the board that fails to load the software package.
Function
This command retrieves the information about the board that fails to load the software
package, including slot ID, board status, and cause of the failure.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-FAILEDBDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"AID=<SWDL_BID>,STATE=<RECOVER_STATE>,REASON=<EXCLUDE_REASON>,RESULT=<SW
DL_RECOVERRESULT>,
RESULT_CODE=<SWDL_RESULT_CODE>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-FAILEDBDLIST:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"AID=SLOT-1-
1,STATE=ACTIVE,REASON=\"Board_process_timeout\",RECOVERSTATE=ACTIVE_START,R
ESULT=UNRECOVERED,RESULT_CODE=0XA02B"
;
Related Commands
None
D.33.64 RTRV-SWDL-MODE
Queries the loading mode.
Function
This command queries the loading mode (SWDL, PRESWDL).
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-SWDL-MODE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SWDLMODE=<SWDLMODE>"<cr><lf> ;
Response Parameters
Parameter Description
<SWDLMODE> Indicates the loading mode. The valid values are SWDL,
PRESWDL.
Example
Command
RTRV-SWDL-MODE:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"SWDLMODE =SWDL"
;
Related Commands
ED-SWDL-MODE
D.33.65 RTRV-SWDL-RESULT
Retrieves the package loading result.
Function
This command queries the package loading result.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-RESULT:[<TID>]::<CTAG>::<SWDL_BID>;
Command Parameters
<SWDL_BID> Indicates the ID of the slot for housing the board that you want to NA
add to the isolation list.
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"DATETIME=<SWDL_DATETIME>,STATE=<SWDL_STATE>,BID=<SWDL_BID>,RESULT_CODE=
<SWDL_RESULT_CODE>,INFO=<SWDL_RESULT_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-RESULT:::100::SLOT-0;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"SWDL_DATETIME=1990-01-03 22:19:20,SWDL_STATE=NORMAL,SWDL_BID=SLOT-
0,SWDL_RESULT_CODE=0x0000,SWDL_RESULT_INFO=\"Success\""
;
Related Commands
None
D.33.66 RTRV-SWDL-TOLERANCE
Queries the enable status of error tolerance in the package loading process.
Function
This command queries the enable status (ENABLE or DISABLE) of error tolerance in the
package loading process.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-SWDL-TOLERANCE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"TOLERANCE =<status>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-TOLERANCE:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"TOLERANCE=ENABLE"
Related Commands
ED-SWDL-TOLERANCE
D.33.67 RTRV-EXTVER
Querying the extra version information.
Function
This command queries the extra version information .
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
RTRV-EXTVER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"NE_EXTVER=< NE_VRCB >"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-EXTVER:::100;
Response Message
NE118 2000-01-01 08:47:59
M 100 COMPLD
"NE_EXTVER=EXTV100R011C00B012"
Related Commands
None
D.33.68 ENT-SWDU-DUMODE
Sets the mode in which an NE is involved in package diffusion.
Function
This command sets the mode in which an NE is involved in package diffusion. An NE
involved in package diffusion can load the software package or transmit the software package
to a downstream NE.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
ENT-SWDU-DUMODE:[<TID>]::<CTAG>::<DuMode>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ENT-SWDU-DUMODE:::100::DIFFUSE;
Response Message
NE 2006-11-10 15:57:06
M 100 COMPLD
;
Related Commands
None
D.33.69 REPT^DNLDEXCLUDEBD^END
Reports the event that MEM-CPY excludebd ends.
Function
Reports the event that MEM-CPY excludebd ends.
Usage Note
None
Category
System
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^DNLDEXCLUDEBD^END<cr><lf>
^^^"RSLT=<SWDL_RSLT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
None
Response Message
OSP-TESTNE1 2013-06-24 21:59:44
"RSLT=SUCCESS"
Related Commands
None
D.33.70 ED-MANUFACTURE
set software downloading mode.
Function
set software downloading mode to be manufacture mode.
Usage Note
the command takes no parameter. Please use it under the guidance of Huawei engineers
Category
SWDL
Security
Debug
Command Syntax
ED-MANUFACTURE:[<TID>]::<CTAG>
Command Parameters
None
Response Syntax
M 100 COMPLD
Response Parameters
None
Example
Command
ED-MANUFACTURE:::100
Response Message
NE21 1990-01-03 19:02:31
M 100 COMPLD;
Related Commands
NONE
D.34 SWDL Management
This section lists commands which used to configurate the SWDL. This group of commands
are provided to DC tool.
D.34.1 ADD-SWDL-EXBD
Adds a card to the isolation list.
Function
This command adds a card to the isolation list.
Usage Note
You can run the command only when the SCC card is in stable state (NORMAL-NORMAL,
SWDL_CPY_FILE_END-NORMAL, SWDL_CPY_MEM_END-NORMAL, or
SWDL_ACTIVE- PEND).
Category
SWDL
Security
Maintenance
Command Syntax
ADD-SWDL-EXBD:
[<TID>]::<CTAG>::<SWDL_BID>,<DEFAULT1>,<DEFAULT2>,<DEFAULT3>;
Command Parameters
<SWDL_BID> Indicates the ID of the slot for housing the card that you want to add NA
to the isolation list.
Response Syntax
<cr><lf><lf>
^^^<sid><yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ADD-SWDL-EXBD:::100::SLOT-1-1,0,0,0;
Response Message
NE 2009-12-18 01:28:53
M 100 COMPLD
;
Related Commands
D.34.4 RTRV-SWDL-EXBD
D.34.3 DLT-SWDL-EXBD
D.34.2 ACT-SWDL-EXBD
D.34.5 DNLD-SWDL-EXBD
D.34.2 ACT-SWDL-EXBD
Activates an isolated card that is specified.
Function
This command activates an isolated card that is specified.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
ACT-SWDL-EXBD:[<TID>]::<CTAG>::<SWDL_BID>;
Command Parameters
Parameter Description Default Value
<SWDL_BID> Indicates the ID of the slot for housing the isolated card NA
that you want to activate.
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME>^<cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ACT-SWDL-EXBD:::100::SLOT-1-9&SLOT-1-8&SLOT-1-3;
Response Message
NE 2009-12-18 02:47:20
M 100 COMPLD
;
Related Commands
D.34.1 ADD-SWDL-EXBD
D.34.3 DLT-SWDL-EXBD
D.34.4 RTRV-SWDL-EXBD
D.34.5 DNLD-SWDL-EXBD
D.34.3 DLT-SWDL-EXBD
Deletes an isolated card.
Function
This command deletes a card that is isolated in the package loading process.
Usage Note
You can run this command only when the SCC card is in NORMAL state.
Category
SWDL
Security
Maintenance
Command Syntax
DLT-SWDL-EXBD:
[<TID>]::<CTAG>::<SWDL_BID>,<DEFAULT1>,<DEFAULT2>,<DEFAULT3>;
Command Parameters
to 0 or greater than 0.
Response Syntax
<cr><lf><lf>
^^^<SID>^<DATE>^<TIME><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-SWDL-EXBD:::100::SLOT-1-1,0,0,0;
Response Message
NE 2009-12-18 01:28:53
M 100 COMPLD
;
Related Commands
D.34.1 ADD-SWDL-EXBD
D.34.4 RTRV-SWDL-EXBD
D.34.2 ACT-SWDL-EXBD
D.34.5 DNLD-SWDL-EXBD
D.34.4 RTRV-SWDL-EXBD
Queries the information about an isolated card.
Function
This command queries the information about an isolated card, including the slot number, card
type, PCB, isolation mode (manual or automatic), card status, processing flag of the isolated
card, and failure reason.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-EXBD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"AID=<SWDL_BID>,BdType=<SWDL_NBDTYPE>,PCB=<PCB>,GROUP_ACTMODE=<GROUP_ACT
MODE>,STATE=<RECOVER_STATE>,FLAG=<EXCLUDE_FLAG>,REASON=<EXCLUDE_REASON>,RES
ULT=<SWDL_RECOVERRESULT>,EXCLUDED_BY=<SWDL_EXCLUDEDBYBD>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-EXBD:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"AID=SLOT-
10,BDTYPE=6,PCB=77,GROUP_ACTMODE=AUTO,STATE=FAIL,FLAG=FALSE,REASON=\"Board_
process_timeout\",RESULT=UNRECOVERED,EXCLUDED_BY=NULL"
Related Commands
D.34.1 ADD-SWDL-EXBD
D.34.3 DLT-SWDL-EXBD
D.34.2 ACT-SWDL-EXBD
D.34.5 DNLD-SWDL-EXBD
D.34.5 DNLD-SWDL-EXBD
Allocates software to specified cards.
Function
This command is used to allocate the software in the newpkg or oldpkg area on the SCC card
to specified cards.
Usage Note
You can run the command only when the SCC card is in stable state
(SWDL_CPY_FILE_END, SWDL_CPY_MEM_END, SWDL_ACTIVE-PEND, or
SWDL_ACTIVATED).
Category
SWDL
Security
Maintenance
Command Syntax
DNLD-SWDL-EXBD:[<TID>]::<CTAG>::<SWPKGAREA>,<SWDL_BID>;
Command Parameters
<SWPKGAREA> Indicates the area where the allocated software is located. The valid NA
values are newpkg and oldpkg.
Response Syntax
<cr><lf><lf>
^^^<sid><yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DNLD-SWDL-EXBD:::100::newpkg, SLOT-1-9&SLOT-1-8&SLOT-1-3;
Response Message
NE 2009-12-24 15:23:20
M 100 COMPLD
;
Related Commands
D.34.1 ADD-SWDL-EXBD
D.34.4 RTRV-SWDL-EXBD
D.34.2 ACT-SWDL-EXBD
D.34.3 DLT-SWDL-EXBD
D.34.6 ED-SWDL-UPDATEWEAKBD
Sets the weak board updating flag.
Function
This command sets the weak board updating flag (ENABLE or DISABLE) of whether to
update software in the [FPGA Compatibility B] zone.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
ED-SWDL-UPDATEWEAKBD:[<TID>]:<CTAG>::<STATUS>;
Command Parameters
Parameter Description Default
Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-SWDL-UPDATEWEAKBD:::100::enable;
Response Message
NE 2009-12-24 15:23:20
M 100 COMPLD
;
Related Commands
D.33.66 RTRV-SWDL-TOLERANCE
D.34.7 RTRV-SWDL-UPDATEWEAKBD
Queries the enable status of whether to update the software in [FPGA Compatibility B] zone.
Function
This command queries the enable status of whether to update the software in [FPGA
Compatibility B] zone.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
RTRV-SWDL-UPDATEWEAKBD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"UPDATEFLAG =<status>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-UPDATEWEAKBD:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"UPDATEFLAG=ENABLE"
Related Commands
ED-SWDL-TOLERANCE
D.34.8 RTRV-SWDL-WEAKBDLIST
Retrieves the information about the board that weak matches the software package.
Function
This command retrieves the information about the board that weak matches the software
package, including slot ID, board type, PCB type,board class,flash numbers,update flag and
fpga version.
Usage Note
None
Category
System
Security
Maintenance
Command Syntax
RTRV-SWDL-WEAKBDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"BID=<SWDL_BID>,BdType=<SWDL_NBDTYPE>,PCB=<PCB>,BdClass=<SWDL_BDCLASS>,O
fsNum=<SWDL_OFSNUM>,
UPDATEFLAG=<STATUS>,FPGAVER=<FPGA_VER>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-SWDL-WEAKBDLIST:::100;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"BID=SLOT-1-
1,BdType=1399,PCB=0,BdClass=0,OfsNum=2,UpdateFlag=ENABLE,FPGAVER=V100T06,1.
11T02,V100T05"
;
Related Commands
None
D.34.9 UPDATE-SWDL-WEAKBD
Update the weak board software.
Function
This command update the weak board software.
Usage Note
None
Category
SWDL
Security
Maintenance
Command Syntax
UPDATE-SWDL-EWEAKBD:[<TID>]:<CTAG>::<SWDL_BID>;
Command Parameters
<SWDL_BID> Indicates the weak board list that wants to update.SLOT-ALL means NA
all the weak matched boards.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
UPDATE-SWDL-WEAKBD:::100::SLOT-1-9
Response Message
NE 2009-12-24 15:23:20
M 100 COMPLD
;
Related Commands
D.33.66 RTRV-SWDL-TOLERANCE
D.35 Patch Management
This section lists commands which used to manage the patch running on the system.
D.35.1 RTRV-PATCH
Queries the information about the patch.
Function
This command queries the information about the patch, including the patch version, number
and the state.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCH:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"PROGVER=<PROGVER>,PATCHVER=<PATCHVER>,PATCHNUM=<PATCHNUM>,RUNNUM=<RUNNU
M>,ACTIVENUM=<ACTIVENUM>,DEACTIVENUM=<DEACTIVENUM>,COMNNUM=<COMNNUM>,TEMPNU
M=<TEMPNUM>""<cr><lf>
;
Response Parameters
Parameter Description
<COMNNUM> NA
<TEMPNUM> NA
Example
Command
RTRV-PATCH::SLOT-3:100;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"PROGVER=5.21.13.40, ATCHVER=5.21.13.40P001,PATCHNUM=2,RUNNUM=0,
ACTIVENUM=0, DEACTIVENUM=2, COMNNUM=2, TEMPNUM=0"
;
Related Commands
None
D.35.2 DLT-PATCHPKG
Deletes the patch package.
Function
This command changes the states of the units loaded with patch files from activated,
deactivated, and running into idle.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
DLT-PATCHPKG:[<TID>]::<CTAG>::<PATCHPKGVER>,[<DELOPTION>];
Command Parameters
<DELOPTION> Indicates the type of the deleted patch package file. The NA
valid values are MEM, FILE, and PKG.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
DLT-PATCHPKG:::100::"SPH001",PKG;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.35.3 INST-PATCHPKG
D.35.4 ROLLBACK-PATCHPKG
D.35.5 RTRV-PATCHPKG-INFO
D.35.6 RTRV-PATCHPKG-STATE
D.35.3 INST-PATCHPKG
Installs the patch package.
Function
This command performs a series of operations on the patch package, including distributing,
loading, activating and committing.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
INST-PATCHPKG:[<TID>]::<CTAG>::<PATCHPKGVER>,[<RUNOPTION>];
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf> ^^^""<cr><lf>
;
Response Parameters
None
Example
Command
INST-PATCHPKG:::100::"SPH001",KEEPBACKPKG;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.35.2 DLT-PATCHPKG
D.35.4 ROLLBACK-PATCHPKG
D.35.5 RTRV-PATCHPKG-INFO
D.35.6 RTRV-PATCHPKG-STATE
D.35.4 ROLLBACK-PATCHPKG
Rolls back the patch package.
Function
This command is issued to roll back the patch package.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
ROLLBACK-PATCHPKG:
[<TID>]::<CTAG>::<PATCHPKGVER>,<ROLLBACKOPTION>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^""<cr><lf>
;
Response Parameters
None
Example
Command
ROLLBACK-PATCHPKG::100::"SPH001",IDLE;
Response Message
NE 2008-03-21 09:33:54
M 100 COMPLD
;
Related Commands
D.35.2 DLT-PATCHPKG
D.35.3 INST-PATCHPKG
D.35.5 RTRV-PATCHPKG-INFO
D.35.6 RTRV-PATCHPKG-STATE
D.35.5 RTRV-PATCHPKG-INFO
Retrieves the information about all patch packages.
Function
This command retrieves the information about all patch packages.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCHPKG-INFO:[<TID>]::<CTAG>::<PKGINFOTYPE>;
Command Parameters
NA
<PKGINFOTYPE> Indicates the type of the patch package. Valid value are as
follows:
IDLE
CURRENT
RUN
BACK
ALL
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"TYPE=<PKGINFOTYPE>,ERRINFO=<PKGERROR>,VER=<PATCHPKGVER>,PATH=<PKGPATH>"
<cr><lf>
;
Response Parameters
Parameter Description
<PKGERROR> Indicates the error codes. The valid values are as follows:
OK
ERROR
UNITLOST_ERROR
BDFILE_ERROR
BDUNIT_ERROR
<PATCHPKGVER> Indicates the version of the patch package.
Parameter Description
Example
Command
RTRV-PATCHPKG-INFO:::123::CURRENT;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"TYPE=CURRENT,ERRINFO=OK,VER=1.0,PATH="ofs1/patch"
;
Related Commands
D.35.2 DLT-PATCHPKG
D.35.3 INST-PATCHPKG
D.35.4 ROLLBACK-PATCHPKG
D.35.6 RTRV-PATCHPKG-STATE
D.35.6 RTRV-PATCHPKG-STATE
Retrieves the current state of the patch package.
Function
This command retrieves the current state of the patch package.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCHPKG-STATE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"PATCHSTATE=<PATCHSTATE>,PKGACTION=<PKGACTION>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PATCHPKG-STATE:::100;
Response Message
NE 2008-03-21 09:33:54
M 100 COMPLD
"PATCHSTATE=IDLE,PKGACTION=NULL"
Related Commands
D.35.2 DLT-PATCHPKG
D.35.3 INST-PATCHPKG
D.35.4 ROLLBACK-PATCHPKG
D.35.5 RTRV-PATCHPKG-INFO
D.35.7 REPT^PATCHPKG
Reports the progress of patch package loading.
Function
this event report the progress and result of patch package loading.
Usage Note
None
Category
Patch
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr><lf>
A^^^<ATAG>^REPT^PATCHPKG<cr><lf>
^^^"EVTTYPE=<PKGEVTTYPE>,ACTION=<PKGACTION>,CMD=<PKGINNERCMD>,BID=<SLOTID>,
MSG=<PKGMSG>"<cr><lf>
;
Response Parameters
Parameter Description
Command
None
Response Message
NE 2011-10-16 00:15:32
A 4369 REPT PATCHPKG
"EVTTYPE=ACTSTART,ACTION=LOADMEM,CMD=NULL,BID=SLOT-1-29,MSG="
;
Related Commands
None
D.35.8 RTRV-PATCH-RESULT
The RTRV-PATCH-RESULT command queries the patch package state and result of patch
package loading.
Function
The RTRV-PATCH-RESULT command queries the patch package state and result of patch
package loading.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCH-RESULT:[<TID>]::<CTAG>::<SLOTID>;
Command Parameters
<SLOTID> Indicates the slot that the destination 0 means query all results
card locate. Only 0 is valid currently.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"DATETIME=<DATETIME>,STATE=<PKGSTATE>,BID=<BID>,RESULT_CODE=<RESULTCODE>
,INFO=<INFO>"<cr><lf>
;
Response Parameters
Parameter Description
<DATETIME> Indicates date and time when an error occurs during patch package loading.
<BID> Indicates the ID of the board where an error occurs. If no error occurs, it is
displayed as 0.
<RESULT_CODE> Indicates the error code. If no error occurs during patch package loading, it is
displayed as success.
Example
Command
RTRV-PATCH-RESULT:::100::SLOT-0;
Response Message
NE 2010-12-08 13:37:07
M 100 COMPLD
"DATETIME=2010-12-07 22-04-35,STATE=IDLE,BID=SLOT-
17,RESULT_CODE=0X9DB0,INFO=\"patch_has_been_removed\""
;
Related Commands
None
D.35.9 DLT-PATCHPKG-BDPKG
Deletes the patch package on a specific board.
Function
This command deletes the patch package on a specific board.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
DLT-PATCHPKG-BDPKG:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
DLT-PATCHPKG-BDPKG::SLOT-1-17:123;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
Related Commands
None
D.35.10 PATCHPKG-ADD-EXCLUDEBD
Adds a card to the isolation board list of patch.
Function
This command adds a card to the isolation board list of patch.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
PATCHPKG-ADD-EXCLUDEBD:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
<SLOTID> Indicates the ID of the slot for housing the card that you want to add NA
to the isolation list.
Response Syntax
<cr><lf><lf>
^^^<sid><yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
PATCHPKG-ADD-EXCLUDEBD::SLOT-1-10:123;
Response Message
NE 2009-12-18 01:28:53
M 100 COMPLD
;
Related Commands
None
D.35.11 PATCHPKG-DEL-EXCLUDEBD
To delete a board from the isolated board list of patch.
Function
This command delete a board from the isolated board list of patch.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
PATCHPKG-DEL-EXCLUDEBD:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid><yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
PATCHPKG-DEL-EXCLUDEBD::SLOT-1-10:123;
Response Message
NE 2009-12-18 01:28:53
M 100 COMPLD
;
Related Commands
None
D.35.12 PATCHPKG-GET-EXCLUDEBD
To query the isolated board list of patch
Function
This command queries the isolated board list of patch
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
PATCHPKG-GET-EXCLUDEBD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SLOTID=<SLOTID>,LASTACTION=<PKGACTION>,ERRORCODE=<PATCH_RESULT_CODE>,ER
RINFO=<PATCH_RESULT_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
PATCHPKG-GET-EXCLUDEBD:::123;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"AID=SLOT-1-
10,LASTACTION=NULL,ERRORCODE=0x9dda,ERRINFO=NSERR_PATCH_CMDFAILED"
Related Commands
None
D.35.13 REFRESH-PATCHPKG-BD
To trigger a board to go online
Function
This command triggers a board to go online.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
REFRESH-PATCHPKG-BD:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid><yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
REFRESH-PATCHPKG-BD::SLOT-1-3:123;
Response Message
NE 2009-12-18 01:28:53
M 100 COMPLD
;
Related Commands
None
D.35.14 REFRESH-PATCHPKG-BDLIST
To update information about boards included in the patch
Function
This command queries the information about all the boards included in the patch, including
control boards based on the DMM physical board list.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
REFRESH-PATCHPKG-BDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid><yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
REFRESH-PATCHPKG-BDLIST:::123;
Response Message
NE 2009-12-18 01:28:53
M 100 COMPLD
;
Related Commands
None
D.35.15 RTRV-PATCHPKG-BDLIST
To query the information about online boards included in the patch.
Function
This command queries the information about online boards included in the patch.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCHPKG-BDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SLOTID=<SLOTID>,SUPPORTPATCH=<SUPPORTPATCH>,ISSCC=<ISSCC>,CMDVER=<CMDVE
R>,BDTYPE=<BDTYPE>,PCBVER=<PATCHNE_PCBVER>,PROGVER=<PROGVER>,PATCHRESULT=<P
ATCH_RESULT_CODE>,ERRINFO=<PATCH_RESULT_INFO>,SWDLPATCHVER=<SWDLPATCHVER>"<
cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PATCHPKG-BDLIST:::123;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"SLOTID=SLOT-1-
17,SUPPORTPATCH=1,ISSCC=1,CMDVER=512,BDTYPE=1564,PCBVER=0,PROGVER=5.51.09.1
0T06,PATCHRESULT=0,ERRINFO=NSERR_PATCH_SUCCESS,SWDLPATCHVER="
Related Commands
None
D.35.16 RTRV-PATCHPKG-DNLDBDLIST
To query the information about boards to which patches are loaded.
Function
This command queries the information about boards to which patches are loaded.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCHPKG-DNLDBDLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"SLOTID=<SLOTID>,CMDVER=<CMDVER>,BDTYPE=<BDTYPE>,PCBVER=<PATCHNE_PCBVER>
,PATCHFILES=<PATCHFILES>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PATCHPKG-DNLDBDLIST:::123;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"SLOTID=SLOT-1-
17,CMDVER=0x0200,BDTYPE=1564,PCBVER=0,PROGVER=5.51.09.10T06,PATCHFILES=2"
Related Commands
None
D.35.17 RTRV-PATCHPKG-WORKSTATE
To query the working status of a patch.
Function
This command queries the working status of a patch.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCHPKG-WORKSTATE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"STATE=<PKGWORKSTATE>,ACTION=<PKGACTION>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PATCHPKG-WORKSTATE:::123;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
"STATE=IDLE,ACTION=NULL"
Related Commands
None
D.35.18 RTRV-PATCH-AREA
Retrieves the sys para information for patches.
Function
Retrieves sys para information for patches.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCH-AREA:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
"PATCHAREAADDR=<PATCHAREAADDR>,PATCHAREALEN=<PATCHAREALEN>,CODEADDR=<CODEAD
DR>,CODELEN=<CODELEN>,
CODEFREELEN=<CODEFREELEN>,DATAADDR=<DATAADDR>,DATALEN=<DATALEN>,DATAFREELEN
=<DATAFREELEN>",
;
Response Parameters
Parameter Description
<CODEADDR> Indicates the start address of memory for patch's code segment.
Parameter Description
<DATAADDR> Indicates the start address of memory for patch's data segment.
Example
Command
RTRV-PATCH-AREA::SLOT-1-9:123;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"PATCHAREAADDR=0x00010000,ATCHAREALEN=0x000f0000,CODEADDR=0x00010000,
CODELEN=0x00080000, CODEFREELEN=0x00080000, DATAADDR=0x00090000,
DATALEN=0x00070000, DATAFREELEN=0x00070000",
;
Related Commands
D.35.19 RTRV-PATCH-INFO
D.35.1 RTRV-PATCH
D.35.19 RTRV-PATCH-INFO
Queries the related information list of the patch.
Function
This command queries the information about the patch, including patch number, start
address, and length.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCH-INFO:[<TID>]:<SLOTID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"PATCHNO=<PATCHNO>,PATCHSTATE=<PATCHSTATE>,CODEADDR=<CODEADDR>,CODELEN=<
CODELEN>,DATAADDR=<DATAADDR>,DATALEN=<DATALEN>,FUNCNUM=<FUNCNUM>""<cr><lf>
;
Response Parameters
Parameter Description
<CODEADDR> Start address of the code segment after the patch is loaded to
memory
<DATAADDR> Start address of the data segment after the patch is loaded to
memory
Command
RTRV-PATCH-INFO::SLOT-1-9:123;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
"PATCHNO=1, PATCHSTATE=running,CODEADDR=0x00010000, CODELEN=
0x0000084c, DATAADDR=0x00090000, DATALEN=0x000005b8, FUNCNUM=3"
;
Related Commands
None
D.35.20 RTRV-PATCH-LIST
The RTRV-PATCH-LIST command queries the patch package version
Function
The RTRV-PATCH-LIST command queries the patch package version.
Usage Note
None
Category
Patch
Security
Retrieve
Command Syntax
RTRV-PATCH-LIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"DLENGTH=<PatchlistLen>,PATCH_LIST=<Patchlist>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PATCH-LIST:::100;
Response Message
NE 2011-08-31 03:45:56
M 100 COMPLD
"LENGTH=6,PATCH_LIST=SPH003"
;
Related Commands
None
D.35.21 RTRV-PATCHPKG-PKGLIST
To query the patchpkg list which are installed.
Function
This command queries the information about the patchpkg list which are installed.
Usage Note
None
Category
Patch
Security
Maintenance
Command Syntax
RTRV-PATCHPKG-PKGLIST:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"INDEX=<INDEX>,SWDLPATCHVER=<SWDLPATCHVER>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-PATCHPKG-PKGLIST:::123;
Response Message
NE 2009-11-02 11:27:06
M 100 COMPLD
""
Related Commands
None
D.36 Database Management
This section lists commands which used to manage the databases of the system.
D.36.1 CHECK-DBMS-CFDB
Check the status of DB in the CF Card.
Function
This command checks the status of DB in the CF Card.
Usage Note
None
Category
DBMS
Security
Maintenance
Command Syntax
CHECK-DBMS-CFDB:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
CHECK-DBMS-CFDB:::100;
Response Message
NE 2005-08-02 17:52:45
M 100 COMPLD
;
Related Commands
D.36.3 RTRV-DBMS-AUTOBACKUP
D.36.2 COPY-DBMS-ALL
Copies all the databases from one storage area to another storage area.
Function
This command instructs an NE to copy all the databases in the source storage area to the
destination storage area. The database in the destination area will be overwritten if it shares
the same name as a database in the source storage area. After the command is issued, the NE
first compares the databases in the two storage areas. If the databases in the source storage
area are the same as those in the destination storage area, they are not copied. When copying
databases from one area to another area, the databases that are identified as "non-backup" are
not copied. In addition, this command does not support copying databases to the MDB.
Usage Note
None
Category
DBMS
Security
Provisioning
Command Syntax
COPY-DBMS-ALL:[<TID>]::<CTAG>::<DB_SRC_AREA>,<DB_DST_AREA>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
COPY-DBMS-ALL:::100::drdb,fdb;
Response Message
NE 2005-08-02 17:22:15
M 100 COMPLD
;
Related Commands
None
D.36.3 RTRV-DBMS-AUTOBACKUP
Retrieves the automatic backup status.
Function
This command retrieves the automatic backup status.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
RTRV-DBMS-AUTOBACKUP:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<DB_AUTO_BACK>"<cr><lf>
;
Response Parameters
Parameter Description
<DB_AUTO_BACK> Indicates the automatic backup status. The valid values are
ENABLE and DISABLE.
Example
Command
RTRV-DBMS-AUTOBACKUP:::100;
Response Message
NE 2005-08-02 18:25:07
M 100 COMPLD
"ENABLE"
;
Related Commands
D.36.4 SET-DBMS-AUTOBACKUP
D.36.4 SET-DBMS-AUTOBACKUP
Sets the automatic backup status switch flag to copy the databases from the MDB to the flash
once a day.
Function
This command sets the automatic backup status switch flag to copy the databases from the
MDB to the Flash once a day.
Usage Note
None
Category
DBMS
Security
Maintenance
Command Syntax
SET-DBMS-AUTOBACKUP:[<TID>]::<CTAG>::<DB_AUTO_BACK>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
SET-DBMS-AUTOBACKUP:::100::ENABLE;
Response Message
NE 2005-08-02 17:52:45
M 100 COMPLD
;
Related Commands
D.36.3 RTRV-DBMS-AUTOBACKUP
D.36.5 RTRV-DBMS-BACKUPTIME
Retrieves the preset automatic backup time of a database.
Function
This command retrieves the preset automatic backup time of a database.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
RTRV-DBMS-BACKUPTIME:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<TIME>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DBMS-BACKUPTIME:::100;
Response Message
NE 2005-08-02 19:55:48
M 100 COMPLD
"13-04-56"
Related Commands
None.
D.36.6 ED-DBMS-CYCLEBACKUP
Edit the attribute for dbms cyclebackup.
Function
The command edit the attribute for dbms cyclebackup.
Usage Note
None
Category
DBMS
Security
Maintenance
Command Syntax
ED-DBMS-CYCLEBACKUP:[<TID>]::<CTAG>::<FLAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<SID>^<YYYY-MM-DD>^<HH:MM:SS> <cr><lf>
M^^<CTAG>^COMPLD <cr><lf>
<cr><lf>
Response Parameters
None
Example
Command
ED-DBMS-CYCLEBACKUP:::100::ENABLE;
Response Message
M1050 2003-02-28 12:23:20
M 100 COMPLD
;
Related Commands
None
D.36.7 RTRV-DBMS-DBF
Retrieves all record information about a database file
Function
This command retrieves all record infomation of a database file.
Usage Note
None
Category
DBMS
Security
Super
Command Syntax
RTRV-DBMS-DBF:[<TID>]:<DB_NAME>:<CTAG>::<DB_SRC_AREA>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<DB_QUERY_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DBMS-DBF::alm_user.dbf:100::mdb;
Response Message
NE 2006-05-19 10:38:43
M 100 COMPLD
"Order=1,UID=00000000,UIDPOS=00,UIDFLAG=00"
"Order=2,UID=00000000,UIDPOS=00,UIDFLAG=00"
Related Commands
None
D.36.8 RTRV-DBMS-LIST
Retrieves all list file information about a region.
Function
This command instructs NE to retrieve all list file information about a region.
Usage Note
None
Category
DBMS
Security
Super
Command Syntax
RTRV-DBMS-LIST:[<TID>]::<CTAG>::<DB_STORE_AREA>
Command Parameters
Parameter Description Default Value
Response Parameters
Parameter Description
<DB_ADDR_STA> Indicates the handle of the database. It is valid for MDB region.
Example
Command
RTRV-DBMS-LIST:::100::FDB0;
Response Message
NE 2005-03-21 09:33:54
NEW-NE 2006-04-05 14:43:35
M 100 RTRV
"ORDER=1:VER=1:NAME=BdInst.dbf:SUM=48:SIZE=290:ADDRSTA=0:UPDTIME=2006-
04-05 13-38-37"
"ORDER=2:VER=3:NAME=CNeInfo.dbf:SUM=1:SIZE=626:ADDRSTA=0:UPDTIME=2006-04-
05 13-38-37"
………………………………….
NEW-NE 2006-04-05 14:43:35
M 100 COMPLD
"ORDER=235:VER=1:NAME=bdatt47.dbf:SUM=0:SIZE=98:ADDRSTA=0:UPDTIME=2006-04-
05 13-38-39"
"ORDER=236:VER=1:NAME=bdatt48.dbf:SUM=0:SIZE=98:ADDRSTA=0:UPDTIME=2006-04-
05 13-38-39"
;
Related Commands
None
D.36.9 RTRV-DBMS-MODE
Retrieves the current working mode of the database.
Function
This command retrieves the current working mode of the database.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
RTRV-DBMS-MODE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<DB_MODE>,<DB_PM_COUNT>"<cr><lf>
;
Response Parameters
Parameter Description
<DB_MODE> Indicates the current working mode. The valid values are Normal
and Protect.
<DB_PM_COUNT> Indicates the current abnormal reset times (cleared after normal
operation for five minutes upon system start).
Example
Command
RTRV-DBMS-MODE:::100;
Response Message
NE 2005-08-02 19:40:39
M 100 COMPLD
"NORMAL,0"
;
Related Commands
None
D.36.10 RTRV-DBMS-NDBF
Retrieves n items record information about a database file.
Function
This command instructs NE to retrieve n items record infomation of a database file.
Usage Note
None
Category
DBMS
Security
Super
Command Syntax
RTRV-DBMS-NDBF:
[<TID>]:<DB_NAME>:<CTAG>::<DB_RECNO>,<DB_REC_CNT>,<DB_SRC_AREA>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<DB_QUERY_INFO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DBMS-NDBF::alm_user.dbf:100::2,4,mdb;
Response Message
NE 2006-05-19 10:39:43
M 100 COMPLD
"Order=1,UID=00000000,UIDPOS=00,UIDFLAG=00"
"Order=2,UID=00000000,UIDPOS=00,UIDFLAG=00"
"Order=3,UID=00000000,UIDPOS=00,UIDFLAG=00"
"Order=4,UID=00000000,UIDPOS=00,UIDFLAG=00"
;
Related Commands
None
D.36.11 RTRV-DBMS-PMMODE
Retrieves the database protection mode.
Function
This command retrieves the database protection mode.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
RTRV-DBMS-PMMODE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^" <DB_PM_MODE>"<cr><lf>
;
Response Parameters
Parameter Description
<DB_PM_MODE> Indicates the database protection mode. The valid values are
ENABLE and DISABLE.
Example
Command
RTRV-DBMS-PMMODE:::100;
Response Message
NE 2005-08-02 19:37:10
M 100 COMPLD
"ENABLE"
Related Commands
None.
D.36.12 RTRV-DBMS-PERIOD
Retrieves the backup period of the database and system parameters.
Function
This command retrieves the backup period of the database and system parameters.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
RTRV-DBMS-PERIOD:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<DBMSPERIOD>,<SYSPERIOD>"<cr><lf>
;
Response Parameters
Parameter Description
<DBMSPERIOD> Indicates the time of the DBMS backup period. (in minutes)
<SYSPERIOD> Indicates the time of the system backup period. (in minutes)
Example
Command
RTRV-DBMS-PERIOD:::100;
Response Message
NE 2005-08-02 20:04:48
M 100 COMPLD
"50,0"
Related Commands
None.
D.36.13 RTRV-DBMS-RECNO
Retrieves the record number of a database file.
Function
This command retrieves the record number of a database file.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
RTRV-DBMS-RECNO:[<TID>]:<DB_NAME>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
^^^"<DB_RECNO>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DBMS-RECNO::user.dbf:100;
Response Message
NE 2005-08-02 16:26:23
M 100 COMPLD
"11"
;
Related Commands
None
D.36.14 RTRV-DBMS-STATEEXT
query the dbms-state of the board
Function
It can query the dbms-state of the board
Usage Note
None
Category
dbms
Security
Maintenance
Command Syntax
RTRV-DBMS-STATEEXT:[<TID>]::<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^<cr><lf>
;
Response Parameters
None
Example
Command
RTRV-DBMS-STATEEXT:::100::SLOT-1-17;
Response Message
NE 2005-03-21 09:33:54
M 100 COMPLD
;
D.36.15 STA-PREPARING-DBUPLOAD
Start preparing for dbupload
Function
This command is to Start preparing for dbupload
Usage Note
none
Category
dbms
Security
Maintenance
Command Syntax
STA-PREPARING-DBUPLOAD:[<TID>]:<CTAG>;
Command Parameters
None
Response Syntax
None
Response Parameters
None
Example
Command
STA-PREPARING-DBUPLOAD:::100;
Response Message
NE169-22 2012-06-04 19:05:58
M 100 COMPLD
Related Commands
None
D.36.16 REPT^DBMS^PROTECTED
Report the event when DBMS enters the protected mode.
Function
This event is reported to indicate that DBMS enters the protected mode
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
A^^<ctag>REPT DBMS PROTECTED<cr><lf>
;
Response Parameters
None
Example
Command
None
Response Message
NE 2004-06-17 18:03:52
A 41 REPT DBMS PROTECTED
;
Related Commands
None
D.36.17 REPT^DBMS^DLTED
Reports the DBMS deleted
Function
This event is reported to indicate that the database is deleted.
Usage Note
None
Category
DBMS
Security
Retrieve
Command Syntax
None
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
A^^<ctag>REPT^DBMS^DLTED<cr><lf>
;
Response Parameters
None
Example
Command
None
Response Message
NE 2004-06-17 18:03:52
A 41 REPT DBMS DLTED
;
Related Commands
None
D.37 Log Management
This section lists commands which used to manage the log.
D.37.1 INIT-LOG
Initializes logs.
Function
This command initializes a specific log of an NE.
Usage Note
Empties the log.
Category
LOG
Security
Debug
Command Syntax
INIT-LOG:[<TID>]:[<AID>]:<CTAG>::<LOGNAME>;
Command Parameters
Parameter Description Default Value
<aid> Indicates the card ID. The current active SCC card is the NA
ID if a value is not entered.
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
Response Parameters
None
Example
Command
INIT-LOG::SLOT-1-9:100::bb0.log;
Response Message
NE 2004-07-08 15:04:16
M 100 COMPLD ;
Related Commands
None
D.37.2 RTRV-LOG
Retrieves the log of an NE.
Function
This command retrieves the log of an NE.
Usage Note
None
Category
LOG
Security
Super
Command Syntax
RTRV-LOG:[<TID>]:<AID>:<CTAG>::<LOGNAME>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
^^^"<LOGNAME>" <cr> <lf>
(^^^/* <CONTENT> */ <cr><lf>)*
;
Response Parameters
Parameter Description
Example
Command
RTRV-LOG::SLOT-1-18:100::bb0.log;
Response Message
NE 2008-09-04 15:46:52
M 100 RTRV
"bb0.log"
/*2008-09-04:15-45-48:ErrCode:0x520602, Level:3, File:tl1_task.cpp,
Line:2442, Info:TransAutoMsg:0xffff*/
"bb0.log"
/*2008-09-04:15-45-48:ErrCode:0x520602, Level:3, File:tl1_task.cpp,
Line:2442, Info:TransAutoMsg:0xffff*/
"bb0.log"
/*2008-09-04:15-45-48:ErrCode:0x520602, Level:3, File:tl1_task.cpp,
Line:2442, Info:TransAutoMsg:0xffff*/
"bb0.log"
/*2008-09-04:15-45-48:ErrCode:0x520602, Level:3, File:tl1_task.cpp,
Line:2442, Info:TransAutoMsg:0xffff*/
"bb0.log"
/*2008-09-04:15-45-48:ErrCode:0x520602, Level:3, File:tl1_task.cpp,
Line:2442, Info:TransAutoMsg:0xffff*/
"bb0.log"
/*2008-09-04:15-45-48:ErrCode:0x520602, Level:3, File:tl1_task.cpp,
Line:2442, Info:TransAutoMsg:0xffff*/
"bb0.log"
Related Commands
D.37.5 RTRV-LOG-BYTIME
D.37.4 RTRV-LOG-BYLEVEL
D.37.3 RTRV-LOG-BYMOD
D.37.3 RTRV-LOG-BYMOD
Retrieves the log by module ID.
Function
This command retrieves the log information about an NE by module ID.
Usage Note
None
Category
LOG
Security
Super
Command Syntax
RTRV-LOG-BYMOD:
[<TID>]:<AID>:<CTAG>::<LOGNAME>,<MODID>,<STA_DATETIME>,<END_DATETIM
E>;
Command Parameters
Parameter Description Default
Value
MODID Indicates the module ID. The value "0" means all modules. NA
STA_DATETIME Indicates the start date and time of the log in a yyyy-mm-dd- NA
hh-mm-ss format.
END_DATETIME Indicates the end date and time of the log in a yyyy-mm-dd- NA
hh-mm-ss format.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<LOG_NAME>,<STA_DATE_TIME>,<MODID>,<LOGCONTENT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-LOG-BYMOD::SLOT-1-18:100::"bb0.log",0,2008-09-04-15-29-10,2008-09-04-
15-30-10;
Response Message
NE 2008-09-04 15:59:42
M 100 COMPLD
"bb0.log:2008-09-04 15-29-10:277:ErrCode:0x970e, Level:3,
File:cfg_init.cpp, Line:7348, Info:SCC Temp ERR!"
"bb0.log:2008-09-04 15-29-10:27:ErrCode:0xbebf417, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-14:27:ErrCode:0xbecf417, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-20:27:ErrCode:0xbeef412, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-24:27:ErrCode:0xbeff412, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-28:27:ErrCode:0xbf0f412, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-32:27:ErrCode:0xbf1f412, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
;
Related Commands
D.37.2 RTRV-LOG
D.37.5 RTRV-LOG-BYTIME
D.37.4 RTRV-LOG-BYLEVEL
D.37.4 RTRV-LOG-BYLEVEL
Retrieves the log by level.
Function
This command retrieves the log information about an NE by level.
Usage Note
None
Category
LOG
Security
Super
Command Syntax
RTRV-LOG-BYLEVEL:
[<TID>]:<AID>:<CTAG>::<LOGNAME>,<LEVEL>,<STA_DATETIME>,<END_DATETIM
E>;
Command Parameters
Parameter Description Default Value
LEVEL Indicates the level of the error. The valid value ranges NA
from 1 to 4. The value "0" means all levels.
STA_DATETIME Indicates the start date and time of the log in a yyyy- NA
mm-dd-hh-mm-ss format.
Parameter Description Default Value
END_DATETIME Indicates the end date and time of the log in a yyyy-mm- NA
dd-hh-mm-ss format.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<LOG_NAME>,<STA_DATE_TIME>,<MODID>,<LOG_CONTENT>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-LOG-BYLEVEL::SLOT-1-18:100::"bb0.log",0,2008-09-04-15-29-40,2008-09-
04-15-30-10;
Response Message
NE 2008-09-04 16:00:12
M 100 COMPLD
"bb0.log:2008-09-04 15-29-42:27:ErrCode:0xbf5f40b, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-43:35:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:35:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:35:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:35:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:35:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:35:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
;
Related Commands
D.37.2 RTRV-LOG
D.37.5 RTRV-LOG-BYTIME
D.37.3 RTRV-LOG-BYMOD
D.37.5 RTRV-LOG-BYTIME
Retrieves the log by time.
Function
This command retrieves the log information about an NE by time.
Usage Note
None
Category
LOG
Security
Super
Command Syntax
RTRV-LOG-BYTIME:
[<TID>]:<AID>:<CTAG>::<LOGNAME>,<STA_DATATIME>,<END_DATATIME>;
Command Parameters
Parameter Description Default Value
STA_DATATIME Indicates the start date and time of the log in a yyyy-mm- NA
dd-hh-mm-ss format.
END_DATATIME Indicates the end date and time of the log in a yyyy-mm- NA
dd-hh-mm-ss format.
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr><lf>
^^^"<LOG_NAME>,<STA_DATA_TIME>,<LOG_CONTENT>"<cr><lf>
;
Response Parameters
Parameter Description
Parameter Description
Example
Command
RTRV-log-bytime::SLOT-1-18:100::bb0.log,2008-09-04-15-29-40,2008-09-04-15-
30-10;
Response Message
NE 2008-09-04 16:00:15
M 100 COMPLD
"bb0.log:2008-09-04 15-29-42:ErrCode:0xbf5f40b, Level:3,
File:ecc_drvadapt.cp, Line:2407, Info:TestCrossChain Read"
"bb0.log:2008-09-04 15-29-43:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
"bb0.log:2008-09-04 15-29-43:ErrCode:0x520602, Level:3,
File:tl1_task.cpp, Line:2442, Info:TransAutoMsg:0xffff"
;
Related Commands
D.37.2 RTRV-LOG
D.37.4 RTRV-LOG-BYLEVEL
D.37.3 RTRV-LOG-BYMOD
D.37.6 INIT-AO
Initializes the automatic output buffer data.
Function
This command initializes a queued autonomous message or a missing autonomous message.
The message that can be cleared includes REPT DBCHG, REPT EVT, and REPT ALM.
Usage Note
None
Category
Security
Security
Debug
Command Syntax
INIT-AO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr> <lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
Response Parameters
None
Example
Command
INIT-AO:::100;
Response Message
NE 2007-06-06 13:27:07
M 100 COMPLD ;
Related Commands
None
D.37.7 RTRV-DOPRA
Retrieves the dopra log of an NE.
Function
This command retrieves the dopra log of an NE.
Usage Note
None
Category
LOG
Security
Super
Command Syntax
RTRV-DOPRA:[<TID>]:<AID>:<CTAG>;
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf> <lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss> <cr><lf>
M^^<ctag>^COMPLD <cr> <lf>
^^^"<CONTENT>" <cr> <lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-DOPRA::SLOT-1-18:100;
Response Message
2014-09-03 09:05:54
M 100 RTRV
"
No record found in the MemoryLeak region(Region id:13)."
"
No record found in the DeadLoop region(Region id:12)."
"
No record found in the MemoryLeakscan region(Region id:11)."
"
The self managed box region has no parse hook!"
"
No record found in the Exception region(Region id:9)."
"
No record found in the VOS_ASSERT region(Region id:8)."
"
No record found in the Reboot region(Region id:7)."
"
No record found in the MemoryDamage region(Region id:5)."
"
No record found in the Log_Except region(Region id:4)."
>
Related Commands
D.37.5 RTRV-LOG-BYTIME
D.37.4 RTRV-LOG-BYLEVEL
D.37.3 RTRV-LOG-BYMOD
D.38 DMM Management
D.39 License Management
This section lists commands which used to maintain the License.
D.39.1 RTRV-LCS-INFO
Retrieves license information.
Function
This command retrieves license information.
Usage Note
None
Category
License
Security
Maintenance
Command Syntax
RTRV-LCS-INFO:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"LSN=<LCS_LSN><cr><lf>^^^CREATOR=<LCS_CREATOR><cr><lf>^^^CREATEDTIME=<LC
S_CREATEDTIME><cr><lf>^^^COUNTRY=<LCS_COUNTRY><cr><lf>^^^CUSTOMER=<LCS_CUST
OMER><cr><lf>^^^OFFICE=<LCS_OFFICE><cr><lf>^^^PRODUCT=<LCS_PRODUCT><cr><lf>
^^^VERSION=<LCS_VERSION><cr><lf>^^^ESN=<LCS_ESN><cr><lf>^^^STATUS=<LCS_STAT
US><cr><lf>^^^REVOKETICKET=<LCS_REVOKETICKET>"<cr><lf>
;
Response Parameters
Parameter Description
<LCS_CREATEDTIME> Indicates the time that the license file was created. It is a string of no
more than 32 characters.
Example
Command
RTRV-LCS-INFO:::100;
Response Message
NE 2009-11-23 11:00:58
M 100 COMPLD
"LSN=LIC2009072401CC00,CREATOR=\"Huawei Technologies Co.,
Ltd.\",CREATEDTIME=\"2009-07-24
22:58:23\",COUNTRY=\"China\",CUSTOMER=\"VOXMobile
SA\",OFFICE=Unknown,PRODUCT=\"OptiX PTN
3900\",VERSION=V100R001,ESN=00:19:B9:1E:2C:0A,STATUS=NORMAL,REVOKETICKET=XX
XXX"
;
Related Commands
None
D.39.2 RTRV-LCS-ESN
Retrieves the ESN of an NE.
Function
This command retrieves the ESN of the NE.
Usage Note
None
Category
License
Security
Maintenance
Command Syntax
RTRV-LCS-ESN:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"DEVICE_ESN=<NE_ESN>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-LCS-ESN:::100;
Response Message
NE 2009-11-23 11:00:58
M 100 COMPLD
"DEVICE_ESN=\"030LNB109B000080,030LNB10AC001539\""
;
Related Commands
D.39.1 RTRV-LCS-INFO
D.39.3 RTRV-LCS-CTRLITEM
Retrieves license control items of an NE.
Function
This command retrieves the license control items of the NE.
Usage Note
None
Category
License
Security
Maintenance
Command Syntax
RTRV-LCS-CTRLITEM:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"ITEMID=<LCS_CTRLITEM_ITEMID>,NAME=<LCS_CTRLITEM_NAME>,TYPE=<LCS_CTRLITE
M_TYPE>,CTRLVAL=<LCS_CTRLITEM_CTRLVAL>,USEDVAL=<LCS_CTRLITEM_USEDVAL>,STATU
S=<LCS_CTRLITEM_STATUS>,DEADLINE=<LCS_CTRLITEM_DEADLINE>,DESCRIPTION=<LCS_C
TRLITEM_DESCRIPTION>"<cr><lf>
;
Response Parameters
Parameter Description
<LCS_CTRLITEM_ USEDVAL> Indicates the value of the license control item that is
currently used.
<LCS_CTRLITEM_STATUS> Indicates the status of the license control item. The valid
values are DEFAULT, TRIAL, NORMAL, and
EMERGENCY.
<LCS_CTRLITEM_DEADLINE> Indicates the deadline of the license control item. It is a
string of no more than 12 characters.
<LCS_CTRLITEM_DESCRIPTION> Indicates the description of the license control item. It is a
string of no more than 128 characters.
Example
Command
RTRV-LCS-CTRLITEM:::100;
Response Message
NE 2009-11-23 11:00:58
M 100 COMPLD
"ITEMID=1,NAME=\"PORT\",TYPE=FUNCTION,CTRLVAL=1,USEDVAL=0,STATUS=
NORMAL,DEADLINE=2010-10-01,DESCRIPTION=\"XXXXXXX\""
"ITEMID=2,NAME=\"PORT2\",TYPE=FUNCTION,CTRLVAL=1,USEDVAL=0,STATUS=
NORMAL,DEADLINE=2010-10-01,DESCRIPTION=\"XXXXXXX\""
;
Related Commands
None
D.39.4 VERIFY-LCSFILE
Verify the validity of license file.
Function
This command instructs NE to verify the validity of license file.
Usage Note
1. LCS_LKVFINFO, LCS_LSN, LCS_PRODUCT, LCS_VERSION and LCS_ESN
are File Verified Results; The others are Item Verified Results.
2. If the licence file verified results is ok, the file level verified results messages is 0.
3. If the licence item verified results is ok, the Item level verified results messages is
0.
4. If both the licence file level and item level verified results are ok, the output
message is 0.
Category
License
Security
Maintenance
Command Syntax
VERIFY-LCSFILE:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"LKVFINFO=<LCS_LKVFINFO>,LSN=<LCS_LSN>,PRODUCT=<LCS_PRODUCT>,VERSION=<LC
S_VERSION
>,ESN=<LCS_ESN>,NAME=<LCS_NAME>,ITEMID=<LCS_ITEMID>,TYPE=<LCS_TYPE>,LKVAL=<
LCS_LKVAL>,DEADLINE=<LCS_DEADLINE>,TRIALDAYS=<LCS_TRIALDAYS>,VERIFYRESULT=<
LCS_VERIFYRESULT>"<cr><lf>
;
Response Parameters
Parameter Description
<LCS_LKVFINFO> License File Verify Result. There is a "OR" relationship between the
valid values listed as below:
(1<<0): LK_ESN_MISMATCH_ESN
(1<<1): LK_VERSION_MISMATCH
<LCS_ESN> Equipment serial number. It is a string, and the max length is 128.
<LCS_NAME> License control item name. It is a string, and the max length is 64.
<LCS_VERIFYRESULT> Item Verify result. There is a "OR" relationship among valid values
listed as below:
(1<<2): ITEM_DEADLINE_OVER
(1<<3): ITEM_TRIAL_OVER
(1<<4): ITEM_DEADLINE_LESSER
(1<<5): ITEM_VALUE_LESSER
(1<<6): ITEM_NOT_PRESENT
(1<<7): ITEM_CONFIG_MORE
(1<<8): ITEM_USED_MORE
(1<<9): ITEM_FUNC_DFLT_VAL_ENABLED
(1<<10): ITEM_DUPLICATE
Example
Command
VERIFY-LCSFILE:::100;
Response Message
NE 2009-11-23 11:00:58
M 100 COMPLD
"LKVFINFO=
1,LSN=XXX,PRODUCT=\"XXXX\",VERSION=XXX,ESN=\"XXX\",NAME=\"LCX6UPDT01\",ITEM
ID=1,TYPE=FUNCTION,LKVAL=1,DEADLINE=2010-01-30,TRIALDAYS=60,VERIFYRESULT= 4
"
"LKVFINFO=
1,LSN=XXXX,PRODUCT=\"XXXX\",VERSION=XXXX,ESN=\"XXX\",NAME=\"LCX6IPV601\",IT
EMID=5,TYPE=FUNCTION,LKVAL=1,DEADLINE=2010-01-
30,TRIALDAYS=60,VERIFYRESULT=4 "
;
Related Commands
None
D.39.5 ACT-LCS
Activates a license file.
Function
This command instructs an NE to activate a license file.
Usage Note
None
Category
License
Security
Maintenance
Command Syntax
ACT-LCS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ACT-LCS:::100;
Response Message
NE 2009-11-23 11:00:58
M 100 COMPLD
;
Related Commands
D.39.6 CANC-LCS
D.39.7 ABT-LCS
D.39.6 CANC-LCS
Revoke license file.
Function
This command instructs NE to revoke license file.
Usage Note
None
Category
License
Security
Maintenance
Command Syntax
CANC-LCS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"REVOKETICKET=<LCS_REVOKETICKET>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
CANC-LCS:::100;
Response Message
HUAWEI-NE 2009-11-23 11:00:58
M 100 COMPLD
"REVOKETICKET=xxxxxxxxx"
;
Related Commands
D.39.7 ABT-LCS
D.39.5 ACT-LCS
D.39.7 ABT-LCS
Rolls back a license file.
Function
This command instructs an NE to rollback a license file.
Usage Note
None
Category
License
Security
Maintenance
Command Syntax
ABT-LCS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<sid>^<yyyy-mm-dd>^<hh:mm:ss><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ABT-LCS:::100;
Response Message
NE 2009-11-23 11:00:58
M 100 COMPLD
;
Related Commands
D.39.5 ACT-LCS
D.39.6 CANC-LCS
D.39.8 ED-LICENSE
Sets the license information of an NE.
Function
This command sets the license information of an NE.
Usage Note
None
Category
Facility Management
Security
Provisioning
Command Syntax
ED-LICENSE:[<TID>]:<AID>:<CTAG>:::[CRSTYPE=<CRSTYPE>,]
[CRSCAP=<CRSCAP>,]
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-LICENSE::SHELF-1:C:::CRSTYPE=OTN,CRSCAP=360
Response Message
NE 2004-01-01 11:37:18 M 100 COMPLD ;
Related Commands
D.39.9 RTRV-LICENSE
D.39.9 RTRV-LICENSE
Queries the license information of an NE.
Function
This command queries the license information of an NE.
Usage Note
None
Category
Facility Management
Security
Retrieve
Command Syntax
RTRV-LICENSE:[<TID>]:<AID>:<CTAG>;
Command Parameters
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ^^^"<AID>::
[CRSTYPE=<CRSTYPE>,][CRSCAP=<CRSCAP>]"<cr><lf>
Response Parameters
Parameter Description
Example
Command
RTRV-LICENSE::SHELF-1:C;
Response Message
NE 2004-01-01 11:37:18 M 100 COMPLD "SHELF-1::CRSTYPE=FREE,CRSCAP=FREE" ;
Related Commands
D.39.8 ED-LICENSE
D.39.10 ED-NELICENSE
To set the License Infomation of NE.
Function
This command sets the license information of an NE.
Usage Note
None
Category
Facility Management
Security
Provisioning
Command Syntax
ED-NELICENSE:[<TID>]::<CTAG>:::[NELCSTYPE=<NELCSTYPE>],
[NELCSLEVEL=<NELCSLEVEL>],[NELCSASSIGN=<NELCSASSIGN>],
Command Parameters
Parameter Description Default Value
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ed-nelicense:::s:::NELCSTYPE=T32SUP100G,NELCSLEVEL=NE,NELCSASSIGN=100
Response Message
NFO-128-38 2013-12-07 16:06:49
M S COMPLD
;
Related Commands
RTRV-NELICENSE
D.39.11 RTRV-NELICENSE
Queries the license information of an NE.
Function
This command queries the license information of an NE.
Usage Note
None
Category
Facility Management
Security
Retrieve
Command Syntax
RTRV-NELICENSE:[<TID>]::<CTAG>::<NELCSTYPE>;
Command Parameters
<TID> Indicates the equipment unit identifier. The valid format is SHELF-<SHELF ID>. NA
<NELCST Indicates the NE license state. The valid types are ALL(all NA
YPE> license),TPBASIC,TPENHANCE,TPINTERWORK,SANACCESS,SDHFEE,PK
TFEE,T32SUP100G,7500SUP10G,FLEXGRID
Response Syntax
<cr><lf><lf> ^^^<rsphdr><cr><lf> M^^<ctag>^COMPLD<cr><lf>
^^^"[NELCSTYPE=<NELCSTYPE>],[NELCSLEVEL=<NELCSLEVEL>],
[NELCSASSIGN=<NELCSASSIGN>],[NELCSUSED=<NELCSUSED>]"<cr><lf>
Response Parameters
Parameter Description
<NELCSTY Indicates the NE license state. The valid types are ALL(all
PE> license),TPBASIC,TPENHANCE,TPINTERWORK,SANACCESS,SDHFEE,PKTFE
E,T32SUP100G,7500SUP10G,FLEXGRID.
Example
Command
RTRV-NELICENSE:::S::T32SUP100G;
Response Message
NFO-128-38 2013-12-07 16:06:26
M S COMPLD
"NELCSTYPE=T32SUP100G,NELCSLEVEL=NE,NELCSASSIGN=1,NELCSUSED=1"
;
Related Commands
ED-NELICENSE
D.40 RADIUS Management
This section lists commands which used to configurate the RADIUS function .
D.40.1 ED-RADIUS
Sets the enable status of RADIUS authentication.
Function
This command sets the enable status of RADIUS authentication.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
ED-RADIUS:[<TID>]::<CTAG>:::Radius=<Radius>;
Command Parameters
NA
<Radius> Indicates the enable status of
RADIUS authentication. The
valid values are as follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-RADIUS:::100:::Radius=ENABLE;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.2 RTRV-RADIUS
D.40.2 RTRV-RADIUS
Obtains the enable status of RADIUS authentication.
Function
This command is used to obtain the enable status of RADIUS authentication.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
RTRV-RADIUS:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"Radius=<Rds_Radius>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-RADIUS:::100;
Response Message
NE 2002-03-04 15:23:20
M 10 COMPLD
"Radius=ENABLE"
;
Related Commands
D.40.1 ED-RADIUS
D.40.3 ENT-RADIUS-SERVER
Adds a RADIUS server or a RADIUS proxy server.
Function
This command adds a RADIUS server or a RADIUS proxy server.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
ENT-RADIUS-SERVER:
[<TID>]::<CTAG>:::ServerType=<Rds_ServerType>,Address=<Rds_Address>,AddrType=
<Rds_AddrType>,PRI=<Rds_PRI>,SharedKey=<Rds_SharedKey>,Interval=<Rds_Interval
>,RetryTimes=<Rds_RetryTimes>;
Command Parameters
NA
<Rds_ServerType> Indicates the RADIUS server type. The valid values are as
follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ENT-RADIUS-
SERVER:::100:::ServerType=authsvr,Address=129.9.68.134,AddrType=radius-
server,PRI=PRIMARY,SharedKey=\"ospTest@123\",Interval=5,RetryTimes=3;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.4 DLT-RADIUS-SERVER
D.40.6 RTRV-RADIUS-SERVER
D.40.4 DLT-RADIUS-SERVER
Deletes a RADIUS server or a RADIUS proxy server.
Function
This command deletes a RADIUS server or a RADIUS proxy server.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
DLT-RADIUS-SERVER:
[<TID>]::<CTAG>:::ServerType=<Rds_ServerType>,Address=<Rds_Address>;
Command Parameters
NA
<Rds_ServerType> Indicates the RADIUS server
type. The valid values are as
follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-RADIUS-SERVER:::100:::ServerType=authsvr,Address=129.9.68.134;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.3 ENT-RADIUS-SERVER
D.40.5 ED-RADIUS-SERVER
Sets the parameters of a RADIUS server.
Function
This command sets the parameters of a RADIUS server.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
ED-RADIUS-SERVER:
[<TID>]::<CTAG>:::ServerType=<Rds_ServerType>,Address=<Rds_Address>,SharedKey
=<Rds_SharedKey>,Interval=<Rds_Interval>,RetryTimes=<Rds_RetryTimes>;
Command Parameters
Parameter Description Default Value
NA
<Rds_ServerType> Indicates the RADIUS server type. The valid values are as
follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-RADIUS-
SERVER:::100:::ServerType=authsvr,Address=129.9.68.134,SharedKey="ospTest@1
23",Interval=5,RetryTimes=3;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.3 ENT-RADIUS-SERVER
D.40.4 DLT-RADIUS-SERVER
D.40.6 RTRV-RADIUS-SERVER
Obtains the information about a RADIUS server or a RADIUS proxy server.
Function
This command is used to obtain the information about a RADIUS server or a RADIUS proxy
server.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
RTRV-RADIUS-SERVER:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"ServerType=<Rds_ServerType>,Address=<Rds_Address>,AddrType=<Rds_AddrTyp
e>,PRI=<Rds_PRI>,Interval=<Rds_Interval>,RetryTimes=<Rds_RetryTimes>,Shared
Key=<Rds_SharedKey>"<cr><lf>;
Response Parameters
Parameter Description
<Rds_ServerType> Indicates the RADIUS server type. The valid values are as
follows:
acctsvr: indicates the accounting server.
authsvr: indicates the authentication server.
<Rds_Address> Indicates the IP address of the RADIUS server. Example:
129.9.68.134
<Rds_AddrType> Indicates the server type. The valid values are as follows:
radius-server: indicates that the server is a real RADIUS
server.
proxy-nas: indicates that the server is a RADIUS proxy
server. The server is a GNE.
<Rds_PRI> Indicates the working status of the RADIUS server. The valid
value is PRIMARY or SECONDARY.
<Rds_Interval> Indicates the response expiration time in seconds. The value
Parameter Description
Example
Command
RTRV-RADIUS-SERVER:::100;
Response Message
NE 2002-03-04 15:23:20
M 10 COMPLD
"SERVERTYPE=AUTHSVR,ADDRESS=129.9.68.134,ADDRTYPE=RADIUS-
SERVER,PRI=PRIMARY,INTERVAL=5,RETRYTIMES=3,SHAREDKEY=********"
;
Related Commands
D.40.5 ED-RADIUS-SERVER
D.40.7 ED-RADIUS-PROXY
Sets the enable status of a RADIUS proxy server.
Function
This command sets the enable status of a RADIUS proxy server.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
ED-RADIUS-PROXY:[<TID>]::<CTAG>:::Proxy=<Rds_Proxy>;
Command Parameters
Parameter Description Default Value
NA
<Rds_Proxy> Indicates the enable status of a RADIUS proxy server.
The valid values are as follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-RADIUS-PROXY:::100:::Proxy=ENABLE;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.8 RTRV-RADIUS-PROXY
D.40.8 RTRV-RADIUS-PROXY
Obtains the enable status of a RADIUS proxy server.
Function
This command is used to obtain the enable status of a RADIUS proxy server.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
RTRV-RADIUS-PROXY:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"Proxy=<Proxy>"<cr><lf>
;
Response Parameters
Parameter Description
<Rds_Proxy> Indicates the enable status of a RADIUS proxy server. The valid
values are as follows:
ENABLE: indicates that a RADIUS proxy server is
enabled.
DISABLE: indicates that a RADIUS proxy server is
disabled.
Example
Command
RTRV-RADIUS-PROXY:::100;
Response Message
NE 2002-03-04 15:23:20
M 10 COMPLD
"PROXY=ENABLE"
;
Related Commands
D.40.7 ED-RADIUS-PROXY
D.40.9 ED-RADIUS-PROXYNASKEY
Sets the shared key of RADIUS proxy server to NAS.
Function
This command sets the shared key of RADIUS proxy server to NAS.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
ED-RADIUS-PROXYNASKEY:
[TID]::<CTAG>:::ServerType=<Rds_ServerType>,Address=<Rds_address>,SharedKey=<R
ds_SharedKey>;
Command Parameters
NA
<Rds_ServerType> Indicates the RADIUS server type. The valid values are as
follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf> ;
Response Parameters
None
Example
Command
ED-RADIUS-
PROXYNASKEY:::100:::ServerType=authsvr,Address=129.9.68.134,SharedKey=\"osp
Test@123\";
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.3 ENT-RADIUS-SERVER
D.40.4 DLT-RADIUS-SERVER
D.40.10 RTRV-RADIUS-PROXYNASKEY
Obtains the shared key of RADIUS proxy server to NAS.
Function
This command is used to obtains the shared key of RADIUS proxy server to NAS.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
RTRV-RADIUS-PROXYNASKEY:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"ServerType=<Rds_ServerType>,Address=<Rds_Address>,SharedKey=<Rds_Shared
Key>"<cr><lf>;
Response Parameters
Parameter Description
<Rds_ServerType> Indicates the RADIUS server type. The valid values are as
follows:
acctsvr: indicates the accounting server.
authsvr: indicates the authentication server.
<Rds_Address> Indicates the IP address of the RADIUS server. Example:
129.9.68.134
<Rds_SharedKey> Indicates the shared key, and is displayed in '*'.
Example
Command
RTRV-RADIUS-PROXYNASKEY:::100;
Response Message
NE 2002-03-04 15:23:20
M 10 COMPLD
"SERVERTYPE=AUTHSVR,ADDRESS=129.9.68.134,SHAREDKEY=********"
;
Related Commands
D.40.5 ED-RADIUS-SERVER
D.40.11 DLT-RADIUS-PROXYNASKEY
Deletes the shared key of RADIUS proxy server to NAS
Function
This command deletes the shared key of RADIUS proxy server to NAS.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
DLT-RADIUS-PROXYNASKEY:
[<TID>]::<CTAG>:::ServerType=<Rds_ServerType>,Address=<Rds_Address>;
Command Parameters
Parameter Description Default Value
NA
<Rds_ServerType> Indicates the RADIUS server
type. The valid values are as
follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
DLT-RADIUS-PROXYNASKEY:::100:::ServerType=authsvr,Address=129.9.68.134;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.3 ENT-RADIUS-SERVER
D.40.12 ED-RADIUS-PROXYFORCEAUTH
Sets the enable status of the RADIUS proxy force authentication.
Function
This command sets the enable status of the RADIUS proxy force authentication.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
ED-RADIUS-PROXYFORCEAUTH:[<TID>]::<CTAG>:::ForceAuth=<Rds_ForceAuth>;
Command Parameters
NA
<Rds_ForceAuth> Indicates the enable status of the RADIUS proxy
force authentication. The valid values are as follows:
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
Response Parameters
None
Example
Command
ED-RADIUS-PROXYFORCEAUTH:::100:::ForceAuth=ENABLE;
Response Message
NE 2002-03-04 15:23:20
M 100 COMPLD
;
Related Commands
D.40.8 RTRV-RADIUS-PROXY
D.40.13 RTRV-RADIUS-PROXYFORCEAUTH
Obtains the enable status of the RADIUS proxy force authentication.
Function
This command is used to obtain the enable status of the RADIUS proxy force authentication.
Usage Note
None
Category
RADIUS
Security
Super
Command Syntax
RTRV-RADIUS-PROXYFORCEAUTH:[<TID>]::<CTAG>;
Command Parameters
None
Response Syntax
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
^^^"FORCEAUTH=<Rds_ForceAuth>"<cr><lf>
;
Response Parameters
Parameter Description
Example
Command
RTRV-RADIUS-PROXYFORCEAUTH:::100;
Response Message
NE 2002-03-04 15:23:20
M 10 COMPLD
"FORCEAUTH=ENABLE"
;
Related Commands
D.40.7 ED-RADIUS-PROXY
D.41 TL1 Parameters
D.41.1 Port Numbering
Rule for Port Numbering
In the TL1 command line, ports can be expressed as : FAC-<Shelf ID>-<Slot ID>-<Port
number>. Methods for port numbering are described according to card types and functions.
The OTU cards intended for Huawei WDM products are classified as follows:
Transponder cards, such as LSX
Line cards, such as NS3, NQ2, and ND2
Tributary cards, such as TOM and TQX
Ports on the cards in the preceding classes are numbered in the same way. The port
numbering rule is as follows:
In Huawei software model, ports are numbered by function. As the number of line ports on an
OTU card are relatively fixed, line ports are numbered with precedence. That is, numbers 1
and 2 are reserved for a pair of WDM-side ports that protect each other and numbering of
client-side ports starts from 3. If such WDM-side ports are not configured, numbers 1 and 2
are reserved.
Based on this rule, the number for the 3 card types is as follows:
Transponder cards with 1 line port (LSX, LSXL, LQMS etc.)
Port Number 1 2 3
Port Number 1 2 3 4
Port Number 3 4 5 6
L4G
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
LDX
Port Name Port Number
IN1/OUT1 1
IN2/OUT2 3
RX1/TX1 5
RX2/TX2 6
LEM24
IN3/OUT3 3
IN4/OUT4 4
TX5/RX5 5
TX6/RX6 6
TX7/RX7 7
TX8/RX8 8
TX9/RX9 9
TX10/RX10 10
TX11/RX11 11
TX12/RX12 12
TX13/RX13 13
TX14/RX14 14
Port Name Port Number
TX15/RX15 15
TX16/RX16 16
TX17/RX17 17
TX18/RX18 18
TX19/RX19 19
TX20/RX20 20
TX21/RX21 21
TX22/RX22 22
TX23/RX23 23
TX24/RX24 24
TX25/RX25 25
TX26/RX26 26
TX27/RX27 27
TX28/RX28 28
LEX4
IN1/OUT1 3
Port Name Port Number
IN2/OUT2 4
TX1/RX1 5
TX2/RX2 6
TX3/RX3 7
TX4/RX4 8
LOA
IN1/OUT1 1
TX1/RX1 3
TX3/RX3 4
TX4/RX4 5
TX4/RX4 6
TX4/RX4 7
TX4/RX4 8
TX4/RX4 9
TX4/RX4 10
LOG
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
LOM
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
Port Name Port Number
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
LQG
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
LQM
IN1/OUT1 1
IN2/OUT2 2
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
LQMD
Port Name Port Number
IN1/OUT1 1
IN2/OUT2 2
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
LQMS
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
LSC
IN/OUT 1
TX/RX 3
LSQ
IN/OUT 1
TX/RX 3
LSX
IN/OUT 1
TX/RX 3
LSXL
IN/OUT 1
TX/RX 3
LSXLR
IN/OUT 1
LSXR
IN/OUT 1
LTX
Port Name Port Number
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
TX9/RX9 11
TX10/RX10 12
LWXS
IN/OUT 1
TX/RX 3
TMX
Port Name Port Number
IN/OUT 1
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
ND2
IN1/OUT1 1
IN2/OUT2 2
NO2
IN1/OUT1 1
IN2/OUT2 2
IN3/OUT3 3
IN4/OUT4 4
IN5/OUT5 5
IN6/OUT6 6
Port Name Port Number
IN7/OUT7 7
IN8/OUT8 8
NQ2
IN1/OUT1 1
IN2/OUT2 2
IN3/OUT3 3
IN4/OUT4 4
NS2
IN/OUT 1
NS3
Table D-5 Serial numbers of the interfaces of the NS3 board displayed on the NM
IN/OUT 1
NS4
Table D-6 Serial numbers of the interfaces of the NS4 board displayed on the NM
Port Name Port Number
IN/OUT 1
TBE
TX/RX 3
TX1/RX1 4
TX2/RX2 5
TX3/RX3 6
TX4/RX4 7
TX5/RX5 8
TX6/RX6 9
TX7/RX7 10
TX8/RX8 11
TDX
TX1/RX1 3
TX2/RX2 4
TEM28
Port Name Port Number
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
... ...
TX28/RX28 30
TOA
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
TOG
Port Name Port Number
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
TOM
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
Port Name Port Number
TQM
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TQX
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TSC
TX/RX 3
TSXL
Port Name Port Number
RX/TX 3
TTX
TX1/RX1 3
TX2/RX2 4
TX3/RX3 5
TX4/RX4 6
TX5/RX5 7
TX6/RX6 8
TX7/RX7 9
TX8/RX8 10
TX9/RX9 11
TX10/RX10 12
PID Card
Table D-7 NPO2
IN/OUT 1
Table D-8 NPO2E
Port Name Port Number
IN/OUT 1
RI/TO 2
RO1/TO1 3
RO2/TO2 4
OUT 1
M01-M40 2-41
MON 42
Table D-10 D40/D40V
IN 1
D01-D40 2-41
MON 42
Table D-11 DFIU
EIN/EOUT 1
ERM/ETM 2
Port Name Port Number
ERC/ETC 3
WIN/WOUT 4
WRM/WTM 5
WRC/WTC 6
Table D-12 FIU
IN/OUT 1
RM/TM 2
RC/TC 3
MON 4
Table D-13 ITL
IN/OUT 1
RE/TE 2
RO/TO 3
MON 4
A/D 1
MI/MO 2
IN/OUT 3
Table D-15 CMR2
A1/D1 1
A2/D2 2
MI/MO 3
IN/OUT 4
Table D-16 CMR4
A1/D1 1
A2/D2 2
A3/D3 3
A4/D4 4
MI/MO 5
IN/OUT 6
Table D-17 DMR1
Port Name Port Number
WA/WD 1
EA/ED 2
WMI/WMO 3
WIN/WOUT 4
EMI/EMO 5
EIN/EOUT 6
Table D-18 MR2
A1/D1 1
A2/D2 2
MI/MO 3
IN/OUT 4
Table D-19 MR4
A1/D1 1
A2/D2 2
A3/D3 3
A4/D4 4
Port Name Port Number
MI/MO 5
IN/OUT 6
Table D-20 MR8
A1/D1 1
A2/D2 2
A3/D3 3
A4/D4 4
A5/D5 5
A6/D6 6
A7/D7 7
A8/D8 8
MI/MO 9
IN/OUT 10
Table D-21 MR8V
A1/D1 1
A2/D2 2
Port Name Port Number
A3/D3 3
A4/D4 4
A5/D5 5
A6/D6 6
A7/D7 7
A8/D8 8
MI/MO 9
IN/OUT 10
VI 11
VO 12
Table D-22 SBM2
A1 1
D1 2
A2 3
D2 4
LINE 5
EXT 6
Reconfigurable Optical Add and Drop Multiplexing Card
Table D-23 RDU9
IN 1
EXPO 2
DM1-DM8 3-10
TOA/ROA 11
MONI 12
MONO 13
Table D-24 RMU9
EXPI 1
OUT 2
AM1-AM8 3-10
TOA/ROA 11
MONI 12
MONO 13
Table D-25 ROAM
IN 1
Port Name Port Number
EXPO 2
EXPI 3
OUT 4
DM 5
A01-A40 6-45
NOTE:
The A01-A40 interfaces correspond to the M01-M40
interfaces on the physical front panel.
Table D-26 TD20
IN 1
AIN 2
AOUT 3
VO 4
DMIN 5
DM01 to DM20 6 to 25
MON 26
Table D-27 TM20
OUT 1
Port Name Port Number
AM01 to AM20 2 to 21
MON 22
Table D-28 WSD9
IN 1
EXPO 2
DM1-DM8 3-10
MONI 11
MONO 12
Table D-29 WSM9
EXPI 1
OUT 2
AM1-AM8 3-10
MONI 11
MONO 12
Table D-30 WSMD2
IN 1
Port Name Port Number
DM 2
AM 3
OUT 4
EXPO 5
EXPI 6
MONO 7
MONI 8
Table D-31 WSMD4
IN 1
DM1 2
AM1 3
OUT 4
DM2-DM4 5 to 7
AM2-AM4 8 to 10
MONO 11
MONI 12
Table D-32 WSMD9
Port Name Port Number
IN 1
EXPO 2
EXPI 3
OUT 4
DM1-DM8 5 to 12
AM1-AM8 13 to 20
MONO 21
MONI 22
Table D-33 DWSS20
IN 1
OUT 2
DM1-DM20 3 to 22
AM1-AM20 23 to 42
MONO 43
MONI 44
LINE 1
SYS 2
MON 3
Table D-35 DAS1
LIN/LOUT 1
RM/TM 3
RX/TX 4
RRDC 8
SOUT 9
RTDC 10
MONR 11
SIN 12
TRDC 15
TTDC 17
MONT 18
Table D-36 HBA
Port Name Port Number
IN 1
OUT 2
MON 3
Table D-37 TN11OAU1
IN 1
OUT 4
RDC/TDC 5
MON 6
Table D-38 TN12OAU1/TN13OAU1
IN 1
OUT 4
RDC/TDC 5
MON 6
VI 7
VO 8
Table D-39 TN11OBU1
Port Name Port Number
IN 1
OUT 2
MON 3
Table D-40 TN12OBU1
IN 1
OUT 2
MON 3
VI 4
VO 5
Table D-41 TN11OBU2
IN 1
OUT 2
MON 3
Table D-42 TN12OBU2
IN 1
OUT 2
Port Name Port Number
MON 3
VI 4
VO 5
Table D-43 RAU1
IN 1
PAOUT 2
RDC 3
OUT 4
TDC 5
MONO 6
LINE 9
SYS 10
MONS 11
Table D-44 RAU2
IN 1
PAOUT 2
Port Name Port Number
RDC 3
OUT 4
TDC 5
MONO 6
VI 7
VO 8
LINE 9
SYS 10
MONS 11
Table D-45 SRAU1
IN 1
PAOUTa 2
RDC 3
OUT 4
TDC 5
MONO 6
VI 7
Port Name Port Number
VO 8
LINE 9
SYS 10
MONS 11
RMF 12
a: Virtual port.
RM/TM 1
Table D-47 SC1
RM/TM 1
Table D-48 SC2
RM1/TM1 1
RM2/TM2 2
Table D-49 ST2
Port Name Port Number
RM1/TM1 1
RM2/TM2 2
TO11/RI11 1
TO12/RI12 2
TO21/RI21 3
TO22/RI22 4
TI1/RO1 5
TI2/RO2 6
Table D-51 OLP
TO1/RI1 1
TO2/RI2 2
TI/RO 3
Table D-52 SCS
TI1/RO1 1
Port Name Port Number
TO11/RI11 2
TO12/RI12 3
TI2/RO2 4
TO21/RI21 5
TO22/RI22 6
IN1-IN4 1-4
Table D-54 MCA8
IN1-IN8 1-8
Table D-55 OPM8
IN1-IN8 1-8
Table D-56 WMU
IN1 1
IN2 2
Variable Optical Attenuator Card
Table D-57 VA1
IN/OUT 1
Table D-58 VA4
IN1/OUT1 1
IN2/OUT2 2
IN3/OUT3 3
IN4/OUT4 4
IN 1
OUT 2
Table D-60 TDC
IN/OUT 1
TN11OBU2 FAC-{N}-{2-8,12-19,21-
TN12OBU2 27,30-36}-2
TN11HBA FAC-{N}-{1-8,12-27,29-
36}-2
TN11DAS1 FAC-{N}-{2-7,13-18,21-
26,30-35}-{9,16}
TN11RAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{4}
TN12OAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-7
TN12OBU1 FAC-{N}-{1-8,11-27,29-
36}-4
TN12VA4 FAC-{N}-{1-8,12-27,29-
36}-{1-4}
TN11DAS1 FAC-{N}-{2-7,13-18,21-
26,30-35}-{5,12}
Table D-62 REFER/ DETECTOR/VOA 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11OBU2 FAC-{N}-{2-8,12-18,20-
TN12OBU2 26,28-34,36-42,46-52,54-
60,62-68}-2
TN11HBA FAC-{N}-{2-7,12-17,20-
25,28-33,36-41,46-51,54-
AID type AID format Unit type Pattern Notes
59,62-67}-2
TN11DAS1 FAC-{N}-{1-8,11-18,19-
26,27-34,35-42,45-52,53-
60,61-68}-{9,16}
TN11RAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{4}
TN12OAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-7
TN12OBU1 FAC-{N}-{1-8,11-42,45-
68}-4
TN12VA4 FAC-{N}-{1-8,11-42,45-
68}-{1-4}
TN11DAS1 FAC-{N}-{1-8,11-18,19-
26,27-34,35-42,45-52,53-
60,61-68}-{5,12}
Table D-63 REFER/ DETECTOR/VOA 6800A values
AID type AID format Unit type Pattern Notes
TN11OBU2 FAC-{N}-{2-17}-2
TN12OBU2
TN11HBA FAC-{N}-{2-16}-2
TN11DAS1 FAC-{N}-{1-17}-{9,16}
TN11RAU1 FAC-{N}-{2-17}-{4}
TN12OAU1 FAC-{N}-{2-17}-7
AID type AID format Unit type Pattern Notes
TN12OBU1 FAC-{N}-{1-17}-4
TN12VA4 FAC-{N}-{1-17}-{1-4}
TN11DAS1 FAC-{N}-{1-17}-{5,12}
Table D-64 REFER/ DETECTOR/VOA 3800A values
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{2,3,4,5}-{9,16}
TN11RAU1 FAC-{2-4,11}-{4}
TN12OBU2 FAC-{11,2-4}-4
TN12OAU1 FAC-{11,2-4}-7
TN12OBU1 FAC-{11,2-5}-4
TN11DAS1 FAC-{N}-{2,3,4,5}-{5,12}
Table D-65 REFER/ DETECTOR/VOA 8800T16 values
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{N}-{1-8,11-18}-
{9,16}
TN11RAU1 FAC-{N}-{2-8,12-18}-{4}
TN12OAU1 FAC-{N}-{2-8,12-18}-7
TN12OBU1 FAC-{N}-{1-18}-4
TN12VA4 FAC-{N}-{1-18}-{1-4}
FAC-N-M-X
TN11DAS1 FAC-{N}-{1-8,11-18}-
{5,12}
APE
Table D-66 ODDBD/ EVENBD 8800 T32 values
AID type AID format Unit type Pattern Notes
TN13WSM9 SLOT-{N}-{1-6,12-
17,20-25,29-34}
TN11RMU9 SLOT-{N}-{1-8,11-
27,29-36}
TN11WSMD9 SLOT-{N}-{1-7,12-
18,20-26,29-35}
TN11ROAM FAC-{N}-{1-6,11-17,20-
25,29-34}-4
TN11OPM8 FAC-{N}-{1-8,11-27,29-
36}-{1-8}
Table D-67 ODDBD/ EVENBD 8800 T64 values
AID type AID format Unit type Pattern Notes
TN13WSM9 SLOT-{N}-{1-6,11-
16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN11RMU9 SLOT-{N}-{1-8,11-
42,45-68}
TN11WSMD9 SLOT-{N}-{1-7,11-
17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11MCA8 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-8}
TN11ROAM FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-4
TN11OPM8 FAC-{N}-{1-8,11-42,45-
68}-{1-8}
Table D-68 ODDBD/ EVENBD 6800A values
AID type AID format Unit type Pattern Notes
TN13WSM9 SLOT-{N}-{1-15}
TN11RMU9 SLOT-{N}-{1-17}
TN11WSMD9 SLOT-{N}-{1-16}
AID type AID format Unit type Pattern Notes
TN11ROAM FAC-{N}-{1-15}-4
TN11OPM8 FAC-{N}-{1-17}-{1-8}
Table D-69 ODDBD/ EVENBD 8800 T16 values
AID type AID format Unit type Pattern Notes
TN13WSM9 SLOT-{N}-{1-6,11-16}
TN11RMU9 SLOT-{N}-{1-18}
TN11WSMD9 SLOT-{N}-{1-7,11-17}
TN11OPM8 FAC-{N}-{1-18}-{1-8}
CFP
Table D-70 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN54TSXL FAC-{N}-{1-8,11-
42,45-68}-{3}
Table D-72 AID 6800A values
AID type AID format Unit type Pattern Notes
CFPS
Table D-74 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
CLNT
Table D-81 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN52TQX CLNT-{N}-{1-8,12-
27,29-36}-{1-4}
TN53TSXL CLNT-{N}-{1-8,12-
27,29-36}-{1}
TN53TQX CLNT-{N}-{1-8,12-
27,29-36}-{1-4}
TN54TEM28 CLNT-{N}-{1-7,12-
18,20-26,29-35}-{1-16}
TN12LWXS FAC-{N}-{1-8,12-27,29-
36}-{3}
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-8,12-27,29-
36}-{5-6}
TN12LSX FAC-{N}-{1-8,12-27,29-
36}-{3}
TN13LSX FAC-{N}-{1-8,12-27,29-
36}-{3}
TN11LSQ FAC-{N}-{2-8,13-19,21-
27,30-36}-{3}
TN12LQMD CLNT-{N}-{1-8,12-
27,29-36}-{1}-{1-4}
TN12LQMS CLNT-{N}-{1-8,12-
27,29-36}-{1}-{1-4}
TN11LOG CLNT-{N}-{1-8,12-
27,29-36}-{1}-{1-8}
TN11LOM CLNT-{N}-{1-7,12-
18,20-26,29-35}-{1}-{1-
8}
TN13LQM CLNT-{N}-{1-8,12-
27,29-36}-{1}-{1-4}
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{1}-{1-8}
CLNT-{N}-{1-8,12-
27,29-36}-{2}-{1-8}
CLNT-{N}-{1-8,12-
27,29-36}-{3,5,6}-{1-4}
CLNT-{N}-{1-8,12-
27,29-36}-{4,7,8}-{1-2}
TN54TOA CLNT-{N}-{1-8,12-
27,29-36}-{1-8}-{1-8}
Table D-82 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN52TDX CLNT-{N}-{1-8,11-
42,45-68}-{1-2}
TN52TQX CLNT-{N}-{1-8,11-
42,45-68}-{1-4}
TN53TSXL CLNT-{N}-{1-8,11-
42,45-68}-{1}
TN53TQX CLNT-{N}-{1-8,11-
42,45-68}-{1-4}
TN54TEM28 CLNT-{N}-{1-7,11-
17,19-25,27-33,35-41,45-
51,53-59,61-67}-{1-16}
TN12LWXS FAC-{N}-{1-8,11-42,45-
68}-{3}
TN12LDX FAC-{N}-{1-8,11-42,45-
68}-{5-6}
TN12LSX FAC-{N}-{1-8,11-42,45-
68}-{3}
TN13LSX FAC-{N}-{1-8,11-42,45-
68}-{3}
TN11LSQ FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{3}
TN12LQMD CLNT-{N}-{1-8,11-
AID type AID format Unit type Pattern Notes
42,45-68}-{1}-{1-4}
TN12LQMS CLNT-{N}-{1-8,11-
42,45-68}-{1}-{1-4}
TN11LOG CLNT-{N}-{1-8,11-
42,45-68}-{1}-{1-8}
TN11LOM CLNT-{N}-{1-7,11-
17,19-25,27-33,35-41,45-
51,53-59,61-67}-{1}-{1-
8}
TN13LQM CLNT-{N}-{1-8,11-
42,45-68}-{1}-{1-4}
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{1}-{1-8}
CLNT-{N}-{1-8,11-
42,45-68}-{2}-{1-8}
CLNT-{N}-{1-8,11-
42,45-68}-{3,5,6}-{1-4}
CLNT-{N}-{1-8,11-
42,45-68}-{4,7,8}-{1-2}
TN54TOA CLNT-{N}-{1-8,11-
42,45-68}-{1-8}-{1-8}
Table D-83 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11TQX CLNT-{N}-{1-8,11-16}-
{1-4}
TN12LSXL CLNT-{N}-{3-17}-1
TN52TQX CLNT-{N}-{1-8,11-16}-
{1-4}
TN53TQX CLNT-{N}-{1-8,11-16}-
{1-4}
TN12LWXS
TN12LDX FAC-{N}-{1-17}-{5-6}
TN11LSQ FAC-{N}-{2-8,12-16}-
{3}
TN11LOM CLNT-{N}-{1-16}-1-{1-
8}
TN11TOM CLNT-{N}-{1-8,11-16}-
{1-4}-{1-8}
TN52TOM CLNT-{N}-{1-8,11-16}-
{1,2}-{1-8}
CLNT-{N}-{1-8,11-16}-
{3,5,6}-{1-4}
CLNT-{N}-{1-8,11-16}-
{4,7,8}-{1-2}
TN11LOG CLNT-{N}-{1-8,11-16}-
TN12LOG 1-{1-8}
Table D-84 ID 3800A values
AID type AID format Unit type Pattern Notes
TN11TOM CLNT-{2-5}-{1-4}-{1-8}
TN52TOM CLNT-{2-5}-{1,2}-{1-8}
CLNT-{2-5}-{3,5,6}-{1-
4}
CLNT-{2-5}-{4,7,8}-{1-
2}
AID type AID format Unit type Pattern Notes
TN11LOG CLNT-{2-5}-1-{1-8}
TN12LOG
TN11LOM CLNT-{3-5}-1-{1-8}
TN12LDX FAC-{2-5,11}-{5-6}
TN53TSXL CLNT-{N}-{1-
8,11-18}-{1}
TN53TQX CLNT-{N}-{1-
8,11-18}-{1-4}
TN54TEM28 CLNT-{N}-{1-
7,11-17}-{1-16}
TN12LDX FAC-{N}-{1-18}-
{5-6}
TN13LSX FAC-{N}-{1-18}-
{3}
TN11LSQ FAC-{N}-{2-8,12-
18}-{3}
<SHELF>-<slot>- 8,11-18}-{1-12}-
<port>- {1-8}
<CHANNEL>:
VCLNT-N-M-X-Y TN12LOG CLNT-{N}-{1-
8,11-18}-{1}-{1-
<string>-
8}
<SHELF>-<slot>-
<port>- TN12LOM CLNT-{N}-{1-
<CHANNEL>: 18}-{1}-{1-8}
CLNT-N-M-X-Y
TN52TOM CLNT-{N}-{1-
8,11-18}-{1}-{1-
8}
CLNT-{N}-{1-
8,11-18}-{2}-{1-
8}
CLNT-{N}-{1-
8,11-18}-{3,5,6}-
{1-4}
CLNT-{N}-{1-
8,11-18}-{4,7,8}-
{1-2}
TN54TOA CLNT-{N}-{1-
8,11-18}-{1-8}-
{1-8}
CRS-OHBYTE
Table D-86 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11ST2 FAC-{N}-{1-8,11-
42,45-68}-{1,2}
Table D-87 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11HSC1 FAC-{N}-{1-8,12-
27,29-36}-1
EC
Table D-90 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11LOM FAC-{N}-{1-7,12-18,20-
26,29-35}-{3-10}
TN12LOM FAC-{N}-{1-8,12-27,29-
36}-{3-10}
TN11LEM24 FAC-{N}-{1-7,12-18,20-
26,29-35}-{7-28}
TN54TOA FAC-{N}-{1-8,12-27,29-
36}-{3-10}
TN54TEM28 FAC-{N}-{1-7,12-18,20-
AID type AID format Unit type Pattern Notes
26,29-35}-{7-30}
Table D-91 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11LOM FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{3-10}
TN12LOM FAC-{N}-{1-8,11-42,45-
68}-{3-10}
TN11LEM24 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{7-28}
TN54TOA FAC-{N}-{1-8,11-42,45-
68}-{3-10}
TN54TEM28 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{7-30}
Table D-92 AID 6800A values
AID type AID format Unit type Pattern Notes
TN12LOG FAC-{N}-{1-8,11-16}-{3-
TN52TOG 10}
TN12TQM FAC-{N}-{1-8,11-16}-{3-
6}
TN52TOM FAC-{N}-{1-8,11-16}-{3-
10}
TN12LOM FAC-{N}-{1-17}-{3-10}
TN11LEM24 FAC-{N}-{1-7,11-16}-{7-
28}
Table D-93 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12TQM FAC-{2-5}-{3-6}
TN52TOM FAC-{2-5}-{3-10}
TN11LEM24 FAC-{{3-5}-{7-28}
TN12LOM FAC-{2-5,11}-{3-10}
TN12LOG FAC-{2-5}-{3-10}
TN52TOG
Table D-94 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
TN12LOM FAC-{N}-{1-18}-
{3-10}
TN11LEM24 FAC-{N}-{1-7,11-
17}-{7-28}
TN54TOA FAC-{N}-{1-
8,11–18}-{3-10}
TN54TEM28 FAC-{N}-{1-7,11-
17}-{7-30}
EQPT
Table D-95 EQPT 8800 T32 values
AID format Unit type Pattern
TN11CRPC SLOT-{N}-{120-123}
TN11D40 SLOT-{N}-{1-6,11-17,20-25,29-34}
TN11D40V SLOT-{N}-{1-6,11-17,20-25,29-34}
TN11DCU SLOT-{N}-{1-8,11-27,29-36}
AID format Unit type Pattern
TN11DMR1 SLOT-{N}-{1-8,12-27,29-36}
TN11GFU SLOT-{N}-{1-8,11-27,29-36}
TN11HBA SLOT-{N}-{2-7,13-18,21-26,30-35}
TN11HSC1 SLOT-{N}-{1-8,12-27,29-36}
TN11ITL SLOT-{N}-{1-8,11-27,29-36}
TN11LOG SLOT-{N}-{1-8,12-27,29-36}
TN11LOM SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11LSXR SLOT-{N}-{1-8,12-27,29-36}
TN11M40 SLOT-{N}-{1-6,11-17,20-25,29-34}
TN11M40V SLOT-{N}-{1-6,11-17,20-25,29-34}
TN11MCA4 SLOT-{N}-{1-7,11-18,20-26,29-35}
TN11MCA8 SLOT-{N}-{1-7,11-18,20-26,29-35}
TN11MR2 SLOT-{N}-{1-8,11-27,29-36}
TN11MR4 SLOT-{N}-{1-8,11-27,29-36}
TN11MR8 SLOT-{N}-{1-7,11-18,20-26,29-35}
TN11MR8V SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11OAU1 SLOT-{N}-{2-8,12-19,21-27,30-36}
TN11OBU1 SLOT-{N}-{1-8,11-27,29-36}
TN11OBU2 SLOT-{N}-{2-8,12-19,21-27,30-36}
TN11RDU9 SLOT-{N}-{1-8,12-27,29-36}
TN11RMU9 SLOT-{N}-{1-8,11-27,29-36}
TN11ROAM SLOT-{N}-{1-6,11-17,20-25,29-34}
TN11ROP SLOT-{N}-{124-127}
TN11SBM2 SLOT-{N}-{1-8,11-27,29-36}
TN11SCS SLOT-{N}-{1-8,11-27,29-36}
TN11TDC SLOT-{N}-{1-8,11-27,29-36}
TN11TMX SLOT-{N}-{1-8,12-27,29-36}
TN11WMU SLOT-{N}-{1-8,11-27,29-36}
AID format Unit type Pattern
TN11WSMD2 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11WSMD4 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN12DCP SLOT-{N}-{1-8,12-27,29-36}
TN12LDX SLOT-{N}-{1-8,12-27,29-36}
TN12LOG SLOT-{N}-{1-8,12-27,29-36}
TN12LOM SLOT-{N}-{1-8,12-27,29-36}
TN12LQMD SLOT-{N}-{1-8,12-27,29-36}
TN12LQMS SLOT-{N}-{1-8,12-27,29-36}
TN12LSX SLOT-{N}-{1-8,12-27,29-36}
TN12LSXL SLOT-{N}-{3-8,14-19,22-27,31-36}
TN12LSXLR SLOT-{N}-{2-8,13-19,21-27,30-36}
TN12LWXS SLOT-{N}-{1-8,12-27,29-36}
TN12OAU1 SLOT-{N}-{2-8,12-19,21-27,30-36}
TN12OBU1 SLOT-{N}-{1-8,11-27,29-36}
TN12OBU2 SLOT-{N}-{2-8,12-19,21-27,30-36}
TN12OLP SLOT-{N}-{1-8,12-27,29-36}
TN12SC1 SLOT-{N}-{1-8,12-27,29-36}
TN12SC2 SLOT-{N}-{1-8,12-27,29-36}
TN12TMX SLOT-{N}-{1-8,12-27,29-36}
TN12VA1 SLOT-{N}-{1-8,12-27,29-36}
TN12VA4 SLOT-{N}-{1-8,12-27,29-36}
TN12WSD9 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN12WSM9 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN13FIU SLOT-{N}-{1-8,12-27,29-36}
TN13LQM SLOT-{N}-{1-8,12-27,29-36}
TN13LSX SLOT-{N}-{1-8,12-27,29-36}
TN13WSD9 SLOT-{N}-{1-6,12-17,20-25,29-34}
TN13WSM9 SLOT-{N}-{1-6,12-17,20-25,29-34}
AID format Unit type Pattern
TN12WSMD2 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN14WSM9 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN52ND2 SLOT-{N}-{1-8,12-27,29-36}
TN52NQ2 SLOT-{N}-{1-8,12-27,29-36}
TN52NS2 SLOT-{N}-{1-8,12-27,29-36}
TN52NS3 SLOT-{N}-{2-8,13-19,21-27,30-36}
TN52TDX SLOT-{N}-{1-8,12-27,29-36}
TN52TOG SLOT-{N}-{1-8,12-27,29-36}
TN52TOM SLOT-{N}-{1-8,12-27,29-36}
TN52TQX SLOT-{N}-{1-8,12-27,29-36}
TN41PIU SLOT-{N}-{39-40,45-46}
TN51AUX SLOT-{N}-{41,43}
TN51EFI1 SLOT-{N}-{38}
TN51EFI2 SLOT-{N}-{37}
TN51FAN SLOT-{N}-{50,51}
TN51SCC SLOT-{N}-{11,28}
TNK2ATE SLOT-{N}-{48}
TN52XCH SLOT-{N}-{9-10}
TN52SCC SLOT-{N}-{11,28}
TN52STG SLOT-{N}-{42,44}
TN11LEM24 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11LEX4 SLOT-{N}-{1-8,12-27,29-36}
TN11OPM8 SLOT-{N}-{1-8,11-27,29-36}
TN54NS3 SLOT-{N}-{1-8,12-27,29-36}
TN53TSXL SLOT-{N}-{1-8,12-27,29-36}
TN53XCH SLOT-{N}-{9-10}
TN54NQ2 SLOT-{N}-{1-8,12-27,29-36}
TN11LSQ SLOT-{N}-{2-8,13-19,21-27,30-36}
AID format Unit type Pattern
TN12WSMD4 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11ST2 SLOT-{N}-{1-8,12-27,29-36}
TN11SFIU SLOT-{N}-{1-8,12-27,29-36}
TN11WSMD9 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11DAS1 SLOT-{N}-{1-8,12-27,29-36}
TN11LSC SLOT-{N}-{4-8,14-19,23-27,32-36}
TN54TOA SLOT-{N}-{1-8,12-27,29-36}
TN53TQX SLOT-{N}-{1-8,12-27,29-36}
TN54TEM28 SLOT-{N}-{1-7,12-18,20-26,29-35}
TN11LTX SLOT-{N}-{2-6,12-17,21-25,30-34}
TN12LSC SLOT-{N}-{1-5,12-16,20-24,29-33}
TN55NS3 SLOT-{N}-{2-8,13-19,21-27,30-36}
TN56NS3 SLOT-{N}-{1-8,12-27,29-36}
TN54TSXL SLOT-{N}-{1-8,12-27,29-36}
TN11RAU1 SLOT-{N}-{2-8,12-19,21-27,30-36}
Table D-96 EQPT 8800 T64 values
AID format Unit type Pattern
TN11CRPC SLOT-{N}-{120-123}
TN11D40 SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN11D40V SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN11DCU SLOT-{N}-{1-8,11-42,45-68}
TN11DMR1 SLOT-{N}-{1-8,11-42,45-68}
TN11GFU SLOT-{N}-{1-8,11-42,45-68}
TN11HBA SLOT-{N}-{2-7,12-17,20-25,28-33,36-41,46-
51,54-59,62-67}
TN11HSC1 SLOT-{N}-{1-8,11-42,45-68}
AID format Unit type Pattern
TN11ITL SLOT-{N}-{1-8,11-42,45-68}
TN11LOG SLOT-{N}-{1-8,11-42,45-68}
TN11LOM SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11LSXR SLOT-{N}-{1-8,11-42,45-68}
TN11M40 SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN11M40V SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN11MCA4 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11MCA8 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11MR2 SLOT-{N}-{1-8,11-42,45-68}
TN11MR4 SLOT-{N}-{1-8,11-42,45-68}
TN11MR8 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11MR8V SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11OAU1 SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN11OBU1 SLOT-{N}-{1-8,11-42,45-68}
TN11OBU2 SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN11RDU9 SLOT-{N}-{1-8,11-42,45-68}
TN11RMU9 SLOT-{N}-{1-8,11-42,45-68}
TN11ROAM SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN11ROP SLOT-{N}-{124-127}
TN11SBM2 SLOT-{N}-{1-8,11-42,45-68}
TN11SCS SLOT-{N}-{1-8,11-42,45-68}
TN11TDC SLOT-{N}-{1-8,11-42,45-68}
TN11TMX SLOT-{N}-{1-8,11-42,45-68}
AID format Unit type Pattern
TN11WMU SLOT-{N}-{1-8,11-42,45-68}
TN11WSMD2 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11WSMD4 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN12DCP SLOT-{N}-{1-8,11-42,45-68}
TN12LDX SLOT-{N}-{1-8,11-42,45-68}
TN12LOG SLOT-{N}-{1-8,11-42,45-68}
TN12LOM SLOT-{N}-{1-8,11-42,45-68}
TN12LQMD SLOT-{N}-{1-8,11-42,45-68}
TN12LQMS SLOT-{N}-{1-8,11-42,45-68}
TN12LSX SLOT-{N}-{1-8,11-42,45-68}
TN12LSXL SLOT-{N}-{3-8,13-18,21-26,29-34,37-42,47-
52,55-60,63-68}
TN12LSXLR SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN12LWXS SLOT-{N}-{1-8,11-42,45-68}
TN12OAU1 SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN12OBU1 SLOT-{N}-{1-8,11-42,45-68}
TN12OBU2 SLOT-{N}-{1-8,11-42,45-68}
TN12OLP SLOT-{N}-{1-8,11-42,45-68}
TN12SC1 SLOT-{N}-{1-8,11-42,45-68}
TN12SC2 SLOT-{N}-{1-8,11-42,45-68}
TN12TMX SLOT-{N}-{1-8,11-42,45-68}
TN12VA1 SLOT-{N}-{1-8,11-42,45-68}
TN12VA4 SLOT-{N}-{1-8,11-42,45-68}
TN12WSD9 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN12WSM9 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
AID format Unit type Pattern
51,53-59,61-67}
TN13FIU SLOT-{N}-{1-8,11-42,45-68}
TN13LQM SLOT-{N}-{1-8,11-42,45-68}
TN13LSX SLOT-{N}-{1-8,11-42,45-68}
TN13WSD9 SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN13WSM9 SLOT-{N}-{1-6,11-16,19-24,27-32,35-40,45-
50,53-58,61-66}
TN12WSMD2 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN14WSM9 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN52ND2 SLOT-{N}-{1-8,11-42,45-68}
TN52NQ2 SLOT-{N}-{1-8,11-42,45-68}
TN52NS2 SLOT-{N}-{1-8,11-42,45-68}
TN52NS3 SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN52TDX SLOT-{N}-{1-8,11-42,45-68}
TN52TOG SLOT-{N}-{1-8,11-42,45-68}
TN52TOM SLOT-{N}-{1-8,11-42,45-68}
TN52TQX SLOT-{N}-{1-8,11-42,45-68}
TN41PIU SLOT-{N}-{69-70,78-81,88-89}
TN51AUX SLOT-{N}-{72-73,83-84}
TN51EFI1 SLOT-{N}-{76}
TN51EFI2 SLOT-{N}-{71}
TN51FAN SLOT-{N}-{90-93}
TNK2XCT SLOT-{N}-{9-10,43-44}
TN52STI SLOT-{N}-{9-10,43-44}
TN11LEM24 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11LEX4 SLOT-{N}-{1-8,11-42,45-68}
AID format Unit type Pattern
TN11OPM8 SLOT-{N}-{1-8,11-42,45-68}
TN54NS3 SLOT-{N}-{1-8,11-42,45-68}
TN53TSXL SLOT-{N}-{1-8,11-42,45-68}
TNK2ATE SLOT-{N}-{87}
TNK2STG SLOT-{N}-{75,86}
TNK2SCC SLOT-{N}-{74,85}
TN11ST2 SLOT-{N}-{1-8,11-42,45-68}
TN54NQ2 SLOT-{N}-{1-8,11-42,45-68}
TN11LSQ SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN12WSMD4 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11SFIU SLOT-{N}-{1-8,11-42,45-68}
TN11WSMD9 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11DAS1 SLOT-{N}-{1-8,11-18,19-26,27-34,35-42,45-
52,53-60,61-68}
TNK2SXH SLOT-{N}-{10,44}
TN11LSC SLOT-{N}-{4-8,14-18,22-26,30-34,38-42,48-
52,56-60,64-68}
TN54TOA SLOT-{N}-{1-8,11-42,45-68}
TN53TQX SLOT-{N}-{1-8,11-42,45-68}
TN54TEM28 SLOT-{N}-{1-7,11-17,19-25,27-33,35-41,45-
51,53-59,61-67}
TN11LTX SLOT-{N}-{2-6,12-16,20-24,28-32,36-40,46-
50,54-58,62-66}
TN12LSC SLOT-{N}-{1-5,11-15,19-23,27-31,35-39,45-
49,53-57,61-65}
TN55NS3 SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
TN56NS3 SLOT-{N}-{1-8,11-42,45-68}
TN54TSXL SLOT-{N}-{1-8,11-42,45-68}
AID format Unit type Pattern
TN11RAU1 SLOT-{N}-{2-8,12-18,20-26,28-34,36-42,46-
52,54-60,62-68}
Table D-97 EQPT 6800A values
AID format Unit type Pattern
TN11OAU1 SLOT-{N}-{2-17}
TN11OBU2
TN12OAU1
TN12OBU2
AID format Unit type Pattern
TN12LSXLR
TN11RAU1
TN11MR8 SLOT-{N}-{1-16}
TN11WSMD4
TN11WSMD2
TN12WSM9
TN12WSD9
TN11MCA4
TN11MCA8
TN11LOM
TN12LQM SLOT-{N}-{1-8,11-16}
TN11LOG
TN12LOG
TN11L4G
TN11LQG
TN12LQMD
TN12LQMS
TN11TOM
TN12NS2
TN11ND2
TN12ND2
TN51NQ2
TN11TBE
TN12TDX
TN12TQM
TN11TQX
TN12LSXL SLOT-{N}-{3-17}
TN11M40 SLOT-{N}-{1-15}
TN11M40V
TN11D40
TN11D40V
TN11ROAM
TN13WSM9
TN13WSD9
TN12WSMD2 SLOT-{N}-{1-16}
TN14WSM9 SLOT-{N}-{1-16}
TN11HBA SLOT-{N}-{2-16}
TN51SCC SLOT-1-{17,18}
TN41PIU SLOT-1-{21,25}
AID format Unit type Pattern
TN51EFI1 SLOT-1-{23}
TN51EFI2 SLOT-1-{22}
TN11ROP SLOT-1-{124-127}
TN11CRPC SLOT-1-{120-123}
TN41ATE SLOT-1-{24}
TN41AUX SLOT-1-{19,20}
TN11FAN SLOT-1-{26}
TN12XCS SLOT-1-{9,10}
TN11LEM24 SLOT-{N}-{1-7,11-16}
TN11LEX4 SLOT-{N}-{1-8,11-17}
TN11OPM8 SLOT-{N}-{1-17}
TN11LSQ SLOT-{N}-{2-8,12-16}
TN55NS3
TN12WSMD4 SLOT-{N}-{1-16}
TN11WSMD9 SLOT-{N}-{1-16}
TN11DAS1 SLOT-{N}-{1-8,11-16}
TN11LSC SLOT-{N}-{4-8,11-16}
TN53TQX SLOT-{N}-{1-8,11-16}
TN11LTX SLOT-{N}-{2-15}
TN12LSC SLOT-{N}-{1-14}
Table D-98 EQPT 3800A values
AID format Unit type Pattern
TN11TMX
TN12TMX
TN11SBM2
TN12DCP
TN12OLP
TN12VA1
TN12VA4
TN11DCU
TN11OBU1
TN12OBU1
TN11GFU
TN11ST2
TN11ACS SLOT-{2-5}
TN11MCA4
TN11MCA8
TN12LQMS
TN12LQMD
TN13LQM
TN11LOG
TN12LOG
TN11L4G
TN11LQG
TN12NS2
TN11TOM
TN12TQM
TN11TBE
TN11MR2
TN11MR4
TN11CMR2
TN11CMR4
TN11DMR1
TN21CMR1 SLOT-{1,8,11}
TN21CMR2
TN21CMR4
TN21MR2
TN21MR4
TN21FIU
TN21DFIU
TN21DMR1
TN11LOM SLOT-{3-5}
TN11OAU1 SLOT-{2-4,11}
AID format Unit type Pattern
TN11OBU2
TN12OAU1
TN12OBU2
TN22SCC SLOT-{8-9}
TN21APIU SLOT-{6-7}
TN61PIU
TN21FIN SLOT-{6-7}
TN61AUX SLOT-{10}
TN22AUX
TN11OPM8 SLOT-{2-5,11}
TN11DAS1 SLOT-{N}-{2-5}
Table D-99 EQPT 8800 T16 values
AID format Unit type Pattern
TN13FIU SLOT-{N}-{1-18}
TN11MR4
TN11MR2
TN11CMR4
TN11CMR2
TN11RMU9
TN11RDU9
TN12SC1
TN12SC2
TN11HSC1
TN12OLP
TN12DCP
TN11SCS
TN12VA1
TN12VA4
TN12OBU1
TN11GFU
TN11ITL
TN11WMU
TN11DCU
TN11TDC
AID format Unit type Pattern
TN12LWXS
TN13LSX
TN12LDX
TN12TMX
TN12LOM
TN11OPM8
TN12WSMD4 SLOT-{N}-{1-7,11-17}
TN11MR8V
TN14WSM9
TN11MCA4
TN11MCA8
TN11WSMD9
TN11LEM24
TN54TEM28
TN12OAU1 SLOT-{N}-{2-8,12-18}
TN12OBU2
TN11LSQ
TN55NS3
TN11RAU1
TN54NQ2 SLOT-{N}-{1-8,11-18}
TN52TOM
TN52ND2
TN52TQX
TN12LOG
TN52TDX
TN52TOG
TN54NS3
TN53TSXL
TN11LEX4
TN11ST2
TN53TQX
TN54TOA
TN11DAS1
TN56NS3
TN54TSXL
TN11HBA SLOT-{N}-{2-7,12-17}
TN41PIU SLOT-{N}-{20,23}
TN41ATE SLOT-{N}-{24}
TN16XCH SLOT-{N}-{9,10}
AID format Unit type Pattern
TN16EFI SLOT-{N}-{19}
TN16FAN SLOT-{N}-{25}
TN16AUX SLOT-{N}-{21,22}
TN11LSC SLOT-{N}-{4-8,14-18}
TN11CRPC SLOT-{N}-{120-123}
TN11ROP SLOT-{N}-{124-127}
TN11LTX SLOT-{N}-{2-6,12-16}
TN12LSC SLOT-{N}-{1-5,11-15}
EQPT-PG
Table D-100 AID 6800A values
AID type AID format Unit type Pattern Notes
FCMOD2
Table D-102 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN52TOM CLNT-{N}-{1-8,12-27,29-
36}-{1}-{1-8}
CLNT-{N}-{1-8,12-27,29-
36}-{2}-{1-8}
CLNT-{N}-{1-8,12-27,29-
36}-{3,5,7}-{1-4}
CLNT-{N}-{1-8,12-27,29-
36}-{4,6,8}-{1-2}
VCLNT-{N}-{1-8,12-27,29-
36}-{1-12}-{1-8}
TN12LOM CLNT-{N}-{1-8,12-27,29-
36}-{1}-{1-8}
TN54TOA CLNT-{N}-{1-8,12-27,29-
36}-{1-8}-{1-8}
TN52TOM CLNT-{N}-{1-8,11-42,45-
68}-{1}-{1-8}
CLNT-{N}-{1-8,11-42,45-
68}-{2}-{1-8}
CLNT-{N}-{1-8,11-42,45-
68}-{3,5,7}-{1-4}
CLNT-{N}-{1-8,11-42,45-
68}-{4,6,8}-{1-2}
VCLNT-{N}-{1-8,11-42,45-
68}-{1-12}-{1-8}
TN12LOM CLNT-{N}-{1-8,11-42,45-
68}-{1}-{1-8}
AID type AID format Unit type Pattern Notes
TN54TOA CLNT-{N}-{1-8,11-42,45-
68}-{1-8}-{1-8}
TN11TOM CLNT-{N}-{1-8,11-16}-{1-
4}-{1-8}
TN11LOM CLNT-{3-5}-1-{1-8}
Table D-106 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
TN12LOM CLNT-{N}-{1-
18}-{1}-{1-8}
TN54TOA CLNT-{N}-{1-
8,11-18}-{1-8}-
{1-8}
FIBER
Table D-107 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN12LSXLR FAC-{N}-{2-8,13-19,21-
27,30-36}-1
TN11LSQ FAC-{N}-{2-8,13-19,21-
27,30-36}-{1,3}
TN11WMU FAC-{N}-{1-8,11-27,29-36}-
TN11DCU {1-2}
AID type AID format Unit type Pattern Notes
TN11GFU
TN12SC2
TN11ST2
TN12LDX FAC-{N}-{1-8,12-27,29-36}-
{1,3,5,6}
TN13LSX FAC-{N}-{1-8,12-27,29-36}-
{1,3}
TN12LSX FAC-{N}-{1-8,12-27,29-36}-
{3-4}
TN12LSXL FAC-{N}-{3-8,14-19,22-
27,31-36}-{1,3}
TN11MR2 FAC-{N}-{1-8,11-27,29-36}-
TN11CMR2 {1-2,4}
TN11MR4 FAC-{N}-{1-8,11-27,29-36}-
TN11MR8 {1-4,6}
TN11CMR4
TN12OLP FAC-{N}-{1-8,12-27,29-36}-
TN11OBU1 {1-3}
TN11OBU2 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1-3}
TN11HBA FAC-{N}-{2-7,13-18,21-
26,30-35}-{1-3}
TN11OBU2 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1-3}
TN12OBU2 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1-5}
TN11MCA4 FAC-{N}-{1-7,11-18,20-
26,29-35}-{1-4}
TN13FIU FAC-{N}-{1-8,12-27,29-36}-
TN11SFIU {1-3}
TN12VA4 FAC-{N}-{1-8,12-27,29-36}-
TN11ITL {1-4}
TN12LQMD FAC-{N}-{1-8,12-27,29-36}-
{1,3-6}
TN12LQMS FAC-{N}-{1-8,12-27,29-36}-
{1-6}
AID type AID format Unit type Pattern Notes
TN11M40 FAC-{N}-{1-6,11-17,20-
TN11D40 25,29-34}-{1-41}
TN11M40V
TN11D40V
TN11TDC FAC-{N}-{1-8,11-27,29-36}-
1
TN11TMX FAC-{N}-{1-8,12-27,29-36}-
TN12TMX {3-6}
TN11DMR1 FAC-{N}-{1-8,12-27,29-36}-
TN12DCP {1-6}
TN11SCS
TN11SBM2
TN11OAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1,4-6}
TN12OAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1,4-8}
TN11MCA8 FAC-{N}-{1-7,11-18,20-
26,29-35}-{1-8}
TN11LOM FAC-{N}-{1-7,12-18,20-
26,29-35}-{3-10}
TN11LOG FAC-{N}-{1-8,12-27,29-36}-
TN12LOG {1,3-10}
TN11WSMD2 FAC-{N}-{1-7,12-18,20-
TN12WSMD2 26,29-35}-{1-6}
TN12WSD9 FAC-{N}-{1-7,12-18,20-
TN12WSM9 26,29-35}-{1-10}
TN11WSMD4
TN12WSMD4
TN13WSD9 FAC-{N}-{1-6,12-17,20-
TN13WSM9 25,29-34}-{1-10}
TN11RMU9 FAC-{N}-{1-8,11-27,29-36}-
{1-11}
TN11ROAM FAC-{N}-{1-6,11-17,20-
25,29-34}-{1-45}
TN52ND2 FAC-{N}-{1-8,12-27,29-36}-
{1-2}
AID type AID format Unit type Pattern Notes
TN52NQ2 FAC-{N}-{1-8,12-27,29-36}-
TN54NQ2 {1-4}
TN52NS2 FAC-{N}-{1-8,12-27,29-36}-
TN56NS3 {1}
TN52TDX FAC-{N}-{1-8,12-27,29-36}-
{3-4}
TN52TQX FAC-{N}-{1-8,12-27,29-36}-
{3-6}
TN52TOM FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN52NS3 FAC-{N}-{2-8,13-19,21-
TN55NS3 27,30-36}-{1}
TN54NS3 FAC-{N}-{1-8,12-27,29-36}-
1
TN52TOG FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN11LEM24 FAC-{N}-{1-7,12-18,20-
26,29-35}-{3-28}
TN11LEX4 FAC-{N}-{1-8,12-27,29-36}-
{3-8}
TN53TSXL FAC-{N}-{1-8,12-27,29-36}-
{3}
TN11OPM8 FAC-{N}-{1-8,11-27,29-36}-
{1-8}
TN53TQX FAC-{N}-{1-8,12-27,29-36}-
{3,4,5,6}
TN54TOA FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN11LSC FAC-{N}-{4-8,14-19,23-
27,32-36}-{1-3}
TN11DAS1 FAC-{N}-{1-8,12-27,29-36}-
{1,3,4,8,9,10,11,12,15,17,18}
TN11WSMD9 FAC-{N}-{1-7,12-18,20-
26,29-35}-{1-22}
TN11LTX FAC-{N}-{2-6,12-17,21-
25,30-34}-{1,3-12}
AID type AID format Unit type Pattern Notes
TN12LSC FAC-{N}-{1-5,12-16,20-
24,29-33}-{1,3}
TN54TSXL FAC-{N}-{1-8,12-27,29-36}-
{3,6}
TN11RAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1,3-5,9-10}
Table D-108 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN12LSXLR FAC-{N}-{2-8,12-18,20-
TN11LSQ 26,28-34,36-42,46-52,54-
60,62-68}-1
TN11WMU FAC-{N}-{1-8,11-42,45-68}-
TN11DCU {1-2}
TN11GFU
TN12SC2
TN11ST2
TN13LSX FAC-{N}-{1-8,11-42,45-68}-
{1,3}
TN12LSX FAC-{N}-{1-8,11-42,45-68}-
{3-4}
TN12LSXL FAC-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-
60,63-68}-{1-2}
TN11MR2 FAC-{N}-{1-8,11-42,45-68}-
TN11CMR2 {1-2,4}
TN11MR4 FAC-{N}-{1-8,11-42,45-68}-
TN11MR8 {1-4,6}
TN11CMR4
TN12OLP FAC-{N}-{1-8,11-42,45-68}-
TN11OBU1 {1-3}
TN11OBU2 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1-3}
TN11HBA FAC-{N}-{2-7,12-17,20-
AID type AID format Unit type Pattern Notes
25,28-33,36-41,46-51,54-
59,62-67}-{1-3}
TN11OBU2 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1-3}
TN12OBU2 FAC-{N}-{1-8,11-42,45-68}-
{1-5}
TN11MCA4 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-4}
TN13FIU FAC-{N}-{1-8,11-42,45-68}-
TN11SFIU {1-3}
TN12VA4 FAC-{N}-{1-8,11-42,45-68}-
TN11ITL {1-4}
TN12LQMD FAC-{N}-{1-8,11-42,45-68}-
{1-6}
TN12LQMS FAC-{N}-{1-8,11-42,45-68}-
{1,3-6}
TN11M40 FAC-{N}-{1-6,11-16,19-
TN11D40 24,27-32,35-40,45-50,53-
TN11M40V 58,61-66}-{1-41}
TN11D40V
TN11TDC FAC-{N}-{1-8,11-42,45-68}-
1
TN11TMX FAC-{N}-{1-8,11-42,45-68}-
TN12TMX {3-6}
TN11DMR1 FAC-{N}-{1-8,11-42,45-68}-
TN12DCP {1-6}
TN11SCS
TN11SBM2
TN11OAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1,4-6}
TN12OAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1,4-8}
TN11MCA8 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
AID type AID format Unit type Pattern Notes
59,61-67}-{1-8}
TN11LOM FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{3-10}
TN11LOG FAC-{N}-{1-8,11-42,45-68}-
TN12LOG {1,3-10}
TN11WSMD2 FAC-{N}-{1-7,11-17,19-
TN12WSMD2 25,27-33,35-41,45-51,53-
59,61-67}-{1-6}
TN12WSD9 FAC-{N}-{1-7,11-17,19-
TN12WSM9 25,27-33,35-41,45-51,53-
TN11WSMD4 59,61-67}-{1-10}
TN12WSMD4
TN13WSD9 FAC-{N}-{1-6,11-16,19-
TN13WSM9 24,27-32,35-40,45-50,53-
58,61-66}-{1-10}
TN11RMU9 FAC-{N}-{1-8,11-42,45-68}-
{1-11}
TN11ROAM FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{1-45}
TN52ND2 FAC-{N}-{1-8,11-42,45-68}-
{1-2}
TN52NQ2 FAC-{N}-{1-8,11-42,45-68}-
TN54NQ2 {1-4}
TN52NS2 FAC-{N}-{1-8,11-42,45-68}-
TN56NS3 {1}
TN52TDX FAC-{N}-{1-8,11-42,45-68}-
{3-4}
TN52TQX FAC-{N}-{1-8,11-42,45-68}-
{3-6}
TN52TOM FAC-{N}-{1-8,11-42,45-68}-
{3-10}
TN52NS3 FAC-{N}-{2-8,12-18,20-
TN55NS3 26,28-34,36-42,46-52,54-
60,62-68}-{1}
TN54NS3 FAC-{N}-{1-8,11-42,45-68}-
AID type AID format Unit type Pattern Notes
TN52TOG FAC-{N}-{1-8,11-42,45-68}-
{3-10}
TN11LEM24 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{3-28}
TN11LEX4 FAC-{N}-{1-8,11-42,45-68}-
{3-8}
TN53TSXL FAC-{N}-{1-8,11-42,45-68}-
{3}
TN11OPM8 FAC-{N}-{1-8,11-42,45-68}-
{1-8}
TN53TQX FAC-{N}-{1-8,11-42,45-68}-
{3,4,5,6}
TN54TOA FAC-{N}-{1-8,11-42,45-68}-
{3-10}
TN11LSC FAC-{N}-{4-8,14-18,22-
26,30-34,38-42,48-52,56-
60,64-68}-{1-3}
TN11DAS1 FAC-{N}-{1-8,11-18,19-
26,27-34,35-42,45-52,53-
60,61-68}-
{1,3,4,8,9,10,11,12,15,17,18}
TN11WSMD9 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-22}
TN11LTX FAC-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}-{1,3-12}
TN12LSC FAC-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}-{1,3}
TN54TSXL FAC-{N}-{1-8,11-42,45-68}-
{3,6}
TN11RAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1,3-5,9-10}
Table D-109 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11NS3 FAC-{N}-{2-8,12-16}-1
TN11TSXL
TN12LSXLR FAC-{N}-{2-17}-1
TN11LSQ
TN12TDX FAC-{N}-{1-8,11-16}-{3-4}
TN11ND2 FAC-{N}-{1-8,11-16}-{1-2}
TN12ND2
TN11WMU FAC-{N}-{1-17}-{1-2}
TN11DCU
TN11GFU
TN12SC2
TN11ST2
TN12LDX FAC-{N}-{1-17}-{1,3,5,6}
TN13LSX FAC-{N}-{1-17}-{1,3}
TN12LSX FAC-{N}-{1-17}-{3-4}
TN12LSXL FAC-{N}-{3-17}-{1-2}
TN11MR2 FAC-{N}-{1-17}-{1-2,4}
TN11CMR2
TN11MR4 FAC-{N}-{1-17}-{1-4,6}
TN11MR8
TN11CMR4
TN12OLP FAC-{N}-{1-17}-{1-3}
TN11OBU1
TN11OBU2 FAC-{N}-{2-17}-{1-3}
TN11HBA FAC-{N}-{2-16}-{1-3}
TN11OBU2 FAC-{N}-{2-17}-{1-3}
TN12OBU2 FAC-{N}-{2-17}-{1-5}
TN51NQ2 FAC-{N}-{1-8,11-16}-{1-4}
AID type AID format Unit type Pattern Notes
TN12TQM FAC-{N}-{1-8,11-16}-{3-6}
TN11TQX
TN11MCA4 FAC-{N}-{1-16}-{1-4}
TN13FIU FAC-{N}-{1-17}-{1-3}
TN11SFIU
TN12VA4 FAC-{N}-{1-17}-{1-4}
TN11ITL
TN12LQMD FAC-{N}-{1-8,11-16}-{1,3-
6}
TN11LQG FAC-{N}-{1-8,11-16}-{1-6}
TN12LQMS
TN11M40 FAC-{N}-{1-15}-{1-41}
TN11D40
TN11M40V
TN11D40V
TN11TDC FAC-{N}-{1-17}-1
TN11TMX FAC-{N}-{1-17}-{3-6}
TN12TMX
TN11DMR1 FAC-{N}-{1-17}-{1-6}
TN12DCP
TN11SCS
TN11SBM2
TN11OAU1 FAC-{N}-{2-17}-{1,4-6}
TN12OAU1 FAC-{N}-{2-17}-{1,4-8}
TN11L4G FAC-{N}-{1-8,11-16}-{1,3-
6}
TN11MCA8 FAC-{N}-{1-16}-{1-8}
TN11TOM FAC-{N}-{1-8,11-16}-{3-
10}
TN11LOM FAC-{N}-{1-16}-{3-10}
TN11TBE FAC-{N}-{1-8,11-16}-{3-
11}
TN11LOG FAC-{N}-{1-8,11-16}-{1,3-
TN12LOG 10}
AID type AID format Unit type Pattern Notes
TN11WSMD2 FAC-{N}-{1-16}-{1-6}
TN12WSMD2
TN12WSD9 FAC-{N}-{1-16}-{1-10}
TN12WSM9
TN11WSMD4
TN12WSMD4
TN13WSD9 FAC-{N}-{1-15}-{1-10}
TN13WSM9
TN11RMU9 FAC-{N}-{1-17}-{1-11}
TN11ROAM FAC-{N}-{1-15}-{1-45}
TN54NS3 FAC-{N}-{1-8,11-16}-1
TN11LEM24 FAC-{N}-{1-7,11-16}-{3-4}
TN11LEX4 FAC-{N}-{1-8,11-17}-{3-4}
TN11OPM8 FAC-{N}-{1-17}-{1-8}
TN53TQX FAC-{N}-{1-8,11-16}-
{3,4,5,6}
TN11LSC FAC-{N}-{4-8,11-16}-{1-3}
TN11DAS1 FAC-{N}-{1-17}-
{1,3,4,8,9,10,11,12,15,17,18}
TN11WSMD9 FAC-{N}-{1-16}-{1-22}
TN11LTX FAC-{N}-{2-15}-{1,3-12}
TN12LSC FAC-{N}-{1-14}-{1,3}
TN55NS3 FAC-{N}-{2-8,12-16}-{1}
TN11RAU1 FAC-{N}-{2-17}-{1,3-5,9-
10}
Table D-110 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12SC2 FAC-{2-5,11}-{1-2}
TN11ST2
TN13LSX FAC-{2-5,11}-{1,3}
AID type AID format Unit type Pattern Notes
TN12LSX FAC-{2-5,11}-{3-4}
TN21FIU FAC-{1,8,11}-{1-3}
TN21DFIU FAC-{1,8,11}-{1-6}
TN11HSC1 FAC-{2-5}-{1}
TN11MR2 FAC-{2-5}-{1-2,4}
TN11CMR2
TN11MR4 FAC-{2-5}-{1-4,6}
TN11CMR4
TN12OLP FAC-{2-5,11}-{1-3}
TN11OBU1
TN11OBU2 FAC-{2-4,11}-{1-3}
TN12OBU1 FAC-{2-5,11}-{1-5}
TN12OBU2 FAC-{2-4,11}-{1-5}
TN12TQM FAC-{2-5}-{3-6}
TN11MCA4 FAC-{2-5}-{1-4}
TN12VA4 FAC-{2-5,11}-{1-4}
TN11TMX FAC-{2-5,11}-{3-6}
TN12TMX
TN11LQG FAC-{2-5}-{1,3-6}
TN12LQMS
TN12LQMD FAC-{2-5}-{1-6}
TN11OAU1
TN12OAU1 FAC-{2-4,11}-{1,4-8}
TN11DMR1 FAC-{2-5}-{1-6}
TN11SBM2 FAC-{2-5,11}-{1-6}
TN12DCP
TN11SCS
TN11L4G FAC-{2-5}-{1,3-6}
TN11MCA8 FAC-{2-5}-{1-8}
TN11TOM FAC-{2-5}-{3-10}
TN11LOM FAC-{3-5}-{1,3-10}
AID type AID format Unit type Pattern Notes
TN11TBE FAC-{2-5}-{3-11}
TN11LOG FAC-{2-5}-{1,3-10}
TN12LOG
TN11LEM24 FAC-{3-5}-{3-4}
TN11LEX4 FAC-{2-5}-{3-4}
TN11OPM8 FAC-{2-5,11}-{1-8}
TN11DAS1 FAC-{2,3,4,5}-
{1,3,4,8,9,10,11,12,15,17,18}
TN11RAU1 FAC-{2-4,11}-{1,3-5,9-10}
Table D-111 AID 8800T16 values
AID type AID format Unit type Pattern Notes
TN11LSQ FAC-{N}-{2-8,12-18}-1
TN11WMU FAC-{N}-{1-18}-{1-2
TN11DCU
TN11GFU
TN12SC2
TN11ST2 FAC-{N}-{1-8,11-18}-{1-2}
TN12LDX FAC-{N}-{1-18}-{1,3,5,6}
TN13LSX FAC-{N}-{1-18}-{1,3}
TN11MR2 FAC-{N}-{1-18}-{1-2,4}
TN11CMR2
TN11MR4 FAC-{N}-{1-18}-{1-4,6}
TN11CMR4
TN12OLP FAC-{N}-{1-18}-{1-3}
TN11HBA FAC-{N}-{2-7,12-17}-{1-3}
TN12OBU2 FAC-{N}-{2-8,12-18}-{1-5}
TN11MCA4 FAC-{N}-{1-7,11-17}-{1-4}
TN13FIU FAC-{N}-{1-18}-{1-3}
AID type AID format Unit type Pattern Notes
TN12VA4 FAC-{N}-{1-18}-{1-4}
TN11ITL
TN11M40 FAC-{N}-{1-6,11-16}-{1-
TN11D40 41}
TN11M40V
TN11TDC FAC-{N}-{1-18}-1
TN12TMX FAC-{N}-{1-18}-{3-6}
TN12DCP FAC-{N}-{1-18}-{1-6}
TN11SCS
TN12OAU1 FAC-{N}-{2-8,12-18}-{1,4-
8}
TN11MCA8 FAC-{N}-{1-7,11-17}-{1-8}
TN12LOG FAC-{N}-{1-8,11-18}-{1,3-
10}
TN12WSMD4 FAC-{N}-{1-7,11-17}-{1-
10}
TN13WSD9 FAC-{N}-{1-6,11-16}-{1-
TN13WSM9 10}
TN11RMU9 FAC-{N}-{1-18}-{1-11}
TN54NS3 FAC-{N}-{1-8,11-18}-1
TN11LEM24 FAC-{N}-{1-7,11-17}-{3-4}
TN11LEX4 FAC-{N}-{1-8,11-18}-{3-4}
TN11OPM8 FAC-{N}-{1-18}-{1-8}
TN53TQX FAC-{N}-{1-8,11-18}-
{3,4,5,6}
TN54TOA FAC-{N}-{1-8,11-18}-{3-
10}
TN11LSC FAC-{N}-{4-8,14-18}-{1-3}
TN11DAS1 FAC-{N}-{1-8,11-18}-
{1,3,4,8,9,10,11,12,15,17,18}
TN11WSMD9 FAC-{N}-{1-7,11-17}-{1-
22}
TN11LTX FAC-{N}-{2-6,12-16}-{1,3-
AID type AID format Unit type Pattern Notes
12}
TN12LSC FAC-{N}-{1-5,11-15}-{1,3}
TN55NS3 FAC-{N}-{2-8,12-18}-{1}
TN56NS3 FAC-{N}-{1-8,11-18}-{1}
TN54TSXL FAC-{N}-{1-8,11-18}-{3,6}
TN11RAU1 FAC-{N}-{2-8,12-18}-{1,3-
5,9-10}
FFP
Table D-112 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-
8,12-27,29-36}-
{5,6}
TN12TMX FAC-{N}-{1-
TN11TMX 8,12-27,29-36}-
{3-6}
TN12LOG FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN11LOG FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN11LOM FAC-{N}-{1-
7,12-18,20-
26,29-35}-{3-
10}
TN12LOM FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN12LSXL FAC-{N}-{3-
AID type AID format Unit type Pattern Notes
8,14-19,22-
27,31-36}-3
TN52TDX FAC-{N}-{1-
8,12-27,29-36}-
{3-4}
TN52TOG FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN52TOM FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN52TQX FAC-{N}-{1-
8,12-27,29-36}-
{3-6}
TN11LEM24 FAC-{N}-{1-
7,12-18,20-
26,29-35}-{5-
28}
TN11LEX4 FAC-{N}-{1-
8,12-27,29-36}-
{5-8}
TN53TSXL FAC-{N}-{1-
8,12-27,29-36}-
{3}
TN11LSQ FAC-{N}-{2-
8,13-19,21-
27,30-36}-{3}
TN54TOA FAC-{N}-{1-
8,12-27,29-36}-
{3–10}
TN53TQX FAC-{N}-{1-
8,12-27,29-36}-
{3–6}
TN54TEM28 FAC-{N}-{1-
7,12-18,20-
26,29-35}-{3-
30}
TN11LTX FAC-{N}-{2-
6,12-17,21-
25,30-34}-{3-
12}
AID type AID format Unit type Pattern Notes
TN54TSXL FAC-{N}-{1-
8,12-27,29-36}-
{3}
TN12LQMS FAC-{N}-{1-
8,12-27,29-36}-
{3-6}
TN13LQM FAC-{N}-{1-
TN12LQMD 8,12-27,29-36}-
{1,3-6}
TN11TMX FAC-{N}-{1-
TN12TMX 8,12-27,29-36}-
{3-6}
TN12LDX FAC-{N}-{1-
8,12-27,29-36}-
{5,6}
TN11LOM FAC-{N}-{1-
7,12-18,20-
26,29-35}-{3-
10}
TN12LOM FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN52TDX FAC-{N}-{1-
8,12-27,29-36}-
{3-4}
TN52TOG FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN52TOM FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN52TQX FAC-{N}-{1-
8,12-27,29-36}-
{3-6}
AID type AID format Unit type Pattern Notes
TN11LEM24 FAC-{N}-{1-
7,12-18,20-
26,29-35}-{5-
28}
TN11LEX4 FAC-{N}-{1-
8,12-27,29-36}-
{5-8}
TN54TOA FAC-{N}-{1-
8,12-27,29-36}-
{3–10}
TN53TQX FAC-{N}-{1-
8,12-27,29-36}-
{3–6}
TN11LTX FAC-{N}-{2-
6,12-17,21-
25,30-34}-{3-
12}
TN54TSXL FAC-{N}-{1-
8,12-27,29-36}-
{3}
TN12LQMS FAC-{N}-{1-
8,12-27,29-36}-
{3-6}
TN13LQM FAC-{N}-{1-
TN12LQMD 8,12-27,29-36}-
{2,3-6}
TN11LSQ FAC-{N}-{2-
8,13-19,21-
27,30-36}-1
TN11TMX FAC-{N}-{1-
TN12TMX 8,12-27,29-36}-
{3-6}
TN12LDX FAC-{N}-{1-
8,12-27,29-36}-
{5,6}
AID type AID format Unit type Pattern Notes
TN11LOM FAC-{N}-{1-
7,12-18,20-
26,29-35}-{3-
10}
TN12LOM FAC-{N}-{1-
8,12-27,29-36}-
{3-10}
TN11LEM24 FAC-{N}-{1-
7,12-18,20-
26,29-35}-{3-4}
TN11LEX4 FAC-{N}-{1-
8,12-27,29-36}-
{3-4}
TN54TOA FAC-{N}-{1-
8,12-27,29-36}-
{3–10}
TN53TQX FAC-{N}-{1-
8,12-27,29-36}-
{3–6}
TN11LTX FAC-{N}-{2-
6,12-17,21-
25,30-34}-{3-
12}
TN54TSXL FAC-{N}-{1-
8,12-27,29-36}-
{3}
TN52NS3 FAC-{N}-{2-
8,13-19,21-
27,30-36}-1
TN12LDX FAC-{N}-{1-
8,12-27,29-36}-
{1,3}
TN11LOM FAC-{N}-{1-
7,12-18,20-
26,29-35}-{1}
TN12LOM FAC-{N}-{1-
8,12-27,29-36}-
{1}
TN11LSQ FAC-{N}-{2-
8,13-19,21-
27,30-36}-1
TN52ND2 FAC-{N}-{1-
8,12-27,29-36}-
{1,2}
TN52NQ2 FAC-{N}-{1-
TN54NQ2 8,12-27,29-36}-
{1-4}
TN52NS2 FAC-{N}-{1-
8,12-27,29-36}-
{1}
TN52NS3 FAC-{N}-{2-
8,13-19,21-
27,30-36}-{1}
TN54NS3 FAC-{N}-{1-
8,12-27,29-36}-
1
TN11LEM24 FAC-{N}-{1-
7,12-18,20-
26,29-35}-{3-4}
TN11LEX4 FAC-{N}-{1-
8,12-27,29-36}-
{3-4}
TN11LTX FAC-{N}-{2-
6,12-17,21-
AID type AID format Unit type Pattern Notes
25,30-34}-{1}
TN12LSC FAC-{N}-{1-
5,12-16,20-
24,29-33}-{1}
TN55NS3 FAC-{N}-{2-
8,13-19,21-
27,30-36}-{1}
TN56NS3 FAC-{N}-{1-
8,12-27,29-36}-
{1}
TN12LDX FAC-{N}-{1-
8,11-42,45-68}-
{5,6}
TN12TMX FAC-{N}-{1-
8,11-42,45-68}-
{3-6}
TN11TMX FAC-{N}-{1-
8,11-42,45-68}-
{3-6}
TN12LOG FAC-{N}-{1-
8,11-42,45-68}-
AID type AID format Unit type Pattern Notes
{3-10}
TN11LOG FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN11LOM FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{3-
10}
TN12LOM FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN12LSXL FAC-{N}-{3-
8,13-18,21-
26,29-34,37-
42,47-52,55-
60,63-68}-3
TN52TDX FAC-{N}-{1-
8,11-42,45-68}-
{3-4}
TN52TOG FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN52TOM FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN52TQX FAC-{N}-{1-
8,11-42,45-68}-
{3-6}
TN11LEM24 FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{5-
28}
TN11LEX4 FAC-{N}-{1-
8,11-42,45-68}-
{5-8}
TN53TSXL FAC-{N}-{1-
8,11-42,45-68}-
{3}
AID type AID format Unit type Pattern Notes
TN11LSQ FAC-{N}-{2-
8,12-18,20-
26,28-34,36-
42,46-52,54-
60,62-68}-{3}
TN54TOA FAC-{N}-{1-
8,11-42,45-68}-
{3–10}
TN53TQX FAC-{N}-{1-
8,11-42,45-68}-
{3–6}
TN54TEM28 FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{3-
30}
TN11LTX FAC-{N}-{2-
6,12-16,20-
24,28-32,36-
40,46-50,54-
58,62-66}-{3-
12}
TN54TSXL FAC-{N}-{1-
8,11-42,45-68}-
{3}
TN12LQMS FAC-{N}-{1-
8,11-42,45-68}-
{3-6}
TN13LQM FAC-{N}-{1-
TN12LQMD 8,11-42,45-68}-
{1,3-6}
TN11TMX FAC-{N}-{1-
TN12TMX 8,11-42,45-68}-
{3-6}
TN12LDX FAC-{N}-{1-
AID type AID format Unit type Pattern Notes
8,11-42,45-68}-
{5,6}
TN11LOM FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{3-
10}
TN12LOM FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN52TDX FAC-{N}-{1-
8,11-42,45-68}-
{3-4}
TN52TOG FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN52TOM FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN52TQX FAC-{N}-{1-
8,11-42,45-68}-
{3-6}
TN11LEM24 FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{5-
28}
TN11LEX4 FAC-{N}-{1-
8,11-42,45-68}-
{5-8}
TN54TOA FAC-{N}-{1-
8,11-42,45-68}-
{3–10}
TN53TQX FAC-{N}-{1-
8,11-42,45-68}-
{3–6}
TN11LTX FAC-{N}-{2-
6,12-16,20-
24,28-32,36-
40,46-50,54-
AID type AID format Unit type Pattern Notes
58,62-66}-{3-
12}
TN54TSXL FAC-{N}-{1-
8,11-42,45-68}-
{3}
TN12LQMS FAC-{N}-{1-
8,11-42,45-68}-
{3-6}
TN13LQM FAC-{N}-{1-
TN12LQMD 8,11-42,45-68}-
{2,3-6}
TN11LSQ FAC-{N}-{2-
8,12-18,20-
26,28-34,36-
42,46-52,54-
60,62-68}-1
TN11TMX FAC-{N}-{1-
TN12TMX 8,11-42,45-68}-
{3-6}
TN12LDX FAC-{N}-{1-
8,11-42,45-68}-
{5,6}
TN11LOM FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{3-
10}
TN12LOM FAC-{N}-{1-
8,11-42,45-68}-
{3-10}
TN11LEM24 FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{3-4}
AID type AID format Unit type Pattern Notes
TN11LEX4 FAC-{N}-{1-
8,11-42,45-68}-
{3-4}
TN54TOA FAC-{N}-{1-
8,11-42,45-68}-
{3–10}
TN53TQX FAC-{N}-{1-
8,11-42,45-68}-
{3–6}
TN11LTX FAC-{N}-{2-
6,12-16,20-
24,28-32,36-
40,46-50,54-
58,62-66}-{3-
12}
TN54TSXL FAC-{N}-{1-
8,11-42,45-68}-
{3}
TN12LSX FAC-{N}-{1-
TN13LSX 8,11-42,45-68}-
{1}
AID type AID format Unit type Pattern Notes
TN52NS3 FAC-{N}-{2-
8,12-18,20-
26,28-34,36-
42,46-52,54-
60,62-68}-1
TN12LDX FAC-{N}-{1-
8,11-42,45-68}-
{1,3}
TN11LOM FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{1}
TN12LOM FAC-{N}-{1-
8,11-42,45-68}-
{1}
TN11LSQ FAC-{N}-{2-
8,12-18,20-
26,28-34,36-
42,46-52,54-
60,62-68}-1
TN52ND2 FAC-{N}-{1-
8,11-42,45-68}-
{1,2}
TN52NQ2 FAC-{N}-{1-
TN54NQ2 8,11-42,45-68}-
{1-4}
TN52NS2 FAC-{N}-{1-
8,11-42,45-68}-
{1}
TN52NS3 FAC-{N}-{2-
8,12-18,20-
26,28-34,36-
42,46-52,54-
60,62-68}-{1}
TN54NS3 FAC-{N}-{1-
8,11-42,45-68}-
1
TN11LEM24 FAC-{N}-{1-
7,11-17,19-
25,27-33,35-
41,45-51,53-
59,61-67}-{3-4}
AID type AID format Unit type Pattern Notes
TN11LEX4 FAC-{N}-{1-
8,11-42,45-68}-
{3-4}
TN11LTX FAC-{N}-{2-
6,12-16,20-
24,28-32,36-
40,46-50,54-
58,62-66}-{1}
TN12LSC FAC-{N}-{1-
5,11-15,19-
23,27-31,35-
39,45-49,53-
57,61-65}-{1}
TN55NS3 FAC-{N}-{2-
8,12-18,20-
26,28-34,36-
42,46-52,54-
60,62-68}-{1}
TN56NS3 FAC-{N}-{1-
8,11-42,45-68}-
{1}
TN12TDX FAC-{N}-{1-
8,11-16}-{3-4}
TN11TSXL FAC-{N}-{2-
8,12-16}-3
TN12LSX FAC-{N}-{1-
TN13LSX 17}-3
TN12LWXS
TN12LDX FAC-{N}-{1-
17}-{1,3,5,6}
TN11L4G FAC-{N}-{1-
8,11-16}-{3-8}
TN12TMX FAC-{N}-{1-
17}-{1,3-6}
TN11TMX FAC-{N}-{1-
17}-{3-6}
TN12LOG FAC-{N}-{1-
8,11-16}-{1,3-
10}
TN11LOG FAC-{N}-{1-
8,11-16}-{3-10}
TN11LOM FAC-{N}-{1-
16}-{3-10}
TN12LOM FAC-{N}-{1-
17}-{1,3-10}
TN11TOM FAC-{N}-{1-
8,11-16}-{3-10}
TN12LSXL FAC-{N}-{3-
17}-3
TN53TQX FAC-{N}-{1-
8,11-16}-{3–6}
TN11LTX FAC-{N}-{2-
15}-{3-12}
TN11TBE FAC-{N}-{1-
8,11-16}-{3-11}
TN12LSX FAC-{N}-{1-
TN13LSX 17}-{3}
TN12LWXS
TN12TDX FAC-{N}-{1-
8,11-16}-{3-4}
TN12TQM FAC-{N}-{1-
TN11TQX 8,11-16}-{3-6}
TN11LQG FAC-{N}-{1-
TN12LQMS 8,11-16}-{3-6}
TN13LQM FAC-{N}-{1-
TN12LQMD 8,11-16}-{1,3-
6}
TN11L4G FAC-{N}-{1-
8,11-16}-{3-8}
TN12LOG FAC-{N}-{1-
8,11-16}-{3-10}
TN11TMX FAC-{N}-{1-
TN12TMX 17}-{3-6}
TN12LDX FAC-{N}-{1-
17}-{5,6}
TN11LOM FAC-{N}-{1-
16}-{3-10}
TN12LOM FAC-{N}-{1-
17}-{3-10}
TN53TQX FAC-{N}-{1-
8,11-16}-{3–6}
TN11LTX FAC-{N}-{2-
15}-{3-12}
TN11TBE FAC-{N}-{1-
8,11-16}-{3-11}
AID type AID format Unit type Pattern Notes
TN12LSX FAC-{N}-{1-
TN13LSX 17}-{3}
TN12LWXS
TN12TDX FAC-{N}-{1-
8,11-16}-{3-4}
TN12TQM FAC-{N}-{1-
TN11TQX 8,11-16}-{3-6}
TN11LQG FAC-{N}-{1-
TN12LQMS 8,11-16}-{3-6}
TN13LQM FAC-{N}-{1-
TN12LQMD 8,11-16}-{2,3-
6}
TN11L4G FAC-{N}-{1-
8,11-16}-{3-8}
TN12LOG FAC-{N}-{1-
8,11-16}-{3-10}
TN11TMX FAC-{N}-{1-
TN12TMX 17}-{3-6}
TN12LDX FAC-{N}-{1-
17}-{5,6}
TN11LOM FAC-{N}-{1-
16}-{3-10}
TN12LOM FAC-{N}-{1-
17}-{3-10}
TN53TQX FAC-{N}-{1-
8,11-16}-{3–6}
TN11LTX FAC-{N}-{2-
15}-{3-12}
TN12LSX FAC-{N}-{1-
TN13LSX 17}-{1}
TN11NS3 FAC-{N}-{2-
8,12-16}-1
TN52NS3 FAC-{N}-{2-
8,12-16}-1
TN11ND2 FAC-{N}-{1-
8,11-16}-{1-2}
TN51NQ2 FAC-{N}-{1-
8,11-16}-{1-4}
TN11LQG FAC-{N}-{1-
8,11-16}-{1}
TN12LDX FAC-{N}-{1-
17}-{1,3}
TN12ND2 FAC-{N}-{1-
8,11-16}-{1,2}
TN11LOM FAC-{N}-{1-
16}-{1}
TN12LOM FAC-{N}-{1-
17}-{1}
TN11LTX FAC-{N}-{2-
15}-{1}
TN12LSC FAC-{N}-{1-
14}-{1}
TN55NS3 FAC-{N}-{2-
8,12-16}-{1}
FAC-N-M-X
Table D-115 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12LSX FAC-{2-5,11}-3
TN13LSX
TN12LWXS
TN12LDX FAC-{2-5,11}-
{1,3,5,6}
TN11L4G FAC-{2-5}-{3-
8}
TN12TMX FAC-{2-5,11}-
{1,3-6}
TN11TMX FAC-{2-5,11}-
{3-6}
TN12LOG FAC-{2-5}-
{1,3-10}
TN11LOG FAC-{2-5}-{3-
10}
TN11LOM FAC-{3-5}-{3-
10}
TN12LOM FAC-{2-5,11}-
{1,3-10}
TN11TOM FAC-{2-5}-{3-
10}
TN11TBE FAC-{2-5}-{3-
AID type AID format Unit type Pattern Notes
11}
TN12LSX FAC-{2-5,11}-
TN13LSX {3}
TN12LWXS
TN12TQM FAC-{2-5}-{3-
6}
TN11LQG FAC-{2-5}-{3-
TN12LQMS 6}
TN13LQM FAC-{2-5}-
TN12LQMD {1,3-6}
TN11L4G FAC-{2-5}-{3-
8}
TN12LOG FAC-{2-5}-{3-
10}
TN11TMX FAC-{2-5,11}-
TN12TMX {3-6}
TN12LDX FAC-{2-5,11}-
{5,6}
TN11LOM FAC-{3-5}-{3-
10}
TN12LOM FAC-{2-5,11}-
{3-10}
TN11TBE FAC-{2-5}-{3-
11}
TN12LSX FAC-{2-5,11}-
TN13LSX {3}
TN12LWXS
TN12TQM FAC-{2-5}-{3-
6}
TN11LQG FAC-{2-5}-{3-
TN12LQMS 6}
AID type AID format Unit type Pattern Notes
TN13LQM FAC-{2-5}-
TN12LQMD {2,3-6}
TN11L4G FAC-{2-5}-{3-
8}
TN12LOG FAC-{2-5}-{3-
10}
TN11TMX FAC-{2-5,11}-
TN12TMX {3-6}
TN12LDX FAC-{2-5,11}-
{5,6}
TN11LOM FAC-{3-5}-{3-
10}
TN12LOM FAC-{2-5,11}-
{3-10}
TN11LQG FAC-{2-5}-{1}
TN12LDX FAC-{2-5,11}-
{1,3}
TN11LOM FAC-{3-5}-{1}
TN12LOM FAC-{2-5,11}-
{1}
TN12TMX FAC-{N}-{1-
18}-{3-6}
TN12LOG FAC-{N}-{1-
8,11-18}-{3-10}
TN12LOM FAC-{N}-{1-
18}-{3-10}
TN52TDX FAC-{N}-{1-
8,11-18}-{3-4}
TN52TOG FAC-{N}-{1-
8,11-18}-{3-10}
TN52TOM FAC-{N}-{1-
8,11-18}-{3-10}
TN52TQX FAC-{N}-{1-
8,11-18}-{3-6}
TN11LEM24 FAC-{N}-{1-
7,11-17}-{5-28}
TN11LEX4 FAC-{N}-{1-
8,11-18}-{5-8}
TN53TSXL FAC-{N}-{1-
8,11-18}-{3}
TN11LSQ FAC-{N}-{2-
8,12-18}-{3}
TN54TOA FAC-{N}-{1-
8,11-18}-{3–
10}
TN53TQX FAC-{N}-{1-
8,11-18}-{3–6}
TN54TEM28 FAC-{N}-{1-
7,11-17}-{3-30}
TN11LTX FAC-{N}-{2-
6,12-16}-{3-12}
TN54TSXL FAC-{N}-{1-
8,11-18}-{3}
AID type AID format Unit type Pattern Notes
TN12TMX FAC-{N}-{1-
18}-{3-6}
TN12LDX FAC-{N}-{1-
18}-{5,6}
TN12LOM FAC-{N}-{1-
18}-{3-10}
TN52TDX FAC-{N}-{1-
8,11-18}-{3-4}
TN52TOG FAC-{N}-{1-
8,11-18}-{3-10}
TN52TOM FAC-{N}-{1-
8,11-18}-{3-10}
TN52TQX FAC-{N}-{1-
8,11-18}-{3-6}
TN11LEM24 FAC-{N}-{1-
7,11-17}-{5-28}
TN11LEX4 FAC-{N}-{1-
8,11-18}-{5-8}
TN54TOA FAC-{N}-{1-
8,11-18}-{3–
10}
TN53TQX FAC-{N}-{1-
8,11-18}-{3–6}
TN11LTX FAC-{N}-{2-
6,12-16}-{3-12}
TN54TSXL FAC-{N}-{1-
8,11-18}-{3}
TN11LSQ FAC-{N}-{2-
AID type AID format Unit type Pattern Notes
8,12-18}-1
TN12TMX FAC-{N}-{1-
18}-{3-6}
TN12LDX FAC-{N}-{1-
18}-{5,6}
TN12LOM FAC-{N}-{1-
18}-{3-10}
TN52TDX FAC-{N}-{1-
8,12-27,29-36}-
{3-4}
TN52TOG FAC-{N}-{1-
8,11-18}-{3-10}
TN52TOM FAC-{N}-{1-
8,11-18}-{3-10}
TN52TQX FAC-{N}-{1-
8,11-18}-{3-6}
TN11LEM24 FAC-{N}-{1-
7,11-17}-{3-4}
TN11LEX4 FAC-{N}-{1-
8,11-18}-{3-4}
TN54TOA FAC-{N}-{1-
8,11-18}-{3–
10}
TN53TQX FAC-{N}-{1-
8,11-18}-{3–6}
TN11LTX FAC-{N}-{2-
6,12-16}-{3-12}
TN54TSXL FAC-{N}-{1-
8,11-18}-{3}
TN12LOM FAC-{N}-{1-
18}-{1}
TN11LSQ FAC-{N}-{2-
8,12-18}-1
TN52ND2 FAC-{N}-{1-
8,11-18}-{1,2}
TN52NQ2 FAC-{N}-{1-
TN54NQ2 8,11-18}-{1-4}
TN52NS2 FAC-{N}-{1-
8,11-18}-{1}
TN54NS3 FAC-{N}-{1-
8,11-18}-1
TN11LEM24 FAC-{N}-{1-
7,11-17}-{3-4}
TN11LEX4 FAC-{N}-{1-
8,11-18}-{3-4}
TN11LTX FAC-{N}-{2-
6,12-16}-{1}
TN12LSC FAC-{N}-{1-
5,11-15}-{1}
TN55NS3 FAC-{N}-{2-
8,12-18}-{1}
TN56NS3 FAC-{N}-{1-
8,11-18}-{1}
TN11LSXR SLOT-{N}-{1-8,12-27,29-
TN12LWXS 36}
TN12LOM
TN12LSX SLOT-{N}-{1-8,12-27,29-
TN13LSX 36}
TN53TSXL SLOT-{N}-{1-8,12-27,29-
36}
TN11TMX SLOT-{N}-{1-8,12-27,29-
TN12TMX 36}
TN52TOG SLOT-{N}-{1-8,12-27,29-
36}
TN12SC1 SLOT-{N}-{1-8,12-27,29-
36}
TN12SC2 SLOT-{N}-{1-8,12-27,29-
36}
TN11ST2 SLOT-{N}-{1-8,12-27,29-
36}
TN11HSC1 SLOT-{N}-{1-8,12-27,29-
36}
TN11LEM24 SLOT-{N}-{1-7,12-18,20-
26,29-35}
TN11LEX4 SLOT-{N}-{1-8,12-19,20-
27,29-36}
TN12LSXL SLOT-{N}-{3-8,14-19,22-
27,31-36}
TN12LSXLR SLOT-{N}-{2-8,13-19,21-
27,30-36}
TN52TOM SLOT-{N}-{1-8,12-27,29-
36}
TN52NS3 SLOT-{N}-{2-8,13-19,21-
AID type AID format Unit type Pattern Notes
27,30-36}
TN52ND2 SLOT-{N}-{1-8,12-27,29-
36}
TN52NQ2 SLOT-{N}-{1-8,12-27,29-
TN54NQ2 36}
TN52NS2 SLOT-{N}-{1-8,12-27,29-
TN54NS3 36}
TN12LQMS SLOT-{N}-{1-8,12-27,29-
TN13LQMD 36}
TN12LQMD
TN52TOM SLOT-{N}-{1-8,12-27,29-
36}
TN11LTX SLOT-{N}-{2-6,12-17,21-
25,30-34}
TN55NS3 SLOT-{N}-{2-8,13-19,21-
27,30-36}
TN56NS3 SLOT-{N}-{1-8,12-27,29-
36}
TN12LSC SLOT-{N}-{1-5,12-16,20-
24,29-33}
TN11LSXR FAC-{N}-{1-8,12-27,29-
TN12LWXS 36}-1
TN12LOM
TN12LSX FAC-{N}-{1-8,12-27,29-
TN13LSX 36}-{1,3}
TN53TSXL FAC-{N}-{1-8,12-27,29-
36}-3
TN11TMX FAC-{N}-{1-8,12-27,29-
TN12TMX 36}-{1,3-6}
TN52TOG FAC-{N}-{1-8,12-27,29-
36}-{3-10}
AID type AID format Unit type Pattern Notes
TN11LTX FAC-{N}-{2-6,12-17,21-
25,30-34}-{1}
TN55NS3 FAC-{N}-{2-8,13-19,21-
27,30-36}-{1}
TN56NS3 FAC-{N}-{1-8,12-27,29-
36}-{1}
TN12LSC FAC-{N}-{1-5,12-16,20-
24,29-33}-{1}
TN11ST2 DCC-{N}-{1-8,12-27,29-
36}-{1-2}
TN11HSC1 DCC-{N}-{1-8,12-27,29-
36}-1
TN12LSXL SRV1-{N}-{3-8,14-19,22-
27,31-36}-1
TN12LSXLR SRV1-{N}-{2-8,13-19,21-
27,30-36}-1
TN52NS2 SRV3-{N}-{1-8,12-27,29-
TN54NS3 36}-1
CLNT-N-M-X TN12LQMD
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{1,3,5,7}
Table D-118 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11LSXR SLOT-{N}-{1-8,11-42,45-
TN12LWXS 68}
TN12LOM
TN12LSX SLOT-{N}-{1-8,11-42,45-
TN13LSX 68}
TN53TSXL SLOT-{N}-{1-8,11-42,45-
68}
TN11TMX SLOT-{N}-{1-8,11-42,45-
TN12TMX 68}
TN52TOG SLOT-{N}-{1-8,11-42,45-
68}
TN12SC1 SLOT-{N}-{1-8,11-42,45-
68}
TN12SC2 SLOT-{N}-{1-8,11-42,45-
68}
TN11ST2 SLOT-{N}-{1-8,11-42,45-
68}
TN11HSC1 SLOT-{N}-{1-8,11-42,45-
68}
TN11LEM24 SLOT-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}
TN11LEX4 SLOT-{N}-{1-8,11-42,45-
68}
TN12LSXL SLOT-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-
60,63-68}
AID type AID format Unit type Pattern Notes
TN12LSXLR SLOT-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}
TN52TOM SLOT-{N}-{1-8,11-42,45-
68}
TN52NS3 SLOT-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}
TN52ND2 SLOT-{N}-{1-8,11-42,45-
68}
TN52NQ2 SLOT-{N}-{1-8,11-42,45-
TN54NQ2 68}
TN52NS2 SLOT-{N}-{1-8,11-42,45-
TN54NS3 68}
TN12LQMS SLOT-{N}-{1-8,11-42,45-
TN13LQMD 68}
TN12LQMD
TN52TOM SLOT-{N}-{1-8,11-42,45-
68}
TN11LTX SLOT-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}
TN55NS3 SLOT-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}
TN56NS3 SLOT-{N}-{1-8,11-42,45-
68}
TN12LSC SLOT-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}
TN11LSXR FAC-{N}-{1-8,11-42,45-
TN12LWXS 68}-1
TN12LOM
AID type AID format Unit type Pattern Notes
TN12LSX FAC-{N}-{1-8,11-42,45-
TN13LSX 68}-{1,3}
TN53TSXL FAC-{N}-{1-8,11-42,45-
68}-3
TN11TMX FAC-{N}-{1-8,11-42,45-
TN12TMX 68}-{1,3-6}
TN52TOG FAC-{N}-{1-8,11-42,45-
68}-{3-10}
TN11LTX FAC-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}-{1}
TN55NS3 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1}
TN56NS3 FAC-{N}-{1-8,11-42,45-
68}-{1}
TN12LSC FAC-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}-{1}
TN11ST2 DCC-{N}-{1-8,11-42,45-
68}-{1-2}
TN11HSC1 DCC-{N}-{1-8,11-42,45-
68}-1
TN11LEX4 SRV1-{N}-{1-8,11-42,45-
68}-{1-4}
TN12LSXL SRV1-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-
60,63-68}-1
TN12LSXLR SRV1-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-1
AID type AID format Unit type Pattern Notes
TN52NS2 SRV3-{N}-{1-8,11-42,45-
TN54NS3 68}-1
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{1,3,5,7}
Table D-119 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11LOM SLOT-{N}-{1-16}
TN12LOM SLOT-{N}-{1-17}
TN11LSXR SLOT-{N}-{1-17}
TN12LWXS
TN11ND2 SLOT-{N}-{1-8,11-16}
TN12ND2
TN12LSX SLOT-{N}-{1-17}
TN13LSX
TN51NQ2 SLOT-{N}-{1-8,11-16}
TN11TMX SLOT-{N}-{1-17}
TN12TMX
TN12SC1 SLOT-{N}-{1-17}
TN12SC2 SLOT-{N}-{1-17}
AID type AID format Unit type Pattern Notes
TN11ST2 SLOT-{N}-{1-17}
TN11HSC1 SLOT-{N}-{1-17}
TN52TOM SLOT-{N}-{1-8,11-16}
TN52NS2 SLOT-{N}-{1-8,11-16}
TN54NS3
TN12TQM SLOT-{N}-{1-8,11-16}
TN11LQG
TN12LQMS
TN12LQMD
TN13LQM
TN52TOM SLOT-{N}-{1-8,11-16}
TN11TOM SLOT-{N}-{1-8,11-16}
TN11LTX SLOT-{N}-{2-15}
TN55NS3 SLOT-{N}-{2-8,12-16}
TN12LSC SLOT-{N}-{1-14}
TN11LOM FAC-{N}-{1-16}-1
TN12LOM FAC-{N}-{1-17}-1
TN11LSXR FAC-{N}-{1-17}-1
TN12LWXS
TN11ND2 FAC-{N}-{1-8,11-16}-{1-
TN12ND2 2}
TN12LSX FAC-{N}-{1-17}-{1,3}
TN13LSX
TN51NQ2 FAC-{N}-{1-8,11-16}-{1-
4}
TN11TMX FAC-{N}-{1-17}-{1,3-6}
TN12TMX
TN11LTX FAC-{N}-{2-15}-{1}
TN55NS3 FAC-{N}-{2-8,12-16}-
AID type AID format Unit type Pattern Notes
{1}
TN12LSC FAC-{N}-{1-14}-{1}
TN11ST2 DCC-{N}-{1-17}-{1-2}
TN11HSC1 DCC-{N}-{1-17}-1
TN52TOM CLNT-{N}-{1-8,11-16}-
{1,3,5,7}
TN11TOM CLNT-{N}-{1-8,11-16}-
{1-4}
Table D-120 AID 3800A values
AID type AID format Unit type Pattern Notes
TN11LOM SLOT-{3-5}
TN12LOM SLOT-{11,2-5}
TN12LSX SLOT-{2-5,11}
TN13LSX
TN11TMX SLOT-{2-5,11}
AID type AID format Unit type Pattern Notes
TN12TMX
TN12SC1 SLOT-{2-5,11}
TN12SC2 SLOT-{2-5,11}
TN11ST2 SLOT-{2-5,11}
TN11HSC1 SLOT-{2-5,11}
TN52TOM SLOT-{2-5}
TN52NS2 SLOT-{2-5,11}
TN12TQM SLOT-{2-5}
TN11LQG
TN12LQMS
TN12LQMD
TN13LQM
TN52TOM SLOT-{2-5}}
TN11TOM SLOT-{2-5}
TN11LOM FAC-{3-5}-1
TN12LOM FAC-{11,2-5}-1
TN12LSX FAC-{2-5,11}-{1-3}
TN13LSX
TN11TMX FAC-{2-5,11}-{1,3-6}
TN12TMX
TN11ST2 DCC-{2-5,11}-{1-2}
TN11HSC1 DCC-{2-5,11}-1
SRV2-M-X
TN52TOM CLNT-{2-5}-{1,3,5,7}
TN11TOM CLNT-{2-5}-{1-4}
IPA
The detection unit.
The format is: FAC-<SHELF>-<SLOT>-<PORT>
Table D-121 DECT / OPRT / ASTDECT 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11OBU2 FAC-{N}-{2-8,12-
TN12OBU2 19,21-27,30-36}-2
TN11HBA FAC-{N}-{2-7,13-
18,21-26,30-35}-2
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{N}-{1-8,12-
27,29-36}-{9,16}
TN11RAU1 FAC-{N}-{2-8,12-
19,21-27,30-36}-{4}
TN12LDX FAC-{N}-{1-8,12-
27,29-36}-{1,3}
TN11LOM FAC-{N}-{1-7,12-
18,20-26,29-35}-1
TN11LOG FAC-{N}-{1-8,12-
TN12LOG 27,29-36}-1
TN12LQMS
TN12LWXS
TN11TMX
TN12TMX
TN12LSX
TN13LSX
TN11LSXR
TN12SC1
TN11HSC1
TN12LOM
TN12SC2 FAC-{N}-{1-8,12-
TN11ST2 27,29-36}-{1,2}
TN12LQMD FAC-{N}-{1-8,12-
TN11ND2 27,29-36}-{1,2}
TN12ND2
TN52NQ2 FAC-{N}-{1-8,12-
TN54NQ2 27,29-36}-{1-4}
TN52ND2 FAC-{N}-{1-8,12-
27,29-36}-{1-2}
TN52NS2 FAC-{N}-{1-8,12-
27,29-36}-1
TN52TOM FAC-{N}-{1-8,12-
27,29-36}-{3-10}
TN52NS3 FAC-{N}-{2-8,13-
AID type AID format Unit type Pattern Notes
19,21-27,30-36}-1
TN54NS3 FAC-{N}-{1-8,12-
27,29-36}-1
TN11LEM24 FAC-{N}-{1-7,12-
18,20-26,29-35}-{3-4}
TN11LEX4 FAC-{N}-{1-8,12-
27,29-36}-{3-4}
TN11DAS1 FAC-{N}-{1-8,12-
27,29-36}-4
TN11LSC FAC-{N}-{4-8,14-
19,23-27,32-36}-{1,2}
TN11LTX FAC-{N}-{2-6,12-
17,21-25,30-34}-{1}
TN12LSC FAC-{N}-{1-5,12-
16,20-24,29-33}-{1}
TN55NS3 FAC-{N}-{2-8,13-
19,21-27,30-36}-{1}
TN56NS3 FAC-{N}-{1-8,12-
27,29-36}-{1}
Table D-122 DECT / OPRT / ASTDECT 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11RAU1 FAC-{N}-{2-8,12-
18,20-26,28-34,36-
42,46-52,54-60,62-68}-
{1}
AID type AID format Unit type Pattern Notes
TN11OBU2 FAC-{N}-{2-8,12-
TN12OBU2 18,20-26,28-34,36-
42,46-52,54-60,62-68}-2
TN11HBA FAC-{N}-{2-7,12-
17,20-25,28-33,36-
41,46-51,54-59,62-67}-2
TN11DAS1 FAC-{N}-{1-8,11-
18,19-26,27-34,35-
42,45-52,53-60,61-68}-
{9,16}
TN11RAU1 FAC-{N}-{2-8,12-
18,20-26,28-34,36-
42,46-52,54-60,62-68}-
{4}
TN12LDX FAC-{N}-{1-8,11-
42,45-68}-{1,3}
TN11LOM FAC-{N}-{1-7,11-
17,19-25,27-33,35-
41,45-51,53-59,61-67}-1
TN11LOG FAC-{N}-{1-8,11-
TN12LOG 42,45-68}-1
TN12LQMS
TN11TMX
TN12TMX
TN12LSX
TN13LSX
TN11LSXR
TN12SC1
TN11HSC1
TN12LWXS
AID type AID format Unit type Pattern Notes
TN12LOM
TN12SC2 FAC-{N}-{1-8,11-
TN11ST2 42,45-68}-{1,2}
TN12LQMD FAC-{N}-{1-8,11-
TN11ND2 42,45-68}-{1,2}
TN12ND2
TN52ND2 FAC-{N}-{1-8,11-
42,45-68}-{1-2}
TN52NQ2 FAC-{N}-{1-8,11-
TN54NQ2 42,45-68}-{1-4}
TN52NS2 FAC-{N}-{1-8,11-
42,45-68}-1
TN52TOM FAC-{N}-{1-8,11-
42,45-68}-{3-10}
TN52NS3 FAC-{N}-{2-8,12-
18,20-26,28-34,36-
42,46-52,54-60,62-68}-1
TN54NS3 FAC-{N}-{1-8,11-
42,45-68}-1
TN11LEM24 FAC-{N}-{1-7,11-
17,19-25,27-33,35-
41,45-51,53-59,61-67}-
{3-4}
TN11LEX4 FAC-{N}-{1-8,11-
42,45-68}-{3-4}
TN11DAS1 FAC-{N}-{1-8,11-
18,19-26,27-34,35-
42,45-52,53-60,61-68}-4
TN11LSC FAC-{N}-{4-8,14-
18,22-26,30-34,38-
42,48-52,56-60,64-68}-
{1,2}
TN11LTX FAC-{N}-{2-6,12-
16,20-24,28-32,36-
40,46-50,54-58,62-66}-
{1}
TN12LSC FAC-{N}-{1-5,11-
15,19-23,27-31,35-
39,45-49,53-57,61-65}-
AID type AID format Unit type Pattern Notes
{1}
TN55NS3 FAC-{N}-{2-8,12-
18,20-26,28-34,36-
42,46-52,54-60,62-68}-
{1}
TN56NS3 FAC-{N}-{1-8,11-
42,45-68}-{1}
Table D-123 DECT / OPRT / ASTDECT 6800A values
AID type AID format Unit type Pattern Notes
TN11OBU2 FAC-{N}-{2-17}-2
TN12OBU2
TN11HBA FAC-{N}-{2-16}-2
TN11DAS1 FAC-{N}-{1-17}-{9,16}
TN11RAU1 FAC-{N}-{2-17}-{4}
TN12LSXLR FAC-{N}-{2-17}-1
TN12NS2 FAC-{N}-{1-8,11-16}-1
TN11L4G
TN11LOG
AID type AID format Unit type Pattern Notes
TN12LOG
TN12LQMS
TN11LQG
TN12LDX FAC-{N}-{1-17}-{1,3}
TN11LOM FAC-{N}-{1-16}-1
TN11TMX FAC-{N}-{1-17}-1
TN12TMX
TN12LSX
TN13LSX
TN11LSXR
TN12SC1
TN11HSC1
TN12LWXS
TN12LOM
TN12SC2 FAC-{N}-{1-17}-{1,2}
TN11ST2
TN12LQMD FAC-{N}-{1-8,11-16}-
TN11ND2 {1,2}
TN12ND2
TN11TOM FAC-{N}-{1-8,11-16}-
{3-10}
TN51NQ2 FAC-{N}-{1-8,11-16}-
TN52NQ2 {1-4}
TN54NS3 FAC-{N}-{1-8,11-16}-1
TN11LEM24 FAC-{N}-{1-7,11-16}-
{3-4}
TN11LEX4 FAC-{N}-{1-8,11-17}-
{3-4}
TN11DAS1 FAC-{N}-{1-17}-4
TN11LSC FAC-{N}-{4-8,11-16}-
{1,2}
TN11LTX FAC-{N}-{2-15}-{1}
TN12LSC FAC-{N}-{1-14}-{1}
TN55NS3 FAC-{N}-{2-8,12-16}-
{1}
Table D-124 DECT / OPRT / ASTDECT 3800A values
AID type AID format Unit type Pattern Notes
TN11OBU2 FAC-{2-4,11}-2
TN12OBU2
TN11DAS1 FAC-{N}-{2,3,4,5}-{9,16}
TN11RAU1 FAC-{N}-{2-4,11}-{4}
TN11TMX FAC-{2-5,11}-1
TN12TMX
TN12LSX
TN13LSX
TN11LSXR
TN12SC1
TN12LWXS
TN12LOM
TN12LDX FAC-{2-5,11}-{1,3}
TN12SC2 FAC-{2-5,11}-{1,2}
TN11LOM FAC-{3-5}-1
TN12LQMD FAC-{2-5}-{1,2}
TN11TOM FAC-{2-5}-{3-10}
AID type AID format Unit type Pattern Notes
TN11LEM24 FAC-{3-5}-{3-4}
TN11LEX4 FAC-{2-5}-{3-4}
TN11DAS1 FAC-{N}-{2,3,4,5}-4
Table D-125 DECT / OPRT / ASTDECT 8800T16 values
AID type AID format Unit type Pattern Notes
TN12OBU2 FAC-{N}-{2-8,12-18}-2
TN11HBA FAC-{N}-{2-7,12-17}-2
TN11DAS1 FAC-{N}-{1-8,11-18}-
{9,16}
TN11RAU1 FAC-{N}-{2-8,12-18}-
{4}
TN12TMX FAC-{N}-{1-18}-1
TN13LSX
TN12SC1
TN11HSC1
TN12LWXS
TN12LOM
TN12SC2 FAC-{N}-{1-18}-{1,2}
TN11ST2 FAC-{N}-{1-8,11-18}-
{1,2}
AID type AID format Unit type Pattern Notes
TN54NS3 FAC-{N}-{1-8,11-18}-1
TN11LEM24 FAC-{N}-{1-7,11-17}-{3-
4}
TN11LEX4 FAC-{N}-{1-8,11-18}-{3-
4}
TN11DAS1 FAC-{N}-{1-8,11-18}-4
TN11LSC FAC-{N}-{4-8,14-18}-
{1,2}
TN11LTX FAC-{N}-{2-6,12-16}-
{1}
TN12LSC FAC-{N}-{1-5,11-15}-
{1}
TN55NS3 FAC-{N}-{2-8,12-18}-
{1}
TN56NS3 FAC-{N}-{1-8,11-18}-
{1}
LPT
Table D-126 AID 8800T32 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{XXX}-{5-
6}
TN12LOG FAC-{N}-{XXX}-{3-
10}
TN12LOM FAC-{N}-{XXX}-{3-
10}
TN12LQMD FAC-{N}-{XXX}-{3-
6}
TN12LQMS FAC-{N}-{XXX}-{3-
6}
TN12LSX FAC-{N}-{XXX}-{3}
AID type AID format Unit type Pattern Notes
TN13LQM FAC-{N}-{XXX}-{3-
6}
TN13LSX FAC-{N}-{XXX}-{3}
TN52TDX FAC-{N}-{XXX}-{3-
4}
TN52TOM FAC-{N}-{XXX}-{3-
10}
TN52TQX FAC-{N}-{XXX}-{3-
6}
TN11LEX4 FAC-{N}-{XXX}-{5-
8}
TN11LEM24 FAC-{N}-{XXX}-{5-
28}
TN11LSC FAX-{N}-{XXX}-{3}
TN54TOA FAX-{N}-{XXX}-{3–
10}
TN53TQX FAX-{N}-{XXX}-{3–
6}
TN54TEM28 FAX-{N}-{XXX}-{3–
30}
TN11LTX FAC-{N}-{XXX}-{3-
12}
Table D-127 AID 8800T64 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{XXX}-{5-
6}
TN12LOG FAC-{N}-{XXX}-{3-
10}
TN12LOM FAC-{N}-{XXX}-{3-
10}
TN12LQMD FAC-{N}-{XXX}-{3-
6}
AID type AID format Unit type Pattern Notes
TN12LQMS FAC-{N}-{XXX}-{3-
6}
TN12LSX FAC-{N}-{XXX}-{3}
TN13LQM FAC-{N}-{XXX}-{3-
6}
TN13LSX FAC-{N}-{XXX}-{3}
TN52TDX FAC-{N}-{XXX}-{3-
4}
TN52TOM FAC-{N}-{XXX}-{3-
10}
TN52TQX FAC-{N}-{XXX}-{3-
6}
TN11LEX4 FAC-{N}-{XXX}-{5-
8}
TN11LEM24 FAC-{N}-{XXX}-{5-
28}
TN11LSC FAX-{N}-{XXX}-{3}
TN54TOA FAX-{N}-{XXX}-{3–
10}
TN53TQX FAX-{N}-{XXX}-{3–
6}
TN54TEM28 FAX-{N}-{XXX}-{3–
30}
TN11LTX FAX-{N}-{XXX}-{3–
12}
Table D-128 AID 6800A values
AID type AID format Unit type Pattern Notes
8,11-16}-{3-4}
TN12LSXL FAC-{N}-{3-17}-3
TN12LSX FAC-{N}-{1-17}-3
TN13LSX
TN11L4G FAC-{N}-{1-8,11-16}-
{3-8}
TN11LOM FAC-{N}-{1-16}-{3-
10}
TN12LDX FAC-{N}-{1-17}-{5,6}
TN11TOM FAC-{N}-{1-8,11-16}-
TN11LOG {3-10}
TN12LOG
TN11LEX4 FAC-{N}-{1-8,11-17}-
{5-8}
TN11LEM24 FAC-{N}-{1-7,11-16}-
{5-28}
TN11LSC FAX-{N}-{XXX}-{3}
TN53TQX FAX-{N}-{XXX}-{3–
6}
TN11LTX FAX-{N}-{XXX}-{3–
12}
Table D-129 AID 3800A values
AID type AID format Unit type Pattern Notes
TN11TBE FAC-{2-5}-{3-11}
TN12LSX FAC-{2-5,11}-3
TN13LSX
TN11L4G FAC-{2-5}-{3-8}
TN11LOM FAC-{3-5}-{3-10}
TN12LDX FAC-{2-5,11}-{5,6}
AID type AID format Unit type Pattern Notes
TN11TOM FAC-{2-5}-{3-10}
TN11LEX4 FAC-{N}-{2-5}-{5-8}
TN11LEM24 FAC-{N}-{3-5}-{5-28}
Table D-130 AID 8800T16 values
AID type AID format Unit type Pattern Notes
TN12LOM FAC-{N}-{XXX}-{3-
10}
TN13LSX FAC-{N}-{XXX}-{3}
TN52TDX FAC-{N}-{XXX}-{3-
4}
TN52TOM FAC-{N}-{XXX}-{3-
10}
TN52TQX FAC-{N}-{XXX}-{3-
6}
TN11LEX4 FAC-{N}-{XXX}-{5-
8}
TN11LEM24 FAC-{N}-{XXX}-{5-
28}
TN11LSC FAX-{N}-{XXX}-{3}
TN54TOA FAX-{N}-{XXX}-{3–
10}
TN53TQX FAX-{N}-{XXX}-{3–
6}
TN54TEM28 FAX-{N}-{XXX}-{3–
30}
TN11LTX FAX-{N}-{XXX}-{3–
12}
MCA
Table D-131 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11OPM8 FAC-{N}-{1-8,11-42,45-
68}-{1-8}-{all,1-80}
Table D-133 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11OPM8 FAC-{N}-{1-18}-{1-8}-
{all,1-80}
FAC-N-M-X-Y MCADATA
OC
Table D-136 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN12LOM FAC-{N}-{1-8,12-
27,29-36}-{1,3-10}
TN12LOG FAC-{N}-{1-8,12-
27,29-36}-{1,3-10}
TN11TMX FAC-{N}-{1-8,12-
27,29-36}-{3-6}
TN12TMX FAC-{N}-{1-8,12-
27,29-36}-{1,3-6}
TN13LQM FAC-{N}-{1-8,12-
27,29-36}-{3-6}
TN12LQMD FAC-{N}-{1-8,12-
27,29-36}-{3-6}
TN12LQMS FAC-{N}-{1-8,12-
27,29-36}-{3-6}
TN12LSX FAC-{N}-{1-8,12-
27,29-36}-{3}
TN13LSX FAC-{N}-{1-8,12-
27,29-36}-{3}
TN12LDX FAC-{N}-{1-8,12-
27,29-36}-{1,3,5,6}
TN12LSXL FAC-{N}-{3-8,14-
19,22-27,31-36}-{3}
TN12LWXS FAC-{N}-{1-8,12-
27,29-36}-{3}
TN52TDX FAC-{N}-{1-8,12-
27,29-36}-{3-4}
AID type AID format Unit type Pattern Notes
TN52TOG FAC-{N}-{1-8,12-
27,29-36}-{3-10}
TN52TOM FAC-{N}-{1-8,12-
27,29-36}-{3-10}
TN52TQX FAC-{N}-{1-8,12-
27,29-36}-{3-6}
TN11LEM24 FAC-{N}-{1-7,12-
18,20-26,29-35}-{5-28}
TN11LEX4 FAC-{N}-{1-8,12-
27,29-36}-{5-8}
TN54NQ2 FAC-{N}-{1-8,12-
27,29-36}-{1-4}
TN53TSXL FAC-{N}-{1-8,12-
27,29-36}-{3}
TN11LSQ FAC-{N}-{2-8,13-
19,21-27,30-36}-{3}
TN12DCP FAC-{N}-{1-8,12-
27,29-36}-{1-4}
TN12OLP FAC-{N}-{1-8,12-
27,29-36}-{1-2}
TN54TOA FAC-{N}-{1-8,12-
27,29-36}-{3-10}
TN53TQX FAC-{N}-{1-8,12-
27,29-36}-{3-6}
TN54TEM28 FAC-{N}-{1-7,12-
18,20-26,29-35}-{3-30}
TN11LTX FAC-{N}-{2-6,12-
17,21-25,30-34}-{3-12}
TN54NS3 FAC-{N}-{1-8,12-
27,29-36}-{1}
Table D-137 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
{3-10}
TN12LOM FAC-{N}-{1-8,11-
42,45-68}-{1,3-10}
TN12LOG FAC-{N}-{1-8,11-
42,45-68}-{1,3-10}
TN11TMX FAC-{N}-{1-8,11-
42,45-68}-{3-6}
TN12TMX FAC-{N}-{1-8,11-
42,45-68}-{1,3-6}
TN13LQM FAC-{N}-{1-8,11-
42,45-68}-{3-6}
TN12LQMD FAC-{N}-{1-8,11-
42,45-68}-{3-6}
TN12LQMS FAC-{N}-{1-8,11-
42,45-68}-{3-6}
TN12LSX FAC-{N}-{1-8,11-
42,45-68}-{3}
TN13LSX FAC-{N}-{1-8,11-
42,45-68}-{3}
TN12LDX FAC-{N}-{1-8,11-
42,45-68}-{1,3,5,6}
TN12LSXL FAC-{N}-{3-8,13-
18,21-26,29-34,37-
42,47-52,55-60,63-68}-
{3}
TN12LWXS FAC-{N}-{1-8,11-
42,45-68}-{3}
TN52TDX FAC-{N}-{1-8,11-
42,45-68}-{3-4}
TN52TOG FAC-{N}-{1-8,11-
42,45-68}-{3-10}
TN52TOM FAC-{N}-{1-8,11-
42,45-68}-{3-10}
TN52TQX FAC-{N}-{1-8,11-
42,45-68}-{3-6}
TN11LEM24 FAC-{N}-{1-7,11-
17,19-25,27-33,35-
AID type AID format Unit type Pattern Notes
41,45-51,53-59,61-67}-
{5-28}
TN11LEX4 FAC-{N}-{1-8,11-
42,45-68}-{5-8}
TN54NQ2 FAC-{N}-{1-8,11-
42,45-68}-{1-4}
TN53TSXL FAC-{N}-{1-8,11-
42,45-68}-{3}
TN11LSQ FAC-{N}-{2-8,12-
18,20-26,28-34,36-
42,46-52,54-60,62-68}-
{3}
TN12DCP FAC-{N}-{1-8,11-
42,45-68}-{1-4}
TN12OLP FAC-{N}-{1-8,11-
42,45-68}-{1-2}
TN53TQX FAC-{N}-{1-8,11-
42,45-68}-{3-6}
TN54TOA FAC-{N}-{1-8,11-
42,45-68}-{3-10}
TN54TEM28 FAC-{N}-{1-7,11-
17,19-25,27-33,35-
41,45-51,53-59,61-67}-
{3-30}
TN11LTX FAC-{N}-{2-6,12-
16,20-24,28-32,36-
40,46-50,54-58,62-66}-
{3-12}
TN54NS3 FAC-{N}-{1-8,11-
42,45-68}-{1}
Table D-138 AID 6800A values
AID type AID format Unit type Pattern Notes
TN13LQM
TN12TDX FAC-{N}-{1-8,11-16}-{3-
4}
TN11TSXL FAC-{N}-{2-8,12-16}-3
TN12LSX FAC-{N}-{1-17}-3
TN13LSX
TN12LWXS
TN11L4G FAC-{N}-{1-8,11-16}-{3-
8}
TN12TMX FAC-{N}-{1-17}-{1,3-6}
TN11TMX FAC-{N}-{1-17}-{3-6}
TN12LOG FAC-{N}-{1-8,11-16}-
{1,3-10}
TN11LOG FAC-{N}-{1-8,11-16}-{3-
10}
TN11LOM FAC-{N}-{1-16}-{3-10}
TN12ND2 FAC-{N}-{1-8,11-16}-{1-
2}
TN51NQ2 FAC-{N}-{1-8,11-16}-{1-
4}
TN11TOM FAC-{N}-{1-8,11-16}-{3-
10}
TN12LSXL FAC-{N}-{3-17}-3
TN12LWXS
TN11LEM24 FAC-{N}-{1-7,11-16}-{5-
28}
TN11LEX4 FAC-{N}-{1-8,11-17}-{5-
8}
TN11LSQ FAC-{N}-{2-8,12-16}-
{3}
TN12DCP FAC-{N}-{1-17}-{1-4}
TN12OLP FAC-{N}-{1-17}-{1-2}
TN53TQX FAC-{N}-{1-8,11-16}-{3-
6}
AID type AID format Unit type Pattern Notes
TN11LTX FAC-{N}-{2-15}-{3-12}
TN54NS3 FAC-{N}-{1-8,11-16}-
{1}
Table D-139 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12LSX FAC-{2-5,11}-3
TN13LSX
TN12LWXS
TN11L4G FAC-{2-5}-{3-8}
TN12TMX FAC-{2-5,11}-{1,3-6}
TN11TMX FAC-{2-5,11}-{3-6}
TN11LOM FAC-{3-5}-{3-10}
TN12LOG FAC-{2-5}-{1,3-10}
TN11LOG FAC-{2-5}-{3-10}
TN11TOM FAC-{2-5}-{3-10}
TN12DCP FAC-{N}-{11,2-5}-{1-
4}
TN12OLP FAC-{N}-{11,2-5}-{1-
2}
Table D-140 AID 8800 T16A values
AID type AID format Unit type Pattern Notes
TN12LOG FAC-{N}-{1-8,11-18}-
{1,3-10}
TN12LWXS FAC-{N}-{1-18}-3
AID type AID format Unit type Pattern Notes
TN11LEM24 FAC-{N}-{1-7,11-17}-{5-
28}
TN11LEX4 FAC-{N}-{1-8,11-18}-{5-
8}
TN11LSQ FAC-{N}-{2-8,12-18}-
{3}
TN12DCP FAC-{N}-{1-18}-{1-4}
TN12OLP FAC-{N}-{1-18}-{1-2}
TN53TQX FAC-{N}-{1-8,11-18}-{3-
6}
TN54TOA FAC-{N}-{1-8,11-18}-{3-
10}
TN11LTX FAC-{N}-{2-6,12-16}-{3-
12}
TN54NS3 FAC-{N}-{1-8,11-18}-
{1}
TN54TEM28 FAC-{N}-{1-7,11-17}-{3-
30}
OCS
Table D-141 AID 8800 T32E values
AID type AID format Unit type Pattern Notes
<SHELF>-<slot>- {1-10}
<port>-
<CHANNEL>:
FAC-N-M-X-Y
OCH
Table D-144 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11D40 FAC-{N}-{1-6,11-17,20-
25,29-34}-{2-41}
TN11D40V FAC-{N}-{1-6,11-17,20-
25,29-34}-{2-41}
TN11DMR1 FAC-{N}-{1-8,12-27,29-36}-
{1-2}
TN11LOG FAC-{N}-{1-8,12-27,29-36}-
{1,3-10}
TN11LOM FAC-{N}-{1-7,12-18,20-
26,29-35}-{1,3-10}
TN11LSXR FAC-{N}-{1-8,12-27,29-36}-
{1}
TN11M40 FAC-{N}-{1-6,11-17,20-
25,29-34}-{2-41}
TN11M40V FAC-{N}-{1-6,11-17,20-
25,29-34}-{2-41}
TN11MR2 FAC-{N}-{1-8,11-27,29-36}-
{1-2}
TN11MR4 FAC-{N}-{1-8,11-27,29-36}-
{1-4}
TN11MR8 FAC-{N}-{1-7,11-18,20-
26,29-35}-{1-8}
TN11MR8V FAC-{N}-{1-7,12-18,20-
26,29-35}-{1-8}
TN11SBM2 FAC-{N}-{1-8,11-27,29-36}-
AID type AID format Unit type Pattern Notes
{1-4}
TN11TDC FAC-{N}-{1-8,11-27,29-36}-
{1}
TN11TMX FAC-{N}-{1-8,12-27,29-36}-
{1,3-6}
TN12DCP FAC-{N}-{1-8,12-27,29-36}-
{1-4}
TN12LDX FAC-{N}-{1-8,12-27,29-36}-
{1,3,5,6}
TN12LOG FAC-{N}-{1-8,12-27,29-36}-
{1,3-10}
TN12LOM FAC-{N}-{1-8,12-27,29-36}-
{1,3-10}
TN12LQMD FAC-{N}-{1-8,12-27,29-36}-
{1-6}
TN12LQMS FAC-{N}-{1-8,12-27,29-36}-
{1,3-6}
TN12LSX FAC-{N}-{1-8,12-27,29-36}-
{1,3}
TN12LSXL FAC-{N}-{3-8,14-19,22-
27,31-36}-{1}
TN12LSXLR FAC-{N}-{2-8,13-19,21-
27,30-36}-{1}
TN12LWXS FAC-{N}-{1-8,12-27,29-36}-
{1,3}
TN12OLP FAC-{N}-{1-8,12-27,29-36}-
{1,2}
TN12TMX FAC-{N}-{1-8,12-27,29-36}-
{1,3-6}
TN13LQM FAC-{N}-{1-8,12-27,29-36}-
{1-6}
TN13LSX FAC-{N}-{1-8,12-27,29-36}-
{1,3}
TN52ND2 FAC-{N}-{1-8,12-27,29-36}-
{1-2}
TN52NQ2 FAC-{N}-{1-8,12-27,29-36}-
AID type AID format Unit type Pattern Notes
{1-4}
TN52NS2 FAC-{N}-{1-8,12-27,29-36}-
{1}
TN52NS3 FAC-{N}-{2-8,13-19,21-
27,30-36}-{1}
TN52TDX FAC-{N}-{1-8,12-27,29-36}-
{3-4}
TN52TOG FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN52TOM FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN52TQX FAC-{N}-{1-8,12-27,29-36}-
{3-6}
TN11LEX4 FAC-{N}-{1-8,12-27,29-36}-
{3-8}
TN11LEM24 FAC-{N}-{1-7,12-18,20-
26,29-35}-{3-28}
TN11LSQ FAC-{N}-{2-8,13-19,21-
27,30-36}-{3}
TN54NS3 FAC-{N}-{1-8,12-27,29-36}-
{1}
TN54NQ2 FAC-{N}-{1-8,12-27,29-36}-
{1-4}
TN53TQX FAC-{N}-{1-8,12-27,29-36}-
{3-6}
TN54TOA FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN11LSC FAC-{N}-{4-8,14-19,23-
27,32-36}-{1-2}
TN12LSC FAC-{N}-{1-5,12-16,20-
24,29-33}-{1}
TN11LTX FAC-{N}-{2-6,12-17,21-
25,30-34}-{1,3-12}
TN55NS3 FAC-{N}-{2-8,13-19,21-
27,30-36}-{1}
TN56NS3 FAC-{N}-{1-8,12-27,29-36}-
AID type AID format Unit type Pattern Notes
{1}
TN12WSM9 FAC-{N}-{1-7,12-18,20-
26,29-35}-{2}-{1-40}
TN13WSD9 FAC-{N}-{1-6,12-17,20-
25,29-34}-{1}-{1-80}
TN13WSM9 FAC-{N}-{1-6,12-17,20-
25,29-34}-{2}-{1-80}
TN11WSMD2 FAC-{N}-{1-7,12-18,20-
26,29-35}-{4}-{1-40}
TN11WSMD4 FAC-{N}-{1-7,12-18,20-
26,29-35}-{4}-{1-40}
TN12WSMD2 FAC-{N}-{1-7,12-18,20-
26,29-35}-{4}-{1-80}
TN14WSM9 FAC-{N}-{1-7,12-18,20-
26,29-35}-{2}-{1-80}
TN12WSMD4 FAC-{N}-{1-7,12-18,20-
26,29-35}-{4}-{1-80}
TN11WSMD9 FAC-{N}-{1-7,12-18,20-
26,29-35}-{4}-{1-80}
TN11LSC FAC-{N}-{4-8,14-19,23-
27,32-36}-{3}-{1-10}
Table D-145 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11D40 FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{2-41}
TN11D40V FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{2-41}
AID type AID format Unit type Pattern Notes
TN11DMR1 FAC-{N}-{1-8,11-42,45-68}-
{1-2}
TN11LOG FAC-{N}-{1-8,11-42,45-68}-
{1,3-10}
TN11LOM FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1,3-10}
TN11LSXR FAC-{N}-{1-8,11-42,45-68}-
{1}
TN11M40 FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{2-41}
TN11M40V FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{2-41}
TN11MR2 FAC-{N}-{1-8,11-42,45-68}-
{1-2}
TN11MR4 FAC-{N}-{1-8,11-42,45-68}-
{1-4}
TN11MR8 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-8}
TN11MR8V FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-8}
TN11SBM2 FAC-{N}-{1-8,11-42,45-68}-
{1-4}
TN11TDC FAC-{N}-{1-8,11-42,45-68}-
{1}
TN11TMX FAC-{N}-{1-8,11-42,45-68}-
{1,3-6}
TN12DCP FAC-{N}-{1-8,11-42,45-68}-
{1-4}
TN12LDX FAC-{N}-{1-8,11-42,45-68}-
{1,3,5,6}
TN12LOG FAC-{N}-{1-8,11-42,45-68}-
{1,3-10}
TN12LOM FAC-{N}-{1-8,11-42,45-68}-
AID type AID format Unit type Pattern Notes
{1,3-10}
TN12LQMD FAC-{N}-{1-8,11-42,45-68}-
{1-6}
TN12LQMS FAC-{N}-{1-8,11-42,45-68}-
{1,3-6}
TN12LSX FAC-{N}-{1-8,11-42,45-68}-
{1,3}
TN12LSXL FAC-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-
60,63-68}-{1}
TN12LSXLR FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1}
TN12LWXS FAC-{N}-{1-8,11-42,45-68}-
{1,3}
TN12OLP FAC-{N}-{1-8,11-42,45-68}-
{1,2}
TN12TMX FAC-{N}-{1-8,11-42,45-68}-
{1,3-6}
TN13LQM FAC-{N}-{1-8,11-42,45-68}-
{1-6}
TN13LSX FAC-{N}-{1-8,11-42,45-68}-
{1,3}
TN52ND2 FAC-{N}-{1-8,11-42,45-68}-
{1-2}
TN52NQ2 FAC-{N}-{1-8,11-42,45-68}-
{1-4}
TN52NS2 FAC-{N}-{1-8,11-42,45-68}-
{1}
TN52NS3 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1}
TN52TDX FAC-{N}-{1-8,11-42,45-68}-
{3-4}
TN52TOG FAC-{N}-{1-8,11-42,45-68}-
{3-10}
TN52TOM FAC-{N}-{1-8,11-42,45-68}-
AID type AID format Unit type Pattern Notes
{3-10}
TN52TQX FAC-{N}-{1-8,11-42,45-68}-
{3-6}
TN11LEX4 FAC-{N}-{1-8,11-42,45-68}-
{3-8}
TN11LEM24 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{3-28}
TN11LSQ FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{3}
TN54NS3 FAC-{N}-{1-8,11-42,45-68}-
{1}
TN54NQ2 FAC-{N}-{1-8,11-42,45-68}-
{1-4}
TN53TQX FAC-{N}-{1-8,11-42,45-68}-
{3-6}
TN54TOA FAC-{N}-{1-8,11-42,45-68}-
{3-10}
TN11LSC FAC-{N}-{4-8,14-18,22-
26,30-34,38-42,48-52,56-
60,64-68}-{1-2}
TN12LSC FAC-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}-{1}
TN11LTX FAC-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}-{1,3-12}
TN55NS3 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1}
TN56NS3 FAC-{N}-{1-8,11-42,45-68}-
{1}
TN12WSM9 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{2}-{1-40}
TN13WSD9 FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{1}-{1-80}
TN13WSM9 FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{2}-{1-80}
TN11WSMD2 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{4}-{1-40}
TN11WSMD4 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{4}-{1-40}
TN12WSMD2 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{4}-{1-80}
TN14WSM9 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{2}-{1-80}
TN12WSMD4 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{4}-{1-80}
TN11WSMD9 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{4}-{1-80}
TN11LSC FAC-{N}-{4-8,14-18,22-
26,30-34,38-42,48-52,56-
60,64-68}-{3}-{1-10}
Table D-146 AID 6800A values
AID type AID format Unit type Pattern Notes
TN12NS2 FAC-{N}-{1-8,11-16}-1
TN12LSXL FAC-{N}-{3-17}-3
TN12LWXS FAC-{N}-{1-17}-1
AID type AID format Unit type Pattern Notes
TN11LSXR
TN12LSX FAC-{N}-{1-17}-{1,3}
TN12LWXS
TN11NS3 FAC-{N}-{2-8,12-16}-1
TN11ND2 FAC-{N}-{1-8,11-16}-{1-2}
TN12TDX FAC-{N}-{1-8,11-16}-{3-4}
TN11CMR2 FAC-{N}-{1-17}-{1-2}
TN11MR2
TN11DMR1
TN12LSX
TN12TQM FAC-{N}-{1-8,11-16}-{3-6}
TN11TQX
TN51NQ2 FAC-{N}-{1-8,11-16}-{1-4}
TN11CMR4 FAC-{N}-{1-17}-{1-4}
TN11MR4
TN11SBM2
TN11LQG FAC-{N}-{1-8,11-16}-{1,3-
TN12LQMS 6}
TN11TMX
TN13LQM FAC-{N}-{1-8,11-16}-{1-6}
TN12LQMD
TN11MR8 FAC-{N}-{1-16}-{1-8}
TN11L4G FAC-{N}-{1-8,11-16}-{1,3-
8}
TN11M40 FAC-{N}-{1-15}-{2-41}
TN11M40V
TN11D40
TN11D40V
TN12LSXLR FAC-{N}-{2-17}-1
TN12LOG FAC-{N}-{1-8,11-16}-{1,3-
10}
TN12LOM FAC-{N}-{1-17}-{1,3-10}
TN12TMX FAC-{N}-{1-17}-{1,3-6}
TN13LSX FAC-{N}-{1-17}-{1,3}
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-17}-{1,3,5,6}
TN12ND2 FAC-{N}-{1-8,11-16}-{1,2}
TN11MR8V FAC-{N}-{1-16}-{1-8}
TN11LOM FAC-{N}-{1-16}-{1,3-10}
TN11LEX4 FAC-{N}-{1-8,11-17}-{3-8}
TN11LEM24 FAC-{N}-{1-7,11-16}-{3-28}
TN11LSQ FAC-{N}-{2-8,12-16}-{3}
TN53TQX FAC-{N}-{1-8,11-16}-{3-10}
TN11LSC FAC-{N}-{4-8,11-16}-{1-2}
TN12LSC FAC-{N}-{1-14}-{1}
TN11LTX FAC-{N}-{2-15}-{1,3-12}
TN55NS3 FAC-{N}-{2-8,12-16}-{1}
TN13WSM9 FAC-{N}-{1-15}-2-{1-80}
TN11WSMD4 FAC-{N}-{1-16}-4-{1-40}
TN11ROAM FAC-{N}-{1-15}-4-{1-40}
TN12WSMD2 FAC-{N}-{1-16}-{4}-{1-80}
TN14WSM9 FAC-{N}-{1-16}-{2}-{1-80}
TN12WSMD4 FAC-{N}-{1-16}-{4}-{1-80}
TN11WSMD9 FAC-{N}-{1-16}-{4}-{1-80}
TN11LSC FAC-{N}-{4-8,11-16}-{3}-
{1-10}
Table D-147 AID 3800A values
AID type AID format Unit type Pattern Notes
TN11TBE FAC-{2-5}-{3-11}
TN12NS2 FAC-{2-5}-1
TN21CMR1 FAC-{1,8,11}-1
TN11LSXR FAC-{2-5,11}-1
TN12LWXS
TN12LSX FAC-{2-5,11}-{1,3}
TN12LWXS
TN11MR2 FAC-{2-5}-{1-2}
TN11CMR2
TN11DMR1
TN21CMR2 FA-{1,8,11}-{1-2}
TN21MR2
TN21DMR1
TN12TQM FAC-{2-5}-{3-6}
TN11MR4 FAC-{2-5}-{1-4}
TN11CMR4
TN11SBM2 FAC-{2-5,11}-{1-4}
TN21CMR4 FAC-{1,8,11}-{1-4}
TN21MR4
TN11LQG FAC-{2-5}-{1,3-6}
TN12LQMS
TN11TMX
TN13LQM FAC-{2-5}-{1-6}
TN12LQMD
TN11L4G FAC-{2-5}-{3-8}
TN11LEX4 FAC-{N}-{2-5}-{3-8}
TN11LEM24 FAC-{N}-{3-5}-{3-28}
Table D-148 AID 8800 T16A values
AID type AID format Unit type Pattern Notes
TN11CMR4 FAC-{N}-{1-18}-{1-4}
TN11MR4
TN11M40 FAC-{N}-{1-6,11-16}-{2-41}
TN11M40V
TN11D40
TN12LOG FAC-{N}-{1-8,11-18}-{1,3-
10}
TN12LOM FAC-{N}-{1-18}-{1,3-10}
TN12TMX FAC-{N}-{1-18}-{1,3-6}
TN13LSX FAC-{N}-{1-18}-{1,3}
TN12LDX FAC-{N}-{1-18}-{1,3,5,6}
TN11MR8V FAC-{N}-{1-7,11-17}-{1-8}
TN11LEX4 FAC-{N}-{1-8,11-18}-{3-8}
TN11LEM24 FAC-{N}-{1-7,11-17}-{3-28}
TN11LSQ FAC-{N}-{2-8,12-18}-{3}
TN53TQX FAC-{N}-{1-8,11-18}-{3-10}
TN54TOA FAC-{N}-{1-8,11-18}-{3-10}
TN11LSC FAC-{N}-{4-8,14-18}-{1-2}
TN12LSC FAC-{N}-{1-5,11-15}-{1}
TN11LTX FAC-{N}-{2-6,12-16}-{1,3-
12}
TN55NS3 FAC-{N}-{2-8,12-18}-{1}
TN56NS3 FAC-{N}-{1-8,11-18}-{1}
TN14WSM9 FAC-{N}-{1-7,11-17}-{2}-
{1-80}
TN12WSMD4 FAC-{N}-{1-7,11-17}-{4}-
{1-80}
TN11WSMD9 FAC-{N}-{1-7,11-17}-{4}-
AID type AID format Unit type Pattern Notes
{1-80}
TN11LSC FAC-{N}-{4-8,14-18}-{3}-
{1-10}
OCHM
Table D-149 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
FAC-M-X ED-OCHM
Table D-153 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
OCHS
Table D-154 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
OCN/STMN
Table D-159 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-8,12-27,29-
36}-{5,6}
TN11TMX FAC-{N}-{1-8,12-27,29-
TN12TMX 36}-{3-6}
TN12LSXL CLNT-{N}-{3-8,14-
19,22-27,31-36}-1
TN53TSXL CLNT-{N}-{1-8,12-
27,29-36}-1
TN53TQX CLNT-{N}-{1-8,12-
AID type AID format Unit type Pattern Notes
27,29-36}-{1-4}
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{1,2,5,6}-{1-4}
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{3,4,7,8}-{1-2}
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{3-4}-{1-4}
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{1-2}-{1-8}
TN54TOA CLNT-{N}-{1-8,12-
27,29-36}-{1-8}-{1-8}
Table D-160 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-8,11-42,45-
68}-{5,6}
TN11TMX FAC-{N}-{1-8,11-42,45-
TN12TMX 68}-{3-6}
TN12LSXL CLNT-{N}-{3-8,13-
18,21-26,29-34,37-42,47-
52,55-60,63-68}-1
AID type AID format Unit type Pattern Notes
TN53TSXL CLNT-{N}-{1-8,11-
42,45-68}-1
TN53TQX CLNT-{N}-{1-8,11-
42,45-68}-{1-4}
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{1,2,5,6}-{1-4}
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{3,4,7,8}-{1-2}
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{3-4}-{1-4}
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{1-2}-{1-8}
TN54TOA CLNT-{N}-{1-8,11-
42,45-68}-{1-8}-{1-8}
Table D-161 AID 6800A values
AID type AID format Unit type Pattern Notes
TN12LWXS FAC-{N}-{1-17}-{1,3}
TN12LDX FAC-{N}-{1-17}-{5,6}
TN11TMX FAC-{N}-{1-17}-{3-6}
TN12TMX
TN12TDX CLNT-{N}-{1-8,11-16}-
AID type AID format Unit type Pattern Notes
TN52TDX {1-2}
TN11TQX CLNT-{N}-{1-8,11-16}-
TN52TQX {1-4}
TN53TQX
TN52TOM CLNT-{N}-{1-8,11-16}-
{1,2,5,6}-{1-4}
TN52TOM CLNT-{N}-{1-8,11-16}-
{3,4,7,8}-{1-2}
TN52TOM CLNT-{N}-{1-8,11-16}-
{3-4}-{1-4}
TN52TOM CLNT-{N}-{1-8,11-16}-
{1-2}-{1-8}
TN11TOM CLNT-{N}-{1-8,11-16}-
{1-4}-{1-4}
Table D-162 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12LWXS FAC-{2-5,11}-{1,3}
TN12LDX FAC-{2-5,11}-{5,6}
TN11TMX FAC-{2-5,11}-{3-6}
TN11TOM CLNT-{2-5}-{1-4}-{1-4}
Table D-163 AID 8800 T16A values
AID type AID format Unit type Pattern Notes
TN12TMX FAC-{N}-{1-18}-{3-6}
TN52TOM CLNT-{N}-{1-8,11-18}-
{3-4}-{1-4}
TN54TOA CLNT-{N}-{1-8,11-18}-
{1-8}-{1-8}
TN52TOM CLNT-{N}-{1-8,11-18}-
{1-2}-{1-8}
OMS
Table D-164 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11BMD8 FAC-{N}-{1-7,11-
TN12D40 18,20-26,29-35}-1
TN11WSMD2 FAC-{N}-{1-7,12-
TN11WSMD4 18,20-26,29-35}-1
TN12WSD9
TN12WSMD2
TN12WSMD4
AID type AID format Unit type Pattern Notes
TN11D40 FAC-{N}-{1-6,11-
TN11D40V 17,20-25,29-34}-1
TN11ROAM
TN13WSD9 FAC-{N}-{1-6,12-
17,20-25,29-34}-1
TN55NPO2 FAC-{N}-
{3,7,14,18,22,26,31,35}-
1
TN11SCS FAC-{N}-{1-8,11-
TN11MR2 27,29-36}-4
TN11MR4 FAC-{N}-{1-8,11-
27,29-36}-6
TN11MR8 FAC-{N}-{1-7,11-
18,20-26,29-35}-10
TN11MR8V FAC-{N}-{1-7,12-
18,20-26,29-35}-10
Table D-165 AID 8800 T64 values
AID AID format Unit type Pattern Notes
type
TN11D40 FAC-{N}-{1-6,11-16,19-24,27-32,35-40,45-
TN11D40V 50,53-58,61-66}-1
TN11ROAM
TN13WSD9
TN55NPO2 FAC-{N}-
{3,7,13,17,21,25,29,33,37,41,47,51,55,59,63,67}-
1
TN11SCS FAC-{N}-{1-8,11-42,45-68}-4
TN11MR2
AID AID format Unit type Pattern Notes
type
TN11MR4 FAC-{N}-{1-8,11-42,45-68}-6
TN11MR8 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-
TN11MR8V 51,53-59,61-67}-10
Table D-166 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11BMD8 FAC-{N}-{1-16}-1
TN11WSMD2
TN11WSMD4
TN12D40
TN12WSD9
TN12WSMD2
TN12WSMD4
TN11D40 FAC-{N}-{1-15}-1
TN11D40V
TN11ROAM
TN13WSD9
TN12PTQX FAC-{N}-{3,7,13}-1
TN11SCS FAC-{N}-{1-17}-4
TN11MR2
TN11MR4 FAC-{N}-{1-17}-6
TN11MR8 FAC-{N}-{1-16}-10
TN11MR8V
Table D-167 AID 3800A values
AID type AID format Unit type Pattern Notes
TN21MR2 FAC-{1,8,11}-4
TN11MR4 FAC-{2-5}-6
TN21MR4 FAC-{1,8,11}-6
Table D-168 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
TN11BMD8 FAC-{N}-{1-7,11-
TN12D40 17}-1
TN12WSMD4
TN11D40 FAC-{N}-{1-6,11-
TN13WSD9 16}-1
TN55NPO2 FAC-{N}-
{3,7,13,17}-1
TN11SCS FAC-{N}-{1-18}-
TN11MR2 4
TN11MR4 FAC-{N}-{1-18}-
6
TN11MR8V FAC-{N}-{1-7,11-
17}-10
OSC
Indicates the external switch command.
Table D-169 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{N}-{1-8,12-
27,29-36}-4
Table D-170 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{N}-{1-8,11-
42,45-68}-4
Table D-171 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{N}-{1-17}-4
Table D-172 AID 3800A values
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{1-8,11-18}-4
OTS
Table D-174 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN21DFIU FAC-{1,8,11}-{1,4}
Table D-178 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
OTUN
Table D-179 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-8,12-27,29-
36}-{1,3,5,6}
TN11TMX FAC-{N}-{1-8,12-27,29-
TN12TMX 36}-{1,3-6}
TN11LSQ FAC-{N}-{2-8,13-19,21-
27,30-36}-{1,3}
TN11LSC FAC-{N}-{4-8,14-19,23-
27,32-36}-1
TN12LSC FAC-{N}-{1-5,12-16,20-
24,29-33}-1
TN11LTX FAC-{N}-{2-6,12-17,21-
25,30-34}-1
TN55NS3 FAC-{N}-{2-8,13-19,21-
27,30-36}-1
AID type AID format Unit type Pattern Notes
TN56NS3 FAC-{N}-{1-8,12-27,29-
36}-1
TN53NS2 FAC-{N}-{1-8,12-27,29-
36}-1
TN53ND2 FAC-{N}-{1-8,12-27,29-
36}-{1,2}
TN53NQ2 FAC-{N}-{1-8,12-27,29-
36}-{1-4}
TN11LOG CLNT-{N}-{1-8,12-27,29-
TN12LOG 36}-1
TN11LOM CLNT-{N}-{1-7,12-18,20-
TN12LOM 26,29-35}-1
TN12LSXL CLNT-{N}-{3-8,14-19,22-
27,31-36}-1
TN52TQX CLNT-{N}-{1-8,12-27,29-
TN53TQX 36}-{1-4}
TN53TSXL CLNT-{N}-{1-8,12-27,29-
36}-1
TN11LEX4 SRV1-{N}-{1-8,12-27,29-
36}-{1}
AID type AID format Unit type Pattern Notes
TN11LEM24 SRV1-{N}-{1-7,12-18,20-
26,29-35}-{1}
TN52NQ2 SRV3-{N}-{1-8,12-27,29-
36}-{1-4}
TN52NS3 SRV3-{N}-{2-8,13-19,21-
27,30-36}-1
TN54NS3 SRV3-{N}-{1-8,12-27,29-
36}-{1}
TN54NQ2 SRV3-{N}-{1-8,12-27,29-
36}-{1}
Table D-180 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-8,11-42,45-
68}-{1,3,5,6}
TN11TMX FAC-{N}-{1-8,11-42,45-
TN12TMX 68}-{1,3-6}
TN11LSC FAC-{N}-{4-8,14-18,22-
26,30-34,38-42,48-52,56-
60,64-68}-1
TN11LSQ FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1,3}
TN12LSC FAC-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}-1
TN11LTX FAC-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}-1
TN55NS3 FAC-{N}-{2-8,12-18,20-
AID type AID format Unit type Pattern Notes
26,28-34,36-42,46-52,54-
60,62-68}-1
TN56NS3 FAC-{N}-{1-8,11-42,45-
68}-1
TN53NS2 FAC-{N}-{1-8,11-42,45-
68}-1
TN53ND2 FAC-{N}-{1-8,11-42,45-
68}-{1,2}
TN53NQ2 FAC-{N}-{1-8,11-42,45-
68}-{1-4}
TN11LOG CLNT-{N}-{1-8,11-42,45-
TN12LOG 68}-1
TN11LOM CLNT-{N}-{1-7,11-17,19-
TN12LOM 25,27-33,35-41,45-51,53-
59,61-67}-1
TN12LSXL CLNT-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-
60,63-68}-1
TN52TQX CLNT-{N}-{1-8,11-42,45-
TN53TQX 68}-{1-4}
TN53TSXL CLNT-{N}-{1-8,11-42,45-
68}-{1-4}
SRV1-N-M-X TN12LQMD
TN13LQM
TN11LEX4 SRV1-{N}-{1-8,11-42,45-
68}-{1}
TN11LEM24 SRV1-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1}
TN52NQ2 SRV3-{N}-{1-8,11-42,45-
68}-{1-4}
TN52NS3 SRV3-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-1
TN54NS3 SRV3-{N}-{1-8,11-42,45-
68}-{1}
TN54NQ2 SRV3-{N}-{1-8,11-42,45-
68}-{1}
Table D-181 AID 6800A values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{N}-{1-17}-{1,3,5,6}
TN11TMX FAC-{N}-{1-17}-{1,3-6}
TN12TMX
TN11LSC FAC-{N}-{4-8,11-16}-1
TN11LSQ FAC-{N}-{2-8,12-16}-
{1,3}
TN12LSC FAC-{N}-{1-14}-1
TN11LTX FAC-{N}-{2-15}-1
TN55NS3 FAC-{N}-{2-8,12-16}-1
TN53NS2 FAC-{N}-{1-8,11-16}-1
AID type AID format Unit type Pattern Notes
TN53ND2 FAC-{N}-{1-8,11-16}-
{1,2}
TN53NQ2 FAC-{N}-{1-8,11-16}-{1-
4}
TN11NS3 SRV2-{N}-{2-8,12-16}-1
TN52TOM SRV2-{N}-{1-8,11-16}-
{1-4}
TN51NQ2 SRV2-{N}-{1-8,11-16}-
{1-4}
TN11L4G CLNT-{N}-{1-8,11-16}-1
TN11LQG
TN11LOG
TN12LOG
TN11LOM CLNT-{N}-{1-16}-1
TN12LOM
TN12LSXL CLNT-{N}-{3-17}-1
TN52TQX CLNT-{N}-{1-8,11-16}-
TN53TQX {1-4}
SRV1-N-M-X TN13LQM
TN11TOM SRV1-{N}-{1-8,11-16}-
{1-4}
TN11LEX4 SRV1-{N}-{1-8,11-17}-
{1}
TN11LEM24 SRV1-{N}-{1-7,11-16}-
{1}
TN52NQ2 SRV3-{N}-{1-8,11-16}-
{1-4}
TN52NS3 SRV3-{N}-{2-8,12-16}-1
TN54NS3 SRV3-{N}-{1-8,11-16}-
{1}
Table D-182 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12LDX FAC-{2-5,11}-{1,3,5,6}
TN11TMX FAC-{2-5,11}-{1,3-6}
TN12TMX
TN11LQG CLNT-{2-5}-1
AID type AID format Unit type Pattern Notes
TN11LOG
TN12LOG
TN11LOM CLNT-{3-5}-1
TN12LOM
TN11TOM CLNT-{2-5}-{1-4}
TN52TOM
TN11TOM SRV1-{2-5}-{1-4}
TN52TOM
TN11LEX4 SRV1-{2-5}-{1}
TN11LEM24 SRV1-{3-5}-{1}
TN12LDX FAC-{N}-{1-18}-
{1,3,5,6}
TN12TMX FAC-{N}-{1-18}-{1,3-
6}
TN11LSQ FAC-{N}-{2-8,12-18}-
{1,3}
TN12LSC FAC-{N}-{1-5,11-15}-1
TN11LTX FAC-{N}-{2-6,12-16}-1
TN55NS3 FAC-{N}-{2-8,12-18}-1
TN56NS3 FAC-{N}-{1-8,11-18}-1
TN53NS2 FAC-{N}-{1-8,11-18}-1
TN53ND2 FAC-{N}-{1-8,11-18}-
{1,2}
AID type AID format Unit type Pattern Notes
TN53NQ2 FAC-{N}-{1-8,11-18}-
{1-4}
TN52TDX CLNT-{N}-{1-8,11-
18}-{1-2}
TN52TQX CLNT-{N}-{1-8,11-
TN53TQX 18}-{1-4}
TN52ND2 SRV3-{N}-{1-8,11-18}-
{1,2}
TN54NQ2 SRV3-{N}-{1-8,11-18}-
{1-4}
TN54NS3 SRV3-{N}-{1-8,11-18}-
{1}
ODUN
Table D-184 AID 8800 T32 values
AID AID format Unit type Pattern Notes
type
TN12LDX FAC-{N}-{1-8,12-27,29-36}-
{1,3,5,6}
TN12TMX FAC-{N}-{1-8,12-27,29-36}-{1,3-
6}
TN11TMX FAC-{N}-{1-8,12-27,29-36}-{3-6}
TN11LSC FAC-{N}-{4-8,14-19,23-27,32-36}-
1
TN11LSQ FAC-{N}-{2-8,13-19,21-27,30-36}-
{1,3}
TN12LSC FAC-{N}-{1-5,12-16,20-24,29-33}-
1
TN54TSXL FAC-{N}-{1-8,12-27,29-36}-3
TN11LTX FAC-{N}-{2-6,12-17,21-25,30-34}-
1
TN55NS3 FAC-{N}-{2-8,13-19,21-27,30-36}-
1
TN56NS3 FAC-{N}-{1-8,12-27,29-36}-1
TN53NS2 FAC-{N}-{1-8,12-27,29-36}-{1}
TN53ND2 FAC-{N}-{1-8,12-27,29-36}-{1,2}
TN53NQ2 FAC-{N}-{1-8,12-27,29-36}-{1-4}
TN11LTX FAC-{N}-{2-6,12-17,21-25,30-34}-
1-{1–10}
TN55NS3 FAC-{N}-{2-8,13-19,21-27,30-36}-
1-{1–4}
TN56NS3 FAC-{N}-{1-8,12-27,29-36}-1-{1–
4}
AID AID format Unit type Pattern Notes
type
TN53NS2 FAC-{N}-{1-8,12-27,29-36}-1-{1-
4}
TN53ND2 FAC-{N}-{1-8,12-27,29-36}-{1,2}-
{1-4}
TN53NQ2 FAC-{N}-{1-8,12-27,29-36}-{1-
4}-{1-4}
TN55NPO2E FAC-{N}-
{3,5,7,14,16,18,22,24,26,31,33,35}-
{1}-{1-4}
TN55NPO2 FAC-{N}-
{3,5,7,14,16,18,22,24,26,31,33,35}-
{1}-{1-4}
TN55NPO2(STND) FAC-{N}-
{3,5,7,14,16,18,22,24,26,31,33,35}-
{1}-{1-4}
TN52NQ2 SRV2-{N}-{1-8,12-27,29-36}-{1-
4}
TN52NS2 SRV2-{N}-{1-8,12-27,29-36}-1
TN54NS3 SRV2-{N}-{1-8,12-27,29-36}-1
TN54NQ2 SRV2-{N}-{1-8,12-27,29-36}-{1-
4}
TN52ND2 SRV2-{N}-{1-8,12-27,29-36}-{1-
2}-{1-4}
TN54NS3 SRV2-{N}-{1-8,12-27,29-36}-1-
{1-4,1001-1016}
TN54NQ2 SRV2-{N}-{1-8,12-27,29-36}-{1-
4}-{1-4}
TN53TQX CLNT-{N}-{1-8,12-27,29-36}-{1–
4}
TN12LOG CLNT-{N}-{1-8,12-27,29-36}-1
TN12LOM CLNT-{N}-{1-8,12-27,29-36}-1
TN11LOM CLNT-{N}-{1-7,12-18,20-26,29-
35}-1
TN52TOG CLNT-{N}-{1-8,12-27,29-36}-{1-
8}
TN52TOM CLNT-{N}-{1-8,12-27,29-36}-{1-
8}
TN54TOA CLNT-{N}-{1-8,12-27,29-36}-{1-
8}
TN52TQX CLNT-{N}-{1-8,12-27,29-36}-{1-
4}
TN52TDX CLNT-{N}-{1-8,12-27,29-36}-{1-
2}
TN53TSXL CLNT-{N}-{1-8,12-27,29-36}-1
TN11LEM24 CLNT-{N}-{1-7,12-18,20-26,29-
35}-{1–2}
TN11LEX4 CLNT-{N}-{1-8,12-27,29-36}-{1–
2}
TN54TEM28 CLNT-{N}-{1-7,12-18,20-26,29-
35}-{1–16}
TN52NS2 SRV1-{N}-{1-8,12-27,29-36}-{1-
4}
AID AID format Unit type Pattern Notes
type
TN52TOG SRV1-{N}-{1-8,12-27,29-36}-{1-
4}
TN52TOM SRV1-{N}-{1-8,12-27,29-36}-{1-
4}
TN54TOA SRV1-{N}-{1-8,12-27,29-36}-{1-
8}
TN52NQ2 SRV1-{N}-{1-8,12-27,29-36}-{1-
16}
TN54NS3 SRV1-{N}-{1-8,12-27,29-36}-{1-
16}
TN54NQ2 SRV1-{N}-{1-8,12-27,29-36}-{1-
16}
TN11LEX4 SRV1-{N}-{1-8,12-27,29-36}-{1–
2}
TN11LEM24 SRV1-{N}-{1-7,12-18,20-26,29-
35}-{1–2}
TN12LQMD SRV1-{N}-{1-8,12-27,29-36}-1-
TN13LQM {1,2}
TN52NS2 SRV1-{N}-{1-8,12-27,29-36}-{1-
4}-{1-2}
TN52TOM SRV1-{N}-{1-8,12-27,29-36}-{1-
4}-{1-2}
TN54TOA SRV1-{N}-{1-8,12-27,29-36}-{1-
8}-{1–2}
TN52NQ2 SRV1-{N}-{1-8,12-27,29-36}-{1-
16}-{1-2}
TN54NS3 SRV1-{N}-{1-8,12-27,29-36}-{1-
16}-{1-2}
TN54NQ2 SRV1-{N}-{1-8,12-27,29-36}-{1-
16}-{1-2}
TN52NQ2 SRV3-{N}-{1-8,12-27,29-36}-{1-
4}
TN52ND2 SRV3-{N}-{1-8,12-27,29-36}-{1-
2}
TN52NS2 SRV3-{N}-{1-8,12-27,29-36}-1
TN54NS3 SRV3-{N}-{1-8,12-27,29-36}-{1-
16}
TN54NQ2 SRV3-{N}-{1-8,12-27,29-36}-{1-
16}
TN55NS3 FAC-{N}-{2-8,13-19,21-27,30-36}-
1–{0}-{1-16}-{1–2}
TN56NS3 FAC-{N}-{1-8,12-27,29-36}-1–
{0}-{1-16}-{1–2}
Table D-185 AID 8800 T64 values
AID AID format Unit type Pattern Notes
type
TN12TMX FAC-{N}-{1-8,11-42,45-68}-{1,3-6}
TN11TMX FAC-{N}-{1-8,11-42,45-68}-{3-6}
TN11LSC FAC-{N}-{4-8,14-18,22-26,30-34,38-42,48-52,56-
60,64-68}-1
TN11LSQ FAC-{N}-{2-8,12-18,20-26,28-34,36-42,46-52,54-
AID AID format Unit type Pattern Notes
type
60,62-68}-{1,3}
TN12LSC FAC-{N}-{1-5,11-15,19-23,27-31,35-39,45-49,53-
57,61-65}-1
TN54TSXL FAC-{N}-{1-5,11-15,19-23,27-31,35-39,45-49,53-
57,61-65}-3
TN11LTX FAC-{N}-{2-6,12-16,20-24,28-32,36-40,46-50,54-
58,62-66}-1
TN55NS3 FAC-{N}-{2-8,12-18,20-26,28-34,36-42,46-52,54-
60,62-68}-1
TN56NS3 FAC-{N}-{1-8,11-42,45-68}-1
TN53NS2 FAC-{N}-{1-8,11-42,45-68}-{1}
TN53ND2 FAC-{N}-{1-8,11-42,45-68}-{1,2}
TN53NQ2 FAC-{N}-{1-8,11-42,45-68}-{1-4}
TN56NS3 FAC-{N}-{1-8,11-42,45-68}-1-{1–4}
TN53NS2 FAC-{N}-{1-8,11-42,45-68}-1-{1-4}
TN53ND2 FAC-{N}-{1-8,11-42,45-68}-{1,2}-{1-4}
TN53NQ2 FAC-{N}-{1-8,11-42,45-68}-{1-4}-{1-4}
TN55NPO2E FAC-{N}-
{3,5,7,13,15,17,21,23,25,29,31,33,37,39,41,47,49,51,
55,57,59,63,65,67}-{1}-{1-4}
TN55NPO2 FAC-{N}-
{3,5,7,13,15,17,21,23,25,29,31,33,37,39,41,47,49,51,
55,57,59,63,65,67}-{1}-{1-4}
TN55NPO2(S FAC-{N}-
TND) {3,5,7,13,15,17,21,23,25,29,31,33,37,39,41,47,49,51,
55,57,59,63,65,67}-{1}-{1-4}
TN52NS2 SRV2-{N}-{1-8,11-42,45-68}-1
TN54NS3 SRV2-{N}-{1-8,11-42,45-68}-1
TN54NQ2 SRV2-{N}-{1-8,11-42,45-68}-{1-16}
TN53TQX CLNT-{N}-{1-8,11-42,45-68}-{1–4}
TN12LOG CLNT-{N}-{1-8,11-42,45-68}-1
TN12LOM CLNT-{N}-{1-8,11-42,45-68}-1
TN11LOM CLNT-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-
59,61-67}-1
TN52TOG CLNT-{N}-{1-8,11-42,45-68}-{1-8}
TN52TOM CLNT-{N}-{1-8,11-42,45-68}-{1-8}
TN54TOA CLNT-{N}-{1-8,11-42,45-68}-{1-8}
TN52TQX CLNT-{N}-{1-8,11-42,45-68}-{1-4}
TN54TOA CLNT-{N}-{1-8,11-42,45-68}-{1-2}
TN53TSXL CLNT-{N}-{1-8,11-42,45-68}-1
TN11LEM24 CLNT-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-
59,61-67}-{1–2}
TN11LEX4 CLNT-{N}-{1-8,11-42,45-68}-{1–2}
TN54TEM28 CLNT-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-
59,61-67}-{1–16}
AID AID format Unit type Pattern Notes
type
TN52TOG SRV1-{N}-{1-8,11-42,45-68}-{1-4}
TN52TOM SRV1-{N}-{1-8,11-42,45-68}-{1-4}
TN54TOA SRV1-{N}-{1-8,11-42,45-68}-{1-8}
TN52NQ2 SRV1-{N}-{1-8,11-42,45-68}-{1-16}
TN11LEX4 SRV1-{N}-{1-8,11-42,45-68}-{1–2}
TN11LEM24 SRV1-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-
59,61-67}-{1–2}
TN54NS3 SRV1-{N}-{1-8,11-42,45-68}-{1-16}
TN54NQ2 SRV1-{N}-{1-8,11-42,45-68}-{1-16}
TN52TOM SRV1-{N}-{1-8,11-42,45-68}-{1-4}-{1-2}
TN54TOA SRV1-{N}-{1-8,11-42,45-68}-{1-8}-{1–2}
TN54NS3 SRV1-{N}-{1-8,11-42,45-68}-{1-16}-{1-2}
TN54NQ2 SRV1-{N}-{1-8,11-42,45-68}-{1-16}-{1-2}
60,62-68}-1
TN52NQ2 SRV3-{N}-{1-8,11-42,45-68}-{1-4}
TN52ND2 SRV3-{N}-{1-8,11-42,45-68}-{1-2}
TN54NS3 SRV3-{N}-{1-8,11-42,45-68}-1
TN54NQ2 SRV3-{N}-{1-8,11-42,45-68}-{1-16}
TN12LDX FAC-{N}-{1-17}-{1,3,5,6}
TN12TMX FAC-{N}-{1-17}-{1,3-6}
TN11TMX FAC-{N}-{1-17}-{3-6}
TN11LSC FAC-{N}-{4-8,11-16}-1
TN11LSQ FAC-{N}-{2-8,12-16}-
{1,3}
TN12LSC FAC-{N}-{1-14}-1
TN11LTX FAC-{N}-{2-15}-1
AID type AID format Unit type Pattern Notes
TN55NS3 FAC-{N}-{2-8,12-16}-1
TN53NS2 FAC-{N}-{1-8,11-16}-{1}
TN53ND2 FAC-{N}-{1-8,11-16}-
{1,2}
TN53NQ2 FAC-{N}-{1-8,11-16}-{1-
4}
TN53NS2 FAC-{N}-{1-8,11-16}-1-
{1-4}
TN53ND2 FAC-{N}-{1-8,11-16}-
{1,2}-{1-4}
TN53NQ2 FAC-{N}-{1-8,11-16}-{1-
4}-{1-4}
TN11ND2 SRV2-{N}-{1-8,11-16}-
{1,2}
TN52ND2 SRV2-{N}-{1-8,11-16}-
{1-2}
TN52NQ2 SRV2-{N}-{1-8,11-16}-
{1-4}
TN52NS2 SRV2-{N}-{1-8,11-16}-1
TN51NQ2 SRV2-{N}-{1-8,11-16}-
{1-4}
TN52NS2 SRV2-{N}-{1-8,11-16}-1-
{1-4}
TN52ND2 SRV2-{N}-{1-8,11-16}-
AID type AID format Unit type Pattern Notes
{1-2}-{1-4}
TN12LSXL CLNT-{N}-{3-17}-1
TN53TQX CLNT-{N}-{1-8,11-16}-
{1–4}
TN12TDX CLNT-{N}-{1-8,11-16}-
TN52TDX {1,2}
TN12LOG CLNT-{N}-{1-8,11-16}-1
TN12LOM CLNT-{N}-{1-17}-1
TN11LOM CLNT-{N}-{1-16}-1
TN52TOG CLNT-{N}-{1-8,11-16}-
{1-8}
TN52TOM CLNT-{N}-{1-8,11-16}-
{1-8}
TN11TQX CLNT-{N}-{1-8,11-16}-
TN11TOM {1-4}
TN52TQX
TN11LEM24 CLNT-{N}-{1-7,11-16}-
{1–2}
TN11LEX4 CLNT-{N}-{1-8,11-17}-
{1–2}
TN12ND2 SRV1-{N}-{1-8,11-16}-
{1-2}
AID type AID format Unit type Pattern Notes
SRV2-{N}-{1-8,11-16}-
{1-2}
TN52TOG SRV1-{N}-{1-8,11-16}-
{1-4}
TN52TOM SRV1-{N}-{1-8,11-16}-
{1-4}
TN11TOM SRV1-{N}-{1-8,11-16}-
TN51NQ2 {1-4}
TN11LEX4 SRV1-{N}-{1-8,11-17}-
{1–2}
TN11LEM24 SRV1-{N}-{1-7,11-16}-
{1–2}
TN12LQMD SRV1-{N}-{1-8,11-16}-1-
TN13LQM {1,2}
TN12ND2 SRV1-{N}-{1-8,11-16}-
{1-2}-{1-4}
TN52TOM SRV1-{N}-{1-8,11-16}-
{1-4}-{1-2}
TN51NQ2 SRV1-{N}-{1-8,11-16}-
{1-4}-{1-4}
TN52NQ2 SRV3-{N}-{1-8,11-16}-
{1-4}
TN52ND2 SRV3-{N}-{1-8,11-16}-
{1-2}
TN52NS2 SRV3-{N}-{1-8,11-16}-1
TN54NS3 SRV3-{N}-{1-8,11-16}-1
TN52NS2 SRV2-{2-5}-1
TN11LOM CLNT-{3-5}-
1
TN52TOG CLNT-{2-5}-{1-8}
TN52TOM CLNT-{2-5}-{1-8}
TN11TOM CLNT-{2-5}-{1-4}
TN11LEM24 CLNT-{N}-{3-5}-{1–2}
TN11LEX4 CLNT-{N}-{2-5}-{1–2}
TN52TOM SRV1-{2-5}-{1-4}
TN11TOM SRV1-{2-5}-{1-4}
SRV1-M-X
TN11LEX4 SRV1-{N}-{2-5}-{1–2}
TN11LEM24 SRV1-{N}-{3-5}-{1–2}
TN12TMX FAC-{N}-{1-18}-{1,3-6}
TN11LSC FAC-{N}-{4-8,14-18}-1
TN11LSQ FAC-{N}-{2-8,12-18}-
{1,3}
TN12LSC FAC-{N}-{1-5,11-15}-1
TN54TSXL FAC-{N}-{1-8,11-18}-3
TN53NS2 FAC-{N}-{1-8,11-18}-
{1}
TN53ND2 FAC-{N}-{1-8,11-18}-
{1,2}
TN53NQ2 FAC-{N}-{1-8,11-18}-
{1-4}
TN11LTX FAC-{N}-{2-6,12-16}-1
TN55NS3 FAC-{N}-{2-8,12-18}-1
TN56NS3 FAC-{N}-{1-8,11-18}-1
AID type AID format Unit type Pattern Notes
TN55NS3 FAC-{N}-{2-8,12-18}-1-
{1–4}
TN56NS3 FAC-{N}-{1-8,11-18}-1-
{1–4}
TN53NS2 FAC-{N}-{1-8,11-18}-1-
{1-4}
TN53ND2 FAC-{N}-{1-8,11-18}-
{1,2}-{1-4}
TN53NQ2 FAC-{N}-{1-8,11-18}-
{1-4}-{1-4}
TN55NPO2E FAC-{N}-{3,7,13,17}-
{1}-{1-4}
TN55NPO2 FAC-{N}-{3,7,13,17}-
{1}-{1-4}
TN55NPO2(STND) FAC-{N}-{3,7,13,17}-
{1}-{1-4}
TN52ND2 SRV2-{N}-{1-8,11-18}-
{1-2}
TN54NS3 SRV2-{N}-{1-8,11-18}-1
TN52ND2 SRV2-{N}-{1-8,11-18}-
{1-2}-{1-4}
TN12LOG CLNT-{N}-{1-8,11-18}-1
TN12LOM CLNT-{N}-{1-18}-1
TN53TSXL CLNT-{N}-{1-8,11-18}-1
TN54TOA CLNT-{N}-{1-8,11-18}-
{1-8}
TN52TOG CLNT-{N}-{1-8,11-18}-
{1-8}
TN52TOM CLNT-{N}-{1-8,11-18}-
{1-8}
TN11LEM24 CLNT-{N}-{1-7,11-17}-
{1-2}
TN11LEX4 CLNT-{N}-{1-8,11-18}-
{1-2}
TN54TEM28 CLNT-{N}-{1-7,11-17}-
{1-16}
TN52ND2 SRV1-{N}-{1-8,11-18}-
{1-8}
TN52TOG SRV1-{N}-{1-8,11-18}-
{1-4}
TN52TOM SRV1-{N}-{1-8,11-18}-
{1-4}
TN54TOA SRV1-{N}-{1-8,11-18}-
{1-8}
TN11LEX4 SRV1-{N}-{1-8,11-18}-
{1–2}
TN11LEM24 SRV1-{N}-{1-7,11-17}-
{1–2}
TN52TOM SRV1-{N}-{1-8,11-18}-
{1-4}-{1-2}
TN54TOA SRV1-{N}-{1-8,11-18}-
{1-8}-{1–2}
TN54NQ2 SRV1-{N}-{1-8,11–18}-
{1-16}-{1–2}
TN54NS3 SRV3-{N}-{1-8,11-18}-1
TN55NS3 FAC-{N}-{2-8,12-18}-1–
{0}-{1-16}-{1–2}
TN56NS3 FAC-{N}-{1-8,11-18}-1–
{0}-{1-16}-{1–2}
OXC-NEPORT
Table D-189 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11WMU FAC-{N}-{1-8,11-27,29-36}-
TN11GFU {1-2}
TN12LSXLR FAC-{N}-{2-8,13-19,21-
27,30-36}-1
TN11MR8 FAC-{N}-{1-7,11-18,20-
TN12WSM9 26,29-35}-{1-10}
AID type AID format Unit type Pattern Notes
TN12WSD9
TN11WSMD4
TN11WSMD2 FAC-{N}-{1-7,11-18,20-
26,29-35}-{1-6}
TN13WSM9 FAC-{N}-{1-6,12-17,20-
TN13WSD9 25,29-34}-{1-10}
TN11RMU9 FAC-{N}-{1-8,11-27,29-36}-
{1-11}
TN11ROAM FAC-{N}-{1-6,11-17,20-
25,29-34}-{1-45}
TN12LWXS FAC-{N}-{1-8,12-27,29-36}-
TN12LSX {1,3}
TN13LSX
TN12LSXL FAC-{N}-{3-8,14-19,22-
27,31-36}-{1}
TN12OLP FAC-{N}-{1-8,12-27,29-36}-
TN11ITL {1-3}
TN12DCP FAC-{N}-{1-8,12-27,29-36}-
TN11MR4 {1-6}
TN11CMR4
TN11DMR1
TN11SBM2
TN11MR2 FAC-{N}-{1-8,11-27,29-36}-
TN11CMR2 {1-4}
TN11HBA FAC-{N}-{2-7,13-18,21-
26,30-35}-{1-4}
TN12VA4 FAC-{N}-{1-8,12-27,29-36}-
{1-4}
TN12OAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1, 4, 5,7,8}
TN12OBU1 FAC-{N}-{1-8,11-27,29-36}-
{1-2,4,5}
TN12OBU2 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1-2,4,5}
TN11OAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1, 4, 5}
AID type AID format Unit type Pattern Notes
TN11OBU1 FAC-{N}-{1-8,11-27,29-36}-
{1-2}
TN11OBU2 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1-2}
TN12LDX FAC-{N}-{1-8,12-27,29-36}-
{1,3,5,6}
TN11TMX FAC-{N}-{1-8,12-27,29-36}-
TN12TMX {1, 3-10}
TN11M40 FAC-{N}-{1-6,11-17,20-
TN11M40V 25,29-34}-{1-41}
TN11D40
TN11D40V
TN12LQMD FAC-{N}-{1-8,12-27,29-36}-
TN13LQM {1-6}
TN11SCS FAC-{N}-{1-8,11-27,29-36}-
{1-6}
TN11LOM FAC-{N}-{1-7,12-18,20-
26,29-35}-{1, 3-10}
TN11LOG FAC-{N}-{1-8,12-27,29-36}-
TN12LOG {1, 3-10}
TN11MR8V FAC-{N}-{1-7,12-18,20-
26,29-35}-{1-10}
TN52ND2 FAC-{N}-{1-8,12-27,29-36}-
{1-2}
TN52NQ2 FAC-{N}-{1-8,12-27,29-36}-
TN54NQ2 {1-4}
TN52NS2 FAC-{N}-{1-8,12-27,29-36}-
TN56NS3 {1}
TN52NS3 FAC-{N}-{2-8,13-19,21-
TN55NS3 27,30-36}-{1}
TN52TDX FAC-{N}-{1-8,12-27,29-36}-
{3-4}
TN52TOG FAC-{N}-{1-8,12-27,29-36}-
{3-10}
TN52TOM FAC-{N}-{1-8,12-27,29-36}-
TN54TOA {3-10}
AID type AID format Unit type Pattern Notes
TN52TQX FAC-{N}-{1-8,12-27,29-36}-
TN53TQX {3-6}
TN11LEM24 FAC-{N}-{1-7,12-18,20-
26,29-35}-{3-28}
TN11LEX4 FAC-{N}-{1-8,12-27,29-36}-
{3-8}
TN54NS3 FAC-{N}-{1-8,12-27,29-36}-
1
TN53TSXL FAC-{N}-{1-8,12-27,29-36}-
TN54TSXL {3}
TN11WSMD9 FAC-{N}-{1-7,12-18,20-
26,29-35}-{1–20}
TN11LTX FAC-{N}-{2-6,12-17,21-
25,30-34}-{1,3-12}
TN12LSC FAC-{N}-{1-5,12-16,20-
24,29-33}-{1,3}
TN11RAU1 FAC-{N}-{2-8,12-19,21-
27,30-36}-{1,3,4,5,9,10}
Table D-190 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11WMU FAC-{N}-{1-8,11-42,45-68}-
TN11GFU {1-2}
TN12LSXLR FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-1
TN11MR8 FAC-{N}-{1-7,11-17,19-
TN12WSM9 25,27-33,35-41,45-51,53-
TN12WSD9 59,61-67}-{1-10}
TN11WSMD4
TN11WSMD2 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-6}
TN13WSM9 FAC-{N}-{1-6,11-16,19-
AID type AID format Unit type Pattern Notes
TN13WSD9 24,27-32,35-40,45-50,53-
58,61-66}-{1-10}
TN11RMU9 FAC-{N}-{1-8,11-42,45-68}-
{1-11}
TN11ROAM FAC-{N}-{1-6,11-16,19-
24,27-32,35-40,45-50,53-
58,61-66}-{1-45}
TN12LWXS FAC-{N}-{1-8,11-42,45-68}-
TN12LSX {1,3}
TN13LSX
TN12LSXL FAC-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-
60,63-68}-{1}
TN12OLP FAC-{N}-{1-8,11-42,45-68}-
TN11ITL {1-3}
TN12DCP FAC-{N}-{1-8,11-42,45-68}-
TN11MR4 {1-6}
TN11CMR4
TN11DMR1
TN11SBM2
TN11MR2 FAC-{N}-{1-8,11-42,45-68}-
TN11CMR2 {1-4}
TN11HBA FAC-{N}-{2-7,12-17,20-
25,28-33,36-41,46-51,54-
59,62-67}-{1-4}
TN12VA4 FAC-{N}-{1-8,11-42,45-68}-
{1-4}
TN12OAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1, 4, 5,7,8}
TN12OBU1 FAC-{N}-{1-8,11-42,45-68}-
{1-2,4,5}
TN12OBU2 FAC-{N}-{1-8,11-42,45-68}-
{1-2,4,5}
TN11OAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1, 4, 5}
TN11OBU1 FAC-{N}-{1-8,11-42,45-68}-
AID type AID format Unit type Pattern Notes
{1-2}
TN11OBU2 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1-2}
TN12LDX FAC-{N}-{1-8,11-42,45-68}-
{1,3,5,6}
TN11TMX FAC-{N}-{1-8,11-42,45-68}-
TN12TMX {1, 3-10}
TN11M40 FAC-{N}-{1-6,11-16,19-
TN11M40V 24,27-32,35-40,45-50,53-
TN11D40 58,61-66}-{1-41}
TN11D40V
TN12LQMD FAC-{N}-{1-8,11-42,45-68}-
TN13LQM {1-6}
TN11SCS FAC-{N}-{1-8,11-42,45-68}-
{1-6}
TN11LOM FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1, 3-10}
TN11LOG FAC-{N}-{1-8,11-42,45-68}-
TN12LOG {1, 3-10}
TN11MR8V FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-10}
TN52ND2 FAC-{N}-{1-8,11-42,45-68}-
{1-2}
TN52NQ2 FAC-{N}-{1-8,11-42,45-68}-
TN54NQ2 {1-4}
TN52NS2 FAC-{N}-{1-8,11-42,45-68}-
TN56NS3 {1}
TN52NS3 FAC-{N}-{2-8,12-18,20-
TN55NS3 26,28-34,36-42,46-52,54-
60,62-68}-{1}
TN52TDX FAC-{N}-{1-8,11-42,45-68}-
{3-4}
TN52TOG FAC-{N}-{1-8,11-42,45-68}-
{3-10}
AID type AID format Unit type Pattern Notes
TN52TOM FAC-{N}-{1-8,11-42,45-68}-
TN54TOA {3-10}
TN52TQX FAC-{N}-{1-8,11-42,45-68}-
TN53TQX {3-6}
TN11LEM24 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{3-28}
TN11LEX4 FAC-{N}-{1-8,11-42,45-68}-
{3-8}
TN54NS3 FAC-{N}-{1-8,11-42,45-68}-
1
TN53TSXL FAC-{N}-{1-8,11-42,45-68}-
TN54TSXL {3}
TN11WSMD9 FAC-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-
59,61-67}-{1-20}
TN11LTX FAC-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}-{1,3-12}
TN12LSC FAC-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}-{1,3}
TN11RAU1 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-{1,3,4,5,9,10}
Table D-191 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11WMU FAC-{N}-{1-17}-{1-2}
TN11GFU
TN12LSXLR FAC-{N}-{2-17}-1
TN11NS3
AID type AID format Unit type Pattern Notes
TN12TDX FAC-{N}-{1-8,11-16}-{3-4}
TN11ND2 FAC-{N}-{1-8,11-16}-{1-2}
TN12ND2
TN51NQ2 FAC-{N}-{1-8,11-16}-{1-4}
TN11MR8 FAC-{N}-{1-16}-{1-10}
TN12WSM9
TN12WSD9
TN11WSMD4
TN13WSM9 FAC-{N}-{1-15}-{1-10}
TN13WSD9
TN11RMU9 FAC-{N}-{1-17}-{1-11}
TN11ROAM FAC-{N}-{1-15}-{1-45}
TN12LWXS FAC-{N}-{1-17}-{1,3}
TN12LSX
TN13LSX
TN12LSXL FAC-{N}-{3-17}-{1}
TN12OLP FAC-{N}-{1-17}-{1-3}
TN11ITL
TN12DCP FAC-{N}-{1-17}-{1-6}
TN11MR4
TN11CMR4
TN11DMR1
TN11SBM2
TN11MR2 FAC-{N}-{1-17}-{1-4}
TN11CMR2
TN11HBA FAC-{N}-{2-16}-{1-4}
TN12TQM FAC-{N}-{1-8,11-16}-{3-6}
TN11TQX
TN53TQX
TN12VA4 FAC-{N}-{1-17}-{1-4}
TN12OAU1 FAC-{N}-{2-17}-{1, 4,
5,7,8}
TN12OBU1 FAC-{N}-{1-17}-{1-2,4,5}
TN12OBU2 FAC-{N}-{2-17}-{1-2,4,5}
AID type AID format Unit type Pattern Notes
TN11OAU1 FAC-{N}-{2-17}-{1, 4, 5}
TN11OBU1 FAC-{N}-{1-17}-{1-2}
TN11OBU2 FAC-{N}-{2-17}-{1-2}
TN12LDX FAC-{N}-{1-17}-{1,3,5,6}
TN11LQG FAC-{N}-{1-8,11-16}-{1, 3-
TN12LQMS 6}
TN11M40 FAC-{N}-{1-15}-{1-41}
TN11M40V
TN11D40
TN11D40V
TN12LQMD FAC-{N}-{1-8,11-16}-{1-6}
TN13LQM
TN11L4G FAC-{N}-{1-8,11-16}-{1, 3-
8}
TN11SCS FAC-{N}-{1-17}-{1-6}
TN11TOM FAC-{N}-{1-8,11-16}-{3-
10}
TN11LOG FAC-{N}-{1-8,11-16}-{1, 3-
TN12LOG 10}
TN11TBE FAC-{N}-{1-8,11-16}-{3-
11}
TN11LEM24 FAC-{N}-{1-7,11-16}-{3-
28}
TN11LEX4 FAC-{N}-{1-8,11-17}-{3-8}
TN54NS3 FAC-{N}-{1-8,11-16}-{1}
TN11DAS1 FAC-{1-17}-{1,9,12}
TN11WSMD2 FAC-{N}-{1-16}-{1-6}
TN11LSC FAC-{N}-{4-8,11-16}-{1-2}
TN11WSMD9 FAC-{N}-{1-16}-{1-20}
AID type AID format Unit type Pattern Notes
TN55NS3 FAC-{N}-{2-8,12-16}-{1}
TN11LTX FAC-{N}-{2-15}-{1,3-12}
TN12LSC FAC-{N}-{1-14}-{1,3}
TN11RAU1 FAC-{N}-{2-17}-
{1,3,4,5,9,10}
Table D-192 AID 3800A values
AID type AID format Unit type Pattern Notes
TN12LSX FAC-{2-5,11}-{1,3}
TN13LSX
TN12LWXS
TN12LDX FAC-{2-5,11}-{1,3,5,6}
TN12OLP FAC-{2-5,11}-{1-3}
TN12DCP FAC-{2-5,11}-{1-6}
TN11DMR1
TN11SBM2 FAC-{2-5,11}-{1-6}
TN12TQM FAC-{2-5}-{3-6}
TN12VA4 FAC-{2-5,11}-{1-4}
TN12OAU1 FAC-{2-4,11}-{1,4,5,7,8}
TN12OBU1 FAC-{2-5,11}-{1,2,4,5}
TN12OBU2 FAC-{2-4,11}-{1,2,4,5}
TN11OAU1 FAC-{2-4,11}-{1,4,5}
TN11OBU1 FAC-{2-5,11}-{1,2}
TN11OBU2 FAC-{2-4,11}-{1,2}
TN11LQG FAC-{2-5}-{1,3-6}
TN12LQMS
TN11TMX FAC-{2-5,11}-{1,3-10}
TN12TMX
AID type AID format Unit type Pattern Notes
TN12LQMD FAC-{2-5}-{1-6}
TN13LQM
TN11L4G FAC-{2-5}-{1,3-8}
TN11SCS FAC-{2-5,11}-{1-6}
TN11TOM FAC-{2-5}-{3-10}
TN11LOG FAC-{2-5}-{1,3-10}
TN12LOG
TN11LOM FAC-{3-5}-{1,3-10}
TN11TBE FAC-{2-5}-{3-11}
TN11LEM24 FAC-{3-5}-{3-4}
TN11LEX4 FAC-{2-5}-{3-4}
TN11DAS1 FAC-{2-5}-{1,9,12}
TN11RAU1 FAC-{2-4,11}-
{1,3,4,5,9,10}
Table D-193 Table 5 AID 8800 T16values
AID type AID format Unit type Pattern Notes
TN13WSM9 FAC-{N}-{1-6,11-
TN13WSD9 16}-{1-10}
TN11RMU9 FAC-{N}-{1-18}-
{1-11}
TN12LWXS FAC-{N}-{1-18}-
TN13LSX {1,3}
TN12OLP FAC-{N}-{1-18}-
TN11ITL {1-3}
TN12DCP FAC-{N}-{1-18}-
TN11MR4 {1-6}
TN11CMR4
TN11MR2 FAC-{N}-{1-17}-
TN11CMR2 {1-4}
AID type AID format Unit type Pattern Notes
TN11HBA FAC-{N}-{2-7,12-
17}-{1-4}
TN53TQX FAC-{N}-{1-8,11-
18}-{3-6}
TN12VA4 FAC-{N}-{1-18}-
{1-4}
TN12OAU1 FAC-{N}-{2-17}-
{1, 4, 5,7,8}
TN12OBU1 FAC-{N}-{1-18}-
{1-2,4,5}
TN12OBU2 FAC-{N}-{2-8,12-
18}-{1-2,4,5}
TN11OAU1 FAC-{N}-{2-17}-
{1, 4, 5}
TN12LDX FAC-{N}-{1-18}-
{1,3,5,6}
TN11M40 FAC-{N}-{1-6,11-
TN11M40V 16}-{1-41}
TN11D40
TN11SCS FAC-{N}-{1-18}-
{1-6}
TN11LEM24 FAC-{N}-{1-7,11-
17}-{3-28}
TN11LEX4 FAC-{N}-{1-8,11-
18}-{3-8}
TN54NS3 FAC-{N}-{1-8,11-
18}-{1}
TN11DAS1 FAC-{1-18}-
{1,9,12}
TN11LSC FAC-{N}-{4-8,14-
18}-{1-2}
TN11WSMD9 FAC-{N}-{1-7,11-
17}-{1-20}
TN11LTX FAC-{N}-{2-6,12-
16}-{1,3-12}
TN12LSC FAC-{N}-{1-5,11-
AID type AID format Unit type Pattern Notes
15}-{1,3}
TN11RAU1 FAC-{N}-{2-8,12-
18}-{1,3,4,5,9,10}
TN55NS3 FAC-{N}-{2-8,12-
18}-{1}
TN56NS3 FAC-{N}-{1-8,11-
18}-{1}
TN54TSXL FAC-{N}-{1-8,11-
18}-{3}
PORT
Table D-194 AID 8800 T32 values
AID format Unit type Pattern
TN11SFIU
TN11DCU
TN11TDC
TN11HSC1
TN11RDU9
TN12LOM
TN52ND2
TN52NQ2
TN52NS2
TN52TDX
TN52TOG
TN52TOM
TN52TQX
TN54NQ2
TN54NS3
TN53TSXL
TN11LEX4
TN13LQM
TN51NQ2
TN11LOG
TN12LOG
TN11LQG
TN12LQMD
TN12LQMS
TN11DAS1
TN53TQX
TN54TOA
TN56NS3
TN54TSXL
TN11OAU1 SLOT-{N}-{2-8,12-19,21-
TN11OBU2 27,30-36}
TN12OAU1
TN12OBU2
TN12LSXLR
TN11LSQ
TN11RAU1
TN11MR8 SLOT-{N}-{1-7,11-18,20-
TN11LOM 26,29-35}
TN11MCA4
TN11MCA8
TN11WSMD4
TN11WSMD2
AID format Unit type Pattern
TN12WSM9
TN12WSD9
TN12LSXL SLOT-{N}-{3-8,14-19,22-
27,31-36}
TN11M40 SLOT-{N}-{1-6,11-17,20-
TN11M40V 25,29-34}
TN11D40
TN11D40V
TN11ROAM
TN13WSM9
TN13WSD9
TN11HBA SLOT-{N}-{2-7,13-18,21-
26,30-35}
TN11ROP SLOT-{N}-{124-127}
TN11CRPC SLOT-{N}-{120-123}
TN52XCH SLOT-{N}-{9-10}
TN53XCH
TN51SCC SLOT-{N}-{11,28}
TN52SCC
TN11MR8V SLOT-{N}-{1-7,12-18,20-
TN11WSMD9 26,29-35}
TNK2STG SLOT-{N}-{42,44}
TN11LSQ SLOT-{N}-{2-8,13-19,21-
TN52NS3 27,30-36}
TN55NS3
TN11LEM24 SLOT-{N}-{1-7,12-18,20-
TN54TEM28 26,29-35}
TN11OPM8 SLOT-{N}-{1-8,11-27,29-36}
TN12WSMD2 SLOT-{N}-{1-7,12-18,20-
TN12WSMD4 26,29-35}
TN14WSM9
TN11LSC SLOT-{N}-{4-8,14-19,23-
27,32-36}
TN11LTX SLOT-{N}-{2-6,12-17,21-
25,30-34}
AID format Unit type Pattern
TN12LSC SLOT-{N}-{1-5,12-16,20-
24,29-33}
Table D-195 AID 8800 T64 values
AID format Unit type Pattern
TN12LOM
TN52ND2
TN52NQ2
TN52NS2
TN52TDX
TN52TOG
TN52TOM
TN52TQX
TN54NQ2
TN54NS3
TN53TSXL
TN11LEX4
TN11OPM8
TN11DAS1
TN53TQX
TN54TOA
TN56NS3
TN54TSXL
TN11OAU1 SLOT-{N}-{2-8,12-18,20-
TN11OBU2 26,28-34,36-42,46-52,54-60,62-
TN12OAU1 68}
TN12OBU2
TN12LSXLR
TN11LSQ
TN11RAU1
TN11MR8 SLOT-{N}-{1-7,11-17,19-
TN11LOM 25,27-33,35-41,45-51,53-59,61-
TN11MCA4 67}
TN11MCA8
TN11WSMD4
TN11WSMD2
TN12WSM9
TN12WSD9
TN11WSMD9
TN12LSXL SLOT-{N}-{3-8,13-18,21-
26,29-34,37-42,47-52,55-60,63-
68}
TN11M40 SLOT-{N}-{1-6,11-16,19-
TN11M40V 24,27-32,35-40,45-50,53-58,61-
TN11D40 66}
TN11D40V
TN11ROAM
AID format Unit type Pattern
TN13WSM9
TN13WSD9
TN11HBA SLOT-{N}-{2-7,12-17,20-
25,28-33,36-41,46-51,54-59,62-
67}
TN11ROP SLOT-{N}-{124-127}
TN11CRPC SLOT-{N}-{120-123}
TN11MR8V SLOT-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-59,61-
67}
TN11LSQ SLOT-{N}-{2-8,12-18,20-
TN52NS3 26,28-34,36-42,46-52,54-60,62-
TN55NS3 68}
TN11LEM24 SLOT-{N}-{1-7,11-17,19-
TN54TEM28 25,27-33,35-41,45-51,53-59,61-
67}
TN12WSMD2 SLOT-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-59,61-
67}
TN12WSMD4 SLOT-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-59,61-
67}
TN14WSM9 SLOT-{N}-{1-7,11-17,19-
25,27-33,35-41,45-51,53-59,61-
67}
TN11LSC SLOT-{N}-{4-8,14-18,22-
26,30-34,38-42,48-52,56-60,64-
68}
TN11LTX SLOT-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-58,62-
66}
TN12LSC SLOT-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-57,61-
65}
Table D-196 AID 6800A values
AID format Unit type Pattern
TN55NS3
TN11LSXR SLOT-{N}-{1-17}
TN12LSX
TN13LSX
TN12LDX
TN11MR2
TN11MR4
TN11CMR2
TN11CMR4
TN12SC1
TN12SC2
TN11ST2
TN11SCS
TN12LWXS
TN11GFU
TN11RMU9
TN11WMU
TN11TMX
TN12TMX
TN11DMR1
TN11SBM2
TN11TOM
TN11ITL
TN12DCP
TN12OLP
TN12VA1
TN12VA4
TN11OBU1
TN12OBU1
TN13FIU
TN11SFIU
TN11DCU
TN11TDC
TN11OAU1 SLOT-{N}-{2-17}
TN11OBU2
TN12OAU1
TN12OBU2
TN12LSXLR
TN11LSQ
TN11RAU1
TN11MR8 SLOT-{N}-{1-16}
TN11LOM
AID format Unit type Pattern
TN11MCA4
TN11MCA8
TN11WSMD4
TN11WSMD2
TN12WSM9
TN12WSD9
TN11WSMD9
TN12NS2 SLOT-{N}-{1-8,11-16}
TN13LQM
TN11TOM
TN11ND2
TN12ND2
TN12TDX
TN12TQM
TN11TQX
TN51NQ2
TN11TBE
TN11LOG
TN12LOG
TN11L4G
TN11LQG
TN12LQMD
TN12LQMS
TN53TQX
TN12LSXL SLOT-{N}-{3-17}
TN11M40 SLOT-{N}-{1-15}
TN11M40V
TN11D40
TN11D40V
TN11ROAM
TN13WSM9
TN13WSD9
TN11HBA SLOT-{N}-{2-16}
TN11ROP SLOT-{N}-{124-127}
TN11CRPC SLOT-{N}-{120-123}
TN54NS3 SLOT-{N}-{1-8,11-16}
TN11LSQ SLOT-{N}-{2-8,12-16}
TN11LEM24 SLOT-{N}-{1-7,11-16}
AID format Unit type Pattern
TN11LEX4 SLOT-{N}-{1-8,11-17}
TN11OPM8 SLOT-{N}-{1-17}
TN11DAS1
TN12WSMD2 SLOT-{N}-{1-16}
TN12WSMD4 SLOT-{N}-{2010-01-16}
TN14WSM9 SLOT-{N}-{1-16}
TN11LSC SLOT-{N}-{14-8,11-16}
TN11LTX SLOT-{N}-{2-15}
TN12LSC SLOT-{N}-{1-14}
Table D-197 AID 3800A values
AID format Unit type Pattern
TN11DMR1 SLOT-{2-5}
TN11ACS
TN11MCA4
TN11MCA8
TN12NS2
TN12LQMD
TN13LQM
TN12TQM
AID format Unit type Pattern
TN11MR2
TN11MR4
TN11CMR2
TN11CMR4
TN11TBE
TN11LOG
TN12LOG
TN11L4G
TN11LQG
TN12LQMS
TN11TOM
TN12DCP
TN12OLP
TN11DAS1
TN21CMR1 SLOT-{1,8,11}
TN21CMR2
TN21DFIU
TN21FIU
TN21DMR1
TN12VA1
TN12VA4
TN12VA4
TN11DCU
TN11OBU1
TN12OBU1
TN11LOM SLOT-{3-5}
TN11OAU1 SLOT-{2-4,11}
TN11OBU2
TN12OAU1
TN12OBU2
TN11LEM24 SLOT-{N}-{3-5}
TN11LEX4 SLOT-{N}-{2-5}
TN11OPM8 SLOT-{N}-{2-5,11}
Table D-198 AID 8800 T16 values
AID format Unit type Pattern
TN11CMR4
TN12SC1
TN12SC2
TN11DCU
TN12VA1
TN12VA4
TN12OLP
TN12DCP
TN11GFU
TN12LWXS
TN13LSX
TN12LDX
TN12TMX
TN12LOM
TN12OBU1
TN11HSC1
TN11ITL
TN13FIU
TN11OPM8
TN11RMU9
TN11WMU
TN11TDC
TN11RDU9
TN11CRPC SLOT-{N}-{120-123}
TN11ROP SLOT-{N}-{124-127}
TN11M40 SLOT-{N}-{1-6,11-16}
TN11D40
TN11M40V
TN13WSM9
TN13WSD9
TN14WSM9 SLOT-{N}-{1-7,11-17}
TN11MR8V
TN11LEM24
TN12WSMD4
TN11WSMD9
TN11MCA4
TN11MCA8
TN54TEM28
TN12LOG SLOT-{N}-{1-8,11-18}
TN52TOM
TN52TOG
AID format Unit type Pattern
TN11DAS1
TN52ND2
TN52TQX
TN52TDX
TN11LEX4
TN54NS3
TN53TQX
TN53TSXL
TN54NQ2
TN54TOA
TN11ST2
TN56NS3
TN54TSXL
TN11HBA SLOT-{N}-{2-7,12-17}
TN12OAU1 SLOT-{N}-{2-8,12-18}
TN12OBU2
TN11LSQ
TN55NS3
TN11RAU1
TN11LSC SLOT-{N}-{4-8,14-18}
TN11LTX SLOT-{N}-{2-6,12-16}
TN12LSC SLOT-{N}-{1-5,11-15}
PROTNSW-EQPT
Table D-199 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TNK2SXH SLOT-{N}-{10,44}
Table D-200 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN52STG SLOT-{N}-{42,44}
TN52XCH SLOT-{N}-{9-10}
SLOT-N-M RLS-
TN53XCH SLOT-{N}-{9-10} PROTNSW-
EQPT
Table D-201 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11TBE SLOT-{N}-{1-8,11-16}
TN11L4G SLOT-{N}-{1-8,11-16}
Table D-202 AID 3800A values
AID type AID format Unit type Pattern Notes
TDC
Table D-204 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11TDC FAC-{N}-{1-8,11-27,29-
AID type AID format Unit type Pattern Notes
36}-1
TN12LSXLR FAC-{N}-{2-8,13-19,21-
27,30-36}-1
TN11LSQ FAC-{N}-{2-8,13-19,21-
27,30-36}-1
TN54NS3 FAC-{N}-{1-8,12-27,29-
36}-1
TN55NS3 FAC-{N}-{2-8,13-19,21-
27,30-36}-1
TN56NS3 FAC-{N}-{1-8,12-27,29-
36}-1
TN11LTX FAC-{N}-{2-6,12-17,21-
25,30-34}-1
TN12LSC FAC-{N}-{1-5,12-16,20-
24,29-33}-1
Table D-205 AID 8800 T64 values
AID type AID format Unit type Pattern Notes
TN11TDC FAC-{N}-{1-8,11-42,45-
68}-1
TN12LSXLR FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-1
TN11LSQ FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-1
TN54NS3 FAC-{N}-{1-8,11-42,45-
68}-1
TN55NS3 FAC-{N}-{2-8,12-18,20-
26,28-34,36-42,46-52,54-
60,62-68}-1
TN56NS3 FAC-{N}-{1-8,11-42,45-
68}-1
AID type AID format Unit type Pattern Notes
TN11LTX FAC-{N}-{2-6,12-16,20-
24,28-32,36-40,46-50,54-
58,62-66}-1
TN12LSC FAC-{N}-{1-5,11-15,19-
23,27-31,35-39,45-49,53-
57,61-65}-1
Table D-206 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11TDC FAC-{N}-{1-17}-1
TN12LSXLR FAC-{N}-{2-17}-1
TN11LSQ FAC-{N}-{2-8,12-16}-1
TN54NS3 FAC-{N}-{1-8,11-16}-1
TN55NS3 FAC-{N}-{2-8,12-16}-1
TN11LTX FAC-{N}-{2-15}-1
TN12LSC FAC-{N}-{1-14}-1
Table D-207 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
TN11LSQ FAC-{N}-{2-8,12-
18}-1
TN54NS3 FAC-{N}-{1-8,11-
18}-1
TN55NS3 FAC-{N}-{2-8,12-
18}-1
TN56NS3 FAC-{N}-{1-8,11-
18}-1
TN11LTX FAC-{N}-{2-6,12-
16}-1
AID type AID format Unit type Pattern Notes
TN12LSC FAC-{N}-{1-5,11-
15}-1
TRAFFICMOD2
Table D-208 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN12LOM CLNT-{N}-{1-8,12-
27,29-36}-1-{1-8}
TN52TOM CLNT-{N}-{1-8,12-
27,29-36}-{1-2}-{1-8}
CLNT-{N}-{1-8,12-
27,29-36}-{3,5,6}-{1-4}
CLNT-{N}-{1-8,12-
27,29-36}-{4,7,8}-{1-2}
TN54T0A CLNT-{N}-{1-8,12-
27,29-36}-{1-8}-{1-8}
TN12LOM CLNT-{N}-{1-8,11-
42,45-68}-1-{1-8}
TN52TOM CLNT-{N}-{1-8,11-
42,45-68}-{1-2}-{1-8}
CLNT-{N}-{1-8,11-
42,45-68}-{3,5,6}-{1-4}
CLNT-{N}-{1-8,11-
42,45-68}-{4,7,8}-{1-2}
TN54T0A CLNT-{N}-{1-8,11-
42,45-68}-{1-8}-{1-8}
TN11TOM CLNT-{N}-{1-8,11-16}-
1-{1-8}
CLNT-{N}-{1-8,11-16}-
{2,4}-{1-2}
CLNT-{N}-{1-8,11-16}-
3-{1-4}
TN12LOM CLNT-{N}-{1-17}-1-{1-
8}
AID type AID format Unit type Pattern Notes
TN52TOM CLNT-{N}-{1-8,11-16}-
{1-2}-{1-8}
CLNT-{N}-{1-8,11-16}-
{3,5,6}-{1-4}
CLNT-{N}-{1-8,11-16}-
{4,7,8}-{1-2}
TN11TOM CLNT-{N}-{2-5}-1-{1-8}
CLNT-{N}-{2-5}-{2,4}-
{1-2}
CLNT-{N}-{2-5}-3-{1-4}
TN12LOM CLNT-{2-5,11}-1-{1-8}
TN52TOM CLNT-{N}-{2-5}-{1-2}-
{1-8}
CLNT-{N}-{2-5}-
{3,5,6}-{1-4}
CLNT-{N}-{2-5}-
{4,7,8}-{1-2}
TN54T0A CLNT-{N}-{1-
8,11-18}-{1-8}-
{1-8}
TST
Table D-213 AID 8800 T32 values
AID AID format Unit type Pattern Notes
type
TN11LEM24 SRV1-{N}-{1-7,12-
AID AID format Unit type Pattern Notes
type
18,20-26,29-35}-1
TN52NS2 SRV3-{N}-{1-8,12-
27,29-36}-{1}-1
TN54NQ2 SRV3-{N}-{1-8,12-
27,29-36}-{1-4}
TN54NS3 SRV3-{N}-{1-8,12-
27,29-36}-1
TN54TOA CLNT-{N}-{1-8,12-
27,29-36}-{1-8}-{1-8}
TN12LSXL CLNT-{N}-{3-8,14-
19,22-27,31-36}-1
TN52TDX CLNT-{N}-{1-8,12-
27,29-36}-{1-2}
TN52TQX CLNT-{N}-{1-8,12-
AID AID format Unit type Pattern Notes
type
27,29-36}-{1-4}
TN52TOG CLNT-{N}-{1-8,12-
27,29-36}-{1-8}
CLNT-{N}-{1-8,12-
TN12LOM
27,29-36}-{1}
TN53TSXL CLNT-{N}-{1-8,12-
27,29-36}-{1}
TN53TQX CLNT-{N}-{1-8,12-
27,29-36}-{1-4}
TN11TMX FAC-{N}-{1-8,12-
TN12TMX 27,29-36}-{1,3-6}
FAC-{N}-{2-8,13-
TN11LSQ
19,21-27,30-36}-{1,3}
FAC-{N}-{4-8,14-
TN11LSC
18}-{1}
FAC-{N}-{2-8,13-
TN55NS3
19,21-27,30-36}-{1}
FAC-{N}-{1-8,12-
TN56NS3
27,29-36}-{1}
FAC-{N}-{2-6,12-
TN11LTX 17,21-25,30-34}-{1,3–
12}
FAC-{N}-{1-5,12-
TN12LSC
16,20-24,29-33}-{1}
TN11LEM24 SRV1-{N}-{1-7,11-
17,19-25,27-33,35-
41,45-51,53-59,61-
67}-1
TN52NS2 SRV3-{N}-{1-8,11-
42,45-68}-{1}
TN54NQ2 SRV3-{N}-{1-8,11-
42,45-68}-{1-4}
TN54NS3 SRV3-{N}-{1-8,11-
42,45-68}-1
TN54TOA CLNT-{N}-{1-8,11-
42,45-68}-{1-8}-{1-8}
TN11LOG CLNT-{N}-{1-8,11-
TN12LOG 42,45-68}-1
TN12LSXL CLNT-{N}-{3-8,13-
18,21-26,29-34,37-
42,47-52,55-60,63-
68}-1
TN52TDX CLNT-{N}-{1-8,11-
42,45-68}-{1-2}
TN52TQX CLNT-{N}-{1-8,11-
42,45-68}-{1-4}
TN52TOG CLNT-{N}-{1-8,11-
42,45-68}-{1-8}
FAC-{N}-{1-8,11-
TN12LOM
42,45-68}-{1}
TN53TSXL CLNT-{N}-{1-8,11-
42,45-68}-{1}
TN53TQX CLNT-{N}-{1-8,11-
42,45-68}-{1-4}
TN11TMX FAC-{N}-{1-8,11-
TN12TMX 42,45-68}-{1,3-6}
FAC-{N}-{2-8,12-
18,20-26,28-34,36-
TN11LSQ
42,46-52,54-60,62-
68}-{1,3}
TN11LSC FAC-{N}-{4-8,14-
18,22-26,30-34,38-
42,48-52,56-60,64-
68}-{1}
AID AID format Unit type Pattern Notes
type
FAC-{N}-{2-8,12-
18,20-26,28-34,36-
TN55NS3
42,46-52,54-60,62-
68}-{1}
FAC-{N}-{1-8,11-
TN56NS3
42,45-68}-{1}
FAC-{N}-{2-6,12-
16,20-24,28-32,36-
TN11LTX
40,46-50,54-58,62-
66}-{1,3–12}
FAC-{N}-{1-5,11-
15,19-23,27-31,35-
TN12LSC
39,45-49,53-57,61-
65}-{1}
FAC-{N}-{1-8,11-
TN54TSXL
42,45-68}-{3}
Table D-215 AID 6800A values
AID AID format Unit type Pattern Notes
type
TN11LEX4 SRV1-{N}-{1-8,11-
17}-1
TN11LEM24 SRV1-{N}-{1-7,11-
16}-1
AID AID format Unit type Pattern Notes
type
TN11NS3 SRV2-{N}-{2-8,12-
16}-1
TN51NQ2 SRV2-{N}-{1-8,11-
16}-{1-4}
TN12LSXL CLNT-{N}-{3-17}-1
TN11LQG CLNT-{N}-{1-8,11-
16}-1
TN12TDX CLNT-{N}-{1-8,11-
16}-{1,2}
TN11TQX CLNT-{N}-{1-8,11-
16}-{1-4}
TN52TQX CLNT-{N}-{1-8,11-
16}-{1-4}
TN53TQX CLNT-{N}-{1-8,11-
16}-{1-4}
TN11TMX FAC-{N}-{1-17}-
TN12TMX {1,3-6}
AID AID format Unit type Pattern Notes
type
FAC-{N}-{2-8,12-
TN11LSQ
16}-{1,3}
FAC-{N}-{4-8,11-
TN11LSC
16}-{1}
FAC-{N}-{2-15}-
TN11LTX
{1,3–12}
TN12LSC FAC-{N}-{1-14}-{1}
TN11LEM24 SRV1-{3-5}-1
TN11TOM CLNT-{2-5}-{1-4}-
{1-4}
TN11LOG CLNT-{2-5}-1
TN12LOG
CLNT-M-X
TN11LQG CLNT-{2-5}-1
TN11TMX FAC-{2-5,11}-{1,3-6}
TN12TMX
Table D-217 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
TN54TOA CLNT-{N}-{1-
8,11-18}-{1-
16}-{1-8}
TN52TQX CLNT-{N}-{1-
8,11-18}-{1-4}
TN52TOG CLNT-{N}-{1-
8,11-18}-{1-8}
TN12LOM FAC-{N}-{1-
18}-{1}
TN53TSXL CLNT-{N}-{1-
8,11-18}-{1}
TN53TQX CLNT-{N}-{1-
8,11-18}-{1-4}
TN12TMX FAC-{N}-{1-
18}-{1,3-6}
TN11LSQ FAC-{N}-{2-
8,12-18}-{1,3}
TN11LSC FAC-{N}-{4-
8,14-18}-{1}
FAC-{N}-{2-
TN55NS3
8,12-18}-{1}
FAC-{N}-{1-
TN56NS3
8,11-18}-{1}
FAC-{N}-{2-
TN11LTX 6,12-16}-{1,3–
12}
FAC-{N}-{1-
TN12LSC
5,11-15}-{1}
WDM
Table D-218 AID 8800 T32 values
AID type AID format Unit type Pattern Notes
TN11MR8 FAC-{N}-{1-7,11-18,20-26,29-35}-
{9-10}
TN11MR8V FAC-{N}-{1-7,12-18,20-26,29-35}-
{9-12}
TN11DMR1 FAC-{N}-{1-8,12-27,29-36}-{3-6}
TN11ROAM FAC-{N}-{1-6,11-17,20-25,29-34}-
{1-5}
TN12WSD9 FAC-{N}-{1-7,12-18,20-26,29-35}-
TN12WSM9 {1-12}
TN11WSMD4
TN12WSMD4
TN11WSMD2 FAC-{N}-{1-7,12-18,20-26,29-35}-
TN12WSMD2 {1-8}
TN14WSM9 FAC-{N}-{1-7,12-18,20-26,29-35}-
{1-12}
TN13WSD9 FAC-{N}-{1-6,12-17,20-25,29-34}-
TN13WSM9 {1-12}
TN11RMU9 FAC-{N}-{1-8,11-27,29-36}-{1-
TN11RDU9 13}
TN11M40 FAC-{N}-{1-6,11-17,20-25,29-34}-
TN11M40V {1-42}
TN11D40
TN11D40V
TN13FIU FAC-{N}-{1-8,12-27,29-36}-{1-4}
TN11ITL
TN12OLP FAC-{N}-{1-8,12-27,29-36}-{1-3}
TN11GFU
TN11HBA FAC-{N}-{2-7,13-18,21-26,30-35}-
{1-3}
TN12DCP FAC-{N}-{1-8,12-27,29-36}-{1-6}
AID type AID format Unit type Pattern Notes
TN11OPM8 FAC-{N}-{1-8,11-27,29-36}-{1-8}
TN11MCA4 FAC-{N}-{1-7,11-18,20-26,29-35}-
{1-4}
TN11MCA8 FAC-{N}-{1-7,11-18,20-26,29-35}-
{1-8}
TN12VA1 FAC-{N}-{1-8,12-27,29-36}-1
TN11TDC
TN12VA4 FAC-{N}-{1-8,12-27,29-36}-{1-4}
TN11SCS FAC-{N}-{1-8,11-27,29-36}-{1-6}
TN11DCU FAC-{N}-{1-8,11-27,29-36}-{1-2}
TN11WMU FAC-{N}-{1-8,11-27,29-36}-{1-2}
TN11CRPC FAC-{N}-{120-123}-{1-3}
TN11ROP FAC-{N}-{124-127}-{1-3}
TN12OBU1 FAC-{N}-{1-8,11-27,29-36}-{1-5}
TN12OBU2 FAC-{N}-{2-8,12-19,21-27,30-36}-
{1-5}
TN12OAU1 FAC-{N}-{2-8,12-19,21-27,30-36}-
{1-8}
TN11OBU1 FAC-{N}-{1-8,11-27,29-36}-{1-3}
TN11OBU2 FAC-{N}-{2-8,12-19,21-27,30-36}-
{1-3}
TN11OAU1 FAC-{N}-{2-8,12-19,21-27,30-36}-
{1-6}
TN11DAS1 FAC-{N}-{1-8,12-27,29-36}-{1-
21}
TN11WSMD9 FAC-{N}-{1-7,12-18,20-26,29-35}-
{1-22}
TN11RAU1 FAC-{N}-{2-8,12-19,21-27,30-36}-
{1-6,9,10-11}
TN55NPO2E FAC-{N}-
{3,5,7,14,16,18,22,24,26,31,33,35}-
{1}
TN55NPO2 FAC-{N}-
{3,5,7,14,16,18,22,24,26,31,33,35}-
AID type AID format Unit type Pattern Notes
{1}
TN55NPO2(STND) FAC-{N}-
{3,5,7,14,16,18,22,24,26,31,33,35}-
{1}
Table D-219 AID 8800 T64 values
AID AID Unit type Pattern Notes
type format
TN11DMR1 FAC-{N}-{1-8,11-42,45-68}-{3-6}
TN11ROAM FAC-{N}-{1-6,11-16,19-24,27-32,35-40,45-50,53-58,61-
66}-{1-5}
TN12WSD9 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-59,61-
TN12WSM9 67}-{1-12}
TN11WSMD4
TN12WSMD4
TN11WSMD2 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-59,61-
TN12WSMD2 67}-{1-8}
TN14WSM9 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-59,61-
67}-{1-12}
TN13WSD9 FAC-{N}-{1-6,11-16,19-24,27-32,35-40,45-50,53-58,61-
TN13WSM9 66}-{1-12}
TN11RMU9 FAC-{N}-{1-8,11-42,45-68}-{1-13}
TN11RDU9
TN11M40 FAC-{N}-{1-6,11-16,19-24,27-32,35-40,45-50,53-58,61-
TN11M40V 66}-{1-42}
TN11D40
TN11D40V
TN13FIU FAC-{N}-{1-8,11-42,45-68}-{1-4}
AID AID Unit type Pattern Notes
type format
TN11ITL
TN12OLP FAC-{N}-{1-8,11-42,45-68}-{1-3}
TN11GFU
TN11HBA FAC-{N}-{2-7,12-17,20-25,28-33,36-41,46-51,54-59,62-
67}-{1-3}
TN12DCP FAC-{N}-{1-8,11-42,45-68}-{1-6}
TN11MCA4 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-59,61-
67}-{1-4}
TN11MCA8 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-59,61-
67}-{1-8}
TN11OPM8 FAC-{N}-{1-8,11-42,45-68}-{1-8}
TN12VA1 FAC-{N}-{1-8,11-42,45-68}-1
TN11TDC
TN12VA4 FAC-{N}-{1-8,11-42,45-68}-{1-4}
TN11SCS FAC-{N}-{1-8,11-42,45-68}-{1-6}
TN11DCU FAC-{N}-{1-8,11-42,45-68}-{1-2}
TN11WMU FAC-{N}-{1-8,11-42,45-68}-{1-2}
TN11CRPC FAC-{N}-{120-123}-{1-3}
TN11ROP FAC-{N}-{124-127}-{1-3}
TN12OBU1 FAC-{N}-{1-8,11-42,45-68}-{1-5}
TN12OBU2 FAC-{N}-{1-8,11-42,45-68}-{1-5}
TN12OAU1 FAC-{N}-{2-8,12-18,20-26,28-34,36-42,46-52,54-60,62-
68}-{1-8}
TN11OBU1 FAC-{N}-{1-8,11-42,45-68}-{1-3}
TN11OBU2 FAC-{N}-{2-8,12-18,20-26,28-34,36-42,46-52,54-60,62-
68}-{1-3}
TN11OAU1 FAC-{N}-{2-8,12-18,20-26,28-34,36-42,46-52,54-60,62-
68}-{1-6}
TN11DAS1 FAC-{N}-{1-8,11-42,45-68}-{1-21}
TN11WSMD9 FAC-{N}-{1-7,11-17,19-25,27-33,35-41,45-51,53-59,61-
67}-{1-22}
AID AID Unit type Pattern Notes
type format
TN11RAU1 FAC-{N}-{2-8,12-18,20-26,28-34,36-42,46-52,54-60,62-
68}-{1-6,9,10-11}
TN55NPO2E FAC-{N}-
{3,5,7,13,15,17,21,23,25,29,31,33,37,39,41,47,49,51,55,5
7,59,63,65,67}-{1}
TN55NPO2 FAC-{N}-
{3,5,7,13,15,17,21,23,25,29,31,33,37,39,41,47,49,51,55,5
7,59,63,65,67}-{1}
TN55NPO2(ST FAC-{N}-
ND) {3,5,7,13,15,17,21,23,25,29,31,33,37,39,41,47,49,51,55,5
7,59,63,65,67}-{1}
Table D-220 AID 6800A values
AID type AID format Unit type Pattern Notes
TN11MR8 FAC-{N}-{1-16}-{9-10}
TN11MR8V FAC-{N}-{1-16}-{9-12}
TN11DMR1 FAC-{N}-{1-17}-{3-6}
TN11ROAM FAC-{N}-{1-15}-{1-5}
TN12WSD9 FAC-{N}-{1-16}-{1-12}
TN12WSM9
TN11WSMD4
TN12WSMD4
TN11WSMD2 FAC-{N}-{1-16}-{1-8}
TN12WSMD2
TN14WSM9 FAC-{N}-{1-16}-{1-12}
TN13WSD9 FAC-{N}-{1-15}-{1-12}
TN13WSM9
TN11RMU9 FAC-{N}-{1-17}-{1-13}
TN11RDU9
TN11M40 FAC-{N}-{1-15}-{1-42}
TN11M40V
AID type AID format Unit type Pattern Notes
TN11D40
TN11D40V
TN13FIU FAC-{N}-{1-17}-{1-4}
TN11ITL
TN12OLP FAC-{N}-{1-17}-{1-3}
TN11GFU
TN11HBA FAC-{N}-{2-16}-{1-3}
TN12DCP FAC-{N}-{1-17}-{1-6}
TN11MCA4 FAC-{N}-{1-16}-{1-4}
TN11MCA8 FAC-{N}-{1-16}-{1-8}
TN11OPM8 FAC-{N}-{1-17}-{1-8}
TN12VA1 FAC-{N}-{1-17}-1
TN11TDC
TN12VA4 FAC-{N}-{1-17}-{1-4}
TN11SCS FAC-{N}-{1-17}-{1-6}
TN11DCU FAC-{N}-{1-17}-{1-2}
TN11WMU FAC-{N}-{1-17}-{1-2}
TN11CRPC FAC-{N}-{120-123}-{1-3}
TN11ROP FAC-{N}-{124-127}-{1-3}
TN12OBU1 FAC-{N}-{1-17}-{1-5}
TN12OBU2 FAC-{N}-{2-17}-{1-5}
TN12OAU1 FAC-{N}-{2-17}-{1-8}
TN11OBU1 FAC-{N}-{1-17}-{1-3}
TN11OBU2 FAC-{N}-{2-17}-{1-3}
TN11OAU1 FAC-{N}-{2-17}-{1-6}
TN11DAS1 FAC-{N}-{1-17}-{1-21}
TN11WSMD9 FAC-{N}-{1-16}-{1-22}
TN11RAU1 FAC-{N}-{2-17}-{1-6,9,10-
11}
Table D-221 AID 3800A values
AID type AID format Unit type Pattern Notes
TN21MR2 FAC-{1,8,11}-{3-4}
TN21CMR2
TN21MR4 FAC-{1,8,11}-{5-6}
TN21CMR4
TN11SBM2 FAC-{2-5,11}-{5-6}
TN21CMR1 FAC-{1,8,11}-{3-4}
TN21DMR1 FAC-{1,8,11}-{3-6}
TN11MR2 FAC-{2-5}-{3-4}
TN11CMR2
TN11MR4 FAC-{2-5}-{5-6}
TN11CMR4
TN11DMR1 FAC-{2-5}-{3-6}
TN12OLP FAC-{2-5,11}-{1-3}
TN12DCP FAC-{2-5,11}-{1-6}
TN12VA1 FAC-{2-5,11}-1
TN12VA4 FAC-{2-5,11}-{1-4}
TN11SCS FAC-{2-5,11}-{1-6}
TN21DFIU FAC-{1,8,11}-{1-6}
TN21FIU FAC-{1,8,11}-{1-4}
TN11DCU FAC-{2-5,11}-{1-2}
TN12OBU1 FAC-{2-5,11}-{1-5}
TN12OBU2 FAC-{2-4,11}-{1-5}
TN12OAU1 FAC-{N}-{2-4,11}-{1-8}
TN11OBU1 FAC-{2-5,11}-{1-3}
TN11OBU2 FAC-{2-4,11}-{1-3}
TN11OAU1 FAC-{2-4,11}-{1-6}
AID type AID format Unit type Pattern Notes
TN11DAS1 FAC-{2-5}-{1-21}
TN11RAU1 FAC-{2-4,11}-{1-6,9,10-11}
Table D-222 AID 8800 T16 values
AID type AID format Unit type Pattern Notes
TN11MR8V FAC-{N}-{1-
7,11-17}-{9-12}
TN12WSMD4 FAC-{N}-{1-16}-
{1-12}
TN14WSM9 FAC-{N}-{1-
7,11-17}-{1-12}
TN13WSD9 FAC-{N}-{1-
TN13WSM9 6,11-16}-{1-12}
TN11RMU9 FAC-{N}-{1-18}-
TN11RDU9 {1-13}
TN11M40 FAC-{N}-{1-
TN11M40V 6,11-16}-{1-42}
TN11D40
TN13FIU FAC-{N}-{1-18}-
TN11ITL {1-4}
TN12OLP FAC-{N}-{1-18}-
TN11GFU {1-3}
TN11HBA FAC-{N}-{2-
7,12-17}-{1-3}
TN12DCP FAC-{N}-{1-18}-
{1-6}
TN11MCA4 FAC-{N}-{1-
7,11-17}-{1-4}
TN11MCA8 FAC-{N}-{1-
7,11-17}-{1-8}
TN11OPM8 FAC-{N}-{1-18}-
{1-8}
AID type AID format Unit type Pattern Notes
TN12VA1 FAC-{N}-{1-18}-
TN11TDC 1
TN12VA4 FAC-{N}-{1-18}-
{1-4}
TN11SCS FAC-{N}-{1-18}-
{1-6}
TN11DCU FAC-{N}-{1-18}-
{1-2}
TN11WMU FAC-{N}-{1-18}-
{1-2}
TN11CRPC FAC-{N}-{120-
123}-{1-3}
TN11ROP FAC-{N}-{124-
127}-{1-3}
TN12OBU1 FAC-{N}-{1-18}-
{1-5}
TN12OBU2 FAC-{N}-{2-
8,12-18}-{1-5}
TN12OAU1 FAC-{N}-{2-
8,12-18}-{1-8}
TN11DAS1 FAC-{N}-{1-
8,11-18}-{1-21}
TN11WSMD9 FAC-{N}-{1-
7,11-17}-{1-22}
TN11RAU1 FAC-{N}-{2-
8,12-18}-{1-
6,9,10-11}
TN55NPO2E FAC-{N}-
{3,7,13,17}-{1}
TN55NPO2 FAC-{N}-
{3,7,13,17}-{1}
TN55NPO2(STND) FAC-{N}-
{3,7,13,17}-{1}
D.41.3 Parameter Description
ALARMTYPE
<ALMTYPE> is the type of environmental alarm returned by the various ENV commands.
Table D-223 ALARMTYPE values
Value Description
CONDTYPE
<CONDTYPE> identifies the type of alarms and conditions reported by the NE. The
following lists the <CONDTYPE> in alphabetical order.
B
Name Description Alarm Severity Affect Service Location Direction
Continuity check
CC-LOS message loss Critical Yes Near End Receiving
D
Name Description Alarm Affect Location Direction
Severity Service
FLOW-OVER The ingress flow speed Minor Yes Near End Receiving
crosses the threshold
OA gain
GAIN-LOW insufficient Major Yes Near End Transmitting
IPA-SHUT IPA has shut down the Not alarmed Yes Near End Transmitting
OA
Link aggregation
LAG-PORT-FAIL failed Minor No Near End Receiving/Transmitting
synchronization -
Fibre channel
verification
Remote alarm
RAI indication Not reported No Far End Receiving/Transmitting
voltage
RATE-OVER The rate over the Minor Yes Near End Receiving
threshold
Signal degrade-
SD-S Section Major Yes Near End Receiving
OAM(802.3ah)
SPAN-LOSS- Span loss over the Major Yes Near End Receiving
OVER threshold
Ventilation system
VENTN failure Critical No Near End NA
Received wavelength
WAVELEN-MIS Mismatch Major Yes Near End Receiving
DEVICETYPE
Indicates the device type.
Table D-225 DEVICETYPE values
Value Description
DIRN
Indicates the direction of transmission in which switching is to be made and is relative to the
line or path identified by the <AID>.
Table D-226 DIRN values
Value Description
BTH Bidirectional
EVENTID
The current state of the event.
Table D-227 EVENTID values
Value Description
LPBKTYPE
Indicates the loopback type.
Table D-228 LPBKTYPE 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.
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.
LTCACTEN
Indicates the enabling flag of the LTC succeeding response.
Table D-229 LTCACTEN values
Value Description
ENABLE Enable
DISABLE Disable
MOD2
ALL,EQPT,WDM, OC3, OC12, OC48, OC192, OC768, GETH, FETH, OCH, OC, EC, OSC,
OTU1, OTU2, OTU5G, OTU3, OTU4, ODU0, ODU1, ODU2, ODU5G, ODU3,
ODU4,ODU1TCM1,ODU1TCM2,ODU1TCM3,ODU1TCM4,ODU1TCM5,ODU1TCM6,O
DU2TCM1,ODU2TCM2,ODU2TCM3,ODU2TCM4,ODU2TCM5,ODU2TCM6,ODU3TC
M1,ODU3TCM2,ODU3TCM3,ODU3TCM4,ODU3TCM5,ODU3TCM6,ODU5GTCM1,OD
U5GTCM2,ODU5GTCM3,ODU5GTCM4,ODU5GTCM5,ODU5GTCM6,ODU4TCM1,OD
U4TCM2,ODU4TCM3,ODU4TCM4,ODU4TCM5,ODU4TCM6,FC100, FC200, FC400,
FC800, FC1200, XGETH, FICON, FICONEXP, FICON4G, HDSDI, DVBASI, SDI,
ESCON, FDDI, ANY, ISC1G, ISC2G, CLO, ETR, IBSDR, IBDDR, FICON8G, LPT,
MCACHN, PL, STM1, STM4, STM16, STM64, STM256, IBQDR, CBR10G, CPRI1,
CPRI2, CPRI3, 100GETH, CFP,40GETH, 3GSDI, HDSDIRBR, 3GSDIRBR, OCS, CFPS,
OCHS, OCHM, E1PATH,
E1PORT,OMS,OTS,VCG,COM,CPRI4,DBG,STS12,STS192,STS3,STS48,STS768,BPR,TU
NNEL.
MONTYPE
Specifies the type of monitored parameter for which a value is requested.
value
PLRBDCUR pump laser rear beam detector the Near End Transmitting
current value
PLRBDMAX pump laser rear beam detector the Near End Transmitting
maximum value
PLRBDMIN pump laser rear beam detector the Near End Transmitting
minimum value
Performance Event of FC
Name
The total number of frames with wrong CRC that the FC channel received in client side.
The total number of times that the link reseted in both client and WAN side.
The total number of frames, with the type of Class1, that the FC channel received in client side.
The total number of frames, with the type of Class2, that the FC channel received in client side.
The total number of frames, with the type of Class3, that the FC channel received in client side.
The total number of frames, with the type of Class4, that the FC channel received in client side.
The total number of frames, with the type of Classf, that the FC channel received in client side.
The total number of frames that the FC channel received in client side.
The total number of frames, with the type of Class1, that the FC channel transmited in client side.
The total number of frames, with the type of Class2, that the FC channel transmited in client side.
The total number of frames, with the type of Class3, that the FC channel transmited in client side.
The total number of frames, with the type of Class4, that the FC channel transmited in client side.
The total number of frames, with the type of Classf, that the FC channel transmited in client side.
The total number of frames that the FC channel transmited in client side.
The total number of bytes that the FC channel received in client side.
The total number of bytes that the FC channel transmited in client side.
The count of OS that the FC channel can't support.
The total number of invalid words that the FC channel received in client side. a
The total number of events in which packets were received missing synchronization.
a: In the case of FICON services, the LOM unit counts only the "The total number of invalid words
that the FC channel received in client side" performance events and does not count the other RMON
performance events. The result of querying the count of the other RMON performance events is
always 0.
Name
Drop Events
Octets Received
Name
Packets Received
Broadcast Packets Received
Multicast Packets Received
FCS and Alignment Errors
Undersize Packets Received
Oversize Packets Received
Fragments
Jabbers
Collisions
Packets Received (64 Octets in Length)
Packets Received (65~127 Octets in Length)
Packets Received (128~255 Octets in Length)
Packets Received (256~511 Octets in Length)
Packets Received (512~1023 Octets in Length)
Packets Received (1024~1518 Octets in Length)
Packets Received (1519~MTU Octets in Length)
Packets Transmitted (64 Octets in Length)
Packets Transmitted (65~127 Octets in Length)
Packets Transmitted (128~255 Octets in Length)
Packets Transmitted (256~511 Octets in Length)
Packets Transmitted (512~1023 Octets in Length)
Packets Transmitted (1024~1518 Octets in Length)
Packets Transmitted (1519~MTU Octets in Length)
Packets Received and Transmitted (64 Octets in Length)
Packets Received and Transmitted (65~127 Octets in Length)
Packets Received and Transmitted (128~255 Octets in Length)
Packets Received and Transmitted (256~511 Octets in Length)
Packets Received and Transmitted (512~1023 Octets in Length)
Packets Received and Transmitted (1024~1518 Octets in Length)
Unicast Packets Received
Unicast Packets Transmitted
Multicast Packets Transmitted
Broadcast Packets Transmitted
Pause Frames Received
Pause Frames Transmitted
Name
OPRT
Operation to be done.
Table D-230 OPRT values for APE
Value Description
INITSTD scans the power of channels, and saves the power as the standard value
of the APE
Table D-231 OPRT values for TDC
Value Description
PLDTYPE
Indicates the primary state of the entity.
Table D-232 PLDTYPE values
Value Description
FETH FE service
GETH GE service
OTU1 OTU-1
OTU2 OTU-2
OTU3 OTU-3
OTU5G OTU-5G
OC3 OC-3
OC12 OC-12
OC48 OC-48
OC192 OC-192
OC768 OC-768
STM1 STM-1
STM4 STM-4
STM16 STM-16
STM64 STM-64
STM256 STM-256
FC100 FC-100
Value Description
FC200 FC-200
FC400 FC-400
FC800 FC-800
FC1200 FC-1200
FICON FICON
FICON4G FICON4G
FICON8G FICON8G
HDSDI HDSDI
DVBASI DVB_ASI
SDI SDI
ESCON ESCON
FDDI FDDI
ISC1G ISC1G
ISC2G ISC2G
ETR ETR
CLO CLO
IBSDR IBSDR
IBDDR IBDDR
3GSDI 3GSDI
HDSDIRBR HDSDIRBR
3GSDIRBR 3GSDIRBR
PST_STATE
Table D-233 PST_STATE values
Value Description
RVRTV
Indicates the revertive mode.
Table D-234 RVRTV values
Value Description
Y revertive mode
N non-revertive mode
SAFE
Set the IPA safety control mode. Setting the IPA safety switch mainly concerns the
requirement of long-haul cross-span networking. In this case, do not set the input optical
power to an excessively low value.
Use the safe-level power when you open the laser switch. Default value is N.
Table D-235 SAFE values
Value Description
Y The safety control switch is on. It indicates that the IPA reset optical power
is not more than 10 dBm.
N The safety control switch is off. It indicates that the IPA reset optical power
detection boards are all in position for work.
SC
Indicates the external switch command.
Table D-236 SC values
Value Description
SST_STATE
Table D-237 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.
Value Description
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.
MT Maintenance
The entity has been manually removed from service for maintenance activity; this
value is 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.
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
Value Description
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 (for
example, the keyword INCL is equal to Y in the DELETE command).
This SST is only used for cross connection.
SB-DEA The SB state of the entity is deactivated. "SB-DEA" itself does not represent a
state. Changing the value to SB-DEA means that you are to deactivate the original
SB state.
STATE
Table D-238 STATE values
Value Description
ABNORMAL The APE pair detects that the waves are in un-equilibrium state
SUCCESS The TDC scan that a search has finished and search objects are found
FAIL The TDC scan that a search has finished but no search objects are found
STATELEVEL
Indicates the state level.
Table D-239 STATELEVEL values
Value Description
FULL The full state model. Each entity supports all states. Configuration and
maintenance operations are all limited by the state model.
COMPLEX The complex state model. In the complex state model, each entity is
restricted by state model.
To set the state of an entity to OOS, make sure that all the supported
entities at the lower layer are in OOS state.
To set the state of an entity to IS or AINS, make sure that the entity
at the upper layer is not in OOS state.
SWITCHSTATE
Indicates the state of the switching. It is only valid when the port is in the protection group.
Table D-240 SWITCHSTATE values
Value Description
IDLE Idle
SF Signal fail
SD Signal degrade
TYPE
Indicates the unit type of the specified AID.
Table D-241 TYPE values
type Unit type Description
11OAU1 -
EC Electrical interface
OTU3 43G
OTU3E 44G
10GFULLLAN
10GE optical/electrical port
10GFULLWAN
GE optical port AUTO
FULL1000M
GE electrical port AUTO
FE optical port FULL100M
FE electrical port AUTO
HALF10M
FULL10M
HALF100M
FULL100M
ACC port FULL1000M
Command Parameter
RATEDPOWER
ED-WDM
STDGAIN
SFTH
LOSTH
PWROFFSET
ATTEN
VOAOFFSET
LSRSTATE
ED-EC PLDTYPE
ED-OC LSRSTATE
ALS
PLDTYPE
ED-OCH LSRSTATE
ALS
BANDTYPE
WVNUM
PLDTYPE
ATTEN
VOAOFFSET
ED-<OTUN> FEC
TYPE
TIMACT
TIMMODE
EXPTTISAPI
EXPTTIDAPI
TTISAPI
TTIDAPI
TTIOPER
ED-<ODUN> TIMACT
TIMMODE
EXPTTISAPI
EXPTTIDAPI
TTISAPI
TTIDAPI
TTIOPER
LCKEN
PLM2AIS
MSIM2AIS
Command Parameter
VCPLM2AIS
ED-<TCMMOD2> TIMACT
TIMMODE
EXPTTISAPI
EXPTTIDAPI
TTISAPI
TTIDAPI
TTIOPER
SRCEN
SRCMODE
SINKEN
SINKMODE
LCKEN
ED-<OCN> PRBS
ED-<FCMOD2> EXTERN
ED-TDC AUTOADJ
TDCVAL
OPR-TDC OPRT
OPR-LPBK-<MOD2> LPBKTYPE
RLS-LPBK-<MOD2> AID
CONN-TST-<OTUN/OCN/ODU2> TSTSIG
DUR
INTERVAL
TSTMOD
DISC-TST-<OTUN/OCN/ODU2> AID
DLT-PXC-OCH FROM
ED-CRS-<MOD2> FROM
DLT-CRS-<MOD2> FROM
OPR-PROTNSW-<MOD2> AID
RLS-PROTNSW-<MOD2> AID
OPR-PROTNSW-EQPT AID
RLS-PROTNSW-EQPT AID
ED-LPT LPTENABLE
Command Parameter
ED-PL LOCKPOWER
LSRSTATE
ED-OSC LSRSTATE