s3:param: add a utility function lp_idmap_range() to get the configured range for...
[Samba/gebeck_regimport.git] / 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">
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.0</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>idmap_ad</refname>
16         <refpurpose>Samba's idmap_ad Backend for Winbind</refpurpose>
17 </refnamediv>
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         classes and relative attribute/value pairs to the user and
27         group objects in the AD.</para>
29         <para>
30         Currently, the <parameter>ad</parameter> backend
31         does not work as the the default idmap backend, but one has
32         to configure it separately for each domain for which one wants
33         to use it, using disjoint ranges. One usually needs to configure
34         a writeable default idmap range, using for example the
35         <parameter>tdb</parameter> or <parameter>ldap</parameter>
36         backend, in order to be able to map the BUILTIN sids and
37         possibly other trusted domains. The writeable default config
38         is also needed in order to be able to create group mappings.
39         This catch-all default idmap configuration should have a range
40         that is disjoint from any explicitly configured domain with
41         idmap backend <parameter>ad</parameter>. See the example below.
42         </para>
43 </refsynopsisdiv>
45 <refsect1>
46         <title>IDMAP OPTIONS</title>
48         <variablelist>
49                 <varlistentry>
50                 <term>range = low - high</term>
51                 <listitem><para>
52                         Defines the available matching UID and GID range for which the
53                         backend is authoritative. Note that the range acts as a filter.
54                         If specified any UID or GID stored in AD that fall outside the
55                         range is ignored and the corresponding map is discarded.
56                         It is intended as a way to avoid accidental UID/GID overlaps
57                         between local and remotely defined IDs.
58                 </para></listitem>
59                 </varlistentry>
60                 <varlistentry>
61                 <term>schema_mode = &lt;rfc2307 | sfu | sfu20&gt;</term>
62                 <listitem><para>
63                         Defines the schema that idmap_ad should use when querying
64                         Active Directory regarding user and group information.
65                         This can be either the RFC2307 schema support included
66                         in Windows 2003 R2 or the Service for Unix (SFU) schema.
67                         For SFU 3.0 or 3.5 please choose "sfu", for SFU 2.0
68                         please choose "sfu20".
70                         Please note that primary group membership is currently always calculated
71                         via the "primaryGroupID" LDAP attribute.
72                 </para></listitem>
73                 </varlistentry>
74         </variablelist>
75 </refsect1>
77 <refsect1>
78         <title>EXAMPLES</title>
79         <para>
80         The following example shows how to retrieve idmappings from our principal and
81         trusted AD domains. If trusted domains are present id conflicts must be
82         resolved beforehand, there is no
83         guarantee on the order conflicting mappings would be resolved at this point.
85         This example also shows how to leave a small non conflicting range for local
86         id allocation that may be used in internal backends like BUILTIN.
87         </para>
89         <programlisting>
90         [global]
91         workgroup = CORP
93         idmap config * : backend = tdb
94         idmap config * : range = 1000000-1999999
96         idmap config CORP : backend  = ad
97         idmap config CORP : range = 1000-999999
98         </programlisting>
99 </refsect1>
101 <refsect1>
102         <title>AUTHOR</title>
104         <para>
105         The original Samba software and related utilities
106         were created by Andrew Tridgell. Samba is now developed
107         by the Samba Team as an Open Source project similar
108         to the way the Linux kernel is developed.
109         </para>
110 </refsect1>
112 </refentry>