N1 Grid Service Provisioning System 5.0 System Administration Guide

Configuring Email Notification

You can specify that the provisioning system send email notification when any system, administrative, or custom event occurs. The criteria that you specify is saved in the provisioning system as a notification rule. You can define a notification rule to apply to a single host or a host set, to an event that generates a particular message, or to an event of a specified severity level.

When you create a notification rule, you tell the provisioning system which events you are interested in. When an event occurs that matches your criteria, the provisioning system sends a message to the email address that is specified in the notification rule.

You might want to create notification rules in the following scenarios.

You need to know when an error has occurred or a plan has failed to run.
You want real-time feedback about who is logged in to the provisioning system.
You want to know about anything that happens on a particular host set.

When you set up a notification rule, you specify the email addresses to which the notification will be sent.

When you installed the provisioning software, you specified the following information.

The email address from which the provisioning software sends notifications
The subject line that should appear in the header of notification email messages

The default subject line text is N1 Service Provisioning System Notification. To change the notification message's subject line, go to the Master Server's config.properties file and update the note.notificationSubject parameter with the desired subject line message. Once you have updated the file, restart the Master Server for the change to take affect.

How to Set Up Notification Rules

If you plan to create a new notification rule by using an existing rule as a template, see How to Edit Notification Rules.

This procedure describes how to create notification rules by using the browser interface. You can also perform this task by using the following command.

rule.add – Creates a new notification rule.

Before You Begin

To create a notification rule, you must belong to a user group that has write permissions on notification rules.

Steps

In the navigation menu, click Notification Rules.

The Notification Rules page is displayed. It lists the notifications that are already saved in the database.

In the top row of the Notification Rules table, type a name and a brief description for the rule you plan to create and click Create.

The Details page for the notification rule is displayed.

The notification rules Details page allows you to perform the following tasks.
- Specify the event or events that will trigger the notification
- Specify the email address to which the notification should be sent

Specify the criteria for the new notification rule.

There are four ways to specify which events will trigger an email notification.
- Event Type. If you know the type of event that you want to monitor, select the event type from the drop-down list.
- Severity Level. If you want to monitor events of a particular severity level, select the severity level from the drop-down list.
  
  When you specify the event's severity level, you can specify whether you want a notification email to be triggered when an event of that severity or higher occurs. To determine what the severity of a particular type of event is, refer to Table 8–1.
- Event Message. If you want to select events based on the messages they automatically generate, you can specify part or all of an event text message in the event text contains field.
  
  To determine the generated message of the event you want to monitor, set up a notification rule that will trigger a notification email. When you receive a notification email that was triggered by the event you want to monitor, place the message contents in the Event Text Contains field. You can also use an asterisk (*) to match any number of characters.
- Host or Host Type. If you want to monitor a specific host or host set, type the name of the hosts in the host field or select a host set from the drop-down list.
  
  To specify multiple hosts by name, lists the names in the On Host field and separate them with spaces, semicolons, or commas.

In the Email a Notification To field, type an email address for the recipient of the notification messages.

Separate multiple addresses with spaces, semicolons, or commas.

When you have finished setting up the notification rule, click Save.

The notification rule is added to the Notification Rules page.

How to View Notification Rules

Viewing notification rules allows you to evaluate if the correct people are receiving the correct amount of system information.

You might want to view notification rules in the following situations.

You need to determine if the correct people are receiving system messages.
You need to determine why you are receiving email notifications.
You need to determine why you are not receiving expected email notifications.
You want to remove yourself from a notification rule's mailing list.

This procedure describes how to view notification rules by using the browser interface. You can also perform this task by using the following commands.

rule.la – Displays all notification rules.
rule.lo – Displays detailed information about a specific rule.

Steps

From the navigation menu, choose Notification Rules.

The Notification Rules page is displayed.

(Optional) To view details for a specific notification rule, find the row that lists the rule that you want to view and click Details.

How to Edit Notification Rules

Editing notification rules allows you to adjust existing rules to further meet your needs. You also have the option of creating new notification rules based on existing rules.

This procedure describes how to edit notification rules by using the browser interface. You can also perform this task by using the following command.

rule.mod— Modifies a notification rule.

Before You Begin

To edit a notification rule, you must belong to a user group that has write permissions on notification rules.

Steps

From the navigation menu, choose Notification Rules.

The browser interface displays the notifications page, which lists the notifications that are already saved in the database.

Select the notification rule that you plan to edit and click Details.

Note –
If you plan to create a new notification rule based on an existing rule, select an existing rule that is similar to the new rule you plan to create.

The browser interface displays the notification rule's Details page.

Specify the criteria for the new notification rule.

There are four ways to specify which events will trigger an email notification.
- Event Type. If you know the type of event that you want to monitor, select the event type from the drop-down list.
- Severity Level. If you want to monitor events of a particular severity level, select the severity level from the drop-down list.
  
  When you specify the event's severity level, you can specify whether you want a notification email to be triggered when an event of that severity or higher occurs. To determine what the severity of a particular type of event is, refer to Table 8–1.
- Event Message. If you want to select events based on the messages they automatically generate, you can specify part or all of an event text message in the event text contains field.
  
  To determine the generated message of the event you want to monitor, set up a notification rule that will trigger a notification email. When you receive a notification email that was triggered by the event you want to monitor, place the message contents in the Event Text Contains field. You can also use an asterisk (*) to match any number of characters.
- Host or Host Type. If you want to monitor a specific host or host set, type the name of the hosts in the host field or select a host set from the drop-down list.
  
  To specify multiple hosts by name, lists the names in the On Host field and separate them with spaces, semicolons, or commas.

Save the notification rule.
- To save the modified notification rule, click Save.
- To use an existing notification rule as a template for a new rule, click Save As.
  1. Type a new, unique name for the notification rule.
  2. Click Continue to Save.
  The new rule displays in the Notification Rules table.

How to Delete Notification Rules

You might want to delete a notification rule when it is no longer being used or you no longer want to receive email about a particular event.

You can delete notification rules at the following times.

When you view the Notification Rules table
When you view the notification rule's Details page

This procedure describes how to delete notification rules by using the browser interface. You can also perform this task by using the following command.

rule.del— Deletes a notification rule.

Before You Begin

To delete a notification rule, you must belong to a user group that has write permissions on notification rules.

Steps

Go to the Notification Rules page.

For the procedure about how to navigate to the Notification Rules page, see How to View Notification Rules.

Select each notification rule that you plan to delete.

You can delete more than one notification rule at a time.

In the last row of the Notification Rules table, click Delete.

Another page is displayed that provides the option to cancel the deletion.

Verify that you are deleting the correct notification rule and click Continue to Delete.

The notification rule that you deleted is no longer listed in the table on the Notification Rules page.

Event Severities

The following table defines the severity of each event description.

Table 8–1 Event Severities


Severity	Event Description
ERROR	System Error
ERROR	Comparison Failed
ERROR	Plan/Preflight Failed
ERROR	Step Failed
WARNING	System Warning
WARNING	Difference Found
INFO	System Information
INFO	Component Installed
INFO	Component Uninstalled
INFO	Component Control Service Executed
INFO	Resource Installed
INFO	Resource Uninstalled
INFO	Comparison Canceled
INFO	Comparison Cancellation Requested
INFO	Comparison Completed
INFO	Comparison Started
INFO	Node Started
INFO	Node Stopped
INFO	Preflight Completed
INFO	Plan/Preflight Canceled
INFO	Plan/Preflight Cancellation Requested
INFO	Plan/Preflight Completed
INFO	Plan/Preflight Started
INFO	Custom Event Sent
INFO	Step Completed
INFO	Step Started
INFO	User Logged In
INFO	User Failed to Log In
INFO	User Logged Out