AlarmNotifier User Guide

AlarmNotifier
User Guide
Document 1503
Notice
Copyright Notice Copyright © 2002-present by Aprisma Management Technologies, Inc. All rights reserved worldwide. Use,
duplication, or disclosure by the United States government is subject to the restrictions set forth in DFARS 252.227-
7013(c)(1)(ii) and FAR 52.227-19.
Liability Disclaimer Aprisma Management Technologies, Inc. (“Aprisma”) reserves the right to make changes in specifications
and other information contained in this document without prior notice. In all cases, the reader should contact Aprisma to
inquire if any changes have been made.
The hardware, firmware, or software described in this manual is subject to change without notice.
IN NO EVENT SHALL APRISMA, ITS EMPLOYEES, OFFICERS, DIRECTORS, AGENTS, OR AFFILIATES BE LIABLE FOR
ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING BUT NOT
LIMITED TO LOST PROFITS) ARISING OUT OF OR RELATED TO THIS MANUAL OR THE INFORMATION CONTAINED
IN IT, EVEN IF APRISMA HAS BEEN ADVISED OF, HAS KNOWN, OR SHOULD HAVE KNOWN, THE POSSIBILITY OF
SUCH DAMAGES.
Trademark, Service Mark, and Logo Information SPECTRUM, IMT, and the SPECTRUM IMT/VNM logo are registered
trademarks of Aprisma Management Technologies, Inc., or its affiliates. APRISMA, APRISMA MANAGEMENT
TECHNOLOGIES, the APRISMA MANAGEMENT TECHNOLOGIES logo, MANAGE WHAT MATTERS, DCM, VNM,
SpectroGRAPH, SpectroSERVER, Inductive Modeling Technology, Device Communications Manager, SPECTRUM Security
Manager, and Virtual Network Machine are unregistered trademarks of Aprisma Management Technologies, Inc., or its
affiliates. For a complete list of Aprisma trademarks, service marks, and trade names, go to:
http://www.aprisma.com/support/secure/manuals/trademark-list.htm
All referenced trademarks, service marks, and trade names identified in this document, whether registered or unregistered,
are the intellectual property of their respective owners. No rights are granted by Aprisma Management Technologies, Inc., to
use such marks, whether by implication, estoppel, or otherwise. If you have comments or concerns about trademark or
copyright references, please send an e-mail to spectrum-docs@aprisma.com; we will do our best to help.
Restricted Rights Notice (Applicable to licenses to the United States government only.)
This software and/or user documentation is/are provided with RESTRICTED AND LIMITED RIGHTS. Use, duplication, or
disclosure by the government is subject to restrictions as set forth in FAR 52.227-14 (June 1987) Alternate III(g)(3) (June
1987), FAR 52.227-19 (June 1987), or DFARS 52.227-7013(c)(1)(ii) (June 1988), and/or in similar or successor clauses in the
FAR or DFARS, or in the DOD or NASA FAR Supplement, as applicable. Contractor/manufacturer is Aprisma Management
Technologies, Inc. In the event the government seeks to obtain the software pursuant to standard commercial practice, this
software agreement, instead of the noted regulatory clauses, shall control the terms of the government's license.
Virus Disclaimer Aprisma makes no representations or warranties to the effect that the licensed software is virus-free.
Aprisma has tested its software with current virus-checking technologies. However, because no antivirus system is 100-
percent effective, we strongly recommend that you write protect the licensed software and verify (with an antivirus system with
which you have confidence) that the licensed software, prior to installation, is virus-free.
Contact Information Aprisma Management Technologies, Inc., 273 Corporate Drive, Portsmouth, NH 03801 USA
Phone: 603.334.2100
U.S. toll-free: 877.468.1448
Web site: http://www.aprisma.com
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 1: Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
The alarm-monitoring process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
SPECTRUM functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
AlarmNotifier functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
SPECTRUM Alarm Notification Manager (SANM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 2: Operating AlarmNotifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Starting AlarmNotifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Stopping AlarmNotifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Starting AlarmNotifier with the process daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
AlarmNotifier output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
SetScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
ClearScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
UpdateScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Script parameter definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Persistent and stale alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Chapter 3: Customizing AlarmNotifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Modifying scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Enabling e-mail in a script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Configuring mail service on Windows platform . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Limiting script output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Passing SPECTRUM attributes to scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Global Alarm attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Sending data to a third-party application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Customizing the .alarmrc resource file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
.alarmrc parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Re-installing or upgrading SPECTRUM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3
Contents
4 Alarm Notifier User Guide

Preface
This guide is intended for system administrators who are responsible for configuring AlarmNotifier
and implementing AlarmNotifier capabilities to monitor and respond to alarms generated by
SPECTRUM.
What is in this book
This guide contains the following chapters:
• Chapter 1: Overview - This chapter serves as an introduction to SPECTRUM’s

AlarmNotifier.
• Chapter 2: Operating AlarmNotifier - This chapter gives instruction on how to start and
stop AlarmNotifier and describes the output that AlarmNotifier generates.
• Chapter 3: Customizing AlarmNotifier - This chapter describes how to customize the

AlarmNotifier application by modifying AlarmNotifier scripts and the AlarmNotifier resource
file.
Text Conventions
The following text conventions are used in this document:
Element Convention Used Example
Variables Courier and Italic in Type the following:

(The user supplies a value angle brackets (<>) DISPLAY=<workstation
for the variable.) name>:0.0 export display
The directory where you <$SPECROOT> Navigate to:

installed SPECTRUM <$SPECROOT>/app-defaults
(The user supplies a value
for the variable.)
5
Preface
Element Convention Used Example
Solaris and Windows Unless otherwise noted, <$SPECROOT>/app-defaults

directory paths directory paths are common on Solaris is equivalent to
to both operating systems, <$SPECROOT>\app-defaults
with the exception that on Windows.
slashes (/) should be used
in Solaris paths, and
backslashes (\) should be
used in Windows paths.
On-screen text Courier The following line displays:

path=”/audit”
User-typed text Courier Type the following path name:

C:\ABC\lib\db
Cross-references Underlined and hypertext- See “Document Feedback” on

blue page 6.
References to SPECTRUM Italic SPECTRUM Installation Guide

documents (title and (0675)
number)
Document Feedback
Please send feedback regarding SPECTRUM documents to the following e-mail address:
spectrum-docs@aprisma.com
Thank you for helping us improve our documentation.
Online Documents
SPECTRUM documents are available online at:
http://www.aprisma.com/manuals
Check this site for the latest updates and additions.

Chapter 1: Overview
AlarmNotifier is a SpectroSERVER-client application that installs with the core SPECTRUM

Enterprise Manager application set. It connects to a single SpectroSERVER and invokes scripts that
provide notifications about the status of alarms generated by SPECTRUM. AlarmNotifier is started
from a terminal shell command prompt. Once started, it continuously displays output generated
from scripts that are invoked whenever alarms are either set, cleared, or updated.
AlarmNotifier capabilities include:
• Single SpectroSERVER alarm-monitoring.
• Three scripts, SetScript, ClearScript, and UpdateScript, that generate alarm information and
can be customized.
• Resource file parameters that can be configured to modify AlarmNotifier operational features.
The alarm-monitoring process

AlarmNotifier works with SPECTRUM in the alarm monitoring and notification process. Figure 1-1
illustrates this process.
Figure 1-1: AlarmNotifier’s Alarm Monitoring Process
SpectroSERVER
Database
Single
SpectroSERVER
Alarms
AlarmNotifier
SetScript ClearScript UpDateScript
Alarm
Notifications
e-mail
Other
Applications
7
Chapter 1: Overview
SPECTRUM functionality
• SPECTRUM polls the network elements modeled in SPECTRUM, updating the information stored
about the status of each element in the SpectroSERVER database.
• SPECTRUM generates an alarm based on a trap received from the network or when it detects a
critical status change in a network-element model. In SpectroGRAPH, the model icon’s
condition panel changes from green to another color that indicates the relative severity level of
the alarm. SPECTRUM posts information about the alarm in the Enterprise Alarm Manager
window and the event information for the alarm in the Event Log window.
AlarmNotifier functionality
• When AlarmNotifier is started, it registers with SPECTRUM and a model of type ClientApp called
AlarmNotifier is created. This model is not visible in any of SPECTRUM’s hierarchical views,
however it can be viewed in the Event Log. Useful information such as application start and
stop time will be logged for this model in the Event Log.
• Once AlarmNotifier is started, it requests information about existing alarms. AlarmNotifier

scripts then generate notifications about these existing alarms.
• AlarmNotifier receives information from the SpectroSERVER every time an alarm is either set,
cleared, or updated. When it receives this information, AlarmNotifier invokes the relevant
script.
• AlarmNotifier scripts may also initiate e-mail notification of alarms to network personnel or
transmit alarm information to third-party applications.
SPECTRUM Alarm Notification Manager (SANM)

SANM can be purchased as an add on component to SPECTRUM to give additional capabilities to
the AlarmNotifier.
SANM’s Policy Administrator enables you to create multiple alarm-filtering policies, each of which
you can associate with uniquely named instances of AlarmNotifier applications. Use of these
policies enables you to stipulate that AlarmNotifier only generate notifications for alarms that you
consider relevant.
SANM’s Policy Administrator enables you to associate policies with AlarmNotifier applications
whenever you want. You can also automate the association process by using the Scheduler utility
to perform these associations.
SANM-enabled AlarmNotifier capabilities include:
• Distributed SpectroSERVER alarm monitoring.
• Additional script parameters that provide more alarm information.
• Commands for acknowledging and clearing alarms.
• Additional start-up options that enable you to log AlarmNotifier activities and concurrently run
multiple instances of AlarmNotifier.
• SANM alarm-filtering tools.

SPECTRUM Alarm Notification Manager (SANM)
Note: All installations of SPECTRUM have a SANM directory present at <$SPECROOT>/

SANM. If SANM functionality has not been purchased, the directory will have two files,
Notifier.tar and spars.tar. If SANM has been purchased these files are replaced by a
SANM executable and supporting files.
For further information on SANM, see the SPECTRUM Alarm Notification Manager (SANM) User
Guide (1308).
Alarm Notifier User Guide 9

Chapter 1: Overview

Chapter 2: Operating AlarmNotifier
This chapter gives instruction on how to start and stop AlarmNotifier and describes the output that
AlarmNotifier generates.
In this chapter
• “Starting AlarmNotifier” on page 11
• “Stopping AlarmNotifier” on page 12
• “AlarmNotifier output” on page 13
• “Persistent and stale alarms” on page 16
Starting AlarmNotifier
AlarmNotifier is located in the <$SPECROOT>/Notifier directory. By default, this directory contains
the following files:
.alarmrc
AlarmNotifier
ClearScript
README
SetScript
UpdateScript
Note: Additional files will be present in this directory if SANM is installed. See the SPECTRUM
Alarm Notification Manager (SANM) User Guide (1308) for further information.
To start AlarmNotifier, you will use the AlarmNotifier command found in this directory.
1. Make sure the landscape to which you intend to connect is specified by the LANDSCAPE
parameter in the <$SPECROOT>/Notifier/.alarmrc resource file. This landscape must be up
and running before starting AlarmNotifier.
2. If you are working in the Windows environment you must configure the mail service before you
start AlarmNotifier for the first time. For instructions, see “Configuring mail service on Windows
platform” on page 20.
11
3. You can launch AlarmNotifier with either the default resource file .alarmrc or a modified
version of the resource file (see “Customizing the .alarmrc resource file” on page 26).
To start AlarmNotifier using the default resource file, enter:
<$SPECROOT>/Notifier/AlarmNotifier
To start AlarmNotifier with a different resource file, enter:
<$SPECROOT>/Notifier/AlarmNotifier -r <resource file>
If you are using Windows NT/2000, you will need to add ./ at the beginning of the
AlarmNotifier command:
<$SPECROOT>/Notifier/./AlarmNotifier
There are additional options available for the AlarmNotifier command when you are using SANM.
For more information, see the SPECTRUM Alarm Notification Manager (SANM) User Guide (1308).
Stopping AlarmNotifier
Once started, AlarmNotifier runs continuously. To stop AlarmNotifier, use one of the following
commands:
In the Solaris or the Windows Environment:
If AlarmNotifier is running in the foreground, enter:
Control-C
In the Solaris Environment:
If AlarmNotifier is running in the background, enter:
kill <option> <AlarmNotifier PID>
In the Windows Environment:
On Windows NT/2000, use the Task Manager to end the AlarmNotifier process.
Starting AlarmNotifier with the process daemon

You can choose to automate the startup of AlarmNotifier by allowing the process daemon
(processd), SPECTRUM’s process launching and tracking daemon, to launch AlarmNotifier as a part
of the SPECTRUM startup process.
In the Solaris environment, processd is automatically started during the SPECTRUM installation
and whenever the system is started. In the Win32 environment, processd is started when a
member of a SPECTRUM user group logs in to the SpectroSERVER. Once processd has started, it
automatically starts and manages other processes. A process that is managed by processd is
restarted automatically if it should somehow stop.
For processd to launch and track the AlarmNotifier application, you must create an install ticket
file. To do this:
1. Using a text editor, create a file with the following content. This is the install ticket file.

AlarmNotifier output
# Processd Install Ticket for Alarm Notifier
PARTNAME;ALARMNOTIFIER;
APPNAME;Alarm Notifier;
WORKPATH;$SPECROOT/Notifier;
LOGNAMEPATH;$WORKPATH/ALARMNOTIFY.OUT;
ADMINPRIVS;y;
AUTORESTART;y;
AUTOBOOTSTART;y;
#STATEBASED;N;
NUMPROCS;1;
RETRYTIMEOUT;6000;
TICKETUSER;<USERNAME>;
RETRYMAX;20;
STARTPRIORITY;30;
#ENV;<var>=<value>;
ARGV;$SPECROOT/Notifier/AlarmNotifier<CSEXE>; //
2. Name this file AlarmNotifier.idb and save it in the <$SPECROOT>/lib/SDPM/partslist directory.
The LOGNAMEPATH parameter specifies the name and path of the log file for the AlarmNotifier
application. It is important to note that each time AlarmNotifier starts, a new log file is generated,
and a backup of the previous log file is created. However, only the two most recent AlarmNotifier
log files are stored by the SpectroSERVER. If you would like to keep all log file output for
AlarmNotifier, you must create a script that will save the log file output in a separate file.
The value specified for the TICKETUSER parameter, <USERNAME>, must be the username of a valid
SPECTRUM User Model.
The SpectroSERVER must be running before AlarmNotifier can start. Therefore, it is important that
the STARTPRIORITY parameter be set to 30, indicating that AlarmNotifier is dependent upon the
SpectroSERVER.
For complete information on creating install tickets for processd, see the Distributed
SpectroSERVER Guide (2770).
AlarmNotifier invokes the SetScript, ClearScript, or UpdateScript whenever an alarm that is

detected by AlarmNotifier is either set, cleared, or updated in SPECTRUM. Each script generates a
notification containing information about the status of the alarm (set, cleared, or updated) and
displays it on your terminal. Each notification contains the parameters defined in “Script parameter
definitions” on page 14.

SetScript
AlarmNotifier invokes the SetScript for an alarm in two situations:
• When AlarmNotifier is started and it detects an existing alarm, unless the value of
GET_EXISTING_ALARMS is changed from the default true in the .alarmrc resource file.
• When SPECTRUM generates an alarm while AlarmNotifier is running.
ClearScript
• AlarmNotifier invokes the ClearScript when an alarm is cleared.
UpdateScript
AlarmNotifier invokes the UpdateScript when an alarm is updated. An alarm is defined as updated
in these situations:
• When a troubleshooter has been assigned to an alarm in the SPECTRUM Enterprise Alarm
Manager window or the troubleshooter name has been changed. This troubleshooter name is
represented by the RepairPerson parameter in the scripts.
• When an alarm’s status has changed. Status information for an alarm is entered in the
Enterprise Alarm Manager window, and it is represented by the AlarmStatus parameter in the
scripts.
• When an alarm is acknowledged or unacknowledged in SPECTRUM.
• When there is a new event or a change to an existing event on a device in an alarmed state.
Script parameter definitions

The following table describes SetScript, ClearScript, and UpdateScript parameters.
Note: Additional script parameters are available when using SANM with AlarmNotifier. See the
SPECTRUM Alarm Notification Manager (SANM) User Guide (1308) for information on these
parameters.
Table 2-1: Script Parameters
Parameter Description
Date The date AlarmNotifier detects the alarm is set, updated, or cleared. The
format used is mm/dd/yyyy.
Time The time AlarmNotifier detects the alarm is set, updated, or cleared. The
format used is hh:mm:ss.
Mtype The type of model for which the alarm is set, updated, or cleared.

ModelName The name of the model for which the alarm is set, updated, or cleared.
If the ModelName contains special characters, you must pass it to the
script as an environmental variable to avoid errors. A special character is
a character that the command shell interprets as having special meaning,
i.e. '$' and '*'.
To pass the model name as an environmental variable, add the attribute
ID for ModelName (0x1006e) to the values associated with the
EXTRA_ATTRS_AS_ENVVARS parameter in the .alarmrc file. See
“Passing SPECTRUM attributes to scripts” on page 21 and “.alarmrc
parameters” on page 27 for more information.
AlarmID The numeric identifier assigned to the alarm by SPECTRUM.
Global AlarmID A unique numeric identifier assigned to the alarm by SPECTRUM. This
differs from the AlarmID in that it is not just unique within the SPECTRUM
environment, but can be passed as a unique identifier to other
environments. This is useful when you need to pass a unique identifier to
a third-party software. An example of a Global AlarmID is 406978f6-
0336-1000-012c-000d5632d07e.
By default, Global AlarmID is commented out in each of the scripts. In
order for this parameter to be passed, the comment mark (#) must be
removed.
Severity The SPECTRUM severity-level code for the alarm: Critical (Red), Major
(Orange), Minor (Yellow), Maintenance (Brown), Suppressed (Gray), or
Initial (Blue).
ProbableCauseID The hexadecimal identifier associated with the probable cause for the
alarm.
RepairPerson The name of the repair person (troubleshooter) assigned to the alarm in
the SPECTRUM Enterprise Alarm Manager window. AlarmNotifier invokes
the UpdateScript whenever a repair person is assigned initially or
thereafter.
Whether or not a repair person name appears in the notifications
generated by SetScript and ClearScript depends on the following
circumstances:
If a repair person is assigned after AlarmNotifier detects that an alarm is
set, SetScript does not display a name, but the UpdateScript and the
ClearScript do.
If a repair person is assigned before AlarmNotifier is notified of the set
(for an alarm that exists before AlarmNotifier is started), all three scripts
display the repair person’s name.
See the Enterprise Alarm Manager User Guide (2065) for more
information about specifying a repair person for an alarm.

AlarmStatus The status information entered for the alarm in the Enterprise Alarm
Manager window. AlarmNotifier invokes UpdateScript whenever status
information is entered initially or thereafter.
Whether or not status information appears in the notifications generated
by the SetScript and ClearScript depends on the following
circumstances:
If status information is entered after AlarmNotifier detects that an alarm
has been set, SetScript does not display the information, but the
UpdateScript and the ClearScript do.
If status information is entered before AlarmNotifier is notified of the set
(for an alarm that exists before AlarmNotifier is started), all three scripts
display the status information.
See the Enterprise Alarm Manager User Guide (2065) for more
information about entering status information for an alarm in the
SPECTRUM Enterprise Alarm Manager window.
SpectroSERVER The name of the host machine for the SpectroSERVER where the alarm
is set, updated, or cleared.
Landscape The handle for the landscape from which the alarm is set, updated, or
cleared.
ModelHandle The handle of the model for which the alarm is generated.
ModelTypeHandle The handle of the model type for which the alarm is set, updated, or
cleared.
IPAddress The IP address of the network element for which the alarm is set,
updated, or cleared.
SecurityString The security string of the model for which the alarm is set, updated, or
cleared.
AlarmState “Existing” or “New.” An alarm’s state is considered existing if the alarm

is set before AlarmNotifier is started. AlarmNotifier invokes SetScript for
an existing alarm if the GET_EXISTING_ALARMS parameter in the
.alarmrc resource file is set to true. An alarm’s state is considered new
if the alarm is generated after AlarmNotifier is started or when the
SpectroSERVER to which AlarmNotifier is connected re-establishes
connections to a previously connected landscape where the alarm
occurred.
Acknowledged “True” or “False.” Indicates whether or not the alarm has been
acknowledged.
UserClearable “True” or “False.” Indicates whether or not the alarm can be cleared by a
user.
DeviceType The value of the DeviceType attribute on the model for which the alarm
is set, updated, or cleared. For more information on this attribute, see the
Modeling with GnSNMPDev Toolkit (1316) guide.
Persistent and stale alarms

When the SpectroSERVER is shut down and brought back up, alarms that existed prior to
shutdown continue to exist. These alarms are considered persistent alarms. The persistent alarm
feature allows SPECTRUM to retain alarm-related information (such as troubleshooter
assignments, status, etc.) when the SpectroSERVER shuts down.

Persistent and stale alarms
In some cases, the underlying cause of an alarm is resolved between the time that the
SpectroSERVER shuts down and is restarted, but the alarm is still displayed in the Alarm List in
Alarm Manager. These alarms are considered to be stale and can be manually cleared by the user.
Stale alarms (also referred to as residual alarms within SPECTRUM) are always user-clearable.
However, stale alarm information is not forwarded to AlarmNotifier by the SpectroSERVER.

Instead, a single new alarm indicating that stale or residual alarms exist on the landscape is
generated and sent to AlarmNotifier. When a stale alarm is manually cleared, you will also see it
cleared in AlarmNotifier. When the final stale alarm is cleared, a “clear” will be issued for the stale
alarm notification.


Chapter 3: Customizing AlarmNotifier
This chapter describes how to customize the AlarmNotifier application by modifying AlarmNotifier
scripts and the AlarmNotifier resource file.
In this chapter
• “Modifying scripts” on page 19
• “Customizing the .alarmrc resource file” on page 26
• “Re-installing or upgrading SPECTRUM” on page 29
Modifying scripts
You can customize AlarmNotifier actions and output by modifying one or more AlarmNotifier
scripts. This section describes how to configure the scripts to initiate e-mail notifications to
specified recipients, how to limit the range of information provided by alarm-transition notifications
generated by scripts, and how to modify a script for integration with a third-party application.
Note: To preserve default script configuration settings in case of accidental loss, make a
backup copy of the default script you plan to edit.
Enabling e-mail in a script

Each AlarmNotifier script includes two parameters, SENDMAIL and VARFORMAIL, that you must
configure to initiate e-mail notification to the troubleshooter specified for an alarm in the
SPECTRUM Enterprise Alarm Manager window. You can enable e-mail notification for one or more
scripts.
To enable e-mail notification in an AlarmNotifier script:
1. Navigate to the <$SPECROOT>/Notifier directory, or the directory where the script you want to
edit resides, and open the script with a text editor.
Note: Since all of the scripts are executed serially, it is possible to edit a script without
stopping the AlarmNotifier.
2. Set the SENDMAIL parameter in the script to True.
19
3. Set the VARFORMAIL parameter to RepairPerson. This sends the email to the troubleshooter
assigned to the alarm in the SPECTRUM Enterprise Alarm Manager. This person must be an
authorized user of (or user model in) the landscape from which the alarm originates.
Note: Because the value for RepairPerson is not established until after the alarm has
occurred, it is not possible to send mail as a result of a set action, i.e. with the
SetScript. If you are also using SANM, it is possible to configure a mail to be sent as a
result of a set action. See the SPECTRUM Alarm Notification Manager (SANM) User
Guide (1308) for further information.
4. Save and close the script.
Configuring mail service on Windows platform

In order to have AlarmNotifier send email notifications when SPECTRUM is installed on a Windows
machine, the mail service must be configured using the mail command. This is required before
AlarmNotifier can start. If this is not done, an error message will prompt the user to configure the
mail service and then start AlarmNotifier.
There are several parameters that will need to be entered when running the mail command from a
terminal window. These parameters are listed in the table below:
Table 3-1: Mail Command Parameters
Parameter Meaning
-m Return HOST Name

The Return host is the machine where incoming mail for this
computer is received.
-h SMTP HOST
The Simple Mail Transfer Protocol host is the machine where
outgoing electronic mail from this computer is sent to be
processed.
-u Return Username
Note: If you want AlarmNotifier to send notifications to a pager, you may want to configure
AlarmNotifer to send notifications to a valid local mail account first. Once you are sure that this
basic configuration works correctly, reconfigure the Mail Service to send the notifications to the
pager.
To configure the Mail Service, perform the following:
1. Consult with your mail server administrator in order to verify the value of the parameters in
Table 3-1.
2. Open the bash shell.
3. Type the following command, then press Enter:
mail -m your-company.com -h smtp.your-company.com -u username
4. The command usage list will appear once the command has completed successfully.

Modifying scripts
5. To verify that the configuration has been done, view the registry entries for HKEY_LOCAL_USER/
Software/SMail. The hostname, smtphost, and username keys should contain the information
you entered in the command string.
Limiting script output

You can comment out AlarmNotifier script parameters that are preceded by the echo command to
reduce the amount of output displayed by a script.
Before you modify a script, review the descriptions of script parameters in Table 2-1 to understand
what information you are suppressing.
To limit the information that AlarmNotifier displays, follow these steps:
1. Close the instance of the AlarmNotifier application you want to configure.
2. Navigate to the default script directory, <$SPECROOT>/Notifier, or the directory where the
script you want to edit resides, and open the script with a text editor.
3. Comment out the echo command line(s) you want to suppress by entering the pound sign (#)
at the beginning of the line.
4. In the following example, the UserClearable parameter is commented out.

echo "SecurityString: " $SECSTR
echo "AlarmState: " $ALARMSTATE
echo "Acknowledged: " $ACKD
#echo "UserClearable: " $CLEARABLE
When this script generates notifications, the information from the parameter that has been
commented out does not appear on the screen.
5. Save and close the script.
Warning! Do not comment out or modify the assignments of the variables themselves
(variables appear in capital letters) or the shift commands. The script will not display
the alarm information properly if you change these lines.
Passing SPECTRUM attributes to scripts

Any of the attributes of the model involved in the alarm can be passed to AlarmNotifier and used in
the SetScript, ClearScript or UpdateScript. To do this, you must use the .alarmrc parameters
EXTRA_ATTRS_AS_ENVVARS or EXTRA_ATTRS_AS_ARGS. When using either of these parameters the
USE_NEW_INTERFACE .alarmrc parameter must be set to TRUE.
EXTRA_ATTRS_AS_ENVVARS passes attributes to AlarmNotifier as environmental variables and

EXTRA_ATTRS_AS_ARGS passes attributes as additional command line arguments. For most
attributes, either of these mechanisms can be used, but EXTRA_ATTRS_AS_ENVVARS is required when
new lines or other special characters can cause problems with the script's parsing of the extra
data. When USE_NEW_INTERFACE=TRUE, the environment variable mechanism is used to pass
$STATUS, $EVENTMSG, and $PCAUSE to avoid this problem. ($EVENTMSG and $PCAUSE are only available
when SANM is installed.)
In the .alarmrc file, set the appropriate parameter equal to the SPECTRUM attribute ID(s) that you
wish to pass. You can reference the attribute ID either in hexadecimal or decimal notation. See

“.alarmrc parameters” on page 27 for specific instructions on the syntax for setting each of these
parameters.
If you pass an attribute as an environmental variable using EXTRA_ATTRS_AS_ENVVARS, you

reference this variable in a script using the following syntax:
$SANM_<attribute_ID>
Where:
<attribute_ID> is the attribute ID of the attribute you are referencing. If you have used
hexadecimal notation to call this attribute in the .alarmrc file, you must also use hexadecimal
notation in the script. If you have used decimal notation to call this attribute in the .alarmrc
file, you must also use decimal notation in the script.
Note: Windows will automatically set environmental variables to uppercase, therefore

when you reference these variables you must be sure to use the uppercase format, i.e.
$SANM_0X100C5.
If you pass an attribute as an argument using EXTRA_ATTRS_AS_ARGS, you reference this variable in
a script by assigning the value to a variable within the script:
<variable>=$<x>
Where:
<variable> is the variable which will hold the value of the attribute.
<x> is the appropriate variable number based on the order and number of arguments that you
have passed.
Example
The following example shows four sample SPECTRUM attributes being passed to AlarmNotifer in
the .alarmrc file and 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

Modifying scripts
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

The following table lists SPECTRUM’s Global Alarm attributes and their corresponding attribute IDs.
Any of these attributes can be passed to AlarmNotifier using the method explained in “Passing
SPECTRUM attributes to scripts” on page 21.
Table 3-2: Global Alarm Attributes
Attribute Name Attribute ID
Acknowledged 0x11f4d
Alarm_Source 0x11fc4
Alarm_Status 0x11f4f
Cause_Code 0x11f50
Cleared_By_User_Name 0x11f51
ImpactScope 0x1290e
ImpactSeverity 0x1290d
Occurences 0x11fc5
Originating_Event 0x1296e
Persistent 0x12942
Primary_Alarm 0x11f54
Severity 0x11f55
Trouble_Shooter_mh 0x11fc6
Trouble_Ticket_ID 0x12022
TroubleShooter 0x11f57
User_Clearable 0x11f9b

Sending data to a third-party application

You can customize or replace the SetScript, ClearScript, or UpdateScript in order to create an
integration with a third-party application.
If you use the functionality built into SetScript, ClearScript, or UpdateScript, but want to add
more functionality to the script, you can do so. It is possible to include SPECTRUM CLI commands
in these scripts in order to retrieve more information from the SpectroSERVER. You can also add
code of your own to the script that will send data to the third-party application of your choice.
If you do not use the functionality built into the existing script, you can direct AlarmNotifier to run
a script or executable that you have created. In the AlarmNotifier resource file (.alarmrc, see
“Customizing the .alarmrc resource file” on page 26), the Set_Script parameter controls the script
that is run when an alarm is set, the Clear_Script parameter controls the script that is run when
an alarm is cleared, and the Update_Script parameter controls the script that is run when an
alarm is updated. (See “AlarmNotifier output” on page 13 for definitions of each of these actions).
By default, the Set_Script parameter has a value of SetScript, the Clear_Script parameter has a
value of ClearScript and the Update_Script parameter has a value of UpdateScript. You can
modify the value of any of these parameters in order to have a different script or executable run
when an alarm is set, cleared, or updated.
Whether you choose to modify an existing script or create a new script, the content of the script or
portion of a script that you create is dependent on the data you want to extract from SPECTRUM
and on the particular third-party application that you want to send the data to.
If you do choose to create your own script or executable, it is important to understand which
arguments are passed from SPECTRUM to the receiving script or executable. In order for your
script or executable to work properly, it must receive all of the arguments passed to it by
SPECTRUM in the correct order.
Table 3-3 on page 25 shows the argument number, name, and format of each argument passed to
each script when the USE_NEW_INTERFACE .alarmrc parameter is set to TRUE. Table 3-4 on page 25
shows the argument number, name, and format of each argument passed to each script when the
USE_NEW_INTERFACE .alarmrc parameter is set to FALSE. When USE_NEW_INTERFACE is set to TRUE,
the Status argument is sent as an environmental variable and argument order is therefore
affected.
Note: If you are working with a SANM enabled AlarmNotifier, there are additional arguments
passed. See the SPECTRUM Alarm Notification Manager (SANM) User Guide (1308) for further
information.

Modifying scripts
Table 3-3: Arguments Passed to Scripts when USE_NEW_INTERFACE is Set to

TRUE
Argument Name Format
1 Date mm/dd/yyyy
2 Time hh:mm:ss
3 Model Type Text
4 Model Name Text
5 Alarm ID Integer
6 Global AlarmID String

*Note that by default this
argument is commented out
in each script. In order for it
to be passed, the comment
(#) mark must be removed.
7 Severity Text
8 Cause Text
9 Repair Person Text
10 Server Text
11 Landscape Hexadecimal
12 Model Handle Hexadecimal
13 Model Type Handle Hexadecimal
14 IP Address xxx.xxx.xxx.xxx
15 Security String Text
16 Alarm State Text
17 Acknowledged Text
18 Clearable Text
19 Device Type Text
Table 3-4: Arguments Passed to Scripts when USE_NEW_INTERFACE is Set to

FALSE
1 Date mm/dd/yyyy
2 Time hh:mm:ss
3 Model Type Text
4 Model Name Text
5 Alarm ID Integer
6 Severity Text

7 Cause Text
8 Repair Person Text
9 Status Text
10 Server Text
11 Landscape Hexadecimal
12 Model Handle Hexadecimal
13 Model Type Handle Hexadecimal
14 IP Address xxx.xxx.xxx.xxx
15 Security String Text
16 Alarm State Text
17 Acknowledged Text
18 Clearable Text
19 Device Type Text
Date and Time
The following conditions apply to the Date and Time arguments for the Set, Clear, and Update
Scripts:
• For SETs: Date and Time are derived from the CREATION_DATE
(0x11f4e) attribute, which is set by the SpectroSERVER upon alarm creation.
• For CLEARs: Date and Time are derived from the CLEAR_DATE
(0x129af) attribute, which is set by the SpectroSERVER upon alarm clearing.
• For UPDATEs: Date and Time reflect when the AlarmNotifier received notification that the
alarm has been updated. This value is not set by the SpectroSERVER, and should not be
relied upon for determining the exact time the update occurred.
Customizing the .alarmrc resource file

The .alarmrc file, located in the Notifier directory, includes AlarmNotifier operational
parameters.
It is possible to modify the resource file in the following ways:
• Specify that AlarmNotifier should not process alarms that were generated by SPECTRUM before
AlarmNotifier was started.
• Specify additional SPECTRUM attributes to be passed to AlarmNotifier.
• Replace SetScript, ClearScript, or UpdateScript with other scripts.
• Specify a SpectroSERVER you want AlarmNotifier to connect to.

Customizing the .alarmrc resource file
• Disable parameters that specify AlarmNotifier actions you are not interested in. This can help
reduce network traffic.
Note: Never comment out parameters. This will not disable them, rather it will cause
their default value to be used.
To modify the .alarmrc file:
1. Navigate to the <$SPECROOT>/Notifier directory, make a backup copy of the .alarmrc file,
and then open the file with a text editor.
2. Edit the file by turning off optional parameters or by entering new parameter values. You can
disable a parameter by giving it a value of False or by leaving the value blank. Do not turn off
required parameters and/or delete parameters.
3. Save and close the file, and then restart AlarmNotifier.
Your changes go into effect when AlarmNotifier is restarted.
.alarmrc parameters
Table 3-5 lists resource file parameters provided with AlarmNotifier.
Note: Additional .alarmrc parameters are available when using SANM with AlarmNotifier. See
the SPECTRUM Alarm Notification Manager (SANM) User Guide (1308) for information on these
parameters.
Table 3-5: Resource File Parameters
Parameter Description
LANDSCAPE The initial SpectroSERVER host to which AlarmNotifier connects.

Enter only one name here. If LANDSCAPE is not defined, as in a
SpectroGRAPH-only installation, AlarmNotifier will default to
using the first landscape in the VNM Landscape Map. An
informational window will display, showing the default landscape
handle.
VNM_MAIL_TIMEOUT The minimum time (in milliseconds) that the MailService waits for
a response from the SpectroSERVER before the request is
canceled. The default value is 60,000 milliseconds (one minute).
VNM_CONNECT_TIME_ The minimum delay (in milliseconds) before an initial TCP

LIMIT connect request between AlarmNotifier and a SpectroSERVER will
time out. The default value is 60,000 milliseconds (one minute).
KEEP_ALIVE_TIMEOUT The amount of time (in milliseconds) before a “keep-alive”

request will time out. The default value is 30,000 milliseconds
(30 seconds).

KEEP_ALIVE_INTERVAL The amount of time (in milliseconds) between “keep-alive”

requests sent to the SpectroSERVER. A “keep-alive” request
checks to see if the SpectroSERVER is still connected to the
AlarmNotifier. If AlarmNotifier does not receive a response to the
“keep-alive” request, it will disconnect from the SpectroSERVER.
If your SpectroSERVER is slow to respond to these requests, you
can increase this value to prevent the AlarmNotifier from
disconnecting from the SpectroSERVER. The default value is
60,000 milliseconds (1 minute).
SEND_ALARM_DELAY The minimum delay (in milliseconds) between successive alarm-

notifications. The default value is 1,000 milliseconds (1 second).
GET_GRAY_INITIAL_ False (the default value) or True. This parameter allows you to
ALARMS specify whether or not you want to receive Gray and Initial
alarms. If you are not interested in Gray or Initial alarms, set this
parameter to “false.” This will reduce the network traffic
generated by AlarmNotifier and improve its performance.
GET_EXISTING_ALARMS True (the default value) or False. This parameter allows you to
specify whether you want to receive reports about the alarms
that already exist when AlarmNotifier is invoked or only those
that occur after it is invoked. The “Waiting for more alarms from
the SpectroSERVERs” message appears during any interval
between alarm-notifications.
UPDATE_EXISTING_ALARMS True or False (the default value). This option specifies whether or
not updates and clears to existing alarms should be processed.
This is different than GET_EXISTING_ALARMS in that it does not
invoke the “SetScript” on page 14 for existing alarms. This
parameter only has an impact if the GET_EXISTING_ALARMS
parameter is set to false. If GET_EXISTING_ALARMS is set to
true, then updates/clears to existing alarms will be processed
regardless of what UPDATE_EXISTING_ALARMS is set to.
UPDATE_ATTRS A comma delimited list of global alarm attribute IDs (see “Global
Alarm attributes” on page 23). If the value of one of the
attributes listed changes, the “UpdateScript” on page 14 is
triggered. Note that model attribute IDs cannot be used with this
parameter.
SET_SCRIPT The script or program that is executed when SPECTRUM sets an

alarm or AlarmNotifier detects an existing alarm. This is a
required parameter. AlarmNotifier will not run properly if a script
is not run as a result of the set action. The CLEAR_SCRIPT and
UPDATE_SCRIPT parameters are not mandatory.
CLEAR_SCRIPT The script or program that is executed when SPECTRUM clears an

alarm.
UPDATE_SCRIPT The script or program that is executed when SPECTRUM updates

an alarm.
USE_DEVICE_NETWORK_AD True (the default value) or False. This parameter allows you to
DRESS specify whether you want to use the device IP address or the port
IP address. When set to False, the port IP address is displayed
beside the "IP Address" field in the AlarmNotifier output.

Re-installing or upgrading SPECTRUM
EXTRA_ATTRS_AS_ENVVARS A comma delimited list of SPECTRUM attribute IDs whose value

you would like to pass to AlarmNotifer. These attributes can then
be used in a script.
These attribute values are passed as environmental variables.
For efficiency, this parameter should be used with string
attributes that include multiple lines of text.
Sample syntax using hexadecimal attribute IDs:
EXTRA_ATTRS_AS_ENVVARS=0x1234, 0x1235, 0x1238
Sample syntax using decimal attribute IDs:
EXTRA_ATTRS_AS_ENVVARS=4660, 4661, 4664
For further information see “Passing SPECTRUM attributes to
scripts” on page 21.
EXTRA_ATTRS_AS_ARGS A comma delimited list of SPECTRUM attribute IDs whose value

you would like to pass to AlarmNotifer. These attributes can then
be used in a script.
These attribute values are passed as arguments.
This parameter should be used with attributes that do NOT
include multiple lines of text.
Sample Syntax using hexadecimal attribute IDs:
EXTRA_ATTRS_AS_ARGS=0x1222, 0x1459, 0x1678
Sample syntax using decimal attribute IDs:
EXTRA_ATTRS_AS_ARGS=4642, 5209, 5752
For further information see “Passing SPECTRUM attributes to
scripts” on page 21.
USE_NEW_INTERFACE This parameter specifies whether you want to use the new script
interface. The new interface is more efficient, and passes the
STATUS, EVENTMSG, and PCAUSE arguments as environment
variables. The default value is FALSE to avoid breaking existing
scripts, but TRUE is the recommended setting once the scripts
have been updated.
NOTE: The EVENTMSG and PCAUSE arguments are only available
when using SANM with AlarmNotifier.
Re-installing or upgrading SPECTRUM

When you re-install SPECTRUM or upgrade to another version of SPECTRUM, the install process
automatically saves the SetScript, UpdateScript, and ClearScript to a backup directory.
Versions of the default scripts you have saved under another name, SetScript_version1 or
UpdateScript_modified for example, are retained in the <$SPECROOT>/Notifier directory along
with the default scripts provided by the re-installation or upgrade. The install process also
automatically saves your .alarmrc file to a backup directory. Versions of the .alarmrc resource
file you have saved under another name, .alarmrc1 or .alarmrc2 for example, are retained in the
<$SPECROOT>/Notifier directory.
The backup scripts and the backup .alarmrc are saved to the following directory:
<$SPECROOT>/Install-Tools/SAVES_<date>/<time>/Notifier


Index
A E
Acknowledged, script parameter 16 E-mail
AlarmID, script parameter 15 enabling in scripts 19
AlarmNotifier specifying who gets mail 19
optimizing performance 27 UNIX or NT systems 19
stopping 12 EXTRA_ATTRS_AS_ARGS 21, 29
AlarmNotifier scripts EXTRA_ATTRS_AS_ENVVARS 21, 29
limiting output of 21
SetScript 14
UpdateScript 14 G
Alarms
existing (generated before AN is invoked) 16 GET_EXISTING_ALARMS, .alarmrc
generated by SPECTRUM 8 parameter 28
minimum delay between 28 GET_GRAY_INITIAL_ALARMS, .alarmrc
monitoring/notification process 7 to 8 parameter 28
AlarmState, script parameter 16 Global Alarm attributes 23
AlarmStatus, script parameter 16
I
C IPAddress, script parameter 16
CLEAR_DATE 26
CLEAR_SCRIPT, .alarmrc parameter 28
ClearScript 14 K
Condition, script parameter 15 KEEP_ALIVE_INTERVAL 28
CREATION_DATE 26 KEEP_ALIVE_TIMEOUT 27
D L
Date for the clearscript 26 LANDSCAPE, .alarmrc parameter 27
Date for the setscript 26 when not defined 27
Date for the update script 26 Landscape, script parameter 16
Date, script parameter 14
Device Type 16, 25, 26
31
Index
M T
ModelHandle, script parameter 16 Time for the clearscript 26
ModelName, script parameter 15 Time for the setscript 26
ModelTypeHandle, script parameter 16 Time for the update script 26
Mtype, script parameter 14 Time, script parameter 14
O U
Output, limiting 21 UPDATE_ATTRS 28
UPDATE_EXISTING_ALARMS 28
UPDATE_SCRIPT, .alarmrc parameter 28
P UpdateScript 14
USE_DEVICE_NETWORK_ADDRESS, .alarmrc
Performance parameter 28
reducing network traffic 27 USE_NEW_INTERFACE 29
Persistent Alarms 16 Userclearable, script parameter 16
Policy Administrator, SANM enhancement
function of 8
ProbableCauseID, script parameter 15
V
VARFORMAIL, script parameter for specifying e-
R mail notification 20
VNM_CONNECT_TIME_LIMIT, .alarmrc
RepairPerson, script parameter 15 parameter 27
residual alarms 17 VNM_MAIL_TIMEOUT, .alarmrc parameter 27
Resource file
.alarmrc 26
resource file 27
S
Scripts
overview 13
SecurityString, script parameter 16
SEND_ALARM_DELAY, .alarmrc parameter 28
SENDMAIL, script parameter for specifying e-
mail notification 19
SET_SCRIPT, .alarmrc parameter 28
SetScript 14
SpectroGRAPH
displaying alarm conditions 8
SpectroSERVER
script parameter 16
SPECTRUM Alarm Notification Manager
(SANM) 8
SPECTRUM, role in alarm-monitoring/notification
process 8
Stale Alarms 16
Starting AlarmNotifier 11
Stopping AlarmNotifier 12

AlarmNotifier User Guide

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

AlarmNotifier User Guide

Hochgeladen von

Copyright:

Verfügbare Formate

AlarmNotifier

Chapter 2: Operating AlarmNotifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 3: Customizing AlarmNotifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4 Alarm Notifier User Guide

What is in this book

This guide contains the following chapters:

• Chapter 1: Overview - This chapter serves as an introduction to SPECTRUM’s

• Chapter 3: Customizing AlarmNotifier - This chapter describes how to customize the

The following text conventions are used in this document:

Element Convention Used Example

Variables Courier and Italic in Type the following:

The directory where you <$SPECROOT> Navigate to:

Element Convention Used Example

Solaris and Windows Unless otherwise noted, <$SPECROOT>/app-defaults

On-screen text Courier The following line displays:

User-typed text Courier Type the following path name:

Cross-references Underlined and hypertext- See “Document Feedback” on

References to SPECTRUM Italic SPECTRUM Installation Guide

Thank you for helping us improve our documentation.

SPECTRUM documents are available online at:

Check this site for the latest updates and additions.

6 Alarm Notifier User Guide

AlarmNotifier is a SpectroSERVER-client application that installs with the core SPECTRUM

AlarmNotifier capabilities include:

• Single SpectroSERVER alarm-monitoring.

The alarm-monitoring process

• Once AlarmNotifier is started, it requests information about existing alarms. AlarmNotifier

SPECTRUM Alarm Notification Manager (SANM)

SANM-enabled AlarmNotifier capabilities include:

• Distributed SpectroSERVER alarm monitoring.

• Additional script parameters that provide more alarm information.

• Commands for acknowledging and clearing alarms.

• SANM alarm-filtering tools.

8 Alarm Notifier User Guide

Note: All installations of SPECTRUM have a SANM directory present at <$SPECROOT>/

Alarm Notifier User Guide 9

10 Alarm Notifier User Guide

• “Starting AlarmNotifier” on page 11

• “Stopping AlarmNotifier” on page 12

• “AlarmNotifier output” on page 13

• “Persistent and stale alarms” on page 16

To start AlarmNotifier using the default resource file, enter:

To start AlarmNotifier with a different resource file, enter:

<$SPECROOT>/Notifier/AlarmNotifier -r <resource file>

In the Solaris or the Windows Environment:

If AlarmNotifier is running in the foreground, enter:

In the Solaris Environment:

If AlarmNotifier is running in the background, enter:

kill <option> <AlarmNotifier PID>

In the Windows Environment:

Starting AlarmNotifier with the process daemon

12 Alarm Notifier User Guide

# Processd Install Ticket for Alarm Notifier

2. Name this file AlarmNotifier.idb and save it in the <$SPECROOT>/lib/SDPM/partslist directory.

AlarmNotifier invokes the SetScript, ClearScript, or UpdateScript whenever an alarm that is

Alarm Notifier User Guide 13

• When SPECTRUM generates an alarm while AlarmNotifier is running.

• When an alarm is acknowledged or unacknowledged in SPECTRUM.

Script parameter definitions

Table 2-1: Script Parameters

14 Alarm Notifier User Guide

AlarmID The numeric identifier assigned to the alarm by SPECTRUM.

Alarm Notifier User Guide 15