Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Start-VBRTapeRestoreFiles (obsolete)

Short Description

Starts files restore from tape.

Start-VBRTapeRestoreFiles (obsolete) 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.

Applies to

Platform: VMware, Hyper-V

Syntax

Start-VBRTapeRestoreFiles [-Files <CatalogueFile[]>] [-Version <CatalogueFileVersion[]>] -Server <CHost> -Path <String> [-PreserveHierarhy] [-Overwrite <RestoreOverwrite>] [-Security] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<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

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Files

Specifies the files to restore. The most recent file version is used.

False

Named

True (ByValue,
ByProperty
Name)

False

Version

Specifies the version of the files you want to restore.

False

Named

True (ByValue,
ByProperty
Name)

False

Server

Specifies the source host where the files to restore are located.

True

Named

False

False

Path

Specifies the path to the files to restore.

True

Named

False

False

Preserve
Hierarhy

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.

False

Named

False

False

Overwrite

Indicates 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.

False

Named

False

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.

False

Named

True (ByValue,
ByProperty
Name)

False

RunAsync

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

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command starts restoring the file named "VM01 Backup Job 1.vbm". The file to restore is obtained with Find-VBRTapeCatalog and piped down.

  • The host to look for files on is obtained with Get-VBRServer and assigned to the $server variable beforehand,
  • The file path is "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm",
  • The -PreserveHierarhy parameter is set to retain the original folder hierarchy,
  • The -Overwrite parameter is set to Newer,
  • The RunAsync parameter is set to bring the process to the background.

PS C:\PS> 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

Example 2

This command restores a specific version of the file named "VM01 Backup Job 1.vbm". The file version is obtained with Find-VBRTapeCatalogVersion and assigned to the $fileversion variable beforehand.

  • The host to look for files on is obtained with Get-VBRServer and assigned to the $server variable beforehand,
  • The file path is "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm",
  • The -PreserveHierarhy parameter is set to retain the original folder hierarchy,
  • The -Overwrite parameter is set to Always,
  • The RunAsync parameter is set to bring the process to the background.

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

Related Commands

Get-VBRServer

Find-VBRTapeCatalog

Find-VBRTapeCatalogVersion

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation