Next update of VFS modules development guide
[tprouty/samba.git] / docs / 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>The idmap_tdb plugin is the default backend used by winbindd
23         for storing SID/uid/gid mapping tables and implements
24         both the &quot;idmap&quot; and &quot;idmap alloc&quot; APIs.
25         </para>
26 </refsynopsisdiv>
27
28 <refsect1>
29         <title>IDMAP OPTIONS</title>
30
31         <variablelist>
32                 <varlistentry>
33                 <term>range = low - high</term>
34                 <listitem><para>
35                         Defines the available matching uid and gid range for which the
36                         backend is authoritative.  Note that the range commonly matches
37                         the allocation range due to the fact that the same backend will
38                         store and retrieve SID/uid/gid mapping entries.  If the parameter
39                         is absent, Winbind fail over to use the &quot;idmap uid&quot; and
40                         &quot;idmap gid&quot; options from smb.conf.
41                 </para></listitem>
42                 </varlistentry>
43         </variablelist>
44 </refsect1>
45
46 <refsect1>
47         <title>IDMAP ALLOC 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 from which
54                         winbindd can allocate for users and groups.  If the parameter
55                         is absent, Winbind fail over to use the &quot;idmap uid&quot;
56                         and &quot;idmap gid&quot; options from smb.conf.
57                 </para></listitem>
58                 </varlistentry>
59         </variablelist>
60 </refsect1>
61
62 <refsect1>
63         <title>EXAMPLES</title>
64
65         <para>
66         The following example is equivalent to the pre-3.0.25 default idmap
67         configuration using the &quot;idmap backend = tdb&quot; setting.
68         </para>
69
70         <programlisting>
71         [global]
72             idmap domains = ALLDOMAINS
73             idmap config ALLDOMAINS:default = yes
74             idmap config ALLDOMAINS:backend = tdb
75             idmap config ALLDOMAINS:range   = 10000 - 50000
76
77             idmap alloc backend = tdb
78             idmap alloc config:range = 10000 - 50000
79         </programlisting>
80 </refsect1>
81
82 <refsect1>
83         <title>AUTHOR</title>
84
85         <para>
86         The original Samba software and related utilities
87         were created by Andrew Tridgell. Samba is now developed
88         by the Samba Team as an Open Source project similar
89         to the way the Linux kernel is developed.
90         </para>
91 </refsect1>
92
93 </refentry>