Stop-VESQLInstantRecovery

Short Description

Stops an active instant recovery session for a Microsoft SQL Server database.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

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

Detailed Description

This cmdlet stops an active instant recovery session for a backed-up Microsoft SQL Server.

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 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 CommonParameters section of Microsoft Docs.

Example

Stopping Instant Recovery Session of a Microsoft SQL Server Database

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

$IRDatabase = Get-VESQLIRDatabase -DatabaseName "monthly_db"

Stop-VESQLInstantRecovery -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-VESQLInstantRecovery cmdlet. Set the $IRDatabase variable as the Database parameter value.

Related Commands

Get-VESQLIRDatabase

Page updated 3/8/2024

Page content applies to build 12.1.2.172