UTStarcom

UTStarcom
UTStarcom
TL1 User Guide
Release 1.2
Revision A
Product Order No. TN780-TL1G-1.2-A
UTStarcom Inc.
www.utstarcom.com
Copyright
© 2004 UTStarcom Inc. All rights reserved.
This Manual is the property of UTStarcom Inc. and is confidential. No part of this Manual may be reproduced for any purpose or
transmitted in any form to any third party without the express written consent of UTStarcom.
UTStarcom makes no warranties or representations, expressed or implied, of any kind relative to the information or any portion
thereof contained in this Manual or its adaptation or use, and assumes no responsibility or liability of any kind, including, but not
limited to, indirect, special, consequential or incidental damages, (1) for any errors or inaccuracies contained in the information or (2)
arising from the adaptation or use of the information or any portion thereof including any application of software referenced or utilized
in the Manual. The information in this Manual is subject to change without notice.
Trademarks
UTStarcom® is a trademark of UTStarcom Inc.
GoAhead is a trademark of GoAhead Software, Inc.
All other trademarks in this Manual are the property of their respective owners.
UTStarcom TN780 and UTStarcom Optical Line Amplifier Regulatory Compliance
FCC Class A
This device complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) this device may not cause
harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired
operation. Modifying the equipment without UTStarcom's written authorization may result in the equipment no longer complying with
FCC requirements for Class A digital devices. In that event, your right to use the equipment may be limited by FCC regulations, and
you may be required to correct any interference to radio or television communications at your own expense.
DOC Class A
This digital apparatus does not exceed the Class A limits for radio noise emissions from digital apparatus as set out in the
interference-causing equipment standard titled “Digital Apparatus," ICES-003 of the Department of Communications.
Cet appareil numérique respecte les limites de bruits radioélectriques applicables aux appareils numériques de Classe A prescrites
dans la norme sur le matériel brouilleur: "Appareils Numériques," NMB-003 édictée par le Ministère des Communications.
Warning
This is a class A product. In a domestic environment, this product may cause radio interference, in which case the user may be
required to take adequate measures.
FDA
This product complies with the DHHS Rules 21 CFR Subchapter J, Section 1040.10, applicable at date of manufacture.
Contents
About this Document
Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Technical Assistance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
Chapter 1 - Introduction
TL1 Interface Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Equipment and Termination Point Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Performance Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Security and Access Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1-2
1-2
1-2
1-3
1-3
1-4
TL1 Standards Compliancy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
TL1 Command Line Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
TL1 Command Line Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Command History Buffer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
TTY Emulation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Managed Entities and AID Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Managed Equipment Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Managed Termination Point Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Managed Service Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page ii
Contents
Chapter 2 - TL1 Message Overview
TL1 Message Conventions and Notations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
TL1 Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Input Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Grouping and Ranging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Command Acknowledgment Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Command Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Autonomous Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Error Code Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Chapter 3 - Establishing Connectivity
Network Element Accessibility Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Connecting to a Target Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to a Target Network Element through Craft Ethernet Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to a Target Network Element through Craft Serial Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modem Interface (Accessing Network Element via Modem). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting to a Target Network Element through DCN Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing TL1 Element through DCN Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-3
3-3
3-5
3-6
3-7
3-7
Starting TL1 Session for GNE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching a TL1 Session using Telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching TL1 Session through MPower EMS Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching TL1 Session through Graphical Node Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-8
3-8
3-9
3-9
Starting TL1 Session for SNE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching a TL1 Session using Telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching TL1 Session through MPower EMS Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching TL1 Session through Graphical Node Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3-10
3-10
3-11
3-12
Chapter 4 - Fault Management
Alarm Surveillance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Alarm Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4-2
4-2
4-3
4-4
Autonomous Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Synchronous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Autonomous Message Filtering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Alarm Severity Assignment Profile (ASAP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Alarm Reporting Control (ARC). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
Chapter 5 - Equipment and Facility Management
Configuring Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Configuring Circuit Pack and Termination Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
TL1 User Guide
Release 1.2
UTStarcom Inc.
Contents
Page iii
Auto-configuring Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
Pre-configuring Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
Equipment State Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Configuring BMM Circuit Pack and Termination Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Configuring DLM Circuit Pack and Termination Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57
Configuring TAM Circuit Pack and Termination Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62
Configuring TOM Circuit Pack and Termination Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63
Configuring MCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-97
Configuring OAM Circuit Pack and Termination Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-99
Configuring OMM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-100
Configuring Network Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-101
Configuring Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-101
Configuring Static Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-102
Chapter 6 - Service Provisioning
Manual Cross-connect Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Dynamically Signaled SNC Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Chapter 7 - Performance Management
PM Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
PM Data Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
PM and Threshold Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Threshold Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Chapter 8 - Security and Access Management
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
User Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Feature Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Access Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Password Aging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Audit Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Managing Security Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8-3
8-3
8-4
8-6
8-7
8-8
8-8
TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Creating Users on Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18
Chapter 9 - Software Maintenance
Software Maintenance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Software Maintenance Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Software Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UTStarcom Inc.
TL1 User Guide
9-23
9-23
9-24
9-24
9-24
Release 1.2
Page iv
Contents
Software Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-25
Chapter 10 - Environmental Alarms and Control
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Chapter 11 - Diagnostics
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Intrusive Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Non-Intrusive Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2
Loopbacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Setting loopbacks on a circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-3
Trace Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
J0 Trace Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTF Section Trace Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DTF Path Trace Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11-14
11-14
11-15
11-16
PRBS Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-25
DTF Section-level PRBS Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-25
DTF Path-level PRBS Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-26
TL1 User Guide
Release 1.2
UTStarcom Inc.
Figures
Figure 1-1
Figure 3-1
Figure 3-2
Figure 3-3
Figure 6-1
Figure 6-2
Figure 6-3
UTStarcom Inc.
Managed Equipment Entities for Digital Transport Chassis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
TL1 Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Local Area Connection Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
TCP/IP Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Pass-thru (Line to Line) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Add/Drop (Line to Trib) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Hairpin (Trib to Trib). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
TL1 User Guide
Release 1.2
Page vi
TL1 User Guide
Figures
Release 1.2
UTStarcom Inc.
Tables
Table 1-1
Table 1-2
Table 1-3
Table 2-1
Table 2-2
Table 2-3
Table 2-4
Table 2-5
Table 2-6
Table 4-1
Table 4-2
Table 4-3
Table 4-4
Table 4-5
Table 4-6
Table 4-7
Table 4-8
Table 4-9
Table 4-10
Table 4-11
Table 4-12
Table 4-13
Table 4-14
Table 4-15
Table 4-16
Table 4-17
UTStarcom Inc.
TL1 Command Line Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Valid Equipment AIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
Termination Point AIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
TL1 Command/Response Conventions and Notations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Input Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Command Acknowledgement Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
Command Response Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Autonomous Messages parameter description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Error Code Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
Message Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Secondary Modifiers for Autonomous and Synchronous Messages . . . . . . . . . . . . . . . . . . . . . 4-5
REPT^ALM Message Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
REPT^EVT Message Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9
REPT^DBCHG Message Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
RTRV-ALM Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
RTRV-ALM Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
RTRV-ALM Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
RTRV-COND-ALL Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
RTRV-COND-ALL Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
RTRV-COND-ALL Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
RTRV-AO Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
RTRV-AO Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
RTRV-AO Response Parameters Description when MSGTYPE=AUDIT . . . . . . . . . . . . . . . . . 4-24
INH-MSG-ALL Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
ALW-MSG-ALL Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
RTRV-MSG-ALL Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
TL1 User Guide
Release 1.2
Page viii
Tables
Table 4-18
Table 4-19
Table 4-20
Table 4-21
Table 4-22
Table 4-23
Table 4-24
Table 4-25
Table 4-26
Table 4-27
Table 4-28
Table 4-29
Table 4-31
Table 4-30
Table 5-1
Table 5-2
Table 5-3
Table 5-4
Table 5-5
Table 5-6
Table 5-7
Table 5-8
Table 5-9
Table 5-10
Table 5-11
Table 5-12
Table 5-13
Table 5-14
Table 5-15
Table 5-16
Table 5-17
Table 5-18
Table 5-19
Table 5-20
Table 5-21
Table 5-22
Table 5-23
Table 5-24
Table 5-25
Table 5-26
Table 5-27
Table 5-28
Table 5-29
Table 5-30
AID Types supported for ASAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
SET-ATTR Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
SET-ATTR Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
RTRV-ATTR Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
RTRV-ATTR Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35
RTRV-ATTR Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35
AID Types supported for ARC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
OPR-ARC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
OPR-ARC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38
RLS-ARC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
RLS-ARC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-41
RTRV-ARC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
RTRV-ARC Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
RTRV-ARC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
ED-SYS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
ED-SYS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
SET-SID Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
SET-SID Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
ED-DAT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
ED-DAT Command Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
RTRV-SYS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
RTRV-SYS Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
RTRV-HDR Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
ED-NTP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
ED-NTP Command Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
RTRV-NTP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
RTRV-NTP Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Equipment Auto-configuration and Pre-configuration Capabilities . . . . . . . . . . . . . . . . . . . . . . 5-19
TL1 Primary States and Primary State Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
TL1 Secondary States and Secondary State Qualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
ENT-EQPT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-21
ENT-EQPT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
List of Allowed Provisioned Equipment Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
ED-EQPT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25
ED-EQPT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-26
DLT EQPT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
DLT EQPT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
RTRV-EQPT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
RTRV EQPT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
RTRV-EQPT Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
Create BMM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Delete BMM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-36
ED-OTS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
ED-OTS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
TL1 User Guide
Release 1.2
UTStarcom Inc.
Tables
Table 5-31
Table 5-32
Table 5-33
Table 5-34
Table 5-35
Table 5-36
Table 5-37
Table 5-38
Table 5-39
Table 5-40
Table 5-41
Table 5-42
Table 5-43
Table 5-44
Table 5-45
Table 5-46
Table 5-47
Table 5-48
Table 5-49
Table 5-50
Table 5-51
Table 5-52
Table 5-53
Table 5-54
Table 5-55
Table 5-56
Table 5-57
Table 5-58
Table 5-59
Table 5-60
Table 5-61
Table 5-62
Table 5-63
Table 5-64
Table 5-65
Table 5-66
Table 5-67
Table 5-68
Table 5-69
Table 5-70
Table 5-71
Table 5-72
Table 5-73
Table 5-74
UTStarcom Inc.
Page ix
ED-OSC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OSC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OCG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OCG Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-BAND Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-BAND Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-DCF Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-DCF Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OTS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OTS Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OSC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OSC Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OCG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OCG Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-BAND Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-BAND Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-DCF Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-DCF Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create DLM Circuit Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delete DLM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OCH Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OCH Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OCH Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTRV-OCH Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create TAM Circuit Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delete TAM Circuit Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create TOM Circuit Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delete TOM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-TRIB Command Usage Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-STM16 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-STM16 Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-STM64 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-STM64 Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-1GbE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-1GbE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-10GbE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-10GbE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OC192 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OC192 Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OC48 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-OC48 Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-10GCC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ED-10GCC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TL1 User Guide
5-39
5-39
5-41
5-41
5-43
5-43
5-45
5-45
5-47
5-47
5-49
5-49
5-51
5-51
5-53
5-53
5-55
5-55
5-57
5-57
5-58
5-58
5-60
5-60
5-62
5-62
5-63
5-64
5-65
5-66
5-67
5-67
5-69
5-69
5-71
5-71
5-73
5-73
5-75
5-75
5-77
5-77
5-79
5-80
Release 1.2
Page x
Tables
Table 5-75
Table 5-76
Table 5-77
Table 5-78
Table 5-79
Table 5-80
Table 5-81
Table 5-82
Table 5-83
Table 5-84
Table 5-85
Table 5-86
Table 5-87
Table 5-88
Table 5-89
Table 5-90
Table 5-91
Table 5-92
Table 5-93
Table 5-94
Table 5-95
Table 5-96
Table 5-97
Table 5-98
Table 5-99
Table 5-100
Table 5-101
Table 5-102
Table 5-103
Table 5-104
Table 5-105
Table 5-106
Table 5-107
Table 5-108
Table 5-109
Table 5-110
Table 5-112
Table 5-113
Table 5-114
Table 5-115
Table 5-116
Table 5-117
Table 5-118
Table 5-119
RTRV-10GCC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
RTRV-10GCC Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81
RTRV-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83
RTRV-TRIB Response Paramaters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83
RTRV-STM16 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-85
RTRV-STM16 Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-85
RTRV-STM64 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-87
RTRV-STM64 Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-87
RTRV-1GbE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-89
RTRV-1GbE Response Description Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-89
RTRV-10GbE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-91
RTRV-10GbE Response Description Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-91
RTRV-OC192 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-93
RTRV-OC192 Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-93
RTRV-OC48 Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95
RTRV-OC48 Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95
Create MCM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-97
Delete MCM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-98
Create OAM Circuit Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-99
Delete OAM Circuit Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-99
Create OMM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-100
Delete OMM circuit pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-100
RTRV-TOPONODE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-104
RTRV-TOPONODE Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-104
RTRV-TIDMAP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-106
RTRV-TIDMAP Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-106
RTRV-CTRLINK Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-108
RTRV-CTRLINK Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-108
RTRV-TELINK Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-110
RTRV-TELINK Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-110
ENT-SROUTE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-112
ENT-SROUTE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-112
DLT-SROUTE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-114
DLT-SROUTE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-114
RTRV-SROUTE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-116
RTRV-SROUTE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-116
OPR-AUTOD Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-118
OPR-AUTOD Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-118
OPR-MKSTBY Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-120
OPR-MKSTBY Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-121
OPR-PROTNSW-EQPT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-122
OPR-PROTNSW-EQPT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . 5-123
ED-NCT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-124
ED-NCT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-124
TL1 User Guide
Release 1.2
UTStarcom Inc.
Tables
Table 5-120
Table 5-122
Table 5-123
Table 5-124
Table 5-125
Table 5-126
Table 5-127
Table 5-129
Table 5-130
Table 5-131
Table 5-132
Table 5-133
Table 5-134
Table 6-1
Table 6-2
Table 6-3
Table 6-4
Table 6-5
Table 6-6
Table 6-7
Table 6-8
Table 6-9
Table 6-10
Table 6-11
Table 6-12
Table 6-13
Table 6-14
Table 6-15
Table 6-16
Table 6-17
Table 6-18
Table 6-19
Table 6-20
Table 6-21
Table 6-22
Table 6-23
Table 6-24
Table 6-25
Table 6-26
Table 6-28
Table 6-27
Table 6-29
Table 6-30
Table 6-31
UTStarcom Inc.
Page xi
RTRV-NCT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-126
ENT-FFP-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-128
ENT-FFP-TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-129
ED-FFP-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-130
ED-FFP-TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-130
RTRV-FFP-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-132
RTRV-FFP-TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-132
DLT-FFP-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-134
DLT-FFP TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-134
OPR-PROTNSW-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-136
OPR-PROTNSW-TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . 5-136
RLS-PROTNSW-TRIB Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-138
RLS-PROTNSW-TRIB Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . 5-138
Valid end point combinations for manual cross-connects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
ENT-CRS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
ENT-CRS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
ED-CRS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
ED-CRS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
DLT-CRS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
DLT-CRS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
DLT-CRS-SIG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
DLT-CRS-SIG Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
RTRV-CRS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
RTRV-CRS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
RTRV-CRS Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
ED-DTPCTP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
ED-DTPCTP Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
RTRV-DTPCTP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
RTRV-DTPCTP Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
ENT-SNC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-21
ENT-SNC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-22
ED-SNC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
ED-SNC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
RTRV-SNC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
RTRV-SNC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
RTRV-SNC Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28
DLT-SNC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
DLT-SNC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
RTRV-PATH-SNC Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
RTRV-PATH-SNC Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33
RTRV-PATH-SNC Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33
RTRV-ROUTE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35
RTRV-ROUTE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-36
RTRV-ROUTE Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-37
TL1 User Guide
Release 1.2
Page xii
Tables
Table 7-1
Table 7-2
Table 7-3
Table 7-4
Table 7-5
Table 7-6
Table 7-7
Table 7-8
Table 7-9
Table 7-10
Table 7-11
Table 7-12
Table 7-13
Table 8-1
Table 8-2
Table 8-3
Table 8-4
Table 8-5
Table 8-6
Table 8-7
Table 8-8
Table 8-9
Table 8-10
Table 8-11
Table 8-12
Table 8-13
Table 8-14
Table 8-15
Table 8-16
Table 8-17
Table 8-18
Table 8-19
Table 8-20
Table 8-21
Table 8-22
Table 8-23
Table 8-24
Table 8-25
Table 8-26
Table 8-27
Table 8-28
Table 8-29
Table 8-30
Table 8-31
PM Features and Associated TL1 Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Performance Monitoring Data for Various Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
INIT-REG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
INIT-REG Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
RTRV-PM Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
RTRV-PM Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
RTRV-PM Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
SET-TH Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
SET-TH Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
RTRV-TH Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
RTRV-TH Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
RTRV-TH Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
Security Features and Related TL1 commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
User Access Privilege Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
User ID and Password format rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7
ACT-USER Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10
ACT-USER Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11
CANC-USER Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
CANC-USER Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12
CANC-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
CANC-USER-SECU Command Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14
ENT-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
ENT-USER-SECU Command Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16
ED-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
ED-USER-SECU Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19
DLT-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
DLT-USER-SECU Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
RTRV-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
RTRV-USER-SECU Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
RTRV-USER-SECU Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25
INH-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
INH-USER-SECU Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26
ALW-USER-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
ALW-USER-SECU Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
ED-PID Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-30
ED-PID Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-30
SET-ATTR-SECULOG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33
SET-ATTR-SECULOG Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33
SET-ATTR-SECUDFLT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-34
SET-ATTR-SECUDFLT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . 8-34
RTRV-DFLT-SECU Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-38
RTRV-DFLT-SECU Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-38
RTRV-AUDIT-SECULOG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-40
TL1 User Guide
Release 1.2
UTStarcom Inc.
Tables
Table 8-32
Table 8-33
Table 8-34
Table 8-35
Table 8-36
Table 8-37
Table 9-1
Table 9-2
Table 9-3
Table 9-4
Table 9-5
Table 9-6
Table 9-7
Table 9-8
Table 9-9
Table 9-10
Table 9-11
Table 9-12
Table 9-13
Table 9-14
Table 9-15
Table 9-16
Table 9-17
Table 9-18
Table 9-19
Table 9-20
Table 9-21
Table 9-22
Table 9-23
Table 9-24
Table 9-25
Table 9-26
Table 9-27
Table 10-1
Table 10-2
Table 10-3
Table 10-4
Table 10-5
Table 10-6
Table 10-7
Table 10-8
Table 10-10
Table 10-11
Table 10-12
UTStarcom Inc.
Page xiii
RTRV-AUDIT-SECULOG Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . 8-41
RTRV-ATTR-SECULOG Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-43
RTRV-ATTR-SECULOG Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . 8-43
RTRV-STATUS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
RTRV-STATUS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
RTRV-STATUS Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-45
COPY-RFILE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
COPY-RFILE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
RTRV-RFILE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7
RTRV-RFILE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
RTRV-RFILE Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8
DLT-RFILE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
DLT-RFILE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
COMP-RFILE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
COMP-RFILE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
APPLY Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15
APPLY Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15
REPT^EVT^FXFR Message Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17
CPY-MEM Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19
CPY-MEM Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19
RTRV^EVT^COM Message Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23
SCHED-BKUP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26
SCHED-BKUP Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26
RTRV-BKUPSCHED Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
RTRV-BKUPSCHED Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
REPT^BKUP Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
REPT^BKUP Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
ED-FXFR Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32
ED-FXFR Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32
RTRV-FXFR Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-34
RTRV-FXFR Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-34
RTRV-FXFR Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-36
REPT^ALM^ENV Message Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
RTRV-ALM-ENV Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
RTRV-ALM-ENV Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
RTRV-ALM-ENV Response Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
SET-ATTR-ENV Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
SET-ATTR-ENV Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
RTRV-ATTR-ENV Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
RTRV-ATTR-ENV Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
OPR-EXT-CONT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
OPR-EXT-CONT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
List of Standard Control Types for Telemetry Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
TL1 User Guide
Release 1.2
Page xiv
Tables
Table 10-13
Table 10-14
Table 10-15
Table 10-16
Table 10-17
Table 10-19
Table 10-20
Table 11-1
Table 11-2
Table 11-3
Table 11-4
Table 11-5
Table 11-6
Table 11-7
Table 11-8
Table 11-9
Table 11-10
Table 11-11
Table 11-12
Table 11-13
Table 11-14
Table 11-15
Table 11-16
Table 11-17
Table 11-18
Table 11-19
Table 11-20
Table 11-21
Table 11-22
Table 11-23
Table 11-24
RLS-EXT-CONT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14
RLS-EXT-CONT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14
SET-ATTR-CONT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16
SET-ATTR-CONT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16
RTRV-ATTR-CONT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18
OPR-ACO-EQPT Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21
OPR-ACO-EQPT Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21
RMV Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
RMV Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-4
OPR-LPBK Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
OPR-LPBK Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6
RLS-LPBK Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
RLS-LPBK Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
RST Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-10
RST Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
INIT-SYS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
INIT-SYS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13
J0 Trace Messaging Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-14
DTF Section Trace Messaging Command Parameters Description . . . . . . . . . . . . . . . . . . . . 11-15
DTF Path Trace Messaging Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . 11-16
RTRV-TRACEROUTE Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
RTRV-TRACEROUTE Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . 11-17
RTRV-PING Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
RTRV-PING Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-19
RTRV-LASTLSATEACTVITYTIME Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-21
RTRV-LASTLSATEACTVITYTIME Command Parameters Description . . . . . . . . . . . . . . . . . 11-21
RTRV-LASTLSATEACTVITYTIME Response Parameter Description . . . . . . . . . . . . . . . . . . 11-21
ED-TL1-DEFAULTS Command Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-23
ED-TL1-DEFAULTS Command Parameters Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-23
DTF Section-Level PRBS Test Command Parameter Description . . . . . . . . . . . . . . . . . . . . . 11-26
DTF Path-Level PRBS Test Command Parameter Description . . . . . . . . . . . . . . . . . . . . . . . 11-26
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Commands
ACT-USER (Activate-User) ...................................................................................................................................... 8-10
ALW-MSG-ALL (Allow-Message)............................................................................................................................. 4-28
ALW-USER-SECU (Allow-User) .............................................................................................................................. 8-28
APPLY...................................................................................................................................................................... 9-15
CANCEL Session (Time-out) ................................................................................................................................... 8-36
CANC-USER (Cancel-User)..................................................................................................................................... 8-12
CANC-USER-SECU (Cancel-User-Security) ........................................................................................................... 8-14
COMP-RFILE (Compress File)................................................................................................................................. 9-13
COPY-RFILE (Copy File) ........................................................................................................................................... 9-3
CPY-MEM ................................................................................................................................................................ 9-19
DLT-CRS (Delete-Cross-Connect)............................................................................................................................. 6-9
DLT-CRS-SIG (Delete-Cross-Signaled)................................................................................................................... 6-11
DLT-EQPT (Delete-Equipment) ............................................................................................................................... 5-28
DLT-FFP-TRIB ....................................................................................................................................................... 5-134
DLT-RFILE (Delete File)........................................................................................................................................... 9-11
DLT-SNC (Delete-Circuit)......................................................................................................................................... 6-30
DLT-SROUTE (Delete-Static Route)...................................................................................................................... 5-114
DLT-USER-SECU (Delete-User-Security) ............................................................................................................... 8-22
ED-10GbE (Edit-10GbE) .......................................................................................................................................... 5-73
ED-10GCC (Edit-10G Clear Channel)...................................................................................................................... 5-79
ED-1GBE (Edit-1GBE) ............................................................................................................................................. 5-71
ED-BAND (Edit-Band) .............................................................................................................................................. 5-43
ED-CRS (Edit-Cross-connect).................................................................................................................................... 6-7
ED-DAT (Edit-Date and Time).................................................................................................................................... 5-8
ED-DCF (Edit-Dispersion Compensation Fiber)....................................................................................................... 5-45
ED-DTPCTP (Edit-DTPCTP).................................................................................................................................... 6-16
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page xvi
TL1 Commands
ED-EQPT (Edit-Equipment)......................................................................................................................................5-25
ED-FFP-TRIB .........................................................................................................................................................5-130
ED-FXFR (Edit File Transfer Object) ........................................................................................................................9-32
ED-NCT (Nodal Control and Timing) ......................................................................................................................5-124
ED-NTP (Edit-Network Timing Protocol) ..................................................................................................................5-14
ED-OC192 (Edit-OC192) ..........................................................................................................................................5-75
ED-OC48 (Edit-OC48) ..............................................................................................................................................5-77
ED-OCG (Edit-Optical Carrier Group) ......................................................................................................................5-41
ED-OCH (Edit-Optical Channel) ...............................................................................................................................5-58
ED-OSC (Edit-Optical Supervisory Channel) ...........................................................................................................5-39
ED-OTS (Edit-Optical Transport Section).................................................................................................................5-37
ED-PID (Edit-Password ID) ......................................................................................................................................8-30
ED-SNC (Modify-Circuit)...........................................................................................................................................6-24
ED-STM16 (Edit-STM16)..........................................................................................................................................5-67
ED-STM64 (Edit-STM64)..........................................................................................................................................5-69
ED-SYS (Edit-System)................................................................................................................................................5-3
ED-TL1-DEFAULTS ...............................................................................................................................................11-23
ED-TRIB (Edit-TRIB) ................................................................................................................................................5-65
ED-USER-SECU (Edit-User-Security)......................................................................................................................8-19
ENT-CRS (Enter-Cross-connect) ...............................................................................................................................6-5
ENT-EQPT (Enter-Equipment) .................................................................................................................................5-21
ENT-FFP-TRIB .......................................................................................................................................................5-128
ENT-SNC (Enter-Circuit) ..........................................................................................................................................6-21
ENT-SROUTE (Enter-Static Route)........................................................................................................................5-112
ENT-USER-SECU (Enter-User-Security) .................................................................................................................8-16
INH-MSG-ALL (Inhibit-Message)..............................................................................................................................4-27
INH-USER-SECU (Inhibit-User) ...............................................................................................................................8-26
INIT-REG (Initialize-Register) ...................................................................................................................................7-10
INIT-SYS (Initialize System) ...................................................................................................................................11-12
OPR-ACO-EQPT (Operate-Alarm Cutoff) ..............................................................................................................10-21
OPR-ARC (Inhibit Reporting Alarms/Events) ...........................................................................................................4-38
OPR-AUTOD (Operate AutoDiscovery)..................................................................................................................5-118
OPR-EXT-CONT (Operate-External-Control).........................................................................................................10-12
OPR-LPBK (Operate-Loopback) ..............................................................................................................................11-6
OPR-MKSTBY ........................................................................................................................................................5-120
OPR-PROTNSW-EQPT (Protection Switch) ..........................................................................................................5-122
OPR-PROTNSW-TRIB ...........................................................................................................................................5-136
REPT^ALM (Report Alarm) ........................................................................................................................................4-6
REPT^ALM^ENV (Report-Alarm) .............................................................................................................................10-3
REPT^ALM^SECU (Report-Security-Alarms)...........................................................................................................8-37
REPT^BKUP (Report Backup) .................................................................................................................................9-31
REPT^DBCHG (Report Database Change) .............................................................................................................4-11
REPT^EVT(Report Event) ..........................................................................................................................................4-9
REPT^EVT^FXFR (Report Event FileTransfer)........................................................................................................9-17
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Commands
Page xvii
REPT^EVT^SESSION (Report-Event-Session) .......................................................................................................8-32
RLS-ARC (Release-Alarm Reporting Control)..........................................................................................................4-40
RLS-EXT-CONT (Release-External-Control) .........................................................................................................10-14
RLS-LPBK (Release-Loopback) ...............................................................................................................................11-8
RLS-PROTNSW-TRIB............................................................................................................................................5-138
RMV (Remove-AIDType)..........................................................................................................................................11-4
RST (Restore Facility) ............................................................................................................................................11-10
RTRV^EVT^COM .....................................................................................................................................................9-21
RTRV-10GbE (Retrieve-10GbE) ..............................................................................................................................5-91
RTRV-10GCC (Retrieve-10GCC).............................................................................................................................5-81
RTRV-1GBE (Retrieve-1GBE)..................................................................................................................................5-89
RTRV-ALM (Retrieve Alarm) ....................................................................................................................................4-15
RTRV-ALM-ENV (Retrieve-Environmental-Alarm) ...................................................................................................10-5
RTRV-AO (Retrieve-Autonomous Output)................................................................................................................4-21
RTRV-ARC (Retrieve-Alarm Reporting Control).......................................................................................................4-42
RTRV-ATTR (Retrieve-Attributes) ............................................................................................................................4-34
RTRV-ATTR-CONT (Retrieve-Control-Attributes) ..................................................................................................10-18
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes) ...........................................................................................10-9
RTRV-ATTR-SECULOG (Retrieve-Attributes) .........................................................................................................8-43
RTRV-AUDIT-SECULOG (Retrieve-Audit-Security-Logs)........................................................................................8-40
RTRV-BAND (Retrieve-Band) ..................................................................................................................................5-53
RTRV-BKUPSCHED (Retrieve Backup Schedule)...................................................................................................9-29
RTRV-COND-ALL (Retrieve-Condition) ...................................................................................................................4-18
RTRV-CRS (Retrieve-Cross Connect) .....................................................................................................................6-13
RTRV-CTRLINK (Retrieve-Control Link) ................................................................................................................5-108
RTRV-DCF (Retrieve-Dispersion Compensation Fiber) ...........................................................................................5-55
RTRV-DFLT-SECU (Retrieve-Default Security Attributes) .......................................................................................8-38
RTRV-DTPCTP (Retrieve-DTPCTP) ........................................................................................................................6-18
RTRV-EQPT (Retrieve-Equipment)..........................................................................................................................5-30
RTRV-FFP-TRIB.....................................................................................................................................................5-132
RTRV-FXFR (Retrieve File Transfer Object) ............................................................................................................9-34
RTRV-HDR (Retrieve-Header) .................................................................................................................................5-13
RTRV-LASTLSATEACTVITYTIME.........................................................................................................................11-21
RTRV-MSG-ALL .......................................................................................................................................................4-29
RTRV-NCT (Nodal Control and Timing) .................................................................................................................5-126
RTRV-NTP (Retrieve-NTP) ......................................................................................................................................5-16
RTRV-OC192 (Retrieve-OC192) ..............................................................................................................................5-93
RTRV-OC48 (Retrieve-OC48) ..................................................................................................................................5-95
RTRV-OCG (Retrieve-Optical Carrier Group) ..........................................................................................................5-51
RTRV-OCH (Retrieve-Optical Channel) ...................................................................................................................5-60
RTRV-OSC (Retrieve-Optical Supervisory Channel) ...............................................................................................5-49
RTRV-OTS (Retrieve-Optical Transport Section).....................................................................................................5-47
RTRV-PATH-SNC ....................................................................................................................................................6-32
RTRV-PING ............................................................................................................................................................11-19
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page xviii
TL1 Commands
RTRV-PM (Retrieve-PM) ..........................................................................................................................................7-12
RTRV-RFILE (Retrieve File) .......................................................................................................................................9-7
RTRV-ROUTE ..........................................................................................................................................................6-35
RTRV-SNC (Retrieve-Circuit) ...................................................................................................................................6-27
RTRV-SROUTE (Retrieve-Static Route) ................................................................................................................5-116
RTRV-STATUS (Retrieve Status).............................................................................................................................8-45
RTRV-STM16 (Retrieve-STM16)..............................................................................................................................5-85
RTRV-STM64 (Retrieve-STM64)..............................................................................................................................5-87
RTRV-SYS (Retrieve-System)..................................................................................................................................5-10
RTRV-TELINK (Retrieve TE Link) ..........................................................................................................................5-110
RTRV-TH (Retrieve-Threshold value) ......................................................................................................................7-19
RTRV-TIDMAP (Retrieve-TIDMAP)........................................................................................................................5-106
RTRV-TOPONODE (Retrieve-Toponode) ..............................................................................................................5-104
RTRV-TRACEROUTE ............................................................................................................................................11-17
RTRV-TRIB (Retrieve-TRIB) ....................................................................................................................................5-83
RTRV-USER-SECU (Retrieve-User-Security)..........................................................................................................8-24
SCHED-BKUP (Schedule Backup)...........................................................................................................................9-26
SET-ATTR (Set-Attributes) .......................................................................................................................................4-31
SET-ATTR-CONT (Set-Control-Attributes).............................................................................................................10-16
SET-ATTR-ENV (Set-Environmental-Attributes) ......................................................................................................10-7
SET-ATTR-SECUDFLT (Set-Default Security Attributes) ........................................................................................8-34
SET-ATTR-SECULOG (Set-Attributes) ....................................................................................................................8-33
SET-SID (Set Source Identifier)..................................................................................................................................5-6
SET-TH (Set-Threshold value) .................................................................................................................................7-17
TL1 User Guide
Release 1.2
UTStarcom Inc.
About this Document
This chapter describes the purpose of the UTStarcom TL1 User Guide in the following sections:
“Objective” on page xix
“Audience” on page xix
“Document Organization” on page xx
“Conventions” on page xxi
“Technical Assistance” on page xxii
Objective
This guide describes the TL1 interface overview, message overview, establishing connectivity, fault
management, configuration of various equipment types, facilities, provisioning services such as crossconnect, sub-network connections, performance monitoring and security management using TL1
commands. It also details the software maintenance, diagnostics and troubleshooting the TL1 interface.
Audience
The primary audience for this Guide includes network operations personnel and system administrators
who are responsible for the managing the network elements through the TL1 interface. This Guide
assumes that the reader is familiar with the following topics and products:
Basic internetworking terminology and concepts
Network topology and protocols
UTStarcom Digital Optical Networking systems
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page xx
About this Document
Document Organization
The following table describes each chapter in this guide..
Chapter number and Name
Description
CHAPTER 1: “Introduction“
This chapter provides an introduction to the TL1 interface. It
includes the description of TL1 standards compliancy, command line editor, TTY emulation modes and managed entities.
CHAPTER 2: “TL1 Message Overview“
This chapter describes TL1 message conventions and notations, input command format, command acknowledgement and
response format, autonomous message format and error
codes.
CHAPTER 3: “Establishing Connectivity“
This chapter describes the procedure to connect the TL1 terminal to a target network element through Craft Ethernet Port,
Craft Serial Port, Modem Interface and DCN Interface.
CHAPTER 4: “Fault Management“
This chapter describes fault management capabilities through
alarm surveillance, autonomous messages, synchronous messages, autonomous message filtering, Alarm Severity Assignment Profile and Alarm Reporting Control.
CHAPTER 5: “Equipment and Facility
Management“
This chapter describes TL1 commands used for equipment
inventory and management, network element configuration and
network topology.
CHAPTER 6: “Service Provisioning“
This chapter describes provisioning of services such as cross
connection and dynamically signaled SNC provisioning managed by the network elements.
CHAPTER 7: “Performance Management“
This chapter describes Performance Monitoring features, data
definitions and threshold configuration.
CHAPTER 8: “Security and Access
Management“
This chapter describes TL1 commands related to Security
Administration and provisioning.
CHAPTER 9: “Software Maintenance“
This chapter describes TL1 commands related to software
download, network element database upgrade, back-up and
restore operations and software downgrade.
CHAPTER 10: “Environmental Alarms
and Control“
This chapter describes the alarms that are triggered under
abnormal conditions caused due to environmental changes
affecting the network element.
CHAPTER 11: “Diagnostics“
This chapter describes TL1 commands related to diagnostics.
Appendix A: “Acronyms“
Provides a list of acronyms and their definitions used in
UTStarcom Technical Publications.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Related Documents
Page xxi
Related Documents
The following documents can be used as reference for further understanding of the contents of this guide.
Document Name
UTStarcom TN780
System Description
Document Order
Number
TN780-SDG-1.2-A
Description
Provides an introduction and reference to Digital Optical
Networking Systems, which include UTStarcom® TN780
(referred to as the TN780) and UTStarcom Optical Line
Amplifier (referred to as the Optical Line Amplifier) used to
build the Digital Optical Networks®. It also includes the
UTStarcom IQ Network Operating System (referred to as
the IQ) operating TN780 and Optical Line Amplifier network elements, and UTStarcom MPower Management
Suite (referred to as the MPower) provided to manage
UTStarcom products.
Conventions
This Guide uses the following conventions:
Convention
bold default font
courier font
default font, italic
Item
Example
Menu command paths
Select Fault Management->
Alarm Manager
Button names
Click Apply
User interface labels
Click Summary panel
Window/dialog box titles
In the Dial-Up Networking window
User-entered text
In the Label enter EastBMM
Command output
Database restore from local or
remote machine?
Directory path
/MPower/EMS
Document titles
Refer to the UTStarcom TN780
System Description
Note:
UTStarcom Inc.
Helpful suggestions
Note: The window is
refreshed only
after making
all the
changes.
TL1 User Guide
Release 1.2
Page xxii
About this Document
Technical Assistance
Customer support for UTStarcom products is available 24 hours a day, seven days a week. For information
or assistance with any UTStarcom product, please contact an UTStarcom Customer Service and Technical
Support resource using any of the methods listed below.
UTStarcom China
Telephone: 86-10-85205588
Fax: 86-10-85205599
UTStarcom USA
Telephone: 1-510-864-8800
Fax: 1-510-864-8802
UTStarcom corporate website: www.utstarcom.com
TL1 User Guide
Release 1.2
UTStarcom Inc.
CHAPTER 1
Introduction
This chapter provides an introduction to the TL1 Interface. It includes the following sections:
“TL1 Interface Overview” on page 1-2
“TL1 Standards Compliancy” on page 1-5
“TL1 Command Line Editor” on page 1-6
“TTY Emulation Modes” on page 1-7
“Managed Entities and AID Overview” on page 1-8
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 1-2
TL1 Interface Overview
TL1 Interface Overview
Transaction Language 1 (TL1) is an industry-recognized common language protocol for messages
exchanged between network elements and an Operations System (OS). The TL1 Interface uses the
common language protocol to eliminate the need to support vendor-specific interfaces.
The TL1 Interface on the network element allows operations system to perform the following functions:
Fault Management
Equipment Configuration
Service Provisioning
Performance Monitoring
Security Administration
Fault Management
The Digital Optical Network provides fault monitoring and management capabilities modeled after
Telcordia and ITU standards. These capabilities provide real-time information on the status of all the
managed equipment. The fault management capabilities comply with GR-474 requirements.
The fault management function includes a standards-based alarm table that tracks outstanding alarm
conditions within the target network element. It also provides a wrap-around historical event log that tracks
all changes that occur within the target network element including user-initiated state and attribute change
events. For more information, refer to the UTStarcom TN780 System Description.
The TL1 Interface supports autonomous alarm notifications for the outstanding alarm conditions and also
synchronous alarm and event retrieval. Refer to “Fault Management” on page 4-1.
Equipment and Termination Point Management
The Digital Optical Network offers equipment configuration capabilities that enable users to configure and
monitor the state of circuit packs and termination points. To ease deployment and to meet diverse
customer needs, the system supports two modes of equipment configuration:
Auto-configuration - In this mode, the network element automatically detects and configures the
hardware modules when it is present.
Pre-configuration - In this mode, users can pre-configure the attributes associated with the hardware
modules, prior to the module being present.
In both cases, termination points are automatically created after the equipment is configured.
The UTStarcom TL1 Interface allow users with appropriate access privileges to create, modify, and delete
the equipment’s configuration. For functional description of the various equipment types, refer to the
UTStarcom TN780 System Description. For a list of hardware modules that are manageable through
TL1 User Guide
Release 1.2
UTStarcom Inc.
Introduction
Page 1-3
UTStarcom TL1 Interface and their corresponding Access Identifiers (AIDs), refer to “Managed Entities
and AID Overview” on page 1-8.
Service Provisioning
The Digital Optical Network features service provisioning capabilities that allow users to establish the data
path for user traffic transport. To ease provisioning and to meet diverse customer needs, the system
supports two modes of service provisioning:
Manual Cross-connect Provisioning - In this mode, users manually provision the individual crossconnects in each network element along the circuit’s route. This mode is recommended for users
who need full control over cross-connects and who have external tools to perform route computations. Manual cross-connect provisioning is possible at each TN780 Digital Node (henceforth
referred to as TN780), where digital access to each optical wavelength is provided.
Dynamically Signaled Subnetwork Connection (SNC) Provisioning - In this mode, the user
specifies the circuit’s end points and the system automatically provisions the cross-connects in the
intermediate network elements using robust Generalized Multi Protocol Label Switching (GMPLS)
signaling and routing protocols. Cross-connects are not only done at intermediate points, but at the
endpoints of the circuit also. This mode greatly simplifies provisioning.
Refer to UTStarcom TN780 System Description manual for more information on service provisioning.
The TL1 Interface supports both modes of service provisioning. Refer to “Service Provisioning” on page 61 for information on TL1 commands.
Performance Management
The Digital Optical Network provides extensive digital and analog performance monitoring (PM) and
flexible performance parameter management. These features can help reduce overall operational costs
associated with fault isolation and troubleshooting in the transport domain.
The System provides an extensive collection of performance monitoring (PM) data to the user, including:
UTStarcom Digital Transport Frame (DTF) PM data for section and path layers at every TN780.
Optical PM data at every TN780 and Optical Line Amplifier.
Native SONET/SDH section layer PM data at tributary ports.
Forward Error Connection (FEC) PM data at every TN780. The FEC performance data can be used
to compute the effective BER on the channel along each Digital Link.
The performance management function provides access to the historical statistics of PM and also the realtime PM data for up-to-date observation to the users. It also provides the capability to reset PM counters
and set PM threshold values. For more information on performance management capabilities, refer to the
UTStarcom TN780 System Description.
The TL1 Interface supports all of the performance management capabilities mentioned above. Refer to
“Performance Management” on page 7-1 for description of TL1 commands.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 1-4
TL1 Interface Overview
Security and Access Management
The security administration capabilities of the Digital Optical Network are in compliance with the security
features specified by the GR-815-CORE standard. This includes support for multiple user access
privileges, the ability to create/delete/modify/retrieve user accounts, user ID and password authentication,
password aging, inactivity time-out and intrusion detection. For more information on security administration
functions supported by the UTStarcom Digital Optical Networking system, refer to the UTStarcom TN780
System Description manual.
The TL1 Interface supports all of the security administration features mentioned above. Refer to “Security
and Access Management” on page 8-1 for the description of TL1 commands.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Introduction
Page 1-5
TL1 Standards Compliancy
The UTStarcom TL1 Interface is compliant with the following Telcordia standards:
GR-831-CORE, Issue 1, November 1996, Operations Application Messages - Language for Operations Application Messages: All TL1 message specifications and grammar.
GR-833-CORE, Issue 4, June 2000 Network Maintenance - Network Element and Transport Surveillance Messages: TL1 surveillance messages.
GR–199–CORE, Issue 4, May 2001, OTGR: Operations Application Messages - Memory Administration Messages: TL1 provisioning messages for equipment, termination points and cross connections.
TR-NWT-00835, Issue 3, OTGR: Operations Application Messages - Network Element Security
Parameter Administration Messages: TL1 messages related to UTStarcom network element system
security.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 1-6
TL1 Command Line Editor
TL1 Command Line Editor
The TL1 Interface provides a user friendly Command Line Editor that eases the use of TL1 Interface. Some
of the features supported by TL1 Command Line Editor are described in the following sections.
TL1 Command Line Shortcuts
The UTStarcom TL1 Command Line Editor supports several shortcuts, shown in Table 1-1 on page 1-6.
To execute the shortcut action, enter the shortcut command at the command line prompt.
Table 1-1 TL1 Command Line Shortcuts
Shortcut commands
Action
“Command <Tab> key”
Lists the command and the command syntax.
“<first letter of the command> <Tab key>”
Lists all the commands that matches with the first letter typed.
Command History Buffer
The TL1 Command Line Editor provides a history buffer that can store up to 40 previously executed
commands.
Note: The history buffer is associated with a given TL1 session. History information is lost once a
user logs out of TL1 session.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Introduction
Page 1-7
TTY Emulation Modes
The TL1 interface supports the following terminal emulation modes:
VT100
ANSI
Linux console
VT420pc
xterm
The TL1 interface does not support the customizing of terminal settings. Following are the default terminal
settings:
Character echo is always turned off
History buffer size is 40 commands
Column width is 80 characters
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 1-8
Managed Entities and AID Overview
Managed Entities and AID Overview
As described in “TL1 Interface Overview” on page 1-2, the UTStarcom TL1 Interface enables configuration
of equipment and provisioning of services associated with the equipment. The TL1 commands use access
identifiers (AIDs) to uniquely identify the managed entity, which could be an equipment or a facility. The
following sections list the entities that users can manage through the UTStarcom TL1 Interface and their
corresponding AIDs. Refer to Table 1-2 on page 1-9 for the description of the equipment AID format.
Table 1-3 on page 1-11 lists the termination points (TPs) and the format used to auto-generate their
corresponding AIDs during equipment configuration and service provisioning.
Managed Equipment Entities
The managed equipment entity refers to the Digital Optical Network hardware modules. Figure 1-1 on
page 1-8 shows the various equipment entities that may be managed through the UTStarcom TL1
Interface. For the functional description of each managed equipment entities, refer to the UTStarcom
TN780 System Description manual.
Figure 1-1 Managed Equipment Entities for Digital Transport Chassis
Cable
Management
for IOP
PEM A
IOP
Cable
Management
for IOP
PEM B
Fan Tray A
Cable
Management
for TAP
TAP
TAM Blanks
MCM
BMMs
TAMs
DLM Blanks
MCM Blank
DLMs
Fiber Bend
Radius Control
Fiber Guide
Fan Tray B
Air Filter
Air Inlet
Plenum
TL1 User Guide
Release 1.2
UTStarcom Inc.
Introduction
Page 1-9
Table 1-2 Valid Equipment AIDs
Equipment
Type
Equipment Description
AID Format
Valid Values
Chassis
Chassis of the network element
<Chassis>
<Chassis> = {1-6}
Service Shelf
Service Shelf present on
the chassis
<Chassis>-<ServiceShelf>
<Chassis> = {1-6}
Fan Shelf present on the
chassis
<Chassis>-<FanShelf>
IO Shelf present on the
chassis
<Chassis>-<IOShelf>
Power Entry Module
present on the IO Shelf of
the Chassis
<Chassis>-<IOShelf><PEMSlot>
Slots on IO Shelf and Service Shelf
<Chassis>-<ServiceShelf><Slot>
Fan Shelf
IO Shelf
PEM
Slot
<ServiceShelf> = {A,B}
<Chassis> = {1-6}
<FanShelf> = {FANA,
FANB}
<Chassis> = {1-6}
<IOShelf> = {IOShelf}
<Chassis> = {1-6}
<IOShelf> = {IOShelf}
<PEMSlot> = {PEMA,
PEMB}
<Chassis> = {1-6}
<ServiceShelf> = {A}
<Slot> = {1-6, 7A, 7B}
MCM
DLM
Management Control Module present on the Service
Shelf
<Chassis>-<ServiceShelf><MCMSlot>
<Chassis> = {1-6}
Digital Line Module present
on the Service Shelf
<Chassis>-<ServiceShelf><DLMSlot>
<Chassis> = {1-6}
Band Mux Module present
on the Service Shelf
<Chassis>-<ServiceShelf><BMMSlot>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<MCMSlot> = {7A, 7B}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
BMM
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
TAM
Tributary Adapter Module
on the DLM circuit pack
<Chassis>-<ServiceShelf><DLMSlot>-<TAMSlot>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {1-5}
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 1-10
Managed Entities and AID Overview
Table 1-2 Valid Equipment AIDs
Equipment
Type
TOM
Equipment Description
Tributary Optical Module
on the TAM circuit pack
AID Format
<Chassis>-<ServiceShelf><DLMSlot>-<TAMSlot><TOMSlot>
Valid Values
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {1-5}
<TOMSlot> = {1, 2, 3, 4}
where
TOM slots (1-2) used for
TAM-2-10G equipment type
TOM slots (1-4) used for
TAM-4-2.5G or TAM-4-1G
equipment types
OAM
Optical Amplifier Module
<Chassis>-<ServiceShelf><OAMSlot>
<Chassis> = {1}
<ServiceShelf> = {A}
<OAMSlot> = {2-3}
OMM
Optical Management Module
<Chassis>-<ServiceShelf><OMMSlot>
<Chassis> = {1}
Fan Shelf A present on the
chassis
<Chassis>-<FANA>
<Chassis> = {1-6}
Fan Shelf B present on the
chassis
<Chassis>-<FANB>
<ServiceShelf> = {A}
<OMMSlot> = {1A, 1B}
FANA
FANB
TL1 User Guide
Release 1.2
FANA (example: 1-FANA)
<Chassis> = {1-6}
FANB (example: 1-FANB)
UTStarcom Inc.
Introduction
Page 1-11
Managed Termination Point Entities
Table 1-3 on page 1-11 lists the termination points and their corresponding AIDs associated with each
managed equipment entity described in “Managed Equipment Entities” on page 1-8.
Table 1-3 Termination Point AIDs
Equipment
Type
BMM
Associated
Termination
Points
OTS
Description
Physical line side
port on the BMM
AID Format
<Chassis>-<ServiceShelf>-<BMMSlot><LinePort>
Valid Values
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<LinePort> = L1
OCG
Optical Channel
Group ports on the
BMM
<Chassis>-<ServiceShelf>-<BMMSlot><BMMOCG>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<BMMOCG> = {T1-T8}
BAND
C-Band termination point
<Chassis>-<ServiceShelf>-<BMMSlot><Band>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<Band> = {C (for C-band)}
DCF
Dispersion Compensation Fiber
port
<Chassis>-<ServiceShelf>-<BMMSlot><DCFPort>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<DCFPort> = {D1}
OSC
Optical Supervisory Channel termination
<Chassis>-<ServiceShelf>-<BMMSlot><OSCPort>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<OSCPort> = {O1}
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 1-12
Managed Entities and AID Overview
Table 1-3 Termination Point AIDs
Equipment
Type
DLM
Associated
Termination
Points
OCG
Description
Line side port on
the DLM
AID Format
<Chassis>-<ServiceShelf>-<DLMSlot><DLMOCG>
Valid Values
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<DLMOCG> = {L1}
OCH
Optical Channel
termination point
The subchannel
option supported
for OC48, STM16
and 1GBE rates
<Chassis>-<ServiceShelf>-<DLMSlot><DLMOCG>-<OCh>-[
<SubCh>]
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<DLMOCG> = {L1}
<OCh> = {1-10}
<SubCh> = {1-4}
DTPCTP
for TAM-210G
Digital termination
point. It is created
when a cross connect is created.
<Chassis>-<ServiceShelf>-<DLMSlot><DLMOCG>-<DLMDTP>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<DLMOCG> = {L1}
<DLMDTP> = {1-10}
DTPCTP
for TAM-42.5G and
TAM-4-1G
Digital termination
point. It is created
when a cross connect is created.
<Chassis>-<ServiceShelf>-<DLMSlot><DLMOCG>-<DLMDTP><DLMSUB>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<DLMOCG> = {L1}
<DLMDTP> = {1-10}
<DLMSUB> = {1-4}
TAM
DTPCTP for
TAM-2-10G
Digital termination
point on TAM. It is
created when a
cross-connect is
created.
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMPort>
Digital termination
point on TAM. It is
created when a
cross-connect is
created.
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMPort>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
<TOMPort> = {1-2}
DTPCTP for
TAM-4-2.5G
and TAM-41G
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
<TOMPort> = {1-4}
TL1 User Guide
Release 1.2
UTStarcom Inc.
Introduction
Page 1-13
Table 1-3 Termination Point AIDs
Equipment
Type
TOM
Associated
Termination
Points
TRIB
Description
Trib physical port
on the TOM
AID Format
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
Valid Values
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
<TOMSlot> = {1,2,3,4}
where
TOM slots (1-2) used for
TAM-2-10G equipment
type
TOM slots (1-4) used for
TAM-4-2.5G or TAM-4-1G
equipment types
OC192 /
OC48
SONET OC192/
OC48 termination
point
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
TOM slots (1-2) used for
OC192
TOM slots (1-4) used for
OC48
STM64/
STM16
SDH STM64/
STM16 termination
point
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
<TOMSlot> = {1,2, 3, 4}
TOM slots (1-2) used for
STM64
TOM slots (1-4) used for
STM16
10GbE/1GbE/
10GCC
10GbE/1GbE termination point
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
TOM slots (1-2) used for
10GbE, 10GCC
UTStarcom Inc.
TOM slots (1-4) used for
TL1 User Guide Release 1.2
1GbE
Page 1-14
Managed Entities and AID Overview
Table 1-3 Termination Point AIDs
Equipment
Type
IO Shelf
Associated
Termination
Points
Alarm Input
Alarm Output
OAM
OTS
Description
AID Format
Valid Values
Parallel telemetry
inputs on the IO
Shelf
<Chassis>-PTIN-<AlarmInput>
<Chassis> = {1-6}
Parallel telemetry
outputs on the IO
Shelf
<Chassis>-PTOUT<AlarmOutput>
<Chassis> = {1-6}
Physical line side
port on BMM
<Chassis>-<ServiceShelf>-<OAMSlot><LinePort>
<Chassis> = {1}
<AlarmInput> = {1-16}
<AlarmOutput> = {1-10}
<ServiceShelf> = {A}
<OAMSlot> = {2, 3}
<LinePort> = L1
BAND
C-Band termination point
<Chassis>-<ServiceShelf>-<OAMSlot><Band>
<Chassis> = {1}
<ServiceShelf> = {A}
<OAMSlot> = {2, 3}
<Band> = {C (for C-band)}
DCF
Dispersion Compensation Fiber
port
<Chassis>-<ServiceShelf>-<OAMSlot><DCFPort>
<Chassis> = {1}
<ServiceShelf> = {A}
<OAMSlot> = {2-3}
<DCFPort> = {D1}
OSC
Optical Supervisory Channel termination
<Chassis>-<ServiceShelf>-<OAMSlot><OSCPort>
<Chassis> = {1}
<ServiceShelf> = {A}
<OAMSlot> = {2-3}
<OSCPort> = {O1}
Managed Service Entities
As described in “Service Provisioning” on page 1-3, TL1 Interface supports two modes of service
provisioning: Cross-connect Provisioning and Dynamically Signaled SNC Provisioning. In the Dynamically
Signaled SNC Provisioning mode, AIDs are defined by the user during provisioning. It is a string of 128
characters. The AID for CRS is a combination of FROMAID and TOAID.
TL1 User Guide
Release 1.2
UTStarcom Inc.
CHAPTER 2
TL1 Message Overview
TL1 interface provides a consistent language for the transmission and reception of network messages to/
from the network element and OSS. These messages can be subdivided into three major categories: input
message (or command) to a network element, output message (or response), and autonomous message
from the network element to the OSS. TL1 syntax defines the grammatical rules used to formulate TL1
commands, responses, and acknowledgments. This chapter includes:
“TL1 Message Conventions and Notations” on page 2-2
“Input Command Format” on page 2-4
“Command Acknowledgment Format” on page 2-8
“Command Response Format” on page 2-9
“Autonomous Message Format” on page 2-12
“Error Code Descriptions” on page 2-14
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-2
TL1 Message Conventions and Notations
TL1 Message Conventions and Notations
Table 2-1 on page 2-2 gives a description of notations, symbols, and conventions used when describing
TL1 command responses or TL1 command formats.
Table 2-1 TL1 Command/Response Conventions and Notations
Convention
Notation
<cr>
Carriage Return
<lf>
Line feed
^
A blank space
[]
The parameters enclosed in the brackets [ ] are optional
<>
The parameters enclosed in the brackets <> are mandatory attributes
;
The semicolon indicates the end of a message
>
The greater than (>) character indicates the partial response
,
The comma separates multiple parameters in the parameters block
:
A Colon separates the parameter blocks
-
A dash (-) is always used in the command code when modifiers are present to separate
the verb, first modifier and second modifier (when applicable)
““
The pair of characters /* and */ is used to delimit free format text
UPPERCASE
Upper case characters in format expressions are transmitted exactly as shown, unless
enclosed within “< >” or “[ ]”, in which case they are substituted for the correct value(s)
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-3
TL1 Help
The TL1 provides help on the command syntax and parameters. The <Tab> key pressed at any stage of
the TL1 command line initiates TL1 help by displaying the complete syntax of the command.
Example
TL1>>DLT-SROUTE:[TID]::<CTAG>:::DSTIPADDR=<dstipaddr>,PREFIXLEN=<prefixlen>;
TL1 help on command syntax follows these notations.
For positional parameters, <> indicates mandatory and [] indicates optional.
For name-defined parameters, absence of a bracket indicates mandatory and [] indicates optional.
In the example,
CTAG is a positional mandatory parameter. TID is a positional optional parameter.
DSTIPADDR is a name-defined mandatory parameter.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-4
Input Command Format
Input Command Format
The Input Command is issued by the OSS to the network element in order to accomplish a specific task.
Each Input command consists of several blocks as described in Table 2-2 on page 2-4.
Command Syntax
<verb>[-<modifier1>[-<modifier2>]]:[TID]:[AID]:CTAG:[GENBLK]:[Parameter
Block]<Terminator>
Table 2-2 Input Command Format
Parameter
Description
Command Code Block
Verb
Every TL1 command must begin with a TL1 command verb followed by up to two modifiers to
fully describe the action to be performed. The command verb defines the action to be performed
such as retrieving information, setting an option, etc. Valid TL1 command verbs used in the network element include the following:
ENT
Enter:add
ED
Edit:modify
RTRV
Request information from a network element (Example: “RTRV-USER-SECU”)
DLT
Delete
REPT
Report autonomous response from network element (Example: “REPT ALM EQPT”)
CANC Logout user account from a TL1 session (Example:”CANC-USER”)
Modifier
OPR
Inhibit reporting alarms/events (Example:”OPR-ARC”)
SET
Set threshold values for a given register (Example:”SET-TH”)
INIT
Initialize
ACT
Login to user account
Modifiers define the object to which the command verb is applied. Depending upon the command verb, a single modifier or two modifiers separated by a hyphen are used to specify the
application of the command verb. Following are some examples of TL1 modifiers used in the
network element:
EQPT
Equipment
CRS
Cross Connect
USER User
SECU Security
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-5
Table 2-2 Input Command Format
Parameter
Description
Staging Parameter Block
TID
Target Identifier
The TID is a user-defined Target Identifier that identifies the specific network entity being
addressed by the command. The TID can consist of up to twenty (20) alphanumeric characters
used to describe the exact identity and location of this network entity within the system. This
descriptive tag could be a designator that includes a facility name, product name and location
within the network.
The valid alphanumeric characters include Letters(a to z|A to Z), digits(0 to 9), hyphens [-]. The
TID must start with a letter. Spaces are not allowed.
A command sent directly to a network element may be addressed without a TID by the originating network element. Alternatively, the originating network element can route the command
through other network elements to its target network element using a TID. If a network element
is the only target possible for a command, the TID can be omitted from that command. Otherwise, a TID must be specified. When a TID is omitted in the TL1 command, the default TID of the
local node or the GNE from previous command will be used by the network element.
AID
Access Identifier
The AID parameter addresses a particular entity such as hardware, software, facility, etc. within
a network element or terminating on the network element. The AID can be used to identify particular circuit packs, units, or subassemblies within the addressed network element. Refer to
“Managed Entities and AID Overview” on page 1-8 for the description of AIDs defined in
network element.
CTAG
Correlation Tag
The CTAG parameter is used to correlate an input command with a corresponding response
message. The operator uses a unique CTAG in a command and the system responds with the
CTAG included in the response to prevent confusion about which response corresponds to
which command. It is an alphanumeric parameter which can consist of six or less ASCII characters. The CTAGs for a given network element received in commands from multiple OSSs need
not be unique.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-6
Input Command Format
Table 2-2 Input Command Format
Parameter
Description
Parameter Block
The Parameter Block, also known as the Data Block, contains the additional information that
may be required to completely describe the operation to be performed. A series of parameters,
separated by delimiting commas, are used to complete the command string. Examples of
parameters include alarm level severity, loopback location and direction, current date and time.
The parameter block is divided into two types:
Position-defined Parameters: In a position-defined parameter block, only the values of the
parameters are defined in an order or position. The network element uses the default value
where ever applicable, when the positional parameter is not specified in the input command.
Name-defined Parameters: In a name-defined parameter block, every parameter is specified in
the input command with a name followed by an = sign and the corresponding value that the
parameter is assigned. The network element can send the name-defined parameters in any
order and the network element uses the default values for the parameter when there is no
parameter specified in the input command.
Terminator
All TL1 commands must end with a semicolon to be interpreted and executed as a valid TL1
command by the system.
Note: TL1 Interface does not support General Block.
Grouping and Ranging
The TL1 language defines a scheme called “grouping”. It is used to create a list of more than one
parameter that is to be passed to a single TL1 command.
Grouping Syntax
The command parameters can be grouped by using the connector “&” for grouping two or more values for
a particular parameter. The “&” grouping connector is used to pick and choose specific values. For
example, the command,
RTRV-AO:DON1::ctag::ATAGSEQ=1&500,MSGTYPE=ALM;
shows grouping of the two ATAG sequence numbers. The command response will provide the data for
ATAG sequence of 1 and ATAG sequence of 500 (if alarms with that ATAG exist).
Ranging Syntax
The “&&” ranging connector is used for expressing the range of values. For example, the command
RTRV-AO:DON1::ctag::ATAGSEQ=1&&500,MSGTYPE=ALM;
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-7
shows the ranging operation. The command retrieves all the alarms whose ATAG sequence number is in
the 1 to 500 range.
Some commands allow the operator “ALL” to be used for grouping. The “ALL” operator indicates the list of
all possible values for the particular parameter.
Note: Grouping and Ranging are not supported by default unless explicitly mentioned in the command itself.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-8
Command Acknowledgment Format
Command Acknowledgment Format
A Command Acknowledgment is a brief TL1 output message from the network element to an OSS, which
acknowledges that the network element received a request. An acknowledgment updates the user as to
the status of a given command. In general, an acknowledgment is sent by the network element when it is
unable to send a response within 2 seconds of the receipt of an input command.
Command Acknowledgement Syntax
[ACK]^<CTAG>] <cr> <lf>
<Terminator>
Table 2-3 Command Acknowledgement Description
Parameter
ACK
Description
The ACK is the acknowledgment code that describes the status of the input command processing. Following are the acknowledgment codes supported by TL1 Interface:
In-Progress (IP) or Printout Follows (PF)
In-Progress (IP) or Printout Follows (PF) is sent when network element is processing
the command and will subsequently send response messages.
No acknowledgement (NA)
No acknowledgement (NA) is sent when, under abnormal conditions, a command
has been accepted but lost and correct acknowledgement is not possible.
Repeat Later (RL)
Repeat Later (RL) is sent when the requested action cannot be executed because of
unavailable system resources caused by system overload, excessive queue lengths,
and busy programs. The command may be entered again later.
CTAG
For the description, refer to Table 2-2 on page 2-4.
Terminator
The Terminator is represented by the less than (<) character.
Example of IP Command Response
IP[^<ctag>] <cr> <lf>
<
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-9
Command Response Format
A response message is generated whenever a TL1 command is initiated. This response can be a Normal
Response which is an acknowledgment that the command was received and completed or an Error
Message which denies the completion of the command and includes an error code.
Command Response Syntax
The format of the command response is described below:
<cr><If><lf>
^^^<SID>^<Date>^<Time><cr> <lf>
M^^<CTAG>^<CMPLCDE><cr><lf>
<Text Block><Terminator>
Table 2-4 Command Response Parameter Description
Parameter
SID
Description
Source Identifier
The Source Identifier (SID) is used when the network element is identifying itself in a
response message. The SID identifies the specific network entity which was addressed
by the command.
Date
Date indicates the date when the command response was generated. The date has the
format: YY-MM-DD.
Time
Time indicates the time when the command response was generated. The time has the
format: HH-MM-SS.
M
M is a constant which signifies that the message is the response to an input command
message.
CTAG
For the description, refer to Table 2-2 on page 2-4.
CMPLCDE
The completion code indicates the disposition of the response. TL1 Interface supports
the following completion codes:
COMPLD - Normal response indicating the successful completion of the input command.
DENY - Error response indicating the failure of the input command as entered. The
error response includes the error code describing the reason for the command failure.
PRTL - Partial response indicating that the command is partially successful. That is, the
requested action was completed for some of the specified AIDs, but not all.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-10
Command Response Format
Table 2-4 Command Response Parameter Description
Parameter
Text Block
Description
The optional text block is used to give detailed information about the input command
response which could be a normal response, error response or a partial response.
The format of the Text Block for normal response is:
<RSPBLK> *
The format of the Text Block for error response is:
^^^<errcde><cr><If>
(^^^<error description><cr><If>) *
(^^^/*error text* /<cr><If>) *
<RSPBLK> *
The response block <RSPBLK> is optional and is present only if the command requires
that particular response parameter to be sent back.
errcde
The error code (errcde) describes the reason for the command failure. The error codes
reported by TL1 Interface are described in “Error Code Descriptions” on page 214.
error description
The error description contains the textual description of the reason for the error and the
list of invalid parameters.
error text
The error text gives further description of the error conditions.
Terminator
The Terminator is represented by either the semicolon character “;” or the
greater than “>” character.
“; “ Indicates that no other output relating to this message will follow. The final
response to a partial response always ends in a semicolon “;”.
“>” indicates that more output associated with this response will follow. If the network
element has a response that is greater than what it can report in a single response, it
will split the response into multiple partial responses.
Example of Normal Response
<cr><If><lf>
^^^<SID>^<Date>^<Time><cr> <lf>
M^^<CTAG>^COMPLD<cr><lf>
<RSPBLK> *;
Example of Error Response
<cr><If><If>
^^^<SID>^<Date>^<Time><cr> <lf>
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-11
M^^<DTAG>^DENY<cr><If>
^^^<ERRCDE><cr><If>
(^^^<Error Description><cr><If>) *
(^^^/*Error Text* /<cr><If>) *;
Fast Retrieval of Large Records
The TL1 agent on the network element is capable of retrieving large amount of data using a single TL1
retrieval command. This is specifically true for commands such as RTRV-AO, RTRV-EQPT where large
amount of records are present on the network element and the TL1 user wants to retrieve all of them.
These types of requests are very expensive in terms of network element MCM CPU performance. In order
to optimize the performance of the retrieval operations in these scenarios, the TL1 agent utilizes the
batching retrieval feature. Using this feature, the entire request is split into batches and the output is given
to the users in batches. Each batch is tagged with the RTRV completion code. The net effect is that, the
wait is minimal for the user, as the output starts appearing as soon as the command is executed.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-12
Autonomous Message Format
Autonomous Message Format
Autonomous messages are those automatic messages reported by the network element to the OSS.
These messages have the verb as REPT. Typical scenarios where autonomous messages are used
include:
Reporting of alarmed and/or non-alarmed trouble events
Reporting of scheduled diagnostic tests in the network element
Reporting of Performance Monitoring data
Reporting of a change in the network element's database (state change and database change notifications)
Autonomous Message Syntax
<cr> <lf> <lf>
^^^<SID>^<Date>^<Time> cr lf
<ALMCDE>^<ATAG>^REPT[^modifier[^modifier]] <cr> <lf>
[^^^"<AID>:<Parameters>" <cr> <lf>]...
[^^^"<AID>:<Parameters>" <cr> <lf>];
Table 2-5 Autonomous Messages parameter description
Parameter
Description
SID
Refer to Table 2-4 on page 2-9.
Date
Refer to Table 2-4 on page 2-9.
Time
Refer to Table 2-4 on page 2-9.
ALMCDE
The ALMCDE is the alarm code that specifies the severity of the alarm and hence
the priority of the action that needs to be taken in response to the alarm. The TL1
Interface supports the following alarm severities:
*C
Critical Alarm
**
Major Alarm
*^
Minor Alarm
A^
Automatic message or no alarm
ATAG
The ATAG is the automatic message tag used to correlate automatic messages
caused by a common trouble. The TL1 Interface assigns each message ATAG a
decimal number limited to a maximum of 10 digits.
REPT
The REPT is the automatic message verb, Report. It is followed by up to two modifiers separated by a space which is indicated by the up caret (^).
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-13
Table 2-5 Autonomous Messages parameter description
Parameter
Description
AID
Refer to Table 2-2 on page 2-4.
Parameters
A series of parameters, separated by delimiting commas, are used to describe the
autonomous message. Examples of parameters include alarm level severity, condition type and direction.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-14
Error Code Descriptions
Error Code Descriptions
TL1 errors are encountered during parsing, detection of invalid AIDs, formatting errors in parameter fields
which specify a collection of parameter values, etc. The Table 2-6 on page 2-14 describes error codes
reported by TL1 Interface.
Table 2-6 Error Code Descriptions
Error Code
Description
Probable cause(s)
ENEQ
Equipage, Not Equipped
The Equipment is not provisioned on the network element.
ICNV
Input, Command Not Valid
The command verb or a modifier is invalid (not recognizable by the network element according to the
domain of command verb, first modifier or second
modifier).
EANS
Equipage, Access Not Supported
Equipment or Entity being updated is read-only or do
not have the right access.
IDNV
Input, Data Not Valid
A simple or compound parameter value appearing in
an input command is invalid (given that it is within its
allowable range).
IDRG
Input, Data Range error
A parameter value appearing in an input command is
inconsistent with its defined type or falls outside its
allowable range.
IEAE
Input, Entity Already Exists
The entity to be created already exists.
IENE
Input, Entity Does Not Exist
The specified object entity does not exist.
IIAC
Input, Invalid Access identifier
AID is invalid because it is syntactically incorrect, or
when an AID is valid but not in the context of the current operation.
IICT
Input, Invalid Correlation Tag
The CTAG syntax is not valid.
IIFM
Input, Invalid data ForMat
The Data format of the attributes is incorrect.
IISP
Input, Invalid Syntax or Punctuation
When a character appearing in an input command violates syntax rules, or when the command string is too
long. It should be possible to return this code for every
command.
IITA
Input, Invalid Target identifier
The Target Identifier specified in the input command is
invalid.
INUP
Input, Non-null Unimplemented
Parameter
This error code is not used currently.
IPMS
Input, Parameter Missing
This error code is returned when the Input command
parameter is missing completely.
IPNV
Input Parameter Not Valid
The error code is returned when the input command
has a invalid parameter.
TL1 User Guide
Release 1.2
UTStarcom Inc.
TL1 Message Overview
Page 2-15
Table 2-6 Error Code Descriptions
Error Code
Description
Probable cause(s)
PICC
Privilege, Invalid Command
Code
This error code is returned if the UAP level is not valid
for the requested command.
PIUI
Privilege, Illegal User Identity
This error code is returned when the user ID or password is invalid.
PLNA
Privilege, Login Not Active
This error code is returned when the command is
issued without the user being logged into the system.
SAAL
Status, Already Allowed
This error code is returned when the user issues an
ALW command followed by an immediate ALW command.
SAIN
Status, Already Inhibited
This error code is returned when the user issues an
INH command followed by an immediate INH command.
SAIS
Status, Already In Service
This error code is returned when the user tries to
change the state of the entity to in-service state when
the current state is already in-service.
SAMS
Status, Already in Maintenance
State
This error code is returned if the user tries to change
the state of entity to MT state when the current state of
the entity is already MT.
SAOP
Status, Already Operated
This error code is returned when the user tries to issue
the protection switch command when the protection
switch has been already operated. For e.g. issuing the
command OPR-PROTNSW-xxx twice in succession.
SARB
Status, All Resources Busy
This error code is returned when the input command
cannot be completed due to shortage of resources.
The resources that are needed to execute the command are all busy with other tasks.
SNVS
Status, Not in Valid State
This error code is returned when the status of entity is
not in valid state to carry out the requested operations.
For example, trying to delete a Termination Point when
it is not in OOS state.
SROF
Status, Requested Operation
Failed
This error code is returned when the input command is
failed due to software problem. For example, the
MCM tries to get information from other cards, which
are in the fault state.
IPNC
Input parameter not consistent
Two valid parameter names appearing in an input
command are mutually exclusive with each other.
IPEX
Input Parameter Extra
A valid parameter is illegally used or repeated (according to the command code) in an input command.
IDNC
Input Data Not Consistent
A piece of input data appearing in an input command is
inconsistent with another piece of input data (given
that their two parameter names are not mutually exclusive).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 2-16
Error Code Descriptions
Table 2-6 Error Code Descriptions
Error Code
Description
Probable cause(s)
IBEX
Input Block Extra
The number of parameter blocks in the input command
is more than what has been expected.
IICM
Input Invalid Command
The Input Command is not valid.
IIPG
Input Invalid Parameter Grouping
The grouping of input parameters are not correct
SRCI
Status Requested Command
Inhibited
This error code is used when a command is not valid
during the scope of current operation. For e.g. Trying
to delete a Signaled Cross Connect.
SAPR
Status Already in Protection
state
This error code is returned when the AID specified in
the ENT-FFP.
SSRD
Status Switch Request Denied
This error code is used when the manual activity
switch request cannot be executed due to the fact that
the standby entity is either operationally faulty (operationally out of service) or manually locked out (manually out of service)
SNSR
Status No Switch Request outstanding
This error code is used when the protection release
command is executed on an entity (e.g. TRIB) which
does not have any switch request outstanding. (e.g.
lockout)
SNPR
Status Not in Protection State
This error code is used when the protection switching
command is applied to an entity (e.g. TRIB ) which is
not involved in a protection group at all.
TL1 User Guide
Release 1.2
UTStarcom Inc.
CHAPTER 3
Establishing Connectivity
This chapter describes how to establish connectivity between TL1 terminal and a target network element
(a TN780 or an Optical Line Amplifier) and to start a TL1 session, in the following sections:
“Network Element Accessibility Options” on page 3-2
“Connecting to a Target Network Element” on page 3-3
“Starting TL1 Session for GNE” on page 3-8
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-2
Network Element Accessibility Options
Network Element Accessibility Options
Access to a network element requires a physical port, a supporting protocol and an application that the
client can use. The ports may be Ethernet, Data Communication Network (DCN), Auxiliary or Serial Craft.
The supported interface may be TL1, MPower GNM or MPower EMS functionality.
As shown in Figure 3-1 on page 3-2, each network element (that is, a TN780 or an Optical Line Amplifier)
can be managed through multiple management clients, thus providing full management redundancy. This
is possible since the Digital Optical Networks implement “network-is-master” network management model.
By following this model, the network elements asynchronously inform and update all management clients
of any event or state change information, and hence mitigate synchronization or accuracy issues between
the management clients.
The network element provides Gateway Network Element (GNE) and Management Application Proxy
(MAP) services to conserve IP addresses and also enable remote network element management. Refer to
UTStarcom TN780 System Description manual for the description of these services and how to utilize
them. When these services are enabled appropriately in the network, the users can issue TL1 commands
to multiple nodes via a single connection through the GNE.
Figure 3-1 on page 3-2 shows how TL1 Interface can be invoked in multiple ways.
Figure 3-1 TL1 Interface
TL1 User Guide
Release 1.2
UTStarcom Inc.
Establishing Connectivity
Page 3-3
Connecting to a Target Network Element
The TL1 terminal can be connected to a target network element using one of the following methods:
Craft Ethernet Port (see “Connecting to a Target Network Element through Craft Ethernet Port” on
page 3-3)
Craft Serial Port (see “Connecting to a Target Network Element through Craft Serial Port” on
page 3-5)
Modem Interface (see “Modem Interface (Accessing Network Element via Modem)” on page 3-6
DCN Interface (see “Connecting to a Target Network Element through DCN Interface” on page 3-7)
Connecting to a Target Network Element through Craft
Ethernet Port
The TL1 terminal must be connected to the target network element and configured in order to access TL1
interface.
The TN780 network element provides craft Ethernet port on the MCM circuit pack and the Optical Line
Amplifier network element provides craft Ethernet port on the OMM circuit pack.
You must use a straight-through CAT5 Ethernet cable with RJ-45 connectors at both ends.
To connect the Ethernet cable from the craft computer to the target network element
Step 1
Connect the male RJ-45 connector on one end of a standard (straight-through) Category 5
Ethernet cable to the Ethernet port on your craft terminal.
Step 2
Connect the male RJ-45 connector on the other end of the Category 5 Ethernet cable to the
female RJ-45 connector labeled Craft on the MCM/OMM circuit pack.
Configuring TL1 Terminal
Follow the procedures described below to establish a direct connection between the craft terminal and the
target network element.
Note: All procedures described below are for the Microsoft Windows 2000 platform.
If there are any values already entered prior to configuration, record the values and enter the new values
as suggested.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-4
Connecting to a Target Network Element
To configure TL1 terminal
Step 1
If the craft computer is connected to the LAN using an Ethernet connection, disconnect the
Ethernet cable, and reboot the craft computer before proceeding.
Step 2
On your Windows desktop, select Start >Settings >Network and Dial-up Connections >Local
Area Connection. The Local Area Connection Status dialog box is displayed.
Step 3
Click Properties. The Local Area Connection Properties dialog box is displayed.
Figure 3-2 Local Area Connection Properties
Step 4
On the General tab, choose TCP/IP Protocol, and then click Properties.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Establishing Connectivity
Page 3-5
Figure 3-3 TCP/IP Properties
Step 5
Click Use the following IP address.
Step 6
In the IP Address field, enter an IP address. The IP address should be in the same subnet as
the IP address configured for DCN. The last three digits must vary between 1 and 255.
Step 7
In the Subnet Mask field, enter 255.255.255.0.
Step 8
In the Default Gateway field, enter the target network element IP address.
Step 9
Click OK to save the changes.
Testing the connection
To test the connection
Step 1
Issue a telnet command to the network element on the port 9090 (for example <telnet IP
Address of the network element > 9090).
Step 2
If the connection is functioning, TL1 prompt will be displayed.
Connecting to a Target Network Element through Craft Serial
Port
The TL1 terminal must be connected to the target network element and configured in order to access TL1
interface.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-6
Connecting to a Target Network Element
The TN780 network element provides craft Ethernet port on the MCM circuit pack and the Optical Line
Amplifier network element provides craft Ethernet port on the OMM circuit pack. The procedure given
below is followed to connect to the MCM and OMM circuit packs (referred to as the MCM/OMM).
To make a Serial connection
Step 1
Insert the male connector end of the Serial cable into the port labeled Craft DCE on the MCM.
Step 2
Insert the other end of the cable into the Serial port on TL1 terminal.
Step 3
Set the baud rate to 9600.
Modem Interface (Accessing Network Element via Modem)
Connecting to a target Network Element using a Modem
To connect to a target network element using a modem
Step 1
Connect the modem DTE port to the CRAFT DCE port (on the I/O panel) with a DB25-to-DB9
serial cable that comes with the modem package.
Step 2
Connect the Line port on modem to the telephone line with a RJ-11 cable (can be PBX extension
or a direct line).
Step 3
Connect the TL1 terminal to a telephone line with a RJ-11 cable.
Accessing procedure
To access the target network element
Step 1
Open the hyperterminal application on the PC (Start Menu >Programs >Accessories >Communications >Hyperterminal).
Step 2
A new connection window appears, provide a name to the connection in that window.
Step 3
"Connect To" window appears, choose Modem in the Connect using drop down menu.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Establishing Connectivity
Page 3-7
Step 4
Select the Country/Region option accordingly (Country code of the country where the network
element is located).
Step 5
Select Area code in that country. Provide the phone number (Exclude Country code and Area
code). Click on OK button.
Step 6
Connect window appears, Click Dial button on this window. Dialing message can be seen in the
same window as a status of the call.
Step 7
If the connection is successful, you will be prompted with authentication dialogue by the network
element. Provide user info (Acli/infinera). You will be presented with network element acli>
prompt. You are only able to access the network element now.
Troubleshooting while connecting to a network element using a modem
This section describes how to identify problems and provides solutions while connecting to a network
element via modem.
1.
Make sure the volume level of your PC sound card is not set to mute. Once you dial the number.
You can hear the dial tone followed by a ring tone if the connections are successful.
2.
If the PC is not connected to the telephone line, you won't hear the dial tone at all. An error message "No dial tone" in the status window (Refer Step 6 of Accessing procedure section).
3.
If you get the dial tone and if there is no ring tone, it means that the modem line is not connected to
the telephone line.
4.
If the dial tone is heard but no ringtone and it never connects, that means the modem is not in "Auto
Answer" mode (Its not picking up the call). Refer the modem manual to know how to set "AutoAnswer" mode. Normally, by default, modem will be in "AutoAnswer" mode.
Connecting to a Target Network Element through DCN
Interface
The TN780 and Optical Line Amplifier network elements provide remote access through the customer
DCN network. The TL1 terminal can be connected to the target network element via the DCN network. The
TL1 terminal must be properly configured to access the network element.
The network element can be connected to the DCN using the Ethernet cable.
Accessing TL1 Element through DCN Interface
The TN780 and Optical Line Amplifier network elements provide remote access through the customer
DCN network. The TL1 terminal can be connected to the target network element via the DCN network. The
TL1 terminal must be properly configured to access the network element.
The network element can be connected to the DCN using the Ethernet cable.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-8
Starting TL1 Session for GNE
Starting TL1 Session for GNE
A TL1 session can be launched using one of the following three methods:
Telnet
MPower EMS Client
MPower Graphical Node Manager
Launching a TL1 Session using Telnet
To access TL1 commands using a telnet session over a DCN connection, use the following port:
Port number 9090 is a telnet port that uses the telnet protocol and associated telnet escape
sequences.
To launch the TL1 session
At the command prompt, start the telnet session as follows:
Step 1
Type
telnet <Node IP Address or Nodename> <Port Number>,
where <Port Number> is 9090.
The TL1 prompt is displayed.
Note: The password will be exposed outside if the TL1 session is opened through the line mode.
It is recommended to use character mode for establishing a secure TL1 session. To
change the mode to character mode. See “To change mode to character mode on Solaris“.
To change mode to character mode on Solaris
Step 1
Do one of the following:
Switch to telnet prompt from the current TL1 session. Type
mode character
Return to TL1 prompt.
The scope of this command is limited to the current session.
In the file $HOME/.telnetrc of the user, enter the following two lines:
DEFAULT
mode character
TL1 User Guide
Release 1.2
UTStarcom Inc.
Establishing Connectivity
Page 3-9
Note: There is a space at the beginning of the second line (mode character).
You must logout of the current session and re-login to the TL1 session for the mode to be
changed to character mode.
Launching TL1 Session through MPower EMS Client
To launch TL1 session through MPower EMS Client
Step 1
Start Netscape Navigator or Internet Explorer.
Step 2
In the browser, type the MPower EMS client IP address that you want to access.
Step 3
Enter the user name and password at the login window that is displayed.
Step 4
Right-click on the node to be accessed and select TL1 session under the Tools option.
Launching TL1 Session through Graphical Node Manager
To launch TL1 session through GNM
Step 1
Start Netscape Navigator or Internet Explorer.
Step 2
In the browser, type the GNM IP address that you want to access.
Step 3
Enter the user name and password at the login window that is displayed.
Step 4
Select ‘TL1 session’ under the ‘Tools’ option.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-10
Starting TL1 Session for SNE
Starting TL1 Session for SNE
A TL1 session can be launched using one of the following three methods:
Telnet
MPower EMS Client
MPower Graphical Node Manager
Launching a TL1 Session using Telnet
To access TL1 commands using a telnet proxy to open a TL1 session, use the following port:
At the command prompt, start the telnet session as follows:
Step 1
Type
telnet <GNE IP Address or GNE Nodename> <Port Number>,
where <Port Number> is 10023.
The TL1 prompt is displayed.
At this point, use ACT-USER command to login to SNE as below:
To login to SNE
Step 1
Type
ACT-USER:SNE_TID:SNE_USERID:ctag::SNE_USER_PASSWORD;
Step 2
After successful login, the user can execute TL1 commands on SNE by specifying SNE_TID in
each command (similar to ACT-USER command in the previous step).
Note: The password will be exposed outside if the TL1 session is opened through the line mode.
It is recommended to use character mode for establishing a secure TL1 session. To
change the mode to character mode. see “To change mode to character mode on Solaris“.
To change mode to character mode on Solaris
Step 1
Do one of the following:
Switch to telnet prompt from the current TL1 session. Type
mode character
Return to TL1 prompt.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Establishing Connectivity
Page 3-11
The scope of this command is limited to the current session.
In the file $HOME/.telnetrc of the user, enter the following two lines:
DEFAULT
mode character
Note: There is a space at the beginning of the second line(mode character).
You must logout of the current session and re-login to the TL1 session for the mode to be
changed to character mode.
Launching TL1 Session through MPower EMS Client
To launch TL1 session through MPower EMS Client
Step 1
Start Netscape Navigator or Internet Explorer.
Step 2
In the browser, type the MPower EMS client IP address that you want to access.
Step 3
Enter the user name and password at the login window that is displayed.
Step 4
Right-click on the node to be accessed and select TL1 session under the Tools option.
This will open the following terminal window. There are two ways to login (See: “Using Node Name” on
page 3-11 and “Using GMPLS IP Address/Port Number” on page 3-11).
Using Node Name
Enter the TID or Router ID of the network element. This will start the TL1 session to the network element.
#### NOTICE: This is a private computer system. Unauthorized access or use may
lead to prosecution ####
Enter GMPLS Node Name/IP Address[:Port]: NE213
Connecting to NE213:9090...
Successfully connected to NE213:9090
TL1>>
Using GMPLS IP Address/Port Number
Enter the TID or Router ID of the network element. This will start the TL1 session to the network element.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-12
Starting TL1 Session for SNE
#### NOTICE: This is a private computer system. Unauthorized access or use may
lead to prosecution ####
Enter GMPLS Node Name/IP Address[:Port]: 1.1.8.213:9090
Connecting to 1.1.8.213:9090...
Successfully connected to 1.1.8.213:9090
TL1>>
Launching TL1 Session through Graphical Node Manager
To launch TL1 session through GNM
Step 1
Start Netscape Navigator or Internet Explorer.
Step 2
In the browser, type the MPower GNM client IP address that you want to access.
Step 3
Enter the user name and password at the login window that is displayed.
Step 4
In the GNM main menu select TL1 session under the Tools option.
This will open the following terminal window. There are two ways to login (See: “Using Node Name” on
page 3-12 and “Using GMPLS IP Address/Port Number” on page 3-12).
Using Node Name
Enter the TID or Router ID of the network element. This will start the TL1 session to the network element.
#### NOTICE: This is a private computer system. Unauthorized access or use may
lead to prosecution ####
Enter GMPLS Node Name/IP Address[:Port]: NE213
Connecting to NE213:9090...
Successfully connected to NE213:9090
TL1>>
Using GMPLS IP Address/Port Number
Enter the TID or Router ID of the network element. This will start the TL1 session to the network element.
#### NOTICE: This is a private computer system. Unauthorized access or use may
lead to prosecution ####
TL1 User Guide
Release 1.2
UTStarcom Inc.
Establishing Connectivity
Page 3-13
Enter GMPLS Node Name/IP Address[:Port]: 1.1.8.213:9090
Connecting to 1.1.8.213:9090...
Successfully connected to 1.1.8.213:9090
TL1>>
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 3-14
TL1 User Guide
Starting TL1 Session for SNE
Release 1.2
UTStarcom Inc.
CHAPTER 4
Fault Management
The UTStarcom Digital Optical Networking system fault monitoring and management capabilities are
modeled after Telcordia and ITU standards. For a detailed description of these capabilities, refer to the
UTStarcom TN780 System Description manual.
The UTStarcom TL1 Interface supports fault management messages in compliance with GR–833–CORE,
OTGR Section 12.3: “Network Maintenance: Network Element and Transport Surveillance Messages.” The
UTStarcom TL1 Interface provides users the ability to:
Monitor alarms and events detected by an UTStarcom network element (a TN780 or an UTStarcom
Optical Line Amplifier), or those detected by external sensors connected to the network element
Retrieve alarms and events stored in the UTStarcom network element
Assign alarm severity through the Alarm Severity Assignment Profile (ASAP)
Inhibit or allow alarm reporting on a per managed entity basis
Users can access these capabilities through the fault management capabilities described in the following
sections:
Alarm Surveillance
Autonomous Messages
Synchronous Messages
Autonomous Message Filtering
Alarm Severity Assignment Profile (ASAP)
Alarm Reporting Control (ARC)
Refer to the UTStarcom TN780 Maintenance and Troubleshooting Guide for description of alarms,
hierarchy of alarms, and alarm clearing procedures.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-2
Alarm Surveillance
Alarm Surveillance
The TL1 Interface supports autonomous messages to asynchronously report alarms and events and
synchronous messages to enable users to retrieve the alarms and events stored in network elements. The
following sections describe the parameters included in these messages, along with the message formats.
Message Parameter Descriptions
The TL1 autonomous and synchronous messages include several parameters to provide users with timely
and accurate information about all managed entities. Table 4-1 on page 4-2 provides the descriptions of
these parameters.
Table 4-1 Message Parameter Descriptions
Parameter
Description
Valid Value
CONDTYPE
The CONDTYPE (Condition Type)
parameter identifies the condition being
reported by the network element.
Refer to UTStarcom TN780 Maintenance and Troubleshooting Guide for
a list of alarm conditions reported through
the TL1 Interface.
NTFCNCDE
The NTFCNCDE (Notification Code) is a
two-character notification code which
identifies the severity of an alarm condition.
CR - Critical
MJ - Major
MN - Minor
NA - Non-Alarmed (Warning)
CL - Clear
NR - Not Reported
SRVEFF
LOCN
DIRN
OCRDAT
The SRVEFF (Service effect) parameter
indicates the effect on service caused by
the reported condition.
SA - Service Affecting
The LOCN (Location) field identifies the
location of the entity that reported the
condition.
NEND: Near End - This is to specify local
SNC
This DIRN (Direction) indicates the direction in which the trouble was reported by
the network element.
TRMT - Transmit
The OCRDAT (Occurrence Date) is the
date when the alarm or event occurred.
The format is MOY-DOM.
NSA - Non-Service Affecting
FEND: Far End - This is to specify
Remote SNC
RCV - Receive
MOY stands for Month Of Year and
ranges from 1 to 12.
DOM stands for Date Of Month and
ranges from 1 to 31.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-3
Table 4-1 Message Parameter Descriptions
Parameter
OCRTM
Description
The OCRTM (Occurrence Time) is the
time when the alarm or event occurred.
Valid Value
The format is HOD-MOH-SOM.
HOD stands for Hour Of Day and ranges
from 0 to 23.
MOH stands for Minutes of Hour and
ranges from 0 to 59.
SOM stands for Seconds of Minute and
ranges from 0 to 59.
CONDDESCR
CONDEFF
The CONDDESCR (Condition Description) is a detailed textual description of
the troubled condition.
Refer UTStarcom TN780 Mainte-
The CONDEFF (Condition Effect)
parameter indicates the effect of the
event on the condition of the network
element.
The valid values for this field are:
nance and Troubleshooting Guide for
a detailed textual description of the troubled condition
CL - Standing Condition Cleared
SC - Standing Condition Raised
TC - Transient Condition
ALMCDE
The Alarm code with severity.
*C Critical alarm
** Major Alarm
*^ Minor alarm
A^ Automatic message or No Alarm.
ATAG
Autonomously Generated Correlation
Tag
An integer up to 10 characters (decimal
point is optional)
MONVAL
Measured value identified by the MONTYPE
An integer
TMPER
Time period for which the PM data is
requested
1-DAY
15-MIN
Alarm Descriptions
Refer to UTStarcom TN780 Maintenance and Troubleshooting Guide for the description and clearing
procedures for the alarm conditions reported by the UTStarcom network elements through TL1 interface.
These alarm conditions are reported as the CONDTYPE and as alarm message parameters in
REPT^ALM, REPT^EVT and RTRV-COND messages.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-4
Alarm Surveillance
Event Descriptions
Refer to UTStarcom TN780 Maintenance and Troubleshooting Guide for the list and description of the
events/transient conditions reported by the UTStarcom network elements through the UTStarcom TL1
Interface.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-5
Autonomous Messages
Autonomous messages are notifications that are automatically reported by the network element to the
OSS in response to alarms and events that occur in the network element. The REPT^ALM and
REPT^EVT autonomous messages support the secondary modifiers listed in Table 4-2 on page 4-5.
Table 4-2 Secondary Modifiers for Autonomous and Synchronous Messages
Secondary Modifier (SM)
Description
ALL
Refers to all managed entities
EQPT(BMM/DLM/TAM/
TOM/MCM/OMM/OAMChassis/PEM/FAN)
Refers to the equipment indicated by the AID in the message
OC192
Refers to the OC192 port
OC48
Refers to the OC48 port
10GbE
Refers to the 10GbE port
1GbE
Refers to the 1GbE port
10GCC
Refers to the 10GCC port
OCH
Refers to the Optical Channel
OCG
Refers to the Optical Channel Group
STM64
Refers to the STM64 port
STM16
Refers to the STM16 port
OTS
Refers to the OTS port
BAND
Refers to the BAND port
TRIB
Refers to the tributary port
DCF
Refers to the dispersion compensation fiber
DTPCTP
Refers to the DTPCTP Channel
COM
Refers to Common objects generally network element
The following sections describe the autonomous message formats supported by the TL1 Interface.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-6
Autonomous Messages
REPT^ALM (Report Alarm)
Message Description
The REPT^ALM message is an autonomous message used to report non-environmental alarms with
severities of critical, major, and minor. Each alarm is reported in a separate REPT^ALM message. All other
transient conditions and events (TCAs) are reported using REPT^EVT messages.
Message Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
<ALMCODE>^<ATAG>^REPT^ALM^<SM> <cr> <lf>
^^^”<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>], [<LOCN>],[<DIRN>]:[<CONDDESCR>]”<
cr> <lf>
;
Message Parameter Description
Table 4-3 on page 4-6 describes parameters specific to REPT^ALM message.
Table 4-3 REPT^ALM Message Parameters
Parameter
ALMCODE
Description
The alarm code with severity.
Valid Range
*C - critical Used with NTFCNCDE=CR
** - major Used with NTFCNCDE=MJ
*^ - minor Used with NTFCNCDE=MN
A^ - clear Used with NTFCNCDE=CL
ATAG
A unique autonomous tag representing
this alarm
Integer
SM
Secondary Modifier indicating type of
entity on which the alarm is reported
Refer Table 4-2 on page 4-5
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-7
Table 4-3 REPT^ALM Message Parameters
Parameter
Description
Valid Range
AID
AID of the entity on which alarm is
being reported
All equipment, facility AIDs, other
objects in the network element like software and database files etc.
NTFCNCDE
The NTFFCNCDE (Notification Code)
is a two-character notification code
which identifies the severity of an alarm
condition.
CR - Critical
MJ - Major
MN - Minor
CL - Clear
CONDTYPE
SRVEFF
OCRDAT
The CONDTYPE (Condition Type)
parameter identifies the condition being
reported by the network element.
Refer to UTStarcom TN780 Mainte-
The SRVEFF (Service effect) parameter indicates the effect on service
caused by the reported condition.
SA - Service Affecting
The OCRDAT (Occurrence Date) is the
date when the alarm or event occurred.
The format is MOY-DOM-SOM.
nance and Troubleshooting Guide
for a list and description of alarm conditions reported through the TL1 Interface.
NSA - Non-Service Affecting
MOY stands for Month Of Year and
ranges from 1 to 12.
DOM stands for Date Of Month and
ranges from 1 to 31.
OCRTM
The OCRTM (Occurrence Time) is the
time when the alarm or event occurred.
The format is HOD-MOH-SOM.
HOD stands for Hour Of Day and
ranges from 0 to 23.
MOH stands for Minutes of Hour and
ranges from 0 to 59.
LOCN
UTStarcom Inc.
The LOCN (Location) field identifies the
location of the entity which has
reported the condition.
NEND: Near End - This is to specify
local SNC
FEND: Far End - This is to specify
Remote SNC
TL1 User Guide
Release 1.2
Page 4-8
Autonomous Messages
Table 4-3 REPT^ALM Message Parameters
Parameter
DIRN
CONDDESCR
Description
Valid Range
This DIRN (Direction) indicates the
direction in which the trouble has been
reported by the network element.
TRMT - Transmit
The CONDDESCR (Condition Description) is a detailed textual description of
the troubled condition.
String of 64 characters. The description should not exceed 64 characters
and should be enclosed in escaped
quotes.
RCV - Receive
NA - Not Applicable
Note: The escape quotes
are used in TL1 to
enclose and identify
an ASCII string.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-9
REPT^EVT(Report Event)
Message Description
The REPT^EVT message is an autonomous message to report the non-alarmed condition.
Message Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME>crl f
A^^<ATAG>^REPT^EVT^<sm>cr lf
^^^"[<AID>]:<CONDTYPE>,<CONDEFF>,<OCRDAT>,<OCRTM>,[<LOCN>],
<DIRN>,[<MONVAL>],[<THLEV>][,<TMPER>]:"\<CONDESC>\""cr lf
;
Message Parameter Description
Table 4-4 on page 4-9 describes parameters specific to REPT^EVT message.
Table 4-4 REPT^EVT Message Parameters
Parameter
Description
Valid Range
ATAG
A unique autonomous tag representing
this event
Integer
SM
Secondary Modifier indicating type of
entity on which the event is reported
Refer Table 4-2 on page 4-5
AID
AID of the entity on which event is being
reported
All equipment, facility AIDs, other objects
in the network element like software and
database files etc.
CONDTYPE
The CONDTYPE (Condition Type)
parameter identifies the condition being
reported by the network element.
Refer to UTStarcom TN780 Maintenance and Troubleshooting Guide for
a list and description of alarm conditions
reported through the TL1 Interface.
CONDEFF
The CONDEFF (Condition Effect)
parameter indicates the effect of the
event on the condition of the network
element.
CL - Standing Condition Cleared
UTStarcom Inc.
SC - Standing Condition Raised
TC - Transient Condition
TL1 User Guide
Release 1.2
Page 4-10
Autonomous Messages
Table 4-4 REPT^EVT Message Parameters
Parameter
OCRDAT
Description
The OCRDAT (Occurrence Date) is the
date when the alarm or event occurred.
Valid Range
The format is MOY-DOM.
MOY stands for Month Of Year and
ranges from 1 to 12.
DOM stands for Date Of Month and
ranges from 1 to 31.
OCRTM
The OCRTM (Occurrence Time) is the
time when the alarm or event occurred.
The format is HOD-MOH-SOM.
HOD stands for Hour Of Day and ranges
from 0 to 23.
MOH stands for Minutes of Hour and
ranges from 0 to 59.
SOM stands for Seconds of Minute and
ranges from 0 to 59.
LOCN
The LOCN (Location) field identifies the
location of the entity which has reported
the condition.
NEND - Near End -This is to specify local
SNC
DIRN
This DIRN (Direction) indicates the direction in which the trouble has been
reported by the network element.
TRMT - Transmit
MONVAL
Measured value
Initialized to zero
THLEV
The Threshold level value
Refer to Table 7-1 on page 7-2 for
details
TMPER
Time Period
1-DAY
RCV - Receive
NA - Not Applicable
15-MIN
CONDDESCR
The CONDDESCR (Condition Description) is a detailed textual description of
the troubled condition.
String of 64 characters. The description
should not exceed 64 characters and
should be enclosed in escaped quotes.
Note: The escape quotes
are used in TL1 to
enclose and identify
an ASCII string.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-11
REPT^DBCHG (Report Database Change)
Message Description
The UTStarcom Digital Optical Networking system reports this message to the OSS when a database
change or state change occurs as a result of commands entered through another management interface,
or as a result of external events such as circuit pack insertion or removal. The following changes are
considered to be database changes:
Changing the network element’s TID (or SID)
Changing the keyword values defined in the common block and specific block
Changing the network element state into and out of OOS-MA primary state
Changing the network element state to the secondary state
Message Format
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
A^^<ATAG>^REPT^DBCHG(cr lf
^^^"b:c:d([:e])*")+
cr lf;
Message Parameter Description
Table 4-5 on page 4-12 describes parameters specific to REPT^DBCHG message.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-12
Autonomous Messages
Table 4-5 REPT^DBCHG Message Parameters Description
Parameter
Description
ATAG
ATAG is an autonomously generated correlation tag. An integer up to 10 characters (decimal point is optional)
b = UPDATE MGMT
BLOCK
This is a keyword defined block which contains information pertinent to the
management of the external update represented by the output response line.
Information items including the time, date, source, link id, user id, and database
change report sequence reside in this block. The corresponding keywords and
their domains are as follows:
TIME=HH-MM-SS
DATE=YY-MM-DD
SOURCE=<alphanumeric string up to 20 characters>
LINKID=<alphanumeric string up to 20 characters>
USERID=<alphanumeric string up to 20 characters>
DBCHGSEQ=<integer from 0 to 9999>
If the REPT DBCHG message generated as a result of the input command, the
SOURCE field contains the CTAG of that command. If the input command is
issued from a local craft interface, it may not have a CTAG where the SOURCE
field is not included.
c = COMMAND CODE
BLOCK
This is a single parameter block which indicates the command code information of the action which created this external update. If a source other than a
message created this update (e.g., a hardware trigger), the equivalent command code which would result in the same effect on the database should be
specified. The command code parameter may have up to three components as
follows:
<verb or trigger type>-<modifier>[-<modifier>]
Valid values of trigger type include “PLUGIN”, “UNPLUG”.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-13
Table 4-5 REPT^DBCHG Message Parameters Description
Parameter
d = AID(s) of the object
entity which the external update has
affected.
Description
Single or multiple AIDs are specified here. Multiple AIDs shall be separated
by’&’ or’&&’ which are the TL1 input command AID separators for grouping
parameter values. The block can be specified as null where there is no AID
associated with an object entity affected by an external update. This block
should not be left blank.
Note: Multiple AIDs are not supported.
e = DATA BLOCK(s)
UTStarcom Inc.
This is a set of zero or more blocks which describe the details of the change
affected by the external update. For switching network elements, there is only
one block for each AID specified. For transport network element there may be
up to three blocks: the Common Block, the Specific Block, and the State Block.
Most external updates would readily translate the effect to these blocks
because the update was effected by a similar action message. Where the
update is not affected by such messages (for example, internal hardware triggered), these blocks should contain information which explicitly indicates the
keyword values that have changed.
TL1 User Guide
Release 1.2
Page 4-14
Synchronous Messages
Synchronous Messages
The synchronous messages consist of a request message from the OSS and a response message from
the UTStarcom Digital Optical Networking system. For example, when a user makes a request for
outstanding minor alarms for a specified network element, the UTStarcom Digital Optical Networking
system outputs the appropriate response message. The UTStarcom TL1 Interface supports RTRV-COND,
RTRV-ALM and RTRV-AO messages, as described in the following sections.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-15
RTRV-ALM (Retrieve Alarm)
Command Description
This command is used to view the current alarms present on the specified entity. This command reports
only alarmed conditions. All the alarms of a particular entity can be retrieved by specifying individual AID.
Command Syntax
RTRV-ALM{ALL|EQPT|OC192|OC48|STM64|STM16|10GBE|OCH|OCG|OTS|BAND|TRIB|DTPCTP|DCF|OSC|N
TP|SYS|FXFR|SNC|NCT|1GBE||10GCC|FFP}:[<TID>]:[<AID>]:<CTAG>::[<NTFCNCDE>],[<C
ONDTYPE>],[<SRVEFF>],[<LOCN>],[<DIRN>];
Table 4-6 RTRV-ALM Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Test and Turn-up, Monitoring Access, Provisioning, System Administrator
Pre-condition
None
Post-condition
None
Related Commands
RTRV-COND-ALL (Retrieve-Condition)
RTRV-AO (Retrieve-Autonomous Output)
SET-ATTR (Set-Attributes)
RTRV-ATTR (Retrieve-Attributes)
OPR-ARC (Inhibit Reporting Alarms/Events)
RLS-ARC (Release-Alarm Reporting Control)
RTRV-ARC (Retrieve-Alarm Reporting Control)
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
(^^^"<AID>,<AIDTYPE>:<NTFCNCDE>, <CONDTYPE>, <SRVEFF>,<OCRDAT>,<
OCRTM>,[<LOCN>],[<DIRN>]:[<CONDDESCR>]" <cr> <lf>)*
(>|;)
Error Codes
UTStarcom Inc.
(See Table 2-6 on page 2-14)
TL1 User Guide
Release 1.2
Page 4-16
Synchronous Messages
Table 4-7 RTRV-ALM Command Parameters Description
Parameter
Description
Valid Range
Default
AID
AID of the entity on which alarms
are to viewed. This parameter is
used to filter alarms.
All equipment, facility AIDs, other
objects in the network element like
software and database files etc.
ALL
NTFCNCDE
Notification code associated with
the alarm conditions being
retrieved.
CR - Critical
ALL
Type of alarm condition
Refer to UTStarcom TN780
Maintenance and Troubleshooting Guide for a list and description
CONDTYPE
MJ - Major
MN - Minor
ALL
of alarm conditions reported through
the TL1 Interface
SRVEFF
Service affecting flag
SA - Service Affecting
ALL
NSA - Non-Service Affecting
LOCN
Location of the alarm
NEND: Near End - This is to specify
local SNC
ALL
FEND: Far End - This is to specify
Remote SNC
DIRN
Direction of the alarm
TRMT - Transmit
ALL
RCV - Receive
Table 4-8 RTRV-ALM Response Parameters Description
Parameter
Description
AID
AID of the entity on which alarm is reported.
AIDTYPE
AIDTYPE of the entity on which alarm is reported.
NTFCNCDE
Notification code (See Table 4-7 on page 4-16)
CONDTYPE
Condition type (See Table 4-7 on page 4-16)
SRVEFF
Service affecting flag (See Table 4-7 on page 4-16)
OCRDAT
Occurrence date (mm-dd) (See Table 4-1 on page 4-2)
OCRTM
Occurrence time (hh-mm-ss) (See Table 4-1 on page 4-2)
LOCN
Location (See Table 4-7 on page 4-16)
DIRN
Direction (See Table 4-7 on page 4-16)
CONDDESCR
The description of alarm message enclosed in escape quotes (“\) (See
Table 4-1 on page 4-2)
Example 1
Use the following command to view all the alarms.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-17
RTRV-ALM-ALL:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:32:22
M
ctag RTRV
"1-A-1,EQPT:CR,IMPROPRMVL,SA,05-02-18,13-33-16,NA,NA:"Equipment improper
removal""
"1-A-3-T1-1,SNC:MN,SNCSETUPFAIL,NSA,05-02-18,14-03-49,NEND,NA:"Signaled SNC
setup failure""
"1-A-3-T1-2,SNC:MN,SNCSETUPFAIL,NSA,05-02-18,14-04-34,NEND,NA:"Signaled SNC
setup failure""
"1-A-3-T1-3,SNC:MN,SNCSETUPFAIL,NSA,05-02-18,13-41-32,NEND,NA:"Signaled SNC
setup failure"
;
Example 2
Use the following command to view the alarms present on the specified entity.
RTRV-ALM-OC192:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:35:10
M
ctag COMPLD
"2-A-4-T3-1,OC192:CR,LOF,SA,05-02-20,05-06-50,NEND,RCV:"Loss Of Frame""
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-18
Synchronous Messages
RTRV-COND-ALL (Retrieve-Condition)
Command Description
This command is used to view all the conditions present on the specified entity. This command reports
both alarmed conditions and non-alarmed conditions.
Command Syntax
RTRV-COND-ALL:[<TID>]:[AID]:<CTAG>::[<typereq>],[<locn>],[<dirn>],[<tmper>];
Table 4-9 RTRV-COND-ALL Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test
and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM (Retrieve Alarm)
RTRV-AO (Retrieve-Autonomous Output)
SET-ATTR (Set-Attributes)
RTRV-ATTR (Retrieve-Attributes)
OPR-ARC (Inhibit Reporting Alarms/Events)
RLS-ARC (Release-Alarm Reporting Control)
RTRV-ARC (Retrieve-Alarm Reporting Control)
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
(^^^“<AID>,<AIDTYPE>:<NTFCNCDE>, <CONDTYPE>, <SRVEFF>,<OCRDAT>,<
OCRTM>,<LOCN>,<DIRN>,<TMPER>,[<CONDDESCR>]“ <cr> <lf>)*
(>|;)
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA (See Table 2-6
on page 2-14)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-19
Table 4-10 RTRV-COND-ALL Command Parameters Description
Parameter
Description
Valid Range
Default
AID
AID of the entity on which alarms
are to viewed. This parameter is
used to filter alarms.
All equipment, facility AIDs,
other objects in the network
element like software and
database files etc.
ALL
TYPEREQ
Type of condition being requested
Refer to UTStarcom
Not Applicable
TN780 Maintenance and
Troubleshooting Guide
LOCN
Location
NEND: Near End - This is to
specify local SNC
Not Applicable
FEND: Far End - This is to
specify Remote SNC
DIRN
Direction
TRMT - Transmit
Not Applicable
RCV - Receive
TMPER
Time period for which the PM data
is requested
1-Day
Not Applicable
15-Min
Table 4-11 RTRV-COND-ALL Response Parameters Description
Parameter
Description
AID
AID of the entity on which alarm is reported.
AIDTYPE
AIDTYPE of the entity on which alarm is reported.
NTFCNCDE
Notification code (See Table 4-1 on page 4-2)
CONDTYPE
Condition type (See Table 4-1 on page 4-2)
SRVEFF
Service affecting flag (See Table 4-1 on page 4-2)
OCRDAT
Occurrence date (See Table 4-1 on page 4-2)
OCRTM
Occurrence time (See Table 4-1 on page 4-2)
LOCN
Location (See Table 4-1 on page 4-2)
DIRN
Direction (See Table 4-1 on page 4-2)
TMPER
Time Period (See Table 4-1 on page 4-2)
CONDDESCR
The description of alarm message enclosed in escape quotes (“\) (See
Table 4-1 on page 4-2)
Example
Use the following command to view the conditions present on specified entity.
RTRV-COND-ALL:::ctag;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-20
Synchronous Messages
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:35:40
M
ctag RTRV
"1-A-1,EQPT:CR,IMPROPRMVL,SA,05-02-18,13-33-16,NA,NA,:"Equipment improper
removal""
"1-A-3-T1-1,SNC:MN,SNCSETUPFAIL,NSA,05-02-18,14-03-49,NEND,NA,:"Signaled
SNCsetup failure""
"1-A-3-T1-2,SNC:MN,SNCSETUPFAIL,NSA,05-02-18,14-04-34,NEND,NA,:"Signaled
SNCsetup failure""
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-21
RTRV-AO (Retrieve-Autonomous Output)
Command Description
This command allows an OSS to view a list of autonomous messages from the Autonomous Output (AO)
buffer. The Operation System Service uses the RTRV-AO command to synchronize itself with the network
element.
Note: Grouping and ranging are supported on ATAGSEQ and DBCHGSEQ.
Command Syntax
RTRVAO:[<TID>]::<CTAG>:::[<ATAGSEQ=atagseq>,]<MSGTYPE=ALM|EVT|DBCHG|AUDIT>[,<DBCH
GSEQ=dbchgseq>];
Table 4-12 RTRV-AO Command Usage
Section
Description
User Access Privilege
Level
Network Administrator, Network Engineer, Security Administrator, Test and
Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM (Retrieve Alarm)
RTRV-COND-ALL (Retrieve-Condition)
SET-ATTR (Set-Attributes)
RTRV-ATTR (Retrieve-Attributes)
OPR-ARC (Inhibit Reporting Alarms/Events)
RLS-ARC (Release-Alarm Reporting Control)
RTRV-ARC (Retrieve-Alarm Reporting Control)
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-22
Synchronous Messages
Table 4-12 RTRV-AO Command Usage
Section
Description
Response Format
cr lf lf
For MSGTYPE=ALM
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD [cr lf
/* cr lf
^^^<SID>^<DATE>^<TIME> <cr> <lf>
<ALMCODE>^<ATAG>^REPT^ALM^<SM> <cr> <lf>
^^^”<AID>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>], [<LOCN>],[<DIRN>]:[<CONDDESCR>]”<
cr> <lf>+
*/] cr lf;
Response Format
cr lf lf
For MSGTYPE=EVT
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD [cr lf
/* cr lf
^^^<SID>^<DATE>^<TIME>crl f
A^^<ATAG>^REPT^EVT^<sm>cr lf
^^^”[<AID>]:<CONDTYPE>,<CONDEFF>,<OCRDAT>,<OCRTM>,[<LOCN>],
<DIRN>,[<MONVAL>],[<THLEV>][,<TMPER>]:”\<ALMMSG>\””cr lf +
*/] cr lf;
Response Format
cr lf lf
For MSGTYPE=DBCHG
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD [cr lf
/* cr lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
A^^<ATAG>^REPT^DBCHG(cr lf
^^^"b:c:d([:e])*")+
*/] cr lf;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-23
Table 4-12 RTRV-AO Command Usage
Section
Description
Response Format
cr lf lf
For MSGTYPE=AUDIT
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD [cr lf
/* cr lf
^^^<SID>^<DATE>^<TIME>crl f
(A^^<ATAG>^REPT^EVT^AUDIT cr lf
^^^”TIME,DATE,[SOURCE],USERID:COMMAND,COMLD|DENY:AID:POSITIONAL PARAM:NAME PARAM:STATE”)+ cr lf
*/] cr lf;
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA (See Table 2-6 on
page 2-14)
Table 4-13 RTRV-AO Command Parameters Description
Parameter
MSGTYPE
Description
Message type
Valid Range
Default
ALM: Alarm Message Type
Mandatory
EVT: Event Message Type
DBCHG: Change message Type
AUDIT: All audit message Type
ATAGSEQ
ATAG Sequence Number
An integer up to 10 characters
Not Applicable
DBCHGSEQ
Sequence number of REPT DBCHG
message. This keyword shall not be
used if ATAGSEQ and/or MSGTYPE
are used.
An integer up to 10 characters
Not Applicable
The response format for RTRV-AO depends on MSGTYPE as given in the Table 4-12 on page 4-21. The
parameters for each response type have been described in the corresponding tables.
For parameters corresponding to MSGTYPE=ALM, please refer Table 4-3 on page 4-6.
For parameters corresponding to MSGTYPE=EVT, please refer Table 4-4 on page 4-9.
For parameters corresponding to MSGTYPE=DBCHG, please refer Table 4-5 on page 4-12.
For parameters corresponding to MSGTYPE=AUDIT, please refer below Table 4-14 on page 4-24.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-24
Synchronous Messages
Table 4-14 RTRV-AO Response Parameters Description when MSGTYPE=AUDIT
Parameters
Description
ATAG
Autonomous tag associated with
the Audit event.
TIME
Timestamp of Audit event
DATE
Datestamp of Audit event
SOURCE
CTAG of the command which
caused the Audit event.
USERID
User Id of the user issuing the
command
COMMAND
Text of command which caused
the Audit event
RESULTCODE
Result code of the command
(COMPLD or DENY)
AID
AID in the command
POSITIONALPARAM
Positional parameters in the
command
NAMEPARAM
Named parameters in the command
STATE
State specification in the command
Example
Use the following command to view the list of autonomous messages.
RTRV-AO:NE1::ctag:::MSGTYPE=EVT;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:38:20
M
ctag RTRV
NE1 05-02-18 13:33:15
A
212455 REPT EVT FXFR
":COPY-RFILE-FAIL,TC:File transfer failed because of MCM reboot"
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-25
>
TL1>>
NE1 05-02-20 06:38:21
M
ctag RTRV
NE1 05-02-18 13:35:17
A
213783 REPT EVT EQPT
"2-A-2:,TC,05-02-18,13-35-17,,,,,:DampStatusString = <Start Reason[7]: Channel
count changed, Hop 1: GainCalcStatus: Ok,
Amp. Setpoint: 2.24, Amp. Target: 3.07, GainCommitStatus: Ok, End Reason[56]:
Success>"
>
TL1>>
NE1 05-02-20 06:38:21
M
ctag RTRV
NE1 05-02-18 13:35:49
A
213945 REPT EVT COM
"NE1:,TC,05-02-18,13-35-49,,,,,:NC System is Active now"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-26
Autonomous Message Filtering
Autonomous Message Filtering
This section discusses commands related to inhibiting or allowing the reporting of autonomous messages
through the UTStarcom TL1 interface.
Note: When autonomous messages are inhibited, the alarm generation by the network element
continues, however, only the reporting is disabled for that session.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-27
INH-MSG-ALL (Inhibit-Message)
Command Description
This command inhibits the reporting of autonomous alarms/events to the user. However, the messages
themselves continue to be generated, and are stored in the network element database. They can be
retrieved through the RTRV-COND/RTRV-ALM commands. The INH-MSG-ALL command works on a per
session basis. By default, message reporting is enabled on UTStarcom network elements.
Command Syntax
INH-MSG-ALL:[<TID>]::<CTAG>;
Table 4-15 INH-MSG-ALL Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
ALW-MSG-ALL (Allow-Message)
Response Format
Standard
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA
Example
Use the following command to inhibit the reporting of all autonomous change reports..
INH-MSG-ALL:::ctag;
Output
The following message is returned indicating successful completion.
qwerty 05-01-07 09:13:30
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-28
Autonomous Message Filtering
ALW-MSG-ALL (Allow-Message)
Command Description
This command is used to allow reporting of all autonomous change reports. This command works on a per
session basis.
Command Syntax
ALW-MSG-ALL:[<TID>]::<CTAG>;
Table 4-16 ALW-MSG-ALL Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
INH-MSG-ALL (Inhibit-Message)
Response Format
Standard
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA
Example
Use the following command to allow reporting of all autonomous change reports.
ALW-MSG-ALL:::ctag;
Output
The following message is returned indicating successful completion.
qwerty 05-01-07 09:13:45
M
CTAG COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-29
RTRV-MSG-ALL
Command Description
This command is used to view the status of reporting autonomous messages to the user. This command
works on a per session basis.
Command Syntax
RTRV-MSG-ALL:[<TID>]::<CTAG>;
Table 4-17 RTRV-MSG-ALL Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
SID DATE TIME
M CTAG COMPLETION CODE
"[AID],[AIDTYPE]:[DUMMY],[CONDTYPE]" ;
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA (See
Table 2-6 on page 2-14)
Example
Use the following command to view the status of reporting the autonomous messages to the user.
RTRV-MSG-ALL:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:40:42
M
ctag COMPLD
",:,ALWMSG"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-30
Alarm Severity Assignment Profile (ASAP)
Alarm Severity Assignment Profile (ASAP)
The Alarm Severity Assignment Profile (ASAP) assigns the notification code (also known as severity) to
the standing condition. Table 4-18 on page 4-30 lists the AID types supported for ASAP.
Table 4-18 AID Types supported for ASAP
AID types
Description
10GbE
Refers to the 10GbE port
1GbE
Refers to the 1GbE port
10GCC
Refers to the 10GCC port
BAND
Refers to the BAND port
DCF
Refers to the dispersion compensation fiber
DTPCTP
Refers to the DTPCTP Channel
EQPT(BMM/DLM/TAM/XFP/MCM/Chassis/TOM/FAN/PEM)
Refers to the equipment indicated by the AID in the message
FXFR
Refers to File Transfer
NTP
Refers to the Network Timing Protocol
OC192
Refers to the OC192 port
OC48
Refers to the OC48 port
OCG
Refers to the Optical Channel Group
OCH
Refers to the Optical Channel
OSC
Refers to the Optical Supervisory Channel
OTS
Refers to the OTS port
SNC
Refers to the Sub-Network Connection
STM16
Refers to all the STM16 port
STM64
Refers to all the STM64 port
SYS
Refers to the System
NCT
Refers to the NCT port
TRIB PTP
Refer to TRIB Port
FFP
Refer to FFP Trib Port
ALL
Refers to all managed entities
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-31
SET-ATTR (Set-Attributes)
Command Description
This command is used to set the severity of the alarms.
Command Syntax
SET-ATTR{EQPT|OC192|OC48|OCH|OCG|DTPCTP|OTS|BAND|STM64|STM16|10GBE|OSC|TRIB|DCF|NTP|S
YS|FXFR|SNC|NCT|1GBE|10GCC|FFP}:[<TID>]:[<AID>]:<CTAG>::<ntfcncde>,<condtype>
,[NEND|FEND]:[<CHASSISLEDCTRL=true|false>];
Table 4-19 SET-ATTR Command Usage
Section
Description
User Access Privilege Level
Provisioning
Pre-condition
AID is mandatory for EQPT (For all other AID types, AID is not
required). LOCN (NEND or FEND) is required only for SNC, to
specify local or remote SNC.
Post-condition
Severity of the alarm raised after the execution of this command
changes. The existing alarms/ events in the event log remain the
same.
Related Commands
RTRV-ALM (Retrieve Alarm)
RTRV-COND-ALL (Retrieve-Condition)
RTRV-AO (Retrieve-Autonomous Output)
RTRV-ATTR (Retrieve-Attributes)
OPR-ARC (Inhibit Reporting Alarms/Events)
RLS-ARC (Release-Alarm Reporting Control)
RTRV-ARC (Retrieve-Alarm Reporting Control)
SET-ATTR-ENV (Set-Environmental-Attributes)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-32
Alarm Severity Assignment Profile (ASAP)
Table 4-20 SET-ATTR Command Parameters Description
Parameter
AID
Description
AID of equipment. This parameter is
applicable only for SET-ATTR-EQPT.
It is needed to determine the type of
equipment to which this setting is to
be applied. The setting is applicable
to all the equipment of that type.
Valid Range
Default
Valid equipment AIDs.
Not Applicable
CR - Critical
Mandatory
For example: If a BMM AID of 1-A-1
or 1-A-2 is specified, the setting takes
effect for all BMM equipment.
NTFCNCDE
Notification code associated with the
alarm.
MJ - Major
MN - Minor
NA - Non-Alarmed (Warning)
CL - Clear
NR - Not Reported
CONDTYPE
Type of alarm condition
See Table 4-1 on
Mandatory
page 4-2
LOCN
Location of SNC. This parameter is
applicable only for SET-ATTR-SNC.
NEND: Near End - This is
to specify local SNC
Not Applicable
FEND: Far End - This is to
specify Remote SNC
CHASSISLEDCTRL
The facility related alarms should be
configured as to whether or not their
alarm state is propagated up to the
chassis level. When an LOS is
detected on the OTS, for example,
the reflection of this major alarm
severity on the chassis summary LED
should be configured in software.
This attribute configures whether an
alarm is propagated to summary LED
of the corresponding chassis or not
true, false
true
Example
Use the following command to set the severity of the alarm.
SET-ATTR-OSC:::ctag::CR,INTER-OAM-MIS-CONN;
Output
The following message is returned indicating successful completion.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-33
NE1 05-02-20 06:42:31
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-34
Alarm Severity Assignment Profile (ASAP)
RTRV-ATTR (Retrieve-Attributes)
Command Description
This command is used to view the severity attributes currently set for the given alarm condition.
Command Syntax
RTRV-ATTR{EQPT|OC192|OC48|OCH|OCG|DTPCTP|OTS|BAND|STM64|STM16|10GBE|OSC|TRIB|DCF|NTP|SY
S|FXFR|SNC|NCT|1GBE|10GCC|FFP|ALL}:[<TID>]::<CTAG>::[<ntfcncde>],[<condtype>],
[NEND|FEND];
Table 4-21 RTRV-ATTR Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
AID is mandatory for equipment.
Post-condition
None
Related Commands
RTRV-ALM (Retrieve Alarm)
RTRV-COND-ALL (Retrieve-Condition)
RTRV-AO (Retrieve-Autonomous Output)
SET-ATTR (Set-Attributes)
OPR-ARC (Inhibit Reporting Alarms/Events)
RLS-ARC (Release-Alarm Reporting Control)
RTRV-ARC (Retrieve-Alarm Reporting Control)
Response Format
SID DATE TIME
M CTAG COMPLETION CODE
"[AID],[AIDTYPE]:<NTFCNCDE>,<CONDTYPE>,[LOCN],[DIRN],[TMPER]:[<CHASSISLEDCTRL=chassisledctrl>]" ;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-35
Table 4-22 RTRV-ATTR Command Parameters Description
Parameter
NTFCNCDE
Description
Notification code associated with
the alarm.
Valid Range
Default
CR - Critical
Not Applicable
MJ - Major
MN - Minor
NA - Non-Alarmed (Warning)
CL - Clear
NR - Not Reported
CONDTYPE
Type of alarm condition
See Table 4-1 on page 4-2
Not Applicable
LOCN
Location of SNC. Parameter applicable only for RTRV-ATTR-SNC.
NEND: Near End - This is to
specify local SNC
Not Applicable
FEND: Far End - This is to
specify Remote SNC
Table 4-23 RTRV-ATTR Response Parameters Description
Parameter
Description
AID
AID of the entity for which this ASAP setting is applicable (This parameter
is not supported in this software release).
AIDTYPE
AIDTYPE of the entity for which this ASAP setting is applicable.
NTFCNCDE
Notification code associated with the alarm (See Table 4-2 on page 4-5)
CONDTYPE
Type of alarm condition (See Table 4-2 on page 4-5)
SRVAFF
Flag indicating whether alarm is service affecting or non-service affecting.
LOCN
Parameter for distinguishing between local (NEND) and remote (FEND)
SNC ASAP setting.
DIRN
Direction (See Table 4-2 on page 4-5)
TMPER
Time period (See Table 4-2 on page 4-5)
CHASSISLEDCTRL
It controls the alarm transmitted to the chassis summary LED. Values are
‘true’ or ‘false’
Example
Use the following command to view the attributes of the entity.
RTRV-ATTR-OSC:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:44:05
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-36
M
Alarm Severity Assignment Profile (ASAP)
ctag RTRV
",OSC:MJ,GMPLS-CONFIG-MISMATCH,NSA,NA,NA,NA:CHASSISLEDCTRL=true"
",OSC:MJ,GMPLS-NBR-DOWN,NSA,NA,NA,NA:CHASSISLEDCTRL=true"
",OSC:MJ,LOC,NSA,NEND,RCV,NA:CHASSISLEDCTRL=true"
",OSC:MN,NBRS-OSC-IPADDR-IN-CONFLICT,NSA,NA,NA,NA:CHASSISLEDCTRL=true"
",OSC:MJ,OSC-IPADDR-DUPLICATE,NSA,NA,NA,NA:CHASSISLEDCTRL=true"
",OSC:MJ,OSC-IPADDR-SUBNET-MISMATCH,NSA,NA,NA,NA:CHASSISLEDCTRL=true"
",OSC:CR,INTER-OAM-MIS-CONN,NSA,NA,TRMT,NA:CHASSISLEDCTRL=true"
NE1 05-02-20 06:44:05
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-37
Alarm Reporting Control (ARC)
The Alarm Reporting Control (ARC) feature supports inhibition of alarms on a per entity basis. When ARC
is enabled on an object instance, the reporting of the alarms, events and TCAs are stopped for all the
management interfaces. Hence, the ARC feature is based on the instance of the object and not on the
sessions. This feature is useful for performing maintenance in an alarm-free state. Table 4-24 on page 437 lists the AID types supported for ARC.
Table 4-24 AID Types supported for ARC
AID types
Description
10GbE
Refers to the 10GbE port
1GbE
Refers to the 1GbE port
10GCC
Refers to the 10GCC port
ALL
Refers to all managed entities
BAND
Refers to the BAND port
DCF
Refers to the dispersion compensation fiber
DTPCTP
Refers to the DTPCTP Channel
EQPT (OMM/OAM/FAN/PEM/BMM/DLM/
TAM/TOM/MCM/Chassis)
Refers to the equipment indicated by the AID in the message
FXFR
Refers to File Transfer
NTP
Refers to the Network Timing Protocol
OC192
Refers to the OC192 port
OC48
Refers to the OC48 port
OCG
Refers to the Optical Channel Group
OCH
Refers to the Optical Channel
OSC
Refers to the Optical Supervisory Channel
OTS
Refers to the OTS port
SNC
Refers to the Sub-Network Connection
STM16
Refers to all the STM16 port
STM64
Refers to all the STM64 port
SYS
Refers to the System
FFP
Refers to FFP Trib port
NCT
Refers to the NCT port.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-38
Alarm Reporting Control (ARC)
OPR-ARC (Inhibit Reporting Alarms/Events)
Command Description
This command is used to inhibit reporting of alarms and events on a per managed entity basis or per
instance basis.
Command Syntax
OPR-ARC{EQPT|OC192|OC48|OCH|OCG|DTPCTP|OTS|BAND|STM64|STM16|10GBE|OSC|TRIB|DCF|NTP|SY
S|SNC|NCT|1GBE|10GCC|FXFR}:[<TID>]:<AID>:<CTAG>::[NEND|FEND];
Table 4-25 OPR-ARC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Provisioning, Test and
Turn-up
Pre-condition
None
Post-condition
None
Related Commands
RLS-ARC (Release-Alarm Reporting Control)
RTRV-ARC (Retrieve-Alarm Reporting Control)
Response Format
Standard
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA (See
Table 2-6 on page 2-14).
Table 4-26 OPR-ARC Command Parameters Description
Parameter
AID
Description
Managed entity for
which alarm reporting
will be inhibited
Valid Range
Default
See Table 1-2 on
page 1-9.
Mandatory
NEND: Near End This is to specify local
SNC
Not Applicable
Example:1-A-6-T4-1
LOCN
TL1 User Guide
Location of SNC.
Parameter applicable
only for OPR-ARCSNC.
Release 1.2
FEND: Far End - This
is to specify Remote
SNC
UTStarcom Inc.
Fault Management
Page 4-39
Example
Use the following command to inhibit reporting of alarms and events on a per managed entity basis or per
instance basis.
OPR-ARC-TRIB::1-A-6-T4-1:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:45:04
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-40
Alarm Reporting Control (ARC)
RLS-ARC (Release-Alarm Reporting Control)
Command Description
This command instructs the network element to release the Alarm Reporting Control (ARC) mode and
resume normal reporting of alarms and events. ARC affects all OS/network element and user sessions.
Command Syntax
RLS-ARC{EQPT|OC192|OC48|OCH|OCG|DTPCTP|OTS|BAND|STM64|STM16|10GBE|OSC|TRIB|DCF|NTP|SY
S|SNC|NCT|1GBE|10GCC|FXFR}:[<TID>]:<AID>:<CTAG>::[NEND|FEND];
Table 4-27 RLS-ARC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Test and Turn-up, Provisioning
Pre-condition
None
Post-condition
When ARC is released, alarms and events that were raised while
ARC was in operation and not subsequently cleared are reported.
Only events that are standing conditions are reported.
Transient conditions, such as threshold crossing alerts are not
reported when ARC is released.
Related Commands
OPR-ARC (Inhibit Reporting Alarms/Events)
RTRV-ARC (Retrieve-Alarm Reporting Control)
Response Format
Standard
Error Codes
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA (See
Table 2-6 on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Fault Management
Page 4-41
Table 4-28 RLS-ARC Command Parameters Description
Parameter
Description
AID
Managed entity for which alarm
reporting inhibition should be
released
LOCN
Location of SNC. Parameter applicable only for RLS-ARC-SNC.
Valid Range
Default
See Table 1-2 on page 1-9.
Mandatory
NEND: Near End - This is to
specify local SNC
Not Applicable
Example:1-A-6-T4-1
FEND: Far End - This is to
specify Remote SNC
Example
Use the following command to instruct a network element to release the Alarm Reporting Control modes
and resume normal reporting of alarms and events.
RLS-ARC-TRIB::1-A-6-T4-1:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:46:11
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-42
Alarm Reporting Control (ARC)
RTRV-ARC (Retrieve-Alarm Reporting Control)
Command Description
This command is used to view the ARC state of the entity specified by the AID.
Command Syntax
RTRV-ARC{EQPT|OC192|OC48|OCH|OCG|DTPCTP|OTS|BAND|STM64|STM16|10GBE|OSC|TRIB|DCF|NTP|SY
S|SNC|NCT|1GBE|10GCC|FXFR}:[<TID>]:[<AID>]:<CTAG>::[NEND|FEND];
Table 4-29 RTRV-ARC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
Upon successful completion, the ARC state of the specified entity
is retrieved.
Related Commands
OPR-ARC (Inhibit Reporting Alarms/Events)
RLS-ARC (Release-Alarm Reporting Control)
Response Format
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"[<aid>][,<aidtype>]:<arcmode>" <cr> <lf>
Error Codes
TL1 User Guide
Release 1.2
ICNC, IIAC, IICM, IICT, IIFM, IITA, ISCH, PICC, PLNA (See
Table 2-6 on page 2-14).
UTStarcom Inc.
Fault Management
Page 4-43
Table 4-30 RTRV-ARC Command Parameters Description
Parameter
Description
Valid Range
Default
AID
AID of the managed entity for which
alarm reporting inhibition is to be
viewed
See Table 1-2 on page 1-9.
Not Applicable
LOCN
Location of SNC. Parameter applicable only for RTRV-ARC-SNC.
NEND: Near End - This is to
specify local SNC
Not Applicable
Example:1-A-6-T4-1
FEND: Far End - This is to
specify Remote SNC
Table 4-31 RTRV-ARC Response Parameters Description
Parameter
Description
AID
AID of the managed entity for
which alarm reporting inhibition is
viewed
AIDTYPE
AIDTYPE of the managed entity
for which alarm reporting inhibition is viewed
ARCMODE
The state of the ARC present on
the network element (RLS or
IND).
LOCN
Location of SNC. Parameter
applicable only for RTRV-ARCSNC.
Example
Use the following command to view the ARC state of the entity.
RTRV-ARC-EQPT::2-A-2:ctag;
Output
The following message is returned indicating successful completion
NE1 05-02-20 06:47:16
M
ctag COMPLD
"2-A-2,EQPT:RLS"
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 4-44
Alarm Reporting Control (ARC)
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
CHAPTER 5
Equipment and Facility Management
The UTStarcom TN780 and Optical Line Amplifier network elements provide extensive equipment
inventory and management capabilities that conform to the telecommunications standards such as
Telcordia GR-1089, GR-199, GR-1093, GR-833 and M.3100. This chapter describes the TL1 commands
used for equipment inventory and management in the following sections:
Configuring Network Element
Configuring Circuit Pack and Termination Point
Configuring Network Topology
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-2
Configuring Network Element
Configuring Network Element
The TL1 interface provides system level commands to configure the network element. Following are some
of the key functions that are configured through the system level commands:
Management IP addresses which include Craft IP address assigned to the Craft Ethernet interface
on the active MCM circuit pack on the main chassis in a multi-chassis configuration, Aux port IP
address assigned to the AUX port to provide Datawire application.
Enable or disable the GNE (Gateway Network Element) proxy function on the node. Refer to the
UTStarcom TN780 System Description manual for a detailed description of the GNE functionality
and also guidelines for enabling or disabling this function in a given network element.
System date and time stamps on alarms and events to support fault tracing and localization.
The System ID (SID) used in the TL1 response messages.
The following sections describe the TL1 commands used to configure and view the attributes of the
network element:
ED-SYS (Edit-System)
ED-DAT (Edit-Date and Time)
RTRV-SYS (Retrieve-System)
RTRV-HDR (Retrieve-Header)
SET-SID (Set Source Identifier)
ED-NTP (Edit-Network Timing Protocol)
RTRV-NTP (Retrieve-NTP)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-3
ED-SYS (Edit-System)
Command Description
This command is used to configure the network element attributes such as management IP addresses,
GNE capability and so on.
Command Syntax
ED-SYS:
[<TID>]::<CTAG>:::[<LABEL=<label>][,<NETYPE=AD|DON|DT|DR>][,<CLLI=<clli>][,<L
OCATION=location>][,<LOCATION2=location2>][,<LATITUDE=latitude>][,<LONGITUDE=
longitude>][,<CRAFTIP=craftip>][,<CRAFTIPNETMASK=craftipnetmask>][,<GNE=Enabl
ed,Disabled>][,<AUXIP=auxip>][,<AUXMASK=<auxmask>][,<PRIMGNEADDR=primgneaddr>
][,<SECGNEADDR=secgneaddr>];
Table 5-1 ED-SYS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
None
Related commands
ED-DAT (Edit-Date and Time)
RTRV-SYS (Retrieve-System)
RTRV-HDR (Retrieve-Header)
Response Format
Standard
Error codes
IDNV, IIFM, IICT, SNVS (See Table 2-6 on page 2-14).
Table 5-2 ED-SYS Command Parameters Description
Parameter
Description
Valid Range/Values
Default
LABEL
A label that identifies the network element. The label can be changed at
any time.
String of 128 characters
Not Applicable
NETYPE
The type of the network element
AD, OA, DON, DT, DR
DON for DTC
OA for OTC
CLLI
UTStarcom Inc.
Common Language Location Identifier (CLLI) is a 20-character standardized geographic identifier that
uniquely identifies the functional category of the equipment.
String of 128 characters
Not Applicable
TL1 User Guide
Release 1.2
Page 5-4
Configuring Network Element
Table 5-2 ED-SYS Command Parameters Description
Parameter
Description
Valid Range/Values
Default
LOCATION
The location of the network element.
String of 255 characters
Not Applicable
LOCATION2
The location 2 of the network element
String of 255 characters
Not Applicable
LATITUDE
The latitude where the network element is located, measured in
degrees.
String of 255 numbers
Not Applicable
LONGITUDE
The longitude where the network element is located, measured in
degrees.
String of 255 numbers
Not Applicable
CRAFTIP
IP address assigned to the craft
Ethernet port on the active MCM
circuit pack on the main chassis.
IP Address
192.168.0.1
This IP address is configured during
turn-up and initialization of the network element using CCLI. It can be
modified later.
CRAFTIPNETMASK
The IP netmask of the craft Ethernet
port.
IP Address
255.255.255.0
GNE
Specifies whether the target network
element is allowed to provide gateway proxy functionality. Enabling this
function on a given network element
allows a management station to communicate with other network elements
within the same signaling domain
through the given network element.
Enabled, Disabled
Enabled
AUXIP
IP address assigned to the AUX port
used to provide Datawire application.
IP Address
Not Applicable
AUXMASK
The IP netmask of the AUX interface.
IP Address
Not Applicable
PRIMGNEADDR
The primary GNE IP address
IP Address
Not Applicable
SECGNEADDR
The secondary GNE IP address
IP Address
Not Applicable
Example
Use the following command to configure the location of the network element.
ED-SYS:::ctag:::LABEL=UTSTARCOM;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 06:50:05
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
M
Page 5-5
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-6
Configuring Network Element
SET-SID (Set Source Identifier)
Command Description
This command is used to set the Source Identifier of the network element.
Command Syntax
SET-SID:[<TID>]::<CTAG>::<sid>;
Table 5-3 SET-SID Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
- The SID of the network element changes to the value of the
parameter SID for all subsequent autonomous messages and
responses.
- The TID of the network element for the subsequent commands
through the GNE changes to the value of the SID parameter.
Related commands
ED-SYS (Edit-System)
RTRV-SYS (Retrieve-System)
RTRV-HDR (Retrieve-Header)
Response Format
Standard
Error codes
IDNV, IIFM, IICT, SNVS (See Table 2-6 on page 2-14).
Table 5-4 SET-SID Command Parameters Description
Parameter
SID
Description
Source Identifier of the network element
Valid Range/Values
String of 20 characters
Default
Mandatory
Example
Use the following command to set the Source Identifier of the network element.
SET-SID:::ctag::UTSTARCOM;
Output
The following message is returned indicating successful completion.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-7
UTSTARCOM 05-02-20 06:51:50
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-8
Configuring Network Element
ED-DAT (Edit-Date and Time)
Command Description
This command changes the current date and time on a target network element to a specified value. The
target network element’s internal clock maintains the current date and time based on this value. The
current date and time values are used as timestamps in the header of the response message and also in
alarms and events generated by the network element. The network elements can also be configured to
derive their current time from an external source using Network Time Protocol (NTP). This is the preferred
method as it ensures that all the network elements within a management domain are synchronized to the
same clock. Refer ED-NTP (Edit-Network Timing Protocol) for NTP service configuration.
Command Syntax
ED-DAT:[<TID>]::<CTAG>::[<DATE>],[<TIME>];
Table 5-5 ED-DAT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
The command immediately changes the current date and time in the
system. The new date and time is used as the timestamp in the
response message header, alarms and events generated by the network element. If this change occurs in the middle of performance monitoring period, the PM counters for this period will be marked invalid.
Related commands
ED-SYS (Edit-System)
RTRV-SYS (Retrieve-System)
RTRV-HDR (Retrieve-Header)
ED-NTP (Edit-Network Timing Protocol)
Response Format
Standard
Error codes
IDNV, IIFM, IICT, SNVS. (See Table 2-6 on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-9
Table 5-6 ED-DAT Command Parameter Description
Parameter
DATE
TIME
Description
Valid Range
The current date value. The format for
this parameter is YY-MM-DD, where YY
specifies the year, MM specifies the
month, and DD specifies the date.
The year value range: 00 to 25
The current time value. The format for
this parameter is HH-MM-SS, where HH
specifies the hour, MM specifies the
minutes, and SS specifies the seconds.
This parameter specifies the time
using a 24 hour format.
The month value range: 01 to 12
Default
Not Applicable
The date value range: 01 to 31
00-00-00
The hours range: 00 to 23
The minutes range: 00 to 59
The seconds range: 00 to 59
Example
Use the following command to set the date and time of the system.
ED-DAT:::ctag::05-02-20,06-54-05;
Output
The following message is returned indicating successful completion.
IP ctag
<
UTSTARCOM 05-02-20 06:54:05
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-10
Configuring Network Element
RTRV-SYS (Retrieve-System)
Command Description
This command is used to view the attributes of the network element.
Command Syntax
RTRV-SYS:[<TID>]::<ctag>;
Table 5-7 RTRV-SYS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
Not applicable
Related commands
ED-DAT (Edit-Date and Time)
ED-SYS (Edit-System)
RTRV-HDR (Retrieve-Header)
Response Format
Standard
Error codes
None
Table 5-8 RTRV-SYS Response Parameters Description
Parameter
Description
LABEL
A label used to identify the target network element. The label can be
changed at any time (See Table 5-2 on page 5-3)
CLLI
Location code of the network element (See Table 5-2 on page 5-3)
NENAME
The Name of Network element
NETYPE
The type of the network element
NODEID
The node ID of the network element
LOCATION
The location of the network element (See Table 5-2 on page 5-3)
LOCATION2
The location2 of the network element (See Table 5-2 on page 5-3)
LATITUDE
The latitude where the network element is located, in degrees (See
Table 5-2 on page 5-3)
LONGITUDE
The longitude where the network element is located, in degrees (See
Table 5-2 on page 5-3)
The DCN IP address on the network element (See Table 5-2 on page 5-
DCNIP
3)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-11
Table 5-8 RTRV-SYS Response Parameters Description
Parameter
Description
SYSDATE
System Date
SYSTIME
System Time
DBVERS
The database version present on the network element
SWVERSION
The active Software version present on the network element
ROUTERID
The IP Address of the router ID
TL1PORT
The TL1 port number
DCNDEST
DCN Destination IP address
DCNGTWY
DCN Gateway IP address
DCNDESTPREFIXLEN
DCN Destination Prefix Length
DCNGLOBALROUTE
DCN Global Route
SWBUILDINFO
Software Build Information
XMLPROXYPORT
XML Proxy Port number
FTPPROXYPORT
FTP Proxy Port
TNETPROXYPORT
The Telnet Proxy Port
HTTPPROXYPORT
HTTP Proxy Port
DCNIPNETMASK
The netmask of the DCNIP. It can take the value: xxx.xxx.xxx.xxx
CRAFTIP
The IP Address of the Craft Interface (See Table 5-2 on page 5-3)
CRAFTIPNETMASK
The netmask of the Craft Interface (See Table 5-2 on page 5-3)
GNE
Flag indicating if the network element is GNE capable (See Table 5-2 on
page 5-3)
AUXIP
IP address assigned to the AUX port used to provide Datawire application
(See Table 5-2 on page 5-3)
AUXMASK
The IP netmask of the AUX interface (See Table 5-2 on page 5-3)
SYSACTIVEDATE
The system active date
SYSACTIVETIME
The system active time
PRIMGNEADDR
Primary GNE IP address (See Table 5-2 on page 5-3)
SECGNEADDR
Secondary GNE IP address (See Table 5-2 on page 5-3)
AVAILABLEPERSISTENTSPACE
The persistent available space in bites on the nodecontroller active MCM
TOTALPERSISTENTSPACE
The persistent Total space in bites on the nodecontroller active MCM
Example
Use the following command to view the attributes of the network element.
RTRV-SYS:::ctag;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-12
Configuring Network Element
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 06:55:03
M
ctag COMPLD
"::LABEL=UTSTARCOM,NENAME=UTSTARCOM,CLLI=,NETYPE=DON,NODEID=MA3204120428,LOCAT
ION=,LOCATION2=,LATITUDE=,LONGITUDE=,SYSDATE=2005-02-20,SYSTIME=06-5502,SYSACTIVEDATE=2005-02-18,SYSACTIVETIME=13-5935,DBVERS=R1.2.0.0223_20050218132857,SWVERSION=R1.2.0.0223,ROUTERID=100.100.8.
91,DCNIP=10.10.8.91,DCNIPNETMASK=255.255.254.0,CRAFTIP=192.168.0.1,CRAFTIPNETM
ASK=255.255.255.0,GNE=ENABLED,TL1PORT=9090,AUXIP=172.168.0.1,AUXMASK=255.255.2
55.0,PRIMGNEADDR=100.100.8.80,SECGNEADDR=0.0.0.0,DCNDEST=10.0.0.0,DCNGTWY=10.1
0.9.2,DCNDESTPREFIXLEN=8,DCNGLOBALROUTE=false,SWBUILDINFO=R1.2.0.0223,XMLPROXY
PORT=15073,FTPPROXYPORT=10021,TNETPROXYPORT=10023,HTTPPROXYPORT=10080,AVAILABL
EPERSISTENTSPACE=668776448,TOTALPERSISTENTSPACE=834534912"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-13
RTRV-HDR (Retrieve-Header)
Command Description
This command is used to request the network element to return the header information of a TL1 response
message. The TL1 response message indicates the status of the network element and help to keep the
TL1 session active.
Command Syntax
RTRV-HDR:[<TID>]::<ctag>;
Table 5-9 RTRV-HDR Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related commands
ED-DAT (Edit-Date and Time)
ED-SYS (Edit-System)
RTRV-SYS (Retrieve-System)
Response Format
Standard
Error codes
None
Example
Use the following command to view the header information of a TL1 response message.
RTRV-HDR:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 10:15:59
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-14
Configuring Network Element
ED-NTP (Edit-Network Timing Protocol)
Command Description
This command is used to configure the Network Timing Protocol (NTP) server IP Address. The NTP server
is used as a common source for deriving the date and time.
Command Syntax
ED-NTP:[<TID>]::<ctag>:::<NTPADDR=ntpaddr>;
Table 5-10 ED-NTP Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
If the NTP server IP address is configured as 0.0.0.0, time is derived
the local network element time.
When NTP servers are configured correctly to an IP address other than
0.0.0.0, the time is derived from the NTP server.
Related commands
ED-DAT (Edit-Date and Time)
RTRV-SYS (Retrieve-System)
RTRV-NTP (Retrieve-NTP)
Response Format
Standard
Error codes
IDNV, IIFM, IICT, SNVS (See Table 2-6 on page 2-14).
Table 5-11 ED-NTP Command Parameter Description
Parameter
NTPADDR
Description
IP address of the NTP server
Valid Range
xxx.xxx.xxx.xxx
Default
None
Example
Use the following command to configure the NTP server.
ED-NTP:::ctag:::ntpaddr=10.10.8.80;
Output
The following message is returned indicating successful completion.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-15
UTSTARCOM 05-02-20 06:57:02
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-16
Configuring Network Element
RTRV-NTP (Retrieve-NTP)
Command Description
This command is used to view the NTP server details.
Command Syntax
RTRV-NTP:[<TID>]::<ctag>;
Table 5-12 RTRV-NTP Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
None
Related commands
ED-DAT (Edit-Date and Time)
RTRV-SYS (Retrieve-System)
ED-NTP (Edit-Network Timing Protocol)
Response Format
Standard
Error codes
IDNV, IIFM, IICT, SNVS (See Table 2-6 on page 2-14)
Table 5-13 RTRV-NTP Response Parameters Description
Parameter
NTPADDR
Description
IP address of the NTP server. It can take the value xxx.xxx.xxx.xxx
Example
Use the following command to view the NTP server details.
RTRV-NTP:::ctag;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-17
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 06:57:02
M
ctag COMPLD
"::NTPADDR=10.10.8.80"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-18
Configuring Circuit Pack and Termination Point
Configuring Circuit Pack and Termination
Point
As described in Managed Entities and AID Overview, network elements can define several managed
entities, such as chassis, circuit packs and termination points associated with each circuit pack. To meet
diverse operational needs, network elements provide two modes of configuring the equipment entities, as
described in the following sections:
Auto-configuring Equipment
Pre-configuring Equipment
The network elements support an equipment state model in compliance with GR-1093 standard. It is briefly
described in the following section. For a detailed description refer to UTStarcom TN780 System
Description manual.
Equipment State Model
The TL1 interface supports commands to create equipment (applicable for pre-configuring equipment),
delete equipment, view attributes and modify attributes for all of the managed equipment entities. The
following sections give a general description of the TL1 commands used to configure equipment:
ENT-EQPT (Enter-Equipment)
ED-EQPT (Edit-Equipment)
DLT-EQPT (Delete-Equipment)
RTRV-EQPT (Retrieve-Equipment)
The attribute values for the TL1 commands mentioned above depend on the hardware module type. The
following sections describe the commands specific to a given hardware module type. They also provide the
TL1 commands used to modify termination point attributes corresponding to the hardware module type.
Configuring BMM Circuit Pack and Termination Points
Configuring DLM Circuit Pack and Termination Point
Configuring TAM Circuit Pack and Termination Point
Configuring TOM Circuit Pack and Termination Point
Configuring MCM
Configuring OAM Circuit Pack and Termination Point
Configuring OMM
Auto-configuring Equipment
In this mode, the network element can automatically detect and configure the hardware modules when
present. Users need not create equipment using ENT-EQPT command. Instead, users can populate the
un-configured slots with the hardware modules and the network element can automatically configure the
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-19
equipment and the associated termination points with default values assigned to the attributes. Users can
modify the attributes using ED-EQPT command.
The removal of the auto-configured hardware module will not delete the equipment from the database.
Whether the hardware module is auto-configured or pre-configured, the user must use DLT-EQPT
command to delete the equipment.
Note: Equipment cannot be deleted if physically present.
Pre-configuring Equipment
In this mode users can pre-configure the hardware modules prior to their physical presence using ENTEQPT command. When the hardware is populated, the network element uses the pre-configured data to
configure the module. The network element generates an error message if the pre-configured hardware
module type does not match the hardware module inserted in the slot.
Table 5-14 on page 5-19 provides a list of hardware modules and the configuration type allowed on each
of them, auto-configuration and pre-configuration modes.
Table 5-14 Equipment Auto-configuration and Pre-configuration Capabilities
Equipment Type
Auto-configurable
Pre-configurable
Applicable TL1 Command set
BMM
Yes
Yes
ENT/ED/RTRV/DLT
DLM
Yes
Yes
ENT/ED/RTRV/DLT
MCM (Active Node
Controller)
Yes
No
ED/RTRV
MCM (Standby node
controller and Active/
Standby Shelf Controller)
Yes
Yes
ENT/ED/RTRV/DLT
TAM
Yes
Yes
ENT/ED/RTRV/DLT
TOM
Yes
Yes
ENT/ED/RTRV/DLT
OAM
Yes
Yes
ENT/ED/RTRV/DLT
OMM
Yes
Yes
ENT/ED/RTRV/DLT
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-20
Configuring Circuit Pack and Termination Point
Equipment State Model
The UTStarcom Digital Optical Networking system implements a state modeling which meets the various
needs of all the supported management applications and interfaces and also communicates
comprehensive state of the equipment and termination points.
Table 5-15 on page 5-20 lists the TL1 primary states, primary state qualifiers and a description of each of
the states.
Table 5-15 TL1 Primary States and Primary State Qualifiers
Primary State
Description
IS-NR
In Service - Normal
IS-ANR
In Service - Abnormal
OOS-AU
Out of Service - Automatic
OOS-MA
Out of Service - Manual
OOS-MAANR
Out of Service - Manual, Abnormal
OOS-AUMA
Out of Service - Autonomous, Manual
Table 5-16 on page 5-20 lists the TL1 secondary states and a description of each of the states.
Table 5-16 TL1 Secondary States and Secondary State Qualifier
Secondary
Description
FLT
Fault
FAF
Facility Failure
SGEO
Supporting Group Entity Outage
CEMA
Composite Entity OOS MA
TS
InTest
SWDL
Software Download
UEQ
Unequipped
MEA
Equipment Mismatch
MT
maintenance
STBYH
Standby
ACT
Active
LPBK
Loop back
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-21
ENT-EQPT (Enter-Equipment)
Command Description
This command is used to create an equipment in a given slot. Refer to Table 1-2 on page 1-9 for valid
equipment AIDs.
Command Syntax
ENTEQPT:[<TID>]:<AID>:<CTAG>::<ctype>:[<LABEL=label>][,<PROVTYPE=provtype>][,<RA
CKNAME=rackname>][,<PROVSERNO=provserno>][,<LOCNINRACK=locninrack>][,<PROVCHA
STYPE=provchastype>]:[IS|OOS];
Table 5-17 ENT-EQPT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
MCM/OMM cards should be provisioned first.
Standby MCM/OMM card can be put into the OOS state. Similarly, a
standby card can be brought into service by updating the state to IS.
Active MCM/OMM card cannot be edited OOS.
When a standby MCM/OMM is locked, activity switch (either manual
or automatic) cannot take place on the locked standby.
Post-condition
Equipment mismatch alarm is raised if the provisioned and installed
card types do not match.
Related Commands
ED-EQPT (Edit-Equipment)
DLT-EQPT (Delete-Equipment)
RTRV-EQPT (Retrieve-Equipment)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IPNC, IDNV, IDNC, IEAE, EQWT (See
Table 2-6 on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-22
Configuring Circuit Pack and Termination Point
Table 5-18 ENT-EQPT Command Parameters Description
Parameter
Description
Valid Range
Default
See Table 1-2 on page 1-9.
Mandatory
The provisioned circuit pack type
configured
BMM, DLM, TAM, TOM, OAM,
MCM, OMM, Chassis
Mandatory
LABEL
Name of the equipment
String of 128 characters
Not Applicable
PROVTYPE
Provisioned Equipment Type
Refer Table 5-19 on page 5-23
for the list of allowed Provisioned
Equipment Types
Not Applicable
PROVCHASTYPE
The type of Chassis that is currently installed on the network element. (This attribute is applicable
only if CTYPE is CHASSIS)
DTC, OTC
Not Applicable
RACKNAME
The name of the Rack where
Chassis is present. (This attribute
is applicable only if CTYPE is
CHASSIS)
String of 64 characters
Not Applicable
PROVSERNO
The provisioned serial number,
this represents one of detected
serial numbers when a chassis is
plugged in. For example:
PROVSERNO=123456789DTC.
(This attribute is applicable only if
CTYPE is CHASSIS)
String of 12 characters
Not Applicable
LOCNINRACK
The Location of the chassis in the
rack. (This attribute is applicable
only if CTYPE is CHASSIS)
String of 255 characters
Not Applicable
STATE
Primary state of the equipment
IS, OOS
IS
AID
AID of the equipment being created
CTYPE
Example: 1-A-7B
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-23
Table 5-19 on page 5-23 lists the allowed Provisioned Equipment Types.
Table 5-19 List of Allowed Provisioned Equipment Types
Circuit Pack Type
BMM
Allowed Provisioned Types
BMM-4-C1
BMM-4-C2
BMM-4-C3
BMM-4-C2-MS
BMM-4-C3-MS
BMM-4-C1-B
BMM-4-C2-MS-B
BMM-4-C3-MS-B
BMM-8-C1
BMM-8-C2-MS
BMM-8-C3-MS
DLM
DLM-1-C1
DLM-3-C1
DLM-5-C1
DLM-7-C1
DLM-2-C1
DLM-4-C1
DLM-6-C1
DLM-8-C1
OAM
OAM-C1
OAM-C2-MS
OAM-C3-MS
OAM-C1-B
OAM-C2-MS-B
OAM-C3-MS-B
TAM
TAM-2-10G
TAM-4-2.5G
TAM-4-1G
TOM
TOM-10G-SR1
TOM-10G-IR2
TOM-2.5G-SR1
TOM-2.5G-IR1
TOM-1G-LX
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-24
Configuring Circuit Pack and Termination Point
Table 5-19 List of Allowed Provisioned Equipment Types
Circuit Pack Type
MCM
Allowed Provisioned Types
MCM-A
MCM-B
Example
Use the following command to create an equipment in a given slot.
ENT-EQPT::2-A-1:c::BMM:PROVTYPE=BMM-4-C1:OOS;
Output
The following message is returned indicating successful completion.
IP ctag
<
UTSTARCOM 05-02-20 06:59:52
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-25
ED-EQPT (Edit-Equipment)
Command Description
This command is used to modify the parameters associated with the equipment in a given slot. Refer to
Table 1-2 on page 1-9 for valid equipment AIDs. Not all keywords are applicable for all types of circuit
packs. For details, refer to sections on the specific circuit packs.
Command Syntax
EDEQPT:[<TID>]:<AID>:<CTAG>::[<ctype>]:[<LABEL=label>][,<PROVTYPE=provtype>][,<
RACKNAME=rackname>][,<PROVSERNO=provserno>][,<LOCNINRACK=locninrack>][,<GAINC
ONTROLLOOP=ENABLE|DISABLE>][,<BAYALMREPT=ENABLE|DISABLE>]:[IS|OSS];
Table 5-20 ED-EQPT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
Standby MCM/OMM card can be put into the OOS state. Similarly, a
standby card can be brought into service by updating the state to IS.
Active MCM/OMM card cannot be edited OOS.
When a standby MCM/OMM is locked, activity switch (either manual
or automatic) cannot take place on the locked standby.
Post-condition
The modified parameters reflect on the equipment.
Related Commands
RTRV-EQPT (Retrieve-Equipment)
DLT-EQPT (Delete-Equipment)
ENT-EQPT (Enter-Equipment)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT (See Table 2-6
on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-26
Configuring Circuit Pack and Termination Point
Table 5-21 ED-EQPT Command Parameters Description
Parameter
Description
Valid Range
Default
See Table 1-2 on
page 1-9.
Mandatory
AID
AID of the equipment for which the
parameters are being modified
CTYPE
Provisioned circuit pack type
BMM, DLM, TAM, TOM,
OAM, OMM, MCM, Chassis
Not Applicable
LABEL
Name of the equipment
String of 128 characters
Not Applicable
PROVTYPE
Provisioned equipment type
Refer Table 5-19 on
page 5-23 for the list of
allowed Provisioned
Equipment Types
Not Applicable
RACKNAME
The name of the rack where the chassis
is present
String of 64 characters
Not Applicable
PROVSERNO
The provisioned serial number, this represents one of detected serial numbers
when a chassis is plugged in. For example: PROVSERNO=123456789DTC
This attribute is applicable to chassis
only
String of 12 characters
Not Applicable
LOCNINRACK
The location of the chassis in the rack
String of 255 characters
Not Applicable
GAINCONTROLLOOP
Enable or disable power control loop in
BMM
enable, disable
disable
BAYALMREPT
The flag to control the Bay Level Alarms
Reporting for this Chassis
enable, disable
enable
STATE
Primary state of the equipment
IS, OOS
OOS
Example: 1-A-7B
Note: Editing the Primary State (PST) of circuit pack like TOMS/TAMS/DLMS may result in a loss
of traffic.
Example
Use the following command to modify equipment (BMM circuit pack).
ED-EQPT::2-A-2:ctag::BMM:LABEL=BMM2;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-27
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:01:13
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-28
Configuring Circuit Pack and Termination Point
DLT-EQPT (Delete-Equipment)
Command Description
This command is used to delete the equipment. Refer to Table 1-2 on page 1-9 for valid equipment AIDs.
Command Syntax
DLT-EQPT:[<TID>]:<AID>:<CTAG>::[<ctype>];
Table 5-22 DLT EQPT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
The Main Chassis cannot be deleted.
Active MCM/OMM cannot be deleted only on the Main Chassis
Cross connects dependent on the equipment should not be present.
The equipment must be in OOS state and all the dependent entities
deleted.
Post-condition
If the command is successful, the equipment is deleted.
Related Commands
ED-EQPT (Edit-Equipment)
ENT-EQPT (Enter-Equipment)
RTRV-EQPT (Retrieve-Equipment)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14)
Table 5-23 DLT EQPT Command Parameters Description
Parameter
AID
Description
AID of the equipment
that is to be deleted
Valid Range
Default
See Table 1-2 on page 1-9.
Mandatory
BMM, DLM, TAM, TOM, OAM, MCM,
OMM.
Optional
Example: 1-A-4-4
CTYPE
Provisioned circuit pack
type. It is automatically
set depending on AID.
Example
Use the following command to delete equipment (BMM circuit pack).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-29
DLT-EQPT::2-A-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:02:05
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-30
Configuring Circuit Pack and Termination Point
RTRV-EQPT (Retrieve-Equipment)
Command Description
This command is used to view the parameters associated with the equipment in a given slot. The AID
“ALL” is supported. Refer to Table 1-2 on page 1-9 for valid equipment AIDs.
Command Syntax
RTRV-EQPT:[<TID>]:[<AID>]:<CTAG>::[<CTYPE>]:[<PROVSTATUS=PROV|UNPROV>];
Table 5-24 RTRV-EQPT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
Not applicable
Related commands
ED-EQPT (Edit-Equipment)
DLT-EQPT (Delete-Equipment)
ENT-EQPT (Enter-Equipment)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE
(See Table 2-6 on page 2-14).
Table 5-25 RTRV EQPT Command Parameters Description
Parameter
Description
Valid Range
Default
AID
AID of equipment
Chassis, BMM, DLM,
TAM, TOM, OAM, MCM,
OMM AIDs
All
CTYPE
Provisioned circuit pack type
Chassis, BMM, DLM,
TAM, TOM, OAM, MCM,
OMM
Optional
PROVSTATUS
Provisioned status of the chassis. This attribute is valid only if
CTYPE is CHASSIS.
PROV, UNPROV
Both PROV and
UNPROV chassis equipment
are retrieved.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-31
Table 5-26 RTRV-EQPT Response Parameters Description
Parameter
Description
AID
AID of the retrieved equipment
CTYPE
Provisioned equipment type
LABEL
Name of the equipment
INSTCTYPE
Installed equipment type
PARTNO
Equipment part number
SERIALNO
Equipment serial number
MFGDATE
Manufacturing date for the equipment
VENDID
Vendor ID of the equipment
CLEI
CLEI code for the equipment
HWVERSION
Hardware version for the equipment
SWVERSION
The active Software version present on the network element
BOOTTIME
Time when the equipment was last booted or rebooted
BOOTREAS
Reason for the last boot/reboot
INTEMP
Inlet temperature
RACKNAME
The name of the rack where the chassis is present
PROVSERNO
Provisioned Serial Number
LOCNINRACK
The location of the chassis in the rack
HOLDERTYPE
The type of holder
HOLDERSTATE
The state of the holder
CHASTYPE
The type of chassis
ACOSTATE
The state of the ACO on the chassis
GAINCONTROLLOOP
Flag for enabling the gain control loop
CURRGAIN
The current gain value
TARGAIN
The target gain value
LASTADJDATE
The last gain adjusted date by DAMP protocol
LASTADJTIME
The last gain adjusted time by DAMP protocol
FWVERS
Firmware version running on the card
SAFWUPG
Service Affecting Firmware Upgrade Flag to indicate whether an upgrade
is pending
PICDSPVERS
PIC DSP firmware version
PST
Primary state of the equipment
PSTQ
Primary state qualifier
SST
Secondary state
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-32
Configuring Circuit Pack and Termination Point
Example 1
Use the following command to view the parameters associated with the CHASSIS equipment type. This
example retrieves both provisioned and unprovisioned CHASSIS.
RTRV-EQPT:::ctag::CHASSIS;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:03:09
M
ctag COMPLD
"1:CHASSIS:LABEL=,CLEI=WMMPK00ERA,PARTNO=1100004310,SERNO=MA3204120428,HWVERS=
01,MFGDATE=122004,INTEMP=26.50C,RACKNAME=,PROVSERNO=MA3204120428,LOCNINRACK=1,
PROVCHASTYPE=DTC,ACOSTATE=DISABLE,BAYALMREPT=ENABLED:IS-NR"
"2:CHASSIS:LABEL=,CLEI=WMMPK00ERA,PARTNO=1100045100,SERNO=MA4104420026,HWVERS=
10,MFGDATE=422004,INTEMP=26.38C,RACKNAME=,PROVSERNO=MA4104420026,LOCNINRACK=1,
PROVCHASTYPE=DTC,ACOSTATE=DISABLE,BAYALMREPT=ENABLED:IS-NR"
":CHASSIS:SERNO=MA4104420028,PROVCHASTYPE=DTC:"
;
Example 2
This example retrieves BMM equipment.
RTRV-EQPT:::c::BMM;
Output
blr885 05-02-28 17:26:21
M
c COMPLD
"1-A-2:BMM:LABEL=,PROVTYPE=BMM-4-C2,INSTTYPE=BMM-4C2,CLEI=1010101010,PARTNO=1100012530,SERNO=MA4104170033,SWVERS=R1.2.0.0503,HWV
ERS=03,MFGDATE=172004,VENDID=,BOOTDATE=2005-02-28,BOOTTIME=17-1000,BOOTREAS=WARM,GAINCONTROLLOOP=ENABLED,CURRGAIN=20.7813,TARGAIN=20.735,LASTA
DJDATE=2005-02-28,LASTADJTIME=17-1003,FWVERS="CPLD:0x21,BMMFPGA:0x1e(0x1e),TXEDFA:3CN30036AAAA03(3CN30036AAAA03),
RXEDFA:3CN30037AAAA04(3CN30037AAAA04)",SAFWUPG=NONE:IS-NR"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-33
Example 3
This example retrieves DLM equipment.
RTRV-EQPT:::c::DLM;
Output
blr885 05-02-28 17:27:42
M
c COMPLD
"1-A-5:DLM:LABEL=,PROVTYPE=DLM-7-C2,INSTTYPE=DLM-7C2,CLEI=WMOTAWGMAA,PARTNO=1100064510,SERNO=MA1004153200,SWVERS=R1.2.0.0503,HW
VERS=17,MFGDATE=152004,VENDID=,BOOTDATE=2005-02-28,BOOTTIME=17-1026,BOOTREAS=WARM,PICDSPVERS="Fw:1.29(1.29),Fpga1:1.15(1.15),Fpga2:1.15(1.15)"
,FWVERS="CPLD:21,CNTL:25,MP:14(14)",SAFWUPG=NONE:IS-NR"
;
Example 4
This example retrieves TAM equipment.
RTRV-EQPT:::c::TAM;
Output
blr885 05-02-28 17:28:18
M
c COMPLD
"1-A-5-1:TAM:LABEL=,PROVTYPE=TAM-2-10G,INSTTYPE=TAM-210G,CLEI=WMUCAFAKAA,PARTNO=1100046310,SERNO=MA3204170987,HWVERS=01,MFGDATE=17
2004,VENDID=,FWVERS="CNTL:b1b(b1b),DJTR:aa15(aa15)",SAFWUPG=NONE:IS-NR"
;
Example 5
This example retrieves TOM equipment.
rtrv-eqpt:::c::TOM;
Output
blr885 05-02-28 17:28:50
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-34
M
Configuring Circuit Pack and Termination Point
c COMPLD
"1-A-5-1-1:TOM:LABEL=,PROVTYPE=TOM-10G-SR1,INSTTYPE=TOM-10GSR1,CLEI=WMOTAWHMAA,PARTNO=7120001001,SERNO=00000K6K04F8,HWVERS=01,MFGDATE=462
004,VENDID=:IS-NR"
"1-A-5-1-2:TOM:LABEL=,PROVTYPE=TOM-10G-SR1,INSTTYPE=TOM-10GSR1,CLEI=WMOTAWHMAA,PARTNO=7120001001,SERNO=00000K6K04G8,HWVERS=01,MFGDATE=462
004,VENDID=:IS-NR"
;
Example 6
This example retrieves MCM equipment.
RTRV-EQPT:::c::MCM;
Output
blr885 05-02-28 17:30:03
M
c COMPLD
"1-A7A:MCM:LABEL=,PROVTYPE=MCM,INSTTYPE=UNKNOWN,CLEI=,PARTNO=,SERNO=,SWVERS=,HWVER
S=,MFGDATE=,VENDID=,BOOTDATE=UNKNOWN,BOOTTIME=UNKNOWN,BOOTREAS=NONE:OOSAU,FLT"
"1-A-7B:MCM:LABEL=,PROVTYPE=MCM-A,INSTTYPE=MCMA,CLEI=WMUCAE9KAA,PARTNO=1100026530,SERNO=MA3204404249,SWVERS=R1.2.0.0503,HWVE
RS=07,MFGDATE=402004,VENDID=,BOOTDATE=2005-02-28,BOOTTIME=17-0012,BOOTREAS=WARM:IS-NR,ACT"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-35
Configuring BMM Circuit Pack and Termination Points
This section describes the TL1 command parameters and their values, specific to configuring the BMM
circuit pack.
Create BMM Circuit Pack
The BMM circuit pack is created using the ENT-EQPT command as shown below. The user can optionally
specify the state (In the following example, the equipment is created in IS state). If the state is not
specified, the BMM circuit pack is created in IS state.
ENT-EQPT::1-A-1:ctag::BMM:PROVTYPE=BMM-4-C2-MS:IS;
Table 5-27 on page 5-35 describes the pre-condition and post-condition.
Table 5-27 Create BMM circuit pack
Section
Description
Pre-condition
The Chassis should be provisioned first.
Post-condition
If the command is successful, it creates the BMM and the corresponding termination points.
If the command is not successful, the BMM circuit pack is not created. MEA alarm is
raised if the provisioned and installed card types do not match.
The creation of BMM circuit pack also creates the corresponding termination points.
The termination points are created with default values given to the attributes which can be changed using
the TL1 commands described in the following list.
ED-OTS (Edit-Optical Transport Section)
ED-OSC (Edit-Optical Supervisory Channel)
ED-OCG (Edit-Optical Carrier Group)
ED-BAND (Edit-Band)
ED-DCF (Edit-Dispersion Compensation Fiber)
The following commands can be used to view the corresponding termination points.
RTRV-OTS (Retrieve-Optical Transport Section)
RTRV-OSC (Retrieve-Optical Supervisory Channel)
RTRV-OCG (Retrieve-Optical Carrier Group)
RTRV-BAND (Retrieve-Band)
RTRV-DCF (Retrieve-Dispersion Compensation Fiber)
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-36
Configuring Circuit Pack and Termination Point
Delete BMM circuit pack
The BMM circuit pack is deleted using the DLT-EQPT command as shown below. However, user should
meet the pre-conditions as described in Table 5-28 on page 5-36.
DLT-EQPT::1-A-1:ctag;
Table 5-28 Delete BMM circuit pack
Section
Description
Pre-condition
BMM must be in OOS
Post-condition
The BMM circuit pack and all the dependent entities are deleted.
The BMM FRU must not be equipped.
Refer to Table 5-24 on page 5-30 for command parameters description.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-37
ED-OTS (Edit-Optical Transport Section)
Command Description
This command is used to modify the parameters of the physical termination point of the Optical Transport
Section on the BMM circuit pack.
Command Syntax
EDOTS:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<TXFIBERTYPE=txfibertype>];
Table 5-29 ED-OTS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The BMM/OAM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related Commands
RTRV-OTS (Retrieve-Optical Transport Section)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-30 ED-OTS Command Parameters Description
Parameter
AID
Description
Valid Range
Default
Physical line side port on the
BMM
<Chassis>-<Service Shelf><BMMSlot>-<LinePort>
Example: 1-A-2-L1
where
Mandatory
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<LinePort> = L1
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-38
Configuring Circuit Pack and Termination Point
Table 5-30 ED-OTS Command Parameters Description
Parameter
Description
Valid Range
Default
LABEL
Name of the termination
point
String of 128 characters
Not Applicable
TXFIBERTYPE
The transmit fiber type
SMF, ELEAF, Lucent True Wave
Reduced Slope, Lucent True
Wave Classic, LS, DSF, Pre
1993 SMF, Original LEAF,
Lucent True Wave Plus, MetroCore, Lucent Allwave, Silica
Core Fiber, Alcatel TerraLight
Not Applicable
Example
Use the following command to modify the parameters of OTS termination point.
ED-OTS::2-A-2-L1:ctag:::LABEL=OTS2;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:04:15
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-39
ED-OSC (Edit-Optical Supervisory Channel)
Command Description
This command is used to modify the parameters of the Optical Supervisory Channel termination point on
the BMM/OAM circuit pack.
Command Syntax
EDOSC:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<ADDR=addr>][,<NETMASK=netmask>][
,<OSPFCOST=ospfcost>][,<OSPFHELLOINT=ospfhelloint>][,<OSPFDEADINT=ospfdeadint
>][,<OSPFENABLE=TRUE|FALSE>][,<TECOST=tecost>][,<HISTSTATS=enable|disable>];
Table 5-31 ED-OSC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The BMM/OAM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-OSC (Retrieve-Optical Supervisory Channel)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14).
Table 5-32 ED-OSC Command Parameters Description
Keyword
AID
Description
Optical Supervisory Channel termination
Example: 1-A-1-O1
Valid Range
Default
<Chassis>-<Service
Shelf>-<BMMSlot><OSCPort>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<OSCPort> = {O1}
LABEL
Name of the termination point
String of 128 characters
Not Applicable
ADDR
IP Address of the OSC
xxx.xxx.xxx.xxx
Not Applicable
NETMASK
Netmask of the OSC
xxx.xxx.xxx.xxx
Not Applicable
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-40
Configuring Circuit Pack and Termination Point
Table 5-32 ED-OSC Command Parameters Description
OSPFCOST
Cost of the OSPF
1 to 8000
100
OSPFENABLE
Flag indicating if the OSPF routing is
enabled or not
true,false
false
TECOST
Cost of the TE link
1 to 8000
100
OSPFHELLOINT
OSPF Hello Interval
10 to 1200
30
OSPFDEADINT
OSPF Dead Interval
30 to 3600
300
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
enable, disable
enable
Example
Use the following command to modify the parameters of OSC termination point.
ED-OSC::2-A-2-o1:ctag:::LABEL=OSC2;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:05:10
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-41
ED-OCG (Edit-Optical Carrier Group)
Command Description
This command is used to modify the parameters of the Optical Channel Group termination point on the
BMM or the DLM circuit pack.
Command Syntax
EDOCG:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<PROVDLM=provdlm>][,<TECTRL=enabl
e|disable>][,<HISTSTATS=enable|disable>]:[IS|OOS];
Table 5-33 ED-OCG Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured to
edit the BMM OCG termination point.
The DLM circuit pack should be pre-configured or auto-configured to
edit the DLM OCG termination point.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-OCG (Retrieve-Optical Carrier Group)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14).
Table 5-34 ED-OCG Command Parameters Description
Keyword
AID
Description
Valid Range
Default
Optical Channel Group ports on the
BMM
<Chassis>-<Service
Shelf>-<Slot>-<OCG>
Example: 1-A-2-T8
where
Optical Channel Group ports on the
DLM
<Chassis> = {1-6}
Example: 1-A-3-L1
<Slot> = {1-2} for BMM
Mandatory
<ServiceShelf> = {A}
<Slot> = {3-6} for DLM
<OCG> = {T1-T8} for
BMM
<OCG>={L1} for DLM
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-42
Configuring Circuit Pack and Termination Point
Table 5-34 ED-OCG Command Parameters Description
LABEL
Name of the termination point
String of 128 characters
Not Applicable
PROVDLM
The provisioned DLM for this BMM
OCG TP. This keyword is applicable to
OCG on BMM only.
valid DLM AID
Not Applicable
TECTRL
This flag indicates if the OCG participates in the TE link or not. This is applicable to only DLM.
enable, disable
enable
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
enable, disable
enable
STATE
State
IS, OOS
Not Applicable
Note: OCG Present on the BMM cannot be put into Locked or Maintenance states OCG Present
on the DLM can be put into Locked state.
Note: Locking a DLM OCG will not affect the data plane traffic but will not guarantee the service.
Note: For BMM OCG facility, the explicit value of NULL for PROVDLM will disassociate a BMM
from DLM.
Example
Use the following command to modify the parameters of OCG termination point.
ED-OCG::2-A-2-T1:ctag:::LABEL=OCG1,PROVDLM=1-A-5;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:05:58
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-43
ED-BAND (Edit-Band)
Command Description
This command is used to modify the parameters of the C band termination point on the BMM circuit pack.
Command Syntax
ED-BAND:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>];
Table 5-35 ED-BAND Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-BAND (Retrieve-Band)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-36 ED-BAND Command Parameters Description
Keyword
AID
Description
L-Band and C-Band termination point
Example:1-A-1-C
Range
Default
<Chassis>-<Service
shelf>-<BMMSlot><Band>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<Band> = {C (for Cband)}
LABEL
Name of the termination point
String of 128 characters
Not Applicable
Example
Use the following command to modify the parameters of BAND termination point.
ED-BAND::2-A-2-C:ctag:::LABEL=CBAND;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-44
Configuring Circuit Pack and Termination Point
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:06:41
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-45
ED-DCF (Edit-Dispersion Compensation Fiber)
Command Description
This command is used to modify the parameters of the Dispersion Compensation Fiber (DCF) termination
point on the BMM circuit pack.
Command Syntax
ED-DCF:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<DCMTYPE=dcmtype>]
Table 5-37 ED-DCF Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-DCF (Retrieve-Dispersion Compensation Fiber)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14).
Table 5-38 ED-DCF Command Parameters Description
Keyword
AID
Description
Dispersion Compensation Fiber port
Example: 1-A-2-D1
Range
Default
<Chassis>-<Service shelf><BMMSlot>-<DCFPort>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<BMMSlot> = {1-2}
<DCFPort> = {D1}
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-46
Configuring Circuit Pack and Termination Point
Table 5-38 ED-DCF Command Parameters Description
DCMTYPE
The DCM type
DCM1H-100N-A
Not Applicable
DCM1H-200N-A
DCM1H-300N-A
DCM1H-400N-A
DCM1H-500N-A
DCM1H-600N-A
DCM1H-700N-A
DCM1H-800N-A
DCM1H-900N-A
DCM1H-1000N-A
DCM1H-1100N-A
DCM1H-1200N-A
DCM1H-1300N-A
DCM1F-1400N-A
DCM1F-1500N-A
DCM1F-1600N-A
DCM1F-1700N-A
DCM1F-1800N-A
DCM1F-1900N-A
DCM1H-100P-A
DCM1H-200P-A
DCM1F-300P-A
DCM1F-400L-A
Unspecified
LABEL
Name of the termination point
String of 128 characters
Not Applicable
Example
Use the following command to modify the parameters of DCF termination point.
ED-DCF::2-A-2-D1:CTAG:::LABEL=DCF2;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:07:19
M
CTAG COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-47
RTRV-OTS (Retrieve-Optical Transport Section)
Command Description
This command is used to view the parameters of OTS termination point on the BMM circuit pack.
Command Syntax
RTRV-OTS:[<TID>]:[<AID>]:<ctag>;
Table 5-39 RTRV-OTS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-OTS (Edit-Optical Transport Section)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-40 RTRV-OTS Response Parameters Description
Parameter
Description
AID
AID of OTS facility
LABEL
Name of the termination point
TXFIBERTYPE
Fiber Type of Transmit Fiber
RXFIBERTYPE
Fiber Type of Receive Fiber
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example
Use the following command to view the parameters of OTS termination point.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-48
Configuring Circuit Pack and Termination Point
RTRV-OTS::2-A-2-L1:CTAG;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:08:13
M
CTAG COMPLD
"2-A-2-L1:OTS:LABEL=OTS2,TXFIBERTYPE=SMF,RXFIBERTYPE=SMF:OOS-AU,FAF&SGEO"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-49
RTRV-OSC (Retrieve-Optical Supervisory Channel)
Command Description
This command is used to view the parameters of Optical Supervisory Channel termination point on the
BMM circuit pack.
Command Syntax
RTRV-OSC:[<TID>]:[<AID>]:<ctag>;
Table 5-41 RTRV-OSC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test
and Turn-up, Monitoring Access, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-OSC (Edit-Optical Supervisory Channel)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14).
Table 5-42 RTRV-OSC Response Parameters Description
Parameter
Description
AID
AID of OSC facility
LABEL
Name of the termination point
ADDR
IP address of the OSC
NETMASK
Netmask of the OSC
OSPFCOST
Cost of the OSPF
OSPFHELLOINT
OSPF hello interval
OSPFDEADINT
The value of OSPF dead interval
OSPFENABLE
Flag indicating if OSPF routing is enabled or not
TECOST
Cost of the TE link
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-50
Configuring Circuit Pack and Termination Point
Table 5-42 RTRV-OSC Response Parameters Description
Parameter
Description
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example
Use the following command to view the parameters of the OSC termination point.
RTRV-OSC::2-A-2-O1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:08:50
M
ctag COMPLD
"2-A-2O1:OSC:LABEL=OSC2,ADDR=20.20.20.80,NETMASK=255.255.255.0,OSPFCOST=100,OSPFHELL
OINT=30,OSPFDEADINT=300,OSPFENABLE=true,TECOST=100,HISTSTATS=ENABLED:OOSAU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-51
RTRV-OCG (Retrieve-Optical Carrier Group)
Command Description
This command is used to view the parameters of OCG termination point on the BMM/DLM circuit pack.
Command Syntax
RTRV-OCG:[<TID>]:[<AID>]:<CTAG>;
Table 5-43 RTRV-OCG Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test
and Turn-up, Monitoring Access, Provisioning
Pre-condition
The BMM/DLM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-OCG (Edit-Optical Carrier Group)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14).
Table 5-44 RTRV-OCG Response Parameters Description
Keyword
Description
AID
AID of the OCG facility
LABEL
Name of the Facility
PROVDLM
The provisioned DLM for this BMM OCG TP.
DISCDLM
Discovered DLM (using auto discovery) for the corresponding BMM OCG TP.
This keyword is applicable to OCG on BMM only.
HISTSTATS
Historical Stats Flag Applicable to only BMM OCG.
TECTRL
This flag indicates if the OCG participates in the TE Link or not.
RMTOCG
Discovered Remote BMM OCG facility to which this OCG is connected.
OCGNUM
The OCG number for this OCG
AUTODISCSTATE
The state of the auto discovery for this OCG.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-52
Configuring Circuit Pack and Termination Point
Table 5-44 RTRV-OCG Response Parameters Description
Keyword
Description
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example1
Use the following command to view the parameters of BMM OCG termination point.
RTRV-OCG::1-A-1-T1:ctag;
Output
The following message is returned indicating successful completion.
NC36 05-02-24 10:17:01
M
ctag COMPLD
"1-A-1-T1:OCG:LABEL=,PROVDLM=,DISCDLM=,OCGNUM=1,HISTSTATS=ENABLED:OOSAU,SGEO";
Example2
Use the following command to view the parameters of DLM OCG termination point.
RTRV-OCG::1-A-3-L1:ctag;
Output
The following message is returned indicating successful completion.
NC36 05-02-24 10:17:40
M
ctag COMPLD
"1-A-3L1:OCG:LABEL=OCG,RMTOCG=,TECTRL=ENABLED,AUTODISCSTATE=NotValid_Or_Shutdown,HIS
TSTATS=:OOS-AU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-53
RTRV-BAND (Retrieve-Band)
Command Description
This command is used to view the parameters of C band termination point on the BMM circuit pack.
Command Syntax
RTRV-BAND:[<TID>]:[<AID>]:<CTAG>;
Table 5-45 RTRV-BAND Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-BAND (Edit-Band)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,SNVS (See
Table 2-6 on page 2-14).
Table 5-46 RTRV-BAND Response Parameters Description
Parameter
Description
AID
AID of BAND facility
LABEL
Name of the termination point
MAXOCGS
The maximum number of OCGs that can be supported for this band
CHANPLAN
The channel plan for this band termination point
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example
Use the following command to view the parameters of BAND termination point.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-54
Configuring Circuit Pack and Termination Point
RTRV-BAND::2-A-2-C:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:12:30
M
ctag COMPLD
"2-A-2-C:BAND:LABEL=CBAND,MAXOCGS=4,CHANPLAN=Odd,HISTSTATS=ENABLED:OOS-AU,SGE
O";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-55
RTRV-DCF (Retrieve-Dispersion Compensation Fiber)
Command Description
This command is used to view the parameters of DCF termination point on the BMM circuit pack.
Command Syntax
RTRV-DCF:[<TID>]:[AID]:<CTAG>;
Table 5-47 RTRV-DCF Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The BMM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-DCF (Edit-Dispersion Compensation Fiber)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,SNVS (See
Table 2-6 on page 2-14).
Table 5-48 RTRV-DCF Response Parameters Description
Parameter
Description
AID
AID of DCF facility
LABEL
Name of the termination point
DCMTYPE
DCF Module Type
EXPDCFLOSS
The expected DCF loss
EXPDISP
The expected DCF Dispersion
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-56
Configuring Circuit Pack and Termination Point
Example
Use the following command to view the parameters of DCF termination point.
RTRV-DCF::2-A-2-D1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:13:13
M
ctag COMPLD
"2-A-2-D1:DCF:LABEL=DCF2,DCMTYPE=UNSPECIFIED,EXPDCFLOSS=0,EXPDISP=0:OOSAU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-57
Configuring DLM Circuit Pack and Termination Point
This section describes the TL1 command parameters and their values specific to configuring the DLM
circuit pack.
Create DLM Circuit Pack
The DLM circuit pack is created using the ENT-EQPT command as shown below.
ENT-EQPT::1-A-3:CTAG::DLM:PROVTYPE=DLM-5-C1:IS;
Table 5-49 on page 5-57 describes the pre-condition and post-condition.
Table 5-49 Create DLM Circuit Pack
Section
Description
Pre-condition
The Chassis/MCM should be provisioned
Post-condition
If the command is successful, it creates DLM. MEA alarm is raised if
the provisioned and installed card types do not match.
The creation of DLM circuit pack also creates the corresponding termination points. The termination points
created with default values given to the attributes can be changed using the TL1 commands described in
the following section:
ED-OCH (Edit-Optical Channel)
The following command is used to view the OCH facility:
RTRV-OCH (Retrieve-Optical Channel)
Delete DLM circuit pack
The DLM circuit pack is deleted using the DLT-EQPT command as shown below. However, user should
meet the pre-conditions as described in Table 5-50 on page 5-57.
DLT-EQPT::1-A-3:CTAG;
Table 5-50 Delete DLM circuit pack
Section
Description
Pre-condition
The Chassis must be in OOS state and the entire cross-connects should
be deleted on the DLM circuit pack.
Post-condition
Deleting the DLM circuit pack deletes the TAM and TOM circuit packs.
Refer to Table 5-24 on page 5-30 for command parameters description.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-58
Configuring Circuit Pack and Termination Point
ED-OCH (Edit-Optical Channel)
Command Description
This command is used to modify the parameters of OCH facility on DLM.
Command Syntax
ED-OCH:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<INSDTSTTI=ENABLE|
DISABLE>][,<DTSTXTTI=dtstxtti>][,<DTSEXPTTI=dtsexptti>][,<PRBSGEN=ENABLED|
DISABLED>][,<PRBSMON=ENABLED|DISABLED>][,<HISTSTATS=ENABLE|DISABLE>][,<TTIALAR
MRPT=ENABLED|DISABLED>][,<PREFECTHORDER=prefecthorder>]
[,<ALLOWSNC=ENABLE|DISABLE>][,<SIGNALDEGRADERPT=ENABLED|DISABLED>]:[IS|OOS];
Table 5-51 ED-OCH Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The DLM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-OCH (Retrieve-Optical Channel)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-52 ED-OCH Command Parameters Description
Keyword
AID
Description
Optical Channel termination point
The subchannel option supported for OC48,
STM16 and 1GBE
Example: 1-A-3-L1-1
Valid Range
<Chassis>-<Service shelf><DLMSlot>-<Och><SubCh>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> =
{A}
<DLMSlot> = {3-6}
<DLMOCG> = {L1}
<OCh> = {1-10}
<SubCh> = {1-4}
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-59
Table 5-52 ED-OCH Command Parameters Description
LABEL
Name of the termination point
String of 128 characters
Not Applicable
INSDTSTTI
Flag to enable or disable the TTI injection (DTS)
enable, disable
enable
DTSTXTTI
Section layer TTI to be transmitted in the transmit directions
String of 64 characters
Not Applicable
DTSEXPTTI
Expected TTI
String of 64 characters
Not Applicable
PRBSGEN
Flag to enable or disable the PRBS test pattern
generation
enabled, disabled
disabled
PRBSMON
Flag to enable or disable the PRBS monitoring
mode
enabled, disabled
disabled
HISTSTATS
HISTSTATS flag for enabling and disabling PM
collection
enabled, disabled
enabled
TTIALARMRPT
Flag to indicate TTI alarm reporting feature
enabled, disabled
disabled
PREFECTHORDER
Pre Fec Threshold Order
1E-9 to 1E-4
Not Applicable
ALLOWSNC
Channel can be used for SNC creation
enable, disable
enable
SIGNALDEGRADERPT
Flag to indicate signal degrade reporting to be
enabled or not
enabled, disabled
enabled
STATE
State
IS, OOS
OOS
Example
Use the following command to modify the parameters of OCH facility.
ED-OCH::1-A-4-L1-1:CTAG:::LABEL=OCH1;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:15:09
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-60
Configuring Circuit Pack and Termination Point
RTRV-OCH (Retrieve-Optical Channel)
Command Description
This command is used to view the channel termination point parameters on the DLM circuit pack.
Command Syntax
RTRV-OCH:[<TID>]:[<AID>]:<ctag>;
Table 5-53 RTRV-OCH Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test
and Turn-up, Monitoring Access, Provisioning
Pre-condition
The DLM circuit pack should be pre-configured or auto-configured. The
AID of ALL option is supported.
Post-condition
None
Related commands
ED-OCH (Edit-Optical Channel)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,SNVS (See
Table 2-6 on page 2-14).
Table 5-54 RTRV-OCH Response Parameters Description
Parameter
Description
AID
AID of OCH facility
LABEL
Name of the termination point
INSDTSTTI
Flag to enable or disable the TTI injection (DTS)
DTSTXTTI
TTI to be transmitted in the transmit directions
DTSEXPTTI
Expected TTI
DTSRCVDTTI
Received TTI
PRBSMON
Flag to enable or disable the PRBS monitoring mode
PRBSGEN
Flag to enable or disable the PRBS test pattern generation
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-61
Table 5-54 RTRV-OCH Response Parameters Description
Parameter
Description
ALLOWSNC
Channel can be used for SNC creation
TTIALARMRPT
Flag to indicate TTI alarm reporting feature
PREFECTHORDER
Pre Fec Threshold Order
SIGNALDEGRADERPT
Flag to indicate signal degrade reporting to be enabled or not
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example
Use the following command to view the channel termination point parameters on the DLM circuit pack.
RTRV-OCH::1-A-4-L1-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 07:15:56
M
ctag COMPLD
"1-A-4-L11:OCH:LABEL=OCH1,INSDTSTTI=DISABLED,DTSTXTTI=,DTSEXPTTI=,DTSRCVDTTI=,PRBSGEN=
Disabled,PRBSMON=Disabled,HISTSTATS=ENABLED,TTIALARMRPT=Disabled,PREFECTHORDE
R=1E-4,ALLOWSNC=ENABLED,SIGNALDEGRADERPT=Enabled:OOS-AU,SGEO";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-62
Configuring Circuit Pack and Termination Point
Configuring TAM Circuit Pack and Termination Point
This section describes the TL1 command parameters and their values specific to configuring the TAM
circuit pack.
Create TAM Circuit Pack
The TAM circuit pack is created using the ENT-EQPT command as shown below.
ENT-EQPT::1-A-3-1:CTAG::TAM:PROVTYPE=TAM-2-10G:IS;
Table 5-55 on page 5-62 describes the pre-condition and post-condition.
Table 5-55 Create TAM Circuit Pack
Section
Description
Pre-condition
The DLM circuit pack should be pre-configured or auto-configured.
Post-condition
If the command is successful, it creates the TAM circuit pack.
Delete TAM circuit pack
The TAM circuit pack is deleted using the DLT-EQPT command as shown below. However, user should
meet the pre-conditions as described in Table 5-56 on page 5-62.
DLT-EQPT::1-A-3-1:CTAG;
Table 5-56 Delete TAM Circuit Pack
Section
Description
Pre-condition
All the cross-connects terminating on this circuit pack should be deleted
prior to deleting the TAM circuit pack.
Post-condition
If the command is successful, it deletes the TAM circuit pack, associated
TOM circuit packs, TRIB and client facilities.
Refer to Table 5-24 on page 5-30 for command parameters description.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-63
Configuring TOM Circuit Pack and Termination Point
This section describes TL1 command parameters and their values specific to configuring the TOM circuit
pack.
Creating a TOM Circuit Pack
The TOM circuit pack is created using the ENT-EQPT command as shown below.
ENT-EQPT::1-A-3-1-1:CTAG::TOM:PROVTYPE=TOM-10G-SR1:IS;
Table 5-57 on page 5-63 describes the pre-condition and post-condition.
Table 5-57 Create TOM Circuit Pack
Section
Description
Pre-condition
The TAM circuit pack should be pre-configured or auto-configured.
Post-condition
If the command is successful, it creates TOM circuit pack, the TRIB
facility and the corresponding client termination points.
The creation of TOM circuit pack also creates the TRIB facility and by default it creates OC192 termination
point. If the client signal type is different from OC192, user needs to configure the correct client termination
point by using ED-TRIB command.
The termination point is created with default values given to the attributes which can be changed using
TL1 commands described in the following sections.
ED-TRIB (Edit-TRIB)
ED-OC192 (Edit-OC192)
ED-OC48 (Edit-OC48)
ED-STM64 (Edit-STM64)
ED-STM16 (Edit-STM16)
ED-10GCC (Edit-10G Clear Channel)
ED-10GbE (Edit-10GbE)
ED-1GBE (Edit-1GBE)
Deleting a TOM Circuit Pack
The TOM circuit pack is deleted using the DLT-EQPT command as shown below. However, user should
meet the pre-conditions as described in Table 5-58 on page 5-64.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-64
Configuring Circuit Pack and Termination Point
DLT-EQPT::1-A-3-1-1:ctag;
Table 5-58 Delete TOM circuit pack
Section
Description
Pre-condition
All the cross connects on the TOM should be deleted.
Post-condition
If the command is successful, the TOM circuit pack and the associated
termination points are deleted.
Refer to Table 5-24 on page 5-30 for command parameters description.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-65
ED-TRIB (Edit-TRIB)
Command Description
This command is used to modify the parameters of TRIB facility on the TOM .
Command Syntax
EDTRIB:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<SVCTYPE=OC192|OC48|STM64|STM16|
10GBE_LAN|10GCC|1GBE_LAN>][,<DISABLEACT=LASEROFF|AISL|NONE>][,<HISTSTATS=enab
le|disable>]:[IS|OOS];
Table 5-59 ED-TRIB Command Usage Parameters
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
None
Post-condition
If the SVCTYPE is changed using this command, client facilities corresponding to old value of SVCTYPE are deleted and
the ones corresponding to new value are created.
Related commands
RTRV-TRIB
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,
SNVS (See Table 2-6 on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-66
Configuring Circuit Pack and Termination Point
Table 5-60 ED-TRIB Command Parameters Description
Keyword
AID
Description
Trib physical port on the TOM
Example:2-A-4-T1-1
Valid Range
<Chassis>-<Service
Shelf>-<DLMSlot><TAMSlot>-<TOMSlot>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3,
T4, T5}
<TOMSlot> = {1,2,3,4}
TOM slots (1-2) used for
TAM-2-10G
TOM slots (1-4) used for
TAM-4-2.5g or TAM -41G
LABEL
Name of the termination point
String of 128 characters
Not Applicable
SVCTYPE
Provisioned service type
OC192, OC48, STM64,
STM16, 10GBE_LAN,
10GCC, 1GBE
OC192
HISTSTATS
HISTSTATS flag for enabling and
disabling PM collection
enable, disable
enable
DISABLEACT
This action is taken when there is
a failure on a client transmit signal
or the trib port is locked.
AISL, LASEROFF,
NONE
AISL
STATE
Primary State
IS, OOS
OOS
Example
Use the following command to modify the parameters of TRIB facility on the TOM.
ED-TRIB::2-A-4-T1-1:ctag:::LABEL=SDHCTP2,SVCTYPE=STM64:OOS;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:07:06
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-67
ED-STM16 (Edit-STM16)
Command Description
This command is used to modify the parameters of STM16 termination point on the TOM circuit pack.
Command Syntax
EDSTM16:[<TID>]:[AID]:<CTAG>:::[<LABEL=label>][,<EXPJ0=expj0>][,<LENJ0=1
|16|64>][,<J0MEAREPT=Enabled|Disabled>][,<HISTSTATS=enable|disable>];
Table 5-61 ED-STM16 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-STM16 (Retrieve-STM16)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-62 ED-STM16 Command Parameters Description
Keyword
AID
Description
STM16 client facility
Example:2-A-4-T1-1
Range
Default
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot> = {1,2,3,4}
LABEL
Name of the termination point
String of 128 characters
Not Applicable
LENJ0
The length of path trace
using J0 byte
1, 16, 64
16
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-68
Configuring Circuit Pack and Termination Point
Table 5-62 ED-STM16 Command Parameters Description
EXPJ0
Expected J0
Not Applicable
Not Applicable
J0MEAREPT
The flag for enabling or disabling the reporting of J0
mismatch condition
enabled, disabled
disabled
HISTSTATS
HISTSTATS flag for enabling
and disabling PM collection
enable, disable
enable
Example
Use the following command to modify the parameters of the STM16 termination point on the TOM circuit
pack.
ED-STM16::1-A-3-T1-1:ctag:::LABEL=SDHCTP1;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:20:50
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-69
ED-STM64 (Edit-STM64)
Command Description
This command is used to modify the parameters such as label and state of the STM64 termination point on
the TOM circuit pack.
Command Syntax:
EDSTM64:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<EXPJ0=expj0>][,<LENJ0=1
|16|64>][,<J0MEAREPT=enabled|disabled>][,<HISTSTATS=enable|disable>];
Table 5-63 ED-STM64 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-STM64 (Retrieve-STM64)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-64 ED-STM64 Command Parameters Description
Keyword
AID
Description
SDH STM64 termination
point
Example: 1-A-3-T1-1
Range
Default
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot> = {1-2}
LABEL
UTStarcom Inc.
Name of the termination
point
String of 128 characters
Not Applicable
TL1 User Guide
Release 1.2
Page 5-70
Configuring Circuit Pack and Termination Point
Table 5-64 ED-STM64 Command Parameters Description
LENJ0
The length of path trace
using J0 byte
1, 16, 64
16
EXPJ0
Expected J0
Not Applicable
Not Applicable
J0MEAREPT
The flag for enabling or
disabling the reporting of
J0 mismatch condition
enabled, disabled
disabled
HISTSTATS
HISTSTATS flag for
enabling and disabling PM
collection
enable, disable
enable
Example
Use the following command to modify the parameters of STM64 termination point.
ED-STM64::1-A-3-T1-1:ctag:::LABEL=SDHCTP1;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:20:50
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-71
ED-1GBE (Edit-1GBE)
Command Description
This command is used to modify the parameters of 1GBE termination point.
Command Syntax
ED-1GBE:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>];
Table 5-65 ED-1GbE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
1GbE termination point must already be created
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-1GBE (Retrieve-1GBE)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-66 ED-1GbE Command Parameters Description
Keyword
AID
Description
1GbE termination point
Example: 1-A-6-T3-3
Range
Default
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot>={1,2,3,4}
LABEL
Name of the termination point
String of 128 characters
Not Applicable
Example
Use the following command to modify the parameters of 1GbE termination point.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-72
Configuring Circuit Pack and Termination Point
ED-1GBE::1-A-5-T5-3:c:::LABEL=1GBE;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 13:07:38
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-73
ED-10GbE (Edit-10GbE)
Command Description
This command is used to modify the parameters such as label and state of the 10GbE termination point on
the TOM circuit pack.
Command Syntax
ED-10GBE:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>];
Table 5-67 ED-10GbE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-10GbE (Retrieve-10GbE)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-68 ED-10GbE Command Parameters Description
Keyword
UTStarcom Inc.
Description
Range
Default
TL1 User Guide
Release 1.2
Page 5-74
Configuring Circuit Pack and Termination Point
Table 5-68 ED-10GbE Command Parameters Description
AID
10GbE termination point
Example: 1-A-6-T2-1
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot>= {1,2}
LABEL
Name of the termination point
String of 128 characters
Not Applicable
Example
Use the following command to modify the parameters of 10GbE termination point.
ED-10GBE::1-A-3-T1-2:ctag:::LABEL=10GBE1;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:10:13
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-75
ED-OC192 (Edit-OC192)
Command Description
This command is used to modify the parameters of OC192 termination point on the TOM circuit pack.
Command Syntax:
EDOC192:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<EXPJ0=expj0>][,<LENJ0=1|16|64>
][,<J0MEAREPT=Enabled|Disabled>][,<HISTSTATS=enable|disable>];
Table 5-69 ED-OC192 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-OC192 (Retrieve-OC192)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-70 ED-OC192 Command Parameters Description
Keyword
AID
Description
SONET OC192 termination point
Example: 1-A-3-T1-1
Range
Default
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot>= {1-2}
LABEL
UTStarcom Inc.
Name of the termination
point
String of 128 characters
Not Applicable
TL1 User Guide
Release 1.2
Page 5-76
Configuring Circuit Pack and Termination Point
Table 5-70 ED-OC192 Command Parameters Description
LENJ0
The length of path trace
using J0 byte
1, 16, 64
16
EXPJ0
Expected J0
Not Applicable
Not Applicable
J0MEAREPT
The flag for enabling or
disabling the reporting of
J0 mismatch condition
enabled, disabled
disabled
HISTSTATS
HISTSTATS flag for
enabling and disabling PM
collection
enable, disable
enable
Example
Use the following command to modify the parameters of OC192 termination point on the TOM circuit pack.
ED-OC192::1-A-4-T1-2:c:::label=test;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:11:13
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-77
ED-OC48 (Edit-OC48)
Command Description
This command is used to modify the parameters of OC48 termination point on the TOM circuit pack.
Command Syntax:
EDOC48:[<TID>]:[AID]:<CTAG>:::[<LABEL=label>][,<EXPJ0=expj0>][,<LENJ0=1|16|64>]
[,<J0MEAREPT=Enabled|Disabled>][,<HISTSTATS=enable|disable>];
Table 5-71 ED-OC48 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
RTRV-OC48 (Retrieve-OC48)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-72 ED-OC48 Command Parameters Description
Keyword
AID
Description
SONET OC48 termination
point
Example: 1-A-3-T1-3
Range
Default
<Chassis>-<Service Shelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot>= {1-4}
LABEL
UTStarcom Inc.
Name of the termination
point
String of 128 characters
Not Applicable
TL1 User Guide
Release 1.2
Page 5-78
Configuring Circuit Pack and Termination Point
Table 5-72 ED-OC48 Command Parameters Description
LENJ0
The length of path trace
using J0 byte
1, 16, 64
16
EXPJ0
Expected J0
Not Applicable
Not Applicable
J0MEAREPT
The flag for enabling or
disabling the reporting of
J0 mismatch condition
enabled, disabled
disabled
HISTSTATS
HISTSTATS flag for
enabling and disabling PM
collection
enable, disable
enable
Example
Use the following command to modify the parameters of OC48 termination point on the TOM circuit pack.
ED-OC48::1-A-3-T2-1:c:::LABEL=test;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:12:13
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-79
ED-10GCC (Edit-10G Clear Channel)
Command Description
This command is used to modify the 10G Clear Channel termination point on the TOM circuit pack.
Command Syntax:
ED-10GCC:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>];
Table 5-73 ED-10GCC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The 10GCC facility is created when the appropriate TOM is provisioned or inserted
The Existing Client facility present on the TRIB can be changed to
10GCC by setting the SVCTYPE attribute of the TRIB facility to
10GCC.
The 10GCC facility is deleted when TOM is deleted
Terminal and Facility Loop backs are supported.
Post-condition
None
Related Commands
RTRV-10GCC (Retrieve-10GCC)
ED-TRIB (Edit-TRIB)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-80
Configuring Circuit Pack and Termination Point
Table 5-74 ED-10GCC Command Parameters Description
Keyword
AID
Description
AID of the 10GCC termination point
Example:1-A-3-T2-1
Range
<Chassis>-<ServiceShelf><DLMSlot>-<TAMSlot><TOMSlot>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot>= {1-2}
LABEL
Name of the facility
String of 128 characters
Not Applicable
Example
Use the following command to modify the 10G Clear Channel termination point on the TOM circuit pack.
ED-10GCC::1-A-3-T2-1:c:::LABEL=test;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:12:53
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-81
RTRV-10GCC (Retrieve-10GCC)
Command Description
This command is used to view the parameters of the 10GCC termination point on the TOM circuit pack.
Command Syntax:
RTRV-10GCC:[<TID>]:[AID]:<CTAG>;
Table 5-75 RTRV-10GCC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
Option of ALL is supported on the AID field to retrieve all 10GCC
facilities present on the network element
Post-condition
None
Related commands
ED-10GCC (Edit-10G Clear Channel)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-76 RTRV-10GCC Response Parameters Description
Keyword
Description
AID
AID of facility
LABEL
Name of the termination point
CKTID
Circuit Id
SVCTYPE
Provisioned service type
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
PST
Primary state
PSTQ
Primary State Qualifier
SST
Secondary State
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-82
Configuring Circuit Pack and Termination Point
Example
Use the following command to view the parameters of the 10GCC termination point on the TOM circuit
pack.
RTRV-10GCC:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:12:44
M
ctag COMPLD
"2-A-4-T1-1:10GCC:LABEL=10GCC1,CKTID="1108517989.MA3204120428.4.2.1.4.1.1:",SVCTYPE=10GCC:OOS-AU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-83
RTRV-TRIB (Retrieve-TRIB)
Command Description
This command is used to view the trib facility on the TOM circuit pack.
Command Syntax:
RTRV-TRIB:[<TID>]:[<AID>]:<CTAG>;
Table 5-77 RTRV-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
The trib termination point is deleted when TOM is detected
Related commands
ED-TRIB (Edit-TRIB)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-78 RTRV-TRIB Response Paramaters Description
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
MAXCAP
Maximum Capacity
SVCTYPE
Provisioned service type
DISABLEACT
This attribute defines the action taken by the TRIB on client transmit
signal when trib port is locked.
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
PROTMOD
This field is displayed only if the protection mode is set to Y-Cable
CFGPROTST
This field is displayed only when the PROTMODE is set to Y-Cable
CURPROTST
This field is displayed only when the PROTMODE is set to Y-Cable
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-84
Configuring Circuit Pack and Termination Point
Table 5-78 RTRV-TRIB Response Paramaters Description
PSDIRN
Protection state direction
PSREQSTATE
Any outstanding protection switch request present on this Trib PTP
PST
Primary state
PSTQ
Primary state Qualifier
SST
Secondary State
Note: The PSDIRN, PROTMODE, CFGPROTST and CURPROTST will be seen only if the TRIB
is part of any protection group.
Example
Use the following command to view the parameters of tributary termination point.
RTRV-TRIB::1-A-6-T1-1:ctag;
Output
The following message is returned indicating successful completion.
NE-123 05-02-22 11:07:44
M
ctag COMPLD
"1-A-6-T1:TRIB:LABEL=,MAXCAP=2.5GIG_ANY,SVCTYPE=OC48,PSDIRN=UNI,PROTMOD=YCable,CFGPROTS
T=Wrk,CURPROTST=Unknown,DISABLEACT=AISL,HISTSTATS=ENABLED:OOS-AU,SGEO"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-85
RTRV-STM16 (Retrieve-STM16)
Command Description
This command is used to view the STM16 termination point on the TOM circuit pack.
Command Syntax:
RTRV-STM16:[<TID>]:[AID]:<ctag>;
Table 5-79 RTRV-STM16 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Provisioning, Test
and Turn-up, Monitoring Access, System Administrator
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-STM16 (Edit-STM16)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,
SNVS (See Table 2-6 on page 2-14).
Table 5-80 RTRV-STM16 Response Parameters Description
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
CKTPACK
Circuitpack supporting the facility
LENJ0
The length of J0 byte
EXPJ0
Expected J0
RCVDJ0
The Received J0 message
J0MEAREPT
The flag for enabling or disabling the reporting of J0 trace mismatch condition
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
CKTID
The circuit ID of the cross-connect
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-86
Configuring Circuit Pack and Termination Point
Table 5-80 RTRV-STM16 Response Parameters Description
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example
Use the following command to view the parameters of STM16 termination point.
RTRV-STM16::2-A-5-T3-2:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 05:03:18
M
ctag COMPLD
"2-A-5-T32:STM16:LABEL=,EXPJ0=,LENJ0=16,RCVDJ0=,J0MEAREPT=Disabled,CKTID=,CKTPACK=,HIST
STATS=ENABLED:OOS-AU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-87
RTRV-STM64 (Retrieve-STM64)
Command Description
This command is used to view the STM64 termination point parameters on the TOM circuit pack.
Command Syntax:
RTRV-STM64:[<TID>]:[AID]:<CTAG>;
Table 5-81 RTRV-STM64 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-STM64 (Edit-STM64)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,
SNVS (See Table 2-6 on page 2-14).
Table 5-82 RTRV-STM64 Response Parameters Description
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
LENJ0
The length of J0 byte
EXPJ0
Expected J0
RCVDJ0
The Received J0 message
J0MEAREPT
The flag for enabling or disabling the reporting of J0 trace mismatch condition
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
CKTID
The circuit ID of the cross-connect
PST
Primary state
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-88
Configuring Circuit Pack and Termination Point
Table 5-82 RTRV-STM64 Response Parameters Description
PSTQ
Primary state Qualifier
SST
Secondary State
Example
Use the following command to view the parameters of STM64 termination point.
RTRV-STM64:::s;
Output
The following message is returned indicating successful completion.
R2B1NE1 04-04-21 02:02:13
M
s COMPLD
"1-A-4-T21:STM64:LABEL=,RCVDJ0=,EXPJ0=,LENJ0=16,J0MEAREPT=Disabled,CKTID=,HISTSTATS=Ena
bled:OOS-AU,SGEO"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-89
RTRV-1GBE (Retrieve-1GBE)
Command Description
This command is used to view the 1GbE client termination point parameters on the TOM circuit pack.
Command Syntax
RTRV-1GBE:[<TID>]:[AID]:<ctag>;
Table 5-83 RTRV-1GbE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
None.
Related commands
ED-1GBE (Edit-1GBE)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-84 RTRV-1GbE Response Description Parameters
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
CKTID
The circuit ID of the cross-connect
SVCTYPE
The service type provided by this 1GbE facility
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-90
Configuring Circuit Pack and Termination Point
Example
Use the following command to view the parameters of 1GbE termination point.
TL1>>RTRV-1GBE::2-A-5-T5-3:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:16:47
M
ctag COMPLD
"2-A-5-T53:1GBE:LABEL=,CKTID="1108519385.PA2600408004.1.1.1.6.5.3:",SVCTYPE=1GBE:OOSAU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-91
RTRV-10GbE (Retrieve-10GbE)
Command Description
This command is used to view the 10GbE termination point parameters on the TOM circuit pack.
Command Syntax
RTRV-10GBE:[<TID>]:[AID]:<ctag>;
Table 5-85 RTRV-10GbE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
None.
Related commands
ED-10GbE (Edit-10GbE)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-86 RTRV-10GbE Response Description Parameters
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
SVCTYPE
The service type provided by this 10GbE facility
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
CKTID
The circuit ID of the cross-connect
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-92
Configuring Circuit Pack and Termination Point
Example
Use the following command to view the parameters of 10GbE termination point.
RTRV-10GbE:::w;
Output
The following message is returned indicating successful completion.
R2B1NE1 04-04-21 02:03:14
M
w COMPLD
"1-A-4-T2-1:10GBE:LABEL=,CKTID=,HISTSTATS=Enabled:OOS-AU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-93
RTRV-OC192 (Retrieve-OC192)
Command Description
This command is used to view the OC192 termination point parameters on the TOM circuit pack.
Command Syntax
RTRV-OC192:[<TID>]:[AID]:<CTAG>;
Table 5-87 RTRV-OC192 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-OC192 (Edit-OC192)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-88 RTRV-OC192 Response Parameters Description
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
LENJ0
The length of J0 byte
EXPJ0
Expected J0
RCVDJ0
The Received J0 message
J0MEAREPT
The flag for enabling or disabling the reporting of J0 trace mismatch
condition
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
CKTID
The circuit ID of the cross-connect
PST
Primary state
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-94
Configuring Circuit Pack and Termination Point
Table 5-88 RTRV-OC192 Response Parameters Description
Parameter
Description
PSTQ
Primary state Qualifier
SST
Secondary State
Example
Use the following command to view the parameters of OC192 termination point.
RTRV-OC192::2-A-5-T2-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:24:36
M
ctag COMPLD
"2-A-5-T21:OC192:LABEL=,RCVDJ0=,EXPJ0=,LENJ0=16,J0MEAREPT=Disabled,CKTID=,HISTSTATS=ENA
BLED:OOS-AU,SGEO";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-95
RTRV-OC48 (Retrieve-OC48)
Command Description
This command is used to view the OC48 termination point parameters on the TOM circuit pack.
Command Syntax
RTRV-OC48:[<TID>]:[AID]:<ctag>;
Table 5-89 RTRV-OC48 Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The TOM circuit pack should be pre-configured or auto-configured.
Post-condition
None
Related commands
ED-OC48 (Edit-OC48)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ "<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>"cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 5-90 RTRV-OC48 Response Parameters Description
Parameter
Description
AID
AID of facility
LABEL
Name of the termination point
LENJ0
The length of J0 byte
EXPJ0
Expected J0
RCVDJ0
The Received J0 message
J0MEAREPT
The flag for enabling or disabling the reporting of J0 trace mismatch
condition
HISTSTATS
HISTSTATS flag for enabling and disabling PM collection
CKTID
The circuit ID of the cross-connect
CKTPACK
The circuitpack supporting this facility
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-96
Configuring Circuit Pack and Termination Point
Table 5-90 RTRV-OC48 Response Parameters Description
Parameter
Description
PST
Primary state
PSTQ
Primary state Qualifier
SST
Secondary State
Example
Use the following command to view the parameters of OC48 termination point.
RTRV-OC48::2-A-5-T3-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:25:24
M
ctag COMPLD
"2-A-5-T31:OC48:LABEL=,EXPJ0=,LENJ0=16,RCVDJ0=,J0MEAREPT=Disabled,CKTID="1108519376.PA2
600408004.1.1.1.6.3.1:",CKTPACK=,HISTSTATS=ENABLED:OOS-AU,SGEO"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-97
Configuring MCM
This section describes the TL1 command parameters and their values, specific to configuring the MCM
circuit pack.
Create MCM Circuit Pack
Please note that Active Node Controller MCM can not be created. However, MCM representing Standby
Node Controller and Active/Standby Shelf Controller can be created.
The MCM circuit pack is created using the ENT-EQPT command as shown below. The user can optionally
specify the state (In the following example, the equipment is created in IS state). If the state is not
specified, the MCM circuit pack is created in IS state.
ENT-EQPT::1-A-7B:ctag::MCM::IS;
Table 5-91 on page 5-97 describes the pre-condition and post-condition.
Table 5-91 Create MCM circuit pack
Section
Description
Pre-condition
The Chassis should be provisioned.
Post-condition
If the command is successful, it creates the MCM.
The TN780 allows for one MCM to be active and the other MCM to be stand-by. The active MCM circuit
pack terminates the management interfaces to the system and provides all of the control and monitoring
functions for the system. The standby MCM maintains synchronization with its active partner so that it is
capable of becoming active at any time, but is not actively involved in system control or monitoring.
There are two types of the MCM available for managing a TN780, the MCM-A (earlier revision of MCM)
and MCM-B.
Note: In Release 1.2 the MCM-A can be deployed in a single-chassis system only.
Note: The MCM-A will be supported in non-redundant configurations only.
Note: The only time a MCM-A and a MCM-B should be located in the same chassis is during the
upgrade of an MCM-A to a MCM-B in a single chassis system.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-98
Configuring Circuit Pack and Termination Point
Delete MCM circuit pack
Please note that Active Node Controller MCM can not be deleted. However, MCM representing Standby
Node Controller and Active/Standby Shelf Controller can be deleted.
The MCM circuit pack is deleted using the DLT-EQPT command as shown below. However, user should
meet the pre-conditions as described in Table 5-92 on page 5-98.
DLT-EQPT::1-A-7B:ctag;
Table 5-92 Delete MCM circuit pack
Section
Pre-condition
Description
MCM must be in OOS.
The MCM must not be equipped.
Post-condition
The MCM is deleted.
Refer to Table 5-24 on page 5-30 for command parameters description.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-99
Configuring OAM Circuit Pack and Termination Point
This section describes TL1 command parameters and their values specific to configuring the OAM circuit
pack. The OAM circuit pack is configured on the OTC.
Create OAM Circuit Pack
The OAM circuit pack is created using the ENT-EQPT command as shown below.
ENT-EQPT::1-A-2:ctag::OAM;
Table 5-93 on page 5-99 describes the pre-condition and post-condition.
Table 5-93 Create OAM Circuit Pack
Section
Description
Pre-condition
The OTC chassis must be configured prior to creating OAM circuit
pack. The OMM circuit pack should be present.
Post-condition
If the command is successful, it creates OAM.
The creation of OAM circuit pack also creates the corresponding termination points. The termination points
are created with default values given to the attributes which can be changed using TL1 commands
described in the following sections.
ED-OTS (Edit-Optical Transport Section)
ED-BAND (Edit-Band)
ED-DCF (Edit-Dispersion Compensation Fiber)
ED-OSC (Edit-Optical Supervisory Channel)
Delete OAM Circuit Pack
The OAM circuit pack is deleted using the DLT-EQPT command as shown below. However, user should
meet the pre-conditions as described in Table 5-94 on page 5-99.
DLT-EQPT::1-A-1:ctag;
Table 5-94 Delete OAM Circuit Pack
Section
Description
Pre-condition
The OAM must be in OOS state and all the dependent entities deleted.
Equipment should not be physically present.
Post-condition
If the command is successful, the OAM circuit pack is deleted.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-100
Configuring Circuit Pack and Termination Point
Refer to Table 5-24 on page 5-30 for command parameters description.
Configuring OMM
This section describes the TL1 command parameters and their values, specific to configuring the OMM
circuit pack.
Create OMM Circuit Pack
Please note that Active OMM can not be created. Only Standby OMM can be created. The OMM circuit
pack is created using the ENT-EQPT command as shown below. The user can optionally specify the state
(In the following example, the equipment is created in IS state). If the state is not specified, the OMM circuit
pack is created in IS state.
ENT-EQPT::1-A-1B:ctag::OMM::IS;
Refer Table 5-95 on page 5-100 describes the pre-condition and post-condition.
Table 5-95 Create OMM circuit pack
Section
Description
Pre-condition
The Chassis should be provisioned.
Post-condition
If the command is successful, it creates the OMM.
Delete OMM circuit pack
Please note that Active OMM can not be deleted. Only Standby OMM can be deleted. The OMM circuit
pack is deleted using the DLT-EQPT command as shown below. However, user should meet the preconditions as described in Table 5-96 on page 5-100.
DLT-EQPT::1-A-1B:ctag;
Table 5-96 Delete OMM circuit pack
Section
Pre-condition
Description
OMM must be in OOS
The OMM must not be equipped.
Post-condition
The OMM is deleted.
Refer to Table 5-24 on page 5-30 for command parameters description.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-101
Configuring Network Topology
The network element supports topology discovery and facilitates Dynamically Signaled SNC provisioning
of circuits through the network. The network topology is discovered through the UTStarcom Transport
routing protocol and distributed amongst all UTStarcom network elements participating in the routing
domain, making each network element aware of other network elements in the same routing domain.
Two primary information elements comprise the topology - routing nodes, which correspond one-for-one to
each network element, and routing links, which are logical representations of capacity between adjacent
routing nodes.
Each network element discovers and maintains topology of a signaling domain. The topology contains
nodes and links.
The following section describes TL1 command used to view the specific topology node attributes:
RTRV-TOPONODE (Retrieve-Toponode)
The following section describes TL1 command used to view the TIDs of the network elements accessible
through a given network element.
Configuring Links
The Digital Optical Network supports two types of links, control links and TE links. These links are
discovered using the OSPF control plane discovery. The links are unidirectional and consist of two
physical fibers that connect the two network elements, one at each end.
Control Links
There are two types of control links, a local control link at the local network element and a remote control
link at the remote network element. A control link refers to the physical fiber between the two OTS
termination points of the network elements (local and remote). The management application can query any
node in the signaling domain and get all the physical links available in that domain.
The following sections describe the TL1 commands used to view the control link attributes:
RTRV-CTRLINK (Retrieve-Control Link)
TE Links
The TE links represent the data plane connectivity of the network element. As the TE links may not exist
physically adjacent to each other, the toponode discovery is not possible within the band.
The following sections describe the TL1 commands used to view the TE link attributes:
RTRV-TELINK (Retrieve TE Link)
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-102
Configuring Network Topology
Configuring Static Routes
The network element provides the ability to add static routes for networks that do not form part of the
internal routing domain. For example, static routes to the PM FTP servers that are connected via the DCN.
One application of static routes is to enable network elements to reach external networks that are not part
of the DCN network.
These are the five parameters that need to be provisioned as part of static route addition:
Host/Network IP address
This field is used to represent the target host or network to which the route is to be added.
Prefix Length
This field is used to explicitly determine if the route is a host or network route. It determines how many bits
of Host/Network IP address are considered as significant bits. A value of 32 is used for host routes. Other
values of ranging from 1 to 31 are used to identify the network component of the IP address during route
lookups.
Gateway
This field represents the host IP on the DCN to which packets that match the host or network route will be
sent for subsequent routing.
Cost
This field is used to assign a cost to the route that uses the specified gateway. It is more relevant when this
route is being advertised within the routing domain to other network elements. The least cost route to the
host or network will be chosen as a consequence.
Route Type
This field is used to state if the route is to be advertised within the routing domain. If so, the network
element that advertises the route will be designated as the gateway in the route advertisement.
Refer ENT-SROUTE (Enter-Static Route) to create a static route.
Refer RTRV-SROUTE (Retrieve-Static Route) to retrieve the parameters associated with a static route.
Refer DLT-SROUTE (Delete-Static Route) to delete a static route.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-103
Note: If the newly added static route conflicts with an existing route in the routing table, the new
route replaces the existing route. Ensure that the addition of new static route is as desired.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-104
Configuring Network Topology
RTRV-TOPONODE (Retrieve-Toponode)
Command Description
This command is used to view the attributes of a topology node. The toponode attributes are a subset of
the UTStarcom Digital Optical Networking system that are derived from the managed entity attributes. The
AID of the TOPONODE is the name of the originating managed entity.
For example, RTRV-TOPONODE:Sunnyvale:Bangalore::ctag; will retrieve the TOPONODE information for
the node ‘Bangalore’.
Command Syntax
RTRV-TOPONODE:[<TID>]:[AID]:<CTAG>;
Table 5-97 RTRV-TOPONODE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
Table 5-98 RTRV-TOPONODE Response Parameters Description
Parameter
Description
AID
AID of Toponode
LABEL
Name of the Topo Node
NETYPE
The Type of network element
NENAME
The Name of Network element
NODEID
The node ID of the network element
ROUTERID
The IP Address of the router ID
DCNIP
The DCN IP address on the network element
DCNIPNETMASK
The netmask of the DCNIP
DCNSTATE
The state of the DCN port
GNE
Flag indicating if the network element is GNE capable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-105
Table 5-98 RTRV-TOPONODE Response Parameters Description
Parameter
Description
TL1PORT
The TL1 port number
XMLPORT
The XML port number
XMLPROXYPORT
The XML Proxy Port
TNETPROXYPORT
The Telnet Proxy Port
FTPPROXYPORT
FTP Proxy Port
HTTPPROXYPORT
HTTP Proxy Port
PRIMGNEIP
The Primary GNE IP address
SECGNEIP
The Secondary GNE IP address
Example
Use the following command to view the attributes of a topology node.
RTRV-TOPONODE:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:27:26
M
ctag COMPLD
"UTSTARCOM::LABEL=UTSTARCOM,NENAME=UTSTARCOM,NETYPE=DON,NODEID=MA3204120428,R
OUTERID=100.100.8.91,DCNIP=10.10.8.91,DCNIPNETMASK=255.255.254.0,DCNSTATE=ENA
BLED,GNE=true,TL1PORT=9090,XMLPORT=5073,XMLPROXYPORT=15073,TNETPROXYPORT=1002
3,FTPPROXYPORT=10021,HTTPPROXYPORT=10080,PRIMGNEIP=100.100.8.80,SECGNEIP=0.0.
0.0";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-106
Configuring Network Topology
RTRV-TIDMAP (Retrieve-TIDMAP)
Command Description
This command is used to view the TID, Node ID and the Router ID information for all the nodes that can be
reached through the local node within the signaling domain.
Command Syntax
RTRV-TIDMAP:[<TID>]::<CTAG>;
Table 5-99 RTRV-TIDMAP Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
This command can be executed on any node, even if it is not a GNE
node. TID parameter to this command is optional. If not specified, the
TID of the local node where the OSS/Client is physically connected
will be used.
Post-condition
The list of TID, NodeID and the Router ID are listed for each node in
the same signaling domain
Related commands
None
Response Format
cr lf lf
^^^<TID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
^^^"::<KEYWORD=DOMAIN>"cr lf
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
Table 5-100 RTRV-TIDMAP Response Parameters Description
Parameter
Description
TID
TID of the network element
NODEID
Node ID of the network element
ROUTERID
The IP Address of the router ID
Example
Use the following command to view the nodes within a signaling domain.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-107
RTRV-TIDMAP:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:28:17
M
ctag COMPLD
"::TID=UTSTARCOM,NODEID=MA3204120428,ROUTERID=100.100.8.91";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-108
Configuring Network Topology
RTRV-CTRLINK (Retrieve-Control Link)
Command Description
This command is used to view the attributes of a control link. A control link in the UTStarcom network refers
to the physical fiber between the two OTSPTPs.
Command Syntax
RTRV-CTRLINK:[<TID>]:[AID]:<CTAG>;
Table 5-101 RTRV-CTRLINK Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
Upon successful completion, the specified attributes are
retrieved.
Related Commands
None
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
Table 5-102 RTRV-CTRLINK Response Parameters Description
Parameter
Description
AID
AID of Control Link
NAME
Name of the ME
LABEL
Name of the control link
ROUTERID
The IP Address of the router ID
NODEID
The node ID of the advertising node
RMTROUTERID
Remote router ID
RMTLINKID
Remote link AID
COST
Cost of the link
INTIPADDR
Control link interface IP address
RMTINTIPADDR
Control link remote interface IP address
RMTOSCID
Remote OSC ID
REACHSCOPE
Reachability scope information for the topnode
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-109
Table 5-102 RTRV-CTRLINK Response Parameters Description
Parameter
Description
LOCALOSCID
Control link local OSC termination point AID
PST
Primary state
PSTQ
Primary state qualifier.
SST
Secondary state
Example
Use the following command to view the parameters of the CTRLINK.
RTRV-CTRLINK:::c;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:30:09
M
c COMPLD
"blr880-1-A-2O1::NAME=blr880,LABEL=,ROUTERID=100.100.8.80,NODEID=PA2600408004,RMTROUTERID=
100.100.8.91,RMTLINKID=blr891-2-A-2O1",COST=100,INTIPADDR=20.20.20.91,RMTINTIPADDR=20.20.20.80,LOCALOSCID=1-A-2O1,REACHSCOPE=Local:IS-NR"
"blr891-2-A-2O1::NAME=blr891,LABEL=,ROUTERID=100.100.8.91,NODEID=MA3204120428,RMTROUTERID=
100.100.8.80,RMTLINKID=blr880-1-A-2O1",COST=100,INTIPADDR=20.20.20.80,RMTINTIPADDR=20.20.20.91,LOCALOSCID=2-A-2O1,REACHSCOPE=Reachable:IS-NR";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-110
Configuring Network Topology
RTRV-TELINK (Retrieve TE Link)
Command Description
This command is used to view the attributes of a TE Link. A TE link in the UTStarcom network refers to the logical link
between two OCGPTPs.
Command Syntax
RTRV-TELINK:[<TID>]:[AID]:<CTAG>;
Table 5-103 RTRV-TELINK Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
Upon successful completion, the specified attributes are
retrieved.
Related Commands
None
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
Table 5-104 RTRV-TELINK Response Parameters Description
Keyword
Description
AID
AID of TE Link
NAME
Name of the managed entity which is TID of the system
LABEL
Name of the control link
ROUTERID
The IP Address of the router ID
NODEID
The node ID of the advertising node
RMTROUTERID
Remote router ID
COST
Cost of the TE link
TECTRL
Flag to indicate whether TE Link is enabled.
MATETELINK
MATE TE link
ASSOCCTRLINK
Control link associated with this TE link
CAPLIST
Bandwidth Capacity List this TE Link can support.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-111
Table 5-104 RTRV-TELINK Response Parameters Description
MAX_10_GIG_TIMESLO
T
Maximum 10GBE Timeslot.
AVAIL_10_GIG_TIMESL
OT
Available 10GBE Timeslot.
INSVC_10_GIG_TIMESL
OT
Current In-service 10GBE Time Slots
MAX_2_5_GIG_TIMESL
OT
Maximum 2.5GBE Timeslot.
AVAIL_2_5_GIG_TIMES
LOT
Available 2.5GBE Timeslot.
INSVC_2_5_GIG_TIMES
LOT
Current In-service 2.5GBE Time Slots
PST
Primary state
PSTQ
Primary state qualifier
SST
Secondary state
Example
Use the following command to view the parameters of the TE Link.
RTRV-TELINK:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:30:54
M
ctag COMPLD
"blr880-1-A-4L1::NAME=blr880,LABEL=,ROUTERID=100.100.8.80,NODEID=PA2600408004,RMTROUTERID=
100.100.8.91,COST=100,TECTRL=ENABLED,MATETELINK=blr891-2-A-4L1",ASSOCCTRLINK=1-A-2O1,MAX_10_GIG_TIMESLOT=10,AVAIL_10_GIG_TIMESLOT=3,INSVC_10_GIG_TIMESLOT=10,MA
X_2_5_GIG_TIMESLOT=40,AVAIL_2_5_GIG_TIMESLOT=20,INSVC_2_5_GIG_TIMESLOT=40:ISNR";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-112
Configuring Network Topology
ENT-SROUTE (Enter-Static Route)
Command Description
This command is used to create a static route.
Command Syntax
ENTSROUTE:[<TID>]::<CTAG>:::<DSTIPADDR=dstipaddr>,<NEXTHOP=nexthop>,<PREFIXLEN=pr
efixlen>[,<COST=cost>][,<ROUTETYPE=LOCAL|DISTRIBUTED>];
Table 5-105 ENT-SROUTE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
The static route entity should not already exist.
Post-condition
Upon successful completion, the static route object is created. It can
be retrieved, and deleted.
Related Commands
DLT-SROUTE (Delete-Static Route)
RTRV-SROUTE (Retrieve-Static Route)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
Table 5-106 ENT-SROUTE Command Parameters Description
Parameter
Description
Valid Range
Default
DSTIPADDR
Destination IP Address
xxx.xxx.xxx.xxx
Mandatory
PREFIXLEN
Prefix Length
1 to 32
Mandatory
NEXTHOP
Next HOP IP Address
xxx.xxx.xxx.xxx
Mandatory
COST
Cost of the static route
1 to 255
1
ROUTETYPE
The static route type
Local, Distributed
Local
Example
Use the following command to create a host specific static route.
ENT-SROUTE:::ctag:::DSTIPADDR=40.40.40.1,PREFIXLEN=32,NEXTHOP=10.10.9.2;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-113
Output
The following message is returned indicating successful completion.
IP ctag
<
TL1>>
NE1 05-02-20 08:31:11
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-114
Configuring Network Topology
DLT-SROUTE (Delete-Static Route)
Command Description
This command is used to delete a static route.
Command Syntax
DLTSROUTE:[<TID>]::<CTAG>:::<DSTIPADDR=dstipaddr>,<PREFIXLEN=prefixlen>;
Table 5-107 DLT-SROUTE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
The static route entity should already exist.
Post-condition
Upon successful completion, the static route object is deleted.
Related Commands
RTRV-TOPONODE (Retrieve-Toponode)
RTRV-SROUTE (Retrieve-Static Route)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14)
Table 5-108 DLT-SROUTE Command Parameters Description
Parameter
Description
Valid Range
Default
DSTIPADDR
Destination IP Address
xxx.xxx.xxx.xxx
Mandatory
PREFIXLEN
Prefix Length
1 to 32
Mandatory
Example
Use the following command to delete a host specific static route.
DLT-SROUTE:::CTAG:::DSTIPADDR=40.40.40.1,PREFIXLEN=32;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-115
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:33:02
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-116
Configuring Network Topology
RTRV-SROUTE (Retrieve-Static Route)
Command Description
This command is used to view the parameters associated with the static route. The destination IP address
and the prefix length of a particular static route must be specified.
Command Syntax
RTRVSROUTE:[<TID>]::<CTAG>:::[<DSTIPADDR=dstipaddr>][,<PREFIXLEN=prefixlen>];
Table 5-109 RTRV-SROUTE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related commands
RTRV-TOPONODE (Retrieve-Toponode)
DLT-SROUTE (Delete-Static Route)
Response Format
cr lf lf
^^^<TID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
^^^"::<KEYWORD=DOMAIN>"cr lf
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP
(See Table 2-6 on page 2-14).
Table 5-110 RTRV-SROUTE Command Parameters Description
Parameter
Description
Valid Range
Default
DSTIPADDR
Destination IP address
xxx.xxx.xxx.xxx
Not Applicable
PREFIXLEN
Prefix length
1 to 32
Not Applicable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-117
Table 5-111 RTRV-SROUTE Response Parameters Description
Keyword
Description
DSTIPADDR
Destination IP address
NEXTHOP
Next Hop IP Address
PREFIXLEN
Prefix Length
COST
Cost of the static route
ROUTETYPE
The static route type
Example
Use the following command to view the parameters of static route.
RTRV-SROUTE:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:32:39
M
ctag COMPLD
"::DSTIPADDR=128.4.40.12,NEXTHOP=10.10.9.2,PREFIXLEN=24,COST=1,ROUTETYPE=LOCA
L";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-118
Configuring Network Topology
OPR-AUTOD (Operate AutoDiscovery)
Command Description
This command instructs the network element to initiate the auto-discovery process. The results of the auto
discovery status can be viewed by retrieving the status of the DLM OCG PTP.
Command Syntax
OPR-AUTOD:[<TID>]:<AID>:<CTAG>;
Table 5-112 OPR-AUTOD Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
The BMM equipment has to be physically present.
The DLM has to be physically present on the chassis and must not
be in the locked state.
DLMOCG should be locked
Post-condition
Once the auto-discovery is successful, the proper values of AIDs
are filled in the corresponding DLM and BMM OCG facilities.
Related commands
None
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, (See Table 2-6 on
page 2-14).
Table 5-113 OPR-AUTOD Command Parameters Description
Parameter
AID
Description
AID of DLMOCG
Example:1-A-4-L1
Valid Range
<Chassis>-<ServiceShelf>-<DLMSlot><DLMOCG>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<DLMOCG> = {L1}
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-119
Example
Use the following command to initiate the auto-discovery process.
OPR-AUTOD::2-a-5-l1:test;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:34:50
M
test COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-120
Configuring Network Topology
OPR-MKSTBY
Command Description
This command initiates a manual make standby process for the given MCM/OMM. The AID is the
mandatory parameter specifying which standby MCM/OMM on which chassis needs to be used for this
command.
Command Syntax
OPR-MKSTBY:[<TID>]:<AID>:<CTAG>;
Table 5-114 OPR-MKSTBY Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
Make standby command can only be invoked on the standby
MCM card. This command is allowed only when the branding mismatch condition is present on the standby MCM or OMM.
MCM can be made standby in main chassis and expansion chassis.
Post-condition
Once the make standby process is successfully completed, the
state of the MCM transitions to IS-NR, STBYH and the MKSTBY
condition is cleared.
If the make standby process fails to completely synchronize the
MCM, then the state of the MCM becomes, OOS-AU, FLT with
alarm of INITFAIL.
Response Format
Standard
Related commands
None
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-121
Table 5-115 OPR-MKSTBY Command Parameters Description
Parameter
AID
Description
Valid Range
AID of the MCM/OMM
that is to be made
standby
<Chassis>-<ServiceShelf>-<MCMSlot>
Example:1-A-7A
<Chassis> = {1-6}
Default
Mandatory
where
<ServiceShelf> = {A}
<MCMSlot> = {7A, 7B}
<Chassis>-<ServiceShelf>-<OMMSlot>
where
<Chassis> = {1}
<ServiceShelf> = {A}
<OMMSlot> = {1A, 1B}
Example
Use the following command to initiate a manual make standby process on standby MCM/OMM.
OPR-MKSTBY::1-A-7A:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:31:48
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-122
Configuring Network Topology
OPR-PROTNSW-EQPT (Protection Switch)
Command Description
This command is used to trigger a manual protection switch request from Active to Standby on the MCM/
OMM circuit pack. This command can be executed only on the active MCM.
Command Syntax
OPR-PROTNSW-EQPT:[<TID>]:<AID>:<CTAG>;
Table 5-116 OPR-PROTNSW-EQPT Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
The standby card must be in the IS-NR, STBYH state.
The command is denied if:
• Standby MCM is not physically present in the slot
• Standby MCM is present but is in Out Of Service State (OOSAU,FLT)
• Standby MCM is present but is currently Locked (OOS-MA)
Post-condition
Once the protection switch takes place, a transient condition of
REPT^EVT^EQPT is generated with CONDTYPE of MANSW (for
Manual Switch). The management plane looses sessions, and
they need to re-established.
The protection switch action on MCM is always non-revertable.
i.e. upon removal of the failure condition on the previous active
card, the activity will not switch back to previous active card
Response Format
Standard
Related commands
None
Error Codes
ENPS, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,
SNVS, SSRD (See Table 2-6 on page 2-14)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-123
Table 5-117 OPR-PROTNSW-EQPT Command Parameters Description
Parameter
AID
Description
Valid Range
AID of the Active MCM/
OMM equipment
<Chassis>-<ServiceShelf>-<Slot>
Example: 1-A-7A refers
to MCM-AID
where
Example: 1-A-1A refers
to OMM-AID
<ServiceShelf> = {A}
Default
Mandatory
<Chassis> = {1-6}
<Slot> = {1A, 1B or 7A,
7B}
Example
Use the following command to trigger a manual protection switch request from Active to Standby card for
MCM 1-A-7A. This example assumes that a standby MCM card 1-A-7B is already present and in ISNR,STBYH state.
OPR-PROTNSW-EQPT::1-A-7A:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:31:48
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-124
Configuring Network Topology
ED-NCT (Nodal Control and Timing)
Command Description
This command is used to modify the parameters associated with the NCT port.
Command Syntax
ED-NCT:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>];
Table 5-118 ED-NCT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
Currently, only label keyword can be modified
Post-condition
None
Response Format
Standard
Related Commands
None
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT (See Table 2-6 on
page 2-14)
Table 5-119 ED-NCT Command Parameters Description
Parameter
AID
Description
AID of the NCT port
Example: 1-NCT-1A
Valid Range
<Chassis>-NCT<NCTport>x
Default
Mandatory
where
<Chassis> = {1-6}
<NCTport> = {1-2}
x=A,B,P
LABEL
A label that identifies the network
element. The label can be changed
at any time.
String of 128 characters
Not Applicable
Example
Use the following command to modify NCT port properties.
ED-NCT::1-NCT-1A:CTAG:::LABEL=test;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-125
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:37:06
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-126
Configuring Network Topology
RTRV-NCT (Nodal Control and Timing)
Command Description
This command is used to view the parameters associated with the NCT port. The ALL option is supported
for the AID.
Command Syntax
RTRV-NCT:[<TID>]:[AID]:<CTAG>;
Table 5-120 RTRV-NCT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test
and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Response Format
<cr> <lf> <lf>
^^^<TID>^<DATE>^<TIME> <cr> <lf>
^^<CTAG>^COMPLD <cr> <lf>
[^^^"<AID>:[<TYPE>]:[<KEYWORD>=<DOMAIN>]*:<PST>[,<SST>]*
"<cr> <lf>]*;
Related Commands
None
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE (See Table 2-
Error Codes
6 on page 2-14)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-127
Table 5-121 RTRV-NCT Response Parameters Description
Keyword
AID
Description
AID of facility
LABEL
Label for the NCT port
NCTPORTTYPE
Port type of the NCT
NCTFORWARDSTATE
The current forwarding state of the NCT port
PEERNCTPORTAID
The AID of the peer NCT port
PEERNCTPORTID
The Identifier of the peer NCT port
PEERCHASSISSERIALNUM
The serial number of peer chassis
PEERCHASSISID
Peer chassis ID
PEERMCMSLOT
Peer MCM Card slot number
PEERCHASTYPE
The peer chassis type
Example
Use the following command to view NCT port properties.
RTRV-NCT::1-NCT-1A:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:38:00
M
ctag COMPLD
"1-NCT1A:NCT:LABEL=test,NCTPORTTYPE=NONE,NCTFORWARDSTATE=Unknown,PEERNCTPORTAID=,PE
ERNCTPORTID=NONE,PEERCHASSISSERIALNUM=,PEERCHASSISID=,PEERMCMSLOT=0,PEERCHAST
YPE=Unknown:OOS-AU,SGEO"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-128
Configuring Network Topology
ENT-FFP-TRIB
Command Description
This command is used to create the facility protection group.
Command Syntax
ENT-FFPTRIB:[<TID>]:<WORKAID>,<PROTECTAID>:<CTAG>:::[<LABEL=label>][,NAME=name>];
Table 5-122 ENT-FFP-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
At the time when the TRIB Y-Cable Protection Group is being created,
the following conditions must be satisfied
Both TRIBs must be provisioned (either physically present or preprovisioned)
Both TRIBs must not be part of an existing protection group on the network element
Both TRIBs must belong to DLMs residing on the same chassis on the
network element
Both TRIBs must have the same provisioned service type
The TRIBs must match one of the following allowed combinations:
The Protection Group Name must be unique within the same network
element
Post-condition
None
Response Format
Standard
Related Commands
ED-FFP-TRIB
RTRV-FFP-TRIB
DLT-FFP-TRIB
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6 on
Error Codes
page 2-14)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-129
Table 5-123 ENT-FFP-TRIB Command Parameters Description
Parameter
Description
Valid Range
Default
WORDAID
AID of the Working end point
Refer Table 1-3
on page 1-11.
Mandatory
PROTECTAID
AID of the Protecting endpoint
Refer Table 1-3
on page 1-11.
Mandatory
LABEL
A label that identifies the network
element. The label can be changed
at any time.
String of 128 characters
Not Applicable
NAME
Name of the protection group
String of 32 characters
Not Applicable
Example
Use the following command to create a protection group.
ENT-FFP-TRIB::1-A-3-T1-1,1-A-4-T1-1:CTAG:::LABEL=xyz,NAME=pg1;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:37:06
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-130
Configuring Network Topology
ED-FFP-TRIB
Command Description
This command is used to modify the parameters of the facility protection group.
Note: There are no attributes that can be modified in Release 1.2 except the Label.
Command Syntax
ED-FFP-TRIB:[<TID>]:<WORKAID>,<PROTECTAID>:<CTAG>:::[<LABEL=label>];
Table 5-124 ED-FFP-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
Upon successful completion, the specified parameters are modified.
Response Format
Standard
Related Commands
ENT-FFP-TRIB
RTRV-FFP-TRIB
DLT-FFP-TRIB
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6 on
page 2-14)
Table 5-125 ED-FFP-TRIB Command Parameters Description
Parameter
Description
Valid Range
Default
WORDAID
AID of the Working end point
Refer Table 1-3
on page 1-11.
Mandatory
PROTECTAID
AID of the Protecting endpoint
Refer Table 1-3
on page 1-11.
Mandatory
LABEL
A label that identifies the network
element. The label can be changed
at any time.
String of 128 characters
Not Applicable
Example
Use the following command to modify a protection group.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-131
ED-FFP-TRIB::1-A-3-T1-1,1-A-4-T1-1:CTAG:::LABEL=testpg;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:37:06
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-132
Configuring Network Topology
RTRV-FFP-TRIB
Command Description
This command is used to view the parameters of the facility protection group.
Command Syntax
RTRV-FFP-TRIB:[<TID>]:[<WORKAID>,<PROTECTAID>]:<CTAG>:::[<NAME=name>];
Table 5-126 RTRV-FFP-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test
and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
After the command is successful the two facilities becomes independent.
The cross connects present are not deleted.
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<WORKAID>,<PROTECTAID>::[KEYWORD=DOMAIN]“cr lf]*;
Related Commands
ED-FFP-TRIB
ENT-FFP-TRIB
DLT-FFP-TRIB
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6 on
page 2-14)
Table 5-127 RTRV-FFP-TRIB Command Parameters Description
Parameter
Description
Valid Range
Default
WORDAID
AID of the Working end point
Refer Table 1-3
on page 1-11.
Optional
PROTECTAID
AID of the Protecting endpoint
Refer Table 1-3
on page 1-11.
Optional
NAME
Name of the protection group
String of 32 characters
Not Applicable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-133
Table 5-128 RTRV-FFP-TRIB Response Parameters Description
Keyword
WORDAID
Description
AID of the Working end point
PROTECTAID
AID of the Protecting endpoint
NAME
Name of the protection group
LABEL
Label of the protection group
RVRTV
Specifies if the protection switch is revertable or not
PSDIRN
Protection Switch Direction
Example
Use the following command to view a protection group.
RTRV-FFP-TRIB:::CTAG;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:37:06
M
CTAG COMPLD
"1-A-3-T1-1,1-A-4-T1-1::NAME=,RVRTV=N,PSDIRN=UNI"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-134
Configuring Network Topology
DLT-FFP-TRIB
Command Description
This command is used to delete the facility protection group.
Command Syntax
DLT-FFP-TRIB:[<TID>]:<WORKAID>,<PROTECTAID>:<CTAG>;
Table 5-129 DLT-FFP-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
The protection trib should be in LOCKED state and the laser should be
disabled
Post-condition
None
Response Format
Standard
Related Commands
ED-FFP-TRIB
ENT-FFP-TRIB
RTRV-FFP-TRIB
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6 on
page 2-14)
Error Codes
Table 5-130 DLT-FFP TRIB Command Parameters Description
Keyword
Description
Valid Range
Default
WORDAID
AID of the Working end
point
Refer Table 1-3 on
page 1-11.
Mandatory
PROTECTAID
AID of the Protecting
endpoint
Refer Table 1-3 on
page 1-11.
Mandatory
Example
Use the following command to delete a protection group.
TL1>>DLT-FFP-TRIB::1-A-3-T1-1,1-A-4-T1-1:ctag;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-135
Output
The following message is returned indicating successful completion.
NE1 05-02-20 08:37:06
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-136
Configuring Network Topology
OPR-PROTNSW-TRIB
Command Description
This command is used to issue a protection switch request for the given protection group specified by the
AID.
Command Syntax
OPR-PROTNSW-TRIB:[<TID>]:<AID>:<CTAG>::<MAN|LOCKOUT>;
Table 5-131 OPR-PROTNSW-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
Protection switch on the trib is successful
Response Format
Standard
Related Commands
RLS-PROTNSW-TRIB
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE, SAOP, SSRD (See
Table 2-6 on page 2-14)
Table 5-132 OPR-PROTNSW-TRIB Command Parameters Description
Parameter
AID
Description
AID of the Trib
Example: 1-A-3-T1-2
Valid Range
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2,
T3, T4, T5}
<TOMSlot>= {1-4}
SC
TL1 User Guide
Switching Condition
Release 1.2
MAN, LOCKOUT
Not Applicable
UTStarcom Inc.
Equipment and Facility Management
Page 5-137
Example
Use the following command to issue a protection switch for protection group.
TL1>>OPR-PROTNSW-TRIB::1-A-3-T1-1:ctag::LOCKOUT;
Output
The following message is returned indicating successful completion.
NE1 05-01-05 12:13:37
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-138
Configuring Network Topology
RLS-PROTNSW-TRIB
Command Description
This command is used to clear the existing switch request that has been performed earlier using the OPRPROTNSW command.
Command Syntax
RLS-PROTNSW-TRIB:[<TID>]:<AID>:<CTAG>;
Table 5-133 RLS-PROTNSW-TRIB Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
Activity switch is released
Response Format
Standard
Related Commands
OPR-PROTNSW-TRIB
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE, SAOP, SSRD (See
Table 2-6 on page 2-14)
Table 5-134 RLS-PROTNSW-TRIB Command Parameters Description
Parameter
AID
Description
AID of the Trib
Example: 1-A-3-T1-2
Valid Range
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2,
T3, T4, T5}
<TOMSlot>= {1-4}
TL1 User Guide
Release 1.2
UTStarcom Inc.
Equipment and Facility Management
Page 5-139
Example
Use the following command to clear the existing switch request that has been performed earlier using
OPR-PROTNSW-TRIB.
TL1>>RLS-PROTNSW-TRIB::1-A-3-T1-1:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-01-05 12:13:37
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 5-140
TL1 User Guide
Configuring Network Topology
Release 1.2
UTStarcom Inc.
CHAPTER 6
Service Provisioning
The service provisioning capabilities include establishing data path connectivity. The services are
originated/terminated in a TN780 network element.
This chapter describes provisioning of services such as cross connection and dynamically signaled SNC
provisioning managed by the network elements in the following sections:
Manual Cross-connect Entities
Dynamically Signaled SNC Provisioning
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-2
Manual Cross-connect Entities
Manual Cross-connect Entities
Cross connect method of provisioning is used when the source and the destination service termination
points reside in the same network element. This method is recommended for users who need full control
over the network elements for a given data path. A cross connect is established by specifying the two
termination points, source and destination, along with the keyword attributes. The TL1 interface checks for
the validity of source and destination endpoints specified in the manual cross-connect command. Table 61 on page 6-2 lists the valid end point combinations to create manual cross-connects.
Table 6-1 Valid end point combinations for manual cross-connects
From AID
To AID
Description
Trib termination point
OCH termination point
Add Drop connection
OCH termination point
Trib termination point
Add Drop connection
OCH termination point
OCH termination point
Pass through connection
Trib termination point
Trib termination point
Hairpin connection
The provisioning function of the network element supports the following types of manual cross-connects:
Pass-thru (Line to Line: DLM in slot 3 to DLM in slot 4 or DLM in slot 5 to DLM in slot 6)
Add-Drop (Line to Trib: within a single DLM)
Hairpin (Trib to Trib: within a single DLM)
Figure 6-1 on page 6-3 illustrates the Line to Line manual cross-connect where the source and destination
termination points are on the line side of two different DLM circuit packs.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-3
Figure 6-1 Pass-thru (Line to Line)
Note: Pass-thru manual cross-connect is not supported between slots 3 to 5, 3 to 6, 4 to 5 and 4
to 6.
Figure 6-2 on page 6-3 illustrates the Line to Trib manual cross-connect where either the source
termination point or the destination termination point is on the line-side and the other termination point is
on the tributary side of the same DLM circuit pack.
Figure 6-2 Add/Drop (Line to Trib)
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-4
Manual Cross-connect Entities
Figure 6-3 on page 6-4 illustrates the Trib to Trib manual cross-connect where the source and destination
termination points are on the tributary side of the same DLM circuit pack. This is referred to as Hairpin (Trib
to Trib).
Figure 6-3 Hairpin (Trib to Trib)
The network element does not allow the configuration of Add/Drop manual cross-connects where the
source and destination termination points are on the tributary side of two different DLMs.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-5
ENT-CRS (Enter-Cross-connect)
Command Description
This command is used to create the manual cross-connect between two endpoints on the network
element.
Command Syntax
ENTCRS:[<TID>]:<FROMAID>,<TOAID>:<CTAG>::[<cct>]:<PAYLOAD=OC192|STM64|OC48|STM16
|10GBE_LAN|10GCC|1GBE_LAN>[,<LABEL=label>][,<CKTIDSUFFIX=cktidsuffix>];
Table 6-2 ENT-CRS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
The DLM must be pre-provisioned or auto provisioned if Line to Line
cross connects are involved.
The TOM must be pre-provisioned or auto provisioned if Trib to Trib,
Line to Trib, Trib to Line cross connects are involved.
Post-condition
Upon successful completion, the manual cross-connect is created.
DTPCTPs are created.
Related Commands
DLT-CRS (Delete-Cross-connect)
ED-CRS (Edit-Cross-connect)
RTRV-CRS (Retrieve-Cross Connect)
ED-DTPCTP (Edit-DTPCTP)
RTRV-DTPCTP (Retrieve-DTPCTP)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6
on page 2-14).
Table 6-3 ENT-CRS Command Parameters Description
Parameter
Description
Valid Range
Default
FROMAID
AID of the source endpoint
Refer Table 1-3 on
page 1-11.
Mandatory
TOAID
AID of the destination endpoint
Refer Table 1-3 on
page 1-11.
Mandatory
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-6
Manual Cross-connect Entities
Table 6-3 ENT-CRS Command Parameters Description
Parameter
Description
Valid Range
Default
CCT
The type of cross-connect to be created
2WAY
2WAY
(Optional)
LABEL
Name of cross-connect
String of 128 characters
Not Applicable
CKTIDSIFFIX
The circuit ID of the cross-connection
specify during creation
String of 96 characters
Mandatory
PAYLOAD
The payload used for the cross connection
OC192, OC48, STM64,
STM16, 10GBE_LAN,
10GCC, 1GBE_LAN
Mandatory
Example
Use the following command to create a manual cross-connect.
ENT-CRS::2-A-3-T1-1,2-A-3-L1-1-1:ctag:::PAYLOAD=OC48,CKTIDSUFFIX=crs1;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:44:08
M
ctag COMPLD;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-7
ED-CRS (Edit-Cross-connect)
Command Description
This command is used to modify the parameters of the manual cross-connect between the two endpoints
on the network element.
Command Syntax
ED-CRS:[<TID>]:<FROMAID>,<TOAID>:<ctag>:::[<LABEL=label>];
Table 6-4 ED-CRS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
The manual cross-connect is created.
Post-condition
Upon successful completion, the label is modified.
Related Commands
DLT-CRS (Delete-Cross-connect)
ENT-CRS (Enter-Cross-connect)
RTRV-CRS (Retrieve-Cross Connect)
ED-DTPCTP (Edit-DTPCTP)
RTRV-DTPCTP (Retrieve-DTPCTP)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6 on
page 2-14).
Table 6-5 ED-CRS Command Parameters Description
Parameter
Description
Valid Range
Default
FROMAID
AID of the source termination point
Refer Table 1-3 on page 1-11.
Mandatory
TOAID
AID of the destination point
Refer Table 1-3 on page 1-11.
Mandatory
LABEL
Name of cross-connect
String of 128 characters
Not Applicable
Example
Use the following command to modify manual cross-connect.
ED-CRS::2-A-3-T1-1,2-A-3-L1-1-1:CTAG:::LABEL=XCON1_OC48;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-8
Manual Cross-connect Entities
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:45:10
M
CTAG COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-9
DLT-CRS (Delete-Cross-Connect)
Command Description
This command is used to delete the manual cross-connect between two endpoints on the network
element.
Command Syntax
DLT-CRS:[<TID>]:<FROMAID>,<TOAID>:<CTAG>;
Table 6-6 DLT-CRS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
The cross-connect is created by the user.
Post-condition
Deletes any DTP CTP that got created as part of manual crossconnect creation.
Related Commands
ENT-CRS (Enter-Cross-connect)
ED-CRS (Edit-Cross-connect)
RTRV-CRS (Retrieve-Cross Connect)
ED-DTPCTP (Edit-DTPCTP)
RTRV-DTPCTP (Retrieve-DTPCTP)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE, SRCI (See
Table 2-6 on page 2-14).
Table 6-7 DLT-CRS Command Parameters Description
Parameter
Description
Valid Range
Default
FROMAID
AID of the source endpoint
Refer Table 1-3 on page 1-11
Mandatory
TOAID
AID of the destination endpoint
Refer Table 1-3 on page 1-11
Mandatory
Example
Use the following command to delete cross connects.
DLT-CRS::2-A-3-T1-1,2-A-3-L1-1-1:ctag;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-10
Manual Cross-connect Entities
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:46:53
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-11
DLT-CRS-SIG (Delete-Cross-Signaled)
Command Description
This command is used to delete the signaled cross-connects present on the OCG termination point in the
DLM circuit pack.
Command Syntax
DLT-CRS-SIG:[<TID>]:<OCGAID>:<ctag>;
Table 6-8 DLT-CRS-SIG Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
DLM OCG termination point must be locked.
Post-condition
All the signaled cross connects (if present on specified DLM
OCG termination point) are deleted
Related Commands
ENT-CRS (Enter-Cross-connect)
ED-CRS (Edit-Cross-connect)
RTRV-CRS (Retrieve-Cross Connect)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
Table 6-9 DLT-CRS-SIG Command Parameters Description
Parameter
OCGAID
Description
Access identifier of OCG
Valid Range
Default
See “Termination Point AIDs” on page 111.
Mandatory
Example
Use the following command to delete the signaled cross connect.
DLT-CRS-SIG::2-a-5-l1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:48:21
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-12
M
Manual Cross-connect Entities
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-13
RTRV-CRS (Retrieve-Cross Connect)
Command Description
This command is used to view the manual and signaled cross-connect present on the network element.
Command Syntax
RTRVCRS:[<TID>]:[<FROMAID>,<TOAID>]:<CTAG>:::[<PAYLOAD=10G|2.5G>][,SIGTYPE=SIGNAL
ED|MANUAL>];
Table 6-10 RTRV-CRS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
A manual cross-connect should be present.
Post-condition
None
Related Commands
DLT-CRS (Delete-Cross-connect)
ENT-CRS (Enter-Cross-connect)
ED-CRS (Edit-Cross-connect)
ED-DTPCTP (Edit-DTPCTP)
RTRV-DTPCTP (Retrieve-DTPCTP)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^”<FROM AID>,<TO AID>:<CCT>:<KEYWORD=DOMAIN>:<PST>,<SST>” <cr><lf>]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, IENE (See Table 2-6
on page 2-14).
Table 6-11 RTRV-CRS Command Parameters Description
Parameter
Description
Valid Range
Default
FROMAID
AID of the source endpoint
Refer Table 1-3 on page 1-11
ALL
TOAID
AID of the destination endpoint
Refer Table 1-3 on page 1-11
ALL
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-14
Manual Cross-connect Entities
Table 6-11 RTRV-CRS Command Parameters Description
Parameter
PAYLOAD
Description
The payload type used for cross
connection
Valid Range
10G, 2.5G
Default
ALL
10G covers: OC192, STM64,
10GBE_LAN, 10GCC,
2.5G covers: OC48, STM16,
1GBE_LAN
SIGTYPE
Signalling type.
Manual, Signaled
ALL
TRAFFICTYPE
The type of traffic being carried
out
ADDDROP, PASSTHRU, HAIRPIN
ALL
Table 6-12 RTRV-CRS Response Parameters Description
Parameter
Description
FROMAID
AID of the source endpoint
TOAID
AID of the destination endpoint
AIDTYPE
AID Type. Always CRS
CCT
Cross-connect type. Always 2WAY.
LABEL
Name of the cross connect
SIGTYPE
Signalling type.
PAYLOAD
The payload type used for cross connection
TRAFFICTYPE
The type of traffic being carried out
CKTIDSUFFIX
The circuit ID Suffix of the cross connection
CKTID
The circuit ID of the cross connection
PST
Primary State (IS,OOS). Refer Table 5-15 on page 5-20 for
the list of primary states
PSTQ
Primary State Qualifier (NR, AU)
SST
Secondary State (SGEO). Refer Table 5-16 on page 5-20 for
the list of secondary states
Note: The command parameters are used as filters to view specific cross-connects instead of all
cross-connects. To view a specific cross-connect using FROMAID and TOAID, it is
required to specify both. Specifying only one of them is not sufficient. Also, FROMAID,TOAID can be specified in reverse order too. Not specifying FROMAID,TOAID will
retrieve all cross-connects satisfying other filter parameters.
Example
Use the following command to view the manual and signaled cross-connect.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-15
RTRV-CRS::2-A-3-T1-1,2-A-3-L1-1-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:46:12
M
ctag COMPLD
"2-A-3-T1-1,2-A-3-L1-11:CRS,2WAY:LABEL=XCON1_OC48,SIGTYPE=Manual,PAYLOAD=OC48,TRAFFICTYPE=ADDDROP,C
KTIDSUFFIX=,CKTID=:OOS-AU,SGEO"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-16
Manual Cross-connect Entities
ED-DTPCTP (Edit-DTPCTP)
Command Description
This command is used to modify the parameters on the DTPCTP termination point on the TOM/DLM circuit
pack.
Command Syntax
EDDTPCTP:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<INSERTTTI=ENABLED|DISABLED>][,
<TXTTI=txtti>][,<EXPTTI=exptti>][,<PRBSGEN=ENABLED|DISABLED>][,<PRBSMON=ENABLE
D|DISABLED>][,<HISTSTATS=ENABLE|DISABLE>][,<TTIALARMRPT=ENABLED|DISABLD>]:[IS|
OOS];
Table 6-13 ED-DTPCTP Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Test and Turn-up, Provisioning
Pre-condition
None
Post-condition
Upon successful completion, the specified parameters are modified.
Related Commands
ENT-CRS (Enter-Cross-connect)
ED-CRS (Edit-Cross-connect)
DLT-CRS (Delete-Cross-connect)
RTRV-CRS (Retrieve-Cross Connect)
RTRV-DTPCTP (Retrieve-DTPCTP)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS (See
Table 2-6 on page 2-14).
Table 6-14 ED-DTPCTP Command Parameters Description
Keyword
AID
Description
AID of the DTPCTP termination point
Example: 1-A-3-T1-1 refers to TOM
DTPCTP
Valid Range
Default
Refer Table 1-3 on
page 1-11.
Mandatory
Example: 1-A-3-L1-1 refers to DLM side
DTPCTP
LABEL
Name of the termination point
String of 128 characters
Not Applicable
INSERTTTI
Flag to Enable or Disable the TTI injection
enabled, disabled
enabled
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-17
Table 6-14 ED-DTPCTP Command Parameters Description
TXTTI
TTI to be transmitted in the transmit
directions
String of 64 characters
Not Applicable
EXPTTI
Expected TTI
String of 64 characters
Not Applicable
TTIALARMRPT
Alarm reporting enable or disable flag
enabled, disabled
disabled
PRBSGEN
Flag to enable or disable the PRBS test
pattern generation
enabled, disabled
disabled
PRBSMON
Flag to enable or disable the PRBS test
pattern monitoring
enabled, disabled
disabled
HISTSTATS
Historical stats flag
enable, disable
enable
STATE
Primary State
IS, OOS
OOS
Example
Use the following command to modify the parameters of DTPCTP termination point.
ED-DTPCTP::1-A-6-T5-4:c:::LABEL=DTPCTP1;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:53:28
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-18
Manual Cross-connect Entities
RTRV-DTPCTP (Retrieve-DTPCTP)
Command Description
This command is used to view the DTPCTP termination point parameters on the TOM circuit pack.
Command Syntax
RTRV-DTPCTP:[<TID>]:[AID]:<CTAG>;
Table 6-15 RTRV-DTPCTP Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The DTPCTP is created when the manual/signaled cross-connect is
created.
Post-condition
None
Related commands
ENT-CRS (Enter-Cross-connect)
ED-CRS (Edit-Cross-connect)
DLT-CRS (Delete-Cross-connect)
RTRV-CRS (Retrieve-Cross Connect)
ED-DTPCTP (Edit-DTPCTP)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^ “<AID>::[KEYWORD=DOMAIN]:<PST>,<SST>“cr lf]*;
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14).
Table 6-16 RTRV-DTPCTP Response Parameters Description
Parameter
Description
AID
AID of the DTPCTP.
LABEL
Name of the termination point
PROVPAYLD
Payload type(OC192/STM64/10GbE) specified during manual cross-connect creation. The provisioned payload is derived from TribPTP.
ACTPAYLD
The actual payload type (OC192/STM64/10GbE) that is detected on
DTPCTP termination point.
INSERTTTI
Flag to Enable or Disable the TTI injection
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-19
Table 6-16 RTRV-DTPCTP Response Parameters Description
Parameter
Description
TXTTI
TTI to be transmitted in the Transmit directions
EXPTTI
Expected TTI
RCVDTTI
Received TTI
ASSOCCKTID
Associated Circuit ID of the manual cross-connect
PRBSGEN
Flag to enable or disable the PRBS test pattern generation
PRBSMON
Flag to enable or disable the PRBS test pattern monitoring
TTIALARMRPT
Alarm reporting enable or disable flag
HISTSTATS
Historical stats flag
PST
Primary State
PSTQ
Primary State Qualifier
SST
Secondary State
Example
Use the following command to view the DTPCTP termination point parameters on the TOM circuit pack.
RTRV-DTPCTP:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:52:59
M
ctag RTRV
"1-A-3-L1-23:DTPCTP:LABEL=,PROVPAYLD=NOTSET,INSERTTTI=DISABLED,TXTTI=,EXPTTI=,ACTPAYLD=N
OTSET,RCVDTTI=,ASSOCCKTID="1108163720.MA3204120428.1.2.1.3.1.1:",HISTSTATS=EN
ABLED,TTIALARMRPT=Disabled:OOS-AU,SGEO";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-20
Dynamically Signaled SNC Provisioning
Dynamically Signaled SNC Provisioning
A circuit is defined as a connection between two service termination points and is used for transport of
client signal from one place to another. In this mode the user specifies the circuit’s end points and the
product automatically provisions the cross-connects in the intermediate network elements using robust
signaling protocol and routing protocols implemented in each network element. This mode simplifies the
provision, yet allows the fine tuning of the characteristics of the end-to-end circuit. The termination points
can reside on the same network element or can be present on another network element.
The network element supports the following circuits:
Local DLM to Remote DLM
Local DLM to Remote TAM
Local TAM to Remote DLM
Local TOM to Remote TOM
The circuit creation involves two lists, the inclusion list and the exclusion list. Both these lists should be
specified which provide information such as the nodes, physical links the route should include or exclude
during the circuit creation.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-21
ENT-SNC (Enter-Circuit)
Command Description
This command is used to create a end-to-end circuit in a given signaling domain. Both the source and
destination network elements should belong to the same signaling domain.
Command Syntax
ENTSNC:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>,]<DSTEND=dstend>,<DSTTID=dsttid>,<P
AYLOAD=OC192|STM64|OC48|STM16|10GBE_LAN|10GCC|1GBE_LAN>[,<CKTIDSUFFIX=cktidsu
ffix>][,<INCLIST=inclist>][,<EXCLIST=exclist>][,<PREPROV=TRUE|FALSE>][,<DLMRO
UTING=LOCAL|DONTCARE>]:[IS|OOS];
Table 6-17 ENT-SNC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
The parameters such as DSTEND and DSTTID are mandatory.The payload
type is specified (OC192, STM64, 10GbE).
For an end-to-end path to be established successfully, the TE Link and the
control link should be setup first.
Post-condition
Once a circuit creation is successful, the network element automatically creates the end point DTPCTPs.
It also creates the intermediate cross-connects.
Related Commands
ED-SNC (Modify-Circuit)
RTRV-SNC (Retrieve-Circuit)
DLT-SNC (Delete-Circuit)
RTRV-PATH-SNC
RTRV-ROUTE
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IIEAE, SARB (See Table 2-6 on
page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-22
Dynamically Signaled SNC Provisioning
Table 6-18 ENT-SNC Command Parameters Description
Keyword
Description
Range
Default
Refer Table 1-3 on
page 1-11.
Mandatory
Name of the circuit
String of 128 characters
Not Applicable
DSTEND
Destination CTP of the circuit
DTPCTP AID
Mandatory
DSTTID
Destination Node Name of the circuit
20 characters string
Mandatory
PREPROV
This indicates whether the SNC is pre-provisioned applicable to local SNC only
True, False
True
CKTIDSUFFIX
The Circuit ID suffix of the circuit
String of 48 characters
Not Applicable
PAYLOAD
The payload unit for creating the circuit
OC192,STM64,OC
48,STM16,10GBE_
LAN, 10GCC,
1GBE_LAN
Mandatory
INCLIST
Inclusion list contains a list of Nodes, Fibers
and/or Channels that should be included in the
SNC Path.
Not Applicable
syntax : AidType%AID
AID
AID of the source
Example: 1-A-3-T1-1
LABEL
INCLIST is of following format:
<INCITEM-1>&<INCITEM-2>&...&<INCITEMn>
INCITEM could be a Node or Fiber or Channel.
Node in INCLIST has following format:
NODE%<NETID>
Fiber in INCLIST has following format:
CTRLLINK%<NETID>-<OSCCTP>
Channel in INCLIST has following format:
TeLink%<NETID>-<OCH>
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-23
Table 6-18 ENT-SNC Command Parameters Description
Keyword
EXCLIST
Description
exclusion list contains a list of Nodes and/or
Fibers that should be excluded in the SNC
Path.
Range
Default
Not Applicable
syntax : AidType%AID
Local, dontcare
local
EXCLIST is of following format:
<EXCITEM-1>&<EXCITEM2>&...&<EXCITEM-n>
EXCITEM could be a Node or Fiber .
Node in EXCLIST has following format:
NODE%<NETID>
Fiber in EXCLIST has following format:
CTRLLINK%<NETID>-<OSCCTP>
DLMROUTING
DLM Routing option
Local indicates that bandwidth between DLMs
3&4 and 5&6 on the local and remote nodes
cannot be considered for SNC route computation.
Dontcare indicates that the bandwidth between
DLMs 3&4 and 5&6 on the local and remote,
nodes can be considered for SNC route computation.
Example
Use the following command to create a end-to-end circuit in a given signaling domain.
ENT-SNC::2-A-4-T1-1:c:::dstend=2-A-4-T1-1,dsttid=NE2,payload=oc192;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 08:54:59
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-24
Dynamically Signaled SNC Provisioning
ED-SNC (Modify-Circuit)
Command Description
This command is used to modify the attributes of a circuit created using ENT-SNC.
Command Syntax
EDSNC:[<TID>]:<AID>:<CTAG>::[LOCAL|REMOTE]:[<LABEL=label>][,<INCLIST=inclist>][,
<PREPROV=True|False>][,<DLMROUTING=Local|dontcare>]:[IS|OOS];
Table 6-19 ED-SNC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
SNC should exist.
Post-condition
Only the LABEL can be modified by this command.
The network element creates the new entity based on the payload type.
Related Commands
RTRV-SNC (Retrieve-Circuit)
ENT-CRS (Enter-Cross-connect)
DLT-CRS (Delete-Cross-connect)
RTRV-PATH-SNC
RTRV-ROUTE
Response Format
Standard
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See Table 2-6 on
Error Codes
page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-25
Table 6-20 ED-SNC Command Parameters Description
Keyword
AID
Description
AID of SNC
Example: 1-A-4-T1-1
Range
Default
<Chassis>-<ServiceShelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4,
T5}
<TOMSlot> = {1,2,3,4}
TOM slots (1-2) used for
TAM-2-10G
TOM slots (1-4) used for
TAM-4-2.5g or TAM -4-1G
SNCTYPE
Type of the SNC
local, remote
local
LABEL
Name of the circuit
String of 128 characters
Not Applicable
INCLIST
Inclusion list – List of nodes/fibers
that should be included in the
SNC Path.
Not Applicable
Not Applicable
PREPROV
This parameter indicates whether
the circuit is preprovisioned.
True, False
True
DLMROUTING
DLM Routing option
Local, dontcare
local
Local indicates that bandwidth
between DLMs 3&4 and 5&6 on
the local and remote nodes cannot be considered for SNC route
computation.
Dontcare indicates that the bandwidth between DLMs 3&4 and
5&6 on the local and remote,
nodes can be considered for SNC
route computation.
Example
Use the following command to modify the parameters of the circuit.
ED-SNC::1-A-6-T3-4:c:::LABEL=test;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-26
Dynamically Signaled SNC Provisioning
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:57:22
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-27
RTRV-SNC (Retrieve-Circuit)
Command Description
This command is used to view the local/remote circuit parameters within the network element. The option
ALL is supported in the AID field. All the local/remote circuits will be listed with this option. A particular
object in the circuit can also be retrieved using the appropriate AID.
Command Syntax
RTRVSNC:[<TID>]:[<AID>]:<CTAG>::[LOCAL|REMOTE]:[<PAYLOAD=OC192|STM64|OC48|STM16|1
0GBE_LAN|10GCC|1GBE_LAN>];
Table 6-21 RTRV-SNC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The topology is up and running with TE links and controls established.
Post-condition
None
Related Commands
ED-SNC (Modify-Circuit)
ENT-CRS (Enter-Cross-connect)
DLT-CRS (Delete-Cross-connect)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See Table 2-6
on page 2-14).
Table 6-22 RTRV-SNC Command Parameters Description
Keyword
AID
Description
AID of SNC
Valid Range
Default
SNC AIDs
ALL
SNCTYPE
Type of the SNC
local, remote
local
PAYLOAD
The payload type
OC192, STM64,OC48, STM16,
10GBE_LAN, 10GCC, 1GBE_LAN
Not Applicable
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-28
Dynamically Signaled SNC Provisioning
Table 6-23 RTRV-SNC Response Parameters Description
Keyword
Description
AID
AID of SNC
NAME
Name of the circuit
SRCEND
Source CTP of the circuit
DSTEND
Destination CTP of the circuit
DSTTID
Destination node name of the circuit
LABEL
Name of the circuit
STATE
State of the circuit
QOS
The type of Quality of Service used for finding the route
QOSVAL
The desired value of the QOS for finding the route
CKTID
The circuit ID of the circuit
CKTIDSUFFIX
The Circuit ID suffix of the circuit
PAYLOAD
The payload unit for creating the circuit
PAYLOADFACT
Payload multiplier factor
INCLIST
The list of objects needed to be included in the route selection criteria.
EXCLIST
The list of objects needed to be exclude in the route selection criteria
DPSTATE
State of the Data Plane
LASTFAILREAS
The last failure reason for the creation the of the circuit
DLMROUTING
DLM Routing option for the circuit
PST
Primary State
PSTQ
Primary State Qualifier.
SST
Secondary State
Example
Use the following command to retrieve the parameters of the required circuit.
RTRV-SNC:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 14:52:59
M
ctag RTRV
"1-A-3-T1-1:Remote:LABEL=sanjai,PAYLOAD=OC48,PAYLOADFACT=1,SRCEND=2-A-3-T11,SRCTID=blr891,DSTEND=1-A-3-T1-
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-29
1,DSTTID=blr880,CKTID="1108163720.MA3204120428.1.2.1.3.1.1:",CKTIDSUFFIX=,DPS
TATE=Down:OOS-AU,SGEO";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-30
Dynamically Signaled SNC Provisioning
DLT-SNC (Delete-Circuit)
Command Description
This command is used to delete a circuit. The AID of the circuit is a mandatory parameter.
Command Syntax
DLT-SNC:[<TID>]:<AID>:<ctag>;
Table 6-24 DLT-SNC Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning
Pre-condition
Remote cross-connects cannot be deleted.
Post-condition
Deletes all cross-connects that were created as part of signaling on
the local network element and along the path. Any DTPCTPs created as part of cross-connect creation are also automatically
deleted.
The SNC should be in LOCKED state
Client CTPs are not affected by this deletion.
Related Commands
ENT-CRS (Enter-Cross-connect)
ED-SNC (Modify-Circuit)
RTRV-SNC (Retrieve-Circuit)
RTRV-PATH-SNC
RTRV-ROUTE
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See Table 2-6
on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-31
Table 6-25 DLT-SNC Command Parameters Description
Parameter
AID
Description
AID of the circuit being
deleted
Example: 1-A-4-T1-
2
Valid Range
<Chassis>-<ServiceShelf>-<DLMSlot><TAMSlot>-<TOMSlot>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2,
T3, T4, T5}
<TOMSlot> = {1,2,3,4}
TOM slots (1-2) used for
TAM-2-10G
TOM slots (1-4) used for
TAM-4-2.5g or TAM -41G
Example
Use the following command to delete the circuit.
DLT-SNC::2-A-4-T1-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:00:22
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-32
Dynamically Signaled SNC Provisioning
RTRV-PATH-SNC
Command Description
This command is used to view the working list information that is currently used by the SNC. The working
list of the SNC is a set of all the entities (facilities) that is used by routing and signaling to connect an end to
end SNC path successfully.
Command Syntax
RTRV-PATH-SNC:[<TID>]:<AID>:<CTAG>::[LOCAL|REMOTE];
Table 6-26 RTRV-PATH-SNC Command Usage
Section
User Access Privilege Level
Description
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
An SNC should have been created
Post-condition
None
Related Commands
ED-SNC (Modify-Circuit)
ENT-CRS (Enter-Cross-connect)
DLT-CRS (Delete-Cross-connect)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See Table 2-6
on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-33
Table 6-27 RTRV-PATH-SNC Command Parameters Description
Keyword
AID
Description
AID of the SNC
Example: 1-A-4-T1-2
Valid Range
Default
<Chassis>-<ServiceShelf><DLMSlot>-<TAMSlot><TOMSlot>
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4, T5}
<TOMSlot> = {1,2,3,4}
TOM slots (1-2) used for TAM-210G
TOM slots (1-4) used for TAM-42.5g or TAM -4-1G
SNCTYPE
Type of the SNC
local, remote
local
The response consists of list of AID and AIDTYPE of TELINKs comprising the SNC.
Table 6-28 RTRV-PATH-SNC Response Parameters Description
Parameter
Description
AID
AID of the Telink
AID TYPE
TeLink AID Type
Example
Use the following command to view the working list information that is currently used by the SNC.
RTRV-PATH-SNC::1-A-3-T1-1:c;
Output
The following message is returned indicating successful completion.
NE1 05-02-15 13:13:47
M
c COMPLD
"NE1-1-A-3-L1:TELINK"
"NE2-1-A-4-L1:TELINK"
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-34
Dynamically Signaled SNC Provisioning
"NE3-1-A-4-L1:TELINK"
"NE4-1-A-4-L1:TELINK";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-35
RTRV-ROUTE
Command Description
This command is used to view the route query, based on the source AID and the destination end points.
The result of the route query is displayed in the response messages corresponding to this command.
Command Syntax
RTRVROUTE:[<TID>]:<AID>:<CTAG>:::<DSTTID=dsttid>,[DSTEND=dstend>,]<PAYLOAD=OC192|
STM64|10GBE_LAN|OC48|STM16|10GCC|1GBE_LAN>[,<PAYLOADFACT=1>][,<DROPTYPE=TRIB>
][,<PREPROV=TRUE|FALSE>][,<INCLIST=inclist>][,<EXCLIST=exclist>][,<DLMROUTING
=LOCAL|DONTCARE>];
Table 6-29 RTRV-ROUTE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
The AID in this command corresponds to the source connection termination point of the route. This is a mandatory parameter.
The DSTEND and DSTTID are keyword defined parameters that corresponds to the Destination Connection Termination Point and the
Destination Node Name (TID) respectively.
The DSTTID is a mandatory parameter.
The DSTEND is optional. If specified, the network element will try the
route query only to this connection termination point.
If only the DSTTID is specified, then the network element will find the
route to the destination network element and will give the first route
found on the network element. (If multiple routes are possible to that
network element)
Post-condition
None
Related Commands
ED-SNC (Modify-Circuit)
ENT-CRS (Enter-Cross-connect)
DLT-CRS (Delete-Cross-connect)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See Table 2-6
on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-36
Dynamically Signaled SNC Provisioning
Table 6-30 RTRV-ROUTE Command Parameters Description
Description
Keyword
AID
AID of the route query
Example: 1-A-4-T1-2
Valid Range
<Chassis>-<ServiceShelf><DLMSlot>-<TAMSlot><TOMSlot>
Default
Mandatory
where
<Chassis> = {1-6}
<ServiceShelf> = {A}
<DLMSlot> = {3-6}
<TAMSlot> = {T1, T2, T3, T4, T5}
<TOMSlot> = {1,2,3,4}
TOM slots (1-2) used for TAM-210G
TOM slots (1-4) used for TAM-42.5g or TAM -4-1G
DSTTID
Destination node name of
the circuit
Not Applicable
Mandatory
DSTEND
Destination CTP of the circuit
String of 128 characters
Not Applicable
PAYLOAD
The payload type
OC192, STM64,OC48, STM16,
10GBE_LAN, 10GCC, 1GBE_LAN
Not Applicable
PAYLOADFACT
Payload multiplier factor
Not Applicable
1
DROPTYPE
Connection termination
type (only trib connection
termination supported)
TRIB
TRIB
PREPROV
Whether the SNC is pre
provisioned
TRUE, FALSE
TRUE
Applicable to Local SNC
only
INCLIST
The list of objects needed
to be included in the route
selection criteria
Not Applicable
Not Applicable
EXCLIST
The list of objects needed
to be exclude in the route
selection criteria
Not Applicable
Not Applicable
DLMROUTING
The type of routing decision to be considered
between the adjacent DLM
3&4 and 5&6
LOCAL, DONTCARE
LOCAL
TL1 User Guide
Release 1.2
UTStarcom Inc.
Service Provisioning
Page 6-37
Table 6-31 RTRV-ROUTE Response Parameters Description
Description
Keyword
DSTEND
Destination CTP of the circuit
DSTTID
Destination node name of the circuit
DROPTYPE
Connection termination type (only trib connection termination supported)
PREPROV
Whether the SNC is pre provisioned
DLMLIST
List of DLM
WORLIST
The list of objects that are currently in the route created by the SNC
Applicable to Local SNC only
RESULTDESC
Result of the route query
PAYLOAD
The payload unit for creating the circuit
PAYLOADFACT
Payload multiplier factor
DLMROUTING
DLM Routing option for the circuit
Example
Use the following command to view the route query.
RTRV-ROUTE::1-A-3-T1-1:ctag:::DSTTID=NE5,DSTEND=1-A-3-T1-1,PAYLOAD=OC48;
Output
The following message is returned indicating successful completion.
NE1 05-02-15 13:11:31
M
ctag COMPLD
"::[email protected],DSTEND="TRIBPTP=1-A-3-T11",PAYLOAD=OC48,PAYLOADFACT=1,DROPTYPE=TRIB,PREPROV=true,DLMROUTING=Local,DLM
LIST=1-A-3-L1,WORKLIST=TeLink%NE1-1-A-3-L1&TeLink%NE2-1-A-4-L1& TeLink%NE3-1A-4-L1& TeLink%NE4-1-A-4-L1,RESULTDESC="Route Found"";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 6-38
TL1 User Guide
Dynamically Signaled SNC Provisioning
Release 1.2
UTStarcom Inc.
CHAPTER 7
Performance Management
UTStarcom network element Performance Management feature is an integral part of the overall network
surveillance functionality.
Performance Monitoring (PM) is defined as the systematic monitoring (or tracking) of an equipment’s
health using continuous collection and analysis of data by observing its performance. Performance is
monitored at different monitoring points such as equipment, trail termination points and connection
termination point defined in the layered network model. PM is typically maintained for a specified length of
time on the network element and is periodically uploaded to higher level management systems for long
term archival.
The TL1 interface enables to retrieve and display performance data from the managed network element
thus providing the following key capabilities:
Identify how well the network element performs compared to predefined thresholds and summarizes
the health of the network element.
Compare the performance of the multiple equipment within the network element.
Detect network service degradations before a failure occurs, thereby enabling preemptive corrective
action.
The network element performance is monitored at different monitoring points, in particular at the
equipment, trail termination points and connection termination points. Performance parameters are
accumulated over 15 minute intervals and 1 day intervals.
This chapter discusses Performance Monitoring through the TL1 interface in the following sections:
“PM Features” on page 7-2
“PM Data Definitions” on page 7-3
“PM and Threshold Configuration” on page 7-9
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-2
PM Features
PM Features
The health of a particular entity in the network element is monitored by collecting and analyzing the
performance data of that entity over a given period of time.
Table 7-1 on page 7-2 summarizes the PM features available through the TL1 interface, and the
associated TL1 messages.
Table 7-1 PM Features and Associated TL1 Command
Feature
TL1 Command
Initialize PM registers
INIT-REG (Initialize-Register)
Retrieve PM data for a given entity type
RTRV-PM (Retrieve-PM)
Set threshold values for PM registers
SET-TH (Set-Threshold value)
Retrieve the threshold values for PM registers
RTRV-TH (Retrieve-Threshold value)
AIDTYPE in each TL1 command is replaced by the actual AID type. For example, to initialize the registers
of OCH termination point, replace the AIDTYPE with OCH. The command is INIT-REG-OCH.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-3
PM Data Definitions
This section describes the list of attributes, definitions and their default values used across the PM
commands in the TL1 interface.
Table 7-2 Parameter Description
Parameter
Description
MONTYPE
Indicates the type of PM data that is requested or reported.
MONLEV
Specifies the level of the monitored value that is requested. The format of this parameter is
LEV-DIR where LEV is either 1 or 0 and DIR is either UP or DOWN. The default for MONLEV is always 1-UP.
MONVAL
The actual value of the register identified by the MONTYPE.
VLDTY
A validity flag that indicates whether MONVAL retrieved is valid or invalid. This flag is
dependent on the initialization of a register within a specified time and hardware related
problems in the managed entity.
LOCN
Indicates the location of the network element, from where the PM data is being reported
Valid values are NEND (Near End) or FEND (Far End).
DIRN
Indicates the direction in which the PM abnormality is located. Valid values are RCV
(receive direction) or TRMT (transmit direction)
TMPER
Time Period for which the PM data is being requested or reported. PM data is accumulated
on a 15-minute or 1-day period.
MONDAT
Indicates the start date of the beginning of the requested Performance Monitoring period
specified in TMPER. The format is MOY-DOM, where MOY (month of year) ranges from 1
to 12 and DOM (day of month) ranges from 1 to 31 in the TMPER parameter. A null value
defaults to the current date.
MONTM
Indicates the beginning time of the requested performance monitoring period specified in
TMPER. The format is HOD-MOH, where hour of day (HOD) ranges from 0 to 23 and
minute of hour (MOH) ranges from 0 to 59. A value of ALL is used to retrieve data from all
times that are available in the network element (starting from hour 0, minute 0, second 1).
A null value defaults to the current time.
Table 7-3 Performance Monitoring Data for Various Entities
AIDTYPE
OTS
UTStarcom Inc.
MONTYPE
LOCN
DIRN
Description
OPT
FEND
TRMT
Optical power transmitted from the line output
OPR
NEND
RCV
Optical power received from the line input
OSARATIO
FEND
TRMT
OSA Ratio in TRMT direction
OSARATIO
NEND
RCV
OSA Ratio in the RCV direction
TL1 User Guide
Release 1.2
Page 7-4
PM Data Definitions
Table 7-3 Performance Monitoring Data for Various Entities
AIDTYPE
OCH
MONTYPE
CVS
LOCN
DIRN
Description
NEND
RCV
The number of code violations
ESS
NEND
RCV
The number of errors received in the current second
SESS
NEND
RCV
The number of severely error seconds crossing a
threshold value, beyond which a major alarm is
raised
BERPREFEC
NEND
RCV
Bit Error Rate before FEC correction
BERPOSTFEC
NEND
RCV
Bit Error Rate after FEC correction
BERPREFECMIN
NEND
RCV
Minimum Bit Error Rate before FEC correction
BERPREFECAVG
NEND
RCV
Average Bit Error Rate before FEC correction
BERPOSTFECMIN
NEND
RCV
Minimum Bit Error Rate after FEC correction
BERPOSTFECMAX
NEND
RCV
Maximum Bit Error Rate after FEC correction
BERPOSTFECAVG
NEND
RCV
Average Bit Error Rate After FEC correction
LBC
FEND
TRMT
Laser Biased Current
(count of BIP8)
Tx Laser Bias
Current
TL1 User Guide
Measured laser bias current of the channel optical transmitter
OPT
NEND
TRMT
Optical channel power transmitted by the DLM
OPTMIN
NEND
TRMT
Minimum optical channel power transmitted by
the DLM
OPTMAX
NEND
TRMT
Maximum optical channel power transmitted by
the DLM
OPTAVG
NEND
TRMT
Average optical channel power transmitted by
the DLM
OPR
NEND
RCV
Optical channel power received by the DLM
OPRMIN
NEND
RCV
Minimum optical channel power received by the
DLM
OPRMAX
NEND
RCV
Maximum optical channel power received by the
DLM
OPRAVG
NEND
RCV
Average optical channel power received by the
DLM
FECZERO
NEND
RCV
Corrected number of zeros
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-5
Table 7-3 Performance Monitoring Data for Various Entities
AIDTYPE
MONTYPE
LOCN
DIRN
Description
BAND
SPANLOSSMIN
NEND
RCV
Minimum recorded span loss
SPANLOSSMAX
NEND
RCV
Maximum recorded span loss
SPANLOSSAVG
NEND
RCV
Average recorded span loss
BANDOPRMIN
NEND
RCV
Minimum
BANDOPRMAX
NEND
RCV
SPANLOSS
NEND
RCV
BANDOPR
NEND
RCV
OAMEDFALB
C1
NEND
TRMT
Laser Biased Current for RX EDFA (stage1)
OAMEDFALB
C2
NEND
TRMT
Laser Biased Current for RX EDFA (stage2)
BMMEDFALBC
NEND
TRMT
Laser Biased Current for TX EDFA on BMM
BANDOPT
NEND
TRMT
Optical Power Transmitted
BMMEDFALB
C1
NEND
RCV
Laser Biased Current for RX EDFA (stage1)
BMMEDFALB
C2
NEND
RCV
Laser Biased Current for RX EDFA (stage2)
OSARATIO
NEND
RCV
The Expected OSA Ratio
BMMPOSTEDFAPOWER
NEND
RCV
Post EDFA power for the BMM
RCV
Last updated span loss details
SPANLOSSUPDATEDTS
UTStarcom Inc.
Current Span Loss
BANDOPRAVG
NEND
RCV
Average Optical Power Received
BANDOPTMIN
NEND
TRMT
Minimum Optical Power Transmitted
BANDOPTMAX
NEND
TRMT
Maximum Optical Power Transmitted
BANDOPTAVG
NEND
TRMT
Band Optical Power Transmitted
TL1 User Guide
Release 1.2
Page 7-6
PM Data Definitions
Table 7-3 Performance Monitoring Data for Various Entities
AIDTYPE
OSC
BMM OCG
MONTYPE
LOCN
DIRN
Description
OPT
NEND
TRMT
Optical Power Transmitted
OPR
NEND
RCV
Optical Power Received
OPRMIN
NEND
RCV
Minimum Recorded OPR
OPRMAX
NEND
RCV
Maximum Recorded OPR
OPRAVG
NEND
RCV
Average Recorded OPR
LBC
NEND
RCV
Laser Biased Current
LBCMIN
NEND
RCV
Minimum Recorded LBC
LBCMAX
NEND
RCV
Maximum Recorded LBC
LBCAVG
NEND
RCV
Average Recorded LBC
BYTES
NEND
TRMT
Number of bytes transmitted
PKTS
NEND
TRMT
Number of packets transmitted
PKTSDROP
NEND
TRMT
Number of packets dropped
BYTES
NEND
RCV
Number of bytes received
PKTS
NEND
RCV
Number of packets received
PKTSDROP
NEND
RCV
Number of packets dropped
OPT
NEND
TRMT
Transmitted optical output power
OPTMIN
NEND
TRMT
Minimum transmitted optical output power
OPTMAX
NEND
TRMT
Maximum transmitted optical output power
OPTAVG
NEND
TRMT
Average transmitted optical output power
OPR
NEND
RCV
Received optical power
OPRMIN
NEND
RCV
Minimum received optical power
OPRMAX
NEND
RCV
Maximum received optical power
OPRAVG
NEND
RCV
Average received optical power
DLM OCG
OPT
NEND
TRMT
Optical Power Transmitted
DCF
EXPDISP
NEND
RCV
Expected Dispersion Value
EXPDISPLOSS
NEND
RCV
Expected Dispersion Loss
ACTDISPLOSS
NEND
RCV
Actual or measured dispersion loss
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-7
Table 7-3 Performance Monitoring Data for Various Entities
AIDTYPE
DTP
TRIB
OC192
MONTYPE
LOCN
DIRN
CVP
NEND
RCV
Count of bit errors detected at the DTF path layer
ESP
NEND
RCV
Count of the number of seconds during which at
least one DTF path layer bit error is detected
SESP
NEND
RCV
Count of the seconds during which K(=2,400) or
more DTF path layer BIP errors are detected
UASP
NEND
RCV
Count of the seconds during which the DTF path
is considered unavailable
PRBSSYNCERR
NEND
RCV
PRBS Synchronization error count
PRBSERR
NEND
RCV
PRBS error count
LBC
NEND
TRMT
Measured laser bias current of the channel optical transmitter
LBCMIN
NEND
TRMT
Minimum laser bias current of the channel optical
transmitter
LBCMAX
NEND
TRMT
Maximum laser bias current of the channel optical transmitter
LBCAVG
NEND
TRMT
Average laser bias current of the channel optical
transmitter
OPT
NEND
TRMT
Transmitted optical power
OPTMIN
NEND
TRMT
Minimum transmitted optical power
OPTMAX
NEND
TRMT
Maximum transmitted optical power
OPTAVG
NEND
TRMT
Average transmitted optical power
OPR
NEND
RCV
Received optical power
OPRMIN
NEND
RCV
Minimum received optical power
OPRMAX
NEND
RCV
Maximum received optical power
OPRAVG
NEND
RCV
Average received optical power
CVS
NEND/
FEND
RCV/
TRMT
Count of BIP errors detected at the section layer
in the SONET signal received from the line/system side and to be transmitted to the receiving
client
CKTID
UTStarcom Inc.
Description
The Circuit ID of the SNC
ESS
NEND/
FEND
RCV/
TRMT
Count of the number of seconds during which at
least one section layer BIP error is detected or
an LOS or SEF defect is present
SESS
NEND/
FEND
RCV/
TRMT
Count of the seconds during which K (=10000) or
more section layer BIP errors are detected
SEFSS
NEND/
FEND
RCV/
TRMT
Count of the seconds during which a SEF defect
is present
TL1 User Guide
Release 1.2
Page 7-8
PM Data Definitions
Table 7-3 Performance Monitoring Data for Various Entities
AIDTYPE
OC48
MONTYPE
CVS
LOCN
NEND
FEND
SEFSS
NEND/
FEND
ESS
NEND/
SESS
NEND/
FEND
FEND
DIRN
Description
RCV/
TRMT
Coding Violation Count Section
RCV/
TRMT
Count of the seconds during which a SEF defect
is present
RCV/
TRMT
Errored Second Count Section
RCV/
TRMT
Severely Errored Second Count Section
CKTID
The Circuit ID of the SNC
STM64
BE-RS
NEND
RCV
Block Error
STM16
ES-RS
NEND
RCV
Errored Seconds Section
SES-RS
NEND
RCV
Severely Errored Seconds Section
OFS-RS
NEND
RCV
Out of Frame Seconds
LOSS-RS
NEND
RCV
Loss of Signal Seconds Regenerated Section
BE-RS
NEND
TRMT
Block Error Count Regenerated Section
ES-RS
NEND
TRMT
Errored Seconds Regenerated Section
SES-RS
NEND
TRMT
Severely Errored Seconds Regenerated Section
OFS-RS
NEND
TRMT
Out of Frame Seconds Regenerated Section
CKTID
TL1 User Guide
Release 1.2
The Circuit ID of SNC
UTStarcom Inc.
Performance Management
Page 7-9
PM and Threshold Configuration
Performance Management module performs the collection and archiving of PM data, displaying real-time
and historical statistics, generation of reports from PM statistics and threshold configuration management.
The TL1 interface allows Performance Monitoring of the network elements through the commands
described in the following sections:
“INIT-REG (Initialize-Register)” on page 7-10
“RTRV-PM (Retrieve-PM)” on page 7-12
Performance thresholds are predefined limits as set on the network element against which the
performance of the network element is measured. When a threshold is crossed, the network element
registers a performance count against the threshold. Thresholds are used to set error levels for each PM.
Threshold PM ranges can be set from the TL1 interface. During the performance statistics accumulation
cycle, if the current value of a performance monitoring parameter reaches or exceeds its corresponding
threshold value, a Threshold Crossing Alert (TCA) is generated by the node and sent to the Alarm
Manager. These messages provide early detection of performance degradation.
Threshold Configuration
Thresholds are used to set error levels for each PM. PM threshold ranges can be set depending on what
values are to be monitored. During the accumulation cycle, if the current value of a performance
monitoring parameter reaches or exceeds its corresponding value, a Threshold Crossing Alert (TCA) is
generated by the node and displayed in the Alarm Manager. These messages provide early detection of
performance degradation. When a threshold is crossed, the node continues to count the errors during a
given accumulation period.
The TL1 interface supports the settings and retrieving of values (refer “REPT^EVT(Report Event)” on
page 4-9 for details on event messages) through the following sections:
“SET-TH (Set-Threshold value)” on page 7-17
“RTRV-TH (Retrieve-Threshold value)” on page 7-19
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-10
PM and Threshold Configuration
INIT-REG (Initialize-Register)
Command Description
This command is used to initialize the PM counter registers to zero. A particular register is initialized by the
user based on the parameter values. All registers of the AID are initialized by default.
Command Syntax
INIT-REG{OC192|OC48|STM64|STM16|10GBE|OCH|DTPCTP}:[<TID>]:<AID>:<CTAG>::[<montype>],[<
monval>],[NEND],[RCV|TRMT],[15-MIN|1-DAY|ALL],[<mondat>],[<montm>];
Table 7-4 INIT-REG Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Test and Turn-up
Pre-condition
MONDAT, MONTM is not required. The initialization is applied to
the current PM bin.
Post-condition
If this command is executed during PM collection for a particular
bin, then that bin is marked invalid.
Related Commands
RTRV-PM (Retrieve-PM)
SET-TH (Set-Threshold value)
RTRV-TH (Retrieve-Threshold value)
Response Format
Standard
Error Codes
None
Table 7-5 INIT-REG Command Parameters Description
Keyword
AID
Description
Managed entity for which INITREG is issued
Valid Range
See Table 1-2 on
Default
Mandatory
page 1-9
Example:1-A-3-T1-1
MONTYPE
Monitored Type
Refer Table 7-3 on
page 7-3 for details.
ALL.
LOCN
Location
NEND (Near End)
ALL
DIRN
Direction
RCV(Receive)
ALL
TRMT (Transmit)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-11
Table 7-5 INIT-REG Command Parameters Description
Keyword
Description
Valid Range
Default
MONVAL
Value of the register
0 (Zero). Initialized to
zero
0
TMPER
15 Minute bin
15-MIN
ALL
1 Day bin
1-DAY
The date of the beginning of the
requested performance monitoring
period specified in TMPER (MOYDOM)
MOY: 1 to 12
The time of the beginning of the
requested performance monitoring
period specified in TMPER (HODMOH)
HOD: 0 to 23
MONDAT
MONTM
Not Applicable
DOM: 1 to 31
Not Applicable
MOH: 0 to 59
Note: MONTYPE, LOCN, DIRN, MONVAL, MONDAT, MONTM parameters are not supported in
this release. All PM registers for a given AID are set to zero for the current interval Since
MONDAT and MONTM are not supported, initializing historical PM intervals is also not
supported.
Example
Use the following command to initialize the PM register.
INIT-REG-OC192::1-A-4-T3-1:ctag::,,,,15-MIN;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:02:05
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-12
PM and Threshold Configuration
RTRV-PM (Retrieve-PM)
Command Description
This command is used to view PM data from the network element.
Note: The current interval data can be retrieved by specifying only TMPER. The historical data for
15 minutes or 1 day can be retrieved by specifying parameters TMPER, MONDAT and
MONTM.
Note: To view real time PM data, leave the TMPER, MONDAT, and MONTM parameters blank
(null). The ranging is allowed on MONTM parameter.
Note: MONTYPE, LOCN (NEND), and DIRN (RCV or TRMT) can be optionally specified as filters
to selectively retrieve specific PM data instead of entire PM data for a given AID.
Command Syntax
RTRV-PM{OC192|OC48|STM64|STM16|OCH|OCG|OTS|BAND|TRIB|DTPCTP|DCF|OSC}:[<TID>]:<AID>:<C
TAG>::[<montype>],[1-UP],[NEND],[RCV|TRMT],[15-MIN|1DAY],[<mondat>],[<montm>];
Table 7-6 RTRV-PM Command Usage
Section
User Access Privilege Level
Description
Network Administrator, Network Engineer, Test and Turn-up,
Monitoring Access, Provisioning, Security Administrator
Pre-condition
The facility on which PM is being retrieved should be in service.
Post-condition
None
Related Commands
INIT-REG (Initialize-Register)
SET-TH (Set-Threshold value)
RTRV-TH (Retrieve-Threshold value)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-13
Table 7-6 RTRV-PM Command Usage
Section
Description
Response Format
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<aid>[,<aidtype>]:<montype>,<monval>[,<vldty>],
[<locn>][,<dirn>][,<tmper>][,<mondat>] [,<montm>]" <cr> <lf>
Error Codes
None
Table 7-7 RTRV-PM Command Parameters Description
Keyword
AID
Description
Managed entity for
which PM data is
retrieved
Valid Range
Default
See Table 1-2 on page 1-9
Mandatory
Example:1-A-3-T1-1
MONTYPE
Monitored Type
Refer Table 7-3 on page 7-3 for details
All
MONLEV
Specifies the level of
the monitored value
that is requested
1-UP
1-UP
LOCN
Location
NEND (Near End)
Not Applicable
DIRN
Direction
RCV(Receive)
ALL
TRMT (Transmit)
ALL
TMPER
MONDAT
MONTM
UTStarcom Inc.
15 Minute bin
15-MIN
1 Day bin
1-DAY
The date of the
beginning of the
requested performance monitoring
period specified in
TMPER (MOYDOM)
MOY: 1 to 12
The time of the
beginning of the
requested performance monitoring
period specified in
TMPER (HODMOH)
HOD: 0 to 23
Not Applicable
Not Applicable
DOM: 1 to 31
Not Applicable
MOH: 0 to 59
TL1 User Guide
Release 1.2
Page 7-14
PM and Threshold Configuration
Table 7-8 RTRV-PM Response Parameters Description
Parameter
Description
AID
AID of the facility
AIDTYPE
AIDTYPE of the facility
MONTYPE
MONTYPE being monitored
MONVAL
MONVAL corresponding to MONTYPE
VLDTY
Validity flag for the PM bin
LOCN
Location (NEND or FEND)
DIRN
Direction (RCV or TRMT)
TMPER
Type of bin being retrieved: 15-MIN, 1-DAY or NULL (for real
time PM retrieval)
MONDAT
Date at the beginning of the interval
MONTM
Time at the beginning of the interval
Example 1
Use the following command to view current 15-MIN PM data.
RTRV-PM-OC192::1-A-4-T3-1:ctag::,,,,15-MIN;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:03:16
M
ctag COMPLD
"1-A-4-T3-1,OC192:CVS,0,FALSE,NEND,RCV,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:ESS,0,FALSE,NEND,RCV,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:SESS,0,FALSE,NEND,RCV,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:SEFSS,0,FALSE,NEND,RCV,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:CVS,0,FALSE,NEND,TRMT,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:ESS,0,FALSE,NEND,TRMT,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:SESS,0,FALSE,NEND,TRMT,15-MIN,02-18,15-00"
"1-A-4-T3-1,OC192:SEFSS,0,FALSE,NEND,TRMT,15-MIN,02-18,15-00"
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-15
"1-A-4-T3-1,OC192:CKTID,"1108710138.PA2600408004.4.1.1.4.3.1:",FALSE,,,15MIN,02-18,15-00";
Example 2
Use the following command to view realtime PM data.
RTRV-PM-OC192::1-A-5-T1-1:ctag;
Output
blr885 05-02-28 18:47:14
M
c COMPLD
"1-A-5-T1-1,OC192:CVS,0,,NEND,RCV,,"
"1-A-5-T1-1,OC192:ESS,0,,NEND,RCV,,"
"1-A-5-T1-1,OC192:SESS,0,,NEND,RCV,,"
"1-A-5-T1-1,OC192:SEFSS,0,,NEND,RCV,,"
"1-A-5-T1-1,OC192:CVS,0,,NEND,TRMT,,"
"1-A-5-T1-1,OC192:ESS,5764,,NEND,TRMT,,"
"1-A-5-T1-1,OC192:SESS,5764,,NEND,TRMT,,"
"1-A-5-T1-1,OC192:SEFSS,5764,,NEND,TRMT,,"
"1-A-5-T1-1,OC192:CKTID,,,,,,"
;
Example 3
Use the following command to view historical 15-MIN PM data.
rtrv-pm-oc192::1-a-5-t1-1:c::,,,,15-MIN,02-28,18-30;
Output
blr885 05-02-28 18:52:22
M
c COMPLD
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-16
PM and Threshold Configuration
"1-A-5-T1-1,OC192:CVS,0,TRUE,NEND,RCV,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:ESS,0,TRUE,NEND,RCV,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:SESS,0,TRUE,NEND,RCV,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:SEFSS,0,TRUE,NEND,RCV,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:CVS,0,TRUE,NEND,TRMT,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:ESS,900,TRUE,NEND,TRMT,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:SESS,900,TRUE,NEND,TRMT,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:SEFSS,900,TRUE,NEND,TRMT,15-MIN,02-28,18-30"
"1-A-5-T1-1,OC192:CKTID,,TRUE,,,15-MIN,02-28,18-30"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-17
SET-TH (Set-Threshold value)
Command Description
This command is used to set the threshold value for a given MONTYPE register.
Once the register count exceeds this threshold value, a Threshold Crossing Event is reported to the OSS
or the user using the report event (REPT^EVT) command.
Command Syntax
SET-TH{OC192|OC48|STM64|STM16|OCH|BAND|DTPCTP}:[<TID>]:<AID>:<CTAG>::[<montype>],[<
thlev>],[NEND],[RCV|TRMT|ALL],[15-MIN|1-DAY]:[<THREPT=ENABLED|DISABLED>];
Table 7-9 SET-TH Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning, Test and Turn-up
Pre-condition
Facility should exist
Post-condition
None
Related Commands
RTRV-PM (Retrieve-PM)
SET-TH (Set-Threshold value)
RTRV-TH (Retrieve-Threshold value)
Response Format
Standard
Error Codes
None
Table 7-10 SET-TH Command Parameters Description
Keyword
AID
Description
Managed entity for which
SET-TH is issued
Valid Range
Default
See Table 1-2 on page 1-
Mandatory
9.
Example:1-A-3-T1-1
MONTYPE
Monitored Type
Refer to Table 7-3 on
page 7-3 for details
ALL
THLEV
Threshold value
Refer to Table 7-3 on
page 7-3 for details
Not Applicable
LOCN
Location
NEND( Near End)
Not Applicable
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-18
PM and Threshold Configuration
Table 7-10 SET-TH Command Parameters Description
Keyword
DIRN
Description
Direction
Valid Range
RCV Receive
Default
ALL
TRMT Transmit
ALL
TMPER
THREPT
15 Minute bin
15-MIN
1 Day bin
1-DAY
Threshold reporting allows
threshold crossing alerts to
be enabled or disabled
enabled, disabled
Not Applicable
Not Applicable
Example
Use the following command to set the threshold value.
SET-TH-OC192::1-A-4-T3-1:ctag::SEFSS,3,NEND,RCV,15-MIN:THREPT=disabled;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:04:34
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-19
RTRV-TH (Retrieve-Threshold value)
Command Description
This command is used the view the current threshold value configured for a given entity.
Command Syntax
RTRV-TH{OC192|OC48|STM64|STM16|OCH|BAND|DTPCTP}:[<TID>]:[<AID>]:<CTAG>::[<montype>],
[NEND],[15-MIN|1-DAY];
Table 7-11 RTRV-TH Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Provisioning, Test and Turn-up
Pre-condition
None
Post-condition
None
Related Commands
INIT-REG (Initialize-Register)
SET-TH (Set-Threshold value)
RTRV-TH (Retrieve-Threshold value)
Response Format
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<aid>[,<aidtype>]:<montype>,
[<locn>][,<dirn>],<thlev>[,<tmper>]:[THREPT=ENABLED|DISABLED]" <cr> <lf>
Error Codes
None
Table 7-12 RTRV-TH Command Parameters Description
Keyword
Description
Valid Range
Default
AID
AID of a facility
FAcility AIDs corresponding to AIDTYPE (Secondary
modifier of the command)
ALL of type corresponding to AIDTYPE.
MONTYPE
Monitored Type
Refer to Table 7-3 on
page 7-3 for details
ALL
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-20
PM and Threshold Configuration
Table 7-12 RTRV-TH Command Parameters Description
Keyword
Description
Valid Range
Default
LOCN
Location
NEND (Near End)
Not Applicable
TMPER
15 Minute bin
15-MIN
ALL
1 Day bin
1-DAY
Table 7-13 RTRV-TH Response Parameters Description
Keyword
AID
Description
AID of a facility
AIDTYPE
AIDTYPE of a facility (Secondary modifier)
MONTYPE
Monitored Type
LOCN
Location
DIRN
Direction
THLEV
Threshold level
TMPER
Time Period
THREPT
Threshold reporting flag that can be enabled or disabled
Note: If the values of AID, MONTYPE, LOCN and TMPER parameters are not entered, the value of each of
these parameters is defaulted to ALL, they are used as filters to look at specific data instead of
all data.
Example
Use the following command to view the threshold value.
RTRV-TH-OC192::2-A-4-T3-1:ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:04:57
M
ctag COMPLD
"2-A-4-T3-1,OC192:CVS,NEND,RCV,1500,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SEFSS,NEND,RCV,3,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:ESS,NEND,RCV,120,15-MIN:THREPT=DISABLED"
TL1 User Guide
Release 1.2
UTStarcom Inc.
Performance Management
Page 7-21
"2-A-4-T3-1,OC192:SESS,NEND,RCV,3,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:CVS,NEND,RCV,15000,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SEFSS,NEND,RCV,7,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:ESS,NEND,RCV,1200,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SESS,NEND,RCV,7,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:CVS,NEND,TRMT,1500,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SEFSS,NEND,TRMT,3,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:ESS,NEND,TRMT,120,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SESS,NEND,TRMT,3,15-MIN:THREPT=DISABLED"
"2-A-4-T3-1,OC192:CVS,NEND,TRMT,15000,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SEFSS,NEND,TRMT,7,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:ESS,NEND,TRMT,1200,1-DAY:THREPT=DISABLED"
"2-A-4-T3-1,OC192:SESS,NEND,TRMT,7,1-DAY:THREPT=DISABLED
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 7-22
TL1 User Guide
PM and Threshold Configuration
Release 1.2
UTStarcom Inc.
CHAPTER 8
Security and Access Management
This chapter describes the procedures used to manage the security and access management features
provided by the TN780 and the Optical Line Amplifier network elements (referred to as network element) in
the following sections:
“Overview” on page 8-2
“User Management” on page 8-3
“TL1 Commands” on page 8-9
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-2
Overview
Overview
The Security Administration capabilities in the UTStarcom Digital Optical Networking system are in
compliance with the security features specified in GR-815-CORE standard. It includes the following
features:
Multiple user access privileges
User ID and password authentication
Password aging
Security parameters provisioning, such as inactivity time-out period, maximum number of invalid logins and so on
User activity and audit log monitoring
The network element supports a comprehensive set of user management and security features.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-3
User Management
A network element user is an user who has access to the network element on which the user account is
created. The user information is stored in the network element database. Every user is identified by a
unique User-ID. The User-ID follows these rules:
Must be unique across a network element
Must have a minimum of 4 characters and a maximum 10 characters of which at least 4 are alphanumeric characters
Is case sensitive
Cannot have a white space
Feature Description
UTStarcom network elements support a comprehensive set of user management and security features.
The Table 8-1 on page 8-3 summarizes the security features supported through the TL1 Interface and the
associated TL1 commands.
Table 8-1 Security Features and Related TL1 commands
Feature
User Management
Description
TL1 Command
Create a user account
ENT-USER-SECU
Modify a user account
ED-USER-SECU
Delete a user account
DLT-USER-SECU
View user account attributes
RTRV-USER-SECU
Disable user account
INH-USER-SECU
Enable user account
ALW-USER-SECU
Change the user password
ED-PID
Password Aging
Report event when password
expires
REPT^EVT^SESSION
Advisory Warning
Message
Provide warning message upon
successful login. This message is
editable.
REPT^EVT^SESSION
Login the Audit trails and retrieve
logs
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-4
User Management
Table 8-1 Security Features and Related TL1 commands
Feature
Security Parameters Management
Description
Detect intrusion when the user
exceeds the maximum number of
invalid logins
TL1 Command
with attribute MXINV
Report Alarms
Time-out based on auto log-off
and reports the corresponding
event
with attribute TMOUT
Login
Login to the network element
“ACT-USER (Activate-User)” on page 8-10
Logout
Logout from the network element
“CANC-USER (Cancel-User)” on page 8-12
Forced Logout
Force logout the users from the
system
“CANC-USER-SECU (Cancel-User-Security)” on page 8-14
on auto logoff
Access Privileges
Multiple access privileges are defined to restrict user access to resources. Each access privilege allows a
specific set of actions to be performed. Assign one or more access privileges to each user account. For the
description of the actions allowed for each access privilege, see Table 8-2 on page 8-5.
There are six levels of access privileges:
Monitoring Access (MA)—allows user to monitor the network element, but not to modify anything on
the network element (read-only privilege). The Monitoring Access is provided to all users by default.
Security Administrator (SA)—allows the user to perform network element security management and
administration related tasks.
Network Administrator (NA)—allows the user to monitor the network element, manage equipment,
turn-up network element, provision services, administer various network-related functions such as
auto-discovery and topology.
Network Engineer (NE)—allows the user to monitor the network element and manage equipment.
Provisioning (PR)—allows the user to monitor the network element, configure facility endpoints and
provision services.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-5
Test and Turn-up (TT)—allows the user to monitor, turn-up and troubleshoot the network element
and fix network problems.
Table 8-2 User Access Privilege Permissions
Managed Object
Entity
Operation
SA
NA
NE
PR
TT
MA
Equipment Management
Chassis
Create, delete and
update
No
Yes
Yes
No
No
No
DLM
Create, delete and
update
No
Yes
Yes
No
No
No
TAM
Create, delete and
update
No
Yes
Yes
No
No
No
BMM
Create, delete and
update
No
Yes
Yes
No
No
No
Alarm input and output contacts
Update
No
Yes
Yes
No
No
No
TOM
Create, delete and
update
No
Yes
Yes
No
No
No
OAM
Create, delete and
update
No
Yes
Yes
No
No
No
OMM
Create, delete and
update
No
Yes
Yes
No
No
No
PEM
Create, delete and
update
No
Yes
Yes
No
No
No
Termination Point (physical ports or logical ports) Management
OTS
Update
No
Yes
No
Yes
Yes
No
Band
Update
No
Yes
No
Yes
Yes
No
OCG - BMM
Update
No
Yes
No
Yes
Yes
No
OCG - DLM
Update
No
Yes
No
Yes
Yes
No
Channel
Update
No
Yes
No
Yes
Yes
No
DTF Path
Update
No
Yes
No
Yes
Yes
No
Trib
Update
No
Yes
No
Yes
Yes
No
Client
Update
No
Yes
No
Yes
Yes
No
OSC
Update
No
Yes
No
Yes
Yes
No
DCF
Update
No
Yes
No
Yes
Yes
No
Cross-connect
Create, update and
Delete
No
Yes
No
Yes
No
No
SNC circuit
Create, update and
Delete
No
Yes
No
Yes
No
No
Services
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-6
User Management
Table 8-2 User Access Privilege Permissions
Managed Object
Entity
Protection Group
Operation
Create
SA
No
NA
Yes
NE
No
PR
TT
MA
Yes
Yes
No
System Administration and Software Maintenance Functions
Periodic PM data
transfer
Update
No
Yes
No
Yes
Yes
No
System date and
time
Update
No
Yes
No
No
No
No
Software download
Update
No
Yes
No
No
No
No
Database download
Update
No
Yes
No
No
No
No
Database upload
Update
No
Yes
No
No
No
No
ASAP (Alarm Severity Assignment Profile)
Update
No
Yes
No
No
No
No
Alarm acknowledgment
Update
No
Yes
Yes
Yes
Yes
No
Network Element Security Administration
Users
Create, update and
delete
Yes
No
No
No
No
No
Security parameters
Update
Yes
No
No
No
No
No
Authentication
The network element supports standards-based authentication features to ensure that only the authorized
users can access the system through management interfaces. Authentication on the network element is
performed via one-way encrypted passwords and is required for each independent session established
with the network element.
This process is enforced on all access interfaces, whether the user is local or remote. When too many
unsuccessful login attempts are detected, the session is terminated and an intrusion attempt alarm
notification is generated.
When the user logs in the first time, a change-password request is displayed. This is a mandatory
operation to be performed.
The password format follows the following rules:
Is a combination of at least six alphanumeric characters
Must contain at least one alphabet and one numeric or special character
Can have a maximum of 10 characters
Supported special characters allowed are:! @ # $ % ^ ( ) _ | ~ { } [ ] Must not contain the user ID
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-7
Is case sensitive
Cannot contain a white space
If no password is set at the time of account creation, the default network element password is assigned to
the user. The default password is “Infinera1” and can be changed any time by the Security Administrator.
User ID and Password Format
The User ID (UID) and password format have a set of rules. Table 8-3 on page 8-7 describes the format
rules for network element User.
Table 8-3 User ID and Password format rules
Authentication
Element
Rules
network element User
ID (UID)
• The UID shall contain alphanumeric characters ranging from 4 to 10 characters.
network element User
Password
• The password shall contain a combination of at least six alphanumeric characters,
including at least one alphabetic, one numeric, or one special character.
• The UID is case sensitive.
• The maximum length of password is 10 characters.
• The set of special characters allowed are:! @ # $ % ^ ( ) _ + | ~ { } [ ] • The password shall not contain the associated User-ID.
• Password and user ID cannot be identical.
• White space is not permitted.
Password Aging
Password aging is a feature provided by the network element to ensure that users change their passwords
periodically. This prevents unauthorized access into the system. Changing of password follows the
following rules:
A password change request is prompted when a user logs in to the GNM for the first time. This is a
mandatory action to be performed by every user. See “ED-PID (Edit-Password ID)” on page 8-30.
A password is valid for 90 days by default. This value can be overridden and can vary from 0-999. If
the time period is set to 0, the password never expires. See “ENT-USER-SECU (Enter-User-Security)” on page 8-16.
Users are not encouraged to use the same password on a rotation basis. A history of the previously
used passwords is maintained by the network element. The count of the number of the passwords to
be stored is configured. See “SET-ATTR-SECULOG (Set-Attributes)” on page 8-33 for a procedural
explanation.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-8
User Management
Audit Logging
The network elements maintain an independent audit log to record all activities and security related events
performed on the managed network element. Security related events can be unauthorized attempts or
excessive authentication attempts.The following TL1 commands are used to provide warning messages
upon successful login of the TL1 user:
“SET-ATTR-SECULOG (Set-Attributes)” on page 8-33
“REPT^EVT^SESSION (Report-Event-Session)” on page 8-32
Managing Security Parameters
The following TL1 commands are used to manage the security parameters:
“SET-ATTR-SECUDFLT (Set-Default Security Attributes)” on page 8-34
“REPT^ALM^SECU (Report-Security-Alarms)” on page 8-37
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-9
TL1 Commands
The following security related commands are supported:
“ACT-USER (Activate-User)” on page 8-10
“CANC-USER (Cancel-User)” on page 8-12
“ENT-USER-SECU (Enter-User-Security)” on page 8-16
“ED-USER-SECU (Edit-User-Security)” on page 8-19
“DLT-USER-SECU (Delete-User-Security)” on page 8-22
“RTRV-USER-SECU (Retrieve-User-Security)” on page 8-24
“INH-USER-SECU (Inhibit-User)” on page 8-26
“ALW-USER-SECU (Allow-User)” on page 8-28
“ED-PID (Edit-Password ID)” on page 8-30
“REPT^EVT^SESSION (Report-Event-Session)” on page 8-32
“SET-ATTR-SECULOG (Set-Attributes)” on page 8-33
“SET-ATTR-SECUDFLT (Set-Default Security Attributes)” on page 8-34
“RTRV-DFLT-SECU (Retrieve-Default Security Attributes)” on page 8-38
“CANCEL Session (Time-out)” on page 8-36
“REPT^ALM^SECU (Report-Security-Alarms)” on page 8-37
“RTRV-DFLT-SECU (Retrieve-Default Security Attributes)” on page 8-38
“RTRV-AUDIT-SECULOG (Retrieve-Audit-Security-Logs)” on page 8-40
“RTRV-ATTR-SECULOG (Retrieve-Attributes)” on page 8-43
“RTRV-STATUS (Retrieve Status)” on page 8-45
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-10
TL1 Commands
ACT-USER (Activate-User)
Command Description
This command is used to login to a network element and to start a TL1 session.
Command Syntax
ACT-USER:[<TID>]:<UID>:<CTAG>::<PID>;
Table 8-4 ACT-USER Command Usage
Section
User Access Privilege Level
Description
Security Administrator, Monitoring Access, Network Administrator, Network
Engineer, Provisioning, Test and Turn-up
Pre-condition
Telnet session should be established first.
Post-condition
Upon successful login, a default warning message is displayed (via
REPT^EVT^SESSION), which is as follows:
NOTICE: This is a private computer system. Unauthorized access or usemay lead to prosecution.
The NOTICE message can be modified and customized by using the command SET-ATTR-SECULOG
When the command is denied, no Error code pertaining to illegal UID or illegal PID will be returned.
After the successful login, the response will include the Date and time of
the last successful login and also include the number of invalid login
attempts before the last successful login.
Related Commands
None
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
^^^"<UID>:YY-MM-DD,HH:MM:SS,NUMINVLOGINS" <cr> <lf>;
ICNV, IICT, IISP, IITA (See Table 2-6 on page 2-14).
Error Codes
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-11
Table 8-5 ACT-USER Command Parameters Description
Parameter
Description
Valid Range
Default
UID
User Identifier
Between 4 and 10 alphanumeric characters
Mandatory
PID
Password Identifier
Series of a maximum of 10 alphanumeric characters and alphabets
Mandatory
Example
Use the following command to login to network element and to start a TL1 session .
ACT-USER::secadmin:ctag::*********;
Output
The following response message is returned indicating successful completion.
NC36 05-02-28 06:21:25
M
c COMPLD
"secadmin:2005-02-26,12-36-34,6"
;
The following event is generated after the successful login.
A
0 REPT EVT SESSION
"emsadmin:NO,54-DAY"
/*NOTICE: This is a private computer system. Unauthorized access or use may
lead to prosecution.*/;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-12
TL1 Commands
CANC-USER (Cancel-User)
Command Description
This command is used to logout from the current TL1 session.
Command Syntax
CANC-USER:[<TID>]:<UID>:<CTAG>;
Table 8-6 CANC-USER Command Usage
Section
Description
User Access Privilege Level
Security Administrator, Monitoring Access, Network Administrator, Network Engineer, Provisioning, Test and Turn-up
Pre-condition
The user is logged in.
Post-condition
The user account is logged out.
Related Commands
CANC-USER-SECU (Cancel-User-Security)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
Standard
PLNA , PICC, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on page 2-
Error Codes
14).
Table 8-7 CANC-USER Command Parameters Description
Parameter
UID
Description
User Identifier
Valid Range
Between 4 and 10 alphanumeric characters
Default
Mandatory
Example
Use the following command to logout from current TL1 session.
CANC-USER::secadmin:ctag;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-13
Output
The following message is returned indicating successful completion.
NE1 05-02-17 09:34:01
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-14
TL1 Commands
CANC-USER-SECU (Cancel-User-Security)
Command Description
This command is used to force logout a user from the TL1 session. This command is different from the
CANC-USER command, while CANC-USER can be used by session user to log off his own session.
This command is reserved for security administrator to log off the session of other user.
Command Syntax
CANC-USER-SECU:[<TID>]:<UID>:<CTAG>::[<SESSID>];
Table 8-8 CANC-USER-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
None
Post-condition
If the command is successful, the user is logged out
Related Commands
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
Standard
Error Codes
PLNA, PICC, PIUI, IENE, IDNV, IICM, IICT, IISP, IITA (See Table 26 on page 2-14).
Table 8-9 CANC-USER-SECU Command Parameter Description
Parameter
TL1 User Guide
Description
Release 1.2
Valid Range
Default
UTStarcom Inc.
Security and Access Management
Page 8-15
Table 8-9 CANC-USER-SECU Command Parameter Description
UID
User Identifier
A string of 4 to 10 characters with at least
4 alphanumeric characters
Mandatory
SESSID
Session ID of the session
to be logged off
String of characters and numerals
All sessions
(If the Session
ID is not specified, then all
the sessions of
the user will be
force logged
off)
Note: The current session of the user issuing the CANC-USER-SECU is not logged off.
Example
Use the following command to force logout a user from the TL1 session with the given session ID.
CANC-USER-SECU::secadmin:c;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:06:00
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-16
TL1 Commands
ENT-USER-SECU (Enter-User-Security)
Command Description
This command is used to create a new TL1 user account. The maximum number of users that can be
created is limited to 500.
Note: Password aging and password rotation are supported.
Command Syntax
ENT-USER-SECU:
[<TID>]:<UID>:<CTAG>::<pid>,,[<uap>]:[<PAGE=page>][,<TMOUT=tmout>][,<DISPNAME=
dispname>][,<PHONENUM=phonenum>][,<MOBILENUM=mobilenum>][,<PAGERNUM=pagernum>]
[,<EMAIL=email>][,<EMSMGMT=TRUE|FALSE>];
Table 8-10 ENT-USER-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
None
Post-condition
If the command is successful, new user account is created
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
Standard
Error Codes
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
page 2-14).
Table 8-11 ENT-USER-SECU Command Parameter Description
Parameter
UID
TL1 User Guide
Description
User identifier
Release 1.2
Valid Range
String of 4 to 10 characters with at
least 4 alphanumeric characters
Default
Mandatory
UTStarcom Inc.
Security and Access Management
Page 8-17
Table 8-11 ENT-USER-SECU Command Parameter Description
PID
Password Identifier
Series of a maximum of 10 alphanumeric characters and alphabets
Mandatory
UAP
User Access Privilege
Grouping supported. See
Monitoring
Access (MA)
“Access Privileges” on page 84.
PAGE
Password Aging in Days.
0 to 999
99 (disabled)
TMOUT
Inactivity Timeout in Minutes.
The value of zero means feature is disabled.
5 to 90
15 minutes
DISPNAME
Display name of the user
account
String of characters and numerals
Not Applicable
PHONENUM
Phone Number of the user
String of numerals
Not Applicable
MOBILENUM
Cell phone number of the user
String of numerals
Not Applicable
PAGERNUM
Pager Number of the user
String of numerals
Not Applicable
EMAIL
Email Contact of the user
String of characters and ‘@’
Not Applicable
EMSMGMT
Flag to enable EMS admin privileged account
true, false
false
Example
Use the following command to create a user account.
ENT-USER-SECU::test:c::*********,,SA&NA&NE;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:08:56
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-18
TL1 Commands
Creating Users on Network Element
User accounts can be configured so that the network element can be accessed by the EMS server using
this account. TL1 provides an option to enable this while creating a new TL1 user account.
An user account used by the EMS server must meet the following criteria.
The account must have ALL security privileges assigned to it.
The account does not require its password to be changed.
The account is not temporarily or permanently locked (disabled).
Inactivity Timeout should be ‘0’.
Refer to “ENT-USER-SECU (Enter-User-Security)” on page 8-16 for the command syntax and command
parameters description.
Example
Use the following command to create MPower EMS Server account.
ENT-USER-SECU::User1:c::*******,,SA&NA&NE:EMSMGMT=TRUE;
Output
R2B1NE1 04-07-16 11:13:58
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-19
ED-USER-SECU (Edit-User-Security)
Command Description
This command is used to modify the security attributes associated with the user account.
Command Syntax
ED-USERSECU:[<TID>]:<UID>:<CTAG>::[<newuid>],[<newpid>],,[<uap>]:[<PAGE=page>][,<TMO
UT=tmout>][,<DISPNAME=dispname>][,<PHONENUM=phonenum>][,<MOBILENUM=mobilenum>
][,<PAGERNUM=pagernum>][,<EMAIL=email>][,<PWDCHNG=TRUE|FALSE>][,<EMSMGMT=TRUE
|FALSE>];
Table 8-12 ED-USER-SECU Command Usage
Section
Description
User Access Privilege
Level
Security Administrator
Pre-condition
User account exists
Post-condition
On successful completion, the user account parameters change
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
Standard
Error Codes
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
page 2-14).
Table 8-13 ED-USER-SECU Command Parameters Description
Parameter
UID
UTStarcom Inc.
Description
User identifier
Valid Range
Default
String of 4 to 10 characters with at
least 4 alphanumeric characters
Mandatory
TL1 User Guide
Release 1.2
Page 8-20
TL1 Commands
Table 8-13 ED-USER-SECU Command Parameters Description
NEWUID
User identifier
String of 4 to 10 characters with at
least 4 alphanumeric characters
Optional
(This is not
supported in
the current
release. It is
there for standards compliance)
NEWPID
Password Identifier
Series of a maximum of 10 alphanumeric characters and alphabets
Optional.
UAP
User Access Privilege
See “Access Privileges” on
page 8-4.
Not Applicable
PAGE
Password aging period, in days.
0 to 999
0 (disabled)
TMOUT
Inactivity timeout period, in minutes. A zero value means feature is disabled.
0 to 90
15 minutes
DISPNAME
Display name for the user
account
String of characters and numerals
Not Applicable
PHONENUM
Phone number of the user
String of numerals
Not Applicable
MOBILENUM
Cell phone number of the user
String of numerals
Not Applicable
PAGERNUM
Pager number of the user
String of numerals
Not Applicable
EMAIL
Email contact of the user
String of characters and ‘@’
Not Applicable
PWDCHNG
Need to change the password
true, false
Not Applicable
EMSMGMT
Flag to enable EMS admin privileged account
true, false
false
Note: In the above Table 8-13, NEWUID parameter is not supported.
Example
Use the following command to modify the security parameters of a user account.
ED-USER-SECU::User1:CTAG::,,,MA&NA&NE&TT&PR&SA:TMOUT=0;
Output
The following message is returned indicating successful completion.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-21
NE1 05-02-20 09:08:16
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-22
TL1 Commands
DLT-USER-SECU (Delete-User-Security)
Command Description
This command is used to delete a user account.
Command Syntax
DLT-USER-SECU:[<TID>]:<UID>:<ctag>;
Table 8-14 DLT-USER-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
The user must have logged out of the session.
Post-condition
The user account is deleted on success.
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
Standard
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
Error Codes
page 2-14).
Table 8-15 DLT-USER-SECU Command Parameters Description
Parameter
UID
Description
User Identifier
Valid Range
String of 4 to 10 characters with at least 4 alphanumeric characters
Default
Mandatory
Example
Use the following command to delete a user account.
DLT-USER-SECU::test12:ctag:;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-23
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:08:16
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-24
TL1 Commands
RTRV-USER-SECU (Retrieve-User-Security)
Command Description
This command is used to view the security parameters of an user account.
Command Syntax
RTRV-USER-SECU:[<TID>]:[UID]:<CTAG>;
Table 8-16 RTRV-USER-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
The user account exists
Post-condition
None
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
(^^^"<UID>:,<UAP>:<KEYWORD BLOCK>" <cr> <lf>)*;
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
page 2-14).
Error Codes
Table 8-17 RTRV-USER-SECU Command Parameters Description
Parameter
UID
TL1 User Guide
Description
User Identifier
Release 1.2
Valid Range
String of 4 to 10 characters with at
least 4 alphanumeric characters
Default
All users
UTStarcom Inc.
Security and Access Management
Page 8-25
Table 8-18 RTRV-USER-SECU Response Parameters Description
Keyword
Description
UID
User Identifier
UAP
User Access Privilege
PAGE
Password aging period, in days.
TMOUT
Inactivity time-out period, in minutes.
DISPNAME
Display name for the user account
PHONENUM
Phone number of the user
MOBILENUM
Cell phone number of the user
PAGERNUM
Pager number of the user
EMAIL
Email contact of the user
PWDCHNG
Need to change the password
EMSMGMT
EMS Management Flag (True or False)
PWDEXP
Remaining days for the current password to expire
TMPLOCK
The user is temporarily locked out
LOCKEDOUT
The state of the user account. Whether inhibited or allowed. If the user is inhibited, the value is TRUE otherwise it is set to FALSE.
Example
Use the following command to view the security parameters of a user account.
RTRV-USER-SECU:::c;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:09:59
M
c COMPLD
"ems16:MA&SA&NA&NE&PR&TT:PAGE=90,TMOUT=15,DISPNAME=,PHONENUM=,MOBILENUM=,PAGE
RNUM=,EMAIL=,PWDCHNG=false,EMSMGMT=True,PWDEXP=80,TMPLOCK=false,LOCKEDOUT=fal
se"
"emsadmin:MA&SA&NA&NE&PR&TT:PAGE=90,TMOUT=0,DISPNAME="EMS
Administrator",PHONENUM=,MOBILENUM=,PAGERNUM=,EMAIL=,PWDCHNG=false,EMSMGMT=Tr
ue,PWDEXP=69,TMPLOCK=false,LOCKEDOUT=false";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-26
TL1 Commands
INH-USER-SECU (Inhibit-User)
Command Description
This command is used to disable the user account.
Command Syntax
INH-USER-SECU:[<TID>]::<CTAG>::<UID>;
Table 8-19 INH-USER-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
The user account specified by UID exists and not disabled.
Post-condition
The user account is disabled to access the network element.
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
ALW-USER-SECU (Allow-User)
ED-PID (Edit-Password ID)
Response Format
Standard
Error Codes
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on page 2-14).
Table 8-20 INH-USER-SECU Command Parameters Description
Parameter
UID
Description
User Identifier
Valid Range
String of 4 to 10 characters with at
least 4 alphanumeric characters
Default
Mandatory
Example
Use the following command to disable the security permissions of the user.
INH-USER-SECU:::ctag::netadmin;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-27
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:10:49
M
ctag COMPLD;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-28
TL1 Commands
ALW-USER-SECU (Allow-User)
Command Description
This command is used to enable the user account.
Command Syntax
ALW-USER-SECU:[<TID>]::<CTAG>::<UID>;
Table 8-21 ALW-USER-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
The user account specified by UID exists and disabled.
Post-condition
The user account is enabled to access the network element.
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ED-PID (Edit-Password ID)
Response Format
Standard
Error Codes
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on page 2-14).
Table 8-22 ALW-USER-SECU Command Parameters Description
Parameter
UID
Description
User Identifier
Valid Range
String of 4 to 10 characters with at least 4
alphanumeric characters
Default
Mandatory
Example
Use the following command to enable an user account.
ALW-USER-SECU:::ctag::netadmin;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-29
Output
The following message is returned indicating successful completion
UTSTARCOM 05-02-20 09:11:37
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-30
TL1 Commands
ED-PID (Edit-Password ID)
Command Description
This command is used to modify the password of a given user. The old and the new password are
specified in this command.
Note: The security administrator as well as the individual user can change the password of an
user account.
Command Syntax
ED-PID:[<TID>]:<UID>:<CTAG>::<OLDPID>,<NEWPID>;
Table 8-23 ED-PID Command Usage
Section
Description
User Access Privilege Level
Security Administrator, Monitoring Access, Network Administrator,
Network Engineer, Provisioning, Test and Turn-up
Pre-condition
None
Post-condition
The new password is applied.
Related Commands
CANC-USER-SECU (Cancel-User-Security)
CANC-USER (Cancel-User)
ENT-USER-SECU (Enter-User-Security)
ED-USER-SECU (Edit-User-Security)
DLT-USER-SECU (Delete-User-Security)
RTRV-USER-SECU (Retrieve-User-Security)
INH-USER-SECU (Inhibit-User)
ALW-USER-SECU (Allow-User)
Response Format
Standard
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
Error Codes
page 2-14).
Table 8-24 ED-PID Command Parameters Description
Parameter
UID
TL1 User Guide
Description
User Identifier
Release 1.2
Valid Range
String of 4 to 10 characters with at
least 4 alphanumeric characters
Default
Mandatory
UTStarcom Inc.
Security and Access Management
Page 8-31
Table 8-24 ED-PID Command Parameters Description
OLDPID
The old password identifier
Series of a maximum of 10 alphanumeric characters and alphabets
Mandatory
NEWPID
The new password identifier
Series of a maximum of 10 alphanumeric characters and alphabets
Mandatory
Example
Use the following command to modify a user password.
ED-PID::admin:CTAG::*********,*********;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:12:23
M
CTAG COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-32
TL1 Commands
REPT^EVT^SESSION (Report-Event-Session)
Message Description
This is an autonomous message transmitted by the network element to a user or an administrator
indicating the occurrence of a condition related to the following:
Password Expiry: The user password has expired and needs to be changed using the ED-PID command.
Password about to expire.
The user has successfully logged into the system. In this case a warning message is reported with
this message to warn intruders of legal implications of intrusion.
The user has successfully logged into the system. This informs the user about when the user’s password will expire.
Message Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
A^^<ATAG>^REPT^EVT^SESSION <cr> <lf>
^^^<Quoted ASCII string><cr> <lf>
;
In case of successful login, the quoted string displayed is the same as the WARN attribute of the SETATTR-SECULOG command. Default is
“NOTICE: This is a private computer system. Unauthorized access or use may lead
to prosecution.
In case of password expiry, the quoted string displayed is as follows:
“<UID>:,PIDAGE, \” Before proceeding, you are required to change your password
\”\””
In case the password about to expire, the string displayed is as follows:
“<UID>: \” Your password will be expired in xxx days \”\””
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-33
SET-ATTR-SECULOG (Set-Attributes)
Command Description
This command is used to set warning message that appears when the user successfully logs into the
system.
Command Syntax
SET-ATTR-SECULOG:[<TID>]:[AID]:<CTAG>:::[<WARN=warn>];
Table 8-25 SET-ATTR-SECULOG Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
Successful login
Post-condition
The warning message is set.
Related Commands
RTRV-ATTR-SECULOG (Retrieve-Attributes)
Response Format
Standard
PLNA , PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
Error Codes
page 2-14).
Table 8-26 SET-ATTR-SECULOG Command Parameters Description
Parameter
WARN
Description
Text string of upto 1600
characters
Valid Range
Upto 20 lines with 80 characters per line
Default
Mandatory
Example
Use the following command to set the warning message.
SET-ATTR-SECULOG:::ctag:::warn="warning message";
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:14:53
M
ctag COMPLD;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-34
TL1 Commands
SET-ATTR-SECUDFLT (Set-Default Security Attributes)
Command Description
This command is used to set the default security attributes on the network element.
Command Syntax
SET-ATTR-SECUDFLT:
[<TID>]::[<CTAG>]:::[MXINV=<mxinv>][,PWDROT=<pwdrot>][,<DURAL=dural>];
Table 8-27 SET-ATTR-SECUDFLT Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
These settings are applied during user account creation.
Post-condition
The default security parameters are set.
Related Commands
RTRV-ATTR-SECULOG (Retrieve-Attributes)
Response Format
Standard
Error Codes
PLNA , PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
page 2-14).
Table 8-28 SET-ATTR-SECUDFLT Command Parameters Description
Parameter
Description
Valid Range
Default
MXINV
The maximum number of invalid login attempts allowed.
The value 0 implies the feature is disabled. i.e allowed to
attempt infinite number of times.
0 to 10
3
PWDROT
This is the password rotation attribute and is used to
block the last X number of passwords not to be re-used
when the password needs to be changed. The value 0
1 to 5
1
0 to 60 minutes
0
implies the feature is disabled. i.e. the user can reuse his previous password.
DURAL
Duration for the lockout
Example
Use the following command to set the default security attributes.
SET-ATTR-SECUDFLT:::ctag:::MXINV=4,PWDROT=2;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-35
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:16:11
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-36
TL1 Commands
CANCEL Session (Time-out)
Message Description
This is an autonomous message transmitted by the network element to the user when a TL1 session
established by the user is terminated because of “Time-out”, i.e, no user interaction happened in that
session for an interval equal to TMOUT interval.
Message Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
A^^<ATAG>^CANC <cr> <lf>
<UID> <cr> <lf>);
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-37
REPT^ALM^SECU (Report-Security-Alarms)
Message Description
This is an autonomous message transmitted by the network element to an administrator indicating the
occurrence of an alarm condition related to security administration.
The following events trigger this alarm:
Intrusion Attempt: There are several attempts to login with invalid user or password and ultimately,
the number of attempts have gone over the limit configured by MXINV attribute (See Table 8-28 on
page 8-34).
Message Format
In case of intrusion detection, the following format is used
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
A^<ATAG>^REPT^ALM^SECU <cr> <lf>
^^^"<UID>:,INTRUSION" cr lf
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-38
TL1 Commands
RTRV-DFLT-SECU (Retrieve-Default Security Attributes)
Command Description
This command is used to view the default security attributes.
Command Syntax
RTRV-DFLT-SECU:[<TID>]::<CTAG>;
Table 8-29 RTRV-DFLT-SECU Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
SID DATE TIME
M CTAG COMPLETION CODE
"::[<MXINV=mxinv>][,<PWDROT=pwdrot>][,<MAXSESS=maxsess>][,<DURAL=dural>]"
;
Error Codes
PLNA, PICC, PIUI, IICM, IICT, IISP, IITA (See Table 2-6 on
page 2-14).
Table 8-30 RTRV-DFLT-SECU Response Parameters Description
Parameter
Description
MXINV
The maximum number of invalid login attempts allowed. The values are 0 to10.
The default is 3. The value 0 implies the feature is disabled. i.e, infinite number of
attempts are allowed.
PWDROT
This is the password rotation attribute and is used to block the last X number of
passwords not to be re-used when the password needs to be changed. The values are 0 to 5. The default is 1. The value 0 implies the feature is disabled, that is,
the user can re-use his previous password.
MAXSESS
This is the maximum number of session allowed to be active on a given network
element simultaneously. Default is30.
DURAL
Duration for the lockout
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-39
Example
Use the following command to view the default security attributes.
RTRV-DFLT-SECU:::ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:17:58
M
ctag COMPLD
"::MXINV=4,PWDROT=3,MAXSESS=30,DURAL=60"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-40
TL1 Commands
RTRV-AUDIT-SECULOG (Retrieve-Audit-Security-Logs)
Command Description
This command is used to view the records from security log, primarily for audit purposes. The security log
is a circular buffer where the existing records are replaced with the latest records.
The events that are logged into this circular buffer include EVENTS: REPT^ALM^SECU and
REPT^EVT^SESSION
Command Syntax
RTRV-AUDIT-SECULOG:[<TID>]::<CTAG>:::[<LOGEVENT=EVENTS|COMMANDS|ALL>];
Table 8-31 RTRV-AUDIT-SECULOG Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
/*
( <EVENTS> | <COMMANDS>) *
*/
For the EVENTS related logs, the format followed is same as that of
REPT^EVT^SECU and REPT^EVT^SESSION.
For the COMMANDS related logs, the format is as follows:
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD/DENY <cr> <lf>
^^^"<UID>:<COMMAND>:[<AID>]:[Position Description]:<KEYWORD
BLOCK>" <cr> <lf>
PLNA, PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
Error Codes
page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-41
Table 8-32 RTRV-AUDIT-SECULOG Command Parameters Description
Parameter
LOGEVENT
Description
The event to be retrieved
Valid Range
Default
EVENTS: REPT^EVT^SESSION and REPT^EVT^SECU
events are retrieved
ALL
COMMANDS: All user initiated
commands from the security log
are retrieved
ALL: All types of events from the
security log are retrieved.
Example
Use the following command to view the default security attributes.
RTRV-AUDIT-SECULOG:::C:::LOGEVENT=COMMANDS;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:18:57
M
C RTRV
"
UTSTARCOM 2005-02-18 13-41-04
M
CTAG DENY
":ACT-USER:sachink::MGMTAPPL=EMS,HOST=10.10.9.149-38819,MGMTPROTO=XML:"
"
"
UTSTARCOM 2005-02-18 13-43-09
M
CTAG DENY
":ACT-USER:emsadmin::MGMTAPPL=EMS,HOST=10.10.9.20-55900,MGMTPROTO=XML:"
"
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-42
TL1 Commands
"
UTSTARCOM 05-02-20 09:19:43
M
C COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-43
RTRV-ATTR-SECULOG (Retrieve-Attributes)
Command Description
This command is used by the administrator to view the warning message that appears when the user
successfully logs into the system.
Command Syntax
RTRV-ATTR-SECULOG:[<TID>]:[AID]:<CTAG>;
Table 8-33 RTRV-ATTR-SECULOG Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
SID DATE TIME
M CTAG COMPLETION CODE
"[AID]::[<WARN=warn>]"
;
PLNA , PICC, PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
Error Codes
page 2-14).
Table 8-34 RTRV-ATTR-SECULOG Response Parameters Description
Parameter
WARN
Description
Text string of upto 1600 characters (20 lines*80 characters per line)
Example
Use the following command to view the default security attributes.
RTRV-ATTR-SECULOG:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:23:27
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-44
M
TL1 Commands
ctag COMPLD
"::WARN="warning message""
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Security and Access Management
Page 8-45
RTRV-STATUS (Retrieve Status)
Command Description
This command is used to view the list of active sessions present on the network element.
Command Syntax
RTRV-STATUS:[<TID>]:[SESNID]:<CTAG>;
Table 8-35 RTRV-STATUS Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
SID DATE TIME
M CTAG COMPLETION CODE
"[SESNID]::[<UID=uid>][,<LOGONDATE=logondate>][,<LOGONTIME=logontime>][,
<CLIENTADDR=clientaddr>][,<PROTO=proto>][,<MGMTPROTO=mgmtproto>][,<PRIVILEGE=privilege>][,
<NEEDCHGPASSWD=needchgpasswd>]"
;
Error Codes
PLNA, PICC,PIUI, IDNV, IICM, IICT, IISP, IITA (See Table 2-6 on
page 2-14).
Table 8-36 RTRV-STATUS Command Parameters Description
Parameter
SESNID
Description
Session identifier
Valid Range
Default
String of characters and numerals
All sessions
Table 8-37 RTRV-STATUS Response Parameters Description
Parameter
Description
SESNID
Session identifier
UID
User identifier
LOGONDATE
Last logon date
LOGONTIME
Last logon time
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 8-46
TL1 Commands
Table 8-37 RTRV-STATUS Response Parameters Description
Parameter
Description
CLIENTADDR
Address of the client machine
PROTO
Communication protocol
MGMTPROTO
Manage application protocol
Example
Use the following command to view the active sessions.
RTRV-STATUS:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:24:02
M
ctag COMPLD
"secadmin_14347::UID=secadmin,LOGONDATE=2005-02-28,LOGONTIME=06-2125,CLIENTADDR=10.10.9.95-13062,PROTO=TELNET,MGMTPROTO=TL1"
"emsadmin_17672::UID=emsadmin,LOGONDATE=2005-02-19,LOGONTIME=09-2929,CLIENTADDR=10.10.9.20-33181,PROTO=XML,MGMTPROTO=EMS"
"emsadmin_17674::UID=emsadmin,LOGONDATE=2005-02-19,LOGONTIME=09-2949,CLIENTADDR=10.10.9.16-54236,PROTO=XML,MGMTPROTO=EMS"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
CHAPTER 9
Software Maintenance
Management of the network element software consists of the following tasks.
Backing up the network element database periodically
Restoring the network element database when necessary
Upgrading software when new releases are issued
This chapter provides procedures to perform the above tasks in the following sections.
Software Maintenance TL1 Commands
Software Maintenance Procedures
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-2
Software Maintenance TL1 Commands
Software Maintenance TL1 Commands
The following commands are used for software installation, maintenance, upgrade and database upload
operations.
COPY-RFILE (Copy File)
RTRV-RFILE (Retrieve File)
DLT-RFILE (Delete File)
COMP-RFILE (Compress File)
APPLY
CPY-MEM
Software Maintenance Procedures
SCHED-BKUP (Schedule Backup)
RTRV-BKUPSCHED (Retrieve Backup Schedule)
ED-FXFR (Edit File Transfer Object)
RTRV-FXFR (Retrieve File Transfer Object)
The following events are raised in response to some of the above commands
REPT^EVT^FXFR (Report Event FileTransfer)
RTRV^EVT^COM
REPT^BKUP (Report Backup)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-3
COPY-RFILE (Copy File)
Command Description
This command is used to initiate FTP between the network element and the host. This command is used to
achieve the following goals:
Software download from the FTP server to the network element.
Database upload (backup) from the network element to an external location.
Database download (external restore) from an external location to the network element.
In addition, it is also used to take backup of 15-MIN and 1-DAY PM data and backup of debug interface craft dump. This is an extension of the standard command.
Command Syntax
COPYRFILE:[<TID>]::<CTAG>:::<TYPE=SWDL|RFR|RFBU|PM15|PM1DAY|DBI>[,<SRC=src>][,<DS
T=dst>][,<OVWRT=YES|NO>];
Table 9-1 COPY-RFILE Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
A REPT^EVT^FXFR event is generated describing the status of the
file transfer.
Related commands
RTRV-RFILE (Retrieve File)
DLT-RFILE (Delete File)
Response Format
Standard
Error codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-4
Software Maintenance TL1 Commands
Table 9-2 COPY-RFILE Command Parameters Description
Parameter
Description
Valid Range
Default
OVWRT
Overwrite flag
YES, NO
YES
TYPE
Type of transfer
that is being
requested.
SWDL: Download a
new software image
Mandatory
RFR: Restore the
database
RFBU: Backup
(upload) the database
PM15: Download
Transfer of 15 minutes PM file
PM1DAY: Download
Transfer of 1day PM
file
DBI: Debug File
SRC
Source URL
Ftpurl
Fileurl
The following formats can be used for ftp
specifications:
For FTP ìftp:[//[<userid>[:<password>]@]<ftphost>[:<port>]]/<url-path>î
SRC has to be specified when TYPE is
SWDL or RFR
DST
Destination URL
Ftpurl
Fileurl
The following formats can be used for ftp
specifications:
For FTP ìftp:[//[<userid>[:<password>]@]<ftphost>[:<port>]]/<url-path>î
DST has to be specified when TYPE is
RFBU, PM15, PM1DAY, or DBI.
Example 1
Use the following command to backup the data base present from current DB to external host at
10.10.72.63.
COPY-RFILE:::ctag:::TYPE=RFBU,DST="ftp://guest:*****@10.10.72.63//home/guest/
backup1/";
Note: Password is echoed as asterisk.
Output
The following message is returned indicating successful completion.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-5
swc214 04-07-16 11:32:22
M
ctag COMPLD
;
TL1>>
swc214 04-07-16 11:32:29
A
2 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:File transfer process started"
;
TL1>>
swc214 04-07-16 11:32:32
A
3 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:Copy File Completed"
Example 2
Use the following command to restore a database file from server whose IP address is 10.10.72.63
COPY-RFILE:::ctag:::TYPE=RFR,SRC="ftp://guest:*****@10.10.72.63//home/guest/
moon/R1.2.0_224";
Output
The following message is returned indicating successful completion.
swc214 04-07-16 11:32:56
M
ctag COMPLD
;
TL1>>
swc214 04-07-16 11:32:57
A
4 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:File transfer process started"
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-6
Software Maintenance TL1 Commands
;
TL1>>
swc214 04-07-16 11:33:01
A
5 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:Copy File Completed"
Example 3
Use the following command to download software file from server whose IP address is 10.10.72.63
COPY-RFILE:::ctag:::TYPE=SWDL,SRC="ftp://guest:*****@10.10.72.63//home/guest/
moon/R1.2.0_224.ppc";
Output
The following message is returned indicating successful completion.
swc214 04-07-16 11:32:56
M
ctag COMPLD
;
TL1>>
swc214 04-07-16 11:32:57
A
4 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:File transfer process started"
;
TL1>>
swc214 04-07-16 11:33:01
A
5 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:Copy File Completed"
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-7
RTRV-RFILE (Retrieve File)
Command Description
This command is used to view a list of SW or DB files from the network element. The AID field supports
ALL option.
Command Syntax
RTRV-RFILE:[<TID>]::<CTAG>:::[<LOCN=locn>][,<TYPE=SW|DB>];
Table 9-3 RTRV-RFILE Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Monitoring Access, Provisioning, Test and Turn-up, Security Administrator
Pre-condition
Not Applicable
Post-condition
Not applicable
Related commands
COPY-RFILE (Copy File)
DLT-RFILE (Delete File)
Response Format
cr lf lf
^^^<TID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^î<AID>:<FILE>,<SIZE>,<CRDATE>,<CRTIME>,<SWVERSION>,<FORMAT>,<VALIDITY>,<USAGE>,<NODEID>,<DBBKPDATE>,<DBBKPTIME>î cr lf]*
The following response is returned when there is no file on the FLASH.
cr lf lf
^^^<TID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
^^^î/* No files found */î cr lf
Error codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-8
Software Maintenance TL1 Commands
Table 9-4 RTRV-RFILE Command Parameters Description
Parameter
TYPE
LOCN
Description
Valid Range
Type of transfer that is
being requested.
SW: Software
Location of the file
The URL of the file to be retrieved file://
[<localhost>]/<url-path>
DB: Database
Default
If TYPE is not
specified, files
with a given name
of both types are
retrieved. If one of
them is present
only that gets
retrieved.
Not Applicable
Table 9-5 RTRV-RFILE Response Parameters Description
Parameter
Description
FILE TYPE
The file type
FILE
Name of the File being retrieved
SIZE
Size of the file
CRDATE
Creation Date
CRTIME
Creation Time.
SWVERSION
Software Version.
FORMAT
Format of the file. This attribute is used to specify whether the file is compressed or normal.
VALIDITY
This attribute is used to specify whether the file is valid or not.
USAGE
This keyword is used to specify the file that is currently running or is
upgraded or backed up.
NODEID
This is the Node ID used in branding.
DBBKUPDATE
Database Backup Date
DBBKUPTIME
Database Backup Time
Example 1
Use the following command to view all the files (SW and DB) in the network element.
RTRV-RFILE:::ctag;
Output
The following message is returned indicating successful completion.
blr886 05-02-24 18:11:45
M
ctag COMPLD
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-9
"::FILE=A1.3.0.0500_20050220152815,FILETYPE=DB,SIZE=11354966,CRDAT=2005-0220,CRTIME=15-3203,SWBUILD=,SWVERSION=R1.2.0.0223,FORMAT=Normal,VALIDITY=Good,USAGE=Backup,NO
DEID=PA2604080059,DBBKPDATE=UNKNOWN,DBBKPTIME=UNKNOWN"
"::FILE=Db_20050218165037,FILETYPE=DB,SIZE=15095659,CRDAT=2005-0218,CRTIME=16-5656,SWBUILD=,SWVERSION=R1.2.0.0222,FORMAT=Compressed,VALIDITY=Good,USAGE=Backu
p,NODEID=PA2604080059,DBBKPDATE=2005-02-20,DBBKPTIME=15-39-54"
"::FILE=R1.2.0.0223_20050220135810,FILETYPE=DB,SIZE=6681174,CRDAT=2005-0220,CRTIME=13-5934,SWBUILD=,SWVERSION=R1.2.0.0223,FORMAT=Compressed,VALIDITY=Good,USAGE=Backu
p,NODEID=PA2604080059,DBBKPDATE=2005-02-20,DBBKPTIME=15-45-11"
"::FILE=main_1321_20050224142820,FILETYPE=DB,SIZE=2845696,CRDAT=2005-0224,CRTIME=14-3025,SWBUILD=,SWVERSION=main_1321,FORMAT=Normal,VALIDITY=Good,USAGE=Current,NOD
EID=PA2604080059,DBBKPDATE=UNKNOWN,DBBKPTIME=UNKNOWN"
"::FILE=A1.3.0.0500,FILETYPE=SW,SIZE=102111870,CRDAT=2005-02-19,CRTIME=011426,SWBUILD=,SWVERSION=1.0.50027,FORMAT=Normal,VALIDITY=Good,USAGE=Upgrade,NOD
EID=,DBBKPDATE=,DBBKPTIME="
"::FILE=R1.2.0.0224,FILETYPE=SW,SIZE=102111891,CRDAT=2005-02-18,CRTIME=115659,SWBUILD=,SWVERSION=1.0.50027,FORMAT=Compressed,VALIDITY=Good,USAGE=Upgrade
,NODEID=,DBBKPDATE=,DBBKPTIME="
"::FILE=main_1321,FILETYPE=SW,SIZE=96453834,CRDAT=2005-02-24,CRTIME=05-4533,SWBUILD=,SWVERSION=1.0.50025,FORMAT=Normal,VALIDITY=Good,USAGE=Current,NOD
EID=,DBBKPDATE=,DBBKPTIME="
;
Example 2
This is an example to retrieve files with name R1.2.0.0224.
RTRV-RFILE:::ctag:::LOCN="file:///R1.2.0.0224";
Output
blr886 05-02-24 18:19:41
M
ctag COMPLD
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-10
Software Maintenance TL1 Commands
"::FILE=R1.2.0.0224,FILETYPE=SW,SIZE=102111891,CRDAT=2005-02-18,CRTIME=115659,SWBUILD=,SWVERSION=1.0.50027,FORMAT=Compressed,VALIDITY=Good,USAGE=Upgrade,
NODEID=,DBBKPDATE=,DBBKPTIME="
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-11
DLT-RFILE (Delete File)
Command Description
This command is used to delete either an existing database or a software image present in the network
element.
Note: The current running software and the current database cannot be deleted.
Command Syntax
DLT-RFILE:[<TID>]::<CTAG>:::<FILE=file>[,<TYPE=SW|DB>];
Table 9-6 DLT-RFILE Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
The current running version of the file cannot be deleted.
Post-condition
Specified file will be deleted on successful execution
Related commands
COPY-RFILE (Copy File)
RTRV-RFILE (Retrieve File)
Response Format
Standard
Error codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP
(See Table 2-6 on page 2-14).
Table 9-7 DLT-RFILE Command Parameters Description
Parameter
Description
FILE
File name specification
TYPE
Type of file that is being deleted
Valid Range
The URL of the file to be deleted
file://[<localhost>]/<url-path>
Mandatory
SW: Software
If TYPE is not
specified, files
with a given name
of both types are
deleted. If one of
them is present
only that gets
deleted.
DB: Database
UTStarcom Inc.
Default
TL1 User Guide
Release 1.2
Page 9-12
Software Maintenance TL1 Commands
Note: The TYPE is optionally used to delete a file of either DB or SW with a given name. If TYPE
is not specified file with a given name is deleted for both SW and DB.
Example
Use the following command to delete the file.
DLT-RFILE:::ctag:::file="file:///R1.2.0.0224",type=db;
Output
The following message is returned indicating successful completion.
Ne105 04-05-13 03:23:05
M
ctag COMPLD
;
The response is accompanied by REPT^DBCHG indicating that DLT-RFILE deleted the given file.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-13
COMP-RFILE (Compress File)
Command Description
This command is used to compress a software image or a database file.
Note: The current software image and DB cannot be compressed.
Command Syntax
COMP-RFILE:[<TID>]::<CTAG>:::<FILE=file>[,<TYPE=SW|DB>];
Table 9-8 COMP-RFILE Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
File will be compressed upon successful execution
Related commands
COPY-RFILE (Copy File)
RTRV-RFILE (Retrieve File)
DLT-RFILE (Delete File)
Response Format
Standard
Error codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
Table 9-9 COMP-RFILE Command Parameters Description
Parameter
Description
Valid Range
Default
FILE
File name specification
The URL of the file to be compressed file://[<localhost>]/
<url-path>
Mandatory
TYPE
File type
SW: Software
If TYPE is not
specified, files with
a given name of
both types are
compressed. If
one of them is
present only that
gets compressed.
DB: Database
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-14
Software Maintenance TL1 Commands
Example
Use the following command to compress a software image or a database file.
COMP-RFILE:::ctag:::”file:///R1.2.0.0220”;
Output
The following message is returned indicating successful completion.
NE9188 04-04-30 18:38:57
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-15
APPLY
Command Description
This command is used to perform the upgrade, restore, revert or install operation to the downloaded
software/database. The OPERTYPE attribute is used to distinguish the type of operation being carried out.
The UPGRADE, INSTALL and REVERT options are applicable only to the software image files. The
RESTORE option is applicable only to the database image file.
Command Syntax
APPLY:[<TID>]::<CTAG>:::<FILENAME=filename>,<OPERTYPE=UPGRADE|INSTALL|REVERT|
INSTALLWITHEMPTYDB|RESTORE>[,<DBNAME=dbname>];
Table 9-10 APPLY Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
Not applicable
Post-condition
Not applicable
Related commands
COPY-RFILE (Copy File)
Response Format
Standard
Error codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
Table 9-11 APPLY Command Parameters Description
Parameter
Description
FILENAME
Name of the file to be used
for this command.
The URL of the SW file to be applied file://[<localhost>]/<url-path>.
DBNAME
DB file name to be used
Name of the DB file to be used when OPERTYPE=REVERT for this command. The system will
then revert to the given SW version given by FILENAME and DBNAME
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-16
Software Maintenance TL1 Commands
Table 9-11 APPLY Command Parameters Description
Parameter
OPERTYPE
Description
UPGRADE
The software and database are upgraded. This is the
default value
INSTALL
The software is installed with empty database
REVERT
The network element will be reverted to the specified
file
RESTORE
The Database is restored
This option is applicable only for a database file.
Default value is UPGRADE.
INSTALLWITHEMPTYDB
The software is installed with empty database. This
can be applied only on the current running software
image.
Example 1
Use the following example for APPLY when a upgrade operation is performed.
APPLY:::ctag:::FILENAME="file:///R1.2.0.0228",OPERTYPE=UPGRADE;
Output
The following message is returned indicating successful completion.
Ne105 04-05-13 03:23:05
M
ctag COMPLD
;
Example 2
Use the following example for APPLY when a revert operation is performed.
APPLY:::ctag:::FILENAME="file:///
R1.2.0.0220",OPERTYPE=REVERT,DBNAME=R1.2.0.0220;
Output
The following message is returned indicating successful completion.
Ne105 04-05-13 03:23:05
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-17
REPT^EVT^FXFR (Report Event FileTransfer)
Message Description
This is an autonomous message that is generated by the network element to report the results of the file
transfer initiated by COPY-RFILE.
Message Syntax
cr lf lf
^^^<TID>^<DATE>^<TIME> cr lf
A^^<ATAG>^REPT^EVT^FXFR cr lf
^^^î[AID]:<CONDTYPE>,<CONDDEFF>:[CONDDESCR]î cr lf
Table 9-12 on page 9-17 describes parameters specific to REPT^EVT message.
Table 9-12 REPT^EVT^FXFR Message Parameters
Parameter
CONDTYPE
Description
COPY-RFILE-COMPL
COPY-RFILE-FAIL
Copy File Completed
File Does Not Exist
File Already Exists
Insufficient Memory Space
File Transfer Protocol Failure
File Transfer Connection Failure
Checksum Failure
Example 1
This is an example of an event due to failed COPY-RFILE execution.
DBMG9 04-04-23 10:26:37
A 34 REPT EVT FXFR
":COPY-RFILE-FAIL,TC:File Transfer Connection Failure"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-18
Software Maintenance TL1 Commands
Example 2
This is an example of an event due to successful COPY-RFILE execution.
DBMG9 04-04-23 10:26:37
A 34 REPT EVT FXFR
":COPY-RFILE-COMPL,TC:Copy File Completed"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-19
CPY-MEM
Command Description
This command is used to perform a local backup on the network element.
Command Syntax
CPY-MEM:[<TID>]::<CTAG>::[<FROMMEM>],[<TOMEM>];
Table 9-13 CPY-MEM Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
Not Applicable
Related commands
REPT^EVT^FXFR (Report Event FileTransfer)
Response Format
Standard
Error codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14)
Table 9-14 CPY-MEM Command Parameters Description
Parameter
Description
FROMMEM
Specifies the functional memory, file or data area from which the data is to be copied
file://[<localhost>]/<url-path>. Default is current DB name.
TOMEM
Specifies the functional memory, file or data area to which the data is to be copied
file://[<localhost>]/<url-path>.
Example
Use the following command to do a local backup on the network element.
CPY-MEM:::ctag::"file:///main_857";
Output
The following message is returned indicating successful completion.
SQA21 04-06-10 22:24:11
M ctag COMPLD
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-20
Software Maintenance TL1 Commands
;
TL1>>
SQA21 04-06-10 22:24:11
A 4 REPT EVT COM
"main_857:DBCONTROL,TC,06-10,22-24-11,NEND,NA,,,:"
;
TL1>>
SQA21 04-06-10 22:24:11
A 5 REPT EVT COM
"Db_20040610222410:DBCONTROL,TC,06-10,22-24-11,NEND,NA,,,:"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-21
RTRV^EVT^COM
Message Description
This is an autonomous message that is generated by the network element to report the Transient
Condition that is reported as a result of the common conditions such as restart. This event is specifically
generated as a result of the execution of INIT-SYS, APPLY and CPY-MEM commands.
Message Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME>crl f
A^^<ATAG>^REPT^EVT^COM cr lf
^^^”[<AID>]:<CONDTYPE>,<CONDEFF>,<OCRDAT>,<OCRTM>,[<LOCN>],
<DIRN>,,,:”\< CONDDESCR >\””cr lf
;
Table 9-15 on page 9-21 describes parameters specific to RTRV^EVT^COM message.
Table 9-15 RTRV^EVT^COM Message Parameters
Parameter
CONDTYPE
Description
CONDEFF
TC - Transient Condition
OCRDAT
Date when the event occurred (mm-dd)
OCRTM
Time when the event occurred (hh-mm-ss)
LOCN
NEND
CONDDESCR
64 character string
Example
Use the following command to generate REPT^EVT^COM using CPY-MEM.
CPY-MEM:::ctag::"file:///main_857";
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-22
Software Maintenance TL1 Commands
Output
The following message is returned indicating successful completion.
SQA21 04-06-10 22:24:11
M ctag COMPLD
;
TL1>>
SQA21 04-06-10 22:24:11
A 4 REPT EVT COM
"main_857:DBCONTROL,TC,06-10,22-24-11,NEND,NA,,,:"
;
TL1>>
SQA21 04-06-10 22:24:11
A 5 REPT EVT COM
"Db_20040610222410:DBCONTROL,TC,06-10,22-24-11,NEND,NA,,,:"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-23
Software Maintenance Procedures
The following operations are performed to maintain and manage software image and database on the
TN780 and Optical Line amplifier network elements.
Refer to COPY-RFILE (Copy File) to perform software download, database restore and database backup
operations. The following parameters are used to specify the operations to be performed.
Table 9-16 Command Parameters
Keyword
TYPE
Value
Description
SWDL
Download a new software image
RFR
Restore the database
RFBU
Backup (upload) the database
Ftpurl
For FTP: ftp:[//[<userid>[:<password>]@]<ftphost>[:<port>]]/<url-path>
Fileurl
For File: file://[<localhost>]/<url-path>
DST
Ftpurl
For FTP: ftp:[//[<userid>[:<password>]@]<ftphost>[:<port>]]/<url-path>
Fileurl
For File: file://[<localhost>]/<url-path>
OVWRT
YES
Overwrite existing file of same directory location and filename
NO
Do not overwrite file. Fail the file transfer if file already exists
SRC
Software Download
The software operated on the TN780 and Optical Line Amplifier network elements is packaged into a
single software image. The software image includes the software components required for all the circuit
packs in the TN780 and Optical Line Amplifier network elements. The software image can be remotely
downloaded from a customer specified FTP server to the MCM circuit pack on the TN780 and OMM circuit
pack on the Optical Line Amplifier network element. Once the software image is downloaded to the MCM/
OMM circuit pack, the software is automatically distributed to the remaining circuit packs within the chassis
on initiation of software upgrade procedure. Up to three software image versions can be stored in the
network element at any given time.
Example
Use the following command to download a software file from FTP server whose IP address is
10.10.72.105.
COPY-RFILE:::ctag:::TYPE=SWDL,SRC=”ftp://guest:[email protected]//home/
guest/Release1DB/R1.2.0_267.ppc”;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-24
Software Maintenance Procedures
Database Download
Users can download the previously backed up database file image to the network element from a specified
FTP server. Up to three database image versions can be stored on the network element at any given time.
The downloaded database image is simply stored in the persistent memory in the network element.
Example
Use the following command to download a database file from FTP server whose IP address is
10.10.72.105.
COPY-RFILE:::ctag:::TYPE=SWDL,SRC=”ftp://guest:[email protected]/home/guest/
Release1DB/R1.2.0_267”
Database Backup
The database backup includes back up of the:
Database image which includes configuration information stored in the persistent memory on the
network element.
Alarm table stored in the persistent memory on the network element.
Event log stored in the persistent memory on the network element.
Example
Use the following command to backup the data base present from current DB to external host at
10.10.1.136
COPY-RFILE:::ctag:::TYPE=RFBU,DST="ftp://guest:[email protected]/home/guest/
base/dbbackup1";
Database Restore
Users can perform the restore operation to activate a new database image file with the current active
software image version. The new database image file must be compatible with the software image version
and it must also be compatible with the network element. The restore operation results in the network
element to be restarted and the new database image file to be activated.
Example
Use the following command to download a database file from server whose IP address is 10.10.1.136.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-25
COPY-RFILE:::ctag:::TYPE=RFR,SRC="ftp://guest:[email protected]//home/guest/
base/dbbackup1";
Next use “APPLY” to initiate restore. Refer to APPLY.
Software Upgrade
The software upgrade process can be initiated by the user. It activates a different software version form
the currently active one. This operation enables the new software image version to be activated with the
previously active database. Refer to APPLY to upgrade the downloaded software.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-26
Software Maintenance Procedures
SCHED-BKUP (Schedule Backup)
Command Description
This command is used to schedule a backup procedure on regular basis.
Command Syntax
SCHED-BKUP:[<TID>]::<CTAG>::<0|1-DAY|7-DAY>,[<stadat>],[<statm>];
Table 9-17 SCHED-BKUP Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
None
Related Commands
RTRV-BKUPSCHED (Retrieve Backup Schedule)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP
Table 9-18 SCHED-BKUP Command Parameters Description
Keyword
Description
Valid Range
Default
INVL
specifies the interval of time
between scheduled backups
0 (zero), 1-DAY, 7-DAY
Not Applicable
STADAT
It is the day of the week.
0 to 6
Not Applicable
STATM
It is the starting time for the
backup schedule.
HOD-MOH
Not Applicable
Note: Only the Current Database is backed up. The destination host where the database is
backed up is configured by the ED-FXFR command.
Note: If the backup schedule identifies the same type of backup that had been previously scheduled, it becomes effective immediately replacing any former schedule.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-27
The format for <STADAT> is the start day of the week. Valid values are 0 to 6 which is as follows:
0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
•The Scheduled backup is disabled by setting the invl value to zero
•When setting INVL=0, the STATM and STADAT are not relevant and the current scheduled backup will
be disabled.
•When setting INVL=1-DAY, STADAT is not relevant, only STATM is considered.
•When setting INVL=7-DAY, both STADAT and STATM have to be specified.
Example 1
Use the following command to schedule backup at 13:00 hours daily.
SCHED-BKUP:::ctag::1-DAY,,13-00;
Output
The following message is returned indicating successful completion.
NE25 04-10-14 17:39:54
M
ctag COMPLD
;
Example 2
Use the following command to schedule backup every Tuesday at 13:00 hours.
SCHED-BKUP:::ctag::7-DAY,2,13-00;
Output
The following message is returned indicating successful completion.
NE25 04-10-14 17:39:54
M
ctag COMPLD
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-28
Software Maintenance Procedures
;
Example 3
Use the following command to disable the scheduled backup.
SCHED-BKUP:::ctag::0;
Output
The following message is returned indicating successful completion.
NE25 04-10-14 17:39:54
M
ctag COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-29
RTRV-BKUPSCHED (Retrieve Backup Schedule)
Command Description
This command is used to view the backup scheduled parameters.
Command Syntax
RTRV-BKUPSCHED:[<TID>]::<CTAG>
Table 9-19 RTRV-BKUPSCHED Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
SCHED-BKUP (Schedule Backup)
Response Format
If there are no backup schedules (invl equal to zero), the format
is as follows:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf> ;
However, if there is a backup schedule to retrieve, the format is
as follows:
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<aid>:<invl>,<nxtbkup>,<nxtbkuptm>" <cr> <lf>
Error Codes
UTStarcom Inc.
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP
TL1 User Guide
Release 1.2
Page 9-30
Software Maintenance Procedures
Table 9-20 RTRV-BKUPSCHED Response Parameters Description
Keyword
Description
Valid Range
Default
INVL
Specifies the interval of time
between scheduled backups.
0 (zero), 1-DAY, 7-DAY
Not Applicable
nxtbkup
It is the date when the next
scheduled backup will occur
YYYY-MM-DD (Year/
Month/Day)
Not Applicable
nxtbkuptm
It is the time of day when the
next scheduled backup will
occur
HH-MM (Hour/Min)
Not Applicable
Example
Use the following command to view the current backup schedule.
RTRV-BKUPSCHED:::ctag;
Output
The following message is returned indicating successful completion.
NE25 04-10-14 17:28:38
M
ctag COMPLD
":1-DAY,2004-10-15,00-00"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-31
REPT^BKUP (Report Backup)
Message Description
Report Backup is generated by a network element to inform the maintenance personnel of the completion
(or non-completion) of a scheduled memory backup. The memory backup was scheduled by using the
SCHED-BKUP command and can be verified by using the RTRV-BKUPSCHED command.
Message Syntax
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
A^^<atag>^REPT^BKUP <cr> <lf>
<rspblk> + ;
where <rspblk> has the format:
^^^"<status>" <cr> <lf>^^^/* Failure Description if <status> is FAIL */ <cr>
<lf>
Table 9-21 REPT^BKUP Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
None
Related Commands
RTRV-BKUPSCHED (Retrieve Backup Schedule),
SCHED-BKUP (Schedule Backup)
Response Format
None
Error Codes
None
Table 9-22 REPT^BKUP Command Parameters Description
Keyword
STATUS
UTStarcom Inc.
Description
indicates the pass/fail status of
the scheduled backup operation
Valid Range
PASS, FAIL
Default
Not Applicable
TL1 User Guide
Release 1.2
Page 9-32
Software Maintenance Procedures
ED-FXFR (Edit File Transfer Object)
Command Description
This command is used to configure the File Transfer Object on the network element.
Command Syntax
EDFXFR:[<TID>]::<CTAG>:::<FTPFILETYPE=SWDL|RFBU|RFR|PM15|PM1DAY|DBI>[,<PRIFTPIP=
priftpip>][,<PRIFTPUID=priftpuid>][,<PRIFTPPID=priftppid>][,<SECFTPIP=secftpip
>][,<SECFTPUID=secftpuid>][,<SECFTPPID=secftppid>][,<DSTFILENAME=dstfilename>]
[,<DSTFILEPATH=dstfilepath>][,<FTPTRANSFER=ENABLE|DISABLE>];
Table 9-23 ED-FXFR Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
None
Related Commands
RTRV-FXFR (Retrieve File Transfer Object)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP
Table 9-24 ED-FXFR Command Parameters Description
Keyword
Description
Valid Range
Default
FTPFILETYPE
Valid Filetypes that can be
transferred
SWDL, RFBU, RFR,
PM15, PM1DAY, DBI
Not Applicable
PRIFTPIP
The IP address of the primary
FTP server
IP address
Not Applicable
PRIFTPUID
The UID of the primary FTP
server
Not Applicable
Not Applicable
PRIFTPPID
The Password Identifier for the
primary FTP server
Not Applicable
Not Applicable
SECFTPIP
The IP address of the secondary FTP server
IP address
Not Applicable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-33
Table 9-24 ED-FXFR Command Parameters Description
Keyword
Description
Valid Range
Default
SECFTPUID
The UID of the secondary FTP
server
Not Applicable
Not Applicable
SECFTPPID
The Password Identifier for the
secondary FTP server
Not Applicable
Not Applicable
DSTFILENAME
Destination File Name
Not Applicable
Not Applicable
DSTFILEPATH
Destination File Path
Not Applicable
Not Applicable
FTPTRANSFER
Enable/Disable FTP transfer
Enable, Disable
Enable
Example
Use the following command to set the IP address and Backup file path/name on primary FTP server.
EDFXFR:::CTAG:::FTPFILETYPE=rfbu,PRIFTPIP=10.10.87.100,PRIFTPUID=sttest,PRIFTPP
ID=*******DSTFILENAME=abc,DSTFILEPATH="/home/test/";
Output
The following message is returned indicating successful completion.
NE221 05-02-14 11:29:55
M
CTAG COMPLD;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-34
Software Maintenance Procedures
RTRV-FXFR (Retrieve File Transfer Object)
Command Description
This command is used to view the parameters associated with the File Transfer Object on the network
element.
Command Syntax
RTRV-FXFR:[<TID>]::<CTAG>:::[<FTPFILETYPE=SWDL|RFBU|RFR|PM15|PM1DAY|DBI>];
Table 9-25 RTRV-FXFR Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
ED-FXFR (Edit File Transfer Object)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP
Table 9-26 RTRV-FXFR Response Parameters Description
Keyword
Description
Valid Range
Default
FTPFILETYPE
Valid Filetypes that can be
transferred
SWDL, RFBU, RFR,
PM15, PM1DAY, DBI
Not Applicable
PRIFTPIP
The IP address of the primary
FTP server
IP address
Not Applicable
PRIFTPUID
The UID of the primary FTP
server
Not Applicable
Not Applicable
PRIFTPPID
The Password Identifier for the
primary FTP server
Not Applicable
Not Applicable
SECFTPIP
The IP address of the secondary FTP server
IP address
Not Applicable
SECFTPUID
The UID of the secondary FTP
server
Not Applicable
Not Applicable
SECFTPPID
The Password Identifier for the
secondary FTP server
Not Applicable
Not Applicable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-35
Table 9-26 RTRV-FXFR Response Parameters Description
Keyword
Description
Valid Range
Default
DSTFILENAME
Destination File Name
Not Applicable
Not Applicable
DSTFILEPATH
Destination File Path
Not Applicable
Not Applicable
CURRXFRSTATE
Current State of the XFR
INPROGRESS_PRI,
Not Applicable
INPROGRESS_SEC,
IDLE,
FILECREATION,
SCHEDULED
CURRXFRPROGRESS
Progress Message of the XFR
string
Not Applicable
LASTXFRTIME
Time when the Last XFR was
attempted
HOD-MOH
Not Applicable
LASTXFRDATE
Date of the last attempted XFR
MOY-DOM
LASTXFRST
ATE_PRI
Control State of the last xfr on
PRI
(hour-of-day, minute-ofhour)
(month-of-year, day-ofmonth)
SUCCEEDED
Not Applicable
Not Applicable
INVALID_LOGIN
PERMISSION_DENIED
DISK_FULL
XFR_INTERRUPTED
CONNECTION_FAIL
FILE_UNAVAILABLE
FAILED
NEVER_STARTED
LASTXFRST
ATE_SEC
Control State of the last xfr on
SEC
SUCCEEDED
Not Applicable
INVALID_LOGIN
PERMISSION_DENIED
DISK_FULL
XFR_INTERRUPTED
CONNECTION_FAIL
FILE_UNAVAILABLE
FAILED
NEVER_STARTED
LASTSUCCXFRDATE
UTStarcom Inc.
The Date when the last successful back up was done
YYYY-MM-DD (Year/
Month/Day)
Not Applicable
TL1 User Guide
Release 1.2
Page 9-36
Software Maintenance Procedures
Table 9-26 RTRV-FXFR Response Parameters Description
Keyword
Description
Valid Range
Default
LASTSUCCXFRTIME
The Time when the last successful back up was done
HH-MM (Hour/Month)
Not Applicable
LASTSUCCXFRFILE
The filename of the last successful backup
Not Applicable
Not Applicable
LASTSUCCXFRIP
The IP address of the host
where the last successful
backup was performed
Not Applicable
Not Applicable
Table 9-27 RTRV-FXFR Command Parameters Description
Parameters
FTPFILETYPE
Description
Valid Filetypes that
can be transferred
Valid Range
SWDL, RFBU, RFR,
PM15, PM1DAY,
DBI
Default
Not Applicable
Example
Use the following command to view the current File Transfer parameters.
RTRV-FXFR:::ctag;
Output
The following message is returned indicating successful completion.
UTSTARCOM 05-02-20 09:31:07
M
ctag COMPLD
"::FTPFILETYPE=RFBU,PRIFTPIP=10.10.8.17,PRIFTPUID=autotest,SECFTPIP=0.0.0.0,SE
CFTPUID=,DSTFILENAME=DB_%D,DSTFILEPATH=/home/autotest/sanjai/db/
,CURRXFRSTATE=Idle,CURRXFRPROGRESS=Idle,LASTXFRDATE=2005-02-18,LASTXFRTIME=092550,LASTXFRSTATE_PRI=TransferInterruptedBecauseOfReboot,LASTXFRSTATE_SEC=NeverS
tarted,LASTSUCCXFRDATE=,LASTSUCCXFRTIME=,LASTATTEMPTXFRDATE=,LASTATTEMPTXFRTIM
E=,LASTSUCCXFRFILE=,FTPTRANSFER=ENABLED"
"::FTPFILETYPE=DBI,PRIFTPIP=10.10.8.17,PRIFTPUID=autotest,SECFTPIP=0.0.0.0,SEC
FTPUID=,DSTFILENAME=blr891_204_debugInfo_%D,DSTFILEPATH=/home/autotest/sanjai/
debug/,CURRXFRSTATE=Idle,CURRXFRPROGRESS=Idle,LASTXFRDATE=2005-02-
TL1 User Guide
Release 1.2
UTStarcom Inc.
Software Maintenance
Page 9-37
12,LASTXFRTIME=20-4518,LASTXFRSTATE_PRI=Succeeded,LASTXFRSTATE_SEC=NeverStarted,LASTSUCCXFRDATE=2
005-02-18,LASTSUCCXFRTIME=14-06-57,LASTATTEMPTXFRDATE=,LASTATTEMPTXFRTIME=,LA
STSUCCXFRFILE=/home/autotest/sanjai/debug/
blr891_204_debugInfo_2005.02.18.14.06.33.tar.gz,LASTSUCCXFRIP=10.10.8.17,FTPT
RANSFER=ENABLED"
"::FTPFILETYPE=RFR,PRIFTPIP=0.0.0.0,PRIFTPUID=,SECFTPIP=0.0.0.0,SECFTPUID=,DS
TFILENAME=,DSTFILEPATH=,CURRXFRSTATE=Idle,CURRXFRPROGRESS=Idle,LASTXFRDATE=,L
ASTXFRTIME=,LASTXFRSTATE_PRI=NeverStarted,LASTXFRSTATE_SEC=NeverStarted,LASTS
UCCXFRDATE=,LASTSUCCXFRTIME=,LASTATTEMPTXFRDATE=,LASTATTEMPTXFRTIME=,LASTSUCC
XFRFILE=,LASTSUCCXFRIP=,FTPTRANSFER=DISABLED"
"::FTPFILETYPE=SWDL,PRIFTPIP=10.10.8.17,PRIFTPUID=autotest,SECFTPIP=10.10.9.2
1,SECFTPUID=gbuild,DSTFILENAME=R1.2.0.0223.ppc,DSTFILEPATH=/home/autotest/
sanjai/builds/,CURRXFRSTATE=Idle,CURRXFRPROGRESS=Idle,LASTXFRDATE=2005-0218,LASTXFRTIME=07-1700,LASTXFRSTATE_PRI=Succeeded,LASTXFRSTATE_SEC=NeverStarted,LASTSUCCXFRDATE=2
005-02-18,LASTSUCCXFRTIME=07-2114,LASTATTEMPTXFRDATE=,LASTATTEMPTXFRTIME=,LASTSUCCXFRFILE=R1.2.0.0223.ppc.ta
r.gz,LASTSUCCXFRIP=10.10.8.17,FTPTRANSFER=ENABLED"
"::FTPFILETYPE=PM15,PRIFTPIP=0.0.0.0,PRIFTPUID=,SECFTPIP=0.0.0.0,SECFTPUID=,D
STFILENAME=pm15min_%D,DSTFILEPATH=,CURRXFRSTATE=Idle,CURRXFRPROGRESS=Idle,LAS
TXFRDATE=,LASTXFRTIME=,LASTXFRSTATE_PRI=NeverStarted,LASTXFRSTATE_SEC=NeverSt
arted,LASTSUCCXFRDATE=,LASTSUCCXFRTIME=,LASTATTEMPTXFRDATE=,LASTATTEMPTXFRTIM
E=,LASTSUCCXFRFILE=,LASTSUCCXFRIP=,FTPTRANSFER=DISABLED"
"::FTPFILETYPE=PM1DAY,PRIFTPIP=0.0.0.0,PRIFTPUID=,SECFTPIP=0.0.0.0,SECFTPUID=
,DSTFILENAME=pm24hr_%D,DSTFILEPATH=,CURRXFRSTATE=Idle,CURRXFRPROGRESS=Idle,LA
STXFRDATE=,LASTXFRTIME=,LASTXFRSTATE_PRI=NeverStarted,LASTXFRSTATE_SEC=NeverS
tarted,LASTSUCCXFRDATE=,LASTSUCCXFRTIME=,LASTATTEMPTXFRDATE=,LASTATTEMPTXFRTI
ME=,LASTSUCCXFRFILE=,LASTSUCCXFRIP=,FTPTRANSFER=DISABLED"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 9-38
TL1 User Guide
Software Maintenance Procedures
Release 1.2
UTStarcom Inc.
CHAPTER 10
Environmental Alarms and Control
This chapter describes the commands for environmental alarm settings and alarms that are triggered
under abnormal conditions caused due to the environmental changes affecting the network element in the
following sections:
“RTRV-ALM-ENV (Retrieve-Environmental-Alarm)” on page 10-5
“SET-ATTR-ENV (Set-Environmental-Attributes)” on page 10-7
“RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)” on page 10-9
“OPR-EXT-CONT (Operate-External-Control)” on page 10-12
“SET-ATTR-CONT (Set-Control-Attributes)” on page 10-16
“RTRV-ATTR-CONT (Retrieve-Control-Attributes)” on page 10-18
“OPR-ACO-EQPT (Operate-Alarm Cutoff)” on page 10-21
The following alarms reported autonomously by the system.
“REPT^ALM^ENV (Report-Alarm)” on page 10-3
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-2
Overview
Overview
Environmental alarms are those triggered by an abnormal condition at the network element site. Sensors
located at various environmental control points throughout the network element site relay messages
through the alarm card at the onsite network element to inform the TL1 interface of a condition likely to
require immediate attention.
Environmental alarms warn the user of system events according to pre-defined environmental occurrences
like temperature, humidity and pressure levels through an audible indicator.
The environmental alarms are generally raised during conditions such as:
Temperature unacceptable
Humidity unacceptable
Heating/ventilation/cooling system problem
Fire detected
Flood detected
Toxic leak detected
Leak detected
Pressure unacceptable
Excessive vibration
Material supply exhausted
Pump failure
Enclosure door open
The user can configure input contact closure control to one of the above given sensor, enable the alarm,
after which the alarm will be reported.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-3
REPT^ALM^ENV (Report-Alarm)
Message Description
This autonomous message is used to report the presence of an environmental alarm.
Message Syntax
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
<ALMCODE>^<ATAG>^REPT^ALM^ENV <cr> <lf>
^^^"<AID>:<NTFCNCDE>,<ALMTYPE>[,<OCRDAT>][,<OCRTM>][,<ALMMSG>]"<cr> <lf>
;
Table 10-1 on page 10-3 describes parameters specific to REPT^ALM message.
Table 10-1 REPT^ALM^ENV Message Parameters
Parameter
ALMCODE
Description
The alarm code with severity.
Valid Value
*C - critical Used with NTFCNCDE=CR
** - major Used with NTFCNCDE=MJ
*^ - minor Used with NTFCNCDE=MN
A^ - clear Used with NTFCNCDE=CL
NTFCNCDE
The NTFFCNCDE (Notification Code) is a
two-character notification code which identifies the severity of an alarm condition.
CR - Critical
MJ - Major
MN - Minor
NA - Non-Alarmed
CL - Clear
OCRDAT
The OCRDAT (Occurrence Date) is the date
when the alarm or event occurred.
The format is MOY-DOM-SOM.
MOY stands for Month Of Year and ranges
from 1 to 12.
DOM stands for Date Of Month and ranges
from 1 to 31.
SOM stands for Seconds of Minute and
ranges from 0 to 59.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-4
Overview
Table 10-1 REPT^ALM^ENV Message Parameters
Parameter
OCRTM
Description
The OCRTM (Occurrence Time) is the time
when the alarm or event occurred.
Valid Value
The format is HOD-MOH-SOM.
HOD stands for Hour Of Day and ranges
from 0 to 23.
MOH stands for Minutes of Hour and ranges
from 0 to 59.
SOM stands for Seconds of Minute and
ranges from 0 to 59.
ALMTYPE
Type of alarm condition.
List of environmental alarms
ALMMSG
The description of alarm message.
40 character string, delimited by escaped
quotes (\")
Example
Use the following is an example of environmental alarm.
Output
blr880 05-02-25 06:05:03
** 16022 REPT ALM ENV
"1:MJ,PTIN-1,05-02-25,06-05-02,Fire Hazard"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-5
RTRV-ALM-ENV (Retrieve-Environmental-Alarm)
Command Description
This command is used to view the environmental alarms present on the specified telemetry inputs.
Command Syntax
RTRV-ALM-ENV:[<TID>]:[AID]:<CTAG>::[<NTFCNCDE>][,<ALMTYPE>];
Table 10-2 RTRV-ALM-ENV Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Test and Turn-up
Pre-condition
None
Post-condition
None
Related Commands
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
RLS-EXT-CONT (Release-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
(^^^“<AID>:<NTFCNCDE>, <ALMTYPE>,<OCRDAT>,<
OCRTM>,<ALMMSG>“ <cr> <lf>)+
(>|;)
Error Codes
UTStarcom Inc.
None
TL1 User Guide
Release 1.2
Page 10-6
Overview
Table 10-3 RTRV-ALM-ENV Command Parameters Description
Parameter
Description
Valid Range
Default
AID
AID of the telemetry input
{Chassis ID}-PTIN-[1-16], where
Chassis ID range is [1-6]
Not Applicable
NTFCNCDE
Notification code associated with the alarm conditions retrieved. Valid
values are CR(Critical),
MJ(Major) and MN(Minor).
CR - Critical
Not Applicable
MJ - Major
MN - Minor
NA - Non-Alarmed (Warning)
CL - Clear
NR - Not Reported
ALMTYPE
Type of alarm condition.
Environmental, Equipment, Facility, Software processing, Communication alarms
Environmental
alarms
Table 10-4 RTRV-ALM-ENV Response Parameters Description
Parameter
Description
AID
AID of the telemetry input
NTFCNCDE
Notification code associated with the alarm conditions retrieved. Valid values are CR(Critical), MJ(Major) and MN(Minor).
ALMTYPE
Type of alarm condition.
OCRDAT
Date when the alarm occurred (mm-dd)
OCRTM
Time when the alarm occurred (hh-mm-ss).
ALMMSG
The description of alarm message enclosed in escape quotes ("\)
Example
Use the following command to view the environmental alarms present on the specified telemetry inputs.
RTRV-ALM-ENV:::ctag;
Output
The following message is returned indicating successful completion.
NC38 05-02-21 09:53:43
M
ctag COMPLD
"1:MJ,PTIN-1,05-02-21,09-53-19,"Fire Hazard""
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-7
SET-ATTR-ENV (Set-Environmental-Attributes)
Command Description
This command is used to set the severity of the environmental alarms.
Command Syntax
SET-ATTRENV:[<TID>]:<AID>:<CTAG>::[<ntfcncde>],[<almtype>],[<almmsg>]:[<LABEL=label>]
[,<MGMTCTRL=true|false>][,<NORMPOS=NORMALLYOPEN|NORMALLYCLOSED>];
Table 10-5 SET-ATTR-ENV Command Usage
Section
Description
User Access Privilege Level
Network Administrator
Pre-condition
None
Post-condition
None
Related Commands
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
RLS-EXT-CONT (Release-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, SNVS
(See Table 2-6 on page 2-14)
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-8
Overview
Table 10-6 SET-ATTR-ENV Command Parameters Description
Parameter
AID
Description
AID of the telemetry input
Example: 1-PTIN-1
NTFCNCDE
Notification code associated with
the alarm conditions retrieved. Valid
values are CR(Critical), MJ(Major)
and MN(Minor).
Valid Range
Default
{Chassis ID}-PTIN-[116], where Chassis ID
range is [1-6]
Mandatory
CR - Critical
Not Applicable
MJ - Major
MN - Minor
NA - Non-Alarmed
(Warning)
CL - Clear
NR - Not Reported
ALMTYPE
Type of alarm condition
10-character string
Environmental
alarms
ALMMSG
The description of alarm message
enclosed in escape quotes ("\)
40-character string
All environmental
alarms
LABEL
Label of the entity
String of characters
Not Applicable
MGMTCTRL
An option provided to the user to
view alarms raised against the input
contacts.
true, false
false
NORMPOS
The normal position of the input
alarm contacts.
normally open, normally
closed
normally open
Example
Use the following command to set the severity of environmental alarms.
SET-ATTR-ENV::1-ptin-1:c::MJ,FIRE,"Fire Hazard";
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:19:05
M
s COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-9
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
Command Description
This command is used to view the attributes of the environmental alarms.
Command Syntax
RTRV-ATTR-ENV:[<TID>]:[AID]:<CTAG>::[<NTFCNCDE>][<ALMTYPE>];
Table 10-7 RTRV-ATTR-ENV Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer, Security Administrator, Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM-ENV (Retrieve-Environmental-Alarm)
SET-ATTR-ENV (Set-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
RLS-EXT-CONT (Release-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
<cr> <lf> <lf>
^^^<SID>^<DATE>^<TIME> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
(^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,<ALMMSG>" <cr>
<lf>)+;
Error Codes
UTStarcom Inc.
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,
SNVS (See Table 2-6 on page 2-14)
TL1 User Guide
Release 1.2
Page 10-10
Overview
Table 10-8 RTRV-ATTR-ENV Command Parameters Description
Parameter
AID
Description
AID of the telemetry input
Example: 1-PTIN-1
NTFCNCDE
Notification code associated with
the alarm conditions being
retrieved
Valid Range
Default
{Chassis ID}-PTIN-[1-16],
where Chassis ID range
is [1-6]
Mandatory
CR - Critical
Not Applicable
MJ - Major
MN - Minor
NA - Non-Alarmed
(Warning)
CL - Clear
NR - Not Reported
ALMTYPE
Type of alarm condition
Environmental, Equipment, Facility, Software
processing, Communication alarms
Environmental
alarms
Table 10-9 RTRV-ATTR-ENV Response Parameters Description
Parameter
Description
AID
AID of the telemetry input
NTFCNCDE
Notification code associated with the alarm conditions retrieved.
Valid values are CR(Critical), MJ(Major) and MN(Minor).
ALMTYPE
Type of alarm condition.
ALMMSG
The description of alarm message enclosed in escape quotes ("\)
LABEL
Name given for Environmental Alarms (String of 128 characters)
MGMCTRL
Management Control
NORMPOS
Normal Position of the Environmental Alarms
CURPOS
Current Position of the Environmental Alarms
Example
Use the following command to view the attributes of the environmental alarms.
RTRV-ATTR-ENV:::c;
Output
The following message is returned indicating successful completion.
NC38 05-02-25 00:06:42
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
M
Page 10-11
c RTRV
"1-PTIN-1:MJ,FIRE,"Fire
Hazard":LABEL=,MGMTCTRL=true,NORMPOS=NormallyClosed,CURPOS=Open"
"1-PTIN-10:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-11:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-12:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-13:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-14:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-15:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-16:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-2:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-3:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
>
TL1>>
NC38 05-02-25 00:06:42
M
c COMPLD
"1-PTIN-4:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-5:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-6:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-7:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-8:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
"1-PTIN-9:MN,NONE,:LABEL=,MGMTCTRL=false,NORMPOS=NormallyOpen,CURPOS=Open"
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-12
Overview
OPR-EXT-CONT (Operate-External-Control)
Command Description
This command operates the external control, such as relay activation, based on Telemetry Output
configuration. The contact is released using the RLS-EXT-CONT command. The RTRV-EXT-CONT
command is used to find the current status of External Contact configuration.
Command Syntax
OPR-EXT-CONT:[<TID>]:<AID>:<CTAG>::[<conttype>];
Table 10-10 OPR-EXT-CONT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM-ENV (Retrieve-Environmental-Alarm)
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
RLS-EXT-CONT (Release-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE,
SNVS (See Table 2-6 on page 2-14)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-13
Table 10-11 OPR-EXT-CONT Command Parameters Description
Parameter
Description
AID
AID of the alarm output contact
Valid Range
Default
<Chassis>-PTOUT<AlarmOutput>
Mandatory
where
<Chassis> = {1-6}
<AlarmOutput> = {110}
CONTTYPE
External Control Type
Refer Table 10-12
on page 10-13 for
the list of CONTTYPE
Same as the configuration previously done for that external control
Table 10-12 List of Standard Control Types for Telemetry Outputs
CONTTYPE
Description
AIRCOND
Air conditioning
ENGINE
Engine
FAN
Fan
GEN
Generator
HEAT
Heat
LIGHT
Light
MISC
Miscellaneous
SPKLR
Sprinkler
Example
Use the following command to operate the external control.
OPR-EXT-CONT::1-ptout-1:s;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:20:24
M
s COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-14
Overview
RLS-EXT-CONT (Release-External-Control)
Command Description
This command releases the external control, such as a relay activation, based on Telemetry Output
configuration. The contact can be operated using the corresponding TL1 command of OPR-EXT-CONT.
Command Syntax
RLS-EXT-CONT:[<TID>]:<AID>:<CTAG>::[<conttype>];
Table 10-13 RLS-EXT-CONT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM-ENV (Retrieve-Environmental-Alarm)
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14)
Table 10-14 RLS-EXT-CONT Command Parameters Description
Parameter
AID
Description
AID of the alarm output
contact
Valid Range
<Chassis>-PTOUT-<AlarmOutput>
Default
Mandatory
where
<Chassis> = {1-6}
<AlarmOutput> = {1-10}
CONTTYPE
TL1 User Guide
External Control Type
Release 1.2
Refer Table 10-12 on
page 10-13 for the list of
CONTTYPE
Not Applicable
UTStarcom Inc.
Environmental Alarms and Control
Page 10-15
Example
Use the following command to release the external control.
RLS-EXT-CONT::1-ptout-1:s;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:20:59
M
s COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-16
Overview
SET-ATTR-CONT (Set-Control-Attributes)
Command Description
This command sets the attributes associated with an external control. These attributes are used when an
external control is operated or released. The related input command is RTRV-ATTR-CONT.
Command Syntax
SET-ATTR-CONT:[<TID>]:<AID>:<CTAG>::[<conttype>];
Table 10-15 SET-ATTR-CONT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM-ENV (Retrieve-Environmental-Alarm)
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
RLS-EXT-CONT (Release-External-Control)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14)
Table 10-16 SET-ATTR-CONT Command Parameters Description
Parameter
AID
Description
AID of the alarm output
contact
Valid Range
<Chassis>-PTOUT-<AlarmOutput>
Default
Mandatory
where
<Chassis> = {1-6}
<AlarmOutput> = {1-10}
CONTTYPE
TL1 User Guide
External Control Type
Release 1.2
Refer Table 10-12 on
page 10-13 for the list of
CONTTYPE
Not Applicable
UTStarcom Inc.
Environmental Alarms and Control
Page 10-17
Example
Use the following command to sets the attributes associated with an external control.
SET-ATTR-CONT::1-ptout-1:c::FAN;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:22:26
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-18
Overview
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
Command Description
This command instructs a network element to retrieve the attributes associated with an external control.
Command Syntax
RTRV-ATTR-CONT:[<TID>]:[<AID>]:<CTAG>::[<conttype>];
Table 10-17 RTRV-ATTR-CONT Command Usage
Section
User Access Privilege Level
Description
Network Administrator, Network Engineer, Security Administrator,
Test and Turn-up, Monitoring Access, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
RLS-EXT-CONT (Release-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Response Format
cr lf lf
^^^<SID>^<DATE>^<TIME> cr lf
M^^CTAG^COMPLD cr lf
[^^^"<AID>[:<CONTTYPE>]" cr lf]
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14)
Table 10-18 RTRV-ATTR-CONT Response Parameters Description
Parameter
Description
AID
AID of the telemetry output
CONTTYPE
Type of Contact.
LABEL
Name of the External Control (String of 128 characters)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-19
Table 10-18 RTRV-ATTR-CONT Response Parameters Description
Parameter
Description
STATUS
Operation Mode of the External Control
CURPOS
Current Position of the External Control
Parameter
AID
Description
AID of the alarm output
contact
Valid Range
Default
<Chassis>-PTOUT-<AlarmOutput>
Optional
where
<Chassis> = {1-6}
<AlarmOutput> = {1-10}
CONTTYPE
External Control Type
Refer Table 10-12 on
page 10-13 for the list of
CONTTYPE
Not Applicable
Example
Use the following command to view the attributes associated with an external control.
RTRV-ATTR-CONT:::s;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:22:58
s COMPLD
"1-PTOUT-1:FAN:LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-10:AIRCOND:LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-2::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-3::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-4::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-5::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-6::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-7::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-20
Overview
"1-PTOUT-8::LABEL=,STATUS=MAN_OFF,CURPOS=Open"
"1-PTOUT-9::LABEL=,STATUS=MAN_OFF,CURPOS=Open";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Environmental Alarms and Control
Page 10-21
OPR-ACO-EQPT (Operate-Alarm Cutoff)
Command Description
This command cuts off the office audible alarm indications without changing the local alarm indications.
Command Syntax
OPR-ACO-EQPT:[<TID>]:<AID>:<CTAG>;
Table 10-19 OPR-ACO-EQPT Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
None
Post-condition
None
Related Commands
RTRV-ALM-ENV (Retrieve-Environmental-Alarm)
SET-ATTR-ENV (Set-Environmental-Attributes)
RTRV-ATTR-ENV (Retrieve-Environmental-Attributes)
OPR-EXT-CONT (Operate-External-Control)
RLS-EXT-CONT (Release-External-Control)
SET-ATTR-CONT (Set-Control-Attributes)
RTRV-ATTR-CONT (Retrieve-Control-Attributes)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, EQWT, IENE, SNVS
(See Table 2-6 on page 2-14)
Table 10-20 OPR-ACO-EQPT Command Parameters Description
Parameter
AID
Description
AID of the chassis
equipment
Valid Range
1 to 6.
Default
Mandatory
Example
Use the following command to cuts off the office audible alarm indications without changing the local alarm
indications.
OPR-ACO-EQPT::1:c;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 10-22
Overview
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:25:18
M
c COMPLD
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
CHAPTER 11
Diagnostics
The UTStarcom Digital Optical Networking systems provide diagnostics and troubleshooting tools to
quickly and easily isolate network problems. This chapter describes the corresponding TL1 Interface in the
following sections:
“Overview” on page 11-2
“Loopbacks” on page 11-3
“INIT-SYS (Initialize System)” on page 11-12
“;” on page 11-13
“PRBS Test” on page 11-25
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-2
Overview
Overview
Diagnostics is one of the key components of the overall fault management solution provided by the
UTStarcom Digital Optical Networking systems. The diagnostics function helps in troubleshooting and
isolating the source of a problem. Two types of diagnostic tools are supported, as described below.
Intrusive Diagnostics
Intrusive Diagnostics refers to diagnostic functions that affect traffic when executed. The equipment must
be in maintenance mode before applying intrusive diagnostics. See UTStarcom TN780 Turn-up and Test
Guide for more information. Intrusive diagnostics also includes the insertion of PRBS and monitoring signal
for errors and applying termination points and terminal loopbacks.
Non-Intrusive Diagnostics
Non-Intrusive diagnostics do not affect the flow of traffic. Users can initiate the non-intrusive diagnostics
when the equipment is in service. Non-intrusive diagnostics include the insertion and monitoring of Trail
Trace Identifier (TTI) and J0 Section Trace.
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-3
Loopbacks
Loopbacks provide a mechanism to support pre-service operation practices and test-related activities.
Loopbacks are used to test newly created circuits before running live traffic or to logically locate the source
of the network failure. The signal under test is looped back to the same location on the network element to
test the integrity and validity of the signal being looped back. Loopbacks are Intrusive diagnostics, that is,
they affect the data traffic and should be applied cautiously. The loopback can be enabled only when the
corresponding managed entity is in administrative maintenance state.
Following types of loopbacks are supported:
Facility Loopback - connects the incoming received signal to the transmitter in the return direction.
The network element sends an AIS or PRBS signal to the downstream nodes depending on the network element configuration.
Terminal Loopback - connects the signal about to be transmitted to the associated incoming
receiver.
Setting loopbacks on a circuit pack
Use the commands in the following order to enable the loopback on a facility.
“RMV (Remove-AIDType)” on page 11-4 to change to administrative maintenance state.
“OPR-LPBK (Operate-Loopback)” on page 11-6 to enable the loopback.
Use the commands in the following order to disable the loopback on a facility.
“RLS-LPBK (Release-Loopback)” on page 11-8 to release the loopback.
“RST (Restore Facility)” on page 11-10 to restore the administrative unlocked state.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-4
Loopbacks
RMV (Remove-AIDType)
Command Description
This command is used to change the state of the managed entity into administrative maintenance state.
The AIDTYPE should be explicitly specified in the command.
Command Syntax
RMV{EQPT|OCH|DTPCTP|TRIB|OC192|OC48|STM64|STM16|10GBE|SNC|1GBE|10GCC}:[<TID>]:<AI
D>:<CTAG>;
Table 11-1 RMV Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Element, Provisioning, Test and
Turn-up
Pre-condition
The entity should be in IS-NR or OOS-AU state. If it is already in the
administrative maintenance state, SAMS (Status Already in Maintenance State) is returned.
Post-condition
The entity is placed in the OOS-MA, MT state.
The Alarm reporting is suppressed once the entity is placed in the MT
state.
The diagnostics commands can now be applied to the object.
The RST-AIDTYPE command is used to bring back the object into the
in-service state
Related Commands
OPR-LPBK (Operate-Loopback)
Response Format
Standard
Error Codes
SAMS, ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
Table 11-2 RMV Command Parameters Description
Parameters
AID
TL1 User Guide
Description
AID of the managed
entity for which administrative state is to be
changed
Release 1.2
Valid Range
See Table 1-2 on
page 1-9.
Default
Mandatory
UTStarcom Inc.
Diagnostics
Page 11-5
Example
Use the following command to put the DLM circuit pack in slot 3 into administrative maintenance state.
RMV-EQPT::1-a-3:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:25:18
M
c COMPLD
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-6
Loopbacks
OPR-LPBK (Operate-Loopback)
Command Description
This command is used to place the termination point in the loopback state. In order to completely specify
the command, the AIDTYPE needs to be explicitly specified. Refer to “Managed Termination Point Entities”
on page 1-11 for details on AID types.
Command Syntax
OPR-LPBK{DTPCTP|OC192|OC48|STM64|STM16|10GBE|1GBE|10GCC}:[<TID>]:<AID>:<CTAG>::[<locn>
],[<orgn>],[<intext>],<FAC|TERM>;
Table 11-3 OPR-LPBK Command Usage
Section
Description
User Access Privilege Level
Test and Turn-up
Pre-condition
The object should be in the OOS-MA, MT state for this command to
succeed.
If the object is already in the loopback state, SAOP (Status Already
OPerated) is returned.
Post-condition
The object is placed in the loopback state. In order to release the
loopback, the corresponding RLS-LPBK command is used.
The standing condition of LPBKFACILITY is raised when the termination point loopback is applied. The standing condition of LPBKTERM is raised when the terminal loopback is applied.
The Alarm reporting is suppressed for the facility present in the loopback state. (Except for the loopback standing conditions reported)
Related Commands
RLS-LPBK (Release-Loopback)
Response Format
Standard
Error Codes
SAMS, ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
Table 11-4 OPR-LPBK Command Parameters Description
Keyword
Description
Valid Range
Default
AID
AID of the termination point on which
the loopback has to be applied
See Table 1-3 on
page 1-11.
Mandatory
LOCN
Location where the loopback occurs
NEND
Not Applicable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-7
Table 11-4 OPR-LPBK Command Parameters Description
Keyword
Description
Valid Range
Default
ORGN
Office that originates the loop back
Not Supported
Not Applicable
INTEXT
Signal processing needed for the signal
being looped back
Not Supported
Not Applicable
LPBKTYPE
Identifies the type of loopback being
supported
FAC: Facility
Mandatory
TERM: Terminal
Example
Use the following command for applying a loopback on OC48 termination point:
OPR-LPBK-OC48::1-a-3-t1-1:ctag::,,,TERM;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:37:02
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-8
Loopbacks
RLS-LPBK (Release-Loopback)
Command Description
This command is used to release the facility from the loopback state. In order to completely specify the
command, the AIDTYPE needs to be explicitly specified.
Command Syntax
RLS-LPBK{DTPCTP|OC192|OC48|STM64|STM16|10GBE|1GBE|10GCC}:[<TID>]:<AID>:<CTAG>::[<locn>
],[<orgn>],[<intext>],[FAC|TERM];
Table 11-5 RLS-LPBK Command Usage
Section
Description
User Access Privilege Level
Test and Turn-up, Network Administrator, Provisioning
Pre-condition
The object should be in the OOS-MA, MT state for this
command to succeed.
If the object is already released from the loopback state,
SARL (Status Already Released) is returned.
If the entity is released from the loopback state. In order to
release the loopback, the corresponding RLS-LPBK
command is used.
Post-condition
The standing condition of LPBKFACILITY or LPBKTEMR
(whichever is applicable) is cleared when this command is
successful.
Related Commands
OPR-LPBK (Operate-Loopback)
Response Format
Standard
Error Codes
SAMS, ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARL (See
Table 2-6 on page 2-14).
Table 11-6 RLS-LPBK Command Parameters Description
Keyword
Description
Valid Range
Default
AID
AID of the termination point from which
the loopback must be released
See Table 1-3 on
page 1-11.
Mandatory
LOCN
Location where the loopback occurs
NEND
Not Applicable
ORGN
Office that originates the loop back
Not Supported
Not Applicable
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-9
Table 11-6 RLS-LPBK Command Parameters Description
Keyword
Description
Valid Range
Default
INTEXT
Signal processing needed for the signal
being looped back
Not Supported
Not Applicable
LPBKTYPE
Identifies the type of loopback being
supported
FAC: Facility
Optional
TERM: Terminal
Note: If LPBKTYPE is specified, it should be same as what was used in the OPR-LPBK command.
Example
Use the following commands to release the termination point loopback present.
RLS-LPBK-OC48::1-a-3-t1-1:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:37:02
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-10
Loopbacks
RST (Restore Facility)
Command Description
This command is used to restore the entity from the administrative maintenance state to the in-service
state. In order to completely specify the command, the AIDTYPE needs to be explicitly specified. Refer
“Managed Entities and AID Overview” on page 1-8 for details on AID types.
Command Syntax
RST{EQPT|OCH|DTPCTP|TRIB|OC192|OC48|STM64|STM16|10GBE|SNC|1GBE|10GCC}:[<TID>]:<AI
D>:<CTAG>;
Table 11-7 RST Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Element, Provisioning, Test and Turnup
Pre-condition
The object shall be in the OOS-MA, MT state for this command to succeed.
If the object is already in the in-service state, SAIS (Status Already in
Service State) is returned.
Post-condition
The object is placed in the in-service state (provided no
prevailing fault is present)
The Alarm reporting is now resumed once the entity is placed in
the IS-NR state
The diagnostics commands cannot be applied any more. The
facility should be first placed in the OOS-MA,MT state by using
the RMV command.
Related Commands
RMV (Remove-AIDType)
Response Format
Standard
Error Codes
SAMS, ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-11
Table 11-8 RST Command Parameters Description
Parameters
AID
Description
AID of the managed
entity for which the
administrative state
must be restored from
maintenance to in-service
Valid Range
See Table 1-2 on
page 1-9.
Default
Mandatory
Example
Use the following command to restore the state of the DLM circuit pack in slot 3 out of administrative
maintenance state.
RST-EQPT::1-a-3:ctag;
Output
The following message is returned indicating successful completion.
NE1 05-02-18 15:25:18
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-12
Loopbacks
INIT-SYS (Initialize System)
Command Description
This command is used to reset the circuit pack identified by the AID.
Command Syntax
INIT-SYS:[<TID>]:<AID>:<CTAG>::<WARM|COLD>;
Table 11-9 INIT-SYS Command Usage
Section
Description
User Access Privilege Level
Network Administrator, Network Engineer
Pre-condition
The circuit pack should be provisioned and physically exist in
the slot.
Post-condition
The diagnostics commands can now be applied to the object.
An event (REPT^EVT^COM) is generated and stored in the AO
buffer whenever a COLD or WARM restart occurs.
Related Commands
ENT-EQPT (Enter-Equipment)
ED-EQPT (Edit-Equipment)
DLT-EQPT (Delete-Equipment)
RTRV-EQPT (Retrieve-Equipment)
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB (See
Table 2-6 on page 2-14).
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-13
Table 11-10 INIT-SYS Command Parameters Description
Keyword
PH
Description
The type of restart to perform
Valid Range
Default
COLD restart
Mandatory
This type of restart is
used to reset the Management Plane (software), the Data Plane
(data path) and the Control Plane (routing and
signaling) on the circuit
pack.
WARM restart
This type of restart is
used to reset the Management Plane and the
Control Plane on the Circuit Pack.
AID
AID of circuit pack that is to be
reset
OAM, BMM, DLM, TAM,
MCM, OMM AID
Mandatory
Example: INIT-SYS::1-A3:c::COLD;
Note: This command terminates the TL1 session and logs the user off if performed on MCM or
OMM.
Example
Use the following command to warm restart the BMM circuit pack.
INIT-SYS::1-A-3:c::WARM;
Output
The following message is returned indicating successful completion.
NE123 04-07-15 13:56:23
M
c COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-14
Trace Messaging
Trace Messaging
Trace Messaging is used to determine installation problems such as incorrectly connected fibers. The
UTStarcom Digital Optical Networking systems support the following types of trace messaging tools:
J0 Trace Messaging
DTF Section Trace Messaging
DTF Path Trace Messaging
J0 Trace Messaging
Use the parameters EXPJ0, LENJ0, J0MEAREPT in the following commands to enable the reporting of J0
trace mismatch condition. Table 11-11 on page 11-14 describes the usage of the parameters.
Refer to “ED-OC48 (Edit-OC48)” on page 5-77 to enable the reporting of J0 trace mismatch condition for the OC48 facility on the TOM circuit pack.
Refer to “ED-STM16 (Edit-STM16)” on page 5-67 to enable the reporting of J0 trace mismatch condition for the STM4 facility on the TOM circuit pack.
Refer to “ED-STM64 (Edit-STM64)” on page 5-69 to enable the reporting of J0 trace mismatch condition for the STM64 facility on the TOM circuit pack.
Table 11-11 J0 Trace Messaging Command Parameters Description
Keyword
Description
Range
Default
EXPJ0
Expected J0 message
00000000 to 11111111
00000001
LENJ0
The length of J0 byte
1, 16, 64
16
J0MEAREPT
The flag for enabling or disabling the reporting
of J0 trace mismatch condition
Enable, Disable
Disable
Example
Use the following command to enable the reporting of J0 trace mismatch condition.
ED-OC192:[<TID>]:<AID>:<CTAG>:::[<LABEL=label>][,<EXPJ0=expj0>][,<LENJ0=1|1
6|64>][,<J0MEAREPT=Enabled|Disabled>][,<HISTSTATS=ENABLE|DISABLE>]:[IS|OOS];
Output
The following message is returned indicating successful completion.
NE31 04-07-24 13:07:05
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
M
Page 11-15
ctag COMPLD;
DTF Section Trace Messaging
The DTF section trace messaging is utilized to detect any mis-connections between the TN780 network
elements within a Digital Link.
To enable the DTF section trace messaging, use the parameters INSERTTTI, TXTTI, EXPTTI and
TTIALARMRPT in the command “ED-DTPCTP (Edit-DTPCTP)” on page 6-16. Refer to Table 11-12 on
page 11-15 for a description on the usage of the parameters.
Table 11-12 DTF Section Trace Messaging Command Parameters Description
Keyword
Description
Valid Range
Default
INSERTTTI
Flag to Enable or Disable the TTI injection
enabled, disabled
enabled
TXTTI
TTI to be transmitted in the transmit
directions
String of 64 characters
Not Applicable
EXPTTI
Expected TTI
String of 64 characters
Not Applicable
TTIALARMRPT
Alarm reporting enable or disable flag
enabled, disabled
disabled
Example
Use the following command to enable the DTF section trace messaging.
ED-DTPCTP::1-A-4-T11:ctag:::inserttti=enabled,txtti=tester,exptti=test,ttialarmrpt=enabled;
Output
The following message is returned indicating successful completion.
NE31 04-07-24 13:09:16
M
ctag COMPLD
;
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-16
Trace Messaging
DTF Path Trace Messaging
The DTF path trace messaging is utilized to detect any mis-connections in the circuit path along the Digital
Optical Network.
To enable the DTF path trace messaging, use the parameters INSDTSTTI, DTSTXTTI and DTSEXPTTI in
the command “ED-OCH (Edit-Optical Channel)” on page 5-58. Refer to Table 11-13 on page 11-16 for a
description on the usage of the parameters.
Table 11-13 DTF Path Trace Messaging Command Parameters Description
Keyword
Description
Valid Range
Default
INSDTSTTI
Flag to enable or disable the TTI injection
(DTS)
enabled
enabled
DTSTXTTI
Section layer TTI to be transmitted in the
transmit directions
String of 64 characters
Not Applicable
DTSEXPTTI
Expected TTI
String of 64 characters
Not Applicable
disabled
Example
Use the following command to enable DTF path trace messaging.
ED-OCH::1-A-4-L110:ctag:::insdtstti=enable,dtstxtti=basant,dtsexptti=jena,ttialarmrpt=enabled;
Output
The following message is returned indicating successful completion.
NE31 04-07-24 13:11:38
M
ctag COMPLD;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-17
RTRV-TRACEROUTE
Command Description
This command is used to obtain the traceroute information of the destination.
Command Syntax
RTRV-TRACEROUTE:[<TID>]::<CTAG>::<destination>;
Table 11-14 RTRV-TRACEROUTE Command Usage
Section
User Access Privilege Level
Description
Test and Turn-up, Network Administrator, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
OPR-LPBK (Operate-Loopback)
Response Format
Standard
Error Codes
SAMS, ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARL (See
Table 2-6 on page 2-14).
Table 11-15 RTRV-TRACEROUTE Command Parameters Description
Keyword
DESTINATION
Description
Destination of the route
Valid Range
IP Address
Default
Mandatory
Example
Use the following commands to obtain the traceroute information of the destination (IP Address) specified.
TL1>>RTRV-TRACEROUTE:::c::10.10.8.101;
Output
The following message is returned indicating successful completion.
BM 05-02-11 20:50:05
M
c COMPLD
":traceroute to 10.10.8.101 (10.10.8.101), 20 hops max, 40 byte packets
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-18
1
Trace Messaging
10.10.8.101
1 ms"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-19
RTRV-PING
Command Description
This command is used to ping a particular destination.
Command Syntax
RTRV-PING:[<TID>]::<CTAG>::<destination>;
Table 11-16 RTRV-PING Command Usage
Section
Description
User Access Privilege Level
Security Administrator, Network Element, Test and Turn-up, Network Administrator, Provisioning
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
Standard
Error Codes
None
Table 11-17 RTRV-PING Command Parameters Description
Parameters
DESTINATION
Description
Destination of the
PING request
Valid Range
IP Address
Default
Mandatory
Example
Use the following commands to ping a particular destination.
RTRV-PING:::ctag::10.10.8.80;
Output
The following message is returned indicating successful completion.
TL1>>
blr880 05-02-13 04:46:32
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-20
M
Trace Messaging
ctag COMPLD
":PING 10.10.8.80 (10.10.8.80): 56 data bytes
64 bytes from 10.10.8.80: icmp_seq=0 ttl=255 time=1.000 ms
64 bytes from 10.10.8.80: icmp_seq=1 ttl=255 time=1.000 ms
64 bytes from 10.10.8.80: icmp_seq=2 ttl=255 time=2.000 ms
----10.10.8.80 PING Statistics---3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 1.000/1.333/2.000/0.577 ms
"
;
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-21
RTRV-LASTLSATEACTVITYTIME
Command Description
This command is used to view the time when the last TE-LSA packet was received from the neighbouring
node in the network.
Command Syntax
RTRV-LASTLSATEACTVITYTIME:[<TID>]::<CTAG>::<nename>;
Table 11-18 RTRV-LASTLSATEACTVITYTIME Command Usage
Section
User Access Privilege Level
Description
Monitoring Access
Pre-condition
None
Post-condition
None
Related Commands
None
Response Format
Standard
Error Codes
SAMS, ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARL (See
Table 2-6 on page 2-14).
Table 11-19 RTRV-LASTLSATEACTVITYTIME Command Parameters Description
Keyword
NENAME
Description
Valid Range
Any network element name or Node ID
within the network
Not Applicable
Default
Mandatory
Table 11-20 RTRV-LASTLSATEACTVITYTIME Response Parameter Description
Parameters
Description
NENAME
Name of the network element
ROUTERID
Router ID
LASTLSATEACTIVITYTIME
Time we last received (TE-LSA) from another node in
the network
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-22
Trace Messaging
Example
Use the following commands to view the TE-LSA.
RTRV-LASTLSATEACTVITYTIME:::ctag::LABTEST;
Output
The following message is returned indicating successful completion.
LABTEST 05-01-26 04:14:15
M
ctag COMPLD
":MeName | RouterId | LastTeLsaActivityTime
LABTEST | 100.100.8.156 | Tue Jan 25 20:12:21 2005";
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-23
ED-TL1-DEFAULTS
Command Description
This command is used to modify the general TL1 defaults parameter.
Command Syntax
ED-TL1-DEFAULTS:[<TID>]::<CTAG>:::<CMDTERM=SEMCOL|SEMCOLCR>;
Table 11-21 ED-TL1-DEFAULTS Command Usage
Section
Description
User Access Privilege Level
Security Administrator
Pre-condition
This is a non-persistent command. The settings will not be remembered after the reset of the MCM.
This command works on all the sessions that are present on the
network element.
Post-condition
Systemwide change to command terminating character for all
commands
Related Commands
None
Response Format
Standard
Error Codes
ENSI, IIAC, IIFM, IPNV, IDNV, IDNC, IEAE, SARB, SAOP (See
Table 2-6 on page 2-14).
Table 11-22 ED-TL1-DEFAULTS Command Parameters Description
Keyword
CMDTERM
Description
Command Termination
Valid Range
SEMCOL, SEMCOLCR
Default
Not Applicable
Example
Use the following commands to modify the general TL1 defaults parameter.
ED-TL1-DEFAULTS:::ctag:::CMDTERM=SEMCOL;
Output
The following message is returned indicating successful completion.
NE1 05-02-20 09:42:10
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-24
M
Trace Messaging
ctag COMPLD
TL1 User Guide
Release 1.2
UTStarcom Inc.
Diagnostics
Page 11-25
PRBS Test
The UTStarcom Digital Optical Networking Systems provide access to the Pseudo Random Bit Sequence
(PRBS) Test generation and monitoring capabilities. The PRBS is a test pattern that is used to diagnose
and isolate the troubled spots in the network, without the requirement for valid data signal or customer
traffic. This type of test signal is used during the system turn-up or in the absence of a valid data signal
from the customer equipment. The test is primarily aimed to watch out and sectionalize the occurrence of
bit errors in the data path. Since the PRBS test affects the normal data traffic flow, it must be invoked only
when the associated facility is in administrative maintenance state.
The TN780 supports PRBS generation and monitoring for testing circuit quality at both the DTF Section
and DTF Path layers. See Figure 11-1 on page 11-25.
“DTF Section-level PRBS Test” on page 11-25
“DTF Path-level PRBS Test” on page 11-26
Figure 11-1 PRBS Tests Supported by the TN780
C
lie
n
t
C
lie
n
t
G
D
T
F
S
e
c
tio
n
P
R
B
S
M
D
T
F
P
a
th
P
R
B
S
M
GP
R
B
S
G
e
n
e
r
a
to
r
G
MP
R
B
S
M
o
n
ito
r
Note: The PRBS tests can be coupled with loopback tests so that the pre-testing of the quality of
the digital link or end-to-end digital path can be performed without the need for an external
PRBS test set. While this is not meant as a replacement for customer-premise to customer-premise circuit quality testing, it does provide an early indicator of whether or not the
transport portion of the full circuit is providing a clean signal.
DTF Section-level PRBS Test
The PRBS signal is generated by the near end DLM and it is monitored by the adjacent TN780 network
elements. This test verifies the quality of the digital link between two adjacent TN780 network elements.
To enable the DTF section-level PRBS generation and monitoring, use the parameters PRBSGEN and
PRBSMON in the command (“ED-OCH (Edit-Optical Channel)” on page 5-58). Refer to (“DTF SectionLevel PRBS Test Command Parameter Description” on page 11-26) for a description on the usage of the
parameters.
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page 11-26
PRBS Test
Table 11-23 DTF Section-Level PRBS Test Command Parameter Description
Keyword
Description
Valid Range
PRBSGEN
Flag to enable or disable the PRBS test
pattern generation
enabled
PRBSMON
Flag to enable or disable the PRBS monitoring mode
enabled
Default
disabled
disabled
disabled
disabled
DTF Path-level PRBS Test
The PRBS signal is generated by the near end TAM circuit pack and it is monitored at the far end TAM
circuit pack where the digital path is terminated. This test verifies the quality of the end-to-end digital path.
use the parameters PRBSGEN and PRBSMON in the command (“ED-DTPCTP (Edit-DTPCTP)” on
page 6-16). Refer to (“DTF Path-Level PRBS Test Command Parameter Description” on page 11-26) for a
description on the usage of the parameters.
Table 11-24 DTF Path-Level PRBS Test Command Parameter Description
Keyword
PRBSGEN
PRBSMON
TL1 User Guide
Description
Valid Range
Flag to enable or disable the PRBS test
pattern generation
enabled
Flag to enable or disable the PRBS test
pattern monitoring
enabled
Release 1.2
Default
disabled
disabled
disabled
disabled
UTStarcom Inc.
Appendix A
Acronyms
Acronym
Definition
A
ACLI
application command line interface
ACO
alarm cutoff
ACT
active
AD
add/drop
ADM
add/drop multiplexer
ADPCM
adaptive differential pulse code modulation
AGC
automatic gain control
AID
access identifier
AINS
administrative inservice
AIS
alarm indication signal
ALS
automatic laser shutdown
AMP
amplifier
ANSI
American National Standards Institute
AO
autonomous output
APD
avalanche photo diode
API
application programming interface
APS
automatic protection switching
ARC
alarm reporting control
ARP
address resolution protocol
ASAP
alarm severity assignment profile
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page A-2
Acronyms
Acronym
Definition
ASE
amplified spontaneous emission
ASIC
application-specific integrated circuit
ATM
asynchronous transfer mode
AU
administrative unit
AUX
auxiliary port
AWG
array waveguide gating
AWG
american wire gauge
B
BDFB
battery distribution fuse bay
BDI
backward defect indication
BDI
backward defect indication
BEI
backward error indication
BER
bit error rate
BERT
bit error rate testing
BGA
ball grid array
BIP-8
bit interleaved parity
BITS
building-integrated timing supply
BLSR
bi-directional line switched ring
BMM-C
Band Mux Module - C band
BNC
Bayonet Niell-Concelman; British Naval Connector
BOL
beginning of life
BOM
bill of material
BOOTP
bootstrap protocol
bps
bits per second
BPV
bipolar violations
C
C
Celsius
CCITT
Consultative Committee on International Telegraph and Telephone
CCLI
commissioning command line interface
CDE
chromatic dispersion equalizer
CDR
clock and data recovery
CDRH
Center for Devices and Radiological Health
CFR
code for federal regulations
CH/Ch/ch
channel
TL1 User Guide
Release 1.2
UTStarcom Inc.
Acronyms
Page A-3
Acronym
Definition
CID
circuit identifier
CIT
craft interface terminal
CLEI
common language equipment identifier
CLI
command line interface
CO
central office
CODEC
coder and decoder
COM
communication
CORBA
common object request broker architecture
CPC
common processor complex
CPE
customer premises equipment
CPLD
complex programmable logic device
CPU
central processing unit
CRC
cyclic redundancy check
CSPF
constraint-based shortest path first algorithm
CSV
comma separated value
CTAG
correlation tag
CTP
client termination point
CTS
clear to send
CV
coding violation
CV-L
coding violation-line
CV-P
coding violation-path
CV-S
coding violation-section
D
DA
digital amplifier
dB
decibel
DB
database
DCC
data communications channel
DCE
data communications equipment
DCF
dispersion compensation fiber
DCM
dispersion compensation module
DCN
data communication network
DEMUX
de-multiplexing
DFB
distributed feedback
DFE
decision feedback equalizer
DGE
dynamic gain equalization
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page A-4
Acronyms
Acronym
DHCP
Definition
dynamic host configuration protocol
DLM
digital line module
DMC
dispersion management chassis
DR
digital repeater
DSF
dispersion shifted fiber
DT
digital terminal
DTC
digital transport chassis
DTE
data terminal equipment
DTF
digital transport frame
DTL
digital transport line
DTMF
dual tone multi frequency
DTP
digital transport path
DTS
digital transport section
DWDM
dense wavelength division multiplexing
E
EDFA
erbium doped fiber amplifier
EEPROM
electrically-erasable programmable read only memory
EMC
electromagnetic compatibility
EMI
electro-magnetic interference
EMS
element management system
EOL
end-of-life
ESD
electrostatic discharge; electrostatic-sensitive device
ES-L
line-errored seconds
ES-P
path-errored seconds
ES-S
section-errored seconds
ETS
IEEE european test symposium
ETSI
European Telecommunications Standards Institute
F
F
fahrenheit
FA
frame alignment
FAS
frame alignment signal
FC
fiber channel; failure count
FCAPS
fault management, configuration management, accounting, performance monitoring, and security administration
TL1 User Guide
Release 1.2
UTStarcom Inc.
Acronyms
Page A-5
Acronym
Definition
FCC
Federal Communications Commission (USA)
FDA
Food and Drug Administration
FDI
forward defect indication
FEC
forward error correction
FIFO
first-in-first-out
FIT
failure in time
FLT
fault
FPGA
field programmable gate array
FRU
field replaceable unit
FTP
file transfer protocol
G
GbE
gigabit ethernet
Gbps
gigabits per second
GCC
general communication channel
GFP
general framing protocol
GHz
gigahertz
GMPLS
generalized multi protocol label switching
GNE
gateway network element
GNM
graphical node manager
GUI
graphical user interface
H/I
HTML
hypertext markup language
HTTP
hypertext transfer protocol
IAP
input, output and alarm panel
ID
identification
IDF
invalid data flag
IEC
International Electrical Commission
I/O
Input/Output
IOP
input output panel
IP
Internet protocol
IQ
see IQ NOS
IQ NOS
UTStarcom IQ network operating system
IR
intermediate reach
IS
in-service
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page A-6
Acronyms
Acronym
ITU-T
Definition
International Telecommunications Union - Telecommunications
J/K/L
JDK
Java Development Kit
JRE
Java Runtime Environment
LAN
local area network
LBC
laser bias current
LC
fiber optic cable connector type
LCK
locked
LED
light-emitting diode
Linear ADM
linear add/drop multiplexer
LOF
loss of frame
LOL
loss of light
LOP
loss of pointer
LOS
loss of signal
LR
long reach
LSB
least significant bit
LTE
line-terminating equipment
LVDS
low voltage differential signaling
M
MA
monitoring access
MAC
media access control
MB
megabyte
Mb/s
megabits per second
MIB
management information base
MCM
management and control module
MEMS
micro electro mechanical systems
MFAS
multi frame alignment signal
MIB
management information base
MMF
multimode fiber
MS
multiplex section
MSA
multi source agreement
MSB
most significant bit
MSOH
multiplex section overhead
MTBF
mean time between failure
TL1 User Guide
Release 1.2
UTStarcom Inc.
Acronyms
Page A-7
Acronym
Definition
MTU
maximum transmission unit
MX
multiplex, multiplexer, multiplexing
N
NA
network administrator
NAND
flash type
NC
normally closed; node controller
NCC
node controller chassis
NCT
nodal control and timing
NDSF
non zero dispersion shifted fiber
NE
network engineer
NEBS
network equipment building system
NECG
net electrical coding gain
NEPA
national fire protection association
NJO
negative justification opportunity
nm
nanometer
NML
network management layer
NMS
network management system
NNI
network-to-network interface
NO
normally open
NSA
non-service affecting
NTP
network time protocol
NVRAM
nonvolatile random access memory
O
OAM
optical amplification module
OAM&P
operation, administration, maintenance and provisioning
OC-12
optical carrier signal at 622.08 mb/s
OC-192
optical carrier signal at 9.95328 gb/s
OC-3
optical carrier signal at 155.52 mb/s
OC-48
optical carrier signal at 2.48832 gb/s
OCG
optical carrier group
Och
Optical channel
OCI
open connection indication
ODU
optical channel data unit
OEO
optical-electrical-optical conversion
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page A-8
Acronyms
Acronym
OFC
Definition
open fiber control
OH
overhead
OIF
optical internetworking forum
OLA
optical line amplifier
OMM
optical management module
OMS
optical multiplex section
OOS
out-of-service
OOS-MT
out-of-service maintenance
OPR
optical power received
OPT
optical power transmitted
OPU
optical channel payload unit
ORL
optical return loss
OS
operating system
OSA
optical spectrum analyzer
OSC
optical supervisory channel
OSNR
optical signal-to-noise ratio
OSPF
open shortest path first
OSS
operations support system
OTC
optical transport chassis
OTDR
optical time domain reflectometer
OTN
optical transport network
OTS
optical transport section
OTU
optical channel transport unit
OW
orderwire
OWM
orderwire module
P/Q
PC
personal computer
PCPM
per channel power monitoring
PDU
protocol data unit; power distribution unit
PEM
power entry module
PF
partial failure
PG
protection group
PHY
physical
PIC
photonic integrated circuit
PID
protocol identifier
TL1 User Guide
Release 1.2
UTStarcom Inc.
Acronyms
Page A-9
Acronym
Definition
PIN
positive-intrinsic negative
PJO
positive justification opportunity
PLD
programmable logic device
PLL
phase locked loop
PM
performance monitoring
PMD
polarization mode dispersion
POH
path overhead
POP
point-of-presence
PPM
part per million
PPP
point-to-point protocol
PR
provisioning
PRBS
pseudo random binary sequence
ps
pico second (unit of measure for dispersion)
PSC
protection switch completion; protection switch count
PSD
protection switch duration
PSTN
public switched telephone network
PT
parallel telemetry
PTP
physical termination point; point-to-point
PWR
power
QOS
quality of service
R
RAM
random access memory
RDI
remote defect indication
REI-L
remote error indication-line
REI-P
remote error indication-path
RFI
remote failure indication
ROM
read-only memory
RS
regenerator section; reed solomon
RSOH
regenerator section overhead
RTC
real time clock
RTN
return lead
RTS
ready to send
RU
rack unit
Rx
receiver; receive
Rx Q
receiver quality
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page A-10
Acronyms
Acronym
Definition
S
SA
service affecting; security administrator
SAPI
source access point identifier
SC
square shaped fiber optic cable connector
SD
signal degrade
SDH
synchronous digital hierarchy
SDRAM
synchronized dynamic random access memory
SEF
severely errored frame
SEFS
severely errored frame second
SELV
safety extra low voltage
SERDES
serializer and deserializer
SES
severely errored seconds
SF
signal fail
SFP
small form factor plug
SID
source identifier; system identifier
SMF
single-mode fiber
SML
service management layer
SNC
sub network connection
SNE
subtending network element
SNMP
simple network management protocol
SNR
signal-to-noise ratio
SOH
section overhead
SOL
start of life
SONET
synchronous optical network
SPE
synchronous payload envelope
SQ
signal quality
SR
short reach
SSL
secure sockets layer
STE
section terminating equipment
STM
synchronous transfer mode
STM-1
SDH signal at 155.52 Mb/s
STM-16
SDH signal at 2.48832 Gb/s
STM-4
SDH signal at 622.08 Mb/s
STM-64
SDH signal at 10 Gb/s
STM-n
synchronous transport module of level n (for example, STM-64, STM-16)
TL1 User Guide
Release 1.2
UTStarcom Inc.
Acronyms
Page A-11
Acronym
Definition
STS
synchronous transport signal
STS-n
synchronous transport signal of level n (for example, STS-12, STS-48)
SW
software
T/U/V
TAM
tributary adapter module
TAP
timing and alarm panel
TCA
Threshold Crossing Alert
TCP
transmission control protocol
TE
traffic engineering
TEC
thermo-electric cooler
TERM
terminal
TFTP
trivial file transfer protocol
TID
target identifier
TIM
trace identifier mismatch
TL1
transaction language 1
TMN
telecommunications management network
TOM
tributary optical module
TP
termination point
TR
transceiver
TT
test and turn-up
TTI
trail trace identifier
Tx
Transmitter; Transmit
UA
unavailable seconds
UART
universal asynchronous receiver transmitter
UAS
unavailable seconds
UAS-L
unavailable seconds, near-end line
UAS-P
unavailable seconds, near-end STS path
UDP
user datagram protocol
UPSR
unidirectional path switched ring
URL
universal resource locator
UTC
Coordinated Universal Time
V
volt
VGA
variable gain amplifier
VLAN
virtual local area network
VOA
variable optical attenuator
UTStarcom Inc.
TL1 User Guide
Release 1.2
Page A-12
Acronyms
Acronym
Definition
VPN
virtual private network
VSR
very short reach
W/X/Y/Z
WAN
wide area network
WDM
wavelength division multiplexing
XC
cross-connect
XFP
name of a small form factor 10 Gbps optical transceiver
XML
extensible markup language
MISC
1R
re-amplification
2R
re-amplification, re-shape
3R
re-amplification, re-shape, re-time
4R
re-amplification, re-shape, re-time, re-code
TL1 User Guide
Release 1.2
UTStarcom Inc.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement