Configure Notifications

Configure notifications for events that come from a data source to the Event Manager.
HID_Notifications
Configure notifications for events that come from a data source to Event Manager. The incoming events are evaluated against the conditions that you configure for the notification criteria. Only when the criteria are met does Event Manager take a notification action. If an event does not trigger a notification, you can still display the event in the Event List.
A user only configures and receives notifications for events for an item in a group to which the user has access.
Consider the following information:
  • Users cannot see the notifications of other users.
  • The action to delete event notifications does not affect the actual or future events.
In this article:
2
Manage Notifications
Administrators can manage notifications by viewing, creating, or deleting them. Manage notifications on the
Manage Notifications
page.
Prerequisite:
Event Manager is enabled and in the Available synchronized state.
As a default tenant administrator, you can work in a real-user context to create notifications for a tenant administrator or tenant user. Log in as a tenant administrator or tenant user. The default tenant administrator can also administrate the tenant, and then create a tenant-scoped notification by proxying to the user.
Follow these steps:
  1. Do
    one
    of the following tasks:
    • Hover over
      Administration
      , and
      Configuration Settings
      , and then click
      Notifications
      .
    • Click the name of your user account in the upper-right corner, and then click
      Manage Notifications
      .
    The
    Manage Notifications
    page appears.
Create a Notification that Sends Messages Related to Events Automatically
You can create a notification that sends messages that is related to events automatically.
Prerequisite:
Event Manager is enabled and in the Available synchronized state.
Follow these steps:
  1. From the
    Manage Notifications
    page, click
    New
    .
    The
    Create Notification
    dialog opens.
  2. Specify a name and description, and then click
    Next
    .
  3. Select the groups that generate events to trigger the notification, and then click
    Next
    .
  4. Select conditions for the notification, and then click
    Next
    .
  5. Specify the notification actions, and then click
    Next
    :
    • Email
      Send email notifications.
      To include the device name for events that are triggered on components, use the
      Item Parent Name
      property.
      To create or update a notification email template, select
      Save
      or
      Update Email Template
      . Changes to templates do not affect existing messages.
      For more information about this notification action, see the "Email" section.
    • Trap
      Send trap notifications. Multiple destinations are supported, but the first destination is required.
      Two MIB choices are available in the Notifications wizard to provide compatibility for existing customers.
      For more information about this notification action, see the "Trap" section.
    • Script
      Specify the script file name. All scripts must be executable.
      You can use a script in another language like Python or Perl.
      Store scripts in the
      /
      installation_directory
      /CA/PerformanceCenter/NotificationScripts
      directory.
      For more information about this notification action, see the "Script" section.
DX NetOps Performance Management
saves the notification and sends messages when the selected conditions occur.
Notification Actions
When you create a notification, you can specify the following actions:
Email
Send email notifications to one or more recipients when an event is raised or cleared. The email provides a link to the context page for the device or component that triggered the alarm.
To use the hostname in the URL instead of the IP address of the
NetOps Portal
host, configure the
Web Site Host
. For more information, see Update Performance Center Website Settings.
Supported roles:
Users with a role that contains the Create Notifications role right and Event Manager access can configure email notifications. However, the Administrator role must first specify an SMTP server.
In the
Email
tab, select
Enable
, and then configure the email notification settings.
Trap
Send trap notifications to fault or network management system (NMS) in your environment, such as
DX NetOps Spectrum
.
While
DX NetOps Spectrum
can receive traps, this method is not the preferred method to integrate with
DX NetOps Spectrum
.
For more information, see the
DX NetOps Spectrum
documentation
.
Create an SNMP profile with the outgoing trap port (typically 162) before creating the notification.
Supported roles:
Users with the Administrator role (global administrators) can configure trap notifications. Administrators must also have product privileges to Event Manager and data sources that create events.
The trap receivers must be preconfigured to receive traps. Each destination can have its own configuration regarding SNMP community and IPV4 destination. To receive and decrypt SNMPv3 traps, the SNMP profile for the trap receiver should match this notification configuration.
For more information, see SNMP Profiles.
For more information about trap formats, see the corresponding NMS documentation for your trap receiver.
Script
Define a script. Scripts can store events to a database, forward notifications to multiple systems, send specific types of notifications to some specific system, and so on. You can log output from scripts that you own. Script return codes are logged in the standard PC log file. Script notification actions are executed serially to ensure that sets are processed before clears. If the queue of unprocessed script notification actions exceeds a certain size (5000 by default), any new incoming script notification actions are dropped. An event is generated when events start dropping and when the processing of new script notification actions restarts. If a script takes too long to complete execution (300 seconds by default), it is killed and an event is generated. The script notification action events are generated on the Data Aggregator item in
NetOps Portal
.
For more information about how to change event properties that are related to script notification actions, see Change Event Properties.
Store scripts in the
/
installation_directory
/CA/PerformanceCenter/NotificationScripts
directory.
The following video examines automatic script event notifications:

Event Manager automatically passes the following parameters to script notification actions:
  • CAPM_EventDataSource
  • CAPM_EventCategory
  • CAPM_EventType
  • CAPM_EventSubType
  • CAPM_EventState
  • CAPM_EventSeverity
  • CAPM_EventOccurredOn
  • CAPM_EventDesc
  • CAPM_ItemParentName
  • CAPM_ItemName
  • CAPM_ItemNameAlias
  • CAPM_ItemDesc
  • CAPM_IPAddress
  • CAPM_ItemUrl
  • CAPM_ItemType
  • CAPM_ItemSubtype
  • CAPM_ItemId
  • CAPM_ItemParentId
Event-specific properties are also available and prefixed with
CAPM_EvProp_
. The
CAPM_ItemId
and
CAPM_ItemParentId
parameters are
NetOps Portal
IDs. The script parameters and notifications are always in English regardless of the
NetOps Portal
language.
Supported roles:
Users with a role that contains the Create Notifications role right can create or edit script notification actions.
Examples:
You can define a script that prints environment variables to a file and a CPU utilization threshold event can trigger the script.
  1. Define the following
    printenv.sh
    script in the
    /
    installation_directory
    /CA/PerformanceCenter/NotificationScripts/
    directory by issuing the following command:
    printenv > /
    installation_directory
    /CA/PerformanceCenter/NotificationScripts/out.txt
  2. Make the script executable by issuing the following command:
    chmod u+x printenv.sh
  3. Configure notifications so that a CPU utilization threshold event triggers the
    printenv.sh
    script.
    The script creates the following output:
    CAPM_EventCategory=PERFORMANCE
    CAPM_EvProp__Severity=1
    CAPM_IPAddress=10.253.223.1
    CAPM_ItemNameAlias=cisco2621-10.253.223.1
    CAPM_EvProp_AlarmRuleID=5,313
    CAPM_EvProp_AlarmAggregationMethod=No Aggregation
    CAPM_ItemId=118
    CAPM_EvProp_AlarmProfileName=Test cpu
    CAPM_ItemDesc=Cisco Internetwork Operating System Software ^M
    IOS (tm) C2600 Software (C2600-IK9O3S3-M), Version 12.3(9), RELEASE SOFTWARE (fc2)^M
    Copyright (c) 1986-2004 by cisco Systems, Inc.^M
    Compiled Fri 14-May-04 14:37 by dchih
    CAPM_EventState=OPENED
    CAPM_EventType=ThresholdViolation
    PWD=/
    installation_directory
    /CA/PerformanceCenter/EM/bin
    CAPM_EventDesc=A Threshold Violation event has been raised. (Profile Name: Test cpu, Rule Name: test cpu)
    CAPM_ItemName=CPU 2
    CAPM_ItemParentId=118
    CAPM_EvProp_ThresholdProfileFolderId=5,311
    CAPM_EvProp_AlarmDuration=60
    CAPM_EvProp_AlarmProfileId=5,314
    CAPM_EvProp_AlarmViolationRuleDetail=Utilization > 50.0
    SHLVL=1
    CAPM_EvProp__Alarm_ID=1500
    CAPM_ItemType=DEVICE
    CAPM_ItemParentName=cisco2621-10.253.223.1
    CAPM_EventSeverity=MAJOR
    CAPM_EvProp_AlarmMetricFamilyName=CPU
    CAPM_EventOccurredOn=Thu May 24 10:39:00 EDT 2018
    CAPM_EvProp_AlarmRuleName=test cpu
    CAPM_EventDataSource=Data [email protected]
    CAPM_ItemUrl=http://10.237.15.180:8181/pc/desktop/page?pg=r&DeviceID=118&timeRange=-1&startTime=2018-05-24+10%3A09+America%2FNew_York&endTime=2018-05-24+11%3A09+America%2FNew_York
    CAPM_ItemSubtype=router
    CAPM_EvProp_AlarmWindow=60
    CAPM_EventSubType=Raised
    _=/usr/bin/printenv
    If an error occurs during the script execution, the errors are logged in the
    PC_Install_Directory
    /PerformanceCenter/EM/logs/EMService.log
    file. For example, if the script does not exist or the script is not executable, an error is logged. The exit code of the script is also logged.
You can define a script that prints environment variables to a file and any device life cycle change can trigger the script.
  1. Define the following
    printenv.sh
    script in the
    /
    installation_directory
    /CA/PerformanceCenter/NotificationScripts/
    directory by issuing the following command:
    printenv > /
    installation_directory
    /CA/PerformanceCenter/NotificationScripts/env.txt
  2. Make the script executable by issuing the following command:
    chmod u+x printenv.sh
  3. Configure notifications so that device life cycle change events trigger the
    printenv.sh
    script.
    The script creates the following output:
    CAPM_EventCategory=CONFIG
    CAPM_EvProp__Severity=Unknown
    CAPM_IPAddress=138.42.96.2
    CAPM_ItemNameAlias=138.42.96.2 - alias
    CAPM_EvProp_User=admin
    CAPM_ItemId=110
    CAPM_EvProp_CurrState=RETIRED
    CAPM_EvProp_PrevState=ACTIVE
    CAPM_ItemDesc=RS 38000 - Riverstone Networks, Inc. Firmware Version: 9.4.1.1 PROM Version: prom-2.0.1.8
    CAPM_EventState=CLOSED
    CAPM_EventType=LifeCycle
    PWD=/
    installation_directory
    /CA/PerformanceCenter/EM/bin
    CAPM_EventDesc=LifeCycle - Change
    CAPM_ItemName=rs38000-96.2
    CAPM_ItemParentId=110
    SHLVL=1
    CAPM_ItemType=DEVICE
    CAPM_ItemParentName=rs38000-96.2
    CAPM_EventSeverity=
    CAPM_EventOccurredOn=Mon Dec 18 16:20:58 EST 2017
    CAPM_EventDataSource=CA Performance Center
    CAPM_ItemUrl=http://10.237.10.219:8181/pc/desktop/page?pg=r&DeviceID=110&timeRange=-1&startTime=2017-12-18+15%3A50+America%2FNew_York&endTime=2017-12-18+16%3A50+America%2FNew_York
    CAPM_ItemSubtype=router
    CAPM_EventSubType=Change
    _=/usr/bin/printenv
    If an error occurs during the script execution, the errors are logged in the
    PC_Install_Directory
    /PerformanceCenter/EM/logs/EMService.log
    file. For example, if the script does not exist or the script is not executable, an error is logged. The exit code of the script is also logged.