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

Stop-VBOExchangeItemRestoreSession

Short Description

Stops active restore sessions initiated to perform operations with backed-up Microsoft Exchange objects.

Applies to: Veeam Backup for Microsoft Office 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

Stop-VBOExchangeItemRestoreSession -Session <VBOExchangeRestoreSession>  [<CommonParameters>]

Detailed Description

This cmdlet stops active restore sessions initiated to perform operations with backed-up Microsoft Exchange objects.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Session

Specifies a restore session that you want to stop.

Accepts the VBOExchangeRestoreSession object. To get this object, run the Get-VBOExchangeItemRestoreSession cmdlet.

True

Named

True (ByValue)

False

<CommonParameters>

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

Examples

Stopping Restore Session

This example shows how to stop a restore session initiated to perform operations with the Microsoft Exchange database.

$session = Get-VBOExchangeItemRestoreSession

Stop-VBOExchangeItemRestoreSession -Session $session[3]

Perform the following steps:

  1. Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.

The Get-VBOExchangeItemRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Stop-VBOExchangeItemRestoreSession cmdlet. Set the $session variable as the Session parameter value.

Related Commands

Get-VBOExchangeItemRestoreSession