Start-VBRWindowsFileRestore

In this article

    Short Description

    Starts Windows VM guest OS file restore session.

    Platform: VMware

    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. You can run this cmdlet to restore guest OS files for the following types of backups:

    • A backup of a Windows-based VM.
    • A backup of a Windows-based machine created by Veeam Agent for Microsoft Windows backups.

    Note

    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 Stop-VBRWindowsFileRestore to stop the restore session.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    RestorePoint

    Specifies the restore point to start a restore session. You will be able to use the session to perform operations with VM guest OS files.

     

    Accepts the COib object. To create this object, run the Get-VBRRestorePoint cmdlet.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    Host

    Specifies a mount server to which VM disks will be mounted.

    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 VBRRestorePoint object. To create this object, run the Get-VBRRestorePoint cmdlet.

    False

    3

    False

    Folder

    Specifies a folder on the mount server. The cmdlet will place the VM 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 VM 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 the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBRFLRItem object that contains settings of a restore session of Windows VM guest OS. files

    Examples

    Start-VBRWindowsFileRestoreExample 1. Starting Restore Session for Windows VM Guest OS Files

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

    $backup = Get-VBRBackup -Name "WinSrv25"

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

    Start-VBRWindowsFileRestore -RestorePoint $restorepoint

    Perform the following steps:

    1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
    2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup and Name parameter values. Save the result to the $restorepoint variable.
    3. Run the Start-VBRWindowsFileRestore cmdlet.  Set the $restorepoint as the RestorePoint parameter value.

    Related Commands