Commands › Exchange Online

Add-LdapDirectory

Exchange Online ExchangeOnlineManagement Add-*

Create LDAP directory configurations.

Quick start script

# Add-LdapDirectory — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Add-LdapDirectory -Id <String> -Host <String> -Port <Int32> | Format-List

# 3. Export for evidence / drift tracking
Add-LdapDirectory | Export-Clixml .\LdapDirectory-$(Get-Date -Format yyyyMMdd).xml

Syntax

Add-LdapDirectory [-Id] <String> [-Host] <String> [-Port] <Int32> -Organization <OrganizationIdParameter>
 [-BaseDn <String>]
 [-Confirm]
 [-TimeoutSec <Int32>]
 [-UseSsl]
 [-WhatIf]
 [<CommonParameters>]

Parameters (9)

Parameter	Type	Required	What it controls
-Id	String	yes	The Id parameter specifies the unique identifier of the LDAP directory configuration that you want to create.
-Host	String	yes	The Host parameter specifies the LDAP server host name or IP address.
-Port	Int32	yes	The Port parameter specifies the port used for LDAP communication. Typical values are 389 for LDAP and 636 for LDAPS.
-Organization	OrganizationIdParameter	yes	The Organization parameter specifies your organization where the LDAP directory configuration is created and stored (for example, contoso.onmicrosoft.com).
-BaseDn	String		The BaseDn parameter specifies the base distinguished name that scopes LDAP searches. For example, "OU=Users,DC=fabrikam,DC=com".
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-TimeoutSec	Int32		The TimeoutSec parameter specifies the LDAP connection timeout in seconds. A valid value is an integer between 1 and 300. The default value is 30.
-UseSsl	SwitchParameter		The UseSsl switch specifies that SSL/TLS is used for the connection to the LDAP server. You don't need to specify a value with this switch.
-WhatIf	SwitchParameter		The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.