Optical Multiservice Edge 6130 TL1 Reference

323-1855-190
Nortel
Optical Multiservice Edge 6130

TL1 Reference
Standard Rel 2.0 Issue 1 June 2007
What’s inside...
Network Element Discovery and Management
Connection Management
Performance Monitoring
Network Backup and Restore
Network Load Management
Topology Adjacency
Equipment
Security
Appendix - Common TL1 Parameter
Errors
Copyright  2006-2007 Nortel Networks, All Rights Reserved
This document is protected by copyright laws and international treaties. All information, copyrights and any other intellectual property
rights contained in this document are the property of Nortel Networks. Except as expressly authorized in writing by Nortel Networks,
the holder is granted no rights to use the information contained herein and this document shall not be published, copied, produced
or reproduced, modified, translated, compiled, distributed, displayed or transmitted, in whole or part, in any form or media.
The information is provided “as is” and Nortel Networks does not make or provide any warranty of any kind, expressed or implied,
including any implied warranties of merchantability, non-infringement of third party intellectual property rights, and fitness for a
particular purpose.
Nortel, the Nortel logo and the Globemark are trademarks of Nortel Networks.
Internet Explorer is a trademark of Microsoft Corporation.
Netscape is a trademark of Netscape Communications Corporation.
Printed in Canada
iii
Contents 0
About this document ix

Optical Multiservice Edge 6130 NTP Library
Network Element Discovery and Management 1-1

TL1 commands and responses 1-1
RTRV-HDR: Retrieve Header 1-2
ACT-USER: Activate User (session) 1-3
Syntax Definition 1-3
RTRV-LAST-SEQNUM: Retrieve Last Sequence Number 1-4
RTRV-NETYPE: Retrieve Network Element 1-5
RTRV-SW-VER:Retrieve Software Version 1-6
RTRV-RTG-INFO:Retrieve Routing Info 1-6
Response Syntax Definition 1-7
RTRV-SYS: Retrieve System 1-7
RTRV-IP: Retrieve IP 1-8
ED-DAT:Edit NE Date & Time 1-9
SET-TOD-SER 1-10
ED-TOD-MODE 1-11
ALW-MSG-BROADCAST:Allow Message Broadcast 1-11
INH-MSG-BROADCAST:Inhibit Message Broadcast 1-12
ALW-MSG-ALL: Allow Message All 1-13
RTRV-COND-ALL: Retrieve Conditions All 1-13
RTRV-ALM-ENV:Retrieve Environment Alarm 1-16
CANC-USER: Cancel User (Session) 1-17
Connection Management 2-1

End-Point TL1 Interface 2-3
RTRV-EQPT: Retrieve Equipment 2-3
TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

iv Contents

RTRV-OCn (OCn = OC3, OC12, etc):Retrieve OCn 2-4
RTRV-E1:Retrieve E1 Facility 2-4
RTRV-E3: Retrieve E3 Facility 2-5
RTRV-T1: Retrieve Facility data 2-6
RTRV-T3: Retrieve Facility data 2-6
RTRV-ETH: Retrieve Ethernet Facility 2-7
RTRV-WAN: Retrieve WAN Facility 2-8
RTRV-FFP-OCn (OCn = OC3, OC12 etc):Retrieve Protection Group 2-9
RTRV-SYS: Retrieve system wide parameters 2-10
RTRV-CRS-ALL: Retrieve Crossconnection all 2-10
ENT-CRS-VT1: Enter Crossconnection 2-11
ENT-CRS-VT2: Enter Crossconnection-VT2 2-13
ENT-CRS-STS1: Enter Crossconnection-STS1 2-15
ENT-CRS-STS3C: Enter Crossconnections-STS3C 2-17
DLT-CRS-VT1: Delete Crossconnections 2-19
DLT-CRS-VT2 2-21
DLT-CRS-STS1: Delete Crossconnection STS1 2-21
DLT-CRS-STS3C:Delete Crossconnection-STS3C 2-23
ED-CRS-VT1:Edit Crossconnection-VT1 2-23
ED-CRS-VT2: Edit Crossconnection-VT2 2-24
ED-CRS-STS1: Edit Crossconnection-STS1 2-25
ED-CRS-STS3C: Edit Crossconnection-STS3C 2-27
RTRV-STSn(STSn = STS1, STS3C, STS12c) 2-28
Performance Monitoring 3-1

Performance Monitoring- AID type all 3-1
Performance Monitoring - AID Type ALL 3-1
RTRV-PM-ALL: Retrieve Current/Previous Counts All 3-2
Network Backup and Restore 4-1
Optical Multiservice Edge 6130 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007
Contents v
SAV-PROV: Save Provisioning 4-1

RST-PROV: Restore provisioning 4-2
Input Syntax Definition 4-3
CMMT-PROV: Commit provisioning 4-3
Network Load Management 5-1

CANC-RELEASE: Cancel Release 5-2
CANC-UPGRD: Cancel Upgrade 5-2
CHK-RELEASE: Check Release 5-3
CHK-UPGRD: Check Upgrade 5-4
CMMT-UPGRD: Commit Upgrade 5-4
DLT-RELEASE: Delete Release 5-5
DLVR-RELEASE: Deliver Release 5-5
INVK-UPGRD: Invoke Upgrade 5-6
LOAD-UPGRD: Load Upgrade 5-7
RTRV-RELEASE: Retrieve Release 5-7
RTRV-SPACE: Retrieve Space 5-8
RTRV-UPGRD-STATE: Retrieve Upgrade State 5-8
Topology Adjacency 6-1

Topology Adjacency TL1 Interface 6-1
RTRV-AD-ALL: Retrieve auto discovery 6-1
Equipment 7-1
RTRV-INVENTORY 7-1
INIT-WARM 7-3
INIT-COLD 7-4
Security 8-1
ENT-SECU-USER: Enter security user 8-1
Input syntax Definition 8-2
DLT-SECU-USER: Delete Security User 8-2
ED-SECU-USER: Edit Security User 8-3
Input syntax Definition 8-3
Appendix - Common TL1 Parameter 9-1

TID 9-4
CTAG 9-5
DATE 9-6
TIME 9-7
UID 9-7
SID 9-8
PID 9-9
UPC 9-10

vi Contents
SWVERSION 9-10
OCRDAT 9-12
OCRTM 9-12
SRVEFF 9-13
CONDDESCR 9-13
YEAR 9-14
DGNTYPE 9-14
AEND 9-15
ZEND 9-16
SERADDRESS[1-5] 9-16
SYNC 9-17
POLLINGINTERVAL 9-17
CKTID 9-18
CCT 9-18
AID-OCn 9-20
AID-CARD 9-20
AID-E1 9-22
AID-E3 9-22
AID-DS1 9-23
AID-DS3 9-24
TERM 9-25
AID-ETH 9-26
TXCON 9-27
AID-WAN 9-27
MAPPING 9-28
RATE 9-28
VCAT 9-29
LCAS 9-29
SEQTYPE 9-30
ATAGSEQ 9-30
DBCHGSEQ 9-31
MONTYPE 9-31
MONLEV 9-32
LOCN 9-33
DIRN 9-33
MONVAL 9-34
TMPER 9-35
MONDAT 9-35
MONTM 9-36
INDEX 9-36
VLDTY 9-37
URL 9-38
CHKALM 9-38
CHKTID 9-39
RELNO 9-40
ALRMS 9-40
XBYTESAVAILABLE 9-41
FREEBYTES 9-41
UPGRDSTAGE 9-42
UPGRDRSLT 9-43
SER 9-43
Contents vii
PEC 9-44
CMDCODE 9-44
AID1 9-45
AID2 9-45
COMMON_BLOCK 9-46
SPECIFIC_BLOCK 9-46
FAILURESTRING 9-47
STATE_BLOCK 9-48
STATUS 9-48
AID (PORT) 9-49
AIDFORMAT 9-49
LAYER 9-50
ENABLED 9-50
MECHANISM 9-51
TX_VERSION 9-51
TX_SIGNATURE 9-52
TYPE 9-52
RX_VERSION 9-53
RX_ACTUAL 9-53
RX_EXPECTED 9-54
RX_RELIABILITY 9-54
RX_TERMINATED 9-55
RX_ACCEPTED 9-55
CLEI 9-56
NEWUID 9-56
NEWPID 9-57
USERTYPE 9-57
Errors 10-1

viii Contents
323-1855-190
ix
About this document 0
The purpose of this document is to be a one stop shop for Network Element
teams to find details on all TL1 commands, in order to achieve a consistent
TL1 interface across products.
The document
• provides a detailed description of each TL1 command and corresponding

responses, listing the parameters, where necessary explicitly specifying the
enumerated values.
• highlights expected Network Element behaviors which have a bearing on
the Nortel element management platform capability to manage an Network
Element.
• addresses AID definitions, Alarms, Events and DBCHGs, with a view to
enforcing the standard formats and behaviors that are present within the
existing Nortel Network Elements.
• Covers Connection Management, Performance Monitoring, Network
Element Backup & Restore and Load Management applications.
This version of this specification does not explicitly state OSMINE
requirements. However it is the intention of this document that any item in this
specification is OSMINE compliant. However, it is possible that Items
(example: commands) not required by OMEA, but required by OSMINE will
not be in this specification.
The topics covered are:
• TL1 command Syntax

• Responses
• Errors

x About this document
Optical Multiservice Edge 6130 NTP Library
Planning a Installing, Managing and Maintenance and Supporting

documentation
Network Commissioning and Provisioning Troubleshooting for the OME6130
Testing a Network a Network a Network Library
Network
Interworking Guide
(NTCA68CA)
Data
About the Installation, Provisioning and Trouble Clearing and Application Guide
OME6130 Commissioning and Protection Switching Module Replacement (NTRN15BA)
NTP Library Testing Procedures Procedures Procedures
(323-1855-090) (323-1855-201) (323-1855-310) (323-1855-543)
Bandwidth and
Planning Guide Data Services
(NT6Q92MB) Procedures
(323-1855-320)
TL1 Reference
(323-1855-190)
Local Craft Access

User Guide
(323-1855-195)
References
This document refers to the following NTPs:
• About the OME6130 NTP Library, 323-1855-090
• Local Craft Access User Guide, 323-1855-195
• Installation, Commissioning, and Testing Procedures, 323-1855-201
• Provisioning and Protection Switching Procedures, 323-1855-310
• Bandwidth and Data Services Procedures, 323-1855-320
• Trouble Clearing and Module Replacement Procedures, 323-1855-543
• Planning Guide, NT6Q92MB
323-1855-190
1-1
Network Element Discovery and

Management 1-
TL1 commands and responses

Table 1-1 lists the commands supported for Network Element discovery and
management.
Table 1-1
TL1 commands for Network Element discovery
TL1 command
RTRV-HDR: Retrieve Header
ACT-USER: Activate User (session)
RTRV-LAST-SEQNUM: Retrieve Last Sequence Number
RTRV-NETYPE: Retrieve Network Element
RTRV-SW-VER:Retrieve Software Version
RTRV-RTG-INFO:Retrieve Routing Info
RTRV-SYS: Retrieve System
RTRV-IP: Retrieve IP
ED-DAT:Edit NE Date & Time
SET-TOD-SER
ED-TOD-MODE
ALW-MSG-BROADCAST:Allow Message Broadcast
INH-MSG-BROADCAST:Inhibit Message Broadcast
ALW-MSG-ALL: Allow Message All
RTRV-COND-ALL: Retrieve Conditions All
CANC-USER: Cancel User (Session)

1-2 Network Element Discovery and Management
RTRV-HDR: Retrieve Header

Use this command to obtain TID value of Network Element by Element
management Platform (The NE Manager will send a RTRV-HDR command to
Network Element without specifying TID. The Network Element will be
expected to respond with a erroneous message containing the SID).
Table 1-2
Field Description
Category System Common
Security Level 1
Logged None
Input Syntax RTRV-HDR:[<tid>]::<ctag>;

where
• <tid> is the target identifier.
• <ctag> is the correlation tag.
Response formats
COMPLD response. -
DENY response. OMEA re-discovery (If the TID of a

Network Element is changed after OMEA
discovery RTRV-HDR will return a DENY
response. OMEA will then re-discover
the Network Element). OMEA acquisition
of the NE’s TID via the SID contained in
the Error Response.
No response. OMEA re-discovery – used to trigger

re-discovery.
Normal Response Syntax ^^^SID^93-06-15^10:12:11

M^^<ctag>^COMPLD
Errors Errors are listed in Table 10-1 on

page 10-1.
ACT-USER: Activate User (session)

Use this command to log into the Network Element and to create a user TL1
session with the Network Element.
Table 1-3
Field Description
Category Security
Security Level 1
Logged TL1 Log
Input Syntax ACT-USER:[tid]:<uid>:ctag::<pid>;

where
Response Syntax ^^^SID^93-06-15^10:12:11

M^^<ctag>^COMPLD

page 10-1.
Note: Passwords that contain lowercase characters must be enclosed within double
quotes. For example, a password of test123 should be entered as 'test123'. Also,
special characters such as backslash and quote must be properly escaped as
described in Telcordia specification GR-813.
Syntax Definition
Table 1-4
Input syntax
Parameter Attributes Description
uid M New User Identification.It

is a text string with a
maximum length of 10
characters.
pid M The user login password. It

is a text string with a
minimum length of eight
characters and maximum
of ten characters.

RTRV-LAST-SEQNUM: Retrieve Last Sequence Number

Use this command to obtain last ATAG Sequence Number from Network
Element.
Table 1-5
Field Description
Category Alarms
Security Level 1
Logged None
Input Syntax RTRV-LAST-SEQNUM:[<tid>]::<ctag>::[

<seqtype>];
where
Response Syntax ^^SID^93-06-15^10:12:11

M^^<ctag>^COMPLD
^^^"[ATAGSEQ=<atagseq>],
[DBCHGSEQ=<dbchgseq>]"
where
• ATAGSEQ is the Autonomous Event
Sequence Number.
•DBCHGSEQ is the Database Change
Sequence Number.

page 10-1.
Syntax Definition
Table 1-6
Input syntax
seqtype 0 Sequence Number Type.
RTRV-NETYPE: Retrieve Network Element

Use this command to retrieve equipment related information from the Network
Element.
Table 1-7
Field Description
Category System Parameters
Security Level 1
Logged None
Input Syntax RTRV-NETYPE:[tid]::ctag;

M^^<ctag>^COMPLD
^^^"<manuf>, <model>, <neType>,
<swIssue>"

page 10-1.
Syntax Definition
Table 1-8
Response syntax
manuf M Manufacturing Name.
model M Shelf Model
neType M Type of Network Element.
swIssue M Current software issue

running.

RTRV-SW-VER:Retrieve Software Version

Use this command to retrieve the version of the software on the Network
Element.
Table 1-9
Field Description
Security Level 1
Logged None
Input Syntax RTRV-SW-VER:[tid]::ctag;
Response Syntax ^^^<SID>^<DATE>^<TIME>

M^^<CTAG>^COMPLD
"swVersion"

page 10-1.
RTRV-RTG-INFO:Retrieve Routing Info

Use this command to return a report list containing the target Network
Element, together with where applicable, any subtended Network Elements.
This command must be available for non-GNE Network Elements. In such
instances the command must return a single entry for the respective Network
Element. The report lists the Network Element source identifiers (SID), the
OSI system identifiers and the OSI cost values.
Element Manager uses to acquire the Network Element MAC Address. This
command will return entries who's TID matches the NAME field.
Table 1-10
Field Description
Category OSI Comms
Security Level 1
Logged None
Input Syntax RTRV-RTG-INFO:[tid]::ctag;
Response Syntax ^^^SID^DATE^TIME

M^^<ctag>^COMPLD"<systemid>";

page 10-1.
Response Syntax Definition

Table 1-11
Response syntax
systemid M System ID
RTRV-SYS: Retrieve System

Use this command to retrieve system wide parameters, to acquire the Network
Element mode (SDH/SONET).
Table 1-12
Field Description
Category System Parameters
Security Level 1
Logged None
Input Syntax RTRV-SYS:[tid]::ctag;

M^^<ctag>^COMPLD
"NEMODE=<nemode>,
<AUMODE>=<aumode>";

page 10-1.

Table 1-13
Response syntax
NEMODE M NE Mode
AUMODE - Network Element mapping

mode.

RTRV-IP: Retrieve IP
Use this command to retrieve the IP address and associated parameters
assigned to the Network Element management interfaces.
Table 1-14
Field Description
Category IP Comms
Security Level 1
Logged None
Input Syntax RTRV-IP:[<tid>]:[<aid>]:<ctag>;

M^^<ctag>^COMPLD
"<aid>::IPADDR=<ipaddr>,
BCASTADDR=<bcastaddr>,
NETMASK=<netmask>,
DEFTTL=<defttl>,
HOSTONLY=<hostonly>,
NONROUTING =<nonrouting>"

page 10-1.
Syntax Definition
Table 1-15
Response syntax
aid M Network Element

management interface
Access Identifier.
IPADDR M IP address for interface

specified by aid
BCASTADDR M Broadcast IP address for

interface specified by aid.
NETMASK M interface specified by aid.
DEFTTL M Default Time To Live

(hops).
HOSTONLY M Host only mode
NONROUTING M Non-routing mode
ED-DAT:Edit NE Date & Time

Use this command in conjunction with the SET-TOD-SER, ED-TOD-MODE.
TL1 commands to synchronize the Network Element time with the Network
Element Manager.
Table 1-16
Field Description
Security Level 4
Logged Database Change Event
Input Syntax ED-DAT:[<tid>]::<ctag>::[<date>],

[<time>];

M^^<ctag>^COMPLD

page 10-1.

SET-TOD-SER
This command is used to provision the addresses of the external time servers
used by the Network Element for Time of Day synchronization. At least one
address must be entered.
Table 1-17
Field Description
Category Time Of Day
Security Level 3
Input Syntax SET-TOD-SER:[<tid>]::<ctag>:::SERAD

DRESS1=<seraddress1>,
[SERADDRESS2=<seraddress2>],
[SERADDRESS5=<seraddress5>];

M^^<ctag>^COMPLD

page 10-1.
Syntax Definition
Table 1-18I
Input syntax
SERADDRESS1 M Server address, in form

x.x.x.x.
SERADDRESS2 O Server address, in form

x.x.x.x.

x.x.x.x.

x.x.x.x.

x.x.x.x.
ED-TOD-MODE
Use this command to set the Time of Day synchronization parameters.
Table 1-19
Field Description
Category Time Of Day
Security Level 3
Input Syntax ED-TOD-MODE:[<tid>]::<ctag>:::SYNC

=<sync>, [POLLINGINTERVAL=<polling
interval>];

M^^<ctag>^COMPLD

page 10-1.
Syntax Definition
Table 1-20
Input syntax
SYNC M Switch on/off remote TOD

Sync.
POLLINGINTERVAL O Polling interval.
ALW-MSG-BROADCAST:Allow Message Broadcast

Use this command to allow DBCHG messaging. This command will be used
by the Network Element Manager to enable the automatic reporting of all
database changes messages from the Network Element.
This command also lets you resume reporting of automatic messages that were
previously inhibited by an INH-MSG-BROADCAST command.
Table 1-21
Field Description
Category Alarms
Security Level 1

Table 1-21 (continued)
Field Description
Input Syntax ALW-MSG-BROADCAST:[<tid>]:[<ALL>

]:<ctag>;
where ALL Include ALL autonomous
database change events for all objects
within the Network Element. its attribute
is O.
Response Syntax ^^^<SID>^<DATE>^<TIME> cr lf

M^^<CTAG>^COMPLD

page 10-1.
INH-MSG-BROADCAST:Inhibit Message Broadcast

Use this command to Inhibit DBCHG messaging. This will be used by the
Network Element Manager to disable the automatic reporting of all database
changes messages from the Network Element.
Table 1-22
Field Description
Category Alarms
Security Level 1
Input Syntax INH-MSG-BROADCAST:[<tid>]:[<ALL>]:

<ctag>;
where ALL Include ALL autonomous
is O

M^^<CTAG>^COMPLD

page 10-1.
ALW-MSG-ALL: Allow Message All

Use this command to enable reporting of all automatic messages from the
Network Element. This command also lets you resume reporting of automatic
messages that were previously inhibited by an INH-MSG-ALL command.
Table 1-23
Field Description
Category Session Management
Security Level 1
Logged None
Input Syntax ALW-MSG-ALL:[<tid>]:[<aid>]:<ctag>;

where ALL include ALL autonomous
is O.
Response Syntax ^^^SID^<date>^<time>M^^<ctag>^COM

PLD

page 10-1.
RTRV-COND-ALL: Retrieve Conditions All

Use this command to retrieve the current conditions (alarm or status) from the
specified Network Element.
Note: The RTRV-COND-ALL command does not retrieve performance

monitored threshold crossings. To display performance monitored
information use the RTRV-PM command. To display environmental alarms
use the RTRV-ALM-ENV command. This command will not retrieve
cleared alarms. To retrieve cleared alarms refer to the RTRV-AO command.

Table 1-24
Field Description
Category Alarms
Security Level 1
Logged None
Input Syntax RTRV-COND-ALL:[<tid>]:[<aid>]:<ctag>

:::[ALRMSTAT=<alrmstat>],
[ALRMSEVER=<alrmsever>];

M^^<CTAG>^COMPLD
^^^"[AID][,<AIDTYPE>]:<NTFCNCDE>,
<TYPEREP>,<SRVEFF>,<OCRDAT>,<
OCRTM>,[LOCN],[DIRN],[TMPER],<CO
NDDESCR>:YEAR=<YEAR>,DGNTYP
E=<DGNTYPE>";

page 10-1.
Syntax Definition
Table 1-25
Input syntax
Parameter Attribute Description
aid O ALL objects, All

components on a shelf.
ALRMSTAT O Alarm status: Controls

whether to retrieve only
enabled alarms, only
disabled alarms, or both
enabled and disabled
alarms.
ALRMSEVER O Alarm severity. Controls

whether to retrieve critical,
major, minor or all enabled
alarms.

Table 1-26
Response syntax
AID O aid
AIDTYPE O aidtype
NTFCNCDE M Notification code for the

message.
TYPEREP M Condition type for an alarm

or a reported event.
GR-833-CORE Appendix
C stipulates 20 characters
max.
SRVEFF M The effect on service

caused by the standing or
alarm condition.
OCRDAT M The date when the alarm

occurred
OCRTM M The time when the alarm

occurred
LOCN O The location associated

with a particular command.
DIRN O The direction of the alarm

condition and is relative to
the entity identified by the
AID.
TMPER O Time Period
CONDDESCR M Condition description

giving a textual outline of
the event.
YEAR M A four character string

used to represent the
alarm occurrence year.
DGNTYPE M An identifier which is used

to provide the following
definitions for Preside: 6
digit unique Alarm Id, 4
digit M3100. Probable
cause, 4 digit
documentation index.

RTRV-ALM-ENV:Retrieve Environment Alarm

Use this command to retrieve the current environmental alarms from the
specified entity or entities.
Note: Environment alarms do not relay information about equipment

faults but about problems with physical premises.
Table 1-27
Field Description
Category Environmental Alarms
Security Level 1
Logged None
Input Syntax RTRV-ALM-ENV:[tid]::ctag;
Response Syntax ^^^<SID>^<DATE>^<TIME> cr lf

M^^<CTAG>^COMPLD cr lf
"<aid>:<ntfcncde>, <almtype>, <ocrdat>,
<ocrtm>, <almmsg>:YEAR=<year>,
DGNTYPE=<dgntype>"

page 10-1.

Table 1-28
Response syntax
aid M AID
ntfcncde M The notification code for

the environmental alarm.
almtype ML The alarm type for the

environmental alarm.
ocrdat M Occurrence Date for the

particular alarm.
ocrtm M Occurrence Time for the

alarm

Response syntax
almmsg M This is the text string (40

chars max) associated
with the environmental
input, assigned by the user
with a SET-ATTRENV
command.
YEAR M A four character string

used to represent the
alarm occurrence year.
DGNTYPE M An identifier which is used

to provide the following
definitions for Preside: 6
digit unique Alarm Id, 4
digit M3100 Probable
cause, 4 digit
documentation index
CANC-USER: Cancel User (Session)

Use this command to log out of an active session with the Network Element
and terminates Network Element TL1 session.
Table 1-29
Field Description
Category Security
Security Level 1
Logged TL1 Log
Input Syntax CANC-USER:[tid]:<uid>:ctag;

where uid is New User Identification. its
attribute is M
Response Syntax Normal response format

No Response, the TL1 Session has been
terminated.

page 10-1.

323-1855-190
2-1
Connection Management 2-
Connection Management
The following section provides the TL1 interface requirements to support the
Nortel Connection Management application.
The connection management application contains the following features:
• End-Points (Requires TL1 interface)

• Connections (Requires TL1 interface)
End-Point TL1 Interface
In order to support the End-Point entity the TL1 interface must provide the
capability to acquire the following information of an Network Element.
• Equipment
– Card Information
• Port Attributes
– NE Port AID’s,
– Traffic Rates
– Configurable port attribute values (e.g. VCAT/LCAS/CCAT etc.).
– Protection characteristics
– Mode

2-2 Connection Management
Table 2-1
TL1 commands for Connection Management.
TL1 command
RTRV-EQPT: Retrieve Equipment
RTRV-OCn (OCn = OC3, OC12, etc):Retrieve OCn
RTRV-E1:Retrieve E1 Facility
RTRV-E3: Retrieve E3 Facility
RTRV-T1: Retrieve Facility data
RTRV-ETH: Retrieve Ethernet Facility
RTRV-WAN: Retrieve WAN Facility
RTRV-FFP-OCn (OCn = OC3, OC12 etc):Retrieve Protection Group
RTRV-SYS: Retrieve system wide parameters
Connection TL1 Interface
RTRV-CRS-ALL: Retrieve Crossconnection all
ENT-CRS-VT1: Enter Crossconnection
ENT-CRS-VT2: Enter Crossconnection-VT2
ENT-CRS-STS1: Enter Crossconnection-STS1
ENT-CRS-STS3C: Enter Crossconnections-STS3C
DLT-CRS-VT1: Delete Crossconnections
DLT-CRS-VT2
DLT-CRS-STS1: Delete Crossconnection STS1
DLT-CRS-STS3C:Delete Crossconnection-STS3C
ED-CRS-VT1:Edit Crossconnection-VT1
ED-CRS-VT2: Edit Crossconnection-VT2
ED-CRS-STS1: Edit Crossconnection-STS1
ED-CRS-STS3C: Edit Crossconnection-STS3C
RTRV-STSn(STSn = STS1, STS3C, STS12c)
End-Point TL1 Interface

RTRV-EQPT: Retrieve Equipment
Use this command to retrieve the data parameters and state parameters for
provisioned equipment. If the equipment is not present, when this command is
issued, it identifies only what is provisioned and does not identify which
equipment is actually present or missing.
If the equipment is present when the command is issued, it returns what is

provisioned and in addition returns information retrieved from the actual
equipment.
Table 2-2
Field Description
Category Equipment
Security Level 1
Logged None
Input Syntax RTRV-EQPT:[tid]:<aid>:ctag;

M^^<ctag>^COMPLD
^^^"<AID-CARD>::
PEC=<pec>, CLEI=<clei>,
SER=<ser>";

page 10-1.

Table 2-3
Response syntax
PEC O Actual PEC Code.
CLEI O CLEI
SER O Serial Number


Use this command to acquire the AID’s of “ALL” OC3/OC12… facilities
(both enabled & disabled) on the Network Element.
Table 2-4
Field Description
Category Facility
Security Level 1
Logged None
Input Syntax RTRV-OCn:[tid]:<aid>:ctag;

M^^<ctag>^COMPLD
<aid>::PORTMODE=<portmode>";

page 10-1.

Table 2-5
Response syntax
aid M aid
PORTMODE M Optical Port market

preference
RTRV-E1:Retrieve E1 Facility
Use this command to view the attributes of an E1 facility.
Table 2-6
Field Description
Category Facility
Security Level 3
Logged None
Field Description
Category Facility
Input Syntax RTRV-E1:[<tid>]:<aid>:ctag;

M^^<ctag>^COMPLD
"<aid>";

page 10-1.

Table 2-7
Response syntax
aid M aid
RTRV-E3: Retrieve E3 Facility

Use this command to acquire the AID’s of any E3 facilities (both enabled &
disabled) on the Network Element.
Table 2-8
Field Description
Category Facility
Security Level 3
Logged None
Input Syntax RTRV-E3:[<tid>]:<aid>:ctag;

M^^<ctag>^COMPLD
"<aid>";

page 10-1.


Use this command to acquire the AID’s of any T1 facilities (both enabled &
Table 2-9
Field Description
Category Facility
Security Level 3
Logged None
Input Syntax RTRV-T1:[<tid>]:<aid>:ctag;

M^^<ctag>^COMPLD"<aid>";

page 10-1.

Table 2-10
Response syntax
aid M aid

Use this command to acquire the AID’s of any DS3 facilities (both enabled &
Table 2-11
Field Description
Category Facility
Security Level 3
Logged None
Input Syntax RTRV-T3:[<tid>]:<aid>:ctag;


page 10-1.

Table 2-12
Response syntax
aid M aid
RTRV-ETH: Retrieve Ethernet Facility

Use this command to acquire the AID's of "ALL" ETH facilities (both enabled
& disabled) on the Network Element.
Table 2-13
Field Description
Category Facility
Security Level 1
Logged None
Input Syntax RTRV-ETH:[<tid>]:<aid>:ctag;


page 10-1.

Table 2-14
Response syntax
aid M aid

RTRV-WAN: Retrieve WAN Facility

Use this command to acquire the AID’s of “ALL” WAN facilities (both
enabled & disabled) on the NE.
Table 2-15
Field Description
Category Facility
Security Level 1
Logged None
Input Syntax RTRV-WAN:[<tid>]:<aid>:ctag;

M^^<ctag>^COMPLD
"<aid>::aid>::MAPPING=<mapping>,
RATE=<rate>,VCAT=<vcat>,
LCAS=<lcas>,
SD_ENABLE=<SD_enable>"

page 10-1.

Table 2-16
Response syntax
aid M aid
MAPPING M Packet mapping into

SONET/SDH.
RATE M SONET/SDH Basic rate

(derived from
SONET/SDH
cross-connections).
VCAT ML SONET/SDH
concatenation
LCAS M Link Capacity Adjustment

Scheme
RTRV-FFP-OCn (OCn = OC3, OC12 etc):Retrieve Protection Group

Use this command to retrieve provisioning information related to a particular
protection group.
Note: The "protaid" parameter is optional when "wrkgaid" is rr-ALL, and

is mandatory otherwise.
Table 2-17
Field Description
Category Protection Switching
Security Level 1
Logged None
Input Syntax RTRV-FFP-OCn:[<tid>]::ctag;

M^^<ctag>^COMPLD
"<wrkgaid>,<protaid>:: PS=<ps>"

page 10-1

Table 2-18
Response syntax
wrkgaid M working aid
protaid M protection aid
PS M Protection Scheme.

RTRV-SYS: Retrieve system wide parameters

Use this command to retrieve the Network Element’s mode(SDH/SONET).
Table 2-19
Field Description
Category System parameters
Security Level 1
Logged None
Input Syntax RTRV-SYS:[<tid>]::ctag;

M^^<ctag>^COMPLD
"NEMODE=<nemode>,<AUMODE>=<a
umode>"

page 10-1.
RTRV-CRS-ALL: Retrieve Crossconnection all

Use this command to retrieve all connections from the Network Element.
Table 2-20
Field Description
Category Connection Management
Security Level 1
Logged None
Input Syntax RTRV-CRS-ALL:[tid]:<aid>:ctag;
Normal Response Syntax ^^^SID^DATE^TIME

M^^<ctag>^COMPLD
"<fromaid>,
<toaid>:[<cct>]:[SWMATE=<swmate>],[
TOMATE=<tomate>],[CKTID=<cktid>],<
rate>"

page 10-1.

Table 2-21
Response syntax
fromaid M ALL objects.
toaid M ALL objects.
cct O Cross-Connect Type:

Used for specifying one or
two way connections
SWMATE O Path Protection Switch

Mate. Specifies the switch
mate path endpoint used
as the protection input
signal for the fromaid. This
parameter is provided at
the destination end node.
CKTID O Circuit Identifier - can be

used to hold the CLCI(see
GR-199) 40 characters
max.
rate M Connection Rate
ENT-CRS-VT1: Enter Crossconnection

Use this command to create VT1 connections.
Table 2-22
Field Description
Security Level 3
Input Syntax ENT-CRS-VT1:[tid]:<fromaid>,<toaid>:ct

ag::[<cct>]::[CKTID=<cktid>],
[SWMATE=<swmate>],[TOMATE=<tom
ate>],[AEND=<aend>],[ZEND=<zend>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-23
Input syntax
fromaid M VT Payloads, VT1 Payload

on DSM, VT1 default
Payload on DSM, VT1
Payload on L2SS card,
VT2 Payload on L2SS
card, VT1 Payload on
TMUX card
toaid M VT Payloads, VT1 Payload

on DSM, VT1 default
Payload on DSM, VT1
VT2 Payload on L2SS
TMUX card

two way connections


used to hold the CLCI (see
GR-199). 40 characters
max.
AEND O APS ID of AID originating

node for BLSR systems.
ZEND O APS ID of AID terminating

ENT-CRS-VT2: Enter Crossconnection-VT2

Use this command to create VT2 connections.
Table 2-24
Field Description
Security Level 3
Input Syntax ENT-CRS-VT2:[tid]:<fromaid>,<toaid>:ct

ag::[<cct>]:: [CKTID=<cktid>],

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-25
Input syntax
fromaid M VT Payloads, VT1 Payload

on DSM, VT1 default
Payload on DSM, VT1
VT2 Payload on L2SS
TMUX card.
toaid M VT Payloads, VT1 Payload

on DSM, VT1 default
Payload on DSM, VT1
VT2 Payload on L2SS
TMUX card.

two way connections.

max.

TOMATE O Specifies the 1+1 switch

signal for the toaid. This


ENT-CRS-STS1: Enter Crossconnection-STS1

Use this command to create STS1 connections.
Table 2-26
Field Description
Security Level 3
Input Syntax ENT-CRS-STS1:[tid]:<fromaid>,<toaid>:

ctag::[<cct>]::[CKTID=<cktid>],
ate>],[AEND=<aend>], [ZEND=<zend>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-27
Input syntax
fromaid M STS1 Payload, STS1

Payload on EC1, STS1
Payload on DS3/E3,
AU4-mapped STS1
Payload, STS1 Payload on
L2SS card, STS1 Payload
on TMUX card.
toaid M STS1 Payload, STS1

Payload on DS3/E3,
AU4-mapped STS1
on TMUX card.



max.

An integer between 0 and
15.

15.
ENT-CRS-STS3C: Enter Crossconnections-STS3C

Use this command to create STS3C connections.
Table 2-28
Field Description
Security Level 3
Input Syntax ENT-CRS-STS3C:[tid]:<fromaid>,<toaid

>:ctag::[<cct>]::[CKTID=<cktid>],

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-29
Input Syntax
fromaid M STS3C Payload, STS3

STS3C Payload on L2RPR
card.
toaid M STS3C Payload, STS3

STS3C Payload on
L2RPR card.



max.

15.

15.
DLT-CRS-VT1: Delete Crossconnections

Use this command to delete VT1 connections.
Table 2-30
Field Description
Security Level 3
Input Syntax DLT-CRS-VT1:[tid]:<fromaid>,<toaid>:ct

ag::[<cct>]:[SWMATE=<swmate>],
[TOMATE=<tomate>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-31
Input Syntax
fromaid M VT1 Payloads on OCn

EC1, AU4-mapped VT1
Payload, VT2 Payloads on
OCn card, AU4-mapped
VT2 Payload, VT2
Payload (E1 equipment),
VT1 Payload on DSM, VT1
default Payload on DSM,
VT1 Payload on L2SS
L2SS card, VT1 Payload
on TMUX card.
toaid M VT1 Payloads on OCn

EC1, AU4-mapped VT1
Payload, VT2 Payloads on
OCn card, AU4-mapped
VT2 Payload, VT2
Payload (E1 equipment),
VT1 Payload on DSM, VT1
default Payload on DSM,
VT1 Payload on L2SS
L2SS card, VT1 Payload
on TMUX card.


Mate.
DLT-CRS-VT2
Use this command to delete VT2 connections.
Table 2-32
Field Description
Security Level 3
Input Syntax DLT-CRS-VT2:[tid]:<fromaid>,<toaid>:ct

ag::[<cct>]:[SWMATE=<swmate>],
[TOMATE=<tomate>];

M^^<ctag>^COMPLD

page 10-1.
DLT-CRS-STS1: Delete Crossconnection STS1

Use this command to delete STS1 connections.
Table 2-33
Field Description
Security Level 3
Input Syntax DLT-CRS-STS1:[tid]:<fromaid>,<toaid>:

ctag::[<cct>]:[SWMATE=<swmate>],
[TOMATE=<tomate>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-34
Input Syntax

Payload on DS3/E3,
AU4-mapped STS1
on TMUX card.

Payload on DS3/E3,
AU4-mapped STS1
on TMUX card


DLT-CRS-STS3C:Delete Crossconnection-STS3C
Use this command to delete STS3C connections.
Table 2-35
Field Description
Security Level 3
Input Syntax DLT-CRS-STS3C:[tid]:<fromaid>,<toaid

>:ctag::[<cct>]:[SWMATE=<swmate>],
[TOMATE=<tomate>];

M^^<ctag>^COMPLD

page 10-1.
ED-CRS-VT1:Edit Crossconnection-VT1
Use this command to modify the CKTID attribute of a provisioned connection.
Table 2-36
Field Description
Security Level 3
Input Syntax ED-CRS-VT1:[tid]:<aid>:ctag:::[CKTID

=<cktid>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-37
Input syntax
CKTID O Circuit Identifier - can be used to

hold the CLCI (see GR-199). 40
characters max.
ED-CRS-VT2: Edit Crossconnection-VT2

Syntax Definition
Table 2-38
Field Description
Security Level 3
Input Syntax ED-CRS-VT2:[tid]:<aid>:ctag:::[CKTID

=<cktid>];

M^^<ctag>^COMPLD

page 10-1.
Table 2-39
Input syntax

max.
ED-CRS-STS1: Edit Crossconnection-STS1

Table 2-40
Field Description
Security Level 3
Input Syntax ED-CRS-STS1:

[<tid>]:<fromaid>,<toaid>:<ctag>::[<cct>
]:[CKTID=<cktid>],[SWMATE=<swmate
>],[TOMATE=<tomate>],[AEND=<aend>
], [ZEND=<zend>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-41
Input syntax

Payload on DS3/E3,
AU4-mapped STS1
on TMUX card.

Payload on DS3/E3,
AU4-mapped STS1
on TMUX card.


TOMATE O Specifies the 1+1 switch

signal for the toaid. This

Input syntax

max.

15.Enter ZEND as well if
this field is included in TL1.

15.Enter AEND as well if
this field is included in TL1.
ED-CRS-STS3C: Edit Crossconnection-STS3C

Table 2-42
Field Description
Security Level 3
Input Syntax ED-CRS-STS3C:[tid]:<aid>:ctag:::[CKTI

D =<cktid>];

M^^<ctag>^COMPLD

page 10-1.

Syntax Definition
Table 2-43
Input syntax

max.
RTRV-STSn(STSn = STS1, STS3C, STS12c)

Use this command to acquire the AID's of "ALL" STSn (STS1, STS3C,
STS12c) path facilities (both enabled & disabled) on the Network Element.
Table 2-44
Field Description
Category -
Security Level -
Logged -
Input Syntax RTRV-STSn:[<tid>]:<aid>:<ctag>:::[STI

NFO=<stinfo>],[SSBITINFO=<ssbitinfo>
];

M^^<ctag>^COMPLD
"<aid>::TMGREF=<tmgref>,
DCC=<dcc>, SDTH=<sdth>,
[STFORMAT=<stformat>],
[STRC=<strc>], [EXPSTRC=<expstrc>],
[STFMODE=<stfmode>],
REMOTE=<remote>,
[SSBITMDE=<ssbitmde>],
[TERM=<term>], ALS=<als>,
EBERTH=<eberth>,
PTHRDIAISINSERT=<pthrdiaisinsert>,
PORTMODE=<portmode>:<pst>, <sst>"

page 10-1.
323-1855-190
3-1
Performance Monitoring 3-
Table 3-1 lists the commands supported for Performance Monitoring.

Table 3-1
TL1 commands for Performance Monitoring
TL1 command
RTRV-PM-ALL: Retrieve Current/Previous Counts All
Performance Monitoring- AID type all

The Network Element must adhere to the following Performance Monitoring
Binning requirements:
• Support 1 Current 15 minute bin.

• Provide 32 Previous 15 minute bins (time-stamped - no zero suppression)
• Provide 1 Current Day bin
• Provide 1 Previous Day bin (time-stamped - no zero suppression)
• Provide 1 Untimed Bin (time-stamped).
All bin counters must be independently incremented. (No relationship between
binned counts).
Performance Monitoring - AID Type ALL

The OME6130 Performance Monitoring TL1 interface must support the
"ALL" wildcarding capability.
"ALL": All Performance Monitoring facility types supported by the Network

Element.

3-2 Performance Monitoring
RTRV-PM-ALL: Retrieve Current/Previous Counts All

Use this command to retrieve the current and historical performance data.
Table 3-2
Field Description
Category System parameters
Security Level 1
Logged None
Input Syntax RTRV-PM-ALL:[<tid>]:<aid>:<ctag>::[<

montype>], [<monlev>], [<locn>],
[<dirn>], [<tmper>], [<mondat>],
[<montm>], [<index>];

M^^<ctag>^COMPLD
"<aid>, [<aidtype>]:<montype>,
<monval>, [<vldty>], <locn>, <dirn>,
<tmper>, <mondat>, <montm>,
[<index>]"

page 10-1.

Table 3-3
Response syntax
aidtype O AID type
monval M Discriminating Level for

requested monitored
parameter.
vldty O Validity indicator for

historical monitoring
information. It indicates
whether the information for
the specified time period
was accumulated over the
entire time period or some
portion of it.
323-1855-190
Network Backup and Restore 4-
Table 4-1 lists the commands supported for Network Backup and Restore.
Table 4-1
TL1 commands for Network Backup and Restore
TL1 command
SAV-PROV: Save Provisioning
RST-PROV: Restore provisioning
CMMT-PROV: Commit provisioning
The following section provides a specification for the TL1 interface required
to support the Nortel Backup & Restore application.
SAV-PROV: Save Provisioning

Use this command to save the Network Element configuration files to a server
located at the specified URL.
Table 4-2
Field Description
Category Backup and Restore
Security Level 3
Logged TL1 Log
Input Syntax SAV-PROV:[tid]::ctag:::URL=<url>

="ftp://uid:pid@hostip/directorypath",[CH
KALM=<chkalm>];

M^^<ctag>^COMPLD

page 10-1.

4-2 Network Backup and Restore
Syntax Definition
Table 4-3
Input syntax
URL M URL
CHKALM O Check alarm status
RST-PROV: Restore provisioning

Use this command to restore provisioning data (including that backed-up from
circuit packs) to an Network Element. The RST-PROV command does some
basic checks on the integrity of the restored data, and compares the software
release listed in the backup data with the current software release running on
the Network Element. If they are not the same, the restoration fails. If
CHKTID=Y or CHKTID is omitted, the RST-PROV command compares the
TID of the Network Element to which provisioning data is being restored with
the stored TID. If they are not the same, the restoration fails.
Table 4-4
Field Description
Security Level 3
Input Syntax RST-PROV:[<tid>]::<ctag>:::URL=<url>,

[CHKTID=<chktid>],

M^^<ctag>^COMPLD

page 10-1.
Network Backup and Restore 4-3
Input Syntax Definition

Table 4-5
Input syntax
URL M URL
CHKTID O Check TID
CMMT-PROV: Commit provisioning

Use this command to commit the files which have been restored to a Network
Element by the RST-PROV command. The CMMT-PROV command checks
for any outstanding reasons not to commit the data at this time. If there are no
reasons, it will commit the data and cause a special reset. It will also clear the
Database Restore in Progress alarm.
Table 4-6
Field Description
Security Level 3
Input Syntax CMMT-PROV:[<tid>]::<ctag>;

M^^<ctag>^COMPLD

page 10-1.

4-4 Network Backup and Restore
323-1855-190
5-1
Network Load Management 5-
Table 5-1 lists the commands supported for Network Load Management.
Table 5-1
TL1 commands for Network Load Management
TL1 command
CANC-RELEASE: Cancel Release
CANC-UPGRD: Cancel Upgrade
CHK-RELEASE: Check Release
CHK-UPGRD: Check Upgrade
CMMT-UPGRD: Commit Upgrade
DLT-RELEASE: Delete Release
DLVR-RELEASE: Deliver Release
INVK-UPGRD: Invoke Upgrade
LOAD-UPGRD: Load Upgrade
RTRV-RELEASE: Retrieve Release
RTRV-SPACE: Retrieve Space
RTRV-UPGRD-STATE: Retrieve Upgrade State

5-2 Network Load Management
The following section provides a specification for the TL1 interface required
to support the Nortel Load Management application.

Use this command to cancel a DLVR-RELEASE in progress, or following a
failed DLVR-RELEASE
Note: To remove a successfully delivered release, the DLT-RELEASE

command must be used instead.
In addition it cleans-up any image files left in an invalid state by the

DLVR-RELEASE, disconnects any file transfer connections left behind by the
DLVR-RELEASE, clears any in progress alarms raised by the
DLVR-RELEASE, and cancels the failure state that may exist. If the active
release is being re-delivered, this command will not delete it from the local
file-system.
Table 5-2
Field Description
Category Load Management
Security Level 3
Input Syntax CANC-RELEASE:[tid]::ctag

M^^<ctag>^COMPLD

page 10-1.
CANC-UPGRD: Cancel Upgrade

Use this command to back out of an upgrade if a CMMT-UPGRD command
has not already been issued.
Table 5-3
Field Description
Security Level 3
Field Description
Input Syntax CANC-UPGRD:[tid]::ctag

M^^<ctag>^COMPLD

page 10-1.

Use this command to verify that the remote server can be reached.
Table 5-4
Field Description
Security Level 3
Logged TL1 Log
Input Syntax CHK-RELEASE:[tid]::ctag:::URL=<url>

="ftp://uid:pid@hostip/directorypath",[CH
KTID=<chktid>];

M^^<ctag>^COMPLD

page 10-1.
Syntax Definition
Table 5-5
Input syntax
aid O SHELF
URL M Address of server which

stores loads.

CHK-UPGRD: Check Upgrade

Use this command to perform a health check on the Network Element before
running an upgrade. CHK-UPGRD allows the person at the Element
Management System (EMS) level to know if the Network Element is healthy
enough to do an upgrade.
Table 5-6
Field Description
Security Level 3
Logged TL1 Log
Input Syntax CHK-UPGRD:[tid]::ctag:::relNo=<relNo>

M^^<ctag>^COMPLD

page 10-1.
Syntax Definition
Table 5-7
Input syntax
relno M ASCII string identifying the

release number. Must be
unique and fully specified -
wildcarding is not allowed.
CMMT-UPGRD: Commit Upgrade

Use this command to make the new load on the SC to become the permanent
load.
Table 5-8
Field Description
Security Level 3
Field Description
Input Syntax CMMT-UPGRD:[<tid>]::<ctag>;

M^^<ctag>^COMPLD

page 10-1.
DLT-RELEASE: Delete Release

Use this command to delete a release of a software load stored on the SP.
Table 5-9
Field Description
Security Level 3
Input Syntax DLT-RELEASE:[tid]::ctag:::relNo=<relNo

>

M^^<ctag>^COMPLD

page 10-1.
DLVR-RELEASE: Deliver Release

Use this command to fetch a software load from the remote server specified in
the URL into the Network Element's local file system, without upgrading to it.
Table 5-10
Field Description
Security Level 3

Field Description
Input Syntax DLVR-RELEASE:[tid]::ctag:::URL=<url>,

[CHKTID=<chktid>];

M^^<ctag>^COMPLD

page 10-1.

Use this command to make the new shelf processor load to begin execution.
Table 5-11
Field Description
Security Level 3
Input Syntax INVK-UPGRD:[tid]::ctag:::[AUTOMATIC

=<domain>];

M^^<ctag>^COMPLD

page 10-1.

Use this command to make the new SP and transport loads to be downloaded
into the shelf processor file system. The new transport load is transferred from
the shelf processor to each transport card in the Network Element.
Table 5-12
Field Description
Security Level 3
Input Syntax LOAD-UPGRD:[tid]::ctag:::relNo=<relNo

>;

M^^<ctag>^COMPLD

page 10-1.
Syntax Definition
Table 5-13
Input syntax
aid O SHELF
relno M ASCII string identifying the

release number to
activate. Must be unique
and fully specified -
wildcarding is not allowed.
RTRV-RELEASE: Retrieve Release

Use this command to acquire the Network Element software release number.
Table 5-14
Field Description
Security Level 1
Logged None

Field Description
Input Syntax RTRV-RELEASE:[tid]::ctag:::[CHKTID=<

chktid>];

M^^<ctag>^COMPLD
"<relno>, <date>"

page 10-1.
RTRV-SPACE: Retrieve Space

Use this command to retrieve the available file system space to make sure there
is enough space before putting a new release in the file system.
Table 5-15
Field Description
Security Level 1
Logged None
Input Syntax RTRV-SPACE:[tid]::ctag

M^^<ctag>^COMPLD
"<x bytes available>, <FREEBYTES>"

page 10-1.
RTRV-UPGRD-STATE: Retrieve Upgrade State

Use this command to retrieve the progress of the software load installation
from the Network Element to the newly installed shelf processor.
Table 5-16
Field Description
Security Level 1
Logged None
Field Description
Input Syntax RTRV-UPGRD-STATE:[tid]::ctag

M^^<ctag>^COMPLD
":<UPGRDSTAGE>,
[<UPGRDRSLT>]:RELEASE=<release>
,[UPGRADING_FROM=<upgrading_fro
m>],[UPGRADING_TO=<upgrading_to>
], [DELIVERING_TO=<delivering_to>]"

page 10-1.

Table 5-17
Response syntax
aid O Equipment being

upgraded.
UPGRDSTAGE M Upgrade Stage.
UPGRDRSLT O Result
RELEASE O Release currently running

on NE
UPGRADING_FROM O Release being upgraded

from
UPGRADING_TO O Release being upgraded to
DELIVERING_TO O Release being delivered
SAVING_RELEASE O Release being saved

323-1855-190
6-1
Topology Adjacency 6-
Table 6-1 lists the commands supported for Topology Adjacency.

Table 6-1
TL1 commands for Topology adjacency
TL1 command
RTRV-AD-ALL: Retrieve auto discovery
Topology Adjacency TL1 Interface

The following section provides the TL1 interface requirements to support the
Nortel Topology Adjacency application.
RTRV-AD-ALL: Retrieve auto discovery

Use this command to retrieve Topology Adjacency information from an
Network Element.
Table 6-2
Field Description
Category Network Topology
Security Level 1
Logged None

6-2 Topology Adjacency
Input Syntax RTRV-AD-ALL:[tid]:<aid>:ctag;

M^^<ctag>^COMPLD
^^^"<aid>:
AIDFORMAT=<aidformat>,LAYER=<lay
er>,ENABLED=<enabled>,MECHANIS
M=<mechanism>,TYPE=<type>,TX_VE
RSION=<tx_version>,
TX_SIGNATURE=<tx_signature>,
RX_VERSION=<rx_version>,
RX_ACTUAL=<rx_actual>,
RX_EXPECTED=<rx_expected>,
RX_RELIABILITY=<rx_reliability>,RX_T
ERMINATED=<rx_terminated>,
RX_ACCEPTED=<accepted>"

page 10-1.
323-1855-190
7-1
Equipment 7-
Table 7-1 lists the commands supported for Equipment.

Table 7-1
TL1 commands for Equipment
TL1 command
RTRV-INVENTORY
INIT-WARM
INIT-COLD
RTRV-INVENTORY
Use this command to identify what type of circuit packs resides in which slots.
The command will return a list of physical inventory (circuit packs, SFPs,
backplane, FAN, power units etc.). Element management application will
require the Network Element TL1 interface to autonomously report insertion
or removal of any inventory item.
Table 7-2
Field Description
Category Equipment
Security Level 1
Logged None

7-2 Equipment
Field Description
Input Syntax RTRV-INVENTORY:[tid]:<aid>:ctag;

"<aid>::PEC=<pec>, CLEI=<clei>,
SER=<ser>”

M^^<ctag>^COMPLD
^^^"<aid>::CTYPE=<ctype>,
[SNMPINDEX=<snmpindex>],
PEC=<pec>, REL=<rel>, CLEI=<clei>,
SER=<ser>, MDAT=<mdat>,
AGE=<age>,
ONSC=<onsc>,[DSMMATE=<dsmmate
>], [DSMCONN=<dsmconn>]"

page 10-1.
Table 7-3
Response syntax
aid M AID
CTYPE M Card Type
SNMPINDEX O Identifies the index of the

equivalent entity instance
in the SNMP entity
Physical MIB group
PEC M Actual PEC Code
REL M Release Level
CLEI M CLEI
SER M Serial Number
MDAT M Date of Manufacture, in the

format: year-week of year
(YYYY-WW).
Equipment 7-3

Response syntax
AGE M Age, cumulative in-service

time elapsed since
manufacture, in the format:
years-days-hours-minutes
(YY-DDD-HH-MM).
ONSC M On since, cumulative time

since the unit was last
inserted, in the format:
years-days-hours-minutes
(YY-DDD-HH-MM).
DSMMATE O Serial Number of MATE

DSM
DSMCONN O DSM Connection
INIT-WARM
Use this command to instruct a Network Element to initialize its circuit packs.
A warm initialization does not affect traffic.
Table 7-4
Field Description
Category Equipment
Security Level 3
Logged TL1 Log
Input Syntax INIT-WARM:[tid]:<slot>:ctag;

M^^<ctag>^COMPLD

page 10-1.

7-4 Equipment
INIT-COLD
Use this command to instruct a Network Element to initialize its circuit packs.
A cold initialization is equivalent to a power-up and will affect traffic.
Table 7-5
Field Description
Category Equipment
Security Level 3
Logged TL1 Log
Input Syntax INIT-COLD:[tid]:<slot>:ctag;

M^^<ctag>^COMPLD

page 10-1.
323-1855-190
8-1
Security 8-
Table 8-1 lists the commands supported for Security.

Table 8-1
TL1 commands for Security
TL1 command
ENT-SECU-USER: Enter security user
DLT-SECU-USER: Delete Security User
ED-SECU-USER: Edit Security User
ENT-SECU-USER: Enter security user

Use this command to create a new user account on a Network Element and
enter the security parameters associated with the account.
Table 8-2
Field Description
Category security
Security Level 4
Input Syntax ENT-SECU-USER:[tid]:<newuid>:ctag::

<newpid>,<newpidConfirm>:
<USERTYPE=Domain>;

M^^<ctag>^COMPLD

page 10-1.

8-2 Security
Input syntax Definition

Table 8-3
Input syntax
newuid M New User Identification
newpid M The user's new password.
newpid_confirmed M The user's new password -

entered twice for
confirmation.
USERTYPE O User account type. 0 =

local, 1 = network
DLT-SECU-USER: Delete Security User

Use this command to delete a User Account.
Table 8-4
Field Description
Category Security
Security Level 3
Input Syntax DLT-SECU-USER:[tid]:<uid>:ctag;

M^^<ctag>^COMPLD

page 10-1.
Security 8-3
ED-SECU-USER: Edit Security User

Use this command to provision a new User Account.
Table 8-5
Field Description
Category Security
Security Level 3
Input Syntax ED-SECU-USER:[tid]:<uid>:ctag::[newp

asswd],[newpasswdConfirm]:
[USERTYPE=Domain];

M^^<ctag>^COMPLD

page 10-1.
Input syntax Definition

Table 8-6
Input syntax
uid M New User Identification
newpid O The user's new password.
USERTYPE O User account type. 0 =

local, 1 = network.

8-4 Security
323-1855-190
9-1
Appendix - Common TL1 Parameter 9-
Table 9-1 lists the commands supported for common parameters.

Table 9-1
TL1 commands for common parameters
TL1 command
TID
CTAG
DATE
TIME
UID
SID
PID
UPC
SWVERSION
OCRDAT
OCRDAT
SRVEFF
CONDDESCR
YEAR
DGNTYPE
AEND
ZEND
SERADDRESS[1-5]
SYNC
POLLINGINTERVAL

9-2 Appendix - Common TL1 Parameter

TL1 command
CKTID
CCT
AID-OCn
AID-CARD
AID-E1
AID-E3
AID-DS3
AID-DS3
TERM
AID-ETH
TXCON
AID-WAN
MAPPING
RATE
VCAT
LCAS
SEQTYPE
ATAGSEQ
DBCHGSEQ
MONTYPE
MONLEV
LOCN
DIRN
MONVAL
TMPER
MONDAT
MONTM
INDEX

TL1 command
URL
URL
CHKALM
CHKTID
RELNO
ALRMS
XBYTESAVAILABLE
FREEBYTES
UPGRDSTAGE
UPGRDRSLT
SER
PEC
CMDCODE
AID1
AID2
COMMON_BLOCK
SPECIFIC_BLOCK
STATE_BLOCK
STATE_BLOCK
STATUS
AID (PORT)
AIDFORMAT
LAYER
ENABLED
MECHANISM
TX_VERSION
TX_SIGNATURE
TYPE


TL1 command
RX_VERSION
RX_ACTUAL
RX_EXPECTED
RX_RELIABILITY
RX_TERMINATED
RX_ACCEPTED
CLEI
NEWUID
NEWPID
USERTYPE
TID
Behavioral notes:
With the exception of the use of the RTRV-HDR command, omission of the
TID assumes that the user is trying to access the Network Element via a
CRAFT session. TID must be optional for RTRV-HDR as it is used to find the
TID of an Network Element(OMEA must know the IP address and port of the
Network Element before it can use RTRV-HDR to find the TID). The SID of
the response is the TID of the Network Element, where TID is omitted the
response will be an error response but the response header will contain the
SID.
Table 9-2
Attribute Nortel Requirement
Parameter TID
Full parameter name Target identifier
Description Identifies the NE targeted by the

command
Type String
Length Max 20 char if not enclosed in quotes, if

in quotes, allowed 20 char + 2 chars for
the quotes.
Format 1) If unquoted, the SID must be between

1 and 20 alphanumeric characters. The
first character must be a letter (lowercase
letters are changed to uppercase letters)
or digit. The remaining characters can be
any combination of letters, numbers, or
dashes (-).
2) Enclose the SID in double quotes (") to
include any combination of upper and
lower case letters, numbers, or special
characters. The string, enclosed by the
double-quotes, cannot include the
following characters: backslash (\),
space, double-quote ("), colon (:),
semicolon (;), ampersand (&), greater
than (>), less than (<), hash (#), comma
(,), and any control characters (like new
lines and tabs). The total number of
characters inside the quotes must be
between 1 and 20
Values (if pre-defined) Not applicable
Consumer & use NE - Used to route the command to the

target NE
CTAG
Behavioral notes: CTAG is intended to be unique per command per OS session
but is not mandated.
Table 9-3
Parameter CTAG
Full parameter name Correlation tag
Description If a number of commands are issued their

responses may not arrive in the same
order as the commands were issued. In
order to correlate command and
response an identifier - the Correlation
Tag is added to each command. The NE
copies the Correlation Tag into its
response. The OS can therefore
correlate input and response.

Type String
Length 6
Format Not Applicable
Example 123456
Consumer & use NE - Used to set the CTAG on the

command response
DATE
Table 9-4
Parameter DATE
Full parameter name date
Description NE real time clock date.
Type Int
Length 8
Format YY-MM-DD.
YY is the last two digits of the year
ranging from 00 to 99,
MM is the month of the year ranging from
01 to 12
DD is the day of the month ranging from
01 to 31.
Example 04-01-21
Consumer & use OMEA Mechanism (Mandatory)Used to

Date stamp a TL1 message/response.
TIME
Table 9-5
Parameter TIME
Full parameter name time
Description NE real time clock time (GMT).
Type Int
Length 8
Format Within TL1 Parameter Block or

autonomous
TL1 Command Response HH:MM:SS
HH is the hour ranging from 00 to 23
MM is the minute ranging from 00 to 59
SS is the second ranging from 00 to 59.
Example 14:45:25
Consumer & use OMEA Mechanism Used to Time stamp a

TL1 message/response.
UID
Table 9-6
Parameter USERID
Full parameter name User identifier
Description A unique identifier for a system user.
Type String
Length Max 10 chars
Format alphanumeric
Example REMOTE
Consumer & use NE - Used to identify an individual system

user.

SID
Table 9-7
Parameter SID
Full parameter name System Identifier
Description SID is the source identification code to be

assigned to the NE. Identifies the NE
generating the response.
Type String
Length Max 20 char if not enclosed in quotes, if

in quotes, allowed 20 char + 2 chars for
the quotes.
Format 1) If unquoted, the SID must be between

1 and 20 alphanumeric characters. The
first character must be a letter (lowercase
letters are changed to uppercase letters)
or digit. The remaining characters can be
any combination of letters, numbers, or
dashes (-).
2) Enclose the SID in double quotes (") to
include any combination of upper and
lower case letters, numbers, or special
characters. The string, enclosed by the
double-quotes, cannot include the
following characters: backslash (\),
space, double-quote ("), colon (:),
semicolon (;), ampersand (&), greater
than (>), less than (<), hash (#), comma
(,), and any control characters (like new
lines and tabs). The total number of
characters inside the quotes must be
between 1 and 20
Consumer & use OMEA Mechanism (Mandatory).Used to

identify the source of an NE TL1
message.
PID
Table 9-8
Parameter PID
Full parameter name Password Identifier
Description The system user's password.
Type String
Length 8 characters
Format Password identifiers (PIDs) must meet

the following:o The PID must be between
8 and 10 characters.o The PID can
include (a - z, A - Z, 0 - 9), and the
following symbols:! " # $ % ` ( ) * + - . / <
= >@[ ] ^ _ ' { | } ~o The PID must contain
at least one alphanumeric character and
one non-alphanumeric character (such
as one of the above symbols or a
number).o The PID cannot contain any of
the following characters: semicolon (;),
colon (:), ampersand (&), comma (,),
spaces (deleted as entered), control
characters, and question mark (?).o The
PID cannot contain the associated user
identifier (UID).o A double quote (")
entered in the PID must be preceded by
a backslash (\). The backslash is
considered as a character in the length of
the password.o Carriage returns
(<Enter>) are ignored.
Example Not applicable
Consumer & use NE - Used by the NE to authenticate a

users request to obtain a TL1 session.

UPC
Table 9-9
Parameter UPC
Full parameter name User Privilege Code
Description Used to determine the access & privilege

level for a given user on an NE.
Type Enum in TL1 Engine,Charuint
Length -
Values (if pre-defined) UPC Values

0 Change Password Only
1 Retrieve Privileges
2 Control Privileges
3 Provisioning Privileges
4 Administration Privileges
5 Span of Control Surveillance
Example 0
Consumer & use NE - Used by the NE to determine the

access & privilege level of a given user
account.
SWVERSION
Table 9-10
Parameter SWVERSION
Full parameter name Software Version
Description Software Version of the Network

Element.
Type String
Length Max 8 chars
Format aabbccdd
aa: Major Release index (Int)
bb: Minor Release index (Int)
ccdd: Not considered by OMEA
(Alphanumeric).
Example 02012501
aabb=0201 is equivalent to R 2.01
aabb=0210 is equivalent to R 2.10
Consumer & use OMEA Mechanism (Mandatory)Used by

the Network Element Management
system to select the appropriate TL1
interface engine.OMEA DMLOMEA
validation used to establish if the NE is in
OMEA's list of valid NE models.
Network Element Software Versioning Rules:
• The Network Element software upgrade process must adhere to the

following rules:
• The Network Element software version must comply with the format
aabbccdd.
• At least one of the software versioning fields must be incremented with any
new build of SW that is delivered to a customer.
• All Network Element software upgrades that result in a modification to the
TL1 interface (syntactical / Behavioral) must in the absence of an
incremental change to a component of the SWVERSION require the bb
element to be incremented.
• The Element Management team will reserve the right to request an
incremental change to the SWVERION reference bb component.

OCRDAT
Table 9-11
Parameter OCRDAT
Full parameter name Occurrence date
Description Date-stamp for the message
Type DATE
Length 5
Format MM-DD
MM is the month of the year ranging from
01 to 12.
DD is the day of the month ranging from
01 to 31.
Values (if pre-defined) Not Applicable
Example 12-25
Consumer & use OMEA DML - Displayed by Preside

Alarm Manager.
OCRTM
Table 9-12
Parameter OCRTM
Full parameter name Occurrence time
Description Time stamp for the occurence of the

event/alarm.
Type TIME
Length 5
Format HH-MM-SS, where HH is the hour of the

day, ranging from 0 to 23.
MM is the minute, ranging from 00 to 59.
SS is the second ranging from 00 to 59.
Example 12-25
Consumer & use OMEA DML - Displayed by Preside Alarm

Manager.
SRVEFF
Table 9-13
Parameter SRVEFF
Full parameter name Service effect
Description Used to indicate whether the resultant

message is service affecting.
Type Enum
Length -
Format Not applicable
Values (if pre-defined) SA - Service Affecting

NSA - Non Service Affecting
Example SA
Consumer & use OMEA DML

Displayed by Preside Alarm Manager.
CONDDESCR
Table 9-14
Parameter CONDDESCR
Full parameter name Condition description(Alarm Text).
Description A description of the condition causing the

message.
Type String
Length -
Format -
Example Loss Of Signal

Displayed by Alarm Manager.

YEAR
Table 9-15
Parameter YEAR
Full parameter name Year
Description The Year the response was issued
Type String
Length 4
Format YYYY
Example 1984
Consumer & use OMEA DML Displayed by Preside Alarm

Manager.
DGNTYPE
Table 9-16
Parameter DGNTYPE
Full parameter name Diagnostic Type
Description An identifier which is used to provide the

following definitions for Preside:
• 6 digit unique Alarm Id,
• 4 digit M3100 Probable Cause,
• 4 digit documentation index.
Type String
Length 16 Chars
Format Refer to Notes
Example 000004-0077-0047

Displayed by Preside Alarm
Manager.Passed to other XDR interfaces
Note: The dgntype is formatted as follows NNNNNN-PPPP-UUUU.
Eg. 000002-0062-0038 where NNNNNN (ALARM-ID) is a number that is

guaranteed to be unique for the time an alarm is set. The clear must have the
same id for the set and clear.
For each item that could be alarmed (e.g. scan point), guarantee to provide a
unique value.
E.g. slot # multiplied by port # multiplied by (alarm index).
PPPP (Probable Cause): is the probable cause.
UUUU (alarm type id): a unique number for the text of the alarm.
AEND
Table 9-17
Parameter AEND
Full parameter name Protection Switch Direction.
Description Not Applicable
Type Not Applicable
Length Not Applicable
Example Not Applicable
Consumer & use Not Required this release

ZEND
Table 9-18
Parameter ZEND
Full parameter name Protection scheme.
Type Not Applicable
SERADDRESS[1-5]
Table 9-19
Parameter NTP Server Address
Full parameter name Server Address
Description This parameter is used to specify the

NTP source server.
Type ipaddr
Length The length field can be changed from 16

to NA, as there is no fixed length that can
be specified for the same.
Format Must be in the standard dot notation,

n.n.n.n
Example 23.23.24.29
Consumer & use Mandatory - SERADDRESS1 must have

an entry.
SYNC
Table 9-20
Parameter SYNC
Full parameter name SYNC- Active / Inactive
Description Switch on/off remote TOD.
Type Enum
Values (if pre-defined) Range: ACTIVE

INACTIVE
Example ACTIVE
Consumer & use Mandatory - SYNC must have an entry.
POLLINGINTERVAL
Table 9-21
Parameter POLLINGINTERVAL
Full parameter name Polling Interval
Description Sync TOD polling interval (SECs).
Type INT
Values (if pre-defined) Range: 10.. 1440

Default=60
Example 10
Consumer & use Mandatory - Polling Interval must be

specified.

CKTID
Table 9-22
Parameter CKTID
Full parameter name Circuit Identifier.
Description Customer provisionable connection label.
Type String
Length Max 40 Characters
Format -
Values (if pre-defined) Not specified.
Example None
Consumer & use ED: The TL1 interface must support the
modification of this attribute.
RTRV Response: Mandatory: Required
by connection management application.
ENT: Mandatory: Required by connection
management application.
CCT
Table 9-23
Parameter CCT
Full parameter name Cross Connect type.
Description Cross-Connect Type: Used for specifying

one or two way connections.
Type ENUM
Values (if pre-defined) Range:1WAY - Unidirectional

unprotected Connection
2WAY - Bidirectional unprotected
Connection
1WAYPR - Unidirectional Path Switched
Ring Connection.
2WAYPR - Bidirectional Path Switched
Ring Connection.
Example 1WAYPR
Consumer & use ENT: Mandatory - Required for the

connection management application.
DLT: Not Specified.
ED: Mandatory - Required for the
connection management application.This
value may not be modified.
RTRV: Not Specified

AID-OCn
Table 9-24
Parameter AID
Full parameter name Access identifier

Refer Appendix AID Formats
Description Identifies an entity with the NE.
Type OC3/OC12 AID
Format OCn-Shelf-Slot-Port
Values (if pre-defined) See NE TL1 specifics [3] and NE TL1

conformity [4]
Example OME6130 Values:

OC3-1-<slot>-<port>
Where:
<slot> = 6,7(agg) or 4,5,7,8 (trib)
<port> 1,2
OC12-1-<slot>-<port>
Where:
<slot> = 6,7
<port> 1,2
Consumer & use Mandatory - Required by the connection

AID-CARD
Table 9-25
Parameter AID

Type Equipment AID
Format CARD_AID_TYPE-SHELF-SLOT

conformity [4]

• 28XE1DS1-1-[4, 5, 8, 9]
• 3XE3DS3-1-[4, 5, 8, 9]
• 2X155M-1-[4, 5, 8, 9]
• 8XETH-1-[4, 5, 8, 9]
• 2xGE-1-[4, 5, 8, 9]
• 2x155/622M-1-[6, 7]
• 2XGE/FX+8X10/100BT L2
622M-1-[4,5,8,9]
• 4X10/100BT+4X100FXL1-1-[4,5,8,9]
• 1X2G5AGG-1-[6,7]
• OAM-1-2
Consumer & use Mandatory - Required by the connection


AID-E1
Table 9-26
Parameter AID

Type E1 AID
Format E1-Shelf-Slot-Port

conformity [4]

• E1-1-[4,5,8,9]-[1-28]
Consumer & use Mandatory - The NE must respond with

all E1 facility AID's in the format specified
above.
AID-E3
Table 9-27
Parameter AID

Type E3 AID
Format E3-Shelf-Slot-Port

conformity [4]

E3-1-[4,5,8,9]-[1,3]

all E3 facility AID's in the format specified
above.
AID-DS1
Table 9-28
Parameter AID

Type DS1 AID
Format DS-Shelf-Slot-Port

conformity [4]

DS1-1-[4,5,8,9]-[1-28]

all DS1 facility AID's in the format
specified above.

AID-DS3
Table 9-29
Parameter AID

Type DS3 AID
Format DS3-Shelf-Slot-Port

conformity [4]

DS3-1-[4,5,8,9]-[1-3]

all DS3 facility AID's in the format
specified above.
TERM
Table 9-30
Parameter TERM
Full parameter name Terminating facility
Description Used to dictate the behavioural lifecycle

model for both User & NE provisioned HO
facilities.
Possible values:
"N": Used to indicate the absence of a HO
STS1/STS3C terminating facility.- There
are No LO connections- In this state the
deletion of a HO XC will not auto-create
(or reveal) a facility. Compare this
behavior with H.
Not used for scenario 1 NEs where there
is a default facility (that is hidden in the
case of a HO XC being present)
"Y": Used to indicate a HO STS1/STS3C
terminating facility that has been
auto-created due to containing a LO
connection- Contains at least 1 LO
connection.
"P": Used to indicate a HO user
provisioned STS1/STS3C facility.-
Contains zero or more LO connections-
Created as a result of either: - manually
provisioning the TERM value of an
automatically created HO facility from "Y"
-> "P". - auto-created from the existence
of the payload
"D": Provisioned facility with no XC.
Facility is present as if provisioned (either
explicitly or by default).- No Low order
XC- No HI order XCThis state is the
default state in scenario1 NEs
"H": Temporarily auto-deleted
provisioned HO facility.The existence of a
HO connection has temporarily deleted a
provisioned Facility. This facility will
effectively be auto-re-created if the HO
connection is deleted.
Type Attribute
Length -

Format TERM="Y"
Values (if pre-defined) Set to a value of "P"
Example TERM="N"
Consumer & use Optional - The NE TL1 interface must

respond with the TERM attribute for
STS1 path facilities,
AID-ETH
Table 9-31
Parameter AID

Type ETH AID
Format ETH-Shelf-Slot-Port

conformity [4]
Example OME6130 values:ETH-1-[4,5,8,9]-[1,8]

all ETH facility AID's in the format
specified above.
TXCON
Table 9-32
Parameter TXCON
Full parameter name Control the EPL conditioning.
Type Not Applicable
AID-WAN
Table 9-33
Parameter AID
Full parameter name Access identifierRefer Appendix AID

Formats
Type WAN AID
Format WAN-Shelf-Slot-Port

conformity [4]
Example OME6130 Values:WAN-1-[4,5,8,9]-[1-8]

all WAN facility AID's in the format
specified above.

MAPPING
Table 9-34
Parameter MAPPING
Full parameter name Packet mapping into SONET/SDH
Description GFP configuration mapping.
Type ENUM
Values (if pre-defined) Range -GFP-F
Example -
Consumer & use Mandatory - Required by connection

RATE
Table 9-35
Parameter RATE
Full parameter name SONET/SDH Basic rate (derived from

SONET/SDH cross-connections)
Description Identify the secondary state's

auto-in-service state
Type Enum
Values (if pre-defined) Range

VT1
VT2
STS1
STS3C
Example STS1
Consumer & use Required for the connection

VCAT
Table 9-36
Parameter VCAT
Full parameter name Virtual Concatenation
Description Identifies whether the VCAT is Enabled

or Disabled.
Type ENUM
Values (if pre-defined) Range - Enable Disable
Example ENABLE

LCAS
Table 9-37
Parameter LCAS
Full parameter name Link Capacity Adjustment Scheme
Description Identifies whether LCAS is Enabled or

Disabled.
Type ENUM
Values (if pre-defined) Range - Enable
Example DISABLE

management

SEQTYPE
Table 9-38
Parameter SEQTYPE
Full parameter name Sequence Number Type
Description Specifies the particular NE Sequence

Number.
Type ENUM
Values (if pre-defined) ATAGSEQ
Example ATAGSEQ
Consumer & use OMEA will set this value to "ATAGSEQ"

to acquire the latest NE ATAG value.
ATAGSEQ
Table 9-39
Parameter ATAGSEQ
Full parameter name ATAG Sequence Number
Description Specifies the ATAG value of the most

recent autonomous event.
Type INT
Example 123
Consumer & use Used by OMEA to acquire the latest NE

ATAG value.
DBCHGSEQ
Table 9-40
Parameter DBCHGSEQ
Full parameter name DBCHG Sequence Number
Description Specifies the sequence value of the most

recent DBCHG event.
Type INT
Example 123
Consumer & use Used by OMEA to acquire the latest NE

DBCHG sequence value.
MONTYPE
Table 9-41
Parameter MONTYPE
Full parameter name Monitor Type
Description Monitored Parameter.

The type of monitored parameter for
which a value is requested.
A null value requests all types of
monitored parameters to be retrieved.
Type ENUM
Example CVL
Consumer & use Performance Monitoring application.

MONLEV
Table 9-42
Parameter MONLEV
Full parameter name Monitor Level
Description The discriminating level for reported

monitored parameters.
Type ENUM
Values (if pre-defined) Null: Default: equivalent to 1-UP.

0-UP: All monitored parameter bins.
1-UP: Non-zero bins only.
0-ADJ-UP: Non-zero bins, zero-adjusted
bins, and all parameters for the first
interval requested.
Note: A PM parameter is zero adjusted
when:
• a restart occurs
• an Initialize Registers (INIT-REG)
command is issued
• the Network Element time is edited
• the state of the facility changes (from
in-service to out-of-service or the
reverse)o a defect occurs at the near
end (In this case, the far-end PM
parameters are zero adjusted.)
Example 1234
Consumer & use Performance Monitoring application.
LOCN
Table 9-43
Parameter LOCN
Full parameter name Location
Description The location where the monitored

parameter / alarm originates, and refers
to the entity identified by the AID.
Type Enum
Length -
Format -
Values (if pre-defined) • NEND (Default Near End)

• FEND (Far End)
• ALL (All ends)
Example NEND

Performance Monitoring application
DIRN
Table 9-44
Parameter DIRN
Full parameter name Direction
Description The direction of the monitored parameter

/ alarm condition and is relative to the
entity identified by the AID.
Type Enum
Length -
Format -

Values (if pre-defined) • RCV - Receive

• TRMT - Transmit
• AZ - A - Z
• BTH - Both
• NA - Not Applicable
• ZA - Z -A
Example -

MONVAL
Table 9-45
Parameter MONVAL
Full parameter name Monitored value
Description The measured value of a monitored

parameter, This value should be provided
for TCA's.
Type Integer from 0 - (2^32 -1)
Values (if pre-defined) • 0 to 4,294,967,295
Example 1

TMPER
Table 9-46
Parameter TMPER
Full parameter name Time period
Description The accumulation time period for the PM

information.
Type Enum
Values (if pre-defined) Null: Default: equivalent to 15-MIN

15-MIN: 15-minute interval
1-DAY: 1-day interval
1-UNT: Untimed interval
Example 1-DAY

MONDAT
Table 9-47
Parameter MONDAT
Full parameter name Monitoring Date
Description Date of (nominal) start of monitoring

interval.
Type Not Applicable
Length 5 Chars
Format MM-DD

MM: 01-12
DD: 01 -31
Example 12-31
Consumer & use Performance Monitoring application

MONTM
Table 9-48
Parameter MONTM
Full parameter name Monitoring Time (GMT)
Description Time of (nominal) start of monitoring

interval. Must be GMT.
Type Not Applicable
Length 5 Chars
Format HH-MM

HH: 00-23
DD: 00 -59
Example 05-40
INDEX
Table 9-49
Parameter INDEX
Full parameter name INDEX
Description The interval numbers to be accessed.

Current intervals are indicated by
INDEX=0, and older periods have higher
numbers.
If you specify <INDEX>, you cannot
specify <MONDAT> or<MONTM>.
1-32 = previous intervals e.g. for
tmper=15-MIN, index=1 is the most
recently completed 15-minute interval,
index=2 is the interval before that.
For tmper=1-DAY, index=1 is the most
recently completed day interval
(yesterday); ALL = all intervals.
Type ENUM

Null: Default equivalent to 0.
0: Current Interval
1-32: Previous intervals
ALL: All available intervals
Example 1
VLDTY
Table 9-50
Parameter VLDTY
Full parameter name Validity
Description Validity indicator for historical monitoring

information. It indicates whether the
information for the specified time period
was accumulated over the entire time
period or some portion of it.
Type ENUM
Values (if pre-defined) COMPL: Interval complete

PRTL: Interval incomplete (partial)
current time period was cut short.
ADJ: The register data is suspect or has
been reset.
Example COMPL

URL
Table 9-51
Parameter URL
Full parameter name Uniform Resource Locator
Description Used to specify the Server & file directory

location from/to which the NE
configuration file is retrieved/saved.
Type STRING
Format The format of url is:

[protocol:]//user:password@host[:port]/di
rectory-path.
Host: IP Address.
Port: Valid port number.
Supported protocols: FTP
Example -
Consumer & use Backup & Restore, Load Management

applications.
CHKALM
Table 9-52
Parameter CHKALM
Full parameter name Check Alarm Status
Description This option checks the alarm status on

the NE before any restore/backup or load
upgrade operations.
Type ENUM
Values (if pre-defined) N: No.

Y: Yes
Example N
Consumer & use No functional implication for the NE
CHKTID
Table 9-53
Parameter CHKTID
Full parameter name Check TID
Description CHKTID = Y
RST-PROV is not allowed if the SID in
the restore file does not match the
current TID on the NE receiving the
command.
CHKTID = N
RST-PROV is allowed whether or not the
SID in the restore file matches the current
TID on the NE receiving the command. If
the RST-PROV command is sent with the
CHKTID=N and some preventative
states exist, the command will fail.
Type ENUM
Values (if pre-defined) N: No.

Y: Yes
Example N
Consumer & use Required for the Backup & Restore

application.

RELNO
Table 9-54
Parameter RELNO
Full parameter name Release Number
Description ASCII string identifying the release

number. Must be unique and fully
specified - wildcarding is not allowed.
Type String
Example REL0100
Consumer & use Required for the Load & Connection

Management application.
ALRMS
Table 9-55
Parameter ALRMS
Full parameter name NE Alarms Flag
Description Indicate to the NE whether to continue

upgrade procedure in the presence of
active alarms.
Type ENUM
Values (if pre-defined) Y: Proceed with upgrade only if there are

no alarms.
N: Proceed with upgrade regardless of
the alarm status.
Example N
Consumer & use Required for the Load Management

application.
XBYTESAVAILABLE
Table 9-56
Parameter XBYTESAVAILABLE
Full parameter name No. of Bytes available.
Description Narrative depicting the No. of free byte

available on the SP.
Type String
Example "94863360 bytes available."

application.
FREEBYTES
Table 9-57
Parameter FREEBYTES
Full parameter name Free Bytes
Description No. of Bytes available on the NE.
Type INT
Example 94863360

application.

UPGRDSTAGE
Table 9-58
Parameter UPGRDSTAGE
Full parameter name Upgrade Stage
Description This command provides the last Upgrade

Command to be received by the NE.
Type ENUM
Values (if pre-defined) DELIVER: last command entered was

DLVR-RELEASE
LOAD: last command entered was
LOAD-UPGRD
INVOKE: last command entered was
INVK-UPGRD
CHECK: last command entered was
CHK-UPGRD
COMMIT: last command entered was
CMMT-UPGRD
CANCEL: last command entered was
CANC-UPGRD
INACTIVE: no upgrade operation
currently active
Example LOAD

application.
UPGRDRSLT
Table 9-59
Parameter UPGRDRSLT
Full parameter name Upgrade Stage Status
Description Provides a status value for the Upgrade

processes list above.
Type ENUM
Values (if pre-defined) PASS upgrade stage passed.

FAIL upgrade stage failed.
INPROGRESS upgrade stage in
progress
Example PASS

application.
SER
Table 9-60
Parameter SER
Full parameter name Serial Number
Description Card Serial Number
Type 25 alphanumeric characters
Consumer & use Required for the OMEA logging

application.

PEC
Table 9-61
Parameter PEC
Full parameter name Product Equipment Code
Description Product Code
Type 8 alphanumeric characters
Consumer & use Required for the OMEA logging

application.
CMDCODE
Table 9-62
Parameter CMDCODE
Full parameter name Command Code
Description Code for executed command
Type String
Example ENT-CRS-STS1
Consumer & use Mandatory

OMEA DML
OMEA Logging (Modification to NE)
Connection management.
AID1
Table 9-63
Parameter AID1
Full parameter name AID
Description First AID in the command staging block
Type String
Length -
Format -
Values (if pre-defined) -
Example -

Connection management.
AID2
Table 9-64
Parameter AID2
Full parameter name AID
Description Second AID in the command staging

block
Type String
Length -
Format -
Example -

Connection management

COMMON_BLOCK
Table 9-65
Parameter COMMON_BLOCK
Full parameter name Common Block
Description Position defined parameters from the

input command "common block".There
will be zero or more parameters in this
block dependant on parameters on the
input of the command.
Type Ident
Length Not Available
Format Not Available
Values (if pre-defined) Not Available
Example -
Consumer & use Mandatory if positional parameters are

specified in the TL1 command.OMEA
Logging application.
SPECIFIC_BLOCK
Table 9-66
Parameter SPECIFIC_BLOCK
Full parameter name Specific Block
Description Name defined (name=value) parameters

from the input command "specific
block".There will be zero or more
parameters in this block dependant on
parameters on the input of the command.
Type Ident
Example -
Consumer & use Mandatory if Name Valued pair

parameters are specified in the TL1
command.
OMEA Logging application.
FAILURESTRING
Table 9-67
Parameter FAILURESTRING
Full parameter name FAILURESTRING
Description Command Failure text
Type String
Example -
Consumer & use OMEA Logging application.

STATE_BLOCK
Table 9-68
Parameter STATE_BLOCK
Full parameter name State Block
Description Position defined parameters from the

input command "state block".There will
be zero or more parameters in this block
dependant on parameters on the input of
the command.
Type Ident
Example -
Consumer & use Mandatory if positional parameters are

specified in the input command "state
block" TL1 command.OMEA DML
OMEA Logging (Modification to
NE)Connection Management
STATUS
Table 9-69
Parameter STATUS
Full parameter name Activity STATUS
Description Status of logged event.
Type ENUM
Values (if pre-defined) COMPLD

DENY
Example COMPLD
Consumer & use OMEA Logging application.
AID (PORT)
Table 9-70
Parameter AID
Full parameter name Port AID
Description AID of the Network port
Type AID
Format OCn-SHELF-SLOT-PORT

conformity [4]
Example OME6130: OC3-1-[4,5,6,7,8,9]-[1,2]

OC12-1-[6,7],[1,2]
Consumer & use OMEA Network Adjacency
AIDFORMAT
Table 9-71
Parameter AIDFORMAT
Full parameter name AIDFORMAT
Description Used to provide the format of the OC3

port AID.
Type Not Available
Format TYP-SH-SL-PRT
TYP - Capacity of OCn port
SH - Shelf
SL - Slot
PRT - Port
Values (if pre-defined) TYP-SH-SL-PRT
Example TYP-SH-SL-PRT

LAYER
Table 9-72
Parameter LAYER
Full parameter name Network Topology Layer
Description Network Layer at which the Topology

data has been reported against.
Type ENUM
Format -
Values (if pre-defined) PMS: Physical (Manual Provisioning)

SECT: Section
LINE: LineEtc
Example SECT
ENABLED
Table 9-73
Parameter ENABLED
Full parameter name ENABLED
Description Status of logged event
Type ENUM
Values (if pre-defined) T: Automatic Discovery enabled.

N: Automatic Discovery disabled
manually provisioned Topology
adjacency object will be set to N.
Example T or N
MECHANISM
Table 9-74
Parameter MECHANISM
Full parameter name MECHANISM
Description The Network mechanism used to infer

Topology adjacency.
Type ENUM
Values (if pre-defined) IS-IS

MANUAL
Etc.
Example IS-IS
Consumer & use OMEA Topology Adjacency.
TX_VERSION
Table 9-75
Parameter TX_VERSION
Full parameter name TX_VERSION
Description Tx Auto-Discovery tagging format
Type ENUM
Values (if pre-defined) 1: Version 1

2: Version 2 (As specified)
0: Manual
Example 2

TX_SIGNATURE
Table 9-76
Parameter TX_SIGNATURE
Full parameter name TX_SIGNATURE
Description TX Topology Adjacency signature
Type Not Applicable
Format -
Example -
TYPE
Table 9-77
Parameter TYPE
Full parameter name TYPE
Description Topology Adjacency Object Type.
Type ENUM
Values (if pre-defined) MANUAL

AUTO
Example MANUAL
RX_VERSION
Table 9-78
Parameter RX_VERSION
Full parameter name RX_VERSION
Description Rx Auto-Discovery tagging format
Type ENUM
Values (if pre-defined) 1: Version 1

2: Version 2 (As specified)
0: Manual
Example 2
RX_ACTUAL
Table 9-79
Parameter RX_ACTUAL
Full parameter name RX_ACTUAL
Description RX_ACTUAL is the received Topology

Adjacency signature.The contents of this
field will be used to derive Topology
Adjacency.
Type Not Applicable
Format -
Example -

RX_EXPECTED
Table 9-80
Parameter RX_EXPECTED
Full parameter name RX_EXPECTED
Description RX_EXPECTED will upon confirmation of

Topology acquire the RX_ACTUAL
value.
Type Not Applicable
Format -
RX_RELIABILITY
Table 9-81
Parameter RX_EXPECTED
Full parameter name RX_EXPECTED
Description RX_EXPECTED will upon confirmation of

Topology acquire the RX_ACTUAL
value.
Type Not Applicable
Format -
Example -
RX_TERMINATED
Table 9-82
Parameter RX_TERMINATED
Full parameter name RX_TERMINATED
Description Used to indicate whether the Topology

Layer is Observed or Terminated at the
particular port.
Type ENUM
Values (if pre-defined) O: Observed

T: Terminated
Example O
RX_ACCEPTED
Table 9-83
Parameter RX_ACCEPTED
Full parameter name RX_ACCEPTED
Description Used to infer that the user has confirmed

the reported Topology.Once confirmed
modifications to the Topology can be
alarmed.
Type ENUM
Values (if pre-defined) Y: Accepted

N: Unaccepted
Example Y

CLEI
Table 9-84
Parameter CLEI
Full parameter name CLEI
Description Common Language Equipment Identifier
Type 10 Character alpha String
Example -
Consumer & use Not Applicable
NEWUID
Table 9-85
Parameter NEWUID
Full parameter name New user Identifier
Description Identifies a new user
Type String
Length 1…10 alphanumeric characters
Format alphanumeric
Example -
Consumer & use -
NEWPID
Table 9-86
Parameter NEWPID
Full parameter name The user's new password
Description Authenticates a new user
Type String
Length alphanumeric
Format 1…10 alphanumeric characters
Example -
Consumer & use -
USERTYPE
Table 9-87
Parameter USERTYPE
Full parameter name User account type
Description 0= local1=Network
Type INT
Length -
Format 0/1
Example -
Consumer & use -

323-1855-190
10-1
Errors 10-
Errors may be generated by any command or command response message. The

format of an error message is as follows:
^^^<SID>^<DATE>^<TIME> cr lf
M^^<CTAG>^DENY cr lf
^^^<error code> cr lf
^^^/*error text*/ cr lf;

Table 10-1
lists the error codes and messages.
Error code Commented Response Description
ENEQ /*Equipage, Not A command is received

EQuipped*/ which specifies an AID
containing a slot
component value for which
a circuit pack has not been
equipped
IBEX /*Input, Block EXtra*/ This is a parsing error - the

received command has
more payload blocks than
are expected according to
the specification of that
command's syntax in the
TL1 Blueprint.
IBMS /*Input, Block MiSsing*/ This is a parsing error - the

received command has
fewer payload blocks than
are expected according to
the specification of that
command's syntax in the
TL1 Blueprint.

10-2 Errors

ICNV /*Input, Command Not This is an unexpected

Valid*/ message - the received
command has not been
specified in the TL1
Blueprint.
IDNC /*Input, Data Not This is a parameter value

Consistent*/ error - a common
occurrence in RTRV-PM
requests, where the tmper
parameter value dictates
what the valid values for
the RANGE parameter is.
Taken in isolation, the
RANGE parameter value
may be legal, but not when
the current value of tmper
is realized.
IDNV /*Input, Data Not Valid*/ This is a parameter value

error - where the value is
not the wrong type (c.f.
IPNV), neither is it out of
range (c.f. IDRG), but has
some other problem.
IDRG /*Input, Data RanGe This is a parameter value

error*/ error - a command has
been received with one or
more parameters whose
type is correct, but whose
values are outside the
valid range specified in the
TL1 Blueprint.
IEAE /*Input, Entity Already A command has been

Exists*/ received to create an
entity, but the supplied AID
refers to an entity which
already exists.
IENA /*Input, Entity Not Attempting to provision a

Available*/ connection to a timeslot
that is already in use (by
another connection). The
Error Description lists the
payload endpoint causing
the error.
Errors 10-3

IENE /*Input, Entity does Not A command has been

Exist*/ received with an AID
which, although
syntactically valid (c.f.
IIAC), is out of range.
IIAC /*Input, Invalid ACcess A command has been

identifier*/ received with an AID which
either contains erroneous
characters, or has an
unrecognized entity type.
For out-of-range AIDs,
IENE should be used.
IICT /*Input, Invalid Correlation This is a parsing error - a

Tag*/ command has been
received with a CTAG
which is longer than 6
characters, or is not a valid
TL1 identifier (contains
characters other than A-Z,
a-z, 0-9). If the CTAG is
wholly numeric, it must be
a non-zero integer.
IISP /*Input, Invalid Syntax or This is a parsing error - a

Punctuation*/ command has been
received with punctuation
characters other than
colon (block separator),
comma (parameter
separator) or semicolon
(terminator).
IITA /*Input, Invalid TArget This is a parsing error - a

identifier*/ command has been
received with a TID which
is longer than 20
characters, or is not a valid
TL1 simple or compound
text string according to
GR-831 & GR833. Note
that the TID must be
quoted, if it contains
characters other than A-Z,
a-z, 0-9 or -.

10-4 Errors

INUP /*Input, Non-null This is an unexpected

Unimplemented parameter - a command
Parameter*/ has been received which
has a parameter which
should always be blank,
according to the
specification in the TL1
Blueprint, but in fact has a
value.
IPMS /*Input, Parameter A command has been

MiSsing*/ received which is missing
parameter(s) defined as
mandatory in its syntax
Blueprint.
IPNV /*Input, Parameter Not This is a parameter type

Valid*/ error - a command has
been received which has a
parameter whose actual
value type is not the same
as that defined in its syntax
Blueprint (e.g. a string was
expected but an integer
was entered).
PICC /*Privilege, Illegal This is a security violation -

Command Code*/ a command has been
issued by a user with
insufficient privilege for
that command (e.g. a
read-only user trying to
create a payload
connection). User privilege
levels run 1 (lowest)
through 4 (highest).
Errors 10-5

PIUC /*Privilege, Illegal User An illegal user privilege

Code*/ code has been supplied in
a security provisioning
command. User privilege
levels run 1 (lowest)
through 4 (highest). This
error is also raised if the
only administrator (level 4)
user attempts
self-demotion to a lower
privilege level - i.e. the risk
would be that the system is
left without an
administrator.
PIUI /*Privilege, Illegal User /In a security provisioning

Identity* command when a new uid
has been entered which is
already in use (it must be
unique), or if an
illegal-format new
password (pid) has been
entered. Important Note:
TR-NWT-000835 explicitly
prohibits this error being
raised from a failed login
attempt (ACT-USER) - in
fact, no error codes at all
should be raised by
ACT-USER; this is
because the reason for the
failed login must not be
revealed. Only a simple
message stating that the
session has been denied
should be displayed.
PLNA /*Privilege, Login Not This is a session error -

Active*/ this error code must be
returned to any command
received before the TL1
session has been logged
into with a valid
ACT-USER command.

10-6 Errors

PRNO /*Privilege, Requestor Not Attempting to provision a

Owner*/ connection on an
ASTN-owned Logical Line
resource. Error
Description lists the
offending Logical Line.
SARB /*Status, All Resources A command cannot be

Busy*/ acted on because the
system has no resources
(e.g. queue, memory, or
CPU time) to perform the
request.
SABT /*Status, ABorTed*/ The command in progress

has been aborted.
SDNC /*Status, Data Not Data is not consistent.

Consistent*/
SDNC /*Catalog does not support A software download

this NE*/ command has been
received which specifies a
catalog file not applicable
to this NE type.
SDNR /*Status, Data Not Ready*/ Data is not ready.
SDNR /*Server not found*/ Data is not ready - Server

not found.
SDNR /*Invalid Data is not ready - Invalid

username/password*/ username/password.
SDNR /*Catalog not found*/ Data is not ready - Catalog

not found.
SDNR /*Files missing from Data is not ready - Files

server*/ missing from server.
SNVS /*Status, Not in Valid Status, Not in Valid State.

State*/
SNVS /*Upgrade is already in A command cannot be

progress*/ action because the system
is in a state which prevents
it (e.g. a request to perform
an upgrade is received
when one is in progress).
Errors 10-7

SNVS /*No upgrade is in A command cannot be

progress*/ action because the system
it (e.g. a request to invoke
a software upgrade is
received with no upgrade
in progress).
SNVS /*Upgrade catalog is being A command cannot be

verified*/ action because the system
it (e.g. a request to check
an upgrade is received
when one is already in
progress).
SNVS /*Download is already in A command cannot be

progress*/ actioned because the
system is in a state which
prevents it (e.g. a request
to download a software is
received when one is
already in progress).
SNVS /*Download is already A command cannot be

completed*/ actioned because the
to stop a download is
received, once a download
is already completed).
SNVS /*Upgrade activation is in A command cannot be

progress*/ actioned because the
to activate an upgrade is
received, when one is
SNVS /*Upgrade activation is A command cannot be

already completed*/ actioned because the
prevents it (e.g.a request
already completed).

10-8 Errors

SNVS /*Upgrade is being A command cannot be

canceled*/ actioned because the
to cancel an upgrade is
received, when one is in
progress).
SNVS /*Upgrade is being A command cannot be

committed*/ actioned because the
to commit an upgrade is
being commited).
SNVS /*Download needs to be A command cannot be

started*/ actioned because the
to check the upgrade is
received, even before the
software is delivered).
SNVS /*Download has not A command cannot be

completed yet*/ actioned because the
to check the upgrade is
received, even before the
software is delivered).
SNVS /*Upgrade activation is A command cannot be

already in progress*/ actioned because the
SNVS /*Upgrade is already being A command cannot be

canceled*/ actioned because the
is received to cancel an
upgrade, even when one is
in progress).
Errors 10-9

SNVS /*Upgrade is already being A command cannot be

committed*/ actioned because the
received, even when one
is in progress).
SNVS /*Upgrade activation is still A command cannot be

in progress*/ actioned because the
prevents it (a request to
activate an upgrade is
SNVS /*Upgrade activation A command cannot be

needs to be invoked*/ actioned because the
received, before the
upgrade has been
invoked).
SNVS /*NE has following health A command cannot be

issues: ...*/ actioned because the
prevents it (e.g. The
current request is not
being carried out as there
are a list of problems with
the NE as described
further in the response).

10-10 Errors

SROF /*Status, Requested Status, Requested

Operation Failed*/ Operation Failed.
SROF /*Can not upgrade from A request to upgrade a

current release to this release has been received
catalog release*/ with the release to be
upgraded is either not
compatible or is not
applicable for that NE.
SSTP /*Status, execution Some fatal error occurred

SToPped due to hardware which prevented the
or software problem*/ command from
completing.
Nortel
Optical Multiservice Edge 6130

TL1 Reference
Copyright  2006-2007 Nortel Networks, All Rights Reserved
This document is protected by copyright laws and international treaties. All

information, copyrights and any other intellectual property rights contained in this
document are the property of Nortel Networks. Except as expressly authorized in
writing by Nortel Networks, the holder is granted no rights to use the information
contained herein and this document shall not be published, copied, produced or
reproduced, modified, translated, compiled, distributed, displayed or transmitted, in
whole or part, in any form or media.
The information is provided “as is” and Nortel Networks does not make or provide
any warranty of any kind, expressed or implied, including any implied warranties of
merchantability, non-infringement of third party intellectual property rights, and
fitness for a particular purpose.
Nortel, the Nortel logo and the Globemark are trademarks of Nortel Networks.
Internet Explorer is a trademark of Microsoft Corporation.
Netscape is a trademark of Netscape Communications Corporation.
323-1855-190
Standard Rel 2.0 Issue 1
June 2007
Printed in Canada

Optical Multiservice Edge 6130 TL1 Reference

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Optical Multiservice Edge 6130 TL1 Reference

Uploaded by

Copyright:

Available Formats

323-1855-190

Optical Multiservice Edge 6130

Standard Rel 2.0 Issue 1 June 2007

About this document ix

Network Element Discovery and Management 1-1

Connection Management 2-1

TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

Response Syntax Definition 2-3

Performance Monitoring 3-1

Network Backup and Restore 4-1

SAV-PROV: Save Provisioning 4-1

Network Load Management 5-1

Topology Adjacency 6-1

Appendix - Common TL1 Parameter 9-1

TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

About this document 0

• provides a detailed description of each TL1 command and corresponding

The topics covered are:

• TL1 command Syntax

TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

Optical Multiservice Edge 6130 NTP Library

Planning a Installing, Managing and Maintenance and Supporting

Local Craft Access

Network Element Discovery and

TL1 commands and responses

RTRV-HDR: Retrieve Header

ACT-USER: Activate User (session)

RTRV-LAST-SEQNUM: Retrieve Last Sequence Number

RTRV-NETYPE: Retrieve Network Element

RTRV-SW-VER:Retrieve Software Version

RTRV-RTG-INFO:Retrieve Routing Info

RTRV-SYS: Retrieve System

ED-DAT:Edit NE Date & Time

ALW-MSG-BROADCAST:Allow Message Broadcast

INH-MSG-BROADCAST:Inhibit Message Broadcast

ALW-MSG-ALL: Allow Message All

RTRV-COND-ALL: Retrieve Conditions All

CANC-USER: Cancel User (Session)

TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

RTRV-HDR: Retrieve Header

Category System Common

Input Syntax RTRV-HDR:[<tid>]::<ctag>;

DENY response. OMEA re-discovery (If the TID of a

No response. OMEA re-discovery – used to trigger

Normal Response Syntax ^^^SID^93-06-15^10:12:11

Errors Errors are listed in Table 10-1 on

ACT-USER: Activate User (session)

Logged TL1 Log

Input Syntax ACT-USER:[tid]:<uid>:ctag::<pid>;

Response Syntax ^^^SID^93-06-15^10:12:11

Errors Errors are listed in Table 10-1 on

Parameter Attributes Description

uid M New User Identification.It

pid M The user login password. It

TL1 Reference 323-1855-190 Standard Rel 2.0 Iss 1 Jun 2007

RTRV-LAST-SEQNUM: Retrieve Last Sequence Number

Input Syntax RTRV-LAST-SEQNUM:[<tid>]::<ctag>::[

Response Syntax ^^SID^93-06-15^10:12:11

Errors Errors are listed in Table 10-1 on

Parameter Attributes Description

seqtype 0 Sequence Number Type.

RTRV-NETYPE: Retrieve Network Element

Category System Parameters