Get-VESQLPublishedDatabase

Short Description

Returns published Microsoft SQL Server databases.

Product: Veeam Backup & Replication

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

Syntax

Get-VESQLPublishedDatabase [-Session] <IVESQLRestoreSession> [[-Name] <String[]>] [-ServerName <String[]>]

[-InstanceName <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of published Microsoft SQL Server databases.

Note

The cmdlet returns Microsoft SQL Server databases published in the PowerShell console only. The cmdlet does not return Microsoft SQL Server databases published in the Veeam Backup & Replication console.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
InstanceName	Specifies an array of target instance names. The cmdlet will get Microsoft SQL Server databases that are published to these instances.	`String[]`	False	Named	False
Name	Specifies an array of names for Microsoft SQL Server databases. The cmdlet will return information about databases with the specified names.	`String[]`	False	1	False
ServerName	Specifies an array of target server names (as DNS names or IP addresses). The cmdlet will get Microsoft SQL Server databases that are published to these servers.	`String[]`	False	Named	False
Session	Specifies a restore session. The cmdlet will return information about Microsoft SQL Server databases added to the specified restore session. Accepts the `IVESQLRestoreSession` object. To get this object, run the `Get-VESQLRestoreSession` cmdlet.	`IVESQLRestoreSession`	True	0	True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VESQLPublishedDatabase[] array that contains published Microsoft SQL Server databases.

Examples

Get-VESQLPublishedDatabase Example 1. Getting all Published Microsoft SQL Server Databases

This example shows how to get an array of all published Microsoft SQL Server databases within a restore session.

$session = Get-VESQLRestoreSession

Get-VESQLPublishedDatabase -Session $session[0]

Perform the following steps:

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

The cmdlet will return an array of restore sessions. Note the ordinal number of the necessary restore session. In this example, it is the first restore session in the array.
Run the Get-VESQLPublishedDatabase cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session.

Get-VESQLPublishedDatabase Example 2. Getting All Published Microsoft SQL Server Databases with Specific Names Belonging to Specific Instances

This example shows how to get an array of published Microsoft SQL Server databases with specific names belonging to specific instances on the backup file.

$session = Get-VESQLRestoreSession

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

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

$database = Get-VESQLPublishedDatabase -Session $session[0] -Name $dbnames -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 restore sessions. Note the ordinal number of the necessary restore session. In this example, it is the first restore session in the array.
Declare the $dbnames 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 Microsoft SQL Server instances that you want to query.
Run the Get-VESQLPublishedDatabase cmdlet. Specify the following settings:
- Set the $session variable as the Session parameter value and select the necessary restore session.
- Set the $dbnames variable as the Name parameter value.
- Set the $instancenames variable as the InstanceName parameter value.
Save the result to the $database variable to be able to use it with other cmdlets.

Get-VESQLPublishedDatabase Example 3. Getting All Microsoft SQL Server Databases Published on Specific Servers

This example shows how to get an array of all Microsoft SQL Server databases published on the specified servers.

$session = Get-VESQLRestoreSession

$servernames = @("dlsql01", "dlsql02")

$database = Get-VESQLPublishedDatabase -Session $session[0] -ServerName $servernames

Perform the following steps:

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

The cmdlet will return an array of restore sessions. Note the ordinal number of the necessary restore session. In this example, it is the first restore session in the array.
Declare the $servernames variable. Assign to this variable an array with the names of the necessary servers with Microsoft SQL Server.
Run the Get-VESQLPublishedDatabase cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Set the $servernames variable as the ServerName parameter value. Save the result to the $database variable to be able to use it with other cmdlets.

Get-VESQLRestoreSession