How to include a Trouble Ticket ID in Spectrum Alarm Notifier output

Document ID : KB000115363
Last Modified Date : 19/09/2018
Show Technical Document Details
Introduction:
When generating Alarms with Trouble Ticket IDs as a result of a CA Spectrum Integration with, for example, CA Service Desk, it is useful if the Trouble Ticket ID can be included in data provided by the Spectrum Alarm Notification Manager (SANM)?
Question:
When generating Alarms with Trouble Ticket IDs can the value be passed to a script launched by the Spectrum Alarm Notification Manager (SANM)?
Environment:
All supported CA Spectrum releases
Answer:
Refer to the "Passing CA Spectrum Attributes to Scripts" section in the CA Spectrum Product Documentation for additional details.

It notes:

In the .alarmrc file, set the appropriate parameter equal to the CA Spectrum attribute IDs that you want to pass. You can reference the attribute ID either in hexadecimal or decimal notation.

It also provides the following example.

Example

The following example shows four sample CA Spectrum attributes that are passed to AlarmNotifier in the .alarmrc file. The attributes are then referenced in a script.

.alarmrc File Reference

USE_NEW_INTERFACE=TRUE
EXTRA_ATTRS_AS_ENVVARS=0x100c5,0x11f84
EXTRA_ATTRS_AS_ARGS=0x110df,0x117dc

Script Reference

#These lines read 0x110df and 0x117dc into the variables MAC_ADDRESS 
#and FIRMWARE_VERSION respectively.
shift 9
MAC_ADDRESS=$1
FIRMWARE_VERSION=$2
#These lines print out the value of each attribute.(Solaris Platform)
echo "The value of attribute 0x100c5 is: " $SANM_0x100c5
echo "The value of attribute 0x11f84 is: " $SANM_0x11f84
echo "The value of attribute 0x110df is: " $MAC_ADDRESS
echo "The value of attribute 0x117dc is: " $FIRMWARE_VERSION
#These lines print out the value of each attribute.(Windows Platform)
#references to environmental variables are in uppercase
echo "The value of attribute 0x100c5 is: " $SANM_0X100C5
echo "The value of attribute 0x11f84 is: " $SANM_0X11F84
echo "The value of attribute 0x110df is: " $MAC_ADDRESS
echo "The value of attribute 0x117dc is: " $FIRMWARE_VERSION

Global Alarm Attributes

This section lists the CA Spectrum Global Alarm attributes and their corresponding attribute IDs. Pass any of these attributes to AlarmNotifier using the method that is described inĀ Passing CA Spectrum Attributes to Scripts.

  • NOTE: Many more are listed in Documentation. This is the specific one for Trouble Ticket IDs, the Trouble_Ticket_ID attribute.
  • Trouble_Ticket_ID
    0x12022