Edit

Share via

New-CMActiveDirectoryForest

  • Reference
Module:
ConfigurationManager

Creates one or more Active Directory forest objects in Configuration Manager.

Syntax

New-CMActiveDirectoryForest
   [-Description <String>]
   [-EnableDiscovery <Boolean>]
   -ForestFqdn <String>
   [-Password <SecureString>]
   [-PublishingPath <String>]
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-CMActiveDirectoryForest cmdlet creates an Active Directory forest object that has a fully qualified domain name (FQDN), description, and publishing path that you supply.

If you configured an Active Directory Forest Discovery method, you can enable discovery for an Active Directory forest. After you enable discovery, Configuration Manager discovers Active Directory sites and subnets.

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: Create an Active Directory forest object that has discovery enabled

PS XYZ:\> New-CMActiveDirectoryForest -ForestFqdn "tsqa.contoso.com" -EnableDiscovery $True

This command creates an Active Directory forest object that has the FQDN tsqa.contoso.com and that has discovery enabled. You must configure an Active Directory Forest Discovery method before discovery can work.

Parameters

-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. If you enable discovery, you must configure an Active Directory Forest Discovery method. 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 an FQDN of a Configuration Manager object.

Type:String
Position:Named
Default value:None
Required:True
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

-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

None

Outputs

IResultObject