1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="idmap_ldap.8">
6 <refentrytitle>idmap_ldap</refentrytitle>
7 <manvolnum>8</manvolnum>
12 <refname>idmap_ldap</refname>
13 <refpurpose>Samba's idmap_ldap Backend for Winbind</refpurpose>
17 <title>DESCRIPTION</title>
19 <para>The idmap_ldap plugin provides a means for Winbind to
20 store and retrieve SID/uid/gid mapping tables in an LDAP directory
21 service. The module implements both the "idmap" and
22 "idmap alloc" APIs.
27 <title>IDMAP OPTIONS</title>
31 <term>ldap_base_dn = DN</term>
33 Defines the directory base suffix to use when searching for
34 SID/uid/gid mapping entries. If not defined, idmap_ldap will default
35 to using the "ldap idmap suffix" option from smb.conf.
40 <term>ldap_url = ldap://server/</term>
42 Specifies the LDAP server to use when searching for existing
43 SID/uid/gid map entries. If not defined, idmap_ldap will
44 assume that ldap://localhost/ should be used.
49 <term>range = low - high</term>
51 Defines the available matching uid and gid range for which the
52 backend is authoritative. Note that the range commonly matches
53 the allocation range due to the fact that the same backend will
54 store and retrieve SID/uid/gid mapping entries. If the parameter
55 is absent, Winbind fail over to use the "idmap uid" and
56 "idmap gid" options from smb.conf.
63 <title>IDMAP ALLOC OPTIONS</title>
67 <term>ldap_base_dn = DN</term>
69 Defines the directory base suffix under which new SID/uid/gid mapping
70 entries should be stored. If not defined, idmap_ldap will default
71 to using the "ldap idmap suffix" option from smb.conf.
76 <term>ldap_url = ldap://server/</term>
78 Specifies the LDAP server to which modify/add/delete requests should
79 be sent. If not defined, idmap_ldap will assume that ldap://localhost/
85 <term>range = low - high</term>
87 Defines the available matching uid and gid range from which
88 winbindd can allocate for users and groups. If the parameter
89 is absent, Winbind fail over to use the "idmap uid"
90 and "idmap gid" options from smb.conf.
97 <title>EXAMPLES</title>
100 The follow sets of a LDAP configuration which uses a slave server
101 running on localhost for fast fetching SID/gid/uid mappings, it
102 implies correct configuration of referrals.
103 The idmap alloc backend is pointed directly to the master to skip
104 the referral (and consequent reconnection to the master) that the
105 slave would return as allocation requires writing on the master.
110 idmap domains = ALLDOMAINS
111 idmap config ALLDOMAINS:default = yes
112 idmap config ALLDOMAINS:backend = ldap
113 idmap config ALLDOMAINS:ldap_base_dn = ou=idmap,dc=example,dc=com
114 idmap config ALLDOMAINS:ldap_url = ldap://localhost/
115 idmap config ALLDOMAINS:range = 10000 - 50000
117 idmap alloc backend = ldap
118 idmap alloc config:ldap_base_dn = ou=idmap,dc=example,dc=com
119 idmap alloc config:ldap_url = ldap://master.example.com/
120 idmap alloc config:range = 10000 - 50000
125 <title>AUTHOR</title>
128 The original Samba software and related utilities
129 were created by Andrew Tridgell. Samba is now developed
130 by the Samba Team as an Open Source project similar
131 to the way the Linux kernel is developed.