docs-xml/smbdotconf/winbind/idmapbackend.xml

   1 <samba:parameter name="idmap backend"
   2                  context="G"
   3                  type="string"
   4                  advanced="1" developer="1" hide="1"
   5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6 <description>
   7         <para>
   8         The idmap backend provides a plugin interface for Winbind to use
   9         varying backends to store SID/uid/gid mapping tables.
  10         </para>
  11
  12         <para>
  13         This option specifies the default backend that is used when no special
  14         configuration set by <smbconfoption name="idmap config"/> matches the
  15         specific request.
  16         </para>
  17
  18         <para>
  19         This default backend also specifies the place where winbind-generated
  20         idmap entries will be stored. So it is highly recommended that you
  21         specify a writable backend like <citerefentry>
  22         <refentrytitle>idmap_tdb</refentrytitle> <manvolnum>8</manvolnum>
  23         </citerefentry> or <citerefentry>
  24         <refentrytitle>idmap_ldap</refentrytitle> <manvolnum>8</manvolnum>
  25         </citerefentry> as the idmap backend. The <citerefentry>
  26         <refentrytitle>idmap_rid</refentrytitle> <manvolnum>8</manvolnum>
  27         </citerefentry> and <citerefentry>
  28         <refentrytitle>idmap_ad</refentrytitle> <manvolnum>8</manvolnum>
  29         </citerefentry> backends are not writable and thus will generate
  30         unexpected results if set as idmap backend.
  31         </para>
  32
  33         <para>
  34         To use the rid and ad backends, please specify them via the
  35         <smbconfoption name="idmap config"/> parameter, possibly also for the
  36         domain your machine is member of, specified by <smbconfoption
  37         name="workgroup"/>.
  38         </para>
  39
  40         <para>Examples of SID/uid/gid backends include tdb (<citerefentry>
  41         <refentrytitle>idmap_tdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>),
  42         ldap (<citerefentry><refentrytitle>idmap_ldap</refentrytitle>
  43         <manvolnum>8</manvolnum></citerefentry>), rid (<citerefentry>
  44         <refentrytitle>idmap_rid</refentrytitle><manvolnum>8</manvolnum></citerefentry>),
  45         and ad (<citerefentry><refentrytitle>idmap_ad</refentrytitle>
  46         <manvolnum>8</manvolnum></citerefentry>).
  47         </para>
  48 </description>
  49
  50 <value type="default">tdb</value>
  51 </samba:parameter>