summaryrefslogtreecommitdiff
path: root/docs/manpages-3/idmap_ldap.8.xml
blob: 32c3f5e921ad859a7616a42fff660e9ad9873a6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="idmap_ldap.8">

<refmeta>
	<refentrytitle>idmap_ldap</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>idmap_ldap</refname>
	<refpurpose>Samba's idmap_ldap Backend for Winbind</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<title>DESCRIPTION</title>

	<para>The idmap_ldap plugin provides a means for Winbind to
	store and retrieve SID/uid/gid mapping tables in an LDAP directory 
	service.  The module implements both the &quot;idmap&quot; and 
	&quot;idmap alloc&quot; APIs.
	</para>
</refsynopsisdiv>

<refsect1>
	<title>IDMAP OPTIONS</title>

	<variablelist>		
		<varlistentry>
		<term>ldap_base_dn = DN</term>
		<listitem><para>
			Defines the directory base suffix to use when searching for 
			SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
			to using the &quot;ldap idmap suffix&quot; option from smb.conf.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>ldap_url = ldap://server/</term>
		<listitem><para>
			Specifies the LDAP server to use when searching for existing 
			SID/uid/gid map entries. If not defined, idmap_ldap will 
			assume that ldap://localhost/ should be used.
		</para></listitem>
		</varlistentry>

                <varlistentry>
		<term>range = low - high</term>
                <listitem><para>
			Defines the available matching uid and gid range for which the
			backend is authoritative.  Note that the range commonly matches
			the allocation range due to the fact that the same backend will
			store and retrieve SID/uid/gid mapping entries.  If the parameter 
			is absent, Winbind fail over to use the &quot;idmap uid&quot; and 
			&quot;idmap gid&quot; options from smb.conf.  
                </para></listitem>
                </varlistentry>
	</variablelist>
</refsect1>

<refsect1>
	<title>IDMAP ALLOC OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>ldap_base_dn = DN</term>
		<listitem><para>
			Defines the directory base suffix under which new SID/uid/gid mapping
			entries should be stored.  If not defined, idmap_ldap will default
			to using the &quot;ldap idmap suffix&quot; option from smb.conf.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>ldap_url = ldap://server/</term>
		<listitem><para>
			Specifies the LDAP server to which modify/add/delete requests should
			be sent.  If not defined, idmap_ldap will assume that ldap://localhost/
			should be used.
		</para></listitem>
		</varlistentry>

                <varlistentry>
		<term>range = low - high</term>
                <listitem><para>
			Defines the available matching uid and gid range from which 
			winbindd can allocate for users and groups.  If the parameter 
			is absent, Winbind fail over to use the &quot;idmap uid&quot; 
			and &quot;idmap gid&quot; options from smb.conf.
                </para></listitem>
                </varlistentry>
	</variablelist>
</refsect1>

<refsect1>
	<title>EXAMPLES</title>

	<para>
	The follow sets of a LDAP configuration which uses a slave server
	running on localhost for fast fetching SID/gid/uid mappings, it
	implies correct configuration of referrals.
	The idmap alloc backend is pointed directly to the master to skip
	the referral (and consequent reconnection to the master) that the
	slave would return as allocation requires writing on the master.
	</para>

	<programlisting>
	[global]
	    idmap domain = ALLDOMAINS
	    idmap config ALLDOMAINS:default      = yes
	    idmap config ALLDOMAINS:backend      = ldap
	    idmap config ALLDOMAINS:ldap_base_dn = ou=idmap,dc=example,dc=com
	    idmap config ALLDOMAINS:ldap_url     = ldap://localhost/
	    idmap config ALLDOMAINS:range        = 10000 - 50000

	    idmap alloc backend = ldap
	    idmap alloc config:ldap_base_dn = ou=idmap,dc=example,dc=com
	    idmap alloc config:ldap_url     = ldap://master.example.com/
	    idmap alloc config:range        = 10000 - 50000
	</programlisting>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>
	The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.
	</para>	
</refsect1>

</refentry>