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