Start-VBRWindowsFileRestore
Short Description
Starts Windows VM guest OS file restore session.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Start-VBRWindowsFileRestore -RestorePoint <COib> [-Host <CHost>] [-ResourcePool <CViResourcePoolItem>] [-Folder <CViFolderItem>] [-Reason <string>] [-Credentials <CCredentials>] [<CommonParameters>] |
Detailed Description
This cmdlet starts a restore session of Windows VM guest OS files.
The cmdlet mounts disks of a machine from the backup or replica to the mount server. After that you can perform the following actions:
- Run the Get-VBRWindowsGuestItem cmdlet to get details on the files and folders that are available for restore.
- Run the Start-VBRWindowsGuestItemRestore cmdlet to restore the necessary files and folders.
After you restore the necessary files, you must stop the restore session. After you stop the session, Veeam Backup & Replication will unmount disks from the mount server. Run the Stop-VBRWindowsFileRestore cmdlet to stop the restore session.
Tip |
To start a restore session for a CDP replica, use the Start-VBRCDPWindowsFileRestore cmdlet. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
RestorePoint | Specifies a restore point to start a restore session. You will be able to use the session to perform operations with machine guest OS files. | Accepts the COib object. To create this object, run the Get-VBRRestorePoint cmdlet. | True | 1 | True (ByValue, |
Host | Specifies the mount server to which machine disks will be mounted. Note: This parameter works only if you start a restore session of machine disks located on storage that use the Direct SAN access transport mode. If you start a restore session of machine disks located on storage that use the other transport mode methods, the cmdlet will mount machine disks to the source storage. | Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet. | False | 2 | False |
ResourcePool | Specifies a resource pool. The cmdlet will register the mount server to this resource pool. | Accepts the CViResourcePoolItem object. To create this object, run the Find-VBRViEntity cmdlet. | False | 3 | False |
Folder | Specifies a folder on the mount server. The cmdlet will place the machine disks under this folder. | Accepts the CViFolderItem object. To create this object, run the Find-VBRViEntity cmdlet. | False | 4 | False |
Reason | Specifies the reason for starting a restore session of machine guest OS files. The information you provide will be saved in the session history so that you can reference it later. | String | False | Named | False |
Credentials | Specifies the credentials to authenticate with the backup share folder. | Accepts the CCredentials object. To create this object, run the Get-VBRCredentials cmdlet. | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the FileRestore object that contains settings of a restore session of Windows guest OS files.
Examples
Example 1. Starting Restore Session for Windows Guest OS Files
Example 2. Starting Restore Session for Windows Guest OS Files from Latest Restore Point [Using Pipeline]
Related Commands
