---
title: "New-VBRHvADForestDomainRestoreSpec"
description: "This cmdlet creates the VBRADForestDomainRestoreSpec object. This object defines the target settings for restoring a domain controller VM on a Hyper-V host during a Microsoft Active Directory forest restore."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrhvadforestdomainrestorespec.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Data Recovery > Microsoft Active Directory Forest Restore > New-VBRHvADForestDomainRestoreSpec"
dateModified: "2026-08-19"
---

# New-VBRHvADForestDomainRestoreSpec

## Short Description
Creates a Hyper-V domain restore specification for a Microsoft Active Directory forest restore.

**Platform**: Hyper-V

**Product Edition**: Veeam Universal License

## Syntax
```
New-VBRHvADForestDomainRestoreSpec [-RestorePoint] <VBRADForestDomainRestorePoint> -Credentials <PSCredential>
 -Server <CHost> -Path <String> -VMName <String> [-NetworkMapping <VBRHvInstantRecoveryNetworkMappingRule[]>] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates the [`VBRADForestDomainRestoreSpec`](vbradforestdomainrestorespec.md) object. This object defines the target settings for restoring a domain controller VM on a Hyper-V host during a Microsoft Active Directory forest restore. Create one specification for each domain controller you want to restore. Use this object with the [`Start-VBRADForestRestore`](start-vbradforestrestore.md) cmdlet.

## 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">Credentials</span></p>
        </td>
        <td>
          <p>Specifies the guest OS credentials of the restored domain controller.</p><p>Accepts the <code>PSCredential</code> object. To get this object, run the <a href="https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.1"><code>Get-Credential</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>PSCredential</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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">NetworkMapping</span></p>
        </td>
        <td>
          <p>Specifies an array of network mapping rules for the restore. Use this parameter to map source networks to networks available on the target Hyper-V host. Network mapping is required when you restore the domain controller VM to a host other than the original one.</p><p>Accepts the <a href="vbrhvinstantrecoverynetworkmappingrule.md"><code>VBRHvInstantRecoveryNetworkMappingRule</code></a><code>[]</code> object. To get this object, run the <a href="new-vbrhvinstantrecoverynetworkmappingrule.md"><code>New-VBRHvInstantRecoveryNetworkMappingRule</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrhvinstantrecoverynetworkmappingrule.md"><code>VBRHvInstantRecoveryNetworkMappingRule[]</code></a></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">Path</span></p>
        </td>
        <td>
          <p>Specifies the path to the folder on the Hyper-V host where the domain controller VM files will be stored during the restore.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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 domain controller restore point to use for the restore operation.</p><p>Accepts the <a href="vbradforestdomainrestorepoint.md"><code>VBRADForestDomainRestorePoint</code></a> object. To get this object, run the <a href="get-vbradforestdomainrestorepoint.md"><code>Get-VBRADForestDomainRestorePoint</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbradforestdomainrestorepoint.md"><code>VBRADForestDomainRestorePoint</code></a></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">Server</span></p>
        </td>
        <td>
          <p>Specifies the Hyper-V host on which to restore the domain controller VM.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHost</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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">VMName</span></p>
        </td>
        <td>
          <p>Specifies the name for the restored domain controller VM.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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
The cmdlet returns the [`VBRADForestDomainRestoreSpec`](vbradforestdomainrestorespec.md) object that defines the target settings for restoring a domain controller VM on a Hyper-V host.

## Examples

::: example
### Example 1. Creating Hyper-V Domain Restore Specification

This example shows how to create a domain restore specification for a Hyper-V environment.

```
$forest = Get-VBRADForest
$domain = Get-VBRADForestDomain -ADForest $forest
$domainRestorePoint = Get-VBRADForestDomainRestorePoint -Domain $domain
$server = Get-VBRServer -Name "hvhost01.company.local"
$credentials = Get-Credential
$hvSpec = New-VBRHvADForestDomainRestoreSpec -RestorePoint $domainRestorePoint[0] -Credentials $credentials -Server $server -Path "C:\VMs\Restore" -VMName "DC01-Restored"
```

Perform the following steps:

1. Run the [`Get-VBRADForest`](get-vbradforest.md) cmdlet. Save the result to the `$forest` variable.
2. Run the [`Get-VBRADForestDomain`](get-vbradforestdomain.md) cmdlet. Set the `$forest` variable as the `ADForest` parameter value. Save the result to the `$domain` variable.
3. Run the [`Get-VBRADForestDomainRestorePoint`](get-vbradforestdomainrestorepoint.md) cmdlet. Set the `$domain` variable as the `Domain` parameter value. Save the result to the `$domainRestorePoint` variable. The cmdlet returns an array of restore points (points in time); this example uses the first one (`$domainRestorePoint[0]`).
4. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$server` variable.
5. Run the [`Get-Credential`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.1) cmdlet. Save the result to the `$credentials` variable.
6. Run the `New-VBRHvADForestDomainRestoreSpec` cmdlet. Specify the following parameters:

   - Set the `$domainRestorePoint[0]` variable as the `RestorePoint` parameter value.
   - Set the `$credentials` variable as the `Credentials` parameter value.
   - Set the `$server` variable as the `Server` parameter value.
   - Specify the `Path` parameter value.
   - Specify the `VMName` parameter value.

   Save the result to the `$hvSpec` variable to use it with other cmdlets.

:::

::: example
### Example 2.  Creating Hyper-V Domain Restore Specification with Network Mapping

This example shows how to create a domain restore specification with network mapping for a Hyper-V environment.

```
$forest = Get-VBRADForest
$domain = Get-VBRADForestDomain -ADForest $forest
$domainRestorePoint = Get-VBRADForestDomainRestorePoint -Domain $domain
$server = Get-VBRServer -Name "hvhost01.company.local"
$credentials = Get-Credential
$sourceNetwork = Get-VBRComputerNetworkInfo
$targetNetwork = Get-VBRHvServerNetworkInfo -Server $server
$networkMapping = New-VBRHvInstantRecoveryNetworkMappingRule -SourceNetwork $sourceNetwork -TargetNetwork $targetNetwork
$hvSpec = New-VBRHvADForestDomainRestoreSpec -RestorePoint $domainRestorePoint[0] -Credentials $credentials -Server $server -Path "C:\VMs\Restore" -VMName "DC01-Restored" -NetworkMapping $networkMapping
```

Perform the following steps:

1. Run the [`Get-VBRADForest`](get-vbradforest.md) cmdlet. Save the result to the `$forest` variable.
2. Run the [`Get-VBRADForestDomain`](get-vbradforestdomain.md) cmdlet. Set the `$forest` variable as the `ADForest` parameter value. Save the result to the `$domain` variable.
3. Run the [`Get-VBRADForestDomainRestorePoint`](get-vbradforestdomainrestorepoint.md) cmdlet. Set the `$domain` variable as the `Domain` parameter value. Save the result to the `$domainRestorePoint` variable. The cmdlet returns an array of restore points (points in time); this example uses the first one (`$domainRestorePoint[0]`).
4. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$server` variable.
5. Run the [`Get-Credential`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.1) cmdlet. Save the result to the `$credentials` variable.
6. Run the [`Get-VBRComputerNetworkInfo`](get-vbrcomputernetworkinfo.md) cmdlet. Save the result to the `$sourceNetwork` variable.
7. Run the [`Get-VBRHvServerNetworkInfo`](get-vbrhvservernetworkinfo.md) cmdlet. Set the `$server` variable as the `Server` parameter value. Save the result to the `$targetNetwork` variable.
8. Run the [`New-VBRHvInstantRecoveryNetworkMappingRule`](new-vbrhvinstantrecoverynetworkmappingrule.md) cmdlet. Set the `$sourceNetwork` variable as the `SourceNetwork` parameter value. Set the `$targetNetwork` variable as the `TargetNetwork` parameter value. Save the result to the `$networkMapping` variable.
9. Run the `New-VBRHvADForestDomainRestoreSpec` cmdlet. Specify the following parameters:

   - Set the `$domainRestorePoint[0]` variable as the `RestorePoint` parameter value.
   - Set the `$credentials` variable as the `Credentials` parameter value.
   - Set the `$server` variable as the `Server` parameter value.
   - Specify the `Path` parameter value.
   - Specify the `VMName` parameter value.
   - Set the `$networkMapping` variable as the `NetworkMapping` parameter value.

   Save the result to the `$hvSpec` variable to use it with other cmdlets.

:::

## Related Commands

- [`Get-VBRADForest`](get-vbradforest.md)
- [`Get-VBRADForestDomain`](get-vbradforestdomain.md)
- [`Get-VBRADForestDomainRestorePoint`](get-vbradforestdomainrestorepoint.md)
- [`Get-VBRServer`](get-vbrserver.md)
- [`Get-VBRComputerNetworkInfo`](get-vbrcomputernetworkinfo.md)
- [`Get-VBRHvServerNetworkInfo`](get-vbrhvservernetworkinfo.md)
- [`New-VBRHvInstantRecoveryNetworkMappingRule`](new-vbrhvinstantrecoverynetworkmappingrule.md)
- [`Start-VBRADForestRestore`](start-vbradforestrestore.md)