Get-VEMDBPublishedDatabase

Short Description

Returns published MongoDB databases.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Get-VEMDBPublishedDatabase [-Instance <String[]>] [-Name <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of published MongoDB databases. Once you get the necessary MongoDB databases, you can use the Get-VEMDBPublishedCollection cmdlet to get an array of published MongoDB collections.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Instance	Specifies an array of names of published MongoDB instances, in the <server>:<port> format (for example, mongodb01:27017). The cmdlet will return an array of databases on the specified instances. This parameter accepts wildcard characters.	String[]	False	Named	False
Name	Specifies an array of names of published MongoDB databases. The cmdlet will return an array of databases with the specified names. This parameter accepts wildcard characters.	String[]	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Instance

Specifies an array of names of published MongoDB instances, in the <server>:<port> format (for example, mongodb01:27017). The cmdlet will return an array of databases on the specified instances.

This parameter accepts wildcard characters.

String[]

False

Named

False

Name

Specifies an array of names of published MongoDB databases. The cmdlet will return an array of databases with the specified names.

This parameter accepts wildcard characters.

String[]

False

Named

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 VEMDBPublishedDatabase[] array that contains settings of published MongoDB databases.

Examples

Example 1. Getting All Published MongoDB Databases

This example shows how to get an array of all published MongoDB databases.

Get-VEMDBPublishedDatabase

Example 2. Getting Specific Published MongoDB Databases

This example shows how to get an array of published MongoDB databases with specific names.

$databasenames = @("customers", "employees")

$publisheddatabases = Get-VEMDBPublishedDatabase -Name $databasenames

Perform the following steps:

Declare the $databasenames variable. Assign to this variable an array with the names of the necessary MongoDB databases.
Run the Get-VEMDBPublishedDatabase cmdlet. Set the $databasenames variable as the Name parameter value. Save the result to the $publisheddatabases variable to be able to use it with other cmdlets.

Example 3. Getting MongoDB Databases from Specific Published Instances

This example shows how to get an array of all MongoDB databases on the specified published MongoDB instances.

$instancenames = @("mongodb01:27017", "mongodb02:27017")

$publisheddatabases = Get-VEMDBPublishedDatabase -Instance $instancenames

Perform the following steps:

Declare the $instancenames variable. Assign to this variable an array with the names of the necessary MongoDB instances.
Run the Get-VEMDBPublishedDatabase cmdlet. Set the $instancenames variable as the Instance parameter value. Save the result to the $publisheddatabases variable to be able to use it with other cmdlets.