Edit

Start-WBVolumeRecovery

  • Reference
Module:
WindowsServerBackup

Starts a volume recovery operation.

Syntax

Start-WBVolumeRecovery
     [-BackupSet] <WBBackupSet>
     [-VolumeInBackup] <WBVolume>
     [[-RecoveryTargetVolume] <WBVolume>]
     [-SkipBadClusterCheck]
     [-Async]
     [-Force]
     [<CommonParameters>]

Description

The Start-WBVolumeRecovery cmdlet starts a volume recovery operation from a WBBackupSet backup. The operation formats the recovery target volume before recovery.

Examples

Example 1: Start volume recovery

PS C:\> $Backup = Get-WBBackupSet
PS C:\> Start-WBVolumeRecovery -BackupSet $Backup -VolumeInBackup $Backup.Volume[0] -Force

This example starts a volume recovery to the original location, and it uses the Force parameter to perform the operation without a confirmation message.

The first command stores the result of the Get-WBBackupSet cmdlet in the variable named $Backup. The object stored in the variable is a WBBackupSet object.

The second command starts the volume recovery by using the $Backup variable as input, specifying the first item in the volume array in the WBBackupSet object.

Example 2: Start a volume recovery with a recovery target

PS C:\> $Backup = Get-WBBackupSet
PS C:\> $RecoveryTarget = Get-WBVolume
PS C:\> Start-WBVolumeRecovery -BackupSet $Backup -VolumeInBackup $Backup.Volume[0] -RecoveryTargetVolume $RecoveryTarget

This example starts volume recovery for the System Reserved volume and restores to the recovery target volume.

The first command stores the output of the Get-WBBackupSet cmdlet in the variable named $Backup.

The second command stores the output of the Get-WBVolume cmdlet in the variable named $RecoveryTarget.

The third command starts the recovery operation for the volume specifying the $Backup variable as the backup to use and the $RecoveryTarget variable as the volume to restore.

Parameters

-Async

Indicates that Windows PowerShell returns immediately after it starts the operation. The cmdlet does not display status information.

Type:SwitchParameter
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BackupSet

Specifies a WBBackupSet object that contains the backup set for the volume recovery operation.

Type:WBBackupSet
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RecoveryTargetVolume

Specifies a WBVolume object that contains the recovery target volume. If you do not specify a recovery target volume, the original volume is the recovery target volume. The recovery operation formats the volume before recovery.

Type:WBVolume
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipBadClusterCheck

Indicates that cmdlet does not perform bad cluster checks.

Type:SwitchParameter
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VolumeInBackup

Specifies a WBVolume object that contains the source volume that this cmdlet recovers. The WBBackupSet object returned by the BackupSet parameter contains the WBVolume information.

Type:WBVolume
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.Windows.ServerBackup.Commands.WBBackupSet

Microsoft.Windows.ServerBackup.Commands.WBVolume

Outputs

Object