Start-VBRvCloudRestoreVApp

In this article

    Short Description

    Starts a vApp restore.

    Applies to

    Platform: VMware

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

    Syntax

    Start-VBRvCloudRestoreVApp [-RestoreParams] <CVcdVAppRestoreSettings> [-PowerUp][-Reason <string>][-RunAsync][<CommonParameters>]

    -OR-

    Start-VBRvCloudRestoreVApp [-RestorePoint] <COib> [-PowerUp] [-Reason <string>][-RunAsync][<CommonParameters>]

    Detailed Description

    This cmdlet starts a restore session for a selected vApp.

    With this cmdlet, you can restore the vApp to the original location or to another location, or with different settings.

    To restore the vApp to the original location you only need to indicate the desired restore point. Be careful to specify the restore point of the vApp, not an individual VM which is not a valid value for this cmdlet. Veeam Backup & Replication gets all the information needed for restore from the restore point data.

    To run restore to another location or with different settings you need to first create a CVcdVAppRestoreSettings object which unifies all the settings options required for restore. The CVcdVAppRestoreSettings object is created with the help of the New-VBRvCloudVAppRestoreSettings cmdlet. See the New-VBRvCloudVAppRestoreSettings topic for detailed instructions for advanced setup options.

    This cmdlet provides two scenarios for each case.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestoreParams

    Specifies the CVcdVAppRestoreSettings object containing all settings required for the vApp restore.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    RestorePoint

    Specifies the restore point of the vApp. Used to restore vApp with all the same settings unchanged.

    False

    Named

    False

    False

    PowerUp

    If set, the vApp will be powered up right after it is restored. Otherwise you will need to power up the vApp manually.

    False

    Named

    False

    False

    Reason

    Specifies the reason for performing restore of the selected vApp.

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

    False

    Named

    False

    False

    RunAsync

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

    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 1

    This command starts a vApp restore. The vApp named "vApp_01" is restored to the original location and with all settings unchanged. The vApp restore point is obtained with Get-VBRRestorePoint and assigned to the $restorepoint variable beforehand.

    Start-VBRvCloudRestoreVApp -RestorePoint $restorepoint

    Example 2

    This command restores a vApp to another location. The vApp named "vApp_01" is restored to organization named "Org_02" with all other settings remaining unchanged.

    To restore the vApp to another organization, you need to first customize the CVcdVAppRestoreSettings object The CVcdVAppRestoreSettings object is obtained with New-VBRvCloudVAppRestoreSettings:

    Run Get-VBRRestorePoint to get the restore points of the vApp. Pass the result to the Where-Object cmdlet to select the restore points with the Name property that equals "vApp_01". Pass the result to the New-VBRvCloudVAppRestoreSettings cmdlet. Save the result to the $restoreparams variable.

    $restoreparams = Get-VBRRestorePoint -Backup $backup | Where {$_.Name -eq "vApp_01"} | New-VBRvCloudVAppRestoreSettings

    Further you need to change the organization in the CVcdVAppRestoreSettings object:

    The Org.Vdc property of the $restoreparams variable is changed to the target organization named "Org_02". The needed organization is obtained with Find-VBRvCloudEntity ([-OrganizationVdc] option).

    $restoreparams.OrgVdc = Find-VBRvCloudEntity -OrganizationVdc -Name "Org_02"

    Now you need to run Start-VBRvCloudRestoreVApp with the customized $restoreparams variable. The RunAcync parameter is set to bring the process to the background:

    Start-VBRvCloudRestoreVApp -RestoreParams $restoreparams -RunAsync

    Related Commands

    New-VBRvCloudVAppRestoreSettings

    Get-VBRRestorePoint