New-AdfsLdapServerConnection
New-AdfsLdapServerConnection is accessible with the help of adfs module. To install adfs on your system please refer to this adfs.
Synopsis
Creates a connection object.
Description
The New-AdfsLdapServerConnection cmdlet creates a connection object that represents the Lightweight Directory Access Protocol (LDAP) folder that serves as a claims provider trust. A connection object includes host name, port, and authentication credentials.
Parameters
-AuthenticationMethod
Specifies the authentication method the local claims provider trust uses. In Windows Server 2016, the only supported method is Basic (username/password).
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to use for the connection to the LDAP host. To obtain a PSCredential object, use the Get-Credential cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-HostName <String>
Specifies the fully qualified domain name of the server that hosts the LDAP folder to which Active Directory Federation Services (AD FS) connects for authentication requests.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
Specifies the port that AD FS uses to connect to the LDAP host.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-SslMode <LdapSslMode>
Specifies SSL setting of the connection. The acceptable values for this parameter are:
-- None
-- Ssl
-- Tls
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
Syntax
New-AdfsLdapServerConnection [-HostName] <String> [-Port <Int32>] [-SslMode <LdapSslMode>] [-AuthenticationMethod <LdapAuthenticationMethod>] [-Credential <PSCredential>] [<CommonParameters>]
—————-Example 1—————-
Create an LDAP connection
PS C:>$Credential = Get-Credential
PS C:\ > $LdapConn = New-AdfsLdapServerConnection -HostName “DC1.TOSSolution.com” -Port 389 -SslMode None -AuthenticationMethod Basic -Credential $Credential
The first command prompts you for a user name and password by using the Get-Credential cmdlet. The command stores the results in the $Credential variable.
The second command creates an LDAP connection. DC1.TOSSolution.com is the fully qualified domain name of a domain controller in the other forest. The command stores the result in the $LdapConn variable.
To see this cmdlet as part of creating an LDAP local claims provider trust, see the Add-AdfsLocalClaimsProviderTrust cmdlet.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command New-AdfsLdapServerConnection
You can also read about
- Add-AdfsLocalClaimsProviderTrust