Start-VBRInstantRecovery

In this article

    Short Description

    Starts VMware Instant VM Recovery.

    Applies to

    Platform: VMware

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

    Syntax

    Start-VBRInstantRecovery [-RestorePoint] <COib> [-Server] <CHost> [[-ResourcePool] <CViResourcePoolItem>] [-VMName<string>] [-Datastore <CViDatastoreItem>] [-StoragePolicy <VBRViStoragePolicy>] [-Folder <CViFolderItem>][-PowerUp] [-NICsEnabled] [-Reason <string>] [-Credentials <CCredentials>] [-RunAsync] [-Force] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRViNetworkInfo[]>] [-EnableTagRestore] [-EnableAntivirusScan][-EnableEntireVolumeScan] [-VirusDetectionAction <VBRVirusDetectionAction> {DisableNetwork | AbortRecovery}] [-GenerateNewSystemUUID <SwitchParameter>][<CommonParameters>]

    Detailed Description

    This cmdlet starts VM instant recovery. With this cmdlet, you can perform the following recover scenarios:

    • Restore to original location
    • Restore to original location with different settings
    • Restore to another location
    • Secure restore

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the restore point to which you want to recover the VM.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    VMName

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

    False

    Named

    False

    False

    Server

    For restore to another location.

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

    Note: You must not specify a vCenter Server in this parameter.

    True

    2

    False

    False

    ResourcePool

    For restore to another location.

    Specifies the resource pool where you want to locate the restored VM.

    False

    3

    False

    False

    Datastore

    For restore to another location.

    Specifies the datastore to which you want to store the changes made to the VM during the Instant Recovery. Veeam Backup & Replication will redirect the redo logs to the selected datastore.

    False

    Named

    False

    False

    StoragePolicy

    Specifies the VMware storage policy profile that must be applied to the restored virtual disks.

    Accepts VBRViStoragePolicy type.

    False

    Named

    False

    False

    Folder

    For restore to another location.

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

    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

    Reason

    Specifies the reason for performing restore of the selected VM.

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

    False

    Named

    False

    False

    RunAsync

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

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will perform VM restore even if the geographical location of the repository where VM backups reside and the target host location does not match.

    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

    False

    EnableEntireVolumeScan

    For secure restore.

    Indicates that the antivirus will continue VMs 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

    False

    VirusDetectionAction

    For secure restore.

    Specifies the secure restore action when the infection is detected.

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

    False

    Named

    False

    False

    Credentials

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

    False

    Named

    False

    False

    EnableTagRestore

    Indicates that Veeam Backup & Replication will restore VMware tags.

    False

    Named

    False

    False

    SourceNetwork

    For restore to another location.

    Specifies the source site network. Veeam Backup & Replication will map it to the target network.

    False

    Named

    False

    False

    TargetNetwork

    For restore to another location.

    Specifies the target site network. Veeam Backup & Replication will map it with the source network.

    False

    Named

    False

    False

    GenerateNewSystemUUID

    Defines that the cmdlet will generate a new system UUID for the restored machine.

    Note: Currently this parameter supports only the $false value: GenerateNewSystemUUID:$false.

    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 example shows how to restore a VM to its original location and to the latest restore point.

    You will need to perform the following steps:

    1. Run Get-VBRBackup to get the backup containing this VM. Save the result to the $backup variable.
    2. Get the most recent VM restore point:
    • Run Get-VBRRestorePoint with the $backup variable to get VM restore points.
    • Use the Sort-Object method to filter restore points by the CreationTime property.
    • Save the result to the $restorepoint variable.
    1. Run Get-VBRServer to get the ESXi host where the original VM is registered. Save the result to the $server variable.

    Start-VBRInstantRecovery Note:

    If you don't know the name of the source ESXi host, you can get it from the properties of the VM restore point. To do that, run the $restorepoint.AuxData.EsxName command. PowerShell will return the name of the source ESXi host.

    1. Run Start-VBRInstantRecovery with the $restorepoint and $server variables.

    $backup = Get-VBRBackup -Name "Support Backup"

    $restorepoint = Get-VBRRestorePoint -Backup $backup | Sort-Object –Property CreationTime –Descending | Select -First 1

    $server = Get-VBRServer -Type ESXi -Name esx02.support.local

    Start-VBRInstantRecovery -RestorePoint $restorepoint -Server $server

    Example 2

    This example shows how to restore the VM to another location with different settings. The job will run with the following settings:

    • The VM is restored with name "MSExchange_Restored".
    • The PowerUp parameter is used to enable the auto power up of the restored VM.
    • The NICsEnabled parameter is used to connect the restored VM to the host network.
    • The restore reason is "Data recovery".
    • The RunAsync parameter is set to bring the process to the background.

    You will need to preform the following steps:

    1. Run Get-VBRRestorePoint to get an array of the restore points for the selected VM. Save the result to the $restorepoint variable.
    2. Run Get-VBRServer to specify the target ESXi host. Save the result to the $server variable.
    3. Run Find-VBRViResourcePool to specify the resource pool. Save the result to the $pool variable.
    4. Run Find-VBRViDatastore to specify the datastore. Save the result to the $store variable.
    5. Run Find-VBRViFolder to specify the folder to locate the restored VM. Save the result to the $folder variable.
    6. Run Start-VBRInstantRecovery with the variables obtained in the previous steps.

    $restorepoint = Get-VBRRestorePoint

    $server = Get-VBRServer -Name support.north.local

    $pool = Find-VBRViResourcePool -Name "ResourcePool_9"

    $store = Find-VBRViDatastore -Name "Datastore_5"

    $folder = Find-VBRViFolder -Name "VM_recovery"

    Start-VBRInstantRecovery -RestorePoint $restorepoint -VMName "MSExchange_Restored" -Server $server -ResourcePool $pool -Datastore $store -Folder $folder -PowerUp:$true -NICsEnabled:$true -Reason "Data recovery" -RunAsync

    Example 3

    The example shows how to perform secure restore of the selected VM. The restore session 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 cancel the restore session
    • The RunAsync parameter is set to bring the process to the background

    You must perform the following steps:

    1. Run Get-VBRRestorePoint to get an array of the restore points for the selected VM. Save the result to the $restorepoint variable.
    2. Run Start-VBRInstantRecovery with the $restorepoint variable. Set the AbortRecovery value of the VirusDetectionAction parameter to disable the recovery of the infected restore point.

    $restorepoint = Get-VBRRestorePoint

    Start-VBRInstantRecovery -RestorePoint $restorepoint[1] -RunAsync -EnableAntivirusScan -EnableEntireVolumeScan -VirusDetectionAction AbortRecovery

    Related Commands

    Get-VBRRestorePoint

    Get-VBRServer

    Find-VBRViResourcePool

    Find-VBRViDatastore

    Find-VBRViFolder

    Get-VBRLocation

    I want to report a typo

    There is a misspelling right here:

     

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