Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRJobAdvancedNotificationOptions

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.

Set-VBRJobAdvancedNotificationOptions Important!

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
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the array of jobs. The cmdlet will modify notification options of these jobs.

True

Named

True (ByValue,
ByProperty
Name)

False

Snmp
Notification

Indicates that the job will send the SNMP notification. You need to have the SNMP notification pre-configured.

False

Named

False

False

Email
Notification

Indicates that the job will send notifications to email address(es). Use the EmailNotificationAddresses to specify the addresses.

False

Named

False

False

Email
Notification
Addresses

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

Get-VBRJob

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation