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

Getting Started

Veeam Backup for Microsoft Office 365 solution includes two applications: Veeam Backup for Microsoft Office 365 for creating data backups and Veeam Explorer for Microsoft Exchange for performing recovery operations.

Each application comes with a PowerShell module:

  • Veeam.Archiver.PowerShell for Veeam Backup for Microsoft Office 365
  • Veeam.Exchange.PowerShell for Veeam Explorer for Microsoft Exchange

These modules include sets of related PowerShell cmdlets that allow you to do all operations available in user interface. Modules are installed by default as part of Veeam Backup for Microsoft Office 365 console and Veeam Explorer for Microsoft Exchange respectively.

Mind that actions performed with PowerShell have the same force as actions performed in user interface. For example, if you delete a job with a PowerShell script, the job will be removed from the Veeam Backup for Microsoft Office 365 database. You will not be able to undo changes.

Requirements

Supports Windows PowerShell version 2.0 or later.

Getting Started Note:

We recommend that you use Windows PowerShell version 4.0 as it is more reliable for performing actions with Veeam Backup for Microsoft Office 365 PowerShell cmdlets.

Starting Veeam Backup for Microsoft Office 365 PowerShell Sessions

You can run Veeam Backup for Microsoft Office 365 PowerShell sessions locally or from a remote machine. Mind that the remote machine must have the Veeam Backup for Microsoft Office 365 console installed.

You can open the PowerShell console in Veeam Backup for Microsoft Office 365 or in Microsoft Windows.

Veeam Backup for Microsoft Office 365

To open the PowerShell console in Veeam Backup for Microsoft Office 365, select PowerShell in the main menu. In this case, you will be able to run PowerShell sessions and perform actions with Veeam Backup for Microsoft Office 365 cmdlets without importing modules into active memory. Veeam Backup for Microsoft Office 365 does it automatically.

Microsoft Windows

If you have Windows PowerShell version 2.0, you must first import Veeam Backup for Microsoft Office 365 PowerShell modules into active memory to access these modules in your PowerShell session. To start the session, you will need to perform the following steps:

  1. Import the Veeam.Archiver.PowerShell module to get access to Veeam Backup for Microsoft Office 365 cmdlets. Run the following command:

PS C:\PS> Import-Module Veeam.Archiver.PowerShell

  1. Import the Veeam.Exchange.PowerShell module to get access to Veeam Explorer for Microsoft Exchange cmdlets. Run the following command:

PS C:\PS> Import-Module Veeam.Exchange.PowerShell

 

Getting Started Note:

If you have Windows PowerShell version 3.0 or later, modules with PowerShell cmdlets will be imported automatically right after you type any Veeam Backup for Microsoft Office 365 PowerShell cmdlet in Windows PowerShell command line.

  1. Connect to a local or remote Veeam Backup for Microsoft Office 365 server. See Connecting to Veeam Backup for Microsoft Office 365 Server.

In This Section

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference