This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRSharePointItemRestoreSession

Short Description

Starts restore sessions to explore backed-up Microsoft SharePoint databases and to perform operations with these databases.

Applies to

Veeam Backup & Replication

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Start a restore session from the particular restore point of the Microsoft SharePoint database.

Start-VBRSharePointItemRestoreSession [-RestorePoint] <IVBRApplicationRestorePoint> [-StagingServerName <string>] [-StagingInstanceName <string>] [-StagingServerPort <int>] [-GuestCredential <pscredential>] [-SqlCredential <pscredential>] [-UseWindowsAuthentification]  [<CommonParameters>]

  • Start a restore session from the particular Microsoft SharePoint site collection.

Start-VBRSharePointItemRestoreSession [-SiteCollection] <IVBRSiteCollection> [-StagingServerName <string>] [-StagingInstanceName <string>] [-StagingServerPort <int>] [-GuestCredential <pscredential>] [-SqlCredential <pscredential>] [-UseWindowsAuthentication]  [<CommonParameters>]>]

  • Start a restore session from the restore points of backed-up VMs with Microsoft SQL databases for the specified Microsoft SharePoint site collection.

Start-VBRSharePointItemRestoreSession [-SiteCollectionRestorePoint] <IVBRSiteCollection> [-StagingServerName <string>] [-StagingInstanceName <string>] [-StagingServerPort <int>] [-GuestCredential <pscredential>][-SqlCredential <pscredential>] [-UseWindowsAuthentication]  [<CommonParameters>]

Detailed Description

This cmdlet allows you to start restore sessions and recover Microsoft SharePoint databases. You can run restore sessions with the following scenarios:

  • Restore session of all site collections and Microsoft SharePoint databases from the particular restore point.
  • Restore session of the particular Microsoft SharePoint site collection. In this case, the mount service will mount the database with this site collection to a staging Microsoft SQL Server.
  • Restore session of backed-up VMs with Microsoft SQL databases for the specified Microsoft SharePoint site collection.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies a restore point. The cmdlet will get a Microsoft SharePoint database from the specified restore point.

Accepts the IVBRApplicationRestorePoint object. To get this object, run the Get-VBRApplicationRestorePoint cmdlet.

True

0

True (ByValue)

SiteCollection

Specifies a site collection. The cmdlet will get a Microsoft SharePoint database from the specified site collection.

 

 

Accepts the IVBRSiteCollection object. To get this object, run the Get-VBRSiteCollectioncmdlet.

True

0

True (ByValue)

SiteCollectionRestorePoint

Specifies restore points of backed-up VMs with Microsoft SQL databases for the specified Microsoft SharePoint site collection.

Accepts the IVBRSiteCollection object. To get this object, run the Get-VBRSiteCollectionRestorePoint cmdlet.

True

0

True (ByValue)

StagingInstanceName

Specifies a name of a Microsoft SQL instance. The cmdlet will create the content database within this instance.

String

False

Named

False

StagingServerPort

Specifies a port number. The cmdlet will use this port to connect to the staging Microsoft SQL server.

Int32

False

Named

False

GuestCredential

Specifies user account credentials to connect to the staging Microsoft SQL server. The user account must have Full control permissions.

Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet.

False

Named

False

SqlCredential

Specifies credentials to authenticate against the Microsoft SQL server.

Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet.

False

Named

False

UseWindowsAuthentification

Defines that the cmdlet will use Windows authentication.

SwitchParameter

False

Named

False

StagingServerName

Specifies a name of the staging SQL server. The cmdlet will mount the restore point of the VM with the SharePoint database to the specified server.

String

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBRSharePointRestoreSession object that contains setting of restore sessions started to explore backed-up Microsoft SharePoint databases and to perform operations with these databases.

Examples

Start-VBRSharePointItemRestoreSessionExample 1. Starting Restore Session for All Site Collections

Start-VBRSharePointItemRestoreSessionExample 2. Starting Restore Session from Microsoft SQL Backup

Start-VBRSharePointItemRestoreSessionExample 3. Starting Restore Session for Specific Microsoft SharePoint Site Collection

Start-VBRSharePointItemRestoreSessionExample 4. Starting Restore Session from Specific Restore Point

Start-VBRSharePointItemRestoreSessionExample 5. Starting Restore Session from Microsoft SQL Databases with Microsoft SharePoint Site Collections

Related Commands