Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Start-VBRHvInstantRecovery

Short Description

Starts Hyper-V Instant VM Recovery.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRHvInstantRecovery [-RestorePoint] <COib> [-Server] <CHost> [-Path] <String> [-VMName <String>][-PreserveVmID [<Boolean>]] [-PowerUp [<Boolean>]] [-NICsEnabled [<Boolean>]] [-PreserveMACs [<Boolean>]] [-Reason <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet allows to perform Instant Recovery of a Hyper-V VM. The Instant VM Recovery for Hyper-V process creates a copy of a VM in a target location reading data from the directly from a compressed and deduplicated backup file.

This cmdlet allows you to use the following options:

  • Restore the VM to any available restore point, full or increment. Use the RestorePoint parameter to indicate the needed restore point.
  • Restore the VM to original location or to another location.  Use the Server and Path parameters to indicate the target location where the VM will be restored. You can indicate the location of the original VM or any other host available with Veeam backup server that will act as a staging location. If you choose the original location, make sure that the original VM is powered off to avoid conflicts or restore the VM with a new name. Use the VMName parameter to set the new name.
  • Connect VM to network. Use the NICsEnabled parameter to connect the restored VM to the network.
  • Power on VM automatically. Use the PowerUp parameter to indicate that the VM must be automatically powered on after restore.
  • Restore the VM with the original ID or with a new ID. Note that if the original VM keeps running, preserving the ID will cause conflict. Preserving the ID is useful in case the original VM will not be used in future - in this case, Veeam Backup & Replication will recognize the restored VM as its original and perform all backup and other operations that were scheduled for the original VM.

The instantly recovered VM runs from a backup and does not provide a wholly functioning service. You need to finalize the successful instant recovery by one of the following steps:

Run Restart-VBRInstantRecovery to restart the Instant Recovery session if it failed for some reason.

Run Get-VBRInstantRecovery to view the session status.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RestorePoint

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

True

1

True (ByValue,
ByProperty
Name)

False

Server

Specifies the host where you want to restore the 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

PreserveVmID

If set to TRUE, the restored VM will get the ID of the original VM. Otherwise, the restored VM will get a new ID.

False

Named

False

False

PowerUp

If set to TRUE, the VM will be powered up right after it is restored. Otherwise, you will need 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 VM keeps running, preserving the MAC address will cause conflict. Preserving the MAC address is useful in case the original VM 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 VM.

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

False

Named

False

False

Credentials

Used to access the VMs stored on shared folders.

Specifies the credentials you want to use to authenticate with the shared folder.

False

Named

False

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 command starts Instant Recovery of the VM.

  • The VM to restore is obtained together with the restore point to which the VM will be restored with Get-VBRRestorePoint and assigned to the $rpoint variable beforehand.
  • The Hyper-V host where the restored VM will be located in obtained with Get-VBRServer and assigned to the $server variable beforehand.
  • The file path for redo logs is c:\Hyper-V\Virtual Hard Disks\Redo.
  • The VM will be restored with name "New-Exch01".
  • The -PowerUp parameter is set toto enable the VM power up automatically.

PS C:\PS> Start-VBRHvInstantRecovery -RestorePoint $rpoint -Server $server -Path "c:\Hyper-V\Virtual Hard Disks\Redo" -VMName "New-Exch01" -PowerUp $True

Related Commands

Get-VBRRestorePoint

Get-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation