Changeset 745 for trunk/server/docs/manpages/idmap_tdb2.8

Timestamp:

Nov 27, 2012, 4:43:17 PM (13 years ago)

Author:

Silvan Scherrer

Message:

Samba Server: updated trunk to 3.6.0

Location:

trunk/server

Files:

• . (modified) (1 prop)
• docs/manpages/idmap_tdb2.8 (modified) (4 diffs)

trunk/server/docs/manpages/idmap_tdb2.8

@@ -3 +3 @@
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 08/02/2011
+.\"      Date: 08/08/2011
 .\"    Manual: System Administration tools
-.\"    Source: Samba 3.5
+.\"    Source: Samba 3.6
 .\"  Language: English
 .\"
-.TH "IDMAP_TDB2" "8" "08/02/2011" "Samba 3\&.5" "System Administration tools"
+.TH "IDMAP_TDB2" "8" "08/08/2011" "Samba 3\&.6" "System Administration tools"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
@@ -25 +25 @@
 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\&.
 .PP
-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\&. The allocator can be provided by the idmap_tdb2 backend itself or by any other allocating backend like idmap_tdb or idmap_ldap\&. This is configured with the parameter
-\fIidmap alloc backend\fR\&.
-.PP
-Note that in order for this (or any other allocating) backend to function at all, the default backend needs to be writeable\&. The ranges used for uid and gid allocation are the default ranges configured by "idmap uid" and "idmap gid"\&.
-.PP
-Furthermore, since there is only one global allocating backend responsible for all domains using writeable idmap backends, any explicitly configured domain with idmap backend tdb2 should have the same range as the default range, since it needs to use the global uid / gid allocator\&. See the example below\&.
+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\&.
 .SH "IDMAP OPTIONS"
 .PP
 range = low \- high
 .RS 4
-Defines the available matching uid and gid range for which the backend is authoritative\&. If the parameter is absent, Winbind fails over to use the "idmap uid" and "idmap gid" options from smb\&.conf\&.
+Defines the available matching uid and gid range for which the backend is authoritative\&.
+.RE
+.PP
+script
+.RS 4
+This option can be used to configure an external program for performing id mappings instead of using the tdb counter\&. The mappings are then stored int tdb2 idmap database\&. For details see the section on IDMAP SCRIPT below\&.
 .RE
 .SH "IDMAP SCRIPT"
 .PP
-The tdb2 idmap backend supports a script for performing id mappings through the smb\&.conf option
-\fIidmap : script\fR\&. The script should accept the following command line options\&.
+The tdb2 idmap backend supports an external program for performing id mappings through the smb\&.conf option
+\fIidmap config * : script\fR
+or its deprecated legacy form
+\fIidmap : script\fR\&.
+.PP
+The mappings obtained by the script are then stored in the idmap tdb2 database instead of mappings created by the incrementing id counters\&. It is therefore important that the script covers 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\&.
+.PP
+The script should accept the following command line options\&.
 .sp
 .if n \{\
@@ -70 +76 @@
 .RE
 .\}
-.PP
-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\&.
 .SH "EXAMPLES"
 .PP
-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\&. This same range is used for uid/gid allocation\&.
+This example shows how tdb2 is used as a the default idmap backend\&.
 .sp
 .if n \{\
@@ -81 +85 @@
 .nf
         [global]
-        idmap backend = tdb2
-        idmap uid = 1000000\-2000000
-        idmap gid = 1000000\-2000000
+        idmap config * : backend = tdb2
+        idmap config * : range = 1000000\-2000000
+        
+.fi
+.if n \{\
+.RE
+.\}
+.PP
+This example shows how tdb2 is used as a the default idmap backend using an external program via the script parameter:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+        [global]
+        idmap config * : backend = tdb2
+        idmap config * : range = 1000000\-2000000
+        idmap config * : script = /usr/local/samba/bin/idmap_script\&.sh
         
 .fi