man page for IDMAP_AD
[Samba/bb.git] / docs / manpages-3 / idmap_ad.8.xml
blobbb67df74e99ebe9c12a59847e0712de0a9190534
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 </refmeta>
11 <refnamediv>
12         <refname>idmap_ad</refname>
13         <refpurpose>Samba's idmap_ad Backend for Winbind</refpurpose>
14 </refnamediv>
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>
27 <refsect1>
28         <title>IDMAP OPTIONS</title>
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 </refsect1>
43 <refsect1>
44         <title>EXAMPLES</title>
45         <para>
46         The following example shows how to retrieve idmappings from our principal and
47         and trusted AD domains. All is needed is to set default to yes. If trusted
48         domains are present id conflicts must be resolved beforehand, there is no
49         guarantee on the order confliting mappings would be resolved at this point.
51         This example also shows how to leave a small non conflicting range for local
52         id allocation that may be used in internal backends like BULTIN.
53         </para>
55         <programlisting>
56         [global]
57         idmap domain = ALLDOMAINS
58         idmap config ALLDOMAINS:backend      = ad
59         idmap config ALLDOMAINS:default      = yes
60         idmap config ALLDOMAINS:range        = 10000 - 300000000
62         idmap alloc backend = tdb
63         idmap alloc config:range        = 5000 - 9999
64         </programlisting>
65 </refsect1>
67 <refsect1>
68         <title>AUTHOR</title>
70         <para>
71         The original Samba software and related utilities 
72         were created by Andrew Tridgell. Samba is now developed
73         by the Samba Team as an Open Source project similar 
74         to the way the Linux kernel is developed.
75         </para> 
76 </refsect1>
78 </refentry>