Start-VBRRestoreVMFiles

In this article

    Short Description

    Restores VM configuration files.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Start-VBRRestoreVMFiles [-RestorePoint] <COib> [-Server] <CHost> [-Path] <string> [-Files <COIBFileInfo[]>] [-Reason <string>] [-RunAsync] [-Force]  [<CommonParameters>]

    Detailed Description

    This cmdlet allows you to restore configuration file (.vmx) or virtual disks (.vmdk) of a selected VM.

    Start-VBRRestoreVMFiles Note:

    Run Start-VBRWindowsFileRestore to restore Windows VM guest OS files.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the VM restore point to which you want to restore.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Server

    Specifies the host to which the VM guest files should be restored.

    True

    2

    False

    False

    Path

    Specifies the string with the path to the folder where restored files should be saved.

    True

    3

    False

    False

    Files

    Specifies the files you want to restore.

    By default, all files from the VM will be restored.

    False

    Named

    True (ByProperty
    Name)

    False

    Reason

    Specifies the string with the reason for performing the VM guest OS file restore.

    False

    Named

    False

    False

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will restore VM configuration files even if the location of the repository where VM backups reside and the target host location do not match.

    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 example allows you to restore all VM guest OS files from the restore point specified in the $point variable and save them on the host specified in the $server variable to the C:\BackupFiles folder.

    Start-VBRRestoreVMFiles –RestorePoint $point –Server $server –Path “C:\BackupFiles”

    Related Commands

    Get-VBRRestorePoint

    Get-VBRServer

    Get-VBRFilesInRestorePoint