Skip to content
CA Spectrum - 10.2 to 10.2.3
Documentation powered by DocOps

Getting Started with Event Configuration

Last update January 22, 2018

Contents

Before You Begin

Before you begin using Event Configuration to create events and alarms, follow any of these steps:

Obtaining a Developer ID

The first 2 bytes of any event code contains a developer ID. By default, this portion of the event code is the default developer ID that is provided with CA Spectrum. However, if you are creating events and alarms to support a new device management module, or you are creating a Southbound Gateway integration; we recommend obtaining a unique registered developer ID from CA. A registered developer ID lets you specify event codes for your events that begin with your unique ID. You can easily recognize your custom code in OneClick and avoid potential conflicts with other CA Spectrum event codes.

To obtain a developer ID, contact CA Support. To be eligible for a developer ID, you must have purchased the Level 1 Toolkit.

Note: For information about the toolkit, see Spectrum Integrator. To activate your developer ID, use SSdbload with the -d option. For more information, see Database Management on loading developer information in.

Mapping Traps to CA Spectrum Events

When you are creating a management module for a device that is not supported by default in CA Spectrum. We recommend using MIB Tools to map the traps that the device sends to new CA Spectrum events. The new events are automatically created when the trap mappings are defined. Follow these steps before you begin using Event Configuration. You can then launch Event Configuration directly from MIB Tools to complete the configuration of the events and associated alarms.

If you create new events using Event Configuration instead of MIB Tools, you cannot use MIB Tools to map traps to them. Instead, you need to manually specify the mappings in the $SPECROOT/custom/Events/AlertMap file on each SpectroSERVER in your environment. This rule applies because the process of mapping traps to events using MIB Tools automatically creates new events with unique event codes. You cannot use MIB Tools to map traps to existing events that were previously created using Event Configuration.

AlertMap files are ASCII files that store the following Mappings:

  • Mappings between the traps that a device sends and CA Spectrum events
  • Mappings between the variable bindings that are sent with a trap and the event variables thatCA Spectrum generates on a model when the trap is received. Variable bindings can store attribute values in a MIB table, OIDs, or integer bit values.
Note: For more information about using MIB Tools to map traps to events, see Certifications.

Preserving Customizations Across Upgrades of CA Spectrum

Several types of event and alarm configuration files support event and alarm processing in CA Spectrum, such as: alert mapping files, event disposition files, event format files, event table files, and probable cause files.

The files that are provided with CA Spectrum to support CA-authored events and alarms are installed in subfolders of the following folders:

<$SPECROOT>/SS/CsVendor
<$SPECROOT>/SG-Support

When you are customizing CA-authored events and alarms or creating your own events and saving the customizations to one or more landscapes; the event and alarm configuration files that define your customizations are installed in the following folder or in one of its subfolders:

<$SPECROOT>/custom/Events

Following this procedure ensures that the support files for your custom events and alarms are not overwritten or affected when you upgrade to a newer version of CA Spectrum.

Starting the Event Configuration Application

You can start Event Configuration from the following locations:

  • OneClick Console
  • MIB Tools

Starting the Event Configuration Application from the OneClick Console

To load all events that are supported in the landscape (or landscapes in a distributed environment) into the application, start Event Configuration from the OneClick Console.

You can start Event Configuration from the OneClick Console.

Follow these steps:

  1. Launch the OneClick Console from the OneClick home page.
  2. From the Tools menu, select Utilities, Event Configuration.

Starting the Event Configuration Application from MIB Tools

To add trap support for a device that is not currently supported in CA Spectrum use MIB Tools, You must map the traps to new CA Spectrum events and specify those events to generate alarms. After you do the mapping, typically you further customize the events and alarms, which you must do in Event Configuration. For this reason, you can start Event Configuration directly from MIB Tools.

When you start Event Configuration from MIB Tools, only the events that are associated with the traps you select are initially loaded into the application.

You can start Event Configuration from MIB Tools.

Follow these steps:

  1. In the Navigation panel in MIB Tools, select the MIB containing the traps that have been mapped to the events that you want to configure.

    Note: Map traps to CA Spectrum events in MIB Tools before you can configure the associated events in Event Configuration. For more information, see information about trap support in Certifications.
  2. In the Contents panel, click the Map tab.
  3. In the Trap Support table, select the mapped traps for which you want to configure events, and click SPEC--editbutton_ICO (Edit traps for selected items in the trap support table).
    The Event Configuration application is started, and the events that are associated with the traps that you selected display by event code in the Navigation panel.

    Note: Click SPEC--reload_ICO (Reloads the list of events) on the Navigation panel, to load all events that are supported in the landscape or landscapes (in a distributed environment).

Overview of the User Interface

You can perform all event and alarm configuration tasks in the Event Configuration main window.

spec--ec_ui_overview_SCR

The window is divided into three panels:

  • Navigation: The Navigation panel lists all of the events that are currently loaded into Event Configuration.
    The Modified column displays a checkmark next to any event that you have created or modified but not yet saved to a landscape. For more information, see Saving Events to Landscapes.
  • Contents: The Contents panel displays a customizable event message in the Events tab in OneClick for the event that is selected in the Navigation panel.
  • Details: The Details panel provides access to the configuration information for the event that is selected in the Navigation panel. If the event generates an alarm, you can also configure the alarm in this panel.
Note: You can click the server connection icon (  SPEC--connectionstatus_ICO ) to access connection status information for all landscapes in the environment.

Loading All Events from All Landscapes

In order to, load or reload all of the events that are supported in the landscape (or landscapes if the environment is distributed).

Click SPEC--reload_ICO (Reloads the list of events) on the Navigation panel.

Note: Click SPEC--reload_ICO If you start Event Configuration from MIB Tools to work with a limited set of events, and now require access to all events supported in all landscapes.

Save Events to Landscapes

When you save new or modified events (and their disposed actions, such as alarms and event rules) to a landscape, Event Configuration updates the event disposition (EventDisp) files that define them on the SpectroSERVER. The SpectroSERVER flushes all existing event and alarm instances and reloads them using the most recent configuration information.

You can save all events or only selected ones. You can also save the changes to the local landscape only or, in a distributed environment, to some or all of the landscapes.

Note: You must save your changes to one or more landscapes before exiting Event Configuration, else the changes you have made are discarded when you exit the application.
Important! The save process flushes and reloads all event rules including those event rules that are in the middle of processing. As a consequence, the processing of events by active event rules is aborted, and all associated data (for example, counts for occurrences of contributing events) is lost.

You can save events to the landscape in a single SpectroSERVER environment.

Follow these steps:

  1. Do one of the following:
    • To save all modified or created events (and associated alarms) click Save All on the File menu.
    • To save only specific events (and associated alarms) select the events in the table in the Navigation panel and then click Save Selected on the File menu.
  2. Click Yes.

You can save events to one or more landscapes in a Distributed SpectroSERVER (DSS) environment.

Follow these steps:

  1. Do one of the following:
    • To save all modified or created events (and associated alarms), click Save All on the File menu.
    • To save only specific events (and associated alarms), select the events in the table in the Navigation panel, and then click Save Selected on the File menu.

    If one or more SpectroSERVERs are unavailable. A relevant notification is displayed so you that can cancel the process if wish to.

    Note: If any SpectroSERVERs are unavailable and cannot receive the changes, you can synchronize the events and alarms on all landscapes later.
  2. Click Yes to save the events and alarms to available SpectroSERVERs. Alternatively, click No to cancel the process.
    The Select Landscapes dialog opens. By default, all available SpectroSERVERs are listed in the left list , which means that all available SpectroSERVERs receive the updated events and alarms.
  3. If there are available landscapes to which you do not want to save the changes, select them in the left list and click the right-arrow button to move them to the right list.
  4. Click OK.

Synchronizing Events in a Distributed Environment

If you are running CA Spectrum in a distributed environment, update events and alarms using Event Configuration and saving them to landscapes, do any of the following tasks:

Synchronize Event Disposition Files on SpectroSERVERs

Event and alarm changes are saved to the SpectroSERVERs in a Distributed SpectroSERVER (DSS) environment only when, for example, a server is unavailable. As a result, conflicts in event and alarm configurations arise across the landscapes. Resolve these conflicts by saving the changes to the unavailable servers when they become available. You can perform this task using the synchronization features in Event Configuration.

To begin resolving event (and alarm) conflicts across landscapes, first add the Conflict column to the table of events in the Navigation panel.

Next, examine the Conflict column and note any select marks ( spec--checkmark--ICO ). CA Spectrum detects an event that is configured differently across two or more landscapes because it finds different event maps for the event in the event disposition files on the SpectroSERVERs. An event with multiple event maps is loaded into Event Configuration once for each unique event map in the DSS environment. The select mark notifies you of each event that has different configurations.

As an example, note the two instances of event 0xf40004 in the following image.

spec--ec_conflicts2_SCR

The image shows the result of customizing a predefined event (event 0xf40004) and saving the customization to some but not all landscapes.

You can identify the landscapes to which the custom event has been saved. Select the custom event 0xf40004 and examine the Landscapes tab (displayed automatically in a DSS environment) in the Details panel.

Similarly, you can identify the landscapes to which a predefined event has been saved. Select predefined event 0xf40004 and examine the Landscapes tab. The following image shows the Landscapes tab for the predefined event.

spec--ec_conflicts1_SCR

Compare the following information:

  • The configurations of the conflicting events
  • The landscapes to which the conflicting events have been saved

This information helps you identify the events to save and the landscapes where they are saved to resolve a conflict. Once you have identified these factors, synchronize the landscapes.

Synchronizing the landscapes updates the event disposition (EventDisp) files on one or more SpectroSERVERs. Once updated, they match the event disposition file on the main location server in the DSS environment. Use the Save command if the main location server does not have the event disposition file that you want to use to update the rest of the SpectroSERVERs. For more information, see Saving Events to Landscapes.

Note: You manually designate a main location server when you install CA Spectrum. For more information about location servers, see Distributed SpectroSERVER Administration.

Follow these steps:

  1. Select Synchronize on the File menu.
    The landscapes with event disposition files that differ from the file on the main location server are listed.
  2. To synchronize with the main location server, select the landscapes, and click OK.

    Note: Synchronize the event and alarm support files on the OneClick web servers in the environment.
Note: You can also synchronize event and alarm support files between fault-tolerant servers. For more information, see Distributed SpectroSERVER Administration .

Synchronize Event and Alarm Support Files on OneClick Web Servers

Support files are created when you create and configure events and alarms and save them to one or more landscapes using Event Configuration.
The following types of files are created and updated automatically on only the OneClick web server to which you are connected:

  • Event format files
    Store the event messages that are displayed in OneClick. Every event that CA Spectrum creates has an event format file.
  • Probable cause files
    Store the alarm messages that are displayed in OneClick. Every alarm that CA Spectrum creates and that appears on the Alarms tab in OneClick has a probable cause file.

If you are running multiple OneClick web servers, copy the folders containing the event format files and the probable cause files to the other OneClick servers in your distributed environment. Copy the following folders:

$SPECROOT/custom/Events/CsEvFormat

$SPECROOT/custom/Events/CsPCause

Also copy the contents of these same directories to a custom directory on all of the SpectroSERVERs in your environment in the following circumstances:

  • Use the command-line interface (CLI) commands showalarms or showevents.
  • Use CA Spectrum Alarm Notification Manager (SANM).

Updating the Overall Alert and Event System for a Landscape

As described in Saving Events to Landscapes, you can update only the events (and their disposed actions, such as alarms or event rules) on one or more landscapes using the Save commands available on the File menu.

However, to update the overall alert and event system more broadly for a given landscape, in OneClick, click Update Event Configuration on the SpectroSERVER Control subview of the Information tab on the VNM model. This action reloads the following:

  • The alert maps that are defined in all custom and predefined AlertMap files.
  • The event maps (including event rules) defined in all custom and predefined event disposition files.
  • The event procedures that are defined in all custom and predefined event procedure definition files.
  • The severity maps defined in all custom and predefined severity mapping files (which are used for alarms that are assigned an alarm severity level of Conditional).
  • The event-related resource settings that are defined in the.vnmrc file for the SpectroSERVER.

    Note: For information about these settings, see Logging Event-Related Errors. For more information about the.vnmrc resource file, see Distributed SpectroSERVER Administration.
  • The parse maps defined in all custom and predefined parse map files.

    Note: For information about parse map files, see Host System Resources Management.
Important! This update process flushes and reloads all event rules, including those event rules that are in the middle of processing. As a result, the processing of events by active event rules is aborted, and all associated data (for example, counts for occurrences of contributing events) is lost.

Add and Remove Columns from the Events Table

You can modify the event information that is displayed in the table of events in the Navigation panel by adding or removing columns from the table.

For example, if you are working in a Distributed SpectroSERVER (DSS) environment, it can be helpful to add the Conflict column to the table. This information lets you identify whether existing events are configured differently on different landscapes.

Note: To filter the events in the table that is based on a specific event property, the corresponding event property column must be displayed. The filtering mechanism checks the text string that you specify against only the text in the displayed columns.

Follow these steps:

  1. Right-click any column heading.
    The Table Preferences dialog opens.
  2. Click the Columns tab, and select the columns that you want to display.

    Note: You can also change the table sort order and font using the controls on the Sort and Font tabs.
  3. Click OK.

Logging Event-Related Errors

When you create and configure events and alarms using Event Configuration and then save them to a landscape, the event and alarm processing instructions are written to configuration files referred to as event disposition files.

To help you resolve errors in event disposition files, which result in errors in event processing, you can write errors of different types to log files. You specify which types of errors to log, and the log files to which to write them, using several parameters in the VNM resource file (.vnmrc file) for the SpectroSERVER. see subsections that follow for details on each parameter.

Several types of errors, such as syntax errors, are typically the result of manual modifications to event disposition files. To minimize these types of errors, it is recommended that you use Event Configuration, not a manual process, to create and configure events and alarms.

Important! If the SpectroSERVER encounters an error in an event map while parsing an event disposition file, that event map is ignored. The event map cannot therefore be used to process the associated event.
Note: If you modify the event-related.vnmrc parameters that are described in this section, you must reload the parameters on the SpectroSERVER using the Update Event Configuration command on the Information tab of the VNM model for the changes to take effect. For more information, see Updating the Overall Alert and Event System for a Landscape. Or you can restart the SpectroSERVER, which reloads all of the parameters in the .vnmrc file, not only the event-related ones. For more information about the.vnmrc file, see Distributed SpectroSERVER Administration.

event_disp_error_file

If you set this parameter to the name of a text file, CA Spectrum writes any syntax errors or other errors that it encounters while parsing an event disposition file to that text file. Use the following syntax:

event_disp_error_file=<file name>

The text file is created in the $SPECROOT/SS folder.

Or you can set the value as follows:

event_disp_error_file=stderr

This command sends the output to the console window in the CA Spectrum Control Panel and to the $SPECROOT/SS/VNM.OUT file.

Note: For more information about syntax errors, see Syntax Errors in EventDisp Files.

event_custom_override_warnings

If you set this parameter to TRUE, when CA Spectrum encounters an event map for an event in a custom event disposition file, and an event map for the same event also exists in an event disposition file that is provided with CA Spectrum, it logs a warning to the text file specified in the event_disp_error_file parameter (if a file is specified). The default value is FALSE.

Setting this parameter to TRUE can be helpful if you must determine which CA-authored events are overridden by your custom events, for example, for troubleshooting purposes. Use the following syntax:

event_custom_override_warnings=TRUE
Note: To set this parameter, you must manually add it to the .vnmrc file.

enable_event_variable_warnings

By default, CA Spectrum does not log any warnings that are encountered while copying event variable values from one event to another during event rule processing. You can override this default behavior by setting the value of this parameter to TRUE. Use the following syntax:

enable_event_variable_warnings=TRUE
Note: To set this parameter, you must manually add it to the.vnmrc file.

event_duplicate_action_warnings

By default, when CA Spectrum encounters identical (and, therefore, duplicate) event maps for an event within an event disposition file or across multiple event disposition files on a SpectroSERVER, it logs a warning to the text file specified in the event_disp_error_file parameter (if a file is specified).

Typically, this default behavior is desirable. However, you can override it by setting the value of this parameter to FALSE. Use the following syntax:

event_duplicate_action_warnings=FALSE
Note: To set this parameter, you must manually add it to the .vnmrc file.

event_disp_default_log

For the events that you create and manage using Event Configuration, you specify whether they are logged in the Distributed Data Manager (DDM) database using the Store Event in Historical Database event option in Event Configuration. See Specify Event Options for more information.

By default, events that do not have event maps in event disposition files are logged in the DDM database. You can override this default behavior by setting the value of this parameter to FALSE. Use the following syntax:

event_disp_default_log=FALSE

Typically, most events have event maps in event disposition files. However, there are situations where this behavior is not true.For example, if you mapped a trap to a CA Spectrum event manually instead of using the recommended method of using MIB Tools, and then you inadvertently neglected to define an event map for the event in an event disposition file, the event is still logged in the DDM database depending on the value of this .vnmrc parameter.

procedure_error_file

If you set this parameter to the name of a text file, CA Spectrum writes any errors that it encounters while parsing a procedure file to that text file. Use the following syntax:

procedure_error_file=<file name>

The text file is created in the $SPECROOT/SS folder.

Alternatively, you can set the value as follows:

procedure_error_file=stderr

This sends the output to the console window in the CA Spectrum Control Panel and to the $SPECROOT/SS/VNM.OUT file.

If the event_disp_error_file parameter is set, the errors that are encountered in procedures that are executed from events are written to the file specified in event_disp_error_file instead of to the file specified in this parameter. Errors that are encountered in other types of procedures, for example, in procedures used for diagnostics, are still written to the file specified in this parameter.

Note: To set this parameter, add it to the.vnmrc file manually.
Was this helpful?

Please log in to post comments.