How to configure and receive alerts from ONTAP EMS Event Subscription in Active IQ Unified Manager

Applies to

• ONTAP 9.3.x and above
• ONTAP EMS
• OnCommand Unified Manager 7.x - 9.5.x
• Active IQ Unified Manager 9.6.x +

Description

• OnCommand Unified Manager has been rebranded to Active IQ Unified Manager as of the 9.6 release. 
  • For the purposes of this article, Unified Manager will refer to both OnCommand Unified Manager and Active IQ Unified Manager.

• Unified Manager serves as a centralized location to receive critical EMS events and send notifications to administrators through alerts configured against the EMS events.

Procedure

Configure EMS Subscriptions in Unified Manager

This section describes how to implement EMS Subscriptions in Unified Manager and verify the configuration.

IMPORTANT: In order for Unified Manager to send notifications when an EMS event of interest is received, an alert must be configured.

Configuring an EMS Subscription in Unified Manager

1. Login to the Unified Manager Web UI.
2. Depending on the Unified Manager release, navigate to:   
   • Active IQ Unified Manager 9.6.x + 
     • Click  Storage Management > Event Setup > 
   • OnCommand Unified Manager 7.x - 9.5.x
     • Click  Configuration > Manage Events > 
3. Click Subscribe to EMS events(top right corner).
   • In the Subscribe to EMS events dialog box, enter the name of the ONTAP EMS event to which you want to subscribe. The EMS events must be entered as a single event. Multiple events (regardless of delimiter) or 'wildcard' events (example: snapmirror.status*) cannot be used in the 'EMS event name' field or the subscription process will fail.  Do NOT enter any event name that has been marked as deprecated.
   • Note: The Description field is not a required field for the subscription process. The optional description only helps to identify EMS events in this list and is not visible anywhere else.
   • Using the above example for SnapMirror status, the message name is: snapmirror.status.updateStatusErr
     
     
4. Click Add.
   • The EMS event is added to the Subscribed EMS events list, but the status 'Unknown' appears in the Applicable to Cluster column.
     
     
5. Continue by clicking on "Add" and adding individual EMS event names to the Subscribed EMS Events listing, if needed.  
6. Click Save and Close to initiate the EMS event subscription process. This subscription process is executed against every cluster that Unified Manager is currently monitoring. A banner message will appear on the screen indicating the subscription process has been initiated.

Verifying the EMS Subscription in Unified Manager

•     Click Subscribe to EMS events.
  • The status 'Yes' appears in the Applicable to Cluster column for the EMS event added. If the status is not 'Yes', check the spelling of the ONTAP EMS event. If the name is entered incorrectly or there is a DNS issue; you must remove the incorrect event or correct the DNS configuration and then add the event again.
• Note: The EMS Subscription process in Unified Manager will be triggered against every cluster that Unified Manager is currently monitoring.

Verifying the EMS Subscription on a Cluster:
Even if the status 'Yes' appears in the Applicable to Cluster column for the EMS event added, the EMS Subscription process may not have been successfully configured on all clusters monitored by Unified Manager. Incorrect event names must be verified first (typographical errors) and corrected by removing the event name and adding with the correct spelling.

NOTE:

• If the EMS event name is not available in an ONTAP release, the subscription cannot be successful.
• Ontap 9.11.x and newer require going into priv set diag to utilize these commands.

Access the clustershell (CLI) by logging in with an SSH client and verify the destination (Unified Manager) has been added as a 'Syslog Dest.' to the cluster:

• ONTAP 9.3+ - No event destinations have been configured:

c90::> event destination show

                                                                         Hide
Name             Mail Dest.        SNMP Dest.         Syslog Dest.       Params3
---------------- ----------------- ------------------ ------------------ ------
allevents        -                 -                  -                  false
asup             -                 -                  -                  false
criticals        -                 -                  -                  false
pager            -                 -                  -                  false
traphost         -                 -                  -                  false
5 entries were displayed.

• ONTAP 9.3+ - After the Unified Manager subscription process has successfully completed:

c90::> event destination show

                                                                         Hide
Name             Mail Dest.        SNMP Dest.         Syslog Dest.       Params
---------------- ----------------- ------------------ ------------------ ------
allevents        -                 -                  -                  false
asup             -                 -                  -                  false
criticals        -                 -                  -                  false
um.lab.demo      -                 -                  um.lab.demo        false
pager            -                 -                  -                  false
traphost         -                 -                  -                  false
6 entries were displayed.

Access the clustershell (CLI) and verify that the requested events have been configured to be sent to the Syslog Dest. (Unified Manager) by the cluster. Only one message is shown below. If multiple events were configured in Unified Manager, verify each event of interest is present in the output of the commands below.

• ONTAP 9.3+:

c90::> event route show -destinations um.lab.demo -fields message-name

message-name                      severity
--------------------------------- --------
snapmirror.status.updateStatusErr ERROR

 

Alerting

Active IQ Unified Manager can also send notifications that alert you about EMS events being triggered in your environment.

1. Navigate to the Alert Setup page and click on Add to add a new alert.  Provide a new alert name and a description for the alert if needed, then click on Resources.

Note: An existing alert can also be modified in a similar way for EMS event notifications.

2. Include or exclude the resources to be included in the alert, then proceed to Events.

 

 

 

 

 

 

 

 

 

 

 

 

 

3. Select EMS events based on the severity of the event, as shown below. Then proceed to the Actions  tab.

4.  Provide information as to how users will be alerted about the respective EMS events, as well as the notification frequency of the alert.  If required, users can also execute a custom script when the alert is triggered. Click Save  when done. 

5. A confirmation should appear in a green banner, denoting that the alert was added successfully.

Additional Information

• ActiveIQ Unified Manager alert configuration and management Resolution Guide
• Frequently Asked Questions (FAQs) and Troubleshooting KB Articles for ActiveIQ Unified Manager ONTAP EMS subscription based events
• How to identify ONTAP EMS events for subscription in Active IQ Unified Manager