Stop-VBRViInstantVMDiskRecovery

Short Description

Stops restore of VM virtual disks.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VBRViInstantVMDiskRecovery [-InstantRecovery] <InstantRecovery> [-Force] [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet stops restore of VM virtual disks.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will run without warning.	`SwitchParameter`	False	Named	False
InstantRecovery	Specifies a session that is running to restore VM virtual disks. The cmdlet will stop this session. Accepts the `InstantRecovery` object. To get this object, run the `Get-VBRInstantRecovery` cmdlet.	`InstantRecovery`	True	0	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Stopping Restore of VM Virtual Disks

This example shows how to stop a session that is running to restore VM virtual disks.

$session = Get-VBRInstantRecovery

Stop-VBRViInstantVMDiskRecovery -InstantRecovery $session

Perform the following steps:

Run the Get-VBRInstantRecovery cmdlet. Save the result to the $session variable.
Run the Stop-VBRViInstantVMDiskRecovery cmdlet. Set the $session variable as the InstantRecovery parameter value.