Paradyne Jetstream CPX-1000 Reference guide

Jetstream

®

CPX-1000

Voice Services Platform

TL1 Reference

Release 2.5

Document No. 1000-A2-GH30-00

A February 2003

1000-A2-GH30-00

Printed in U.S.A.

Notice

This publication is protected by federal copyright law. No part of this publication may be copied or distributed,

transmitted, transcribed, stored in a retrieval system, or translated into any human or computer language in any form or

by any means, electronic, mechanical, magnetic, manual or otherwise, or disclosed to third parties without the express

written permission of Paradyne Corporation, 8545 126th Ave. N., Largo, FL 33773.

Paradyne Corporation makes no representation or warranties with respect to the contents hereof and specifically

disclaims any implied warranties of merchantability or fitness for a particular purpose. Further, Paradyne Corporation

reserves the right to revise this publication and to make changes from time to time in the contents hereof without

obligation of Paradyne Corporation to notify any person of such revision or changes.

Changes and enhancements to the product and to the information herein will be documented and issued as a new

release to this manual.

Warranty, Sales, Service, and Training Information

Contact your local sales representative, service representative, or distributor directly for any help needed. For additional

information concerning warranty, sales, service, repair, installation, documentation, training, distributor locations, or

Paradyne worldwide office locations, use one of the following methods:

Internet: Visit the Paradyne World Wide Web site at www.paradyne.com. (Be sure to register your warranty at

www.paradyne.com/warranty.)

Telephone: Call our automated system to receive current information by fax or to speak with a company

representative.

— Within the U.S.A., call 1-800-870-2221

— Outside the U.S.A., call 1-727-530-2340

Document Feedback

We welcome your comments and suggestions about this document. Please mail them to Technical Publications,

Paradyne Corporation, 8545 126th Ave. N., Largo, FL 33773, or send e-mail to userdoc@paradyne.com. Include the

number and title of this document in your correspondence. Please include your name and phone number if you are

willing to provide additional clarification.

Trademarks

Jetstream is a registered trademark of Paradyne Corporation. All other products and services mentioned herein are the

trademarks, service marks, registered trademarks, or registered service marks of their respective owners.

February 2003 i

Table of Contents

Preface

Audience vii

Organization vii

Related Documents viii

Chapter 1 Introduction

TL1 Agent.................................................................................1-1

Connections .............................................................................1-2

Configurable Options.............................................................1-2

User Administration...............................................................1-3

Command Scoping Rules.......................................................1-3

Grouping of Parameter Arguments .....................................1-4

Conventions and Notations...................................................1-4

Chapter 2 Parameter Types

Access Parameters...................................................................2-1

AID......................................................................................2-1

ATAG ..................................................................................2-2

CTAG ..................................................................................2-2

TID.......................................................................................2-2

Table of Contents 1000-A2-GH30-00

ii February 2003

Other Parameters ....................................................................2-3

AIDType .............................................................................2-3

AlarmCutoff Mode ...........................................................2-4

AlarmIndication Signal ....................................................2-4

ATAGSeq ............................................................................2-5

Attenuation ........................................................................2-5

BoolYN ...............................................................................2-5

BoolYNull...........................................................................2-5

Cable ...................................................................................2-6

CableType...........................................................................2-6

ChannelGoTo .....................................................................2-6

ClearLog .............................................................................2-7

CommandMode ................................................................2-7

CompressionType .............................................................2-7

ConditionEffect .................................................................2-8

ConditionType...................................................................2-8

ControlState ..................................................................... 2-11

ControlType ..................................................................... 2-11

DgnRoutineTerm.............................................................2-12

Direction...........................................................................2-12

DSMode............................................................................2-13

DSnFacility.......................................................................2-13

Duration ...........................................................................2-13

EchoType ..........................................................................2-14

EnvConditionType..........................................................2-14

EquipmentType ...............................................................2-15

FacilityType......................................................................2-15

Function_Restore.............................................................2-16

IadPortType......................................................................2-16

Idle.....................................................................................2-17

InhibitMode .....................................................................2-17

Interval..............................................................................2-17

LineCode ..........................................................................2-18

Location ............................................................................2-18

LogName..........................................................................2-18

February 2003 iii

1000-A2-GH30-00 Table of Contents

Loopback ..........................................................................2-19

LoopbackType .................................................................2-19

LossBudget.......................................................................2-20

MessageType....................................................................2-21

ModeofSwitch..................................................................2-21

MonitoredLevel ...............................................................2-22

MonitoredType ................................................................2-22

MonitoredValue...............................................................2-22

NotificationCode.............................................................2-23

OCFacility ........................................................................2-23

ON_OFF ...........................................................................2-23

Operation Category ........................................................2-23

PrimaryState ....................................................................2-24

Redundancy.....................................................................2-25

ReportInterval .................................................................2-25

SecondaryState ................................................................2-25

ServiceEffect.....................................................................2-26

SignalingType ..................................................................2-26

State...................................................................................2-26

STSFacility........................................................................2-27

STSMap.............................................................................2-28

ThresholdLevel................................................................2-28

TimePeriod.......................................................................2-29

Timing...............................................................................2-29

TimingReference..............................................................2-30

TransportType..................................................................2-30

TroubleIsolated................................................................2-30

Type...................................................................................2-31

Unassigned.......................................................................2-32

UserPrivilege ...................................................................2-32

Table of Contents 1000-A2-GH30-00

iv February 2003

Chapter 3 TL1 Commands and Messages

DSFacility .................................................................................3-3

REPT ALM <DSnFacility>...............................................3-3

RTRV-<DSnFacility>.........................................................3-5

Environment ............................................................................3-7

REPT ALM ENV................................................................3-7

RTRV-ALM-ENV...............................................................3-9

Equipment.............................................................................. 3-11

REPT ALM EQPT ............................................................ 3-11

REPT EVT EQPT..............................................................3-13

RTRV-EQPT......................................................................3-16

RTRV-IAD.........................................................................3-17

RTRV-IADPORT ..............................................................3-20

RTRV-IADPRF .................................................................3-21

RTRV-IG............................................................................3-23

RTRV-PROTGRP .............................................................3-25

Fault ........................................................................................3-27

REPT ALM IAD...............................................................3-27

REPT ALM IADPORT ....................................................3-29

REPT ALM IG..................................................................3-30

REPT ALM PROTGROUP .............................................3-32

REPT EVT IAD ................................................................3-34

REPT EVT IADPORT......................................................3-36

REPT EVT IG ...................................................................3-37

REPT EVT PROTGROUP...............................................3-39

RTRV-ALM-<AIDType> ................................................3-40

IAD Provisioning ..................................................................3-42

ENT-IAD...........................................................................3-42

ED-IAD .............................................................................3-45

DLT-IAD ...........................................................................3-47

ED-IADPORT ..................................................................3-48

February 2003 v

1000-A2-GH30-00 Table of Contents

Log...........................................................................................3-50

INIT-LOG .........................................................................3-50

REPT DBCHG..................................................................3-52

RTRV-ATTR-LOG............................................................3-53

RTRV-LOG .......................................................................3-54

RTRV-LOG-TL1LOG.......................................................3-56

SET-ATTR-LOG ...............................................................3-57

OCFacility ..............................................................................3-58

REPT ALM <OCFacility> ..............................................3-58

RTRV-OC3 ........................................................................3-60

Protection ...............................................................................3-63

Security ...................................................................................3-63

DLT-USER-SECU ............................................................3-64

ED-PID..............................................................................3-65

ED-SECU ..........................................................................3-66

ED-USER-SECU ..............................................................3-67

ENT-USER-SECU ............................................................3-69

RTRV-USER-SECU..........................................................3-70

STSFacility..............................................................................3-72

System.....................................................................................3-74

ACT-USER........................................................................3-74

ALW-MSG-<AIDType>..................................................3-75

CANC-USER....................................................................3-76

ED-DAT ............................................................................3-77

INH-MSG-<AIDType>...................................................3-78

RTRV-HDR ......................................................................3-79

SET-SID.............................................................................3-80

Chapter 4 Error Codes

Table of Contents 1000-A2-GH30-00

vi February 2003

Chapter 5 Environmental Alarm Types

Index

February 2003 vii

Preface

This TL1 Reference lists all commands and messages supported by

the TL1 Agent. This document also provides input and response

(output) formats and examples with those commands and

messages.

Audience The TL1 Reference is written for network operations center crafts

personnel who manage and monitor alarms and events of the

CPX-1000 equipment. These readers should know the command

language interface and be familiar with TL1.

Organization The TL1 Reference is organized as follows:

Chapter 1, Introduction, describes the Transaction Language

1 (TL1), a standard-based messages supported by the TL1

Agent.

Chapter 2, Parameter Types, describes all message

parameter types defined for the TL1 messages.

Chapter 3, TL1 Commands and Messages, describes the

TL1 commands and messages and provides input and

output formats and examples.

Chapter 4, Error Codes, lists both the default and general

error codes.

Chapter 5, Environmental Alarm Types, lists and describes

valid values for the <almtype> parameter.

Preface 1000-A2-GH30-00

viii February 2003

Complete documentation for this product is available online at

www.paradyne.com. Select Support

Technical Manuals

Jetstream Media Gateway Systems.

CPX-1000 Voice Services Platform Installation and Operation

Describes the features, installation, testing, troubleshooting,

and repair of the CPX-1000 Voice Services Platform

equipment.

JetCraft User’s Guide

Describes the installation and use of JetCraft in CPX-1000

provisioning.

JetVision Installation

Describes the installation of JetVision software.

JetVision User’s Guide

Describes the top level management of multiple CPX-1000

equipment.

To order a paper copy of a Paradyne document or to speak to a

sales representative, please call 1-727-530-2000.

February 2003 1-1

C H A P T E R

1

Introduction

This chapter describes the Transaction Language 1 (TL1)

commands supported by the Jetstream TL1 Agent. TL1 is a set of

ASCII-based instructions (or “messages”) that an Operations

Support System (OSS) uses to manage a network element (NE) and

its resources. This chapter includes these topics:

Number of connections allowed (page 1-2)

Configurable options (page 1-2)

User administration (page 1-3)

Command scoping rules (page 1-3)

Grouping of parameter arguments (page 1-4)

Convention and notation (page 1-4)

Jetstream TL1 is based on the following Bellcore documents:

GR-833-CORE, Network Maintenance: Network Element and

Transport Surveillance Messages

GR-199-CORE, Operations Applications Messages, Memory

Administration Messages

TR-NWT-000835 Operations Application Messages, Network

Element and Network System Security Administration Messages

GR-1093-CORE, Generic State Requirements for Network

Elements

TL1 Agent The TL1 Agent is an application that allows TL1 messages to be

sent to the CPX-1000 Voice Services Platform. The messages

supported allow for alarm management and retrieval of the

current CPX-1000 configuration.

1. Introduction 1000-A2-GH30-00

1-2 February 2003

Connections The TL1 Agent supports several simultaneous sessions to access

information about the CPX-1000. You can access the TL1 Agent via

TELNET or one of the serial ports on the MP card of the CPX-1000.

Configurable

Options

Table 1–1 lists the configurable options to which you can customize

your setup and their default settings. Configure these options in

the Windows registry, and configure the TL1 Agent using the

following registry key:

\\HKEY_LOCAL_MACHINE\System\CurrentControlSet

\Services\Jetstream TL1 Agent\parameters

Default Port Simultaneous Session

TELNET 3082 7

Serial port COM1 1

Table 1–1. TL1 Agent Configurable Options

Configurable Options Default Settings Description

LogRootDir C:\temp\TL1Logs The directory containing the TL1 logs.

ErrorLogFileName TL1Error The name of the TL1 error log file.

TL1LogFileName TL1Log The name of the TL1 log file.

ErrorLogMaxEntries 256 The maximum number of entries in the

error log file, up to 9999 entries.

TL1LogMaxEntries 256 The maximum number of entries in the

TL1 log file, up to 9999 entries.

TidValue CPX-1000 The Target Identifier.

Port 3082 The port number of socket connection.

Serial Port 1 The port number of serial communication.

February 2003 1-3

1000-A2-GH30-00 1. Introduction

User

Administration

To control access, the TL1 Agent supports four different user

levels; each level has different privilege. Table 1–2 lists these

privilege levels.

Command

Scoping Rules

Commands may affect one or more entities. In general, you can

specify a TL1 interface where retrieval may be broad but changes

are narrow in scope.

Retrieves (Request): To allow as much bulk and flexible

retrieval of information from the CPX-1000, the fields of

requests permit the following values and/or operators.

— Fields with default values are optional and allow the

wildcard value “ALL.” Where their syntaxes allow, these

fields are listable and rangeable.

— An “ALL” absence indicates that the fields do not allow a

default and that the keyword “ALL” is not permitted.

Other Commands (Changes): To ensure that changes are

specific to the entities that they are intended for, the scope of

provisioning commands in general is as narrow as possible.

Table 1–2. User Levels and Privileges

User Levels Privileges

ROALM Read Only Alarms

RWALM Read/Write Alarms

ROADM Read Only Administration

RWADM Read/Write Administration

1. Introduction 1000-A2-GH30-00

1-4 February 2003

Grouping of

Parameter

Arguments

Some parameters in a message can be grouped by using the

ampersand (&) character so a single occurrence of a message may

be applied to more than one entity. The grouping can be done to

generate a list of AIDs or a range (incremented in integer steps) of

AIDs. For example:

CPX-1&CPX-2&CPX-3

where the command applies to the three CPX shelves CPX-1,

CPX-2, and CPX-3 as if three individual commands had been sent

to the NE.

Conventions

and Notations

Uppercase characters in format expression appear as they are in

the message. Table 1–3 lists syntactical characters.

Note

Parameter grouping is not allowed unless explicitly

stated in the message.

Note

Semicolons (;), commas (,), colons (:), and dashes (–) are

transmitted exactly as shown.

February 2003 1-5

1000-A2-GH30-00 1. Introduction

Table 1–3. Syntactical Characters

Character Description

; A semicolon indicates the end of a message.

, A comma separates parameters within a parameter

block.

: A colon separates parameter blocks.

– A dash is used to separate the first and second

modifier.

“ “ A pair of quotes is used to delimit an expression

that can be parsed.

[ ] One or more parameters (including delimiters)

enclosed within brackets indicates the parameters

are optional. An optional parameter means that if a

user inputs an empty field for an optional

parameter, then a default value will be substituted

automatically in the transmitted input field.

< > The brackets are used to enclose one or more

information items, e.g., <date>, <time>, etc. The

brackets are not transmitted.

* A single asterisk or double asterisks are used to

specify multiple or a range of values.

& A single ampersand is used to list several entities.

&& Double ampersands are used to indicate a range of

entities.

1. Introduction 1000-A2-GH30-00

1-6 February 2003

February 2003 2-1

C H A P T E R

2

Parameter Types

This chapter describes all message parameter types defined for the

TL1 messages used in the CPX-1000, including

Access parameter types (page 2-1)

Other parameter types (page 2-3)

Access

Parameters

Access parameters include

AID

ATAG

CTAG

TID

AID The Access Identification code (AID) directs an input command to

its intended physical or data entity inside the CPX-1000.

Equipment module and facilities are typical examples of entities

addressed by the access code. The following table lists all AIDS

used in TL1 messages by the CPX-1000.

2. Parameter Types 1000-A2-GH30-00

2-2 February 2003

ATAG Automatic tag (ATAG) is a numeric transaction identifier similar to

CTAG. Its value is automatically generated by a TL1 Agent and is

used exclusively as a sequence number for autonomous messages.

When the TL1 Agent first initializes or resets, ATAG starts at 1; and

when ATAG reaches 999999, the number automatically restarts at

1. Operations Support Systems (OSSs) use ATAG to spot any lost

messages.

CTAG A correlation tag (CTAG) is used to correlate input and output

messages. The value of CTAG consists of up to six ASCII,

alphanumeric characters. If no CTAG is provided, 0 is used.

TID The target identifier (TID) identifies the target CPX-1000 to which a

command is directed. A message sent to an CPX-1000 may be

addressed at that CPX-1000 or routed by it to its target CPX-1000.

If an CPX-1000 is the only target possible for a message sent on a

connection, then TID may be left out of that message. Otherwise, a

TID must be specified.

TIDs are not case-sensitive. It consists between 6 and 20

alphanumeric characters, and no spaces are allowed.

AID Pattern

COM

Control

DS

Environment

COM

CONT-{1-16}

CPX-{1-16}-{1-8}

ENV-{1-16}

Equipment

IAD

IADPRF

IADPort

IG

LOGID

OC

ProtGroup

CPX-{1-16}

IAD-{1-2000}

IADPRF-{1-1000}

IAD-{1-2000}-{1-24}

GR303-{1-4}

TL1LOG

CPX-{1-16}-1

ATM-{1-4}

TDM-{1-6}

February 2003 2-3

1000-A2-GH30-00 2. Parameter Types

Other

Parameters

This section describes other parameters used in the CPX-1000.

AIDType This parameter indicates the type of Access Identifier (AID) for

most non-environment messages. It defines the scope of AIDs for

equipment (EQPT), the CPX-1000 as a whole (COM), and facility

AIDs. The different facility AIDs have their own enums (i.e.,

AIDTypeOC, AIDTypeTn). For RTRV, the keyword ALL may be

used in messages instead of a specific value for this enum.

Note

Do not use AIDType as the first modifier for ED, ENT, or

RTRV messages (i.e., ED-AIDType, ENT-AIDType,

RTRV-AIDType). Instead, use the specific enums (e.g.,

ED-AIDTypeEC, etc.) or “fixed string” message names

(e.g., ED-EQPT, etc.).

Options Description

COM Designates CPX-1000 as a whole.

EQPT Equipment

IAD Integrated Access Device

IADPORT Integrated Access Device port

IG Interface Group

OC3 Optical carrier 3

PROTGRP Protection Group

STS1 Synchronous transport signal 1

T1 DS1

T3 DS3

2. Parameter Types 1000-A2-GH30-00

2-4 February 2003

AlarmCutoff

Mode

This parameter indicates the mode of alarm cutoff (ACO)

operation that is provided by the CPX-1000.

AlarmIndication

Signal

This parameter indicates the type of Alarm Indication Signal (AIS)

to be sent on the outgoing cross-connected signal when AIS is on

the incoming signal.

Note

This parameter is reserved for a future release.

Options Description

DELD ACO is delayed to allow announcement

IMED ACO is introduced automatically and

immediately at the CPX-1000

MAN ACO is introduced by OS command or

manual operation

Note

This parameter is reserved for a future release.

Options Description

FONES Translate to framed all ones.

N No. For AISPASS, translate to the AIS type of

the connected DS3.

NAS North American Standard (default for AIST).

ONES Translate to unframed all ones.

Y Yes. For AISPASS, no translation, i.e., let the

incoming AIS pass through.

Page is loading ...

Paradyne Jetstream CPX-1000 Reference guide

Paradyne Jetstream CPX-1000 Reference guide

Related papers

Other documents