Start-VBRApplicationBackupSnapshotInstantRecovery

Short Description

Starts instant recovery from an application backup repository snapshot.

Platform: VMware, Hyper-V

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

Syntax

Start-VBRApplicationBackupSnapshotInstantRecovery -Snapshot <VBRApplicationBackupSnapshot> -MountPath <String>

[-Reason <String>] [-Force] [-RepositoryPermissions <VBRApplicationBackupRepositoryPermission[]>]

[-EnableKerberosPermissions] [-KerberosPermissions <VBRApplicationBackupRepositoryKerberosPermission[]>] [<CommonParameters>]

Detailed Description

This cmdlet starts an instant recovery session from an application backup repository snapshot. Veeam Backup & Replication mounts the snapshot to the temporary NFS path and makes the application data available for browsing and selective restore.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
EnableKerberosPermissions	Enables Kerberos authentication for accessing the temporary NFS share.	`SwitchParameter`	False	Named	False
Force	Defines that the cmdlet will start instant recovery without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
KerberosPermissions	Specifies permissions for accessing the temporary NFS share with Kerberos credentials. Accepts the `VBRApplicationBackupRepositoryKerberosPermission`[] object. To create this object, run the `New-VBRKerberosPermission` cmdlet.	`VBRApplicationBackupRepositoryKerberosPermission[]`	False	Named	False
MountPath	Specifies the temporary NFS path to which Veeam Backup & Replication will mount the application backup repository snapshot for browsing and selective restore.	`String`	True	Named	False
Reason	Specifies the reason for starting instant recovery. The information you provide will be saved in the session history so that you can reference it later.	`String`	False	Named	False
RepositoryPermissions	Specifies host permissions for accessing the temporary NFS share. Accepts the `VBRApplicationBackupRepositoryPermission`[] object. To create this object, run the `New-VBRApplicationBackupRepositoryPermission` cmdlet.	`VBRApplicationBackupRepositoryPermission[]`	False	Named	False
Snapshot	Specifies the snapshot to which you want to recover the application backup repository. Veeam Backup & Replication will mount the snapshot to export data. 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 instant recovery session.

Examples

Starting Instant Recovery from Application Backup Repository Snapshot

This example shows how to start instant recovery from an application backup snapshot and grant access to the NFS share for a specific host.

$snapshot = Get-VBRApplicationBackupSnapshot -Name "ApplicationBackupSnapshot01"

$permission = New-VBRApplicationBackupRepositoryPermission -ServerName "172.18.21.25" -Mode ReadWrite

Start-VBRApplicationBackupSnapshotInstantRecovery -Snapshot $snapshot -MountPath "dataset_recovery" -RepositoryPermissions $permission

Perform the following steps:

Run the Get-VBRApplicationBackupSnapshot cmdlet. Specify the Name parameter value. Save the result to the $snapshot variable.
Run the New-VBRApplicationBackupRepositoryPermission cmdlet. Specify the ServerName and Mode parameter values. Save the result to the $permission variable.
Run the Start-VBRApplicationBackupSnapshotInstantRecovery cmdlet. Set the $snapshot variable as the Snapshot parameter value. Specify the MountPath parameter value. Set the $permission variable as the RepositoryPermissions parameter value.