Short Description
Customizes job notification settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobAdvancedNotificationOptions -Job <CBackupJob[]> [-SnmpNotification <bool>] [-EmailNotificationAddresses <string>] [-EmailNotification <bool>] [<CommonParameters>] |
Detailed Description
This cmdlet sets notification options for the selected job.
You can set SNMP and email notifications on job run results.
|
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. |
To modify settings enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Job | Specifies the array of jobs. The cmdlet will modify notification options of these jobs. | True | Named | True (ByValue, | False |
Snmp | Indicates that the job will send the SNMP notification. You need to have the SNMP notification pre-configured. | False | Named | False | False |
Email | Indicates that the job will send notifications to email address(es). Use the EmailNotificationAddresses to specify the addresses. | False | Named | False | False |
Email | Specifies the email address(es) to use for email notification. You can write multiple addresses separated by semicolon. | 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.
Example 1
This command sets SNMP and email notifications for the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedNotificationOptions -SnmpNotification $True -EmailNotification $True -EmailNotificationAddresses "administrator@veeam.com" |
Example 2
This command turns off the previously set email notification for the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedNotificationOptions -EmailNotification $False |
Related Commands
