Start-WBApplication Recovery

Module:
windowsserverbackup
Starts an application recovery operation.

Syntax 

Start-WBApplicationRecovery
     [-BackupSet] <WBBackupSet>
     [-ApplicationInBackup] <WBApplication>
     [[-RecoveryTarget] <String>]
     [-NoRollForward]
     [-Async]
     [-Force]
     [<CommonParameters>]

Description

The Start-WBApplicationRecovery cmdlet starts an application recovery operation. To perform application recovery, you must specify the backup set from which to recover the application and the application to recover. The application to recover must exist in the application array for the backup set specified. If you do not specify a recovery target, the operation recovers the application to the application's original location.

Examples

Example 1: Start an application recovery operation 

PS C:\> $Backup = Get-WBBackupSet
PS C:\> Start-WBApplicationRecovery -BackupSet $Backup -ApplicationInBackup $Backup.Application[0] -RecoveryTarget "F:\"
Warning
Start recovery of application Registry to F:\ ? 
 [Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y
Recovering component Registry : 
Recovering component Registry : Preparing to recover. 
Completed.

This example recovers an application to a file path.

The first command gets the backup object from the system catalog and stores it in the variable named $Backup.

The second command starts the recovery by specifying $Backup as the backup set, and specifying the first element of the application array within the backup set. The first element of the application array is the registry.

Required Parameters

-ApplicationInBackup

Specifies an application object that contains the application that this cmdlet recovers. This application must exist in the backup set's application array.

Type: WBApplication
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-BackupSet

Specifies a backup set object that contains the backup set from which to recover the application.

Type: WBBackupSet
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-Async

Indicates that Windows PowerShell returns immediately after starting the backup without displaying status messages to the console.

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

Forces the command to run without asking for user confirmation.

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

Indicates that this cmdlet recovers applications 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.

Type: SwitchParameter
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-RecoveryTarget

Specifies the path to which the recovery operation recovers the application.

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

Inputs

WBBackupSet, WBApplication

Outputs

System.String

If you do not specify the Async parameter, the recovery operation displays status messages at periodic intervals until the recovery is complete. While the recovery operation is running, you can use the Get-WBJob cmdlet to get the status of the operation. After the operation is complete you can use the Get-WBJob -Previous 1 command to get the completed recovery status.