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                         If the parameter is absent, Winbind fails over to use
  44                         the &quot;idmap uid&quot; and &quot;idmap gid&quot; options
  45                         from smb.conf.
  46                 </para></listitem>
  47                 </varlistentry>
  48         </variablelist>
  49 </refsect1>
  50
  51 <refsect1>
  52         <title>EXAMPLES</title>
  53
  54         <para>
  55         This example shows how tdb is used as a the default idmap backend.
  56         It configures the idmap range through the global options for all
  57         domains encountered. This same range is used for uid/gid allocation.
  58         </para>
  59
  60         <programlisting>
  61         [global]
  62         # "backend = tdb" is redundant here since it is the default
  63         idmap config * : backend = tdb
  64         idmap config * : range = 1000000-2000000
  65         </programlisting>
  66
  67         <para>
  68         This (rather theoretical) example shows how tdb can be used as the
  69         allocating backend while ldap is the default backend used to store
  70         the mappings.
  71         It adds an explicit configuration for some domain DOM1, that
  72         uses the tdb idmap backend. Note that the same range as the
  73         default uid/gid range is used, since the allocator has to serve
  74         both the default backend and the explicitly configured domain DOM1.
  75         </para>
  76
  77         <programlisting>
  78         [global]
  79         idmap config * : backend = ldap
  80         idmap config * : range = 1000000-2000000
  81         # use a different uid/gid allocator:
  82
  83         idmap config DOM1 : backend = tdb
  84         idmap config DOM1 : range = 1000000-2000000
  85         </programlisting>
  86 </refsect1>
  87
  88 <refsect1>
  89         <title>AUTHOR</title>
  90
  91         <para>
  92         The original Samba software and related utilities
  93         were created by Andrew Tridgell. Samba is now developed
  94         by the Samba Team as an Open Source project similar
  95         to the way the Linux kernel is developed.
  96         </para>
  97 </refsect1>
  98
  99 </refentry>