Edit

Share via

Set-CMActiveDirectoryForest

  • Reference
Module:
ConfigurationManager

Changes Active Directory forest properties in Configuration Manager.

Syntax

Set-CMActiveDirectoryForest
   [-AddPublishingSite <IResultObject[]>]
   [-Description <String>]
   [-EnableDiscovery <Boolean>]
   -InputObject <IResultObject>
   [-PassThru]
   [-Password <SecureString>]
   [-PublishingPath <String>]
   [-RemovePublishingSite <IResultObject[]>]
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMActiveDirectoryForest
   [-AddPublishingSite <IResultObject[]>]
   [-Description <String>]
   [-EnableDiscovery <Boolean>]
   -ForestFqdn <String>
   [-PassThru]
   [-Password <SecureString>]
   [-PublishingPath <String>]
   [-RemovePublishingSite <IResultObject[]>]
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMActiveDirectoryForest
   [-AddPublishingSite <IResultObject[]>]
   [-Description <String>]
   [-EnableDiscovery <Boolean>]
   -Id <UInt32>
   [-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

Type:IResultObject[]
Aliases:AddPublishingSites
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for an Active Directory forest object.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForestFqdn

Specifies the FQDN of a Configuration Manager object.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

Type:UInt32
Aliases:ForestId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies an Active Directory forest object in Configuration Manager.

Type:IResultObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Password

{{ Fill Password Description }}

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemovePublishingSite

Type:IResultObject[]
Aliases:RemovePublishingSites
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject