TL1 Gateway User Guide (5087)

SPECTRUM
®
TL1 Gateway User Guide (5087)
r9.0
This documentation and any related computer software help programs (hereinafter referred to as the
“Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at
any time.
This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part,
without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and
protected by the copyright laws of the United States and international treaties.
Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the Documentation for their
own internal use, and may make one copy of the related software as reasonably required for back-up and disaster
recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only
authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the
product are permitted to have access to such copies.
The right to print copies of the Documentation and to make a copy of the related software is limited to the period
during which the applicable license for the product remains in full force and effect. Should the license terminate for
any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the
Documentation have been returned to CA or destroyed.
EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY
APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING
WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS
OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION,
LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF
SUCH LOSS OR DAMAGE.
The use of any product referenced in the Documentation is governed by the end user’s applicable license agreement.
The manufacturer of this Documentation is CA.
Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the
restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section
252.227-7014(b)(3), as applicable, or their successors.
All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.
Copyright © 2008 CA. All rights reserved.
Contents
Preface
Intended Audience . . . . . . . . . . . . . .
Text Conventions . . . . . . . . . . . . . . .
Documentation Location and Feedback
Contact Technical Support . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
...
...
...
...
.
.
.
.
.v
.v
.vi
.vi
What Is TL1? . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is the SPECTRUM TL1 Gateway?. . . . . . . . .
Honored TL1 Standards . . . . . . . . . . . . . . . . . . .
What Does the SPECTRUM TL1 Gateway Include? .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.1
.1
.2
.2
Chapter 1: Getting Started
.
.
.
.
.
.
.
.
Chapter 2: Installing and Using
the TL1 Gateway
Prerequisites for the TL1 Gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing on a Non-SPECTRUM Machine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting up Port Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating a TL1 Device Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Max Telnet Sessions and Max Logins Per Telnet Attribute Considerations . . . . . . . . . . . . . . . . .
Max Telnet Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Max Logins Per Telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Important Processing Information for both Max Telnet Sessions and Max Logins Per Telnet . .
TL1 Devices with Autonomous Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pre Login Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command on First Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The TL1 AlarmMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Format of the AlarmMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The tl1map Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AlarmMap Extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing an AlarmMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Examples of tl1map Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
..3
..6
..6
..7
..8
. 11
. 11
. 11
. 12
. 14
. 15
. 16
. 17
. 19
. 20
. 22
. 22
. 23
Chapter 3: Managing the TL1 Gateway Deamon
The TL1 Gateway Daemon . . . . . . . . . . . . . . . . . . .
Starting the TL1 Daemon on the SPECTRUM Machine
Starting the TL1 Daemon on a Remote Machine . . . .
Terminating the TL1 Daemon . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
25
25
26
27
Contents
iii
Index
iv
TL1 Gateway User Guide
Preface
This guide is organized as follows:
„
Chapter 1, “Getting Started,” on page 1 provides an overview of TL1 as well
as SPECTRUM TL1 Gateway.
„
Chapter 2, “Installing and Using the TL1 Gateway,” on page 3 describes how
to utilize and install SPECTRUM TL1 Gateway.
„
Chapter 3, “Managing the TL1 Gateway Deamon,” on page 25 describes how
to manage the TL1 Gateway Daemon.
Intended Audience
This manual is intended for telecommunications management that
utilize TL1.
Text Conventions
The following text conventions are used in this document:
Element
Convention Used
Variables
Italic in angle
brackets (<>)
(The user supplies a
value for the
variable.)
The directory where
you installed
SPECTRUM
<$SPECROOT>
Example
Type the following:
DISPLAY=<workstation
name>:0.0 export
display
Navigate to:
<$SPECROOT>/app-defaults
(The user supplies a
value for the
variable.)
v
Documentation Location and Feedback
Element
Convention Used
Example
Linux, Solaris, and
Windows directory
paths
Unless otherwise noted,
directory paths are
common to both
operating systems, with
the exception that
slashes (/) should be
used in Linux and
Solaris paths, and
backslashes (\) should
be used in Windows
paths.
<$SPECROOT>/app-defaults
on Linux and Solaris is
equivalent to
<$SPECROOT>\app-defaults
on Windows.
On-screen text
Courier
The following line displays:
path=”/audit”
User-typed text
Courier
Type the following path
name:
C:\ABC\lib\db
References to
SPECTRUM
documents (title and
number)
Italic
Installation Guide (5136)
Documentation Location and Feedback
Check the following site for the latest updates and additions to SPECTRUM
documents:
http://ca.com/support
To send feedback regarding SPECTRUM documentation, access the following
web address:
http://supportconnectw.ca.com/public/ca_common_docs/docserver_email.asp
Thank you for helping us improve our documentation.
Contact Technical Support
For online technical assistance and a complete list of locations, primary service
hours, and telephone numbers, contact Technical Support at the following web
address:
http://ca.com/support
vi
TL1 Gateway User Guide
Chapter 1: Getting Started
This section describes SPECTRUM’s TL1 Gateway and the components it
comprises.
What Is TL1?
Transaction Language 1 (occasionally referred to as MML (Man
MachineLanguage) is a widely used protocol in telecommunications
management that can be used to manage most telecom network elements in
North America today. Unlike SNMP, TL1 is a man-machine interface that contains
strings that humans can read and understand. Also, unlike SNMP, there is no
concept of MIB in the TL1 world. TL1 was originally specified by Bellcore in 1986,
and is now maintained by Telcordia Technologies.
What Is the SPECTRUM TL1 Gateway?
The current version of the TL1 Gateway translates TL1 events and alarms
originating from a TL1 device into SPECTRUM events and alarms. It is basically
a mediator from the TL1 world to the SPECTRUM world. Each TL1 device is
represented by a corresponding device model within SPECTRUM. This allows you
to launch the Enterprise Alarm Manager application for a particular model so that
you can check for certain alarm conditions and initiate corrective action. The TL1
Gateway also supports TL1 devices that are accessible through proxy devices,
also known as Gateway Network Element (GNE) devices.
Getting Started
1
Honored TL1 Standards
Honored TL1 Standards
The SPECTRUM TL1 Gateway implements the full range of TL1 Condition Types
as specified by Telcordia. Please see following URL for a listing of Telcordia’s
current network element and transport surveillance messages:
www.telcordia.com
What Does the SPECTRUM TL1 Gateway Include?
2
„
TL1-specific inference handlers that plug into SpectroSERVER.
„
a daemon (TL1d) that handles communication between the TL1 devices and
the SpectroSERVER.
„
a model type (Gen_TL1_Dev) for generic TL1 devices
„
a tool (tl1map) to manage TL1 AlarmMaps
TL1 Gateway User Guide
Chapter 2: Installing and Using
the TL1 Gateway
This section describes how to install the components of the TL Gateway.
Prerequisites for the TL1 Gateway
The SPECTRUM TL1 Gateway is designed such that it can either be run on the
same machine SPECTRUM is running on, or on a separate machine. Diagrams
illustrating both installation models are provided on the subsequent pages.
Running the TL1 Gateway on a separate machine is recommended if any of the
following conditions apply:
„
The SPECTRUM machine hosts a SpectroSERVER that has a high work load.
„
The SPECTRUM machine is short on resources like CPU and RAM.
„
The SPECTRUM machine is also used by applications other than SPECTRUM.
„
A high volume of TL1 traffic has to be processed.
Note: SPECTRUM TL1 Gateway does not support IPv6.
Installing and Using the TL1 Gateway
3
Prerequisites for the TL1 Gateway
Figure 1
4
TL1 Gateway User Guide
TL1 Gateway Installed on SPECTRUM Host
Prerequisites for the TL1 Gateway
Figure 2
TL1 Gateway Installed on Remote Host
Installing and Using the TL1 Gateway
5
Installation Options
Installation Options
If your configuration requires the TL1 Gateway to be run on the same machine
SPECTRUM is running on, then the gateway has already been installed during the
major SPECTRUM installation. In this case, all required TL1 Gateway
components can be found in a subdirectory called TL1Apps, which is located in
your top-level SPECTRUM directory. The TL1Apps directory contains the
following files:
„
TL1d --
the gateway daemon
„
tl1map -- the AlarmMap utility
Installing on a Non-SPECTRUM Machine
In some cases, where a certain level of performance is needed, it is preferable
to install the TL1 daemon component on a separate machine that will be
dedicated to TL1 message processing. The instructions vary slightly depending
on the platform you are using and are thus presented separately for NT and
Solaris below. In either case you will have to find and run the self-extracting
installer file on the SPECTRUM application CD. This will launch a series of dialogs
that will prompt you to supply the following information:
„
confirmation of the license agreement
„
the extraction key
„
installation target area
Note: Regardless of the platform SPECTRUM is running on (Solaris or NT), the
TL1 daemon component can be installed and operated on either type of platform.
For example, you could run SPECTRUM on a Solaris machine, while the TL1
daemon could be hosted by an NT machine, and you would thus have a
heterogeneous TL1 Gateway configuration.
Installing on NT
1. Navigate into the TL1GW folder on the SPECTRUM application CD.
2. Run the tl1inst.exe program.
3. Copy the resulting files (listed below) to the proper locations on the NT
machine:
–
TL1d.exe
–
tl1map.exe
–
orb.dll
–
orb_p.dll
The executables TL1d.exe and tl1map.exe should be copied to the preferred
locations. The DLL files should be copied to the system area that is used for
third-party DLL files.
6
TL1 Gateway User Guide
Setting up Port Numbers
Installing on Solaris
1. Navigate into the TL1GW directory on the SPECTRUM application CD
2. Run the tl1inst.bin program.
3. Copy the resulting files (listed below) to the proper locations on the Solaris
machine:
–
TL1d
–
tl1map
–
liborb.so
The executables TL1d and tl1map should be copied to the preferred
locations. The shared library liborb.so should be copied to the preferred
system area for third-party libraries (e.g., /usr/lib). If using a location
other than /usr/lib, the environment variable LD_LIBRARY_PATH must be
updated to include that location.
Setting up Port Numbers
When you create a TL1 device model, the two port numbers described below
need to be specified. Before assigning any port numbers, you should first check
the local system administration/security policies.
„
TL1 Gateway Port. This port will be used for communication between the
TL1 daemon (TL1d) and SpectroSERVER. At model creation time, a default
port number of 64222 is supplied. When choosing a different port number,
it is strongly recommended that you do not use port number 65535.
Again, you should check with the local system administrator to find a port
number in the dynamic/private range 49152 to 65534. The TL1 Gateway
port number can be specified as a command line argument when launching
TL1d; otherwise, the default of 64222 will be assumed.
„
TL1 Device Port. This port is used for communication between the physical
TL1 device and the TL1 daemon. You should check with the network
administrator to find out the port number to use, as it depends on how the
device is configured. It will likely be a port number specified in the IANA
standard document Port Numbers in the “Registered Port Numbers”
section. Likely candidates are: 2361, 3081, 3082, 3083. See
http://www.iana.org/assignments/port-numbers for more details. The TL1 port
number is entered via the model creation dialog.
Installing and Using the TL1 Gateway
7
Creating a TL1 Device Model
Creating a TL1 Device Model
Like any other SPECTRUM device models, TL1 device models can be created
interactively via OneClick, but they are not currently modeled through
AutoDiscovery. To model a generic TL1 device, do the following:
1. From any OneClick Topology view, select the Model by Type button to
display the Select Model Type dialog.
2. In the Select Model Type dialog, select Gen_TL1_Dev to model a generic TL1
device and click OK.
8
TL1 Gateway User Guide
Creating a TL1 Device Model
The Create Model Type dialog box is displayed.
3. Specify the following fields to properly configure the TL1 device model:
–
Model Name - Enter a unique name for this model.
–
TL1 Gateway Address - Enter the IP address of the machine that hosts
the TL1 daemon (TL1d).
–
TL1 Gateway Port - Enter the port number used for communication
between the TL1 daemon and SPECTRUM; or leave the default value of
64222.
–
TL1 Device Address - Enter the IP address of the TL1 device. Note that
in some cases this may be the IP address of a dedicated TL1 device that
acts as a proxy for all the other TL1 devices in the network.
–
TL1 Device Port - Enter the port number the TL1 device agent is
listening on (also known as the “craft” port).
–
Max Telnet Sessions - Specify the total number of telnet sessions the
TL1 Gateway can make to Gateway Network Element (GNE). Default is
1.
Note: See the Max Telnet Sessions and Max Logins Per Telnet Attribute
Considerations on page 11 for additional information about this powerful
field value.
Installing and Using the TL1 Gateway
9
Creating a TL1 Device Model
–
Max Logins Per Telnet - Enter the number of logins that are permitted
to be active simultaneously per telnet session. This depends on the GNE.
Note: See the Max Telnet Sessions and Max Logins Per Telnet Attribute
Considerations on page 11 for additional information about this powerful
field value.
–
TID - Enter the “Target ID” for the TL1 device. This is part of TL1’s
addressing concept and is required to uniquely identify the device. The
TID is most often a predefined alphanumeric string that should be
obtained from the local network administrator.
–
User Name - Enter the userid for the maintenance user, as configured
in the TL1 device.
–
Password - Enter the password for the maintenance user.
–
Security String - Adding a security string prevents certain users from
viewing this model.
–
Poll Interval (sec) - Specifies the interval at which this device will be
polled. Change the value as needed to increase or decrease the polling
interval. By default, SPECTRUM polls modeled devices for status updates
every 60 seconds (or for some model types every 300 seconds).
–
If you increase the time between polling intervals, you will use less
bandwidth for management traffic, but you will receive device status
updates less frequently.
–
If you decrease the time between polling intervals, you will have more
frequent updates of device status, but you will use more bandwidth. As
such, you may want to use the default polling interval (60 seconds) for
critical devices and use 600 seconds for less important devices.
–
Log Ratio - Defines how many times SPECTRUM polls devices for
updates before logging the results. By default the log ratio is 10
(SPECTRUM logs the polling results after it polls the device every 10th
time).
No entries or adjustments to the defaults are required for the remaining
fields, but you may want to consider whether the default Polling Interval of
60 seconds is optimal for your device; this setting can be changed as
necessary in individual cases to adjust network traffic for improved
performance.
For more information about settings on the previous fields, see the OneClick
Administration Guide (5166).
4. Click the OK button. A TL1 device model icon appears.
10
TL1 Gateway User Guide
Creating a TL1 Device Model
Max Telnet Sessions and Max Logins Per Telnet Attribute Considerations
Max Telnet Sessions
The Max Telnet Sessions field enables you to specify the total number of telnet
sessions the TL1 Gateway can make to Gateway Network Element (GNE).
Default is 1.
TL1 devices exist in a ring or group. The Gateway Network Element acts as a go
between the rest of the network and the TL1 devices within the ring. Therefore,
SPECTRUM makes a telnet connection to the GNE.
This will vary with hardware maximum device specifications. SPECTRUM may
use as many sessions as the Max Telnet Sessions value has been set to allow.
You may want to specify Max Telnet Sessions to one less than the hardware
maximum in order to leave one available for the Network Administrator, but it is
not required.
For any given ring, the number of telnet sessions used is the highest Max Telnet
Sessions value among all the Gen_TL1_Dev models that are associated with that
ring. So, if you have 10 devices modeled for a single ring, if all the Max Telnet
Sessions values are 1, then the TL1 daemon (TL1d) will use at most 1 telnet
session when communicating with all the devices on that ring. If 9 of the models
have a Max Telnet Sessions value of 1 and 1 of the models has a Max Telnet
Sessions value of 4, then the TL1d may use up to 4 concurrent telnet sessions
when communicating with ANY of the devices on that ring.
The recommended usage for Max Telnet Sessions is to set it to the desired value
on the Gen_TL1_Dev model which represents the TL1 proxy device, and to leave
the value at it's default for other Gen_TL1_Dev models. That way, if you want
to change the value, you only have to change it on one model.
Max Logins Per Telnet
The Max Logins Per Telnet field enables you to enter the number of logins that
are permitted to be active simultaneously per telnet session. This depends on the
GNE. Some authorize one active login at a time, others allocate more.
As with Max Telnet Session, when two or more devices from the same ring are
modeled, the TL1 deamon (TL1d) uses the highest Max Logins Per Telnet value
among all the Gen_TL1-Dev models that are associated with that ring.
The recommended usage for Max Logins Per Telnet is to set it to the desired
value on the Gen_TL1_Dev model which represents the TL1 proxy device, and
to leave the value at it's default for other Gen_TL1_Dev models. That way, if
you want to change the value, you only have to change it on one model.
Installing and Using the TL1 Gateway
11
Creating a TL1 Device Model
Important Processing Information for both Max Telnet Sessions and Max Logins Per Telnet
It is important to understand the difference between having a value for Max
Logins Per Telnet of 1 versus a value greater than 1.
When Max Logins Per Telnet Equals 1
When Max Logins Per Telnet equals one, the telnet connection(s) are
time-shared. Therefore, polls cannot occur simultaneously, but instead are
carried out in sequence. The maximum number of devices manageable is
dependent primarily on the polling interval and the value of Max Telnet Sessions.
Congestion and slow device response can adversely affect Spectrum's
management of the devices. Please see Congestion Considerations on page 12
for additional information.
When Max Logins Per Telnet Is Greater Than 1
When Max Logins Per Telnet is greater than one, polls can occur
simultaneously. The maximum number of devices manageable is a hard limit of
Max Telnet Sessions multiplied with Max Logins Per Telnet. Therefore,
congestion and slow device response has less impact on Spectrum's ability to
properly manage the devices. Please see Congestion Considerations on page 12
for additional information.
The TL1 daemon (TL1d) will communicate with TL1 devices over shared telnet
sessions. That is, if you have say, 10 TL1 devices on a single TL1 ring, the TL1
Gateway can send ping requests to and receive messages from all 10 devices
over a single telnet connection.
The TL1 daemon (TL1d) can also have several concurrent telnet sessions open to
the same TL1 ring. So, the TL1 Gateway could be using 3 telnet sessions open
at the same time to communicate with 10 TL1 devices on a single ring.
Congestion Considerations
Because communication is shared over the connections, congestion can occur.
The amount of congestion is determined by: the number of concurrent telnet
sessions available to the TL1 Gateway for use to the TL1 ring in question; the
number of TL1 devices on the ring that are managed in SPECTRUM; the polling
interval of the TL1 models; the frequency of alerts sent to the TL1 Gateway from
the TL1 devices; and the time delay in the TL1 devices responding to commands
from the TL1 Gateway.
If congestion over the telnet session is bad enough, ping requests sent by the
SpectroSERVER will not return in time, and the TL1 models will sporadically go
into a contact lost state.
If the network congestion is caused by too many alerts from the TL1 devices, a
solution might be to specify an autonomous port for the device(s).
12
TL1 Gateway User Guide
Creating a TL1 Device Model
If Max Logins Per Telnet equals one, the following two solutions are available:
„
Increase the polling interval of the TL1 models -- the devices will be polled
less often causing less congestion, resulting in better performance.
„
Increase the telnet sessions to TL1 devices ratio, by either increasing the
number of concurrent telnet sessions the TL1d may use, or by decreasing
the number of TL1 devices on the ring.
Upgrade Considerations
Of particular importance to customers who are upgrading:
„
Due to the overhead caused by the new functionality, we have increased the
default value for the DCM Timeout attribute (0x110c4) from 3000 to 5000.
However, if the customer is upgrading this change will not be made because
the Timeout attribute has the 'Preserve Value' flag set.
„
If the DMC timeout value is left at 3000, the ping requests sent by the
SpectroSERVER will probably timeout sporadically. After upgrading,
customers should change the Timeout value for all Gen_TL1_Dev models
that they have currently modeled to be 2000 milliseconds higher than their
current value. Likewise, they should also increase the Gen_TL1_Dev model
type default value for Timeout by 2000 milliseconds.
Installing and Using the TL1 Gateway
13
TL1 Devices with Autonomous Port
TL1 Devices with Autonomous Port
Some TL1 devices support command ports only and have a port dedicated to
autonomous messages. The TL1 Gateway supports this option.
To use it, highlight the TL1 device icon and select the Information tab in the
Component Detail view. The TL1 Autonomous Port can be set in the TL1 Device
Information section.
14
TL1 Gateway User Guide
Pre Login Sequence
Pre Login Sequence
Before logging into a TL1 device, the TL1 daemon can send a few characters to
the device to ‘wake up’ the telnet session. These characters are stored in the
Pre Login Sequence attribute. The default is a single newline character.
For some cases, multiple newlines may be more appropriate. To change the Pre Login
Sequence, highlight the TL1 device icon and select the Information tab in the
Component Detail view. The Pre Login Sequence can be set in the TL1 Device Information
section.
Installing and Using the TL1 Gateway
15
Command on First Logon
Command on First Logon
The Command on First Logon field value is issued to the device the first time
you log into the device. In the figure, the ALW-MSG-ALL command is used to enable
the device to send alerts to the TL1 Gateway, because some devices will not do
this automatically. Then the Gateway will be able to relay the alerts to
SPECTRUM as it receives them as normal.
You are able to customize the Command on First Logon for any command
necessary. SPECTRUM automatically replaces the <TID> and <CTAG> values. The
<TID> value will utilize the TID field value you specified within the Create Model
Type dialog box. The <CTAG> value will automatically generated by the TL1
Gateway for proper communication.
16
TL1 Gateway User Guide
The TL1 AlarmMap
The TL1 AlarmMap
The TL1 Gateway’s AlarmMap is an internal mapping of TL1 events and alarms
to SPECTRUM alerts. The AlarmMap is used by the TL1 daemon to determine
whether an incoming TL1 event/alarm will be discarded or be converted to an
alert code and forwarded to SPECTRUM. Thus the AlarmMap functions as a filter
to discard unnecessary TL1 events/alarms. An AlarmMap usually includes a
default entry, which is used for any TL1 events/alarms that have no specific
mapping defined. That is, all unmapped TL1 events/alarms result in the same
SPECTRUM alert as specified in the default entry.
TL1 alarms are displayed in the following figure:
Installing and Using the TL1 Gateway
17
The TL1 AlarmMap
TL1 Details per Alarms are displayed in the following figure:
18
TL1 Gateway User Guide
The TL1 AlarmMap
Format of the AlarmMap
The AlarmMap is a sequence of records, each comprising the following five
comma-separated fields:
<type>,<condition>,<alert-code>,<clr-alert-code>,<process>
As described below:
<type> is a text string specifying the entry type as either “ALM” (for alarm) or
“EVT” (for event).
<condition> is a text string identifying a TL1 condition type (TL1 alarms) as
specified in the Telcordia standards document GR-833-CORE. If this string is
blank, or empty, the record serves as the default entry for the AlarmMap. If the
string ends in a hyphen (e.g., OGCCS-), then all conditions starting with that
string will be mapped by this entry. This is similar to a “wildcard.”
<alert-code> is a hexadecimal literal with a leading “0x” that specifies the alert
code to be used by SPECTRUM for this TL1 event/alarm.
<clr-alert-code> is a hexadecimal literal with a leading “0x” that specifies the
code used by SPECTRUM to clear the TL1 event/alarm.
<process> is a boolean value of either TRUE, or FALSE that specifies whether the
event/alarm should be processed. If TRUE, an alert will be generated for
SPECTRUM. If FALSE, the incoming TL1 event/alarm is discarded and nothing will
be forwarded to SPECTRUM. An example of an AlarmMap is shown below.
ALM,
,0x3d50001
,0x3d50002
,TRUE
ALM,LINETERM
,0x3d500f3
,0x3d500f4
,TRUE
ALM,ECOI
,0x3d501b9
,0x3d501ba
,TRUE
ALM,SLOR
,0x3d501c9
,0x3d501ca
,TRUE
EVT,NTYDGSP
,0x3d5009d ,0x3d5009e ,TRUE
<------ DEFAULT
The commas can be surrounded by spaces, and everything after the <process>
field and a space is treated as comment for better readability.
Note that the contents of the AlarmMap are critical to the performance of the TL1
Gateway. You should configure the AlarmMap such that only those TL1 alarms
you are interested in will be processed. In other words, make sure the
<process> value is set to FALSE for all TL1 alarms for which you do not want a
SPECTRUM alert to be generated.
Also note that if an “unwanted” TL1 event/alarm does not appear in the map, it
will still be processed through the default mapping, assuming the map has a
default entry. To prevent this, you can do either of the following:
„
Include all unwanted TL1 events/alarms in the map with their <process>
values set to FALSE.
„
Remove the default entry.
Installing and Using the TL1 Gateway
19
The TL1 AlarmMap
The tl1map Utility
The TL1 Gateway includes a command-line tool called tl1map that lets you
inspect the AlarmMap and perform either of the following two operations:
„
Extract an AlarmMap from either a TL1 device model or from the TL1 device
model type (Gen_TL1_Dev).
„
Import an AlarmMap in the form of a text file either to a TL1 device model
or to the Gen_TL1_Dev model type.
The tl1map tool is located in your top-level SPECTRUM directory’s TL1Apps
subdirectory. You can run tl1map either from the shell command line or from
within scripts (if you need to perform more complicated AlarmMap
manipulations). In either case, tl1map is a SpectroSERVER client, so
SpectroSERVER must be up and running.
Note: The tl1map utility is dedicated to models/model types of the Gen_TL1_Dev
hierarchy only. It is not intended to be used with any other models/model types
and could cause potential data corruption if not used properly.
20
TL1 Gateway User Guide
The TL1 AlarmMap
Syntax:
.tl1map {load | dump} -f mfile {-t | -m} handle [host]
dump - Extracts the internal AlarmMap in text format and saves it to the file
specified by the -f option, in text format.
load - Processes the input file specified by the -f option and writes an
AlarmMap to the corresponding attribute.
-f mfile - The -f flag indicates that the next entry will provide the name of a
particular map file (mfile). In load mode, the supplied input file is expected to
have AlarmMap syntax (see <HyperHot><Italic>Format of the AlarmMap on
Page 19), and it will be converted into an internal TL1 AlarmMap object. When
in dump mode, the contents of the already existing, internal AlarmMap will be
extracted, formatted, and written to the specified mfile. This file is then suitable
for visual inspection and processing by a text editor, so it can be changed, and
re-imported using the load option.
-t - Specifies that the handle provided will be the model type handle of the TL1
device model type.
-m - Specifies that the handle provided will the model handle of a TL1 device
model.
handle - The handle of either the TL1 device model type (if the -t flag is used) or
the TL1 device model (if the -m flag is used). The handle is in hexadecimal
format.
host - The name of the SPECTRUM host. This is only needed when accessing a
remote host, or if the Unix hostname command reports a mixed-case name,
while the “true” host name was advertised in lower-case format. In any case,
tl1map should be run on the local host.
The -m, -t, and -f options can appear in any order.
Installing and Using the TL1 Gateway
21
The TL1 AlarmMap
AlarmMap Extraction
If tl1map is invoked with the dump option, it will read the current AlarmMap
attribute value from either a model (-m option), or a model-type (-t option),
convert it into a human-readable format, and write it to the file specified by the
-f option. That file will also contain an informational header, which includes
things like model name, model type name, model handle, model type handle,
host name, and the current time stamp (based on the machine where the utility
was invoked). The header is formated as a comment, so it will not affect any
subsequent import operation using this machine-generated file.
Typically, you would examine this AlarmMap file with a text editor, make any
desired modifications, and then import the file again by invoking tl1map with the
load option.
Note that the entries in the output file are in no particular order. If you wish to
compare two different AlarmMaps, you need to do the following:
1. Strip off the comment header.
2. Sort the files.
3. Perform the actual comparison.
Importing an AlarmMap
To import an AlarmMap under any of the following scenarios, use the tl1map
utility with the load option:
„
Creating an initial AlarmMap based on documents from a TL1 device vendor
or on TL1 standards documents.
„
Extracting a previously stored AlarmMap, applying some changes, and
importing the changed version again.
„
Extracting the AlarmMap from one model/model type, and importing it to
another model/model type (possibly on another host)
When importing an initial AlarmMap from a file, you have to make sure that the
file conforms with the format specifications for AlarmMap files
(<HyperHot><Italic>Format of the AlarmMap on Page 19).
The tl1map utility will display limited diagnostic messages if it encounters illegal
entries in the AlarmMap file. If there were any errors, no data will be written to
the model/model type attribute.
22
TL1 Gateway User Guide
The TL1 AlarmMap
Examples of tl1map Usage
The following examples illustrate how the tl1map utility might be used to
perform various specific tasks. Note that the examples use /dev/stdin and
/dev/stdout. Since these are not available on NT, you would therefore use
intermediate files instead of Unix-style pipes.
To import an AlarmMap to model 0x146007
tl1map load -f custom.amap -m 0x146007
To export the AlarmMap to a file
Exporting the AlarmMap to a file enables it to be modified. The modified file can
be re-loaded/imported.
tl1map dump -f exp.amap -t 0x4010000
...then, after you edit and save exp.amap ...
tl1map load -f exp.amap -t 0x4010000
To copy the AlarmMap from one model to another
tl1map dump -m0x1503fcc -f/dev/stdout |
tl1map load -m0x1504003 -f/dev/stdin
To delete the “LINETERM” entry from the AlarmMap
tl1map dump -m0x1504003 -f/dev/stdout |
sed '/LINETERM/d' |
tl1map load -m0x1504003 -f/dev/stdin
To copy a model-based map from one host to a model type-based map
on another host:
tl1map dump -m0x1504003 -f/dev/stdout hosta |
tl1map load -t0x25040cc -f/dev/stdin hostb
Installing and Using the TL1 Gateway
23
The TL1 AlarmMap
The following example shows a shell script that could be used to implement a
simple AlarmMap editor:
#! /bin/ksh
#
# A simple AlarmMap editor
#
# Syntax: tl1edit { -m | -f } handle [ host ]
#
# Your favorite text editor
if [[ -z $EDITOR ]]; then
EDITOR=vi
fi
# Generate a unique, temp file name
MF=`date '+%Y%m%d%H%M%S.almap'`
# Dump the AlarmMap to that temp file
tl1map dump -f $MF $*
# Make a backup copy
cp $MF $MF.orig
# Invoke your favorite editor on that file
$EDITOR $MF
# If there are no changes, remove temp mapfiles & exit
diff $MF $MF.orig > /dev/null && rm -rf $MF $MF.orig && exit
# If there were changes, load them into the attribute
tl1map load -f $MF $*
24
TL1 Gateway User Guide
Chapter 3: Managing the TL1 Gateway
Deamon
The TL1 Gateway Daemon
The TL1 Gateway daemon (TL1d) must be up and running in order to translate
alarms from the modeled TL1 device into SPECTRUM events and alarms. The
daemon is located in your top-level SPECTRUM directory’s TL1Apps subdirectory.
Syntax:
TL1d [-p gw-port]
The [-p gw-port] option specifies that a TL1 Gateway port (gw-port) other than the
one specified at model creation will be designated for communication between
the daemon and SpectroSERVER.
Note: The default value of 64222 may be changed, but it is recommended that
you not use 65535, as this is likely to conflict with other applications.
Starting the TL1 Daemon on the SPECTRUM Machine
This procedure varies only slightly (Step 3) for the Solaris and NT platforms.
1.
Launch a command shell window.
2.
Navigate to the TL1Apps subdirectory in your top-level SPECTRUM directory.
3.
Enter one of the following commands:
TL1d ( or ./TL1d on Solaris)
or, if you want to use a different gateway port...
TL1d ( or ./TL1d on Solaris) -p <your-gw-port number>
As soon as you see “@(#)” followed by the actual port number, the daemon is
running and you can then minimize the command shell window.
Managing the TL1 Gateway Deamon
25
Starting the TL1 Daemon on a Remote Machine
Starting the TL1 Daemon on a Remote Machine
This procedure is described separately for NT and Solaris below. In either case,
you will need to know the IP address of the machine in your network that hosts
the CORBA osagent. This will probably be the same machine SPECTRUM is
running on.
Starting the TL1 Daemon on a Remote Machine on NT
1. Launch a command shell window.
2. Navigate to the directory where your TL1d.exe file resides.
3. Enter one of the following commands:
TL1d
or, if you want to use a different gateway port...
TL1d -p <your-gw-port number>
As soon as you see “@(#)” followed by the actual port number, the daemon is
running and you can then minimize the command shell window.
Starting the TL1 Daemon on a Remote Machine on Solaris
1. Launch a command shell window.
2. Navigate to the directory where your TL1d file resides.
3. Enter one of the following commands:
./TL1d
or, if you want to use a different gateway port...
./TL1d -p <your-gw-port number>
As soon as you see “@(#)” followed by the actual port number, the daemon is
running and you can then minimize the command shell window.
26
TL1 Gateway User Guide
Terminating the TL1 Daemon
Terminating the TL1 Daemon
The specific command or procedure for gracefully terminating the TL1 daemon
depends on the platform the daemon is running on.
On Solaris, use either the kill command or Control-C
On NT, bring up the Task Manager, select the TL1d process, and then terminate
it.
Managing the TL1 Gateway Deamon
27
Terminating the TL1 Daemon
28
TL1 Gateway User Guide
Index
A
AlarmMap • 17, 19
Examples • 23
Extraction • 22
Format • 19
Importing • 22
Usage • 23
Utility • 20
Autonomous Port • 14
C
Pre Login Sequence • 15
proxy devices • 1
S
SPECTRUM TL1 Gateway • 1
T
telecom network elements
manage • 1
telecommunications management • 1
Command on First Logon • 16
TID • 16
Congestion Considerations • 12
TL1 • 1
AlarmMap • 17
Alarms • 17
alarms • 1
Alarms Details • 18
devices • 1
events • 1
CTAG • 16
G
Gateway Network Element • 1
I
Installation Options • 6
Installing
NT • 6
Solaris • 7
IPv6 • 3
M
Max Logins Per Telnet • 11
Processing Considerations • 12
TL1 Daemon
Starting • 25
Remote Machine • 26
SPECTRUM Machine • 25
Terminating • 27
TL1 Device Model
Creating • 8
TL1 Gateway
Installation Options • 6
Installed on Remote Host • 5
Installed on SPECTRUM Host • 4
prerequisites • 3
TL1 Gateway Daemon • 25
Max Telnet Sessions • 11
Processing Considerations • 12
TL1 Gateway Deamon
Managing • 25
P
TL1Apps directory • 6
TL1d • 6
tl1map • 6
Port Numbers
Setting • 7
TL1 Device Port • 7
TL1 Gateway Port • 7
tl1map • 20
tl1map Utility • 20
Index 29
U
Upgrade Considerations • 13
W
Who Should Read This Guide • v
Index 30
Download PDF
Similar pages