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

Stop-VBRSharePointItemRestoreSession

In this article

Short Description

Stops active restore sessions for Microsoft SharePoint.

Applies to: Veeam Backup & Replication

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet stops active restore sessions for Microsoft SharePoint.

Stop-VBRSharePointItemRestoreSession Note:

Mind the following:

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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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

True (ByValue)

False

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

Return Type

Example

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

Run the Get-VBRSharePointItemRestoreSession cmdlet to get the restore session of Microsoft SharePoint that you want to stop. Save the result to the $session variable.
Run the Stop-VBRSharePointItemRestoreSession cmdlet with the $session variable.

$session = Get-VBRSharePointItemRestoreSession

Stop-VBRSharePointItemRestoreSession -Session $session

Related Commands

Get-VBRSharePointItemRestoreSession