Get-VEMDBRestoreJob

Short Description

Returns active MongoDB restore jobs.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

Return an active restore job using the job ID.

Get-VEMDBRestoreJob -JobId <Guid> [<CommonParameters>]

Return an active restore job using the name of the restored collection.

Get-VEMDBRestoreJob [-CollectionName <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of ongoing MongoDB restore jobs. After you specify the restore job you need, you can stop the restore process with the Stop-VEMDBRestoreJob 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.

Note

The cmdlet returns restore jobs initiated in the PowerShell console only. The cmdlet does not return restore jobs running in the Veeam Backup & Replication console.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
CollectionName	Specifies an array of restored collections. The cmdlet will return information about the restore process performed for the specified collections. This parameter accepts wildcard characters.	String[]	False	Named	False
JobId	Specifies the job ID of the required restore job. The cmdlet will return information about the restore process performed for the specified database.	Guid	True	Named	True (ByValue)

Parameter

Description

Type

Required

Position

Accept Pipeline Input

CollectionName

Specifies an array of restored collections. The cmdlet will return information about the restore process performed for the specified collections.

This parameter accepts wildcard characters.

String[]

False

Named

False

JobId

Specifies the job ID of the required restore job. The cmdlet will return information about the restore process performed for the specified database.

Guid

True

Named

True (ByValue)

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 VEMDBRestore[] array that contains information about ongoing MongoDB restore jobs.

Examples

Get-VEMDBRestoreJob Example 1. Getting All Active Restore Jobs

Get-VEMDBRestoreJob Example 2. Getting Restore Job by Job ID

Get-VEMDBRestoreJob Example 3. Getting Restore Job by Collection Name

Related Commands

Stop-VEMDBRestoreJob