Save-VBRNASBackupFLRItem

Short Description

Restore objects backed up by file backup jobs to the specified file shares.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Save-VBRNASBackupFLRItem -Item <VBRNASBackupFLRItem[]> -Server <VBRNASServer> -Path <string> [-PreservePermissions] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet restores objects backed up by file backup jobs to the specified file shares.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Item

Specifies an array of backed-up object. The cmdlet will restore these objects to the file share.

[For restore of backups to the specific restore point]: Accepts the VBRNASBackupFLR Item[] object. To get this object, run the Get-VBRNASBackupFLRItem cmdlet.

[For all versions of backups restore]:

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

True

Named

True (ByValue, ByPropertyName)

 

Server

Specifies a file share. The cmdlet will restore the backed-up object to this file share.

Accepts the VBR NASServer object. To get this object, run the Get-VBRNASServer cmdlet.

True

Named

False

 

Path

Specifies a path on a file share. The cmdlet will restore the backed-up object to that path.

String

False

Named

False

 

PreservePermissions

Defines that the cmdlet will restore permissions and security attributes of objects that you want to save.

If you provide this parameter, the cmdlet will restore backup files with security attributes and permissions set by the user. Otherwise, permissions and security attributes of restored backups will not be recovered.

SwitchParamter

False

Named

False

 

RunAsync

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

SwitchParamter

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 VBRNASBackupFLRItem and VBRNASBackupFLRFolder objects that contain settings of restored guest OS files and folders that have been backed up by file backup jobs.

Examples

Save-VBRNASBackupFLRItemExample 1. Restoring All Objects to File Shares

This example shows how to restore all backed-up files and folders to the \\WinSrv\Reports file share. Veeam Backup & Replication will save files and folders to the \\WinSrv\Reports\Restored folder on the file share.

$session = Get-VBRNASBackupFLRSession

$fileshare = Get-VBRNASServer -Name "\\WinSrv\Reports"

$files = Get-VBRNASBackupFLRItem -Session $session

Save-VBRNASBackupFLRItem -Item $folder -Server $fileshare -Path "\\WinSrv\Reports\Restored"

Perform the following steps:

  1. Run the Get-VBRNASBackupFLRSession cmdlet. Save the result to the $session variable.
  2. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $fileshare variable.
  3. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $session variable as the Session parameter value.
  4. Run the Save-VBRNASBackupFLRItem cmdlet. Specify the following settings:
  • Set the $folder variable as the Item parameter value.
  • Set the $fileshare variable as the Server parameter value.
  • Specify the Path parameter value.

Save-VBRNASBackupFLRItemExample 2. Restoring Specific Folder to File Shares

This example shows how to restore the October Reports folder to the \\WinSrv\Reports file share. Veeam Backup & Replication will save files and folders to the \\WinSrv\Reports\Restored folder on the file share.

$session = Get-VBRNASBackupFLRSession

$fileshare = Get-VBRNASServer -Name "\\WinSrv\Reports"

$folder = Get-VBRNASBackupFLRItem -Session $session -Name "October Reports"

Save-VBRNASBackupFLRItem -Item $folder -Server $fileshare -Path "\\WinSrv\Reports\Restored"

Perform the following steps:

  1. Run the Get-VBRNASBackupFLRSession cmdlet. Save the result to the $session variable.
  2. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $fileshare variable.
  3. Run the Get-VBRNASBackupFLRItem cmdlet. Specify the Name parameter value. Set the $session variable as the Session parameter value. Save the result to the $folder variable.
  4. Run the Save-VBRNASBackupFLRItem cmdlet. Specify the following settings:
  • Set the $folder variable as the Item parameter value.
  • Set the $fileshare variable as the Server parameter value.
  • Specify the Path parameter value.

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.