This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRvCloudInstantRecovery

Short Description

Starts an instant recovery of vCloud VMs

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] [-EnableTagRestore] [-EnableAntivirusScan][-EnableEntireVolumeScan] [-VirusDetectionAction <VBRVirusDetectionAction> {DisableNetwork | AbortRecovery}][<CommonParameters>]

Detailed Description

This cmdlet performs instant recovery of the selected vCloud VM. With this cmdlet, you can perform the following recover scenarios:

Restore to the original location
Restore to another vApp
Secure restore of the selected restore point

To restore the VM to another vApp specify the required vApp object for the vApp parameter. To perform restore to the original location, omit this parameter.

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 that 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
Enable Antivirus Scan	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
Enable EntireVolume Scan	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
Virus Detection Action	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
EnableTagRestore	Indicates that Veeam Backup & Replication will restore VMware tags.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRvCloudInstantRecoveryObject

InstantRecovery

Example 1

The example shows how to start instant recovery of the vCloud VM.

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

$restorepoint = Get-VBRRestorePoint

Start-VBRvCloudInstantRecovery -RestorePoint $restorepoint[1]

Example 2

The example shows how to start instant recovery of the vCloud VM. The job will run with the following settings:

The VmName parameter is omitted to restore the VM with its original name.
The PowerOn parameter is set to power up the VM automatically right after it is restored.
The reason for restore is "Configuration test".
The RunAsync parameter is set to bring the process to the background.

You will need to perform the following steps:

Run Get-VBRRestorePoint to get the array of the restore points for the selected VM. Save the result to the $restorepoint variable.
Run Find-VBRvCloudEntity to specify the vApp you want to restore the VM to. Save the result to the $vapp variable.
Run Find-VBRViDatastore to specify the datastore. Save the result to the $datastore variable.
Run Start-VBRvCloudInstantRecovery with the $restorepoint, $vapp and the $datastore variables.

$restorepoint = Get-VBRRestorePoint

$vApp = Find-VBRvCloudEntity -vApp -Name "RestoreVapp"

$datastore = Find-VBRViDatastore -Name "Datastore05"

Start-VBRvCloudInstantRecovery -RestorePoint $restorepoint[1] -vApp $vapp -Datastore $datastore -PowerOn -Reason "Configuration test" -RunAsync

Example 3

The example shows how to run the secure restore of the selected vCloud 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 stop the instant recovery job.

The RunAsync parameter is set to bring the process to the background.

You will need to perform the following steps:

Run Get-VBRRestorePoint to get the array of the restore points for the selected VM. Save the result to the $restorepoint variable.
Run Start-VBRvCloudInstantRecovery with the $restorepoint variable. Set the AbortRecovery value for the VirusDetectionAction parameter to cancel the restore session in case the antivirus detects the virus threat.

$restorepoint = Get-VBRRestorePoint

Start-VBRvCloudInstantRecovery -RestorePoint $restorepoint[1] -RunAsync -EnableAntivirusScan -EnableEntireVolumeScan -VirusDetectionAction AbortRecovery

Related Commands

Get-VBRRestorePoint

Find-VBRvCloudEntity

Find-VBRViDatastore