cisco.ons.tl1

7/31/2019 Cisco.ons.Tl1

http://slidepdf.com/reader/full/ciscoonstl1 1/4

C H A P T E R

2-1Cisco CNS Notification Engine TL1 Support Guide

OL-3058-01

2

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. Thischapters 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 TypeThe /opt/ssng/config/TL1/tl1deviceInfo.dat file contains information about each of the devices towhich the TL1 Listener connects. This dat file is read by the TL1Listener during its initialization. Forthe TL1 Listener to receive messages from a device, you can manually add the new device to thetl1deviceInfo.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 usingthe ./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 theCNS Notification Engine.

http://p/NOTE/3_0_docs/Install-User/using.pdf





OL-3058-01

Chapter 2 Extending Support for Additional TL1 MessagesExtending Support for New Messages from Supported Device Types

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 CNSNotification 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 TL1Lis tener which will connect to all the devices included inthe tl1deviceInfo.dat file.

Step 4 Ensure that no errors are logged by the CNS Notification Engine when the TL1 Listener connects to alldevices. 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 theCNS Notification Engine.

Extending Support for New Messages from Supported DeviceTypes

When an Autonomous message is received by the TL1 Listener, the parser within the Listener will parsethe message based on the ONS.tcs definition file that is loaded into the parser during TL1 Listenerstartup.

If the Autonomous message definition is found within the ONS.tcs file, the parser parses the TL1message into Name-Value pairs.

If a device sends an autonomous message that is not supported, that is the definition for that TL1 messageis not present in the ONS.tcs definition file, the message will not be parsed. Only the default Name-Valuepairs will be sent to the event adapter.

The following is an example of a TL1 Autonomous message:

cpcons-1 1970-01-28 00:38:20A 3573 REPT EVT OC3"FAC-14-2:T-ESS,TC,,,,,500,500,15-MIN:\"Performance Monitor Threshold Crossing Alert\",";








OL-3058-01

Chapter 2 Extending Support for Additional TL1 MessagesExtending 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 thefollowing:

Name=Listener Value=TL1Name=Module Value=15454Name=SID Value=cpcons-1

Name=Date Value=1970-01-28Name=Time Value=00:38:20Name=AlarmCode Value=AName=ATAG Value=3573Name=Verb Value=REPTName=Modifier1 Value=EVTName=Modifier2 Value=OC3Name=AID Value=FAC-14-2Name=CONDTYPE Value=T-ESSName=CONDEFF Value=TCName=MONVAL Value=500Name=THLEV Value=500Name=TMPER Value=15-MINName=desc Value="Performance Monitor Threshold Crossing Alert"Name=Severity Value=2

Name=Type Value=UNKNOWN

If the message definition is not present in the ONS.tcs file, only the default Name-Value pairs wouldexist and the message will not be parsed for other attributes. The default Name-Value pairs look like thefollowing:

Name=Listener Value=TL1Name=Module Value=15454Name=SID Value=cpcons-1Name=Date Value=1970-01-28Name=Time Value=00:38:20Name=AlarmCode Value=AName=ATAG Value=3573Name=Verb Value=REPTName=Modifier1 Value=EVTName=Modifier2 Value=OC3Name=Severity Value=2Name=Type Value=UNKNOWNName=Message Value=<The remainder of the message, separated by a space>

Unsupported messages will be published in the class Cisco_Unsupported . Note that specificName-Value pairs such as AID , CONDTYPE , and CONDEFF are not included with unsupportedmessages.

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 andmodify .tcs files. This Command Set contains XML-based TL1 Message definitions (metadata) in a TCSfile.

Refer to TL1 Documentation at http://www.adventnet.com/products/tl1/help/index.html for more detailson 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.

http://p/NOTE/3_0_docs/TL1_mes/messages.pdf







OL-3058-01

Chapter 2 Extending Support for Additional TL1 MessagesExtending Support for a New Device Type

Extending Support for a New Device TypeThe 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 usingthe ./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 theCNS Notification Engine.

Step 2 Obtain a list of all the TL1 Messages supported by the new device type.

Step 3Manually create a new module for the new device in the

ONS.tcsfile, or use the TL1 Message BuilderGUI tool provided by Adventnet.

Step 4 Manually update the ONS.tcs file in the new module to add the definitions of all the messages for thatnew device type.

Refer to TL1 Documentation at http://www.adventnet.com/products/tl1/help/index.html for more detailson 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 themessages supported by the device type.

Step 5 Add the new devices to the /opt/ssng/config/TL1/tl1deviceInfo.dat file. Refer to the section “ExtendingSupport for a New Device of a Supported Device Type” earlier in this chapter.

Step 6 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.ons.tl1

Documents