TL1Gatewayd

The Oracle Communications Unified Assurance Core TL1 Gateway is a reverse multiplexing engine that connects to configured TL1 gateways and elements defined in the graph database, runs polling, and outputs all the results via non-blocking output TCP socket. This component is designed to connect to TL1 or other ASCII devices and output all the autonomous messages and results from commands and make this available to TCP Socket listeners for Events, Metrics, and Topology processing.

You can run this application as a service using the Services UI.

Core TL1 Gateway Setup

The following steps show you how to setup TL1 objects.

  1. A device must exist in the Device Catalog for this application to be able to function. Devices can be created in several different ways:

    1. Using the Core Device Auto Discovery application.

    2. Using the Manual Discovery UI:

      Configuration -> Device Discovery -> Manual Discovery

    3. Manually entering all values using the Devices UI:

      Configuration -> Device Catalog -> Devices

  2. For each TL1 Gateway that will be connected to, create an entry in the Gateways UI. The gateway will need to be associated to a device in the Device Catalog.

    Configuration -> TL1 -> Gateways

  3. For each TL1 Network Element that will be connected to, create an entry in the Elements UI. The element entry will need the commands that will be run to retrieve data.

    Configuration -> TL1 -> Elements

  4. Enable the default Service, unless a specific configuration option is needed:

    Configuration -> Broker Control -> Services

  5. Configure and start the appropriate listening service(s) depending upon the data to be collected:

Default Service

The following table shows the settings for the default service. Actual values are in bold, descriptions of values are in plaintext.

Field Value
Package coreCollection-app
Name TL1 Gateway
Program bin/core/collection/TL1Gatewayd
Arguments This field is blank. There is no default value.
Description Supports collection of events, metrics, and topology via a reverse multiplexing of tl1 connections
Failover Type Standalone (Supported: Standalone, Primary, Redundant/Backup)
Status Disabled
Privileged This option is selected.

See Services in Unified Assurance User's Guide for general information about the settings for services.

See Using Application Primary/Backup Failover for more information about the different failover types.

Default Configuration

The following table shows the default configurations for the application. Actual values are in bold, descriptions of values are in plaintext.

Name Default Value Possible Values Notes
Host * Text, 255 characters The IP address to be used by the TCP host used for forwarding data. - NO RELOAD CONFIG SUPPORT
LogFile logs/TL1Gateway.log Text, 255 characters The relative path to the log file.
LogLevel ERROR OFF, FATAL, ERROR, WARN, INFO, DEBUG The logging level for the application.
PollTime 60 An integer The interval for automatic reconfiguration, reconnection and polling.
Port 9000 An integer The port to be used by the TCP host used for forwarding data. - NO RELOAD CONFIG SUPPORT
Buffer 32 Text (Optional) TL1 message buffer in kilobytes (1024) allowing up to that length before dropping - NO RELOAD CONFIG SUPPORT
CommandLimit 20 An integer (Optional) Buffer size for TL1 commands received from the CommandPort. Once this buffer is reached, commands are cycled out from the front of the queue as new commands come in (default: 20)
CommandDelimiter | Text (Optional) If a message is greater than 4096 characters, the delimiter will be used to put messages back together.
CommandPort 0 An integer (Optional) The port to be used for receiving TL1 commands from an external source to relay to connected gateway (default: 0/disabled). Command messages must follow the following format: GID=,. example: `GID=1,RTRV-PM-ALL:ATLNGA::CTAG;
DeviceGroupID This field is blank. There is no default value. The name of any available device group. (Optional) Used to get a more specific list of devices that will be connected to.
DeviceZoneID Default First Zone All Zones or the name of any available device zone. (Optional) Used to get a more specific list of devices that will be connected to.
Limit 150 An integer (Optional) Buffer size for TL1 messages received from gateways. Once this buffer is reached, messages are cycled out from the front of the queue as new messages come in (default: 150)
PollByIP Disabled Enabled or Disabled (Optional) If enabled, the gateway IP address will be used to connect to the gateway instead of the device DNS name.
PreferIPv4 Enabled Enabled or Disabled (Optional) Controls whether or not to prefer IPv4 transport to communicate with gateways. This option is only considered if both IPv4 and IPv6 are available for a gateway. If not specified, IPv6 will be preferred.
Threads 15 An integer (Optional) Upper limit for gateway thread pool. Thread pool will grow or shrink based on number of gateways up to this limit. NOTE: Currently if more gateways are configured to be polled than this limit, it is very likely poll cycles will be disrupted. (0=disable (no cap), default: 15)
TimeOut 30 An integer (Optional) Time to wait for response to commands sent to TL1 elements. Time to wait for response from SSH commands.
SocketTimeout 60 An integer (Optional) Timeout for Login commands to TL1 elements.

Administration Details

The following list shows the technical details you will need for advanced administration of the application: