Restore-VBRNASBackupFLRItem

Short Description

Restore objects backed up by file backup jobs to original file shares.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Restore-VBRNASBackupFLRItem -Item <VBRNASBackupFLRItem[]> [-Overwrite] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet restores specific files and folders that have been backed up by file backup jobs. The cmdlet will restore files and folders to original file shares.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Item

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

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

[For restore of specific version of backup files]: Accepts the VBRNASBackupFLRItemVersion object. To get this object, run the Get-VBRNASBackupFLRItemVersion cmdlet.

True

Named

True (ByValue, ByPropertyName)

 

Overwrite

Defines that the cmdlet will overwrite an existing object with the restored one.

If you provide this parameter, the cmdlet will overwrite an existing object on the file share with the version of an object from a backup. Otherwise, an existing object will not be overwritten.

SwitchParameter

False

Named

False

 

RunAsync

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

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 VBRNASBackupFLRItem object that contains information on backed-up objects that have been restored to original file shares.

Examples

Restore-VBRNASBackupFLRItemExample 1. Restoring all Versions of Objects to File Share

This example shows how to restore specific versions of files and folders to the original file share. Veeam Backup & Replication will not overwrite files and folders that are already added to a file share with versions of these files and folders from a backup.

$session = Get-VBRNASBackupFLRSession

$files = Get-VBRNASBackupFLRItem -Session $session

$fileversion = Get-VBRNASBackupFLRItemVersion -Item $files

Restore-VBRNASBackupFLRItem -Item $fileversion[0]

Perform the following steps:

  1. Run the Get-VBRNASBackupFLRSession cmdlet. Save the result to the $session variable.
  2. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $session variable as the Session parameter value. Save the result to the $files variable.
  3. Run the Get-VBRNASBackupFLRItemVersion cmdlet. Set the $files variable as the Item parameter value. Save the result to the $fileversion variable.
  4. Run the Restore-VBRNASBackupFLRItem cmdlet. Set the $files variable as the Item parameter value.

Restore-VBRNASBackupFLRItemExample 2. Restoring Specific Restore Point of Objects to File Share

This example shows how to restore files and folders to the specific restore point.Veeam Backup & Replication will overwrite files and folders that are already added to a file share with versions of these files and folders from a backup.

$restorepoint = Get-VBRNASBackupRestorePoint

$session = Start-VBRNASBackupFLRSession -RestorePoint $restorepoint[3]

Get-VBRNASBackupFLRItem -Session $session

Restore-VBRNASBackupFLRItem -Item $fileversion -Overwrite

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. Save the result to the $session variable.
  3. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $session variable as the Session parameter value. Save the result to the $files variable.
  4. Run the Restore-VBRNASBackupFLRItem cmdlet. Set the $files variable as the Item parameter value. Specify the Overwrite 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.