Start-VBRTapeRestore (obsolete)

Short Description

Starts VM 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.

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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
RestorePoint	Specifies the particular restore points of the VM. You can assign multiple restore points to this object.	Accepts the COib[] object. To get this object, run the Get-VBRRestorePoint cmdlet.	True	Named	True (ByValue, ByProperty Name)
Repository	Specifies the backup repository where you want to restore the VM.	Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.	True	Named	False
Reason	Specifies the reason for restore.	String	False	Named	False
Server	Specifies the server where you want to restore the VM.	Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.	True	Named	False
Path	Specifies the path to the folder where you want to restore the VM.	String	True	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False

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

Examples

Example 1. Starting VM Restore from Tape to Specific Backup Repository

This example shows how to start restoring the VM01 VM to a specified backup repository.

$backup = Get-VBRBackup -Id "d6b08a78-f405-400a-bb02-a132cf1778fa"

$repository = Get-VBRBackupRepository -Name "Backups Vol2"

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

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Id parameter value. Save the result to the $backup variable.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value.
Pipe the cmdlet output to the Where cmdlet to filter restore points by the Name property.
Pipe the cmdlet output to the Select cmdlet and specify the First parameter value.
Run the Start-VBRTapeRestore cmdlet. Set the $repository variable as the Repository parameter value. Specify the Reason parameter value. Provide the RunAsync parameter.

Example 2. Starting VM Restore from Tape to Specific Server

This example shows how to start restoring the VM01 VM to a specified server.

$rpoint = Get-VBRRestorePoint -Id 2ee79fec-9aa8-4058-a147-ff6b76ef2924

$server = Get-VBRServer -Name "srv001"

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

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Id parameter value. Save the result to the $rpoint variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Start-VBRTapeRestore cmdlet. Specify the following settings:

Set the $rpoint variable as the RestorePoint parameter value.
Set the $server variable as the Server parameter value.
Specify the Path parameter value.
Provide the RunAsync parameter.

Related Commands