<CFLDAP SERVER="server_name"
PORT="port_number"
USERNAME="name"
PASSWORD="password"
ACTION="action"
NAME="name"
TIMEOUT="seconds"
MAXROWS="number"
START="distinguished_name"
SCOPE="scope"
ATTRIBUTES="attribute, attribute"
FILTER="filter"
SORT="sort_order"
DN="distinguished_name"
STARTROW="row_number">
SERVER
Required. Host name ("biff.upperlip.com") or IP address ("192.1.2.225") of the LDAP server.
PORT
Optional. Port defaults to the standard LDAP port, 389.
USERNAME
Optional. If no user name is specified, the LDAP connection will be anonymous.
PASSWORD
Optional. Password corresponds to user name.
ACTION
Optional. Specifies the LDAP action. There are five possible values:
- Query -- (Default) Returns LDAP entry information only. Requires NAME, START, ATTRIBUTES attributes.
- Add -- Adds LDAP entries to the LDAP server. Requires ATTRIBUTES.
- Modify -- Modifies LDAP entries on an LDAP server with the exception of the distinguished name ("DN") attribute. Requires DN, ATTRIBUTES.
- ModifyDN -- Modifies the distinguished name attribute for LDAP entries on an LDAP server. Requires DN, ATTRIBUTES.
- Delete -- Deletes LDAP entries on an LDAP server. Requires DN.
NAME
Required for ACTION="Query". The name you assign to the LDAP query.
TIMEOUT
Optional. Specifies the maximum amount of time in seconds to wait for LDAP processing. Defaults to 60 seconds.
MAXROWS
Optional. Specifies the maximum number of entries for LDAP queries.
START
Required for ACTION="Query". Specifies the distinguished name of the entry to be used to start the search.
SCOPE
Optional. Specifies the scope of the search from the entry specified in the Start attribute for ACTION="Query". There are three possible values:
- OneLevel -- (Default) Searches all entries one level beneath the entry specified in the START attribute.
- Base -- Searches only the entry specified in the START attribute.
- Subtree -- Searches the entry specified in the START attribute as well all entries at all levels beneath it.
ATTRIBUTES
Required for ACTION="Query", Add, ModifyDN, and Modify. For queries, specifies the comma-separated list of attributes to be returned for queries. Can also be used to specify the list of update columns for ACTION="Add" or Modify. When used with ACTION="Add" and Action="Modify", separate multiple attributes with a semicolon. When used with ACTION="ModifyDN", ColdFusion passes attributes to the LDAP server without performing any syntax checking.
FILTER
Optional. Specifies the search criteria for ACTION="Query". Attributes are referenced in the form: "(attribute operator value)". Example: "(sn=Smith)". Default is "objectclass=*".
SORT
Optional. Specifies the attribute to sort query results by. Enter Asc for an ascending sort and Desc for a descending sort.
DN
Required for ACTION="Add", Modify, ModifyDN, and Delete. Specifies the distinguished name for update actions. Example: "cn=Barbara Jensen, o=Ace Industry, c=US".
|