docs/manpages-3/idmap_ldap.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_ldap.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_ldap</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>idmap_ldap</refname>
  13         <refpurpose>Samba's idmap_ldap Backend for Winbind</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <title>DESCRIPTION</title>
  18
  19         <para>The idmap_ldap plugin provides a means for Winbind to
  20         store and retrieve SID/uid/gid mapping tables in an LDAP directory
  21         service.  The module implements both the &quot;idmap&quot; and
  22         &quot;idmap alloc&quot; APIs.
  23         </para>
  24 </refsynopsisdiv>
  25
  26 <refsect1>
  27         <title>IDMAP OPTIONS</title>
  28
  29         <variablelist>
  30                 <varlistentry>
  31                 <term>ldap_base_dn = DN</term>
  32                 <listitem><para>
  33                         Defines the directory base suffix to use when searching for
  34                         SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
  35                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  36                 </para></listitem>
  37                 </varlistentry>
  38
  39                 <varlistentry>
  40                 <term>ldap_url = ldap://server/</term>
  41                 <listitem><para>
  42                         Specifies the LDAP server to use when searching for existing
  43                         SID/uid/gid map entries. If not defined, idmap_ldap will
  44                         assume that ldap://localhost/ should be used.
  45                 </para></listitem>
  46                 </varlistentry>
  47
  48                 <varlistentry>
  49                 <term>range = low - high</term>
  50                 <listitem><para>
  51                         Defines the available matching uid and gid range for which the
  52                         backend is authoritative.  Note that the range commonly matches
  53                         the allocation range due to the fact that the same backend will
  54                         store and retrieve SID/uid/gid mapping entries.  If the parameter
  55                         is absent, Winbind fail over to use the &quot;idmap uid&quot; and
  56                         &quot;idmap gid&quot; options from smb.conf.
  57                 </para></listitem>
  58                 </varlistentry>
  59         </variablelist>
  60 </refsect1>
  61
  62 <refsect1>
  63         <title>IDMAP ALLOC OPTIONS</title>
  64
  65         <variablelist>
  66                 <varlistentry>
  67                 <term>ldap_base_dn = DN</term>
  68                 <listitem><para>
  69                         Defines the directory base suffix under which new SID/uid/gid mapping
  70                         entries should be stored.  If not defined, idmap_ldap will default
  71                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  72                 </para></listitem>
  73                 </varlistentry>
  74
  75                 <varlistentry>
  76                 <term>ldap_url = ldap://server/</term>
  77                 <listitem><para>
  78                         Specifies the LDAP server to which modify/add/delete requests should
  79                         be sent.  If not defined, idmap_ldap will assume that ldap://localhost/
  80                         should be used.
  81                 </para></listitem>
  82                 </varlistentry>
  83
  84                 <varlistentry>
  85                 <term>range = low - high</term>
  86                 <listitem><para>
  87                         Defines the available matching uid and gid range from which
  88                         winbindd can allocate for users and groups.  If the parameter
  89                         is absent, Winbind fail over to use the &quot;idmap uid&quot;
  90                         and &quot;idmap gid&quot; options from smb.conf.
  91                 </para></listitem>
  92                 </varlistentry>
  93         </variablelist>
  94 </refsect1>
  95
  96 <refsect1>
  97         <title>EXAMPLES</title>
  98
  99         <para>
 100         The follow sets of a LDAP configuration which uses a slave server
 101         running on localhost for fast fetching SID/gid/uid mappings, it
 102         implies correct configuration of referrals.
 103         The idmap alloc backend is pointed directly to the master to skip
 104         the referral (and consequent reconnection to the master) that the
 105         slave would return as allocation requires writing on the master.
 106         </para>
 107
 108         <programlisting>
 109         [global]
 110             idmap domain = ALLDOMAINS
 111             idmap config ALLDOMAINS:default      = yes
 112             idmap config ALLDOMAINS:backend      = ldap
 113             idmap config ALLDOMAINS:ldap_base_dn = ou=idmap,dc=example,dc=com
 114             idmap config ALLDOMAINS:ldap_url     = ldap://localhost/
 115             idmap config ALLDOMAINS:range        = 10000 - 50000
 116
 117             idmap alloc backend = ldap
 118             idmap alloc config:ldap_base_dn = ou=idmap,dc=example,dc=com
 119             idmap alloc config:ldap_url     = ldap://master.example.com/
 120             idmap alloc config:range        = 10000 - 50000
 121         </programlisting>
 122 </refsect1>
 123
 124 <refsect1>
 125         <title>AUTHOR</title>
 126
 127         <para>
 128         The original Samba software and related utilities
 129         were created by Andrew Tridgell. Samba is now developed
 130         by the Samba Team as an Open Source project similar
 131         to the way the Linux kernel is developed.
 132         </para>
 133 </refsect1>
 134
 135 </refentry>