Stop-VESQLRestoreSession

In this article

    Short Description

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

    Applies to Veeam Backup & Replication

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

    Syntax

    Stop-VESQLRestoreSession [-Session] <VESQLRestoreSession>  [<CommonParameters>]

    Detailed Description

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

    Stop-VESQLRestoreSession 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-VESQLRestoreSession cmdlet.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Session

    Specifies a restore session initiated to perform operations with Microsoft SQL databases. The cmdlet will stop this session.

    Accepts the VESQLRestoreSession object. To get this object, run the Get-VESQLRestoreSession 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 Session

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

    $session = Get-VESQLRestoreSession

    Stop-VESQLRestoreSession -Session $session[3]

    Perform the following steps:

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

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

    Related Commands

    Get-VESQLRestoreSession