Skip to content

Assure1 Core TL1 Gateway

Overview

The Assure1 Core TL1 Gateway is a reverse multiplexing engine that connects to configured TL1 gateways and elements defined in the orient database, executes 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.

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 "Device Auto Discovery" application (DeviceAutoDiscovery). See the application documentation for additional information.

    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 executed 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

Field Value
Package Name coreCollection-app
Service Name TL1 Gateway
Service Program bin/core/collection/TL1Gatewayd
Service Arguments
Service Description Supports collection of events, metrics, and topology via a reverse multiplexing of tl1 connections
Failover Type Standalone (Supported: Standalone, Primary/Backup)
Status Disabled
Privileged (Checked)

Default Configuration

Name 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 Relative path to Log File.
LogLevel ERROR OFF, FATAL, ERROR, WARN, INFO, DEBUG Logging level used by application.
PollTime 60 Integer The interval for automatic reconfiguration, reconnection and polling.
Port 9000 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 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 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 Integer Optional - Used to get a more specific list of devices that will be connected to.
DeviceZoneID Default First Zone Integer Optional - Used to get a more specific list of devices that will be connected to.
Limit 150 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/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/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 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 Integer Optional - Time to wait for response to commands sent to TL1 elements. Time to wait for response from SSH commands.
SocketTimeout 60 Integer Optional - Timeout for Login commands to TL1 elements.

Administration Details

The following list shows the technical details needed for advanced administration of the application:

  • Package - coreCollection-app

  • Synopsis - ./TL1Gatewayd [OPTIONS]

  • Options:

     -c, --AppConfigID N   Application Config ID (Service, Job, or Request ID)
 -?, -h, --Help        Print usage and exit

  • Threaded - Multi-Threaded