Stop-VBRInstantRecovery

In this article

    Short Description

    Stops a running instant VM recovery process.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Stop-VBRInstantRecovery [-InstantRecovery] <InstantRecovery[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet stops publishing a VM within an instant recovery process.

    With instant recovery technology, Veeam Backup & Replication starts a VM directly from a backup, incremental or full, without copying it to production storage. You need to finalize the successful instant recovery by either migrating the recovered VM to production or by stopping publishing the recovered VM.

    To migrate the VM, run Start-VBRQuickMigration.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    InstantRecovery

    Specifies the running instant VM recovery process that you want to stop.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This command stops the last instant recovery session. The needed session object is obtained with Get-VBRInstantRecovery, selected by order and piped down.

    Get-VBRInstantRecovery | Select -Last 1 | Stop-VBRInstantRecovery

    Example 2

    This command stops the instant recovery session represented by the $RecoverySession variable. The needed session object is obtained with Get-VBRInstantRecovery and assigned to the variable beforehand.

    Stop-VBRInstantRecovery -InstantRecovery $RecoverySession

    Related Commands

    Get-VBRInstantRecovery