Stop-VEMDBRestoreJob

Short Description

Stops the restore process for backed-up MongoDB data.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Stop-VEMDBRestoreJob -RestoreJob <VEMDBRestore> [-Force <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet stops an ongoing restore job for backed-up MongoDB data.

Stop-VEMDBRestoreJob Note:

The cmdlet stops restore jobs initiated in the PowerShell console only.
Restore jobs will not stop automatically if you close the PowerShell console. To stop the restore session, you must run the Stop-VEMDBRestoreJob cmdlet.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will show no prompt before executing the command.	SwitchParameter	False	Named	False
RestoreJob	Specifies an initiated MongoDB restore job. The cmdlet will stop this job.	Accepts the VEMDBRestore object. To get this object, run the Get-VEMDBRestoreJob cmdlet.	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.

Example

Stopping Restore Job

This example shows how to stop a MongoDB restore job.

$restore = Get-VEMDBRestoreJob

Stop-VEMDBARestoreJob -RestoreJob $restore[3] -Force

Perform the following steps:

Run the Get-VEMDBRestoreJob cmdlet. Save the result to the $restore variable.

The cmdlet will return an array of active restore jobs. Note the ordinal number of the necessary restore job (in our example, it is the fourth restore job in the array).

Run the Stop-VEMDBRestoreJob cmdlet. Set the $restore variable as the RestoreJob parameter value and select the necessary restore job. Note that the Force parameter is also provided, which will cause the restore job to be stopped without any additional prompts or warnings.

Related Commands

Get-VEMDBRestoreJob