Start-WBVolumeRecovery

Start-WBVolumeRecovery

Starts a volume recovery operation.

Syntax

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

Detailed Description

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

Parameters

-Async

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

-BackupSet<WBBackupSet>

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

-Force

Performs the recovery operation without requesting confirmation. By default, the cmdlet prompts you for confirmation.

-RecoveryTargetVolume<WBVolume>

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.

-SkipBadClusterCheck

Indicates that the system not perform bad cluster checks.

-VolumeInBackup<WBVolume>

Specifies a WBVolume object that contains the source volume to recover. The WBBackupSet object returned by the BackupSet parameter contains the WBVolume information.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• WBBackupSet, WBVolume, WBVolume

Outputs

The output type is the type of the objects that the cmdlet emits.

• System.String

  If you do not specify the Async parameter, the status of the recovery operation displays at periodic intervals until the recovery operation finishes. You can also use the Get-WBJob cmdlet to get the status of the current recovery operation. Type Get-WBJob -Previous 1 to get the status after the recovery operation completes.

Examples

Example 1: Start volume recovery

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.

PS C:\> $Backup = Get-WBBackupSet

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

Example 2: Start a volume recovery with a recovery target

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.

PS C:\> $Backup = Get-WBBackupSet

PS C:\> $RecoveryTarget = Get-WBVolume

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

Related topics

Resume-WBVolumeRecovery