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

Start-VBRvCloudInstantRecovery

Short Description

Starts a vCloud VM instant recovery.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRvCloudInstantRecovery [-RestorePoint] <COib> [-vApp <CVcdVappItem>] [-VmName <String>] [-Datastore <CVcdDatastoreRestoreInfo>] [-PowerOn] [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet performs instant recovery of the selected vCloud VM. You can restore the VM to the original location or to another vApp.

To restore the VM to another vApp indicate the desired vApp object for the -vApp parameter. To perform restore to the original location, omit this parameter.

The VM that you want to restore and its parameters are derived from the specified restore point data.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RestorePoint

Specifies the restore point of the VM.

True

1

True (ByValue,
ByProperty
Name)

False

vApp

Specifies the vApp you want to restore the VM to. If omitted, the VM will be restored to the original vApp.

False

Named

False

False

VmName

Specifies the name under which the VM should be restored and registered. By default, the original name of the VM is used. If you are restoring the VM to the same vApp where the original VM is registered and the original VM still resides there, it is recommended that you change the VM name to avoid conflicts.

False

Named

False

False

Datastore

Specifies the datastore you want to connect the restored VM to. If ommited, the VM will be connected to the original datastore.

Note: If you restore the VM to another vApp, make sure that the datastore is available in the Organization VCD hosting the vApp to which the VM is restored.

False

Named

False

False

PowerOn

If set, 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

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 instant recovery for the VM. The VM is restored to the original location with all its settings unchanged. The restore point object is obtained with Get-VBRRestorePoint and assigned to the $rpoint variable beforehand.

PS C:\PS> Start-VBRvCloudInstantRecovery -RestorePoint $rpoint

Example 2

This command starts instant recovery for the VM named "VM01". The VM is restored to another vApp and is connected to another datastore.

  • The VM restore point is obtained with Get-VBRRestorePoint and piped down. The most resent restore point is selected with Select method,
  • The VM is restored to a new vApp represented by the $vapp variable, the vApp is obtained with Find-VBRvCloudEntity ([-VApp] option) and assigned to the variable beforehand,
  • The -VmName parameter is omitted to restore the VM with its original name,
  • The new datastore the VM will be connected to is represented by $datastore variable, the datastore is obtained with Find-VBRDatastore and assigned to the variable beforehand,
  • The -PowerOn parameter is set to power up the VM automatically right after it is restored,
  • The reason for restore is "Configuration test",
  • The RunAcync parameter is set to bring the process to the background.

PS C:\PS> Get-VBRRestorePoint -Backup $backup | where {$_.Name -eq "VM01"} | Select -First 1 | Start-VBRvCloudInstantRecovery -vApp $vapp -Datastore $datastore -PowerOn -Reason "Configuration test" -RunAsync

Related Commands

Get-VBRRestorePoint

Find-VBRvCloudEntity

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