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

Start-VBRInstantRecovery

Short Description

Starts VMware Instant VM Recovery.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRInstantRecovery [-RestorePoint] <COib> [-Server] <CHost> [[-ResourcePool] <CViResourcePoolItem>] [-VMName <string>] [-Datastore <CViDatastoreItem>] [-StoragePolicy <VBRViStoragePolicy>] [-Folder <CViFolderItem>] [-PowerUp] [-NICsEnabled] [-Reason <string>] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet starts VM instant recovery.

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 the name you want to apply to the restored VM. By default, the original VM name is applied.

False

Named

False

False

Server

Used to restore the VM to another location.

Specifies the target ESX(i) host where you want to locate the restored VM. You must not specify a vCenter Server in this parameter.

True

2

False

False

ResourcePool

Used to restore the VM to another location.

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

False

3

False

False

Datastore

Used to redirect the redo logs.

Specifies the datastore to which you want to store the changes made to the VM during the Instant Recovery.

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

Used to restore the VM 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

<CommonParameters>

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

Example 1

This command starts the instant recovery of the VM named "MSExchange". The VM is restored to the original location and to the last restore point.

The backup and the restore point are obtained with Get-VBRBackup and Get-VBRRestorePoint respectively and piped down. The server to locate the restored VM is obtained with Get-VBRServer and assigned to the $server variable beforehand.

PS C:\PS> Get-VBRBackup -Name "MSExchange Backup" | Get-VBRRestorePoint | Select -Last 1 | Start-VBRInstantRecovery -Server $server

Example 2

This command restores the VM to another location and with different settings. The following parameters are set:

  • The restore point is obtained with Get-VBRRestorePoint and assigned to the $restorepoint variable.
  • The VM is restored with name "MSExchange_Restored".
  • The server to locate the restored VM is obtained with Get-VBRServer and assigned to the $server variable.
  • The resource pool is obtained with Find-VBRViResourcePool and assigned to the $pool variable.
  • The datastore is obtained with Find-VBRViDatastore and assigned to the $store variable.
  • The folder to locate the restored VM is obtained with Find-VBRViFolder and saved to the $folder variable.
  • 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.

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

Related Commands

Get-VBRRestorePoint

Get-VBRServer

Find-VBRViResourcePool

Find-VBRViDatastore

Find-VBRViFolder

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