Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Get-VESQLPublishedDatabase

Short Description

Returns published Microsoft SQL databases.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

Get-VESQLPublishedDatabase [-Session] <VESQLRestoreSession> [[-Name] <string[]>] [-ServerName <string[]>][-InstanceName <string[]>]  [<CommonParameters>]

Detailed Description

This cmdlet returns an array of published Microsoft SQL databases.

Get-VESQLPublishedDatabase Note:

Mind that you can get an array of Microsoft SQL databases in the following cases:

  • If they were published by means of PowerShell only
  • If they were published per one restore session only

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Session

Specifies a restore session. The cmdlet will return information about a Microsoft SQL database added to the specified restore session.

Accepts the VESQLRestoreSession object. To get this object, run the Get-VESQLRestoreSession cmdlet

True

0

True (ByValue)

False

Name

Specifies a name of a Microsoft SQL database. The cmdlet will return information about the database with the specified name.

False

1

False

False

ServerName

Specifies a name of the target server to which a Microsoft SQL database was published.

False

Named

False

False

InstanceName

Specifies a name of the target instance to which a Microsoft SQL database was published.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Return Type

VESQLPublishedDatabase

Example

This example shows how to get a list of all published Microsoft SQL databases.

  1. Run the Get-VESQLRestoreSession cmdlet to get a restore session for Microsoft SQL databases. Save the result to the $session variable.
  2. Run the Get-VESQLPublishedDatabase cmdlet with the $session variable.

$session = Get-VESQLRestoreSession

Get-VESQLPublishedDatabase -Session $session[0]

Related Commands

Get-VESQLRestoreSession

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation