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