Start-VBRComputerVolumeRestore

In this article

    Short Description

    Starts restore to original location of computer volumes backed-up with Veeam Agent For Microsoft Windows.

    Important

    This cmdlet is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

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

    Syntax

    Start-VBRComputerVolumeRestore -RestorePoint <COib> [-Volumes <VBRComputerDiskPartition[]>] [-EnableAntivirusScan] [-EnableEntireVolumeScan] [-Reason <string>] [-Force] [-RunAsync]  [<CommonParameters>]

    Detailed Description

    This cmdlet starts restore to original location of computer volumes backed-up with Veeam Agent for Microsoft Windows.

    Important

    Mind the following:

    • The cmdlet does not support the disk mapping option. All disks are restored to the original location.
    • Restore of system OS volumes to original location is not supported.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    RestorePoint

    Specifies a restore point of computers. The cmdlet will restore volumes these computers.

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

    True

    Named

    True (ByValue, ByPropertyName)

    Volumes

    Specifies an array of computer volumes that you want to restore.

    Accepts the VBRComputerDiskPartition[] object. To get this object, run the Get-VBRComputerDiskPartition cmdlet.

    False

    Named

    False

    EnableAntivirusScan

    Defines that the cmdlet will perform secure restore.

    If you provide this parameter, Veeam Backup & Replication will trigger the antivirus software to scan selected computer volumes before the restore.

    SwitchParameter

    False

    Named

    False

    EnableEntireVolumeScan

    For secure restore.

    Defines that the antivirus will continue computer volumes scan after the first virus threat is found. If you provide this parameter, the cmdlet will generate a report on all virus threats.

    SwitchParameter

    False

    Named

    False

    Reason

    Specifies a reason of volume-level restore.

    The information you provide will be saved in the session history so that you can reference it later.

    String

    False

    Named

    False

    Force

    Defines that the cmdlet will start restore without showing warnings in the PowerShell console.

    SwitchParameter

    False

    Named

    False

    RunAsync

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

    SwitchParameter

    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

    VBRSession

    Examples

    Starting Restore to Original Location of Computer Volumes Backed-Up with Veeam Agent for Microsoft Windows

    This example shows how to start a volume-level restore of the WinLaptop2017 computer.

    $backup = Get-VBRBackup -Name "WinLaptop2017"

    $restorepoint = Get-VBRRestorePoint -Backup $backup

    $volume = Get-VBRComputerDiskPartition -RestorePoint $restorepoint[3]

    Start-VBRComputerVolumeRestore -RestorePoint $restorepoint[3] -Volumes $volume[2] -EnableAntivirusScan -EnableEntireVolumeScan -Force

    Perform the following steps:

    1. Get the restore point:
    1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRRestorePoint cmdlet. 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 forth restore point in the array).

    1. Run the Get-VBRComputerDiskPartition cmdlet. Specify the RestorePoint parameter value.

    The Get-VBRComputerDiskPartition cmdlet will return an array of volumes. Mind the ordinal number of the necessary volumes (in our example, it is the third volume in the array).

    1. Run the Start-VBRComputerVolumeRestore cmdlet. Specify the following settings:
    • Set the $restorepoint[3] variable as the RestorePoint parameter value.
    • Set the $volume[2] variable as the Volumes parameter value.
    • Provide the EnableAntivirusScan parameter value.
    • Provide the EnableEntireVolumeScan parameter value.
    • Provide the Force parameter value.

    Related Commands