Starts an instant restore of backups created by the file share backup job.
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Start-VBRNASInstantRecovery [-RestorePoint] <VBRNASBackupRestorePoint> [-Permissions] <VBRNASPermissionSet> [[-MountOptions] <VBRNASInstantRecoveryMountOptions>] [-Reason <string>] [-RunAsync] [-WaitAllSessions] [<CommonParameters>]
This cmdlet starts an instant restore of backups created by the file share backup job. It starts agents, creates a file share on the specified repository (the file share name is retrieved from the file share backup) and creates records in the database.
Accept Pipeline Input
Specifies an array of restore points. The cmdlet will start an instant recovery for each of the specified restore points.
Accepts the VBRNASBackupRestorePoint object. To get this object, run the Get-VBRNASBackupRestorePoint cmdlet.
True (ByValue, ByPropertyName)
Specifies an array of permission sets. The cmdlet will start an instant recovery by applying these permission sets.
Accepts the VBRNASPermissionSet object. To create this object, run the New-VBRNASPermissionSet cmdlet.
Specifies a mapping configuration for instant restore of NAS backups.
If the parameter is not defined, the cmdlet will use automatic mapping.
Accepts the VBRNASInstantRecoveryMountOptions object. To create this object, run the New-VBRNASInstantRecoveryMountOptions cmdlet.
Specifies the reason for starting the instant restore of NAS backups.
Defines that the command returns immediately without waiting for the task to complete.
If the parameter is set to True, the cmdlet will wait for all sessions to finish before returning the result. In this case, the result is sorted according to the order in which restore points are specified. Sessions are also started in this order.
If the parameter is set to False, the cmdlet will return the result after each session finishes. In this case, the result is returned in nondeterministic order.
Note: This parameter is used with the RunAsync parameter that must be set to False.
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
The cmdlet returns the VBRNASInstantRecovery object that defines the following settings: session ID, backup name (the same as the job name), creation time of the used restore point, job type (it is always equal to EDbJobType.InstantFileShareRestore), ID and name of the mount server where the restore was started, UNC path of the published SMB share with NAS backup contents, session name, permission settings, mount state.
Example 1. Starting Instant Restore for NAS Backups with Automatic Mapping
The following example shows how to start instant restore for NAS backups with automatic mapping.
Example 2. Starting Instant Restore for NAS Backups with Manual Mapping
The following example shows how to start instant restore for NAS backups with manual mapping.