Get-VESQLDatabase

Short Description

Returns backed-up Microsoft SQL Server 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 Server databases.

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

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
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)
Name	Specifies an array of names for Microsoft SQL Server databases. The cmdlet will return an array of databases with the specified names.	String[]	False	1	False
InstanceName	Specifies an array of names for Microsoft SQL Server instances. The cmdlet will return an array of databases located on the specified instances.	String[]	False	2	False

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

Examples

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

This example shows how to get a list of all Microsoft SQL Server 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 cmdlet will return an array of active restore sessions. Note 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 and select the necessary restore session.

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

This example shows how to get all Microsoft SQL Server databases 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 cmdlet will return an array of active restore sessions. Note 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 and select the necessary restore session. Specify the Name parameter value.

Get-VESQLDatabase Example 3. Getting Microsoft SQL Server Databases with Specific Names Belonging to Specific Instances

This example shows how to get all Microsoft SQL Server databases with specific names that belong to specific instances.

$session = Get-VESQLRestoreSession

$databasenames = @("db1", "db2")

$instancenames = @("instance_01", "instance_02")

Get-VESQLDatabase -Session $session[0] -Name @databasenames -InstanceName @instancenames

Perform the following steps:

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

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the first restore session in the array.

Declare the $databasenames variable. Assign to this variable an array with the names of the necessary Microsoft SQL Server databases.
Declare the $instancenames variable. Assign to this variable an array with the names of the necessary Microsoft SQL Server instances.
Run the Get-VESQLDatabase cmdlet. Specify the following settings:

Set the $session variable as the Session parameter value and specify the necessary restore session.
Set the $databasenames variable as the Name parameter value.
Set the $instancenames variable as the InstanceName parameter value.

Related Commands

Get-VESQLRestoreSession