Start-VBRTapeRestoreFiles (obsolete)

Short Description

Starts files restore from tape.

Note

This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore operation with Veeam Backup & Replication UI for full functionality

Platform: VMware, Hyper-V

Syntax

Start-VBRTapeRestoreFiles [-Files <CatalogueFile[]>] [-Version <CatalogueFileVersion[]>] -Server <CHost>

-Path <String> [-PreserveHierarhy] [-Overwrite <RestoreOverwrite>] [-Security] [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet starts restoring files from backup copied to tape. You can restore file to its most recent state or to any of its backup version. The versions of files are used as restore points.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Files	Specifies the files to restore. The most recent file version is used. Accepts the `CatalogueFile[]` object. To get this object, run the `Find-VBRTapeCatalog` cmdlet.	`CatalogueFile[]`	False	Named	True (ByPropertyName, ByValue)
Overwrite	Specifies the overwrite options in case the file exists on the target side: `None` — leave the original file `Newer` — overwrite the file if the restore file in newer `Always` — overwrite the existing file	`RestoreOverwrite`	False	Named	False
Path	Specifies the path to the files to restore.	`String`	True	Named	False
PreserveHierarhy	If indicated, the files and folders will be restored in respect to the original folder hierarchy. Otherwise all files and folders are restored into a plain sequence.	`SwitchParameter`	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Security	If indicated, the files will be restored with with the original security settings. Otherwise the file/folder security settings will be inherited from parent item.	`SwitchParameter`	False	Named	False
Server	Specifies the source host where the files to restore are located.	`CHost`	True	Named	False
Version	Specifies the version of the files you want to restore. Accepts the `CatalogueFileVersion[]` object. To get this object, run the `Find-VBRTapeCatalogVersion` cmdlet.	`CatalogueFileVersion[]`	False	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Start-VBRTapeRestoreFiles (obsolete) Example 1. Restoring File from Tape [Using Pipeline]

This example shows how to start restoring the VM01 Backup Job 1.vbm file.

$server = Get-VBRServer -Name "srv001"

Find-VBRTapeCatalog -Name "VM01 Backup Job 1.vbm" | Start-VBRTapeRestoreFiles -Server $server -Path "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm" -PreserveHierarhy -Overwrite Newer -Security -RunAsync

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Find-VBRTapeCatalog cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Start-VBRTapeRestoreFiles cmdlet. Specify the following settings:
- Set the $server variable as the Server parameter value.
- Specify the Path parameter value.
- Provide the PreserveHierarhy parameter value.
- Set the Newer option for the Overwrite parameter.
- Provide the Security parameter value.
- Provide the RunAsync parameter value.

Start-VBRTapeRestoreFiles (obsolete) Example 2. Restoring Specific Version of File from Tape [Using Variable]

This example shows how to restore a specific version of the VM01 Backup Job 1.vbm file.

$file = Find-VBRTapeCatalog -Name "VM01 Backup Job 1.vbm"

$fileversion = Find-VBRTapeCatalogVersion -CatalogFile $file

$server = Get-VBRServer -Name "srv001"

Start-VBRTapeRestoreFiles -Version $fileversion -Server $server -Path "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm" -PreserveHierarhy -Overwrite Always

Perform the following steps:

Run the Find-VBRTapeCatalog cmdlet. Specify the Name parameter value. Save the result to the $file variable.
Run the Find-VBRTapeCatalogVersion cmdlet. Set the $file variable as the CatalogFile parameter value. Save the result to the $fileversion variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Pipe the cmdlet output to the Start-VBRTapeRestoreFiles cmdlet. Specify the following settings:
- Set the $fileversion variable as the Version parameter value.
- Set the $server variable as the Server parameter value.
- Specify the Path parameter value.
- Provide the PreserveHierarhy parameter value.
- Set the Always option for the Overwrite parameter.