New-VBRViADForestDomainRestoreSpec
Short Description
Creates a VMware domain restore specification for a Microsoft Active Directory forest restore.
Platform: VMware
Product Edition: Veeam Universal License
Syntax
|
New-VBRViADForestDomainRestoreSpec [-RestorePoint] <VBRADForestDomainRestorePoint> -Credentials <PSCredential>
-Server <CHost> -ResourcePool <CViResourcePoolItem> -Datastore <CViDatastoreItem> -Folder <CViFolderItem>
-VMName <String> [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRViNetworkInfo[]>] [<CommonParameters>] |
Detailed Description
This cmdlet creates the VBRADForestDomainRestoreSpec object. This object defines the target settings for restoring a domain controller VM on a VMware 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-VBRADForestRestoreStarts a Microsoft Active Directory forest restore. 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
|
|
Datastore
|
Specifies the datastore on the target ESXi host where the domain controller VM files will be stored.
Accepts the CViDatastoreItem object. To get this object, run the Find-VBRViDatastoreLooks for VMware datastores. cmdlet.
|
CViDatastoreItem
|
True
|
Named
|
False
|
|
Folder
|
Specifies the VM folder in the vCenter Server inventory where the restored domain controller VM will appear.
Accepts the CViFolderItem object. To get this object, run the Find-VBRViEntityLooks for VMware objects. cmdlet.
|
CViFolderItem
|
True
|
Named
|
False
|
|
ResourcePool
|
Specifies the resource pool on the target ESXi host where the domain controller VM will be placed.
Accepts the CViResourcePoolItem object. To get this object, run the Find-VBRViResourcePoolReturns VMware resource pools. cmdlet.
|
CViResourcePoolItem
|
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-VBRADForestDomainRestorePointReturns restore points for an Active Directory domain. cmdlet.
|
VBRADForestDomainRestorePoint
|
True
|
0
|
True (ByPropertyName, ByValue)
|
|
Server
|
Specifies the VMware ESXi host on which to restore the domain controller VM.
|
CHost
|
True
|
Named
|
False
|
|
SourceNetwork
|
Specifies the array of virtual networks connected to the domain controller VM in the source environment. Use this parameter together with the TargetNetwork parameter to configure network mapping. The SourceNetwork and TargetNetwork arrays must contain the same number of networks. Network mapping is required when you restore the domain controller VM to a host other than the original one.
Accepts the VBRViNetworkInfo[] object. To get this object, run the Get-VBRViServerNetworkInfoReturns virtual networks for a VMware host. cmdlet.
|
VBRViNetworkInfo[]
|
False
|
Named
|
False
|
|
TargetNetwork
|
Specifies the array of virtual networks connected to the target VMware host that the domain controller VM will be mapped to. Use this parameter together with the SourceNetwork parameter to configure network mapping. The SourceNetwork and TargetNetwork arrays must contain the same number of networks. Network mapping is required when you restore the domain controller VM to a host other than the original one.
Accepts the VBRViNetworkInfo[] object. To get this object, run the Get-VBRViServerNetworkInfoReturns virtual networks for a VMware host. cmdlet.
|
VBRViNetworkInfo[]
|
False
|
Named
|
False
|
|
VMName
|
Specifies the name for the restored domain controller VM. The name can contain from 1 to 81 characters.
|
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 VMware host.
Examples
Example 1. Creating VMware Domain Restore Specification
|
This example shows how to create a domain restore specification for a VMware environment.
|
$forest = Get-VBRADForest
$domain = Get-VBRADForestDomain -ADForest $forest
$domainRestorePoint = Get-VBRADForestDomainRestorePoint -Domain $domain
$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"
$viSpec = New-VBRViADForestDomainRestoreSpec -RestorePoint $domainRestorePoint[0] -Credentials $credentials -Server $server -ResourcePool $resourcePool -Datastore $datastore -Folder $folder -VMName "DC01-Restored" |
Perform the following steps:
- Run the
Get-VBRADForestReturns Microsoft Active Directory forests in your infrastructure. cmdlet. Save the result to the $forest variable.
- Run the
Get-VBRADForestDomainReturns Active Directory domains within a forest or a restore point. cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $domain variable.
- Run the
Get-VBRADForestDomainRestorePointReturns restore points for an Active Directory domain. 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-VBRServerReturns hosts connected to the backup infrastructure. 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-VBRViResourcePoolReturns VMware resource pools. 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-VBRViDatastoreLooks for VMware datastores. 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-VBRViEntityLooks for VMware objects. cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value. Save the result to the $folder variable.
- Run the
New-VBRViADForestDomainRestoreSpec 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.
- 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 $viSpec variable to use it with other cmdlets.
|
Example 2. Creating VMware Domain Restore Specification with Network Mapping
|
This example shows how to create a domain restore specification with network mapping for a VMware environment.
|
$forest = Get-VBRADForest
$domain = Get-VBRADForestDomain -ADForest $forest
$domainRestorePoint = Get-VBRADForestDomainRestorePoint -Domain $domain
$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"
$sourceNetwork = Get-VBRViServerNetworkInfo -Server $server | Where-Object { $_.NetworkName -eq "VM Network" }
$targetNetwork = Get-VBRViServerNetworkInfo -Server $server | Where-Object { $_.NetworkName -eq "Restore Network" }
$viSpec = New-VBRViADForestDomainRestoreSpec -RestorePoint $domainRestorePoint[0] -Credentials $credentials -Server $server -ResourcePool $resourcePool -Datastore $datastore -Folder $folder -VMName "DC01-Restored" -SourceNetwork $sourceNetwork -TargetNetwork $targetNetwork |
Perform the following steps:
- Run the
Get-VBRADForestReturns Microsoft Active Directory forests in your infrastructure. cmdlet. Save the result to the $forest variable.
- Run the
Get-VBRADForestDomainReturns Active Directory domains within a forest or a restore point. cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $domain variable.
- Run the
Get-VBRADForestDomainRestorePointReturns restore points for an Active Directory domain. 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-VBRServerReturns hosts connected to the backup infrastructure. 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-VBRViResourcePoolReturns VMware resource pools. 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-VBRViDatastoreLooks for VMware datastores. 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-VBRViEntityLooks for VMware objects. 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-VBRViServerNetworkInfoReturns virtual networks for a VMware host. cmdlet. Set the $server variable as the Server parameter value. Filter the result by the network name. Save the result to the $sourceNetwork variable.
- Run the
Get-VBRViServerNetworkInfoReturns virtual networks for a VMware host. cmdlet. Set the $server variable as the Server parameter value. Filter the result by the network name. Save the result to the $targetNetwork variable.
- Run the
New-VBRViADForestDomainRestoreSpec 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.
- 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.
- Set the
$sourceNetwork variable as the SourceNetwork parameter value.
- Set the
$targetNetwork variable as the TargetNetwork parameter value.
Save the result to the $viSpec variable to use it with other cmdlets.
|
Related Commands
Example 1. Creating VMware Domain Restore Specification