idmap_tdb.8: Remove reference to idmap uid and idmap gid options as fallback
[obnox/samba/samba-obnox.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.6</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.
25         </para>
26
27         <para>
28         In contrast to read only backends like idmap_rid, it is an allocating
29         backend: This means that it needs to allocate new user and group IDs in
30         order to create new mappings.
31         </para>
32 </refsynopsisdiv>
33
34 <refsect1>
35         <title>IDMAP OPTIONS</title>
36
37         <variablelist>
38                 <varlistentry>
39                 <term>range = low - high</term>
40                 <listitem><para>
41                         Defines the available matching uid and gid range for which the
42                         backend is authoritative.
43                 </para></listitem>
44                 </varlistentry>
45         </variablelist>
46 </refsect1>
47
48 <refsect1>
49         <title>EXAMPLES</title>
50
51         <para>
52         This example shows how tdb is used as a the default idmap backend.
53         It configures the idmap range through the global options for all
54         domains encountered. This same range is used for uid/gid allocation.
55         </para>
56
57         <programlisting>
58         [global]
59         # "backend = tdb" is redundant here since it is the default
60         idmap config * : backend = tdb
61         idmap config * : range = 1000000-2000000
62         </programlisting>
63
64         <para>
65         This (rather theoretical) example shows how tdb can be used as the
66         allocating backend while ldap is the default backend used to store
67         the mappings.
68         It adds an explicit configuration for some domain DOM1, that
69         uses the tdb idmap backend. Note that the same range as the
70         default uid/gid range is used, since the allocator has to serve
71         both the default backend and the explicitly configured domain DOM1.
72         </para>
73
74         <programlisting>
75         [global]
76         idmap config * : backend = ldap
77         idmap config * : range = 1000000-2000000
78         # use a different uid/gid allocator:
79
80         idmap config DOM1 : backend = tdb
81         idmap config DOM1 : range = 1000000-2000000
82         </programlisting>
83 </refsect1>
84
85 <refsect1>
86         <title>AUTHOR</title>
87
88         <para>
89         The original Samba software and related utilities
90         were created by Andrew Tridgell. Samba is now developed
91         by the Samba Team as an Open Source project similar
92         to the way the Linux kernel is developed.
93         </para>
94 </refsect1>
95
96 </refentry>