TL1 Interface Description
TL1 Interface Description
Nortel Networks
OPTera Long Haul 1600
Optical Line System
TL1 Interface Description
What’s inside...
Interface configurations
Administrative interface
Surveillance interface
TL1 commissioning
Copyright 2000 Nortel Networks, All Rights Reserved.
The information contained herein is the property of Nortel Networks and is strictly confidential. Except as expressly authorized in
writing by Nortel Networks, the holder shall keep all information contained herein confidential, shall disclose it only to its employees
with a need to know, and shall protect it, in whole or in part, from disclosure and dissemination to third parties with the same degree
of care it uses to protect its own confidential information, but with no less than reasonable care. Except as expressly authorized in
writing by Nortel Networks, the holder is granted no rights to use the information contained herein.
Nortel Networks, the Nortel Networks logo, the Globemark, How the World Shares Ideas, S/DMS TransportNode, OPTera, Preside,
and Unified Networks are trademarks of Nortel Networks.
Contents 0
About this document vii
THLEV 4-20
TID 4-20
Time 4-21
TIME 4-21
TMPER 4-21
TYPEREQ 4-22
VLDTY 4-22
TL1 acknowledgment responses and error codes 4-23
Acknowledgment responses 4-23
Error codes 4-24
Alarm summary 4-25
Message types 4-25
Message intervals and PM considerations 4-28
Autonomous messages 4-30
REPT ALM (report alarm) 4-30
REPT ALM ENV (report alarm environment) 4-33
REPT COND (report condition) 4-34
REPT EVT (report event) 4-36
REPT PM (report performance monitoring) 4-39
REPT SW (report switch) 4-43
Non-autonomous messages 4-45
ALW-MSG (allow messages) 4-45
ALW-PMREPT (allow performance monitoring report) 4-46
ED-DAT (change OPC date and time) 4-48
INHIBIT-MSG (inhibit messages) 4-51
INH-PMREPT (inhibit performance monitoring report) 4-53
INIT-REG (initialize register) 4-55
OPR-EXT-CONT (operate external controls) 4-58
OPR-SYNCNSW (Operate Synchronization Switch) 4-60
RLS-EXT-CONT (release external controls) 4-62
RLS-SYNCNSW (release synchronization switch) 4-64
RTRV-ALM (retrieve alarm) 4-66
RTRV-ALM-ENV (retrieve alarm environment) 4-69
RTRV-COND (retrieve condition) 4-71
RTRV-HDR (retrieve header) 4-75
RTRV-PM (retrieve performance monitoring) 4-77
RTRV-PMMODE (retrieve performance monitoring) 4-79
RTRV-TH (retrieve performance monitoring threshold) 4-81
SET-PMMODE (set performance monitoring mode) 4-84
SET-SID (set source identifier) 4-86
SET-TH (set performance monitoring threshold) 4-88
Message associations 4-91
Alarm tables 4-91
5-2 Defining and enabling X.25 communications on the OPC X.25 port 5-17
5-3 Configuring virtual circuit profiles 5-34
5-4 Restarting the TL1 Session Manager 5-40
5-5 Querying active TL1 sessions 5-42
5-6 Accessing and exiting TL1 interfaces through the UNIX shell tool 5-44
5-7 Configuring and enabling the TL1 Interface Router Service over X.25 or
TCP/IP 5-46
5-8 Configuring TL1 over TCP/IP 5-71
Audience
This document is for the following members of the operating company:
• planners
• provisioners
• network administrators
• transmission standards engineers
• maintenance personnel
Network
16 OR r
Applications
00
G Plu
M
Supported
C
R
om r
Am s
ep
ea
bi
pl
ne
ifi
te
er
Library Introduction, List of Terms, and Master Topical Index
-continued-
OTP1153
Network
16
Applications
00 R P
G
M
Supported
C
R
O
om r
Am s
ep
ea
bi
pl
ne
lu
ifi
te
er
r
Maintenance
Supporting Documentation to the OPTera Long Haul 1600 Library (not part of this library)
323-1301-XXX OC-192 NTP Library
323-1321-XXX TN-64X NTP Library
323-1201-XXX OC-48 NTP Library
323-1211-XXX TN-16X NTP Library
450-3101-XXX Preside Documentation
NTR710AM Optical Networks Data Communications Planning Guide
NTCA65DA OPTera Connect DX NTP Library (OPTera Connect DX SONET platform)
NTCA65FA OPTera Connect DX NTP Library (OC-192 platform)
NTCA65GA OPTera Connect DX NTP Library (OPTera Connect DX SONET & OC-192 platforms)
NTCA65JA OPTera Connect DX NTP Library (OPTera Connect DX SDH platform)
NTCA65AC TN-64X Rel 3 NTP Library
NTCA65KA OPTera Connect DX NTP Library (OPTera Connect DX SDH & TN-64X platforms)
References
This document refers to the following Nortel Networks technical publications
(NTP) that are specific to the OPTera Long Haul 1600 Library:
• Powering Up and Commissioning Procedures, 323-1801-220
• Performance Monitoring Procedures, 323-1801-520
• Fault Detection, 323-1801-541
• Trouble Clearing and Module Replacement, 323-1801-543
• OPC User Interface Description, 323-1801-196
• User Interface Connection Procedures, 323-1801-301
• External Interface Configuration Procedures, 323-1801-302
• Data Administration Procedures, 323-1801-304
• Security Management Procedures, 323-1801-305
• Log Reference, 323-1801-840
• Setting, changing or retrieving a TID using the OPC interface (Procedure 1-2)
— Have the user id and password for OPC
— Log into the OPC
— Open the Unix shell tool, in the OPC Admin section
— View the table with the current NEid, NEname, OPCTID and TID for all NEs in the span of control
— Issue a message to define or change the TID or OPCTID
— Exit the Unix shell tool
• Defining and enabling TCP/IP communications to access TL1 surveillance (Procedure 2-1)
— Use a terminal connected to an OPC (User Interface Connection Procedures, 323-1801-301)
— Log into the OPC and display the user session manager
— Create a user with the Centralized User Administration (CUA) tool
— Log out of the user session manager
— Select the TL1 surveillance interface or enhanced TL1 surveillance interface from the OPC prompt
— Enter the password file
— Make a copy of the password file
— Log out of OPC
—continued—
• Defining and enabling X.25 communications on the OPC X.25 port (Procedure 5-2)
— Obtain a userID and password, at the root or admin class level
— Complete X.25 worksheet
— Log into OPC
— Open a TL1 configuration tool
— Select to configure an X.25 port
— View X.25 parameters
— Accept or change X.25 parameters
— Create the configuration file from the X.25 menu
— Enable X.25 from the configure menu
—continued—
• Accessing and exiting TL1 interfaces through the Unix shell tool (Procedure 5-6)
— Obtain a userID and password that allows you to access the OPC at the root level
— Use a terminal connected to the OPC (User Interface Connection Procedures, 323-1801-301)
— Log into the OPC as root
— Issue a message to access the TL1 interface
— Issue a message to exit the TL1 interface
• Configuring and enabling the TL1 interface Router Service over X.25 or TCP/IP (Procedure 5-7)
— Obtain a userID and password that accesses the TL1 Configuration tool from the User Session Manager
— Determine and configure the X.121 address of the OSS into the virtual circuit profile of both the gateway
OPC and into remote OPCs. For more details see Procedure 5-3
— Configure the gateway OPC port B for X.25. For more information see Procedure 5-2
— Determine the RemoteOPCNames, TIDs, IP address of the OSS, OSS type, and port number for primary
router service over TCP/IP.
— Ensure the OPTera Long Haul 1600 PID is not set to NULL. If it is go to Procedure 5-3 to change it.
— Log into the OPC using the admin userID
— Open the TL1 configuration tool from the User Session Manager
— Configure the TL1 interface router over X.25 or TCP/IP
— For X.25 configure and enable primary and backup router
— For TCP/IP configure and enable primary and backup router
— Establish or disable a TL1 session over the TL1 Interface Router Service
—end—
Procedure tasks
• Access the main menu of the NEUI with admin or read/write privileges (step 1).
• Put the associated facility OOS if you are taking a CPG OOS (step 4).
• Put the corresponding output facility OOS if you are taking the protection ESI CPG OOS (step 10).
• Put the protection ESI CPG OOS (step 14).
• Put the output facility for the working ESI CPG OOS (step 18).
• Set the target filter mode to freerun if you are taking the working ESI CPG OOS (step 20).
Expected results
• The primary state of the CPG changes.
• If the expected results do not occur:
— Perform the procedure again.
— Contact your next level of support.
Introduction to TL1 1-
TL1 overview
Transaction Language 1 (TL1) is an industry-recognized common language
protocol for messages exchanged between network elements and an operations
system (OS). OPTera Long Haul 1600 supports TL1 messages for the network
administrative and surveillance functions. TL1 allows an OS to communicate
with different vendor’s equipment through the common language protocol.
TL1 eliminates the need to support vendor-specific interfaces.
Figure 1-1
Example of TL1 connection by TCP/IP (route diverse linear system shown)
OTP0677.eps
Operations
system
LAN/WAN
Backup
Backup TL1/TCPIP
OPC OPC Router
site
Regenerator Regenerator OPTera Long Haul 1600
Repeater
Legend:
Figure 1-2
Example of two systems that interface through TL1 to a remote operations system by X.25
OTP0678.eps
Operations
system
Modem Modem
DCE DCE
Primary Backup
X.25/TL1 X.25/TL1
link link
OPTera OPTera
Long Haul Long Haul
1600 1600
Repeater Repeater
Regenerator Regenerator
Primary Backup
OPC OPC OPC OPC
site site
DTE DTE
Primary Backup
X.25/TL1 Regenerator X.25/TL1
link link
Ethernet SONET SDCC bridge
OPTera OPTera
Long Haul OC-192 Long Haul
1600 Terminal 1600
Repeater Repeater
Legend:
Standards compliance
The OPTera Long Haul 1600 TransportNode TL1 surveillance interface
complies with the following Telcordia standards:
• GR-833-CORE Issue 2: Network Maintenance - Network Element and
Transport Surveillance Messages
• TA-TSY-200 Issue 4: Specification of System Maintenance Messages at
the OS/NE Interface
• SR-OPT-001665 Issue 2: NMA Generic Transport Element Interface
Support
The X.25 interface is compliant with the following standards:
• ITU-T (previously CCITT) Recommendation X.25, ITU-T (previously
CCITT) Blue Book 1988
• ISO/IEC 8208 X.25 Packet Layer Protocol 1990
The TransportNode equipment is compliant with the Telcordia NMA OS
standard, releases 2.4 and 3.2.
TL1 connectivity
TL1 over X.25
The OPC and the operations system can send TL1 messages between them
with an X.25 packet layer protocol. The OPC X.25 port is accessible on the
legacy OPC, or on the OPC Interface circuit pack faceplate on a partitioned
OPC. You can provision the OPC X.25 port as an X.25 port. With the
appropriate X.25 cable and a link to an X.25 data packet network, the X.25 port
becomes the TransportNode OPTera LH TL1 gateway to the operations
system. To configure X.25 port for TL1 use, refer to Chapter 5, “TL1
commissioning”.
Note: Make sure the X.25 port is not connected in order to configure it as
an X.25/TL1 interface. To configure the X.25 port for X.25 use, establish
a terminal session through the OPC Ethernet port or log in from a network
element.
TL1 over TCP/IP
You can access the TL1 interface:
• over X.25
• through TRUE TCP/IP
• over TELNET TCP/IP with a telnet session
When you access TL1 over TRUE TCP/IP, there is no need for telnet. You need
a telnet session to use the tl1shell and when you log in as an “nma” or “ops”
user. If you access TL1 with a telnet session, establish the telnet session with
the Ethernet port on the OPC faceplate. The functionality and messages
supported by the Ethernet TL1 interface are identical to that of the X.25 TL1
interface. The Ethernet allows for a faster rate of transmission and also frees
port B on the legacy OPC. You can use port B as a printer port or terminal port.
The redundant connection originates at either the X.25 port or the Ethernet port
of the backup OPC. This connection becomes activated only when the backup
OPC is active. For example, when a fiber cut between the network elements
that contains the primary and backup OPCs occurs, both the primary and
standby TL1 interfaces are active. This kind of fiber cut results in a loss of
communication between OPCs.
When the backup OPC and the backup TL1 connection become active, the
operations system receives an autonomous Report Switch (REPT-SW)
message. The message indicates that the TL1 link is now active. If the backup
OPC becomes active before the establishment of the TL1 connection to the
backup OPC, the system does not send the REPT-SW message.
You must manually synchronize the TID used by TL1 between the primary
OPC and the backup OPC. When a new TID is set, perform OPC
synchronization. For the procedure to transfer data between OPCs, refer to
Data Administration Procedures, 323-1801-304.
Loss of communication
Use the Retrieve Header (RTRV-HDR) TL1 surveillance interface message to
detect a loss of communication to the network elements or the OPC. After you
issue the RTRV-HDR request to the OPC or the selected network element, you
should receive the TL1 response message within three minutes. Three minutes
is the worst case estimate. If you do not receive the TL1 response within three
minutes then there is a link failure or loss of communications to that network
element or OPC. The RTRV-HDR message is useful when troubleshooting
network element link failures.
Simultaneous TL1 sessions
See Table 1-1 for the number of sessions that can occur simultaneously on the
TL1 OS and the OPC user interface. The maximum number of simultaneous
TL1 sessions is four (whether you are using X.25 or TCP/IP). Of the four, all
can be surveillance sessions. Only one TL1 provisioning interface session can
occur at a time. If four TL1 sessions are active, then a maximum of two OPC
user interface sessions can occur.
l
Table 1-1
TL1 operations system sessions
0 4
1 4
2 3
3 3
4 2
The first line contains the source identifier (SID), the date and time. The date
and time indicate when the TL1 response was sent to the operations system.
An example of the first line is:
The second line of the TL1 message differs for autonomous messages and
non-autonomous messages. For autonomous messages, the second line in
non-alarm messages begins with an A. The second line in alarm messages
begins with an alarm code, such as an asterisk (which represents a minor
alarm) as shown in Figure 1-3. The second line of autonomous messages also
contains:
• a numerical alarm tag (ATAG), the ATAG is automatically generated
• the TL1 message type
For non-autonomous messages, the second line always begins with an M,
followed by the correlation tag (CTAG) used in the original TL1 request. The
CTAG is in turn followed by either the word COMPLD to indicate a normal
response, or DENY to indicate an error response.
There are two possible acknowledgment messages, Table 1-2 describes these
messages:
Table 1-2
Acknowledgment messages
Acknowledgment Description
NA crlf No Acknowledgment
< Indicates that the TL1 request was received, but the selected
OPC is not active so no TL1 response will be sent back to the
operations system.
Legend:
cr = carriage return
lf = line feed
There are three possible values for the TID parameter block: a defined target
identifier (TID), the NE name (NEname), or the NE identification number
(NEid). The list below provides a summary of the TID block parameter values:
• The value of the TID parameter block can be a defined TID of up to 20
characters (letters, digits, hyphens [-], underscores [_], and periods [.]).
This name is set through the TL1 connection as a TL1 message (set-sid) or
through an OPC Session Manager UNIX command (tidmap). Refer to
“Setting an identification parameter” later in this chapter.
• The value of the TID parameter block can be the NEname (providing it
meets TL1 requirements) if a TID is not set. The NEname allows a user to
provide a designation for the NE that reflects the needs of the application.
The NEname is set from the NE user interface (NE UI).
• The value of the TID parameter block can be the NEid if the NEname is
not valid and if a TID is not set. The assignment of the NEid is the first step
in the commissioning of a new network element. This NEid can be up to
five numeric characters long (that is, the values 1 through 65534 inclusive).
The OPC uses the NEid to uniquely identify a particular NE. You must
assign an NEid to each NE. Instructions for setting the NEid are in the
Powering up and Commissioning Procedures, 323-1801-220.
Table 1-3
TL1 network element identification for NMA and OPS
You must manually synchronize the defined name between the primary OPC
and the backup OPC. Perform an OPC synchronization when a new target
identifier is set. Each network element can have only one TID.
Table 1-4
Action Details
Setting and retrieving a TL1 TID from an operations system Procedure 1-1
Setting a TL1 TID through the OPC user interface Procedure 1-2
Procedure 1-1
Setting and retrieving a TL1 TID from an operations
system
Use this procedure to set, change, or confirm a target identifier (TID) from an
operations system such as a network monitoring and analysis (NMA) system.
The TID is applicable in TL1 surveillance applications. The TID defines a TL1
target identifier and fully supports the format defined by Telcordia standards
for the naming of network elements.
Procedure tasks
• Establish a connection to the TL1 interface of the OPC (step 1).
• Set or retrieve the TID (step 2).
• Set or change the OPCTID (step 5).
Expected results
• The TID and OPCTID are set and retrieved.
• If the expected results do not occur:
— Check that you have a connection to the TL1 interface of the OPC.
— Check that you have correctly typed the required messages.
— Check that you have the correct input parameters for TID and OPCTID.
—continued—
Action
Step Action
TID operations
3 To set or change the TID for a network element, issue the following message:
set-sid:<current tid>::<ctag>::<new tid>;crlf
If the command successfully executes, you receive this message:
crlf
lf
^^^<new tid>^<date>^<time> crlf
M^^<ctag>^COMPLD crlf
;
If there is an error, you receive this message:
crlf
lf
^^^<current tid>^<date>^<time> crlf
M^^<ctag>^DENY crlf
^^^<errcde> crlf
[^^^/*error text*/ crlf]
;
4 To confirm the new TID or to display the TID, issue the following message:
rtrv-hdr:<tid>::<ctag>;crlf
If the command successfully executes, you receive this message:
crlf
lf
^^^<current tid>^<date>^<time> crlf
M^^<ctag>^COMPLD crlf
;
—continued—
Step Action
Step Action
6 To confirm the new OPCTID or to display the OPCTID, issue the following
message:
rtrv-hdr:<OPCTID>::<ctag>;crlf
If the command successfully executes, you receive this message:
crlf
lf
^^^<current OPCTID>^<date>^<time> crlf
M^^<ctag>^COMPLD crlf
;
If there is an error, you receive this message:
crlf
lf
^^^<OPCTID>^<date>^<time> crlf
M^^<ctag>^DENY crlf
^^^<errcde> crlf
[^^^/*<error text>*/ crlf]
;
If the OPCTID for an OPC is unknown, issue the following message:
rtrv-hdr:<OPCNAME>::<ctag>; crlf
A successful response returns the current OPCTID for that OPC.
crlf
lf
^^^<current tid>^<date>^<time> crlf
M^^<ctag>^COMPLD crlf
;
—end—
Procedure 1-2
Setting a TL1 TID through the OPC user interface
Use this procedure to define, change, or display TID through an OPC interface.
The TID is applicable in TL1 surveillance applications. The TID defines a TL1
target identifier and fully supports the format defined by Telcordia standards
for the naming of network elements.
• semi-colon (;)
• colon (:)
• ampersand (&)
• greater than (>)
• less than (<)
• back-slash (\)
• double quote (“)
• comma (,)
• any control characters
You cannot use spaces in the TID. You can use lowercase lettering in the TID,
however, the system interprets and returns the alphabetical characters in
uppercase only.
Note: This procedure uses the tidmap command. To obtain help for the
tidmap command enter tidmap -h ↵.
—continued—
Procedure tasks
• Log in to the OPC (step 1).
• Open the UNIX shell tool, in the OPC Admin section (step 2).
• Display a table of current values for NEid, NEname, and TID (step 3).
• Define or change a TID and OPCTID (step 5).
Expected results
• The TID and OPCTID are set and retrieved.
• If the expected results do not occur:
— Make sure you log onto the system as admin user or root user.
— Check that you have the correct input parameters for the command.
—continued—
Action
Step Action
2 With the User Session Manager displayed, open the UNIX shell tool (in the
OPC Admin section).
If you do not know how to open the UNIX shell tool, see User Interface
Connection Procedures, 323-1801-301.
The UNIX prompt “OPC>” appears.
—continued—
Step Action
3 To display a table of the current values for NEid, NEname, OPCTID, and TID
for all NEs in the OPC span of control, type the following command:
tidmap ↵
A table similar to the table below appears:
TID NE NAME NE ID
============ ========= ======
TLITID000123 NENAME123 10001
NENAME234 NENAME234 20002
30003 30003
OPCTID OPCNAME
========= =========
OPCP1967P OPC00001P
OPC00001B OPC00001B
Step Action
Go to step 7.
Define or change an OPCTID
6 To define or change an OPCTID, type the following command:
tidmap -a <OPCNAME> <OPCTID> ↵
where
<OPCNAME> is the value of the NEid
<OPCTID> is the new value for the OPCTID
Interface configurations 2-
To make the TL1 interface operational with an X.25 connection you must
configure the X.25 port for X.25 communications and configure virtual circuit
profiles. Before you use the TL1 interface initialize the X.25 communications.
To make the TL1 interface operational with a telnet connection you must
configure the appropriate user accounts. To use the TL1 interface over telnet
the appropriate user accounts must be set up first.
Before the TL1 interface on the S/DMS TransportNode systems becomes
operational, you must perform certain steps to make sure the TL1 interface is
functioning correctly. This chapter describes the configuration requirements
for the TL1 sessions via X.25 and telnet.
TL1 configuration
This section describes the configuration requirements for both the primary and
backup TL1 interfaces.
Issue the RTRV-HDR command from any interface to confirm that the TL1
interface is working correctly.
Note: You can use the same TL1 requirements to configure the backup
TL1 interface. The backup interface cannot transport any TL1 messages
while the backup OPC is inactive. Send a non-autonomous message, such
as a RTRV-HDR message, to the OPC to check the TL1 connection. If the
operations system receives an “NA” acknowledgment response (as
explained in Chapter 1, “Introduction to TL1”), then the backup TL1
interface is operational upon activation of the backup OPC. If the
operations system receives no response, use the TL1 checklist to locate the
trouble area.
X.25 configuration
X.25 is an international telecommunications standard for data packet
switching. The International Telecommunications
Union-Telecommunications (ITU-T, formerly CCITT) defines the X.25
standard. The X.25 standard ensures that the information sent from data
terminal equipment (DTE) can be understood when the remote operations
system receives it over the data packet network. The TL1 interface on the OPC
is an example of DTE. The purpose of the X.25 packet protocol is to allow TL1
messaging between the OPC and the operations system. The ISO/IEC 8208
X.25 Packet Layer Protocol for Data Terminal Equipment document defines
this protocol.
Set the X.25 configuration before you verify the TL1 interface. After you
configure the X.25 communications, add the valid X.121 user addresses into
the OPC. Refer to the procedures in Chapter 5, “TL1 commissioning”, of this
document to define and enable X.25 communications on the X.25 port.
• The X.25 parameters on the OPC, such as the X.121 address, must be
configured (refer to Chapter 5, “TL1 commissioning”, of this document).
• The X.25 port on the OPC Interface circuit pack must be available for use.
• The X.25 port must be configured as an X.25 port (refer to Chapter 5, “TL1
commissioning”, of this document)
Note: After configuring the X.25 port, restart the TL1 session manager as
described in Chapter 5, “TL1 commissioning”, of this document.
• One end of the TL1 cable must be connected to the X.25 port and other end
to the data communication equipment (modem, data line, or modem
eliminator).
• The link access protocol B (LAPB) must be initialized. Use a protocol
analyzer to verify the initialization.
• The operations system X.121 addresses must be added to the OPC virtual
circuit profile configuration file. This provides user security. If the
operations system X.121 address is not entered in the OPC, the X.25 call
request from the operations system is refused.
Note: The X.121 parameter must be defined for the OPC and it can be an
assigned number from the data packet network administrator. The device
and name parameters should not be modified. The t1, t3, t4, framesize, n2,
and l2window level 2 parameters are all configurable. The network type
parameter can be either DTE 84 (data terminal equipment) or DCE 84
(data communication equipment). Only switched virtual circuits (SVC)
can be provisioned under the circuit table definition with a maximum
number of 16 for the maximum parameter. All the other parameters are
configurable. Ensure that you match the X.25 parameters on the OPC to
those on the operations system.
• The operations system must issue a call request to the OPC and establish
the X.25 SVC.
X.25 communications
In X.25 communications there are both data circuit-terminating equipment
(DCE) and data terminating equipment (DTE) at the physical level and at the
handshaking and flow-control levels. The OPC X.25 port is a DTE device
which should be connected to a synchronous modem (DCE). In the case of a
direct connection (no modems) to an operations system, which is also a DTE,
a synchronous modem eliminator is needed. Both configurations are shown in
Figure 2-1.
Figure 2-1
X.25 communication between OPC and operations system
F2412
Packet
Synchronous switched Synchronous Operations
OPC data System (OS)
modem modem
network
Hardware: DCE Hardware: DCE
Hardware: DTE Hardware: DTE
Control: DTE Control: DCE
Hardware: DCE-DCE
Hardware: DTE Hardware: DTE
Control: DTE Control: DCE
The OPC is normally configured as DTE for flow-control purposes with the
operations system configured as DCE. The X.29/X.3 PAD facilities can be
specified in the call request packet originated from the operations system. The
X.29/X.3 PAD facilities are normally required for asynchronous access such
as using a VT100 terminal and they can be used in an operations system
environment. The OPC accepts the incoming X.25 call if the X.29/X.3
facilities have been defined.
The OPC supports only switched virtual circuits (SVC) and not permanent
virtual circuits (PVC). The SVC connections require call establishment
handshaking (call request and call acceptance packets) between the OPC and
the operations system, whereas PVC connections do not require call control.
Think of SVC as a regular phone line over which user A dials a number to start
a conversation with user B, and PVC as a direct phone line that user A just
picks up and talks to user B.
If a problem persists after the above has been checked, connect a protocol
analyzer between the OPC and the DCE device to monitor the packet
exchanges. Verify that:
• the X.25 connection is an SVC and not a PVC
• call request packets are received by the OPC
• the protocol id (PID) in the call request packet matches the OPC user
defined PID
• the calling and caller’s X.121 addresses are specified in the call request
packet
• the X.29/X.3 PAD facility bit is set in the call request packet
• SABM or UA packets are continuously received or transmitted
Note: If so, there is a problem at the LAPB layer 2 level.
• the OPC issues a call acceptance packet and then a clear request packet
Note: If so, there is a problem with vcpinfo (the user X.121 address is not
defined in the OPC) or the facilities requested.
Ethernet configuration
The TL1 interfaces can also be accessed by way of telnet sessions to the OPC.
Ensure that:
• the Ethernet port on the OPC is enabled
• the network monitoring and analysis (NMA) users have been created on
the OPC (see Procedure 2-1, “Defining and enabling TCP/IP
communications”)
• the appropriate Ethernet cable has been plugged into the OPC
• the operations system has a telnet session to the OPC and is logged in
Note: OC-3 Express network elements are Nortel Networks only SONET
network elements that support TL1 as the application layer protocol. All
other Nortel Networks SONET network elements, such as the OC-12,
OC-48, OC-192, and OPTera Long Haul 1600 network elements, support
CMISE as the application layer protocol.
TARP
Target Identifier Address Resolution Protocol (TARP) is a propagation
protocol allowing network elements to translate between TID values and
NSAP addresses. The TARP feature provides a mapping of TID values to
NSAP addresses, so that TL1 messages reach the proper network element
regardless of the application layer protocol (TL1 or CMISE).
Full TARP services
Nortel Networks OC-3 Express network elements support TL1 as the
application layer protocol. These network elements require full TARP
services.
TARP transparency
Nortel Networks OPTera Long Haul 1600 network elements support CMISE
as the application layer protocol. These network elements do not require TARP
services, but they do provide minimal TARP support. By providing minimal
TARP support, these network elements do not disrupt the operations of
network elements that support TL1 as the application layer protocol (such as
Nortel Networks OC-3 Express network elements). Nortel Networks CMISE
network elements do not originate TARP messages but do propagate them.
This type of support is known as TARP transparency (see Figure 2-2).
OS
TL1 messages
NE NE NE NE
Table 2-1
Action Details
Procedure 2-1
Defining and enabling TCP/IP communications
Use this procedure to access TL1 surveillance interfaces on the operations
controller (OPC) with the Transmission Control Protocol/Internet Protocol
(TCP/IP) telnet session. This procedure allows you to directly log in to the
NMA interface.
Procedure tasks
• Create a user with the OPC Central User Administration (CUA) tool (step 2).
• Select the appropriate interface (step 5).
• Make a backup copy of the password file (step 8).
Expected results
• You establish a TL1 surveillance session over TCP/IP.
• If the expected results do not occur:
— Check that you created a user called NMA with the OPC CUA tool.
— Check that you entered the right commands at the OPC prompt.
— Check that you were able to telnet to the OPC and log in as nma.
—continued—
Action
Step Action
1 Log in to the OPC as root, and display the User Session Manager by typing
“opcui” at the prompt. If you do not know how to do this, see User Interface
Connection Procedures, 323-1801-301.
2 Create a user with the OPC Centralized User Administration (CUA) tool. If you
do not know how to do this, see Security Management Procedures,
323-1801-305.
Call the user NMA and place in the slat group.
3 Press the Esc key to close the CUA tool.
4 Log out of the User Session Manager.
The “opc>” prompt appears.
5 Select the appropriate interface from the following table:
If you want to access the Then go to
TL1 Surveillance interface (NMA) step 6
Enhanced TL1 Surveillance interface (NMA) step 7
Step Action
Go to step 11.
10 At the prompt, enter:
n↵
Administrative interface 3-
This chapter describes S/DMS TransportNode OPTera Long Haul 1600
network element user administration through the TL1 administrative interface.
It contains definitions of the non-autonomous messages and respective
parameters.
Table 3-1
Action Details
Table 3-2 lists the non-autonomous administrative message types that exist for
user administration.
Table 3-2
Non-autonomous administrative message types
ACT-USER (activate user Used by admin and root users to activate a TL1 user administration
session) session.
DLT-USER-SECU (delete user Used, during a user administration session, to delete a user from the
security) OPC user list.
ED-USER-SECU (edit user Used, during a user administration session, to change the parameters
security) associated with the user.
ENT-USER-SECU (enter user Used, during a user administration session, to add a user to the OPC
security) user list.
RTRV-USER-SECU (retrieve Used, during a user administration session, to retrieve the parameters
user security) associated with the user.
See Procedure 3-1, “Opening a TL1 administration session”, for syntax and
usage.
Examples
An example of the ACT-USER command with a normal output response:
ACT-USER:NE_TID:admin:CTAG20::admin;
See Procedure 3-2, “Closing a TL1 administration session”, for syntax and
usage.
Examples
An example of the CANC-USER command with a normal output response:
CANC-USER:NE_TID::CTAG30;
Note: These examples illustrate the behavior over an X.25 interface; you
can use this command to terminate a TL1 shell interface.
See Procedure 3-6, “Deleting a CUA user account”, for syntax and usage.
Examples
An example of the DLT-USER-SECU command with normal output
responses:
DLT-USER-SECU:NE_TID:newuser:CTAG28;
See Procedure 3-5, “Editing security parameters for a CUA user” for syntax
and usage.
Examples
An example of the ED-USER-SECU command with normal output responses:
ED-USER-SECU:NE_TID:newuser:CTAG24::,SECRET12;
See Procedure 3-4, “Adding a user account to the CUA”, for syntax and usage.
Examples
An example of the ENT-USER-SECU command with normal output
responses:
ENT-USER-SECU:NE_TID:newuser:CTAG22:admin:SECRET12,,RW;
See Procedure 3-3, “Retrieving security parameters for a CUA user” for syntax
and usage.
Examples
An example of the RTRV-USER-SECU command and a normal output
response:
RTRV-USER-SECU:NE_TID:newuser:CTAG26;
See Table 3-3 for the maximum number of user accounts allowed:
Table 3-3
Maximum quantity of CUA user accounts
User privileges
An OPC defines users that have read, write, and administrative privileges for
each of the network elements in its span of control. Each of these users belongs
to a defined user group on the OPC. Users in the admin and root user groups
are seen as administrators and can perform user administration through the
CUA interface. These admin and root users have the same administration
privileges available through TL1. Users who do not belong to these two groups
do not have administrative privileges.
A user profile is made up of several parameters. Each user defined in the CUA
belongs to a user group. Each user group has Read, Read/Write,
Read/Write/Admin, or no privileges for each network element in its span of
control. Table 3-4 identifies the TL1 syntax of the network element privileges
and the CUA equivalent meanings.
Table 3-4
CUA user privileges
TL1 syntax CUA equivalent meaning
Note: The UAPs are the same as user access class on the CUA.
Figure 3-1 is an example CUA user profile window, and shows how a user has
UAPs for each network element. A user with no privileges for a given network
element has the ‘Accessibility’ column set to ‘No’. A user with no accessibility
corresponds to having a UAP value of “NULL” when specified in the TL1
interface.
Figure 3-1
Example CUA user profile window
Table 3-5 shows the relationship between CUA accessibility and access
classes, and the TL1 UAP.
In order for the first TL1 administrator to open a TL1 administration session,
that user must belong to an existing admin or root user account. The first user
can add, modify or delete TL1 administrators through both the TL1 interface
with the commands described in this section, and the CUA tool.
Table 3-5
CUA accessibility and access classes mapped to TL1 UAPs
Accessibility Access class UAP
Yes Read R
Yes Read/Write RW
No Read NULL
No Read/Write NULL
No Read/Write/Admin NULL
Symbol Meaning
^ ASCII space
[] optional expression
Error responses
If a TL1 administration command is unsuccessful, a DENY response with a
TL1 error is returned. Table 3-8 lists the error codes that are reported, with a
description of the situation which causes the problem. The error response for
TL1 administration commands follows the syntax:
crlf
lf
^^^<sid>^<date>^<time> crlf
M^^<ctag>^DENY crlf
^^^<errcde> crlf
^^^”<error text>” crlf
;
Table 3-8
TL1 administration session error codes
IDNV ent-user-secu Input, Data Not Valid: GRP GRP syntax is invalid.
ed-user-secu Input, Data Not Valid: GRP New GRP syntax is invalid.
ent-user-secu Input, Data Not Valid: GRP GRP does not exist in CUA.
ed-user-secu Input, Data Not Valid: GRP User group specified by NGRP does not
exist in CUA. Use an existing user group.
ent-user-secu Input, Data Not Valid: UAP UAP is something other than {NULL, R, RW,
RWA}.
ed-user-secu Input, Data Not Valid: UAP New UAP is something other than {NULL,
R, RW, RWA}.
act-user Input, Data Not Valid: PID PID does not match the actual password.
ent-user-secu Input, Data Not Valid: PID PID is not acceptable to CUA. Possibly due
ed-user-secu to improper syntax. Check the password
format rules for the CUA.
ed-user-secu Input, Data Not Valid: PID New PID syntax is invalid.
act-user Input, Data Not Valid: UID UID does not exist.
ed-user-secu
canc-user Input, Data Not Valid: UID UID syntax is invalid. The UID syntax is
dlt-user-secu incorrect or the UID does not exist.
—continued—
IDNV ent-user-secu Input, Data Not Valid: UID UID syntax is incorrect.
ed-user-secu
ent-user-secu Input, Data Not Valid: UID UID is not acceptable to CUA. Possibly due
to improper syntax. Check the user id format
rules for the CUA.
rtrv-user-secu Input, Data Not Valid: UID UID syntax was invalid or no such user
found.
IICM ent-user-secu Input, Invalid Command No administration session is active. Use the
dlt-user-secu ACT-USER command first.
rtrv-user-secu
ed-user-secu
IITA act-user Input, Invalid TArget Identifier No such TID was in the OPC span of
canc-user control.
ent-user-secu
dlt-user-secu
rtrv-user-secu
ed-user-secu
ent-user-secu Input, Non-null Unimplemented Second parameter in the last block must be
Parameter left blank.
ed-user-secu Input, Non-null Unimplemented Third parameter in the last block must be left
Parameter blank.
—continued—
SARB act-user CUA interface is in use CUA tool is open in the OPC User Session
canc-user Manager. You cannot send TL1
ent-user-secu administration commands until you close
dlt-user-secu the CUA tool.
rtrv-user-secu
ed-user-secu
SROF act-user User has no admin privileges User was not a member of the admin or root
user groups and does not have
administrative privileges.
Procedure 3-1
Opening a TL1 administration session
Use this procedure to open a TL1 administration session to use the
administrator TL1 commands. Only users from the admin and root user groups
can open a TL1 administration session. To open a TL1 administration session
use the activate user (act-user) command.
After you use the ACT-USER command, no other user can activate a session
on that TL1 connection. The current user must cancel the session with the
cancel user (canc-user) command. Refer to Procedure 3-2, “Closing a TL1
administration session”.
Procedure tasks
• Establish a connection to a TL1 interface of the OPC (step 1).
• Open a TL1 administration session (step 2).
Expected results
• You open a TL1 administrative session.
• If the expected results do not occur:
— Refer to “Error responses” on page 3-13 for error responses.
—continued—
Action
Step Action
where
<tid> is the optional target identifier
Note: The tid must be a valid identifier in the OPC span of
control.
<uid> is the user identifier of a user in either the admin or root user
groups. See Table 3-6 for syntax information.
<ctag> is the correlation tag
<pid> is the private identifier, or password. See Table 3-6 for syntax.
where
<sid> is the source identifier
<ctag> is the correlation tag
<uid> is the user identifier
—end—
Procedure 3-2
Closing a TL1 administration session
Use this procedure to close a TL1 administration session. The activate user
(act-user) command opens the session. Refer to Procedure 3-1, “Opening a
TL1 administration session”.
Procedure tasks
• Close a TL1 administration session by issuing a TL1 message (step 1).
Expected results
• The TL1 administration session closes.
• If the expected results do not occur:
— Refer to “Error responses” on page 3-13 for error responses.
—continued—
Action
Step Action
where
<tid> is the optional target identifier
Note: The tid must be a valid identifier in the OPC span of
control.
<uid> is the optional user identifier
See Table 3-6 for syntax information.
Note: If you enter the uid specify the current user. If you do
not enter the uid, the system assumes it is the current user.
<ctag> is the correlation tag
where
<sid> is the source identifier
<ctag> is the correlation tag
<uid> is the user identifier
—end—
Procedure 3-3
Retrieving security parameters for a CUA user
Use this procedure during a TL1 administration session to retrieve the security
parameters associated with a Centralized User Administration (CUA) user.
Procedure tasks
• Retrieve security parameters by issuing a TL1 message (step 1).
Expected results
• Security parameters are retrieved.
• If the expected results do not occur:
— Refer to “Error responses” on page 3-13 for error responses.
—continued—
Action
Step Action
where
<tid> is the target identifier (not optional)
Note: The user access privileges for the specified target
identifier are in the TL1 response.
<uid> is the optional user identifier
See Table 3-6 for syntax information.
Note: If you enter a specified uid, the security parameters for
that specified user are retrieved. If you do not specify a uid, the
security parameters for all user accounts are retrieved.
<ctag> is the correlation tag
where
<sid> is the source identifier
<ctag> is the correlation tag
<uid> is the user identifier
<uap> is the user access privilege for the listed user account
Options include:
R (read access only)
RW (read/write access only)
RWA (read/write/admin access)
NULL (no access)
<grp> is the user group that contains the listed user account
Note: Example groups include admin, netsurv and slat.
Procedure 3-4
Adding a user account to the CUA
Use this procedure during a TL1 administration session to add a user account
to the Centralized User Administration (CUA). The parameters that you need
to specify are:
• user id
• group (grp)
• password (pid)
• user access privilege (uap)
Note 1: The uap applies to each network element in the span of control.
Note 2: You cannot add user accounts through TL1 if an OPC CUA
session is in progress. If you issue a ent-user-secu command after a CUA
session becomes active you get a DENY error response.
Note 3: If you attempt to execute a TL1 administration command without
first opening a TL1 administration session, you get an ‘Invalid Command’
response. Refer to Procedure 3-1, “Opening a TL1 administration session”.
Procedure tasks
• Add a user account to the CUA by issuing a TL1 message (step 1).
Expected results
• A new user account is added. The parameters of the new user account appear in a response message.
• If the expected results do not occur:
— Refer to “Error responses” on page 3-13 for error responses.
—continued—
Action
Step Action
where
<tid> is the optional target identifier
Note: If you use the tid, make sure it is valid in the OPC span
of control. The tid has no significance when used with this
command.
<uid> is the user identifier for the new user
See Table 3-6 for syntax information.
Note: This user identifier must be unique to the CUA.
<ctag> is the correlation tag
<grp> is the group to contain the added user
Note: This must be a group known to the CUA, for example,
admin.
<pid> is the password for the added user account
See Table 3-6 for syntax information.
Note: It is the responsibility of the operations system or the
application to hide this password from view.
<uap> is the user access privilege for the added user account
Options include:
R (read access only)
RW (read/write access only)
RWA (read/write/admin access)
NULL (no access)
Note: These privileges apply to each NE in the OPC span of
control as a default for the new user. If new user requires
different privileges for each NE, use the ed-user-secu
command. See Procedure 3-5, “Editing security parameters
for a CUA user”.
Procedure 3-5
Editing security parameters for a CUA user
Use this procedure during a TL1 administration session to modify a
Centralized User Administration (CUA) user account. Parameters that you can
change are user id (uid), group (grp), password (pid), and user access privilege
(uap).
If you change the access privilege to NULL for one or more network elements,
that account will no longer exist on those network elements. If the user is on
an active session when the access privilege changes to NULL, the user session
can continue unaffected. After the user logs out of the network elements, their
password expires and the user will not be able to log on to those network
elements again. After the Centralized User Administration audit, user accounts
with NULL access privileges no longer exist on the network elements.
Procedure tasks
• Modify a CUA user account by issuing a TL1 message (step 1).
Expected results
• The following security parameters will change to your new values: user id (uid), group (grp), password
(pid), and user access privilege (uap).
• If the expected results do not occur:
— Refer to “Error responses” on page 3-13 for error responses.
—continued—
Action
Step Action
where
<tid> is the target identifier, which is not optional
Note: The command still executes when the TID value is null.
<uid> is the user identifier
See Table 3-6 for syntax information.
<ctag> is the correlation tag
<ngrp> is the optional new group to contain the user
Note: If specified, this must be a group known to the CUA, for
example, admin. If not specified, the user’s group does not
change.
<npid> is the optional new password for the user account
See Table 3-6 for syntax information.
Note: The operations system is responsible for hiding this
password from view. If not specified, the password does not
change.
<nuap> is the optional new user access privilege for the user account
Options include:
R (read access only)
RW (read/write access only)
RWA (read/write/admin access)
NULL (no access)
The privileges apply to the NE specified by the tid.
—continued—
Step Action
where
<uap> is the new value, if changed
<grp> is the new value, if changed
—end—
Procedure 3-6
Deleting a CUA user account
Use this procedure during a TL1 administration session to delete a user
account from the Centralized User Administration (CUA). Deletion of user
accounts must conform to the CUA rules. It is not possible to delete the admin
user account. See External Interface Configuration Procedures,
323-1801-302, for the CUA rules.
Note 1: You cannot delete user accounts through TL1 if an OPC CUA
session is in progress. If you issue a dlt-user-secu command after a CUA
session becomes active you get a DENY error response.
Note 2: If you attempt to execute a TL1 administration command without
first opening a TL1 administration session, you get an ‘Invalid Command’
response. Refer to Procedure 3-1, “Opening a TL1 administration session”.
Note 3: If the user is on an active session on the OPC when their account
gets deleted the user can continue in the session unaffected. After the user
logs out of the session, the user is not able to log in again.
Note 4: If the user is on an active session on a network element when their
account gets deleted, the user can continue in the session unaffected. After
the user logs out of the network element their user password expires and
the user is not able to log on to that network element again. After the
Centralized User Administration audit, that user account no longer exists
on network elements where the account was deleted.
Procedure tasks
• Delete a CUA user account by issuing a TL1 message (step 1).
Expected results
• The CUA user account gets deleted and a TL1 message appears.
• If the expected results do not occur:
— Refer to “Error responses” on page 3-13 for error responses.
—continued—
Action
Step Action
where
<tid> is the optional target identifier
Note: If you use the tid, make sure it is valid in the OPC span
of control. The tid has no significance when used with this
command.
<uid> is the user identifier
<ctag> is the correlation tag
Surveillance interface 4-
This chapter describes OPTera Long Haul 1600 network element alarm
surveillance through the TL1 surveillance interface. It provides the association
between the alarms and their equivalent TL1 messages. This chapter also
provides definitions of messages and parameters.
Chapter summary
See Table 4-1 for the sections provided in this chapter.
Table 4-1
Major sections in this chapter
Section
Message parameters
Alarm summary
Autonomous messages
Non-autonomous messages
Message associations
Symbol Meaning
^ ASCII space
[] optional expression
Message parameters
This section describes the surveillance message parameters listed in Table 4-2.
Table 4-2
TL1 surveillance message parameters
Parameter Description
DUR Duration
Table 4-2
TL1 surveillance message parameters (continued)
Parameter Description
TIME The new time for the OPC time of day clock
ACTID
The ACTID parameter indicates the name of the active OPC module.
Format
The ACTID parameter format consists of up to 20 characters of ASCII text that
follow the syntax restrictions of the AID parameter.
AID
The AID parameter indicates the identification of the access point at the
network element or OPC to which terminations are made. See Table 4-3 for
AID parameters and the modified formats in which they appear.
Format
The AID parameter format consists of up to three fields, separated by hyphens,
that describe the physical location of the target for the TL1 request.
Table 4-3
AID formats
ALL NULL
COM NULL
ENV <Eqid>
<Eqid>-<Fan_id>
<Eqid>-<Battery_id>
<Eqid>-<CPGname>-<Scan_point_id>
EQPT <Eqid-<CPGname>-[<Slot_id>]
OC48 <Eqid>-<CPGname>
OC192 <Eqid>-<CPGname>
T1 <Eqid>-<ESI_Fac_id>-[<member_name>]
AIDTYPE
The AIDTYPE parameter indicates the access identifier type. This parameter
appears in the response to a Retrieve Alarm message. This parameter has the
same value as the second command code modifier (SCCM) of the
corresponding autonomous Report Alarm message. See Table 4-4 for the
AIDTYPE parameter domains.
Table 4-4
AIDTYPE parameter domains
COM Common
ENV Environmental
ALMCDE
The ALMCDE parameter indicates the alarm severity code. See Table 4-5 for
the ALMCDE parameter domains.
Table 4-5
ALMCDE parameter domains
*C Critical alarm
** Major alarm
*^ Minor alarm
A^ Autonomous message
ALMMSG
The ALMMSG parameter indicates the alarm text description.
Format
The ALMMSG parameter format consists of up to 40 characters of ASCII text
as seen on the alarms screen, enclosed within escaped quotes (\”).
ALMTYPE
The ALMTYPE parameter indicates alarm indication type. The value of the
parameter determines the format of the AID parameter for all messages related
to environmental alarms. When the ALMTYPE parameter has a null value, the
AID parameter has no meaning. See Table 4-6 for the ALMTYPE parameter
domains.
Table 4-6
ALMTYPE parameter domains
ATAG
The ATAG parameter is a numeric transaction identifier, similar to the CTAG
identifier. The TL1 software in the OPC module generates the value of the
ATAG automatically. The ATAG parameter is a sequence number that appears
in autonomous messages only.
The number by which the ATAG parameter increments, in the REPT COND
message, is dependent on the SCCM parameter. If the SCCM value is ALL, the
ATAG parameter increases by 10. If there are no standing alarms, the ATAG
parameter increases by one.
The REPT PM TL1 message increments the ATAG parameter by one for each
of the PM values reported.
Format
The ATAG parameter format consists of an integer number, of up to six
characters, ranging from 1 to 999999. The ATAG identifies the generated TL1
messages. It is an automatic message counter which increments by one or 10
for each autonomous message. The ATAG value of the first TL1 autonomous
message is a random number and it wraps around from 999999 to 1.
CONDDESCR
The CONDDESCR parameter indicates the condition text description.
Format
The CONDDESCR parameter format consists of up to 64 characters of ASCII
text of the log text seen in the OPC Event Browser, enclosed within escaped
quotes (\”).
CONDEFF
The CONDEFF parameter indicates the effect of the event on the condition of
the network element. See Table 4-7 for the CONDEFF parameter domains.
Table 4-7
CONDEFF parameter domains
SC Standing condition
TC Transient condition
CONDTYPE
The CONDTYPE parameter indicates the condition event type. See Table 4-8
for the CONDTYPE parameter domains.
Table 4-8
CONDTYPE parameter domains
CONDTYPE domains Description
ACCESSDENY Access is denied
ACTLPBK Active loopback in effect
AIS Alarm indication signal detected
APSB Automatic protection switching byte failure
BKUPMEMP Primary non-volatile backup memory failure
BKUPMEMS Secondary non-volatile backup memory failure
BUERR Bus error
CCBPV Composite clock bipolar violation density error
—continued—
Table 4-8
CONDTYPE parameter domains (continued)
CONDTYPE domains Description
CONTBUS Control bus failure
CONTCOM Control communications equipment failure
CONTEQPT Control equipment failure
CONTR Control processor failure
DATAFLT Data integrity fault
DBMEMTRF Database synchronization failure
DISKERR Hard disk error
DISKFULL Hard disk full
EOC Embedded operations channel failure
FAILTOSW Switch to protection failure
FERF Line far end receive failure
FRCDWKSWPR Forced switch to protection channel/equipment
FRD Fraud detected
FRNGSYNCCG Free running synchronization mode
FSTSYNC Fast start synchronization mode
HLDOVRSYNC Holdover synchronization mode
INCFAD Incoming failure due to fading
INHSWPR Protection switch inhibited
INIT Initialization executed
INTRUDER Intrusion attempt
INTSFT Internal software fault
IMPROPRMVL Improper removal
LOCKOUTOFPR Lockout of protection
LOCKOUTOWK Lockout of working
LOF Loss of frame
LOP Loss of pointer
LOS Loss of signal
LOTRI Loss of timing reference input
MA Multiple access problem
MISC Miscellaneous condition (used with logs)
MISC-1 Miscellaneous condition
MISC-2 Miscellaneous condition
MANWKSWPR Manual switch to protection channel/equipment
MANSWTOPRI Manual switch to primary synchronization reference
—continued—
Table 4-8
CONDTYPE parameter domains (continued)
CONDTYPE domains Description
MANSWTOSEC Manual switch to secondary synchronization
reference
MSGTHRTLACT Message throttling active
NTTST Network termination returns to no test mode
OC48TERM OC-48 facility termination equipment failure
OC192TERM OC-192 facility termination equipment failure
ORDRWR Orderwire channel failure
PAINTGRT Path integrity failure
RCVR Receiver failure
SFI Rx AIS
SWEQPT Protection switching equipment failure
SYNC Oscillating synchronization status
SYNCCLK Synchronization unit failure
SYNCPRI Synchronization to primary reference failure
SYNCSEC Synchronization to secondary reference failure
TDTERM Timing Distribution Card (TDC) equipment failure
T-AIS Section alarm indication signal threshold exceeded
T-AISSP Path alarm indication signal second
T-BCVL Line bipolar coding violation
T-BESL Line bipolar errored seconds
T-BIPS Section bit interleaved parity threshold exceeded
T-BSESL Line bipolar severely errored seconds
T-GPMLSD Group PM line section day
T-GPMLS1MIN Group PM line section 1 minute
T-GPMLSM Group PM line section minutes
T-GPMIPD Group PM path day
T-GPMIPM Group PM path minutes
T-CVL Line code violation threshold exceeded
T-CVP Path code violation threshold exceeded
T-CVS Section code violation threshold exceeded
T-ESL Line errored seconds threshold exceeded
T-ESP Path errored seconds threshold exceeded
T-ESS Section errored seconds threshold exceeded
T-LBCL Laser bias current level threshold exceeded
—continued—
Table 4-8
CONDTYPE parameter domains (continued)
CONDTYPE domains Description
T-LPR Laser power receive threshold exceeded
T-LPT Laser power transmit threshold exceeded
T-OOF Threshold exceeded-out of frame
T-SASP Path severely errored frame second/alarm indication
signal second
T-SEFSP Path severely errored frame seconds
T-SEFSS Section severely errored frame seconds
T-SESL Line severely errored seconds threshold exceeded
T-SESP Path severely errored seconds threshold exceeded
T-SESS Section severely errored seconds threshold
exceeded
T-UASL Line unavailable seconds threshold exceeded
T-UASP Path unavailable seconds threshold exceeded
TRMT Transmitter failure
WKSWPR Working facility/equipment switch to protection
WTR Wait to restore mechanism
YEL Yellow signal received
CTAG
The CTAG parameter is a correlation identifier generated by the operations
system (OS) and used to correlate non-autonomous command and response
messages. It can contain mixed numeric or alphabetic characters. If the first
character is numeric, the remaining characters must be numeric. The TL1
software in the OPC keeps track of correlation identifiers for outstanding
non-autonomous requests.
Format
The CTAG parameter format consists of up to 6 ASCII characters.
Date
The Date parameter indicates the TL1 message translation date. See Table 4-9
for the Date parameter domains.
Format
This is the format of the Date parameter:
<yy>-<mm>-<dd>
Table 4-9
Date parameter domains
DATE
The DATE parameter indicates the new date to which the OPC time of day
clock will change to. See Table 4-10 for the DATE parameter domains.
Format
This is the format of the Date parameter:
<yy>-<mm>-<dd>
Table 4-10
DATE parameter domains
DIRN
The DIRN parameter indicates the direction of the event. See Table 4-11 for
the DIRN parameter domains.
Table 4-11
DIRN parameter domains
NA Not applicable
DUR
The DUR parameter indicates the duration of the contact operation.
Continuous latching of the relay contacts is possible from the surveillance
operations system. See Table 4-12 for a description of the DUR parameter
domains.
Table 4-12
DUR parameter domains
ERRCDE
The ERRCDE parameter indicates the associated error code of the message.
See Table 4-28 on page 4-24 for a listing of error codes and their respective
descriptions.
LOCN
The LOCN parameter indicates the location of the event. See Table 4-13 for
the LOCN parameter domains.
Table 4-13
LOCN parameter domains
MODE
The MODE parameter indicates the switch mode of the event. See Table 4-14
for the MODE parameter domains.
Table 4-14
MODE parameter domains
MODETYPE
The MODETYPE parameter indicates the performance monitoring parameters
which will be retrieved or set. See Table 4-15 for MODETYPE parameter
domains.
Table 4-15
MODETYPE parameter domains
MONDAT
The MONDAT parameter indicates the month and day of the start of the PM
monitoring period specified by TMPER. This parameter has the format
MONTH-DAY. MONTH and DAY should be the Greenwich mean time
equivalent of the local OPC time. If null, the default is the current date. To
retrieve several daily counts use parameter grouping with this parameter. See
Table 4-16 for MONDAT parameter domains.
The date associated with the first bin is specified in the MONTM field. When
you request 15-minute bins for the previous day (that is, prior to midnight), the
date must not be null. Put the previous day’s date into the field if MONTM is
not set to ALL. If MONTM is set to ALL, MONDAT must be null.
Format
This is the format of the MONDAT parameter:
<mm>-<dd>
Table 4-16
MONDAT parameter domains
MONLEV
The MONLEV parameter indicates the monitor level of the PM data to report.
See Table 4-17 for the MONLEV parameter domains. A null value defaults to
1-UP.
Format
The MONLEV parameter format consists of two fields separated by a hyphen.
This is the format of the MONLEV parameter:
<lev>-<dir>
Table 4-17
MONLEV parameter domains
MONLEV Description
domains
MONTM
The MONTM parameters indicate the hour and minute of the start of the PM
monitoring period specified by TMPER. This parameter has the format
HOUR-MINUTE. A null value defaults to the start of the last 15-minute bin
collected at the OPC. Note that these last 15-minute bins can not all align to
the same time period for all termination classes collected. The alignment of the
time periods depends on the actual time when the collection of PM counts took
place on the OPC. You must explicitly enter the time range or single interval if
all bins need to align to the same time period.
If you specify ALL for the MONTM parameter, the date parameter
(MONDAT) must be null. When you specify MONTM as ALL, all 15-minute
bins with non-zero counts are retrieved. The 15-minute bins will have the
correct time stamp, regardless of whether the 8-hour interval falls within the
same day or across two days.
If you have not run PM collection or updated the PM database for several hours
or days, use the RTRV-PM command with MONTM=ALL to retrieve these
stale records with their correct time stamps. Use parameter grouping with this
parameter to retrieve several 15-minute counts. See Table 4-18 for the
MONTM parameter domains.
Format
The MONTM parameter format consists of two fields separated by a hyphen.
This is the format of the MONTM parameter:
<hh>-<mm>
Table 4-18
MONTM parameter domains
MONTYPE
The MONTYPE parameter indicates the performance monitor (PM) type of
the monitored PM parameter. See Table 4-19 for the MONTYPE parameter
domains.
MONVAL
The MONVAL parameter indicates the performance monitor value of the
monitored PM parameter. See Table 4-19 for the MONVAL parameter
domains.
Table 4-19
MONTYPE and MONVAL parameter domains
NTFCNCDE
The NTFCNCDE parameter indicates the notification code of the message.
See Table 4-20 for the NTFCNCDE parameter domains.
Note: The CL value does not appear in the Report Condition, Retrieve
Alarm, and Retrieve Alarm Environment messages.
Table 4-20
NTFCNCDE parameter domains
CR Critical alarm
MJ Major alarm
MN Minor alarm
CL Cleared alarm
OCRDAT
The OCRDAT parameter indicates the date of the event occurrence. See Table
4-21 for the OCRDAT parameter domains.
Format
The OCRDAT parameter format consists of two fields separated by a hyphen.
This is the format of the OCRDAT parameter:
<mm>-<dd>
Table 4-21
OCRDAT parameter domains
OCRTM
The OCRTM parameter indicates the time of the event occurrence. See Table
4-22 for the OCRTM parameter domains.
Format
The OCRTM parameter format consists of three fields separated by hyphens.
This is the format of the OCRTM parameter:
<hh>-<mm>-<ss>
Note 1: When you put an entity with an alarm against it out of service
(OOS), the alarm clears. When you put this same entity back in service (IS)
without correcting the cause of the alarm, the alarm raises again. The
timestamp of the alarm has the same value as the timestamp when the
alarm was first raised.
Note 2: When you provision an entity with an alarm against it as ‘not
reported’, the alarm clears. When you provision this same entity back to
‘reported’ without correcting the cause of the alarm, the alarm raises again.
The timestamp of the alarm has the same value as the timestamp when the
alarm was first raised
Table 4-22
OCRTM parameter domains
PMSTATE
The PMSTATE parameter indicates the performance monitoring collection
state. The possible domains for this parameter are:
• ON
• OFF
REF
The timing reference number is for synchronization switching commands.
There can be up to six references with integer values of 1, 2, 3, 4, 5, and 6. The
integers correspond to the actual timing references. Provision the actual timing
reference in the timing reference protection user interface screen. See Table
4-23 for the REF parameter domains.
Table 4-23
REF parameter domains
SCCM
The SCCM parameter indicates the SONET second command code modifier
(SCCM) values specifying the administrative view of a given TL1 message.
The value ALL is meaningful only in the Retrieve Alarm message. See Table
4-24 for the SCCM parameter domains.
Table 4-24
SCCM parameter domains
ENV Environmental
EQPT Equipment
OS Output Signal
T1 ESI related
SID
The SID parameter indicates the NE or OPC originating the TL1 message.
Format
The SID parameter format is identical to the target identifier (TID) parameter,
and consists of either an SID name, the NE name (NEname), or the NE identity
(NEid).
• The format can be a 20-character name of ASCII text programmed for use
as the SID. The SID can consist of letters, digits, hyphens (-),
underscores (_), and periods (.).
• The format can be the 13-character NE name, if it meets TL1 requirements.
• The format can be the 5-digit NE identity (that is, the values 1 through
65534 inclusive). The system uses the NEid if the NEname is invalid.
• The SID format for the primary OPC is OPCxxxxxP, where xxxxx consists
of five letters and or digits.
• The SID format for the backup OPC is OPCxxxxxB, where xxxxx consists
of five letters and or digits.
SRVEFF
The SRVEFF parameter indicates the effect on service. Possible values are:
• service affecting (SA)
• non-service affecting (NSA)
STATE
The STATE parameter indicates the service state. The valid value is out of
service (OOS).
STBYID
The STBYID parameter indicates the name of the standby OPC (always NA).
Format
The STBYID parameter format consists of up to 20 characters of ASCII text
that meet the syntax restrictions of the AID parameter.
THLEV
The THLEV parameter provides crossed threshold values. This parameter has
the same syntax as the MONVAL parameter. See Table 4-19 for an example of
the MONVAL parameter domains.
TID
The TID parameter indicates the target of a TL1 message.
Format
The TID parameter format is identical to the source identifier (SID) parameter,
and consists of either a TID name, the NE name (NEname), or the NE identity
(NEid).
• The format can be a 20-character name of ASCII text programmed for use
as the TID. The TID can consist of letters, digits, hyphens (-),
underscores (_), and periods (.).
• The format can be the 13-character NE name, if it meets TL1 requirements.
• The format can be the 5-digit NE identity (that is, the values 1 through
65534 inclusive). The system uses the NEid if the NEname is invalid.
• The TID format for the primary OPC is OPCxxxxxP, where xxxxx consists
of five letters and or digits.
• The TID format for the backup OPC is OPCxxxxxB, where xxxxx consists
of five letters and or digits.
Time
The Time parameter indicates the translation time of the TL1 message. See
Table 4-25 for the Time parameter domains.
Format
The Time parameter format consists of three fields separated by colons. This
is the format of the Time parameter:
<hh>:<mm>:<ss>
Table 4-25
Time parameter domains
TIME
The TIME parameter indicates the new time to which the OPC time of day
clock changes. See Table 4-26 for the TIME parameter domains.
Format
The TIME parameter format consists of three fields separated by hyphens.
This is the format of the TIME parameter:
<hh>-<mm>-<ss>
Table 4-26
TIME parameter domains
TMPER
The PM accumulation time period. The possible values are the following:
• 15-MIN
• 1-DAY
TYPEREQ
The TYPEREQ parameter indicates the required types of conditions to
retrieve. Valid types of condition types are:
• NULL (specifying all condition types)
• Specific condition types such as LOS and LOF. See Table 4-8 for a
complete list of the CONDTYPE values.
VLDTY
The PM validity measurement indicates the validity of the PM counts in a day
bin (24 hour period). If all 15-minute bins have their validity flag set to
COMPLD, then the validity flag for the day bin is set to COMPLD. If any of
the 15-minute bins has its validity flag set to PRTL, the corresponding day bin
is also set to PRTL. See Table 4-27 for the VLDTY parameter domains.
The validity flag on a 15-minute bin as well as the day bin is set to PRTL for
one of the following reasons:
• a restart occurs at a network element
• a network element detects a time change of 10 seconds or more
• PM data clears on the network element
• a time switchover occurs (for example, from daylight savings time to
standard time)
• a loss of communication between the OPC and the NE (the OPC cannot
retrieve PM counts from the network element during PM collection)
Table 4-27
VLDTY parameter domains
Acknowledgment responses
The surveillance interface uses two acknowledgment responses:
• Printout Follows
• Not Acknowledged
The Acknowledgment responses indicate that the TL1 request was received by
the OPC. You receive an Acknowledgment response before a TL1 response.
Printout Follows
A response is sent to the originator of the TL1 command within two seconds
after it receives the command. If it is not possible to send a response to the TL1
request in two seconds, then the TL1 task sends a ‘printout follows’
acknowledgment in the following format:
PF^crlf
<
The angle bracket (<) after the lf is a special character that is part of the
message.
The angle bracket (<) after the lf is a special character that is part of the
message.
Error codes
The error codes that can appear in the ‘errcde’ parameter are in Table 4-28.
Table 4-28
Error codes
ERRCDE Description
parameter
Alarm summary
This section summarizes the message types available through the surveillance
interface and discusses message intervals.
Message types
There are two types of TL1 surveillance messages: autonomous and
non-autonomous.
Autonomous messages
The OPC generates autonomous messages as a result of activity on the network
elements, such as alarms, threshold alerts, and warnings. The OPC sends these
messages to the operations system automatically. You do not need to make a
request to receive autonomous messages. Autonomous messages have a
unidirectional data flow between the OPC and the operations system. Only the
surveillance interface generates autonomous messages. The autonomous
message types listed in Table 4-29 exist for alarms and events.
Table 4-29
Autonomous message types
REPT ALM (report alarm) Reports non-environmental alarms with severities of critical, major,
minor, and clear. All other alarms such as warnings, event logs, and PM
threshold crossings are reported with Report Event messages.
REPT ALM ENV (report alarm Reports environmental alarms. Environmental alarms include scan
environment) points, shelf temperature, 48V battery supply, and fan alarms.
REPT COND (report Reports the current standing condition or state associated with
condition) equipments or facilities once per hour. Standing conditions are alarms
of any severity. OPC event logs are not standing conditions and are
therefore not retrieved. Environmental alarms are also not retrieved.
If a network element gets added or deleted, the existing Report
Condition schedule gets cancelled and rescheduled. The new schedule
is based on the new quantity of network elements and the time of the
changes.
REPT EVT (report event) Reports event logs, alarms of severity warning or indeterminate, and
PM threshold alerts. There are two possible formats for this message;
one for alarms/alerts, and the other for event logs.
REPT PM (report Reports PM counts every 15 minutes. Only the non-zero PM counts are
performance monitoring) reported for each network element.
REPT SW (report switch) Reports that an OPC module has switched from an inactive state to an
active state. This switch message occurs in situations such as fiber
cuts, which cause the primary and backup OPCs to lose communication
with each other. This message also reports manual OPC switchover.
Non-autonomous messages
Non-autonomous messages consist of a request message from the operations
system and a response message from the OPC. These messages have a
bidirectional flow between the operations system and the OPC. For example,
the operations system message can be a user request for minor alarms on a
network element, the OPC sends a response message. The non-autonomous
message types in Table 4-30 exist for alarm and event monitoring.
Table 4-30
Non-autonomous message types
ALW-MSG (allow messages) Used to resume the transmission of autonomous messages after they
have been in the inhibit-message mode.
ED-DAT (change OPC date Used to change OPC time, allowing an OS to keep the OPC and NE
and time) time-of-day (TOD) clocks in synchronization with the OS time-of-day
clock.
INIT-REG (initialize register) Used to initialize all of the registers (also referred to as bins) that
contain current, history, or both current and history performance
monitoring (PM) counts.
OPR-EXT-CONT (operate Used to instruct the target network element to operate the specified
external controls) parallel relay output.
RLS-EXT-CONT (release Used to instruct the target network element to release the specified
external controls) parallel relay output.
Table 4-30
Non-autonomous message types (continued)
RTRV-ALM (retrieve alarm) Used to retrieve active alarms with a higher severity than warning. The
response message provides information similar to the Report Alarm
message.
RTRV-COND (retrieve Used to instruct a network element to return the current standing
condition) condition or state associated with one or more specified equipments or
facilities in the target network element. Standing conditions are alarms
of any severity, or threshold crossing alerts provisioned as Warning
alarms. Threshold crossing events and OPC event logs are standing
conditions and therefore not retrieved. Environmental alarms are also
not retrieved.
RTRV-HDR (retrieve header) Used to verify the identifier (name) of the network element specified in
the input message. If you do not specify the source identifier (SID) of
the active network element, you get an error message.
RTRV-PM (retrieve Used to retrieve non-zero PM counts. The response message provides
performance monitoring) information similar to the Report Performance Monitoring message.
RTRV-TH (retrieve Used to instruct the target network element to report the current
performance monitoring threshold level of one or more monitored parameters. The RTRV-TH
threshold) command does not recognize or retrieve “Untimed” intervals.
SET-PMMODE (set Used to set or change the state of PM collection on the OPC.
performance monitoring
mode)
SET-SID (set source identifier) Used to set or change the target identifier of a network element.
SET-TH (set performance Used to instruct the target network element to change
monitoring threshold) performance-monitoring (PM) parameter threshold levels. The OS
receives an autonomous message when a threshold exceeds its set
value.
If the system contains N network elements, the operations system does not
receive N REPT COND messages on the hour. Instead, the operations system
receives N REPT COND messages spread out over the hour with an interval of
60/N minutes. The REPT COND message uses the TL1 connection
establishment time as T0, the time to begin counting towards the next hour.
The REPT COND messages are not based on the actual hour (for example, 12
pm and 1 pm) intervals but on T0 + 1 hour intervals.
From each network element, the PM collector requests the latest 15-minute
counts for each termination class for each network element.
As soon as the PM collector receives the requested data, it stores the data in a
database on the OPC. The PM collector notifies a TL1 process that it has PM
counts for a particular termination class for a specific network element. The
non-zero counts from the 15-minute period are then retrieved from the OPC
database. The operations system then receives the non-zero counts in the form
of the REPT PM message.
The time the PM reports get sent to the operations system depends on several
factors. These factors include the quantity of network elements in the span of
control, the quantity of facilities provisioned, the quantity of non-zero counts,
and the line rate of the connection.
The parameters you enter in the RTRV-PM command form the search criteria.
These search parameters can request one of the following:
• specific facility type (such as OC-48)
• circuit pack
• port (such as G2 port 1)
• PM parameter (such as PathCV)
• value (such as higher than 10)
• direction (Rx or Tx)
• time period (15-MIN or 1-DAY)
• date
• time
Although most parameters specified can use only a single value, date and time,
you can group parameters to retrieve several bins, which need not be
consecutive. For example, you can retrieve bins whose start times were 10:15,
11:45 and 13:30. You can also request a range of bins such as all bins between
10:15 and 11:45 inclusive.
Autonomous messages
This section describes TL1 autonomous messages and the most relevant
parameters of each autonomous message type. Refer to “Message parameters”
and Table 4-2 for a general description of all message parameters.
Refer to “Message associations” later on in this chapter for the entire suite of
network element alarm messages and their TL1 equivalents. Refer also to
Trouble Clearing and Module Replacement, 323-1801-543, for procedures to
clear these alarms.
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-31 for a listing of all valid SCCM and AID values.
Table 4-31
Valid SCCM and AID values for the REPT ALM message
Orderwire 1-OWIG
Table 4-31
Valid SCCM and AID values for the REPT ALM message (continued)
Note: AID Table 4-3 shows the relationship between the position of a circuit pack on the shelf and the
AID for the related equipment and facilities.
Example
Examples of the REPT ALM message are:
92013 96-05-10 04:23:25
A 14449 REPT ALM EQPT
"1-ESIG1-S7:CL,IMPROPRMVL,NSA,05-10,04-23-21,,NA:
\"Circuit pack missing\""
;PF
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-32 for a listing of all valid SCCM and AID values.
Table 4-32
Valid SCCM and AID values for the REPT ALM ENV message
Bay 1
Fan 1-F[1..3]
Note: AID Table 4-3 shows the relationship between the position of a circuit pack on the shelf and the
AID for the related equipment and facilities.
Example
An example of the REPT ALM ENV message is:
92013 96-05-10 04:09:14
* 14412 REPT ALM ENV
"1:MN,HITEMP,05-10,04-09-10,\"High shelf temperature\""
;
No action is required when receiving REPT COND messages since they are
mainly status messages: the standing alarms will have already been reported
(using the REPT ALM message).
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See 4-33 for a listing of all valid SCCM and AID values.
Table 4-33
Valid SCCM and AID values for the REPT COND message
Table 4-33
Valid SCCM and AID values for the REPT COND message (continued)
Table 4-33
Valid SCCM and AID values for the REPT COND message (continued)
Orderwire 1-OWIG
MOSAIC CPG on an OPTera Long Haul Amplifier NE 1-OTRG0-S[1..5], 1-OTRG5-S[6..10]
type 1-OTRG10-S[11..15],
1-OTRG15-S[16..20]
Example
An example of the REPT COND message is:
92013 96-05-10 04:27:41
A 14474 REPT COND OC192
"1:MN,T-AISSP,NSA,05-10,03-45-02,NEND,NA"
;
Output format
The syntax of the REPT EVT alarm/alert message is:
crlf
lf
^^^<sid>^<date>^<time>crlf
A^^<atag>^REPT^EVT^<sccm>crlf
^^^”[<aid>]:<condtype>,<condeff>,<ocrdat>,<ocrtm>,[<locn>],
<dirn>,[<monval>],[<thlev>][,<tmper>]:”\<almmsg>\””crlf
;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-34 for specific parameter details and Table 4-35 for a
listing of all valid SCCM and AID values.
Table 4-34
Specific parameter details
Parameter Details
almmsg For REPT EVT alarm/alert messages, the alarm message value is the first 40
characters of the alarm text as seen on the NE alarm screen.
condtype For REPT EVT log messages, the condition type value is always MISC.
conddescr For REPT EVT log messages, the condition description value is the first 64
characters of the log text as seen in the OPC Event Browser.
Example
An example of the REPT EVT alarm/alert message (warning/indeterminate)
is:
92013 96-05-10 04:28:56
A 14480 REPT EVT EQPT
"1-ESIG1:SYNCCLKA,SC,05-10,04-28-52,,NA,0,0,15-MIN:
\"Timing generation entry to acquire\""
;
Table 4-35
Valid SCCM and AID values for the REPT EVT message
Table 4-35
Valid SCCM and AID values for the REPT EVT message (continued)
Orderwire 1-OWIG
Note: AID Table 4-3 shows the relationship between the position of a circuit pack on the shelf and the
AID for the related equipment and facilities.
Example
An example of the REPT PM message is:
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Tables 4-36, 4-37, 4-38, 4-39, and 4-40 for the range of values
for the various parameters.
Table 4-36
Range of values for REPT PM, ALW-PMREPT, INH-PMREPT, RTRV-PM, and RTRV-TH messages
AID <frame>-<cpgname>-[<port>]
port is only applicable to STS1 path
refer to Table 4-37
MONTM refer to Table 4-39 (default is start of the Last 15-min bin which has been collected by OPC)
Table 4-37
AID values for REPT PM, ALW-PMREPT, INH-PMREPT, RTRV-PM and RTRV-TH messages
ALL ALL — — —
Table 4-38
MONTYPE values for REPT PM, ALM-PMREPT, INH-PMREPT, RTRV-PM and RTRV-TH messages
MONTYPE MONTYPE
Description SCCM (DIRN=ZA) (DIRN=AZ)
Table 4-39
MONDAT, MONTM, AND TMPER values for REPT PM and RTVR-PM messages
Table 4-40
MONLEV and MONVAL values for REPT PM and RTRV-PM messages
Parameter Details
MONLEV The PM level has format LEVEL-DIRECTION where LEVEL is a decimal number
and DIRECTION is UP or DOWN. The PM counts must be greater than or equal
to LEVEL (for up) and less than or equal to LEVEL (for down) before they are
reported. A null value defaults to 1-UP.
MONVAL This is the actual PM count value for the specified time frame sent in response.
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters.The parameters listed in Table 4-41 have restricted values.
Table 4-41
Specific parameter details
Parameter Details
actid The active OPC value is the name of the active OPC as defined during
system commissioning.
stbyid The standby OPC value is always NA given that the active OPC does
not know the status of the inactive OPC.
Example
An example of the REPT SW message is:
92013 96-05-10 05:25:48
A 14696 REPT SW
“OPCM001P,NA”
;
Non-autonomous messages
TL1 non-autonomous messages are described in this section. Refer to
“Message parameters” and Table 4-2 for a general description of all message
parameters. See Table 4-28 for a listing of all error codes.
Note: You must open an administrative session before you use this
message.
Input format
The syntax of the ALW-MSG input message is:
alw-msg-all:<tid>::<ctag>:[<ntfcncde>];crlf
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-42 for specific parameter details.
Parameter Details
Example
An example ALW-MSG normal response output message is:
alw-msg-all:NE1::ctag01;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Tables 4-36, 4-37, and 4-38 for the range of values for the
various parameters.
The ED-DAT command should be used with caution and only when absolutely
necessary. Changing the time affects other applications whose activities and
operations depend on the OPC time. To limit any side effects of changing the
OPC time, the change does not occur immediately after it has been requested.
Instead, the OPC time drifts gradually (at a rate of about 4% for each hour)
until the difference between the OPC Time-of-Day clock and the requested
time has been reduced to zero. A full 30-minute adjustment can take almost 12
hours to complete.
Note 1: When the TID parameter is used in the ED-DAT command, the
message is sent to the specified network element in the OPC span of
control. When the TID parameter is null, the ED-DAT command is sent to
the OPC.
Note 2: When the ED-DAT command is sent to any network element in an
OPC span of control or to the OPC, the time of day changes only on the
active OPC. The inactive OPC time cannot be changed.
Note 3: The time cannot be changed more than 30 minutes from the
current time.
Note 4: While there is a time change request in progress, no additional
time change requests are accepted.
Note 5: If the primary OPC is synchronized to a 1 Hz clock source, it is
not possible to change the OPC time. An attempt to change the OPC time
in this instance results in an error response.
Input format
The syntax of the ED-DAT input message is:
ED-DAT:<tid>::<ctag>::[DATE][,TIME];crlf
Parameter description
Refer to “Message parameters”and Table 4-2 for a general description of all
parameters. The parameters listed in Table 4-43 have restricted values.
Table 4-43
Specific parameter details
Parameter Details
DATE This is the date to which the OPC is to be changed in the form
YY-MM-DD. The year can range from 00 to 99, the month from
00 to 12, and the day from 00 to 31.
TIME This is the time to which the OPC is to be changed in the form
HH-MM-SS. The time is in 24 hour format. The hours can range
from 00 to 23, the minutes from 00 to 59, and the seconds from
00 to 59.
Note: DATE and TIME are optional parameters. If you do not specify the DATE
parameter, the system uses the current date value. If you do not specify the time
parameter, the system uses the current time. When the time change falls into the
next day, you should specify the value of the DATE parameter.
Examples
An example of the ED-DAT normal output response is:
ED-DAT:NE_TID::CTAG12::05-22,09-45;
Note 1: You must open an administrative session before you use this
command.
Note 2: The timeout is 30 minutes from the last Inhibit command with a
different notification code.
Note 3: Inhibited alarms are reported with an INHMSG prefix in response
to report alarm messages (RTRV-ALM) and retrieve condition
(RTRV-COND) messages.
Input format
The syntax of the INH-MSG input message is:
inh-msg-all:<tid>::<ctag>:[<ntfcncde>];crlf
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-44 for specific parameter details.
Table 4-44
Specific parameter details
Parameter Details
Example
An example INH-MSG normal response output message is:
inh-msg-all:NE1::ctag01;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Tables 4-36, 4-37, and 4-38 for the range of values for the
various parameters.
Examples
An example INH-PMREPT normal response output message is:
INH-PMREPT-ALL:NE1::102;
Parameters
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-45 for a description of specific parameter details. See
Table 4-46 for a listing of all valid AID values.
Table 4-45
Specific parameter details
Parameter Details
tmper The valid values of the time period register or bin to be reset are HIS (history), CNT
(current), and BTH (both history and current).
CNT resets the current 15-minute and current day bins on the network element to zero
for all PM types for the specified AID.
HIS resets all history 15-minute and day bins to zero.
BTH resets all bins, current as well as history, to zero.
A null value is taken to mean BTH.
Table 4-46
SCCM and AID values for the INIT-REG command
Examples
An example of the INIT-REG normal response output message to zero all
15-minute PM counts for OPTera Long Haul 1600 [NE1] channel G2) is:
INIT-REG-OPTera LH:NE1:1-B:STEVE1::,,,,BTH;
INIT-REG-OPTera LH:NE1:1-F:STEVE1::,,,,BTH;
The relay contact to operate is determined by the AID value in the command.
Since only one relay contact is implied by a given AID, the contact type
(parameter CONTTYPE) is not supported. The default value of the DUR
parameter is conts.
Input format
The syntax of the OPR-EXT-CONT message is:
OPR-EXT-CONT:<tid>:<aid>:<ctag>::[,<dur>];crlf
Include the comma before the optional DUR parameter as this is a positional
parameter block. The comma is a place holder for a parameter (conttype) not
required in this command.
Normal response output format
The syntax of the OPR-EXT-CONT normal response output message is:
crlf
lf
^^^<sid>^<date>^<time>crlf
M^^<ctag>^COMPLDcrlf
;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-47 for a listing of all valid AID and DUR values.
Table 4-47
Valid AID and DUR values for OPR-EXT-CONT messages
Example
An example of the OPR-EXT-CONT normal response is:
OPR-EXT-CONT:9214:1-ptg2-X2:jps6::,CONTS;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of the
ref parameter. The ref parameter listed in Table 4-48 has restricted values.
Table 4-48
Specific parameter details
Parameter Details
Example
An example of the OPR-SYNCNSW normal response output message is:
OPR-SYNCNSW:WEST_CH1::123::1;
The relay contact to operate is determined by the AID value in the command.
Since only one relay contact is implied by a given AID, the contact type
(parameter CONTTYPE) is not supported. The default value of the DUR
parameter is conts.
Input format
The syntax of the RLS-EXT-CONT message is:
RLS-EXT-CONT:<tid>:<aid>:<ctag>::[,<dur>];crlf
Include the comma before the optional DUR parameter as this is a positional
parameter block. The comma is a place holder for a parameter (conttype) not
required in this command.
Normal response output format
The syntax of the RLS-EXT-CONT normal response output message is:
crlf
lf
^^^<sid>^<date>^<time>crlf
M^^<ctag>^COMPLDcrlf
;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-49 for a listing of all valid AID and DUR values. See
Table 4-28 for a listing of all error codes.
Table 4-49
Valid AID and DUR values for the RLS-EXT-CONT message
Example
An example RLS-EXT-CONT normal message response is:
RLS-EXT-CONT:9214:1-ptg2-X2:jps5::,mntry;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. The ref parameter listed in Table 4-50 has restricted values.
Table 4-50
Specific parameter details
Parameter Details
Examples
An example of the RLS-SYNCNSW normal response output message is:
RLS-SYNCNSW:WEST_CH1::123::1;
Refer to the “Message associations” section later in this chapter for the entire
suite of network element alarms and their TL1 equivalents. For procedures to
clear these alarms refer to Trouble Clearing and Module Replacement,
323-1801-543.
Input format
The syntax of the RTRV-ALM input message is:
RTRV-ALM-<sccm>:<tid>:[<aid>]:<ctag>[::[<ntfcncde>],
[<condtype>],[<srveff>],[<locn>],[<dirn>]];crlf
Parameter description
Refer to “Message associations” and Table 4-2 for a general description of all
parameters.
The access identifier is optional. Use a null value to request the retrieval of
states and conditions for all the AIDs of the type defined by the SCCM. When
the SCCM value is set to ALL, conditions and states are retrieved for all the
addressed entities. When the SCCM value is ALL or COM, the null value for
the AID must be used. Parameter grouping is not supported. See Table 4-51 for
a listing of all valid SCCMs and AIDs.
Table 4-51
Valid SCCM and AID values for the RTRV-ALM message
Table 4-51
Valid SCCM and AID values for the RTRV-ALM message (continued)
Note: AID Table 4-3 shows the relationship between the position of a circuit pack on the shelf and the
AID for the related equipment and facilities.
Examples
An example of the RTRV-ALM normal response output message is:
RTRV-ALM-OC192:NE_TID:1-A:CTAG06::MN;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. The access identifier is optional. Use a null value to request the
retrieval of states and conditions for all the environmental AIDs. Parameter
grouping is not supported. See Table 4-52 for a listing of all valid SCCMs and
AIDs.
Table 4-52
Valid SCCM and AID values for the RTRV-ALM-ENV message
Bay 1
Fan 1-F[1..3]
Note: AID Table 4-3 shows the relationship between the position of a circuit pack on the shelf and the
AID for the related equipment and facilities.
Examples
An example of the RTRV-ALM-ENV normal response output message is:
RTRV-ALM-ENV:NE_TID::CTAG08;
Note: Threshold crossing events and OPC event logs are not considered
standing conditions and are not retrieved. Environmental alarms are also
not retrieved.
Input format
The syntax of the RTRV-COND message is:
RTRV-COND-<sccm>:<tid>:[<aid>]:<ctag>::[<typereq>],[<locn>],
[<dirn>][,<tmper>],;crlf
Note: This block occurs at least once, and it can contain multiples.
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. The typereq parameter is detailed in Table 4-53.
The access identifier is optional. Use a null value to request the retrieval of
states and conditions for all the AIDs of the type defined by the SCCM. When
the SCCM is ALL, the retrieval of conditions and states for all the addressable
entities occurs. When the SCCM value is ALL or COM, the null value for the
AID must be used. Parameter grouping is not supported. See Table 4-54 for a
listing of all valid SCCMs and AIDs.
Table 4-53
Specific parameter details
Parameter Details
tmper The value of tmper identifies the accumulation time period. The
format for this is VAL-UN, where VAL is value of time and UN is the
same unit. Parameter grouping is not supported.
The valid accumulation time periods for PM parameters are 1-DAY
and 15-MIN.
Table 4-54
Valid SCCM and AID values for the RTRV-COND message
Table 4-54
Valid SCCM and AID values for the RTRV-COND message (continued)
MOR 1-MORG0-S1
1-MORG1-S2
1-MORG2-S3
1-MORG3-S4
Note: AID Table 4-3 shows the relationship between the position of a circuit pack on the shelf and the
AID for the related equipment and facilities.
Examples
An example of the RTRV-COND normal response output message is:
RTRV-COND-ALL:NE_TID::CTAG10;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters.
Examples
An example of the RTRV-HDR normal response output message is:
RTRV-HDR:NE_TID::CTAG03;
An example of the RTRV-HDR error response output message when the TID
value is a null value:
RTRV-HDR:::CTAG04;
Note: This example illustrates that the OPC will use the TID which first
appears in the tidmap list. In this example, the TID 92013 applies to the
OPTera Long Haul 1600 network element and the OPC.
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Tables 4-36, 4-37, 4-38, 4-39, and 4-40 for the range of values
for the various parameters.
Note: As there were no path code violations for the time periods starting
08:15 and 09:00, these two time periods were not reported.
Since the state of PM collection is set for all network elements in the entire
span of control, the TID and AID usually associated with TL1 commands have
no meaning and must be null. If the SCCM is specified as EQPT, the protection
switching parameters and/or physical PM parameters (laser bias current,
optical power) can be affected for all OCn (n = 12, 48, 192) and OPTera Long
Haul 1600 facility types which support such parameters. To distinguish
between the two cases, two modetypes, PROT and PHYS for the protection
switching counts and physical PM counts, respectively, have been defined.
These two modetypes have not been defined in Telcordia standards.
Input format
The syntax of the RTRV-PMMODE message is:
RTRV-PMMODE-<sccm>:::<ctag>::[<locn>],[<modetype>],
[<pmstate>];
The response block has the following format. The normal response must
contain at least one occurrence of such a block:
^^^“<aidtype>:<locn>,<modetype>,<pmstate>”crlf
;
Parameters
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-55 for specific parameter details.
Table 4-55
Specific parameter details for RTRV-PMMODE
Parameter Details
modetype The PM type should be turned ON or OFF. The parameters supported are:
ALL all parameters which apply for the SCCM specified
P (all path parameters)
L (all line parameters)
S (all section parameters)
PROT (all protection switching parameters)
PROT-P (all path protection switching parameters)
PROT-L (all line protection switching parameters)
PROT-S (all ring protection switching parameters)
PHYS (all physical PM parameters)
A null value defaults to ALL.
Example
An example of RTRV-PMMODE error output message is:
RTRV-PMMODE-oc48:::1234::nend,1,junk;
The response block has the following format. The normal response must
contain at least one occurrence of such a block:
^^^”<aid>,<aidtype>:<montype>,<locn>,<dirn>,<thlev>,
<tmper>”crlf
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Tables 4-36, 4-37, 4-38, 4-39, and 4-40 for the range of values
for the various parameters. See Table 4-56 for parameter details specific to the
RTRV-TH command.
Table 4-56
Specific parameter details
Parameter Details
dirn The direction parameter is sent only in the response and cannot be specified in the
request. The thresholds for both directions, transmit and receive, are sent in the
response if they are available. The receive and transmit directions are monitored only for
DS3 path PM parameters.
locn Only the NEND (near end) thresholds are retrieved. A null value defaults to NEND.
Note: The RTRV-TH command does not provide the option to select the direction (ZA
or AZ), and both are retrieved, provided that either direction has the same TMPER value.
If neither of the TMPER values matches the value specified in the command, the
command fails and a DENY message is returned.
Note: The “untimed” interval that is available on the network element is not supported by this command.
Examples
The command to retrieve the 15-minute path coding violation (CVP) of OC12
facility G4 STS channel 3 (12G4-3), near end (NEND) in NE1 is:
RTRV-TH-STS1:NE1:1-12G4-3:Steve1::CVP,NEND,15-MIN;
Since the direction (DIRN) is not specified in the command, for the OC12 path
both the transmit and receive threshold values are retrieved with a single
command. For example, the command to retrieve the daily path severe error
seconds (SESP) thresholds of OC12 facility G4 STS channel 2 (12G4-2), near
end (NEND) in NE1 is:
RTRV-TH-STS1:NE1::Steve1:1-12G4-2:SESP,NEND,1-DAY;
If both time the transmit and receive thresholds are set to a time period other
than the one specified in the command, an error response is returned. In this
example, only if both thresholds are set to a time period other than 1-DAY, the
following error response is sent:
NE1 93-08-13 15:23:27
M STEVE1 DENY
SROF
/*Invalid TMPER set for 1-DAY threshold.*/
Since the state of PM collection is set for all network elements in the entire
span of control, the TID and AID usually associated with TL1 commands have
no meaning and must be null. If the SCCM is specified as EQPT, the protection
switching parameters and/or physical PM parameters (laser bias current,
optical power) can be affected for all OCn (n = 3, 12, 48, 192) and OPTera
Long Haul 1600 facility types which support such parameters. To distinguish
between the two cases, two modetypes, PROT and PHYS for the protection
switching counts and physical PM counts, respectively, have been defined.
These two modetypes have not been defined in Telcordia standards.
Input format
The syntax of the SET-PMMODE message is:
SET-PMMODE-<sccm>:::<ctag>::[<locn>],[<modetype>],[<pmstate>];
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-57 for a listing of all valid values.
Table 4-57
Specific parameter details for SET-PMMODE
Parameters Details
locn The location is either NEND (near end), FEND (far end), or BTH (both near and far end).
A null value defaults to all that apply.
modetype The PM type should be turned ON or OFF. The parameters supported are:
ALL all parameters which apply for the SCCM specified
P (all path parameters)
L (all line parameters)
S (all section parameters)
PROT (all protection switching parameters)
PROT-P (all path protection switching parameters)
PROT-L (all line protection switching parameters)
PROT-S (all ring protection switching parameters)
PHYS (all physical PM parameters)
A null value defaults to ALL.
pmstate The PM collection state is either ON or OFF. A null value defaults to ON.
Examples
An example of a normal response message to turn PM collection on for a
OPTera Long Haul 1600 line, near end is:
SET-PMMODE-OC192:::1234::nend,l,on;
Note: The procedure to set a TL1 TID for the surveillance or provisioning
interfaces from an operations system is described in Chapter 1,
“Introduction to TL1”.
Input format
The syntax of the Set Source Identifier input message is:
SET-SID:<tid>::<ctag>::<sid>;crlf
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. The parameters listed in Table 4-58 have restricted values.
Table 4-58
Specific parameter details
Parameter Details
Examples
An example of the Set Source Identifier normal output message is:
SET-SID:92013::CTAG01::NE_TID;
Parameter description
Refer to “Message parameters” and Table 4-2 for a general description of all
parameters. See Table 4-59 for the SCCM and AID range of values.
Table 4-59
Specific parameter details
Parameter Details
dirn The direction can be AZ (transmit) or ZA (receive). The value of DIRN depends on
MONTYPE. A null value defaults to ZA (receive).
locn Only the NEND (near end) PM counts are monitored. A null value defaults to NEND.
montype The PM type is used to specify which threshold should be set (for example, CVL and
SESS). MONTYPE must not be null.
sccm The second command code modifier cannot be set to ALL and it must not be null.
thlev The new threshold value (positive integer) for the target PM type (MONTYPE). THLEV
must not be null.
tmper The time period is either 15-MIN or 1-DAY. A null value defaults to 15-MIN. The
“untimed” interval is not supported by this command.
If TMPER is specified as 15-MIN, the “timed” interval is set for threshold 1 on the network
element, possibly changing the definition of the time period (day or untimed), which can
have been set by some other means (for example, on the NE UI), to “timed”.
If TMPER is specified as 1-DAY, the “day” interval is set for threshold 2 on the network
element, possibly changing the definition of the time period (timed or untimed), which
can have been set by some other means (for example, on the NE UI), to “day”.
Table 4-60
SCCM and AID values for the SET-TH command
Table 4-60
SCCM and AID values for the SET-TH command (continued)
Example
The command to set the 15-minute line coding violation (CVL) of OC12
facility G4 near end (NEND), receive direction (ZA) in NE1 to 13000 is:
SET-TH-OC12:NE1:1-12G4:Steve1::CVL,13000,NEND,ZA,15-MIN;
Message associations
The tables in this part of the chapter permit the cross-reference of the
OPTera Long Haul 1600 network element alarm points to their TL1 equivalent
messages.
Alarm tables
The alarms listed in Table 4-61 provide the association and TL1 parameters of
NE alarms reported autonomously by means of REPT ALM,
REPT ALM ENV, REPT COND, and REPT EVT messages, and on demand
through RTRV-ALM, RTRV-ALM-ENV, and RTRV-COND commands.
Refer to Trouble Clearing and Module Replacement, 323-1801-543, for
procedures to clear these alarms.
REPT EVT messages with an SCCM value of COM and a condtype value of
MISC are reporting event logs. Event logs reported through TL1 are the same
as the logs that can be viewed through the OPC Event Browser tool. A
complete list and description of event logs can be found in Log Reference,
323-1801-840.
Table 4-61
List of TL1 alarm tables
Equipment alarms
Table 4-62
TL1 alarm table for facilities
Table 4-63
TL1 alarm table for equipment
Table 4-64
TL1 alarm table for alerts
Table 4-65 lists SCCM and AID values for software equipment alarms. Table
4-66 correlates software equipment alarms to TL1 messages.
Table 4-65
SCCM and AID values for software equipment alarms
SCCM AID
EQPT 1-ESIG[1-S7,2-S8]
1-OWIG
1-SCP-S6
1-MORG0-S1, 1-MORG1-S2, 1-MORG2-S3, 1-MORG3-S4
1-48G[4..19]-S[5..20]
1-48G[5,6,8,9]-S[6,7,9,10]
1-48G[10,11,13,14]-S[11,12,14,15]
1-48G[15,16,18,19]-S[16,17,19,20]
1-[D..S]
1-D[E,W]-S[5,6]
1-E[E,W]-S[7,8]
1-F[E,W]-S[9,10]
1-G[E,W]-S[11,12]
1-H[E,W]-S[13,14]
1-I[E,W]-S[15,16]
1-J[E,W]-S[17,18]
1-K[E,W]-S[19,20]
1-G-S8
1-L-S13
1-Q-S181-L-S13
1-Q-S18
1-TDCG1-S4A
1-TDCG2-S4B
1-OTRG0-S[1..5]
1-OTRG5-S[6..10]
1-OTRG10-S[11..15]]
1-OTRG15-S[16..20]
Table 4-66
Software equipment alarms
Table 4-67
SCCM and AID values for common equipment alarms
SCCM AID
COM NULL
EQPT 1-FC-S[1..10]
Table 4-68
Common equipment alarms
Manual area address dropped for m nsa REPT ALM MANAADDRDRP MN NSA NA
area
Table 4-69
SCCM and AID values for maintenance interface equipment alarms
SCCM AID
EQPT 1-MIU-S9
Table 4-70
Maintenance interface equipment alarms
Table 4-71
SCCM and AID values for message exchange equipment alarms
SCCM AID
Table 4-72
Message exchange equipment alarms
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
SCCM AID
EQPT 1-OWIG
Table 4-74
Orderwire equipment alarms
SCCM AID
EQPT 1-OPC
1-OPC-S[3,5,12]
Table 4-76
OPC equipment alarms
Table 4-76
OPC equipment alarms (continued)
Table 4-77
SCCM and AID values for parallel telemetry equipment alarms
SCCM AID
EQPT 1-PTG1-S13
1-PTG2-S14
Table 4-78
Parallel telemetry equipment alarms
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
Table 4-79
SCCM and AID values for shelf controller equipment alarms
SCCM AID
EQPT 1-SCP-S6
Table 4-80
Shelf controller equipment alarms
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
Table 4-81
SCCM and AID values for external synchronization interfaces (ESI) equipment
alarms
SCCM AID
EQPT 1-ESIG1-S7
1-ESIG2-S8
Table 4-82
External synchronization interface equipment alarms
Table 4-82
External synchronization interface equipment alarms (continued)
Table 4-83
SCCM and AID values for OC-192 WT/XR/TR equipment alarms
Application SCCM AID
10G WT transport facility at an OPTera EQPT 1-D-S5, 1-E-S6, 1-F-S7, 1-G-S8,1-H-S9, 1-I-S10,
Long Haul 1600 Repeater 1-J-S11, 1-K-S12, 1-L-S13, 1-M-S14, 1-N-S15,
1-O-S16, 1-P-S17, 1-Q-S18, 1-R-S19, 1-S-S20
Table 4-84
Timing Distribution Card equipment alarms
Network element alarm TL1 representation of the network element alarm
Table 4-85
OC-192 WT/XR/TR equipment alarms
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
SCCM AID
EQPT 1-48G[4..19]-S[5..20]
1-48G[5,6,8,9]-S[6,7,9,10]
1-48G[10,11,13,14]-S[11,12,14,15]
1-48G[15,16,18,19]-S[16,17,19,20]
Table 4-87
OC-48 WT and TR equipment alarms
Table 4-89
MOR Plus equipment alarms
Network element alarm TL1 representation of the network element alarm
Table 4-90
SCCM and AID values for external synchronization interface (ESI) facility alarms
SCCM AID
T1 1-REF[1..6]
1-BITS[A,B]
1-TRG[1,2]-[1,2]
Table 4-91
External synchronization interface facility alarms
Alarm text Sev Serv TL1 message CONDTYPE NTFCN SRV DIRN
code CDE EFF
Note: The TL1 parameter LOCN contains NEND for external synchronization interface (ESI) facility
alarms.
Table 4-92
SCCM and AID values for OC-192 facility alarms
Table 4-93
OC-192 facility alarms
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
Far end protection line fail m nsa REPT ALM FEPRLF MN NSA ZA
Table 4-93
OC-192 facility alarms (continued)
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
Table 4-94
SCCM and AID values for OC-48 facility alarms
SCCM AID
OC48 1-48G[4..19
1-48G[5,6,8,9]
1-48G[10,11,13,14]
1-48G[15,16,18,19]
Table 4-95
OC-48 facility alarms
Far end protection line fail m nsa REPT ALM FEPRLF MN NSA NA
Table 4-95
OC-48 facility alarms (continued)
Note 1: The TL1 parameter NTFCNCDE is not used in REPT EVT messages. The CONDEFF
parameter is used instead of NTFCNCDE with a value of SC for warnings.
Note 2: The TL1 parameter SRVEFF is not used in REPT EVT messages.
Table 4-97
MOR Plus facility alarms
Network element alarm TL1 representation of the network element alarm
Table 4-98
SCCM and AID values for common equipment PM facility alarms
SCCM AID
OC192 1-[D..S]
1-D[E,W], 1-E[E,W],
1-F[E,W], 1-G[E,W],
1-H[E,W], 1-I[E,W],
1-J[E,W], 1-K[E,W]
1-G
1-L
1-Q
OC48 1-48G[4..19
1-48G[5,6,8,9]
1-48G[10,11,13,14]
1-48G[15,16,18,19]
Table 4-99
Common equipment PM facility alarms
Table 4-100
SCCM and AID values for RLM facility alarms
Table 4-101
RLM facility alarms
Table 4-102
SCCM and AID values for common equipment environmental alarms
SCCM AID
ENV 1
1-B[A,B]
1-BF[A,B]
1-F[1..3]
Table 4-103
Common equipment environmental alarms
Table 4-103
Common equipment environmental alarms (continued)
48V battery A CE supply fail m nsa REPT ALM BATTERY MN NSA NULL
48V battery B CE supply fail m nsa REPT ALM BATTERY MN NSA NULL
Table 4-104
SCCM and AID values for parallel telemetry environmental alarms
SCCM AID
ENV 1-PTG1-S[1..32],
1-PTG2-S[1..32]
Table 4-105
Parallel telemetry environmental alarms
Alarm text Sev Serv TL1 messages CONDTYPE NTFCN SRV DIRN
code CDE EFF
Table 4-106
SCCM and AID values for ESI alerts
SCCM AID
EQPT 1-ESIG[1-S7,2-S8]
1-SW[A-S14,B-S15]
T1 1-REF[1..6]
1-BITSA
1-BITSB
Table 4-107
ESI alerts
Alarm text Sev Serv TL1 messages CONDTYPE COND SRV DIRN
code DEF EFF
SCCM AID
Table 4-109
Message exchange alerts
Table 4-110
SCCM and AID values for ESI facility alerts
SCCM AID
T1 1-REF[1..6]
1-BITSA
1-BITSB
Table 4-111
ESI facility alerts
Alarm text Sev Serv TL1 messages CONDTYPE COND SRV DIRN
code DEF EFF
SCCM AID
OC48 1-48G[4..19
1-48G[5,6,8,9]
1-48G[10,11,13,14]
1-48G[15,16,18,19]
STS1 1-48G[1..8]-[1..48]
1-192G[D..S]-[1..192]
Table 4-113
Common equipment PM alerts
Table 4-113
Common equipment PM alerts (continued)
TL1 commissioning 5-
The operations controller (OPC) supports Transaction Language 1 (TL1)
communications over an X.25 connection at the OPC X.25 port. The default
configuration of the OPC X.25 port is for X.25 communications. On the legacy
OPC, X.25 is configured on port B. The OPC also supports TL1
communications over Transmission Control Protocol/Internet Protocol
(TCP/IP) using an Ethernet connection on the OPC faceplate.
This chapter describes how to configure the OPC X.25 port for TL1
communications over X.25, how to configure TL1 over TCP/IP, and how to
access TL1 interfaces through the OPC. It also describes how to configure and
enable TL1 Interface Router Service.
To configure the X.25 as an X.25/TL1 interface, the OPC X.25 port must have
no connections. To configure the OPC X.25 port for X.25 use, establish a
terminal session through the OPC Ethernet port or through an rlogin session
from a network element.
The preferred combination of connections from the OSS to the gateway OPC
are as follows:
• If a single gateway OPC manages four spans of control (SOCs): then have
one OSS connection to the primary router service and one OSS connection
to the backup router service on the gateway OPC.
• If a single gateway OPC manages only one SOC: then the OSS can have
four connections to the primary router service and four connections to the
backup router service on the gateway OPC.
Action Details
Defining and enabling X.25 communications on the OPC X.25 port Procedure 5-2
Action Details
Defining and enabling X.25 communications on the OPC X.25 port Procedure 5-2
Action Details
Perform the procedure in Table 5-4 to access TL1 interfaces through the OPC
UNIX shell:
Table 5-4
Action Details
Accessing and exiting TL1 interfaces through the UNIX shell tool Procedure 5-6
Perform the procedure in Table 5-5 to configure and enable TL1 Interface
Router Service over X.25 or TCP/IP:
Table 5-5
Action Details
Configuring and enabling the TL1 Interface Router Service over Procedure 5-7
X.25 or TCP/IP
Procedure 5-1
Completing an X.25 worksheet
Use this procedure to complete an X.25 worksheet. Make copies of the
worksheet from the sample worksheet on page 5-8 to work on. You need the
information in the worksheet to complete Procedure 5-2, “Defining and
enabling X.25 communications on the OPC X.25 port.”
Procedure tasks
• Fill out the X.25 worksheet with your requested values (step 1).
• Obtain the listing of the X.25 parameters for your connection from your service provider (step 7).
• Fill out the X.25 worksheet with the actual service values from your service provider (step 8).
Expected results
• A completed X.25 worksheet.
• If the expected results do not occur:
— Review steps 1 through 5 to be sure you have all your requested values.
— Contact your service provider for any actual service values you are missing.
—continued—
Action
Step Action
1 Determine which CCITT X.25 recommendation you want to use for your
connection (that is, 1980 or 1984). Record this value in the “Requested value”
column of the X.25 worksheet for the Network name parameter.
2 Determine the speed of service you want for your receiver and transmitter.
Record these values in the “Requested value” column of the X.25 worksheet.
Record the default inbound throughput class (speed of the receiver) and the
default outbound throughput class (speed of the transmitter) parameters. The
throughput classes supported by the OPC are in the following table.
11 (default) 19200
10 9600
9 4800
8 2400
7 1200
3 Determine the quantity and type of virtual circuits you require and record
these values in the “Requested value” column of the X.25 worksheet for the
following parameters: Maximum number of circuits allowed, Number of
inbound SVCs, Number of SVCs, and Number of outbound SVCs.
The OPC supports a maximum of 16 virtual circuits. The circuits include:
SVCs (two-way switched virtual circuits), IVCs (incoming virtual circuits), and
OVCs (outgoing virtual circuits). The OPC does not support PVCs
(permanent virtual circuits).
As a general guideline, TL1 requires one SVC or IVC for each TL1 session,
and X.3 PAD requires one SVC or IVC for each connection. See External
Interface Configuration Procedures, 323-1801-302 for more information on
X.3 PAD.
4 Determine which facilities you require (that is, flow control negotiation,
throughput class negotiation, fast select, and reverse charge acceptance).
See the X.25 parameter description, which begins on page 5-10, for an
explanation of these facilities. Record the values in the “Requested value”
column of the X.25 worksheet.
—continued—
Step Action
5 Determine if you require any specific values for the rest of the X.25
parameters (see the X.25 parameter description, which begins on page
5-10). Note that the OPC default values are not necessarily the same as your
service provider’s default values. Record any requested values in the
“Requested value” column of the X.25 worksheet for the appropriate
parameters.
6 Contact your service provider and request an X.25 connection. You must
provide the following information from step 1 to step 5 to the service provider:
• CCITT X.25 recommendation (1980 or 1984)
• speed of service (throughput class for receiver and transmitter)
• quantity and type of virtual circuits
• any required facilities
• any specific values for the rest of the X.25 parameters
7 Obtain the listing of the X.25 parameters for your connection from your
service provider.
8 Use the information from the X.25 parameter listing to complete the “Actual
service value” column in the X.25 worksheet for all parameters (see the
worksheet on page 5-8).
Note: Record all values provided by your service provider in the worksheet’s
“Actual service value” column. Even if you did not request a specific value for
some parameters, the OPC default might not be the same as your service
provider’s default. For the X.25 connection to function properly, use the
service provider’s value.
—continued—
X.25 worksheet
The X.25 worksheet lists all relevant X.25 parameters, and provides space in
which you can record both your required values and the actual service value.
Shaded areas indicate that the column does not apply to that parameter.
Global parameters
Level 2 parameters
Level 3 parameters
Number of SVCs 0
—continued—
For the X.25 connection to function properly, you must use the values provided
by your service provider. Even if you do not request a specific value for some
parameters, the OPC default might not be the same as your service provider’s
default. Use the service provider’s default value.
Global parameters
This section describes the global parameters.
X.121 Address
Obtain the X.121 address from your service provider. The X.121 is the address
of your X.25 connection. There is no default value. The X.121 address can be
a maximum of 10 digits in length. This parameter has the abbreviation “x.121”
in the X.25 initialization file.
X.121 Packet Address
The X.121 packet address is the same as the X.121 address. Obtain the X.121
packet address from your service provider. There is no default value. The
X.121 packet address can be a maximum of 15 digits in length. This parameter
has the abbreviation “x.121_packetaddr” in the X.25 initialization file.
Device File Name
The device file name is the name of the device special file for X.25 on the OPC.
The default file name is /dev/x25_0. Use the default file name. This parameter
has the abbreviation “device” in the X.25 initialization file.
Programmatic Access Name
This is the name that application programs (for example, X.3 PAD) use to
identify the X.25 interface. The default name is scc0. Do not change the default
name. This parameter has the abbreviation “name” in the X.25 initialization
file.
—continued—
Level 2 parameters
The following sections describe the level 2 parameters.
Level 2 window size
The level 2 window size defines the number of frames the system can send
before receiving an acknowledgment. The valid range is 1 to 7 and the default
value is 7. This parameter has the abbreviation “l2window” in the X.25
initialization file.
Retransmission timer (T1)
The retransmission timer (T1 timer) specifies the amount of time to wait for
acknowledgment of a frame. The valid range is 1 000 to 12 000 msec and the
default value is 3 000 msec. This parameter has the abbreviation “t1” in the
X.25 initialization file.
Idle timer (T3)
The idle timer (T3 timer) specifies the amount of time the X.25 connection can
be idle before it disconnects. The value must be a multiple of 1 000 msec. If it
is not, the value rounds up. A value of 0 disables the timer. The connection will
never disconnect if the timer disables. The maximum value is 13 000 000
msec. The default value is 60 000 msec. The idle timer should be greater than
the product of the retransmission timer and the number of retransmissions
allowed (T1xN2). This parameter has the abbreviation “t3” in the X.25
initialization file.
Idle probe timer (T4)
After the time specified by the idle probe timer (T4 timer) has elapsed, the
system sends a message to check the integrity of the X.25 connection. The idle
probe timer must be less than or equal to the idle timer. The default value is 0
msec. When the default value is 0, the idle probe timer is off and the
verification message does not get sent. This parameter has the abbreviation
“t4” in the X.25 initialization file.
Note: If the T4 timer is in a disabled state, ensure that the data circuit is
providing a “keep alive signal”. Without the “keep alive signal”, the OPC
drops the connection after a specified time interval (typically 60 seconds).
—continued—
Level 3 parameters
The following sections describe the level 3 parameters.
Network name
This parameter specifies the version of the X.25 CCITT recommendation used
for your connection. The default version is DTE_84. Version DTE_80 is also
available. The recommended version is the default version. This parameter has
the abbreviation “networktype” in the X.25 initialization file.
Flow control negotiation
If flow control negotiation is on, you can negotiate packet size and window
size. If flow control negotiation is off you cannot negotiate packet size or
window size. The default is off. This parameter has the abbreviation
“flowcontrol” in the X.25 initialization file.
Throughput class negotiation
Depending on certain conditions, the service provider might not be able to
support your requested connection speed. If throughput class negotiation is on,
negotiation for different connection speeds can occur. If throughput class
negotiation is off, negotiation for different connection speeds cannot occur.
The default is off. This parameter has the abbreviation “thruputclass” in the
X.25 initialization file.
Fast select
If fast select is enabled, it is possible to send data with the call request packet.
If fast select is disabled, it is not possible to send data with the call request
packet. Disable is the default value. This parameter has the abbreviation
“fast_select_accept” in the X.25 initialization file.
—continued—
Note: The total quantity of IVCs, SVCs, and OVCs cannot exceed 16.
Number of SVCs
This parameter defines the maximum number of two-way SVCs. The default
is 0. This parameter is a part of the starting LCI parameter in the X.25
initialization file. (See the following description of the starting LCI parameter
for more details.)
Note: The total quantity of IVCs, SVCs, and OVCs cannot exceed 16.
Number of outbound SVCs
This parameter defines the maximum number of outbound SVCs. The default
is 0. This parameter is a part of the starting LCI parameter in the X.25
initialization file. (See the following description of the starting LCI parameter
for more details.)
Note: The total quantity of IVCs, SVCs, and OVCs cannot exceed 16.
Starting LCI
Use this parameter to assign LCIs to the virtual circuits. The valid range is 1 to
4095. The default is 1. You must define a unique LCI for each type of virtual
circuit that used. This parameter has the abbreviation “lci” in the X.25
initialization file and the defined information appears in tabular format. The
LCI number, and the type and number of virtual circuits are in the list.
—end—
Procedure 5-2
Defining and enabling X.25 communications on the
OPC X.25 port
Use this procedure to define the X.25 configuration parameters on the OPC
X.25 port. The Port configuration from the OPC described in this procedure
uses the TL1 configuration tool. This tool is an interactive program that
displays menus and prompts to guide you through the process of specifying
configuration parameters. This procedure tells you how to start the program
with the config_TL1 command in the UNIX shell. After you start the program,
it prompts you to supply the necessary parameter values. If the program
terminates abnormally, it might create a configuration file that does not support
X.25 communications. If this happens you must reexecute the following
procedure from the beginning. X.25 configuration parameters on the OPC
X.25 port can also be defined through the OPC UI Port configuration tool.
Procedure tasks
• Log in to the OPC (step 1).
• Configure an X.25 port (step 5).
• Change the X.25 parameters (step 16).
• Create the configuration file (step 74).
• Enable X.25 (step 75).
Expected results
• You will define X.25 parameters and enable X.25.
• If the expected results do not occur:
— Make sure that you have a userID and password at the root or admin class level.
— Make sure that you have thoroughly completed the X.25 worksheet.
— Review the command conventions described in OPC User Interface Description, 323-1801-196.
—continued—
1 Port Configuration
2 Virtual Circuit Profile Configuration
3 Restart TL1 Session Manager
4 Query Active TL1 Sessions
5 Configure OC-3 TL1 Router over X.25
6 TL1 Interface Router Service Configuration
7 Configure TL1 Over TCP/IP (Enhancements)
8 Configure TL1 AID for High Speed Optics
9 Exit
Step Action
The “opc>” prompt appears on the UNIX shell. This is the end of the
procedure.
Configure an X.25 port
5 Configure an X.25 port from the TL1 Configuration Main Menu, by entering:
1 ↵
The X.25 Configuration Main Menu appears.
************************************
* X.25 Configuration Main Menu *
************************************
1 Query Configuration
2 Configure X.25
3 Unconfigure a service
4 View config_port_log file
8 Return to Main menu
9 Exit
Step Action
Step Action
Step Action
18 Determine that you have the information required to properly configure the
X.25 parameters.
The following messages and prompts appear.
To properly configure X.25 you MUST know the following
information:
X.121 Address
Device File (/dev/x25_?)
X.25 Programmatic Access Name
Circuit Table Definition
Do you wish to begin configuring X.25 parameter values?
[y/n]:
Note: The circuit table definition is the quantity and type of virtual circuits
(IVCs, SVCs, and OVCs), and their associated starting logical channel
identifiers (LCIs).
19 Confirm the configuration of X.25 parameters, by entering:
y↵
The X.25 parameter menu appears.
1 Global parameters
2 Level 2 parameters
3 Level 3 parameters
4 Display all parameters
5 Exit configuration and create file
6 Abort configuration program; file will not be created
Enter selection:
20 Select one of the following actions:
Step Action
Enter selection:
22 Modify the Global Parameters, by entering:
1↵
Each of the Global parameters appears in turn. You have the opportunity to
enter a value, or to accept the default value. To accept the default value press
the Return key.
The following message appears prompting you to enter the X.121 address.
Enter the X.25 values below; type ‘quit’ to return to menu
23 Enter the X.121 address and press the Return key.
A message appears. The message asks if the X.121 packet address is the
same.
24 Confirm that the X.121 packet address is the same as the X.121 address, by
entering:
y↵
A message appears prompting you to enter the device file name.
25 Use the default device file name (/dev/x25_0), to do this press:
↵
A message appears prompting you to enter the programmatic access name.
—continued—
Step Action
26 Use the default programmatic access name (scc0), by pressing the Return
key.
The Global parameters appear in a list. The values you entered appear in the
square brackets that follow the parameter name. The Global parameter menu
follows the Global parameter listing.
27 Determine whether or not the Global parameters match the values in your
X.25 worksheet.
Enter selection:
—continued—
Step Action
Step Action
Enter selection:
40 Modify the Level 3 parameters, by entering:
1↵
The following message appears. The message asks you to enter the network
name.
Enter the Level 3 values below; type ‘quit’ to return to
menu
—continued—
Step Action
Step Action
Step Action
52 Enter the default inbound packet size and press the Return key.
A message appears. The message asks you to enter the default outbound
packet size.
53 Enter the default outbound packet size and press the Return key.
A message appears. The message asks if you to enter the default inbound
window size.
54 Enter the default inbound window size and press the Return key.
A message appears. The message asks you to enter the default outbound
window size.
55 Enter the default outbound window size and press the Return key.
A message appears. The message asks you to enter the default inbound
throughput class.
56 Enter the default inbound throughput class and press the Return key.
A message appears. The message asks you to enter the default outbound
throughput class.
57 Enter the default outbound throughput class and press the Return key.
A message appears. The message asks you to enter the negotiation limit for
inbound packet size.
58 Enter the negotiation limit for inbound packet size and press the Return key.
Note: If flow control negotiation is off, the OPC ignores any value you enter
for this parameter.
A message appears. The message asks you to enter the negotiation limit for
outbound packet size.
59 Enter the negotiation limit for outbound packet size and press the Return key.
Note: If flow control negotiation is off, the OPC ignores any value you enter
for this parameter.
A message appears. The message asks you to enter the negotiation limit for
inbound window size.
—continued—
Step Action
60 Enter the negotiation limit for inbound window size and press the Return key.
Note: If flow control negotiation is off, the OPC ignores any value you enter
for this parameter.
A message appears. The message asks you to enter the negotiation limit for
outbound window size.
61 Enter the negotiation limit for outbound window size and press the Return
key.
Note: If flow control negotiation is off, the OPC ignores any value you enter
for this parameter.
A message appears. The message asks you to enter the negotiation limit for
inbound throughput class.
62 Enter the negotiation limit for inbound throughput class and press the Return
key.
Note: If throughput class negotiation is off, the OPC ignores any value you
enter for this parameter.
A message appears. The message asks you to enter the negotiation limit for
outbound throughput class.
63 Enter the negotiation limit for outbound throughput class and press the
Return key.
Note: If throughput class negotiation is off, the OPC ignores any value you
enter for this parameter.
A message appears. The message asks you to enter the maximum number
of circuits allowed.
64 Enter the maximum number of circuits allowed and press the Return key.
A message appears. The message asks you to enter the number of
permanent virtual circuits.
65 Do not enter any value.
Press the Return key.
A message appears. The message asks you to enter the quantity of inbound
switched virtual circuits.
—continued—
Step Action
66 Enter the quantity of inbound switched virtual circuits (IVC) and press the
Return key.
67 Enter the starting logical channel identifier for the inbound switched virtual
circuits and press the Return key.
A message appears. The message asks you to enter the quantity of switched
virtual circuits.
68 Enter the number of switched virtual circuits (SVC) and press the Return key.
A message appears. The message asks you to enter the starting logical
channel identifier.
69 Enter the starting logical channel identifier for the two-way switched virtual
circuits and press the Return key.
A message appears. The message asks you to enter the quantity of outbound
switched virtual circuits.
—continued—
Step Action
70 Enter the number of outbound switched virtual circuits (OVC) and press the
Return key.
71 Enter the starting logical channel identifier for the outbound switched virtual
circuits and press the Return key.
The Level 3 parameters appear in a list. Values in square brackets that follow
the parameter name are the values that you entered. The Level 3 parameter
menu follows the Level 3 parameter listing.
72 Review the Level 3 parameters.
Step Action
Enable X.25
75 Enable X.25 from the Configure X.25 menu, by entering:
3↵
If one of the following messages appears for the Then go to
legacy OPC or partitioned OPC:
Port Number (B, 1, 2, 3): step
X.25 operation is being configured on step 77
port X25
Do you wish to continue? (Yes/No)
Procedure 5-3
Configuring virtual circuit profiles
Use this procedure to configure virtual circuit profiles which must be defined
to support the TL1 protocol. Profiles can be added, removed, or listed.
Configuring virtual circuit profiles from the OPC as described in this
procedure utilizes the TL1 configuration tool. This procedure tells you how to
start the program by using the config_TL1 command in the UNIX shell.
Note: The Port configuration tool cannot be run simultaneously with the
TL1 configuration tool.
Procedure tasks
• Configure a virtual circuit profile (step 5).
• List all virtual circuit profiles and protocol ids (step 10).
• Add a virtual circuit profile (step 13).
• Delete a virtual circuit profile (step 17).
• Define a protocol id (step 21).
Expected results
• A virtual circuit profile will be added or deleted.
• A protocol ID for TL1 requests will be defined.
• If the expected results do not occur:
— Verify that you have logged in to the OPC as root.
— Verify that you have the correct OSS address, OSS type, and protocol ID.
—continued—
Action
Step Action
1 Log in to the OPC as root. If you do not know how to do this, see User
Interface Connection Procedures, 323-1801-301.
The “opc>” prompt appears. This is the UNIX shell.
2 Open the TL1 Configuration tool, by entering:
config_TL1 ↵
The TL1 Configuration Main Menu appears.
3 Select an action from the following table:
Step Action
8 Go to step 3.
9 Exit the TL1 Configuration tool, by entering:
9↵
The “opc>” prompt appears on the UNIX shell. This is the end of the
procedure.
List all virtual circuit profiles and protocol ids
10 List virtual circuit profiles and Protocol IDs from the Virtual Circuit
Configuration menu, by entering:
3↵
A list, similar to the following, appears:
Listing virtual circuits ...
-------------------------------------------------------
Remote address received: 01413134 - OPS
Remote address received: 01412122 - NMA
Remote address received: 01412142 - BTH
Total of 3 virtual circuit profile(s) received.
configured
In-service Protocol ID: NULL
-------------------------------------------------------
Step Action
where
<oss address> is a number of up to 16 digits
Note: The form of the address can be seen by
listing existing virtual circuit profiles.
where
<oss type> is
NMA (for a surveillance interface), or
OPS (for a provisioning interface)
BTH (for both surveillance and provisioning
interface)
-------------------------------------------------------
New virtual circuit profile created with remote address
12345678
-------------------------------------------------------
The Virtual Circuit Profile Configuration menu appears.
Go to step 6.
—continued—
Step Action
where
<oss address> is the address of the virtual circuit to be deleted
-------------------------------------------------------
Virtual circuit profile with remote address 12345678 has
been deleted
-------------------------------------------------------
The Virtual Circuit Profile Configuration menu appears.
20 Go to step 6.
Define a protocol id
21 Define a Protocol ID for TL1 requests from the Virtual Circuit Profile
Configuration menu, by entering:
4↵
A message and prompt similar to the following appear:
Warning: If X.3 PAD is enabled, the Protocol ID must be
set to a value other than 01 or NULL.
Step Action
where
<protocol ID> is a hexadecimal number from 1 to 16 digits
Note: Bellcore recommends that “CF” be used as
the protocol ID.
-------------------------------------------------------
New protocol ID accepted,
-------------------------------------------------------
The Virtual Circuit Profile Configuration menu appears.
Note: Procedure 5-4 describes restarting the TL1 Session Manager.
Go to step 6.
—end—
Procedure 5-4
Restarting the TL1 Session Manager
Use this procedure to restart the TL1 Session Manager. This procedure ensures
that a changed Protocol ID takes effect. There is no need to reboot the OPC.
Note: Restarting the TL1 Session Manager terminates all current TL1
connections.
Procedure tasks
• Log in to the OPC as root (step 1).
• Open the TL1 Configuration tool (step 2).
• Restart the TL1 Session Manager (step 5).
Expected results
• The TL1 Session Manager will be successfully restarted.
• If the expected results do not occur:
— Ensure that you have a userID and password that allows you to access the OPC at the root level.
— Recall if these messages appeared onscreen: “Do you still wish to restart the TL1 Session
Manager? (Yes/No)”, “Restarting TL1 Session Manager”.
—continued—
Action
Step Action
1 Log in to the OPC as root. If you do not know how to do this, see User
Interface Connection Procedures, 323-1801-301.
The “opc>” prompt appears. This is the UNIX shell.
2 Open the TL1 Configuration tool, by entering:
config_TL1 ↵
The TL1 Configuration Main Menu appears.
3 Select your next step:
Procedure 5-5
Querying active TL1 sessions
Use this procedure to query the current session quantity. The TL1 Session
Manager permits up to four simultaneous TL1 sessions to be active.
Procedure tasks
• Log in to the OPC as root (step 1).
• Open the TL1 Configuration tool (step 2).
• Query the TL1 Session Manager (step 5).
Expected results
• A list of active TL1 sessions appears.
• If the expected results do not occur:
— Ensure that you have a userID and password that allows you to access the OPC at the root level.
— Ensure that no more than four simultaneous TL1 sessions are active.
—continued—
Action
Step Action
1 Log in to the OPC as root. If you do not know how to do this, see User
Interface Connection Procedures, 323-1801-301.
The “opc>” prompt appears. This is the UNIX shell.
2 Open the TL1 Configuration tool, by entering:
config_TL1
The TL1 Configuration Main Menu appears.
3 Select your next step:
Procedure 5-6
Accessing and exiting TL1 interfaces through the
UNIX shell tool
Use this procedure to access or exit the TL1 surveillance network monitoring
and analysis (NMA). TL1 messages are transferred between the terminal and
the OPC.
Procedure tasks
• Access the TL1 interface (step 2).
• Exit the TL1 interface (step 4).
Expected results
• The TL1 Surveillance interface (NMA) is accessed or exited.
• If the expected results do not occur:
— Ensure that you have a userID and password that allows you to access the OPC at the root level.
— Ensure that you have properly typed the commands tl1shell nma and canc-user.
—continued—
Action
Step Action
1 Log in to the OPC as root. If you do not know how to do this, see User
Interface Connection Procedures, 323-1801-301.
The “opc>” prompt appears. This is the UNIX shell.
Access the TL1 interface
2 Access the TL1 Surveillance interface (NMA), by entering:
tl1shell nma ↵
The “TL1 Command” prompt appears.
3 You can now enter TL1 commands.
All commands must end with a semi-colon. You can spread one TL1
command over many lines, provided you end the command with a
semi-colon. You can also enter multiple commands on one line, providing the
commands are separated with a semi-colon.
Procedure 5-7
Configuring and enabling the TL1 Interface Router
Service over X.25 or TCP/IP
Use this procedure to configure and enable the TL1 Interface Router Service
(TIRS) over X.25 or TCP/IP. TIRS routes TL1 messages to a maximum of four
spans of control interconnected via optical tributaries, Ethernet, or CNet.
The primary router service is used to route TL1 messages to remote primary
OPC’s span of control. The backup router service is used to route TL1
messages to a remote backup OPC’s span of control.
Procedure tasks
• Log in to the OPC (step 1).
• Choose to configure TIRS over X.25 or TCP/IP (step 3).
• TCP/IP: Configure and enable primary and backup router service (step 4).
• X.25: Configure and enable primary and backup router service (step 57).
Expected results
• The primary (and backup) TL1 Interface Router Service is configured and enabled over X.25 or TCP/IP.
— If the expected results do not occur:
— Ensure that you have a userID and password that allows you to access the OPC at the admin level.
— Verify that you have chosen the correct options from the TIRS Configuration Main Menu.
— Verify that you have entered the correct data for each step (such as the TID and RemoteOPCName).
— Contact your next level of support.
—continued—
Action
Step Action
1 Log in to the OPC using the admin userID and open the TL1 Configuration
tool from the User Session Manager. If you do not know how to do this, see
User Interface Connection Procedures, 323-1801-301.
2 Configure the TL1 Interface Router Service, by entering:
6↵
The following TL1 Interface Router Services Configuration menu appears.
********************************************************
* TL1 Interface Router Services Configuration Main Menu *
********************************************************
1 TL1 Interface Router Services Configuration
over X.25
2 TL1 Interface Router Services Configuration
over TCP/IP
8 Return to Main Menu
9 Exit
Note: After you have configured TIRS over X.25 or TCP/IP, you must
establish a TL1 session over the TL1 Interface Router Service (step 102).
When you wish to disable your session, you must disable your session over
the TL1 Interface Router Service (step 102).
—continued—
Step Action
*******************************************************
* TL1 Interface Router Services over TCP/IP Main Menu *
*******************************************************1
1 Primary Router Service Configuration
2 Backup Router Service Configuration
3 Add IP address for OSS Type
4 Delete IP address for OSS Type
5 List IP address for OSS Type
8 Return to Main Menu
9 Exit
Note: For backup router service, the computer screens and procedure steps
are very similar to the screens and steps for the primary router service. The
only difference is the word “backup” will appear instead of the word “primary”
for all screens and text.
—continued—
Step Action
Step Action
11 To add the port number enter yes ↵. If you do not want to add the port number
enter no ↵.
Go to step 8.
12 Configure TL1 Primary Router Service, by entering:
2↵
Step Action
17 To update the configuration enter yes ↵. If you do not want to update the
configuration enter no ↵.
Go to step 8.
18 Enable TL1 Primary Router Service, by entering:
3↵
The following message appears.
TL1 Primary Router Process Enabled Successfully.
Go to step 8.
19 Disable TL1 Primary Router Service, by entering:
4↵
The following message appears.
TL1 Primary Router Process Disabled Successfully.
Go to step 8.
—continued—
Step Action
Step Action
26 To update the configuration enter yes ↵ if you do not want to update the
configuration enter no ↵.
Go to step 5.
27 Delete IP address for OSS type, by entering:
4↵
The following message appears:
Enter IP address of the OSS (END):
An example of an IP address is 192.219.223.79.
28 Continue to enter the IP addresses to be deleted, when you are finished
enter:
end ↵.
The following message appears:
The IP addresses deleted are
Step Action
Note: The IP addresses shown are examples only. Your addresses will be
different.
31 Press return:
↵
Go to step 5.
32 Modify TL1 Primary Router Configuration, by entering:
7↵
Step Action
Step Action
Step Action
45 Go to step 33.
46 Add SOC to existing TL1 Primary Router Configuration, by entering:
1↵
The following message appears:
Enter the RemoteOPCName for TL1 Interface Primary Router
Service(END):
47 Enter the RemoteOPCName for TL1 Interface Primary Router Service, by
entering:
OPC92755P ↵ (example only, your OPC name will be different)
The following message appears:
Enter the TID for TL1 Interface Primary Router
Service (END):
48 Enter the TID, by entering:
TIDNAME1 ↵ (example only, your TID will be different)
The following message appears:
Enter the TID for TL1 Interface Primary Router
Service (END):
49 Continue to enter all the TIDs, when you are finished enter:
end ↵.
The following message appears:
Enter the RemoteOPCName for TL1 Interface Primary Router Service(END)
50 Continue to enter all the TIDs, when you are finished enter:
end ↵.
The following message appears:
THE SOCs added are
Go to step 33.
—continued—
Step Action
Step Action
Go to step 33.
Configure TIRS over X.25
57 Configure TIRS over X.25, by entering:
1↵
The following TL1 Interface Router Services over X.25 menu appears.
*****************************************************
* TL1 Interface Router Services over X.25 Main Menu *
*****************************************************
1 Primary Router Service Configuration
2 Backup Router Service Configuration
8 Return to Main Menu
9 Exit
Step Action
Step Action
Step Action
68 Repeat step 67 until all the TIDs have been entered, then enter:
end ↵
The following message appears (example only).
Enter the RemoteOPCName for TL1 Interface Primary Router Service
(END):
69 Select an action from the following table:
If you would like to Then go to
enter another remote OPC name and the TIDs in its step 66
span of control
quit entering another remote OPC and its TIDs step 71
Step Action
Step Action
Step Action
Step Action
85 Continue to enter all the TIDs, when you are finished enter end ↵
The following message appears:
The RemoteOPC : OPC48011P (example only)
Step Action
Step Action
Go to step 78.
96 Add TID to existing TL1 Primary Router Configuration, by entering:
1↵
The following message appears:
Enter the RemoteOPCName to which you want to add TID for
TL1 Interface Primary Router Service (END) :
97 Enter the RemoteOPCName, by entering:
OPC92755P ↵ (example only, your OPC name will be different)
98 Continue to enter all the RemoteOPCNames, when you are finished enter:
end ↵.
The following message appears:
Enter the TID for TL1 Interface Primary Router
Service (END):
99 Enter the TID, by entering:
TIDNAME1 ↵ (example only, your TID will be different)
The following message appears:
Enter the TID for TL1 Interface Primary Router
Service (END):
100 Continue to enter all the TIDs, when you are finished enter end ↵.
The following message appears:
THE TIDs added are
Step Action
Enable or disable a TL1 session over the TL1 Interface Router Service
102 Select your next step:
where
<tid> is the target identifier. The tid must be specified and it
should be a valid identifier in the OPC’s span of control.
<uid> is the user id. The following conditions apply on which
type of user id can be used:
When TL1 SECURITY is DISABLED:
1.admin user
2.root user
When TL1 SECURITY is ENABLED:
1.root user
2.admin user
3.tl1usr user
Step Action
106 Send a TL1 command using a valid TID from the OPC’s SOC to verify that the
connection has been established. Enter:
rtrv-hdr:<tid>::<ctag>; ↵
where
<tid> is the target identifier. The tid must be specified and it should
be a valid identifier in the OPC’s span of control.
<ctag> is the correlation tag.
107 Verify that a ‘COMPLD’ is returned from the RTRV-HDR response output
message.
Go to step 3.
Disable the TL1 session
108 Disable a TL1 session over the TL1 Interface Router Service. Enter in the
following command from an operations system TL1 window:
canc-user:<tid>::<ctag>; ↵
where
<tid> is the target identifier. The tid must be specified and it should
be a valid identifier in the OPC’s span of control.
<ctag> is the correlation tag.
Procedure 5-8
Configuring TL1 over TCP/IP
Use this procedure for configuring TL1 over TCP/IP.
Procedure tasks
• Configure TL1 over TELNET/TCP/IP (step 5).
• Configure TL1 over TRUE TCP/IP (step 8).
• Unconfigure TL1 over TELNET/TCP/IP (step 16).
• Unconfigure TL1 over TRUE TCP/IP (step 19).
• Display TL1 TCP/IP port configurations (step 22).
Expected results
• TL1 will be configured over TELNET/TCP/IP or TRUE TCP/IP.
• If required, TL1 will be unconfigured over TELNET/TCP/IP or TRUE TCP/IP.
• TL1 TCP/IP configurations will be displayed.
• If the expected results do not occur:
— Ensure that you have a userID and password that allows you to access the TL1 Configuration tool
from the User Session Manager.
— Verify that you have chosen the correct options from the TL1 over TCP/IP Port Configuration Menu.
— Verify that you have entered the correct data for each step (port number, OSS name, IP address,
etc.).
—continued—
Action
Step Action
1 Log in to the OPC using the admin userID and open the TL1 Configuration
tool from the User Session Manager. If you do not know how to do this, see
User Interface Connection Procedures, 323-1801-301.
The TL1 Configuration Main Menu appears.
2 Configure TL1 over TCP/IP, by entering:
7↵
The following message appears.
This option will update the files
/etc/services,/etc/inetd.conf
and /usr/adm/inetd.sec. You can take a backup of the above
files
with extension .backup before proceeding further. Choose
Yes/No.
Step Action
Step Action
9 Enter the port number for your TRUE TCP/IP operations and press:
↵
A message prompting you to enter the OSS for NMA or OPS appears.
Enter OSS type [NMA or OPS]:
10 Enter an OSS type (“NMA” or “OPS”) and press:
↵
A message appears asking whether you want to allow connections from all
OSS hosts.
11 Select your next step:
Step Action
17 Enter the port number that you want to unconfigure and press:
↵
A confirmation asking you whether you want to continue appears.
18 Confirm the request, by entering:
y↵
The TL1 over TCP/IP Port Configuration menu appears.
Go to step 4.
Unconfigure TL1 over TRUE TCP/IP
19 Unconfigure TL1 over TRUE TCP/IP, by entering:
4↵
The following message appears.
This option allows for Unconfiguring a port for TL1 TCP/IP
operations. Select a port number > 5000 && <= 65535.
Step Action
323-1801-190
Rel 3 Standard
July 2000
Printed in Canada and in the United Kingdom