This is an archive version of the document. To get the most up-to-date information, see the current version.Start-VBRHvRestoreVM
Short Description
Starts restore of the entire VM.
Applies to
Platform: Hyper-V
For VMware, run Start-VBRRestoreVM.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRHvRestoreVM [-RestorePoint] <COib> [-Server <CHost>] [-Path <String>] [-VMName <String>] [-PreserveVmID [<Boolean>]] [-PowerUp] [-RegisterAsClusterResource] [-NICsEnabled [<Boolean>]] [-PreserveMACs [<Boolean>]] [-User <String>] [-Password <String>] [-Credential <PSCredential>] [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet starts restore of the entire VM.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Restore | Specifies the VM restore point to which you want to restore. | True | 1 | True (ByValue, | False |
Server | Specifies the host where you want to locate the restored VM. | False | Named | False | False |
Path | Specifies the path to the folder where you want to restore the VM. | False | Named | False | False |
VMName | Specifies the name you want to apply to the restored VM. By default, the original VM name is applied. | False | Named | False | False |
Preserve | If set to TRUE, the restored VM will get the ID of the original VM. Otherwise, the restored VM will get a new ID. Note that if the original VM keeps running, preserving the ID will cause conflict. Preserving the ID is useful in case the original VM will not be used in future - in this case, Veeam Backup & Replication will recognize the restored VM as its original and perform all backup and other operations that were scheduled for the original VM. | False | Named | False | False |
PowerUp | If set, the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually. | False | Named | False | False |
RegisterAs | If set, the restored VM will be registered as a part of a cluster in case you restore the VM to a clustered host. | False | Named | False | False |
NICsEnabled | If set to True, the restored VM will be connected to the network. Otherwise the VM will have no network connections. | False | Named | False | False |
PreserveMACs | If set to TRUE, the restored VM will get the MAC address of the original VM. Otherwise, the restored VM will get a new MAC address. Note that if the original VM keeps running, preserving the MAC address will cause conflict. Preserving the MAC address is useful in case 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. | False | Named | False | False |
User | Specifies the user name you want to use for authenticating with the VM. If you use the Username/Password scenario, the -Credentials parameter must be omitted. | False | Named | False | False |
Password | Specifies the password you want to use for authenticating with the VM. If you use the Username/Password scenario, the -Credentials parameter must be omitted. | False | Named | False | False |
Credential | Specifies the credentials you want to use for authenticating with the VM. If you use the Credentials scenario, the -User and -Password parameters must be omitted. | 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 |
QuickRollback | Indicates that the incremental restore must be performed. | 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.
