Start-VBRSharePointItemRestoreSession

In this article

    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 restore point. 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 IVBRSiteColl ection 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

    True

    0

    True (ByValue)

    StagingServerPort

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

    Int

    False

    Named

    False

    GuestCredential

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

    PSCredential

    False

    Named

    False

    SqlCredential

    Specifies credentials to authenticate against the Microsoft SQL server.

    PSCredential

    False

    Named

    False

    UseWindowsAuthentification

    Defines that the cmdlet will use Windows authentication.

    SwitchParameter

    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.

    Return Type

    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

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

    $restorepoint = Get-VBRApplicationRestorePoint -Sharepoint

    Start-VBRSharePointItemRestoreSession -RestorePoint $restorepoint[0]

    Perform the following steps:

    1. Run the Get-VBRApplicationRestorePoint cmdlet. Provide the Sharepoint parameter. Save the result to the $restorepoint variable.
    2. Run the Start-VBRSharePointItemRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.

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

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

    $restorepoint = Get-VBRApplicationRestorePoint -SQL

    Start-VBRSharePointItemRestoreSession -RestorePoint $restorepoint[0]

    Perform the following steps:

    1. Run the Get-VBRApplicationRestorePoint cmdlet. Provide the SQL parameter. Save the result to the $restorepoint variable.
    2. Run the Start-VBRSharePointItemRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.

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

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

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

    $sitepoint = Get-VBRSiteCollection -RestorePoint $restorepoint

    Start-VBRSharePointItemRestoreSession -SiteCollection $sitepoint[0]

    Perform the following steps:

    1. Run the Get-VBRApplicationRestorePoint cmdlet. Provide the Sharepoint parameter. Save the result to the $restorepoint variable.
    2. Run the Get-VBRSiteCollection cmdlet. Provide the RestorePoint parameter. Save the result to the $sitecollection variable.
    3. Run the Start-VBRSharePointItemRestoreSession cmdlet. Set the $sitepoint variable as the SiteCollection parameter value.

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

    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.

    $restorepoint = Get-VBRApplicationRestorePoint -Sharepoint

    $creds = Get-credential

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

    Perform the following steps:

    1. Run the Get-VBRApplicationRestorePoint cmdlet. Provide the Sharepoint parameter. 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. Specify the following settings:
    • Set the $restorepoint variable as the RestorePoint parameter value.
    • Specify the StagingServerName parameter value.
    • Specify the StagingInstanceName parameter value.
    • Set the $creds variable as the GuestCredential parameter value.
    • Set the $creds variable as the SqlCredential parameter value.
    • Provide the UseWindowsAuthentification parameter.

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

    This example shows how to start a restore session from the restore points of backed-up VMs with Microsoft SQL databases for the Sharepoint server Microsoft SharePoint site collection.

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

    $sitecollection = Get-VBRSiteCollection -RestorePoint $restorepoint

    $sitepoint = Get-VBRSiteCollectionRestorePoint -SiteCollection $sitecollection

    Start-VBRSharePointItemRestoreSession -SiteCollectionRestorePoint $sitepoint[0]

    Perform the following steps:

    1. Run the Get-VBRApplicationRestorePoint cmdlet. Provide the Sharepoint parameter. Save the result to the $restorepoint variable.
    1. Run the Get-VBRSiteCollection cmdlet. Provide the RestorePoint parameter. Save the result to the $sitecollection variable.
    1. Run the Get-VBRSiteCollectionRestorePoint cmdlet. Set the $sitecollection variable as the SiteCollectionRestorePoint parameter value.
    1. Run the Start-VBRSharePointItemRestoreSession cmdlet. Set the $sitepoint variable as the SiteCollectionRestorePoint parameter value.

    Related Commands