Restore-VBRUnstructuredBackupFLRItem

Short Description

Restores objects backed up by file backup jobs or object storage backup jobs to original file shares or object storage.

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

Syntax

Restore-VBRUnstructuredBackupFLRItem -Item <VBRUnstructuredBackupFLRItem[]> [-Overwrite] [-RunAsync]

[-ChangedItemsOnly] [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet restores specific files and folders backed up by file backup jobs or object storage backup jobs. The cmdlet will restore files and folders to original file shares or object storage.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ChangedItemsOnly	Defines whether to restore changed files and folders only.	`SwitchParameter`	False	Named	False
Force	Defines that the cmdlet will restore unstructured data backups without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Item	Specifies an array of backed-up objects. The cmdlet will restore these objects to the original file share or object storage. Accepts the `VBRUnstructuredBackupFLRItem[]` object. To get this object, run the `Get-VBRUnstructuredBackupFLRItemVersion` cmdlet.	`VBRUnstructuredBackupFLRItem[]`	True	Named	True (ByPropertyName, ByValue)
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 or object storage server with the version of an object from a backup. Otherwise, an existing object will not be overwritten.	`SwitchParameter`	False	Named	False
RetrievalSettings	Specifies the retrieval policy settings. The cmdlet will use these settings to retrieve data from archive object storage repositories. Note: If you do not provide this parameter, the cmdlet will prompt you to use the default retrieval policy settings. Accepts the `VBRUnstructuredBackupColdStorageRetrievalSettings` object. To create this object, run the `New-VBRUnstructuredBackupColdStorageRetrievalSettings` cmdlet.	`VBRUnstructuredBackupColdStorageRetrievalSettings`	False	Named	False
RunAsync	Defines 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 Microsoft Docs.

Output Object

The cmdlet returns the VBRUnstructuredBackupFLRItem object that contains information on backed-up objects that have been restored to original file shares or object storage.

Examples

Restore-VBRUnstructuredBackupFLRItem Example 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.

$restorepoint = Get-VBRUnstructuredBackupRestorePoint

$session = Start-VBRUnstructuredBackupFLRSession -RestorePoint $restorepoint

$files = Get-VBRUnstructuredBackupFLRItem -Session $session

$fileversion = Get-VBRUnstructuredBackupFLRItemVersion -Item $files

Restore-VBRUnstructuredBackupFLRItem -Item $fileversion[0]

Perform the following steps:

Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Start-VBRUnstructuredBackupFLRSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $session variable.
Run the Get-VBRUnstructuredBackupFLRItem cmdlet. Set the $session variable as the Session parameter value. Save the result to the $files variable.
Run the Get-VBRUnstructuredBackupFLRItemVersion cmdlet. Set the $files variable as the Item parameter value. Save the result to the $fileversion variable.
Run the Restore-VBRUnstructuredBackupFLRItem cmdlet. Set the $fileversion variable as the Item parameter value.

Restore-VBRUnstructuredBackupFLRItem Example 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-VBRUnstructuredBackupRestorePoint

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

$files = Get-VBRUnstructuredBackupFLRItem -Session $session

Restore-VBRUnstructuredBackupFLRItem -Item $files -Overwrite

Perform the following steps:

Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Start-VBRUnstructuredBackupFLRSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $session variable.
Run the Get-VBRUnstructuredBackupFLRItem cmdlet. Set the $session variable as the Session parameter value. Save the result to the $files variable.
Run the Restore-VBRUnstructuredBackupFLRItem cmdlet. Set the $files variable as the Item parameter value. Provide the Overwrite parameter.