Stop-VBOExchangeItemRestoreSession

Short Description

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

Product: Veeam Backup for Microsoft 365

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

Syntax

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

Detailed Description

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies a restore session that you want to stop. Accepts the `VBOExchangeRestoreSession` object. To get this object, run the `Get-VBOExchangeItemRestoreSession` cmdlet.	`VBOExchangeRestoreSession`	True	Named	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.

Examples

Stopping Restore Session

This example shows how to stop a restore session initiated to perform operations with backed-up Microsoft Exchange items.

$session = Get-VBOExchangeItemRestoreSession

Stop-VBOExchangeItemRestoreSession -Session $session[3]

Perform the following steps:

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

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In this example, it is the fourth restore session in the array.
Run the Stop-VBOExchangeItemRestoreSession cmdlet. Set the $session variable as the Session parameter value.

Get-VBOExchangeItemRestoreSession