Stop-VBRViInstantVMDiskRecovery

Short Description

Stops restore of VM virtual disks.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet stops a restore of VM virtual disks.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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.

True

0

True (ByValue, ByPropertyName)

Force

Defines that the cmdlet will run without warning.

SwitchParameter

False

Named

False

RunAsync

Indicates 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 the About CommonParameters section of 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:

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

Related Commands

Get-VBRInstantRecovery

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.