How to configuring Spectrum Alarm Notifier to send email notifications

Document ID : KB000021373
Last Modified Date : 14/02/2018
Show Technical Document Details

Question: 

Configuring Spectrum Alarm Notifier for the first time. How to configure Spectrum Alarm Notifier to send email notifications.

Environment:  

Spectrum 9.x / 10.x

Answer: 

To configure AlarmNotifier to send an email when an alarm is received.

  1. Via Command Line or Windows Explorer go to the $SPECROOT/Notifier directory 
  2. Edit the SetScript File 
  3. Locate the following line:

    SENDMAIL=False
  4. Modify the entry as follows:

    SENDMAIL=True

The next line in the SetScript after SENDMAIL is VARFORMAIL. It can be configured to send an email to the email address(es) defined within the NotificationData setting of the associated SANM (Spectrum Alarm Notification Manager) policy. Since troubleshooter assignment is done on existing alarms the RepairPerson option is typically better suited for use in the UpdateScript and the ClearScript.

  1. Continuing on with editing the SetScript 
  2. Locate the following line: 

    VARFORMAIL=RepairPerson
  3. Modify the entry as follows:

    VARFORMAIL=NotificationData
  4. Save the changes made to this file.

To configure AlarmNotifier to send an email when an alarm is updated (for instance when an alarm is acknowledged) modify the UpdateScript. Follow the steps above and make the same modifications to the SENDMAIL line made in the SetScript. In this case VARFORMAIL can be configured to send an email to a troubleshooter when they are assigned with the RepairPerson setting. The NotificationData option can also be used to send an email via SANM. The third option is Both which can be employed to allow email notifications to both NotificationData and RepairPerson.

  1. To configure VARFORMAIL in the UpdateScript 
  2. Locate the following line: 

    VARFORMAIL=RepairPerson
  3. Configure as required with RepairPerson, NotificationData or Both
  4. Save the changes made to this file.

To configure AlarmNotifier to email when an alarm is cleared modify the ClearScript. Follow the steps for modifying UpdateScript above and make the same modifications.

At this point, AlarmNotifier can be run via the command line manually. More often than not users want AlarmNotifier to start and restart automatically as opposed to having to start the utility manually. This can be done via processd. Also, the advantage to having AlarmNotifier started via processd is a log will be kept of the notifications that are sent. And processd can be configured to automatically restart Notifier if it is stopped. To start AlarmNotifier automatically and have it restarted if stopped please follow these steps:

  1. Via Command Line or Windows Explorer go to the $SPECROOT/lib/SDPM/partslist directory 
  2. Edit the ALARMNOTIFIER.idb 
  3. Locate the following lines:

    AUTORESTART;y;
    AUTOBOOTSTART;n;
  4. Out of the box you can see AUTORESTART is already set to yes. Change the AUTOBOOTSTART to yes also. The entries should now appear as:

    AUTORESTART;y;
    AUTOBOOTSTART;y;
  5. Save the changes made to this file.

The next time this server is rebooted AlarmNotifier will automatically start via processd. These steps will allow processd to start any services that are not already running. But will not impact the services that are running. If you wish to have AlarmNotifier started without a reboot please do the following:

  1. Open a bash shell (on windows run bash -login) 
  2. Change directory to $SPECROOT/lib/SDPM 
  3. Run: ./processd -restart
  4. Verify AlarmNotifier is now a running process

WINDOWS ONLY

CA includes Simple mail for use in sending emails. This will also need to configured for AlarmNotifier to successfully send an email. To configure Simple mail please do the following:

  1. Open a command prompt in Windows 
  2. mail -h SMTP Hostname -u Return Username -m Domain Name
  3. As an example mail -h smtp.ca.com -u spectrum -m ca.com
  4. Once this command is run you can run regedit and search for smail. In the smail folder these are the entries from the example. You should see the settings you used.

    Default REG_SZ (value not set)
    hostname REG_SZ ca.com
    smtphost REG_SZ smtp.ca.com
    username REG_SZ spectrum

SOLARIS/LINUX ONLY

AlarmNotifier utilizes the email utility configured for the Operating System, typically this is sendmail. If emails fail to send please see your system admin to ensure sendmail is set up correctly for your environment.

 

Additional Information:

For more information on Alarm Notifier please reference:

 

https://docops.ca.com/ca-spectrum/10-1/en/managing-client-applications/alarmnotifier