Start-VBRvCloudRestoreVApp
Short Description
Starts a vApp restore.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Start a vApp restore to another location or with different settings.
Start-VBRvCloudRestoreVApp -RestoreParams <CVcdVAppRestoreSettings> [-PowerUp] [-Reason <string>] [-RunAsync] [<CommonParameters>] |
- Start a vApp restore to the original location.
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 | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
RestoreParams | Specifies the CVcdVAppRestoreSettings object containing all settings required for the vApp restore. | Accepts the CVcdVAppRestoreSettings object. To create this object, run the New-VBRvCloudVAppRestoreSettings cmdlet. | True | 1 | True (ByValue, |
RestorePoint | Specifies the restore point of the vApp. Used to restore vApp with all the same settings unchanged. | Accepts the COib object. To get this object, run the Get-VBRRestorePoint cmdlet. | False | Named | 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. | SwitchParameter | False | Named | 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. | String | 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 Microsoft Docs.
Output Object
None.
Examples
Example 1. Starting vApp Restore to Original Location
Example 2. Starting vApp Restore to Another Location
Related Commands
