Diff: Help/LdapSearchPlugin

Differences between current version and predecessor to the previous major change of Help/LdapSearchPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 5 Last edited on October 14, 2015 11:47 am by PhilHollenback
Older page: version 4 Last edited on February 23, 2012 2:52 pm by PhilHollenback Revert
@@ -20,32 +20,46 @@
 }}} 
  
 == Arguments == 
  
-host _(default: from LDAP_AUTH_HOST or localhost)_:  
- hostname or ip or ldap:// uri to connect to.  
-  
-port _(default: from LDAP_AUTH_HOST or 389)_:  
- portnumber to connect to.  
-  
-basedn _(default: LDAP_BASE _DN)_:  
- connect string: "ou=Users,o=Development,dc=mycompany.com"  
-  
-filter _(default: "(cn= *)")_:  
- Optional ldap_search() filter argument  
-  
-attributes _(default: empty)_ :  
- space seperated fields to return as table columns: "cn sn"  
-  
-options:  
- ldap_set_option(). Default: LDAP_SET_OPTION if host == LDAP_AUTH_HOST  
- Column seperated name=value pairs. Esp. needed for Windows Active directory:  
- "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"  
-user:  
- Default: LDAP_AUTH _USER if host == LDAP_AUTH_HOST  
-password:  
- Default: LDAP_AUTH_PASSWORD if host == LDAP_AUTH_HOST  
- user and password are required for Windows Active directory. 
+{| class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| ** host**  
+| hostname or ip or ldap:// uri to connect to.  
+| from LDAP_AUTH_HOST or localhost  
+|-  
+| **port**  
+| portnumber to connect to.  
+| from LDAP_AUTH _HOST or 389  
+|-  
+| **basedn**  
+| connect string: "ou=Users,o=Development,dc=mycompany.com"  
+| LDAP_BASE_DN  
+|-  
+| ** filter**  
+| Optional ldap_search() filter argument  
+| "(cn=*)"  
+|-  
+| ** attributes**  
+| space separated fields to return as table columns: "cn sn"  
+| empty  
+|-  
+| ** options**  
+| ldap_set_option(). Column separated name=value pairs. Esp. needed for Windows Active directory: "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"  
+| LDAP_SET _OPTION if host == LDAP_AUTH_HOST  
+|-  
+| **user**  
+| user and password are required for Windows Active directory.  
+| Default: LDAP_AUTH_USER if host == LDAP_AUTH_HOST  
+|-  
+| **password**  
+| user and password are required for Windows Active directory.  
+| Default: LDAP_AUTH_PASSWORD if host == LDAP_AUTH_HOST  
+|}  
  
 == Examples == 
  
 <<WikiFormRich action=LdapSearch 
@@ -57,12 +71,12 @@
  submit[] reset[] 
 >> 
  
 == Author == 
-* [[PhpWiki:JohnLines| John Lines]]  
+* John Lines 
  
 == See Also == 
  
 <noinclude> 
 ---- 
 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]] 
 </noinclude> 

current version

The LdapSearch plugin displays a LDAP query as table.

Usage

<<LdapSearch>>
<<LdapSearch
           host="localhost"
           port=389
           basedn=""
           filter="(cn=*)"
           attributes=""
>>
<<LdapSearch host=ldap.example.com filter="(ou=web-team)"
                      attributes="sn cn telephonenumber">>
<<LdapSearch host="ldap.itd.umich.edu" basedn="" filter="(sn=jensen)" attributes="cn drink">>
<<LdapSearch host=ldap.example.com attributes="cn sn telephonenumber">>
<<LdapSearch host=bugs.debian.org port=10101 basedn="dc=current,dc=bugs,dc=debian,dc=org"
                      filter="(debbugsPackage=phpwiki)"
                      attributes="debbugsSeverity debbugsState debbugsTitle">>

Arguments

Argument

Description

Default value

host

hostname or ip or ldap:// uri to connect to.

from LDAP_AUTH_HOST or localhost

port

portnumber to connect to.

from LDAP_AUTH_HOST or 389

basedn

connect string: "ou=Users,o=Development,dc=mycompany.com"

LDAP_BASE_DN

filter

Optional ldap_search() filter argument

"(cn=*)"

attributes

space separated fields to return as table columns: "cn sn"

empty

options

ldap_set_option(). Column separated name=value pairs. Esp. needed for Windows Active directory: "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"

LDAP_SET_OPTION if host == LDAP_AUTH_HOST

user

user and password are required for Windows Active directory.

Default: LDAP_AUTH_USER if host == LDAP_AUTH_HOST

password

user and password are required for Windows Active directory.

Default: LDAP_AUTH_PASSWORD if host == LDAP_AUTH_HOST

Examples

host 
port 
basedn 
filter 
attributes 

Author

  • John Lines

See Also



Our Founder
ToolboxClick to hide/show