C H A P T E R

Extending Support for Additional TL1 Messages

Cisco CNS Notification Engine (CNS-NOTE), Release 3.0 supports specific Transactional Language 1 (TL1) messages. This chapter describes how you extend support for additional TL1 messages. This chapters contains the following sections:

Extending Support for a New Device of a Supported Device Type Extending Support for New Messages from Supported Device Types Extending Support for a New Device Type

Extending Support for a New Device of a Supported Device Type

The /opt/ssng/config/TL1/tl1deviceInfo.dat file contains information about each of the devices to which the TL1 Listener connects. This dat file is read by the TL1Listener during its initialization. For the TL1 Listener to receive messages from a device, you can manually add the new device to the tl1deviceInfo.dat file, if it belongs to one of the supported device types:

Cisco ONS 15454 Cisco ONS 15327 Cisco ONS 15800 Cisco ONS 15801

The following is a typical entry in the tl1deviceInfo.dat:

nodename=cpcons-1 portno=2361 targetid=192.168.118.111 username=CISCO15 password = device=15454 chatInString=ACT-USER:cpcons-1:CISCO15:TEST::; chatOutString=CANC-USER:cpcons-1:TEST; keepAliveMsg=RTRV-HDR:cpcons-1::TEST; keepaliveInt=700

To manually add a new device for TL1 message support, do the following:
Step 1

In case the CNS Notification Engine application has been started, stop CNS Notification Engine using the ./ssng stop command. Refer to the section Stopping the CNS Notification Engine in the Cisco CNS Notification Engine Installation and User Guide for Release 3.0 for further information on stopping the CNS Notification Engine.

Cisco CNS Notification Engine TL1 Support Guide OL-3058-01

2-1

Chapter 2 Extending Support for New Messages from Supported Device Types

Extending Support for Additional TL1 Messages

Step 2

Update the tl1deviceInfo.dat file with the details of the new device. The details to be added include:
nodename portno targetid username password device chatInString chatOutString keepAliveMsg keepaliveInt

Step 3

Start the CNS Notification Engine using the ./setup command. Refer to the section Starting the CNS Notification Engine in the Cisco CNS Notification Engine Installation and User Guide for Release 3.0 for further information on stopping the CNS Notification Engine The CNS Notification Engine initiates the TL1Listener which will connect to all the devices included in the tl1deviceInfo.dat file.

Step 4

Ensure that no errors are logged by the CNS Notification Engine when the TL1 Listener connects to all devices. Check /opt/ssng/log/server.log for server startup messages. If errors are logged by the CNS Notification Engine, correct the tl1deviceInfo.dat file and restart the CNS Notification Engine.

Extending Support for New Messages from Supported Device Types

When an Autonomous message is received by the TL1 Listener, the parser within the Listener will parse the message based on the ONS.tcs definition file that is loaded into the parser during TL1 Listener startup. If the Autonomous message definition is found within the ONS.tcs file, the parser parses the TL1 message into Name-Value pairs. If a device sends an autonomous message that is not supported, that is the definition for that TL1 message is not present in the ONS.tcs definition file, the message will not be parsed. Only the default Name-Value pairs will be sent to the event adapter. The following is an example of a TL1 Autonomous message:
cpcons-1 1970-01-28 00:38:20 A 3573 REPT EVT OC3 "FAC-14-2:T-ESS,TC,,,,,500,500,15-MIN:\"Performance Monitor Threshold Crossing Alert\"," ;

Cisco CNS Notification Engine TL1 Support Guide

2-2

OL-3058-01

Chapter 2

Extending Support for Additional TL1 Messages Extending Support for New Messages from Supported Device Types

If the definition for this message is present in ONS.tcs, then the message is parsed as shown in the following:
Name=Listener Name=Module Name=SID Name=Date Name=Time Name=AlarmCode Name=ATAG Name=Verb Name=Modifier1 Name=Modifier2 Name=AID Name=CONDTYPE Name=CONDEFF Name=MONVAL Name=THLEV Name=TMPER Name=desc Name=Severity Name=Type Value=TL1 Value=15454 Value=cpcons-1 Value=1970-01-28 Value=00:38:20 Value=A Value=3573 Value=REPT Value=EVT Value=OC3 Value=FAC-14-2 Value=T-ESS Value=TC Value=500 Value=500 Value=15-MIN Value="Performance Monitor Threshold Crossing Alert" Value=2 Value=UNKNOWN

If the message definition is not present in the ONS.tcs file, only the default Name-Value pairs would exist and the message will not be parsed for other attributes. The default Name-Value pairs look like the following:
Name=Listener Value=TL1 Name=Module Value=15454 Name=SID Value=cpcons-1 Name=Date Value=1970-01-28 Name=Time Value=00:38:20 Name=AlarmCode Value=A Name=ATAG Value=3573 Name=Verb Value=REPT Name=Modifier1 Value=EVT Name=Modifier2 Value=OC3 Name=Severity Value=2 Name=Type Value=UNKNOWN Name=Message Value=<The remainder of the message, separated by a space>

Unsupported messages will be published in the class Cisco_Unsupported. Note that specific Name-Value pairs such as AID, CONDTYPE, and CONDEFF are not included with unsupported messages. To support any new message, the corresponding module for that particular device type in the ONS.tcs file should be updated with the definition of that message. The message syntax for all supported device messages is provided in Chapter 1, Supported TL1 Messages. The ONS.tcs file can be updated with the new message definitions manually to create and modify .tcs files. This Command Set contains XML-based TL1 Message definitions (metadata) in a TCS file. Refer to TL1 Documentation at http://www.adventnet.com/products/tl1/help/index.html for more details on how to prepare a .tcs file for new messages.

Note

You must stop and restart the CNS Notification Engine for the new messages to be supported.

Cisco CNS Notification Engine TL1 Support Guide OL-3058-01

2-3

Chapter 2 Extending Support for a New Device Type

Extending Support for Additional TL1 Messages

Extending Support for a New Device Type

The TL1 Listener supports the following Cisco ONS devices:

Cisco ONS 15454 Cisco ONS 15327 Cisco ONS 15800 Cisco ONS 15801

To support new device type messages, do the following:

Step 1

In case the CNS Notification Engine application has been started, stop CNS Notification Engine using the ./ssng stop command. Refer to the section Stopping the CNS Notification Engine in the Cisco CNS Notification Engine Installation and User Guide for Release 3.0 for further information on stopping the CNS Notification Engine. Obtain a list of all the TL1 Messages supported by the new device type. Manually create a new module for the new device in theONS.tcs file, or use the TL1 Message Builder GUI tool provided by Adventnet. Manually update the ONS.tcs file in the new module to add the definitions of all the messages for that new device type. Refer to TL1 Documentation at http://www.adventnet.com/products/tl1/help/index.html for more details on how to prepare a .tcs file for new messages. Once the ONS.tcs file is updated, the TL1 Listener is ready to handle the new device type and all of the messages supported by the device type.

Step 2 Step 3 Step 4

Step 5 Step 6

Add the new devices to the /opt/ssng/config/TL1/tl1deviceInfo.dat file. Refer to the section Extending Support for a New Device of a Supported Device Type earlier in this chapter. Start the CNS Notification Engine using the ./setup command. Refer to the section Starting the CNS Notification Engine in the Cisco CNS Notification Engine Installation and User Guide for Release 3.0 for further information on stopping the CNS Notification Engine

Cisco CNS Notification Engine TL1 Support Guide

2-4

OL-3058-01