Start-VBREpInstantRecovery

In this article

    Short Description

    Starts instant recovery of physical computers to virtual infrastructure.

    Applies to

    Platform: Hyper-V

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

    Syntax

    Start-VBREpInstantRecovery [-RestorePoint] <COib> [-Server] <CHost> [-Path] <string> [-VMName <string>] [-PowerUp <bool>] [-NICsEnabled <bool>] [-PreserveMACs <bool>] [-Reason <string>] [-Credentials <CCredentials>][-EnableAntivirusScan] [-EnableEntireVolumeScan] [-VirusDetectionAction <VBRVirusDetectionAction> {DisableNetwork | AbortRecovery}] [<CommonParameters>]

    Detailed Description

    This cmdlet starts an instant recovery session for physical machines. The process restores a backup of a physical computer to a virtualization host.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the restore point of the physical computer to which you want to restore the VM.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Server

    Specifies the host where you want to locate the restored VM.

    True

    2

    False

    False

    Path

    Used to redirect the redo logs.

    Specifies the path to the folder where you want to store the changes made to the VM during the instant recovery.

    True

    3

    False

    False

    VmName

    Specifies the name you want to apply to the restored VM. By default, the original VM name is applied.

    False

    Named

    False

    False

    PowerUp

    If set to True, the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually.

    False

    Named

    False

    False

    NICsEnabled

    If set to True, the restored VM will be connected to the network. Otherwise the VM will have no network connections.

    False

    Named

    False

    False

    PreserveMACs

    If set to True, the restored VM will get the MAC address of the original VM. Otherwise, the restored VM will get a new MAC address.

    Note that if the original computer keeps running, preserving the MAC address will cause conflict. Preserving the MAC address is useful in case the original computer will not be used in future - in this case, the restored VM will be able to use the MAC settings used by its applications, if any are installed.

    False

    Named

    False

    False

    Reason

    Specifies the reason for performing restore of the selected endpoint.

    The information you provide will be saved in the session history so that you can reference it later.

    False

    Named

    False

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the VM.

    False

    Named

    False

    False

    EnableAntivirusScan

    Indicates that the cmdlet will perform secure restore. Veeam Backup & Replication will trigger the antivirus software to scan selected VMs before the restore.

    False

    Named

    False

     

    EnableEntireVolumeScan

    For secure restore.

    Indicates that the antivirus will continue machine scan after the first virus threat is found. Use this option if you want to get the report on all virus threats.

    False

    Named

    False

     

    VirusDetectionAction

    For secure restore.

    Specifies secure restore action when the virus threat is detected.

    • DisableNetwork - use this option if you want to restore VMs in safe state with disabled network adapters (NICs).
    • AbortRecovery - use this option if you want to cancel the restore session.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example

    This example shows how to run secure restore of the selected machine. The job will run with the following settings:

    • The antivirus will continue VM scan after the first virus threat is found
    • In case the threat is detected, Veeam Backup & Replication will restore the machine with disabled NIC
    • The RunAsync parameter is set to bring the process to the background.

    You must perform the following steps:

    1. Run Get-VBRRestorePoint to get the array of the restore points for the selected VM. Save the result to the $restorepoint variable.
    2. Run Start-VBREpInstantRecovery with the $restorepoint variable. Set the DisableNetwork value for the VirusDetectionAction parameter to restore the VM in safe state.

    $restorepoint = Get-VBRRestorePoint

    Start-VBREpInstantRecovery -RestorePoint $restorepoint[1] -RunAsync -EnableAntivirusScan -EnableEntireVolumeScan -VirusDetectionAction DisableNetwork

    Related Commands

    Get-VBRRestorePoint