docs-xml/manpages-3/idmap_autorid.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_autorid.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_autorid</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_autorid</refname>
  16         <refpurpose>Samba's idmap_autorid Backend for Winbind</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <title>DESCRIPTION</title>
  21         <para>The idmap_autorid backend provides a way to use an algorithmic
  22         mapping scheme to map UIDs/GIDs and SIDs that is more deterministic
  23         than idmap_tdb and easier to configure than idmap_rid.</para>
  24         <para>The module works similar to idmap_rid, but it automatically
  25         configures the range to be used for each domain, so there is no need
  26         to specify a specific range for each domain in the forest, the only
  27         configuration that is needed is the range of uid/gids that shall
  28         be used for user/group mappings and an optional size of the ranges
  29         to be used.</para>
  30         <para>The mappings of which domain is mapped to which range is stored
  31         in autorid.tdb, thus you should backup this database regularly.</para>
  32         <para>Due to the algorithm being used, it is the module that is
  33         most easy to use as it only requires a minimal configuration.</para>
  34 </refsynopsisdiv>
  35
  36 <refsect1>
  37         <title>IDMAP OPTIONS</title>
  38
  39         <variablelist>
  40                 <varlistentry>
  41                 <term>rangesize = numberofidsperdomain</term>
  42                 <listitem><para>
  43                         Defines the available number of uids/gids per domain. The
  44                         minimum needed value is 2000. SIDs with RIDs larger than this
  45                         value cannot be mapped, are ignored and the corresponding map
  46                         is discarded. Choose this value carefully, as this should
  47                         not be changed after the first ranges for domains have been
  48                         defined, otherwise mappings between domains will get intermixed
  49                         leading to unpredictable results. Please note that RIDs in Windows
  50                         Domains usually start with 500 for builtin users and 1000
  51                         for regular users. As the parameter cannot be changed later, please
  52                         plan accordingly for your expected number of users in a domain
  53                         with safety margins.
  54                 </para>
  55                 <para>The default value is 100000.</para>
  56                 </listitem>
  57                 </varlistentry>
  58         </variablelist>
  59 </refsect1>
  60
  61 <refsect1>
  62         <title>THE MAPPING FORMULAS</title>
  63         <para>
  64                 The Unix ID for a RID is calculated this way:
  65                 <programlisting>
  66                         ID = IDMAP UID LOW VALUE + DOMAINRANGENUMBER * RANGESIZE + RID
  67                 </programlisting>
  68         </para>
  69         <para>
  70                 Correspondingly, the formula for calculating the RID for a
  71                 given Unix ID is this:
  72                 <programlisting>
  73                         RID = ID - IDMAP UID LOW VALUE - DOMAINRANGENUMBER * RANGESIZE
  74                 </programlisting>
  75         </para>
  76 </refsect1>
  77
  78 <refsect1>
  79         <title>EXAMPLES</title>
  80         <para>
  81                 This example shows you the minimal configuration that will
  82                 work for the principial domain and 19 trusted domains.
  83         </para>
  84
  85         <programlisting>
  86         [global]
  87         security = ads
  88         workgroup = CUSTOMER
  89         realm = CUSTOMER.COM
  90
  91         idmap backend = autorid
  92         idmap uid = 1000000-1999999
  93         idmap gid = 1000000-1999999
  94
  95         </programlisting>
  96
  97         <para>
  98                 This example shows how to configure idmap_autorid as default
  99                 for all domains with a potentially large amount of users
 100                 plus a specific configuration for a trusted domain
 101                 that uses the SFU mapping scheme. Please note that idmap uid/gid
 102                 ranges and sfu ranges are not allowed to overlap.
 103         </para>
 104
 105         <programlisting>
 106         [global]
 107         security = ads
 108         workgroup = CUSTOMER
 109         realm = CUSTOMER.COM
 110
 111         idmap backend = autorid
 112         autorid:rangesize = 1000000
 113         idmap uid = 1000000-19999999
 114         idmap gid = 1000000-19999999
 115
 116         idmap config TRUSTED : backend  = ad
 117         idmap config TRUSTED : range    = 50000 - 99999
 118         idmap config TRUSTED : schema_mode = sfu
 119         </programlisting>
 120
 121 </refsect1>
 122
 123 <refsect1>
 124         <title>AUTHOR</title>
 125
 126         <para>
 127         The original Samba software and related utilities
 128         were created by Andrew Tridgell. Samba is now developed
 129         by the Samba Team as an Open Source project similar
 130         to the way the Linux kernel is developed.
 131         </para>
 132 </refsect1>
 133
 134 </refentry>