TL1 Gateway User Guide - ehealth-spectrum.ca.com

1 Titlepage TL1 Gateway user Guide Document 9035087-01. Applications & Gateways Copyright Notice Document 9035087-01. Copyright January 2002 Aprisma Management Technologies, Inc., 121. Technology Drive, Durham, NH 03824 USA. All rights reserved worldwide. Use, duplication, or disclosure by the United States government is subject to the restrictions set forth in DFARS. (c)(1)(ii) and FAR Liability Disclaimer Aprisma Management Technologies, Inc. ("Aprisma") reserves the right to make changes in specifications and other information contained in this document without prior notice. In all cases, the reader should contact Aprisma to inquire if any changes have been made. The hardware, firmware, or software described in this manual is subject to change without notice. IN NO EVENT SHALL APRISMA, ITS EMPLOYEES, OFFICERS, DIRECTORS, AGENTS, OR. AFFILIATES BE LIABLE FOR ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL. DAMAGES WHATSOEVER (INCLUDING BUT NOT LIMITED TO LOST PROFITS) ARISING OUT.

2 OF OR RELATED TO THIS MANUAL OR THE INFORMATION CONTAINED IN IT, EVEN IF. APRISMA HAS BEEN ADVISED OF, HAS KNOWN, OR SHOULD HAVE KNOWN, THE. POSSIBILITY OF SUCH DAMAGES. Trademark, Service Mark, and Logo Information spectrum , IMT, and the spectrum IMT/VNM logo are registered trademarks of Aprisma Management Technologies, Inc., or its affiliates. APRISMA, APRISMA MANAGEMENT. TECHNOLOGIES, the APRISMA MANAGEMENT TECHNOLOGIES logo, MANAGE WHAT. MATTERS, DCM, VNM, SpectroGRAPH, SpectroSERVER, Inductive Modeling Technology, Device Communications Manager, spectrum Security Manager, and Virtual Network Machine are unregistered trademarks of Aprisma Management Technologies, Inc., or its affiliates. For a complete list of Aprisma trademarks, service marks, and trade names, go to All referenced trademarks, service marks, and trade names identified in this document, whether registered or unregistered, are the intellectual property of their respective owners. No rights are granted by Aprisma Management Technologies, Inc.

3 , to use such marks, whether by implication, estoppel, or otherwise. If you have comments or concerns about trademark or copyright references, please send an e-mail to we will do our best to help. TL1 Gateway user Guide Page 2. Restricted Rights Notice (Applicable to licenses to the United States government only.). This software and/or user documentation is/are provided with RESTRICTED AND LIMITED. RIGHTS. Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR (June 1987) Alternate III (g)(3) (June 1987), FAR (June 1987), or DFARS (c)(1)(ii) (June 1988), and/or in similar or successor clauses in the FAR or DFARS, or in the DOD or NASA FAR Supplement, as applicable. Contractor/manufacturer is Aprisma Management Technologies, Inc., 121 Technology Drive, Durham, NH 03824. In the event the government seeks to obtain the software pursuant to standard commercial practice, this software agreement, instead of the noted regulatory clauses, shall control the terms of the government's license.

4 Virus Disclaimer Aprisma makes no representations or warranties to the effect that the licensed software is virus- free. Aprisma has tested its software with current virus-checking technologies. However, because no anti-virus system is 100 percent effective, we strongly recommend that you write-protect the licensed software and verify (with an anti-virus system in which you have confidence) that the licensed software, prior to installation, is virus-free. Contact Information Aprisma Management Technologies, Inc. 273 Corporate Drive Portsmouth, NH 03801. Phone: toll-free: Web site: TL1 Gateway user Guide Page 3. Contents Introduction 5. What Is TL1? ..5. What Is the spectrum TL1 Gateway ? ..5. Honored TL1 Standards ..6. What Does the spectrum TL1 Gateway Include? ..7. Using the TL1 Gateway 8. Prerequisites for the TL1 Gateway ..8. Installation Options ..11. Installing on a Non- spectrum Machine ..11. Setting up Port Numbers ..13. Creating a TL1 Device Model.

5 13. TL1 Devices with Autonomous Port ..17. The TL1 AlarmMap ..18. Format of the AlarmMap ..19. The tl1map Utility ..20. AlarmMap Extraction ..22. Importing an AlarmMap ..22. Examples of tl1map Usage ..23. The TL1 Gateway Daemon ..26. Starting the TL1 Daemon on the spectrum Machine ..26. Starting the TL1 Daemon on a Remote Machine ..27. Terminating the TL1 Daemon ..28. TL1 Gateway user Guide Page 4. Introduction 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 in Piscataway, NJ.)

6 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. Figure 1 on Page 6 shows the Alarm Manager's Main window with the Probable Cause tab activated. For more information on this application, refer to the Enterprise Alarm Manager user 's Guide (9032065). TL1 Gateway user Guide Page 5. Figure 1: Enterprise Alarm Manager: Main Window Honored TL1 Standards The spectrum TL1 Gateway implements the full range of TL1 Condition Types as specified in appendix C of Telcordia Technologies Generic Requirements GR-833-CORE, OTGR: Network Maintenance: Network Element and Transport Surveillance Messages.

7 Issue 4, June 2000. TL1 Gateway user Guide Page 6. What Does the spectrum TL1 Gateway Include? 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 Page 7. Using the TL1 Gateway This section describes how to install, configure, and use 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 (Figure 2 on Page 9), or on a separate machine (Figure 3 on Page 10). 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 .

8 A high volume of TL1 traffic has to be processed. TL1 Gateway user Guide Page 8. Figure 2: TL1 Gateway Installed on spectrum Host TL1 Gateway user Guide Page 9. Figure 3: TL1 Gateway Installed on Remote Host TL1 Gateway user Guide Page 10. 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 TL1 Apps, which is located in your top-level spectrum directory. The TL1 Apps 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.

9 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 Regardless of the platform spectrum is running on (Solaris or NT), the TL1 daemon component can be installed Note: Note: 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. On NT. TL1 Gateway user Guide Page 11. 1 Navigate into the TL1GW folder on the spectrum application CD. 2 Run the program. 3 Copy the resulting files (listed below) to the proper locations on the NT. machine: The executables and 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.

10 On Solaris: 1 Navigate into the TL1GW directory on the spectrum application CD. 2 Run the program. 3 Copy the resulting files (listed below) to the proper locations on the Solaris machine: TL1d tl1map The executables TL1d and tl1map should be copied to the preferred locations. The shared library should be copied to the preferred system area for third-party libraries ( , /usr/lib). If using a location other than /usr/lib, the environment variable LD_LIBRARY_PATH must be updated to include that location. Identify a machine in your network that hosts the CORBA osagent, and in your profile file (or the equivalent on NT) permanently set the environment variable OSAGENT_ADDR to the IP address of that machine. This is mandatory and will ensure that the TL1 components can access model and model type information from the spectrum database. TL1 Gateway user Guide Page 12. Your profile or file should contain a line similar to one of the following two examples: export OSAGENT_ADDR= set OSAGENT_ADDR= Setting up Port Numbers When you create a TL1 device model, the two port numbers described below need to be specified.