Stop-VBRExchangeItemRestoreSession

In this article

    Short Description

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

    Applies to: 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.

    Stop-VBRExchangeItemRestoreSession Note:

    • 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

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    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.

    True

    0

    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.

    Example

    Stopping Restore Sessions

    This example shows how to stop all active restore sessions initiated to perform operations with Microsoft Exchange databases.

    $session = Get-VBRExchangeItemRestoreSession

    Stop-VBRExchangeItemRestoreSession -Session $session[3]

    Perform the following steps:

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

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

    Related Commands

    Get-VBRExchangeItemRestoreSession

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.