Get-VESQLIRDatabase

Short Description

Returns Microsoft SQL Server databases that are published within an instant recovery session.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VESQLIRDatabase [[-DatabaseName] <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of backed-up Microsoft SQL Server databases that are published within an instant recovery session.

After you get the published Microsoft SQL Server databases within an instant recovery session, you can perform the following operations with these databases:

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

DatabaseName

Specifies a Microsoft SQL Server database name. The cmdlet will return an array of databases with the specified name.

String

False

0

False

<CommonParameters>

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

Output Object

The cmdlet returns the VESQLIRDatabase[] object that contains an array of SQL Server databases that are published within an instant recovery session.

Examples

Get-VESQLIRDatabaseExample 1. Getting All Microsoft SQL Server Databases Published Within Instant Recovery Session

This command returns a list of all published Microsoft SQL Server databases within an instant recovery session. Save the result to the $IRDatabase variable to be able to use it with other cmdlets.

$IRDatabase = Get-VESQLIRDatabase

Get-VESQLIRDatabaseExample 2. Getting Microsoft SQL Server Databases With Specific Name Published Within Instant Recovery Session

This command returns all Microsoft SQL Server databases with the specified name published within an instant recovery session. Save the result to the $IRDatabase variable to be able to use it with other cmdlets.

$IRDatabase = Get-VESQLIRDatabase -DatabaseName "db1"

Page updated 10/2/2023

Page content applies to build 12.1.1.56