Set-VBRNotificationOptions

In this article

    Short Description

    Modifies job notification settings.

    Applies to

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

    Syntax

    Set-VBRNotificationOptions -NotificationOptions <VBRNotificationOptions> [-EnableAdditionalNotification][-AdditionalAddress <string[]>]
    [-seNotificationOptions] [-NotificationSubject <string>] [-NotifyOnSuccess][-NotifyOnWarning] [-NotifyOnError] [-NotifyOnLastRetryOnly]
    [-EnableSnmpNotification] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies notification settings for backup or replication jobs. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    NotificationOptions

    Specifies notification settings that you want to modify.

    Accepts the VBRNotificationOptions type.

    True

    Named

    False

     

    EnableAdditionalNotification

    Indicates that the email notification is enabled (true) or disabled (false).

    False

    Named

    False

     

    AdditionalAddress

    Specifies the email address for job notifications.

    False

    Named

    False

     

    UseNotificationOptions

    Indicates that the notifications must use custom settings (true) or global settings (false).

    Use the following parameters to set the custom settings:

    • NotifyOnSuccess
    • NotifyOnWarning
    • NotifyOnError
    • NotifyOnLastRetryOnly

    False

    Named

    False

     

    NotificationSubject

    Specifies the subject of the email notifications.

    False

    Named

    False

     

    NotifyOnSuccess

    Indicates that the email is sent when the job finished successfully.

    False

    Named

    False

     

    NotifyOnWarning

    Indicates that the email is sent when the job finished with a warning.

    False

    Named

    False

     

    NotifyOnError

    Indicates that the email is sent when the job finished with an error.

    False

    Named

    False

     

    NotifyOnLastRetryOnly

    Indicates that the email is sent about the final job status. If you do not enable this option, Veeam Backup & Replication will send one notification per every job retry.

    NOTE: This parameter is not available for backup policies that Veeam Agent backup jobs use to back up computers.

    False

    Named

    False

     

    EnableSnmpNotification

    Indicates that SNMP traps will be sent when the job completes successfully.

    NOTE: This parameter is not available for the following types of jobs:

    • Backup policies that Veeam Agent backup jobs use to back up computers.
    • Veeam Agent backup jobs.

    False

    Named

    False

     

    NotifyWhenWaitingForTape

    Indicates that the email is sent if the tape job cannot start because there are no available tapes.

    NOTE: This parameter is not available for the following types of jobs:

    • Backup policies that Veeam Agent backup jobs use to back up computers.
    • Veaam Agent backup jobs.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    Example

    This example shows how to modify notification settings for the backup job. Veeam Backup & Replication will send a notification when the backup job completes with the error, warning or when it completes successfully.

    1. Run New-VBRNotificationOptions to specify notification settings. Save the result to the $notifications variable.
    2. Run Set-VBRNotificationOptions with the $notifications variable.

    $notifications = New-VBRNotificationOptions -EnableAdditionalNotification -AdditionalAddress "admin@domain.com" -UseNotificationOptions -NotifyOnSuccess -NotifyOnWarning

    Set-VBRNotificationOptions -NotificationOptions $notifications -EnableAdditionalNotification -UseNotificationOptions -NotifyOnError

    Related Commands

    New-VBRNotificationOptions