Set-VBRNotificationOptions

Short Description

Modifies job notification settings.

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

Syntax

Set-VBRNotificationOptions -NotificationOptions <VBRNotificationOptions> [-EnableAdditionalNotification]

[-AdditionalAddress <String[]>] [-UseNotificationOptions] [-NotificationSubject <String>] [-NotifyOnSuccess]

[-NotifyOnWarning] [-NotifyOnError] [-NotifyOnLastRetryOnly] [-EnableSnmpNotification]

[-NotifyWhenWaitingForTape] [-EnableDailyNotification] [-SendTime <TimeSpan>] [<CommonParameters>]

Detailed Description

This cmdlet modifies notification settings for backup or replication jobs.

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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AdditionalAddress	Specifies the email address for job notifications.	`String[]`	False	Named	False
EnableAdditionalNotification	Enables the email notification option.	`SwitchParameter`	False	Named	False
EnableDailyNotification	Defines that the cmdlet will send email notification daily. Use the `SendTime` parameter to specify the time when the cmdlet must send the email notification.	`SwitchParameter`	False	Named	False
EnableSnmpNotification	Defines that the cmdlet will send the SNMP traps 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.	`SwitchParameter`	False	Named	False
NotificationOptions	Specifies notification settings that you want to modify. Accepts the `VBRNotificationOptions` object. To get this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	True	Named	False
NotificationSubject	Specifies the subject of the email notifications.	`String`	False	Named	False
NotifyOnError	Defines that the cmdlet will send the email when the job finished with an error. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
NotifyOnLastRetryOnly	Defines that the cmdlet will send the email about the final job status. If you do not enable this option, Veeam Backup & Replication will send one notification per every job retry. Default: `True`. Note: This parameter is not available for backup policies that Veeam Agent backup jobs use to back up computers. To disable this parameter, set the value to `$false`. That is, parameter_name:`$false`.	`SwitchParameter`	False	Named	False
NotifyOnSuccess	Defines that the cmdlet will send the email when the job finished successfully. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
NotifyOnWarning	Defines that the cmdlet will send the email when the job finished with a warning. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
NotifyWhenWaitingForTape	Defines that the cmdlet will send the email 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. Veeam Agent backup jobs.	`SwitchParameter`	False	Named	False
SendTime	Specifies the time when the cmdlet must send the email notification.	`TimeSpan`	False	Named	False
UseNotificationOptions	Defines that the cmdlet will use custom or global settings. You can set it to `True` (custom settings) or `False` (global settings). Use the following parameters to set the custom settings: `NotifyOnSuccess` `NotifyOnWarning` `NotifyOnError` `NotifyOnLastRetryOnly`	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRNotificationOptions object that contains job notification options.

Examples

Modifying Notification Settings for Backup Job

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.

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

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

Perform the following steps:

Run the New-VBRNotificationOptions cmdlet. Specify the following settings:
- Provide the EnableAdditionalNofitication parameter.
- Specify the AdditionalAddress parameter value.
- Provide the UseNotificationOptions parameter.
- Provide the NotifyOnSuccess parameter.
- Provide the NotifyOnWarning parameter.
Save the result to the $notifications variable.
Run the Set-VBRNotificationOptions cmdlet. Specify the following settings:
- Set the $notifications variable as the NotificationOptions parameter value.
- Provide the EnableAdditionalNotification parameter.
- Provide the UseNotificationOptions parameter.
- Provide the NotifyOnError parameter.

New-VBRNotificationOptions