1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-27 03:21:53 +03:00
samba-mirror/docs-xml/manpages-3/idmap_tdb2.8.xml
Luk Claes 615a2d4abe idmap_tdb2.8: Remove mentioning of deprecated idmap uid and idmap gid options as fallback
Signed-off-by: Luk Claes <luk@debian.org>
Signed-off-by: Michael Adam <obnox@samba.org>
2011-05-31 01:44:28 +02:00

112 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="idmap_tdb2.8">
<refmeta>
<refentrytitle>idmap_tdb2</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">3.6</refmiscinfo>
</refmeta>
<refnamediv>
<refname>idmap_tdb2</refname>
<refpurpose>Samba's idmap_tdb2 Backend for Winbind</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>DESCRIPTION</title>
<para>
The idmap_tdb2 plugin is a substitute for the default idmap_tdb
backend used by winbindd for storing SID/uid/gid mapping tables
in clustered environments with Samba and CTDB.
</para>
<para>
In contrast to read only backends like idmap_rid, it is an allocating
backend: This means that it needs to allocate new user and group IDs in
order to create new mappings.
</para>
</refsynopsisdiv>
<refsect1>
<title>IDMAP OPTIONS</title>
<variablelist>
<varlistentry>
<term>range = low - high</term>
<listitem><para>
Defines the available matching uid and gid range for which the
backend is authoritative.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>IDMAP SCRIPT</title>
<para>
The tdb2 idmap backend supports a script for performing id mappings
through the smb.conf option <parameter>idmap : script</parameter>.
The script should accept the following command line options.
</para>
<programlisting>
SIDTOID S-1-xxxx
IDTOSID UID xxxx
IDTOSID GID xxxx
</programlisting>
<para>
And it should return one of the following responses as a single line of
text.
</para>
<programlisting>
UID:yyyy
GID:yyyy
SID:yyyy
ERR:yyyy
</programlisting>
<para>
Note that the script should cover the complete range of SIDs
that can be passed in for SID to Unix ID mapping, since otherwise
SIDs unmapped by the script might get mapped to IDs that had
previously been mapped by the script.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>
This example shows how tdb2 is used as a the default idmap backend.
It configures the idmap range through the global options for all
domains encountered.
</para>
<programlisting>
[global]
idmap config * : backend = tdb2
idmap config * : range = 1000000-2000000
</programlisting>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.
</para>
</refsect1>
</refentry>