Get-VEMDBDatabase

Short Description

Returns backed-up MongoDB databases.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Get-VEMDBDatabase [-Session] <VEMDBRestoreSession> [-Name <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of backed-up MongoDB databases. After you get the backed-up databases, you can use the Get-VEMDBCollection cmdlet to get the collections you need.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies a restore session initiated to perform operations with MongoDB data.

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

True

0

True (ByValue)

Name

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

String[]

False

Named

False

<CommonParameters>

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

Examples

Get-VEMDBDatabaseExample 1. Getting All MongoDB Databases Within Specified Restore Session

This example shows how to get an array of all MongoDB databases within the specified restore session.

$session = Get-VEMDBRestoreSession

$databases = Get-VEMDBDatabase -Session $session[1]

Perform the following steps:

  1. Run the Get-VEMDBRestoreSession 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).

  1. Run the Get-VEMDBDatabase cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $databases variable to be able to use it with other cmdlets.

Get-VEMDBDatabaseExample 2. Getting MongoDB Databases With Specified Names

This example shows how to get an array of MongoDB databases with the specified names.

$session = Get-VEMDBRestoreSession

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

$databases = Get-VEMDBDatabase -Session $session[1] -Name $dbnames

Perform the following steps:

  1. Run the Get-VEMDBRestoreSession 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.

  1. Declare the $dbnames variable. Assign to this variable an array with the names of the necessary MongoDB databases.
  2. Run the Get-VEMDBDatabase cmdlet. Set the $session variable as the Session parameter value and specify the necessary restore session. Set the $dbnames variable as the Name parameter value. Save the result to the $databases variable to be able to use it with other cmdlets.

Related Commands

Get-VEMDBRestoreSession

Page updated 9/27/2024

Page content applies to build 12.3.0.310