New-VBRProtectionGroupNotificationOptions

In this article

    Short Description

    Creates notification options for protection groups.

    Applies to

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    New-VBRProtectionGroupNotificationOptions [-EnableAdditionalNotification] [-SendTime <timespan>] [-AdditionalAddress <string[]>] [-UseNotificationOptions] [-NotificationSubject <string>] [-NotifyOnSuccess][-NotifyOnWarning] [-NotifyOnError]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBRProtectionGroupNotificationOptions object. This object contains new notification options for protection groups.

    New-VBRProtectionGroupNotificationOptions Important!

    Email notification can be configured for the protection groups only in case the global email notifications are enabled. Note that you cannot enable the global email notifications with Veeam PowerShell. To learn more about notification settings, see Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    EnableAdditionalNotification

    Enables custom custom email notifications for the protection group.

    Default: Disabled.

    NOTE: You must specify at least one email address to enable custom email notifications. Use the AdditionalAddress parameter to specify the email address.

    False

    Named

    False

     

    SendTime

    Specifies the time when notifications will be sent.

    False

    Named

    False

     

    AdditionalAddress

    Specifies an array of email addresses. Veeam Backup & Replication will send notifications to this email address.

    False

    Named

    False

     

    UseNotificationOptions

    Enables custom notification setting.

    Use the following parameters to set the custom settings:

    • NotifyOnSuccess
    • NotifyOnWarning
    • NotifyOnError

    Default: Disabled.

    False

    Named

    False

     

    NotificationSubject

    Specifies the subject for the email notifications.

    False

    Named

    False

     

    NotifyOnSuccess

    Indicates that an email will be sent if the job finishes successfully.

    False

    Named

    False

     

    NotifyOnWarning

    Indicates that an email will be sent if the job finishes with warning.

    False

    Named

    False

     

    NotifyOnError

    Indicates that an email will be sent if the job finishes with error.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example

    The example shows how to create notifications options for the protection group. Veeam Backup & Replication will send notifications at 5:00 PM. Save the result to the $options variable to use it when you create a protection group and to get it in case you need to modify notification options.

    $options = New-VBRProtectionGroupNotificationOptions -EnableAdditionalNotification -AdditionalAddress admin@domain.com -SendTime 05:00