Changeset 231 for branches/samba-3.2.x/docs/manpages/idmap_ldap.8
- Timestamp:
- May 27, 2009, 9:08:03 AM (16 years ago)
- File:
-
- 1 edited
-
branches/samba-3.2.x/docs/manpages/idmap_ldap.8 (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.2.x/docs/manpages/idmap_ldap.8
r229 r231 1 1 .\" Title: idmap_ldap 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.7 3.1<http://docbook.sf.net/>4 .\" Date: 12/19/20082 .\" Author: [see the "AUTHOR" section] 3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 4 .\" Date: 02/03/2009 5 5 .\" Manual: System Administration tools 6 6 .\" Source: Samba 3.2 7 .\" Language: English 7 8 .\" 8 .TH "IDMAP_LDAP" "8" "12/19/2008" "Samba 3\.2" "System Administration tools" 9 .TH "IDMAP_LDAP" "8" "02/03/2009" "Samba 3\&.2" "System Administration tools" 10 .\" ----------------------------------------------------------------- 11 .\" * (re)Define some macros 12 .\" ----------------------------------------------------------------- 13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" toupper - uppercase a string (locale-aware) 15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 16 .de toupper 17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ 18 \\$* 19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz 20 .. 21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 22 .\" SH-xref - format a cross-reference to an SH section 23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 .de SH-xref 25 .ie n \{\ 26 .\} 27 .toupper \\$* 28 .el \{\ 29 \\$* 30 .\} 31 .. 32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 33 .\" SH - level-one heading that works better for non-TTY output 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 35 .de1 SH 36 .\" put an extra blank line of space above the head in non-TTY output 37 .if t \{\ 38 .sp 1 39 .\} 40 .sp \\n[PD]u 41 .nr an-level 1 42 .set-an-margin 43 .nr an-prevailing-indent \\n[IN] 44 .fi 45 .in \\n[an-margin]u 46 .ti 0 47 .HTML-TAG ".NH \\n[an-level]" 48 .it 1 an-trap 49 .nr an-no-space-flag 1 50 .nr an-break-flag 1 51 \." make the size of the head bigger 52 .ps +3 53 .ft B 54 .ne (2v + 1u) 55 .ie n \{\ 56 .\" if n (TTY output), use uppercase 57 .toupper \\$* 58 .\} 59 .el \{\ 60 .nr an-break-flag 0 61 .\" if not n (not TTY), use normal case (not uppercase) 62 \\$1 63 .in \\n[an-margin]u 64 .ti 0 65 .\" if not n (not TTY), put a border/line under subheading 66 .sp -.6 67 \l'\n(.lu' 68 .\} 69 .. 70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 71 .\" SS - level-two heading that works better for non-TTY output 72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 73 .de1 SS 74 .sp \\n[PD]u 75 .nr an-level 1 76 .set-an-margin 77 .nr an-prevailing-indent \\n[IN] 78 .fi 79 .in \\n[IN]u 80 .ti \\n[SN]u 81 .it 1 an-trap 82 .nr an-no-space-flag 1 83 .nr an-break-flag 1 84 .ps \\n[PS-SS]u 85 \." make the size of the head bigger 86 .ps +2 87 .ft B 88 .ne (2v + 1u) 89 .if \\n[.$] \&\\$* 90 .. 91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 92 .\" BB/BE - put background/screen (filled box) around block of text 93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 94 .de BB 95 .if t \{\ 96 .sp -.5 97 .br 98 .in +2n 99 .ll -2n 100 .gcolor red 101 .di BX 102 .\} 103 .. 104 .de EB 105 .if t \{\ 106 .if "\\$2"adjust-for-leading-newline" \{\ 107 .sp -1 108 .\} 109 .br 110 .di 111 .in 112 .ll 113 .gcolor 114 .nr BW \\n(.lu-\\n(.i 115 .nr BH \\n(dn+.5v 116 .ne \\n(BHu+.5v 117 .ie "\\$2"adjust-for-leading-newline" \{\ 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 119 .\} 120 .el \{\ 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 122 .\} 123 .in 0 124 .sp -.5v 125 .nf 126 .BX 127 .in 128 .sp .5v 129 .fi 130 .\} 131 .. 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 133 .\" BM/EM - put colored marker in margin next to block of text 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 135 .de BM 136 .if t \{\ 137 .br 138 .ll -2n 139 .gcolor red 140 .di BX 141 .\} 142 .. 143 .de EM 144 .if t \{\ 145 .br 146 .di 147 .ll 148 .gcolor 149 .nr BH \\n(dn 150 .ne \\n(BHu 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] 152 .in 0 153 .nf 154 .BX 155 .in 156 .fi 157 .\} 158 .. 159 .\" ----------------------------------------------------------------- 160 .\" * set default formatting 161 .\" ----------------------------------------------------------------- 9 162 .\" disable hyphenation 10 163 .nh 11 164 .\" disable justification (adjust text to left margin only) 12 165 .ad l 13 .SH "NAME" 14 idmap_ldap - Samba's idmap_ldap Backend for Winbind 166 .\" ----------------------------------------------------------------- 167 .\" * MAIN CONTENT STARTS HERE * 168 .\" ----------------------------------------------------------------- 169 .SH "Name" 170 idmap_ldap \- Samba\'s idmap_ldap Backend for Winbind 15 171 .SH "DESCRIPTION" 16 172 .PP 17 The idmap_ldap plugin provides a means for Winbind to store and retrieve SID/uid/gid mapping tables in an LDAP directory service\ . The module implements both the "idmap" and "idmap alloc" APIs\.173 The idmap_ldap plugin provides a means for Winbind to store and retrieve SID/uid/gid mapping tables in an LDAP directory service\&. The module implements both the "idmap" and "idmap alloc" APIs\&. 18 174 .SH "IDMAP OPTIONS" 19 175 .PP 20 176 ldap_base_dn = DN 21 177 .RS 4 22 Defines the directory base suffix to use when searching for SID/uid/gid mapping entries\ . If not defined, idmap_ldap will default to using the "ldap idmap suffix" option from smb\.conf\.178 Defines the directory base suffix to use when searching for SID/uid/gid mapping entries\&. If not defined, idmap_ldap will default to using the "ldap idmap suffix" option from smb\&.conf\&. 23 179 .RE 24 180 .PP 25 181 ldap_user_dn = DN 26 182 .RS 4 27 Defines the user DN to be used for authentication\ . If absent an anonymous bind will be performed\.183 Defines the user DN to be used for authentication\&. If absent an anonymous bind will be performed\&. 28 184 .RE 29 185 .PP 30 186 ldap_url = ldap://server/ 31 187 .RS 4 32 Specifies the LDAP server to use when searching for existing SID/uid/gid map entries\ . If not defined, idmap_ldap will assume that ldap://localhost/ should be used\.188 Specifies the LDAP server to use when searching for existing SID/uid/gid map entries\&. If not defined, idmap_ldap will assume that ldap://localhost/ should be used\&. 33 189 .RE 34 190 .PP 35 191 range = low \- high 36 192 .RS 4 37 Defines the available matching uid and gid range for which the backend is authoritative\ . Note that the range commonly matches the allocation range due to the fact that the same backend will store and retrieve SID/uid/gid mapping entries\. If the parameter is absent, Winbind fail over to use the "idmap uid" and "idmap gid" options from smb\.conf\.193 Defines the available matching uid and gid range for which the backend is authoritative\&. Note that the range commonly matches the allocation range due to the fact that the same backend will store and retrieve SID/uid/gid mapping entries\&. If the parameter is absent, Winbind fail over to use the "idmap uid" and "idmap gid" options from smb\&.conf\&. 38 194 .RE 39 195 .SH "IDMAP ALLOC OPTIONS" … … 41 197 ldap_base_dn = DN 42 198 .RS 4 43 Defines the directory base suffix under which new SID/uid/gid mapping entries should be stored\ . If not defined, idmap_ldap will default to using the "ldap idmap suffix" option from smb\.conf\.199 Defines the directory base suffix under which new SID/uid/gid mapping entries should be stored\&. If not defined, idmap_ldap will default to using the "ldap idmap suffix" option from smb\&.conf\&. 44 200 .RE 45 201 .PP 46 202 ldap_user_dn = DN 47 203 .RS 4 48 Defines the user DN to be used for authentication\ . If absent an anonymous bind will be performed\.204 Defines the user DN to be used for authentication\&. If absent an anonymous bind will be performed\&. 49 205 .RE 50 206 .PP 51 207 ldap_url = ldap://server/ 52 208 .RS 4 53 Specifies the LDAP server to which modify/add/delete requests should be sent\ . If not defined, idmap_ldap will assume that ldap://localhost/ should be used\.209 Specifies the LDAP server to which modify/add/delete requests should be sent\&. If not defined, idmap_ldap will assume that ldap://localhost/ should be used\&. 54 210 .RE 55 211 .PP 56 212 range = low \- high 57 213 .RS 4 58 Defines the available matching uid and gid range from which winbindd can allocate for users and groups\ . If the parameter is absent, Winbind fail over to use the "idmap uid" and "idmap gid" options from smb\.conf\.214 Defines the available matching uid and gid range from which winbindd can allocate for users and groups\&. If the parameter is absent, Winbind fail over to use the "idmap uid" and "idmap gid" options from smb\&.conf\&. 59 215 .RE 60 216 .SH "EXAMPLES" 61 217 .PP 62 The follow sets of a LDAP configuration which uses a slave server running on localhost for fast fetching SID/gid/uid mappings, it implies correct configuration of referrals\ . The idmap alloc backend is pointed directly to the master to skip the referral (and consequent reconnection to the master) that the slave would return as allocation requires writing on the master\.218 The follow sets of a LDAP configuration which uses a slave server running on localhost for fast fetching SID/gid/uid mappings, it implies correct configuration of referrals\&. The idmap alloc backend is pointed directly to the master to skip the referral (and consequent reconnection to the master) that the slave would return as allocation requires writing on the master\&. 63 219 .sp 64 .RS 4 220 .if n \{\ 221 .RS 4 222 .\} 223 .fam C 224 .ps -1 65 225 .nf 226 .if t \{\ 227 .sp -1 228 .\} 229 .BB lightgray adjust-for-leading-newline 230 .sp -1 231 66 232 [global] 67 233 idmap domains = ALLDOMAINS … … 74 240 idmap alloc backend = ldap 75 241 idmap alloc config:ldap_base_dn = ou=idmap,dc=example,dc=com 76 idmap alloc config:ldap_url = ldap://master\ .example\.com/242 idmap alloc config:ldap_url = ldap://master\&.example\&.com/ 77 243 idmap alloc config:range = 10000 \- 50000 78 244 79 .fi 80 .RE 245 .EB lightgray adjust-for-leading-newline 246 .if t \{\ 247 .sp 1 248 .\} 249 .fi 250 .fam 251 .ps +1 252 .if n \{\ 253 .RE 254 .\} 81 255 .SH "NOTE" 82 256 .PP 83 In order to use authentication against ldap servers you may need to provide a DN and a password\ . To avoid exposing the password in plain text in the configuration file we store it into a security store\. The "net idmap " command is used to store a secret for the DN specified in a specific idmap domain\.257 In order to use authentication against ldap servers you may need to provide a DN and a password\&. To avoid exposing the password in plain text in the configuration file we store it into a security store\&. The "net idmap " command is used to store a secret for the DN specified in a specific idmap domain\&. 84 258 .SH "AUTHOR" 85 259 .PP 86 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\.260 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\&.
Note:
See TracChangeset
for help on using the changeset viewer.
