Parameter: | Description: | Default: |
"uid=joeshmoe" | the LDAP query string | required |
base="..." | base dn of the (sub)tree to search in; if base is written in brackets (e.g. 'base="(ou=people)"') then it is prepended to the default base | the default base of the LdapContrib |
clear="..." | comma separated list of attributes to be removed from the output if they are not resolved | nothing is cleared |
default="..." | when the LDAP query yields no results, the value of this parameter is returned as the search result instead of null. Naturally, if hidenull is on, default doesn't have any effect | "" (null string) |
filter="uid=joeshmoe" | (Alternative to above) | N/A |
footer="..." | footer to appended to the output | no footer |
format="..." | format string used to display a database record | $dn |
header="..." | header to prepend the output | no header |
hidenull="on" | wether to hide any output on an empty hit set; possible values: on , off | off |
limit="100" | maximum number of records to return | no limit |
required="..." | a comma separated list of LDAP record attributes. If specified, the LDAP query results not having all of the specified attributes are eliminated | nothing is required |
reverse="on" | reverse the result set; possible values: on , off | off |
scope="one" | scope of search; possible values: sub , base , one | sub |
sep="..." or separator="..." | separator between database records | $n (new line) |
skip="10" | number of records in the hit set to skip before displaying them | 0 (nothing is skipped) |
sort="..." | name of attributes to sort the output | DN |