Stop-VESQLInstantRecovery

In this article

    Short Description

    Stops an active instant recovery session for Microsoft SQL Server databases.

    Applies to Veeam Backup & Replication

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Stop-VESQLInstantRecovery [-Database] <VESQLIRDatabase> [-Force] [<CommonParameters>]

    Detailed Description

    This cmdlet stops active instant recovery sessions started to explore Microsoft SQL Server databases backed up with Veeam Backup & Replication.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Database

    Specifies a Microsoft SQL Server database. The cmdlet will stop the instant recovery session of this database.

    Accepts the VESQLIRDatabase object. To get this object, run the Get-VESQLIRDatabase cmdlet.

    True

    0

    True (ByValue)

    Force

    Defines that the cmdlet will overwrite an existing Microsoft SQL database with a Microsoft SQL database from a backup.

    Note: The cmdlet will show no prompt before executing the command.

    SwitchParameter

    False

    Named

    False

    <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 for Microsoft SQL Server Databases

    This example shows how to stop an instant recovery session of the monthly_db database.

    $IRDatabase = Get-VESQLIRDatabase -DatabaseName "monthly_db"

    Stop-VESQLIRDatabase -Database $IRDatabase

    Perform the following steps:

    1. Run the Get-VESQLIRDatabase cmdlet. Specify the DatabaseName parameter value. Save the result to the $IRDatabase variable.
    2. Run the Stop-VESQLIRDatabase cmdlet. Set the $IRDatabase variable as the Database parameter value.

    Related Commands

    Get-VEORRMANRestoreSession