Quest has been named as an ASP "Ten Best Web Support Sites" award winner. Learn more.

Rapid Recovery 6.0.2 - User Guide

*** Legend Introduction to Dell Data Protection | Rapid Recovery Understanding the Rapid Recovery Core Console Working with repositories Managing Rapid Recovery Core settings Using custom groups Working with encryption keys Protecting machines using the Rapid Recovery Core Working with Microsoft Exchange and SQL Servers Protecting server clusters Exporting protected data to virtual machines Managing protected machines Understanding replication Managing events Generating and viewing reports Restoring data Understanding bare metal restore for Windows machines Retention and archiving Managing cloud accounts Working with Linux machines Understanding the Local Mount Utility Central Management Console Understanding the Rapid Recovery Command Line Management utility Understanding the Rapid Recovery PowerShell module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets Localization Qualifiers
Extending Rapid Recovery jobs using scripting Rapid Recovery APIs Glossary

Configuring an email server

Complete the steps in this procedure to configure an email server.

Note: You must also configure notification group settings, including enabling the Notify by email option, before email alert messages are sent by the system. For more information on specifying events to receive email alerts, see Configuring notification groups.
  1. Navigate to the Rapid Recovery Core Console.
  2. On the icon bar, click [Settings] (Settings), and then do one of the following:
    • From the list of Core settings on the left side of the Settings page, click SMTP Server.
    • Scroll down on the right side of the Settings page until you can see the SMTP Server heading.

    The SMTP Server core settings appear.

  3. Click on the setting you want to change.
    The setting you selected becomes editable.
  4. Enter the configuration information as described in the following table.
    Option Description
    SMTP Server Enter the name of the email server to be used by the email notification template. The naming convention includes the host name, domain, and suffix; for example, smtp.gmail.com.
    From Enter a return email address. It is used to specify the return email address for the email notification template; for example, noreply@localhost.com.
    User name Enter a user name for the email server.
    Password Enter the password associated with the user name required to access the email server.
    Port Enter a port number. It is used to identify the port for the email server; for example, the port 587 for Gmail.

    The default is 25.

    Timeout (seconds) Enter an integer value to specify how long to try to connect to the email server. It is used to establish the time in seconds before a timeout occurs.

    The default is 60 seconds.

    TLS Select this option if the mail server uses a secure connection such as Transport Layer Security (TLS) or Secure Sockets Layer (SSL).
  5. For each setting, when satisfied with your changes, click [Check mark] to save the change and exit edit mode, or click [Cancel] to exit edit mode without saving.
    CAUTION:
    If you do not confirm each change, your settings will not change.
  6. Click Send Test Email and then do the following:
    1. In the Send Test Email dialog box, enter a destination email address for the test message and then click Send.
    2. If the test message fails, exit the error dialog box and the Send Test Email dialog box, and revise your email server configuration settings. Then send the test message again.
    3. Once the test message is successful, click OK to confirm the successful operation.
    4. Check the email account to which you sent the test email message.

Was this topic helpful?

[Select Rating]



Configuring an email notification template

When you enable notifications of Rapid Recovery events by email, a default template is created for you by default. The SMTP email server defined for the Core uses this template to send notifications regarding Rapid Recovery events by email.

This topic describes the process of configuring the default email notification template or customizing the content. Using the Restore Default option, you can restore changes to the default notification template at any time.

CAUTION:
Modify the template at your own risk. You are responsible for testing any modifications to the template. Only the default template is supported.

Complete the steps in this procedure to configure an email notification template.

Note: You must also configure an email server and notification group settings, including enabling the Notify by email option, before email alert messages are sent. For more information about configuring an email server for sending alerts, see Configuring an email server. For more information on specifying events to receive email alerts, see Configuring notification groups.
  1. Navigate to the Rapid Recovery Core Console.
  2. On the icon bar, click [More] (More), and then select [Notifications] Notifications.

    The Notifications page appears.

  3. In the Email Settings pane, click [Change} Change.

    The Edit Email Notification Configuration dialog box appears.

  4. Select Enable Email Notifications.
    The email template is enabled and is visible. The values of the default email template are described in the following step.
  5. Review the contents in the Edit Email Notification Configuration dialog box and determine if the default content suits your needs.
    Option Description
    Enable email notifications

    This setting enables or disables the email notification template.

    • To enable email notification, select this option.
    • To disable email notification, clear this option.
    Email Subject

    The contents of this text field control the subject line for email messages sent as notifications of system events. The default email subject line is as follows:

    <hostName> <level>: <name> for <agentName>
    Email

    The contents of this text area control the body for email messages sent as notifications of system events. The default email body message is as follows:

    <shortCompanyName> <coreProductName> on <hostName> has reported the <level> event "<name>"
    
    Date/Time: <localTimestamp>
    
    <message>
    
    <if(details.errorDetails)>
    <details.ErrorDetails.Message>
    
    <details.ErrorDetails.Details>
    <endif>
    ---
    
    About this event: <description>
    
    <coreAdminUrl>
    Send Test Email Clicking this button sends a test email message to the email address you specify in the resulting Send Test Email dialog box.
    Restore Defaults Clicking this button removes any customized changes from the email template, and restores the Email Subject and Email fields with the default contents described in this table.
    OK Clicking this button confirms and saves the settings in the Edit Email Notification Configuration dialog box.
    Cancel Clicking this button cancels any changes in the Edit Email Notification Configuration dialog box.
  6. If you want to customize the email template, make changes to the text or variables described in the preceding step. The variables used in the default are described in the following table.
    Option Description
    hostName The host name of the Core
    details The details object of the specific event.
    agentName The name of the protected machine associated with this event, if the event has a scope of a single protected machine.
    repositoryName The name of the repository associated with this event, if the event has repository scope.
    jobSummary The summary of the job associated with this event, if the event has job scope.
    remoteSlaveCoreName The name of the remote target core associated with this event, if the event has target core scope.
    remoteMasterCoreName The name of the remote source core associated with this event, if the event has source core scope.
    productName The name of the product, for example 'AppAssure Core' or 'Rapid Recovery Core.' This product name can be changed for branding using white labeling.
    companyName The name of the company selling the product.
  7. In the Email Subject text box, enter a subject for the email template.

    The Email Subject is used to define the subject of the email notification template, for example, <hostname> - <level> <name>.

  8. In the Email text box, enter the information for the body of the template which describes the event, when it occurred, and the severity.
  9. Click Send Test Email , and then do the following:
    1. In the Send Test Email dialog box, enter a destination email address for the test message and then click Send.
    2. If the test message fails, exit the error dialog box and the Send Test Email dialog box, click OK to save the current email template settings. Then modify your email server settings as described in the procedure Configuring an email server. Ensure that you reenter the password for that email account. Save those settings and then return to this procedure.
    3. Once the test message is successful, click OK to confirm the successful operation.
    4. Check the email account to which you sent the test email message.

Once you are satisfied with the results of your tests, return to the Edit Email Notification Configuration dialog box, and click OK to close the dialog box and save your settings.


Was this topic helpful?

[Select Rating]



Configuring notification groups

Note: You must also configure Simple Mail Transfer Protocol (SMTP) server settings if you want to send alerts as email messages, as described in this procedure. For more information on setting email server configuration settings, see Configuring an email server.
Notification groups let you define sets of specific events for which users are alerted, and the manner in which that notification takes place. You can configure alerts to be sent by the following methods:
  • By email
  • In the Windows event log
  • Using syslogd
  • Using toast alerts
  • Using alerts
  • Using SNMP trap

You can configure more than one notification group with different notification parameters.

Notification groups can be set at the Core level, or for each specific protected machine.

Complete the steps in this procedure to configure notification groups for alerts.

  1. Do one of the following:
    • To set notifications at the Core level, from the icon bar, click [More] (More), and then select Notifications.

      The Notifications page appears.

    • To set notifications for a specific protected machine, do the following:
      1. From the Protected Machines menu, click the machine for which you want to specify notifications.

        The Custom Notification Groups page appears.

      2. In the Summary page of the protected machine, from the More drop-down menu, select Notifications.

      The Custom Notification Groups page appears.

  2. Click [Add] Add Group

    The Add Notification Group dialog box appears.

    Notification groups let you define sets of specific events for which users are alerted, and the manner in which that notification takes place. You can configure alerts to be sent by the following methods:

    The Add Notification Group dialog box contains a general description area and two tabs:

    • Enable Alerts
    • Notification Options
  3. In the general description area, enter the basic information for the notification group, as described in the following table.
    Option Description
    Name Enter a name for the event notification group. This information is required.
    CAUTION:
    The value you enter for the notification group name cannot be changed later.
    Description Enter a description that clarifies the purpose for the event notification group. This information is optional.
  4. On the Enable Alerts tab, define the set of system events that you want to log, create reports for, and for which you want to be alerted, as follows:
    Option Description
    All Alerts To create alerts for all events, select All Alerts.
    Errors To create alerts for errors, from the Select Types menu, click Error. This is represented by a red X. [Error icon]
    Warning To create alerts for errors, from the Select Types menu, click Warning. This is represented by a yellow exclamation point icon. [Error icon]
    Info To create alerts for informational messages, from the Select Types menu, click Info. This is represented by a blue i. [Info icon]
    Restore Default To restore alert types to the default, from the Select Types menu, click Restore Default. This is represented by a dark blue left-facing arrow. [Restore default icon]
  5. To create alerts for a specific event type (error, warning, or informational message), do the following:
    1. If the All Alerts option does not display alert groups, click the right angle bracket > symbol preceding the All Alerts label. The symbol changes to a downward-facing arrow, and the view expands to show groups.
    2. Then click the right angle bracket > symbol next to any specific alert group to display related events in the group.
      The event group categories include:
    • Archive
    • Auto Report
    • Attachability
    • Auto Update
    • Back Up Repository
    • Boot CD
    • Clouds
    • Clusters
    • Core Service
    • Database Retention
    • Dedupe Cache
    • DVM Repository
    • Exchange
    • Export
    • Jobs
    • Licensing
    • Local Mount
    • Log Truncation
    • Metadata
    • Nightly Jobs
    • Notification
    • Persist Core State
    • PowerShell Scripting
    • Protection
    • Push Install
    • Recovery Point Check
    • Remote Mount
    • Repository Common
    • Replication
    • Restore
    • Rollup
    • Scheduled Archives
    • Security
    • Server Logs
    • vSphere
    • To define alerts for all events in every group, select the checkbox for All Alerts.
    • To define alerts for all events within any alert group, select the checkbox next to that group.
    • To select only some alert types within an alert group, expand the group and then select only those specific events for which you want to log, report, and set alerts.
  6. Click the Notification Options tab.
  7. On the Notification Options tab, specify how to handle the notification process.
    Option Description
    Notify by email Designate the recipients of the email notification. You can choose to specify separate multiple email addresses as well as blind and carbon copies.

    You can choose:

    • To:
    • CC:
    • BCC:
    Notify by Windows Event Log Select this option if you want alerts to be reported through the Windows Event Log.
    Notify by syslogd Select this option if you want alerts to be reported through syslogd. Specify the details for the syslogd in the following text boxes:
    • Host:
    • Port:
    Notify by Toast alerts Select this option if you want the alert to appear as a pop-up in the lower-right corner of your screen.
    Notify by Alerts Select this option if you want alerts to appear as pop-up windows located at the bottom right side of the Core Console.
    Notify by SNMP trap The Rapid Recovery Core serves as an SNMP agent, sending traps (notifications about specific events) to an SNMP manager. The result is the reporting of Core information such as alerts, repository status, and protected machines. Select this option if you want to notify Core events by SNMP trap. You must also specify a trap number. For example, the default trap number used by the Rapid Recovery Core is 162.
  8. Click OK.
    You will see a message indicating that the notification group name you defined cannot be changed after creating the group. Other properties within the notification group can be changed at any time.
    • If you are satisfied with the group name, confirm this message and save your work.
    • If you want to change the group name, click No to return to the Create Notification Group window, update the group name and any other notification group settings, and save your work.
    The notification group appears in the summary table. You can create different notification groups using any set of parameters.

Was this topic helpful?

[Select Rating]



About configuring repetition reduction

The ability for administrators to receive alerts upon certain events is critical. Nonetheless, in certain circumstances, receiving repeated notification of events that you are aware of can also be frustrating or inconvenient. Even if an alert is generated due to an environmental failure that you wish to know about immediately, it is possible for the same error condition to generate hundreds or thousands of events in the event log. To reduce repetition in the event log, and reduce the inconvenience of receiving repeated e-mail notifications for the same event in the Core Console, Rapid Recovery includes a repetition reduction setting, which is enabled by default and set at 5 minutes. This setting can be set as low as 1 minute and as high as 60 minutes. It can also be disabled entirely.

When repetition reduction is disabled, then every time an event of the same type and scope occurs, it is logged in the database. Regardless of how much time passed since that event previously occurred, each new occurrence is shown in the Alerts portion of the Events tab.

When repetition reduction is enabled (for example, with the default time of 5 minutes), then the first time that specific event occurs, it is logged in the events database and shown in the alerts log. If subsequently an event of the same type and scope is again logged within the threshold of time established, then the count for the event in the database increases by 1 for each repeat occurrence within that threshold. The log shows in the Alerts portion of the Events page. However, it displays the event only once, with the date and time of the most recent occurrence. The events log is not updated with the same event until the threshold of time from the first occurrence expires. For example, if set for 5 minutes and the event occurs again 6 minutes later, it appears in the log and you receive another email message.


Was this topic helpful?

[Select Rating]



Related Documents