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

Understanding Veeam Backup for Microsoft Office 365 Cmdlets

Veeam cmdlets are developed to behave like other Microsoft Windows cmdlets. Each cmdlet is a simple single-function command that is a specialized .NET class implementing specific actions. Most of the cmdlets have parameters that pass additional data to the command. The cmdlets and their parameters are named after the Microsoft naming conditions.

Working with Veeam Backup for Microsoft Office 365 PowerShell cmdlets and scripts in many respects depends on your imagination, skills and expertise in Windows PowerShell. To learn more about Windows PowerShell and its basics, use the book by Dr. Tobias Weltner: Microsoft Master-PowerShell.

Input and Output

As an input, the cmdlets expect objects, and they output objects. The objects mostly represent instances of the backup infrastructure: jobs, job schedule settings, backup exclusions and so on. The objects can be part of a pipeline.

You can use the cmdlet help to understand what kind of input is needed. The cmdlets have syntax that shows whole sets of parameters available in the cmdlet and what each parameter expects as input. For example, Add-VBOJob has the following syntax:

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

 

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

That means:

  • To create a backup job, you need to specify an Exchange organization whose mailboxes will be processed, the repository where mailbox backups will be stored, specify name, description and schedule for this backup job.
  • The cmdlet has two parameter sets per different job settings: you can instruct a backup job to process all mailboxes or only the selected ones. Use an appropriate parameter set for each case.
Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference