Set-CMActiveDirectoryForest
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 SP1 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. 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 the FQDN of a Configuration Manager object.
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 running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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 command 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"