Part 5/5
Edition 02
Released 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
Edition 02
Contents
Contents
1 E1 Commands and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1 E1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.1 DLT E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.2 ED E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.3 ENT E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.4 OPR LPBK E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.5 REPT OPSTAT E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.6 RLS LPBK E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.7 RTRV ALM E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.8 RTRV ATTR E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.9 RTRV COND E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.10 RTRV PM E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.11 RTRV E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.12 SET ATTR E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E1 Autonomouse Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.1 REPT ALM E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.2 REPT EVT E1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E1 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E1 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E3 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.1 ED E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.2 RTRV ALM E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.3 RTRV ATTR E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.4 RTRV COND E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.5 RTRV PM E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.6 RTRV E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.7 SET ATTR E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E3 Autonmous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.2.1 REPT ALM E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.2.2 REPT EVT E3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E3 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E3 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ENV Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.1 RTRV ALM ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.2 RTRV ATTR ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.3 RTRV COND ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.4 SET ATTR ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 8 8 10 14 18 21 23 25 28 30 33 36 40 42 42 44 46 47 49 50 50 53 56 59 62 65 68 70 70 72 74 75 77 78 78 80 82 84
Edition 02
3 / 166
Contents
3.2 3.3 4 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10 4.11 4.12 4.13 4.14 4.15 4.16 4.17 4.18 4.19 4.20 4.21 4.22 Appendix A Appendix B Appendix C Appendix D
ENV Autonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2.1 REPT ALM ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Environmental (ENV) Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DLT MEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ED SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FREE PORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . INIT LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . INIT SYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RD SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . REPT OPSTAT ICON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . REPT OPSTAT NE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RESV NEXT PORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RST MEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV CMDSSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV HDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV MEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV NE ALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV PORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV SYNCN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET NE ALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET SID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . STA CMDSSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . STP CMDSSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alarms and Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ATM Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Access Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
86 86 88 89 90 92 94 96 98 101 103 105 109 112 114 116 118 120 122 126 128 130 132 135 137 139 141 151 153 157
4 / 166
Edition 02
Contents
Figures
Figure 1 Figure 2 Figure 3 Standard Density ASAM (NE) Equipment Arrangement . . . . . . . . . . . . . . High Density ASAM (NE) Equipment Arrangement . . . . . . . . . . . . . . . . . . Ultra Density ASAM (NE) Equipment Arrangement . . . . . . . . . . . . . . . . . . 157 158 159
Tables
Table 1 Table 2 Table 3 Table 4 Table 5 E1 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E1 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E3 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E3 Monotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ENV Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 47 74 75 88
Edition 02
5 / 166
Contents
6 / 166
Edition 02
Edition 02
7 / 166
1.1
1.1.1
E1 Commands
This section describes the E1 commands.
DLT E1
Function Restrictions
Deletes an existing E1 facility in the NE. All parameters in this command are position defined.
Command Format
DLT-E1:[tid]:aid_e1:[ctag][:];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access Identifier for the E1 facility. Enter in the following format, replacing lower case parameters with the values given: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
Grouping and ranging are allowed. 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.
8 / 166
Edition 02
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* DLT-E1:[tid]:aid_e1:[ctag][:] */ errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix C)
Example
Related Command
ED E1
Edition 02
9 / 166
1.1.2
ED E1
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 (non IMA) mode. All parameters in this command are position defined. The ATM interface must be provisioned with the ENT E1 or ED ATMPORT commands before ATM parameters are edited.
Restrictions
Command Format
ED-E1:[tid]:aid_e1:[ctag]:::[e1_nblk]:[pst];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access Identifier for the E1 facility. Enter in the following format, replacing lower case parameters with the values given: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the Nt or LT (1...4)
Grouping and ranging are allowed. 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.
10 / 166
Edition 02
Parameter [e1_nblk]
Explanation 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 RESV NEXT PORT and FREE PORT com mands
Edition 02
11 / 166
Explanation 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. ATM Access Profile name Connection Admission and Control Profile index for downstream direction (1...50) Connection Admission and Control profile name for the downstream direction Connection Admission and Control Profile index for upstream direction (1...50) 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 ED ATMPORT 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 OOS In Service Out of Service (OOS MA is implied)
12 / 166
Edition 02
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* ED-E1:[tid]:aid_e1:[ctag]:::[e1_nblk]:[pst] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Related Commands
Edition 02
13 / 166
1.1.3
ENT E1
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. All parameters in this command are position defined. 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 ENT IMAGRP .
Restrictions
Command Format
ENT-E1:[tid]:aid_e1:[ctag]:::e1_nblk:[pst];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access Identifier for the E1 facility. Enter in one of the following formats, replacing lower case parameters with the values given: LTE1 rack shelf lt_slot circuit NTE1 circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT(1...4)
Grouping and ranging are allowed. 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. E1 facility parameter block containing one or more of the following named parameters (separated by commas): LINETYPE Type of line interface used. Valid values are: DSXE1 DSXE1CRC (default) 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)
e1_nblk
14 / 166
Edition 02
Explanation 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. ATM Access Profile name Connection Admission and Control Profile index for downstream direction (1...50) Connection Admission and Control profile name for the downstream direction Connection Admission and Control Profile index for upstream direction (1...50) 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 ED ATMPORT command. Note that 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.
Edition 02
15 / 166
Parameter
Explanation 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) LTIMA imagrp (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 OOS In Service Out of Service (OOS MA is implied)
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* ENT-E1:[tid]:aid_e1:[ctag]:::e1_nblk:[pst] */ errcde
16 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Enter E1 circuit 2 2 10 1 on the LT with a line interface type of DSX1E1, a port ID of FRANKLIN, and an IMA group of NTIMA.
Related Commands
Edition 02
17 / 166
1.1.4
OPR LPBK E1
Function Restrictions
Places the selected E1 facility in a loopback mode.
" "
All parameters in this command are position defined. 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 in band loopback control codes. This form of loopback is not maintained persistently. Loopbacks provisioned with this command take priority over in band loopbacks. Only one loopback at a time is allowed on a facility.
"
"
"
"
Command Format
OPR-LPBK-E1:[tid]:aid_e1:[ctag]::,,,[lbktype];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access Identifier for the E1 facility. Valid values are: NTE1 circuit LTE1 rack shelf lt lt_slot circuit rack shelf lt_slot circuit Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
18 / 166
Edition 02
Parameter [ctag]
Explanation 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. Type of loopback. Valid values are: LINE PAYLOAD TERMINAL Loopback facility at the physical line level toward the facility (default) Loopback facility data (payload) toward the facility Loopback facility data internally toward the NE
[lpbktype]
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* OPR-LPBK-E1:[tid]:aid_e1:[ctag]::,,,[lpbktype] */ errcde /* error description */
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Edition 02
19 / 166
Example
Related Command
RLS LPBK E1
20 / 166
Edition 02
1.1.5
REPT OPSTAT E1
Function Restrictions
Reports current operational parameters for E1 lines. All parameters in this command are position defined.
Command Format
REPT-OPSTAT-E1:[tid]:aid_e1:[ctag][:];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access identifier for E1 facility. Enter in the following format, replacing lower case parameters with the values given: LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
Grouping and ranging are allowed. 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
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* REPT-OPSTAT-E1:[tid]:aid_e1:[ctag][:] */ errcde
Edition 02
21 / 166
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_e1 op_e1 Explanation Target NE identification Year (last two digits), month, and day Hour (1...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters E1 operational parameter. Values are: INCELLS OUTCELLS value Rolling count of cells received on this facility Rolling count of cells transmitted on this facility
Example
*/
Related Commands
None.
22 / 166
Edition 02
1.1.6
RLS LPBK E1
Function Restrictions
Releases any loopback currently active at the near end of a specific E1 facility. All parameters in this command are position defined. Provisioned loopbacks (set with the OPR LPBK E1 command) and in band loopbacks (set by E1 in band control codes) are both released.
Command Format
RLS-LPBK-E1:[tid]:aid_e1:[ctag][:];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access identifier for the E1 facility. Valid values are: LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
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.
Edition 02
23 / 166
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RLS-LPBK-E1:[tid]:aid_e1:[ctag][:] */ errcde /* error description */
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Related Command
OPR LPBK E1
24 / 166
Edition 02
1.1.7
RTRV ALM E1
Function Restrictions
Retrieves current alarms for selected E1 facilities. All parameters in this command are position defined.
Command Format
RTRV-ALM-E1:[tid]:aid_e1:[ctag]::[ntfcde],,[srveff],[locn],[dirn];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access Identifier for the E1 facility. Enter in the following format, replacing lower case parameters with the values given: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
Grouping and ranging are allowed. 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. Notification code. Valid values are: CR MJ MN [serveff] Critical alarm Major alarm Minor alarm
[ntfncde]
Grouping is allowed. If no value is specified, ALL is assumed. Service effect. Valid values are: SA NSA Service affecting Not service affecting
Edition 02
25 / 166
Parameter [locn]
Explanation Location of the condition. Valid values are: NEND FEND Near end Far end
If no value is specified, ALL is assumed. [dirn] Direction of the condition. Valid values are: RCV TRMT Receive Transmit
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-ALM-E1:[tid]:aid_e1:[ctag]::[ntfncde],,[srveff],[locn],[dirn] */ errcde /* error description */
26 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_e1 aid_type ntfncde cond_e1 serveff [locn] [dirn] [cond_descr] Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters, except that ALL is not used The type of Access Identifier. The value is E1. As described for command parameters, except that ALL is not used E1 facility condition. Values are as defined in E1 Conditions", Section 1.3 As described for command parameters, except that ALL is not used As described for command parameters As described for command parameters Description of alarm conditionas defined in E1 Conditions", Section 1.3
Example
Related Commands
None
Edition 02
27 / 166
1.1.8
RTRV ATTR E1
Function Restrictions
Retrieves current attributes of E1 facility related conditions. All parameters in this command are position defined.
Command Format
RTRV-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::[ntfcde],[cond_e1],[locn],[dirn];
Command Parameters
Parameter [tid] [aid_all_e1] [ctag] Explanation 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. Access identifier for the all E1 facilities. The value is E1. 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. Notification code. Valid values are: CR MJ MN NA NR [cond_e1] [locn] Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
[ntfncde]
Grouping is allowed. If no value is specified, ALL is assumed. E1 facility condition. Valid values are described E1 Conditions", Section 1.3 Facility location. Valid values are: NEND FEND Near end Far end
Only applicable to conditions supporting location. If no value is specified, ALL is assumed. [dirn] Signal direction. Valid values are: RCV TRMT Receive Transmit
28 / 166
Edition 02
Response Format
M */
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-ATTR-E1:[tid]:aidall_e1:[ctag]::[ntfncde],[cond_e1],[locn],[dirn] */ errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_all_e1 aid_type [ntfncde] [cond_e1] [locn] [dirn] Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters, except that ALL is not used The type of Access Identifier. The value is E1. As described for command parameters, except that ALL is not used As described for command parameters As described for command parameters As described for command parameters
Example
*/
Related Commands
SET ATTR E1
Edition 02
29 / 166
1.1.9
RTRV COND E1
Function Restrictions
Retrieves current conditions of an E1 facility. All parameters in this command are position defined.
Command Format
RTRV-COND-E1:[tid]:aid_e1:[ctag]::[cond_e1],[locn],[dirn];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access identifier for the E1 facility. Valid values are: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
Grouping and ranging are allowed. 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. E1 facility condition. Valid values are deined in E1 Conditions", Section 1.3 Facility location. Valid values are: NEND FEND [dirn] Near end Far end
[cond_e1] [locn]
If no value is specified, ALL is assumed. Signal direction. Valid values are: RCV TRMT Receive Transmit
30 / 166
Edition 02
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-COND-E1:[tid]:aid_e1:[ctag]::[cond_ds1],[locn] */ errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_e1 [aid_type] ntfncde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters The type of Access Identifier. The value is E1. Notification code. Valid values are: CR MJ MN NA NR cond_e1 serveff Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
As described for command parameters, except that ALL is not used Service effect. Valid values are: SA NSA Service affecting Not service affecting
As described for command parameters, except that ALL is not used As described for command parameters, except that ALL is not used Description of alarm condition.
Edition 02
31 / 166
Example
Related Commands
None
32 / 166
Edition 02
1.1.10
RTRV PM E1
Function Restrictions
Retrieves E1 performance monitoring data. All parameters in this command are position defined.
Command Format
RTRV-PM-E1:[tid]:aid_e1:[ctag]::[mone1],[monlev],[locn],[dirn],[tmper], [mondat],[montm];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access identifier for the environment. Valid values are: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4 LT slot number (1...16) Circuit in the NT or LT (1...4)
Grouping and ranging are allowed. 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. Monitored parameter (Monotype). Valid values are given in E1 Monotypes, Section 1.4 Threshold level. Enter in the following format: lev dirn lev dirn Level (0...4294967295) Direction. Valid values are: UP (Up) DN (Down) If no value is specified, 1 UP is assumed. [locn] Location of the facility. Valid values are: NEND FEND Near end Far end
[mone1] [monlev]
Edition 02
33 / 166
Parameter [dirn]
Explanation Signal direction. Valid values are: RCV TRMT Receive Transmit
If no value is specified, this parameter is not used for filtering responses. [tmper] Time period. The only valid value is: 15 MIN [mondat] 15 minutes If no value is specified, 15 MIN is assumed. Start date for the monitoring period. Valid values are: mm dd mm dd ALL [montm] Month and day Month (1...12) Day (1...31) All performance monitoring data is retrieved
If no value is specified, today's date is assumed. Start time for the monitoring period. Valid values are: hh mm hh mm ALL Hour and minute Hour (00...23) Minute. Valid values are 0, 15, 30, and 45. All performance monitoring data is retrieved
If no value is specified, the nearest value to the current time is assumed. Grouping is allowed.
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-PM-E1:[tid]:aid_e1:[ctag]::[mone1],[monlev],[locn],[dirn],[tmper], [mondat],[montm] */ errcde
34 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ aid_e1 [aid_type] mone1 monval [locn] [dirn] [tmper] [mondat] [montm] errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format As described for command parameters Type of AID. The value is E1. As described for command parameters, except that ALL is not used Measured value for the monitored parameter (0...4294967295) As described for command parameters As described for command parameters As described for command parameters As described for command parameters, except that ALL is not used As described for command parameters, except that ALL is not used Error code (See Appendix B)
Example
Retrieve the near end alarm indication signal count above 4096 for a 15 minute period beginning at 8:30 a.m. on November 10.
*/
Related Command
RTRV ALM E1
Edition 02
35 / 166
1.1.11
RTRV E1
Function Restrictions
Retrieves the provisioning data associated with an E1 facilities. All parameters in this command are position defined.
Command Format
RTRV-E1:[tid]:aid_e1:[ctag]::::[pstf],[sstf];
Command Parameters
Parameter [tid] aid_e1 Explanation 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. Access Identifier for the E1 facility. Enter in the following format, replacing lower case parameters with the values given: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
Grouping and ranging are allowed. 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. Primary state filter. Valid values are: IS OOS AU MA [sstf] In Service Out of Service (OOS MA, OOS AU, OOS AUMA) OOS AU, OOS AUMA OOS MA, OOS AUMA
[pstf]
If no value is specified, this filter is ignored. Secondary state filter. Valid values are: LPBK Retrieve looped back entities only If no value is specified, this filter is ignored.
36 / 166
Edition 02
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-E1:[tid]:aid_e1:[ctag]::::[pstf],[sstf] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD aid_e1 DENY /* */ e1_nblk Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed As described for command parameters Input command is denied Enclosed are human readable comments unspecified format E1 facility parameter block containing one or more of the following named parameters (separated by commas): LINETYPE Type of line interface used. Values are: DSX1E1 DSX1E1CRC 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 has failed and cannot be assigned)
Edition 02
37 / 166
Explanation The following parameters apply only if the E1 facility directly transports ATM traffic (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* ATMACCPROFNM* CACPROFDN* CACPROFDNNM* CACPROFUP* CACPROFUPNM* ATM Access Profile index (1...50). Default is 1. ATM Access Profile name Connection Admission and Control Profile index for downstream direction (1...50). Default is 1. Connection Admission and Control Profile name for the downstream direction Connection Admission and Control Profile index for upstream direction (1...50). Default is 1. 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 ED ATMPORT command. 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. 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) LTIMA imagrp (AID of IMA group on LT, imagr=1..4) NULL (Do not use IMA; E1 will directly transport ATM) pst Primary state. Values are: IS NR OOS AU OOS MA (Transient state. Changes to OOS-AUMA OOS AUMA [sst] errcde Secondary state. Values are: LPBK Retrieve looped back entities only Error code (See Appendix B)
38 / 166
Edition 02
Example
Related Commands
ENT E1
Edition 02
39 / 166
1.1.12
SET ATTR E1
Function Restrictions
Sets attributes of E1 facility related alarm conditions. All parameters in this command are position defined. Attributes are common for all E1 facilities.
Command Format
SET-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::ntfncde,cond_e1,[locn],[dirn];
Command Parameters
Parameter [tid] [aid_all_e1] [ctag] Explanation The identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. Access identifier for all E1 facilities. The value is E1. 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. Notification code. Valid values are:
ntfncde
CR MJ MN NA NR
[cond_e1] [locn]
Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
E1 facility condition. Valid values are deined in E1 Conditions", Section 1.3 Facility location. Valid values are:
NEND FEND
RCV TRMT
Receive Transmit
40 / 166
Edition 02
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* SET-ATTR-E1:[tid]:[aid_all_e1]:[ctag]::ntfncde,cond_e1,[locn],[dirn] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Associate the critical (CR) notification code with the RAI alarm condition.
*/
Related Command
RTRV ATTR E1
Edition 02
41 / 166
1.2
1.2.1
E1 Autonomouse Messages
This section describes the E1 autonomous messages.
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
Parameter almcde Explanation Alarm code. Identifies the severity of the alarm. Values are: *C ** *^ A^ atag aid_e1 Critical alarm Major alarm Minor alarm Automatic message (typically used to report a cleared alarm)
Automatic tag that indicates the numerical sequence of messages reported Access identifier for the E1 facility. Values are: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4) Critical alarm Major alarm Minor alarm Cleared alarm
ntfncde
[cond_e1] serveff
E1 facility condition. Valid values are deined in E1 Conditions", Section 1.3 Service effect. Values are: SA NSA Service affecting Not service affecting
42 / 166
Edition 02
Parameter [ocrdat]
Explanation Date of occurrence in the following format: mm dd mm dd Month and day Month (1...12) Day (1...31) Hour, minute, and second Hour (00...23) Minute (00...59) Second (00...59) Near end Far end Receive Transmit
[ocrtm]
[locn]
[dirn]
[conddescr]
Edition 02
43 / 166
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
Parameter almcde atag aid_e1 Explanation Alarm code. Identifies the severity of the alarm. Values are: A^ Non alarm message Automatic tag that indicates the numerical sequence of messages reported Access identifier for the E1 facility. Values are: NTE1 circuit LTE1 rack shelf lt_slot circuit rack shelf lt_slot circuit [cond_e1] [condeff] Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Circuit in the NT or LT (1...4)
E1 facility condition. Valid values are deined in E1 Conditions", Section 1.3 Effect of the event on the condition reported. Values are: SC CL TC Standing condition raised Standing condition cleared Transient condition Month and day Month (1...12) Day (1...31) Hour, minute, and second Hour (00...23) Minute (00...59) Second (00...59)
[ocrdat]
[ocrtm]
44 / 166
Edition 02
Parameter [locn]
Explanation Location of the condition. Values are: NEND FEND Near end Far end Receive Transmit
[dirn]
[cond_descr]
Edition 02
45 / 166
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
Condition RAI AIS LOF LOS ACTLPBK MISMATCH LCD* LI F+ LODS+ MISCONN+ RFI-IMA+ FAULT-IMA+
E1 Conditions
SERVEFF SA SA SA SA SA SA SA SA SA SA SA SA DEF NTFCNCDE Description Minor Minor MAJOR Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Remote Alarm Indication.[L] [D] Alarm Indication Signal.[L] [D] Loss of framing.[L] [D] Loss of Signal/Clock.[L] [D] Facility placed in loopback.[L] Interface does not match configuration.[L] Loss of ATM Cell Delineation.[L] [D] Loss of IMA Frame.[L] [D] IMA Link out of Delay Synchronization.[L] [D] IMA Link Mis-connected.[L] [D] IMA Remote Failure Indication.[L] [D] IMA Remote Failure Indication.[L] [D] IMA Link unusable due to far-end behavior.[L] [D]
UNUSABLE IMA+ SA
* 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.
46 / 166
Edition 02
1.4
E1 Monotypes
Table 2 lists the E1 Monotypes. In this table, the following notations are used:
"
Location:
D D
NE = Near end of the facility FE = Far end of the facility RX = Receive TX = Transmit.
"
Direction
D D
Table 2
Monotype CV-L ES-L CV-P ES-P ESB-P SES-P UAS-P SEFS-P DHECV* IV-IMA-L+ SES-IMA-L+ UAS-IMA-L+ UUS-IMA-L+ FC-IMA-L+ OIF-IMA-L+
E1 Monotypes
Location NE NE + FE NE + FE NE + FE NE + FE NE + FE NE +FE NE + FE NE NE NE + FE NE + FE NE + FE NE + FE NE NE Direction Rx Rx Rx Rx Rx Rx Rx Rx Rx Rx Rx Rx Tx + Rx Tx + Rx Rx Rx Description Line Code Violations Line Errored Seconds Path Coding Violations Path Errored Seconds Path Errored Seconds - Type B Path Severely Errored Seconds Path Un-Available Seconds Path Severely Errored Framing Seconds Discarded Cells Due to HEC Violation IMA Link ICP Violations IMA Link Severely Errored Seconds IMA Link Un-Available Seconds IMA Link Un-Usable Seconds IMA Link Failure Count IMA Link Out of IMA Frame Events IMA Link ICP Cell Stuffing Events
STUFF-IMA-L+
* 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.
Edition 02
47 / 166
48 / 166
Edition 02
Edition 02
49 / 166
2.1
2.1.1
E3 Commands
This section describes the E3 commands.
ED E3
Function Restrictions
Edits the provisioning data associated with an E3 facility. All parameters in this command are position defined.
Command Format
ED-E3:[tid]:aid_e3:[ctag]:::[e3_nblk]:[pst];
Command Parameters
Parameter [tid] aid_e3 Explanation Identification of the target NE. Alcatel factory default value is null. The NE SID code is the only other valid value. Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: NTE3 circuit (E3 Facility on the NT sides A and B) LTE3 rack shelf lt_slot circuit (E3 facility in the LT) rack shelf lt_slot circuit [ctag] Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit in the LT (1...4)
Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
50 / 166
Edition 02
Parameter [e3_nblk]
Explanation 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. 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. ATM Access Profile name Connection Admission and Control Profile index for downstream direction (1...50) Connection Admission and Control profile name for the downstream direction Connection Admission and Control Profile index for upstream direction (1...50) 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 ED ATMPORT command. [pst] Primary state to be set. Valid values are: IS OOS In Service Out of Service (OOS MA is implied)
If no value is specified, the value of this parameter stays unchanged. This parameter is not used for the NT
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* ED-E3:[tid]:aid_e3:[ctag]:::[e3_nblk]:[pst] */ aid:ERRCDE=errcde /* error description */
Edition 02
51 / 166
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B)
Example
Edit circuit 2 on the NT to use a Connection Admission and Control Profile index of 9.
Related Commands
DLT E3 RTRV E3
52 / 166
Edition 02
2.1.2
RTRV ALM E3
Function Restrictions
Retrieves current alarms for selected E3 facilities. All parameters in this command are position defined.
Command Format
RTRV-ALM-E3:[tid]:aid_e3:[ctag]::[ntfcde],,[srveff],[locn],[dirn];
Command Parameters
Parameter [tid] aid_e3 Explanation 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. Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: 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) LTE3 rack shelf lt_slot circuit (E3 facility on the LT side) rack shelf lt_slot circuit [ctag] [ntfncde] Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit in the LT (1...1)
Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. Notification code. Valid values are: CR MJ MN Critical alarm Major alarm Minor alarm
Grouping is allowed. If no value is specified, ALL is assumed. [serveff] Service effecting Valid values are: SA NSA Service affecting Not service affecting
Edition 02
53 / 166
Parameter [locn]
Explanation Location of the condition. Valid values are: NEND FEND Near end Far end
If no value is specified, ALL is assumed. [dirn] Direction of the condition. Valid values are: RCV TRMT Receive Transmit
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-ALM-E3:[tid]:aid_e3:[ctag]::[ntfncde],,[srveff],[locn],[dirn] */ errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_e3 aid_type ntfncde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) Only E3NTA is supported. The type of Access Identifier. The value is E3. As described for command parameters, except that ALL is not used
54 / 166
Edition 02
Explanation E3 facility condition. Values are as defined in E3 Conditions", Section 2.3 As described for command parameters, except that ALL is not used As described for command parameters As described for command parameters Description of alarm condition as defined in E3 Conditions", Section 2.3
Example
Related Commands
None
Edition 02
55 / 166
2.1.3
RTRV ATTR E3
Function Restrictions
Retrieves current attributes of E3 facility related conditions. All parameters in this command are position defined.
Command Format
RTRV-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::[ntfcde],[cond_e3],[locn],[dirn];
Command Parameters
Parameter [tid] [aidall_e3] [ctag] [ntfncde] Explanation 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. Access identifier for all E3 facilities. The value is E3. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. Notification code. Valid values are: CR MJ MN NA NR cond_e3 [locn] Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
Grouping is allowed. If no value is specified, ALL is assumed. E3 facility condition. Values are as defined in E3 Conditions", Section 2.3 Facility location. Valid values are: NEND FEND Near end Far end
Only applicable to conditions supporting location. If no value is specified, ALL is assumed. [dirn] Signal direction. Valid values are: RCV TRMT Receive Transmit
56 / 166
Edition 02
Response Format
M */
Normal Response
Error Response
M */ errcde /* error description */ ; sid yy-mm-dd hh:mm:ss c DENY /* RTRV-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::[ntfncde],[cond_e3],[locn],[dirn]
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aidall_e3 aid_type [ntfncde] [cond_e3] [locn] [dirn] [cond_descr] Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters, except that ALL is not used Type of Access Identifier. The value is E3. As described for command parameters, except that ALL is not used As defined in E3 Conditions", Section 2.3 As described for command parameters As described for command parameters Description of alarm condition as defined in E3 Conditions", Section 2.3
Edition 02
57 / 166
Example
*/
Related Commands
SET ATTR E3
58 / 166
Edition 02
2.1.4
RTRV COND E3
Function Restrictions
Retrieves current conditions of an E3 facility. All parameters in this command are position defined.
Command Format
RTRV-COND-E3:[tid]:aid_e3:[ctag]::[cond_e3],[locn],[dirn];
Command Parameters
Parameter [tid] aid_e3 Explanation 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. Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: 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) LTE3 rack shelf lt_slot circuit (E3 facility on the LT side) rack shelf lt_slot circuit [ctag] cond_e3 [locn] Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit in the LT (1...1)
Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. E3 facility condition. Values are as defined in E3 Conditions", Section 2.3 Facility location. Valid values are: NEND FEND Near end Far end
If no value is specified, ALL is assumed. [dirn] Signal direction. Valid values are: RCV TRMT Receive Transmit
Edition 02
59 / 166
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-COND-E3:[tid]:aid_e3:[ctag]::[cond_e3],[locn],[dirn] */ errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_e3 [aid_type] ntfncde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters Type of Access Identifier. The value is E3. Notification code. Valid values are: CR MJ MN NA NR cond_e3 serveff Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
E3 facility condition. Values are as defined in E3 Conditions", Section 2.3 Service effecting Valid values are: SA NSA Service affecting Not service affecting
As described for command parameters, except that ALL is not used As described for command parameters, except that ALL is not used Description of alarm condition as defined in E3 Conditions", Section 2.3
60 / 166
Edition 02
Example
Related Commands
None
Edition 02
61 / 166
2.1.5
RTRV PM E3
Function Restrictions
Retrieves E3 performance monitoring data. All parameters in this command are position defined.
Command Format
RTRV-PM-E3:[tid]:aid_e3:[ctag]::[mone3],[monlev],[locn],[dirn],[tmper], [mondat],[montm];
Command Parameters
Parameter [tid] aid_e3 Explanation 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. Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: 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) LTE3 rack shelf lt_slot circuit (E3 facility in the LT side) rack shelf lt_slot circuit [ctag] [mone3] Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit number (1...1)
Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. E3 monitored parameter. Valid values are as defined in E3 Monotypes", section 2.4. Grouping is allowed. If no value is specified, ALL is assumed. Threshold level. Enter in the following format: lev dirn lev dirn Level (0...4294967295) Direction. Valid values are: UP (Up) DN (Down) If no value is specified, 1 UP is assumed.
[monlev]
62 / 166
Edition 02
Parameter [locn]
Explanation Location of the facility. Valid values are: NEND FEND Near end Far end
If no value is specified, all values are reported. [dirn] Signal direction. Valid values are: RCV TRMT [tmper] Receive Transmit
If no value is specified, this parameter is not used for filtering responses. Time period. The only valid value is: 15 MIN [mondat] 15 minutes If no value is specified, 15 MIN is assumed. Start date for the monitoring period. Valid values are: mm dd mm dd ALL [montm] Month and day Month (1...12) Day (1...31) All performance monitoring data is retrieved
If no value is specified, today's date is assumed. Start time for the monitoring period. Valid values are: hh mm hh mm ALL Hour and minute Hour (00...23) Minute. Valid values are 0, 15, 30, and 45. All performance monitoring data is retrieved
Grouping is allowed. If no value is specified, the nearest value to the current time is assumed.
Response Format
M
Normal Response
Edition 02
63 / 166
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-PM-E3:[tid]:aid_e3:[ctag]::[mone3],[monlev],[locn][dirn],[tmper], [mondat],[montm] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ aid_e3 [aid_type] mone3 monval [locn] [dirn] [tmper] [mondat] [montm] errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format As described for command parameters Type of AID. The value is E3. As described for command parameters, except that ALL is not used Measured value for the monitored parameter (0...4294967295) As described for command parameters As described for command parameters As described for command parameters As described for command parameters, except that ALL is not used As described for command parameters, except that ALL is not used Error code (see Appendix B)
Example
Retrieve the near end line code violation count above 4096 for a 15 minute period beginning at 8:30 a.m. on November 10.
*/
Related Command
RTRV ALM E3
64 / 166
Edition 02
2.1.6
RTRV E3
Function Restrictions
Retrieves the provisioning data associated with an E3 facilities. All parameters in this command are position defined.
Command Format
RTRV-E3:[tid]:aid_e3:[ctag]::::[pstf];
Command Parameters
Parameter [tid] aid_e3 Explanation 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. Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: 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) LTE3 rack shelf lt_slot circuit (E3 facility on the LT side) rack shelf lt_slot circuit [pstf] IS OOS AU MA [ctag] Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit number (1...1) In Service Out of Service (OOS MA, OOS AU, OOS AUMA) OOS AU, OOS AUMA OOS MA, OOS AUMA
If no value is specified, this filter is ignored. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
Response Format
M
Normal Response
Edition 02
65 / 166
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-E3:[tid]:aid_e3:[ctag]::::[pstf] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD aid_e3 DENY /* */ [e3_nblk] Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed As described for command parameters Input command is denied Enclosed are human readable comments unspecified format Named parameter block for E3. The block consists of the following parameters, each followed by an equal sign and a value. ATMACCPROF* ATMACCPROFNM* CACPROFDN* CACPROFDNNM* CACPROFUP* CACPROFUPNM* ATM Access Profile index (1...50). Default is 1. ATM Access Profile name Connection Admission and Control Profile index for downstream direction (1...50). Default is 1. Connection Admission and Control Profile name for the downstream direction Connection Admission and Control Profile index for upstream direction (1...50). Default is 1. 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 ED ATMPORT command. state Primary state. Values are: IS NR OOS AU OOS MA (Transient state. Changes to OOS-AUMA) OOS AUMA errcde Error code (see Appendix B)
66 / 166
Edition 02
Example
Related Command
ENT E3
Edition 02
67 / 166
2.1.7
SET ATTR E3
Function Restrictions
Sets attributes of E3 facility related alarm conditions. Attributes are common for all E3 facilities. All parameters in this command are position defined.
Command Format
SET-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::ntfncde,cond_e3,[locn],[dirn];
Command Parameters
Parameter [tid] [aid_all_e3] [ctag] ntfncde Explanation Identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. Access identifier for all E3 facilities. The value is E3. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. Notification code. Valid values are: CR MJ MN NA NR cond_e3 [locn] Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
E3 facility condition. Values are as defined in E3 Conditions", Section 2.3 Facility location. Valid values are: NEND FEND Near end Far end
Only applicable to conditions supporting location. If no value is specified, ALL is assumed. [dirn] Signal direction. Valid values are: RCV TRMT Receive Transmit
68 / 166
Edition 02
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* SET-ATTR-E3:[tid]:[aid_all_e3]:[ctag]::ntfncde,cond_e3,[locn],[dirn] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B)
Example
Associate the critical (CR) notification code with the RAI alarm condition.
*/
Related Command
RTRV ATTR E3
Edition 02
69 / 166
2.2
2.2.1
E3 Autonmous Messages
This section describes the E3 autonomous messages.
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
Parameter almcde Explanation Alarm code. Identifies the severity of the alarm. Values are: *C ** *^ A^ atag aid_e3 Critical alarm Major alarm Minor alarm Automatic message (typically used to report a cleared alarm)
Automatic tag that indicates the numerical sequence of messages reported Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: 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) LTE3 rack shelf lt_slot circuit (E3 facility on the LT side) rack shelf lt_slot circuit Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit number (1...1) Critical alarm Major alarm Minor alarm Cleared alarm
ntfncde
cond_e3
70 / 166
Edition 02
Parameter serveff
Explanation Service effecting Values are: SA NSA Service affecting (Immediate action required) Not service affecting Month and day Month (1...12) Day (1...31) Hour, minute, and second Hour (00...23) Minute (00...59) Second (00...59) Near end Far end Receive Transmit
[ocrdat]
[ocrtm]
[locn]
[dirn]
[conddescr]
Edition 02
71 / 166
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
Parameter almcde atag aid_e3 Explanation Alarm code. Identifies the severity of the alarm. Values are: A^ Non alarm message Automatic tag that indicates the numerical sequence of messages reported Access Identifier for the E3 facility. The value can be preceded with AID=, but this is not required. Valid values are: 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) LTE3 rack shelf lt_slot circuit (E3 facility on the LT side) rack shelf lt_slot circuit cond_e3 [condeff] Rack number (1...6) Shelf number (1...2) LT slot number (1...16) Circuit number (1...1)
E3 facility condition. Values are as defined in E3 Conditions", Section 2.3 Effect of event on condition reported. Values are: SC CL TC Standing condition raised Standing condition cleared Transient condition
72 / 166
Edition 02
Parameter [ocrdat]
Explanation Date of occurrence in the following format: mm dd mm dd Month and day Month (1...12) Day (1...31) Hour, minute, and second Hour (00...23) Minute (00...59) Second (00...59) Near end Far end Receive Transmit
[ocrtm]
[locn]
[dirn]
[cond_descr]
Edition 02
73 / 166
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
Condition RAI AIS LOF LOS LCD* ACTLPBK PLM P PLU UNEQ P CELLSIG OVRFLO UDRFLO
E3 Conditions
SERVEFF SA SA SA SA SA SA SA SA SA SA SA SA DEF NTFCNCDE Description Major Critical Critical Critical Critical Critical Minor Minor Minor Critical Critical Critical Remote Alarm Indication.[L] [D] Alarm Indication Signal.[L] [D] Loss of framing.[L] [D] Loss of Signal/Clock.[L] [D] Loss of ATM Cell Delineation.[L] [D] Network Side in Loopback[L] [D] Payload Type Mismatch[L] [D] Stable Payload Type[L] [D] Payload Unequipped[L] [D] False start of cell input signal [L][D] Buffer (FIFO) overflow [L][D] Buffer (FIFO) underflow [L] [D]
74 / 166
Edition 02
2.4
E3 Monotypes
Table 4 lists the E3 Monotypes. In this table, the following notations are used:
" " "
Table 4
Monotype CV L ES L ESP P SESP P UASP P ESCP P SESCP P UASCP P SAS P DHECV*
E3 Monotypes
Location NE NE NE NE NE NE + FE NE + FE FE NE NE Direction RX RX RX RX RX RX RX RX RX RX Description Line Code Violations Line Errored Seconds P-Bit Errored Seconds P-Bit Severely Errored Seconds P-Bit Un-Available Seconds CP-Bit Errored Seconds CP-Bit Severely Errored Seconds CP-Bit Un-Available Seconds Severely Errored Framing Seconds Discarded Cells Due to HEC Violation
Edition 02
75 / 166
76 / 166
Edition 02
Edition 02
77 / 166
3.1
3.1.1
ENV Commands
This section describes the ENV commands.
Command Format
RTRV-ALM-ENV:[tid]:aid_env:[ctag]::[ntfcde],;
Command Parameters
Parameter [tid] aid_env Explanation 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. Access identifier for the environment. Enter in the following format, replacing lower case parameters with the values given: ENV <number> <number> [ctag] 1...5 Grouping and ranging are allowed. ALL may be used. 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. Notification code. Valid values are: CR MJ MN Critical alarm Major alarm Minor alarm
[ntfncde]
Response Format
M
Normal Response
78 / 166
Edition 02
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-ALM-ENV:[tid]:aid_env:[ctag]::[ntfncde] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_env ntfncde cond_env Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters, except that ALL is not used As described for command parameters, except that ALL is not used Environment related alarm condition. Values are as defined in ENV Conditions", Section 3.3
Example
*/
Related Commands
None
Edition 02
79 / 166
3.1.2
Command Format
RTRV-ATTR-ENV:[tid]:aid_env:[ctag]::[ntfcde];
Command Parameters
Parameter [tid] aid_env Explanation 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. Access identifier for the environment. Enter in the following format, replacing lower case parameters with the values given: ENV <number> <number> [ctag] 1...5 Grouping and ranging are allowed. ALL may be used. 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. Notification code. Valid values are: CR MJ MN NR Critical alarm Major alarm Minor alarm Not reported (information is stored in the NE)
[ntfncde]
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-ATTR-ENV:[tid]:aid_env:[ctag]::[ntfncde] */ errcde
80 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_env aid_type ntfncde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters, except that ALL is not used. The type of Access Identifier. The value is ENV. Notification code. Valid values are: CR MJ MN NA NR cond_env Critical alarm Major alarm Minor alarm Not alarmed (reported via REPORT EVENT) Not reported (information is stored in the NE)
Environment related alarm condition. Values are as defined in ENV Conditions", Section 3.3
Example
*/
Related Commands
Edition 02
81 / 166
3.1.3
Command Format
RTRV-COND-ENV:[tid]:aid_env:[ctag]::[cond_env];
Command Parameters
Parameter [tid] aid_env Explanation 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. Access identifier for an environment. The value can be preceded with AID=, but this is not required. Enter in the following formats, replacing lower case parameters with the values given: ENV <number> <number> [ctag] cond_env 1...5
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-COND-ENV:[tid]:aid_env:[ctag]::[cond_env] */ errcde
82 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_env [aid_type] [ntfncde] Explanation Target NE identification Year (two digits), month, and day Hour (00 23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters, except that ALL is not used Type of Access Identifier. The value is ENV. Notification code. Values are: CR MJ MN NR cond_env [cond_descr] Critical alarm Major alarm Minor alarm Not reported (information is stored in the NE)
As described for command parameters, except that ALL is not used Description of alarm condition (1...40 characters)
Example
Related Commands
None
Edition 02
83 / 166
3.1.4
Command Format
SET-ATTR-ENV:[tid]:aid_env:[ctag]::ntfncde;
Command Parameters
Parameter [tid] aid_env Explanation The identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. Access identifier for the environment. Enter in the following format, replacing lower case parameters with the values given: ENV <number> <number> [ctag] 1...5 Grouping and ranging are allowed. ALL may be used. 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. Notification code. Valid values are: CR MJ MN NR Critical alarm Major alarm Minor alarm Not reported (information is stored in the NE)
ntfncde
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* SET-ATTR-ENV:[tid]:aid_env:[ctag]::ntfncde */ errcde
84 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Associate the critical (CR) notification code with alarm conditions on environment 4.
*/
Related Command
Edition 02
85 / 166
3.2
3.2.1
Message Format
almcode atag REPT ALM ENV aid_env:ntfncde,cond_env,ocrdat,ocrtm,[conddescr] ;
Response Parameters
Parameter almcde Explanation Alarm code. Identifies the severity of the alarm. Values are: *C ** *^ A^ atag aid_env Critical alarm Major alarm Minor alarm Automatic message (typically used to report a cleared alarm)
Automatic tag that indicates the numerical sequence of messages reported Access identifier for the environment in the following format: ENV <number> <number> 1...5 Critical alarm Major alarm Minor alarm Cleared alarm
ntfncde
86 / 166
Edition 02
Explanation Environment condition. The value is: MISC mm dd mm dd Miscellaneous environment alarm Month and day Month (1...12) Day (1...31) Hour, minute, and second Hour (00...23) Minute (00...59) Second (00...59) Date of occurrence in the following format:
ocrtm
[conddescr]
Edition 02
87 / 166
3.3
Table 5
Condition MISC ** Note:
88 / 166
Edition 02
Edition 02
89 / 166
4.1
DLT MEM
Function Restrictions
Deletes a software package from the NE. 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 RST MEM command. Once the database is deleted, the restore operation becomes impossible. All parameters in this command are position defined.
Command Format
DLT-MEM:[tid]:aid_com:[ctag]::swpkg;
Command Parameters
Parameter [tid] aid_com [ctag] swpkg Explanation Identification of the target NE. Alcatel factory default value is null. The NE SID code is the only other valid value. Access Identifier for common equipment. The value is COM. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. Software package to be deleted. The value is BACKUPDB (backup version of the provisioning database.
90 / 166
Edition 02
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* DLT-MEM:[tid]:aid_com:[ctag]::swpkg */ errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B)
Example
Related Command
RST MEM
Edition 02
91 / 166
4.2
ED SYNCN
Function Restrictions Command Format
Configures the reference source for synchronization of the NE clocks. All parameters in this command are position defined.
ED-SYNCN:[tid]:[aid_syncn]:[ctag]:::[syncn_nblk];
Command Parameters
Parameter [tid] aid_syncn [ctag] syncn_nblk Explanation 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 of the NE clock. The value is CLKSRCNT (default). Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. 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.
92 / 166
Edition 02
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* ED-SYNCN:[tid]:[aid_syncn]:[ctag]:::[syncn_nblk] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (two digits), month, and day Hour (00 23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B)
Example
Configure the NE clock to use the BITS clock as its primary reference source.
Related Commands
Edition 02
93 / 166
4.3
FREE PORT
Function
Frees a port previously assigned to a user (by ED ADSL, ED SHDSL, ED E1, or RESV-NEXT PORT). 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 RESC NEXT PORT command. Assigned ports may be freed (un assigned) using the FREE PORT 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 position defined.
Command Format
FREE-PORT:[tid]:port_aid:[ctag][:];
Command Parameters
Parameter [tid] [ctag] Explanation 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. 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. Access identifier for the port. Enter in one of the following formats, replacing lower case parameters with the values given: ADSL rack shelf lt_slot circuit LTSHDSL rack shelf lt_slot circuit rack shelf lt_slot circuit Rack number (1...6) Shelf number (1...4 for ADSL, 1...3 for SHDSL) LT slot number (1...16) Circuit number in LT (1...24)
port_aid
94 / 166
Edition 02
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* FREE-PORT:[tid]:port_aid:[ctag][:] */ aid:ERRCDE=errcde /* error description */
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Source NE identification Year (last two digits), month, and day Hour (1...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Related Commands
Edition 02
95 / 166
4.4
INIT LOG
Function Restrictions Command Format
Initializes selected system log(s). All parameters in this command are position defined.
INIT-LOG:[tid]::[ctag]::lognms;
Command Parameters
Parameter [tid] [ctag] Explanation 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. 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. Names of logs to be initialized. The only supported value is SECURITY.
lognms
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* INIT-LOG:[tid]::[ctag]::lognms */ errcde
96 / 166
Edition 02
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Related Command
RTRV LOG
Edition 02
97 / 166
4.5
INIT SYS
Function Restrictions
Initializes or resets selected subsystems in the NE. All parameters in this command are position defined. To restore persistent database, do the following: a) Use STA CMDSSN to start a command session. b) Enable download by using SET NE ALL with MEMDNLD=ENABLED. c) Use TFTP to download the database file. d) Restart the system by using INIT SYS with INIT_MODE=4. e) Use STP CMDSSN to stop the command session.
Command Format
INIT-SYS:[tid]:aid_proc:[ctag]::init_mode;
Command Parameters
Parameter [tid] aid_proc Explanation Identification of the target NE. Alcatel factory default value is null. The NE SID code is the only other valid value. Identifier of the processor to be initialized. Grouping and ranging are not allowed. Valid values are: NTA NTB LT rack shelf lt_slot SERV rack shelf serv_slot where SYSTEM rack shelf lt_slot Serv_slot [ctag] Entire system Rack number (1...6) Shelf number (1...4) LT slot number (1...16) Server slot number (1...16) Network Termination Unit A Network Termination Unit B Processor in LT unit Processor in Server
No grouping or ranging is allowed Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
98 / 166
Edition 02
Parameter init_mode
Explanation Mode of initialization. Valid values are: 0 1 2 3 4 Emergency restart for active NT only* Initialize with self test Initialize without self test Complete reset (aid_proc=SYSTEM only). Removes all persistent data from system. Restart using downloaded persistent database (aid_proc=SYSTEM only) (see Restrictions)
ATTENTION
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* INIT-SYS:[tid]:aid_proc:[ctag]::init_mode */ aid:ERRCDE=errcde /* error description */
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B)
Edition 02
99 / 166
Example
Related Commands
None
100 / 166
Edition 02
4.6
RD SYNCN
Function Restrictions Command Format
Retrieves the current reference source for synchronization of the NE clock. All parameters in this command are position defined.
RD-SYNCN:[tid]:[aid_syncn]:[ctag][:];
Command Parameters
Parameter [tid] aid_syncn [ctag] Explanation 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 of the NE clock. The value is CLKSRCNT. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RD-SYNCN:[tid]:[aid_syncn]:[ctag][:] */ errcde
Edition 02
101 / 166
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD aid_syncn cref Explanation Target NE identification Year (two digits), month, and day Hour (00 23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed As described for command parameters Primary reference source for synchronizing the clock. Values are: PRI LOOP PRI LOCAL PRI REDNT DENY /* */ errcde Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) Loop timing recovered from network side facility Local oscillator on NT board Local oscillator on redundant NT board
Example
Related Commands
102 / 166
Edition 02
4.7
REPT-OPSTAT-ICON:[tid]:[aid_com]:[ctag][:];
Command Parameters
Parameter [tid] [aid_com] [ctag] Explanation 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. Access Identifier for common equipment. The value is COM. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* REPT-OPSTAT-ICON:[tid]:[aid_icon]:[ctag][:] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY Explanation Target NE identification Year (last two digits), month, and day Hour (00 23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied
Edition 02
103 / 166
Explanation Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters 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> <s> Rack Number (1...6) 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 8 digit 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
Example
REPT-OPSTAT-ICON:RALGH:; M RALGH 99-11-24 12:30:43 42 COMPLD /* REPT-OPSTAT-ICON:RALGH::42 COM:SHELF1,\300000000000 COM:SHELF2,\ COM:SHELF3,\ COM:SHELF4,\ COM:SHELF5,\ COM:SHELF6,\ COM:SHELF7,\ COM:SHELF8,\ COM:ORDER,\ : 00 \
*/ \ \ \ \ \ \ \ \
Related Commands
None.
104 / 166
Edition 02
4.8
REPT OPSTAT NE
Function Restrictions Command Format
Reports current operational parameters for the system. All parameters in this command are position defined.
REPT-OPSTAT-NE:[tid]:[aid_com]:[ctag][:];
Command Parameters
Parameter [tid] [aid_com] [ctag] Explanation Identification of the target NE. Alcatel factory default value is null. The NE SID code is the only other valid value. Access Identifier for common equipment. The value is COM. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
Response Format
M
Normal Response
Error Response
M tid yy-mm-dd hh:mm:ss c DENY /* REPT-OPSTAT-NE:[tid]:[aid_com]:[ctag][:] */ aid:ERRCDE=errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD Explanation Target NE identification Year (2 digits), month, and day Hour (00...23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed
Edition 02
105 / 166
Explanation Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters 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 (Large shelf US model) MAUS (Mini RAM US model) LAEU (Large shelf European model) MAEU (Mini RAM European model) OTHER (Unknown equipment practice) EXTCHALEN EXTCHBLEN FACASTATUS Length of extender chain, side A (integer 1...N) Length of extender chain, side B (integer 1...N) 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 MEMASTATUS Status of NT facility side B. Values are the same as for FACASTATUS. Status of system memory, side A. Values are: NORMAL (Memory is OK) FAULT (Memory is not OK) MEMBSTATUS MEMMIGR Status of system memory, side B. Values are the same as for MEMASTATUS. Memory migration status (see DLT MEM and RST MEM). Values are: IDLE (Migration not possible) BUSY (Migration in progress) COMPLETE (Migration completed, rollback possible)
106 / 166
Edition 02
Explanation 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 NUMPROTNSW PROTCURR Status of NT side B. Values are the same as for NTASTATUS. Rolling count of protection switching events 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)
Edition 02
107 / 166
Example
REPT-OPSTAT-NE:RALGH:COM:42; M RALGH 00-11-24 12:30:43 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
108 / 166
Edition 02
4.9
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
Parameter [tid] port_type Explanation 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. Type of port to be assigned. Valid values are: ADSL SHDSL [ctag] ADSL port SHDSL port
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. 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 FAULTY Port is not assigned Port is faulty and cannot be assigned
port_id
Edition 02
109 / 166
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RESV-NEXT-PORT:[tid]:port-type:[ctag]::port_id */ aid:ERRCDE=errcde /* error description */
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD port_type port_aid Explanation Source NE identification Year (last two digits), month, and day Hour (1...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed As described for command parameters Access identifier for the port. Values are: ADSL rack shelf lt_slot circuit LTSHDSL rack shelf lt_slot circuit rack shelf lt_slot circuit DENY /* */ errcde Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) Rack number (1...6) Shelf number (1...4, for ADSL, 1...3 for SHDSL) LT slot number (1...16) Circuit number (1...24)
110 / 166
Edition 02
Example
Related Commands
Edition 02
111 / 166
4.10
RST MEM
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 DLT MEM.
RSTMEM:[tid]:aid_com:[ctag][:];
Command Parameters
Parameter [tid] aid_com [ctag] Explanation Identification of the target NE. Alcatel factory default value is null. The NE SID code is the only other valid value. Access Identifier for all common equipment. The value is COM. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
Response Format
M ;
Normal Response
Error Response
M tid yy-mm-dd hh:mm:ss c DENY /* RSTMEM:[tid]:aid_com:[ctag][:] */ aid:ERRCDE=errcde /* error description */
112 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_com Explanation Target NE identification Year (2 digits), month, and day Hour (00...23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters
Example
RST-MEM:RALGH:COM:42; M
Restore the NE provisioning database to the backup version created during the last NE software migration.
Related Command
DLT MEM
Edition 02
113 / 166
4.11
RTRV CMDSSN
Function Restrictions
Retrieves information about active Command Sessions. All parameters in this command are position defined. 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
Parameter [tid] aid_com [ctag] Explanation 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. Access identifier for all common equipment. The value is COM. 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
M
Normal Response
114 / 166
Edition 02
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-CMDSSN:[tid]:aid_com:[ctag][:] */ errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_com cmdssn_owner Explanation Target NE identification Year (last two digits), month, and day Hour (1...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command syntax Owner of the Command Session. Valid values are: AWS CRAFT ADSL workstation (or another SNMP Manager) TL1 Manager (Local Craft, Remote Craft, or TL1 OS)
Example
Related Commands
Edition 02
115 / 166
4.12
RTRV HDR
Function Restrictions
Retrieves the NE header information. All parameters in this command are position defined.
Command Format
RTRV-HDR:[tid]::[ctag][:];
Command Parameters
Parameter [tid] [ctag] Explanation 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. 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
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-HDR:[tid]::[ctag][:] */ errcde
116 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
RTRV-HDR:RALGH::42; M ;
Related Commands
None.
Edition 02
117 / 166
4.13
RTRV LOG
Function Restrictions
Retrieves selected logs. All parameters in this command are position defined.
Command Format
RTRV-LOG:[tid]::[ctag]::lognms;
Command Parameters
Parameter [tid] [ctag] Explanation 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. 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. Names of logs to be retrieved. The only supported value is SECURITY.
lognms
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-LOG:[tid]::[ctag]::lognms */ errcde
118 / 166
Edition 02
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde lognms logdump Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters Dump of log buffer
Example
Related Command
INIT LOG
Edition 02
119 / 166
4.14
RTRV MEM
Function Restrictions
Retrieves the list of software image files available in the NE, along with the software version associated with each file. All parameters in this command are position defined.
Command Format
RTRV-MEM:[tid]:aid_com:[ctag][:];
Command Parameters
Parameter [tid] aid_com [ctag] Explanation 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. Access Identifier for all common equipment. The value is COM. 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
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-MEM:[tid]:aid_com:[ctag][:] */ errcde
120 / 166
Edition 02
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde filename Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) Name of a software module
Example
Retrieve the list of software image files for the RALGH NE.
Related Commands
None
Edition 02
121 / 166
4.15
RTRV NE ALL
Function Restrictions
Retrieves common provisioning data associated with the NE. All parameters in this command are position defined.
Command Format
RTRV-NE-ALL:[tid]:[aid_com]:[ctag][:];
Command Parameters
Parameter [tid] [aid_com] [ctag] Explanation 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. Access Identifier for all common equipment. The value is COM. 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
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-NE-ALL:[tid]:[aid_com]:[ctag][:] */ errcde
122 / 166
Edition 02
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde aid_com ne_nblk Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B) As described for command parameters 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 ATM VCI of the PVC over which the NE issues BOOTP requests (32...65535) ATM VPI of the PVC over which the NE issues BOOTP requests (0...4000). Default is 0. Timeout for an idle command session (see STA CMDSSN or STP CMDSSN), in seconds (0...65535). A value of 0 disables the timeout feature. 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 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 SET NE ALL command.
DEFROUTER
MEMALM
Edition 02
123 / 166
Explanation 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 INIT SYS). 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 VC level 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 SNTP Duration of the ADSL facility POTS test in minutes (0...60). See STA TST ADSL command. Use of Simple Network Time Protocol to maintain NE clock. Values are: ENABLED (Use SNTP) DISABLED (Use NE local time set by SET DAT com mand) TZOFFSET Offset of local time zone from GMT/UTC, in minutes ( 780...780). Used by the system if SMTP=ENABLED.
124 / 166
Edition 02
Example
Retrieve the common provisioning data associated with the RALGH NE.
Related Commands
INIT SYS SET DAT SET NE ALL STA CMDSSN STP CMDSSN
Edition 02
125 / 166
4.16
RTRV PORT
Function Restrictions
Retrieves a port in the NE, based on the optional Port Identifier label associated with the port. All parameters in this command are position defined. 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
Parameter [tid] [port_type] [ctag] port_id Explanation 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. Type of port to be retrieved. The only valid value is ALL. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0. Port Identifier label (1...32 characters) associated with the port to be retrieved. The label is assigned with the RESV NEXT PORT command or the PORTID parameter of the ED ADSL and ED SHDSL commands.
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY; /* RTRV-PORT:[tid]:[port_type]:[ctag]::port_id */ errcde
126 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde port_type Explanation Target NE identification Year (two digits), month, and day Hour (00 23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) Type of port. Values are: ADSL SHDSL port_aid ADSL port SHDSL port
AID of the user port. Values are: ADSL rack shelf slot circuit LTSHDSL rack shelf lt_slot circuit rack shelf lt_slot circuit Rack number (1...6) Shelf number (1...4 for ADSL; 1...3 for SHDSL) LT slot number (1...16) Circuit number (1...24)
Example
Related Commands
Edition 02
127 / 166
4.17
RTRV SYNCN
Function Restrictions
Retrieves the configuration of the reference source to be used for synchronization of the NE clock. All parameters in this command are position defined.
Command Format
RTRV-SYNCN:[tid]:[aid_syncn]:[ctag][:];
Command Parameters
Parameter [tid] [aid_syncn] [ctag] Explanation 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 of the NE clock. The value is CLKSRCNT. Correlation tag (1...6 characters) that links an input command with associated output responses. The default is 0.
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* RTRV-SYNCN:[tid]:[aid_syncn]:[ctag][:] */ errcde
128 / 166
Edition 02
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde [aid_syncn] syncn_nblk Explanation Target NE identification Year (two digits), month, and day Hour (00 23), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (see Appendix B) As described for command parameters 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.
Related Commands
Edition 02
129 / 166
4.18
SET DAT
Function Restrictions
Sets the date and time in the NE. All parameters in this command are position defined. Resetting the NT or the ASAM also resets the date and time.
Command Format
SET-DAT:[tid]::[ctag]::date,time;
Command Parameters
Parameter [tid] [ctag] Explanation The identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. 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. Date in the following format: mm dd yy mm dd yy Month, day, and year Month (1...12) Day (1...31) 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 mm ss hh mm ss Hour, minute, and second Hour (00...23) Minute (00...59) Second (00...59)
date
130 / 166
Edition 02
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* SET-DAT:[tid]::[ctag]::date,time */; errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Set the date to 20 December 2000 and the time to 11:23:45 in the RALGH NE.
*/
Related Command
None.
Edition 02
131 / 166
4.19
SET NE ALL
Function Restrictions
Sets miscellaneous provisioning parameters in an NE. All parameters in this command are position defined.
Command Format
SET-NE-ALL:[tid]:[aid_com]:[ctag]:::ne_nblk;
Command Parameters
Parameter [tid] [aid_com] [ctag] Explanation The identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. Access Identifier for all common equipment. The value is COM. 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. NE named parameter block containing one or more of the following parameters (separated by commas): BOOTPVPI BOOTPVCI CMDSSNTMO ATM VPI of the PVC over which the NE issues BOOTP requests (0...4000). The default is 0. ATM VCI of the PVC over which the NE issues BOOTP requests (32...65535). The default is 32. Timeout for an idle command session (see STA CMDSSN or STP CMDSSN), in seconds (0...65535). A value of 0 disables the timeout feature. 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 RTRV NE ALL). 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 RTRV NE ALL). The only valid value is ENABLED.
ne_nblk
DEFROUTER
132 / 166
Edition 02
Explanation 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 VC level 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 SNTP Duration of the ADSL facility POTS test in minutes (0...60). See STA TST ADSL command. 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 SET DAT command) AWS must be used to configure SNTP . TZOFFSET APSSOAKINT Offset of local time zone from GMT/UTC, in minutes ( 780...780). Used by the system if SMTP=ENABLED. The soaking period for activation of Automatic protection switching (APS) in 1/100 seconds (0..4294967295). 0 implies no soaking period The soaking period for activation of equipment protection switching (EPS) in 1/100 seconds (0..4294967295). 0 implies no soaking period 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
EPSSOAKINT
MEMSYNC
Edition 02
133 / 166
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* SET-NE-ALL:[tid]:[aid_com]:[ctag]:::ne_nblk */ errcde
Response Parameters
Parameter sid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Source NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Related Commands
RTRV NE ALL SET DAT STA TST ADSL STP TST ADSL
134 / 166
Edition 02
4.20
SET SID
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. All parameters in this command are position defined. The SID is used to uniquely identify an NE in the system, so the SID must be unique for each NE.
Restrictions
SET-SID:[tid]::[ctag]::sid;
Command Format
Command Parameters
Parameter [tid] [ctag] Explanation The identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. 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. 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 case sensitive.
sid
Edition 02
135 / 166
Response Format
M
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* SET-SID:[tid]::[ctag]::sid */; errcde
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ errcde Explanation Target NE identification Year (last two digits), month, and day Hour (00...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format Error code (See Appendix B)
Example
Related Commands
None.
136 / 166
Edition 02
4.21
STA CMDSSN
Function Restrictions
Initiates a Command Session on behalf of the issuing manager. While a Command Session is in progress, only the owner of the session can modify the NE database. 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 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
Parameter [tid] aid_com [ctag] Explanation 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. Access identifier for all common equipment. The value is COM. 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.
Edition 02
137 / 166
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* STA-CMDSSN:[tid]:aid_com:[ctag][:]; */ aid_com:ERRCDE=errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ aid_com errcde Explanation Target NE identification Year (last two digits), month, and day Hour (1...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format As described for command parameters Error code (See Appendix B)
Example
Related Commands
138 / 166
Edition 02
4.22
STP CMDSSN
Function Restrictions
Terminates any active 'Command Session' owned by the issuing manager. All TL1 managers share ownership of their Command Sessions, so care should be exercised when issuing this command. 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 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
Parameter [tid] aid_com [ctag] Explanation The identification of the target NE. TID is optional and has an Alcatel factory default value of null. The NE's SID code is the only other valid value. Access identifier for all common equipment. The value is COM. 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.
Edition 02
139 / 166
Response Format
M ;
Normal Response
Error Response
M sid yy-mm-dd hh:mm:ss c DENY /* STP-CMDSSN:[tid]:aid_com:[ctag][:]; */ aid_com:ERRCDE=errcde /* error description */
Response Parameters
Parameter tid yy mm dd hh:mm:ss M c COMPLD DENY /* */ aid_com errcde Explanation Target NE identification Year (last two digits), month, and day Hour (1...24), minute, and second Message generated in response to an input command If provided, ctag; otherwise 0 Completed Input command is denied Enclosed are human readable comments unspecified format As described for command parameters Error code (See Appendix B)
Example
Related Commands
140 / 166
Edition 02
Appendix A
Appendix A
A.1
General Description
Retrieving current alarm conditions using TL1 commands or Receiving automatically generated system status and event reporting through autonomous messages.
A.2
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, service affecting/non service affecting behavior codes, and brief descriptions.
In the following tables, the default notification code column lists the default alarm notification codes for the equipment or facility. Most notification codes can be changed by the SET ATTR TL1 command for that entity.
Edition 02
141 / 166
Appendix A
If the notification code is Critical, Major, or Minor, an alarm autonomous message (REPT ALM) reports changes in the alarm condition for in service (IS) entities. If the entity is out of service (OOS MA), reporting is suppressed. The RTRV ALM or RTRV COND commands are used to retrieve the current state of the alarm.
Service affecting behavior is listed as either service affecting (SA) or non service affecting (NSA). ADSL Conditions
DEFAULT NTFCNCDE Major Minor Minor Minor Minor Minor Minor DESCRIPTION
SA SA SA SA SA SA SA SA SA SA SA SA SA SA Modem could not initialize Loss of cell delineation, interleaved Loss of cell delineation, fast Loss of frame Loss of link LOS Loss of signal Loss of power CFGERR Critical Major Major Minor Minor Minor Minor Modem activation failed config error COMMF NOPEER LORATE CELLDSCUP* CELLDSCDN* Unable to communicate w/ peer modem Line capacity insufficient to meet config No peer modem detected Line rate is below planned rate Upstream cell discard Downstream cell discard CAPINSUF *ATM alarms reported via the ADSL facility
SERVICE AFFECTING?
142 / 166
Edition 02
Appendix A
E1 Facility Conditions
CONDITION ACTLPBK AIS SERVICE AFFECTING? SA SA SA SA SA SA SA SA SA SA SA SA SA DEFAULT NTFCNCDE Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor DESCRIPTION Facility placed in loopback Alarm indication signal IMA link fault
FAULT IMA** LCD* LIF** Loss of ATM cell delineation Loss of IMA frame LODS** LOF IMA link out of delay synchronization Loss of framing MISMATCH LOS RAI Interface does ot match configuration Loss of signal/clock Major MISCONN** RFI IMA** IMA link misconnected Remote alarm indication IMA remote failure indication UNUSABLE IMA** IMA link unusable due to far end 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)
3EC 36876 AEAA TCZZA Edition 02
143 / 166
MEMDIFEH UNPLANNED SWROLLBK SHUTDOWN RMTDLFAIL PROGVER MEMDIF IQREFCLK IQCLKOOL INIT IMPROPRMVL HITEMP FANALM 2 FANALM 1 FA EQPT CONTCOM CONTBUS COMMERR BUSCFG ATMHW CONDITION NSA NSA NSA SA NSA NSA NSA SA SA SA SA NSA NSA NSA NSA SA SA SA SA SA SA SERVICE AFFECTING?
*There are five miscellaneous alarms, corresponding to AIDs ENV 1 through ENV 5. MISC* CONDITION Appendix A Alarms and Events NSA SERVICE AFFECTING?
144 / 166
UNEQUIP EQUIP DEFENCE SA
Equipment Conditions
Event
Event
Critical
Minor
Minor
Minor
Major
Major
Major
Minor
Critical
Critical
Critical
Major
Major
Major
Major
Minor
Event
Critical
Critical
Major
Critical
Major
DEFAULT NTFCNCDE
Minor
DEFAULT NTFCNCDE
Module removed
Module inserted
Equipment inserted
DESCRIPTION
DESCRIPTION
Edition 02
UNUSABLE IMA* FAULT IMA* RFI IMA* MISCONN* LODS * LIF * CONDITION SA SA SA SA SA SA SERVICE AFFECTING?
STARTUP INSUFLNKS CFGABORT BLOCKED CONDITION SA SA SA SA SERVICE AFFECTING?
Edition 02
*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/RTRV ATTR IMALNK commands.
Minor
Minor
Minor
Minor
Minor
Minor
DEFAULT NTFCNCDE
Minor
Minor
Minor
Minor
DEFAULT NTFCNCDE
DESCRIPTION
DESCRIPTION
Appendix A
145 / 166
Appendix A
SHDSL Conditions
LOSW-NS 1 LOSW-NS 2 LOSW-CS 1 LOSW-CS 2 ATEN NS 1 ATEN NS 2 ATEN CS 1 ATEN CS 2 SNR NS 1 SNR NS 2 SNR CS 1 SNR CS 2 DCCONT NS 1 DCCONT NS 2 DCCONT CS 1 DCCONT CS 2 ACTLPBK NS SA SA SA SA SA SA SA SA SA SA SA SA SA SA SA SA SA Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Minor Loss of sync word - Network Side Loop1 Loss of sync word - Network Side Loop2 Loss of sync word - Customer Side Loop1 Loss of sync word - Customer Side Loop2 Loop attenuation alarm - Network Side Loop1 Loop attenuation alarm - Network Side Loop2 Loop attenuation alarm - Customer Side Loop1 Loop attenuation alarm - Customer Side Loop2 Signal to noise ratio alarm - Network Side Loop1 Signal to noise ratio alarm - Network Side Loop2 Signal to noise ratio alarm - Customer Side Loop1 Signal to noise ratio alarm - Customer Side Loop2 DC continuity fault - Network Side Loop1 DC continuity fault - Network Side Loop2 DC continuity fault - Customer Side Loop1 DC continuity fault - Customer Side Loop2 Facility placed in loopback - Network Side
CONDITION
SERVICE AFFECTING?
DEFAULT NTFCNCDE
DESCRIPTION
146 / 166
Edition 02
Appendix A
SERVICE AFFECTING? SA SA SA SA SA
DESCRIPTION Configuration error Loss of ATM Cell Delineation (see Note) Loss of power at STU R Unable to disable STU R access Device Failure
Note
These ATM alarms are only supported for STU C and STU R.
E3 Facility Conditions
CONDITION RAI AIS SERVICE AFFECTING? SA SA SA SA SA SA SA SA SA SA SA SA DEFAULT NTFCNCDE MAJOR Critical Critical Critical Critical Critical Minor Minor Minor Critical Critical Critical DESCRIPTION Remote Alarm Indication Alarm Indication Signal Loss of framing Loss of Signal/Clock
LOF LOS LCD* Loss of cell delineation ACTLPBK PLM P PLU UNEQ-P CELLSIG OVRFLO UDRFLO Network side in loopback Payload type mismatch Stable payload type Payload unequipped False start of cell input signal Buffer (FIFO) overflow Buffer (FIFO) underflow
Edition 02
147 / 166
Appendix A
AIS L RFI L SA SA SA SA SA SA SA SA SA SA SA SA SA Minor Minor Minor Line alarm indication signal Excessive line bit errors BERL HT Critical Remote failure/defect indication Excessive far end block errors Excessive section BIP 8 errors Section loss of frame Section loss of clock False start of cell input signal Buffer (FIFO) overflow Reference clock failed FIFO clock failed Loss of ATM cell delineation Section loss of signal T CV LFE T CV S LOF LOS Critical Critical Critical Critical Critical Critical Critical Critical Critical LOC CELLSIG OVRFLO REFCLK FIFOCLK LCD*
CONDITION
SERVICE AFFECTING?
DEFAULT NTFCNCDE
DESCRIPTION
* These ATM conditions are reported via the OC3 facility STS3C facility conditions
PLM P PLU NSA NSA NSA SA SA SA SA SA Minor Minor Minor Minor Minor Minor Signal Label Mismatch Signal Label Unstable Path Unequipped UNEQ P RFI P T CV P LOP Remote Path Failure/Defect Indication Excessive Path BIP errors STS Loss of Pointer Excessive Path Far-End Block Errors Path Alarm Indication Signal Major T CV PFE AIS P Critical
CONDITION
SERVICE AFFECTING?
DEFAULT NTFCNCDE
DESCRIPTION
148 / 166
Edition 02
Appendix A
ANISIGCHN FAILURE SA SA Critical Minor Minor Minor Failure of network-side Signaling Channel UNISIGCHN FAILURE Failure of user-side Signaling Channel T1-SIGSYS1-PERF NSA NSA Performance count threshold exceeded on Signaling Channel Performance summary count threshold exceeded on Signaling Channel T1-SIGSYS1-SUM
CONDITION
SERVICE AFFECTING?
DEFAULT NTFCNCDE
DESCRIPTION
T3 (DS3) facility conditions
CONDITION RAI AIS SERVICE AFFECTING? SA SA SA SA SA SA SA DEFAULT NTFCNCDE Minor Minor DESCRIPTION Remote alarm indication Alarm indication signal Loss of framing Loss of signal/clock
LOF Major Major Major LOS Critical ATMFE LCD ATM DS3 PLCP Far-End Alarm ATM DS3 PLCP Loss of Frame Loss of ATM Cell Delineation ATMLOF Critical
3EC 36876 AEAA TCZZA Edition 02
149 / 166
Appendix A
150 / 166
Edition 02
Appendix B
Error Codes
Appendix B
Error Codes
An error code is a four character 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 ENDS EQWT ICNC IDNC IDNV IEAE IENE IISP IITA IPEX IPMS IPNC IPNV SAAL SAIN SARB SDNA SDNC SLEM DESCRIPTION Equipage, not equipped with duplex switching Equipage, wrong type Input, command not consistent Input, data not consistent Input, data not valid Input, entity already exists Input, entity not exists (does not exist) Input, invalid syntax or punctuation Input, invalid target identifier - the command contains an invalid TID Invalid extra input parameter Input parameter missing Input parameter not consistent Input parameter not valid Status, already allowed Status, already inhibited Status, all system resources busy Status, duplex unit not available Status, data not consistent Status, list exceed maximum - command processing exceeded system limit TA/TR TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200 TA 200
Edition 02
151 / 166
Appendix B
Error Codes
DESCRIPTION Status, not in valid state Status, requested command(s) inhibited Status, requested operation failed Status, system resources exceeded - the command exceeded the system limit on a parameter Status, command execution stopped - the command execution was terminated because of a software/hardware problem
152 / 166
Edition 02
Appendix C
ATM Addressing
Appendix C
C.1 Introduction
ATM Addressing
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
C.2
DCC-idi.hodsp.esi.sel
idi hodsp
Initial Domain Identifier (3 digit decimal). The value is a 3 digit Country Code. Higher Order Domain Specific Part (20 digit hexadecimal). If fewer than 20 digits are specified, the value is padded with trailing zeroes. End System Identifier (12 digit hexadecimal). If fewer than 12 digits are specified, the value is padded with trailing zeroes. Selector (2 digit hexadecimal). If fewer than 2 digits are specified, the value is padded with trailing zeroes.
esi
sel
Edition 02
153 / 166
Appendix C
ATM Addressing
C.3
ICD-idi.hodsp.esi.sel
idi
Initial Domain Identifier (4 digit decimal). The value is a 4 digit International Code Designator that identifies an international organization. Higher Order Domain Specific Part (20 digit hexadecimal). If fewer than 20 digits are specified, the value is padded with trailing zeroes. End System Identifier (12 digit hexadecimal). If fewer than 12 digits are specified, the value is padded with trailing zeroes. Selector (2 digit hexadecimal). If fewer than 2 digits are specified, the value is padded with trailing zeroes.
hodsp
esi
sel
C.4
AE164-idi.hodsp.esi.sel
idi
Initial Domain Identifier (1...15 digit decimal). The value is an E.164 telephone number. Higher Order Domain Specific Part (8 digit hexadecimal). If fewer than 8 digits are specified, the value is padded with trailing zeroes. End System Identifier (12 digit hexadecimal). If fewer than 12 digits are specified, the value is padded with trailing zeroes. Selector (2 digit hexadecimal). If fewer than 2 digits are specified, the value is padded with trailing zeroes.
hodsp
esi
sel
154 / 166
Edition 02
Appendix C
ATM Addressing
C.5
AE164-phone
phone
C.6
A-address
address
Edition 02
155 / 166
Appendix C
ATM Addressing
156 / 166
Edition 02
Appendix D
Appendix D
Standard Density (SD) systems High Density (HD) systems Ulta Density (UD) systems.
D.1
Figure 1
LT1 LT2 LT12 ACU ATU R NTA or EXA NTA or EXB ATU R
Shelf Detail
ATU R
ATU R
Rack 2
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
Edition 02
157 / 166
ACU
Figure 2
D.2
158 / 166
Appendix D
Rack 1
NTA or EXA
Shelf
Shelf
NTA or EXB
TAU or TEU
Note
Shelf Detail
Rack 2
Shelf
Shelf
LP1
LT1
LT2
LP2
Rack 3
Shelf
Shelf
ASAM (NE)
LP1 6
LT16
Rack 4
Shelf
Shelf
3EC 36876 AEAA TCZZA Rack 5 Shelf Shelf ATU R ATU R ATU R ATU R ATU R
ATU R
Rack 6
Shelf
Shelf
Edition 02
Appendix D
D.3
ACU
NTA or EXA
NTA or EXB
LT1
LT2
LT16
Rack 1 Shelf
Rack 2
Rack 3
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. Note The maximum number of shelves allowed in an ASAM is 6 because of the limit on the number (2304) lines.
Edition 02
ATU R ATU R ATU R ATU R
Shelf Detail
ATU R
ATU R
159 / 166
Appendix D
D.4
Racks (RACK)
The ASAM may have up to 6 racks. The AID for the racks is: RACK rack where rack is the rack number.
Shelves (SHELF)
The ASAM may have up to 2 HD shelves (sub racks), 3 UD or 4 SD shelves in a rack. The AID for shelves is: SHELF rack shelf where rack is the rack number and shelf is the shelf number (1...4).
The NT are always located in the first shelf of the first rack in a 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 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: SERV rack shelf sv_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).
The AID for IP Gateway (IPGW) server units is IPGW rack shelf sv_slot Note Server units may only be placed in rack 1, shelf 1 The IPGW server is a two slot card that must be planned in a slot pair. Slots are paired as 1 2, 3 4, .., 15 16. The sv_slot used must be the lower slot number in the pair (e.g., 1 for 1 2, 3 for 3 4, .. 15 for 15 16).
160 / 166
Edition 02
Appendix D
All subsequent shelves in the system are configured with Shelf Extender (EX) units instead NTs. The extender units connect the shelf to the previous one in daisy chain 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} rack shelf Note rack=1, shelf=1 is not a valid AID for an Extender since this location is only used for an NT.
Each shelf in the ASAM supports LT units in LT slots 1..12 for SD shelves and slots 1..18 for HD shelves. The AIDs for the Line Termination units are: LT rack shelf lt_slot
Each LT in the HD shelf is associated with a separate applique unit that performs LT support functions. The AID for the LP units is: LP rack shelf lt_slot Note LP Units are not managed in release 4.2.
The ASAM supports a single TAU for HD systems that is located in the first system shelf (rack 1, shelf 1). This unit supports external test access to circuits in the LT. The TAU connects to other shelves via a daisy chain 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. TEU rack shelf The TEU is located in shelves other than rack 1, shelf 1. Note The TAU and TEUs are not managed in release 4.2.
Each shelf has a slot for an ACU. However, only one ACU is 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: ACU rack shelf
Edition 02
161 / 166
Appendix D
ATU R (ATUR)
The ADSL Termination Unit Remote (ATU R ) or the ADSL modem at the customer premises is managed in a limited way by the ASAM. The ATU R is identified by the ADSL circuit to which it is connected via the LT. The AID is: ATUR rack shelf lt_slot circuit
D.5
Each ADSL LT supports ADSL Termination Unit Central (ATU C) modems. Each modem supports a single ADSL line or circuit. The AID for ADSL lines is: ADSL rack shelf lt_slot circuit Note SD LTs support 4 circuits HD LTs support 12 circuits UD LTs support 24 circuits.
The SONET NT units (NTA and NTB) and SONET LT units support corresponding OC3 and STS3C facilities. The AIDs for these facilities are: NT Facilities: {NTOC3|NTOC3A|NTOC3B} {NTSTS3C|NTSTS3CA|NTSTS3CB} LT Facilities: LTOC3 rack shelf lt_slot circuit LTSTS3C rack shelf lt_slot circuit
E1 Facilities
The E1 NT units support corresponding E1 facilities. The AIDs for the NT E1 facilities are: NTE1 circuit LTE1 rack shelf lt_slot circuit
E3 Facilities
The E3 NT units (NTA and NTB) support corresponding E3 facilities.The AIDs for the NT E3 facilities are: {NTE3|NTE3A|NTE3B}
162 / 166
Edition 02
Appendix D
DS1 Facilities
The ASAM supports DS1 facilities on DS1 LT cards.The AID for these DS1 facilities is: LTT1 rack shelf lt_slot circuit Note Only HD LTs are supported. Each supports 8 circuits.
DS3 Facilities
The DS3 NT units (NTA and NTB) support corresponding DS3 facilities. The AIDs for the NT DS3 facilities are: NT Facilities: {NTT3|NTT3A|NTT3B} LT Facilities: LTT3 rack shelf lt_slot circuit Note DS3 LT 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: LTSHDSL rack shelf lt_slot circuit (SHDSL facility in the LT) LTSHDSLDEV rack shelf lt_slot circuit unit (A unit in the SHDSL facility in the LT) where unit = SHDSL unit in a span (1..2) unit 1 = STU C unit 2 = STU R LTSHDSLSEG rack shelf lt_slot circuit unit side (A segment in the SHDSL facility) where side = Side of the unit: N Network Side C Customer Side LTSHDSLSWP rack shelf lt_slot circuit unit side wirepair (A specific wire pair associated with an SHDSL Segment) where wirepair = The wire pair in a segment: 1 Pair 1 (only pair in a 2 wire mode) 2 Pair 2 (second pair in a 4 wire mode)
The system supports VALT LT cards. Voice gateway facilities in the LT card are accessed via AID: LTVOXPORT rack shelf lt_slot circuit
Edition 02
163 / 166
Appendix D
D.6
ATM Port
ATM Ports in the NE are identified by the following AIDs: NTATM LTATM rack shelf lt_slot circuit LTIMAATM rack shelf lt_slot imagrp SERVATM rack shelf serv_slot circuit Where: imagrp is the IMA Group number in the LT serv_slot is the slot number where the Server card is installed.
The Virtual Path Links in the ATM facilities on the NT and the LT side are identified by the following AIDs: NTVPL vpi LTVPL rack shelf lt_slot circuit vpi Where vpi is the VPI (Virtual Path Identifier) for the VPL.
The Virtual Channel Links in the ATM facilities on the NT and the LT side are identified by the following AIDs: NTVCL vpi vci LTVCL rack shelf lt_slot vpi vci Where vpi is the VPI (Virtual Path Identifier), and vci is the VCI (Virtual Channel Identifier) for the VCL.
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) LTIMA rack shelf lt_slot imagrp 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.
164 / 166
Edition 02
Appendix D
The ASAM system supports SVC capability. The AIDs for accessing Signaling Channels are: NTSIGCHN LTSIGCHN rack shelf lt_slot circuit LTIMASIGCHN rack shelf lt_slot imagrp
The ASAM supports SVC capability. The AID for accessing the Signaling Subsystem is: SIGSYS 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: E164 ddddddddddddddd (1..15 digits) AESA DCC: DCC dddF .xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxx.xx AESA ICD: ICD dddd.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxx.xx AESA E.164: AE164 dddddddddddddddF .xxxxxxxx.xxxxxxxxxxxx.xx Unformatted AESA : A xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (2..40 digits) where: d = '0' .. '9' (decimal digit) x = '0' .. 'F' (hexadecimal digit) F = Optionally specified hexadecimal 'F' digit
IP Port (IPPORT)
The ASAM supports ports for communications via the Internet Protocol. The following AIDs support ports that can be configured by the user: ATM 1 The first IP over ATM 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.
Edition 02
165 / 166
Appendix D
D.7
166 / 166
Edition 02