Short Description
Creates new job notification options.
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>] |
Detailed Description
This cmdlet creates an object containing email notification settings for backup or replication jobs. You can use this object later to apply these settings to a 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. For more information about job notification settings, see the Notification Settings section of the User Guide for VMware vSphere. |
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 that the email is sent when the job finishes successfully. | False | Named | False | False |
NotifyOn | Indicates that the email is sent when the job finishes with warning. | False | Named | False | False |
NotifyOnError | Indicates that the email is sent when the job finishes with error. | False | Named | False | False |
NotifyOn | Indicates that the email is sent when the last retry of the job starts. | 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.
Return Type
Example
The example shows how to create notification options for the backup job. Veeam Backup & Replication will send notifications if the job finishes with warning or completes successfully.
PS C:\PS> New-VBRNotificationOptions -EnableAdditionalNotification -AdditionalAddress admin@domain.com -UseNotificationOptions -NotifyOnSuccess -NotifyOnWarning |
