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

Start-VBRRestoreVirtualDisks

Short Description

Restores physical disks to virtual disk formats.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRRestoreVirtualDisks [-RestorePoint] <COib> [-Server] <CHost> [-Path] <string> -RestoreDiskType <EVirtualDiskRestoreType> {Vmdk | Vhd | Vhdx} [-Files <COIBFileInfo[]>] [-SourceShareCredentials <CCredentials>][-TargetShareCredentials <CCredentials>] [-Reason <string>] [-EnableAntivirusScan]
[-EnableEntireVolumeScan] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet restores physical disks from Veeam Agent for Microsoft Windows volume level backups and converts them to the following format:

  • VMDK
  • VHDX
  • VHD

The cmdlet allows you to scan the disks that you want to restore with the antivirus.

Run Start-VBRRestoreVMFiles to restore VM configuration files.

Start-VBRRestoreVirtualDisks Note:

In case the antivirus detects the virus threat, Veeam Backup & Replication will cancel the restore session.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RestorePoint

Specifies the restore point from which you want to restore the disks.

You must select restore points only from Veeam Agent for Microsoft Windows volume level backups.

True

1

True (ByValue,
ByProperty
Name)

False

Server

Specifies the Windows host to which the disks should be restored.

True

2

False

False

Path

Specifies the path to the folder on the target server where the virtual disks must be placed.

True

3

False

False

RestoreDisk
Type

Specifies the format to which you want to convert the resulting virtual disk:

  • VHD
  • VHDX
  • VMDK

True

Named

False

False

Files

Specifies the disks from the backup that you want to restore.

Default: all.

False

Named

True (ByProperty
Name)

False

SourceShareCredentials

Specifies the credentials for the backup repository. The cmdlet will export the backup from this repository.

False

Named

False

 

TargetShareCredentials

Specifies the credentials for the shared folder. The cmdlet will add the exported files to that folder.

False

Named

False

 

Reason

Specifies the reason for performing the disk restore.

False

Named

False

False

Enable
Antivirus
Scan

Indicates that the cmdlet will perform secure restore. Veeam Backup & Replication will trigger the antivirus software to scan selected machines before the restore.

False

Named

False

 

Enable
Entire
Volume
Scan

For secure restore.

Indicates that the antivirus will continue physical discs scan after the first virus threat is found. Use this option if you want to get the report on all virus threats.

False

Named

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 example shows how to restore all disks from a Veeam Agent for Microsoft Windows backup to Veeam backup server. The disks are restored to the latest restore point. The resulting format is VMDK.

  1. Run Get-VBRLocalhost to get the Veeam backup server. Save it to the $server variable.
  2. Get the most recent restore point. Run Get-VBRRestorePoint and filter the array of restore points with Sort-Object method by the "CreationTime" property. Save the result to the $restorepoint variable.
  3. Run Start-VBRRestoreVirtualDisks with the $restorepoint and $server variables.

PS C:\PS> $server = Get-VBRLocalhost

PS C:\PS> $restorepoint = Get-VBRBackup -Name "Backup Job SRV03" | Get-VBRRestorePoint | Sort-Object -Property CreationTime | Select-Object -First 1

PS C:\PS> Start-VBRRestoreVirtualDisks -RestorePoint $restorepoint -Server $server -Path "C:\SRV03_Restored" -RestoreDiskType Vmdk -RunAsync

Example 2

This example shows how to restore selected disks to a Windows server added to Veeam Backup & Replication. The disks are restored to the latest restore point. The resulting format is VHDX.

  1. Get the most recent restore point. Run Get-VBRRestorePoint and filter the array of restore points with Sort-Object method by the "CreationTime" property. Save the result to the $restorepoint variable.
  2. Run Get-VBRServer to get the server and save it to the $server variable.
  3. Run Get-VBRFilesInRestorePoint to get the disks in the backup. Save the result to the $disks variable. In this example, disks 1 and 3 will be restored.
  4. Run Start-VBRRestoreVirtualDisks. Use the $restorepoint, $server and $disks variables.

PS C:\PS> $restorepoint = Get-VBRBackup -Name "Backup Job SRV03" | Get-VBRRestorePoint | Sort-Object -Property CreationTime | Select-Object -First 1

PS C:\PS> $server = Get-VBRServer -Type Windows -Name "Veeam_Remote"

PS C:\PS> $disks = Get-VBRFilesInRestorePoint -RestorePoint $restorepoint

PS C:\PS> Start-VBRRestoreVirtualDisks -RestorePoint $restorepoint -Server $server -Path "C:\SRV03_Restored" -RestoreDiskType Vhdx -Files $disks[1,3] -RunAsync

Related Commands

Get-VBRRestorePoint

Get-VBRServer

Get-VBRFilesInRestorePoint

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation