Start-VBRNASBackupFLRSession

In this article

    Short Description

    Starts a restore session to explore objects backed-up by file backup jobs.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Start a file-level restore to recover backup files to the specified restore point.

    Start-VBRNASBackupFLRSession -RestorePoint <VBRNASBackupRestorePoint>  [<CommonParameters>]

    • Start a file-level restore to recover all versions of backup files.

    Start-VBRNASBackupFLRSession -NASBackup <VBRNASBackup> -NASServer <VBRNASServer>  [<CommonParameters>]

    Detailed Description

    This cmdlet mounts backup content and allows you to restore files and folders that are backed-up by file backup jobs. You can mount backup content to one of the following options:

    • Mount backup to the specific restore point.
    • Mount all versions of backup files that are located on the specific file share. The cmdlet will mount all versions of backup files that are located on the short-term and long-term repositories.

    You might want to use this mount session to restore specifics files and folders that are backed-up by file backup jobs.

    Run the Get-VBRNASBackupFLRItem cmdlet to get items that you want to restore.

    Run the Restore-VBRNASBackupFLRItem cmdlet to restore the necessary files and folders.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    RestorePoint

    Specifies a restore point. The cmdlet will start a file-level restore to recover backup files to the specified restore point.

    Accepts the VBRNASBackupRestorePoint object. To get this object, run the Get-VBRNASBackupRestorePoint cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

     

    NASBackup

    Specifies an array of backup files. The cmdlet will start a file-level restore to recover all versions of backup files that are located on the short-term and long-term repositories.

    Accepts the VBRNASBackup[] object. To get this object, run the Get-VBRNASBackup cmdlet.

    True

    Named

    True (ByPropertyName

     

    NASServer

    Specifies an array of file shares. The cmdlet will start a file-level restore to recover all versions of backup files that are located on the specified file shares.

    Accepts the VBRNASServer[] object. To get this object, run the Get-VBRNASServer cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

     

    <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 VBRNASBackupRestorePoint object that contains settings of restore sessions that are started to perform a file-level restore of backups that are created by file backup jobs.

    Examples

    Start-VBRNASBackupFLRSessionExample 1. Restoring Backups to Specific Restore Point

    This example shows how to start a file-level restore of backups to a specific restore point.

    $backup = Get-VBRNASBackupRestorePoint

    Start-VBRNASBackupFLRSession -RestorePoint $restorepoint

    Perform the following steps:

    1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
    2. Run the Start-VBRNASBackupFLRSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.

    Start-VBRNASBackupFLRSessionExample 2. Restoring Backups on Specific File Share

    This example shows how to start a file-level restore of backups that are located on a specific file share.

    $backup = Get-VBRNASBackup

    $server = Get-VBRNASServer

    Start-VBRNASBackupFLRSession -NASBackup $backup -NASServer $server

    Perform the following steps:

    1. Run the Get-VBRNASBackup cmdlet. Save the result to the $backup variable.
    2. Run the Get-VBRNASServer cmdlet. Save the result to the $server variable.
    3. Run the Start-VBRNASBackupFLRSession cmdlet. Set the $backup variable as the NASBackup parameter value. Set the $server variable as the NASServer parameter value.

    Related Commands