API Reference
Command
Test-ADXLdap
Tests LDAP connectivity on domain controllers.
Examples
Example 1: Test LDAP and LDAPS on all domain controllers in the current forest
Test-ADXLdap -Forest 'contoso.com' -Identity 'krbtgt'
Example 2: Validate LDAP, LDAPS, and GC ports on selected controllers with a probe credential
$credential = Get-Credential 'CONTOSO\svc_ldap_probe'
Test-ADXLdap -ComputerName 'dc-01.contoso.com','dc-02.contoso.com' -Credential $credential -RetryCount 2 -ProbeLegacyTls
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Test-ADXLdap [-ComputerName <string[]>] [-CertificateIncludeDomainName <string[]>] [-Credential <PSCredential>] [-Domain <string[]>] [-Forest <string>] [-GCPortLDAP <int>] [-GCPortLDAPS <int>] [-Identity <string>] [-IncludeTrusts] [-MaxConcurrency <int>] [-NoCertificateValidation] [-PerPortTimeoutMs <int>] [-PortLDAP <int>] [-PortLDAPS <int>] [-ProbeLegacyTls] [-RetryCount <int>] [-RetryDelayMs <int>] [-ServerBudgetMs <int>] [-SkipCheckGC] [-SkipRODC] [<CommonParameters>]Parameters
- ComputerName string[]
- Server names to test. When omitted all DCs are tested.
- CertificateIncludeDomainName string[]
- When verifying certificate, validates that certificate DNS names include all specified values.
- Credential PSCredential
- Credential for binding.
- Domain string[]
- Domains to test.
- Forest string
- Forest name when enumerating domains.
- GCPortLDAP int
- GC LDAP port.
- GCPortLDAPS int
- GC LDAPS port.
- Identity string
- User identity to verify.
- IncludeTrusts SwitchParameter
- Include trusted forests when querying domains.
- MaxConcurrency int
- Maximum concurrent server tests.
- NoCertificateValidation SwitchParameter
- Opt out of certificate verification. By default, certificate verification is performed.
- PerPortTimeoutMs int
- Timeout per port operation (ms). Default 3000.
- PortLDAP int
- LDAP port.
- PortLDAPS int
- LDAPS port.
- ProbeLegacyTls SwitchParameter
- Probe accepted TLS versions on LDAPS (adds extra handshakes).
- RetryCount int
- Number of retries per port.
- RetryDelayMs int
- Milliseconds to wait between retries.
- ServerBudgetMs int
- Total budget per server (ms). Default 30000.
- SkipCheckGC SwitchParameter
- Skip Global Catalog ports.
- SkipRODC SwitchParameter
- Skip read-only domain controllers.
Outputs
ADPlayground.Ldap.LdapServerReadable, ADPlayground.Ldap.LdapServerResult