s3/docs: Raise version number up to 3.5.
[Samba/gebeck_regimport.git] / docs-xml / manpages-3 / idmap_hash.8.xml
blob2c886f33c922e7faefdb256d1da3f77a1002f23f
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_hash.8">
5 <refmeta>
6         <refentrytitle>idmap_hash</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.5</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>idmap_hash</refname>
16         <refpurpose>Samba's idmap_hash Backend for Winbind</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <title>DESCRIPTION</title>
21         <para>The idmap_hash plugin implements a hashing algorithm used to map
22           SIDs for domain users and groups to 31-bit uids and gids, respectively.
23           This plugin also implements the nss_info API and can be used
24           to support a local name mapping files if enabled via the
25           &quot;winbind normalize names&quot; and &quot;winbind nss info&quot;
26           parameters in smb.conf.
27         </para>
28 </refsynopsisdiv>
30 <refsect1>
31         <title>IDMAP OPTIONS</title>
33         <variablelist>
34                 <varlistentry>
35                 <term>name_map</term>
36                 <listitem><para>
37                     Specifies the absolute path to the name mapping
38                     file used by the nss_info API.  Entries in the file
39                     are of the form &quot;<replaceable>unix name</replaceable>
40                     = <replaceable>qualified domain name</replaceable>&quot;.
41                     Mapping of both user and group names is supported.
42                 </para></listitem>
43                 </varlistentry>
44         </variablelist>
45 </refsect1>
47 <refsect1>
48         <title>EXAMPLES</title>
49         <para>The following example utilizes the idmap_hash plugin for
50           the idmap and nss_info information.
51         </para>
53         <programlisting>
54         [global]
55         idmap backend = hash
56         idmap uid = 1000-4000000000
57         idmap gid = 1000-4000000000
59         winbind nss info = hash
60         winbind normalize names = yes
61         idmap_hash:name_map = /etc/samba/name_map.cfg
62         </programlisting>
63 </refsect1>
65 <refsect1>
66         <title>AUTHOR</title>
68         <para>
69         The original Samba software and related utilities
70         were created by Andrew Tridgell. Samba is now developed
71         by the Samba Team as an Open Source project similar
72         to the way the Linux kernel is developed.
73         </para>
74 </refsect1>
76 </refentry>