docs/manpages-3/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 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>idmap_ad</refname>
  13         <refpurpose>Samba's idmap_ad Backend for Winbind</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <title>DESCRIPTION</title>
  18         <para>The idmap_ad plugin provides a way for Winbind to read
  19         id mappings from an AD server that uses RFC2307/SFU schema
  20         extensions. This module implements only the &quot;idmap&quot;
  21         API, and is READONLY. Mappings must be provided in advance
  22         by the administrator by adding the posixAccount/posixGroup
  23         classess and relative attribute/value pairs to the users and
  24         groups objects in AD</para>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>IDMAP OPTIONS</title>
  29
  30         <variablelist>
  31                 <varlistentry>
  32                 <term>range = low - high</term>
  33                 <listitem><para>
  34                         Defines the available matching uid and gid range for which the
  35                         backend is authoritative. Note that the range acts as a filter.
  36                         If specified any UID or GID stored in AD that fall outside the
  37                         range is ignored and the corresponding map is discarded.
  38                         It is intended as a way to avoid accidental UID/GID overlaps
  39                         between local and remotely defined IDs.
  40                 </para></listitem>
  41                 </varlistentry>
  42                 <varlistentry>
  43                 <term>schema_mode = &lt;rfc2307 | sfu &gt;</term>
  44                 <listitem><para>
  45                         Defines the schema that idmap_ad should use when querying
  46                         Active Directory regarding user and group information.
  47                         This can either the RFC2307 schema support included
  48                         in Windows 2003 R2 or the Service for Unix (SFU) schema.
  49                 </para></listitem>
  50                 </varlistentry>
  51         </variablelist>
  52 </refsect1>
  53
  54 <refsect1>
  55         <title>EXAMPLES</title>
  56         <para>
  57         The following example shows how to retrieve idmappings from our principal and
  58         and trusted AD domains. All is needed is to set default to yes. If trusted
  59         domains are present id conflicts must be resolved beforehand, there is no
  60         guarantee on the order conflicting mappings would be resolved at this point.
  61
  62         This example also shows how to leave a small non conflicting range for local
  63         id allocation that may be used in internal backends like BULTIN.
  64         </para>
  65
  66         <programlisting>
  67         [global]
  68         idmap domains = ALLDOMAINS
  69         idmap config ALLDOMAINS:backend      = ad
  70         idmap config ALLDOMAINS:default      = yes
  71         idmap config ALLDOMAINS:range        = 10000 - 300000000
  72
  73         idmap alloc backend = tdb
  74         idmap alloc config:range        = 5000 - 9999
  75         </programlisting>
  76 </refsect1>
  77
  78 <refsect1>
  79         <title>AUTHOR</title>
  80
  81         <para>
  82         The original Samba software and related utilities
  83         were created by Andrew Tridgell. Samba is now developed
  84         by the Samba Team as an Open Source project similar
  85         to the way the Linux kernel is developed.
  86         </para>
  87 </refsect1>
  88
  89 </refentry>