Stop-VBRExchangeItemRestoreSession

Short Description

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

Product: Veeam Backup & Replication

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

Syntax

Stop-VBRExchangeItemRestoreSession [-Session] <VBRExchangeRestoreSession> [<CommonParameters>]

Detailed Description

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

Note

Consider the following:

The cmdlet stops restore sessions initiated in the PowerShell console only.
Restore sessions will not stop automatically if you close the PowerShell console. To stop the restore session, you must run the Stop-VBRExchangeItemRestoreSession cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies a restore session for a Microsoft Exchange database that you want to stop. Accepts the `VBRExchangeRestoreSession` object. To get this object, run the `Get-VBRExchangeItemRestoreSession` cmdlet.	`VBRExchangeRestoreSession`	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 Learn.

Examples

Stopping Specific Restore Session

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

$session = Get-VBRExchangeItemRestoreSession

Stop-VBRExchangeItemRestoreSession -Session $session[3]

Perform the following steps:

Run the Get-VBRExchangeItemRestoreSession 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-VBRExchangeItemRestoreSession cmdlet. Set the $session variable as the Session parameter value.

Get-VBRExchangeItemRestoreSession