fill in the idmap_tdb man page
[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 </refmeta>
9
10
11 <refnamediv>
12         <refname>idmap_tdb</refname>
13         <refpurpose>Samba's idmap_tdb Backend for winbindd</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <title>DESCRIPTION</title>
18
19         <para>The idmap_tdb plugin is the default backend used by winbindd
20         for storing SID/uid/gid mapping tables and implements
21         both the &quot;idmap&quot; and &quot;idmap alloc&quot; APIs.
22         </para>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>IDMAP OPTIONS</title>
27
28         <variablelist>          
29                 <varlistentry>
30                 <term>range = low - high</term>
31                 <listitem><para>
32                         Defines the available matching uid and gid range for which the
33                         backend is authoritative.  Note that the range commonly matches
34                         the allocation range due to the fact that the same backend will
35                         store and retreive SID/uid/gid mapping entries.  If the parameter 
36                         is absent, Winbind fail over to use the &quot;idmap uid&quot; and 
37                         &quot;idmap gid&quot; options from smb.conf.  
38                 </para></listitem>
39                 </varlistentry>
40         </variablelist>
41 </refsect1>
42
43 <refsect1>
44         <title>IDMAP ALLOC OPTIONS</title>
45
46         <variablelist>
47                 <varlistentry>
48                 <term>range = low - high</term>
49                 <listitem><para>
50                         Defines the available matching uid and gid range from which 
51                         winbindd can allocate for users and groups.  If the parameter 
52                         is absent, Winbind fail over to use the &quot;idmap uid&quot; 
53                         and &quot;idmap gid&quot; options from smb.conf.
54                 </para></listitem>
55                 </varlistentry>
56         </variablelist>
57 </refsect1>
58
59 <refsect1>
60         <title>EXAMPLES</title>
61
62         <para>
63         The following example is equivalent to the pre-3.0.25 default idmap 
64         configuration using the &quot;idmap backend = tdb&quot; setting.
65         </para>
66
67         <programlisting>
68         [global]
69             idmap domain = default
70
71             idmap config default:backend = tdb
72             idmap config default:default = yes
73             idmap config default:range   = 10000 - 50000
74
75             idmap alloc backend = tdb
76             idmap alloc config:range = 10000 - 50000
77         </programlisting>
78 </refsect1>
79
80 <refsect1>
81         <title>AUTHOR</title>
82
83         <para>
84         The original Samba software and related utilities 
85         were created by Andrew Tridgell. Samba is now developed
86         by the Samba Team as an Open Source project similar 
87         to the way the Linux kernel is developed.
88         </para> 
89 </refsect1>
90
91 </refentry>