New-CMActiveDirectoryForest
New-CMActiveDirectoryForest
Creates one or more Active Directory forest objects in Configuration Manager.
Syntax
Parameter Set: New
New-CMActiveDirectoryForest -EnableDiscovery <Boolean> -ForestFqdn <String> [-Description <String> ] [-PublishingPath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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, Microsoft System Center 2012 SP1 Configuration Manager discovers Active Directory sites and subnets.
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. If you enable discovery, you must configure an Active Directory Forest Discovery method. The default value is $False.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ForestFqdn<String>
Specifies an FQDN of a Configuration Manager object.
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: Create an Active Directory forest object that has discovery enabled
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.
PS C:\> New-CMActiveDirectoryForest -ForestFqdn "tsqa.contoso.com" -EnableDiscovery $True