Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Start-VBOExchangeItemRestoreSession

Short Description

Starts restore sessions to explore backed-up Microsoft Exchange items and to perform operations with these items.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to.

  • To explore or restore Microsoft Exchange items from the latest restore point:

Start-VBOExchangeItemRestoreSession -LatestState [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

  • To explore or restore Microsoft Exchange items from the specified restore point:

Start-VBOExchangeItemRestoreSession -RestorePoint <IVBORestorePoint> [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

  • To explore or restore Microsoft Exchange items from the latest restore point remotely:

Start-VBOExchangeItemRestoreSession -Server <string> -Credential <pscredential> [-Port <int>] [-SkipCertificateCheck] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

Detailed Description

This cmdlet establishes a connection to the Veeam Backup for Microsoft Office 365 server and retrieves organization mailbox data from backups. You can specify a restore point to view organization mailbox data at the state of this restore point.

During a restore session you can explore backed-up mailbox items using the following cmdlets:

To perform restore operations, use the following cmdlets:

Parameters

Parameter

Description

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

LatestState

Indicates that the cmdlet will retrieve data from a mailbox database at the state of the latest restore point.

True

Named

False

False

RestorePoint

Specifies a restore point to start a new restore session. You will be able to use the session to perform operations with items that this restore point contains.

Accepts the IVBORestorePoint object. To get this object, run the Get-VBORestorePoint cmdlet.

True

Named

True (ByValue)

False

Server

Specifies a DNS name or an IP address of Veeam Backup for Microsoft Office 365 server that backed up items you want to restore.

True

Named

False

False

Credential

Specifies credentials that will be used to authenticate against the Veeam Backup for Microsoft Office 365 server.

True

Named

False

False

Job

Specifies a backup job to start a new restore session. You will be able to use the session to perform operations with items backed up by this job.

Accepts the IVBOJob object. To get this object, run the Get-VBOJob cmdlet.

False

Named

True (ByValue)

False

Organization

Specifies an organization to start a new restore session. You will be able to use the session to perform operations with items backed up for this organization.

Accepts the IVBOOrganization object.  To get this object, run the Get-VBOOrganization cmdlet.

False

Named

True (ByValue)

False

ShowDeleted

Specifies that deleted items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items.

NOTE: With this parameter provided, the amount of data returned by cmdlets within the current session may significantly increase.

False

Named

False

False

ShowAllVersions

Specifies that all versions of SharePoint items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items.

NOTE: With this parameter provided, the amount of data returned by cmdlets within the current session may significantly increase.

False

Named

False

False

Port

Specifies a port number that will be used to connect to the Veeam Backup for Microsoft Office 365 server.

False

Named

False

False

SkipCertificateCheck

Indicates that the cmdlet will not perform the SSL certificate check.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

This example shows how to start a restore session with the following settings:

  • The cmdlet will retrieve data from a mailbox database the state of the latest restore point.
  • The cmdlet will start a restore session only for backups associated with the ABC organization.

You must perform the following steps:

  1. Run the Get-VBOOrganization cmdlet. Save the result to the $organization variable.
  2. Run the Start-VBOExchangeItemRestoreSession cmdlet. Set the $organization variable as the Organization parameter value.

$organization = Get-VBOOrganization -Name "ABC"

Start-VBOExchangeItemRestoreSession -LatestState -Organization $organization

Example 2

This example shows how to start a restore session with the following settings:

  • The cmdlet will retrieve a mailbox database at the state of the selected restore point.
  • The cmdlet will start a restore session only for backups that were created by the Sales Reports backup job.

You must perform the following steps:

  1. Run the Get-VBORestorePoint cmdlet and select a restore point by its creation time. Save the result to the $restorepoint variable.
  2. Run the Get-VBOJob cmdlet to get a backup job associated with backups that you want to explore or restore during the restore session.
  3. Run the Start-VBOExchangeItemRestoreSession cmdlet with the $restorepoint and $job variables.

$restorepoint = Get-VBORestorePoint | Select-Object -Property BackupTime | select -First 2

$job = Get-VBOJob -Name "Sales Reports"

Start-VBOExchangeItemRestoreSession -RestorePoint $restorepoint -Job $job

Example 3

This example shows how to start a remote restore session for a mailbox database at the state of the latest restore point.

  1. Run the Get-Credential cmdlet to create a credential object. Type Windows credentials to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $creds variable
  2. Run the Start-VBOExchangeItemRestoreSession cmdlet with the $creds variable.

$creds = Get-Credential

Start-VBOExchangeItemRestoreSession -Server vbo365server.support.local -Credential $creds

Example 4

This example shows how to perform a restore scenario:

  • Start a remote restore session for a mailbox database at the state of the latest restore point
  • Perform an item restore from an organization mailbox
  • Stop a restore session

You must perform the following steps:

  1. Start the remote restore session for the mailbox database at the state of the latest restore point:
  1. Run the Get-Credential cmdlet to create a credential object with Windows credentials to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $vbosrvcreds variable
  2. Run the Start-VBOExchangeItemRestoreSession cmdlet with the $vbosrvcreds variable.
  1. Perform an item restore:
  1. Get a mailbox that contains an item that you want to restore and save it to the $mailbox variable:
  1. Run the Get-VBOExchangeItemRestoreSession cmdlet to get the restore session. Save the result to the $session variable.
  2. Run the Get-VEXDatabase cmdlet with the $session variable to get the mailbox database. Save the result to the $database variable.
  3. Run the Get-VEXMailbox cmdlet with the $database variable and the Name parameter to get the specific mailbox from the mailbox database. Save the result to the $mailbox variable.
  1. Run the Get-Credential cmdlet to create a credential object with account credentials to connect to the Microsoft Exchange server. Save the result to the $exsrvcreds variable.
  2. Run the Restore-VEXitem cmdlet with the $mailbox and $exsrvcreds variables to restore the mailbox to the Microsoft Exchange server.
  1. Stop the restore session:
  1. Run the Stop-VBOExchangeItemRestoreSession cmdlet. Use the $session variable that you obtained in the Step 1.

$vbosrvcreds = Get-Credential

Start-VBOExchangeItemRestoreSession -Server vbo365server.support.local -Credential $vbosrvcreds

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session

$mailbox = Get-VEXMailbox -Database $database -Name "sales"

$exsrvcreds = Get-Credential

Restore-VEXItem -Mailbox $mailbox -Server outlook.office365.com -Credential $exsrvcreds -RestoreChangedItem

Stop-VBOExchangeItemRestoreSession -Session $session

Related Commands

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation