Stop-VBRWindowsFileRestore

Short Description

Stops Windows guest OS file restore session.

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

Syntax

This cmdlet provides the following parameter sets:

FileRestore

Stop-VBRWindowsFileRestore [[-FileRestore] <FileRestore>] [<CommonParameters>]
MountPoint

Stop-VBRWindowsFileRestore [-MountPoint <String>] [<CommonParameters>]

Detailed Description

This cmdlet stops Windows guest OS file restore session initiated with the Start-VBRWindowsFileRestore cmdlet.

Note

Note that you cannot restore files after the disks are unmounted.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
FileRestore	Specifies the running Windows guest OS file restore session you want to stop. Accepts the `FileRestore` object. To create this object, run the `Start-VBRWindowsFileRestore` cmdlet.	`FileRestore`	False	0	False
MountPoint	Specifies the path to the mounted disk.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Stop-VBRWindowsFileRestore Example 1. Stopping Restore Session of Windows Guest OS Files

This example shows how to stop a restore session of 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

Stop-VBRWindowsFileRestore -FileRestore $session

Perform the following steps:

Start the restore session:
1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
2. 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.
3. Run the Start-VBRWindowsFileRestore cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $session variable.
Run the Stop-VBRWindowsFileRestore cmdlet. Set the $session variable as the FileRestore parameter value.

Stop-VBRWindowsFileRestore Example 2. Unmounting Windows Guest OS Disks

This command unmounts Windows Guest OS Disks from the C:\Disks mount point.

Stop-VBRWindowsFileRestore -MountPoint "C:\Disks"