TL1 Commands and Messages Guide

7300 ASAM
TL1 Commands and Messages
Part 5/5
3EC 36876 AEAA TCZZA Edition 02

Status Released
Change Note B D Fa a42761
Short Title TL1 Commands & Messages

All rights reserved. Passing on and copying of this
document, use and communication of its contents
not permitted without written authorization from Alcatel.
2 / 166 3EC 36876 AEAA TCZZA Edition 02

Contents
Contents
1 E1 Commands and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.1 E1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.1 DLTE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.2 EDE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.3 ENTE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.1.4 OPRLPBKE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.1.5 REPTOPSTATE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.1.6 RLSLPBKE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.1.7 RTRVALME1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.1.8 RTRVATTRE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.1.9 RTRVCONDE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.1.10 RTRVPME1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
1.1.11 RTRVE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.1.12 SETATTRE1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
1.2 E1 Autonomouse Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.2.1 REPT ALM E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.2.2 REPT EVT E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.3 E1 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.4 E1 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2 E3 Commands and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.1 E3 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.1.1 EDE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.1.2 RTRVALME3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.1.3 RTRVATTRE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
2.1.4 RTRVCONDE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.1.5 RTRVPME3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
2.1.6 RTRVE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
2.1.7 SETATTRE3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.2 E3 Autonmous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.2.1 REPT ALM E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
2.2.2 REPT EVT E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
2.3 E3 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
2.4 E3 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
3 Environmental Commands and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
3.1 ENV Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.1.1 RTRVALMENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.1.2 RTRVATTRENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
3.1.3 RTRVCONDENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
3.1.4 SETATTRENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
3EC 36876 AEAA TCZZA Edition 02 3 / 166

Contents
3.2 ENV Autonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

3.2.1 REPT ALM ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
3.3 Environmental (ENV) Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
4 Miscellaneous System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4.1 DLTMEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
4.2 EDSYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
4.3 FREEPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
4.4 INITLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
4.5 INITSYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
4.6 RDSYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
4.7 REPTOPSTATICON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
4.8 REPTOPSTATNE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
4.9 RESVNEXTPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
4.10 RSTMEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
4.11 RTRVCMDSSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
4.12 RTRVHDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
4.13 RTRVLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
4.14 RTRVMEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
4.15 RTRVNEALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
4.16 RTRVPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
4.17 RTRVSYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
4.18 SETDAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
4.19 SETNEALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
4.20 SETSID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
4.21 STACMDSSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
4.22 STPCMDSSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Appendix A Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Appendix B Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Appendix C ATM Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Appendix D System Access Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Contents
Figures
Figure 1 Standard Density ASAM (NE) Equipment Arrangement . . . . . . . . . . . . . . 157
Figure 2 High Density ASAM (NE) Equipment Arrangement . . . . . . . . . . . . . . . . . . 158
Figure 3 Ultra Density ASAM (NE) Equipment Arrangement . . . . . . . . . . . . . . . . . . 159
Tables
Table 1 E1 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 2 E1 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Table 3 E3 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Table 4 E3 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Table 5 ENV Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Contents

1 E1 Commands and Messages

This chapter provides information about the E1 commands and
messages. The chapter has the following main parts:
E1 Commands
E1 Autonomous Messages
E1 Conditions
E1 Monotypes.

1.1 E1 Commands
This section describes the E1 commands.
1.1.1 DLTE1
Function Deletes an existing E1 facility in the NE.
Restrictions All parameters in this command are positiondefined.
Command Format
DLT-E1:[tid]:aid_e1:[ctag][:];
Command Parameters
Parameter Explanation
[tid] The identification of the target NE. TID is optional and has an Alcatel factory
default value of null. The NEs SID code is the only other valid value.
aid_e1 Access Identifier for the E1 facility. Enter in the following format, replacing
lowercase parameters with the values given:
NTE1circuit
LTE1rackshelflt_slotcircuit
rack Rack number (1...6)
shelf Shelf number (1...4)
lt_slot LT slot number (1...16)
circuit Circuit in the NT or LT (1...4)
Grouping and ranging are allowed.
[ctag] The correlation tag that correlates an input command with its associated output
response(s). It is assigned by the originator of the command. The value is limited
to six characters, which may be an identifier or a decimal numeral. It is optional
with a default of 0.

Response Format Normal Response

sid yy-mm-dd hh:mm:ss
M c COMPLD
/* DLT-E1:[tid]:aid_e1:[ctag][:] */
;
Error Response
M c DENY
/* DLT-E1:[tid]:aid_e1:[ctag][:] */
errcde
/* error description */
;
Response Parameters
tid Target NE identification

yymmdd Year (last two digits), month, and day
hh:mm:ss Hour (00...24), minute, and second
M Message generated in response to an input command
c If provided, ctag; otherwise 0
COMPLD Completed
DENY Input command is denied
/* */ Enclosed are human readable comments unspecified format
errcde Error code (See Appendix C)
Example Delete LT E1 circuit located at rack 3, shelf 2, slot 6.

DLT-E1:RALGH:LTE1-3-2-6:42;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* DLT-E1:RALGH:LTE1-3-2-6:42 */
;
Related Command EDE1

1.1.2 EDE1
Function Edits the provisioning data associated with an E1 facility. It

optionally allows modification of associated ATM interface
parameters if this facility is provisioned in native ATM (nonIMA)
mode.

The ATM interface must be provisioned with the ENTE1 or
EDATMPORT commands before ATM parameters are edited.
Command Format
ED-E1:[tid]:aid_e1:[ctag]:::[e1_nblk]:[pst];
Command Parameters
NTE1circuit
circuit Circuit in the Nt or LT (1...4)

[e1_nblk] An E1 facility parameter block containing one or more of the following named
parameters (separated by commas):
LINETYPE E1 line type. Valid values are:
DSX1E1CRC
DSX1E1
PORTID Port identifier (1...32 characters). Indicates the user to
whom the port is assigned. The following values are
reserved and cannot be used:
AVAILABLE (port is not assigned)
FAILED (port is failed and cannot be assigned)
Also see the RESVNEXTPORT and FREEPORT com
mands

[e1_nblk] (cont) The following parameters apply only if the E1 facility directly transports ATM traffic
(ATM mode). For use with IMA, they should be set to null. If no value is specified,
null is assumed.
ATMACCPROF* ATM Access Profile index (1...50). This value deter
mines the range of values for vpi and vci in several
other commands. The value of ATMACCPROF cannot
be changed while any VPLs or VCLs exist.
ATMACCPROFNM* ATM Access Profile name
CACPROFDN* Connection Admission and Control Profile index for
downstream direction (1...50)
CACPROFDNNM* Connection Admission and Control profile name for
the downstream direction
CACPROFUP* Connection Admission and Control Profile index for
upstream direction (1...50)
CACPROFUPNM* Connection Admission and Control profile name for
the upstream direction
*These parameters should not be used and are only included in this release for
release for backward compatibility, and will not be supported in a later release.
They should be provisioned with the EDATMPORT command.
Note: the parameters must have been provisioned using the ENT-IMAGRP and
ED-ATMPORT commands before they can be edited.
QOSCLASS Quality of service of connections on this port. Valid
values are:
CBR (CBR connections only)
UBR (UBR connections only)
CBRUBR (both CBR and UBR connections)
This parameter should not be used and is only included in this release for
backward compatibility. It will be removed from later releases.
[pst] Primary state filter. Valid values are:
IS InService
OOS OutofService (OOSMA is implied)
If no value is specified, this parameter remains unchanged.


M c COMPLD
/* ED-E1:[tid]:aid_e1:[ctag]:::[e1_nblk]:[pst] */
;
Error Response
M c DENY
errcde
;
Response Parameters

COMPLD Completed
errcde Error code (See Appendix B)
Example Edit circuit 2 on the NT to have a line type of DSX1E1.

ED-E1:RALGH:NTE1-2:42:::LINETYPE=DSX1E1,PORTID=CORWIN;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* ED-E1:RALGH:NTE1-2:42:::LIJNETYPE=DSX1E1,PORTID=CORWIN */
;
Related Commands DLTE1

ENT-E1
RTRV-E1

1.1.3 ENTE1
Function Creates the provisioning data associated with an E1 facility. It also

provisions any associated direct ATM interface or IMA (Inverse
Multiplexing for ATM) group.

A circuit can be used in direct ATM (native) mode only if no IMA
group has been defined for the same port (in other words, circuit
and imagrp cannot have the same value). See ENTIMAGRP.
Command Format
ENT-E1:[tid]:aid_e1:[ctag]:::e1_nblk:[pst];
Command Parameters
aid_e1 Access Identifier for the E1 facility. Enter in one of the following formats, replacing
NTE1circuit
circuit Circuit in the NT or LT(1...4)
e1_nblk E1 facility parameter block containing one or more of the following named
LINETYPE Type of line interface used. Valid values are:
DSXE1
DSXE1CRC (default)
FAILED (port is failed and cannot be assigned)

[e1_nblk] (cont) The following parameters apply only if the E1 facility directly transports ATM traffic
(ATM mode). For use with IMA, they should be set to null. If no value is specified,
null is assumed.
Note that the parameters must have been provisioned using the ENT-IMAGRP
and ED-ATMPORT commands before they can be edited.
values are:

The following parameter applies only if the E1 facility is to be used with an IMA
group. For use with ATM, it should be set to null. If no value is specified, null is
assumed.
IMAGRP IMA group to which this facility is to be assigned. Valid
values are:
NTIMA (AID of IMA group on NT)
LTIMAimagrp (AID of IMA group on LT, imagrp =
1..4)
NULL (Do not use IMA; E1 will directly transport ATM)
Note: If an IMA group is specified, it must exist.
Note: For each profile above, either the profile name or the index (not both) may
be specified. If a profile name is specified and two profiles match the name (one
Local and other Network), the Network profile is used.
The E1-NT or E1-LT may use up to 4 E1 facilities with an IMA Group.
Otherwise only one E1 facility may be used to directly transport ATM.
[pst] Primary state filter. Valid values are:
IS InService
If no value is specified, this parameter remains unchanged.

M c COMPLD
/* ENT-E1:[tid]:aid_e1:[ctag]:::e1_nblk:[pst] */
;
Error Response
M c DENY
/* ENT-E1:[tid]:aid_e1:[ctag]:::e1_nblk:[pst] */
errcde
;

Response Parameters

COMPLD Completed
Example Enter E1 circuit 22101 on the LT with a line interface type of

DSX1E1, a port ID of FRANKLIN, and an IMA group of NTIMA.
ENT-E1:RALGH:LTE1-2-2-10-1:42:::LINETYPE=DSX1E1,PORTID=FRANKLIN,IMAGRP=NTIMA;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/*
ENT-E1:RALGH:LTE1-2-2-10-1:42:::LINETYPE=DSX1E1,PORTID=FRANKLIN,IMAGRP=NTIMA */
;
Related Commands FREEPORT

RESVNEXTPORT
RTRVE1

1.1.4 OPRLPBKE1
Function Places the selected E1 facility in a loopback mode.

Loopbacks are supported for the near end (NEND) of the
facility only.
Loopbacks provisioned with this command are maintained
persistently.
The near end of the facility can also be placed in loopback by
sending E1 inband loopback control codes. This form of
loopback is not maintained persistently.
Loopbacks provisioned with this command take priority over
inband loopbacks.
Only one loopback at a time is allowed on a facility.
Command Format
OPR-LPBK-E1:[tid]:aid_e1:[ctag]::,,,[lbktype];
Command Parameters
aid_e1 Access Identifier for the E1 facility. Valid values are:
NTE1circuit
LTE1rackshelfltlt_slotcircuit

[lpbktype] Type of loopback. Valid values are:
LINE Loopback facility at the physical line level toward the
facility (default)
PAYLOAD Loopback facility data (payload) toward the facility
TERMINAL Loopback facility data internally toward the NE
If not specified, LINE is assumed

M c COMPLD
/* OPR-LPBK-E1:[tid]:aid_e1:[ctag]::,,,[lpbktype] */
;
Error Response
M c DENY
/* OPR-LPBK-E1:[tid]:aid_e1:[ctag]::,,,[lpbktype] */
errcde
;
Response Parameters
sid Source NE identification

COMPLD Completed

Example Place NTE1 circuit 2 in payload loopback mode.

OPR-LPBK-E1:RALGH:NTE1-2:40::,,,PAYLOAD;
RALGH 00-11-24 12:30:43
M 40 COMPLD
/* OPR-LPBK-E1:RALGH:NTE1-2:40::,,,PAYLOAD */
;
Related Command RLSLPBKE1

1.1.5 REPTOPSTATE1
Function Reports current operational parameters for E1 lines.
Command Format
REPT-OPSTAT-E1:[tid]:aid_e1:[ctag][:];
Command Parameters
aid_e1 Access identifier for E1 facility. Enter in the following format, replacing lowercase
parameters with the values given:

M c COMPLD
/* REPT-OPSTAT-E1:[tid]:aid_e1:[ctag][:] */
“aid_e1:op_e1,value”
;
Error Response
M c DENY
/* REPT-OPSTAT-E1:[tid]:aid_e1:[ctag][:] */
errcde
;

Response Parameters

COMPLD Completed
aid_e1 As described for command parameters
op_e1 E1 operational parameter. Values are:
INCELLS Rolling count of cells received on this facility
OUTCELLS Rolling count of cells transmitted on this facility
value The value of the parameter specified in op_adsl.
Example Report E1 operational parameters for rack 2, shelf 3, slot 6,

circuit 1.
REPT-OPSTAT-E1:RALGH:LTE1-2-3-6-1;
RALGH 00-01-24 12:30:43
M 42 COMPLD
/* REPT-OPSTAT-IMAGRP:RALGH:LTE1-2-3–6-1:42 */
“LTE1-2-3–6-1:INCELLS,36600”
“LTE1-2-3–6-1:OUTCELLS,28800”
;
Related Commands None.

1.1.6 RLSLPBKE1
Function Releases any loopback currently active at the near end of a

specific E1 facility.

Provisioned loopbacks (set with the OPRLPBKE1 command) and
inband loopbacks (set by E1 inband control codes) are both
released.
Command Format
RLS-LPBK-E1:[tid]:aid_e1:[ctag][:];
Command Parameters
aid_e1 Access identifier for the E1 facility. Valid values are:


M c COMPLD
/* RLS-LPBK-E1:[tid]:aid_e1:[ctag][:] */
;
Error Response
M c DENY
/* RLS-LPBK-E1:[tid]:aid_e1:[ctag][:] */
errcde
;
Response Parameters

COMPLD Completed
Example Release LTE1 circuit 2 from loopback mode.

RLS-LPBK-E1:RALGH:LTE1-2:40;
RALGH 00-11-24 12:30:43
M 40 COMPLD
/* RLS-LPBK-E1:RALGH:LTE1-2:40 */
;
Related Command OPRLPBKE1

1.1.7 RTRVALME1
Function Retrieves current alarms for selected E1 facilities.
Command Format
RTRV-ALM-E1:[tid]:aid_e1:[ctag]::[ntfcde],,[srveff],[locn],[dirn];
Command Parameters
NTE1circuit
[ntfncde] Notification code. Valid values are:
CR Critical alarm
MJ Major alarm
MN Minor alarm
Grouping is allowed. If no value is specified, ALL is assumed.
[serveff] Service effect. Valid values are:
SA Service affecting
NSA Not service affecting

[locn] Location of the condition. Valid values are:

NEND Near end
FEND Far end
If no value is specified, ALL is assumed.
[dirn] Direction of the condition. Valid values are:
RCV Receive
TRMT Transmit

M c COMPLD
/* RTRV-ALM-E1:[tid]:aid_e1:[ctag]::[ntfncde],,[srveff],[locn],[dirn] */
“aid_e1[,aid_type]:ntfncde,cond_e1,serveff,,,[locn],[dirn]:[cond_descr]”
;
Error Response
M c DENY
errcde
;

Response Parameters

COMPLD Completed
aid_e1 As described for command parameters, except that ALL is not used
aid_type The type of Access Identifier. The value is E1.
ntfncde As described for command parameters, except that ALL is not used
cond_e1 E1 facility condition. Values are as defined in E1 Conditions", Section 1.3
serveff As described for command parameters, except that ALL is not used
[locn] As described for command parameters
[dirn] As described for command parameters
[cond_descr] Description of alarm conditionas defined in E1 Conditions", Section 1.3
Example Retrieve serviceaffecting critical alarms for NT circuit 2.

RTRV-ALM-E1:RALGH:NTE1-2:42::CR,,SA;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-ALM-E1:RALGH:NTE1-2:42::CR::SA */
“NTE1-2,E1:CR,LOS,SA,,,NEND,RCV,:Loss of Signal/Clock”
;
Related Commands None

1.1.8 RTRVATTRE1
Function Retrieves current attributes of E1 facilityrelated conditions.
Command Format
RTRV-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::[ntfcde],[cond_e1],[locn],[dirn];
Command Parameters
[aid_all_e1] Access identifier for the all E1 facilities. The value is E1.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not alarmed (reported via REPORT EVENT)
NR Not reported (information is stored in the NE)
[cond_e1] E1 facility condition. Valid values are described E1 Conditions", Section 1.3
[locn] Facility location. Valid values are:
NEND Near end
FEND Far end
Only applicable to conditions supporting location. If no value is specified, ALL is
assumed.
[dirn] Signal direction. Valid values are:
RCV Receive
TRMT Transmit
Only applicable to conditions supporting direction. If no value is specified, ALL is
assumed.


M c COMPLD
/* RTRV-ATTR-E1:[tid]:[aidall_e1]:[ctag]::[ntfncde],[cond_e1],[locn],[dirn]
*/
“aid_all_e1[,aid_type]:ntfncde,cond_e1,[locn],[dirn]”
;
Error Response
M c DENY
/* RTRV-ATTR-E1:[tid]:aidall_e1:[ctag]::[ntfncde],[cond_e1],[locn],[dirn] */
errcde
;
Response Parameters

COMPLD Completed
aid_all_e1 As described for command parameters, except that ALL is not used
[ntfncde] As described for command parameters, except that ALL is not used
[cond_e1] As described for command parameters
Example Retrieve critical attributes for E1 conditions.

RTRV-ATTR-E1:RALGH:E1:42::CR;
RALGH 98-11-24 12:30:43
M 42 COMPLD
/* RTRV-ATTR-E1:RALGH:E1:42::CR */
“E1,E1:CR,LOF,NEND,RCV”
;
Related Commands SETATTRE1

1.1.9 RTRVCONDE1
Function Retrieves current conditions of an E1 facility.
Command Format
RTRV-COND-E1:[tid]:aid_e1:[ctag]::[cond_e1],[locn],[dirn];
Command Parameters
aid_e1 Access identifier for the E1 facility. Valid values are:
NTE1circuit
ltslot LT slot number (1...16)
[cond_e1] E1 facility condition. Valid values are deined in E1 Conditions", Section 1.3
NEND Near end
FEND Far end
RCV Receive
TRMT Transmit


M c COMPLD
/* RTRV-COND-E1:[tid]:aid_e1:[ctag]::[cond_e1],[locn],[dirn] */
“aid_e1[,aid_type]:ntfncde,cond_e1,serveff,,,[locn],[dirn],,[cond_descr]”
;
Error Response
M c DENY
/* RTRV-COND-E1:[tid]:aid_e1:[ctag]::[cond_ds1],[locn] */
errcde
;
Response Parameters

COMPLD Completed
[aid_type] The type of Access Identifier. The value is E1.
ntfncde Notification code. Valid values are:
CR Critical alarm
MJ Major alarm
MN Minor alarm
cond_e1 As described for command parameters, except that ALL is not used
serveff Service effect. Valid values are:
[locn] As described for command parameters, except that ALL is not used
[dirn] As described for command parameters, except that ALL is not used
[cond_descr] Description of alarm condition.

Example Retrieve current conditions for NT circuit 2 facility.

RTRV-COND-E1:RALGH:NTE1-2:42::,,;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-COND-E1:RALGH:NTE1-2:42::,, */
“NTE1-2,E1:CR,LOS,SA,,,NEND,RCV,,Loss Of Signal/Clock”
;

1.1.10 RTRVPME1
Function Retrieves E1 performance monitoring data.
Command Format
RTRV-PM-E1:[tid]:aid_e1:[ctag]::[mone1],[monlev],[locn],[dirn],[tmper],
[mondat],[montm];
Command Parameters
aid_e1 Access identifier for the environment. Valid values are:
NTE1circuit
shelf Shelf number (1...4
[mone1] Monitored parameter (Monotype). Valid values are given in E1 Monotypes,
Section 1.4
[monlev] Threshold level. Enter in the following format:
levdirn
lev Level (0...4294967295)
dirn Direction. Valid values are:
UP (Up)
DN (Down)
If no value is specified, 1UP is assumed.
[locn] Location of the facility. Valid values are:
NEND Near end
FEND Far end
If no value is specified, this parameter is not used for filtering responses.


RCV Receive
TRMT Transmit
[tmper] Time period. The only valid value is:
15MIN 15 minutes
If no value is specified, 15MIN is assumed.
[mondat] Start date for the monitoring period. Valid values are:
mmdd Month and day
mm Month (1...12)
dd Day (1...31)
ALL All performance monitoring data is retrieved
If no value is specified, today's date is assumed.
[montm] Start time for the monitoring period. Valid values are:
hhmm Hour and minute
hh Hour (00...23)
mm Minute. Valid values are 0, 15, 30, and 45.
If no value is specified, the nearest value to the current time is assumed. Grouping
is allowed.

M c COMPLD
/* RTRV-PM-E1:[tid]:aid_e1:[ctag]::[mone1],[monlev],[locn],[dirn],[tmper],
[mondat],[montm] */
“aid_e1[,aid_type]:mone1,monval,,[locn],,[tmper],[mondat],[montm]”
;
Error Response
M c DENY
[mondat],[montm] */
errcde
;

Response Parameters

COMPLD Completed
[aid_type] Type of AID. The value is E1.
mone1 As described for command parameters, except that ALL is not used
monval Measured value for the monitored parameter (0...4294967295)
[tmper] As described for command parameters
[mondat] As described for command parameters, except that ALL is not used
[montm] As described for command parameters, except that ALL is not used
Example Retrieve the nearend alarm indication signal count above 4096
for a 15minute period beginning at 8:30 a.m. on November 10.
RTRV-PM-E1:RALGH:NTE1-3:42::CV-L,4096-UP,NEND,,15-MIN,11-10,08-30;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-PM-E1:RALGH:NTE1-3:42::CV-L,4096-UP,NEND,,15-MIN,11-10,08-30 */
“NTE1-3:CV-L,2015,,NEND,,15-MIN,11-10,08-30”
;
Related Command RTRVALME1

1.1.11 RTRVE1
Function Retrieves the provisioning data associated with an E1 facilities.
Command Format
RTRV-E1:[tid]:aid_e1:[ctag]::::[pstf],[sstf];
Command Parameters
NTE1circuit
[pstf] Primary state filter. Valid values are:
IS InService
OOS OutofService (OOSMA, OOSAU, OOSAUMA)
AU OOSAU, OOSAUMA
MA OOSMA, OOSAUMA
If no value is specified, this filter is ignored.
[sstf] Secondary state filter. Valid values are:
LPBK Retrieve loopedback entities only


M c COMPLD
/* RTRV-E1:[tid]:aid_e1:[ctag]::::[pstf],[sstf] */
aid_e1::e1_nblk:state,[sst]
;
Error Response
M c DENY
/* RTRV-E1:[tid]:aid_e1:[ctag]::::[pstf],[sstf] */
errcde
;
Response Parameters

COMPLD Completed
e1_nblk E1 facility parameter block containing one or more of the following named
LINETYPE Type of line interface used. Values are:
DSX1E1
DSX1E1CRC
FAILED (port has failed and cannot be assigned)

e1_nblk The following parameters apply only if the E1 facility directly transports ATM traffic
(cont) (ATM mode). For each profile, either the profile name or the profile index (not
both) can be specified. If a profile name matches two profiles (Network and Lo
cal), the Network profile is used.
ATMACCPROF* ATM Access Profile index (1...50). Default is 1.
downstream direction (1...50). Default is 1.
CACPROFDNNM* Connection Admission and Control Profile name for
upstream direction (1...50). Default is 1.
CACPROFUPNM* Connection Admission and Control Profile name for
values are:
The following parameter applies only if the E1 facility is to be used with an IMA
group. Otherwise it is not reported.
IMAGRP IMA group to which this facility is to be assigned.
Values are:
NTIMA (AID of IMA group on NT)
LTIMAimagrp (AID of IMA group on LT, imagr=1..4)
NULL (Do not use IMA; E1 will directly transport ATM)
pst Primary state. Values are:
ISNR
OOSAU
OOSMA (Transient state. Changes to OOS-AUMA
OOSAUMA
[sst] Secondary state. Values are:
LPBK Retrieve loopedback entities only

Example Retrieve circuit 2 on the NT.

RTRV-E1:RALGH:NTE1-2:42::::;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-E1:RALGH:NTE1-2:42:::: */
NTE1-2::LINETYPE=DSX1E1,CACPROFDN=4,CACPROFUP=3,ATMACCPROF=9,IMAGRP=2:IS-NR,
;
Related Commands ENTE1

1.1.12 SETATTRE1
Function Sets attributes of E1 facilityrelated alarm conditions.

Attributes are common for all E1 facilities.
Command Format
SET-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::ntfncde,cond_e1,[locn],[dirn];
Command Parameters
default value of null. The NE's SID code is the only other valid value.
[aid_all_e1] Access identifier for all E1 facilities. The value is E1.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NEND Near end
FEND Far end
Only applicable to conditions supporting location. If no value is
specified, ALL is assumed.
RCV Receive
TRMT Transmit
Only applicable to conditions supporting direction. If no value is
specified, ALL is assumed.


M c COMPLD
/* SET-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::ntfncde,cond_e1,[locn],[dirn] */;
Error Response
M c DENY
/* SET-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::ntfncde,cond_e1,[locn],[dirn] */
errcde
;
Response Parameters

COMPLD Completed
Example Associate the critical (CR) notification code with the RAI alarm
condition.
SET-ATTR-E1:RALGH:E1:42::CR,RAI;
RALGH 98-11-24 12:30:43
M 42 COMPLD
/* SET-ATTR-E1:RALGH:E1:42::CR,RAI */
;
Related Command RTRVATTRE1

1.2 E1 Autonomouse Messages

This section describes the E1 autonomous messages.
1.2.1 REPT ALM E1
Function Reports current E1 facility alarms from the NE.
Message Format
almcode atag REPT ALM E1
“aid_e1:ntfncde,cond_e1,serveff,[ocrdat],[ocrtm],[locn],[dirn]:[conddescr]”
;
Response Parameters
almcde Alarm code. Identifies the severity of the alarm. Values are:
*C Critical alarm
** Major alarm
*^ Minor alarm
A^ Automatic message (typically used to report a cleared
alarm)
atag Automatic tag that indicates the numerical sequence of messages reported
aid_e1 Access identifier for the E1 facility. Values are:
NTE1circuit
ntfncde Notification code. Values are:
CR Critical alarm
MJ Major alarm
MN Minor alarm
CL Cleared alarm
serveff Service effect. Values are:

[ocrdat] Date of occurrence in the following format:

mmdd Month and day
mm Month (1...12)
dd Day (1...31)
[ocrtm] Time of occurrence in the following format:
hhmmss Hour, minute, and second
hh Hour (00...23)
mm Minute (00...59)
ss Second (00...59)
[locn] Location of the condition. Values are:
NEND Near end
FEND Far end
[dirn] Direction of the condition. Values are:
RCV Receive
TRMT Transmit
[conddescr] Text string of up to 40 characters that describes the alarm condition

1.2.2 REPT EVT E1
Function Reports current E1 facility events from the NE.
Message Format
almcode atag REPT EVT E1
“aid_e1:cond_e1,[condeff],[ocrdat],[ocrtm],[locn],[dirn]:[conddescr]”
;
Response Parameters
A^ Nonalarm message
aid_e1 Access identifier for the E1 facility. Values are:
NTE1circuit
[condeff] Effect of the event on the condition reported. Values are:
SC Standing condition raised
CL Standing condition cleared
TC Transient condition
mmdd Month and day
mm Month (1...12)
dd Day (1...31)
hh Hour (00...23)
mm Minute (00...59)
ss Second (00...59)

[locn] Location of the condition. Values are:

NEND Near end
FEND Far end
[dirn] Direction of the condition. Values are:
RCV Receive
TRMT Transmit
[cond_descr] Text string of up to 40 characters that describes the alarm condition

1.3 E1 Conditions
Table 1 lists the E1 conditions. In this table, [L] indicates conditions
that support the 'Location' parameter and [D] indicates conditions
that support the 'Direction' parameter
Table 1 E1 Conditions
Condition SERVEFF DEF NTFCNCDE Description
RAI SA Minor Remote Alarm Indication.[L] [D]

AIS SA Minor Alarm Indication Signal.[L] [D]
LOF SA MAJOR Loss of framing.[L] [D]
LOS SA Minor Loss of Signal/Clock.[L] [D]
ACTLPBK SA Minor Facility placed in loopback.[L]
MISMATCH SA Minor Interface does not match configuration.[L]
LCD* SA Minor Loss of ATM Cell Delineation.[L] [D]
LI F+ SA Minor Loss of IMA Frame.[L] [D]
LODS+ SA Minor IMA Link out of Delay Synchronization.[L] [D]
MISCONN+ SA Minor IMA Link Mis-connected.[L] [D]
RFI-IMA+ SA Minor IMA Remote Failure Indication.[L] [D]
FAULT-IMA+ SA Minor IMA Remote Failure Indication.[L] [D]
UNUSABLEIMA+ SA Minor IMA Link unusable due to far-end behavior.[L] [D]
* These ATM Conditions are only available as "E1 Conditions" in this release for backward compatibility,
and will be removed in a future release They should be retrieved via xxx-ATMPORT commands.
+ IMA Link conditions reported via the E1 facility (For E1's being used as a Link with IMA).
Note DS1 and E1 facilities share alarm conditions. Attribute

changes affect both type of facilities.

1.4 E1 Monotypes
Table 2 lists the E1 Monotypes. In this table, the following
notations are used:
Location:
NE = Nearend of the facility
FE = Farend of the facility
Direction
RX = Receive
TX = Transmit.
Table 2 E1 Monotypes
Monotype Location Direction Description
CV-L NE Rx Line Code Violations

ES-L NE + FE Rx Line Errored Seconds
CV-P NE + FE Rx Path Coding Violations
ES-P NE + FE Rx Path Errored Seconds
ESB-P NE + FE Rx Path Errored Seconds - Type B
SES-P NE + FE Rx Path Severely Errored Seconds
UAS-P NE +FE Rx Path Un-Available Seconds
SEFS-P NE + FE Rx Path Severely Errored Framing Seconds
DHECV* NE Rx Discarded Cells Due to HEC Violation
IV-IMA-L+ NE Rx IMA Link ICP Violations
SES-IMA-L+ NE + FE Rx IMA Link Severely Errored Seconds
UAS-IMA-L+ NE + FE Rx IMA Link Un-Available Seconds
UUS-IMA-L+ NE + FE Tx + Rx IMA Link Un-Usable Seconds
FC-IMA-L+ NE + FE Tx + Rx IMA Link Failure Count
OIF-IMA-L+ NE Rx IMA Link Out of IMA Frame Events
STUFF-IMA-L+ NE Rx IMA Link ICP Cell Stuffing Events
* These ATM Montypes are only available as "E1 Montypes" in this release for backward compatibility, and
will be removed in a future release They should be retrieved via xxx-ATMPORT commands.
+ These IMA Link parameters are reported via the underlying E1 facility if it is used as an IMA Link.



This chapter provides information about the E3 commands and
messages. The chapter has the following main parts:
E3 Commands
E3 Autonomous Messages.
E3 Conditions
E3 Monotypes.

2.1 E3 Commands
This section describes the E3 commands.
2.1.1 EDE3
Function Edits the provisioning data associated with an E3 facility.
Command Format
ED-E3:[tid]:aid_e3:[ctag]:::[e3_nblk]:[pst];
Command Parameters
[tid] Identification of the target NE. Alcatel factory default value is null. The NE SID
code is the only other valid value.
aid_e3 Access Identifier for the E3 facility. The value can be preceded with AID=, but this
is not required. Valid values are:
NTE3circuit (E3 Facility on the NT sides A and B)
LTE3rackshelflt_slotcircuit (E3 facility in the LT)
circuit Circuit in the LT (1...4)
[ctag] Correlation tag (1...6 characters) that links an input command with associated
output responses. The default is 0.

[e3_nblk] Named parameter block for E3. The block consists of one or more of the
following parameters, in any order separated by commas, each followed by an
equal sign and a valid value. If not specified, the values of these parameters
remain unchanged.
ATM access profiles cannot be changed while any VPLs or VCLs exist. The profile
index and profile name for the same entity cannot be specified. If a profile name
matches two profiles (Local and Network), the Network profile is used.
[pst] Primary state to be set. Valid values are:
IS InService
If no value is specified, the value of this parameter stays unchanged.
This parameter is not used for the NT

M c COMPLD
;
Error Response
M c DENY
aid:ERRCDE=errcde
;

Response Parameters

COMPLD Completed
errcde Error code (see Appendix B)
Example Edit circuit 2 on the NT to use a Connection Admission and

Control Profile index of 9.
ED-E3:RALGH:NTE3:42:::CACPROFUP=9;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* ED-E3:RALGH:NTE3:42:::CACPROFUP=9 */
;
Related Commands DLTE3

RTRV E3

2.1.2 RTRVALME3
Function Retrieves current alarms for selected E3 facilities.
Command Format
RTRV-ALM-E3:[tid]:aid_e3:[ctag]::[ntfcde],,[srveff],[locn],[dirn];
Command Parameters
NTE3 (E3 Facility on the NT sides A and B)
NTE3A (E3 Facility on the NT side A)
NTE3B (E3 Facility on the NT side B)
LTE3rackshelflt_slotcircuit (E3 facility on the LT side)
CR Critical alarm
MJ Major alarm
MN Minor alarm
[serveff] Service effecting Valid values are:

[locn] Location of the condition. Valid values are:

NEND Near end
FEND Far end
[dirn] Direction of the condition. Valid values are:
RCV Receive
TRMT Transmit

M c COMPLD
;
Error Response
M c DENY
errcde
;
Response Parameters

COMPLD Completed
aid_e3 Only E3NTA is supported.

serveff As described for command parameters, except that ALL is not used
[cond_descr] Description of alarm condition as defined in E3 Conditions", Section 2.3
Example Retrieve serviceaffecting critical alarms for NT circuit 2.

RTRV-ALM-E3:RALGH:NTE3-2:42::CR,,SA;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-ALM-E3:RALGH:NTE3-2:42::CR::SA */
“NTE3-2,E3:CR,LOS,SA,,,NEND,RCV,:Loss of Signal/Clock”
;

2.1.3 RTRVATTRE3
Function Retrieves current attributes of E3 facilityrelated conditions.
Command Format
RTRV-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::[ntfcde],[cond_e3],[locn],[dirn];
Command Parameters
[tid] Identification of the target NE. TID is optional and has an Alcatel factory default
value of null. The NEs SID code is the only other valid value.
[aidall_e3] Access identifier for all E3 facilities. The value is E3.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NEND Near end
FEND Far end
assumed.
RCV Receive
TRMT Transmit
assumed.


M c COMPLD
/* RTRV-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::[ntfncde],[cond_e3],[locn],[dirn]
*/
“aidall_e3[,aid_type]:ntfncde,cond_e3,[locn],[dirn]”
;
Error Response
M c DENY
/* RTRV-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::[ntfncde],[cond_e3],[locn],[dirn]
*/
errcde
;
Response Parameters

COMPLD Completed
aidall_e3 As described for command parameters, except that ALL is not used
aid_type Type of Access Identifier. The value is E3.
[ntfncde] As described for command parameters, except that ALL is not used
[cond_e3] As defined in E3 Conditions", Section 2.3

Example Retrieve critical attributes for E3 conditions.

RTRV-ATTR-E3:RALGH:E3:42::CR;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-ATTR-E3:RALGH:E3:42::CR */
“E3,E3:CR,LOF,NEND,RCV”
;
Related Commands SETATTRE3

2.1.4 RTRVCONDE3
Function Retrieves current conditions of an E3 facility.
Command Format
RTRV-COND-E3:[tid]:aid_e3:[ctag]::[cond_e3],[locn],[dirn];
Command Parameters
NEND Near end
FEND Far end
RCV Receive
TRMT Transmit


M c COMPLD
;
Error Response
M c DENY
errcde
;
Response Parameters

COMPLD Completed
[aid_type] Type of Access Identifier. The value is E3.
CR Critical alarm
MJ Major alarm
MN Minor alarm
serveff Service effecting Valid values are:
[locn] As described for command parameters, except that ALL is not used
[dirn] As described for command parameters, except that ALL is not used

Example Retrieve current conditions for NT circuit 2 facility.

RTRV-COND-E3:RALGH:NTE3-2:42::,,;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-COND-E3:RALGH:NTE3-2:42::,, */
“NTE3-2,E3:CR,LOS,SA,,,NEND,RCV,,Loss Of Signal/Clock”
;

2.1.5 RTRVPME3
Function Retrieves E3 performance monitoring data.
Command Format
RTRV-PM-E3:[tid]:aid_e3:[ctag]::[mone3],[monlev],[locn],[dirn],[tmper],
[mondat],[montm];
Command Parameters
NTE3A (E3 Facility on the NT side A )
LTE3rackshelflt_slotcircuit (E3 facility in the LT side)
circuit Circuit number (1...1)
[mone3] E3 monitored parameter. Valid values are as defined in E3 Monotypes", section
2.4.
[monlev] Threshold level. Enter in the following format:
levdirn
lev Level (0...4294967295)
dirn Direction. Valid values are:
UP (Up)
DN (Down)
If no value is specified, 1UP is assumed.

[locn] Location of the facility. Valid values are:

NEND Near end
FEND Far end
If no value is specified, all values are reported.
RCV Receive
TRMT Transmit
[tmper] Time period. The only valid value is:
15MIN 15 minutes
If no value is specified, 15MIN is assumed.
[mondat] Start date for the monitoring period. Valid values are:
mmdd Month and day
mm Month (1...12)
dd Day (1...31)
If no value is specified, today's date is assumed.
[montm] Start time for the monitoring period. Valid values are:
hhmm Hour and minute
hh Hour (00...23)
mm Minute. Valid values are 0, 15, 30, and 45.
Grouping is allowed. If no value is specified, the nearest value to the current time
is assumed.

M c COMPLD
[mondat],[montm] */
“aid_e3[,aid_type]:mone3,monval,,[locn],,[tmper],[mondat],[montm]”
;

Error Response
M c DENY
/* RTRV-PM-E3:[tid]:aid_e3:[ctag]::[mone3],[monlev],[locn][dirn],[tmper],
[mondat],[montm] */
errcde
;
Response Parameters

COMPLD Completed
[aid_type] Type of AID. The value is E3.
mone3 As described for command parameters, except that ALL is not used
monval Measured value for the monitored parameter (0...4294967295)
[tmper] As described for command parameters
[mondat] As described for command parameters, except that ALL is not used
[montm] As described for command parameters, except that ALL is not used
Example Retrieve the nearend line code violation count above 4096 for a
15minute period beginning at 8:30 a.m. on November 10.
RTRV-PM-E3:RALGH:NTE3:42::CV-L,4096-UP,NEND,,15-MIN,11-10,08-30;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-PM-E3:RALGH:NTE3:42::CV-L,4096-UP,NEND,,15-MIN,11-10,08-30 */
“NTE3:CV-L,2015,,NEND,,15-MIN,11-10,08-30”
;
Related Command RTRVALME3

2.1.6 RTRVE3
Function Retrieves the provisioning data associated with an E3 facilities.
Command Format
RTRV-E3:[tid]:aid_e3:[ctag]::::[pstf];
Command Parameters
[pstf] Primary state filter. Valid values are:
IS InService
OOS OutofService (OOSMA, OOSAU, OOSAUMA)
AU OOSAU, OOSAUMA
MA OOSMA, OOSAUMA

M c COMPLD
/* RTRV-E3:[tid]:aid_e3:[ctag]::::[pstf] */
aide3::e3_nblk:state
;

Error Response
M c DENY
/* RTRV-E3:[tid]:aid_e3:[ctag]::::[pstf] */
errcde
;
Response Parameters

COMPLD Completed
[e3_nblk] Named parameter block for E3. The block consists of the following parameters,
each followed by an equal sign and a value.
ATMACCPROF* ATM Access Profile index (1...50). Default is 1.
downstream direction (1...50). Default is 1.
CACPROFDNNM* Connection Admission and Control Profile name for
upstream direction (1...50). Default is 1.
CACPROFUPNM* Connection Admission and Control Profile name for
state Primary state. Values are:
ISNR
OOSAU
OOSMA (Transient state. Changes to OOS-AUMA)
OOSAUMA

Example Retrieve E3 provisioning data.

RTRV-E3:RALGH:NTE3:42;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-E3:RALGH:NTE3:42 */
NTE3::CELLMAPNG=PLCP_SCRAM,CRDECPLNG=IDLE,OOFDETECT=3OF16BITS,
LINEBLDOUT=ENABLED,CACPROFUP=14,ATMACCPROF=9:IS-NR
;
Related Command ENTE3

2.1.7 SETATTRE3
Function Sets attributes of E3 facilityrelated alarm conditions. Attributes are

common for all E3 facilities.
Command Format
SET-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::ntfncde,cond_e3,[locn],[dirn];
Command Parameters
value of null. The NE's SID code is the only other valid value.
[aid_all_e3] Access identifier for all E3 facilities. The value is E3.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NEND Near end
FEND Far end
assumed.
RCV Receive
TRMT Transmit
assumed.


M c COMPLD
/* SET-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::ntfncde,cond_e3,[locn],[dirn] */;
Error Response
M c DENY
/* SET-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::ntfncde,cond_e3,[locn],[dirn] */
errcde
;
Response Parameters

COMPLD Completed
Example Associate the critical (CR) notification code with the RAI alarm
condition.
SET-ATTR-E3:RALGH:E3:42::CR,RAI;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* SET-ATTR-E3:RALGH:E3:42::CR,RAI */
;
Related Command RTRVATTRE3

2.2 E3 Autonmous Messages

This section describes the E3 autonomous messages.
2.2.1 REPT ALM E3
Function Reports current E3 facility alarms from the NE.
Message Format
almcode atag REPT ALM E3
“aid_e3:ntfncde,cond_e3,serveff,[ocrdat],[ocrtm],[locn],[dirn]:[conddescr]”
;
Response Parameters
*C Critical alarm
** Major alarm
*^ Minor alarm
alarm)
CR Critical alarm
MJ Major alarm
MN Minor alarm
CL Cleared alarm

serveff Service effecting Values are:

SA Service affecting (Immediate action required)
mmdd Month and day
mm Month (1...12)
dd Day (1...31)
hh Hour (00...23)
mm Minute (00...59)
ss Second (00...59)
[locn] Location of condition. Values are:
NEND Near end
FEND Far end
[dirn] Direction of condition. Values are:
RCV Receive
TRMT Transmit
[conddescr] Description of condition (1...40 characters)

2.2.2 REPT EVT E3
Function Reports current E3 facility events from the NE.
Message Format
almcode atag REPT EVT E3
“aid_e3:cond_e3,[condeff],[ocrdat],[ocrtm],[locn],[dirn]:[conddescr]”
;
Response Parameters
A^ Nonalarm message
[condeff] Effect of event on condition reported. Values are:
SC Standing condition raised
CL Standing condition cleared
TC Transient condition


mmdd Month and day
mm Month (1...12)
dd Day (1...31)
hh Hour (00...23)
mm Minute (00...59)
ss Second (00...59)
[locn] Location of condition. Values are:
NEND Near end
FEND Far end
[dirn] Direction of condition. Values are:
RCV Receive
TRMT Transmit
[cond_descr] Description of the alarm condition (1...40 characters)

2.3 E3 Conditions
Table 3 lists the E3 conditions. In this table, [L] indicates conditions
that support the 'Location' parameter and [D] indicates conditions
that support the 'Direction' parameter
Table 3 E3 Conditions
RAI SA Major Remote Alarm Indication.[L] [D]

AIS SA Critical Alarm Indication Signal.[L] [D]
LOF SA Critical Loss of framing.[L] [D]
LOS SA Critical Loss of Signal/Clock.[L] [D]
LCD* SA Critical Loss of ATM Cell Delineation.[L] [D]
ACTLPBK SA Critical Network Side in Loopback[L] [D]
PLMP SA Minor Payload Type Mismatch[L] [D]
PLU SA Minor Stable Payload Type[L] [D]
UNEQP SA Minor Payload Unequipped[L] [D]
CELLSIG SA Critical False startofcell input signal [L][D]
OVRFLO SA Critical Buffer (FIFO) overflow [L][D]
UDRFLO SA Critical Buffer (FIFO) underflow [L] [D]
* These ATM Conditions are reported via the E3 facility.

2.4 E3 Monotypes
Table 4 lists the E3 Monotypes. In this table, the following
notations are used:
NE = Nearend of the facility
FE = Farend of the facility
RX = Receive.
Table 4 E3 Monotypes
Monotype Location Direction Description
CVL NE RX Line Code Violations

ESL NE RX Line Errored Seconds
ESPP NE RX P-Bit Errored Seconds
SESPP NE RX P-Bit Severely Errored Seconds
UASPP NE RX P-Bit Un-Available Seconds
ESCPP NE + FE RX CP-Bit Errored Seconds
SESCPP NE + FE RX CP-Bit Severely Errored Seconds
UASCPP FE RX CP-Bit Un-Available Seconds
SASP NE RX Severely Errored Framing Seconds
DHECV* NE RX Discarded Cells Due to HEC Violation
* These ATM monotypes are reported via the E3 facility.


3 Environmental Commands and Messages

This chapter provides information about the Environmental (ENV)
commands and messages. The chapter has the following main
parts:
ENV Commands
ENV Autonomous Messages.
ENV Conditions.

3.1 ENV Commands

This section describes the ENV commands.
3.1.1 RTRVALMENV
Function Retrieves current environment alarms.
Command Format
RTRV-ALM-ENV:[tid]:aid_env:[ctag]::[ntfcde],;
Command Parameters
aid_env Access identifier for the environment. Enter in the following format, replacing
ENV<number>
<number> 1...5
Grouping and ranging are allowed. ALL may be used.
CR Critical alarm
MJ Major alarm
MN Minor alarm
Grouping and ranging are allowed. If no value is specified, ALL is assumed.

M c COMPLD
/* RTRV-ALM-ENV:[tid]:aid_env:[ctag]::[ntfncde] */
“aid_env:ntfncde,cond_env”
;

Error Response
M c DENY
/* RTRV-ALM-ENV:[tid]:aid_env:[ctag]::[ntfncde] */
errcde
;
Response Parameters

COMPLD Completed
aid_env As described for command parameters, except that ALL is not used
cond_env Environmentrelated alarm condition. Values are as defined in ENV Conditions",
Section 3.3
Example Retrieve ADSL alarms for environment 4.

RTRV-ALM-ENV:RALGH:ENV-4:42:::,,;
RALGH 98-11-24 12:30:43
M 42 COMPLD
/* RTRV-ALM-ADSL:RALGH:ENV-4:42:::,, */
“ENV:CR,MISC,SA”
;

3.1.2 RTRVATTRENV
Function Retrieves current attributes of environmentrelated conditions.
Command Format
RTRV-ATTR-ENV:[tid]:aid_env:[ctag]::[ntfcde];
Command Parameters
ENV<number>
<number> 1...5
CR Critical alarm
MJ Major alarm
MN Minor alarm

M c COMPLD
/* RTRV-ATTR-ENV:[tid]:aid_env:[ctag]::[ntfncde] */
“aid_env,aid_type:ntfncde,cond_env”
;
Error Response
M c DENY
/* RTRV-ATTR-ENV:[tid]:aid_env:[ctag]::[ntfncde] */
errcde
;

Response Parameters

COMPLD Completed
aid_env As described for command parameters, except that ALL is not used.
aid_type The type of Access Identifier. The value is ENV.
CR Critical alarm
MJ Major alarm
MN Minor alarm
Section 3.3
Example Retrieve critical attributes for environment 4.

RTRV-ATTR-ENV:RALGH:ENV-4:42::CR;
RALGH 98-11-24 12:30:43
M 42 COMPLD
/* RTRV-ATTR-ENV:RALGH:ENV-4:42::CR */
“ENV-4,ENV:CR,MISC”
;
Related Commands SETATTRENV

3.1.3 RTRVCONDENV
Function Retrieves current conditions associated with an environmental

alarm input.
Command Format
RTRV-COND-ENV:[tid]:aid_env:[ctag]::[cond_env];
Command Parameters
aid_env Access identifier for an environment. The value can be preceded with AID=, but
this is not required. Enter in the following formats, replacing lowercase
parameters with the values given:
ENV<number>
<number> 1...5
Section 3.3

M c COMPLD
/* RTRV-COND-ENV:[tid]:aid_env:[ctag]::[cond_env] */
“aid_env[,aid_type]:ntfncde,cond_env,,,,,,,[cond_descr]”
;
Error Response
M c DENY
/* RTRV-COND-ENV:[tid]:aid_env:[ctag]::[cond_env] */
errcde
;

Response Parameters

yymmdd Year (two digits), month, and day
hh:mm:ss Hour (0023), minute, and second
COMPLD Completed
aid_env As described for command parameters, except that ALL is not used
[aid_type] Type of Access Identifier. The value is ENV.
[ntfncde] Notification code. Values are:
CR Critical alarm
MJ Major alarm
MN Minor alarm
cond_env As described for command parameters, except that ALL is not used
[cond_descr] Description of alarm condition (1...40 characters)
Example Retrieve current condition of environment number 4.

RTRV-COND-ENV:RALGH:ENV-4:42::;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-COND-ENV:RALGH:ENV-4:42:: */
“ENV-4:MN,MISC,NSA,,,,,,Miscellaneous Environment Alarm”
;

3.1.4 SETATTRENV
Function Sets the attributes of environment alarm conditions.
Command Format
SET-ATTR-ENV:[tid]:aid_env:[ctag]::ntfncde;
Command Parameters
ENV<number>
<number> 1...5
CR Critical alarm
MJ Major alarm
MN Minor alarm

M c COMPLD
/* SET-ATTR-ENV:[tid]:aid_env:[ctag]::ntfncde */
;
Error Response
M c DENY
/* SET-ATTR-ENV:[tid]:aid_env:[ctag]::ntfncde */
errcde
;

Response Parameters

COMPLD Completed
Example Associate the critical (CR) notification code with alarm conditions
on environment 4.
SET-ATTR-ENV:RALGH:ENV-4:42::CR;
RALGH 98-11-24 12:30:43
M 42 COMPLD
/* SET-ATTR-ENV:RALGH:ENV-4:42::CR */
;
Related Command RTRVATTRENV

3.2 ENV Autonomous Messages

This section describes the ENV autonmous messages.
3.2.1 REPT ALM ENV
Function Reports current environment alarms from the NE.
Message Format
almcode atag REPT ALM ENV
“aid_env:ntfncde,cond_env,ocrdat,ocrtm,[conddescr]”
;
Response Parameters
*C Critical alarm
** Major alarm
*^ Minor alarm
alarm)
aid_env Access identifier for the environment in the following format:
ENV<number>
<number> 1...5
CR Critical alarm
MJ Major alarm
MN Minor alarm
CL Cleared alarm

cond_env Environment condition. The value is:

MISC Miscellaneous environment alarm
ocrdat Date of occurrence in the following format:
mmdd Month and day
mm Month (1...12)
dd Day (1...31)
ocrtm Time of occurrence in the following format:
hh Hour (00...23)
mm Minute (00...59)
ss Second (00...59)
[conddescr] Text string of up to 40 characters that describes the alarm condition

3.3 Environmental (ENV) Conditions

Table 5 lists the ENV conditions.
Table 5 ENV Conditions

MISC ** NSA NR Miscellaneous Environment Alarm

Note: There are 5 miscellaneous alarms corresponding to AIDs (ENV1..5).

4 Miscellaneous System Commands

This chapter provides information about the Miscellaneous System
commands.

4.1 DLTMEM
Function Deletes a software package from the NE.
Restrictions In this release, only one action is supported: deletion of the

backup version of the NE provisioning database that is created
after a successful software migration. This is the database used by
the RSTMEM command. Once the database is deleted, the restore
operation becomes impossible.
All parameters in this command are positiondefined.
Command Format
DLT-MEM:[tid]:aid_com:[ctag]::swpkg;
Command Parameters
aid_com Access Identifier for common equipment. The value is COM.
swpkg Software package to be deleted. The value is BACKUPDB (backup version of the
provisioning database.


M c COMPLD
/* DLT-MEM:[tid]:aid_com:[ctag]::swpkg */
;
Error Response
M c DENY
/* DLT-MEM:[tid]:aid_com:[ctag]::swpkg */
errcde
;
Response Parameters

COMPLD Completed
Example Delete the backup version of the provisioning database.

DLT-MEM:RALGH:COM:42::BACKUPDB;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* DLT-MEM:RALGH:COM:42::BACKUPDB */
;
Related Command RSTMEM

4.2 EDSYNCN
Function Configures the reference source for synchronization of the NE

clocks.
Command Format
ED-SYNCN:[tid]:[aid_syncn]:[ctag]:::[syncn_nblk];
Command Parameters
aid_syncn AID of the NE clock. The value is CLKSRCNT (default).
syncn_nblk Named parameter block for SYNCN. The block consists of the following
parameter, followed by an equal sign and a valid value.
PRICREF Primary reference source for synchronizing the clock.
Valid values are:
LOOP (Loop timing recovered from network side facili
ty)
LOCAL (Local oscillator on NT board)
REDNT (Local oscillator on redundant NT board)
If not specified, the value of this parameter remains unchanged.


M c COMPLD
/* ED-SYNCN:[tid]:[aid_syncn]:[ctag]:::[syncn_nblk] */
;
Error Response
M c DENY
/* ED-SYNCN:[tid]:[aid_syncn]:[ctag]:::[syncn_nblk] */
errcde
;
Response Parameters

COMPLD Completed
Example Configure the NE clock to use the BITS clock as its primary
reference source.
ED-SYNCN:RALGH:CLKSRCNT:42:::PRICREF=LOCAL;
RALGH 99-11-24 12:30:43
M 42 COMPLD
/* ED-SYNCN:RALGH:CLKSRCNT:42:::PRICREF=LOCAL */
;
Related Commands DLTSYNCN

ENTSYNCN

4.3 FREEPORT
Function Frees a port previously assigned to a user (by EDADSL,

EDSHDSL, EDE1, or RESV-NEXTPORT).
Note User ports can be assigned to a user/customer, or be
free (available) for assignment. Assignment is based on
the value of the PORTID parameter associated with the
PORT. A specific port may be assigned using the
ED(ADSL/SHDSL) commands, or any free (available)
port may be requested using the RESCNEXTPORT
command. Assigned ports may be freed (unassigned)
using the FREEPORT command.
Restrictions Port assignment is independent of the state (faulty or otherwise)

and presence of connections on the port. You must verify the
condition of the port before freeing it.
All parameters in this command are positiondefined.
Command Format
FREE-PORT:[tid]:port_aid:[ctag][:];
Command Parameters
port_aid Access identifier for the port. Enter in one of the following formats, replacing
ADSLrackshelflt_slotcircuit
LTSHDSLrackshelflt_slotcircuit
shelf Shelf number (1...4 for ADSL, 1...3 for SHDSL)
circuit Circuit number in LT (1...24)


M c COMPLD
/* FREE-PORT:[tid]:port_aid:[ctag][:] */
;
Error Response
M c DENY
/* FREE-PORT:[tid]:port_aid:[ctag][:] */
aid:ERRCDE=errcde
;
Response Parameters

COMPLD Completed
Example Free port ADSL1382.

FREE-PORT:RALGH:ADSL-1-3-8-2:40;
RALGH 00-01-24 12:30:43
M 40 COMPLD
/* FREE-PORT:RALGH:ADSL-1-3-8-2:40 */
;
Related Commands EDADSL

EDT1
RESVNEXTPORT

4.4 INITLOG
Function Initializes selected system log(s).
Command Format
INIT-LOG:[tid]::[ctag]::lognms;
Command Parameters
lognms Names of logs to be initialized. The only supported value is SECURITY.

M c COMPLD
/* INIT-LOG:[tid]::[ctag]::lognms */
;
Error Response
M c DENY
/* INIT-LOG:[tid]::[ctag]::lognms */
errcde
;

Response Parameters

COMPLD Completed
Example Initialize the SECURITY log.

INIT-LOG:RALGH::40::SECURITY;
RALGH 98-11-24 12:30:43
M 40 COMPLD
/* INIT-LOG:RALGH::40::SECURITY */
;
Related Command RTRVLOG

4.5 INITSYS
Function Initializes or resets selected subsystems in the NE.

To restore persistent database, do the following:
a) Use STACMDSSN to start a command session.
b) Enable download by using SETNEALL with
MEMDNLD=ENABLED.
c) Use TFTP to download the database file.
d) Restart the system by using INITSYS with INIT_MODE=4.
e) Use STPCMDSSN to stop the command session.
Command Format
INIT-SYS:[tid]:aid_proc:[ctag]::init_mode;
Command Parameters
aid_proc Identifier of the processor to be initialized. Grouping and ranging are not
allowed. Valid values are:
NTA Network Termination UnitA
NTB Network Termination UnitB
LTrackshelflt_slot Processor in LT unit
SERVrackshelfserv_slot Processor in Server
where
SYSTEM Entire system
Serv_slot Server slot number (1...16)
No grouping or ranging is allowed

init_mode Mode of initialization. Valid values are:

0 Emergency restart for active NT only*
1 Initialize with selftest
2 Initialize without selftest
3 Complete reset (aid_proc=SYSTEM only). Removes all
persistent data from system.
4 Restart using downloaded persistent database
(aid_proc=SYSTEM only) (see Restrictions)
* = To be used only if a normal restart using the values 1 to

ATTENTION 4 is not successful.

M c COMPLD
/* INIT-SYS:[tid]:aid_proc:[ctag]::init_mode */
;
Error Response
M c DENY
/* INIT-SYS:[tid]:aid_proc:[ctag]::init_mode */
aid:ERRCDE=errcde
;
Response Parameters

COMPLD Completed

Example Perform a complete reset of the NTA unit.

INIT-SYS:RALGH:NTA:40::3;
RALGH 00-11-24 12:30:43
M 40 COMPLD
/* INIT-SYS:RALGH:NTA:40::3 */
;

4.6 RDSYNCN
Function Retrieves the current reference source for synchronization of the

NE clock.
Command Format
RD-SYNCN:[tid]:[aid_syncn]:[ctag][:];
Command Parameters
aid_syncn AID of the NE clock. The value is CLKSRCNT.

M c COMPLD
/* RD-SYNCN:[tid]:[aid_syncn]:[ctag][:] */
aid_syncn,cref
;
Error Response
M c DENY
/* RD-SYNCN:[tid]:[aid_syncn]:[ctag][:] */
errcde
;

Response Parameters

COMPLD Completed
aid_syncn As described for command parameters
cref Primary reference source for synchronizing the clock. Values are:
PRILOOP Loop timing recovered from network side facility
PRILOCAL Local oscillator on NT board
PRIREDNT Local oscillator on redundant NT board
Example Retrieve the NE clock source.

RD-SYNCN:RALGH:CLKSRCNT:42;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RD-SYNCN:RALGH:CLKSRCNT:42 */
CLKSRCNT,PRI-LOCAL
;
Related Commands EDSYNCN

RTRVSYNCN

4.7 REPTOPSTATICON
Function Reports current operational parameters of the IQbus Controller

(ICON) subsystem of the ASAM.
Command Format
REPT-OPSTAT-ICON:[tid]:[aid_com]:[ctag][:];
Command Parameters
[aid_com] Access Identifier for common equipment. The value is COM.

M c COMPLD
/* REPT-OPSTAT-ICON:[tid]:[aid_com]:[ctag][:] */
“aid_com:op_icon,value”
;
Error Response
M c DENY
/* REPT-OPSTAT-ICON:[tid]:[aid_icon]:[ctag][:] */
errcde
;
Response Parameters

COMPLD Completed


aid_icon As described for command parameters
op_icon ICON subsystem operational parameter. Values are:
R<r>S<s> Status bitmap for shelf <s> in Rack <r>: n (1...8) in
each rack.
<r> Rack Number (1...6)
<s> Shelf (1...4)
If shelf n is not present in a rack, the value is a space
character. Otherwise, the value is a bitmap consisting
of three bits as follows:
Bit 0: LT equipped (1=yes, 0=no)
Bit 1: LT enabled (1=yes, 0=no)
Bit 2: LT powered down (1=yes, 0=no)
ORDER Sequence of shelves in the extender chain. The value is
a series of 8digit hexadecimal numbers, in extender
chain order. The 5 least significant bits of each
number represent the settings of the backplane straps
for the corresponding shelf.
value Value of the parameter specified in op_icon
Example Report ICON subsystem operational parameters.

REPT-OPSTAT-ICON:RALGH:;
RALGH 99-11-24 12:30:43
M 42 COMPLD
/* REPT-OPSTAT-ICON:RALGH::42 */
“COM:SHELF1,\”300000000000 \“”
“COM:SHELF2,\” \“”
“COM:ORDER,\” : 00 \””
;

4.8 REPTOPSTATNE
Function Reports current operational parameters for the system.
Command Format
REPT-OPSTAT-NE:[tid]:[aid_com]:[ctag][:];
Command Parameters
[aid_com] Access Identifier for common equipment. The value is COM.

tid yy-mm-dd hh:mm:ss
M c COMPLD
/* REPT-OPSTAT-NE:[tid]:[aid_com]:[ctag][:] */
“aid_com:op_ne,value”
“aid_com:op_ne,value”
. . .
;
Error Response
M c DENY
/* REPT-OPSTAT-NE:[tid]:[aid_com]:[ctag][:] */
aid:ERRCDE=errcde
;
Response Parameters

yymmdd Year (2 digits), month, and day
COMPLD Completed


aid_com As described for command parameters
op_ne,value Name and value (separated by a comma) of a system operational parameter.
Parameters are:
ACTCHN Currently active chain (side). Values are:
CHAINA (Chain A active)
CHAINB (Chain B active)
EQPTPRAC Equipment practice for this NE. Values are:
LAUS (Largeshelf US model)
MAUS (MiniRAM US model)
LAEU (Largeshelf European model)
MAEU (MiniRAM European model)
OTHER (Unknown equipment practice)
EXTCHALEN Length of extender chain, side A (integer 1...N)
EXTCHBLEN Length of extender chain, side B (integer 1...N)
FACASTATUS Status of NT facility side A. Values are:
NORMAL (Available)
LOS (Loss of signal)
LOF (Loss of framing)
AIS (Alarm indication signal)
BER (Excessive bit errors)
FACBSTATUS Status of NT facility side B. Values are the same as for
FACASTATUS.
MEMASTATUS Status of system memory, side A. Values are:
NORMAL (Memory is OK)
FAULT (Memory is not OK)
MEMBSTATUS Status of system memory, side B. Values are the same
as for MEMASTATUS.
MEMMIGR Memory migration status (see DLTMEM and
RSTMEM). Values are:
IDLE (Migration not possible)
BUSY (Migration in progress)
COMPLETE (Migration completed, rollback possible)

op_ne,value (cont) MEMSYNC Memory synchronization between sides A and B.

Values are:
INSYNC (Both sides synchronized)
OUTSYNC (Both sides not synchronized)
BUSY (Synchronization in progress)
NTASTATUS Status of NT side A. Values are:
NORMAL (Available)
UNAVAIL (Not present)
UNREACH (Cannot communicate with unit)
NTBSTATUS Status of NT side B. Values are the same as for
NTASTATUS.
NUMPROTNSW Rolling count of protection switching events
PROTCURR Current protection switching mode. Values are:
INH (Administratively inhibited)
ALW (Allowed)
SWA (Manually switched to side A)
SWB (Manually switched to side B)
SWCAUSE Reason for last protection switch. Values are:
NOSW (No switch has occurred)
MANSW (Manual/administrative switch)
EQPTF (Equipment failure or removal switch)
EXTCHF (Extender chain failure switch)
LNKF (Link (NT facility) failure switch)
TMOUT (watchdog timer timed out switch)
MEMf (database corruption caused switch)
MISMATCH (mismatch of board type or SW variant)

Example Report system operational parameters.

REPT-OPSTAT-NE:RALGH:COM:42;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* REPT-OPSTAT-NE:RALGH:COM:42 */
“COM:ACTCHN,CHAINA”
“COM:EQPTPRAC,LAUS
“COM:EXTCHALEN,1”
“COM:EXTCHBLEN,2”
“COM:FACASTATUS,NORMAL”
“COM:FACBSTATUS,NORMAL
“COM:MEMASTATUS,NORMAL
“COM:MEMBSTATUS,NORMAL”
“COM:MEMMIGR,COMPLETE
“COM:MEMSYNC,INSYNC”
“COM:NTASTATUS,NORMAL”
“COM:NTBSTATUS,NORMAL
“COM:NUMPROTNSW,0”
“COM:PROTCURR,ALW”
“COM:SWCAUSE,NOSW”
Related Commands DLTMEM

RSTMEM

4.9 RESVNEXTPORT
Function Reserves the first available port of a particular type for a user. If a
free port is found, it is assigned; otherwise, an error is reported.
Note User ports can be assigned to a user/customer, or be
free (available) for assignment. Assignment is based on
the value of the PORTID parameter associated with the
PORT. A specific port may be assigned using the
ED(ADSL/SHDSL) commands, or any free (available)
port may be requested using the RESCNEXTPORT
command. Assigned ports may be freed (unassigned)
using the FREEPORT command.
Restrictions All parameters in this command are position-defined. Port

assignment is independent of the state (faulty or otherwise) and
presence of connections on the port. You must verify the condition
of the port before reserving it.
Command Format
RESV-NEXT-PORT:[tid]:port_type:[ctag]::port_id;
Command Parameters
port_type Type of port to be assigned. Valid values are:
ADSL ADSL port
SHDSL SHDSL port
port_id Label used to mark the port as assigned to a particular user (1...32 characters).
The following values are reserved and cannot be used:
AVAILABLE Port is not assigned
FAULTY Port is faulty and cannot be assigned


M c COMPLD
/* RESV-NEXT-PORT:[tid]:port-type:[ctag]::port_id */
port_type:port_aid
;
Error Response
M c DENY
/* RESV-NEXT-PORT:[tid]:port-type:[ctag]::port_id */
aid:ERRCDE=errcde
;
Response Parameters

COMPLD Completed
port_type As described for command parameters
port_aid Access identifier for the port. Values are:
shelf Shelf number (1...4, for ADSL, 1...3 for SHDSL)

Example Free port ADSL1382.

RESV-NEXT-PORT:RALGH:ADSL:40::ARTURO;
RALGH 00-01-24 12:30:43
M 40 COMPLD
/* RESV-NEXT-PORT:RALGH:ADSL:40::ARTURO */
ADSL:ADSL-1-3-8-2
;

EDT1
FREEPORT

4.10 RSTMEM
Function Restores the NE provisioning database to the backup version, if

one exists.
Note A backup database is saved during NE software
migration. It can be deleted with DLTMEM.
Command Format
RST–MEM:[tid]:aid_com:[ctag][:];
Command Parameters
aid_com Access Identifier for all common equipment. The value is COM.

M c COMPLD
/* RST–MEM:[tid]:aid_com:[ctag][:] */
;
Error Response
M c DENY
/* RST–MEM:[tid]:aid_com:[ctag][:] */
aid:ERRCDE=errcde
;

Response Parameters

yymmdd Year (2 digits), month, and day
COMPLD Completed
Example Restore the NE provisioning database to the backup version

created during the last NE software migration.
RST-MEM:RALGH:COM:42;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RST-MEM:RALGH:COM:42 */
Related Command DLTMEM

4.11 RTRVCMDSSN
Function Retrieves information about active Command Sessions.

At this moment only two Command Session owners are
supported:
5523 AWS: ADSL workstation (or another SNMP manager)
Craft: craft interface.
Note: The CRAFT session is shared by all TL1 managers
including Local & Remote Craft Interfaces, as well as the TL1
Operations System.
Only one manager at a time can have a Command Session open.
The Craft Interface can have multiple nested Command sessions.
Command Sessions left idle for more than one minute are
automatically terminated. In case of a Craft Session, activity by
any TL1 manager keeps all Craft sessions active.
Command Format
RTRV-CMDSSN:[tid]:aid_com:[ctag][:];
Command Parameters
aid_com Access identifier for all common equipment. The value is COM.

M c COMPLD
/* RTRV-CMDSSN:[tid]:aid_com:[ctag][:] */
aid_com:cmdssn_owner
;

Error Response
M c DENY
/* RTRV-CMDSSN:[tid]:aid_com:[ctag][:] */
errcde
;
Response Parameters

COMPLD Completed
aid_com As described for command syntax
cmdssn_owner Owner of the Command Session. Valid values are:
AWS ADSL workstation (or another SNMP Manager)
CRAFT TL1 Manager (Local Craft, Remote Craft, or TL1 OS)
Example Retrieve information about active Command Sessions.

RTRV-CMDSSN:RALGH:COM:42;
RALGH 99-01-24 12:30:43
M 42 COMPLD
/* RTRV-CMDSSN:RALGH:COM:42 */
COM:AWS
COM:CRAFT
;
Related Commands RTRVCMDSSN

STACMDSSN
STPCMDSSN

4.12 RTRVHDR
Function Retrieves the NE header information.
Command Format
RTRV-HDR:[tid]::[ctag][:];
Command Parameters

M c COMPLD
/* RTRV-HDR:[tid]::[ctag][:] */
;
Error Response
M c DENY
/* RTRV-HDR:[tid]::[ctag][:] */
errcde
;

Response Parameters

COMPLD Completed
Example Retrieve header information for the RALGH NE.

RTRV-HDR:RALGH::42;
RALGH 98-11-24 12:30:43
M 42 COMPLD
/* RTRV-HDR:RALGH::42 */
;

4.13 RTRVLOG
Function Retrieves selected logs.
Command Format
RTRV-LOG:[tid]::[ctag]::lognms;
Command Parameters
lognms Names of logs to be retrieved. The only supported value is SECURITY.

M c COMPLD
/* RTRV-LOG:[tid]::[ctag]::lognms */
“lognms”
/* logdump */
;
Error Response
M c DENY
/* RTRV-LOG:[tid]::[ctag]::lognms */
errcde
;

Response Parameters

COMPLD Completed
lognms As described for command parameters
logdump Dump of log buffer
Example Retrieve the SECURITY log.

RTRV-LOG:RALGH::40::SECURITY;
RALGH 98-11-24 12:30:43
M 40 COMPLD
/* RTRV-LOG:RALGH::40::SECURITY */
(dump of log buffer)
;
Related Command INITLOG

4.14 RTRVMEM
Function Retrieves the list of software image files available in the NE, along
with the software version associated with each file.
Command Format
RTRV-MEM:[tid]:aid_com:[ctag][:];
Command Parameters
aid_com Access Identifier for all common equipment. The value is COM.

M c COMPLD
/* RTRV-MEM:[tid]:aid_com:[ctag][:] */
filename[,filename,...]
;
Error Response
M c DENY
/* RTRV-MEM:[tid]:aid_com:[ctag][:] */
errcde
;

Response Parameters

COMPLD Completed
filename Name of a software module
Example Retrieve the list of software image files for the RALGH NE.
RTRV-MEM:RALGH:COM:40;
RALGH 98-11-24 12:30:43
M 40 COMPLD
/* RTRV-MEM:RALGH:COM:40 */
(filename)
;

4.15 RTRVNEALL
Function Retrieves common provisioning data associated with the NE.
Command Format
RTRV-NE-ALL:[tid]:[aid_com]:[ctag][:];
Command Parameters
[aid_com] Access Identifier for all common equipment. The value is COM.

M c COMPLD
/* RTRV-NE-ALL:[tid]:[aid_com]:[ctag][:] */
aid_com:ne_nblk
;
Error Response
M c DENY
/* RTRV-NE-ALL:[tid]:[aid_com]:[ctag][:] */
errcde
;

Response Parameters

COMPLD Completed
ne_nblk NE named parameter block containing one or more of the following parameters
(separated by commas):
APSSOAKINT The soaking period for activation of Automatic
protection switching (APS) in 1/100 seconds
(0..4294967295). 0 implies no soaking period
BOOTPVCI ATM VCI of the PVC over which the NE issues BOOTP
requests (32...65535)
BOOTPVPI ATM VPI of the PVC over which the NE issues BOOTP
requests (0...4000). Default is 0.
CMDSSNTMO Timeout for an idle command session (see
STACMDSSN or STPCMDSSN), in seconds
(0...65535). A value of 0 disables the timeout feature.
DEFROUTER IP address of default IP router (if a router is used to
connect the AWS). Values are:
ddd.ddd.ddd.ddd (IP address, where ddd = 0...255)
NONE (No default IP router is used)
AWS must be used to configure SNTP.
EPSSOAKINT The soaking period for activation of equipment
protection switching (EPS) in 1/100 seconds
(0..4294967295).. 0 implies no soaking period
MEMALM Status of alarm condition indicating loss or corruption
of persistent memory. Values are:
ACTIVE (Persistent memory lost or corrupted)
CLEAR (Persistent memory OK)
After a loss or corruption of persistent memory is cor
rected, the alarm condition must be manually cleared
using the MEMALM=CLEAR parameter of the SETNE
ALL command.

ne_nblk (cont) MEMDNLD Whether external download of system persistent

database is enabled. External download is typically
used to restore the database from a previous backup
version (see INITSYS). Values are:
ENABLED (Download is allowed)
DISABLED (Download is not allowed)
MEMSYNC Persistent memory synchronization in protection mode.
Values are:
DISABLED(Memory synchronization is disabled)
ENABLED(Memory synchronization is enabled)
NETPOS Position of the NE in the access subnetwork. Valid
values are:
HUB (NE is directly connected to the network)
SUBTENDING (NE is subtending from another ASAM.
No VClevel connections are allowed for a subtending
NE.)
Note: This parameter is not used and is available only
for backward compatibility. It will be removed in a fu
ture release.
POTSTSTDUR Duration of the ADSL facility POTS test in minutes
(0...60). See STATSTADSL command.
SNTP Use of Simple Network Time Protocol to maintain NE
clock. Values are:
ENABLED (Use SNTP)
DISABLED (Use NE local time set by SETDAT com
mand)
TZOFFSET Offset of local time zone from GMT/UTC, in minutes
(780...780). Used by the system if SMTP=ENABLED.

Example Retrieve the common provisioning data associated with the

RALGH NE.
RTRV-NE-ALL:RALGH:COM:40;
RALGH 00-11-24 12:30:43
M 40 COMPLD
/* RTRV-NE-ALL:RALGH:COM:40 */
COM:BOOTPVPI=0,BOOTPVCI=32
;
Related Commands INITSYS

SETDAT
SETNEALL
STACMDSSN
STPCMDSSN

4.16 RTRVPORT
Function Retrieves a port in the NE, based on the optional Port Identifier
label associated with the port.
Restrictions All parameters in this command are positiondefined. If the Port

Identifier is not unique, the first port that matches the specified
value is returned.
Command Format
RTRV-PORT:[tid]:[port_type]:[ctag]::port_id;
Command Parameters
[port_type] Type of port to be retrieved. The only valid value is ALL.
port_id Port Identifier label (1...32 characters) associated with the port to be retrieved.
The label is assigned with the RESVNEXTPORT command or the PORTID
parameter of the EDADSL and EDSHDSL commands.

M c COMPLD
/* RTRV-PORT:[tid]:[port_type]:[ctag]::port_id */
port_type:port_aid
;
Error Response
M c DENY;
/* RTRV-PORT:[tid]:[port_type]:[ctag]::port_id */
errcde
;

Response Parameters

COMPLD Completed
port_type Type of port. Values are:
ADSL ADSL port
SHDSL SHDSL port
port_aid AID of the user port. Values are:
ADSLrackshelfslotcircuit
shelf Shelf number (1...4 for ADSL; 1...3 for SHDSL)
Example Retrieve the first port associated with user HARRINGTON.

RTRV-PORT:RALGH:ALL:42::HARRINGTON;
RALGH 00-11-24 12:30:43
M 42 COMPLD
/* RTRV-PORT:RALGH:ALL:42::HARRINGTON */
ADSL:ADSL-3-2-7-1
;

EDT1
RESVNEXTPORT

4.17 RTRVSYNCN
Function Retrieves the configuration of the reference source to be used for

synchronization of the NE clock.
Command Format
RTRV-SYNCN:[tid]:[aid_syncn]:[ctag][:];
Command Parameters
[aid_syncn] AID of the NE clock. The value is CLKSRCNT.

M c COMPLD
/* RTRV-SYNCN:[tid]:[aid_syncn]:[ctag][:] */
aid_syncn::[syncn_nblk]
;
Error Response
M c DENY
/* RTRV-SYNCN:[tid]:[aid_syncn]:[ctag][:] */
errcde
;

Response Parameters

COMPLD Completed
[aid_syncn] As described for command parameters
syncn_nblk Clock synchronization parameter block. The block consists of the following
parameter, followed by an equal sign and a value.
PRICREF Primary reference source for synchronizing the clock.
Values are:
LOOP (Loop timing recovered from network side facili
ty)
LOCAL (Local oscillator on NT board)
REDNT (Local oscillator on redundant NT board)
Example Retrieve the configuration of the reference source for

synchronization of the NE clock.
RTRV-SYNCN:RALGH:CLKSRCNT:42;
RALGH 99-11-24 12:30:43
M 42 COMPLD
/* RTRV-SYNCN:RALGH:CLKSRCNT:42 */
CLKSRCNT::PRICREF=LOCAL
;
Related Commands DLTSYNCN

EDSYNCN
ENTSYNCN

4.18 SETDAT
Function Sets the date and time in the NE.

Resetting the NT or the ASAM also resets the date and time.
Command Format
SET-DAT:[tid]::[ctag]::date,time;
Command Parameters
date Date in the following format:
mmddyy Month, day, and year
mm Month (1...12)
dd Day (1...31)
yy Year (00...99)
Note: Following interpretation is used for yy:
00..69 --> 2000...2069
70..99 --> 1970...1999
Current implementation restricts dates between 1970
and 2035.
time Time in the following format:
hh Hour (00...23)
mm Minute (00...59)
ss Second (00...59)


M c COMPLD
/* SET-DAT:[tid]::[ctag]::date,time */;
Error Response
M c DENY
/* SET-DAT:[tid]::[ctag]::date,time */;
errcde
;
Response Parameters

COMPLD Completed
Example Set the date to 20 December 2000 and the time to 11:23:45 in
the RALGH NE.
SET-DAT:RALGH::42::12-20-00,11-23-45;
RALGH 00-12-20 11:23:45
M 42 COMPLD
/* SET-DAT:RALGH::42::12-20-00,11-23-45 */
;
Related Command None.

4.19 SETNEALL
Function Sets miscellaneous provisioning parameters in an NE.
Command Format
SET-NE-ALL:[tid]:[aid_com]:[ctag]:::ne_nblk;
Command Parameters
[aid_com] Access Identifier for all common equipment. The value is COM.
ne_nblk NE named parameter block containing one or more of the following parameters
(separated by commas):
BOOTPVPI ATM VPI of the PVC over which the NE issues BOOTP
requests (0...4000). The default is 0.
BOOTPVCI ATM VCI of the PVC over which the NE issues BOOTP
requests (32...65535). The default is 32.
CMDSSNTMO Timeout for an idle command session (see
STACMDSSN or STPCMDSSN), in seconds
(0...65535). A value of 0 disables the timeout feature.
DEFROUTER IP address of default IP router (if a router is used to
connect the AWS). Values are:
ddd.ddd.ddd.ddd (IP address, where ddd =
1...255)
NONE (No default IP router is used)
MEMALM Used to clear an alarm condition indicating loss or
corruption of persistent memory (see RTRVNEALL).
Valid values are:
CLEAR (persistent memory OK)
ACTIVE (persistent memory lost/corrupted
Note: An active alarm must be cleared after restoring
memory.
MEMDNLD Whether external download of system persistent
database is enabled (see RTRVNEALL). The only valid
value is ENABLED.

ne_nblk (cont) NETPOS Position of the NE in the access subnetwork. Valid

values are:
HUB (NE is directly connected to the network)
SUBTENDING (NE is subtending from another ASAM.
No VClevel connections are allowed for a subtending
NE.)
Note: This parameter is not used and is available only
for backward compatibility. It will be removed in a fu
ture release.
POTSTSTDUR Duration of the ADSL facility POTS test in minutes
(0...60). See STATSTADSL command.
SNTP Use of Simple Network Time Protocol to maintain NE
clock. Values are:
ENABLED (Use SNTP)
DISABLED (Do not use SNTP; use NE local time set by
SETDAT command)
AWS must be used to configure SNTP.
TZOFFSET Offset of local time zone from GMT/UTC, in minutes
(780...780). Used by the system if SMTP=ENABLED.
APSSOAKINT The soaking period for activation of Automatic
protection switching (APS) in 1/100 seconds
EPSSOAKINT The soaking period for activation of equipment
protection switching (EPS) in 1/100 seconds
MEMSYNC Persistent memory synchronization in protection mode.
Values are:
DISABLED(Memory synchronization is disabled)
ENABLED(Memory synchronization is enabled)
Only parameters specified in the Ne_nblk will be changed. Other parameters re
main unchanged


M c COMPLD
/* SET-NE-ALL:[tid]:[aid_com]:[ctag]:::ne_nblk */
;
Error Response
M c DENY
/* SET-NE-ALL:[tid]:[aid_com]:[ctag]:::ne_nblk */
errcde
;
Response Parameters

COMPLD Completed
Example Set the common provisioning parameters for the RALGH NE.
SET-NE-ALL:RALGH:COM:40:::BOOTPVPI=4003,BOOTPVCI=29730;
RALGH 00-11-24 12:30:43
M 40 COMPLD
/* SET-NE-ALL:RALGH:COM:40:::BOOTPVPI=4003,BOOTPVCI=29730 */
;
Related Commands RTRVNEALL

SETDAT
STATSTADSL
STPTSTADSL

4.20 SETSID
Function Sets the system identifier (SID) of the NE. The SID is used to
uniquely identify an NE in the system, so the SID must be unique
for each NE.

The SID is used to uniquely identify an NE in the system, so the
SID must be unique for each NE.
SET-SID:[tid]::[ctag]::sid;
Command Format
Command Parameters
sid System identifier (SID). A text string of up to 20 characters containing only letters,
digits or hyphens. It is recommended to use the NEs CCLI code as the SID.
Note: The SID is casesensitive.


M c COMPLD
/* SET-SID:[tid]::[ctag]::sid */;
Error Response
M c DENY
/* SET-SID:[tid]::[ctag]::sid */;
errcde
;
Response Parameters

COMPLD Completed
Example Set the SID for the RALGH NE to RALEIGHNC".

SET-SID:RALGH::42::RALEIGH-NC;
RALGH 98-12-20 11:23:45
M 42 COMPLD
/* SET-SID:RALGH::42::RALEIGH-NC */
;

4.21 STACMDSSN
Function Initiates a Command Session on behalf of the issuing manager.
Restrictions While a Command Session is in progress, only the owner of the

session can modify the NE database.
supported:
Operations System.
Only one Manager can have an active Command Session at one
time. The Craft Interface can have multiple nested Command
Sessions. Command Sessions left idle for more than one minute
are automatically terminated. Activity by any TL1 manager keeps
all Craft Command Sessions active.
Command Format
STA-CMDSSN:[tid]:aid_com:[ctag][:];
Command Parameters


M c COMPLD
/* STA-CMDSSN:[tid]:aid_com:[ctag][:]; */
;
Error Response
M c DENY
/* STA-CMDSSN:[tid]:aid_com:[ctag][:]; */
aid_com:ERRCDE=errcde
;
Response Parameters

COMPLD Completed
Example Initiate a Command Session.

STA-CMDSSN:RALGH:COM:42;
RALGH 99-01-24 12:30:43
M 42 COMPLD
/* STA-CMDSSN:RALGH:COM:42 */
;

STPCMDSSN

4.22 STPCMDSSN
Function Terminates any active 'Command Session' owned by the issuing

manager.
Restrictions All TL1 managers share ownership of their Command Sessions, so

care should be exercised when issuing this command.
supported:
Operations System.
Only one manager at a time can have an active Command
Session. The Craft Interface can have multiple nested Command
Sessions. Command Sessions left idle for more than one minute
are automatically terminated. Activity by any TL1 manager keeps
all Craft Command sessions alive.
Command Format
STP-CMDSSN:[tid]:aid_com:[ctag][:];
Command Parameters


M c COMPLD
/* STP-CMDSSN:[tid]:aid_com:[ctag][:]; */
;
Error Response
M c DENY
/* STP-CMDSSN:[tid]:aid_com:[ctag][:]; */
aid_com:ERRCDE=errcde
;
Response Parameters

COMPLD Completed
Example Terminate any active Command Sessions.

STP-CMDSSN:RALGH:COM:42;
RALGH 99-01-24 12:30:43
M 42 COMPLD
/* STP-CMDSSN:RALGH:COM:42 */
;

STACMDSSN

Appendix A Alarms and Events

A.1 General Description
This appendix provides tables that summarize the provisionable
and nonprovisionable characteristics of the condition types used
by the ASAM. Condition types help you to isolate the type of error
to minimize the time taken to clear delays. These tables should be
useful after initial provisioning. (Refer to the Task Oriented
Procedures manual for complete provisioning instructions.)
When errors are detected by the system, you are notified by either:
Retrieving current alarm conditions using TL1 commands or
Receiving automatically generated system status and event
reporting through autonomous messages.
A.2 Retrieving Current Status of Alarms and Conditions
Provisionable alarm conditions have associated notification codes
with varying degrees of severity. Although these alarms have
default notification codes, most codes can be changed using the
set attribute (SETATTR<xxx>) TL1 commands, where <xxx>
represents the entity associated with the alarm condition. When
the notification codes are set, the current alarm conditions can be
retrieved at any time using the retrieve alarm (RTRVALM<xxx>)
and retrieve condition (RTRVCOND<xxx>) TL1 commands for
an entity. The standard alarm notification codes are:
CR Critical alarm
MJ Major alarm
MN Minor alarm
A.3 Table Description

The tables in this appendix are organized by entities that are valid
for the ASAM. Each condition type is listed with the default
notification code values, serviceaffecting/nonserviceaffecting
behavior codes, and brief descriptions.
Default Notification In the following tables, the default notification code column lists
Code (NTFCNCDE) the default alarm notification codes for the equipment or facility.
Most notification codes can be changed by the SETATTR TL1
command for that entity.

If the notification code is Critical, Major, or Minor, an alarm

autonomous message (REPTALM) reports changes in the alarm
condition for in service (IS) entities. If the entity is outofservice
(OOSMA), reporting is suppressed. The RTRVALM or
RTRVCOND commands are used to retrieve the current state of
the alarm.
Serviceaffecting/Non Serviceaffecting behavior is listed as either serviceaffecting (SA)

serviceaffecting or nonserviceaffecting (NSA).
Behaviour ADSL Conditions
SERVICE DEFAULT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁ ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
FACTERM
ÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
AFFECTING?
SA
NTFCNCDE
Major
DESCRIPTION
Modem could not initialize
ÁÁÁÁÁÁÁ
LCDI*ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ ÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
Minor Loss of cell delineation, interleaved
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
LCDF* SA Minor Loss of cell delineation, fast
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
LOF SA Minor Loss of frame
ÁÁÁÁÁÁÁ
LOL
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
LOS ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
Loss of link
Loss of signal
ÁÁÁÁÁÁÁ
LPR
CFGERR
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Critical
Loss of power
Modem activation failedconfig error
COMMF SA Major Unable to communicate w/ peer modem
CAPINSUF SA Major Line capacity insufficient to meet config
NOPEER SA Minor No peer modem detected
LORATE SA Minor Line rate is below planned rate
CELLDSCUP* SA Minor Upstream cell discard
ÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
CELLDSCDN* SA Minor Downstream cell discard
*ATM alarms reported via the ADSL facility

Common Equipment / NE (COM) Conditions

SERVICE DEFAULT
CONDITION AFFECTING? NTFCNCDE DESCRIPTION
INIT SA Critical System ans backup memory reset

IQCLKOOL SA Critical IQ-bus clock not locked to reference
IQREFCLK SA Critical IQ-bus reference clock lost
SNTPCOM NSA Major Unable to communicate w/ SNTP server
SWCAP NSA Major Loss of protection switching
DISKSPACE NSA Major Disk is 90% full
E1 Facility Conditions
SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ACTLPBK
ÁÁÁÁÁÁÁÁ
AIS ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ ÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
Facility placed in loopback
Alarm indication signal
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
FAULTIMA**
ÁÁÁÁÁÁÁÁ
LCD*
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
IMA link fault
Loss of ATM cell delineation
ÁÁÁÁÁÁÁÁ
LIF**
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA Minor Loss of IMA frame
ÁÁÁÁÁÁÁÁ
LODS**ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA Minor IMA link out of delay synchronization
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
MISMATCH SA Minor Interface does ot match configuration
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
LOF SA Major Loss of framing
ÁÁÁÁÁÁÁÁ
LOS
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
MISCONN** ÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
Loss of signal/clock
IMA link misconnected
ÁÁÁÁÁÁÁÁ
RAI
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
RFIIMA**
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
Remote alarm indication
IMA remote failure indication
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
UNUSABLEIMA**
SA
ÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
Minor IMA link unusable due to farend
behavior
*ATM condition reported via the T1 facility (for E1s directly transporting ATM)
**IMA condition reported via the T1 facility (for E1s used as a link with IMA)

Environment (ENV) Conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁ
AFFECTING?
NTFCNCDE DESCRIPTION
ÁÁÁÁÁÁÁ
MISC*
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA
Minor Miscellaneous environment alarm
*There are five miscellaneous alarms, corresponding to AIDs ENV1 through ENV5.
Equipment Conditions
SERVICE DEFAULT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ATMHW
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
BUSCFG ÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Major
Critical
ATM hardware error
Backplane configuration error
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
COMMERR
ÁÁÁÁÁÁÁÁ
CONTBUS
ÁÁÁÁÁÁÁ
SA
SA
Major
Critical
Failed to communicate with the module
Subrack backplane fault
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
CONTCOM
ÁÁÁÁÁÁÁ
EQPT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Critical
Event
Subrack extender bus fault
Equipment inserted
ÁÁÁÁÁÁÁ
FA ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA Minor Fuse alarm (power fuse blown)
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
FANALM1 NSA Major Fan alarm for Fan1
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
FANALM2
ÁÁÁÁÁÁÁÁ
HITEMP ÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA
NSA
Major
Major
Fan alarm for Fan2
Module temperature exceeded limit
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
IMPROPRMVL
ÁÁÁÁÁÁÁ
INIT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Major
Critical
Improper removal of provisioned module
System and backup memory reset
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
IQCLKOOL
ÁÁÁÁÁÁÁÁ
IQREFCLK
ÁÁÁÁÁÁÁ
SA
SA
Critical
Critical
IQBus clock not locked to reference
IQBus reference clock lost
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
MEMDIF ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA Minor Plugin module does not match
configuration
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
PROGVER
ÁÁÁÁÁÁÁ
NSA Major Failed to load or find requested software
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
RMTDLFAIL ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA Major Failed to download software
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SHUTDOWN SA Major Equipment shutdown due to high
temperature
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SWROLLBK ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA Minor Software version rolled back
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
UNPLANNED NSA Minor Module inserted in slot planned for
NOBOARD
MEMDIFEH NSA Minor Equipment holder config mismatch
DEFENCE SA Critical Equipment shutdowndefense action
EQUIP - Event Module inserted
UNEQUIP - Event Module removed

IMA Group Conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
BLOCKED ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA Minor Group operation inhibited
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
CFGABORT
ÁÁÁÁÁÁÁ
SA
Minor Remote configuration request not
supported
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
INSUFLNKS SA Minor Insufficient number of IMA links to
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
operate
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
STARTUP SA Minor Remote IMA group startup
IMA Link Conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁÁ
LIF *
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
AFFECTING?
SA
NTFCNCDE
Minor
DESCRIPTION
Loss of IMA Frame.
ÁÁÁÁÁÁÁÁ
LODS *ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA Minor IMA Link out of Dealy Sunchronization
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
MISCONN* SA Minor IMA Link misconnected
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
RFIIMA*
ÁÁÁÁÁÁÁ
FAULTIMA* ÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
IMA Remote failure indication
IMA link fault
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
UNUSABLEIMA*
ÁÁÁÁÁÁÁ
SA
Minor IMA Link unusable due to Farend
behavior
*IMA Link related conditions are reported via the associated facilty
(e.g. E1/T1/SHDSL). However their attributes can only be
provisioned using the SET/RTRVATTRIMALNK commands.

SHDSL Conditions
SERVICE DEFAULT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁ
AFFECTING? NTFCNCDE DESCRIPTION
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
LOSW-NS1
SA
ÁÁÁÁÁÁÁ
Minor Loss of sync word - Network Side
Loop1
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
LOSW-NS2
SA
ÁÁÁÁÁÁÁ
Minor Loss of sync word - Network Side
Loop2
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
LOSW-CS1
SA
ÁÁÁÁÁÁÁ
Minor Loss of sync word - Customer Side
Loop1
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
LOSW-CS2
SA
ÁÁÁÁÁÁÁ
Minor Loss of sync word - Customer Side
Loop2
ATENNS1 SA Minor Loop attenuation alarm - Network Side
Loop1
ATENNS2 SA Minor Loop attenuation alarm - Network Side
Loop2
ATENCS1 SA Minor Loop attenuation alarm - Customer Side
Loop1
ATENCS2 SA Minor Loop attenuation alarm - Customer Side
Loop2
SNRNS1 SA Minor Signal to noise ratio alarm - Network
Side Loop1
SNRNS2 SA Minor Signal to noise ratio alarm - Network
Side Loop2
SNRCS1 SA Minor Signal to noise ratio alarm - Customer
Side Loop1
SNRCS2 SA Minor Signal to noise ratio alarm - Customer
Side Loop2
DCCONTNS1 SA Minor DC continuity fault - Network Side
Loop1
DCCONTNS2 SA Minor DC continuity fault - Network Side
Loop2
DCCONTCS1 SA Minor DC continuity fault - Customer Side
Loop1
DCCONTCS2 SA Minor DC continuity fault - Customer Side
Loop2
ACTLPBKNS SA Minor Facility placed in loopback - Network
Side

SERVICE DEFAULT
CONFERR SA Minor Configuration error

LCD SA Minor Loss of ATM Cell Delineation (see Note)
LPR SA Minor Loss of power at STUR
SECUERR SA Minor Unable to disable STUR access
DEVFAIL SA Minor Device Failure
Note These ATM alarms are only supported for STUC and
STUR.
E3 Facility Conditions
SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
RAI ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA MAJOR Remote Alarm Indication
ÁÁÁÁÁÁÁÁ
AIS
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
LOF ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Critical
Critical
Alarm Indication Signal
Loss of framing
ÁÁÁÁÁÁÁÁ
LOS
LCD*
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Critical
Critical
Loss of Signal/Clock
Loss of cell delineation
ACTLPBK SA Critical Network side in loopback
PLMP SA Minor Payload type mismatch
PLU SA Minor Stable payload type
UNEQ-P SA Minor Payload unequipped
CELLSIG SA Critical False startofcell input signal
OVRFLO SA Critical Buffer (FIFO) overflow
UDRFLO SA Critical Buffer (FIFO) underflow
* These ATM conditions are reported via the E3 facility

OC3 facility condition

SERVICE DEFAULT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁ
AISL
ÁÁÁÁÁÁÁ
AFFECTING?
ÁÁÁÁÁÁÁ
SA
NTFCNCDE
Minor
DESCRIPTION
Line alarm indication signal
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
BERLHT ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA Critical Excessive line bit errors
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
RFIL SA Minor Remote failure/defect indication
ÁÁÁÁÁÁÁ
TCVSÁÁÁÁÁÁÁÁ
TCVLFE
ÁÁÁÁÁÁÁ
SA
SA
Minor
Critical
Excessive farend block errors
Excessive section BIP8 errors
LOF SA Critical Section loss of frame
LOS SA Critical Section loss of signal
LOC SA Critical Section loss of clock
CELLSIG SA Critical False startofcell input signal
OVRFLO SA Critical Buffer (FIFO) overflow
REFCLK SA Critical Reference clock failed
FIFOCLK SA Critical FIFO clock failed
LCD* SA Critical Loss of ATM cell delineation
* These ATM conditions are reported via the OC3 facility
STS3C facility conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁ
PLMP
ÁÁÁÁÁÁÁ
AFFECTING?
ÁÁÁÁÁÁÁ
NSA
NTFCNCDE
Minor
DESCRIPTION
Signal Label Mismatch
ÁÁÁÁÁÁÁ
PLU ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
NSA Minor Signal Label Unstable
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
UNEQP NSA Minor Path Unequipped
ÁÁÁÁÁÁÁ
RFIP
TCVPÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Major
Remote Path Failure/Defect Indication
Excessive Path BIP errors
TCVPFE SA Minor Excessive Path Far-End Block Errors
LOP SA Critical STS Loss of Pointer
AISP SA Minor Path Alarm Indication Signal

Signaling channel conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
CONDITION
ÁÁÁÁÁÁÁ
AFFECTING? NTFCNCDE DESCRIPTION
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ANISIGCHN
ÁÁÁÁÁÁÁ
FAILURE
ÁÁÁÁÁÁÁ
SA
Critical Failure of network-side Signaling
Channel
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
UNISIGCHN
ÁÁÁÁÁÁÁ
FAILURE ÁÁÁÁÁÁÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
Minor Failure of user-side Signaling Channel
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
T1-SIGSYS1-PERF
ÁÁÁÁÁÁÁ
NSA
Minor Performance count threshold exceeded on
Signaling Channel
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
T1-SIGSYS1-SUM
ÁÁÁÁÁÁÁ
NSA
Minor Performance summary count threshold
exceeded on Signaling Channel
Signaling subsystem conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
T1-SIGSYS1-PERF
ÁÁÁÁÁÁÁ
NSA
Minor Performance count threshold exceeded for
Signaling Subsystem
T3 (DS3) facility conditions

SERVICE DEFAULT
ÁÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
RAI
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁÁ
AIS
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Minor
Minor
Remote alarm indication
Alarm indication signal
ÁÁÁÁÁÁÁÁ
LOF
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA Major Loss of framing
ÁÁÁÁÁÁÁÁ
LOS
ATMFE
ÁÁÁÁÁÁÁ
ÁÁÁÁÁÁÁ
SA
SA
Critical
Major
Loss of signal/clock
ATM DS3 PLCP Far-End Alarm
ATMLOF SA Major ATM DS3 PLCP Loss of Frame
LCD SA Critical Loss of ATM Cell Delineation


Appendix B Error Codes

An error code is a fourcharacter mnemonic in the response to an
input command that describes why the command cannot be
executed. The error codes are grouped into categories of
equipage (E)
input (I)
multiple error (M)
privilege (P) and
status (S).
The following table lists the error codes, their descriptions, and the
Technical Advisory (TA) or Technical Reference (TR) from which the
error codes originate.
ASAM Error Code Summary
CODE DESCRIPTION TA/TR
ENDS Equipage, not equipped with duplex switching TA200

EQWT Equipage, wrong type TA200
ICNC Input, command not consistent TA200
IDNC Input, data not consistent TA200
IDNV Input, data not valid TA200
IEAE Input, entity already exists TA200
IENE Input, entity not exists (does not exist) TA200
IISP Input, invalid syntax or punctuation TA200
IITA Input, invalid target identifier - the command contains an invalid TID TA200
IPEX Invalid extra input parameter TA200
IPMS Input parameter missing TA200
IPNC Input parameter not consistent TA200
IPNV Input parameter not valid TA200
SAAL Status, already allowed TA200
SAIN Status, already inhibited TA200
SARB Status, all system resources busy TA200
SDNA Status, duplex unit not available TA200
SDNC Status, data not consistent TA200
SLEM Status, list exceed maximum - command processing exceeded system TA200
limit

CODE DESCRIPTION TA/TR
SNVS Status, not in valid state TA200

SRCI Status, requested command(s) inhibited TA200
SROF Status, requested operation failed TA200
SSRE Status, system resources exceeded - the command exceeded the TA200
system limit on a parameter
SSTP Status, command execution stopped - the command execution was TA200
terminated because of a software/hardware problem

Appendix C ATM Addressing

C.1 Introduction
This appendix describes the formats for ATM addresses used in
SVC commands. All four formats specified by the ATM Forum are
supported:
Data Country Code ATM End System Address (AESA)
Internation Code Designator AESA
E.164 AESA
Native E.164
Unformatted AESA addresses are also supported.
C.2 Data Country Code AESA Format
The format for DCC AESA addresses is:
DCC-idi.hodsp.esi.sel
idi Initial Domain Identifier (3 digit decimal).
The value is a 3digit Country Code.
hodsp HigherOrder DomainSpecific Part (20
digit hexadecimal). If fewer than 20 digits
are specified, the value is padded with
trailing zeroes.
esi End System Identifier (12 digit
hexadecimal). If fewer than 12 digits are
specified, the value is padded with trailing
zeroes.
sel Selector (2 digit hexadecimal). If fewer than
2 digits are specified, the value is padded
with trailing zeroes.

C.3 International Code Designator AESA Format

The format for ICD AESA addresses is:
ICD-idi.hodsp.esi.sel
idi Initial Domain Identifier (4 digit decimal).
The value is a 4digit International Code
Designator that identifies an international
organization.
hodsp HigherOrder DomainSpecific Part (20
digit hexadecimal). If fewer than 20 digits
are specified, the value is padded with
trailing zeroes.
zeroes.
C.4 E.164 AESA Format
The format for E.164 AESA addresses is:
AE164-idi.hodsp.esi.sel
idi Initial Domain Identifier (1...15 digit
decimal). The value is an E.164 telephone
number.
hodsp HigherOrder DomainSpecific Part (8 digit
zeroes.
zeroes.

C.5 Native E.164 Format

The format for native E.164 addresses is:
AE164-phone
phone E.164 telephone number (1...15 digit
decimal)
C.6 Unformatted AESA Format
The format for unformatted AESA addresses is:
A-address
address AESA address exactly as it is represented
internally (1...15 digit hexadecimal)


Appendix D System Access Identifiers

This appendix provides information about the System AIDs It first
provides information about the equpment arrangements for:
Standard Density (SD) systems
High Density (HD) systems
Ulta Density (UD) systems.
Then the document lists the Equipment AIDs.
D.1 Standard Density Systems
Figure 1 shows the equipment arrangement for the SD ASAM.
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎShelf Detail
ÎÎÎÎ
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ÎÎÎÎ
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ LT1
ÎÎÎÎ
LT2 LT12 ACU ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ
NTA NTA
ÎÎÎÎ
ATUR
or or
EXA EXB –––
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ÎÎÎÎ ATUR
ÎÎÎÎ
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ASAM (NE)
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ
Rack1 Rack2 Rack3 Rack4
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ Shelf Shelf Shelf Shelf
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ Shelf
Shelf Shelf Shelf
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ Shelf Shelf Shelf Shelf
Shelf Shelf Shelf Shelf
Figure 1 Standard Density ASAM (NE) Equipment Arrangement
A SD ASAM can have a maximum of 4 racks. Each rack can have

up to 4 shelves.
Note The maximum number of shelves allowed in an ASAM
is 12

D.2 HighDensity Systems

Figure 2 shows the equipment arrangement for the HD ASAM.
Shelf Detail
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ TAU
LP1 LP2 –––
or LP1
TEU 6
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ÎÎÎÎÎ
ATUR
ÎÎÎÎÎ
ATUR
ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ATUR
NTA NTA
ACU or or LT1 LT2 ––– LT16
–––
–––
EXA EXB
ATUR
ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ
Rack1 Rack2 Rack3 Rack4 Rack5 Rack6
Shelf Shelf Shelf Shelf Shelf Shelf
Shelf Shelf Shelf Shelf Shelf Shelf
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ASAM (NE)
Figure 2 High Density ASAM (NE) Equipment Arrangement
An HD ASAM can have a maximum of 6 racks. Each rack can up

to 2 shelves.
is 12

D.3 UltraDensity Systems

Figure shows the equipment arrangement for the UD ASAM.
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ÎÎÎÎ
Shelf Detail
ATUR
ÎÎÎÎ
ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ
ATUR
ATUR
NTA NTA
–––
ACU or or LT1 LT2 LT16
–––
–––
EXA EXB
ÎÎÎÎ
ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ATUR
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ
Rack1 Rack2 Rack3
Shelf Shelf Shelf
Shelf Shelf Shelf
Shelf Shelf Shelf
ÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎÎ ASAM (NE)
Figure 3 Ultra Density ASAM (NE) Equipment Arrangement
An UD ASAM can have a maximum of 3 racks. Each rack can up

to 3 shelves.
is 6 because of the limit on the number (2304) lines.

D.4 Equipment Access Identifiers

This sections describes the equipment AIDs used in the A7300
ASAM.
Racks (RACK) The ASAM may have up to 6 racks. The AID for the racks is:
RACKrack
where rack is the racknumber.
Shelves (SHELF) The ASAM may have up to 2 HD shelves (subracks), 3 UD or 4

SD shelves in a rack. The AID for shelves is:
SHELFrackshelf
where rack is the rack number and shelf is the shelf
number (1...4).
Network Termination The NT are always located in the first shelf of the first rack in a
Units (NT) system (ASAM). The primary NT unit is the NTA, while the
secondary or backup unit is the NTB. The AIDs for the NT are:
{NT|NTA|NTB}
Server Units (SERV) Server Units are special boards that use the LT slots in shelf 1 and
which support auxillary services in the ASAM. The AID for the
Server Units is:
SERVrackshelfsv_slot
Note: Presently
Note Server units may only be placed in rack 1, shelf 1. In
this release the only server unit supported is the IP
Gateway type A (IPGWA).
IP Gateway Server The AID for IP Gateway (IPGW) server units is

(IPGW) IPGWrackshelfsv_slot
Note Server units may only be placed in rack 1, shelf 1
The IPGW server is a twoslot card that must be
planned in a slotpair.
Slots are paired as 12, 34, .., 1516. The sv_slot
used must be the lower slot number in the pair (e.g.,
1 for 12, 3 for 34, .. 15 for 1516).

Shelf Extender Units All subsequent shelves in the system are configured with Shelf
(EX) Extender (EX) units instead NTs. The extender units connect the
shelf to the previous one in daisychain fashion. The extender units
correspond to NT units in the first shelf and have primary unit
EXA, and backup unit EXB. The AIDs for Shelf Extender units are:
{EX|EXA|EXB}rackshelf
Note rack=1, shelf=1 is not a valid AID for an Extender
since this location is only used for an NT.
Line Termination Units Each shelf in the ASAM supports LT units in LT slots 1..12 for SD
(LT) shelves and slots 1..18 for HD shelves. The AIDs for the Line
Termination units are:
LTrackshelflt_slot
Line Termination Each LT in the HD shelf is associated with a separate applique unit
Applique Units (LP) that performs LT support functions. The AID for the LP units is:
LPrackshelflt_slot
Note LP Units are not managed in release 4.2.
Test Access Unit (TAU) The ASAM supports a single TAU for HD systems that is located in
and Test Extender Units the first system shelf (rack 1, shelf 1). This unit supports external
(TEU) test access to circuits in the LT. The TAU connects to other shelves
via a daisychain connection using the TEUs located in the same
slot in all subsequent shelves in the system. The AIDs for the TAU
TEU are:
TAU
The TAU is always located in rack 1, shelf 1.
TEUrackshelf
The TEU is located in shelves other than rack 1, shelf 1.
Note The TAU and TEUs are not managed in release 4.2.
Alarm Control Unit Each shelf has a slot for an ACU. However, only one ACU is
(ACU) needed for each rack of an ASAM. ACUs may only be installed in
the first shelf of every rack except the first rack. In the first rack the
ACU must be in the same shelf as the NT. The AID is:
ACUrackshelf

ATUR (ATUR) The ADSL Termination Unit Remote (ATUR ) or the ADSL modem
at the customer premises is managed in a limited way by the
ASAM. The ATUR is identified by the ADSL circuit to which it is
connected via the LT. The AID is:
ATURrackshelflt_slotcircuit
D.5 Transport Facility Access Identifiers
This section describes the AIDs associated with the transport
facility.
ADSL Facilities (ADSL) Each ADSL LT supports ADSL Termination UnitCentral (ATUC)
modems. Each modem supports a single ADSL line or circuit. The
AID for ADSL lines is:
Note SD LTs support 4 circuits
HD LTs support 12 circuits
UD LTs support 24 circuits.
OC3 and STS3C The SONETNT units (NTA and NTB) and SONETLT units support
Facilities corresponding OC3 and STS3C facilities. The AIDs for these
facilities are:
NT Facilities:
{NTOC3|NTOC3A|NTOC3B}
{NTSTS3C|NTSTS3CA|NTSTS3CB}
LT Facilities:
LTOC3rackshelflt_slotcircuit
LTSTS3Crackshelflt_slotcircuit
E1 Facilities The E1NT units support corresponding E1 facilities. The AIDs for
the NT E1 facilities are:
NTE1circuit
E3 Facilities The E3NT units (NTA and NTB) support corresponding E3

facilities.The AIDs for the NT E3 facilities are:
{NTE3|NTE3A|NTE3B}

DS1 Facilities The ASAM supports DS1 facilities on DS1LT cards.The AID for
these DS1 facilities is:
LTT1rackshelflt_slotcircuit
Note Only HD LTs are supported. Each supports 8 circuits.
DS3 Facilities The DS3NT units (NTA and NTB) support corresponding DS3
facilities. The AIDs for the NT DS3 facilities are:
NT Facilities:
{NTT3|NTT3A|NTT3B}
LT Facilities:
LTT3rackshelflt_slotcircuit
Note DS3LT units are only supported for HD and UD
systems in release 4.2.
SHDSL Facilities The A7300 ASAM supports SHDSL LT cards. SHDSL facilities in the
LT card are accessed via the following AIDs:
(SHDSL facility in the LT)
LTSHDSLDEVrackshelflt_slotcircuitunit
(A unit in the SHDSL facility in the LT)
where unit = SHDSL unit in a span (1..2)
unit 1 = STUC
unit 2 = STUR
LTSHDSLSEGrackshelflt_slotcircuitunitside
(A segment in the SHDSL facility)
where side = Side of the unit:
N Network Side
C Customer Side
LTSHDSLSWPrackshelflt_slotcircuitunitsidewirepair
(A specific wirepair associated with an SHDSL Segment)
where wirepair = The wirepair in a segment:
1 Pair1 (only pair in a 2wire mode)
2 Pair2 (second pair in a 4wire mode)
Voice Gateway The system supports VALT LT cards. Voice gateway facilities in the
Facilities LT card are accessed via AID:
LTVOXPORTrackshelflt_slotcircuit

D.6 Miscellaneous Access Identifiers

This section describes various miscellaneous AIDs.
ATM Port ATM Ports in the NE are identified by the following AIDs:
NTATM
LTATMrackshelflt_slotcircuit
LTIMAATMrackshelflt_slotimagrp
SERVATMrackshelfserv_slotcircuit
Where:
imagrp is the IMA Group number in the LT
serv_slot is the slot number where the Server card is installed.
ATM Virtual Path Link The Virtual Path Links in the ATM facilities on the NT and the LT
(VPL) side are identified by the following AIDs:
NTVPLvpi
LTVPLrackshelflt_slotcircuitvpi
Where vpi is the VPI (Virtual Path Identifier) for the VPL.
ATM Virtual Channel The Virtual Channel Links in the ATM facilities on the NT and the
Link (VCL) LT side are identified by the following AIDs:
NTVCLvpivci
LTVCLrackshelflt_slotvpivci
Where vpi is the VPI (Virtual Path Identifier), and vci is the VCI
(Virtual Channel Identifier) for the VCL.
IMA Group (IMAGRP) The ASAM supports the use of ATM Forum's Inverse Multiplexing
for ATM (IMA) for E1, DS1 and SHDSL facilities. The AIDs for the
IMA Groups are:
NTIMA (for E1 NT)
LTIMArackshelflt_slotimagrp
Where imagrp is the IMA Group number in the card:
1..4 : SD and HD E1 boards
1..8 : HD and UD DS1 boards
1..24 : HD and UD SHDSL boards.

Signaling Channel The ASAM system supports SVC capability. The AIDs for accessing
(SIGCHN) Signaling Channels are:
NTSIGCHN
LTSIGCHNrackshelflt_slotcircuit
LTIMASIGCHNrackshelflt_slotimagrp
Signaling Subsystem The ASAM supports SVC capability. The AID for accessing the
(SIGSYS) Signaling Subsystem is:
SIGSYS
SVC User (SVCUSR) The ASAM supports SVC capability. The AID for accessing an SVC
User is as follows:
<ATM Address>
The addresses are entered via TL1 in one of the following formats:
Native E.164: E164ddddddddddddddd (1..15 digits)
AESA DCC: DCCdddF.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxx.xx
AESA ICD: ICDdddd.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxx.xx
AESA E.164: AE164dddddddddddddddF.xxxxxxxx.xxxxxxxxxxxx.xx
Unformatted AESA : Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
(2..40 digits)
where:
d = '0' .. '9' (decimal digit)
x = '0' .. 'F' (hexadecimal digit)
F = Optionally specified hexadecimal 'F' digit
IPPort (IPPORT) The ASAM supports ports for communications via the Internet
Protocol. The following AIDs support ports that can be configured
by the user:
ATM1 The first IPoverATM port in the NT
NTENET The IP over Ethernet interface in the NT
Environment (ENV) The ASAM supports 5 external alarm sensing inputs via the ACU.
These can be customized for any environment alarm. These
environment alarm inputs are identified by:
ENV<number>
Where <number> is the number of the alarm input from 1..5.

D.7 Generic Group Access Idenfifiers

The ASAM defines some generic AIDs that represent a group
(class) of objects in the NE. These are used in conjunction with
functions that can only be performed on the group or class as a
whole. Example of these functions include changing Alarm
Attributes which are defined for the group. The following generic
group AIDs are supported:
ALL Represents all entities of the type defined by
the command modifier
COM Represents objects that are common or
shared by all entities in the NE
EQPT Represents every equipment in the NE
ADSL Represents every ADSL facility in the NE
OC3 Represents every OC3 facility in the NE
STS3C Represents every STS3C facility in the NE
E1 Represents every E1 facility in the NE
E3 Represents every E3 facility in the NE
T1 Represents every T1/DS1 facility in the NE
T3 Represents every T3/DS3 facility in the NE
SHDSL Represents every SHDSL facility in the NE
IMAGRP Represents every IMA Group entity in the
NE
IMALNK Represents every IMA Link entity in the NE
SIGCHN Represents every signaling channel in the
NE
SIGSYS Represents the Signaling Subsystem in the
NE
IPGW Represents all instances of IP Gateway
server cards

TL1 Commands and Messages Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TL1 Commands and Messages Guide

Uploaded by

Copyright:

Available Formats

7300 ASAM

TL1 Commands and Messages

3EC 36876 AEAA TCZZA Edition 02

Short Title TL1 Commands & Messages

2 / 166 3EC 36876 AEAA TCZZA Edition 02

1 E1 Commands and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3EC 36876 AEAA TCZZA Edition 02 3 / 166

3.2 ENV Autonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

4 / 166 3EC 36876 AEAA TCZZA Edition 02

3EC 36876 AEAA TCZZA Edition 02 5 / 166

6 / 166 3EC 36876 AEAA TCZZA Edition 02

1 E1 Commands and Messages

3EC 36876 AEAA TCZZA Edition 02 7 / 166

Function Deletes an existing E1 facility in the NE.

Restrictions All parameters in this command are positiondefined.

8 / 166 3EC 36876 AEAA TCZZA Edition 02

Response Format Normal Response

tid Target NE identification

Example Delete LT E1 circuit located at rack 3, shelf 2, slot 6.

Related Command EDE1

3EC 36876 AEAA TCZZA Edition 02 9 / 166

Function Edits the provisioning data associated with an E1 facility. It

Restrictions All parameters in this command are positiondefined.

10 / 166 3EC 36876 AEAA TCZZA Edition 02

3EC 36876 AEAA TCZZA Edition 02 11 / 166

12 / 166 3EC 36876 AEAA TCZZA Edition 02

Response Format Normal Response

tid Target NE identification

Example Edit circuit 2 on the NT to have a line type of DSX1E1.

Related Commands DLTE1

3EC 36876 AEAA TCZZA Edition 02 13 / 166

Function Creates the provisioning data associated with an E1 facility. It also

Restrictions All parameters in this command are positiondefined.

14 / 166 3EC 36876 AEAA TCZZA Edition 02

3EC 36876 AEAA TCZZA Edition 02 15 / 166

Response Format Normal Response

16 / 166 3EC 36876 AEAA TCZZA Edition 02

tid Target NE identification

Example Enter E1 circuit 22101 on the LT with a line interface type of

Related Commands FREEPORT

3EC 36876 AEAA TCZZA Edition 02 17 / 166

Function Places the selected E1 facility in a loopback mode.

Restrictions All parameters in this command are positiondefined.

18 / 166 3EC 36876 AEAA TCZZA Edition 02

Response Format Normal Response

sid Source NE identification

3EC 36876 AEAA TCZZA Edition 02 19 / 166

Example Place NTE1 circuit 2 in payload loopback mode.

Related Command RLSLPBKE1

20 / 166 3EC 36876 AEAA TCZZA Edition 02

Function Reports current operational parameters for E1 lines.

Restrictions All parameters in this command are positiondefined.

Response Format Normal Response

3EC 36876 AEAA TCZZA Edition 02 21 / 166

tid Target NE identification

Example Report E1 operational parameters for rack 2, shelf 3, slot 6,

Related Commands None.

22 / 166 3EC 36876 AEAA TCZZA Edition 02

Function Releases any loopback currently active at the near end of a

Restrictions All parameters in this command are positiondefined.

3EC 36876 AEAA TCZZA Edition 02 23 / 166

Response Format Normal Response

sid Source NE identification

Restrictions All parameters in this command are positiondefined.

Related Command EDE1

Restrictions All parameters in this command are positiondefined.

Related Commands DLTE1

Restrictions All parameters in this command are positiondefined.

Example Enter E1 circuit 22101 on the LT with a line interface type of

Related Commands FREEPORT

Restrictions All parameters in this command are positiondefined.

Related Command RLSLPBKE1

Restrictions All parameters in this command are positiondefined.

Restrictions All parameters in this command are positiondefined.

Related Command OPRLPBKE1

Restrictions All parameters in this command are positiondefined.

Example Retrieve serviceaffecting critical alarms for NT circuit 2.

Function Retrieves current attributes of E1 facilityrelated conditions.

Restrictions All parameters in this command are positiondefined.

Related Commands SETATTRE1

Restrictions All parameters in this command are positiondefined.

Restrictions All parameters in this command are positiondefined.

Related Command RTRVALME1

Restrictions All parameters in this command are positiondefined.

Related Commands ENTE1

Function Sets attributes of E1 facilityrelated alarm conditions.

Restrictions All parameters in this command are positiondefined.

Related Command RTRVATTRE1