Get-VBRExchangeItemRestoreSession

In this article

    Short Description

    Returns active restore sessions started to perform operations with backed-up Microsoft Exchange databases.

    Applies to: Veeam Backup & Replication

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

    Syntax

    Get-VBRExchangeItemRestoreSession

    Detailed Description

    This cmdlet returns an array of active restore sessions started to perform operations with backed-up Microsoft Exchange databases.

    Get-VBRExchangeItemRestoreSession Note:

    The cmdlet returns restore sessions initiated in the PowerShell console only. The cmdlet does not return restore sessions running in the Veeam Backup & Replication console.

    <CommonParameters>

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

    Output Object

    The cmdlet returns the VBRExchangeItemRestoreSession object that contains settings of restore sessions started to explore backed-up Exchange databases and and to perform operations with these databases.

    Examples

    Get-VBRExchangeItemRestoreSessionExample 1. Getting all Running Restore Sessions

    This command gets all running restore sessions initiated to perform operations with Microsoft Exchange databases. Save the result to the $session variable to be able to use it with other cmdlets.

    $session = Get-VBRExchangeItemRestoreSession

    Get-VBRExchangeItemRestoreSessionExample 2. Getting Specific Restore Session

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

    $session = Get-VBRExchangeItemRestoreSession

    $session[0]

    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 first restore session in the array).

    1. Specify the necessary ordinal number of the restore session for the $session variable. In our example, it is the fourth restore session in the array.

    Get-VBRExchangeItemRestoreSessionExample 3. 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[0]

    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 first restore session in the array).

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

    Related Commands

    Stop-VBRExchangeItemRestoreSession

    I want to report a typo

    There is a misspelling right here:

     

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