Start-VBRvCloudRestoreVm

Short Description

Starts a vCloud VM restore.

Applies to

Platform: VMware

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

Syntax

Start-VBRvCloudRestoreVm [-RestorePoint] <COib> [-vApp <CVcdVappItem>] [-StorageProfile <CVcdOrgVdcStorageProfile>] [-vCloudDatastore <CVcdDatastoreRestoreInfo>] [-VmTemplate <IVcdItem>] [-VMName <string>] [-PowerUp] [-Reason <string>] [-RunAsync] [-EnableAntivirusScan] [-EnableEntireVolumeScan][-VirusDetectionAction <VBRVirusDetectionAction> {DisableNetwork | AbortRecovery}][<CommonParameters>]

Detailed Description

This cmdlet starts a restore session of a selected vCloud VM. With this cmdlet, you can perform the following recover scenarios:

  • Restore to the original location
  • Restore to another location
  • Restore with different settings
  • Secure restore of the selected restore point

To restore a VM to the original location you only need to select the required 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.

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

StorageProfile

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

False

Named

False

False

vCloudDatastore

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

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.

Enables the antivirus scan for all volumes of the infected restore point. Use this option if you want to perform secure restore with the following options:

  • Continue machine scan after the first virus threat is found
  • Get the report on all virus threats

False

Named

False

False

VirusDetectionAction

For secure restore.

Specifies secure restore action when the virus threat is detected.

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

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

The example shows how to start a vCloud VM restore to the original location.

  1. Run Get-VBRRestorePoint to get the array of the restore points for the selected VM. Save the result to the $restorepoint variable.
  2. Run Start-VBRvCloudRestoreVm with the $restorepoint variable.

$restorepoint = Get-VBRRestorePoint

Start-VBRvCloudRestoreVm -RestorePoint $restorepoint[1]

Example 2

The example shows how to restore a VM to another vApp with another storage profile.

  1. Run Get-VBRRestorePoint to get the array of the restore points for the selected VM. Save the result to the $restorepoint variable.
  2. Run Find-VBRvCloudEntity to specify the vApp you want to restore the VM to. Save the result to the $vapp variable.
  3. Run Find-VBRvCloudEntity to specify the storage profile you want to apply to the restored VM.. Save the result to the $profile variable.
  4. Run Start-VBRvCloudRestoreVm with the $restorepoint, $vapp and $profile variables.

$restorepoint = Get-VBRRestorePoint

$vapp = Find-VBRvCloudEntity -VApp

$profile = Find-VBRvCloudEntity -StorageProfile

Start-VBRvCloudRestoreVm -RestorePoint $restorepoint -vApp $vapp -StorageProfile $profile

Example 3

The example shows how to run secure restore of the selected VM. The job will run with the following settings:

  • Veeam Backup & Replication will scan all volumes of the infected restore points.
  • In case the infection is detected, Veeam Backup & Replication will restore the VM with disabled NIC
  • The RunAsync parameter is set to bring the process to the background.

You must perform the following steps:

  1. Run Get-VBRRestorePoint to get the array of the restore points for the selected VM. Save the result to the $restorepoint variable.
  2. Run Start-VBRvCloudRestoreVm with the $restorepoint variable. Set the DisableNetwork value for the VirusDetectionAction parameter to restore the VM with disabled network adapters (NICs).

$restorepoint = Get-VBRRestorePoint

Start-VBRvCloudRestoreVm -RestorePoint $restorepoint[1] -RunAsync -EnableAntivirusScan -EnableEntireVolumeScan -VirusDetectionAction DisableNetwork

Related Commands

Get-VBRRestorePoint

Find-VBRvCloudEntity