Start-WBHyperVRecovery
Starts recovery of a Hyper-V Server 2016 virtual machine.
Syntax
Default (Default)
Start-WBHyperVRecovery
[-BackupSet] <WBBackupSet>
[-VMInBackup] <WBVirtualMachine[]>
[[-TargetPath] <String>]
[-NoRollForward]
[-Async]
[-Force]
[-UseAlternateLocation]
[-RecreatePath]
[<CommonParameters>]
Description
The Start-WBHyperVRecovery cmdlet starts a recovery operation for a Hyper-V virtual machine. Use the application array from a WBBackupSet object to specify the virtual machines that you want to recover.
For an overview of Hyper-V, see Hyper-V Overview on TechNet.
Examples
Example 1: Recover a virtual machine to its original location
PS C:\> $Backup = Get-WBBackupSet
PS C:\> Start-WBHyperVRecovery -BackupSet $Backup -VMInBackup $Backup.Application[0].Component[0]
This example recovers a virtual machine to its original location.
The first command gets the backup set object from the system catalog and stores it in the variable named $Backup.
The second command uses the backup set stored in $Backup to recover a virtual machine that has the ID 285CEA9B-E337-44E1-9BF9-BF431BC3EB35 to its original location.
Example 2: Recover a virtual machine to an alternate location
PS C:\> $Backup = Get-WBBackupSet
PS C:\> Start-WBHyperVRecovery -BackupSet $Backup -VMInBackup $Backup.Application[0].Component[1] -TargetPath "F:\Dir1" -UseAlternateLocation -RecreatePath
This example recovers a virtual machine to an alternate location.
The first command gets the backup set object from the system catalog and stores it in the variable named $Backup.
The second command recovers the virtual machine that has the ID F7D8AAF4-D086-47CC-8264-61F80527BFF4 to an alternate location.
Parameters
-Async
Indicates that Windows PowerShell returns immediately after it starts the recovery and does not display status messages.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-BackupSet
Specifies a backup set object that contains a Hyper-V application backup.
Parameter properties
| Type: | WBBackupSet |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoRollForward
Indicates that this cmdlet recovers a virtual machine from a previous point in time if you select the latest version of the application from the backups. For versions of the application other than the latest version, the operation uses point-in-time recovery by default.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecreatePath
Indicates that the recovery operation recreates the original folder structure when it restores a virtual machine. This option applies only if you recover a virtual machine to an alternate location. If you do not specify this option, the recovery puts all files for a component under a single folder.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 7 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetPath
Specifies an alternate location in the backup set where the recovery process searches for files.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseAlternateLocation
Indicates that you can use the recovery process to recover Hyper-V components, update configuration, and register the virtual machine with the Hyper-V management service. This option applies only if you recover a virtual machine to an alternate location.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 6 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMInBackup
Specifies a list of virtual machine objects that contain the virtual machines to recover. This list must contain virtual machines from the Hyper-V application object in the backup set's application array.
Parameter properties
| Type: | WBVirtualMachine[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.