Veeam Backup & Replication 9.5 Update 4 [Archived]
Veeam Explorers PowerShell Reference
Related documents
Search
This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRSharePointItemRestoreSession

In this article

    Short Description

    Starts restore sessions for Microsoft SharePoint.

    Applies to: Veeam Backup & Replication

    Product Edition: Community, Standard, Enterprise, Enterprise Plus

    Syntax

    This cmdlet provides parameter sets that allow you to.

    • 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>]

    • To 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>] [-UseWindowsAuthentification]  [<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.

    Start-VBRSharePointItemRestoreSession Important!

    You can use this cmdlet with the SiteCollection parameter to restore the particular site collection only in case Microsoft SharePoint and Microsoft SQL Server are installed on the same machine.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    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)

    False

    SiteCollection

    Specifies a site that you want to get. The cmdlet will restore items from the specified site.

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

    True

    0

    True (ByValue)

    False

    StagingServerName

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

    False

    Named

    False

    False

    StagingInstanceName

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

    False

    Named

    False

    False

    StagingServerPort

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

    False

    Named

    False

    False

    GuestCredential

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

    False

    Named

    False

    False

    SqlCredential

    Specifies credentials to authenticate against the Microsoft SQL server.

    False

    Named

    False

    False

    UseWindowsAuthentification

    Indicates that the cmdlet will use Windows authentication.

    False

    Named

    False

    False

    <CommonParameters>

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

    Return Type

    VBRSharePointRestoreSession

    Example 1

    This example shows how to start a restore session for all site collections and Microsoft SharePoint databases from the particular restore point.

    1. Run the Get-VBRApplicationRestorePoint cmdlet to get a restore point. Save the result to the $restorepoint variable.
    2. Run the Start-VBRSharePointItemRestoreSession cmdlet with the $restorepoint variable.

    $restorepoint = Get-VBRApplicationRestorePoint -Sharepoint

    Start-VBRSharePointItemRestoreSession -RestorePoint $restorepoint[0]

    Example 2

    This example shows how to start a restore session from a Microsoft SQL backup that contains the necessary Microsoft SharePoint database

    1. Run the Get-VBRApplicationRestorePoint cmdlet with the SQL parameter to get a restore point of the Microsoft SQL backup. Save the result to the $restorepoint variable.
    2. Run the Start-VBRSharePointItemRestoreSession cmdlet with the $restorepoint variable.

    $restorepoint = Get-VBRApplicationRestorePoint -SQL

    Start-VBRSharePointItemRestoreSession -RestorePoint $restorepoint[0]

    Example 3

    This example shows how to start a restore session for a Microsoft SharePoint site collection.

    1. Run the Get-VBRApplicationRestorePoint cmdlet to get a restore point. Save the result to the $restorepoint variable.
    2. Run the Get-VBRSiteCollection cmdlet to get the site collection. Save the result to the $restorepoint variable.
    3. Run the Start-VBRSharePointItemRestoreSession cmdlet with the $sitecollection variable.

    $restorepoint = Get-VBRApplicationRestorePoint -SharePoint -Name "Sharepoint server"

    $sitecollection = Get-VBRSiteCollection -RestorePoint $restorepoint

    Start-VBRSharePointItemRestoreSession -SiteCollection $sitecollection[0]

    Example 4

    This example shows how to start a restore session for all site collections and Microsoft SharePoint databases from the particular restore point. The cmdlet will use a staging server and will create the content database within the VEEAMSQL2016 instance.

    1. Run the Get-VBRApplicationRestorePoint cmdlet to get the restore point. Save the result to the $restorepoint variable.
    2. Run the Get-Credential cmdlet to create a credential object that you want to use for authenticating with the staging server and an SQL instance. Save the result to the $creds variable.
    3. Run the Start-VBRSharePointItemRestoreSession cmdlet with the $restorepoint and $creds variables. Use the UseWindowsAuthentification parameter to apply the Windows authentication option.

    $restorepoint = Get-VBRApplicationRestorePoint -Sharepoint

    $creds = Get-credential

    Start-VBRSharePointItemRestoreSession -RestorePoint $sapp -StagingServerName "LOCALHOST" -StagingInstanceName "VEEAMSQL2016" -GuestCredential $creds -SqlCredential $creds -UseWindowsAuthentification

    Related Commands

    View all results across Veeam
    Back to document search