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.3</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. The allocator can be provided by the
  31         idmap_tdb backend itself or by any other allocating backend like
  32         idmap_ldap or idmap_tdb2. This is configured with the
  33         parameter <parameter>idmap alloc backend</parameter>.
  34         </para>
  35
  36         <para>
  37         Note that in order for this (or any other allocating) backend to
  38         function at all, the default backend needs to be writeable.
  39         The ranges used for uid and gid allocation are the default ranges
  40         configured by &quot;idmap uid&quot; and &quot;idmap gid&quot;.
  41         </para>
  42
  43         <para>
  44         Furthermore, since there is only one global allocating backend
  45         responsible for all domains using writeable idmap backends,
  46         any explicitly configured domain with idmap backend tdb
  47         should have the same range as the default range, since it needs
  48         to use the global uid / gid allocator. See the example below.
  49         </para>
  50 </refsynopsisdiv>
  51
  52 <refsect1>
  53         <title>IDMAP OPTIONS</title>
  54
  55         <variablelist>
  56                 <varlistentry>
  57                 <term>range = low - high</term>
  58                 <listitem><para>
  59                         Defines the available matching uid and gid range for which the
  60                         backend is authoritative.
  61                         If the parameter is absent, Winbind fails over to use
  62                         the &quot;idmap uid&quot; and &quot;idmap gid&quot; options
  63                         from smb.conf.
  64                 </para></listitem>
  65                 </varlistentry>
  66         </variablelist>
  67 </refsect1>
  68
  69 <refsect1>
  70         <title>EXAMPLES</title>
  71
  72         <para>
  73         This example shows how tdb is used as a the default idmap backend.
  74         It configures the idmap range through the global options for all
  75         domains encountered. This same range is used for uid/gid allocation.
  76         </para>
  77
  78         <programlisting>
  79         [global]
  80         # "idmap backend = tdb" is redundant here since it is the default
  81         idmap backend = tdb
  82         idmap uid = 1000000-2000000
  83         idmap gid = 1000000-2000000
  84         </programlisting>
  85
  86         <para>
  87         This (rather theoretical) example shows how tdb can be used as the
  88         allocating backend while ldap is the default backend used to store
  89         the mappings.
  90         It adds an explicit configuration for some domain DOM1, that
  91         uses the tdb idmap backend. Note that the same range as the
  92         default uid/gid range is used, since the allocator has to serve
  93         both the default backend and the explicitly configured domain DOM1.
  94         </para>
  95
  96         <programlisting>
  97         [global]
  98         idmap backend = ldap
  99         idmap uid = 1000000-2000000
 100         idmap gid = 1000000-2000000
 101         # use a different uid/gid allocator:
 102         idmap alloc backend = tdb
 103
 104         idmap config DOM1 : backend = tdb
 105         idmap config DOM1 : range = 1000000-2000000
 106         </programlisting>
 107 </refsect1>
 108
 109 <refsect1>
 110         <title>AUTHOR</title>
 111
 112         <para>
 113         The original Samba software and related utilities
 114         were created by Andrew Tridgell. Samba is now developed
 115         by the Samba Team as an Open Source project similar
 116         to the way the Linux kernel is developed.
 117         </para>
 118 </refsect1>
 119
 120 </refentry>