source: vendor/current/docs/manpages/idmap_rfc2307.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 5.2 KB
Line 
1'\" t
2.\" Title: idmap_rfc2307
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "IDMAP_RFC2307" "8" "10/25/2016" "Samba 4\&.4" "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_rfc2307 \- Samba\*(Aqs idmap_rfc2307 Backend for Winbind
32.SH "DESCRIPTION"
33.PP
34The idmap_rfc2307 plugin provides a way for winbind to read id mappings from records in an LDAP server as defined in RFC 2307\&. The LDAP server can be stand\-alone or the LDAP server provided by the AD server\&. An AD server is always required to provide the mapping between name and SID, and the LDAP server is queried for the mapping between name and uid/gid\&. This module implements only the "idmap" API, and is READONLY\&.
35.PP
36Mappings must be provided in advance by the administrator by creating the user accounts in the Active Directory server and the posixAccount and posixGroup objects in the LDAP server\&. The names in the Active Directory server and in the LDAP server have to be the same\&.
37.PP
38This id mapping approach allows the reuse of existing LDAP authentication servers that store records in the RFC 2307 format\&.
39.PP
40When connecting to the LDAP server provided by an AD server, the parameter
41\m[blue]\fBldap ssl ads\fR\m[]
42determines whether SSL should be used\&. When using a stand\-alone LDAP server,
43\m[blue]\fBldap ssl\fR\m[]
44applies\&.
45.SH "IDMAP OPTIONS"
46.PP
47range = low \- high
48.RS 4
49Defines the available matching UID and GID range for which the backend is authoritative\&. Note that the range acts as a filter\&. If specified any UID or GID stored in AD that fall outside the range is ignored and the corresponding map is discarded\&. It is intended as a way to avoid accidental UID/GID overlaps between local and remotely defined IDs\&.
50.RE
51.PP
52ldap_server = <ad | stand\-alone >
53.RS 4
54Defines the type of LDAP server to use\&. This can either be the LDAP server provided by the Active Directory server (ad) or a stand\-alone LDAP server\&.
55.RE
56.PP
57bind_path_user
58.RS 4
59Specifies the bind path where user objects can be found in the LDAP server\&.
60.RE
61.PP
62bind_path_group
63.RS 4
64Specifies the bind path where group objects can be found in the LDAP server\&.
65.RE
66.PP
67user_cn = <yes | no>
68.RS 4
69Query cn attribute instead of uid attribute for the user name in LDAP\&. This option is not required, the default is no\&.
70.RE
71.PP
72realm
73.RS 4
74Append @realm to cn for groups (and users if user_cn is set) in LDAP queries\&. This option is not required, the default is not to append the realm\&.
75.RE
76.PP
77ldap_domain
78.RS 4
79When using the LDAP server in the Active Directory server, this allows one to specify the domain where to access the Active Directory server\&. This allows using trust relationships while keeping all RFC 2307 records in one place\&. This parameter is optional, the default is to access the AD server in the current domain to query LDAP records\&.
80.RE
81.PP
82ldap_url
83.RS 4
84When using a stand\-alone LDAP server, this parameter specifies the ldap URL for accessing the LDAP server\&.
85.RE
86.PP
87ldap_user_dn
88.RS 4
89Defines the user DN to be used for authentication\&. The secret for authenticating this user should be stored with net idmap secret (see
90\fBnet\fR(8))\&. If absent, an anonymous bind will be performed\&.
91.RE
92.SH "EXAMPLES"
93.PP
94The following example shows how to retrieve id mappings from a stand\-alone LDAP server\&. This example also shows how to leave a small non conflicting range for local id allocation that may be used in internal backends like BUILTIN\&.
95.sp
96.if n \{\
97.RS 4
98.\}
99.nf
100 [global]
101 idmap config * : backend = tdb
102 idmap config * : range = 1000000\-1999999
103
104 idmap config DOMAIN : backend = rfc2307
105 idmap config DOMAIN : range = 2000000\-2999999
106 idmap config DOMAIN : ldap_server = stand\-alone
107 idmap config DOMAIN : ldap_url = ldap://ldap1\&.example\&.com
108 idmap config DOMAIN : ldap_user_dn = cn=ldapmanager,dc=example,dc=com
109 idmap config DOMAIN : bind_path_user = ou=People,dc=example,dc=com
110 idmap config DOMAIN : bind_path_group = ou=Group,dc=example,dc=com
111
112.fi
113.if n \{\
114.RE
115.\}
116.SH "AUTHOR"
117.PP
118The 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.