Get-VEMDBRestoreSession

Short Description

Returns active restore sessions started to perform restore operations with backed-up MongoDB data.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Get-VEMDBRestoreSession [[-SessionId] <Guid>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of active restore sessions started to perform operations with backed-up MongoDB data. Once you select the restore session you need, you can either get backed-up MongoDB databases using the Get-VEMDBDatabase cmdlet, or backed-up MongoDB collections using the Get-VEMDBCollection cmdlet.

Note the difference between a restore session and a restore job. A restore session is a preliminary step where Veeam Explorer for MongoDB has retrieved the backup from the backup repository, pending restore operations. A restore job is the process of restoring data from the backup to the target MongoDB deployment.

Get-VEMDBRestoreSession Note:

  • You can only get an array of restore sessions that are started in PowerShell. The cmdlet does not return restore sessions started in the Veeam Backup & Replication console.
  • The cmdlet only returns an array of restore sessions started within the same PowerShell session.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

SessionId

Specifies the session ID of the necessary restore session.

GUID

False

1

True (ByValue)

<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 VEMDBRestoreSession[] object that contains settings of the started restore sessions. You can use this object to explore backed-up MongoDB databases and collections and to perform restore operations with MongoDB data.

Examples

Get-VEMDBRestoreSessionExample 1. Getting All Active Restore Sessions

This command returns all active restore sessions. Save the result to the $session variable to be able to use it with other cmdlets.

$session = Get-VEMDBRestoreSession

Get-VEMDBRestoreSessionExample 2. Getting Restore Session by Session ID

This command returns a MongoDB restore session with a specific session ID. Save the result to the $session variable to be able to use it with other cmdlets.

$session = Get-VEMDBRestoreSession -SessionId "b7ced612-1259-4221-810b-f62c21b1c159"

Related Commands

Page updated 7/12/2024

Page content applies to build 12.3.0.310