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

Start-VBRvCloudRestoreVm

Short Description

Starts a vCloud VM restore.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRvCloudRestoreVm [-RestorePoint] <COib> [-vApp <CVcdVappItem>] [-StorageProfile <CVcdOrgVdcStorageProfile>] [-vCloudDatastore <CVcdDatastoreRestoreInfo>] [-VmTemplate <IVcdItem>] [-VMName <String>] [-PowerUp] [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet starts a restore session of a selected vCloud VM.

With this cmdlet, you can restore the VM to the original location or to another location, or with different settings.

To restore a VM to the original location you only need to indicate the desired restore point. Be careful to specify the restore point of the VM, not the vApp which is not a valid value for this cmdlet. Veeam Backup & Replication gets all the information needed for restore from the restore point data.

To run restore to another location or with different settings you need to set the new settings values with the parameters available in this cmdlet. These parameters are not obligatory, so you can type only those that you want to change.

You cannot restore multiple VM with one command, to restore several VMs you need to start a restore session for each one.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RestorePoint

Specifies the restore point of the VM. If you specify no other parameters of the VM, it will be restored with its initial settings, i.e. the datastore or VM template.

This parameter does not accept VM arrays.

True

1

True (ByValue,
ByProperty
Name)

False

vApp

Specifies the vApp where to you want to restore the VM.

False

Named

False

False

Storage
Profile

Specifies the storage profile you want to apply to the restored VM.

False

Named

False

False

vCloud
Datastore

Specifies the datastore you want to use with the restored VM.

False

Named

False

False

VmTemplate

Specifies the template you want to apply to the restored VM.

False

Named

False

False

VMName

Specifies the VM name you want to apply to the restored VM.

False

Named

False

False

PowerUp

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 a vCloud VM restore. The VM is restored to the original location and with all settings unchanged.

All the information needed for restore is taken from the restore point represented by the $restorepoint variable. The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand.

PS C:\PS> Start-VBRvCloudRestoreVm -RestorePoint $restorepoint

Example 2

This command restores a VM to another vApp and with another storage profile.

  • The VM to restore and the restore point to which it should be restored is represented by the $restorepoint variable. The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand,
  • The vApp object to where the VM will be restored is represented by the $vapp variable. The vApp object is obtained with Find-VBRvCloudEntity ([-VApp] option) and assigned to the variable beforehand.
  • The storage profile object that will be applied to the restored VM is represented by the $profile variable. The storage profile object is obtained with Find-VBRvCloudEntity ([-StorageProfile] option) and assigned to the variable beforehand.

PS C:\PS> Start-VBRvCloudRestoreVm -RestorePoint $restorepoint -vApp $vapp -StorageProfile $profile

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 Endpoint Backup Documentation

Veeam Management Pack Documentation