+ All Categories
Home > Documents > Enterprise Alarm Manager User Guide...

Enterprise Alarm Manager User Guide...

Date post: 24-Apr-2018
Category:
Upload: ngohanh
View: 215 times
Download: 1 times
Share this document with a friend
66
Enterprise Alarm Manager User Guide Document 2065
Transcript

Enterprise Alarm Manager

User GuideDocument 2065

NoticeCopyright 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 [email protected]; 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.2100U.S. toll-free: 877.468.1448Web site: http://www.aprisma.com

3

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 1: Alarm Manager andEnterprise Alarm Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Accessing AM and EAM within SpectroGRAPH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Accessing alarms for specific models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 2: Managing Alarms With EAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

EAM Main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

EAM menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Keyboard accelerators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

EAM Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Shrinking the main window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Alarm information panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Alarm List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Stale alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Local Filter/Search area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Filter log area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Alarm count panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Connection Status information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Application Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Impact Scope view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Device Criticality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Filtering alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Primary and secondary alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Filter dialog box buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Using the Advanced Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Local Filter/Search area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Sorting alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

How sorting arranges the Alarm List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Changing column order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Changing column size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Clearing alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Acknowledging alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Setting alarm status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Creating device/model notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Mailing alarm information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4 Enterprise Alarm Manager User Guide

Contents

Assigning alarms to troubleshooters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Troubleshooter notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Unassigning alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Creating troubleshooters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Deleting troubleshooters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Setting preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Alarm sounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Customizing the sound files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Iconified EAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 3: Custom Scripts and Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Access tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Truncated and untruncated tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

5

Preface

This guide is intended for network operations personnel who will use SPECTRUM Enterprise Alarm Manager to manage alarms.

What is in this book

This guide contains the following chapters:

• Chapter 1: Alarm Manager and Enterprise Alarm Manager - This chapter details how to use Alarm Manager and Enterprise Alarm Manager in conjunction with SpectroGRAPH.

• Chapter 2: Managing Alarms with EAM - This chapter describes EAM’s Main window and details how to use the application’s features for managing alarms.

• Chapter 3: Custom Scripts and Applications - This chapter provides information on how to run scripts to customize certain aspects of EAM.

Text conventions

The following text conventions are used in this document:

Element Convention Used Example

Variables

(The user supplies a value for the variable.)

Courier and Italic in angle brackets (<>)

Type the following:

DISPLAY=<workstation name>:0.0 export display

The directory where you installed SPECTRUM

(The user supplies a value for the variable.)

<$SPECROOT> Navigate to:

<$SPECROOT>/app-defaults

Solaris and Windows directory paths

Unless otherwise noted, directory paths are common to both operating systems, with the exception that slashes (/) should be used in Solaris paths, and backslashes (\) should be used in Windows paths.

<$SPECROOT>/app-defaults on Solaris is equivalent to <$SPECROOT>\app-defaults on Windows.

6

Document feedback

Please send feedback regarding SPECTRUM documents to the following e-mail address:

[email protected]

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.

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-blue

See “Document feedback” on page 6.

References to SPECTRUM documents (title and document number)

Italic SPECTRUM Installation Guide (0675)

Functionality enabled by SPECTRUM Alarm Notification Manager (SANM)

SANM in brackets []. [SANM] AGE_FIELD_ID

Element Convention Used Example

7

Chapter 1: Alarm Manager andEnterprise Alarm Manager

This chapter details how to use Alarm Manager and Enterprise Alarm Manager in conjunction with SpectroGRAPH.

IntroductionTwo programs for managing alarms are available in SPECTRUM:

• Alarm Manager (AM) provides a list of current network alarms and allows you to manage alarms in a non-distributed environment (composed of a single landscape managed by a single SpectroSERVER.)

• Enterprise Alarm Manager (EAM) provides a list of current network alarms and allows you to manage alarms in a distributed environment (composed of multiple unique landscapes each with its own SpectroSERVER, and having the capability to access information from more than one SpectroSERVER at a time.)

In a distributed environment, the Enterprise Alarm Manager works the same as the Alarm Manager, but shows alarms for all landscapes. This guide focuses on the EAM since AM operates similarly to EAM. Be aware, however, that because AM does not include the distributed functionality that EAM does, all references to landscapes and distributed environments do not apply to discussions of AM.

Both AM and EAM can run with a locally installed SpectroSERVER or a remote SpectroSERVER. AM can be used with or without SpectroGRAPH; however, if SpectroGRAPH is not used, related SpectroGRAPH views (Performance, Information, etc.) are not available.

OverviewAM and EAM provide the user with a dynamic view of SpectroSERVER alarms. If your network is modeled using a distributed SpectroSERVER, you may have several landscape icons in SpectroGRAPH, each representing its own SpectroSERVER. You can opt to view all or some of these landscapes in EAM.

AM and EAM allow you to:

8 Enterprise Alarm Manager User Guide

Chapter 1: Alarm Manager and Enterprise Alarm Manager

• Mail alarm information present in the information panel to specified recipient(s).

• View and select multiple alarms, which allows for a quicker resolution of alarms.

• Take an action on an alarm or a set of alarms. Possible actions are:

• Assign and Unassign a troubleshooter

• Clear alarms

• Acknowledge and Unacknowledge alarms

• Set Status of alarms

• Set Trouble Ticket ID on alarms

• View alarms in a hierarchical manner (for example, all alarms that occur under a LAN).

• Establish the criteria by which the list of alarms is filtered and displayed. You can filter alarms according to: Model Type, Model, Landscape (EAM only), Date/Time, Address, Model Class, Severity, Cause, Assignment, and State.

• Establish the criteria by which alarms are ordered. You can sort alarms by any of the column headings (Severity, Date/Time, Model Type, etc.) and by two different methods (from the Sort dialog box or by clicking directly on the Alarm List column headings).

• Operate in a distributed environment with simultaneous viewing of alarms across multiple landscapes (EAM only).

Accessing AM and EAM within SpectroGRAPHThe different methods that you can use to launch AM or EAM are described below. Depending on the method that you use, all of the alarms in your environment will be shown or alarms for specific models will be shown.

Method 1: From the SpectroGRAPH menu, select Tools > Alarm Manager.

This method will launch AM/EAM showing all alarms in your environment. If you are using EAM, all alarms will be shown for all the landscapes that you have configured EAM to connect to.

Note: The first time EAM is run, it only connects to the default landscape. To connect to more landscapes choose View > Filter from the EAM Main window to open the Filter dialog box, then click on the Landscape tab and move the desired landscapes from the Hide list to the Show list. See “Setting preferences” on page 48.

Method 2: From the SpectroGRAPH toolbar, select the Model Alarms button .

Method 3: From the SpectroGRAPH menu, select View > Icon Subviews > Model Alarms.

Method 4: Right click in the Topology view and choose Model Alarms from the resulting menu.

If you use method 2, 3, or 4 with one or more models selected (use the Shift key to select multiple models), only the alarms applicable to those selected models will be shown. Any saved landscape and/or model filter preferences will not be used. Instead, the alarms shown will be filtered by the current landscape and selected models.

Accessing alarms for specific models

Enterprise Alarm Manager User Guide 9

If you use method 2, 3, or 4 with no models selected, the alarms applicable to the Universe model will be displayed. As above, any saved landscape and/or model filter preferences will not be used. Instead, the current landscape and Universe model will be used for the filter.

See “Accessing alarms for specific models” on page 9 for more information.

Accessing alarms for specific models When you bring up AM/EAM against one or more models, only alarms that have been generated against those models will be displayed. If any of the selected models are container models (LAN_802_3, Landscape, IPClassB, etc.), all alarms that have been generated against devices contained within the container model will also be displayed.

Note: When you access AM/EAM against a specific model, you will not see alarms associated with devices that are connected to the selected model (as opposed to contained within the model). If the selected model contains another model that is itself a container, you will see the devices within that container model as well.

When you launch AM/EAM against one or more models, SPECTRUM displays the Application Scope dialog box. This dialog box indicates that the application was brought up on one or more selected models, and therefore only displays information on those selected models.

You can prevent the Application Scope dialog box from being automatically displayed by deselecting the Show this dialog at startup button at the bottom of the dialog box. The dialog box can be redisplayed by selecting View > Application Scope from the AM/EAM Main window or by clicking the Application Scope dialog box icon at the bottom right corner of the AM/EAM Main window. The menu option and dialog box icon only appear when AM/EAM is launched against one or more specific models.

When AM/EAM is launched against one or more specific models, the Shown Models filter label (located beneath the Filtered by: field at the bottom left of the Alarm List) shows which model the alarms are being displayed for. For example:

Shown Models: east-coast (Landscape) indicates EAM was launched against the Landscape model “east-coast.”

Shown Models: 111.222.3.4 (HubCSIEMME), SSR250 (Generic_SSR_FP) indicates EAM was launched against an EMME hub and a SmartSwitch router and is displaying alarms as they pertain only to these two devices.

10 Enterprise Alarm Manager User Guide

Chapter 1: Alarm Manager and Enterprise Alarm Manager

11

Chapter 2: Managing Alarms With EAM

This chapter describes EAM’s Main window and details how to use the application’s features for managing alarms.

EAM Main windowThe EAM Main window contains the following areas:

Menu and Toolbars drop down menus and icons to perform actions

Alarm Information panel displays detailed information on the selected alarm.

Alarm List displays a list of current, non-filtered alarms.

Alarm Count panel displays the totals for the alarms currently displayed in the Alarm List.

Note: By default, EAM only displays the most severe alarms occurring on a device; secondary alarms are suppressed. To display all alarms on a device, select View > Filter and then click the State tab. In the Primary/Secondary State box, select the Primary and Secondary button to turn it off; see “Primary and secondary alarms” on page 34.

Figure 2-1 on page 12 shows an example of an EAM Main window.

12 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Figure 2-1: EAM Main Window

When an alarm occurs, it is added to the EAM Alarm List if it meets the filtering criteria. The related alarm information is recorded in the Event Log. An alarm is removed from the list when the condition causing it is cleared.

Click an alarm in any column of the Alarm List to display detailed information for that alarm in the Alarm Information panel. Figure 2-2 on page 21 shows the Alarm Information panel; Figure 2-3 on page 25 shows the main Alarm List; Figure 2-4 on page 28 shows the Alarm Count panel.

See “Changing column size” on page 41 to adjust column size. The Alarm List can be scrolled to the right and left using the scroll bar at the bottom of the panel.

EAM menus

Options available from EAM menus are described in the following paragraphs.

File

This menu lets you mail selected items, print and exit from EAM; see Table 2-1.

Table 2-1: File Menu

Mail Selected Items... Opens the Mail Selected Items dialog box, which enables you to send the alarm information contained in the Alarm Information Panel to the specified recipient(s).

A

EAM Main window

Enterprise Alarm Manager User Guide 13

View

This menu lets you choose specific viewing preferences and provides access to three dialog boxes; see Table 2-2.

Print Page Setup—Displays the Print Page Setup dialog box where you can set printing options.

Window—Displays the Print Window dialog box where you can set print range, destination, and number of copies for printing the EAM main window.

Print Selected—Displays the Print Selected Data dialog box where you can set print range, destination, and number of copies for printing the selected alarms.

Print All—Displays the Print All Data dialog box where you can set print range, destination, and number of copies for printing all displayed alarms.

Print to Text File—Displays the Print to Text File dialog box. To print to a text file: Select the data you wish to print. Choose to save the selected data in either Tabular or Non Tabular format (choose tabular format to create a file to import into a spreadsheet). Enter the path and filename for the text file and click OK to save.

Close Exits the EAM application.

Table 2-2: View Menu

Show Toolbar Toggles on and off the toolbar at the top of the Information panel

Show Toolbar Labels Toggles on and off the toolbar labels beneath each toolbar icon

Show Tool Tips Toggles on and off the toolbar icon descriptions

Show Status Help Toggles on and off status help in the status bar

Application Scope This is only available if EAM was brought up against a specific model through the Icon Subviews menu. (This dialog box can also be accessed by clicking the Application Scope icon in the bottom right corner of the EAM window.)

Connection Status Displays the Connection Status dialog box, which shows the connection status and type of service of all servers accessible by Alarm Manager. (This dialog box can also be accessed by clicking the Servers icon in the bottom right corner of the EAM window.)

Show Filter/Search Panel Toggles on and off the Filter/Search buttons and their associated text boxes

Show Alarm Information Toggles on and off the Alarm Information panel at the top of the EAM window

Table 2-1: File Menu

14 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Model

This menu is applies to the last selected or currently displayed device. It is the same as the Icon Subviews menu. The Icon Subviews menu may also be accessed by clicking the right mouse button in the EAM window or on the model icon; see Table 2-3.

Show Alarm Counts Toggles on and off the Alarm Counts Panel at the bottom of the EAM window

Hide Selected Alarms Hides (temporarily filters out) the selected alarms in the Alarm List. This can be done for multiple alarms.

Show Hidden Alarms Redisplays all alarms hidden by the Hide Selected Alarms method.

Filter Displays the Filter dialog box where you can choose which alarms to display or hide using filter configuration panels: Model Type, Model, Landscape, Date/Time, Address, Model Class, Severity, Cause, Assignment, and State.

Sort Displays the Sort dialog box where you can choose to sort the Alarm List by one, two, or three columns (the primary, secondary, and tertiary sort order) and, for each of those columns, whether the sort order is ascending or descending.

Column Order Displays the Column Order dialog box where you can rearrange column order and choose which columns to hide or show.

Impact Scope Displays the Impact Scope view where you can determine which devices are affected by a critical alarm. Additionally, the display contains the user defined device criticality. See “Impact Scope view” on page 29 for more information.

Table 2-3: Model Menu

Navigate Lets you Navigate In or Navigate Up to SpectroGRAPH views, (for example, Topology, Device Topology, and Location).

Model Alarms Opens the Alarm View for the selected (highlighted) model only. This is the same as starting EAM through Icon Subviews > Model Alarms. The Application Scope dialog box displays when accessing the Alarm View this way.

Performance Displays the SpectroGRAPH Performance view for the model highlighted in the Alarm List.

Notes Opens the Notes dialog box where you can write notes about the model/device and send the notes through e-mail. Notes are displayed in the Model/Device Notes tab of the Information Panel.

Table 2-2: View Menu (Continued)

EAM Main window

Enterprise Alarm Manager User Guide 15

Alarms

This menu applies to all the currently selected alarms and provides several selections to manage these alarms; see Table 2-4.

Troubleshooter

This menu provides selections for managing troubleshooters and getting detailed information on troubleshooter assignments; see Table 2-5 on page 16.

Various SpectroGRAPH menu selections

These menu choices vary depending on the selected model. Most of these views can only be accessed if SpectroGRAPH is running (Notes and Acknowledge menu picks can be accessed without SpectroGRAPH). Note that this same menu (the Icon Subviews menu) can be accessed by a right-click from anywhere within EAM window and differs from the Model menu only by having a “Close Window” selection which, if selected, closes EAM.

Table 2-4: Alarms Menu

Select All Selects all alarms in the Alarm List for performing actions: Assign troubleshooter, Unassign troubleshooter, Clear alarms, Acknowledge alarms, and Set Status of alarms.

Acknowledge Acknowledges an alarm. When acknowledged, a checkmark appears in the Acknowledged column. This is useful for distinguishing specific alarms as distinct from new alarms that automatically appear in the Alarm List.

Unacknowledge Unacknowledges an acknowledged alarm.

Set Status Displays the Set Status dialog box for the selected alarm. If more than one alarm is selected, the dialog box will not contain any text. Enter status information, including device and alarm history, for the selected alarm. If more than one alarm is selected, you can choose to append the information entered in the dialog box to the Alarm Status for each alarm selected. This text appears in the Information Panel’s Alarm Status tab.

Set Trouble Ticket ID Displays the Set Trouble Ticket ID dialog box for the selected alarm. If more than one alarm is selected, the dialog box will not contain any text. Enter the desired information for the selected alarm. If more than one alarm is selected, you can choose to append the information entered in the dialog box to the Trouble Ticket ID for each alarm selected. This text appears in the Information Panel’s Trouble Ticket ID tab.

Clear Displays the Confirm Clear dialog box. Click OK to clear the selected alarms. A checkmark in the Clearable column designates an alarm that can be cleared. If an alarm cannot be cleared, an error dialog box appears.

Table 2-3: Model Menu (Continued)

16 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Options

This menu lets you customize certain aspects of the EAM; see Table 2-6.

Table 2-5: Troubleshooter Menu

Assign When only one troubleshooter is created, clicking Assign Troubleshooter directly assigns the troubleshooter and no dialog box appears. If more than one troubleshooter is created, clicking Assign Troubleshooter displays the Assign dialog box listing all available troubleshooter names and e-mail addresses for the landscape on which the alarm was generated. When you select a troubleshooter and click OK, the selected troubleshooter is assigned to the selected alarms.

Unassign Displays the Confirm Unassign dialog box. Click OK to unassign the troubleshooter from the selected alarms.

Information Displays the Information dialog box, which identifies each troubleshooter assignment, including Model Name, Model Type, and Alarm ID. The dialog box also shows the e-mail address and total number of assignments per troubleshooter, and allows the name and e-mail address fields to be modified.

Create Displays the Create dialog box. This lets you create a troubleshooter and enter an (optional) e-mail address. Only users with write privileges can create troubleshooters. The troubleshooter is created for the default landscape. In a distributed environment the troubleshooter is created for the landscape selected by the user.

Delete Displays the Delete dialog box listing all available troubleshooter names and e-mail addresses for the landscape currently selected. This lets you delete one or more troubleshooters.

Table 2-6: Options Menu

Preferences Displays the Preferences dialog box where you can set/save preferences for customizing EAM to best suit your needs.

Clear User Preferences This clears all user changes, including filter, sort, column order, and preference changes.

Clear Group Preferences This clears all group preferences, including filter, sort, column order, and preference changes. This option only appears if the user currently logged in is part of a group and has ADMIN privileges for that group. See Security and User Maintenance (2602) for more information.

Sound Toggles the alarm sound on and off. If on, an audible sound indicates the alarm severity each time a new alarm is generated. Sounds can be selected through the Notification tab in the Preferences dialog box.

Auto Raise Toggles the Auto Raise feature on and off. If on, the EAM window is brought to the front each time a new alarm is generated. Also, if the EAM window is minimized, it is automatically maximized and brought to the foreground.

EAM Main window

Enterprise Alarm Manager User Guide 17

Note: The attribute selected for the user-defined column must be different from existing columns in the Alarm List. If a duplicate column is created, an error message appears and the Set User-Defined Columns dialog box reappears when you click OK to acknowledge the error message. Likewise, the column label must be unique; if a duplicate label is entered, an error message appears.

User-defined columns are best suited for static/unchanging values, because the additional attribute information is only read once when the alarm is created. For example, sysUpTime (as a column) would quickly indicate inaccurate information since the up-time is continually changing and the displayed value is not.

Also, user-defined attribute values are simply converted to a string and not reformatted. For example, sysUpTime would be displayed as a large number and not formatted into days/hours/minutes/seconds.

Help

This menu provides selections on various help options available in or from the main EAM window; see Table 2-7.

Set User-Defined Columns...

Displays a dialog box where you can create up to three custom columns. Use the Attribute browser to select the desired model type attribute. List attributes (those attributes containing a list of attributes) and Security attributes may not be displayed in the table. Attributes are displayed on a per-model type basis and many attributes are not common to all model types. See SPECTRUM Views (2517) and Model Type Editor User’s Guide (0659) for more information.

The Attribute Name is automatically entered as the name for the new column. Select the text in the Column Name field and enter another name, if desired.

If the attribute type value is an octet string, the “Display octet value as text string” option can be selected by clicking the button to its down position. Note that you must shutdown and then restart EAM to display the new column(s). Once EAM is restarted, to view the new column(s), the column names must be moved from the hidden list to the shown list; then order the column names as desired.

Table 2-7: Help Menu

What’s This? Displays the What’s This? help text boxes. When selected, the cursor changes to a question mark. When you click an area of the EAM window, a short description of that area displays.

Hints Launches a Web browser and opens the main Hints page with its associated links to other Hints pages.

Help Index Opens the Help index.

Help Topics Opens the Help table of contents.

Table 2-6: Options Menu

18 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Keyboard accelerators

You can also use the keyboard to open certain dialog boxes and perform certain alarm actions; see Table 2-8.

About Enterprise Alarm Manager

Displays a dialog box with information about this version of EAM.

Online Manuals Accesses the SPECTRUM online documentation (SPECTRUM Documentation CD must be installed).

Table 2-8: Keyboard Accelerators

Accelerator Menu selection Function

Ctrl+J File > Mail Selected Items... Opens the Mail Selected Items dialog box, which enables you to send the alarm information contained in the Alarm Information Panel to the specified recipient(s).

Alt+F4 File > Close Closes the EAM window.

Ctrl+F View > Filter... Opens the Filter dialog box, which enables you to filter alarms.

Ctrl+S View > Sort... Opens the Sort dialog box, which enables you to sort alarms.

Ctrl+O View > Column Order... Opens the Column Order dialog box, which enables you to show/hide and order the columns in the Alarm List.

Ctrl+A Alarms > Select All Selects (highlights) all alarms in the Alarm List. This is used to perform an action on all alarms in the Alarm List (for example, clear all alarms, acknowledge all alarms, etc.)

Ctrl+K Alarms > Acknowledge Acknowledges the selected alarm(s) and puts a checkmark in the Acknowledged column.

Ctrl+R Alarms > Unacknowledge Unacknowledges the selected alarm(s) and removes the checkmark from the Acknowledged column.

Table 2-7: Help Menu (Continued)

EAM Main window

Enterprise Alarm Manager User Guide 19

Ctrl+T Alarms > Set Status Opens the Set Status dialog box where you can enter status information (including device and alarm history) for the selected alarm. This text appears in the Information Panel’s Alarm Status tab where you can enter unique text to describe the alarm. If more than one alarm is selected, the dialog box will not contain any information. You can select to append the information to the existing status information for each of the selected alarms.

Ctrl+B Alarms > Set Trouble Ticket ID Opens the Set Trouble Ticket ID dialog box. Displays the user-created identification used to track a trouble ticket on an alarm. If more than one alarm is selected, the dialog box will not contain any information. You can select to append the information to the existing trouble ticket ID information for each of the selected alarms.

Ctrl+L Alarms > Clear Displays the Confirm Clear dialog box. If any of the selected alarm(s), are unclearable, an error message appears.

Ctrl+G Troubleshooter > Assign Opens the Assign Troubleshooter dialog box , which enables you to assign a troubleshooter to a selected alarm. If only one troubleshooter is created, it directly assigns that troubleshooter to the selected alarm(s).

Ctrl+U Troubleshooter > Unassign Displays the Confirm Unassign dialog box.

Ctrl+N Troubleshooter > Information... Opens the Information dialog box, which shows the assignment(s) for each troubleshooter. The dialog box also lets you modify the name and e-mail address for each available troubleshooter.

Ctrl+P Troubleshooter > Create... Opens the Create dialog box where you can create a troubleshooter and assign an optional e-mail address. Only users with write privilege can create troubleshooters.

Table 2-8: Keyboard Accelerators

Accelerator Menu selection Function

20 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

EAM Toolbar

The toolbar below the menu allows you to access menu choices quickly by clicking a toolbar button; see Table 2-9.

Note: When the cursor is positioned over a toolbar button, pop-up text identifying the tool displays. Further descriptive text is provided when you click the What’s This? button, and then click a toolbar button.

Ctrl+D Troubleshooter > Delete Opens the Delete dialog box, which enables you to select one or more troubleshooters to delete. If only one troubleshooter exists, it opens a Confirm Delete dialog box.

Ctrl+Y Options > Preferences Opens the Preferences dialog box.

Table 2-9: Toolbar Buttons

Button Function

Mail Opens the Mail Selected Items dialog box, which enables you to mail alarm information to the specified recipient(s).

Filter Opens the Filter dialog box, which enables you to filter alarms.

Sort Opens the Sort dialog box, which enables you to sort alarms.

Order Opens the Column Order dialog box, which enables you to show/hide and order the columns in the Alarm List.

Select All Selects all alarms in the Alarm List. This is used to perform an action on all alarms in the Alarm List (for example, clear all alarms, acknowledge all alarms, etc.).

Ack Acknowledges the selected alarm and puts a checkmark in the Acknowledged column. This button is grayed out if the selected alarm is already acknowledged.

Unack Unacknowledges the selected alarm and removes the checkmark from the Acknowledged column. This button is grayed out if the selected alarm is not acknowledged.

Clear Displays the Confirm Clear dialog box. If any of the selected alarms are unclearable, an error message appears.

Assign Displays the Assign troubleshooter dialog box. If there are no troubleshooters created, the Assign action will be disabled. This button is enabled or disabled based on the availability of troubleshooters.

Table 2-8: Keyboard Accelerators

Accelerator Menu selection Function

EAM Main window

Enterprise Alarm Manager User Guide 21

Shrinking the main window

When the main window is shrunk or compressed, menu items still appear. However, toolbar icons become accessible through a new icon that appears with double right-pointing arrows. Click the >> icon to view the additional toolbar icons.

Alarm information panel

Displays detailed information about the last alarm selected in the Alarm List. If multiple alarms are selected, the information pertains to the last alarm selected. The panel includes a device icon and eight tabbed panels, which are described in Table 2-10 on page 22.

Figure 2-2: Alarm Information panel

Note: Some probable cause information is requested from the primary landscape (VNM - Virtual Network Machine) and may be undefined for alarms in remote landscapes. To access probable cause information for alarms in remote landscapes, connect EAM directly to the landscape in which the alarm with the missing information is located.

If Archive Manager is disconnected through the Control Panel (or is otherwise not operating), alarm events data is unavailable. In this case, the following message appears in the Events tab:

An error occurred while retrieving the event information for this alarm.

Error: Connection lost (0x10000002).

Unassign Displays the Confirm Unassign dialog box. This button is grayed out if the selected alarm does not have a troubleshooter assigned to it. This button is enabled or disabled based on the availability of troubleshooters.

Ping Pings the device on which the alarm is occurring.

Telnet Telnets to the device on which the alarm is occurring.

MIB Tools Opens the MIB Tools application.

What’s This? Changes the cursor to a question mark which, when clicked on any area of the Alarm Manager window, displays a short description of the selected area.

Hints Launches a Web browser and displays the main Hints page with its associated links to other Hints pages.

Table 2-9: Toolbar Buttons

System*

sugar

Sun DV

Probable Cause* History*Events* Alarm Status* Trouble Ticket ID* Location* Device Notes*

AUTHORIZATION FAILURE TRAP RECEIVED

SYMPTOMS:

An authorization Failure trap was received from the device

PROBABLE CAUSES:

22 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

To correct this, restart Archive Manager from the Control Panel by selecting Control > Start Archive Manager.

Table 2-10: Alarm Information Panel Fields

Field Description

Device Icon The icon for the device associated with the alarm. Specific areas of the icon are double-click zones that access more detailed views. These zones are identified by the pop-up text boxes that appear when the cursor is positioned over them. The right mouse button activates the Icon Subviews menu from anywhere in the Alarm Information panel. Most of these views can only be accessed if SpectroGRAPH is running (Notes and Acknowledge menu picks can be accessed without SpectroGRAPH). For more information on how to use these views, which include Performance, Configuration, Model Information, Application and others, see SPECTRUM Views (2517).

System Tab Displays several fields of detailed system information, to include: System Name, Network Address, IP Address, Description, Contact, and Location.

-System Name The full domain name of the managed node. For example, in [email protected], "generic" is the name of the managed node (the network device on which the SNMP agent is running), and "company.com" is the domain name. This field is blank if the device is unreachable.

-Network Address The address SPECTRUM is using to talk to the device's SNMP agent.

-IP Address The port address of the interface. This information is only available on interface ports.

-Description A written description of the device SPECTRUM is talking to and managing, including system hardware type, and operating and network software.

-Contact The person to contact when device problems occur. This is specified when the device is created and can be modified in certain SpectroGRAPH views.

-Location The physical location of the device that generated the alarm (for example, Facility B, second floor.)

Probable Cause Tab The most likely reason(s) the selected alarm was generated.

EAM Main window

Enterprise Alarm Manager User Guide 23

Events Tab The event(s) that generated the selected alarm. By default, events are displayed in groups of ten. The event counter at the bottom right of the tab shows the total number of events and the current number displayed. Events are displayed from newest to oldest. Use the Next, Previous, Top, and Bottom buttons to navigate through the events. You can change the default setting by using the Preferences dialog box (Options > Preferences > Display). If no event(s) caused the alarm, the message “There is no event information associated with this alarm.” displays. (See page 21.) You can change various default event settings from the VNM icon by selecting Icon Subviews > Configuration > AlarmMgmt.

History Tab A list of five (default) or fewer historical alarm summaries for the selected model. These summaries provide a record of when alarms were generated and cleared, as well as actions taken on the alarms (status set, troubleshooter assigned, etc.). Use these summaries to compare the currently selected alarm to previous alarms on the same model and with the same probable cause. The most recent alarm appears first in the list. The alarm counter at the bottom right of the tab shows the total number of alarms and the current number displayed.

Use the Next, Previous, Top, and Bottom buttons to navigate through the alarm summaries. If more than the last five historical alarm summaries are needed, change the default setting (Maximum Alarm History Count) in the Preferences dialog box (Options > Preferences > Display). To disable Alarm History data, right-click the VNM icon in SpectroGRAPH’s Universe Topology view to access the Icon Subview Menu; then choose Configuration > AlarmMgmt and toggle Generate Alarm Events to “No”.

Alarm Status Tab Current administrative status of the device. These user-created notes can include device and alarm history. This tab is read/write. See “Set Status” on page 15 for more information.

Trouble Ticket ID Tab User-created identification used to track trouble tickets on an alarm. This tab is read/write. See “Set Trouble Ticket ID” on page 15 for more information.

Table 2-10: Alarm Information Panel Fields

Field Description

24 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

The System, Probable Cause, Events, History, and Location tabbed panels and their associated fields are read-only. The Alarm Status, Trouble Ticket ID and Device/Model Notes panels are read-write. For all panels, an asterisk (*) to the right of the tab name indicates the panel currently contains information. The last tab selected is saved and restored as the front panel when EAM is shutdown and restarted.

Alarm List

The Alarm List displays all alarms that fit the current filtering criteria. Table 2-11 on page 25 describes the default column settings shown at startup. Table 2-12 on page 26 describes the columns that are hidden at startup.

Location Tab Alarm location listed in SpectroGRAPH’s hierarchical format. For example, Topological Location: ‘squash’ of type ‘Landscape’; ‘Universe’ of type ‘Universe’.

Buttons for Topological Location, Physical Location, and Organizational Location provide direct access to the associated SpectroGRAPH view (if a SpectroGRAPH connection is established) where the device of the selected alarm is located. These buttons are grayed out if the views are not modeled in SPECTRUM.

When you click the Topological Location button in the Location tab, the view (in which the model resides) displays the alarming model highlighted and centered in that view.

Device/Model Notes Tab User-created notes for the device in alarm state.

This tab is read/write.

The tab varies depending on what is highlighted in the Alarm List. If the selected alarm is on a device with a network address, the tab is for Device Notes; if the selected alarm is on a model with no associated network address (that is, it is a conceptual model such as a User or Landscape), the tab is for Model Notes.

Table 2-10: Alarm Information Panel Fields

Field Description

EAM Main window

Enterprise Alarm Manager User Guide 25

Figure 2-3: Alarm List

Table 2-11: Column Settings at Startup

Column Definition

Severity The color-coded severity of the alarm, both graphically (colored bells or blocks of color) and with text.

Date/Time The exact moment the alarm was generated.

Model Name The model name of the device on which the alarm is occurring.

Network Address The address of the device on which the alarm is occurring.

Impact Severity The relative importance of this device to the network. (Device Criticality of the alarm plus Device Criticality of all its downstream neighbors.) The Impact Severity value is limited to the MAX_ULONG value set on the SpectroSERVER.

The Impact Severity value of an alarm is calculated when the alarm is generated. This value is not updated when the device criticality of a specific impacted object is updated.

Manufacturer The manufacturer of the device.

Model Class The type of device the model represents (for example, bridge, router, hub, etc.)

Device Type The value of the DeviceType attribute, which is used to identify the type of device based on the device’s System Object ID. The Device Type can be set using the Device Type Identification Application. See the Modeling with the GnSNMPDev Toolkit (1316) guide for instructions.

Model Type The SPECTRUM model on which the alarm is occurring.

Acknowledged The acknowledged state of the alarm. An acknowledged alarm is indicated with a check mark in this column.

Probable Cause Title The first line of the probable cause text.

Severity Date/Time Model Name Network Addr Impact Sever Manufactur Model Class Model TypeMaint...CriticalCriticalCriticalCriticalCriticalCriticalCriticalMinor

Mon 1 Oct 2001 10:17:06Mon 1 Oct 2001 14:47:23Mon 1 Oct 2001 14:46:14

Mon 1 Oct 2001 14:45:30Mon 1 Oct 2001 14:45:27Mon 1 Oct 2001 14:45:12Sun 30 Sep 2001 13:36:45

Sun 30 Sep 2001 13:36:06Sun 30 Sep 2001 13:36:44

123.19.54.64123.456.78.90123.564.76.80Fault Isolation123.606.49.10123.709.31.79123.566.32.54123.20.56.11123.21.88.12

123.19.54.64

123.456.78.90

123.564.76.80

123.606.49.10123.709.31.79123.566.32.54123.20.56.11123.21.88.12

011

13251000

Enterasys NetwEnterasys NetwEnterasys Netw

Enterasys Netw

Enterasys Netw

Enterasys Netw

HUBNODEBRIDGEAPPLICATIONBRIDGENODE

LINKLINKCHASSIS

Hub__CSI_IRMHSI_W6HubCSIEMMEFaultIsolation6H202_24Xyl_CSMIMIIWA_LinkWA_LinkHubSyn5xxx

Search Shown Prev Next

Filtered by Landscape

Maintenance

Displayed 9 of 9

Servers

1 Critical: 7 0 1 9Major Minor Total

26 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Stale alarms

When the SpectroSERVER shuts down and is then brought back up, alarms that existed prior to shutdown are re-displayed in the Alarm List. This “persistent alarm” feature enables SPECTRUM to retain alarm-related information (troubleshooter assignments, status, etc.) when the server goes down.

Assignment The name of the troubleshooter assigned to the alarm. See “Assigning alarms to troubleshooters” on page 44.

Clearable The clearable status of the alarm. Alarms with an “X” in this column can be cleared, those without an “X” cannot be cleared.

Landscape The landscape on which the alarm occurred (EAM only.)

Table 2-12: Columns Hidden at Startup

Column Definition

MAC Address The hard-coded physical address of the device.

Contact The person to contact when device problems occur.

Device Location The physical location of the device, (for example, telephone closet, first floor.)

Occurrences The number of times that the event that generated the alarm has occurred since the alarm was asserted. When an alarm is generated, the occurrences count is set to 1. Each time the event that created the alarm is generated while the alarm is still active, the occurrences will be incremented. If the alarm is cleared, and then the event is generated again so that a new alarm is generated, the occurrences will be set to 1.

Secondary An “X” denotes that this alarm is secondary to more severe primary alarms on this model.

Status The user-defined status (if any has been entered) of the alarm.

Trouble Ticket ID The user-created identification used to track a trouble ticket if any exists on the alarm.

Alarm ID The alarm's unique number identification, which is maintained even if the SpectroSERVER is shut down.

Probable Cause ID The system-generated ID for the alarm's probable cause (for example, 0x00010009 is the ID for the probable cause "Device has stopped responding to polls.”)

Stale A checkmark denotes an alarm that existed before the SpectroSERVER shutdown is now "residual," and may need to be cleared; see “Filter dialog box buttons” on page 35.

Table 2-11: Column Settings at Startup (Continued)

Column Definition

EAM Main window

Enterprise Alarm Manager User Guide 27

In some cases, the underlying cause of an alarm gets resolved between server shutdown and restart, but the alarm still displays in the Alarm List. These alarms are considered to be “stale” and can be cleared. Stale alarms, also referred to as “residual” alarms within SPECTRUM, can always be cleared by the user.

Stale alarms are identified by a checkmark in the Alarm List Stale column, which is hidden by default.

To display the Stale column:

1. Select View > Column Order to open the Column Order dialog box.

2. In the Hidden list, click Stale to highlight it.

3. Click the left arrow or double-click the highlighted name to move it to the Show list.

4. Click OK to apply your changes, or Cancel to close the dialog box with no changes.

Local Filter/Search area

Below the Alarm List’s scroll bar is the local Filter/Search area. This area displays four buttons and a text field that are used for local filtering and searching of alarms in the alarm list.

Toggles between filter and search functions; the default is Search.

Specifies which column to filter/search in; the default is Shown.

Finds the previous entry matching the search criteria. (Enabled only when the search option is selected.)

Finds the next entry matching the search criteria. (Enabled only when the search option is selected.)

Filter log area

Below the Search and Shown buttons is the Filter log area where the current filter settings are displayed. For Show/Hide list type filters, the Filtered by: field lists up to three items. If there are more than three items, the list is abbreviated with an ellipsis, for example, “Model Type (Show Pingable, VNM, User, ...)”. Probable causes are abbreviated after two items, for example, “Probable Cause (Hide DUPLICATE MODEL, OUT OF MEMORY, ...)”.

Alarm count panel

Displays the number of each alarm type displayed in the Alarm List and gives a total for all alarms. For consistency, the alarm severities are displayed in the color code used throughout SPECTRUM.

Search

Shown

Prev

Next

28 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Figure 2-4: Alarm Count panel

Note: In some cases, the alarm count total will not match the number of items displayed in the Alarm List. This occurs when a server that has alarms displayed in the list is shut down and filter settings are changed to filter out certain alarms. The Alarm List does not update with the changes relative to the down server until that server is restarted, but the alarm counts total displays the correct number based on current filter settings.

Initial and Suppressed alarms are Disabled by default and are not displayed in the Alarm List. Maintenance, Major, Critical, and Minor alarms are enabled by default and appear in the Alarm List. Any severity that is enabled through the VNM, but is hidden in the filter dialog, is shown grayed out in the Alarm Count Panel.

Displaying alarm severities

1. Open the SpectroGRAPH Universe Topology view and highlight the VNM icon.

2. Select View > Icon Subviews > Configuration to open the Landscape Configuration view.

3. Select AlarmMgmt from the Configure/Information panel list; then click OK to open the Alarm Management Model Information view.

4. In the Alarm Management Options field, toggle the Disable <severity> Alarms button to Yes. For example, to disable Maintenance alarms, set the Disable Maintenance Alarms toggle to Yes.

5. Select File > Save All Changes to close the Alarm Management Model Information view.

If you have Enabled Initial and Suppressed alarms in the Alarm Management Model Information view, you can make them appear in the Alarm List by doing the following:

1. From the Alarm Manager Main window, select View > Filter to open the Filter dialog box.

2. Click the Severity tab and move Initial and Suppressed severities from the Hide list to the Show list by clicking the left-pointing double arrow.

This displays Initial and Suppressed severity alarms in the Alarm List. However, only the Initial and Suppressed severity alarms generated after the setting change appear in the Alarm List.

Table 2-13: Severity Colors

Severity Color Definition

Initial Blue Contact with device is not established.

Suppressed Gray Device cannot be reached due to a known error condition that exists on another device.

Maintenance Brown Device is off line for maintenance purposes.

Critical Red A loss of service has occurred; immediate action is required.

Impact Scope view

Enterprise Alarm Manager User Guide 29

Connection Status information

Clicking the Servers icon at the bottom right corner of the EAM window displays the Connection Status dialog box, which shows the connection status and type of service of all servers accessible by the application. Possible types of service include Events, Alarms, Landscape, and View.

The color of the status icon indicates the condition of the connection. Color-coded conditions include green (complete service), yellow (degraded service), and red (total loss of service).

The Connection Log gives date/time information and status messages for the selected service in the dialog box. Possible messages include “Connection lost,” and “Connection re-established.”

Application Scope

If you start EAM by right-clicking on a specific model (Icon Subviews > Model Alarms), the Application Scope dialog box displays. This dialog alerts you that EAM was brought up on one or more selected models and that information is available only for those models and any models they might contain. For example, if you bring up EAM against a LAN model that contains other models, the alarms for that LAN and all the models it has within it display in the Alarm List. See “Accessing alarms for specific models” on page 9 for more information on bringing up EAM against specific models, accessing the Application Scope dialog box, and disabling the display of the Application Scope dialog box.

Impact Scope viewThe Impact Scope view lets you view which hidden network-critical devices have gone into a gray, suppressed condition. These devices are the downstream devices directly affected by the selected alarm in the Alarm List. Access the Impact Scope view from the View menu.

The level of criticality is arbitrarily set on an individual device basis from the Fault Management view on that device. See How to Manage Your Network in SPECTRUM (1909) for a discussion on the Fault Management view. See Table 2-14 on page 30 for definitions of the icons and columns in the Impact Scope view.

Major Orange A loss of service has occurred (or is impending); action is required within a short period of time.

Minor Yellow A situation has occurred, but no immediate action is required.

This severity is also used for alarms created only to convey information, such as “Duplicate IP.”

Normal Green Contact has been made with the device. Device is operating normally. There are no alarms associated with this device.

Total Sum of the alarms for all of the severities not filtered.

Table 2-13: Severity Colors (Continued)

Severity Color Definition

30 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Device Criticality

The Criticality value shown on the Impact Scope view (see Figure 2-5 on page 31) is determined by summing the device’s value plus the values of all other downstream neighbors associated with that device. The higher the number, the more critical or important the device is to your network. Since this is an arbitrary number, you can assign a high number to the device to signify its relative importance to your network.

The Impact Severity column value (shown on the Alarm Manager view) of an alarm signifies the total impact the device has on the network, taking into account its criticality plus the criticality of its downstream neighbors (Impact Severity = Device Criticality of the alarm plus the importance of all its downstream neighbors). The Impact Severity value is limited to the MAX_ULONG value set on the SpectroSERVER.

Note: The Impact Severity value of an alarm is calculated when the alarm is generated. This value is not updated when the device criticality of a specific impacted object is updated.

Table 2-14: Impact Scope View

Window Element Description

Source The icon for the source SpectroSERVER that controls this device.

Destination The icon for the device with the gray, suppressed condition.

Impact Type column The type of condition, such as “Contact Lost.”

Application column The source that generated the gray alarm, such as “SpectroSERVER.”

Source column The source’s IP address.

Destination column The impacted device’s IP address.

Criticality column A device’s criticality determined by the Device Criticality setting on the Fault Management view (default setting is “1”).

Filtering alarms

Enterprise Alarm Manager User Guide 31

Figure 2-5: Impact Scope View

Filtering alarmsYou can define which alarms will be displayed by establishing filtering criteria. These filtering subsets make it possible for you to customize EAM to display alarms appropriate to your networking needs. Only those alarms that meet all filtering criteria are displayed.

Note: If you change filter settings while a server with displayed alarms is down, the new settings are not applied to the down server. In this case, there may be alarms still displayed in the Alarm List that do not fit your filtering criteria. In addition, if you filter out an alarm severity while a server is down, the alarm count for that severity is grayed out, but the number of alarms remaining in the view is still reported, (that is, the alarm count total includes those alarms on the down server that would otherwise be filtered out). The filter’s new settings are applied once the down server re-establishes its connection.

Figure 2-6 on page 32 shows the EAM Filter dialog box and its Show/Hide list. Some of the Filter’s tabs use the Show/Hide format to choose filtering selections.

Impact Scope

Source Destination

Impact Type Application Source Destination Criticality

Contact Lost SpectroSERVER 123.456.67.89 123.45.67.96 75

Contact Lost SpectroSERVER 123.456.68.12 124.46.78.97 200Contact Lost SpectroSERVER 123.456.69.14 124.46.78.98 550

Search Shown Prev Next

Close Help

123.45.67.96

HubCSIEMME

Corporate

VNM

Impact Scope for 123.456.67.89 of type 6H2002_24

Displayed 3 of 3

32 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Figure 2-6: EAM Filter Dialog Box

The Filter dialog box displays tabs for setting various types of alarm filters and a variety of buttons to save and reset filter settings; see Table 2-15 and “Filter dialog box buttons” on page 35. The options available with each filter are retrieved from the database that is being used to model your network.

Table 2-15: Filter Tabs

Landscape Choose the landscapes you want displayed in the Alarm List and move them to the Show list. By default, only the primary landscape appears in the Show list; all other landscapes are in the Hide list.

Model Class Choose the model classes you do not want displayed in the Alarm List and move them to the Hide list.

Device Type Choose the device types you want to display in the Alarm List by typing a string into the Device Type text box and clicking the Add button. You can also click on the Device Type button to choose from a list of currently available Device Types.

The default setting is Show Device Types. You can toggle this button to Hide Device Types and exclude your selected Device Types (s) from the Alarm List.

Model Type Move the model type(s) that you do not want to view alarms for to the Hide list.

Filtering alarms

Enterprise Alarm Manager User Guide 33

Model Choose the models you want to display (or not display by toggling Show to Hide) in the Alarm List by typing a string into the Model Name text box. If the EAM is brought up against a specific model, (that is, Icon Subviews > Model Alarms), the Model List contains only that model and any models contained within that model. When more than 20 models are found in a search, a confirmation dialog box displays. If EAM is brought up with Tools > Alarm Manager, the Model List is empty (unless changes were made to the Model filter and saved using the Make Changes Permanent button in a previous EAM session).

The default setting is Show Models. You can toggle this button to Hide Models and exclude your selected model(s) from the Alarm List. The default setting is to find an exact match for your selected model name string. Toggle this button to search on a Substring, Prefix, or Suffix, (for example, "mod", "gen", or "del" will locate “generic_model”). The number of models that are added to the Model List is limited to 1000 by default (Max Model Filter Request). You can change the default number by selecting Options -> Preferences -> Filter.

Address Choose the devices you want to display in the Alarm List by designating either a list of network address ranges or a list of specific network addresses. To specify a range, enter an address in the From text box, and a different, higher address in the To text box. To specify a specific address, enter an address in either the From or To text box. If you do not want to display the network address in the Alarm List, toggle Show Network Address to Hide Network Address.

Date/Time Choose the date and time range that you want to view alarms for. You need to designate the Start Time and End Time.

Severity Choose the alarm severities that you want to show or hide by moving them to the appropriate list. Critical, Major, and Minor alarms are shown by default.

The Maintenance alarm severity is in the Hide column.

Initial and Suppressed alarms are not generated (enabled) by default; see “Displaying alarm severities” on page 28.

Cause Choose the probable cause messages that you do not want to view alarms for; then move them to the Hide list. The first time the filter dialog box opens, all available probable causes are loaded, which can take some time.

Assignment A list of all available troubleshooters from all the landscapes currently attached to is displayed. Click on the troubleshooters that you do not want to view alarms for; then move them to the Hide list. By default, “Unassigned” appears in the Show list. If you want to filter out all unassigned alarms from the Alarm List, move the “Unassigned” entry into the Hide list.

State Choose the states you want displayed in the alarm list by selecting or deselecting them. States are grouped by Acknowledge State (Acknowledge and Not Acknowledged), Clearable State (Clearable and Not Clearable, and Primary/Secondary State (Primary/Secondary and Primary Only).

Table 2-15: Filter Tabs (Continued)

34 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Note: Model types listed in the Filter dialog box pertain to the primary landscape only, (for example, the VNM connected to at startup). Other landscapes in the primary landscape’s map may contain different model types, but these additional model types do not appear in the Model Type list. To access model types on remote servers, designate one modeling catalog as the “master” containing all needed models, (this is generally the primary landscape or VNM) and copy the master catalog to all remote landscapes; see Distributed SpectroSERVER (2770) for a discussion of the master catalog.

Primary and secondary alarms

By default, the Alarm List displays only primary, or the most severe, alarms occurring on a device, and secondary alarms are suppressed.

Viewing both primary and secondary alarms on a model allows you to see all the alarms on that model rather than just the most severe which may be of help when troubleshooting.

For example, a model might have a primary alarm of Contact Lost but the reason for the lost contact, (for example, Device Too Hot, might now be a secondary alarm because lost contact is the more severe condition compared to the device being too hot). Being able to see the underlying secondary alarm would help focus your attention on the device's environmental control systems.

To display secondary alarms:

1. Select View > Filter to open the Filter dialog box.

2. Click the State tab.

3. In the Primary/Secondary State field, select the Primary and Secondary button.

4. Click the Make Changes Permanent button if you want your changes to be the new default settings.

5. Click OK to apply your changes. Secondary alarms will now appear in the Alarm List.

Note: Only one button at a time can be selected in the Primary/Secondary State field.

To view the Secondary Alarms Column:

Attribute Choose the attribute ID that you want to filter on by clicking the Attribute ID button and selecting the appropriate attribute. The ID number will automatically be written to the text field next to the button.

Next, choose the Comparison Type. This allows you to select how to compare the value of the attribute ID with the value in the Attribute Value field. Only the comparison types appropriate to the attribute’s data type will be displayed for selection.

Choose the Ignore Case selection if you do not want the comparison to be case sensitive. This selection is only enabled when it is appropriate for the attribute’s data type.

Fill in the Attribute Value field with the value you want to use in the comparison.

Table 2-15: Filter Tabs (Continued)

Filtering alarms

Enterprise Alarm Manager User Guide 35

1. Select View > Column Order to open the Column Order dialog box.

2. In the Hidden list, click Secondary.

3. Click the left arrow or double-click the highlighted name to move it from the Hidden list to the Shown list.

4. Click the up arrow to move the column up (to the left in the Alarm List) or to move it down (to the right in the Alarm List).

5. Click OK to apply your changes. For all secondary alarms, a checkmark will appear in the Secondary column.

The example below provides a second illustration of the relation between primary and secondary alarms on a device. In this case, one of the alarms has nothing to do with the device itself, but is the result of the creation, within SPECTRUM, of a duplicate model for the device.

Occasionally a device for which a SPECTRUM model has already been created, will have a second model created for it. SPECTRUM designates such a second model as a "duplicate" model, and automatically assigns it a Minor (yellow) Duplicate Model alarm, meaning that it will appear in the Alarm Manager's main Alarm List. If the device itself subsequently generates a more severe alarm, for example, a Critical (red) Contact Lost alarm, this alarm will become the primary alarm and the Duplicate Model alarm will become secondary because the most severe alarm is always designated the primary alarm.

Filter dialog box buttons

The Filter dialog buttons are:

Resets only the selected tab to the settings last saved by Make Changes Permanent, or those at startup.

Clears only the selected tab.

When used with the OK button, saves any new filter settings. These settings will be retained even if the EAM is shutdown and restarted. If the current user is part of a group, the settings can be saved for the user only or for the group. The options “To user” and “To user group” become accessible when the Make Changes Permanent button is clicked.

Note: For more information on user and group options, refer to Security and User Maintenance (2602).

.

Applies the new settings for the current EAM session only (unless the Make Changes Permanent button is selected) and closes the dialog box.

Reset Page

Clear Page

Make Changes Permanent

OK

Cancel

36 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Closes the dialog box and cancels any changes in the settings.

Resets all tabs to the settings last saved by Make Changes Permanent, or those at startup, and leaves the dialog box open.

Clears all tabs and leaves the dialog box open. If you click OK, all alarms are displayed in the Alarm List because no filters are set.

Displays help text for a specific area of the screen.

The Make Changes Permanent button is used to save the settings you chose in any of the tabs by clicking the button (to the recessed position) and selecting OK from the dialog buttons. These settings will be retained even if the EAM is shutdown and restarted. If the current user is part of a group, the settings can be saved for the user only or for the group. The options “To user” and “To user group” become accessible when the Make Changes Permanent button is clicked.

Note: For more information on user and group options, refer to Security and User Maintenance (2602).

Using the Advanced Filter

The Advanced Filter gives you more flexibility (compared to simple filtering) because it lets you make multiple selections of the types of filters you want to apply. Simple filtering, on the other hand, simply groups all filter selections and applies them in a linear fashion, (for example, Filter by Landscape and Secondary Alarms and Model Type). In simple filtering, all criteria must be met; in advanced filtering, any of the criteria, i.e., entry 1 or entry 2, can be met.

Note: You must have at least two entries in the Advanced Filter panel for an advanced filter to be applied and filter the Alarm List in an "either/or" fashion.

For example, with advanced filtering, you can choose to display red (Critical) HubCat5000 or yellow (Minor) Pingables. In this case, red (Critical) Pingables will not show up in the Alarm List, nor will yellow (Minor) HubCat5000. With simple filtering, you are not able to make this fine a distinction and you would see all Minor and Critical Pingables and all Minor and Critical HubCat5000. The example below shows you the steps to achieve advanced filtering for the above selections.

To filter on Critical HubCat5000 OR Minor Pingables only:

1. In the Filter dialog box, click the Model Type tab and hide all model types except HubCat5000 models by doing the following:

a. Move all model types to the Hide table with the double right arrow button.

b. Type “HubCat5000" into the Filter/Search text box.

Reset All

Clear All

What’s This?

Filtering alarms

Enterprise Alarm Manager User Guide 37

c. Move HubCat5000 into the Show table with the single left arrow button or double-click the entry.

2. Click the Severity tab and move Major and Minor alarms to the Hide list.

3. Click the Advanced button and then the Add button to put your selections in the Advanced Filter panel. The panel will read, "Model Type (Show HubCat5000) AND Severity (Show Critical)".

4. Click the Model Type tab and hide all model types except Pingable.

5. Click the Severity tab and move Major and Critical alarms to the Hide list.

6. Click the Add button to put your selections in the Advanced Filter panel. The panel should read, "OR Model Type (Show Pingable) AND Severity (Show Minor)".

7. Click OK.

Local Filter/Search area

The local Filter/Search area below the Alarm List allows you to locally filter (i.e., without using the Filter dialog box) and search alarm data using two buttons. The first button allows you to toggle between Filter or Search (the default is Search). The second button allows you to specify which column to filter/search in (Severity, Date/Time, Model Type, etc.); the default setting is Shown, which filters/searches all shown columns for a match (All filters/searches all columns, including those hidden from the list). Figure 2-7 shows the Local Filter/Search Area with the Search button selected.

When the Alarm List is filtered using the local filter the changes are temporary and the display will revert to its original state when the text box string is deleted or the EAM is shutdown and restarted.

Figure 2-7: Local Filter/Search Area

To locally filter the Alarm List using a specified string do the following:

1. Toggle the Filter/Search button to Filter.

2. Enter a string or partial string in the text box at the right of the menu buttons.

The list will update to display only those entries that match the string in the specified column (or any shown column if Shown is chosen).

To locally filter the Alarm List using a selection list do the following:

1. Toggle the Filter/Search button to Filter.

2. Toggle the Shown button to Acknowledged, Clearable, Secondary, Severity, or Stale.

38 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

A new selection list button will appear as shown in Figure 2-8. When you click the button, a list of all the available options is displayed.

Figure 2-8: Local Filter Selection List

3. Click the selection list button <NONE>, and select the desired severity that you want to filter and show.

To search the Alarm List do the following:

1. Toggle the Filter/Search button to Search.

2. Enter a string or partial string in the text box.

The first entry matching the string in the specified column (or any shown column if Shown is selected) is highlighted in the Alarm List. The Prev and Next buttons can be used to find the previous or next entries matching the string.

Note: The Prev and Next buttons are disabled (grayed out) when the filtering option is selected. The label under the Filter/Search area on the right-hand side displays how many entries are displayed out of the total.

Sorting alarmsYou can modify the EAM to best suit your needs by selecting a column category (Severity, Date/Time, etc.) by which to sort alarms. You can sort on up to three columns at a time and order alarms in ascending or descending order (i.e., most severe to least severe, newest to oldest, etc.) Sorting alarms can be done by two different methods, using the Sort dialog box or using the column headings in the Alarm Manager Main window.

To sort using the Sort dialog box:

1. Select View > Sort or click the Sort button. The Sort dialog box, shown in Figure 2-9 on page 39, appears.

Sorting alarms

Enterprise Alarm Manager User Guide 39

Figure 2-9: EAM Sort Dialog Box

The Sort By selection sets the “primary sort” by which the entire list is sorted. The two Then By selections set the “secondary” and “tertiary” sort order for the Alarm List.

Possible sorting options are:

Sorting can also be accomplished directly within the Alarm List by doing the following:

1. Click in a column header. This automatically makes the selected column the primary sort as indicated by the small triangle next to the right column separator. Clicking this same column will reverse the sort order and the triangle will invert its position. Ascending and descending order are indicated by a triangle pointing up or down, respectively.

2. Click in another column header. This now becomes the primary sort and shifts the previously selected primary sort to secondary, as indicated by the two triangles next to the column separator.

3. Click in a third column. This becomes the primary sort, the previous primary becomes the secondary, and the previous secondary becomes the tertiary as indicated by three triangles.

Acknowledged Landscape Probable Cause ID

Alarm ID MAC Address Secondary

Assignment Manufacturer Severity

Clearable Model Class Stale

Contact Model Name Status

Date/Time Model Type Trouble Ticket ID

Device Location Network Address None

Firmware_Version_Number Occurrences

Impact Severity Probable Cause User-Defined columns

Primary Sort

Secondary Sort

Tertiary Sort

Enterprise Alarm Manager: Sort

Sort By:

Then By:

Then By:

Severity

Date/Time

Alarm ID

Descending

Descending

Descending

OK Cancel Reset Clear

40 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Each subsequent column header sort will make the current selection the primary sort, the previous primary sort the secondary sort, and the previous secondary sort the tertiary sort.

Note: Only three columns can be sorted on at a time.

How sorting arranges the Alarm List

After you select a column to be the Primary sort order, the Secondary sort is applied when two or more alarms have the same value for the Primary sort field. For example, if the Primary sort is Model Type and the Secondary sort is Date/Time, list entries in the Model Type column are grouped together according to type (e.g., all GnSNMPDev models will be together) and, within this grouping, entries are arranged according to the Date/Time the alarms were generated. If you select a column as the Tertiary sort (e.g., Severity), the models grouped together according to type and date/time generated are further defined and grouped by severity. For example, any GnSNMPDev models generated at the same time and having a severity of Critical are grouped together in their adjacent list columns. Figure 2-10 on page 40 shows how the Alarm List looks when sorted this way.

Figure 2-10: Sorted Alarm List Order

Changing column order You can rearrange, hide or show columns to suit your particular needs. This can be done by using the Column Order dialog box, or directly within the EAM window by dragging and dropping column headers.

To reorder columns using the dialog box:

1. Select View > Column Order or click the Column Order icon. This displays the Column Order dialog box, which is comprised of a Shown Order/Hidden list.

2. Select the desired order of columns by highlighting a list entry and clicking the up/down arrows at the bottom of the Show list. (The topmost entry in the Column Order dialog box corresponds to the leftmost column in the Alarm List.) Select any columns you want to show or hide from

Minor Tues 27 Jan 12:09:12 GnSNMPDev

Critical Tues 27 Jan 12:09:18 GnSNMPDev

Minor Tues 27 Jan 12:09:24 GnSNMPDev

Critical Fri 30 Jan 13:54:34 GnSNMPDev

Minor Mon 02 Feb 10:36:10 GnSNMPDev

Critical Mon 02 Feb 10:36:10 GnSNMPDev

Critical Mon 02 Feb 10:36:10 GnSNMPDev

Severity Date/Time Model Type

The secondary sort column organizes the similar model types according to the time alarms were generated, in this case, in descending order.

The tertiary sort column further organizes the model types with alarms generated at the same time together. Here, the tertiary sort is by condition, descending order.

The primary sort column groups all similar model types.

Changing column size

Enterprise Alarm Manager User Guide 41

the Alarm List by moving them to the appropriate Hide/Show list using the left/right arrows, or by double-clicking a list entry.

To reorder columns using the mouse cursor (drag and drop):

1. Click the mouse button on a column header and keep it pressed down.

2. Drag the column to a new location using the cursor, which becomes an arrow pointing to a piece of paper. You can scroll past the edge of the window and the Alarm List window will scroll automatically to the left or right.

3. Release the mouse button.

Changing column sizeColumn size can be changed by two different methods:

• Double-click a column header. This will resize the column to the width of the longest text entry, including the header title, or

• Place the mouse over the column header separators to change the cursor to a left-right arrow, click the mouse button, drag the column header separator to the desired position, and release the mouse button.

Clearing alarmsYou have the option of clearing alarms. Clearable alarms are denoted by a “x?” mark in the Clearable column of the Alarm List. If an alarm has no check mark, it cannot be cleared and will remain in the Alarm List until the problem that generated the alarm is resolved. A confirmation dialog box is displayed to verify whether or not you want to clear the alarms.

Note: If you do not want to be prompted with the confirmation dialog box, you can turn this function off in the Preferences dialog box (Options > Preferences) by clicking the Actions tab and selecting (clicking to the recessed position) the Expert Clear button.

To clear alarms:

1. Click an alarm to select it from the Alarm List. Use the Control key to select multiple alarms or choose Alarms > Select All to select all alarms in the Alarm List. When selected, an alarm is highlighted.

2. Select Alarms > Clear, or click the Clear alarms toolbar button.

3. Click OK in the confirmation dialog box. The selected alarms are cleared and removed from the Alarm List, if they were clearable.

Note: If any alarms could not be cleared, an error dialog box listing the alarms not cleared will be displayed.

Users with view-only access to a model can clear an alarm in the Alarm Manager if the Alarm Clear By Read Only field is toggled to YES. This attribute is found by right-clicking the VNM icon and selecting Configuration. Then double-click AlarmMgmt to display the Alarm Management Model Information View.

42 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Acknowledging alarmsYou have the option of acknowledging alarms. This feature is useful when you assign the responsibility for selected alarms to a troubleshooter and then mark those alarms as “acknowledged.” When an alarm is acknowledged, a check mark appears in the Acknowledged column of the Alarm List and, if it is the only alarm on the device, the device icon in the Alarm Information panel stops flashing.

To acknowledge alarms:

1. Click an alarm to select it from the Alarm List. Use the Control key to select multiple alarms or choose Alarms > Select All to select all alarms in the Alarm List. When selected, an alarm is highlighted.

2. Select Alarms > Acknowledge, or click the Acknowledge alarms button. The alarm is acknowledged as denoted by a check mark in the Acknowledged column.

Note: Blue, gray, and brown alarms are acknowledged automatically by SPECTRUM. Also, these alarms never need to be assigned to a troubleshooter because they represent the state of a particular model and not an actual “alarm.” That is, an Initial (blue) alarm simply indicates that contact with the device has not yet been established. If contact is made, the “alarm” will go away. (see “Severity Colors” on page 28)

Setting alarm statusEAM includes an option for setting the administrative status for any alarm or set of alarms. This repair management feature of the EAM can be an aid in alarm management and report generation. When setting the status of selected alarms, you are prompted for new status text.

To set the status of selected alarms:

1. Click an alarm to select it from the Alarm List. Use the Control key to select multiple alarms or choose Alarms > Select All to select all alarms in the Alarm List. When selected, an alarm is highlighted.

2. Select Alarms > Set Status. The Set Status dialog box is displayed.

3. Enter the appropriate information in the text area of the Set Status dialog box.

4. If more than one alarm was selected, select Overwrite Existing Data to replace the current Status information for all alarms with the information entered in the dialog box.

Deselect Overwrite Existing Data to append the information entered in the dialog box to the existing information for the selected alarms.

Important: The Overwrite Existing Data option is deselected by default.

5. Click OK to set the new status for the alarm(s).

Set Status dialog box buttons are:

Sets the status on the selected alarms and closes the dialog box.

OK

Creating device/model notes

Enterprise Alarm Manager User Guide 43

Clears any previously entered text in the dialog box, and leaves the dialog box open.

Cancels all changes and closes the dialog box.

To see the newly entered status information, click the alarm in the Alarm List. The details of that alarm appear in the Alarm Information panel. Click the Alarm Status tab to view the status for the selected alarm.

Note: The status for a single alarm can also be set directly from the Alarm Status tab by entering the desired information and clicking OK.

To set the same Alarm Status or Trouble Ticket ID for all alarms, click the Select All icon, then click Alarms > Set Status (or Set Trouble Ticket ID) and enter the desired status. Click OK to set the status (or ID) to all alarms.

Important: When using the Alarms > Set Status or Set Trouble Ticket ID options, information contained in the Alarm Status or Trouble Ticket ID for any of the selected alarms is appended with new Alarm Status or Trouble Ticket ID information unless the Overwrite Existing Data button is selected.

Creating device/model notesDevice notes can include any information, including device and alarm history, pertinent to the device. These user-created notes are written to the device, not the alarm. As a result, if a device has more than one alarm on it, the notes will apply to all alarms on that device.

The tab will vary depending on the model on which a highlighted alarm is occurring: if the selected alarm is on a device with a network address, the tab will be for Device Notes; if the selected alarm is on a model with no associated network address, i.e., it is a conceptual model such as a Landscape or LAN, the tab will be for Model Notes.

Note: If different devices are selected, the device notes or model notes will only be written to the last device selected.

To write notes to multiple devices use the Global Attribute Editor (GAE). See the Search Manager User Guide (2383) for details.

To create Device or Model Notes:

1. Click the Notes tab.

2. Click in the panel to activate the editable field.

3. Enter your text.

4. Click OK.

Clear

Cancel

44 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Notes dialog box buttons are:

Saves the text.

Clears any previously entered text.

Cancels all changes and reverts to the text last entered.

Notes:

• You must click OK before selecting a new alarm or switching to a different tab.

• You may also enter device notes by selecting the Model menu and clicking on Notes or by right-mouse clicking from anywhere in the EAM window to access the Icon Subviews menu and selecting Notes, which will open the Notes dialog. When you open the Notes dialog box this way you also have the option of e-mailing your notes by clicking the Mail button.

Mailing alarm informationAlarm information may be emailed to user specified recipients. Highlight the desired alarms and select the File > Mail Selected Items... option or click the Mail icon on the toolbar. A mail message dialog box opens. Enter the mail recipients email addresses in the To: and Cc: fields. The Subject line may be changed from Enterprise Alarm Manager to any desired text. The body of the email will contain the alarm information for each of the selected alarms. Click in the body of the message and type any additional notes or information. Click the Send button when done.

Assigning alarms to troubleshootersThe repair management feature of the EAM allows you to assign any troubleshooter (Troubleshooter > Create) to selected alarms from the Alarm List. Troubleshooter assignments are canceled when the alarm is cleared.

Troubleshooters, when created, are shared from a common pool of troubleshooters based on the landscape to which the user is initially connected. Only landscapes which are currently filtered in will be listed in the Assignment dialog box. If a user selects to a different landscape, the troubleshooters associated with that landscape are listed.

All activities related to repair management are recorded in the Event Log.

Warning: No troubleshooting capabilities will be available if you connect a 5.0 EAM to a 5.0.1- 6.0 version of SpectroSERVER or if you don’t have the security privileges to access the VNM.

Note: Users with read-only privileges may assign and unassign a troubleshooter if the “Alarm Update by Read Only” flag is set to Yes. This flag is set in the Alarm Management Model Information View which is accessed by right-clicking the VNM icon and selecting Configuration.

OK

Clear

Cancel

Assigning alarms to troubleshooters

Enterprise Alarm Manager User Guide 45

In the Landscape Configuration View, double click AlarmMgmt and set the flag in the Alarm Management Model Information View.

When troubleshooters are assigned to alarms, the alarm can be acknowledged at the same time by selecting the Acknowledge When Assign option in the Options > Preferences > Action tab.

To assign a troubleshooter to an alarm:

1. Click an alarm to select it in the Alarm List. Use the Control key to select multiple alarms or choose Alarms > Select All to select all alarms in the Alarm List. When selected, an alarm is highlighted.

Note: Troubleshooters are created on a per-landscape basis. Assignments must be made to alarms on the same landscape the troubleshooter was created on. If alarms from multiple landscapes are selected, the Assign menu pick/toolbar icon will be disabled.

2. Select Troubleshooter > Assign, or click the Assign Troubleshooter button. The Assign dialog box displays a list of all created troubleshooters for the landscape of the selected alarm.

3. Select a troubleshooter from the list and click OK. The selected troubleshooter is now assigned to the selected alarm(s).

Note: If only one troubleshooter has been created, clicking Assign Troubleshooter will directly assign the troubleshooter and no dialog box will appear.

If more than one landscape is filtered in, toggle the Landscape field to the desired landscape. Troubleshooters available for that landscape will be listed. Select the desired troubleshooter and click OK.

Assign Dialog Box Buttons are:

Assigns the troubleshooter to the selected alarm and closes the dialog box.

Closes the dialog box without making an assignment.

To see which troubleshooter is assigned to an alarm, look in the Assignment column of that alarm in the Alarm List. The troubleshooter name for that alarm appears in the Assignment column of the Alarm List. To see all assignments for a particular troubleshooter, select Troubleshooter > Information to access the Information dialog box, and click the troubleshooter of interest to see its assignments.

Note: Troubleshooter assignments made by your user can be overwritten by another user.

Only troubleshooters for the current landscape will be listed in the Troubleshooter Information and the Troubleshooter Delete dialog boxes.

Troubleshooter notification

When a troubleshooter is created with a valid e-mail address an e-mail notification is sent informing the troubleshooter of the creation. E-mail notification is also sent when the

OK

Cancel

46 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

troubleshooter information is changed or the troubleshooter is deleted from the landscape. If the troubleshooter had previously been assigned to alarms, the e-mail notification will also state that the troubleshooter has been unassigned from the alarm(s).

When assigned to an alarm, the troubleshooter will receive e-mail with detailed information on the assigned alarm. The default information included in the e-mail messages includes: Trouble Ticket ID, Alarm Status, Acknowledged, Troubleshooter, Severity, Date/Time, Probable Cause, and the PCause text. Event information can be included by selecting the EMail Events to Troubleshooter option and setting the desired number (1 - 50) for the EMail Event Count, in the Options > Preferences > Notification tab. All other fields in the message are reflective of the columns currently displayed in the alarm table.

Additional e-mail containing this information is also sent when alarm changes occur, i.e., acknowledging, set status, clearing, etc. A sample mail message is shown below.The following alarms are being assigned to you, <troubleshooter name>:----------------------------------------------------------------------Trouble Ticket ID: Alarm Status: Severity: CriticalDate/Time: Mon 25 Mar 2002 17:01:42 ESTModel Name: guidoNetwork Address: <IP address>Manufacturer: Model Class: 9Model Type: Host_DeviceAcknowledged: FalseTroubleshooter: Clearable: FalseLandscape: sulu (0x2fe00000)Probable Cause: 0x00010009DEVICE HAS STOPPED RESPONDING TO POLLSSYMPTOMS:Device has stopped responding to polls.PROBABLE CAUSES:1) Device Hardware Failure.2) Cable between this and upstream device broken.3) Power Failure.4) Incorrect Network Address.5) Device Firmware Failure.RECOMMENDED ACTIONS:1) Check power to device.2) Verify status lights on device.3) Verify reception of packets.4) Verify network address in device and SPECTRUM.5) Cycle power on device and recheck.6) If above fails, call repair.

Events: Mon 25 Mar,2002 - 17:01:42 - Device guido of type Host_Device has stopped responding to polls and/or external requests. An alarm will be generated. (event [0x00010d03])----------------------------------------------------------------------<end of sample mail message>

Note: Troubleshooters with a valid e-mail address will also be notified of other alarm changes: Unassignment, Set Status, Set Trouble Ticket ID, Acknowledgement, Unacknowledgement, Clear, and Delete Troubleshooter.

Unassigning alarms

Enterprise Alarm Manager User Guide 47

The system’s mail utility needs to be configured properly in order for e-mail to be sent to troubleshooters.

Unassigning alarmsThis repair management feature of the EAM allows you to unassign a troubleshooter from selected alarms in the Alarm List. Troubleshooter assignments are canceled when the alarm is cleared. A confirmation dialog box is displayed before unassigning a troubleshooter.

To unassign a troubleshooter from one or more alarms:

1. Click an alarm to select it in the Alarm List. Use the Control key to select multiple alarms or choose Alarms > Select All to select all alarms in the Alarm List. When selected, an alarm is highlighted.

2. Select Troubleshooter > Unassign, or click the Unassign Troubleshooter button.

3. Click OK in the confirmation dialog box. The troubleshooter is now unassigned from the selected alarm.

Confirm Unassign Dialog Box Buttons are:

Unassigns the troubleshooter from the selected alarms and closes the dialog box.

Cancels all changes and closes the dialog box.

Creating troubleshootersThe Create Troubleshooter dialog box allows you to create troubleshooters for use on the current landscape.

To create a troubleshooter:

1. Select the Troubleshooter > Create menu item. The Create dialog box is displayed.

2. Fill in the fields appropriately. The troubleshooter that you designate should have a valid e-mail address or e-mail will not be received when an assignment is made (see “Troubleshooter notification” on page 45).

3. In a distributed environment, click the Landscape button and select the landscape that the Troubleshooter will be created on.

OK

Cancel

Table 2-16: Troubleshooter Information

Troubleshooter Name

The identity of the person who is to be responsible for troubleshooting network alarms.

E-Mail Address The valid e-mail address of the person designated above (optional).

48 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

4. Click OK to create the troubleshooter.

Create Troubleshooter Dialog Box Buttons are:

Creates the troubleshooter and closes the dialog box.

Cancels all changes and closes the dialog box.

Deleting troubleshootersThe Delete Troubleshooter dialog box allows you to delete one or more troubleshooters.

To delete a troubleshooter:

1. Select the Troubleshooter > Delete menu item. The Delete dialog box is displayed.

2. Select the troubleshooters that you want to delete and click OK on the Delete dialog box.

3. Then click OK in the confirmation dialog box. The selected troubleshooters are now deleted and removed from the list of available troubleshooters.

Delete Dialog Box Buttons are:

Deletes the selected troubleshooter and closes the dialog box.

Cancels all changes and closes the dialog box.

Hint: If only one troubleshooter is created, the Delete dialog box will not appear. Instead, a Confirm Delete dialog box will appear asking if you want the single troubleshooter deleted. If so, click OK.

Setting preferencesYou can change the startup defaults of the EAM to best suit your needs by using the Preferences dialog box. The dialog box allows you to customize and save preference settings, which provides persistence from one run of EAM to another (when you save the changes by using the Make Changes Permanent button). You access the dialog box from the Options menu; see Figure 2-11 (EAM Preferences dialog box with the Display tab selected).

Landscape The landscape that the troubleshooter will be created on.

OK

Cancel

OK

Cancel

Table 2-16: Troubleshooter Information

Setting preferences

Enterprise Alarm Manager User Guide 49

Note: A user with ADMIN privileges may select between User and Group for saving the Preferences using the Make Changes Permanent option. See Security and User Maintenance (2602) for more information. If the user does not have ADMIN privileges, then the selected preferences are saved for that user model only.

Figure 2-11: EAM Preferences Dialog Box

To access the Preferences dialog box, select Options > Preferences. The fields for the six tabs are outlined in Table 2-17 on page 49 through Table 2-22 on page 52.

Note: Default settings are shown in parentheses in the first column; deselected signifies a raised button, and selected signifies a recessed button.

To clear all Preference changes and return to the default settings, you can click either the Defaults button or select Options > Clear User Preferences. To clear all Preference changes for a Group and return to the default settings, select Options > Clear Group Preferences. This option is only available if the user is part of the group and has ADMIN privileges for that group.

Warning: Clicking the Clear User Preferences or Clear Group Preferences button will clear all your changes, including filter, column order, etc., and will require that you restart the EAM for the changes to take effect.

The Preferences Actions tab fields are:

Table 2-17: Actions Tab

Acknowledge When Assign (deselected)

If selected, the alarm is acknowledged when a troubleshooter is assigned to the alarm.

50 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

The Alarm Update Control function prevents the view from being unusable when the EAM is getting frequent alarm updates. One thousand milliseconds (1,000 ms) is the equivalent of 1 second.

The Preferences Alarm Update Control tab fields are:

Example:

Alarm Update Control at default settings

In a three second period of time (the Alarm Update Control Time), if there are more than five alarm updates (the Alarm Update Trigger Count) to the Alarm List, all further alarm updates are stored and withheld for 30 seconds (the Alarm Update Timeout) before the list is updated again with all alarms that occurred within that 30-second period.

This delay prevents the EAM from updating the Alarm List too frequently when a large number of alarms are being generated by network devices, or when alarms are being generated and cleared repeatedly by the same device.

Secondary alarms for devices in maintenance mode will be hidden.

The Preferences Connection tab fields are:

Expert Clear (deselected)

If selected, confirmation for clearing selected alarms will not be displayed.

Table 2-18: Alarm Update Control Tab

Alarm Update Control Time (3000 ms)

The interval, in milliseconds, during which EAM measures the number of times alarms are updated. (Minimum=1000, Maximum=60000)

Alarm Update Timeout (30000 ms)

The period of time during which alarm updates are stored and withheld (queued) before the Alarm List is updated again. (Minimum=1000, Maximum=300000)

Alarm Update Trigger Count (5)

The maximum number of alarm updates allowed during the Update Control Time. (Minimum=1, Maximum=1000)

Show Secondary Alarms When Device is in Maintenance (deselected)

If this preference is enabled, secondary alarms will be shown when the device is in maintenance mode. If this preference is not selected, all secondary alarms will be hidden when a device is in maintenance mode and will be shown again when the device is no longer in maintenance mode. This preference will only apply when primary and secondary alarms are enabled in the filter settings. If you reset this value, you will need to restart the Alarm Manager in order for the new setting will take effect. See How To Manage Your Network with SPECTRUM (1909) for more information on maintenance mode.

Table 2-19: Connection Tab

Connection Confirmation Interval (60000ms)

The time, in milliseconds, between requests to the server asking if it is still responding. (Minimum=1000, Maximum=No Limit)

Table 2-17: Actions Tab

Setting preferences

Enterprise Alarm Manager User Guide 51

The Preferences Display tab fields are:

Connection Confirmation Timeout (300000ms)

The time, in milliseconds, to wait for an answer from the server confirming it is still responding. (Minimum=1000, Maximum=No Limit)

Connection Retry Timeout (20000 ms)

Time, in milliseconds, for the client to wait for SpectroSERVER to establish the initial connection before returning an error. (Minimum=1000, Maximum=No Limit)

Connection Time Limit

(5000 ms)

The time limit, in milliseconds, for connecting to the server before the connection attempt is aborted. (Minimum=1000, Maximum=No Limit)

Disable Queue Send (selected)

If deselected, disables queue that sends requests to the SpectroSERVER.

Initial Landscape

(Server...)

The initial landscape that EAM will connect to. Select the desired server from the list displayed when you click the Server... button. The port and the landscape name are displayed in the field.

Mail Queue Size (512) Maximum number of outstanding Mail Service requests that an application can make. (Minimum=1024, Maximum=No Limit)

Mail Response Timeout (600000ms)

Minimum time, in milliseconds, the Mail Service waits for a response from the SpectroSERVER before the request is canceled. If the VNM is extremely busy, increasing this number can prevent a timeout from occurring when the EAM is invoked against a specific model. (Minimum=1000, Maximum=No Limit)

Max Send Batch Size (512)

Maximum number of Mail Service requests that are batched together. (Minimum=1, Maximum=No Limit)

Route Message Timeout (1000ms)

Time, in milliseconds, to wait for a landscape update before canceling requests that cannot be routed. (Minimum=1000, Maximum=No Limit)

Show SpectroSERVER Selection Dialog at Startup

(selected)

If selected, shows the Select SpectroSERVER dialog box at startup where you choose which server you initially connect to.

Table 2-20: Display Tab

Enable Sort From Column Headers (selected)

If deselected, disables the option to sort the Alarm List by clicking in column headers

Event Page Count (10)

Maximum number of events to display on the Events tab at any one time. Minimum number of events is 1 and maximum is 50.

Filter/Search Delay (500 ms)

The time delay, in milliseconds, between typing the last character in a string and a local Filter or Search being performed.

History Request Count (10)

Maximum number of events to request from the Archive Manager at any one time. (Minimum=1, Maximum=1000)

Table 2-19: Connection Tab (Continued)

52 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

The Preferences Filter tab field is:

The Preferences Notification tab fields are:

Iconify At Startup (deselected)

If selected, the main window is iconified at startup.

Maximum Alarm History Count (5)

Maximum number of historical alarm summaries to display in the History tab. (Minimum=1, Maximum=50)

Save Settings At Exit (selected)

Saves any settings made to the View menu (Show Alarm Information, Show Tooltips, etc.), and Options menu (Sound On, Auto Raise On) when EAM is exited.

Severity As Background Color (deselected)

If selected, displays the alarm severity color as the background color for the row in the alarm list table.

Severity Column As Rectangle (deselected)

If selected, displays the alarm severity in the Alarm List Severity column as blocks of color rather than as colored bells.

Show Severity Name (selected)

If selected, displays the name of the severity in the Severity column.

Table Column Header Font... (MediumB)

Click the Font... button to display a Font dialog box where you may choose font, style, and size of the Alarm List’s column header labels.

Table Data Font... (MediumB)

Click the Font... button to display a Font dialog box where you may choose font, style, and size of the Alarm List’s table text.

Visible Rows (15) Indicates the number of visible rows to display in the Alarm List at startup (the others are still accessible via the scroll bar). (Minimum=1, Maximum=1000)

Table 2-21: Filter Tab

Max Model Filter Request(1000)

The maximum number of models that will be placed into the Model list on the Model page of the filter dialog box before a dialog is displayed asking if all found models matching the string should be added to the list. (Minimum=1, Maximum=1000)

Table 2-22: Notification Tab

EMail Event Count(10)

The number of Events that will be mailed to the assigned Troubleshooter for the alarm.

EMail Events To Troubleshooter (selected)

Events associated with the alarm will be e-mailed to the assigned troubleshooter. The number of events is specified in the E-mail Event Count field. If deselected, Events will not be included in the troubleshooter notification e-mail.

Play Duplicate Sounds (deselected)

If selected, every new alarm will generate an audible sound. If deselected, only one sound is generated for each unique severity alarm that enters the system at the same time.

Table 2-20: Display Tab (Continued)

Setting preferences

Enterprise Alarm Manager User Guide 53

The Preference dialog box buttons are:

When used with the OK button, saves any new preference settings. These settings will be retained even if the EAM is shutdown and restarted. If the current user is part of a group, the preferences can be saved for the user only or for the group. The options “To user” and “To user group” become accessible when the Make Changes Permanent button is clicked.

Note: Preference changes can be made at the system, group, or user level depending on the current user’s privileges. For more information, refer to Security and User Maintenance (2602).

Applies any new preference settings for the current EAM session and closes the dialog box.

Cancels all changes and closes the dialog box.

Repeat Sound (deselected)

If selected, sounds are repeated (every minute by default) for all unacknowledged alarms.

Repeated Sound Interval(60 seconds)

Length of time to wait before repeating sounds for unacknowledged alarms. (Minimum=1, Maximum=3600)

Sound File for Critical Alarms

Location of the .au (Solaris) or .wav (NT) file to play when a Critical alarm enters the system.

<$SPECROOT>/lib/sounds/critical.au

Sound File for Initial Alarms

Location of the .au (Solaris) or .wav (NT) file to play when a Critical alarm enters the system.

<$SPECROOT>/lib/sounds/initial.au

Sound File for Maintenance Alarms

Location of the .au (Solaris) or .wav (NT) file to play when a Critical alarm enters the system.

<$SPECROOT>/lib/sounds/maintenance.au

Sound File for Major Alarms

Location of the .au (Solaris) or .wav (NT) file to play when a Critical alarm enters the system.

<$SPECROOT>/lib/sounds/major.au

Sound File for Minor Alarms

Location of the .au (Solaris) or .wav (NT) file to play when a Critical alarm enters the system.

<$SPECROOT>/lib/sounds/minor.au

Sound File for Suppressed Alarms

Location of the .au (Solaris) or .wav (NT) file to play when a Critical alarm enters the system.

<$SPECROOT>/lib/sounds/suppressed.au

Make Changes Permanent

OK

Cancel

Apply

Table 2-22: Notification Tab

54 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

Applies any new preference settings and leaves the dialog box open.

Clears all Preferences changes and returns to the default (factory) settings.

Displays help text for a specific area of the screen.

Displays the Hints help page for the selected tab.

Alarm sounds

When new alarms occur, an audible sound indicates which severity of alarms have entered the system. The default sound is a voice stating the severity, e.g., "Critical Alarm” or “Minor Alarm." You can customize this audible sound in the Preference dialog box Notification tab. If the Play Duplicate Sounds button (Notification Tab of the Preferences dialog box) is selected, a sound will be played for every alarm that enters the system at the same time. Otherwise, if left at the default setting, when alarms of the same severity enter the system at the same time, the severity of the alarm is announced only once.

Sound is turned on by default at startup. To turn sound off, select Options > Sound and click the button to the raised position.

Customizing the sound files

You can customize alarm sounds by editing the specific alarm severity sound file. For example, if you created a sound file called “Red Alarm” located in your /sounds/custom directory, and you want to use this instead of the default “Critical Alarm,” you would open the Preference dialog box Notification tab and replace <$SPECROOT>/lib/sounds/critical.au with <$SPECROOT>/lib/sounds/custom/Red Alarm.au, and click Apply or OK.

Note: If the Alarm Manager is run from one machine and displayed on another machine (the display is exported), sound will still be heard on the machine the Alarm Manager is being run from.

For example, the Alarm Manager executable is located on machine A. The user of machine B logs into machine A, exports the display back to machine B, and runs machine A's Alarm Manager. When new alarms come in, sound will be heard from machine A, not from machine B.

It is recommended that Alarm Manager be run from the machine on which the executable is located when the sound feature is being used.

Defaults

What’s This?

Hints

Iconified EAM

Enterprise Alarm Manager User Guide 55

Iconified EAMWhen the EAM window is iconified (minimized), it appears as an icon containing alarm bells. When a new alarm occurs or an alarm changes in the minimized EAM and auto raise (Options > Auto Raise) is on, the EAM automatically opens and comes to the foreground. If sound is enabled, it will still function while the window is minimized.

To restore the EAM window to its original size, double-click the alarm bell icon or choose Restore from the window manager menu.

56 Enterprise Alarm Manager User Guide

Chapter 2: Managing Alarms With EAM

57

Chapter 3: Custom Scripts and Applications

This chapter provides information on how to run scripts to customize certain aspects of EAM.

Note: While the following example scripts may be useful in your integration tasks, they may not be applicable in all cases and are not supported by Aprisma. Some or all of the following scripts may require modification for your integration project.

IntroductionEAM lets you to run scripts that can access specific EAM data provided by Alarm Manager. Once these scripts are created, the menu selections appear in the Icon Subviews menu, from where they are run.

Access tagsScripts run from the Icon Subviews menu of a selected alarm in the Alarm Manager have access to that alarm’s data.

The information accessible includes the following:

Table 3-1: Access Tags and Their Meanings

Tag Meaning

eventids The event IDs associated with this alarm.

causesymptoms The “Symptoms” portion of the probable cause text.

causereasons The “Probable Causes” portion of the probable cause text.

causesolutions The “Recommended Actions” portion of the probable cause text.

severity The severity of the alarm (e.g., Critical, Major, Minor).

alarmid The identifier associated with the alarm.

causenum The probable cause identification number.

causetitle The title of the probable cause.

58 Enterprise Alarm Manager User Guide

Chapter 3: Custom Scripts and Applications

status The alarm status of the alarm.

ticket The trouble ticket ID for this alarm.

troubleshooter The troubleshooter assigned to the alarm.

time The date and time the alarm was generated represented as a string.

seconds The date and time the alarm was generated, represented in seconds.

occurrences The number of times the alarm exists on the device.

acknowledged An indication of whether or not the alarm is acknowledged.

clearable An indication of whether or not the alarm is user clearable.

secondary An indication of whether or not the alarm is secondary.

vnm The landscape on which this alarm is occurring.

causetext The probable cause of the alarm, truncated at 1000 characters.

events The events associated with the alarm, truncated at 1000 characters.

history The history associated with the alarm, truncated at 1000 characters.

causetextfile The complete text of the probable cause, placed in a file (see “Truncated and untruncated tags” on page 59).

eventtextfile The complete list of events for the alarm, placed in a file (see “Truncated and untruncated tags” on page 59).

historytextfile The complete history associated with the alarm, placed in a file (see “Truncated and untruncated tags” on page 59).

statustextfile The complete alarm status of the alarm, placed in a file (see “Truncated and untruncated tags” on page 59).

tickettextfile The complete trouble ticket ID for this alarm, placed in a file (see “Truncated and untruncated tags” on page 59)

stale An indication of whether or not the alarm has become stale.

manufacturer The name of the manufacturer for the device on which this alarm is occurring (e.g., Cisco, Enterasys, etc.).

class The class of the device on which the alarm is occurring (e.g., router, hub).

user_label_one The label displayed for the first user-defined column.

user_value_one The value of the first user-defined attribute.

user_label_two The label displayed for the second user-defined column.

Table 3-1: Access Tags and Their Meanings (Continued)

Tag Meaning

Access tags

Enterprise Alarm Manager User Guide 59

Truncated and untruncated tags

The tags causetext, events, history, status, and ticket truncate their values at 1000 characters to prevent the command line from overflowing. The tags causetextfile, eventtextfile, historytextfile, statustextfile, and tickettextfile place the complete untruncated value into a temporary file and the name of the temporary file is passed back as the value of the tag.

Important: On Windows 2000/NT, if the values for causetext, events, history, and possibly status and ticket tags, are more than one line (lines ending with a line break), use the corresponding “textfile” tag (causetextfile, eventtextfile, historytextfile, statustextfile, or tickettextfile) to retrieve the value for the fields. The value returned to the “textfile” tags is the name of the file from which the actual data may be retrieved.

Notes:

• Use the causetext, events, history, status, or ticket tags if you know that the values will not exceed 1000 characters, or if you do not care if the value is truncated. Use the causetextfile, eventtextfile, historytextfile, statustextfile, or tickettextfile tags if you want to be guaranteed to receive the complete value.

• In order to implement scripted menu picks on all model types, modify the common.isv file in the

SG-Support/CsResource/actions directory.

You can also specify the specific attribute ID to access. For example, for model name you could specify (0x1006e).

This alarm information only makes sense for scripts run from Alarm Manager or Enterprise Alarm Manager, since the information will not otherwise be available. Scripts written which access this information should add the following tag to the .isv file to ensure the script is only available on the Icon Subviews menu for devices in the AM/EAM applications:

application=”<Alarm Manager>” or

application=”<Enterprise Alarm Manager>”

Example

1. Navigate to the SG-Support/CsResource/actions directory and locate the common.isv file.

2. Edit the common.isv file and add a GoScript entry which calls a script to print out a list of arguments. In the following example, “Using Access Tags” will appear under the Model Menu,

user_value_two The value of the second user-defined attribute.

user_label_three The label displayed for the third user-defined column.

user_value_three The value of the third user-defined attribute.

Table 3-1: Access Tags and Their Meanings (Continued)

Tag Meaning

60 Enterprise Alarm Manager User Guide

Chapter 3: Custom Scripts and Applications

or when you right click the model icon or an alarm in the Alarm Manager. Append the GoScript entry shown below to the end of the common.isv script file:

act="GoScript" menu="Using Access Tags" script="TagIT" arg="{alarmid}" arg="{severity}" arg="{time}" arg="{acknowledged}" arg="{clearable}" arg="{causetitle}" arg="{status}" arg="{class}" arg="{manufacturer}"

Warning: The GoScript entry must be on one continuous line. It does not work if it is split onto multiple lines.

3. In the <$SPECROOT>/SG-Support/CsScript directory, create a file called “TagIT”. The TagIT file prints out the arguments, and is called from the common.isv file.

Figure 3-1: TagIT Script

Warning: The last line that starts as ‘$XTERM -geometry’ must be typed as one continuous line. It does not work if it is split onto multiple lines.

4. In the <$SPECROOT>/SG-Support/CsScript directory, create a file called “PrintArgs”. The PrintArgs script is called from the TagIT script.

#!/bin/sh # # This script is used to demonstrate the access tags provided # in Alarm Manager that may be used to retrieve attribute# information. The purpose of “Access Tags” is to provide a# quick and easy way to obtain model and alarm information that# can be passed to a script. In addition, "Access Tags" do not# require the user to memorize long and complex Hex IDs. # SPECTRUM provides the "CsXTerm" utility that determines the# appropriate terminal configuration based upon operating system XTERM=`CsXTerm` if [ "`uname -s`" = "Windows_NT" ] then

$XTERM sh PrintArgs "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9" else

$XTERM -geometry 70x35 -e PrintArgs "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9" fi

Access tags

Enterprise Alarm Manager User Guide 61

Figure 3-2: PrintArgs Script

5. Make the scripts executable using the chmod command (chmod +x TagIT and chmod +x PrintArgs).

6. Run Alarm Manager.

7. Select an alarm and right click to access the Icon Subviews menu.

8. Choose the “TagIT” entry from the Icon Subviews menu to run the script.

#!/bin/sh # This script is used to display the parameters received by the# executable invoked from the icon subview menu of Alarm Manager. # This information could be used in e-mail, automated notification or# any other purpose the user determines appropriate. # Display Alarm Information: # echo "By using \"access tags\" the user is able to pass " echo "any item of information displayed in the alarm table listing"echo "" echo "Alarm ID: " $1 echo "Alarm Severity: " $2 echo "Alarm Date: " $3 echo "Alarm Acknowledged: " $4 echo "Alarm Clearable: " $5 echo "" echo "In addition, the user has the ability to pass data that " echo "is displayed in the tabbed panes along the top of the " echo "alarm table" echo "" echo "Probable Cause Information: " echo " " $6 echo "" echo "Alarm Status Information: " if [ -z "$7" ] then STATUS_INFO="Not available for this model" else STATUS_INFO=$7 fi echo " " $STATUS_INFO echo "" echo "Furthermore, device specific information may be retrieved from"echo "the Alarm Manager Application using \"access tags\"." echo "" echo "Device Type: " $8 echo "Manufacturer: " $9 echo "" echo "Press <ENTER> to Continue ... " read wait

62 Enterprise Alarm Manager User Guide

Chapter 3: Custom Scripts and Applications

9. Verify that a terminal window is displayed showing the output with the correct values.

10. Press Enter to exit.

Note: If a tag is specified that doesn’t exist, the invalid tag name will simply be returned, e.g., “{ticket}”. If an invalid attribute id is used, an error message will be displayed.

63

Index

AAbout EAM 18Accelerators 18Accessing AM and EAM within SpectroGRAPH 8Acknowledge

alarm 15Acknowledged 25Actions Preferences

Acknowledge When Assign 49Expert Clear 50

Advanced filter 36Alarm Count Panel 27Alarm Count panel 11Alarm ID 26Alarm Information panel 11, 21Alarm List Panel 47Alarm List panel 11Alarm sounds 54Alarm Status tab 23Alarm Update Control Preferences

Alarm Update Control Time (3000ms) 50Alarm Update Timeout (30000 ms) 50Alarm Update Trigger Count (5) 50

AlarmsClearing 41Initial 28Maintenance 28Major 29menu 15Minor 29Normal 29Primary 34Secondary 34Stale 27Suppressed 28Total 29

Application Scope 9, 13, 29Assign Troubleshooter 16, 45Assignment 26Auto Raise 16

CClear Group Preferences 16Clear User Preferences 16, 49Clearable 26Clearing alarms 15Column Order 14Confirm Delete dialog box 48Connection Preferences

Connection Confirmation Interval (60000ms) 50

Connection Confirmation Timeout (300000ms) 51

Connection Retry Timeout (20000 ms) 51Connection Time Limit (5000 ms) 51Disable Queue Send (selected) 51Initial Landscape 51Mail Queue Size (512) 51Mail Response Timeout (600000ms) 51Max Send Batch Size (512) 51Route Message Timeout (1000ms) 51Show SpectroSERVER Selection Dialog at

Startup (selected) 51Connection Status 13Connection Status Information 29Contact 22, 26Create Troubleshooter 16, 47Customizing sound 54

64 Enterprise Alarm Manager User Guide

Index

DDate/Time 25Defaults button 49Delete Troubleshooter 16, 48Description 22Device Icon 22Device Location 26Device Notes 43Device Notes tab 24Device Type 25, 32Disabling alarms 28Display Preferences

Enable Sort From Column Headers (selected) 51

Event Page Count (10) 51Filter/Search Delay (500 ms) 51History Request Count (100) 51Iconify At Startup (deselected) 52Maximum Alarm History Count (5) 52Save Settings At Exit (selected) 52Severity As Background Color (deselected) 52Severity As Rectangle (deselected) 52Show Severity Name (selected) 52Table Column Header Font (MediumB) 52Table Data Font (MediumB) 52Visible Rows (15) 52

Displaying alarm severities 28distributed environment 7Distributed SpectroSERVER 7

EEAM

Acknowledging Alarms 42Assigning Alarms to Troubleshooters 44Clearing alarms 41Creating Troubleshooters 47Deleting Troubleshooters 48Menus 12Panels 21Setting Alarm Status 42Setting Preferences 48Shrinking the Main Window 21Sorting Alarms 38Unassigning Alarms 47

E-Mail Address 47Events tab 23

FFile

menu 12Filter dialog buttons 35Filter log area 27Filter Preferences

Max Model Filter Request 52Filter Tabs

Address 33Assignment 33Attribute 34Cause 33Date/Time 33Landscape 32Model 33Model Class 32Model Type 32Severity 33State 33

Filter/Search Area 27Filter/Search Panel 13

HHelp

menu 17Help Index 17Help Topics 17Hide Selected Alarms 14hierarchical 8Hints 17History tab 23

Iicon

alarm clock 55Icon Subviews

menu 15Impact Scope 14Impact Severity 25Initial alarms 28IP Address 22

KKeyboard Accelerators

Alt+F4 (File > Close) 18Ctrl+A (Alarms > Select All) 18Ctrl+B (Alarms > Set Trouble Ticket) 19Ctrl+D (Troubleshooter > Delete) 20Ctrl+F (View > Filter) 18Ctrl+G (Troubleshooter > Assign) 19Ctrl+J (File > Mail Selected Items...) 18

Enterprise Alarm Manager User Guide 65

Ctrl+K (Alarms > Acknowledge) 18Ctrl+L (Alarms > Clear) 19Ctrl+N (Troubleshooter > Information..) 19Ctrl+P (Troubleshooter > Create...) 19Ctrl+R (Alarms > Unacknowledge) 18Ctrl+S (View > Sort) 18Ctrl+T (Alarms > Set Status) 19Ctrl+U (Troubleshooter > Unassign) 19Ctrl+Y (Options > Preferences) 20

keyboard accelerators 18

LLandscape 26Landscape Configuration view 28Local Filter/Search area 27Location 22Location tab 24

MMAC Address 26Mail Selected Items 12Manufacturer 25Menu and Toolbars 11Model alarms 14, 29, 33Model Class 25Model Name 25Model Notes 43Model Notes tab 24Model Type 25

NNavigate In 14Network Address 22, 25non-distributed environment 7Notes 14Notification Preferences

Initial Alarm Sound File 53Maintenance Alarm Sound File 53Major Alarm Sound File 53Minor Alarm Sound File 53Play Duplicate Sounds (deselected) 52Repeat Sound (deselected) 53Repeated Sound Interval (60 seconds) 53Suppressed Alarm Sound File 53

Notifications PreferencesCritical Alarm Sound File 53

OOccurrences 26Online Manuals 18Options 16

PPerformance 14persistent alarm 26Play Duplicate Sounds button 54Preference settings 48

Actions 49Alarm Update Control 50Connection 50Display 51Filter 52Notification 52

Preferences 16Preferences dialog box 48Primary alarms 34Print 13Print to Text File 13Probable Cause 25Probable Cause ID 26Probable Cause tab 22

Rresidual alarms 27

SSave filter settings button 36Secondary 26Secondary alarms 34Select All 15Set Status 15, 42Set Trouble Ticket ID 15Set User-Defined Columns... 17Severity 25Show Alarm Counts 14Show Alarm Information 13Show Hidden Alarms 14Show Status Help 13Sound 16SpectroGRAPH 7, 15Stale 26Stale alarms 27Status 26Suppressed alarms 28System Name 22

66 Enterprise Alarm Manager User Guide

Index

System tab 22

TText Conventions 5Tool Tips 13Toolbar 13, 20Toolbar icons

Acknowledge alarms 20Assign troubleshooter 20Clear alarms 20Filter 20Hints help 21Mail 20MIB Tools 21Order 20Ping 21Select All 20Sort 20Telnet 21Unacknowledge alarms button 20Unassign troubleshooter 21What’s This? help 21

Toolbar Labels 13Trouble Ticket ID 15, 26Trouble Ticket ID tab 23Troubleshooter

menu 15Troubleshooter Information 16Troubleshooter Name 47

UUnacknowledge 15Unassign Troubleshooter 16, 47

VView

menu 13

WWhat’s This? 17


Recommended