Set-CMActiveDirectoryForest
Changes Active Directory forest properties in Configuration Manager.
Syntax
SetByValue (Default)
Set-CMActiveDirectoryForest
-InputObject <IResultObject>
[-AddPublishingSite <IResultObject[]>]
[-Description <String>]
[-EnableDiscovery <Boolean>]
[-PassThru]
[-Password <SecureString>]
[-PublishingPath <String>]
[-RemovePublishingSite <IResultObject[]>]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByFQDN
Set-CMActiveDirectoryForest
-ForestFqdn <String>
[-AddPublishingSite <IResultObject[]>]
[-Description <String>]
[-EnableDiscovery <Boolean>]
[-PassThru]
[-Password <SecureString>]
[-PublishingPath <String>]
[-RemovePublishingSite <IResultObject[]>]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetById
Set-CMActiveDirectoryForest
-Id <UInt32>
[-AddPublishingSite <IResultObject[]>]
[-Description <String>]
[-EnableDiscovery <Boolean>]
[-PassThru]
[-Password <SecureString>]
[-PublishingPath <String>]
[-RemovePublishingSite <IResultObject[]>]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-CMActiveDirectoryForest cmdlet changes values for an Active Directory forest object in 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.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Change the description of an Active Directory forest
PS XYZ:\> Set-CMActiveDirectoryForest -Id "16777217" -Description "AD Forest 01"
This command changes the description of an Active Directory forest that has the ID 16777217 to AD Forest 01.
Parameters
-AddPublishingSite
The Set-CMActiveDirectoryForest cmdlet changes values for an Active Directory forest object in 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.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | IResultObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AddPublishingSites |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
Specifies a description for an Active Directory forest object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableDiscovery
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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ForestFqdn
Specifies the FQDN of a Configuration Manager object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetByFQDN
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specifies an array of IDs of Configuration Manager objects. You can find the identifier value in the ForestID property of an Active Directory forest.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ForestId |
Parameter sets
SetById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies an Active Directory forest object in Configuration Manager.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetByValue
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Password
{{ Fill Password Description }}
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PublishingPath
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RemovePublishingSite
The Set-CMActiveDirectoryForest cmdlet changes values for an Active Directory forest object in 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.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | IResultObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RemovePublishingSites |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserName
The Set-CMActiveDirectoryForest cmdlet changes values for an Active Directory forest object in 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.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.