Start-VBRWindowsFileRestore

Short Description

Starts Windows VM guest OS file restore session.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Start-VBRWindowsFileRestore [-RestorePoint] <COib> [-Reason <String>] [[-Host] <CHost>]

[[-ResourcePool] <CViResourcePoolItem>] [[-Folder] <CViFolderItem>] [-Credentials <CCredentials>]

[-ShareCredentials <CCredentials>] [-MountHost <CHost>] [-ForceArchivedSnapshotsRestore] [<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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Note: This parameter is obsolete. Use the `ShareCredentials` parameter instead, Specifies the credentials to authenticate with the backup share folder. Accepts the `CCredentials` object. To create this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	False	Named	False
Folder	For restore from storage snapshots. Specifies the folder where the temporary VM will be mounted. If you do not specify this parameter, the cmdlet will use the default VM folder of the `Host`. Accepts the `CViFolderItem` object. To create this object, run the `Find-VBRViEntity` cmdlet.	`CViFolderItem`	False	3	False
ForceArchivedSnapshotsRestore	Defines that the cmdlet will use archive snapshots for restore without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Host	For restore from storage snapshots. Specifies the ESXi host to which the storage snapshot clone will be mounted as a temporary datastore. Veeam Backup & Replication registers a temporary VM on this host and attaches the source disks to it. Note: This parameter applies only when the storage snapshot is accessed using the Direct SAN access transport mode. For other transport modes, Veeam Backup & Replicationmounts the snapshot clone to the source storage. Accepts the `CHost` object. To create this object, run the `Get-VBRServer` cmdlet.	`CHost`	False	1	False
MountHost	Specifies the mount server to which machine disks will be mounted.	`CHost`	False	Named	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
ResourcePool	For restore from storage snapshots. Specifies the resource pool where the temporary VM will be mounted. If you do not specify this parameter, the cmdlet will use the default resource pool of the `Host`. Accepts the `CViResourcePoolItem` object. To create this object, run the `Find-VBRViEntity` cmdlet.	`CViResourcePoolItem`	False	2	False
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.	`COib`	True	0	True (ByPropertyName, ByValue)
ShareCredentials	Specifies the credentials that will be used to access the shared folder. Accepts the `CCredentials` object. To create this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	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

Start-VBRWindowsFileRestore Example 1. Starting Restore Session for Windows Guest OS Files

This example shows how to start a restore session for Windows guest OS files of the WinSrv25 machine.

$backup = Get-VBRBackup -Name "WinSrv25"

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

$session = Start-VBRWindowsFileRestore -RestorePoint $restorepoint[1]

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Name parameter value. Save the result to the $restorepoint variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the second restore session in the array).
Run the Start-VBRWindowsFileRestore cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $session variable.

Start-VBRWindowsFileRestore Example 2. Starting Restore Session for Windows Guest OS Files from Latest Restore Point [Using Pipeline]

This example shows how to start a restore session for Windows guest OS files of the WinSrv25 machine. The cmdlet will use the latest restore point to start restore of Windows guest OS files.

Get-VBRBackup -Name "WinSrv25" | Get-VBRRestorePoint | Sort-Object -Property CreationTime -Descending | Select-Object -First 1 | Start-VBRWindowsFileRestore

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Get-VBRRestorePoint cmdlet.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value for the Property parameter. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Set the 1 number as the First parameter value.
Pipe the cmdlet output to the Start-VBRWindowsFileRestore cmdlet.