Start-VBRViComputerInstantRecovery

Short Description

Starts instant recovery of Veeam Agent computers to the VMware infrastructure.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRViComputerInstantRecovery [-RestorePoint] <COib> -Server <CHost> [-RestoredVMName <string>] [-VMFolder <CViFolderItem>] [-ResourcePool <CViResourcePoolItem>] [-SourceNetwork <VBRComputerNetworkInfo[]>] [-TargetNetwork <IVBRServerNetworkInfo[]>] [-GenerateNewSystemUUID] [-CacheDatastore <VBRViDatastore>] [-StoragePolicy <VBRViStoragePolicy>] [-PowerOnAfterRestoring] [-ConnectVMToNetwork] [-Reason <string>] [-Credentials <CCredentials>] [-RunAsync] [-EnableAntivirusScan] [-EnableEntireVolumeScan] [-VirusDetectionAction <VBRVirusDetectionAction> {DisableNetwork | AbortRecovery}] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet starts an instant recovery of machines to the VMware infrastructure. You can restore the following types of machines:

  • MIcrosoft Windows computers backed up by Veeam Agent.
  • Linux computers backed up by the Veeam Agent.
  • Hyper-V workloads to restore them to VMware vSphere VMs.

To restore Hyper-V workloads to Hyper-V VMs, run the Start-VBRHvInstantRecovery cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies a restore point for Veeam Agent computers. The cmdlet will use the specified restore point to recover Veeam Agent computers.

Accepts the COib object. To get this object, run the Get-VBRRestorePoint cmdlet.

True

0

True (ByValue, ByPropertyName)

Server

For restore to another location.

Specifies the target ESXi host. The cmdlet will restore the Veeam Agent computers to this ESXi host.

Note: You must not specify a vCenter Server in this parameter.

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

True

Named

False

VMFolder

For restore to another location.

Specifies a folder on the ESXi host. The cmdlet will restore the Veeam Agent computers to this folder.

Accepts the CViFolderItem object. To get this object, run the Find-VBRViFolder cmdlet.

False

Named

False

RestoredVMName

Specifies a name of the restored Veeam Agent computer. The cmdlet will restore the Veeam Agent computer with this name.

Default: The original Veeam Agent computer name.

String

False

Named

False

ResourcePool

For restore to another location.

Specifies a resource pool on the ESXi host. The cmdlet will restore Veeam Agent computers to this resource pool.

Accepts the CViResourcePoolItem object. To get this object, run the Find-VBRViResourcePool cmdlet.

False

Named

False

SourceNetwork

For restore to another location.

Specifies the source site network. Veeam Backup & Replication will map it to the target network.

Accepts the VBRComputerNetworkInfo[] object. To get this object, run the Get-VBRComputerNetworkInfo cmdlet.

False

Named

False

TargetNetwork

For restore to another location.

Specifies the target site network. Veeam Backup & Replication will map it with the source network.

IVBRServerNetworkInfo[]

False

Named

False

GenerateNewSystemUUID

Defines that the cmdlet will generate a new system UUID for the restored Veeam Agent computers.

If you do not provide this parameter, the cmdlet will keep the existing system UUID of the restored Veeam Agent computers.

SwitchParameter

False

Named

False

CacheDatastore

Specifies a datastore to keep redo logs for the restored Veeam Agent computers.

Note: If you do not specify this parameter, Veeam Backup & Replication will store redo logs on the vPower NFS server.

VBRViDatastore

False

Named

False

StoragePolicy

Specifies the VMware storage policy profiles. The cmdlet will restore the specified VMware storage policy associated with the restored Veeam Agent computer.

Note: Veeam Backup & Replication restores the storage policy only if you restore the Veeam Agent computer to the original location.

Accepts the VBRViStoragePolicy object. To get this object, run the Find-VBRViStoragePolicy cmdlet.

False

Named

False

PowerOnAfterRestoring

Defines that that cmdlet will power on the restored Veeam Agent computers.

If you do not provide this parameter, you will need to power up the restored Veeam Agent computers manually.

SwitchParameter

False

Named

False

ConnectVMToNetwork

Defines that the cmdlet will restore the Veeam Agent computer with initial network settings.

SwitchParameter

False

Named

False

Reason

Specifies a reason for performing instant recovery of Veeam Agent computers.

String

False

Named

False

Credentials

Used to access the backups of Veeam Agent computers that are stored on shared folders.

Specifies the credentials you want to use to authenticate with the shared folder.

CCredentials

False

Named

False

RunAsync

Defines that the command returns immediately without waiting for the task to complete.

SwitchParameter

False

Named

False

EnableAntivirusScan

Defines that the cmdlet will perform the secure restore. Veeam Backup & Replication will trigger the antivirus software to scan selected Veeam Agent computers before the restore.

SwitchParameter

False

Named

False

EnableEntireVolumeScan

For the secure restore option.

Defines that the antivirus will continue to scan Veeam Agent computers after the first virus threat is found. Use this option if you want to get the report on all virus threats.

SwitchParameter

False

Named

False

VirusDetectionAction

For secure restore.

Specifies the secure restore action when the infection is detected.

  • DisableNetwork: use this option if you want to restore Veeam Agent computers with disabled network adapters (NICs).
  • AbortRecovery: use this option if you want to cancel the restore session.

VBRVirusDetectionAction

False

Named

False

Force

Defines that the cmdlet will perform restore of Veeam Agent computers even if the geographical location of the repository where backups of Veeam Agent computers reside and the target host location does not match.

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

This cmdlet returns the InstantRecovery object that contains settings of an instant recovery of Veeam Agent computers to the VMware infrastructure.

Examples

Performing Instant Recovery of Veeam Agent Computer

This example shows how to perform instant recovery of Veeam Agent computer. The Veeam Agent computer will be restored to the esx07.tech.local host as the WindowsAB_Restored VM.

$backup = Get-VBRBackup -Name "Windows Agent Backup"

$restorepoint = Get-VBRRestorePoint

$srv = Get-VBRServer -Name "esx07.tech.local"

Start-VBRViComputerInstantRecovery -RestorePoint $restorepoint[3] -Server $srv -RestoredVMName "WindowsAB_Restored

Perform the following steps:

  1. Get the restore point:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
  2. Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the fourth restore point in the array).

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $srv variable.
  2. Run the Start-VBRViComputerInstantRecovery cmdlet. Specify the following settings:
  • Set the $restorepoint parameter as the RestorePoint variable value.
  • Set the $srv parameter as the Server variable value.
  • Specify the RestoredVMName parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.