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 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 cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the guest OS credentials of the restored domain controller. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	True	Named	False
NetworkMapping	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. Accepts the `VBRHvInstantRecoveryNetworkMappingRule[]` object. To get this object, run the `New-VBRHvInstantRecoveryNetworkMappingRule` cmdlet.	`VBRHvInstantRecoveryNetworkMappingRule[]`	False	Named	False
Path	Specifies the path to the folder on the Hyper-V host where the domain controller VM files will be stored during the restore.	`String`	True	Named	False
RestorePoint	Specifies the domain controller restore point to use for the restore operation. Accepts the `VBRADForestDomainRestorePoint` object. To get this object, run the `Get-VBRADForestDomainRestorePoint` cmdlet.	`VBRADForestDomainRestorePoint`	True	0	True (ByPropertyName, ByValue)
Server	Specifies the Hyper-V host on which to restore the domain controller VM.	`CHost`	True	Named	False
VMName	Specifies the name for the restored domain controller VM.	`String`	True	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRADForestDomainRestoreSpec object that defines the target settings for restoring a domain controller VM on a Hyper-V host.

Examples

New-VBRHvADForestDomainRestoreSpec 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:

Run the Get-VBRADForest cmdlet. Save the result to the $forest variable.
Run the Get-VBRADForestDomain cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $domain variable.
Run the Get-VBRADForestDomainRestorePoint 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]).
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-Credential cmdlet. Save the result to the $credentials variable.
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.

New-VBRHvADForestDomainRestoreSpec 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:

Run the Get-VBRADForest cmdlet. Save the result to the $forest variable.
Run the Get-VBRADForestDomain cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $domain variable.
Run the Get-VBRADForestDomainRestorePoint 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]).
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-Credential cmdlet. Save the result to the $credentials variable.
Run the Get-VBRComputerNetworkInfo cmdlet. Save the result to the $sourceNetwork variable.
Run the Get-VBRHvServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $targetNetwork variable.
Run the New-VBRHvInstantRecoveryNetworkMappingRule 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.
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.