Export (0) Print
Expand All
Expand Minimize

Set-CMActiveDirectoryForest

Updated: September 1, 2013

Applies To: System Center 2012 Configuration Manager SP1

Set-CMActiveDirectoryForest

Changes Active Directory forest properties in Configuration Manager.

Syntax

Parameter Set: SetById
Set-CMActiveDirectoryForest -Id <String[]> [-Description <String> ] [-EnableDiscovery <Boolean> ] [-PublishingPath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByFQDN
Set-CMActiveDirectoryForest -ForestFqdn <String> [-Description <String> ] [-EnableDiscovery <Boolean> ] [-PublishingPath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByValue
Set-CMActiveDirectoryForest -InputObject <IResultObject> [-Description <String> ] [-EnableDiscovery <Boolean> ] [-PublishingPath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-CMActiveDirectoryForest cmdlet changes values for an Active Directory forest object in Microsoft System Center 2012 Configuration Manager. You can edit the description, enable or disable discovery, and specify a fully qualified domain name (FQDN) and publishing path. You can specify an Active Directory forest object by ID or FQDN, or you can supply the Active Directory forest object itself.

Active Directory Forest Discovery requires a global account to discover or publish to untrusted forests.

Parameters

-Description<String>

Specifies a description for an Active Directory forest object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableDiscovery<Boolean>

Specifies whether to discover Active Directory sites and subnets. You must configure an Active Directory Forest Discovery method before you use this parameter. Valid values for this parameter are $True or $False. The default value is $False.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ForestFqdn<String>

Specifies an array of FQDNs of Configuration Manager objects.


Aliases

none

Required?

true

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

-InputObject<IResultObject>

Specifies an Active Directory forest object in Configuration Manager.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PublishingPath<String>

Specifies one or more Configuration Manager sites that publish site information to an Active Directory forest. You can use a comma-separated list in quotation marks to specify more than one site.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

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: Change the description of an Active Directory forest

This example changes the description of an Active Directory forest that has the ID 16777217 to AD Forest 01.


PS C:\> Set-CMActiveDirectoryForest -Id "16777217" -Description "AD Forest 01"

Related topics

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