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

Last change on this file was 740, checked in by Silvan Scherrer, 13 years ago

Samba Server: update vendor to 3.6.0

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