Start-VBRNASInstantRecovery

In this article

    Short Description

    Starts an instant restore of backups created by the file share backup job.

    Applies to

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

    Syntax

    Start-VBRNASInstantRecovery [-RestorePoint] <VBRNASBackupRestorePoint[]> [-Permissions] <VBRNASPermissionSet[]>  [[-MountOptions] <VBRNASInstantRecoveryMountOptions>] [-Reason <string>] [-RunAsync] [-WaitAllSessions]  [<CommonParameters>]

    Detailed Description

    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.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    RestorePoint

    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

    0

    True (ByValue, ByPropertyName)

    Permissions

    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.

    True

    1

    False

    MountOptions

    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.

    False

    2

    False

    Reason

    Specifies the reason for starting the instant restore of NAS backups.

    String

    False

    Named

    False

    RunAsync

    Defines that the command returns immediately without waiting for the task to complete.

    SwitchParameter

    False

    Named

    False

    WaitAllSessions

    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.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    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.

    Examples

    Start-VBRNASInstantRecoveryExample 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.

    $backup = Get-VBRNASBackup -Name "Daily SMB1 Backup"
    $nasBackupPoint = Get-VBRNASBackupRestorePoint -NASBackup $backup
    $permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -AllowEveryone
    Start-VBRNASInstantRecovery -RestorePoint $nasBackupPoint[0] -Permissions $permissions -Reason "Test instant restore for NAS"

    1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRNASBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
    3. Run the New-VBRNASPermissionSet cmdlet. Specify the RestorePoint, Owner and AllowEveryone parameter values.
    4. Run the Start-VBRNASInstantRecovery cmdlet. Specify the following parameters:
    • Specify the first value from the array returned to the $nasBackupPoint variable as the RestorePoint parameter.
    • Set the $permissions variable as the Permissions parameter value.
    • Specify the Reason parameter.

    Start-VBRNASInstantRecoveryExample 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.

    $backup = Get-VBRNASBackup -Name "Daily SMB1 Backup"
    $nasBackupPoint = Get-VBRNASBackupRestorePoint -NASBackup $backup
    $permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -AllowEveryone
    $manualMapping = New-VBRNASInstantRecoveryMountOptions -RestorePoint $nasBackupPoint[0] -MountServer "172.17.20.3"
    Start-VBRNASInstantRecovery -RestorePoint $nasBackupPoint[0] -Permissions $permissions -MountOptions $manualMapping -Reason "Test instant restore for NAS"

    1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRNASBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
    3. Run the New-VBRNASPermissionSet cmdlet. Specify the RestorePoint, Owner and AllowEveryone parameter values.
    4. Run the New-VBRNASInstantRecoveryMountOptions cmdlet. Specify the RestorePoint and MountServer parameter values.
    1. Run the Start-VBRNASInstantRecovery cmdlet. Specify the following parameters:
    • Specify the first value from the array returned to the $nasBackupPoint variable as the RestorePoint parameter.
    • Set the $permissions variable as the Permissions parameter value.
    • Set the $manualMapping variable as the MountOptions parameter value.
    • Specify the Reason parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.