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                 </para></listitem>
  45                 </varlistentry>
  46         </variablelist>
  47 </refsect1>
  48
  49 <refsect1>
  50         <title>IDMAP SCRIPT</title>
  51
  52         <para>
  53         The tdb2 idmap backend supports a script for performing id mappings
  54         through the smb.conf option <parameter>idmap : script</parameter>.
  55         The script should accept the following command line options.
  56         </para>
  57
  58         <programlisting>
  59         SIDTOID S-1-xxxx
  60         IDTOSID UID xxxx
  61         IDTOSID GID xxxx
  62         </programlisting>
  63
  64         <para>
  65         And it should return one of the following responses as a single line of
  66         text.
  67         </para>
  68
  69         <programlisting>
  70         UID:yyyy
  71         GID:yyyy
  72         SID:yyyy
  73         ERR:yyyy
  74         </programlisting>
  75
  76         <para>
  77         Note that the script should cover the complete range of SIDs
  78         that can be passed in for SID to Unix ID mapping, since otherwise
  79         SIDs unmapped by the script might get mapped to IDs that had
  80         previously been mapped by the script.
  81         </para>
  82 </refsect1>
  83
  84 <refsect1>
  85         <title>EXAMPLES</title>
  86
  87         <para>
  88         This example shows how tdb2 is used as a the default idmap backend.
  89         It configures the idmap range through the global options for all
  90         domains encountered.
  91         </para>
  92
  93         <programlisting>
  94         [global]
  95         idmap config * : backend = tdb2
  96         idmap config * : range = 1000000-2000000
  97         </programlisting>
  98 </refsect1>
  99
 100 <refsect1>
 101         <title>AUTHOR</title>
 102
 103         <para>
 104         The original Samba software and related utilities
 105         were created by Andrew Tridgell. Samba is now developed
 106         by the Samba Team as an Open Source project similar
 107         to the way the Linux kernel is developed.
 108         </para>
 109 </refsect1>
 110
 111 </refentry>