Start-VBOSharePointItemRestoreSession - Veeam Backup for Microsoft Office 365 PowerShell Reference
Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Start-VBOSharePointItemRestoreSession

Short Description

Starts restore sessions for exploring backed up items and performing restore operations.

Syntax

This cmdlet provides 3 parameter sets.

  • For exploring or restoring backups from the specified job:

Start-VBOSharePointItemRestoreSession [-Job] <IVBOJob> [-Server <string>] [-Credential <pscredential>] [-Port <int>]  [<CommonParameters>]

  • For exploring or restoring backups from the specified restore point:

Start-VBOSharePointItemRestoreSession [-RestorePoint] <IVBORestorePoint> [-Server <string>] [-Credential <pscredential>] [-Port <int>]  [<CommonParameters>]

  • For exploring or restoring backups of the specified organization:

Start-VBOSharePointItemRestoreSession [-Organization] <IVBOOrganization> [-Server <string>] [-Credential <pscredential>] [-Port <int>]  [<CommonParameters>]

Detailed Description

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

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

To perform operations with the selected items, use the following cmdlets:

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the backup job. The cmdlet will start a restore session for backups created by the specified job.

True

0

True (ByValue)

False

Server

Specifies the Veeam Backup for Microsoft Office 365 server to which you want to connect.

False

Named

False

False

Organization

Specifies OneDrive organization. The cmdlet will start a restore session for backups associated with the specified organization.

True

0

True (ByValue)

False

Credential

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

False

Named

False

False

Port

Specifies the port for connecting with SharePoint server.

False

Named

False

False

Restore
Point

Specifies the restore point. The cmdlet will retrieve data from the database at the state of the specified restore point.

True

0

True (ByValue)

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 start a Veeam Explorer for Microsoft SharePoint restore session for a backup from the job "SharePoint" on the local host:

  1. Run Get-Credential to create a credential object. Type Windows credentials for connecting to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable
  2. Run Get-VBOJob to get the backup job associated with the backups you want to explore or restore during the restore session.
  3. Run Start-VBOSharePointItemRestoreSession with the $credentials and $job variables.

PS C:\PS> $credentials = Get-Credential

PS C:\PS> $job = Get-VBOJob -Name SharePoint

PS C:\PS> Start-VBOSharePointItemRestoreSession -Job $job -Server localhost -Credentials $credentials -Port 9194

Example 2

This example shows how to start a Veeam Explorer for Microsoft SharePoint restore session for a backup in a specific restore point on the local host:

  1. Run Get-Credential to create a credential object. Type Windows credentials for connecting to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable
  2. Run Get-VBORestorePoint and select the needed restore point by its creation time. Save the result to the $restorepoint variable.
  3. Run Start-VBOSharePointItemRestoreSession with the $credentials and $restorepoint variables.

PS C:\PS> $credentials = Get-Credential

PS C:\PS> $restorepoint = Get-VBORestorePoint

PS C:\PS> Start-VBOSharePointItemRestoreSession -ResotorePoint $restorepoint -Server localhost -Credentials $credentials -Port 9194

Example 3

This example shows how to start a Veeam Explorer for Microsoft SharePoint restore session for backups of "ABC" organization:

  1. Run Get-Credential to create a credential object. Type Windows credentials for connecting to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable
  2. Run Get-VBOOrganization to get the organization whose backups you want to explore or restore during the restore session. Save the result to the $organization variable.
  3. Run Start-VBOSharePointItemRestoreSession with the $organization and $credentials variable.

PS C:\PS> $credentials = Get-Credential

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

PS C:\PS> Start-VBOSharePointItemRestoreSession -Organization $org -Server localhost -Credentials $credentials -Port 9194

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference