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

Add-VBOJob

Short Description

Creates a backup job.

Syntax

This cmdlet provides 2 parameter sets.

  • For creating a job that will back up all mailboxes of Exchange organization:

Add-VBOJob -Organization <VBOOrganization> -Name <string> -Repository <VBORepository> [-Description <string>] [-AllMailboxes] [-ExcludedMailboxes <VBOOrganizationMailbox[]>] [-RunJob] [-SchedulePolicy <VBOJobSchedulePolicy>]  [<CommonParameters>]

  • For creating a backup job that will back up only the selected mailboxes of Exchange organization:

Add-VBOJob -Organization <VBOOrganization> -Name <string> -SelectedMailboxes <VBOOrganizationMailbox[]> -Repository <VBORepository> [-Description <string>] [-RunJob] [-SchedulePolicy <VBOJobSchedulePolicy>] [<CommonParameters>]

Detailed Description

This cmdlet creates a backup job that will back up Exchange organization mailboxes.

Add-VBOJob Note:

Before creating a backup job, make sure you are familiar with the following restrictions:

  • Only one job can back up all mailboxes of Exchange organization
  • Several jobs cannot back up same mailboxes

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Organization

Specifies Exchange organization. The backup job will back up the mailboxes of this organization.

True

Named

True (ByValue)

False

Name

Specifies the name you want to use for the backup job.

True

Named

False

False

Repository

Specifies the backup repository. Veeam Backup for Microsoft Office 365 will store mailbox backups in this repository.

True

Named

False

False

Description

Specifies the description of the backup job.

False

Named

False

False

AllMailboxes

Indicates that the backup job will back up all mailboxes of Exchange organization.

False

Named

False

False

Excluded
Mailboxes

Specifies mailboxes that the backup job will not back up.

If you configured your backup job to back up all Exchange organization mailboxes, the cmdlet will exclude these mailboxes from processing.

False

Named

False

False

Selected
Mailboxes

Specifies mailboxes that the backup job will back up.

True

Named

False

False

RunJob

Indicates that the backup job will run right after its creation. Otherwise, the backup job will be created with Stopped status.

False

Named

False

False

SchedulePolicy

Specifies the backup job schedule settings.

For more information on how to create the backup 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 1

This example shows how to create a backup job that will back up all mailboxes of Exchange organization.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get Exchange organization. Save the result to the $org variable.
  2. Run Get-VBORepository to specify the backup repository. Save the result to the $repository variable.
  3. Run Add-VBOJob with the $org and $repository variables. Use RunJob parameter to start the backup job after its creation.

PS C:\PS> $org = Get-VBOOrganization -Name "ABC Company"

PS C:\PS> $repository = Get-VBORepository -Name "ABC Backup Files"

PS C:\PS> Add-VBOJob -Name "ABC Backup" -Organization $org -Repository $repository -AllMailboxes -RunJob

Example 2

This example shows how to create a job that will back up selected mailboxes of Exchange organization.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get Exchange organization. Save the result to the $org variable.
  2. Run Get-VBORepository to specify the backup repository. Save the result to the $repository variable.
  3. Run Get-VBOOrganizationMailbox to select the mailboxes for the backup job. Save each mailbox to a separate variable: $box1, $box2, etc.
  4. Run Add-VBOJob with the $org, $repository, $box1 and $box2 variables.

PS C:\PS> $org = Get-VBOOrganization -Name "ABC Company"

PS C:\PS> $repository = Get-VBORepository -Name "ABC Backup Files"

PS C:\PS> $box1 = Get-VBOOrganizationMailbox -Organization $org -Name "Tech Support"

PS C:\PS> $box2 = Get-VBOOrganizationMailbox -Organization $org -Name "QA"

PS C:\PS> Add-VBOJob -Name "ABC Backup" -Organization $org -Repository $repository -SelectedMailboxes $box1, $box2 -RunJob

Related Commands

Get-VBOOrganization

Get-VBORepository

Get-VBOOrganizationMailbox

New-VBOJobSchedulePolicy

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference