Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
PowerShell Reference

Set-VBOEmailSettings

Short Description

Modifies e-mail notification settings.

Syntax

Set-VBOEmailSettings [-EnableNotification] [-SMTPServer <string>] [-Port <int>] [-UseAuthentication] [-UseSSL] [-Credential <pscredential>] [-From <string>] [-To <string>] [-Subject <string>] [-NotifyOnSuccess] [-NotifyOnWarning] [-NotifyOnFailure] [-SupressUntilLastRetry]  [<CommonParameters>]

Detailed Description

This cmdlet modifies e-mail notification settings for Veeam Backup for Microsoft Office 365.

To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Set-VBOEmailSettings Note:

E-mail notification settings are global, they will be applied to all backup jobs configured in Veeam Backup for Microsoft Office 365.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Enable
Notification

Indicates that Veeam Backup for Microsoft Office 365 will send e-mail notifications on the job run results.

False

Named

False

False

SMTPServer

Specifies the full DNS name or IP address of the SMTP server for sending e-mail notifications.

False

Named

False

False

Port

Specifies the port for connecting to SMTP server.

False

Named

False

False

Use
Authentication

Indicates that SMTP server requires authentication. Otherwise, the connection will be established to SMTP server, which does not enforce authentication.

False

Named

False

False

UseSSL

If set, enables a secure connection for e-mail notification transmission. Otherwise, e-mail notifications will be transmitted through the connection that does not require SSL authentication.

False

Named

False

False

Credential

Specifies the credentials you want to use for authenticating with SMTP server.

False

Named

False

False

From

Specifies notification sender e-mail address with the rights to connect to SMTP server.

False

Named

False

False

To

Specifies notification recipient e-mail address. Semicolon is used for listing multiple recipients.

False

Named

False

False

Subject

Specifies the subject for creating the notification e-mail. You can use the following system variables:

  • %JobName% - backup job name
  • %JobResult% - backup job result
  • %OrgName% - Exchange organization, whose mailboxes were processed by the backup job
  • %MailboxCount% - total number of processed mailboxes
  • %Issues% - number of mailboxes processed with Failed or Warning status
  • %Time% - date and time of the backup job completion

False

Named

False

False

NotifyOn
Success

Indicates that Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes successfully.

False

Named

False

False

NotifyOn
Warning

Indicates that Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes with warning.

False

Named

False

False

NotifyOn
Failure

Indicates that Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes with error.

False

Named

False

False

SupressUntil
LastRetry

Indicates that Veeam Backup for Microsoft Office 365 will send the notification per the job schedule settings. The following e-mail notification scenarios are possible:

  • if the job fails, Veeam Backup for Microsoft Office 365 will send the notification on the last job retry
  • if the job completes with Success or Warning, Veeam Backup for Microsoft Office 365 will send the notification on the last completion status
  • if the job is scheduled to Terminate job if it exceeds allowed backup window, Veeam Backup for Microsoft Office 365 will send the notification on the last attempt within the allowed backup window

For more information on job schedule settings, see New-VBOJobSchedulePolicy.

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

This example shows how to set e-mail notifications with the following settings:

  • E-mail notifications will be sent to several recipients if the job finishes with error.
  • The body of the subject in e-mail notifications will contain system variables.

PS C:\PS> Set-VBOEmailSettings -EnableNotification -From vbo@tech.com -To "helpdesk@tech.com; support@tech.com" -Subject "[%JobResult%] %Time% %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues" -NotifyOnFailure

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference