Get-VBRADForestDomain

Short Description

Returns Active Directory domains within a forest or a restore point.

Applies to

Platform: VMware, Hyper-V

Product Edition: Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

Get Microsoft Active Directory forest domains using the Microsoft Active Directory forest.

Get-VBRADForestDomain -ADForest <VBRADForest> [<CommonParameters>]

Get Microsoft Active Directory forest domains using a restore point.

Get-VBRADForestDomain -RestorePoint <VBRADForestRestorePoint> [<CommonParameters>]

Detailed Description

The cmdlet returns all Active Directory domains in the specified Microsoft Active Directory forest or restore point, including domains from every domain tree in the forest.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ADForest	Specifies a Microsoft Active Directory forest object. The cmdlet will return Active Directory domains within that forest.	Accepts the VBRADForest object. To get this object, run the Get-VBRADForest cmdlet.	True	Named	True (ByValue)
RestorePoint	Specifies a Microsoft Active Directory forest restore point. The cmdlet will return Active Directory domains within that restore point.	Accepts the VBRADForestRestorePoint object. To get this object, run the Get-VBRADForestRestorePoint cmdlet.	True	Named	True (ByValue)

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

Output Object

The cmdlet returns the VBRADForestDomain[] object that contains information about the Active Directory domain.

Examples

Example 1. Getting Domains from Microsoft Active Directory Forest

This example shows how to get Active Directory domains by specifying the forest.

$forest = Get-VBRADForest

Get-VBRADForestDomain -ADForest $forest

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.

Example 2. Getting Domains from Forest Restore Point

This example shows how to get Active Directory domains by specifying a forest restore point.

$forest = Get-VBRADForest

$restorePoint = Get-VBRADForestRestorePoint -ADForest $forest

Get-VBRADForestDomain -RestorePoint $restorePoint

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. Save the result to the $restorePoint variable.
Run the Get-VBRADForestDomain cmdlet. Set the $restorePoint variable as the RestorePoint parameter value.

Related Commands