Start-VBRHvInstantRecovery
Short Description
Starts Hyper-V Instant Recovery.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Start-VBRHvInstantRecovery -RestorePoint <COib> [-Credentials <CCredentials>] [-DisableDiskAllocation] [-DiskMappingRule <VBRHvVirtualDeviceMappingRule>] [-EnableAntivirusScan] [-EnableEntireVolumeScan] [-EnableYARAScan] [-Force] [-HelperAppliance <VBRHvInstantRecoveryHelperAppliance>] [-NetworkMapping <VBRHvInstantRecoveryNetworkMappingRule[]>] [-NICsEnabled <bool>] [-Path <string>] [-PowerUp <bool>] [-PreserveMACs <bool>] [-PreserveVmID <bool>] [-Reason <string>] [-RegisterAsClusterResource] [-Server <CHost>] [-VirusDetectionAction {DisableNetwork | AbortRecovery}] [-VMName <string>] [-YARAScanRule <String>] [<CommonParameters>] |
Detailed Description
This cmdlet starts Instant Recovery to Microsoft Hyper-V. The Instant Recovery for Microsoft Hyper-V process creates a copy of a workload in a target location reading data from the directly from a compressed and deduplicated backup file. For the list of workload types that you can restore, see in the Instant Recovery to Microsoft Hyper-V section in the Veeam Backup & Replication User Guide.
With this cmdlet, you can perform the following recover scenarios:
- Restore to original location
- Restore to original location with different settings
- Restore to another location
- Secure restore
The recovered VM runs from a backup and does not provide a wholly functioning service. You need to finalize the successful instant recovery by one of the following steps:
- Remove the recovered VM. You can stop publishing the recovered VM and discard the changes made to it while it was running from backup. To do this, run the Stop-VBRInstantRecovery cmdlet.
- Migrate the recovered VM to the production. To do this, run the Start-VBRHvInstantRecoveryMigration cmdlet.
Run the Restart-VBRInstantRecovery cmdlet to restart the Instant Recovery session if it failed for some reason.
Run the Get-VBRInstantRecovery cmdlet to get the session status.
Note: |
|
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
RestorePoint | Specifies a restore point to which you want to restore the workload. | Accepts the COib object. To create this object, run the Get-VBRRestorePoint cmdlet. | True | 0 | True (ByValue, ByPropertyName) |
Server | Specifies the host where the restored VM will reside. | Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet. | False | Named | False |
Path | To redirect the redo logs. Specifies the path to the folder where you want to restore the VM. Note: This parameter is required if you provide the Server parameter. | String | False
| Named | False |
VMName | Specifies the name you want to apply to the restored VM. By default, the original name is applied. | String | False | Named | False |
PreserveVmID | Defines whether the restored VM gets the ID of the original workload:
| Bool | False | Named | False |
PowerUp | Defines whether to power on the VM right after restore:
| Bool | False | Named | False |
NICsEnabled | Defines whether to connect the restored VM to the network:
| Bool | False | Named | False |
PreserveMACs | Defines whether the restored VM gets the MAC address of the original workload:
Note: If the original workload keeps running, preserving the MAC address will cause conflict. Preserving the workload address is useful if the original VM will not be used in future — in this case, the restored VM will be able to use the MAC settings used by its applications, if any are installed. | Bool | False | Named | False |
Reason | Specifies the reason for performing restore of the selected workload. The information you provide will be saved in the session history so that you can reference it later. | String | False | Named | False |
Credentials | Used to access VMs stored on shared folders. Specifies the credentials you want to use to authenticate with the shared folder. | Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet. | False | Named | False |
Force | Defines that the cmdlet will perform restore even if the geographic location of the repository where backups reside and the target host location do not match. The cmdlet will not show any warnings in the PowerShell console. | SwitchParameter | False | Named | False |
EnableAntivirusScan | Enables secure restore. Veeam Backup & Replication will trigger the antivirus software to scan the selected workloads before the restore. | SwitchParameter | False | Named | False |
EnableYARAScan | Enables the YARA scan for the selected VMs. Use the YARAScanRule parameter to specify the YARA rule to be used. | SwitchParameter | False | Named | False |
YARAScanRule | Specifies the YARA rule. Veeam Backup & Replication will scan VMs with this rule. Veeam Backup & Replication searches for YARA rules by the following path: C:\Program Files\Veeam\Backup and Replication\Backup\YaraRules. To use the Yara rule, you must specify its name and extension. Veeam Backup & Replication accepts only .yar and .yara extension. | String | False | Named | False |
EnableEntireVolumeScan | For secure restore. Defines that the antivirus will continue workload scan 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.
| Accepts the VBRVirusDetectionAction enum type. | False | Named | False |
NetworkMapping | Specifies an array of network mapping rules. These rules specify how to map networks in the original site with networks in the target site (where the recovered VM will reside). Note: This parameter applies if you perform instant recovery of Veeam Agent computers. | Accepts the VBRHvInstantRecoveryNetworkMappingRule[] object. To create this object, run the New-VBRHvInstantRecoveryNetworkMappingRule cmdlet. | False | Named | False |
HelperAppliance | Specifies settings of a helper appliance used to restore Linux-based VMs. Note: This parameter applies if you perform instant recovery for workloads other than Microsoft Hyper-V VMs. | Accepts the VBRHvInstantRecoveryHelperAppliance object. To create this object, run the New-VBRHvInstantRecoveryHelperAppliance cmdlet. | False | Named | True (ByValue, ByPropertyName) |
DisableDiskAllocation | Defines whether to allocate disk space. | SwitchParameter | False | Named | False |
DiskMappingRule | Specifies backed-up virtual disk mapping settings. | Accepts the VBRHvVirtualDeviceMappingRule[] object. To create this object, run the New-VBRHvVirtualDeviceMappingRule cmdlet. | False | Named | False |
RegisterAsClusterResource | Defines that the restored VM will be registered as a part of a cluster in case you restore the VM to a clustered host. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
None.
Examples
Example 1. Starting Instant Recovery of VM
The example shows how to start Instant Recovery of the VM.
Perform the following steps:
The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the second restore point is used. |
Example 2. Starting Instant Recovery of VM with Different Settings
The example shows how to start Instant Recovery of the VM. The job will run with the following settings:
Perform the following steps:
The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the second restore point is used.
|
Example 3. Starting Secure Restore of VM
The example shows how to run the secure restore of the selected VM. The job will run with the following settings:
Perform the following steps:
The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the second restore point is used.
|
Related Commands