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

Start-VBRTapeRestore (obsolete)

Short Description

Starts VM restore from tape.

Start-VBRTapeRestore (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-VBRTapeRestore -RestorePoint <COib[]> -Repository <CBackupRepository> [-Reason <string>] [-RunAsync][<CommonParameters>]

-OR-

Start-VBRTapeRestore -RestorePoint <COib[]> -Server <CHost> -Path <string> [-Reason <string>] [-RunAsync][<CommonParameters>]

Detailed Description

This cmdlet starts restoring VMs from backup copied to tape.

You can restore VMs to a chosen backup repository or to a folder on the server you specify. Choose an appropriate syntax for each option.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RestorePoint

Specifies the particular restore point(s) of the VM.

You can assign multiple restore points to this object.

True

Named

True (ByValue,
ByProperty
Name)

False

Repository

Specifies the backup repository where you want to restore the VM.

True

Named

False

False

Reason

Specifies the reason for restore.

False

Named

False

False

Server

Specifies the server where you want to restore the VM.

True

Named

False

False

Path

Specifies the path to the folder where you want to restore the VM.

True

Named

False

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 a VM named "VM01" to a specified backup repository.

  • The VM01 restore point is obtained with Get-VBRRestorePoint. The backup to get the restore point from is represented by the $backup variable. The most recent restore point is selected with Select method and piped down.
  • The repository to where the VM will be restored is obtained with Get-VBRBackupRepository and assigned to the $repository variable beforehand,
  • The reason for restore is "Data recovery",
  • The -RunAsync parameter is set to bring the process to the background.

PS C:\PS> Get-VBRRestorePoint -Backup $backup | Where {$_.Name -eq "VM01"} |Select -First 1 | Start-VBRTapeRestore -Repository $repository -Reason "Data recovery" -RunAsync

Example 2

This command starts restoring a VM to a specified backup repository.

  • The restore point to which the VM wil be restored is obtained with Get-VBRRestorePoint and assigned to the $rpoint variable beforehand,
  • The host to where the VM will be restored is obtained with Get-VBRServer and assigned to the $server variable beforehand,
  • The path to the folder where the VM will be restored is "c:\Restored",
  • The -Reason parameter is not set,
  • The -RunAsync parameter is set to bring the process to the background.

PS C:\PS> Start-VBRTapeRestore -RestorePoint $rpoint -Server $server -Path "c:\Restored' -RunAsync

Related Commands

Get-VBRRestorePoint

Get-VBRBackupRepository

Get-VBRServer

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