ADTRAN 4200659L7, 4175043L2, 1200287L1, 1200291L1, 1200657L2, 4200659L2, 4200659L5, 4200659L8, 4200659L3, 4200659L1, 4200659L6, 4200659L4 User Manual

Size:
1.66 Mb
Download

Chapter 9. Transaction Language 1 (TL1)

The MX2800 STS-1specifically uses “quoted line(s)” inREPTALM andREPT-EVT autonomous messages. TheREPT-ALM message has the following quoted line format:

<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,<OCRDAT>,<OCRTM>,<LOCN>…

The NTFCNCDE field will contain one of the following values:

CL - Alarm Cleared

TC - Transient Condition

MN - Minor

MJ - Major

CR - Critical

The REPT-EVT message has the following quoted line format:

<AID>:<CONDTYPE>,<CONDEFF>,<OCRDAT>,<OCRTM>,<LOCN>…

The CONDEFF field will contain one of the following values:

CL - Standing Condition Cleared

SC - Standing Condition Raised

TC - Transient Condition

For possible CONDTYPE codes for bothREPT-ALM andREPT-EVT quoted lines, refer to the condition types listed inTable 9-2 on page 9-10 andTable 9-3 on page 9-12, respectively.

See the section TL1 Autonomous Messages on page 9-10 for a list of autonomous messages currently supported by the MX2800 STS- 1.

TL1 COMMANDS

As stated in TL1 Messages on page 9-2,the general format for a

TL1 command is:

<VERB>[-<MOD1>[-<MOD2>]]:[<TID>]:[<AID>]:[<CTAG>]:[GB](:<PARAMx>(,<PARAMx>)*)*;

61200659L1-1

MX2800 STS-1User Manual

9-5

Chapter 9. Transaction Language 1 (TL1)

Areas of concentration for TL1 support in the MX2800 STS-1include session initiation, termination, user account management, and system event reporting.Table 9-1 lists the commands currently supported by the MX2800STS-1.

 

Table 9-1.TL1 Commands

 

ACT-USER::<username>:::<password>;

 

 

Description

Initiates a TL1 session

 

 

TID*

Circuit ID/Unit ID

 

 

AID

Username (must be present in TL1 user table)

 

 

CTAG*

Transaction Number (integer)

 

 

PARAM1

Password for associated username

 

 

ALW-MSG-{EQPT|rr|ALL};

 

 

Description

Allows the transmission of the requested autonomous

 

alarm(s)

 

 

MOD2

Specifies what entity type to allow:

 

EQPT...General Equipment Unit

 

rr ..........Facility or Circuit (i.e. T1, VT1, STS1)

 

ALL ......All entity types

 

 

TID*

Circuit ID/Unit ID

 

 

CTAG*

Transaction Number (integer)

 

 

PARAM1*

Specifies what notification code to allow:

 

MN ....... minor

 

MJ........ major

 

CR ....... critical

 

ALL........all notification codes

 

 

CANC-USER;

 

 

Description

Terminates a TL1 session

 

 

TID*

Circuit ID/Unit ID

 

 

AID*

Username (must be present in TL1 user table)

 

 

CTAG*

Transaction Number (integer)

 

 

* An asterisk indicates optional command blocks.

9-6

MX2800 STS-1User Manual

61200659L1-1

Chapter 9. Transaction Language 1 (TL1)

Table 9-1.TL1 Commands (Continued)

ED-USER-SECU::<username>:::,<password>,,<privileges>;

Description

Edits the requested TL1 user’s account

 

 

TID*

Circuit ID/Unit ID

 

 

AID

Username (must be present in TL1 user table)

 

 

CTAG*

Transaction Number (integer)

 

 

PARAM2

User’s new password

 

 

PARAM4

User’s new privileges:

 

0 ..........

disabled

 

1 ..........

guest

 

3 ..........

admin

 

 

 

ENT-USER-SECU::<username>:::<password>,,<privileges>;

Description

Adds the requested user to the TL1 user table

 

 

TID*

Circuit ID/Unit ID

 

 

AID

Username

 

 

CTAG*

Transaction Number (integer)

 

 

PARAM1

User’s password

 

 

PARAM3

User’s privileges:

 

0 .......... disabled

 

1 .......... guest

 

3 .......... admin

 

 

DLT-USER-SECU::<user>;

 

 

Description

Removes the requested user from the TL1 user table

 

 

TID*

Circuit ID/Unit ID

 

 

AID

Username (must be present in TL1 user table)

 

 

CTAG*

Transaction Number (integer)

 

 

INH-MSG-{EQPT|rr|ALL};

 

 

Description

Inhibits the transmission of the requested autonomous

 

alarm(s)

 

 

* An asterisk indicates optional command blocks.

61200659L1-1

MX2800 STS-1User Manual

9-7

Chapter 9. Transaction Language 1 (TL1)

 

 

Table 9-1.TL1 Commands (Continued)

 

 

MOD2

 

Specifies what entity type to inhibit:

 

 

EQPT...General Equipment Unit

 

 

rr ..........Facility or Circuit (i.e. T1, VT1, STS1)

 

 

ALL ......All entity types

 

 

 

TID*

 

Circuit ID/Unit ID

 

 

 

CTAG*

 

Transaction Number (integer)

 

 

 

PARAM1*

 

Specifies what notification code to inhibit:

 

 

MN ....... minor

 

 

MJ........ major

 

 

CR ....... critical

 

 

ALL........all notification codes

 

 

 

RTRV-HDR;

 

 

 

Description

 

Replies with a normal "COMPLD" response

 

 

 

TID*

 

Circuit ID/Unit ID

 

 

 

CTAG*

 

Transaction Number (integer)

 

 

RTRV-USER-SECU;

 

 

Description

 

Retrieves the current list of users from the TL1 users table

 

 

 

TID*

 

Circuit ID/Unit ID

 

 

 

CTAG*

 

Transaction Number (integer)

 

 

RTRV-ALM-{EQPT|rr|ALL};

 

 

Description

 

Retrieves the requested alarm status

 

 

 

MOD2

 

Specifies what entity type to query:

 

 

EQPT...General Equipment Unit

 

 

rr ..........Facility or Circuit (i.e. T1, VT1, STS1)

 

 

ALL ......All entity types

 

 

 

TID*

 

Circuit ID/Unit ID

 

 

 

* An asterisk indicates optional command blocks.

9-8

MX2800 STS-1User Manual

61200659L1-1

 

 

Chapter 9. Transaction Language 1 (TL1)

 

 

Table 9-1.TL1 Commands (Continued)

 

 

 

 

AID*

Identifies the component to which the desired alarm

 

 

pertains. Identifiers are dependent on the entity specified in

 

 

"MOD2" as follows:

for T1:

101....DS1#1

102....DS1#2

.

128....DS1#28

ALL....all DS1 circuits (default selection)

for VT1:

201....VT1#1

202....VT1#2

.

228....VT1#28

ALL....all VT1 circuits (default selection)

for STS-1:

301 ....STS-1#1

ALL....all STS-1circuits (default selection) for EQPT:

 

 

401 ....

Generic

 

 

402 ....

Control Card A

 

 

403 ....

Control Card B

 

 

404 ....

Power Supply A

 

 

405 ....

Power Supply B

 

 

ALL....

all EQPT identifiers (default selection)

 

for ALL:

x

specific identifier (e.g. "1", "28",etc.,)

 

 

 

 

ALL....

all identifiers (default selection)

 

 

CTAG*

Transaction Number (integer)

 

 

PARAM1*

Specifies what notification code to query:

 

MN.......

minor

 

 

MJ........

major

 

 

CR .......

critical

 

* An asterisk indicates optional command blocks.

61200659L1-1

MX2800 STS-1User Manual

9-9

Chapter 9. Transaction Language 1 (TL1)

TL1 AUTONOMOUS MESSAGES

Autonomous messages provide a mechanism for real time reporting of system events. Transmission of these messages is disabled by default and must be explicitly enabled. Although most events reported are alarms, some events are only informational. The VERB,MOD1, andMOD2 parameters of the message indicate what type of event has occurred.

REPT-ALM indicates an alarm event.Table 9-2 lists possible autonomous messages for alarm events.

Table 9-2.MX2800STS-1Alarm Events

 

AID

Notification

Condition

Service

Location

Description

 

 

Code

Type

Affecting

 

 

 

 

 

 

 

 

 

 

101-128

MN

TSA

SA

NEND

DS1 In-test

 

 

 

 

 

 

 

 

101-128

CR

LOS

SA

NEND

Loss Of Signal

REPT

 

 

 

 

 

 

101-128

MN

BPV

SA

NEND

Bipolar Violation

ALM

 

 

 

 

 

 

101-128

MJ

FACTERM

NSA

NEND

T1 Failure

T1

 

 

 

 

 

 

 

 

101-128

MN

AIS

SA

FEND

Alarm Indication Signal

 

 

 

 

 

 

 

 

101-128

MN

AIS

SA

FEND

STS-1Unframed Ones Alarm

 

 

 

 

 

 

 

 

201-228

MN

LOP-V

SA

NEND

VT path Loss of Pointer

 

 

 

 

 

 

 

 

201-228

MN

AIS-V

SA

FEND

VT path Alarm Indication

 

 

 

 

 

 

Signal

REPT

 

 

 

 

 

 

201-228

MN

RFI-V

SA

FEND

VT path Remote Failure

ALM

 

 

 

 

 

Indication

VT1

 

 

 

 

 

 

 

 

 

 

 

 

201-228

MN

SMLF

NSA

FEND

VT path Signal Label

 

 

 

 

 

 

Mismatch

 

 

 

 

 

 

 

 

201-228

MN

UNEQ-V

NSA

FEND

VT path Unequipped

 

 

 

 

 

 

 

REPT

 

 

 

 

 

 

ALM

301

MN

TSA

SA

NEND

STS-1In-test

STS-1

 

 

 

 

 

 

 

 

 

 

 

 

 

9-10

MX2800 STS-1User Manual

61200659L1-1

Chapter 9. Transaction Language 1 (TL1)

Table 9-2.MX2800STS-1Alarm Events (Continued)

 

 

AID

Notification

Condition

Service

Location

Description

 

 

 

Code

Type

Affecting

 

 

 

 

 

 

 

 

 

 

 

401

(General)

TC

RCVRY

SA

FEND

Protection Switch Alarm

 

 

 

 

 

 

 

 

 

401

(General)

TC

ESW

NSA

NEND

Excessive Protection

 

 

 

 

 

 

 

Switches

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

TC

PROTNA

NSA

NEND

Controller Card Removed

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

CR

CONTEQPT

NSA

NEND

Control Card Failure

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

CR

LOS

SA

NEND

STS-1Loss of Signal

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

CR

LOF

SA

NEND

STS-1Loss of Frame

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

CR

EXT

SA

NEND

STS-1Loss of H4Multi-frame

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

CR

LOP-P

SA

NEND

STS-1Loss of Pointer

 

403

(Ctrl B)

 

 

 

 

 

REPT

 

 

 

 

 

 

402 (Ctrl A)

CR

AIS-L

SA

FEND

STS-1Line Alarm Signal

ALM

403 (Ctrl B)

 

 

 

 

Indication

EQPT

 

 

 

 

 

 

402 (Ctrl A)

CR

AIS-P

SA

FEND

STS-1Path Alarm Signal

 

403

(Ctrl B)

 

 

 

 

Indication

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

MN

RFI-L

SA

FEND

STS-1Line Remote Failure

 

403

(Ctrl B)

 

 

 

 

Indication

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

MN

RFI-P

SA

FEND

STS-1Path Remote Failure

 

403

(Ctrl B)

 

 

 

 

Indication

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

MN

UNEQ-P

NSA

FEND

STS-1Path Unequipped

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

MN

SLMF

NSA

FEND

STS-1Path Signal Label

 

403

(Ctrl B)

 

 

 

 

Mismatch

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

CR

TRMT

SA

NEND

STS-1Transmit Loss of Signal

 

403

(Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

402

(Ctrl A)

MN

BPV

SA

NEND

STS-1Excessive Code

 

403

(Ctrl B)

 

 

 

 

Violations

 

 

 

 

 

 

 

 

 

404

(PS A)

TC

PROTNA

NSA

NEND

Power Card Removed

 

405

(PS B)

 

 

 

 

 

 

 

 

 

 

 

 

 

61200659L1-1

MX2800 STS-1User Manual

9-11

Chapter 9. Transaction Language 1 (TL1)

Table 9-2.MX2800STS-1Alarm Events (Continued)

 

 

AID

Notification

Condition

Service

Location

Description

 

 

 

Code

Type

Affecting

 

 

 

 

 

 

 

 

 

 

 

404

(PS A)

MJ

PWR

NSA

NEND

Power Supply Failure

 

405

(PS B)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

404

(PS A)

MJ

PWR

NSA

NEND

Power Supply Communication

 

405

(PS B)

 

 

 

 

Failure

 

 

 

 

 

 

 

 

 

404

(PS A)

MJ

PWR

NSA

NEND

Power Supply Low

REPT

405 (PS B)

 

 

 

 

 

ALM

404 (PS A)

MJ

PWR

NSA

NEND

Power Supply Charger Fail

EQPT

405 (PS B)

 

 

 

 

 

(cont’d)

 

 

 

 

 

 

404 (PS A)

CR

PWR

NSA

NEND

Power Supply Battery Low

 

405 (PS B)

 

 

 

 

 

 

 

 

 

 

 

 

 

404 (PS A)

MJ

PWR

NSA

NEND

Power Supply Temp High

 

405 (PS B)

 

 

 

 

 

 

 

 

 

 

 

 

 

404 (PS A)

CR

PWR

NSA

NEND

Power Supply Temp Critical

 

405 (PS B)

 

 

 

 

 

 

 

 

 

 

 

 

 

REPT-EVT indicates an informational event.Table 9-3 lists possible autonomous messages for informational events.

Table 9-3.MX2800STS-1Informational Events

 

AID

Notification

Condition

Service

Location

Description

 

 

Code

Type

Affecting

 

 

 

 

 

 

 

 

 

 

501

TC

TIM-P

SA

NEND

STS-1ReceiveJ-Trace

 

 

 

 

 

 

Event

 

 

 

 

 

 

 

 

502 (Ctrl A)

TC

NORMAL

NSA

NEND

Controller Card Inserted

 

503 (Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

REPT

502 (Ctrl A)

TC

SYNCSTAT

SA

NEND

STS-1Clock Status Event

503 (Ctrl B)

 

CHNG

 

 

 

EVT

 

 

 

 

 

 

502 (Ctrl A)

TC

RCVRY

SA

NEND

STS-1Clock Source Event

EQPT

 

503 (Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

 

502 (Ctrl A)

TC

SYNCPRI

SA

NEND

STS-1PRI. Ext. Clock

 

503 (Ctrl B)

 

 

 

 

Event

 

 

 

 

 

 

 

 

502 (Ctrl A)

TC

SYNCSEC

SA

NEND

STS-1SEC. Ext. Clock

 

503 (Ctrl B)

 

 

 

 

Event

 

 

 

 

 

 

 

9-12

MX2800 STS-1User Manual

61200659L1-1

Chapter 9. Transaction Language 1 (TL1)

Table 9-3.MX2800STS-1Informational Events (Continued)

 

AID

Notification

Condition

Service

Location

Description

 

 

Code

Type

Affecting

 

 

 

 

 

 

 

 

 

REPT

502 (Ctrl A)

TC

INT

SA

NEND

STS-1Clock Loss of

503 (Ctrl B)

 

 

 

 

Activity

EVT

 

 

 

 

 

 

 

 

 

 

EQPT

 

 

 

 

 

 

502 (Ctrl A)

TC

NORMAL

NSA

NEND

Power Card Inserted

(cont’d)

503 (Ctrl B)

 

 

 

 

 

 

 

 

 

 

 

 

TL1 ERROR CODES

When the MX2800 STS-1denies a received TL1 command, the Output Response message has an associated4-lettererror code indicating the reason for denial.Table 9-4 lists possible error codes.

 

Table 9-4.TL1 Error Codes

 

 

Error Code

Description

 

 

ICNV

Input, Command Not Valid

 

 

IITA

Input, Invalid Target Identifier

 

 

IPNV

Input, Parameter Not Valid

 

 

PIVI

Privilege, Illegal User Identity

 

 

PLNA

Privilege, Login Not Active

 

 

SSRE

Status, System Resources Exceeded

 

 

61200659L1-1

MX2800 STS-1User Manual

9-13

Chapter 9. Transaction Language 1 (TL1)

9-14

MX2800 STS-1User Manual

61200659L1-1