This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VESQLDatabase

Short Description

Returns backed-up Microsoft SQL databases.

Applies to

Veeam Backup & Replication

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

Syntax

Get-VESQLDatabase [-Session] <VESQLRestoreSession> [[-Name] <String[]>] [[-InstanceName] <String[]>][<CommonParameters>]

Detailed Description

This cmdlet returns an array of backed-up Microsoft SQL databases.

After you get backed-up Microsoft SQL databases, you can perform the following operations with these databases:

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Session	Specifies an active restore session. The cmdlet will return an array of databases within the specified restore session.	Accepts the VESQLRestoreSession object. To get this object, run the Get-VESQLRestoreSession cmdlet.	True	0	True (ByValue)	False
Name	Specifies an array of names for Microsoft SQL Server databases. The cmdlet will return an array of databases with the specified name.	String[]	False	1	False	False
InstanceName	Specifies an array of names for Microsoft SQL Server instances. The cmdlet will return an array of instances with the specified name.	String[]	False	2	False	False

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 VESQLDatabase[] object that contains an array of backed-up Microsoft SQL databases.

Examples

Get-VESQLDatabase Example 1. Getting Microsoft SQL Databases Within Specified Restore Session

This example shows how to get a list of Microsoft SQL databases within the specified restore session.

$session = Get-VESQLRestoreSession

Get-VESQLDatabase -Session $session[1]

Perform the following steps:

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

Run the Get-VESQLDatabase cmdlet. Set the $session variable as the Session parameter value.

Get-VESQLDatabase Example 2. Getting Microsoft SQL Database with Specified Name

This example shows how to get a Microsoft SQL database with the specified name.

$session = Get-VESQLRestoreSession

Get-VESQLDatabase -Session $session[0] -Name "SQLDatabase"

Perform the following steps:

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

Run the Get-VESQLDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value.

Related Commands

Get-VESQLRestoreSession