This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRProtectionGroupNotificationOptions
Short Description
Modifies notification options for protection groups.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRProtectionGroupNotificationOptions -NotificationOptions <VBRProtectionGroupNotificationOptions>[-EnableAdditionalNotification] [-SendTime <timespan>] [-AdditionalAddress <string[]>] [-UseNotificationOptions][-NotificationSubject <string>] [-NotifyOnSuccess] [-NotifyOnWarning] [-NotifyOnError] [<CommonParameters>] |
Detailed Description
This cmdlet modifies notification options for protection groups.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
NotificationOptions | Specifies the notification options that you want to modify. Accepts the VBRProtectionGroupNotificationOptions type. | True | Named | False |
|
EnableAdditional | 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:
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
This example shows how to modify additional notifications for protection groups. Use the $options variable to specify the notification options that you want to modify.
