New-VBRvCloudVAppRestoreSettings

Short Description

Creates a set of vApp restore parameters.

Platform: VMware

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

Syntax

New-VBRvCloudVAppRestoreSettings [-RestorePoint] <COib> [-vAppName <String>] [-OrgVdc <IVcdItem>] [-PowerUp]

[-Reason <String>] [<CommonParameters>]

Detailed Description

This cmdlet is an assistant command creating a CVcdVAppRestoreSettings object that is further used in the Start-VBRvCloudRestoreVApp cmdlet. This object gathers the parameters of a selected vApp that will be needed for restore.

The vApp that you want to restore and its parameters are derived from the specified restore point data. Use the OrgVdc parameter to set another organization where you want to restore the vApp to.

You can customize any of the parameters that are derived from the restore point. For more information, see the Advanced Setup section.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
OrgVdc	Specifies the organization VDC you want to restore the vApp to. If not set, the vApp will be restored to the original organization VDC. Accepts the `IVcdItem` object. Run the `Find-VBRvCloudEntity` cmdlet to get this object.	`IVcdItem`	False	Named	False
PowerUp	If set to `True`, 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
RestorePoint	Specifies the restore point of the vApp you want to restore the vApp to. Accepts the `COib` object. To get this object, run the `Get-VBRRestorePoint` cmdlet.	`COib`	True	0	True (ByPropertyName, ByValue)
vAppName	Specifies the name of the restored vApp. Use this parameter in case you want to restore the vApp with different name.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

CVcdVAppRestoreSettings

Examples

New-VBRvCloudVAppRestoreSettings Example 1. Creating Settings for Future Restore of vApp

This example shows how to create a set of restore parameters for the vApp01 vApp that will be restored to another organization VDC.

$restoreparams = New-VBRvCloudVAppRestoreSettings -RestorePoint $restorepoint -vAppName "vApp01" -OrgVdc $Org

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Find-VBRvCloudEntity cmdlet. Provide the OrganizationVdc parameter. Save the result to the $Org variable.
Run the New-VBRvCloudVAppRestoreSettings cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
- Specify the vAppName parameter value.
- Set the $Org variable as the OrgVdc parameter value.
Save the result to the $restoreparams variable.

New-VBRvCloudVAppRestoreSettings Example 2. Viewing Settings Derived from Restore Point

This example shows how to view the vApp settings that the cmdlet derived from the restore point. The cmdlet output will contain the details about the vAppOib, OrgVdc, Vms, and vAppName settings of the vApp.

$restoreparams

vAppOib OrgVdc Vms vAppName

------- ------ --- --------

Veeam.Bacvup.. Veeam.Backup... {Veeam.Backup... vApp01

Where:

vAppOib — the restore point of the vApp
OrgVdc — the organization vDataCenter where the vApp is registered
Vms — the list of VMs within the vApp
vAppName — the name of the vApp

New-VBRvCloudVAppRestoreSettings Example 3. Viewing Settings of VMs Within vApp

This example shows how to view the properties of the VMs within the vApp. The cmdlet output will contain the details about the VmOib, StorageProfile, vCloudDatastore, and VmTemplate settings of each VM.

$restoreparams.vms

VmOib StorageProfile vCloudDatastore VmTemplate

----- -------------- --------------- ----------

Veeam... Name: 'Storag... Veeam.Backup.CV...

Where:

VmOib — the VM restore point
StorageProfile — the VM storage profile
vCloudDatastore — the datastore that the VM uses
VmTemplate — the VM template

New-VBRvCloudVAppRestoreSettings Example 4. Customizing Settings for Restore of vApp

This example shows how to restore the vApp to another organization. The new organization object is specified as the OrgVdc parameter value, and all other VM settings are set to null.

$restoreparams = New-VBRvCloudVAppRestoreSettings -RestorePoint $restorepoint -OrgVdc $Org

$restoreparams.vms[0].vCloudDatastore=$null

$restoreparams.vms[0].StorageProfile=$null

$restoreparams.vms[0].VmTemplate=$null

Perform the following steps:

Run the New-VBRvCloudVAppRestoreSettings cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Set the $Org variable as the OrgVdc parameter value. Save the result to the $restoreparams variable.
Set the vCloudDatastore, StorageProfile, and VmTemplate properties of the required VM in the $restoreparams.vms array to null.

The $restoreparams variable now contains the data needed for the restore and can be used in the Start-VBRvCloudRestoreVApp cmdlet.