source: vendor/3.6.23/docs/manpages/idmap_tdb2.8

Last change on this file was 860, checked in by Silvan Scherrer, 11 years ago

Samba 3.6: updated vendor to latest version

File size: 3.7 KB
Line 
1'\" t
2.\" Title: idmap_tdb2
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5.\" Date: 09/18/2013
6.\" Manual: System Administration tools
7.\" Source: Samba 3.6
8.\" Language: English
9.\"
10.TH "IDMAP_TDB2" "8" "09/18/2013" "Samba 3\&.6" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31idmap_tdb2 \- Samba\*(Aqs idmap_tdb2 Backend for Winbind
32.SH "DESCRIPTION"
33.PP
34The 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\&.
35.PP
36In 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\&.
37.SH "IDMAP OPTIONS"
38.PP
39range = low \- high
40.RS 4
41Defines the available matching uid and gid range for which the backend is authoritative\&.
42.RE
43.PP
44script
45.RS 4
46This 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\&.
47.RE
48.SH "IDMAP SCRIPT"
49.PP
50The tdb2 idmap backend supports an external program for performing id mappings through the smb\&.conf option
51\fIidmap config * : script\fR
52or its deprecated legacy form
53\fIidmap : script\fR\&.
54.PP
55The 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\&.
56.PP
57The script should accept the following command line options\&.
58.sp
59.if n \{\
60.RS 4
61.\}
62.nf
63 SIDTOID S\-1\-xxxx
64 IDTOSID UID xxxx
65 IDTOSID GID xxxx
66
67.fi
68.if n \{\
69.RE
70.\}
71.PP
72And it should return one of the following responses as a single line of text\&.
73.sp
74.if n \{\
75.RS 4
76.\}
77.nf
78 UID:yyyy
79 GID:yyyy
80 SID:yyyy
81 ERR:yyyy
82
83.fi
84.if n \{\
85.RE
86.\}
87.SH "EXAMPLES"
88.PP
89This example shows how tdb2 is used as a the default idmap backend\&.
90.sp
91.if n \{\
92.RS 4
93.\}
94.nf
95 [global]
96 idmap config * : backend = tdb2
97 idmap config * : range = 1000000\-2000000
98
99.fi
100.if n \{\
101.RE
102.\}
103.PP
104This example shows how tdb2 is used as a the default idmap backend using an external program via the script parameter:
105.sp
106.if n \{\
107.RS 4
108.\}
109.nf
110 [global]
111 idmap config * : backend = tdb2
112 idmap config * : range = 1000000\-2000000
113 idmap config * : script = /usr/local/samba/bin/idmap_script\&.sh
114
115.fi
116.if n \{\
117.RE
118.\}
119.SH "AUTHOR"
120.PP
121The 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\&.
Note: See TracBrowser for help on using the repository browser.