Test-ADDSDomainControllerInstallation

Module:

ADDSDeployment

Runs the prerequisites (only) for installing a domain controller in Active Directory.

Syntax

Test-ADDSDomainControllerInstallation
    -DomainName <String>
    [-SafeModeAdministratorPassword <SecureString>]
    [-SiteName <String>]
    [-ADPrepCredential <PSCredential>]
    [-AllowDomainControllerReinstall]
    [-ApplicationPartitionsToReplicate <String[]>]
    [-CreateDnsDelegation]
    [-Credential <PSCredential>]
    [-CriticalReplicationOnly]
    [-DatabasePath <String>]
    [-DnsDelegationCredential <PSCredential>]
    [-NoDnsOnNetwork]
    [-NoGlobalCatalog]
    [-InstallationMediaPath <String>]
    [-InstallDns]
    [-LogPath <String>]
    [-MoveInfrastructureOperationMasterRoleIfNecessary]
    [-NoRebootOnCompletion]
    [-ReplicationSourceDC <String>]
    [-SkipAutoConfigureDns]
    [-SystemKey <SecureString>]
    [-SysvolPath <String>]
    [-Force]
    [<CommonParameters>]

Test-ADDSDomainControllerInstallation
    -DomainName <String>
    [-SafeModeAdministratorPassword <SecureString>]
    -SiteName <String>
    [-ADPrepCredential <PSCredential>]
    [-AllowDomainControllerReinstall]
    [-AllowPasswordReplicationAccountName <String[]>]
    [-ApplicationPartitionsToReplicate <String[]>]
    [-Credential <PSCredential>]
    [-CriticalReplicationOnly]
    [-DatabasePath <String>]
    [-DelegatedAdministratorAccountName <String>]
    [-DenyPasswordReplicationAccountName <String[]>]
    [-NoDnsOnNetwork]
    [-NoGlobalCatalog]
    [-InstallationMediaPath <String>]
    [-InstallDns]
    [-LogPath <String>]
    [-MoveInfrastructureOperationMasterRoleIfNecessary]
    [-ReadOnlyReplica]
    [-NoRebootOnCompletion]
    [-ReplicationSourceDC <String>]
    [-SkipAutoConfigureDns]
    [-SystemKey <SecureString>]
    [-SysvolPath <String>]
    [-Force]
    [<CommonParameters>]

Test-ADDSDomainControllerInstallation
    -DomainName <String>
    [-SafeModeAdministratorPassword <SecureString>]
    [-ADPrepCredential <PSCredential>]
    [-ApplicationPartitionsToReplicate <String[]>]
    [-Credential <PSCredential>]
    [-CriticalReplicationOnly]
    [-DatabasePath <String>]
    [-NoDnsOnNetwork]
    [-InstallationMediaPath <String>]
    [-LogPath <String>]
    [-NoRebootOnCompletion]
    [-ReplicationSourceDC <String>]
    [-SkipAutoConfigureDns]
    [-SystemKey <SecureString>]
    [-SysvolPath <String>]
    [-UseExistingAccount]
    [-Force]
    [<CommonParameters>]

Description

The Test-ADDSDomainControllerInstallation cmdlet runs those prerequisite checks (only) which would be performed if you were to use the Install-ADDSDomainController cmdlet to install a domain controller in Active Directory. It differs from using the WhatIf parameter with the Install-ADDSDomainController cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment.

For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in AD DS Simplified Administration.

Examples

Example 1: Test if the installation of domain controller is possible

$HashArguments = @{
    Credential = (Get-Credential CORP\Administrator)
    DomainName = "corp.contoso.com"
    InstallDns = $true
}
Test-ADDSDomainControllerInstallation @HashArguments

This command runs the prerequisites to determine if installing a domain controller is possible that includes a DNS server for the corp.contoso.com domain using domain administrator credentials. The command also prompts the user to enter and confirm the Directory Services Restore Mode (DSRM) password.

Example 2: Test if the installation of domain controller and DNS server is possible

Test-ADDSDomainControllerInstallation -InstallDns -DomainName "corp.contoso.com"

This command runs the prerequisites to determine if installing a domain controller along with the DNS server in the corp.contoso.com domain. The command also prompts the user to enter and confirm the DSRM password.

Example 3: Test if installation of domain controller is possible using Administrator credentials

$HashArguments = @{
    Credential = (Get-Credential)
    DomainName = (Read-Host "Domain to promote into")
    InstallDns = $true
}
Test-ADDSDomainControllerInstallation @HashArguments

This command runs the prerequisites to determine if installing a domain controller along with a DNS server and that will cause the user to be prompted for Administrator credentials as well as whether the domain name is possible and if the user is prompted to enter and confirm the DSRM password.

Parameters

-ADPrepCredential

Specifies the user name and password that corresponds to the account to be used for running operations (if they are required) to prepare Active Directory prior to the installation of this domain. Use the Get-Credential cmdlet to prompt the user to supply a password.

Type:	PSCredential
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowDomainControllerReinstall

Indicates that the cmdlet continues to install this domain controller, despite the fact that another domain controller account with the same name is detected. By default, the Install-ADDSDomainController cmdlet does not continue to install if another domain controller with the same name is found.

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

-AllowPasswordReplicationAccountName

Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. Use an empty string ("") if you want to keep the value empty. By default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed.

Type:	String[]
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ApplicationPartitionsToReplicate

Specifies an array of application directory partitions that DCPromo replicates. Use the following format: "partition1" "partition2" "partitionN". Use * to replicate all application directory partitions.

Type:	String[]
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CreateDnsDelegation

Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you are installing along with the domain controller. Valid for Active Directory-integrated DNS only. If this parameter is specified then the DNS delegation is created. If the value of $False is specified then no DNS delegation is created. By default, the value for this parameter is computed automatically based on the environment.

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

-Credential

Specifies the user name and password that corresponds to the account used to install the domain controller. Use the Get-Credential cmdlet to prompt the user to supply a password.

Type:	PSCredential
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CriticalReplicationOnly

Indicates that the cmdlet performs only critical replication before reboot and then continues during the AD DS installation operation. This parameter will skip the noncritical and potentially lengthy portion of replication. The noncritical replication happens after the installation finishes and the computer reboots. By default, the cmdlet performs both critical and noncritical portions of the replication.

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

-DatabasePath

Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that will contain the domain database, for instance, C:\Windows\NTDS. The default is %SYSTEMROOT%\NTDS.

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

-DelegatedAdministratorAccountName

Specifies the name of the user or group that is the delegated administrator of this domain controller.

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

-DenyPasswordReplicationAccountName

Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. Use an empty string ("") if you do not want to deny the replication of credentials of any users or computers. By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins.

Type:	String[]
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DnsDelegationCredential

Specifies the user name and password for creating DNS delegation. The cmdlet will skip the parameter if the value for the -CreateDnsDelegation parameter is either specified or computed to be $false.

Type:	PSCredential
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainName

Specifies the fully qualified domain name (FQDN) for the domain where the domain controller is installed or added.

Type:	String
Position:	Named
Default value:	<mandatory>
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Forces the command to run without asking for user confirmation.

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

-InstallationMediaPath

Specifies the location of the installation media that is used to install a new domain controller.

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

-InstallDns

Indicates that the cmdlet installs and configures the DNS Server service on the domain controller. For domain controller installation, if this parameter is left unspecified and the current domain already hosts and stores the DNS names for the domain, then the default for this parameter is $true and the DNS server is installed. Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server is installed.

To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. For example, if the value of the DomainName parameter is corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response is corp.contoso.com.

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

-LogPath

Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for instance, C:\Windows\Logs. The default is %SYSTEMROOT%\NTDS.

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

-MoveInfrastructureOperationMasterRoleIfNecessary

Indicates that the cmdlet transfers the infrastructure master role to the domain controller that you create in case the transfer is needed. You cannot use the NoGlobalCatalog parameter when specifying this parameter. Do not specify this parameter if you want the infrastructure master role to remain where it currently is.

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

-NoDnsOnNetwork

Indicates that the DNS service is not available on the network. This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. It indicates that a DNS server is installed on this computer for name resolution. Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server.

Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. Therefore, if you do not specify this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address.

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

-NoGlobalCatalog

Indicates that the read-only domain controller (RODC) is not a global catalog server. By default, the domain controller that you are installing is a global catalog server.

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

-NoRebootOnCompletion

Indicates that the cmdlet does not restart the computer upon the completion of the operation to install the domain controller. By default, if this parameter is omitted the computer restarts upon the completion of the install operation. As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a domain controller until it is rebooted.

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

-ReadOnlyReplica

Indicates that this cmdlet installs the domain controller as an RODC for an existing domain.

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

-ReplicationSourceDC

Specifies the name of the domain controller to be used as the source for replicating to this domain controller.

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

-SafeModeAdministratorPassword

Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. If no value is specified for this parameter, the cmdlet prompts you to enter and confirm a masked password. If specified with a value, the value must be a secure string.

Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. If specified with a value, the value must be a secure string.

If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. This is the preferred usage when running the cmdlet interactively. If additionally there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. This is not recommended as it could allow a mistyped password to be configured. Another available advanced option is to use the ConvertTo-SecureString cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments.

Type:	SecureString
Position:	Named
Default value:	<mandatory>
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SiteName

Specifies the name of an existing site where you can place the new domain controller. The default value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. If no such site exists, the default is the site of the replication source domain controller.

Type:	String
Position:	Named
Default value:	<mandatory>
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipAutoConfigureDns

Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root hints. This parameter is in effect only if the DNS Server service is already installed.

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

-SystemKey

Specifies the system key for the media from which you replicate the data. The default is none.

Type:	SecureString
Position:	Named
Default value:	NULL
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SysvolPath

Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the Sysvol data, for example, C:\Windows\SYSVOL. The default is %SYSTEMROOT%\SYSVOL.

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

-UseExistingAccount

Indicates that the cmdlet attaches a server to an existing RODC account. If specified, a member of the Domain Admins group or a delegated user can run this cmdlet.

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

Related Links

• Understand and Troubleshoot AD DS Simplified Administration
• Install-ADDSDomainController
• Test-ADDSReadOnlyDomainControllerAccountCreation
• Test-ADDSDomainInstallation
• Test-ADDSForestInstallation
• Get-Credential
• ConvertTo-SecureString