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 VM files 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>] |
Related Commands
Detailed Description
This cmdlet allows you to restore files stored on disks of VM running Windows or from Endpoint 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.
|
You need to save the restore session to a variable when you run this cmdlet. Otherwise you will be unable to finalize the restore session with PowerShell. |
Run Start-VBRRestoreVMFiles to restore VM configuration files.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
RestorePoint | Specifies the restore point of a VM or an Endpoint backup from which you want to restore files. | True | 1 | True (ByValue, | 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 | 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 |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This example shows how to perform the whole file restore process.
- A new file level restore session is initiated with by running Start-VBRWindowsFileRestore:
- The list of available restore points produced by the backup job 'Job 1' is obtained with Get-VBRRestorePoint and piped down.
- The restore points are sorted with Sort-Object method by the "creationtime" property to get the most recent one.
- The restore session is assigned to the $result variable.
- To copy the files, you need to obtain the mount point for the target mounted volume:
- The path is obtained with the MountSession.MountedDevices property which helps to map the mounted volumes to drives letters of the original VM.
- The mount point is assigned to the $flrmountpoint variable.
- The mount point is used to obtain the path to the files. The path is assigned to the $file variable.
- The files are copied to the root of C:\ drive.
- The file restore session is stopped with Stop-VBRWindowsFileRestore.
PS C:\PS> $result = Get-VBRBackup | where {$_.jobname -eq "Job 1"} | Get-VBRRestorePoint | where {$_.name -eq "VM1"} | Sort-Object creationtime -Descending | Select-Object -First 1 | Start-VBRWindowsFileRestore PS C:\PS> $flrmountpoint = ($result.MountSession.MountedDevices | ? {$_.DriveLetter -eq (Split-Path -Qualifier $origfile)}).MountPoint PS C:\PS> $file = $flrmountpoint + (Split-Path -NoQualifier $origfile) PS C:\PS> Copy $file c:\ PS C:\PS> Stop-VBRWindowsFileRestore $result |