Set-VBRJobAdvancedNotificationOptions

Short Description

Customizes job notification settings.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBRJobAdvancedNotificationOptions [-EmailNotification <Boolean>] [-EmailNotificationAddresses <string>] -Job <CBackupJob[]> [-SnmpNotification <Boolean>] [<CommonParameters>]

Detailed Description

This cmdlet sets notification options for the selected job.

You can set SNMP and email notifications on job run results.

Set-VBRJobAdvancedNotificationOptions Important!

Veeam Backup & Replication will send email notifications and SNMP notifications only in case these options are set up in the Veeam Backup & Replication general settings. Note that you cannot enable email notifications and SNMP notifications with Veeam PowerShell.

For more information on configuring notification, see the Specifying Email Notification Settings section of the User Guide for VMware vSphere.

For more information on configuring SNMP notifications, see the Specifying SNMP Settings section of the User Guide for VMware vSphere.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies the array of jobs. The cmdlet will modify notification options of these jobs.	Accepts the CBackupJob[] object. To create this object, run the Get-VBRJob cmdlet.	True	Named	True (ByProperty Name, ByValue)
SnmpNotification	Defines whether the job will send the SNMP notification. You need to have the SNMP notification pre-configured.	Bool	False	Named	False
EmailNotification	Defines whether the job will send notifications to email address(es). Use the EmailNotificationAddresses parameter to specify the addresses.	Bool	False	Named	False
EmailNotificationAddresses	Specifies the email address(es) to use for email notification. You can write multiple addresses separated by semicolon.	String	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the CBackupJob[] object that contains an array of modified jobs.

Examples

Set-VBRJobAdvancedNotificationOptions Example 1. Setting SNMP and Email Notifications for Backup Job [Using Pipeline]

This example shows how to set SNMP and email notifications for the backup job named Backup Job 01.

Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedNotificationOptions -SnmpNotification $True -EmailNotification $True -EmailNotificationAddresses "administrator@veeam.com"

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Set-VBRJobAdvancedNotificationOptions cmdlet. Specify the following settings:

Provide the $True value for the SnmpNotification parameter.
Provide the $True value for the EmailNotification parameter.
Specify the EmailNotificationAddresses parameter value.

Set-VBRJobAdvancedNotificationOptions Example 2. Turning off Previously Set Email Notification for Backup Job [Using Pipeline]

This example shows how to turn off the previously set email notification for the backup job named Backup Job 01.

Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedNotificationOptions -EmailNotification $False

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Set-VBRJobAdvancedNotificationOptions cmdlet. Provide the $False value for the EmailNotification parameter.

Related Commands

Get-VBRJob