Stop-VBRWindowsFileRestore

In this article

    Short Description

    Stops guest OS file recovery session for VMs running Windows.

    Applies to

    Platform: VMware

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

    Syntax

    This cmdlet provides two parameter sets:

    • To stop the restore session:

    Stop-VBRWindowsFileRestore [[-FileRestore] <FileRestore>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    • To unmount disks:

    Stop-VBRWindowsFileRestore [-MountPoint <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet finalizes the restore session initiated with Start-VBRWindowsFileRestore.

    To finalize the restore session, you can use the following options:

    • Submit the session object.

    You need to save the object of the restore session the moment you start the session. If you have saved it to a variable, you can use it with the FileRestore parameter.

    • Submit the path to any of disks that were mounted during the restore.

    You need to know a temporary path to at least one of the VM virtual disks that were mounted during the restore session. Note that when you provide path to one virtual disk, as the result of the cmdlet all disk of the VM will be unmounted.

    This cmdlet provides syntax for both scenarios.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    FileRestore

    Specifies the running file-level restore session you want to stop.

    False

    1

    False

    False

    MountPoint

    Specifies the string with the path to the mounted disk.

    False

    Named

    False

    False

    <CommonParameters>

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

    Example

    This command stops a file restore session initiated with Start-VBRWindowsFileRestore.

    This example uses the $result variable that contains the object of the restore session. The session object was saved to the variable during the restore session start.

    Stop-VBRWindowsFileRestore $Result