Get-VBRADForestDomain

Short Description

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

Platform: VMware, Hyper-V

Product Edition: Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

  • ADForest

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

  • RestorePoint

    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-VBRADForestReturns Microsoft Active Directory forests in your infrastructure. cmdlet.

VBRADForest

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-VBRADForestRestorePointReturns restore points for a Microsoft Active Directory forest. cmdlet.

VBRADForestRestorePoint

True

Named

True (ByValue)

<CommonParameters>

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

Get-VBRADForestDomainExample 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:

  1. Run the Get-VBRADForestReturns Microsoft Active Directory forests in your infrastructure. cmdlet. Save the result to the $forest variable.
  2. Run the Get-VBRADForestDomain cmdlet. Set the $forest variable as the ADForest parameter value.

Get-VBRADForestDomainExample 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:

  1. Run the Get-VBRADForestReturns Microsoft Active Directory forests in your infrastructure. cmdlet. Save the result to the $forest variable.
  2. Run the Get-VBRADForestRestorePointReturns restore points for a Microsoft Active Directory forest. cmdlet. Set the $forest variable as the ADForest parameter value. Save the result to the $restorePoint variable.
  3. Run the Get-VBRADForestDomain cmdlet. Set the $restorePoint variable as the RestorePoint parameter value.

Page updated 2026-08-19

Page content applies to build 13.1.1.18