Stop-VBRInstantRecoveryMigration

Short Description

Stops running migration sessions launched during Instant Recovery.

Platform: VMware

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

Syntax

Stop-VBRInstantRecoveryMigration [-Migration] <InstantRecoveryMigration[]> [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet stops migration sessions launched during Instant Recovery (including Instant Recovery for first class disks, file shares and so on).

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Migration	Specifies an array of IDs of the migration sessions that you want to stop. Accepts the `InstantRecoveryMigration[]` object. To create this object, run the `Get-VBRInstantRecoveryMigration` cmdlet.	`InstantRecoveryMigration[]`	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 Migration Sessions Launched During Instant Recovery

This example shows how to stop a running migration session launched during Instant Recovery.

$session = Get-VBRInstantRecoveryMigration

Stop-VBRInstantRecoveryMigration -Migration $session[3]

Perform the following steps:

Run the Get-VBRInstantRecoveryMigration cmdlet. Save the result to the $session variable.
The Get-VBRInstantRecoveryMigration cmdlet will return an array of migration sessions. Mind the ordinal number of the necessary migration session (in our example, it is the fourth migration session in the array).
Run the Stop-VBRInstantRecoveryMigration cmdlet. Set the $session[3] variable as the Migration parameter value.