docs-xml/manpages-3/idmap_tdb2.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_tdb2.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_tdb2</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_tdb2</refname>
  16         <refpurpose>Samba's idmap_tdb2 Backend for Winbind</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <title>DESCRIPTION</title>
  21
  22         <para>
  23         The idmap_tdb2 plugin is a substitute for the default idmap_tdb
  24         backend used by winbindd for storing SID/uid/gid mapping tables
  25         in clustered environments with Samba and CTDB.
  26         </para>
  27
  28         <para>
  29         In contrast to read only backends like idmap_rid, it is an allocating
  30         backend: This means that it needs to allocate new user and group IDs in
  31         order to create new mappings.
  32         </para>
  33 </refsynopsisdiv>
  34
  35 <refsect1>
  36         <title>IDMAP OPTIONS</title>
  37
  38         <variablelist>
  39                 <varlistentry>
  40                 <term>range = low - high</term>
  41                 <listitem><para>
  42                         Defines the available matching uid and gid range for which the
  43                         backend is authoritative.
  44                         If the parameter is absent, Winbind fails over to use
  45                         the &quot;idmap uid&quot; and &quot;idmap gid&quot; options
  46                         from smb.conf.
  47                 </para></listitem>
  48                 </varlistentry>
  49         </variablelist>
  50 </refsect1>
  51
  52 <refsect1>
  53         <title>IDMAP SCRIPT</title>
  54
  55         <para>
  56         The tdb2 idmap backend supports a script for performing id mappings
  57         through the smb.conf option <parameter>idmap : script</parameter>.
  58         The script should accept the following command line options.
  59         </para>
  60
  61         <programlisting>
  62         SIDTOID S-1-xxxx
  63         IDTOSID UID xxxx
  64         IDTOSID GID xxxx
  65         </programlisting>
  66
  67         <para>
  68         And it should return one of the following responses as a single line of
  69         text.
  70         </para>
  71
  72         <programlisting>
  73         UID:yyyy
  74         GID:yyyy
  75         SID:yyyy
  76         ERR:yyyy
  77         </programlisting>
  78
  79         <para>
  80         Note that the script should cover the complete range of SIDs
  81         that can be passed in for SID to Unix ID mapping, since otherwise
  82         SIDs unmapped by the script might get mapped to IDs that had
  83         previously been mapped by the script.
  84         </para>
  85 </refsect1>
  86
  87 <refsect1>
  88         <title>EXAMPLES</title>
  89
  90         <para>
  91         This example shows how tdb2 is used as a the default idmap backend.
  92         It configures the idmap range through the global options for all
  93         domains encountered.
  94         </para>
  95
  96         <programlisting>
  97         [global]
  98         idmap config * : backend = tdb2
  99         idmap config * : range = 1000000-2000000
 100         </programlisting>
 101 </refsect1>
 102
 103 <refsect1>
 104         <title>AUTHOR</title>
 105
 106         <para>
 107         The original Samba software and related utilities
 108         were created by Andrew Tridgell. Samba is now developed
 109         by the Samba Team as an Open Source project similar
 110         to the way the Linux kernel is developed.
 111         </para>
 112 </refsect1>
 113
 114 </refentry>