docs-xml/manpages/idmap_ad.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_ad.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_ad</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.7</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>idmap_ad</refname>
  16         <refpurpose>Samba's idmap_ad Backend for Winbind</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <title>DESCRIPTION</title>
  21         <para>The idmap_ad plugin provides a way for Winbind to read
  22         id mappings from an AD server that uses RFC2307/SFU schema
  23         extensions. This module implements only the &quot;idmap&quot;
  24         API, and is READONLY. Mappings must be provided in advance
  25         by the administrator by adding the uidNumber attributes for
  26         users and gidNumber attributes for groups in the AD. Winbind
  27         will only map users that have a uidNumber and whose primary
  28         group have a gidNumber attribute set. It is however
  29         recommended that all groups in use have gidNumber attributes
  30         assigned, otherwise they are not working.</para>
  31
  32         <para>
  33         Currently, the <parameter>ad</parameter> backend
  34         does not work as the default idmap backend, but one has
  35         to configure it separately for each domain for which one wants
  36         to use it, using disjoint ranges. One usually needs to configure
  37         a writeable default idmap range, using for example the
  38         <parameter>tdb</parameter> or <parameter>ldap</parameter>
  39         backend, in order to be able to map the BUILTIN sids and
  40         possibly other trusted domains. The writeable default config
  41         is also needed in order to be able to create group mappings.
  42         This catch-all default idmap configuration should have a range
  43         that is disjoint from any explicitly configured domain with
  44         idmap backend <parameter>ad</parameter>. See the example below.
  45         </para>
  46 </refsynopsisdiv>
  47
  48 <refsect1>
  49         <title>IDMAP OPTIONS</title>
  50
  51         <variablelist>
  52                 <varlistentry>
  53                 <term>range = low - high</term>
  54                 <listitem><para>
  55                         Defines the available matching UID and GID range for which the
  56                         backend is authoritative. Note that the range acts as a filter.
  57                         If specified any UID or GID stored in AD that fall outside the
  58                         range is ignored and the corresponding map is discarded.
  59                         It is intended as a way to avoid accidental UID/GID overlaps
  60                         between local and remotely defined IDs.
  61                 </para></listitem>
  62                 </varlistentry>
  63                 <varlistentry>
  64                 <term>schema_mode = &lt;rfc2307 | sfu | sfu20&gt;</term>
  65                 <listitem><para>
  66                         Defines the schema that idmap_ad should use when querying
  67                         Active Directory regarding user and group information.
  68                         This can be either the RFC2307 schema support included
  69                         in Windows 2003 R2 or the Service for Unix (SFU) schema.
  70                         For SFU 3.0 or 3.5 please choose "sfu", for SFU 2.0
  71                         please choose "sfu20".
  72
  73                         Please note that the behavior of primary group membership is
  74                         controlled by the <emphasis>unix_primary_group</emphasis> option.
  75                 </para></listitem>
  76                 </varlistentry>
  77                 <varlistentry>
  78                 <term>unix_primary_group = yes/no</term>
  79                 <listitem><para>
  80                   Defines whether the user's primary group is fetched from the SFU
  81                   attributes or the AD primary group. If set to
  82                   <parameter>yes</parameter> the primary group membership is fetched
  83                   from the LDAP attributes (gidNumber).
  84                   If set to <parameter>no</parameter> the primary group membership is
  85                   calculated via the "primaryGroupID" LDAP attribute.
  86                 </para>
  87                 <para>Default: no</para>
  88                 </listitem>
  89                 </varlistentry>
  90                 <varlistentry>
  91                 <term>unix_nss_info = yes/no</term>
  92                 <listitem><para>
  93                   If set to <parameter>yes</parameter> winbind will retrieve the login
  94                   shell and home directory from the LDAP attributes. If set to
  95                   <parameter>no</parameter> the or the AD LDAP entry lacks the SFU
  96                   attributes the options <emphasis>template shell</emphasis> and
  97                   <emphasis>template homedir</emphasis> are used.
  98                 </para>
  99                 <para>Default: no</para>
 100                 </listitem>
 101                 </varlistentry>
 102         </variablelist>
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>EXAMPLES</title>
 107         <para>
 108         The following example shows how to retrieve idmappings from our principal and
 109         trusted AD domains. If trusted domains are present id conflicts must be
 110         resolved beforehand, there is no
 111         guarantee on the order conflicting mappings would be resolved at this point.
 112
 113         This example also shows how to leave a small non conflicting range for local
 114         id allocation that may be used in internal backends like BUILTIN.
 115         </para>
 116
 117         <programlisting>
 118         [global]
 119         workgroup = CORP
 120
 121         idmap config * : backend = tdb
 122         idmap config * : range = 1000000-1999999
 123
 124         idmap config CORP : backend  = ad
 125         idmap config CORP : range = 1000-999999
 126         </programlisting>
 127 </refsect1>
 128
 129 <refsect1>
 130         <title>AUTHOR</title>
 131
 132         <para>
 133         The original Samba software and related utilities
 134         were created by Andrew Tridgell. Samba is now developed
 135         by the Samba Team as an Open Source project similar
 136         to the way the Linux kernel is developed.
 137         </para>
 138 </refsect1>
 139
 140 </refentry>