Start-VBRUnstructuredBackupFLRSession

Short Description

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

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

Syntax

This cmdlet provides the following parameter sets:

RestorePoint

Start-VBRUnstructuredBackupFLRSession -RestorePoint <VBRUnstructuredBackupRestorePoint>

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

AllTime

Start-VBRUnstructuredBackupFLRSession -Backup <VBRUnstructuredBackup> -Server <VBRUnstructuredServer>

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

Detailed Description

This cmdlet mounts backup content and allows you to restore files, folders and objects that are backed-up by file backup jobs or object storage 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 or object storage. 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 and object storage backup jobs.

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

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies the backup file. The cmdlet will start a file-level restore to recover all versions of a backup file that is located on the short-term and long-term repositories. Accepts the `VBRUnstructuredBackup` object. To get this object, run the `Get-VBRUnstructuredBackup` cmdlet.	`VBRUnstructuredBackup`	True	Named	True (ByPropertyName, ByValue)
Force	Defines that the cmdlet will start a restore session without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
RestorePoint	Specifies a restore point. The cmdlet will start a restore of files, folders or individual objects. This parameter set recovers backup files or objects to the specified restore point. Accepts the `VBRUnstructuredBackupRestorePoint` object. To get this object, run the `Get-VBRUnstructuredBackupRestorePoint` cmdlet.	`VBRUnstructuredBackupRestorePoint`	True	Named	True (ByPropertyName, ByValue)
RetrievalSettings	Specifies the retrieval policy settings. The cmdlet will use these settings to retrieve data from archive 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
Server	Specifies file shares or object storage. The cmdlet will start a restore of files, folders or individual objects. This parameter set recovers backup files or objects to the specified restore point. Accepts the `VBRUnstructuredServer` object. To get this object, run the `Get-VBRUnstructuredServer` cmdlet.	`VBRUnstructuredServer`	True	Named	True (ByPropertyName)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRUnstructuredBackupFLRSession 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 and object storage backup jobs.

Examples

Start-VBRUnstructuredBackupFLRSession Example 1. Restoring Backups on Specific Object Storage

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

$backup = Get-VBRUnstructuredBackup

$server = Get-VBRUnstructuredServer -Backup $backup

Start-VBRUnstructuredBackupFLRSession -Backup $backup -Server $server

Perform the following steps:

Run the Get-VBRUnstructuredBackup cmdlet. Save the result to the $backup variable.
Run the Get-VBRUnstructuredServer cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $server variable.
Run the Start-VBRUnstructuredBackupFLRSession cmdlet. Set the $backup variable as the Backup parameter value. Set the $server variable as the Server parameter value.

Start-VBRUnstructuredBackupFLRSession Example 2. Restoring Backups to Specific Restore Point

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

$restorepoint = Get-VBRUnstructuredBackupRestorePoint

Start-VBRUnstructuredBackupFLRSession -RestorePoint $restorepoint[3]

Perform the following steps:

Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
The Get-VBRUnstructuredBackupRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the fourth restore session in the array).
Run the Start-VBRUnstructuredBackupFLRSession cmdlet. Set the $restorepoint[3] variable as the RestorePoint parameter value.