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

Start-VBOSharePointItemRestoreSession

Short Description

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

Applies to: Veeam Backup for Microsoft Office 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets.

  • To explore or restore backups from the specified job:

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

  • To explore or restore backups from the specified restore point:

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

  • To explore or restore 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 a 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 the 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 against the SharePoint server.

False

Named

False

False

Port

Specifies the port number. The cmdlet will use this port to connect to the SharePoint server.

False

Named

False

False

Restore
Point

Specifies a 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 restore session for a backup from the SharePoint job on the local host.

  1. Run Get-Credential to create a credential object. Type Windows credentials to connect 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 that you want to explore or restore during the restore session. Save the result to the $job variable.
  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 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 to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable
  2. Run Get-VBORestorePoint and select the restore point. 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 restore session for backups of the ABC organization:

  1. Run Get-Credential to create a credential object. Type Windows credentials to connect 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

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