Export (0) Print
Expand All
Expand Minimize

Get-CMActiveDirectoryForest

Updated: September 1, 2013

Applies To: System Center 2012 Configuration Manager SP1

Get-CMActiveDirectoryForest

Gets one or more Active Directory forest objects.

Syntax

Parameter Set: SearchByFQDN
Get-CMActiveDirectoryForest [-ForestFqdn <String> ] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Get-CMActiveDirectoryForest -Id <String[]> [ <CommonParameters>]




Detailed Description

The Get-CMActiveDirectoryForest cmdlet gets one or more Active Directory forest objects in Microsoft System Center 2012 Configuration Manager. You can get an Active Directory forest object by ID or fully qualified domain name (FQDN).

Parameters

-ForestFqdn<String>

Specifies the FQDN of a Configuration Manager object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String[]>

Specifies an array of IDs of Configuration Manager objects. You can find the identifier value in the ForestID property of an Active Directory forest.


Aliases

ForestId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Get all Active Directory forest objects

This example gets all Active Directory forest objects.


PS C:\> Get-CMActiveDirectoryForest

Example 2: Get an Active Directory Forest object by ID

This example gets an Active Directory forest object that has the ID 16777217.


PS C:\> Get-CMActiveDirectoryForest -Id "16777217"

Example 3: Get Active Directory Forest by domain name

This example gets an Active Directory forest object that has the FQDN western.contoso.com.


PS C:\> Get-CMActiveDirectoryForest -ForestFqdn "western.contoso.com"

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft