New-VBRNotificationOptions

Short Description

Creates new job notification options.

Applies to

Platform: VMware, Hyper-V

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

Syntax

New-VBRNotificationOptions [-EnableAdditionalNotification] [-AdditionalAddress <string[]>] [-UseNotificationOptions] [-NotificationSubject <string>] [-NotifyOnSuccess] [-NotifyOnWarning] [-NotifyOnError] [-NotifyOnLastRetryOnly] [-EnableSnmpNotification] [-NotifyWhenWaitingForTape]  [<CommonParameters>]

Detailed Description

This cmdlet creates a VBRNotificationOptions that contains email notification settings for backup or replication jobs. You can use this object later to apply these settings to a job.

New-VBRNotificationOptions 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

EnableAdditionalNotification

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

False

Named

False

False

AdditionalAddress

The email address for notification.

False

Named

False

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

False

NotificationSubject

Specifies the subject of the email notifications.

False

Named

False

False

NotifyOnSuccess

Indicates if the email is sent if the job finished successfully.

False

Named

False

False

NotifyOnWarning

Indicates if the email is sent if the job finished with warning.

False

Named

False

False

NotifyOnError

Indicates if the email is sent if the job finished with error.

False

Named

False

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

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

VBRNotificationOptions

Example

This command creates notification options for the backup job. Veeam Backup & Replication will send notifications about the job warning and when the job completes successfully.

New-VBRNotificationOptions -EnableAdditionalNotification -AdditionalAddress admin@domain.com -UseNotificationOptions -NotifyOnSuccess -NotifyOnWarning