This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRWindowsFileRestore

Short Description

Starts Windows VM guest OS file restore.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRWindowsFileRestore [-RestorePoint] <COib> [[-Host] <CHost>] [[-ResourcePool] <CViResourcePoolItem>] [[-Folder] <CViFolderItem>] [-Reason <string>] [-Credentials <CCredentials>] [<CommonParameters>]

Detailed Description

This cmdlet allows you to restore files stored on disks of VM running Windows or from Veeam Agent for Microsoft Windows backups.

This cmdlet mounts the disks of the backed up VM(s) to the Veeam backup server or other server in your virtual infrastructure. The disks are published directly from the backup file. After the disks are mounted, you can copy the needed files to any disk or folder accessible by Veeam backup server.

To stop the file restore session and unmount the disks, run Stop-VBRWindowsFileRestore.

Start-VBRWindowsFileRestore Important!

You must save the restore session to a variable when you run this cmdlet. Otherwise you will no be able to finalize the restore session with PowerShell.

Run Start-VBRRestoreVMFiles to restore VM configuration files.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
RestorePoint	Specifies the restore point of a VM or a Veeam Agent for Microsoft Windows backup from which you want to restore files.	True	1	True (ByValue, ByProperty Name)	False
Reason	Specifies the string with the reason for performing file restore.	False	Named	False	False
Host	Specifies the host to which the snapshot clone/virtual copy must be mounted and on which the temporary VM must be created.	False	2	False	False
Resource Pool	Specifies the resource pool to which the temporary VM must be placed.	False	3	False	False
Folder	Specifies the folder to which the temporary VM must be placed.	False	4	False	False
Credentials	Specifies the credentials to authenticate with the backup share folder.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example 1

This example shows how to start a restore session for Windows VM guest OS files.

Run Get-VBRBackup to get a backup that contains files which you want to restore. Save the result to the $backup variable.
Run Get-VBRRestorePoint with the $backup variable to get a restore point of a VM. Use the Name parameter to specify the VM name. Save the result to the $restorepoint variable.
Run Start-VBRWindowsFileRestore with the $restorepoint variable. Save the result to the $flerestore variable.

$backup = Get-VBRBackup

$restorepoint = Get-VBRRestorePoint -Backup $backup -Name "Production VM"

$flerestore = Start-VBRWindowsFileRestore -RestorePoint $restorepoint

Example 2

This example shows how to start a restore session for Windows VM guest OS files and restore them to the specified folder.

Run Get-VBRBackup to get a backup that contains files which you want to restore. Save the result to the $backup variable.
Run Get-VBRRestorePoint with the $backup variable to get a restore point of a VM. Use the Name parameter to specify the VM name. Save the result to the $restorepoint variable.
Run Start-VBRWindowsFileRestore with the $restorepoint variable.
Run Get-VBRCredentials to get credentials for the VM. Save the result to the $credentials variable.
Run Get-VBRRestoreSession to get a restore session. Save the result to the $session variable.
Run Start-VBRWindowsGuestItemRestore with the $session and the $credentials variables. Use the RestorePolicy parameter to specify the restore policy.

$backup = Get-VBRBackup

$restorepoint = Get-VBRRestorePoint -Backup $backup -Name "Production VM"

Start-VBRWindowsFileRestore -RestorePoint $restorepoint

$credentials = Get-VBRCredentials -Name "CRM DB Administrator"

$session = Get-VBRRestoreSession

Start-VBRWindowsGuestItemRestore -Path "C:\Files\" -Session $session -RestorePolicy Keep -GuestCredentials $credentials

Related Commands

Get-VBRRestorePoint

Get-VBRServer

Find-VBRViResourcePool

Find-VBRViFolder

Stop-VBRWindowsFileRestore

Start-VBRWindowsGuestItemRestore