---
title: "New-VBRvCloudVAppRestoreSettings"
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."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrvcloudvapprestoresettings.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > VMware Cloud Director > New-VBRvCloudVAppRestoreSettings"
dateModified: "2026-09-03"
---

# 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`](start-vbrvcloudrestorevapp.md) 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](#examples-example-2--viewing-settings-derived-from-restore-point) section.

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">OrgVdc</span></p>
        </td>
        <td>
          <p>Specifies the organization VDC you want to restore the vApp to. If not set, the vApp will be restored to the original organization VDC.</p><p>Accepts the <code>IVcdItem</code> object. Run the <a href="find-vbrvcloudentity.md"><code>Find-VBRvCloudEntity</code></a> cmdlet to get this object.</p>
        </td>
        <td style="width:10%;">
          <p><code>IVcdItem</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PowerUp</span></p>
        </td>
        <td>
          <p>If set to <code>True</code>, the vApp will be powered up right after it is restored. Otherwise, you will need to power up the vApp manually.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Reason</span></p>
        </td>
        <td>
          <p>Specifies the reason for performing restore of the selected vApp.</p><p>The information you provide will be saved in the session history so that you can reference it later.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">RestorePoint</span></p>
        </td>
        <td>
          <p>Specifies the restore point of the vApp you want to restore the vApp to.</p><p>Accepts the <code>COib</code> object. To get this object, run the <a href="get-vbrrestorepoint.md"><code>Get-VBRRestorePoint</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>COib</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>0</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">vAppName</span></p>
        </td>
        <td>
          <p>Specifies the name of the restored vApp. Use this parameter in case you want to restore the vApp with different name.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
`CVcdVAppRestoreSettings`

## Examples

::: example
### 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:

1. Run the [`Get-VBRRestorePoint`](get-vbrrestorepoint.md) cmdlet. Save the result to the `$restorepoint` variable.
2. Run the [`Find-VBRvCloudEntity`](find-vbrvcloudentity.md) cmdlet. Provide the `OrganizationVdc` parameter. Save the result to the `$Org` variable.
3. 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.

:::

::: example
### 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

:::

::: example
### 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

:::

::: example
### 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:

1. 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.
2. 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`](start-vbrvcloudrestorevapp.md) cmdlet.

:::

## Related Commands

- [`Get-VBRRestorePoint`](get-vbrrestorepoint.md)
- [`Find-VBRvCloudEntity`](find-vbrvcloudentity.md)