Stop-VBRSharePointItemRestoreSession

In this article

    Short Description

    Stops active restore sessions initiated to perform operations with Microsoft SharePoint databases.

    Applies to: Veeam Backup & Replication

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

    Syntax

    Stop-VBRSharePointItemRestoreSession [-Session] <SharePointRestoreSession>  [<CommonParameters>]

    Detailed Description

    This cmdlet stops active restore sessions for Microsoft SharePoint initiated to perform operations with Microsoft SharePoint databases.

    Stop-VBRSharePointItemRestoreSession Note:

    • You can stop restore sessions that are created by means of PowerShell only.
    • The cmdlet will stop sessions that are initiated within the same PowerShell session only.
    • Restore sessions will not stop automatically if you close the PowerShell console without stopping the restore session first.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Session

    Specifies a restore session for Microsoft SharePoint that you want to stop.

    Accepts the SharePointRestoreSession object. To get this object, run the Get-VBOSharePointItemRestoreSession cmdlet.

    True

    0

    True (ByValue)

    <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

    None.

    Examples

    Stopping Restore Session

    This example shows how to stop a restore session for Microsoft SharePoint.

    $session = Get-VBRSharePointItemRestoreSession

    Stop-VBRSharePointItemRestoreSession -Session $session

    Perform the following steps:

    1. Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
    2. Run the Stop-VBRSharePointItemRestoreSession cmdlet. Set the $session variable as the Session parameter value.

    Related Commands

    Get-VBRSharePointItemRestoreSession