s3:docs: update the idmap_tdb manpage to reflect current facts.
[ira/wip.git] / docs-xml / manpages-3 / idmap_tdb.8.xml
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_tdb.8">
4
5 <refmeta>
6         <refentrytitle>idmap_tdb</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.2</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>idmap_tdb</refname>
16         <refpurpose>Samba's idmap_tdb Backend for Winbind</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <title>DESCRIPTION</title>
21
22         <para>
23         The idmap_tdb plugin is the default backend used by winbindd
24         for storing SID/uid/gid mapping tables. In contrast to read only
25         backends like idmap_rid, it is an allocating backend:
26         This means that it needs to allocate new user and group IDs
27         to create new mappings as requests to yet unmapped users are answered.
28         </para>
29
30         <para>
31         Note that in order for this (or any other allocating) backend to
32         function at all, the default backend needs to be writeable.
33         The ranges used for uid and gid allocation are the default ranges
34         configured by &quot;idmap uid&quot; and &quot;idmap gid&quot;.
35         </para>
36
37         <para>
38         Furthermore, since there is only one global allocating backend
39         responsible for all domains using writeable idmap backends,
40         any explicitly configured domain with idmap backend tdb
41         should have the same range as the default range, since it needs
42         to use the global uid / gid allocator. See the example below.
43         </para>
44 </refsynopsisdiv>
45
46 <refsect1>
47         <title>IDMAP OPTIONS</title>
48
49         <variablelist>
50                 <varlistentry>
51                 <term>range = low - high</term>
52                 <listitem><para>
53                         Defines the available matching uid and gid range for which the
54                         backend is authoritative.
55                         If the parameter is absent, Winbind fails over to use
56                         the &quot;idmap uid&quot; and &quot;idmap gid&quot; options
57                         from smb.conf.
58                 </para></listitem>
59                 </varlistentry>
60         </variablelist>
61 </refsect1>
62
63 <refsect1>
64         <title>EXAMPLES</title>
65
66         <para>
67         This example shows how tdb is used as a the default idmap backend.
68         It configures the idmap range through the global options for all
69         domains encountered. This same range is used for uid/gid allocation.
70         </para>
71
72         <programlisting>
73         [global]
74         # "idmap backend = tdb" is redundant here since it is the default
75         idmap backend = tdb
76         idmap uid = 1000000-2000000
77         idmap gid = 1000000-2000000
78         </programlisting>
79
80         <para>
81         This (rather theoretical) example shows how tdb can be used as the
82         allocating backend while ldap is the default backend used to store
83         the mappings.
84         It adds an explicit configuration for some domain DOM1, that
85         uses the tdb idmap backend. Note that the same range as the
86         default uid/gid range is used, since the allocator has to serve
87         both the default backend and the explicitly configured domain DOM1.
88         </para>
89
90         <programlisting>
91         [global]
92         idmap backend = ldap
93         idmap uid = 1000000-2000000
94         idmap gid = 1000000-2000000
95         # use a different uid/gid allocator:
96         idmap alloc backend = tdb
97
98         idmap config DOM1 : backend = tdb
99         idmap config DOM1 : range = 1000000-2000000
100         </programlisting>
101 </refsect1>
102
103 <refsect1>
104         <title>AUTHOR</title>
105
106         <para>
107         The original Samba software and related utilities
108         were created by Andrew Tridgell. Samba is now developed
109         by the Samba Team as an Open Source project similar
110         to the way the Linux kernel is developed.
111         </para>
112 </refsect1>
113
114 </refentry>