Diff: Help/LdapSearchPlugin
Note: You are viewing an old revision of this page. View the current version.
Differences between version 3 and previous revision of Help/LdapSearchPlugin.
Other diffs: Previous Major Revision, Previous Author
| Newer page: | version 3 | Last edited on 9 September 2007 0:16 | by harold | Revert |
| Older page: | version 2 | Last edited on 22 May 2014 3:01 | by harold | Revert |
@@ -1,82 +1,66 @@
-The **~LdapSearch** [[
Help:WikiPlugin|plugin]]
displays a LDAP query as table.
+Help:WikiPlugin which
displays a LDAP query as table.
-==
Usage ==
-{{{
-<<
LdapSearch>
>
-<<
LdapSearch
+!
Usage
+<verbatim>
+
<?plugin
LdapSearch ?
>
+
<?plugin
LdapSearch
host="localhost"
port=389
basedn=""
-
filter="(cn=*)"
+
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"
+ ?
>
+
<?plugin
LdapSearch host=ldap.example.com filter="(ou=web-team)"
+ attributes="sn cn telephonenumber" ?
>
+
<?plugin
LdapSearch host="ldap.itd.umich.edu" basedn="" filter="(sn=jensen)" attributes="cn drink" ?
>
+
<?plugin
LdapSearch host=ldap.example.com attributes="cn sn telephonenumber" ?
>
+
<?plugin
LdapSearch host=bugs.debian.org port=10101 basedn="dc=current,dc=bugs,dc=debian,dc=org"
filter="(debbugsPackage=phpwiki)"
- attributes="debbugsSeverity debbugsState debbugsTitle">
>
-}}}
+ attributes="debbugsSeverity debbugsState debbugsTitle" ?
>
+</verbatim>
-==
Arguments ==
+!
Arguments
-{| 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
-|}
+host _(default
: from LDAP_AUTH_HOST or localhost)
_:
+ hostname or ip or
ldap:// uri to connect
to.
-== Examples ==
+port _(default: from LDAP_AUTH_HOST or 389)_:
+ portnumber to connect to.
-<<
WikiFormRich action=LdapSearch
+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.
+
+! Examples
+
+
<?plugin
WikiFormRich action=LdapSearch
editbox[] name=host value=bugs.debian.org size=80
editbox[] name=port value=10101 size=80
editbox[] name=basedn value="dc=current,dc=bugs,dc=debian,dc=org" size=80
-
editbox[] name=filter value="(debbugsPackage=phpwiki)" size=80
+
editbox[] name=filter value="(debbugsPackage=phpwiki)" size=80
editbox[] name=attributes value="debbugsSeverity debbugsState debbugsTitle" size=80
-
submit[] reset[]
->
>
+
submit[] reset[]
+?
>
-==
Author ==
-* John Lines
+!
Author
+PhpWiki:JohnLines
-==
See Also ==
+!
See Also
-<noinclude>
----
-[[
PhpWikiDocumentation]] [[CategoryWikiPlugin]]
-</noinclude>
+PhpWikiDocumentation Help:WikiPlugin
version 3
Help:WikiPlugin which displays a LDAP query as table.
Usage
<?plugin LdapSearch ?>
<?plugin LdapSearch
host="localhost"
port=389
basedn=""
filter="(cn=*)"
attributes=""
?>
<?plugin LdapSearch host=ldap.example.com filter="(ou=web-team)"
attributes="sn cn telephonenumber" ?>
<?plugin LdapSearch host="ldap.itd.umich.edu" basedn="" filter="(sn=jensen)" attributes="cn drink" ?>
<?plugin LdapSearch host=ldap.example.com attributes="cn sn telephonenumber" ?>
<?plugin LdapSearch host=bugs.debian.org port=10101 basedn="dc=current,dc=bugs,dc=debian,dc=org"
filter="(debbugsPackage=phpwiki)"
attributes="debbugsSeverity debbugsState debbugsTitle" ?>
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.
