Start-VBRApplicationBackupSnapshotRecovery

Short Description

Starts recovery from an application backup repository snapshot.

Platform: VMware, Hyper-V

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Start-VBRApplicationBackupSnapshotRecovery -Snapshot <VBRApplicationBackupSnapshot> [-Reason <String>] [-Force]

[-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet starts a recovery session from an application backup repository snapshot. Veeam Backup & Replication will revert the snapshot to export its data by its original NFS path.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will start recovery without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason for starting recovery. The information you provide will be saved in the session history so that you can reference it later.	`String`	False	Named	False
RunAsync	Defines that the cmdlet will run the recovery operation asynchronously. The cmdlet returns a session object immediately without waiting for the recovery to complete.	`SwitchParameter`	False	Named	False
Snapshot	Specifies the snapshot from which you want to recover the application backup repository. Accepts the `VBRApplicationBackupSnapshot` object. To get this object, run the `Get-VBRApplicationBackupSnapshot` cmdlet.	`VBRApplicationBackupSnapshot`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRSession object that contains information about the recovery session.

Examples

Starting Recovery from Application Backup Repository Snapshot

This example shows how to start recovery from an application backup repository snapshot.

$snapshot = Get-VBRApplicationBackupSnapshot -Name "ApplicationBackupSnapshot01"

Start-VBRApplicationBackupSnapshotRecovery -Snapshot $snapshot

Perform the following steps:

Run the Get-VBRApplicationBackupSnapshot cmdlet. Specify the Name parameter value. Save the result to the $snapshot variable.
Run the Start-VBRApplicationBackupSnapshotRecovery cmdlet. Set the $snapshot variable as the Snapshot parameter value.

Get-VBRApplicationBackupSnapshot