Adding an LDAP Site (AddLDAPSite)

Use the ICISites interface AddLDAPSite method to add a Site that uses LDAP.

This method is available in EFT Server 4.3.4 and later.

Signature:

HRESULT AddLDAPSite(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in,optional] BSTR bstrDomainContext,

[in,optional] BSTR bstrAllowGroup,

[in] int nIP,

[in] long nPort,

[in] VARIANT_BOOL bCreateHomeFolder,

[in] VARIANT_BOOL bPermHomeFolder,

[in] VARIANT_BOOL bAutoStart,

[out, retval] ICISite** prop);

 

Parameters

Definition

bstrName

New site name

bstrRootFolder

Site root folder

bstrDomainContext

LDAP domain components, e.g. DNS domain name

bstrAllowGroup

LDAP group name

nIP

Index of the site IP address

nPort

Port number of the site

bCreateHomeFolder

TRUE means that a home folder for new site users should be created

bPermHomeFolder

TRUE means that new site users should be granted full permissions in their home folders

bAutoStart

TRUE means that the site should start automatically

 

You can also call Add(), setting "3" as the nAMID parameter to create an LDAP site.

Configuration Notes

The "bstrDomainContext" string that is passed in must be composed properly to define the parameters of the LDAP site. The syntax is the same for both methods: a semicolon separated list of name/value pairs that defines the LDAP options.

Example:

LDAPDB={path to AUD file};LDAPSERVER={IP or Hostname for LDAP server};LDAPPORT={port on LDAP server};BASEDN={base dn for users};USERFILTER={filter for LDAP query to return users};USERATTRIBUTE={what user attribute to use as client login};TYPE={0 for anonymous bind, 1 for simple bind};USERNAME={cn of the user to bind as for querying users};PASSWORD={password for that user};SSL={0 for no SSL, 1 for SSL}

Empty values can be blank, but the name must exist, such as for an anonymous bind "USERNAME=;"

Example:

Connect to a server using the LDAP protocol. Note that "USERNAME=" and "PASSWORD=" must be configured appropriately for your  login, and an appropriate path for "LDAPDB=" should be specified.

LDAPDB=d:\program files\foostation\eft\LDAP.aud;LDAPSERVER=199.199.99.99;LDAPPORT=389;BASEDN=cn=users,dc=forest,dc=intranet,dc=fs;USERFILTER=(objectClass=person);USERATTRIBUTE=SamAccountName;TYPE=0;USERNAME=cn=user,cn=users,dc=forest,dc=intranet,dc=fs;PASSWORD=secret;SSL=0