This is an archive version of the document. To get the most up-to-date information, see the current version.New-VBRNotificationOptions
Short Description
Creates a new VBRNotificationOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRNotificationOptions [-EnableAdditionalNotification] [-AdditionalAddress <string[]>] [-UseNotificationOptions] [-NotificationSubject <string>] [-NotifyOnSuccess] [-NotifyOnWarning] [-NotifyOnError] [-NotifyOnLastRetryOnly] [<CommonParameters>] |
Related Commands
None
Return Type
Detailed Description
This cmdlet creates a new VBRNotificationOptions object. This object contains custom email notification settings and is used further to apply these settings to an existing job.
|
Email notification can be configured for jobs only in case that the global email notifications are enabled. Note that you cannot enable the global email notifications with Veeam PowerShell. Read more about job notification settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Enable | Indicates if the email notification is enabled (true) or disabled (false). | False | Named | False | False |
Additional | The email address for notification. | False | Named | False | False |
UseNotification | Indicates that the notifications must use custom settings (true) or global settings (false). Use the NotifyOnSuccess, NotifyOnWarning, NotifyOnError and NotifyOnLastRetryOnly parameters to set the custom settings. | False | Named | False | False |
Notification | The subject that must be used for creating the notification email. | False | Named | False | False |
NotifyOn | Indicates if the email is sent if the job finished successfully. | False | Named | False | False |
NotifyOn | Indicates if the email is sent if the job finished with warning. | False | Named | False | False |
NotifyOnError | Indicates if the email is sent if the job finished with error. | False | Named | False | False |
NotifyOn | Indicates if the email is sent if the last retry of the job started. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
