Debian Codegraph @

upstream/fedora-44/man5/smb.conf.5

raw
1 '\" t
2 .\" Title: smb.conf
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 03/18/2026
6 .\" Manual: File Formats and Conventions
7 .\" Source: Samba 4.24.0
8 .\" Language: English
9 .\"
10 .TH "SMB\&.CONF" "5" "03/18/2026" "Samba 4\&.24\&.0" "File Formats and Conventions"
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"
31 smb.conf \- The configuration file for the Samba suite
32 .SH "SYNOPSIS"
33 .PP
34 The
35 smb\&.conf
36 file is a configuration file for the Samba suite\&.
37 smb\&.conf
38 contains runtime configuration information for the Samba programs\&. The complete description of the file format and possible parameters held within are here for reference purposes\&.
39 .SH "HOW CONFIGURATION CHANGES ARE APPLIED"
40 .PP
41 The Samba suite includes a number of different programs\&. Some of them operate in a client mode, others are server daemons that provide various services to its clients\&. The
42 smb\&.conf
43 file is processed in the following way:
44 .RS
45 .sp
46 .RS 4
47 .ie n \{\
48 \h'-04'\(bu\h'+03'\c
49 .\}
50 .el \{\
51 .sp -1
52 .IP \(bu 2.3
53 .\}
54 The Samba suite\*(Aqs client applications read their configuration only once\&. Any changes made after start aren\*(Aqt reflected in the context of already running client code\&.
55 .RE
56 .sp
57 .RS 4
58 .ie n \{\
59 \h'-04'\(bu\h'+03'\c
60 .\}
61 .el \{\
62 .sp -1
63 .IP \(bu 2.3
64 .\}
65 The Samba suite\*(Aqs server daemons reload their configuration when requested\&. However, already active connections do not change their configuration\&. More detailed information can be found in
66 \fBsmbd\fR(8)
67 and
68 \fBwinbindd\fR(8)
69 manual pages\&.
70 .RE
71 .sp
72 .RE
73 .PP
74 To request Samba server daemons to refresh their configuration, please use
75 \fBsmbcontrol\fR(1)
76 utility\&.
77 .SH "FILE FORMAT"
78 .PP
79 The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form:
80 .sp
81 .if n \{\
82 .RS 4
83 .\}
84 .nf
85 \fIname\fR = \fIvalue \fR
86 .fi
87 .if n \{\
88 .RE
89 .\}
90 .PP
91 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
92 .PP
93 Section and parameter names are not case sensitive\&.
94 .PP
95 Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&.
96 .PP
97 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
98 .PP
99 Any line ending in a
100 \(lq\e\(rq
101 is continued on the next line in the customary UNIX fashion\&.
102 .PP
103 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
104 .SH "SECTION DESCRIPTIONS"
105 .PP
106 Each section in the configuration file (except for the [global] section) describes a shared resource (known as a
107 \(lqshare\(rq)\&. The section name is the name of the shared resource and the parameters within the section define the shares attributes\&.
108 .PP
109 There are three special sections, [global], [homes] and [printers], which are described under
110 \fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
111 .PP
112 A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. Some housekeeping options are also specifiable\&.
113 .PP
114 Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server)\&.
115 .PP
116 Sections may be designated
117 \fIguest\fR
118 services, in which case no password is required to access them\&. A specified UNIX
119 \fIguest account\fR
120 is used to define access privileges in this case\&.
121 .PP
122 Sections other than guest services will require a password to access them\&. The client provides the username\&. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the
123 user =
124 option in the share definition\&. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\&.
125 .PP
126 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&.
127 .PP
128 The following sample section defines a file space share\&. The user has write access to the path
129 /home/bar\&. The share is accessed via the share name
130 foo:
131 .sp
132 .if n \{\
133 .RS 4
134 .\}
135 .nf
136 \fI[foo]\fR
137 \m[blue]\fBpath = /home/bar\fR\m[]
138 \m[blue]\fBread only = no\fR\m[]
139 .fi
140 .if n \{\
141 .RE
142 .\}
143 .PP
144 The following sample section defines a printable share\&. The share is read\-only, but printable\&. That is, the only write access permitted is via calls to open, write to and close a spool file\&. The
145 \fIguest ok\fR
146 parameter means access will be permitted as the default guest user (specified elsewhere):
147 .sp
148 .if n \{\
149 .RS 4
150 .\}
151 .nf
152 \fI[aprinter]\fR
153 \m[blue]\fBpath = /var/tmp\fR\m[]
154 \m[blue]\fBread only = yes\fR\m[]
155 \m[blue]\fBprintable = yes\fR\m[]
156 \m[blue]\fBguest ok = yes\fR\m[]
157 .fi
158 .if n \{\
159 .RE
160 .\}
161 .sp
162 .SH "SPECIAL SECTIONS"
163 .SS "The [global] section"
164 .PP
165 Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items\&. See the notes under PARAMETERS for more information\&.
166 .SS "The [homes] section"
167 .PP
168 If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server\&.
169 .PP
170 When the connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, the requested section name is treated as a username and looked up in the local password file\&. If the name exists and the correct password has been given, a share is created by cloning the [homes] section\&.
171 .PP
172 Some modifications are then made to the newly created share:
173 .RS
174 .sp
175 .RS 4
176 .ie n \{\
177 \h'-04'\(bu\h'+03'\c
178 .\}
179 .el \{\
180 .sp -1
181 .IP \(bu 2.3
182 .\}
183 The share name is changed from homes to the located username\&.
184 .RE
185 .sp
186 .RS 4
187 .ie n \{\
188 \h'-04'\(bu\h'+03'\c
189 .\}
190 .el \{\
191 .sp -1
192 .IP \(bu 2.3
193 .\}
194 If no path was given, the path is set to the user\*(Aqs home directory\&.
195 .RE
196 .sp
197 .RE
198 .PP
199 If you decide to use a
200 \fIpath =\fR
201 line in your [homes] section, it may be useful to use the %S macro\&. For example:
202 .sp
203 .if n \{\
204 .RS 4
205 .\}
206 .nf
207 \fBpath = /data/pchome/%S\fR
208 .fi
209 .if n \{\
210 .RE
211 .\}
212 .sp
213 is useful if you have different home directories for your PCs than for UNIX access\&.
214 .PP
215 This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\&.
216 .PP
217 A similar process occurs if the requested section name is
218 \(lqhomes\(rq, except that the share name is not changed to that of the requesting user\&. This method of using the [homes] section works well if different users share a client PC\&.
219 .PP
220 The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others\&. The following is a typical and suitable [homes] section:
221 .sp
222 .if n \{\
223 .RS 4
224 .\}
225 .nf
226 \fI[homes]\fR
227 \m[blue]\fBread only = no\fR\m[]
228 .fi
229 .if n \{\
230 .RE
231 .\}
232 .PP
233 An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients
234 \fIwithout a password\fR\&. In the very unlikely event that this is actually desirable, it is wise to also specify
235 \fIread only access\fR\&.
236 .PP
237 The
238 \fIbrowseable\fR
239 flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag\&. This is useful as it means setting
240 \fIbrowseable = no\fR
241 in the [homes] section will hide the [homes] share but make any auto home directories visible\&.
242 .SS "The [printers] section"
243 .PP
244 This section works like [homes], but for printers\&.
245 .PP
246 If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host\*(Aqs printcap file\&.
247 .PP
248 When a connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, but a [homes] section exists, it is used as described above\&. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name\&. If a match is found, a new printer share is created by cloning the [printers] section\&.
249 .PP
250 A few modifications are then made to the newly created share:
251 .RS
252 .sp
253 .RS 4
254 .ie n \{\
255 \h'-04'\(bu\h'+03'\c
256 .\}
257 .el \{\
258 .sp -1
259 .IP \(bu 2.3
260 .\}
261 The share name is set to the located printer name
262 .RE
263 .sp
264 .RS 4
265 .ie n \{\
266 \h'-04'\(bu\h'+03'\c
267 .\}
268 .el \{\
269 .sp -1
270 .IP \(bu 2.3
271 .\}
272 If no printer name was given, the printer name is set to the located printer name
273 .RE
274 .sp
275 .RS 4
276 .ie n \{\
277 \h'-04'\(bu\h'+03'\c
278 .\}
279 .el \{\
280 .sp -1
281 .IP \(bu 2.3
282 .\}
283 If the share does not permit guest access and no username was given, the username is set to the located printer name\&.
284 .RE
285 .sp
286 .RE
287 .PP
288 The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\&.
289 .PP
290 Typically the path specified is that of a world\-writeable spool directory with the sticky bit set on it\&. A typical [printers] entry looks like this:
291 .sp
292 .if n \{\
293 .RS 4
294 .\}
295 .nf
296 \fI[printers]\fR
297 \m[blue]\fBpath = /var/tmp\fR\m[]
298 \m[blue]\fBguest ok = yes\fR\m[]
299 \m[blue]\fBprintable = yes\fR\m[]
300 .fi
301 .if n \{\
302 .RE
303 .\}
304 .PP
305 All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned\&. If your printing subsystem doesn\*(Aqt work like that, you will have to set up a pseudo\-printcap\&. This is a file consisting of one or more lines like this:
306 .sp
307 .if n \{\
308 .RS 4
309 .\}
310 .nf
311 alias|alias|alias|alias\&.\&.\&.
312 .fi
313 .if n \{\
314 .RE
315 .\}
316 .PP
317 Each alias should be an acceptable printer name for your printing subsystem\&. In the [global] section, specify the new file as your printcap\&. The server will only recognize names found in your pseudo\-printcap, which of course can contain whatever aliases you like\&. The same technique could be used simply to limit access to a subset of your local printers\&.
318 .PP
319 An alias, by the way, is defined as any component of the first entry of a printcap record\&. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (|)\&.
320 .if n \{\
321 .sp
322 .\}
323 .RS 4
324 .it 1 an-trap
325 .nr an-no-space-flag 1
326 .nr an-break-flag 1
327 .br
328 .ps +1
329 \fBNote\fR
330 .ps -1
331 .br
332 .PP
333 On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
334 printcap name = lpstat
335 to automatically obtain a list of printers\&. See the
336 printcap name
337 option for more details\&.
338 .sp .5v
339 .RE
340 .SH "USERSHARES"
341 .PP
342 Starting with Samba version 3\&.0\&.23 the capability for non\-root users to add, modify, and delete their own share definitions has been added\&. This capability is called
343 \fIusershares\fR
344 and is controlled by a set of parameters in the [global] section of the smb\&.conf\&. The relevant parameters are :
345 .PP
346 usershare allow guests
347 .RS 4
348 Controls if usershares can permit guest access\&.
349 .RE
350 .PP
351 usershare max shares
352 .RS 4
353 Maximum number of user defined shares allowed\&.
354 .RE
355 .PP
356 usershare owner only
357 .RS 4
358 If set only directories owned by the sharing user can be shared\&.
359 .RE
360 .PP
361 usershare path
362 .RS 4
363 Points to the directory containing the user defined share definitions\&. The filesystem permissions on this directory control who can create user defined shares\&.
364 .RE
365 .PP
366 usershare prefix allow list
367 .RS 4
368 Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Only directories below the pathnames in this list are permitted\&.
369 .RE
370 .PP
371 usershare prefix deny list
372 .RS 4
373 Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Directories below the pathnames in this list are prohibited\&.
374 .RE
375 .PP
376 usershare template share
377 .RS 4
378 Names a pre\-existing share used as a template for creating new usershares\&. All other share parameters not specified in the user defined share definition are copied from this named share\&.
379 .RE
380 .PP
381 To allow members of the UNIX group
382 foo
383 to create user defined shares, create the directory to contain the share definitions as follows:
384 .PP
385 Become root:
386 .sp
387 .if n \{\
388 .RS 4
389 .\}
390 .nf
391 mkdir /usr/local/samba/lib/usershares
392 chgrp foo /usr/local/samba/lib/usershares
393 chmod 1770 /usr/local/samba/lib/usershares
394 .fi
395 .if n \{\
396 .RE
397 .\}
398 .PP
399 Then add the parameters
400 .sp
401 .if n \{\
402 .RS 4
403 .\}
404 .nf
405 \m[blue]\fBusershare path = /usr/local/samba/lib/usershares\fR\m[]
406 \m[blue]\fBusershare max shares = 10\fR\m[] # (or the desired number of shares)
407 .fi
408 .if n \{\
409 .RE
410 .\}
411 .sp
412 to the global section of your
413 smb\&.conf\&. Members of the group foo may then manipulate the user defined shares using the following commands\&.
414 .PP
415 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
416 .RS 4
417 To create or modify (overwrite) a user defined share\&.
418 .RE
419 .PP
420 net usershare delete sharename
421 .RS 4
422 To delete a user defined share\&.
423 .RE
424 .PP
425 net usershare list wildcard\-sharename
426 .RS 4
427 To list user defined shares\&.
428 .RE
429 .PP
430 net usershare info wildcard\-sharename
431 .RS 4
432 To print information about user defined shares\&.
433 .RE
434 .SH "PARAMETERS"
435 .PP
436 Parameters define the specific attributes of sections\&.
437 .PP
438 Some parameters are specific to the [global] section (e\&.g\&.,
439 \fIsecurity\fR)\&. Some parameters are usable in all sections (e\&.g\&.,
440 \fIcreate mask\fR)\&. All others are permissible only in normal sections\&. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal\&. The letter
441 \fIG\fR
442 in parentheses indicates that a parameter is specific to the [global] section\&. The letter
443 \fIS\fR
444 indicates that a parameter can be specified in a service specific section\&. All
445 \fIS\fR
446 parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\&.
447 .PP
448 Parameters are arranged here in alphabetical order \- this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym\&.
449 .SH "VARIABLE SUBSTITUTIONS"
450 .PP
451 Many of the strings that are settable in the config file can take substitutions\&. For example the option
452 \(lqpath = /tmp/%u\(rq
453 is interpreted as
454 \(lqpath = /tmp/john\(rq
455 if the user connected with the username john\&.
456 .PP
457 These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\&. These are:
458 .PP
459 %U
460 .RS 4
461 session username (the username that the client wanted, not necessarily the same as the one they got)\&.
462 .RE
463 .PP
464 %G
465 .RS 4
466 primary group name of %U\&.
467 .RE
468 .PP
469 %h
470 .RS 4
471 the Internet hostname that Samba is running on\&.
472 .RE
473 .PP
474 %m
475 .RS 4
476 the NetBIOS name of the client machine (very useful)\&.
477 .sp
478 This parameter is not available when Samba listens on port 445, as clients no longer send this information\&. If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section
479 \fIserver smb transports = 139\fR\&. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2\&.x\&.
480 .RE
481 .PP
482 %L
483 .RS 4
484 the NetBIOS name of the server\&. This allows you to change your config based on what the client calls you\&. Your server can have a
485 \(lqdual personality\(rq\&.
486 .RE
487 .PP
488 %M
489 .RS 4
490 the Internet name of the client machine\&.
491 .RE
492 .PP
493 %R
494 .RS 4
495 the selected protocol level after protocol negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2, NT1, SMB2_02, SMB2_10, SMB3_00, SMB3_02, SMB3_11 or SMB2_FF\&.
496 .RE
497 .PP
498 %d
499 .RS 4
500 the process id of the current server process\&.
501 .RE
502 .PP
503 %a
504 .RS 4
505 The architecture of the remote machine\&. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Mac OS X (\fBOSX\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), Windows XP 64\-bit(\fBWinXP64\fR), Windows 2003 including 2003R2 (\fBWin2K3\fR), and Windows Vista (\fBVista\fR)\&. Anything else will be known as
506 \fBUNKNOWN\fR\&.
507 .RE
508 .PP
509 %I
510 .RS 4
511 the IP address of the client machine\&.
512 .sp
513 Before 4\&.0\&.0 it could contain IPv4 mapped IPv6 addresses, now it only contains IPv4 or IPv6 addresses\&.
514 .RE
515 .PP
516 %J
517 .RS 4
518 the IP address of the client machine, colons/dots replaced by underscores\&.
519 .RE
520 .PP
521 %i
522 .RS 4
523 the local IP address to which a client connected\&.
524 .sp
525 Before 4\&.0\&.0 it could contain IPv4 mapped IPv6 addresses, now it only contains IPv4 or IPv6 addresses\&.
526 .RE
527 .PP
528 %j
529 .RS 4
530 the local IP address to which a client connected, colons/dots replaced by underscores\&.
531 .RE
532 .PP
533 %T
534 .RS 4
535 the current date and time\&.
536 .RE
537 .PP
538 %t
539 .RS 4
540 the current date and time in a minimal format without colons (YYYYYmmdd_HHMMSS)\&.
541 .RE
542 .PP
543 %D
544 .RS 4
545 name of the domain or workgroup of the current user\&.
546 .RE
547 .PP
548 %w
549 .RS 4
550 the winbind separator\&.
551 .RE
552 .PP
553 %$(\fIenvvar\fR)
554 .RS 4
555 the value of the environment variable
556 \fIenvar\fR\&.
557 .RE
558 .PP
559 The following substitutes apply only to some configuration options (only those that are used when a connection has been established):
560 .PP
561 %S
562 .RS 4
563 the name of the current service, if any\&.
564 .RE
565 .PP
566 %P
567 .RS 4
568 the root directory of the current service, if any\&.
569 .RE
570 .PP
571 %u
572 .RS 4
573 username of the current service, if any\&.
574 .RE
575 .PP
576 %g
577 .RS 4
578 primary group name of %u\&.
579 .RE
580 .PP
581 %H
582 .RS 4
583 the home directory of the user given by %u\&.
584 .RE
585 .PP
586 %N
587 .RS 4
588 This value is the same as %L\&.
589 .RE
590 .PP
591 There are some quite creative things that can be done with these substitutions and other
592 smb\&.conf
593 options\&.
594 .SH "NAME MANGLING"
595 .PP
596 Samba supports
597 name mangling
598 so that DOS and Windows clients can use files that don\*(Aqt conform to the 8\&.3 format\&. It can also be set to adjust the case of 8\&.3 format filenames\&.
599 .PP
600 There are several options that control the way mangling is performed, and they are grouped here rather than listed separately\&. For the defaults look at the output of the testparm program\&.
601 .PP
602 These options can be set separately for each service\&.
603 .PP
604 The options are:
605 .PP
606 case sensitive = yes/no/auto
607 .RS 4
608 controls whether filenames are case sensitive\&. If they aren\*(Aqt, Samba must do a filename search and match on passed names\&. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\&.0\&.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\&. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is the same as setting it to no for them\&. Default
609 \fIauto\fR\&.
610 .RE
611 .PP
612 default case = upper/lower
613 .RS 4
614 controls what the default case is for new filenames (ie\&. files that don\*(Aqt currently exist in the filesystem)\&. Default
615 \fIlower\fR\&. IMPORTANT NOTE: As part of the optimizations for directories containing large numbers of files, the following special case applies\&. If the options
616 \m[blue]\fBcase sensitive = yes\fR\m[],
617 \m[blue]\fBpreserve case = No\fR\m[], and
618 \m[blue]\fBshort preserve case = No\fR\m[]
619 are set, then the case of
620 \fIall\fR
621 incoming client filenames, not just new filenames, will be modified\&. See additional notes below\&.
622 .RE
623 .PP
624 preserve case = yes/no
625 .RS 4
626 controls whether new files (ie\&. files that don\*(Aqt currently exist in the filesystem) are created with the case that the client passes, or if they are forced to be the
627 default
628 case\&. Default
629 \fIyes\fR\&.
630 .RE
631 .PP
632 short preserve case = yes/no
633 .RS 4
634 controls if new files (ie\&. files that don\*(Aqt currently exist in the filesystem) which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the
635 default
636 case\&. This option can be used with
637 preserve case = yes
638 to permit long filenames to retain their case, while short names are lowercased\&. Default
639 \fIyes\fR\&.
640 .RE
641 .PP
642 By default, Samba 3\&.0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving\&. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share\&.
643 .SH "REGISTRY\-BASED CONFIGURATION"
644 .PP
645 Starting with Samba version 3\&.2\&.0, the capability to store Samba configuration in the registry is available\&. The configuration is stored in the registry key
646 \fIHKLM\eSoftware\eSamba\esmbconf\fR\&. There are two levels of registry configuration:
647 .RS
648 .sp
649 .RS 4
650 .ie n \{\
651 \h'-04' 1.\h'+01'\c
652 .\}
653 .el \{\
654 .sp -1
655 .IP " 1." 4.2
656 .\}
657 Share definitions stored in registry are used\&. This is triggered by setting the global parameter
658 \fIregistry shares\fR
659 to
660 \(lqyes\(rq
661 in
662 \fIsmb\&.conf\fR\&.
663 .sp
664 The registry shares are loaded not at startup but on demand at runtime by
665 \fIsmbd\fR\&. Shares defined in
666 \fIsmb\&.conf\fR
667 take priority over shares of the same name defined in registry\&.
668 .RE
669 .sp
670 .RS 4
671 .ie n \{\
672 \h'-04' 2.\h'+01'\c
673 .\}
674 .el \{\
675 .sp -1
676 .IP " 2." 4.2
677 .\}
678 Global
679 \fIsmb\&.conf\fR
680 options stored in registry are used\&. This can be activated in two different ways:
681 .sp
682 Firstly, a registry only configuration is triggered by setting
683 \m[blue]\fBconfig backend = registry\fR\m[]
684 in the [global] section of
685 \fIsmb\&.conf\fR\&. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry\&. This is the recommended method of using registry based configuration\&.
686 .sp
687 Secondly, a mixed configuration can be activated by a special new meaning of the parameter
688 \m[blue]\fBinclude = registry\fR\m[]
689 in the [global] section of
690 \fIsmb\&.conf\fR\&. This reads the global options from registry with the same priorities as for an include of a text file\&. This may be especially useful in cases where an initial configuration is needed to access the registry\&.
691 .sp
692 Activation of global registry options automatically activates registry shares\&. So in the registry only case, shares are loaded on demand only\&.
693 .RE
694 .sp
695 .RE
696 .PP
697 Note: To make registry\-based configurations foolproof at least to a certain extent, the use of
698 \fIlock directory\fR
699 and
700 \fIconfig backend\fR
701 inside the registry configuration has been disabled: Especially by changing the
702 \fIlock directory\fR
703 inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\&.
704 .PP
705 The registry configuration can be accessed with tools like
706 \fIregedit\fR
707 or
708 \fInet (rpc) registry\fR
709 in the key
710 \fIHKLM\eSoftware\eSamba\esmbconf\fR\&. More conveniently, the
711 \fIconf\fR
712 subcommand of the
713 \fBnet\fR(8)
714 utility offers a dedicated interface to read and write the registry based configuration locally, i\&.e\&. directly accessing the database file, circumventing the server\&.
715 .SH "IDENTITY MAPPING CONSIDERATIONS"
716 .PP
717 In the SMB protocol, users, groups, and machines are represented by their security identifiers (SIDs)\&. On POSIX system Samba processes need to run under corresponding POSIX user identities and with supplemental POSIX groups to allow access to the files owned by those users and groups\&. The process of mapping SIDs to POSIX users and groups is called
718 \fIIDENTITY MAPPING\fR
719 or, in short,
720 \fIID MAPPING\fR\&.
721 .PP
722 Samba supports multiple ways to map SIDs to POSIX users and groups\&. The configuration is driven by the
723 \m[blue]\fBidmap config DOMAIN : OPTION\fR\m[]
724 option which allows one to specify identity mapping (idmap) options for each domain separately\&.
725 .PP
726 Identity mapping modules implement different strategies for mapping of SIDs to POSIX user and group identities\&. They are applicable to different use cases and scenarios\&. It is advised to read the documentation of the individual identity mapping modules before choosing a specific scenario to use\&. Each identity management module is documented in a separate manual page\&. The standard idmap backends are tdb (\fBidmap_tdb\fR(8)), tdb2 (\fBidmap_tdb2\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), hash (\fBidmap_hash\fR(8)), autorid (\fBidmap_autorid\fR(8)), ad (\fBidmap_ad\fR(8)), nss (\fBidmap_nss\fR(8)), and rfc2307 (\fBidmap_rfc2307\fR(8))\&.
727 .PP
728 Overall, ID mapping configuration should be decided carefully\&. Changes to the already deployed ID mapping configuration may create the risk of losing access to the data or disclosing the data to the wrong parties\&.
729 .PP
730 This example shows how to configure two domains with
731 \fBidmap_rid\fR(8), the principal domain and a trusted domain, leaving the default id mapping scheme at tdb\&.
732 .sp
733 .if n \{\
734 .RS 4
735 .\}
736 .nf
737 [global]
738 security = domain
739 workgroup = MAIN
740
741 idmap config * : backend = tdb
742 idmap config * : range = 1000000\-1999999
743
744 idmap config MAIN : backend = rid
745 idmap config MAIN : range = 5000000\-5999999
746
747 idmap config TRUSTED : backend = rid
748 idmap config TRUSTED : range = 6000000\-6999999
749 .fi
750 .if n \{\
751 .RE
752 .\}
753 .SH "EXPLANATION OF EACH PARAMETER"
754
755
756 abort shutdown script (G)
757 .PP
758 .RS 4
759 This a full path name to a script called by
760 \fBsmbd\fR(8)
761 that should stop a shutdown procedure issued by the
762 \m[blue]\fBshutdown script\fR\m[]\&.
763 .sp
764 If the connected user possesses the
765 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
766 .sp
767 Default:
768 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI""\fR\fI \fR
769 .sp
770 Example:
771 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI/sbin/shutdown \-c\fR\fI \fR
772 .RE
773
774 access based share enum (S)
775 .PP
776 .RS 4
777 If this parameter is
778 \fByes\fR
779 for a service, then the share hosted by the service will only be visible to users who have read or write access to the share during share enumeration (for example net view \e\esambaserver)\&. The share ACLs which allow or deny the access to the share can be modified using for example the
780 sharesec
781 command or using the appropriate Windows tools\&. This has parallels to access based enumeration, the main difference being that only share permissions are evaluated, and security descriptors on files contained on the share are not used in computing enumeration access rights\&.
782 .sp
783 Default:
784 \fI\fIaccess based share enum\fR\fR\fI = \fR\fIno\fR\fI \fR
785 .RE
786
787 acl allow execute always (S)
788 .PP
789 .RS 4
790 This boolean parameter controls the behaviour of
791 \fBsmbd\fR(8)
792 when receiving a protocol request of "open for execution" from a Windows client\&. With Samba 3\&.6 and older, the execution right in the ACL was not checked, so a client could execute a file even if it did not have execute rights on the file\&. In Samba 4\&.0, this has been fixed, so that by default, i\&.e\&. when this parameter is set to "False", "open for execution" is now denied when execution permissions are not present\&.
793 .sp
794 If this parameter is set to "True", Samba does not check execute permissions on "open for execution", thus re\-establishing the behaviour of Samba 3\&.6\&. This can be useful to smoothen upgrades from older Samba versions to 4\&.0 and newer\&. This setting is not meant to be used as a permanent setting, but as a temporary relief: It is recommended to fix the permissions in the ACLs and reset this parameter to the default after a certain transition period\&.
795 .sp
796 Default:
797 \fI\fIacl allow execute always\fR\fR\fI = \fR\fIno\fR\fI \fR
798 .RE
799
800 acl check permissions (S)
801 .PP
802 .RS 4
803 Please note this parameter is now deprecated in Samba 3\&.6\&.2 and will be removed in a future version of Samba\&.
804 .sp
805 This boolean parameter controls what
806 \fBsmbd\fR(8)
807 does on receiving a protocol request of "open for delete" from a Windows client\&. If a Windows client doesn\*(Aqt have permissions to delete a file then they expect this to be denied at open time\&. POSIX systems normally only detect restrictions on delete by actually attempting to delete the file or directory\&. As Windows clients can (and do) "back out" a delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately on "open for delete" request as we cannot restore such a deleted file\&. With this parameter set to true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the request without actually deleting the file if the file system permissions would seem to deny it\&. This is not perfect, as it\*(Aqs possible a user could have deleted a file without Samba being able to check the permissions correctly, but it is close enough to Windows semantics for mostly correct behaviour\&. Samba will correctly check POSIX ACL semantics in this case\&.
808 .sp
809 If this parameter is set to "false" Samba doesn\*(Aqt check permissions on "open for delete" and allows the open\&. If the user doesn\*(Aqt have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user\&. The symptom of this is files that appear to have been deleted "magically" re\-appearing on a Windows explorer refresh\&. This is an extremely advanced protocol option which should not need to be changed\&. This parameter was introduced in its final form in 3\&.0\&.21, an earlier version with slightly different semantics was introduced in 3\&.0\&.20\&. That older version is not documented here\&.
810 .sp
811 Default:
812 \fI\fIacl check permissions\fR\fR\fI = \fR\fIyes\fR\fI \fR
813 .RE
814
815 acl claims evaluation (G)
816 .PP
817 .RS 4
818 This option controls the way Samba handles evaluation of security descriptors in Samba, with regards to Active Directory Claims\&. AD Claims, introduced with Windows 2012, are essentially administrator\-defined key\-value pairs that can be set both in Active Directory (communicated via the Kerberos PAC) and in the security descriptor themselves\&.
819 .sp
820 Active Directory claims are new with Samba 4\&.20\&. Because the claims are evaluated against a very flexible expression language within the security descriptor, this option provides a mechanism to disable this logic if required by the administrator\&.
821 .sp
822 This default behaviour is that claims evaluation is enabled in the AD DC only\&. Additionally, claims evaluation on the AD DC is only enabled if the DC functional level is 2012 or later\&. See
823 \m[blue]\fBad dc functional level\fR\m[]\&.
824 .sp
825 Possible values are :
826 .RS
827 .sp
828 .RS 4
829 .ie n \{\
830 \h'-04'\(bu\h'+03'\c
831 .\}
832 .el \{\
833 .sp -1
834 .IP \(bu 2.3
835 .\}
836 \fBAD DC only\fR: Enabled for the Samba AD DC (for DC functional level 2012 or higher)\&.
837 .RE
838 .sp
839 .RS 4
840 .ie n \{\
841 \h'-04'\(bu\h'+03'\c
842 .\}
843 .el \{\
844 .sp -1
845 .IP \(bu 2.3
846 .\}
847 \fBnever\fR: Disabled in all cases\&. This option disables some but not all of the Authentication Policies and Authentication Policy Silos features of the Windows 2012R2 functional level in the AD DC\&.
848 .RE
849 .sp
850 .RE
851 Default:
852 \fI\fIacl claims evaluation\fR\fR\fI = \fR\fIAD DC only\fR\fI \fR
853 .RE
854
855 acl flag inherited canonicalization (S)
856 .PP
857 .RS 4
858 This option controls the way Samba handles client requests setting the Security Descriptor of files and directories and the effect the operation has on the Security Descriptor flag "DACL auto\-inherited" (DI)\&. Generally, this flag is set on a file (or directory) upon creation if the parent directory has DI set and also has inheritable ACEs\&.
859 .sp
860 On the other hand when a Security Descriptor is explicitly set on a file, the DI flag is cleared, unless the flag "DACL Inheritance Required" (DR) is also set in the new Security Descriptor (fwiw, DR is never stored on disk)\&.
861 .sp
862 This is the default behaviour when this option is enabled (the default)\&. When setting this option to
863 no, the resulting value of the DI flag on\-disk is directly taken from the DI value of the to\-be\-set Security Descriptor\&. This can be used so dump tools like rsync that copy data blobs from xattrs that represent ACLs created by the acl_xattr VFS module will result in copies of the ACL that are identical to the source\&. Without this option, the copied ACLs would all lose the DI flag if set on the source\&.
864 .sp
865 Default:
866 \fI\fIacl flag inherited canonicalization\fR\fR\fI = \fR\fIyes\fR\fI \fR
867 .RE
868
869 acl group control (S)
870 .PP
871 .RS 4
872 In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions and ACLs on a file\&. If this parameter is set, then Samba overrides this restriction, and also allows the
873 \fIprimary group owner\fR
874 of a file or directory to modify the permissions and ACLs on that file\&.
875 .sp
876 On a Windows server, groups may be the owner of a file or directory \- thus allowing anyone in that group to modify the permissions on it\&. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group\&. This means there are multiple people with permissions to modify ACLs on a file or directory, easing manageability\&.
877 .sp
878 This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same way as Windows\&. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on\&.
879 .sp
880 This parameter is best used with the
881 \m[blue]\fBinherit owner\fR\m[]
882 option and also on a share containing directories with the UNIX
883 \fIsetgid bit\fR
884 set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.
885 .sp
886 This parameter was deprecated in Samba 3\&.0\&.23, but re\-activated in Samba 3\&.0\&.31 and above, as it now only controls permission changes if the user is in the owning primary group\&. It is now no longer equivalent to the
887 \fIdos filemode\fR
888 option\&.
889 .sp
890 Default:
891 \fI\fIacl group control\fR\fR\fI = \fR\fIno\fR\fI \fR
892 .RE
893
894 acl map full control (S)
895 .PP
896 .RS 4
897 This boolean parameter controls whether
898 \fBsmbd\fR(8)
899 maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum allowed POSIX permission set, into a Windows ACL of "FULL CONTROL"\&. If this parameter is set to true any POSIX ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and execute\&.
900 .sp
901 Default:
902 \fI\fIacl map full control\fR\fR\fI = \fR\fIyes\fR\fI \fR
903 .RE
904
905 ad dc functional level (G)
906 .PP
907 .RS 4
908 The value of the parameter (a string) is the Active Directory functional level that this Domain Controller will claim to support\&.
909 .sp
910 Possible values are :
911 .RS
912 .sp
913 .RS 4
914 .ie n \{\
915 \h'-04'\(bu\h'+03'\c
916 .\}
917 .el \{\
918 .sp -1
919 .IP \(bu 2.3
920 .\}
921 \fB2008_R2\fR: Similar to Windows 2008 R2 Functional Level
922 .RE
923 .sp
924 .RS 4
925 .ie n \{\
926 \h'-04'\(bu\h'+03'\c
927 .\}
928 .el \{\
929 .sp -1
930 .IP \(bu 2.3
931 .\}
932 \fB2012\fR: Similar to Windows 2012 Functional Level
933 .RE
934 .sp
935 .RS 4
936 .ie n \{\
937 \h'-04'\(bu\h'+03'\c
938 .\}
939 .el \{\
940 .sp -1
941 .IP \(bu 2.3
942 .\}
943 \fB2012_R2\fR: Similar to Windows 2012 R2 Functional Level
944 .RE
945 .sp
946 .RS 4
947 .ie n \{\
948 \h'-04'\(bu\h'+03'\c
949 .\}
950 .el \{\
951 .sp -1
952 .IP \(bu 2.3
953 .\}
954 \fB2016\fR: Similar to Windows 2016 Functional Level
955 .RE
956 .sp
957 .RE
958 Normally this option should not be set as Samba will operate per the released functionality of the Samba Active Directory Domain Controller\&.
959 .sp
960 However to access incomplete features in domain functional level 2016 it may be useful to set this value, prior to upgrading the domain functional level\&.
961 .sp
962 If this is set manually, the protection against mismatching features between domain controllers is reduced, so all domain controllers should be running the same version of Samba, to ensure that behaviour as seen by the client is the same no matter which DC is contacted\&.
963 .sp
964 Setting this to
965 \fB2016\fR
966 will allow raising the domain functional level with
967 samba\-tool domain level raise \-\-domain\-level=2016
968 and provide access to Samba\*(Aqs Kerberos Claims and Dynamic Access Control feature\&.
969 .if n \{\
970 .sp
971 .\}
972 .RS 4
973 .it 1 an-trap
974 .nr an-no-space-flag 1
975 .nr an-break-flag 1
976 .br
977 .ps +1
978 \fBWarning\fR
979 .ps -1
980 .br
981 The Samba\*(Aqs Kerberos Claims and Dynamic Access Control features enabled with
982 \fB2016\fR
983 are incomplete in Samba 4\&.19\&.
984 .sp .5v
985 .RE
986 Default:
987 \fI\fIad dc functional level\fR\fR\fI = \fR\fI2008_R2\fR\fI \fR
988 .sp
989 Example:
990 \fI\fIad dc functional level\fR\fR\fI = \fR\fI2016\fR\fI \fR
991 .RE
992
993 add group script (G)
994 .PP
995 .RS 4
996 This is the full pathname to a script that will be run
997 \fIAS ROOT\fR
998 by
999 \fBsmbd\fR(8)
1000 when a new group is requested\&. It will expand any
1001 \fI%g\fR
1002 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions\&. In that case the script must print the numeric gid of the created group on stdout\&.
1003 .sp
1004 Default:
1005 \fI\fIadd group script\fR\fR\fI = \fR\fI\fR\fI \fR
1006 .sp
1007 Example:
1008 \fI\fIadd group script\fR\fR\fI = \fR\fI/usr/sbin/groupadd %g\fR\fI \fR
1009 .RE
1010
1011 additional dns hostnames (G)
1012 .PP
1013 .RS 4
1014 A list of additional DNS names by which this host can be identified
1015 .sp
1016 Default:
1017 \fI\fIadditional dns hostnames\fR\fR\fI = \fR\fI # empty string (no additional dns names)\fR\fI \fR
1018 .sp
1019 Example:
1020 \fI\fIadditional dns hostnames\fR\fR\fI = \fR\fI host2\&.example\&.com host3\&.other\&.com \fR\fI \fR
1021 .RE
1022
1023 add machine script (G)
1024 .PP
1025 .RS 4
1026 This is the full pathname to a script that will be run by
1027 \fBsmbd\fR(8)
1028 when a machine is added to Samba\*(Aqs domain and a Unix account matching the machine\*(Aqs name appended with a "$" does not already exist\&.
1029 .sp
1030 This option is very similar to the
1031 \m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.
1032 .sp
1033 Default:
1034 \fI\fIadd machine script\fR\fR\fI = \fR\fI\fR\fI \fR
1035 .sp
1036 Example:
1037 \fI\fIadd machine script\fR\fR\fI = \fR\fI/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\fR\fI \fR
1038 .RE
1039
1040 addport command (G)
1041 .PP
1042 .RS 4
1043 Samba 3\&.0\&.23 introduced support for adding printer ports remotely using the Windows "Add Standard TCP/IP Port Wizard"\&. This option defines an external program to be executed when smbd receives a request to add a new Port to the system\&. The script is passed two parameters:
1044 .RS
1045 .sp
1046 .RS 4
1047 .ie n \{\
1048 \h'-04'\(bu\h'+03'\c
1049 .\}
1050 .el \{\
1051 .sp -1
1052 .IP \(bu 2.3
1053 .\}
1054 \fIport name\fR
1055 .RE
1056 .sp
1057 .RS 4
1058 .ie n \{\
1059 \h'-04'\(bu\h'+03'\c
1060 .\}
1061 .el \{\
1062 .sp -1
1063 .IP \(bu 2.3
1064 .\}
1065 \fIdevice URI\fR
1066 .RE
1067 .sp
1068 .RE
1069 The deviceURI is in the format of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.
1070 .sp
1071 Default:
1072 \fI\fIaddport command\fR\fR\fI = \fR\fI\fR\fI \fR
1073 .sp
1074 Example:
1075 \fI\fIaddport command\fR\fR\fI = \fR\fI/etc/samba/scripts/addport\&.sh\fR\fI \fR
1076 .RE
1077
1078 addprinter command (G)
1079 .PP
1080 .RS 4
1081 With the introduction of MS\-RPC based printing support for Windows NT/2000 clients in Samba 2\&.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers\&.\&.\&." folder displayed a share listing\&. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server\&.
1082 .sp
1083 For a Samba host this means that the printer must be physically added to the underlying printing system\&. The
1084 \fIaddprinter command\fR
1085 defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the
1086 smb\&.conf
1087 file in order that it can be shared by
1088 \fBsmbd\fR(8)\&.
1089 .sp
1090 The
1091 \fIaddprinter command\fR
1092 is automatically invoked with the following parameter (in order):
1093 .RS
1094 .sp
1095 .RS 4
1096 .ie n \{\
1097 \h'-04'\(bu\h'+03'\c
1098 .\}
1099 .el \{\
1100 .sp -1
1101 .IP \(bu 2.3
1102 .\}
1103 \fIprinter name\fR
1104 .RE
1105 .sp
1106 .RS 4
1107 .ie n \{\
1108 \h'-04'\(bu\h'+03'\c
1109 .\}
1110 .el \{\
1111 .sp -1
1112 .IP \(bu 2.3
1113 .\}
1114 \fIshare name\fR
1115 .RE
1116 .sp
1117 .RS 4
1118 .ie n \{\
1119 \h'-04'\(bu\h'+03'\c
1120 .\}
1121 .el \{\
1122 .sp -1
1123 .IP \(bu 2.3
1124 .\}
1125 \fIport name\fR
1126 .RE
1127 .sp
1128 .RS 4
1129 .ie n \{\
1130 \h'-04'\(bu\h'+03'\c
1131 .\}
1132 .el \{\
1133 .sp -1
1134 .IP \(bu 2.3
1135 .\}
1136 \fIdriver name\fR
1137 .RE
1138 .sp
1139 .RS 4
1140 .ie n \{\
1141 \h'-04'\(bu\h'+03'\c
1142 .\}
1143 .el \{\
1144 .sp -1
1145 .IP \(bu 2.3
1146 .\}
1147 \fIlocation\fR
1148 .RE
1149 .sp
1150 .RS 4
1151 .ie n \{\
1152 \h'-04'\(bu\h'+03'\c
1153 .\}
1154 .el \{\
1155 .sp -1
1156 .IP \(bu 2.3
1157 .\}
1158 \fIWindows 9x driver location\fR
1159 .RE
1160 .sp
1161 .RE
1162 All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception\&. The "Windows 9x driver location" parameter is included for backwards compatibility only\&. The remaining fields in the structure are generated from answers to the APW questions\&.
1163 .sp
1164 Once the
1165 \fIaddprinter command\fR
1166 has been executed,
1167 smbd
1168 will reparse the
1169 smb\&.conf
1170 to determine if the share defined by the APW exists\&. If the sharename is still invalid, then
1171 smbd
1172 will return an ACCESS_DENIED error to the client\&.
1173 .sp
1174 The
1175 \fIaddprinter command\fR
1176 program can output a single line of text, which Samba will set as the port the new printer is connected to\&. If this line isn\*(Aqt output, Samba won\*(Aqt reload its printer shares\&.
1177 .sp
1178 Default:
1179 \fI\fIaddprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
1180 .sp
1181 Example:
1182 \fI\fIaddprinter command\fR\fR\fI = \fR\fI/usr/bin/addprinter\fR\fI \fR
1183 .RE
1184
1185 add share command (G)
1186 .PP
1187 .RS 4
1188 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1189 \fIadd share command\fR
1190 is used to define an external program or script which will add a new service definition to
1191 smb\&.conf\&.
1192 .sp
1193 In order to successfully execute the
1194 \fIadd share command\fR,
1195 smbd
1196 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1197 SeDiskOperatorPrivilege\&. Scripts defined in the
1198 \fIadd share command\fR
1199 parameter are executed as root\&.
1200 .sp
1201 When executed,
1202 smbd
1203 will automatically invoke the
1204 \fIadd share command\fR
1205 with five parameters\&.
1206 .RS
1207 .sp
1208 .RS 4
1209 .ie n \{\
1210 \h'-04'\(bu\h'+03'\c
1211 .\}
1212 .el \{\
1213 .sp -1
1214 .IP \(bu 2.3
1215 .\}
1216 \fIconfigFile\fR
1217 \- the location of the global
1218 smb\&.conf
1219 file\&.
1220 .RE
1221 .sp
1222 .RS 4
1223 .ie n \{\
1224 \h'-04'\(bu\h'+03'\c
1225 .\}
1226 .el \{\
1227 .sp -1
1228 .IP \(bu 2.3
1229 .\}
1230 \fIshareName\fR
1231 \- the name of the new share\&.
1232 .RE
1233 .sp
1234 .RS 4
1235 .ie n \{\
1236 \h'-04'\(bu\h'+03'\c
1237 .\}
1238 .el \{\
1239 .sp -1
1240 .IP \(bu 2.3
1241 .\}
1242 \fIpathName\fR
1243 \- path to an **existing** directory on disk\&.
1244 .RE
1245 .sp
1246 .RS 4
1247 .ie n \{\
1248 \h'-04'\(bu\h'+03'\c
1249 .\}
1250 .el \{\
1251 .sp -1
1252 .IP \(bu 2.3
1253 .\}
1254 \fIcomment\fR
1255 \- comment string to associate with the new share\&.
1256 .RE
1257 .sp
1258 .RS 4
1259 .ie n \{\
1260 \h'-04'\(bu\h'+03'\c
1261 .\}
1262 .el \{\
1263 .sp -1
1264 .IP \(bu 2.3
1265 .\}
1266 \fImax connections\fR
1267 Number of maximum simultaneous connections to this share\&.
1268 .RE
1269 .sp
1270 .RE
1271 This parameter is only used to add file shares\&. To add printer shares, see the
1272 \m[blue]\fBaddprinter command\fR\m[]\&.
1273 .sp
1274 Default:
1275 \fI\fIadd share command\fR\fR\fI = \fR\fI\fR\fI \fR
1276 .sp
1277 Example:
1278 \fI\fIadd share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR
1279 .RE
1280
1281 add user script (G)
1282 .PP
1283 .RS 4
1284 This is the full pathname to a script that will be run
1285 \fIAS ROOT\fR
1286 by
1287 \fBsmbd\fR(8)
1288 under special circumstances described below\&.
1289 .sp
1290 Normally, a Samba server requires that UNIX users are created for all users accessing files on this server\&. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task\&. This option allows smbd to create the required UNIX users
1291 \fION DEMAND\fR
1292 when a user accesses the Samba server\&.
1293 .sp
1294 When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,
1295 \fBsmbd\fR(8)
1296 contacts the
1297 \m[blue]\fBpassword server\fR\m[]
1298 and attempts to authenticate the given user with the given password\&. If the authentication succeeds then
1299 smbd
1300 attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and
1301 \m[blue]\fBadd user script\fR\m[]
1302 is set then
1303 smbd
1304 will call the specified script
1305 \fIAS ROOT\fR, expanding any
1306 \fI%u\fR
1307 argument to be the user name to create\&.
1308 .sp
1309 If this script successfully creates the user then
1310 smbd
1311 will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.
1312 .sp
1313 See also
1314 \m[blue]\fBsecurity\fR\m[],
1315 \m[blue]\fBpassword server\fR\m[],
1316 \m[blue]\fBdelete user script\fR\m[]\&.
1317 .sp
1318 Default:
1319 \fI\fIadd user script\fR\fR\fI = \fR\fI\fR\fI \fR
1320 .sp
1321 Example:
1322 \fI\fIadd user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/add_user %u\fR\fI \fR
1323 .RE
1324
1325 add user to group script (G)
1326 .PP
1327 .RS 4
1328 Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools\&. It will be run by
1329 \fBsmbd\fR(8)
1330 \fIAS ROOT\fR\&. Any
1331 \fI%g\fR
1332 will be replaced with the group name and any
1333 \fI%u\fR
1334 will be replaced with the user name\&.
1335 .sp
1336 Note that the
1337 adduser
1338 command used in the example below does not support the used syntax on all systems\&.
1339 .sp
1340 Default:
1341 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\fR\fI \fR
1342 .sp
1343 Example:
1344 \fI\fIadd user to group script\fR\fR\fI = \fR\fI/usr/sbin/adduser %u %g\fR\fI \fR
1345 .RE
1346
1347 administrative share (S)
1348 .PP
1349 .RS 4
1350 If this parameter is set to
1351 \fByes\fR
1352 for a share, then the share will be an administrative share\&. The Administrative Shares are the default network shares created by all Windows NT\-based operating systems\&. These are shares like C$, D$ or ADMIN$\&. The type of these shares is STYPE_DISKTREE_HIDDEN\&.
1353 .sp
1354 See the section below on
1355 \m[blue]\fBsecurity\fR\m[]
1356 for more information about this option\&.
1357 .sp
1358 Default:
1359 \fI\fIadministrative share\fR\fR\fI = \fR\fIno\fR\fI \fR
1360 .RE
1361
1362 admin users (S)
1363 .PP
1364 .RS 4
1365 This is a list of users who will be granted administrative privileges on the share\&. This means that they will do all file operations as the super\-user (root)\&.
1366 .sp
1367 You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions\&.
1368 .sp
1369 Default:
1370 \fI\fIadmin users\fR\fR\fI = \fR\fI\fR\fI \fR
1371 .sp
1372 Example:
1373 \fI\fIadmin users\fR\fR\fI = \fR\fIjason\fR\fI \fR
1374 .RE
1375
1376 afs share (S)
1377 .PP
1378 .RS 4
1379 This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the
1380 \fIpath\fR
1381 parameter is a local AFS import\&. The special AFS features include the attempt to hand\-craft an AFS token if you enabled \-\-with\-fake\-kaserver in configure\&.
1382 .sp
1383 Default:
1384 \fI\fIafs share\fR\fR\fI = \fR\fIno\fR\fI \fR
1385 .RE
1386
1387 afs token lifetime (G)
1388 .PP
1389 .RS 4
1390 This parameter controls the lifetime of tokens that the AFS fake\-kaserver claims\&. In reality these never expire but this lifetime controls when the afs client will forget the token\&.
1391 .sp
1392 Set this parameter to 0 to get
1393 \fBNEVERDATE\fR\&.
1394 .sp
1395 Default:
1396 \fI\fIafs token lifetime\fR\fR\fI = \fR\fI604800\fR\fI \fR
1397 .RE
1398
1399 afs username map (G)
1400 .PP
1401 .RS 4
1402 If you are using the fake kaserver AFS feature, you might want to hand\-craft the usernames you are creating tokens for\&. For example this is necessary if you have users from several domain in your AFS Protection Database\&. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator\&.
1403 .sp
1404 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.
1405 .sp
1406 Default:
1407 \fI\fIafs username map\fR\fR\fI = \fR\fI\fR\fI \fR
1408 .sp
1409 Example:
1410 \fI\fIafs username map\fR\fR\fI = \fR\fI%u@afs\&.samba\&.org\fR\fI \fR
1411 .RE
1412
1413 aio max threads (G)
1414 .PP
1415 .RS 4
1416 The integer parameter specifies the maximum number of threads each smbd process will create when doing parallel asynchronous IO calls\&. If the number of outstanding calls is greater than this number the requests will not be refused but go onto a queue and will be scheduled in turn as outstanding requests complete\&.
1417 .sp
1418 Related command:
1419 \m[blue]\fBaio read size\fR\m[]
1420 .sp
1421 Related command:
1422 \m[blue]\fBaio write size\fR\m[]
1423 .sp
1424 Default:
1425 \fI\fIaio max threads\fR\fR\fI = \fR\fI100\fR\fI \fR
1426 .RE
1427
1428 aio read size (S)
1429 .PP
1430 .RS 4
1431 If this integer parameter is set to a non\-zero value, Samba will read from files asynchronously when the request size is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining reads\&.
1432 .sp
1433 The only reasonable values for this parameter are 0 (no async I/O) and 1 (always do async I/O)\&.
1434 .sp
1435 Related command:
1436 \m[blue]\fBaio write size\fR\m[]
1437 .sp
1438 Default:
1439 \fI\fIaio read size\fR\fR\fI = \fR\fI1\fR\fI \fR
1440 .sp
1441 Example:
1442 \fI\fIaio read size\fR\fR\fI = \fR\fI0 # Always do reads synchronously \fR\fI \fR
1443 .RE
1444
1445 aio write behind (S)
1446 .PP
1447 .RS 4
1448 If Samba has been built with asynchronous I/O support, Samba will not wait until write requests are finished before returning the result to the client for files listed in this parameter\&. Instead, Samba will immediately return that the write request has been finished successfully, no matter if the operation will succeed or not\&. This might speed up clients without aio support, but is really dangerous, because data could be lost and files could be damaged\&.
1449 .sp
1450 The syntax is identical to the
1451 \m[blue]\fBveto files\fR\m[]
1452 parameter\&.
1453 .sp
1454 Default:
1455 \fI\fIaio write behind\fR\fR\fI = \fR\fI\fR\fI \fR
1456 .sp
1457 Example:
1458 \fI\fIaio write behind\fR\fR\fI = \fR\fI/*\&.tmp/\fR\fI \fR
1459 .RE
1460
1461 aio write size (S)
1462 .PP
1463 .RS 4
1464 If this integer parameter is set to a non\-zero value, Samba will write to files asynchronously when the request size is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining writes\&.
1465 .sp
1466 The only reasonable values for this parameter are 0 (no async I/O) and 1 (always do async I/O)\&.
1467 .sp
1468 Compared to
1469 \m[blue]\fBaio read size\fR\m[]
1470 this parameter has a smaller effect, most writes should end up in the file system cache\&. Writes that require space allocation might benefit most from going asynchronous\&.
1471 .sp
1472 Related command:
1473 \m[blue]\fBaio read size\fR\m[]
1474 .sp
1475 Default:
1476 \fI\fIaio write size\fR\fR\fI = \fR\fI1\fR\fI \fR
1477 .sp
1478 Example:
1479 \fI\fIaio write size\fR\fR\fI = \fR\fI0 # Always do writes synchronously \fR\fI \fR
1480 .RE
1481
1482 algorithmic rid base (G)
1483 .PP
1484 .RS 4
1485 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.
1486 .sp
1487 Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with system users etc\&.
1488 .sp
1489 All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server\&. As such the algorithmic mapping can\*(Aqt be \*(Aqturned off\*(Aq, but pushing it \*(Aqout of the way\*(Aq should resolve the issues\&. Users and groups can then be assigned \*(Aqlow\*(Aq RIDs in arbitrary\-rid supporting backends\&.
1490 .sp
1491 Default:
1492 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI1000\fR\fI \fR
1493 .sp
1494 Example:
1495 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI100000\fR\fI \fR
1496 .RE
1497
1498 allocation roundup size (S)
1499 .PP
1500 .RS 4
1501 This parameter allows an administrator to tune the allocation size reported to Windows clients\&. This is only useful for old SMB1 clients because modern SMB dialects eliminated that bottleneck and have better performance by default\&. Using this parameter may cause difficulties for some applications, e\&.g\&. MS Visual Studio\&. If the MS Visual Studio compiler starts to crash with an internal error, set this parameter to zero for this share\&. Settings this parameter to a large value can also cause small files to allocate more space on the disk than needed\&.
1502 .sp
1503 This parameter is deprecated and will be removed in one of the next Samba releases\&.
1504 .sp
1505 The integer parameter specifies the roundup size in bytes\&.
1506 .sp
1507 Default:
1508 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI0\fR\fI \fR
1509 .sp
1510 Example:
1511 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI1048576 # (to set it to the former default of 1 MiB)\fR\fI \fR
1512 .RE
1513
1514 allow dcerpc auth level connect (G)
1515 .PP
1516 .RS 4
1517 This option controls whether DCERPC services are allowed to be used with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but no per message integrity nor privacy protection\&.
1518 .sp
1519 Some interfaces like samr, lsarpc and netlogon have a hard\-coded default of
1520 \fBno\fR
1521 and epmapper, mgmt and rpcecho have a hard\-coded default of
1522 \fByes\fR\&.
1523 .sp
1524 The behavior can be overwritten per interface name (e\&.g\&. lsarpc, netlogon, samr, srvsvc, winreg, wkssvc \&.\&.\&.) by using \*(Aqallow dcerpc auth level connect:interface = yes\*(Aq as option\&.
1525 .sp
1526 This option is over\-ridden by the implementation specific restrictions\&. E\&.g\&. the drsuapi and backupkey protocols require DCERPC_AUTH_LEVEL_PRIVACY\&. The dnsserver protocol requires DCERPC_AUTH_LEVEL_INTEGRITY\&.
1527 .sp
1528 Default:
1529 \fI\fIallow dcerpc auth level connect\fR\fR\fI = \fR\fIno\fR\fI \fR
1530 .sp
1531 Example:
1532 \fI\fIallow dcerpc auth level connect\fR\fR\fI = \fR\fIyes\fR\fI \fR
1533 .RE
1534
1535 allow dns updates (G)
1536 .PP
1537 .RS 4
1538 This option determines what kind of updates to the DNS are allowed\&.
1539 .sp
1540 DNS updates can either be disallowed completely by setting it to
1541 \fBdisabled\fR, enabled over secure connections only by setting it to
1542 \fBsecure only\fR
1543 or allowed in all cases by setting it to
1544 \fBnonsecure\fR\&.
1545 .sp
1546 Default:
1547 \fI\fIallow dns updates\fR\fR\fI = \fR\fIsecure only\fR\fI \fR
1548 .sp
1549 Example:
1550 \fI\fIallow dns updates\fR\fR\fI = \fR\fIdisabled\fR\fI \fR
1551 .RE
1552
1553 allow insecure wide links (G)
1554 .PP
1555 .RS 4
1556 In normal operation the option
1557 \m[blue]\fBwide links\fR\m[]
1558 which allows the server to follow symlinks outside of a share path is automatically disabled when
1559 \m[blue]\fBunix extensions\fR\m[]
1560 are enabled on a Samba server\&. This is done for security purposes to prevent UNIX clients creating symlinks to areas of the server file system that the administrator does not wish to export\&.
1561 .sp
1562 Setting
1563 \m[blue]\fBallow insecure wide links\fR\m[]
1564 to true disables the link between these two parameters, removing this protection and allowing a site to configure the server to follow symlinks (by setting
1565 \m[blue]\fBwide links\fR\m[]
1566 to "true") even when
1567 \m[blue]\fBunix extensions\fR\m[]
1568 is turned on\&.
1569 .sp
1570 It is not recommended to enable this option unless you fully understand the implications of allowing the server to follow symbolic links created by UNIX clients\&. For most normal Samba configurations this would be considered a security hole and setting this parameter is not recommended\&.
1571 .sp
1572 This option was added at the request of sites who had deliberately set Samba up in this way and needed to continue supporting this functionality without having to patch the Samba code\&.
1573 .sp
1574 Default:
1575 \fI\fIallow insecure wide links\fR\fR\fI = \fR\fIno\fR\fI \fR
1576 .RE
1577
1578 allow nt4 crypto (G)
1579 .PP
1580 .RS 4
1581 This option is deprecated and will be removed in future, as it is a security problem if not set to "no" (which will be the hardcoded behavior in future)\&.
1582 .sp
1583 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will reject clients which do not support NETLOGON_NEG_STRONG_KEYS nor NETLOGON_NEG_SUPPORTS_AES\&.
1584 .sp
1585 This option was added with Samba 4\&.2\&.0\&. It may lock out clients which worked fine with Samba versions up to 4\&.1\&.x\&. as the effective default was "yes" there, while it is "no" now\&.
1586 .sp
1587 If you have clients without RequireStrongKey = 1 in the registry, you may need to set "allow nt4 crypto = yes", until you have fixed all clients\&.
1588 .sp
1589 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe via downgrade attacks\&.
1590 .sp
1591 \fIAvoid using this option!\fR
1592 Use explicit \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq instead! Which is available with the patches for
1593 CVE\-2022\-38023
1594 see
1595 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240
1596 .sp
1597 Samba will log an error in the log files at log level 0 if legacy a client is rejected or allowed without an explicit, \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq line to be added, if the legacy client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:error_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
1598 .sp
1599 This allows admins to use "yes" only for a short grace period, in order to collect the explicit \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq options\&.
1600 .sp
1601 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq, \*(Aq\m[blue]\fBreject md5 clients\fR\m[]\*(Aq, \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT\fR\m[]\*(Aq, and/or \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq options\&.
1602 .sp
1603 Default:
1604 \fI\fIallow nt4 crypto\fR\fR\fI = \fR\fIno\fR\fI \fR
1605 .RE
1606
1607 allow nt4 crypto:COMPUTERACCOUNT (G)
1608 .PP
1609 .RS 4
1610 If you still have legacy domain members which required \*(Aqallow nt4 crypto = yes\*(Aq, it is possible to specify an explicit exception per computer account by using \*(Aqallow nt4 crypto:COMPUTERACCOUNT = yes\*(Aq as option\&. Note that COMPUTERACCOUNT has to be the sAMAccountName value of the computer account (including the trailing \*(Aq$\*(Aq sign)\&.
1611 .sp
1612 Samba will log a complaint in the log files at log level 0 about the security problem if the option is set to "yes", but the related computer does not require it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:warn_about_unused_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
1613 .sp
1614 Samba will log a warning in the log files at log level 5, if a setting is still needed for the specified computer account\&.
1615 .sp
1616 See
1617 CVE\-2022\-38023,
1618 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
1619 .sp
1620 This option overrides the
1621 \m[blue]\fBallow nt4 crypto\fR\m[]
1622 option\&.
1623 .sp
1624 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq, \*(Aq\m[blue]\fBreject md5 clients\fR\m[]\*(Aq, \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and/or \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq options\&.
1625 .sp
1626 Which means \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq is only useful in combination with \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq and \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
1627 .sp
1628 .if n \{\
1629 .RS 4
1630 .\}
1631 .nf
1632 allow nt4 crypto:LEGACYCOMPUTER1$ = yes
1633 server reject md5 schannel:LEGACYCOMPUTER1$ = no
1634 server reject aes schannel:LEGACYCOMPUTER1$ = no
1635 allow nt4 crypto:NASBOX$ = yes
1636 server reject md5 schannel:NASBOX$ = no
1637 server reject aes schannel:NASBOX$ = no
1638 allow nt4 crypto:LEGACYCOMPUTER2$ = yes
1639 server reject md5 schannel:LEGACYCOMPUTER2$ = no
1640 server reject aes schannel:LEGACYCOMPUTER2$ = no
1641
1642 .fi
1643 .if n \{\
1644 .RE
1645 .\}
1646 .sp
1647 \fINo default\fR
1648 .RE
1649
1650 allow trusted domains (G)
1651 .PP
1652 .RS 4
1653 This option only takes effect when the
1654 \m[blue]\fBsecurity\fR\m[]
1655 option is set to
1656 \fBserver\fR,
1657 \fBdomain\fR
1658 or
1659 \fBads\fR\&. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication\&.
1660 .sp
1661 This is useful if you only want your Samba server to serve resources to users in the domain it is a member of\&. As an example, suppose that there are two domains DOMA and DOMB\&. DOMB is trusted by DOMA, which contains the Samba server\&. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA\&. This can make implementing a security boundary difficult\&.
1662 .sp
1663 Default:
1664 \fI\fIallow trusted domains\fR\fR\fI = \fR\fIyes\fR\fI \fR
1665 .RE
1666
1667 allow unsafe cluster upgrade (G)
1668 .PP
1669 .RS 4
1670 If set to no (the default), smbd checks at startup if other smbd versions are running in the cluster and refuses to start if so\&. This is done to protect data corruption in internal data structures due to incompatible Samba versions running concurrently in the same cluster\&. Setting this parameter to
1671 yes
1672 disables this safety check\&.
1673 .sp
1674 Default:
1675 \fI\fIallow unsafe cluster upgrade\fR\fR\fI = \fR\fIno\fR\fI \fR
1676 .RE
1677
1678 apply group policies (G)
1679 .PP
1680 .RS 4
1681 This option controls whether winbind will execute the gpupdate command defined in
1682 \m[blue]\fBgpo update command\fR\m[]
1683 on the Group Policy update interval\&. The Group Policy update interval is defined as every 90 minutes, plus a random offset between 0 and 30 minutes\&. This applies Group Policy Machine polices to the client or KDC and machine policies to a server\&.
1684 .sp
1685 Default:
1686 \fI\fIapply group policies\fR\fR\fI = \fR\fIno\fR\fI \fR
1687 .sp
1688 Example:
1689 \fI\fIapply group policies\fR\fR\fI = \fR\fIyes\fR\fI \fR
1690 .RE
1691
1692 async dns timeout (G)
1693 .PP
1694 .RS 4
1695 The number of seconds the asynchronous DNS resolver code in Samba will wait for responses\&. Some of the Samba client library code uses internal asynchronous DNS resolution for A and AAAA records when trying to find Active Directory Domain controllers\&. This value prevents this name resolution code from waiting for DNS server timeouts\&.
1696 .sp
1697 The minimum value of this parameter is clamped at 1 second\&.
1698 .sp
1699 Default:
1700 \fI\fIasync dns timeout\fR\fR\fI = \fR\fI10\fR\fI \fR
1701 .sp
1702 Example:
1703 \fI\fIasync dns timeout\fR\fR\fI = \fR\fI20\fR\fI \fR
1704 .RE
1705
1706 async smb echo handler (G)
1707 .PP
1708 .RS 4
1709 This parameter specifies whether Samba should fork the async smb echo handler\&. It can be beneficial if your file system can block syscalls for a very long time\&. In some circumstances, it prolongs the timeout that Windows uses to determine whether a connection is dead\&. This parameter is only for SMB1\&. For SMB2 and above TCP keepalives can be used instead\&.
1710 .sp
1711 Default:
1712 \fI\fIasync smb echo handler\fR\fR\fI = \fR\fIno\fR\fI \fR
1713 .RE
1714
1715 auth event notification (G)
1716 .PP
1717 .RS 4
1718 When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream authentication events across the internal message bus\&. Scripts built using Samba\*(Aqs python bindings can listen to these events by registering as the service
1719 auth_event\&.
1720 .sp
1721 This is
1722 \fInot\fR
1723 needed for the audit logging described in
1724 \m[blue]\fBlog level\fR\m[]\&.
1725 .sp
1726 Instead, this should instead be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around)\&.
1727 .sp
1728 The authentication events are also logged via the normal logging methods when the
1729 \m[blue]\fBlog level\fR\m[]
1730 is set appropriately, say to
1731 auth_json_audit:3\&.
1732 .sp
1733 Default:
1734 \fI\fIauth event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
1735 .RE
1736
1737 preload
1738 .PP
1739 .RS 4
1740 This parameter is a synonym for
1741 auto services\&.
1742 .RE
1743
1744 auto services (G)
1745 .PP
1746 .RS 4
1747 This is a list of services that you want to be automatically added to the browse lists\&. This is most useful for homes and printers services that would otherwise not be visible\&.
1748 .sp
1749 Note that if you just want all printers in your printcap file loaded then the
1750 \m[blue]\fBload printers\fR\m[]
1751 option is easier\&.
1752 .sp
1753 Default:
1754 \fI\fIauto services\fR\fR\fI = \fR\fI\fR\fI \fR
1755 .sp
1756 Example:
1757 \fI\fIauto services\fR\fR\fI = \fR\fIfred lp colorlp\fR\fI \fR
1758 .RE
1759
1760 available (S)
1761 .PP
1762 .RS 4
1763 This parameter lets you "turn off" a service\&. If
1764 \fIavailable = no\fR, then
1765 \fIALL\fR
1766 attempts to connect to the service will fail\&. Such failures are logged\&.
1767 .sp
1768 Default:
1769 \fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR
1770 .RE
1771
1772 bind dns directory
1773 .PP
1774 .RS 4
1775 This parameter is a synonym for
1776 binddns dir\&.
1777 .RE
1778
1779 binddns dir (G)
1780 .PP
1781 .RS 4
1782 This parameters defines the directory samba will use to store the configuration files for bind, such as named\&.conf\&. NOTE: The bind dns directory needs to be on the same mount point as the private directory!
1783 .sp
1784 Default:
1785 \fI\fIbinddns dir\fR\fR\fI = \fR\fI/var/lib/samba/bind\-dns\fR\fI \fR
1786 .RE
1787
1788 bind interfaces only (G)
1789 .PP
1790 .RS 4
1791 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
1792 \fBsmbd\fR(8)
1793 and name service
1794 \fBnmbd\fR(8)
1795 in a slightly different ways\&.
1796 .sp
1797 For name service it causes
1798 nmbd
1799 to bind to ports 137 and 138 on the interfaces listed in the
1800 \m[blue]\fBinterfaces\fR\m[]
1801 parameter\&.
1802 nmbd
1803 also binds to the "all addresses" interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes of reading broadcast messages\&. If this option is not set then
1804 nmbd
1805 will service name requests on all of these sockets\&. If
1806 \m[blue]\fBbind interfaces only\fR\m[]
1807 is set then
1808 nmbd
1809 will check the source address of any packets coming in on the broadcast sockets and discard any that don\*(Aqt match the broadcast addresses of the interfaces in the
1810 \m[blue]\fBinterfaces\fR\m[]
1811 parameter list\&. As unicast packets are received on the other sockets it allows
1812 nmbd
1813 to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
1814 \m[blue]\fBinterfaces\fR\m[]
1815 list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
1816 nmbd\&.
1817 .sp
1818 For file service it causes
1819 \fBsmbd\fR(8)
1820 to bind only to the interface list given in the
1821 \m[blue]\fBinterfaces\fR\m[]
1822 parameter\&. This restricts the networks that
1823 smbd
1824 will serve, to packets coming in on those interfaces\&. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\&.
1825 .sp
1826 If
1827 \m[blue]\fBbind interfaces only\fR\m[]
1828 is set and the network address
1829 \fI127\&.0\&.0\&.1\fR
1830 is not added to the
1831 \m[blue]\fBinterfaces\fR\m[]
1832 parameter list
1833 \fBsmbpasswd\fR(8)
1834 may not work as expected due to the reasons covered below\&.
1835 .sp
1836 To change a users SMB password, the
1837 smbpasswd
1838 by default connects to the
1839 \fIlocalhost \- 127\&.0\&.0\&.1\fR
1840 address as an SMB client to issue the password change request\&. If
1841 \m[blue]\fBbind interfaces only\fR\m[]
1842 is set then unless the network address
1843 \fI127\&.0\&.0\&.1\fR
1844 is added to the
1845 \m[blue]\fBinterfaces\fR\m[]
1846 parameter list then
1847 smbpasswd
1848 will fail to connect in it\*(Aqs default mode\&.
1849 smbpasswd
1850 can be forced to use the primary IP interface of the local host by using its
1851 \fBsmbpasswd\fR(8)
1852 \fI\-r \fR\fI\fIremote machine\fR\fR
1853 parameter, with
1854 \fIremote machine\fR
1855 set to the IP name of the primary interface of the local host\&.
1856 .sp
1857 Default:
1858 \fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR
1859 .RE
1860
1861 blocking locks (S)
1862 .PP
1863 .RS 4
1864 This parameter controls the behavior of
1865 \fBsmbd\fR(8)
1866 when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it\&.
1867 .sp
1868 If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires\&.
1869 .sp
1870 If this parameter is set to
1871 \fBno\fR, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained\&.
1872 .sp
1873 Default:
1874 \fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR
1875 .RE
1876
1877 block size (S)
1878 .PP
1879 .RS 4
1880 This parameter controls the behavior of
1881 \fBsmbd\fR(8)
1882 when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
1883 .sp
1884 Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed\&. This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re\-compiling the code\&. As this is an experimental option it may be removed in a future release\&.
1885 .sp
1886 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
1887 .sp
1888 Default:
1889 \fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR
1890 .sp
1891 Example:
1892 \fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR
1893 .RE
1894
1895 browsable
1896 .PP
1897 .RS 4
1898 This parameter is a synonym for
1899 browseable\&.
1900 .RE
1901
1902 browseable (S)
1903 .PP
1904 .RS 4
1905 This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
1906 .sp
1907 Default:
1908 \fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR
1909 .RE
1910
1911 browse list (G)
1912 .PP
1913 .RS 4
1914 This controls whether
1915 \fBsmbd\fR(8)
1916 will serve a browse list to a client doing a
1917 NetServerEnum
1918 call\&. Normally set to
1919 \fByes\fR\&. You should never need to change this\&.
1920 .sp
1921 Default:
1922 \fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR
1923 .RE
1924
1925 cache directory (G)
1926 .PP
1927 .RS 4
1928 Usually, most of the TDB files are stored in the
1929 \fIlock directory\fR\&. Since Samba 3\&.4\&.0, it is possible to differentiate between TDB files with persistent data and TDB files with non\-persistent data using the
1930 \fIstate directory\fR
1931 and the
1932 \fIcache directory\fR
1933 options\&.
1934 .sp
1935 This option specifies the directory for storing TDB files containing non\-persistent data that will be kept across service restarts\&. The directory should be placed on persistent storage, but the data can be safely deleted by an administrator\&.
1936 .sp
1937 Default:
1938 \fI\fIcache directory\fR\fR\fI = \fR\fI/var/lib/samba\fR\fI \fR
1939 .sp
1940 Example:
1941 \fI\fIcache directory\fR\fR\fI = \fR\fI/var/run/samba/locks/cache\fR\fI \fR
1942 .RE
1943
1944 casesignames
1945 .PP
1946 .RS 4
1947 This parameter is a synonym for
1948 case sensitive\&.
1949 .RE
1950
1951 case sensitive (S)
1952 .PP
1953 .RS 4
1954 See the discussion in the section
1955 name mangling\&.
1956 .sp
1957 Default:
1958 \fI\fIcase sensitive\fR\fR\fI = \fR\fIauto\fR\fI \fR
1959 .RE
1960
1961 change notify (G)
1962 .PP
1963 .RS 4
1964 This parameter specifies whether Samba should reply to a client\*(Aqs file change notify requests\&.
1965 .sp
1966 You should never need to change this parameter
1967 .sp
1968 Default:
1969 \fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
1970 .RE
1971
1972 change share command (G)
1973 .PP
1974 .RS 4
1975 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1976 \fIchange share command\fR
1977 is used to define an external program or script which will modify an existing service definition in
1978 smb\&.conf\&.
1979 .sp
1980 In order to successfully execute the
1981 \fIchange share command\fR,
1982 smbd
1983 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1984 SeDiskOperatorPrivilege\&. Scripts defined in the
1985 \fIchange share command\fR
1986 parameter are executed as root\&.
1987 .sp
1988 When executed,
1989 smbd
1990 will automatically invoke the
1991 \fIchange share command\fR
1992 with six parameters\&.
1993 .RS
1994 .sp
1995 .RS 4
1996 .ie n \{\
1997 \h'-04'\(bu\h'+03'\c
1998 .\}
1999 .el \{\
2000 .sp -1
2001 .IP \(bu 2.3
2002 .\}
2003 \fIconfigFile\fR
2004 \- the location of the global
2005 smb\&.conf
2006 file\&.
2007 .RE
2008 .sp
2009 .RS 4
2010 .ie n \{\
2011 \h'-04'\(bu\h'+03'\c
2012 .\}
2013 .el \{\
2014 .sp -1
2015 .IP \(bu 2.3
2016 .\}
2017 \fIshareName\fR
2018 \- the name of the new share\&.
2019 .RE
2020 .sp
2021 .RS 4
2022 .ie n \{\
2023 \h'-04'\(bu\h'+03'\c
2024 .\}
2025 .el \{\
2026 .sp -1
2027 .IP \(bu 2.3
2028 .\}
2029 \fIpathName\fR
2030 \- path to an **existing** directory on disk\&.
2031 .RE
2032 .sp
2033 .RS 4
2034 .ie n \{\
2035 \h'-04'\(bu\h'+03'\c
2036 .\}
2037 .el \{\
2038 .sp -1
2039 .IP \(bu 2.3
2040 .\}
2041 \fIcomment\fR
2042 \- comment string to associate with the new share\&.
2043 .RE
2044 .sp
2045 .RS 4
2046 .ie n \{\
2047 \h'-04'\(bu\h'+03'\c
2048 .\}
2049 .el \{\
2050 .sp -1
2051 .IP \(bu 2.3
2052 .\}
2053 \fImax connections\fR
2054 Number of maximum simultaneous connections to this share\&.
2055 .RE
2056 .sp
2057 .RS 4
2058 .ie n \{\
2059 \h'-04'\(bu\h'+03'\c
2060 .\}
2061 .el \{\
2062 .sp -1
2063 .IP \(bu 2.3
2064 .\}
2065 \fICSC policy\fR
2066 \- client side caching policy in string form\&. Valid values are: manual, documents, programs, disable\&.
2067 .RE
2068 .sp
2069 .RE
2070 This parameter is only used to modify existing file share definitions\&. To modify printer shares, use the "Printers\&.\&.\&." folder as seen when browsing the Samba host\&.
2071 .sp
2072 Default:
2073 \fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR
2074 .sp
2075 Example:
2076 \fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/changeshare\fR\fI \fR
2077 .RE
2078
2079 check parent directory delete on close (S)
2080 .PP
2081 .RS 4
2082 A Windows SMB server prevents the client from creating files in a directory that has the delete\-on\-close flag set\&. By default Samba doesn\*(Aqt perform this check as this check is a quite expensive operation in Samba\&.
2083 .sp
2084 Default:
2085 \fI\fIcheck parent directory delete on close\fR\fR\fI = \fR\fIno\fR\fI \fR
2086 .RE
2087
2088 check password script (G)
2089 .PP
2090 .RS 4
2091 The name of a program that can be used to check password complexity\&. The password is sent to the program\*(Aqs standard input\&.
2092 .sp
2093 The program must return 0 on a good password, or any other value if the password is bad\&. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail\&.
2094 .sp
2095 In Samba AD, this script will be run
2096 \fIAS ROOT\fR
2097 by
2098 \fBsamba\fR(8)
2099 without any substitutions\&.
2100 .sp
2101 Note that starting with Samba 4\&.11 the following environment variables are exported to the script:
2102 .RS
2103 .sp
2104 .RS 4
2105 .ie n \{\
2106 \h'-04'\(bu\h'+03'\c
2107 .\}
2108 .el \{\
2109 .sp -1
2110 .IP \(bu 2.3
2111 .\}
2112 SAMBA_CPS_ACCOUNT_NAME is always present and contains the sAMAccountName of user, the is the same as the %u substitutions in the none AD DC case\&.
2113 .RE
2114 .sp
2115 .RS 4
2116 .ie n \{\
2117 \h'-04'\(bu\h'+03'\c
2118 .\}
2119 .el \{\
2120 .sp -1
2121 .IP \(bu 2.3
2122 .\}
2123 SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC case if the userPrincipalName is present\&.
2124 .RE
2125 .sp
2126 .RS 4
2127 .ie n \{\
2128 \h'-04'\(bu\h'+03'\c
2129 .\}
2130 .el \{\
2131 .sp -1
2132 .IP \(bu 2.3
2133 .\}
2134 SAMBA_CPS_FULL_NAME is optional if the displayName is present\&.
2135 .RE
2136 .sp
2137 .RE
2138 Note: In the example directory is a sample program called
2139 crackcheck
2140 that uses cracklib to check the password quality\&.
2141 .sp
2142 Default:
2143 \fI\fIcheck password script\fR\fR\fI = \fR\fI # Disabled\fR\fI \fR
2144 .sp
2145 Example:
2146 \fI\fIcheck password script\fR\fR\fI = \fR\fI/usr/local/sbin/crackcheck\fR\fI \fR
2147 .RE
2148
2149 client ipc max protocol (G)
2150 .PP
2151 .RS 4
2152 The value of the parameter (a string) is the highest protocol level that will be supported for IPC$ connections as DCERPC transport\&.
2153 .sp
2154 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2155 .sp
2156 The value
2157 \fBdefault\fR
2158 refers to the latest supported protocol, currently
2159 \fBSMB3_11\fR\&.
2160 .sp
2161 See
2162 \m[blue]\fBclient max protocol\fR\m[]
2163 for a full list of available protocols\&. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1\&.
2164 .sp
2165 Default:
2166 \fI\fIclient ipc max protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2167 .sp
2168 Example:
2169 \fI\fIclient ipc max protocol\fR\fR\fI = \fR\fISMB2_10\fR\fI \fR
2170 .RE
2171
2172 client ipc min protocol (G)
2173 .PP
2174 .RS 4
2175 This setting controls the minimum protocol version that the will be attempted to use for IPC$ connections as DCERPC transport\&.
2176 .sp
2177 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2178 .sp
2179 The value
2180 \fBdefault\fR
2181 refers to the higher value of
2182 \fBNT1\fR
2183 and the effective value of
2184 \m[blue]\fBclient min protocol\fR\m[]\&.
2185 .sp
2186 See
2187 \m[blue]\fBclient max protocol\fR\m[]
2188 for a full list of available protocols\&. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1\&.
2189 .sp
2190 Default:
2191 \fI\fIclient ipc min protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2192 .sp
2193 Example:
2194 \fI\fIclient ipc min protocol\fR\fR\fI = \fR\fISMB3_11\fR\fI \fR
2195 .RE
2196
2197 client ipc signing (G)
2198 .PP
2199 .RS 4
2200 This controls whether the client is allowed or required to use SMB signing for IPC$ connections as DCERPC transport\&. Possible values are
2201 \fIdesired\fR,
2202 \fIrequired\fR
2203 and
2204 \fIdisabled\fR\&.
2205 .sp
2206 When set to required or default, SMB signing is mandatory\&.
2207 .sp
2208 When set to desired, SMB signing is offered, but not enforced and if set to disabled, SMB signing is not offered either\&.
2209 .sp
2210 Connections from winbindd to Active Directory Domain Controllers always enforce signing\&.
2211 .sp
2212 Default:
2213 \fI\fIclient ipc signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2214 .RE
2215
2216 client lanman auth (G)
2217 .PP
2218 .RS 4
2219 This parameter has been deprecated since Samba 4\&.13 and support for LanMan (as distinct from NTLM, NTLMv2 or Kerberos) authentication as a client will be removed in a future Samba release\&.
2220 .sp
2221 That is, in the future, the current default of
2222 client NTLMv2 auth = yes
2223 will be the enforced behaviour\&.
2224 .sp
2225 This parameter determines whether or not
2226 \fBsmbclient\fR(8)
2227 and other samba client tools will attempt to authenticate itself to servers using the weaker LANMAN password hash\&. If disabled, only server which support NT password hashes (e\&.g\&. Windows NT/2000, Samba, etc\&.\&.\&. but not Windows 95/98) will be able to be connected from the Samba client\&.
2228 .sp
2229 The LANMAN encrypted response is easily broken, due to its case\-insensitive nature, and the choice of algorithm\&. Clients without Windows 95/98 servers are advised to disable this option\&.
2230 .sp
2231 Disabling this option will also disable the
2232 client plaintext auth
2233 option\&.
2234 .sp
2235 Likewise, if the
2236 client ntlmv2 auth
2237 parameter is enabled, then only NTLMv2 logins will be attempted\&.
2238 .sp
2239 Default:
2240 \fI\fIclient lanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
2241 .RE
2242
2243 client ldap sasl wrapping (G)
2244 .PP
2245 .RS 4
2246 The
2247 \m[blue]\fBclient ldap sasl wrapping\fR\m[]
2248 defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are
2249 \fIplain\fR,
2250 \fIsign\fR
2251 and
2252 \fIseal\fR\&.
2253 .sp
2254 The values
2255 \fIsign\fR
2256 and
2257 \fIseal\fR
2258 are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.
2259 .sp
2260 This option is needed firstly to secure the privacy of administrative connections from
2261 samba\-tool, including in particular new or reset passwords for users\&. For this reason the default is
2262 \fIseal\fR\&.
2263 .sp
2264 Additionally,
2265 winbindd
2266 and the
2267 net
2268 tool can use LDAP to communicate with Domain Controllers, so this option also controls the level of privacy for those connections\&. All supported AD DC versions will enforce the usage of at least signed LDAP connections by default, so a value of at least
2269 \fIsign\fR
2270 is required in practice\&.
2271 .sp
2272 The default value is
2273 \fIseal\fR\&. That implies synchronizing the time with the KDC in the case of using
2274 \fIKerberos\fR\&.
2275 .sp
2276 In order to force using LDAP (on port 389) with STARTTLS or LDAPS (on port 636), it is possible to use
2277 \fIstarttls\fR
2278 or
2279 \fIldaps\fR\&. In that case the NTLMSSP or Kerberos authentication using the TLS channel bindings in order to glue it to the connection\&.
2280 .sp
2281 Default:
2282 \fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fIseal\fR\fI \fR
2283 .RE
2284
2285 client max protocol (G)
2286 .PP
2287 .RS 4
2288 The value of the parameter (a string) is the highest protocol level that will be supported by the client\&.
2289 .sp
2290 Possible values are :
2291 .RS
2292 .sp
2293 .RS 4
2294 .ie n \{\
2295 \h'-04'\(bu\h'+03'\c
2296 .\}
2297 .el \{\
2298 .sp -1
2299 .IP \(bu 2.3
2300 .\}
2301 \fBCORE\fR: Earliest version\&. No concept of user names\&.
2302 .RE
2303 .sp
2304 .RS 4
2305 .ie n \{\
2306 \h'-04'\(bu\h'+03'\c
2307 .\}
2308 .el \{\
2309 .sp -1
2310 .IP \(bu 2.3
2311 .\}
2312 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
2313 .RE
2314 .sp
2315 .RS 4
2316 .ie n \{\
2317 \h'-04'\(bu\h'+03'\c
2318 .\}
2319 .el \{\
2320 .sp -1
2321 .IP \(bu 2.3
2322 .\}
2323 \fBLANMAN1\fR: First
2324 \fImodern\fR
2325 version of the protocol\&. Long filename support\&.
2326 .RE
2327 .sp
2328 .RS 4
2329 .ie n \{\
2330 \h'-04'\(bu\h'+03'\c
2331 .\}
2332 .el \{\
2333 .sp -1
2334 .IP \(bu 2.3
2335 .\}
2336 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
2337 .RE
2338 .sp
2339 .RS 4
2340 .ie n \{\
2341 \h'-04'\(bu\h'+03'\c
2342 .\}
2343 .el \{\
2344 .sp -1
2345 .IP \(bu 2.3
2346 .\}
2347 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
2348 .RE
2349 .sp
2350 .RS 4
2351 .ie n \{\
2352 \h'-04'\(bu\h'+03'\c
2353 .\}
2354 .el \{\
2355 .sp -1
2356 .IP \(bu 2.3
2357 .\}
2358 \fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and later versions of Windows\&. SMB2 has sub protocols available\&.
2359 .RS
2360 .sp
2361 .RS 4
2362 .ie n \{\
2363 \h'-04'\(bu\h'+03'\c
2364 .\}
2365 .el \{\
2366 .sp -1
2367 .IP \(bu 2.3
2368 .\}
2369 \fBSMB2_02\fR: The earliest SMB2 version\&.
2370 .RE
2371 .sp
2372 .RS 4
2373 .ie n \{\
2374 \h'-04'\(bu\h'+03'\c
2375 .\}
2376 .el \{\
2377 .sp -1
2378 .IP \(bu 2.3
2379 .\}
2380 \fBSMB2_10\fR: Windows 7 SMB2 version\&.
2381 .RE
2382 .sp
2383 .RE
2384 By default SMB2 selects the SMB2_10 variant\&.
2385 .RE
2386 .sp
2387 .RS 4
2388 .ie n \{\
2389 \h'-04'\(bu\h'+03'\c
2390 .\}
2391 .el \{\
2392 .sp -1
2393 .IP \(bu 2.3
2394 .\}
2395 \fBSMB3\fR: The same as SMB2\&. Used by Windows 8\&. SMB3 has sub protocols available\&.
2396 .RS
2397 .sp
2398 .RS 4
2399 .ie n \{\
2400 \h'-04'\(bu\h'+03'\c
2401 .\}
2402 .el \{\
2403 .sp -1
2404 .IP \(bu 2.3
2405 .\}
2406 \fBSMB3_00\fR: Windows 8 SMB3 version\&.
2407 .RE
2408 .sp
2409 .RS 4
2410 .ie n \{\
2411 \h'-04'\(bu\h'+03'\c
2412 .\}
2413 .el \{\
2414 .sp -1
2415 .IP \(bu 2.3
2416 .\}
2417 \fBSMB3_02\fR: Windows 8\&.1 SMB3 version\&.
2418 .RE
2419 .sp
2420 .RS 4
2421 .ie n \{\
2422 \h'-04'\(bu\h'+03'\c
2423 .\}
2424 .el \{\
2425 .sp -1
2426 .IP \(bu 2.3
2427 .\}
2428 \fBSMB3_11\fR: Windows 10 SMB3 version\&.
2429 .RE
2430 .sp
2431 .RE
2432 By default SMB3 selects the SMB3_11 variant\&.
2433 .RE
2434 .sp
2435 .RE
2436 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2437 .sp
2438 The value
2439 \fBdefault\fR
2440 refers to
2441 \fBSMB3_11\fR\&.
2442 .sp
2443 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2444 \m[blue]\fBclient ipc max protocol\fR\m[]
2445 option\&.
2446 .sp
2447 Default:
2448 \fI\fIclient max protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2449 .sp
2450 Example:
2451 \fI\fIclient max protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
2452 .RE
2453
2454 client min protocol (G)
2455 .PP
2456 .RS 4
2457 This setting controls the minimum protocol version that the client will attempt to use\&.
2458 .sp
2459 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol unless you connect to a legacy SMB1\-only server\&.
2460 .sp
2461 See
2462 Related command: \m[blue]\fBclient max protocol\fR\m[]
2463 for a full list of available protocols\&.
2464 .sp
2465 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2466 \m[blue]\fBclient ipc min protocol\fR\m[]
2467 option\&.
2468 .sp
2469 Note that most command line tools support \-\-option=\*(Aqclient min protocol=NT1\*(Aq, so it may not be required to enable SMB1 protocols globally in smb\&.conf\&.
2470 .sp
2471 Default:
2472 \fI\fIclient min protocol\fR\fR\fI = \fR\fISMB2_02\fR\fI \fR
2473 .sp
2474 Example:
2475 \fI\fIclient min protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
2476 .RE
2477
2478 client netlogon ping protocol (G)
2479 .PP
2480 .RS 4
2481 This option controls the protocol Samba uses to issue netlogon ping requests\&. This is normally done via connectionless ldap, but some installations require LDAPS over TCP port 636 for this\&.
2482 .sp
2483 Possible values are :
2484 .RS
2485 .sp
2486 .RS 4
2487 .ie n \{\
2488 \h'-04'\(bu\h'+03'\c
2489 .\}
2490 .el \{\
2491 .sp -1
2492 .IP \(bu 2.3
2493 .\}
2494 \fBCLDAP\fR
2495 .RE
2496 .sp
2497 .RS 4
2498 .ie n \{\
2499 \h'-04'\(bu\h'+03'\c
2500 .\}
2501 .el \{\
2502 .sp -1
2503 .IP \(bu 2.3
2504 .\}
2505 \fBLDAP\fR
2506 .RE
2507 .sp
2508 .RS 4
2509 .ie n \{\
2510 \h'-04'\(bu\h'+03'\c
2511 .\}
2512 .el \{\
2513 .sp -1
2514 .IP \(bu 2.3
2515 .\}
2516 \fBLDAPS\fR
2517 .RE
2518 .sp
2519 .RS 4
2520 .ie n \{\
2521 \h'-04'\(bu\h'+03'\c
2522 .\}
2523 .el \{\
2524 .sp -1
2525 .IP \(bu 2.3
2526 .\}
2527 \fBSTARTTLS\fR
2528 .RE
2529 .sp
2530 .RE
2531 Default:
2532 \fI\fIclient netlogon ping protocol\fR\fR\fI = \fR\fICLDAP\fR\fI \fR
2533 .RE
2534
2535 client NTLMv2 auth (G)
2536 .PP
2537 .RS 4
2538 This parameter has been deprecated since Samba 4\&.13 and support for NTLM and LanMan (as distinct from NTLMv2 or Kerberos authentication) will be removed in a future Samba release\&.
2539 .sp
2540 That is, in the future, the current default of
2541 client NTLMv2 auth = yes
2542 will be the enforced behaviour\&.
2543 .sp
2544 This parameter determines whether or not
2545 \fBsmbclient\fR(8)
2546 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
2547 .sp
2548 If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent\&. Older servers (including NT4 < SP4, Win9x and Samba 2\&.2) are not compatible with NTLMv2 when not in an NTLMv2 supporting domain
2549 .sp
2550 Similarly, if enabled, NTLMv1,
2551 client lanman auth
2552 and
2553 client plaintext auth
2554 authentication will be disabled\&. This also disables share\-level authentication\&.
2555 .sp
2556 If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
2557 client lanman auth\&.
2558 .sp
2559 Note that Windows Vista and later versions already use NTLMv2 by default, and some sites (particularly those following \*(Aqbest practice\*(Aq security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM\&.
2560 .sp
2561 When
2562 \m[blue]\fBclient use spnego\fR\m[]
2563 is also set to
2564 \fByes\fR
2565 extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP\&. This behavior was introduced with the patches for CVE\-2016\-2111\&.
2566 .sp
2567 Default:
2568 \fI\fIclient NTLMv2 auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
2569 .RE
2570
2571 client plaintext auth (G)
2572 .PP
2573 .RS 4
2574 This parameter has been deprecated since Samba 4\&.13 and support for plaintext (as distinct from NTLM, NTLMv2 or Kerberos authentication) will be removed in a future Samba release\&.
2575 .sp
2576 That is, in the future, the current default of
2577 client plaintext auth = no
2578 will be the enforced behaviour\&.
2579 .sp
2580 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
2581 .sp
2582 Default:
2583 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fIno\fR\fI \fR
2584 .RE
2585
2586 client protection (G)
2587 .PP
2588 .RS 4
2589 This parameter defines which protection Samba client tools should use by default\&.
2590 .sp
2591 Possible client settings are:
2592 .RS
2593 .sp
2594 .RS 4
2595 .ie n \{\
2596 \h'-04'\(bu\h'+03'\c
2597 .\}
2598 .el \{\
2599 .sp -1
2600 .IP \(bu 2.3
2601 .\}
2602 \fIdefault\fR
2603 \- Use the individual default values of the options:
2604 .RS
2605 .sp
2606 .RS 4
2607 .ie n \{\
2608 \h'-04'\(bu\h'+03'\c
2609 .\}
2610 .el \{\
2611 .sp -1
2612 .IP \(bu 2.3
2613 .\}
2614 \fIclient signing\fR
2615 .RE
2616 .sp
2617 .RS 4
2618 .ie n \{\
2619 \h'-04'\(bu\h'+03'\c
2620 .\}
2621 .el \{\
2622 .sp -1
2623 .IP \(bu 2.3
2624 .\}
2625 \fIclient smb encrypt\fR
2626 .RE
2627 .sp
2628 .RE
2629 .RE
2630 .sp
2631 .RS 4
2632 .ie n \{\
2633 \h'-04'\(bu\h'+03'\c
2634 .\}
2635 .el \{\
2636 .sp -1
2637 .IP \(bu 2.3
2638 .\}
2639 \fIplain\fR
2640 \- This will send everything just as plaintext, signing or encryption are turned off\&.
2641 .RE
2642 .sp
2643 .RS 4
2644 .ie n \{\
2645 \h'-04'\(bu\h'+03'\c
2646 .\}
2647 .el \{\
2648 .sp -1
2649 .IP \(bu 2.3
2650 .\}
2651 \fIsign\fR
2652 \- This will enable integrity checking\&.
2653 .RE
2654 .sp
2655 .RS 4
2656 .ie n \{\
2657 \h'-04'\(bu\h'+03'\c
2658 .\}
2659 .el \{\
2660 .sp -1
2661 .IP \(bu 2.3
2662 .\}
2663 \fIencrypt\fR
2664 \- This will enable integrity checks and force encryption for privacy\&.
2665 .RE
2666 .sp
2667 .RE
2668 Default:
2669 \fI\fIclient protection\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2670 .RE
2671
2672 client schannel (G)
2673 .PP
2674 .RS 4
2675 This option is deprecated with Samba 4\&.8 and will be removed in future\&. At the same time the default changed to yes, which will be the hardcoded behavior in future\&.
2676 .sp
2677 This controls whether the client offers or even demands the use of the netlogon schannel\&.
2678 \m[blue]\fBclient schannel = no\fR\m[]
2679 does not offer the schannel,
2680 \m[blue]\fBclient schannel = auto\fR\m[]
2681 offers the schannel but does not enforce it, and
2682 \m[blue]\fBclient schannel = yes\fR\m[]
2683 denies access if the server is not able to speak netlogon schannel\&.
2684 .sp
2685 Note that for active directory domains this is hardcoded to
2686 \m[blue]\fBclient schannel = yes\fR\m[]\&.
2687 .sp
2688 This option is over\-ridden by the
2689 \m[blue]\fBrequire strong key\fR\m[]
2690 option\&.
2691 .sp
2692 Default:
2693 \fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
2694 .sp
2695 Example:
2696 \fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
2697 .RE
2698
2699 client signing (G)
2700 .PP
2701 .RS 4
2702 This controls whether the client is allowed or required to use SMB signing\&. Possible values are
2703 \fIdesired\fR,
2704 \fIrequired\fR
2705 and
2706 \fIdisabled\fR\&.
2707 .sp
2708 When set to desired or default, SMB signing is offered, but not enforced\&.
2709 .sp
2710 When set to required, SMB signing is mandatory and if set to disabled, SMB signing is not offered either\&.
2711 .sp
2712 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2713 \m[blue]\fBclient ipc signing\fR\m[]
2714 option\&.
2715 .sp
2716 Default:
2717 \fI\fIclient signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2718 .RE
2719
2720 client smb encrypt (G)
2721 .PP
2722 .RS 4
2723 This parameter controls whether a client should try or is required to use SMB encryption\&. It has different effects depending on whether the connection uses SMB1 or SMB3:
2724 .RS
2725 .sp
2726 .RS 4
2727 .ie n \{\
2728 \h'-04'\(bu\h'+03'\c
2729 .\}
2730 .el \{\
2731 .sp -1
2732 .IP \(bu 2.3
2733 .\}
2734 If the connection uses SMB1, then this option controls the use of a Samba\-specific extension to the SMB protocol introduced in Samba 3\&.2 that makes use of the Unix extensions\&.
2735 .RE
2736 .sp
2737 .RS 4
2738 .ie n \{\
2739 \h'-04'\(bu\h'+03'\c
2740 .\}
2741 .el \{\
2742 .sp -1
2743 .IP \(bu 2.3
2744 .\}
2745 If the connection uses SMB2 or newer, then this option controls the use of the SMB\-level encryption that is supported in SMB version 3\&.0 and above and available in Windows 8 and newer\&.
2746 .RE
2747 .sp
2748 .RE
2749 This parameter can be set globally\&. Possible values are
2750 \fIoff\fR,
2751 \fIif_required\fR,
2752 \fIdesired\fR, and
2753 \fIrequired\fR\&. A special value is
2754 \fIdefault\fR
2755 which is the implicit default setting of
2756 \fIif_required\fR\&.
2757 .PP
2758 \fIEffects for SMB1\fR
2759 .RS 4
2760 The Samba\-specific encryption of SMB1 connections is an extension to the SMB protocol negotiated as part of the UNIX extensions\&. SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and sign every request/response in a SMB protocol stream\&. When enabled it provides a secure method of SMB/CIFS communication, similar to an ssh protected session, but using SMB/CIFS authentication to negotiate encryption and signing keys\&. Currently this is only supported smbclient of by Samba 3\&.2 and newer\&. Windows does not support this feature\&.
2761 .sp
2762 When set to default, SMB encryption is probed, but not enforced\&. When set to required, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated\&.
2763 .RE
2764 .PP
2765 \fIEffects for SMB3 and newer\fR
2766 .RS 4
2767 Native SMB transport encryption is available in SMB version 3\&.0 or newer\&. It is only used by Samba if
2768 \fIclient max protocol\fR
2769 is set to
2770 \fISMB3\fR
2771 or newer\&.
2772 .sp
2773 These features can be controlled with settings of
2774 \fIclient smb encrypt\fR
2775 as follows:
2776 .RS
2777 .sp
2778 .RS 4
2779 .ie n \{\
2780 \h'-04'\(bu\h'+03'\c
2781 .\}
2782 .el \{\
2783 .sp -1
2784 .IP \(bu 2.3
2785 .\}
2786 Leaving it as default, explicitly setting
2787 \fIdefault\fR, or setting it to
2788 \fIif_required\fR
2789 globally will enable negotiation of encryption but will not turn on data encryption globally\&.
2790 .RE
2791 .sp
2792 .RS 4
2793 .ie n \{\
2794 \h'-04'\(bu\h'+03'\c
2795 .\}
2796 .el \{\
2797 .sp -1
2798 .IP \(bu 2.3
2799 .\}
2800 Setting it to
2801 \fIdesired\fR
2802 globally will enable negotiation and will turn on data encryption on sessions and share connections for those servers that support it\&.
2803 .RE
2804 .sp
2805 .RS 4
2806 .ie n \{\
2807 \h'-04'\(bu\h'+03'\c
2808 .\}
2809 .el \{\
2810 .sp -1
2811 .IP \(bu 2.3
2812 .\}
2813 Setting it to
2814 \fIrequired\fR
2815 globally will enable negotiation and turn on data encryption on sessions and share connections\&. Clients that do not support encryption will be denied access to the server\&.
2816 .RE
2817 .sp
2818 .RS 4
2819 .ie n \{\
2820 \h'-04'\(bu\h'+03'\c
2821 .\}
2822 .el \{\
2823 .sp -1
2824 .IP \(bu 2.3
2825 .\}
2826 Setting it to
2827 \fIoff\fR
2828 globally will completely disable the encryption feature for all connections\&.
2829 .RE
2830 .sp
2831 .RE
2832 .RE
2833 .sp
2834 Default:
2835 \fI\fIclient smb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2836 .RE
2837
2838 client smb3 encryption algorithms (G)
2839 .PP
2840 .RS 4
2841 This parameter specifies the availability and order of encryption algorithms which are available for negotiation in the SMB3_11 dialect\&.
2842 .sp
2843 It is also possible to remove individual algorithms from the default list, by prefixing them with \*(Aq\-\*(Aq\&. This can avoid having to specify a hardcoded list\&.
2844 .sp
2845 Note: that the removal of AES\-128\-CCM from the list will result in SMB3_00 and SMB3_02 being unavailable, as it is the default and only available algorithm for these dialects\&.
2846 .sp
2847 Default:
2848 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-128\-GCM, AES\-128\-CCM, AES\-256\-GCM, AES\-256\-CCM\fR\fI \fR
2849 .sp
2850 Example:
2851 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-256\-GCM\fR\fI \fR
2852 .sp
2853 Example:
2854 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fI\-AES\-128\-GCM \-AES\-128\-CCM\fR\fI \fR
2855 .RE
2856
2857 client smb encryption over quic (G)
2858 .PP
2859 .RS 4
2860 This parameter controls whether the client requires SMB level encryption even when the transport is already encrypted via QUIC and thus TLS\&.
2861 .sp
2862 \fIclient smb encrypt\fR
2863 controls the use of the encryption mechanism introduced with SMB3\&.0\&. If
2864 \fIclient smb encryption over quic\fR
2865 value is set to
2866 \fIno\fR,
2867 \fIand\fR
2868 the client connects via a validated QUIC (and thus TLS) connection, the client ignores the requirements from the parameter
2869 \fIclient smb encrypt\fR
2870 to avoid double encryption\&.
2871 .sp
2872 If
2873 \fIclient smb encryption over quic\fR
2874 is left at its default
2875 \fIyes\fR, the client connects over normal TCP, or the
2876 \fItls verify peer\fR
2877 was set to anything less than
2878 \fBca_and_name\fR, the requirements from
2879 \fIclient smb encrypt\fR
2880 apply\&.
2881 .sp
2882 Note that the QUIC\-layer encryption is based on a TLS\-level certificate presented by the server\&. The SMB\-layer encryption is based on individual user sessions and as such essentially on initial user credentials such as the user\*(Aqs password or equivalent credentials used for logging on to a Windows session\&. This might influence your security assessment regarding the
2883 \fIclient smb encryption over quic\fR
2884 parameter\&.
2885 .sp
2886 Default:
2887 \fI\fIclient smb encryption over quic\fR\fR\fI = \fR\fIyes\fR\fI \fR
2888 .RE
2889
2890 client smb3 signing algorithms (G)
2891 .PP
2892 .RS 4
2893 This parameter specifies the availability and order of signing algorithms which are available for negotiation in the SMB3_11 dialect\&.
2894 .sp
2895 It is also possible to remove individual algorithms from the default list, by prefixing them with \*(Aq\-\*(Aq\&. This can avoid having to specify a hardcoded list\&.
2896 .sp
2897 Note: that the removal of AES\-128\-CMAC from the list will result in SMB3_00 and SMB3_02 being unavailable, and the removal of HMAC\-SHA256 will result in SMB2_02 and SMB2_10 being unavailable, as these are the default and only available algorithms for these dialects\&.
2898 .sp
2899 Default:
2900 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-GMAC, AES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
2901 .sp
2902 Example:
2903 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
2904 .sp
2905 Example:
2906 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fI\-AES\-128\-CMAC\fR\fI \fR
2907 .RE
2908
2909 client smb transports (G)
2910 .PP
2911 .RS 4
2912 Specifies which transports and ports the client should try to connect to for SMB traffic\&.
2913 .sp
2914 The order matters as they are tried in order with short delays for the fallbacks\&.
2915 .sp
2916 The transport \*(Aqtcp\*(Aq uses raw tcp with a 4 byte length header per SMB PDU\&. The default port for \*(Aqtcp\*(Aq is 445\&. Other ports can be specified by adding it after \*(Aq:\*(Aq, e\&.g\&. \*(Aqtcp:1445\*(Aq\&.
2917 .sp
2918 The transport \*(Aqnbt\*(Aq uses netbios framing on top of tcp per SMB PDU\&. The default port for \*(Aqnbt\*(Aq is 139\&. Other ports can be specified by adding it after \*(Aq:\*(Aq, e\&.g\&. \*(Aqnbt:1139\*(Aq\&.
2919 .sp
2920 The transport \*(Aqquic\*(Aq uses the quic protocol on top of udp\&. The default port for \*(Aqquic\*(Aq is 443\&. Other ports can be specified by adding it after \*(Aq:\*(Aq, e\&.g\&. \*(Aqquic:1443\*(Aq\&. The following options are also relevant:
2921 \m[blue]\fBtls enabled\fR\m[],
2922 \m[blue]\fBtls ca directories\fR\m[],
2923 \m[blue]\fBtls trust system cas\fR\m[],
2924 \m[blue]\fBtls cafile\fR\m[],
2925 \m[blue]\fBtls certfile\fR\m[],
2926 \m[blue]\fBtls keyfile\fR\m[]
2927 and
2928 \m[blue]\fBtls verify peer\fR\m[]\&.
2929 .sp
2930 Note: \*(Aqquic\*(Aq requires the quic\&.ko kernel module for Linux from https://github\&.com/lxin/quic (tested with Linux 6\&.14)\&. Future Linux versions may support it natively\&.
2931 .sp
2932 Numerical ports are handled as \*(Aqtcp\*(Aq except port \*(Aq139\*(Aq is handled as \*(Aqnbt\*(Aq\&.
2933 .sp
2934 Note that\*(Aqs currently a limit of 10 unique transports, all others will be ignored\&.
2935 .sp
2936 Default:
2937 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, nbt\fR\fI \fR
2938 .sp
2939 Example:
2940 \fI\fIclient smb transports\fR\fR\fI = \fR\fI445\fR\fI \fR
2941 .sp
2942 Example:
2943 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, tcp:1445\fR\fI \fR
2944 .sp
2945 Example:
2946 \fI\fIclient smb transports\fR\fR\fI = \fR\fI8000, nbt:1139\fR\fI \fR
2947 .sp
2948 Example:
2949 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, quic, nbt\fR\fI \fR
2950 .sp
2951 Example:
2952 \fI\fIclient smb transports\fR\fR\fI = \fR\fI+quic\fR\fI \fR
2953 .RE
2954
2955 client use kerberos (G)
2956 .PP
2957 .RS 4
2958 This parameter determines whether Samba client tools will try to authenticate using Kerberos\&. For Kerberos authentication you need to use dns names instead of IP addresses when connecting to a service\&.
2959 .sp
2960 Possible option settings are:
2961 .RS
2962 .sp
2963 .RS 4
2964 .ie n \{\
2965 \h'-04'\(bu\h'+03'\c
2966 .\}
2967 .el \{\
2968 .sp -1
2969 .IP \(bu 2.3
2970 .\}
2971 \fIdesired\fR
2972 \- Kerberos authentication will be tried first and if it fails it automatically fallback to NTLM\&.
2973 .RE
2974 .sp
2975 .RS 4
2976 .ie n \{\
2977 \h'-04'\(bu\h'+03'\c
2978 .\}
2979 .el \{\
2980 .sp -1
2981 .IP \(bu 2.3
2982 .\}
2983 \fIrequired\fR
2984 \- Kerberos authentication will be required\&. There will be no fallback to NTLM or a different alternative\&.
2985 .RE
2986 .sp
2987 .RS 4
2988 .ie n \{\
2989 \h'-04'\(bu\h'+03'\c
2990 .\}
2991 .el \{\
2992 .sp -1
2993 .IP \(bu 2.3
2994 .\}
2995 \fIoff\fR
2996 \- Don\*(Aqt use Kerberos, use NTLM instead or another alternative\&.
2997 .RE
2998 .sp
2999 .RE
3000 In case that weak cryptography is not allowed (e\&.g\&. FIPS mode) the default will be forced to
3001 \fIrequired\fR\&.
3002 .sp
3003 Default:
3004 \fI\fIclient use kerberos\fR\fR\fI = \fR\fIdesired\fR\fI \fR
3005 .RE
3006
3007 client use krb5 netlogon (G)
3008 .PP
3009 .RS 4
3010 \fIThis option is experimental for now!\fR
3011 .sp
3012 This option controls whether winbindd (and other client tools) try to use ServerAuthenticateKerberos for the netlogon secure channel\&.
3013 .sp
3014 The behavior can be controlled per netbios domain by using \*(Aqclient use krb5 netlogon:NETBIOSDOMAIN = yes|no\*(Aq as option\&.
3015 .sp
3016 This option is over\-ridden by the
3017 \m[blue]\fBreject aes netlogon servers\fR\m[]
3018 option (if it is effectively on) and lets
3019 \m[blue]\fBclient use krb5 netlogon\fR\m[]
3020 be yes as well\&.
3021 .sp
3022 The \*(Aqdefault\*(Aq currently maps to \*(Aqno\*(Aq\&.
3023 .sp
3024 A meaning of \*(Aqauto\*(Aq depends on the used kerberos library and the trust/domain type\&.
3025 .sp
3026 If samba was compiled using \*(Aq\-\-without\-ads\*(Aq or \*(Aq\-\-with\-system\-heimdalkrb5\*(Aq it is not possible to activate the ServerAuthenticateKerberos feature, as the krb5_init_creds_step() function is not available\&. This forces \*(Aqauto\*(Aq to behave as \*(Aqno\*(Aq\&.
3027 .sp
3028 The value of \*(Aqauto\*(Aq maps to \*(Aqyes\*(Aq if the domain is detected as active directory domain, e\&.g\&. with \*(AqSECURITY = ADS\*(Aq or on an active directory domain controller\&.
3029 .sp
3030 \fI WARNING: This option is experimental in this Samba version (see VERSION section below) and should not be used in production! \fR
3031 .sp
3032 Default:
3033 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIdefault\fR\fI \fR
3034 .sp
3035 Example:
3036 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
3037 .sp
3038 Example:
3039 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIauto\fR\fI \fR
3040 .sp
3041 Example:
3042 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIyes\fR\fI \fR
3043 .RE
3044
3045 client use spnego (G)
3046 .PP
3047 .RS 4
3048 This parameter has been deprecated since Samba 4\&.13 and support for NTLMv2, NTLM and LanMan authentication outside NTLMSSP will be removed in a future Samba release\&.
3049 .sp
3050 That is, in the future, the current default of
3051 client use spnego = yes
3052 will be the enforced behaviour\&.
3053 .sp
3054 This variable controls whether Samba clients will try to use Simple and Protected NEGOtiation (as specified by rfc2478) with supporting servers (including WindowsXP, Windows2000 and Samba 3\&.0) to agree upon an authentication mechanism\&. This enables Kerberos authentication in particular\&.
3055 .sp
3056 When
3057 \m[blue]\fBclient NTLMv2 auth\fR\m[]
3058 is also set to
3059 \fByes\fR
3060 extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP\&. This behavior was introduced with the patches for CVE\-2016\-2111\&.
3061 .sp
3062 Default:
3063 \fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
3064 .RE
3065
3066 cluster addresses (G)
3067 .PP
3068 .RS 4
3069 With this parameter you can add additional addresses that nmbd will register with a WINS server\&. Similarly, these addresses will be registered by default when
3070 \fInet ads dns register\fR
3071 is called with
3072 \m[blue]\fBclustering = yes\fR\m[]
3073 configured\&.
3074 .sp
3075 Default:
3076 \fI\fIcluster addresses\fR\fR\fI = \fR\fI\fR\fI \fR
3077 .sp
3078 Example:
3079 \fI\fIcluster addresses\fR\fR\fI = \fR\fI10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\fR\fI \fR
3080 .RE
3081
3082 clustering (G)
3083 .PP
3084 .RS 4
3085 This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.
3086 .sp
3087 Set this parameter to
3088 yes
3089 only if you have a cluster setup with ctdb running\&.
3090 .sp
3091 Default:
3092 \fI\fIclustering\fR\fR\fI = \fR\fIno\fR\fI \fR
3093 .RE
3094
3095 comment (S)
3096 .PP
3097 .RS 4
3098 This is a text field that is seen next to a share when a client does a queries the server, either via the network neighborhood or via
3099 net view
3100 to list what shares are available\&.
3101 .sp
3102 If you want to set the string that is displayed next to the machine name then see the
3103 \m[blue]\fBserver string\fR\m[]
3104 parameter\&.
3105 .sp
3106 Default:
3107 \fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR
3108 .sp
3109 Example:
3110 \fI\fIcomment\fR\fR\fI = \fR\fIFred\*(Aqs Files\fR\fI \fR
3111 .RE
3112
3113 config backend (G)
3114 .PP
3115 .RS 4
3116 This controls the backend for storing the configuration\&. Possible values are
3117 \fIfile\fR
3118 (the default) and
3119 \fIregistry\fR\&. When
3120 \m[blue]\fBconfig backend = registry\fR\m[]
3121 is encountered while loading
3122 \fIsmb\&.conf\fR, the configuration read so far is dropped and the global options are read from registry instead\&. So this triggers a registry only configuration\&. Share definitions are not read immediately but instead
3123 \fIregistry shares\fR
3124 is set to
3125 \fIyes\fR\&.
3126 .sp
3127 Note: This option can not be set inside the registry configuration itself\&.
3128 .sp
3129 Default:
3130 \fI\fIconfig backend\fR\fR\fI = \fR\fIfile\fR\fI \fR
3131 .sp
3132 Example:
3133 \fI\fIconfig backend\fR\fR\fI = \fR\fIregistry\fR\fI \fR
3134 .RE
3135
3136 config file (G)
3137 .PP
3138 .RS 4
3139 This allows you to override the config file to use, instead of the default (usually
3140 smb\&.conf)\&. There is a chicken and egg problem here as this option is set in the config file!
3141 .sp
3142 For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file\&.
3143 .sp
3144 This option takes the usual substitutions, which can be very useful\&.
3145 .sp
3146 If the config file doesn\*(Aqt exist then it won\*(Aqt be loaded (allowing you to special case the config files of just a few clients)\&.
3147 .sp
3148 \fINo default\fR
3149 .sp
3150 Example:
3151 \fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\&.conf\&.%m\fR\fI \fR
3152 .RE
3153
3154 copy (S)
3155 .PP
3156 .RS 4
3157 This parameter allows you to "clone" service entries\&. The specified service is simply duplicated under the current service\*(Aqs name\&. Any parameters specified in the current section will override those in the section being copied\&.
3158 .sp
3159 This feature lets you set up a \*(Aqtemplate\*(Aq service and create similar services easily\&. Note that the service being copied must occur earlier in the configuration file than the service doing the copying\&.
3160 .sp
3161 Default:
3162 \fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR
3163 .sp
3164 Example:
3165 \fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR
3166 .RE
3167
3168 create krb5 conf (G)
3169 .PP
3170 .RS 4
3171 Setting this parameter to
3172 no
3173 prevents winbind from creating custom krb5\&.conf files\&. Winbind normally does this because the krb5 libraries are not AD\-site\-aware and thus would pick any domain controller out of potentially very many\&. Winbind is site\-aware and makes the krb5 libraries use a local DC by creating its own krb5\&.conf files\&.
3174 .sp
3175 Preventing winbind from doing this might become necessary if you have to add special options into your system\-krb5\&.conf that winbind does not see\&.
3176 .sp
3177 Default:
3178 \fI\fIcreate krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR
3179 .RE
3180
3181 create mode
3182 .PP
3183 .RS 4
3184 This parameter is a synonym for
3185 create mask\&.
3186 .RE
3187
3188 create mask (S)
3189 .PP
3190 .RS 4
3191 When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \*(AqAND\*(Aqed with this parameter\&. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a file\&. Any bit
3192 \fInot\fR
3193 set here will be removed from the modes set on a file when it is created\&.
3194 .sp
3195 The default value of this parameter removes the
3196 group
3197 and
3198 other
3199 write and execute bits from the UNIX modes\&.
3200 .sp
3201 Following this Samba will bit\-wise \*(AqOR\*(Aq the UNIX mode created from this parameter with the value of the
3202 \m[blue]\fBforce create mode\fR\m[]
3203 parameter which is set to 000 by default\&.
3204 .sp
3205 This parameter does not affect directory masks\&. See the parameter
3206 \m[blue]\fBdirectory mask\fR\m[]
3207 for details\&.
3208 .sp
3209 Default:
3210 \fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR
3211 .sp
3212 Example:
3213 \fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
3214 .RE
3215
3216 csc policy (S)
3217 .PP
3218 .RS 4
3219 This stands for
3220 \fIclient\-side caching policy\fR, and specifies how clients capable of offline caching will cache the files in the share\&. The valid values are: manual, documents, programs, disable\&.
3221 .sp
3222 These values correspond to those used on Windows servers\&.
3223 .sp
3224 For example, shares containing roaming profiles can have offline caching disabled using
3225 \m[blue]\fBcsc policy = disable\fR\m[]\&.
3226 .sp
3227 Default:
3228 \fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR
3229 .sp
3230 Example:
3231 \fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR
3232 .RE
3233
3234 ctdbd socket (G)
3235 .PP
3236 .RS 4
3237 In a test environment, this parameter can be used when
3238 clustering=yes
3239 to specify an alternate location for the CTDB Unix domain socket\&.
3240 .sp
3241 This parameter should not be set in production environments\&. If it is not set then the (correct) build\-time default is used\&.
3242 .sp
3243 Default:
3244 \fI\fIctdbd socket\fR\fR\fI = \fR\fI\fR\fI \fR
3245 .sp
3246 Example:
3247 \fI\fIctdbd socket\fR\fR\fI = \fR\fI/var/run/altctdb/ctdbd\&.socket\fR\fI \fR
3248 .RE
3249
3250 ctdb locktime warn threshold (G)
3251 .PP
3252 .RS 4
3253 In a cluster environment using Samba and ctdb it is critical that locks on central ctdb\-hosted databases like locking\&.tdb are not held for long\&. With the current Samba architecture it happens that Samba takes a lock and while holding that lock makes file system calls into the shared cluster file system\&. This option makes Samba warn if it detects that it has held locks for the specified number of milliseconds\&. If this happens,
3254 \fIsmbd\fR
3255 will emit a debug level 0 message into its logs and potentially into syslog\&. The most likely reason for such a log message is that an operation of the cluster file system Samba exports is taking longer than expected\&. The messages are meant as a debugging aid for potential cluster problems\&.
3256 .sp
3257 The default value of 0 disables this logging\&.
3258 .sp
3259 Default:
3260 \fI\fIctdb locktime warn threshold\fR\fR\fI = \fR\fI0\fR\fI \fR
3261 .RE
3262
3263 ctdb timeout (G)
3264 .PP
3265 .RS 4
3266 This parameter specifies a timeout in milliseconds for the connection between Samba and ctdb\&. It is only valid if you have compiled Samba with clustering and if you have set
3267 \fIclustering=yes\fR\&.
3268 .sp
3269 When something in the cluster blocks, it can happen that we wait indefinitely long for ctdb, just adding to the blocking condition\&. In a well\-running cluster this should never happen, but there are too many components in a cluster that might have hickups\&. Choosing the right balance for this value is very tricky, because on a busy cluster long service times to transfer something across the cluster might be valid\&. Setting it too short will degrade the service your cluster presents, setting it too long might make the cluster itself not recover from something severely broken for too long\&.
3270 .sp
3271 Be aware that if you set this parameter, this needs to be in the file smb\&.conf, it is not really helpful to put this into a registry configuration (typical on a cluster), because to access the registry contact to ctdb is required\&.
3272 .sp
3273 Setting
3274 \fIctdb timeout\fR
3275 to n makes any process waiting longer than n milliseconds for a reply by the cluster panic\&. Setting it to 0 (the default) makes Samba block forever, which is the highly recommended default\&.
3276 .sp
3277 Default:
3278 \fI\fIctdb timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
3279 .RE
3280
3281 cups connection timeout (G)
3282 .PP
3283 .RS 4
3284 This parameter is only applicable if
3285 \m[blue]\fBprinting\fR\m[]
3286 is set to
3287 \fBcups\fR\&.
3288 .sp
3289 If set, this option specifies the number of seconds that smbd will wait whilst trying to contact to the CUPS server\&. The connection will fail if it takes longer than this number of seconds\&.
3290 .sp
3291 Default:
3292 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI30\fR\fI \fR
3293 .sp
3294 Example:
3295 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI60\fR\fI \fR
3296 .RE
3297
3298 cups encrypt (G)
3299 .PP
3300 .RS 4
3301 This parameter is only applicable if
3302 \m[blue]\fBprinting\fR\m[]
3303 is set to
3304 \fBcups\fR
3305 and if you use CUPS newer than 1\&.0\&.x\&.It is used to define whether or not Samba should use encryption when talking to the CUPS server\&. Possible values are
3306 \fIauto\fR,
3307 \fIyes\fR
3308 and
3309 \fIno\fR
3310 .sp
3311 When set to auto we will try to do a TLS handshake on each CUPS connection setup\&. If that fails, we will fall back to unencrypted operation\&.
3312 .sp
3313 Default:
3314 \fI\fIcups encrypt\fR\fR\fI = \fR\fIno\fR\fI \fR
3315 .RE
3316
3317 cups options (S)
3318 .PP
3319 .RS 4
3320 This parameter is only applicable if
3321 \m[blue]\fBprinting\fR\m[]
3322 is set to
3323 \fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
3324 .sp
3325 You can pass any generic print option known to CUPS (as listed in the CUPS "Software Users\*(Aq Manual")\&. You can also pass any printer specific option (as listed in "lpoptions \-d printername \-l") valid for the target queue\&. Multiple parameters should be space\-delimited name/value pairs according to the PAPI text option ABNF specification\&. Collection values ("name={a=\&.\&.\&. b=\&.\&.\&. c=\&.\&.\&.}") are stored with the curley brackets intact\&.
3326 .sp
3327 You should set this parameter to
3328 \fBraw\fR
3329 if your CUPS server
3330 error_log
3331 file contains messages such as "Unsupported format \*(Aqapplication/octet\-stream\*(Aq" when printing from a Windows client through Samba\&. It is no longer necessary to enable system wide raw printing in
3332 /etc/cups/mime\&.{convs,types}\&.
3333 .sp
3334 Default:
3335 \fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR
3336 .sp
3337 Example:
3338 \fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR
3339 .RE
3340
3341 cups server (G)
3342 .PP
3343 .RS 4
3344 This parameter is only applicable if
3345 \m[blue]\fBprinting\fR\m[]
3346 is set to
3347 \fBcups\fR\&.
3348 .sp
3349 If set, this option overrides the ServerName option in the CUPS
3350 client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
3351 .sp
3352 Optionally, a port can be specified by separating the server name and port number with a colon\&. If no port was specified, the default port for IPP (631) will be used\&.
3353 .sp
3354 Default:
3355 \fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR
3356 .sp
3357 Example:
3358 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR
3359 .sp
3360 Example:
3361 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR
3362 .RE
3363
3364 dcerpc endpoint servers (G)
3365 .PP
3366 .RS 4
3367 Specifies which DCE/RPC endpoint servers should be run\&.
3368 .sp
3369 Default:
3370 \fI\fIdcerpc endpoint servers\fR\fR\fI = \fR\fIepmapper, samr, netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6, backupkey, dnsserver\fR\fI \fR
3371 .sp
3372 Example:
3373 \fI\fIdcerpc endpoint servers\fR\fR\fI = \fR\fIrpcecho\fR\fI \fR
3374 .RE
3375
3376 deadtime (G)
3377 .PP
3378 .RS 4
3379 The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected\&. The deadtime only takes effect if the number of open files is zero\&.
3380 .sp
3381 This is useful to stop a server\*(Aqs resources being exhausted by a large number of inactive connections\&.
3382 .sp
3383 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
3384 .sp
3385 Using this parameter with a timeout of a few minutes is recommended for most systems\&.
3386 .sp
3387 A deadtime of zero indicates that no auto\-disconnection should be performed\&.
3388 .sp
3389 Default:
3390 \fI\fIdeadtime\fR\fR\fI = \fR\fI10080\fR\fI \fR
3391 .sp
3392 Example:
3393 \fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR
3394 .RE
3395
3396 debug class (G)
3397 .PP
3398 .RS 4
3399 With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.
3400 .sp
3401 For more information about currently available debug classes, see section about
3402 \m[blue]\fBlog level\fR\m[]\&.
3403 .sp
3404 Default:
3405 \fI\fIdebug class\fR\fR\fI = \fR\fIno\fR\fI \fR
3406 .RE
3407
3408 debug encryption (G)
3409 .PP
3410 .RS 4
3411 This option will make the smbd server and client code using libsmb (smbclient, smbget, smbspool, \&.\&.\&.) dump the Session Id, the decrypted Session Key, the Signing Key, the Application Key, the Encryption Key and the Decryption Key every time an SMB3+ session is established\&. This information will be printed in logs at level 0\&.
3412 .sp
3413 Warning: access to these values enables the decryption of any encrypted traffic on the dumped sessions\&. This option should only be enabled for debugging purposes\&.
3414 .sp
3415 Default:
3416 \fI\fIdebug encryption\fR\fR\fI = \fR\fIno\fR\fI \fR
3417 .RE
3418
3419 debug hires timestamp (G)
3420 .PP
3421 .RS 4
3422 Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on\&.
3423 .sp
3424 Note that the parameter
3425 \m[blue]\fBdebug timestamp\fR\m[]
3426 or
3427 \m[blue]\fBdebug syslog format\fR\m[]
3428 must be on for this to have an effect\&.
3429 .sp
3430 Default:
3431 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR
3432 .RE
3433
3434 debug pid (G)
3435 .PP
3436 .RS 4
3437 When using only one log file for more then one forked
3438 \fBsmbd\fR(8)\-process there may be hard to follow which process outputs which message\&. This boolean parameter is adds the process\-id to the timestamp message headers in the logfile when turned on\&.
3439 .sp
3440 Note that the parameter
3441 \m[blue]\fBdebug timestamp\fR\m[]
3442 must be on for this to have an effect\&.
3443 .sp
3444 Default:
3445 \fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR
3446 .RE
3447
3448 debug prefix timestamp (G)
3449 .PP
3450 .RS 4
3451 With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the
3452 \m[blue]\fBdebug timestamp\fR\m[]
3453 parameter\&. This gives timestamps to the messages without adding an additional line\&.
3454 .sp
3455 Note that this parameter overrides the
3456 \m[blue]\fBdebug timestamp\fR\m[]
3457 parameter\&.
3458 .sp
3459 Default:
3460 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
3461 .RE
3462
3463 debug syslog format (G)
3464 .PP
3465 .RS 4
3466 With this option enabled (\fByes\fR
3467 (alias
3468 \fBin_logs\fR) or
3469 \fBalways\fR), debug messages are printed in a single\-line format like that traditionally produced by syslog\&. The timestamp consists of an abbreviated month, space\-padded date, and time including seconds\&. This is followed by the hostname and the program name, with the process\-ID in square brackets\&.
3470 .sp
3471 The value
3472 \fBalways\fR
3473 produces this log format even to
3474 \fBSTDOUT\fR
3475 or
3476 \fBSTDERR\fR
3477 .sp
3478 The value
3479 \fBno\fR
3480 defers to other parameters and typically produces traditional two\-line Samba logs to log files\&.
3481 .sp
3482 If
3483 \m[blue]\fBdebug hires timestamp\fR\m[]
3484 is also enabled then an RFC5424 timestamp is used instead\&.
3485 .sp
3486 Default:
3487 \fI\fIdebug syslog format\fR\fR\fI = \fR\fIno\fR\fI \fR
3488 .RE
3489
3490 winbind debug traceid (G)
3491 .PP
3492 .RS 4
3493 With this boolean parameter enabled, the per request unique traceid will be displayed in the debug header for winbind processes\&.
3494 .sp
3495 Default:
3496 \fI\fIwinbind debug traceid\fR\fR\fI = \fR\fIyes\fR\fI \fR
3497 .RE
3498
3499 debug uid (G)
3500 .PP
3501 .RS 4
3502 Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on\&.
3503 .sp
3504 Note that the parameter
3505 \m[blue]\fBdebug timestamp\fR\m[]
3506 must be on for this to have an effect\&.
3507 .sp
3508 Default:
3509 \fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR
3510 .RE
3511
3512 dedicated keytab file (G)
3513 .PP
3514 .RS 4
3515 Specifies the absolute path to the kerberos keytab file when
3516 \m[blue]\fBkerberos method\fR\m[]
3517 is set to "dedicated keytab"\&.
3518 .sp
3519 Default:
3520 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\fR\fI \fR
3521 .sp
3522 Example:
3523 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI/usr/local/etc/krb5\&.keytab\fR\fI \fR
3524 .RE
3525
3526 default case (S)
3527 .PP
3528 .RS 4
3529 See the section on
3530 name mangling\&. Also note the
3531 \m[blue]\fBshort preserve case\fR\m[]
3532 parameter\&.
3533 .sp
3534 Default:
3535 \fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR
3536 .RE
3537
3538 default devmode (S)
3539 .PP
3540 .RS 4
3541 This parameter is only applicable to
3542 \m[blue]\fBprintable\fR\m[]
3543 services\&. When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba server has a Device Mode which defines things such as paper size and orientation and duplex settings\&. The device mode can only correctly be generated by the printer driver itself (which can only be executed on a Win32 platform)\&. Because smbd is unable to execute the driver code to generate the device mode, the default behavior is to set this field to NULL\&.
3544 .sp
3545 Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode\&. Certain drivers will do things such as crashing the client\*(Aqs Explorer\&.exe with a NULL devmode\&. However, other printer drivers can cause the client\*(Aqs spooler service (spoolsv\&.exe) to die if the devmode was not created by the driver itself (i\&.e\&. smbd generates a default devmode)\&.
3546 .sp
3547 This parameter should be used with care and tested with the printer driver in question\&. It is better to leave the device mode to NULL and let the Windows client set the correct values\&. Because drivers do not do this all the time, setting
3548 default devmode = yes
3549 will instruct smbd to generate a default one\&.
3550 .sp
3551 For more information on Windows NT/2k printing and Device Modes, see the
3552 MSDN documentation\&.
3553 .sp
3554 Default:
3555 \fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR
3556 .RE
3557
3558 default
3559 .PP
3560 .RS 4
3561 This parameter is a synonym for
3562 default service\&.
3563 .RE
3564
3565 default service (G)
3566 .PP
3567 .RS 4
3568 This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found\&. Note that the square brackets are
3569 \fINOT\fR
3570 given in the parameter value (see example below)\&.
3571 .sp
3572 There is no default value for this parameter\&. If this parameter is not given, attempting to connect to a nonexistent service results in an error\&.
3573 .sp
3574 Typically the default service would be a
3575 \m[blue]\fBguest ok\fR\m[],
3576 \m[blue]\fBread only\fR\m[]
3577 service\&.
3578 .sp
3579 Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it allows you to use macros like
3580 \fI%S\fR
3581 to make a wildcard service\&.
3582 .sp
3583 Note also that any "_" characters in the name of the service used in the default service will get mapped to a "/"\&. This allows for interesting things\&.
3584 .sp
3585 Default:
3586 \fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR
3587 .sp
3588 Example:
3589 \fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR
3590 .RE
3591
3592 defer sharing violations (G)
3593 .PP
3594 .RS 4
3595 Windows allows specifying how a file will be shared with other processes when it is opened\&. Sharing violations occur when a file is opened by a different process using options that violate the share settings specified by other processes\&. This parameter causes smbd to act as a Windows server does, and defer returning a "sharing violation" error message for up to one second, allowing the client to close the file causing the violation in the meantime\&.
3596 .sp
3597 UNIX by default does not have this behaviour\&.
3598 .sp
3599 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
3600 .sp
3601 Default:
3602 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fIyes\fR\fI \fR
3603 .RE
3604
3605 delete group script (G)
3606 .PP
3607 .RS 4
3608 This is the full pathname to a script that will be run
3609 \fIAS ROOT\fR
3610 by
3611 \fBsmbd\fR(8)
3612 when a group is requested to be deleted\&. It will expand any
3613 \fI%g\fR
3614 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
3615 .sp
3616 Default:
3617 \fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR
3618 .RE
3619
3620 deleteprinter command (G)
3621 .PP
3622 .RS 4
3623 With the introduction of MS\-RPC based printer support for Windows NT/2000 clients in Samba 2\&.2, it is now possible to delete a printer at run time by issuing the DeletePrinter() RPC call\&.
3624 .sp
3625 For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The
3626 \m[blue]\fBdeleteprinter command\fR\m[]
3627 defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
3628 smb\&.conf\&.
3629 .sp
3630 The
3631 \m[blue]\fBdeleteprinter command\fR\m[]
3632 is automatically called with only one parameter:
3633 \m[blue]\fBprinter name\fR\m[]\&.
3634 .sp
3635 Once the
3636 \m[blue]\fBdeleteprinter command\fR\m[]
3637 has been executed,
3638 smbd
3639 will reparse the
3640 smb\&.conf
3641 to check that the associated printer no longer exists\&. If the sharename is still valid, then
3642 smbd
3643 will return an ACCESS_DENIED error to the client\&.
3644 .sp
3645 Default:
3646 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
3647 .sp
3648 Example:
3649 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR
3650 .RE
3651
3652 delete readonly (S)
3653 .PP
3654 .RS 4
3655 This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
3656 .sp
3657 This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file\&.
3658 .sp
3659 Default:
3660 \fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
3661 .RE
3662
3663 delete share command (G)
3664 .PP
3665 .RS 4
3666 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
3667 \fIdelete share command\fR
3668 is used to define an external program or script which will remove an existing service definition from
3669 smb\&.conf\&.
3670 .sp
3671 In order to successfully execute the
3672 \fIdelete share command\fR,
3673 smbd
3674 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
3675 SeDiskOperatorPrivilege\&. Scripts defined in the
3676 \fIdelete share command\fR
3677 parameter are executed as root\&.
3678 .sp
3679 When executed,
3680 smbd
3681 will automatically invoke the
3682 \fIdelete share command\fR
3683 with two parameters\&.
3684 .RS
3685 .sp
3686 .RS 4
3687 .ie n \{\
3688 \h'-04'\(bu\h'+03'\c
3689 .\}
3690 .el \{\
3691 .sp -1
3692 .IP \(bu 2.3
3693 .\}
3694 \fIconfigFile\fR
3695 \- the location of the global
3696 smb\&.conf
3697 file\&.
3698 .RE
3699 .sp
3700 .RS 4
3701 .ie n \{\
3702 \h'-04'\(bu\h'+03'\c
3703 .\}
3704 .el \{\
3705 .sp -1
3706 .IP \(bu 2.3
3707 .\}
3708 \fIshareName\fR
3709 \- the name of the existing service\&.
3710 .RE
3711 .sp
3712 .RE
3713 This parameter is only used to remove file shares\&. To delete printer shares, see the
3714 \m[blue]\fBdeleteprinter command\fR\m[]\&.
3715 .sp
3716 Default:
3717 \fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR
3718 .sp
3719 Example:
3720 \fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR
3721 .RE
3722
3723 delete user from group script (G)
3724 .PP
3725 .RS 4
3726 Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration tools\&. It will be run by
3727 \fBsmbd\fR(8)
3728 \fIAS ROOT\fR\&. Any
3729 \fI%g\fR
3730 will be replaced with the group name and any
3731 \fI%u\fR
3732 will be replaced with the user name\&.
3733 .sp
3734 Default:
3735 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR
3736 .sp
3737 Example:
3738 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR
3739 .RE
3740
3741 delete user script (G)
3742 .PP
3743 .RS 4
3744 This is the full pathname to a script that will be run by
3745 \fBsmbd\fR(8)
3746 when managing users with remote RPC (NT) tools\&.
3747 .sp
3748 This script is called when a remote client removes a user from the server, normally using \*(AqUser Manager for Domains\*(Aq or
3749 rpcclient\&.
3750 .sp
3751 This script should delete the given UNIX username\&.
3752 .sp
3753 Default:
3754 \fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR
3755 .sp
3756 Example:
3757 \fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR
3758 .RE
3759
3760 delete veto files (S)
3761 .PP
3762 .RS 4
3763 This option is used when Samba is attempting to delete a directory that contains one or more vetoed files or directories or non\-visible files or directories (such as dangling symlinks that point nowhere)\&. (see the
3764 \m[blue]\fBveto files\fR\m[],
3765 \m[blue]\fBhide special files\fR\m[],
3766 \m[blue]\fBhide unreadable\fR\m[],
3767 \m[blue]\fBhide unwriteable files\fR\m[]
3768 options)\&. If this option is set to
3769 \fBno\fR
3770 (the default) then if a vetoed directory contains any non\-vetoed files or directories then the directory delete will fail\&. This is usually what you want\&.
3771 .sp
3772 If this option is set to
3773 \fByes\fR, then Samba will attempt to recursively delete any files and directories within the vetoed directory\&. This can be useful for integration with file serving systems such as NetAtalk which create meta\-files within directories you might normally veto DOS/Windows users from seeing (e\&.g\&.
3774 \&.AppleDouble)
3775 .sp
3776 Setting
3777 \m[blue]\fBdelete veto files = yes\fR\m[]
3778 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
3779 .sp
3780 Default:
3781 \fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR
3782 .RE
3783
3784 dfree cache time (S)
3785 .PP
3786 .RS 4
3787 The
3788 \fIdfree cache time\fR
3789 should only be used on systems where a problem occurs with the internal disk space calculations\&. This has been known to happen with Ultrix, but may occur with other operating systems\&. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\&.
3790 .sp
3791 This is a new parameter introduced in Samba version 3\&.0\&.21\&. It specifies in seconds the time that smbd will cache the output of a disk free query\&. If set to zero (the default) no caching is done\&. This allows a heavily loaded server to prevent rapid spawning of
3792 \m[blue]\fBdfree command\fR\m[]
3793 scripts increasing the load\&.
3794 .sp
3795 By default this parameter is zero, meaning no caching will be done\&.
3796 .sp
3797 \fINo default\fR
3798 .sp
3799 Example:
3800 \fI\fIdfree cache time\fR\fR\fI = \fR\fI60\fR\fI \fR
3801 .RE
3802
3803 dfree command (S)
3804 .PP
3805 .RS 4
3806 The
3807 \fIdfree command\fR
3808 setting should only be used on systems where a problem occurs with the internal disk space calculations\&. This has been known to happen with Ultrix, but may occur with other operating systems\&. The symptom that was seen was an error of "Abort Retry Ignore" at the end of each directory listing\&.
3809 .sp
3810 This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine\&. The example below gives a possible script that might fulfill this function\&.
3811 .sp
3812 In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
3813 \m[blue]\fBdfree cache time\fR\m[]
3814 was added to allow the output of this script to be cached for systems under heavy load\&.
3815 .sp
3816 The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
3817 \&./\&. The script should return two integers in ASCII\&. The first should be the total disk space in blocks, and the second should be the number of available blocks\&. An optional third return value can give the block size in bytes\&. The default blocksize is 1024 bytes\&.
3818 .sp
3819 Note: Your script should
3820 \fINOT\fR
3821 be setuid or setgid and should be owned by (and writeable only by) root!
3822 .sp
3823 Where the script dfree (which must be made executable) could be:
3824 .sp
3825 .if n \{\
3826 .RS 4
3827 .\}
3828 .nf
3829
3830 #!/bin/sh
3831 df "$1" | tail \-1 | awk \*(Aq{print $(NF\-4),$(NF\-2)}\*(Aq
3832 .fi
3833 .if n \{\
3834 .RE
3835 .\}
3836 .sp
3837 or perhaps (on Sys V based systems):
3838 .sp
3839 .if n \{\
3840 .RS 4
3841 .\}
3842 .nf
3843
3844 #!/bin/sh
3845 /usr/bin/df \-k "$1" | tail \-1 | awk \*(Aq{print $3" "$5}\*(Aq
3846 .fi
3847 .if n \{\
3848 .RE
3849 .\}
3850 .sp
3851 Note that you may have to replace the command names with full path names on some systems\&. Also note the arguments passed into the script should be quoted inside the script in case they contain special characters such as spaces or newlines\&.
3852 .sp
3853 By default internal routines for determining the disk capacity and remaining space will be used\&.
3854 .sp
3855 \fINo default\fR
3856 .sp
3857 Example:
3858 \fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR
3859 .RE
3860
3861 dgram port (G)
3862 .PP
3863 .RS 4
3864 Specifies which ports the server should listen on for NetBIOS datagram traffic\&.
3865 .sp
3866 Default:
3867 \fI\fIdgram port\fR\fR\fI = \fR\fI138\fR\fI \fR
3868 .RE
3869
3870 directory mode
3871 .PP
3872 .RS 4
3873 This parameter is a synonym for
3874 directory mask\&.
3875 .RE
3876
3877 directory mask (S)
3878 .PP
3879 .RS 4
3880 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
3881 .sp
3882 When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit\-wise \*(AqAND\*(Aqed with this parameter\&. This parameter may be thought of as a bit\-wise MASK for the UNIX modes of a directory\&. Any bit
3883 \fInot\fR
3884 set here will be removed from the modes set on a directory when it is created\&.
3885 .sp
3886 The default value of this parameter removes the \*(Aqgroup\*(Aq and \*(Aqother\*(Aq write bits from the UNIX mode, allowing only the user who owns the directory to modify it\&.
3887 .sp
3888 Following this Samba will bit\-wise \*(AqOR\*(Aq the UNIX mode created from this parameter with the value of the
3889 \m[blue]\fBforce directory mode\fR\m[]
3890 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
3891 .sp
3892 Default:
3893 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR
3894 .sp
3895 Example:
3896 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
3897 .RE
3898
3899 directory security mask (S)
3900 .PP
3901 .RS 4
3902 This parameter has been removed for Samba 4\&.0\&.0\&.
3903 .sp
3904 \fINo default\fR
3905 .RE
3906
3907 disable netbios (G)
3908 .PP
3909 .RS 4
3910 Enabling this parameter will disable netbios support in Samba\&. Netbios is the only available form of browsing in Windows versions prior to Windows 2000\&.
3911 .if n \{\
3912 .sp
3913 .\}
3914 .RS 4
3915 .it 1 an-trap
3916 .nr an-no-space-flag 1
3917 .nr an-break-flag 1
3918 .br
3919 .ps +1
3920 \fBNote\fR
3921 .ps -1
3922 .br
3923 Clients that only support netbios won\*(Aqt be able to see your samba server when netbios support is disabled\&.
3924 .sp .5v
3925 .RE
3926 Default:
3927 \fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR
3928 .RE
3929
3930 disable spoolss (G)
3931 .PP
3932 .RS 4
3933 Enabling this parameter will disable Samba\*(Aqs support for the SPOOLSS set of MS\-RPC\*(Aqs and will yield identical behavior as Samba 2\&.0\&.x\&. Windows NT/2000 clients will downgrade to using Lanman style printing commands\&. Windows 9x/ME will be unaffected by the parameter\&. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window\&. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand\&.
3934 \fIBe very careful about enabling this parameter\&.\fR
3935 .sp
3936 Default:
3937 \fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR
3938 .RE
3939
3940 dmapi support (S)
3941 .PP
3942 .RS 4
3943 This parameter specifies whether Samba should use DMAPI to determine whether a file is offline or not\&. This would typically be used in conjunction with a hierarchical storage system that automatically migrates files to tape\&.
3944 .sp
3945 Note that Samba infers the status of a file by examining the events that a DMAPI application has registered interest in\&. This heuristic is satisfactory for a number of hierarchical storage systems, but there may be system for which it will fail\&. In this case, Samba may erroneously report files to be offline\&.
3946 .sp
3947 This parameter is only available if a supported DMAPI implementation was found at compilation time\&. It will only be used if DMAPI is found to enabled on the system at run time\&.
3948 .sp
3949 Default:
3950 \fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR
3951 .RE
3952
3953 dns hostname (G)
3954 .PP
3955 .RS 4
3956
3957 This value is used:
3958
3959 .RS
3960 .sp
3961 .RS 4
3962 .ie n \{\
3963 \h'-04'\(bu\h'+03'\c
3964 .\}
3965 .el \{\
3966 .sp -1
3967 .IP \(bu 2.3
3968 .\}
3969 to register DNS record with AD during a join or by calling
3970 .sp
3971 .if n \{\
3972 .RS 4
3973 .\}
3974 .nf
3975 net ads dns register
3976 .fi
3977 .if n \{\
3978 .RE
3979 .\}
3980 .RE
3981 .sp
3982 .RS 4
3983 .ie n \{\
3984 \h'-04'\(bu\h'+03'\c
3985 .\}
3986 .el \{\
3987 .sp -1
3988 .IP \(bu 2.3
3989 .\}
3990 during Kerberos authentication to create service principal names
3991 .RE
3992 .sp
3993 .RS 4
3994 .ie n \{\
3995 \h'-04'\(bu\h'+03'\c
3996 .\}
3997 .el \{\
3998 .sp -1
3999 .IP \(bu 2.3
4000 .\}
4001 during keytab creation \- see the
4002 \m[blue]\fBsync machine password to keytab\fR\m[]
4003 parameter
4004 .RE
4005 .sp
4006 .RE
4007 This is not supported in samba\-tool yet\&.
4008
4009 Default:
4010 \fI\fIdns hostname\fR\fR\fI = \fR\fI[netbios name]\&.[realm]\fR\fI \fR
4011 .sp
4012 Example:
4013 \fI\fIdns hostname\fR\fR\fI = \fR\fIclient\-hostname\&.example\&.com\fR\fI \fR
4014 .RE
4015
4016 dns forwarder (G)
4017 .PP
4018 .RS 4
4019 This option specifies the list of DNS servers that DNS requests will be forwarded to if they can not be handled by Samba itself\&.
4020 .sp
4021 The DNS forwarder is only used if the internal DNS server in Samba is used\&. Port numbers can be appended by separating them from the address by using a colon (\*(Aq:\*(Aq)\&. When specifying a port, IPv6 addresses must be enclosed in square brackets (\*(Aq[\*(Aq and \*(Aq]\*(Aq)\&. IPv6 forwarder addresses with no port specified, don\*(Aqt need the square brackets, and default to port 53\&.
4022 .sp
4023 Default:
4024 \fI\fIdns forwarder\fR\fR\fI = \fR\fI\fR\fI \fR
4025 .sp
4026 Example:
4027 \fI\fIdns forwarder\fR\fR\fI = \fR\fI192\&.168\&.0\&.1 192\&.168\&.0\&.2 ::1 [2001:db8::1] [2001:db8:1:2::1]:54 \fR\fI \fR
4028 .RE
4029
4030 dns port (G)
4031 .PP
4032 .RS 4
4033 Specifies which ports the server should listen on for DNS traffic\&.
4034 .sp
4035 It makes possible to use another DNS server as a front and forward to Samba\&.
4036 .if n \{\
4037 .sp
4038 .\}
4039 .RS 4
4040 .it 1 an-trap
4041 .nr an-no-space-flag 1
4042 .nr an-break-flag 1
4043 .br
4044 .ps +1
4045 \fBWarning\fR
4046 .ps -1
4047 .br
4048 Dynamic DNS updates may not be proxied by the front DNS server when forwarding to Samba\&. Dynamic DNS update proxying depends on the features of the other DNS server used as a front\&.
4049 .sp .5v
4050 .RE
4051 Default:
4052 \fI\fIdns port\fR\fR\fI = \fR\fI53\fR\fI \fR
4053 .RE
4054
4055 dns proxy (G)
4056 .PP
4057 .RS 4
4058 Specifies that
4059 \fBnmbd\fR(8)
4060 when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word\-for\-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name\-querying client\&.
4061 .sp
4062 Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum\&.
4063 .sp
4064 nmbd
4065 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
4066 .sp
4067 Default:
4068 \fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR
4069 .RE
4070
4071 dns update command (G)
4072 .PP
4073 .RS 4
4074 This option sets the command that is called when there are DNS updates\&. It should update the local machines DNS names using TSIG\-GSS\&.
4075 .sp
4076 Default:
4077 \fI\fIdns update command\fR\fR\fI = \fR\fI/builddir/build/BUILD/samba\-4\&.24\&.0\-build/samba\-4\&.24\&.0/source4/scripting/bin/samba_dnsupdate\fR\fI \fR
4078 .sp
4079 Example:
4080 \fI\fIdns update command\fR\fR\fI = \fR\fI/usr/local/sbin/dnsupdate\fR\fI \fR
4081 .RE
4082
4083 dns zone scavenging (G)
4084 .PP
4085 .RS 4
4086 When enabled (the default is disabled) unused dynamic dns records are periodically removed\&.
4087 .if n \{\
4088 .sp
4089 .\}
4090 .RS 4
4091 .it 1 an-trap
4092 .nr an-no-space-flag 1
4093 .nr an-break-flag 1
4094 .br
4095 .ps +1
4096 \fBWarning\fR
4097 .ps -1
4098 .br
4099 This option should not be enabled for installations created with versions of samba before 4\&.9\&. Doing this will result in the loss of static DNS entries\&. This is due to a bug in previous versions of samba (BUG 12451) which marked dynamic DNS records as static and static records as dynamic\&.
4100 .sp .5v
4101 .RE
4102 .if n \{\
4103 .sp
4104 .\}
4105 .RS 4
4106 .it 1 an-trap
4107 .nr an-no-space-flag 1
4108 .nr an-break-flag 1
4109 .br
4110 .ps +1
4111 \fBNote\fR
4112 .ps -1
4113 .br
4114 If one record for a DNS name is static (non\-aging) then no other record for that DNS name will be scavenged\&.
4115 .sp .5v
4116 .RE
4117 Default:
4118 \fI\fIdns zone scavenging\fR\fR\fI = \fR\fIno\fR\fI \fR
4119 .RE
4120
4121 dns zone transfer clients allow (G)
4122 .PP
4123 .RS 4
4124 This option specifies the list of IPs authorized to ask for dns zone transfer from bind DLZ module\&.
4125 .sp
4126 The IP list is comma and space separated and specified in the same syntax as used in
4127 \m[blue]\fBhosts allow\fR\m[], specifically including IP address, IP prefixes and IP address masks\&.
4128 .sp
4129 As this is a DNS server option, hostnames are naturally not permitted\&.
4130 .sp
4131 The default behaviour is to deny any request\&. A request will be authorized only if the emitting client is identified in this list, and not in
4132 \m[blue]\fBdns zone transfer clients deny\fR\m[]
4133 .sp
4134 Default:
4135 \fI\fIdns zone transfer clients allow\fR\fR\fI = \fR\fI\fR\fI \fR
4136 .sp
4137 Example:
4138 \fI\fIdns zone transfer clients allow\fR\fR\fI = \fR\fI192\&.168\&.0\&.1\fR\fI \fR
4139 .RE
4140
4141 dns zone transfer clients deny (G)
4142 .PP
4143 .RS 4
4144 This option specifies the list of IPs denied to ask for dns zone transfer from bind DLZ module\&.
4145 .sp
4146 The IP list is comma and space separated and specified in the same syntax as used in
4147 \m[blue]\fBhosts allow\fR\m[], specifically including IP address, IP prefixes and IP address masks\&.
4148 .sp
4149 As this is a DNS server option, hostnames are naturally not permitted\&.
4150 .sp
4151 If a client identified in this list sends a zone transfer request, it will always be denied, even if they are in
4152 \m[blue]\fBdns zone transfer clients allow\fR\m[]\&. This allows the definition of specific denied clients within an authorized subnet\&.
4153 .sp
4154 Default:
4155 \fI\fIdns zone transfer clients deny\fR\fR\fI = \fR\fI\fR\fI \fR
4156 .sp
4157 Example:
4158 \fI\fIdns zone transfer clients deny\fR\fR\fI = \fR\fI192\&.168\&.0\&.1\fR\fI \fR
4159 .RE
4160
4161 domain logons (G)
4162 .PP
4163 .RS 4
4164 This parameter has been deprecated since Samba 4\&.13 and support for NT4\-style domain logons(as distinct from the Samba AD DC) will be removed in a future Samba release\&.
4165 .sp
4166 That is, in the future, the current default of
4167 domain logons = no
4168 will be the enforced behaviour\&.
4169 .sp
4170 If set to
4171 \fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
4172 \m[blue]\fBworkgroup\fR\m[]
4173 it is in\&. This will also cause the Samba server to act as a domain controller for NT4 style domain services\&. For more details on setting up this feature see the Domain Control chapter of the Samba HOWTO Collection\&.
4174 .sp
4175 Default:
4176 \fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR
4177 .RE
4178
4179 domain master (G)
4180 .PP
4181 .RS 4
4182 Tell
4183 \fBsmbd\fR(8)
4184 to enable WAN\-wide browse list collation\&. Setting this option causes
4185 nmbd
4186 to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
4187 \m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
4188 \m[blue]\fBworkgroup\fR\m[]
4189 on broadcast\-isolated subnets will give this
4190 nmbd
4191 their local browse lists, and then ask
4192 \fBsmbd\fR(8)
4193 for a complete copy of the browse list for the whole wide area network\&. Browser clients will then contact their local master browser, and will receive the domain\-wide browse list, instead of just the list for their broadcast\-isolated subnet\&.
4194 .sp
4195 Note that Windows NT Primary Domain Controllers expect to be able to claim this
4196 \m[blue]\fBworkgroup\fR\m[]
4197 specific special NetBIOS name that identifies them as domain master browsers for that
4198 \m[blue]\fBworkgroup\fR\m[]
4199 by default (i\&.e\&. there is no way to prevent a Windows NT PDC from attempting to do this)\&. This means that if this parameter is set and
4200 nmbd
4201 claims the special name for a
4202 \m[blue]\fBworkgroup\fR\m[]
4203 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
4204 .sp
4205 If
4206 \m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
4207 \m[blue]\fBdomain master\fR\m[]
4208 parameter\&. If
4209 \m[blue]\fBdomain logons\fR\m[]
4210 is not enabled (the default setting), then neither will
4211 \m[blue]\fBdomain master\fR\m[]
4212 be enabled by default\&.
4213 .sp
4214 When
4215 \m[blue]\fBdomain logons = Yes\fR\m[]
4216 the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
4217 \m[blue]\fBdomain master = No\fR\m[], Samba will function as a BDC\&. In general, this parameter should be set to \*(AqNo\*(Aq only on a BDC\&.
4218 .sp
4219 Default:
4220 \fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR
4221 .RE
4222
4223 dont descend (S)
4224 .PP
4225 .RS 4
4226 There are certain directories on some systems (e\&.g\&., the
4227 /proc
4228 tree under Linux) that are either not of interest to clients or are infinitely deep (recursive)\&. This parameter allows you to specify a comma\-delimited list of directories that the server should always show as empty\&.
4229 .sp
4230 Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
4231 \&./proc
4232 instead of just
4233 /proc\&. Experimentation is the best policy :\-)
4234 .sp
4235 Default:
4236 \fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR
4237 .sp
4238 Example:
4239 \fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR
4240 .RE
4241
4242 dos charset (G)
4243 .PP
4244 .RS 4
4245 DOS SMB clients assume the server has the same charset as they do\&. This option specifies which charset Samba should use to talk to DOS clients\&.
4246 .sp
4247 The default depends on which charsets you have installed\&. Samba tries to use charset 850 but falls back to ASCII in case it is not available\&. Run
4248 \fBtestparm\fR(1)
4249 to check the default on your system\&.
4250 .sp
4251 \fINo default\fR
4252 .RE
4253
4254 dos filemode (S)
4255 .PP
4256 .RS 4
4257 The default behavior in Samba is to provide UNIX\-like behavior where only the owner of a file/directory is able to change the permissions on it\&. However, this behavior is often confusing to DOS/Windows users\&. Enabling this parameter allows a user who has write access to the file (by whatever means, including an ACL permission) to modify the permissions (including ACL) on it\&. Note that a user belonging to the group owning the file will not be allowed to change permissions if the group is only granted read access\&. Ownership of the file/directory may also be changed\&. Note that using the VFS modules acl_xattr or acl_tdb which store native Windows as meta\-data will automatically turn this option on for any share for which they are loaded, as they require this option to emulate Windows ACLs correctly\&.
4258 .sp
4259 Default:
4260 \fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR
4261 .RE
4262
4263 dos filetime resolution (S)
4264 .PP
4265 .RS 4
4266 Under the DOS and Windows FAT filesystem, the finest granularity on time resolution is two seconds\&. Setting this parameter for a share causes Samba to round the reported time down to the nearest two second boundary when a query call that requires one second resolution is made to
4267 \fBsmbd\fR(8)\&.
4268 .sp
4269 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\&. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read\&. One of these calls uses a one\-second granularity, the other uses a two second granularity\&. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed\&. Setting this option causes the two timestamps to match, and Visual C++ is happy\&.
4270 .sp
4271 Default:
4272 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR
4273 .RE
4274
4275 dos filetimes (S)
4276 .PP
4277 .RS 4
4278 Under DOS and Windows, if a user can write to a file they can change the timestamp on it\&. Under POSIX semantics, only the owner of the file or root may change the timestamp\&. By default, Samba emulates the DOS semantics and allows one to change the timestamp on a file if the user
4279 smbd
4280 is acting on behalf has write permissions\&. Due to changes in Microsoft Office 2000 and beyond, the default for this parameter has been changed from "no" to "yes" in Samba 3\&.0\&.14 and above\&. Microsoft Excel will display dialog box warnings about the file being changed by another user if this parameter is not set to "yes" and files are being shared between users\&.
4281 .sp
4282 Default:
4283 \fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR
4284 .RE
4285
4286 dsdb event notification (G)
4287 .PP
4288 .RS 4
4289 When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream Samba database events across the internal message bus\&. Scripts built using Samba\*(Aqs python bindings can listen to these events by registering as the service
4290 dsdb_event\&.
4291 .sp
4292 This is
4293 \fInot\fR
4294 needed for the audit logging described in
4295 \m[blue]\fBlog level\fR\m[]\&.
4296 .sp
4297 Instead, this should instead be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around)\&.
4298 .sp
4299 The Samba database events are also logged via the normal logging methods when the
4300 \m[blue]\fBlog level\fR\m[]
4301 is set appropriately, say to
4302 dsdb_json_audit:5\&.
4303 .sp
4304 Default:
4305 \fI\fIdsdb event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4306 .RE
4307
4308 dsdb group change notification (G)
4309 .PP
4310 .RS 4
4311 When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream group membership change events across the internal message bus\&. Scripts built using Samba\*(Aqs python bindings can listen to these events by registering as the service
4312 dsdb_group_event\&.
4313 .sp
4314 This is
4315 \fInot\fR
4316 needed for the audit logging described in
4317 \m[blue]\fBlog level\fR\m[]\&.
4318 .sp
4319 Instead, this should instead be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around)\&.
4320 .sp
4321 The Samba database events are also logged via the normal logging methods when the
4322 \m[blue]\fBlog level\fR\m[]
4323 is set appropriately, say to
4324 dsdb_group_json_audit:5\&.
4325 .sp
4326 Default:
4327 \fI\fIdsdb group change notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4328 .RE
4329
4330 dsdb password event notification (G)
4331 .PP
4332 .RS 4
4333 When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream password change and reset events across the internal message bus\&. Scripts built using Samba\*(Aqs python bindings can listen to these events by registering as the service
4334 password_event\&.
4335 .sp
4336 This is
4337 \fInot\fR
4338 needed for the audit logging described in
4339 \m[blue]\fBlog level\fR\m[]\&.
4340 .sp
4341 Instead, this should instead be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around)\&.
4342 .sp
4343 The Samba database events are also logged via the normal logging methods when the
4344 \m[blue]\fBlog level\fR\m[]
4345 is set appropriately, say to
4346 dsdb_password_json_audit:5\&.
4347 .sp
4348 Default:
4349 \fI\fIdsdb password event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4350 .RE
4351
4352 durable handles (S)
4353 .PP
4354 .RS 4
4355 This boolean parameter controls whether Samba can grant SMB2 durable file handles on a share\&.
4356 .sp
4357 Note that durable handles are only enabled if
4358 \m[blue]\fBkernel oplocks = no\fR\m[],
4359 \m[blue]\fBkernel share modes = no\fR\m[], and
4360 \m[blue]\fBposix locking = no\fR\m[], i\&.e\&. if the share is configured for CIFS/SMB2 only access, not supporting interoperability features with local UNIX processes or NFS operations\&.
4361 .sp
4362 Also note that, for the time being, durability is not granted for a handle that has the delete on close flag set\&.
4363 .sp
4364 Default:
4365 \fI\fIdurable handles\fR\fR\fI = \fR\fIyes\fR\fI \fR
4366 .RE
4367
4368 ea support (S)
4369 .PP
4370 .RS 4
4371 This boolean parameter controls whether
4372 \fBsmbd\fR(8)
4373 will allow clients to attempt to access extended attributes on a share\&. In order to enable this parameter on a setup with default VFS modules:
4374 .RS
4375 .sp
4376 .RS 4
4377 .ie n \{\
4378 \h'-04'\(bu\h'+03'\c
4379 .\}
4380 .el \{\
4381 .sp -1
4382 .IP \(bu 2.3
4383 .\}
4384 Samba must have been built with extended attributes support\&.
4385 .RE
4386 .sp
4387 .RS 4
4388 .ie n \{\
4389 \h'-04'\(bu\h'+03'\c
4390 .\}
4391 .el \{\
4392 .sp -1
4393 .IP \(bu 2.3
4394 .\}
4395 The underlying filesystem exposed by the share must support extended attributes (e\&.g\&. the getfattr(1)
4396 / setfattr(1)
4397 utilities must work)\&.
4398 .RE
4399 .sp
4400 .RS 4
4401 .ie n \{\
4402 \h'-04'\(bu\h'+03'\c
4403 .\}
4404 .el \{\
4405 .sp -1
4406 .IP \(bu 2.3
4407 .\}
4408 Access to extended user attributes must be allowed by the underlying filesystem (e\&.g\&. when mounted with a system\-dependent option like user_xattr on Linux)\&.
4409 .RE
4410 .sp
4411 .RE
4412 This option exposes the "user" attribute namespace from the underlying filesystem to clients\&. In order to match Windows conventions, the namespace prefix ("user\&.") is stripped from the attribute name on the client side\&. The handling of further attribute namespaces (like "security", "system", or "trusted") is not affected by this option\&.
4413 .sp
4414 Note that the SMB protocol allows setting attributes whose value is 64K bytes long, and that on NTFS, the maximum storage space for extended attributes per file is 64K\&. On some filesystem the limits may be lower\&. Filesystems with too limited EA space may experience unexpected weird effects\&. The default has changed to yes in Samba release 4\&.9\&.0 and above to allow better Windows fileserver compatibility in a default install\&.
4415 .sp
4416 Default:
4417 \fI\fIea support\fR\fR\fI = \fR\fIyes\fR\fI \fR
4418 .RE
4419
4420 elasticsearch:address (S)
4421 .PP
4422 .RS 4
4423 Specifies the name of the Elasticsearch server to use for Spotlight queries when using the Elasticsearch backend\&.
4424 .sp
4425 Default:
4426 \fI\fIelasticsearch:address\fR\fR\fI = \fR\fIlocalhost\fR\fI \fR
4427 .sp
4428 Example:
4429 \fI\fIelasticsearch:address\fR\fR\fI = \fR\fIneedle\&.haystack\&.samba\&.org\fR\fI \fR
4430 .RE
4431
4432 elasticsearch:default_fields (G)
4433 .PP
4434 .RS 4
4435 Default attributes in Elasticsearch to query when receiving a Spotlight query that searches in the special attribute "*"\&. This is the default used by macOS clients when searching from the Finder\&.
4436 .sp
4437 This option expects a list of Elasticsearch attributes separated by comma where each attributes must be enclosed in double quotes\&.
4438 .sp
4439 Default:
4440 \fI\fIelasticsearch:default_fields\fR\fR\fI = \fR\fI"file\&.filename", "content"\fR\fI \fR
4441 .sp
4442 Example:
4443 \fI\fIelasticsearch:default_fields\fR\fR\fI = \fR\fI"foo", "bar"\fR\fI \fR
4444 .RE
4445
4446 elasticsearch:force substring search (G)
4447 .PP
4448 .RS 4
4449 Force string searches in string attributes likes paths to be prefix searches by prefixing a *\&. Example: a Spotlight search for \*(Aq*=="samba*"\*(Aq would be mapped to "\*(Aqquery\*(Aq: \*(Aq(*samba*)\*(Aq" instead of "\*(Aqquery\*(Aq: \*(Aq(samba*)\*(Aq"\&.
4450 .sp
4451 Default:
4452 \fI\fIelasticsearch:force substring search\fR\fR\fI = \fR\fIno\fR\fI \fR
4453 .sp
4454 Example:
4455 \fI\fIelasticsearch:force substring search\fR\fR\fI = \fR\fIyes\fR\fI \fR
4456 .RE
4457
4458 elasticsearch:ignore unknown attribute (G)
4459 .PP
4460 .RS 4
4461 Ignore unknown Spotlight attributes in search queries\&. An example query using the unsupported attribute
4462 "kMDItemTopic"
4463 would be
4464 kMDItemTopic=="hotstuff"\&. By default any query using such a type would completely fail\&. By enabling this option, if the type match is a subexpression of a larger expression, then this subexpression is just ignored\&.
4465 .sp
4466 Default:
4467 \fI\fIelasticsearch:ignore unknown attribute\fR\fR\fI = \fR\fIno\fR\fI \fR
4468 .sp
4469 Example:
4470 \fI\fIelasticsearch:ignore unknown attribute\fR\fR\fI = \fR\fIyes\fR\fI \fR
4471 .RE
4472
4473 elasticsearch:ignore unknown type (G)
4474 .PP
4475 .RS 4
4476 Ignore unknown Spotlight types in search queries\&. An example query using the unsupported type
4477 "public\&.calendar\-event"
4478 would be
4479 kMDItemContentType=="public\&.calendar\-event"\&. By default any query using such a type would completely fail\&. By enabling this option, if the type match is a subexpression of a larger expression, then this subexpression is just ignored\&.
4480 .sp
4481 Default:
4482 \fI\fIelasticsearch:ignore unknown type\fR\fR\fI = \fR\fIno\fR\fI \fR
4483 .sp
4484 Example:
4485 \fI\fIelasticsearch:ignore unknown type\fR\fR\fI = \fR\fIyes\fR\fI \fR
4486 .RE
4487
4488 elasticsearch:index (S)
4489 .PP
4490 .RS 4
4491 Specifies the name of the Elasticsearch index to use for Spotlight queries when using the Elasticsearch backend\&. The default value of "_all" is a special Elasticsearch value that performs the search operation on all indices\&.
4492 .sp
4493 Default:
4494 \fI\fIelasticsearch:index\fR\fR\fI = \fR\fI_all\fR\fI \fR
4495 .sp
4496 Example:
4497 \fI\fIelasticsearch:index\fR\fR\fI = \fR\fIspotlight\fR\fI \fR
4498 .RE
4499
4500 elasticsearch:mappings (G)
4501 .PP
4502 .RS 4
4503 Path to a file specifying metadata attribute mappings in JSON format\&. Use by the Elasticsearch backend of the Spotlight RPC service\&.
4504 .sp
4505 Default:
4506 \fI\fIelasticsearch:mappings\fR\fR\fI = \fR\fI/usr/share/samba/elasticsearch_mappings\&.json\fR\fI \fR
4507 .sp
4508 Example:
4509 \fI\fIelasticsearch:mappings\fR\fR\fI = \fR\fI/usr/share/foo/mymappings\&.json\fR\fI \fR
4510 .RE
4511
4512 elasticsearch:max results (S)
4513 .PP
4514 .RS 4
4515 Path to a file specifying metadata attribute mappings in JSON format\&. Used by the Elasticsearch backend of the Spotlight RPC service\&. A value of 0 means no limit\&.
4516 .sp
4517 Default:
4518 \fI\fIelasticsearch:max results\fR\fR\fI = \fR\fI100\fR\fI \fR
4519 .sp
4520 Example:
4521 \fI\fIelasticsearch:max results\fR\fR\fI = \fR\fI10\fR\fI \fR
4522 .RE
4523
4524 elasticsearch:port (S)
4525 .PP
4526 .RS 4
4527 Specifies the TCP port of the Elasticsearch server to use for Spotlight queries when using the Elasticsearch backend\&.
4528 .sp
4529 Default:
4530 \fI\fIelasticsearch:port\fR\fR\fI = \fR\fI9200\fR\fI \fR
4531 .sp
4532 Example:
4533 \fI\fIelasticsearch:port\fR\fR\fI = \fR\fI9201\fR\fI \fR
4534 .RE
4535
4536 elasticsearch:use tls (S)
4537 .PP
4538 .RS 4
4539 Specifies whether to use HTTPS when talking to the Elasticsearch server used for Spotlight queries when using the Elasticsearch backend\&.
4540 .sp
4541 Default:
4542 \fI\fIelasticsearch:use tls\fR\fR\fI = \fR\fIno\fR\fI \fR
4543 .sp
4544 Example:
4545 \fI\fIelasticsearch:use tls\fR\fR\fI = \fR\fIyes\fR\fI \fR
4546 .RE
4547
4548 enable asu support (G)
4549 .PP
4550 .RS 4
4551 Hosts running the "Advanced Server for Unix (ASU)" product require some special accommodations such as creating a builtin [ADMIN$] share that only supports IPC connections\&. The has been the default behavior in smbd for many years\&. However, certain Microsoft applications such as the Print Migrator tool require that the remote server support an [ADMIN$] file share\&. Disabling this parameter allows for creating an [ADMIN$] file share in smb\&.conf\&.
4552 .sp
4553 Default:
4554 \fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR
4555 .RE
4556
4557 enable core files (G)
4558 .PP
4559 .RS 4
4560 This parameter specifies whether core dumps should be written on internal exits\&. Normally set to
4561 \fByes\fR\&. You should never need to change this\&.
4562 .sp
4563 Default:
4564 \fI\fIenable core files\fR\fR\fI = \fR\fIyes\fR\fI \fR
4565 .sp
4566 Example:
4567 \fI\fIenable core files\fR\fR\fI = \fR\fIno\fR\fI \fR
4568 .RE
4569
4570 enable privileges (G)
4571 .PP
4572 .RS 4
4573 This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
4574 net rpc rights
4575 or one of the Windows user and group manager tools\&. This parameter is enabled by default\&. It can be disabled to prevent members of the Domain Admins group from being able to assign privileges to users or groups which can then result in certain smbd operations running as root that would normally run under the context of the connected user\&.
4576 .sp
4577 An example of how privileges can be used is to assign the right to join clients to a Samba controlled domain without providing root access to the server via smbd\&.
4578 .sp
4579 Please read the extended description provided in the Samba HOWTO documentation\&.
4580 .sp
4581 Default:
4582 \fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR
4583 .RE
4584
4585 enable spoolss (G)
4586 .PP
4587 .RS 4
4588 Inverted synonym for
4589 \m[blue]\fBdisable spoolss\fR\m[]\&.
4590 .sp
4591 Default:
4592 \fI\fIenable spoolss\fR\fR\fI = \fR\fIyes\fR\fI \fR
4593 .RE
4594
4595 encrypt passwords (G)
4596 .PP
4597 .RS 4
4598 This parameter has been deprecated since Samba 4\&.11 and support for plaintext (as distinct from NTLM, NTLMv2 or Kerberos authentication) will be removed in a future Samba release\&.
4599 .sp
4600 That is, in the future, the current default of
4601 encrypt passwords = yes
4602 will be the enforced behaviour\&.
4603 .sp
4604 This boolean controls whether encrypted passwords will be negotiated with the client\&. Note that Windows NT 4\&.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed\&. To use encrypted passwords in Samba see the chapter "User Database" in the Samba HOWTO Collection\&.
4605 .sp
4606 MS Windows clients that expect Microsoft encrypted passwords and that do not have plain text password support enabled will be able to connect only to a Samba server that has encrypted password support enabled and for which the user accounts have a valid encrypted password\&. Refer to the smbpasswd command man page for information regarding the creation of encrypted passwords for user accounts\&.
4607 .sp
4608 The use of plain text passwords is NOT advised as support for this feature is no longer maintained in Microsoft Windows products\&. If you want to use plain text passwords you must set this parameter to no\&.
4609 .sp
4610 In order for encrypted passwords to work correctly
4611 \fBsmbd\fR(8)
4612 must either have access to a local
4613 \fBsmbpasswd\fR(5)
4614 file (see the
4615 \fBsmbpasswd\fR(8)
4616 program for information on how to set up and maintain this file), or set the
4617 \m[blue]\fBsecurity = [domain|ads]\fR\m[]
4618 parameter which causes
4619 smbd
4620 to authenticate against another server\&.
4621 .sp
4622 Default:
4623 \fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR
4624 .RE
4625
4626 enhanced browsing (G)
4627 .PP
4628 .RS 4
4629 This option enables a couple of enhancements to cross\-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations\&.
4630 .sp
4631 The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs\&. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs\&.
4632 .sp
4633 You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists\&. Due to the restrictions of the browse protocols, these enhancements can cause a empty workgroup to stay around forever which can be annoying\&.
4634 .sp
4635 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
4636 .sp
4637 Default:
4638 \fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR
4639 .RE
4640
4641 enumports command (G)
4642 .PP
4643 .RS 4
4644 The concept of a "port" is fairly foreign to UNIX hosts\&. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i\&.e\&. LPT1:, COM1:, FILE:) or a remote port (i\&.e\&. LPD Port Monitor, etc\&.\&.\&.)\&. By default, Samba has only one port defined\-\-\fB"Samba Printer Port"\fR\&. Under Windows NT/2000, all printers must have a valid port name\&. If you wish to have a list of ports displayed (smbd
4645 does not use a port name for anything) other than the default
4646 \fB"Samba Printer Port"\fR, you can define
4647 \fIenumports command\fR
4648 to point to a program which should generate a list of ports, one per line, to standard output\&. This listing will then be used in response to the level 1 and 2 EnumPorts() RPC\&.
4649 .sp
4650 Default:
4651 \fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR
4652 .sp
4653 Example:
4654 \fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR
4655 .RE
4656
4657 eventlog list (G)
4658 .PP
4659 .RS 4
4660 This option defines a list of log names that Samba will report to the Microsoft EventViewer utility\&. The listed eventlogs will be associated with tdb file on disk in the
4661 $(statedir)/eventlog\&.
4662 .sp
4663 The administrator must use an external process to parse the normal Unix logs such as
4664 /var/log/messages
4665 and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
4666 .sp
4667 Default:
4668 \fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR
4669 .sp
4670 Example:
4671 \fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR
4672 .RE
4673
4674 fake directory create times (S)
4675 .PP
4676 .RS 4
4677 NTFS and Windows VFAT file systems keep a create time for all files and directories\&. This is not the same as the ctime \- status change time \- that Unix keeps, so Samba by default reports the earliest of the various times Unix does keep\&. Setting this parameter for a share causes Samba to always report midnight 1\-1\-1980 as the create time for directories\&.
4678 .sp
4679 This option is mainly used as a compatibility option for Visual C++ when used against Samba shares\&. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory\&. Also, when NMAKE compares timestamps it uses the creation time when examining a directory\&. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains\&.
4680 .sp
4681 However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or deleted in the directory\&. NMAKE finds all object files in the object directory\&. The timestamp of the last one built is then compared to the timestamp of the object directory\&. If the directory\*(Aqs timestamp if newer, then all object files will be rebuilt\&. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected\&.
4682 .sp
4683 Default:
4684 \fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR
4685 .RE
4686
4687 fake oplocks (S)
4688 .PP
4689 .RS 4
4690 Oplocks are the way that SMB clients get permission from a server to locally cache file operations\&. If a server grants an oplock (opportunistic lock) then the client is free to assume that it is the only one accessing the file and it will aggressively cache file data\&. With some oplock types the client may even cache file open/close operations\&. This can give enormous performance benefits\&.
4691 .sp
4692 When you set
4693 fake oplocks = yes,
4694 \fBsmbd\fR(8)
4695 will always grant oplock requests no matter how many clients are using the file\&.
4696 .sp
4697 It is generally much better to use the real
4698 \m[blue]\fBoplocks\fR\m[]
4699 support rather than this parameter\&.
4700 .sp
4701 If you enable this option on all read\-only shares or shares that you know will only be accessed from one client at a time such as physically read\-only media like CDROMs, you will see a big performance improvement on many operations\&. If you enable this option on shares where multiple clients may be accessing the files read\-write at the same time you can get data corruption\&. Use this option carefully!
4702 .sp
4703 Default:
4704 \fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
4705 .RE
4706
4707 follow symlinks (S)
4708 .PP
4709 .RS 4
4710 This parameter allows the Samba administrator to stop
4711 \fBsmbd\fR(8)
4712 from following symbolic links in a particular share\&. Setting this parameter to
4713 \fBno\fR
4714 prevents any file or directory that is a symbolic link from being followed (the user will get an error)\&. This option is very useful to stop users from adding a symbolic link to
4715 /etc/passwd
4716 in their home directory for instance\&. However it will slow filename lookups down slightly\&.
4717 .sp
4718 This option is enabled (i\&.e\&.
4719 smbd
4720 will follow symbolic links) by default\&.
4721 .sp
4722 Default:
4723 \fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR
4724 .RE
4725
4726 smbd force process locks (S)
4727 .PP
4728 .RS 4
4729 This boolean option tells
4730 smbd
4731 whether to forcefully disable the use of Open File Description locks on Linux\&.
4732 .sp
4733 This option should not be changed from the default unless you know what you\*(Aqre doing\&.
4734 .sp
4735 Default:
4736 \fI\fIsmbd force process locks\fR\fR\fI = \fR\fIno\fR\fI \fR
4737 .RE
4738
4739 force create mode (S)
4740 .PP
4741 .RS 4
4742 This parameter specifies a set of UNIX mode bit permissions that will
4743 \fIalways\fR
4744 be set on a file created by Samba\&. This is done by bitwise \*(AqOR\*(Aqing these bits onto the mode bits of a file that is being created\&. The default for this parameter is (in octal) 000\&. The modes in this parameter are bitwise \*(AqOR\*(Aqed onto the file mode after the mask set in the
4745 \fIcreate mask\fR
4746 parameter is applied\&.
4747 .sp
4748 The example below would force all newly created files to have read and execute permissions set for \*(Aqgroup\*(Aq and \*(Aqother\*(Aq as well as the read/write/execute bits set for the \*(Aquser\*(Aq\&.
4749 .sp
4750 Default:
4751 \fI\fIforce create mode\fR\fR\fI = \fR\fI0000\fR\fI \fR
4752 .sp
4753 Example:
4754 \fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
4755 .RE
4756
4757 force directory mode (S)
4758 .PP
4759 .RS 4
4760 This parameter specifies a set of UNIX mode bit permissions that will
4761 \fIalways\fR
4762 be set on a directory created by Samba\&. This is done by bitwise \*(AqOR\*(Aqing these bits onto the mode bits of a directory that is being created\&. The default for this parameter is (in octal) 0000 which will not add any extra permission bits to a created directory\&. This operation is done after the mode mask in the parameter
4763 \fIdirectory mask\fR
4764 is applied\&.
4765 .sp
4766 The example below would force all created directories to have read and execute permissions set for \*(Aqgroup\*(Aq and \*(Aqother\*(Aq as well as the read/write/execute bits set for the \*(Aquser\*(Aq\&.
4767 .sp
4768 Default:
4769 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0000\fR\fI \fR
4770 .sp
4771 Example:
4772 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
4773 .RE
4774
4775 force directory security mode (S)
4776 .PP
4777 .RS 4
4778 This parameter has been removed for Samba 4\&.0\&.0\&.
4779 .sp
4780 \fINo default\fR
4781 .RE
4782
4783 group
4784 .PP
4785 .RS 4
4786 This parameter is a synonym for
4787 force group\&.
4788 .RE
4789
4790 force group (S)
4791 .PP
4792 .RS 4
4793 This specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service\&. This is useful for sharing files by ensuring that all access to files on service will use the named group for their permissions checking\&. Thus, by assigning permissions for this group to the files and directories within this service the Samba administrator can restrict or allow sharing of these files\&.
4794 .sp
4795 In Samba 2\&.0\&.5 and above this parameter has extended functionality in the following way\&. If the group name listed here has a \*(Aq+\*(Aq character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group\&. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group\&. This gives a finer granularity of ownership assignment\&. For example, the setting
4796 force group = +sys
4797 means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share\&. All other users will retain their ordinary primary group\&.
4798 .sp
4799 If the
4800 \m[blue]\fBforce user\fR\m[]
4801 parameter is also set the group specified in
4802 \fIforce group\fR
4803 will override the primary group set in
4804 \fIforce user\fR\&.
4805 .sp
4806 Default:
4807 \fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR
4808 .sp
4809 Example:
4810 \fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR
4811 .RE
4812
4813 force printername (S)
4814 .PP
4815 .RS 4
4816 When printing from Windows NT (or later), each printer in
4817 smb\&.conf
4818 has two associated names which can be used by the client\&. The first is the sharename (or shortname) defined in smb\&.conf\&. This is the only printername available for use by Windows 9x clients\&. The second name associated with a printer can be seen when browsing to the "Printers" (or "Printers and Faxes") folder on the Samba server\&. This is referred to simply as the printername (not to be confused with the
4819 \fIprinter name\fR
4820 option)\&.
4821 .sp
4822 When assigning a new driver to a printer on a remote Windows compatible print server such as Samba, the Windows client will rename the printer to match the driver name just uploaded\&. This can result in confusion for users when multiple printers are bound to the same driver\&. To prevent Samba from allowing the printer\*(Aqs printername to differ from the sharename defined in smb\&.conf, set
4823 \fIforce printername = yes\fR\&.
4824 .sp
4825 Be aware that enabling this parameter may affect migrating printers from a Windows server to Samba since Windows has no way to force the sharename and printername to match\&.
4826 .sp
4827 It is recommended that this parameter\*(Aqs value not be changed once the printer is in use by clients as this could cause a user not be able to delete printer connections from their local Printers folder\&.
4828 .sp
4829 Default:
4830 \fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR
4831 .RE
4832
4833 force security mode (S)
4834 .PP
4835 .RS 4
4836 This parameter has been removed for Samba 4\&.0\&.0\&.
4837 .sp
4838 \fINo default\fR
4839 .RE
4840
4841 force unknown acl user (S)
4842 .PP
4843 .RS 4
4844 If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or representation of a user or group id) as the owner or group owner of the file will be silently mapped into the current UNIX uid or gid of the currently connected user\&.
4845 .sp
4846 This is designed to allow Windows NT clients to copy files and folders containing ACLs that were created locally on the client machine and contain users local to that machine only (no domain users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and groupid of the file owner map to the current connected user\&. This can only be fixed correctly when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid\&.
4847 .sp
4848 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
4849 .sp
4850 Default:
4851 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR
4852 .RE
4853
4854 force user (S)
4855 .PP
4856 .RS 4
4857 This specifies a UNIX user name that will be assigned as the default user for all users connecting to this service\&. This is useful for sharing files\&. You should also use it carefully as using it incorrectly can cause security problems\&.
4858 .sp
4859 This user name only gets used once a connection is established\&. Thus clients still need to connect as a valid user and supply a valid password\&. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected as\&. This can be very useful\&.
4860 .sp
4861 In Samba 2\&.0\&.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity\&. Prior to 2\&.0\&.5 the primary group was left as the primary group of the connecting user (this was a bug)\&.
4862 .sp
4863 Default:
4864 \fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR
4865 .sp
4866 Example:
4867 \fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR
4868 .RE
4869
4870 fss: prune stale (G)
4871 .PP
4872 .RS 4
4873 When enabled, Samba\*(Aqs File Server Remote VSS Protocol (FSRVP) server checks all FSRVP initiated snapshots on startup, and removes any corresponding state (including share definitions) for nonexistent snapshot paths\&.
4874 .sp
4875 Default:
4876 \fI\fIfss: prune stale\fR\fR\fI = \fR\fIno\fR\fI \fR
4877 .sp
4878 Example:
4879 \fI\fIfss: prune stale\fR\fR\fI = \fR\fIyes\fR\fI \fR
4880 .RE
4881
4882 fss: sequence timeout (G)
4883 .PP
4884 .RS 4
4885 The File Server Remote VSS Protocol (FSRVP) server includes a message sequence timer to ensure cleanup on unexpected client disconnect\&. This parameter overrides the default timeout between FSRVP operations\&. FSRVP timeouts can be completely disabled via a value of 0\&.
4886 .sp
4887 Default:
4888 \fI\fIfss: sequence timeout\fR\fR\fI = \fR\fI180 or 1800, depending on operation\fR\fI \fR
4889 .sp
4890 Example:
4891 \fI\fIfss: sequence timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
4892 .RE
4893
4894 fstype (S)
4895 .PP
4896 .RS 4
4897 This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
4898 \fBsmbd\fR(8)
4899 when a client queries the filesystem type for a share\&. The default type is
4900 \fBNTFS\fR
4901 for compatibility with Windows NT but this can be changed to other strings such as
4902 \fBSamba\fR
4903 or
4904 \fBFAT\fR
4905 if required\&.
4906 .sp
4907 Default:
4908 \fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR
4909 .sp
4910 Example:
4911 \fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR
4912 .RE
4913
4914 get quota command (G)
4915 .PP
4916 .RS 4
4917 The
4918 get quota command
4919 should only be used whenever there is no operating system API available from the OS that samba can use\&.
4920 .sp
4921 This option is only available Samba was compiled with quotas support\&.
4922 .sp
4923 This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on\&.
4924 .sp
4925 Such a script is being given 3 arguments:
4926 .RS
4927 .sp
4928 .RS 4
4929 .ie n \{\
4930 \h'-04'\(bu\h'+03'\c
4931 .\}
4932 .el \{\
4933 .sp -1
4934 .IP \(bu 2.3
4935 .\}
4936 directory
4937 .RE
4938 .sp
4939 .RS 4
4940 .ie n \{\
4941 \h'-04'\(bu\h'+03'\c
4942 .\}
4943 .el \{\
4944 .sp -1
4945 .IP \(bu 2.3
4946 .\}
4947 type of query
4948 .RE
4949 .sp
4950 .RS 4
4951 .ie n \{\
4952 \h'-04'\(bu\h'+03'\c
4953 .\}
4954 .el \{\
4955 .sp -1
4956 .IP \(bu 2.3
4957 .\}
4958 uid of user or gid of group
4959 .RE
4960 .sp
4961 .RE
4962 The directory is actually mostly just "\&." \- It needs to be treated relatively to the current working directory that the script can also query\&.
4963 .sp
4964 The type of query can be one of:
4965 .RS
4966 .sp
4967 .RS 4
4968 .ie n \{\
4969 \h'-04'\(bu\h'+03'\c
4970 .\}
4971 .el \{\
4972 .sp -1
4973 .IP \(bu 2.3
4974 .\}
4975 1 \- user quotas
4976 .RE
4977 .sp
4978 .RS 4
4979 .ie n \{\
4980 \h'-04'\(bu\h'+03'\c
4981 .\}
4982 .el \{\
4983 .sp -1
4984 .IP \(bu 2.3
4985 .\}
4986 2 \- user default quotas (uid = \-1)
4987 .RE
4988 .sp
4989 .RS 4
4990 .ie n \{\
4991 \h'-04'\(bu\h'+03'\c
4992 .\}
4993 .el \{\
4994 .sp -1
4995 .IP \(bu 2.3
4996 .\}
4997 3 \- group quotas
4998 .RE
4999 .sp
5000 .RS 4
5001 .ie n \{\
5002 \h'-04'\(bu\h'+03'\c
5003 .\}
5004 .el \{\
5005 .sp -1
5006 .IP \(bu 2.3
5007 .\}
5008 4 \- group default quotas (gid = \-1)
5009 .RE
5010 .sp
5011 .RE
5012 This script should print one line as output with spaces between the columns\&. The printed columns should be:
5013 .RS
5014 .sp
5015 .RS 4
5016 .ie n \{\
5017 \h'-04'\(bu\h'+03'\c
5018 .\}
5019 .el \{\
5020 .sp -1
5021 .IP \(bu 2.3
5022 .\}
5023 1 \- quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
5024 .RE
5025 .sp
5026 .RS 4
5027 .ie n \{\
5028 \h'-04'\(bu\h'+03'\c
5029 .\}
5030 .el \{\
5031 .sp -1
5032 .IP \(bu 2.3
5033 .\}
5034 2 \- number of currently used blocks
5035 .RE
5036 .sp
5037 .RS 4
5038 .ie n \{\
5039 \h'-04'\(bu\h'+03'\c
5040 .\}
5041 .el \{\
5042 .sp -1
5043 .IP \(bu 2.3
5044 .\}
5045 3 \- the softlimit number of blocks
5046 .RE
5047 .sp
5048 .RS 4
5049 .ie n \{\
5050 \h'-04'\(bu\h'+03'\c
5051 .\}
5052 .el \{\
5053 .sp -1
5054 .IP \(bu 2.3
5055 .\}
5056 4 \- the hardlimit number of blocks
5057 .RE
5058 .sp
5059 .RS 4
5060 .ie n \{\
5061 \h'-04'\(bu\h'+03'\c
5062 .\}
5063 .el \{\
5064 .sp -1
5065 .IP \(bu 2.3
5066 .\}
5067 5 \- currently used number of inodes
5068 .RE
5069 .sp
5070 .RS 4
5071 .ie n \{\
5072 \h'-04'\(bu\h'+03'\c
5073 .\}
5074 .el \{\
5075 .sp -1
5076 .IP \(bu 2.3
5077 .\}
5078 6 \- the softlimit number of inodes
5079 .RE
5080 .sp
5081 .RS 4
5082 .ie n \{\
5083 \h'-04'\(bu\h'+03'\c
5084 .\}
5085 .el \{\
5086 .sp -1
5087 .IP \(bu 2.3
5088 .\}
5089 7 \- the hardlimit number of inodes
5090 .RE
5091 .sp
5092 .RS 4
5093 .ie n \{\
5094 \h'-04'\(bu\h'+03'\c
5095 .\}
5096 .el \{\
5097 .sp -1
5098 .IP \(bu 2.3
5099 .\}
5100 8 (optional) \- the number of bytes in a block(default is 1024)
5101 .RE
5102 .sp
5103 .RE
5104 Default:
5105 \fI\fIget quota command\fR\fR\fI = \fR\fI\fR\fI \fR
5106 .sp
5107 Example:
5108 \fI\fIget quota command\fR\fR\fI = \fR\fI/usr/local/sbin/query_quota\fR\fI \fR
5109 .RE
5110
5111 getwd cache (G)
5112 .PP
5113 .RS 4
5114 This is a tuning option\&. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls\&. This can have a significant impact on performance, especially when the
5115 \m[blue]\fBwide links\fR\m[]
5116 parameter is set to
5117 \fBno\fR\&.
5118 .sp
5119 Default:
5120 \fI\fIgetwd cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
5121 .RE
5122
5123 gpo update command (G)
5124 .PP
5125 .RS 4
5126 This option sets the command that is called to apply GPO policies\&. The samba\-gpupdate script applies System Access and Kerberos Policies to the KDC\&. System Access policies set minPwdAge, maxPwdAge, minPwdLength, and pwdProperties in the samdb\&. Kerberos Policies set kdc:service ticket lifetime, kdc:user ticket lifetime, and kdc:renewal lifetime in smb\&.conf\&.
5127 .sp
5128 Default:
5129 \fI\fIgpo update command\fR\fR\fI = \fR\fI/builddir/build/BUILD/samba\-4\&.24\&.0\-build/samba\-4\&.24\&.0/source4/scripting/bin/samba\-gpupdate\fR\fI \fR
5130 .sp
5131 Example:
5132 \fI\fIgpo update command\fR\fR\fI = \fR\fI/usr/local/sbin/gpoupdate\fR\fI \fR
5133 .RE
5134
5135 guest account (G)
5136 .PP
5137 .RS 4
5138 This is a username which will be used for access to services which are specified as
5139 \m[blue]\fBguest ok\fR\m[]
5140 (see below)\&. Whatever privileges this user has will be available to any client connecting to the guest service\&. This user must exist in the password file, but does not require a valid login\&. The user account "ftp" is often a good choice for this parameter\&.
5141 .sp
5142 On some systems the default guest account "nobody" may not be able to print\&. Use another account in this case\&. You should test this by trying to log in as your guest user (perhaps by using the
5143 su \-
5144 command) and trying to print using the system print command such as
5145 lpr(1)
5146 or
5147 lp(1)\&.
5148 .sp
5149 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
5150 .sp
5151 Default:
5152 \fI\fIguest account\fR\fR\fI = \fR\fInobody # default can be changed at compile\-time\fR\fI \fR
5153 .sp
5154 Example:
5155 \fI\fIguest account\fR\fR\fI = \fR\fIftp\fR\fI \fR
5156 .RE
5157
5158 public
5159 .PP
5160 .RS 4
5161 This parameter is a synonym for
5162 guest ok\&.
5163 .RE
5164
5165 guest ok (S)
5166 .PP
5167 .RS 4
5168 If this parameter is
5169 \fByes\fR
5170 for a service, then no password is required to connect to the service\&. Privileges will be those of the
5171 \m[blue]\fBguest account\fR\m[]\&.
5172 .sp
5173 This parameter nullifies the benefits of setting
5174 \m[blue]\fBrestrict anonymous = 2\fR\m[]
5175 .sp
5176 See the section below on
5177 \m[blue]\fBsecurity\fR\m[]
5178 for more information about this option\&.
5179 .sp
5180 Default:
5181 \fI\fIguest ok\fR\fR\fI = \fR\fIno\fR\fI \fR
5182 .RE
5183
5184 only guest
5185 .PP
5186 .RS 4
5187 This parameter is a synonym for
5188 guest only\&.
5189 .RE
5190
5191 guest only (S)
5192 .PP
5193 .RS 4
5194 If this parameter is
5195 \fByes\fR
5196 for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
5197 \m[blue]\fBguest ok\fR\m[]
5198 is not set for the service\&.
5199 .sp
5200 See the section below on
5201 \m[blue]\fBsecurity\fR\m[]
5202 for more information about this option\&.
5203 .sp
5204 Default:
5205 \fI\fIguest only\fR\fR\fI = \fR\fIno\fR\fI \fR
5206 .RE
5207
5208 hide dot files (S)
5209 .PP
5210 .RS 4
5211 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
5212 .sp
5213 Default:
5214 \fI\fIhide dot files\fR\fR\fI = \fR\fIyes\fR\fI \fR
5215 .RE
5216
5217 hide files (S)
5218 .PP
5219 .RS 4
5220 This is a list of files or directories that are not visible but are accessible\&. The DOS \*(Aqhidden\*(Aq attribute is applied to any files or directories that match\&.
5221 .sp
5222 Each entry in the list must be separated by a \*(Aq/\*(Aq, which allows spaces to be included in the entry\&. \*(Aq*\*(Aq and \*(Aq?\*(Aq can be used to specify multiple files or directories as in DOS wildcards\&.
5223 .sp
5224 \m[blue]\fBhide files\fR\m[]
5225 can also be used as a parametric option where NAME in
5226 .sp
5227 hide files : NAME =
5228 .sp
5229 specifies a user or group name with the same syntax as
5230 \m[blue]\fBvalid users\fR\m[]\&. This parametric form can be specified multiple times for different users or groups\&. This means that "hide files : NAME" set both in the [global] and the share section add up, whereas normally options set in a share section overwrite the default in the [global] section\&.
5231 .sp
5232 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \*(Aq/\*(Aq\&.
5233 .sp
5234 Note that the case sensitivity option is applicable in hiding files\&.
5235 .sp
5236 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\&.
5237 .sp
5238 The example shown above is based on files that the Macintosh SMB client (DAVE) available from
5239 Thursby
5240 creates for internal use, and also still hides all files beginning with a dot\&.
5241 .sp
5242 An example of us of this parameter is:
5243 .sp
5244 .if n \{\
5245 .RS 4
5246 .\}
5247 .nf
5248 hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
5249
5250 ; Hide some files for anyone and some files for specific users and groups
5251 hide files = /hideforall1/
5252 hide files : USER = /hidetoforuser/
5253 hide files : GROUP = /hideforgroup/
5254 hide files : UNIVERSITY\eAlumnis = /somefile\&.txt/
5255 hide files : john@university\&.org = /anotherfile\&.txt/
5256 hide files : S\-1\-5\-21\-123\-456\-789\-1000 = /secretfile\&.txt/
5257
5258 .fi
5259 .if n \{\
5260 .RE
5261 .\}
5262 .sp
5263 Default:
5264 \fI\fIhide files\fR\fR\fI = \fR\fI # no file are hidden\fR\fI \fR
5265 .RE
5266
5267 hide new files timeout (S)
5268 .PP
5269 .RS 4
5270 Setting this parameter to something but 0 hides files that have been modified less than N seconds ago\&.
5271 .sp
5272 It can be used for ingest/process queue style workloads\&. A processing application should only see files that are definitely finished\&. As many applications do not have proper external workflow control, this can be a way to make sure processing does not interfere with file ingest\&.
5273 .sp
5274 Default:
5275 \fI\fIhide new files timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
5276 .RE
5277
5278 hide special files (S)
5279 .PP
5280 .RS 4
5281 This parameter prevents clients from seeing special files such as sockets, devices and fifo\*(Aqs in directory listings\&.
5282 .sp
5283 Default:
5284 \fI\fIhide special files\fR\fR\fI = \fR\fIno\fR\fI \fR
5285 .RE
5286
5287 hide unreadable (S)
5288 .PP
5289 .RS 4
5290 This parameter prevents clients from seeing the existence of files that cannot be read\&. Defaults to off\&.
5291 .sp
5292 Please note that enabling this can slow down listing large directories significantly\&. Samba has to evaluate the ACLs of all directory members, which can be a lot of effort\&.
5293 .sp
5294 Default:
5295 \fI\fIhide unreadable\fR\fR\fI = \fR\fIno\fR\fI \fR
5296 .RE
5297
5298 hide unwriteable files (S)
5299 .PP
5300 .RS 4
5301 This parameter prevents clients from seeing the existence of files that cannot be written to\&. Defaults to off\&. Note that unwriteable directories are shown as usual\&.
5302 .sp
5303 Please note that enabling this can slow down listing large directories significantly\&. Samba has to evaluate the ACLs of all directory members, which can be a lot of effort\&.
5304 .sp
5305 Default:
5306 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fIno\fR\fI \fR
5307 .RE
5308
5309 honor change notify privilege (S)
5310 .PP
5311 .RS 4
5312 This option can be used to make use of the change notify privilege\&. By default notify results are not checked against the file system permissions\&.
5313 .sp
5314 If "honor change notify privilege" is enabled, a user will only receive notify results, if he has change notify privilege or sufficient file system permissions\&. If a user has the change notify privilege, he will receive all requested notify results, even if the user does not have the permissions on the file system\&.
5315 .sp
5316 Default:
5317 \fI\fIhonor change notify privilege\fR\fR\fI = \fR\fIno\fR\fI \fR
5318 .RE
5319
5320 host msdfs (G)
5321 .PP
5322 .RS 4
5323 If set to
5324 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
5325 .sp
5326 See also the
5327 \m[blue]\fBmsdfs root\fR\m[]
5328 share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
5329 .sp
5330 Default:
5331 \fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR
5332 .RE
5333
5334 hostname lookups (G)
5335 .PP
5336 .RS 4
5337 Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead\&. An example place where hostname lookups are currently used is when checking the
5338 hosts deny
5339 and
5340 hosts allow\&.
5341 .sp
5342 Default:
5343 \fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR
5344 .sp
5345 Example:
5346 \fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR
5347 .RE
5348
5349 allow hosts
5350 .PP
5351 .RS 4
5352 This parameter is a synonym for
5353 hosts allow\&.
5354 .RE
5355
5356 hosts allow (S)
5357 .PP
5358 .RS 4
5359 A synonym for this parameter is
5360 \m[blue]\fBallow hosts\fR\m[]\&.
5361 .sp
5362 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
5363 .sp
5364 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
5365 .sp
5366 You can specify the hosts by name or IP number\&. For example, you could restrict access to only the hosts on a Class C subnet with something like
5367 allow hosts = 150\&.203\&.5\&.\&. The full syntax of the list is described in the man page
5368 hosts_access(5)\&. Note that this man page may not be present on your system, so a brief description will be given here also\&.
5369 .sp
5370 Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
5371 \m[blue]\fBhosts deny\fR\m[]
5372 option\&.
5373 .sp
5374 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
5375 \fIEXCEPT\fR
5376 keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
5377 .sp
5378 Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
5379 .sp
5380 hosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66
5381 .sp
5382 Example 2: allow hosts that match the given network/netmask
5383 .sp
5384 hosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0
5385 .sp
5386 Example 3: allow a couple of hosts
5387 .sp
5388 hosts allow = lapland, arvidsjaur
5389 .sp
5390 Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
5391 .sp
5392 hosts allow = @foonet
5393 .sp
5394 hosts deny = pirate
5395 .if n \{\
5396 .sp
5397 .\}
5398 .RS 4
5399 .it 1 an-trap
5400 .nr an-no-space-flag 1
5401 .nr an-break-flag 1
5402 .br
5403 .ps +1
5404 \fBNote\fR
5405 .ps -1
5406 .br
5407 Note that access still requires suitable user\-level passwords\&.
5408 .sp .5v
5409 .RE
5410 See
5411 \fBtestparm\fR(1)
5412 for a way of testing your host access to see if it does what you expect\&.
5413 .sp
5414 Default:
5415 \fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\&.e\&., all hosts permitted access)\fR\fI \fR
5416 .sp
5417 Example:
5418 \fI\fIhosts allow\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\fR\fI \fR
5419 .RE
5420
5421 deny hosts
5422 .PP
5423 .RS 4
5424 This parameter is a synonym for
5425 hosts deny\&.
5426 .RE
5427
5428 hosts deny (S)
5429 .PP
5430 .RS 4
5431 The opposite of
5432 \fIhosts allow\fR
5433 \- hosts listed here are
5434 \fINOT\fR
5435 permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
5436 \fIallow\fR
5437 list takes precedence\&.
5438 .sp
5439 In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
5440 0\&.0\&.0\&.0/0) and then explicitly specify to the
5441 \m[blue]\fBhosts allow = hosts allow\fR\m[]
5442 parameter those hosts that should be permitted access\&.
5443 .sp
5444 Default:
5445 \fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\&.e\&., no hosts specifically excluded)\fR\fI \fR
5446 .sp
5447 Example:
5448 \fI\fIhosts deny\fR\fR\fI = \fR\fI150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fR\fI \fR
5449 .RE
5450
5451 idmap backend (G)
5452 .PP
5453 .RS 4
5454 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&.
5455 .sp
5456 This option specifies the default backend that is used when no special configuration set, but it is now deprecated in favour of the new spelling
5457 \m[blue]\fBidmap config * : backend\fR\m[]\&.
5458 .sp
5459 Default:
5460 \fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
5461 .RE
5462
5463 idmap cache time (G)
5464 .PP
5465 .RS 4
5466 This parameter specifies the number of seconds that Winbind\*(Aqs idmap interface will cache positive SID/uid/gid query results\&. By default, Samba will cache these results for one week\&.
5467 .sp
5468 Default:
5469 \fI\fIidmap cache time\fR\fR\fI = \fR\fI604800\fR\fI \fR
5470 .RE
5471
5472 idmap config DOMAIN : OPTION (G)
5473 .PP
5474 .RS 4
5475 ID mapping in Samba is the mapping between Windows SIDs and Unix user and group IDs\&. This is performed by Winbindd with a configurable plugin interface\&. Samba\*(Aqs ID mapping is configured by options starting with the
5476 \m[blue]\fBidmap config\fR\m[]
5477 prefix\&. An idmap option consists of the
5478 \m[blue]\fBidmap config\fR\m[]
5479 prefix, followed by a domain name or the asterisk character (*), a colon, and the name of an idmap setting for the chosen domain\&.
5480 .sp
5481 The idmap configuration is hence divided into groups, one group for each domain to be configured, and one group with the asterisk instead of a proper domain name, which specifies the default configuration that is used to catch all domains that do not have an explicit idmap configuration of their own\&.
5482 .sp
5483 There are three general options available:
5484 .PP
5485 backend = backend_name
5486 .RS 4
5487 This specifies the name of the idmap plugin to use as the SID/uid/gid backend for this domain\&. The standard backends are tdb (\fBidmap_tdb\fR(8)), tdb2 (\fBidmap_tdb2\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), hash (\fBidmap_hash\fR(8)), autorid (\fBidmap_autorid\fR(8)), ad (\fBidmap_ad\fR(8)) and nss (\fBidmap_nss\fR(8))\&. The corresponding manual pages contain the details, but here is a summary\&.
5488 .sp
5489 The first three of these create mappings of their own using internal unixid counters and store the mappings in a database\&. These are suitable for use in the default idmap configuration\&. The rid and hash backends use a pure algorithmic calculation to determine the unixid for a SID\&. The autorid module is a mixture of the tdb and rid backend\&. It creates ranges for each domain encountered and then uses the rid algorithm for each of these automatically configured domains individually\&. The ad backend uses unix ids stored in Active Directory via the standard schema extensions\&. The nss backend reverses the standard winbindd setup and gets the unix ids via names from nsswitch which can be useful in an ldap setup\&.
5490 .RE
5491 .PP
5492 range = low \- high
5493 .RS 4
5494 Defines the available matching uid and gid range for which the backend is authoritative\&. For allocating backends, this also defines the start and the end of the range for allocating new unique IDs\&.
5495 .sp
5496 winbind uses this parameter to find the backend that is authoritative for a unix ID to SID mapping, so it must be set for each individually configured domain and for the default configuration\&. The configured ranges must be mutually disjoint\&.
5497 .sp
5498 Note that the low value interacts with the
5499 \m[blue]\fBmin domain uid\fR\m[]
5500 option!
5501 .RE
5502 .PP
5503 read only = yes|no
5504 .RS 4
5505 This option can be used to turn the writing backends tdb, tdb2, and ldap into read only mode\&. This can be useful e\&.g\&. in cases where a pre\-filled database exists that should not be extended automatically\&.
5506 .RE
5507 .sp
5508 The following example illustrates how to configure the
5509 \fBidmap_ad\fR(8)
5510 backend for the CORP domain and the
5511 \fBidmap_tdb\fR(8)
5512 backend for all other domains\&. This configuration assumes that the admin of CORP assigns unix ids below 1000000 via the SFU extensions, and winbind is supposed to use the next million entries for its own mappings from trusted domains and for local groups for example\&.
5513 .sp
5514 .if n \{\
5515 .RS 4
5516 .\}
5517 .nf
5518 idmap config * : backend = tdb
5519 idmap config * : range = 1000000\-1999999
5520
5521 idmap config CORP : backend = ad
5522 idmap config CORP : range = 1000\-999999
5523
5524 .fi
5525 .if n \{\
5526 .RE
5527 .\}
5528 .sp
5529 \fINo default\fR
5530 .RE
5531
5532 winbind gid
5533 .PP
5534 .RS 4
5535 This parameter is a synonym for
5536 idmap gid\&.
5537 .RE
5538
5539 idmap gid (G)
5540 .PP
5541 .RS 4
5542 The idmap gid parameter specifies the range of group ids for the default idmap configuration\&. It is now deprecated in favour of
5543 \m[blue]\fBidmap config * : range\fR\m[]\&.
5544 .sp
5545 See the
5546 \m[blue]\fBidmap config\fR\m[]
5547 option\&.
5548 .sp
5549 Default:
5550 \fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR
5551 .sp
5552 Example:
5553 \fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
5554 .RE
5555
5556 idmap negative cache time (G)
5557 .PP
5558 .RS 4
5559 This parameter specifies the number of seconds that Winbind\*(Aqs idmap interface will cache negative SID/uid/gid query results\&.
5560 .sp
5561 Default:
5562 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR
5563 .RE
5564
5565 winbind uid
5566 .PP
5567 .RS 4
5568 This parameter is a synonym for
5569 idmap uid\&.
5570 .RE
5571
5572 idmap uid (G)
5573 .PP
5574 .RS 4
5575 The idmap uid parameter specifies the range of user ids for the default idmap configuration\&. It is now deprecated in favour of
5576 \m[blue]\fBidmap config * : range\fR\m[]\&.
5577 .sp
5578 See the
5579 \m[blue]\fBidmap config\fR\m[]
5580 option\&.
5581 .sp
5582 Default:
5583 \fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR
5584 .sp
5585 Example:
5586 \fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
5587 .RE
5588
5589 include (S)
5590 .PP
5591 .RS 4
5592 This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
5593 .sp
5594 It takes the standard substitutions, except
5595 \fI%u\fR,
5596 \fI%P\fR
5597 and
5598 \fI%S\fR\&.
5599 .sp
5600 The parameter
5601 \fIinclude = registry\fR
5602 has a special meaning: It does
5603 \fInot\fR
5604 include a file named
5605 \fIregistry\fR
5606 from the current working directory, but instead reads the global configuration options from the registry\&. See the section on registry\-based configuration for details\&. Note that this option automatically activates registry shares\&.
5607 .sp
5608 Default:
5609 \fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR
5610 .sp
5611 Example:
5612 \fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\&.conf\fR\fI \fR
5613 .RE
5614
5615 include system krb5 conf (G)
5616 .PP
5617 .RS 4
5618 Setting this parameter to
5619 no
5620 will prevent winbind to include the system /etc/krb5\&.conf file into the krb5\&.conf file it creates\&. See also
5621 \m[blue]\fBcreate krb5 conf\fR\m[]\&. This option only applies to Samba built with MIT Kerberos\&.
5622 .sp
5623 Default:
5624 \fI\fIinclude system krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR
5625 .RE
5626
5627 inherit acls (S)
5628 .PP
5629 .RS 4
5630 This parameter is only relevant for filesystems that do not support standardized NFS4 ACLs but only a POSIX draft ACL implementation and which implements default ACLs like most filesystems on Linux\&. It can be used to ensure that if default ACLs exist on parent directories, they are always honored when creating a new file or subdirectory in these parent directories\&. The default behavior is to use the unix mode specified when creating the directory\&. Enabling this option sets the unix mode to 0777, thus guaranteeing that the default directory ACLs are propagated\&. Note that using the VFS modules acl_xattr or acl_tdb which store native Windows as meta\-data will automatically turn this option on for any share for which they are loaded, as they require this option to emulate Windows ACLs correctly\&.
5631 .sp
5632 Default:
5633 \fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR
5634 .RE
5635
5636 inherit owner (S)
5637 .PP
5638 .RS 4
5639 The ownership of new files and directories is normally governed by effective uid of the connected user\&. This option allows the Samba administrator to specify that the ownership for new files and directories should be controlled by the ownership of the parent directory\&.
5640 .sp
5641 Valid options are:
5642 .RS
5643 .sp
5644 .RS 4
5645 .ie n \{\
5646 \h'-04'\(bu\h'+03'\c
5647 .\}
5648 .el \{\
5649 .sp -1
5650 .IP \(bu 2.3
5651 .\}
5652 \fBno\fR
5653 \- Both the Windows (SID) owner and the UNIX (uid) owner of the file are governed by the identity of the user that created the file\&.
5654 .RE
5655 .sp
5656 .RS 4
5657 .ie n \{\
5658 \h'-04'\(bu\h'+03'\c
5659 .\}
5660 .el \{\
5661 .sp -1
5662 .IP \(bu 2.3
5663 .\}
5664 \fBwindows and unix\fR
5665 \- The Windows (SID) owner and the UNIX (uid) owner of new files and directories are set to the respective owner of the parent directory\&.
5666 .RE
5667 .sp
5668 .RS 4
5669 .ie n \{\
5670 \h'-04'\(bu\h'+03'\c
5671 .\}
5672 .el \{\
5673 .sp -1
5674 .IP \(bu 2.3
5675 .\}
5676 \fByes\fR
5677 \- a synonym for
5678 \fBwindows and unix\fR\&.
5679 .RE
5680 .sp
5681 .RS 4
5682 .ie n \{\
5683 \h'-04'\(bu\h'+03'\c
5684 .\}
5685 .el \{\
5686 .sp -1
5687 .IP \(bu 2.3
5688 .\}
5689 \fBunix only\fR
5690 \- Only the UNIX owner is set to the UNIX owner of the parent directory\&.
5691 .RE
5692 .sp
5693 .RE
5694 Common scenarios where this behavior is useful is in implementing drop\-boxes, where users can create and edit files but not delete them and ensuring that newly created files in a user\*(Aqs roaming profile directory are actually owned by the user\&.
5695 .sp
5696 The
5697 \fBunix only\fR
5698 option effectively breaks the tie between the Windows owner of a file and the UNIX owner\&. As a logical consequence, in this mode, setting the Windows owner of a file does not modify the UNIX owner\&. Using this mode should typically be combined with a backing store that can emulate the full NT ACL model without affecting the POSIX permissions, such as the acl_xattr VFS module, coupled with
5699 \m[blue]\fBacl_xattr:ignore system acls = yes\fR\m[]\&. This can be used to emulate folder quotas, when files are exposed only via SMB (without UNIX extensions)\&. The UNIX owner of a directory is locally set and inherited by all subdirectories and files, and they all consume the same quota\&.
5700 .sp
5701 Default:
5702 \fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR
5703 .RE
5704
5705 inherit permissions (S)
5706 .PP
5707 .RS 4
5708 The permissions on new files and directories are normally governed by
5709 \m[blue]\fBcreate mask\fR\m[],
5710 \m[blue]\fBdirectory mask\fR\m[],
5711 \m[blue]\fBforce create mode\fR\m[]
5712 and
5713 \m[blue]\fBforce directory mode\fR\m[]
5714 but the boolean inherit permissions parameter overrides this\&.
5715 .sp
5716 New directories inherit the mode of the parent directory, including bits such as setgid\&.
5717 .sp
5718 New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
5719 \m[blue]\fBmap archive\fR\m[],
5720 \m[blue]\fBmap hidden\fR\m[]
5721 and
5722 \m[blue]\fBmap system\fR\m[]
5723 as usual\&.
5724 .sp
5725 Note that the setuid bit is
5726 \fInever\fR
5727 set via inheritance (the code explicitly prohibits this)\&.
5728 .sp
5729 This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user\&.
5730 .sp
5731 Default:
5732 \fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR
5733 .RE
5734
5735 init logon delay (G)
5736 .PP
5737 .RS 4
5738 This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with
5739 \m[blue]\fBinit logon delayed hosts\fR\m[]\&.
5740 .sp
5741 Default:
5742 \fI\fIinit logon delay\fR\fR\fI = \fR\fI100\fR\fI \fR
5743 .RE
5744
5745 init logon delayed hosts (G)
5746 .PP
5747 .RS 4
5748 This parameter takes a list of host names, addresses or networks for which the initial samlogon reply should be delayed (so other DCs get preferred by XP workstations if there are any)\&.
5749 .sp
5750 The length of the delay can be specified with the
5751 \m[blue]\fBinit logon delay\fR\m[]
5752 parameter\&.
5753 .sp
5754 Default:
5755 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\fR\fI \fR
5756 .sp
5757 Example:
5758 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.de\fR\fI \fR
5759 .RE
5760
5761 interfaces (G)
5762 .PP
5763 .RS 4
5764 This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NetBIOS over TCP/IP (NBT) traffic\&. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127\&.0\&.0\&.1 that are broadcast capable\&.
5765 .sp
5766 The option takes a list of interface strings\&. Each string can be in any of the following forms:
5767 .RS
5768 .sp
5769 .RS 4
5770 .ie n \{\
5771 \h'-04'\(bu\h'+03'\c
5772 .\}
5773 .el \{\
5774 .sp -1
5775 .IP \(bu 2.3
5776 .\}
5777 a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
5778 .RE
5779 .sp
5780 .RS 4
5781 .ie n \{\
5782 \h'-04'\(bu\h'+03'\c
5783 .\}
5784 .el \{\
5785 .sp -1
5786 .IP \(bu 2.3
5787 .\}
5788 an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
5789 .RE
5790 .sp
5791 .RS 4
5792 .ie n \{\
5793 \h'-04'\(bu\h'+03'\c
5794 .\}
5795 .el \{\
5796 .sp -1
5797 .IP \(bu 2.3
5798 .\}
5799 an IP/mask pair\&.
5800 .RE
5801 .sp
5802 .RS 4
5803 .ie n \{\
5804 \h'-04'\(bu\h'+03'\c
5805 .\}
5806 .el \{\
5807 .sp -1
5808 .IP \(bu 2.3
5809 .\}
5810 a broadcast/mask pair\&.
5811 .RE
5812 .sp
5813 .RE
5814 The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form\&.
5815 .sp
5816 The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS\*(Aqs normal hostname resolution mechanisms\&.
5817 .sp
5818 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
5819 .sp
5820 In order to support SMB3 multi\-channel configurations, smbd understands some extra parameters which can be appended after the actual interface with this extended syntax (note that the quoting is important in order to handle the ; and , characters):
5821 .sp
5822 "interface[;key1=value1[,key2=value2[\&.\&.\&.]]]"
5823 .sp
5824 Known keys are speed, capability, if_index and options\&. Speed is specified in bits per second\&. Known capabilities are RSS and RDMA\&. The if_index should be used with care: the values must not coincide with indexes used by the kernel\&. Note that these options are mainly intended for testing and development rather than for production use\&. At least on Linux systems, these values should be auto\-detected, but the settings can serve as last a resort when autodetection is not working or is not available\&. The specified values overwrite the auto\-detected values\&.
5825 .sp
5826 The possible values for options are "dynamic" and "nodynamic"\&. Use this option in combination with setting
5827 \m[blue]\fBbind interfaces only\fR\m[]
5828 Use the "dynamic" to have smbd open/close listening sockets on the interface, when IP addresses are added to or removed from the interface\&. Use the "nodynamic" option to ignore any ip add/remove events for interface\&. Please note that when an IP address is removed, connections to that IP address are also terminated (traditional behaviour has been to keep the TCP flow alive)\&.
5829 .sp
5830 Note that dynamically opening/closing listening sockets is only available on some operating systems (currently Linux)\&.
5831 .sp
5832 The first two example below configures three network interfaces corresponding to the eth0 device and IP addresses 192\&.168\&.2\&.10 and 192\&.168\&.3\&.10\&. The netmasks of the latter two interfaces would be set to 255\&.255\&.255\&.0\&.
5833 .sp
5834 The other examples show how per interface extra parameters can be specified\&. Notice the possible usage of "," and ";", which makes the double quoting necessary\&.
5835 .sp
5836 Default:
5837 \fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR
5838 .sp
5839 Example:
5840 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR
5841 .sp
5842 Example:
5843 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0, 192\&.168\&.2\&.10/24; 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR
5844 .sp
5845 Example:
5846 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;if_index=65,speed=1000000000,capability=RSS"\fR\fI \fR
5847 .sp
5848 Example:
5849 \fI\fIinterfaces\fR\fR\fI = \fR\fI"lo;speed=1000000000" "eth0;capability=RSS"\fR\fI \fR
5850 .sp
5851 Example:
5852 \fI\fIinterfaces\fR\fR\fI = \fR\fI"lo;speed=1000000000" , "eth0;capability=RSS"\fR\fI \fR
5853 .sp
5854 Example:
5855 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;capability=RSS" , "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"\fR\fI \fR
5856 .sp
5857 Example:
5858 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;options=dynamic"\fR\fI \fR
5859 .RE
5860
5861 invalid users (S)
5862 .PP
5863 .RS 4
5864 This is a list of users that should not be allowed to login to this service\&. This is really a
5865 \fIparanoid\fR
5866 check to absolutely ensure an improper setting does not breach your security\&.
5867 .sp
5868 A name starting with a \*(Aq@\*(Aq is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database\&.
5869 .sp
5870 A name starting with \*(Aq+\*(Aq is interpreted only by looking in the UNIX group database via the NSS getgrnam() interface\&. A name starting with \*(Aq&\*(Aq is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system)\&. The characters \*(Aq+\*(Aq and \*(Aq&\*(Aq may be used at the start of the name in either order so the value
5871 \fI+&group\fR
5872 means check the UNIX group database, followed by the NIS netgroup database, and the value
5873 \fI&+group\fR
5874 means check the NIS netgroup database, followed by the UNIX group database (the same as the \*(Aq@\*(Aq prefix)\&.
5875 .sp
5876 The current servicename is substituted for
5877 \fI%S\fR\&. This is useful in the [homes] section\&.
5878 .sp
5879 Default:
5880 \fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR
5881 .sp
5882 Example:
5883 \fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR
5884 .RE
5885
5886 iprint server (G)
5887 .PP
5888 .RS 4
5889 This parameter is only applicable if
5890 \m[blue]\fBprinting\fR\m[]
5891 is set to
5892 \fBiprint\fR\&.
5893 .sp
5894 If set, this option overrides the ServerName option in the CUPS
5895 client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
5896 .sp
5897 Default:
5898 \fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR
5899 .sp
5900 Example:
5901 \fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR
5902 .RE
5903
5904 kdc always include pac (G)
5905 .PP
5906 .RS 4
5907 This option over\-rides the PA\-PAC\-REQUEST received from the client\&. When enabled (the default) a PAC will always be included in the kerberos responses\&.
5908 .sp
5909 This option currently only applies if the embedded Heimdal KDC is used\&.
5910 .sp
5911 Default:
5912 \fI\fIkdc always include pac\fR\fR\fI = \fR\fIyes\fR\fI \fR
5913 .RE
5914
5915 certificate backdating compensation (G)
5916 .PP
5917 .RS 4
5918 When performing certificate based kerberos authentication (PKINIT) with
5919 \m[blue]\fBstrong certificate binding enforcement = compatibility\fR\m[]
5920 .sp
5921 This parameter specifies the number of minutes that a certificate\*(Aqs issue date may precede the creation of a user\*(Aqs account\&.
5922 .sp
5923 More details can be found at
5924 KB5014754: Certificate\-based authentication changes on Windows domain controllers
5925 .sp
5926 Default:
5927 \fI\fIcertificate backdating compensation\fR\fR\fI = \fR\fI0\fR\fI \fR
5928 .RE
5929
5930 strong certificate binding enforcement (G)
5931 .PP
5932 .RS 4
5933 This parameter controls the enforcement of Windows Certificate bindings as outlined in
5934 KB5014754: Certificate\-based authentication changes on Windows domain controllers, when performing certificate based kerberos authentication (PKINIT)
5935 .sp
5936 The possible values are:
5937 .RS
5938 .sp
5939 .RS 4
5940 .ie n \{\
5941 \h'-04'\(bu\h'+03'\c
5942 .\}
5943 .el \{\
5944 .sp -1
5945 .IP \(bu 2.3
5946 .\}
5947 \fBnone\fR
5948 .sp
5949 No validation of the certificate mappings is performed
5950 .RE
5951 .sp
5952 .RS 4
5953 .ie n \{\
5954 \h'-04'\(bu\h'+03'\c
5955 .\}
5956 .el \{\
5957 .sp -1
5958 .IP \(bu 2.3
5959 .\}
5960 \fBcompatibility\fR
5961 .sp
5962 Weak certificate mappings are permitted\&.
5963 .sp
5964 In compatibility mode for WEAK mappings the date the certificate was issued must be after the date that the user was created\&.
5965 .sp
5966 \fBUnless\fR
5967 \m[blue]\fBcertificate backdating compensation\fR\m[]
5968 has a value\&. In that case the certificate may have been issued no more than that number of minutes before the user was created\&.
5969 .RE
5970 .sp
5971 .RS 4
5972 .ie n \{\
5973 \h'-04'\(bu\h'+03'\c
5974 .\}
5975 .el \{\
5976 .sp -1
5977 .IP \(bu 2.3
5978 .\}
5979 \fBfull\fR
5980 .sp
5981 Only
5982 \fBstrong\fR
5983 certificate mappings are permitted\&. This is the default\&.
5984 .RE
5985 .sp
5986 .RE
5987 .sp
5988 Certificate mappings are configured in the users
5989 \fBaltSecurityIdentities\fR
5990 attribute and may be any of:
5991 .RS
5992 .sp
5993 .RS 4
5994 .ie n \{\
5995 \h'-04'\(bu\h'+03'\c
5996 .\}
5997 .el \{\
5998 .sp -1
5999 .IP \(bu 2.3
6000 .\}
6001 X509 Issuer and subject
6002 .sp
6003 Example: "X509:<I>IssuerName<S>SubjectName"
6004 .sp
6005 The values provided for the issuer name and subject name must match those in the user\*(Aqs certificate exactly\&.
6006 .sp
6007 \fIWEAK\fR
6008 .RE
6009 .sp
6010 .RS 4
6011 .ie n \{\
6012 \h'-04'\(bu\h'+03'\c
6013 .\}
6014 .el \{\
6015 .sp -1
6016 .IP \(bu 2.3
6017 .\}
6018 X509 Subject only
6019 .sp
6020 Example: "X509:<S>SubjectName"
6021 .sp
6022 The value provided for the issuer subject name must match that in the user\*(Aqs certificate exactly\&.
6023 .sp
6024 \fIWEAK\fR
6025 .RE
6026 .sp
6027 .RS 4
6028 .ie n \{\
6029 \h'-04'\(bu\h'+03'\c
6030 .\}
6031 .el \{\
6032 .sp -1
6033 .IP \(bu 2.3
6034 .\}
6035 X509 RFC822
6036 .sp
6037 Example: "X509:<RFC822>test@example\&.com"
6038 .sp
6039 Email address
6040 .sp
6041 \fIWEAK\fR
6042 .RE
6043 .sp
6044 .RS 4
6045 .ie n \{\
6046 \h'-04'\(bu\h'+03'\c
6047 .\}
6048 .el \{\
6049 .sp -1
6050 .IP \(bu 2.3
6051 .\}
6052 X509 Issuer and serial number
6053 .sp
6054 Example: "X509:<I>IssuerName<SR>123456789"
6055 .sp
6056 Certificate issuer and serial number
6057 .sp
6058 \fISTRONG\fR
6059 .RE
6060 .sp
6061 .RS 4
6062 .ie n \{\
6063 \h'-04'\(bu\h'+03'\c
6064 .\}
6065 .el \{\
6066 .sp -1
6067 .IP \(bu 2.3
6068 .\}
6069 X509 Subject Key Identifier
6070 .sp
6071 Example: "<SKI>01234xxxxx"
6072 .sp
6073 \fISTRONG\fR
6074 .RE
6075 .sp
6076 .RS 4
6077 .ie n \{\
6078 \h'-04'\(bu\h'+03'\c
6079 .\}
6080 .el \{\
6081 .sp -1
6082 .IP \(bu 2.3
6083 .\}
6084 X509 public key SHA1
6085 .sp
6086 Example: "X509:<SHA1\-PUKEY>1234567890abcdef"
6087 .sp
6088 The SHA1 hash of the certificate\*(Aqs public key
6089 .sp
6090 \fISTRONG\fR
6091 .RE
6092 .sp
6093 .RE
6094 Certificate mappings may also take the form of a certificate extension (extension 1\&.3\&.6\&.1\&.4\&.1\&.311\&.25\&.2) that contains the user\*(Aqs SID\&. This is considered a
6095 \fISTRONG\fR
6096 mapping\&.
6097 .sp
6098 Default:
6099 \fI\fIstrong certificate binding enforcement\fR\fR\fI = \fR\fIfull\fR\fI \fR
6100 .RE
6101
6102 kdc default domain supported enctypes (G)
6103 .PP
6104 .RS 4
6105 Set the default value of
6106 \fBmsDS\-SupportedEncryptionTypes\fR
6107 for service accounts in Active Directory that are missing this value or where
6108 \fBmsDS\-SupportedEncryptionTypes\fR
6109 is set to 0\&.
6110 .sp
6111 This allows Samba administrators to match the configuration flexibility provided by the
6112 \fBHKEY_LOCAL_MACHINE\eSystem\eCurrentControlSet\eservices\eKDC\eDefaultDomainSupportedEncTypes\fR
6113 Registry Value on Windows\&.
6114 .sp
6115 Unlike the Windows registry key (which only takes an base\-10 number), in Samba this may also be expressed in hexadecimal or as a list of Kerberos encryption type names\&.
6116 .sp
6117 Specified values are ORed together bitwise, and those currently supported consist of:
6118 .RS
6119 .sp
6120 .RS 4
6121 .ie n \{\
6122 \h'-04'\(bu\h'+03'\c
6123 .\}
6124 .el \{\
6125 .sp -1
6126 .IP \(bu 2.3
6127 .\}
6128 \fBarcfour\-hmac\-md5\fR,
6129 \fBrc4\-hmac\fR,
6130 \fB0x4\fR, or
6131 \fB4\fR
6132 .sp
6133 Known on Windows as Kerberos RC4 encryption
6134 .RE
6135 .sp
6136 .RS 4
6137 .ie n \{\
6138 \h'-04'\(bu\h'+03'\c
6139 .\}
6140 .el \{\
6141 .sp -1
6142 .IP \(bu 2.3
6143 .\}
6144 \fBaes128\-cts\-hmac\-sha1\-96\fR,
6145 \fBaes128\-cts\fR,
6146 \fB0x8\fR, or
6147 \fB8\fR
6148 .sp
6149 Known on Windows as Kerberos AES 128 bit encryption
6150 .RE
6151 .sp
6152 .RS 4
6153 .ie n \{\
6154 \h'-04'\(bu\h'+03'\c
6155 .\}
6156 .el \{\
6157 .sp -1
6158 .IP \(bu 2.3
6159 .\}
6160 \fBaes256\-cts\-hmac\-sha1\-96\fR,
6161 \fBaes256\-cts\fR,
6162 \fB0x10\fR, or
6163 \fB16\fR
6164 .sp
6165 Known on Windows as Kerberos AES 256 bit encryption
6166 .RE
6167 .sp
6168 .RS 4
6169 .ie n \{\
6170 \h'-04'\(bu\h'+03'\c
6171 .\}
6172 .el \{\
6173 .sp -1
6174 .IP \(bu 2.3
6175 .\}
6176 \fBaes256\-cts\-hmac\-sha1\-96\-sk\fR,
6177 \fBaes256\-cts\-sk\fR,
6178 \fB0x20\fR, or
6179 \fB32\fR
6180 .sp
6181 Allow AES session keys\&. When this is set, it indicates to the KDC that AES session keys can be used, even when
6182 \fBaes256\-cts\fR
6183 and
6184 \fBaes128\-cts\fR
6185 are not set\&. This allows use of AES keys against hosts otherwise only configured with RC4 for ticket keys (which is the default)\&.
6186 .RE
6187 .sp
6188 .RE
6189 Default:
6190 \fI\fIkdc default domain supported enctypes\fR\fR\fI = \fR\fI0 # maps to what the software supports currently\&. If AES keys are available (the domain functional level is 2008 or higher), this is aes128\-cts\-hmac\-sha1\-96 aes256\-cts\-hmac\-sha1\-96\&. Otherwise it is arcfour\-hmac\-md5 aes256\-cts\-hmac\-sha1\-96\-sk\&.\fR\fI \fR
6191 .RE
6192
6193 kdc enable fast (G)
6194 .PP
6195 .RS 4
6196 With the Samba 4\&.16 the embedded Heimdal KDC brings support for RFC6113 FAST, which wasn\*(Aqt available in older Samba versions\&.
6197 .sp
6198 This option is mostly for testing and currently only applies if the embedded Heimdal KDC is used\&.
6199 .sp
6200 Default:
6201 \fI\fIkdc enable fast\fR\fR\fI = \fR\fIyes\fR\fI \fR
6202 .RE
6203
6204 kdc force enable rc4 weak session keys (G)
6205 .PP
6206 .RS 4
6207 \fBRFC8429\fR
6208 declares that
6209 \fBrc4\-hmac\fR
6210 Kerberos ciphers are weak and there are known attacks on Active Directory use of this cipher suite\&.
6211 .sp
6212 However for compatibility with Microsoft Windows this option allows the KDC to assume that regardless of the value set in a service account\*(Aqs
6213 \fBmsDS\-SupportedEncryptionTypes\fR
6214 attribute that a
6215 \fBrc4\-hmac\fR
6216 Kerberos session key (as distinct from the ticket key, as found in a service keytab) can be used if the potentially older client requests it\&.
6217 .sp
6218 Default:
6219 \fI\fIkdc force enable rc4 weak session keys\fR\fR\fI = \fR\fIno\fR\fI \fR
6220 .RE
6221
6222 kdc name match implicit dollar without canonicalization (G)
6223 .PP
6224 .RS 4
6225 This option only affect clients that do not request name canonicalization in an AS request, which generally means traditional unix Kerberos clients and not Windows clients\&.
6226 .sp
6227 The KDC may match the name in an AS request inexactly, for example using a case\-insensitive comparison or converting it to a User Principal Name, but the client is not informed of the principal it actually matched unless it set the \*(Aqcanonicalize\*(Aq option flag\&.
6228 .sp
6229 In Active Directory domains, the default behaviour of the KDC is to append a \*(Aq$\*(Aq character if the supplied name does not have one and does not already match\&. That allows \*(Aqfoo\*(Aq to match the machine account \*(Aqfoo$\*(Aq\&. An attacker who is able to create arbitrary machine accounts (which can be a low\-privilege operation) is sometimes able to get tickets for unix users by mimicking their names\&. This is known as the \*(Aqdollar ticket attack\*(Aq\&.
6230 .sp
6231 With this option set to \*(Aqno\*(Aq, the KDC will not try to match using the appended \*(Aq$\*(Aq unless the canonicalize flag is set\&. This will allow AD\-aware clients as usual to connect with canonicalization, but not expose traditional unix clients to the dollar ticket attack\&.
6232 .sp
6233 Default:
6234 \fI\fIkdc name match implicit dollar without canonicalization\fR\fR\fI = \fR\fIyes\fR\fI \fR
6235 .RE
6236
6237 kdc require canonicalization (G)
6238 .PP
6239 .RS 4
6240 Require that Kerberos clients use the canonicalization flag\&.
6241 .sp
6242 Clients that do not use the Kerberos canonicalization flag (see RFC 6806) will get a TGT for the name they requested, which may not exactly match the name in the Samba database\&. For example, a client may request a ticket for \*(Aqroot\*(Aq, and if there is a computer called \*(AqROOT$\*(Aq in the database, the KDC will issue a ticket for \*(Aqroot\*(Aq, using the standard matching rules for AD Kerberos\&. A member server that is Kerberos\-aware but not AD\-aware might accept this ticket as valid for the local root user\&. This option avoids the problem by refusing to honour requests without the canonicalization flag\&.
6243 .sp
6244 This is a reasonable option if all expected clients request canonicalization (as Windows clients do), and there are member servers that might be confused by this issue\&. Typically that means unix servers expecting to be in an MIT Kerberos domain\&.
6245 .sp
6246 See also the "kdc name match implicit dollar without canonicalization" option, which is more useful if you expect Kerberos clients that will not use the canonicalize flag\&.
6247 .sp
6248 Default:
6249 \fI\fIkdc require canonicalization\fR\fR\fI = \fR\fIno\fR\fI \fR
6250 .RE
6251
6252 kdc supported enctypes (G)
6253 .PP
6254 .RS 4
6255 On an active directory domain controller, this is the list of supported encryption types for local running kdc\&.
6256 .sp
6257 This allows Samba administrators to remove support for weak/unused encryption types, similar the configuration flexibility provided by the
6258 \fBNetwork security: Configure encryption types allowed for Kerberos\fR
6259 GPO/Local Policies/Security Options Value, which results in the
6260 \fBHKEY_LOCAL_MACHINE\eSOFTWARE\eMicrosoft\eWindows\eCurrentVersion\ePolicies\eSystem\eKerberos\eParameters\eSupportedEncryptionTypes\fR
6261 Registry Value on Windows\&.
6262 .sp
6263 Unlike the Windows registry key (which only takes an base\-10 number), in Samba this may also be expressed as hexadecimal or a list of Kerberos encryption type names\&.
6264 .sp
6265 Specified values are ORed together bitwise, and those currently supported consist of:
6266 .RS
6267 .sp
6268 .RS 4
6269 .ie n \{\
6270 \h'-04'\(bu\h'+03'\c
6271 .\}
6272 .el \{\
6273 .sp -1
6274 .IP \(bu 2.3
6275 .\}
6276 \fBarcfour\-hmac\-md5\fR,
6277 \fBrc4\-hmac\fR,
6278 \fB0x4\fR, or
6279 \fB4\fR
6280 .sp
6281 Known on Windows as Kerberos RC4 encryption
6282 .RE
6283 .sp
6284 .RS 4
6285 .ie n \{\
6286 \h'-04'\(bu\h'+03'\c
6287 .\}
6288 .el \{\
6289 .sp -1
6290 .IP \(bu 2.3
6291 .\}
6292 \fBaes128\-cts\-hmac\-sha1\-96\fR,
6293 \fBaes128\-cts\fR,
6294 \fB0x8\fR, or
6295 \fB8\fR
6296 .sp
6297 Known on Windows as Kerberos AES 128 bit encryption
6298 .RE
6299 .sp
6300 .RS 4
6301 .ie n \{\
6302 \h'-04'\(bu\h'+03'\c
6303 .\}
6304 .el \{\
6305 .sp -1
6306 .IP \(bu 2.3
6307 .\}
6308 \fBaes256\-cts\-hmac\-sha1\-96\fR,
6309 \fBaes256\-cts\fR,
6310 \fB0x10\fR, or
6311 \fB16\fR
6312 .sp
6313 Known on Windows as Kerberos AES 256 bit encryption
6314 .RE
6315 .sp
6316 .RE
6317 Default:
6318 \fI\fIkdc supported enctypes\fR\fR\fI = \fR\fI0 # maps to what the software supports currently: arcfour\-hmac\-md5 aes128\-cts\-hmac\-sha1\-96 aes256\-cts\-hmac\-sha1\-96\fR\fI \fR
6319 .RE
6320
6321 keepalive (G)
6322 .PP
6323 .RS 4
6324 The value of the parameter (an integer) represents the number of seconds between
6325 \fIkeepalive\fR
6326 packets\&. If this parameter is zero, no keepalive packets will be sent\&. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding\&.
6327 .sp
6328 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
6329 \m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
6330 .sp
6331 Please note this option only applies to SMB1 client connections, and has no effect on SMB2 clients\&.
6332 .sp
6333 Default:
6334 \fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR
6335 .sp
6336 Example:
6337 \fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR
6338 .RE
6339
6340 kerberos encryption types (G)
6341 .PP
6342 .RS 4
6343 This parameter determines the encryption types to use when operating as a Kerberos client\&. Possible values are
6344 \fIall\fR,
6345 \fIstrong\fR, and
6346 \fIlegacy\fR\&.
6347 .sp
6348 Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos tickets\&. This library is normally configured outside of Samba, using the krb5\&.conf file\&. This file may also include directives to configure the encryption types to be used\&. However, Samba implements Active Directory protocols and algorithms to locate a domain controller\&. In order to force the Kerberos library into using the correct domain controller, some Samba processes, such as
6349 \fBwinbindd\fR(8)
6350 and
6351 \fBnet\fR(8), build a private krb5\&.conf file for use by the Kerberos library while being invoked from Samba\&. This private file controls all aspects of the Kerberos library operation, and this parameter controls how the encryption types are configured within this generated file, and therefore also controls the encryption types negotiable by Samba\&.
6352 .sp
6353 When set to
6354 \fBall\fR, all active directory encryption types are allowed\&.
6355 .sp
6356 When set to
6357 \fBstrong\fR, only AES\-based encryption types are offered\&. This can be used in hardened environments to prevent downgrade attacks\&.
6358 .sp
6359 When set to
6360 \fBlegacy\fR, only RC4\-HMAC\-MD5 is allowed\&. AVOID using this option, because of
6361 CVE\-2022\-37966
6362 see
6363 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15237\&.
6364 .sp
6365 Default:
6366 \fI\fIkerberos encryption types\fR\fR\fI = \fR\fIall\fR\fI \fR
6367 .RE
6368
6369 kerberos method (G)
6370 .PP
6371 .RS 4
6372 Controls how kerberos tickets are verified\&.
6373 .sp
6374 Valid options are:
6375 .RS
6376 .sp
6377 .RS 4
6378 .ie n \{\
6379 \h'-04'\(bu\h'+03'\c
6380 .\}
6381 .el \{\
6382 .sp -1
6383 .IP \(bu 2.3
6384 .\}
6385 secrets only \- use only the secrets\&.tdb for ticket verification (default)
6386 .RE
6387 .sp
6388 .RS 4
6389 .ie n \{\
6390 \h'-04'\(bu\h'+03'\c
6391 .\}
6392 .el \{\
6393 .sp -1
6394 .IP \(bu 2.3
6395 .\}
6396 system keytab \- use only the system keytab for ticket verification
6397 .RE
6398 .sp
6399 .RS 4
6400 .ie n \{\
6401 \h'-04'\(bu\h'+03'\c
6402 .\}
6403 .el \{\
6404 .sp -1
6405 .IP \(bu 2.3
6406 .\}
6407 dedicated keytab \- use a dedicated keytab for ticket verification
6408 .RE
6409 .sp
6410 .RS 4
6411 .ie n \{\
6412 \h'-04'\(bu\h'+03'\c
6413 .\}
6414 .el \{\
6415 .sp -1
6416 .IP \(bu 2.3
6417 .\}
6418 secrets and keytab \- use the secrets\&.tdb first, then the system keytab
6419 .RE
6420 .sp
6421 .RE
6422 The major difference between "system keytab" and "dedicated keytab" is that the latter method relies on kerberos to find the correct keytab entry instead of filtering based on expected principals\&.
6423 .sp
6424 When the kerberos method is in "dedicated keytab" mode,
6425 \m[blue]\fBdedicated keytab file\fR\m[]
6426 must be set to specify the location of the keytab file\&.
6427 .sp
6428 Suggested configuration is to use the default value \*(Aqsecrets only\*(Aq together with the
6429 \m[blue]\fBsync machine password to keytab\fR\m[]
6430 option\&.
6431 .sp
6432 Default:
6433 \fI\fIkerberos method\fR\fR\fI = \fR\fIdefault\fR\fI \fR
6434 .RE
6435
6436 kernel change notify (G)
6437 .PP
6438 .RS 4
6439 This parameter specifies whether Samba should ask the kernel for change notifications in directories so that SMB clients can refresh whenever the data on the server changes\&.
6440 .sp
6441 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
6442 .sp
6443 Default:
6444 \fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
6445 .RE
6446
6447 kernel oplocks (S)
6448 .PP
6449 .RS 4
6450 For UNIXes that support kernel based
6451 \m[blue]\fBoplocks\fR\m[]
6452 (currently only Linux), this parameter allows the use of them to be turned on or off\&. However, this disables Level II oplocks for clients as the Linux kernel does not support them properly\&.
6453 .sp
6454 Kernel oplocks support allows Samba
6455 \fIoplocks \fR
6456 to be broken whenever a local UNIX process or NFS operation accesses a file that
6457 \fBsmbd\fR(8)
6458 has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
6459 \fIvery\fR
6460 cool feature :\-)\&.
6461 .sp
6462 If you do not need this interaction, you should disable the parameter on Linux to get Level II oplocks and the associated performance benefit\&.
6463 .sp
6464 This parameter defaults to
6465 \fBno\fR
6466 and is translated to a no\-op on systems that do not have the necessary kernel support\&.
6467 .sp
6468 Default:
6469 \fI\fIkernel oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
6470 .RE
6471
6472 kernel share modes (S)
6473 .PP
6474 .RS 4
6475 This parameter controls whether SMB share modes are translated into file system specific sharemode calls\&.
6476 .sp
6477 Kernel share modes provide a minimal level of interoperability with local UNIX processes and NFS operations by preventing access corresponding to the SMB share modes\&. This requires a file system specific VFS module with proper support\&.
6478 .sp
6479 Note that in order to use SMB2 durable file handles on a share, you have to turn kernel share modes off\&.
6480 .sp
6481 This parameter defaults to
6482 \fBno\fR\&. Setting it to
6483 \fByes\fR
6484 requires a file system module that supports file system sharemodes, otherwise attempts to access files will fail with a sharing violation\&.
6485 .sp
6486 Default:
6487 \fI\fIkernel share modes\fR\fR\fI = \fR\fIno\fR\fI \fR
6488 .RE
6489
6490 kpasswd port (G)
6491 .PP
6492 .RS 4
6493 Specifies which ports the Kerberos server should listen on for password changes\&.
6494 .sp
6495 Default:
6496 \fI\fIkpasswd port\fR\fR\fI = \fR\fI464\fR\fI \fR
6497 .RE
6498
6499 krb5 acceptor report canonical client name (G)
6500 .PP
6501 .RS 4
6502 This option affects the client name provided to Kerberos acceptors for incoming Kerberos tickets\&. If set to ‘yes’, the client name in the ticket will be replaced with the canonical client name (the sAMAccountName)\&. Otherwise, it will be left unchanged\&.
6503 .sp
6504 This option currently only applies if the embedded Heimdal KDC is used\&.
6505 .sp
6506 Default:
6507 \fI\fIkrb5 acceptor report canonical client name\fR\fR\fI = \fR\fIyes\fR\fI \fR
6508 .RE
6509
6510 krb5 port (G)
6511 .PP
6512 .RS 4
6513 Specifies which port the KDC should listen on for Kerberos traffic\&.
6514 .sp
6515 Default:
6516 \fI\fIkrb5 port\fR\fR\fI = \fR\fI88\fR\fI \fR
6517 .RE
6518
6519 lanman auth (G)
6520 .PP
6521 .RS 4
6522 This parameter has been deprecated since Samba 4\&.11 and support for LanMan (as distinct from NTLM, NTLMv2 or Kerberos authentication) will be removed in a future Samba release\&.
6523 .sp
6524 That is, in the future, the current default of
6525 lanman auth = no
6526 will be the enforced behaviour\&.
6527 .sp
6528 This parameter determines whether or not
6529 \fBsmbd\fR(8)
6530 will attempt to authenticate users or permit password changes using the LANMAN password hash\&. If disabled, only clients which support NT password hashes (e\&.g\&. Windows NT/2000 clients, smbclient, but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host\&.
6531 .sp
6532 The LANMAN encrypted response is easily broken, due to its case\-insensitive nature, and the choice of algorithm\&. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option\&.
6533 .sp
6534 When this parameter is set to
6535 no
6536 this will also result in sambaLMPassword in Samba\*(Aqs passdb being blanked after the next password change\&. As a result of that lanman clients won\*(Aqt be able to authenticate, even if lanman auth is re\-enabled later on\&.
6537 .sp
6538 Unlike the
6539 \fIencrypt passwords\fR
6540 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
6541 client lanman auth
6542 to disable this for Samba\*(Aqs clients (such as smbclient)
6543 .sp
6544 This parameter is overridden by
6545 \fIntlm auth\fR, so unless that it is also set to
6546 \fBntlmv1\-permitted\fR
6547 or
6548 \fByes\fR, then only NTLMv2 logins will be permitted and no LM hash will be stored\&. All modern clients support NTLMv2, and but some older clients require special configuration to use it\&.
6549 .sp
6550 \fIThis parameter has no impact on the Samba AD DC, LM authentication is always disabled and no LM password is ever stored\&.\fR
6551 .sp
6552 Default:
6553 \fI\fIlanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
6554 .RE
6555
6556 large readwrite (G)
6557 .PP
6558 .RS 4
6559 This parameter determines whether or not
6560 \fBsmbd\fR(8)
6561 supports the new 64k streaming read and write variant SMB requests introduced with Windows 2000\&. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64\-bit capable operating system such as IRIX, Solaris or a Linux 2\&.4 kernel\&. Can improve performance by 10% with Windows 2000 clients\&. Defaults to on\&. Not as tested as some other Samba code paths\&.
6562 .sp
6563 Default:
6564 \fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR
6565 .RE
6566
6567 ldap admin dn (G)
6568 .PP
6569 .RS 4
6570 The
6571 \m[blue]\fBldap admin dn\fR\m[]
6572 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retrieving user account information\&. The
6573 \m[blue]\fBldap admin dn\fR\m[]
6574 is used in conjunction with the admin dn password stored in the
6575 private/secrets\&.tdb
6576 file\&. See the
6577 \fBsmbpasswd\fR(8)
6578 man page for more information on how to accomplish this\&.
6579 .sp
6580 The
6581 \m[blue]\fBldap admin dn\fR\m[]
6582 requires a fully specified DN\&. The
6583 \m[blue]\fBldap suffix\fR\m[]
6584 is not appended to the
6585 \m[blue]\fBldap admin dn\fR\m[]\&.
6586 .sp
6587 \fINo default\fR
6588 .RE
6589
6590 ldap connection timeout (G)
6591 .PP
6592 .RS 4
6593 This parameter tells the LDAP library calls which timeout in seconds they should honor during initial connection establishments to LDAP servers\&. It is very useful in failover scenarios in particular\&. If one or more LDAP servers are not reachable at all, we do not have to wait until TCP timeouts are over\&. This feature must be supported by your LDAP library\&.
6594 .sp
6595 This parameter is different from
6596 \m[blue]\fBldap timeout\fR\m[]
6597 which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.
6598 .sp
6599 Default:
6600 \fI\fIldap connection timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
6601 .RE
6602
6603 ldap debug level (G)
6604 .PP
6605 .RS 4
6606 This parameter controls the debug level of the LDAP library calls\&. In the case of OpenLDAP, it is the same bit\-field as understood by the server and documented in the
6607 \fBslapd.conf\fR(5)
6608 manpage\&. A typical useful value will be
6609 \fI1\fR
6610 for tracing function calls\&.
6611 .sp
6612 The debug output from the LDAP libraries appears with the prefix [LDAP] in Samba\*(Aqs logging output\&. The level at which LDAP logging is printed is controlled by the parameter
6613 \fIldap debug threshold\fR\&.
6614 .sp
6615 Default:
6616 \fI\fIldap debug level\fR\fR\fI = \fR\fI0\fR\fI \fR
6617 .sp
6618 Example:
6619 \fI\fIldap debug level\fR\fR\fI = \fR\fI1\fR\fI \fR
6620 .RE
6621
6622 ldap debug threshold (G)
6623 .PP
6624 .RS 4
6625 This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of
6626 \fIldap debug level\fR
6627 for details\&.
6628 .sp
6629 Default:
6630 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI10\fR\fI \fR
6631 .sp
6632 Example:
6633 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI5\fR\fI \fR
6634 .RE
6635
6636 ldap delete dn (G)
6637 .PP
6638 .RS 4
6639 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
6640 .sp
6641 Default:
6642 \fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR
6643 .RE
6644
6645 ldap deref (G)
6646 .PP
6647 .RS 4
6648 This option controls whether Samba should tell the LDAP library to use a certain alias dereferencing method\&. The default is
6649 \fIauto\fR, which means that the default setting of the ldap client library will be kept\&. Other possible values are
6650 \fInever\fR,
6651 \fIfinding\fR,
6652 \fIsearching\fR
6653 and
6654 \fIalways\fR\&. Grab your LDAP manual for more information\&.
6655 .sp
6656 Default:
6657 \fI\fIldap deref\fR\fR\fI = \fR\fIauto\fR\fI \fR
6658 .sp
6659 Example:
6660 \fI\fIldap deref\fR\fR\fI = \fR\fIsearching\fR\fI \fR
6661 .RE
6662
6663 ldap follow referral (G)
6664 .PP
6665 .RS 4
6666 This option controls whether to follow LDAP referrals or not when searching for entries in the LDAP database\&. Possible values are
6667 \fIon\fR
6668 to enable following referrals,
6669 \fIoff\fR
6670 to disable this, and
6671 \fIauto\fR, to use the libldap default settings\&. libldap\*(Aqs choice of following referrals or not is set in /etc/openldap/ldap\&.conf with the REFERRALS parameter as documented in ldap\&.conf(5)\&.
6672 .sp
6673 Default:
6674 \fI\fIldap follow referral\fR\fR\fI = \fR\fIauto\fR\fI \fR
6675 .sp
6676 Example:
6677 \fI\fIldap follow referral\fR\fR\fI = \fR\fIoff\fR\fI \fR
6678 .RE
6679
6680 ldap group suffix (G)
6681 .PP
6682 .RS 4
6683 This parameter specifies the suffix that is used for groups when these are added to the LDAP directory\&. If this parameter is unset, the value of
6684 \m[blue]\fBldap suffix\fR\m[]
6685 will be used instead\&. The suffix string is prepended to the
6686 \m[blue]\fBldap suffix\fR\m[]
6687 string so use a partial DN\&.
6688 .sp
6689 Default:
6690 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6691 .sp
6692 Example:
6693 \fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR
6694 .RE
6695
6696 ldap idmap suffix (G)
6697 .PP
6698 .RS 4
6699 This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
6700 \m[blue]\fBldap suffix\fR\m[]
6701 will be used instead\&. The suffix string is prepended to the
6702 \m[blue]\fBldap suffix\fR\m[]
6703 string so use a partial DN\&.
6704 .sp
6705 Default:
6706 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6707 .sp
6708 Example:
6709 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR
6710 .RE
6711
6712 ldap machine suffix (G)
6713 .PP
6714 .RS 4
6715 It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
6716 \m[blue]\fBldap suffix\fR\m[]
6717 will be used instead\&. The suffix string is prepended to the
6718 \m[blue]\fBldap suffix\fR\m[]
6719 string so use a partial DN\&.
6720 .sp
6721 Default:
6722 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6723 .sp
6724 Example:
6725 \fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR
6726 .RE
6727
6728 ldap max anonymous request size (G)
6729 .PP
6730 .RS 4
6731 This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an anonymous connection\&.
6732 .sp
6733 If the request size exceeds this limit the request will be rejected\&.
6734 .sp
6735 Default:
6736 \fI\fIldap max anonymous request size\fR\fR\fI = \fR\fI256000\fR\fI \fR
6737 .sp
6738 Example:
6739 \fI\fIldap max anonymous request size\fR\fR\fI = \fR\fI500000\fR\fI \fR
6740 .RE
6741
6742 ldap max authenticated request size (G)
6743 .PP
6744 .RS 4
6745 This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an authenticated connection\&.
6746 .sp
6747 If the request size exceeds this limit the request will be rejected\&.
6748 .sp
6749 Default:
6750 \fI\fIldap max authenticated request size\fR\fR\fI = \fR\fI16777216\fR\fI \fR
6751 .sp
6752 Example:
6753 \fI\fIldap max authenticated request size\fR\fR\fI = \fR\fI4194304\fR\fI \fR
6754 .RE
6755
6756 ldap max search request size (G)
6757 .PP
6758 .RS 4
6759 This parameter specifies the maximum permitted size (in bytes) for an LDAP search request\&.
6760 .sp
6761 If the request size exceeds this limit the request will be rejected\&.
6762 .sp
6763 Default:
6764 \fI\fIldap max search request size\fR\fR\fI = \fR\fI256000\fR\fI \fR
6765 .sp
6766 Example:
6767 \fI\fIldap max search request size\fR\fR\fI = \fR\fI4194304\fR\fI \fR
6768 .RE
6769
6770 ldap page size (G)
6771 .PP
6772 .RS 4
6773 This parameter specifies the number of entries per page\&.
6774 .sp
6775 If the LDAP server supports paged results, clients can request subsets of search results (pages) instead of the entire list\&. This parameter specifies the size of these pages\&.
6776 .sp
6777 Default:
6778 \fI\fIldap page size\fR\fR\fI = \fR\fI1000\fR\fI \fR
6779 .sp
6780 Example:
6781 \fI\fIldap page size\fR\fR\fI = \fR\fI512\fR\fI \fR
6782 .RE
6783
6784 ldap password sync
6785 .PP
6786 .RS 4
6787 This parameter is a synonym for
6788 ldap passwd sync\&.
6789 .RE
6790
6791 ldap passwd sync (G)
6792 .PP
6793 .RS 4
6794 This option is used to define whether or not Samba should sync the LDAP password with the NT and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password change via SAMBA\&.
6795 .sp
6796 The
6797 \m[blue]\fBldap passwd sync\fR\m[]
6798 can be set to one of three values:
6799 .RS
6800 .sp
6801 .RS 4
6802 .ie n \{\
6803 \h'-04'\(bu\h'+03'\c
6804 .\}
6805 .el \{\
6806 .sp -1
6807 .IP \(bu 2.3
6808 .\}
6809 \fIYes\fR
6810 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
6811 .RE
6812 .sp
6813 .RS 4
6814 .ie n \{\
6815 \h'-04'\(bu\h'+03'\c
6816 .\}
6817 .el \{\
6818 .sp -1
6819 .IP \(bu 2.3
6820 .\}
6821 \fINo\fR
6822 = Update NT and LM passwords and update the pwdLastSet time\&.
6823 .RE
6824 .sp
6825 .RS 4
6826 .ie n \{\
6827 \h'-04'\(bu\h'+03'\c
6828 .\}
6829 .el \{\
6830 .sp -1
6831 .IP \(bu 2.3
6832 .\}
6833 \fIOnly\fR
6834 = Only update the LDAP password and let the LDAP server do the rest\&.
6835 .RE
6836 .sp
6837 .RE
6838 Default:
6839 \fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR
6840 .RE
6841
6842 ldap replication sleep (G)
6843 .PP
6844 .RS 4
6845 When Samba is asked to write to a read\-only LDAP replica, we are redirected to talk to the read\-write master server\&. This server then replicates our changes back to the \*(Aqlocal\*(Aq server, however the replication might take some seconds, especially over slow links\&. Certain client activities, particularly domain joins, can become confused by the \*(Aqsuccess\*(Aq that does not immediately change the LDAP back\-end\*(Aqs data\&.
6846 .sp
6847 This option simply causes Samba to wait a short time, to allow the LDAP server to catch up\&. If you have a particularly high\-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly\&. Be aware that no checking is performed that the data has actually replicated\&.
6848 .sp
6849 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
6850 .sp
6851 Default:
6852 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR
6853 .RE
6854
6855 ldapsam:editposix (G)
6856 .PP
6857 .RS 4
6858 Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller eliminating the need to set up custom scripts to add and manage the posix users and groups\&. This option will instead directly manipulate the ldap tree to create, remove and modify user and group entries\&. This option also requires a running winbindd as it is used to allocate new uids/gids on user/group creation\&. The allocation range must be therefore configured\&.
6859 .sp
6860 To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly configured\&. On virgin servers the default users and groups (Administrator, Guest, Domain Users, Domain Admins, Domain Guests) can be precreated with the command
6861 net sam provision\&. To run this command the ldap server must be running, Winbindd must be running and the smb\&.conf ldap options must be properly configured\&. The typical ldap setup used with the
6862 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6863 option is usually sufficient to use
6864 \m[blue]\fBldapsam:editposix = yes\fR\m[]
6865 as well\&.
6866 .sp
6867 An example configuration can be the following:
6868 .sp
6869 .if n \{\
6870 .RS 4
6871 .\}
6872 .nf
6873 encrypt passwords = true
6874 passdb backend = ldapsam
6875
6876 ldapsam:trusted=yes
6877 ldapsam:editposix=yes
6878
6879 ldap admin dn = cn=admin,dc=samba,dc=org
6880 ldap delete dn = yes
6881 ldap group suffix = ou=groups
6882 ldap idmap suffix = ou=idmap
6883 ldap machine suffix = ou=computers
6884 ldap user suffix = ou=users
6885 ldap suffix = dc=samba,dc=org
6886
6887 idmap backend = ldap:"ldap://localhost"
6888
6889 idmap uid = 5000\-50000
6890 idmap gid = 5000\-50000
6891
6892 .fi
6893 .if n \{\
6894 .RE
6895 .\}
6896 .sp
6897 This configuration assumes a directory layout like described in the following ldif:
6898 .sp
6899 .if n \{\
6900 .RS 4
6901 .\}
6902 .nf
6903 dn: dc=samba,dc=org
6904 objectClass: top
6905 objectClass: dcObject
6906 objectClass: organization
6907 o: samba\&.org
6908 dc: samba
6909
6910 dn: cn=admin,dc=samba,dc=org
6911 objectClass: simpleSecurityObject
6912 objectClass: organizationalRole
6913 cn: admin
6914 description: LDAP administrator
6915 userPassword: secret
6916
6917 dn: ou=users,dc=samba,dc=org
6918 objectClass: top
6919 objectClass: organizationalUnit
6920 ou: users
6921
6922 dn: ou=groups,dc=samba,dc=org
6923 objectClass: top
6924 objectClass: organizationalUnit
6925 ou: groups
6926
6927 dn: ou=idmap,dc=samba,dc=org
6928 objectClass: top
6929 objectClass: organizationalUnit
6930 ou: idmap
6931
6932 dn: ou=computers,dc=samba,dc=org
6933 objectClass: top
6934 objectClass: organizationalUnit
6935 ou: computers
6936
6937 .fi
6938 .if n \{\
6939 .RE
6940 .\}
6941 .sp
6942 Default:
6943 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR
6944 .RE
6945
6946 ldapsam:trusted (G)
6947 .PP
6948 .RS 4
6949 By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix\-style NSS subsystem to access user and group information\&. Due to the way Unix stores user information in /etc/passwd and /etc/group this inevitably leads to inefficiencies\&. One important question a user needs to know is the list of groups he is member of\&. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS counterparts in LDAP\&. UNIX has optimized functions to enumerate group membership\&. Sadly, other functions that are used to deal with user and group attributes lack such optimization\&.
6950 .sp
6951 To make Samba scale well in large environments, the
6952 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6953 option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes\&. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object\&. If these assumptions are met,
6954 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6955 can be activated and Samba can bypass the NSS system to query user group memberships\&. Optimized LDAP queries can greatly speed up domain logon and administration tasks\&. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved\&.
6956 .sp
6957 Default:
6958 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR
6959 .RE
6960
6961 ldap server require strong auth (G)
6962 .PP
6963 .RS 4
6964 The
6965 \m[blue]\fBldap server require strong auth\fR\m[]
6966 defines whether the ldap server requires ldap traffic to be signed or signed and encrypted (sealed)\&. Possible values are
6967 \fIno\fR,
6968 \fIallow_sasl_without_tls_channel_bindings\fR
6969 and
6970 \fIyes\fR\&.
6971 .sp
6972 Windows has
6973 \fILdapEnforceChannelBinding\fR
6974 under
6975 \fIHKLM\eSYSTEM\eCurrentControlSet\eServices\eNTDS\eParameters\e\fR\&.
6976 .sp
6977 A value of
6978 \fIno\fR
6979 allows simple and sasl binds over all transports\&. This matches LdapEnforceChannelBinding=0\&.
6980 .sp
6981 A value of
6982 \fIallow_sasl_without_tls_channel_bindings\fR
6983 allows simple and sasl binds (without sign or seal) over TLS encrypted connections\&. Missing tls channel bindings are ignored, so only use this if a value of
6984 \fIyes\fR
6985 is not possible\&. Unencrypted connections only allow sasl binds with sign or seal\&. This matches LdapEnforceChannelBinding=1\&.
6986 .sp
6987 Before support for tls channel bindings existed in Samba, a value of
6988 \fIallow_sasl_over_tls\fR
6989 was possible in order to allow sasl binds without tls channel bindings\&. This is now misleading as a value of
6990 \fIyes\fR
6991 will now allow sasl binds with tls channel bindings\&. Configurations should be changed to
6992 \fIyes\fR
6993 instead or
6994 \fIallow_sasl_without_tls_channel_bindings\fR
6995 if really required\&. Currently
6996 \fIallow_sasl_over_tls\fR
6997 is just an alias of
6998 \fIallow_sasl_without_tls_channel_bindings\fR, but it will be removed in future versions\&.
6999 .sp
7000 A value of
7001 \fIyes\fR
7002 allows only simple binds and sasl binds with correct tls channel bindings over TLS encrypted connections\&. sasl binds without tls channel bindings are not allowed\&. Unencrypted connections only allow sasl binds with sign or seal\&. This matches LdapEnforceChannelBinding=2\&.
7003 .sp
7004 Default:
7005 \fI\fIldap server require strong auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
7006 .RE
7007
7008 ldap ssl (G)
7009 .PP
7010 .RS 4
7011 This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is
7012 \fINOT\fR
7013 related to Samba\*(Aqs previous SSL support which was enabled by specifying the
7014 \-\-with\-ssl
7015 option to the
7016 configure
7017 script\&.
7018 .sp
7019 LDAP connections should be secured where possible\&. This may be done setting
7020 \fIeither\fR
7021 this parameter to
7022 \fIstart tls\fR
7023 \fIor\fR
7024 by specifying
7025 \fIldaps://\fR
7026 in the URL argument of
7027 \m[blue]\fBpassdb backend\fR\m[]\&.
7028 .sp
7029 The
7030 \m[blue]\fBldap ssl\fR\m[]
7031 can be set to one of two values:
7032 .RS
7033 .sp
7034 .RS 4
7035 .ie n \{\
7036 \h'-04'\(bu\h'+03'\c
7037 .\}
7038 .el \{\
7039 .sp -1
7040 .IP \(bu 2.3
7041 .\}
7042 \fIOff\fR
7043 = Never use SSL when querying the directory\&.
7044 .RE
7045 .sp
7046 .RS 4
7047 .ie n \{\
7048 \h'-04'\(bu\h'+03'\c
7049 .\}
7050 .el \{\
7051 .sp -1
7052 .IP \(bu 2.3
7053 .\}
7054 \fIstart tls\fR
7055 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
7056 .RE
7057 .sp
7058 .RE
7059 Please note that this parameter does only affect
7060 \fIrpc\fR
7061 methods\&.
7062 .sp
7063 Default:
7064 \fI\fIldap ssl\fR\fR\fI = \fR\fIstart tls\fR\fI \fR
7065 .RE
7066
7067 ldap suffix (G)
7068 .PP
7069 .RS 4
7070 Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
7071 .sp
7072 The ldap suffix will be appended to the values specified for the
7073 \m[blue]\fBldap user suffix\fR\m[],
7074 \m[blue]\fBldap group suffix\fR\m[],
7075 \m[blue]\fBldap machine suffix\fR\m[], and the
7076 \m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
7077 \m[blue]\fBldap suffix\fR\m[]\&.
7078 .sp
7079 Default:
7080 \fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
7081 .sp
7082 Example:
7083 \fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR
7084 .RE
7085
7086 ldap timeout (G)
7087 .PP
7088 .RS 4
7089 This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.
7090 .sp
7091 Default:
7092 \fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR
7093 .RE
7094
7095 ldap user suffix (G)
7096 .PP
7097 .RS 4
7098 This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
7099 \m[blue]\fBldap suffix\fR\m[]
7100 will be used instead\&. The suffix string is prepended to the
7101 \m[blue]\fBldap suffix\fR\m[]
7102 string so use a partial DN\&.
7103 .sp
7104 Default:
7105 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR
7106 .sp
7107 Example:
7108 \fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR
7109 .RE
7110
7111 level2 oplocks (S)
7112 .PP
7113 .RS 4
7114 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
7115 .sp
7116 Level2, or read\-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read\-write oplock to a read\-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks)\&. This allows all openers of the file that support level2 oplocks to cache the file for read\-ahead only (ie\&. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application \&.EXE files)\&.
7117 .sp
7118 Once one of the clients which have a read\-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to "none" and delete any read\-ahead caches\&.
7119 .sp
7120 It is recommended that this parameter be turned on to speed access to shared executables\&.
7121 .sp
7122 For more discussions on level2 oplocks see the CIFS spec\&.
7123 .sp
7124 Currently, if
7125 \m[blue]\fBkernel oplocks\fR\m[]
7126 are supported then level2 oplocks are not granted (even if this parameter is set to
7127 \fByes\fR)\&. Note also, the
7128 \m[blue]\fBoplocks\fR\m[]
7129 parameter must be set to
7130 \fByes\fR
7131 on this share in order for this parameter to have any effect\&.
7132 .sp
7133 Default:
7134 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
7135 .RE
7136
7137 lm announce (G)
7138 .PP
7139 .RS 4
7140 This parameter determines if
7141 \fBnmbd\fR(8)
7142 will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list\&. This parameter can have three values,
7143 \fByes\fR,
7144 \fBno\fR, or
7145 \fBauto\fR\&. The default is
7146 \fBauto\fR\&. If set to
7147 \fBno\fR
7148 Samba will never produce these broadcasts\&. If set to
7149 \fByes\fR
7150 Samba will produce Lanman announce broadcasts at a frequency set by the parameter
7151 \m[blue]\fBlm interval\fR\m[]\&. If set to
7152 \fBauto\fR
7153 Samba will not send Lanman announce broadcasts by default but will listen for them\&. If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter
7154 \m[blue]\fBlm interval\fR\m[]\&.
7155 .sp
7156 Default:
7157 \fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR
7158 .sp
7159 Example:
7160 \fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR
7161 .RE
7162
7163 lm interval (G)
7164 .PP
7165 .RS 4
7166 If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
7167 \m[blue]\fBlm announce\fR\m[]
7168 parameter) then this parameter defines the frequency in seconds with which they will be made\&. If this is set to zero then no Lanman announcements will be made despite the setting of the
7169 \m[blue]\fBlm announce\fR\m[]
7170 parameter\&.
7171 .sp
7172 Default:
7173 \fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR
7174 .sp
7175 Example:
7176 \fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR
7177 .RE
7178
7179 load printers (G)
7180 .PP
7181 .RS 4
7182 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
7183 printers
7184 section for more details\&.
7185 .sp
7186 Default:
7187 \fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR
7188 .RE
7189
7190 local master (G)
7191 .PP
7192 .RS 4
7193 This option allows
7194 \fBnmbd\fR(8)
7195 to try and become a local master browser on a subnet\&. If set to
7196 \fBno\fR
7197 then
7198 nmbd
7199 will not attempt to become a local master browser on a subnet and will also lose in all browsing elections\&. By default this value is set to
7200 \fByes\fR\&. Setting this value to
7201 \fByes\fR
7202 doesn\*(Aqt mean that Samba will
7203 \fIbecome\fR
7204 the local master browser on a subnet, just that
7205 nmbd
7206 will
7207 \fIparticipate\fR
7208 in elections for local master browser\&.
7209 .sp
7210 Setting this value to
7211 \fBno\fR
7212 will cause
7213 nmbd
7214 \fInever\fR
7215 to become a local master browser\&.
7216 .sp
7217 Default:
7218 \fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR
7219 .RE
7220
7221 lock dir
7222 .PP
7223 .RS 4
7224 This parameter is a synonym for
7225 lock directory\&.
7226 .RE
7227
7228 lock directory (G)
7229 .PP
7230 .RS 4
7231 This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
7232 \m[blue]\fBmax connections\fR\m[]
7233 option\&.
7234 .sp
7235 Note: This option can not be set inside registry configurations\&.
7236 .sp
7237 The files placed in this directory are not required across service restarts and can be safely placed on volatile storage (e\&.g\&. tmpfs in Linux)
7238 .sp
7239 Default:
7240 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/lib/samba/lock\fR\fI \fR
7241 .sp
7242 Example:
7243 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR
7244 .RE
7245
7246 locking (S)
7247 .PP
7248 .RS 4
7249 This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
7250 .sp
7251 If
7252 locking = no, all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking\&.
7253 .sp
7254 If
7255 locking = yes, real locking will be performed by the server\&.
7256 .sp
7257 This option
7258 \fImay\fR
7259 be useful for read\-only filesystems which
7260 \fImay\fR
7261 not need locking (such as CDROM drives), although setting this parameter of
7262 \fBno\fR
7263 is not really recommended even in this case\&.
7264 .sp
7265 Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption\&. You should never need to set this parameter\&.
7266 .sp
7267 Default:
7268 \fI\fIlocking\fR\fR\fI = \fR\fIyes\fR\fI \fR
7269 .RE
7270
7271 lock spin time (G)
7272 .PP
7273 .RS 4
7274 The time in milliseconds that smbd should keep waiting to see if a failed lock request can be granted\&. This parameter has changed in default value from Samba 3\&.0\&.23 from 10 to 200\&. The associated
7275 lock spin count
7276 parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
7277 .sp
7278 Default:
7279 \fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR
7280 .RE
7281
7282 log file (G)
7283 .PP
7284 .RS 4
7285 This option allows you to override the name of the Samba log file (also known as the debug file)\&.
7286 .sp
7287 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
7288 .sp
7289 \fINo default\fR
7290 .sp
7291 Example:
7292 \fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\&.%m\fR\fI \fR
7293 .RE
7294
7295 logging (G)
7296 .PP
7297 .RS 4
7298 This parameter configures logging backends\&. Multiple backends can be specified at the same time, with different log levels for each backend\&. The parameter is a list of backends, where each backend is specified as backend[:option][@loglevel]\&.
7299 .sp
7300 The \*(Aqoption\*(Aq parameter can be used to pass backend\-specific options\&.
7301 .sp
7302 The log level for a backend is optional, if it is not set for a backend, all messages are sent to this backend\&. The parameter
7303 \m[blue]\fBlog level\fR\m[]
7304 determines overall log levels, while the log levels specified here define what is sent to the individual backends\&.
7305 .sp
7306 When
7307 \m[blue]\fBlogging\fR\m[]
7308 is set, it overrides the
7309 \m[blue]\fBsyslog\fR\m[]
7310 and
7311 \m[blue]\fBsyslog only\fR\m[]
7312 parameters\&.
7313 .sp
7314 Some backends are only available when Samba has been compiled with the additional libraries\&. The overall list of logging backends:
7315 .RS
7316 .sp
7317 .RS 4
7318 .ie n \{\
7319 \h'-04'\(bu\h'+03'\c
7320 .\}
7321 .el \{\
7322 .sp -1
7323 .IP \(bu 2.3
7324 .\}
7325 \fIsyslog\fR
7326 .RE
7327 .sp
7328 .RS 4
7329 .ie n \{\
7330 \h'-04'\(bu\h'+03'\c
7331 .\}
7332 .el \{\
7333 .sp -1
7334 .IP \(bu 2.3
7335 .\}
7336 \fIfile\fR
7337 .RE
7338 .sp
7339 .RS 4
7340 .ie n \{\
7341 \h'-04'\(bu\h'+03'\c
7342 .\}
7343 .el \{\
7344 .sp -1
7345 .IP \(bu 2.3
7346 .\}
7347 \fIsystemd\fR
7348 .RE
7349 .sp
7350 .RS 4
7351 .ie n \{\
7352 \h'-04'\(bu\h'+03'\c
7353 .\}
7354 .el \{\
7355 .sp -1
7356 .IP \(bu 2.3
7357 .\}
7358 \fIlttng\fR
7359 .RE
7360 .sp
7361 .RS 4
7362 .ie n \{\
7363 \h'-04'\(bu\h'+03'\c
7364 .\}
7365 .el \{\
7366 .sp -1
7367 .IP \(bu 2.3
7368 .\}
7369 \fIgpfs\fR
7370 .RE
7371 .sp
7372 .RS 4
7373 .ie n \{\
7374 \h'-04'\(bu\h'+03'\c
7375 .\}
7376 .el \{\
7377 .sp -1
7378 .IP \(bu 2.3
7379 .\}
7380 \fIringbuf\fR
7381 .RE
7382 .sp
7383 .RE
7384 The
7385 \fIringbuf\fR
7386 backend supports an optional size argument to change the buffer size used, the default is 1 MB:
7387 \fIringbuf:size=NBYTES\fR
7388 .sp
7389 Default:
7390 \fI\fIlogging\fR\fR\fI = \fR\fI\fR\fI \fR
7391 .sp
7392 Example:
7393 \fI\fIlogging\fR\fR\fI = \fR\fIsyslog@1 file\fR\fI \fR
7394 .RE
7395
7396 debuglevel
7397 .PP
7398 .RS 4
7399 This parameter is a synonym for
7400 log level\&.
7401 .RE
7402
7403 log level (G)
7404 .PP
7405 .RS 4
7406 The value of the parameter (a string) allows the debug level (logging level) to be specified in the
7407 smb\&.conf
7408 file\&.
7409 .sp
7410 This parameter has been extended since the 2\&.2\&.x series, now it allows one to specify the debug level for multiple debug classes and distinct logfiles for debug classes\&. This is to give greater flexibility in the configuration of the system\&. The following debug classes are currently implemented:
7411 .RS
7412 .sp
7413 .RS 4
7414 .ie n \{\
7415 \h'-04'\(bu\h'+03'\c
7416 .\}
7417 .el \{\
7418 .sp -1
7419 .IP \(bu 2.3
7420 .\}
7421 \fIall\fR
7422 .RE
7423 .sp
7424 .RS 4
7425 .ie n \{\
7426 \h'-04'\(bu\h'+03'\c
7427 .\}
7428 .el \{\
7429 .sp -1
7430 .IP \(bu 2.3
7431 .\}
7432 \fItdb\fR
7433 .RE
7434 .sp
7435 .RS 4
7436 .ie n \{\
7437 \h'-04'\(bu\h'+03'\c
7438 .\}
7439 .el \{\
7440 .sp -1
7441 .IP \(bu 2.3
7442 .\}
7443 \fIprintdrivers\fR
7444 .RE
7445 .sp
7446 .RS 4
7447 .ie n \{\
7448 \h'-04'\(bu\h'+03'\c
7449 .\}
7450 .el \{\
7451 .sp -1
7452 .IP \(bu 2.3
7453 .\}
7454 \fIlanman\fR
7455 .RE
7456 .sp
7457 .RS 4
7458 .ie n \{\
7459 \h'-04'\(bu\h'+03'\c
7460 .\}
7461 .el \{\
7462 .sp -1
7463 .IP \(bu 2.3
7464 .\}
7465 \fIsmb\fR
7466 .RE
7467 .sp
7468 .RS 4
7469 .ie n \{\
7470 \h'-04'\(bu\h'+03'\c
7471 .\}
7472 .el \{\
7473 .sp -1
7474 .IP \(bu 2.3
7475 .\}
7476 \fIrpc_parse\fR
7477 .RE
7478 .sp
7479 .RS 4
7480 .ie n \{\
7481 \h'-04'\(bu\h'+03'\c
7482 .\}
7483 .el \{\
7484 .sp -1
7485 .IP \(bu 2.3
7486 .\}
7487 \fIrpc_srv\fR
7488 .RE
7489 .sp
7490 .RS 4
7491 .ie n \{\
7492 \h'-04'\(bu\h'+03'\c
7493 .\}
7494 .el \{\
7495 .sp -1
7496 .IP \(bu 2.3
7497 .\}
7498 \fIrpc_cli\fR
7499 .RE
7500 .sp
7501 .RS 4
7502 .ie n \{\
7503 \h'-04'\(bu\h'+03'\c
7504 .\}
7505 .el \{\
7506 .sp -1
7507 .IP \(bu 2.3
7508 .\}
7509 \fIpassdb\fR
7510 .RE
7511 .sp
7512 .RS 4
7513 .ie n \{\
7514 \h'-04'\(bu\h'+03'\c
7515 .\}
7516 .el \{\
7517 .sp -1
7518 .IP \(bu 2.3
7519 .\}
7520 \fIsam\fR
7521 .RE
7522 .sp
7523 .RS 4
7524 .ie n \{\
7525 \h'-04'\(bu\h'+03'\c
7526 .\}
7527 .el \{\
7528 .sp -1
7529 .IP \(bu 2.3
7530 .\}
7531 \fIauth\fR
7532 .RE
7533 .sp
7534 .RS 4
7535 .ie n \{\
7536 \h'-04'\(bu\h'+03'\c
7537 .\}
7538 .el \{\
7539 .sp -1
7540 .IP \(bu 2.3
7541 .\}
7542 \fIwinbind\fR
7543 .RE
7544 .sp
7545 .RS 4
7546 .ie n \{\
7547 \h'-04'\(bu\h'+03'\c
7548 .\}
7549 .el \{\
7550 .sp -1
7551 .IP \(bu 2.3
7552 .\}
7553 \fIvfs\fR
7554 .RE
7555 .sp
7556 .RS 4
7557 .ie n \{\
7558 \h'-04'\(bu\h'+03'\c
7559 .\}
7560 .el \{\
7561 .sp -1
7562 .IP \(bu 2.3
7563 .\}
7564 \fIidmap\fR
7565 .RE
7566 .sp
7567 .RS 4
7568 .ie n \{\
7569 \h'-04'\(bu\h'+03'\c
7570 .\}
7571 .el \{\
7572 .sp -1
7573 .IP \(bu 2.3
7574 .\}
7575 \fIquota\fR
7576 .RE
7577 .sp
7578 .RS 4
7579 .ie n \{\
7580 \h'-04'\(bu\h'+03'\c
7581 .\}
7582 .el \{\
7583 .sp -1
7584 .IP \(bu 2.3
7585 .\}
7586 \fIacls\fR
7587 .RE
7588 .sp
7589 .RS 4
7590 .ie n \{\
7591 \h'-04'\(bu\h'+03'\c
7592 .\}
7593 .el \{\
7594 .sp -1
7595 .IP \(bu 2.3
7596 .\}
7597 \fIlocking\fR
7598 .RE
7599 .sp
7600 .RS 4
7601 .ie n \{\
7602 \h'-04'\(bu\h'+03'\c
7603 .\}
7604 .el \{\
7605 .sp -1
7606 .IP \(bu 2.3
7607 .\}
7608 \fImsdfs\fR
7609 .RE
7610 .sp
7611 .RS 4
7612 .ie n \{\
7613 \h'-04'\(bu\h'+03'\c
7614 .\}
7615 .el \{\
7616 .sp -1
7617 .IP \(bu 2.3
7618 .\}
7619 \fIdmapi\fR
7620 .RE
7621 .sp
7622 .RS 4
7623 .ie n \{\
7624 \h'-04'\(bu\h'+03'\c
7625 .\}
7626 .el \{\
7627 .sp -1
7628 .IP \(bu 2.3
7629 .\}
7630 \fIregistry\fR
7631 .RE
7632 .sp
7633 .RS 4
7634 .ie n \{\
7635 \h'-04'\(bu\h'+03'\c
7636 .\}
7637 .el \{\
7638 .sp -1
7639 .IP \(bu 2.3
7640 .\}
7641 \fIscavenger\fR
7642 .RE
7643 .sp
7644 .RS 4
7645 .ie n \{\
7646 \h'-04'\(bu\h'+03'\c
7647 .\}
7648 .el \{\
7649 .sp -1
7650 .IP \(bu 2.3
7651 .\}
7652 \fIdns\fR
7653 .RE
7654 .sp
7655 .RS 4
7656 .ie n \{\
7657 \h'-04'\(bu\h'+03'\c
7658 .\}
7659 .el \{\
7660 .sp -1
7661 .IP \(bu 2.3
7662 .\}
7663 \fIldb\fR
7664 .RE
7665 .sp
7666 .RS 4
7667 .ie n \{\
7668 \h'-04'\(bu\h'+03'\c
7669 .\}
7670 .el \{\
7671 .sp -1
7672 .IP \(bu 2.3
7673 .\}
7674 \fItevent\fR
7675 .RE
7676 .sp
7677 .RS 4
7678 .ie n \{\
7679 \h'-04'\(bu\h'+03'\c
7680 .\}
7681 .el \{\
7682 .sp -1
7683 .IP \(bu 2.3
7684 .\}
7685 \fIauth_audit\fR
7686 .RE
7687 .sp
7688 .RS 4
7689 .ie n \{\
7690 \h'-04'\(bu\h'+03'\c
7691 .\}
7692 .el \{\
7693 .sp -1
7694 .IP \(bu 2.3
7695 .\}
7696 \fIauth_json_audit\fR
7697 .RE
7698 .sp
7699 .RS 4
7700 .ie n \{\
7701 \h'-04'\(bu\h'+03'\c
7702 .\}
7703 .el \{\
7704 .sp -1
7705 .IP \(bu 2.3
7706 .\}
7707 \fIkerberos\fR
7708 .RE
7709 .sp
7710 .RS 4
7711 .ie n \{\
7712 \h'-04'\(bu\h'+03'\c
7713 .\}
7714 .el \{\
7715 .sp -1
7716 .IP \(bu 2.3
7717 .\}
7718 \fIdrs_repl\fR
7719 .RE
7720 .sp
7721 .RS 4
7722 .ie n \{\
7723 \h'-04'\(bu\h'+03'\c
7724 .\}
7725 .el \{\
7726 .sp -1
7727 .IP \(bu 2.3
7728 .\}
7729 \fIsmb2\fR
7730 .RE
7731 .sp
7732 .RS 4
7733 .ie n \{\
7734 \h'-04'\(bu\h'+03'\c
7735 .\}
7736 .el \{\
7737 .sp -1
7738 .IP \(bu 2.3
7739 .\}
7740 \fIsmb2_credits\fR
7741 .RE
7742 .sp
7743 .RS 4
7744 .ie n \{\
7745 \h'-04'\(bu\h'+03'\c
7746 .\}
7747 .el \{\
7748 .sp -1
7749 .IP \(bu 2.3
7750 .\}
7751 \fIdsdb_audit\fR
7752 .RE
7753 .sp
7754 .RS 4
7755 .ie n \{\
7756 \h'-04'\(bu\h'+03'\c
7757 .\}
7758 .el \{\
7759 .sp -1
7760 .IP \(bu 2.3
7761 .\}
7762 \fIdsdb_json_audit\fR
7763 .RE
7764 .sp
7765 .RS 4
7766 .ie n \{\
7767 \h'-04'\(bu\h'+03'\c
7768 .\}
7769 .el \{\
7770 .sp -1
7771 .IP \(bu 2.3
7772 .\}
7773 \fIdsdb_password_audit\fR
7774 .RE
7775 .sp
7776 .RS 4
7777 .ie n \{\
7778 \h'-04'\(bu\h'+03'\c
7779 .\}
7780 .el \{\
7781 .sp -1
7782 .IP \(bu 2.3
7783 .\}
7784 \fIdsdb_password_json_audit\fR
7785 .RE
7786 .sp
7787 .RS 4
7788 .ie n \{\
7789 \h'-04'\(bu\h'+03'\c
7790 .\}
7791 .el \{\
7792 .sp -1
7793 .IP \(bu 2.3
7794 .\}
7795 \fIdsdb_transaction_audit\fR
7796 .RE
7797 .sp
7798 .RS 4
7799 .ie n \{\
7800 \h'-04'\(bu\h'+03'\c
7801 .\}
7802 .el \{\
7803 .sp -1
7804 .IP \(bu 2.3
7805 .\}
7806 \fIdsdb_transaction_json_audit\fR
7807 .RE
7808 .sp
7809 .RS 4
7810 .ie n \{\
7811 \h'-04'\(bu\h'+03'\c
7812 .\}
7813 .el \{\
7814 .sp -1
7815 .IP \(bu 2.3
7816 .\}
7817 \fIdsdb_group_audit\fR
7818 .RE
7819 .sp
7820 .RS 4
7821 .ie n \{\
7822 \h'-04'\(bu\h'+03'\c
7823 .\}
7824 .el \{\
7825 .sp -1
7826 .IP \(bu 2.3
7827 .\}
7828 \fIdsdb_group_json_audit\fR
7829 .RE
7830 .sp
7831 .RS 4
7832 .ie n \{\
7833 \h'-04'\(bu\h'+03'\c
7834 .\}
7835 .el \{\
7836 .sp -1
7837 .IP \(bu 2.3
7838 .\}
7839 \fIldapsrv\fR
7840 .RE
7841 .sp
7842 .RE
7843 Various modules register dynamic debug classes at first usage:
7844 .RS
7845 .sp
7846 .RS 4
7847 .ie n \{\
7848 \h'-04'\(bu\h'+03'\c
7849 .\}
7850 .el \{\
7851 .sp -1
7852 .IP \(bu 2.3
7853 .\}
7854 \fIcatia\fR
7855 .RE
7856 .sp
7857 .RS 4
7858 .ie n \{\
7859 \h'-04'\(bu\h'+03'\c
7860 .\}
7861 .el \{\
7862 .sp -1
7863 .IP \(bu 2.3
7864 .\}
7865 \fIdfs_samba4\fR
7866 .RE
7867 .sp
7868 .RS 4
7869 .ie n \{\
7870 \h'-04'\(bu\h'+03'\c
7871 .\}
7872 .el \{\
7873 .sp -1
7874 .IP \(bu 2.3
7875 .\}
7876 \fIextd_audit\fR
7877 .RE
7878 .sp
7879 .RS 4
7880 .ie n \{\
7881 \h'-04'\(bu\h'+03'\c
7882 .\}
7883 .el \{\
7884 .sp -1
7885 .IP \(bu 2.3
7886 .\}
7887 \fIfileid\fR
7888 .RE
7889 .sp
7890 .RS 4
7891 .ie n \{\
7892 \h'-04'\(bu\h'+03'\c
7893 .\}
7894 .el \{\
7895 .sp -1
7896 .IP \(bu 2.3
7897 .\}
7898 \fIfruit\fR
7899 .RE
7900 .sp
7901 .RS 4
7902 .ie n \{\
7903 \h'-04'\(bu\h'+03'\c
7904 .\}
7905 .el \{\
7906 .sp -1
7907 .IP \(bu 2.3
7908 .\}
7909 \fIfull_audit\fR
7910 .RE
7911 .sp
7912 .RS 4
7913 .ie n \{\
7914 \h'-04'\(bu\h'+03'\c
7915 .\}
7916 .el \{\
7917 .sp -1
7918 .IP \(bu 2.3
7919 .\}
7920 \fImedia_harmony\fR
7921 .RE
7922 .sp
7923 .RS 4
7924 .ie n \{\
7925 \h'-04'\(bu\h'+03'\c
7926 .\}
7927 .el \{\
7928 .sp -1
7929 .IP \(bu 2.3
7930 .\}
7931 \fIpreopen\fR
7932 .RE
7933 .sp
7934 .RS 4
7935 .ie n \{\
7936 \h'-04'\(bu\h'+03'\c
7937 .\}
7938 .el \{\
7939 .sp -1
7940 .IP \(bu 2.3
7941 .\}
7942 \fIrecycle\fR
7943 .RE
7944 .sp
7945 .RS 4
7946 .ie n \{\
7947 \h'-04'\(bu\h'+03'\c
7948 .\}
7949 .el \{\
7950 .sp -1
7951 .IP \(bu 2.3
7952 .\}
7953 \fIshadow_copy\fR
7954 .RE
7955 .sp
7956 .RS 4
7957 .ie n \{\
7958 \h'-04'\(bu\h'+03'\c
7959 .\}
7960 .el \{\
7961 .sp -1
7962 .IP \(bu 2.3
7963 .\}
7964 \fIshadow_copy\fR
7965 .RE
7966 .sp
7967 .RS 4
7968 .ie n \{\
7969 \h'-04'\(bu\h'+03'\c
7970 .\}
7971 .el \{\
7972 .sp -1
7973 .IP \(bu 2.3
7974 .\}
7975 \fIunityed_media\fR
7976 .RE
7977 .sp
7978 .RS 4
7979 .ie n \{\
7980 \h'-04'\(bu\h'+03'\c
7981 .\}
7982 .el \{\
7983 .sp -1
7984 .IP \(bu 2.3
7985 .\}
7986 \fIvirusfilter\fR
7987 .RE
7988 .sp
7989 .RE
7990 To configure the logging for specific classes to go into a different file then
7991 \m[blue]\fBlog file\fR\m[], you can append
7992 \fI@PATH\fR
7993 to the class, eg
7994 \fIlog level = 1 full_audit:1@/var/log/audit\&.log\fR\&.
7995 .sp
7996 Authentication and authorization audit information is logged under the
7997 \fIauth_audit\fR, and if Samba was not compiled with \-\-without\-json, a JSON representation is logged under
7998 \fIauth_json_audit\fR\&.
7999 .sp
8000 Support is comprehensive for all authentication and authorisation of user accounts in the Samba Active Directory Domain Controller, as well as the implicit authentication in password changes\&. In the file server, NTLM authentication, SMB and RPC authorization is covered\&.
8001 .sp
8002 Log levels for
8003 \fIauth_audit\fR
8004 and
8005 \fIauth_audit_json\fR
8006 are:
8007 .RS
8008 .sp
8009 .RS 4
8010 .ie n \{\
8011 \h'-04'\(bu\h'+03'\c
8012 .\}
8013 .el \{\
8014 .sp -1
8015 .IP \(bu 2.3
8016 .\}
8017 2: Authentication Failure
8018 .RE
8019 .sp
8020 .RS 4
8021 .ie n \{\
8022 \h'-04'\(bu\h'+03'\c
8023 .\}
8024 .el \{\
8025 .sp -1
8026 .IP \(bu 2.3
8027 .\}
8028 3: Authentication Success
8029 .RE
8030 .sp
8031 .RS 4
8032 .ie n \{\
8033 \h'-04'\(bu\h'+03'\c
8034 .\}
8035 .el \{\
8036 .sp -1
8037 .IP \(bu 2.3
8038 .\}
8039 4: Authorization Success
8040 .RE
8041 .sp
8042 .RS 4
8043 .ie n \{\
8044 \h'-04'\(bu\h'+03'\c
8045 .\}
8046 .el \{\
8047 .sp -1
8048 .IP \(bu 2.3
8049 .\}
8050 5: Anonymous Authentication and Authorization Success
8051 .RE
8052 .sp
8053 .RE
8054 Changes to the AD DC
8055 sam\&.ldb
8056 database are logged under the
8057 \fIdsdb_audit\fR
8058 and a JSON representation is logged under
8059 \fIdsdb_json_audit\fR\&.
8060 .sp
8061 Group membership changes to the AD DC
8062 sam\&.ldb
8063 database are logged under the
8064 \fIdsdb_group_audit\fR
8065 and a JSON representation is logged under
8066 \fIdsdb_group_json_audit\fR\&.
8067 .sp
8068 Log levels for
8069 \fIdsdb_audit\fR,
8070 \fIdsdb_json_audit\fR,
8071 \fIdsdb_group_audit\fR,
8072 \fIdsdb_group_json_audit\fR
8073 and
8074 \fIdsdb_json_audit\fR
8075 are:
8076 .RS
8077 .sp
8078 .RS 4
8079 .ie n \{\
8080 \h'-04'\(bu\h'+03'\c
8081 .\}
8082 .el \{\
8083 .sp -1
8084 .IP \(bu 2.3
8085 .\}
8086 5: Database modifications
8087 .RE
8088 .sp
8089 .RS 4
8090 .ie n \{\
8091 \h'-04'\(bu\h'+03'\c
8092 .\}
8093 .el \{\
8094 .sp -1
8095 .IP \(bu 2.3
8096 .\}
8097 5: Replicated updates from another DC
8098 .RE
8099 .sp
8100 .RE
8101 In the AD DC, password changes, password resets, and certain authentication related attribute changes are logged under
8102 \fIdsdb_password_audit\fR
8103 and a JSON representation is logged under the
8104 \fIdsdb_password_json_audit\fR\&. Password changes will also appears as authentication events via
8105 \fIauth_audit\fR
8106 and
8107 \fIauth_audit_json\fR\&.
8108 .sp
8109 Log levels for
8110 \fIdsdb_password_audit\fR
8111 and
8112 \fIdsdb_password_json_audit\fR
8113 are:
8114 .RS
8115 .sp
8116 .RS 4
8117 .ie n \{\
8118 \h'-04'\(bu\h'+03'\c
8119 .\}
8120 .el \{\
8121 .sp -1
8122 .IP \(bu 2.3
8123 .\}
8124 5: Successful password changes and resets, and authentication related attribute changes\&.
8125 .RE
8126 .sp
8127 .RE
8128 Changes to the following attributes are logged:
8129 .RS
8130 .sp
8131 .RS 4
8132 .ie n \{\
8133 \h'-04'\(bu\h'+03'\c
8134 .\}
8135 .el \{\
8136 .sp -1
8137 .IP \(bu 2.3
8138 .\}
8139 altSecurityIdentities
8140 .RE
8141 .sp
8142 .RS 4
8143 .ie n \{\
8144 \h'-04'\(bu\h'+03'\c
8145 .\}
8146 .el \{\
8147 .sp -1
8148 .IP \(bu 2.3
8149 .\}
8150 dNSHostName
8151 .RE
8152 .sp
8153 .RS 4
8154 .ie n \{\
8155 \h'-04'\(bu\h'+03'\c
8156 .\}
8157 .el \{\
8158 .sp -1
8159 .IP \(bu 2.3
8160 .\}
8161 msDS\-AdditionalDnsHostName
8162 .RE
8163 .sp
8164 .RS 4
8165 .ie n \{\
8166 \h'-04'\(bu\h'+03'\c
8167 .\}
8168 .el \{\
8169 .sp -1
8170 .IP \(bu 2.3
8171 .\}
8172 msDS\-KeyCredentialLink
8173 .RE
8174 .sp
8175 .RS 4
8176 .ie n \{\
8177 \h'-04'\(bu\h'+03'\c
8178 .\}
8179 .el \{\
8180 .sp -1
8181 .IP \(bu 2.3
8182 .\}
8183 servicePrincipalName
8184 .RE
8185 .sp
8186 .RE
8187 In the
8188 \fIdsdb_password_json_audit\fR
8189 log these are given the value "Auth info change" in the "action" field\&. Password changes and resets have the value "change" and "reset" in this field, respectively\&.
8190 .sp
8191 Transaction rollbacks and prepare commit failures are logged under the
8192 \fIdsdb_transaction_audit\fR
8193 and a JSON representation is logged under the
8194 \fIdsdb_transaction_json_audit\fR\&.
8195 .sp
8196 Log levels for
8197 \fIdsdb_transaction_audit\fR
8198 and
8199 \fIdsdb_transaction_json\fR
8200 are:
8201 .RS
8202 .sp
8203 .RS 4
8204 .ie n \{\
8205 \h'-04'\(bu\h'+03'\c
8206 .\}
8207 .el \{\
8208 .sp -1
8209 .IP \(bu 2.3
8210 .\}
8211 5: Transaction failure (rollback)
8212 .RE
8213 .sp
8214 .RS 4
8215 .ie n \{\
8216 \h'-04'\(bu\h'+03'\c
8217 .\}
8218 .el \{\
8219 .sp -1
8220 .IP \(bu 2.3
8221 .\}
8222 10: Transaction success (commit)
8223 .RE
8224 .sp
8225 .RE
8226 Transaction roll\-backs are possible in Samba, and whilst they rarely reflect anything more than the failure of an individual operation (say due to the add of a conflicting record), they are possible\&. Audit logs are already generated and sent to the system logs before the transaction is complete\&. Logging the transaction details allows the identification of password and
8227 sam\&.ldb
8228 operations that have been rolled back, and so have not actually persisted\&.
8229 .if n \{\
8230 .sp
8231 .\}
8232 .RS 4
8233 .it 1 an-trap
8234 .nr an-no-space-flag 1
8235 .nr an-break-flag 1
8236 .br
8237 .ps +1
8238 \fBWarning\fR
8239 .ps -1
8240 .br
8241 Changes to
8242 sam\&.ldb
8243 made locally by the
8244 root
8245 user with direct access to the database are not logged to the system logs, but to the administrator\*(Aqs own console\&. While less than ideal, any user able to make such modifications could disable the audit logging in any case\&.
8246 .sp .5v
8247 .RE
8248 Default:
8249 \fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR
8250 .sp
8251 Example:
8252 \fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR
8253 .sp
8254 Example:
8255 \fI\fIlog level\fR\fR\fI = \fR\fI1 full_audit:1@/var/log/audit\&.log winbind:2\fR\fI \fR
8256 .RE
8257
8258 log nt token command (G)
8259 .PP
8260 .RS 4
8261 This option can be set to a command that will be called when new nt tokens are created\&.
8262 .sp
8263 This is only useful for development purposes\&.
8264 .sp
8265 Default:
8266 \fI\fIlog nt token command\fR\fR\fI = \fR\fI\fR\fI \fR
8267 .RE
8268
8269 logon drive (G)
8270 .PP
8271 .RS 4
8272 This parameter specifies the local path to which the home directory will be connected (see
8273 \m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
8274 .sp
8275 Note that this option is only useful if Samba is set up as a logon server\&.
8276 .sp
8277 Default:
8278 \fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR
8279 .sp
8280 Example:
8281 \fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR
8282 .RE
8283
8284 logon home (G)
8285 .PP
8286 .RS 4
8287 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
8288 .sp
8289 C:\e>\fBNET USE H: /HOME\fR
8290 .sp
8291 from a command prompt, for example\&.
8292 .sp
8293 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8294 .sp
8295 This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user\*(Aqs home directory\&. This is done in the following way:
8296 .sp
8297 logon home = \e\e%N\e%U\eprofile
8298 .sp
8299 This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request\&. Win9X clients truncate the info to \e\eserver\eshare when a user does
8300 net use /home
8301 but use the whole string when dealing with profiles\&.
8302 .sp
8303 Note that in prior versions of Samba, the
8304 \m[blue]\fBlogon path\fR\m[]
8305 was returned rather than
8306 \fIlogon home\fR\&. This broke
8307 net use /home
8308 but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
8309 .sp
8310 Disable this feature by setting
8311 \m[blue]\fBlogon home = ""\fR\m[]
8312 \- using the empty string\&.
8313 .sp
8314 This option is only useful if Samba is set up as a logon server\&.
8315 .sp
8316 Default:
8317 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR
8318 .sp
8319 Example:
8320 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR
8321 .RE
8322
8323 logon path (G)
8324 .PP
8325 .RS 4
8326 This parameter specifies the directory where roaming profiles (Desktop, NTuser\&.dat, etc) are stored\&. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles\&. To find out how to handle roaming profiles for Win 9X system, see the
8327 \m[blue]\fBlogon home\fR\m[]
8328 parameter\&.
8329 .sp
8330 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&. It also specifies the directory from which the "Application Data",
8331 desktop,
8332 start menu,
8333 network neighborhood,
8334 programs
8335 and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
8336 .sp
8337 The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client\&. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser\&.dat and other directories\&. Thereafter, the directories and any of the contents can, if required, be made read\-only\&. It is not advisable that the NTuser\&.dat file be made read\-only \- rename it to NTuser\&.man to achieve the desired effect (a
8338 \fIMAN\fRdatory profile)\&.
8339 .sp
8340 Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in\&. Therefore, it is vital that the logon path does not include a reference to the homes share (i\&.e\&. setting this parameter to \e\e%N\ehomes\eprofile_path will cause problems)\&.
8341 .sp
8342 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8343 .if n \{\
8344 .sp
8345 .\}
8346 .RS 4
8347 .it 1 an-trap
8348 .nr an-no-space-flag 1
8349 .nr an-break-flag 1
8350 .br
8351 .ps +1
8352 \fBWarning\fR
8353 .ps -1
8354 .br
8355 Do not quote the value\&. Setting this as
8356 \(lq\e\e%N\eprofile\e%U\(rq
8357 will break profile handling\&. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over\-ride the parameter value present in the smb\&.conf file\&. Any error present in the passdb backend account record must be edited using the appropriate tool (pdbedit on the command\-line, or any other locally provided system tool)\&.
8358 .sp .5v
8359 .RE
8360 Note that this option is only useful if Samba is set up as a domain controller\&.
8361 .sp
8362 Disable the use of roaming profiles by setting the value of this parameter to no value\&. Take note that even if the default setting in the smb\&.conf file is the empty string, any value specified in the user account settings in the passdb backend will over\-ride the effect of setting this parameter to null\&. Disabling of all roaming profile use requires that the user account settings must also be blank\&.
8363 .sp
8364 An example of use is:
8365 .sp
8366 .if n \{\
8367 .RS 4
8368 .\}
8369 .nf
8370 logon path = \e\ePROFILESERVER\ePROFILE\e%U
8371 .fi
8372 .if n \{\
8373 .RE
8374 .\}
8375 .sp
8376 In this example the use of roaming profiles is disabled (depending also on passdb settings):
8377 .sp
8378 .if n \{\
8379 .RS 4
8380 .\}
8381 .nf
8382 logon path =
8383 .fi
8384 .if n \{\
8385 .RE
8386 .\}
8387 .sp
8388 Default:
8389 \fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR
8390 .RE
8391
8392 logon script (G)
8393 .PP
8394 .RS 4
8395 This parameter specifies the batch file (\&.bat) or NT command file (\&.cmd) to be downloaded and run on a machine when a user successfully logs in\&. The file must contain the DOS style CR/LF line endings\&. Using a DOS\-style editor to create the file is recommended\&.
8396 .sp
8397 The script must be a relative path to the
8398 \fI[netlogon]\fR
8399 service\&. If the [netlogon] service specifies a
8400 \m[blue]\fBpath\fR\m[]
8401 of
8402 /usr/local/samba/netlogon, and
8403 \m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
8404 .sp
8405 .if n \{\
8406 .RS 4
8407 .\}
8408 .nf
8409 /usr/local/samba/netlogon/STARTUP\&.BAT
8410 .fi
8411 .if n \{\
8412 .RE
8413 .\}
8414 .sp
8415 The contents of the batch file are entirely your choice\&. A suggested command would be to add
8416 NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\&. Another use would be to add
8417 NET USE U: \e\eSERVER\eUTILS
8418 for commonly used utilities, or
8419 .sp
8420 .if n \{\
8421 .RS 4
8422 .\}
8423 .nf
8424 \fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
8425 .fi
8426 .if n \{\
8427 .RE
8428 .\}
8429 .sp
8430 for example\&.
8431 .sp
8432 Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached\&.
8433 .sp
8434 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8435 .sp
8436 This option is only useful if Samba is set up as a logon server in a classic domain controller role\&. If Samba is set up as an Active Directory domain controller, LDAP attribute
8437 scriptPath
8438 is used instead\&. For configurations where
8439 \m[blue]\fBpassdb backend = ldapsam\fR\m[]
8440 is in use, this option only defines a default value in case LDAP attribute
8441 sambaLogonScript
8442 is missing\&.
8443 .sp
8444 Default:
8445 \fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR
8446 .sp
8447 Example:
8448 \fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\&.bat\fR\fI \fR
8449 .RE
8450
8451 log writeable files on exit (G)
8452 .PP
8453 .RS 4
8454 When the network connection between a CIFS client and Samba dies, Samba has no option but to simply shut down the server side of the network connection\&. If this happens, there is a risk of data corruption because the Windows client did not complete all write operations that the Windows application requested\&. Setting this option to "yes" makes smbd log with a level 0 message a list of all files that have been opened for writing when the network connection died\&. Those are the files that are potentially corrupted\&. It is meant as an aid for the administrator to give him a list of files to do consistency checks on\&.
8455 .sp
8456 Default:
8457 \fI\fIlog writeable files on exit\fR\fR\fI = \fR\fIno\fR\fI \fR
8458 .RE
8459
8460 lppause command (S)
8461 .PP
8462 .RS 4
8463 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
8464 .sp
8465 This command should be a program or script which takes a printer name and job number to pause the print job\&. One way of implementing this is by using job priorities, where jobs having a too low priority won\*(Aqt be sent to the printer\&.
8466 .sp
8467 If a
8468 \fI%p\fR
8469 is given then the printer name is put in its place\&. A
8470 \fI%j\fR
8471 is replaced with the job number (an integer)\&. On HPUX (see
8472 \fIprinting=hpux \fR), if the
8473 \fI\-p%p\fR
8474 option is added to the lpq command, the job will show up with the correct status, i\&.e\&. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status\&.
8475 .sp
8476 Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server\&.
8477 .sp
8478 Currently no default value is given to this string, unless the value of the
8479 \m[blue]\fBprinting\fR\m[]
8480 parameter is
8481 \fBSYSV\fR, in which case the default is :
8482 lp \-i %p\-%j \-H hold
8483 or if the value of the
8484 \fIprinting\fR
8485 parameter is
8486 \fBSOFTQ\fR, then the default is:
8487 qstat \-s \-j%j \-h\&.
8488 .sp
8489 Default:
8490 \fI\fIlppause command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8491 .sp
8492 Example:
8493 \fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR
8494 .RE
8495
8496 lpq cache time (G)
8497 .PP
8498 .RS 4
8499 This controls how long lpq info will be cached for to prevent the
8500 lpq
8501 command being called too often\&. A separate cache is kept for each variation of the
8502 lpq
8503 command used by the system, so if you use different
8504 lpq
8505 commands for different users then they won\*(Aqt share cache information\&.
8506 .sp
8507 The cache files are stored in
8508 /tmp/lpq\&.xxxx
8509 where xxxx is a hash of the
8510 lpq
8511 command in use\&.
8512 .sp
8513 The default is 30 seconds, meaning that the cached results of a previous identical
8514 lpq
8515 command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
8516 lpq
8517 command is very slow\&.
8518 .sp
8519 A value of 0 will disable caching completely\&.
8520 .sp
8521 Default:
8522 \fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR
8523 .sp
8524 Example:
8525 \fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR
8526 .RE
8527
8528 lpq command (S)
8529 .PP
8530 .RS 4
8531 This parameter specifies the command to be executed on the server host in order to obtain
8532 lpq\-style printer status information\&.
8533 .sp
8534 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
8535 .sp
8536 Currently nine styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ\&. This covers most UNIX systems\&. You control which type is expected using the
8537 \fIprinting =\fR
8538 option\&.
8539 .sp
8540 Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about\&. To get around this, the server reports on the first printer service connected to by the client\&. This only happens if the connection number sent is invalid\&.
8541 .sp
8542 If a
8543 \fI%p\fR
8544 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8545 .sp
8546 Note that it is good practice to include the absolute path in the
8547 \fIlpq command\fR
8548 as the
8549 \fB$PATH \fR
8550 may not be available to the server\&. When compiled with the CUPS libraries, no
8551 \fIlpq command\fR
8552 is needed because smbd will make a library call to obtain the print queue listing\&.
8553 .sp
8554 Default:
8555 \fI\fIlpq command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8556 .sp
8557 Example:
8558 \fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR
8559 .RE
8560
8561 lpresume command (S)
8562 .PP
8563 .RS 4
8564 This parameter specifies the command to be executed on the server host in order to restart or continue printing or spooling a specific print job\&.
8565 .sp
8566 This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
8567 \m[blue]\fBlppause command\fR\m[]
8568 parameter\&.
8569 .sp
8570 If a
8571 \fI%p\fR
8572 is given then the printer name is put in its place\&. A
8573 \fI%j\fR
8574 is replaced with the job number (an integer)\&.
8575 .sp
8576 Note that it is good practice to include the absolute path in the
8577 \fIlpresume command\fR
8578 as the PATH may not be available to the server\&.
8579 .sp
8580 See also the
8581 \m[blue]\fBprinting\fR\m[]
8582 parameter\&.
8583 .sp
8584 Default: Currently no default value is given to this string, unless the value of the
8585 \fIprinting\fR
8586 parameter is
8587 \fBSYSV\fR, in which case the default is:
8588 .sp
8589 lp \-i %p\-%j \-H resume
8590 .sp
8591 or if the value of the
8592 \fIprinting\fR
8593 parameter is
8594 \fBSOFTQ\fR, then the default is:
8595 .sp
8596 qstat \-s \-j%j \-r
8597 .sp
8598 Default:
8599 \fI\fIlpresume command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8600 .sp
8601 Example:
8602 \fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR
8603 .RE
8604
8605 lprm command (S)
8606 .PP
8607 .RS 4
8608 This parameter specifies the command to be executed on the server host in order to delete a print job\&.
8609 .sp
8610 This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
8611 .sp
8612 If a
8613 \fI%p\fR
8614 is given then the printer name is put in its place\&. A
8615 \fI%j\fR
8616 is replaced with the job number (an integer)\&.
8617 .sp
8618 Note that it is good practice to include the absolute path in the
8619 \fIlprm command\fR
8620 as the PATH may not be available to the server\&.
8621 .sp
8622 Examples of use are:
8623 .sp
8624 .if n \{\
8625 .RS 4
8626 .\}
8627 .nf
8628 lprm command = /usr/bin/lprm \-P%p %j
8629
8630 or
8631
8632 lprm command = /usr/bin/cancel %p\-%j
8633 .fi
8634 .if n \{\
8635 .RE
8636 .\}
8637 .sp
8638 Default:
8639 \fI\fIlprm command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8640 .RE
8641
8642 lsa over netlogon (G)
8643 .PP
8644 .RS 4
8645 Setting this deprecated option will allow the RPC server in the AD DC to answer the LSARPC interface on the
8646 \epipe\enetlogon
8647 IPC pipe\&.
8648 .sp
8649 When enabled, this matches the behaviour of Microsoft\*(Aqs Windows, due to their internal implementation choices\&.
8650 .sp
8651 If it is disabled (the default), the AD DC can offer improved performance, as the netlogon server is decoupled and can run as multiple processes\&.
8652 .sp
8653 Default:
8654 \fI\fIlsa over netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
8655 .RE
8656
8657 machine password timeout (G)
8658 .PP
8659 .RS 4
8660 If a Samba server is a member of a Windows NT or Active Directory Domain (see the
8661 \m[blue]\fBsecurity = domain\fR\m[]
8662 and
8663 \m[blue]\fBsecurity = ads\fR\m[]
8664 parameters), then periodically a running winbindd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
8665 secrets\&.tdb\&. This parameter specifies how often this password will be changed, in seconds\&. The default is one week (expressed in seconds), the same as a Windows NT Domain member server\&.
8666 .sp
8667 See also
8668 \fBsmbpasswd\fR(8), and the
8669 \m[blue]\fBsecurity = domain\fR\m[]
8670 and
8671 \m[blue]\fBsecurity = ads\fR\m[]
8672 parameters\&.
8673 .sp
8674 Default:
8675 \fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR
8676 .RE
8677
8678 magic output (S)
8679 .PP
8680 .RS 4
8681 This parameter specifies the name of a file which will contain output created by a magic script (see the
8682 \m[blue]\fBmagic script\fR\m[]
8683 parameter below)\&.
8684 .if n \{\
8685 .sp
8686 .\}
8687 .RS 4
8688 .it 1 an-trap
8689 .nr an-no-space-flag 1
8690 .nr an-break-flag 1
8691 .br
8692 .ps +1
8693 \fBWarning\fR
8694 .ps -1
8695 .br
8696 If two clients use the same
8697 \fImagic script \fR
8698 in the same directory the output file content is undefined\&.
8699 .sp .5v
8700 .RE
8701 Default:
8702 \fI\fImagic output\fR\fR\fI = \fR\fI # <magic script name>\&.out\fR\fI \fR
8703 .sp
8704 Example:
8705 \fI\fImagic output\fR\fR\fI = \fR\fImyfile\&.txt\fR\fI \fR
8706 .RE
8707
8708 magic script (S)
8709 .PP
8710 .RS 4
8711 This parameter specifies the name of a file which, if opened, will be executed by the server when the file is closed\&. This allows a UNIX script to be sent to the Samba host and executed on behalf of the connected user\&.
8712 .sp
8713 Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion\&.
8714 .sp
8715 If the script generates output, output will be sent to the file specified by the
8716 \m[blue]\fBmagic output\fR\m[]
8717 parameter (see above)\&.
8718 .sp
8719 Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end\-of\-line marker\&. Magic scripts must be executable
8720 \fIas is\fR
8721 on the host, which for some hosts and some shells will require filtering at the DOS end\&.
8722 .sp
8723 Magic scripts are
8724 \fIEXPERIMENTAL\fR
8725 and should
8726 \fINOT\fR
8727 be relied upon\&.
8728 .sp
8729 Default:
8730 \fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR
8731 .sp
8732 Example:
8733 \fI\fImagic script\fR\fR\fI = \fR\fIuser\&.csh\fR\fI \fR
8734 .RE
8735
8736 mangled names (S)
8737 .PP
8738 .RS 4
8739 This controls whether non\-DOS names under UNIX should be mapped to DOS\-compatible names ("mangled") and made visible, or whether non\-DOS names should simply be ignored\&.
8740 .sp
8741 See the section on
8742 name mangling
8743 for details on how to control the mangling process\&.
8744 .sp
8745 Possible option settings are
8746 .RS
8747 .sp
8748 .RS 4
8749 .ie n \{\
8750 \h'-04'\(bu\h'+03'\c
8751 .\}
8752 .el \{\
8753 .sp -1
8754 .IP \(bu 2.3
8755 .\}
8756 \fIyes\fR
8757 \- enables name mangling for all not DOS 8\&.3 conforming names\&.
8758 .RE
8759 .sp
8760 .RS 4
8761 .ie n \{\
8762 \h'-04'\(bu\h'+03'\c
8763 .\}
8764 .el \{\
8765 .sp -1
8766 .IP \(bu 2.3
8767 .\}
8768 \fIno\fR
8769 \- disables any name mangling\&.
8770 .RE
8771 .sp
8772 .RS 4
8773 .ie n \{\
8774 \h'-04'\(bu\h'+03'\c
8775 .\}
8776 .el \{\
8777 .sp -1
8778 .IP \(bu 2.3
8779 .\}
8780 \fIillegal (default)\fR
8781 \- does mangling for names with illegal NTFS characters\&. This is the most sensible setting for modern clients that don\*(Aqt use the shortname anymore\&.
8782 .RE
8783 .sp
8784 .RE
8785 If mangling is used then the mangling method is as follows:
8786 .RS
8787 .sp
8788 .RS 4
8789 .ie n \{\
8790 \h'-04'\(bu\h'+03'\c
8791 .\}
8792 .el \{\
8793 .sp -1
8794 .IP \(bu 2.3
8795 .\}
8796 The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters of the mangled name\&.
8797 .RE
8798 .sp
8799 .RS 4
8800 .ie n \{\
8801 \h'-04'\(bu\h'+03'\c
8802 .\}
8803 .el \{\
8804 .sp -1
8805 .IP \(bu 2.3
8806 .\}
8807 A tilde "~" is appended to the first part of the mangled name, followed by a two\-character unique sequence, based on the original root name (i\&.e\&., the original filename minus its final extension)\&. The final extension is included in the hash calculation only if it contains any upper case characters or is longer than three characters\&.
8808 .sp
8809 Note that the character to use may be specified using the
8810 \m[blue]\fBmangling char\fR\m[]
8811 option, if you don\*(Aqt like \*(Aq~\*(Aq\&.
8812 .RE
8813 .sp
8814 .RS 4
8815 .ie n \{\
8816 \h'-04'\(bu\h'+03'\c
8817 .\}
8818 .el \{\
8819 .sp -1
8820 .IP \(bu 2.3
8821 .\}
8822 Files whose UNIX name begins with a dot will be presented as DOS hidden files\&. The mangled name will be created as for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that\*(Aqs three underscores)\&.
8823 .RE
8824 .sp
8825 .RE
8826 The two\-digit hash value consists of upper case alphanumeric characters\&.
8827 .sp
8828 This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters\&. The probability of such a clash is 1/1300\&.
8829 .sp
8830 The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename\&. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename\&. Mangled names do not change between sessions\&.
8831 .sp
8832 Default:
8833 \fI\fImangled names\fR\fR\fI = \fR\fIillegal\fR\fI \fR
8834 .sp
8835 Example:
8836 \fI\fImangled names\fR\fR\fI = \fR\fIno\fR\fI \fR
8837 .RE
8838
8839 mangle prefix (G)
8840 .PP
8841 .RS 4
8842 controls the number of prefix characters from the original name used when generating the mangled names\&. A larger value will give a weaker hash and therefore more name collisions\&. The minimum value is 1 and the maximum value is 6\&.
8843 .sp
8844 mangle prefix is effective only when mangling method is hash2\&.
8845 .sp
8846 Default:
8847 \fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR
8848 .sp
8849 Example:
8850 \fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR
8851 .RE
8852
8853 mangling char (S)
8854 .PP
8855 .RS 4
8856 This controls what character is used as the
8857 \fImagic\fR
8858 character in
8859 name mangling\&. The default is a \*(Aq~\*(Aq but this may interfere with some software\&. Use this option to set it to whatever you prefer\&. This is effective only when mangling method is hash\&.
8860 .sp
8861 Default:
8862 \fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR
8863 .sp
8864 Example:
8865 \fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR
8866 .RE
8867
8868 mangling method (G)
8869 .PP
8870 .RS 4
8871 controls the algorithm used for the generating the mangled names\&. Can take two different values, "hash" and "hash2"\&. "hash" is the algorithm that was used in Samba for many years and was the default in Samba 2\&.2\&.x "hash2" is now the default and is newer and considered a better algorithm (generates less collisions) in the names\&. Many Win32 applications store the mangled names and so changing to algorithms must not be done lightly as these applications may break unless reinstalled\&.
8872 .sp
8873 Default:
8874 \fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR
8875 .sp
8876 Example:
8877 \fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR
8878 .RE
8879
8880 map acl inherit (S)
8881 .PP
8882 .RS 4
8883 This boolean parameter is only relevant for systems that do not support standardized NFS4 ACLs but only a POSIX draft implementation of ACLs\&. Linux is the only common UNIX system which does still not offer standardized NFS4 ACLs actually\&. On such systems this parameter controls whether
8884 \fBsmbd\fR(8)
8885 will attempt to map the \*(Aqprotected\*(Aq (don\*(Aqt inherit) flags of the Windows ACLs into an extended attribute called user\&.SAMBA_PAI (POSIX draft ACL Inheritance)\&. This parameter requires support for extended attributes on the filesystem and allows the Windows ACL editor to store (non\-)inheritance information while NT ACLs are mapped best\-effort to the POSIX draft ACLs that the OS and filesystem implements\&.
8886 .sp
8887 Default:
8888 \fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR
8889 .RE
8890
8891 map archive (S)
8892 .PP
8893 .RS 4
8894 This controls whether the DOS archive attribute should be mapped to the UNIX owner execute bit\&. The DOS archive bit is set when a file has been modified since its last backup\&. One motivation for this option is to keep Samba/your PC from making any file it touches from becoming executable under UNIX\&. This can be quite annoying for shared source code, documents, etc\&.\&.\&.
8895 .sp
8896 Note that this parameter will be ignored if the
8897 \m[blue]\fBstore dos attributes\fR\m[]
8898 parameter is set, as the DOS archive attribute will then be stored inside a UNIX extended attribute\&.
8899 .sp
8900 Note that this requires the
8901 \m[blue]\fBcreate mask\fR\m[]
8902 parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
8903 \m[blue]\fBcreate mask\fR\m[]
8904 for details\&.
8905 .sp
8906 Default:
8907 \fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR
8908 .RE
8909
8910 map hidden (S)
8911 .PP
8912 .RS 4
8913 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
8914 .sp
8915 Note that this parameter will be ignored if the
8916 \m[blue]\fBstore dos attributes\fR\m[]
8917 parameter is set, as the DOS hidden attribute will then be stored inside a UNIX extended attribute\&.
8918 .sp
8919 Note that this requires the
8920 \m[blue]\fBcreate mask\fR\m[]
8921 to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
8922 \m[blue]\fBcreate mask\fR\m[]
8923 for details\&.
8924 .sp
8925 Default:
8926 \fI\fImap hidden\fR\fR\fI = \fR\fIno\fR\fI \fR
8927 .RE
8928
8929 map readonly (S)
8930 .PP
8931 .RS 4
8932 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
8933 .sp
8934 This parameter can take three different values, which tell
8935 \fBsmbd\fR(8)
8936 how to display the read only attribute on files, where either
8937 \m[blue]\fBstore dos attributes\fR\m[]
8938 is set to
8939 \fBNo\fR, or no extended attribute is present\&. If
8940 \m[blue]\fBstore dos attributes\fR\m[]
8941 is set to
8942 \fByes\fR
8943 then this parameter is
8944 \fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
8945 .sp
8946 The three settings are :
8947 .RS
8948 .sp
8949 .RS 4
8950 .ie n \{\
8951 \h'-04'\(bu\h'+03'\c
8952 .\}
8953 .el \{\
8954 .sp -1
8955 .IP \(bu 2.3
8956 .\}
8957 \fBYes\fR
8958 \- The read only DOS attribute is mapped to the inverse of the user or owner write bit in the unix permission mode set\&. If the owner write bit is not set, the read only attribute is reported as being set on the file\&. If the read only DOS attribute is set, Samba sets the owner, group and others write bits to zero\&. Write bits set in an ACL are ignored by Samba\&. If the read only DOS attribute is unset, Samba simply sets the write bit of the owner to one\&.
8959 .RE
8960 .sp
8961 .RS 4
8962 .ie n \{\
8963 \h'-04'\(bu\h'+03'\c
8964 .\}
8965 .el \{\
8966 .sp -1
8967 .IP \(bu 2.3
8968 .\}
8969 \fBPermissions\fR
8970 \- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
8971 \fBsmbd\fR(8)
8972 by reading the unix permissions and filesystem ACL (if present)\&. If the connecting user does not have permission to modify the file, the read only attribute is reported as being set on the file\&.
8973 .RE
8974 .sp
8975 .RS 4
8976 .ie n \{\
8977 \h'-04'\(bu\h'+03'\c
8978 .\}
8979 .el \{\
8980 .sp -1
8981 .IP \(bu 2.3
8982 .\}
8983 \fBNo\fR
8984 \- The read only DOS attribute is unaffected by permissions, and can only be set by the
8985 \m[blue]\fBstore dos attributes\fR\m[]
8986 method\&. This may be useful for exporting mounted CDs\&.
8987 .RE
8988 .sp
8989 .RE
8990 Note that this parameter will be ignored if the
8991 \m[blue]\fBstore dos attributes\fR\m[]
8992 parameter is set, as the DOS \*(Aqread\-only\*(Aq attribute will then be stored inside a UNIX extended attribute\&.
8993 .sp
8994 The default has changed to no in Samba release 4\&.9\&.0 and above to allow better Windows fileserver compatibility in a default install\&. In addition the default setting of
8995 \m[blue]\fBstore dos attributes\fR\m[]
8996 has been changed to
8997 \fBYes\fR
8998 in Samba release 4\&.9\&.0 and above\&.
8999 .sp
9000 Default:
9001 \fI\fImap readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
9002 .RE
9003
9004 map system (S)
9005 .PP
9006 .RS 4
9007 This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
9008 .sp
9009 Note that this parameter will be ignored if the
9010 \m[blue]\fBstore dos attributes\fR\m[]
9011 parameter is set, as the DOS system attribute will then be stored inside a UNIX extended attribute\&.
9012 .sp
9013 Note that this requires the
9014 \m[blue]\fBcreate mask\fR\m[]
9015 to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
9016 \m[blue]\fBcreate mask\fR\m[]
9017 for details\&.
9018 .sp
9019 Default:
9020 \fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR
9021 .RE
9022
9023 map to guest (G)
9024 .PP
9025 .RS 4
9026 This parameter can take four different values, which tell
9027 \fBsmbd\fR(8)
9028 what to do with user login requests that don\*(Aqt match a valid UNIX user in some way\&.
9029 .sp
9030 The four settings are :
9031 .RS
9032 .sp
9033 .RS 4
9034 .ie n \{\
9035 \h'-04'\(bu\h'+03'\c
9036 .\}
9037 .el \{\
9038 .sp -1
9039 .IP \(bu 2.3
9040 .\}
9041 \fBNever\fR
9042 \- Means user login requests with an invalid password are rejected\&. This is the default\&.
9043 .RE
9044 .sp
9045 .RS 4
9046 .ie n \{\
9047 \h'-04'\(bu\h'+03'\c
9048 .\}
9049 .el \{\
9050 .sp -1
9051 .IP \(bu 2.3
9052 .\}
9053 \fBBad User\fR
9054 \- Means user logins with an invalid password are rejected, unless the username does not exist, in which case it is treated as a guest login and mapped into the
9055 \m[blue]\fBguest account\fR\m[]\&.
9056 .RE
9057 .sp
9058 .RS 4
9059 .ie n \{\
9060 \h'-04'\(bu\h'+03'\c
9061 .\}
9062 .el \{\
9063 .sp -1
9064 .IP \(bu 2.3
9065 .\}
9066 \fBBad Password\fR
9067 \- Means user logins with an invalid password are treated as a guest login and mapped into the
9068 \m[blue]\fBguest account\fR\m[]\&. Note that this can cause problems as it means that any user incorrectly typing their password will be silently logged on as "guest" \- and will not know the reason they cannot access files they think they should \- there will have been no message given to them that they got their password wrong\&. Helpdesk services will
9069 \fIhate\fR
9070 you if you set the
9071 \fImap to guest\fR
9072 parameter this way :\-)\&.
9073 .RE
9074 .sp
9075 .RS 4
9076 .ie n \{\
9077 \h'-04'\(bu\h'+03'\c
9078 .\}
9079 .el \{\
9080 .sp -1
9081 .IP \(bu 2.3
9082 .\}
9083 \fBBad Uid\fR
9084 \- Is only applicable when Samba is configured in some type of domain mode security (security = {domain|ads}) and means that user logins which are successfully authenticated but which have no valid Unix user account (and smbd is unable to create one) should be mapped to the defined guest account\&. This was the default behavior of Samba 2\&.x releases\&. Note that if a member server is running winbindd, this option should never be required because the nss_winbind library will export the Windows domain users and groups to the underlying OS via the Name Service Switch interface\&.
9085 .RE
9086 .sp
9087 .RE
9088 Note that this parameter is needed to set up "Guest" share services\&. This is because in these modes the name of the resource being requested is
9089 \fInot\fR
9090 sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares\&.
9091 .sp
9092 Default:
9093 \fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR
9094 .sp
9095 Example:
9096 \fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR
9097 .RE
9098
9099 max connections (S)
9100 .PP
9101 .RS 4
9102 This option allows the number of simultaneous connections to a service to be limited\&. If
9103 \fImax connections\fR
9104 is greater than 0 then connections will be refused if this number of connections to the service are already open\&. A value of zero mean an unlimited number of connections may be made\&.
9105 .sp
9106 Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
9107 \m[blue]\fBlock directory\fR\m[]
9108 option\&.
9109 .sp
9110 Default:
9111 \fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR
9112 .sp
9113 Example:
9114 \fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR
9115 .RE
9116
9117 max disk size (G)
9118 .PP
9119 .RS 4
9120 This option allows you to put an upper limit on the apparent size of disks\&. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size\&.
9121 .sp
9122 Note that this option does not limit the amount of data you can put on the disk\&. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in
9123 \fImax disk size\fR\&.
9124 .sp
9125 This option is primarily useful to work around bugs in some pieces of software that can\*(Aqt handle very large disks, particularly disks over 1GB in size\&.
9126 .sp
9127 A
9128 \fImax disk size\fR
9129 of 0 means no limit\&.
9130 .sp
9131 Default:
9132 \fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR
9133 .sp
9134 Example:
9135 \fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR
9136 .RE
9137
9138 max log size (G)
9139 .PP
9140 .RS 4
9141 This option (an integer in kilobytes) specifies the max size the log file should grow to\&. Samba periodically checks the size and if it is exceeded it will rename the file, adding a
9142 \&.old
9143 extension\&.
9144 .sp
9145 A size of 0 means no limit\&.
9146 .sp
9147 Default:
9148 \fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR
9149 .sp
9150 Example:
9151 \fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR
9152 .RE
9153
9154 max mux (G)
9155 .PP
9156 .RS 4
9157 This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow\&. You should never need to set this parameter\&.
9158 .sp
9159 Default:
9160 \fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR
9161 .RE
9162
9163 max open files (G)
9164 .PP
9165 .RS 4
9166 This parameter limits the maximum number of open files that one
9167 \fBsmbd\fR(8)
9168 file serving process may have open for a client at any one time\&. This parameter can be set very high (16384) as Samba uses only one bit per unopened file\&. Setting this parameter lower than 16384 will cause Samba to complain and set this value back to the minimum of 16384, as Windows 7 depends on this number of open file handles being available\&.
9169 .sp
9170 The limit of the number of open files is usually set by the UNIX per\-process file descriptor limit rather than this parameter so you should never need to touch this parameter\&.
9171 .sp
9172 Default:
9173 \fI\fImax open files\fR\fR\fI = \fR\fI16384\fR\fI \fR
9174 .RE
9175
9176 max print jobs (S)
9177 .PP
9178 .RS 4
9179 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
9180 \fBsmbd\fR(8)
9181 will remote "Out of Space" to the client\&.
9182 .sp
9183 Default:
9184 \fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
9185 .sp
9186 Example:
9187 \fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR
9188 .RE
9189
9190 max reported print jobs (S)
9191 .PP
9192 .RS 4
9193 This parameter limits the maximum number of jobs displayed in a port monitor for Samba printer queue at any given moment\&. If this number is exceeded, the excess jobs will not be shown\&. A value of zero means there is no limit on the number of print jobs reported\&.
9194 .sp
9195 Default:
9196 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR
9197 .sp
9198 Example:
9199 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
9200 .RE
9201
9202 max smbd processes (G)
9203 .PP
9204 .RS 4
9205 This parameter limits the maximum number of
9206 \fBsmbd\fR(8)
9207 processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections\&. Remember that under normal operating conditions, each user will have an
9208 \fBsmbd\fR(8)
9209 associated with him or her to handle connections to all shares from a given host\&.
9210 .sp
9211 For a Samba ADDC running the standard process model this option limits the number of processes forked to handle requests\&. Currently new processes are only forked for ldap and netlogon requests\&.
9212 .sp
9213 Default:
9214 \fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR
9215 .sp
9216 Example:
9217 \fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR
9218 .RE
9219
9220 max stat cache size (G)
9221 .PP
9222 .RS 4
9223 This parameter limits the size in memory of any
9224 \fIstat cache\fR
9225 being used to speed up case insensitive name mappings\&. It represents the number of kilobyte (1024) units the stat cache can use\&. A value of zero, meaning unlimited, is not advisable due to increased memory usage\&. You should not need to change this parameter\&.
9226 .sp
9227 Default:
9228 \fI\fImax stat cache size\fR\fR\fI = \fR\fI512\fR\fI \fR
9229 .sp
9230 Example:
9231 \fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR
9232 .RE
9233
9234 max ttl (G)
9235 .PP
9236 .RS 4
9237 This option tells
9238 \fBnmbd\fR(8)
9239 what the default \*(Aqtime to live\*(Aq of NetBIOS names should be (in seconds) when
9240 nmbd
9241 is requesting a name using either a broadcast packet or from a WINS server\&. You should never need to change this parameter\&. The default is 3 days\&.
9242 .sp
9243 Default:
9244 \fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR
9245 .RE
9246
9247 max wins ttl (G)
9248 .PP
9249 .RS 4
9250 This option tells
9251 \fBsmbd\fR(8)
9252 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \*(Aqtime to live\*(Aq of NetBIOS names that
9253 nmbd
9254 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
9255 .sp
9256 Default:
9257 \fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR
9258 .RE
9259
9260 max xmit (G)
9261 .PP
9262 .RS 4
9263 This option controls the maximum packet size that will be negotiated by Samba\*(Aqs
9264 \fBsmbd\fR(8)
9265 for the SMB1 protocol\&. The default is 16644, which matches the behavior of Windows 2000\&. A value below 2048 is likely to cause problems\&. You should never need to change this parameter from its default value\&.
9266 .sp
9267 Default:
9268 \fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR
9269 .sp
9270 Example:
9271 \fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR
9272 .RE
9273
9274 mdns name (G)
9275 .PP
9276 .RS 4
9277 This parameter controls the name that multicast DNS support advertises as its\*(Aq hostname\&.
9278 .sp
9279 The default is to use the NETBIOS name which is typically the hostname in all capital letters\&.
9280 .sp
9281 A setting of mdns will defer the hostname configuration to the MDNS library that is used\&.
9282 .sp
9283 Default:
9284 \fI\fImdns name\fR\fR\fI = \fR\fInetbios\fR\fI \fR
9285 .RE
9286
9287 message command (G)
9288 .PP
9289 .RS 4
9290 This specifies what command to run when the server receives a WinPopup style message\&.
9291 .sp
9292 This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
9293 .sp
9294 An example is:
9295 .sp
9296 .if n \{\
9297 .RS 4
9298 .\}
9299 .nf
9300 message command = csh \-c \*(Aqxedit %s;rm %s\*(Aq &
9301 .fi
9302 .if n \{\
9303 .RE
9304 .\}
9305 .sp
9306 This delivers the message using
9307 xedit, then removes it afterwards\&.
9308 \fINOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY\fR\&. That\*(Aqs why I have the \*(Aq&\*(Aq on the end\&. If it doesn\*(Aqt return immediately then your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully)\&.
9309 .sp
9310 All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
9311 \fI %u\fR
9312 won\*(Aqt work (\fI%U\fR
9313 may be better in this case)\&.
9314 .sp
9315 Apart from the standard substitutions, some additional ones apply\&. In particular:
9316 .RS
9317 .sp
9318 .RS 4
9319 .ie n \{\
9320 \h'-04'\(bu\h'+03'\c
9321 .\}
9322 .el \{\
9323 .sp -1
9324 .IP \(bu 2.3
9325 .\}
9326 \fI%s\fR
9327 = the filename containing the message\&.
9328 .RE
9329 .sp
9330 .RS 4
9331 .ie n \{\
9332 \h'-04'\(bu\h'+03'\c
9333 .\}
9334 .el \{\
9335 .sp -1
9336 .IP \(bu 2.3
9337 .\}
9338 \fI%t\fR
9339 = the destination that the message was sent to (probably the server name)\&.
9340 .RE
9341 .sp
9342 .RS 4
9343 .ie n \{\
9344 \h'-04'\(bu\h'+03'\c
9345 .\}
9346 .el \{\
9347 .sp -1
9348 .IP \(bu 2.3
9349 .\}
9350 \fI%f\fR
9351 = who the message is from\&.
9352 .RE
9353 .sp
9354 .RE
9355 You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
9356 .sp
9357 Here\*(Aqs a way of sending the messages as mail to root:
9358 .sp
9359 .if n \{\
9360 .RS 4
9361 .\}
9362 .nf
9363 message command = /bin/mail \-s \*(Aqmessage from %f on %m\*(Aq root < %s; rm %s
9364 .fi
9365 .if n \{\
9366 .RE
9367 .\}
9368 .sp
9369 If you don\*(Aqt have a message command then the message won\*(Aqt be delivered and Samba will tell the sender there was an error\&. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered\&.
9370 .sp
9371 If you want to silently delete it then try:
9372 .sp
9373 .if n \{\
9374 .RS 4
9375 .\}
9376 .nf
9377 message command = rm %s
9378 .fi
9379 .if n \{\
9380 .RE
9381 .\}
9382 .sp
9383 Default:
9384 \fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR
9385 .sp
9386 Example:
9387 \fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \*(Aqxedit %s; rm %s\*(Aq &\fR\fI \fR
9388 .RE
9389
9390 min domain uid (G)
9391 .PP
9392 .RS 4
9393 The integer parameter specifies the minimum uid allowed when mapping a local account to a domain account\&.
9394 .sp
9395 Note that this option interacts with the configured
9396 \fIidmap ranges\fR!
9397 .sp
9398 Default:
9399 \fI\fImin domain uid\fR\fR\fI = \fR\fI1000\fR\fI \fR
9400 .RE
9401
9402 min print space (S)
9403 .PP
9404 .RS 4
9405 This sets the minimum amount of free disk space that must be available before a user will be able to spool a print job\&. It is specified in kilobytes\&. The default is 0, which means a user can always spool a print job\&.
9406 .sp
9407 Default:
9408 \fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR
9409 .sp
9410 Example:
9411 \fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR
9412 .RE
9413
9414 min receivefile size (G)
9415 .PP
9416 .RS 4
9417 This option changes the behavior of
9418 \fBsmbd\fR(8)
9419 when processing SMBwriteX calls\&. Any incoming SMBwriteX call on a non\-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will be passed to any underlying kernel recvfile or splice system call (if there is no such call Samba will emulate in user space)\&. This allows zero\-copy writes directly from network socket buffers into the filesystem buffer cache, if available\&. It may improve performance but user testing is recommended\&. If set to zero Samba processes SMBwriteX calls in the normal way\&. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be nonzero\&. The maximum value is 128k\&. Values greater than 128k will be silently set to 128k\&.
9420 .sp
9421 Note this option will have NO EFFECT if set on a SMB signed connection\&.
9422 .sp
9423 The default is zero, which disables this option\&.
9424 .sp
9425 Default:
9426 \fI\fImin receivefile size\fR\fR\fI = \fR\fI0\fR\fI \fR
9427 .RE
9428
9429 min wins ttl (G)
9430 .PP
9431 .RS 4
9432 This option tells
9433 \fBnmbd\fR(8)
9434 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \*(Aqtime to live\*(Aq of NetBIOS names that
9435 nmbd
9436 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
9437 .sp
9438 Default:
9439 \fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR
9440 .RE
9441
9442 mit kdc command (G)
9443 .PP
9444 .RS 4
9445 This option specifies the path to the MIT kdc binary\&.
9446 .sp
9447 If the KDC is not installed in the default location and wasn\*(Aqt correctly detected during build then you should modify this variable and point it to the correct binary\&.
9448 .sp
9449 Default:
9450 \fI\fImit kdc command\fR\fR\fI = \fR\fI/usr/sbin/krb5kdc\fR\fI \fR
9451 .sp
9452 Example:
9453 \fI\fImit kdc command\fR\fR\fI = \fR\fI/opt/mit/sbin/krb5kdc\fR\fI \fR
9454 .RE
9455
9456 msdfs proxy (S)
9457 .PP
9458 .RS 4
9459 This parameter indicates that the share is a stand\-in for another CIFS share whose location is specified by the value of the parameter\&. When clients attempt to connect to this share, they are redirected to one or multiple, comma separated proxied shares using the SMB\-Dfs protocol\&.
9460 .sp
9461 Only Dfs roots can act as proxy shares\&. Take a look at the
9462 \m[blue]\fBmsdfs root\fR\m[]
9463 and
9464 \m[blue]\fBhost msdfs\fR\m[]
9465 options to find out how to set up a Dfs root share\&.
9466 .sp
9467 \fINo default\fR
9468 .sp
9469 Example:
9470 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare,\eotherserver2\esomeshare\fR\fI \fR
9471 .RE
9472
9473 msdfs root (S)
9474 .PP
9475 .RS 4
9476 If set to
9477 \fByes\fR, Samba treats the share as a Dfs root and allows clients to browse the distributed file system tree rooted at the share directory\&. Dfs links are specified in the share directory by symbolic links of the form
9478 msdfs:serverA\e\eshareA,serverB\e\eshareB
9479 and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
9480 .sp
9481 Default:
9482 \fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR
9483 .RE
9484
9485 msdfs shuffle referrals (S)
9486 .PP
9487 .RS 4
9488 If set to
9489 \fByes\fR, Samba will shuffle Dfs referrals for a given Dfs link if multiple are available, allowing for load balancing across clients\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
9490 .sp
9491 Default:
9492 \fI\fImsdfs shuffle referrals\fR\fR\fI = \fR\fIno\fR\fI \fR
9493 .RE
9494
9495 multicast dns register (G)
9496 .PP
9497 .RS 4
9498 If compiled with proper support for it, Samba will announce itself with multicast DNS services like for example provided by the Avahi daemon\&.
9499 .sp
9500 This parameter allows disabling Samba to register itself\&.
9501 .sp
9502 Default:
9503 \fI\fImulticast dns register\fR\fR\fI = \fR\fIyes\fR\fI \fR
9504 .RE
9505
9506 name cache timeout (G)
9507 .PP
9508 .RS 4
9509 Specifies the number of seconds it takes before entries in samba\*(Aqs hostname resolve cache time out\&. If the timeout is set to 0\&. the caching is disabled\&.
9510 .sp
9511 Default:
9512 \fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR
9513 .sp
9514 Example:
9515 \fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
9516 .RE
9517
9518 name resolve order (G)
9519 .PP
9520 .RS 4
9521 This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses\&. Its main purpose to is to control how netbios name resolution is performed\&. The option takes a space separated string of name resolution options\&.
9522 .sp
9523 The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
9524 .RS
9525 .sp
9526 .RS 4
9527 .ie n \{\
9528 \h'-04'\(bu\h'+03'\c
9529 .\}
9530 .el \{\
9531 .sp -1
9532 .IP \(bu 2.3
9533 .\}
9534 \fBlmhosts\fR
9535 : Lookup an IP address in the Samba lmhosts file\&. If the line in lmhosts has no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then any name type matches for lookup\&.
9536 .RE
9537 .sp
9538 .RS 4
9539 .ie n \{\
9540 \h'-04'\(bu\h'+03'\c
9541 .\}
9542 .el \{\
9543 .sp -1
9544 .IP \(bu 2.3
9545 .\}
9546 \fBhost\fR
9547 : Do a standard host name to IP address resolution, using the system
9548 /etc/hosts
9549 or DNS lookups\&. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the
9550 /etc/nsswitch\&.conf
9551 file\&. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers)\&. The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap\&._tcp\&.domain\&.
9552 .RE
9553 .sp
9554 .RS 4
9555 .ie n \{\
9556 \h'-04'\(bu\h'+03'\c
9557 .\}
9558 .el \{\
9559 .sp -1
9560 .IP \(bu 2.3
9561 .\}
9562 \fBwins\fR
9563 : Query a name with the IP address listed in the
9564 \m[blue]\fBWINSSERVER\fR\m[]
9565 parameter\&. If no WINS server has been specified this method will be ignored\&.
9566 .RE
9567 .sp
9568 .RS 4
9569 .ie n \{\
9570 \h'-04'\(bu\h'+03'\c
9571 .\}
9572 .el \{\
9573 .sp -1
9574 .IP \(bu 2.3
9575 .\}
9576 \fBbcast\fR
9577 : Do a broadcast on each of the known local interfaces listed in the
9578 \m[blue]\fBinterfaces\fR\m[]
9579 parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
9580 .RE
9581 .sp
9582 .RE
9583 The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup\&.
9584 .sp
9585 When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for
9586 \fIname resolve order\fR:
9587 .sp
9588 name resolve order = wins bcast
9589 .sp
9590 DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless queries for DOMAIN<0x1c> lookups\&.
9591 .sp
9592 Default:
9593 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts wins host bcast\fR\fI \fR
9594 .sp
9595 Example:
9596 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR
9597 .RE
9598
9599 socket address
9600 .PP
9601 .RS 4
9602 This parameter is a synonym for
9603 nbt client socket address\&.
9604 .RE
9605
9606 nbt client socket address (G)
9607 .PP
9608 .RS 4
9609 This option allows you to control what address Samba will send NBT client packets from, and process replies using, including in nmbd\&.
9610 .sp
9611 Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
9612 .sp
9613 By default Samba will send UDP packets from the OS default address for the destination, and accept replies on 0\&.0\&.0\&.0\&.
9614 .sp
9615 This parameter is deprecated\&. See
9616 \m[blue]\fBbind interfaces only = Yes\fR\m[]
9617 and
9618 \m[blue]\fBinterfaces\fR\m[]
9619 for the previous behaviour of controlling the normal listening sockets\&.
9620 .sp
9621 Default:
9622 \fI\fInbt client socket address\fR\fR\fI = \fR\fI0\&.0\&.0\&.0\fR\fI \fR
9623 .sp
9624 Example:
9625 \fI\fInbt client socket address\fR\fR\fI = \fR\fI192\&.168\&.2\&.20\fR\fI \fR
9626 .RE
9627
9628 nbtd:wins_prepend1Bto1Cqueries (G)
9629 .PP
9630 .RS 4
9631 Normally queries for 0x1C names (all logon servers for a domain) will return the first address of the 0x1B names (domain master browser and PDC) as first address in the result list\&. As many client only use the first address in the list by default, all clients will use the same server (the PDC)\&. Windows servers have an option to disable this behavior (since Windows 2000 Service Pack 2)\&.
9632 .sp
9633 Default:
9634 \fI\fInbtd:wins_prepend1Bto1Cqueries\fR\fR\fI = \fR\fIyes\fR\fI \fR
9635 .RE
9636
9637 nbtd:wins_wins_randomize1Clist (G)
9638 .PP
9639 .RS 4
9640 Normally queries for 0x1C names will return the addresses in the same order as they\*(Aqre stored in the database, that means first all addresses which have been directly registered at the local wins server and then all addresses registered at other servers\&. Windows servers have an option to change this behavior and randomize the returned addresses\&. Set this parameter to "yes" and Samba will sort the address list depending on the client address and the matching bits of the addresses, the first address is randomized based on depending on the "nbtd:wins_randomize1Clist_mask" parameter\&.
9641 .sp
9642 Default:
9643 \fI\fInbtd:wins_wins_randomize1Clist\fR\fR\fI = \fR\fIno\fR\fI \fR
9644 .RE
9645
9646 nbtd:wins_randomize1Clist_mask (G)
9647 .PP
9648 .RS 4
9649 If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then randomizing of the first returned address is based on the specified netmask\&. If there are addresses which are in the same subnet as the client address, the first returned address is randomly chosen out them\&. Otherwise the first returned address is randomly chosen out of all addresses\&.
9650 .sp
9651 Default:
9652 \fI\fInbtd:wins_randomize1Clist_mask\fR\fR\fI = \fR\fI255\&.255\&.255\&.0\fR\fI \fR
9653 .RE
9654
9655 nbt port (G)
9656 .PP
9657 .RS 4
9658 Specifies which port the server should use for NetBIOS over IP name services traffic\&.
9659 .sp
9660 Default:
9661 \fI\fInbt port\fR\fR\fI = \fR\fI137\fR\fI \fR
9662 .RE
9663
9664 ncalrpc dir (G)
9665 .PP
9666 .RS 4
9667 This directory will hold a series of named pipes to allow RPC over inter\-process communication\&.
9668 .sp
9669 This will allow Samba and other unix processes to interact over DCE/RPC without using TCP/IP\&. Additionally a sub\-directory \*(Aqnp\*(Aq has restricted permissions, and allows a trusted communication channel between Samba processes
9670 .sp
9671 Default:
9672 \fI\fIncalrpc dir\fR\fR\fI = \fR\fI/run/samba/ncalrpc\fR\fI \fR
9673 .sp
9674 Example:
9675 \fI\fIncalrpc dir\fR\fR\fI = \fR\fI/var/run/samba/ncalrpc\fR\fI \fR
9676 .RE
9677
9678 netbios aliases (G)
9679 .PP
9680 .RS 4
9681 This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known\&. This allows one machine to appear in browse lists under multiple names\&. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities\&.
9682 .sp
9683 Default:
9684 \fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR
9685 .sp
9686 Example:
9687 \fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR
9688 .RE
9689
9690 netbios name (G)
9691 .PP
9692 .RS 4
9693 This sets the NetBIOS name by which a Samba server is known\&. By default it is the same as the first component of the host\*(Aqs DNS name\&. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under\&.
9694 .sp
9695 Note that the maximum length for a NetBIOS name is 15 characters\&.
9696 .sp
9697 There is a bug in Samba that breaks operation of browsing and access to shares if the netbios name is set to the literal name
9698 PIPE\&. To avoid this problem, do not name your Samba server
9699 PIPE\&.
9700 .sp
9701 Default:
9702 \fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR
9703 .sp
9704 Example:
9705 \fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR
9706 .RE
9707
9708 netbios scope (G)
9709 .PP
9710 .RS 4
9711 This sets the NetBIOS scope that Samba will operate under\&. This should not be set unless every machine on your LAN also sets this value\&.
9712 .sp
9713 Default:
9714 \fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR
9715 .RE
9716
9717 neutralize nt4 emulation (G)
9718 .PP
9719 .RS 4
9720 This option controls whether winbindd sends the NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the NT4 emulation of a domain controller\&.
9721 .sp
9722 Typically you should not need set this\&. It can be useful for upgrades from NT4 to AD domains\&.
9723 .sp
9724 The behavior can be controlled per netbios domain by using \*(Aqneutralize nt4 emulation:NETBIOSDOMAIN = yes\*(Aq as option\&.
9725 .sp
9726 Default:
9727 \fI\fIneutralize nt4 emulation\fR\fR\fI = \fR\fIno\fR\fI \fR
9728 .RE
9729
9730 nmbd bind explicit broadcast (G)
9731 .PP
9732 .RS 4
9733 This option causes
9734 \fBnmbd\fR(8)
9735 to explicitly bind to the broadcast address of the local subnets\&. This is needed to make nmbd work correctly in combination with the
9736 \m[blue]\fBsocket address\fR\m[]
9737 option\&. You should not need to unset this option\&.
9738 .sp
9739 Default:
9740 \fI\fInmbd bind explicit broadcast\fR\fR\fI = \fR\fIyes\fR\fI \fR
9741 .RE
9742
9743 nsupdate command (G)
9744 .PP
9745 .RS 4
9746 This option sets the path to the
9747 nsupdate
9748 command which is used for GSS\-TSIG dynamic DNS updates\&.
9749 .sp
9750 Default:
9751 \fI\fInsupdate command\fR\fR\fI = \fR\fI/usr/bin/nsupdate \-g\fR\fI \fR
9752 .RE
9753
9754 nt hash store (G)
9755 .PP
9756 .RS 4
9757 This parameter determines whether or not
9758 \fBsamba\fR(8)
9759 will, as an AD DC, attempt to store the NT password hash used in NTLM and NTLMv2 authentication for users in this domain\&.
9760 .sp
9761 If so configured, the Samba Active Directory Domain Controller, will, except for trust accounts (computers, domain controllers and inter\-domain trusts),
9762 \fINOT store the NT hash\fR
9763 for new and changed accounts in the sam\&.ldb database\&.
9764 .sp
9765 This avoids the storage of an unsalted hash for these user\-created passwords\&. As a consequence the
9766 \fBarcfour\-hmac\-md5\fR
9767 Kerberos key type is also unavailable in the KDC for these users \- thankfully
9768 \fImodern clients will select an AES based key instead\&.\fR
9769 .sp
9770 NOTE: As the password history in Active Directory is stored as an NT hash (and thus unavailable), a workaround is used, relying instead on Kerberos password hash values\&. This stores three passwords, the current, previous and second previous password\&. This allows some checking against reuse\&.
9771 .sp
9772 However as these values are salted, changing the sAMAccountName, userAccountControl or userPrincipalName of an account will cause the salt to change\&. After the rare combination of both a rename and a password change only the current password will be recognised for password history purposes\&.
9773 .sp
9774 The available settings are:
9775 .RS
9776 .sp
9777 .RS 4
9778 .ie n \{\
9779 \h'-04'\(bu\h'+03'\c
9780 .\}
9781 .el \{\
9782 .sp -1
9783 .IP \(bu 2.3
9784 .\}
9785 \fBalways\fR
9786 \- Always store the NT hash (as machine accounts will also always store an NT hash, a hash will be stored for all accounts)\&.
9787 .sp
9788 This setting may be useful if
9789 \fIntlm auth\fR
9790 is set to
9791 \fBdisabled\fR
9792 for a trial period
9793 .RE
9794 .sp
9795 .RS 4
9796 .ie n \{\
9797 \h'-04'\(bu\h'+03'\c
9798 .\}
9799 .el \{\
9800 .sp -1
9801 .IP \(bu 2.3
9802 .\}
9803 \fBnever\fR
9804 \- Never store the NT hash for user accounts, only for machine accounts
9805 .RE
9806 .sp
9807 .RS 4
9808 .ie n \{\
9809 \h'-04'\(bu\h'+03'\c
9810 .\}
9811 .el \{\
9812 .sp -1
9813 .IP \(bu 2.3
9814 .\}
9815 \fBauto\fR
9816 \- Store an NT hash if
9817 \fIntlm auth\fR
9818 is not set to
9819 \fBdisabled\fR\&.
9820 .RE
9821 .sp
9822 .RE
9823 Default:
9824 \fI\fInt hash store\fR\fR\fI = \fR\fIalways\fR\fI \fR
9825 .RE
9826
9827 nt acl support (S)
9828 .PP
9829 .RS 4
9830 This boolean parameter controls whether
9831 \fBsmbd\fR(8)
9832 will attempt to map UNIX permissions into Windows NT access control lists\&. The UNIX permissions considered are the traditional UNIX owner and group permissions, as well as filesystem ACLs set on any files or directories\&. This parameter was formally a global parameter in releases prior to 2\&.2\&.2\&.
9833 .sp
9834 Default:
9835 \fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9836 .RE
9837
9838 ntlm auth (G)
9839 .PP
9840 .RS 4
9841 This parameter determines whether or not
9842 \fBsmbd\fR(8)
9843 will attempt to authenticate users using the NTLM encrypted password response for this local passdb (SAM or account database)\&.
9844 .sp
9845 If disabled, both NTLM and LanMan authentication against the local passdb is disabled\&.
9846 .sp
9847 Note that these settings apply only to local users, authentication will still be forwarded to and NTLM authentication accepted against any domain we are joined to, and any trusted domain, even if disabled or if NTLMv2\-only is enforced here\&. To control NTLM authentication for domain users, this option must be configured on each DC\&.
9848 .sp
9849 By default with
9850 ntlm auth
9851 set to
9852 \fBntlmv2\-only\fR
9853 only NTLMv2 logins will be permitted\&. All modern clients support NTLMv2 by default, but some older clients will require special configuration to use it\&.
9854 .sp
9855 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802\&.1x\&.
9856 .sp
9857 The available settings are:
9858 .RS
9859 .sp
9860 .RS 4
9861 .ie n \{\
9862 \h'-04'\(bu\h'+03'\c
9863 .\}
9864 .el \{\
9865 .sp -1
9866 .IP \(bu 2.3
9867 .\}
9868 \fBntlmv1\-permitted\fR
9869 (alias
9870 \fByes\fR) \- Allow NTLMv1 and above for all clients\&.
9871 .sp
9872 This is the required setting to enable the
9873 \fIlanman auth\fR
9874 parameter\&.
9875 .RE
9876 .sp
9877 .RS 4
9878 .ie n \{\
9879 \h'-04'\(bu\h'+03'\c
9880 .\}
9881 .el \{\
9882 .sp -1
9883 .IP \(bu 2.3
9884 .\}
9885 \fBntlmv2\-only\fR
9886 (alias
9887 \fBno\fR) \- Do not allow NTLMv1 to be used, but permit NTLMv2\&.
9888 .RE
9889 .sp
9890 .RS 4
9891 .ie n \{\
9892 \h'-04'\(bu\h'+03'\c
9893 .\}
9894 .el \{\
9895 .sp -1
9896 .IP \(bu 2.3
9897 .\}
9898 \fBmschapv2\-and\-ntlmv2\-only\fR
9899 \- Only allow NTLMv1 when the client promises that it is providing MSCHAPv2 authentication (such as the
9900 ntlm_auth
9901 tool)\&.
9902 .RE
9903 .sp
9904 .RS 4
9905 .ie n \{\
9906 \h'-04'\(bu\h'+03'\c
9907 .\}
9908 .el \{\
9909 .sp -1
9910 .IP \(bu 2.3
9911 .\}
9912 \fBdisabled\fR
9913 \- Do not accept NTLM (or LanMan) authentication of any level, nor permit NTLM password changes\&.
9914 .sp
9915 \fIWARNING:\fR
9916 Both Microsoft Windows and Samba
9917 \fIRead Only Domain Controllers\fR
9918 (RODCs) convert a plain\-text LDAP Simple Bind into an NTLMv2 authentication to forward to a full DC\&. Setting this option to
9919 \fBdisabled\fR
9920 will cause these forwarded authentications to fail\&.
9921 .sp
9922 Additionally, for Samba acting as an Active Directory Domain Controller, for user accounts, if
9923 \fInt hash store\fR
9924 is set to the default setting of
9925 \fBauto\fR, the
9926 \fINT hash will not be stored\fR
9927 in the sam\&.ldb database for new users and after a password change\&.
9928 .RE
9929 .sp
9930 .RE
9931 The default changed from
9932 \fByes\fR
9933 to
9934 \fBno\fR
9935 with Samba 4\&.5\&. The default changed again to
9936 \fBntlmv2\-only\fR
9937 with Samba 4\&.7, however the behaviour is unchanged\&.
9938 .sp
9939 Default:
9940 \fI\fIntlm auth\fR\fR\fI = \fR\fIntlmv2\-only\fR\fI \fR
9941 .RE
9942
9943 nt pipe support (G)
9944 .PP
9945 .RS 4
9946 This boolean parameter controls whether
9947 \fBsmbd\fR(8)
9948 will allow Windows NT clients to connect to the NT SMB specific
9949 \fBIPC$\fR
9950 pipes\&. This is a developer debugging option and can be left alone\&.
9951 .sp
9952 Default:
9953 \fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9954 .RE
9955
9956 ntp signd socket directory (G)
9957 .PP
9958 .RS 4
9959 This setting controls the location of the socket that the NTP daemon uses to communicate with Samba for signing packets\&.
9960 .sp
9961 If a non\-default path is specified here, then it is also necessary to make NTP aware of the new path using the
9962 \fBntpsigndsocket\fR
9963 directive in
9964 ntp\&.conf\&.
9965 .sp
9966 Default:
9967 \fI\fIntp signd socket directory\fR\fR\fI = \fR\fI/var/lib/samba/ntp_signd\fR\fI \fR
9968 .RE
9969
9970 nt status support (G)
9971 .PP
9972 .RS 4
9973 This boolean parameter controls whether
9974 \fBsmbd\fR(8)
9975 will negotiate NT specific status support with Windows NT/2k/XP clients\&. This is a developer debugging option and should be left alone\&. If this option is set to
9976 \fBno\fR
9977 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
9978 .sp
9979 You should not need to ever disable this parameter\&.
9980 .sp
9981 Default:
9982 \fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9983 .RE
9984
9985 ntvfs handler (S)
9986 .PP
9987 .RS 4
9988 This specifies the NTVFS handlers for this share\&.
9989 .RS
9990 .sp
9991 .RS 4
9992 .ie n \{\
9993 \h'-04'\(bu\h'+03'\c
9994 .\}
9995 .el \{\
9996 .sp -1
9997 .IP \(bu 2.3
9998 .\}
9999 unixuid: Sets up user credentials based on POSIX gid/uid\&.
10000 .RE
10001 .sp
10002 .RS 4
10003 .ie n \{\
10004 \h'-04'\(bu\h'+03'\c
10005 .\}
10006 .el \{\
10007 .sp -1
10008 .IP \(bu 2.3
10009 .\}
10010 cifs: Proxies a remote CIFS FS\&. Mainly useful for testing\&.
10011 .RE
10012 .sp
10013 .RS 4
10014 .ie n \{\
10015 \h'-04'\(bu\h'+03'\c
10016 .\}
10017 .el \{\
10018 .sp -1
10019 .IP \(bu 2.3
10020 .\}
10021 nbench: Filter module that saves data useful to the nbench benchmark suite\&.
10022 .RE
10023 .sp
10024 .RS 4
10025 .ie n \{\
10026 \h'-04'\(bu\h'+03'\c
10027 .\}
10028 .el \{\
10029 .sp -1
10030 .IP \(bu 2.3
10031 .\}
10032 ipc: Allows using SMB for inter process communication\&. Only used for the IPC$ share\&.
10033 .RE
10034 .sp
10035 .RS 4
10036 .ie n \{\
10037 \h'-04'\(bu\h'+03'\c
10038 .\}
10039 .el \{\
10040 .sp -1
10041 .IP \(bu 2.3
10042 .\}
10043 posix: Maps POSIX FS semantics to NT semantics
10044 .RE
10045 .sp
10046 .RS 4
10047 .ie n \{\
10048 \h'-04'\(bu\h'+03'\c
10049 .\}
10050 .el \{\
10051 .sp -1
10052 .IP \(bu 2.3
10053 .\}
10054 print: Allows printing over SMB\&. This is LANMAN\-style printing, not the be confused with the spoolss DCE/RPC interface used by later versions of Windows\&.
10055 .RE
10056 .sp
10057 .RE
10058 Note that this option is only used when the NTVFS file server is in use\&. It is not used with the (default) s3fs file server\&.
10059 .sp
10060 Default:
10061 \fI\fIntvfs handler\fR\fR\fI = \fR\fIunixuid, default\fR\fI \fR
10062 .RE
10063
10064 null passwords (G)
10065 .PP
10066 .RS 4
10067 Allow or disallow client access to accounts that have null passwords\&.
10068 .sp
10069 See also
10070 \fBsmbpasswd\fR(5)\&.
10071 .sp
10072 Default:
10073 \fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR
10074 .RE
10075
10076 obey pam restrictions (G)
10077 .PP
10078 .RS 4
10079 When Samba 3\&.0 is configured to enable PAM support (i\&.e\&. \-\-with\-pam), this parameter will control whether or not Samba should obey PAM\*(Aqs account and session management directives\&. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management\&. Note that Samba always ignores PAM for authentication in the case of
10080 \m[blue]\fBencrypt passwords = yes\fR\m[]\&. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption\&.
10081 .sp
10082 Default:
10083 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR
10084 .RE
10085
10086 old password allowed period (G)
10087 .PP
10088 .RS 4
10089 Number of minutes to permit an NTLM login after a password change or reset using the old password\&. This allows the user to re\-cache the new password on multiple clients without disrupting a network reconnection in the meantime\&.
10090 .sp
10091 This parameter only applies when
10092 \m[blue]\fBserver role\fR\m[]
10093 is set to Active Directory Domain Controller\&.
10094 .sp
10095 Default:
10096 \fI\fIold password allowed period\fR\fR\fI = \fR\fI60\fR\fI \fR
10097 .RE
10098
10099 oplock break wait time (G)
10100 .PP
10101 .RS 4
10102 This is a tuning parameter added due to bugs in both Windows 9x and WinNT\&. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request\&. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients\&.
10103 .if n \{\
10104 .sp
10105 .\}
10106 .RS 4
10107 .it 1 an-trap
10108 .nr an-no-space-flag 1
10109 .nr an-break-flag 1
10110 .br
10111 .ps +1
10112 \fBWarning\fR
10113 .ps -1
10114 .br
10115 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
10116 .sp .5v
10117 .RE
10118 Default:
10119 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR
10120 .RE
10121
10122 oplocks (S)
10123 .PP
10124 .RS 4
10125 This boolean option tells
10126 smbd
10127 whether to issue oplocks (opportunistic locks) to file open requests on this share\&. The oplock code can dramatically (approx\&. 30% or more) improve the speed of access to files on Samba servers\&. It allows the clients to aggressively cache files locally and you may want to disable this option for unreliable network environments (it is turned on by default in Windows NT Servers)\&.
10128 .sp
10129 Oplocks may be selectively turned off on certain files with a share\&. See the
10130 \m[blue]\fBveto oplock files\fR\m[]
10131 parameter\&. On some systems oplocks are recognized by the underlying operating system\&. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process\&. See the
10132 \m[blue]\fBkernel oplocks\fR\m[]
10133 parameter for details\&.
10134 .sp
10135 Default:
10136 \fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
10137 .RE
10138
10139 os2 driver map (G)
10140 .PP
10141 .RS 4
10142 The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names\&. The format is:
10143 .sp
10144 <nt driver name> = <os2 driver name>\&.<device name>
10145 .sp
10146 For example, a valid entry using the HP LaserJet 5 printer driver would appear as
10147 HP LaserJet 5L = LASERJET\&.HP LaserJet 5L\&.
10148 .sp
10149 The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3\-HOWTO book\&. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3\-HOWTO book\&.
10150 .sp
10151 Default:
10152 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR
10153 .RE
10154
10155 os level (G)
10156 .PP
10157 .RS 4
10158 This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
10159 \fBnmbd\fR(8)
10160 has a chance of becoming a local master browser for the
10161 \m[blue]\fBworkgroup\fR\m[]
10162 in the local broadcast area\&.
10163 .sp
10164 \fI Note:\fR
10165 By default, Samba will win a local master browsing election over all Microsoft operating systems except a Windows NT 4\&.0/2000 Domain Controller\&. This means that a misconfigured Samba host can effectively isolate a subnet for browsing purposes\&. This parameter is largely auto\-configured in the Samba\-3 release series and it is seldom necessary to manually override the default setting\&. Please refer to the chapter on Network Browsing in the Samba\-3 HOWTO document for further information regarding the use of this parameter\&.
10166 \fINote:\fR
10167 The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
10168 .sp
10169 Default:
10170 \fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR
10171 .sp
10172 Example:
10173 \fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR
10174 .RE
10175
10176 pam password change (G)
10177 .PP
10178 .RS 4
10179 With the addition of better PAM support in Samba 2\&.2, this parameter, it is possible to use PAM\*(Aqs password change control flag for Samba\&. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in
10180 \m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
10181 \m[blue]\fBpasswd chat\fR\m[]
10182 parameter for most setups\&.
10183 .sp
10184 Default:
10185 \fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR
10186 .RE
10187
10188 panic action (G)
10189 .PP
10190 .RS 4
10191 This is a Samba developer option that allows a system command to be called when either
10192 \fBsmbd\fR(8)
10193 or
10194 \fBnmbd\fR(8)
10195 crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
10196 .sp
10197 Default:
10198 \fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR
10199 .sp
10200 Example:
10201 \fI\fIpanic action\fR\fR\fI = \fR\fI/bin/sleep 90000\fR\fI \fR
10202 .RE
10203
10204 passdb backend (G)
10205 .PP
10206 .RS 4
10207 This option allows the administrator to chose which backend will be used for storing user and possibly group information\&. This allows you to swap between different storage mechanisms without recompile\&.
10208 .sp
10209 The parameter value is divided into two parts, the backend\*(Aqs name, and a \*(Aqlocation\*(Aq string that has meaning only to that particular backed\&. These are separated by a : character\&.
10210 .sp
10211 Available backends can include:
10212 .RS
10213 .sp
10214 .RS 4
10215 .ie n \{\
10216 \h'-04'\(bu\h'+03'\c
10217 .\}
10218 .el \{\
10219 .sp -1
10220 .IP \(bu 2.3
10221 .\}
10222 smbpasswd
10223 \- The old plaintext passdb backend\&. Some Samba features will not work if this passdb backend is used\&. Takes a path to the smbpasswd file as an optional argument\&.
10224 .RE
10225 .sp
10226 .RS 4
10227 .ie n \{\
10228 \h'-04'\(bu\h'+03'\c
10229 .\}
10230 .el \{\
10231 .sp -1
10232 .IP \(bu 2.3
10233 .\}
10234 tdbsam
10235 \- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
10236 \m[blue]\fBprivate dir\fR\m[]
10237 directory\&.
10238 .RE
10239 .sp
10240 .RS 4
10241 .ie n \{\
10242 \h'-04'\(bu\h'+03'\c
10243 .\}
10244 .el \{\
10245 .sp -1
10246 .IP \(bu 2.3
10247 .\}
10248 ldapsam
10249 \- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
10250 ldap://localhost)
10251 .sp
10252 LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
10253 \m[blue]\fBldap ssl\fR\m[]) or by specifying
10254 \fIldaps://\fR
10255 in the URL argument\&.
10256 .sp
10257 Multiple servers may also be specified in double\-quotes\&. Whether multiple servers are supported or not and the exact syntax depends on the LDAP library you use\&.
10258 .RE
10259 .sp
10260 .RE
10261
10262 Examples of use are:
10263 .sp
10264 .if n \{\
10265 .RS 4
10266 .\}
10267 .nf
10268 passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb
10269
10270 or multi server LDAP URL with OpenLDAP library:
10271
10272 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
10273
10274 or multi server LDAP URL with Netscape based LDAP library:
10275
10276 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
10277 .fi
10278 .if n \{\
10279 .RE
10280 .\}
10281 .sp
10282 Default:
10283 \fI\fIpassdb backend\fR\fR\fI = \fR\fItdbsam\fR\fI \fR
10284 .RE
10285
10286 passdb expand explicit (G)
10287 .PP
10288 .RS 4
10289 This parameter controls whether Samba substitutes %\-macros in the passdb fields if they are explicitly set\&. We used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable %G_osver% in which %G would have been substituted by the user\*(Aqs primary group\&.
10290 .sp
10291 Default:
10292 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR
10293 .RE
10294
10295 passwd chat (G)
10296 .PP
10297 .RS 4
10298 This string controls the
10299 \fI"chat"\fR
10300 conversation that takes places between
10301 \fBsmbd\fR(8)
10302 and the local password changing program to change the user\*(Aqs password\&. The string describes a sequence of response\-receive pairs that
10303 \fBsmbd\fR(8)
10304 uses to determine what to send to the
10305 \m[blue]\fBpasswd program\fR\m[]
10306 and what to expect back\&. If the expected output is not received then the password is not changed\&.
10307 .sp
10308 This chat sequence is often quite site specific, depending on what local methods are used for password control\&.
10309 .sp
10310 Note that this parameter only is used if the
10311 \m[blue]\fBunix password sync\fR\m[]
10312 parameter is set to
10313 \fByes\fR\&. This sequence is then called
10314 \fIAS ROOT\fR
10315 when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext\&. This means that root must be able to reset the user\*(Aqs password without knowing the text of the previous password\&.
10316 .sp
10317 The string can contain the macro
10318 \fI%n\fR
10319 which is substituted for the new password\&. The old password (\fI%o\fR) is only available when
10320 \m[blue]\fBencrypt passwords\fR\m[]
10321 has been disabled\&. The chat sequence can also contain the standard macros \en, \er, \et and \es to give line\-feed, carriage\-return, tab and space\&. The chat sequence string can also contain a \*(Aq*\*(Aq which matches any sequence of characters\&. Double quotes can be used to collect strings with spaces in them into a single string\&.
10322 .sp
10323 If the send string in any part of the chat sequence is a full stop "\&.", then no string is sent\&. Similarly, if the expect string is a full stop then no string is expected\&.
10324 .sp
10325 If the
10326 \m[blue]\fBpam password change\fR\m[]
10327 parameter is set to
10328 \fByes\fR, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output\&. The \en macro is ignored for PAM conversions\&.
10329 .sp
10330 Default:
10331 \fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en *new*password* %n\en *changed*\fR\fI \fR
10332 .sp
10333 Example:
10334 \fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR
10335 .RE
10336
10337 passwd chat debug (G)
10338 .PP
10339 .RS 4
10340 This boolean specifies if the passwd chat script parameter is run in
10341 \fIdebug\fR
10342 mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
10343 \fBsmbd\fR(8)
10344 log with a
10345 \m[blue]\fBdebug level\fR\m[]
10346 of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
10347 smbd
10348 log\&. It is available to help Samba admins debug their
10349 \fIpasswd chat\fR
10350 scripts when calling the
10351 \fIpasswd program\fR
10352 and should be turned off after this has been done\&. This option has no effect if the
10353 \m[blue]\fBpam password change\fR\m[]
10354 parameter is set\&. This parameter is off by default\&.
10355 .sp
10356 Default:
10357 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR
10358 .RE
10359
10360 passwd chat timeout (G)
10361 .PP
10362 .RS 4
10363 This integer specifies the number of seconds smbd will wait for an initial answer from a passwd chat script being run\&. Once the initial answer is received the subsequent answers must be received in one tenth of this time\&. The default it two seconds\&.
10364 .sp
10365 Default:
10366 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
10367 .RE
10368
10369 passwd program (G)
10370 .PP
10371 .RS 4
10372 The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
10373 \fI%u\fR
10374 will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
10375 .sp
10376 Also note that many passwd programs insist in
10377 \fIreasonable \fR
10378 passwords, such as a minimum length, or the inclusion of mixed case chars and digits\&. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it\&.
10379 .sp
10380 \fINote\fR
10381 that if the
10382 \fIunix password sync\fR
10383 parameter is set to
10384 \fByes \fR
10385 then this program is called
10386 \fIAS ROOT\fR
10387 before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
10388 smbd
10389 will fail to change the SMB password also (this is by design)\&.
10390 .sp
10391 If the
10392 \fIunix password sync\fR
10393 parameter is set this parameter
10394 \fIMUST USE ABSOLUTE PATHS\fR
10395 for
10396 \fIALL\fR
10397 programs called, and must be examined for security implications\&. Note that by default
10398 \fIunix password sync\fR
10399 is set to
10400 \fBno\fR\&.
10401 .sp
10402 Default:
10403 \fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR
10404 .sp
10405 Example:
10406 \fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR
10407 .RE
10408
10409 password hash gpg key ids (G)
10410 .PP
10411 .RS 4
10412 If
10413 samba
10414 is running as an active directory domain controller, it is possible to store the cleartext password of accounts in a PGP/OpenGPG encrypted form\&.
10415 .sp
10416 You can specify one or more recipients by key id or user id\&. Note that 32bit key ids are not allowed, specify at least 64bit\&.
10417 .sp
10418 The value is stored as \*(AqPrimary:SambaGPG\*(Aq in the
10419 supplementalCredentials
10420 attribute\&.
10421 .sp
10422 As password changes can occur on any domain controller, you should configure this on each of them\&. Note that this feature is currently available only on Samba domain controllers\&.
10423 .sp
10424 This option is only available if
10425 samba
10426 was compiled with
10427 gpgme
10428 support\&.
10429 .sp
10430 You may need to export the
10431 GNUPGHOME
10432 environment variable before starting
10433 samba\&.
10434 \fIIt is strongly recommended to only store the public key in this location\&. The private key is not used for encryption and should be only stored where decryption is required\&.\fR
10435 .sp
10436 Being able to restore the cleartext password helps, when they need to be imported into other authentication systems later (see
10437 samba\-tool user getpassword) or you want to keep the passwords in sync with another system, e\&.g\&. an OpenLDAP server (see
10438 samba\-tool user syncpasswords)\&.
10439 .sp
10440 While this option needs to be configured on all domain controllers, the
10441 samba\-tool user syncpasswords
10442 command should run on a single domain controller only (typically the PDC\-emulator)\&.
10443 .sp
10444 Default:
10445 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fI\fR\fI \fR
10446 .sp
10447 Example:
10448 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fI4952E40301FAB41A\fR\fI \fR
10449 .sp
10450 Example:
10451 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fIselftest@samba\&.example\&.com\fR\fI \fR
10452 .sp
10453 Example:
10454 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fIselftest@samba\&.example\&.com, 4952E40301FAB41A\fR\fI \fR
10455 .RE
10456
10457 password hash userPassword schemes (G)
10458 .PP
10459 .RS 4
10460 This parameter determines whether or not
10461 \fBsamba\fR(8)
10462 acting as an Active Directory Domain Controller will attempt to store additional passwords hash types for the user
10463 .sp
10464 The values are stored as \*(AqPrimary:userPassword\*(Aq in the
10465 supplementalCredentials
10466 attribute\&. The value of this option is a hash type\&.
10467 .sp
10468 The currently supported hash types are:
10469 .RS
10470 .sp
10471 .RS 4
10472 .ie n \{\
10473 \h'-04'\(bu\h'+03'\c
10474 .\}
10475 .el \{\
10476 .sp -1
10477 .IP \(bu 2.3
10478 .\}
10479 \fBCryptSHA256\fR
10480 .RE
10481 .sp
10482 .RS 4
10483 .ie n \{\
10484 \h'-04'\(bu\h'+03'\c
10485 .\}
10486 .el \{\
10487 .sp -1
10488 .IP \(bu 2.3
10489 .\}
10490 \fBCryptSHA512\fR
10491 .RE
10492 .sp
10493 .RE
10494 Multiple instances of a hash type may be computed and stored\&. The password hashes are calculated using the
10495 \fBcrypt\fR(3)
10496 call\&. The number of rounds used to compute the hash can be specified by adding \*(Aq:rounds=xxxx\*(Aq to the hash type, i\&.e\&. CryptSHA512:rounds=4500 would calculate an SHA512 hash using 4500 rounds\&. If not specified the Operating System defaults for
10497 \fBcrypt\fR(3)
10498 are used\&.
10499 .sp
10500 As password changes can occur on any domain controller, you should configure this on each of them\&. Note that this feature is currently available only on Samba domain controllers\&.
10501 .sp
10502 Currently the NT Hash of the password is recorded when these hashes are calculated and stored\&. When retrieving the hashes the current value of the NT Hash is checked against the stored NT Hash\&. This detects password changes that have not updated the password hashes\&. In this case
10503 samba\-tool user
10504 will ignore the stored hash values\&.
10505 .sp
10506 Being able to obtain the hashed password helps, when they need to be imported into other authentication systems later (see
10507 samba\-tool user getpassword) or you want to keep the passwords in sync with another system, e\&.g\&. an OpenLDAP server (see
10508 samba\-tool user syncpasswords)\&.
10509 .sp
10510 Related command:
10511 \m[blue]\fBunix password sync\fR\m[]
10512 .sp
10513 Default:
10514 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fI\fR\fI \fR
10515 .sp
10516 Example:
10517 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256\fR\fI \fR
10518 .sp
10519 Example:
10520 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256 CryptSHA512\fR\fI \fR
10521 .sp
10522 Example:
10523 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256:rounds=5000 CryptSHA512:rounds=7000\fR\fI \fR
10524 .RE
10525
10526 password server (G)
10527 .PP
10528 .RS 4
10529 By specifying the name of a domain controller with this option, and using
10530 security = [ads|domain]
10531 it is possible to get Samba to do all its username/password validation using a specific remote server\&.
10532 .sp
10533 Ideally, this option
10534 \fIshould not\fR
10535 be used, as the default \*(Aq*\*(Aq indicates to Samba to determine the best DC to contact dynamically, just as all other hosts in an AD domain do\&. This allows the domain to be maintained (addition and removal of domain controllers) without modification to the smb\&.conf file\&. The cryptographic protection on the authenticated RPC calls used to verify passwords ensures that this default is safe\&.
10536 .sp
10537 \fIIt is strongly recommended that you use the default of \*(Aq*\*(Aq\fR, however if in your particular environment you have reason to specify a particular DC list, then the list of machines in this option must be a list of names or IP addresses of Domain controllers for the Domain\&. If you use the default of \*(Aq*\*(Aq, or list several hosts in the
10538 \fIpassword server\fR
10539 option then
10540 smbd
10541 will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
10542 .sp
10543 If the list of servers contains both names/IP\*(Aqs and the \*(Aq*\*(Aq character, the list is treated as a list of preferred domain controllers, but an auto lookup of all remaining DC\*(Aqs will be added to the list as well\&. Samba will not attempt to optimize this list by locating the closest DC\&.
10544 .sp
10545 If parameter is a name, it is looked up using the parameter
10546 \m[blue]\fBname resolve order\fR\m[]
10547 and so may resolved by any method and order described in that parameter\&.
10548 .sp
10549 Default:
10550 \fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR
10551 .sp
10552 Example:
10553 \fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR
10554 .sp
10555 Example:
10556 \fI\fIpassword server\fR\fR\fI = \fR\fIwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\fR\fI \fR
10557 .RE
10558
10559 directory
10560 .PP
10561 .RS 4
10562 This parameter is a synonym for
10563 path\&.
10564 .RE
10565
10566 path (S)
10567 .PP
10568 .RS 4
10569 This parameter specifies a directory to which the user of the service is to be given access\&. In the case of printable services, this is where print data will spool prior to being submitted to the host for printing\&.
10570 .sp
10571 For a printable service offering guest access, the service should be readonly and the path should be world\-writeable and have the sticky bit set\&. This is not mandatory of course, but you probably won\*(Aqt get the results you expect if you do otherwise\&.
10572 .sp
10573 Any occurrences of
10574 \fI%u\fR
10575 in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
10576 \fI%m\fR
10577 will be replaced by the NetBIOS name of the machine they are connecting from\&. These replacements are very useful for setting up pseudo home directories for users\&.
10578 .sp
10579 Note that this path will be based on
10580 \m[blue]\fBroot dir\fR\m[]
10581 if one was specified\&.
10582 .sp
10583 Default:
10584 \fI\fIpath\fR\fR\fI = \fR\fI\fR\fI \fR
10585 .sp
10586 Example:
10587 \fI\fIpath\fR\fR\fI = \fR\fI/home/fred\fR\fI \fR
10588 .RE
10589
10590 perfcount module (G)
10591 .PP
10592 .RS 4
10593 This parameter specifies the perfcount backend to be used when monitoring SMB operations\&. Only one perfcount module may be used, and it must implement all of the apis contained in the smb_perfcount_handler structure defined in smb\&.h\&.
10594 .sp
10595 \fINo default\fR
10596 .RE
10597
10598 pid directory (G)
10599 .PP
10600 .RS 4
10601 This option specifies the directory where pid files will be placed\&.
10602 .sp
10603 Default:
10604 \fI\fIpid directory\fR\fR\fI = \fR\fI/run\fR\fI \fR
10605 .sp
10606 Example:
10607 \fI\fIpid directory\fR\fR\fI = \fR\fI/var/run/\fR\fI \fR
10608 .RE
10609
10610 posix locking (S)
10611 .PP
10612 .RS 4
10613 The
10614 \fBsmbd\fR(8)
10615 daemon maintains an database of file locks obtained by SMB clients\&. The default behavior is to map this internal database to POSIX locks\&. This means that file locks obtained by SMB clients are consistent with those seen by POSIX compliant applications accessing the files via a non\-SMB method (e\&.g\&. NFS or local file access)\&. It is very unlikely that you need to set this parameter to "no", unless you are sharing from an NFS mount, which is not a good idea in the first place\&.
10616 .sp
10617 Default:
10618 \fI\fIposix locking\fR\fR\fI = \fR\fIyes\fR\fI \fR
10619 .RE
10620
10621 postexec (S)
10622 .PP
10623 .RS 4
10624 This option specifies a command to be run whenever the service is disconnected\&. It takes the usual substitutions\&. The command may be run as the root on some systems\&.
10625 .sp
10626 An interesting example may be to unmount server resources:
10627 .sp
10628 postexec = /etc/umount /cdrom
10629 .sp
10630 Default:
10631 \fI\fIpostexec\fR\fR\fI = \fR\fI\fR\fI \fR
10632 .sp
10633 Example:
10634 \fI\fIpostexec\fR\fR\fI = \fR\fIecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
10635 .RE
10636
10637 exec
10638 .PP
10639 .RS 4
10640 This parameter is a synonym for
10641 preexec\&.
10642 .RE
10643
10644 preexec (S)
10645 .PP
10646 .RS 4
10647 This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
10648 .sp
10649 An interesting example is to send the users a welcome message every time they log in\&. Maybe a message of the day? Here is an example:
10650 .sp
10651 preexec = csh \-c \*(Aqecho \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\*(Aq &
10652 .sp
10653 Of course, this could get annoying after a while :\-)
10654 .sp
10655 See also
10656 \m[blue]\fBpreexec close\fR\m[]
10657 and
10658 \m[blue]\fBpostexec\fR\m[]\&.
10659 .sp
10660 Default:
10661 \fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR
10662 .sp
10663 Example:
10664 \fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
10665 .RE
10666
10667 preexec close (S)
10668 .PP
10669 .RS 4
10670 This boolean option controls whether a non\-zero return code from
10671 \m[blue]\fBpreexec\fR\m[]
10672 should close the service being connected to\&.
10673 .sp
10674 Default:
10675 \fI\fIpreexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
10676 .RE
10677
10678 prefered master
10679 .PP
10680 .RS 4
10681 This parameter is a synonym for
10682 preferred master\&.
10683 .RE
10684
10685 preferred master (G)
10686 .PP
10687 .RS 4
10688 This boolean parameter controls if
10689 \fBnmbd\fR(8)
10690 is a preferred master browser for its workgroup\&.
10691 .sp
10692 If this is set to
10693 \fByes\fR, on startup,
10694 nmbd
10695 will force an election, and it will have a slight advantage in winning the election\&. It is recommended that this parameter is used in conjunction with
10696 \m[blue]\fBdomain master = yes\fR\m[], so that
10697 nmbd
10698 can guarantee becoming a domain master\&.
10699 .sp
10700 Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser\&. This will result in unnecessary broadcast traffic and reduced browsing capabilities\&.
10701 .sp
10702 Default:
10703 \fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR
10704 .RE
10705
10706 prefork backoff increment (G)
10707 .PP
10708 .RS 4
10709 This option specifies the number of seconds added to the delay before a prefork master or worker process is restarted\&. The restart is initially zero, the prefork backoff increment is added to the delay on each restart up to the value specified by "prefork maximum backoff"\&.
10710 .sp
10711 Additionally set the backoff for an individual service by using "prefork backoff increment: service name" i\&.e\&. "prefork backoff increment:ldap = 2" to set the backoff increment to 2\&.
10712 .sp
10713 If the backoff increment is 2 and the maximum backoff is 5\&. There will be a zero second delay for the first restart\&. A two second delay for the second restart\&. A four second delay for the third and any subsequent restarts
10714 .sp
10715 Default:
10716 \fI\fIprefork backoff increment\fR\fR\fI = \fR\fI10\fR\fI \fR
10717 .RE
10718
10719 prefork children (G)
10720 .PP
10721 .RS 4
10722 This option controls the number of worker processes that are started for each service when prefork process model is enabled (see
10723 \fBsamba\fR(8)
10724 \-M) The prefork children are only started for those services that support prefork (currently ldap, kdc and netlogon)\&. For processes that don\*(Aqt support preforking all requests are handled by a single process for that service\&.
10725 .sp
10726 This should be set to a small multiple of the number of CPU\*(Aqs available on the server
10727 .sp
10728 Additionally the number of prefork children can be specified for an individual service by using "prefork children: service name" i\&.e\&. "prefork children:ldap = 8" to set the number of ldap worker processes\&.
10729 .sp
10730 Default:
10731 \fI\fIprefork children\fR\fR\fI = \fR\fI4\fR\fI \fR
10732 .RE
10733
10734 prefork maximum backoff (G)
10735 .PP
10736 .RS 4
10737 This option controls the maximum delay before a failed pre\-fork process is restarted\&.
10738 .sp
10739 Default:
10740 \fI\fIprefork maximum backoff\fR\fR\fI = \fR\fI120\fR\fI \fR
10741 .RE
10742
10743 preload modules (G)
10744 .PP
10745 .RS 4
10746 This is a list of paths to modules that should be loaded into smbd before a client connects\&. This improves the speed of smbd when reacting to new connections somewhat\&.
10747 .sp
10748 Default:
10749 \fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR
10750 .sp
10751 Example:
10752 \fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\&.so\fR\fI \fR
10753 .RE
10754
10755 preserve case (S)
10756 .PP
10757 .RS 4
10758 This controls if new filenames are created with the case that the client passes, or if they are forced to be the
10759 \m[blue]\fBdefault case\fR\m[]\&.
10760 .sp
10761 See the section on
10762 NAME MANGLING
10763 for a fuller discussion\&.
10764 .sp
10765 Default:
10766 \fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
10767 .RE
10768
10769 print ok
10770 .PP
10771 .RS 4
10772 This parameter is a synonym for
10773 printable\&.
10774 .RE
10775
10776 printable (S)
10777 .PP
10778 .RS 4
10779 If this parameter is
10780 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
10781 .sp
10782 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
10783 \m[blue]\fBread only\fR\m[]
10784 parameter controls only non\-printing access to the resource\&.
10785 .sp
10786 Default:
10787 \fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR
10788 .RE
10789
10790 printcap cache time (G)
10791 .PP
10792 .RS 4
10793 This option specifies the number of seconds before the printing subsystem is again asked for the known printers\&.
10794 .sp
10795 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
10796 .sp
10797 Default:
10798 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR
10799 .sp
10800 Example:
10801 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR
10802 .RE
10803
10804 printcap
10805 .PP
10806 .RS 4
10807 This parameter is a synonym for
10808 printcap name\&.
10809 .RE
10810
10811 printcap name (G)
10812 .PP
10813 .RS 4
10814 This parameter may be used to override the compiled\-in default printcap name used by the server (usually
10815 /etc/printcap)\&. See the discussion of the
10816 [printers]
10817 section above for reasons why you might want to do this\&.
10818 .sp
10819 To use the CUPS printing interface set
10820 printcap name = cups\&. This should be supplemented by an additional setting
10821 \m[blue]\fBprinting = cups\fR\m[]
10822 in the [global] section\&.
10823 printcap name = cups
10824 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
10825 .sp
10826 On System V systems that use
10827 lpstat
10828 to list available printers you can use
10829 printcap name = lpstat
10830 to automatically obtain lists of available printers\&. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems)\&. If
10831 \fI printcap name\fR
10832 is set to
10833 lpstat
10834 on these systems then Samba will launch
10835 lpstat \-v
10836 and attempt to parse the output to obtain a printer list\&.
10837 .sp
10838 A minimal printcap file would look something like this:
10839 .sp
10840 .if n \{\
10841 .RS 4
10842 .\}
10843 .nf
10844 print1|My Printer 1
10845 print2|My Printer 2
10846 print3|My Printer 3
10847 print4|My Printer 4
10848 print5|My Printer 5
10849 .fi
10850 .if n \{\
10851 .RE
10852 .\}
10853 .sp
10854 where the \*(Aq|\*(Aq separates aliases of a printer\&. The fact that the second alias has a space in it gives a hint to Samba that it\*(Aqs a comment\&.
10855 .if n \{\
10856 .sp
10857 .\}
10858 .RS 4
10859 .it 1 an-trap
10860 .nr an-no-space-flag 1
10861 .nr an-break-flag 1
10862 .br
10863 .ps +1
10864 \fBNote\fR
10865 .ps -1
10866 .br
10867 Under AIX the default printcap name is
10868 /etc/qconfig\&. Samba will assume the file is in AIX
10869 qconfig
10870 format if the string
10871 qconfig
10872 appears in the printcap filename\&.
10873 .sp .5v
10874 .RE
10875 Default:
10876 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR
10877 .sp
10878 Example:
10879 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR
10880 .RE
10881
10882 print command (S)
10883 .PP
10884 .RS 4
10885 After a print job has finished spooling to a service, this command will be used via a
10886 system()
10887 call to process the spool file\&. Typically the command specified will submit the spool file to the host\*(Aqs printing subsystem, but there is no requirement that this be the case\&. The server will not remove the spool file, so whatever command you specify should remove the spool file when it has been processed, otherwise you will need to manually remove old spool files\&.
10888 .sp
10889 The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
10890 .sp
10891 %s, %f \- the path to the spool file name
10892 .sp
10893 %p \- the appropriate printer name
10894 .sp
10895 %J \- the job name as transmitted by the client\&.
10896 .sp
10897 %c \- The number of printed pages of the spooled job (if known)\&.
10898 .sp
10899 %z \- the size of the spooled print job (in bytes)
10900 .sp
10901 The print command
10902 \fIMUST\fR
10903 contain at least one occurrence of
10904 \fI%s\fR
10905 or
10906 \fI%f \fR
10907 \- the
10908 \fI%p\fR
10909 is optional\&. At the time a job is submitted, if no printer name is supplied the
10910 \fI%p \fR
10911 will be silently removed from the printer command\&.
10912 .sp
10913 If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified\&.
10914 .sp
10915 If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed\&.
10916 .sp
10917 Note that printing may fail on some UNIXes from the
10918 \fBnobody\fR
10919 account\&. If this happens then create an alternative guest account that can print and set the
10920 \m[blue]\fBguest account\fR\m[]
10921 in the [global] section\&.
10922 .sp
10923 You can form quite complex print commands by realizing that they are just passed to a shell\&. For example the following will log a print job, print the file, then remove it\&. Note that \*(Aq;\*(Aq is the usual separator for command in shell scripts\&.
10924 .sp
10925 print command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s
10926 .sp
10927 You may have to vary this command considerably depending on how you normally print files on your system\&. The default for the parameter varies depending on the setting of the
10928 \m[blue]\fBprinting\fR\m[]
10929 parameter\&.
10930 .sp
10931 Default: For
10932 printing = BSD, AIX, QNX, LPRNG or PLP :
10933 .sp
10934 print command = lpr \-r \-P%p %s
10935 .sp
10936 For
10937 printing = SYSV or HPUX :
10938 .sp
10939 print command = lp \-c \-d%p %s; rm %s
10940 .sp
10941 For
10942 printing = SOFTQ :
10943 .sp
10944 print command = lp \-d%p \-s %s; rm %s
10945 .sp
10946 For printing = CUPS : If SAMBA is compiled against libcups, then
10947 \m[blue]\fBprintcap = cups\fR\m[]
10948 uses the CUPS API to submit jobs, etc\&. Otherwise it maps to the System V commands with the \-oraw option for printing, i\&.e\&. it uses
10949 lp \-c \-d%p \-oraw; rm %s\&. With
10950 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
10951 .sp
10952 \fINo default\fR
10953 .sp
10954 Example:
10955 \fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR
10956 .RE
10957
10958 printer
10959 .PP
10960 .RS 4
10961 This parameter is a synonym for
10962 printer name\&.
10963 .RE
10964
10965 printer name (S)
10966 .PP
10967 .RS 4
10968 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
10969 .sp
10970 If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified\&.
10971 .sp
10972 The default value of the
10973 \m[blue]\fBprinter name\fR\m[]
10974 may be
10975 lp
10976 on many systems\&.
10977 .sp
10978 Default:
10979 \fI\fIprinter name\fR\fR\fI = \fR\fI\fR\fI \fR
10980 .sp
10981 Example:
10982 \fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR
10983 .RE
10984
10985 printing (S)
10986 .PP
10987 .RS 4
10988 This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
10989 \fIprint command\fR,
10990 \fIlpq command\fR,
10991 \fIlppause command \fR,
10992 \fIlpresume command\fR, and
10993 \fIlprm command\fR
10994 if specified in the [global] section\&.
10995 .sp
10996 Currently nine printing styles are supported\&. They are
10997 \fBBSD\fR,
10998 \fBAIX\fR,
10999 \fBLPRNG\fR,
11000 \fBPLP\fR,
11001 \fBSYSV\fR,
11002 \fBHPUX\fR,
11003 \fBQNX\fR,
11004 \fBSOFTQ\fR,
11005 \fBCUPS\fR
11006 and
11007 \fBIPRINT\fR\&.
11008 .sp
11009 Be aware that CUPS and IPRINT are only available if the CUPS development library was available at the time Samba was compiled or packaged\&.
11010 .sp
11011 To see what the defaults are for the other print commands when using the various options use the
11012 \fBtestparm\fR(1)
11013 program\&.
11014 .sp
11015 This option can be set on a per printer basis\&. Please be aware however, that you must place any of the various printing commands (e\&.g\&. print command, lpq command, etc\&.\&.\&.) after defining the value for the
11016 \fIprinting\fR
11017 option since it will reset the printing commands to default values\&.
11018 .sp
11019 See also the discussion in the
11020 [printers]
11021 section\&.
11022 .sp
11023 See
11024 testparm \-v\&.
11025 for the default value on your system
11026 .sp
11027 Default:
11028 \fI\fIprinting\fR\fR\fI = \fR\fI # Depends on the operating system\fR\fI \fR
11029 .RE
11030
11031 printjob username (S)
11032 .PP
11033 .RS 4
11034 This parameter specifies which user information will be passed to the printing system\&. Usually, the username is sent, but in some cases, e\&.g\&. the domain prefix is useful, too\&.
11035 .sp
11036 Default:
11037 \fI\fIprintjob username\fR\fR\fI = \fR\fI%U\fR\fI \fR
11038 .sp
11039 Example:
11040 \fI\fIprintjob username\fR\fR\fI = \fR\fI%D\e%U\fR\fI \fR
11041 .RE
11042
11043 print notify backchannel (S)
11044 .PP
11045 .RS 4
11046 Windows print clients can update print queue status by expecting the server to open a backchannel SMB connection to them\&. Due to client firewall settings this can cause considerable timeouts and will often fail, as there is no guarantee the client is even running an SMB server\&. By default, the Samba print server will not try to connect back to clients, and will treat corresponding requests as if the connection back to the client failed\&.
11047 .sp
11048 Default:
11049 \fI\fIprint notify backchannel\fR\fR\fI = \fR\fIno\fR\fI \fR
11050 .RE
11051
11052 private directory
11053 .PP
11054 .RS 4
11055 This parameter is a synonym for
11056 private dir\&.
11057 .RE
11058
11059 private dir (G)
11060 .PP
11061 .RS 4
11062 This parameters defines the directory smbd will use for storing such files as
11063 smbpasswd
11064 and
11065 secrets\&.tdb\&.
11066 .sp
11067 Default:
11068 \fI\fIprivate dir\fR\fR\fI = \fR\fI/var/lib/samba/private\fR\fI \fR
11069 .RE
11070
11071 queuepause command (S)
11072 .PP
11073 .RS 4
11074 This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
11075 .sp
11076 This command should be a program or script which takes a printer name as its only parameter and stops the printer queue, such that no longer jobs are submitted to the printer\&.
11077 .sp
11078 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
11079 .sp
11080 If a
11081 \fI%p\fR
11082 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
11083 .sp
11084 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
11085 .sp
11086 Default:
11087 \fI\fIqueuepause command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
11088 .sp
11089 Example:
11090 \fI\fIqueuepause command\fR\fR\fI = \fR\fIdisable %p\fR\fI \fR
11091 .RE
11092
11093 queueresume command (S)
11094 .PP
11095 .RS 4
11096 This parameter specifies the command to be executed on the server host in order to resume the printer queue\&. It is the command to undo the behavior that is caused by the previous parameter (\m[blue]\fBqueuepause command\fR\m[])\&.
11097 .sp
11098 This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, such that queued jobs are resubmitted to the printer\&.
11099 .sp
11100 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
11101 .sp
11102 If a
11103 \fI%p\fR
11104 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
11105 .sp
11106 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
11107 .sp
11108 Default:
11109 \fI\fIqueueresume command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
11110 .sp
11111 Example:
11112 \fI\fIqueueresume command\fR\fR\fI = \fR\fIenable %p\fR\fI \fR
11113 .RE
11114
11115 raw NTLMv2 auth (G)
11116 .PP
11117 .RS 4
11118 This parameter has been deprecated since Samba 4\&.13 and support for NTLMv2 authentication without NTLMSSP will be removed in a future Samba release\&.
11119 .sp
11120 That is, in the future, the current default of
11121 raw NTLMv2 auth = no
11122 will be the enforced behaviour\&.
11123 .sp
11124 This parameter determines whether or not
11125 \fBsmbd\fR(8)
11126 will allow SMB1 clients without extended security (without SPNEGO) to use NTLMv2 authentication\&.
11127 .sp
11128 If this option,
11129 lanman auth
11130 and
11131 ntlm auth
11132 are all disabled, then only clients with SPNEGO support will be permitted\&. That means NTLMv2 is only supported within NTLMSSP\&.
11133 .sp
11134 Default:
11135 \fI\fIraw NTLMv2 auth\fR\fR\fI = \fR\fIno\fR\fI \fR
11136 .RE
11137
11138 read list (S)
11139 .PP
11140 .RS 4
11141 This is a list of users that are given read\-only access to a service\&. If the connecting user is in this list then they will not be given write access, no matter what the
11142 \m[blue]\fBread only\fR\m[]
11143 option is set to\&. The list can include group names using the syntax described in the
11144 \m[blue]\fBinvalid users\fR\m[]
11145 parameter\&.
11146 .sp
11147 Default:
11148 \fI\fIread list\fR\fR\fI = \fR\fI\fR\fI \fR
11149 .sp
11150 Example:
11151 \fI\fIread list\fR\fR\fI = \fR\fImary, @students\fR\fI \fR
11152 .RE
11153
11154 read only (S)
11155 .PP
11156 .RS 4
11157 An inverted synonym is
11158 \m[blue]\fBwriteable\fR\m[]\&.
11159 .sp
11160 If this parameter is
11161 \fByes\fR, then users of a service may not create or modify files in the service\*(Aqs directory\&.
11162 .sp
11163 Note that a printable service (printable = yes) will
11164 \fIALWAYS\fR
11165 allow writing to the directory (user privileges permitting), but only via spooling operations\&.
11166 .sp
11167 Default:
11168 \fI\fIread only\fR\fR\fI = \fR\fIyes\fR\fI \fR
11169 .RE
11170
11171 read raw (G)
11172 .PP
11173 .RS 4
11174 This is ignored if
11175 \m[blue]\fBasync smb echo handler\fR\m[]
11176 is set, because this feature is incompatible with raw read SMB requests
11177 .sp
11178 If enabled, raw reads allow reads of 65535 bytes in one packet\&. This typically provides a major performance benefit for some very, very old clients\&.
11179 .sp
11180 However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads\&.
11181 .sp
11182 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
11183 .sp
11184 Default:
11185 \fI\fIread raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
11186 .RE
11187
11188 realm (G)
11189 .PP
11190 .RS 4
11191 This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
11192 domain\&. It is usually set to the DNS name of the kerberos server\&.
11193 .sp
11194 Default:
11195 \fI\fIrealm\fR\fR\fI = \fR\fI\fR\fI \fR
11196 .sp
11197 Example:
11198 \fI\fIrealm\fR\fR\fI = \fR\fImysambabox\&.mycompany\&.com\fR\fI \fR
11199 .RE
11200
11201 registry shares (G)
11202 .PP
11203 .RS 4
11204 This turns on or off support for share definitions read from registry\&. Shares defined in
11205 \fIsmb\&.conf\fR
11206 take precedence over shares with the same name defined in registry\&. See the section on registry\-based configuration for details\&.
11207 .sp
11208 Note that this parameter defaults to
11209 \fIno\fR, but it is set to
11210 \fIyes\fR
11211 when
11212 \fIconfig backend\fR
11213 is set to
11214 \fIregistry\fR\&.
11215 .sp
11216 Default:
11217 \fI\fIregistry shares\fR\fR\fI = \fR\fIno\fR\fI \fR
11218 .sp
11219 Example:
11220 \fI\fIregistry shares\fR\fR\fI = \fR\fIyes\fR\fI \fR
11221 .RE
11222
11223 reject aes netlogon servers (G)
11224 .PP
11225 .RS 4
11226 This option controls whether winbindd requires support for ServerAuthenticateKerberos support for the netlogon secure channel\&.
11227 .sp
11228 Support for ServerAuthenticateKerberos was added in Windows starting with Server 2025, it\*(Aqs available in Samba active directory domain controllers starting with 4\&.22 with the \*(Aq\m[blue]\fBserver support krb5 netlogon = yes\fR\m[]\*(Aq option, which is disabled by default\&.
11229 .sp
11230 The following flags will be required: NETLOGON_NEG_PASSWORD_SET2, NETLOGON_NEG_SUPPORTS_KERBEROS_AUTH and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11231 .sp
11232 You can set this to yes if all domain controllers support ServerAuthenticateKerberos\&. This will prevent downgrade attacks\&.
11233 .sp
11234 The behavior can be controlled per netbios domain by using \*(Aqreject aes netlogon servers:NETBIOSDOMAIN = no\*(Aq as option\&.
11235 .sp
11236 This option overrides the
11237 \m[blue]\fBreject md5 servers\fR\m[]
11238 option\&.
11239 .sp
11240 This option overrides the
11241 \m[blue]\fBclient use krb5 netlogon\fR\m[]
11242 option (if it is effectively off)\&.
11243 .sp
11244 Default:
11245 \fI\fIreject aes netlogon servers\fR\fR\fI = \fR\fIno\fR\fI \fR
11246 .RE
11247
11248 reject md5 clients (G)
11249 .PP
11250 .RS 4
11251 This option is deprecated and will be removed in a future release, as it is a security problem if not set to "yes" (which will be the hardcoded behavior in the future)\&.
11252 .sp
11253 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will reject clients which does not support NETLOGON_NEG_SUPPORTS_AES\&.
11254 .sp
11255 Support for NETLOGON_NEG_SUPPORTS_AES was added in Windows starting with Server 2008R2 and Windows 7, it\*(Aqs available in Samba starting with 4\&.0, however third party domain members like NetApp ONTAP still uses RC4 (HMAC\-MD5), see
11256 https://www\&.samba\&.org/samba/security/CVE\-2022\-38023\&.html
11257 for more details\&.
11258 .sp
11259 The default changed from \*(Aqno\*(Aq to \*(Aqyes\*(Aq, with the patches for
11260 CVE\-2022\-38023
11261 see
11262 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11263 .sp
11264 \fIAvoid using this option!\fR
11265 Use an explicit per machine account \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq instead! Which is available with the patches for
11266 CVE\-2022\-38023
11267 see
11268 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11269 .sp
11270 Samba will log an error in the log files at log level 0 if legacy a client is rejected or allowed without an explicit, \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq line to be added, if the legacy client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:error_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
11271 .sp
11272 This allows admins to use "no" only for a short grace period, in order to collect the explicit \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq options\&.
11273 .sp
11274 When set to \*(Aqyes\*(Aq this option overrides the \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT\fR\m[]\*(Aq and \*(Aq\m[blue]\fBallow nt4 crypto\fR\m[]\*(Aq options and implies \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
11275 .sp
11276 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and/or \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq options\&.
11277 .sp
11278 Default:
11279 \fI\fIreject md5 clients\fR\fR\fI = \fR\fIyes\fR\fI \fR
11280 .RE
11281
11282 server reject md5 schannel:COMPUTERACCOUNT (G)
11283 .PP
11284 .RS 4
11285 If you still have legacy domain members or trusted domains, which required "reject md5 clients = no" before, it is possible to specify an explicit exception per computer account by setting \*(Aqserver reject md5 schannel:COMPUTERACCOUNT = no\*(Aq\&. Note that COMPUTERACCOUNT has to be the sAMAccountName value of the computer account (including the trailing \*(Aq$\*(Aq sign)\&.
11286 .sp
11287 Samba will log a complaint in the log files at log level 0 about the security problem if the option is set to "no", but the related computer does not require it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:warn_about_unused_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
11288 .sp
11289 Samba will log a warning in the log files at log level 5 if a setting is still needed for the specified computer account\&.
11290 .sp
11291 See
11292 CVE\-2022\-38023,
11293 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11294 .sp
11295 This option overrides the
11296 \m[blue]\fBreject md5 clients\fR\m[]
11297 option\&.
11298 .sp
11299 When set to \*(Aqyes\*(Aq this option overrides the \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT\fR\m[]\*(Aq and \*(Aq\m[blue]\fBallow nt4 crypto\fR\m[]\*(Aq options and implies \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
11300 .sp
11301 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and/or \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq options\&.
11302 .sp
11303 Which means \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq is only useful in combination with \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
11304 .sp
11305 .if n \{\
11306 .RS 4
11307 .\}
11308 .nf
11309 server reject md5 schannel:LEGACYCOMPUTER1$ = no
11310 server reject aes schannel:LEGACYCOMPUTER1$ = no
11311 server reject md5 schannel:NASBOX$ = no
11312 server reject aes schannel:NASBOX$ = no
11313 server reject md5 schannel:LEGACYCOMPUTER2$ = no
11314 server reject aes schannel:LEGACYCOMPUTER2$ = no
11315
11316 .fi
11317 .if n \{\
11318 .RE
11319 .\}
11320 .sp
11321 \fINo default\fR
11322 .RE
11323
11324 reject md5 servers (G)
11325 .PP
11326 .RS 4
11327 This option controls whether winbindd requires support for aes support for the netlogon secure channel\&.
11328 .sp
11329 The following flags will be required NETLOGON_NEG_ARCFOUR, NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11330 .sp
11331 You can set this to yes if all domain controllers support aes\&. This will prevent downgrade attacks\&.
11332 .sp
11333 The behavior can be controlled per netbios domain by using \*(Aqreject md5 servers:NETBIOSDOMAIN = no\*(Aq as option\&.
11334 .sp
11335 The default changed from \*(Aqno\*(Aq to \*(Aqyes, with the patches for CVE\-2022\-38023, see https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240
11336 .sp
11337 This option is over\-ridden by the
11338 \m[blue]\fBreject aes netlogon servers\fR\m[]
11339 option\&.
11340 .sp
11341 This option overrides the
11342 \m[blue]\fBrequire strong key\fR\m[]
11343 option\&.
11344 .sp
11345 Default:
11346 \fI\fIreject md5 servers\fR\fR\fI = \fR\fIyes\fR\fI \fR
11347 .RE
11348
11349 remote announce (G)
11350 .PP
11351 .RS 4
11352 This option allows you to setup
11353 \fBnmbd\fR(8)
11354 to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
11355 .sp
11356 This is useful if you want your Samba server to appear in a remote workgroup for which the normal browse propagation rules don\*(Aqt work\&. The remote workgroup can be anywhere that you can send IP packets to\&.
11357 .sp
11358 For example:
11359 .sp
11360 .if n \{\
11361 .RS 4
11362 .\}
11363 .nf
11364 remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF
11365 .fi
11366 .if n \{\
11367 .RE
11368 .\}
11369 .sp
11370 the above line would cause
11371 nmbd
11372 to announce itself to the two given IP addresses using the given workgroup names\&. If you leave out the workgroup name, then the one given in the
11373 \m[blue]\fBworkgroup\fR\m[]
11374 parameter is used instead\&.
11375 .sp
11376 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable\&.
11377 .sp
11378 See the chapter on Network Browsing in the Samba\-HOWTO book\&.
11379 .sp
11380 Default:
11381 \fI\fIremote announce\fR\fR\fI = \fR\fI\fR\fI \fR
11382 .RE
11383
11384 remote browse sync (G)
11385 .PP
11386 .RS 4
11387 This option allows you to setup
11388 \fBnmbd\fR(8)
11389 to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment\&. This option will allow you to gain browse lists for multiple workgroups across routed networks\&. This is done in a manner that does not work with any non\-Samba servers\&.
11390 .sp
11391 This is useful if you want your Samba server and all local clients to appear in a remote workgroup for which the normal browse propagation rules don\*(Aqt work\&. The remote workgroup can be anywhere that you can send IP packets to\&.
11392 .sp
11393 For example:
11394 .sp
11395 .if n \{\
11396 .RS 4
11397 .\}
11398 .nf
11399 \fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
11400 .fi
11401 .if n \{\
11402 .RE
11403 .\}
11404 .sp
11405 the above line would cause
11406 nmbd
11407 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
11408 .sp
11409 The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable\&. If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment\&.
11410 .sp
11411 The
11412 \m[blue]\fBremote browse sync\fR\m[]
11413 may be used on networks where there is no WINS server, and may be used on disjoint networks where each network has its own WINS server\&.
11414 .sp
11415 Default:
11416 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\fR\fI \fR
11417 .RE
11418
11419 rename user script (G)
11420 .PP
11421 .RS 4
11422 This is the full pathname to a script that will be run as root by
11423 \fBsmbd\fR(8)
11424 under special circumstances described below\&.
11425 .sp
11426 When a user with admin authority or SeAddUserPrivilege rights renames a user (e\&.g\&.: from the NT4 User Manager for Domains), this script will be run to rename the POSIX user\&. Two variables,
11427 %uold
11428 and
11429 %unew, will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
11430 .if n \{\
11431 .sp
11432 .\}
11433 .RS 4
11434 .it 1 an-trap
11435 .nr an-no-space-flag 1
11436 .nr an-break-flag 1
11437 .br
11438 .ps +1
11439 \fBNote\fR
11440 .ps -1
11441 .br
11442 The script has all responsibility to rename all the necessary data that is accessible in this posix method\&. This can mean different requirements for different backends\&. The tdbsam and smbpasswd backends will take care of the contents of their respective files, so the script is responsible only for changing the POSIX username, and other data that may required for your circumstances, such as home directory\&. Please also consider whether or not you need to rename the actual home directories themselves\&. The ldapsam backend will not make any changes, because of the potential issues with renaming the LDAP naming attribute\&. In this case the script is responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that needs to change for other applications using the same directory\&.
11443 .sp .5v
11444 .RE
11445 Default:
11446 \fI\fIrename user script\fR\fR\fI = \fR\fI\fR\fI \fR
11447 .RE
11448
11449 require strong key (G)
11450 .PP
11451 .RS 4
11452 This option controls whether winbindd requires support for md5 strong key support for the netlogon secure channel\&.
11453 .sp
11454 The following flags will be required NETLOGON_NEG_STRONG_KEYS, NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11455 .sp
11456 You can set this to no if some domain controllers only support des\&. This might allows weak crypto to be negotiated, may via downgrade attacks\&.
11457 .sp
11458 The behavior can be controlled per netbios domain by using \*(Aqrequire strong key:NETBIOSDOMAIN = no\*(Aq as option\&.
11459 .sp
11460 Note for active directory domain this option is hardcoded to \*(Aqyes\*(Aq
11461 .sp
11462 This option is over\-ridden by the
11463 \m[blue]\fBreject md5 servers\fR\m[]
11464 option\&.
11465 .sp
11466 This option overrides the
11467 \m[blue]\fBclient schannel\fR\m[]
11468 option\&.
11469 .sp
11470 Default:
11471 \fI\fIrequire strong key\fR\fR\fI = \fR\fIyes\fR\fI \fR
11472 .RE
11473
11474 reset on zero vc (G)
11475 .PP
11476 .RS 4
11477 This boolean option controls whether an incoming SMB1 session setup should kill other connections coming from the same IP\&. This matches the default Windows 2003 behaviour\&. Setting this parameter to yes becomes necessary when you have a flaky network and windows decides to reconnect while the old connection still has files with share modes open\&. These files become inaccessible over the new connection\&. The client sends a zero VC on the new connection, and Windows 2003 kills all other connections coming from the same IP\&. This way the locked files are accessible again\&. Please be aware that enabling this option will kill connections behind a masquerading router, and will not trigger for clients that only use SMB2 or SMB3\&.
11478 .sp
11479 Default:
11480 \fI\fIreset on zero vc\fR\fR\fI = \fR\fIno\fR\fI \fR
11481 .RE
11482
11483 restrict anonymous (G)
11484 .PP
11485 .RS 4
11486 The setting of this parameter determines whether SAMR and LSA DCERPC services can be accessed anonymously\&. This corresponds to the following Windows Server registry options:
11487 .sp
11488 .if n \{\
11489 .RS 4
11490 .\}
11491 .nf
11492 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\eControl\eLsa\eRestrictAnonymous
11493
11494 .fi
11495 .if n \{\
11496 .RE
11497 .\}
11498 .sp
11499 The option also affects the browse option which is required by legacy clients which rely on Netbios browsing\&. While modern Windows version should be fine with restricting the access there could still be applications relying on anonymous access\&.
11500 .sp
11501 Setting
11502 \m[blue]\fBrestrict anonymous = 1\fR\m[]
11503 will disable anonymous SAMR access\&.
11504 .sp
11505 Setting
11506 \m[blue]\fBrestrict anonymous = 2\fR\m[]
11507 will, in addition to restricting SAMR access, disallow anonymous connections to the IPC$ share in general\&. Setting
11508 \m[blue]\fBguest ok = yes\fR\m[]
11509 on any share will remove the security advantage\&.
11510 .sp
11511 Default:
11512 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI0\fR\fI \fR
11513 .RE
11514
11515 root
11516 .PP
11517 .RS 4
11518 This parameter is a synonym for
11519 root directory\&.
11520 .RE
11521
11522 root dir
11523 .PP
11524 .RS 4
11525 This parameter is a synonym for
11526 root directory\&.
11527 .RE
11528
11529 root directory (G)
11530 .PP
11531 .RS 4
11532 The server will
11533 chroot()
11534 (i\&.e\&. Change its root directory) to this directory on startup\&. This is not strictly necessary for secure operation\&. Even without it the server will deny access to files not in one of the service entries\&. It may also check for, and deny access to, soft links to other parts of the filesystem, or attempts to use "\&.\&." in file names to access other directories (depending on the setting of the
11535 \m[blue]\fBwide links\fR\m[]
11536 parameter)\&.
11537 .sp
11538 Adding a
11539 \fIroot directory\fR
11540 entry other than "/" adds an extra level of security, but at a price\&. It absolutely ensures that no access is given to files not in the sub\-tree specified in the
11541 \fIroot directory\fR
11542 option,
11543 \fIincluding\fR
11544 some files needed for complete operation of the server\&. To maintain full operability of the server you will need to mirror some system files into the
11545 \fIroot directory\fR
11546 tree\&. In particular you will need to mirror
11547 /etc/passwd
11548 (or a subset of it), and any binaries or configuration files needed for printing (if required)\&. The set of files that must be mirrored is operating system dependent\&.
11549 .sp
11550 Default:
11551 \fI\fIroot directory\fR\fR\fI = \fR\fI\fR\fI \fR
11552 .sp
11553 Example:
11554 \fI\fIroot directory\fR\fR\fI = \fR\fI/homes/smb\fR\fI \fR
11555 .RE
11556
11557 root postexec (S)
11558 .PP
11559 .RS 4
11560 This is the same as the
11561 \fIpostexec\fR
11562 parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
11563 .sp
11564 Default:
11565 \fI\fIroot postexec\fR\fR\fI = \fR\fI\fR\fI \fR
11566 .RE
11567
11568 root preexec (S)
11569 .PP
11570 .RS 4
11571 This is the same as the
11572 \fIpreexec\fR
11573 parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
11574 .sp
11575 Default:
11576 \fI\fIroot preexec\fR\fR\fI = \fR\fI\fR\fI \fR
11577 .RE
11578
11579 root preexec close (S)
11580 .PP
11581 .RS 4
11582 This is the same as the
11583 \fIpreexec close \fR
11584 parameter except that the command is run as root\&.
11585 .sp
11586 Default:
11587 \fI\fIroot preexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
11588 .RE
11589
11590 rpc big endian (G)
11591 .PP
11592 .RS 4
11593 Setting this option will force the RPC client and server to transfer data in big endian\&.
11594 .sp
11595 If it is disabled, data will be transferred in little endian\&.
11596 .sp
11597 The behaviour is independent of the endianness of the host machine\&.
11598 .sp
11599 Default:
11600 \fI\fIrpc big endian\fR\fR\fI = \fR\fIno\fR\fI \fR
11601 .RE
11602
11603 rpc server dynamic port range (G)
11604 .PP
11605 .RS 4
11606 This parameter tells the RPC server which port range it is allowed to use to create a listening socket for LSA, SAM, Netlogon and others without wellknown tcp ports\&. The first value is the lowest number of the port range and the second the highest\&.
11607 .sp
11608 This applies to RPC servers in all server roles\&.
11609 .sp
11610 Default:
11611 \fI\fIrpc server dynamic port range\fR\fR\fI = \fR\fI49152\-65535\fR\fI \fR
11612 .RE
11613
11614 rpc server port (G)
11615 .PP
11616 .RS 4
11617 Specifies which port the server should listen on for DCE/RPC over TCP/IP traffic\&.
11618 .sp
11619 This controls the default port for all protocols, except for NETLOGON\&.
11620 .sp
11621 If unset, the first available port from
11622 \m[blue]\fBrpc server dynamic port range\fR\m[]
11623 is used, e\&.g\&. 49152\&.
11624 .sp
11625 The NETLOGON server will use the next available port, e\&.g\&. 49153\&. To change this port use (eg) rpc server port:netlogon = 4000\&.
11626 .sp
11627 Furthermore, all RPC servers can have the port they use specified independenty, with (for example) rpc server port:drsuapi = 5000\&.
11628 .sp
11629 This option applies currently only when
11630 \fBsamba\fR(8)
11631 runs as an active directory domain controller\&.
11632 .sp
11633 The default value 0 causes Samba to select the first available port from
11634 \m[blue]\fBrpc server dynamic port range\fR\m[]\&.
11635 .sp
11636 Default:
11637 \fI\fIrpc server port\fR\fR\fI = \fR\fI0\fR\fI \fR
11638 .RE
11639
11640 rpc start on demand helpers (G)
11641 .PP
11642 .RS 4
11643 This global parameter determines if
11644 samba\-dcerpcd
11645 should be started on demand to service named pipe (np) DCE\-RPC requests from
11646 smbd
11647 or
11648 winbindd\&. This is the normal case where no startup scripts have been modified to start
11649 samba\-dcerpcd
11650 as a daemon\&.
11651 .sp
11652 If
11653 samba\-dcerpcd
11654 is started as a daemon or via a system service manager such as systemd, this parameter MUST be set to "no", otherwise
11655 samba\-dcerpcd
11656 will fail to start\&.
11657 .sp
11658 Default:
11659 \fI\fIrpc start on demand helpers\fR\fR\fI = \fR\fIyes\fR\fI \fR
11660 .RE
11661
11662 samba kcc command (G)
11663 .PP
11664 .RS 4
11665 This option specifies the path to the Samba KCC command\&. This script is used for replication topology replication\&.
11666 .sp
11667 It should not be necessary to modify this option except for testing purposes or if the
11668 samba_kcc
11669 was installed in a non\-default location\&.
11670 .sp
11671 Default:
11672 \fI\fIsamba kcc command\fR\fR\fI = \fR\fI/builddir/build/BUILD/samba\-4\&.24\&.0\-build/samba\-4\&.24\&.0/source4/scripting/bin/samba_kcc\fR\fI \fR
11673 .sp
11674 Example:
11675 \fI\fIsamba kcc command\fR\fR\fI = \fR\fI/usr/local/bin/kcc\fR\fI \fR
11676 .RE
11677
11678 security (G)
11679 .PP
11680 .RS 4
11681 This option affects how clients respond to Samba and is one of the most important settings in the
11682 smb\&.conf
11683 file\&.
11684 .sp
11685 Unless
11686 \m[blue]\fBserver role\fR\m[]
11687 is specified, the default is
11688 security = user, as this is the most common setting, used for a standalone file server or a DC\&.
11689 .sp
11690 The alternatives to
11691 security = user
11692 are
11693 security = ads
11694 or
11695 security = domain, which support joining Samba to a Windows domain
11696 .sp
11697 You should use
11698 security = user
11699 and
11700 \m[blue]\fBmap to guest\fR\m[]
11701 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&.
11702 .sp
11703 The different settings will now be explained\&.
11704 .sp
11705 \fISECURITY = AUTO\fR
11706 .sp
11707 This is the default security setting in Samba, and causes Samba to consult the
11708 \m[blue]\fBserver role\fR\m[]
11709 parameter (if set) to determine the security mode\&.
11710 .sp
11711 \fISECURITY = USER\fR
11712 .sp
11713 If
11714 \m[blue]\fBserver role\fR\m[]
11715 is not specified, this is the default security setting in Samba\&. With user\-level security a client must first "log\-on" with a valid username and password (which can be mapped using the
11716 \m[blue]\fBusername map\fR\m[]
11717 parameter)\&. Encrypted passwords (see the
11718 \m[blue]\fBencrypt passwords\fR\m[]
11719 parameter) can also be used in this security mode\&. Parameters such as
11720 \m[blue]\fBforce user\fR\m[]
11721 and
11722 \m[blue]\fBguest only\fR\m[]
11723 if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated\&.
11724 .sp
11725 \fINote\fR
11726 that the name of the resource being requested is
11727 \fInot\fR
11728 sent to the server until after the server has successfully authenticated the client\&. This is why guest shares don\*(Aqt work in user level security without allowing the server to automatically map unknown users into the
11729 \m[blue]\fBguest account\fR\m[]\&. See the
11730 \m[blue]\fBmap to guest\fR\m[]
11731 parameter for details on doing this\&.
11732 .sp
11733 \fISECURITY = DOMAIN\fR
11734 .sp
11735 This mode will only work correctly if
11736 \fBnet\fR(8)
11737 has been used to add this machine into a Windows NT Domain\&. It expects the
11738 \m[blue]\fBencrypt passwords\fR\m[]
11739 parameter to be set to
11740 \fByes\fR\&. In this mode Samba will try to validate the username/password by passing it to a Windows NT Primary or Backup Domain Controller, in exactly the same way that a Windows NT Server would do\&.
11741 .sp
11742 \fINote\fR
11743 that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to\&.
11744 .sp
11745 \fINote\fR
11746 that from the client\*(Aqs point of view
11747 security = domain
11748 is the same as
11749 security = user\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
11750 .sp
11751 \fINote\fR
11752 that the name of the resource being requested is
11753 \fInot\fR
11754 sent to the server until after the server has successfully authenticated the client\&. This is why guest shares don\*(Aqt work in user level security without allowing the server to automatically map unknown users into the
11755 \m[blue]\fBguest account\fR\m[]\&. See the
11756 \m[blue]\fBmap to guest\fR\m[]
11757 parameter for details on doing this\&.
11758 .sp
11759 See also the
11760 \m[blue]\fBpassword server\fR\m[]
11761 parameter and the
11762 \m[blue]\fBencrypt passwords\fR\m[]
11763 parameter\&.
11764 .sp
11765 \fISECURITY = ADS\fR
11766 .sp
11767 In this mode, Samba will act as a domain member in an ADS realm\&. To operate in this mode, the machine running Samba will need to have Kerberos installed and configured and Samba will need to be joined to the ADS realm using the net utility\&.
11768 .sp
11769 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
11770 .sp
11771 Note that this forces
11772 \m[blue]\fBrequire strong key = yes\fR\m[]
11773 and
11774 \m[blue]\fBclient schannel = yes\fR\m[]
11775 for the primary domain\&.
11776 .sp
11777 Read the chapter about Domain Membership in the HOWTO for details\&.
11778 .sp
11779 Default:
11780 \fI\fIsecurity\fR\fR\fI = \fR\fIAUTO\fR\fI \fR
11781 .sp
11782 Example:
11783 \fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR
11784 .RE
11785
11786 security mask (S)
11787 .PP
11788 .RS 4
11789 This parameter has been removed for Samba 4\&.0\&.0\&.
11790 .sp
11791 \fINo default\fR
11792 .RE
11793
11794 server addresses (S)
11795 .PP
11796 .RS 4
11797 This is a per\-share parameter to limit share visibility and accessibility to specific server IP addresses\&. Multi\-homed servers can offer a different set of shares per interface\&.
11798 .sp
11799 An empty list means to offer a share on all interfaces\&.
11800 .sp
11801 Default:
11802 \fI\fIserver addresses\fR\fR\fI = \fR\fI\fR\fI \fR
11803 .RE
11804
11805 max protocol
11806 .PP
11807 .RS 4
11808 This parameter is a synonym for
11809 server max protocol\&.
11810 .RE
11811
11812 protocol
11813 .PP
11814 .RS 4
11815 This parameter is a synonym for
11816 server max protocol\&.
11817 .RE
11818
11819 server max protocol (G)
11820 .PP
11821 .RS 4
11822 The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
11823 .sp
11824 Possible values are :
11825 .RS
11826 .sp
11827 .RS 4
11828 .ie n \{\
11829 \h'-04'\(bu\h'+03'\c
11830 .\}
11831 .el \{\
11832 .sp -1
11833 .IP \(bu 2.3
11834 .\}
11835 \fBLANMAN1\fR: First
11836 \fImodern\fR
11837 version of the protocol\&. Long filename support\&.
11838 .RE
11839 .sp
11840 .RS 4
11841 .ie n \{\
11842 \h'-04'\(bu\h'+03'\c
11843 .\}
11844 .el \{\
11845 .sp -1
11846 .IP \(bu 2.3
11847 .\}
11848 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
11849 .RE
11850 .sp
11851 .RS 4
11852 .ie n \{\
11853 \h'-04'\(bu\h'+03'\c
11854 .\}
11855 .el \{\
11856 .sp -1
11857 .IP \(bu 2.3
11858 .\}
11859 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
11860 .RE
11861 .sp
11862 .RS 4
11863 .ie n \{\
11864 \h'-04'\(bu\h'+03'\c
11865 .\}
11866 .el \{\
11867 .sp -1
11868 .IP \(bu 2.3
11869 .\}
11870 \fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and later versions of Windows\&. SMB2 has sub protocols available\&.
11871 .RS
11872 .sp
11873 .RS 4
11874 .ie n \{\
11875 \h'-04'\(bu\h'+03'\c
11876 .\}
11877 .el \{\
11878 .sp -1
11879 .IP \(bu 2.3
11880 .\}
11881 \fBSMB2_02\fR: The earliest SMB2 version\&.
11882 .RE
11883 .sp
11884 .RS 4
11885 .ie n \{\
11886 \h'-04'\(bu\h'+03'\c
11887 .\}
11888 .el \{\
11889 .sp -1
11890 .IP \(bu 2.3
11891 .\}
11892 \fBSMB2_10\fR: Windows 7 SMB2 version\&.
11893 .RE
11894 .sp
11895 .RE
11896 By default SMB2 selects the SMB2_10 variant\&.
11897 .RE
11898 .sp
11899 .RS 4
11900 .ie n \{\
11901 \h'-04'\(bu\h'+03'\c
11902 .\}
11903 .el \{\
11904 .sp -1
11905 .IP \(bu 2.3
11906 .\}
11907 \fBSMB3\fR: The same as SMB2\&. Used by Windows 8\&. SMB3 has sub protocols available\&.
11908 .RS
11909 .sp
11910 .RS 4
11911 .ie n \{\
11912 \h'-04'\(bu\h'+03'\c
11913 .\}
11914 .el \{\
11915 .sp -1
11916 .IP \(bu 2.3
11917 .\}
11918 \fBSMB3_00\fR: Windows 8 SMB3 version\&.
11919 .RE
11920 .sp
11921 .RS 4
11922 .ie n \{\
11923 \h'-04'\(bu\h'+03'\c
11924 .\}
11925 .el \{\
11926 .sp -1
11927 .IP \(bu 2.3
11928 .\}
11929 \fBSMB3_02\fR: Windows 8\&.1 SMB3 version\&.
11930 .RE
11931 .sp
11932 .RS 4
11933 .ie n \{\
11934 \h'-04'\(bu\h'+03'\c
11935 .\}
11936 .el \{\
11937 .sp -1
11938 .IP \(bu 2.3
11939 .\}
11940 \fBSMB3_11\fR: Windows 10 SMB3 version\&.
11941 .RE
11942 .sp
11943 .RE
11944 By default SMB3 selects the SMB3_11 variant\&.
11945 .RE
11946 .sp
11947 .RE
11948 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
11949 .sp
11950 Default:
11951 \fI\fIserver max protocol\fR\fR\fI = \fR\fISMB3\fR\fI \fR
11952 .sp
11953 Example:
11954 \fI\fIserver max protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
11955 .RE
11956
11957 min protocol
11958 .PP
11959 .RS 4
11960 This parameter is a synonym for
11961 server min protocol\&.
11962 .RE
11963
11964 server min protocol (G)
11965 .PP
11966 .RS 4
11967 This setting controls the minimum protocol version that the server will allow the client to use\&.
11968 .sp
11969 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol unless you have legacy clients which are SMB1 capable only\&.
11970 .sp
11971 See
11972 Related command: \m[blue]\fBserver max protocol\fR\m[]
11973 for a full list of available protocols\&.
11974 .sp
11975 Default:
11976 \fI\fIserver min protocol\fR\fR\fI = \fR\fISMB2_02\fR\fI \fR
11977 .sp
11978 Example:
11979 \fI\fIserver min protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
11980 .RE
11981
11982 server multi channel support (G)
11983 .PP
11984 .RS 4
11985 This boolean parameter controls whether
11986 \fBsmbd\fR(8)
11987 will support SMB3 multi\-channel\&.
11988 .sp
11989 This parameter was added with version 4\&.4\&.
11990 .sp
11991 Note that this feature was still considered experimental up to 4\&.14\&.
11992 .sp
11993 Due to dependencies to kernel APIs of Linux or FreeBSD, it\*(Aqs only possible to use this feature on Linux and FreeBSD for now\&. For testing this restriction can be overwritten by specifying
11994 \fBforce:server multi channel support=yes\fR
11995 in addition\&.
11996 .sp
11997 This option is enabled by default starting with to 4\&.15 (on Linux and FreeBSD)\&.
11998 .sp
11999 Default:
12000 \fI\fIserver multi channel support\fR\fR\fI = \fR\fIyes\fR\fI \fR
12001 .RE
12002
12003 server reject aes schannel (G)
12004 .PP
12005 .RS 4
12006 \fIThis option is experimental for now!\fR
12007 .sp
12008 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will reject clients which do not support ServerAuthenticateKerberos\&.
12009 .sp
12010 Support for ServerAuthenticateKerberos was added in Windows starting with Server 2025, it\*(Aqs available in Samba starting with 4\&.22 with the \*(Aq\m[blue]\fBserver support krb5 netlogon = yes\fR\m[]\*(Aq and \*(Aq\m[blue]\fBclient use krb5 netlogon = yes\fR\m[]\*(Aq options, which are disabled by default\&.
12011 .sp
12012 Note this options is not really related to security problems behind CVE_2022_38023, but it still uses the debug level related logic and options\&.
12013 .sp
12014 Samba will log an error in the log files at log level 0 if legacy a client is rejected without an explicit, \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq line to be added, if the client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:error_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
12015 .sp
12016 Samba will log a message in the log files at log level 5 if a client is allowed without an explicit, \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq line to be added, if the client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBNETLOGON_AES:usage_debug_level = 0\fR\m[]\*(Aq in order to complain only at a lower or higher log level)\&. This can we used to prepare the configuration before changing to \*(Aq\m[blue]\fBserver reject aes schannel = yes\fR\m[]\*(Aq
12017 .sp
12018 Admins can use \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no/yes\fR\m[]\*(Aq options in order to have more control
12019 .sp
12020 When set to \*(Aqyes\*(Aq this option overrides the \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and \*(Aq\m[blue]\fBreject md5 clients\fR\m[]\*(Aq options and implies \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
12021 .sp
12022 This option interacts with the \*(Aq\m[blue]\fBserver support krb5 netlogon\fR\m[]\*(Aq option\&.
12023 .sp
12024 For now \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq is EXPERIMENTAL and should not be configured explicitly\&.
12025 .sp
12026 Default:
12027 \fI\fIserver reject aes schannel\fR\fR\fI = \fR\fIno\fR\fI \fR
12028 .sp
12029 Example:
12030 \fI\fIserver reject aes schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
12031 .RE
12032
12033 server reject aes schannel:COMPUTERACCOUNT (G)
12034 .PP
12035 .RS 4
12036 If the time has come and most domain members or trusted domains support ServerAuthenticateKerberos, admins may want to use "server reject aes schannel = yes"\&. It is possible to specify an explicit exception per computer account by setting \*(Aqserver reject aes schannel:COMPUTERACCOUNT = no\*(Aq\&. Note that COMPUTERACCOUNT has to be the sAMAccountName value of the computer account (including the trailing \*(Aq$\*(Aq sign)\&.
12037 .sp
12038 Note this options is not really related to security problems behind CVE_2022_38023, but it still uses the debug level related logic and options\&.
12039 .sp
12040 Samba will log a complaint in the log files at log level 0 about the security problem if the option is set to "no", but the related computer does not require it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:warn_about_unused_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
12041 .sp
12042 Samba will log a warning in the log files at log level 5 if a setting is still needed for the specified computer account\&.
12043 .sp
12044 This option overrides the
12045 \m[blue]\fBserver reject aes schannel\fR\m[]
12046 option\&.
12047 .sp
12048 When set to \*(Aqyes\*(Aq this option overrides the \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and \*(Aq\m[blue]\fBreject md5 clients\fR\m[]\*(Aq options and implies \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
12049 .sp
12050 .if n \{\
12051 .RS 4
12052 .\}
12053 .nf
12054 server reject aes schannel:LEGACYCOMPUTER1$ = no
12055 server reject aes schannel:NASBOX$ = no
12056 server reject aes schannel:LEGACYCOMPUTER2$ = no
12057 server reject aes schannel:HIGHPRIVACYSRV$ = yes
12058
12059 .fi
12060 .if n \{\
12061 .RE
12062 .\}
12063 .sp
12064 \fINo default\fR
12065 .RE
12066
12067 server role (G)
12068 .PP
12069 .RS 4
12070 This option determines the basic operating mode of a Samba server and is one of the most important settings in the
12071 smb\&.conf
12072 file\&.
12073 .sp
12074 The default is
12075 server role = auto, as causes Samba to operate according to the
12076 \m[blue]\fBsecurity\fR\m[]
12077 setting, or if not specified as a simple file server that is not connected to any domain\&.
12078 .sp
12079 The alternatives are
12080 server role = standalone
12081 or
12082 server role = member server, which support joining Samba to a Windows domain, along with
12083 server role = domain controller, which run Samba as a Windows domain controller\&.
12084 .sp
12085 You should use
12086 server role = standalone
12087 and
12088 \m[blue]\fBmap to guest\fR\m[]
12089 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&.
12090 .sp
12091 \fISERVER ROLE = AUTO\fR
12092 .sp
12093 This is the default server role in Samba, and causes Samba to consult the
12094 \m[blue]\fBsecurity\fR\m[]
12095 parameter (if set) to determine the server role, giving compatible behaviours to previous Samba versions\&.
12096 .sp
12097 \fISERVER ROLE = STANDALONE\fR
12098 .sp
12099 If
12100 \m[blue]\fBsecurity\fR\m[]
12101 is also not specified, this is the default security setting in Samba\&. In standalone operation, a client must first "log\-on" with a valid username and password (which can be mapped using the
12102 \m[blue]\fBusername map\fR\m[]
12103 parameter) stored on this machine\&. Encrypted passwords (see the
12104 \m[blue]\fBencrypt passwords\fR\m[]
12105 parameter) are by default used in this security mode\&. Parameters such as
12106 \m[blue]\fBforce user\fR\m[]
12107 and
12108 \m[blue]\fBguest only\fR\m[]
12109 if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated\&.
12110 .sp
12111 \fISERVER ROLE = MEMBER SERVER\fR
12112 .sp
12113 This mode will only work correctly if
12114 \fBnet\fR(8)
12115 has been used to add this machine into a Windows Domain\&. It expects the
12116 \m[blue]\fBencrypt passwords\fR\m[]
12117 parameter to be set to
12118 \fByes\fR\&. In this mode Samba will try to validate the username/password by passing it to a Windows or Samba Domain Controller, in exactly the same way that a Windows Server would do\&.
12119 .sp
12120 \fINote\fR
12121 that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to\&. Winbind can provide this\&.
12122 .sp
12123 \fISERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER\fR
12124 .sp
12125 This mode of operation runs a classic Samba primary domain controller, providing domain logon services to Windows and Samba clients of an NT4\-like domain\&. Clients must be joined to the domain to create a secure, trusted path across the network\&. There must be only one PDC per NetBIOS scope (typically a broadcast network or clients served by a single WINS server)\&.
12126 .sp
12127 \fISERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER\fR
12128 .sp
12129 This mode of operation runs a classic Samba backup domain controller, providing domain logon services to Windows and Samba clients of an NT4\-like domain\&. As a BDC, this allows multiple Samba servers to provide redundant logon services to a single NetBIOS scope\&.
12130 .sp
12131 \fISERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER\fR
12132 .sp
12133 This mode of operation runs Samba as an active directory domain controller, providing domain logon services to Windows and Samba clients of the domain\&. This role requires special configuration, see the
12134 Samba4 HOWTO
12135 .sp
12136 \fISERVER ROLE = IPA PRIMARY DOMAIN CONTROLLER\fR
12137 .sp
12138 This mode of operation runs Samba in a hybrid mode for IPA domain controller, providing forest trust to Active Directory\&. This role requires special configuration performed by IPA installers and should not be used manually by any administrator\&.
12139 .sp
12140 Default:
12141 \fI\fIserver role\fR\fR\fI = \fR\fIAUTO\fR\fI \fR
12142 .sp
12143 Example:
12144 \fI\fIserver role\fR\fR\fI = \fR\fIACTIVE DIRECTORY DOMAIN CONTROLLER\fR\fI \fR
12145 .RE
12146
12147 server schannel (G)
12148 .PP
12149 .RS 4
12150 This option is deprecated and will be removed in future, as it is a security problem if not set to "yes" (which will be the hardcoded behavior in future)\&.
12151 .sp
12152 \fIAvoid using this option!\fR
12153 Use explicit \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq instead!
12154 .sp
12155 Samba will log an error in the log files at log level 0 if legacy a client is rejected or allowed without an explicit, \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq line to be added, if the legacy client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2020_1472:error_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
12156 .sp
12157 This allows admins to use "auto" only for a short grace period, in order to collect the explicit \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq options\&.
12158 .sp
12159 See
12160 CVE\-2020\-1472(ZeroLogon),
12161 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=14497\&.
12162 .sp
12163 This option is over\-ridden by the
12164 \m[blue]\fBserver require schannel:COMPUTERACCOUNT\fR\m[]
12165 option\&.
12166 .sp
12167 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT\fR\m[]\*(Aq and/or \*(Aq\m[blue]\fBserver schannel require seal\fR\m[]\*(Aq options\&.
12168 .sp
12169 Default:
12170 \fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
12171 .RE
12172
12173 server require schannel:COMPUTERACCOUNT (G)
12174 .PP
12175 .RS 4
12176 If you still have legacy domain members, which required "server schannel = auto" before, it is possible to specify explicit exception per computer account by using \*(Aqserver require schannel:COMPUTERACCOUNT = no\*(Aq as option\&. Note that COMPUTERACCOUNT has to be the sAMAccountName value of the computer account (including the trailing \*(Aq$\*(Aq sign)\&.
12177 .sp
12178 Samba will complain in the log files at log level 0, about the security problem if the option is not set to "no", but the related computer is actually using the netlogon secure channel (schannel) feature\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2020_1472:warn_about_unused_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
12179 .sp
12180 Samba will warn in the log files at log level 5, if a setting is still needed for the specified computer account\&.
12181 .sp
12182 See
12183 CVE\-2020\-1472(ZeroLogon),
12184 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=14497\&.
12185 .sp
12186 This option overrides the
12187 \m[blue]\fBserver schannel\fR\m[]
12188 option\&.
12189 .sp
12190 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT\fR\m[]\*(Aq and/or \*(Aq\m[blue]\fBserver schannel require seal\fR\m[]\*(Aq options\&.
12191 .sp
12192 Which means \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq is only useful in combination with \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT = no\fR\m[]\*(Aq
12193 .sp
12194 .if n \{\
12195 .RS 4
12196 .\}
12197 .nf
12198 server require schannel:LEGACYCOMPUTER1$ = no
12199 server require schannel seal:LEGACYCOMPUTER1$ = no
12200 server require schannel:NASBOX$ = no
12201 server require schannel seal:NASBOX$ = no
12202 server require schannel:LEGACYCOMPUTER2$ = no
12203 server require schannel seal:LEGACYCOMPUTER2$ = no
12204
12205 .fi
12206 .if n \{\
12207 .RE
12208 .\}
12209 .sp
12210 \fINo default\fR
12211 .RE
12212
12213 server schannel require seal (G)
12214 .PP
12215 .RS 4
12216 This option is deprecated and will be removed in future, as it is a security problem if not set to "yes" (which will be the hardcoded behavior in future)\&.
12217 .sp
12218 This option controls whether the netlogon server, will reject the usage of netlogon secure channel without privacy/enryption\&.
12219 .sp
12220 The option is modelled after the registry key available on Windows\&.
12221 .sp
12222 .if n \{\
12223 .RS 4
12224 .\}
12225 .nf
12226 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\eServices\eNetlogon\eParameters\eRequireSeal=2
12227
12228 .fi
12229 .if n \{\
12230 .RE
12231 .\}
12232 .sp
12233 \fIAvoid using this option!\fR
12234 Use the per computer account specific option \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT\fR\m[]\*(Aq instead! Which is available with the patches for
12235 CVE\-2022\-38023
12236 see
12237 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
12238 .sp
12239 Samba will log an error in the log files at log level 0 if legacy a client is rejected or allowed without an explicit, \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT = no\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT = no\fR\m[]\*(Aq line to be added, if the legacy client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:error_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
12240 .sp
12241 This allows admins to use "no" only for a short grace period, in order to collect the explicit \*(Aq\m[blue]\fBserver schannel require seal:COMPUTERACCOUNT = no\fR\m[]\*(Aq options\&.
12242 .sp
12243 When set to \*(Aqyes\*(Aq this option overrides the \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and \*(Aq\m[blue]\fBserver schannel\fR\m[]\*(Aq options and implies \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = yes\fR\m[]\*(Aq\&.
12244 .sp
12245 This option is over\-ridden by the
12246 \m[blue]\fBserver schannel require seal:COMPUTERACCOUNT\fR\m[]
12247 option\&.
12248 .sp
12249 Default:
12250 \fI\fIserver schannel require seal\fR\fR\fI = \fR\fIyes\fR\fI \fR
12251 .RE
12252
12253 server schannel require seal:COMPUTERACCOUNT (G)
12254 .PP
12255 .RS 4
12256 If you still have legacy domain members, which required "server schannel require seal = no" before, it is possible to specify explicit exception per computer account by using \*(Aqserver schannel require seal:COMPUTERACCOUNT = no\*(Aq as option\&. Note that COMPUTERACCOUNT has to be the sAMAccountName value of the computer account (including the trailing \*(Aq$\*(Aq sign)\&.
12257 .sp
12258 Samba will log a complaint in the log files at log level 0 about the security problem if the option is set to "no", but the related computer does not require it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:warn_about_unused_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
12259 .sp
12260 Samba will warn in the log files at log level 5, if a setting is still needed for the specified computer account\&.
12261 .sp
12262 See
12263 CVE\-2022\-38023,
12264 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
12265 .sp
12266 This option overrides the \*(Aq\m[blue]\fBserver schannel require seal\fR\m[]\*(Aq option\&.
12267 .sp
12268 When set to \*(Aqyes\*(Aq this option overrides the \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and \*(Aq\m[blue]\fBserver schannel\fR\m[]\*(Aq options and implies \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = yes\fR\m[]\*(Aq\&.
12269 .sp
12270 .if n \{\
12271 .RS 4
12272 .\}
12273 .nf
12274 server require schannel seal:LEGACYCOMPUTER1$ = no
12275 server require schannel seal:NASBOX$ = no
12276 server require schannel seal:LEGACYCOMPUTER2$ = no
12277
12278 .fi
12279 .if n \{\
12280 .RE
12281 .\}
12282 .sp
12283 \fINo default\fR
12284 .RE
12285
12286 server services (G)
12287 .PP
12288 .RS 4
12289 This option contains the services that the Samba daemon will run\&.
12290 .sp
12291 An entry in the
12292 smb\&.conf
12293 file can either override the previous value completely or entries can be removed from or added to it by prefixing them with
12294 \fB+\fR
12295 or
12296 \fB\-\fR\&.
12297 .sp
12298 Default:
12299 \fI\fIserver services\fR\fR\fI = \fR\fIs3fs, rpc, nbt, wrepl, ldap, cldap, kdc, drepl, ft_scanner, winbindd, ntp_signd, kcc, dnsupdate, dns\fR\fI \fR
12300 .sp
12301 Example:
12302 \fI\fIserver services\fR\fR\fI = \fR\fI\-s3fs, +smb\fR\fI \fR
12303 .RE
12304
12305 server signing (G)
12306 .PP
12307 .RS 4
12308 This controls whether the client is allowed or required to use SMB1 and SMB2 signing\&. Possible values are
12309 \fIdefault\fR,
12310 \fIauto\fR,
12311 \fImandatory\fR
12312 and
12313 \fIdisabled\fR\&.
12314 .sp
12315 By default, and when smb signing is set to
12316 \fIdefault\fR, smb signing is required when
12317 \m[blue]\fBserver role\fR\m[]
12318 is
12319 \fIactive directory domain controller\fR
12320 and disabled otherwise\&.
12321 .sp
12322 When set to auto, SMB1 signing is offered, but not enforced\&. When set to mandatory, SMB1 signing is required and if set to disabled, SMB signing is not offered either\&.
12323 .sp
12324 For the SMB2 protocol, by design, signing cannot be disabled\&. In the case where SMB2 is negotiated, if this parameter is set to
12325 \fIdisabled\fR, it will be treated as
12326 \fIauto\fR\&. Setting it to
12327 \fImandatory\fR
12328 will still require SMB2 clients to use signing\&.
12329 .sp
12330 Default:
12331 \fI\fIserver signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
12332 .RE
12333
12334 server smb encrypt (S)
12335 .PP
12336 .RS 4
12337 This parameter controls whether a remote client is allowed or required to use SMB encryption\&. It has different effects depending on whether the connection uses SMB1 or SMB2 and newer:
12338 .RS
12339 .sp
12340 .RS 4
12341 .ie n \{\
12342 \h'-04'\(bu\h'+03'\c
12343 .\}
12344 .el \{\
12345 .sp -1
12346 .IP \(bu 2.3
12347 .\}
12348 If the connection uses SMB1, then this option controls the use of a Samba\-specific extension to the SMB protocol introduced in Samba 3\&.2 that makes use of the Unix extensions\&.
12349 .RE
12350 .sp
12351 .RS 4
12352 .ie n \{\
12353 \h'-04'\(bu\h'+03'\c
12354 .\}
12355 .el \{\
12356 .sp -1
12357 .IP \(bu 2.3
12358 .\}
12359 If the connection uses SMB2 or newer, then this option controls the use of the SMB\-level encryption that is supported in SMB version 3\&.0 and above and available in Windows 8 and newer\&.
12360 .RE
12361 .sp
12362 .RE
12363 This parameter can be set globally and on a per\-share bases\&. Possible values are
12364 \fIoff\fR,
12365 \fIif_required\fR,
12366 \fIdesired\fR, and
12367 \fIrequired\fR\&. A special value is
12368 \fIdefault\fR
12369 which is the implicit default setting of
12370 \fIif_required\fR\&.
12371 .PP
12372 \fIEffects for SMB1\fR
12373 .RS 4
12374 The Samba\-specific encryption of SMB1 connections is an extension to the SMB protocol negotiated as part of the UNIX extensions\&. SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and sign every request/response in a SMB protocol stream\&. When enabled it provides a secure method of SMB/CIFS communication, similar to an ssh protected session, but using SMB/CIFS authentication to negotiate encryption and signing keys\&. Currently this is only supported smbclient of by Samba 3\&.2 and newer, and hopefully soon Linux CIFSFS and MacOS/X clients\&. Windows clients do not support this feature\&.
12375 .sp
12376 This may be set on a per\-share basis, but clients may chose to encrypt the entire session, not just traffic to a specific share\&. If this is set to mandatory then all traffic to a share
12377 \fImust\fR
12378 be encrypted once the connection has been made to the share\&. The server would return "access denied" to all non\-encrypted requests on such a share\&. Selecting encrypted traffic reduces throughput as smaller packet sizes must be used (no huge UNIX style read/writes allowed) as well as the overhead of encrypting and signing all the data\&.
12379 .sp
12380 If SMB encryption is selected, Windows style SMB signing (see the
12381 \m[blue]\fBserver signing\fR\m[]
12382 option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.
12383 .sp
12384 When set to auto or default, SMB encryption is offered, but not enforced\&. When set to mandatory, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated\&.
12385 .RE
12386 .PP
12387 \fIEffects for SMB3\&.0 and newer\fR
12388 .RS 4
12389 Native SMB transport encryption is available in SMB version 3\&.0 or newer\&. It is only offered by Samba if
12390 \fIserver max protocol\fR
12391 is set to
12392 \fISMB3\fR
12393 or newer\&. Clients supporting this type of encryption include Windows 8 and newer, Windows server 2012 and newer, and smbclient of Samba 4\&.1 and newer\&.
12394 .sp
12395 The protocol implementation offers various options:
12396 .RS
12397 .sp
12398 .RS 4
12399 .ie n \{\
12400 \h'-04'\(bu\h'+03'\c
12401 .\}
12402 .el \{\
12403 .sp -1
12404 .IP \(bu 2.3
12405 .\}
12406 The capability to perform SMB encryption can be negotiated during protocol negotiation\&.
12407 .RE
12408 .sp
12409 .RS 4
12410 .ie n \{\
12411 \h'-04'\(bu\h'+03'\c
12412 .\}
12413 .el \{\
12414 .sp -1
12415 .IP \(bu 2.3
12416 .\}
12417 Data encryption can be enabled globally\&. In that case, an encryption\-capable connection will have all traffic in all its sessions encrypted\&. In particular all share connections will be encrypted\&.
12418 .RE
12419 .sp
12420 .RS 4
12421 .ie n \{\
12422 \h'-04'\(bu\h'+03'\c
12423 .\}
12424 .el \{\
12425 .sp -1
12426 .IP \(bu 2.3
12427 .\}
12428 Data encryption can also be enabled per share if not enabled globally\&. For an encryption\-capable connection, all connections to an encryption\-enabled share will be encrypted\&.
12429 .RE
12430 .sp
12431 .RS 4
12432 .ie n \{\
12433 \h'-04'\(bu\h'+03'\c
12434 .\}
12435 .el \{\
12436 .sp -1
12437 .IP \(bu 2.3
12438 .\}
12439 Encryption can be enforced\&. This means that session setups will be denied on non\-encryption\-capable connections if data encryption has been enabled globally\&. And tree connections will be denied for non\-encryption capable connections to shares with data encryption enabled\&.
12440 .RE
12441 .sp
12442 .RE
12443 These features can be controlled with settings of
12444 \fIserver smb encrypt\fR
12445 as follows:
12446 .RS
12447 .sp
12448 .RS 4
12449 .ie n \{\
12450 \h'-04'\(bu\h'+03'\c
12451 .\}
12452 .el \{\
12453 .sp -1
12454 .IP \(bu 2.3
12455 .\}
12456 Leaving it as default, explicitly setting
12457 \fIdefault\fR, or setting it to
12458 \fIif_required\fR
12459 globally will enable negotiation of encryption but will not turn on data encryption globally or per share\&.
12460 .RE
12461 .sp
12462 .RS 4
12463 .ie n \{\
12464 \h'-04'\(bu\h'+03'\c
12465 .\}
12466 .el \{\
12467 .sp -1
12468 .IP \(bu 2.3
12469 .\}
12470 Setting it to
12471 \fIdesired\fR
12472 globally will enable negotiation and will turn on data encryption on sessions and share connections for those clients that support it\&.
12473 .RE
12474 .sp
12475 .RS 4
12476 .ie n \{\
12477 \h'-04'\(bu\h'+03'\c
12478 .\}
12479 .el \{\
12480 .sp -1
12481 .IP \(bu 2.3
12482 .\}
12483 Setting it to
12484 \fIrequired\fR
12485 globally will enable negotiation and turn on data encryption on sessions and share connections\&. Clients that do not support encryption will be denied access to the server\&.
12486 .RE
12487 .sp
12488 .RS 4
12489 .ie n \{\
12490 \h'-04'\(bu\h'+03'\c
12491 .\}
12492 .el \{\
12493 .sp -1
12494 .IP \(bu 2.3
12495 .\}
12496 Setting it to
12497 \fIoff\fR
12498 globally will completely disable the encryption feature for all connections\&. Setting
12499 \fIserver smb encrypt = required\fR
12500 for individual shares (while it\*(Aqs globally off) will deny access to this shares for all clients\&.
12501 .RE
12502 .sp
12503 .RS 4
12504 .ie n \{\
12505 \h'-04'\(bu\h'+03'\c
12506 .\}
12507 .el \{\
12508 .sp -1
12509 .IP \(bu 2.3
12510 .\}
12511 Setting it to
12512 \fIdesired\fR
12513 on a share will turn on data encryption for this share for clients that support encryption if negotiation has been enabled globally\&.
12514 .RE
12515 .sp
12516 .RS 4
12517 .ie n \{\
12518 \h'-04'\(bu\h'+03'\c
12519 .\}
12520 .el \{\
12521 .sp -1
12522 .IP \(bu 2.3
12523 .\}
12524 Setting it to
12525 \fIrequired\fR
12526 on a share will enforce data encryption for this share if negotiation has been enabled globally\&. I\&.e\&. clients that do not support encryption will be denied access to the share\&.
12527 .sp
12528 Note that this allows per\-share enforcing to be controlled in Samba differently from Windows: In Windows,
12529 \fIRejectUnencryptedAccess\fR
12530 is a global setting, and if it is set, all shares with data encryption turned on are automatically enforcing encryption\&. In order to achieve the same effect in Samba, one has to globally set
12531 \fIserver smb encrypt\fR
12532 to
12533 \fIif_required\fR, and then set all shares that should be encrypted to
12534 \fIrequired\fR\&. Additionally, it is possible in Samba to have some shares with encryption
12535 \fIrequired\fR
12536 and some other shares with encryption only
12537 \fIdesired\fR, which is not possible in Windows\&.
12538 .RE
12539 .sp
12540 .RS 4
12541 .ie n \{\
12542 \h'-04'\(bu\h'+03'\c
12543 .\}
12544 .el \{\
12545 .sp -1
12546 .IP \(bu 2.3
12547 .\}
12548 Setting it to
12549 \fIoff\fR
12550 or
12551 \fIif_required\fR
12552 for a share has no effect\&.
12553 .RE
12554 .sp
12555 .RE
12556 .RE
12557 .sp
12558 Default:
12559 \fI\fIserver smb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
12560 .RE
12561
12562 server smb3 encryption algorithms (G)
12563 .PP
12564 .RS 4
12565 This parameter specifies the availability and order of encryption algorithms which are available for negotiation in the SMB3_11 dialect\&.
12566 .sp
12567 It is also possible to remove individual algorithms from the default list, by prefixing them with \*(Aq\-\*(Aq\&. This can avoid having to specify a hardcoded list\&.
12568 .sp
12569 Note: that the removal of AES\-128\-CCM from the list will result in SMB3_00 and SMB3_02 being unavailable, as it is the default and only available algorithm for these dialects\&.
12570 .sp
12571 Default:
12572 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-128\-GCM, AES\-128\-CCM, AES\-256\-GCM, AES\-256\-CCM\fR\fI \fR
12573 .sp
12574 Example:
12575 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-256\-GCM\fR\fI \fR
12576 .sp
12577 Example:
12578 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fI\-AES\-128\-GCM \-AES\-128\-CCM\fR\fI \fR
12579 .RE
12580
12581 server smb encryption over quic (G)
12582 .PP
12583 .RS 4
12584 This parameter controls whether the SMB server requires SMB\-level encryption although the transport is encrypted via QUIC\&.
12585 .sp
12586 \fIserver smb encrypt\fR
12587 controls the use of the encryption mechanism introduced with SMB3\&.0\&. If
12588 \fIserver smb encryption over quic\fR
12589 value is set to
12590 \fIno\fR,
12591 \fIand\fR
12592 the client connects via a validated QUIC (and thus TLS) connection, the server ignores the requirements from the parameter
12593 \fIserver smb encrypt\fR
12594 and accepts all SMB\-level packets inside the QUIC connection as encrypted in a trustworthy way\&. This avoids costly double\-encryption\&.
12595 .sp
12596 If
12597 \fIserver smb encryption over quic\fR
12598 is left at its default
12599 \fIyes\fR, the client connects over normal TCP, or the client does not indicate that it can trust the QUIC connection it uses, the requirements from
12600 \fIserver smb encrypt\fR
12601 apply\&.
12602 .sp
12603 Note that the QUIC\-layer encryption is based on a TLS\-level certificate presented by the server\&. The SMB\-layer encryption is based on individual user sessions and as such essentially on initial user credentials such as the user\*(Aqs password or equivalent credentials used for logging on to a Windows session\&. This might influence your security assessment regarding the
12604 \fIserver smb encryption over quic\fR
12605 parameter\&.
12606 .sp
12607 Windows has a similar SMB server setting with the
12608 \fIDisableSmbEncryptionOnSecureConnection\fR
12609 switch in the
12610 Set\-SmbServerConfiguration
12611 PowerShell commandlet\&.
12612 .sp
12613 Default:
12614 \fI\fIserver smb encryption over quic\fR\fR\fI = \fR\fIyes\fR\fI \fR
12615 .RE
12616
12617 server smb3 signing algorithms (G)
12618 .PP
12619 .RS 4
12620 This parameter specifies the availability and order of signing algorithms which are available for negotiation in the SMB3_11 dialect\&.
12621 .sp
12622 It is also possible to remove individual algorithms from the default list, by prefixing them with \*(Aq\-\*(Aq\&. This can avoid having to specify a hardcoded list\&.
12623 .sp
12624 Note: that the removal of AES\-128\-CMAC from the list will result in SMB3_00 and SMB3_02 being unavailable, and the removal of HMAC\-SHA256 will result in SMB2_02 and SMB2_10 being unavailable, as these are the default and only available algorithms for these dialects\&.
12625 .sp
12626 Default:
12627 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-GMAC, AES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
12628 .sp
12629 Example:
12630 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
12631 .sp
12632 Example:
12633 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fI\-AES\-128\-CMAC\fR\fI \fR
12634 .RE
12635
12636 server smb transports (G)
12637 .PP
12638 .RS 4
12639 Specifies which transports and ports the server should listen on for SMB traffic\&.
12640 .sp
12641 The order matters only for mDNS registrations, the first \*(Aqtcp\*(Aq or \*(Aqnbt\*(Aq port is used for that\&.
12642 .sp
12643 The transport \*(Aqtcp\*(Aq uses raw tcp with a 4 byte length header per SMB PDU\&. The default port for \*(Aqtcp\*(Aq is 445\&. Other ports can be specified by adding it after \*(Aq:\*(Aq, e\&.g\&. \*(Aqtcp:1445\*(Aq\&.
12644 .sp
12645 The transport \*(Aqnbt\*(Aq uses netbios framing on top of tcp per SMB PDU\&. The default port for \*(Aqnbt\*(Aq is 139\&. Other ports can be specified by adding it after \*(Aq:\*(Aq, e\&.g\&. \*(Aqnbt:1139\*(Aq\&.
12646 .sp
12647 The transport \*(Aqquic\*(Aq uses the quic protocol on top of udp\&. The default port for \*(Aqquic\*(Aq is 443\&. Other ports can be specified by adding it after \*(Aq:\*(Aq, e\&.g\&. \*(Aqquic:1443\*(Aq\&. The following options are also relevant:
12648 \m[blue]\fBtls enabled\fR\m[],
12649 \m[blue]\fBtls cafile\fR\m[],
12650 \m[blue]\fBtls certfile\fR\m[]
12651 and
12652 \m[blue]\fBtls keyfile\fR\m[]\&. If the files pointed to by
12653 \m[blue]\fBtls cafile\fR\m[],
12654 \m[blue]\fBtls certfile\fR\m[]
12655 and
12656 \m[blue]\fBtls keyfile\fR\m[]
12657 all do not exist, a self\-signed tls certificate is generated automatically at startup\&.
12658 .sp
12659 Note: \*(Aqquic\*(Aq requires the quic\&.ko kernel module for Linux from https://github\&.com/lxin/quic (tested with Linux 6\&.14)\&. Future Linux versions may support it natively\&.
12660 .sp
12661 Numerical ports are handled as \*(Aqtcp\*(Aq except port \*(Aq139\*(Aq is handled as \*(Aqnbt\*(Aq\&.
12662 .sp
12663 Note that\*(Aqs currently a limit of 10 unique transports, all others will be ignored\&.
12664 .sp
12665 Default:
12666 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, nbt\fR\fI \fR
12667 .sp
12668 Example:
12669 \fI\fIserver smb transports\fR\fR\fI = \fR\fI445\fR\fI \fR
12670 .sp
12671 Example:
12672 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, tcp:1445\fR\fI \fR
12673 .sp
12674 Example:
12675 \fI\fIserver smb transports\fR\fR\fI = \fR\fI8000, nbt:1139\fR\fI \fR
12676 .sp
12677 Example:
12678 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, quic, nbt\fR\fI \fR
12679 .sp
12680 Example:
12681 \fI\fIserver smb transports\fR\fR\fI = \fR\fI+quic\fR\fI \fR
12682 .RE
12683
12684 smb ports (G)
12685 .PP
12686 .RS 4
12687 This is a synonym for
12688 \m[blue]\fBserver smb transports\fR\m[]\&.
12689 .sp
12690 \fINo default\fR
12691 .RE
12692
12693 server string (G)
12694 .PP
12695 .RS 4
12696 This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
12697 net view\&. It can be any string that you wish to show to your users\&.
12698 .sp
12699 It also sets what will appear in browse lists next to the machine name\&.
12700 .sp
12701 A
12702 \fI%v\fR
12703 will be replaced with the Samba version number\&.
12704 .sp
12705 A
12706 \fI%h\fR
12707 will be replaced with the hostname\&.
12708 .sp
12709 Default:
12710 \fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR
12711 .sp
12712 Example:
12713 \fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR
12714 .RE
12715
12716 server support krb5 netlogon (G)
12717 .PP
12718 .RS 4
12719 \fIThis option is experimental for now!\fR
12720 .sp
12721 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will provide support for ServerAuthenticateKerberos\&.
12722 .sp
12723 Support for ServerAuthenticateKerberos was added in Windows starting with Server 2025, it\*(Aqs available in Samba starting with 4\&.22 with the \*(Aq\m[blue]\fBserver support krb5 netlogon = yes\fR\m[]\*(Aq and \*(Aq\m[blue]\fBclient use krb5 netlogon = yes\fR\m[]\*(Aq options, which are disabled by default\&.
12724 .sp
12725 This option interacts with the \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = yes\fR\m[]\*(Aq and \*(Aq\m[blue]\fBserver reject aes schannel = yes\fR\m[]\*(Aq options\&.
12726 .sp
12727 Default:
12728 \fI\fIserver support krb5 netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
12729 .sp
12730 Example:
12731 \fI\fIserver support krb5 netlogon\fR\fR\fI = \fR\fIyes\fR\fI \fR
12732 .RE
12733
12734 set primary group script (G)
12735 .PP
12736 .RS 4
12737 Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups\&. This script sets the primary group in the unix user database when an administrator sets the primary group from the windows user manager or when fetching a SAM with
12738 net rpc vampire\&.
12739 \fI%u\fR
12740 will be replaced with the user whose primary group is to be set\&.
12741 \fI%g\fR
12742 will be replaced with the group to set\&.
12743 .sp
12744 Default:
12745 \fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR
12746 .sp
12747 Example:
12748 \fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \*(Aq%g\*(Aq \*(Aq%u\*(Aq\fR\fI \fR
12749 .RE
12750
12751 set quota command (G)
12752 .PP
12753 .RS 4
12754 The
12755 set quota command
12756 should only be used whenever there is no operating system API available from the OS that samba can use\&.
12757 .sp
12758 This option is only available if Samba was compiled with quota support\&.
12759 .sp
12760 This parameter should specify the path to a script that can set quota for the specified arguments\&.
12761 .sp
12762 The specified script should take the following arguments:
12763 .RS
12764 .sp
12765 .RS 4
12766 .ie n \{\
12767 \h'-04'\(bu\h'+03'\c
12768 .\}
12769 .el \{\
12770 .sp -1
12771 .IP \(bu 2.3
12772 .\}
12773 1 \- path to where the quota needs to be set\&. This needs to be interpreted relative to the current working directory that the script may also check for\&.
12774 .RE
12775 .sp
12776 .RS 4
12777 .ie n \{\
12778 \h'-04'\(bu\h'+03'\c
12779 .\}
12780 .el \{\
12781 .sp -1
12782 .IP \(bu 2.3
12783 .\}
12784 2 \- quota type
12785 .RS
12786 .sp
12787 .RS 4
12788 .ie n \{\
12789 \h'-04'\(bu\h'+03'\c
12790 .\}
12791 .el \{\
12792 .sp -1
12793 .IP \(bu 2.3
12794 .\}
12795 1 \- user quotas
12796 .RE
12797 .sp
12798 .RS 4
12799 .ie n \{\
12800 \h'-04'\(bu\h'+03'\c
12801 .\}
12802 .el \{\
12803 .sp -1
12804 .IP \(bu 2.3
12805 .\}
12806 2 \- user default quotas (uid = \-1)
12807 .RE
12808 .sp
12809 .RS 4
12810 .ie n \{\
12811 \h'-04'\(bu\h'+03'\c
12812 .\}
12813 .el \{\
12814 .sp -1
12815 .IP \(bu 2.3
12816 .\}
12817 3 \- group quotas
12818 .RE
12819 .sp
12820 .RS 4
12821 .ie n \{\
12822 \h'-04'\(bu\h'+03'\c
12823 .\}
12824 .el \{\
12825 .sp -1
12826 .IP \(bu 2.3
12827 .\}
12828 4 \- group default quotas (gid = \-1)
12829 .RE
12830 .sp
12831 .RE
12832 .RE
12833 .sp
12834 .RS 4
12835 .ie n \{\
12836 \h'-04'\(bu\h'+03'\c
12837 .\}
12838 .el \{\
12839 .sp -1
12840 .IP \(bu 2.3
12841 .\}
12842 3 \- id (uid for user, gid for group, \-1 if N/A)
12843 .RE
12844 .sp
12845 .RS 4
12846 .ie n \{\
12847 \h'-04'\(bu\h'+03'\c
12848 .\}
12849 .el \{\
12850 .sp -1
12851 .IP \(bu 2.3
12852 .\}
12853 4 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce)
12854 .RE
12855 .sp
12856 .RS 4
12857 .ie n \{\
12858 \h'-04'\(bu\h'+03'\c
12859 .\}
12860 .el \{\
12861 .sp -1
12862 .IP \(bu 2.3
12863 .\}
12864 5 \- block softlimit
12865 .RE
12866 .sp
12867 .RS 4
12868 .ie n \{\
12869 \h'-04'\(bu\h'+03'\c
12870 .\}
12871 .el \{\
12872 .sp -1
12873 .IP \(bu 2.3
12874 .\}
12875 6 \- block hardlimit
12876 .RE
12877 .sp
12878 .RS 4
12879 .ie n \{\
12880 \h'-04'\(bu\h'+03'\c
12881 .\}
12882 .el \{\
12883 .sp -1
12884 .IP \(bu 2.3
12885 .\}
12886 7 \- inode softlimit
12887 .RE
12888 .sp
12889 .RS 4
12890 .ie n \{\
12891 \h'-04'\(bu\h'+03'\c
12892 .\}
12893 .el \{\
12894 .sp -1
12895 .IP \(bu 2.3
12896 .\}
12897 8 \- inode hardlimit
12898 .RE
12899 .sp
12900 .RS 4
12901 .ie n \{\
12902 \h'-04'\(bu\h'+03'\c
12903 .\}
12904 .el \{\
12905 .sp -1
12906 .IP \(bu 2.3
12907 .\}
12908 9(optional) \- block size, defaults to 1024
12909 .RE
12910 .sp
12911 .RE
12912 The script should output at least one line of data on success\&. And nothing on failure\&.
12913 .sp
12914 Default:
12915 \fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR
12916 .sp
12917 Example:
12918 \fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR
12919 .RE
12920
12921 share:fake_fscaps (S)
12922 .PP
12923 .RS 4
12924 This is needed to support some special applications that makes use of filesystem specific features like sparse files or block reflink copy\&.
12925 .sp
12926 With
12927 \m[blue]\fBshare:fake_fscaps = 64\fR\m[]
12928 the SPARSE_FILES (0x40) file system capability flag is set\&.
12929 .sp
12930 With
12931 \m[blue]\fBshare:fake_fscaps = 134217728\fR\m[]
12932 the SUPPORTS_BLOCK_REFCOUNTING (0x8000000) file system capability flag is set\&. As of this writing, filesystems that support this feature are BTRFS, XFS and ZFS\&.
12933 .sp
12934 The complete list can be found in MS\-FSCC 2\&.5\&.1 FileFsAttributeInformation\&. Note that only decimal values can be used in the configuration\&.
12935 .sp
12936 Default:
12937 \fI\fIshare:fake_fscaps\fR\fR\fI = \fR\fI0\fR\fI \fR
12938 .RE
12939
12940 short preserve case (S)
12941 .PP
12942 .RS 4
12943 This boolean parameter controls if new files which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the
12944 \m[blue]\fBdefault case\fR\m[]\&. This option can be use with
12945 \m[blue]\fBpreserve case = yes\fR\m[]
12946 to permit long filenames to retain their case, while short names are lowered\&.
12947 .sp
12948 See the section on
12949 NAME MANGLING\&.
12950 .sp
12951 Default:
12952 \fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
12953 .RE
12954
12955 show add printer wizard (G)
12956 .PP
12957 .RS 4
12958 With the introduction of MS\-RPC based printing support for Windows NT/2000 client in Samba 2\&.2, a "Printers\&.\&.\&." folder will appear on Samba hosts in the share listing\&. Normally this folder will contain an icon for the MS Add Printer Wizard (APW)\&. However, it is possible to disable this feature regardless of the level of privilege of the connected user\&.
12959 .sp
12960 Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for Administrator privileges\&. If the user does not have administrative access on the print server (i\&.e is not root or has granted the SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level\&. This should succeed, however the APW icon will not be displayed\&.
12961 .sp
12962 Disabling the
12963 \fIshow add printer wizard\fR
12964 parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
12965 .if n \{\
12966 .sp
12967 .\}
12968 .RS 4
12969 .it 1 an-trap
12970 .nr an-no-space-flag 1
12971 .nr an-break-flag 1
12972 .br
12973 .ps +1
12974 \fBNote\fR
12975 .ps -1
12976 .br
12977 This does not prevent the same user from having administrative privilege on an individual printer\&.
12978 .sp .5v
12979 .RE
12980 Default:
12981 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR
12982 .RE
12983
12984 shutdown script (G)
12985 .PP
12986 .RS 4
12987 This a full path name to a script called by
12988 \fBsmbd\fR(8)
12989 that should start a shutdown procedure\&.
12990 .sp
12991 If the connected user possesses the
12992 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
12993 .sp
12994 The %z %t %r %f variables are expanded as follows:
12995 .RS
12996 .sp
12997 .RS 4
12998 .ie n \{\
12999 \h'-04'\(bu\h'+03'\c
13000 .\}
13001 .el \{\
13002 .sp -1
13003 .IP \(bu 2.3
13004 .\}
13005 \fI%z\fR
13006 will be substituted with the shutdown message sent to the server\&.
13007 .RE
13008 .sp
13009 .RS 4
13010 .ie n \{\
13011 \h'-04'\(bu\h'+03'\c
13012 .\}
13013 .el \{\
13014 .sp -1
13015 .IP \(bu 2.3
13016 .\}
13017 \fI%t\fR
13018 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
13019 .RE
13020 .sp
13021 .RS 4
13022 .ie n \{\
13023 \h'-04'\(bu\h'+03'\c
13024 .\}
13025 .el \{\
13026 .sp -1
13027 .IP \(bu 2.3
13028 .\}
13029 \fI%r\fR
13030 will be substituted with the switch
13031 \fI\-r\fR\&. It means reboot after shutdown for NT\&.
13032 .RE
13033 .sp
13034 .RS 4
13035 .ie n \{\
13036 \h'-04'\(bu\h'+03'\c
13037 .\}
13038 .el \{\
13039 .sp -1
13040 .IP \(bu 2.3
13041 .\}
13042 \fI%f\fR
13043 will be substituted with the switch
13044 \fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
13045 .RE
13046 .sp
13047 .RE
13048 Shutdown script example:
13049 .sp
13050 .if n \{\
13051 .RS 4
13052 .\}
13053 .nf
13054 #!/bin/bash
13055
13056 time=$2
13057 let time="${time} / 60"
13058 let time="${time} + 1"
13059
13060 /sbin/shutdown $3 $4 +$time $1 &
13061
13062 .fi
13063 .if n \{\
13064 .RE
13065 .\}
13066 .sp
13067 Shutdown does not return so we need to launch it in background\&.
13068 .sp
13069 Default:
13070 \fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR
13071 .sp
13072 Example:
13073 \fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR
13074 .RE
13075
13076 unix extensions
13077 .PP
13078 .RS 4
13079 This parameter is a synonym for
13080 smb1 unix extensions\&.
13081 .RE
13082
13083 smb1 unix extensions (G)
13084 .PP
13085 .RS 4
13086 This boolean parameter controls whether Samba implements the SMB1/CIFS UNIX extensions, as defined by HP\&. These extensions enable Samba to better serve UNIX SMB1/CIFS clients by supporting features such as symbolic links, hard links, etc\&.\&.\&. These extensions require a similarly enabled client, and are of no current use to Windows clients\&.
13087 .sp
13088 Note if this parameter is turned on, the
13089 \m[blue]\fBwide links\fR\m[]
13090 parameter will automatically be disabled\&.
13091 .sp
13092 See the parameter
13093 \m[blue]\fBallow insecure wide links\fR\m[]
13094 if you wish to change this coupling between the two parameters\&.
13095 .sp
13096 Default:
13097 \fI\fIsmb1 unix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
13098 .RE
13099
13100 smb2 disable lock sequence checking (G)
13101 .PP
13102 .RS 4
13103 This boolean parameter controls whether
13104 \fBsmbd\fR(8)
13105 will disable lock sequence checking even for multi\-channel connections as well as durable handles\&.
13106 .sp
13107 The [MS\-SMB2] specification (under 3\&.3\&.5\&.14 Receiving an SMB2 LOCK Request) documents that a server should do lock sequence if Open\&.IsResilient or Open\&.IsDurable or Open\&.IsPersistent is TRUE or if Connection\&.Dialect belongs to the SMB 3\&.x dialect family and Connection\&.ServerCapabilities includes SMB2_GLOBAL_CAP_MULTI_CHANNEL\&.
13108 .sp
13109 But Windows Server (at least up to v2004) only does these checks for the Open\&.IsResilient and Open\&.IsPersistent\&. That means they do not implement the behavior specified in [MS\-SMB2]\&.
13110 .sp
13111 By default Samba behaves according to the specification and implements lock sequence checking when multi\-channel is used\&.
13112 .sp
13113 Warning: Only enable this option if existing clients can\*(Aqt handle lock sequence checking for handles without Open\&.IsResilient and Open\&.IsPersistent\&. And it turns out that the Windows Server behavior is required\&.
13114 .sp
13115 Note: it\*(Aqs likely that this option will be removed again if future Windows versions change their behavior\&.
13116 .sp
13117 Note: Samba does not implement Open\&.IsResilient and Open\&.IsPersistent yet\&.
13118 .sp
13119 Default:
13120 \fI\fIsmb2 disable lock sequence checking\fR\fR\fI = \fR\fIno\fR\fI \fR
13121 .sp
13122 Example:
13123 \fI\fIsmb2 disable lock sequence checking\fR\fR\fI = \fR\fIyes\fR\fI \fR
13124 .RE
13125
13126 smb2 disable oplock break retry (G)
13127 .PP
13128 .RS 4
13129 This boolean parameter controls whether
13130 \fBsmbd\fR(8)
13131 will trigger smb2 oplock break notification retries when using
13132 \m[blue]\fBserver multi channel support = yes\fR\m[]\&.
13133 .sp
13134 The [MS\-SMB2] specification documents that a server should send smb2 oplock break notification retries on all available channel to the given client\&.
13135 .sp
13136 But Windows Server versions (at least up to 2019) do not send smb2 oplock break notification retries on channel failures\&. That means they do not implement the behavior specified in [MS\-SMB2]\&.
13137 .sp
13138 By default Samba behaves according to the specification and send smb2 oplock break notification retries\&.
13139 .sp
13140 Warning: Only enable this option if existing clients can\*(Aqt handle possible retries and it turns out that the Windows Server behavior is required\&.
13141 .sp
13142 Note: it\*(Aqs likely that this option gets removed again if future Windows versions change their behavior\&.
13143 .sp
13144 Note: this only applies to oplocks and not SMB2 leases\&.
13145 .sp
13146 Default:
13147 \fI\fIsmb2 disable oplock break retry\fR\fR\fI = \fR\fIno\fR\fI \fR
13148 .sp
13149 Example:
13150 \fI\fIsmb2 disable oplock break retry\fR\fR\fI = \fR\fIyes\fR\fI \fR
13151 .RE
13152
13153 smb2 leases (G)
13154 .PP
13155 .RS 4
13156 This boolean option tells
13157 smbd
13158 whether to globally negotiate SMB2 leases on file open requests\&. Leasing is an SMB2\-only feature which allows clients to aggressively cache files locally above and beyond the caching allowed by SMB1 oplocks\&.
13159 .sp
13160 This is only available with
13161 \m[blue]\fBoplocks = yes\fR\m[]
13162 and
13163 \m[blue]\fBkernel oplocks = no\fR\m[]\&.
13164 .sp
13165 Default:
13166 \fI\fIsmb2 leases\fR\fR\fI = \fR\fIyes\fR\fI \fR
13167 .RE
13168
13169 smb2 max credits (G)
13170 .PP
13171 .RS 4
13172 This option controls the maximum number of outstanding simultaneous SMB2 operations that Samba tells the client it will allow\&. This is similar to the
13173 \m[blue]\fBmax mux\fR\m[]
13174 parameter for SMB1\&. You should never need to set this parameter\&.
13175 .sp
13176 The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server\&.
13177 .sp
13178 Default:
13179 \fI\fIsmb2 max credits\fR\fR\fI = \fR\fI8192\fR\fI \fR
13180 .RE
13181
13182 smb2 max read (G)
13183 .PP
13184 .RS 4
13185 This option specifies the protocol value that
13186 \fBsmbd\fR(8)
13187 will return to a client, informing the client of the largest size that may be returned by a single SMB2 read call\&.
13188 .sp
13189 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
13190 .sp
13191 Please note that the default is 8MiB, but it\*(Aqs limit is based on the smb2 dialect (64KiB for SMB == 2\&.0, 8MiB for SMB >= 2\&.1 with LargeMTU)\&. Large MTU is not supported over NBT (tcp port 139)\&.
13192 .sp
13193 Default:
13194 \fI\fIsmb2 max read\fR\fR\fI = \fR\fI8388608\fR\fI \fR
13195 .RE
13196
13197 smb2 max trans (G)
13198 .PP
13199 .RS 4
13200 This option specifies the protocol value that
13201 \fBsmbd\fR(8)
13202 will return to a client, informing the client of the largest size of buffer that may be used in querying file meta\-data via QUERY_INFO and related SMB2 calls\&.
13203 .sp
13204 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
13205 .sp
13206 Please note that the default is 8MiB, but it\*(Aqs limit is based on the smb2 dialect (64KiB for SMB == 2\&.0, 1MiB for SMB >= 2\&.1 with LargeMTU)\&. Large MTU is not supported over NBT (tcp port 139)\&.
13207 .sp
13208 Default:
13209 \fI\fIsmb2 max trans\fR\fR\fI = \fR\fI8388608\fR\fI \fR
13210 .RE
13211
13212 smb2 max write (G)
13213 .PP
13214 .RS 4
13215 This option specifies the protocol value that
13216 \fBsmbd\fR(8)
13217 will return to a client, informing the client of the largest size that may be sent to the server by a single SMB2 write call\&.
13218 .sp
13219 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
13220 .sp
13221 Please note that the default is 8MiB, but it\*(Aqs limit is based on the smb2 dialect (64KiB for SMB == 2\&.0, 8MiB for SMB => 2\&.1 with LargeMTU)\&. Large MTU is not supported over NBT (tcp port 139)\&.
13222 .sp
13223 Default:
13224 \fI\fIsmb2 max write\fR\fR\fI = \fR\fI8388608\fR\fI \fR
13225 .RE
13226
13227 smb3 directory leases (G)
13228 .PP
13229 .RS 4
13230 This is an enumerated type that controls
13231 smbd
13232 whether SMB3 directory leases are enabled\&. Directory Leasing is an SMB3\-only feature which allows clients to cache directories\&.
13233 .sp
13234 Possible values for
13235 \m[blue]\fBsmb3 directory leases\fR\m[]
13236 are
13237 \fByes\fR,
13238 \fBno\fR
13239 and
13240 \fBauto\fR,
13241 \fBauto\fR
13242 being the default\&.
13243 .sp
13244 When set to
13245 \fBauto\fR, the effective value depends on the option
13246 \m[blue]\fBclustering\fR\m[]\&. If
13247 \m[blue]\fBclustering\fR\m[]
13248 is enabled,
13249 \m[blue]\fBsmb3 directory leases\fR\m[]
13250 are disabled and the other way around\&.
13251 .sp
13252 \m[blue]\fBsmb3 directory leases\fR\m[]
13253 are only available with
13254 \m[blue]\fBsmb2 leases = yes\fR\m[],
13255 \m[blue]\fBoplocks = yes\fR\m[]
13256 and
13257 \m[blue]\fBkernel oplocks = no\fR\m[]\&.
13258 .sp
13259 Enabling
13260 \m[blue]\fBsmb3 directory leases\fR\m[]
13261 implicitly enables
13262 \m[blue]\fBstrict rename\fR\m[]\&.
13263 .sp
13264 Default:
13265 \fI\fIsmb3 directory leases\fR\fR\fI = \fR\fIauto\fR\fI \fR
13266 .RE
13267
13268 smb3 share cap:CONTINUOUS AVAILABILITY (S)
13269 .PP
13270 .RS 4
13271 The SMB3 protocol introduced the SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY flag\&. It means clients can have different expectations from the server (or cluster of servers)\&.
13272 .sp
13273 Note: this option only applies to disk shares\&.
13274 .sp
13275 In a ctdb cluster shares are continuously available, but windows clients mix this with the global persistent handles support\&.
13276 .sp
13277 Persistent handles are requested if SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is present even without SMB2_CAP_PERSISTENT_HANDLES\&.
13278 .sp
13279 And SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is required for SMB2_SHARE_CAP_CLUSTER to have an effect\&.
13280 .sp
13281 So we better don\*(Aqt announce this by default until we support persistent handles\&.
13282 .sp
13283 The
13284 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13285 option can be used to force the announcement of SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY\&.
13286 .sp
13287 Warning: only use this if you know what you are doing!
13288 .sp
13289 .if n \{\
13290 .RS 4
13291 .\}
13292 .nf
13293 smb3 share cap:CONTINUOUS AVAILABILITY = yes
13294
13295 .fi
13296 .if n \{\
13297 .RE
13298 .\}
13299 .sp
13300 \fINo default\fR
13301 .RE
13302
13303 smb3 share cap:SCALE OUT (S)
13304 .PP
13305 .RS 4
13306 The SMB3 protocol introduced the SMB2_SHARE_CAP_SCALEOUT flag\&. It means clients can have different expectations from cluster of multiple servers and alters the retry/reconnect behavior\&.
13307 .sp
13308 Note: this option only applies to disk shares\&.
13309 .sp
13310 In a ctdb cluster we have multiple active nodes, so we announce SMB2_SHARE_CAP_SCALEOUT in a cluster\&.
13311 .sp
13312 The
13313 \m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[]
13314 option can be used to disable the announcement of SMB2_SHARE_CAP_SCALEOUT, even if
13315 \m[blue]\fBclustering\fR\m[]
13316 is yes\&.
13317 .sp
13318 .if n \{\
13319 .RS 4
13320 .\}
13321 .nf
13322 clustering = yes
13323 smb3 share cap: SCALE OUT = no
13324
13325 .fi
13326 .if n \{\
13327 .RE
13328 .\}
13329 .sp
13330 \fINo default\fR
13331 .RE
13332
13333 smb3 share cap:CLUSTER (S)
13334 .PP
13335 .RS 4
13336 The SMB3 protocol introduced the SMB2_SHARE_CAP_CLUSTER flag\&. It means clients can expect that all cluster nodes provide a witness service in order to use the [MS\-SWN] protocol to monitor the server cluster\&.
13337 .sp
13338 Note: this option only applies to disk shares\&.
13339 .sp
13340 rpcd_witness is only active if
13341 \fBsamba-dcerpcd\fR(8)
13342 is not started as on demand helper and only in a ctdb cluster\&.
13343 .sp
13344 So we announce SMB2_SHARE_CAP_CLUSTER only if
13345 \m[blue]\fBclustering\fR\m[]
13346 is yes and
13347 \m[blue]\fBrpc start on demand helpers\fR\m[]
13348 is no\&.
13349 .sp
13350 The
13351 \m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[]
13352 option can be used to control the announcement of SMB2_SHARE_CAP_CLUSTER independent of
13353 \m[blue]\fBclustering\fR\m[]
13354 and
13355 \m[blue]\fBrpc start on demand helpers\fR\m[]\&.
13356 .sp
13357 Example to disable the announcement of SMB2_SHARE_CAP_CLUSTER:
13358 .sp
13359 .if n \{\
13360 .RS 4
13361 .\}
13362 .nf
13363 clustering = yes
13364 rpc start on demand helpers = no
13365 smb3 share cap: CLUSTER = no
13366
13367 .fi
13368 .if n \{\
13369 .RE
13370 .\}
13371 .sp
13372 Example to force the announcement of SMB2_SHARE_CAP_CLUSTER:
13373 .sp
13374 .if n \{\
13375 .RS 4
13376 .\}
13377 .nf
13378 smb3 share cap: CLUSTER = yes
13379
13380 .fi
13381 .if n \{\
13382 .RE
13383 .\}
13384 .sp
13385 Example to let Windows clients use the witness service, see
13386 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13387 option and USE AT YOUR OWN RISK!:
13388 .sp
13389 .if n \{\
13390 .RS 4
13391 .\}
13392 .nf
13393 clustering = yes
13394 rpc start on demand helpers = no
13395 # This is the default with the above:
13396 # smb3 share cap: CLUSTER = yes
13397 #
13398 # Use at you own risk!
13399 smb3 share cap: CONTINUOUS AVAILABILITY = yes
13400
13401 .fi
13402 .if n \{\
13403 .RE
13404 .\}
13405 .sp
13406 \fINo default\fR
13407 .RE
13408
13409 smb3 share cap:ASYMMETRIC (S)
13410 .PP
13411 .RS 4
13412 The SMB3_02 protocol introduced the SMB2_SHARE_CAP_ASYMMETRIC flag\&. It means clients alters its behavior and uses isolated transport connections and witness registrations for the share\&. It means a client may connect to different cluster nodes for individual shares and
13413 net witness share\-move
13414 can be used to control the node usage\&.
13415 .sp
13416 Note: this option only applies to disk shares\&.
13417 .sp
13418 Shares in a ctdb cluster are symmetric by design, so we don\*(Aqt announce SMB2_SHARE_CAP_ASYMMETRIC by default\&.
13419 .sp
13420 The
13421 \m[blue]\fBsmb3 share cap:ASYMMETRIC\fR\m[]
13422 option can be used to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC\&.
13423 .sp
13424 Example to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC:
13425 .sp
13426 .if n \{\
13427 .RS 4
13428 .\}
13429 .nf
13430 smb3 share cap: ASYMMETRIC = yes
13431
13432 .fi
13433 .if n \{\
13434 .RE
13435 .\}
13436 .sp
13437 Example to let Windows clients use the witness service, see
13438 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13439 option and USE AT YOUR OWN RISK!:
13440 .sp
13441 .if n \{\
13442 .RS 4
13443 .\}
13444 .nf
13445 clustering = yes
13446 rpc start on demand helpers = no
13447 # This is the default with the above:
13448 # smb3 share cap: CLUSTER = yes
13449 #
13450 # Use at you own risk!
13451 smb3 share cap: CONTINUOUS AVAILABILITY = yes
13452 smb3 share cap: ASYMMETRIC = yes
13453
13454 .fi
13455 .if n \{\
13456 .RE
13457 .\}
13458 .sp
13459 \fINo default\fR
13460 .RE
13461
13462 smb3 unix extensions (S)
13463 .PP
13464 .RS 4
13465 Support for SMB 3\&.1\&.1 Unix Extensions\&.
13466 .sp
13467 Default:
13468 \fI\fIsmb3 unix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
13469 .RE
13470
13471 smbd async dosmode (S)
13472 .PP
13473 .RS 4
13474 This parameter control whether the fileserver will use sync or async methods for fetching the DOS attributes when doing a directory listing\&. By default sync methods will be used\&.
13475 .sp
13476 Default:
13477 \fI\fIsmbd async dosmode\fR\fR\fI = \fR\fIno\fR\fI \fR
13478 .RE
13479
13480 smbd getinfo ask sharemode (S)
13481 .PP
13482 .RS 4
13483 This parameter allows disabling fetching file write time from the open file handle database locking\&.tdb when a client requests file or directory metadata\&. It\*(Aqs a performance optimisation at the expense of protocol correctness\&.
13484 .sp
13485 Default:
13486 \fI\fIsmbd getinfo ask sharemode\fR\fR\fI = \fR\fIyes\fR\fI \fR
13487 .RE
13488
13489 smbd max async dosmode (S)
13490 .PP
13491 .RS 4
13492 This parameter controls how many async operations to fetch the DOS attributes the fileserver will queue when doing directory listings\&.
13493 .sp
13494 Default:
13495 \fI\fIsmbd max async dosmode\fR\fR\fI = \fR\fIaio max threads * 2\fR\fI \fR
13496 .RE
13497
13498 smbd max xattr size (S)
13499 .PP
13500 .RS 4
13501 This parameter controls the maximum size of extended attributes that may be written to the server as EAs or as alternate data streams if vfs_streams_xattr is enabled\&. The maximum size of extended attributes depends on the Samba server\*(Aqs operating system and the underlying filesystem\&. The Linux VFS currently sets an upper boundary of 64 KiB per extended attribute\&. FreeBSD does not set a practical upper limit, but since pread() and pwrite() are not possible via the extattr on FreeBSD, it is not recommended to increase this value above a few MiB\&. If a client attempts to write an overly\-large alternate datastream, the Samba server will return STATUS_FILESYSTEM_LIMITATION\&. If this error is encountered, users may try increasing the maximum size supported for xattr writes\&. If this is not possible, and writes are from a MacOS client and to an AFP_Resource extended attribute, the user may enable the vfs_fruit module and configure to allow stream writes for AFP_Resource to an alternative storage location\&. See vfs_fruit documentation for further details\&.
13502 .sp
13503 Default:
13504 \fI\fIsmbd max xattr size\fR\fR\fI = \fR\fI65536\fR\fI \fR
13505 .RE
13506
13507 smbd profiling share (S)
13508 .PP
13509 .RS 4
13510 This parameter allows the administrator to enable per\-share profiling support\&. When enabled, profile counters may be collected with per\-share granularity a specific shares\&. Takes affect only when global option
13511 \m[blue]\fBsmbd profiling level\fR\m[]
13512 is enabled\&.
13513 .sp
13514 Default:
13515 \fI\fIsmbd profiling share\fR\fR\fI = \fR\fIno\fR\fI \fR
13516 .RE
13517
13518 smbd profiling level (G)
13519 .PP
13520 .RS 4
13521 This parameter allows the administrator to enable profiling support\&.
13522 .sp
13523 Possible values are
13524 \fBoff\fR,
13525 \fBcount\fR
13526 and
13527 \fBon\fR\&.
13528 .sp
13529 Default:
13530 \fI\fIsmbd profiling level\fR\fR\fI = \fR\fIoff\fR\fI \fR
13531 .sp
13532 Example:
13533 \fI\fIsmbd profiling level\fR\fR\fI = \fR\fIon\fR\fI \fR
13534 .RE
13535
13536 smbd search ask sharemode (S)
13537 .PP
13538 .RS 4
13539 This parameter allows disabling fetching file write time from the open file handle database locking\&.tdb\&. It\*(Aqs a performance optimisation at the expense of protocol correctness\&.
13540 .sp
13541 Default:
13542 \fI\fIsmbd search ask sharemode\fR\fR\fI = \fR\fIyes\fR\fI \fR
13543 .RE
13544
13545 smb encrypt (S)
13546 .PP
13547 .RS 4
13548 This is a synonym for
13549 \m[blue]\fBserver smb encrypt\fR\m[]\&.
13550 .sp
13551 Default:
13552 \fI\fIsmb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
13553 .RE
13554
13555 smb passwd file (G)
13556 .PP
13557 .RS 4
13558 This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
13559 .sp
13560 An example of use is:
13561 .sp
13562 .if n \{\
13563 .RS 4
13564 .\}
13565 .nf
13566 smb passwd file = /etc/samba/smbpasswd
13567 .fi
13568 .if n \{\
13569 .RE
13570 .\}
13571 .sp
13572 Default:
13573 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI/var/lib/samba/private/smbpasswd\fR\fI \fR
13574 .RE
13575
13576 socket options (G)
13577 .PP
13578 .RS 4
13579 .if n \{\
13580 .sp
13581 .\}
13582 .RS 4
13583 .it 1 an-trap
13584 .nr an-no-space-flag 1
13585 .nr an-break-flag 1
13586 .br
13587 .ps +1
13588 \fBWarning\fR
13589 .ps -1
13590 .br
13591 Modern server operating systems are tuned for high network performance in the majority of situations; when you set socket options you are overriding those settings\&. Linux in particular has an auto\-tuning mechanism for buffer sizes that will be disabled if you specify a socket buffer size\&. This can potentially cripple your TCP/IP stack\&.
13592 .sp
13593 Getting the socket options correct can make a big difference to your performance, but getting them wrong can degrade it by just as much\&. As with any other low level setting, if you must make changes to it, make small changes and
13594 \fItest\fR
13595 the effect before making any large changes\&.
13596 .sp .5v
13597 .RE
13598 .sp
13599 This option allows you to set socket options to be used when talking with the client\&.
13600 .sp
13601 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
13602 .sp
13603 This option will typically be used to tune your Samba server for optimal performance for your local network\&. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself\&. We strongly suggest you read the appropriate documentation for your operating system first (perhaps
13604 man setsockopt
13605 will help)\&.
13606 .sp
13607 You may find that on some systems Samba will say "Unknown socket option" when you supply an option\&. This means you either incorrectly typed it or you need to add an include file to includes\&.h for your OS\&. If the latter is the case please send the patch to
13608 samba\-technical@lists\&.samba\&.org\&.
13609 .sp
13610 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
13611 .sp
13612 This is the list of socket options currently settable using this option:
13613 .RS
13614 .sp
13615 .RS 4
13616 .ie n \{\
13617 \h'-04'\(bu\h'+03'\c
13618 .\}
13619 .el \{\
13620 .sp -1
13621 .IP \(bu 2.3
13622 .\}
13623 SO_KEEPALIVE
13624 .RE
13625 .sp
13626 .RS 4
13627 .ie n \{\
13628 \h'-04'\(bu\h'+03'\c
13629 .\}
13630 .el \{\
13631 .sp -1
13632 .IP \(bu 2.3
13633 .\}
13634 SO_REUSEADDR
13635 .RE
13636 .sp
13637 .RS 4
13638 .ie n \{\
13639 \h'-04'\(bu\h'+03'\c
13640 .\}
13641 .el \{\
13642 .sp -1
13643 .IP \(bu 2.3
13644 .\}
13645 SO_BROADCAST
13646 .RE
13647 .sp
13648 .RS 4
13649 .ie n \{\
13650 \h'-04'\(bu\h'+03'\c
13651 .\}
13652 .el \{\
13653 .sp -1
13654 .IP \(bu 2.3
13655 .\}
13656 TCP_NODELAY
13657 .RE
13658 .sp
13659 .RS 4
13660 .ie n \{\
13661 \h'-04'\(bu\h'+03'\c
13662 .\}
13663 .el \{\
13664 .sp -1
13665 .IP \(bu 2.3
13666 .\}
13667 TCP_KEEPCNT *
13668 .RE
13669 .sp
13670 .RS 4
13671 .ie n \{\
13672 \h'-04'\(bu\h'+03'\c
13673 .\}
13674 .el \{\
13675 .sp -1
13676 .IP \(bu 2.3
13677 .\}
13678 TCP_KEEPIDLE *
13679 .RE
13680 .sp
13681 .RS 4
13682 .ie n \{\
13683 \h'-04'\(bu\h'+03'\c
13684 .\}
13685 .el \{\
13686 .sp -1
13687 .IP \(bu 2.3
13688 .\}
13689 TCP_KEEPINTVL *
13690 .RE
13691 .sp
13692 .RS 4
13693 .ie n \{\
13694 \h'-04'\(bu\h'+03'\c
13695 .\}
13696 .el \{\
13697 .sp -1
13698 .IP \(bu 2.3
13699 .\}
13700 IPTOS_LOWDELAY
13701 .RE
13702 .sp
13703 .RS 4
13704 .ie n \{\
13705 \h'-04'\(bu\h'+03'\c
13706 .\}
13707 .el \{\
13708 .sp -1
13709 .IP \(bu 2.3
13710 .\}
13711 IPTOS_THROUGHPUT
13712 .RE
13713 .sp
13714 .RS 4
13715 .ie n \{\
13716 \h'-04'\(bu\h'+03'\c
13717 .\}
13718 .el \{\
13719 .sp -1
13720 .IP \(bu 2.3
13721 .\}
13722 SO_REUSEPORT
13723 .RE
13724 .sp
13725 .RS 4
13726 .ie n \{\
13727 \h'-04'\(bu\h'+03'\c
13728 .\}
13729 .el \{\
13730 .sp -1
13731 .IP \(bu 2.3
13732 .\}
13733 SO_SNDBUF *
13734 .RE
13735 .sp
13736 .RS 4
13737 .ie n \{\
13738 \h'-04'\(bu\h'+03'\c
13739 .\}
13740 .el \{\
13741 .sp -1
13742 .IP \(bu 2.3
13743 .\}
13744 SO_RCVBUF *
13745 .RE
13746 .sp
13747 .RS 4
13748 .ie n \{\
13749 \h'-04'\(bu\h'+03'\c
13750 .\}
13751 .el \{\
13752 .sp -1
13753 .IP \(bu 2.3
13754 .\}
13755 SO_SNDLOWAT *
13756 .RE
13757 .sp
13758 .RS 4
13759 .ie n \{\
13760 \h'-04'\(bu\h'+03'\c
13761 .\}
13762 .el \{\
13763 .sp -1
13764 .IP \(bu 2.3
13765 .\}
13766 SO_RCVLOWAT *
13767 .RE
13768 .sp
13769 .RS 4
13770 .ie n \{\
13771 \h'-04'\(bu\h'+03'\c
13772 .\}
13773 .el \{\
13774 .sp -1
13775 .IP \(bu 2.3
13776 .\}
13777 SO_SNDTIMEO *
13778 .RE
13779 .sp
13780 .RS 4
13781 .ie n \{\
13782 \h'-04'\(bu\h'+03'\c
13783 .\}
13784 .el \{\
13785 .sp -1
13786 .IP \(bu 2.3
13787 .\}
13788 SO_RCVTIMEO *
13789 .RE
13790 .sp
13791 .RS 4
13792 .ie n \{\
13793 \h'-04'\(bu\h'+03'\c
13794 .\}
13795 .el \{\
13796 .sp -1
13797 .IP \(bu 2.3
13798 .\}
13799 TCP_FASTACK *
13800 .RE
13801 .sp
13802 .RS 4
13803 .ie n \{\
13804 \h'-04'\(bu\h'+03'\c
13805 .\}
13806 .el \{\
13807 .sp -1
13808 .IP \(bu 2.3
13809 .\}
13810 TCP_QUICKACK
13811 .RE
13812 .sp
13813 .RS 4
13814 .ie n \{\
13815 \h'-04'\(bu\h'+03'\c
13816 .\}
13817 .el \{\
13818 .sp -1
13819 .IP \(bu 2.3
13820 .\}
13821 TCP_NODELAYACK
13822 .RE
13823 .sp
13824 .RS 4
13825 .ie n \{\
13826 \h'-04'\(bu\h'+03'\c
13827 .\}
13828 .el \{\
13829 .sp -1
13830 .IP \(bu 2.3
13831 .\}
13832 TCP_KEEPALIVE_THRESHOLD *
13833 .RE
13834 .sp
13835 .RS 4
13836 .ie n \{\
13837 \h'-04'\(bu\h'+03'\c
13838 .\}
13839 .el \{\
13840 .sp -1
13841 .IP \(bu 2.3
13842 .\}
13843 TCP_KEEPALIVE_ABORT_THRESHOLD *
13844 .RE
13845 .sp
13846 .RS 4
13847 .ie n \{\
13848 \h'-04'\(bu\h'+03'\c
13849 .\}
13850 .el \{\
13851 .sp -1
13852 .IP \(bu 2.3
13853 .\}
13854 TCP_DEFER_ACCEPT *
13855 .RE
13856 .sp
13857 .RS 4
13858 .ie n \{\
13859 \h'-04'\(bu\h'+03'\c
13860 .\}
13861 .el \{\
13862 .sp -1
13863 .IP \(bu 2.3
13864 .\}
13865 TCP_USER_TIMEOUT *
13866 .RE
13867 .sp
13868 .RE
13869 Those marked with a
13870 \fI\*(Aq*\*(Aq\fR
13871 take an integer argument\&. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don\*(Aqt specify 1 or 0\&.
13872 .sp
13873 To specify an argument use the syntax SOME_OPTION = VALUE for example
13874 SO_SNDBUF = 8192\&. Note that you must not have any spaces before or after the = sign\&.
13875 .sp
13876 If you are on a local network then a sensible option might be:
13877 .sp
13878 socket options = IPTOS_LOWDELAY
13879 .sp
13880 If you have a local network then you could try:
13881 .sp
13882 socket options = IPTOS_LOWDELAY TCP_NODELAY
13883 .sp
13884 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
13885 .sp
13886 Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
13887 .sp
13888 Default:
13889 \fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR
13890 .sp
13891 Example:
13892 \fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR
13893 .RE
13894
13895 spn update command (G)
13896 .PP
13897 .RS 4
13898 This option sets the command that for updating servicePrincipalName names from
13899 spn_update_list\&.
13900 .sp
13901 Default:
13902 \fI\fIspn update command\fR\fR\fI = \fR\fI/builddir/build/BUILD/samba\-4\&.24\&.0\-build/samba\-4\&.24\&.0/source4/scripting/bin/samba_spnupdate\fR\fI \fR
13903 .sp
13904 Example:
13905 \fI\fIspn update command\fR\fR\fI = \fR\fI/usr/local/sbin/spnupdate\fR\fI \fR
13906 .RE
13907
13908 spoolss: architecture (G)
13909 .PP
13910 .RS 4
13911 Windows spoolss print clients only allow association of server\-side drivers with printers when the driver architecture matches the advertised print server architecture\&. Samba\*(Aqs spoolss print server architecture can be changed using this parameter\&.
13912 .sp
13913 Default:
13914 \fI\fIspoolss: architecture\fR\fR\fI = \fR\fIWindows x64\fR\fI \fR
13915 .sp
13916 Example:
13917 \fI\fIspoolss: architecture\fR\fR\fI = \fR\fIWindows NT x86\fR\fI \fR
13918 .RE
13919
13920 spoolss: os_major (G)
13921 .PP
13922 .RS 4
13923 Windows might require a new os version number\&. This option allows to modify the build number\&. The complete default version number is: 5\&.0\&.2195 (Windows 2000)\&. The example is 6\&.1\&.7601 (Windows 2008 R2)\&.
13924 .sp
13925 Default:
13926 \fI\fIspoolss: os_major\fR\fR\fI = \fR\fI5\fR\fI \fR
13927 .sp
13928 Example:
13929 \fI\fIspoolss: os_major\fR\fR\fI = \fR\fI6\fR\fI \fR
13930 .RE
13931
13932 spoolss: os_minor (G)
13933 .PP
13934 .RS 4
13935 Windows might require a new os version number\&. This option allows to modify the build number\&. The complete default version number is: 5\&.0\&.2195 (Windows 2000)\&. The example is 6\&.1\&.7601 (Windows 2008 R2)\&.
13936 .sp
13937 Default:
13938 \fI\fIspoolss: os_minor\fR\fR\fI = \fR\fI0\fR\fI \fR
13939 .sp
13940 Example:
13941 \fI\fIspoolss: os_minor\fR\fR\fI = \fR\fI1\fR\fI \fR
13942 .RE
13943
13944 spoolss: os_build (G)
13945 .PP
13946 .RS 4
13947 Windows might require a new os version number\&. This option allows to modify the build number\&. The complete default version number is: 5\&.0\&.2195 (Windows 2000)\&. The example is 6\&.1\&.7601 (Windows 2008 R2)\&.
13948 .sp
13949 Default:
13950 \fI\fIspoolss: os_build\fR\fR\fI = \fR\fI2195\fR\fI \fR
13951 .sp
13952 Example:
13953 \fI\fIspoolss: os_build\fR\fR\fI = \fR\fI7601\fR\fI \fR
13954 .RE
13955
13956 spoolss_client: os_major (G)
13957 .PP
13958 .RS 4
13959 Windows might require a new os version number\&. This option allows to modify the build number\&. The complete default version number is: 6\&.1\&.7007 (Windows 7 and Windows Server 2008 R2)\&.
13960 .sp
13961 Default:
13962 \fI\fIspoolss_client: os_major\fR\fR\fI = \fR\fI6\fR\fI \fR
13963 .RE
13964
13965 spoolss_client: os_minor (G)
13966 .PP
13967 .RS 4
13968 Windows might require a new os version number\&. This option allows to modify the build number\&. The complete default version number is: 6\&.1\&.7007 (Windows 7 and Windows Server 2008 R2)\&.
13969 .sp
13970 Default:
13971 \fI\fIspoolss_client: os_minor\fR\fR\fI = \fR\fI1\fR\fI \fR
13972 .RE
13973
13974 spoolss_client: os_build (G)
13975 .PP
13976 .RS 4
13977 Windows might require a new os version number\&. This option allows to modify the build number\&. The complete default version number is: 6\&.1\&.7007 (Windows 7 and Windows Server 2008 R2)\&.
13978 .sp
13979 Default:
13980 \fI\fIspoolss_client: os_build\fR\fR\fI = \fR\fI7007\fR\fI \fR
13981 .RE
13982
13983 spotlight (S)
13984 .PP
13985 .RS 4
13986 This parameter controls whether Samba allows Spotlight queries on a share\&. For controlling indexing of filesystems you also have to use Tracker\*(Aqs own configuration system\&.
13987 .sp
13988 Spotlight has several prerequisites:
13989 .RS
13990 .sp
13991 .RS 4
13992 .ie n \{\
13993 \h'-04'\(bu\h'+03'\c
13994 .\}
13995 .el \{\
13996 .sp -1
13997 .IP \(bu 2.3
13998 .\}
13999 Samba must be configured and built with Spotlight support\&.
14000 .RE
14001 .sp
14002 .RS 4
14003 .ie n \{\
14004 \h'-04'\(bu\h'+03'\c
14005 .\}
14006 .el \{\
14007 .sp -1
14008 .IP \(bu 2.3
14009 .\}
14010 Tracker integration must be setup and the share must be indexed by Tracker\&.
14011 .RE
14012 .sp
14013 .RE
14014 For a detailed set of instructions please see
14015 https://wiki\&.samba\&.org/index\&.php/Spotlight\&.
14016 .sp
14017 Default:
14018 \fI\fIspotlight\fR\fR\fI = \fR\fIno\fR\fI \fR
14019 .RE
14020
14021 spotlight backend (S)
14022 .PP
14023 .RS 4
14024 Spotlight search backend\&. Available backends:
14025 .RS
14026 .sp
14027 .RS 4
14028 .ie n \{\
14029 \h'-04'\(bu\h'+03'\c
14030 .\}
14031 .el \{\
14032 .sp -1
14033 .IP \(bu 2.3
14034 .\}
14035 \fBnoindex\fR
14036 \- a backend that returns no results\&.
14037 .RE
14038 .sp
14039 .RE
14040 .RS
14041 .sp
14042 .RS 4
14043 .ie n \{\
14044 \h'-04'\(bu\h'+03'\c
14045 .\}
14046 .el \{\
14047 .sp -1
14048 .IP \(bu 2.3
14049 .\}
14050 \fBtracker\fR
14051 \- Gnome Tracker\&.
14052 .RE
14053 .sp
14054 .RS 4
14055 .ie n \{\
14056 \h'-04'\(bu\h'+03'\c
14057 .\}
14058 .el \{\
14059 .sp -1
14060 .IP \(bu 2.3
14061 .\}
14062 \fBelasticsearch\fR
14063 \- a backend that uses JSON and REST over HTTP(s) to query an Elasticsearch server\&.
14064 .RE
14065 .sp
14066 .RE
14067 .sp
14068 Default:
14069 \fI\fIspotlight backend\fR\fR\fI = \fR\fInoindex\fR\fI \fR
14070 .RE
14071
14072 stat cache (G)
14073 .PP
14074 .RS 4
14075 This parameter determines if
14076 \fBsmbd\fR(8)
14077 will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
14078 .sp
14079 Default:
14080 \fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
14081 .RE
14082
14083 state directory (G)
14084 .PP
14085 .RS 4
14086 Usually, most of the TDB files are stored in the
14087 \fIlock directory\fR\&. Since Samba 3\&.4\&.0, it is possible to differentiate between TDB files with persistent data and TDB files with non\-persistent data using the
14088 \fIstate directory\fR
14089 and the
14090 \fIcache directory\fR
14091 options\&.
14092 .sp
14093 This option specifies the directory where TDB files containing important persistent data will be stored\&.
14094 .sp
14095 Default:
14096 \fI\fIstate directory\fR\fR\fI = \fR\fI/var/lib/samba\fR\fI \fR
14097 .sp
14098 Example:
14099 \fI\fIstate directory\fR\fR\fI = \fR\fI/var/run/samba/locks/state\fR\fI \fR
14100 .RE
14101
14102 store dos attributes (S)
14103 .PP
14104 .RS 4
14105 If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or READ\-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such as occurs with
14106 \m[blue]\fBmap hidden\fR\m[]
14107 and
14108 \m[blue]\fBmap readonly\fR\m[])\&. When set, DOS attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or directory\&. When this parameter is set it will override the parameters
14109 \m[blue]\fBmap hidden\fR\m[],
14110 \m[blue]\fBmap system\fR\m[],
14111 \m[blue]\fBmap archive\fR\m[]
14112 and
14113 \m[blue]\fBmap readonly\fR\m[]
14114 and they will behave as if they were set to off\&. This parameter writes the DOS attributes as a string into the extended attribute named "user\&.DOSATTRIB"\&. This extended attribute is explicitly hidden from smbd clients requesting an EA list\&. On Linux the filesystem must have been mounted with the mount option user_xattr in order for extended attributes to work, also extended attributes must be compiled into the Linux kernel\&. In Samba 3\&.5\&.0 and above the "user\&.DOSATTRIB" extended attribute has been extended to store the create time for a file as well as the DOS attributes\&. This is done in a backwards compatible way so files created by Samba 3\&.5\&.0 and above can still have the DOS attribute read from this extended attribute by earlier versions of Samba, but they will not be able to read the create time stored there\&. Storing the create time separately from the normal filesystem meta\-data allows Samba to faithfully reproduce NTFS semantics on top of a POSIX filesystem\&. The default has changed to yes in Samba release 4\&.9\&.0 and above to allow better Windows fileserver compatibility in a default install\&.
14115 .sp
14116 Default:
14117 \fI\fIstore dos attributes\fR\fR\fI = \fR\fIyes\fR\fI \fR
14118 .RE
14119
14120 strict allocate (S)
14121 .PP
14122 .RS 4
14123 This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
14124 \fByes\fR
14125 the server will change from UNIX behaviour of not committing real disk storage blocks when a file is extended to the Windows behaviour of actually forcing the disk system to allocate real storage blocks when a file is created or extended to be a given size\&. In UNIX terminology this means that Samba will stop creating sparse files\&.
14126 .sp
14127 This option is really designed for file systems that support fast allocation of large numbers of blocks such as extent\-based file systems\&. On file systems that don\*(Aqt support extents (most notably ext3) this can make Samba slower\&. When you work with large files over >100MB on file systems without extents you may even run into problems with clients running into timeouts\&.
14128 .sp
14129 When you have an extent based filesystem it\*(Aqs likely that we can make use of unwritten extents which allows Samba to allocate even large amounts of space very fast and you will not see any timeout problems caused by strict allocate\&. With strict allocate in use you will also get much better out of quota messages in case you use quotas\&. Another advantage of activating this setting is that it will help to reduce file fragmentation\&.
14130 .sp
14131 To give you an idea on which filesystems this setting might currently be a good option for you: XFS, ext4, btrfs, ocfs2 on Linux and JFS2 on AIX support unwritten extents\&. On Filesystems that do not support it, preallocation is probably an expensive operation where you will see reduced performance and risk to let clients run into timeouts when creating large files\&. Examples are ext3, ZFS, HFS+ and most others, so be aware if you activate this setting on those filesystems\&.
14132 .sp
14133 Default:
14134 \fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR
14135 .RE
14136
14137 strict locking (S)
14138 .PP
14139 .RS 4
14140 This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
14141 \fByes\fR, the server will check every read and write access for file locks, and deny access if locks exist\&. This can be slow on some systems\&.
14142 .sp
14143 When strict locking is set to Auto (the default), the server performs file lock checks only on non\-oplocked files\&. As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for improved performance\&.
14144 .sp
14145 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
14146 .sp
14147 Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
14148 strict locking = Auto
14149 or
14150 strict locking = no
14151 is acceptable\&.
14152 .sp
14153 Default:
14154 \fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR
14155 .RE
14156
14157 strict rename (S)
14158 .PP
14159 .RS 4
14160 By default a Windows SMB server prevents directory renames when there are open file or directory handles below it in the filesystem hierarchy\&. Historically Samba has always allowed this as POSIX filesystem semantics require it\&.
14161 .sp
14162 This boolean parameter allows Samba to match the Windows behavior\&. Setting this to "yes" is a very expensive change, as it forces Samba to travers the entire open file handle database on every directory rename request\&. In a clustered Samba system the cost is even greater than the non\-clustered case\&.
14163 .sp
14164 When set to "no" smbd only checks the local process the client is attached to for open files below a directory being renamed, instead of checking for open files across all smbd processes\&.
14165 .sp
14166 Because of the expense in fully searching the database, the default is "no", and it is recommended to be left that way unless a specific Windows application requires it to be changed\&.
14167 .sp
14168 If the client has requested UNIX extensions (POSIX pathnames) then renames are always allowed and this parameter has no effect\&.
14169 .sp
14170 Enabling
14171 \m[blue]\fBsmb3 directory leases\fR\m[]
14172 implicitly enables
14173 \m[blue]\fBstrict rename\fR\m[]\&.
14174 .sp
14175 Default:
14176 \fI\fIstrict rename\fR\fR\fI = \fR\fIno\fR\fI \fR
14177 .RE
14178
14179 strict sync (S)
14180 .PP
14181 .RS 4
14182 This parameter controls whether Samba honors a request from an SMB client to ensure any outstanding operating system buffer contents held in memory are safely written onto stable storage on disk\&. If set to
14183 \fByes\fR, which is the default, then Windows applications can force the smbd server to synchronize unwritten data onto the disk\&. If set to
14184 \fBno\fR
14185 then smbd will ignore client requests to synchronize unwritten data onto stable storage on disk\&.
14186 .sp
14187 In Samba 4\&.7\&.0, the default for this parameter changed from
14188 \fBno\fR
14189 to
14190 \fByes\fR
14191 to better match the expectations of SMB2/3 clients and improve application safety when running against smbd\&.
14192 .sp
14193 The flush request from SMB2/3 clients is handled asynchronously inside smbd, so leaving the parameter as the default value of
14194 \fByes\fR
14195 does not block the processing of other requests to the smbd process\&.
14196 .sp
14197 Legacy Windows applications (such as the Windows 98 explorer shell) seemed to confuse writing buffer contents to the operating system with synchronously writing outstanding data onto stable storage on disk\&. Changing this parameter to
14198 \fBno\fR
14199 means that
14200 \fBsmbd\fR(8)
14201 will ignore the Windows applications request to synchronize unwritten data onto disk\&. Only consider changing this if smbd is serving obsolete SMB1 Windows clients prior to Windows XP (Windows 98 and below)\&. There should be no need to change this setting for normal operations\&.
14202 .sp
14203 Default:
14204 \fI\fIstrict sync\fR\fR\fI = \fR\fIyes\fR\fI \fR
14205 .RE
14206
14207 svcctl list (G)
14208 .PP
14209 .RS 4
14210 This option defines a list of init scripts that smbd will use for starting and stopping Unix services via the Win32 ServiceControl API\&. This allows Windows administrators to utilize the MS Management Console plug\-ins to manage a Unix server running Samba\&.
14211 .sp
14212 The administrator must create a directory name
14213 svcctl
14214 in Samba\*(Aqs $(libdir) and create symbolic links to the init scripts in
14215 /etc/init\&.d/\&. The name of the links must match the names given as part of the
14216 \fIsvcctl list\fR\&.
14217 .sp
14218 Default:
14219 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR
14220 .sp
14221 Example:
14222 \fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR
14223 .RE
14224
14225 sync always (S)
14226 .PP
14227 .RS 4
14228 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
14229 \fBno\fR
14230 then the server will be guided by the client\*(Aqs request in each write call (clients can set a bit indicating that a particular write should be synchronous)\&. If this is
14231 \fByes\fR
14232 then every write will be followed by a
14233 fsync()
14234 call to ensure the data is written to disk\&. Note that the
14235 \fIstrict sync\fR
14236 parameter must be set to
14237 \fByes\fR
14238 in order for this parameter to have any effect\&.
14239 .sp
14240 Default:
14241 \fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR
14242 .RE
14243
14244 sync machine password script (G)
14245 .PP
14246 .RS 4
14247 This is the full pathname to a script that will be run by
14248 \fBwinbindd\fR(8)
14249 when a machine account password is updated\&.
14250 .sp
14251 If keytabs should be generated in clustered environments it is recommended to update them on all nodes\&. You can set the config option to /usr/share/ctdb/scripts/winbind_ctdb_updatekeytab\&.sh in clustering case\&. It is also needed to activate the
14252 \fB46\&.update\-keytabs\&.script\fR
14253 in ctdb, it re\-creates the keytab during the ctdb recovered event:
14254 .sp
14255 .if n \{\
14256 .RS 4
14257 .\}
14258 .nf
14259 onnode all ctdb event script enable legacy 46\&.update\-keytabs\&.script
14260
14261 .fi
14262 .if n \{\
14263 .RE
14264 .\}
14265 .sp
14266 Default:
14267 \fI\fIsync machine password script\fR\fR\fI = \fR\fI\fR\fI \fR
14268 .sp
14269 Example:
14270 \fI\fIsync machine password script\fR\fR\fI = \fR\fI/usr/share/ctdb/scripts/winbind_ctdb_updatekeytab\&.sh\fR\fI \fR
14271 .RE
14272
14273 sync machine password to keytab (G)
14274 .PP
14275 .RS 4
14276 This option allows you to describe what keytabs and how should be updated when machine account is changed via one of these commands
14277 .sp
14278 .if n \{\
14279 .RS 4
14280 .\}
14281 .nf
14282 wbinfo \-\-change\-secret
14283 rpcclient \-\-machine\-pass \-c change_trust_pw
14284 net rpc changetrustpw
14285 net ads changetrustpw
14286 .fi
14287 .if n \{\
14288 .RE
14289 .\}
14290 .sp
14291 or by winbindd doing regular updates (see
14292 \m[blue]\fBmachine password timeout\fR\m[])
14293 .sp
14294 The option takes a list of keytab strings to describe how to synchronize content of those keytabs or a single \*(Aqdisabled\*(Aq value to disable the synchronization\&. Each string has this form:
14295 .sp
14296 .if n \{\
14297 .RS 4
14298 .\}
14299 .nf
14300 absolute_path_to_keytab:spn_spec[:spn_spec]*[:sync_etypes][:sync_kvno][:netbios_aliases][:additional_dns_hostnames][:machine_password]
14301 .fi
14302 .if n \{\
14303 .RE
14304 .\}
14305 .sp
14306 spn_spec can be specified multiple times (separated using \*(Aq:\*(Aq) and each spn_spec can have exactly one of these forms:
14307 .sp
14308 .if n \{\
14309 .RS 4
14310 .\}
14311 .nf
14312 account_name
14313 sync_account_name
14314 sync_upn
14315 sync_spns
14316 spn_prefixes=value1[,value2[\&.\&.\&.]]
14317 spns=value1[,value2[\&.\&.\&.]]
14318 .fi
14319 .if n \{\
14320 .RE
14321 .\}
14322 .sp
14323 Every keytab contains principals according the specification below:
14324 .sp
14325 .if n \{\
14326 .RS 4
14327 .\}
14328 .nf
14329 account_name \- COMPUTER$@REALM
14330 sync_account_name \- uses attribute "sAMAccountName" from AD
14331 sync_upn \- uses attribute "userPrincipalName" (if exists in AD)
14332 sync_spns \- uses attribute "servicePrincipalName" (if exists in AD)
14333 spn_prefixes \- creates these two principals from each prefix\&. e\&.g\&.:
14334 prefix/\m[blue]\fBnetbios name\fR\m[]@REALM
14335 prefix/\m[blue]\fBdns hostname\fR\m[]@REALM
14336 with :netbios_aliases for each netbiosalias in \m[blue]\fBnetbios aliases\fR\m[]
14337 prefix/netbiosalias@REALM
14338 prefix/netbiosalias\&.dnsdomain@REALM
14339 with :additional_dns_hostnames for each additionaldnshostname in \m[blue]\fBadditional dns hostnames\fR\m[]
14340 prefix/additionaldnshostname@REALM
14341 \- \*(Aqhost\*(Aq principal should be created using specifier spn_prefixes
14342 spns \- creates only the principals defined in the list
14343 .fi
14344 .if n \{\
14345 .RE
14346 .\}
14347 .sp
14348 \*(Aqaccount_name\*(Aq and \*(Aqsync_account_name\*(Aq are the same, just the source differs (secrets\&.tdb vs\&. AD)\&.
14349 .sp
14350 Options:
14351 .sp
14352 .if n \{\
14353 .RS 4
14354 .\}
14355 .nf
14356 sync_etypes \- attribute "msDS\-SupportedEncryptionTypes" is read from AD and is used to find the highest common enc type for AD and KRB5 lib\&.
14357 sync_kvno \- attribute "msDS\-KeyVersionNumber" from AD is used to set KVNO\&. If this option is missing, KVNO is set to \-1\&.
14358 netbios_aliases \- evaluated only for spn_prefixes (see details above)\&.
14359 additional_dns_hostnames \- evaluated only for spn_prefixes (see details above)\&.
14360 machine_password \- mandatory, if missing the entry is ignored\&. For future use\&.
14361 .fi
14362 .if n \{\
14363 .RE
14364 .\}
14365 .sp
14366 Example:
14367 .sp
14368 .if n \{\
14369 .RS 4
14370 .\}
14371 .nf
14372 "/path/to/keytab0:account_name:machine_password",
14373 "/path/to/keytab1:account_name:sync_etypes:sync_kvno:machine_password",
14374 "/path/to/keytab2:sync_spns:machine_password",
14375 "/path/to/keytab3:sync_spns:sync_kvno:machine_password",
14376 "/path/to/keytab4:spn_prefixes=imap,smtp:machine_password",
14377 "/path/to/keytab5:spn_prefixes=imap,smtp:netbios_aliases:additional_dns_hostnames:sync_kvno:machine_password",
14378 "/path/to/keytab6:spns=wurst/brot@REALM:machine_password",
14379 "/path/to/keytab7:spns=wurst/brot@REALM,wurst2/brot@REALM:sync_kvno:machine_password",
14380 "/path/to/keytab8:sync_account_name:sync_upn:sync_spns:spn_prefixes=host,cifs,http:spns=wurst/brot@REALM:sync_kvno:machine_password"
14381 .fi
14382 .if n \{\
14383 .RE
14384 .\}
14385 .sp
14386 If sync_etypes or sync_kvno or sync_spns is present then winbind connects to DC\&. For "offline domain join" it might be useful not to use these options\&.
14387 .sp
14388 If no value is present and
14389 \m[blue]\fBkerberos method\fR\m[]
14390 is different from \*(Aqsecrets only\*(Aq, the behavior differs between winbind and net utility:
14391 .RS
14392 .sp
14393 .RS 4
14394 .ie n \{\
14395 \h'-04'\(bu\h'+03'\c
14396 .\}
14397 .el \{\
14398 .sp -1
14399 .IP \(bu 2.3
14400 .\}
14401 \fBwinbind\fR
14402 uses value
14403 .sp
14404 .if n \{\
14405 .RS 4
14406 .\}
14407 .nf
14408 /path/to/keytab:host:account_name:sync_spns:sync_kvno:machine_password
14409 .fi
14410 .if n \{\
14411 .RE
14412 .\}
14413 .sp
14414 where the path to the keytab is obtained either from the krb5 library or from
14415 \m[blue]\fBdedicated keytab file\fR\m[]\&.
14416 .RE
14417 .sp
14418 .RS 4
14419 .ie n \{\
14420 \h'-04'\(bu\h'+03'\c
14421 .\}
14422 .el \{\
14423 .sp -1
14424 .IP \(bu 2.3
14425 .\}
14426 \fBnet changesecretpw \-f\fR
14427 command uses the default \*(Aqdisabled\*(Aq value\&.
14428 .RE
14429 .sp
14430 .RS 4
14431 .ie n \{\
14432 \h'-04'\(bu\h'+03'\c
14433 .\}
14434 .el \{\
14435 .sp -1
14436 .IP \(bu 2.3
14437 .\}
14438 No other
14439 \fBnet\fR
14440 subcommands use the \*(Aqdisabled\*(Aq value\&.
14441 .RE
14442 .sp
14443 .RE
14444 If a single value \*(Aqdisabled\*(Aq is present, the synchronization process is disabled\&. This is required for FreeIPA domain member setup where keytab synchronization uses a protocol not implemented by Samba\&.
14445 .sp
14446 Suggested configuration is together with
14447 \m[blue]\fBkerberos method\fR\m[]
14448 set to the default value \*(Aqsecrets only\*(Aq\&.
14449 .sp
14450 In clustered environments it is recommended to set
14451 \m[blue]\fBsync machine password script\fR\m[]
14452 to update the machine password on all nodes\&.
14453 .sp
14454 \fINo default\fR
14455 .RE
14456
14457 syslog (G)
14458 .PP
14459 .RS 4
14460 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
14461 \fBLOG_ERR\fR, debug level one maps onto
14462 \fBLOG_WARNING\fR, debug level two maps onto
14463 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
14464 \fBLOG_DEBUG\fR\&.
14465 .sp
14466 This parameter sets the threshold for sending messages to syslog\&. Only messages with debug level less than this value will be sent to syslog\&. There still will be some logging to log\&.[sn]mbd even if
14467 \fIsyslog only\fR
14468 is enabled\&.
14469 .sp
14470 The
14471 \m[blue]\fBlogging\fR\m[]
14472 parameter should be used instead\&. When
14473 \m[blue]\fBlogging\fR\m[]
14474 is set, it overrides the
14475 \m[blue]\fBsyslog\fR\m[]
14476 parameter\&.
14477 .sp
14478 Default:
14479 \fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR
14480 .RE
14481
14482 syslog only (G)
14483 .PP
14484 .RS 4
14485 If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files\&. There still will be some logging to log\&.[sn]mbd even if
14486 \fIsyslog only\fR
14487 is enabled\&.
14488 .sp
14489 The
14490 \m[blue]\fBlogging\fR\m[]
14491 parameter should be used instead\&. When
14492 \m[blue]\fBlogging\fR\m[]
14493 is set, it overrides the
14494 \m[blue]\fBsyslog only\fR\m[]
14495 parameter\&.
14496 .sp
14497 Default:
14498 \fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR
14499 .RE
14500
14501 template homedir (G)
14502 .PP
14503 .RS 4
14504 When filling out the user information for a Windows NT user, the
14505 \fBwinbindd\fR(8)
14506 daemon uses this parameter to fill in the home directory for that user\&. If the string
14507 \fI%D\fR
14508 is present it is substituted with the user\*(Aqs Windows NT domain name\&. If the string
14509 \fI%U\fR
14510 is present it is substituted with the user\*(Aqs Windows NT user name\&.
14511 .sp
14512 Default:
14513 \fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR
14514 .RE
14515
14516 template shell (G)
14517 .PP
14518 .RS 4
14519 When filling out the user information for a Windows NT user, the
14520 \fBwinbindd\fR(8)
14521 daemon uses this parameter to fill in the login shell for that user\&.
14522 .sp
14523 Default:
14524 \fI\fItemplate shell\fR\fR\fI = \fR\fI/bin/false\fR\fI \fR
14525 .RE
14526
14527 time server (G)
14528 .PP
14529 .RS 4
14530 This parameter determines if
14531 \fBnmbd\fR(8)
14532 advertises itself as a time server to Windows clients\&.
14533 .sp
14534 Default:
14535 \fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR
14536 .RE
14537
14538 debug timestamp
14539 .PP
14540 .RS 4
14541 This parameter is a synonym for
14542 timestamp logs\&.
14543 .RE
14544
14545 timestamp logs (G)
14546 .PP
14547 .RS 4
14548 Samba debug log messages are timestamped by default\&. If you are running at a high
14549 \m[blue]\fBdebug level\fR\m[]
14550 these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
14551 .sp
14552 Default:
14553 \fI\fItimestamp logs\fR\fR\fI = \fR\fIyes\fR\fI \fR
14554 .RE
14555
14556 tls ca directories (G)
14557 .PP
14558 .RS 4
14559 This option can be set to a list of directories with files (in PEM format) containing CA certificates of root CAs to trust to sign certificates or intermediate CA certificates\&.
14560 .sp
14561 \fINo default\fR
14562 .RE
14563
14564 tls cafile (G)
14565 .PP
14566 .RS 4
14567 This option can be set to a file (PEM format) containing CA certificates of root CAs to trust to sign certificates or intermediate CA certificates\&.
14568 .sp
14569 This path is relative to
14570 \m[blue]\fBprivate dir\fR\m[]
14571 if the path does not start with a /\&.
14572 .sp
14573 Default:
14574 \fI\fItls cafile\fR\fR\fI = \fR\fItls/ca\&.pem\fR\fI \fR
14575 .RE
14576
14577 tls certfile (G)
14578 .PP
14579 .RS 4
14580 This option can be set to a file (PEM format) containing the RSA certificate to be used as TLS server certificate\&. If required it can also contain additional intermediate certificates to be send along during the TLS handshake\&.
14581 .sp
14582 This path is relative to
14583 \m[blue]\fBprivate dir\fR\m[]
14584 if the path does not start with a /\&.
14585 .sp
14586 Default:
14587 \fI\fItls certfile\fR\fR\fI = \fR\fItls/cert\&.pem\fR\fI \fR
14588 .RE
14589
14590 tls crlfile (G)
14591 .PP
14592 .RS 4
14593 This option can be set to a file containing a certificate revocation list (CRL)\&.
14594 .sp
14595 This path is relative to
14596 \m[blue]\fBprivate dir\fR\m[]
14597 if the path does not start with a /\&.
14598 .sp
14599 Default:
14600 \fI\fItls crlfile\fR\fR\fI = \fR\fI\fR\fI \fR
14601 .RE
14602
14603 tls dh params file (G)
14604 .PP
14605 .RS 4
14606 This option can be set to a file with Diffie\-Hellman parameters which will be used with DH ciphers\&.
14607 .sp
14608 This path is relative to
14609 \m[blue]\fBprivate dir\fR\m[]
14610 if the path does not start with a /\&.
14611 .sp
14612 Default:
14613 \fI\fItls dh params file\fR\fR\fI = \fR\fI\fR\fI \fR
14614 .RE
14615
14616 tls enabled (G)
14617 .PP
14618 .RS 4
14619 If this option is set to
14620 \fByes\fR, then Samba will use TLS when possible in communication\&.
14621 .sp
14622 Default:
14623 \fI\fItls enabled\fR\fR\fI = \fR\fIyes\fR\fI \fR
14624 .RE
14625
14626 tls keyfile (G)
14627 .PP
14628 .RS 4
14629 This option can be set to a file (PEM format) containing the RSA private key\&. This file must be accessible without a pass\-phrase, i\&.e\&. it must not be encrypted\&.
14630 .sp
14631 This path is relative to
14632 \m[blue]\fBprivate dir\fR\m[]
14633 if the path does not start with a /\&.
14634 .sp
14635 Default:
14636 \fI\fItls keyfile\fR\fR\fI = \fR\fItls/key\&.pem\fR\fI \fR
14637 .RE
14638
14639 tls priority (G)
14640 .PP
14641 .RS 4
14642 This option can be set to a string describing the TLS protocols to be supported in the parts of Samba that use GnuTLS, specifically the AD DC\&.
14643 .sp
14644 The string is appended to the default priority list of GnuTLS\&.
14645 .sp
14646 The valid options are described in the
14647 GNUTLS Priority\-Strings documentation at http://gnutls\&.org/manual/html_node/Priority\-Strings\&.html
14648 .sp
14649 The SSL3\&.0 protocol will be disabled\&.
14650 .sp
14651 Default:
14652 \fI\fItls priority\fR\fR\fI = \fR\fINORMAL:\-VERS\-SSL3\&.0\fR\fI \fR
14653 .RE
14654
14655 tls trust system cas (G)
14656 .PP
14657 .RS 4
14658 With this option the system\*(Aqs default trusted CAs are used to trust SSL/TLS connections\&.
14659 .sp
14660 Please use this with care, as it really means trusting all CAs installed on the system!
14661 .sp
14662 Default:
14663 \fI\fItls trust system cas\fR\fR\fI = \fR\fIno\fR\fI \fR
14664 .RE
14665
14666 tls verify peer (G)
14667 .PP
14668 .RS 4
14669 This controls if and how strict the client will verify the peer\*(Aqs certificate and name\&. Possible values are (in increasing order):
14670 \fBno_check\fR,
14671 \fBca_only\fR,
14672 \fBca_and_name_if_available\fR,
14673 \fBca_and_name\fR
14674 and
14675 \fBas_strict_as_possible\fR\&.
14676 .sp
14677 When set to
14678 \fBno_check\fR
14679 the certificate is not verified at all, which allows trivial man in the middle attacks\&.
14680 .sp
14681 When set to
14682 \fBca_only\fR
14683 the certificate is verified to be signed from a ca specified in the
14684 \m[blue]\fBtls ca file\fR\m[]
14685 option\&. As alternative
14686 \m[blue]\fBtls ca directories\fR\m[]
14687 or
14688 \m[blue]\fBtls trust system cas\fR\m[]
14689 can be used\&. Providing at least one valid CA certificate is required\&. The certificate lifetime is also verified\&. If the
14690 \m[blue]\fBtls crl file\fR\m[]
14691 option is configured, the certificate is also verified against the ca crl\&.
14692 .sp
14693 When set to
14694 \fBca_and_name_if_available\fR
14695 all checks from
14696 \fBca_only\fR
14697 are performed\&. In addition, the peer hostname is verified against the certificate\*(Aqs name, if it is provided by the application layer and not given as an ip address string\&.
14698 .sp
14699 When set to
14700 \fBca_and_name\fR
14701 all checks from
14702 \fBca_and_name_if_available\fR
14703 are performed\&. In addition the peer hostname needs to be provided and even an ip address is checked against the certificate\*(Aqs name\&.
14704 .sp
14705 When set to
14706 \fBas_strict_as_possible\fR
14707 all checks from
14708 \fBca_and_name\fR
14709 are performed\&. In addition the
14710 \m[blue]\fBtls crl file\fR\m[]
14711 needs to be configured\&. Future versions of Samba may implement additional checks\&.
14712 .sp
14713 Default:
14714 \fI\fItls verify peer\fR\fR\fI = \fR\fIas_strict_as_possible\fR\fI \fR
14715 .RE
14716
14717 unicode (G)
14718 .PP
14719 .RS 4
14720 Specifies whether the server and client should support unicode\&.
14721 .sp
14722 If this option is set to false, the use of ASCII will be forced\&.
14723 .sp
14724 Default:
14725 \fI\fIunicode\fR\fR\fI = \fR\fIyes\fR\fI \fR
14726 .RE
14727
14728 unix charset (G)
14729 .PP
14730 .RS 4
14731 Specifies the charset the unix machine Samba runs on uses\&. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use\&.
14732 .sp
14733 This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
14734 .sp
14735 Default:
14736 \fI\fIunix charset\fR\fR\fI = \fR\fIUTF\-8\fR\fI \fR
14737 .sp
14738 Example:
14739 \fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR
14740 .RE
14741
14742 unix password sync (G)
14743 .PP
14744 .RS 4
14745 This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed\&. If this is set to
14746 \fByes\fR
14747 the program specified in the
14748 \fIpasswd program\fR
14749 parameter is called
14750 \fIAS ROOT\fR
14751 \- to allow the new UNIX password to be set without access to the old UNIX password (as the SMB password change code has no access to the old password cleartext, only the new)\&.
14752 .sp
14753 This option has no effect if
14754 samba
14755 is running as an active directory domain controller, in that case have a look at the
14756 \m[blue]\fBpassword hash gpg key ids\fR\m[]
14757 option and the
14758 samba\-tool user syncpasswords
14759 command\&.
14760 .sp
14761 Default:
14762 \fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR
14763 .RE
14764
14765 use client driver (S)
14766 .PP
14767 .RS 4
14768 This parameter applies only to Windows NT/2000 clients\&. It has no effect on Windows 95/98/ME clients\&. When serving a printer to Windows NT/2000 clients without first installing a valid printer driver on the Samba host, the client will be required to install a local printer driver\&. From this point on, the client will treat the print as a local printer and not a network printer connection\&. This is much the same behavior that will occur when
14769 disable spoolss = yes\&.
14770 .sp
14771 The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS\-RPC\&. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user\&. If the user possesses local administrator rights but not root privilege on the Samba host (often the case), the OpenPrinterEx() call will fail\&. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though jobs may successfully be printed)\&.
14772 .sp
14773 If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead\&. Thus allowing the OpenPrinterEx() call to succeed\&.
14774 \fIThis parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server\&.\fR
14775 .sp
14776 Default:
14777 \fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR
14778 .RE
14779
14780 use mmap (G)
14781 .PP
14782 .RS 4
14783 This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system\&. Samba requires a coherent mmap/read\-write system memory cache\&. Currently only OpenBSD and HPUX do not have such a coherent cache, and on those platforms this parameter is overridden internally to be effectively
14784 \fBno\fR\&. On all systems this parameter should be left alone\&. This parameter is provided to help the Samba developers track down problems with the tdb internal code\&.
14785 .sp
14786 Default:
14787 \fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR
14788 .RE
14789
14790 username level (G)
14791 .PP
14792 .RS 4
14793 This option helps Samba to try and \*(Aqguess\*(Aq at the real UNIX username, as many DOS clients send an all\-uppercase username\&. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine\&.
14794 .sp
14795 If this parameter is set to non\-zero the behavior changes\&. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name\&. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be\&. Use this parameter when you have strange usernames on your UNIX machine, such as
14796 \fBAstrangeUser \fR\&.
14797 .sp
14798 This parameter is needed only on UNIX systems that have case sensitive usernames\&.
14799 .sp
14800 Default:
14801 \fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR
14802 .sp
14803 Example:
14804 \fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR
14805 .RE
14806
14807 username map (G)
14808 .PP
14809 .RS 4
14810 This option allows you to specify a file containing a mapping of usernames from the clients to the server\&. This can be used for several purposes\&. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses\&. The other is to map multiple users to a single username so that they can more easily share files\&.
14811 .sp
14812 Please note that for user mode security, the username map is applied prior to validating the user credentials\&. Domain member servers (domain or ads) apply the username map after the user has been successfully authenticated by the domain controller and require fully qualified entries in the map table (e\&.g\&. biddle =
14813 DOMAIN\efoo)\&.
14814 .sp
14815 The map file is parsed line by line\&. Each line should contain a single UNIX username on the left then a \*(Aq=\*(Aq followed by a list of usernames on the right\&. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group\&. The special client name \*(Aq*\*(Aq is a wildcard and matches any name\&. Each line of the map file may be up to 1023 characters long\&.
14816 .sp
14817 The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the \*(Aq=\*(Aq signs\&. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left\&. Processing then continues with the next line\&.
14818 .sp
14819 If any line begins with a \*(Aq#\*(Aq or a \*(Aq;\*(Aq then it is ignored\&.
14820 .sp
14821 If any line begins with an \*(Aq!\*(Aq then the processing will stop after that line if a mapping was done by the line\&. Otherwise mapping continues with every line being processed\&. Using \*(Aq!\*(Aq is most useful when you have a wildcard mapping line later in the file\&.
14822 .sp
14823 For example to map from the name
14824 \fBadmin\fR
14825 or
14826 \fBadministrator\fR
14827 to the UNIX name
14828 \fB root\fR
14829 you would use:
14830 .sp
14831 .if n \{\
14832 .RS 4
14833 .\}
14834 .nf
14835 root = admin administrator
14836 .fi
14837 .if n \{\
14838 .RE
14839 .\}
14840 .sp
14841 Or to map anyone in the UNIX group
14842 \fBsystem\fR
14843 to the UNIX name
14844 \fBsys\fR
14845 you would use:
14846 .sp
14847 .if n \{\
14848 .RS 4
14849 .\}
14850 .nf
14851 sys = @system
14852 .fi
14853 .if n \{\
14854 .RE
14855 .\}
14856 .sp
14857 You can have as many mappings as you like in a username map file\&.
14858 .sp
14859 If your system supports the NIS NETGROUP option then the netgroup database is checked before the
14860 /etc/group
14861 database for matching groups\&.
14862 .sp
14863 You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
14864 .sp
14865 .if n \{\
14866 .RS 4
14867 .\}
14868 .nf
14869 tridge = "Andrew Tridgell"
14870 .fi
14871 .if n \{\
14872 .RE
14873 .\}
14874 .sp
14875 would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
14876 .sp
14877 The following example would map mary and fred to the unix user sys, and map the rest to guest\&. Note the use of the \*(Aq!\*(Aq to tell Samba to stop processing if it gets a match on that line:
14878 .sp
14879 .if n \{\
14880 .RS 4
14881 .\}
14882 .nf
14883 !sys = mary fred
14884 guest = *
14885 .fi
14886 .if n \{\
14887 .RE
14888 .\}
14889 .sp
14890 Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
14891 \fBfred\fR
14892 is remapped to
14893 \fBmary\fR
14894 then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for
14895 \fBmary\fR
14896 not
14897 \fBfred\fR\&. The only exception to this is the username passed to a Domain Controller (if you have one)\&. The DC will receive whatever username the client supplies without modification\&.
14898 .sp
14899 Also note that no reverse mapping is done\&. The main effect this has is with printing\&. Users who have been mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don\*(Aqt own the print job\&.
14900 .sp
14901 Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
14902 DOMAIN\euser) from the username map when performing a kerberos login from a client\&. However, when looking up a map entry for a user authenticated by NTLM[SSP], only the login name would be used for matches\&. This resulted in inconsistent behavior sometimes even on the same server\&.
14903 .sp
14904 The following functionality is obeyed in version 3\&.0\&.8 and later:
14905 .sp
14906 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
14907 .sp
14908 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
14909 DOMAIN\euser) only after the user has been successfully authenticated\&.
14910 .sp
14911 An example of use is:
14912 .sp
14913 .if n \{\
14914 .RS 4
14915 .\}
14916 .nf
14917 username map = /usr/local/samba/lib/users\&.map
14918 .fi
14919 .if n \{\
14920 .RE
14921 .\}
14922 .sp
14923 Default:
14924 \fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR
14925 .RE
14926
14927 username map cache time (G)
14928 .PP
14929 .RS 4
14930 Mapping usernames with the
14931 \m[blue]\fBusername map\fR\m[]
14932 or
14933 \m[blue]\fBusername map script\fR\m[]
14934 features of Samba can be relatively expensive\&. During login of a user, the mapping is done several times\&. In particular, calling the
14935 \m[blue]\fBusername map script\fR\m[]
14936 can slow down logins if external databases have to be queried from the script being called\&.
14937 .sp
14938 The parameter
14939 \m[blue]\fBusername map cache time\fR\m[]
14940 controls a mapping cache\&. It specifies the number of seconds a mapping from the username map file or script is to be efficiently cached\&. The default of 0 means no caching is done\&.
14941 .sp
14942 Default:
14943 \fI\fIusername map cache time\fR\fR\fI = \fR\fI0\fR\fI \fR
14944 .sp
14945 Example:
14946 \fI\fIusername map cache time\fR\fR\fI = \fR\fI60\fR\fI \fR
14947 .RE
14948
14949 username map script (G)
14950 .PP
14951 .RS 4
14952 This script is a mutually exclusive alternative to the
14953 \m[blue]\fBusername map\fR\m[]
14954 parameter\&. This parameter specifies an external program or script that must accept a single command line option (the username transmitted in the authentication request) and return a line on standard output (the name to which the account should mapped)\&. In this way, it is possible to store username map tables in an LDAP directory services\&.
14955 .sp
14956 Default:
14957 \fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR
14958 .sp
14959 Example:
14960 \fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\&.sh\fR\fI \fR
14961 .RE
14962
14963 usershare allow guests (G)
14964 .PP
14965 .RS 4
14966 This parameter controls whether user defined shares are allowed to be accessed by non\-authenticated users or not\&. It is the equivalent of allowing people who can create a share the option of setting
14967 \fIguest ok = yes\fR
14968 in a share definition\&. Due to its security sensitive nature, the default is set to off\&.
14969 .sp
14970 Default:
14971 \fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR
14972 .RE
14973
14974 usershare max shares (G)
14975 .PP
14976 .RS 4
14977 This parameter specifies the number of user defined shares that are allowed to be created by users belonging to the group owning the usershare directory\&. If set to zero (the default) user defined shares are ignored\&.
14978 .sp
14979 Default:
14980 \fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR
14981 .RE
14982
14983 usershare owner only (G)
14984 .PP
14985 .RS 4
14986 This parameter controls whether the pathname exported by a user defined shares must be owned by the user creating the user defined share or not\&. If set to True (the default) then smbd checks that the directory path being shared is owned by the user who owns the usershare file defining this share and refuses to create the share if not\&. If set to False then no such check is performed and any directory path may be exported regardless of who owns it\&.
14987 .sp
14988 Default:
14989 \fI\fIusershare owner only\fR\fR\fI = \fR\fIyes\fR\fI \fR
14990 .RE
14991
14992 usershare path (G)
14993 .PP
14994 .RS 4
14995 This parameter specifies the absolute path of the directory on the filesystem used to store the user defined share definition files\&. This directory must be owned by root, and have no access for other, and be writable only by the group owner\&. In addition the "sticky" bit must also be set, restricting rename and delete to owners of a file (in the same way the /tmp directory is usually configured)\&. Members of the group owner of this directory are the users allowed to create usershares\&.
14996 .sp
14997 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
14998 .sp
14999 .if n \{\
15000 .RS 4
15001 .\}
15002 .nf
15003 ls \-ld /usr/local/samba/lib/usershares/
15004 drwxrwx\-\-T 2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
15005
15006 .fi
15007 .if n \{\
15008 .RE
15009 .\}
15010 .sp
15011 In this case, only members of the group "power_users" can create user defined shares\&.
15012 .sp
15013 Default:
15014 \fI\fIusershare path\fR\fR\fI = \fR\fI/var/lib/samba/usershares\fR\fI \fR
15015 .RE
15016
15017 usershare prefix allow list (G)
15018 .PP
15019 .RS 4
15020 This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions\&. If the pathname to be exported doesn\*(Aqt start with one of the strings in this list, the user defined share will not be allowed\&. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\&.
15021 .sp
15022 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\&.
15023 .sp
15024 Default:
15025 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\fR\fI \fR
15026 .sp
15027 Example:
15028 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR
15029 .RE
15030
15031 usershare prefix deny list (G)
15032 .PP
15033 .RS 4
15034 This parameter specifies a list of absolute pathnames the root of which are NOT allowed to be exported by user defined share definitions\&. If the pathname exported starts with one of the strings in this list the user defined share will not be allowed\&. Any pathname not starting with one of these strings will be allowed to be exported as a usershare\&. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares\&.
15035 .sp
15036 If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation\&.
15037 .sp
15038 Default:
15039 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\fR\fI \fR
15040 .sp
15041 Example:
15042 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR
15043 .RE
15044
15045 usershare template share (G)
15046 .PP
15047 .RS 4
15048 User defined shares only have limited possible parameters such as path, guest ok, etc\&. This parameter allows usershares to "cloned" from an existing share\&. If "usershare template share" is set to the name of an existing share, then all usershares created have their defaults set from the parameters set on this share\&.
15049 .sp
15050 The target share may be set to be invalid for real file sharing by setting the parameter "\-valid = False" on the template share definition\&. This causes it not to be seen as a real exported share but to be able to be used as a template for usershares\&.
15051 .sp
15052 Default:
15053 \fI\fIusershare template share\fR\fR\fI = \fR\fI\fR\fI \fR
15054 .sp
15055 Example:
15056 \fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR
15057 .RE
15058
15059 use sendfile (S)
15060 .PP
15061 .RS 4
15062 If this parameter is
15063 \fByes\fR, and the
15064 \fBsendfile()\fR
15065 system call is supported by the underlying operating system, then some SMB read calls (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that are exclusively oplocked\&. This may make more efficient use of the system CPU\*(Aqs and cause Samba to be faster\&. Samba automatically turns this off for clients that use protocol levels lower than NT LM 0\&.12 and when it detects a client is Windows 9x (using sendfile from Linux will cause these clients to fail)\&.
15066 .sp
15067 Default:
15068 \fI\fIuse sendfile\fR\fR\fI = \fR\fIno\fR\fI \fR
15069 .RE
15070
15071 utmp (G)
15072 .PP
15073 .RS 4
15074 This boolean parameter is only available if Samba has been configured and compiled with the option
15075 \-\-with\-utmp\&. If set to
15076 \fByes\fR
15077 then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server\&. Sites may use this to record the user connecting to a Samba share\&.
15078 .sp
15079 Due to the requirements of the utmp record, we are required to create a unique identifier for the incoming user\&. Enabling this option creates an n^2 algorithm to find this number\&. This may impede performance on large installations\&.
15080 .sp
15081 Default:
15082 \fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR
15083 .RE
15084
15085 utmp directory (G)
15086 .PP
15087 .RS 4
15088 This parameter is only available if Samba has been configured and compiled with the option
15089 \-\-with\-utmp\&. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that record user connections to a Samba server\&. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
15090 /var/run/utmp
15091 on Linux)\&.
15092 .sp
15093 Default:
15094 \fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR
15095 .sp
15096 Example:
15097 \fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR
15098 .RE
15099
15100 \-valid (S)
15101 .PP
15102 .RS 4
15103 This parameter indicates whether a share is valid and thus can be used\&. When this parameter is set to false, the share will be in no way visible nor accessible\&.
15104 .sp
15105 This option should not be used by regular users but might be of help to developers\&. Samba uses this option internally to mark shares as deleted\&.
15106 .sp
15107 Default:
15108 \fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR
15109 .RE
15110
15111 valid users (S)
15112 .PP
15113 .RS 4
15114 This is a list of users that should be allowed to login to this service\&. Names starting with \*(Aq@\*(Aq, \*(Aq+\*(Aq and \*(Aq&\*(Aq are interpreted using the same rules as described in the
15115 \fIinvalid users\fR
15116 parameter\&.
15117 .sp
15118 If this is empty (the default) then any user can login\&. If a username is in both this list and the
15119 \fIinvalid users\fR
15120 list then access is denied for that user\&.
15121 .sp
15122 The current servicename is substituted for
15123 \fI%S\fR\&. This is useful in the [homes] section\&.
15124 .sp
15125 \fINote: \fRWhen used in the [global] section this parameter may have unwanted side effects\&. For example: If samba is configured as a MASTER BROWSER (see
15126 \fIlocal master\fR,
15127 \fIos level\fR,
15128 \fIdomain master\fR,
15129 \fIpreferred master\fR) this option will prevent workstations from being able to browse the network\&.
15130 .sp
15131 Default:
15132 \fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR
15133 .sp
15134 Example:
15135 \fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR
15136 .RE
15137
15138 veto files (S)
15139 .PP
15140 .RS 4
15141 This is a list of files and directories that are neither visible nor accessible\&. Each entry in the list must be separated by a \*(Aq/\*(Aq, which allows spaces to be included in the entry\&. \*(Aq*\*(Aq and \*(Aq?\*(Aq can be used to specify multiple files or directories as in DOS wildcards\&.
15142 .sp
15143 \m[blue]\fBveto files\fR\m[]
15144 can also be used as a parametric option where NAME in
15145 .sp
15146 veto files : NAME =
15147 .sp
15148 specifies a user or group name with the same syntax as
15149 \m[blue]\fBvalid users\fR\m[]\&. This parametric form can be specified multiple times for different users or groups\&. This means that "veto files : NAME" set both in the [global] and the share section add up, whereas normally options set in a share section overwrite the default in the [global] section\&.
15150 .sp
15151 Each filename must be a unix path, not a DOS path and must
15152 \fInot\fR
15153 include the unix directory separator \*(Aq/\*(Aq\&.
15154 .sp
15155 Note that the
15156 \m[blue]\fBcase sensitive\fR\m[]
15157 option is applicable in vetoing files\&.
15158 .sp
15159 One feature of the veto files parameter that it is important to be aware of is Samba\*(Aqs behaviour when trying to delete a directory\&. If a directory that is to be deleted contains nothing but veto files this deletion will
15160 \fIfail\fR
15161 unless you also set the
15162 \m[blue]\fBdelete veto files\fR\m[]
15163 parameter to
15164 \fIyes\fR\&.
15165 .sp
15166 Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned\&.
15167 .sp
15168 Examples of use include:
15169 .sp
15170 .if n \{\
15171 .RS 4
15172 .\}
15173 .nf
15174 ; Veto any files containing the word Security,
15175 ; any ending in \&.tmp, and any directory containing the
15176 ; word root\&.
15177 veto files = /*Security*/*\&.tmp/*root*/
15178
15179 ; Veto some files for anyone and some files for specific users and groups
15180 veto files = /vetoforall1/
15181 veto files : USER = /vetotoforuser/
15182 veto files : GROUP = /vetoforgroup/
15183 veto files : UNIVERSITY\eAlumnis = /somefile\&.txt/
15184 veto files : john@university\&.org = /anotherfile\&.txt/
15185 veto files : S\-1\-5\-21\-123\-456\-789\-1000 = /secretfile\&.txt/
15186
15187 ; Veto the Apple specific files that a NetAtalk server
15188 ; creates\&.
15189 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
15190 .fi
15191 .if n \{\
15192 .RE
15193 .\}
15194 .sp
15195 Default:
15196 \fI\fIveto files\fR\fR\fI = \fR\fI # No files or directories are vetoed\fR\fI \fR
15197 .RE
15198
15199 veto oplock files (S)
15200 .PP
15201 .RS 4
15202 This parameter is only valid when the
15203 \m[blue]\fBoplocks\fR\m[]
15204 parameter is turned on for a share\&. It allows the Samba administrator to selectively turn off the granting of oplocks on selected files that match a wildcarded list, similar to the wildcarded list used in the
15205 \m[blue]\fBveto files\fR\m[]
15206 parameter\&.
15207 .sp
15208 You might want to do this on files that you know will be heavily contended for by clients\&. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in
15209 \&.SEM\&. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share\&.
15210 .sp
15211 An example of use is:
15212 .sp
15213 .if n \{\
15214 .RS 4
15215 .\}
15216 .nf
15217 veto oplock files = /\&.*SEM/
15218 .fi
15219 .if n \{\
15220 .RE
15221 .\}
15222 .sp
15223 Default:
15224 \fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR
15225 .RE
15226
15227 vfs mkdir use tmp name (S)
15228 .PP
15229 .RS 4
15230 Creating a new directory for an SMB client is a very complex task! It includes things like inheriting permissions from the parent directory and storing DOS attributes\&.
15231 .sp
15232 Other clients should not see the existence of the directory that is in progress of being created!
15233 .sp
15234 This option is an enumerated type that controls the usage of a temporary directory name\&. When this is set to
15235 \fByes\fR, the directory name will be prefixed with \*(Aq\&.::TMPNAME:D:$SERVERID:\*(Aq (where $SERVERID is a unique identifier for the current process)\&.
15236 .sp
15237 When this option is set to Auto (the default), the server uses a temporary directory name if, at least, one of the following options is effectively not set to
15238 \fBno\fR:
15239 \m[blue]\fBinherit acls\fR\m[],
15240 \m[blue]\fBinherit owner\fR\m[],
15241 \m[blue]\fBinherit permissions\fR\m[],
15242 \m[blue]\fBnt acl support\fR\m[]
15243 or
15244 \m[blue]\fBstore dos attributes\fR\m[]\&. Note on OpenBSD Auto (the default) is mapped to
15245 \fBno\fR, see
15246 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15801\&.
15247 .sp
15248 A re\-export of an SMB/CIFS mount might one rare case where
15249 vfs mkdir use tmp name = no
15250 could be useful\&.
15251 .sp
15252 In most cases
15253 vfs mkdir use tmp name = Auto
15254 should be kept\&.
15255 .sp
15256 Default:
15257 \fI\fIvfs mkdir use tmp name\fR\fR\fI = \fR\fIAuto\fR\fI \fR
15258 .RE
15259
15260 vfs object
15261 .PP
15262 .RS 4
15263 This parameter is a synonym for
15264 vfs objects\&.
15265 .RE
15266
15267 vfs objects (S)
15268 .PP
15269 .RS 4
15270 This parameter specifies the backend names which are used for Samba VFS I/O operations\&. By default, normal disk I/O operations are used but these can be overloaded with one or more VFS objects\&. Be aware that the definition of this parameter will overwrite a possible previous definition of the vfs objects parameter\&.
15271 .sp
15272 Default:
15273 \fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR
15274 .sp
15275 Example:
15276 \fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR
15277 .RE
15278
15279 volume (S)
15280 .PP
15281 .RS 4
15282 This allows you to override the volume label returned for a share\&. Useful for CDROMs with installation programs that insist on a particular volume label\&.
15283 .sp
15284 Default:
15285 \fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR
15286 .RE
15287
15288 volume serial number (S)
15289 .PP
15290 .RS 4
15291 This allows to override the volume serial number (a 32bit value) reported for a share\&.
15292 .sp
15293 The special value
15294 \fI\-1\fR
15295 (default) stands for a unique number that is calculated for each share\&.
15296 .sp
15297 Default:
15298 \fI\fIvolume serial number\fR\fR\fI = \fR\fI\-1\fR\fI \fR
15299 .sp
15300 Example:
15301 \fI\fIvolume serial number\fR\fR\fI = \fR\fI0xabcdefgh\fR\fI \fR
15302 .RE
15303
15304 wide links (S)
15305 .PP
15306 .RS 4
15307 This parameter controls whether or not links in the UNIX file system may be followed by the server\&. Links that point to areas within the directory tree exported by the server are always allowed; this parameter controls access only to areas that are outside the directory tree being exported\&.
15308 .sp
15309 Note: Turning this parameter on when UNIX extensions are enabled will allow UNIX clients to create symbolic links on the share that can point to files or directories outside restricted path exported by the share definition\&. This can cause access to areas outside of the share\&. Due to this problem, this parameter will be automatically disabled (with a message in the log file) if the
15310 \m[blue]\fBunix extensions\fR\m[]
15311 option is on\&.
15312 .sp
15313 See the parameter
15314 \m[blue]\fBallow insecure wide links\fR\m[]
15315 if you wish to change this coupling between the two parameters\&.
15316 .sp
15317 Default:
15318 \fI\fIwide links\fR\fR\fI = \fR\fIno\fR\fI \fR
15319 .RE
15320
15321 winbind cache time (G)
15322 .PP
15323 .RS 4
15324 This parameter specifies the number of seconds the
15325 \fBwinbindd\fR(8)
15326 daemon will cache user and group information before querying a Windows NT server again\&.
15327 .sp
15328 This does not apply to authentication requests, these are always evaluated in real time unless the
15329 \m[blue]\fBwinbind offline logon\fR\m[]
15330 option has been enabled\&.
15331 .sp
15332 Default:
15333 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR
15334 .RE
15335
15336 winbindd socket directory (G)
15337 .PP
15338 .RS 4
15339 This setting controls the location of the winbind daemon\*(Aqs socket\&.
15340 .sp
15341 Except within automated test scripts, this should not be altered, as the client tools (nss_winbind etc) do not honour this parameter\&. Client tools must then be advised of the altered path with the WINBINDD_SOCKET_DIR environment variable\&.
15342 .sp
15343 Default:
15344 \fI\fIwinbindd socket directory\fR\fR\fI = \fR\fI/run/samba/winbindd\fR\fI \fR
15345 .RE
15346
15347 winbind enum groups (G)
15348 .PP
15349 .RS 4
15350 On large installations using
15351 \fBwinbindd\fR(8)
15352 it may be necessary to suppress the enumeration of groups through the
15353 setgrent(),
15354 getgrent()
15355 and
15356 endgrent()
15357 group of system calls\&. If the
15358 \fIwinbind enum groups\fR
15359 parameter is
15360 \fBno\fR, calls to the
15361 getgrent()
15362 system call will not return any data\&.
15363 .if n \{\
15364 .sp
15365 .\}
15366 .RS 4
15367 .it 1 an-trap
15368 .nr an-no-space-flag 1
15369 .nr an-break-flag 1
15370 .br
15371 .ps +1
15372 \fBWarning\fR
15373 .ps -1
15374 .br
15375 Turning off group enumeration may cause some programs to behave oddly\&.
15376 .sp .5v
15377 .RE
15378 Default:
15379 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR
15380 .RE
15381
15382 winbind enum users (G)
15383 .PP
15384 .RS 4
15385 On large installations using
15386 \fBwinbindd\fR(8)
15387 it may be necessary to suppress the enumeration of users through the
15388 setpwent(),
15389 getpwent()
15390 and
15391 endpwent()
15392 group of system calls\&. If the
15393 \fIwinbind enum users\fR
15394 parameter is
15395 \fBno\fR, calls to the
15396 getpwent
15397 system call will not return any data\&.
15398 .if n \{\
15399 .sp
15400 .\}
15401 .RS 4
15402 .it 1 an-trap
15403 .nr an-no-space-flag 1
15404 .nr an-break-flag 1
15405 .br
15406 .ps +1
15407 \fBWarning\fR
15408 .ps -1
15409 .br
15410 Turning off user enumeration may cause some programs to behave oddly\&. For example, the finger program relies on having access to the full user list when searching for matching usernames\&.
15411 .sp .5v
15412 .RE
15413 Default:
15414 \fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR
15415 .RE
15416
15417 winbind expand groups (G)
15418 .PP
15419 .RS 4
15420 This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the
15421 \m[blue]\fBwinbind nested groups\fR\m[]
15422 option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.
15423 .sp
15424 This option also affects the return of non nested group memberships of Windows domain users\&. With the new default "winbind expand groups = 0" winbind does not query group memberships at all\&.
15425 .sp
15426 Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time\&.
15427 .sp
15428 The default value was changed from 1 to 0 with Samba 4\&.2\&. Some broken applications (including some implementations of newgrp and sg) calculate the group memberships of users by traversing groups, such applications will require "winbind expand groups = 1"\&. But the new default makes winbindd more reliable as it doesn\*(Aqt require SAMR access to domain controllers of trusted domains\&.
15429 .sp
15430 Default:
15431 \fI\fIwinbind expand groups\fR\fR\fI = \fR\fI0\fR\fI \fR
15432 .RE
15433
15434 winbind:ignore domains (G)
15435 .PP
15436 .RS 4
15437 Allows one to enter a list of trusted domains winbind should ignore (untrust)\&. This can avoid the overhead of resources from attempting to login to DCs that should not be communicated with\&.
15438 .sp
15439 Default:
15440 \fI\fIwinbind:ignore domains\fR\fR\fI = \fR\fI\fR\fI \fR
15441 .sp
15442 Example:
15443 \fI\fIwinbind:ignore domains\fR\fR\fI = \fR\fIDOMAIN1, DOMAIN2\fR\fI \fR
15444 .RE
15445
15446 winbind max clients (G)
15447 .PP
15448 .RS 4
15449 This parameter specifies the maximum number of clients the
15450 \fBwinbindd\fR(8)
15451 daemon can connect with\&. The parameter is not a hard limit\&. The
15452 \fBwinbindd\fR(8)
15453 daemon configures itself to be able to accept at least that many connections, and if the limit is reached, an attempt is made to disconnect idle clients\&.
15454 .sp
15455 Default:
15456 \fI\fIwinbind max clients\fR\fR\fI = \fR\fI200\fR\fI \fR
15457 .RE
15458
15459 winbind max domain connections (G)
15460 .PP
15461 .RS 4
15462 This parameter specifies the maximum number of simultaneous connections that the
15463 \fBwinbindd\fR(8)
15464 daemon should open to the domain controller of one domain\&. Setting this parameter to a value greater than 1 can improve scalability with many simultaneous winbind requests, some of which might be slow\&. Changing this value requires a restart of winbindd\&.
15465 .sp
15466 Note that if
15467 \m[blue]\fBwinbind offline logon\fR\m[]
15468 is set to
15469 \fBYes\fR, then only one DC connection is allowed per domain, regardless of this setting\&.
15470 .sp
15471 Default:
15472 \fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI1\fR\fI \fR
15473 .sp
15474 Example:
15475 \fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI10\fR\fI \fR
15476 .RE
15477
15478 winbind nested groups (G)
15479 .PP
15480 .RS 4
15481 If set to yes, this parameter activates the support for nested groups\&. Nested groups are also called local groups or aliases\&. They work like their counterparts in Windows: Nested groups are defined locally on any machine (they are shared between DC\*(Aqs through their SAM) and can contain users and global groups from any trusted SAM\&. To be able to use nested groups, you need to run nss_winbind\&.
15482 .sp
15483 Default:
15484 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR
15485 .RE
15486
15487 winbind normalize names (G)
15488 .PP
15489 .RS 4
15490 This parameter controls whether winbindd will replace whitespace in user and group names with an underscore (_) character\&. For example, whether the name "Space Kadet" should be replaced with the string "space_kadet"\&. Frequently Unix shell scripts will have difficulty with usernames contains whitespace due to the default field separator in the shell\&. If your domain possesses names containing the underscore character, this option may cause problems unless the name aliasing feature is supported by your nss_info plugin\&.
15491 .sp
15492 This feature also enables the name aliasing API which can be used to make domain user and group names to a non\-qualified version\&. Please refer to the manpage for the configured idmap and nss_info plugin for the specifics on how to configure name aliasing for a specific configuration\&. Name aliasing takes precedence (and is mutually exclusive) over the whitespace replacement mechanism discussed previously\&.
15493 .sp
15494 Default:
15495 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR
15496 .sp
15497 Example:
15498 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR
15499 .RE
15500
15501 winbind nss info (G)
15502 .PP
15503 .RS 4
15504 This parameter is designed to control how Winbind retrieves Name Service Information to construct a user\*(Aqs home directory and login shell\&. Currently the following settings are available:
15505 .RS
15506 .sp
15507 .RS 4
15508 .ie n \{\
15509 \h'-04'\(bu\h'+03'\c
15510 .\}
15511 .el \{\
15512 .sp -1
15513 .IP \(bu 2.3
15514 .\}
15515 \fItemplate\fR
15516 \- The default, using the parameters of
15517 \fItemplate shell\fR
15518 and
15519 \fItemplate homedir\fR)
15520 .RE
15521 .sp
15522 .RS 4
15523 .ie n \{\
15524 \h'-04'\(bu\h'+03'\c
15525 .\}
15526 .el \{\
15527 .sp -1
15528 .IP \(bu 2.3
15529 .\}
15530 \fI<sfu | sfu20 | rfc2307 >\fR
15531 \- When Samba is running in security = ads and your Active Directory Domain Controller does support the Microsoft "Services for Unix" (SFU) LDAP schema, winbind can retrieve the login shell and the home directory attributes directly from your Directory Server\&. For SFU 3\&.0 or 3\&.5 simply choose "sfu", if you use SFU 2\&.0 please choose "sfu20"\&.
15532 .sp
15533 Note that for the idmap backend
15534 idmap_ad
15535 you need to configure those settings in the idmap configuration section\&. Make sure to consult the documentation of the idmap backend that you are using\&.
15536 .RE
15537 .sp
15538 .RE
15539 .sp
15540 Default:
15541 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR
15542 .sp
15543 Example:
15544 \fI\fIwinbind nss info\fR\fR\fI = \fR\fIsfu\fR\fI \fR
15545 .RE
15546
15547 winbind offline logon (G)
15548 .PP
15549 .RS 4
15550 This parameter is designed to control whether Winbind should allow one to login with the
15551 \fIpam_winbind\fR
15552 module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
15553 .sp
15554 Default:
15555 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIno\fR\fI \fR
15556 .sp
15557 Example:
15558 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIyes\fR\fI \fR
15559 .RE
15560
15561 winbind reconnect delay (G)
15562 .PP
15563 .RS 4
15564 This parameter specifies the number of seconds the
15565 \fBwinbindd\fR(8)
15566 daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable\&.
15567 .sp
15568 Default:
15569 \fI\fIwinbind reconnect delay\fR\fR\fI = \fR\fI30\fR\fI \fR
15570 .RE
15571
15572 winbind refresh tickets (G)
15573 .PP
15574 .RS 4
15575 This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
15576 \fIpam_winbind\fR
15577 module\&.
15578 .sp
15579 Default:
15580 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIno\fR\fI \fR
15581 .sp
15582 Example:
15583 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIyes\fR\fI \fR
15584 .RE
15585
15586 winbind request timeout (G)
15587 .PP
15588 .RS 4
15589 This parameter specifies the number of seconds the
15590 \fBwinbindd\fR(8)
15591 daemon will wait before disconnecting either a client connection with no outstanding requests (idle) or a client connection with a request that has remained outstanding (hung) for longer than this number of seconds\&.
15592 .sp
15593 Default:
15594 \fI\fIwinbind request timeout\fR\fR\fI = \fR\fI60\fR\fI \fR
15595 .RE
15596
15597 winbind rpc only (G)
15598 .PP
15599 .RS 4
15600 Setting this parameter to
15601 yes
15602 forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.
15603 .sp
15604 Default:
15605 \fI\fIwinbind rpc only\fR\fR\fI = \fR\fIno\fR\fI \fR
15606 .RE
15607
15608 winbind scan trusted domains (G)
15609 .PP
15610 .RS 4
15611 This option only takes effect when the
15612 \m[blue]\fBsecurity\fR\m[]
15613 option is set to
15614 \fBdomain\fR
15615 or
15616 \fBads\fR\&. If it is set to yes, winbindd periodically tries to scan for new trusted domains and adds them to a global list inside of winbindd\&. The list can be extracted with
15617 wbinfo \-\-trusted\-domains \-\-verbose\&. Setting it to yes matches the behaviour of Samba 4\&.7 and older\&.
15618 .sp
15619 The construction of that global list is not reliable and often incomplete in complex trust setups\&. In most situations the list is not needed any more for winbindd to operate correctly\&. E\&.g\&. for plain file serving via SMB using a simple idmap setup with
15620 \fBautorid\fR,
15621 \fBtdb\fR
15622 or
15623 \fBad\fR\&. However some more complex setups require the list, e\&.g\&. if you specify idmap backends for specific domains\&. Some pam_winbind setups may also require the global list\&.
15624 .sp
15625 If you have a setup that doesn\*(Aqt require the global list, you should set
15626 \m[blue]\fBwinbind scan trusted domains = no\fR\m[]\&.
15627 .sp
15628 Default:
15629 \fI\fIwinbind scan trusted domains\fR\fR\fI = \fR\fIno\fR\fI \fR
15630 .RE
15631
15632 winbind sealed pipes (G)
15633 .PP
15634 .RS 4
15635 This option controls whether any requests from winbindd to domain controllers pipe will be sealed\&. Disabling sealing can be useful for debugging purposes\&.
15636 .sp
15637 The behavior can be controlled per netbios domain by using \*(Aqwinbind sealed pipes:NETBIOSDOMAIN = no\*(Aq as option\&.
15638 .sp
15639 Default:
15640 \fI\fIwinbind sealed pipes\fR\fR\fI = \fR\fIyes\fR\fI \fR
15641 .RE
15642
15643 winbind separator (G)
15644 .PP
15645 .RS 4
15646 This parameter allows an admin to define the character used when listing a username of the form of
15647 \fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
15648 pam_winbind\&.so
15649 and
15650 nss_winbind\&.so
15651 modules for UNIX services\&.
15652 .sp
15653 Please note that setting this parameter to + causes problems with group membership at least on glibc systems, as the character + is used as a special character for NIS in /etc/group\&.
15654 .sp
15655 Default:
15656 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\e\fR\fI \fR
15657 .sp
15658 Example:
15659 \fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR
15660 .RE
15661
15662 winbind use default domain (G)
15663 .PP
15664 .RS 4
15665 This parameter specifies whether the
15666 \fBwinbindd\fR(8)
15667 daemon should operate on users without domain component in their username\&. Users without a domain component are treated as is part of the winbindd server\*(Aqs own domain\&. While this does not benefit Windows users, it makes SSH, FTP and e\-mail function in a way much closer to the way they would in a native unix system\&.
15668 .sp
15669 This option should be avoided if possible\&. It can cause confusion about responsibilities for a user or group\&. In many situations it is not clear whether winbind or /etc/passwd should be seen as authoritative for a user, likewise for groups\&.
15670 .sp
15671 Default:
15672 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR
15673 .sp
15674 Example:
15675 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR
15676 .RE
15677
15678 winbind use krb5 enterprise principals (G)
15679 .PP
15680 .RS 4
15681 winbindd is able to get kerberos tickets for pam_winbind with krb5_auth or wbinfo \-K/\-\-krb5auth=\&.
15682 .sp
15683 winbindd (at least on a domain member) is never be able to have a complete picture of the trust topology (which is managed by the DCs)\&. There might be uPNSuffixes and msDS\-SPNSuffixes values, which don\*(Aqt belong to any AD domain at all\&.
15684 .sp
15685 With
15686 \m[blue]\fBwinbind scan trusted domains = no\fR\m[]
15687 winbindd doesn\*(Aqt even get a complete picture of the topology\&.
15688 .sp
15689 It is not really required to know about the trust topology\&. We can just rely on the [K]DCs of our primary domain (e\&.g\&. PRIMARY\&.A\&.EXAMPLE\&.COM) and use enterprise principals e\&.g\&. upnfromB@B\&.EXAMPLE\&.COM@PRIMARY\&.A\&.EXAMPLE\&.COM and follow the WRONG_REALM referrals in order to find the correct DC\&. The final principal might be userfromB@INTERNALB\&.EXAMPLE\&.PRIVATE\&.
15690 .sp
15691 With
15692 \m[blue]\fBwinbind use krb5 enterprise principals = yes\fR\m[]
15693 winbindd enterprise principals will be used\&.
15694 .sp
15695 Default:
15696 \fI\fIwinbind use krb5 enterprise principals\fR\fR\fI = \fR\fIyes\fR\fI \fR
15697 .sp
15698 Example:
15699 \fI\fIwinbind use krb5 enterprise principals\fR\fR\fI = \fR\fIno\fR\fI \fR
15700 .RE
15701
15702 winbind varlink service (G)
15703 .PP
15704 .RS 4
15705 This setting controls whether
15706 \fBwinbind\fR(8)
15707 will listen for User/Group record lookup from
15708 \fBnss-systemd\fR(8)
15709 via Varlink, offering an alternative to nss_winbind\&.
15710 .sp
15711 For more information about User/Group record lookup via Varlink see https://systemd\&.io/USER_GROUP_API/ and
15712 \fBnss-systemd \fR(8)
15713 manpage\&.
15714 .sp
15715 .if n \{\
15716 .sp
15717 .\}
15718 .RS 4
15719 .it 1 an-trap
15720 .nr an-no-space-flag 1
15721 .nr an-break-flag 1
15722 .br
15723 .ps +1
15724 \fBWarning\fR
15725 .ps -1
15726 .br
15727 \fBSystemd\fR(1)
15728 versions prior 253 consider the default
15729 \m[blue]\fBwinbind separator\fR\m[]
15730 \*(Aq\e\*(Aq an unsafe character in the GetMemberhips reply\&. To workaround the issue it is recommended to set it to \*(Aq+\*(Aq for example\&.
15731 .sp .5v
15732 .RE
15733 .sp
15734 .if n \{\
15735 .sp
15736 .\}
15737 .RS 4
15738 .it 1 an-trap
15739 .nr an-no-space-flag 1
15740 .nr an-break-flag 1
15741 .br
15742 .ps +1
15743 \fBWarning\fR
15744 .ps -1
15745 .br
15746 This setting has no effect in platforms or distributions without
15747 \fBsystemd\fR(1)\&.
15748 .sp .5v
15749 .RE
15750 .sp
15751 Default:
15752 \fI\fIwinbind varlink service\fR\fR\fI = \fR\fIno\fR\fI \fR
15753 .RE
15754
15755 winsdb:local_owner (G)
15756 .PP
15757 .RS 4
15758 This specifies the address that is stored in the winsOwner attribute, of locally registered winsRecord\-objects\&. The default is to use the ip\-address of the first network interface\&.
15759 .sp
15760 \fINo default\fR
15761 .RE
15762
15763 winsdb:dbnosync (G)
15764 .PP
15765 .RS 4
15766 This parameter disables fsync() after changes of the WINS database\&.
15767 .sp
15768 Default:
15769 \fI\fIwinsdb:dbnosync\fR\fR\fI = \fR\fIno\fR\fI \fR
15770 .RE
15771
15772 wins hook (G)
15773 .PP
15774 .RS 4
15775 When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database\&. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS\&.
15776 .sp
15777 The wins hook parameter specifies the name of a script or executable that will be called as follows:
15778 .sp
15779 wins_hook operation name nametype ttl IP_list
15780 .RS
15781 .sp
15782 .RS 4
15783 .ie n \{\
15784 \h'-04'\(bu\h'+03'\c
15785 .\}
15786 .el \{\
15787 .sp -1
15788 .IP \(bu 2.3
15789 .\}
15790 The first argument is the operation and is one of "add", "delete", or "refresh"\&. In most cases the operation can be ignored as the rest of the parameters provide sufficient information\&. Note that "refresh" may sometimes be called when the name has not previously been added, in that case it should be treated as an add\&.
15791 .RE
15792 .sp
15793 .RS 4
15794 .ie n \{\
15795 \h'-04'\(bu\h'+03'\c
15796 .\}
15797 .el \{\
15798 .sp -1
15799 .IP \(bu 2.3
15800 .\}
15801 The second argument is the NetBIOS name\&. If the name is not a legal name then the wins hook is not called\&. Legal names contain only letters, digits, hyphens, underscores and periods\&.
15802 .RE
15803 .sp
15804 .RS 4
15805 .ie n \{\
15806 \h'-04'\(bu\h'+03'\c
15807 .\}
15808 .el \{\
15809 .sp -1
15810 .IP \(bu 2.3
15811 .\}
15812 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
15813 .RE
15814 .sp
15815 .RS 4
15816 .ie n \{\
15817 \h'-04'\(bu\h'+03'\c
15818 .\}
15819 .el \{\
15820 .sp -1
15821 .IP \(bu 2.3
15822 .\}
15823 The fourth argument is the TTL (time to live) for the name in seconds\&.
15824 .RE
15825 .sp
15826 .RS 4
15827 .ie n \{\
15828 \h'-04'\(bu\h'+03'\c
15829 .\}
15830 .el \{\
15831 .sp -1
15832 .IP \(bu 2.3
15833 .\}
15834 The fifth and subsequent arguments are the IP addresses currently registered for that name\&. If this list is empty then the name should be deleted\&.
15835 .RE
15836 .sp
15837 .RE
15838 An example script that calls the BIND dynamic DNS update program
15839 nsupdate
15840 is provided in the examples directory of the Samba source code\&.
15841 .sp
15842 \fINo default\fR
15843 .RE
15844
15845 wins proxy (G)
15846 .PP
15847 .RS 4
15848 This is a boolean that controls if
15849 \fBnmbd\fR(8)
15850 will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
15851 \fByes\fR
15852 for some older clients\&.
15853 .sp
15854 Default:
15855 \fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR
15856 .RE
15857
15858 wins server (G)
15859 .PP
15860 .RS 4
15861 This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
15862 \fBnmbd\fR(8)
15863 should register with\&. If you have a WINS server on your network then you should set this to the WINS server\*(Aqs IP\&.
15864 .sp
15865 You should point this at your WINS server if you have a multi\-subnetted network\&.
15866 .sp
15867 If you want to work in multiple namespaces, you can give every wins server a \*(Aqtag\*(Aq\&. For each tag, only one (working) server will be queried for a name\&. The tag should be separated from the ip address by a colon\&.
15868 .if n \{\
15869 .sp
15870 .\}
15871 .RS 4
15872 .it 1 an-trap
15873 .nr an-no-space-flag 1
15874 .nr an-break-flag 1
15875 .br
15876 .ps +1
15877 \fBNote\fR
15878 .ps -1
15879 .br
15880 You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross\-subnet browsing to work correctly\&.
15881 .sp .5v
15882 .RE
15883 See the chapter in the Samba3\-HOWTO on Network Browsing\&.
15884 .sp
15885 Default:
15886 \fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR
15887 .sp
15888 Example:
15889 \fI\fIwins server\fR\fR\fI = \fR\fImary:192\&.9\&.200\&.1 fred:192\&.168\&.3\&.199 mary:192\&.168\&.2\&.61 # For this example when querying a certain name, 192\&.19\&.200\&.1 will be asked first and if that doesn\*(Aqt respond 192\&.168\&.2\&.61\&. If either of those doesn\*(Aqt know the name 192\&.168\&.3\&.199 will be queried\&.\fR\fI \fR
15890 .sp
15891 Example:
15892 \fI\fIwins server\fR\fR\fI = \fR\fI192\&.9\&.200\&.1 192\&.168\&.2\&.61\fR\fI \fR
15893 .RE
15894
15895 wins support (G)
15896 .PP
15897 .RS 4
15898 This boolean controls if the
15899 \fBnmbd\fR(8)
15900 process in Samba will act as a WINS server\&. You should not set this to
15901 \fByes\fR
15902 unless you have a multi\-subnetted network and you wish a particular
15903 nmbd
15904 to be your WINS server\&. Note that you should
15905 \fINEVER\fR
15906 set this to
15907 \fByes\fR
15908 on more than one machine in your network\&.
15909 .sp
15910 Default:
15911 \fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR
15912 .RE
15913
15914 workgroup (G)
15915 .PP
15916 .RS 4
15917 This controls what workgroup your server will appear to be in when queried by clients\&. Note that this parameter also controls the Domain name used with the
15918 \m[blue]\fBsecurity = domain\fR\m[]
15919 setting\&.
15920 .sp
15921 Default:
15922 \fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR
15923 .sp
15924 Example:
15925 \fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR
15926 .RE
15927
15928 wreplsrv:periodic_interval (G)
15929 .PP
15930 .RS 4
15931 This maximum interval in seconds between 2 periodically scheduled runs where we check for wins\&.ldb changes and do push notifications to our push partners\&. Also wins_config\&.ldb changes are checked in that interval and partner configuration reloads are done\&.
15932 .sp
15933 Default:
15934 \fI\fIwreplsrv:periodic_interval\fR\fR\fI = \fR\fI15\fR\fI \fR
15935 .RE
15936
15937 wreplsrv:propagate name releases (G)
15938 .PP
15939 .RS 4
15940 If this parameter is enabled, then explicit (from the client) and implicit (via the scavenging) name releases are propagated to the other servers directly, even if there are still other addresses active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3) entries\&. Also the replication conflict merge algorithm for SPECIAL GROUP (2) entries discards replica addresses where the address owner is the local server, if the address was not stored locally before\&. The merge result is propagated directly in case an address was discarded\&. A Windows servers doesn\*(Aqt propagate name releases of SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means that Windows servers may return different results to name queries for SPECIAL GROUP (2) and MULTIHOMED (3) names\&. The option doesn\*(Aqt have much negative impact if Windows servers are around, but be aware that they might return unexpected results\&.
15941 .sp
15942 Default:
15943 \fI\fIwreplsrv:propagate name releases\fR\fR\fI = \fR\fIno\fR\fI \fR
15944 .RE
15945
15946 wreplsrv:scavenging_interval (G)
15947 .PP
15948 .RS 4
15949 This is the interval in s between 2 scavenging runs which clean up the WINS database and changes the states of expired name records\&. Defaults to half of the value of wreplsrv:renew_interval\&.
15950 .sp
15951 \fINo default\fR
15952 .RE
15953
15954 wreplsrv:tombstone_extra_timeout (G)
15955 .PP
15956 .RS 4
15957 This is the time in s the server needs to be up till we\*(Aqll remove tombstone records from our database\&. Defaults to 3 days\&.
15958 .sp
15959 Default:
15960 \fI\fIwreplsrv:tombstone_extra_timeout\fR\fR\fI = \fR\fI259200\fR\fI \fR
15961 .RE
15962
15963 wreplsrv:tombstone_interval (G)
15964 .PP
15965 .RS 4
15966 This is the interval in s till released records of the WINS server become tombstone\&. Defaults to 6 days\&.
15967 .sp
15968 Default:
15969 \fI\fIwreplsrv:tombstone_interval\fR\fR\fI = \fR\fI518400\fR\fI \fR
15970 .RE
15971
15972 wreplsrv:tombstone_timeout (G)
15973 .PP
15974 .RS 4
15975 This is the interval in s till tombstone records are deleted from the WINS database\&. Defaults to 1 day\&.
15976 .sp
15977 Default:
15978 \fI\fIwreplsrv:tombstone_timeout\fR\fR\fI = \fR\fI86400\fR\fI \fR
15979 .RE
15980
15981 wreplsrv:verify_interval (G)
15982 .PP
15983 .RS 4
15984 This is the interval in s till we verify active replica records with the owning WINS server\&. Unfortunately not implemented yet\&. Defaults to 24 days\&.
15985 .sp
15986 Default:
15987 \fI\fIwreplsrv:verify_interval\fR\fR\fI = \fR\fI2073600\fR\fI \fR
15988 .RE
15989
15990 writable
15991 .PP
15992 .RS 4
15993 This parameter is a synonym for
15994 writeable\&.
15995 .RE
15996
15997 write ok
15998 .PP
15999 .RS 4
16000 This parameter is a synonym for
16001 writeable\&.
16002 .RE
16003
16004 writeable (S)
16005 .PP
16006 .RS 4
16007 Inverted synonym for
16008 \m[blue]\fBread only\fR\m[]\&.
16009 .sp
16010 Default:
16011 \fI\fIwriteable\fR\fR\fI = \fR\fIno\fR\fI \fR
16012 .RE
16013
16014 write list (S)
16015 .PP
16016 .RS 4
16017 This is a list of users that are given read\-write access to a service\&. If the connecting user is in this list then they will be given write access, no matter what the
16018 \m[blue]\fBread only\fR\m[]
16019 option is set to\&. The list can include group names using the @group syntax\&.
16020 .sp
16021 Note that if a user is in both the read list and the write list then they will be given write access\&.
16022 .sp
16023 Default:
16024 \fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR
16025 .sp
16026 Example:
16027 \fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR
16028 .RE
16029
16030 write raw (G)
16031 .PP
16032 .RS 4
16033 This is ignored if
16034 \m[blue]\fBasync smb echo handler\fR\m[]
16035 is set, because this feature is incompatible with raw write SMB requests
16036 .sp
16037 If enabled, raw writes allow writes of 65535 bytes in one packet\&. This typically provides a major performance benefit for some very, very old clients\&.
16038 .sp
16039 However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw writes\&.
16040 .sp
16041 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
16042 .sp
16043 Default:
16044 \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
16045 .RE
16046
16047 wsp property file (G)
16048 .PP
16049 .RS 4
16050 \m[blue]\fBwsp property file\fR\m[]
16051 parameter\&. This parameter specifies the file where additional WSP Windows Search Protocol properties are stored\&. The format of the file is a csv consisting of 10 comma separated columns\&. The first 3 columns are required, the other columns are desirable but not necessary\&.
16052 .PP
16053 Property Name
16054 .RS 4
16055 A property name e\&.g\&. System\&.ItemUrl\&.
16056 .RE
16057 .PP
16058 GUID
16059 .RS 4
16060 A guid that identifies the propertyset the property belongs to\&.
16061 .RE
16062 .PP
16063 prop ID
16064 .RS 4
16065 A number that together with the GUID uniquely identifies the property\&.
16066 .RE
16067 .PP
16068 inInverted Index
16069 .RS 4
16070 Set to TRUE is the property is indexed\&.
16071 .RE
16072 .PP
16073 isColumn
16074 .RS 4
16075 Set to TRUE if the property is one that can be returned in rows returned from WSP query\&.
16076 .RE
16077 .PP
16078 type
16079 .RS 4
16080 One of
16081 \fIBoolean\fR,\fIBuffer\fR,\fIByte\fR,\fIDateTime\fR,\fIDouble\fR,\fIInt32\fR,\fIString\fR,\fIUInt16\fR,\fIUInt32\fR,\fIUInt64\fR
16082 .RE
16083 .PP
16084 MaxSize
16085 .RS 4
16086 maximum size when stored\&.
16087 .RE
16088 .PP
16089 Vector Property
16090 .RS 4
16091 TRUE if this is a multivalue property\&.
16092 .RE
16093 .PP
16094 Description
16095 .RS 4
16096 Description of what the property is used for\&.
16097 .RE
16098 .sp
16099 Default:
16100 \fI\fIwsp property file\fR\fR\fI = \fR\fI\fR\fI \fR
16101 .RE
16102
16103 wtmp directory (G)
16104 .PP
16105 .RS 4
16106 This parameter is only available if Samba has been configured and compiled with the option
16107 \-\-with\-utmp\&. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on the UNIX system) that record user connections to a Samba server\&. The difference with the utmp directory is the fact that user info is kept after a user has logged out\&.
16108 .sp
16109 By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
16110 /var/run/wtmp
16111 on Linux)\&.
16112 .sp
16113 Default:
16114 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR
16115 .sp
16116 Example:
16117 \fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR
16118 .RE
16119 .SH "WARNINGS"
16120 .PP
16121 Although the configuration file permits service names to contain spaces, your client software may not\&. Spaces will be ignored in comparisons anyway, so it shouldn\*(Aqt be a problem \- but be aware of the possibility\&.
16122 .PP
16123 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
16124 \fBsmbd\fR(8)
16125 has no such limitation, but attempts to connect from such clients will fail if they truncate the service names\&. For this reason you should probably keep your service names down to eight characters in length\&.
16126 .PP
16127 Use of the
16128 [homes]
16129 and
16130 [printers]
16131 special sections make life for an administrator easy, but the various combinations of default attributes can be tricky\&. Take extreme care when designing these sections\&. In particular, ensure that the permissions on spool directories are correct\&.
16132 .SH "VERSION"
16133 .PP
16134 This man page is part of version 4\&.24\&.0 of the Samba suite\&.
16135 .SH "SEE ALSO"
16136 .PP
16137 \fBsamba\fR(7),
16138 \fBsmbpasswd\fR(8),
16139 \fBsmbd\fR(8),
16140 \fBnmbd\fR(8),
16141 \fBwinbindd\fR(8),
16142 \fBsamba\fR(8),
16143 \fBsamba-tool\fR(8),
16144 \fBsmbclient\fR(1),
16145 \fBnmblookup\fR(1),
16146 \fBtestparm\fR(1)\&.
16147 .SH "AUTHOR"
16148 .PP
16149 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\&.