Configuring Alarm Notification

Configuring a Basic Filter for Alarm Notification

The following steps show how to configure a basic filter based on unique event identifier (UEI), severity, and device family. When the alarm criteria specified in the XML file are matched, the alarm XML is passed as an argument to the invoked script.

1. Configure the destination for the notification in the script, for example, Sample_App_Script.sh. The script specifies how the alarm notifications are sent to the application.

   curl -v -u super:juniper123 -X POST -H  "Content-Type:application/xml" -d "$xml" "http://localhost:8080/SampleApplication/services/Alarms" 

   Note: In the preceding example, the curl command is used to post the script, but the configuration of the script can vary based on the requirements of the application. You can access sample configuration scripts from the /opt/opennms/etc/examples/alarm-notification/scripts directory. However, all active scripts must be present in the /opt/opennms/etc/alarm-notification/scripts directory.

2. In the alarmNotificationConf.xml configuration file:
   1. Enable the alarm notification feature:

      <notification name="SampleAppNotification" enable="true">
      

   2. Configure the number of seconds to wait for the script to execute before timing out:

      <script timeout_in_seconds=”45”>
       

      Note: If you do not configure the timeout_in_seconds attribute, the default time out for the script invoked is 60 seconds. In this case, the shell exit status will be ’143’ and error handling will be considered in the same way as other error exit status. If the script continues to execute after the timeout value for the script, alarm notification will not wait for the script status. During this time, processing of other alarms will not be blocked.

   3. Specify the name of the script that will be invoked:

      <scriptname>Sample_App_Script.sh</scriptname>

      The configured script must be present in the /opt/opennms/etc/alarm-notification/scripts directory.

   4. Enable error handling, and configure the number of notification retry attempts and interval (in seconds) between retry attempts, if the initial attempt to send the notification fails:

      <errorhandling enable="true">
           <retry_interval_inseconds>3</retry_interval_inseconds>
          <number_of_retries>2</number_of_retries>
      </errorhandling>
      

      Note: The script exit status should be ’0’ if there are no errors. For other exit status values, the script will be invoked again if error handling is enabled.

   5. Configure the UEI of the alarms which will require notification:

      <uies>
           <uei name="uei.opennms.org/generic/traps/SNMP_Link_Down"  notification_threshold=”5”
                <filter devicefamily=”JSeries” severity=”Minor,Normal”/>
                <filter devicefamily=”DevicesWithNoSysoid"  severity=”Minor,Normal”/>
           <uei/>
      </uies>
      

Activating Alarm Notification Configuration Files for Basic Filtering

1. Log in from the Junos Space system console.

   The Junos Space Appliance Settings menu displays.

2. From the Junos Space Appliance Settings menu, enter 7 (or enter 8 from the Junos Space Virtual Appliance) to run the shell.

3. (Optional): To view the sample configuration files for alarm notification:

   • Navigate to the /opt/opennms/etc/examples/alarm-notification directory to view sample files for alarmNotificationConf.xml, eventconf.xml, and vacuumd-configuration.xml.
   • Navigate to the /opt/opennms/etc/examples/alarm-notification/scripts directory to view the CBU_App_Script.sh and NA_App_Script.sh sample scripts.

4. To activate configuration files for alarm notification, perform the following steps:

   1. Add your configured alarmNotificationConf.xml file to the /opt/opennms/etc/alarm-notification directory.
   2. Add your configured eventconf.xml and vacuumd-configuration.xml files to the /opt/opennms/etc directory.
   3. Add your configured script file to the /opt/opennms/etc/alarm-notification/scripts directory.

Reloading a Filter Configuration to Apply Filter Configuration Changes

After making any changes to a filter, you can reload the configuration by sending a “reloadDaemonConfig” event, for example:

You do not need to restart the server to apply the configuration changes listed in previous steps. However, to send the event, go to /opt/opennms/bin ./send-event.pl -p 'daemonName Alarmd.AlarmNorthbounder' uei.opennms.org/internal/reloadDaemonConfig.

This event will reload the following files:

• alarmNotficationConf.xml
• devicefamily.properties
• Drool (.drl) files