Set-VBRJobAdvancedNotificationOptions

In this article

    Short Description

    Customizes job notification settings.

    Applies to

    Platform: VMware, Hyper-V

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

    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!

    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.

    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

    SnmpNotification

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

    False

    Named

    False

    False

    EmailNotification

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

    False

    Named

    False

    False

    EmailNotificationAddresses

    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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    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.

    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.

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

    Related Commands

    Get-VBRJob

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.