Start-VBRADForestRestore

Short Description

Starts a Microsoft Active Directory forest restore.

Platform: VMware, Hyper-V

Product Edition: Veeam Universal License

Syntax

Start-VBRADForestRestore -RestorePoint <VBRADForestRestorePoint>

-DomainRestoreSpec <VBRADForestDomainRestoreSpec[]> [-ReIpRule <VBRADForestReIpRule[]>] [-Reason <String>]

[-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet starts a restore of a Microsoft Active Directory forest. The cmdlet restores domain controllers from a backup to the specified target hosts.

Before starting the restore, create a domain restore specification for each domain controller you want to restore. For VMware environments, run the New-VBRViADForestDomainRestoreSpec cmdlet. For Hyper-V environments, run the New-VBRHvADForestDomainRestoreSpec cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
DomainRestoreSpec	Specifies the array of domain restore specifications. Each specification defines the target settings for restoring a domain controller VM. The domain restore specification must contain exactly one root domain. All domain restore specifications must belong to the same Microsoft Active Directory forest as the specified restore point. Accepts the `VBRADForestDomainRestoreSpec[]` object. To create this object, run the `New-VBRViADForestDomainRestoreSpec` or `New-VBRHvADForestDomainRestoreSpec` cmdlet.	`VBRADForestDomainRestoreSpec[]`	True	Named	False
Reason	Specifies the reason for the restore operation. Veeam Backup & Replication adds this reason to the restore session log.	`String`	False	Named	False
ReIpRule	Specifies the array of re-IP rules for the restore. Use re-IP rules when the domain controllers must be restored to a network with a different IP addressing scheme. Accepts the `VBRADForestReIpRule[]` object. To create this object, run the `New-VBRADForestReIpRule` cmdlet.	`VBRADForestReIpRule[]`	False	Named	False
RestorePoint	Specifies the restore point for the Microsoft Active Directory forest from which to restore domain controllers. Accepts the `VBRADForestRestorePoint` object. To get this object, run the `Get-VBRADForestRestorePoint` cmdlet.	`VBRADForestRestorePoint`	True	Named	False
RunAsync	Defines that the cmdlet will run the restore operation asynchronously. The cmdlet returns a session object immediately without waiting for the restore 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

The cmdlet returns the VBRADForestRestoreSession object that contains properties of the Microsoft Active Directory forest restore session.

Examples

Start-VBRADForestRestore Example 1. Microsoft Active Directory Forest Restore to VMware vSphere

This example shows how to start a Microsoft Active Directory forest restore for a VMware vSphere environment. It restores two domain controllers — one from the root domain and one from a child domain.

$forest = Get-VBRADForest

$restorePoint = (Get-VBRADForestRestorePoint -ADForest $forest)[0]

$domains = Get-VBRADForestDomain -ADForest $forest

$server = Get-VBRServer -Name "esx01.company.local"

$credentials = Get-Credential

$resourcePool = Find-VBRViResourcePool -Server $server -Name "Resources"

$datastore = Find-VBRViDatastore -Server $server -Name "Datastore01"

$folder = Find-VBRViEntity -Server $server -Name "Discovered virtual machine"

$rootRestorePoint = (Get-VBRADForestDomainRestorePoint -Domain $domains[0])[0]

$rootSpec = New-VBRViADForestDomainRestoreSpec -RestorePoint $rootRestorePoint -Credentials $credentials -Server $server -ResourcePool $resourcePool -Datastore $datastore -Folder $folder -VMName "DC01-Restored"

$childRestorePoint = (Get-VBRADForestDomainRestorePoint -Domain $domains[1])[0]

$childSpec = New-VBRViADForestDomainRestoreSpec -RestorePoint $childRestorePoint -Credentials $credentials -Server $server -ResourcePool $resourcePool -Datastore $datastore -Folder $folder -VMName "DC02-Restored"

$restore = Start-VBRADForestRestore -RestorePoint $restorePoint -DomainRestoreSpec @($rootSpec, $childSpec) -RunAsync -Reason "Disaster recovery"

Perform the following steps:

Run the Get-VBRADForest cmdlet. Save the result to the $forest variable.
Run the Get-VBRADForestRestorePoint cmdlet. Set the $forest variable as the ADForest parameter value. The cmdlet returns an array of forest restore points (points in time); this example saves the first one to the $restorePoint variable.
Run the Get-VBRADForestDomain cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $domains variable. The cmdlet returns all domains in the forest.
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 Find-VBRViResourcePool cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value. Save the result to the $resourcePool variable.
Run the Find-VBRViDatastore cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value. Save the result to the $datastore variable.
Run the Find-VBRViEntity cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value. Save the result to the $folder variable.
Run the Get-VBRADForestDomainRestorePoint cmdlet. Set the root domain (the first element of the $domains array) as the Domain parameter value. Save the first restore point to the $rootRestorePoint variable.
Run the New-VBRViADForestDomainRestoreSpec cmdlet to create the specification for the root domain controller. Specify the following parameters:
- Set the $rootRestorePoint variable as the RestorePoint parameter value.
- Set the $credentials variable as the Credentials parameter value.
- Set the $server variable as the Server parameter value.
- Set the $resourcePool variable as the ResourcePool parameter value.
- Set the $datastore variable as the Datastore parameter value.
- Set the $folder variable as the Folder parameter value.
- Specify the VMName parameter value.
Save the result to the $rootSpec variable.
Run the Get-VBRADForestDomainRestorePoint cmdlet. Set a child domain (the second element of the $domains array) as the Domain parameter value. Save the first restore point to the $childRestorePoint variable.
Run the New-VBRViADForestDomainRestoreSpec cmdlet to create the specification for the child domain controller. Specify the same parameters as for the root domain controller, but set the $childRestorePoint variable as the RestorePoint parameter value and specify a different VMName parameter value. Save the result to the $childSpec variable.
Run the Start-VBRADForestRestore cmdlet. Specify the following parameters:
- Set the $restorePoint variable as the RestorePoint parameter value.
- Set the @($rootSpec, $childSpec) array as the DomainRestoreSpec parameter value. The array must contain exactly one specification for the root domain.
- Provide the RunAsync parameter.
- Specify the Reason parameter.
Save the result to the $restore variable to use it with other cmdlets.

Start-VBRADForestRestore Example 2. Microsoft Active Directory Forest Restore to Microsoft Hyper-V

This example shows how to start a Microsoft Active Directory forest restore for a Microsoft Hyper-V environment. It restores two domain controllers — one from the root domain and one from a child domain.

$forest = Get-VBRADForest

$restorePoint = (Get-VBRADForestRestorePoint -ADForest $forest)[0]

$domains = Get-VBRADForestDomain -ADForest $forest

$server = Get-VBRServer -Name "hvhost01.company.local"

$credentials = Get-Credential

$rootRestorePoint = (Get-VBRADForestDomainRestorePoint -Domain $domains[0])[0]

$rootSpec = New-VBRHvADForestDomainRestoreSpec -RestorePoint $rootRestorePoint -Credentials $credentials -Server $server -Path "C:\VMs\Restore" -VMName "DC01-Restored"

$childRestorePoint = (Get-VBRADForestDomainRestorePoint -Domain $domains[1])[0]

$childSpec = New-VBRHvADForestDomainRestoreSpec -RestorePoint $childRestorePoint -Credentials $credentials -Server $server -Path "C:\VMs\Restore" -VMName "DC02-Restored"

$reIpRule = New-VBRADForestReIpRule -SourceIp 172.16.*.* -SourceMask 255.255.0.0 -TargetIp 172.17.*.* -TargetMask 255.255.0.0 -TargetGateway 172.17.0.1 -VlanTag 120

$restore = Start-VBRADForestRestore -RestorePoint $restorePoint -DomainRestoreSpec @($rootSpec, $childSpec) -ReIpRule $reIpRule -RunAsync -Reason "Disaster recovery"

Perform the following steps:

Run the Get-VBRADForest cmdlet. Save the result to the $forest variable.
Run the Get-VBRADForestRestorePoint cmdlet. Set the $forest variable as the ADForest parameter value. The cmdlet returns an array of forest restore points (points in time); this example saves the first one to the $restorePoint variable.
Run the Get-VBRADForestDomain cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $domains variable. The cmdlet returns all domains in the forest.
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-VBRADForestDomainRestorePoint cmdlet. Set the root domain (the first element of the $domains array) as the Domain parameter value. Save the first restore point to the $rootRestorePoint variable.
Run the New-VBRHvADForestDomainRestoreSpec cmdlet to create the specification for the root domain controller. Specify the following parameters:
- Set the $rootRestorePoint 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 $rootSpec variable.
Run the Get-VBRADForestDomainRestorePoint cmdlet. Set a child domain (the second element of the $domains array) as the Domain parameter value. Save the first restore point to the $childRestorePoint variable.
Run the New-VBRHvADForestDomainRestoreSpec cmdlet to create the specification for the child domain controller. Specify the same parameters as for the root domain controller, but set the $childRestorePoint variable as the RestorePoint parameter value and specify a different VMName parameter value. Save the result to the $childSpec variable.
Run the New-VBRADForestReIpRule cmdlet to create a re-IP rule. Specify the SourceIp, SourceMask, TargetIp, TargetMask, TargetGateway, and VlanTag parameter values. Save the result to the $reIpRule variable.
Run the Start-VBRADForestRestore cmdlet. Specify the following parameters:
- Set the $restorePoint variable as the RestorePoint parameter value.
- Set the @($rootSpec, $childSpec) array as the DomainRestoreSpec parameter value. The array must contain exactly one specification for the root domain.
- Set the $reIpRule variable as the ReIpRule parameter value.
- Provide the RunAsync parameter.
- Specify the Reason parameter.
Save the result to the $restore variable to use it with other cmdlets.